@spiffcommerce/core 0.10.183 → 0.10.185

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, 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, BulkStepData as _BulkStepData1, StepGroup, FrameData as _FrameData1, Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, 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, getAxisAlignedBoundingBox } 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, BulkStepData as _BulkStepData1, StepGroup, FrameData as _FrameData1, Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, 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, getSvgElement, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, CreateLayoutCommand, rehydrateSerializedLayout, ColorProfileProps, WorkflowPanel, determineCorrectFontSizeAndLines, registerJSDOM, getAxisAlignedBoundingBox } from "@spiffcommerce/papyrus";
 import { ApolloClient } from "@apollo/client";
 import React, { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
@@ -24,6 +24,23 @@ declare class GraphQlManager {
     getShadowGraphqlClient(): ApolloClient<any>;
 }
 export const graphQlManager: GraphQlManager;
+/**
+ * A renderable scene is a scene that can be displayed to the user. This is based on the workflow state.
+ */
+export interface RenderableScene {
+    /**
+     * The id of the scene.
+     */
+    id: string;
+    /**
+     * The title of the scene.
+     */
+    title: string;
+    /**
+     * The id of each step inside the scene that can be rendered. This is based on the workflow state.
+     */
+    renderableSteps: string[];
+}
 /**
  * Information parsed froma workflow structure that is relevant
  * to a given scene.
@@ -1136,6 +1153,13 @@ export const useEditorInteraction: (editorRef: RefObject<SVGRectElement>, intera
     handleSequenceStart: () => void;
 };
 export const useShortcutCombination: (shortcutKeys: string[], onCombinationPressed: () => void, onCombinationReleased?: () => void) => void;
+export interface DesignInputStep {
+    data: DesignInputStepData;
+    name: string;
+}
+interface DesignInputStepData {
+}
+export const generateCommands: (designInputSteps: DesignInputStep[], workflow: _Workflow1, layouts: _ILayout1[], server: ServerService, productOverlayImageUrl?: string) => Promise<_CanvasCommand1[]>;
 export const EditorCore: FunctionComponent<{
     isMobile: boolean;
     color?: string;
@@ -1170,6 +1194,8 @@ export const EditorCore: FunctionComponent<{
     onSequenceStart: () => void;
     setElementEvent: (e: ElementEvent | undefined) => void;
     onElementSelected: (elementId: string | undefined, event: PointerEvent) => void;
+    variationRecord: null | VariationRecord;
+    workflow: _Workflow1;
 }>;
 /**
  * The advanced editor encapsulates the logic required to allow users to manipulate a design
@@ -1188,6 +1214,8 @@ export const AdvancedEditor: FunctionComponent<{
     onContextMenuHandlePointerDown?: (event: PointerEvent) => void;
     onElementSelected?: (id: string | undefined, element: PointerEvent) => void;
     onDragEnd?: () => void;
+    variationRecord: null | VariationRecord;
+    workflow: _Workflow1;
 }>;
 /**
  * A StepHandle allows for managing the state of a specific step in a workflow. This class
@@ -1245,7 +1273,7 @@ export class BulkStepHandle extends StepHandle<_BulkStepData1> {
     /**
      * @param variant The variant to select. This is not supported in the bulk step.
      */
-    selectVariant(variant: _VariantResource1): Promise<void>;
+    selectVariant(): Promise<void>;
     setDesignName(designName: string): Promise<void>;
     addVariationRecord(): VariationRecord;
     updateBulkIsConnected(bulkIsConnected: boolean): void;
@@ -1510,11 +1538,20 @@ export interface WorkflowExperience {
      * @param scene The scene you want the steps for.
      */
     getStepsByScene(scene: StepGroup): StepHandle<_AnyStepData1>[];
+    /**
+     * Attaches a listener to the scenes on a workflow experience. The scenes returned are a subset of the scenes configured in the
+     * workflow and are based on the current state of the experience. This is useful for building a navigation menu.
+     * @param cb The callback to be called when the scenes change. The new scenes are passed as an argument.
+     */
+    attachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
+    /**
+     * Detaches a listener from the scenes on a workflow experience.
+     */
+    detachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
     /**
      * Saves this experience to storage. This may be local or remote depending
      * on configuration.
      * @param title The title for the saved design.
-     * @param thumbnail An optional thumbnail for the saved design. If none is provided this field will be saved blank.
      */
     save(title: string): Promise<SavedDesign>;
     /**
@@ -1535,13 +1572,6 @@ export interface WorkflowExperience {
      */
     onDesignFinished(product: Product, onProgressUpdate: DesignCreationProgressUpdate, selections: WorkflowSelections, metadata?: WorkflowMetadata | undefined): Promise<DesignCreationMessage>;
 }
-export interface DesignInputStep {
-    data: DesignInputStepData;
-    name: string;
-}
-interface DesignInputStepData {
-}
-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.
@@ -1695,7 +1725,7 @@ export class FrameStepHandle extends StepHandle<_FrameStepData1> {
 }
 export const TransformWrapper: React.FunctionComponent;
 export { CommandContext };
-export { AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, CanvasCommand, CreateElementCommand, CreateLayoutCommand, DeleteElementCommand, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, GroupCommand, LayoutElementFactory, LayoutElementType, MoveCommand, ResizeCommand, RotateCommand, SendBackwardsCommand, StepAspectType, StepType, TextChangeCommand, UnitOfMeasurement, dataUrlFromExternalUrl, findElement, frameDataCache, generate, getAxisAlignedBoundingBox, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, rehydrateSerializedLayout, getFrameData, getSvgString, loadFontFromDataUrl, loadFontFromExternalUrl, determineCorrectFontSizeAndLines, patternImageDataCache, registerJSDOM };
+export { AssetType, BringForwardCommand, BringToFrontCommand, BringToBackCommand, CanvasCommand, CreateElementCommand, CreateLayoutCommand, DeleteElementCommand, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, GroupCommand, LayoutElementFactory, LayoutElementType, MoveCommand, ResizeCommand, RotateCommand, SendBackwardsCommand, StepAspectType, StepType, TextChangeCommand, UnitOfMeasurement, dataUrlFromExternalUrl, findElement, frameDataCache, generate, getAxisAlignedBoundingBox, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, rehydrateSerializedLayout, getFrameData, getSvgElement, 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, 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.183",
+    "version": "0.10.185",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -10,7 +10,8 @@
         "build": "parcel build",
         "dev": "ladle serve",
         "test": "tsc --noEmit --isolatedModules --skipLibCheck && jest",
-        "prepare": "yarn run build"
+        "prepare": "yarn run build",
+        "lint": "npx eslint src"
     },
     "targets": {
         "main": {
@@ -51,11 +52,16 @@
         "@types/qrcode": "^1.3.5",
         "@types/react": "^17.0.9",
         "@types/react-dom": "^17.0.9",
+        "@typescript-eslint/eslint-plugin": "^5.43.0",
+        "@typescript-eslint/parser": "^5.43.0",
         "@wojtekmaj/enzyme-adapter-react-17": "^0.6.7",
         "agent-base": "^6.0.2",
         "assert": "^2.0.0",
         "buffer": "^6.0.3",
         "enzyme": "^3.11.0",
+        "eslint": "^8.28.0",
+        "eslint-plugin-react": "^7.31.11",
+        "eslint-plugin-react-hooks": "^4.6.0",
         "events": "^3.3.0",
         "https-browserify": "^1.0.0",
         "husky": "^8.0.1",
@@ -79,7 +85,7 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "^1.5.58",
+        "@spiffcommerce/papyrus": "^1.5.59",
         "canvg": "https://github.com/spiffdev/canvg.git#03bcd151b12441e88ecb552bb658356f5bbe92c4",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",