@nice2dev/i18n 1.1.9 → 1.2.0

package/README.md

@@ -5,7 +5,7 @@ Shared internationalization infrastructure for Nice2Dev UI libraries.
 ## Features
 
 - **NiceI18nProvider** — React context for translations
-- **20 built-in languages** — en, pl, de, fr, es, it, pt, nl, sv, no, da, fi, cs, sk, hu, ro, bg, uk, ja, ko, zh, ar
+- **30 built-in languages**, loaded one at a time — en, pl, de, fr, es, it, pt, nl, sv, no, da, fi, cs, sk, hu, ro, bg, uk, ja, ko, zh, ar, hi, bn, th, vi, id, sw, fil, ms
 - **ICU MessageFormat** — pluralization, gender, ordinals, select
 - **RTL support** — Arabic, Hebrew with automatic dir attribute
 - **Browser detection** — `detectBrowserLanguage()` auto-detects user preference
@@ -39,6 +39,27 @@ function App() {
 
 All Nice2Dev components automatically pick up translations from the provider.
 
+The provider loads only the dictionary of `lang`, with `import()`, so your bundler gives each
+language its own chunk. Until it arrives the controls show their built-in English; to start in
+the language, load it before the first render:
+
+```tsx
+import { NiceI18nProvider, loadNiceDictionary } from '@nice2dev/i18n';
+
+await loadNiceDictionary('pl');
+root.render(
+  <NiceI18nProvider lang="pl">
+    <App />
+  </NiceI18nProvider>,
+);
+```
+
+Or pass `fallback` to render something else meanwhile. Up to 1.1.x the provider carried all thirty
+dictionaries; 1.1.10 added this loading as `NiceI18nLazyProvider`, which is now the same component.
+If your bundler config groups modules by package (`manualChunks`), leave
+`@nice2dev/i18n/dist/dictionaries/` out of the group — see the
+[setup guide](../../documentation/guides/GLOBAL_THEMING_I18N_SETUP.md#bundler-chunking-manualchunks).
+
 ### Option 2: Custom Translation Function
 
 If you use react-i18next, i18next, or any other i18n library:
@@ -70,12 +91,19 @@ All components work without a provider — they show English by default.
 
 ### NiceI18nProvider
 
-| Prop        | Type                       | Description                                              |
-| ----------- | -------------------------- | -------------------------------------------------------- |
-| `lang`      | `NiceSupportedLang`        | Built-in language code (default: 'en')                   |
-| `t`         | `(key, default) => string` | Custom translation function (takes priority over `lang`) |
-| `overrides` | `Record<string, string>`   | Extra translations merged on top of built-in dictionary  |
-| `children`  | `ReactNode`                | App content                                              |
+| Prop        | Type                       | Description                                                                   |
+| ----------- | -------------------------- | ----------------------------------------------------------------------------- |
+| `lang`      | `NiceSupportedLang`        | Built-in language code (default: 'en'); its dictionary is loaded on first use |
+| `t`         | `(key, default) => string` | Custom translation function (takes priority over `lang`; nothing is loaded)   |
+| `overrides` | `Record<string, string>`   | Extra translations merged on top of built-in dictionary                       |
+| `fallback`  | `ReactNode`                | Rendered instead of `children` until the first dictionary has loaded          |
+| `onError`   | `(error) => void`          | Called when a dictionary fails to load                                        |
+| `children`  | `ReactNode`                | App content                                                                   |
+
+### loadNiceDictionary
+
+`loadNiceDictionary(lang)` loads one language's dictionary and caches it; concurrent calls share
+one request. `getLoadedNiceDictionary(lang)` returns it once loaded, otherwise `undefined`.
 
 ### useNiceTranslation
 
@@ -90,12 +118,15 @@ function MyComponent() {
 }
 ```
 
-### createTranslator
+### `@nice2dev/i18n/all` — every dictionary at once
 
-Create a translator function without React context:
+`NICE_I18N_DICTIONARIES`, `createTranslator`, `NICE_I18N_VARIANTS` / `resolvePlVariant` and the
+translation tooling (`getMissingTranslations`, `getTranslationStats`, `NICE_GLOSSARY`, …) need all
+thirty languages, so they live on their own entry (1.2.0). Use it in build scripts, tests or a
+translation editor — not in app code that only shows one language.
 
 ```tsx
-import { createTranslator } from '@nice2dev/i18n';
+import { createTranslator } from '@nice2dev/i18n/all';
 
 const t = createTranslator('de');
 console.log(t('save', 'Save')); // "Speichern"
@@ -146,30 +177,38 @@ const userLang = detectBrowserLanguage(); // e.g. 'pl' if browser is Polish
 
 ## Supported Languages
 
-| Code | Language     | Native Name |
-| ---- | ------------ | ----------- |
-| `en` | English      | English     |
-| `pl` | Polish       | Polski      |
-| `de` | German       | Deutsch     |
-| `fr` | French       | Français    |
-| `es` | Spanish      | Español     |
-| `it` | Italian      | Italiano    |
-| `pt` | Portuguese   | Português   |
-| `nl` | Dutch        | Nederlands  |
-| `sv` | Swedish      | Svenska     |
-| `no` | Norwegian    | Norsk       |
-| `da` | Danish       | Dansk       |
-| `fi` | Finnish      | Suomi       |
-| `cs` | Czech        | Čeština     |
-| `sk` | Slovak       | Slovenčina  |
-| `hu` | Hungarian    | Magyar      |
-| `ro` | Romanian     | Română      |
-| `bg` | Bulgarian    | Български   |
-| `uk` | Ukrainian    | Українська  |
-| `ja` | Japanese     | 日本語      |
-| `ko` | Korean       | 한국어      |
-| `zh` | Chinese      | 中文        |
-| `ar` | Arabic (RTL) | العربية     |
+| Code  | Language     | Native Name |
+| ----- | ------------ | ----------- |
+| `en`  | English      | English     |
+| `pl`  | Polish       | Polski      |
+| `de`  | German       | Deutsch     |
+| `fr`  | French       | Français    |
+| `es`  | Spanish      | Español     |
+| `it`  | Italian      | Italiano    |
+| `pt`  | Portuguese   | Português   |
+| `nl`  | Dutch        | Nederlands  |
+| `sv`  | Swedish      | Svenska     |
+| `no`  | Norwegian    | Norsk       |
+| `da`  | Danish       | Dansk       |
+| `fi`  | Finnish      | Suomi       |
+| `cs`  | Czech        | Čeština     |
+| `sk`  | Slovak       | Slovenčina  |
+| `hu`  | Hungarian    | Magyar      |
+| `ro`  | Romanian     | Română      |
+| `bg`  | Bulgarian    | Български   |
+| `uk`  | Ukrainian    | Українська  |
+| `ja`  | Japanese     | 日本語      |
+| `ko`  | Korean       | 한국어      |
+| `zh`  | Chinese      | 中文        |
+| `ar`  | Arabic (RTL) | العربية     |
+| `hi`  | Hindi        | हिन्दी      |
+| `bn`  | Bengali      | বাংলা       |
+| `th`  | Thai         | ไทย         |
+| `vi`  | Vietnamese   | Tiếng Việt  |
+| `id`  | Indonesian   | Indonesia   |
+| `sw`  | Swahili      | Kiswahili   |
+| `fil` | Filipino     | Filipino    |
+| `ms`  | Malay        | Melayu      |
 
 ## Adding Custom Translations
 
@@ -192,7 +231,7 @@ All Nice2Dev components use namespaced keys like:
 - `dataGrid.sort`, `dataGrid.filter` — grid-specific
 - `form.required`, `form.invalid` — validation messages
 
-See `src/i18nDictionaries.ts` for the full list.
+See `src/dictionaries/en.ts` for the full list.
 
 ## License
 

package/dist/all.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("./i18nDictionaries.cjs"),e=require("./translate-pipeline.cjs"),a=require("./translationMemory.cjs"),t=require("./dictionaries/index.cjs");function g(o="en",r){const n=t.NICE_I18N_DICTIONARIES[o]??t.NICE_I18N_DICTIONARIES.en,i=r?{...n,...r}:n;return(l,I)=>i[l]??I}exports.NICE_I18N_VARIANTS=s.NICE_I18N_VARIANTS;exports.resolvePlVariant=s.resolvePlVariant;exports.generateCoverageReport=e.generateCoverageReport;exports.generateTranslationCode=e.generateTranslationCode;exports.getAllTranslationStats=e.getAllTranslationStats;exports.getMissingTranslations=e.getMissingTranslations;exports.getSourceKeys=e.getSourceKeys;exports.getTranslationStats=e.getTranslationStats;exports.NICE_GLOSSARY=a.NICE_GLOSSARY;exports.findSimilarTranslation=a.findSimilarTranslation;exports.getGlossaryForLanguage=a.getGlossaryForLanguage;exports.lookupGlossary=a.lookupGlossary;exports.validateAgainstGlossary=a.validateAgainstGlossary;exports.NICE_I18N_DICTIONARIES=t.NICE_I18N_DICTIONARIES;exports.createTranslator=g;

package/dist/all.d.ts

@@ -0,0 +1,136 @@
+/**
+ * A translation function without React context, for non-component code. Synchronous, so it
+ * reads the full dictionary map; in an app, `await loadNiceDictionary(lang)` from the main
+ * entry and look keys up in what it returns instead.
+ */
+export declare function createTranslator(lang?: NiceSupportedLang, overrides?: Record<string, string>): NiceTranslateFn;
+
+/**
+ * Find fuzzy matches in existing translations for reuse.
+ * Compares the English value to find similar existing translations.
+ */
+export declare function findSimilarTranslation(englishValue: string, lang: NiceSupportedLang, threshold?: number): {
+    key: string;
+    english: string;
+    translated: string;
+    similarity: number;
+} | undefined;
+
+/**
+ * Generate a coverage report in markdown format.
+ */
+export declare function generateCoverageReport(): string;
+
+/**
+ * Generate TypeScript code for translations to be added to the dictionary.
+ */
+export declare function generateTranslationCode(lang: NiceSupportedLang, translations: TranslationResult[]): string;
+
+/**
+ * Get translation statistics for all languages.
+ */
+export declare function getAllTranslationStats(): TranslationStats[];
+
+/**
+ * Get all glossary entries for a specific language.
+ */
+export declare function getGlossaryForLanguage(lang: NiceSupportedLang): Array<{
+    en: string;
+    translation: string;
+}>;
+
+/**
+ * Find missing translations for a specific language.
+ */
+export declare function getMissingTranslations(lang: NiceSupportedLang): MissingTranslation[];
+
+/**
+ * Get all keys from the English dictionary (source of truth).
+ */
+export declare function getSourceKeys(): string[];
+
+/**
+ * Get translation statistics for a language.
+ */
+export declare function getTranslationStats(lang: NiceSupportedLang): TranslationStats;
+
+export declare interface GlossaryEntry {
+    en: string;
+    translations: Partial<Record<NiceSupportedLang, string>>;
+    context?: string;
+}
+
+/**
+ * Look up a term in the glossary for a given language.
+ * Returns the approved translation or undefined.
+ */
+export declare function lookupGlossary(englishTerm: string, lang: NiceSupportedLang): string | undefined;
+
+export declare interface MissingTranslation {
+    key: string;
+    englishValue: string;
+}
+
+export declare const NICE_GLOSSARY: GlossaryEntry[];
+
+export declare const NICE_I18N_DICTIONARIES: Record<NiceSupportedLang, Record<string, string>>;
+
+/**
+ * Locale-and-register variants. Built on top of the base pl dictionary;
+ * unspecified keys fall back to NICE_I18N_DICTIONARIES.pl.
+ */
+export declare const NICE_I18N_VARIANTS: Partial<Record<string, Partial<Record<NiceI18nVariant, Record<string, string>>>>>;
+
+/**
+ * The languages with a built-in dictionary, and the two helpers that only need the list.
+ *
+ * Its own module, free of dictionary imports: the context, `useNiceTranslation` and the
+ * provider need the list but must not pull thirty dictionaries in with it. Until 1.1.x
+ * `isSupported` and `detectBrowserLanguage` sat next to the eager provider, in a module that
+ * imported all of them.
+ */
+declare const NICE_SUPPORTED_LANGS: readonly ["en", "pl", "de", "fr", "es", "it", "pt", "nl", "sv", "no", "da", "fi", "cs", "sk", "hu", "ro", "bg", "uk", "ja", "ko", "zh", "ar", "hi", "bn", "th", "vi", "id", "sw", "fil", "ms"];
+
+export declare type NiceI18nVariant = 'formal' | 'informal';
+
+declare type NiceSupportedLang = (typeof NICE_SUPPORTED_LANGS)[number];
+
+/**
+ * Translation function type.
+ * Accepts a key and a default/fallback value, returns the translated string.
+ */
+declare type NiceTranslateFn = (key: string, defaultValue: string) => string;
+
+/**
+ * Resolve a register-aware dictionary by locale + variant.
+ *
+ * Reads `pl` from its own module rather than through the aggregate, so this
+ * function pulls one language instead of all thirty.
+ */
+export declare function resolvePlVariant(variant: NiceI18nVariant): Record<string, string>;
+
+export declare interface TranslationResult {
+    key: string;
+    original: string;
+    translated: string;
+}
+
+export declare interface TranslationStats {
+    lang: NiceSupportedLang;
+    totalKeys: number;
+    translatedKeys: number;
+    missingKeys: number;
+    coverage: number;
+}
+
+/**
+ * Validate translations against the glossary.
+ * Returns entries where the translation doesn't match the glossary.
+ */
+export declare function validateAgainstGlossary(lang: NiceSupportedLang): Array<{
+    key: string;
+    currentTranslation: string;
+    glossaryTranslation: string;
+}>;
+
+export { }

package/dist/all.mjs

@@ -0,0 +1,25 @@
+import { NICE_I18N_VARIANTS as S, resolvePlVariant as T } from "./i18nDictionaries.mjs";
+import { generateCoverageReport as p, generateTranslationCode as N, getAllTranslationStats as c, getMissingTranslations as f, getSourceKeys as A, getTranslationStats as C } from "./translate-pipeline.mjs";
+import { NICE_GLOSSARY as _, findSimilarTranslation as d, getGlossaryForLanguage as x, lookupGlossary as y, validateAgainstGlossary as E } from "./translationMemory.mjs";
+import { NICE_I18N_DICTIONARIES as r } from "./dictionaries/index.mjs";
+function i(a = "en", t) {
+  const e = r[a] ?? r.en, o = t ? { ...e, ...t } : e;
+  return (n, s) => o[n] ?? s;
+}
+export {
+  _ as NICE_GLOSSARY,
+  r as NICE_I18N_DICTIONARIES,
+  S as NICE_I18N_VARIANTS,
+  i as createTranslator,
+  d as findSimilarTranslation,
+  p as generateCoverageReport,
+  N as generateTranslationCode,
+  c as getAllTranslationStats,
+  x as getGlossaryForLanguage,
+  f as getMissingTranslations,
+  A as getSourceKeys,
+  C as getTranslationStats,
+  y as lookupGlossary,
+  T as resolvePlVariant,
+  E as validateAgainstGlossary
+};

package/dist/calendar-systems.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const f=require("react"),C=require("./locale.cjs"),d={gregory:{id:"gregory",displayName:"Gregorian",monthsInYear:12,hasEra:!0,isLunar:!1,associatedLanguages:["en","de","fr","es","it","pt","nl","pl","cs","sk","hu","ro","bg","uk","sv","no","da","fi"]},islamic:{id:"islamic",displayName:"Islamic (Hijri)",monthsInYear:12,hasEra:!0,isLunar:!0,associatedLanguages:["ar"]},"islamic-umalqura":{id:"islamic-umalqura",displayName:"Islamic (Umm al-Qura)",monthsInYear:12,hasEra:!0,isLunar:!0,associatedLanguages:["ar"]},"islamic-tbla":{id:"islamic-tbla",displayName:"Islamic (Tabular)",monthsInYear:12,hasEra:!0,isLunar:!0,associatedLanguages:["ar"]},"islamic-civil":{id:"islamic-civil",displayName:"Islamic (Civil)",monthsInYear:12,hasEra:!0,isLunar:!0,associatedLanguages:["ar"]},hebrew:{id:"hebrew",displayName:"Hebrew",monthsInYear:13,hasEra:!1,isLunar:!0,associatedLanguages:[]},buddhist:{id:"buddhist",displayName:"Buddhist",monthsInYear:12,hasEra:!0,isLunar:!1,associatedLanguages:[]},japanese:{id:"japanese",displayName:"Japanese (Imperial)",monthsInYear:12,hasEra:!0,isLunar:!1,associatedLanguages:["ja"]},persian:{id:"persian",displayName:"Persian (Jalali)",monthsInYear:12,hasEra:!0,isLunar:!1,associatedLanguages:[]},chinese:{id:"chinese",displayName:"Chinese",monthsInYear:12,hasEra:!0,isLunar:!0,associatedLanguages:["zh"]},coptic:{id:"coptic",displayName:"Coptic",monthsInYear:13,hasEra:!0,isLunar:!1,associatedLanguages:[]},ethiopic:{id:"ethiopic",displayName:"Ethiopian",monthsInYear:13,hasEra:!0,isLunar:!1,associatedLanguages:[]},indian:{id:"indian",displayName:"Indian (Saka)",monthsInYear:12,hasEra:!0,isLunar:!1,associatedLanguages:[]},roc:{id:"roc",displayName:"Republic of China",monthsInYear:12,hasEra:!0,isLunar:!1,associatedLanguages:["zh"]}},p={en:"gregory",pl:"gregory",de:"gregory",fr:"gregory",es:"gregory",it:"gregory",pt:"gregory",nl:"gregory",sv:"gregory",no:"gregory",da:"gregory",fi:"gregory",cs:"gregory",sk:"gregory",hu:"gregory",ro:"gregory",bg:"gregory",uk:"gregory",ja:"japanese",ko:"gregory",zh:"gregory",ar:"islamic",hi:"gregory",bn:"gregory",th:"buddhist",vi:"gregory",id:"gregory",sw:"gregory",fil:"gregory",ms:"gregory"};function E(a,e="gregory",n={}){const r=C.getLocaleTag(a),{dateStyle:s="medium",showEra:u=!1,showWeekday:y=!1}=n,o={calendar:e,dateStyle:s};y&&(delete o.dateStyle,o.weekday="long",o.year="numeric",o.month="long",o.day="numeric");const M=new Intl.DateTimeFormat(r,o),H={calendar:e,year:"numeric",month:"long",day:"numeric",era:"long"},R=new Intl.DateTimeFormat(r,H),I=new Intl.DateTimeFormat(r,{calendar:e,month:"long"}),L=new Intl.DateTimeFormat(r,{calendar:e,weekday:"long"});return{format:t=>M.format(t),formatWithEra:t=>R.format(t),getMonthName:t=>I.format(t),getMonthNames:()=>{const t=[],m=new Date(2024,0,15);for(let i=0;i<12;i++)m.setMonth(i),t.push(I.format(m));return t},getWeekdayName:t=>L.format(t),getWeekdayNames:()=>{const t=[],m=new Date(2024,0,7);for(let i=0;i<7;i++)m.setDate(7+i),t.push(L.format(m));return t},parseParts:t=>{var l,c,D,S;const i=new Intl.DateTimeFormat(r,{calendar:e,year:"numeric",month:"numeric",day:"numeric",era:"short"}).formatToParts(t);return{calendar:e,year:parseInt(((l=i.find(g=>g.type==="year"))==null?void 0:l.value)||"0",10),month:parseInt(((c=i.find(g=>g.type==="month"))==null?void 0:c.value)||"0",10),day:parseInt(((D=i.find(g=>g.type==="day"))==null?void 0:D.value)||"0",10),era:(S=i.find(g=>g.type==="era"))==null?void 0:S.value,gregorianDate:t}},getEraName:t=>{var l;return(l=new Intl.DateTimeFormat(r,{calendar:e,era:"long"}).formatToParts(t).find(c=>c.type==="era"))==null?void 0:l.value}}}function N(a,e,n="en"){return E(n,e).parseParts(a)}function T(a,e="en"){return N(new Date,a,e)}const Y=["Muharram","Safar","Rabi' al-Awwal","Rabi' al-Thani","Jumada al-Awwal","Jumada al-Thani","Rajab","Sha'ban","Ramadan","Shawwal","Dhu al-Qi'dah","Dhu al-Hijjah"];function w(a){return(11*a+14)%30<11}function k(a,e){return e===12?w(a)?30:29:e%2===1?30:29}const F=["Tishrei","Cheshvan","Kislev","Tevet","Shevat","Adar","Nisan","Iyar","Sivan","Tammuz","Av","Elul"],j=["Tishrei","Cheshvan","Kislev","Tevet","Shevat","Adar I","Adar II","Nisan","Iyar","Sivan","Tammuz","Av","Elul"];function _(a){return(7*a+1)%19<7}const h=[{name:"Meiji",kanji:"明治",startDate:new Date(1868,9,23)},{name:"Taisho",kanji:"大正",startDate:new Date(1912,6,30)},{name:"Showa",kanji:"昭和",startDate:new Date(1926,11,25)},{name:"Heisei",kanji:"平成",startDate:new Date(1989,0,8)},{name:"Reiwa",kanji:"令和",startDate:new Date(2019,4,1)}];function A(a){for(let e=h.length-1;e>=0;e--)if(a>=h[e].startDate)return h[e];return null}function O(a){const e=A(a);return e?a.getFullYear()-e.startDate.getFullYear()+1:null}const P=["Farvardin","Ordibehesht","Khordad","Tir","Mordad","Shahrivar","Mehr","Aban","Azar","Dey","Bahman","Esfand"];function W(a){return((a-474)%2820+2820)%2820*682%2816<682}const b=["Rat","Ox","Tiger","Rabbit","Dragon","Snake","Horse","Goat","Monkey","Rooster","Dog","Pig"];function J(a){return b[(a-4)%12]}const v=["Jia","Yi","Bing","Ding","Wu","Ji","Geng","Xin","Ren","Gui"];function z(a){return v[(a-4)%10]}function B(a,e,n){const r=e||p[a],s=f.useMemo(()=>E(a,r,n),[a,r,n]),u=f.useMemo(()=>d[r],[r]),y=f.useMemo(()=>T(r,a),[r,a]);return{calendar:r,info:u,current:y,format:s.format,formatWithEra:s.formatWithEra,getMonthName:s.getMonthName,getMonthNames:s.getMonthNames,getWeekdayName:s.getWeekdayName,getWeekdayNames:s.getWeekdayNames,parseParts:s.parseParts,getEraName:s.getEraName,toCalendar:o=>N(o,r,a)}}function q(){return Object.keys(d)}function G(a,e="en"){const n={...d[a]};try{const r=C.getLocaleTag(e),u=new Intl.DisplayNames([r],{type:"calendar"}).of(a);u&&(n.displayName=u)}catch{}return n}function Z(a){const e=p[a],n=new Set([e]);for(const[r,s]of Object.entries(d))s.associatedLanguages.includes(a)&&n.add(r);return n.add("gregory"),Array.from(n)}exports.CALENDAR_INFO=d;exports.CELESTIAL_STEMS=v;exports.CHINESE_ZODIAC=b;exports.DEFAULT_CALENDAR=p;exports.HEBREW_MONTHS=F;exports.HEBREW_MONTHS_LEAP=j;exports.HIJRI_MONTHS=Y;exports.JAPANESE_ERAS=h;exports.PERSIAN_MONTHS=P;exports.createCalendarFormatter=E;exports.getAvailableCalendars=q;exports.getCalendarInfo=G;exports.getCelestialStem=z;exports.getChineseZodiac=J;exports.getCurrentCalendarDate=T;exports.getHijriMonthDays=k;exports.getJapaneseEra=A;exports.getJapaneseYear=O;exports.getRecommendedCalendars=Z;exports.isHebrewLeapYear=_;exports.isHijriLeapYear=w;exports.isPersianLeapYear=W;exports.toCalendar=N;exports.useCalendar=B;