@salesforce/lds-runtime-webruntime 1.369.0 → 1.371.0

package/dist/ldsWebruntimeOneStoreInit.js

@@ -15,8 +15,11 @@
 import { getInstrumentation } from 'o11y/client';
 import { setServices } from 'force/luvioServiceProvisioner1';
 export { default, resolve, setServices } from 'force/luvioServiceProvisioner1';
-import { executeGlobalControllerRawResponse } from 'aura';
 import { getSfapJwt } from 'force/clwrSfapExchange';
+import language from '@salesforce/i18n/lang';
+import isDesignMode from '@app/isDesignMode';
+import isPreviewMode from '@app/isPreviewMode';
+import authenticationCookieName from '@app/authenticationCookieName';
 
 /*!
  * Copyright (c) 2022, Salesforce, Inc.,
@@ -483,6 +486,38 @@ function setOverlaps(setA, setB) {
   }
   return false;
 }
+class CacheControlRequestRunner {
+  constructor(readFromCache, requestFromNetwork, writeToCache) {
+    this.readFromCacheInternal = readFromCache;
+    this.requestFromNetworkInternal = requestFromNetwork;
+    this.writeToCacheInternal = writeToCache;
+  }
+  readFromCache(cache) {
+    const resultPromise = this.readFromCacheInternal(cache);
+    return resultPromise.then((result) => {
+      if (result.isErr()) {
+        return err(result.error);
+      }
+      this.returnData = result;
+      return ok$1(void 0);
+    });
+  }
+  requestFromNetwork() {
+    const that = this;
+    return async function* () {
+      const result = await that.requestFromNetworkInternal();
+      if (result.isErr()) {
+        that.networkError = result;
+      } else {
+        that.networkData = result;
+      }
+      yield result;
+    }();
+  }
+  writeToCache(cache, networkResult) {
+    return this.writeToCacheInternal(cache, networkResult);
+  }
+}
 class CacheControlCommand extends BaseCommand {
   constructor(services) {
     super();
@@ -502,57 +537,48 @@ class CacheControlCommand extends BaseCommand {
       this.cacheControlStrategyConfig,
       overrides
     );
-    let returnData;
-    let returnError;
-    const requestRunner = {
-      readFromCache: (cache) => {
-        const resultPromise2 = this.buildResultWithSubscribe(cache);
-        return resultPromise2.then((result) => {
-          if (result.isErr()) {
-            return err(result.error);
-          }
-          returnData = result;
-          return ok$1(void 0);
-        });
-      },
-      requestFromNetwork: () => {
-        const that = this;
-        return async function* () {
-          const result = await that.requestFromNetwork();
-          if (result.isErr()) {
-            returnError = result;
-          }
-          yield result;
-        }();
-      },
-      writeToCache: (cache, networkResult) => {
-        return this.writeToCacheAndRecordKeys(cache, networkResult);
-      }
-    };
+    const requestRunner = this.buildRequestRunner();
     const resultPromise = this.services.cacheController.execute(mergedCacheControlConfig, requestRunner, {
       instrumentationAttributes: this.instrumentationAttributes
     });
     return resultPromise.then((result) => {
-      return this.publishUpdatedKeys().then(() => {
-        if (returnError) {
-          return returnError;
-        }
-        if (result.isErr()) {
-          return err(result.error);
-        }
-        if (this.subscriptions.length > 0) {
-          this.subscribeToKeysUsed();
-        }
-        if (returnData === void 0) {
-          return err(new Error("Cache miss after fetching from network"));
+      return this.handleCacheControllerResult(result, requestRunner);
+    });
+  }
+  handleCacheControllerResult(result, requestRunner) {
+    const { networkError, networkData, returnData } = requestRunner;
+    return this.publishUpdatedKeys().then(() => {
+      if (networkError) {
+        return networkError;
+      }
+      if (result.isErr()) {
+        if (networkData) {
+          return this.constructSubscribableResult(networkData.value);
         }
-        if (returnData.isOk() && this.lastEmittedData === void 0) {
-          this.lastEmittedData = returnData.value.data;
+        return err(result.error);
+      }
+      if (this.subscriptions.length > 0) {
+        this.subscribeToKeysUsed();
+      }
+      if (returnData === void 0) {
+        if (networkData) {
+          return this.constructSubscribableResult(networkData.value);
         }
-        return returnData;
-      });
+        return err(new Error("Cache miss after fetching from network"));
+      }
+      if (returnData.isOk() && this.lastEmittedData === void 0) {
+        this.lastEmittedData = returnData.value.data;
+      }
+      return returnData;
     });
   }
+  buildRequestRunner() {
+    return new CacheControlRequestRunner(
+      (cache) => this.buildResultWithSubscribe(cache),
+      () => this.requestFromNetwork(),
+      (cache, networkResult) => this.writeToCacheAndRecordKeys(cache, networkResult)
+    );
+  }
   publishUpdatedKeys() {
     if (this.services.pubSub) {
       if (this.keysUpdated !== void 0 && this.keysUpdated.size > 0) {
@@ -623,14 +649,18 @@ class CacheControlCommand extends BaseCommand {
       } else {
         const data = readResult.value;
         this.keysUsed = recordableCache.keysRead;
-        return ok$1({
-          data,
-          subscribe: this.buildSubscribe(),
-          refresh: () => this.refresh()
-        });
+        return this.constructSubscribableResult(data);
       }
     });
   }
+  constructSubscribableResult(data) {
+    return ok$1({
+      data,
+      // this cast is in case we need to return Network data as a fallback for caching errors
+      subscribe: this.buildSubscribe(),
+      refresh: () => this.refresh()
+    });
+  }
   /**
    * Builds a function that subscribes to cache changes via the pubsub service. Whenever
    * relevant cache updates occur, it re-reads the data and compares it against
@@ -2784,6 +2814,75 @@ const platformSfapJwtResolver = {
     },
 };
 
+const METHODS_WITH_CSRF = ['POST', 'PATCH', 'PUT', 'DELETE'];
+/**
+ * Webruntime request interceptor that modifies outgoing HTTP requests with standard
+ * query parameters and security headers. This ensures the api calls for onestore adapters
+ * follow the same pattern as the equivalent luvio api calls for all CLWR endpoints.
+ *
+ * This interceptor:
+ * - Adds language query parameter from i18n settings
+ * - Adds asGuest parameter based on design/preview mode and SID cookie presence
+ * - Adds htmlEncode=false query parameter (since this is an api call by definition)
+ * - For POST/PATCH/PUT/DELETE requests, adds CSRF token to headers
+ *
+ * @param {FetchParameters} args - The fetch parameters array containing [url, requestInit]
+ * @returns Promise-like resolved with the modified fetch parameters
+ *
+ * @example
+ * ```typescript
+ * const modifiedArgs = await webruntimeRequestInterceptor(['/api/data', { method: 'GET' }]);
+ * // URL will have ?language=en_US&asGuest=false&htmlEncode=false appended
+ * ```
+ */
+async function webruntimeRequestInterceptor(args) {
+    const [url, requestInit] = args;
+    if (!(typeof url === 'string' || url instanceof URL)) {
+        return resolvedPromiseLike$3(args);
+    }
+    const urlObj = url instanceof URL ? url : new URL(url, location?.href);
+    urlObj.searchParams.append('language', language);
+    urlObj.searchParams.append('asGuest', getAsGuestParamValue().toString());
+    urlObj.searchParams.append('htmlEncode', 'false');
+    // Update the args array with the modified URL string
+    args[0] = urlObj;
+    if (requestInit?.method && METHODS_WITH_CSRF.includes(requestInit.method)) {
+        await addCSRFToken(requestInit);
+    }
+    return resolvedPromiseLike$3(args);
+}
+function hasSidCookie() {
+    const cookies = document.cookie.split(';');
+    return cookies.some((cookie) => {
+        const [name] = cookie.trim().split('=');
+        return name === authenticationCookieName;
+    });
+}
+function getAsGuestParamValue() {
+    // authenticationCookieName (__Secure-has-sid) is set in design mode or preview mode
+    if (isDesignMode || isPreviewMode) {
+        return false;
+    }
+    return !hasSidCookie();
+}
+async function addCSRFToken(params) {
+    const { csrfToken } = await getUser();
+    if (!params.headers) {
+        params.headers = {};
+    }
+    if (csrfToken) {
+        params.headers['CSRF-Token'] = csrfToken;
+    }
+}
+async function getUser() {
+    if (typeof window === 'undefined') {
+        // always make API calls as guest on the server
+        return { isGuest: true, id: null, csrfToken: null };
+    }
+    const { default: user } = await import('@app/user');
+    return user;
+}
+
 const SFAP_BASE_URL = 'api.salesforce.com';
 const sfapJwtRepository = new JwtRepository();
 const sfapJwtManager = new JwtManager(sfapJwtRepository, platformSfapJwtResolver);
