@spiffcommerce/core 22.0.2 → 22.1.0

package/dist/index.d.ts

@@ -1995,12 +1995,15 @@ declare enum InformationMessageType {
     Info = "Info"
 }
 /**
- * Services required for the operaiton of individual steps.
+ * Services required for the operation of individual steps.
  */
 interface StepSpecificServices {
     frameService?: FrameService;
     module?: ModuleProduct;
 }
+interface ValidationErrors {
+    steps: Map<string, Map<string, string>>;
+}
 type DesignCreationProgressUpdate = (message: string) => void;
 type ConfirmCallback = (isConfirmed: boolean) => void;
 type EditedCallback = (editedSteps: EditedSteps) => void;
@@ -2017,6 +2020,7 @@ type SelectionCallback = (callbackOptions: {
 }) => void;
 type StepSpecificStorageCallback = (selections: StepStorage) => void;
 type StorageCallback = (storage: WorkflowStorage) => void;
+type ValidationCallback = (validationErrors: ValidationErrors) => void;
 type StateMutationFunc = (options?: Omit<MutationOptions, "mutation">) => Promise<FetchResult<any, Record<string, any>, Record<string, any>>>;
 interface WorkflowManager {
     addPoller: (poller: Poller) => void;
@@ -2031,6 +2035,7 @@ interface WorkflowManager {
     addSelectionCallback: (callback: SelectionCallback) => void;
     addStepSpecificStorageCallback: (callback: StepSpecificStorageCallback, stepName: string) => void;
     addStorageCallback: (callback: StorageCallback) => void;
+    addValidationCallback: (callback: ValidationCallback) => void;
     getCommandDispatcher: () => (command: CanvasCommand) => void;
     getCommandContext: () => CommandContext;
     getLayouts: () => ILayout[];
@@ -2076,6 +2081,11 @@ interface WorkflowManager {
     setInformationResults: (results: InformationResult[]) => void;
     setMandatoryFulfilled: (stepName: string, status: boolean) => void;
     setSelectionsAndElements: (stepName: string, variants: VariantResource[], elements: RegionElement[], callback?: () => Promise<void>) => Promise<void>;
+    setStepError: (stepName: string, field: string, error: string | undefined) => void;
+    /** Gets any validation errors for a specific step, or `undefined` if there are none. */
+    getStepErrors: (stepName: string) => Map<string, string> | undefined;
+    /** Gets validation errors for all steps. Only steps with errors will be present. */
+    getValidationErrors: () => ValidationErrors;
     toggleDesignConfirmed: () => void;
     updateMetadata: (stepName: string, update: any) => void;
     /**
@@ -2859,9 +2869,11 @@ declare class FrameStepService implements StepService<FrameStepData> {
     getCreateElementCommand(id: string, region: Region, layout: ILayout, options: FrameCreateOpts): CreateElementCommand<FrameElement>;
     loadPatternFromString(src: string, frameService: FrameService, recalculateOffsets?: boolean, colors?: {
         [key: string]: ColorDefinition;
-    } | undefined): Promise<void>;
+    } | undefined, colorSafeSvg?: boolean): Promise<void>;
     changeColors(stepData: Step<FrameStepData>, workflowManager: WorkflowManager, newFills: Map<string, ColorDefinition>): void;
+    getUniqueColorCount(stepData: Step<FrameStepData>, workflowManager: WorkflowManager): number;
     private calculateColorMetadata;
+    private validateColorCount;
     private selectVariantCommand;
     private frameSourceSvg;
     /**
@@ -3108,6 +3120,12 @@ declare class MockWorkflowManager implements WorkflowManager {
     ejectFromPreviewService(): void;
     setWorkflowStateSyncEnabled(_enabled: boolean): void;
     updateTransactionShareActions(): Promise<void>;
+    addValidationCallback(_callback: ValidationCallback): void;
+    setStepError(_stepName: string, _field: string, _error: string | undefined): void;
+    getStepErrors(_stepName: string): undefined;
+    getValidationErrors(): {
+        steps: Map<any, any>;
+    };
 }
 
 declare const generateCommands: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<CanvasCommand[]>;
@@ -3328,7 +3346,7 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
      * @returns A promise that resolves with the newly generated Asset.
      */
     removeBackgroundFromImageSelection(applyNewAsset?: boolean): Promise<Asset>;
-    changeColors(newFills: Map<string, ColorDefinition>): Promise<void>;
+    changeColors(newFills: Map<string, ColorDefinition>): void;
     getImageData(): PatternImageData | undefined;
     getColorOption(): Promise<_spiffcommerce_papyrus.OptionResource | undefined>;
     getAvailableColors(): Promise<ColorOption[]>;
@@ -3336,6 +3354,8 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
     getOriginalImageColors(): Promise<{
         [key: string]: ColorDefinition;
     } | undefined>;
+    getMaxAllowedColors(): number | undefined;
+    getUniqueColorCount(): number;
     getCurrentFrameStep(frameData: FrameData$1, uploading?: any, imageUploadComplete?: any, variants?: VariantResource[]): FrameStep;
     getFrameService(): FrameService | undefined;
     hasOverlayImageKey(): string | undefined;