@salesforce/lds-runtime-aura 1.309.0-dev14 → 1.309.0-dev16

package/dist/ldsEngineCreator.js

@@ -3998,18 +3998,19 @@ const DEFAULT_STORAGE_OPTIONS = {
     version: 3,
 };
 function buildAuraPrefetchStorage(options = {}) {
+    const { onPredictionsReadyCallback, ...storageOptions } = options;
     const auraStorage = createStorage({
         ...DEFAULT_STORAGE_OPTIONS,
-        ...options,
+        ...storageOptions,
     });
     const inMemoryStorage = new InMemoryPrefetchStorage();
     if (auraStorage === null) {
         return inMemoryStorage;
     }
-    return new AuraPrefetchStorage(auraStorage, inMemoryStorage);
+    return new AuraPrefetchStorage(auraStorage, inMemoryStorage, onPredictionsReadyCallback);
 }
 class AuraPrefetchStorage {
-    constructor(auraStorage, inMemoryStorage) {
+    constructor(auraStorage, inMemoryStorage, onPredictionsReadyCallback = () => { }) {
         this.auraStorage = auraStorage;
         this.inMemoryStorage = inMemoryStorage;
         /**
@@ -4026,6 +4027,7 @@ class AuraPrefetchStorage {
          */
         auraStorage.getAll().then((results) => {
             keys(results).forEach((key) => this.inMemoryStorage.set(key, results[key]));
+            onPredictionsReadyCallback();
         });
     }
     set(key, value) {
@@ -4099,7 +4101,7 @@ function getEnvironmentSetting(name) {
     }
     return undefined;
 }
-// version: 1.309.0-dev14-d0a3778177
+// version: 1.309.0-dev16-189d0681ed
 
 const forceRecordTransactionsDisabled = getEnvironmentSetting(EnvironmentSettings.ForceRecordTransactionsDisabled);
 //TODO: Some duplication here that can be most likely moved to a util class
@@ -4394,6 +4396,53 @@ function setupMetadataWatcher(luvio) {
     });
 }
 
+/**
+ * Manages the state of predictions and notifies registered callbacks when predictions are ready.
+ */
+class PredictionsReadyManager {
+    constructor() {
+        /**
+         * Array of callbacks to be executed when predictions are ready.
+         * @private
+         */
+        this.predictionsReadyCallbacks = [];
+        /**
+         * Indicates whether the predictions are ready.
+         * @private
+         */
+        this.predictionsReady = false;
+    }
+    /**
+     * Registers a callback to be called when predictions are ready.
+     * If predictions are already ready, the callback is invoked immediately.
+     *
+     * @param {() => void} callback - The callback function to be executed when predictions are ready.
+     */
+    whenPredictionsReady(callback) {
+        if (this.predictionsReady) {
+            callback();
+        }
+        else {
+            this.predictionsReadyCallbacks.push(callback);
+        }
+    }
+    /**
+     * Notifies that predictions are ready by invoking all registered callbacks.
+     */
+    notifyPredictionsReady() {
+        this.predictionsReady = true;
+        this.predictionsReadyCallbacks.forEach((cb) => cb());
+    }
+    /**
+     * Retrieves the list of callbacks registered to be executed when predictions are ready.
+     *
+     * @returns {Array<() => void>} Array of callback functions.
+     */
+    getCallbacks() {
+        return this.predictionsReadyCallbacks;
+    }
+}
+
 // This code *should* be in lds-network-adapter, but when combined with the Aura
 // component test workaround in lds-default-luvio it creates a circular dependecy
 // between lds-default-luvio and lds-network-adapter. We do the register on behalf
@@ -4430,8 +4479,14 @@ function getInflightRequestLimit() {
         return HARDCODED_REQUEST_LIMIT;
     }
 }
