@spiffcommerce/core 29.1.2 → 29.2.0-beta.3ff37077-33d0-571f-b9a9-bc0d6594c98d

package/dist/index.mjs

@@ -9631,6 +9631,7 @@ const re = v`
         value
         type
         channel
+        mandatoryFulfilled
         storage {
             ... on GlobalPropertyStateColorOptionStorage {
                 customColor
@@ -9760,6 +9761,7 @@ const re = v`
                 title
                 description
                 entityId
+                mandatory
                 conditions {
                     targetAspectName
                     action
@@ -9771,6 +9773,9 @@ const re = v`
                         pmsPickerEnabled
                         colorOptionId
                     }
+                    text {
+                        templatingEnabled
+                    }
                 }
             }
         }
@@ -13565,13 +13570,13 @@ class Pa {
     return this.property.name;
   }
   /**
-   * @returns A human friendly title.
+   * @returns A human-friendly title.
    */
   getTitle() {
     return this.property.title;
   }
   /**
-   * @returns A human friendly description.
+   * @returns A human-friendly description.
    */
   getDescription() {
     return this.property.description;
@@ -13588,6 +13593,18 @@ class Pa {
   getRawProperty() {
     return this.property;
   }
+  /**
+   * @returns Whether this aspect has been marked as required to be completed before the user can continue.
+   */
+  isMandatory() {
+    return !!this.property.mandatory;
+  }
+  /**
+   * @returns Whether this aspect has been marked as `completed` for mandatory checks. Note that this function always returns `true` if the aspect has not been marked as mandatory.
+   */
+  isMandatoryFulfilled() {
+    return !this.property.mandatory || !!this.bundle.getGlobalPropertyStateManager().getAspectMandatoryFulfilled(this.property.name);
+  }
   /**
    * Returns all steps that share this property.
    * @param targetExperiences Optionally filter the steps to only those in the given experiences.
@@ -13649,12 +13666,18 @@ class cl extends Pa {
   async selectImage(t) {
     const e = this.bundle.getGlobalPropertyStateManager();
     await Promise.all([
-      e.setAspect(this.property.name, t.key, {
-        ...e.getAspectStorage(this.property.name) || {},
-        originalAssetKey: t.key,
-        backgroundRemovedAssetKey: void 0,
-        useOriginalAsset: void 0
-      }),
+      e.setAspect(
+        this.property.name,
+        t.key,
+        {
+          ...e.getAspectStorage(this.property.name) || {},
+          originalAssetKey: t.key,
+          backgroundRemovedAssetKey: void 0,
+          useOriginalAsset: void 0
+        },
+        void 0,
+        !0
+      ),
       this.applyImageSelection(t),
       this.loadImageData()
     ]);
@@ -13850,6 +13873,14 @@ class dl extends Pa {
   constructor(t, e) {
     super(t, e);
   }
+  /**
+   * If this returns false, you should not display any templating tools.
+   * Note: Templates will currently still be rendered, regardless of what this function returns.
+   */
+  isTemplatingEnabled() {
+    var t, e;
+    return ((e = (t = this.property.data) == null ? void 0 : t.text) == null ? void 0 : e.templatingEnabled) || !1;
+  }
   /**
    * Gets the current text
    */
@@ -13862,7 +13893,7 @@ class dl extends Pa {
    */
   async setText(t) {
     await Promise.all([
-      this.bundle.getGlobalPropertyStateManager().setAspect(this.property.name, t),
+      this.bundle.getGlobalPropertyStateManager().setAspect(this.property.name, t, void 0, void 0, t.trim() !== ""),
       this.applyTextSelection(t)
     ]);
   }
@@ -13937,7 +13968,7 @@ class er extends Pa {
    */
   async selectVariant(t, e) {
     await Promise.all([
-      this.bundle.getGlobalPropertyStateManager().setAspect(this.property.name, t.getId(), void 0, e),
+      this.bundle.getGlobalPropertyStateManager().setAspect(this.property.name, t.getId(), void 0, e, !0),
       this.applyVariantSelection(t)
     ]);
   }
@@ -13964,7 +13995,7 @@ class Ka extends er {
    */
   async selectVariant(t, e) {
     await Promise.all([
-      this.bundle.getGlobalPropertyStateManager().setAspect(this.property.name, t.getId(), void 0, e),
+      this.bundle.getGlobalPropertyStateManager().setAspect(this.property.name, t.getId(), void 0, e, !0),
       this.applyColorVariant(t, void 0, e)
     ]);
   }
@@ -14067,73 +14098,85 @@ class hl {
       throw new Error("Global property state not initialized");
     return (a = this.globalPropertyState.aspects.find((n) => n.name === t && n.channel === e)) == null ? void 0 : a.storage;
   }
-  async setAspect(t, e, a, n) {
+  getAspectMandatoryFulfilled(t) {
+    if (!this.globalPropertyState)
+      throw new Error("Global property state not initialized");
+    const e = this.globalPropertyState.aspects.filter((a) => a.name === t);
+    if (e)
+      return e.some((a) => !!a.mandatoryFulfilled);
+  }
+  async setAspect(t, e, a, n, i) {
     if (!this.globalPropertyState)
       throw new Error("Global property state not initialized");
     if (!this.configuration)
       throw new Error("Global property configuration not linked to the state manager.");
-    const i = this.configuration.aspects.find((l) => l.name === t);
-    if (!i)
+    const s = this.configuration.aspects.find((c) => c.name === t);
+    if (!s)
       throw new Error(`Failed to find configuration aspect with name: ${t}`);
-    const s = yt(this.globalPropertyState), o = this.globalPropertyState.aspects.filter((l) => l.name === t);
-    if (o.length > 0)
+    const o = yt(this.globalPropertyState), l = this.globalPropertyState.aspects.filter((c) => c.name === t);
+    if (l.length > 0)
       if (n) {
-        const l = o.find((c) => c.channel === n);
-        if (l)
-          l.value = e, l.type = i.type, l.channel = n, a !== void 0 && (l.storage = a !== null ? a : void 0);
+        const c = l.find((d) => d.channel === n);
+        if (c)
+          c.value = e, c.type = s.type, c.channel = n, a !== void 0 && (c.storage = a !== null ? a : void 0), i !== void 0 && (c.mandatoryFulfilled = i);
         else {
           if (n === 1) {
-            const c = this.globalPropertyState.aspects.findIndex((d) => !d.channel && d.name === t);
-            c && c > 0 && this.globalPropertyState.aspects.splice(c, 1);
+            const d = this.globalPropertyState.aspects.findIndex(
+              (A) => !A.channel && A.name === t
+            );
+            d && d > 0 && this.globalPropertyState.aspects.splice(d, 1);
           }
           this.globalPropertyState.aspects.push({
             name: t,
             value: e,
-            type: i.type,
+            type: s.type,
             storage: a !== null ? a : void 0,
-            channel: n
+            channel: n,
+            mandatoryFulfilled: i
           });
         }
       } else {
-        const l = o[0];
-        l.value = e, l.type = i.type, a !== void 0 && (l.storage = a !== null ? a : void 0);
+        const c = l[0];
+        c.value = e, c.type = s.type, a !== void 0 && (c.storage = a !== null ? a : void 0), i !== void 0 && (c.mandatoryFulfilled = i);
       }
     else
       this.globalPropertyState.aspects.push({
         name: t,
         value: e,
-        type: i.type,
+        type: s.type,
         storage: a !== null ? a : void 0,
-        channel: n
+        channel: n,
+        mandatoryFulfilled: i
       });
-    await this.updateGlobalPropertyState(), await this.onGlobalPropertyStateChange(s, this.globalPropertyState);
+    await this.updateGlobalPropertyState(), await this.onGlobalPropertyStateChange(o, this.globalPropertyState);
   }
-  async setAspectStorage(t, e, a) {
+  async setAspectStorage(t, e, a, n) {
     if (!this.globalPropertyState)
       throw new Error("Global property state not initialized");
     if (!this.configuration)
       throw new Error("Global property configuration not linked to the state manager.");
-    const n = this.configuration.aspects.find((o) => o.name === t);
-    if (!n)
+    const i = this.configuration.aspects.find((l) => l.name === t);
+    if (!i)
       throw new Error(`Failed to find configuration aspect with name: ${t}`);
-    const i = yt(this.globalPropertyState), s = this.globalPropertyState.aspects.filter((o) => o.name === t);
-    if (s.length > 0)
+    const s = yt(this.globalPropertyState), o = this.globalPropertyState.aspects.filter((l) => l.name === t);
+    if (o.length > 0)
       if (a) {
-        const o = s.find((l) => l.channel === a);
-        o && (o.storage = e !== null ? e : void 0, o.type = n.type);
+        const l = o.find((c) => c.channel === a);
+        l && (l.storage = e !== null ? e : void 0, l.type = i.type, n !== void 0 && (l.mandatoryFulfilled = n));
       } else {
-        const o = s[0];
-        o.storage = e !== null ? e : void 0, o.type = n.type;
+        const l = o[0];
+        l.storage = e !== null ? e : void 0, l.type = i.type, n !== void 0 && (l.mandatoryFulfilled = n);
       }
     else
       this.globalPropertyState.aspects.push({
         name: t,
         value: "",
-        type: n.type,
+        type: i.type,
         storage: e !== null ? e : void 0,
-        channel: a
+        channel: a,
+        mandatoryFulfilled: n
       });
-    await this.updateGlobalPropertyState(), await this.onGlobalPropertyStateChange(i, this.globalPropertyState);
+    await this.updateGlobalPropertyState(), await this.onGlobalPropertyStateChange(s, this.globalPropertyState);
   }
   async updateGlobalPropertyState() {
     var e, a;
@@ -14839,7 +14882,7 @@ class Ke {
       this.id,
       this.ownerId,
       o,
-      this.checkConditionalHandlesChanged.bind(this),
+      this.onGlobalPropertiesChanged.bind(this),
       s
     ), this.globalPropertyHandleService = new ll(this), this.setPreviewService(a);
     const l = new Promise((u, h) => {
@@ -15497,22 +15540,36 @@ class Ke {
       }
     });
   }
-  async checkConditionalHandlesChanged(t, e) {
+  async onGlobalPropertiesChanged(t, e) {
     const a = await this.globalPropertyHandleService.getHandles(), n = this.globalPropertyHandleService.applyConditionsFromState(a, t), i = this.globalPropertyHandleService.applyConditionsFromState(a, e);
-    if ((() => {
-      if (n.length !== i.length)
+    this.checkConditionalHandlesChanged(n, i), this.checkMandatoryHandlesChanged(n, i);
+    const s = i.filter((o) => !n.includes(o));
+    await Promise.all(s.map((o) => o.applyGlobalState()));
+  }
+  checkConditionalHandlesChanged(t, e) {
+    (() => {
+      if (t.length !== e.length)
         return !0;
-      for (let o = 0; o < n.length; o++)
-        if (n[o].getName() !== i[o].getName())
+      for (let n = 0; n < t.length; n++)
+        if (t[n].getName() !== e[n].getName())
           return !0;
       return !1;
-    })()) {
-      this.fireEvent("conditional-global-properties-changed", {
-        globalProperties: i
-      });
-      const o = i.filter((l) => !n.includes(l));
-      await Promise.all(o.map((l) => l.applyGlobalState()));
-    }
+    })() && this.fireEvent("conditional-global-properties-changed", {
+      globalProperties: e
+    });
+  }
+  checkMandatoryHandlesChanged(t, e) {
+    const a = [], n = [], i = [];
+    for (const s of e)
+      if (s.isMandatory()) {
+        const o = t.find((c) => c.getName() == s.getName()), l = s.isMandatoryFulfilled();
+        l ? n.push(s) : i.push(s), (!o || o.isMandatoryFulfilled() !== l) && a.push(s);
+      }
+    a.length > 0 && this.fireEvent("global-properties-mandatory-changed", {
+      changed: a,
+      completed: n,
+      remaining: i
+    });
   }
   fireEvent(t, e) {
     this.eventEmitter.emit(t, e);
@@ -16113,7 +16170,7 @@ class gd {
       } catch (a) {
         throw console.error(a), new ut("Critical - Unable to synchronize workflow state with server.");
       }
-    }, this.options = t, this.options.applicationKey && Lr(this.options.applicationKey), console.debug("------------------------"), console.debug("Spiff Commerce Core SDK"), console.debug("Version: 29.1.2"), console.debug(`Application Key Provided: ${!!this.options.applicationKey}`), console.debug("------------------------");
+    }, this.options = t, this.options.applicationKey && Lr(this.options.applicationKey), console.debug("------------------------"), console.debug("Spiff Commerce Core SDK"), console.debug("Version: 29.2.0-beta.c2f233cf-0c8a-5f9b-b1db-025730373034"), console.debug(`Application Key Provided: ${!!this.options.applicationKey}`), console.debug("------------------------");
   }
   configure(t) {
     mt.setHubUrl(t.hubUrl), mt.setServerUrl(t.serverUrl), mt.setServicesApiUrl(t.servicesApiUrl), this.marketplaceThemeInstallId = t.marketplaceThemeInstallId, this.marketplaceThemeInstallConfigurationId = t.marketplaceThemeInstallConfigurationId, this.userPoolClientId = t.userPoolClientId, this.userPoolRegion = t.userPoolRegion, this.spiffRegion = t.spiffRegion, t.bearerAuthenticationToken && zr(t.bearerAuthenticationToken), this.options.applicationKey && this.getIntegration(), this.spiffRegion && this.userPoolRegion && this.userPoolClientId && Lt.init(this.spiffRegion, this.userPoolRegion, this.userPoolClientId);