@lwrjs/router 0.12.0-alpha.1 → 0.12.0-alpha.10

package/build/modules/lwr/navigation/navigationApi.js

@@ -1,27 +1,27 @@
 import { getNavigationHelm } from 'lwr/contextUtils';
 /**
- * Navigate programmatically.
+ * Navigate programmatically to a page reference.
  * The Promise used within is deliberately not returned.
  *
  * @param {HTMLElement} context - The navigation context
- * @param {object | string} loc - A route or URL for navigating
- * @param {*} options - Usually a boolean; when true the previous browser history
- *              entry should be replaced by this one
+ * @param {PageReference} pageReference - A page reference location
+ * @param {boolean} replace - When true the previous browser history entry should be replaced by this one
+ * @param {NavigateOptions} options - Additional navigation options (i.e. switch locale)
  */
-export function navigate(context, pageReference, replace) {
+export function navigate(context, pageReference, replace, options) {
   const api = getNavigationHelm(context);
-  api.navigate(pageReference, replace);
+  api.navigate(pageReference, replace, options);
 }
 
 /**
- * Generate a URL for the given route.
+ * Generate a URL for the given page reference.
  *
  * @param {HTMLElement} context - The navigation context
- * @param {object} route - A route
+ * @param {PageReference} pageReference - A page reference location
  *
  * @returns {Promise<string>}
  */
-export function generateUrl(context, pageReference) {
+export function generateUrl(context, pageReference, options) {
   const api = getNavigationHelm(context);
-  return api.generateUrl(pageReference);
+  return api.generateUrl(pageReference, options);
 }

package/build/modules/lwr/navigation/navigationMixin.js

@@ -62,16 +62,16 @@ function NavigationMixin(Base) {
         }
       }
     }
