@kodiak-finance/orderly-i18n 2.7.4

package/README.md

@@ -0,0 +1,334 @@
+# @orderly.network/i18n
+
+Internationalization and cli tools for Orderly SDK. Based on i18next ecosystem.
+
+## Integration Guide
+
+Follow these steps to integrate localization support in your app using Orderly SDK:
+
+### 1. Wrap Your App with LocaleProvider
+
+The LocaleProvider is the core component that supplies localized resources to your application. Make sure to wrap your app’s root component with LocaleProvider.
+
+```tsx
+import { LocaleProvider } from "@orderly.network/i18n";
+
+<LocaleProvider>
+  <YourApp />
+</LocaleProvider>;
+```
+
+### 2. Provide Locale Data
+
+#### Default Language
+
+- English (`en`) is included by default.
+
+#### Supported Locales
+
+We currently support **16 locales**
+
+| Locale Code | Language   |
+| ----------- | ---------- |
+| `en`        | English    |
+| `zh`        | Chinese    |
+| `ja`        | Japanese   |
+| `es`        | Spanish    |
+| `ko`        | Korean     |
+| `vi`        | Vietnamese |
+| `de`        | German     |
+| `fr`        | French     |
+| `ru`        | Russian    |
+| `id`        | Indonesian |
+| `tr`        | Turkish    |
+| `it`        | Italian    |
+| `pt`        | Portuguese |
+| `uk`        | Ukrainian  |
+| `pl`        | Polish     |
+| `nl`        | Dutch      |
+
+#### CSV for Easy Translation
+
+- Each release generates a `dist/locale.csv` file to simplify translation workflows.
+- We provide a CLI tool to convert between CSV and JSON formats.
+
+### 3. Extending Locale Files
+
+You can localize both the SDK UI and your own custom components.
+
+- When adding custom keys, prefix them with `extend.` to avoid conflicts with default keys.
+
+```json
+{
+  "extend.custom.button.label": "My Custom Button"
+}
+```
+
+## Example
+
+Here's a complete example of how to set up the i18n integration:
+
+### Async load locale files
+
+```typescript
+import { FC, ReactNode } from "react";
+import { WalletConnectorProvider } from "@orderly.network/wallet-connector";
+import { OrderlyAppProvider } from "@orderly.network/react-app";
+import { LocaleProvider, LocaleEnum, LocaleCode } from "@orderly.network/i18n";
+
+const OrderlyProvider: FC<{ children: ReactNode }> = (props) => {
+  const onLanguageChanged = async (lang: LocaleCode) => {};
+
+  // please copy build-in locale files (@orderly.network/i18n/locales) to you public/locales
+  // and copy you extend locale files to public/locales/extend
+  const loadPath = (lang: LocaleCode) => {
+    if (lang === LocaleEnum.en) {
+      // because en is built-in, we need to load the en extend only
+      return `/locales/extend/${lang}.json`;
+    }
+    return [`/locales/${lang}.json`, `/locales/extend/${lang}.json`];
+  };
+
+  return (
+    <LocaleProvider
+      onLanguageChanged={onLanguageChanged}
+      backend={{ loadPath }}
+    >
+      <WalletConnectorProvider>
+        <OrderlyAppProvider
+          brokerId="orderly"
+          brokerName="Orderly"
+          networkId="testnet"
+        >
+          {props.children}
+        </OrderlyAppProvider>
+      </WalletConnectorProvider>
+    </LocaleProvider>
+  );
+};
+```
+
+### Sync Load locale data
+
+```typescript
+import { FC, ReactNode } from "react";
+import { WalletConnectorProvider } from "@orderly.network/wallet-connector";
+import { OrderlyAppProvider } from "@orderly.network/react-app";
+import { LocaleProvider, LocaleCode, Resources } from "@orderly.network/i18n";
+import zh from "@orderly.network/i18n/locales/zh.json";
+import ja from "@orderly.network/i18n/locales/ja.json";
+import ko from "@orderly.network/i18n/locales/ko.json";
+
+// extend or overrides English translations
+const extendEn = {
+  "extend.trading": "Trading",
+};
+
+// extend or overrides chinese translations
+const extendZh = {
+  "extend.trading": "交易",
+};
+
+// extend or overrides japanese translations
+const extendJa = {
+  "extend.trading": "取引",
+};
+
+// extend or overrides korean translations
+const extendKo = {
+  "extend.trading": "거래",
+};
+
+// define language resources
+const resources: Resources = {
+  en: extendEn,
+  zh: {
+    ...zh,
+    ...extendZh,
+  },
+  ja: {
+    ...ja,
+    ...extendJa,
+  },
+  ko: {
+    ...ko,
+    ...extendKo,
+  },
+};
+
+const OrderlyProvider: FC<{ children: ReactNode }> = (props) => {
+  const onLanguageChanged = (locale: LocaleCode) => {};
+
+  return (
+    <LocaleProvider resources={resources} onLanguageChanged={onLocaleChange}>
+      <WalletConnectorProvider>
+        <OrderlyAppProvider
+          brokerId="orderly"
+          brokerName="Orderly"
+          networkId="testnet"
+        >
+          {props.children}
+        </OrderlyAppProvider>
+      </WalletConnectorProvider>
+    </LocaleProvider>
+  );
+};
+```
+
+### Add custom languages
+
+We also support adding more custom languages
+
+```typescript
+import { FC, ReactNode } from "react";
+import { WalletConnectorProvider } from "@orderly.network/wallet-connector";
+import { OrderlyAppProvider } from "@orderly.network/react-app";
+import {
+  LocaleProvider,
+  Resources,
+  LocaleEnum,
+  LocaleCode,
+  Language,
+} from "@orderly.network/i18n";
+
+// japanese locale
+const ja = {
+  "extend.ja": "日本語",
+};
+
+// korean locale
+const ko = {
+  "extend.ko": "한국어",
+};
+
+// define language resources
+const resources: Resources = {
+  ja,
+  ko,
+};
+
+// custom languages
+const languages: Language[] = [
+  { localCode: LocaleEnum.en, displayName: "English" },
+  { localCode: LocaleEnum.ja, displayName: "日本語" },
+  { localCode: LocaleEnum.ko, displayName: "한국어" },
+];
+
+const OrderlyProvider: FC<{ children: ReactNode }> = (props) => {
+  const onLanguageChanged = (locale: LocaleCode) => {};
+
+  return (
+    <LocaleProvider
+      resources={resources}
+      languages={languages}
+      onLanguageChanged={onLanguageChanged}
+    >
+      <WalletConnectorProvider>
+        <OrderlyAppProvider
+          brokerId="orderly"
+          brokerName="Orderly"
+          networkId="testnet"
+        >
+          {props.children}
+        </OrderlyAppProvider>
+      </WalletConnectorProvider>
+    </LocaleProvider>
+  );
+};
+```
+
+## CLI
+
+## Usage
+
+The package provides a CLI tool for managing Internationalization files.
+
+```bash
+npx @orderly.network/i18n <command> [options]
+```
+
+## Commands
+
+### csv2json
+
+Convert a locale CSV file to multiple locale JSON files.
+
+```bash
+npx @orderly.network/i18n csv2json <input> <outputDir>
+```
+
+Example:
+
+```bash
+npx @orderly.network/i18n csv2json ./dist/locale.csv ./dist/locales
+```
+
+### json2csv
+
+Convert multiple locale JSON files to a single locale CSV file.
+
+```bash
+npx @orderly.network/i18n json2csv <inputDir> <output>
+```
+
+Example:
+
+```bash
+npx @orderly.network/i18n json2csv ./locales ./dist/locale.csv
+```
+
+### diffcsv
+
+Compare two locale CSV files to find differences.
+
+```bash
+npx @orderly.network/i18n diffcsv <oldFile> <newFile>
+```
+
+Example:
+
+```bash
+npx @orderly.network/i18n diffcsv ./dist/locale1.csv ./dist/locale2.csv
+```
+
+### fillJson
+
+Fill values from an input locale JSON file and generate a new locale JSON file.
+
+```bash
+npx @orderly.network/i18n fillJson <input> <output>
+```
+
+Example:
+
+```bash
+npx @orderly.network/i18n fillJson ./src/locale/zh.json ./dist/locale/zh.json
+```
+
+### separateJson
+
+Separate JSON files into default and extend key values based on a specified key.
+
+```bash
+npx @orderly.network/i18n separateJson <inputDir> <outputDir> <separateKey>
+```
+
+Example:
+
+```bash
+npx @orderly.network/i18n separateJson ./locales ./dist/locales extend
+```
+
+### mergeJson
+
+Merge default and extend JSON files back into one file.
+
+```bash
+npx @orderly.network/i18n mergeJson <inputDir> <outputDir>
+```
+
+Example:
+
+```bash
+npx @orderly.network/i18n mergeJson ./dist/locales1 ./dist/locales2
+```

