@salesforce/lds-runtime-aura 1.312.0 → 1.313.0

package/dist/ldsEngineCreator.js

@@ -21,7 +21,7 @@ import useCmpDefPredictions from '@salesforce/gate/lds.pdl.useCmpDefPredictions'
 import applyPredictionRequestLimit from '@salesforce/gate/lds.pdl.applyRequestLimit';
 import useExactMatchesPlusGate from '@salesforce/gate/lds.pdl.useExactMatchesPlus';
 import { GetApexWireAdapterFactory, registerPrefetcher as registerPrefetcher$1 } from 'force/ldsAdaptersApex';
-import { instrument, getRecordAvatarsAdapterFactory, getRecordAdapterFactory, coerceFieldIdArray, getRecordsAdapterFactory, getRecordActionsAdapterFactory, getObjectInfosAdapterFactory, coerceObjectIdArray, getObjectInfoAdapterFactory, coerceObjectId, getRelatedListsActionsAdapterFactory, getRelatedListInfoBatchAdapterFactory, getRelatedListRecordsBatchAdapterFactory, getRelatedListRecordsAdapterFactory, getListInfoByNameAdapterFactory, getListInfosByObjectNameAdapterFactory, getListRecordsByNameAdapterFactory, getListObjectInfoAdapterFactory, configuration, InMemoryRecordRepresentationQueryEvaluator, UiApiNamespace, RecordRepresentationRepresentationType, registerPrefetcher } from 'force/ldsAdaptersUiapi';
+import { instrument, getRecordAvatarsAdapterFactory, getRecordAdapterFactory, coerceFieldIdArray, getRecordsAdapterFactory, getRecordActionsAdapterFactory, getObjectInfosAdapterFactory, coerceObjectIdArray, getObjectInfoAdapterFactory, coerceObjectId, getRelatedListsActionsAdapterFactory, getRelatedListInfoBatchAdapterFactory, getRelatedListInfoAdapterFactory, getRelatedListRecordsBatchAdapterFactory, getRelatedListRecordsAdapterFactory, getListInfoByNameAdapterFactory, getListInfosByObjectNameAdapterFactory, getListRecordsByNameAdapterFactory, getListObjectInfoAdapterFactory, configuration, InMemoryRecordRepresentationQueryEvaluator, UiApiNamespace, RecordRepresentationRepresentationType, registerPrefetcher } from 'force/ldsAdaptersUiapi';
 import { BaseCommand, convertAuraResponseToData, convertFetchResponseToData } from 'force/luvioRuntime5';
 import { serviceBroker } from 'force/luvioServiceBroker5';
 import oneStoreEnabled from '@salesforce/gate/lds.oneStoreEnabled.ltng';
