@salesforce/lds-worker-api 1.461.0 → 1.463.0

package/dist/sfdc/es/ldsWorkerApi.js

@@ -359,19 +359,7 @@ function invokeDmlAdapter(adapter, configObject, onResponse, nativeAdapterReques
 function invokeAdapterWithDraftToReplace(adapterId, config, draftIdToReplace, onResponse, nativeAdapterRequestContext) {
     invokeAdapterWithDraftToMerge(adapterId, config, draftIdToReplace, onResponse, nativeAdapterRequestContext);
 }
-/**
- * Executes the specified adapter with the given @param adapterId and @param config. Then
- * it merges the draft with the given id with the draft generated by
- * the mutating adapter. Will call onResult callback once with data or error.
- *
- * This function returns an error if the given adapterId cannot be found, or if the
- * adapterId is not a mutating adapter if a draft isn't created, or
- * if it fails to parse the given config string.
- *
- * If the @param adapterId is deleteRecod, the invocation of it will generate a delele draft.
- * The newly generated delete draft will replace the draft specified by @param targetDraftId
- */
-function invokeAdapterWithDraftToMerge(adapterId, config, targetDraftId, onResponse, nativeAdapterRequestContext) {
+function invokeAdapterWithDraftToMergeAndMetadata(adapterId, config, targetDraftId, metadata, onResponse, nativeAdapterRequestContext) {
     const adapter = getDMLAdapterFromName(adapterId);
     if (adapter === undefined) {
         // Check if the adapter is non-mutating adapter and create proper error message.
@@ -387,10 +375,12 @@ function invokeAdapterWithDraftToMerge(adapterId, config, targetDraftId, onRespo
     // deleteRecord adapter call will generate a delete draft and
     // the newly generate draft will replace the target draft
     if (adapterId === 'deleteRecord') {
-        invokeAdapterWithDraftToMergeDeleteRecord(adapter, config, targetDraftId, onResponse, nativeAdapterRequestContext);
+        invokeAdapterWithDraftToMergeDeleteRecord(adapter, config, targetDraftId, metadata, onResponse, nativeAdapterRequestContext);
         return;
     }
-    draftManager.getQueue().then((draftInfo) => {
+    draftManager
+        .getQueue()
+        .then((draftInfo) => {
         const draftIds = draftInfo.items.map((draft) => draft.id);
         if (draftIds.includes(targetDraftId) === false) {
             onResponse({
@@ -407,14 +397,32 @@ function invokeAdapterWithDraftToMerge(adapterId, config, targetDraftId, onRespo
                 const draftId = draftIds[draftIds.length - 1];
                 draftManager
                     .mergeActions(targetDraftId, draftId)
-                    .then(() => {
+                    .then(async () => {
                     if (responseValue.data === undefined ||
                         responseValue.data.drafts === undefined) {
                         onResponse(responseValue);
                         return;
                     }
                     const newResponse = removeDraftNodeActionId(draftId, responseValue);
-                    onResponse(newResponse);
+                    if (metadata !== undefined) {
+                        const mergedState = await draftManager.getQueue();
+                        const mergedItem = mergedState.items.find((item) => item.id === targetDraftId);
+                        const mergedMetadata = mergedItem?.metadata ?? {};
+                        draftManager
+                            .setMetadata(targetDraftId, {
+                            ...mergedMetadata,
+                            ...metadata,
+                        })
+                            .then(() => {
+                            onResponse(newResponse);
+                        })
+                            .catch((error) => {
+                            onResponse(convertErrorIntoNativeFetchError(error, 'Unable to set metadata on draft'));
+                        });
+                    }
+                    else {
+                        onResponse(newResponse);
+                    }
                 })
                     .catch((error) => {
                     onResponse(convertErrorIntoNativeFetchError(error, `Unknown error merging draft`));
@@ -426,8 +434,26 @@ function invokeAdapterWithDraftToMerge(adapterId, config, targetDraftId, onRespo
                 onResponse(response);
             }
         }, nativeAdapterRequestContext);
+    })
+        .catch((error) => {
+        onResponse(convertErrorIntoNativeFetchError(error, 'Unable to get draft queue'));
     });
 }
+/**
+ * Executes the specified adapter with the given @param adapterId and @param config. Then
+ * it merges the draft with the given id with the draft generated by
+ * the mutating adapter. Will call onResult callback once with data or error.
+ *
+ * This function returns an error if the given adapterId cannot be found, or if the
+ * adapterId is not a mutating adapter if a draft isn't created, or
+ * if it fails to parse the given config string.
+ *
+ * If the @param adapterId is deleteRecod, the invocation of it will generate a delele draft.
+ * The newly generated delete draft will replace the draft specified by @param targetDraftId
+ */
+function invokeAdapterWithDraftToMerge(adapterId, config, targetDraftId, onResponse, nativeAdapterRequestContext) {
+    invokeAdapterWithDraftToMergeAndMetadata(adapterId, config, targetDraftId, undefined, onResponse, nativeAdapterRequestContext);
+}
 /**
  * Executes the specified adapter with the given adapterId and config. Then
  * it sets the given metadata on the draft created by the mutating adapter.  Will call
@@ -563,18 +589,20 @@ This is a special case version of the invokeAdapterWithDraftToMerge function
 which should only be used for the deleteRecord wire adapter, since it does not
 contain record data in the result and has to do special querying of the draft queue
 */
-function invokeAdapterWithDraftToMergeDeleteRecord(adapter, config, draftIdToReplace, onResponse, nativeAdapterRequestContext) {
+function invokeAdapterWithDraftToMergeDeleteRecord(adapter, config, draftIdToReplace, metadata, onResponse, nativeAdapterRequestContext) {
     const targetedRecordId = parse(config);
     let priorDraftIds;
-    draftManager.getQueue().then((draftState) => {
-        priorDraftIds = draftState.items.map((item) => {
-            return item.id;
-        });
+    draftManager
+        .getQueue()
+        .then((draftState) => {
+        priorDraftIds = draftState.items.map((item) => item.id);
         invokeDmlAdapter(adapter, parse(config), (responseValue) => {
             if (responseValue.error === undefined &&
                 responseValue.errors === undefined &&
                 responseValue.data === undefined) {
-                draftManager.getQueue().then((newState) => {
+                draftManager
+                    .getQueue()
+                    .then((newState) => {
                     const draftIdsToFilter = priorDraftIds ? priorDraftIds : [];
                     const newDrafts = newState.items;
                     const addedDrafts = newDrafts.filter((item) => {
@@ -591,13 +619,35 @@ function invokeAdapterWithDraftToMergeDeleteRecord(adapter, config, draftIdToRep
                     else {
                         draftManager
                             .replaceAction(draftIdToReplace, addedDrafts[0].id)
-                            .then(() => {
-                            onResponse(responseValue);
+                            .then((replacedDraft) => {
+                            if (metadata !== undefined) {
+                                // Spread the metadata returned by replaceAction
+                                // (not the pre-replace snapshot) so that keys the
+                                // replacement clears — notably retryCount — stay
+                                // cleared instead of being reintroduced here.
+                                draftManager
+                                    .setMetadata(draftIdToReplace, {
+                                    ...replacedDraft.metadata,
+                                    ...metadata,
+                                })
+                                    .then(() => {
+                                    onResponse(responseValue);
+                                })
+                                    .catch((error) => {
+                                    onResponse(convertErrorIntoNativeFetchError(error, 'Unable to set metadata on draft'));
+                                });
+                            }
+                            else {
+                                onResponse(responseValue);
+                            }
                         })
                             .catch((error) => {
                             onResponse(convertErrorIntoNativeFetchError(error, 'Unknown error replacing action'));
                         });
                     }
+                })
+                    .catch((error) => {
+                    onResponse(convertErrorIntoNativeFetchError(error, 'Unable to get draft queue'));
                 });
             }
             else {
@@ -606,6 +656,9 @@ function invokeAdapterWithDraftToMergeDeleteRecord(adapter, config, draftIdToRep
                 onResponse(response);
             }
         }, nativeAdapterRequestContext);
+    })
+        .catch((error) => {
+        onResponse(convertErrorIntoNativeFetchError(error, 'Unable to get draft queue'));
     });
 }
 function removeDraftNodeActionId(targetDraftId, responseValue) {
@@ -1372,5 +1425,5 @@ if (process.env.NODE_ENV !== 'production') {
     });
 }
 
-export { createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, importLuvioAdapterModule, importOneStoreAdapterModule, invokeAdapter, invokeAdapterWithDraftToMerge, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, stopEviction, subscribeToAdapter };
-// version: 1.461.0-37b1c9d1cb
+export { createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, importLuvioAdapterModule, importOneStoreAdapterModule, invokeAdapter, invokeAdapterWithDraftToMerge, invokeAdapterWithDraftToMergeAndMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, stopEviction, subscribeToAdapter };
+// version: 1.463.0-ea9ecd17fc

package/dist/sfdc/es/types/executeAdapter.d.ts

@@ -57,6 +57,7 @@ export declare function subscribeToAdapter(adapterId: string, config: string, on
  * Will be removed in future, ideally 2 releases later.
  */
 export declare function invokeAdapterWithDraftToReplace(adapterId: string, config: string, draftIdToReplace: string, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
+export declare function invokeAdapterWithDraftToMergeAndMetadata(adapterId: string, config: string, targetDraftId: string, metadata: DraftQueueItemMetadata | undefined, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
 /**
  * Executes the specified adapter with the given @param adapterId and @param config. Then
  * it merges the draft with the given id with the draft generated by

package/dist/sfdc/es/types/main.d.ts

@@ -1,4 +1,4 @@
-import { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithDraftToMerge, executeAdapter, executeMutatingAdapter } from './executeAdapter';
+import { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithDraftToMerge, invokeAdapterWithDraftToMergeAndMetadata, executeAdapter, executeMutatingAdapter } from './executeAdapter';
 import { getImperativeAdapterNames } from './lightningAdapterApi';
 import { nimbusDraftQueue } from './nimbusDraftQueue';
 import { draftQueue, draftManager } from './draftQueueImplementation';
@@ -8,4 +8,4 @@ import { createPrimingSession } from './primingApi';
 import { evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction } from './cachePurging';
 import { importLuvioAdapterModule } from './customLuvioAdapter';
 import { importOneStoreAdapterModule } from './customOneStoreAdapter';
-export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithDraftToMerge, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction, importLuvioAdapterModule, importOneStoreAdapterModule, };
+export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithDraftToMerge, invokeAdapterWithDraftToMergeAndMetadata, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction, importLuvioAdapterModule, importOneStoreAdapterModule, };