i18next 23.14.0 → 23.15.1

package/dist/esm/package.json

@@ -1 +1 @@
-{"type":"module","version":"23.14.0"}
+{"type":"module","version":"23.15.1"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18next",
-  "version": "23.14.0",
+  "version": "23.15.1",
   "description": "i18next internationalization framework",
   "main": "./dist/cjs/i18next.js",
   "module": "./dist/esm/i18next.js",

package/typescript/helpers.d.ts

@@ -58,3 +58,11 @@ type $StringKeyPathToRecordUnion<
 export type $StringKeyPathToRecord<TPath extends string, TValue> = $UnionToIntersection<
   $StringKeyPathToRecordUnion<TPath, TValue>
 >;
+
+/**
+ * We could use NoInfer typescript build-in utility,
+ * however this project still supports ts < 5.4.
+ *
+ * @see https://github.com/millsp/ts-toolbelt/blob/master/sources/Function/NoInfer.ts
+ */
+export type $NoInfer<A> = [A][A extends any ? 0 : never];

package/typescript/options.d.ts

@@ -106,6 +106,16 @@ export type TypeOptions = $MergeBy<
      * Suffix for interpolation
      */
     interpolationSuffix: '}}';
+
+    /**
+     * Prefix for unescaped interpolation
+     */
+    unescapePrefix: '-';
+
+    /**
+     * Suffix for unescaped interpolation
+     */
+    unescapeSuffix: '';
   },
   CustomTypeOptions
 >;

package/typescript/t.d.ts

@@ -4,6 +4,7 @@ import type {
   $Dictionary,
   $SpecialObject,
   $StringKeyPathToRecord,
+  $NoInfer,
 } from './helpers.js';
 import type {
   TypeOptions,
@@ -29,6 +30,8 @@ type _Resources = TypeOptions['resources'];
 type _JSONFormat = TypeOptions['jsonFormat'];
 type _InterpolationPrefix = TypeOptions['interpolationPrefix'];
 type _InterpolationSuffix = TypeOptions['interpolationSuffix'];
+type _UnescapePrefix = TypeOptions['unescapePrefix'];
+type _UnescapeSuffix = TypeOptions['unescapeSuffix'];
 
 type $IsResourcesDefined = [keyof _Resources] extends [never] ? false : true;
 type $ValueIfResourcesDefined<Value, Fallback> = $IsResourcesDefined extends true
@@ -53,6 +56,14 @@ type WithOrWithoutPlural<Key> = _JSONFormat extends 'v4' | 'v3'
 type JoinKeys<K1, K2> = `${K1 & string}${_KeySeparator}${K2 & string}`;
 type AppendNamespace<Ns, Keys> = `${Ns & string}${_NsSeparator}${Keys & string}`;
 
+type TrimSpaces<T extends string, Acc extends string = ''> = T extends `${infer Char}${infer Rest}`
+  ? Char extends ' '
+    ? TrimSpaces<Rest, Acc>
+    : TrimSpaces<Rest, `${Acc}${Char}`>
+  : T extends ''
+  ? Acc
+  : never;
+
 /** ****************************************************
  * Build all keys and key prefixes based on Resources *
  ***************************************************** */
@@ -141,10 +152,16 @@ export type ParseKeys<
 /** *******************************************************
  * Parse t function return type and interpolation values *
  ******************************************************** */
+type ParseActualValue<Ret> = Ret extends `${_UnescapePrefix}${infer ActualValue}${_UnescapeSuffix}`
+  ? TrimSpaces<ActualValue>
+  : Ret;
+
 type ParseInterpolationValues<Ret> =
   Ret extends `${string}${_InterpolationPrefix}${infer Value}${_InterpolationSuffix}${infer Rest}`
     ?
-        | (Value extends `${infer ActualValue},${string}` ? ActualValue : Value)
+        | (Value extends `${infer ActualValue},${string}`
+            ? ParseActualValue<ActualValue>
+            : ParseActualValue<Value>)
         | ParseInterpolationValues<Rest>
     : never;
 
@@ -244,6 +261,12 @@ export type TFunctionDetailedResult<T = string, TOpt extends TOptions = {}> = {
   usedParams: InterpolationMap<T> & { count?: TOpt['count'] };
 };
 
+type TFunctionProcessReturnValue<Ret, DefaultValue> = Ret extends string | $SpecialObject | null
+  ? Ret
+  : [DefaultValue] extends [never]
+  ? Ret
+  : DefaultValue;
+
 type TFunctionReturnOptionalDetails<Ret, TOpt extends TOptions> = TOpt['returnDetails'] extends true
   ? TFunctionDetailedResult<Ret, TOpt>
   : Ret;
@@ -262,12 +285,13 @@ export interface TFunction<Ns extends Namespace = DefaultNamespace, KPrefix = un
     const TOpt extends TOptions,
     Ret extends TFunctionReturn<Ns, AppendKeyPrefix<Key, KPrefix>, TOpt>,
     const ActualOptions extends TOpt & InterpolationMap<Ret> = TOpt & InterpolationMap<Ret>,
+    DefaultValue extends string = never,
   >(
     ...args:
       | [key: Key | Key[], options?: ActualOptions]
-      | [key: string | string[], options: TOpt & $Dictionary & { defaultValue: string }]
-      | [key: string | string[], defaultValue: string, options?: TOpt & $Dictionary]
-  ): TFunctionReturnOptionalDetails<Ret, TOpt>;
+      | [key: string | string[], options: TOpt & $Dictionary & { defaultValue: DefaultValue }]
+      | [key: string | string[], defaultValue: DefaultValue, options?: TOpt & $Dictionary]
+  ): TFunctionReturnOptionalDetails<TFunctionProcessReturnValue<$NoInfer<Ret>, DefaultValue>, TOpt>;
 }
 
 export type KeyPrefix<Ns extends Namespace> = ResourceKeys<true>[$FirstNamespace<Ns>] | undefined;

