@spiffcommerce/core 21.1.1 → 21.2.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.2.0] - 15-03-2024
+
+### Added
+
+- `FileUploadGlobalPropertyHandle`:
+    - `hasImage(): boolean`: Returns a boolean value indicating if the associated state has an image.
+    - `getImage(): Promise<Asset | undefined>`: Retrieves the current image from the server.
+
 ## [21.1.1] - 15-03-2024
 
 ### Fixed

package/dist/index.d.ts

@@ -1666,6 +1666,86 @@ declare abstract class GlobalPropertyHandle {
      * @param targetExperiences Optionally filter the steps to only those in the given experiences.
      */
     protected getSharedSteps(targetExperiences?: WorkflowExperience[]): StepHandle<_spiffcommerce_papyrus.AnyStepData>[];
+    protected getStateValue(): string | undefined;
+}
+/**
+ * A file upload global property allows for setting a frame image against all shared steps.
+ */
+declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
+    /**
+     * Select an image to be used for all shared steps.
+     * @param asset The asset to use.
+     * @returns A promise resolving when all affected steps have been updated.
+     */
+    selectImage(asset: Asset): Promise<void>;
+    /**
+     * Returns `true` if the state has an image assigned, otherwise `false`.
+     */
+    hasImage(): boolean;
+    /**
+     * Retrieves the current image selection, if one exists.
+     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
+     */
+    getImage(): Promise<Asset | undefined>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyImageSelection;
+}
+declare class TextGlobalPropertyHandle extends GlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
+    /**
+     * Gets the current text
+     */
+    getText(): string;
+    /**
+     * Set the text.
+     */
+    setText(text: string): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyTextSelection;
+}
+/**
+ * An option property handle represents a property that can
+ * affect the option of steps across multiple transactions.
+ */
+declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
+    protected optionResource?: OptionResource;
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
+    /**
+     * Gets the currently selected variant, or undefined if no variant is selected.
+     */
+    getCurrentVariant(): Variant | undefined;
+    /**
+     * @returns A list of valid variants for this step. Does not include disabled variants.
+     */
+    getAvailableVariants(): Variant[];
+    /**
+     * @returns A list of all variants for this step, including disabled ones.
+     */
+    getAllVariants(): Variant[];
+    /**
+     * Select a given variant on the option for all shared steps.
+     * @param variant The variant to select.
+     */
+    selectVariant(variant: Variant): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyVariantSelection;
+}
+/**
+ * A color option property handle represents a property that can
+ * affect the option of steps across multiple transactions. This class is a specialization of the OptionGlobalPropertyHandle which includes functionality for
+ * setting custom color values when a custom color variant is selected.
+ */
+declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle {
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
+    /**
+     * Sets a custom color on the global state.
+     */
+    setCustomColor(color: string): void;
+    /**
+     * Gets the custom color used by the global state.
+     */
+    getCustomColor(): string;
 }
 
 interface GlobalPropertyStateManager {
@@ -3032,4 +3112,4 @@ declare class PromiseCache {
 }
 declare const promiseCache: PromiseCache;
 
-export { ArrayInput, AssetNotFoundError, Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };
+export { ArrayInput, AssetNotFoundError, Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ColorOptionGlobalPropertyHandle, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextGlobalPropertyHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };

package/dist/index.js

@@ -460,7 +460,7 @@ class $t {
         name: e.name,
         blob: new Blob([e], { type: e.type })
       };
-      return await O.uploadAssetWithProgress(a, n, A, !0);
+      return await T.uploadAssetWithProgress(a, n, A, !0);
     }
   }
   removePersistedAsset(e) {
@@ -533,7 +533,7 @@ class be {
     return e ? Array.from(e.entries()).map((A) => ({ assetKey: A[0], src: A[1] })) : [];
   }
 }