package/bin/cli.js

@@ -0,0 +1,240 @@
+#!/usr/bin/env node
+
+const yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
+// const { generateCsv } = require("../script/generateCsv");
+const { json2csv } = require("../script/json2csv");
+const { csv2json } = require("../script/csv2json");
+const { diffCsv } = require("../script/diffCsv");
+const { fillJson } = require("../script/fillJson");
+const { separateJson } = require("../script/separateJson");
+const { mergeJson } = require("../script/mergeJson");
+main();
+
+async function main() {
+  const argv = getArgv();
+
+  const {
+    _,
+    input,
+    output,
+    oldFile,
+    newFile,
+    inputDir,
+    outputDir,
+    separateKey,
+  } = argv;
+
+  const command = _[0];
+  // console.log("argv", argv);
+
+  switch (command) {
+    case "json2csv":
+      await json2csv(inputDir, output);
+      break;
+    case "csv2json":
+      await csv2json(input, outputDir);
+      break;
+    case "diffcsv":
+      await diffCsv(oldFile, newFile);
+      break;
+    // case "generateCsv":
+    //   await generateCsv(output);
+    //   break;
+    case "fillJson":
+      await fillJson(input, output);
+      break;
+    case "separateJson":
+      await separateJson(inputDir, outputDir, separateKey);
+      break;
+    case "mergeJson":
+      await mergeJson(inputDir, outputDir);
+      break;
+    default:
+      console.log("Invalid command");
+      break;
+  }
+}
+
+function getArgv() {
+  const argv = yargs(hideBin(process.argv))
+    .scriptName("")
+    .usage("i18n locale tools")
+    .usage("$0 <command> [options]")
+    .strict()
+    // Error if no subcommand is provided
+    .demandCommand(1, "Please provide a valid subcommand")
+    .help()
+    // Add `-h` as an alias for `--help`
+    .alias("h", "help")
+
+    // csv2json command
+    .command(
+      "csv2json <input> <outputDir>",
+      "Convert locale CSV to multiple locale JSON files",
+      (yargs) => {
+        return yargs
+          .positional("input", {
+            describe: "Input path for the locale CSV file",
+            type: "string",
+            demandOption: true,
+          })
+          .positional("outputDir", {
+            describe: "Output directory for locale JSON files",
+            type: "string",
+            demandOption: true,
+          });
+      },
+      (argv) => {
+        console.log(
+          `Converting ${argv.input} to locale JSON files, output directory: ${argv.outputDir}`
+        );
+      }
+    )
+
+    // json2csv command
+    .command(
+      "json2csv <inputDir> <output>",
+      "Convert locale JSON files to a locale CSV file",
+      (yargs) => {
+        return yargs
+          .positional("inputDir", {
+            describe:
+              "Input directory for locale JSON files (all JSON files in the directory will be converted)",
+            type: "string",
+            demandOption: true,
+          })
+          .positional("output", {
+            describe: "Output path for the locale CSV file",
+            type: "string",
+            demandOption: true,
+          });
+      },
+      (argv) => {
+        console.log(
+          `Converting locale JSON files: ${argv.inputDir} to locale CSV: ${argv.output}`
+        );
+      }
+    )
+
+    // diffcsv command
+    .command(
+      "diffcsv <oldFile> <newFile>",
+      "Compare two locale CSV files",
+      (yargs) => {
+        return yargs
+          .positional("oldFile", {
+            describe: "Path to the first locale CSV file",
+            type: "string",
+            demandOption: true,
+          })
+          .positional("newFile", {
+            describe: "Path to the second CSV file",
+            type: "string",
+            demandOption: true,
+          });
+      },
+      (argv) => {
+        console.log(
+          `Comparing locale CSV files: ${argv.oldFile} and ${argv.newFile}`
+        );
+      }
+    )
+
+    // generateCsv command
+    // .command(
+    //   "generateCsv <output>",
+    //   "Generate a locale CSV file",
+    //   (yargs) => {
+    //     return yargs.positional("output", {
+    //       describe: "Output path for the locale CSV file",
+    //       type: "string",
+    //       // Required
+    //       demandOption: true,
+    //     });
+    //   },
+    //   (argv) => {
+    //     console.log(`Generating locale CSV file at: ${argv.output}`);
+    //   }
+    // )
+
+    // fillJson command
+    .command(
+      "fillJson <input> <output>",
+      "Fill values from the input locale JSON file and generate a new locale JSON file",
+      (yargs) => {
+        return yargs
+          .positional("input", {
+            describe: "Input path for the locale JSON file",
+            type: "string",
+            demandOption: true,
+          })
+          .positional("output", {
+            describe: "Output path for the locale JSON file",
+            type: "string",
+            demandOption: true,
+          });
+      },
+      (argv) => {
+        console.log(
+          `Filling values from the input locale JSON file: ${argv.input} and generating a new locale JSON file: ${argv.output}`
+        );
+      }
+    )
+
+    // separateJson command
+    .command(
+      "separateJson <inputDir> <outputDir> <separateKey>",
+      "Separate json file default and extend key values based on the key",
+      (yargs) => {
+        return yargs
+          .positional("inputDir", {
+            describe: "Input directory for locale JSON files",
+            type: "string",
+            demandOption: true,
+          })
+          .positional("outputDir", {
+            describe: "Output directory for locale JSON files",
+            type: "string",
+            demandOption: true,
+          })
+          .positional("separateKey", {
+            describe: "Key to separate the json files",
+            type: "string",
+            demandOption: true,
+          });
+      },
+      (argv) => {
+        console.log(
+          `Separating json files into multiple files: ${argv.inputDir} to ${argv.outputDir} with key: ${argv.key}`
+        );
+      }
+    )
+
+    // mergeJson command
+    .command(
+      "mergeJson <inputDir> <outputDir>",
+      "Merge default and extend JSON files back into one file",
+      (yargs) => {
+        return yargs
+          .positional("inputDir", {
+            describe:
+              "Input directory containing both default and extend JSON files",
+            type: "string",
+            demandOption: true,
+          })
+          .positional("outputDir", {
+            describe: "Output directory for merged JSON files",
+            type: "string",
+            demandOption: true,
+          });
+      },
+      (argv) => {
+        console.log(
+          `Merging JSON files from ${argv.inputDir} to ${argv.outputDir}`
+        );
+      }
+    );
+
+  return argv.argv;
+}

