@spiffcommerce/core 0.9.0 → 0.9.2

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, FrameOffsets, PatternImageData, IServerModel, Asset as _Asset1, MaterialResource, AssetType as _AssetType1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, Region, ILayout as _ILayout1, CreateElementCommand as _CreateElementCommand1, IllustrationElement as _IllustrationElement1, LayoutsState as _LayoutsState1, VariantResource as _VariantResource1, CanvasCommand as _CanvasCommand1, LayoutData as _LayoutData1, DigitalContentStepData as _DigitalContentStepData1, FrameStepData as _FrameStepData1, FrameElement as _FrameElement1, MaterialStepData as _MaterialStepData1, ModelStepData as _ModelStepData1, ModuleStepData as _ModuleStepData1, PatchworkStepData as _PatchworkStepData1, PatchworkOffsets as _PatchworkOffsets1, PictureStepData as _PictureStepData1, QuestionStepData as _QuestionStepData1, ShapeStepData as _ShapeStepData1, FontData, GroupCommand as _GroupCommand1, OptionResource as _OptionResource1, TextboxElement as _TextboxElement1, TextStepData as _TextStepData1, StepStorage as _StepStorage1, SerializableStep, CommandState as _CommandState1, CommandContext as _CommandContext1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BulkStepData, CanvasCommand, ColorDefinition, CommandContext, CommandState, CreateElementCommand, DeleteElementCommand, DigitalContentStepData, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameStepData, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, MoveCommand, OptionResource, PatchworkElement, PatchworkOffsets, PatchworkStepData, PictureStepData, QuestionStepData, ResizeCommand, RotateCommand, SendBackwardsCommand, ShapeStepData, Step, StepAspect, StepAspectType, StepStorage, StepType, TextChangeCommand, TextStepData, TextboxElement, UnitOfMeasurement, VariantResource, Workflow, dataUrlFromExternalUrl, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, getFrameData, getSvgString, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, CreateLayoutCommand, rehydrateSerializedLayout, ColorProfileProps, WorkflowPanel, determineCorrectFontSizeAndLines, registerJSDOM } from "@spiffcommerce/papyrus";
+import { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, FrameOffsets, PatternImageData, IServerModel, Asset as _Asset1, MaterialResource, AssetType as _AssetType1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, Region, ILayout as _ILayout1, CreateElementCommand as _CreateElementCommand1, IllustrationElement as _IllustrationElement1, LayoutsState as _LayoutsState1, VariantResource as _VariantResource1, CanvasCommand as _CanvasCommand1, LayoutData as _LayoutData1, DigitalContentStepData as _DigitalContentStepData1, FrameStepData as _FrameStepData1, FrameElement as _FrameElement1, MaterialStepData as _MaterialStepData1, ModelStepData as _ModelStepData1, ModuleStepData as _ModuleStepData1, PatchworkStepData as _PatchworkStepData1, PatchworkOffsets as _PatchworkOffsets1, PictureStepData as _PictureStepData1, QuestionStepData as _QuestionStepData1, ShapeStepData as _ShapeStepData1, FontData, GroupCommand as _GroupCommand1, OptionResource as _OptionResource1, TextboxElement as _TextboxElement1, TextStepData as _TextStepData1, StepStorage as _StepStorage1, SerializableStep, CommandState as _CommandState1, LayoutState, CommandContext as _CommandContext1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BulkStepData, CanvasCommand, ColorDefinition, CommandContext, CommandState, CreateElementCommand, DeleteElementCommand, DigitalContentStepData, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameStepData, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, MoveCommand, OptionResource, PatchworkElement, PatchworkOffsets, PatchworkStepData, PictureStepData, QuestionStepData, ResizeCommand, RotateCommand, SendBackwardsCommand, ShapeStepData, Step, StepAspect, StepAspectType, StepStorage, StepType, TextChangeCommand, TextStepData, TextboxElement, UnitOfMeasurement, VariantResource, Workflow, dataUrlFromExternalUrl, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, getFrameData, getSvgString, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, CreateLayoutCommand, rehydrateSerializedLayout, ColorProfileProps, WorkflowPanel, determineCorrectFontSizeAndLines, registerJSDOM } from "@spiffcommerce/papyrus";
 import { ApolloClient } from "@apollo/client";
 import { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent, MouseEvent } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
