@lwrjs/config 0.11.0-alpha.2 → 0.11.0-alpha.4

package/build/cjs/defaults.cjs

@@ -87,6 +87,14 @@ var SSR_VIEW_TRANSFORM_PLUGIN = "@lwrjs/lwc-ssr/viewTransformer";
 var DEFAULT_ASSET_PROVIDERS = ["@lwrjs/fs-asset-provider"];
 var DEFAULT_ASSET_TRANSFORM_PLUGINS = ["@lwrjs/asset-transformer"];
 var DEFAULT_URI_TRANSFORM_PLUGINS = [];
+var DEFAULT_I18N_CONFIG = {
+  defaultLocale: "en-US",
+  locales: [
+    {
+      id: "en-US"
+    }
+  ]
+};
 var DEFAULT_AMD_LOADER = "lwr/loader";
 var DEFAULT_AMD_LOADER_LEGACY = "lwr/loaderLegacy";
 var DEFAULT_ESM_LOADER = "lwr/esmLoader";
@@ -157,5 +165,6 @@ var DEFAULT_LWR_CONFIG = {
   bundleConfig: getDefaultBundleConfig(MODE),
   serverType: DEFAULT_SERVER_TYPE,
   locker: import_shared_utils.DEFAULT_LWR_LOCKER_CONFIG,
-  uriTransformers: DEFAULT_URI_TRANSFORM_PLUGINS
+  uriTransformers: DEFAULT_URI_TRANSFORM_PLUGINS,
+  i18n: DEFAULT_I18N_CONFIG
 };

package/build/cjs/runtime-config.cjs

