@spiffcommerce/core 0.10.115 → 0.10.117

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, Asset as _Asset1, Region, VariantResource as _VariantResource1, FrameOffsets, PatternImageData, IServerModel, MaterialResource, AssetType as _AssetType1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, 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, FrameData as _FrameData1, 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 { Workflow as _Workflow1, StepAspect as _StepAspect1, Step as _Step1, AnyStepData as _AnyStepData1, Asset as _Asset1, Region, VariantResource as _VariantResource1, FrameOffsets, PatternImageData, DigitalContentStepData as _DigitalContentStepData1, LayoutsState as _LayoutsState1, CanvasCommand as _CanvasCommand1, IServerModel, MaterialResource, AssetType as _AssetType1, FrameStepData as _FrameStepData1, ILayout as _ILayout1, CreateElementCommand as _CreateElementCommand1, FrameElement as _FrameElement1, ColorDefinition as _ColorDefinition1, IllustrationStepData as _IllustrationStepData1, IllustrationElement as _IllustrationElement1, LayoutData as _LayoutData1, 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, FrameData as _FrameData1, 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[];
@@ -238,6 +238,11 @@ declare class Poller {
      */
     constructor(predicate: () => Promise<boolean>, onSuccess: () => void, onFailure: () => void, interval?: number, maxAttempts?: number);
 }
+declare class DigitalContentStepService implements StepService<_DigitalContentStepData1> {
+    init(stepData: _Step1<_DigitalContentStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
+    regenerateQRCode(elements: RegionElement[], uploading: boolean, assetKey: string, url: string, workflowManager: WorkflowManager, stepData: _Step1<_DigitalContentStepData1>, setUrl: (finalUrl: string) => void, commandDispatcher: (command: _CanvasCommand1) => void, setIsRegenerating: (state: boolean) => void): Promise<void>;
+}
+export const digitalContentStepService: DigitalContentStepService;
 interface StorageService {
     /**
      * Get a value.
@@ -324,6 +329,23 @@ interface PersistedAsset {
     src: string;
 }
 export const assetService: AssetService;
+interface FrameCreateOpts {
+    stepName?: string;
+    frameData: FrameData;
+    disablePlaceholder?: boolean;
+    focalBlur?: boolean;
+    focalBlurStrength?: number;
+    focalBlurRadius?: number;
+    pattern?: any;
+}
+declare class FrameStepService implements StepService<_FrameStepData1> {
+    init(stepData: _Step1<_FrameStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
+    selectImage(stepData: _Step1<_FrameStepData1>, asset: IServerModel<_Asset1>, workflowManager: WorkflowManager): void;
+    selectVariant(stepData: _Step1<_FrameStepData1>, variant: _VariantResource1 | undefined, elements: RegionElement[], workflowManager: WorkflowManager, setFrameIsUpdating?: (status: boolean) => void): Promise<void>;
+    getCreateElementCommand(id: string, region: Region, layout: _ILayout1, options: FrameCreateOpts): _CreateElementCommand1<_FrameElement1>;
+    loadPatternFromString(src: string, frameService: FrameService): Promise<void>;
+}
+export const frameStepService: FrameStepService;
 interface SVGCreateOpts {
     stepName?: string;
     src: string;
@@ -339,47 +361,16 @@ declare class IllustrationStepService implements StepService<_IllustrationStepDa
     getIllustrationBody(src: string): Promise<string>;
     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<{
+    availableColors(stepData: _Step1<_IllustrationStepData1>, workflowManager: WorkflowManager): Promise<{
         fill: string | undefined;
         stroke: string | undefined;
         variant: _VariantResource1;
-    }[] | {
-        fill: string;
-        stroke: string;
     }[]>;
     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): 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> {
-    init(stepData: _Step1<_DigitalContentStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
-    regenerateQRCode(elements: RegionElement[], uploading: boolean, assetKey: string, url: string, workflowManager: WorkflowManager, stepData: _Step1<_DigitalContentStepData1>, setUrl: (finalUrl: string) => void, commandDispatcher: (command: _CanvasCommand1) => void, setIsRegenerating: (state: boolean) => void): Promise<void>;
-}
-export const digitalContentStepService: DigitalContentStepService;
-interface FrameCreateOpts {
-    stepName?: string;
-    frameData: FrameData;
-    disablePlaceholder?: boolean;
-    focalBlur?: boolean;
-    focalBlurStrength?: number;
-    focalBlurRadius?: number;
-    pattern?: any;
-}
-declare class FrameStepService implements StepService<_FrameStepData1> {
-    init(stepData: _Step1<_FrameStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<CommandWithFollowup | null>;
-    selectImage(stepData: _Step1<_FrameStepData1>, asset: IServerModel<_Asset1>, workflowManager: WorkflowManager): void;
-    selectVariant(stepData: _Step1<_FrameStepData1>, variant: _VariantResource1 | undefined, elements: RegionElement[], workflowManager: WorkflowManager, setFrameIsUpdating?: (status: boolean) => void): Promise<void>;
-    getCreateElementCommand(id: string, region: Region, layout: _ILayout1, options: FrameCreateOpts): _CreateElementCommand1<_FrameElement1>;
-    loadPatternFromString(src: string, frameService: FrameService): Promise<void>;
-}
-export const frameStepService: FrameStepService;
 declare class MaterialStepService implements StepService<_MaterialStepData1> {
     init(stepData: _Step1<_MaterialStepData1>, workflowManager: WorkflowManager, reducerState?: _LayoutsState1): Promise<null | CommandWithFollowup>;
     selectVariant(step: _Step1<_MaterialStepData1>, variant: _VariantResource1, workflowManager: WorkflowManager, setApplying: (status: boolean) => void): Promise<void>;
@@ -406,7 +397,7 @@ declare class QuestionStepService implements StepService<_QuestionStepData1> {
 }
 export const questionStepService: QuestionStepService;
 declare class ShapeStepService implements StepService<_ShapeStepData1> {
-    availableColours(stepData: _Step1<_ShapeStepData1>): Promise<{
+    availableColours(stepData: _Step1<_ShapeStepData1>, workflowManager: WorkflowManager): Promise<{
         fill: string | undefined;
         stroke: string | undefined;
         variant: _VariantResource1;
@@ -445,7 +436,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>, workflowManager: WorkflowManager): Promise<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
@@ -568,6 +559,7 @@ export interface WorkflowManager {
     getMetadata: (stepName: string) => StepMetadata | undefined;
     getWorkflowMetadata: () => WorkflowMetadata;
     getInformationResults(): InformationResult[];
+    getServer(): ServerService;
     getTransaction: () => Transaction;
     getWorkflow: () => _Workflow1;
     getWorkflowSelections: () => WorkflowSelections;
@@ -903,7 +895,7 @@ interface ServerResponse {
     /**
      * The body of the response containing any return data.
      */
-    body: object;
+    body: any;
     headers: {
         "content-type": string;
     };
@@ -946,7 +938,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> | undefined>;
+    getOption(server: ServerService, id: string): Promise<undefined | IServerModel<_OptionResource1>>;
     getAssetTileImageForVariant(variant: _VariantResource1): Promise<string>;
     getDefaultVariant(option: _OptionResource1): _VariantResource1 | undefined;
     getDisplayImageSource: (variant?: _VariantResource1) => undefined | string;
@@ -964,7 +956,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> | undefined>;
+    getOptionFromStep: (step: _Step1<_AnyStepData1>, server: ServerService) => Promise<IServerModel<_OptionResource1> | undefined>;
 }
 export const optionService: OptionService;
 export const CommandContextContext: import("react").Context<_CommandContext1>;
@@ -1287,9 +1279,6 @@ export class IllustrationStepHandle extends StepHandle<_IllustrationStepData1> {
         fill: string | undefined;
         stroke: string | undefined;
         variant: _VariantResource1;
-    }[] | {
-        fill: string;
-        stroke: string;
     }[]>;
     hasVaryingSelection(): boolean | undefined;
     hasVaryingColors(): boolean | undefined;
@@ -1437,7 +1426,7 @@ export interface DesignInputStep {
 }
 interface DesignInputStepData {
 }
-export const generateCommands: (designInputSteps: DesignInputStep[], workflow: _Workflow1, layouts: _ILayout1[], productOverlayImageUrl?: string) => Promise<_CanvasCommand1[]>;
+export const generateCommands: (designInputSteps: DesignInputStep[], workflow: _Workflow1, layouts: _ILayout1[], server: ServerService, productOverlayImageUrl?: string) => Promise<_CanvasCommand1[]>;
 /**
  * Options that can be used during instantiation of the SpiffCommerce Javascript Client.
  * Please refer to the documentation for more information.
@@ -1470,7 +1459,6 @@ export class SpiffCommerceClient {
     getSavedDesigns(): Promise<import("services/design").SavedDesign[]>;
     /**
      * Removes a design from storage. This will be a noop if the design isn't already saved.
-     * @param experience The workflow experience to remove from storage.
      */
     deleteDesign(transactionId: string): Promise<void>;
     /**
@@ -1491,7 +1479,7 @@ export class SpiffCommerceClient {
      * @param previewServiceConstructor A function called during initialization. Takes a class implementing ThreeDPreviewService in return.
      * @returns A workflow experience configured as requested.
      */
-    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: _Workflow1) => any): Promise<WorkflowExperience>;
+    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: _Workflow1) => any, server?: ServerService): Promise<WorkflowExperience>;
     /**
      * @returns The preview service that was provided during construction.
      */
