npm - @nimpl/i18n - Versions diffs - 0.0.0-experimental-47e75fe → 0.0.0-experimental-504b302 - Mend

@nimpl/i18n 0.0.0-experimental-47e75fe → 0.0.0-experimental-504b302

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

package/ClientTranslation.d.ts +2 -2
package/README.md +295 -23
package/dist/ClientTranslation.js +7 -6
package/dist/initialize.js +88 -0
package/dist/lib/ClientI18nProvider.js +3 -2
package/dist/lib/Translation.js +2 -1
package/dist/lib/format-translate.js +16 -0
package/dist/{getTranslation.js → lib/get-translation-core.js} +6 -11
package/dist/lib/injectQuery.js +2 -1
package/dist/lib/parseEntities.js +2 -1
package/dist/lib/translation-core.js +15 -0
package/dist/lib/transmitter-core.js +38 -0
package/dist/useTranslation.js +4 -6
package/initialize.d.ts +17 -0
package/package.json +3 -16
package/types.d.ts +10 -0
package/useTranslation.d.ts +2 -2
package/I18nTransmitter.d.ts +0 -10
package/ServerTranslation.d.ts +0 -12
package/clientConfig.d.ts +0 -0
package/dist/I18nTransmitter.js +0 -43
package/dist/ServerTranslation.js +0 -14
package/dist/clientConfig.js +0 -2
package/dist/configuration/getConfig.js +0 -68
package/dist/configuration/types.js +0 -2
package/dist/helpers/isPromise.js +0 -10
package/dist/i18n.js +0 -29
package/dist/lib/formatServerTranslate.js +0 -18
package/dist/lib/loadI18nData.js +0 -25
package/getTranslation.d.ts +0 -10
package/i18n.d.ts +0 -2

package/ClientTranslation.d.ts CHANGED Viewed

@@ -7,5 +7,5 @@ type ClientTranslationProps = {
     query?: I18nOptions["query"];
     removeUnusedQueries?: I18nOptions["removeUnusedQueries"];
 };
-declare const ClientTranslation: React.FC<ClientTranslationProps>;
-export default ClientTranslation;
+export declare const ClientTranslation: React.FC<ClientTranslationProps>;
+export {};

package/README.md CHANGED Viewed

@@ -1,49 +1,321 @@
 # @nimpl/i18n