-    [Navigate](pageRef, replace) {
+    [Navigate](pageRef, replace, options) {
       if (!isSSR) {
         this[GetContext]();
-        navigate(this[NavContext], pageRef, replace);
+        navigate(this[NavContext], pageRef, replace, options);
       }
     }
-    async [GenerateUrl](pageRef) {
+    async [GenerateUrl](pageRef, options) {
       if (!isSSR) {
         this[GetContext]();
-        return generateUrl(this[NavContext], pageRef);
+        return generateUrl(this[NavContext], pageRef, options);
       } else {
         return null;
       }

package/build/modules/lwr/router/router.js

@@ -5,7 +5,7 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
 
-import { freeze, getUrlFromPageReference, getPageReferenceFromUrl, matchRouteByUrl, getUrlFromPageReferenceAndRouteDef, parseRoutes } from 'lwr/routerUtils';
+import { freeze, getUrlFromPageReference, getPageReferenceFromUrl, matchRouteByUrl, getUrlFromPageReferenceAndRouteDef, parseRoutes, DEFAULT_I18N_ROUTER_CONFIG } from 'lwr/routerUtils';
 import { generateMessage, messages } from 'lwr/routerErrors';
 import { createObservable } from 'lwr/observable';
 class RouterImpl {
@@ -25,10 +25,11 @@ class RouterImpl {
     this.routeObservable = createObservable();
     this.config = {
       basePath: config.basePath || '',
+      i18n: config.i18n || DEFAULT_I18N_ROUTER_CONFIG,
       caseSensitive: Boolean(config.caseSensitive),
       routes: config.routes || [],
-      generateUrl: address => getUrlFromPageReference(address, this.compiledRoutes, this.config.basePath),
-      parseUrl: url => getPageReferenceFromUrl(url, this.compiledRoutes, this.config.basePath)
+      generateUrl: (address, options) => getUrlFromPageReference(address, this.compiledRoutes, this.config.basePath, this.config.i18n, options),
+      parseUrl: url => getPageReferenceFromUrl(url, this.compiledRoutes, this.config.basePath, this.config.i18n)
     };
     const {
       DEPRECATED_getRouteFromUrl,
@@ -48,14 +49,14 @@ class RouterImpl {
    *
    * @param address
    */
-  generateUrl(address) {
+  generateUrl(address, options) {
     const {
       DEPRECATED_getUrlFromRoute: getUrlFromRoute
     } = this.deprecatedConfig;
     if (getUrlFromRoute) {
-      return getUrlFromRoute(address, this.config.generateUrl);
+      return getUrlFromRoute(address, this.config.generateUrl, options);
     } else {
-      return this.config.generateUrl(address);
+      return this.config.generateUrl(address, options);
     }
   }
 
@@ -81,13 +82,13 @@ class RouterImpl {
    *
    * @param address - The address to match
    */
-  matchRoute(address) {
-    const url = typeof address === 'string' ? address : this.generateUrl(address);
+  matchRoute(address, options) {
+    const url = typeof address === 'string' ? address : this.generateUrl(address, options);
     if (url === null) {
       return null;
     }
-    const match = matchRouteByUrl(url, this.compiledRoutes, this.config.basePath);
-    const pathMatch = match && getUrlFromPageReferenceAndRouteDef(match.route.pageReference, match.routeDefinition, this.config.basePath);
+    const match = matchRouteByUrl(url, this.compiledRoutes, this.config.basePath, this.config.i18n, options);
+    const pathMatch = match && getUrlFromPageReferenceAndRouteDef(match.route.pageReference, match.routeDefinition, this.config.basePath, this.config.i18n, options);
     if (!match || !pathMatch) {
       return null;
     }
@@ -103,10 +104,10 @@ class RouterImpl {
    *
    * @param address - The address to match to a viewset
    */
-  async resolveView(address) {
+  async resolveView(address, options) {
     return new Promise((resolve, reject) => {
       // get the RoutingMatch: { pathMatch, route, routeDefinition }
-      const routingMatch = this.matchRoute(address);
+      const routingMatch = this.matchRoute(address, options);
       if (!routingMatch) {
         return reject(generateMessage(messages.NO_ROUTE_MATCH, [JSON.stringify(address)]));
       }
@@ -138,8 +139,8 @@ class RouterImpl {
    *
    * @param {object} address
    */
-  navigate(address) {
-    const routingMatch = this.matchRoute(address);
+  navigate(address, options) {
+    const routingMatch = this.matchRoute(address, options);
     if (!routingMatch) {
       throw new Error(generateMessage(messages.MISSING_ROUTE, [JSON.stringify(address)]));
     }

package/build/modules/lwr/routerBridge/routerBridge.js

@@ -50,7 +50,6 @@ class DomRouterBridge {
     }) => {
       this.config.onPostNavigate(pageReference); // ONLY return the page reference
     });
-
     this.bridgedRouter.addErrorNavigate(this.config.onError);
 
     // Prevent the observed router from altering the browser URL or history

package/build/modules/lwr/routerContainer/utils.js

@@ -10,7 +10,9 @@ import { invariant, messages } from 'lwr/routerErrors';
 import { DomRouterImpl } from 'lwr/domRouter';
 /*
  * Provides programmatic routing capabilities.
- */ // The application may create 1 root router at a time.
+ */
+
+// The application may create 1 root router at a time.
 let hasRoot = false;
 /**
  * Create a new navigation context, attach to the given node.

package/build/modules/lwr/routerUtils/routeDefUtils.js

@@ -230,6 +230,5 @@ export function getPageReferenceFromUriAndRouteDef(uri, routeDef) {
       };
     }
   }
-
   return null;
 }

package/build/modules/lwr/routerUtils/routeUtils.js

@@ -7,6 +7,11 @@
 
 import { getPathFromUrl, getQueryFromUrl, getQueryString, isParam, getParamName, getQueryNames } from './uriUtils';
 import { getPageReferenceFromUriAndRouteDef, matchRouteDefinitionByPageReference, getPathParams, getQueryParams } from './routeDefUtils';
+export const DEFAULT_I18N_ROUTER_CONFIG = {
+  locale: 'en-US',
+  defaultLocale: 'en-US'
+};
+
 /**
  * Returns true if the given path & queryObj match the patterns (if any) defined in the routeDef
  *
@@ -80,14 +85,22 @@ function getRouteDefinitionForUri(uri, routeDefs) {
  * @param {string} url - URL string to turn into a route
  * @param {array[object]} routeDefs - List of Route Definitions to match to the url
  * @param {string} basePath - Optional: if provided, remove the base path before conversion.
+ * @param {object} i18n - Optional: if provided, remove the non-default locale before conversion.
  *
  * @returns {object}
  */
-export function matchRouteByUrl(url, routeDefs, basePath = '') {
+export function matchRouteByUrl(url, routeDefs, basePath = '', i18n = DEFAULT_I18N_ROUTER_CONFIG, options) {
   // Pass in the rest of the URL for matching, without the prefix.
-  if (basePath && url.indexOf(basePath) === 0) {
+  if (basePath && url?.indexOf(basePath) === 0) {
     url = url.replace(basePath, '');
   }
+  // Remove the locale
+  if (options?.locale || i18n?.locale) {
+    const localePath = `/${options?.locale || i18n.locale}`;
+    if (url?.indexOf(localePath) === 0) {
+      url = url.replace(localePath, '');
+    }
+  }
 
   // Parse the URL.
   const routeDef = getRouteDefinitionForUri(url, routeDefs);
@@ -137,10 +150,10 @@ export function matchRouteByUrl(url, routeDefs, basePath = '') {
  * @param basePath Base path for the url
  * @returns the url or null if no match
  */
-export function getUrlFromPageReference(pageReference, routeDefs, basePath = '') {
+export function getUrlFromPageReference(pageReference, routeDefs, basePath = '', i18n = DEFAULT_I18N_ROUTER_CONFIG, options) {
   const routeDef = matchRouteDefinitionByPageReference(pageReference, routeDefs);
   if (routeDef) {
-    return getUrlFromPageReferenceAndRouteDef(pageReference, routeDef, basePath);
+    return getUrlFromPageReferenceAndRouteDef(pageReference, routeDef, basePath, i18n, options);
   }
   return null;
 }
@@ -186,7 +199,7 @@ function extractBindingValues(parameters, pageReference, pageBindings) {
  * @param routeDef routeDef to that defines how serialize the given pageReference
  * @returns url for the given pageReference
  */
-export function getUrlFromPageReferenceAndRouteDef(pageReference, routeDef, basePath = '') {
+export function getUrlFromPageReferenceAndRouteDef(pageReference, routeDef, basePath = '', i18n = DEFAULT_I18N_ROUTER_CONFIG, options) {
   const {
     params,
     original: {
@@ -229,7 +242,9 @@ export function getUrlFromPageReferenceAndRouteDef(pageReference, routeDef, base
   });
   const queryObject = getQueryObjectForParametersAndPageReference(pageReference, queryParameters, routeDef);
   const queryString = getQueryString(queryObject);
-  return `${basePath}${toPathUrl}${queryString}`;
+  const locale = options?.locale || i18n && i18n.locale;
+  const localePart = locale !== i18n.defaultLocale ? `/${locale}` : '';
+  return `${basePath}${localePart}${toPathUrl}${queryString}`;
 }
 
 /**
@@ -281,8 +296,8 @@ function getQueryObjectForParametersAndPageReference(pageReference, queryParamet
 /**
  * Obtains the pageReference for the given URL
  */
-export function getPageReferenceFromUrl(url, routeDefs, basePath = '') {
-  const routingMatch = matchRouteByUrl(url, routeDefs, basePath);
+export function getPageReferenceFromUrl(url, routeDefs, basePath = '', i18n = DEFAULT_I18N_ROUTER_CONFIG) {
+  const routingMatch = matchRouteByUrl(url, routeDefs, basePath, i18n);
   if (routingMatch && routingMatch.route && routingMatch.route.pageReference) {
     return routingMatch.route.pageReference;
   }

package/build/modules/lwr/routerUtils/routerUtils.js

@@ -7,7 +7,7 @@
 
 export { createFilterChain } from './filterUtils';
 export { getPageReferenceFromUriAndRouteDef } from './routeDefUtils';
-export { getUrlFromPageReference, getPageReferenceFromUrl, matchRouteByUrl, getUrlFromPageReferenceAndRouteDef } from './routeUtils';
+export { DEFAULT_I18N_ROUTER_CONFIG, getUrlFromPageReference, getPageReferenceFromUrl, matchRouteByUrl, getUrlFromPageReferenceAndRouteDef } from './routeUtils';
 export { isObject, freeze, guid, isValidRoute } from './typeUtils';
 export { parseRoutes } from './parseUtils';
 import { pathToRegexp as ptr, compile as ptrCompile } from './pathToRegexp';

package/build/modules/lwr/routerUtils/typeUtils.js

@@ -8,6 +8,7 @@
 /*
  * Utilities for checking type, including route types.
  */
+
 /**
  * @param {*} o - Item to check if it's an object
  * @returns {boolean}

package/build/modules/lwr/serverRouter/serverRouter.js

@@ -24,7 +24,7 @@ export class ServerRouter {
    * Perform a hard navigation to the given page reference
    * Client only!
    */
-  async navigate(address) {
+  async navigate(address, _replace, options) {
     if (hasDocument) {
       // invoke the handleNavigation hook, which intercepts the raw page ref
       if (this.handleNavHook && !this.handleNavHook(address)) {
@@ -32,7 +32,7 @@ export class ServerRouter {
       }
 
       // continue navigating
-      const url = await this.getValidatedUrl(address);
+      const url = await this.getValidatedUrl(address, options);
       if (url) {
         // hard navigation
         document.location.href = url;
@@ -44,8 +44,8 @@ export class ServerRouter {
    * lightning/navigation
    * Generate a URL based on the given page reference
    */
-  generateUrl(address) {
-    return this.router.generateUrl(address);
+  generateUrl(address, options) {
+    return this.router.generateUrl(address, options);
   }
 
   /**
@@ -66,7 +66,7 @@ export class ServerRouter {
     url = this.getRelativeUrl(url);
 
     // ensure the initial URL matches a valid route definition
-    const routingMatch = this.router.matchRoute(url);
+    const routingMatch = this.router.matchRoute(url, {});
     if (!routingMatch) {
       this.processError(generateMessageObject(messages.MISSING_ROUTE, [url]));
       return;
@@ -75,9 +75,9 @@ export class ServerRouter {
 
     // set up the navigation context APIs
     registerNavigationHelm(this.contextId, {
-      navigate: address => this.navigate(address),
-      generateUrl: address => this.generateUrl(address),
-      // the JS context is lost during hard navigations, so subcribing to route changes will not work
+      navigate: (address, replace, options) => this.navigate(address, replace, options),
+      generateUrl: (address, options) => this.generateUrl(address, options),
+      // the JS context is lost during hard navigation, so subscribing to route changes will not work
       subscribe: () => {
         throw new Error('The server router does not support the subscribe API');
       }
@@ -114,9 +114,9 @@ export class ServerRouter {
   /**
    * Validate the page reference passed to the navigate API
    */
-  async getValidatedUrl(address) {
+  async getValidatedUrl(address, options) {
     // match the URL to a route definition; fail if there is no match
-    const routingMatch = this.router.matchRoute(address);
+    const routingMatch = this.router.matchRoute(address, {});
     if (!routingMatch) {
       this.processError(generateMessageObject(messages.NO_ROUTE_MATCH, [JSON.stringify(address)]));
       return;
@@ -131,7 +131,7 @@ export class ServerRouter {
       this.processError(generateMessageObject(messages.PRENAV_FAILED, [JSON.stringify(address)]));
       return;
     }
-    return this.router.generateUrl(address);
+    return this.router.generateUrl(address, options);
   }
 
   /**

package/package.json

@@ -5,7 +5,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.12.0-alpha.1",
+    "version": "0.12.0-alpha.10",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -53,15 +53,15 @@
         "test:server": "jest --config ./jest.server.config.cjs"
     },
     "dependencies": {
-        "@lwrjs/client-modules": "0.12.0-alpha.1",
-        "@lwrjs/diagnostics": "0.12.0-alpha.1",
-        "@lwrjs/shared-utils": "0.12.0-alpha.1",
+        "@lwrjs/client-modules": "0.12.0-alpha.10",
+        "@lwrjs/diagnostics": "0.12.0-alpha.10",
+        "@lwrjs/shared-utils": "0.12.0-alpha.10",
         "ajv": "6.12.6"
     },
     "devDependencies": {
-        "@lwc/jest-preset": "^14.2.1",
-        "@lwrjs/fs-watch": "0.12.0-alpha.1",
-        "@rollup/plugin-typescript": "^11.1.5",
+        "@lwc/jest-preset": "^14.3.0",
+        "@lwrjs/fs-watch": "0.12.0-alpha.10",
+        "@rollup/plugin-typescript": "^11.1.6",
         "jest": "^26.6.3",
         "rollup": "^2.78.0",
         "ts-jest": "^26.5.6",
@@ -93,10 +93,10 @@
         ]
     },
     "engines": {
-        "node": ">=16.0.0"
+        "node": ">=18.0.0"
     },
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "138cc3716e923d0367e8279aaf2d6be21e74f440"
+    "gitHead": "36759959f624aa40d371dc9ee698dd472813f19c"
 }