@koine/i18n 2.0.0-beta.104 → 2.0.0-beta.105

package/adapter-next/code/I18nDocument.d.ts

@@ -0,0 +1,3 @@
+import type { I18nCompiler } from "../../compiler/types";
+declare const _default: ({}: I18nCompiler.AdapterArg<"next">) => string;
+export default _default;

package/api.cjs.js

@@ -535,7 +535,7 @@ export const routes = ${e} as const;
 `;
 });
 
-var u$2 = (({})=>`
+var u$3 = (({})=>`
 
 export type RouteIdError = (typeof routesError)[number];
 
@@ -961,7 +961,7 @@ let c$2 = (e, a)=>!utils.isArray(a) && utils.isObject(a) && hasPlurals(a) ? hasO
     } else o += "";
     return(// adjust syntax
     (o = o.replace(/;\[\];/g, "[];")).replace(/;+/g, ";"));
-}, u$1 = (e, t)=>{
+}, u$2 = (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", "");
@@ -1090,7 +1090,7 @@ export namespace I18n {
    * more sophisticated than the type result of \`typeof "./en/messages.json"\`
    */
   export type TranslationsDictionary = {
-    ${u$1(e, t).join("\n    ")}
+    ${u$2(e, t).join("\n    ")}
   }
 
   /**
@@ -1436,7 +1436,7 @@ var t$1 = createAdapter(adapterJsOptions, ({})=>({
             },
             {
                 name: "routesError",
-                fn: u$2,
+                fn: u$3,
                 ext: "ts"
             },
             {
@@ -1792,6 +1792,82 @@ export const I18nApp = (props: I18nAppProps) => {
 export default I18nApp;
 `);
 
