@hoardodile/i18n 0.1.3 → 0.1.5

package/dist/core.d.ts

@@ -19,6 +19,19 @@
 declare const SUPPORTED_LANGUAGES: readonly ["en", "zh", "ja", "de", "es"];
 type SupportedLanguage = (typeof SUPPORTED_LANGUAGES)[number];
 declare function isSupportedLanguage(value: string): value is SupportedLanguage;
+/**
+ * Catalog key for each supported language's display name in its own
+ * script (`language.english` → "English", `language.chinese` → "中文", …).
+ * The `language.*` catalog keys are named (not BCP-47 codes), so build the
+ * `t()` key through this map rather than interpolating the code.
+ */
+declare const LANGUAGE_LABEL_KEYS: {
+    readonly en: "language.english";
+    readonly zh: "language.chinese";
+    readonly ja: "language.japanese";
+    readonly de: "language.german";
+    readonly es: "language.spanish";
+};
 /**
  * Map a BCP-47 locale string (e.g. `navigator.language`,
  * `app.getLocale()`, a stored pref) onto the supported set, taking the
@@ -29,4 +42,4 @@ declare function isSupportedLanguage(value: string): value is SupportedLanguage;
  */
 declare function resolveSystemLanguage(raw: string | undefined): SupportedLanguage;
 
-export { SUPPORTED_LANGUAGES, type SupportedLanguage, isSupportedLanguage, resolveSystemLanguage };
+export { LANGUAGE_LABEL_KEYS, SUPPORTED_LANGUAGES, type SupportedLanguage, isSupportedLanguage, resolveSystemLanguage };

package/dist/core.js

@@ -3,12 +3,19 @@ var SUPPORTED_LANGUAGES = ["en", "zh", "ja", "de", "es"];
 function isSupportedLanguage(value) {
   return SUPPORTED_LANGUAGES.includes(value);
 }
+var LANGUAGE_LABEL_KEYS = {
+  en: "language.english",
+  zh: "language.chinese",
+  ja: "language.japanese",
+  de: "language.german",
+  es: "language.spanish"
+};
 function resolveSystemLanguage(raw) {
   const base = raw?.toLowerCase().split("-")[0];
   if (base !== void 0 && isSupportedLanguage(base)) return base;
   return "en";
 }
 
-export { SUPPORTED_LANGUAGES, isSupportedLanguage, resolveSystemLanguage };
+export { LANGUAGE_LABEL_KEYS, SUPPORTED_LANGUAGES, isSupportedLanguage, resolveSystemLanguage };
 //# sourceMappingURL=core.js.map
 //# sourceMappingURL=core.js.map

