@spiffcommerce/core 0.10.20 → 0.10.22

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 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 { ApolloClient } from "@apollo/client";
-import { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent, MouseEvent } from "react";
+import { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
 export interface WorkflowScene {
     name: string;
@@ -1024,7 +1024,7 @@ export const useEditorInteraction: (editorRef: RefObject<SVGRectElement>, intera
     handleScroll: () => void;
     handleSequenceStart: () => void;
 };
-export const useShortcutCombination: (shortcutKeys: string[], callback: (keys: string[]) => void) => void;
+export const useShortcutCombination: (shortcutKeys: string[], callback: () => void) => void;
 export const EditorCore: FunctionComponent<{
     color?: string;
     editorRef: RefObject<SVGRectElement>;
@@ -1044,7 +1044,7 @@ export const EditorCore: FunctionComponent<{
     targetedElements?: string[];
     borderRadius?: number;
     handleContextMenu?: (e: any) => void;
-    onMouseMove?: (event: React.MouseEvent<SVGSVGElement, React.MouseEvent>) => void;
+    onMouseMove?: (event: React.MouseEvent<SVGRectElement, MouseEvent>) => void;
     handleKeyDown: (event: KeyboardEvent, adjustmentBoundary?: Region) => void;
     handleKeyUp: (event: KeyboardEvent) => void;
     handlePointerMove: (e: PointerEvent, adjustmentBoundary?: Region) => void;
@@ -1064,7 +1064,7 @@ export const AdvancedEditor: FunctionComponent<{
     guidelineColor?: string;
     borderRadius?: number;
     handleContextMenu?: (event: React.MouseEvent) => void;
-    onMouseMove?: (event: React.MouseEvent<SVGSVGElement, MouseEvent>) => void;
+    onMouseMove?: (event: React.MouseEvent<SVGRectElement, MouseEvent>) => void;
     onElementSelected?: (id: string | undefined, element: PointerEvent) => void;
 }>;
 /**
@@ -1118,6 +1118,11 @@ export abstract class StepHandle<T extends _AnyStepData1> {
 }
 export class IllustrationStepHandle extends StepHandle<_IllustrationStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_IllustrationStepData1>);
+    /**
+     * Allows for select a vector from the available vectors configured on this steps base option.
+     * @param variant The new vector variant to use for this step.
+     * @returns A promise that can be awaited to know when the new vector asset has been updated on the design.
+     */
     selectVariant(variant: _VariantResource1): Promise<void>;
     /**
      * Get colors for the illustration.
@@ -1129,6 +1134,11 @@ export class IllustrationStepHandle extends StepHandle<_IllustrationStepData1> {
 }
 export class PictureStepHandle extends StepHandle<_PictureStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_PictureStepData1>);
+    /**
+     * Allows the user to select an image variant from the available variants configured on this steps base option.
+     * @param variant The new image variant to use.
+     * @returns A promise that can be awaited to ensure the new image asset has been updated on the design.
+     */
     selectVariant(variant: _VariantResource1): Promise<void>;
 }
 interface TextChangeResult {
@@ -1138,6 +1148,10 @@ interface TextChangeResult {
 }
 export class TextStepHandle extends StepHandle<_TextStepData1> {
     constructor(manager: WorkflowManager, step: _Step1<_TextStepData1>);
+    /**
+     * Allows for select a font from the available fonts configured on this steps base option.
+     * @param variant The font variant to use.
+     */
     selectVariant(variant: _VariantResource1): Promise<void>;
     /**
      * @returns A list of colors that can be used to fill the text.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.10.20",
+    "version": "0.10.22",
     "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.12",
+        "@spiffcommerce/papyrus": "^1.5.13",
         "canvg": "https://github.com/spiffdev/canvg.git#03bcd151b12441e88ecb552bb658356f5bbe92c4",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",