@spiffcommerce/core 37.0.3 → 37.1.0

package/dist/index.d.ts

@@ -806,13 +806,17 @@ declare class Variant {
      */
     isDefault(): boolean;
     /**
-     * @returns The underlying variant resource. Generally not needed but made available just incase.
+     * @returns The underlying variant resource. Generally not needed but made available just in case.
      */
     getResource(): VariantResource;
     /**
      * @returns True when the variant is enabled. False otherwise.
      */
     isEnabled(): boolean;
+    /**
+     * @returns The category for grouping variants in an option.
+     */
+    getCategory(): string | undefined;
 }
 
 /**
@@ -3069,6 +3073,7 @@ interface VariantResource {
     default?: boolean;
     namedColor?: string;
     option?: OptionResource;
+    category?: string;
 }
 interface IntegrationOptionResource {
     id?: string;
@@ -3193,6 +3198,7 @@ interface FrameStepData extends Animatable, Placeable, Colorable {
     displaySelectionOnFinishStep?: boolean;
     displayImageOnFinishStep?: boolean;
     disablePlaceholder?: boolean;
+    enableVariantCategories?: boolean;
     initialZoomLevel?: number;
     markSelectionAsCustomField?: boolean;
     markImageAsCustomField?: boolean;
@@ -3213,6 +3219,7 @@ interface IllustrationStepData extends Animatable, Placeable, Colorable {
     hideColorsInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
     displayColorsOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     enableVariantSearch?: boolean;
     markSelectionAsCustomField?: boolean;
     markColorsAsCustomField?: boolean;
@@ -3227,6 +3234,7 @@ interface IllustrationStepData extends Animatable, Placeable, Colorable {
 interface MaterialStepData extends Animatable {
     hideSelectionInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     markSelectionAsCustomField?: boolean;
     targetMaterials: string[];
     varySelection?: boolean;
@@ -3235,6 +3243,7 @@ interface ModelStepData extends Animatable {
     replaceProductModel?: boolean;
     hideSelectionInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     markSelectionAsCustomField?: boolean;
     varySelection?: boolean;
 }
@@ -3249,6 +3258,7 @@ interface ModuleStepData extends Animatable, Placeable {
 interface PictureStepData extends Animatable, Placeable {
     hideSelectionInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     enableVariantSearch?: boolean;
     markSelectionAsCustomField?: boolean;
     varySelection?: boolean;
@@ -3262,6 +3272,7 @@ interface QuestionStepData extends Animatable {
 interface ShapeStepData extends Animatable, Placeable {
     hideSelectionInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     markSelectionAsCustomField?: boolean;
     defaultColour?: string;
     excludeFromPrint?: boolean;
@@ -3278,6 +3289,7 @@ interface TextStepData extends Animatable, Placeable, Colorable {
     displayColorOnFinishStep?: boolean;
     displayTextOnFinishStep?: boolean;
     displayStrokeOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     markSelectionAsCustomField?: boolean;
     markFillImageAsCustomField?: boolean;
     markColorAsCustomField?: boolean;
@@ -5333,6 +5345,7 @@ declare class IllustrationStepHandle extends StepHandle<IllustrationStepData> {
     isColorPickerEnabled(): boolean;
     isPMSPickerEnabled(): boolean;
     isVariantSearchEnabled(): boolean;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 interface TextChangeResult {
@@ -5426,6 +5439,7 @@ declare class TextStepHandle extends StepHandle<TextStepData> implements CustomC
      * @param stroke A new stroke value to use.
      */
     setStrokeColor(stroke: ColorOption | undefined): Promise<void>;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 declare class PictureStepHandle extends StepHandle<PictureStepData> {
@@ -5437,6 +5451,7 @@ declare class PictureStepHandle extends StepHandle<PictureStepData> {
      */
     selectVariant(variant: Variant): Promise<void>;
     isVariantSearchEnabled(): boolean;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 /**
@@ -5516,6 +5531,7 @@ declare class ParseError extends ImplementationError {
 declare class ModelStepHandle extends StepHandle<ModelStepData> {
     constructor(manager: WorkflowManager, step: Step<ModelStepData>, tags: string[]);
     selectVariant(variant: Variant): Promise<void>;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 declare enum FrameStep {
@@ -5571,11 +5587,13 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
     getUseOriginalImageSelection(): boolean;
     setUseOriginalImageSelection(value: boolean): Promise<void>;
     private getFrameStepStorage;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 declare class MaterialStepHandle extends StepHandle<MaterialStepData> {
     constructor(manager: WorkflowManager, step: Step<MaterialStepData>, tags: string[]);
     selectVariant(variant: Variant): Promise<void>;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 declare class QuestionStepHandle extends StepHandle<QuestionStepData> {
@@ -5612,6 +5630,7 @@ declare class ShapeStepHandle extends StepHandle<ShapeStepData> implements Custo
      */
     setCustomColor(color: string): void;
     getCustomColor(): string;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 declare const shortenUrl: (longUrl: string) => Promise<string>;

package/dist/index.mjs

@@ -3877,6 +3877,7 @@ const Ie = new $r(), Ur = C`
             material {
                 ...MaterialFields
             }
+            category
         }
         defaultVariant {
             id
@@ -4751,6 +4752,7 @@ const B = new Wr(), Ln = C`
                             disablePlaceholder
                             displayImageOnFinishStep
                             displaySelectionOnFinishStep
+                            enableVariantCategories
                             forceImageCover
                             hideImageInCart
                             hideSelectionInCart
@@ -4784,6 +4786,7 @@ const B = new Wr(), Ln = C`
                             pmsPickerEnabled
                             displayColorsOnFinishStep
                             displaySelectionOnFinishStep
+                            enableVariantCategories
                             enableVariantSearch
                             hideColorsInCart
                             hideSelectionInCart
@@ -4805,6 +4808,7 @@ const B = new Wr(), Ln = C`
                                 layoutName
                             }
                             displaySelectionOnFinishStep
+                            enableVariantCategories
                             hideSelectionInCart
                             lookAtAnimation {
                                 ...LookAtAnimationFields
@@ -4822,6 +4826,7 @@ const B = new Wr(), Ln = C`
                                 layoutName
                             }
                             displaySelectionOnFinishStep
+                            enableVariantCategories
                             hideSelectionInCart
                             lookAtAnimation {
                                 ...LookAtAnimationFields
@@ -4860,6 +4865,7 @@ const B = new Wr(), Ln = C`
                                 layoutName
                             }
                             displaySelectionOnFinishStep
+                            enableVariantCategories
                             enableVariantSearch
                             hideSelectionInCart
                             lookAtAnimation {
@@ -4904,6 +4910,7 @@ const B = new Wr(), Ln = C`
                                 layoutName
                             }
                             displaySelectionOnFinishStep
+                            enableVariantCategories
                             excludeFromPrint
                             hideSelectionInCart
                             lookAtAnimation {
@@ -4956,6 +4963,7 @@ const B = new Wr(), Ln = C`
                             displayImageFillOnFinishStep
                             displayStrokeOnFinishStep
                             displayTextOnFinishStep
+                            enableVariantCategories
                             hideColorInCart
                             hideImageFillInCart
                             hideSelectionInCart
@@ -11800,7 +11808,7 @@ class rt {
     return !!this.variantData.default;
   }
   /**
-   * @returns The underlying variant resource. Generally not needed but made available just incase.
+   * @returns The underlying variant resource. Generally not needed but made available just in case.
    */
   getResource() {
     return this.variantData;
@@ -11811,6 +11819,12 @@ class rt {
   isEnabled() {
     return this.variantData.enabled;
   }
+  /**
+   * @returns The category for grouping variants in an option.
+   */
+  getCategory() {
+    return this.variantData.category;
+  }
 }
 const jt = class jt {
   constructor(t, e, a) {
@@ -12025,6 +12039,9 @@ class Al extends tt {
   isVariantSearchEnabled() {
     return this.step.data.enableVariantSearch ?? !1;
   }
+  isVariantCategoriesEnabled() {
+    return this.step.data.enableVariantCategories ?? !1;
+  }
 }
 class ul extends tt {
   constructor(t, e, a) {
@@ -12038,6 +12055,9 @@ class ul extends tt {
       (e) => this.setUpdateState(e)
     );
   }
+  isVariantCategoriesEnabled() {
+    return this.step.data.enableVariantCategories ?? !1;
+  }
 }
 class hl extends tt {
   constructor(t, e, a) {
@@ -12051,6 +12071,9 @@ class hl extends tt {
       (e) => this.setUpdateState(e)
     );
   }
+  isVariantCategoriesEnabled() {
+    return this.step.data.enableVariantCategories ?? !1;
+  }
 }
 class gl extends tt {
   constructor(t, e, a) {
@@ -12072,6 +12095,9 @@ class gl extends tt {
   isVariantSearchEnabled() {
     return this.step.data.enableVariantSearch ?? !1;
   }
+  isVariantCategoriesEnabled() {
+    return this.step.data.enableVariantCategories ?? !1;
+  }
 }
 class ml extends tt {
   constructor(t, e, a) {
@@ -12147,6 +12173,9 @@ class pl extends tt {
       );
     return t;
   }
+  isVariantCategoriesEnabled() {
+    return this.step.data.enableVariantCategories ?? !1;
+  }
 }
 class fl extends tt {
   constructor(t, e, a) {
@@ -12340,6 +12369,9 @@ class fl extends tt {
     const e = this.manager.getRegionElements(this.step.stepName);
     await W.changeStrokeColor(this.step, t, e, this.manager);
   }
+  isVariantCategoriesEnabled() {
+    return this.step.data.enableVariantCategories ?? !1;
+  }
 }
 class Cl extends tt {
   constructor(t, e, a) {
@@ -16111,7 +16143,7 @@ class qd {
       } catch (a) {
         throw console.error(a), new pt("Critical - Unable to synchronize workflow state with server.");
       }
-    }, this.options = t, this.options.applicationKey && cr(this.options.applicationKey), console.debug("------------------------"), console.debug("Spiff Commerce Core SDK"), console.debug("Version: 37.0.3"), console.debug(`Application Key Provided: ${!!this.options.applicationKey}`), console.debug("------------------------");
+    }, this.options = t, this.options.applicationKey && cr(this.options.applicationKey), console.debug("------------------------"), console.debug("Spiff Commerce Core SDK"), console.debug("Version: 37.1.0"), console.debug(`Application Key Provided: ${!!this.options.applicationKey}`), console.debug("------------------------");
   }
   configure(t) {
     Ct.setHubUrl(t.hubUrl), Ct.setServerUrl(t.serverUrl), Ct.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 && Ar(t.bearerAuthenticationToken), this.options.applicationKey && this.getIntegration(), this.spiffRegion && this.userPoolRegion && this.userPoolClientId && Lt.init(this.spiffRegion, this.userPoolRegion, this.userPoolClientId);
@@ -17333,6 +17365,9 @@ class Cc extends tt {
   getFrameStepStorage() {
     return this.manager.getStepStorage(this.step.stepName);
   }
+  isVariantCategoriesEnabled() {
+    return this.step.data.enableVariantCategories ?? !1;
+  }
 }
 const wc = C`
     query GetLoggedInCustomer($email: String!) {