package/dist/constant.d.mts

@@ -0,0 +1,2 @@
+export { f as LocaleEnum, g as defaultLanguages, h as defaultLng, i as defaultNS, k as i18nCookieKey, j as i18nLocalStorageKey } from './types-Bcx1nSla.js';
+import 'react';

package/dist/constant.d.ts

@@ -0,0 +1,2 @@
+export { f as LocaleEnum, g as defaultLanguages, h as defaultLng, i as defaultNS, k as i18nCookieKey, j as i18nLocalStorageKey } from './types-Bcx1nSla.js';
+import 'react';

package/dist/constant.js

@@ -0,0 +1,12 @@
+'use strict';
+
+var e=(a=>(a.en="en",a.zh="zh",a.ja="ja",a.es="es",a.ko="ko",a.vi="vi",a.de="de",a.fr="fr",a.ru="ru",a.id="id",a.tr="tr",a.it="it",a.pt="pt",a.uk="uk",a.pl="pl",a.nl="nl",a))(e||{}),l=[{localCode:"en",displayName:"English"},{localCode:"zh",displayName:"\u4E2D\u6587"},{localCode:"ja",displayName:"\u65E5\u672C\u8A9E"},{localCode:"es",displayName:"Espa\xF1ol"},{localCode:"ko",displayName:"\uD55C\uAD6D\uC5B4"},{localCode:"vi",displayName:"Ti\u1EBFng Vi\u1EC7t"},{localCode:"de",displayName:"Deutsch"},{localCode:"fr",displayName:"Fran\xE7ais"},{localCode:"ru",displayName:"\u0420\u0443\u0441\u0441\u043A\u0438\u0439"},{localCode:"id",displayName:"Bahasa Indonesia"},{localCode:"tr",displayName:"T\xFCrk\xE7e"},{localCode:"it",displayName:"Italiano"},{localCode:"pt",displayName:"Portugu\xEAs"},{localCode:"uk",displayName:"\u0423\u043A\u0440\u0430\u0457\u043D\u0441\u044C\u043A\u0430"},{localCode:"pl",displayName:"Polski"},{localCode:"nl",displayName:"Nederlands"}],o="en",d="translation",i="orderly_i18nLng",s="orderly_i18nLng";
+
+exports.LocaleEnum = e;
+exports.defaultLanguages = l;
+exports.defaultLng = o;
+exports.defaultNS = d;
+exports.i18nCookieKey = s;
+exports.i18nLocalStorageKey = i;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=constant.js.map