@@ -2850,8 +2949,8 @@ function buildCopilotFetchServiceDescriptor(logger) {
         tags: { specialHacksFor: 'copilot' },
     };
 }
-function buildUnauthorizedFetchServiceDescriptor() {
-    const fetchService = buildServiceDescriptor();
+function buildDefaultFetchServiceDescriptor() {
+    const fetchService = buildServiceDescriptor({ request: [webruntimeRequestInterceptor] });
     return {
         ...fetchService,
         tags: { authenticationScopes: '' },
@@ -2880,23 +2979,15 @@ function buildJwtRequestInterceptor(logger) {
     return jwtRequestHeaderInterceptor;
 }
 
-function buildAuraNetworkService() {
-    return {
-        type: 'auraNetwork',
-        version: '1.0',
-        service: executeGlobalControllerRawResponse,
-    };
-}
 const loggerService = new ConsoleLogger$1('ERROR');
 const cacheServiceDescriptor = buildServiceDescriptor$4();
 const instrumentationServiceDescriptor = buildServiceDescriptor$5(loggerService);
 const inMemoryCacheInclusionPolicyServiceDescriptor = buildInMemoryCacheInclusionPolicyService(cacheServiceDescriptor.service);
 const services = [
     instrumentationServiceDescriptor,
-    buildUnauthorizedFetchServiceDescriptor(),
+    buildDefaultFetchServiceDescriptor(),
     buildJwtAuthorizedSfapFetchServiceDescriptor(loggerService),
     buildCopilotFetchServiceDescriptor(loggerService),
-    buildAuraNetworkService(),
     buildServiceDescriptor$6(instrumentationServiceDescriptor.service),
     buildServiceDescriptor$3(cacheServiceDescriptor.service, inMemoryCacheInclusionPolicyServiceDescriptor.service),
     buildServiceDescriptor$d(),
@@ -2911,4 +3002,4 @@ const services = [
     buildServiceDescriptor$2(),
 ];
 setServices(services);
-// version: 1.369.0-b61b56bd49
+// version: 1.371.0-e11a80989c

package/dist/types/interceptors.d.ts

@@ -0,0 +1,22 @@
+import { type FetchParameters } from '@luvio/service-fetch-network/v1';
+/**
+ * Webruntime request interceptor that modifies outgoing HTTP requests with standard
+ * query parameters and security headers. This ensures the api calls for onestore adapters
+ * follow the same pattern as the equivalent luvio api calls for all CLWR endpoints.
+ *
+ * This interceptor:
+ * - Adds language query parameter from i18n settings
+ * - Adds asGuest parameter based on design/preview mode and SID cookie presence
+ * - Adds htmlEncode=false query parameter (since this is an api call by definition)
+ * - For POST/PATCH/PUT/DELETE requests, adds CSRF token to headers
+ *
+ * @param {FetchParameters} args - The fetch parameters array containing [url, requestInit]
+ * @returns Promise-like resolved with the modified fetch parameters
+ *
+ * @example
+ * ```typescript
+ * const modifiedArgs = await webruntimeRequestInterceptor(['/api/data', { method: 'GET' }]);
+ * // URL will have ?language=en_US&asGuest=false&htmlEncode=false appended
+ * ```
+ */
+export declare function webruntimeRequestInterceptor(args: FetchParameters): Promise<[input: RequestInfo | URL, init?: RequestInit | undefined]>;

package/dist/types/jwt-authorized-fetch-service.d.ts

@@ -7,4 +7,4 @@ export declare function buildJwtAuthorizedSfapFetchServiceDescriptor(logger: Log
  * copilot commands.
  */
 export declare function buildCopilotFetchServiceDescriptor(logger: LoggerService): FetchServiceDescriptor;
-export declare function buildUnauthorizedFetchServiceDescriptor(): FetchServiceDescriptor;
+export declare function buildDefaultFetchServiceDescriptor(): FetchServiceDescriptor;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-webruntime",
-    "version": "1.369.0",
+    "version": "1.371.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS engine for Webruntime runtime",
     "main": "dist/ldsWebruntimeOneStoreInit.js",
@@ -35,33 +35,33 @@
         "ready": "yarn build && jest --collectCoverage && yarn test:size && yarn release:corejar"
     },
     "devDependencies": {
-        "@luvio/service-provisioner": "5.43.1",
-        "@luvio/tools-core": "5.43.1",
+        "@luvio/service-provisioner": "5.44.0",
+        "@luvio/tools-core": "5.44.0",
         "jwt-encode": "1.0.1"
     },
     "dependencies": {
-        "@luvio/command-aura-network": "5.43.1",
-        "@luvio/command-aura-normalized-cache-control": "5.43.1",
-        "@luvio/command-aura-resource-cache-control": "5.43.1",
-        "@luvio/command-fetch-network": "5.43.1",
-        "@luvio/command-http-normalized-cache-control": "5.43.1",
-        "@luvio/command-ndjson": "5.43.1",
-        "@luvio/command-network": "5.43.1",
-        "@luvio/command-sse": "5.43.1",
-        "@luvio/command-streaming": "5.43.1",
-        "@luvio/jwt-manager": "5.43.1",
+        "@luvio/command-aura-network": "5.44.0",
+        "@luvio/command-aura-normalized-cache-control": "5.44.0",
+        "@luvio/command-aura-resource-cache-control": "5.44.0",
+        "@luvio/command-fetch-network": "5.44.0",
+        "@luvio/command-http-normalized-cache-control": "5.44.0",
+        "@luvio/command-ndjson": "5.44.0",
+        "@luvio/command-network": "5.44.0",
+        "@luvio/command-sse": "5.44.0",
+        "@luvio/command-streaming": "5.44.0",
+        "@luvio/jwt-manager": "5.44.0",
         "@luvio/network-adapter-composable": "0.158.7",
         "@luvio/network-adapter-fetch": "0.158.7",
-        "@luvio/service-aura-network": "5.43.1",
-        "@luvio/service-cache": "5.43.1",
-        "@luvio/service-cache-control": "5.43.1",
-        "@luvio/service-cache-inclusion-policy": "5.43.1",
-        "@luvio/service-fetch-network": "5.43.1",
-        "@luvio/service-instrument-command": "5.43.1",
-        "@luvio/service-pubsub": "5.43.1",
-        "@luvio/service-store": "5.43.1",
-        "@luvio/utils": "5.43.1",
-        "@salesforce/lds-adapters-uiapi-lex": "^1.369.0"
+        "@luvio/service-aura-network": "5.44.0",
+        "@luvio/service-cache": "5.44.0",
+        "@luvio/service-cache-control": "5.44.0",
+        "@luvio/service-cache-inclusion-policy": "5.44.0",
+        "@luvio/service-fetch-network": "5.44.0",
+        "@luvio/service-instrument-command": "5.44.0",
+        "@luvio/service-pubsub": "5.44.0",
+        "@luvio/service-store": "5.44.0",
+        "@luvio/utils": "5.44.0",
+        "@salesforce/lds-adapters-uiapi-lex": "^1.371.0"
     },
     "luvioBundlesize": [
         {