@spiffcommerce/core 0.2.8 → 0.3.0

package/dist/types.d.ts

@@ -21,6 +21,45 @@ interface WorkflowScenesConfiguration {
     finishScene: boolean;
     finishSceneTitle: string;
 }
+/**
+ * A queue promise is a container for a promise that can be
+ * executed at a later time.
+ */
+export abstract class QueueablePromise {
+    readonly timestamp: number;
+    abstract execute(): Promise<any>;
+}
+/**
+ * A promise queue contains any number of QueuePromise objects. These objects are stored within a PromiseQueue and executed
+ * as quickly as possible in order. This is ideal in situations where a specific operation should be
+ * applied in an ordered way while still making.
+ */
+export class PromiseQueue<T extends QueueablePromise> {
+    /**
+     * Constructs a new promise queue.
+     * @param queueMaxSize An optional maximum size, when the max size is hit.
+     *                     The older promises will be discarded.
+     */
+    constructor(queueMaxSize?: number);
+    /**
+     * Enqueue a new promise.
+     * @param promise A new promise to add to the queue.
+     */
+    enqueue(promise: T): Promise<void>;
+    /**
+     * @returns Returns true when work is being actively processed by this queue.
+     */
+    hasActivePromise(): boolean;
+    /**
+     * @returns The number of unexecuted jobs remaining in the queue. Not including the active job.
+     */
+    getRemainingQueueSize(): number;
+    /**
+     * Finalize the queue, any jobs that come in while this is in progress will result
+     * in the promise being extended.
+     */
+    finalize(): Promise<void>;
+}
 export class FrameService {
     minZoomScale: number;
     maxZoomScale: number;
@@ -255,20 +294,20 @@ declare class TextStepService implements StepService<_TextStepData1> {
     textAlign: (stepData: _TextStepData1) => string;
 }
 export const textStepService: TextStepService;
-interface EditedSteps {
+export interface EditedSteps {
     [stepName: string]: boolean;
 }
 export interface MandatorySteps {
     [stepName: string]: boolean;
 }
-type StepElements = {
+export type StepElements = {
     [key: string]: RegionElement[];
 };
 type StepInitialised = {
     [key: string]: boolean;
 };
 type StepMetadata = FrameMetadata | IllustrationMetadata | ModuleMetadata | TextMetadata;
-interface WorkflowStorage {
+export interface WorkflowStorage {
     [stepName: string]: StepStorage;
 }
 export interface WorkflowMetadata {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.2.8",
+    "version": "0.3.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",