package/dist/constant.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constant.ts"],"names":["LocaleEnum","defaultLanguages","defaultLng","defaultNS","i18nLocalStorageKey","i18nCookieKey"],"mappings":"AAEO,IAAKA,OAEVA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAhCKA,OAAA,IAmCCC,EAA+B,CAC1C,CAAE,UAAW,KAAe,YAAa,SAAU,EACnD,CAAE,UAAW,KAAe,YAAa,cAAK,EAC9C,CAAE,UAAW,KAAe,YAAa,oBAAM,EAC/C,CAAE,UAAW,KAAe,YAAa,YAAU,EACnD,CAAE,UAAW,KAAe,YAAa,oBAAM,EAC/C,CAAE,UAAW,KAAe,YAAa,sBAAa,EACtD,CAAE,UAAW,KAAe,YAAa,SAAU,EACnD,CAAE,UAAW,KAAe,YAAa,aAAW,EACpD,CAAE,UAAW,KAAe,YAAa,4CAAU,EACnD,CAAE,UAAW,KAAe,YAAa,kBAAmB,EAC5D,CAAE,UAAW,KAAe,YAAa,cAAS,EAClD,CAAE,UAAW,KAAe,YAAa,UAAW,EACpD,CAAE,UAAW,KAAe,YAAa,cAAY,EACrD,CAAE,UAAW,KAAe,YAAa,8DAAa,EACtD,CAAE,UAAW,KAAe,YAAa,QAAS,EAClD,CAAE,UAAW,KAAe,YAAa,YAAa,CACxD,EACaC,EAAa,KACbC,EAAY,cAEZC,EAAsB,kBAGtBC,EAAgB","sourcesContent":["import { Language } from \"./context\";\n\nexport enum LocaleEnum {\n  /** English */\n  en = \"en\",\n  /** Chinese */\n  zh = \"zh\",\n  /** Japanese */\n  ja = \"ja\",\n  /** Spanish */\n  es = \"es\",\n  /** Korean */\n  ko = \"ko\",\n  /** Vietnamese */\n  vi = \"vi\",\n  /** German */\n  de = \"de\",\n  /** French */\n  fr = \"fr\",\n  /** Russian */\n  ru = \"ru\",\n  /** Indonesian */\n  id = \"id\",\n  /** Turkish */\n  tr = \"tr\",\n  /** Italian */\n  it = \"it\",\n  /** Portuguese */\n  pt = \"pt\",\n  /** Ukrainian */\n  uk = \"uk\",\n  /** Polish */\n  pl = \"pl\",\n  /** Dutch */\n  nl = \"nl\",\n}\n\nexport const defaultLanguages: Language[] = [\n  { localCode: LocaleEnum.en, displayName: \"English\" }, // English\n  { localCode: LocaleEnum.zh, displayName: \"中文\" }, // Chinese\n  { localCode: LocaleEnum.ja, displayName: \"日本語\" }, // Japanese\n  { localCode: LocaleEnum.es, displayName: \"Español\" }, // Spanish\n  { localCode: LocaleEnum.ko, displayName: \"한국어\" }, // Korean\n  { localCode: LocaleEnum.vi, displayName: \"Tiếng Việt\" }, // Vietnamese\n  { localCode: LocaleEnum.de, displayName: \"Deutsch\" }, // German\n  { localCode: LocaleEnum.fr, displayName: \"Français\" }, // French\n  { localCode: LocaleEnum.ru, displayName: \"Русский\" }, // Russian\n  { localCode: LocaleEnum.id, displayName: \"Bahasa Indonesia\" }, // Indonesian\n  { localCode: LocaleEnum.tr, displayName: \"Türkçe\" }, // Turkish\n  { localCode: LocaleEnum.it, displayName: \"Italiano\" }, // Italian\n  { localCode: LocaleEnum.pt, displayName: \"Português\" }, // Portuguese\n  { localCode: LocaleEnum.uk, displayName: \"Українська\" }, // Ukrainian\n  { localCode: LocaleEnum.pl, displayName: \"Polski\" }, // Polish\n  { localCode: LocaleEnum.nl, displayName: \"Nederlands\" }, // Dutch\n];\nexport const defaultLng = LocaleEnum.en;\nexport const defaultNS = \"translation\";\n\nexport const i18nLocalStorageKey = \"orderly_i18nLng\";\n\n// preferred-language\nexport const i18nCookieKey = \"orderly_i18nLng\";\n"]}

