@salesforce/lds-runtime-mobile 1.302.0 → 1.303.0

package/dist/main.js

@@ -1575,6 +1575,32 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         }, revivingStore).finally(() => {
         });
     };
+    const expirePossibleStaleRecords = async function (keys$1, config, refresh) {
+        validateNotDisposed();
+        const metadataKeys = keys$1.map(serializeStructuredKey);
+        const now = Date.now();
+        const entries = await durableStore.getMetadata(metadataKeys, DefaultDurableSegment);
+        if (entries === undefined || keys$8(entries).length === 0) {
+            return environment.expirePossibleStaleRecords(keys$1);
+        }
+        let metaDataChanged = false;
+        const metadataEntries = metadataKeys.reduce((accu, key) => {
+            const metadataEntry = entries[key];
+            if (metadataEntry.metadata !== undefined) {
+                const metadata = { ...metadataEntry.metadata, expirationTimestamp: now };
+                accu[key] = { metadata };
+                metaDataChanged = true;
+            }
+            return accu;
+        }, {});
+        if (metaDataChanged) {
+            await durableStore.setMetadata(metadataEntries, DefaultDurableSegment);
+        }
+        if (config !== undefined && refresh !== undefined) {
+            return environment.refreshPossibleStaleRecords(config, refresh);
+        }
+        return Promise.resolve();
+    };
     // set the default cache policy of the base environment
     environment.setDefaultCachePolicy({
         type: 'stale-while-revalidate',
@@ -1607,6 +1633,7 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         handleErrorResponse: { value: handleErrorResponse },
         getNotifyChangeStoreEntries: { value: getNotifyChangeStoreEntries },
         notifyStoreUpdateAvailable: { value: notifyStoreUpdateAvailable },
+        expirePossibleStaleRecords: { value: expirePossibleStaleRecords },
     });
 }
 
