@vaadin/hilla-react-i18n 24.4.0-alpha13 → 24.4.0-alpha14

package/backend.d.ts

@@ -1,8 +1,8 @@
-import type { Translations } from './types.js';
+import type { TranslationsResult } from './types.js';
 export interface I18nBackend {
-    loadTranslations(language: string): Promise<Translations>;
+    loadTranslations(language: string): Promise<TranslationsResult>;
 }
 export declare class DefaultBackend implements I18nBackend {
-    loadTranslations(language: string): Promise<Translations>;
+    loadTranslations(language: string): Promise<TranslationsResult>;
 }
 //# sourceMappingURL=backend.d.ts.map

package/backend.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,WAAW,WAAW;IAC1B,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC3D;AAED,qBAAa,cAAe,YAAW,WAAW;IAC1C,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAShE"}
+{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAgB,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEnE,MAAM,WAAW,WAAW;IAC1B,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACjE;AAED,qBAAa,cAAe,YAAW,WAAW;IAC1C,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAYtE"}

package/backend.js

@@ -1,12 +1,15 @@
 class DefaultBackend {
   async loadTranslations(language) {
-    const url = `./?v-r=i18n&langtag=${language}`;
-    return fetch(url).then(async (response) => {
-      if (response.status === 200) {
-        return response.json();
-      }
-      return Promise.reject(new Error(`Failed to load translations for language: ${language}`));
-    });
+    const response = await fetch(`./?v-r=i18n&langtag=${language}`);
+    if (!response.ok) {
+      throw new Error("Failed fetching translations.");
+    }
+    const retrievedLocale = response.headers.get("X-Vaadin-Retrieved-Locale");
+    const translations = await response.json();
+    return {
+      translations,
+      resolvedLanguage: retrievedLocale ?? void 0
+    };
   }
 }
 export {

package/backend.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["src/backend.ts"],
-  "sourcesContent": ["import type { Translations } from './types.js';\n\nexport interface I18nBackend {\n  loadTranslations(language: string): Promise<Translations>;\n}\n\nexport class DefaultBackend implements I18nBackend {\n  async loadTranslations(language: string): Promise<Translations> {\n    const url = `./?v-r=i18n&langtag=${language}`;\n    return fetch(url).then(async (response) => {\n      if (response.status === 200) {\n        return response.json();\n      }\n      return Promise.reject(new Error(`Failed to load translations for language: ${language}`));\n    });\n  }\n}\n"],
-  "mappings": "AAMO,MAAM,eAAsC;AAAA,EACjD,MAAM,iBAAiB,UAAyC;AAC9D,UAAM,MAAM,uBAAuB,QAAQ;AAC3C,WAAO,MAAM,GAAG,EAAE,KAAK,OAAO,aAAa;AACzC,UAAI,SAAS,WAAW,KAAK;AAC3B,eAAO,SAAS,KAAK;AAAA,MACvB;AACA,aAAO,QAAQ,OAAO,IAAI,MAAM,6CAA6C,QAAQ,EAAE,CAAC;AAAA,IAC1F,CAAC;AAAA,EACH;AACF;",
+  "sourcesContent": ["import type { Translations, TranslationsResult } from './types.js';\n\nexport interface I18nBackend {\n  loadTranslations(language: string): Promise<TranslationsResult>;\n}\n\nexport class DefaultBackend implements I18nBackend {\n  async loadTranslations(language: string): Promise<TranslationsResult> {\n    const response = await fetch(`./?v-r=i18n&langtag=${language}`);\n    if (!response.ok) {\n      throw new Error('Failed fetching translations.');\n    }\n    const retrievedLocale = response.headers.get('X-Vaadin-Retrieved-Locale');\n    const translations: Translations = await response.json();\n    return {\n      translations,\n      resolvedLanguage: retrievedLocale ?? undefined,\n    };\n  }\n}\n"],
+  "mappings": "AAMO,MAAM,eAAsC;AAAA,EACjD,MAAM,iBAAiB,UAA+C;AACpE,UAAM,WAAW,MAAM,MAAM,uBAAuB,QAAQ,EAAE;AAC9D,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACjD;AACA,UAAM,kBAAkB,SAAS,QAAQ,IAAI,2BAA2B;AACxE,UAAM,eAA6B,MAAM,SAAS,KAAK;AACvD,WAAO;AAAA,MACL;AAAA,MACA,kBAAkB,mBAAmB;AAAA,IACvC;AAAA,EACF;AACF;",
   "names": []
 }

package/index.d.ts

@@ -3,10 +3,10 @@ import type { I18nOptions } from './types.js';
 export declare class I18n {
     #private;
     get language(): Signal<string | undefined>;
+    get resolvedLanguage(): Signal<string | undefined>;
     configure(options?: I18nOptions): Promise<void>;
     setLanguage(newLanguage: string): Promise<void>;
     private updateLanguage;
-    private loadTranslations;
     translate(key: string): string;
 }
 export declare const i18n: I18n;

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAGzE,OAAO,KAAK,EAAE,WAAW,EAAgB,MAAM,YAAY,CAAC;AAgB5D,qBAAa,IAAI;;IAMf,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,CAEzC;IAEK,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/C,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAIvC,cAAc;YAmBd,gBAAgB;IAU9B,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAG/B;AAED,eAAO,MAAM,IAAI,MAAa,CAAC;AAE/B,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAGzE,OAAO,KAAK,EAAE,WAAW,EAAoC,MAAM,YAAY,CAAC;AAgBhF,qBAAa,IAAI;;IAOf,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,CAEzC;IAED,IAAI,gBAAgB,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,CAEjD;IAEK,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/C,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAIvC,cAAc;IA2B5B,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAG/B;AAED,eAAO,MAAM,IAAI,MAAa,CAAC;AAE/B,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C"}

package/index.js

@@ -15,9 +15,13 @@ class I18n {
   #backend = new DefaultBackend();
   #language = signal(void 0);
   #translations = signal({});
+  #resolvedLanguage = signal(void 0);
   get language() {
     return this.#language;
   }
+  get resolvedLanguage() {
+    return this.#resolvedLanguage;
+  }
   async configure(options) {
     const initialLanguage = determineInitialLanguage(options);
     await this.updateLanguage(initialLanguage);
@@ -29,10 +33,17 @@ class I18n {
     if (this.#language.value === newLanguage) {
       return;
     }
-    const newTranslations = await this.loadTranslations(newLanguage);
+    let translationsResult;
+    try {
+      translationsResult = await this.#backend.loadTranslations(newLanguage);
+    } catch (e) {
+      console.error(`Failed to load translations for language: ${newLanguage}`, e);
+      return;
+    }
     batch(() => {
-      this.#translations.value = newTranslations;
+      this.#translations.value = translationsResult.translations;
       this.#language.value = newLanguage;
+      this.#resolvedLanguage.value = translationsResult.resolvedLanguage;
       if (updateSettings) {
         updateLanguageSettings({
           language: newLanguage
@@ -40,14 +51,6 @@ class I18n {
       }
     });
   }
-  async loadTranslations(newLanguage) {
-    try {
-      return await this.#backend.loadTranslations(newLanguage);
-    } catch (e) {
-      console.error(`Failed to load translations for language: ${newLanguage}`, e);
-      return {};
-    }
-  }
   translate(key) {
     return this.#translations.value[key] || key;
   }

package/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["src/index.ts"],
-  "sourcesContent": ["import { batch, signal, type Signal } from '@vaadin/hilla-react-signals';\nimport { DefaultBackend, type I18nBackend } from './backend.js';\nimport { getLanguageSettings, updateLanguageSettings } from './settings.js';\nimport type { I18nOptions, Translations } from './types.js';\n\nfunction determineInitialLanguage(options?: I18nOptions): string {\n  // Use explicitly configured language if defined\n  if (options?.language) {\n    return options.language;\n  }\n  // Use last used language as fallback\n  const settings = getLanguageSettings();\n  if (settings?.language) {\n    return settings.language;\n  }\n  // Otherwise use browser language\n  return navigator.language;\n}\n\nexport class I18n {\n  readonly #backend: I18nBackend = new DefaultBackend();\n\n  readonly #language: Signal<string | undefined> = signal(undefined);\n  readonly #translations: Signal<Translations> = signal({});\n\n  get language(): Signal<string | undefined> {\n    return this.#language;\n  }\n\n  async configure(options?: I18nOptions): Promise<void> {\n    const initialLanguage = determineInitialLanguage(options);\n    await this.updateLanguage(initialLanguage);\n  }\n\n  async setLanguage(newLanguage: string): Promise<void> {\n    await this.updateLanguage(newLanguage, true);\n  }\n\n  private async updateLanguage(newLanguage: string, updateSettings = false) {\n    if (this.#language.value === newLanguage) {\n      return;\n    }\n\n    const newTranslations = await this.loadTranslations(newLanguage);\n    // Update all signals together to avoid triggering side effects multiple times\n    batch(() => {\n      this.#translations.value = newTranslations;\n      this.#language.value = newLanguage;\n\n      if (updateSettings) {\n        updateLanguageSettings({\n          language: newLanguage,\n        });\n      }\n    });\n  }\n\n  private async loadTranslations(newLanguage: string) {\n    try {\n      return await this.#backend.loadTranslations(newLanguage);\n    } catch (e) {\n      // TODO proper error handling, maybe allow developer to hook into this\n      console.error(`Failed to load translations for language: ${newLanguage}`, e);\n      return {};\n    }\n  }\n\n  translate(key: string): string {\n    return this.#translations.value[key] || key;\n  }\n}\n\nexport const i18n = new I18n();\n\nexport function translate(key: string): string {\n  return i18n.translate(key);\n}\n"],
-  "mappings": "AAAA,SAAS,OAAO,cAA2B;AAC3C,SAAS,sBAAwC;AACjD,SAAS,qBAAqB,8BAA8B;AAG5D,SAAS,yBAAyB,SAA+B;AAE/D,MAAI,SAAS,UAAU;AACrB,WAAO,QAAQ;AAAA,EACjB;AAEA,QAAM,WAAW,oBAAoB;AACrC,MAAI,UAAU,UAAU;AACtB,WAAO,SAAS;AAAA,EAClB;AAEA,SAAO,UAAU;AACnB;AAEO,MAAM,KAAK;AAAA,EACP,WAAwB,IAAI,eAAe;AAAA,EAE3C,YAAwC,OAAO,MAAS;AAAA,EACxD,gBAAsC,OAAO,CAAC,CAAC;AAAA,EAExD,IAAI,WAAuC;AACzC,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,UAAU,SAAsC;AACpD,UAAM,kBAAkB,yBAAyB,OAAO;AACxD,UAAM,KAAK,eAAe,eAAe;AAAA,EAC3C;AAAA,EAEA,MAAM,YAAY,aAAoC;AACpD,UAAM,KAAK,eAAe,aAAa,IAAI;AAAA,EAC7C;AAAA,EAEA,MAAc,eAAe,aAAqB,iBAAiB,OAAO;AACxE,QAAI,KAAK,UAAU,UAAU,aAAa;AACxC;AAAA,IACF;AAEA,UAAM,kBAAkB,MAAM,KAAK,iBAAiB,WAAW;AAE/D,UAAM,MAAM;AACV,WAAK,cAAc,QAAQ;AAC3B,WAAK,UAAU,QAAQ;AAEvB,UAAI,gBAAgB;AAClB,+BAAuB;AAAA,UACrB,UAAU;AAAA,QACZ,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,iBAAiB,aAAqB;AAClD,QAAI;AACF,aAAO,MAAM,KAAK,SAAS,iBAAiB,WAAW;AAAA,IACzD,SAAS,GAAG;AAEV,cAAQ,MAAM,6CAA6C,WAAW,IAAI,CAAC;AAC3E,aAAO,CAAC;AAAA,IACV;AAAA,EACF;AAAA,EAEA,UAAU,KAAqB;AAC7B,WAAO,KAAK,cAAc,MAAM,GAAG,KAAK;AAAA,EAC1C;AACF;AAEO,MAAM,OAAO,IAAI,KAAK;AAEtB,SAAS,UAAU,KAAqB;AAC7C,SAAO,KAAK,UAAU,GAAG;AAC3B;",
+  "sourcesContent": ["import { batch, signal, type Signal } from '@vaadin/hilla-react-signals';\nimport { DefaultBackend, type I18nBackend } from './backend.js';\nimport { getLanguageSettings, updateLanguageSettings } from './settings.js';\nimport type { I18nOptions, Translations, TranslationsResult } from './types.js';\n\nfunction determineInitialLanguage(options?: I18nOptions): string {\n  // Use explicitly configured language if defined\n  if (options?.language) {\n    return options.language;\n  }\n  // Use last used language as fallback\n  const settings = getLanguageSettings();\n  if (settings?.language) {\n    return settings.language;\n  }\n  // Otherwise use browser language\n  return navigator.language;\n}\n\nexport class I18n {\n  readonly #backend: I18nBackend = new DefaultBackend();\n\n  readonly #language: Signal<string | undefined> = signal(undefined);\n  readonly #translations: Signal<Translations> = signal({});\n  readonly #resolvedLanguage: Signal<string | undefined> = signal(undefined);\n\n  get language(): Signal<string | undefined> {\n    return this.#language;\n  }\n\n  get resolvedLanguage(): Signal<string | undefined> {\n    return this.#resolvedLanguage;\n  }\n\n  async configure(options?: I18nOptions): Promise<void> {\n    const initialLanguage = determineInitialLanguage(options);\n    await this.updateLanguage(initialLanguage);\n  }\n\n  async setLanguage(newLanguage: string): Promise<void> {\n    await this.updateLanguage(newLanguage, true);\n  }\n\n  private async updateLanguage(newLanguage: string, updateSettings = false) {\n    if (this.#language.value === newLanguage) {\n      return;\n    }\n\n    let translationsResult: TranslationsResult;\n    try {\n      translationsResult = await this.#backend.loadTranslations(newLanguage);\n    } catch (e) {\n      console.error(`Failed to load translations for language: ${newLanguage}`, e);\n      return;\n    }\n\n    // Update all signals together to avoid triggering side effects multiple times\n    batch(() => {\n      this.#translations.value = translationsResult.translations;\n      this.#language.value = newLanguage;\n      this.#resolvedLanguage.value = translationsResult.resolvedLanguage;\n\n      if (updateSettings) {\n        updateLanguageSettings({\n          language: newLanguage,\n        });\n      }\n    });\n  }\n\n  translate(key: string): string {\n    return this.#translations.value[key] || key;\n  }\n}\n\nexport const i18n = new I18n();\n\nexport function translate(key: string): string {\n  return i18n.translate(key);\n}\n"],
+  "mappings": "AAAA,SAAS,OAAO,cAA2B;AAC3C,SAAS,sBAAwC;AACjD,SAAS,qBAAqB,8BAA8B;AAG5D,SAAS,yBAAyB,SAA+B;AAE/D,MAAI,SAAS,UAAU;AACrB,WAAO,QAAQ;AAAA,EACjB;AAEA,QAAM,WAAW,oBAAoB;AACrC,MAAI,UAAU,UAAU;AACtB,WAAO,SAAS;AAAA,EAClB;AAEA,SAAO,UAAU;AACnB;AAEO,MAAM,KAAK;AAAA,EACP,WAAwB,IAAI,eAAe;AAAA,EAE3C,YAAwC,OAAO,MAAS;AAAA,EACxD,gBAAsC,OAAO,CAAC,CAAC;AAAA,EAC/C,oBAAgD,OAAO,MAAS;AAAA,EAEzE,IAAI,WAAuC;AACzC,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,mBAA+C;AACjD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,UAAU,SAAsC;AACpD,UAAM,kBAAkB,yBAAyB,OAAO;AACxD,UAAM,KAAK,eAAe,eAAe;AAAA,EAC3C;AAAA,EAEA,MAAM,YAAY,aAAoC;AACpD,UAAM,KAAK,eAAe,aAAa,IAAI;AAAA,EAC7C;AAAA,EAEA,MAAc,eAAe,aAAqB,iBAAiB,OAAO;AACxE,QAAI,KAAK,UAAU,UAAU,aAAa;AACxC;AAAA,IACF;AAEA,QAAI;AACJ,QAAI;AACF,2BAAqB,MAAM,KAAK,SAAS,iBAAiB,WAAW;AAAA,IACvE,SAAS,GAAG;AACV,cAAQ,MAAM,6CAA6C,WAAW,IAAI,CAAC;AAC3E;AAAA,IACF;AAGA,UAAM,MAAM;AACV,WAAK,cAAc,QAAQ,mBAAmB;AAC9C,WAAK,UAAU,QAAQ;AACvB,WAAK,kBAAkB,QAAQ,mBAAmB;AAElD,UAAI,gBAAgB;AAClB,+BAAuB;AAAA,UACrB,UAAU;AAAA,QACZ,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,UAAU,KAAqB;AAC7B,WAAO,KAAK,cAAc,MAAM,GAAG,KAAK;AAAA,EAC1C;AACF;AAEO,MAAM,OAAO,IAAI,KAAK;AAEtB,SAAS,UAAU,KAAqB;AAC7C,SAAO,KAAK,UAAU,GAAG;AAC3B;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/hilla-react-i18n",
-  "version": "24.4.0-alpha13",
+  "version": "24.4.0-alpha14",
   "description": "Hilla I18n utils for React",
   "main": "index.js",
   "module": "index.js",
@@ -46,8 +46,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@vaadin/hilla-frontend": "24.4.0-alpha13",
-    "@vaadin/hilla-react-signals": "24.4.0-alpha13"
+    "@vaadin/hilla-frontend": "24.4.0-alpha14",
+    "@vaadin/hilla-react-signals": "24.4.0-alpha14"
   },
   "peerDependencies": {
     "react": "^18"

package/types.d.ts

@@ -1,4 +1,8 @@
 export type Translations = Record<string, string>;
+export type TranslationsResult = {
+    translations: Translations;
+    resolvedLanguage?: string;
+};
 export interface I18nOptions {
     language?: string;
 }

package/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,EAAE,YAAY,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}