package/dist/constant.mjs

@@ -0,0 +1,5 @@
+var e=(a=>(a.en="en",a.zh="zh",a.ja="ja",a.es="es",a.ko="ko",a.vi="vi",a.de="de",a.fr="fr",a.ru="ru",a.id="id",a.tr="tr",a.it="it",a.pt="pt",a.uk="uk",a.pl="pl",a.nl="nl",a))(e||{}),l=[{localCode:"en",displayName:"English"},{localCode:"zh",displayName:"\u4E2D\u6587"},{localCode:"ja",displayName:"\u65E5\u672C\u8A9E"},{localCode:"es",displayName:"Espa\xF1ol"},{localCode:"ko",displayName:"\uD55C\uAD6D\uC5B4"},{localCode:"vi",displayName:"Ti\u1EBFng Vi\u1EC7t"},{localCode:"de",displayName:"Deutsch"},{localCode:"fr",displayName:"Fran\xE7ais"},{localCode:"ru",displayName:"\u0420\u0443\u0441\u0441\u043A\u0438\u0439"},{localCode:"id",displayName:"Bahasa Indonesia"},{localCode:"tr",displayName:"T\xFCrk\xE7e"},{localCode:"it",displayName:"Italiano"},{localCode:"pt",displayName:"Portugu\xEAs"},{localCode:"uk",displayName:"\u0423\u043A\u0440\u0430\u0457\u043D\u0441\u044C\u043A\u0430"},{localCode:"pl",displayName:"Polski"},{localCode:"nl",displayName:"Nederlands"}],o="en",d="translation",i="orderly_i18nLng",s="orderly_i18nLng";
+
+export { e as LocaleEnum, l as defaultLanguages, o as defaultLng, d as defaultNS, s as i18nCookieKey, i as i18nLocalStorageKey };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=constant.mjs.map

