@spiffcommerce/core 0.10.79 → 0.10.80

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, 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 { 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, 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[];
@@ -87,6 +87,79 @@ export class PromiseQueue<T extends QueueablePromise> {
      */
     finalize(): Promise<void>;
 }
+/**
+ * A generic base class for custom errors that assigns the name
+ * of the error class automatically. All custom errors should extend this.
+ */
+declare abstract class CustomError extends Error {
+    constructor(message: any);
+}
+/**
+ * A custom class for categorising errors related to workflow configuration.
+ */
+declare abstract class ConfigurationError extends CustomError {
+    constructor(message: any);
+}
+/**
+ * Thrown when an option was expected but not found in the workflow configuration or
+ * the server returned a 404 for an option we expected.
+ */
+export class OptionNotFoundError extends ConfigurationError {
+    readonly optionId: string;
+    constructor(step: _Step1<_AnyStepData1>);
+}
+/**
+ * Thrown when a layout is not found for a given region entity. This
+ * can occur when panels are deleted from a workflow but steps are still relying
+ * on the layout being present.
+ */
+export class LayoutNotFoundError extends ConfigurationError {
+    readonly panelId: string;
+    constructor(region: Region);
+}
+/**
+ * Thrown when an asset is not found on a specific variant. This can occur when
+ * the asset wasn't configured in hub and the variant is loaded in a workflow.
+ */
+export class AssetNotFoundError extends ConfigurationError {
+    readonly variant: _VariantResource1;
+    constructor(variant: _VariantResource1);
+}
+/**
+ * Thrown when a resource is not found linked to a specific asset. This
+ * can occur when generation of a resource fails or hasn't completed. Or may be
+ * a sign of a misconfiguration.
+ */
+export class ResourceNotFoundError extends ConfigurationError {
+    readonly asset: _Asset1;
+    constructor(asset: _Asset1);
+}
+/**
+ * Thrown when configuration is missing when it was expected. More generic
+ * to cover remaining cases outside of the more specific ones such as options, variants & assets.
+ */
+export class MisconfigurationError extends ConfigurationError {
+    readonly step: _Step1<_AnyStepData1>;
+    constructor(step: _Step1<_AnyStepData1>, message: string);
+}
+/**
+ * A custom class for categorising errors related to implementation of core.
+ */
+declare abstract class ImplementationError extends CustomError {
+    constructor(message: any);
+}
+/**
+ * Thrown when we hit a case that we didn't expect to happen
+ */
+export class UnhandledBehaviorError extends ImplementationError {
+    constructor(message: string);
+}
+/**
+ * Thrown when we fail to parse something that we expected to be valid
+ */
+export class ParseError extends ImplementationError {
+    constructor(message: string);
+}
 export class FrameService {
     minZoomScale: number;
     maxZoomScale: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "0.10.79",
+    "version": "0.10.80",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",