@lwrjs/shared-utils 0.5.7 → 0.5.11-236-1

package/build/cjs/index.cjs

@@ -30,4 +30,5 @@ __exportStar(exports, __toModule(require("./import-metadata.cjs")));
 __exportStar(exports, __toModule(require("./graph.cjs")));
 __exportStar(exports, __toModule(require("./mappings.cjs")));
 __exportStar(exports, __toModule(require("./metrics.cjs")));
+__exportStar(exports, __toModule(require("./urls.cjs")));
 __exportStar(exports, __toModule(require("./env.cjs")));

package/build/cjs/urls.cjs

@@ -0,0 +1,83 @@
+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 __export = (target, all) => {
+  for (var name in all)
+    __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});
+  }
+  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);
+};
+
+// packages/@lwrjs/shared-utils/src/urls.ts
+__markAsModule(exports);
+__export(exports, {
+  extractRequestParams: () => extractRequestParams,
+  getClientBootstrapConfigurationRoutes: () => getClientBootstrapConfigurationRoutes,
+  getClientBootstrapConfigurationUri: () => getClientBootstrapConfigurationUri,
+  getClientBootstrapConfigurationUriPrefix: () => getClientBootstrapConfigurationUriPrefix,
+  removeClientBootstrapConfigurationSuffix: () => removeClientBootstrapConfigurationSuffix
+});
+var import_path_to_regexp = __toModule(require("path-to-regexp"));
+var CONFIG_SUFFIX = "/config.js";
+function getClientBootstrapConfigurationUri(routeInfo, runtimeEnvironment, runtimeParams) {
+  const encodeUrl = encodeURIComponent(routeInfo.url);
+  const configUrlPrefix = getClientBootstrapConfigurationUriPrefix(routeInfo, runtimeEnvironment, runtimeParams);
+  return `${configUrlPrefix}/${encodeUrl}${CONFIG_SUFFIX}`;
+}
+function getClientBootstrapConfigurationUriPrefix(routeInfo, runtimeEnvironment, runtimeParams) {
+  const {apiVersion, format} = runtimeEnvironment;
+  const {id} = routeInfo;
+  const locale = runtimeParams?.locale;
+  const environment = runtimeParams?.environment;
+  if (locale && environment) {
+    return `/${apiVersion}/application/${format}/l/${locale}/e/${environment}/ai/${id}/configuration/ci`;
+  } else if (locale) {
+    return `/${apiVersion}/application/${format}/l/${locale}/ai/${id}/configuration/ci`;
+  } else if (environment) {
+    return `/${apiVersion}/application/${format}/e/${environment}/ai/${id}/configuration/ci`;
+  } else {
+    return `/${apiVersion}/application/${format}/ai/${id}/configuration/ci`;
+  }
+}
+function removeClientBootstrapConfigurationSuffix(url) {
+  let ret = url;
+  if (url.endsWith(CONFIG_SUFFIX)) {
+    ret = url.slice(0, -CONFIG_SUFFIX.length);
+  }
+  return ret;
+}
+function getClientBootstrapConfigurationRoutes() {
+  return [
+    `/:apiVersion/application/:format/l/:locale/ai/:appId/configuration/ci/:encodedViewPath${CONFIG_SUFFIX}`,
+    `/:apiVersion/application/:format/l/:locale/e/:environment/ai/:appId/configuration/ci/:encodedViewPath${CONFIG_SUFFIX}`,
+    `/:apiVersion/application/:format/ai/:appId/configuration/ci/:encodedViewPath${CONFIG_SUFFIX}`,
+    `/:apiVersion/application/:format/e/:environment/ai/:appId/configuration/ci/:encodedViewPath${CONFIG_SUFFIX}`
+  ];
+}
+function extractRequestParams(parameterizedRoute, resolvedUrl, existingParams) {
+  const keys = [];
+  const re = (0, import_path_to_regexp.pathToRegexp)(parameterizedRoute, keys);
+  const params = existingParams || {};
+  if (keys.length > 0) {
+    const result = re.exec(resolvedUrl) || new Array(keys.length);
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i].name;
+      const value = result[i + 1];
+      params[key] = value;
+    }
+  }
+  return params;
+}

package/build/es/index.d.ts

@@ -9,5 +9,6 @@ export * from './import-metadata.js';
 export * from './graph.js';
 export * from './mappings.js';
 export * from './metrics.js';
+export * from './urls.js';
 export * from './env.js';
 //# sourceMappingURL=index.d.ts.map

package/build/es/index.js

@@ -9,5 +9,6 @@ export * from './import-metadata.js';
 export * from './graph.js';
 export * from './mappings.js';
 export * from './metrics.js';
+export * from './urls.js';
 export * from './env.js';
 //# sourceMappingURL=index.js.map

package/build/es/urls.d.ts

