@salesforce/lds-worker-api 1.283.0 → 1.285.0

package/dist/standalone/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/standalone/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, };