@salesforce/lds-drafts 1.304.0 → 1.306.0

package/dist/ldsDrafts.js

@@ -793,6 +793,29 @@ class DurableDraftQueue {
     mergeActions(targetActionId, sourceActionId) {
         return this.replaceOrMergeActions(targetActionId, sourceActionId, true);
     }
+    async retryAction(actionId) {
+        this.stopQueueManually();
+        const actions = await this.getQueueActions();
+        const target = actions[0];
+        if (!target || target.id !== actionId) {
+            throw Error(`Action ${actionId} not found at the head of the draft queue`);
+        }
+        if (!isDraftError(target)) {
+            throw Error(`Action ${actionId} is not in Error state`);
+        }
+        let pendingAction = {
+            ...target,
+            status: DraftActionStatus.Pending,
+            error: undefined,
+        };
+        await this.draftStore.writeAction(pendingAction);
+        await this.notifyChangedListeners({
+            type: DraftQueueEventType.ActionUpdated,
+            action: pendingAction,
+        });
+        await this.startQueueSafe();
+        return pendingAction;
+    }
     async setMetadata(actionId, metadata) {
         const keys$1 = keys(metadata);
         const compatibleKeys = keys$1.filter((key) => {
@@ -1605,9 +1628,14 @@ var DraftQueueOperationType;
     DraftQueueOperationType["ItemCompleted"] = "completed";
     DraftQueueOperationType["ItemFailed"] = "failed";
     DraftQueueOperationType["ItemUpdated"] = "updated";
+    /** @deprecated in 252. All Queue state changed events are consolidated in QueueStateChanged
+     * Planned to be removed in 256 (W-16217436) */
     DraftQueueOperationType["QueueStarted"] = "started";
+    /** @deprecated in 252. All Queue state changed events are consolidated in QueueStateChanged
+     * Planned to be removed in 256 (W-16217436) */
     DraftQueueOperationType["QueueStopped"] = "stopped";
-    DraftQueueOperationType["QueueWaiting"] = "waiting";
+    /** @since 252 */
+    DraftQueueOperationType["QueueStateChanged"] = "queueStateChanged";
 })(DraftQueueOperationType || (DraftQueueOperationType = {}));
 /**
  * Converts the internal DraftAction's ResourceRequest into
@@ -1703,8 +1731,6 @@ class DraftManager {
                 return DraftQueueOperationType.QueueStarted;
             case DraftQueueState.Stopped:
                 return DraftQueueOperationType.QueueStopped;
-            case DraftQueueState.Waiting:
-                return DraftQueueOperationType.QueueWaiting;
             default:
                 throw Error('Unsupported event type');
         }
@@ -1877,7 +1903,12 @@ class DraftManager {
         const managerState = await this.getQueue();
         let operationType, item;
         if (isDraftQueueStateChangeEvent(event)) {
-            operationType = this.draftQueueStateToOperationType(event.state);
+            if (this.listenerVersion === undefined) {
+                operationType = this.draftQueueStateToOperationType(event.state);
+            }
+            else {
+                operationType = DraftQueueOperationType.QueueStateChanged;
+            }
         }
         else {
             const { action, type } = event;
@@ -1939,6 +1970,18 @@ class DraftManager {
             return this.buildDraftQueueItem(updatedAction);
         });
     }
+    /**
+     * Retries a draft action that is in error state without any modification.
+     *
+     * @param actionId The id of the draft action that should be retried
+     * @throws If the draft action is not at the front of the draft queue or is not
+     * in error state.
+     */
+    async retryAction(actionId) {
+        return this.draftQueue.retryAction(actionId).then((updatedAction) => {
+            return this.buildDraftQueueItem(updatedAction);
+        });
+    }
 }
 
 function makeEnvironmentDraftAware(luvio, env, durableStore, handlers, draftQueue) {

package/dist/types/DraftManager.d.ts

@@ -72,9 +72,14 @@ export declare enum DraftQueueOperationType {
     ItemCompleted = "completed",
     ItemFailed = "failed",
     ItemUpdated = "updated",
+    /** @deprecated in 252. All Queue state changed events are consolidated in QueueStateChanged
+     * Planned to be removed in 256 (W-16217436) */
     QueueStarted = "started",
+    /** @deprecated in 252. All Queue state changed events are consolidated in QueueStateChanged
+     * Planned to be removed in 256 (W-16217436) */
     QueueStopped = "stopped",
-    QueueWaiting = "waiting"
+    /** @since 252 */
+    QueueStateChanged = "queueStateChanged"
 }
 /**
  * A closure that draft queue change listeners pass to
@@ -171,4 +176,12 @@ export declare class DraftManager {
      * @param metadata The metadata to set on the specified action
      */
     setMetadata(actionId: string, metadata: DraftQueueItemMetadata): Promise<DraftQueueItem>;
+    /**
+     * Retries a draft action that is in error state without any modification.
+     *
+     * @param actionId The id of the draft action that should be retried
+     * @throws If the draft action is not at the front of the draft queue or is not
+     * in error state.
+     */
+    retryAction(actionId: string): Promise<DraftQueueItem>;
 }

package/dist/types/DraftQueue.d.ts

@@ -235,6 +235,14 @@ export interface DraftQueue {
      * action will be removed after the merge.
      */
     mergeActions<Data, Response>(targetActionId: string, sourceActionId: string): Promise<DraftAction<Data, Response>>;
+    /**
+     * Retries a draft action that is in error state without any modification.
+     *
+     * @param actionId The id of the draft action that should be retried
+     * @throws If the draft action is not at the front of the draft queue or is not
+     * in error state.
+     */
+    retryAction<Data, Response>(actionId: string): Promise<DraftAction<Data, Response>>;
     /** Set the draft queue state to Started and process the next item */
     startQueue(): Promise<void>;
     /** Set the draft queue state to Stopped and don't let another item begin */

package/dist/types/DurableDraftQueue.d.ts

@@ -49,6 +49,7 @@ export declare class DurableDraftQueue implements DraftQueue {
     private statusOfAction;
     replaceAction<Data, Response>(targetActionId: string, sourceActionId: string): Promise<DraftAction<Data, Response>>;
     mergeActions<Data, Response>(targetActionId: string, sourceActionId: string): Promise<DraftAction<Data, Response>>;
+    retryAction<Data, Response>(actionId: string): Promise<DraftAction<Data, Response>>;
     setMetadata(actionId: string, metadata: DraftActionMetadata): Promise<DraftAction<unknown, unknown>>;
     private scheduleRetryWithSpecifiedDelay;
     private scheduleRetry;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-drafts",
-    "version": "1.304.0",
+    "version": "1.306.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS Drafts",
     "main": "dist/ldsDrafts.js",
@@ -26,7 +26,7 @@
     "dependencies": {
         "@luvio/engine": "0.156.3",
         "@luvio/environments": "0.156.3",
-        "@salesforce/lds-utils-adapters": "^1.304.0"
+        "@salesforce/lds-utils-adapters": "^1.306.0"
     },
     "volta": {
         "extends": "../../package.json"