@@ -1819,7 +1819,7 @@ class RecordHomePage extends LexDefaultPage {
     buildSaveRequestData(request) {
         const requestBuckets = [];
         const { adapterName } = request;
-        const matchingRequestStrategy = this.requestStrategies[adapterName];
+        const matchingRequestStrategy = this.requestStrategies.get(adapterName);
         if (matchingRequestStrategy === undefined) {
             return [];
         }
@@ -1843,7 +1843,7 @@ class RecordHomePage extends LexDefaultPage {
     }
     resolveSimilarRequest(similarRequest) {
         const { adapterName } = similarRequest;
-        const matchingRequestStrategy = this.requestStrategies[adapterName];
+        const matchingRequestStrategy = this.requestStrategies.get(adapterName);
         if (matchingRequestStrategy === undefined) {
             return similarRequest;
         }
@@ -1880,12 +1880,11 @@ class RecordHomePage extends LexDefaultPage {
         return true;
     }
     static handlesContext(context) {
-        const maybeRecordHomePageContext = context;
-        return (maybeRecordHomePageContext !== undefined &&
-            maybeRecordHomePageContext.actionName !== undefined &&
-            maybeRecordHomePageContext.objectApiName !== undefined &&
-            maybeRecordHomePageContext.recordId !== undefined &&
-            maybeRecordHomePageContext.type === 'recordPage');
+        return (context !== undefined &&
+            context.actionName !== undefined &&
+            context.objectApiName !== undefined &&
+            context.recordId !== undefined &&
+            context.type === 'recordPage');
     }
 }
 
@@ -1899,7 +1898,7 @@ class ObjectHomePage extends LexDefaultPage {
     buildSaveRequestData(request) {
         const requestBuckets = [];
         const { adapterName } = request;
-        const matchingRequestStrategy = this.requestStrategies[adapterName];
+        const matchingRequestStrategy = this.requestStrategies.get(adapterName);
         if (matchingRequestStrategy === undefined) {
             return [];
         }
@@ -1978,11 +1977,10 @@ class ObjectHomePage extends LexDefaultPage {
     }
     // Identifies a valid ObjectHomeContext
     static handlesContext(context) {
-        const maybeObjectHomePageContext = context;
-        return (maybeObjectHomePageContext !== undefined &&
-            maybeObjectHomePageContext.listViewApiName !== undefined &&
-            maybeObjectHomePageContext.objectApiName !== undefined &&
-            maybeObjectHomePageContext.type === 'objectHomePage');
+        return (context !== undefined &&
+            context.listViewApiName !== undefined &&
+            context.objectApiName !== undefined &&
+            context.type === 'objectHomePage');
     }
 }
 
@@ -2705,11 +2703,12 @@ async function runRequestsWithLimit(requests, runner, concurrentRequestsLimit, p
     await Promise.all(promises);
 }
 
-function isCmpDefsRequest({ request: { adapterName } }) {
-    return adapterName === 'getComponentsDef';
+function isBoxcarableRequest({ request: { adapterName } }, strategyMap) {
+    const strategy = strategyMap.get(adapterName);
+    return strategy === undefined || strategy.isBoxcarable;
 }
-function predictComponentDefs(cmpDefPredictions, requestRunner) {
-    const reducedPredictions = requestRunner.reduceRequests(cmpDefPredictions);
+function predictNonBoxcarableRequest(nonBoxcaredPredictions, requestRunner) {
+    const reducedPredictions = requestRunner.reduceRequests(nonBoxcaredPredictions);
     reducedPredictions.map((request) => requestRunner.runRequest(request.request));
 }
 class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher {
@@ -2718,16 +2717,16 @@ class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher {
     // from scripts/lds-uiapi-plugin.js
     requestStrategies, options) {
         super(context, repository, requestRunner);
-        this.requestStrategies = requestStrategies;
         this.options = options;
+        this.requestStrategyMap = new Map(requestStrategies.map((strategy) => [strategy.adapterName, strategy]));
         this.page = this.getPage();
     }
     getPage() {
         if (RecordHomePage.handlesContext(this.context)) {
-            return new RecordHomePage(this.context, this.requestStrategies, this.options);
+            return new RecordHomePage(this.context, this.requestStrategyMap, this.options);
         }
         else if (ObjectHomePage.handlesContext(this.context)) {
-            return new ObjectHomePage(this.context, this.requestStrategies, this.options);
+            return new ObjectHomePage(this.context, this.requestStrategyMap, this.options);
         }
         return new LexDefaultPage(this.context);
     }
@@ -2736,7 +2735,7 @@ class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher {
         let similarPageRequests = this.getSimilarPageRequests();
         if (exactPageRequests.length > 0 && this.options.useExactMatchesPlus === true) {
             similarPageRequests = similarPageRequests.filter((requestEntry) => {
-                const strategy = this.requestStrategies[requestEntry.request.adapterName];
+                const strategy = this.requestStrategyMap.get(requestEntry.request.adapterName);
                 return strategy && strategy.onlySavedInSimilar;
             });
         }
@@ -2749,17 +2748,17 @@ class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher {
         //            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.
-        predictComponentDefs(pageRequests.filter(isCmpDefsRequest), this.requestRunner);
+        predictNonBoxcarableRequest(pageRequests.filter((r) => !isBoxcarableRequest(r, this.requestStrategyMap)), this.requestRunner);
         const alwaysRequestEntries = alwaysRequests.map((request) => {
             return {
                 request,
                 requestMetadata: { requestTime: 0 }, // ensures always requests are executed, and executed first.
             };
         });
-        const nonCmpDefPredictions = pageRequests.filter((r) => !isCmpDefsRequest(r));
+        const boxcarablePredictions = pageRequests.filter((r) => isBoxcarableRequest(r, this.requestStrategyMap));
         const reducedPredictions = this.page.shouldReduceAlwaysRequestsWithPredictions()
-            ? this.requestRunner.reduceRequests([...nonCmpDefPredictions, ...alwaysRequestEntries])
-            : this.requestRunner.reduceRequests(nonCmpDefPredictions);
+            ? this.requestRunner.reduceRequests([...boxcarablePredictions, ...alwaysRequestEntries])
+            : this.requestRunner.reduceRequests(boxcarablePredictions);
         const predictedRequestsWithLimit = (this.page.shouldExecuteAlwaysRequestByThemself()
             ? [...alwaysRequestEntries, ...reducedPredictions]
             : reducedPredictions)
@@ -2927,6 +2926,27 @@ class PrefetchRepository {
     }
 }
 
+class LexRequestRunner {
+    constructor() {
+        this.requestStrategies = [];
+        this.requestStrategiesByAdapterName = new Map();
+    }
+    setRequestStrategies(strategies) {
+        this.requestStrategies = strategies;
+        this.requestStrategiesByAdapterName = new Map(strategies.map((strategy) => [strategy.adapterName, strategy]));
+    }
+    reduceRequests(requests) {
+        return this.requestStrategies.map((strategy) => strategy.reduce(requests)).flat();
+    }
+    runRequest(request) {
+        const strategy = this.requestStrategiesByAdapterName.get(request.adapterName);
+        if (strategy) {
+            return Promise.resolve(strategy.execute(request.config)).then();
+        }
+        return Promise.resolve(undefined);
+    }
+}
+
 class RequestStrategy {
     /**
      * Perform any transformations required to prepare the request for saving.
@@ -3036,6 +3056,19 @@ class RequestStrategy {
     }
 }
 
+class LexRequestStrategy extends RequestStrategy {
+    /**
+     * Whether or not requests from this strategies can be boxcarred by Aura.
+     * If they are, the lex prefetcher will run predictions of this strategy with a limit,
+     * to avoid predictions being boxcared.
+     *
+     * @returns boolean
+     */
+    get isBoxcarable() {
+        return true;
+    }
+}
+
 const noop = () => { };
 // Taken from https://sourcegraph.soma.salesforce.com/perforce.soma.salesforce.com/app/main/core/-/blob/ui-global-components/components/one/one/oneController.js?L75
 // In theory this should not be here, but for now, we don't have an alternative,
@@ -3150,7 +3183,7 @@ function requestComponents(config) {
         unstable_loadComponentDefs(descriptorsMap, noop);
     }
 }
-class GetComponentsDefStrategy extends RequestStrategy {
+class GetComponentsDefStrategy extends LexRequestStrategy {
     constructor() {
         super(...arguments);
         this.adapterName = 'getComponentsDef';
@@ -3200,6 +3233,14 @@ class GetComponentsDefStrategy extends RequestStrategy {
     isContextDependent(_context, _request) {
         return true;
     }
+    /**
+     * Component predictions are not boxcared
+     *
+     * @returns false
+     */
+    get isBoxcarable() {
+        return false;
+    }
 }
 
 const LDS_PDL_CMP_IDENTIFIER = 'lds:pdl';
@@ -3213,7 +3254,7 @@ const DEFAULT_RESOURCE_CONTEXT = {
         },
     },
 };
-class LuvioAdapterRequestStrategy extends RequestStrategy {
+class LuvioAdapterRequestStrategy extends LexRequestStrategy {
     constructor(luvio) {
         super();
         this.luvio = luvio;
@@ -3628,15 +3669,28 @@ class GetRelatedListsActionsRequestStrategy extends LuvioAdapterRequestStrategy
     }
 }
 
+const GET_RELATED_LIST_INFO_BATCH_ADAPTER_NAME = 'getRelatedListInfoBatch';
 class GetRelatedListInfoBatchRequestStrategy extends LuvioAdapterRequestStrategy {
     constructor() {
         super(...arguments);
-        this.adapterName = 'getRelatedListInfoBatch';
+        this.adapterName = GET_RELATED_LIST_INFO_BATCH_ADAPTER_NAME;
         this.adapterFactory = getRelatedListInfoBatchAdapterFactory;
     }
     buildConcreteRequest(similarRequest, _context) {
         return similarRequest;
     }
+    /**
+     * @override
+     */
+    transformForSave(request) {
+        return {
+            ...request,
+            config: {
+                ...request.config,
+                parentObjectApiName: coerceObjectId(request.config.parentObjectApiName),
+            },
+        };
+    }
     canCombine(reqA, reqB) {
         return reqA.parentObjectApiName === reqB.parentObjectApiName;
     }
@@ -3647,6 +3701,95 @@ class GetRelatedListInfoBatchRequestStrategy extends LuvioAdapterRequestStrategy
     }
 }
 
+class GetRelatedListInfoRequestStrategy extends LuvioAdapterRequestStrategy {
+    constructor() {
+        super(...arguments);
+        this.adapterName = 'getRelatedListInfo';
+        this.adapterFactory = getRelatedListInfoAdapterFactory;
+    }
+    /**
+     * @override
+     */
+    isContextDependent(context, request) {
+        // we have a higher degree of confidence of being able to use a similar request when
+        // optional config is not set AND the object type of the page context is the same as the
+        // object type related list is for
+        return (context.objectApiName === request.config.parentObjectApiName &&
+            this.isRequiredOnlyConfig(request.config));
+    }
+    /**
+     * @override
+     */
+    buildConcreteRequest(similarRequest, _context) {
+        return similarRequest;
+    }
+    /**
+     * @override
+     */
+    transformForSave(request) {
+        return {
+            ...request,
+            config: {
+                ...request.config,
+                parentObjectApiName: coerceObjectId(request.config.parentObjectApiName),
+            },
+        };
+    }
+    /**
+     * For performance reasons (fear of over-fetching), we only want to predict single requests which either are not
+     * part of a batch request OR specify optional parameters (thus requiring data differing from that of a batch
+     * request).
+     *
+     * ADG currently handles the batching of getRelatedListInfo -> getRelatedListInfoBatch
+     * https://gitcore.soma.salesforce.com/core-2206/core-public/blob/p4/main/core/ui-laf-components/modules/laf/batchingPortable/reducers/RelatedListInfoBatchReducer.js
+     *
+     * @param unfilteredRequests
+     * @returns GetRelatedListInfoRequest[]
+     * @override
+     */
+    reduce(unfilteredRequests) {
+        // using batch versions of request, map keys of parent record to values of related lists
+        const batchRequests = unfilteredRequests.filter((entry) => entry.request.adapterName === GET_RELATED_LIST_INFO_BATCH_ADAPTER_NAME).reduce((result, entry) => {
+            // pull batch request parameters that correspond to single request parameters
+            const { parentObjectApiName, relatedListNames, recordTypeId } = entry.request.config;
+            // key based off of parent object and its type
+            const key = `${parentObjectApiName}_${recordTypeId}`;
+            // make sure an entry exists for the record
+            const relatedListIds = result.get(key) || new Set();
+            result.set(key, relatedListIds);
+            // add each related list to values for the record
+            relatedListNames.forEach((list) => relatedListIds.add(list));
+            return result;
+        }, new Map());
+        // return only the single requests that will NOT be covered by a batch request
+        return this.filterRequests(unfilteredRequests).filter((entry) => {
+            const config = entry.request.config;
+            if (!this.isRequiredOnlyConfig(config, true)) {
+                // requested data is customized beyond default; batch may not cover, so keep single request
+                return true;
+            }
+            // key based off of parent object and its type
+            const key = `${config.parentObjectApiName}_${config.recordTypeId}`;
+            // keep only the lists that are not batched
+            const batchLists = batchRequests.get(key);
+            return !(batchLists && batchLists.has(config.relatedListId));
+        });
+    }
+    /**
+     * Return true if the request config doesn't specify values for any of the optional parameters.
+     *
+     * @param config
+     * @param ignoreRecordType
+     */
+    isRequiredOnlyConfig(config, ignoreRecordType = false) {
+        return ((ignoreRecordType || config.recordTypeId === undefined) &&
+            (config.fields || []).length === 0 &&
+            (config.optionalFields || []).length === 0 &&
+            config.restrictColumnsToLayout !== false // default is true
+        );
+    }
+}
+
 const GET_RELATED_LIST_RECORDS_BATCH_ADAPTER_NAME = 'getRelatedListRecordsBatch';
 class GetRelatedListRecordsBatchRequestStrategy extends LuvioAdapterRequestStrategy {
     constructor() {
@@ -3905,41 +4048,6 @@ class GetListObjectInfoRequestStrategy extends LuvioAdapterRequestStrategy {
     }
 }
 
-class LexRequestRunner {
-    constructor(luvio) {
-        this.luvio = luvio;
-        this.requestStrategies = {
-            getRecord: new GetRecordRequestStrategy(luvio),
-            getRecords: new GetRecordsRequestStrategy(luvio),
-            getRecordActions: new GetRecordActionsRequestStrategy(luvio),
-            getRecordAvatars: new GetRecordAvatarsRequestStrategy(luvio),
-            getObjectInfo: new GetObjectInfoRequestStrategy(luvio),
-            getObjectInfos: new GetObjectInfosRequestStrategy(luvio),
-            getRelatedListsActions: new GetRelatedListsActionsRequestStrategy(luvio),
-            getRelatedListInfoBatch: new GetRelatedListInfoBatchRequestStrategy(luvio),
-            getRelatedListRecords: new GetRelatedListRecordsRequestStrategy(luvio),
-            getRelatedListRecordsBatch: new GetRelatedListRecordsBatchRequestStrategy(luvio),
-            getListInfoByName: new GetListInfoByNameRequestStrategy(luvio),
-            getListRecordsByName: new GetListRecordsByNameRequestStrategy(luvio),
-            getApex: new GetApexRequestStrategy(luvio),
-            getComponentsDef: new GetComponentsDefStrategy(),
-            getListInfosByObjectName: new GetListInfosByObjectNameRequestStrategy(luvio),
-            getListObjectInfo: new GetListObjectInfoRequestStrategy(luvio),
-        };
-    }
-    reduceRequests(requests) {
-        return Object.values(this.requestStrategies)
-            .map((strategy) => strategy.reduce(requests))
-            .flat();
-    }
-    runRequest(request) {
-        if (request.adapterName in this.requestStrategies) {
-            return Promise.resolve(this.requestStrategies[request.adapterName].execute(request.config)).then();
-        }
-        return Promise.resolve(undefined);
-    }
-}
-
 class InMemoryPrefetchStorage {
     constructor() {
         this.data = {};
@@ -4065,7 +4173,7 @@ function getEnvironmentSetting(name) {
     }
     return undefined;
 }
-// version: 1.312.0-0d267bac6a
+// version: 1.313.0-19e9b0d234
 
 const forceRecordTransactionsDisabled = getEnvironmentSetting(EnvironmentSettings.ForceRecordTransactionsDisabled);
 //TODO: Some duplication here that can be most likely moved to a util class
@@ -4397,8 +4505,28 @@ function getInflightRequestLimit() {
     }
 }
 function setupPredictivePrefetcher(luvio) {
+    const allStrategies = [
+        new GetRecordRequestStrategy(luvio),
+        new GetRecordsRequestStrategy(luvio),
+        new GetRecordActionsRequestStrategy(luvio),
+        new GetRecordAvatarsRequestStrategy(luvio),
+        new GetObjectInfoRequestStrategy(luvio),
+        new GetObjectInfosRequestStrategy(luvio),
+        new GetRelatedListsActionsRequestStrategy(luvio),
+        new GetRelatedListRecordsRequestStrategy(luvio),
+        new GetRelatedListRecordsBatchRequestStrategy(luvio),
+        new GetRelatedListInfoRequestStrategy(luvio),
+        new GetRelatedListInfoBatchRequestStrategy(luvio),
+        new GetListInfoByNameRequestStrategy(luvio),
+        new GetListRecordsByNameRequestStrategy(luvio),
+        new GetApexRequestStrategy(luvio),
+        new GetComponentsDefStrategy(),
+        new GetListInfosByObjectNameRequestStrategy(luvio),
+        new GetListObjectInfoRequestStrategy(luvio),
+    ];
     const storage = buildAuraPrefetchStorage();
-    const requestRunner = new LexRequestRunner(luvio);
+    const requestRunner = new LexRequestRunner();
+    requestRunner.setRequestStrategies(allStrategies);
     const repository = new PrefetchRepository(storage, {
         modifyBeforeSaveHook: (requests) => requestRunner.reduceRequests(requests),
     });
@@ -4410,24 +4538,7 @@ function setupPredictivePrefetcher(luvio) {
         inflightRequestLimit,
         useExactMatchesPlus,
     };
-    const prefetcher = new LexPredictivePrefetcher({ context: 'unknown' }, repository, requestRunner, {
-        getRecord: new GetRecordRequestStrategy(luvio),
-        getRecords: new GetRecordsRequestStrategy(luvio),
-        getRecordActions: new GetRecordActionsRequestStrategy(luvio),
-        getRecordAvatars: new GetRecordAvatarsRequestStrategy(luvio),
-        getObjectInfo: new GetObjectInfoRequestStrategy(luvio),
-        getObjectInfos: new GetObjectInfosRequestStrategy(luvio),
-        getRelatedListsActions: new GetRelatedListsActionsRequestStrategy(luvio),
-        getRelatedListRecords: new GetRelatedListRecordsRequestStrategy(luvio),
-        getRelatedListRecordsBatch: new GetRelatedListRecordsBatchRequestStrategy(luvio),
-        getRelatedListInfoBatch: new GetRelatedListInfoBatchRequestStrategy(luvio),
-        getListInfoByName: new GetListInfoByNameRequestStrategy(luvio),
-        getListRecordsByName: new GetListRecordsByNameRequestStrategy(luvio),
-        getApex: new GetApexRequestStrategy(luvio),
-        getComponentsDef: new GetComponentsDefStrategy(),
-        getListInfosByObjectName: new GetListInfosByObjectNameRequestStrategy(luvio),
-        getListObjectInfo: new GetListObjectInfoRequestStrategy(luvio),
-    }, prefetcherOptions);
+    const prefetcher = new LexPredictivePrefetcher({ context: 'unknown' }, repository, requestRunner, allStrategies, prefetcherOptions);
     registerPrefetcher(luvio, prefetcher);
     if (useApexPredictions.isOpen({ fallback: false })) {
         registerPrefetcher$1(luvio, prefetcher);
@@ -4628,4 +4739,4 @@ function ldsEngineCreator() {
 }
 
 export { buildPredictorForContext, ldsEngineCreator as default, initializeLDS, initializeOneStore };
-// version: 1.312.0-08241ccdd7
+// version: 1.313.0-bf88d762e3

package/dist/types/predictive-loading/lex/index.d.ts

@@ -0,0 +1,18 @@
+import type { BaseAdapterRequest } from '../../predictive-loading';
+import type { DefaultPageContext, ObjectHomePageContext, RecordHomePageContext } from '../pages';
+/**
+ * Options for the predictive prefetcher.
+ */
+export type LexPrefetcherOptions = {
+    /**
+     * Limit on the number of requests that can be inflight at any given time.
+     */
+    inflightRequestLimit: number;
+    /**
+     * When `true` requests will be saved in multiple context buckets and when exact matches contains predictions, only those will be used.
+     * Defaults to `false` (saves in one of them, predictions are built from similar + exact context buckets).
+     */
+    useExactMatchesPlus?: boolean;
+};
+export type LexRequest<Config = unknown> = BaseAdapterRequest<Config>;
+export type LexContext = RecordHomePageContext | ObjectHomePageContext | DefaultPageContext;

package/dist/types/predictive-loading/pages/lex-default-page.d.ts

@@ -1,7 +1,7 @@
-import type { LexRequest } from '../prefetcher';
+import type { BaseAdapterRequest } from '../request-strategy';
 import { PredictivePrefetchPage } from './predictive-prefetch-page';
 export type DefaultPageContext = Record<string, any>;
-export declare class LexDefaultPage<Request extends LexRequest, Context extends DefaultPageContext> extends PredictivePrefetchPage<Request, Context> {
+export declare class LexDefaultPage<Request extends BaseAdapterRequest, Context extends DefaultPageContext> extends PredictivePrefetchPage<Request, Context> {
     constructor(context: Context);
     buildSaveRequestData(request: Request): {
         context: Context;

package/dist/types/predictive-loading/pages/object-home-page.d.ts

@@ -1,29 +1,23 @@
-import type { LexContext, LexPrefetcherOptions } from '../prefetcher';
-import type { GetListInfoByNameRequestStrategy, GetListInfoByNameRequest, GetListRecordsByNameRequestStrategy, GetListRecordsByNameRequest, GetListInfosByObjectNameRequestStrategy, GetListInfosByObjectNameRequest, GetObjectInfosRequest, GetObjectInfosRequestStrategy, GetListObjectInfoRequest, GetListObjectInfoRequestStrategy } from '../request-strategy';
+import type { LexPrefetcherOptions, LexRequest } from '../lex';
+import type { LexRequestStrategy } from '../request-strategy/lex-request-strategy';
+import type { DefaultPageContext } from './lex-default-page';
 import { LexDefaultPage } from './lex-default-page';
 export type ObjectHomePageContext = {
     objectApiName: string;
     listViewApiName: string;
     type: 'objectHomePage';
 };
-export type ObjectHomePageRequest = GetListInfoByNameRequest | GetListObjectInfoRequest | GetListRecordsByNameRequest | GetListInfosByObjectNameRequest | GetObjectInfosRequest;
-export declare class ObjectHomePage extends LexDefaultPage<ObjectHomePageRequest, ObjectHomePageContext> {
+export declare class ObjectHomePage extends LexDefaultPage<LexRequest, ObjectHomePageContext> {
     private requestStrategies;
     private options;
     similarContext: ObjectHomePageContext;
-    constructor(context: ObjectHomePageContext, requestStrategies: {
-        getListInfoByName: GetListInfoByNameRequestStrategy;
-        getListRecordsByName: GetListRecordsByNameRequestStrategy;
-        getListInfosByObjectName: GetListInfosByObjectNameRequestStrategy;
-        getObjectInfos: GetObjectInfosRequestStrategy;
-        getListObjectInfo: GetListObjectInfoRequestStrategy;
-    }, options: LexPrefetcherOptions);
-    buildSaveRequestData(request: ObjectHomePageRequest): {
+    constructor(context: ObjectHomePageContext, requestStrategies: Map<string, LexRequestStrategy>, options: LexPrefetcherOptions);
+    buildSaveRequestData(request: LexRequest): {
         context: ObjectHomePageContext;
-        request: any;
+        request: LexRequest<unknown>;
     }[];
-    resolveSimilarRequest(similarRequest: ObjectHomePageRequest): ObjectHomePageRequest;
-    getAlwaysRunRequests(): ObjectHomePageRequest[];
+    resolveSimilarRequest(similarRequest: LexRequest): LexRequest;
+    getAlwaysRunRequests(): LexRequest[];
     /**
      * AlwaysRequests must be reduced with predictions.
      *
@@ -38,5 +32,5 @@ export declare class ObjectHomePage extends LexDefaultPage<ObjectHomePageRequest
      * @returns false
      */
     shouldExecuteAlwaysRequestByThemself(): boolean;
-    static handlesContext(context: LexContext): context is ObjectHomePageContext;
+    static handlesContext(context: DefaultPageContext): context is ObjectHomePageContext;
 }

package/dist/types/predictive-loading/pages/record-home-page.d.ts

@@ -1,38 +1,24 @@
-import type { LexContext, LexPrefetcherOptions } from '../prefetcher';
-import type { GetRecordRequest, GetRecordsRequest, GetRecordRequestStrategy, GetRecordsRequestStrategy, GetRecordActionsRequestStrategy, GetRecordActionsRequest, GetRecordAvatarsRequest, GetRecordAvatarsRequestStrategy, GetObjectInfoRequest, GetObjectInfosRequest, GetObjectInfoRequestStrategy, GetObjectInfosRequestStrategy, GetRelatedListsActionsRequestStrategy, GetRelatedListsActionsRequest, GetRelatedListInfoBatchRequestStrategy, GetRelatedListInfoBatchRequest, GetRelatedListRecordsRequestStrategy, GetRelatedListRecordsRequest, GetRelatedListRecordsBatchRequestStrategy, GetRelatedListRecordsBatchRequest, GetApexRequest, GetComponentsRequest, GetApexRequestStrategy, GetComponentsDefStrategy } from '../request-strategy';
+import type { LexPrefetcherOptions, LexRequest } from '../lex';
+import type { DefaultPageContext } from './lex-default-page';
 import { LexDefaultPage } from './lex-default-page';
+import type { LexRequestStrategy } from '../request-strategy/lex-request-strategy';
 export type RecordHomePageContext = {
     objectApiName: string;
     recordId: string;
     actionName: string;
     type: 'recordPage';
 };
-export type RecordHomePageRequest = GetRecordRequest | GetRecordsRequest | GetRecordActionsRequest | GetRecordAvatarsRequest | GetObjectInfoRequest | GetObjectInfosRequest | GetRelatedListsActionsRequest | GetRelatedListInfoBatchRequest | GetRelatedListRecordsRequest | GetRelatedListRecordsBatchRequest | GetApexRequest | GetComponentsRequest;
-type RecordHomePageRequestStrategies = {
-    getRecord: GetRecordRequestStrategy;
-    getRecords: GetRecordsRequestStrategy;
-    getRecordActions: GetRecordActionsRequestStrategy;
-    getRecordAvatars: GetRecordAvatarsRequestStrategy;
-    getObjectInfo: GetObjectInfoRequestStrategy;
-    getObjectInfos: GetObjectInfosRequestStrategy;
-    getRelatedListsActions: GetRelatedListsActionsRequestStrategy;
-    getRelatedListInfoBatch: GetRelatedListInfoBatchRequestStrategy;
-    getRelatedListRecords: GetRelatedListRecordsRequestStrategy;
-    getRelatedListRecordsBatch: GetRelatedListRecordsBatchRequestStrategy;
-    getApex: GetApexRequestStrategy;
-    getComponentsDef: GetComponentsDefStrategy;
-};
-export declare class RecordHomePage extends LexDefaultPage<RecordHomePageRequest, RecordHomePageContext> {
+export declare class RecordHomePage extends LexDefaultPage<LexRequest, RecordHomePageContext> {
     private requestStrategies;
     private options;
     similarContext: RecordHomePageContext;
-    constructor(context: RecordHomePageContext, requestStrategies: RecordHomePageRequestStrategies, options: LexPrefetcherOptions);
-    buildSaveRequestData(request: RecordHomePageRequest): {
+    constructor(context: RecordHomePageContext, requestStrategies: Map<string, LexRequestStrategy>, options: LexPrefetcherOptions);
+    buildSaveRequestData(request: LexRequest): {
         context: RecordHomePageContext;
-        request: any;
+        request: LexRequest<unknown>;
     }[];
-    resolveSimilarRequest(similarRequest: RecordHomePageRequest): RecordHomePageRequest;
-    getAlwaysRunRequests(): RecordHomePageRequest[];
+    resolveSimilarRequest(similarRequest: LexRequest): LexRequest;
+    getAlwaysRunRequests(): LexRequest[];
     /**
      * In RH, we know that there will be predictions, and we want to reduce the always requests (getRecord(id, type))
      * with one of the predictions in case some request containing the fields was missed in the predictions.
@@ -46,6 +32,5 @@ export declare class RecordHomePage extends LexDefaultPage<RecordHomePageRequest
      * @returns true
      */
     shouldExecuteAlwaysRequestByThemself(): boolean;
-    static handlesContext(context: LexContext): context is RecordHomePageContext;
+    static handlesContext(context: DefaultPageContext): context is RecordHomePageContext;
 }
-export {};

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

@@ -1,50 +1,15 @@
 import { ApplicationPredictivePrefetcher } from './predictive-prefetcher';
 import { LexDefaultPage } from '../pages/lex-default-page';
-import type { DefaultPageContext } from '../pages';
-import type { GetRecordActionsRequestStrategy, GetRecordAvatarsRequestStrategy, GetRecordRequestStrategy, GetRecordsRequestStrategy, GetObjectInfoRequestStrategy, GetObjectInfosRequestStrategy, GetRelatedListsActionsRequestStrategy, GetRelatedListInfoBatchRequestStrategy, GetRelatedListRecordsRequestStrategy, GetRelatedListRecordsBatchRequestStrategy, GetListInfoByNameRequestStrategy, GetListRecordsByNameRequestStrategy, GetApexRequestStrategy, GetComponentsDefStrategy, GetListInfosByObjectNameRequestStrategy, GetListObjectInfoRequestStrategy } from '../request-strategy';
 import type { RequestRunner } from '../request-runner';
 import type { PrefetchRepository } from '../repository/prefetch-repository';
-import type { RecordHomePageContext, RecordHomePageRequest } from '../pages/record-home-page';
 import type { RequestEntry } from '../common';
-import type { ObjectHomePageContext, ObjectHomePageRequest } from '../pages/object-home-page';
-export type LexRequest = RecordHomePageRequest | ObjectHomePageRequest;
-export type LexContext = RecordHomePageContext | ObjectHomePageContext | DefaultPageContext;
-/**
- * Options for the predictive prefetcher.
- */
-export type LexPrefetcherOptions = {
-    /**
-     * Limit on the number of requests that can be inflight at any given time.
-     */
-    inflightRequestLimit: number;
-    /**
-     * When `true` requests will be saved in multiple context buckets and when exact matches contains predictions, only those will be used.
-     * Defaults to `false` (saves in one of them, predictions are built from similar + exact context buckets).
-     */
-    useExactMatchesPlus?: boolean;
-};
+import type { LexRequestStrategy } from '../request-strategy/lex-request-strategy';
+import type { LexContext, LexPrefetcherOptions, LexRequest } from '../lex';
 export declare class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher<LexRequest, LexContext> {
-    private requestStrategies;
     protected options: LexPrefetcherOptions;
     page: LexDefaultPage<LexRequest, LexContext>;
-    constructor(context: LexContext, repository: PrefetchRepository, requestRunner: RequestRunner<LexRequest>, requestStrategies: {
-        getRecord: GetRecordRequestStrategy;
-        getRecords: GetRecordsRequestStrategy;
-        getRecordActions: GetRecordActionsRequestStrategy;
-        getRecordAvatars: GetRecordAvatarsRequestStrategy;
-        getObjectInfo: GetObjectInfoRequestStrategy;
-        getObjectInfos: GetObjectInfosRequestStrategy;
-        getRelatedListsActions: GetRelatedListsActionsRequestStrategy;
-        getRelatedListInfoBatch: GetRelatedListInfoBatchRequestStrategy;
-        getRelatedListRecords: GetRelatedListRecordsRequestStrategy;
-        getRelatedListRecordsBatch: GetRelatedListRecordsBatchRequestStrategy;
-        getListInfoByName: GetListInfoByNameRequestStrategy;
-        getListObjectInfo: GetListObjectInfoRequestStrategy;
-        getListRecordsByName: GetListRecordsByNameRequestStrategy;
-        getListInfosByObjectName: GetListInfosByObjectNameRequestStrategy;
-        getApex: GetApexRequestStrategy;
-        getComponentsDef: GetComponentsDefStrategy;
-    }, options: LexPrefetcherOptions);
+    private requestStrategyMap;
+    constructor(context: LexContext, repository: PrefetchRepository, requestRunner: RequestRunner<LexRequest>, requestStrategies: LexRequestStrategy[], options: LexPrefetcherOptions);
     getPage(): LexDefaultPage<LexRequest, LexContext>;
     getAllPageRequests(): RequestEntry<LexRequest>[];
     predict(): Promise<void>;

package/dist/types/predictive-loading/request-runner/lex-request-runner.d.ts

@@ -1,11 +1,11 @@
-import type { Luvio } from '@luvio/engine';
-import type { LexRequest } from '../prefetcher';
 import type { RequestRunner } from './request-runner';
 import type { RequestEntry } from '../common';
+import type { LexRequest } from '../lex';
+import type { LexRequestStrategy } from '../request-strategy/lex-request-strategy';
 export declare class LexRequestRunner implements RequestRunner<LexRequest> {
-    private luvio;
     private requestStrategies;
-    constructor(luvio: Luvio);
+    private requestStrategiesByAdapterName;
+    setRequestStrategies(strategies: LexRequestStrategy[]): void;
     reduceRequests(requests: RequestEntry<LexRequest>[]): RequestEntry<LexRequest>[];
     runRequest(request: LexRequest): Promise<void>;
 }

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

@@ -1,4 +1,4 @@
-import { RequestStrategy } from './request-strategy';
+import { LexRequestStrategy } from './lex-request-strategy';
 type DescriptorsMap = Record<string, unknown | string | undefined>;
 type NormalizedDescriptorsMap = Record<string, string>;
 export type GetComponentsRequest = {
@@ -12,7 +12,7 @@ export type NormalizedGetComponentsRequest = {
 export type GetComponentsContext = {
     objectApiName: string;
 };
-export declare class GetComponentsDefStrategy extends RequestStrategy<DescriptorsMap, GetComponentsRequest, GetComponentsContext> {
+export declare class GetComponentsDefStrategy extends LexRequestStrategy<DescriptorsMap, GetComponentsRequest, GetComponentsContext> {
     adapterName: string;
     execute(config: NormalizedDescriptorsMap): void;
     buildConcreteRequest(similarRequest: GetComponentsRequest, _context: GetComponentsContext): GetComponentsRequest;
@@ -21,5 +21,11 @@ export declare class GetComponentsDefStrategy extends RequestStrategy<Descriptor
     combineRequests(reqA: NormalizedDescriptorsMap, reqB: NormalizedDescriptorsMap): NormalizedDescriptorsMap;
     get onlySavedInSimilar(): boolean;
     isContextDependent(_context: GetComponentsContext, _request: GetComponentsRequest): boolean;
+    /**
+     * Component predictions are not boxcared
+     *
+     * @returns false
+     */
+    get isBoxcarable(): boolean;
 }
 export {};

package/dist/types/predictive-loading/request-strategy/get-related-list-info-batch-request-strategy.d.ts

@@ -7,10 +7,15 @@ export type GetRelatedListInfoBatchRequest = {
 type GetRelatedListInfoBatchContext = {
     objectApiName: string;
 };
+export declare const GET_RELATED_LIST_INFO_BATCH_ADAPTER_NAME = "getRelatedListInfoBatch";
 export declare class GetRelatedListInfoBatchRequestStrategy extends LuvioAdapterRequestStrategy<GetRelatedListInfoBatchConfig, GetRelatedListInfoBatchRequest, GetRelatedListInfoBatchContext> {
     adapterName: string;
     adapterFactory: import("@luvio/engine").AdapterFactory<GetRelatedListInfoBatchConfig, import("packages/lds-adapters-uiapi/dist/es/es2018/types/src/generated/types/RelatedListInfoBatchRepresentation").RelatedListInfoBatchRepresentation>;
     buildConcreteRequest(similarRequest: GetRelatedListInfoBatchRequest, _context: GetRelatedListInfoBatchContext): GetRelatedListInfoBatchRequest;
+    /**
+     * @override
+     */
+    transformForSave(request: GetRelatedListInfoBatchRequest): GetRelatedListInfoBatchRequest;
     canCombine(reqA: GetRelatedListInfoBatchConfig, reqB: GetRelatedListInfoBatchConfig): boolean;
     combineRequests(reqA: GetRelatedListInfoBatchConfig, reqB: GetRelatedListInfoBatchConfig): GetRelatedListInfoBatchConfig;
 }

package/dist/types/predictive-loading/request-strategy/get-related-list-info-request-strategy.d.ts

@@ -0,0 +1,48 @@
+import type { BaseAdapterRequest } from './request-strategy';
+import type { GetRelatedListInfoConfig } from '@salesforce/lds-adapters-uiapi';
+import type { RequestEntry } from '../common';
+import { LuvioAdapterRequestStrategy } from './luvio-adapter-request-strategy';
+export type GetRelatedListInfoRequest = {
+    adapterName: 'getRelatedListInfo';
+    config: GetRelatedListInfoConfig;
+};
+type GetRelatedListInfoContext = {
+    objectApiName: string;
+};
+export declare class GetRelatedListInfoRequestStrategy extends LuvioAdapterRequestStrategy<GetRelatedListInfoConfig, GetRelatedListInfoRequest, GetRelatedListInfoContext> {
+    adapterName: string;
+    adapterFactory: import("@luvio/engine").AdapterFactory<GetRelatedListInfoConfig, import("packages/lds-adapters-uiapi/dist/es/es2018/types/src/generated/types/RelatedListInfoRepresentation").RelatedListInfoRepresentation>;
+    /**
+     * @override
+     */
+    isContextDependent(context: GetRelatedListInfoContext, request: GetRelatedListInfoRequest): boolean;
+    /**
+     * @override
+     */
+    buildConcreteRequest(similarRequest: GetRelatedListInfoRequest, _context: GetRelatedListInfoContext): GetRelatedListInfoRequest;
+    /**
+     * @override
+     */
+    transformForSave(request: GetRelatedListInfoRequest): GetRelatedListInfoRequest;
+    /**
+     * For performance reasons (fear of over-fetching), we only want to predict single requests which either are not
+     * part of a batch request OR specify optional parameters (thus requiring data differing from that of a batch
+     * request).
+     *
+     * ADG currently handles the batching of getRelatedListInfo -> getRelatedListInfoBatch
+     * https://gitcore.soma.salesforce.com/core-2206/core-public/blob/p4/main/core/ui-laf-components/modules/laf/batchingPortable/reducers/RelatedListInfoBatchReducer.js
+     *
+     * @param unfilteredRequests
+     * @returns GetRelatedListInfoRequest[]
+     * @override
+     */
+    reduce(unfilteredRequests: RequestEntry<BaseAdapterRequest<unknown>>[]): RequestEntry<GetRelatedListInfoRequest>[];
+    /**
+     * Return true if the request config doesn't specify values for any of the optional parameters.
+     *
+     * @param config
+     * @param ignoreRecordType
+     */
+    isRequiredOnlyConfig(config: GetRelatedListInfoConfig, ignoreRecordType?: boolean): boolean;
+}
+export {};

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

@@ -6,6 +6,7 @@ export * from './get-record-actions-request-strategy';
 export * from './get-object-info-request-strategy';
 export * from './get-object-infos-request-strategy';
 export * from './get-related-lists-actions-request-strategy';
+export * from './get-related-list-info-request-strategy';
 export * from './get-related-list-info-batch-request-strategy';
 export * from './get-related-list-records-request-strategy';
 export * from './get-related-list-records-batch-request-strategy';

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

@@ -0,0 +1,13 @@
+import { RequestStrategy } from './request-strategy';
+import type { LexContext, LexRequest } from '../lex';
+import type { DefaultPageContext } from '../pages';
+export declare abstract class LexRequestStrategy<Config = unknown, Request extends LexRequest<Config> = LexRequest<Config>, Context extends LexContext = DefaultPageContext> extends RequestStrategy<Config, Request, Context> {
+    /**
+     * Whether or not requests from this strategies can be boxcarred by Aura.
+     * If they are, the lex prefetcher will run predictions of this strategy with a limit,
+     * to avoid predictions being boxcared.
+     *
+     * @returns boolean
+     */
+    get isBoxcarable(): boolean;
+}

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

@@ -1,6 +1,6 @@
 import type { AdapterFactory, AdapterRequestContext, Luvio, Snapshot } from '@luvio/engine';
-import type { BaseAdapterRequest } from './request-strategy';
-import { RequestStrategy } from './request-strategy';
+import { LexRequestStrategy } from './lex-request-strategy';
+import type { LexContext, LexRequest } from '../lex';
 export declare const DEFAULT_RESOURCE_CONTEXT: {
     sourceContext: {
         tagName: string;
@@ -11,7 +11,7 @@ export declare const DEFAULT_RESOURCE_CONTEXT: {
         };
     };
 };
-export declare abstract class LuvioAdapterRequestStrategy<AdapterConfig, Request extends BaseAdapterRequest<AdapterConfig>, Context> extends RequestStrategy<AdapterConfig, Request, Context> {
+export declare abstract class LuvioAdapterRequestStrategy<AdapterConfig, Request extends LexRequest<AdapterConfig>, Context extends LexContext> extends LexRequestStrategy<AdapterConfig, Request, Context> {
     private luvio;
     constructor(luvio: Luvio);
     /**

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

@@ -1,5 +1,5 @@
 import type { RequestEntry } from '../common';
-export type BaseAdapterRequest<Config> = {
+export type BaseAdapterRequest<Config = unknown> = {
     adapterName: string;
     config: Config;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-aura",
-    "version": "1.312.0",
+    "version": "1.313.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS engine for Aura runtime",
     "main": "dist/ldsEngineCreator.js",
@@ -35,15 +35,15 @@
     },
     "devDependencies": {
         "@luvio/service-broker": "5.3.1",
-        "@salesforce/lds-adapters-apex": "^1.312.0",
-        "@salesforce/lds-adapters-uiapi": "^1.312.0",
+        "@salesforce/lds-adapters-apex": "^1.313.0",
+        "@salesforce/lds-adapters-uiapi": "^1.313.0",
         "@salesforce/lds-adapters-uiapi-lex": "^1.302.0",
-        "@salesforce/lds-ads-bridge": "^1.312.0",
-        "@salesforce/lds-aura-storage": "^1.312.0",
-        "@salesforce/lds-bindings": "^1.312.0",
-        "@salesforce/lds-instrumentation": "^1.312.0",
-        "@salesforce/lds-network-aura": "^1.312.0",
-        "@salesforce/lds-network-fetch-with-jwt": "^1.312.0"
+        "@salesforce/lds-ads-bridge": "^1.313.0",
+        "@salesforce/lds-aura-storage": "^1.313.0",
+        "@salesforce/lds-bindings": "^1.313.0",
+        "@salesforce/lds-instrumentation": "^1.313.0",
+        "@salesforce/lds-network-aura": "^1.313.0",
+        "@salesforce/lds-network-fetch-with-jwt": "^1.313.0"
     },
     "dependencies": {
         "@luvio/command-aura-network": "5.3.1",
@@ -64,13 +64,13 @@
         "@luvio/service-subscription": "5.3.1",
         "@luvio/service-type-registry": "5.3.1",
         "@luvio/utils": "5.3.1",
-        "@salesforce/lds-adapters-uiapi-lex": "^1.312.0"
+        "@salesforce/lds-adapters-uiapi-lex": "^1.313.0"
     },
     "luvioBundlesize": [
         {
             "path": "./dist/ldsEngineCreator.js",
             "maxSize": {
-                "none": "175 kB",
+                "none": "178 kB",
                 "min": "75 kB",
                 "compressed": "32 kB"
             }