@spiffcommerce/core 21.5.0-alpha.0 → 21.6.0-alpha.0

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [21.5.0] - 22-03-2024
+
+### Changed
+
+- `StepHandle`: The override global property state setting now has a different value for each Global Property Aspect type. The get/set functions have been renamed and have an extra parameter to determine the Aspect Type.
+    - `getOverrideGlobalPreviewConfiguration` -> `getOverrideGlobalPropertyConfiguration(type: AspectType): boolean`. 
+    - `setOverrideGlobalPreviewConfiguration` -> `setOverrideGlobalPropertyConfiguration(type: AspectType, value: boolean): void`
+
 
 ## [21.4.1] - 21-03-2024
 

package/dist/index.d.ts

@@ -852,7 +852,7 @@ interface Product {
  */
 interface ProductPriceBreak {
     /**
-     * The id of this price breal.
+     * The id of this price break.
      */
     id: string;
     /**
@@ -947,7 +947,7 @@ declare enum ConversionLocation {
      */
     OnStart = "OnStart",
     /**
-     * The client should allow the user to input details just before quiting the experience.
+     * The client should allow the user to input details just before quitting the experience.
      */
     OnQuit = "OnQuit",
     /**
@@ -1306,14 +1306,14 @@ declare abstract class StepHandle<T extends AnyStepData> {
      * Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties,
      * and when this step is associated with one or more Global Property Aspects.
      */
-    getOverrideGlobalPreviewConfiguration(type: AspectType): boolean;
+    getOverrideGlobalPropertyConfiguration(type: AspectType): boolean;
     /**
      * Sets whether or not this step should override Global Properties.
      * Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties,
      * and when this step is associated with one or more Global Property Aspects.
      * @param type The AspectType to override.
      */
-    setOverrideGlobalPreviewConfiguration(type: AspectType, value: boolean): void;
+    setOverrideGlobalPropertyConfiguration(type: AspectType, value: boolean): void;
     /**
      * Retrieves the identifiers of all of the configured aspects for the specified Global Property Configuration.
      * @param configurationId The ID of the Global Property Configuration. You can usually find this with `bundle.getGlobalPropertyConfiguration()?.id`
@@ -1547,6 +1547,11 @@ interface WorkflowExperience {
      * The price break percentage that is expected to be applied in price calculations.
      */
     priceBreakToBeApplied(): number;
+    /**
+     * Calculates the price break and fires the "PriceBreakChanged" event if required.
+     * This function is primarily intended for internal use.
+     */
+    checkForPriceBreakChanges(): void;
     /**
      * Takes selections made by the user in another workflow and applies them to this workflow. For
      * selections to be copied they must both have a matching global property configuration.
@@ -1637,7 +1642,8 @@ interface WorkflowExperience {
     removeEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
 }
 declare enum WorkflowExperienceEventType {
-    QuantityChanged = "QuantityChanged"
+    QuantityChanged = "QuantityChanged",
+    PriceBreakChanged = "PriceBreakChanged"
 }
 declare class WorkflowExperienceImpl implements WorkflowExperience {
     readonly client: SpiffCommerceClient;
@@ -1649,6 +1655,7 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
      * Bundle this experience has been added to.
      */
     private bundle?;
+    private currentPriceBreak;
     private renderableScenes;
     private renderableSceneCallbacks;
     private eventCallbacks;
@@ -1669,6 +1676,9 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
     getTotalPriceSubunits(disablePriceBreaks?: boolean): number;
     private getPriceSubUnitsAfterPriceBreaks;
     priceBreakToBeApplied(): number;
+    checkForPriceBreakChanges(): void;
+    private getMatchingExperiences;
+    private updatePriceBreak;
     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>[];

package/dist/index.js

@@ -5723,7 +5723,7 @@ const sA = class qe {
    * Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties,
    * and when this step is associated with one or more Global Property Aspects.
    */
-  getOverrideGlobalPreviewConfiguration(e) {
+  getOverrideGlobalPropertyConfiguration(e) {
     var A;
     return (((A = this.manager.getStepStorage(this.step.stepName)) == null ? void 0 : A.overrideGlobalConfigurations) ?? {})[e.toString()] ?? !1;
   }
@@ -5733,7 +5733,7 @@ const sA = class qe {
    * and when this step is associated with one or more Global Property Aspects.
    * @param type The AspectType to override.
    */
-  setOverrideGlobalPreviewConfiguration(e, t) {
+  setOverrideGlobalPropertyConfiguration(e, t) {
     var n;
     const A = ((n = this.manager.getStepStorage(this.step.stepName)) == null ? void 0 : n.overrideGlobalConfigurations) ?? {};
     A[e.toString()] = t, this.manager.updateStorage(this.step.stepName, { overrideGlobalConfigurations: A });
@@ -6589,11 +6589,11 @@ const Te = new da(), wa = F`
         }
     }
 `;
-var Ea = /* @__PURE__ */ ((c) => (c.QuantityChanged = "QuantityChanged", c))(Ea || {});
+var Ea = /* @__PURE__ */ ((c) => (c.QuantityChanged = "QuantityChanged", c.PriceBreakChanged = "PriceBreakChanged", c))(Ea || {});
 class he {
   constructor(e, t) {
     var n;
-    if (this.cachedStepHandles = /* @__PURE__ */ new Map(), this.renderableScenes = [], this.renderableSceneCallbacks = [], this.eventCallbacks = /* @__PURE__ */ new Map(), this.debouncedSavedDesignUpdate = Jt(async () => {
+    if (this.cachedStepHandles = /* @__PURE__ */ new Map(), this.currentPriceBreak = 1, this.renderableScenes = [], this.renderableSceneCallbacks = [], this.eventCallbacks = /* @__PURE__ */ new Map(), this.debouncedSavedDesignUpdate = Jt(async () => {
       await Te.getSavedDesignByTransaction(
         this.getWorkflowManager().getTransaction().id
       ) && this.save();
@@ -6646,7 +6646,7 @@ class he {
         };
       });
       this.renderableScenes = i, this.renderableSceneCallbacks.forEach((s) => s(i));
-    });
+    }), this.currentPriceBreak = this.priceBreakToBeApplied();
   }
   getBundle() {
     return this.bundle;
@@ -6737,7 +6737,10 @@ class he {
     }), this.getPriceSubUnitsAfterPriceBreaks(A, e);
   }
   getBasePriceSubunits(e, t) {
-    const A = this.getPriceSubUnitsAfterPriceBreaks(this.getWorkflowManager().getProduct().basePrice || 0, t);
+    const A = this.getPriceSubUnitsAfterPriceBreaks(
+      this.getWorkflowManager().getProduct().basePrice || 0,
+      t
+    );
     if (e) {
       const n = this.getAdditionalProductPriceSubunits(t) || 0;
       return A + n;
@@ -6760,15 +6763,32 @@ class he {
     return Math.ceil(n);
   }
   priceBreakToBeApplied() {
-    var n;
-    const e = (this.getWorkflowManager().getProduct().priceBreaks || []).sort((a, i) => -(a.minQty - i.minQty)), A = (((n = this.bundle) == null ? void 0 : n.getWorkflowExperiences()) || []).filter(
-      (a) => a.getWorkflowManager().getProduct().id === this.getWorkflowManager().getProduct().id
-    ).reduce((a, i) => a + i.getQuantity(), 0);
-    for (const a of e)
-      if (a.minQty <= A)
-        return a.percentage;
+    const e = (this.getWorkflowManager().getProduct().priceBreaks || []).sort(
+      (n, a) => -(n.minQty - a.minQty)
+    ), A = [...this.getMatchingExperiences(), this].reduce((n, a) => n + a.getQuantity(), 0);
+    for (const n of e)
+      if (n.minQty <= A)
+        return n.percentage;
     return 1;
   }
+  checkForPriceBreakChanges() {
+    const e = this.priceBreakToBeApplied();
+    this.currentPriceBreak !== e && (this.updatePriceBreak(e), this.getMatchingExperiences().forEach(
+      (t) => t.updatePriceBreak(e)
+    ));
+  }
+  getMatchingExperiences() {
+    var e;
+    return (((e = this.bundle) == null ? void 0 : e.getWorkflowExperiences()) || []).filter(
+      (t) => t.getWorkflowManager().getTransaction().id !== this.getWorkflowManager().getTransaction().id && t.getWorkflowManager().getProduct().id === this.getWorkflowManager().getProduct().id
+    );
+  }
+  updatePriceBreak(e) {
+    this.currentPriceBreak = e, this.callEvent(
+      "PriceBreakChanged"
+      /* PriceBreakChanged */
+    );
+  }
   async copySelectionsViaGlobalConfiguration(e, t, A) {
     const n = await e.getGlobalProperties(), a = A == null ? void 0 : A.map((r) => r.getId()), i = this.getSteps().filter((r) => a === void 0 || a.includes(r.getId())), s = t.getSteps(), o = (r) => n.find((g) => g.getRawProperty().name === r.aspectName);
     i.forEach((r) => {
@@ -6923,7 +6943,7 @@ class he {
     this.getWorkflowManager().getTransaction().quantity = e, this.callEvent(
       "QuantityChanged"
       /* QuantityChanged */
-    );
+    ), this.checkForPriceBreakChanges();
     const t = x.getMap("transactionOwnerIds") || /* @__PURE__ */ new Map(), A = this.getWorkflowManager().getTransaction(), n = t.get(A.id) || void 0;
     await P.getShadowGraphqlClient().mutate({
       mutation: wn,
@@ -8022,7 +8042,7 @@ class gt {
     return (e ?? this.bundle.getWorkflowExperiences()).flatMap(
       (n) => n.getSteps().filter((a) => {
         var i;
-        return a.getOverrideGlobalPreviewConfiguration(this.property.type) ? !1 : (i = a.getRaw().globalPropertyAspectConfigurations) == null ? void 0 : i.some(
+        return a.getOverrideGlobalPropertyConfiguration(this.property.type) ? !1 : (i = a.getRaw().globalPropertyAspectConfigurations) == null ? void 0 : i.some(
           (s) => {
             var o, r;
             return s.globalPropertyConfigurationId === ((r = (o = this.bundle.getProductCollection()) == null ? void 0 : o.getResource().globalPropertyConfiguration) == null ? void 0 : r.id) && s.aspectName === this.property.name;
@@ -8683,9 +8703,9 @@ class Ft {
     return this.productCollection ? new ei(this.productCollection) : void 0;
   }
   async addWorkflowExperience(e) {
-    await this.appendWorkflowExperience(e), await this.injectExperienceIntoPreviewService(e);
+    e.setBundle(this), await this.appendWorkflowExperience(e), await this.injectExperienceIntoPreviewService(e);
     const t = await this.getGlobalProperties();
-    await Promise.all(t.map((A) => A.applyGlobalState([e]))), e.setBundle(this);
+    await Promise.all(t.map((A) => A.applyGlobalState([e])));
   }
   async addWorkflowExperiences(e) {
     const t = e.map((i) => i.getWorkflowManager().getTransaction().id), A = t.map(
@@ -8716,7 +8736,7 @@ class Ft {
         const i = await this.getGlobalProperties();
         await Promise.all(i.map((s) => s.applyGlobalState(e)));
       })()
-    ]), this.workflowExperiences.forEach((i) => i.setBundle(this));
+    ]), this.workflowExperiences.forEach((i) => i.setBundle(this)), this.workflowExperiences.forEach((i) => i.checkForPriceBreakChanges());
   }
   async appendWorkflowExperience(e, t = !0) {
     const A = e.getWorkflowManager().getTransaction().id;
@@ -8735,14 +8755,14 @@ class Ft {
         bundleOwnerId: this.ownerId,
         transactionOwnerId: i
       }
-    }), t && this.workflowExperiences.push(e);
+    }), t && (this.workflowExperiences.push(e), this.workflowExperiences.forEach((s) => s.checkForPriceBreakChanges()));
   }
   async removeWorkflowExperience(e) {
     const t = this.workflowExperiences.indexOf(e);
-    await this.removeTransaction(t, this.workflowExperiences[t].getWorkflowManager().getTransaction()), e.setBundle(void 0);
+    await this.removeTransaction(t, this.workflowExperiences[t].getWorkflowManager().getTransaction());
   }
   async removeWorkflowExperiences(e) {
-    await this.removeTransactions(e.map((t) => t.getWorkflowManager().getTransaction())), e.forEach((t) => t.setBundle(void 0));
+    await this.removeTransactions(e.map((t) => t.getWorkflowManager().getTransaction()));
   }
   async removeWorkflowExperienceByTransaction(e) {
     const t = this.workflowExperiences.findIndex(
@@ -8770,7 +8790,7 @@ class Ft {
         context: {
           bundleOwnerId: this.ownerId
         }
-      }), A && (this.workflowExperiences.splice(e, 1), await this.updateTransactionOrder());
+      }), A && (this.workflowExperiences.splice(e, 1), this.workflowExperiences.forEach((a) => a.checkForPriceBreakChanges()), n.checkForPriceBreakChanges(), await this.updateTransactionOrder());
     } else
       throw new Error("Unable to remove workflow experience from bundle - Not Found! - " + t.id);
   }
@@ -8788,7 +8808,9 @@ class Ft {
         1
       )[0]
     );
-    A.forEach((n) => n.setBundle(void 0)), this.previewService && A.forEach((n) => n.getWorkflowManager().ejectFromPreviewService()), e.forEach((n) => this.bundleStateManager.removeStateForTransaction(n.id)), await P.getShadowGraphqlClient().mutate({
+    A.forEach((n) => n.setBundle(void 0)), [...this.workflowExperiences, ...A].forEach(
+      (n) => n.checkForPriceBreakChanges()
+    ), this.previewService && A.forEach((n) => n.getWorkflowManager().ejectFromPreviewService()), e.forEach((n) => this.bundleStateManager.removeStateForTransaction(n.id)), await P.getShadowGraphqlClient().mutate({
       mutation: La,
       variables: {
         id: this.id,
@@ -8981,7 +9003,7 @@ class Ft {
       })),
       t
     );
-    if (A.forEach((n) => n.setBundle(this)), this.workflowExperiences = A, this.previewService)
+    if (A.forEach((n) => n.setBundle(this)), A.forEach((n) => n.checkForPriceBreakChanges()), this.workflowExperiences = A, this.previewService)
       for (const n of A)
         await this.injectExperienceIntoPreviewService(n);
   }