package/typescript/t.v4.d.ts

@@ -29,6 +29,8 @@ type _Resources = TypeOptions['resources'];
 type _JSONFormat = TypeOptions['jsonFormat'];
 type _InterpolationPrefix = TypeOptions['interpolationPrefix'];
 type _InterpolationSuffix = TypeOptions['interpolationSuffix'];
+type _UnescapePrefix = TypeOptions['unescapePrefix'];
+type _UnescapeSuffix = TypeOptions['unescapeSuffix'];
 
 type $IsResourcesDefined = [keyof _Resources] extends [never] ? false : true;
 type $ValueIfResourcesDefined<Value, Fallback> = $IsResourcesDefined extends true
@@ -53,6 +55,14 @@ type WithOrWithoutPlural<Key> = _JSONFormat extends 'v4' | 'v3'
 type JoinKeys<K1, K2> = `${K1 & string}${_KeySeparator}${K2 & string}`;
 type AppendNamespace<Ns, Keys> = `${Ns & string}${_NsSeparator}${Keys & string}`;
 
+type TrimSpaces<T extends string, Acc extends string = ''> = T extends `${infer Char}${infer Rest}`
+  ? Char extends ' '
+    ? TrimSpaces<Rest, Acc>
+    : TrimSpaces<Rest, `${Acc}${Char}`>
+  : T extends ''
+  ? Acc
+  : never;
+
 /** ****************************************************
  * Build all keys and key prefixes based on Resources *
  ***************************************************** */
@@ -140,10 +150,16 @@ export type ParseKeys<
 /** *******************************************************
  * Parse t function return type and interpolation values *
  ******************************************************** */
+type ParseActualValue<Ret> = Ret extends `${_UnescapePrefix}${infer ActualValue}${_UnescapeSuffix}`
+  ? TrimSpaces<ActualValue>
+  : Ret;
+
 type ParseInterpolationValues<Ret> =
   Ret extends `${string}${_InterpolationPrefix}${infer Value}${_InterpolationSuffix}${infer Rest}`
     ?
-        | (Value extends `${infer ActualValue},${string}` ? ActualValue : Value)
+        | (Value extends `${infer ActualValue},${string}`
+            ? ParseActualValue<ActualValue>
+            : ParseActualValue<Value>)
         | ParseInterpolationValues<Rest>
     : never;