@salesforce/lds-drafts 1.301.0 → 1.303.0

package/dist/ldsDrafts.js

@@ -669,7 +669,7 @@ class DurableDraftQueue {
         if (status === DraftActionStatus.Error) {
             this.state = DraftQueueState.Error;
             this.processingAction = undefined;
-            this.notifyChangedListeners({
+            await this.notifyChangedListeners({
                 type: DraftQueueEventType.ActionFailed,
                 action: action,
             });
@@ -685,7 +685,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 },
         });
@@ -792,17 +792,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();
@@ -928,7 +932,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(draftStore[key]));
             }
             return actionArray;
         });
@@ -1577,6 +1582,7 @@ var DraftQueueOperationType;
     DraftQueueOperationType["ItemUpdated"] = "updated";
     DraftQueueOperationType["QueueStarted"] = "started";
     DraftQueueOperationType["QueueStopped"] = "stopped";
+    DraftQueueOperationType["QueueWaiting"] = "waiting";
 })(DraftQueueOperationType || (DraftQueueOperationType = {}));
 /**
  * Converts the internal DraftAction's ResourceRequest into
@@ -1619,6 +1625,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 = [
@@ -1632,7 +1648,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();
@@ -1662,6 +1678,8 @@ class DraftManager {
                 return DraftQueueOperationType.QueueStarted;
             case DraftQueueState.Stopped:
                 return DraftQueueOperationType.QueueStopped;
+            case DraftQueueState.Waiting:
+                return DraftQueueOperationType.QueueWaiting;
             default:
                 throw Error('Unsupported event type');
         }
@@ -1719,7 +1737,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) => {

package/dist/types/DraftManager.d.ts

@@ -68,7 +68,8 @@ export declare enum DraftQueueOperationType {
     ItemFailed = "failed",
     ItemUpdated = "updated",
     QueueStarted = "started",
-    QueueStopped = "stopped"
+    QueueStopped = "stopped",
+    QueueWaiting = "waiting"
 }
 /**
  * A closure that draft queue change listeners pass to
@@ -78,7 +79,9 @@ export declare type DraftQueueListener = (state: DraftManagerState, operationTyp
 export declare class DraftManager {
     private draftQueue;
     private listeners;
+    private listenerVersion;
     private draftEventsShouldBeEmitted;
+    private shouldEmitEvent;
     constructor(draftQueue: DraftQueue);
     private draftQueueEventTypeToOperationType;
     private draftQueueStateToOperationType;
@@ -113,7 +116,7 @@ export declare class DraftManager {
      *
      * @param listener The listener closure to subscribe to changes
      */
-    registerDraftQueueChangedListener(listener: DraftQueueListener): () => Promise<void>;
+    registerDraftQueueChangedListener(listener: DraftQueueListener, version?: 252 | undefined): () => Promise<void>;
     /**
      * Creates a custom action handler for the given handler
      * @param handlerId

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-drafts",
-    "version": "1.301.0",
+    "version": "1.303.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS Drafts",
     "main": "dist/ldsDrafts.js",
@@ -24,8 +24,8 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --adapter=lds-drafts"
     },
     "dependencies": {
-        "@luvio/engine": "0.155.1",
-        "@luvio/environments": "0.155.1",
-        "@salesforce/lds-utils-adapters": "^1.301.0"
+        "@luvio/engine": "0.156.3",
+        "@luvio/environments": "0.156.3",
+        "@salesforce/lds-utils-adapters": "^1.303.0"
     }
 }