@spiffcommerce/core 0.10.73 → 0.10.75

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, 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, StepGroup, 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, 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, StepGroup, 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, 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 } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
@@ -249,6 +249,10 @@ declare class IllustrationStepService implements StepService<_IllustrationStepDa
     getCreateElementCommand(id: string, region: Region, layout: _ILayout1, options: SVGCreateOpts): _CreateElementCommand1<_IllustrationElement1>;
     init(stepData: _Step1<_IllustrationStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
     availableColors(stepData: _Step1<_IllustrationStepData1>): Promise<{
+        fill: string | undefined;
+        stroke: string | undefined;
+        variant: _VariantResource1;
+    }[] | {
         fill: string;
         stroke: string;
     }[]>;
@@ -256,6 +260,11 @@ declare class IllustrationStepService implements StepService<_IllustrationStepDa
     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): Promise<void>;
 }
+/**
+ * FIXME: This should be shifted to papyrus at some point
+ * @param svg The SVG to get an object URL for.
+ * @returns An object URL storing the cached image of this svg file.
+ */
 export const svgObjectURL: (svg: string) => Promise<string>;
 export const illustrationStepService: IllustrationStepService;
 declare class DigitalContentStepService implements StepService<_DigitalContentStepData1> {
@@ -295,17 +304,6 @@ declare class ModuleStepService implements StepService<_ModuleStepData1> {
     changeText(stepData: _Step1<_ModuleStepData1>, input: string, workflowManager: WorkflowManager, error: string, setError: (e: string) => void): Promise<void>;
 }
 export const moduleStepService: ModuleStepService;
-declare class PatchworkStepService implements StepService<_PatchworkStepData1> {
-    init(stepData: _Step1<_PatchworkStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
-    recalculate(stepData: _Step1<_PatchworkStepData1>, elements: RegionElement[], workflowManager: WorkflowManager, setIsCalculating: (status: boolean) => void): void;
-    selectVariant(stepData: _Step1<_PatchworkStepData1>, variant: _VariantResource1, elements: RegionElement[], workflowManager: WorkflowManager, setIsCalculating: (status: boolean) => void): Promise<void>;
-    /**
-     * Constructs a preview SVG for a patchwork. Based on the configuration
-     * of the given element.
-     */
-    constructPreviewSvg(stepData: _Step1<_PatchworkStepData1>, elements: RegionElement[], getAllLayouts: () => _LayoutData1[], offsets?: _PatchworkOffsets1): null | string;
-}
-export const patchworkStepService: PatchworkStepService;
 declare class PictureStepService implements StepService<_PictureStepData1> {
     init(stepData: _Step1<_PictureStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
     selectVariant(stepData: _Step1<_PictureStepData1>, variant: _VariantResource1, workflowManager: WorkflowManager, setIsUpdating: (status: boolean) => void): Promise<void>;
@@ -318,6 +316,10 @@ declare class QuestionStepService implements StepService<_QuestionStepData1> {
 export const questionStepService: QuestionStepService;
 declare class ShapeStepService implements StepService<_ShapeStepData1> {
     availableColours(stepData: _Step1<_ShapeStepData1>): Promise<{
+        fill: string | undefined;
+        stroke: string | undefined;
+        variant: _VariantResource1;
+    }[] | {
         fill: string;
         stroke: string;
     }[]>;
@@ -846,7 +848,7 @@ declare class OptionService {
      * @param server The server service for making the request.
      * @param id The option ID to be retrieved.
      */
-    getOption(server: ServerService, id: string): Promise<IServerModel<_OptionResource1>>;
+    getOption(server: ServerService, id: string): Promise<IServerModel<_OptionResource1> | undefined>;
     getAssetTileImageForVariant(variant: _VariantResource1): Promise<string>;
     getDefaultVariant(option: _OptionResource1): _VariantResource1 | undefined;
     getDisplayImageSource: (variant?: _VariantResource1) => undefined | string;
@@ -864,7 +866,7 @@ declare class OptionService {
      * @param step The step to find an option on.
      * @returns An OptionResource in a promise.
      */
-    getOptionFromStep: (step: _Step1<_AnyStepData1>) => Promise<IServerModel<_OptionResource1>>;
+    getOptionFromStep: (step: _Step1<_AnyStepData1>) => Promise<IServerModel<_OptionResource1> | undefined>;
 }
 export const optionService: OptionService;
 export const CommandContextContext: import("react").Context<_CommandContext1>;
@@ -974,14 +976,14 @@ export interface AdvancedEditorState extends UIState {
 }
 export const getDefaultState: (getLayouts: LayoutsGetter, defaultZoom: number) => {
     layoutId: string;
-    selectedElement: any;
+    selectedElement: undefined;
     zoom: number;
     maxZoom: number;
     units: _UnitOfMeasurement1;
     subMenu: EditorSubMenu;
-    activeModifierKeys: any[];
+    activeModifierKeys: never[];
     metaPressed: boolean;
-    elementEvent: any;
+    elementEvent: undefined;
     scrolledMovement: boolean;
 };
 export const commandReducer: (state: AdvancedEditorState, command: UICommand) => AdvancedEditorState;
@@ -997,14 +999,14 @@ export class UICommand {
     constructor(changes: Partial<AdvancedEditorState>);
     apply(state: AdvancedEditorState): {
         layoutId: string;
-        selectedElement?: string;
+        selectedElement?: string | undefined;
         zoom: number;
         maxZoom: number;
         units: _UnitOfMeasurement1;
         subMenu: EditorSubMenu;
         activeModifierKeys: KeyEvent[];
         metaPressed: boolean;
-        elementEvent?: ElementEvent;
+        elementEvent?: ElementEvent | undefined;
         scrolledMovement: boolean;
     };
 }
@@ -1137,7 +1139,7 @@ export class IllustrationStepHandle extends StepHandle<_IllustrationStepData1> {
      */
     getColors(): {
         [key: string]: import("@spiffcommerce/papyrus").ColorDefinition;
-    };
+    } | undefined;
 }
 export class PictureStepHandle extends StepHandle<_PictureStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_PictureStepData1>);
@@ -1188,16 +1190,16 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
      * Gets the text currently applied to the elements of this step.
      */
     getText(): string;
-    isReplaceable(): boolean;
+    isReplaceable(): boolean | undefined;
     /**
      * Inform the step that now is the time to
      * clear default text if it should do so.
      * Returns a text change rwsult if a clear occurred.
      */
     clearDefaultTextIfNecessary(): TextChangeResult | undefined;
-    hasVaryingText(): boolean;
-    hasVaryingColor(): boolean;
-    hasVaryingSelection(): boolean;
+    hasVaryingText(): boolean | undefined;
+    hasVaryingColor(): boolean | undefined;
+    hasVaryingSelection(): boolean | undefined;
     getRegions(): import("@spiffcommerce/papyrus").Region[];
 }
 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>;
@@ -1331,10 +1333,10 @@ export class MockWorkflowManager implements WorkflowManager {
     addVariationRecord(_variationRecord: Omit<VariationRecord, "recordNumber">): {
         recordNumber: number;
         transactionId: string;
-        values: any[];
+        values: never[];
     };
-    getCurrentVariationRecord(): any;
-    removeVariationRecord(_recordNumber: number): any[];
+    getCurrentVariationRecord(): undefined;
+    removeVariationRecord(_recordNumber: number): never[];
     outstandingRequestsPromise(): Promise<void>;
     updateStateWithServerImmediate(_getReducerState: () => _CommandState1): Promise<void>;
     addPoller(_poller: Poller): void;
@@ -1352,27 +1354,27 @@ export class MockWorkflowManager implements WorkflowManager {
     addStorageCallback(_callback: StorageCallback): void;
     addVariationRecordsCallback(_callback: VariationRecordsCallback): void;
     getCommandDispatcher(): (_command: _CanvasCommand1) => void;
-    getLayouts(): any[];
+    getLayouts(): never[];
     getLayoutPreviewService(): {
         getAll: () => Map<any, any>;
     };
-    getPreviewService(): any;
-    getProfanities(): any[];
-    getRegionElements(_stepName: string): any[];
-    getSerializedStep(_stepName: string, _serializedSteps: SerializableStep[]): any;
-    getStepSpecificServices(_stepName: string): any;
+    getPreviewService(): undefined;
+    getProfanities(): never[];
+    getRegionElements(_stepName: string): never[];
+    getSerializedStep(_stepName: string, _serializedSteps: SerializableStep[]): undefined;
+    getStepSpecificServices(_stepName: string): undefined;
     getTransaction(): {
         id: string;
     };
     getWorkflow(): {
         id: string;
         name: string;
-        panels: any[];
-        steps: any[];
+        panels: never[];
+        steps: never[];
         showModelOnFinishStep: boolean;
         allowProofDownload: boolean;
         introduction: string;
-        stepGroups: any[];
+        stepGroups: never[];
     };
     markStepsAsInitialised(_stepNames: string[]): void;
     getUpdatesPending: () => boolean;
@@ -1392,6 +1394,6 @@ export class MockWorkflowManager implements WorkflowManager {
 }
 export { CommandContext };
 export { AssetType, BringForwardCommand, CanvasCommand, CreateElementCommand, CreateLayoutCommand, DeleteElementCommand, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, GroupCommand, LayoutElementFactory, LayoutElementType, MoveCommand, ResizeCommand, RotateCommand, SendBackwardsCommand, StepAspectType, StepType, TextChangeCommand, UnitOfMeasurement, dataUrlFromExternalUrl, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, rehydrateSerializedLayout, getFrameData, getSvgString, loadFontFromDataUrl, loadFontFromExternalUrl, determineCorrectFontSizeAndLines, patternImageDataCache, registerJSDOM };
-export { Animatable, AnyStepData, Asset, BulkStepData, ColorProfileProps, ColorDefinition, CommandState, WorkflowPanel, DigitalContentStepData, FrameElement, FrameStepData, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, OptionResource, PatchworkElement, PatchworkOffsets, PatchworkStepData, PictureStepData, QuestionStepData, ShapeStepData, Step, StepAspect, StepStorage, TextStepData, TextboxElement, VariantResource, Workflow };
+export { Animatable, AnyStepData, Asset, BulkStepData, ColorProfileProps, ColorDefinition, CommandState, WorkflowPanel, DigitalContentStepData, FrameElement, FrameStepData, ILayout, IllustrationElement, IllustrationStepData, ImageElement, LayoutData, LayoutElement, LayoutsState, MaterialStepData, ModelStepData, ModuleStepData, OptionResource, PictureStepData, QuestionStepData, ShapeStepData, Step, StepAspect, StepStorage, TextStepData, TextboxElement, VariantResource, Workflow };
 
 //# sourceMappingURL=types.d.ts.map

package/package.json

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