package/dist/constant.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constant.ts"],"names":["LocaleEnum","defaultLanguages","defaultLng","defaultNS","i18nLocalStorageKey","i18nCookieKey"],"mappings":"AAEO,IAAKA,OAEVA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAELA,EAAA,GAAK,KAhCKA,OAAA,IAmCCC,EAA+B,CAC1C,CAAE,UAAW,KAAe,YAAa,SAAU,EACnD,CAAE,UAAW,KAAe,YAAa,cAAK,EAC9C,CAAE,UAAW,KAAe,YAAa,oBAAM,EAC/C,CAAE,UAAW,KAAe,YAAa,YAAU,EACnD,CAAE,UAAW,KAAe,YAAa,oBAAM,EAC/C,CAAE,UAAW,KAAe,YAAa,sBAAa,EACtD,CAAE,UAAW,KAAe,YAAa,SAAU,EACnD,CAAE,UAAW,KAAe,YAAa,aAAW,EACpD,CAAE,UAAW,KAAe,YAAa,4CAAU,EACnD,CAAE,UAAW,KAAe,YAAa,kBAAmB,EAC5D,CAAE,UAAW,KAAe,YAAa,cAAS,EAClD,CAAE,UAAW,KAAe,YAAa,UAAW,EACpD,CAAE,UAAW,KAAe,YAAa,cAAY,EACrD,CAAE,UAAW,KAAe,YAAa,8DAAa,EACtD,CAAE,UAAW,KAAe,YAAa,QAAS,EAClD,CAAE,UAAW,KAAe,YAAa,YAAa,CACxD,EACaC,EAAa,KACbC,EAAY,cAEZC,EAAsB,kBAGtBC,EAAgB","sourcesContent":["import { Language } from \"./context\";\n\nexport enum LocaleEnum {\n  /** English */\n  en = \"en\",\n  /** Chinese */\n  zh = \"zh\",\n  /** Japanese */\n  ja = \"ja\",\n  /** Spanish */\n  es = \"es\",\n  /** Korean */\n  ko = \"ko\",\n  /** Vietnamese */\n  vi = \"vi\",\n  /** German */\n  de = \"de\",\n  /** French */\n  fr = \"fr\",\n  /** Russian */\n  ru = \"ru\",\n  /** Indonesian */\n  id = \"id\",\n  /** Turkish */\n  tr = \"tr\",\n  /** Italian */\n  it = \"it\",\n  /** Portuguese */\n  pt = \"pt\",\n  /** Ukrainian */\n  uk = \"uk\",\n  /** Polish */\n  pl = \"pl\",\n  /** Dutch */\n  nl = \"nl\",\n}\n\nexport const defaultLanguages: Language[] = [\n  { localCode: LocaleEnum.en, displayName: \"English\" }, // English\n  { localCode: LocaleEnum.zh, displayName: \"中文\" }, // Chinese\n  { localCode: LocaleEnum.ja, displayName: \"日本語\" }, // Japanese\n  { localCode: LocaleEnum.es, displayName: \"Español\" }, // Spanish\n  { localCode: LocaleEnum.ko, displayName: \"한국어\" }, // Korean\n  { localCode: LocaleEnum.vi, displayName: \"Tiếng Việt\" }, // Vietnamese\n  { localCode: LocaleEnum.de, displayName: \"Deutsch\" }, // German\n  { localCode: LocaleEnum.fr, displayName: \"Français\" }, // French\n  { localCode: LocaleEnum.ru, displayName: \"Русский\" }, // Russian\n  { localCode: LocaleEnum.id, displayName: \"Bahasa Indonesia\" }, // Indonesian\n  { localCode: LocaleEnum.tr, displayName: \"Türkçe\" }, // Turkish\n  { localCode: LocaleEnum.it, displayName: \"Italiano\" }, // Italian\n  { localCode: LocaleEnum.pt, displayName: \"Português\" }, // Portuguese\n  { localCode: LocaleEnum.uk, displayName: \"Українська\" }, // Ukrainian\n  { localCode: LocaleEnum.pl, displayName: \"Polski\" }, // Polish\n  { localCode: LocaleEnum.nl, displayName: \"Nederlands\" }, // Dutch\n];\nexport const defaultLng = LocaleEnum.en;\nexport const defaultNS = \"translation\";\n\nexport const i18nLocalStorageKey = \"orderly_i18nLng\";\n\n// preferred-language\nexport const i18nCookieKey = \"orderly_i18nLng\";\n"]}

