@spiffcommerce/core 22.0.1 → 22.0.2

package/dist/index.d.ts

@@ -495,6 +495,21 @@ declare class Variant {
     isEnabled(): boolean;
 }
 
+/**
+ * Steps that support custom color variants should implement the following interface to
+ * add the behavior in the way that makes sense to the step.
+ */
+interface CustomColorSupport {
+    /**
+     * Allows for setting a custom color when the custom variant is selected. Will
+     * throw when a non-custom variant is selected.
+     */
+    setCustomColor(color: string): any;
+    /**
+     * Get the custom color that is currently set on the step.
+     */
+    getCustomColor(): string;
+}
 /**
  * A StepHandle allows for managing the state of a specific step in a workflow. This class
  * abstracts away the complexities of dealing with a step directly and allows for using high level
@@ -1104,6 +1119,13 @@ declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
  */
 declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle {
     constructor(bundle: Bundle$1, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
+    /**
+     * Select a given variant on the option for all shared steps.
+     * @param variant The variant to select.
+     */
+    selectVariant(variant: Variant): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyColorVariant;
     /**
      * Sets a custom color on the global state.
      */
@@ -3123,7 +3145,7 @@ interface TextChangeResult {
     helperText?: string;
     errorText?: string;
 }
-declare class TextStepHandle extends StepHandle<TextStepData> {
+declare class TextStepHandle extends StepHandle<TextStepData> implements CustomColorSupport {
     constructor(manager: WorkflowManager, step: Step<TextStepData>);
     /**
      * Allows for select a font from the available fonts configured on this steps base option.
@@ -3182,6 +3204,8 @@ declare class TextStepHandle extends StepHandle<TextStepData> {
      * the user is allowed to add, or undefined if there is no limit.
      */
     getCharactersRemaining(): number | undefined;
+    setCustomColor(_color: string): void;
+    getCustomColor(): string;
 }
 
 declare class PictureStepHandle extends StepHandle<PictureStepData> {
@@ -3340,7 +3364,7 @@ declare class QuestionStepHandle extends StepHandle<QuestionStepData> {
     getDisplayType(): any;
 }
 
-declare class ShapeStepHandle extends StepHandle<ShapeStepData> {
+declare class ShapeStepHandle extends StepHandle<ShapeStepData> implements CustomColorSupport {
     constructor(manager: WorkflowManager, step: Step<ShapeStepData>);
     selectVariant(variant: Variant): Promise<void>;
     /**