@koine/i18n 2.0.0-beta.76 → 2.0.0-beta.78

package/adapter-js/code/types.js

@@ -1,327 +0,0 @@
-import { forin as e, isArray as t, isBoolean as a, isObject as s, isString as n } from "@koine/utils";
-import { dataParamsToTsInterfaceBody as o } from "../../compiler/helpers";
-import { hasOnlyPluralKeys as i, hasPlurals as r, pickNonPluralValue as l, transformKeysForPlurals as p } from "../../compiler/pluralisation";
-let c = (e, a)=>!t(a) && s(a) && r(a) ? i(a) ? `"${e}": string;` : `"${e}": ${h(l(a))}` : `"${e}": ${h(a)}`, h = (e)=>{
-    let o = "", i = "";
-    if (a(e) ? i = "boolean" : n(e) && (i = "string"), i) o += i + ";";
-    else if (e) {
-        if (t(e)) {
-            let t = e[0];
-            o += `${h(t)}[];`;
-        } else if (s(e)) {
-            o += "{";
-            let t = p(Object.keys(e));
-            for(let a = 0; a < t.length; a++){
-                let s = t[a], n = e[s] || "";
-                o += c(s, n);
-            }
-            o += "};";
-        }
-    } else o += "";
-    return (o = o.replace(/;\[\];/g, "[];")).replace(/;+/g, ";");
-}, d = (e, t)=>{
-    let { translationFiles: a } = t, { defaultLocale: s } = e, n = a.filter((e)=>e.locale === s), o = [];
-    for(let e = 0; e < n.length; e++){
-        let { path: t, data: a } = n[e], s = t.replace(".json", "");
-        o.push(`"${s}": ${h(a)}`);
-    }
-    return o.sort();
-}, u = (t)=>{
-    let a = [];
-    return e(t.byId, (e, { params: t })=>{
-        t && a.push(`"${e}": { ${o(t)} };`);
-    }), a;
-}, T = (e)=>e.sort().map((e)=>`"${e}"`).join(" | "), y = (e, t)=>T(Object.keys(e.byId).filter((a)=>t(a, e.byId[a]))), m = (e)=>Object.keys(e.byId).reduce((t, a)=>{
-        if (e.byId[a].inWildcard) for(let s = 0; s < e.wildcardIds.length; s++){
-            let n = e.wildcardIds[s];
-            a.startsWith(n) && (t[n] = t[n] || [], t[n].push(a));
-        }
-        return t;
-    }, {}), f = (e, t, a)=>{
-    let s = m(t), n = [];
-    for(let o in s){
-        let i = s[o].map((e)=>e.split(o)[1].slice(1)), r = t.byId[o].pathnames[e.defaultLocale], l = [];
-        for(let s = 0; s < i.length; s++){
-            let n = i[s], p = `${o}${a.routes.tokens.idDelimiter}${n}`, c = t.byId[p].pathnames[e.defaultLocale].split(r)[1];
-            l.push(`"${n}": "${c}";`);
-        }
-        n.push(`"${o}": { ${l.join(" ")} }`);
-    }
-    return n;
-}, b = (e, t)=>{
-    let a = [];
-    for(let s in t.byId){
-        let n = t.byId[s];
-        a.push(`"${n.id}": "${n.pathnames[e.defaultLocale]}";`);
-    }
-    return a;
-};
-export default (({ config: e, input: t, routes: a, options: s })=>{
-    let n = y(a, (e, { params: t })=>!t), o = y(a, (e, { params: t })=>!!t), { idDelimiter: i } = s.routes.tokens;
-    return `
-/* eslint-disable @typescript-eslint/no-namespace */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/ban-types */
-import type { Split } from "@koine/utils";
-import type { I18nUtils } from "@koine/i18n";
-
-export namespace I18n {
-  /**
-   * Any of the available locale code
-   */
-  export type Locale = ${e.locales.map((e)=>`"${e}"`).join(" | ")};
- 
-  /**
-   * Utility to map values by all available locales
-   * 
-   * @usecase I need to map zendesk URLs to my project's locales
-   */
-  export type LocalesMap<T = any> = Record<Locale, T>;
-
-  /**
-   * Any of the available route id
-   */
-  export type RouteId = RouteIdStatic | RouteIdDynamic;
-
-  /**
-   * The static routes available ids
-   */
-  export type RouteIdStatic = ${n};
-
-  /**
-   * The dynamic routes available ids
-   */
-  export type RouteIdDynamic = ${o};
-
-  /**
-   * SPA routes ids map
-   */
-  /**
-   * Map every SPA path divided by their roots to their actual pathname value for the default locale
-   */
-  export type RouteSpa = {
-    ${f(e, a, s).join("\n    ")}
-  }
-
-  /**
-   * Map every route id to its actual pathanem value for the default locale
-   */
-  export type RoutePathnames = {
-    ${b(e, a).join("\n    ")}
-  }
-
-  /**
-   * Route dynamic params dictionary for each dynamic route id
-   */
-  export type RouteParams = {
-    ${u(a).join("\n    ")}
-  }
-
-  /**
-   * Utility to join two route ids
-   */
-  export type RouteJoinedId<Root extends string, Tail extends string> = \`\${Root}${i}\${Tail}\` extends RouteId ? \`\${Root}${i}\${Tail}\` : never;
-
-  /**
-   * Extract all children routes that starts with the given string
-   *
-   * This is useful to get the subroutes of an application area, e.g. all subroutes
-   * of a dashboard, using it with: \` type DashboardRoutes = RoutesChildrenOf<"dashboard">;\`
-   */
-  export type RoutesChildrenOf<
-    TStarts extends string,
-    T extends string = RouteId,
-  > = T extends \`\${TStarts}.\${infer First}\` ? \`\${TStarts}.\${First}\` : never;
-
-  /**
-   * 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 = {
-    ${d(e, t).join("\n    ")}
-  }
-
-  /**
-   * Any of the available translations namespaces
-   */
-  export type TranslateNamespace = Extract<keyof TranslationsDictionary, string>;
-
-  /**
-   * Translation **value** found at a specific _path_ in the given _namespace_
-   *
-   * \`TPath\` can be any of all possible paths:
-   * - \`myKey\` sub dictionaries within a namespace
-   * - \`myKey.nested\` whatever nested level of nesting within a namespace
-   */
-  export type TranslationAtPathFromNamespace<
-    TNamespace extends TranslateNamespace,
-    TPath extends TranslationsPaths<TranslationsDictionary[TNamespace]>,
-  > = TNamespace extends TranslateNamespace
-    ? TPath extends string // TranslationsPaths<TranslationsDictionary[TNamespace]>
-      ? I18nUtils.Get<TranslationsDictionary[TNamespace], TPath>
-      : TranslationsDictionary[TNamespace]
-    : never;
-
-  /**
-   * The generic type passed and to use with {@link TranslationAtPath} when you
-   * want to build a type extending that
-   */
-  export type TranslationAtPathGeneric =
-    | TranslateNamespace
-    | TranslationsAllPaths;
-
-  /**
-   * Translation **value** found at a _path_
-   *
-   * \`TPath\` can be any of all possible paths begininng with a namespace:
-   * - \`namespace\` only a namespace
-   * - \`namespace:myKey\` sub dictionaries within a namespace
-   * - \`namespace:myKey.nested\` whatever nested level of nesting
-   */
-  export type TranslationAtPath<TPath extends TranslationAtPathGeneric> =
-    TPath extends TranslateNamespace
-      ? TranslationsDictionary[TPath]
-      : TPath extends \`\${infer Namespace}:\${infer Path}\`
-        ? Namespace extends TranslateNamespace
-          ? I18nUtils.Get<TranslationsDictionary[Namespace], Path>
-          : never
-        : never;
-
-  /**
-   * All translations paths from the given _path_
-   *
-   * \`TPath\` can be any of all possible paths begininng with a namespace:
-   * - \`namespace\` only a namespace
-   * - \`namespace:myKey\` sub dictionaries within a namespace
-   * - \`namespace:myKey.nested\` whatever nested level of nesting
-   */
-  export type TranslationsPathsFrom<TPath extends TranslationAtPathGeneric> =
-    TPath extends TranslateNamespace
-      ? TranslationsPaths<TranslationsDictionary[TPath]>
-      : TPath extends \`\${infer Namespace}:\${infer Path}\`
-        ? Namespace extends TranslateNamespace
-          ? I18nUtils.Get<TranslationsDictionary[Namespace], Path> extends object
-            ? TranslationsPaths<I18nUtils.Get<TranslationsDictionary[Namespace], Path>>
-            : TranslationsPaths<TranslationsDictionary[Namespace]>
-          : never
-        : never;
-
-  /**
-   * All translations _paths_ of the given one, e.g. if \`TPath\` would be
-   * \`"dashboard.users.[id].edit"\` the generated type would be the union
-   * \`"dashboard.users.[id]" | "dashboard.users" | "dashboard"\`.
-   */
-  export type TranslationsPathsAncestors<
-    TPath extends string,
-    TSeparator extends string = ".",
-  > = I18nUtils.BuildRecursiveJoin<Split<TPath, TSeparator>, TSeparator>;
-
-  /**
-   * Recursive mapped type to extract all usable string paths from a translation
-   * definition object (usually from a JSON file).
-   */
-  export type TranslationsPaths<T, TAsObj extends boolean = true> = I18nUtils.Paths<T, TAsObj>;
-
-  /**
-   * Recursive mapped type of all usable string paths from the whole translations
-   * dictionary.
-   */
-  export type TranslationsAllPaths = I18nUtils.AllPaths<TranslationsDictionary>;
-
-  /**
-   * Unlike in \`next-translate\` we allow passing some predefined arguments as
-   * shortcuts for common use cases:
-   * - \`"obj"\` as a shortcut for \`{ returnObjects: true }\`
-   * - \`""\` as a shortcut for \`{ fallback: "" }\`
-   *
-   */
-  export type TranslationShortcut = "obj" | "";
-
-  /**
-   * Query object to populate the returned translated string interpolating data
-   * or a TranslationShortcut.
-   *
-   * NOTE: when using a shortcut passing TranslationOptions to \`t()\` is not supported
-   * TODO: type safe this behaviour of the third argument (options).
-   */
-  export type TranslationQuery =
-    | undefined
-    | null
-    | TranslationShortcut
-    | {
-        [key: string]: string | number | boolean;
-      };
-
-  /**
-   * Opions of the translate function or a TranslationShortcut.
-   *
-   * NOTE: when using a shortcut passing TranslationOptions to \`t()\` is not supported
-   * TODO: type safe this behaviour of the third argument (options).
-   */
-  export type TranslationOptions =
-    | undefined
-    | TranslationShortcut
-    | {
-        returnObjects?: boolean;
-        fallback?: string | string[];
-        default?: string;
-      };
-
-  /**
-   * Translate function which optionally accept a namespace as first argument
-   */
-  export type Translate<
-    TNamespace extends TranslateNamespace | undefined = TranslateNamespace,
-  > = TNamespace extends TranslateNamespace
-    ? TranslateNamespaced<TNamespace>
-    : TranslateDefault;
-
-  /**
-   * Translate function **without** namespace, it allows to select any of the all
-   * available strings in _all_ namespaces.
-   */
-  export type TranslateDefault = <
-    TPath extends TranslationsAllPaths,
-    TReturn = TranslationAtPath<TPath>,
-  >(
-    s: TPath,
-    q?: TranslationQuery,
-    o?: TranslationOptions,
-  ) => TReturn;
-
-  /**
-   * Translate function **with** namespace, it allows to select all available
-   * strings _only_ in the given namespace.
-   */
-  export type TranslateNamespaced<TNamespace extends TranslateNamespace> = <
-    TPath extends TranslationsPaths<TranslationsDictionary[TNamespace]>,
-    TReturn = TranslationAtPathFromNamespace<TNamespace, TPath>,
-  >(
-    s: TPath,
-    q?: TranslationQuery,
-    o?: TranslationOptions,
-  ) => TReturn;
-
-  /**
-   * Translate function _loose_ type, to use only in implementations that uses
-   * the \`t\` function indirectly without needng knowledge of the string it needs
-   * to output.
-   */
-  export type TranslateLoose<TReturn = string> = (
-    s?: any,
-    q?: TranslationQuery,
-    o?: TranslationOptions,
-  ) => TReturn;
-
-  /**
-   * Translate function _loosest_ type it allows to return string or object or array
-   * or whatever basically.
-   */
-  export type TranslateLoosest<TReturn = any> = (
-    s?: any,
-    q?: TranslationQuery,
-    o?: TranslationOptions,
-  ) => TReturn;
-}
-`;
-});