package/dist/core.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/core.ts"],"names":[],"mappings":";AAkBO,IAAM,sBAAsB,CAAC,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,MAAM,IAAI;AAGzD,SAAS,oBAAoB,KAAA,EAA2C;AAC9E,EAAA,OAAQ,mBAAA,CAA0C,SAAS,KAAK,CAAA;AACjE;AAUO,SAAS,sBACf,GAAA,EACoB;AACpB,EAAA,MAAM,OAAO,GAAA,EAAK,WAAA,GAAc,KAAA,CAAM,GAAG,EAAE,CAAC,CAAA;AAC5C,EAAA,IAAI,IAAA,KAAS,MAAA,IAAa,mBAAA,CAAoB,IAAI,GAAG,OAAO,IAAA;AAC5D,EAAA,OAAO,IAAA;AACR","file":"core.js","sourcesContent":["/**\n * Locale plumbing shared by the web SPA, the Electron shell and the plugin\n * SDK: the supported-language set and pure helpers. **This module must\n * stay free of catalog imports** — the sandboxed preload imports\n * `isSupportedLanguage` from here, and the catalogs (which weigh far\n * more than this file) live in `./catalogs.ts` (`CATALOGS`,\n * `catalogFor`), `./catalogs/ui.ts` (`UI_CATALOGS`, `uiCatalogFor`) plus\n * the per-language JSON modules.\n *\n * `catalogs/*.json` (the app `translation` namespace) and `ui/*.json`\n * (the shared `ui` namespace consumed by `@hoardodile/ui` and the plugin\n * SDK iframes) must stay in lockstep internally: identical flat key\n * sets, matching interpolation placeholders, and complete `_one`/`_other`\n * pairs. `src/parity.test.ts` enforces this — run it after touching any\n * catalog. `CATALOGS: Record<SupportedLanguage, typeof en>` and\n * `UI_CATALOGS: Record<SupportedLanguage, typeof uiEn>` additionally\n * make any key drift a compile error in `tsc`.\n */\nexport const SUPPORTED_LANGUAGES = [\"en\", \"zh\", \"ja\", \"de\", \"es\"] as const\nexport type SupportedLanguage = (typeof SUPPORTED_LANGUAGES)[number]\n\nexport function isSupportedLanguage(value: string): value is SupportedLanguage {\n\treturn (SUPPORTED_LANGUAGES as readonly string[]).includes(value)\n}\n\n/**\n * Map a BCP-47 locale string (e.g. `navigator.language`,\n * `app.getLocale()`, a stored pref) onto the supported set, taking the\n * base code: `\"ja-JP\"` → `\"ja\"`, `\"de-DE\"` → `\"de\"`, `\"es-MX\"` → `\"es\"`,\n * `\"zh-CN\"`/`\"zh-TW\"` → `\"zh\"` (any Chinese base maps to the `zh`\n * catalog, preserving historical behavior). Unknown or missing values\n * fall back to `\"en\"`.\n */\nexport function resolveSystemLanguage(\n\traw: string | undefined,\n): SupportedLanguage {\n\tconst base = raw?.toLowerCase().split(\"-\")[0]\n\tif (base !== undefined && isSupportedLanguage(base)) return base\n\treturn \"en\"\n}\n"]}
+{"version":3,"sources":["../src/core.ts"],"names":[],"mappings":";AAkBO,IAAM,sBAAsB,CAAC,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,MAAM,IAAI;AAGzD,SAAS,oBAAoB,KAAA,EAA2C;AAC9E,EAAA,OAAQ,mBAAA,CAA0C,SAAS,KAAK,CAAA;AACjE;AAQO,IAAM,mBAAA,GAAsB;AAAA,EAClC,EAAA,EAAI,kBAAA;AAAA,EACJ,EAAA,EAAI,kBAAA;AAAA,EACJ,EAAA,EAAI,mBAAA;AAAA,EACJ,EAAA,EAAI,iBAAA;AAAA,EACJ,EAAA,EAAI;AACL;AAUO,SAAS,sBACf,GAAA,EACoB;AACpB,EAAA,MAAM,OAAO,GAAA,EAAK,WAAA,GAAc,KAAA,CAAM,GAAG,EAAE,CAAC,CAAA;AAC5C,EAAA,IAAI,IAAA,KAAS,MAAA,IAAa,mBAAA,CAAoB,IAAI,GAAG,OAAO,IAAA;AAC5D,EAAA,OAAO,IAAA;AACR","file":"core.js","sourcesContent":["/**\n * Locale plumbing shared by the web SPA, the Electron shell and the plugin\n * SDK: the supported-language set and pure helpers. **This module must\n * stay free of catalog imports** — the sandboxed preload imports\n * `isSupportedLanguage` from here, and the catalogs (which weigh far\n * more than this file) live in `./catalogs.ts` (`CATALOGS`,\n * `catalogFor`), `./catalogs/ui.ts` (`UI_CATALOGS`, `uiCatalogFor`) plus\n * the per-language JSON modules.\n *\n * `catalogs/*.json` (the app `translation` namespace) and `ui/*.json`\n * (the shared `ui` namespace consumed by `@hoardodile/ui` and the plugin\n * SDK iframes) must stay in lockstep internally: identical flat key\n * sets, matching interpolation placeholders, and complete `_one`/`_other`\n * pairs. `src/parity.test.ts` enforces this — run it after touching any\n * catalog. `CATALOGS: Record<SupportedLanguage, typeof en>` and\n * `UI_CATALOGS: Record<SupportedLanguage, typeof uiEn>` additionally\n * make any key drift a compile error in `tsc`.\n */\nexport const SUPPORTED_LANGUAGES = [\"en\", \"zh\", \"ja\", \"de\", \"es\"] as const\nexport type SupportedLanguage = (typeof SUPPORTED_LANGUAGES)[number]\n\nexport function isSupportedLanguage(value: string): value is SupportedLanguage {\n\treturn (SUPPORTED_LANGUAGES as readonly string[]).includes(value)\n}\n\n/**\n * Catalog key for each supported language's display name in its own\n * script (`language.english` → \"English\", `language.chinese` → \"中文\", …).\n * The `language.*` catalog keys are named (not BCP-47 codes), so build the\n * `t()` key through this map rather than interpolating the code.\n */\nexport const LANGUAGE_LABEL_KEYS = {\n\ten: \"language.english\",\n\tzh: \"language.chinese\",\n\tja: \"language.japanese\",\n\tde: \"language.german\",\n\tes: \"language.spanish\",\n} as const satisfies Record<SupportedLanguage, string>\n\n/**\n * Map a BCP-47 locale string (e.g. `navigator.language`,\n * `app.getLocale()`, a stored pref) onto the supported set, taking the\n * base code: `\"ja-JP\"` → `\"ja\"`, `\"de-DE\"` → `\"de\"`, `\"es-MX\"` → `\"es\"`,\n * `\"zh-CN\"`/`\"zh-TW\"` → `\"zh\"` (any Chinese base maps to the `zh`\n * catalog, preserving historical behavior). Unknown or missing values\n * fall back to `\"en\"`.\n */\nexport function resolveSystemLanguage(\n\traw: string | undefined,\n): SupportedLanguage {\n\tconst base = raw?.toLowerCase().split(\"-\")[0]\n\tif (base !== undefined && isSupportedLanguage(base)) return base\n\treturn \"en\"\n}\n"]}

