types: add tests for context values (#2188)

i18next · May 14, 2024 · d057e1d · d057e1d
1 parent 31f61e6
commit d057e1d
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/test/typescript/custom-types/i18next.d.ts b/test/typescript/custom-types/i18next.d.ts
@@ -9,6 +9,7 @@ import {
   TestNamespaceFallback,
   TestNamespaceNonPlurals,
   TestNamespaceInterpolators,
+  TestNamespaceContextAlternate,
 } from '../test.namespace.samples';
 
 declare module 'i18next' {
@@ -23,6 +24,7 @@ declare module 'i18next' {
       fallback: TestNamespaceFallback;
 
       ctx: TestNamespaceContext;
+      ctxAlternate: TestNamespaceContextAlternate;
 
       plurals: TestNamespacePlurals;
 

diff --git a/test/typescript/custom-types/t.test.ts b/test/typescript/custom-types/t.test.ts
@@ -203,6 +203,41 @@ describe('t', () => {
     // });
   });
 
+  describe('context + explicit namespace', () => {
+    const t = (() => '') as TFunction<['ctx']>;
+
+    it('should work with basic usage', () => {
+      expectTypeOf(t('ctx:dessert', { context: 'cake' })).toEqualTypeOf<'a nice cake'>();
+
+      // context + plural
+      expectTypeOf(t('ctx:dessert', { context: 'muffin', count: 3 })).toMatchTypeOf<string>();
+
+      // @ts-expect-error
+      // valid key with invalid context
+      assertType(t('ctx:foo', { context: 'cake' }));
+    });
+  });
+
+  describe('context with `t` function with multiple namespaces', () => {
+    const t = (() => '') as TFunction<['ctx', 'ctxAlternate']>;
+
+    it('should work with basic usage', () => {
+      expectTypeOf(t('ctx:dessert', { context: 'cake' })).toEqualTypeOf<'a nice cake'>();
+
+      // context + plural
+      expectTypeOf(t('ctx:dessert', { context: 'muffin', count: 3 })).toMatchTypeOf<string>();
+
+      // @ts-expect-error
+      // valid key with invalid context
+      assertType(t('ctx:foo', { context: 'cake' }));
+    });
+
+    it('should work with text value from another namespace', () => {
+      expectTypeOf(t('ctxAlternate:game')).toMatchTypeOf<string>();
+      expectTypeOf(t('ctxAlternate:game', { context: 'monopoly' })).toMatchTypeOf<string>();
+    });
+  });
+
   it('should work with false plural usage', () => {
     const t = (() => '') as TFunction<'nonPlurals'>;
 

diff --git a/test/typescript/test.namespace.samples.ts b/test/typescript/test.namespace.samples.ts
@@ -43,6 +43,12 @@ export type TestNamespaceContext = {
   beverage_water: 'cold water';
 };
 
+export type TestNamespaceContextAlternate = {
+  game: 'A fun game';
+  game_chess: 'Chess';
+  game_monopoly: 'Monopoly';
+};
+
 export type TestNamespacePlurals = {
   foo_zero: 'foo';
   foo_one: 'foo';