@spiffcommerce/core 0.9.10 → 0.10.1

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, 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 { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, FrameOffsets, PatternImageData, IServerModel, Asset as _Asset1, MaterialResource, AssetType as _AssetType1, VariantResource as _VariantResource1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, Region, ILayout as _ILayout1, CreateElementCommand as _CreateElementCommand1, IllustrationElement as _IllustrationElement1, LayoutsState as _LayoutsState1, 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, LayoutState, 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[];
@@ -208,6 +208,13 @@ declare class AssetService {
      * Convert a File object for an image into a FileInfo.
      */
     loadImageAsFileInfo: (file: File) => Promise<FileInfo>;
+    /**
+     * Search for the asset of a variant. First looks for an asset inlined in the variant,
+     * otherwise check for ID in our cache and go to the server as a last resort.
+     * @param variant The variant to search on.
+     * @returns An asset entity as a promise.
+     */
+    getAssetFromVariant: (variant: _VariantResource1) => Promise<IServerModel<_Asset1>>;
 }
 interface PersistedAsset {
     assetKey: string;
@@ -235,7 +242,7 @@ declare class IllustrationStepService implements StepService<_IllustrationStepDa
     }[];
     changeColorsCommand(svg: string, illustrationWidth: number, illustrationHeight: number, elements: string[], newFills: Map<string, string>): Promise<_CanvasCommand1>;
     changeColors(stepData: _Step1<_IllustrationStepData1>, elements: RegionElement[], workflowManager: WorkflowManager, getAllLayouts: () => _LayoutData1[], newFills: Map<string, string>): Promise<void>;
-    selectVariant(stepData: _Step1<_IllustrationStepData1>, variant: _VariantResource1, elements: RegionElement[], setIsUpdating: (isUpdating: boolean) => void, workflowManager: WorkflowManager): void;
+    selectVariant(stepData: _Step1<_IllustrationStepData1>, variant: _VariantResource1, elements: RegionElement[], setIsUpdating: (isUpdating: boolean) => void, workflowManager: WorkflowManager): Promise<void>;
 }
 export const svgObjectURL: (svg: string) => Promise<string>;
 export const illustrationStepService: IllustrationStepService;
@@ -348,7 +355,7 @@ declare class TextStepService implements StepService<_TextStepData1> {
      */
     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;
+    selectVariant(step: _Step1<_TextStepData1>, variant: _VariantResource1, workflowManager: WorkflowManager, setError: (status: boolean) => void, setHelperText: (text: string) => void): void;
     textAlign: (stepData: _TextStepData1) => string;
     createTextFillSpotColor(colorOption: IServerModel<_OptionResource1>, variant: _VariantResource1): TextFillSpotColor | undefined;
 }
@@ -400,7 +407,8 @@ export interface InformationResult {
 }
 export enum InformationMessageType {
     Error = "Error",
-    Warning = "Warning"
+    Warning = "Warning",
+    Info = "Info"
 }
 /**
  * Services required for the operaiton of individual steps.
@@ -449,6 +457,7 @@ export interface WorkflowManager {
     getCommandDispatcher: () => (command: _CanvasCommand1) => void;
     getCurrentVariationRecord: () => VariationRecord | undefined;
     getVariationRecords: () => VariationRecord[];
+    getCommandContext: () => _CommandContext1;
     getLayouts: () => _ILayout1[];
     getAllLayoutData: () => LayoutState[];
     getLayoutPreviewService: () => any;
@@ -842,6 +851,13 @@ declare class OptionService {
      * Returns all selected variants. This is used by the question step as multiple selections can be made.
      */
     getSelectedVariants: (option: _OptionResource1 | undefined, selectedVariantIds: string[]) => _VariantResource1[];
+    /**
+     * Returns the option from a given step. When the option is inline, we return that.
+     * Otherwise look for an option ID, check our cache and go to the server as a last resort.
+     * @param step The step to find an option on.
+     * @returns An OptionResource in a promise.
+     */
+    getOptionFromStep: (step: _Step1<_AnyStepData1>) => Promise<IServerModel<_OptionResource1>>;
 }
 export const optionService: OptionService;
 export const CommandContextContext: import("react").Context<_CommandContext1>;
