@lwrjs/router 0.24.2 → 0.24.4

package/build/cjs/services/module-provider/index.cjs

@@ -1,42 +1,45 @@
-var __create = Object.create;
 var __defProp = Object.defineProperty;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
-    __defProp(target, name, {get: all[name], enumerable: true});
+    __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __exportStar = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, {get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable});
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
-};
-var __toModule = (module2) => {
-  return __exportStar(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? {get: () => module2.default, enumerable: true} : {value: module2, enumerable: true})), module2);
+  return to;
 };
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // packages/@lwrjs/router/src/services/module-provider/index.ts
-__markAsModule(exports);
-__export(exports, {
-  default: () => module_provider_default
+var module_provider_exports = {};
+__export(module_provider_exports, {
+  default: () => RouterModuleProvider
 });
-var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
-var import_utils = __toModule(require("./utils.cjs"));
-var import__ = __toModule(require("../index.cjs"));
+module.exports = __toCommonJS(module_provider_exports);
+var import_shared_utils = require("@lwrjs/shared-utils");
+var import_utils = require("./utils.cjs");
+var import__ = require("../index.cjs");
 var DEFAULT_DIR = "$rootDir/src/routes";
 var RouterModuleProvider = class {
-  constructor({routesDir = DEFAULT_DIR}, context) {
-    this.name = "router-module-provider";
-    this.watchedFileSet = new Set();
+  name = "router-module-provider";
+  version;
+  routesDir;
+  appBasePath;
+  i18n;
+  // Watch the Router Config files and recompile the modules on change
+  routerWatcher;
+  watchedFileSet = /* @__PURE__ */ new Set();
+  // <config path, module id>
+  constructor({ routesDir = DEFAULT_DIR }, context) {
     const {
-      config: {rootDir, contentDir, i18n, layoutsDir},
-      runtimeEnvironment: {lwrVersion, watchFiles},
+      config: { rootDir, contentDir, i18n, layoutsDir },
+      runtimeEnvironment: { lwrVersion, watchFiles },
       watcherFactory
     } = context;
     this.version = lwrVersion;
@@ -49,9 +52,14 @@ var RouterModuleProvider = class {
     }).replace(/\/$/, "");
     this.routerWatcher = watchFiles && watcherFactory ? (0, import_utils.setUpWatcher)(watcherFactory, this.onRouterModuleChange.bind(this)) : void 0;
   }
+  // When Router Metadata changes on the file system:
+  //      1. delete the config data from the routerConfigJsonCache (in ../index)
   async onRouterModuleChange(configPath) {
     (0, import__.deleteRouterConfigJsonCacheEntry)(configPath);
   }
+  // Watch Router Config files:
+  //      1. Add files to the watcher
+  //      2. Track watched files in the watchedFileSet
   watchConfigs(configPath) {
     if (this.routerWatcher) {
       if (!this.watchedFileSet.has(configPath)) {
@@ -60,6 +68,9 @@ var RouterModuleProvider = class {
       }
     }
   }
+  // 1. Check that:
+  //      a. the specifier is in the correct format: "@lwrjs/router/{routerId}"
+  //      b. the config JSON addressed by "routerId" is available on the file system
   getRouterConfig(specifier) {
     let config;
     const routerId = (0, import_utils.parseSpecifier)(specifier);
@@ -70,12 +81,14 @@ var RouterModuleProvider = class {
     }
     return config;
   }
-  async getModuleEntry({specifier}, runtimeParams) {
+  async getModuleEntry({ specifier }, runtimeParams) {
     const config = this.getRouterConfig(specifier);
     if (config) {
       return {
         id: `${specifier}|${this.version}|${runtimeParams.basePath}|${runtimeParams.locale}`,
+        // used as part of the cache key for this module by the LWR Module Registry
         virtual: true,
+        // ...because this is a server-generated module
         entry: `<virtual>/${specifier}.js`,
         specifier,
         version: this.version
@@ -83,8 +96,8 @@ var RouterModuleProvider = class {
     }
   }
   async getModule(moduleId, runtimeParams) {
-    const {specifier, namespace, name = specifier} = moduleId;
-    const moduleEntry = await this.getModuleEntry({specifier}, runtimeParams);
+    const { specifier, namespace, name = specifier } = moduleId;
+    const moduleEntry = await this.getModuleEntry({ specifier }, runtimeParams);
     if (!moduleEntry) {
       return;
     }
@@ -104,4 +117,3 @@ var RouterModuleProvider = class {
     return moduleCompiled;
   }
 };
-var module_provider_default = RouterModuleProvider;

package/build/cjs/services/module-provider/utils.cjs

@@ -1,37 +1,33 @@
-var __create = Object.create;
 var __defProp = Object.defineProperty;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
-    __defProp(target, name, {get: all[name], enumerable: true});
+    __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __exportStar = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, {get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable});
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
-};
-var __toModule = (module2) => {
-  return __exportStar(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? {get: () => module2.default, enumerable: true} : {value: module2, enumerable: true})), module2);
+  return to;
 };
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // packages/@lwrjs/router/src/services/module-provider/utils.ts
-__markAsModule(exports);
-__export(exports, {
+var utils_exports = {};
+__export(utils_exports, {
   SPECIFIER_PREFIX: () => SPECIFIER_PREFIX,
   generateModule: () => generateModule,
   getRouterConfigPath: () => getRouterConfigPath,
   parseSpecifier: () => parseSpecifier,
   setUpWatcher: () => setUpWatcher
 });
-var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
-var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
+module.exports = __toCommonJS(utils_exports);
+var import_diagnostics = require("@lwrjs/diagnostics");
+var import_shared_utils = require("@lwrjs/shared-utils");
 var SPECIFIER_PREFIX = "@lwrjs/router/";
 function parseSpecifier(specifier) {
   return specifier.startsWith(SPECIFIER_PREFIX) ? specifier.replace(SPECIFIER_PREFIX, "") : void 0;
@@ -42,9 +38,18 @@ function getRouterConfigPath(dir, specifier) {
 }
 function setUpWatcher(factory, onModuleChange) {
   const watcher = factory.createFileWatcher();
-  watcher.on("change", (0, import_shared_utils.debounce)((file) => onModuleChange(file), 500));
-  watcher.on("unlink", (0, import_shared_utils.debounce)((file) => onModuleChange(file, true), 500));
-  watcher.on("add", (file) => import_diagnostics.logger.info({label: `@lwrjs/router`, message: `Watching Router Config file at "${file}"`}));
+  watcher.on(
+    "change",
+    (0, import_shared_utils.debounce)((file) => onModuleChange(file), 500)
+  );
+  watcher.on(
+    "unlink",
+    (0, import_shared_utils.debounce)((file) => onModuleChange(file, true), 500)
+  );
+  watcher.on(
+    "add",
+    (file) => import_diagnostics.logger.info({ label: `@lwrjs/router`, message: `Watching Router Config file at "${file}"` })
+  );
   return watcher;
 }
 function getHandlerClassName(specifier) {
@@ -52,10 +57,9 @@ function getHandlerClassName(specifier) {
 }
 function generateHandlerClasses(routes) {
   let handlerClasses = "";
-  const seenComponents = new Set();
+  const seenComponents = /* @__PURE__ */ new Set();
   const filteredAndDeDupedArray = routes.filter((item) => {
-    if (!item.component)
-      return false;
+    if (!item.component) return false;
     if (!seenComponents.has(item.component)) {
       seenComponents.add(item.component);
       return true;
@@ -88,25 +92,27 @@ function generateHandlerClasses(routes) {
 function generateRouteDefinitions(routes) {
   let routeDefs = "[\n";
   routes.forEach((r) => {
-    const {handler, component, ...routeDef} = r;
+    const { handler, component, ...routeDef } = r;
     const portableProps = JSON.stringify(routeDef);
     if (handler) {
-      routeDefs += portableProps.slice(0, portableProps.length - 1) + `, handler: () => import('${handler}') },
+      routeDefs += // translate the handler specifier => a handler dynamic import
+      portableProps.slice(0, portableProps.length - 1) + `, handler: () => import('${handler}') },
 `;
     } else if (component) {
-      routeDefs += portableProps.slice(0, portableProps.length - 1) + `, handler: () => Promise.resolve({ default: ${getHandlerClassName(component)} }) },
+      routeDefs += // translate the component specifier => a resolved handler class
+      portableProps.slice(0, portableProps.length - 1) + `, handler: () => Promise.resolve({ default: ${getHandlerClassName(component)} }) },
 `;
     }
   });
   return `${routeDefs}	]`;
 }
-function generateModule(config = {routes: []}, {defaultLocale, uriPattern}, runtimeParams) {
-  const {caseSensitive, routes: jsonRoutes} = config;
+function generateModule(config = { routes: [] }, { defaultLocale, uriPattern }, runtimeParams) {
+  const { caseSensitive, routes: jsonRoutes } = config;
   const csString = caseSensitive ? "true" : "false";
   const routes = generateRouteDefinitions(jsonRoutes);
   const handlers = generateHandlerClasses(jsonRoutes);
   const basePath = runtimeParams?.basePath || "";
-  const i18nRouterConfig = uriPattern === "path-prefix" ? `${JSON.stringify({locale: runtimeParams?.locale, defaultLocale})}` : void 0;
+  const i18nRouterConfig = uriPattern === "path-prefix" ? `${JSON.stringify({ locale: runtimeParams?.locale, defaultLocale })}` : void 0;
   return `import { createRouter as createLwrRouter } from 'lwr/router';
 ${handlers}
 export function createRouter({ basePath = '${basePath}', caseSensitive = ${csString}, DEPRECATED_getRouteFromUrl, DEPRECATED_getUrlFromRoute } = {}) {

package/package.json

@@ -5,7 +5,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.24.2",
+    "version": "0.24.4",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -53,14 +53,14 @@
         "test:server": "jest --config ./jest.server.config.cjs"
     },
     "dependencies": {
-        "@lwrjs/client-modules": "0.24.2",
-        "@lwrjs/diagnostics": "0.24.2",
-        "@lwrjs/shared-utils": "0.24.2",
+        "@lwrjs/client-modules": "0.24.4",
+        "@lwrjs/diagnostics": "0.24.4",
+        "@lwrjs/shared-utils": "0.24.4",
         "ajv": "8.18.0"
     },
     "devDependencies": {
         "@lwc/jest-preset": "^19.6.1",
-        "@lwrjs/fs-watch": "0.24.2",
+        "@lwrjs/fs-watch": "0.24.4",
         "@rollup/plugin-typescript": "^11.1.6",
         "jest": "29.7.0",
         "memfs": "^4.13.0",
@@ -100,5 +100,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "7492ce779f3b7e91617c4644a1aa567eff01db58"
+    "gitHead": "63feabb6eea1340e80a82146cc1c24bfc4f2d518"
 }