@@ -1506,6 +1494,7 @@ export class SpiffCommerceClient {
     getTransaction(): Transaction;
 }
 export class MockWorkflowManager implements WorkflowManager {
+    getServer(): ServerService;
     getInitializationPromise(): Promise<void>;
     getProduct: () => Product;
     isInitialized(): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.10.115",
+    "version": "0.10.117",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -9,7 +9,7 @@
     "scripts": {
         "build": "parcel build",
         "dev": "ladle serve",
-        "test": "jest && tsc --noEmit --isolatedModules --skipLibCheck",
+        "test": "tsc --noEmit --isolatedModules --skipLibCheck && jest",
         "prepare": "yarn run build"
     },
     "targets": {
@@ -39,16 +39,15 @@
         "@babel/plugin-proposal-class-properties": "^7.18.6",
         "@esbuild-plugins/node-globals-polyfill": "^0.1.1",
         "@ladle/react": "^2.4.5",
-        "@parcel/packager-ts": "2.7.0",
-        "@parcel/transformer-typescript-tsc": "^2.7.0",
-        "@parcel/transformer-typescript-types": "^2.7.0",
-        "@parcel/validator-typescript": "^2.7.0",
+        "@parcel/packager-ts": "2.8.0",
+        "@parcel/transformer-typescript-tsc": "^2.8.0",
+        "@parcel/transformer-typescript-types": "2.8.0",
+        "@parcel/validator-typescript": "^2.8.0",
         "@types/enzyme": "^3.10.12",
         "@types/jest": "^29.0.3",
         "@types/lodash.clonedeep": "^4.5.7",
         "@types/lodash.debounce": "^4.0.7",
         "@types/lodash.isequal": "^4.5.6",
-        "@types/opentype.js": "^0.7.2",
         "@types/qrcode": "^1.3.5",
         "@types/react": "^17.0.9",
         "@types/react-dom": "^17.0.9",
@@ -80,14 +79,13 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "^1.5.36",
+        "@spiffcommerce/papyrus": "1.5.38",
         "canvg": "https://github.com/spiffdev/canvg.git#03bcd151b12441e88ecb552bb658356f5bbe92c4",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",
         "lodash.clonedeep": "^4.5.0",
         "lodash.debounce": "^4.0.8",
         "lodash.isequal": "^4.5.0",
-        "opentype.js": "^1.3.4",
         "qrcode": "^1.5.1",
         "svg-path-bbox": "^1.2.2",
         "swagger-client": "3.18.5"