+const predictionsReadyManager = new PredictionsReadyManager();
+function whenPredictionsReady(callback) {
+    predictionsReadyManager.whenPredictionsReady(callback);
+}
 function setupPredictivePrefetcher(luvio) {
-    const storage = buildAuraPrefetchStorage();
+    const storage = buildAuraPrefetchStorage({
+        onPredictionsReadyCallback: () => predictionsReadyManager.notifyPredictionsReady(),
+    });
     const requestRunner = new LexRequestRunner(luvio);
     const repository = new PrefetchRepository(storage, {
         modifyBeforeSaveHook: (requests) => requestRunner.reduceRequests(requests),
@@ -4523,6 +4578,16 @@ function buildPredictorForContext(context) {
     if (__lexPrefetcher === undefined) {
         return;
     }
+    const currentContext = __lexPrefetcher.context;
+    let isSameContext = false;
+    if (currentContext && currentContext.type === 'recordPage') {
+        const rhPageContext = currentContext;
+        isSameContext =
+            rhPageContext.actionName === context.actionName &&
+                rhPageContext.objectApiName === context.objectApiName &&
+                rhPageContext.recordId === context.recordId &&
+                rhPageContext.type === context.type;
+    }
     // // This chunk configures which page we're going to use to try and preload.
     __lexPrefetcher.context = context;
     return {
@@ -4551,6 +4616,9 @@ function buildPredictorForContext(context) {
             });
         },
         runPredictions() {
+            if (isSameContext) {
+                return Promise.resolve();
+            }
             return executeAsyncActivity(METRIC_KEYS.PREDICTIVE_DATA_LOADING_PREDICT, (_act) => __lexPrefetcher.predict(), PDL_EXECUTE_ASYNC_OPTIONS);
         },
         getPredictionSummary() {
@@ -4661,5 +4729,5 @@ function ldsEngineCreator() {
     return { name: 'ldsEngineCreator' };
 }
 
-export { buildPredictorForContext, ldsEngineCreator as default, initializeLDS, initializeOneStore };
-// version: 1.309.0-dev14-eec35cd428
+export { buildPredictorForContext, ldsEngineCreator as default, initializeLDS, initializeOneStore, whenPredictionsReady };
+// version: 1.309.0-dev16-7409c81567

package/dist/types/main.d.ts

@@ -1,4 +1,5 @@
 import { type RecordHomePageContext } from './predictive-loading';
+export declare function whenPredictionsReady(callback: () => void): void;
 /**
  * @typedef {Object} RecordHomePageContext
  * @property {string} objectApiName - The API name of the object.
@@ -27,7 +28,7 @@ import { type RecordHomePageContext } from './predictive-loading';
 export declare function buildPredictorForContext(context: RecordHomePageContext): {
     hasPredictions(): boolean;
     watchPageLoadForPredictions(): void;
-    runPredictions(): Promise<void | undefined>;
+    runPredictions(): Promise<void>;
     getPredictionSummary(): {
         exact: number;
         similar: number;

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

@@ -0,0 +1 @@
+export { PredictionsReadyManager } from './predictions-ready-manager';

package/dist/types/predictive-loading/lex/predictions-ready-manager.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Manages the state of predictions and notifies registered callbacks when predictions are ready.
+ */
+export declare class PredictionsReadyManager {
+    /**
+     * Array of callbacks to be executed when predictions are ready.
+     * @private
+     */
+    private predictionsReadyCallbacks;
+    /**
+     * Indicates whether the predictions are ready.
+     * @private
+     */
+    private predictionsReady;
+    /**
+     * Registers a callback to be called when predictions are ready.
+     * If predictions are already ready, the callback is invoked immediately.
+     *
+     * @param {() => void} callback - The callback function to be executed when predictions are ready.
+     */
+    whenPredictionsReady(callback: () => void): void;
+    /**
+     * Notifies that predictions are ready by invoking all registered callbacks.
+     */
+    notifyPredictionsReady(): void;
+    /**
+     * Retrieves the list of callbacks registered to be executed when predictions are ready.
+     *
+     * @returns {Array<() => void>} Array of callback functions.
+     */
+    getCallbacks(): Array<() => void>;
+}

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

@@ -11,11 +11,13 @@ export declare const DEFAULT_STORAGE_OPTIONS: {
     debugLogging: boolean;
     version: number;
 };
-export declare function buildAuraPrefetchStorage(options?: Partial<AuraStorageConfig>): PrefetchStorage;
+export declare function buildAuraPrefetchStorage(options?: Partial<AuraStorageConfig> & {
+    onPredictionsReadyCallback?: () => void;
+}): PrefetchStorage;
 export declare class AuraPrefetchStorage implements PrefetchStorage {
     private auraStorage;
     private inMemoryStorage;
-    constructor(auraStorage: AuraStorage, inMemoryStorage: InMemoryPrefetchStorage);
+    constructor(auraStorage: AuraStorage, inMemoryStorage: InMemoryPrefetchStorage, onPredictionsReadyCallback?: () => void);
     set<T>(key: string, value: T): Promise<void>;
     get<T>(key: string): T | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-aura",
-    "version": "1.309.0-dev14",
+    "version": "1.309.0-dev16",
     "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.2-dev2",
-        "@salesforce/lds-adapters-apex": "^1.309.0-dev14",
-        "@salesforce/lds-adapters-uiapi": "^1.309.0-dev14",
+        "@salesforce/lds-adapters-apex": "^1.309.0-dev16",
+        "@salesforce/lds-adapters-uiapi": "^1.309.0-dev16",
         "@salesforce/lds-adapters-uiapi-lex": "^1.302.0",
-        "@salesforce/lds-ads-bridge": "^1.309.0-dev14",
-        "@salesforce/lds-aura-storage": "^1.309.0-dev14",
-        "@salesforce/lds-bindings": "^1.309.0-dev14",
-        "@salesforce/lds-instrumentation": "^1.309.0-dev14",
-        "@salesforce/lds-network-aura": "^1.309.0-dev14",
-        "@salesforce/lds-network-fetch-with-jwt": "^1.309.0-dev14"
+        "@salesforce/lds-ads-bridge": "^1.309.0-dev16",
+        "@salesforce/lds-aura-storage": "^1.309.0-dev16",
+        "@salesforce/lds-bindings": "^1.309.0-dev16",
+        "@salesforce/lds-instrumentation": "^1.309.0-dev16",
+        "@salesforce/lds-network-aura": "^1.309.0-dev16",
+        "@salesforce/lds-network-fetch-with-jwt": "^1.309.0-dev16"
     },
     "dependencies": {
         "@luvio/command-aura-network": "5.3.2-dev2",
@@ -51,8 +51,8 @@
         "@luvio/command-network": "5.3.2-dev2",
         "@luvio/command-sse": "5.3.2-dev2",
         "@luvio/command-streaming": "5.3.2-dev2",
-        "@luvio/network-adapter-composable": "0.156.4-dev1",
-        "@luvio/network-adapter-fetch": "0.156.4-dev1",
+        "@luvio/network-adapter-composable": "0.156.4-dev2",
+        "@luvio/network-adapter-fetch": "0.156.4-dev2",
         "@luvio/runtime": "5.3.2-dev2",
         "@luvio/service-aura-network": "5.3.2-dev2",
         "@luvio/service-cache-inclusion-policy": "5.3.2-dev2",
@@ -64,13 +64,13 @@
         "@luvio/service-subscription": "5.3.2-dev2",
         "@luvio/service-type-registry": "5.3.2-dev2",
         "@luvio/utils": "5.3.2-dev2",
-        "@salesforce/lds-adapters-uiapi-lex": "^1.309.0-dev14"
+        "@salesforce/lds-adapters-uiapi-lex": "^1.309.0-dev16"
     },
     "luvioBundlesize": [
         {
             "path": "./dist/ldsEngineCreator.js",
             "maxSize": {
-                "none": "175.2 kB",
+                "none": "178 kB",
                 "min": "75 kB",
                 "compressed": "32 kB"
             }