@spiffcommerce/core 26.6.1 → 26.7.0

package/CHANGELOG.md

@@ -14,6 +14,13 @@ 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.7.0] - 27-11-2024
+
+### Added
+
+-   Text steps now support custom stroke. Similar to other color customisation features, this is accessible via the functions `getAvailableStrokeColors`, `getStrokeColor`, and `setStrokeColor` on `TextStepHandle`.
+    The thickness of the stroke, the colors to select from, and other options, are configurable via the Spiff Hub in the Workflow editor.
+
 ## [26.5.2] - 20-11-2024
 
 ### Fixed

package/dist/index.d.ts

@@ -2991,14 +2991,17 @@ interface TextStepData extends Animatable, Placeable, Colorable {
     hideSelectionInCart?: boolean;
     hideFillImageInCart?: boolean;
     hideColorInCart?: boolean;
+    hideStrokeInCart?: boolean;
     hideTextInCart?: boolean;
     displaySelectionOnFinishStep?: boolean;
-    displayFillImageOnFinishStep?: boolean;
+    displayImageFillOnFinishStep?: boolean;
     displayColorOnFinishStep?: boolean;
     displayTextOnFinishStep?: boolean;
+    displayStrokeOnFinishStep?: boolean;
     markSelectionAsCustomField?: boolean;
     markFillImageAsCustomField?: boolean;
     markColorAsCustomField?: boolean;
+    markStrokeAsCustomField?: boolean;
     markTextAsCustomField?: boolean;
     allowNewlines?: boolean;
     defaultText: string;
@@ -3023,6 +3026,9 @@ interface TextStepData extends Animatable, Placeable, Colorable {
     varyColor?: boolean;
     imageFillOption?: OptionResource;
     imageFillScale?: number;
+    strokeEnabled?: boolean;
+    strokeOption?: OptionResource;
+    strokeThickness?: string;
 }
 interface SilentStepData extends Animatable, Placeable {
     asset?: Asset;
@@ -3092,6 +3098,7 @@ interface StepStorage {
     overrideGlobalConfigurations?: {
         [key: string]: boolean;
     };
+    strokeColor?: IllustrationColorObject;
     text?: string;
     videoShortUrl?: string;
     videoUrl?: string;
@@ -3792,6 +3799,7 @@ interface TextMetadata {
     color?: string;
     text: string;
     fillImage?: string;
+    strokeColor?: string;
 }
 interface SelectionStorage {
     selectedVariants?: VariantResource[];
@@ -4203,6 +4211,8 @@ interface TextboxElement extends LayoutElement {
      */
     algorithm?: TextAlgorithm;
     fillSpotColorDefinition?: SpotColorDefinition;
+    strokeColor?: ColorDefinition;
+    strokeThickness?: string;
 }
 interface FontData {
     assetUrl: string;
@@ -4720,13 +4730,20 @@ declare class TextStepService implements StepService<TextStepData> {
     /**
      * Get the colors that can be used for a given text step.
      * @param stepData The text step to get colors for.
-     * @returns A list of color objects containg fill, stroke and variant if available.
+     * @returns A list of color objects containing fill, stroke and variant if available.
      */
     availableFillColors(stepData: Step<TextStepData>): ColorOption[];
     changeAlignment(stepData: Step<TextStepData>, alignment: "left" | "center" | "right", elements: RegionElement[], workflowManager: WorkflowManager): void;
     changeFillColor(stepData: Step<TextStepData>, newColor: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
     availableFillImages(stepData: Step<TextStepData>): Promise<TextFillImage[]>;
     changeFillImage(stepData: Step<TextStepData>, fillImage: TextFillImage, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
+    /**
+     * Get the colors that can be used for a given text step's stroke.
+     * @param stepData The text step to get colors for.
+     * @returns A list of color objects containing fill, stroke and variant if available.
+     */
+    availableStrokeColors(stepData: Step<TextStepData>): ColorOption[];
+    changeStrokeColor(stepData: Step<TextStepData>, newColor: ColorOption | undefined, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
     /**
      * Given an element and a string, filters any characters from the string that are
      * not supported by the font of the given element.
@@ -4744,8 +4761,9 @@ declare class TextStepService implements StepService<TextStepData> {
     private getDefaultColorVariant;
     private getDefaultColor;
     private getDefaultImageFillVariant;
+    private getDefaultStrokeColorVariant;
     /**
-     * Validates a string of text based on step confoiguration.
+     * Validates a string of text based on step configuration.
      * @param text The text to validate
      * @param step The step providing configuration
      * @param workflowManager Workflow manager for access to workflow state
@@ -5016,6 +5034,16 @@ declare class TextStepHandle extends StepHandle<TextStepData> implements CustomC
     getCharactersRemaining(): number | undefined;
     setCustomColor(_color: string): void;
     getCustomColor(): string;
+    /**
+     * @returns A list of colors that can be used for the text's outline.
+     */
+    getAvailableStrokeColors(): ColorOption[];
+    getStrokeColor(): string;
+    /**
+     * Changes the stroke of text related to this step to the new stroke value.
+     * @param stroke A new stroke value to use.
+     */
+    setStrokeColor(stroke: ColorOption | undefined): Promise<void>;
 }
 
 declare class PictureStepHandle extends StepHandle<PictureStepData> {