package/adapter-next/code/index.js

@@ -1,54 +0,0 @@
-import e from "./next-redirects";
-import t from "./next-rewrites";
-import n from "./useCurrentLocalisedPathnames";
-import s from "./useLocale";
-import r from "./useRouteId";
-import o from "./useTo";
-import m from "./useToSpa";
-export default (()=>({
-        dependsOn: [
-            "js"
-        ],
-        files: [
-            {
-                name: "next-redirects",
-                fn: e,
-                ext: "js"
-            },
-            {
-                name: "next-rewrites",
-                fn: t,
-                ext: "js"
-            },
-            {
-                name: "useCurrentLocalisedPathnames",
-                fn: n,
-                ext: "ts",
-                index: !0
-            },
-            {
-                name: "useLocale",
-                fn: s,
-                ext: "ts",
-                index: !0
-            },
-            {
-                name: "useRouteId",
-                fn: r,
-                ext: "ts",
-                index: !0
-            },
-            {
-                name: "useTo",
-                fn: o,
-                ext: "ts",
-                index: !0
-            },
-            {
-                name: "useToSpa",
-                fn: m,
-                ext: "ts",
-                index: !0
-            }
-        ]
-    }));

package/adapter-next/code/next-redirects.js

@@ -1,5 +0,0 @@
-import { generateRedirects as r } from "../redirects";
-export default (({ config: e, routes: t, options: o })=>{
-    let l = JSON.stringify(r(e, t.byId, o.routes), null, 2);
-    return `module.exports = ${l}`;
-});

