@salesforce/lds-worker-api 1.247.0 → 1.249.0

package/dist/sfdc/es/ldsWorkerApi.js

@@ -778,174 +778,49 @@ function removeEventHandler(session, handler) {
     }
 }
 
-/**
- * Copyright (c) 2022, Salesforce, Inc.,
- * All rights reserved.
- * For full license text, see the LICENSE.txt file
- */
-
-
-var DraftActionStatus;
-(function (DraftActionStatus) {
-    DraftActionStatus["Pending"] = "pending";
-    DraftActionStatus["Uploading"] = "uploading";
-    DraftActionStatus["Error"] = "error";
-    DraftActionStatus["Completed"] = "completed";
-})(DraftActionStatus || (DraftActionStatus = {}));
-var ProcessActionResult;
-(function (ProcessActionResult) {
-    // non-2xx network error, requires user intervention
-    ProcessActionResult["ACTION_ERRORED"] = "ERROR";
-    // upload succeeded
-    ProcessActionResult["ACTION_SUCCEEDED"] = "SUCCESS";
-    // queue is empty
-    ProcessActionResult["NO_ACTION_TO_PROCESS"] = "NO_ACTION_TO_PROCESS";
-    // network request is in flight
-    ProcessActionResult["ACTION_ALREADY_PROCESSING"] = "ACTION_ALREADY_PROCESSING";
-    // network call failed (offline)
-    ProcessActionResult["NETWORK_ERROR"] = "NETWORK_ERROR";
-    // queue is blocked on an error that requires user intervention
-    ProcessActionResult["BLOCKED_ON_ERROR"] = "BLOCKED_ON_ERROR";
-    //waiting for user to execute custom action
-    ProcessActionResult["CUSTOM_ACTION_WAITING"] = "CUSTOM_ACTION_WAITING";
-})(ProcessActionResult || (ProcessActionResult = {}));
-var DraftQueueState;
-(function (DraftQueueState) {
-    /** Currently processing an item in the queue or queue is empty and waiting to process the next item. */
-    DraftQueueState["Started"] = "started";
-    /**
-     * The queue is stopped and will not attempt to upload any drafts until startDraftQueue() is called.
-     * This is the initial state when the DraftQueue gets instantiated.
-     */
-    DraftQueueState["Stopped"] = "stopped";
-    /**
-     * The queue is stopped due to a blocking error from the last upload attempt.
-     * The queue will not run again until startDraftQueue() is called.
-     */
-    DraftQueueState["Error"] = "error";
-    /**
-     * There was a network error and the queue will attempt to upload again shortly.
-     * To attempt to force an upload now call startDraftQueue().
-     */
-    DraftQueueState["Waiting"] = "waiting";
-})(DraftQueueState || (DraftQueueState = {}));
-var DraftQueueEventType;
-(function (DraftQueueEventType) {
-    /**
-     * Triggered after an action had been added to the queue
-     */
-    DraftQueueEventType["ActionAdded"] = "added";
-    /**
-     * Triggered when starting to upload and process an action
-     */
-    DraftQueueEventType["ActionUploading"] = "uploading";
-    /**
-     * Triggered once an action failed
-     */
-    DraftQueueEventType["ActionFailed"] = "failed";
-    /**
-     * Triggered after an action has been deleted from the queue
-     */
-    DraftQueueEventType["ActionDeleted"] = "deleted";
-    /**
-     * Triggered after an action has been completed and after it has been removed from the queue
-     */
-    DraftQueueEventType["ActionCompleted"] = "completed";
-    /**
-     * Triggered after an action has been updated by the updateAction API
-     */
-    DraftQueueEventType["ActionUpdated"] = "updated";
-    /**
-     * Triggered after the Draft Queue state changes
-     */
-    DraftQueueEventType["QueueStateChanged"] = "state";
-})(DraftQueueEventType || (DraftQueueEventType = {}));
-var QueueOperationType;
-(function (QueueOperationType) {
-    QueueOperationType["Add"] = "add";
-    QueueOperationType["Delete"] = "delete";
-    QueueOperationType["Update"] = "update";
-})(QueueOperationType || (QueueOperationType = {}));
-/**
-Use Math.random to generate v4 RFC4122 compliant uuid
- */
-function uuidv4() {
-    const uuid = [];
-    for (let i = 0; i < 32; i++) {
-        const random = (Math.random() * 16) | 0;
-        if (i === 8 || i === 12 || i === 16 || i === 20) {
-            uuid.push('-');
-        }
-        uuid.push((i === 12 ? 4 : i === 16 ? (random & 3) | 8 : random).toString(16));
-    }
-    return uuid.join('');
-}
-
-var CustomActionResultType;
-(function (CustomActionResultType) {
-    CustomActionResultType["SUCCESS"] = "SUCCESS";
-    CustomActionResultType["FAILURE"] = "FAILURE";
-})(CustomActionResultType || (CustomActionResultType = {}));
-var CustomActionErrorType;
-(function (CustomActionErrorType) {
-    CustomActionErrorType["NETWORK_ERROR"] = "NETWORK_ERROR";
-    CustomActionErrorType["CLIENT_ERROR"] = "CLIENT_ERROR";
-})(CustomActionErrorType || (CustomActionErrorType = {}));
-
-/**
- * Denotes what kind of operation a DraftQueueItem represents.
- */
-var DraftActionOperationType;
-(function (DraftActionOperationType) {
-    DraftActionOperationType["Create"] = "create";
-    DraftActionOperationType["Update"] = "update";
-    DraftActionOperationType["Delete"] = "delete";
-    DraftActionOperationType["Custom"] = "custom";
-})(DraftActionOperationType || (DraftActionOperationType = {}));
-var DraftQueueOperationType;
-(function (DraftQueueOperationType) {
-    DraftQueueOperationType["ItemAdded"] = "added";
-    DraftQueueOperationType["ItemUploading"] = "uploading";
-    DraftQueueOperationType["ItemDeleted"] = "deleted";
-    DraftQueueOperationType["ItemCompleted"] = "completed";
-    DraftQueueOperationType["ItemFailed"] = "failed";
-    DraftQueueOperationType["ItemUpdated"] = "updated";
-    DraftQueueOperationType["QueueStarted"] = "started";
-    DraftQueueOperationType["QueueStopped"] = "stopped";
-})(DraftQueueOperationType || (DraftQueueOperationType = {}));
-
 var EvictStatus;
 (function (EvictStatus) {
-    EvictStatus["InProgress"] = "InProgress";
+    EvictStatus["Started"] = "Started";
+    EvictStatus["Running"] = "Running";
+    EvictStatus["Evicted"] = "Evicted";
     EvictStatus["Succeeded"] = "Succeeded";
     EvictStatus["Error"] = "Error";
-    EvictStatus["Cancelled"] = "Cancelled";
+    EvictStatus["Canceled"] = "Canceled";
 })(EvictStatus || (EvictStatus = {}));
 const MessagingDurableSegmentName = 'MESSAGING';
 const DEFAULT_MAX_ENTRIES_PER_OPERATION = 500;