package/dist/create-i18n.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/core.ts","../src/create-i18n.ts"],"names":[],"mappings":";;;;;AAkBO,IAAM,sBAAsB,CAAC,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,MAAM,IAAI,CAAA;;;ACgBzD,SAAS,WAAW,OAAA,EAA0C;AACpE,EAAA,MAAM,EAAE,GAAA,EAAK,SAAA,EAAW,GAAG,MAAK,GAAI,OAAA;AACpC,EAAA,MAAM,QAAA,GAAW,QAAQ,cAAA,EAAe;AACxC,EAAA,KAAK,SAAS,IAAA,CAAK;AAAA,IAClB,SAAA;AAAA,IACA,GAAA;AAAA,IACA,WAAA,EAAa,IAAA;AAAA,IACb,aAAA,EAAe,CAAC,GAAG,mBAAmB,CAAA;AAAA,IACtC,wBAAA,EAA0B,IAAA;AAAA,IAC1B,aAAA,EAAe,EAAE,WAAA,EAAa,KAAA,EAAM;AAAA,IACpC,UAAA,EAAY,KAAA;AAAA,IACZ,iBAAA,EAAmB,KAAA;AAAA,IACnB,iBAAA,EAAmB,IAAA;AAAA,IACnB,eAAA,EAAiB,GAAA;AAAA,IACjB,GAAG;AAAA,GACmB,CAAA;AACvB,EAAA,OAAO,QAAA;AACR","file":"create-i18n.js","sourcesContent":["/**\n * Locale plumbing shared by the web SPA, the Electron shell and the plugin\n * SDK: the supported-language set and pure helpers. **This module must\n * stay free of catalog imports** — the sandboxed preload imports\n * `isSupportedLanguage` from here, and the catalogs (which weigh far\n * more than this file) live in `./catalogs.ts` (`CATALOGS`,\n * `catalogFor`), `./catalogs/ui.ts` (`UI_CATALOGS`, `uiCatalogFor`) plus\n * the per-language JSON modules.\n *\n * `catalogs/*.json` (the app `translation` namespace) and `ui/*.json`\n * (the shared `ui` namespace consumed by `@hoardodile/ui` and the plugin\n * SDK iframes) must stay in lockstep internally: identical flat key\n * sets, matching interpolation placeholders, and complete `_one`/`_other`\n * pairs. `src/parity.test.ts` enforces this — run it after touching any\n * catalog. `CATALOGS: Record<SupportedLanguage, typeof en>` and\n * `UI_CATALOGS: Record<SupportedLanguage, typeof uiEn>` additionally\n * make any key drift a compile error in `tsc`.\n */\nexport const SUPPORTED_LANGUAGES = [\"en\", \"zh\", \"ja\", \"de\", \"es\"] as const\nexport type SupportedLanguage = (typeof SUPPORTED_LANGUAGES)[number]\n\nexport function isSupportedLanguage(value: string): value is SupportedLanguage {\n\treturn (SUPPORTED_LANGUAGES as readonly string[]).includes(value)\n}\n\n/**\n * Map a BCP-47 locale string (e.g. `navigator.language`,\n * `app.getLocale()`, a stored pref) onto the supported set, taking the\n * base code: `\"ja-JP\"` → `\"ja\"`, `\"de-DE\"` → `\"de\"`, `\"es-MX\"` → `\"es\"`,\n * `\"zh-CN\"`/`\"zh-TW\"` → `\"zh\"` (any Chinese base maps to the `zh`\n * catalog, preserving historical behavior). Unknown or missing values\n * fall back to `\"en\"`.\n */\nexport function resolveSystemLanguage(\n\traw: string | undefined,\n): SupportedLanguage {\n\tconst base = raw?.toLowerCase().split(\"-\")[0]\n\tif (base !== undefined && isSupportedLanguage(base)) return base\n\treturn \"en\"\n}\n","/**\n * The i18next instance factory every React root uses: the web SPA, the\n * desktop wizard/shell pages, the workbench and the plugin SDK iframes\n * all boot their instance with the same options so catalog behavior\n * (fallback, plurals, interpolation, type safety) never diverges between\n * surfaces.\n *\n * This module is deliberately free of catalog imports — plugin iframe\n * bundles import the factory through this subpath and ship only the\n * small `ui`/`plugin` namespaces (the full app catalog would otherwise\n * be pulled into every bundle). Host surfaces use `createI18n` from\n * `@hoardodile/i18n`, which wraps this factory with the shared catalogs.\n *\n * React-free on purpose: the Electron main process and the sandboxed\n * preload keep using `catalogFor` / `uiCatalogFor` directly, and each\n * React root adds its own `react-i18next` binding (e.g.\n * `setI18n(instance)`).\n */\n\nimport i18next, { type i18n as I18nInstance, type InitOptions } from \"i18next\"\nimport { SUPPORTED_LANGUAGES } from \"./core.ts\"\n\nexport type CreateI18nOptions = Omit<InitOptions, \"lng\" | \"resources\"> & {\n\t/** Initial language; undefined lets i18next resolve its default (fallback → \"en\"). */\n\treadonly lng?: string\n\t/** Resource map — the shared catalogs (or the smaller ui/plugin set). */\n\treadonly resources: InitOptions[\"resources\"]\n}\n\n/**\n * Create an i18next instance with the canonical option set. Callers\n * supply the resources explicitly (hosts via the `@hoardodile/i18n`\n * wrapper, plugins via the SDK).\n */\nexport function createI18n(options: CreateI18nOptions): I18nInstance {\n\tconst { lng, resources, ...rest } = options\n\tconst instance = i18next.createInstance()\n\tvoid instance.init({\n\t\tresources,\n\t\tlng,\n\t\tfallbackLng: \"en\",\n\t\tsupportedLngs: [...SUPPORTED_LANGUAGES],\n\t\tnonExplicitSupportedLngs: true,\n\t\tinterpolation: { escapeValue: false },\n\t\treturnNull: false,\n\t\treturnEmptyString: false,\n\t\tcompatibilityJSON: \"v4\",\n\t\tpluralSeparator: \"_\",\n\t\t...rest,\n\t} satisfies InitOptions)\n\treturn instance\n}\n"]}
+{"version":3,"sources":["../src/core.ts","../src/create-i18n.ts"],"names":[],"mappings":";;;;;AAkBO,IAAM,sBAAsB,CAAC,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,MAAM,IAAI,CAAA;;;ACgBzD,SAAS,WAAW,OAAA,EAA0C;AACpE,EAAA,MAAM,EAAE,GAAA,EAAK,SAAA,EAAW,GAAG,MAAK,GAAI,OAAA;AACpC,EAAA,MAAM,QAAA,GAAW,QAAQ,cAAA,EAAe;AACxC,EAAA,KAAK,SAAS,IAAA,CAAK;AAAA,IAClB,SAAA;AAAA,IACA,GAAA;AAAA,IACA,WAAA,EAAa,IAAA;AAAA,IACb,aAAA,EAAe,CAAC,GAAG,mBAAmB,CAAA;AAAA,IACtC,wBAAA,EAA0B,IAAA;AAAA,IAC1B,aAAA,EAAe,EAAE,WAAA,EAAa,KAAA,EAAM;AAAA,IACpC,UAAA,EAAY,KAAA;AAAA,IACZ,iBAAA,EAAmB,KAAA;AAAA,IACnB,iBAAA,EAAmB,IAAA;AAAA,IACnB,eAAA,EAAiB,GAAA;AAAA,IACjB,GAAG;AAAA,GACmB,CAAA;AACvB,EAAA,OAAO,QAAA;AACR","file":"create-i18n.js","sourcesContent":["/**\n * Locale plumbing shared by the web SPA, the Electron shell and the plugin\n * SDK: the supported-language set and pure helpers. **This module must\n * stay free of catalog imports** — the sandboxed preload imports\n * `isSupportedLanguage` from here, and the catalogs (which weigh far\n * more than this file) live in `./catalogs.ts` (`CATALOGS`,\n * `catalogFor`), `./catalogs/ui.ts` (`UI_CATALOGS`, `uiCatalogFor`) plus\n * the per-language JSON modules.\n *\n * `catalogs/*.json` (the app `translation` namespace) and `ui/*.json`\n * (the shared `ui` namespace consumed by `@hoardodile/ui` and the plugin\n * SDK iframes) must stay in lockstep internally: identical flat key\n * sets, matching interpolation placeholders, and complete `_one`/`_other`\n * pairs. `src/parity.test.ts` enforces this — run it after touching any\n * catalog. `CATALOGS: Record<SupportedLanguage, typeof en>` and\n * `UI_CATALOGS: Record<SupportedLanguage, typeof uiEn>` additionally\n * make any key drift a compile error in `tsc`.\n */\nexport const SUPPORTED_LANGUAGES = [\"en\", \"zh\", \"ja\", \"de\", \"es\"] as const\nexport type SupportedLanguage = (typeof SUPPORTED_LANGUAGES)[number]\n\nexport function isSupportedLanguage(value: string): value is SupportedLanguage {\n\treturn (SUPPORTED_LANGUAGES as readonly string[]).includes(value)\n}\n\n/**\n * Catalog key for each supported language's display name in its own\n * script (`language.english` → \"English\", `language.chinese` → \"中文\", …).\n * The `language.*` catalog keys are named (not BCP-47 codes), so build the\n * `t()` key through this map rather than interpolating the code.\n */\nexport const LANGUAGE_LABEL_KEYS = {\n\ten: \"language.english\",\n\tzh: \"language.chinese\",\n\tja: \"language.japanese\",\n\tde: \"language.german\",\n\tes: \"language.spanish\",\n} as const satisfies Record<SupportedLanguage, string>\n\n/**\n * Map a BCP-47 locale string (e.g. `navigator.language`,\n * `app.getLocale()`, a stored pref) onto the supported set, taking the\n * base code: `\"ja-JP\"` → `\"ja\"`, `\"de-DE\"` → `\"de\"`, `\"es-MX\"` → `\"es\"`,\n * `\"zh-CN\"`/`\"zh-TW\"` → `\"zh\"` (any Chinese base maps to the `zh`\n * catalog, preserving historical behavior). Unknown or missing values\n * fall back to `\"en\"`.\n */\nexport function resolveSystemLanguage(\n\traw: string | undefined,\n): SupportedLanguage {\n\tconst base = raw?.toLowerCase().split(\"-\")[0]\n\tif (base !== undefined && isSupportedLanguage(base)) return base\n\treturn \"en\"\n}\n","/**\n * The i18next instance factory every React root uses: the web SPA, the\n * desktop wizard/shell pages, the workbench and the plugin SDK iframes\n * all boot their instance with the same options so catalog behavior\n * (fallback, plurals, interpolation, type safety) never diverges between\n * surfaces.\n *\n * This module is deliberately free of catalog imports — plugin iframe\n * bundles import the factory through this subpath and ship only the\n * small `ui`/`plugin` namespaces (the full app catalog would otherwise\n * be pulled into every bundle). Host surfaces use `createI18n` from\n * `@hoardodile/i18n`, which wraps this factory with the shared catalogs.\n *\n * React-free on purpose: the Electron main process and the sandboxed\n * preload keep using `catalogFor` / `uiCatalogFor` directly, and each\n * React root adds its own `react-i18next` binding (e.g.\n * `setI18n(instance)`).\n */\n\nimport i18next, { type i18n as I18nInstance, type InitOptions } from \"i18next\"\nimport { SUPPORTED_LANGUAGES } from \"./core.ts\"\n\nexport type CreateI18nOptions = Omit<InitOptions, \"lng\" | \"resources\"> & {\n\t/** Initial language; undefined lets i18next resolve its default (fallback → \"en\"). */\n\treadonly lng?: string\n\t/** Resource map — the shared catalogs (or the smaller ui/plugin set). */\n\treadonly resources: InitOptions[\"resources\"]\n}\n\n/**\n * Create an i18next instance with the canonical option set. Callers\n * supply the resources explicitly (hosts via the `@hoardodile/i18n`\n * wrapper, plugins via the SDK).\n */\nexport function createI18n(options: CreateI18nOptions): I18nInstance {\n\tconst { lng, resources, ...rest } = options\n\tconst instance = i18next.createInstance()\n\tvoid instance.init({\n\t\tresources,\n\t\tlng,\n\t\tfallbackLng: \"en\",\n\t\tsupportedLngs: [...SUPPORTED_LANGUAGES],\n\t\tnonExplicitSupportedLngs: true,\n\t\tinterpolation: { escapeValue: false },\n\t\treturnNull: false,\n\t\treturnEmptyString: false,\n\t\tcompatibilityJSON: \"v4\",\n\t\tpluralSeparator: \"_\",\n\t\t...rest,\n\t} satisfies InitOptions)\n\treturn instance\n}\n"]}

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import { e as en } from './catalogs-P15rGrmg.js';
-export { C as CATALOGS, c as catalogFor } from './catalogs-P15rGrmg.js';
+import { e as en } from './catalogs-DkcPbpdW.js';
+export { C as CATALOGS, c as catalogFor } from './catalogs-DkcPbpdW.js';
 import { u as uiEn } from './ui-DYXLhqSV.js';
 export { U as UI_CATALOGS, a as uiCatalogFor } from './ui-DYXLhqSV.js';
 import { i18n } from 'i18next';
 import { CreateI18nOptions } from './create-i18n.js';
-export { SUPPORTED_LANGUAGES, SupportedLanguage, isSupportedLanguage, resolveSystemLanguage } from './core.js';
+export { LANGUAGE_LABEL_KEYS, SUPPORTED_LANGUAGES, SupportedLanguage, isSupportedLanguage, resolveSystemLanguage } from './core.js';
 
 /**
  * Type the `t()` keys of every consumer against the catalogs: a wrong key