@salesforce/lds-drafts 1.100.4 → 1.100.5

package/dist/DraftQueue.d.ts

@@ -144,15 +144,19 @@ export interface UpdateQueueOperation {
     action: DraftAction<unknown, unknown>;
 }
 export type QueueOperation = UpdateQueueOperation | AddQueueOperation | DeleteQueueOperation;
+export interface EnqueueResult<Data, Response> {
+    action: PendingDraftAction<Data>;
+    data: Response;
+}
 export interface DraftQueue {
     /**
      * Enqueues a draft action into the DraftQueue
      * @param handlerId the id of the handler associated with the data
      * @param data the data the handler will use to create the draft action with
-     * @returns A promise including the pending action created for the request
+     * @returns A promise including the pending action created for the request and the data associated with the action
      * @throws {Error} An error when a proper action handler is not found or conditions are not met to enqueue the action
      */
-    enqueue<Response>(handlerId: string, data: unknown): Promise<PendingDraftAction<Response>>;
+    enqueue<Data, Response>(handlerId: string, data: Data): Promise<EnqueueResult<Data, Response>>;
     /**
      * add a new handler to the draft queue to process the data in the actions
      * @param id identifier to the handler
@@ -225,11 +229,5 @@ export interface DraftQueue {
      * @param metadata The metadata to set on the specified action
      */
     setMetadata(actionId: string, metadata: DraftActionMetadata): Promise<DraftAction<unknown, unknown>>;
-    /**
-     * Gets the data associated with the passed in action. This data will have drafts applied to it
-     * @param action
-     * @returns the data for the given action or undefined if the data no longer exists
-     */
-    getDataForAction<T>(action: DraftAction<T, unknown>): Promise<T | undefined>;
 }
 export {};

package/dist/DurableDraftQueue.d.ts

@@ -1,4 +1,4 @@
-import type { DraftQueue, DraftAction, CompletedDraftAction, PendingDraftAction, DraftQueueChangeListener, DraftActionMetadata } from './DraftQueue';
+import type { DraftQueue, DraftAction, CompletedDraftAction, DraftQueueChangeListener, DraftActionMetadata, EnqueueResult } from './DraftQueue';
 import { ProcessActionResult, DraftQueueState } from './DraftQueue';
 import type { CustomActionExecutor } from './actionHandlers/CustomActionHandler';
 import type { ActionHandler } from './actionHandlers/ActionHandler';