@@ -293,44 +293,27 @@ interface TextError {
 }
 declare class TextStepService implements StepService<_TextStepData1> {
     init(stepData: _Step1<_TextStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
-    /**
-     * @deprecated Only returns the first element. see findLayoutElements. A step can have multiple and we should return all of them!
-     */
-    findLayoutElement(workflowManager: WorkflowManager, step: _Step1<_TextStepData1>, getAllLayouts: () => any[]): _TextboxElement1;
-    findLayoutElements(workflowManager: WorkflowManager, step: _Step1<_TextStepData1>, getAllLayouts: () => any[]): _TextboxElement1[];
+    findLayoutElements(workflowManager: WorkflowManager, step: _Step1<_TextStepData1>): _TextboxElement1[];
     /**
      * 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.
      */
     availableColors(stepData: _Step1<_TextStepData1>): ColorOption[];
-    createTextFillSpotColor(colorOption: IServerModel<_OptionResource1>, variant: _VariantResource1): TextFillSpotColor | undefined;
-    changeColor(stepData: _Step1<_TextStepData1>, newColor: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
+    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
      * not supported by the font of the given element.
      * @param layoutElement The element to use for glyph lookup.
      * @param text The text string to filter.
+     * @param fontData An optional fontData object, when provided, we use the font table to determine glyphs that aren't provided and additionally strip these out also.
      * @returns A new string representing the passed string with unsupported characters removed.
      */
-    filterUnsupportedCharacters: (layoutElement: _TextboxElement1 | undefined, text: string) => string;
-    updateInputText(input: string, customiseAllText: boolean, elements: _TextboxElement1[], step: _Step1<_TextStepData1>, storage: TextStepStorage, workflowManager: WorkflowManager): TextUpdateResult;
-    /**
-     * @deprecated
-     */
-    changeInputTextWithRegion(step: _Step1<_TextStepData1>, 
-    /**
-     * @deprecated
-     */
-    curFontSize: number, 
-    /**
-     * @deprecated
-     */
-    curFontData: FontData, input: string, storage: TextStepStorage, workflowManager: WorkflowManager, customiseAllText: boolean, setError: (status: boolean) => void, setHelperText: (text: string) => void, setFlashRedError?: (status: boolean) => void): Promise<_GroupCommand1 | undefined>;
-    selectVariant(step: _Step1<_TextStepData1>, variant: _VariantResource1, storage: TextStepStorage, elements: RegionElement[], workflowManager: WorkflowManager, customiseAllText: boolean, setError: (status: boolean) => void, setHelperText: (text: string) => void): void;
-    fontDataFromVariant(variant: _VariantResource1): Promise<FontData>;
-    findOrCreateElements(workflowManager: WorkflowManager, step: _Step1<_TextStepData1>, getAllLayouts: () => any[]): Promise<_TextboxElement1[]>;
+    filterUnsupportedCharacters: (text: string, fontData?: FontData) => string;
+    updateInputText(input: string, elements: _TextboxElement1[], step: _Step1<_TextStepData1>, workflowManager: WorkflowManager): TextUpdateResult;
+    selectVariant(step: _Step1<_TextStepData1>, variant: _VariantResource1, storage: TextStepStorage, elements: RegionElement[], workflowManager: WorkflowManager, setError: (status: boolean) => void, setHelperText: (text: string) => void): void;
     textAlign: (stepData: _TextStepData1) => string;
+    createTextFillSpotColor(colorOption: IServerModel<_OptionResource1>, variant: _VariantResource1): TextFillSpotColor | undefined;
 }
 export const textStepService: TextStepService;
 declare abstract class ModuleProduct {
@@ -430,6 +413,7 @@ export interface WorkflowManager {
     getCurrentVariationRecord: () => VariationRecord | undefined;
     getVariationRecords: () => VariationRecord[];
     getLayouts: () => _ILayout1[];
+    getAllLayoutData: () => LayoutState[];
     getLayoutPreviewService: () => any;
     getPreviewService: () => any | undefined;
     getProductName: () => string | undefined;
@@ -437,6 +421,9 @@ export interface WorkflowManager {
     getRegionElements: (stepName: string) => RegionElement[];
     getSerializedStep: (stepName: string, serializedSteps: SerializableStep[]) => SerializableStep | undefined;
     getStepSpecificServices: (stepName: string) => StepSpecificServices | undefined;
+    getStepStorage: (stepName: string) => _StepStorage1 | undefined;
+    getMetadata: (stepName: string) => StepMetadata | undefined;
+    getInformationResults(): InformationResult[];
     getTransaction: () => Transaction;
     getWorkflow: () => _Workflow1;
     getWorkflowSelections: () => WorkflowSelections;
@@ -734,11 +721,12 @@ interface TextMetadata {
 export interface SelectionStorage {
     selectedVariants?: _VariantResource1[];
 }
-interface TextStepStorage extends SelectionStorage {
+export interface TextStepStorage extends SelectionStorage {
     color?: string;
     defaultCleared?: boolean;
     inputText?: string;
     text?: string;
+    customiseAllText?: boolean;
 }
 type StepSelections = {
     [key: string]: SelectionStorage;
@@ -1043,6 +1031,31 @@ interface StorageService {
     setMap(key: string, val: Map<any, any>): void;
 }
 export const persistenceService: StorageService;
+/**
+ * An abstract base class to be extended by step handles to implement type specific behavior.
+ */
+declare abstract class StepHandleTypeContext<T> {
+    protected readonly manager: WorkflowManager;
+    protected readonly step: _Step1<T>;
+    constructor(manager: WorkflowManager, stepConfiguration: _Step1<T>);
+}
+interface TextChangeResult {
+    input: string;
+    helperText?: string;
+    errorText?: string;
+}
+declare class StepHandleTextContext extends StepHandleTypeContext<_TextStepData1> {
+    /**
+     * Changes the fill of text related to this step to the new fill value.
+     * @param fill A new fill value to use.
+     */
+    setFill(fill: ColorOption): Promise<void>;
+    /**
+     * Changes the text value of text related to this step to a new value.
+     * @param userInput Input from the user.
+     */
+    setText(userInput: string): TextChangeResult;
+}
 /**
  * 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
@@ -1061,6 +1074,14 @@ interface StepHandle {
      * Selects a specific variant for this step.
      */
     selectVariant(variant: _VariantResource1): any;
+    /**
+     * Get a handle to a class that exposes any functionality specific to this step type.
+     */
+    getTypeSpecificContext(): StepHandleTextContext | StepHandleIllustrationContext | StepHandleQuestionContext;
+}
+declare class StepHandleIllustrationContext extends StepHandleTypeContext<_IllustrationStepData1> {
+}
+declare class StepHandleQuestionContext extends StepHandleTypeContext<_QuestionStepData1> {
 }
 /**
  * A Workflow experience encapsulates the workflow manager and command context. It
@@ -1173,6 +1194,10 @@ export class Client {
     getTransaction(): Transaction;
 }
 export class MockWorkflowManager implements WorkflowManager {
+    getAllLayoutData: () => LayoutState[];
+    getMetadata: (stepName: string) => StepMetadata | undefined;
+    getStepStorage: (stepName: string) => _StepStorage1 | undefined;
+    getInformationResults(): InformationResult[];
     getVariationRecords(): VariationRecord[];
     reset(): Promise<void>;
     updateStateWithServer(_getReducerState: () => _CommandState1): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.9.0",
+    "version": "0.9.2",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -45,7 +45,6 @@
         "@types/lodash.clonedeep": "^4.5.7",
         "@types/lodash.debounce": "^4.0.7",
         "@types/lodash.isequal": "^4.5.6",
-        "@types/offscreencanvas": "^2019.7.0",
         "@types/opentype.js": "^0.7.2",
         "@types/qrcode": "^1.3.5",
         "@types/react": "^17.0.9",
@@ -67,7 +66,7 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "^1.5.2",
+        "@spiffcommerce/papyrus": "^1.5.3",
         "canvg": "https://github.com/spiffdev/canvg.git#03bcd151b12441e88ecb552bb658356f5bbe92c4",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",