package/dist/index.d.mts

@@ -0,0 +1,44 @@
+import { L as LocaleCode, R as Resources, a as LocaleContextState } from './types-Bcx1nSla.js';
+export { b as Language, d as LocaleContext, f as LocaleEnum, e as LocaleMessages, P as PopupMode, c as PopupProps, g as defaultLanguages, h as defaultLng, i as defaultNS, l as en, k as i18nCookieKey, j as i18nLocalStorageKey, u as useLocaleContext } from './types-Bcx1nSla.js';
+import * as react_i18next from 'react-i18next';
+import { I18nextProviderProps, FallbackNs, UseTranslationOptions } from 'react-i18next';
+export * from 'react-i18next';
+import * as i18next from 'i18next';
+import { FlatNamespace, KeyPrefix } from 'i18next';
+export { createInstance, default as i18next } from 'i18next';
+import { ReactNode } from 'react';
+import { $Tuple } from 'react-i18next/helpers';
+export { generatePath, getLocalePathFromPathname, parseI18nLang, removeLangPrefix } from './utils.mjs';
+
+declare const i18n: i18next.i18n;
+
+type BackendOptions = {
+    loadPath: (lang: LocaleCode, ns: string) => string | string[];
+};
+
+type I18nProviderProps = Partial<I18nextProviderProps>;
+declare const I18nProvider: React.FC<I18nProviderProps>;
+type LocaleProviderProps = {
+    children: ReactNode;
+    locale?: LocaleCode;
+    resource?: Record<string, string>;
+    resources?: Resources;
+    /**
+     * supported languages, you can select supported languages from default languages
+     */
+    supportedLanguages?: LocaleCode[];
+    /**
+     * @deprecated use onLanguageChanged instead, will be removed in next patch version
+     */
+    onLocaleChange?: (locale: LocaleCode) => void;
+    /** optional conversion function to use to modify the detected language code */
+    convertDetectedLanguage?: (lang: string) => LocaleCode;
+    backend?: BackendOptions;
+} & Partial<LocaleContextState>;
+declare const LocaleProvider: React.FC<LocaleProviderProps>;
+
+declare function useTranslation<Ns extends FlatNamespace | $Tuple<FlatNamespace> | undefined, KPrefix extends KeyPrefix<FallbackNs<Ns>> = undefined>(ns?: Ns, options?: UseTranslationOptions<KPrefix>): react_i18next.UseTranslationResponse<FallbackNs<Ns>, KPrefix>;
+
+declare function useLocaleCode(): LocaleCode;
+
+export { I18nProvider, type I18nProviderProps, LocaleCode, LocaleContextState, LocaleProvider, type LocaleProviderProps, Resources, i18n, useLocaleCode, useTranslation };