@@ -0,0 +1,29 @@
+import { RuntimeEnvironment, RuntimeParams } from '@lwrjs/types';
+export declare function getClientBootstrapConfigurationUri(routeInfo: {
+    id: string;
+    url: string;
+}, runtimeEnvironment: Required<Pick<RuntimeEnvironment, 'apiVersion' | 'format'>>, runtimeParams?: RuntimeParams): string;
+export declare function getClientBootstrapConfigurationUriPrefix(routeInfo: {
+    id: string;
+}, runtimeEnvironment: Required<Pick<RuntimeEnvironment, 'apiVersion' | 'format'>>, runtimeParams?: RuntimeParams): string;
+/**
+ * Remove the suffix from config
+ */
+export declare function removeClientBootstrapConfigurationSuffix(url: string): string;
+/**
+ * Get the parameterized client bootstrap app configuration routes
+ */
+export declare function getClientBootstrapConfigurationRoutes(): string[];
+/**
+ * Extract param values from a resolved URL based on a parameterized route.  Keep existing param values.
+ * Uses path-to-regexp to match -> https://www.npmjs.com/package/path-to-regexp
+ *
+ * extractRequestParams('/:p1/:p2*', '/foo/bar/barz', {e1:'v1'}) => {e1:'v1', p1:'foo', p2:'bar/barz'}
+ *
+ * @param parameterizedRoute - A Url with parameter tokens
+ * @param resolvedUrl - A url with tokens filled in to match against
+ * @param existingParams - optional existing request parameters to match against
+ * @returns A parameter maps with existing parameters plus token value pairs from route and url
+ */
+export declare function extractRequestParams(parameterizedRoute: string, resolvedUrl: string, existingParams?: Record<string, string>): Record<string, string>;
+//# sourceMappingURL=urls.d.ts.map

package/build/es/urls.js

@@ -0,0 +1,73 @@
+import { pathToRegexp } from 'path-to-regexp';
+const CONFIG_SUFFIX = '/config.js';
+export function getClientBootstrapConfigurationUri(routeInfo, runtimeEnvironment, runtimeParams) {
+    const encodeUrl = encodeURIComponent(routeInfo.url);
+    const configUrlPrefix = getClientBootstrapConfigurationUriPrefix(routeInfo, runtimeEnvironment, runtimeParams);
+    return `${configUrlPrefix}/${encodeUrl}${CONFIG_SUFFIX}`;
+}
+export function getClientBootstrapConfigurationUriPrefix(routeInfo, runtimeEnvironment, runtimeParams) {
+    const { apiVersion, format } = runtimeEnvironment;
+    const { id } = routeInfo;
+    const locale = runtimeParams?.locale;
+    const environment = runtimeParams?.environment;
+    if (locale && environment) {
+        return `/${apiVersion}/application/${format}/l/${locale}/e/${environment}/ai/${id}/configuration/ci`;
+    }
+    else if (locale) {
+        return `/${apiVersion}/application/${format}/l/${locale}/ai/${id}/configuration/ci`;
+    }
+    else if (environment) {
+        return `/${apiVersion}/application/${format}/e/${environment}/ai/${id}/configuration/ci`;
+    }
+    else {
+        return `/${apiVersion}/application/${format}/ai/${id}/configuration/ci`;
+    }
+}
+/**
+ * Remove the suffix from config
+ */
+export function removeClientBootstrapConfigurationSuffix(url) {
+    let ret = url;
+    if (url.endsWith(CONFIG_SUFFIX)) {
+        ret = url.slice(0, -CONFIG_SUFFIX.length);
+    }
+    return ret;
+}
+/**
+ * Get the parameterized client bootstrap app configuration routes
+ */
+export function getClientBootstrapConfigurationRoutes() {
+    return [
+        `/:apiVersion/application/:format/l/:locale/ai/:appId/configuration/ci/:encodedViewPath${CONFIG_SUFFIX}`,
+        `/:apiVersion/application/:format/l/:locale/e/:environment/ai/:appId/configuration/ci/:encodedViewPath${CONFIG_SUFFIX}`,
+        `/:apiVersion/application/:format/ai/:appId/configuration/ci/:encodedViewPath${CONFIG_SUFFIX}`,
+        `/:apiVersion/application/:format/e/:environment/ai/:appId/configuration/ci/:encodedViewPath${CONFIG_SUFFIX}`,
+    ];
+}
+/**
+ * Extract param values from a resolved URL based on a parameterized route.  Keep existing param values.
+ * Uses path-to-regexp to match -> https://www.npmjs.com/package/path-to-regexp
+ *
+ * extractRequestParams('/:p1/:p2*', '/foo/bar/barz', {e1:'v1'}) => {e1:'v1', p1:'foo', p2:'bar/barz'}
+ *
+ * @param parameterizedRoute - A Url with parameter tokens
+ * @param resolvedUrl - A url with tokens filled in to match against
+ * @param existingParams - optional existing request parameters to match against
+ * @returns A parameter maps with existing parameters plus token value pairs from route and url
+ */
+export function extractRequestParams(parameterizedRoute, resolvedUrl, existingParams) {
+    const keys = [];
+    const re = pathToRegexp(parameterizedRoute, keys);
+    const params = existingParams || {};
+    if (keys.length > 0) {
+        const result = re.exec(resolvedUrl) || new Array(keys.length);
+        for (let i = 0; i < keys.length; i++) {
+            const key = keys[i].name;
+            // result array if [url, value, value] so add 1 to count to get matching value
+            const value = result[i + 1];
+            params[key] = value;
+        }
+    }
+    return params;
+}
+//# sourceMappingURL=urls.js.map

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.5.7",
+    "version": "0.5.11-236-1",
     "homepage": "https://lwr.dev/",
     "repository": {
         "type": "git",
@@ -41,11 +41,11 @@
         "slugify": "^1.4.5"
     },
     "devDependencies": {
-        "@lwrjs/diagnostics": "0.5.7",
-        "@lwrjs/types": "0.5.7"
+        "@lwrjs/diagnostics": "0.5.11-236-1",
+        "@lwrjs/types": "0.5.11-236-1",
+        "@types/path-to-regexp": "^1.7.0"
     },
     "engines": {
         "node": ">=14.15.4 <17"
-    },
-    "gitHead": "406dbaa1c1f7a08b067e47c1c01d0b5295df3e5b"
+    }
 }

package/LICENSE

@@ -1,10 +0,0 @@
-MIT LICENSE
-
-Copyright (c) 2020, Salesforce.com, Inc.
-All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.