@spiffcommerce/core 14.2.7-alpha.0 → 14.2.8-beta.0

package/dist/index.d.mts

@@ -1,7 +1,8 @@
 import * as _spiffcommerce_papyrus from '@spiffcommerce/papyrus';
-import { OptionResource, VariantResource, Step, AnyStepData, FrameOffsets, PatternImageData, Region, StepStorage, CanvasCommand, CommandContext, ILayout, LayoutState, SerializableStep, Workflow, CommandState, GlobalPropertyConfiguration, LayoutsState, Asset, MaterialResource, AssetType, StepType, GlobalPropertyConfigurationAspect, AspectType, Theme, StepAspect, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, LayoutData, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, BulkStepData } from '@spiffcommerce/papyrus';
+import { OptionResource, VariantResource, Step, AnyStepData, FrameOffsets, PatternImageData, Region, SilentStepData, Placeable, StepStorage, CanvasCommand, CommandContext, ILayout, LayoutState, SerializableStep, Workflow, CommandState, GlobalPropertyConfiguration, LayoutsState, Asset, MaterialResource, AssetType, StepType, GlobalPropertyConfigurationAspect, AspectType, Theme, StepAspect, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, LayoutData, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, BulkStepData } from '@spiffcommerce/papyrus';
 export { Animatable, AnyStepData, Asset, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, BulkStepData, CanvasCommand, ColorDefinition, ColorProfileProps, CommandContext, CommandState, CreateElementCommand, CreateLayoutCommand, 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, Theme, UnitOfMeasurement, VariantResource, Workflow, WorkflowPanel, dataUrlFromExternalUrl, determineCorrectFontSizeAndLines, findElement, frameDataCache, generate, generateSVGWithUnknownColors, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getFrameData, getSvgElement, loadFontFromDataUrl, loadFontFromExternalUrl, patternImageDataCache, registerJSDOM, rehydrateSerializedLayout } from '@spiffcommerce/papyrus';
-import { ApolloClient } from '@apollo/client/core';
+import { ApolloClient, FetchResult } from '@apollo/client/core';
+import * as lodash from 'lodash';
 
 declare class OptionService {
     /**
@@ -262,6 +263,8 @@ declare abstract class ModuleProduct {
     abstract svgPrint(text: string, region: Region): string;
 }
 
+interface SilentIllustrationStepData extends SilentStepData, Placeable {
+}
 interface EditedSteps {
     [stepName: string]: boolean;
 }
@@ -322,6 +325,7 @@ type StepSpecificStorageCallback = (selections: StepStorage) => void;
 type StorageCallback = (storage: WorkflowStorage) => void;
 type CurrentVariationRecordCallback = (variationRecord: null | VariationRecord) => void;
 type VariationRecordsCallback = (records: VariationRecord[]) => void;
+type StateMutationFunc = (options?: any) => Promise<FetchResult<any, Record<string, any>, Record<string, any>>>;
 interface WorkflowManager {
     addPoller: (poller: Poller) => void;
     addConfirmCallback: (callback: ConfirmCallback) => void;
@@ -407,7 +411,7 @@ interface WorkflowManager {
      */
     injectIntoPreviewService(previewService: any): Promise<void>;
     /**
-     * Ejects the model of this product from the preview service.
+     * Ejects the model of this product from the preview service. This also sets the internal preview service to undefined.
      */
     ejectFromPreviewService(): void;
 }
@@ -1236,6 +1240,31 @@ interface Scene {
      */
     stepIds: string[];
 }
+/**
+ * State related to a workflow experience.
+ */
+interface ExperienceOptions {
+    product: Product;
+    transaction: Transaction;
+    workflow?: Workflow;
+    previewService?: any;
+    modelContainer?: any;
+    renderableContextService?: any;
+    layouts: ILayout[];
+    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
@@ -1363,6 +1392,50 @@ interface WorkflowExperience {
         [key: string]: string;
     }>;
 }
