@spiffcommerce/core 37.0.3 → 38.0.0

package/dist/index.d.ts

@@ -737,6 +737,7 @@ declare class AssetService implements AssetManager {
     uploadAsset(file: FileInfo, assetType: AssetType, anonymous?: boolean, temporary?: boolean): Promise<Asset>;
     uploadFile(file: File, onProgress: (val: number) => void): Promise<Asset>;
     removeBackgroundFromAsset(asset: Asset): Promise<Asset>;
+    vectorizeAsset(asset: Asset): Promise<Asset>;
     removePersistedAsset(assetKey: string): void;
     getPersistedAssets(): PersistedAsset[];
     registerPersistedAssetListener(callback: () => void): void;
@@ -806,13 +807,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;
 }
 
 /**
@@ -1459,6 +1464,13 @@ declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
      * @returns A promise that resolves with the newly generated Asset.
      */
     removeBackgroundFromImage(applyNewAsset?: boolean): Promise<Asset>;
+    /**
+     * Vectorizes the current image selection, stores it in the state, and returns the new asset.
+     * Note: This is a more expensive operation than raster background removal, so should only be used when necessary (e.g., for large images or when the user needs a transparent background for printing).
+     * @param applyNewAsset Optionally applies the new asset to all shared steps. Default: `true`.
+     * @returns A promise that resolves with the newly generated Asset.
+     */
+    vectorizeImage(applyNewAsset?: boolean): Promise<Asset>;
     /**
      * Returns `true` if the state has an image assigned, otherwise `false`.
      */
@@ -3069,6 +3081,7 @@ interface VariantResource {
     default?: boolean;
     namedColor?: string;
     option?: OptionResource;
+    category?: string;
 }
 interface IntegrationOptionResource {
     id?: string;
@@ -3193,9 +3206,12 @@ interface FrameStepData extends Animatable, Placeable, Colorable {
     displaySelectionOnFinishStep?: boolean;
     displayImageOnFinishStep?: boolean;
     disablePlaceholder?: boolean;
+    enableVariantCategories?: boolean;
     initialZoomLevel?: number;
     markSelectionAsCustomField?: boolean;
     markImageAsCustomField?: boolean;
+    shouldVectorize?: boolean;
+    vectorizeMaxColors?: number;
     maxColors?: number;
     focalBlur?: boolean;
     focalBlurRadius?: number;
@@ -3213,6 +3229,7 @@ interface IllustrationStepData extends Animatable, Placeable, Colorable {
     hideColorsInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
     displayColorsOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     enableVariantSearch?: boolean;
     markSelectionAsCustomField?: boolean;
     markColorsAsCustomField?: boolean;
@@ -3227,6 +3244,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 +3253,7 @@ interface ModelStepData extends Animatable {
     replaceProductModel?: boolean;
     hideSelectionInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     markSelectionAsCustomField?: boolean;
     varySelection?: boolean;
 }
@@ -3249,6 +3268,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 +3282,7 @@ interface QuestionStepData extends Animatable {
 interface ShapeStepData extends Animatable, Placeable {
     hideSelectionInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     markSelectionAsCustomField?: boolean;
     defaultColour?: string;
     excludeFromPrint?: boolean;
@@ -3278,6 +3299,7 @@ interface TextStepData extends Animatable, Placeable, Colorable {
     displayColorOnFinishStep?: boolean;
     displayTextOnFinishStep?: boolean;
     displayStrokeOnFinishStep?: boolean;
+    enableVariantCategories?: boolean;
     markSelectionAsCustomField?: boolean;
     markFillImageAsCustomField?: boolean;
     markColorAsCustomField?: boolean;
@@ -3370,6 +3392,7 @@ interface StepStorage {
     framePatternData?: {
         originalAssetKey?: string;
         backgroundRemovedAssetKey?: string;
+        vectorizedAssetKey?: string;
         useOriginalAsset?: boolean;
     };
     framePatternSrc?: string;
@@ -4363,6 +4386,7 @@ type GlobalPropertyStateAspectStorage = GlobalPropertyStateFileUploadStorage | G
 type GlobalPropertyStateFileUploadStorage = {
     originalAssetKey?: string;
     backgroundRemovedAssetKey?: string;
+    vectorizedAssetKey?: string;
     useOriginalAsset?: boolean;
     colors?: GlobalPropertyStateIllustrationColor[];
 };
@@ -5333,6 +5357,7 @@ declare class IllustrationStepHandle extends StepHandle<IllustrationStepData> {
     isColorPickerEnabled(): boolean;
     isPMSPickerEnabled(): boolean;
     isVariantSearchEnabled(): boolean;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 interface TextChangeResult {
@@ -5426,6 +5451,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 +5463,7 @@ declare class PictureStepHandle extends StepHandle<PictureStepData> {
      */
     selectVariant(variant: Variant): Promise<void>;
     isVariantSearchEnabled(): boolean;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 /**
@@ -5516,6 +5543,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 {
@@ -5549,6 +5577,12 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
      * @returns A promise that resolves with the newly generated Asset.
      */
     removeBackgroundFromImageSelection(applyNewAsset?: boolean): Promise<Asset>;
+    vectorizeImageSelection(applyNewAsset?: boolean): Promise<Asset>;
+    getBackgroundRemovedImageSelection(): Promise<Asset | undefined>;
+    getVectorizedImageSelection(): Promise<Asset | undefined>;
+    hasOriginalImageSelection(): boolean;
+    hasBackgroundRemovedImageSelection(): boolean;
+    hasVectorizedImageSelection(): boolean;
     changeColors(newFills: Map<string, ColorDefinition>): Promise<void>;
     getImageData(): PatternImageData | undefined;
     getColorOption(): Promise<OptionResource | undefined>;
@@ -5557,6 +5591,8 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
     getOriginalImageColors(): Promise<{
         [key: string]: ColorDefinition;
     } | undefined>;
+    getShouldVectorize(): boolean;
+    getVectorizeMaxColors(): number | undefined;
     getMaxAllowedColors(): number | undefined;
     getUniqueColorCount(): number;
     getCurrentFrameStep(frameData: FrameData, uploading?: any, imageUploadComplete?: any, variants?: VariantResource[]): FrameStep;
@@ -5565,17 +5601,16 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
     hasOverlayImageUrl(): any;
     getWhitelistedExtensions(): string[];
     getOriginalImageSelection(): Promise<Asset | undefined>;
-    getBackgroundRemovedImageSelection(): Promise<Asset | undefined>;
-    hasOriginalImageSelection(): boolean;
-    hasBackgroundRemovedImageSelection(): boolean;
     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 +5647,7 @@ declare class ShapeStepHandle extends StepHandle<ShapeStepData> implements Custo
      */
     setCustomColor(color: string): void;
     getCustomColor(): string;
+    isVariantCategoriesEnabled(): boolean;
 }
 
 declare const shortenUrl: (longUrl: string) => Promise<string>;