@lwrjs/shared-utils 0.17.2-alpha.1 → 0.17.2-alpha.11

package/build/cjs/env.cjs

@@ -8,8 +8,12 @@ var __export = (target, all) => {
 // packages/@lwrjs/shared-utils/src/env.ts
 __markAsModule(exports);
 __export(exports, {
+  B3_TRACE_ID: () => B3_TRACE_ID,
+  CORRELATION_ID: () => CORRELATION_ID,
+  MRT_REQUEST_CLASS: () => MRT_REQUEST_CLASS,
   REQUEST_DEPTH_HEADER: () => REQUEST_DEPTH_HEADER,
-  REQUEST_DEPTH_KEY: () => REQUEST_DEPTH_KEY,
+  ROUTE_CORE_HEADER: () => ROUTE_CORE_HEADER,
+  TRUE_CLIENT_IP: () => TRUE_CLIENT_IP,
   buildEnvironmentContext: () => buildEnvironmentContext,
   getFeatureFlags: () => getFeatureFlags,
   isLambdaEnv: () => isLambdaEnv,
@@ -64,11 +68,15 @@ function buildEnvironmentContext(runtimeParams) {
     uiBasePath
   };
 }
-var REQUEST_DEPTH_HEADER = "X-SFDC-Request-Depth";
-var REQUEST_DEPTH_KEY = REQUEST_DEPTH_HEADER.toLowerCase();
+var TRUE_CLIENT_IP = "true-client-ip";
+var B3_TRACE_ID = "x-b3-traceid";
+var CORRELATION_ID = "x-correlation-id";
+var MRT_REQUEST_CLASS = "x-mobify-request-class";
+var ROUTE_CORE_HEADER = "x-sfdc-route-core";
+var REQUEST_DEPTH_HEADER = "x-sfdc-request-depth";
 function parseRequestDepth(headers = {}, query = {}) {
   let maxDepth = 0;
-  const value = headers && headers[REQUEST_DEPTH_KEY];
+  const value = headers && headers[REQUEST_DEPTH_HEADER];
   if (value) {
     if (Array.isArray(value)) {
       for (const depth of value) {
@@ -86,8 +94,8 @@ function parseRequestDepth(headers = {}, query = {}) {
       }
     }
   }
-  if (query[REQUEST_DEPTH_KEY]) {
-    const queryValue = parseInt(query[REQUEST_DEPTH_KEY], 10);
+  if (query[REQUEST_DEPTH_HEADER]) {
+    const queryValue = parseInt(query[REQUEST_DEPTH_HEADER], 10);
     if (!isNaN(queryValue) && queryValue > maxDepth) {
       maxDepth = queryValue;
     }

package/build/cjs/fs.cjs

@@ -168,9 +168,7 @@ function normalizeResourcePath(rawPath, {rootDir, assets, contentDir, layoutsDir
   return rawPath.replace(RESOURCE_DIR_REGEX, function(fullMatch, m1, m2) {
     const alias = assetsMap[m1] || assetsMap[m2];
     if (!alias && !allowUnresolvedAlias) {
-      throw (0, import_diagnostics.createSingleDiagnosticError)({
-        description: import_diagnostics.descriptions.UNRESOLVABLE.DIR_ALIAS(fullMatch)
-      }, import_diagnostics.LwrUnresolvableError);
+      throw new import_diagnostics.LwrUnresolvableError(import_diagnostics.descriptions.UNRESOLVABLE.DIR_ALIAS(fullMatch), "asset");
     }
     return alias;
   });

package/build/cjs/graph.cjs

@@ -112,9 +112,7 @@ async function getModuleGraphs(specifier, options, moduleRegistry, defRegistry,
   };
   const moduleDef = isBundler(defRegistry) ? await defRegistry.getModuleBundle(versionedModuleId, runtimeEnvironment, runtimeParams) : await defRegistry.getModule(versionedModuleId, runtimeParams);
   if (!moduleDef) {
-    throw (0, import_diagnostics.createSingleDiagnosticError)({
-      description: import_diagnostics.descriptions.UNRESOLVABLE.MODULE_ENTRY(versionedModuleId.specifier)
-    }, import_diagnostics.LwrUnresolvableError);
+    throw new import_diagnostics.LwrUnresolvableError(import_diagnostics.descriptions.UNRESOLVABLE.MODULE_ENTRY(versionedModuleId.specifier), "module");
   }
   const flattened = [];
   await traverse(moduleDef, depth, flattened, 0, acc, defRegistry, runtimeEnvironment, runtimeParams);

package/build/cjs/identity.cjs

@@ -95,7 +95,7 @@ function explodeSpecifier(rawSpecifier) {
   const name = rawName ? [rawName, ...remaining].join("/") : rawNamespace;
   return {
     specifier: importee,
-    namespace,
+    namespace: namespace || "",
     name,
     version: version ? normalizeVersionFromUri(version) : version
   };

package/build/cjs/urls.cjs

@@ -33,7 +33,8 @@ __export(exports, {
   getViewUri: () => getViewUri,
   isModuleOrBundleUrl: () => isModuleOrBundleUrl,
   isURL: () => isURL,
-  removeClientBootstrapConfigurationSuffix: () => removeClientBootstrapConfigurationSuffix
+  removeClientBootstrapConfigurationSuffix: () => removeClientBootstrapConfigurationSuffix,
+  toHostname: () => toHostname
 });
 var import_path_to_regexp = __toModule(require("path-to-regexp"));
 var import_path = __toModule(require("path"));
@@ -138,3 +139,6 @@ function crossEnvFileURL(url) {
   }
   return url;
 }
+function toHostname(url) {
+  return url.replace(/^https?:\/\//, "").replace(/:(\d+)(?=[/.]|$)/, "");
+}

package/build/es/env.d.ts

@@ -16,7 +16,11 @@ export declare function isLocalDev(): boolean;
  * Create a serializable context for user-land exposed environment variables
  */
 export declare function buildEnvironmentContext(runtimeParams: RuntimeParams): EnvironmentContext;
-export declare const REQUEST_DEPTH_HEADER = "X-SFDC-Request-Depth";
-export declare const REQUEST_DEPTH_KEY: string;
+export declare const TRUE_CLIENT_IP = "true-client-ip";
+export declare const B3_TRACE_ID = "x-b3-traceid";
+export declare const CORRELATION_ID = "x-correlation-id";
+export declare const MRT_REQUEST_CLASS = "x-mobify-request-class";
+export declare const ROUTE_CORE_HEADER = "x-sfdc-route-core";
+export declare const REQUEST_DEPTH_HEADER = "x-sfdc-request-depth";
 export declare function parseRequestDepth(headers?: Headers, query?: Record<string, string>): number;
 //# sourceMappingURL=env.d.ts.map

package/build/es/env.js

@@ -89,11 +89,17 @@ export function buildEnvironmentContext(runtimeParams) {
         uiBasePath,
     };
 }
-export const REQUEST_DEPTH_HEADER = 'X-SFDC-Request-Depth';
-export const REQUEST_DEPTH_KEY = REQUEST_DEPTH_HEADER.toLowerCase();
+// headers used by LWR-Node and LWR@MRT
+export const TRUE_CLIENT_IP = 'true-client-ip'; // public IP of the original request source, eg: 13.123.12.3
+export const B3_TRACE_ID = 'x-b3-traceid'; // trace ID shared across service boundaries for a page request, eg: 463ac35c9f6413ad48485a3953bb6124
+export const CORRELATION_ID = 'x-correlation-id'; // shared correlation ID for the request
+export const MRT_REQUEST_CLASS = 'x-mobify-request-class'; // contains the site base path, eg: basePath=/mysite
+export const ROUTE_CORE_HEADER = 'x-sfdc-route-core'; // helps route requests to Core efficiently, value: true
+export const REQUEST_DEPTH_HEADER = 'x-sfdc-request-depth'; // tracks the request depth to prevent cycles to the LWR server, eg: 2
+// standard headers: Forwarded (eg: host=dev.testing.com;proto=https), Host (eg: darrell.sandbox.my.site.com), Cookie (holds the SID for auth'ed requests)
 export function parseRequestDepth(headers = {}, query = {}) {
     let maxDepth = 0;
-    const value = headers && headers[REQUEST_DEPTH_KEY];
+    const value = headers && headers[REQUEST_DEPTH_HEADER];
     if (value) {
         if (Array.isArray(value)) {
             for (const depth of value) {
@@ -112,8 +118,8 @@ export function parseRequestDepth(headers = {}, query = {}) {
             }
         }
     }
-    if (query[REQUEST_DEPTH_KEY]) {
-        const queryValue = parseInt(query[REQUEST_DEPTH_KEY], 10);
+    if (query[REQUEST_DEPTH_HEADER]) {
+        const queryValue = parseInt(query[REQUEST_DEPTH_HEADER], 10);
         if (!isNaN(queryValue) && queryValue > maxDepth) {
             maxDepth = queryValue;
         }

package/build/es/fs.js

@@ -3,7 +3,7 @@ import pathLib from 'path';
 import url from 'url';
 import crypto from 'crypto';
 import { slugify } from './identity.js';
-import { LwrUnresolvableError, createSingleDiagnosticError, descriptions } from '@lwrjs/diagnostics';
+import { LwrUnresolvableError, descriptions } from '@lwrjs/diagnostics';
 import { lookup } from 'mime-types';
 import { Readable } from 'stream';
 import { logger } from '@lwrjs/diagnostics';
@@ -185,9 +185,7 @@ export function normalizeResourcePath(rawPath, { rootDir, assets, contentDir, la
     return rawPath.replace(RESOURCE_DIR_REGEX, function (fullMatch, m1, m2) {
         const alias = assetsMap[m1] || assetsMap[m2];
         if (!alias && !allowUnresolvedAlias) {
-            throw createSingleDiagnosticError({
-                description: descriptions.UNRESOLVABLE.DIR_ALIAS(fullMatch),
-            }, LwrUnresolvableError);
+            throw new LwrUnresolvableError(descriptions.UNRESOLVABLE.DIR_ALIAS(fullMatch), 'asset');
         }
         return alias;
     });

package/build/es/graph.js

@@ -1,5 +1,5 @@
 import { getSpecifier, getVersionedModuleId, isBundleDefinition } from './identity.js';
-import { LwrUnresolvableError, createSingleDiagnosticError, descriptions } from '@lwrjs/diagnostics';
+import { LwrUnresolvableError, descriptions } from '@lwrjs/diagnostics';
 import { ModuleNameType } from './import-metadata.js';
 export var GraphDepth;
 (function (GraphDepth) {
@@ -117,9 +117,7 @@ options, moduleRegistry, defRegistry, runtimeEnvironment, runtimeParams, visited
         ? await defRegistry.getModuleBundle(versionedModuleId, runtimeEnvironment, runtimeParams)
         : await defRegistry.getModule(versionedModuleId, runtimeParams);
     if (!moduleDef) {
-        throw createSingleDiagnosticError({
-            description: descriptions.UNRESOLVABLE.MODULE_ENTRY(versionedModuleId.specifier),
-        }, LwrUnresolvableError);
+        throw new LwrUnresolvableError(descriptions.UNRESOLVABLE.MODULE_ENTRY(versionedModuleId.specifier), 'module');
     }
     const flattened = [];
     await traverse(moduleDef, depth, flattened, 0, acc, defRegistry, runtimeEnvironment, runtimeParams);

package/build/es/identity.d.ts

@@ -43,6 +43,7 @@ export declare function prettyModuleUriSuffix(specifier: string): string;
  */
 interface PartialModuleId extends AbstractModuleId {
     name: string;
+    namespace: string;
 }
 export declare function explodeSpecifier(rawSpecifier: string): PartialModuleId;
 export declare function explodeSpecifiers(rawSpecifiers: string): PartialModuleId[];

package/build/es/identity.js

@@ -55,7 +55,7 @@ export function explodeSpecifier(rawSpecifier) {
     // Return an abstract ModuleIdentifier
     return {
         specifier: importee,
-        namespace,
+        namespace: namespace || '',
         name,
         version: version ? normalizeVersionFromUri(version) : version,
     };

package/build/es/urls.d.ts

@@ -38,4 +38,5 @@ export declare function getViewUri(routePath: string, basePath: string, locale:
  */
 export declare function isURL(uri: string): boolean;
 export declare function crossEnvFileURL(url: string): string;
+export declare function toHostname(url: string): string;
 //# sourceMappingURL=urls.d.ts.map

package/build/es/urls.js

@@ -139,4 +139,13 @@ export function crossEnvFileURL(url) {
     }
     return url;
 }
+// Remove the protocol and port from a URL to create a hostname
+// eg: url = https://developer.mozilla.org:4097/en-US/docs/Web/API/URL/hostname
+// protocol = https
+// port = 4097
+// host = developer.mozilla.org:4097
+// hostname = developer.mozilla.org
+export function toHostname(url) {
+    return url.replace(/^https?:\/\//, '').replace(/:(\d+)(?=[/.]|$)/, '');
+}
 //# sourceMappingURL=urls.js.map

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.17.2-alpha.1",
+    "version": "0.17.2-alpha.11",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -37,7 +37,7 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "@lwrjs/diagnostics": "0.17.2-alpha.1",
+        "@lwrjs/diagnostics": "0.17.2-alpha.11",
         "es-module-lexer": "^1.5.4",
         "fast-json-stable-stringify": "^2.1.0",
         "magic-string": "^0.30.9",
@@ -50,7 +50,7 @@
         "slugify": "^1.4.5"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.17.2-alpha.1",
+        "@lwrjs/types": "0.17.2-alpha.11",
         "@types/mime-types": "2.1.4",
         "@types/path-to-regexp": "^1.7.0",
         "memfs": "^4.13.0"
@@ -58,5 +58,5 @@
     "engines": {
         "node": ">=18.0.0"
     },
-    "gitHead": "bba15ca717a242b0375decaa378af06bdee813b5"
+    "gitHead": "72217912e6c17e617413044743892582be5599a0"
 }