@koine/i18n 2.0.0-beta.133 → 2.0.0-beta.135

package/README.md

@@ -1 +1,30 @@
 # @koine/i18n
+
+## Features
+
+## Co-locate multiple internationalised projects within the same monorepo
+
+The compiled output allows to easily manage multile applications and their translations independently within the same monorepo.
+
+**Further reading**
+
+This was achieved preferring types compilation (the `I18n` namespace) rather than relying on [module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation) where interface merging of possibly exported shared types from `@koine/i18n` could have achieved the same (see [`i18next` approach](https://www.i18next.com/overview/typescript#create-a-declaration-file)). That in fact would have not allow types to be scoped to the specific i18n compiled project, especially important within a monorepo. It was taken into consideration even a class based approach possibly achieved by something like this:
+
+```ts
+// in `@koine/i18n/types.ts`:
+export class I18nClass<Locales extends {}, ...all other configurable interfaces as generics> {
+  public Locale: keyof Locales;
+
+  constructor(locales: Locales) {
+    this.Locale = Object.keys(locales)[0] as keyof Locales;
+  }
+}
+
+// somewhere in the project using @koine/i18n
+import { I18n } from "@/i18n";
+
+const myLocale: I18n["Locale"] = "";
+
+```
+This was discarded for a better _dx_ as using `I18n["Locale"]` is not as nice as using the namespace form of this `I18n.Locale`.
+For a better _dx_ it was also decided not to export any `I18n` namespace from `@koine/i18n` to avoid amibguity in the IDE autocomplete feature as the same namespace is always exported from the compiled output.

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

@@ -9,7 +9,7 @@ var o = createAdapter.createGenerator("js", (e)=>{
             name: "locales",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 export const locales = ${l} as const;
 
 export default locales;
@@ -19,7 +19,7 @@ export default locales;
             name: "defaultLocale",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 import type { I18n } from "./types";
 
 export const defaultLocale: I18n.Locale = "${o.defaultLocale}";
@@ -31,7 +31,7 @@ export default defaultLocale;
             name: "config",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 import { locales } from "./locales";
 import { defaultLocale } from "./defaultLocale";
 
@@ -49,7 +49,8 @@ export default config;
         configCjs: {
             name: "config.cjs",
             ext: "js",
-            content: ()=>/* js */ `
+            index: !1,
+            content: ()=>`
 const { locales } = require("./locales");
 const { defaultLocale } = require("./defaultLocale");
 

package/adapter-js/generators/config.d.ts

@@ -20,6 +20,7 @@ declare const _default: (data: import("../../compiler-sync").I18nCompiler.DataCo
     configCjs: {
         name: string;
         ext: "js";
+        index: false;
         content: () => string;
     };
 };

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

@@ -7,7 +7,7 @@ var o = createGenerator("js", (e)=>{
             name: "locales",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 export const locales = ${l} as const;
 
 export default locales;
@@ -17,7 +17,7 @@ export default locales;
             name: "defaultLocale",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 import type { I18n } from "./types";
 
 export const defaultLocale: I18n.Locale = "${o.defaultLocale}";
@@ -29,7 +29,7 @@ export default defaultLocale;
             name: "config",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 import { locales } from "./locales";
 import { defaultLocale } from "./defaultLocale";
 
@@ -47,7 +47,8 @@ export default config;
         configCjs: {
             name: "config.cjs",
             ext: "js",
-            content: ()=>/* js */ `
+            index: !1,
+            content: ()=>`
 const { locales } = require("./locales");
 const { defaultLocale } = require("./defaultLocale");
 

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

@@ -1,16 +1,15 @@
 'use strict';
 
 var createAdapter = require('../../compiler/createAdapter.cjs.js');
-var helpers = require('../../compiler/helpers.cjs.js');
 
 var t = createAdapter.createGenerator("js", (e)=>{
-    let { options: n } = e, { start: r, end: a } = n.translations.tokens.dynamicDelimiters;
+    let { options: t } = e;
     return {
         createT: {
             name: "createT",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 import type { I18n } from "./types";
 import { defaultLocale } from "./defaultLocale";
 import { tInterpolateParams } from "./tInterpolateParams";
@@ -24,7 +23,7 @@ const allowEmptyStrings = true;
 /**
  * @see https://github.com/aralroca/next-translate/blob/master/src/transCore.tsx
  */
-export function createT<TNamespace extends I18n.TranslateNamespace>(
+export function createT(
   dictionaries: I18n.Dictionaries,
   pluralRules: Intl.PluralRules,
   locale: string = defaultLocale,
@@ -54,7 +53,7 @@ export function createT<TNamespace extends I18n.TranslateNamespace>(
     query?: I18n.TranslationQuery,
     options?: I18n.TranslationOptions,
   ): TReturn => {
-    const [namespace, key] = path.split("${n.translations.tokens.namespaceDelimiter}");
+    const [namespace, key] = path.split("${t.translations.tokens.namespaceDelimiter}");
     const dic = (namespace && dictionaries[namespace]) || {};
     const pluralisedKey = getPluralisedKey(pluralRules, dic, key, query, options);
     const dicValue = getDicValue(dic, pluralisedKey, query, options);
@@ -66,6 +65,7 @@ export function createT<TNamespace extends I18n.TranslateNamespace>(
     const empty =
       typeof value === "undefined" ||
       (typeof value === "object" && !Object.keys(value).length) ||
+      (Array.isArray(value) && !value.length) ||
       (value === "" && !allowEmptyStrings);
 
     // no need to try interpolation
@@ -168,10 +168,6 @@ function interpolation(
   if (!text || !query || query === "obj") return text || "";
 
   return tInterpolateParams(text, query);
-  // return Object.keys(query).reduce((all, key) => {
-  //   const regex = new RegExp(\`${helpers.escapeEachChar(r)}\\s*\${key}(?:[\\s,]+([\\w-]*))?\\s*\$${helpers.escapeEachChar(a)}\`, "gm");
-  //   return all.replace(regex, (_match) => query[key as keyof typeof query] as string);
-  // }, text);
 }
 
 function objectInterpolation(

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

@@ -1,14 +1,13 @@
 import { createGenerator } from '../../compiler/createAdapter.esm.js';
-import { escapeEachChar } from '../../compiler/helpers.esm.js';
 
 var t = createGenerator("js", (e)=>{
-    let { options: n } = e, { start: r, end: a } = n.translations.tokens.dynamicDelimiters;
+    let { options: t } = e;
     return {
         createT: {
             name: "createT",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 import type { I18n } from "./types";
 import { defaultLocale } from "./defaultLocale";
 import { tInterpolateParams } from "./tInterpolateParams";
@@ -22,7 +21,7 @@ const allowEmptyStrings = true;
 /**
  * @see https://github.com/aralroca/next-translate/blob/master/src/transCore.tsx
  */
-export function createT<TNamespace extends I18n.TranslateNamespace>(
+export function createT(
   dictionaries: I18n.Dictionaries,
   pluralRules: Intl.PluralRules,
   locale: string = defaultLocale,
@@ -52,7 +51,7 @@ export function createT<TNamespace extends I18n.TranslateNamespace>(
     query?: I18n.TranslationQuery,
     options?: I18n.TranslationOptions,
   ): TReturn => {
-    const [namespace, key] = path.split("${n.translations.tokens.namespaceDelimiter}");
+    const [namespace, key] = path.split("${t.translations.tokens.namespaceDelimiter}");
     const dic = (namespace && dictionaries[namespace]) || {};
     const pluralisedKey = getPluralisedKey(pluralRules, dic, key, query, options);
     const dicValue = getDicValue(dic, pluralisedKey, query, options);
@@ -64,6 +63,7 @@ export function createT<TNamespace extends I18n.TranslateNamespace>(
     const empty =
       typeof value === "undefined" ||
       (typeof value === "object" && !Object.keys(value).length) ||
+      (Array.isArray(value) && !value.length) ||
       (value === "" && !allowEmptyStrings);
 
     // no need to try interpolation
@@ -166,10 +166,6 @@ function interpolation(
   if (!text || !query || query === "obj") return text || "";
 
   return tInterpolateParams(text, query);
-  // return Object.keys(query).reduce((all, key) => {
-  //   const regex = new RegExp(\`${escapeEachChar(r)}\\s*\${key}(?:[\\s,]+([\\w-]*))?\\s*\$${escapeEachChar(a)}\`, "gm");
-  //   return all.replace(regex, (_match) => query[key as keyof typeof query] as string);
-  // }, text);
 }
 
 function objectInterpolation(

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

@@ -4,10 +4,10 @@ var createAdapter = require('../../compiler/createAdapter.cjs.js');
 
 var e = createAdapter.createGenerator("js", (t)=>({
         defaultI18nMetadata: {
-            // dir: createGenerator.dirs.internal,
             name: "defaultI18nMetadata",
             ext: "ts",
-            content: ()=>/* js */ `
+            index: !1,
+            content: ()=>`
 import type { I18n } from "./types";
 
 /**

package/adapter-js/generators/defaultI18nMetadata.d.ts

@@ -2,6 +2,7 @@ declare const _default: (data: import("../../compiler-sync").I18nCompiler.DataCo
     defaultI18nMetadata: {
         name: string;
         ext: "ts";
+        index: false;
         content: () => string;
     };
 };

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

@@ -2,10 +2,10 @@ import { createGenerator } from '../../compiler/createAdapter.esm.js';
 
 var e = createGenerator("js", (t)=>({
         defaultI18nMetadata: {
-            // dir: createGenerator.dirs.internal,
             name: "defaultI18nMetadata",
             ext: "ts",
-            content: ()=>/* js */ `
+            index: !1,
+            content: ()=>`
 import type { I18n } from "./types";
 
 /**

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

@@ -1,29 +1,49 @@
 'use strict';
 
-var createAdapter = require('../../compiler/createAdapter.cjs.js');
+Object.defineProperty(exports, '__esModule', { value: true });
 
-var a = createAdapter.createGenerator("js", (e)=>{
-    let { config: a } = e;
-    return {
-        formatTo: {
-            name: "formatTo",
-            ext: "ts",
-            content: ()=>/* js */ `
-import { defaultLocale } from "./defaultLocale";
+var createAdapter = require('../../compiler/createAdapter.cjs.js');
+var functions = require('../../compiler/functions.cjs.js');
+var imports = require('../../compiler/imports.cjs.js');
 
-/**
- * @internal
- */
-export function formatTo(
-  locale: string | undefined,
-  pathname: string,
-  params?: object,
-) {
+const formatTo = ({ hideDefaultLocaleInUrl: e })=>new functions.FunctionsCompiler({
+        imports: [
+            new imports.ImportsCompiler({
+                path: "defaultLocale",
+                named: [
+                    {
+                        name: "defaultLocale"
+                    }
+                ]
+            })
+        ],
+        comment: {
+            internal: !0
+        },
+        name: "tInterpolateParams",
+        args: [
+            {
+                name: "locale",
+                type: "string | undefined",
+                optional: !1
+            },
+            {
+                name: "pathname",
+                type: "string",
+                optional: !1
+            },
+            {
+                name: "params",
+                type: "object",
+                optional: !0
+            }
+        ],
+        body: ({ format: a })=>`{
   locale = locale || defaultLocale;
   if (process.env["NODE_ENV"] === "development") {
     if (params) {
       pathname.replace(/\\[(.*?)\\]/g, (_, dynamicKey) => {
-        const key = dynamicKey as Extract<keyof typeof params, string>;
+        const key = dynamicKey${"ts" === a ? " as Extract<keyof typeof params, string>" : ""};
 
         if (!(key in params)) {
           console.warn(
@@ -56,21 +76,35 @@ export function formatTo(
     pathname = pathname.replace(
         /\\[(.*?)\\]/g,
         (_, key) =>
-          params[key as keyof typeof params] + "",
+          params[key${"ts" === a ? " as keyof typeof params" : ""}] + "",
       )
   }
-  ${a.hideDefaultLocaleInUrl ? `
+  ${e ? `
   if (locale !== defaultLocale) {
     return "/" + locale + (pathname === "/" ? "" : pathname);
   }
   ` : ""}
   return pathname;
-}
-
-// export default formatTo;
+}`
+    });
+var a = createAdapter.createGenerator("js", (e)=>{
+    let { config: a } = e;
+    return {
+        formatTo: {
+            name: "formatTo",
+            ext: "ts",
+            index: !1,
+            content: ()=>`
+${formatTo(a).$out("ts", {
+                    imports: {
+                        folderUp: 0
+                    },
+                    exports: "named"
+                })}
 `
         }
     };
 });
 
-module.exports = a;
+exports.default = a;
+exports.formatTo = formatTo;

package/adapter-js/generators/formatTo.d.ts

@@ -1,7 +1,11 @@
-declare const _default: (data: import("../../compiler-sync").I18nCompiler.DataCode<"js">) => {
+import { FunctionsCompiler } from "../../compiler/functions";
+import type { I18nCompiler } from "../../compiler/types";
+export declare const formatTo: ({ hideDefaultLocaleInUrl, }: Pick<I18nCompiler.Config, "hideDefaultLocaleInUrl">) => FunctionsCompiler;
+declare const _default: (data: I18nCompiler.DataCode<"js">) => {
     formatTo: {
         name: string;
         ext: "ts";
+        index: false;
         content: () => string;
     };
 };

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

@@ -1,27 +1,45 @@
 import { createGenerator } from '../../compiler/createAdapter.esm.js';
+import { FunctionsCompiler } from '../../compiler/functions.esm.js';
+import { ImportsCompiler } from '../../compiler/imports.esm.js';
 
-var a = createGenerator("js", (e)=>{
-    let { config: a } = e;
-    return {
-        formatTo: {
-            name: "formatTo",
-            ext: "ts",
-            content: ()=>/* js */ `
-import { defaultLocale } from "./defaultLocale";
-
-/**
- * @internal
- */
-export function formatTo(
-  locale: string | undefined,
-  pathname: string,
-  params?: object,
-) {
+const formatTo = ({ hideDefaultLocaleInUrl: e })=>new FunctionsCompiler({
+        imports: [
+            new ImportsCompiler({
+                path: "defaultLocale",
+                named: [
+                    {
+                        name: "defaultLocale"
+                    }
+                ]
+            })
+        ],
+        comment: {
+            internal: !0
+        },
+        name: "tInterpolateParams",
+        args: [
+            {
+                name: "locale",
+                type: "string | undefined",
+                optional: !1
+            },
+            {
+                name: "pathname",
+                type: "string",
+                optional: !1
+            },
+            {
+                name: "params",
+                type: "object",
+                optional: !0
+            }
+        ],
+        body: ({ format: a })=>`{
   locale = locale || defaultLocale;
   if (process.env["NODE_ENV"] === "development") {
     if (params) {
       pathname.replace(/\\[(.*?)\\]/g, (_, dynamicKey) => {
-        const key = dynamicKey as Extract<keyof typeof params, string>;
+        const key = dynamicKey${"ts" === a ? " as Extract<keyof typeof params, string>" : ""};
 
         if (!(key in params)) {
           console.warn(
@@ -54,21 +72,34 @@ export function formatTo(
     pathname = pathname.replace(
         /\\[(.*?)\\]/g,
         (_, key) =>
-          params[key as keyof typeof params] + "",
+          params[key${"ts" === a ? " as keyof typeof params" : ""}] + "",
       )
   }
-  ${a.hideDefaultLocaleInUrl ? `
+  ${e ? `
   if (locale !== defaultLocale) {
     return "/" + locale + (pathname === "/" ? "" : pathname);
   }
   ` : ""}
   return pathname;
-}
-
-// export default formatTo;
+}`
+    });
+var a = createGenerator("js", (e)=>{
+    let { config: a } = e;
+    return {
+        formatTo: {
+            name: "formatTo",
+            ext: "ts",
+            index: !1,
+            content: ()=>`
+${formatTo(a).$out("ts", {
+                    imports: {
+                        folderUp: 0
+                    },
+                    exports: "named"
+                })}
 `
         }
     };
 });
 
-export { a as default };
+export { a as default, formatTo };

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

@@ -3,22 +3,21 @@
 var createAdapter = require('../../compiler/createAdapter.cjs.js');
 
 var m = createAdapter.createGenerator("js", (e)=>{
-    let { config: { baseUrl: t, trailingSlash: a } } = e;
+    let { config: { baseUrl: a, trailingSlash: t } } = e;
     return {
         formatUrl: {
             name: "formatUrl",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 /**
  * Returns an absolute normalised URL prepending the \`baseUrl\` i18n option to
  * the given pathname. It respects the \`trailingSlash\` option.
  * 
+ * @internal
  * @param pathname Normalised, always prepended with a locale (if needed) and a slash
  */
-export const formatUrl = (pathname: string) => "${t}" + ${a ? "pathname" : '(pathname === "/" ? "" : pathname)'};
-
-export default formatUrl;
+export const formatUrl = (pathname: string) => "${a}" + ${t ? "pathname" : '(pathname === "/" ? "" : pathname)'};
 `
         }
     };

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

@@ -1,22 +1,21 @@
 import { createGenerator } from '../../compiler/createAdapter.esm.js';
 
 var m = createGenerator("js", (e)=>{
-    let { config: { baseUrl: t, trailingSlash: a } } = e;
+    let { config: { baseUrl: a, trailingSlash: t } } = e;
     return {
         formatUrl: {
             name: "formatUrl",
             ext: "ts",
             index: !0,
-            content: ()=>/* js */ `
+            content: ()=>`
 /**
  * Returns an absolute normalised URL prepending the \`baseUrl\` i18n option to
  * the given pathname. It respects the \`trailingSlash\` option.
  * 
+ * @internal
  * @param pathname Normalised, always prepended with a locale (if needed) and a slash
  */
-export const formatUrl = (pathname: string) => "${t}" + ${a ? "pathname" : '(pathname === "/" ? "" : pathname)'};
-
-export default formatUrl;
+export const formatUrl = (pathname: string) => "${a}" + ${t ? "pathname" : '(pathname === "/" ? "" : pathname)'};
 `
         }
     };

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

@@ -7,13 +7,12 @@ var s = createAdapter.createGenerator("js", (e)=>({
         getI18nDictionaries: {
             name: "getI18nDictionaries",
             ext: "ts",
-            content: ()=>/* js */ `
+            index: !1,
+            content: ()=>`
 import { defaultLocale } from "./defaultLocale";
 import type { I18n } from "./types";
 
 ${getI18nDictionaries_inline.getI18nDictionaries_inline(0, !0)}
-
-// export default getI18nDictionaries;
 `
         }
     }));

package/adapter-js/generators/getI18nDictionaries.d.ts

@@ -2,6 +2,7 @@ declare const _default: (data: import("../../compiler-sync").I18nCompiler.DataCo
     getI18nDictionaries: {
         name: string;
         ext: "ts";
+        index: false;
         content: () => string;
     };
 };

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

@@ -5,13 +5,12 @@ var s = createGenerator("js", (e)=>({
         getI18nDictionaries: {
             name: "getI18nDictionaries",
             ext: "ts",
-            content: ()=>/* js */ `
+            index: !1,
+            content: ()=>`
 import { defaultLocale } from "./defaultLocale";
 import type { I18n } from "./types";
 
 ${getI18nDictionaries_inline(0, !0)}
-
-// export default getI18nDictionaries;
 `
         }
     }));

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

@@ -2,9 +2,7 @@
 
 var loadTranslations_inline = require('./loadTranslations_inline.cjs.js');
 
-/**
- * @requires {defaultLocale, I18n}
- */ const getI18nDictionaries_inline = (n, i)=>`
+const getI18nDictionaries_inline = (n, i)=>`
 // import { loadTranslations } from "./loadTranslations";
 
 ${loadTranslations_inline.loadTranslations_inline(n)}

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

@@ -1,8 +1,6 @@
 import { loadTranslations_inline } from './loadTranslations_inline.esm.js';
 
-/**
- * @requires {defaultLocale, I18n}
- */ const getI18nDictionaries_inline = (n, i)=>`
+const getI18nDictionaries_inline = (n, i)=>`
 // import { loadTranslations } from "./loadTranslations";
 
 ${loadTranslations_inline(n)}

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

@@ -8,8 +8,8 @@ var n = createAdapter.createGenerator("js", (t)=>{
         getI18nMetadata: {
             name: "getI18nMetadata",
             ext: "ts",
-            // prettier-ignore
-            content: ()=>/* js */ `
+            index: !1,
+            content: ()=>`
 import { defaultI18nMetadata } from "./defaultI18nMetadata";
 import { defaultLocale } from "./defaultLocale";
 import { formatUrl } from "./formatUrl";
@@ -23,7 +23,7 @@ type GetI18nMetadataOptions<TRouteId extends I18n.RouteId | RouteIdError> = {
 } & I18n.RouteArgs<TRouteId>;
 
 /**
- * - All localised variants should always be included (despite the current lang)
+ * - All localised variants should always be included (despite the current locale)
  * - We use the defaultLocale's URL as the \`x-default\` alternate value
  * @see https://developers.google.com/search/docs/specialty/international/localized-versions#html
  *
@@ -57,8 +57,6 @@ export function getI18nMetadata<TRouteId extends I18n.RouteId | RouteIdError>({
     ),` : e.length ? "to(id, params, currentLocale))," : "to(id, currentLocale)),"}
   };
 }
-
-// export default getI18nMetadata;
 `
         }
     };

package/adapter-js/generators/getI18nMetadata.d.ts

@@ -2,6 +2,7 @@ declare const _default: (data: import("../../compiler-sync").I18nCompiler.DataCo
     getI18nMetadata: {
         name: string;
         ext: "ts";
+        index: false;
         content: () => string;
     };
 };