package/adapter-next/code/next-rewrites.js

@@ -1,5 +0,0 @@
-import { generateRewrites as r } from "../rewrites";
-export default (({ config: e, routes: t, options: o })=>{
-    let l = JSON.stringify(r(e, t.byId, o.routes), null, 2);
-    return `module.exports = ${l}`;
-});

package/adapter-next/code/useCurrentLocalisedPathnames.js

@@ -1,20 +0,0 @@
-export default (()=>`
-"use client";
-
-import { useEffect, useState } from "react";
-import { deriveLocalisedPathnames, type LocalisedPathnames } from "./deriveLocalisedPathnames";
-import { useRouteId } from "./useRouteId";
-
-export function useCurrentLocalisedPathnames() {
-  const routeId = useRouteId();
-  const [urls, setUrls] = useState<LocalisedPathnames>({} as LocalisedPathnames);
-
-  useEffect(() => {
-    setUrls(deriveLocalisedPathnames(routeId, location));
-  }, [routeId]);
-
-  return urls;
-}
-
-export default useCurrentLocalisedPathnames;
-`);

package/adapter-next/code/useLocale.js

@@ -1,8 +0,0 @@
-export default (({ config: e })=>`
-import { useRouter } from "next/router";
-import type { I18n } from "./types";
-
-export const useLocale = () => (useRouter().locale as I18n.Locale) || "${e.defaultLocale}";
-
-export default useLocale;
-`);

