@spiffcommerce/core 26.19.0 → 26.20.0

package/CHANGELOG.md

@@ -14,12 +14,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   `Fixed` for any bug fixes.
 -   `Security` in case of vulnerabilities.
 
+## [26.20.0] - 31-03-2025
+
+### Added
+
+-   Added new methods to the `FileUploadGlobalPropertyHandle` for overriding SVG colors:
+    -   `getImageWithColors`: Returns a promise that resolves with the current image with the current color configuration, if applicable.
+    -   `getAvailableColors`: Returns the colors from the configured color option.
+    -   `getCurrentColors`: Returns the current color configuration.
+    -   `isColorPickerEnabled` and `isPmsPickerEnabled`: Return whether the color picker and pms picker are enabled, respectively.
+    -   `getOriginalColors`: Returns a promise that resolves with the original color configuration of the image asset.
+    -   `changeColors`: Updates the current color configuration and propagates the changes to all connected workflow experiences.
 
 ## [26.19.0] - 26-03-2025
 
 ### Added
 
-- The `generateQuoteId` method on bundles.
+-   The `generateQuoteId` method on bundles.
 
 ## [26.18.0] - 24-03-2025
 

package/dist/index.d.ts

@@ -1372,7 +1372,11 @@ declare abstract class GlobalPropertyHandle {
  * A file upload global property allows for setting a frame image against all shared steps.
  */
 declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
+    private colorOption?;
+    private imageData?;
     constructor(bundle: Bundle$1, property: GlobalPropertyConfigurationAspect);
+    initialize(): Promise<FileUploadGlobalPropertyHandle>;
+    private loadImageData;
     /**
      * Select an image to be used for all shared steps.
      * @param asset The asset to use.
@@ -1395,6 +1399,7 @@ declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
      * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
      */
     getImage(): Promise<Asset | undefined>;
+    getImageWithColors(): Promise<string | undefined>;
     /**
      * Retrieves the original, unmodified image selection, if one exists.
      * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
@@ -1408,6 +1413,18 @@ declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
     getUseOriginalImage(): boolean;
     setUseOriginalImage(value: boolean): Promise<void>;
     applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    getAvailableColors(): ColorOption[];
+    getCurrentColors(): {
+        [key: string]: ColorDefinition;
+    } | undefined;
+    isColorPickerEnabled(): boolean;
+    isPmsPickerEnabled(): boolean;
+    getOriginalColors(): Promise<{
+        [key: string]: ColorDefinition;
+    } | undefined>;
+    changeColors(newFills: {
+        [key: string]: ColorDefinition;
+    }): Promise<void>;
     private applyImageSelection;
     private updateSharedStepStorage;
 }
@@ -2718,6 +2735,15 @@ interface GlobalPropertyConfigurationAspect {
     description: string;
     entityId?: string;
     conditions?: GlobalPropertyConfigurationAspectCondition[];
+    data?: GlobalPropertyConfigurationAspectData;
+}
+interface GlobalPropertyConfigurationAspectData {
+    fileUpload: GlobalPropertyConfigurationAspectFileUploadData;
+}
+interface GlobalPropertyConfigurationAspectFileUploadData {
+    colorPickerEnabled?: boolean;
+    pmsPickerEnabled?: boolean;
+    colorOptionId?: string;
 }
 interface GlobalPropertyConfigurationAspectCondition {
     targetAspectName?: string;
@@ -4004,6 +4030,12 @@ type GlobalPropertyStateFileUploadStorage = {
     originalAssetKey?: string;
     backgroundRemovedAssetKey?: string;
     useOriginalAsset?: boolean;
+    colors?: GlobalPropertyStateIllustrationColor[];
+};
+type GlobalPropertyStateIllustrationColor = {
+    key: string;
+    browserValue: string;
+    pmsValue?: string;
 };
 type GlobalPropertyStateColorOptionStorage = {
     customColor?: string;
@@ -4649,7 +4681,7 @@ declare class FrameStepService implements StepService<FrameStepData> {
     /**
      * Grab the source to be used for a frame from the variant or throw otherwise.
      */
-    private patternSource;
+    static patternSource(asset: Asset): string;
     private loadPatternFromAsset;
 }
 declare const frameStepService: FrameStepService;
@@ -5140,7 +5172,7 @@ declare enum FrameStep {
     Position = "Position"
 }
 declare class FrameStepHandle extends StepHandle<FrameStepData> {
-    frameService: any;
+    frameService: FrameService;
     constructor(manager: WorkflowManager, step: Step<FrameStepData>, tags: string[]);
     selectVariant(variant: Variant): Promise<void>;
     onFrameDataChanged(callback: (frameData: FrameData[]) => void): void;