+declare class WorkflowExperienceImpl implements WorkflowExperience {
+    readonly client: SpiffCommerceClient;
+    readonly commandContext: CommandContext;
+    readonly workflowManager: WorkflowManager;
+    readonly isReadOnly: boolean;
+    private renderableScenes;
+    private renderableSceneCallbacks;
+    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): TextStepHandle | FrameStepHandle | BulkStepHandle | ShapeStepHandle | IllustrationStepHandle | MaterialStepHandle | ModelStepHandle | PictureStepHandle | QuestionStepHandle | undefined;
+    getSteps(): StepHandle<AnyStepData>[];
+    getScenes(): Scene[];
+    getSelectionPriceSubunits(): number;
+    getBasePriceSubunits(): number;
+    getTotalPriceSubunits(): number;
+    getBulkStep(): BulkStepHandle | undefined;
+    getStepByName(name: string): TextStepHandle | FrameStepHandle | BulkStepHandle | ShapeStepHandle | IllustrationStepHandle | MaterialStepHandle | ModelStepHandle | PictureStepHandle | QuestionStepHandle | undefined;
+    getStepsByType(type: StepType): StepHandle<AnyStepData>[];
+    getStepsByScene(scene: Scene): StepHandle<AnyStepData>[];
+    attachCustomerDetails(details: {
+        email: string;
+    }): Promise<void>;
+    assignCustomerDetails(details: CustomerDetailsInput): Promise<void>;
+    attachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
+    detachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
+    debouncedSavedDesignUpdate: lodash.DebouncedFunc<() => Promise<void>>;
+    save(title?: string): Promise<SavedDesign>;
+    copy(): Promise<WorkflowExperience>;
+    onDesignFinished(onProgressUpdate?: DesignCreationProgressUpdate): Promise<DesignCreationMessage>;
+    /**
+     * @param step The step to test against.
+     * @returns Returns true when a valid handle is implemented for a given step type. Certain steps don't support handles, such as silent illustrations.
+     */
+    private stepHasHandle;
+    private getCanvasObjectURLAsync;
+    getExportedData(): Map<string, {
+        [key: string]: string;
+    }>;
+}
 
 /**
  * A GlobalPropertyHandle acts as an interface to global properties on our platform. Currently
@@ -1530,6 +1603,25 @@ interface Bundle {
      * Remove a previously added event listener from this bundle.
      */
     removeEventListener(event: BundleEvent, listener: () => 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.
+     * Call `setPreviewService` to update the preview service for this bundle.
+     */
+    getPreviewService(): any | undefined;
+    /**
+     * Set the preview service for this bundle. This will update the preview service for all workflow experiences in this bundle, and will
+     * also automatically inject the preview service into any new workflow experiences that are added to this bundle.
+     * If this method is called with no arguments or undefined, the preview service will be removed from this bundle.
+     * @param previewService The preview service to use for this bundle.
+     * @returns A promise that resolves when the preview service has been updated for all workflow experiences in this bundle.
+     */
+    setPreviewService(previewService?: any): Promise<void>;
+    /**
+     * Returns a promise that resolves when the bundle has been initialized.
+     * This will resolve immediately if the bundle has no experiences, or if the bundle has already been initialized.
+     */
+    getInitializationPromise(): Promise<void>;
 }
 type BundleEvent = "conditional-global-properties-changed";
 
@@ -1711,9 +1803,11 @@ declare class SpiffCommerceClient {
     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, previewServiceConstructor?: (workflow: Workflow, transactionId: string) => any): Promise<Bundle>;
+    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.
@@ -2357,4 +2451,4 @@ interface StepAspectValue {
 declare const stepAspectValuesToDesignInputSteps: (stepAspectValues: StepAspectValue[], workflow: Workflow) => DesignInputStep[];
 declare const generateStateFromDesignInputSteps: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<LayoutsState>;
 
-export { AssetNotFoundError, BulkPriceCalculationStrategy, BulkStepHandle, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FrameService, FrameStep, FrameStepHandle, GetWorkflowOptions, IllustrationStepHandle, InformationMessageType, InformationResult, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, ProductCameraRig, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SpiffCommerceClient, Stakeholder, StakeholderType, StepElements, StepHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, UnhandledBehaviorError, Variant, VariationRecord, WorkflowExperience, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, gatherVaryingStepAspects, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };
+export { AssetNotFoundError, BulkPriceCalculationStrategy, BulkStepHandle, Bundle, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FrameService, FrameStep, FrameStepHandle, GetWorkflowOptions, IllustrationStepHandle, InformationMessageType, InformationResult, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, UnhandledBehaviorError, Variant, VariationRecord, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, gatherVaryingStepAspects, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };