@spiffcommerce/core 37.1.0 → 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;
@@ -1463,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`.
      */
@@ -3202,6 +3210,8 @@ interface FrameStepData extends Animatable, Placeable, Colorable {
     initialZoomLevel?: number;
     markSelectionAsCustomField?: boolean;
     markImageAsCustomField?: boolean;
+    shouldVectorize?: boolean;
+    vectorizeMaxColors?: number;
     maxColors?: number;
     focalBlur?: boolean;
     focalBlurRadius?: number;
@@ -3382,6 +3392,7 @@ interface StepStorage {
     framePatternData?: {
         originalAssetKey?: string;
         backgroundRemovedAssetKey?: string;
+        vectorizedAssetKey?: string;
         useOriginalAsset?: boolean;
     };
     framePatternSrc?: string;
@@ -4375,6 +4386,7 @@ type GlobalPropertyStateAspectStorage = GlobalPropertyStateFileUploadStorage | G
 type GlobalPropertyStateFileUploadStorage = {
     originalAssetKey?: string;
     backgroundRemovedAssetKey?: string;
+    vectorizedAssetKey?: string;
     useOriginalAsset?: boolean;
     colors?: GlobalPropertyStateIllustrationColor[];
 };
@@ -5565,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>;
@@ -5573,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;
@@ -5581,9 +5601,6 @@ 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;