package/adapter-next/code/useRouteId.js

@@ -1,10 +0,0 @@
-export default (()=>`
-import { useRouter } from "next/router";
-import type { I18n } from "./types";
-import { pathnameToRouteId } from "./pathnameToRouteId";
-
-export const useRouteId = () => 
-  pathnameToRouteId(useRouter().pathname) as I18n.RouteId;
-
-export default useRouteId;
-`);

package/adapter-next/code/useTo.js

@@ -1,26 +0,0 @@
-export default (()=>`
-"use client";
-
-import { to } from "./to";
-import type { I18n } from "./types";
-import { useLocale } from "./useLocale";
-
-export type UseToReturn = ReturnType<typeof useTo>;
-
-export const useTo = () => {
-  const locale = useLocale();
-  return <Id extends I18n.RouteId>(
-    routeId: Id,
-    ...args: Id extends I18n.RouteIdDynamic
-      ? [params: I18n.RouteParams[Id]]
-      : []
-  ) =>
-    args[0]
-      ? // @ts-expect-error nevermind
-        (to(routeId, args[0], locale) as I18n.RoutePathnames[Id])
-      : // @ts-expect-error nevermind
-        (to(routeId, locale) as I18n.RoutePathnames[Id]);
-};
-
-export default useTo;
-`);

package/adapter-next/code/useToSpa.js

@@ -1,34 +0,0 @@
-export default (()=>`
-"use client";
-
-import { toSpa } from "./toSpa";
-import type { I18n } from "./types";
-import { useLocale } from "./useLocale";
-
-export type UseToSpaReturn = ReturnType<typeof useToSpa>;
-
-export const useToSpa = () => {
-  const locale = useLocale();
-  return <
-    Root extends keyof I18n.RouteSpa,
-    Path extends Extract<keyof I18n.RouteSpa[Root], string>,
-  >(
-    root: Root,
-    path: Path,
-    ...args: I18n.RouteJoinedId<Root, Path> extends I18n.RouteIdDynamic
-      ? [params: I18n.RouteParams[I18n.RouteJoinedId<Root, Path>]]
-      : I18n.RouteJoinedId<Root, Path> extends I18n.RouteIdStatic
-        ? []
-        : never
-  ) => {
-    const [params] = args;
-    return (
-      // prettier-ignore
-      // @ts-expect-error FIXME: types
-      (params ? toSpa(root, path, params, locale) : toSpa(root, path, locale)) as I18n.RouteSpa[Root][Path]
-    );
-  };
-};
-
-export default useToSpa;
-`);

package/adapter-next/plugin-async.js

@@ -1,11 +0,0 @@
-import { i18nCompiler as t } from "../compiler";
-import { getRedirects as e, getRewrites as r, tweakNextConfig as i } from "./plugin-shared";
-export let withI18nAsync = (a = {})=>async ()=>{
-        let { i18nCompiler: n, redirects: l, rewrites: o, ...p } = a, c = p;
-        if (!n) return c;
-        let m = await t(n);
-        if ((c = i(m.config, c)).redirects = ()=>e(l, n, m), c.rewrites = ()=>r(o, n, m), "next-translate" === n.code.adapter) try {
-            c = (await import("next-translate-plugin").then((t)=>t.default))(c);
-        } catch (t) {}
-        return c;
-    };