@lwrjs/router 0.24.2 → 0.24.3

package/build/cjs/modules/lwr/domRouter/domRouter.cjs

@@ -1,68 +1,90 @@
-var __create = Object.create;
+"use strict";
 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/modules/lwr/domRouter/domRouter.ts
-__markAsModule(exports);
-__export(exports, {
+var domRouter_exports = {};
+__export(domRouter_exports, {
   DomRouterImpl: () => DomRouterImpl,
   NAV_EVENT: () => NAV_EVENT,
   PARENT_EVENT: () => PARENT_EVENT,
   createDomRouter: () => createDomRouter
 });
-var import_navigation = __toModule(require("lwr/navigation"));
-var import_contextProvider = __toModule(require("lwr/contextProvider"));
-var import_routerErrors = __toModule(require("lwr/routerErrors"));
-var import_routerUtils = __toModule(require("lwr/routerUtils"));
-var import_observable = __toModule(require("lwr/observable"));
-var import_metrics = __toModule(require("lwr/metrics"));
-var import_profiler = __toModule(require("lwr/profiler"));
-var import_navigationMixinHacks = __toModule(require("lwr/navigationMixinHacks"));
+module.exports = __toCommonJS(domRouter_exports);
+var import_navigation = require("lwr/navigation");
+var import_contextProvider = require("lwr/contextProvider");
+var import_routerErrors = require("lwr/routerErrors");
+var import_routerUtils = require("lwr/routerUtils");
+var import_observable = require("lwr/observable");
+var import_metrics = require("lwr/metrics");
+var import_profiler = require("lwr/profiler");
+var import_navigationMixinHacks = require("lwr/navigationMixinHacks");
 var NAV_EVENT = `universalcontainernavigationevent${(0, import_routerUtils.guid)()}`;
 var PARENT_EVENT = `universalcontainerparentevent${(0, import_routerUtils.guid)()}`;
 var DomRouterImpl = class {
+  /**
+   * Create and configure the Router.
+   *
+   * @param {object} config - The domRouter config object, all properties are optional
+   * @param {object} router - an optional Router
+   * @param {HTMLElement} target - DOM node to attach to
+   */
   constructor(config, router, target) {
     this.pendingRoute = null;
     this.committedRoute = null;
+    // used for instrumentation
     this.contextId = Object.freeze(() => void 0);
     this.connected = false;
     this.preNavFilters = (0, import_routerUtils.createFilterChain)();
     this.errorNavFilters = (0, import_routerUtils.createFilterChain)();
+    /**
+     * Inspect a navigation event bubbling up from a descendent component.
+     * This node can choose to stop the event by returning false.
+     * If propagation is not stopped, and this node is the root (no parent),
+     *      then begin the root -> leaf processing of this new route.
+     *      This will update the navigation event subscribers in each DomRouter, top down.
+     *
+     * @param {Event} event - With detail: { url, options }
+     */
     this._handleNavigationEvent = (event) => {
       const navigationEvent = event;
       if (navigationEvent.detail && typeof navigationEvent.detail === "object") {
-        const {url, replace, address} = navigationEvent.detail;
+        const { url, replace, address } = navigationEvent.detail;
         const continueNavigation = this.config.handleNavigation(address, replace);
         if (!continueNavigation) {
           navigationEvent.stopPropagation();
         } else {
           if (this.root && !url) {
-            this.root.processError((0, import_routerErrors.generateMessageObject)(import_routerErrors.messages.MISSING_URL, [JSON.stringify(address)]));
+            this.root.processError(
+              (0, import_routerErrors.generateMessageObject)(import_routerErrors.messages.MISSING_URL, [JSON.stringify(address)])
+            );
           } else if (!this.parent) {
             this.process(url, replace);
           }
         }
       }
     };
+    /**
+     * Be discovered as a parent for descendent components.
+     * Stop immediate propagation because we only want 1 parent to be found.
+     *
+     * @param {Event} event - With detail: callback
+     */
     this._handleParentEvent = (event) => {
       event.stopImmediatePropagation();
       const parentRouterEvent = event;
@@ -78,6 +100,9 @@ var DomRouterImpl = class {
     this.router.contextId = this.contextId;
     this.routeObservable = (0, import_observable.createObservable)();
   }
+  /**
+   * Search up the node chain until the root node is hit
+   */
   get root() {
     if (!this.parent) {
       return this;
@@ -91,6 +116,13 @@ var DomRouterImpl = class {
     }
     throw new Error("No root router could be found");
   }
+  /**
+   * Informs an wire listeners of routing changes/errors
+   *
+   * @param {RoutingResult} result - result object from navigation event
+   * @param {string} url - url from the page reference that triggered the navigation event
+   * @param {MessageObject} error - if an error occurred during the navigation
+   */
   updateWires(result, url, error) {
     if (error) {
       this.processError(error);
@@ -98,17 +130,20 @@ var DomRouterImpl = class {
       if (this.committedRoute && result.route === this.committedRoute.route) {
         return;
       }
-      (0, import_profiler.logOperationEnd)({id: import_metrics.ROUTER_VIEW, specifier: this.eventId});
-      this.pendingRoute = this.pendingRoute || {...result, url};
-      this.committedRoute = {...this.pendingRoute, ...result};
+      (0, import_profiler.logOperationEnd)({ id: import_metrics.ROUTER_VIEW, specifier: this.eventId });
+      this.pendingRoute = this.pendingRoute || { ...result, url };
+      this.committedRoute = { ...this.pendingRoute, ...result };
       import_navigation.CurrentPageReference.setContext(this.target, result.route.pageReference);
-      this.routeObservable.next({...this.committedRoute, viewset: result.viewset});
-      (0, import_profiler.logOperationEnd)({id: import_metrics.ROUTER_NAV, specifier: this.eventId});
+      this.routeObservable.next({ ...this.committedRoute, viewset: result.viewset });
+      (0, import_profiler.logOperationEnd)({ id: import_metrics.ROUTER_NAV, specifier: this.eventId });
       if (this.child) {
         this.child.process(this._stripUrlForChild(this.committedRoute.url));
       }
     }
   }
+  /**
+   * Override to provide this router as a navigation context
+   */
   connect() {
     this._sendEvent(PARENT_EVENT, (router) => {
       this.parent = router;
@@ -131,16 +166,18 @@ var DomRouterImpl = class {
       }
       if (result.status && result.status >= 400) {
         const error = result.error || new Error();
-        this.processError((0, import_routerErrors.generateMessageObject)(import_routerErrors.messages.DESTINATION_ERROR, [
-          result.status.toString(),
-          error.message,
-          error.stack || ""
-        ]));
+        this.processError(
+          (0, import_routerErrors.generateMessageObject)(import_routerErrors.messages.DESTINATION_ERROR, [
+            result.status.toString(),
+            error.message,
+            error.stack || ""
+          ])
+        );
         return;
       }
       const pageReference = result.route.pageReference || {};
       const url = this.router.generateUrl(pageReference) || "";
-      (0, import_profiler.logOperationStart)({id: import_metrics.ROUTER_VIEW, specifier: this.eventId});
+      (0, import_profiler.logOperationStart)({ id: import_metrics.ROUTER_VIEW, specifier: this.eventId });
       if (result.viewset) {
         const currentViewContext = {
           viewset: result.viewset,
@@ -176,12 +213,28 @@ var DomRouterImpl = class {
     this.child = void 0;
     this.connected = false;
   }
+  /**
+   * Add listeners to this router hook which run BEFORE a new URL is processed (root -> leaf).
+   *
+   * @param {object | object[]} filters
+   */
   addPreNavigate(filters) {
     this.preNavFilters.add(filters);
   }
+  /**
+   * Add listeners to this router hook which run when there is an error navigating.
+   *
+   * @param {object | object[]} filters
+   */
   addErrorNavigate(filters) {
     this.errorNavFilters.add(filters);
   }
+  /**
+   * Override parent implementation.
+   * Pass the current state down to a new child.
+   *
+   * @param {child} child - Child router
+   */
   async addChild(child) {
     await new Promise((resolve) => {
       setTimeout(() => {
@@ -198,9 +251,23 @@ var DomRouterImpl = class {
       }
     }
   }
+  /**
+   * Process the current URL passed down by the parent router.
+   * Stop propagation of the navigation event if a preNavigate filter returns false.
+   *
+   * Update the current path and route matches.
+   * Update the observable to hold the new route.
+   *
+   * After processing, delegate to a child router, if it exists.
+   *
+   * @param {string} url - Relative URL string to process
+   * @param {NavigateOptions} options - Additional navigation options (i.e. switch root locale)
+   * @returns {boolean} - True if the processing was NOT blocked by a preNavigate listener
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   async process(url, _shouldReplace, options, _updateHistory) {
-    this.eventId = new Date().getTime().toString();
-    (0, import_profiler.logOperationStart)({id: import_metrics.ROUTER_NAV, specifier: this.eventId});
+    this.eventId = (/* @__PURE__ */ new Date()).getTime().toString();
+    (0, import_profiler.logOperationStart)({ id: import_metrics.ROUTER_NAV, specifier: this.eventId });
     try {
       if (!this.parent) {
         await this.preProcess(url, options);
@@ -218,13 +285,22 @@ var DomRouterImpl = class {
     }
     return true;
   }
+  /**
+   * Run the preNavigate filters for this router.
+   * After processing, delegate to a child router, if it exists.
+   *
+   * @param {string} url - Relative URL string to process,
+   *                   cannot use a route since the processing is done in context
+   *
+   * @returns {Promise<boolean>} - Resolves to true if successful
+   */
   preProcess(url, options) {
     const address = this.router.parseUrl(url);
     const routingMatch = address && this.router.matchRoute(address, options);
     if (!routingMatch) {
       return Promise.reject((0, import_routerErrors.generateMessageObject)(import_routerErrors.messages.MISSING_ROUTE, [url]));
     }
-    this.pendingRoute = {url, ...routingMatch};
+    this.pendingRoute = { url, ...routingMatch };
     const canGo = this.preNavFilters.empty() ? Promise.resolve(true) : this.preNavFilters.compile({
       current: this.committedRoute || void 0,
       next: this.pendingRoute
@@ -235,13 +311,28 @@ var DomRouterImpl = class {
       return canContinue || Promise.reject((0, import_routerErrors.generateMessageObject)(import_routerErrors.messages.PRENAV_FAILED, [url]));
     });
   }
+  /**
+   * Run the errorNavigate filters for this router.
+   * After processing, delegate to a child router, if it exists.
+   *
+   * @param {object} e - An error object to pass into the error hook listeners.
+   */
   processError(messageObject) {
-    (0, import_profiler.logOperationStart)({id: import_metrics.ROUTER_ERROR});
+    (0, import_profiler.logOperationStart)({ id: import_metrics.ROUTER_ERROR });
     this.errorNavFilters.compile(messageObject);
     if (this.child) {
       this.child.processError(messageObject);
     }
   }
+  /**
+   * lightning/navigation
+   * Fire an event to send the navigation event up the DOM.
+   * The root router will be the last to catch the event if it is not stopped.
+   *
+   * @param {object} address - Address to navigate to
+   * @param {*} options - Usually a boolean; when true the previous browser history
+   *                    entry should be replaced by this one
+   */
   navigate(address, replace, options) {
     const routerOptions = this.filterNavigateOptions(options);
     let url = this.router.generateUrl(address, routerOptions);
@@ -249,8 +340,17 @@ var DomRouterImpl = class {
       const parentPath = this.parent && this.parent.committedRoute && this.parent.committedRoute.pathMatch || "";
       url = parentPath.concat(url);
     }
-    this._sendEvent(NAV_EVENT, {url, replace, address});
+    this._sendEvent(NAV_EVENT, { url, replace, address });
   }
+  /**
+   * lightning/navigation
+   * Generate a URL based on the given route.
+   * Return the URL string.
+   *
+   * @param   {object} route - Route to generate a url for
+   *
+   * @returns {string}
+   */
   generateUrl(address, options) {
     const routerOptions = this.filterNavigateOptions(options);
     const url = this.router.generateUrl(address, routerOptions);
@@ -260,6 +360,10 @@ var DomRouterImpl = class {
     const parentPath = this.parent && this.parent.committedRoute && this.parent.committedRoute.pathMatch || "";
     return `${parentPath}${url}`;
   }
+  /**
+   * Async version of generateUrl, used by the NavigationMixin and goes through the generateUrlFilter.
+   * @returns {Promise<string>}
+   */
   async generateUrlAsync(address, options) {
     const routerOptions = this.filterNavigateOptions(options);
     const url = await this.router.generateUrlAsync(address, routerOptions);
@@ -269,21 +373,34 @@ var DomRouterImpl = class {
     const parentPath = this.parent && this.parent.committedRoute && this.parent.committedRoute.pathMatch || "";
     return `${parentPath}${url}`;
   }
+  /**
+   * lightning/navigation
+   * Subscribe a callback to the Observable on the current route of this router.
+   *
+   * @param {function} callback - A callback function invoked when the navigation state changes
+   *                     callback(route, routeDef)
+   * @param {boolean} replay - Flag to determine if callback should be called with current route and data immediately
+   */
   subscribe(callback, replay) {
-    return this.routeObservable.subscribe({
-      next: callback,
-      error: () => {
+    return this.routeObservable.subscribe(
+      {
+        next: callback,
+        error: () => {
+        },
+        complete: () => {
+        }
       },
-      complete: () => {
-      }
-    }, Boolean(replay));
+      Boolean(replay)
+    );
   }
   _sendEvent(name, payload) {
-    import_routerUtils.hasDocument && this.target.dispatchEvent(new CustomEvent(name, {
-      bubbles: true,
-      composed: true,
-      detail: payload
-    }));
+    import_routerUtils.hasDocument && this.target.dispatchEvent(
+      new CustomEvent(name, {
+        bubbles: true,
+        composed: true,
+        detail: payload
+      })
+    );
   }
   _stripUrlForChild(url) {
     if (this.pendingRoute && url.indexOf(this.pendingRoute.pathMatch) === 0) {
@@ -291,10 +408,14 @@ var DomRouterImpl = class {
     }
     return url;
   }
+  /**
+   * Filter the navigate options based on if this is a root router or not.
+   */
   filterNavigateOptions(options) {
     const isRoot = !this.parent;
     const routerOptions = {
       ...options,
+      // Only allow switch locales if this is a root router
       locale: isRoot ? options?.locale : void 0
     };
     return routerOptions;

package/build/cjs/modules/lwr/domRouterUtils/domRouterUtils.cjs

@@ -1,33 +1,30 @@
-var __create = Object.create;
+"use strict";
 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/modules/lwr/domRouterUtils/domRouterUtils.ts
-__markAsModule(exports);
-__export(exports, {
+var domRouterUtils_exports = {};
+__export(domRouterUtils_exports, {
   getRelativeUrl: () => import_uriUtils.getRelativeUrl,
   removeFragment: () => import_uriUtils.removeFragment,
   replace: () => import_historyUtils.replace,
   set: () => import_historyUtils.set
 });
-var import_uriUtils = __toModule(require("./uriUtils.cjs"));
-var import_historyUtils = __toModule(require("./historyUtils.cjs"));
+module.exports = __toCommonJS(domRouterUtils_exports);
+var import_uriUtils = require("./uriUtils.cjs");
+var import_historyUtils = require("./historyUtils.cjs");

package/build/cjs/modules/lwr/domRouterUtils/historyUtils.cjs

@@ -1,16 +1,29 @@
+"use strict";
 var __defProp = Object.defineProperty;
-var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+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 __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 to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // packages/@lwrjs/router/src/modules/lwr/domRouterUtils/historyUtils.ts
-__markAsModule(exports);
-__export(exports, {
+var historyUtils_exports = {};
+__export(historyUtils_exports, {
   replace: () => replace,
   set: () => set
 });
+module.exports = __toCommonJS(historyUtils_exports);
 function set(path, route) {
   const data = route || {};
   window.history.pushState(data, "", path);

package/build/cjs/modules/lwr/domRouterUtils/types.cjs

@@ -1,5 +1,18 @@
+"use strict";
 var __defProp = Object.defineProperty;
-var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // packages/@lwrjs/router/src/modules/lwr/domRouterUtils/types.ts
-__markAsModule(exports);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/build/cjs/modules/lwr/domRouterUtils/uriUtils.cjs

@@ -1,34 +1,31 @@
-var __create = Object.create;
+"use strict";
 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/modules/lwr/domRouterUtils/uriUtils.ts
-__markAsModule(exports);
-__export(exports, {
+var uriUtils_exports = {};
+__export(uriUtils_exports, {
   getRelativeUrl: () => getRelativeUrl,
   getUrlObject: () => getUrlObject,
   removeFragment: () => removeFragment
 });
-var import_routerUtils = __toModule(require("lwr/routerUtils"));
+module.exports = __toCommonJS(uriUtils_exports);
+var import_routerUtils = require("lwr/routerUtils");
 function getUrlObject(url = "") {
   url = url || "";
   if (url.indexOf("://") < 0) {
@@ -51,6 +48,7 @@ function getUrlObject(url = "") {
     href: link.href,
     origin: `${link.protocol}//${link.hostname}${link.port ? `:${link.port}` : ""}`,
     pathname: link.pathname.replace(/(\/)?/, "/"),
+    // ensure there is a leading slash (IE11)
     searchParams
   };
 }

package/build/cjs/modules/lwr/historyRouter/historyRouter.cjs

@@ -1,41 +1,42 @@
-var __create = Object.create;
+"use strict";
 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/modules/lwr/historyRouter/historyRouter.ts
-__markAsModule(exports);
-__export(exports, {
+var historyRouter_exports = {};
+__export(historyRouter_exports, {
   HistoryRouter: () => HistoryRouter,
   createHistoryRouter: () => createHistoryRouter
 });
-var import_domRouter = __toModule(require("lwr/domRouter"));
-var import_domRouterUtils = __toModule(require("lwr/domRouterUtils"));
-var import_routerUtils = __toModule(require("lwr/routerUtils"));
+module.exports = __toCommonJS(historyRouter_exports);
+var import_domRouter = require("lwr/domRouter");
+var import_domRouterUtils = require("lwr/domRouterUtils");
+var import_routerUtils = require("lwr/routerUtils");
 var HistoryRouter = class extends import_domRouter.DomRouterImpl {
   constructor() {
     super(...arguments);
     this.historyDisabled = false;
     this.currentUrl = "";
   }
+  /**
+   * Override.
+   * Initialize with the current route and listen to the popstate event for future changes.
+   */
   connect() {
     super.connect();
     if (!this.historyDisabled) {
@@ -56,6 +57,16 @@ var HistoryRouter = class extends import_domRouter.DomRouterImpl {
     super.disconnect();
     import_routerUtils.hasDocument && window.removeEventListener("popstate", this.onpopstate);
   }
+  /**
+   * Override.
+   * Update the browser history if the preNavigate hooks.
+   *
+   * @param {string} url - The URL to go to
+   * @param {boolean} shouldReplace - True if the current history state should be replaced
+   * @param {boolean} updateHistory - True if the browser history should be updated with the new URL
+   *
+   * @returns {boolean} - True if the processing was NOT blocked by a preNavigate listener
+   */
   async process(url, shouldReplace, options, updateHistory = true) {
     const canContinue = await super.process(url, shouldReplace, options, updateHistory);
     if (canContinue && this.connected && !this.parent) {
@@ -70,6 +81,12 @@ var HistoryRouter = class extends import_domRouter.DomRouterImpl {
     }
     return canContinue;
   }
+  /**
+   * Update the root route, and trickle down the router tree.
+   * Redirect to use the base path, if it is missing.
+   *
+   * @param {string} url - The URL to go to
+   */
   catchBrowserUpdate(url) {
     this.process(url, false, {}, false);
   }