+const EVICTION_IN_PROGESS_MESSAGE = `Cache eviction in progress. Can't start another until it is finished or canceled.`;
 /**
- * Keep tracking of ongoing eviction id to a flag to trigger eviction cancellation.
- * false in the begining, set to true when cancelEviction is called.
+ * Only one eviction is allowed at a time. running status is return when evictCacheRecordsByIds or
+ * evictExpiredCacheEntries is called if there's already an eviction in progress.
  */
-const evictionCancellationFlag = new Map();
+var activeEvictionInProgress = false;
+var cancelCurrentEviction = false;
 /**
  * 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.
  */
 function evictCacheRecordsByIds(recordIds, onProgressUpdate) {
-    const evictionId = uuidv4();
-    evictionCancellationFlag.set(evictionId, false);
+    // Send error back if an eviction is going on.
+    if (activeEvictionInProgress) {
+        return {
+            status: EvictStatus.Running,
+            message: EVICTION_IN_PROGESS_MESSAGE,
+        };
+    }
+    activeEvictionInProgress = true;
+    cancelCurrentEviction = false;
     const evictAChunk = () => {
         evictChunksOfRecord(recordIds).then(onEvicted);
     };
-    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictionId, evictAChunk);
+    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictAChunk);
     evictAChunk();