+var o$6 = (({})=>`
+"use client";
+
+import type { AppProps } from "next/app";
+import { defaultI18nMetadata } from "./defaultI18nMetadata";
+import { defaultLocale } from "./defaultLocale";
+import { I18nProvider } from "./I18nProvider";
+import { I18nMetadataProvider } from "./I18nMetadataProvider";
+import { I18nEffects } from "./I18nEffects";
+import { I18nHead } from "./I18nHead";
+import type { I18n } from "./types";
+
+/**
+ * @internal
+ */
+export type I18nAppPropsData = {
+  i18n: {
+    locale: I18n.Locale;
+    dictionaries: I18n.Dictionaries;
+    metadata: I18n.Metadata;
+  }
+};
+
+const i18nDefaults: I18nAppPropsData["i18n"] = {
+  locale: defaultLocale,
+  dictionaries: {},
+  metadata: defaultI18nMetadata
+};
+
+type I18nAppProps =  React.PropsWithChildren<
+  AppProps<I18nAppPropsData>["pageProps"]
+>;
+
+/**
+ * To use in \`_app.tsx\` file wrapping your component
+ * 
+ * **For Pages Router only**
+ * 
+ * NB: Consider that when using ISR with \`fallback: true\` the first load
+ * will not have any useful i18n data (App's \`pageProps\` is an empty object),
+ * hence we provide a \`i18nDefaults\` object.
+ * 
+ * @usage
+ * \`\`\`ts
+ * export default function App(props: AppProps) {
+ *   const { Component, pageProps } = props;
+ *   
+ *   return (
+ *     <I18nApp {...pageProps}>
+ *       <Component {...pageProps} />
+ *     </I18nApp>
+ *   );
+ * }
+ * \`\`\`
+ */
+export const I18nApp = (props: I18nAppProps) => {
+  const { i18n, children } = props;
+  const { locale, dictionaries, metadata } = i18n || i18nDefaults;
+  
+  return (
+    <I18nProvider
+      locale={locale}
+      dictionaries={dictionaries}
+    >
+      <I18nHead metadata={metadata} />
+      <I18nMetadataProvider metadata={metadata}>
+        {children}
+      </I18nMetadataProvider>
+      <I18nEffects />
+    </I18nProvider>
+  );
+};
+
+export default I18nApp;
+`);
+
 /**
  * We cannot re-use `I18nHeadTags` as NextHead component does needs HTML tags
  * to be its immediate children.
@@ -1839,7 +1915,7 @@ export const I18nHead = (props: I18nHeadProps) => {
 // export default I18nHead;
 `);
 
-var o$6 = (({})=>`
+var m$3 = (({})=>`
 import { I18nProvider } from "./I18nProvider";
 import { defaultLocale } from "./defaultLocale";
 // import { getI18nDictionaries } from "./getI18nDictionaries";
@@ -1878,7 +1954,7 @@ export const I18nLayout = async ({
 export default I18nLayout;
 `);
 
-var m$3 = (({ config: { single: t }, options: { routes: { localeParamName: a } } })=>`
+var i$4 = (({ config: { single: t }, options: { routes: { localeParamName: a } } })=>`
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { notFound } from "next/navigation";
 import { I18nMetadataSetter } from "./I18nMetadataSetter";
@@ -1980,7 +2056,7 @@ I18nPage.metadata = <TRouteId extends I18n.RouteId>(
 export default I18nPage;
 `);
 
-var i$4 = (({})=>`
+var x$2 = (({})=>`
 import { defaultI18nMetadata } from "./defaultI18nMetadata";
 import { I18nMetadataProvider } from "./I18nMetadataProvider";
 import { I18nRouteProvider } from "./I18nRouteProvider";
@@ -2007,7 +2083,7 @@ export const I18nRoot = ({ children }: I18nRootProps) => {
 export default I18nRoot;
 `);
 
-var x$2 = (({})=>`
+var a$3 = (({})=>`
 "use client";
 
 import { useContext, useEffect } from "react";
@@ -2052,7 +2128,7 @@ export const I18nSetter = <TRouteId extends I18n.RouteId>(
 export default I18nSetter;
 `);
 
-var a$3 = (({ options: { routes: { localeParamName: a } } })=>`
+var f$2 = (({ options: { routes: { localeParamName: a } } })=>`
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import type { GetStaticPathsContext, GetStaticPropsContext } from "next";
 import type { I18nAppPropsData } from "./I18nApp";
@@ -2368,12 +2444,12 @@ const generateRewriteForPathname = (e, t, r, a, l)=>{
         e.source.localeCompare(t.source));
 };
 
-var f$2 = (({ config: e, routes: t, options: o })=>{
+var s$4 = (({ config: e, routes: t, options: o })=>{
     let l = JSON.stringify(generateRewrites(e, o.routes, t.byId), null, 2);
     return `module.exports = ${l}`;
 });
 
-var s$4 = (({ options: { routes: { localeParamName: t } }, adapterOptions: { router: e } })=>{
+var d$4 = (({ options: { routes: { localeParamName: t } }, adapterOptions: { router: e } })=>{
     let o = t ? `.replace("[${t}]/", "")` : "";
     switch(e){
         case "app":
@@ -2432,7 +2508,7 @@ export default useRouteId;
     }
 });
 
-var d$4 = (({})=>`
+var I$2 = (({})=>`
 "use client";
 
 import { to } from "./to";
@@ -2459,7 +2535,7 @@ export const useTo = () => {
 export default useTo;
 `);
 
-var I$2 = (({})=>`
+var u$1 = (({})=>`
 "use client";
 
 import { toSpa } from "./toSpa";
@@ -2495,7 +2571,7 @@ export default useToSpa;
 `);
 
 var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
-    let { router: t } = e, u = [
+    let { router: t } = e, c = [
         // TODO: maybe remove these files, they are useful for debugging for now
         // but probably will be useless
         {
@@ -2505,51 +2581,51 @@ var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
         },
         {
             name: "next-rewrites",
-            fn: f$2,
+            fn: s$4,
             ext: "js"
         },
         {
             name: "useRouteId",
-            fn: s$4,
+            fn: d$4,
             ext: "ts",
             index: !0
         },
         {
             name: "useTo",
-            fn: d$4,
+            fn: I$2,
             ext: "ts",
             index: !0
         },
         {
             name: "useToSpa",
-            fn: I$2,
+            fn: u$1,
             ext: "ts",
             index: !0
         }
     ];
-    return ("app" === t || "migrating" === t) && (u = u.concat([
+    return ("app" === t || "migrating" === t) && (c = c.concat([
         {
             name: "I18nLayout",
-            fn: o$6,
+            fn: m$3,
             ext: "tsx",
             index: !0
         },
         {
             name: "I18nPage",
-            fn: m$3,
+            fn: i$4,
             ext: "tsx",
             index: !0
         },
         {
             name: "I18nRoot",
-            fn: i$4,
+            fn: x$2,
             ext: "tsx",
             index: !0
         }
-    ])), ("pages" === t || "migrating" === t) && (u = u.concat([
+    ])), ("pages" === t || "migrating" === t) && (c = c.concat([
         {
             name: "I18nSetter",
-            fn: x$2,
+            fn: a$3,
             ext: "tsx",
             index: !0
         },
@@ -2559,6 +2635,12 @@ var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
             ext: "tsx",
             index: !0
         },
+        {
+            name: "I18nDocument",
+            fn: o$6,
+            ext: "tsx",
+            index: !0
+        },
         {
             name: "I18nHead",
             fn: r$3,
@@ -2566,7 +2648,7 @@ var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
         },
         {
             name: "i18nGet",
-            fn: a$3,
+            fn: f$2,
             ext: "ts",
             index: !0
         }
@@ -2574,7 +2656,7 @@ var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
         dependsOn: [
             "react"
         ],
-        files: u
+        files: c
     };
 });
 

package/api.esm.js

@@ -513,7 +513,7 @@ export const routes = ${e} as const;
 `;
 });
 
-var u$2 = (({})=>`
+var u$3 = (({})=>`
 
 export type RouteIdError = (typeof routesError)[number];
 
@@ -939,7 +939,7 @@ let c$2 = (e, a)=>!isArray(a) && isObject(a) && hasPlurals(a) ? hasOnlyPluralKey
     } else o += "";
     return(// adjust syntax
     (o = o.replace(/;\[\];/g, "[];")).replace(/;+/g, ";"));
-}, u$1 = (e, t)=>{
+}, u$2 = (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", "");
@@ -1068,7 +1068,7 @@ export namespace I18n {
    * more sophisticated than the type result of \`typeof "./en/messages.json"\`
    */
   export type TranslationsDictionary = {
-    ${u$1(e, t).join("\n    ")}
+    ${u$2(e, t).join("\n    ")}
   }
 
   /**
@@ -1414,7 +1414,7 @@ var t$1 = createAdapter(adapterJsOptions, ({})=>({
             },
             {
                 name: "routesError",
-                fn: u$2,
+                fn: u$3,
                 ext: "ts"
             },
             {
@@ -1770,6 +1770,82 @@ export const I18nApp = (props: I18nAppProps) => {
 export default I18nApp;
 `);
 
+var o$6 = (({})=>`
+"use client";
+
+import type { AppProps } from "next/app";
+import { defaultI18nMetadata } from "./defaultI18nMetadata";
+import { defaultLocale } from "./defaultLocale";
+import { I18nProvider } from "./I18nProvider";
+import { I18nMetadataProvider } from "./I18nMetadataProvider";
+import { I18nEffects } from "./I18nEffects";
+import { I18nHead } from "./I18nHead";
+import type { I18n } from "./types";
+
+/**
+ * @internal
+ */
+export type I18nAppPropsData = {
+  i18n: {
+    locale: I18n.Locale;
+    dictionaries: I18n.Dictionaries;
+    metadata: I18n.Metadata;
+  }
+};
+
+const i18nDefaults: I18nAppPropsData["i18n"] = {
+  locale: defaultLocale,
+  dictionaries: {},
+  metadata: defaultI18nMetadata
+};
+
+type I18nAppProps =  React.PropsWithChildren<
+  AppProps<I18nAppPropsData>["pageProps"]
+>;
+
+/**
+ * To use in \`_app.tsx\` file wrapping your component
+ * 
+ * **For Pages Router only**
+ * 
+ * NB: Consider that when using ISR with \`fallback: true\` the first load
+ * will not have any useful i18n data (App's \`pageProps\` is an empty object),
+ * hence we provide a \`i18nDefaults\` object.
+ * 
+ * @usage
+ * \`\`\`ts
+ * export default function App(props: AppProps) {
+ *   const { Component, pageProps } = props;
+ *   
+ *   return (
+ *     <I18nApp {...pageProps}>
+ *       <Component {...pageProps} />
+ *     </I18nApp>
+ *   );
+ * }
+ * \`\`\`
+ */
+export const I18nApp = (props: I18nAppProps) => {
+  const { i18n, children } = props;
+  const { locale, dictionaries, metadata } = i18n || i18nDefaults;
+  
+  return (
+    <I18nProvider
+      locale={locale}
+      dictionaries={dictionaries}
+    >
+      <I18nHead metadata={metadata} />
+      <I18nMetadataProvider metadata={metadata}>
+        {children}
+      </I18nMetadataProvider>
+      <I18nEffects />
+    </I18nProvider>
+  );
+};
+
+export default I18nApp;
+`);
+
 /**
  * We cannot re-use `I18nHeadTags` as NextHead component does needs HTML tags
  * to be its immediate children.
@@ -1817,7 +1893,7 @@ export const I18nHead = (props: I18nHeadProps) => {
 // export default I18nHead;
 `);
 