@@ -1048,56 +1064,45 @@ export const AdvancedEditor: FunctionComponent<{
     onElementSelected?: (id: string | undefined, element: PointerEvent) => void;
 }>;
 /**
- * An abstract base class to be extended by step handles to implement type specific behavior.
+ * 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
+ * concepts instead of dealing with the underlying data structures.
  */
-declare abstract class StepHandleTypeContext<T> {
+declare abstract class StepHandle<T extends _AnyStepData1> {
+    /**
+     * Access to the workflow manager this step is contained by.
+     */
     protected readonly manager: WorkflowManager;
+    /**
+     * The step metadata, useful for determining logic based on configuration.
+     */
     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> {
+    constructor(manager: WorkflowManager, step: _Step1<T>);
     /**
-     * Changes the fill of text related to this step to the new fill value.
-     * @param fill A new fill value to use.
+     * Set the current update state of this step. All step handles pointing to this step will
+     * see this value.
+     * @param value The new value
      */
-    setFill(fill: ColorOption): Promise<void>;
+    protected setUpdateState(value: boolean): void;
     /**
-     * Changes the text value of text related to this step to a new value.
-     * @param userInput Input from the user.
+     * @returns Gets the current update state of this step. All step handles for this step will see this value.
      */
-    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
- * concepts instead of dealing with the underlying data structures.
- */
-interface StepHandle {
+    protected getUpdateState(): boolean;
     /**
      * Gets the currently selected variant, or undefined if no variant is selected.
      */
-    getCurrentVariant(): any;
+    getCurrentVariant(): _VariantResource1;
     /**
      * Returns a list of valid variants for this step.
      */
     getAvailableVariants(): Promise<_VariantResource1[]>;
     /**
-     * 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.
+     * Most step types have a base option type that variants can be selected for.
+     * Selects a specific variant for this step. This will execute all required changes to
+     * the design and update the metadata to include the new selection. Any conditions
+     * that would be triggered will also be executed.
      */
-    getTypeSpecificContext(): StepHandleTextContext | StepHandleIllustrationContext | StepHandleQuestionContext;
-}
-declare class StepHandleIllustrationContext extends StepHandleTypeContext<_IllustrationStepData1> {
-}
-declare class StepHandleQuestionContext extends StepHandleTypeContext<_QuestionStepData1> {
+    abstract selectVariant(variant: _VariantResource1): Promise<void>;
 }
 /**
  * A Workflow experience encapsulates the workflow manager and command context. It
@@ -1125,17 +1130,17 @@ export interface WorkflowExperience {
      * Returns the step matching a given name, undefined if not found.
      * @param id The id the step must match.
      */
-    getStepById(id: string): StepHandle | undefined;
+    getStepById(id: string): StepHandle<_AnyStepData1> | undefined;
     /**
      * Returns the step matching a given name, undefined if not found.
      * @param name The name the step must match.
      */
-    getStepByName(name: string): StepHandle | undefined;
+    getStepByName(name: string): StepHandle<_AnyStepData1> | undefined;
     /**
      * Returns all steps matching a specific type in the workflow. These steps
      * may be across multiple scenes and may or may not be active based on condition state.
      */
-    getStepsByType(type: _StepType1): StepHandle[];
+    getStepsByType(type: _StepType1): StepHandle<_AnyStepData1>[];
     /**
      * Creates a data URL preview for the current design.
      */
@@ -1210,6 +1215,7 @@ export class Client {
     getTransaction(): Transaction;
 }
 export class MockWorkflowManager implements WorkflowManager {
+    getCommandContext: () => _CommandContext1;
     getAllLayoutData: () => LayoutState[];
     getMetadata: (stepName: string) => StepMetadata | undefined;
     getStepStorage: (stepName: string) => _StepStorage1 | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.9.10",
+    "version": "0.10.1",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -79,7 +79,7 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "^1.5.4",
+        "@spiffcommerce/papyrus": "^1.5.5",
         "canvg": "https://github.com/spiffdev/canvg.git#03bcd151b12441e88ecb552bb658356f5bbe92c4",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",