@lwrjs/label-module-provider 0.11.0-alpha.9 → 0.11.1

package/build/cjs/index.cjs

@@ -28,6 +28,7 @@ __export(exports, {
 });
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
 var import_utils = __toModule(require("./utils.cjs"));
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var DEFAULT_DIR = [
   {
     dir: "$rootDir/src/labels",
@@ -35,13 +36,18 @@ var DEFAULT_DIR = [
   }
 ];
 var LabelModuleProvider = class {
-  constructor({provideDefault = false, labelDirs = DEFAULT_DIR}, {config, runtimeEnvironment: {defaultLocale, lwrVersion}}) {
+  constructor({provideDefault = false, labelDirs = DEFAULT_DIR}, {config, runtimeEnvironment: {lwrVersion}}) {
     this.name = "label-module-provider";
     this.labelDirs = [];
     this.labelJsonCache = new Map();
     this.version = lwrVersion;
-    this.defaultLocale = defaultLocale;
+    this.defaultLocale = config.i18n.defaultLocale;
     this.provideDefault = provideDefault;
+    this.i18n = config.i18n;
+    this.useI18nFallbacks = !!this.i18n.locales.find((f) => f.fallback);
+    if (!this.useI18nFallbacks && labelDirs.length > 1) {
+      import_diagnostics.logger.warn(`[label-module-provider] You are using the label provider with a deprecated fallback strategy.  Please migrate to the new i18n app-level configuration.`);
+    }
     const {rootDir, contentDir, layoutsDir} = config;
     labelDirs.forEach((config2) => {
       const normalizedDir = (0, import_shared_utils.normalizeResourcePath)(config2.dir, {
@@ -56,29 +62,40 @@ var LabelModuleProvider = class {
       });
     });
   }
-  async getLabelInfo(specifier, locale) {
+  async getLabelInfo(specifier, initialLocale) {
     const labelInfo = (0, import_utils.parseSpecifier)(this.labelDirs, specifier);
     if (!labelInfo) {
       return void 0;
     }
+    let rawValue;
+    if (this.useI18nFallbacks) {
+      rawValue = await (0, import_shared_utils.walkLocaleFallbacks)(initialLocale, this.i18n, async (locale) => {
+        return this.getLabelInfoForLocale(labelInfo, locale, false);
+      });
+    } else {
+      rawValue = this.getLabelInfoForLocale(labelInfo, initialLocale, true);
+    }
+    const {labelReference} = labelInfo;
+    const labelValue = !rawValue && this.provideDefault ? labelReference : rawValue;
+    return labelValue ? {...labelInfo, labelValue} : void 0;
+  }
+  getLabelInfoForLocale(labelInfo, locale, legacyFallbacks) {
     const {dir, labelReference} = labelInfo;
     const cacheKey = `${dir}|${locale}`;
     let labelJson = {};
     if (this.labelJsonCache.has(cacheKey)) {
       labelJson = this.labelJsonCache.get(cacheKey);
     } else {
-      let fsLabels = (0, import_utils.getLabels)(dir, locale);
-      if (!fsLabels && locale !== this.defaultLocale) {
-        fsLabels = (0, import_utils.getLabels)(dir, this.defaultLocale);
+      let fsLabels = (0, import_utils.getLabels)(dir, locale, legacyFallbacks);
+      if (legacyFallbacks && !fsLabels && locale !== this.defaultLocale) {
+        fsLabels = (0, import_utils.getLabels)(dir, this.defaultLocale, legacyFallbacks);
       }
       labelJson = fsLabels || labelJson;
       this.labelJsonCache.set(cacheKey, labelJson);
     }
     const [namespace, labelName] = labelReference.split(".");
     const namespacedLabels = labelJson[namespace] || {};
-    const rawValue = namespacedLabels[labelName] || labelJson[labelReference];
-    const labelValue = !rawValue && this.provideDefault ? labelReference : rawValue;
-    return labelValue ? {...labelInfo, labelValue} : void 0;
+    return namespacedLabels[labelName] || labelJson[labelReference];
   }
   async getModuleEntry({specifier}, runtimeParams = {}) {
     const locale = runtimeParams.locale && runtimeParams.locale !== "*" ? runtimeParams.locale : this.defaultLocale;

package/build/cjs/utils.cjs

@@ -33,6 +33,7 @@ var import_fs = __toModule(require("fs"));
 var import_path = __toModule(require("path"));
 var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_validation = __toModule(require("./validation.cjs"));
+var import_diagnostics2 = __toModule(require("@lwrjs/diagnostics"));
 function isValidLocaleFormat(locale) {
   return /^[A-Za-z]{2}([_-][A-Za-z]{2})?$/.test(locale);
 }
@@ -46,13 +47,13 @@ function parseSpecifier(allDirs, specifier) {
   const fileType = (file ? (0, import_path.extname)(file) : ".js").substr(1);
   return {labelReference, fileType, ...dirConfig};
 }
-function getLabels(labelDir, locale) {
+function getLabels(labelDir, locale, legacyFallbacks) {
   const localePath = `${labelDir}/${locale}.json`;
   try {
     if ((0, import_fs.existsSync)(localePath)) {
       return (0, import_validation.validateAndParse)(localePath);
     }
-    if (locale.length > 2) {
+    if (legacyFallbacks && locale.length > 2) {
       const lang = locale.substr(0, 2);
       const country = locale.substr(3);
       const altLocale = locale[2] === "-" ? `${lang}_${country}` : `${lang}-${country}`;
@@ -72,7 +73,7 @@ function getLabels(labelDir, locale) {
         description: import_diagnostics.descriptions.UNRESOLVABLE.LABEL_MODULE(localePath, e.message)
       }, import_diagnostics.LwrUnresolvableError);
     }
-    console.error(diagnosticError);
+    import_diagnostics2.logger.error(diagnosticError);
   }
   return void 0;
 }

package/build/es/index.d.ts

@@ -1,4 +1,4 @@
-import type { AbstractModuleId, ModuleCompiled, ModuleEntry, ModuleProvider, ProviderContext, RuntimeParams } from '@lwrjs/types';
+import type { AbstractModuleId, I18NConfig, ModuleCompiled, ModuleEntry, ModuleProvider, ProviderContext, RuntimeParams } from '@lwrjs/types';
 import { LabelDirConfig, LabelProviderOptions } from './utils.js';
 export default class LabelModuleProvider implements ModuleProvider {
     name: string;
@@ -6,9 +6,12 @@ export default class LabelModuleProvider implements ModuleProvider {
     defaultLocale: string;
     provideDefault: boolean;
     labelDirs: LabelDirConfig[];
+    i18n: I18NConfig;
+    useI18nFallbacks: boolean;
     private labelJsonCache;
-    constructor({ provideDefault, labelDirs }: LabelProviderOptions, { config, runtimeEnvironment: { defaultLocale, lwrVersion } }: ProviderContext);
+    constructor({ provideDefault, labelDirs }: LabelProviderOptions, { config, runtimeEnvironment: { lwrVersion } }: ProviderContext);
     private getLabelInfo;
+    private getLabelInfoForLocale;
     getModuleEntry({ specifier }: AbstractModuleId, runtimeParams?: RuntimeParams): Promise<ModuleEntry | undefined>;
     getModule({ specifier, namespace, name }: AbstractModuleId, runtimeParams?: RuntimeParams): Promise<ModuleCompiled | undefined>;
 }

package/build/es/index.js

@@ -1,5 +1,6 @@
-import { hashContent, normalizeResourcePath } from '@lwrjs/shared-utils';
-import { getLabels, generateModule, isValidLocaleFormat, parseSpecifier, } from './utils.js';
+import { hashContent, normalizeResourcePath, walkLocaleFallbacks } from '@lwrjs/shared-utils';
+import { generateModule, isValidLocaleFormat, parseSpecifier, getLabels, } from './utils.js';
+import { logger } from '@lwrjs/diagnostics';
 const DEFAULT_DIR = [
     {
         dir: '$rootDir/src/labels',
@@ -7,13 +8,18 @@ const DEFAULT_DIR = [
     },
 ];
 export default class LabelModuleProvider {
-    constructor({ provideDefault = false, labelDirs = DEFAULT_DIR }, { config, runtimeEnvironment: { defaultLocale, lwrVersion } }) {
+    constructor({ provideDefault = false, labelDirs = DEFAULT_DIR }, { config, runtimeEnvironment: { lwrVersion } }) {
         this.name = 'label-module-provider';
         this.labelDirs = [];
         this.labelJsonCache = new Map(); // TODO: file watcher
         this.version = lwrVersion;
-        this.defaultLocale = defaultLocale;
+        this.defaultLocale = config.i18n.defaultLocale;
         this.provideDefault = provideDefault;
+        this.i18n = config.i18n;
+        this.useI18nFallbacks = !!this.i18n.locales.find((f) => f.fallback);
+        if (!this.useI18nFallbacks && labelDirs.length > 1) {
+            logger.warn(`[label-module-provider] You are using the label provider with a deprecated fallback strategy.  Please migrate to the new i18n app-level configuration.`);
+        }
         // normalize the label directories
         const { rootDir, contentDir, layoutsDir } = config;
         labelDirs.forEach((config) => {
@@ -30,13 +36,30 @@ export default class LabelModuleProvider {
             });
         });
     }
-    async getLabelInfo(specifier, locale) {
+    async getLabelInfo(specifier, initialLocale) {
         // Check if this provider handles given specifier package/prefix
         // Modules handled by this provider have specifiers in this form: "{package}/{labelReference}"
         const labelInfo = parseSpecifier(this.labelDirs, specifier);
         if (!labelInfo) {
             return undefined;
         }
+        // If the app has defined any fallbacks in the config.  Assume this is the fallback precedence we should follow.
+        let rawValue;
+        if (this.useI18nFallbacks) {
+            rawValue = await walkLocaleFallbacks(initialLocale, this.i18n, async (locale) => {
+                return this.getLabelInfoForLocale(labelInfo, locale, false);
+            });
+        }
+        // Other wise use the default fallbacks for backward compatibility
+        else {
+            rawValue = this.getLabelInfoForLocale(labelInfo, initialLocale, true);
+        }
+        // If provideDefault is on, and the label is missing, return the label reference/key
+        const { labelReference } = labelInfo;
+        const labelValue = !rawValue && this.provideDefault ? labelReference : rawValue;
+        return labelValue ? { ...labelInfo, labelValue: labelValue } : undefined;
+    }
+    getLabelInfoForLocale(labelInfo, locale, legacyFallbacks) {
         const { dir, labelReference } = labelInfo;
         // Fetch the label JSON from the cache or file system
         const cacheKey = `${dir}|${locale}`;
@@ -47,10 +70,10 @@ export default class LabelModuleProvider {
         }
         else {
             // Cache miss, read from fs
-            let fsLabels = getLabels(dir, locale);
+            let fsLabels = getLabels(dir, locale, legacyFallbacks);
             // Fallback to default locale
-            if (!fsLabels && locale !== this.defaultLocale) {
-                fsLabels = getLabels(dir, this.defaultLocale);
+            if (legacyFallbacks && !fsLabels && locale !== this.defaultLocale) {
+                fsLabels = getLabels(dir, this.defaultLocale, legacyFallbacks);
             }
             // Set cache
             labelJson = fsLabels || labelJson;
@@ -61,9 +84,7 @@ export default class LabelModuleProvider {
         // If provideDefault is on, and the label is missing, return the label reference/key
         const [namespace, labelName] = labelReference.split('.');
         const namespacedLabels = (labelJson[namespace] || {});
-        const rawValue = namespacedLabels[labelName] || labelJson[labelReference]; // nested or flat structure
-        const labelValue = !rawValue && this.provideDefault ? labelReference : rawValue;
-        return labelValue ? { ...labelInfo, labelValue: labelValue } : undefined;
+        return namespacedLabels[labelName] || labelJson[labelReference]; // nested or flat structure
     }
     async getModuleEntry({ specifier }, runtimeParams = {}) {
         const locale = (runtimeParams.locale && runtimeParams.locale !== '*' ? runtimeParams.locale : this.defaultLocale);

package/build/es/utils.d.ts

@@ -6,14 +6,14 @@ export interface LabelProviderOptions {
     provideDefault: boolean;
     labelDirs: LabelDirConfig[];
 }
-interface LabelKeyInfo extends LabelDirConfig {
+export interface LabelKeyInfo extends LabelDirConfig {
     labelReference: string;
     fileType: string;
 }
 export interface LabelInfo extends LabelKeyInfo {
     labelValue: string;
 }
-type LabelEntry = {
+export type LabelEntry = {
     [key: string]: string;
 };
 export type LabelMap = {
@@ -45,8 +45,9 @@ export declare function parseSpecifier(allDirs: LabelDirConfig[], specifier: str
  *
  * @param labelDir - The directory which contains the label JSON files
  * @param locale - The locale to retrieve
+ * @param legacyFallbacks - Use the legacy fallback logic
  */
-export declare function getLabels(labelDir: string, locale: string): LabelMap | undefined;
+export declare function getLabels(labelDir: string, locale: string, legacyFallbacks: boolean): LabelMap | undefined;
 /**
  * Generate a module string which fulfills a label request
  *
@@ -54,5 +55,4 @@ export declare function getLabels(labelDir: string, locale: string): LabelMap |
  * @param fileType - The module file type: html, css or js
  */
 export declare function generateModule(label: string): string;
-export {};
 //# sourceMappingURL=utils.d.ts.map

package/build/es/utils.js

@@ -2,6 +2,7 @@ import { existsSync } from 'fs';
 import { extname } from 'path';
 import { createSingleDiagnosticError, descriptions, LwrUnresolvableError } from '@lwrjs/diagnostics';
 import { validateAndParse } from './validation.js';
+import { logger } from '@lwrjs/diagnostics';
 /**
  * Validate a locale string against these rules:
  *      - first 2 characters are a language code
@@ -42,8 +43,9 @@ export function parseSpecifier(allDirs, specifier) {
  *
  * @param labelDir - The directory which contains the label JSON files
  * @param locale - The locale to retrieve
+ * @param legacyFallbacks - Use the legacy fallback logic
  */
-export function getLabels(labelDir, locale) {
+export function getLabels(labelDir, locale, legacyFallbacks) {
     // Check for locale JSON file (eg: en_US.json)
     const localePath = `${labelDir}/${locale}.json`;
     try {
@@ -51,7 +53,7 @@ export function getLabels(labelDir, locale) {
             return validateAndParse(localePath);
         }
         // If the locale contains a country code, try some fallbacks
-        if (locale.length > 2) {
+        if (legacyFallbacks && locale.length > 2) {
             const lang = locale.substr(0, 2);
             const country = locale.substr(3);
             // Check for a different language/country separator (_ vs -)
@@ -74,7 +76,7 @@ export function getLabels(labelDir, locale) {
                 description: descriptions.UNRESOLVABLE.LABEL_MODULE(localePath, e.message),
             }, LwrUnresolvableError);
         }
-        console.error(diagnosticError);
+        logger.error(diagnosticError);
     }
     return undefined;
 }

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.11.0-alpha.9",
+    "version": "0.11.1",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -30,15 +30,15 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "@lwrjs/diagnostics": "0.11.0-alpha.9",
-        "@lwrjs/shared-utils": "0.11.0-alpha.9",
+        "@lwrjs/diagnostics": "0.11.1",
+        "@lwrjs/shared-utils": "0.11.1",
         "ajv": "6.12.6"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.11.0-alpha.9"
+        "@lwrjs/types": "0.11.1"
     },
     "engines": {
         "node": ">=16.0.0"
     },
-    "gitHead": "bc50e3f828be56ebdd2f8206cafe8158ab722470"
+    "gitHead": "b7c40fdcd86635dd4e368c0a2e91c5d3374c0fcf"
 }