@spiffcommerce/core 14.3.1 → 14.5.0

package/dist/types.d.ts

@@ -1,4 +1,7 @@
-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, GlobalPropertyConfiguration, MaterialResource, AssetType as _AssetType1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, BulkStepData as _BulkStepData1, FrameData as _FrameData1, AspectType, GlobalPropertyConfigurationAspect, Theme as _Theme1, 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, Theme } 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, SilentStepData, Placeable, StepStorage as _StepStorage1, SerializableStep, CommandState as _CommandState1, CommandContext as _CommandContext1, LayoutState, GlobalPropertyConfiguration, MaterialResource, AssetType as _AssetType1, Point, ScaleAxis, UnitOfMeasurement as _UnitOfMeasurement1, StepType as _StepType1, BulkStepData as _BulkStepData1, FrameData as _FrameData1, AspectType, GlobalPropertyConfigurationAspect, Theme as _Theme1, 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, Theme } from "@spiffcommerce/papyrus";
+import { DefaultContext, OperationVariables } from "@apollo/client/core/types";
+import { MutationFunctionOptions } from "@apollo/client/react/types/types";
+import { ApolloCache, FetchResult } from "@apollo/client/core";
 import { ApolloClient } from "@apollo/client";
 import React, { ReactNode, Dispatch, FunctionComponent, RefObject, PointerEvent, KeyboardEvent } from "react";
 export const gatherVaryingStepAspects: (workflow: _Workflow1) => _StepAspect1[];
@@ -409,6 +412,8 @@ declare abstract class ModuleProduct {
      */
     abstract svgPrint(text: string, region: Region): string;
 }
+export interface SilentIllustrationStepData extends SilentStepData, Placeable {
+}
 export interface EditedSteps {
     [stepName: string]: boolean;
 }
@@ -469,6 +474,7 @@ type StepSpecificStorageCallback = (selections: _StepStorage1) => void;
 type StorageCallback = (storage: WorkflowStorage) => void;
 type CurrentVariationRecordCallback = (variationRecord: null | VariationRecord) => void;
 type VariationRecordsCallback = (records: VariationRecord[]) => void;
