@koine/i18n 2.0.0-beta.190 → 2.0.0-beta.192

package/adapter-js/generators/types.cjs.js

@@ -9,15 +9,15 @@ var imports = require('../../compiler/imports.cjs.js');
 var pluralisation = require('../../compiler/pluralisation.cjs.js');
 
 function getTypeLocale(e) {
-    return y(e.locales);
+    return d(e.locales);
 }
-function y(e, t = !0) {
+function d(e, t = !0) {
     return (t ? e.sort() : e).filter(utils.isString).map((e)=>`"${e}"`).join(" | ");
 }
-function d(e, t) {
-    return y(Object.keys(e.byId).filter((a)=>t(a, e.byId[a]))) || "never";
+function y(e, t) {
+    return d(Object.keys(e.byId).filter((a)=>t(a, e.byId[a]))) || "never";
 }
-function T(e) {
+function m(e) {
     return `{
     ${e.join("\n    ")}
   }`;
@@ -32,13 +32,13 @@ const getImportTypes = ()=>new imports.ImportsCompiler({
         ]
     });
 var x = createAdapter.createGenerator("js", (i)=>{
-    let { options: { routes: { localeParamName: y, tokens: { idDelimiter: u } }, translations: { tokens: { keyDelimiter: h, namespaceDelimiter: f } } } } = i, I = function(s) {
-        let { config: i, routes: y, options: u } = s;
+    let { options: { routes: { tokens: { idDelimiter: d } }, translations: { tokens: { keyDelimiter: u, namespaceDelimiter: h } } } } = i, f = function(s) {
+        let { config: i, routes: d, options: u } = s;
         return {
             Locale: getTypeLocale(i),
-            RouteIdStatic: d(y, (e, { params: t })=>!t),
-            RouteIdDynamic: d(y, (e, { params: t })=>!!t),
-            RouteSpa: T(function(e, t, a) {
+            RouteIdStatic: y(d, (e, { params: t })=>!t),
+            RouteIdDynamic: y(d, (e, { params: t })=>!!t),
+            RouteSpa: m(function(e, t, a) {
                 let n = Object.keys(t.byId).reduce((e, a)=>{
                     if (t.byId[a].inWildcard) for(let n = 0; n < t.wildcardIds.length; n++){
                         let s = t.wildcardIds[n];
@@ -55,28 +55,28 @@ var x = createAdapter.createGenerator("js", (i)=>{
                     s.push(`"${o}": { ${l.join(" ")} }`);
                 }
                 return s;
-            }(i, y, u)),
-            RoutePathnames: T(function(e, t) {
+            }(i, d, u)),
+            RoutePathnames: m(function(e, t) {
                 let a = [];
                 for(let n in t.byId){
                     let s = t.byId[n];
                     a.push(`"${s.id}": "${s.pathnames[e.defaultLocale]}";`);
                 }
                 return a;
-            }(i, y)),
-            RouteParams: T(function(e) {
+            }(i, d)),
+            RouteParams: m(function(e) {
                 let t = [];
                 for(let a in e.byId){
                     let { params: n } = e.byId[a];
                     n && t.push(`"${a}": ${helpers.compileDataParamsToType(n)};`);
                 }
                 return t;
-            }(y)),
-            TranslationsDictionary: T(function(s) {
-                let { config: { defaultLocale: o }, input: { translationFiles: i }, options: { translations: { ignorePaths: y } } } = s, d = helpers.filterInputTranslationFiles(i, y, (e)=>e.locale === o), T = [];
-                for(let s = 0; s < d.length; s++){
-                    let { path: o, data: r } = d[s], i = o.replace(".json", "");
-                    T.push(`"${i}": ${function s(o) {
+            }(d)),
+            TranslationsDictionary: m(function(s) {
+                let { config: { defaultLocale: o }, input: { translationFiles: i }, options: { translations: { ignorePaths: d } } } = s, y = helpers.filterInputTranslationFiles(i, d, (e)=>e.locale === o), m = [];
+                for(let s = 0; s < y.length; s++){
+                    let { path: o, data: r } = y[s], i = o.replace(".json", "");
+                    m.push(`"${i}": ${function s(o) {
                         let r = "", i = "";
                         if (utils.isBoolean(o) ? i = "boolean" : utils.isString(o) && (i = "string"), i) r += i + ";";
                         else if (o) {
@@ -87,8 +87,8 @@ var x = createAdapter.createGenerator("js", (i)=>{
                                 r += "{";
                                 let t = pluralisation.transformKeysForPlurals(Object.keys(o));
                                 for(let n = 0; n < t.length; n++){
-                                    let i = t[n], m = o[i] || "";
-                                    r += !utils.isArray(m) && utils.isObject(m) && pluralisation.hasPlurals(m) ? pluralisation.hasOnlyPluralKeys(m) ? `"${i}": string;` : `"${i}": ${s(pluralisation.pickNonPluralValue(m))}` : `"${i}": ${s(m)}`;
+                                    let i = t[n], T = o[i] || "";
+                                    r += !utils.isArray(T) && utils.isObject(T) && pluralisation.hasPlurals(T) ? pluralisation.hasOnlyPluralKeys(T) ? `"${i}": string;` : `"${i}": ${s(pluralisation.pickNonPluralValue(T))}` : `"${i}": ${s(T)}`;
                                 }
                                 r += "};";
                             }
@@ -96,7 +96,7 @@ var x = createAdapter.createGenerator("js", (i)=>{
                         return (r = r.replace(/;\[\];/g, "[];")).replace(/;+/g, ";");
                     }(r)}`);
                 }
-                return T.sort();
+                return m.sort();
             }(s))
         };
     }(i);
@@ -111,8 +111,6 @@ var x = createAdapter.createGenerator("js", (i)=>{
 declare namespace I18n {
   type Locale = import("../types").I18n.Locale;
   type LocalesMap = import("../types").I18n.LocalesMap;
-  type Params = import("../types").I18n.Params;
-  type Props = import("../types").I18n.Props;
   type RouteArgs = import("../types").I18n.RouteArgs;
   type RouteId = import("../types").I18n.RouteId;
   type RouteIdDynamic = import("../types").I18n.RouteIdDynamic;
@@ -142,7 +140,7 @@ declare namespace I18n {
             ext: "ts",
             index: !0,
             content: ()=>`
-import type { Split, JsonObject } from "@koine/utils";
+import type { Split } from "@koine/utils";
 import type { I18nUtils } from "${process.env.JEST_WORKER_ID ? "../../../types" : "@koine/i18n"}";
 import type { RouteIdError } from "./internal/routesError";
 
@@ -150,7 +148,7 @@ export namespace I18n {
   /**
    * Any of the available locale code
    */
-  export type Locale = ${I.Locale};
+  export type Locale = ${f.Locale};
  
   /**
    * Utility to map values by all available locales
@@ -159,23 +157,6 @@ export namespace I18n {
    */
   export type LocalesMap<T = any> = Record<Locale, T>;
 
-  /**
-   * Params globally available from the URL/folder structure \`${y}\`,
-   * named accordingly to the \`localeParam\` option (e.g. _next.js_ folder structure
-   * \`/[${y}]/my-route/page.tsx\`)
-   */
-  export type Params = {
-    ${y}: Locale;
-  };
-
-  /**
-   * Props available to each page/layout when a root \`localeParam\` is in place
-   * (e.g. _next.js_ folder structure \`/[${y}]/my-route/page.tsx\`).
-   */
-  export type Props<P = {}> = P & {
-    params: Params;
-  };
-
   /**
    * @internal
    */
@@ -196,32 +177,32 @@ export namespace I18n {
   /**
    * The static routes available ids
    */
-  export type RouteIdStatic = ${I.RouteIdStatic};
+  export type RouteIdStatic = ${f.RouteIdStatic};
 
   /**
    * The dynamic routes available ids
    */
-  export type RouteIdDynamic = ${I.RouteIdDynamic};
+  export type RouteIdDynamic = ${f.RouteIdDynamic};
 
   /**
    * Route dynamic params dictionary for each dynamic route id
-  */
- export type RouteParams = ${I.RouteParams};
+   */
+  export type RouteParams = ${f.RouteParams};
 
  /**
-  * Map every route id to its actual pathanem value for the default locale
+  * Map every route id to its actual pathname value for the default locale
   */
-  export type RoutePathnames = ${I.RoutePathnames};
+  export type RoutePathnames = ${f.RoutePathnames};
 
   /**
    * Map every SPA path divided by their roots to their actual pathname value for the default locale
    */
-  export type RouteSpa = ${I.RouteSpa};
+  export type RouteSpa = ${f.RouteSpa};
 
   /**
    * Utility to join two route ids
    */
-  export type RouteJoinedId<Root extends string, Tail extends string> = \`\${Root}${u}\${Tail}\` extends RouteId ? \`\${Root}${u}\${Tail}\` : never;
+  export type RouteJoinedId<Root extends string, Tail extends string> = \`\${Root}${d}\${Tail}\` extends RouteId ? \`\${Root}${d}\${Tail}\` : never;
 
   /**
    * Extract all children routes that starts with the given string
@@ -238,7 +219,7 @@ export namespace I18n {
    * The types extracted from the translations JSON files, this is a little
    * more sophisticated than the type result of \`typeof "./en/messages.json"\`
    */
-  export type TranslationsDictionary = ${I.TranslationsDictionary};
+  export type TranslationsDictionary = ${f.TranslationsDictionary};
 
   /**
    * Any of the available translations dictionary namespaces
@@ -260,13 +241,13 @@ export namespace I18n {
    *
    * \`T\` can be any of all possible paths begininng with a namespace:
    * - \`namespace\` only a namespace
-   * - \`namespace${f}myKey\` sub dictionaries within a namespace
-   * - \`namespace${f}myKey.nested\` whatever nested level of nesting
+   * - \`namespace${h}myKey\` sub dictionaries within a namespace
+   * - \`namespace${h}myKey.nested\` whatever nested level of nesting
    */
   export type TranslationsChildrenOf<T extends TranslationAtGeneric> =
     T extends TranslationsNamespace
       ? TranslationsPaths<TranslationsDictionary[T]>
-      : T extends \`\${infer Namespace}${f}\${infer Path}\`
+      : T extends \`\${infer Namespace}${h}\${infer Path}\`
         ? Namespace extends TranslationsNamespace
           ? I18nUtils.Get<TranslationsDictionary[Namespace], Path> extends object
             ? TranslationsPaths<I18nUtils.Get<TranslationsDictionary[Namespace], Path>>
@@ -276,12 +257,12 @@ export namespace I18n {
 
   /**
    * All translations ancestor partial _paths_ of the given one, e.g. if \`T\` would be
-   * \`"area${h}main${h}[id]${h}edit"\` the generated type would be the union
-   * \`"area${h}main${h}[id]" | "area${h}main" | "area"\`.
+   * \`"area${u}main${u}[id]${u}edit"\` the generated type would be the union
+   * \`"area${u}main${u}[id]" | "area${u}main" | "area"\`.
    */
   export type TranslationsAncestorsOf<
     T extends string,
-    TSeparator extends string = "${h}",
+    TSeparator extends string = "${u}",
   > = I18nUtils.BuildRecursiveJoin<Split<T, TSeparator>, TSeparator>;
 
   /**
@@ -289,13 +270,13 @@ export namespace I18n {
    *
    * \`T\` can be any of all possible paths begininng with a namespace:
    * - \`namespace\` only a namespace
-   * - \`namespace${f}myKey\` sub dictionaries within a namespace
-   * - \`namespace${f}myKey${h}nested\` whatever nested level of nesting
+   * - \`namespace${h}myKey\` sub dictionaries within a namespace
+   * - \`namespace${h}myKey${u}nested\` whatever nested level of nesting
    */
   export type TranslationAt<T extends TranslationAtGeneric> =
     T extends TranslationsNamespace
       ? TranslationsDictionary[T]
-      : T extends \`\${infer Namespace}${f}\${infer Path}\`
+      : T extends \`\${infer Namespace}${h}\${infer Path}\`
         ? Namespace extends TranslationsNamespace
           ? I18nUtils.Get<TranslationsDictionary[Namespace], Path>
           : never
@@ -314,7 +295,7 @@ export namespace I18n {
    *
    * \`T\` can be any of all possible paths:
    * - \`myKey\` sub dictionaries within a namespace
-   * - \`myKey${h}nested\` whatever nested level of nesting within a namespace
+   * - \`myKey${u}nested\` whatever nested level of nesting within a namespace
    */
   export type TranslationAtNamespace<
     TNamespace extends TranslationsNamespace,

package/adapter-js/generators/types.esm.js

@@ -5,15 +5,15 @@ import { ImportsCompiler } from '../../compiler/imports.esm.js';
 import { transformKeysForPlurals, hasPlurals, hasOnlyPluralKeys, pickNonPluralValue } from '../../compiler/pluralisation.esm.js';
 
 function getTypeLocale(e) {
-    return y(e.locales);
+    return d(e.locales);
 }
-function y(e, t = !0) {
+function d(e, t = !0) {
     return (t ? e.sort() : e).filter(isString).map((e)=>`"${e}"`).join(" | ");
 }
-function d(e, t) {
-    return y(Object.keys(e.byId).filter((a)=>t(a, e.byId[a]))) || "never";
+function y(e, t) {
+    return d(Object.keys(e.byId).filter((a)=>t(a, e.byId[a]))) || "never";
 }
-function T(e) {
+function m(e) {
     return `{
     ${e.join("\n    ")}
   }`;
@@ -28,13 +28,13 @@ const getImportTypes = ()=>new ImportsCompiler({
         ]
     });
 var x = createGenerator("js", (i)=>{
-    let { options: { routes: { localeParamName: y, tokens: { idDelimiter: u } }, translations: { tokens: { keyDelimiter: h, namespaceDelimiter: f } } } } = i, I = function(s) {
-        let { config: i, routes: y, options: u } = s;
+    let { options: { routes: { tokens: { idDelimiter: d } }, translations: { tokens: { keyDelimiter: u, namespaceDelimiter: h } } } } = i, f = function(s) {
+        let { config: i, routes: d, options: u } = s;
         return {
             Locale: getTypeLocale(i),
-            RouteIdStatic: d(y, (e, { params: t })=>!t),
-            RouteIdDynamic: d(y, (e, { params: t })=>!!t),
-            RouteSpa: T(function(e, t, a) {
+            RouteIdStatic: y(d, (e, { params: t })=>!t),
+            RouteIdDynamic: y(d, (e, { params: t })=>!!t),
+            RouteSpa: m(function(e, t, a) {
                 let n = Object.keys(t.byId).reduce((e, a)=>{
                     if (t.byId[a].inWildcard) for(let n = 0; n < t.wildcardIds.length; n++){
                         let s = t.wildcardIds[n];
@@ -51,28 +51,28 @@ var x = createGenerator("js", (i)=>{
                     s.push(`"${o}": { ${l.join(" ")} }`);
                 }
                 return s;
-            }(i, y, u)),
-            RoutePathnames: T(function(e, t) {
+            }(i, d, u)),
+            RoutePathnames: m(function(e, t) {
                 let a = [];
                 for(let n in t.byId){
                     let s = t.byId[n];
                     a.push(`"${s.id}": "${s.pathnames[e.defaultLocale]}";`);
                 }
                 return a;
-            }(i, y)),
-            RouteParams: T(function(e) {
+            }(i, d)),
+            RouteParams: m(function(e) {
                 let t = [];
                 for(let a in e.byId){
                     let { params: n } = e.byId[a];
                     n && t.push(`"${a}": ${compileDataParamsToType(n)};`);
                 }
                 return t;
-            }(y)),
-            TranslationsDictionary: T(function(s) {
-                let { config: { defaultLocale: o }, input: { translationFiles: i }, options: { translations: { ignorePaths: y } } } = s, d = filterInputTranslationFiles(i, y, (e)=>e.locale === o), T = [];
-                for(let s = 0; s < d.length; s++){
-                    let { path: o, data: r } = d[s], i = o.replace(".json", "");
-                    T.push(`"${i}": ${function s(o) {
+            }(d)),
+            TranslationsDictionary: m(function(s) {
+                let { config: { defaultLocale: o }, input: { translationFiles: i }, options: { translations: { ignorePaths: d } } } = s, y = filterInputTranslationFiles(i, d, (e)=>e.locale === o), m = [];
+                for(let s = 0; s < y.length; s++){
+                    let { path: o, data: r } = y[s], i = o.replace(".json", "");
+                    m.push(`"${i}": ${function s(o) {
                         let r = "", i = "";
                         if (isBoolean(o) ? i = "boolean" : isString(o) && (i = "string"), i) r += i + ";";
                         else if (o) {
@@ -83,8 +83,8 @@ var x = createGenerator("js", (i)=>{
                                 r += "{";
                                 let t = transformKeysForPlurals(Object.keys(o));
                                 for(let n = 0; n < t.length; n++){
-                                    let i = t[n], m = o[i] || "";
-                                    r += !isArray(m) && isObject(m) && hasPlurals(m) ? hasOnlyPluralKeys(m) ? `"${i}": string;` : `"${i}": ${s(pickNonPluralValue(m))}` : `"${i}": ${s(m)}`;
+                                    let i = t[n], T = o[i] || "";
+                                    r += !isArray(T) && isObject(T) && hasPlurals(T) ? hasOnlyPluralKeys(T) ? `"${i}": string;` : `"${i}": ${s(pickNonPluralValue(T))}` : `"${i}": ${s(T)}`;
                                 }
                                 r += "};";
                             }
@@ -92,7 +92,7 @@ var x = createGenerator("js", (i)=>{
                         return (r = r.replace(/;\[\];/g, "[];")).replace(/;+/g, ";");
                     }(r)}`);
                 }
-                return T.sort();
+                return m.sort();
             }(s))
         };
     }(i);
@@ -107,8 +107,6 @@ var x = createGenerator("js", (i)=>{
 declare namespace I18n {
   type Locale = import("../types").I18n.Locale;
   type LocalesMap = import("../types").I18n.LocalesMap;
-  type Params = import("../types").I18n.Params;
-  type Props = import("../types").I18n.Props;
   type RouteArgs = import("../types").I18n.RouteArgs;
   type RouteId = import("../types").I18n.RouteId;
   type RouteIdDynamic = import("../types").I18n.RouteIdDynamic;
@@ -138,7 +136,7 @@ declare namespace I18n {
             ext: "ts",
             index: !0,
             content: ()=>`
-import type { Split, JsonObject } from "@koine/utils";
+import type { Split } from "@koine/utils";
 import type { I18nUtils } from "${process.env.JEST_WORKER_ID ? "../../../types" : "@koine/i18n"}";
 import type { RouteIdError } from "./internal/routesError";
 
@@ -146,7 +144,7 @@ export namespace I18n {
   /**
    * Any of the available locale code
    */
-  export type Locale = ${I.Locale};
+  export type Locale = ${f.Locale};
  
   /**
    * Utility to map values by all available locales
@@ -155,23 +153,6 @@ export namespace I18n {
    */
   export type LocalesMap<T = any> = Record<Locale, T>;
 
-  /**
-   * Params globally available from the URL/folder structure \`${y}\`,
-   * named accordingly to the \`localeParam\` option (e.g. _next.js_ folder structure
-   * \`/[${y}]/my-route/page.tsx\`)
-   */
-  export type Params = {
-    ${y}: Locale;
-  };
-
-  /**
-   * Props available to each page/layout when a root \`localeParam\` is in place
-   * (e.g. _next.js_ folder structure \`/[${y}]/my-route/page.tsx\`).
-   */
-  export type Props<P = {}> = P & {
-    params: Params;
-  };
-
   /**
    * @internal
    */
@@ -192,32 +173,32 @@ export namespace I18n {
   /**
    * The static routes available ids
    */
-  export type RouteIdStatic = ${I.RouteIdStatic};
+  export type RouteIdStatic = ${f.RouteIdStatic};
 
   /**
    * The dynamic routes available ids
    */
-  export type RouteIdDynamic = ${I.RouteIdDynamic};
+  export type RouteIdDynamic = ${f.RouteIdDynamic};
 
   /**
    * Route dynamic params dictionary for each dynamic route id
-  */
- export type RouteParams = ${I.RouteParams};
+   */
+  export type RouteParams = ${f.RouteParams};
 
  /**
-  * Map every route id to its actual pathanem value for the default locale
+  * Map every route id to its actual pathname value for the default locale
   */
-  export type RoutePathnames = ${I.RoutePathnames};
+  export type RoutePathnames = ${f.RoutePathnames};
 
   /**
    * Map every SPA path divided by their roots to their actual pathname value for the default locale
    */
-  export type RouteSpa = ${I.RouteSpa};
+  export type RouteSpa = ${f.RouteSpa};
 
   /**
    * Utility to join two route ids
    */
-  export type RouteJoinedId<Root extends string, Tail extends string> = \`\${Root}${u}\${Tail}\` extends RouteId ? \`\${Root}${u}\${Tail}\` : never;
+  export type RouteJoinedId<Root extends string, Tail extends string> = \`\${Root}${d}\${Tail}\` extends RouteId ? \`\${Root}${d}\${Tail}\` : never;
 
   /**
    * Extract all children routes that starts with the given string
@@ -234,7 +215,7 @@ export namespace I18n {
    * The types extracted from the translations JSON files, this is a little
    * more sophisticated than the type result of \`typeof "./en/messages.json"\`
    */
-  export type TranslationsDictionary = ${I.TranslationsDictionary};
+  export type TranslationsDictionary = ${f.TranslationsDictionary};
 
   /**
    * Any of the available translations dictionary namespaces
@@ -256,13 +237,13 @@ export namespace I18n {
    *
    * \`T\` can be any of all possible paths begininng with a namespace:
    * - \`namespace\` only a namespace
-   * - \`namespace${f}myKey\` sub dictionaries within a namespace
-   * - \`namespace${f}myKey.nested\` whatever nested level of nesting
+   * - \`namespace${h}myKey\` sub dictionaries within a namespace
+   * - \`namespace${h}myKey.nested\` whatever nested level of nesting
    */
   export type TranslationsChildrenOf<T extends TranslationAtGeneric> =
     T extends TranslationsNamespace
       ? TranslationsPaths<TranslationsDictionary[T]>
-      : T extends \`\${infer Namespace}${f}\${infer Path}\`
+      : T extends \`\${infer Namespace}${h}\${infer Path}\`
         ? Namespace extends TranslationsNamespace
           ? I18nUtils.Get<TranslationsDictionary[Namespace], Path> extends object
             ? TranslationsPaths<I18nUtils.Get<TranslationsDictionary[Namespace], Path>>
@@ -272,12 +253,12 @@ export namespace I18n {
 
   /**
    * All translations ancestor partial _paths_ of the given one, e.g. if \`T\` would be
-   * \`"area${h}main${h}[id]${h}edit"\` the generated type would be the union
-   * \`"area${h}main${h}[id]" | "area${h}main" | "area"\`.
+   * \`"area${u}main${u}[id]${u}edit"\` the generated type would be the union
+   * \`"area${u}main${u}[id]" | "area${u}main" | "area"\`.
    */
   export type TranslationsAncestorsOf<
     T extends string,
-    TSeparator extends string = "${h}",
+    TSeparator extends string = "${u}",
   > = I18nUtils.BuildRecursiveJoin<Split<T, TSeparator>, TSeparator>;
 
   /**
@@ -285,13 +266,13 @@ export namespace I18n {
    *
    * \`T\` can be any of all possible paths begininng with a namespace:
    * - \`namespace\` only a namespace
-   * - \`namespace${f}myKey\` sub dictionaries within a namespace
-   * - \`namespace${f}myKey${h}nested\` whatever nested level of nesting
+   * - \`namespace${h}myKey\` sub dictionaries within a namespace
+   * - \`namespace${h}myKey${u}nested\` whatever nested level of nesting
    */
   export type TranslationAt<T extends TranslationAtGeneric> =
     T extends TranslationsNamespace
       ? TranslationsDictionary[T]
-      : T extends \`\${infer Namespace}${f}\${infer Path}\`
+      : T extends \`\${infer Namespace}${h}\${infer Path}\`
         ? Namespace extends TranslationsNamespace
           ? I18nUtils.Get<TranslationsDictionary[Namespace], Path>
           : never
@@ -310,7 +291,7 @@ export namespace I18n {
    *
    * \`T\` can be any of all possible paths:
    * - \`myKey\` sub dictionaries within a namespace
-   * - \`myKey${h}nested\` whatever nested level of nesting within a namespace
+   * - \`myKey${u}nested\` whatever nested level of nesting within a namespace
    */
   export type TranslationAtNamespace<
     TNamespace extends TranslationsNamespace,