@salesforce/lds-runtime-aura 1.322.0 → 1.323.0

package/dist/ldsEngineCreator.js

@@ -1215,6 +1215,35 @@ function buildServiceDescriptor$1(cache) {
     };
 }
 
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+/**
+ * Most-recently set of published services.
+ */
+let servicesAvailable;
+new Promise((resolve) => (servicesAvailable = resolve));
+/**
+ * Sets the services that will be used to satisfy calls to getServices().
+ * Any previously registered services are replaced with the services provided.
+ * Note overwriting services should be done with great care as previous callers
+ * of getServices() will not be aware of the new services.
+ *
+ * The default implementation provided by this module only supports a single
+ * set of active services. Runtime environments that require multiple sets of
+ * active services will need to override this module with their own
+ * implementation.
+ 
+ * @param services services to be used to satisfy future getServices() requests
+ */
+function setServices(services) {
+    resolvedPromiseLike(services);
+    servicesAvailable(services);
+}
+
 /**
  * Copyright (c) 2022, Salesforce, Inc.,
  * All rights reserved.
@@ -1722,27 +1751,8 @@ const SFAP_BASE_URL = 'api.salesforce.com';
 const sfapJwtRepository = new JwtRepository();
 const sfapJwtManager = new JwtManager(sfapJwtRepository, platformSfapJwtResolver);
 function buildJwtAuthorizedSfapFetchServiceDescriptor(logger) {
-    const jwtRequestModifier = ({ baseUri }, [resource, request]) => {
-        if (typeof resource !== 'string' && !(resource instanceof URL)) {
-            // istanbul ignore else: this will not be tested in NODE_ENV = production for test coverage
-            if (process.env.NODE_ENV !== 'production') {
-                throw new Error('SFAP fetch service expects a string or URL resource');
-            }
-            return [resource, request];
-        }
-        const overrideUrl = new URL(baseUri);
-        const url = typeof resource === 'string' ? new URL(resource) : new URL(resource.toString());
-        if (!(url.host === SFAP_BASE_URL)) {
-            logger.warn(`SFAP fetch service requires that the host of the resource is ${SFAP_BASE_URL}`);
-            return [resource, request];
-        }
-        url.host = overrideUrl.host;
-        url.protocol = overrideUrl.protocol;
-        return [url, request];
-    };
-    const jwtRequestHeaderInterceptor = buildJwtRequestHeaderInterceptor(sfapJwtManager, jwtRequestModifier);
     const jwtAuthorizedFetchService = buildServiceDescriptor({
-        request: [jwtRequestHeaderInterceptor],
+        request: [buildJwtRequestInterceptor(logger)],
     });
     return {
         ...jwtAuthorizedFetchService,
@@ -1779,10 +1789,13 @@ function buildCopilotFetchServiceDescriptor(logger) {
                     return resolvedPromiseLike(sfapJwtManager.getJwt()).then((token) => {
                         // replace the body's instanceConfig.endpoint with the JWT's iss value
                         const body = JSON.parse(requestInit.body);
-                        if (!body || !body.instanceConfig || !token.decodedInfo.iss) {
+                        if (!body || !token.decodedInfo || !token.decodedInfo.iss) {
                             logger.warn('skipping injection of endpoint into start session request');
                         }
                         else {
+                            if (!body.instanceConfig) {
+                                body.instanceConfig = {};
+                            }
                             body.instanceConfig.endpoint = token.decodedInfo.iss;
                         }
                         return [
@@ -1794,6 +1807,7 @@ function buildCopilotFetchServiceDescriptor(logger) {
                         ];
                     });
                 },
+                buildJwtRequestInterceptor(logger),
             ],
         }),
         tags: { specialHacksFor: 'copilot' },
@@ -1806,6 +1820,28 @@ function buildUnauthorizedFetchServiceDescriptor() {
         tags: { authenticationScopes: '' },
     };
 }
+function buildJwtRequestInterceptor(logger) {
+    const jwtRequestModifier = ({ baseUri }, [resource, request]) => {
+        if (typeof resource !== 'string' && !(resource instanceof URL)) {
+            // istanbul ignore else: this will not be tested in NODE_ENV = production for test coverage
+            if (process.env.NODE_ENV !== 'production') {
+                throw new Error('SFAP fetch service expects a string or URL resource');
+            }
+            return [resource, request];
+        }
+        const overrideUrl = new URL(baseUri);
+        const url = typeof resource === 'string' ? new URL(resource) : new URL(resource.toString());
+        if (!(url.host === SFAP_BASE_URL)) {
+            logger.warn(`SFAP fetch service requires that the host of the resource is ${SFAP_BASE_URL}`);
+            return [resource, request];
+        }
+        url.host = overrideUrl.host;
+        url.protocol = overrideUrl.protocol;
+        return [url, request];
+    };
+    const jwtRequestHeaderInterceptor = buildJwtRequestHeaderInterceptor(sfapJwtManager, jwtRequestModifier);
+    return jwtRequestHeaderInterceptor;
+}
 
 const PDL_EXECUTE_ASYNC_OPTIONS = {
     LOG_ERROR_ONLY: true,
@@ -1853,7 +1889,17 @@ const { create, keys, hasOwnProperty, entries } = Object;
 const { isArray, from } = Array;
 const { stringify } = JSON;
 
+// Note: exported enum for core usage.
+var PdlRequestPriority;
+(function (PdlRequestPriority) {
+    PdlRequestPriority[PdlRequestPriority["LOW"] = 0] = "LOW";
+    PdlRequestPriority[PdlRequestPriority["NORMAL"] = 1] = "NORMAL";
+    PdlRequestPriority[PdlRequestPriority["HIGH"] = 2] = "HIGH";
+})(PdlRequestPriority || (PdlRequestPriority = {}));
 class RequestStrategy {
+    getRequestPriority(_request, _context) {
+        return 1 /* RequestPriority.NORMAL */;
+    }
     /**
      * Perform any transformations required to prepare the request for saving.
      *
@@ -4065,6 +4111,39 @@ async function runRequestsWithLimit(requests, runner, concurrentRequestsLimit, p
     // Wait for all initial requests to complete
     await Promise.all(promises);
 }
+/**
+ * Compares two request entries based on their priority and, if the priorities are the same, their request times.
+ * This function is typically used for sorting requests where priority takes precedence, and timing is used
+ * as a secondary criterion. The function assumes that any necessary filtering of requests has already been done.
+ *
+ * @template Context - Extends `DefaultPageContext`, provides additional context for the request priority determination.
+ *
+ * @param {RequestEntry<LexRequest>} requestA - The first request entry containing the request and its metadata.
+ * @param {RequestEntry<LexRequest>} requestB - The second request entry containing the request and its metadata.
+ * @param {RequestStrategyManager} requestStrategyManager - Manager that provides access to request strategies based on adapter names.
+ * @param {Context} context - The context in which the requests are being compared, used to determine request priority.
+ *
+ * @returns {number} A negative number if the first request should come before the second, a positive number if the
+ *                   second should come before the first, or zero if they are considered equal for sorting purposes.
+ *                   This is determined first by the priority (higher priority comes first) and then by the request
+ *                   time (earlier request comes first) if priorities are the same. The priorities are fetched from
+ *                   the `requestStrategyManager` for each request's `adapterName`. If a strategy is not found,
+ *                   the priority defaults to `RequestPriority.LOW`.
+ */
+function compareByPriorityThenTime({ request: requestA, requestMetadata: requestMetadataA }, { request: requestB, requestMetadata: requestMetadataB }, requestStrategyManager, context) {
+    const aPriority = requestStrategyManager.get(requestA.adapterName)?.getRequestPriority(requestA, context) ||
+        0 /* RequestPriority.LOW */;
+    const bPriority = requestStrategyManager.get(requestB.adapterName)?.getRequestPriority(requestB, context) ||
+        0 /* RequestPriority.LOW */;
+    if (aPriority === bPriority) {
+        // when both requests have the same priority, use the request time in waterfall.
+        return requestMetadataA.requestTime - requestMetadataB.requestTime;
+    }
+    else {
+        // sort by priority, descending
+        return bPriority - aPriority;
+    }
+}
 
 function isBoxcarableRequest({ request: { adapterName } }, requestStrategyManager) {
     const strategy = requestStrategyManager.get(adapterName);
@@ -4117,20 +4196,22 @@ class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher {
         return [...exactPageRequests, ...similarPageRequests];
     }
     async predict() {
+        // perf: caching access, to avoid this.prop in loops.
+        const { requestStrategyManager, context } = this;
         const alwaysRequests = this.page.getAlwaysRunRequests();
         const pageRequests = this.getAllPageRequests();
         // IMPORTANT: Because there's no way to differentiate a cmpDef prediction from the page
         //            requesting the cmpDef, we need to predict cmpDefs before we start watching
         //            for predictions in the page. Having this code after an
         //            await will make the predictions to be saved as predictions too.
-        predictNonBoxcarableRequest(pageRequests.filter((r) => !isBoxcarableRequest(r, this.requestStrategyManager)), this.requestRunner);
+        predictNonBoxcarableRequest(pageRequests.filter((r) => !isBoxcarableRequest(r, requestStrategyManager)), this.requestRunner);
         const alwaysRequestEntries = alwaysRequests.map((request) => {
             return {
                 request,
                 requestMetadata: { requestTime: 0 }, // ensures always requests are executed, and executed first.
             };
         });
-        const boxcarablePredictions = pageRequests.filter((r) => isBoxcarableRequest(r, this.requestStrategyManager));
+        const boxcarablePredictions = pageRequests.filter((r) => isBoxcarableRequest(r, requestStrategyManager));
         const reducedPredictions = this.page.shouldReduceAlwaysRequestsWithPredictions()
             ? this.requestRunner.reduceRequests([...boxcarablePredictions, ...alwaysRequestEntries])
             : this.requestRunner.reduceRequests(boxcarablePredictions);
@@ -4138,7 +4219,7 @@ class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher {
             ? [...alwaysRequestEntries, ...reducedPredictions]
             : reducedPredictions)
             // Sorting in order requested
-            .sort((a, b) => a.requestMetadata.requestTime - b.requestMetadata.requestTime);
+            .sort((a, b) => compareByPriorityThenTime(a, b, requestStrategyManager, context));
         this.totalRequestCount = predictedRequestsWithLimit.length;
         await runRequestsWithLimit(predictedRequestsWithLimit, this.requestRunner, this.options.inflightRequestLimit, 
         // `this.repository.pageStartTime` would be the correct here,
@@ -4296,7 +4377,7 @@ function getEnvironmentSetting(name) {
     }
     return undefined;
 }
-// version: 1.322.0-87f682c9f3
+// version: 1.323.0-34d96539ec
 
 const forceRecordTransactionsDisabled = getEnvironmentSetting(EnvironmentSettings.ForceRecordTransactionsDisabled);
 //TODO: Some duplication here that can be most likely moved to a util class
@@ -4971,6 +5052,7 @@ function initializeOneStore() {
         buildServiceDescriptor$8(),
     ];
     serviceBroker.publish(services);
+    setServices(services);
 }
 function initializeOnestoreUiApiAdapters() {
     configuration.setGetObjectInfoAdapter(getObjectInfo);
@@ -4996,5 +5078,5 @@ function ldsEngineCreator() {
     return { name: 'ldsEngineCreator' };
 }
 
-export { LexRequestStrategy, buildPredictorForContext, ldsEngineCreator as default, initializeLDS, initializeOneStore, registerRequestStrategy, saveRequestAsPrediction, unregisterRequestStrategy, whenPredictionsReady };
-// version: 1.322.0-6aa042602a
+export { LexRequestStrategy, PdlRequestPriority, buildPredictorForContext, ldsEngineCreator as default, initializeLDS, initializeOneStore, registerRequestStrategy, saveRequestAsPrediction, unregisterRequestStrategy, whenPredictionsReady };
+// version: 1.323.0-ddaba12fc0

package/dist/types/main.d.ts

@@ -1,6 +1,7 @@
 import { type RecordHomePageContext } from './predictive-loading';
 import type { LexRequestStrategy } from './predictive-loading/request-strategy/lex-request-strategy';
 import { type LexRequest } from './predictive-loading/lex';
+export { PdlRequestPriority } from './predictive-loading';
 export { LexRequestStrategy } from './predictive-loading/request-strategy/lex-request-strategy';
 /**
  * Registers a request strategy to be utilized by PDL.

package/dist/types/predictive-loading/prefetcher/utils.d.ts

@@ -1,5 +1,8 @@
 import type { RequestRunner } from '../request-runner';
 import type { RequestEntry } from '../common';
+import type { LexRequest } from '../lex';
+import type { RequestStrategyManager } from '../request-strategy-manager/request-strategy-manager';
+import type { DefaultPageContext } from '../pages';
 /**
  * Runs a list of requests with a specified concurrency limit.
  *
@@ -14,3 +17,23 @@ import type { RequestEntry } from '../common';
  * Requests are only processed if their `requestTime` is less than the time elapsed since `pageStartTime`.
  */
 export declare function runRequestsWithLimit<Request>(requests: RequestEntry<Request>[], runner: RequestRunner<Request>, concurrentRequestsLimit: number, pageStartTime: number): Promise<void>;
+/**
+ * Compares two request entries based on their priority and, if the priorities are the same, their request times.
+ * This function is typically used for sorting requests where priority takes precedence, and timing is used
+ * as a secondary criterion. The function assumes that any necessary filtering of requests has already been done.
+ *
+ * @template Context - Extends `DefaultPageContext`, provides additional context for the request priority determination.
+ *
+ * @param {RequestEntry<LexRequest>} requestA - The first request entry containing the request and its metadata.
+ * @param {RequestEntry<LexRequest>} requestB - The second request entry containing the request and its metadata.
+ * @param {RequestStrategyManager} requestStrategyManager - Manager that provides access to request strategies based on adapter names.
+ * @param {Context} context - The context in which the requests are being compared, used to determine request priority.
+ *
+ * @returns {number} A negative number if the first request should come before the second, a positive number if the
+ *                   second should come before the first, or zero if they are considered equal for sorting purposes.
+ *                   This is determined first by the priority (higher priority comes first) and then by the request
+ *                   time (earlier request comes first) if priorities are the same. The priorities are fetched from
+ *                   the `requestStrategyManager` for each request's `adapterName`. If a strategy is not found,
+ *                   the priority defaults to `RequestPriority.LOW`.
+ */
+export declare function compareByPriorityThenTime<Context extends DefaultPageContext = DefaultPageContext>({ request: requestA, requestMetadata: requestMetadataA }: RequestEntry<LexRequest>, { request: requestB, requestMetadata: requestMetadataB }: RequestEntry<LexRequest>, requestStrategyManager: RequestStrategyManager, context: Context): number;

package/dist/types/predictive-loading/request-strategy/request-strategy.d.ts

@@ -3,6 +3,16 @@ export type BaseAdapterRequest<Config = unknown> = {
     adapterName: string;
     config: Config;
 };
+export declare const enum RequestPriority {
+    LOW = 0,
+    NORMAL = 1,
+    HIGH = 2
+}
+export declare enum PdlRequestPriority {
+    LOW = 0,
+    NORMAL = 1,
+    HIGH = 2
+}
 export declare abstract class RequestStrategy<Config, Request extends BaseAdapterRequest<Config>, Context> {
     /**
      * Name of the adapter used in this strategy.
@@ -10,6 +20,7 @@ export declare abstract class RequestStrategy<Config, Request extends BaseAdapte
     abstract adapterName: string;
     abstract execute(config: Config): any;
     abstract buildConcreteRequest(similarRequest: Request, context: Context): Request;
+    getRequestPriority(_request: Request, _context: Context): RequestPriority;
     /**
      * Perform any transformations required to prepare the request for saving.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-aura",
-    "version": "1.322.0",
+    "version": "1.323.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS engine for Aura runtime",
     "main": "dist/ldsEngineCreator.js",
@@ -35,15 +35,17 @@
     },
     "devDependencies": {
         "@luvio/service-broker": "5.13.0",
-        "@salesforce/lds-adapters-apex": "^1.322.0",
-        "@salesforce/lds-adapters-uiapi": "^1.322.0",
+        "@luvio/service-provisioner": "5.13.0",
+        "@salesforce/lds-adapters-apex": "^1.323.0",
+        "@salesforce/lds-adapters-uiapi": "^1.323.0",
         "@salesforce/lds-adapters-uiapi-lex": "^1.302.0",
-        "@salesforce/lds-ads-bridge": "^1.322.0",
-        "@salesforce/lds-aura-storage": "^1.322.0",
-        "@salesforce/lds-bindings": "^1.322.0",
-        "@salesforce/lds-instrumentation": "^1.322.0",
-        "@salesforce/lds-network-aura": "^1.322.0",
-        "@salesforce/lds-network-fetch-with-jwt": "^1.322.0"
+        "@salesforce/lds-ads-bridge": "^1.323.0",
+        "@salesforce/lds-aura-storage": "^1.323.0",
+        "@salesforce/lds-bindings": "^1.323.0",
+        "@salesforce/lds-instrumentation": "^1.323.0",
+        "@salesforce/lds-network-aura": "^1.323.0",
+        "@salesforce/lds-network-fetch-with-jwt": "^1.323.0",
+        "jwt-encode": "1.0.1"
     },
     "dependencies": {
         "@luvio/command-aura-network": "5.13.0",
@@ -61,7 +63,7 @@
         "@luvio/service-instrument-command": "5.13.0",
         "@luvio/service-store": "5.13.0",
         "@luvio/utils": "5.13.0",
-        "@salesforce/lds-adapters-uiapi-lex": "^1.322.0"
+        "@salesforce/lds-adapters-uiapi-lex": "^1.323.0"
     },
     "luvioBundlesize": [
         {