add interpolation data to response if returnDetails is true (#2053)

* add interpolation data to response if returnDetails is true * avoid directly modifying incoming options * remove console.logs * pass TOpt to TFunctionDetailedResult in t.v4.d.ts * add comment about extending array of options properties
i18next · Oct 18, 2023 · c580d7a · c580d7a
1 parent f6aea8d
commit c580d7a
Show file tree

Hide file tree

Showing 5 changed files with 141 additions and 5 deletions.
diff --git a/src/Translator.js b/src/Translator.js
@@ -121,13 +121,21 @@ class Translator extends EventEmitter {
             exactUsedKey: key,
             usedLng: lng,
             usedNS: namespace,
+            usedParams: this.getUsedParamsDetails(options),
           };
         }
         return `${namespace}${nsSeparator}${key}`;
       }
 
       if (returnDetails) {
-        return { res: key, usedKey: key, exactUsedKey: key, usedLng: lng, usedNS: namespace };
+        return {
+          res: key,
+          usedKey: key,
+          exactUsedKey: key,
+          usedLng: lng,
+          usedNS: namespace,
+          usedParams: this.getUsedParamsDetails(options),
+        };
       }
       return key;
     }
@@ -163,6 +171,7 @@ class Translator extends EventEmitter {
           : `key '${key} (${this.language})' returned an object instead of string.`;
         if (returnDetails) {
           resolved.res = r;
+          resolved.usedParams = this.getUsedParamsDetails(options);
           return resolved;
         }
         return r;
@@ -323,6 +332,7 @@ class Translator extends EventEmitter {
     // return
     if (returnDetails) {
       resolved.res = res;
+      resolved.usedParams = this.getUsedParamsDetails(options);
       return resolved;
     }
     return res;
@@ -544,6 +554,47 @@ class Translator extends EventEmitter {
     return this.resourceStore.getResource(code, ns, key, options);
   }
 
+  getUsedParamsDetails(options = {}) {
+    // we need to remember to extend this array whenever new option properties are added
+    const optionsKeys = [
+      'defaultValue',
+      'ordinal',
+      'context',
+      'replace',
+      'lng',
+      'lngs',
+      'fallbackLng',
+      'ns',
+      'keySeparator',
+      'nsSeparator',
+      'returnObjects',
+      'returnDetails',
+      'joinArrays',
+      'postProcess',
+      'interpolation',
+    ];
+
+    const useOptionsReplaceForData = options.replace && typeof options.replace !== 'string';
+    let data = useOptionsReplaceForData ? options.replace : options;
+    if (useOptionsReplaceForData && typeof options.count !== 'undefined') {
+      data.count = options.count;
+    }
+
+    if (this.options.interpolation.defaultVariables) {
+      data = { ...this.options.interpolation.defaultVariables, ...data };
+    }
+
+    // avoid reporting options (execpt count) as usedParams
+    if (!useOptionsReplaceForData) {
+      data = { ...data };
+      for (const key of optionsKeys) {
+        delete data[key];
+      }
+    }
+
+    return data;
+  }
+
   static hasDefaultValue(options) {
     const prefix = 'defaultValue';
 

diff --git a/test/translator/translator.translate.spec.js b/test/translator/translator.translate.spec.js
@@ -73,6 +73,7 @@ describe('Translator', () => {
             exactUsedKey: 'test',
             usedLng: 'en',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -83,6 +84,7 @@ describe('Translator', () => {
             exactUsedKey: 'test',
             usedLng: 'en',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -93,6 +95,7 @@ describe('Translator', () => {
             exactUsedKey: 'test',
             usedLng: 'en',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -103,6 +106,7 @@ describe('Translator', () => {
             exactUsedKey: 'test',
             usedLng: 'de',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -113,6 +117,7 @@ describe('Translator', () => {
             exactUsedKey: 'test',
             usedLng: 'de',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -123,6 +128,7 @@ describe('Translator', () => {
             exactUsedKey: 'test',
             usedLng: 'en',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -133,6 +139,7 @@ describe('Translator', () => {
             exactUsedKey: 'test',
             usedLng: 'en',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -143,6 +150,7 @@ describe('Translator', () => {
             exactUsedKey: 'test',
             usedLng: 'en',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -153,6 +161,7 @@ describe('Translator', () => {
             exactUsedKey: 'deep.test',
             usedLng: 'en',
             usedNS: 'translation',
+            usedParams: {},
           },
         },
         {
@@ -163,6 +172,73 @@ describe('Translator', () => {
             exactUsedKey: 'deep.test',
             usedLng: 'en',
             usedNS: 'translation',
+            usedParams: {},
+          },
+        },
+        {
+          args: ['translation:test', { returnDetails: true, testParam: 'test-param' }],
+          expected: {
+            usedKey: 'test',
+            res: 'test_en',
+            exactUsedKey: 'test',
+            usedLng: 'en',
+            usedNS: 'translation',
+            usedParams: {
+              testParam: 'test-param',
+            },
+          },
+        },
+        {
+          args: [
+            'translation:test',
+            {
+              returnDetails: true,
+              replace: { testParam: 'test-param' },
+            },
+          ],
+          expected: {
+            usedKey: 'test',
+            res: 'test_en',
+            exactUsedKey: 'test',
+            usedLng: 'en',
+            usedNS: 'translation',
+            usedParams: {
+              testParam: 'test-param',
+            },
+          },
+        },
+        {
+          args: [
+            'translation:test',
+            {
+              defaultValue: 'default',
+              ordinal: true,
+              context: undefined,
+              replace: { testParam: 'test-param' },
+              lng: 'en',
+              lngs: ['en', 'de'],
+              fallbackLng: 'en',
+              ns: ['translation', 'other'],
+              keySeparator: '.',
+              nsSeparator: ':',
+              returnObjects: false,
+              returnDetails: true,
+              joinArrays: true,
+              postProcess: false,
+              interpolation: { escapeValue: false },
+              count: 1,
+            },
+          ],
+          expected: {
+            usedKey: 'test',
+            res: 'test_en',
+            exactUsedKey: 'test',
+            usedLng: 'en',
+            usedNS: 'translation',
+            usedParams: {
+              testParam: 'test-param',
+              count: 1,
+            },
           },
         },
       ];

diff --git a/test/typescript/t.test.ts b/test/typescript/t.test.ts
@@ -143,6 +143,7 @@ function interpolation(t: TFunction) {
   resolved.exactUsedKey;
   resolved.usedNS;
   resolved.usedLng;
+  resolved.usedParams;
 
   const r2 = t('keyTwo', { returnDetails: false });
   r2?.substring(0, 2); // make sure it is a string

diff --git a/typescript/t.d.ts b/typescript/t.d.ts
@@ -175,7 +175,7 @@ export type TFunctionReturn<
     : ParseTReturn<ActualKey, Resources[$FirstNamespace<ActualNS>]>
   : DefaultTReturn<TOpt>;
 
-export type TFunctionDetailedResult<T = string> = {
+export type TFunctionDetailedResult<T = string, TOpt extends TOptions = {}> = {
   /**
    * The plain used key
    */
@@ -196,10 +196,14 @@ export type TFunctionDetailedResult<T = string> = {
    * The used namespace for this translation.
    */
   usedNS: string;
+  /**
+   * The parameters used for interpolation.
+   */
+  usedParams: InterpolationMap<T> & { count?: TOpt['count'] };
 };
 
 type TFunctionReturnOptionalDetails<Ret, TOpt extends TOptions> = TOpt['returnDetails'] extends true
-  ? TFunctionDetailedResult<Ret>
+  ? TFunctionDetailedResult<Ret, TOpt>
   : Ret;
 
 type AppendKeyPrefix<Key, KPrefix> = KPrefix extends string

diff --git a/typescript/t.v4.d.ts b/typescript/t.v4.d.ts
@@ -175,7 +175,7 @@ export type TFunctionReturn<
     : ParseTReturn<ActualKey, Resources[$FirstNamespace<ActualNS>]>
   : DefaultTReturn<TOpt>;
 
-export type TFunctionDetailedResult<T = string> = {
+export type TFunctionDetailedResult<T = string, TOpt extends TOptions = {}> = {
   /**
    * The plain used key
    */
@@ -196,10 +196,14 @@ export type TFunctionDetailedResult<T = string> = {
    * The used namespace for this translation.
    */
   usedNS: string;
+  /**
+   * The parameters used for interpolation.
+   */
+  usedParams: InterpolationMap<T> & { count?: TOpt['count'] };
 };
 
 type TFunctionReturnOptionalDetails<Ret, TOpt extends TOptions> = TOpt['returnDetails'] extends true
-  ? TFunctionDetailedResult<Ret>
+  ? TFunctionDetailedResult<Ret, TOpt>
   : Ret;
 
 type AppendKeyPrefix<Key, KPrefix> = KPrefix extends string