-    return evictionId;
+    return { status: EvictStatus.Started };
 }
 /**
  * Purging the db entries which passed expired time by specified days
@@ -953,49 +828,53 @@ function evictCacheRecordsByIds(recordIds, onProgressUpdate) {
  * @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.
  */
 function evictExpiredCacheEntries(expiredByDays, onProgressUpdate) {
-    const evictionId = uuidv4();
-    evictionCancellationFlag.set(evictionId, false);
+    // Send error back if an eviction is going on.
+    if (activeEvictionInProgress) {
+        return {
+            status: EvictStatus.Running,
+            message: EVICTION_IN_PROGESS_MESSAGE,
+        };
+    }
+    activeEvictionInProgress = true;
+    cancelCurrentEviction = false;
     const overdueExpirationTimeStamp = Date.now() - expiredByDays * 24 * 3600 * 1000;
     const evictAChunk = () => {
         evictChunkOfOverdueEntries(overdueExpirationTimeStamp).then(onEvicted);
     };
-    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictionId, evictAChunk);
+    const onEvicted = getOnEvictedCallback(onProgressUpdate, evictAChunk);
     evictAChunk();
-    return evictionId;
+    return { status: EvictStatus.Started };
 }
 /**
- * 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.
  */
-function cancelEviction(evictionId) {
-    if (evictionCancellationFlag.has(evictionId)) {
-        evictionCancellationFlag.set(evictionId, true);
+function stopEviction() {
+    if (activeEvictionInProgress) {
+        cancelCurrentEviction = true;
     }
 }
 /**
  * Get a callback function when a chunk of records or entries are removed.
  * @param onProgressUpdate
- * @param evictionId
  * @param evictAChunk
  * @returns a callback to call when a chunk of records or entries are removed.
  */
-function getOnEvictedCallback(onProgressUpdate, evictionId, evictAChunk) {
+function getOnEvictedCallback(onProgressUpdate, evictAChunk) {
     return (progress) => {
         onProgressUpdate(progress);
         const { status } = progress;
         if (status === EvictStatus.Succeeded || status === EvictStatus.Error) {
-            evictionCancellationFlag.delete(evictionId);
+            activeEvictionInProgress = false;
         }
-        if (status === EvictStatus.InProgress) {
-            if (evictionCancellationFlag.get(evictionId)) {
-                evictionCancellationFlag.delete(evictionId);
-                onProgressUpdate({ status: EvictStatus.Cancelled });
+        if (status === EvictStatus.Evicted) {
+            if (cancelCurrentEviction) {
+                activeEvictionInProgress = false;
+                onProgressUpdate({ status: EvictStatus.Canceled });
             }
             else {
                 evictAChunk();
@@ -1032,7 +911,7 @@ function evictChunksOfRecord(ids) {
                     nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
                 }
                 resolve({
-                    status: EvictStatus.InProgress,
+                    status: EvictStatus.Evicted,
                     evictedEntries,
                     skippedEntries,
                 });
@@ -1070,7 +949,8 @@ function evictChunkOfOverdueEntries(overdueExpirationTimestamp) {
                         WHERE key NOT LIKE 'UiApi::ObjectInfoRepresentation:%' 
                             AND 
                             (
-                                key NOT LIKE 'UiApi::RecordRepresentation:%' 
+                                key NOT LIKE 'UiApi::RecordRepresentation:%' AND 
+                                JSON_EXTRACT(metadata, '$.expirationTimestamp') < ${overdueExpirationTimestamp}
                                 OR  
                                 key LIKE 'UiApi::RecordRepresentation:%' AND 
                                 JSON_EXTRACT(data, '$.drafts') IS NULL AND
@@ -1085,7 +965,7 @@ function evictChunkOfOverdueEntries(overdueExpirationTimestamp) {
                     // broadcast entries evicted
                     nimbusSqliteStore.setEntries({ notifyStoreUpdateAvailable: { data: evictedEntries } }, MessagingDurableSegmentName);
                     resolve({
-                        status: EvictStatus.InProgress,
+                        status: EvictStatus.Evicted,
                         evictedEntries,
                         skippedEntries: [],
                     });
@@ -1119,5 +999,5 @@ if (process.env.NODE_ENV !== 'production') {
     });
 }
 
-export { cancelEviction, createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, subscribeToAdapter };
-// version: 1.247.0-4fe38c091
+export { createPrimingSession, draftManager, draftQueue, evictCacheRecordsByIds, evictExpiredCacheEntries, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, stopEviction, subscribeToAdapter };
+// version: 1.249.0-11c3e1ed5

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