@spiffcommerce/core 2.0.0 → 3.1.0

package/dist/types.d.ts

@@ -368,7 +368,7 @@ declare class TextStepService implements StepService<_TextStepData1> {
      * @param stepData The text step to get colors for.
      * @returns A list of color objects containg fill, stroke and variant if available.
      */
-    availableColors(stepData: _Step1<_TextStepData1>): Promise<ColorOption[]>;
+    availableColors(stepData: _Step1<_TextStepData1>): ColorOption[];
     changeFill(stepData: _Step1<_TextStepData1>, newColor: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
     /**
      * Given an element and a string, filters any characters from the string that are
@@ -824,7 +824,7 @@ interface Product {
      */
     conversionConfiguration?: ConversionConfiguration;
 }
-interface ColorOption {
+export interface ColorOption {
     id?: string;
     fill?: string;
     stroke?: string;
@@ -1474,7 +1474,7 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
     /**
      * @returns A list of colors that can be used to fill the text.
      */
-    getAvailableColors(): Promise<ColorOption[]>;
+    getAvailableColors(): ColorOption[];
     /**
      * Changes the fill of text related to this step to the new fill value.
      * @param fill A new fill value to use.
@@ -1511,6 +1511,16 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
     hasVaryingSelection(): boolean | undefined;
     hasColorPicker(): boolean | undefined;
     getRegions(): import("@spiffcommerce/papyrus").Region[];
+    /**
+     * Return the maximum characters allowed for
+     * this step, or undefined if there is no limit.
+     */
+    getCharacterLimit(): number | undefined;
+    /**
+     * Return the remaining amount of characters that
+     * the user is allowed to add, or undefined if there is no limit.
+     */
+    getCharactersRemaining(): number | undefined;
 }
 export const createDesign: (workflowManager: WorkflowManager, workflow: _Workflow1, layouts: _ILayout1[], getReducerState: () => _CommandState1, product: Product, transaction: Transaction, workflowSelections: WorkflowSelections, designName: string, onProgressUpdate: DesignCreationProgressUpdate, updateVariationRecords: (variationRecords: VariationRecord[]) => Promise<void>, variationRecords: VariationRecord[], createPreviewImage: (shouldRender3D?: boolean) => Promise<string>, workflowMetadata?: WorkflowMetadata) => Promise<DesignCreationMessage>;
 export interface SavedDesign {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "2.0.0",
+    "version": "3.1.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",