@salesforce/lds-worker-api 1.247.0 → 1.249.0

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

@@ -1,11 +1,20 @@
 declare enum EvictStatus {
-    InProgress = "InProgress",
+    Started = "Started",
+    Running = "Running",
+    Evicted = "Evicted",
     Succeeded = "Succeeded",
     Error = "Error",
-    Cancelled = "Cancelled"
+    Canceled = "Canceled"
 }
-interface EvictInProgress {
-    status: EvictStatus.InProgress;
+interface EvictStarted {
+    status: EvictStatus.Started;
+}
+interface EvictRunning {
+    status: EvictStatus.Running;
+    message: string;
+}
+interface BatchEvicted {
+    status: EvictStatus.Evicted;
     skippedEntries?: string[];
     evictedEntries?: string[];
 }
@@ -17,35 +26,33 @@ interface EvictError {
     message: string;
 }
 interface EvictCancelled {
-    status: EvictStatus.Cancelled;
+    status: EvictStatus.Canceled;
 }
-export type EvictProgress = EvictInProgress | EvictSucceeded | EvictError | EvictCancelled;
+export type EvictProgress = BatchEvicted | 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 evictId, call cancelEviction with it to abort the eviction.
+ * @returns started or already running based whether there's an active eviction going on or not.
  *
  * The record will not be purged if the record has draft.
  */
-export declare function evictCacheRecordsByIds(recordIds: string[], onProgressUpdate: ProgressUpdateCallback): string;
+export declare function evictCacheRecordsByIds(recordIds: string[], onProgressUpdate: ProgressUpdateCallback): EvictStarted | EvictRunning;
 /**
  * Purging the db entries which passed expired time by specified days
  * from durable store.
  * @param expiredByDays
  * @param onProgressUpdate
  *
- * @returns an evictId, call cancelEviction with it to abort the eviction.
+ * @returns started or already running based whether there's an active eviction going on or not.
  *
  * Important: records with draft, objectInfo entries will not be purged even expired by the specified days.
  */
-export declare function evictExpiredCacheEntries(expiredByDays: number, onProgressUpdate: ProgressUpdateCallback): string;
+export declare function evictExpiredCacheEntries(expiredByDays: number, onProgressUpdate: ProgressUpdateCallback): EvictStarted | EvictRunning;
 /**
- * Cancel the eviction by specified id.
- * Signal to cancel the eviction if the eviction is going on.
- * @param evictionId
+ * Signal to stop current eviction if there's an active eviction going on.
  */
-export declare function cancelEviction(evictionId: string): void;
+export declare function stopEviction(): void;
 export {};

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

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