@@ -38,7 +38,7 @@ var RUNTIME_CONFIGS = {
     compat: "0",
     debug: false,
     watchFiles: true,
-    defaultLocale: "en_US",
+    defaultLocale: "en-US",
     hmrEnabled: true,
     immutableAssets: false,
     env: {
@@ -52,7 +52,7 @@ var RUNTIME_CONFIGS = {
     compat: "0",
     debug: false,
     watchFiles: false,
-    defaultLocale: "en_US",
+    defaultLocale: "en-US",
     hmrEnabled: false,
     immutableAssets: true,
     env: {
@@ -66,7 +66,7 @@ var RUNTIME_CONFIGS = {
     compat: "1",
     debug: false,
     watchFiles: true,
-    defaultLocale: "en_US",
+    defaultLocale: "en-US",
     hmrEnabled: false,
     immutableAssets: false,
     env: {
@@ -80,7 +80,7 @@ var RUNTIME_CONFIGS = {
     compat: "1",
     debug: false,
     watchFiles: false,
-    defaultLocale: "en_US",
+    defaultLocale: "en-US",
     hmrEnabled: false,
     immutableAssets: true,
     env: {
@@ -96,8 +96,9 @@ function getServerModeConfig(serverMode) {
   return selectedMode;
 }
 function getRuntimeEnvironment(config) {
-  const {serverMode, lwrVersion, apiVersion, basePath, minify} = config;
+  const {serverMode, lwrVersion, apiVersion, basePath, i18n, minify} = config;
   const serverModeConfig = getServerModeConfig(config.serverMode);
+  const defaultLocale = i18n.defaultLocale;
   return {
     ...serverModeConfig,
     minify: minify !== null ? minify : serverModeConfig.minify,
@@ -105,6 +106,7 @@ function getRuntimeEnvironment(config) {
     serverMode,
     lwrVersion,
     apiVersion,
-    basePath
+    basePath,
+    defaultLocale
   };
 }

package/build/cjs/validation/app-config-context.cjs

@@ -29,6 +29,7 @@ __export(exports, {
   BASE_PATH_REGEX: () => BASE_PATH_REGEX,
   BOOTSTRAP_ATTRIBUTE_KEYS: () => BOOTSTRAP_ATTRIBUTE_KEYS,
   ERROR_ROUTE_ATTRIBUTE_KEYS: () => ERROR_ROUTE_ATTRIBUTE_KEYS,
+  I18N_ATTRIBUTE_KEYS: () => I18N_ATTRIBUTE_KEYS,
   LOCKER_ATTRIBUTE_KEYS: () => LOCKER_ATTRIBUTE_KEYS,
   ROOT_ATTRIBUTE_KEYS: () => ROOT_ATTRIBUTE_KEYS,
   ROUTE_ATTRIBUTE_KEYS: () => ROUTE_ATTRIBUTE_KEYS,
@@ -57,6 +58,7 @@ var ROOT_ATTRIBUTE_KEYS = createKeys("root", [
   "globalData",
   "globalDataDir",
   "hooks",
+  "i18n",
   "ignoreLwrConfigFile",
   "lwrConfigFile",
   "layoutsDir",
@@ -80,6 +82,7 @@ var ROOT_ATTRIBUTE_KEYS = createKeys("root", [
 var ASSET_DIR_ATTRIBUTE_KEYS = createKeys("assetDir", ["alias", "dir", "urlPath", "root"]);
 var ASSET_FILE_ATTRIBUTE_KEYS = createKeys("assetFile", ["alias", "file", "urlPath"]);
 var LOCKER_ATTRIBUTE_KEYS = createKeys("locker", ["enabled", "trustedComponents", "clientOnly"]);
+var I18N_ATTRIBUTE_KEYS = createKeys("i18n", ["defaultLocale", "locales"]);
 var ROUTE_ATTRIBUTE_KEYS = createKeys("routes", [
   "bootstrap",
   "subRoutes",
@@ -445,4 +448,12 @@ var ValidationContext = class {
       });
     }
   }
+  assertDefaultInLocales(node, defaultLocale, localesIds) {
+    if (!localesIds.includes(defaultLocale)) {
+      this.diagnostics.push({
+        description: import_diagnostics.descriptions.CONFIG_PARSER.DEFAULT_NOT_IN_LOCALES(defaultLocale, localesIds),
+        location: this.getLocationFromNode(node)
+      });
+    }
+  }
 };

package/build/cjs/validation/app-config.cjs

@@ -91,6 +91,23 @@ function validateRoutes(node, validationContext, preMerge) {
     }
   }
 }
+function validateI18NConfig(node, validationContext, preMerge) {
+  if (node) {
+    if (!preMerge) {
+      validationContext.assertIsObject(node, "i18n");
+    }
+    validationContext.assertIsObject(node, "i18n");
+    validationContext.assertValidKeys(node, "i18n", import_app_config_context.I18N_ATTRIBUTE_KEYS);
+    validationContext.assertRequiredKeys(node, "i18n", ["defaultLocale", "locales"]);
+    const locales = (0, import_jsonc_parser.findNodeAtLocation)(node, ["locales"]);
+    validationContext.assertNotEmptyArray(locales, "i18n.locales");
+    validationContext.assertUniqueIds([...locales?.children || []], "i18n.locales");
+    const defaultLocale = (0, import_jsonc_parser.findNodeAtLocation)(node, ["defaultLocale"]);
+    validationContext.assertNotEmptyString(defaultLocale, "i18n.defaultLocale");
+    const localeIds = locales?.children?.map((n) => (0, import_jsonc_parser.findNodeAtLocation)(n, ["id"])?.value) || [];
+    validationContext.assertDefaultInLocales(node, defaultLocale?.value, localeIds);
+  }
+}
 function validateBundleConfig(node, validationContext) {
   if (node) {
     validationContext.assertIsObject(node, "bundleConfig");
@@ -213,6 +230,7 @@ function validateRoot(node, validationContext, preMerge) {
   validateRouteHandlers((0, import_jsonc_parser.findNodeAtLocation)(node, ["routeHandlers"]), validationContext);
   validateAssets((0, import_jsonc_parser.findNodeAtLocation)(node, ["assets"]), validationContext, preMerge);
   validateLocker(lockerNode, validationContext);
+  validateI18NConfig((0, import_jsonc_parser.findNodeAtLocation)(node, ["i18n"]), validationContext, preMerge);
   validateBundleConfig(bundleConfigNode, validationContext);
   validationContext.assertClientLockerSSR(routes, lockerNode);
   validationContext.assertNotEmptyString((0, import_jsonc_parser.findNodeAtLocation)(node, ["apiVersion"]), "apiVersion");

package/build/es/defaults.js

@@ -47,6 +47,14 @@ export const SSR_VIEW_TRANSFORM_PLUGIN = '@lwrjs/lwc-ssr/viewTransformer';
 const DEFAULT_ASSET_PROVIDERS = ['@lwrjs/fs-asset-provider'];
 const DEFAULT_ASSET_TRANSFORM_PLUGINS = ['@lwrjs/asset-transformer'];
 const DEFAULT_URI_TRANSFORM_PLUGINS = [];
+const DEFAULT_I18N_CONFIG = {
+    defaultLocale: 'en-US',
+    locales: [
+        {
+            id: 'en-US',
+        },
+    ],
+};
 export const DEFAULT_AMD_LOADER = 'lwr/loader';
 export const DEFAULT_AMD_LOADER_LEGACY = 'lwr/loaderLegacy';
 export const DEFAULT_ESM_LOADER = 'lwr/esmLoader';
@@ -122,5 +130,6 @@ export const DEFAULT_LWR_CONFIG = {
     serverType: DEFAULT_SERVER_TYPE,
     locker: DEFAULT_LWR_LOCKER_CONFIG,
     uriTransformers: DEFAULT_URI_TRANSFORM_PLUGINS,
+    i18n: DEFAULT_I18N_CONFIG,
 };
 //# sourceMappingURL=defaults.js.map

package/build/es/runtime-config.js

@@ -8,7 +8,7 @@ export const RUNTIME_CONFIGS = {
         compat: '0',
         debug: false,
         watchFiles: true,
-        defaultLocale: 'en_US',
+        defaultLocale: 'en-US',
         hmrEnabled: true,
         immutableAssets: false,
         env: {
@@ -22,7 +22,7 @@ export const RUNTIME_CONFIGS = {
         compat: '0',
         debug: false,
         watchFiles: false,
-        defaultLocale: 'en_US',
+        defaultLocale: 'en-US',
         hmrEnabled: false,
         immutableAssets: true,
         env: {
@@ -36,7 +36,7 @@ export const RUNTIME_CONFIGS = {
         compat: '1',
         debug: false,
         watchFiles: true,
-        defaultLocale: 'en_US',
+        defaultLocale: 'en-US',
         hmrEnabled: false,
         immutableAssets: false,
         env: {
@@ -50,7 +50,7 @@ export const RUNTIME_CONFIGS = {
         compat: '1',
         debug: false,
         watchFiles: false,
-        defaultLocale: 'en_US',
+        defaultLocale: 'en-US',
         hmrEnabled: false,
         immutableAssets: true,
         env: {
@@ -80,8 +80,9 @@ export function getServerModeConfig(serverMode) {
  * @returns {RuntimeEnvironment} the complete runtime environment
  */
 export function getRuntimeEnvironment(config) {
-    const { serverMode, lwrVersion, apiVersion, basePath, minify } = config;
+    const { serverMode, lwrVersion, apiVersion, basePath, i18n, minify } = config;
     const serverModeConfig = getServerModeConfig(config.serverMode);
+    const defaultLocale = i18n.defaultLocale;
     return {
         ...serverModeConfig,
         minify: minify !== null ? minify : serverModeConfig.minify,
@@ -90,6 +91,7 @@ export function getRuntimeEnvironment(config) {
         lwrVersion,
         apiVersion,
         basePath,
+        defaultLocale,
     };
 }
 //# sourceMappingURL=runtime-config.js.map

package/build/es/validation/app-config-context.d.ts

@@ -1,4 +1,4 @@
-import type { AssetDirConfig, AssetFileConfig, LwrErrorRoute, LwrRoute, NormalizedLwrGlobalConfig, NormalizedLwrAppBootstrapConfig, LwrLockerConfig, RouteHandlersConfig, BundleConfig } from '@lwrjs/types';
+import type { AssetDirConfig, AssetFileConfig, LwrErrorRoute, LwrRoute, NormalizedLwrGlobalConfig, NormalizedLwrAppBootstrapConfig, LwrLockerConfig, RouteHandlersConfig, BundleConfig, I18NConfig } from '@lwrjs/types';
 import { Node } from 'jsonc-parser';
 import { Diagnostic } from '@lwrjs/diagnostics';
 type RequiredAssetDirConfig = Required<AssetDirConfig>;
@@ -6,6 +6,7 @@ type RequiredAssetFileConfig = Required<AssetFileConfig>;
 type RequiredLwrRoute = Required<LwrRoute>;
 type RequiredLwrErrorRoute = Required<LwrErrorRoute>;
 type RequiredLwrLockerConfig = Required<LwrLockerConfig>;
+type RequiredI18NConfig = Required<I18NConfig>;
 interface ConfigMap {
     root: NormalizedLwrGlobalConfig;
     assetDir: RequiredAssetDirConfig;
@@ -18,11 +19,13 @@ interface ConfigMap {
     bundleConfig: BundleConfig;
     'bundleConfig.external': BundleConfig;
     'bundleConfig.groups': BundleConfig;
+    i18n: RequiredI18NConfig;
 }
-export declare const ROOT_ATTRIBUTE_KEYS: ["amdLoader", "apiVersion", "assets", "assetProviders", "assetTransformers", "bundleConfig", "bundleProviders", "cacheDir", "contentDir", "environment", "errorRoutes", "esmLoader", "staticSiteGenerator", "globalData", "globalDataDir", "hooks", "ignoreLwrConfigFile", "lwrConfigFile", "layoutsDir", "locker", "lwc", "lwrVersion", "moduleProviders", "port", "basePath", "resourceProviders", "rootDir", "routeHandlers", "routes", "serverMode", "minify", "serverType", "uriTransformers", "viewProviders", "viewTransformers"];
+export declare const ROOT_ATTRIBUTE_KEYS: ["amdLoader", "apiVersion", "assets", "assetProviders", "assetTransformers", "bundleConfig", "bundleProviders", "cacheDir", "contentDir", "environment", "errorRoutes", "esmLoader", "staticSiteGenerator", "globalData", "globalDataDir", "hooks", "i18n", "ignoreLwrConfigFile", "lwrConfigFile", "layoutsDir", "locker", "lwc", "lwrVersion", "moduleProviders", "port", "basePath", "resourceProviders", "rootDir", "routeHandlers", "routes", "serverMode", "minify", "serverType", "uriTransformers", "viewProviders", "viewTransformers"];
 export declare const ASSET_DIR_ATTRIBUTE_KEYS: ["alias", "dir", "urlPath", "root"];
 export declare const ASSET_FILE_ATTRIBUTE_KEYS: ["alias", "file", "urlPath"];
 export declare const LOCKER_ATTRIBUTE_KEYS: ["enabled", "trustedComponents", "clientOnly"];
+export declare const I18N_ATTRIBUTE_KEYS: ["defaultLocale", "locales"];
 export declare const ROUTE_ATTRIBUTE_KEYS: ["bootstrap", "subRoutes", "contentTemplate", "id", "cache", "layoutTemplate", "method", "path", "rootComponent", "routeHandler", "properties"];
 export declare const ERROR_ROUTE_ATTRIBUTE_KEYS: ["bootstrap", "subRoutes", "contentTemplate", "id", "layoutTemplate", "rootComponent", "routeHandler", "status", "properties", "cache"];
 export declare const BOOTSTRAP_ATTRIBUTE_KEYS: ["autoBoot", "syntheticShadow", "workers", "services", "configAsSrc", "ssr", "mixedMode", "module", "preloadModules"];
@@ -57,6 +60,7 @@ export declare class ValidationContext {
     assertRequiredKeys(node: Node, property: string, requiredPropertyKeys: string[]): void;
     assertValidKeys<T extends keyof ConfigMap>(node: Node, property: T, validPropertyKeys: (keyof ConfigMap[T])[]): void;
     assertNoBundleConfigDupes(node: Node, dupes: string[]): void;
+    assertDefaultInLocales(node: Node, defaultLocale: string, localesIds: string[]): void;
 }
 export {};
 //# sourceMappingURL=app-config-context.d.ts.map

package/build/es/validation/app-config-context.js

@@ -23,6 +23,7 @@ export const ROOT_ATTRIBUTE_KEYS = createKeys('root', [
     'globalData',
     'globalDataDir',
     'hooks',
+    'i18n',
     'ignoreLwrConfigFile',
     'lwrConfigFile',
     'layoutsDir',
@@ -46,6 +47,7 @@ export const ROOT_ATTRIBUTE_KEYS = createKeys('root', [
 export const ASSET_DIR_ATTRIBUTE_KEYS = createKeys('assetDir', ['alias', 'dir', 'urlPath', 'root']);
 export const ASSET_FILE_ATTRIBUTE_KEYS = createKeys('assetFile', ['alias', 'file', 'urlPath']);
 export const LOCKER_ATTRIBUTE_KEYS = createKeys('locker', ['enabled', 'trustedComponents', 'clientOnly']);
+export const I18N_ATTRIBUTE_KEYS = createKeys('i18n', ['defaultLocale', 'locales']);
 export const ROUTE_ATTRIBUTE_KEYS = createKeys('routes', [
     'bootstrap',
     'subRoutes',
@@ -429,5 +431,13 @@ export class ValidationContext {
             });
         }
     }
+    assertDefaultInLocales(node, defaultLocale, localesIds) {
+        if (!localesIds.includes(defaultLocale)) {
+            this.diagnostics.push({
+                description: descriptions.CONFIG_PARSER.DEFAULT_NOT_IN_LOCALES(defaultLocale, localesIds),
+                location: this.getLocationFromNode(node),
+            });
+        }
+    }
 }
 //# sourceMappingURL=app-config-context.js.map

package/build/es/validation/app-config.js

@@ -1,6 +1,6 @@
 import { parseTree, printParseErrorCode, findNodeAtLocation as findNode, } from 'jsonc-parser';
 import { createSingleDiagnosticError, descriptions, LwrConfigValidationError } from '@lwrjs/diagnostics';
-import { ASSET_DIR_ATTRIBUTE_KEYS, ASSET_FILE_ATTRIBUTE_KEYS, BOOTSTRAP_ATTRIBUTE_KEYS, ERROR_ROUTE_ATTRIBUTE_KEYS, LOCKER_ATTRIBUTE_KEYS, ROOT_ATTRIBUTE_KEYS, ROUTE_ATTRIBUTE_KEYS, ValidationContext, } from './app-config-context.js';
+import { ASSET_DIR_ATTRIBUTE_KEYS, ASSET_FILE_ATTRIBUTE_KEYS, BOOTSTRAP_ATTRIBUTE_KEYS, ERROR_ROUTE_ATTRIBUTE_KEYS, I18N_ATTRIBUTE_KEYS, LOCKER_ATTRIBUTE_KEYS, ROOT_ATTRIBUTE_KEYS, ROUTE_ATTRIBUTE_KEYS, ValidationContext, } from './app-config-context.js';
 import { calculatePositionFromSource } from './helpers.js';
 import { DEFAULT_ESM_BUNDLE_EXCLUSIONS, DEFAULT_AMD_BUNDLE_EXCLUSIONS } from '../defaults.js';
 import { ConfigSpan, getTracer } from '@lwrjs/instrumentation';
@@ -96,6 +96,28 @@ function validateRoutes(node, validationContext, preMerge) {
         }
     }
 }
+function validateI18NConfig(node, validationContext, preMerge) {
+    if (node) {
+        // i18n may not be defined until after config hooks are applied
+        // note: there are 2 "post" hooks (onConfig/onStart) that i18n can be applied.
+        // We need to ensure that we only validate after the last one (if both are used)
+        if (!preMerge) {
+            validationContext.assertIsObject(node, 'i18n');
+        }
+        validationContext.assertIsObject(node, 'i18n');
+        validationContext.assertValidKeys(node, 'i18n', I18N_ATTRIBUTE_KEYS);
+        validationContext.assertRequiredKeys(node, 'i18n', ['defaultLocale', 'locales']);
+        // Validate locales
+        const locales = findNode(node, ['locales']);
+        validationContext.assertNotEmptyArray(locales, 'i18n.locales');
+        validationContext.assertUniqueIds([...(locales?.children || [])], 'i18n.locales');
+        // Validate defaultLocale
+        const defaultLocale = findNode(node, ['defaultLocale']);
+        validationContext.assertNotEmptyString(defaultLocale, 'i18n.defaultLocale');
+        const localeIds = locales?.children?.map((n) => findNode(n, ['id'])?.value) || [];
+        validationContext.assertDefaultInLocales(node, defaultLocale?.value, localeIds);
+    }
+}
 function validateBundleConfig(node, validationContext) {
     if (node) {
         validationContext.assertIsObject(node, 'bundleConfig');
@@ -274,6 +296,7 @@ function validateRoot(node, validationContext, preMerge) {
     validateRouteHandlers(findNode(node, ['routeHandlers']), validationContext);
     validateAssets(findNode(node, ['assets']), validationContext, preMerge);
     validateLocker(lockerNode, validationContext);
+    validateI18NConfig(findNode(node, ['i18n']), validationContext, preMerge);
     validateBundleConfig(bundleConfigNode, validationContext);
     validationContext.assertClientLockerSSR(routes, lockerNode);
     validationContext.assertNotEmptyString(findNode(node, ['apiVersion']), 'apiVersion');

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.11.0-alpha.2",
+    "version": "0.11.0-alpha.4",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -41,14 +41,14 @@
         "test": "jest"
     },
     "dependencies": {
-        "@lwrjs/diagnostics": "0.11.0-alpha.2",
-        "@lwrjs/instrumentation": "0.11.0-alpha.2",
-        "@lwrjs/shared-utils": "0.11.0-alpha.2",
+        "@lwrjs/diagnostics": "0.11.0-alpha.4",
+        "@lwrjs/instrumentation": "0.11.0-alpha.4",
+        "@lwrjs/shared-utils": "0.11.0-alpha.4",
         "fs-extra": "^11.1.1",
         "jsonc-parser": "^3.0.0"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.11.0-alpha.2",
+        "@lwrjs/types": "0.11.0-alpha.4",
         "jest": "^26.6.3",
         "ts-jest": "^26.5.6"
     },
@@ -61,5 +61,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "ce7d80468d289a0d24682735513166f163f29f61"
+    "gitHead": "89a7e9815e0e381d9fd67212f0471d9a11f73985"
 }