@@ -5655,7 +5682,7 @@ class DurableDraftQueue {
         if (status === DraftActionStatus.Error) {
             this.state = DraftQueueState.Error;
             this.processingAction = undefined;
-            this.notifyChangedListeners({
+            await this.notifyChangedListeners({
                 type: DraftQueueEventType.ActionFailed,
                 action: action,
             });
@@ -5671,7 +5698,7 @@ class DurableDraftQueue {
         if (this.state === DraftQueueState.Waiting) {
             this.state = DraftQueueState.Started;
         }
-        this.notifyChangedListeners({
+        await this.notifyChangedListeners({
             type: DraftQueueEventType.ActionUploading,
             action: { ...action, status: DraftActionStatus.Uploading },
         });
@@ -5778,17 +5805,21 @@ class DurableDraftQueue {
         });
         return action;
     }
-    scheduleRetryWithSpecifiedDelay(retryDelayInMs) {
+    async scheduleRetryWithSpecifiedDelay(retryDelayInMs) {
+        await this.notifyChangedListeners({
+            type: DraftQueueEventType.QueueStateChanged,
+            state: DraftQueueState.Waiting,
+        });
         this.timeoutHandler = setTimeout(() => {
             if (this.state !== DraftQueueState.Stopped) {
                 this.processNextAction();
             }
         }, retryDelayInMs);
     }
-    scheduleRetry() {
+    async scheduleRetry() {
         const newInterval = this.retryIntervalMilliseconds * 2;
         this.retryIntervalMilliseconds = Math.min(Math.max(newInterval, this.minimumRetryInterval), this.maximumRetryInterval);
-        this.scheduleRetryWithSpecifiedDelay(this.retryIntervalMilliseconds);
+        return this.scheduleRetryWithSpecifiedDelay(this.retryIntervalMilliseconds);
     }
     async getActionsForReplaceOrMerge(targetActionId, sourceActionId) {
         const actions = await this.getQueueActions();
@@ -5914,7 +5945,8 @@ class DurableDraftStore {
             const actionArray = [];
             for (let i = 0, len = keys$1.length; i < len; i++) {
                 const key = keys$1[i];
-                actionArray.push(draftStore[key]);
+                // clone draft so we don't expose the internal draft store
+                actionArray.push(clone$1(draftStore[key]));
             }
             return actionArray;
         });
@@ -6563,6 +6595,7 @@ var DraftQueueOperationType;
     DraftQueueOperationType["ItemUpdated"] = "updated";
     DraftQueueOperationType["QueueStarted"] = "started";
     DraftQueueOperationType["QueueStopped"] = "stopped";
+    DraftQueueOperationType["QueueWaiting"] = "waiting";
 })(DraftQueueOperationType || (DraftQueueOperationType = {}));
 /**
  * Converts the internal DraftAction's ResourceRequest into
@@ -6605,6 +6638,16 @@ function toQueueState(queue) {
     };
 }
 class DraftManager {
+    shouldEmitEvent(event) {
+        // Waiting events cannot be emitted prior to 252 native clients
+        // TODO [W-16102411]: we can safely remove this backwards compatible code in 256
+        if (isDraftQueueStateChangeEvent(event) &&
+            event.state === DraftQueueState.Waiting &&
+            this.listenerVersion === undefined) {
+            return false;
+        }
+        return this.draftEventsShouldBeEmitted.includes(event.type);
+    }
     constructor(draftQueue) {
         this.listeners = [];
         this.draftEventsShouldBeEmitted = [
@@ -6618,7 +6661,7 @@ class DraftManager {
         ];
         this.draftQueue = draftQueue;
         draftQueue.registerOnChangedListener((event) => {
-            if (this.draftEventsShouldBeEmitted.includes(event.type)) {
+            if (this.shouldEmitEvent(event)) {
                 return this.callListeners(event);
             }
             return Promise.resolve();
@@ -6648,6 +6691,8 @@ class DraftManager {
                 return DraftQueueOperationType.QueueStarted;
             case DraftQueueState.Stopped:
                 return DraftQueueOperationType.QueueStopped;
+            case DraftQueueState.Waiting:
+                return DraftQueueOperationType.QueueWaiting;
             default:
                 throw Error('Unsupported event type');
         }
@@ -6705,7 +6750,8 @@ class DraftManager {
      *
      * @param listener The listener closure to subscribe to changes
      */
-    registerDraftQueueChangedListener(listener) {
+    registerDraftQueueChangedListener(listener, version = undefined) {
+        this.listenerVersion = version;
         this.listeners.push(listener);
         return () => {
             this.listeners = this.listeners.filter((l) => {
@@ -8530,6 +8576,7 @@ class QuickActionExecutionRepresentationHandler extends AbstractResourceRequestA
             isCreated: true,
             isSuccess: true,
             successMessage: `record created.`,
+            drafts: { draftActionId: action.id },
         });
     }
     getDraftMetadata(_key) {
@@ -8647,6 +8694,7 @@ class UpdateRecordQuickActionExecutionRepresentationHandler extends AbstractReso
             isCreated: false,
             isSuccess: true,
             successMessage: `record updated.`,
+            drafts: { draftActionId: action.id },
         });
     }
     async getDraftMetadata(key) {
@@ -18530,4 +18578,4 @@ register({
 });
 
 export { O11Y_NAMESPACE_LDS_MOBILE, getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.302.0-e45992a1f4
+// version: 1.303.0-a698c7cc67

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-mobile",
-    "version": "1.302.0",
+    "version": "1.303.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS runtime for mobile/hybrid environments.",
     "main": "dist/main.js",
@@ -32,27 +32,27 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-runtime-mobile"
     },
     "dependencies": {
-        "@salesforce/lds-adapters-uiapi-mobile": "^1.302.0",
-        "@salesforce/lds-bindings": "^1.302.0",
-        "@salesforce/lds-instrumentation": "^1.302.0",
-        "@salesforce/lds-priming": "^1.302.0",
+        "@salesforce/lds-adapters-uiapi-mobile": "^1.303.0",
+        "@salesforce/lds-bindings": "^1.303.0",
+        "@salesforce/lds-instrumentation": "^1.303.0",
+        "@salesforce/lds-priming": "^1.303.0",
         "@salesforce/user": "0.0.21",
         "o11y": "250.7.0"
     },
     "devDependencies": {
-        "@salesforce/lds-adapters-graphql": "^1.302.0",
-        "@salesforce/lds-drafts": "^1.302.0",
-        "@salesforce/lds-drafts-adapters-uiapi": "^1.302.0",
-        "@salesforce/lds-durable-records": "^1.302.0",
-        "@salesforce/lds-graphql-eval": "^1.302.0",
-        "@salesforce/lds-graphql-local-evaluation": "^1.302.0",
-        "@salesforce/lds-network-adapter": "^1.302.0",
-        "@salesforce/lds-network-nimbus": "^1.302.0",
-        "@salesforce/lds-store-binary": "^1.302.0",
-        "@salesforce/lds-store-nimbus": "^1.302.0",
-        "@salesforce/lds-store-sql": "^1.302.0",
-        "@salesforce/lds-utils-adapters": "^1.302.0",
-        "@salesforce/nimbus-plugin-lds": "^1.302.0",
+        "@salesforce/lds-adapters-graphql": "^1.303.0",
+        "@salesforce/lds-drafts": "^1.303.0",
+        "@salesforce/lds-drafts-adapters-uiapi": "^1.303.0",
+        "@salesforce/lds-durable-records": "^1.303.0",
+        "@salesforce/lds-graphql-eval": "^1.303.0",
+        "@salesforce/lds-graphql-local-evaluation": "^1.303.0",
+        "@salesforce/lds-network-adapter": "^1.303.0",
+        "@salesforce/lds-network-nimbus": "^1.303.0",
+        "@salesforce/lds-store-binary": "^1.303.0",
+        "@salesforce/lds-store-nimbus": "^1.303.0",
+        "@salesforce/lds-store-sql": "^1.303.0",
+        "@salesforce/lds-utils-adapters": "^1.303.0",
+        "@salesforce/nimbus-plugin-lds": "^1.303.0",
         "babel-plugin-dynamic-import-node": "^2.3.3",
         "wait-for-expect": "^3.0.2"
     },

package/sfdc/main.js

@@ -1575,6 +1575,32 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         }, revivingStore).finally(() => {
         });
     };
+    const expirePossibleStaleRecords = async function (keys$1, config, refresh) {
+        validateNotDisposed();
+        const metadataKeys = keys$1.map(serializeStructuredKey);
+        const now = Date.now();
+        const entries = await durableStore.getMetadata(metadataKeys, DefaultDurableSegment);
+        if (entries === undefined || keys$8(entries).length === 0) {
+            return environment.expirePossibleStaleRecords(keys$1);
+        }
+        let metaDataChanged = false;
+        const metadataEntries = metadataKeys.reduce((accu, key) => {
+            const metadataEntry = entries[key];
+            if (metadataEntry.metadata !== undefined) {
+                const metadata = { ...metadataEntry.metadata, expirationTimestamp: now };
+                accu[key] = { metadata };
+                metaDataChanged = true;
+            }
+            return accu;
+        }, {});
+        if (metaDataChanged) {
+            await durableStore.setMetadata(metadataEntries, DefaultDurableSegment);
+        }
+        if (config !== undefined && refresh !== undefined) {
+            return environment.refreshPossibleStaleRecords(config, refresh);
+        }
+        return Promise.resolve();
+    };
     // set the default cache policy of the base environment
     environment.setDefaultCachePolicy({
         type: 'stale-while-revalidate',
@@ -1607,6 +1633,7 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         handleErrorResponse: { value: handleErrorResponse },
         getNotifyChangeStoreEntries: { value: getNotifyChangeStoreEntries },
         notifyStoreUpdateAvailable: { value: notifyStoreUpdateAvailable },
+        expirePossibleStaleRecords: { value: expirePossibleStaleRecords },
     });
 }
 
@@ -5655,7 +5682,7 @@ class DurableDraftQueue {
         if (status === DraftActionStatus.Error) {
             this.state = DraftQueueState.Error;
             this.processingAction = undefined;
-            this.notifyChangedListeners({
+            await this.notifyChangedListeners({
                 type: DraftQueueEventType.ActionFailed,
                 action: action,
             });
@@ -5671,7 +5698,7 @@ class DurableDraftQueue {
         if (this.state === DraftQueueState.Waiting) {
             this.state = DraftQueueState.Started;
         }
-        this.notifyChangedListeners({
+        await this.notifyChangedListeners({
             type: DraftQueueEventType.ActionUploading,
             action: { ...action, status: DraftActionStatus.Uploading },
         });
@@ -5778,17 +5805,21 @@ class DurableDraftQueue {
         });
         return action;
     }
-    scheduleRetryWithSpecifiedDelay(retryDelayInMs) {
+    async scheduleRetryWithSpecifiedDelay(retryDelayInMs) {
+        await this.notifyChangedListeners({
+            type: DraftQueueEventType.QueueStateChanged,
+            state: DraftQueueState.Waiting,
+        });
         this.timeoutHandler = setTimeout(() => {
             if (this.state !== DraftQueueState.Stopped) {
                 this.processNextAction();
             }
         }, retryDelayInMs);
     }
-    scheduleRetry() {
+    async scheduleRetry() {
         const newInterval = this.retryIntervalMilliseconds * 2;
         this.retryIntervalMilliseconds = Math.min(Math.max(newInterval, this.minimumRetryInterval), this.maximumRetryInterval);
-        this.scheduleRetryWithSpecifiedDelay(this.retryIntervalMilliseconds);
+        return this.scheduleRetryWithSpecifiedDelay(this.retryIntervalMilliseconds);
     }
     async getActionsForReplaceOrMerge(targetActionId, sourceActionId) {
         const actions = await this.getQueueActions();
@@ -5914,7 +5945,8 @@ class DurableDraftStore {
             const actionArray = [];
             for (let i = 0, len = keys$1.length; i < len; i++) {
                 const key = keys$1[i];
-                actionArray.push(draftStore[key]);
+                // clone draft so we don't expose the internal draft store
+                actionArray.push(clone$1(draftStore[key]));
             }
             return actionArray;
         });
@@ -6563,6 +6595,7 @@ var DraftQueueOperationType;
     DraftQueueOperationType["ItemUpdated"] = "updated";
     DraftQueueOperationType["QueueStarted"] = "started";
     DraftQueueOperationType["QueueStopped"] = "stopped";
+    DraftQueueOperationType["QueueWaiting"] = "waiting";
 })(DraftQueueOperationType || (DraftQueueOperationType = {}));
 /**
  * Converts the internal DraftAction's ResourceRequest into
@@ -6605,6 +6638,16 @@ function toQueueState(queue) {
     };
 }
 class DraftManager {
+    shouldEmitEvent(event) {
+        // Waiting events cannot be emitted prior to 252 native clients
+        // TODO [W-16102411]: we can safely remove this backwards compatible code in 256
+        if (isDraftQueueStateChangeEvent(event) &&
+            event.state === DraftQueueState.Waiting &&
+            this.listenerVersion === undefined) {
+            return false;
+        }
+        return this.draftEventsShouldBeEmitted.includes(event.type);
+    }
     constructor(draftQueue) {
         this.listeners = [];
         this.draftEventsShouldBeEmitted = [
@@ -6618,7 +6661,7 @@ class DraftManager {
         ];
         this.draftQueue = draftQueue;
         draftQueue.registerOnChangedListener((event) => {
-            if (this.draftEventsShouldBeEmitted.includes(event.type)) {
+            if (this.shouldEmitEvent(event)) {
                 return this.callListeners(event);
             }
             return Promise.resolve();
@@ -6648,6 +6691,8 @@ class DraftManager {
                 return DraftQueueOperationType.QueueStarted;
             case DraftQueueState.Stopped:
                 return DraftQueueOperationType.QueueStopped;
+            case DraftQueueState.Waiting:
+                return DraftQueueOperationType.QueueWaiting;
             default:
                 throw Error('Unsupported event type');
         }
@@ -6705,7 +6750,8 @@ class DraftManager {
      *
      * @param listener The listener closure to subscribe to changes
      */
-    registerDraftQueueChangedListener(listener) {
+    registerDraftQueueChangedListener(listener, version = undefined) {
+        this.listenerVersion = version;
         this.listeners.push(listener);
         return () => {
             this.listeners = this.listeners.filter((l) => {
@@ -8530,6 +8576,7 @@ class QuickActionExecutionRepresentationHandler extends AbstractResourceRequestA
             isCreated: true,
             isSuccess: true,
             successMessage: `record created.`,
+            drafts: { draftActionId: action.id },
         });
     }
     getDraftMetadata(_key) {
@@ -8647,6 +8694,7 @@ class UpdateRecordQuickActionExecutionRepresentationHandler extends AbstractReso
             isCreated: false,
             isSuccess: true,
             successMessage: `record updated.`,
+            drafts: { draftActionId: action.id },
         });
     }
     async getDraftMetadata(key) {
@@ -18530,4 +18578,4 @@ register({
 });
 
 export { O11Y_NAMESPACE_LDS_MOBILE, getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.302.0-e45992a1f4
+// version: 1.303.0-a698c7cc67