@@ -23,7 +23,6 @@ export declare class DurableDraftQueue implements DraftQueue {
     addHandler<Data>(handler: ActionHandler<Data, unknown, unknown>): Promise<void>;
     removeHandler(id: string): Promise<void>;
     addCustomHandler(id: string, executor: CustomActionExecutor): Promise<void>;
-    getDataForAction<T>(action: DraftAction<T, unknown>): Promise<T | undefined>;
     getQueueState(): DraftQueueState;
     startQueue(): Promise<void>;
     stopQueue(): Promise<void>;
@@ -32,7 +31,7 @@ export declare class DurableDraftQueue implements DraftQueue {
      */
     private stopQueueManually;
     getQueueActions<Data = unknown, Response = unknown>(): Promise<DraftAction<Data, Response>[]>;
-    enqueue<Data>(handlerId: string, data: unknown): Promise<PendingDraftAction<Data>>;
+    enqueue<Data, Response>(handlerId: string, data: unknown): Promise<EnqueueResult<Data, Response>>;
     registerOnChangedListener(listener: DraftQueueChangeListener): () => Promise<void>;
     actionCompleted(action: CompletedDraftAction<unknown, unknown>): Promise<void>;
     actionFailed(action: DraftAction<unknown, unknown>, retry: boolean): Promise<void>;

package/dist/actionHandlers/AbstractResourceRequestActionHandler.d.ts

@@ -1,5 +1,5 @@
 import type { NetworkAdapter, ResourceRequest, Luvio, DurableStoreKeyMetadataMap } from '@luvio/engine';
-import type { DraftAction, CompletedDraftAction, QueueOperation, PendingDraftAction, DraftActionMetadata, DraftQueue } from '../DraftQueue';
+import type { DraftAction, CompletedDraftAction, QueueOperation, PendingDraftAction, DraftActionMetadata, DraftQueue, EnqueueResult } from '../DraftQueue';
 import { ProcessActionResult } from '../DraftQueue';
 import type { ActionHandler, DraftIdAndKeyMapping, ReplacingActions } from './ActionHandler';
 export type ResponseIngestionEntry<T = unknown> = {
@@ -15,7 +15,7 @@ export declare abstract class AbstractResourceRequestActionHandler<ResponseType,
         [key: string]: string;
     };
     constructor(draftQueue: DraftQueue, networkAdapter: NetworkAdapter, getLuvio: () => Luvio);
-    enqueue(data: ResourceRequest): Promise<PendingDraftAction<ResourceRequest>>;
+    enqueue(data: ResourceRequest): Promise<EnqueueResult<ResourceRequest, ResponseType>>;
     handleAction(action: DraftAction<ResourceRequest, ResponseType>, actionCompleted: (action: CompletedDraftAction<ResourceRequest, ResponseType>) => Promise<void>, actionErrored: (action: DraftAction<ResourceRequest, ResponseType>, retry: boolean) => Promise<void>): Promise<ProcessActionResult>;
     buildPendingAction(request: ResourceRequest, queue: DraftAction<unknown, unknown>[]): Promise<PendingDraftAction<ResourceRequest>>;
     handleActionEnqueued(action: PendingDraftAction<ResourceRequest>): Promise<void>;

package/dist/actionHandlers/ActionHandler.d.ts

@@ -1,4 +1,4 @@
-import type { CompletedDraftAction, DraftAction, DraftActionMetadata, PendingDraftAction, ProcessActionResult, QueueOperation } from '../DraftQueue';
+import type { CompletedDraftAction, DraftAction, DraftActionMetadata, EnqueueResult, PendingDraftAction, ProcessActionResult, QueueOperation } from '../DraftQueue';
 import type { DraftKeyMapping } from '../DraftIdMapping';
 export interface ReplacingActions<Response, Data> {
     original: DraftAction<Response, Data>;
@@ -36,7 +36,7 @@ export interface ActionHandler<Data, DraftMetadata, Type> {
      * Enqueues an action to the draft queue
      * @param data the data that will get added to the draft action
      */
-    enqueue(data: Data): Promise<PendingDraftAction<Data>>;
+    enqueue(data: Data): Promise<EnqueueResult<Data, Type>>;
     /**
      * Used to build a PendingDraftAction that is specific to the type of Data and Response.
      * @param data

package/dist/ldsDrafts.js

@@ -191,14 +191,13 @@ const { isArray } = Array;
 function buildLuvioOverrideForDraftAdapters(luvio, handler, extractTargetIdFromCacheKey, options = {}) {
     // override this to create and enqueue a new draft action, and return synthetic response
     const dispatchResourceRequest = async function (resourceRequest, _context) {
-        const action = await handler.enqueue(resourceRequest).catch((err) => {
+        const { data } = await handler.enqueue(resourceRequest).catch((err) => {
             throw transformErrorToDraftSynthesisError(err);
         });
-        const record = await handler.getDataForAction(action);
-        if (record === undefined) {
+        if (data === undefined) {
             return Promise.reject(createDraftSynthesisErrorResponse());
         }
-        return createOkResponse(record);
+        return createOkResponse(data);
     };
     // override this to use an infinitely large ttl so the cache entry never expires
     const publishStoreMetadata = function (key, storeMetadataParams) {
@@ -443,10 +442,6 @@ class DurableDraftQueue {
         const handler = customActionHandler(executor, id, this);
         return this.addHandler(handler);
     }
-    async getDataForAction(action) {
-        const handler = this.getHandler(action.handler);
-        return handler.getDataForAction(action);
-    }
     getQueueState() {
         return this.state;
     }
@@ -539,7 +534,11 @@ class DurableDraftQueue {
             if (this.state === DraftQueueState.Started) {
                 this.processNextAction();
             }
-            return pendingAction;
+            const actionData = (await handler.getDataForAction(pendingAction));
+            return {
+                action: pendingAction,
+                data: actionData,
+            };
         });
     }
     registerOnChangedListener(listener) {
@@ -1483,7 +1482,9 @@ class DraftManager {
             targetId,
             tag,
         })
-            .then(this.buildDraftQueueItem);
+            .then((result) => {
+            return this.buildDraftQueueItem(result.action);
+        });
     }
     /**
      * Get the current state of each of the DraftActions in the DraftQueue

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-drafts",
-    "version": "1.100.4",
+    "version": "1.100.5",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS Drafts",
     "main": "dist/ldsDrafts.js",
@@ -26,6 +26,6 @@
     "dependencies": {
         "@luvio/engine": "0.135.4",
         "@luvio/environments": "0.135.4",
-        "@salesforce/lds-utils-adapters": "^1.100.4"
+        "@salesforce/lds-utils-adapters": "^1.100.5"
     }
 }