+export type StateMutationFunc = (options?: MutationFunctionOptions<any, OperationVariables, DefaultContext, ApolloCache<any>> | undefined) => Promise<FetchResult<any, Record<string, any>, Record<string, any>>>;
 export interface WorkflowManager {
     addPoller: (poller: Poller) => void;
     addConfirmCallback: (callback: ConfirmCallback) => void;
@@ -771,7 +777,7 @@ interface Partner {
     currencyCode?: string;
     customerDetailsPromptMarkdown?: string;
 }
-interface Product {
+export interface Product {
     /**
      * ID of the partner owner.
      */
@@ -1039,7 +1045,7 @@ export interface Stakeholder {
     transaction?: Transaction;
     customer?: Customer;
 }
-interface Bundle {
+interface _Bundle1 {
     id?: string;
     bundleOwnerId?: string;
     bundleStakeholders?: BundleStakeholder[];
@@ -1054,7 +1060,7 @@ interface Bundle {
 }
 interface BundleStakeholder {
     id: string;
-    bundle?: Bundle;
+    bundle?: _Bundle1;
     customer?: Customer;
     type?: StakeholderType;
 }
@@ -1511,6 +1517,8 @@ export abstract class StepHandle<T extends _AnyStepData1> {
      * @returns The underlying data for this step. Favor using the step handle methods instead of this.
      */
     getRaw(): _Step1<T>;
+    getTags(): string[];
+    hasTag(tag: string): boolean;
     /**
      * Fires any configured animations on the 3D preview for this step.
      * This includes camera & model animations. If the preview is unavailable
@@ -1771,6 +1779,31 @@ interface Scene {
      */
     stepIds: string[];
 }
+/**
+ * State related to a workflow experience.
+ */
+interface ExperienceOptions {
+    product: Product;
+    transaction: Transaction;
+    workflow?: _Workflow1;
+    previewService?: any;
+    modelContainer?: any;
+    renderableContextService?: any;
+    layouts: _ILayout1[];
+    reloadedState?: LayoutsState;
+    /**
+     * When true the experience is intended to be immutable.
+     */
+    readOnly?: boolean;
+    /**
+     * A function that communicates state changes to the server.
+     */
+    stateMutationFunc: StateMutationFunc;
+    /**
+     * Should be set to true when the experience is loaded from an existing transaction.
+     */
+    isReloadedTransaction?: boolean;
+}
 /**
  * A Workflow experience encapsulates the workflow manager and command context. It
  * provides a simplified interface for interacting with the workflow manager. You
@@ -1898,6 +1931,42 @@ export interface WorkflowExperience {
         [key: string]: string;
     }>;
 }
+export class WorkflowExperienceImpl implements WorkflowExperience {
+    readonly client: SpiffCommerceClient;
+    readonly commandContext: CommandContext;
+    readonly workflowManager: WorkflowManager;
+    readonly isReadOnly: boolean;
+    constructor(client: SpiffCommerceClient, experienceOptions: ExperienceOptions);
+    getClient(): SpiffCommerceClient;
+    getIsReadOnly(): boolean;
+    getCommandContext(): CommandContext;
+    getWorkflowManager(): WorkflowManager;
+    updateVariationRecords(variationRecords: VariationRecord[]): Promise<void>;
+    createPreviewImage(isThreeD?: boolean, resolution?: number): Promise<string>;
+    getStepById(id: string): BulkStepHandle | import("index").IllustrationStepHandle | import("index").MaterialStepHandle | import("index").ModelStepHandle | import("index").PictureStepHandle | import("index").QuestionStepHandle | import("index").ShapeStepHandle | import("index").TextStepHandle | import("index").FrameStepHandle | undefined;
+    getSteps(): StepHandle<_AnyStepData1>[];
+    getScenes(): Scene[];
+    getSelectionPriceSubunits(): number;
+    getBasePriceSubunits(): number;
+    getTotalPriceSubunits(): number;
+    getBulkStep(): BulkStepHandle | undefined;
+    getStepByName(name: string): BulkStepHandle | import("index").IllustrationStepHandle | import("index").MaterialStepHandle | import("index").ModelStepHandle | import("index").PictureStepHandle | import("index").QuestionStepHandle | import("index").ShapeStepHandle | import("index").TextStepHandle | import("index").FrameStepHandle | undefined;
+    getStepsByType(type: _StepType1): StepHandle<_AnyStepData1>[];
+    getStepsByScene(scene: Scene): StepHandle<_AnyStepData1>[];
+    attachCustomerDetails(details: {
+        email: string;
+    }): Promise<void>;
+    assignCustomerDetails(details: CustomerDetailsInput): Promise<void>;
+    attachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
+    detachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
+    debouncedSavedDesignUpdate: import("lodash").DebouncedFunc<() => Promise<void>>;
+    save(title?: string): Promise<SavedDesign>;
+    copy(): Promise<WorkflowExperience>;
+    onDesignFinished(onProgressUpdate?: DesignCreationProgressUpdate): Promise<DesignCreationMessage>;
+    getExportedData(): Map<string, {
+        [key: string]: string;
+    }>;
+}
 export enum FrameStep {
     SelectFrame = "SelectFrame",
     SelectImage = "SelectImage",
@@ -1921,9 +1990,9 @@ export class FrameStepHandle extends StepHandle<_FrameStepData1> {
  * bundles can return a handle for any global properties associated to the collection.
  */
 declare abstract class GlobalPropertyHandle {
-    protected readonly bundle: _Bundle1;
+    protected readonly bundle: Bundle;
     protected readonly property: GlobalPropertyConfigurationAspect;
-    constructor(bundle: _Bundle1, property: GlobalPropertyConfigurationAspect);
+    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
     /**
      * @returns The name of the global property. This is the key used to store the property in the state.
      */
@@ -1963,7 +2032,7 @@ interface GlobalPropertyStateManager {
 /**
  * A bundle serves as a container for a set of workflow experience.
  */
-interface _Bundle1 {
+export interface Bundle {
     /**
      * @returns The client that this bundle is associated with.
      */
@@ -2035,6 +2104,11 @@ interface _Bundle1 {
      * @param experience The workflow experience to remove from this bundle.
      */
     removeWorkflowExperience(experience: WorkflowExperience): Promise<void>;
+    /**
+     * Remove a workflow experience from this bundle by transaction.
+     * @param transaction The transaction to remove from this bundle.
+     */
+    removeWorkflowExperienceByTransaction(transaction: Transaction): Promise<void>;
     /**
      * Returns all workflow experiences currently added to this bundle.
      */
@@ -2075,11 +2149,11 @@ interface _Bundle1 {
      * @param event The event to listen for. Currently only "conditional-global-properties-changed" is supported.
      * @param listener The listener to call when the event occurs.
      */
-    addEventListener(event: BundleEvent, listener: () => void): void;
+    addEventListener(event: BundleEventType, listener: (e: BundleEvent) => void): void;
     /**
      * Remove a previously added event listener from this bundle.
      */
-    removeEventListener(event: BundleEvent, listener: () => void): void;
+    removeEventListener(event: BundleEventType, listener: (e: BundleEvent) => void): void;
     /**
      * Retrieves the current preview service for this bundle, if one exists.
      * If a preview service was specified when calling client.getExistingBundle, this will return that service.
@@ -2100,7 +2174,19 @@ interface _Bundle1 {
      */
     getInitializationPromise(): Promise<void>;
 }
-type BundleEvent = "conditional-global-properties-changed";
+type BundleEventType = "conditional-global-properties-changed" | "workflow-experience-hover-enter" | "workflow-experience-hover-exit";
+type BundleEventData = ConditionalGlobalPropertiesChangedEventData | WorkflowExperienceHoverEventData;
+type BundleEvent = {
+    bundle: Bundle;
+    data: BundleEventData;
+    event: BundleEventType;
+};
+interface ConditionalGlobalPropertiesChangedEventData {
+    globalProperties: GlobalPropertyHandle[];
+}
+interface WorkflowExperienceHoverEventData {
+    workflowExperience: WorkflowExperience;
+}
 interface ExecutionResponse {
     id: string;
     completedAt?: string;
@@ -2265,14 +2351,14 @@ export class SpiffCommerceClient {
      * @param collectionId Optional: The id of the product collection that the bundle can use.
      * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
      */
-    getNewBundle(collectionId?: string): Promise<_Bundle1>;
+    getNewBundle(collectionId?: string): Promise<Bundle>;
     /**
      * Retrieves an existing bundle from the API, by id.
      * @param bundleId The id of the bundle to retrieve.
      * @param previewService Optional: A reference to an existing preview service to use. This can be assigned manually later.
      * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
      */
-    getExistingBundle(bundleId: string, previewService?: any): Promise<_Bundle1>;
+    getExistingBundle(bundleId: string, previewService?: any): Promise<Bundle>;
     /**
      * Retrieves all existing bundle stakeholders from the API, for the currently authenticated customer.
      * @returns An array of bundle stakeholders.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "14.3.1",
+    "version": "14.5.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -87,7 +87,7 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "4.0.4",
+        "@spiffcommerce/papyrus": "4.1.0",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",
         "lodash.clonedeep": "^4.5.0",