@salesforce/lds-runtime-aura 1.256.0 → 1.258.0

package/dist/ldsEngineCreator.js

@@ -211,10 +211,17 @@ class ApplicationPredictivePrefetcher {
         this.queuedPredictionRequests.push(...predictedRequests);
         return Promise.all(predictedRequests.map((request) => this.requestRunner.runRequest(request))).then();
     }
-    async getSimilarPageRequests() {
+    hasPredictions() {
+        const exactPageRequests = this.repository.getPageRequests(this.context) || [];
+        const similarPageRequests = this.page.similarContext !== undefined
+            ? this.repository.getPageRequests(this.page.similarContext)
+            : [];
+        return exactPageRequests.length > 0 || similarPageRequests.length > 0;
+    }
+    getSimilarPageRequests() {
         let resolvedSimilarPageRequests = [];
         if (this.page.similarContext !== undefined) {
-            const similarPageRequests = await this.repository.getPageRequests(this.page.similarContext);
+            const similarPageRequests = this.repository.getPageRequests(this.page.similarContext);
             if (similarPageRequests !== undefined) {
                 resolvedSimilarPageRequests = similarPageRequests.map((request) => this.page.resolveSimilarRequest(request));
             }
@@ -363,13 +370,12 @@ class PrefetchRepository {
         });
         this.requestBuffer.set(identifier, batchForKey);
     }
-    async getPage(key) {
+    getPage(key) {
         const identifier = stableJSONStringify$1(key);
-        const rawPage = await this.storage.get(identifier);
-        return rawPage;
+        return this.storage.get(identifier);
     }
-    async getPageRequests(key) {
-        const page = await this.getPage(key);
+    getPageRequests(key) {
+        const page = this.getPage(key);
         if (page === undefined) {
             return [];
         }
@@ -703,7 +709,7 @@ class InMemoryPrefetchStorage {
         return Promise.resolve();
     }
     get(key) {
-        return Promise.resolve(this.data[key]);
+        return this.data[key];
     }
 }
 
@@ -732,6 +738,18 @@ class AuraPrefetchStorage {
     constructor(auraStorage, inMemoryStorage) {
         this.auraStorage = auraStorage;
         this.inMemoryStorage = inMemoryStorage;
+        /**
+         * Because of aura is an event loop hog and we therefore need to minimize asynchronicity in LEX,
+         * we need need to preload predictions and treat read operations sync. Not making it sync, will cause
+         * some request to be sent the network when they could be dedupe against those from the predictions.
+         *
+         * Drawbacks of this approach:
+         * 1. Loading all of aura storage into memory and then updating it based on changes to that in memory
+         *    representation means that updates to predictions in aura storage across different tabs will result
+         *    in overwrites, not graceful merges of predictions.
+         * 2. If whoever is consuming this tries to get and run predictions before this is done loading,
+         *    then they will (potentially incorrectly) think that we don't have any predictions.
+         */
         auraStorage.getAll().then((results) => {
             ObjectKeys(results).forEach((key) => this.inMemoryStorage.set(key, results[key]));
         });
@@ -746,10 +764,9 @@ class AuraPrefetchStorage {
         });
         return inMemoryResult;
     }
-    async get(key) {
+    get(key) {
         // we never read from the AuraStorage, except in construction.
-        const result = await this.inMemoryStorage.get(key);
-        return result ? result : undefined;
+        return this.inMemoryStorage.get(key);
     }
 }
 
@@ -1495,7 +1512,12 @@ function setupPredictivePrefetcher(luvio) {
     registerPrefetcher(luvio, prefetcher);
     __lexPrefetcher = prefetcher;
 }
-// Triggers a payload.
+/**
+ * @deprecated This function is deprecated in favor of `buildPredictorForContext`.
+ *    We only keep it so if the lds.usePredictiveLoading gate is open the existing functionality
+ *    on LASR don't break.
+ *    Note: we don't want to make it a noop either because then the gate toggle will be meaningless.
+ */
 async function predictiveLoadPage(preloadProps, runPredictions) {
     // the gate is disabled and the prefetcher was not setup.
     if (__lexPrefetcher === undefined) {
@@ -1517,6 +1539,52 @@ async function predictiveLoadPage(preloadProps, runPredictions) {
     });
     return runPredictions ? __lexPrefetcher.predict() : Promise.resolve();
 }
+/**
+ * @typedef {Object} RecordHomePageContext
+ * @property {string} objectApiName - The API name of the object.
+ * @property {string} recordId - The unique identifier for the record.
+ * @property {string} actionName - The name of the action being performed.
+ * @property {'recordPage'} type - The type of the context, specifically for a record page.
+ */
+/**
+ * Builds a predictor for a given record home page context. This predictor is responsible for
+ * preloading data based on predictions for the current context and create new predictions based
+ * on page requests of this context.
+ *
+ * @param {RecordHomePageContext} context - The context for which the predictor is to be built.
+ * @returns {{
+ *     hasPredictions: () => boolean,
+ *     watchPageLoadForPredictions: () => void,
+ *     runPredictions: () => ReturnType<Promise<void>>
+ * }} An object containing methods to handle predictions:
+ *  - hasPredictions: Checks if there are any predictions available.
+ *  - watchPageLoadForPredictions: Starts recording the page request for prediction purposes.
+ *  - runPredictions: Executes the predictions based on the recorded data and returns a promise
+ *    of when those predictions are completed.
+ */
+function buildPredictorForContext(context) {
+    // the gate is disabled and the prefetcher was not setup.
+    if (__lexPrefetcher === undefined) {
+        return;
+    }
+    // // This chunk configures which page we're going to use to try and preload.
+    __lexPrefetcher.context = context;
+    return {
+        hasPredictions() {
+            return __lexPrefetcher.hasPredictions();
+        },
+        watchPageLoadForPredictions() {
+            // This chunk tells the prefetcher to receive events, send off any predictions we have from previous loads, then setup idle detection to stop predicting.
+            __lexPrefetcher.startRecording();
+            onIdleDetected(() => {
+                __lexPrefetcher.stopRecording();
+            });
+        },
+        runPredictions() {
+            return __lexPrefetcher.predict();
+        },
+    };
+}
 // LDS initialization logic, invoked directly by Aura component tests
 function initializeLDS() {
     const storeOptions = {
@@ -1542,5 +1610,5 @@ function ldsEngineCreator() {
     return { name: 'ldsEngineCreator' };
 }
 
-export { ldsEngineCreator as default, initializeLDS, predictiveLoadPage };
-// version: 1.256.0-ad6a66c18
+export { buildPredictorForContext, ldsEngineCreator as default, initializeLDS, predictiveLoadPage };
+// version: 1.258.0-69570a3e6

package/dist/types/main.d.ts

@@ -1,3 +1,4 @@
+import { type RecordHomePageContext } from './predictive-loading';
 type PreloadProps = {
     context: {
         objectApiName: string;
@@ -13,7 +14,41 @@ type LexPageReference = {
     state: any;
     type: string;
 };
+/**
+ * @deprecated This function is deprecated in favor of `buildPredictorForContext`.
+ *    We only keep it so if the lds.usePredictiveLoading gate is open the existing functionality
+ *    on LASR don't break.
+ *    Note: we don't want to make it a noop either because then the gate toggle will be meaningless.
+ */
 export declare function predictiveLoadPage(preloadProps: PreloadProps, runPredictions: true): Promise<void>;
+/**
+ * @typedef {Object} RecordHomePageContext
+ * @property {string} objectApiName - The API name of the object.
+ * @property {string} recordId - The unique identifier for the record.
+ * @property {string} actionName - The name of the action being performed.
+ * @property {'recordPage'} type - The type of the context, specifically for a record page.
+ */
+/**
+ * Builds a predictor for a given record home page context. This predictor is responsible for
+ * preloading data based on predictions for the current context and create new predictions based
+ * on page requests of this context.
+ *
+ * @param {RecordHomePageContext} context - The context for which the predictor is to be built.
+ * @returns {{
+ *     hasPredictions: () => boolean,
+ *     watchPageLoadForPredictions: () => void,
+ *     runPredictions: () => ReturnType<Promise<void>>
+ * }} An object containing methods to handle predictions:
+ *  - hasPredictions: Checks if there are any predictions available.
+ *  - watchPageLoadForPredictions: Starts recording the page request for prediction purposes.
+ *  - runPredictions: Executes the predictions based on the recorded data and returns a promise
+ *    of when those predictions are completed.
+ */
+export declare function buildPredictorForContext(context: RecordHomePageContext): {
+    hasPredictions(): boolean;
+    watchPageLoadForPredictions(): void;
+    runPredictions(): Promise<void>;
+} | undefined;
 export declare function initializeLDS(): void;
 declare function ldsEngineCreator(): {
     name: string;

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

@@ -16,5 +16,6 @@ export declare abstract class ApplicationPredictivePrefetcher<Request, Context e
     startRecording(): void;
     saveRequest(request: Request): Promise<void>;
     predict(): Promise<void>;
-    getSimilarPageRequests(): Promise<Request[]>;
+    hasPredictions(): boolean;
+    getSimilarPageRequests(): Request[];
 }

package/dist/types/predictive-loading/repository/prefetch-repository.d.ts

@@ -21,7 +21,7 @@ export declare class PrefetchRepository {
     clearRequestBuffer(): void;
     flushRequestsToStorage(): Promise<void>;
     saveRequest<Request>(key: Key, request: Request): Promise<void>;
-    getPage<Request>(key: Key): Promise<PageEntry<Request> | undefined>;
-    getPageRequests<Request>(key: Key): Promise<Request[]>;
+    getPage<Request>(key: Key): PageEntry<Request> | undefined;
+    getPageRequests<Request>(key: Key): Request[];
 }
 export {};

package/dist/types/predictive-loading/storage/aura-prefetch-storage.d.ts

@@ -15,5 +15,5 @@ export declare class AuraPrefetchStorage implements PrefetchStorage {
     private inMemoryStorage;
     constructor(auraStorage: AuraStorage, inMemoryStorage: InMemoryPrefetchStorage);
     set<T>(key: string, value: T): Promise<void>;
-    get<T>(key: string): Promise<T | undefined>;
+    get<T>(key: string): T | undefined;
 }

package/dist/types/predictive-loading/storage/in-memory-prefetch-storage.d.ts

@@ -2,5 +2,5 @@ import type { PrefetchStorage } from '.';
 export declare class InMemoryPrefetchStorage implements PrefetchStorage {
     data: Record<string, any>;
     set<T>(key: string, value: T): Promise<void>;
-    get<T>(key: string): Promise<T | undefined>;
+    get<T>(key: string): T | undefined;
 }

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

@@ -1,5 +1,5 @@
 export type PrefetchStorage = {
-    get<T>(key: string): Promise<T | undefined>;
+    get<T>(key: string): T | undefined;
     set<T>(key: string, value: T): Promise<void>;
 };
 export * from './in-memory-prefetch-storage';

package/dist/types/predictive-loading/storage/local-prefetch-storage.d.ts

@@ -3,5 +3,5 @@ export declare class LocalPrefetchStorage implements PrefetchStorage {
     private localStorage;
     constructor(localStorage: typeof window.localStorage);
     set<T>(key: string, value: T): Promise<void>;
-    get<T>(key: string): Promise<T | undefined>;
+    get<T>(key: string): T | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-aura",
-    "version": "1.256.0",
+    "version": "1.258.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS engine for Aura runtime",
     "main": "dist/ldsEngineCreator.js",
@@ -34,16 +34,16 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-runtime-aura"
     },
     "devDependencies": {
-        "@salesforce/lds-adapters-uiapi": "^1.256.0",
-        "@salesforce/lds-ads-bridge": "^1.256.0",
-        "@salesforce/lds-aura-storage": "^1.256.0",
-        "@salesforce/lds-bindings": "^1.256.0",
-        "@salesforce/lds-instrumentation": "^1.256.0",
-        "@salesforce/lds-network-aura": "^1.256.0",
-        "@salesforce/lds-network-fetch-with-jwt": "^1.256.0"
+        "@salesforce/lds-adapters-uiapi": "^1.258.0",
+        "@salesforce/lds-ads-bridge": "^1.258.0",
+        "@salesforce/lds-aura-storage": "^1.258.0",
+        "@salesforce/lds-bindings": "^1.258.0",
+        "@salesforce/lds-instrumentation": "^1.258.0",
+        "@salesforce/lds-network-aura": "^1.258.0",
+        "@salesforce/lds-network-fetch-with-jwt": "^1.258.0"
     },
     "dependencies": {
-        "@luvio/network-adapter-composable": "0.154.3"
+        "@luvio/network-adapter-composable": "0.154.4"
     },
     "luvioBundlesize": [
         {
@@ -51,7 +51,7 @@
             "maxSize": {
                 "none": "63 kB",
                 "min": "28 kB",
-                "compressed": "12 kB"
+                "compressed": "13 kB"
             }
         }
     ],