@spiffcommerce/core 18.4.1 → 18.4.3-alpha.0

package/dist/index.d.ts

@@ -89,17 +89,25 @@ declare class PromiseQueue<T extends QueueablePromise> {
     private queue;
     private activePromise?;
     private queueMaxSize;
+    private isEnabled;
     /**
      * Constructs a new promise queue.
      * @param queueMaxSize An optional maximum size, when the max size is hit.
      *                     The older promises will be discarded.
+     * @param enabled When false, the queue will not process any jobs. Assign `enabled` to true to start processing.
      */
-    constructor(queueMaxSize?: number);
+    constructor(queueMaxSize?: number, enabled?: boolean);
     /**
      * Enqueue a new promise.
      * @param promise A new promise to add to the queue.
      */
     enqueue(promise: T): void;
+    get enabled(): boolean;
+    /**
+     * Enable or disable the queue. When disabled, the queue will not process any jobs.
+     * Disabling processing will not cancel any active promises.
+     */
+    set enabled(value: boolean);
     /**
      * @returns Returns true when work is being actively processed by this queue.
      */
@@ -468,6 +476,11 @@ interface WorkflowManager {
      * Ejects the model of this product from the preview service. This also sets the internal preview service to undefined.
      */
     ejectFromPreviewService(): void;
+    /**
+     * Enables or disables uploading of workflow state to the server.
+     * @param enabled When true, workflow state will be uploaded to the server.
+     */
+    setWorkflowStateSyncEnabled: (enabled: boolean) => void;
 }
 
 interface StepService<T extends AnyStepData> {
@@ -1379,6 +1392,10 @@ interface ExperienceOptions {
      * by default.
      */
     singleVariantsRenderable?: boolean;
+    /**
+     * When true, will delay syncing the workflow state until manually enabled.
+     */
+    delayWorkflowStateSync?: boolean;
 }
 /**
  * A Workflow experience encapsulates the workflow manager and command context. It
@@ -2609,6 +2626,7 @@ declare class MockWorkflowManager implements WorkflowManager {
     updateStorage(_stepName: string, _update: StepStorage): Promise<void>;
     injectIntoPreviewService(_previewService: any): Promise<void>;
     ejectFromPreviewService(): void;
+    setWorkflowStateSyncEnabled(_enabled: boolean): void;
 }
 
 declare const generateCommands: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<CanvasCommand[]>;