@salesforce/lds-worker-api 1.243.0 → 1.245.0

package/dist/standalone/umd/types/cachePurging.d.ts

@@ -0,0 +1,39 @@
+declare enum EvictStatus {
+    InProgress = "InProgress",
+    Succeeded = "Succeeded",
+    Error = "Error",
+    Cancelled = "Cancelled"
+}
+interface EvictInProgress {
+    status: EvictStatus.InProgress;
+    skippedEntries?: string[];
+    evictedEntries?: string[];
+}
+interface EvictSucceeded {
+    status: EvictStatus.Succeeded;
+}
+interface EvictError {
+    status: EvictStatus.Error;
+    message: string;
+}
+interface EvictCancelled {
+    status: EvictStatus.Cancelled;
+}
+export type EvictProgress = EvictInProgress | EvictSucceeded | EvictError | EvictCancelled;
+export type ProgressUpdateCallback = (progess: EvictProgress) => void;
+/**
+ * Purging records specified by an array of record id from durable store
+ * @param recordIds record id array
+ * @onProgressUpdate call back to report evict progress
+ *
+ * @returns a function to cancel the eviction
+ *
+ * The record will not be purged if the record has draft.
+ */
+export declare function evictCacheRecordsByIds(recordIds: string[], onProgressUpdate: ProgressUpdateCallback): string;
+/**
+ * Cancel the eviction by specified id.
+ * @param evictionId
+ */
+export declare function cancelEviction(evictionId: string): void;
+export {};

package/dist/standalone/umd/types/main.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-worker-api",
-    "version": "1.243.0",
+    "version": "1.245.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "",
     "main": "dist/standalone/es/lds-worker-api.js",
@@ -54,9 +54,9 @@
         {
             "path": "./dist/sfdc/es/ldsWorkerApi.js",
             "maxSize": {
-                "none": "33 kB",
-                "min": "13 kB",
-                "compressed": "6 kB"
+                "none": "41.5 kB",
+                "min": "17 kB",
+                "compressed": "8 kB"
             }
         }
     ],