@lwrjs/shared-utils 0.17.2-alpha.10 → 0.17.2-alpha.12

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/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/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.17.2-alpha.10",
+    "version": "0.17.2-alpha.12",
     "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.10",
+        "@lwrjs/diagnostics": "0.17.2-alpha.12",
         "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.10",
+        "@lwrjs/types": "0.17.2-alpha.12",
         "@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": "3938f97f31973d7953bb61cff8388c71980c22c7"
+    "gitHead": "f5d7c20e7aec008c06db8d5e289c8cb1e3467005"
 }