@salesforce/lds-drafts 1.314.0 → 1.316.0

package/dist/ldsDrafts.js

@@ -385,6 +385,11 @@ class DurableDraftQueue {
         this.userState = DraftQueueState.Stopped;
         this.uploadingActionId = undefined;
         this.timeoutHandler = undefined;
+        this.logger = typeof __nimbus !== 'undefined' &&
+            __nimbus.plugins !== undefined &&
+            __nimbus.plugins.JSLoggerPlugin !== undefined
+            ? __nimbus.plugins.JSLoggerPlugin
+            : undefined;
         this.handlers = {};
         this.draftStore = draftStore;
         this.workerPool = new AsyncWorkerPool(1);
@@ -425,12 +430,13 @@ class DurableDraftQueue {
         await this.notifyChangedListeners({
             type: DraftQueueEventType.QueueStateChanged,
             state: this.state,
+            draftCount: this.draftStore.getCount(),
         });
         const result = await this.processNextAction();
         switch (result) {
             case ProcessActionResult.BLOCKED_ON_ERROR:
                 this.state = DraftQueueState.Error;
-                return Promise.reject();
+                return Promise.reject('Unable to start queue - first action is in error state');
             default:
                 return Promise.resolve();
         }
@@ -441,16 +447,22 @@ class DurableDraftQueue {
             // Do nothing if the queue state is already stopped
             return Promise.resolve();
         }
-        this.stopQueueManually();
+        this.stopQueueManually(false);
         return this.notifyChangedListeners({
             type: DraftQueueEventType.QueueStateChanged,
             state: DraftQueueState.Stopped,
+            draftCount: this.draftStore.getCount(),
         });
     }
     /**
      * Used to stop the queue within DraftQueue without user interaction
      */
-    stopQueueManually() {
+    stopQueueManually(internalReason) {
+        if (this.logger) {
+            this.logger.logInfo(internalReason
+                ? 'Draft queue stopped for internal reason'
+                : 'Draft queue stopped by app');
+        }
         if (this.timeoutHandler) {
             clearTimeout(this.timeoutHandler);
             this.timeoutHandler = undefined;
@@ -493,6 +505,7 @@ class DurableDraftQueue {
                 await this.notifyChangedListeners({
                     type: DraftQueueEventType.ActionAdded,
                     action: pendingAction,
+                    draftCount: this.draftStore.getCount(),
                 });
                 await handler.handleActionEnqueued(pendingAction, queue);
                 if (this.state === DraftQueueState.Started) {
@@ -525,6 +538,7 @@ class DurableDraftQueue {
                 await this.notifyChangedListeners({
                     type: DraftQueueEventType.ActionCompleted,
                     action,
+                    draftCount: this.draftStore.getCount(),
                 });
                 if (this.state === DraftQueueState.Started) {
                     this.processNextAction();
@@ -574,6 +588,7 @@ class DurableDraftQueue {
             await this.notifyChangedListeners({
                 type: DraftQueueEventType.ActionFailed,
                 action: action,
+                draftCount: this.draftStore.getCount(),
             });
             return ProcessActionResult.BLOCKED_ON_ERROR;
         }
@@ -590,6 +605,7 @@ class DurableDraftQueue {
         await this.notifyChangedListeners({
             type: DraftQueueEventType.ActionUploading,
             action: { ...action, status: DraftActionStatus.Uploading },
+            draftCount: this.draftStore.getCount(),
         });
         return this.handle(action);
     }
@@ -611,6 +627,7 @@ class DurableDraftQueue {
         return this.notifyChangedListeners({
             type: DraftQueueEventType.ActionFailed,
             action: errorAction,
+            draftCount: this.draftStore.getCount(),
         });
     }
     async notifyChangedListeners(event) {
@@ -657,6 +674,7 @@ class DurableDraftQueue {
         await this.notifyChangedListeners({
             type: DraftQueueEventType.ActionDeleted,
             action,
+            draftCount: this.draftStore.getCount(),
         });
         if (this.userState === DraftQueueState.Started &&
             this.state !== DraftQueueState.Started &&
@@ -666,7 +684,7 @@ class DurableDraftQueue {
     }
     async updateDraftAction(action) {
         // stop queue manually
-        this.stopQueueManually();
+        this.stopQueueManually(true);
         const actionStatus = await this.statusOfAction(action.id);
         if (actionStatus === DraftActionStatus.Uploading) {
             return Promise.reject('cannot update an uploading action');
@@ -696,7 +714,7 @@ class DurableDraftQueue {
         return this.replaceOrMergeActions(targetActionId, sourceActionId, true);
     }
     async retryAction(actionId) {
-        this.stopQueueManually();
+        this.stopQueueManually(true);
         const actions = await this.getQueueActions();
         const target = actions[0];
         if (!target || target.id !== actionId) {
@@ -714,6 +732,7 @@ class DurableDraftQueue {
         await this.notifyChangedListeners({
             type: DraftQueueEventType.ActionUpdated,
             action: pendingAction,
+            draftCount: this.draftStore.getCount(),
         });
         await this.startQueueSafe();
         return pendingAction;
@@ -739,6 +758,7 @@ class DurableDraftQueue {
         await this.notifyChangedListeners({
             type: DraftQueueEventType.ActionUpdated,
             action: action,
+            draftCount: this.draftStore.getCount(),
         });
         return action;
     }
@@ -746,6 +766,7 @@ class DurableDraftQueue {
         await this.notifyChangedListeners({
             type: DraftQueueEventType.QueueStateChanged,
             state: DraftQueueState.Waiting,
+            draftCount: this.draftStore.getCount(),
         });
         this.timeoutHandler = setTimeout(() => {
             if (this.state !== DraftQueueState.Stopped) {
@@ -804,7 +825,7 @@ class DurableDraftQueue {
         if (this.replacingAction !== undefined) {
             throw Error('Cannot replace/merge actions while a replace/merge action operation is in progress.');
         }
-        this.stopQueueManually();
+        this.stopQueueManually(true);
         const promise = this.getActionsForReplaceOrMerge(targetActionId, sourceActionId).then(async ({ target, source }) => {
             // put in a try/finally block so we don't leave this.replacingAction
             // indefinitely set
@@ -820,6 +841,7 @@ class DurableDraftQueue {
                 await this.notifyChangedListeners({
                     type: DraftQueueEventType.ActionUpdated,
                     action: updatedTarget,
+                    draftCount: this.draftStore.getCount(),
                 });
                 // remove the source from queue
                 await this.removeDraftAction(sourceActionId);
@@ -958,6 +980,9 @@ class DurableDraftStore {
         };
         return this.enqueueAction(action);
     }
+    getCount() {
+        return keys(this.draftStore).length;
+    }
     /**
      * Runs a write operation against the draft store, if the initial
      * revive is still in progress, the action gets enqueued to run once the
@@ -1761,16 +1786,17 @@ class DraftManager {
             return Promise.reject('cannot edit incompatible action type or uploading actions');
         }
         action.data.body.fields = { ...action.data.body.fields, ...fields };
+        action.status = DraftActionStatus.Pending;
         await this.draftQueue.updateDraftAction(action);
         return this.buildDraftQueueItem(action);
     }
     isValidFieldMap(fields) {
         const keys$1 = keys(fields);
-        const validTypes = ['string', 'number', 'null', 'boolean'];
+        const validTypes = ['string', 'number', 'boolean'];
         for (let i = 0; i < keys$1.length; i++) {
             const key = keys$1[i];
             const value = fields[key];
-            if (!validTypes.includes(typeof value)) {
+            if (!validTypes.includes(typeof value) && value !== null) {
                 return false;
             }
         }
@@ -1798,6 +1824,7 @@ class DraftManager {
         }
         const data = action.data;
         data.body.fields = { ...data.body.fields, ...fields };
+        action.status = DraftActionStatus.Pending;
         await this.draftQueue.updateDraftAction(action);
         return this.buildDraftQueueItem(action);
     }

package/dist/types/DraftQueue.d.ts

@@ -103,31 +103,36 @@ export declare enum DraftQueueEventType {
      */
     QueueStateChanged = "state"
 }
-export interface DraftQueueAddEvent {
+export interface DraftQueueStats {
+    draftCount: number;
+}
+export interface DraftQueueAddEvent extends DraftQueueStats {
     type: DraftQueueEventType.ActionAdded;
     action: PendingDraftAction<unknown>;
 }
-export interface DraftQueueUploadingEvent {
+export interface DraftQueueUploadingEvent extends DraftQueueStats {
     type: DraftQueueEventType.ActionUploading;
     action: UploadingDraftAction<unknown>;
+    draftCount: number;
 }
-export interface DraftQueueDeleteEvent {
+export interface DraftQueueDeleteEvent extends DraftQueueStats {
     type: DraftQueueEventType.ActionDeleted;
     action: DraftAction<unknown, unknown>;
+    draftCount: number;
 }
-export interface DraftQueueCompleteEvent {
+export interface DraftQueueCompleteEvent extends DraftQueueStats {
     type: DraftQueueEventType.ActionCompleted;
     action: CompletedDraftAction<unknown, unknown>;
 }
-export interface DraftQueueActionFailedEvent {
+export interface DraftQueueActionFailedEvent extends DraftQueueStats {
     type: DraftQueueEventType.ActionFailed;
     action: ErrorDraftAction<unknown>;
 }
-export interface DraftQueueActionUpdatedEvent {
+export interface DraftQueueActionUpdatedEvent extends DraftQueueStats {
     type: DraftQueueEventType.ActionUpdated;
     action: DraftAction<unknown, unknown>;
 }
-export interface DraftQueueStateChangedEvent {
+export interface DraftQueueStateChangedEvent extends DraftQueueStats {
     type: DraftQueueEventType.QueueStateChanged;
     state: DraftQueueState;
 }

package/dist/types/DraftStore.d.ts

@@ -8,4 +8,5 @@ export interface DraftStore {
     deleteDraft(actionId: string): Promise<void>;
     deleteByTag(tag: string): Promise<void>;
     completeAction(queueOperations: QueueOperation[]): Promise<void>;
+    getCount(): number;
 }

package/dist/types/DurableDraftQueue.d.ts

@@ -16,6 +16,7 @@ export declare class DurableDraftQueue implements DraftQueue {
     private replacingAction?;
     private uploadingActionId?;
     private timeoutHandler;
+    private logger;
     private workerPool;
     private handlers;
     private getHandler;

package/dist/types/DurableDraftStore.d.ts

@@ -21,6 +21,7 @@ export declare class DurableDraftStore implements DraftStore {
     deleteDraft(id: string): Promise<void>;
     deleteByTag(tag: string): Promise<void>;
     completeAction(queueOperations: QueueOperation[]): Promise<void>;
+    getCount(): number;
     /**
      * Runs a write operation against the draft store, if the initial
      * revive is still in progress, the action gets enqueued to run once the

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-drafts",
-    "version": "1.314.0",
+    "version": "1.316.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS Drafts",
     "main": "dist/ldsDrafts.js",
@@ -26,7 +26,10 @@
     "dependencies": {
         "@luvio/engine": "0.156.4",
         "@luvio/environments": "0.156.4",
-        "@salesforce/lds-utils-adapters": "^1.314.0"
+        "@salesforce/lds-utils-adapters": "^1.316.0"
+    },
+    "devDependencies": {
+        "@salesforce/nimbus-plugin-lds": "^1.316.0"
     },
     "volta": {
         "extends": "../../package.json"