@spiffcommerce/core 8.0.3 → 9.0.0

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, 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, MaterialResource, AssetType as _AssetType1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, BulkStepData as _BulkStepData1, 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 { 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, 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, TextFillImage, TextStepData as _TextStepData1, StepStorage as _StepStorage1, SerializableStep, CommandState as _CommandState1, CommandContext as _CommandContext1, LayoutState, MaterialResource, AssetType as _AssetType1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, BulkStepData as _BulkStepData1, 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[];
@@ -368,8 +368,10 @@ 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>): ColorOption[];
-    changeFill(stepData: _Step1<_TextStepData1>, newColor: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
+    availableFillColors(stepData: _Step1<_TextStepData1>): ColorOption[];
+    changeFillColor(stepData: _Step1<_TextStepData1>, newColor: ColorOption, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
+    availableFillImages(stepData: _Step1<_TextStepData1>): Promise<TextFillImage[]>;
+    changeFillImage(stepData: _Step1<_TextStepData1>, fillImage: TextFillImage, elements: RegionElement[], workflowManager: WorkflowManager): Promise<void>;
     /**
      * Given an element and a string, filters any characters from the string that are
      * not supported by the font of the given element.
@@ -865,6 +867,7 @@ interface ModuleMetadata {
 interface TextMetadata {
     color?: string;
     text: string;
+    fillImage?: string;
 }
 export interface SelectionStorage {
     selectedVariants?: _VariantResource1[];
@@ -1541,16 +1544,19 @@ export class TextStepHandle extends StepHandle<_TextStepData1> {
     /**
      * @returns A list of colors that can be used to fill the text.
      */
-    getAvailableColors(): ColorOption[];
+    getAvailableFillColors(): ColorOption[];
     /**
      * Changes the fill of text related to this step to the new fill value.
      * @param fill A new fill value to use.
      */
-    setFill(fill: ColorOption): Promise<void>;
+    setFillColor(fill: ColorOption): Promise<void>;
     /**
      * Gets the color currently applied to the element.
      */
-    getFill(): string;
+    getFillColor(): string;
+    getAvailableFillImages(): Promise<TextFillImage[]>;
+    setFillImage(fillImage: TextFillImage): Promise<void>;
+    getFillImage(): TextFillImage | undefined;
     /**
      * When true & the step has replaceable text configured the user will be
      * abled to edit the entire text string including the non-replaceable text.
@@ -1805,6 +1811,7 @@ interface ClientOptions {
     /**
      * When set to true, the client will treat the workflow as a bulk order
      * containing multiple variations of the base design.
+     * @deprecated Specify when calling getWorkflowExperience instead.
      */
     bulk?: boolean;
     /**
@@ -1813,6 +1820,37 @@ interface ClientOptions {
      */
     applicationKey?: string;
 }
+interface GetWorkflowFromTransactionOptions {
+    /** The existing Transaction to use. */
+    transactionId: string;
+    /** If set to true, the workflow will display in a read-only mode. */
+    readOnly?: boolean;
+    /** An existing workflow state, if available. */
+    workflowState?: string;
+    type: "transaction";
+}
+interface GetWorkflowFromIntegrationProductOptions {
+    /** The workflow to load. */
+    workflowId: string;
+    integrationProductId: string;
+    /** An existing workflow state, if available. */
+    workflowState?: string;
+    bulk?: boolean;
+    type: "integration";
+}
+interface GetWorkflowFromExternalProductOptions {
+    /** The workflow to load. */
+    workflowId: string;
+    /** The external ID associated with an integration. */
+    externalIntegrationId: string;
+    /** The ID of the product from the external system. */
+    externalProductId: string;
+    /** An existing workflow state, if available. */
+    workflowState?: string;
+    bulk?: boolean;
+    type: "external";
+}
+export type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetWorkflowFromIntegrationProductOptions | GetWorkflowFromExternalProductOptions;
 /**
  * The Spiff Commerce Javascript Client. Required for
  * creating workflow experiences.
@@ -1828,22 +1866,25 @@ export class SpiffCommerceClient {
     /**
      * Initialize the client from an integration product.
      * @param integrationProductId The integration product to use.
+     * @deprecated Use getWorkflowExperience to initialize the experience.
      */
     initFromIntegrationProduct(integrationProductId: string): Promise<void>;
     /**
      * Initialize the client from an existing transaction.
      * @param transactionId The id of the transaction
      * @returns A promise resolving at initialization completion.
+     * @deprecated Use getWorkflowExperience to initialize the experience.
      */
     initFromTransaction(transactionId: string, readOnly?: boolean): Promise<void>;
     /**
      * Creates a new instance of WorkflowExperience. A high level wrapper for workflows.
-     * @param workflowId The id of the workflow to be run.
-     * @param workflowState An existing workflow state if available.
+     * @param workflowId The id of the workflow to be run. Deprecated: Provide options instead.
+     * @param workflowState An existing workflow state if available. Deprecated: Provide options instead.
      * @param previewServiceConstructor A function called during initialization. Takes a class implementing ThreeDPreviewService in return.
+     * @param options Options to configure loading the transaction and workflow.
      * @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, options?: GetWorkflowOptions): Promise<WorkflowExperience>;
     /**
      * @returns The preview service that was provided during construction.
      */

package/package.json

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