@spiffcommerce/core 20.3.0 → 20.4.0

package/dist/index.d.ts

@@ -640,6 +640,10 @@ interface Transaction {
      * The users who have access to this transaction.
      */
     stakeholders?: Stakeholder[];
+    /**
+     * The amount of this transaction that was, or will be, ordered
+     */
+    quantity?: number;
 }
 /**
  * An integration product represents the connection of a product in SpiffCommerce with
@@ -1532,6 +1536,33 @@ interface WorkflowExperience {
     getExportedData(): Map<string, {
         [key: string]: string;
     }>;
+    /**
+     * Get the quantity of this WorkflowExperience's Transaction.
+     * @returns The amount that was, or will be, ordered.
+     */
+    getQuantity(): number;
+    /**
+     * Sets the quantity of this WorkflowExperience's Transaction.
+     * @throws {Error} if the WorkflowExperience is read-only.
+     * @throws {RangeError} if the value is below 1.
+     * @param quantity The amount that was, or will be, ordered.
+     */
+    setQuantity(quantity: number): void;
+    /**
+     * Registers a callback function to be called when the specified event is raised.
+     * @param type The type of event to listen for.
+     * @param callback The function to call when the event occurs.
+     */
+    addEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
+    /**
+     * Removes a previously registered callback.
+     * @param type The type of event.
+     * @param callback The function to remove.
+     */
+    removeEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
+}
+declare enum WorkflowExperienceEventType {
+    QuantityChanged = "QuantityChanged"
 }
 declare class WorkflowExperienceImpl implements WorkflowExperience {
     readonly client: SpiffCommerceClient;
@@ -1541,6 +1572,7 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
     readonly cachedStepHandles: Map<string, StepHandle<any>>;
     private renderableScenes;
     private renderableSceneCallbacks;
+    private eventCallbacks;
     constructor(client: SpiffCommerceClient, experienceOptions: ExperienceOptions);
     getClient(): SpiffCommerceClient;
     getIsReadOnly(): boolean;
@@ -1577,6 +1609,11 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
     getExportedData(): Map<string, {
         [key: string]: string;
     }>;
+    getQuantity(): number;
+    setQuantity(quantity: number): void;
+    addEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
+    removeEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
+    private callEvent;
 }
 
 /**