-var o$6 = (({})=>`
+var m$3 = (({})=>`
 import { I18nProvider } from "./I18nProvider";
 import { defaultLocale } from "./defaultLocale";
 // import { getI18nDictionaries } from "./getI18nDictionaries";
@@ -1856,7 +1932,7 @@ export const I18nLayout = async ({
 export default I18nLayout;
 `);
 
-var m$3 = (({ config: { single: t }, options: { routes: { localeParamName: a } } })=>`
+var i$4 = (({ config: { single: t }, options: { routes: { localeParamName: a } } })=>`
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { notFound } from "next/navigation";
 import { I18nMetadataSetter } from "./I18nMetadataSetter";
@@ -1958,7 +2034,7 @@ I18nPage.metadata = <TRouteId extends I18n.RouteId>(
 export default I18nPage;
 `);
 
-var i$4 = (({})=>`
+var x$2 = (({})=>`
 import { defaultI18nMetadata } from "./defaultI18nMetadata";
 import { I18nMetadataProvider } from "./I18nMetadataProvider";
 import { I18nRouteProvider } from "./I18nRouteProvider";
@@ -1985,7 +2061,7 @@ export const I18nRoot = ({ children }: I18nRootProps) => {
 export default I18nRoot;
 `);
 
-var x$2 = (({})=>`
+var a$3 = (({})=>`
 "use client";
 
 import { useContext, useEffect } from "react";
@@ -2030,7 +2106,7 @@ export const I18nSetter = <TRouteId extends I18n.RouteId>(
 export default I18nSetter;
 `);
 
-var a$3 = (({ options: { routes: { localeParamName: a } } })=>`
+var f$2 = (({ options: { routes: { localeParamName: a } } })=>`
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import type { GetStaticPathsContext, GetStaticPropsContext } from "next";
 import type { I18nAppPropsData } from "./I18nApp";
@@ -2346,12 +2422,12 @@ const generateRewriteForPathname = (e, t, r, a, l)=>{
         e.source.localeCompare(t.source));
 };
 
-var f$2 = (({ config: e, routes: t, options: o })=>{
+var s$4 = (({ config: e, routes: t, options: o })=>{
     let l = JSON.stringify(generateRewrites(e, o.routes, t.byId), null, 2);
     return `module.exports = ${l}`;
 });
 
-var s$4 = (({ options: { routes: { localeParamName: t } }, adapterOptions: { router: e } })=>{
+var d$4 = (({ options: { routes: { localeParamName: t } }, adapterOptions: { router: e } })=>{
     let o = t ? `.replace("[${t}]/", "")` : "";
     switch(e){
         case "app":
@@ -2410,7 +2486,7 @@ export default useRouteId;
     }
 });
 
-var d$4 = (({})=>`
+var I$2 = (({})=>`
 "use client";
 
 import { to } from "./to";
@@ -2437,7 +2513,7 @@ export const useTo = () => {
 export default useTo;
 `);
 
-var I$2 = (({})=>`
+var u$1 = (({})=>`
 "use client";
 
 import { toSpa } from "./toSpa";
@@ -2473,7 +2549,7 @@ export default useToSpa;
 `);
 
 var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
-    let { router: t } = e, u = [
+    let { router: t } = e, c = [
         // TODO: maybe remove these files, they are useful for debugging for now
         // but probably will be useless
         {
@@ -2483,51 +2559,51 @@ var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
         },
         {
             name: "next-rewrites",
-            fn: f$2,
+            fn: s$4,
             ext: "js"
         },
         {
             name: "useRouteId",
-            fn: s$4,
+            fn: d$4,
             ext: "ts",
             index: !0
         },
         {
             name: "useTo",
-            fn: d$4,
+            fn: I$2,
             ext: "ts",
             index: !0
         },
         {
             name: "useToSpa",
-            fn: I$2,
+            fn: u$1,
             ext: "ts",
             index: !0
         }
     ];
-    return ("app" === t || "migrating" === t) && (u = u.concat([
+    return ("app" === t || "migrating" === t) && (c = c.concat([
         {
             name: "I18nLayout",
-            fn: o$6,
+            fn: m$3,
             ext: "tsx",
             index: !0
         },
         {
             name: "I18nPage",
-            fn: m$3,
+            fn: i$4,
             ext: "tsx",
             index: !0
         },
         {
             name: "I18nRoot",
-            fn: i$4,
+            fn: x$2,
             ext: "tsx",
             index: !0
         }
-    ])), ("pages" === t || "migrating" === t) && (u = u.concat([
+    ])), ("pages" === t || "migrating" === t) && (c = c.concat([
         {
             name: "I18nSetter",
-            fn: x$2,
+            fn: a$3,
             ext: "tsx",
             index: !0
         },
@@ -2537,6 +2613,12 @@ var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
             ext: "tsx",
             index: !0
         },
+        {
+            name: "I18nDocument",
+            fn: o$6,
+            ext: "tsx",
+            index: !0
+        },
         {
             name: "I18nHead",
             fn: r$3,
@@ -2544,7 +2626,7 @@ var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
         },
         {
             name: "i18nGet",
-            fn: a$3,
+            fn: f$2,
             ext: "ts",
             index: !0
         }
@@ -2552,7 +2634,7 @@ var n$4 = createAdapter(adapterNextOptions, ({ adapterOptions: e })=>{
         dependsOn: [
             "react"
         ],
-        files: u
+        files: c
     };
 });
 

package/package.json

@@ -2,8 +2,8 @@
   "name": "@koine/i18n",
   "sideEffects": false,
   "dependencies": {
-    "@koine/node": "2.0.0-beta.104",
-    "@koine/utils": "2.0.0-beta.104",
+    "@koine/node": "2.0.0-beta.105",
+    "@koine/utils": "2.0.0-beta.105",
     "glob": "^10.3.10",
     "webpack": "^5.90.1",
     "minimatch": "^9.0.3",
@@ -58,5 +58,5 @@
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "version": "2.0.0-beta.104"
+  "version": "2.0.0-beta.105"
 }