@spiffcommerce/core 21.2.1 → 21.2.2-0

package/dist/index.d.ts

@@ -836,6 +836,28 @@ interface Product {
      * The Spiff SKU code for the product.
      */
     skuCode?: string;
+    /**
+     * Price breaks for this product when dealing with quantity.
+     */
+    priceBreaks?: ProductPriceBreak[];
+}
+/**
+ * A price break represents a minimum quantity of a product and the price that will be charged for that quantity.
+ * This can be seen as an override for the base price of the product.
+ */
+interface ProductPriceBreak {
+    /**
+     * The id of this price breal.
+     */
+    id: string;
+    /**
+     * The minimum quantity of this price break. A positive integer.
+     */
+    minQty: number;
+    /**
+     * A percentage to apply to the overall price. A value between 0-1 where 1 retains 100% of the original price and 0 completely discounts it to free.
+     */
+    percentage: number;
 }
 interface ProductTag {
     id: string;
@@ -1422,6 +1444,14 @@ interface ExperienceOptions {
  * should get an instance of this class from a Client you have constructed previously.
  */
 interface WorkflowExperience {
+    /**
+     * Get the bundle this experience is part of. May be undefined.
+     */
+    getBundle(): Bundle | undefined;
+    /**
+     * Set the bundle this experience is part of. Can be cleared using undefined.
+     */
+    setBundle(bundle: Bundle | undefined): any;
     /**
      * Returns the client that was responsible for spawning this experience.
      */
@@ -1582,10 +1612,16 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
     readonly workflowManager: WorkflowManager;
     readonly isReadOnly: boolean;
     readonly cachedStepHandles: Map<string, StepHandle<any>>;
+    /**
+     * Bundle this experience has been added to.
+     */
+    private bundle?;
     private renderableScenes;
     private renderableSceneCallbacks;
     private eventCallbacks;
     constructor(client: SpiffCommerceClient, experienceOptions: ExperienceOptions);
+    getBundle(): Bundle | undefined;
+    setBundle(bundle: Bundle): void;
     getClient(): SpiffCommerceClient;
     getIsReadOnly(): boolean;
     getCommandContext(): CommandContext;
@@ -1598,6 +1634,7 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
     getBasePriceSubunits(includeAdditionalProduct?: boolean): number;
     getAdditionalProductPriceSubunits(): number | undefined;
     getTotalPriceSubunits(): number;
+    private getPriceSubUnitsAfterPriceBreaks;
     copySelectionsViaGlobalConfiguration(bundle: Bundle, experience: WorkflowExperience, filter?: StepHandle<AnyStepData>[]): Promise<void>;
     getStepByName(name: string): TextStepHandle | FrameStepHandle | ShapeStepHandle | InformationStepHandle | IllustrationStepHandle | MaterialStepHandle | ModelStepHandle | PictureStepHandle | QuestionStepHandle | undefined;
     getStepsByType(type: StepType): StepHandle<AnyStepData>[];