@salesforce/lds-worker-api 1.283.0 → 1.284.0

package/dist/sfdc/es/ldsWorkerApi.js

@@ -338,63 +338,75 @@ function invokeDmlAdapter(adapter, configObject, onResponse, nativeAdapterReques
     }
 }
 /**
- * Executes the specified adapter with the given adapterId and config. Then
- * it replaces the draft with the given id with the draft generated
- * by the mutating adapter.  Will call onResult callback once with data or error.
+ * @deprecated There is no situation in which any consumer actually wants to replace the draft.
+ * call {@link invokeAdapterWithDraftToMerge} instead`.
+ * Keep it for now for app back compatibility.
+ * Will be removed in future, ideally 2 releases later.
+ */
+function invokeAdapterWithDraftToReplace(adapterId, config, draftIdToReplace, onResponse, nativeAdapterRequestContext) {
+    invokeAdapterWithDraftToMerge(adapterId, config, draftIdToReplace, onResponse, nativeAdapterRequestContext);
+}
+/**
+ * Executes the specified adapter with the given @param dapterId and @param config. Then
+ * it merge 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 throws an error if the given adapterId cannot be found, or if the
- * adapterId is not a mutating adapter, or if a draft isn't created, or if it
- * fails to parse the given config string.
+ * 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 invokeAdapterWithDraftToReplace(adapterId, config, draftIdToReplace, onResponse, nativeAdapterRequestContext) {
+function invokeAdapterWithDraftToMerge(adapterId, config, targetDraftId, onResponse, nativeAdapterRequestContext) {
+    const adapter = getDMLAdapterFromName(adapterId);
+    if (adapter === undefined) {
+        // Check if the adapter is non-mutating adapter and create proper error message.
+        const message = getImperativeAdapterFromName(imperativeAdapterKeyBuilder(adapterId)) !== undefined
+            ? NON_MUTATING_ADAPTER_MESSAGE
+            : `adapter ${adapterId} not recognized`;
+        onResponse({
+            data: undefined,
+            error: createNativeFetchErrorResponse(message),
+        });
+        return;
+    }
+    // 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);
+        return;
+    }
     draftManager.getQueue().then((draftInfo) => {
         const draftIds = draftInfo.items.map((draft) => draft.id);
-        if (draftIds.includes(draftIdToReplace) === false) {
+        if (draftIds.includes(targetDraftId) === false) {
             onResponse({
                 data: undefined,
                 error: createNativeFetchErrorResponse(DRAFT_DOESNT_EXIST_MESSAGE),
             });
             return;
         }
-        const adapter = getDMLAdapterFromName(adapterId);
-        if (adapter === undefined) {
-            // This check is here for legacy purpose
-            // So the consumers still get the same errors
-            if (getImperativeAdapterFromName(imperativeAdapterKeyBuilder(adapterId)) !== undefined) {
-                onResponse({
-                    data: undefined,
-                    error: createNativeFetchErrorResponse(NON_MUTATING_ADAPTER_MESSAGE),
+        invokeDmlAdapter(adapter, parse(config), (responseValue) => {
+            const draftIds = draftIdsForResponseValue(responseValue);
+            if (responseValue.error === undefined &&
+                draftIds !== undefined &&
+                draftIds.length > 0) {
+                const draftId = draftIds[draftIds.length - 1];
+                draftManager
+                    .mergeActions(targetDraftId, draftId)
+                    .then(() => {
+                    onResponse(responseValue);
+                })
+                    .catch((error) => {
+                    onResponse(convertErrorIntoNativeFetchError(error, `Unknown error merging draft`));
                 });
-                return;
             }
-            throw Error(`adapter ${adapterId} not recognized`);
-        }
-        if (adapterId === 'deleteRecord') {
-            invokeAdapterWithDraftToReplaceDeleteRecord(adapter, config, draftIdToReplace, onResponse, nativeAdapterRequestContext);
-        }
-        else {
-            invokeDmlAdapter(adapter, parse(config), (responseValue) => {
-                const draftIds = draftIdsForResponseValue(responseValue);
-                if (responseValue.error === undefined &&
-                    draftIds !== undefined &&
-                    draftIds.length > 0) {
-                    const draftId = draftIds[draftIds.length - 1];
-                    draftManager
-                        .replaceAction(draftIdToReplace, draftId)
-                        .then(() => {
-                        onResponse(responseValue);
-                    })
-                        .catch((error) => {
-                        onResponse(convertErrorIntoNativeFetchError(error, 'Unknown error replacing draft'));
-                    });
-                }
-                else {
-                    let response = responseValue;
-                    response.error = createNativeFetchErrorResponse(NO_DRAFT_CREATED_MESSAGE);
-                    onResponse(response);
-                }
-            }, nativeAdapterRequestContext);
-        }
+            else {
+                let response = responseValue;
+                response.error = createNativeFetchErrorResponse(NO_DRAFT_CREATED_MESSAGE);
+                onResponse(response);
+            }
+        }, nativeAdapterRequestContext);
     });
 }
 /**
@@ -502,11 +514,11 @@ function invokeAdapterWithMetadataDeleteRecord(adapter, config, metadata, onResp
 }
 /*
 //TODO W-10284305: Remove this function in 238
-This is a special case version of the invokeAdapterWithDraftToReplace function
+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 invokeAdapterWithDraftToReplaceDeleteRecord(adapter, config, draftIdToReplace, onResponse, nativeAdapterRequestContext) {
+function invokeAdapterWithDraftToMergeDeleteRecord(adapter, config, draftIdToReplace, onResponse, nativeAdapterRequestContext) {
     const targetedRecordId = parse(config);
     let priorDraftIds;
     draftManager.getQueue().then((draftState) => {
@@ -1061,5 +1073,5 @@ if (process.env.NODE_ENV !== 'production') {
     });
 }
 
-export { createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, stopEviction, subscribeToAdapter };
-// version: 1.283.0-a330da944
+export { createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToMerge, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, stopEviction, subscribeToAdapter };
+// version: 1.284.0-a7e8dc51c

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

@@ -47,15 +47,25 @@ export declare function buildAdapterRequestContext(nativeRequestContext: NativeA
  */
 export declare function subscribeToAdapter(adapterId: string, config: string, onSnapshot: NativeOnSnapshot, nativeAdapterRequestContext?: NativeAdapterRequestContext): Unsubscribe;
 /**
- * Executes the specified adapter with the given adapterId and config. Then
- * it replaces the draft with the given id with the draft generated
- * by the mutating adapter.  Will call onResult callback once with data or error.
+ * @deprecated There is no situation in which any consumer actually wants to replace the draft.
+ * call {@link invokeAdapterWithDraftToMerge} instead`.
+ * Keep it for now for app back compatibility.
+ * Will be removed in future, ideally 2 releases later.
+ */
+export declare function invokeAdapterWithDraftToReplace(adapterId: string, config: string, draftIdToReplace: string, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
+/**
+ * Executes the specified adapter with the given @param dapterId and @param config. Then
+ * it merge 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 throws an error if the given adapterId cannot be found, or if the
- * adapterId is not a mutating adapter, or if a draft isn't created, or if it
- * fails to parse the given config string.
+ * 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
  */
-export declare function invokeAdapterWithDraftToReplace(adapterId: string, config: string, draftIdToReplace: string, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
+export declare function invokeAdapterWithDraftToMerge(adapterId: string, config: string, targetDraftId: string, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
 /**
  * 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

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

@@ -1,4 +1,4 @@
-import { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter } from './executeAdapter';
+import { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithDraftToMerge, executeAdapter, executeMutatingAdapter } from './executeAdapter';
 import { getImperativeAdapterNames } from './lightningAdapterApi';
 import { nimbusDraftQueue } from './nimbusDraftQueue';
 import { draftQueue, draftManager } from './draftQueueImplementation';
@@ -6,4 +6,4 @@ import { setUiApiRecordTTL, setMetadataTTL } from './ttl';
 import { registerReportObserver } from '@salesforce/lds-runtime-mobile';
 import { createPrimingSession } from './primingApi';
 import { evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction } from './cachePurging';
-export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction, };
+export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithDraftToMerge, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction, };