-(Former [next-translation](https://www.npmjs.com/package/next-translation))
+<PackageLinks npmName="@nimpl/i18n" githubName="nimpl-i18n" />
-i18n library designed primarily with server components in mind and maximum optimization (due to the transfer of logic to the assembly stage and/or server side).
+i18n library designed for React Server Components with maximum optimization (due to the transfer of logic to the assembly stage and/or server side).
-Visit https://nimpl.dev/docs/i18n to view the full documentation.
+<!---robin-->
-## Why one more library?
+Read the documentation in a convenient interface at [nimpl.dev/docs/i18n](https://nimpl.dev/docs/i18n)
-Server components are a recent feature in React. Existing translation libraries are not yet well-optimized for them. If they support it, then only by disabling Next.js static optimization.
+<!---/robin-->
-This library is an attempt to create a highly optimized solution exclusively using the current capabilities of React.js, Next.js and node.js.
+## Installation
+```bash
+npm i @nimpl/i18n
+```
-## Features
+## Why This Library?
-Support for loading translations during page rendering (_instead of the application build step_), allowing for up-to-date translations with ISR or SSR;
+Most i18n libraries either load the entire dictionary on the client or disable static optimization when working with Server Components.
-Support for revalidation logic, i.e. you can specify how often translations should be updated (_or that they should not be updated at all_);
+This library resolves translations on the server. Client components only receive the specific precompiled keys they need through the `Transmitter` wrapper - not the whole dictionary. Pages remain statically generated with translations baked into the HTML.
-Optimized caching system - not a single extra request will be sent, even with parallel building (which is now enabled by default);
+## Quick Start
-Passing only those translations to the client that are needed on the client;
+### 1. Create i18n Configuration
-Embedding parameters in client translations on the server;
+Create a configuration file (e.g., `src/i18n.ts`):
-Support for html entities.
+```ts
+import { initialize } from "@nimpl/i18n/initialize";
+import fs from "fs/promises";
-## Installation
+export const { getTranslation, ServerTranslation, Transmitter, revalidate } = initialize({
+  load: async (language) => {
+    const data = await fs.readFile(`./translations/${language}.json`, "utf-8");
+    return JSON.parse(data);
+  },
+  getLanguage: async () => {
+    // Use next/root-params, @nimpl/getters, @nimpl/context or implement your own language detection
+    const { params } = await import("@nimpl/getters/get-params").then(m => m.getParams());
+    return params.lang as string;
+  },
+  languages: ["en", "de", "fr"],
+  cache: true,
+});
+```
-**Using npm:**
+### 2. Set Up Routes
-```bash
-npm i @nimpl/i18n
+```
+app/
+  [lang]/
+    layout.tsx
+    page.tsx
 ```
-**Using yarn:**
+```tsx
+// app/[lang]/layout.tsx
+export default function RootLayout({
+  children,
+  params,
+}: {
+  children: React.ReactNode;
+  params: { lang: string };
+}) {
+  return (
+    <html lang={params.lang}>
+      <body>{children}</body>
+    </html>
+  );
+}
+```
-```bash
-yarn add @nimpl/i18n
+### 3. Use Translations
+```tsx
+// app/[lang]/page.tsx
+import { getTranslation } from "@/i18n";
+export default async function Page() {
+  const { t } = await getTranslation();
+  return <h1>{t("home.title")}</h1>;
+}
+```
+## API
+### initialize
+Creates configured i18n functions. Call once and export the returned functions.
+```ts
+import { initialize } from "@nimpl/i18n/initialize";
+export const { getTranslation, ServerTranslation, Transmitter, revalidate } = initialize(config);
+```
+#### Config Options
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `load` | `(language: string) => Promise<object>` | Yes | Async function that returns translations for a language |
+| `getLanguage` | `() => Promise<string>` | Yes | Function to determine current language |
+| `languages` | `string[]` | Yes | Array of supported language codes |
+| `cache` | `boolean` | No | Enable translation caching (recommended for production) |
+### getTranslation
+Server-side function for translations in React Server Components.
+```tsx
+import { getTranslation } from "@/i18n";
+export default async function Page() {
+  const { t, language } = await getTranslation();
+  return <h1>{t("home.title")}</h1>;
+}
+```
+With explicit language (useful for `generateMetadata`):
+```tsx
+export async function generateMetadata({ params }: { params: { lang: string } }) {
+  const { t } = await getTranslation({ language: params.lang });
+  return { title: t("home.meta.title") };
+}
+```
+With namespace:
+```tsx
+const { t } = await getTranslation({ namespace: "home" });
+t("title"); // Equivalent to t("home.title")
+```
+### Transmitter
+Server component that passes translations to client components. Wrap client components that need translations.
+```tsx
+import { Transmitter } from "@/i18n";
+import Counter from "./Counter";
+export default async function Page() {
+  return (
+    <Transmitter terms={["counter", "shared.buttons"]}>
+      <Counter />
+    </Transmitter>
+  );
+}
+```
+With explicit language:
+```tsx
+<Transmitter terms={["counter"]} language="fr">
+  <Counter />
+</Transmitter>
+```
+### ServerTranslation
+Server component for complex translations with embedded JSX.
+```tsx
+import { ServerTranslation } from "@/i18n";
+// Translation: "Read our <link>documentation</link> for more info"
+export default async function Page() {
+  return (
+    <ServerTranslation
+      term="home.description"
+      components={{ link: <a href="/docs" /> }}
+    />
+  );
+}
+```
+With variables:
+```tsx
+// Translation: "We have <b>{{count}}</b> products"
+<ServerTranslation
+  term="products.count"
+  components={{ b: <strong /> }}
+  query={{ count: 42 }}
+/>
+```
+### useTranslation
+Client-side hook. Requires `Transmitter` in a parent Server Component.
+```tsx
+"use client";
+import { useTranslation } from "@nimpl/i18n/useTranslation";
+export default function Counter() {
+  const { t } = useTranslation();
+  return <button>{t("counter.increment")}</button>;
+}
+```
+With namespace:
+```tsx
+const { t } = useTranslation({ namespace: "counter" });
+```
+### ClientTranslation
+Client component for complex translations with embedded JSX.
+```tsx
+"use client";
+import { ClientTranslation } from "@nimpl/i18n/ClientTranslation";
+// Translation: "Read our <link>documentation</link>"
+export default function Info() {
+  return (
+    <ClientTranslation
+      term="info.description"
+      components={{ link: <a href="/docs" /> }}
+    />
+  );
+}
+```
+### revalidate
+Refresh cached translations for a language.
+```tsx
+import { revalidate } from "@/i18n";
+// Foreground revalidation (blocks until complete)
+await revalidate("en");
+// Background revalidation (non-blocking)
+await revalidate("en", true);
+```
+## Variable Interpolation
+Use `{{variable}}` syntax in translations:
+```json
+{
+  "greeting": "Hello, {{name}}!",
+  "items": "You have {{count}} items"
+}
+```
+```tsx
+t("greeting", { query: { name: "Alex" } });
+// → "Hello, Alex!"
+t("items", { query: { count: 5 } });
+// → "You have 5 items"
+```
+Use `removeUnusedQueries` to strip undefined variables:
+```tsx
+// Translation: "Hello, {{name}}! Role: {{role}}"
+t("welcome", { query: { name: "Alex" }, removeUnusedQueries: true });
+// → "Hello, Alex! Role: "
 ```
-## Additionally
+### Server-Side Query Injection
+Pass dynamic values to client translations from the server to improve client performance:
+```tsx
+<Transmitter
+  terms={[
+    "pricing",
+    ["welcome", { query: { stage: process.env.NODE_ENV } }],
+  ]}
+>
+  <ClientComponent />
+</Transmitter>
+```
+## Namespaces
+Access nested keys with dot notation or colon prefix:
+```tsx
+// Dot notation
+t("header.nav.home");
+// Namespace in options
+const { t } = await getTranslation({ namespace: "header" });
+t("nav.home");
+// Colon prefix (overrides default namespace)
+t("footer:copyright");
+```
+## Notes
+- Client components (`useTranslation`, `ClientTranslation`) inherit language from server parents
+- The `terms` array accepts namespace prefixes (e.g., `"nav"`) or specific keys (e.g., `"nav.home"`)
+- Use `next/root-params`, `@nimpl/getters` or `@nimpl/context` for automatic route parameter detection
+## Examples
-Create tasks with wishes, ideas, difficulties, etc. All of them will definitely be considered and thought over.
+- [Base example](https://github.com/alexdln/nimpl-i18n/tree/main/examples/base)
 ## License
-[MIT](https://github.com/alexdln/nimpl-i18n/blob/main/LICENSE)
+MIT

package/dist/ClientTranslation.js CHANGED Viewed

@@ -4,12 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientTranslation = void 0;
 const react_1 = __importDefault(require("react"));
-const Translation_1 = __importDefault(require("./lib/Translation"));
-const useTranslation_1 = __importDefault(require("./useTranslation"));
-const ClientTranslation = ({ term, components, query, removeUnusedQueries }) => {
-    const { t } = (0, useTranslation_1.default)();
+const Translation_1 = require("./lib/Translation");
+const useTranslation_1 = require("./useTranslation");
+const ClientTranslation = ({ term, components, query, removeUnusedQueries, }) => {
+    const { t } = (0, useTranslation_1.useTranslation)();
     const text = t(term, { query, removeUnusedQueries });
-    return react_1.default.createElement(Translation_1.default, { term: term, text: text, components: components });
+    return react_1.default.createElement(Translation_1.Translation, { term: term, text: text, components: components });
 };
-exports.default = ClientTranslation;
+exports.ClientTranslation = ClientTranslation;

package/dist/initialize.js ADDED Viewed

@@ -0,0 +1,88 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initialize = void 0;
+const react_1 = __importDefault(require("react"));
+const get_translation_core_1 = require("./lib/get-translation-core");
+const translation_core_1 = require("./lib/translation-core");
+const transmitter_core_1 = require("./lib/transmitter-core");
+const initialize = (config) => {
+    const cache = new Map();
+    const loadTranslates = async (language, revalidate) => {
+        const item = cache.get(language);
+        if (!revalidate && item)
+            return item;
+        if (item && "then" in item) {
+            return item;
+        }
+        const newData = await config.load(language);
+        cache.set(language, newData);
+        return newData;
+    };
+    const getTranslation = async (options) => {
+        const { language, ...rest } = options || {};
+        const targetLanguage = language || (await config.getLanguage());
+        let dictionary;
+        if (config.cache) {
+            dictionary = await loadTranslates(targetLanguage);
+        }
+        else {
+            dictionary = await revalidate(targetLanguage);
+        }
+        if (!language) {
+            throw new Error("Unable to get the language in getTranslation. Please check the getLanguage method in the configuration file or pass the language as an argument.");
+        }
+        return (0, get_translation_core_1.getTranslationCore)({ ...rest, language: targetLanguage, dictionary });
+    };
+    const ServerTranslation = async (options) => {
+        const { language, ...rest } = options || {};
+        const targetLanguage = language || (await config.getLanguage());
+        let dictionary;
+        if (config.cache) {
+            dictionary = await loadTranslates(targetLanguage);
+        }
+        else {
+            dictionary = await revalidate(targetLanguage);
+        }
+        if (!language) {
+            throw new Error("Unable to get the language in ServerTranslation. Please check the getLanguage method in the configuration file or pass the language as an argument.");
+        }
+        return react_1.default.createElement(translation_core_1.TranslationCore, { ...rest, language: targetLanguage, dictionary: dictionary });
+    };
+    const Transmitter = async (options) => {
+        const { language, ...rest } = options || {};
+        const targetLanguage = language || (await config.getLanguage());
+        let dictionary;
+        if (config.cache) {
+            dictionary = await loadTranslates(targetLanguage);
+        }
+        else {
+            dictionary = await revalidate(targetLanguage);
+        }
+        if (!language) {
+            throw new Error("Unable to get the language in Transmitter. Please check the getLanguage method in the configuration file or pass the language as an argument.");
+        }
+        return react_1.default.createElement(transmitter_core_1.TransmitterCore, { ...rest, language: targetLanguage, dictionary: dictionary });
+    };
+    const revalidate = async (language, background = false) => {
+        const item = cache.get(language);
+        if (item && "then" in item)
+            return item;
+        if (background) {
+            const newData = await loadTranslates(language, true);
+            return newData;
+        }
+        const newDataPromise = loadTranslates(language, true);
+        cache.set(language, newDataPromise);
+        return newDataPromise;
+    };
+    return {
+        Transmitter,
+        ServerTranslation,
+        getTranslation,
+        revalidate,
+    };
+};
+exports.initialize = initialize;

package/dist/lib/ClientI18nProvider.js CHANGED Viewed

@@ -34,13 +34,14 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientI18nProvider = void 0;
 const react_1 = __importStar(require("react"));
 const ClientI18nContext_1 = require("./ClientI18nContext");
-const ClientI18nProvider = ({ translates, children, language, cleanThread }) => {
+const ClientI18nProvider = ({ translates, children, language, cleanThread, }) => {
     const prevTranslates = (0, react_1.useContext)(ClientI18nContext_1.ClientI18nContext);
     if (cleanThread) {
         Object.assign(translates, prevTranslates?.translates);
     }
     return react_1.default.createElement(ClientI18nContext_1.ClientI18nContext.Provider, { value: { language, translates } }, children);
 };
-exports.default = ClientI18nProvider;
+exports.ClientI18nProvider = ClientI18nProvider;

package/dist/lib/Translation.js CHANGED Viewed

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Translation = void 0;
 const react_1 = __importDefault(require("react"));
 const parseTag = (tag) => {
     const isSelfClosing = tag.endsWith("/>");
@@ -89,4 +90,4 @@ const Translation = ({ term, text, components }) => {
     }
     return parts;
 };
-exports.default = Translation;
+exports.Translation = Translation;

package/dist/lib/format-translate.js ADDED Viewed

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatTranslate = void 0;
+const html_entities_1 = require("html-entities");
+const injectQuery_1 = require("./injectQuery");
+const formatTranslate = ({ term, text, removeUnusedQueries, query, parseEntities }) => {
+    let newTranslate = text;
+    if (query) {
+        newTranslate = (0, injectQuery_1.injectQuery)({ term, text: newTranslate, query, removeUnusedQueries });
+    }
+    if (parseEntities === undefined || parseEntities === true) {
+        newTranslate = (0, html_entities_1.decode)(newTranslate, { scope: "strict" });
+    }
+    return newTranslate;
+};
+exports.formatTranslate = formatTranslate;

package/dist/{getTranslation.js → lib/get-translation-core.js} RENAMED Viewed

@@ -3,16 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTranslationCore = void 0;
 const object_path_1 = __importDefault(require("object-path"));
-const formatServerTranslate_1 = __importDefault(require("./lib/formatServerTranslate"));
-const loadI18nData_1 = __importDefault(require("./lib/loadI18nData"));
-const getTranslation = async (options) => {
-    const { language: argLanguage, namespace } = options || {};
-    const { dictionary, language: configLanguage } = await (0, loadI18nData_1.default)();
-    const language = argLanguage || configLanguage;
-    if (!language) {
-        throw new Error("Unable to get the language in the createTranslation function. Please check the getLanguage method in the configuration file or pass the language as an argument.");
-    }
+const format_translate_1 = require("./format-translate");
+const getTranslationCore = (options) => {
+    const { language, namespace, dictionary } = options || {};
     const namespaceDictionary = namespace ? object_path_1.default.get(dictionary, namespace) : dictionary;
     const t = (term, opts) => {
         let termDictionary = namespaceDictionary;
@@ -26,8 +21,8 @@ const getTranslation = async (options) => {
         const fullTerm = `${termNamespace ? `${termNamespace}.` : ""}${termKey}`;
         if (typeof translation !== "string" || !translation)
             return fullTerm;
-        return (0, formatServerTranslate_1.default)({ term: fullTerm, text: translation, parseEntities: true, ...opts });
+        return (0, format_translate_1.formatTranslate)({ term: fullTerm, text: translation, parseEntities: true, ...opts });
     };
     return { t, language };
 };
-exports.default = getTranslation;
+exports.getTranslationCore = getTranslationCore;

package/dist/lib/injectQuery.js CHANGED Viewed

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.injectQuery = void 0;
 const injectQuery = ({ text, query, removeUnusedQueries }) => {
     let result = "";
     let i = 0;
@@ -27,4 +28,4 @@ const injectQuery = ({ text, query, removeUnusedQueries }) => {
     }
     return result;
 };
-exports.default = injectQuery;
+exports.injectQuery = injectQuery;

package/dist/lib/parseEntities.js CHANGED Viewed

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseEntities = void 0;
 const html_entities_1 = require("html-entities");
 const parseEntities = (translate) => {
     return (0, html_entities_1.decode)(translate, { scope: "strict" });
 };
-exports.default = parseEntities;
+exports.parseEntities = parseEntities;

package/dist/lib/translation-core.js ADDED Viewed

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslationCore = void 0;
+const react_1 = __importDefault(require("react"));
+const Translation_1 = require("./Translation");
+const get_translation_core_1 = require("./get-translation-core");
+const TranslationCore = ({ dictionary, namespace, term, components, query, removeUnusedQueries, language, }) => {
+    const { t } = (0, get_translation_core_1.getTranslationCore)({ language, namespace, dictionary });
+    const text = t(term, { query, removeUnusedQueries });
+    return react_1.default.createElement(Translation_1.Translation, { term: term, text: text, components: components });
+};
+exports.TranslationCore = TranslationCore;

package/dist/lib/transmitter-core.js ADDED Viewed

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransmitterCore = void 0;
+const react_1 = __importDefault(require("react"));
+const object_path_1 = __importDefault(require("object-path"));
+const ClientI18nProvider_1 = require("./ClientI18nProvider");
+const format_translate_1 = require("./format-translate");
+const formatTranslates = (result, targetKey, translates, opts = {}) => {
+    if (!translates)
+        return;
+    if (typeof translates === "string") {
+        result[targetKey] = (0, format_translate_1.formatTranslate)({ term: targetKey, text: translates, parseEntities: true, ...opts });
+    }
+    else {
+        Object.entries(translates).forEach(([subKey, translate]) => {
+            formatTranslates(result, `${targetKey}.${subKey}`, translate, opts);
+        });
+    }
+};
+const TransmitterCore = async ({ dictionary, language, terms, children, cleanThread, }) => {
+    const result = {};
+    terms.forEach((term) => {
+        if (Array.isArray(term)) {
+            const [termKey, opts] = term;
+            const translates = object_path_1.default.get(dictionary, termKey);
+            formatTranslates(result, termKey, translates, opts);
+        }
+        else {
+            const translates = object_path_1.default.get(dictionary, term);
+            formatTranslates(result, term, translates);
+        }
+    });
+    return (react_1.default.createElement(ClientI18nProvider_1.ClientI18nProvider, { language: language, translates: result, cleanThread: cleanThread }, children));
+};
+exports.TransmitterCore = TransmitterCore;

package/dist/useTranslation.js CHANGED Viewed

@@ -1,11 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTranslation = void 0;
 const react_1 = require("react");
 const ClientI18nContext_1 = require("./lib/ClientI18nContext");
-const injectQuery_1 = __importDefault(require("./lib/injectQuery"));
+const injectQuery_1 = require("./lib/injectQuery");
 const useTranslation = ({ namespace } = {}) => {
     const context = (0, react_1.useContext)(ClientI18nContext_1.ClientI18nContext);
     if (!context) {
@@ -24,7 +22,7 @@ const useTranslation = ({ namespace } = {}) => {
         if (!translation)
             return termKey;
         if (opts?.query) {
-            return (0, injectQuery_1.default)({
+            return (0, injectQuery_1.injectQuery)({
                 term,
                 text: translation,
                 query: opts.query,
@@ -35,4 +33,4 @@ const useTranslation = ({ namespace } = {}) => {
     };
     return { t, language };
 };
-exports.default = useTranslation;
+exports.useTranslation = useTranslation;

package/initialize.d.ts ADDED Viewed

@@ -0,0 +1,17 @@
+import React from "react";
+import { type Config, type Translates } from "./types";
+import { type GetTranslationCoreOptions } from "./lib/get-translation-core";
+import { type TranslationCoreProps } from "./lib/translation-core";
+import { type TransmitterCoreProps } from "./lib/transmitter-core";
+export declare const initialize: (config: Config) => {
+    Transmitter: (options: Omit<TransmitterCoreProps, "dictionary" | "language"> & {
+        language?: string;
+    }) => Promise<React.JSX.Element>;
+    ServerTranslation: (options: Omit<TranslationCoreProps, "dictionary" | "language"> & {
+        language?: string;
+    }) => Promise<React.JSX.Element>;
+    getTranslation: (options: Omit<GetTranslationCoreOptions, "dictionary" | "language"> & {
+        language?: string;
+    }) => Promise<import("./lib/get-translation-core").GetTranslationCoreReturnType>;
+    revalidate: (language: string, background?: boolean) => Promise<Translates>;
+};

package/package.json CHANGED Viewed

@@ -1,31 +1,19 @@
 {
   "name": "@nimpl/i18n",
-  "version": "0.0.0-experimental-47e75fe",
+  "version": "0.0.0-experimental-504b302",
   "description": "i18n library for working with translations in server and client components",
   "exports": {
     "./ClientTranslation": {
       "default": "./dist/ClientTranslation.js"
     },
-    "./getTranslation": {
-      "default": "./dist/getTranslation.js"
-    },
-    "./i18n": {
-      "default": "./dist/i18n.js"
-    },
-    "./I18nTransmitter": {
-      "default": "./dist/I18nTransmitter.js"
-    },
-    "./ServerTranslation": {
-      "default": "./dist/ServerTranslation.js"
+    "./initialize": {
+      "default": "./dist/initialize.js"
     },
     "./types": {
       "default": "./dist/types.js"
     },
     "./useTranslation": {
       "default": "./dist/useTranslation.js"
-    },
-    "./clientConfig": {
-      "default": "./dist/clientConfig.js"
     }
   },
   "files": [
@@ -68,7 +56,6 @@
     "react": ">= 19.1.0"
   },
   "dependencies": {
-    "@nimpl/getters": "2.2.2",
     "html-entities": "2.6.0",
     "object-path": "0.11.8"
   }

package/types.d.ts CHANGED Viewed

@@ -20,3 +20,13 @@ export type I18nContextType = {
         [key: string]: string;
     };
 } | null;
+export type Meta = {
+    lastUpdated: number;
+    isRevalidated?: boolean;
+} & Record<string, unknown>;
+export type Config = {
+    load(key: string, meta?: Meta): Promise<Translates>;
+    getLanguage(): Promise<string>;
+    languages: string[];
+    cache?: boolean;
+};

package/useTranslation.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@ type GetTranslationReturnType = {
     t: (term: string, opts?: I18nOptions) => string;
     language: string;
 };
-declare const useTranslation: ({ namespace }?: {
+export declare const useTranslation: ({ namespace }?: {
     namespace?: string;
 }) => GetTranslationReturnType;
-export default useTranslation;
+export {};

package/I18nTransmitter.d.ts DELETED Viewed

@@ -1,10 +0,0 @@
-import React from "react";
-import { type I18nOptions } from "./types";
-export type I18nTransmitterProps = {
-    terms: (string | [string, I18nOptions])[];
-    children: React.ReactNode;
-    cleanThread?: boolean;
-    language?: string;
-};
-declare const I18nTransmitter: React.FC<I18nTransmitterProps>;
-export default I18nTransmitter;

package/ServerTranslation.d.ts DELETED Viewed

@@ -1,12 +0,0 @@
-import React from "react";
-import { type I18nOptions } from "./types";
-import { type TranslationProps } from "./lib/Translation";
-type ServerTranslationProps = {
-    term: string;
-    components?: TranslationProps["components"];
-    query?: I18nOptions["query"];
-    removeUnusedQueries?: I18nOptions["removeUnusedQueries"];
-    language?: string;
-};
-declare const ServerTranslation: React.FC<ServerTranslationProps>;
-export default ServerTranslation;

package/clientConfig.d.ts DELETED Viewed

File without changes

package/dist/I18nTransmitter.js DELETED Viewed

@@ -1,43 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importDefault(require("react"));
-const object_path_1 = __importDefault(require("object-path"));
-const ClientI18nProvider_1 = __importDefault(require("./lib/ClientI18nProvider"));
-const formatServerTranslate_1 = __importDefault(require("./lib/formatServerTranslate"));
-const loadI18nData_1 = __importDefault(require("./lib/loadI18nData"));
-const formatServerTranslates = (result, targetKey, translates, opts = {}) => {
-    if (!translates)
-        return;
-    if (typeof translates === "string") {
-        result[targetKey] = (0, formatServerTranslate_1.default)({ term: targetKey, text: translates, parseEntities: true, ...opts });
-    }
-    else {
-        Object.entries(translates).forEach(([subKey, translate]) => {
-            formatServerTranslates(result, `${targetKey}.${subKey}`, translate, opts);
-        });
-    }
-};
-const I18nTransmitter = async ({ language: argLanguage, terms, children, cleanThread, }) => {
-    const { dictionary, language: configLanguage } = await (0, loadI18nData_1.default)();
-    const language = argLanguage || configLanguage;
-    if (!language) {
-        throw new Error("Unable to get the language in the createTranslation function. Please check the getLanguage method in the configuration file or pass the language as an argument.");
-    }
-    const result = {};
-    terms.forEach((term) => {
-        if (Array.isArray(term)) {
-            const [termKey, opts] = term;
-            const translates = object_path_1.default.get(dictionary, termKey);
-            formatServerTranslates(result, termKey, translates, opts);
-        }
-        else {
-            const translates = object_path_1.default.get(dictionary, term);
-            formatServerTranslates(result, term, translates);
-        }
-    });
-    return (react_1.default.createElement(ClientI18nProvider_1.default, { language: language, translates: result, cleanThread: cleanThread }, children));
-};
-exports.default = I18nTransmitter;

package/dist/ServerTranslation.js DELETED Viewed

@@ -1,14 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importDefault(require("react"));
-const Translation_1 = __importDefault(require("./lib/Translation"));
-const getTranslation_1 = __importDefault(require("./getTranslation"));
-const ServerTranslation = async ({ term, components, query, removeUnusedQueries, language, }) => {
-    const { t } = await (0, getTranslation_1.default)({ language });
-    const text = t(term, { query, removeUnusedQueries });
-    return react_1.default.createElement(Translation_1.default, { term: term, text: text, components: components });
-};
-exports.default = ServerTranslation;

package/dist/clientConfig.js DELETED Viewed

	@@ -1,2 +0,0 @@
1	- "use strict";
2	- throw new Error("Please add the i18n wrapper to your next.config.js");

package/dist/configuration/getConfig.js DELETED Viewed

@@ -1,68 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const url_1 = require("url");
-const CONFIG_PATH = path_1.default.join(process.cwd(), "nimpl-i18n.js");
-// Crutch bypass of conversion by the assembler to require
-const dynamicImport = new Function("p", "return import(p)");
-const getConfig = async () => {
-    let clientConfig;
-    if (fs_1.default.existsSync(CONFIG_PATH)) {
-        const config = await dynamicImport((0, url_1.pathToFileURL)(CONFIG_PATH).href);
-        clientConfig = config.default;
-    }
-    else {
-        // @ts-expect-error will be imported from the alias configuration in webpack
-        const config = await Promise.resolve().then(() => __importStar(require("@nimpl/i18n/clientConfig")));
-        clientConfig = config.default;
-    }
-    const { load, getLanguage, languages } = clientConfig;
-    if (!load) {
-        throw new Error(`Can't find "load" method in configuration file - https://github.com/alexdln/nimpl-i18n#configuration`);
-    }
-    if (!languages) {
-        throw new Error(`Can't find "languages" list in configuration file - https://github.com/alexdln/nimpl-i18n#configuration`);
-    }
-    if (!getLanguage) {
-        throw new Error(`Can't find "getLanguage" method in configuration file - https://github.com/alexdln/nimpl-i18n#configuration`);
-    }
-    return clientConfig;
-};
-exports.default = getConfig;

package/dist/configuration/types.js DELETED Viewed

	@@ -1,2 +0,0 @@
1	- "use strict";
2	- Object.defineProperty(exports, "__esModule", { value: true });

package/dist/helpers/isPromise.js DELETED Viewed

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPromise = void 0;
-const isPromise = (el) => {
-    if (el && typeof el === "object" && "then" in el) {
-        return true;
-    }
-    return false;
-};
-exports.isPromise = isPromise;

package/dist/i18n.js DELETED Viewed

@@ -1,29 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = require("fs");
-const path_1 = __importDefault(require("path"));
-const CONFIG_PATH = path_1.default.join(process.cwd(), "nimpl-i18n.js");
-const i18n = () => {
-    return (nextConfig = {}) => {
-        return {
-            ...nextConfig,
-            webpack: (config, options) => {
-                if (!(0, fs_1.existsSync)(CONFIG_PATH))
-                    throw new Error("Please create and configure nimpl-i18n.js");
-                config.resolve ||= {};
-                config.resolve.alias = {
-                    ...config.resolve.alias,
-                    "@nimpl/i18n/clientConfig": CONFIG_PATH,
-                };
-                if (typeof nextConfig.webpack === "function") {
-                    return nextConfig.webpack(config, options);
-                }
-                return config;
-            },
-        };
-    };
-};
-exports.default = i18n;

package/dist/lib/formatServerTranslate.js DELETED Viewed

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const html_entities_1 = require("html-entities");
-const injectQuery_1 = __importDefault(require("./injectQuery"));
-const formatServerTranslate = ({ term, text, removeUnusedQueries, query, parseEntities }) => {
-    let newTranslate = text;
-    if (query) {
-        newTranslate = (0, injectQuery_1.default)({ term, text: newTranslate, query, removeUnusedQueries });
-    }
-    if (parseEntities === undefined || parseEntities === true) {
-        newTranslate = (0, html_entities_1.decode)(newTranslate, { scope: "strict" });
-    }
-    return newTranslate;
-};
-exports.default = formatServerTranslate;

package/dist/lib/loadI18nData.js DELETED Viewed

@@ -1,25 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getConfig_1 = __importDefault(require("../configuration/getConfig"));
-const get_pathname_1 = require("@nimpl/getters/get-pathname");
-const get_params_1 = require("@nimpl/getters/get-params");
-const loadI18nData = async () => {
-    const config = await (0, getConfig_1.default)();
-    const language = await config.getLanguage({
-        get pathname() {
-            return (0, get_pathname_1.getPathname)();
-        },
-        get params() {
-            return (0, get_params_1.getParams)();
-        },
-    });
-    if (!language || !config.languages.includes(language)) {
-        throw new Error(`Can\' load data for language "${language}", valid languages are: ${config.languages.join(", ")}`);
-    }
-    const dictionary = await config.load(language);
-    return { dictionary, language };
-};
-exports.default = loadI18nData;

package/getTranslation.d.ts DELETED Viewed

@@ -1,10 +0,0 @@
-import { type I18nOptions } from "./types";
-type GetTranslationReturnType = {
-    t: (term: string, opts?: I18nOptions) => string;
-    language: string;
-};
-declare const getTranslation: (options?: {
-    language?: string;
-    namespace?: string;
-}) => Promise<GetTranslationReturnType>;
-export default getTranslation;

package/i18n.d.ts DELETED Viewed

	@@ -1,2 +0,0 @@
1	- declare const i18n: () => (nextConfig?: any) => any;
2	- export default i18n;