-const O = new $t();
+const T = new $t();
 class _t {
   constructor() {
     this.cache = {}, this.disabled = !1;
@@ -625,8 +625,8 @@ const ge = new _t(), KA = F`
   });
   return e.data.options.forEach((A) => {
     var t, n;
-    (t = A.defaultVariant) != null && t.asset && O.cacheAsset(A.defaultVariant.asset), A.colorProfile && O.cacheAsset(A.colorProfile), (n = A.variants) == null || n.forEach((a) => {
-      a.asset && O.cacheAsset(a.asset), a.displayImage && O.cacheAsset(a.displayImage), a.thumbnail && O.cacheAsset(a.thumbnail), a.material && O.cacheMaterial(a.material);
+    (t = A.defaultVariant) != null && t.asset && T.cacheAsset(A.defaultVariant.asset), A.colorProfile && T.cacheAsset(A.colorProfile), (n = A.variants) == null || n.forEach((a) => {
+      a.asset && T.cacheAsset(a.asset), a.displayImage && T.cacheAsset(a.displayImage), a.thumbnail && T.cacheAsset(a.thumbnail), a.material && T.cacheMaterial(a.material);
     });
   }), e.data.options;
 }, tn = async (c, e) => (await e).find((t) => t.id === c), nn = async (c) => {
@@ -1852,11 +1852,11 @@ class Mn {
       new qA(
         async () => {
           var o;
-          const i = (o = (await O.getLocalOrFromServer(A.key || "")).versions) == null ? void 0 : o.find((r) => r.name === "svg");
+          const i = (o = (await T.getLocalOrFromServer(A.key || "")).versions) == null ? void 0 : o.find((r) => r.name === "svg");
           return i ? (await fetch(i.link)).status === 200 : !1;
         },
         () => {
-          O.getLocalOrFromServer(A.key || "").then((a) => {
+          T.getLocalOrFromServer(A.key || "").then((a) => {
             this.loadPatternFromAsset(a, e, t);
           });
         },
@@ -3224,8 +3224,8 @@ class kn {
         let Q;
         if (E && E.variants) {
           const N = E.variants.find((H) => {
-            var T;
-            return H.id === ((T = E.defaultVariant) == null ? void 0 : T.id);
+            var O;
+            return H.id === ((O = E.defaultVariant) == null ? void 0 : O.id);
           }) || E.variants[0];
           Q = this.createTextFillSpotColor(E, N), i.updateStorage(e, {
             colorProfileAssetKey: (h = E.colorProfile) == null ? void 0 : h.key
@@ -6280,7 +6280,7 @@ const ot = F`
 }, ct = async (c, e, A, t, n, a, i, s, o, r) => {
   var M;
   await (async () => {
-    var T;
+    var O;
     if (r !== void 0)
       return r;
     await c.outstandingRequestsPromise();
@@ -6292,7 +6292,7 @@ const ot = F`
       context: {
         transactionOwnerId: S
       }
-    }), H = (T = N.data) == null ? void 0 : T.transactions[0].workflowState;
+    }), H = (O = N.data) == null ? void 0 : O.transactions[0].workflowState;
     return N.errors ? (N.errors.forEach((b) => {
       N.errors && console.log("Server Error:", b.message);
     }), null) : H ?? null;
@@ -6302,11 +6302,11 @@ const ot = F`
     let Y = 0;
     if (Object.keys(a).length > 0)
       for (const N of Object.keys(a)) {
-        const H = a[N], T = e.steps.find((b) => b.stepName === N);
+        const H = a[N], O = e.steps.find((b) => b.stepName === N);
         for (let b = 0; b < H.selections.length; ++b) {
           const V = H.selections[b];
-          if (T && (!y || T.option && (T.option.variants || []).length > 1 && !T.data.hideSelectionInCart && !T.data.hideSelectionsInCart)) {
-            const ke = T.stepTitle;
+          if (O && (!y || O.option && (O.option.variants || []).length > 1 && !O.data.hideSelectionInCart && !O.data.hideSelectionsInCart)) {
+            const ke = O.stepTitle;
             S[ke] ? S[ke].push({
               id: V.id || "",
               name: V.name,
@@ -7944,6 +7944,9 @@ class gA {
       })
     );
   }
+  getStateValue() {
+    return this.bundle.getGlobalPropertyStateManager().getAspect(this.property.name);
+  }
 }
 class ja extends gA {
   constructor(e, A) {
@@ -7960,11 +7963,26 @@ class ja extends gA {
       this.applyImageSelection(e)
     ]);
   }
+  /**
+   * Returns `true` if the state has an image assigned, otherwise `false`.
+   */
+  hasImage() {
+    return !!this.getStateValue();
+  }
+  /**
+   * Retrieves the current image selection, if one exists.
+   * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
+   */
+  async getImage() {
+    const e = this.getStateValue();
+    if (e)
+      return T.getLocalOrFromServer(e);
+  }
   async applyGlobalState(e) {
-    const A = this.bundle.getGlobalPropertyStateManager().getAspect(this.property.name);
+    const A = this.getStateValue();
     if (!A)
       return Promise.resolve();
-    const t = await O.getLocalOrFromServer(A);
+    const t = await T.getLocalOrFromServer(A);
     return t ? this.applyImageSelection(t, e) : Promise.resolve();
   }
   async applyImageSelection(e, A) {
@@ -7980,7 +7998,7 @@ class Va extends gA {
    * Gets the current text
    */
   getText() {
-    const e = this.bundle.getGlobalPropertyStateManager().getAspect(this.property.name);
+    const e = this.getStateValue();
     return e || "";
   }
   /**
@@ -7993,7 +8011,7 @@ class Va extends gA {
     ]);
   }
   async applyGlobalState(e) {
-    const A = this.bundle.getGlobalPropertyStateManager().getAspect(this.property.name);
+    const A = this.getStateValue();
     if (!A)
       return Promise.resolve();
     await this.applyTextSelection(A, e);
@@ -8016,7 +8034,7 @@ class Bt extends gA {
     var A, t;
     if (!this.optionResource)
       return;
-    const e = this.bundle.getGlobalPropertyStateManager().getAspect(this.property.name);
+    const e = this.getStateValue();
     if (e) {
       const n = (t = this.optionResource.variants) == null ? void 0 : t.find((a) => a.id === e);
       return n ? new X(n) : void 0;
@@ -8056,7 +8074,7 @@ class Bt extends gA {
   }
   async applyGlobalState(e) {
     var n, a;
-    const A = this.bundle.getGlobalPropertyStateManager().getAspect(this.property.name);
+    const A = this.getStateValue();
     if (!A)
       return Promise.resolve();
     const t = (a = (n = this.optionResource) == null ? void 0 : n.variants) == null ? void 0 : a.find((i) => i.id === A);
@@ -9821,8 +9839,8 @@ const oi = F`
   return t.forEach((a) => {
     a.steps.forEach((i) => {
       var s, o, r;
-      delete i.data.__typename, (s = i.option) != null && s.id && ((o = i.option.defaultVariant) != null && o.asset && O.cacheAsset(i.option.defaultVariant.asset), i.option.colorProfile && O.cacheAsset(i.option.colorProfile), (r = i.option.variants) == null || r.forEach((g) => {
-        g.asset && O.cacheAsset(g.asset), g.displayImage && O.cacheAsset(g.displayImage), g.thumbnail && O.cacheAsset(g.thumbnail), g.material && O.cacheMaterial(g.material);
+      delete i.data.__typename, (s = i.option) != null && s.id && ((o = i.option.defaultVariant) != null && o.asset && T.cacheAsset(i.option.defaultVariant.asset), i.option.colorProfile && T.cacheAsset(i.option.colorProfile), (r = i.option.variants) == null || r.forEach((g) => {
+        g.asset && T.cacheAsset(g.asset), g.displayImage && T.cacheAsset(g.displayImage), g.thumbnail && T.cacheAsset(g.thumbnail), g.material && T.cacheMaterial(g.material);
       }), ge.set({ id: i.option.id }, Promise.resolve(i.option)));
     });
   }), t;
@@ -9874,7 +9892,7 @@ class fi {
    * and the Spiff Commerce platform.
    */
   getAssetManager() {
-    return O;
+    return T;
   }
   getCurrencyCode() {
     if (this.currencyCode === void 0)
@@ -10307,7 +10325,7 @@ class fi {
         return {
           transaction: Y,
           workflowId: Y.workflowId,
-          readOnly: ((H = m.find((T) => T.option.transactionId === Y.id)) == null ? void 0 : H.option.readOnly) ?? !1,
+          readOnly: ((H = m.find((O) => O.option.transactionId === Y.id)) == null ? void 0 : H.option.readOnly) ?? !1,
           index: m[N].index
         };
       });
@@ -10345,14 +10363,14 @@ class fi {
       ...r.map(n),
       ...g.map(a)
     ])).flat(), l = [...new Set(B.map((m) => m.workflowId))], d = await wt(l, A), w = new Map(d.map((m) => [m.id, m])), h = x.getMap("transactionOwnerIds") || /* @__PURE__ */ new Map(), E = B.map(async (m) => {
-      var T;
+      var O;
       const { transaction: I, workflowId: p, readOnly: M, index: y } = m, S = w.get(p), Y = e[y];
       !h.get(I.id) && I.transactionOwnerId && h.set(I.id, I.transactionOwnerId);
       const N = h.get(I.id) || void 0, H = {
         product: I.product,
         transaction: I,
         layouts: [],
-        singleVariantsRenderable: (T = Y == null ? void 0 : Y.workflowConfiguration) == null ? void 0 : T.singleVariantsRenderable,
+        singleVariantsRenderable: (O = Y == null ? void 0 : Y.workflowConfiguration) == null ? void 0 : O.singleVariantsRenderable,
         stateMutationFunc: M ? async () => {
           throw new k("State mutation is forbidden in read only mode!");
         } : async (b) => this.updateTransactionState({ ...b, context: { transactionOwnerId: N } }),
@@ -10789,12 +10807,14 @@ export {
   Xi as BringToFrontCommand,
   qi as CanvasCommand,
   Oe as CollectionProduct,
+  Wa as ColorOptionGlobalPropertyHandle,
   Zi as CommandContext,
   cn as ConversionDataType,
   rn as ConversionLocation,
   $i as CreateElementCommand,
   _i as CreateLayoutCommand,
   es as DeleteElementCommand,
+  ja as FileUploadGlobalPropertyHandle,
   Qe as FlowExecutionNodeResult,
   ii as FlowExecutionResult,
   ai as FlowService,
@@ -10822,6 +10842,7 @@ export {
   rs as MoveCommand,
   dt as ObjectInput,
   si as ObjectInputType,
+  Bt as OptionGlobalPropertyHandle,
   Me as OptionNotFoundError,
   oe as ParseError,
   Aa as PictureStepHandle,
@@ -10843,6 +10864,7 @@ export {
   W as StepHandle,
   ds as StepType,
   ws as TextChangeCommand,
+  Va as TextGlobalPropertyHandle,
   bi as TextInput,
   aa as TextStepHandle,
   ti as Transform,
@@ -10852,7 +10874,7 @@ export {
   X as Variant,
   Ea as WorkflowExperienceEventType,
   he as WorkflowExperienceImpl,
-  O as assetService,
+  T as assetService,
   la as createDesign,
   hs as dataUrlFromExternalUrl,
   Te as designService,