@spiffcommerce/core 21.9.1 → 21.10.0-alpha.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _spiffcommerce_papyrus from '@spiffcommerce/papyrus';
-import { OptionResource, VariantResource, Step, AnyStepData, FrameOffsets, PatternImageData, Region, Workflow, ILayout, LayoutsState, LayoutData, SilentStepData, Placeable, StepStorage, CanvasCommand, CommandContext, LayoutState, SerializableStep, CommandState, GlobalPropertyConfiguration, AspectType, Asset, MaterialResource, AssetType, StepType, GlobalPropertyConfigurationAspect, Theme, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, InformationStepData } from '@spiffcommerce/papyrus';
+import { OptionResource, VariantResource, Step, AnyStepData, FrameOffsets, PatternImageData, Region, Workflow, ILayout, LayoutsState, LayoutData, Asset, MaterialResource, AssetType, StepType, AspectType, CommandState, CommandContext, GlobalPropertyConfigurationAspect, GlobalPropertyConfiguration, Theme, SilentStepData, Placeable, StepStorage, CanvasCommand, LayoutState, SerializableStep, FrameStepData, CreateElementCommand, FrameElement, IllustrationStepData, IllustrationElement, ColorDefinition, MaterialStepData, ModelStepData, TextStepData, TextboxElement, TextFillImage, FontData, GroupCommand, PictureStepData, QuestionStepData, ShapeStepData, ModuleStepData, DigitalContentStepData, FrameData as FrameData$1, InformationStepData } from '@spiffcommerce/papyrus';
 export { Animatable, AnyStepData, AspectType, Asset, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, CanvasCommand, ColorDefinition, ColorProfileProps, CommandContext, CommandState, CreateElementCommand, CreateLayoutCommand, DeleteElementCommand, DigitalContentStepData, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameStepData, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, ImageElement, InformationStepData, 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, loadFont, patternImageDataCache, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, setCanvasModule } from '@spiffcommerce/papyrus';
 import { ApolloClient, MutationOptions, FetchResult } from '@apollo/client/core';
 import { RenderableContextService, RenderableContext, ThreeDPreviewService, ModelContainer } from '@spiffcommerce/preview';
@@ -344,2351 +344,2362 @@ interface StepAspectValue {
 declare const stepAspectValuesToDesignInputSteps: (stepAspectValues: StepAspectValue[], workflow: Workflow) => DesignInputStep[];
 declare const generateStateFromDesignInputSteps: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<LayoutsState>;
 
-interface SilentIllustrationStepData extends SilentStepData, Placeable {
-}
-interface EditedSteps {
-    [stepName: string]: boolean;
-}
-interface MandatorySteps {
-    [stepName: string]: boolean;
-}
-type StepElements = {
-    [key: string]: RegionElement[];
-};
-type StepInitialised = {
-    [key: string]: boolean;
-};
-type StepMetadata = FrameMetadata | IllustrationMetadata | ModuleMetadata | TextMetadata;
-interface WorkflowStorage {
-    [stepName: string]: StepStorage;
-}
-interface WorkflowMetadata {
-    [stepName: string]: StepMetadata;
-}
-interface WorkflowSelections {
-    [stepName: string]: {
-        selections: VariantResource[];
-    };
-}
-interface InformationResult {
-    message: string;
-    messageType: InformationMessageType;
-    stepID: string;
-}
-declare enum InformationMessageType {
-    Error = "Error",
-    Warning = "Warning",
-    Info = "Info"
-}
 /**
- * Services required for the operaiton of individual steps.
+ * An asset manager provides a way to create and
+ * manage assets on the Spiff Commerce Platform.
  */
-interface StepSpecificServices {
-    frameService?: FrameService;
-    module?: ModuleProduct;
-}
-type DesignCreationProgressUpdate = (message: string) => void;
-type ConfirmCallback = (isConfirmed: boolean) => void;
-type EditedCallback = (editedSteps: EditedSteps) => void;
-type ElementsCallback = (elements: StepElements) => void;
-type InformationResultCallback = (messages: InformationResult[]) => void;
-type InitCallback = (stepInitialised: StepInitialised) => void;
-type MakingAdjustmentsCallback = (makingAdjustments: string) => void;
-type MandatoryCallback = (mandatorySteps: MandatorySteps) => void;
-type MetadataCallback = (metadata: WorkflowMetadata) => void;
-type SelectionCallback = (callbackOptions: {
-    selectionCost: number;
-    selections: StepSelections;
-    traversableScenes: WorkflowScene[];
-}) => void;
-type StepSpecificStorageCallback = (selections: StepStorage) => void;
-type StorageCallback = (storage: WorkflowStorage) => void;
-type StateMutationFunc = (options?: Omit<MutationOptions, "mutation">) => Promise<FetchResult<any, Record<string, any>, Record<string, any>>>;
-interface WorkflowManager {
-    addPoller: (poller: Poller) => void;
-    addConfirmCallback: (callback: ConfirmCallback) => void;
-    addEditedCallback: (callback: EditedCallback) => void;
-    addElementsCallback: (callback: ElementsCallback) => void;
-    addInformationResultCallback: (callback: InformationResultCallback) => void;
-    addInitCallback: (callback: InitCallback) => void;
-    addMakingAdjustmentsCallback: (callback: MakingAdjustmentsCallback) => void;
-    addMandatoryCallback: (callback: MandatoryCallback) => void;
-    addMetadataCallback: (callback: MetadataCallback) => void;
-    addSelectionCallback: (callback: SelectionCallback) => void;
-    addStepSpecificStorageCallback: (callback: StepSpecificStorageCallback, stepName: string) => void;
-    addStorageCallback: (callback: StorageCallback) => void;
-    getCommandDispatcher: () => (command: CanvasCommand) => void;
-    getCommandContext: () => CommandContext;
-    getLayouts: () => ILayout[];
-    getAllLayoutData: () => LayoutState[];
-    getLayoutPreviewService: () => LayoutPreviewService | undefined;
-    getPreviewService: () => ThreeDPreviewService | undefined;
-    getProfanities: () => string[];
-    getRegionElements: (stepName: string) => RegionElement[];
-    getSerializedStep: (stepName: string, serializedSteps: SerializableStep[]) => SerializableStep | undefined;
-    getStepSpecificServices: (stepName: string) => StepSpecificServices | undefined;
-    getStepStorage: (stepName: string) => StepStorage | undefined;
-    getMetadata: (stepName: string) => StepMetadata | undefined;
-    getWorkflowMetadata: () => WorkflowMetadata;
-    getInformationResults(): InformationResult[];
-    getTransaction: () => Transaction;
-    getTransactionCustomer: () => Customer | undefined;
-    setTransactionCustomer: (customer: Customer) => void;
-    /**
-     * @deprecated Use setTransactionCustomer instead.
-     */
-    setTransactionCustomerDetails: (details: {
-        email: string;
-    }) => void;
-    getWorkflow: () => Workflow;
-    getWorkflowSelections: () => WorkflowSelections;
-    getProduct: () => Product;
+interface AssetManager {
     /**
-     * A promise resolving when the initial state of the workflow has completed loading.
+     * Uploads a file to the Spiff Commerce Platform.
      */
-    getInitializationPromise: () => Promise<void>;
+    uploadFile: (file: File, onProgress: (val: number) => void) => Promise<Asset>;
     /**
-     * Returns true when the initial state of the workflow has been loaded and settled.
+     * From an existing asset, generates a new asset that has the background replaced with transparency.
+     * This process is idempotent, i.e. it will only run once for a given asset.
+     * @param asset The existing asset to remove the background from.
+     * @returns A promise that resolves with a new asset.
      */
-    isInitialized(): boolean;
-    markStepsAsInitialised: (stepNames: string[]) => void;
-    getUpdatesPending: () => boolean;
-    markUpdateCompleted: (id: string) => void;
-    markUpdatePending: () => string;
-    outstandingRequestsPromise: () => Promise<void>;
-    reset: () => Promise<void>;
-    setCurrentAdjustingStepId: (stepId: string) => void;
-    setEditedStatus: (stepName: string, status: boolean) => void;
-    setInformationResults: (results: InformationResult[]) => void;
-    setMandatoryFulfilled: (stepName: string, status: boolean) => void;
-    setSelectionsAndElements: (stepName: string, variants: VariantResource[], elements: RegionElement[], callback?: () => Promise<void>) => Promise<void>;
-    toggleDesignConfirmed: () => void;
-    updateMetadata: (stepName: string, update: any) => void;
+    removeBackgroundFromAsset(asset: Asset): Promise<Asset>;
+}
+declare class AssetService implements AssetManager {
+    private cache;
+    private bgrmCache;
+    private materialCache;
     /**
-     * @deprecated State updates are being pulled internally. This function will be removed in the future.
+     * Allows for retrieving an asset, returns the option from a cache if possible.
      */
-    updateStateWithServerImmediate: (getReducerState: () => CommandState) => Promise<void>;
-    updateStorage: (stepName: string, update: StepStorage) => void;
-    getModelContainer: () => ModelContainer | undefined;
-    setModelContainer: (container: ModelContainer) => void;
+    getLocalOrFromServer(assetKey: string): Promise<Asset>;
     /**
-     * Injects the model of this product into the preview service.
-     * This also overwrites the internal preview service.
-     * @param previewService The preview service to inject into.
-     * @param refocusCamera Optional: Run camera focus Defaults to `true`.
+     * Caches an asset if it doesn't already exist.
      */
-    injectIntoPreviewService(previewService: ThreeDPreviewService, refocusCamera?: boolean): Promise<void>;
+    cacheAsset(asset: Asset): void;
     /**
-     * Ejects the model of this product from the preview service. This also sets the internal preview service to undefined.
+     * Caches a material if it doesn't already exist.
      */
-    ejectFromPreviewService(): void;
+    cacheMaterial(material: MaterialResource): void;
     /**
-     * Enables or disables uploading of workflow state to the server.
-     * @param enabled When true, workflow state will be uploaded to the server.
+     * Allows for retrieving a material, returns the option from a cache if possible.
+     * @param id The option ID to be retrieved.
      */
-    setWorkflowStateSyncEnabled: (enabled: boolean) => void;
-}
-
-interface StepService<T extends AnyStepData> {
+    getMaterialLocalOrFromServer(id: string): Promise<MaterialResource>;
     /**
-     * Initialize the given step, or reload from serialized data if present.
+     * Upload a user asset to the server. Using callbacks to notify important events.
+     * The asset will be stored via the persistence service for future access, if available.
      */
-    init(stepData: Step<T>, workflowManager: WorkflowManager, reducerState?: LayoutsState): Promise<any>;
-}
-interface FileInfo {
+    uploadAssetWithProgress(file: FileInfo, assetType: AssetType, onProgress: (val: number) => void, anonymous?: boolean, temporary?: boolean): Promise<Asset>;
+    uploadAsset(file: FileInfo, assetType: AssetType, anonymous?: boolean, temporary?: boolean): Promise<Asset>;
+    uploadFile(file: File, onProgress: (val: number) => void): Promise<Asset>;
+    removeBackgroundFromAsset(asset: Asset): Promise<Asset>;
+    removePersistedAsset(assetKey: string): void;
+    getPersistedAssets(): PersistedAsset[];
     /**
-     * The name of the file.
+     * Convert a File object for an image into a FileInfo.
      */
-    name: string;
+    loadImageAsFileInfo: (file: File) => Promise<FileInfo>;
     /**
-     * A blob object representing the
-     * data of the file.
+     * Handles mimeType resolution & asset creation request
+     * @param file A file info object containing data about the file and its name
+     * @param assetType The type of asset we're expecting to upload
      */
-    blob: Blob;
-}
-/**
- * A command along with a function to run afterwards.
- */
-interface CommandWithFollowup {
-    command?: CanvasCommand;
-    followup?: () => Promise<void>;
-}
-/**
- * The variant selections of a completed step.
- */
-interface SelectedVariants {
-    [stepName: string]: {
-        id: string;
-        name: string;
-        priceModifier: number;
-    }[];
-}
-interface ExportedData {
-    [name: string]: {
-        value: string;
-        priceModifier: number;
-    };
-}
-interface DesignCreationMessage {
-    additionalExternalProductId?: string;
-    additionalExternalVariantId?: string;
-    baseCost?: number;
-    designProductId?: string;
-    designProductVariantId?: string;
-    event: string;
-    exportedData: ExportedData;
-    externalCartProductId?: string;
-    externalCartProductVariantId?: string;
-    lineItemImageUrl: string;
-    metadata?: {
-        [stepName: string]: string;
-    };
-    optionsCost: number;
-    processExecutionId?: string;
-    quantity?: number;
-    selectedVariants?: SelectedVariants;
-    sku?: string;
-    transactionId: string;
-    transactionOwnerId?: string;
-    weight?: number;
-    workflowViewerLink: string;
-    workflowViewerReadOnlyLink: string;
+    private dispatchCreateAssetRequest;
+    private guessMIME;
 }
-interface BundleDesignCreationMessage {
-    bundleId: string;
-    items: DesignCreationMessage[];
+interface PersistedAsset {
+    assetKey: string;
+    src: string;
 }
+declare const assetService: AssetService;
+
 /**
- * Represents a transaction.
+ * A wrapping component that provides a simple interface for interacting with a variant.
  */
-interface Transaction {
+declare class Variant {
+    private readonly variantData;
+    constructor(variant: VariantResource);
+    getType(): AssetType | undefined;
     /**
-     * A unique identifier for this transaction. Useful for reloading and
-     * modifying state of the transaction.
+     * @returns The unique identifier for the variant.
      */
-    id: string;
+    getId(): string;
     /**
-     * User-supplied name for the associated design.
+     * @returns The configured name of the variant. Generally a human readable value.
      */
-    designName?: string;
+    getName(): string;
     /**
-     * The workflow associated with this transaction.
+     * @returns The price modifier for this variant. This is the amount that will be added to the base price of the product.
      */
-    workflowId?: string;
+    getPriceFormatted(locales?: Intl.LocalesArgument, options?: Intl.NumberFormatOptions | undefined): string;
     /**
-     * Temporary ID that grants write permission to the transaction.
-     */
-    transactionOwnerId?: string;
-    /**
-     * The current state of the design.
+     * @returns The price modifier for this variant. This is the amount that will be added to the base price of the product.
+     *          Presented in subunits of the currency of the option. For example, if the option is configured to use USD, the price modifier will be in cents.
      */
-    workflowState?: string;
+    getPrice(): number;
     /**
-     * URL to a partner-specific logo intended to display during the workflow experience.
+     * @returns The URL for the base asset resource configured on this variant
      */
-    customLogoLink?: string;
+    getAsset(): string | undefined;
     /**
-     * URL to a logo intended to display at the periphery of the workflow experience.
+     * @returns The URL for the base asset resource configured on this variant
      */
-    workflowFooterLogoLink?: string;
+    getAssetResource(): Asset | undefined;
     /**
-     * URL to the corresponding integration in the REST API.
+     * @returns The URL for a thumbnail resource configured on this variant.
      */
-    restApiIntegrationLink?: string;
+    getThumbnail(): string | undefined;
     /**
-     * URL to redirect to when a workflow is finished.
+     * @returns The URL for the display image configured on this variant. Can be used for things like size charts.
+     * @deprecated To be removed in a future version, Please use getThumbnail() instead
      */
-    callbackUrl?: string;
+    getDisplayImage(): string | undefined;
     /**
-     * Product that this transaction belongs to.
+     * @returns When this variant is configured to have a color, this will return the hex value for that color.
      */
-    product?: Product;
+    getColor(): string | undefined;
     /**
-     * The integration product related to this lineitem.
+     * @returns True when the variant is the default for its containing option. False otherwise.
      */
-    integrationProduct?: IntegrationProductResource;
+    isDefault(): boolean;
     /**
-     * Whether this transaction has previously been ordered.
+     * @returns The underlying variant resource. Generally not needed but made available just incase.
      */
-    isOrdered?: boolean;
+    getResource(): VariantResource;
     /**
-     * @deprecated use isOrdered to check whether transaction has been ordered instead.
+     * @returns True when the variant is enabled. False otherwise.
      */
-    lineItem?: LineItem;
+    isEnabled(): boolean;
+}
+
+/**
+ * A StepHandle allows for managing the state of a specific step in a workflow. This class
+ * abstracts away the complexities of dealing with a step directly and allows for using high level
+ * concepts instead of dealing with the underlying data structures.
+ */
+declare abstract class StepHandle<T extends AnyStepData> {
     /**
-     * The external product variant ID representing the design product related
-     * to this transaction, null unless the createDesignProduct flag was set
-     * and the design was finalized using createDesign operation.
+     * Stores whether or not the step is currently updating.
      */
-    /**@deprecated use externalCartProductVariantId instead of this moving forward */
-    externalDesignProductVariantId?: string;
+    private static readonly updateState;
     /**
-     * The external product id representing the design product related
-     * to this transaction, null unless the createDesignProduct flag was set
-     * and the design was finalized using createDesign operation.
+     * Access to the workflow manager this step is contained by.
      */
-    /**@deprecated use externalCartProductId instead of this moving forward. */
-    externalDesignProductId?: string;
+    protected readonly manager: WorkflowManager;
     /**
-     * The external product id representing the product related to the transaction.
-     * This value can hold any type of transaction such as design and standard products.
+     * The step metadata, useful for determining logic based on configuration.
      */
-    externalCartProductId?: string;
+    protected readonly step: Step<T>;
+    constructor(manager: WorkflowManager, step: Step<T>);
     /**
-     * The external product variant id representing the product related to the transaction.
-     * This value can hold any type of transaction such as design and standard products.
+     * Set the current update state of this step. All step handles pointing to this step will
+     * see this value.
+     * @param value The new value
      */
-    externalCartProductVariantId?: string;
-    priceModifierTotal?: number;
+    protected setUpdateState(value: boolean): void;
     /**
-     * URL to open the transaction in the workflow viewer.
+     * @returns Gets the current update state of this step. All step handles for this step will see this value.
      */
-    workflowViewerLink?: string;
-    workflowViewerReadOnlyLink?: string;
-    previewImageLink?: string;
-    lastSyncedAt?: string;
+    protected getUpdateState(): boolean;
     /**
-     * The users who have access to this transaction.
+     * Gets the currently selected variant, or undefined if no variant is selected.
      */
-    stakeholders?: Stakeholder[];
+    getCurrentVariant(): Variant | undefined;
     /**
-     * The amount of this transaction that was, or will be, ordered
+     * @returns A list of valid variants for this step. Does not include disabled variants.
      */
-    quantity?: number;
-    printFileUrl1?: string;
-    printFileUrl2?: string;
-    printFileUrl3?: string;
-    printFileUrl4?: string;
-    printFileUrl5?: string;
-}
-/**
- * An integration product represents the connection of a product in SpiffCommerce with
- * a product on a third party platform.
- */
-interface IntegrationProductResource {
+    getAvailableVariants(): Variant[];
     /**
-     * The ID of the IntegrationProduct entity. Used internally by SpiffCommerce.
+     * @returns A list of all variants for this step, including disabled ones.
      */
-    id: string;
+    getAllVariants(): Variant[];
     /**
-     * The ID of the product on the third party platform. For example a Shopify product ID.
+     * Most step types have a base option type that variants can be selected for.
+     * Selects a specific variant for this step. This will execute all required changes to
+     * the design and update the metadata to include the new selection. Any conditions
+     * that would be triggered will also be executed.
      */
-    externalProductId?: string;
+    abstract selectVariant(variant: Variant): Promise<void>;
     /**
-     * The integration that this product is associated with. For example a Shopify integration.
+     * @returns A unique identifier for this step within the workflow.
      */
-    integration?: Integration;
+    getId(): string;
     /**
-     * The ID of an additional product (on the third party platform) that should be added to the cart.
+     * @returns The name of the step
      */
-    additionalExternalProductId?: string;
+    getName(): string;
     /**
-     * A supplementary ID for the additional product. Shopify uses the variant ids to add products to the cart.
+     * @returns A message that can accompany the step name in UI components. Used to describe the purpose of the step in more detail.
      */
-    additionalExternalVariantId?: string;
+    getHelpText(): string | undefined;
     /**
-     * When the additionalExternalProductId is set, this is the IntegrationProduct that is associated with it.
-     * If no Spiff product has been associated with the additionalExternalProductId, this will be null.
+     * @returns The type of the step handle.
      */
-    additionalIntegrationProduct?: IntegrationProductResource;
+    getType(): StepType;
     /**
-     * The product that this integration product is associated with.
+     * @returns The underlying data for this step. Favor using the step handle methods instead of this.
      */
-    product?: Product;
-}
-interface Integration {
-    id: string;
-    enabled: boolean;
-    externalIntegrationId?: string;
-    type?: IntegrationType;
-    isCurrent?: boolean;
-}
-declare enum IntegrationType {
-    Hub = "Hub",
-    Shopify = "Shopify"
-}
-/**
- * Fields found in a variant within a line item resource.
- */
-interface LineItemVariant {
-    currencyCode: string;
-    optionName: string;
-    priceModifier: number;
-    stepName: string;
-    variantName: string;
-}
-interface LineItem {
-    id: string;
-    transactionId?: string;
-    previewImageUrl?: string;
-    product: Product;
-    quantity: number;
-    metadata?: LineItemMetadata[];
-    variants: LineItemVariant[];
-}
-interface LineItemMetadata {
-    stepName: string;
-    metadata: string;
-}
-interface ProductWorkflow$1 {
-    friendlyName: string;
-    id: string;
-    index?: number;
-    present?: boolean;
-    imageUrl: string;
-    workflowName: string;
-}
-interface Partner {
-    id?: string;
-    name?: string;
-    currencyCode?: string;
-    customerDetailsPromptMarkdown?: string;
-}
-interface Product {
+    getRaw(): Step<T>;
+    getTags(): string[];
+    hasTag(tag: string): boolean;
     /**
-     * ID of the partner owner.
+     * @param type The AspectType to fetch the value for.
+     * @returns A boolean indicating whether this step should override Global Properties.
+     * Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties,
+     * and when this step is associated with one or more Global Property Aspects.
      */
-    partnerId?: string;
-    partner?: Partner;
+    getOverrideGlobalPropertyConfiguration(type: AspectType): boolean;
     /**
-     * Whether a line item for this product is delivered as soon as the order is received.
+     * Sets whether or not this step should override Global Properties.
+     * Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties,
+     * and when this step is associated with one or more Global Property Aspects.
+     * @param type The AspectType to override.
      */
-    autoprint: boolean;
+    setOverrideGlobalPropertyConfiguration(type: AspectType, value: boolean): void;
     /**
-     * Whether this product can be quickprinted.
+     * Retrieves the identifiers of all of the configured aspects for the specified Global Property Configuration.
+     * @param configurationId The ID of the Global Property Configuration. You can usually find this with `bundle.getGlobalPropertyConfiguration()?.id`
+     * @returns An array of strings matching the keys of all the Global Property Aspects in the Configuration that this step is configured to use.
      */
-    canQuickprint?: boolean;
+    getGlobalPropertyAspects(configurationId: string): string[];
     /**
-     * The internal identifier for this product.
+     * Fires any configured animations on the 3D preview for this step.
+     * This includes camera & model animations. If the preview is unavailable
+     * this function will do nothing.
      */
-    id: string;
+    executeAnimations(): void;
+}
+
+declare const createDesign: (workflowManager: WorkflowManager, workflow: Workflow, layouts: ILayout[], getReducerState: () => CommandState, product: Product, transaction: Transaction, workflowSelections: WorkflowSelections, designName: string, onProgressUpdate: DesignCreationProgressUpdate, createPreviewImage: (shouldRender3D?: boolean, transactionId?: string) => Promise<string | undefined>, workflowMetadata?: WorkflowMetadata) => Promise<DesignCreationMessage>;
+interface SavedDesign {
     /**
-     * The human friendly name of the product.
+     * The user's name for this saved design.
      */
-    name: string;
+    title: string;
     /**
-     * A URL to the image asset associated with this product.
+     * A URL pointing to an image of the design. Typically a data URL
      */
-    imageUrl?: string;
+    thumbnail?: string;
     /**
-     * A resource url for a 3D model used to represent this product
-     * in the 3d editor. If not available we assume the product doesn't support 3D.
+     * The ID of the transaction relating to this design.
      */
-    modelUrl?: string;
+    transactionId: string;
     /**
-     * A URL for the image used as an overlay on any workflows
-     * that incorporate a product overlay step.
+     * The product ID for this transaction.
      */
-    overlayImageUrl?: string;
+    productId: string;
     /**
-     * Words which can't be used in a workflow for this product.
+     * The integration product ID related to this order.
      */
-    profanities?: {
-        id: string;
-        createdAt: string;
-        userId: string;
-        word: string;
-    }[];
+    integrationProductId: string;
     /**
-     * The max characters that can be typed for quickprint.
+     * The name of the workflow annotated at time of save (may be different from current workflow name).
      */
-    quickprintMaxLength?: number;
+    workflowName: string;
     /**
-     * The name of the module to use for quickprint.
+     * The ID of the workflow annotated at time of save.
      */
-    quickprintModuleName?: string;
+    workflowId: string;
     /**
-     * If true, the product should be displayed in the client as if it is available.
-     * Should be displayed as if it is unavailable otherwise.
+     * The last edit that occured on this saved design.
      */
-    enabled: boolean;
+    lastEdited: Date;
+}
+/**
+ * The design service exposes helper functionality wrapping important design management operations.
+ * NOTE: In the future this interface should allow for storing/pulling designs from the server.
+ */
+declare class DesignService {
+    readonly localPersistenceKey = "designTransactions";
+    private storageMethod;
+    private designSavedListeners;
     /**
-     * Workflows which have been assigned to this product.
+     * @param func The function to call when a design is saved.
      */
-    workflows?: ProductWorkflow$1[];
+    attachSaveListener(func: (design: SavedDesign) => void): void;
     /**
-     * The base price of this product in sub units. Essentially the cost of the
-     * product without any customisations applied.
+     * @param func The function to remove from the list of listeners.
      */
-    basePrice?: number;
+    detachSaveListener(func: (design: SavedDesign) => void): void;
     /**
-     * The weight of this product.
+     * Gets the currently persisted designs.
      */
-    weight?: number;
+    getSavedDesigns(): Promise<SavedDesign[]>;
     /**
-     * When specified, represents a pre-rendered image of this product to be
-     * displayed to customers while the 3D preview is loading.
+     * Search for a transaction that has been saved.
+     * @param transactionId The id to search for.
+     * @returns The transaction for the given id provided it has been saved. undefined if it doesn't exist.
      */
-    preloadImageUrl?: string;
+    getSavedDesignByTransaction(transactionId: string): Promise<SavedDesign | undefined>;
     /**
-     * When set the store owner has configured this product to prompt for
-     * customer details. In hosted experience, we'll offer to collect this information from the customer. In
-     * bespoke UIs created using the Core SDK you will need to check this flag and request the data accordingly.
-     * See attachCustomerDetails on the WorkflowExperience for how to supply us with the details you collect.
+     * Saves a design to storage.
+     * @param design The design to save.
      */
-    promptForCustomerDetails?: boolean;
+    addDesign(design: SavedDesign): Promise<void>;
     /**
-     * Configuration for conversion. Optional.
+     * Change the user's name of the given saved design.
      */
-    conversionConfiguration?: ConversionConfiguration;
-    integrationProducts?: IntegrationProductResource[];
-    productTags?: ProductTag[];
+    renameDesign(transactionId: string, title: string): Promise<void>;
     /**
-     * The SKU of the product in the merchant's store.
+     * Removes a given design from storage.
+     * @param transactionId
      */
-    sku?: string;
+    removeDesign(transactionId: string): Promise<void>;
+    private setDesigns;
+}
+declare const designService: DesignService;
+
+/**
+ * A scene is a collection of steps that can be used to group steps together.
+ */
+interface Scene {
     /**
-     * The Spiff SKU code for the product.
+     * The unique identifier for the scene.
      */
-    skuCode?: string;
+    id?: string;
     /**
-     * Price breaks for this product when dealing with quantity.
+     * The name of the scene.
      */
-    priceBreaks?: ProductPriceBreak[];
+    name: string;
+    /**
+     * The steps that are part of the scene. A list of ids. See getStepById.
+     */
+    stepIds: string[];
 }
 /**
- * A price break represents a minimum quantity of a product and the price that will be charged for that quantity.
- * This can be seen as an override for the base price of the product.
+ * State related to a workflow experience.
  */
-interface ProductPriceBreak {
+interface ExperienceOptions {
+    product: Product;
+    transaction: Transaction;
+    workflow?: Workflow;
     /**
-     * The id of this price break.
+     * @deprecated favor inject / eject functions.
      */
-    id: string;
+    previewService?: ThreeDPreviewService;
+    modelContainer?: ModelContainer;
+    renderableContextService?: LayoutPreviewService;
+    layouts: ILayout[];
+    reloadedState?: LayoutsState;
     /**
-     * The minimum quantity of this price break. A positive integer.
+     * When true the experience is intended to be immutable.
      */
-    minQty: number;
+    readOnly?: boolean;
     /**
-     * A percentage to apply to the overall price. A value between 0-1 where 1 retains 100% of the original price and 0 completely discounts it to free.
+     * A function that communicates state changes to the server.
      */
-    percentage: number;
-}
-interface ProductTag {
-    id: string;
-    name: string;
-}
-interface ColorOption {
-    id?: string;
-    fill?: string;
-    stroke?: string;
-    variant?: VariantResource;
-    colorProfileAssetKey?: string;
-}
-interface RegionElement {
-    id: string;
-    region?: Region;
-}
-interface FrameMetadata {
-    image: string;
-}
-interface IllustrationMetadata {
-    colors: string[];
-}
-interface ModuleMetadata {
-    text: string;
-}
-interface TextMetadata {
-    color?: string;
-    text: string;
-    fillImage?: string;
-}
-interface SelectionStorage {
-    selectedVariants?: VariantResource[];
-}
-interface TextStepStorage extends SelectionStorage {
-    color?: string;
-    defaultCleared?: boolean;
-    inputText?: string;
-    text?: string;
-    customiseAllText?: boolean;
-}
-type StepSelections = {
-    [key: string]: SelectionStorage;
-};
-interface FrameData {
+    stateMutationFunc: StateMutationFunc;
     /**
-     * The path data for a frame SVG
+     * Should be set to true when the experience is loaded from an existing transaction.
+     * FIXME: Wouldn't we know this from existance of reloadedState
      */
-    path: string;
+    isReloadedTransaction?: boolean;
     /**
-     *  The viewbox width
+     * When true the system will treat steps with
+     * a single variant as renderable. False
+     * by default.
      */
-    width: number;
+    singleVariantsRenderable?: boolean;
     /**
-     * The viewbox height.
+     * When true, will delay syncing the workflow state until manually enabled.
      */
-    height: number;
-}
-interface FrameThresholdSettings {
-    useThreshold: boolean;
-    invertThreshold: boolean;
-    threshold: number;
-    thresholdSaturation: number;
-}
-/**
- * Defines the different behaviors supported by the camera system
- * for control when viewing a product.
- */
-declare enum ProductCameraRig {
-    Orbit = 0,
-    Pan = 1
+    delayWorkflowStateSync?: boolean;
 }
 /**
- * Defines the locations at which a conversion attempt can take place.
+ * A Workflow experience encapsulates the workflow manager and command context. It
+ * provides a simplified interface for interacting with the workflow manager. You
+ * should get an instance of this class from a Client you have constructed previously.
  */
-declare enum ConversionLocation {
+interface WorkflowExperience {
     /**
-     * The client should expose a flow for allowing the user to optionally input details at any point.
+     * Get the bundle this experience is part of. May be undefined.
      */
-    Manual = "Manual",
+    getBundle(): Bundle$1 | undefined;
     /**
-     *  The client should show the conversion flow at the beginning of a workflow.
+     * Set the bundle this experience is part of. Can be cleared using undefined.
      */
-    OnStart = "OnStart",
+    setBundle(bundle: Bundle$1 | undefined): any;
     /**
-     * The client should allow the user to input details just before quitting the experience.
+     * Returns the client that was responsible for spawning this experience.
      */
-    OnQuit = "OnQuit",
+    getClient(): SpiffCommerceClient;
     /**
-     * The client should ask the user for details prior to adding to cart.
+     * State related to the design of the user.
      */
-    OnEnd = "OnEnd"
-}
-/**
- * The data configured to be requested.
- */
-declare enum ConversionDataType {
-    Email = "Email",
-    FirstName = "FirstName",
-    LastName = "LastName",
-    Phone = "Phone"
-}
-interface ConversionData {
-    type: ConversionDataType;
-    mandatory: boolean;
-}
-/**
- * The configuration for conversion, exposed on products currently.
- */
-interface ConversionConfiguration {
-    id: string;
-    name?: string;
-    locations: ConversionLocation[];
-    requestedData: ConversionDataType[];
-    requestedDataItems: ConversionData[];
-    mandatory?: boolean;
-}
-/**
- * Someone who has used a workflow experience and entered their contact details.
- */
-interface Customer {
-    id?: string;
-    emailAddress: string;
-    firstName?: string;
-    lastName?: string;
-    phoneNumber?: string;
-    loginToken?: string;
-    partner?: Partner;
-    stakeholders?: Stakeholder[];
-    bundleStakeholders?: BundleStakeholder[];
-}
-interface CustomerDetailsInput {
-    emailAddress: string;
-    firstName?: string;
-    lastName?: string;
-    phoneNumber?: string;
-}
-declare enum StakeholderType {
-    Owner = "Owner",
-    Approver = "Approver",
-    Editor = "Editor",
-    Viewer = "Viewer"
-}
-interface Stakeholder {
-    id: string;
-    type?: StakeholderType;
-    transaction?: Transaction;
-    customer?: Customer;
-}
-interface Bundle$1 {
-    id?: string;
-    bundleOwnerId?: string;
-    bundleStakeholders?: BundleStakeholder[];
-    bundleStateData?: string;
-    metadata?: {
-        key: string;
-        value: string;
-    }[];
-    name?: string;
-    partner?: Partner;
-    productCollection?: ProductCollectionResource;
-    transactions?: Transaction[];
-}
-interface BundleStakeholder {
-    id: string;
-    bundle?: Bundle$1;
-    customer?: Customer;
-    type?: StakeholderType;
-}
-interface BundleStakeholderInput {
-    type: StakeholderType;
-    customerDetails: CustomerDetailsInput;
-}
-type ProductCollectionResource = {
-    id: string;
-    globalPropertyConfiguration?: GlobalPropertyConfiguration;
-    productCollectionProducts?: ProductCollectionProductResource[];
-    name: string;
-    transformCollection?: TransformCollection$1;
-};
-type ProductCollectionProductResource = {
-    id: string;
-    productCollection?: ProductCollectionResource;
-    productCollectionId?: string;
-    product: Product;
-    productId: string;
-    workflowId?: string;
-};
-type GlobalPropertyState = {
-    id: string;
-    aspects: GlobalPropertyStateAspect[];
-};
-type GlobalPropertyStateAspect = {
-    name: string;
-    value: string;
-    type?: AspectType;
-    storage?: GlobalPropertyStateAspectStorage;
-};
-type GlobalPropertyStateAspectStorage = GlobalPropertyStateFileUploadStorage;
-type GlobalPropertyStateFileUploadStorage = {
-    originalAssetKey?: string;
-    backgroundRemovedAssetKey?: string;
-    useOriginalAsset?: boolean;
-};
-interface BundleStateTransform {
-    position: Vector3;
-    rotation: Vector3;
-    scale: Vector3;
-}
-interface Vector3 {
-    x: number;
-    y: number;
-    z: number;
-}
-interface TransformCollection$1 {
-    id: string;
-    name: string;
-    transforms: TransformCollectionTransform[];
-}
-interface TransformCollectionTransform {
-    id: string;
-    name: string;
-    position: Vector3;
-    rotation: Vector3;
-    scale: Vector3;
-}
-type Extendable<T> = T & {
-    [key: string]: any;
-};
-
-/**
- * An asset manager provides a way to create and
- * manage assets on the Spiff Commerce Platform.
- */
-interface AssetManager {
+    getCommandContext(): CommandContext;
     /**
-     * Uploads a file to the Spiff Commerce Platform.
+     * Returns true when the user may only view the design.
      */
-    uploadFile: (file: File, onProgress: (val: number) => void) => Promise<Asset>;
+    getIsReadOnly(): boolean;
     /**
-     * From an existing asset, generates a new asset that has the background replaced with transparency.
-     * This process is idempotent, i.e. it will only run once for a given asset.
-     * @param asset The existing asset to remove the background from.
-     * @returns A promise that resolves with a new asset.
+     * Get the low level workflow amanager instance for this experience. Don't touch this unless you're willing to break things.
      */
-    removeBackgroundFromAsset(asset: Asset): Promise<Asset>;
-}
-declare class AssetService implements AssetManager {
-    private cache;
-    private bgrmCache;
-    private materialCache;
+    getWorkflowManager(): WorkflowManager;
     /**
-     * Allows for retrieving an asset, returns the option from a cache if possible.
+     * Returns the step matching a given name, undefined if not found.
+     * @param id The id the step must match.
      */
-    getLocalOrFromServer(assetKey: string): Promise<Asset>;
+    getStepById(id: string): StepHandle<AnyStepData> | undefined;
     /**
-     * Caches an asset if it doesn't already exist.
+     * Returns the step matching a given name, undefined if not found.
+     * @param name The name the step must match.
      */
-    cacheAsset(asset: Asset): void;
+    getStepByName(name: string): StepHandle<AnyStepData> | undefined;
     /**
-     * Caches a material if it doesn't already exist.
+     * Returns all steps matching a specific type in the workflow. These steps
+     * may be across multiple scenes and may or may not be active based on condition state.
      */
-    cacheMaterial(material: MaterialResource): void;
+    getStepsByType(type: StepType): StepHandle<AnyStepData>[];
     /**
-     * Allows for retrieving a material, returns the option from a cache if possible.
-     * @param id The option ID to be retrieved.
+     * Returns all steps that are children of a given scene.
+     * @param scene The scene you want the steps for.
      */
-    getMaterialLocalOrFromServer(id: string): Promise<MaterialResource>;
+    getStepsByScene(scene: Scene): StepHandle<AnyStepData>[];
     /**
-     * Upload a user asset to the server. Using callbacks to notify important events.
-     * The asset will be stored via the persistence service for future access, if available.
+     * Returns all steps in the workflow that are currently active. Ordered by scene and appearance within their respective scenes.
      */
-    uploadAssetWithProgress(file: FileInfo, assetType: AssetType, onProgress: (val: number) => void, anonymous?: boolean, temporary?: boolean): Promise<Asset>;
-    uploadAsset(file: FileInfo, assetType: AssetType, anonymous?: boolean, temporary?: boolean): Promise<Asset>;
-    uploadFile(file: File, onProgress: (val: number) => void): Promise<Asset>;
-    removeBackgroundFromAsset(asset: Asset): Promise<Asset>;
-    removePersistedAsset(assetKey: string): void;
-    getPersistedAssets(): PersistedAsset[];
+    getSteps(): StepHandle<AnyStepData>[];
     /**
-     * Convert a File object for an image into a FileInfo.
+     * Returns a list of scenes that are configured in the workflow. Each scene
+     * contains a list of steps. See getStepsByScene to access these.
      */
-    loadImageAsFileInfo: (file: File) => Promise<FileInfo>;
+    getScenes(): Scene[];
     /**
-     * Handles mimeType resolution & asset creation request
-     * @param file A file info object containing data about the file and its name
-     * @param assetType The type of asset we're expecting to upload
+     * Returns the total cost in subunits for all selections made on the design.
+     * @param disablePriceBreaks Whether to exclude price breaks from the calculation.
      */
-    private dispatchCreateAssetRequest;
-    private guessMIME;
-}
-interface PersistedAsset {
-    assetKey: string;
-    src: string;
-}
-declare const assetService: AssetService;
-
-interface StorageService {
+    getSelectionPriceSubunits(disablePriceBreaks?: boolean): number;
     /**
-     * Get a value.
-     * @param key The key to lookup the value with.
+     * Returns the total cost in subunits for the base product.
+     * @param includeAdditionalProduct When true the additional product cost will be included in the total (if configured).
+     * @param disablePriceBreaks Whether to exclude price breaks from the calculation.
      */
-    get(key: string): string | undefined;
+    getBasePriceSubunits(includeAdditionalProduct?: boolean, disablePriceBreaks?: boolean): number;
     /**
-     * Set a value.
-     * @param key The key to set.
-     * @param val The new value.
+     * If an additional product is configured, returns the base price of that product. Returns undefined otherwise.
+     * @param disablePriceBreaks Whether to exclude price breaks from the calculation.
      */
-    set(key: string, val: string): void;
+    getAdditionalProductPriceSubunits(disablePriceBreaks?: boolean): number | undefined;
     /**
-     * Remove a value.
-     * @param key The key to remove, does nothing if the key doesn't exist.
+     * A convenience function returning the sum of the selection and base price values.
+     * @param disablePriceBreaks Whether to exclude price breaks from the calculation.
      */
-    remove(key: string): void;
+    getTotalPriceSubunits(disablePriceBreaks?: boolean): number;
     /**
-     * Get a map from persistence.
-     * @param key The key to search by.
+     * The price break percentage that is expected to be applied in price calculations.
      */
-    getMap<K = any, V = any>(key: string): Map<K, V> | undefined;
+    priceBreakToBeApplied(): number;
     /**
-     * St a map into persistence.
-     * @param key The key to set the map at.
-     * @param val The map to set.
+     * Calculates the price break and fires the "PriceBreakChanged" event if required.
+     * This function is primarily intended for internal use.
      */
-    setMap<K = any, V = any>(key: string, val: Map<K, V>): void;
-}
-declare const persistenceService: StorageService;
-
-/**
- * A wrapping component that provides a simple interface for interacting with a variant.
- */
-declare class Variant {
-    private readonly variantData;
-    constructor(variant: VariantResource);
-    getType(): AssetType | undefined;
+    checkForPriceBreakChanges(): void;
     /**
-     * @returns The unique identifier for the variant.
+     * Takes selections made by the user in another workflow and applies them to this workflow. For
+     * selections to be copied they must both have a matching global property configuration.
+     * @param experience The experience to take selections from.
+     * @param filter A list of steps to apply the selections to. If undefined all steps will be updated.
      */
-    getId(): string;
+    copySelectionsViaGlobalConfiguration(bundle: Bundle$1, experience: WorkflowExperience, filter?: StepHandle<AnyStepData>[]): Promise<void>;
     /**
-     * @returns The configured name of the variant. Generally a human readable value.
+     * Attach specific details about the customer to the experience. This is useful for things like retargeting. Currently only
+     * email is supported. From SpiffCommerce hosted experiences these details will be attached whenever the customer has provided & given permission.
+     * @param details The new customer details. Only email is supported.
+     * @deprecated Use assignCustomerDetails instead.
      */
-    getName(): string;
+    attachCustomerDetails(details: {
+        /**
+         * An email used for things like sending a design to the user.
+         */
+        email: string;
+    }): Promise<void>;
     /**
-     * @returns The price modifier for this variant. This is the amount that will be added to the base price of the product.
+     * Attach specific details about the customer to the experience. This is useful for things like retargeting.
+     * From SpiffCommerce hosted experiences these details will be attached whenever the customer has provided & given permission.
+     * @param details The new customer details.
      */
-    getPriceFormatted(locales?: Intl.LocalesArgument, options?: Intl.NumberFormatOptions | undefined): string;
+    assignCustomerDetails(details: CustomerDetailsInput): Promise<void>;
     /**
-     * @returns The price modifier for this variant. This is the amount that will be added to the base price of the product.
-     *          Presented in subunits of the currency of the option. For example, if the option is configured to use USD, the price modifier will be in cents.
+     * 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.
      */
-    getPrice(): number;
+    attachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
     /**
-     * @returns The URL for the base asset resource configured on this variant
+     * Detaches a listener from the scenes on a workflow experience.
      */
-    getAsset(): string | undefined;
+    detachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
     /**
-     * @returns The URL for the base asset resource configured on this variant
+     * Saves this experience to storage. This may be local or remote depending
+     * on configuration.
+     * @param title The title for the saved design.
      */
-    getAssetResource(): Asset | undefined;
+    save(title: string): Promise<SavedDesign>;
     /**
-     * @returns The URL for a thumbnail resource configured on this variant.
+     * Returns a copy of the currently loaded design as a new, seperated workflow experience with
+     * a fresh transaction.
      */
-    getThumbnail(): string | undefined;
+    copy(): Promise<WorkflowExperience>;
     /**
-     * @returns The URL for the display image configured on this variant. Can be used for things like size charts.
-     * @deprecated To be removed in a future version, Please use getThumbnail() instead
+     * Creates a data URL preview for the current design.
      */
-    getDisplayImage(): string | undefined;
+    createPreviewImage(isThreeD?: boolean, resolution?: number): Promise<string>;
     /**
-     * @returns When this variant is configured to have a color, this will return the hex value for that color.
+     * To be called when the workflow experience is considered completed by the user.
+     * @param onProgressUpdate Progress callback for finalizing the design. Optional
+     * @param capturePreviewImage When true a preview image will be generated for the design. Defaults to true.
      */
-    getColor(): string | undefined;
+    onDesignFinished(onProgressUpdate?: DesignCreationProgressUpdate, capturePreviewImage?: boolean): Promise<DesignCreationMessage>;
     /**
-     * @returns True when the variant is the default for its containing option. False otherwise.
+     * Returns the metadata associated with this workflow experience.
+     * This is a combination of the metadata from the workflow, and the selections made by the user.
      */
-    isDefault(): boolean;
+    getExportedData(): Map<string, {
+        [key: string]: string;
+    }>;
     /**
-     * @returns The underlying variant resource. Generally not needed but made available just incase.
+     * Get the quantity of this WorkflowExperience's Transaction.
+     * @returns The amount that was, or will be, ordered.
      */
-    getResource(): VariantResource;
+    getQuantity(): number;
     /**
-     * @returns True when the variant is enabled. False otherwise.
+     * Sets the quantity of this WorkflowExperience's Transaction.
+     * @throws {Error} if the WorkflowExperience is read-only.
+     * @throws {RangeError} if the value is below 1.
+     * @param quantity The amount that was, or will be, ordered.
+     * @returns A promise that resolves when the Transaction has been updated on the server.
      */
-    isEnabled(): boolean;
-}
-
-/**
- * A StepHandle allows for managing the state of a specific step in a workflow. This class
- * abstracts away the complexities of dealing with a step directly and allows for using high level
- * concepts instead of dealing with the underlying data structures.
- */
-declare abstract class StepHandle<T extends AnyStepData> {
-    /**
-     * Stores whether or not the step is currently updating.
-     */
-    private static readonly updateState;
+    setQuantity(quantity: number): Promise<void>;
     /**
-     * Access to the workflow manager this step is contained by.
+     * Registers a callback function to be called when the specified event is raised.
+     * @param type The type of event to listen for.
+     * @param callback The function to call when the event occurs.
      */
-    protected readonly manager: WorkflowManager;
+    addEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
     /**
-     * The step metadata, useful for determining logic based on configuration.
+     * Removes a previously registered callback.
+     * @param type The type of event.
+     * @param callback The function to remove.
      */
-    protected readonly step: Step<T>;
-    constructor(manager: WorkflowManager, step: Step<T>);
+    removeEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
+}
+declare enum WorkflowExperienceEventType {
+    QuantityChanged = "QuantityChanged",
+    PriceBreakChanged = "PriceBreakChanged"
+}
+declare class WorkflowExperienceImpl implements WorkflowExperience {
+    readonly client: SpiffCommerceClient;
+    readonly commandContext: CommandContext;
+    readonly workflowManager: WorkflowManager;
+    readonly isReadOnly: boolean;
+    readonly cachedStepHandles: Map<string, StepHandle<any>>;
     /**
-     * Set the current update state of this step. All step handles pointing to this step will
-     * see this value.
-     * @param value The new value
+     * Bundle this experience has been added to.
      */
-    protected setUpdateState(value: boolean): void;
+    private bundle?;
+    private currentPriceBreak;
+    private renderableScenes;
+    private renderableSceneCallbacks;
+    private eventCallbacks;
+    constructor(client: SpiffCommerceClient, experienceOptions: ExperienceOptions);
+    getBundle(): Bundle$1 | undefined;
+    setBundle(bundle: Bundle$1): void;
+    getClient(): SpiffCommerceClient;
+    getIsReadOnly(): boolean;
+    getCommandContext(): CommandContext;
+    getWorkflowManager(): WorkflowManager;
+    createPreviewImage(isThreeD?: boolean, resolution?: number): Promise<string>;
+    getStepById(id: string): StepHandle<any> | undefined;
+    getSteps(): StepHandle<AnyStepData>[];
+    getScenes(): Scene[];
+    getSelectionPriceSubunits(disablePriceBreaks?: boolean): number;
+    getBasePriceSubunits(includeAdditionalProduct?: boolean, disablePriceBreaks?: boolean): number;
+    getAdditionalProductPriceSubunits(disablePriceBreaks?: boolean): number | undefined;
+    getTotalPriceSubunits(disablePriceBreaks?: boolean): number;
+    private getPriceSubUnitsAfterPriceBreaks;
+    priceBreakToBeApplied(): number;
+    checkForPriceBreakChanges(): void;
+    private getMatchingExperiencesFromBundle;
+    private updatePriceBreak;
+    copySelectionsViaGlobalConfiguration(bundle: Bundle$1, experience: WorkflowExperience, filter?: StepHandle<AnyStepData>[]): Promise<void>;
+    getStepByName(name: string): TextStepHandle | FrameStepHandle | ShapeStepHandle | InformationStepHandle | 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, capturePreviewImage?: boolean): Promise<DesignCreationMessage>;
     /**
-     * @returns Gets the current update state of this step. All step handles for this step will see this value.
+     * @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.
      */
-    protected getUpdateState(): boolean;
+    private stepHasHandle;
+    private getCanvasObjectURLAsync;
+    getExportedData(): Map<string, {
+        [key: string]: string;
+    }>;
+    getQuantity(): number;
+    setQuantity(quantity: number): Promise<void>;
+    addEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
+    removeEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
+    private callEvent;
+}
+
+/**
+ * A GlobalPropertyHandle acts as an interface to global properties on our platform. Currently
+ * bundles can return a handle for any global properties associated to the collection.
+ */
+declare abstract class GlobalPropertyHandle {
+    protected readonly bundle: Bundle$1;
+    protected readonly property: GlobalPropertyConfigurationAspect;
+    constructor(bundle: Bundle$1, property: GlobalPropertyConfigurationAspect);
     /**
-     * Gets the currently selected variant, or undefined if no variant is selected.
+     * @returns The name of the global property. This is the key used to store the property in the state.
      */
-    getCurrentVariant(): Variant | undefined;
+    getName(): string;
     /**
-     * @returns A list of valid variants for this step. Does not include disabled variants.
+     * @returns A human friendly title.
      */
-    getAvailableVariants(): Variant[];
+    getTitle(): string;
     /**
-     * @returns A list of all variants for this step, including disabled ones.
+     * @returns A human friendly description.
      */
-    getAllVariants(): Variant[];
+    getDescription(): string;
     /**
-     * Most step types have a base option type that variants can be selected for.
-     * Selects a specific variant for this step. This will execute all required changes to
-     * the design and update the metadata to include the new selection. Any conditions
-     * that would be triggered will also be executed.
+     * @returns The type of the global property. Use this to determine how to render the property.
      */
-    abstract selectVariant(variant: Variant): Promise<void>;
+    getType(): AspectType;
     /**
-     * @returns A unique identifier for this step within the workflow.
+     * @returns The underlying property data object.
      */
-    getId(): string;
+    getRawProperty(): GlobalPropertyConfigurationAspect;
     /**
-     * @returns The name of the step
+     * Applies the global state to all shared steps, if the state is set.
+     * @param targetExperiences Optionally filter the workflow experiences it should be applied to.
      */
-    getName(): string;
+    abstract applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
     /**
-     * @returns A message that can accompany the step name in UI components. Used to describe the purpose of the step in more detail.
+     * Returns all steps that share this property.
+     * @param targetExperiences Optionally filter the steps to only those in the given experiences.
      */
-    getHelpText(): string | undefined;
+    protected getSharedSteps(targetExperiences?: WorkflowExperience[]): StepHandle<_spiffcommerce_papyrus.AnyStepData>[];
+    protected getStateValue(): string | undefined;
+}
+/**
+ * A file upload global property allows for setting a frame image against all shared steps.
+ */
+declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
+    constructor(bundle: Bundle$1, property: GlobalPropertyConfigurationAspect);
     /**
-     * @returns The type of the step handle.
+     * Select an image to be used for all shared steps.
+     * @param asset The asset to use.
+     * @returns A promise resolving when all affected steps have been updated.
      */
-    getType(): StepType;
+    selectImage(asset: Asset): Promise<void>;
+    canUseBackgroundRemover(): Promise<boolean>;
     /**
-     * @returns The underlying data for this step. Favor using the step handle methods instead of this.
+     * Removes the background from an image, stores it in the state, and returns the new asset.
+     * @param applyNewAsset Optionally applies the new asset to all shared steps. Default: `true`.
+     * @returns A promise that resolves with the newly generated Asset.
      */
-    getRaw(): Step<T>;
-    getTags(): string[];
-    hasTag(tag: string): boolean;
+    removeBackgroundFromImage(applyNewAsset?: boolean): Promise<Asset>;
     /**
-     * @param type The AspectType to fetch the value for.
-     * @returns A boolean indicating whether this step should override Global Properties.
-     * Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties,
-     * and when this step is associated with one or more Global Property Aspects.
+     * Returns `true` if the state has an image assigned, otherwise `false`.
      */
-    getOverrideGlobalPropertyConfiguration(type: AspectType): boolean;
+    hasImage(): boolean;
     /**
-     * Sets whether or not this step should override Global Properties.
-     * Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties,
-     * and when this step is associated with one or more Global Property Aspects.
-     * @param type The AspectType to override.
+     * Retrieves the current image selection, if one exists.
+     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
      */
-    setOverrideGlobalPropertyConfiguration(type: AspectType, value: boolean): void;
+    getImage(): Promise<Asset | undefined>;
     /**
-     * Retrieves the identifiers of all of the configured aspects for the specified Global Property Configuration.
-     * @param configurationId The ID of the Global Property Configuration. You can usually find this with `bundle.getGlobalPropertyConfiguration()?.id`
-     * @returns An array of strings matching the keys of all the Global Property Aspects in the Configuration that this step is configured to use.
+     * Retrieves the original, unmodified image selection, if one exists.
+     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
      */
-    getGlobalPropertyAspects(configurationId: string): string[];
+    getOriginalImage(): Promise<Asset | undefined>;
     /**
-     * Fires any configured animations on the 3D preview for this step.
-     * This includes camera & model animations. If the preview is unavailable
-     * this function will do nothing.
+     * Retrieves the version of the image selection that has the background removed, if one exists.
+     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
      */
-    executeAnimations(): void;
+    getBackgroundRemovedImage(): Promise<Asset | undefined>;
+    getUseOriginalImage(): boolean;
+    setUseOriginalImage(value: boolean): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyImageSelection;
+    private updateSharedStepStorage;
 }
-
-declare const createDesign: (workflowManager: WorkflowManager, workflow: Workflow, layouts: ILayout[], getReducerState: () => CommandState, product: Product, transaction: Transaction, workflowSelections: WorkflowSelections, designName: string, onProgressUpdate: DesignCreationProgressUpdate, createPreviewImage: (shouldRender3D?: boolean, transactionId?: string) => Promise<string | undefined>, workflowMetadata?: WorkflowMetadata) => Promise<DesignCreationMessage>;
-interface SavedDesign {
-    /**
-     * The user's name for this saved design.
-     */
-    title: string;
-    /**
-     * A URL pointing to an image of the design. Typically a data URL
-     */
-    thumbnail?: string;
+declare class TextGlobalPropertyHandle extends GlobalPropertyHandle {
+    constructor(bundle: Bundle$1, property: GlobalPropertyConfigurationAspect);
     /**
-     * The ID of the transaction relating to this design.
+     * Gets the current text
      */
-    transactionId: string;
+    getText(): string;
     /**
-     * The product ID for this transaction.
+     * Set the text.
      */
-    productId: string;
+    setText(text: string): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyTextSelection;
+}
+/**
+ * An option property handle represents a property that can
+ * affect the option of steps across multiple transactions.
+ */
+declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
+    protected optionResource?: OptionResource;
+    constructor(bundle: Bundle$1, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
     /**
-     * The integration product ID related to this order.
+     * Gets the currently selected variant, or undefined if no variant is selected.
      */
-    integrationProductId: string;
+    getCurrentVariant(): Variant | undefined;
     /**
-     * The name of the workflow annotated at time of save (may be different from current workflow name).
+     * @returns A list of valid variants for this step. Does not include disabled variants.
      */
-    workflowName: string;
+    getAvailableVariants(): Variant[];
     /**
-     * The ID of the workflow annotated at time of save.
+     * @returns A list of all variants for this step, including disabled ones.
      */
-    workflowId: string;
+    getAllVariants(): Variant[];
     /**
-     * The last edit that occured on this saved design.
+     * Select a given variant on the option for all shared steps.
+     * @param variant The variant to select.
      */
-    lastEdited: Date;
+    selectVariant(variant: Variant): Promise<void>;
+    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    private applyVariantSelection;
 }
 /**
- * The design service exposes helper functionality wrapping important design management operations.
- * NOTE: In the future this interface should allow for storing/pulling designs from the server.
+ * A color option property handle represents a property that can
+ * affect the option of steps across multiple transactions. This class is a specialization of the OptionGlobalPropertyHandle which includes functionality for
+ * setting custom color values when a custom color variant is selected.
  */
-declare class DesignService {
-    readonly localPersistenceKey = "designTransactions";
-    private storageMethod;
-    private designSavedListeners;
-    /**
-     * @param func The function to call when a design is saved.
-     */
-    attachSaveListener(func: (design: SavedDesign) => void): void;
+declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle {
+    constructor(bundle: Bundle$1, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
     /**
-     * @param func The function to remove from the list of listeners.
+     * Sets a custom color on the global state.
      */
-    detachSaveListener(func: (design: SavedDesign) => void): void;
+    setCustomColor(color: string): void;
     /**
-     * Gets the currently persisted designs.
+     * Gets the custom color used by the global state.
      */
-    getSavedDesigns(): Promise<SavedDesign[]>;
-    /**
-     * Search for a transaction that has been saved.
-     * @param transactionId The id to search for.
-     * @returns The transaction for the given id provided it has been saved. undefined if it doesn't exist.
-     */
-    getSavedDesignByTransaction(transactionId: string): Promise<SavedDesign | undefined>;
-    /**
-     * Saves a design to storage.
-     * @param design The design to save.
-     */
-    addDesign(design: SavedDesign): Promise<void>;
-    /**
-     * Change the user's name of the given saved design.
-     */
-    renameDesign(transactionId: string, title: string): Promise<void>;
+    getCustomColor(): string;
+}
+
+interface GlobalPropertyStateManager {
+    getInitializationPromise(): Promise<void>;
+    getGlobalPropertyState(): GlobalPropertyState | undefined;
+    getAspect(name: string): string | undefined;
+    getAspectStorage(name: string): GlobalPropertyStateAspectStorage | undefined;
     /**
-     * Removes a given design from storage.
-     * @param transactionId
+     * Updates the value of a named aspect in the state.
+     * @param name The name (key) of the aspect. This must match the key in the associated Global Property Config
+     * @param value The value, represented as a string.
+     * @param storage Optional: Additional data storage for the aspect. Not specifying this parameter, or providing `undefined`, will not update the
+     * storage (if it already exists). Providing `null` will clear the existing storage.
      */
-    removeDesign(transactionId: string): Promise<void>;
-    private setDesigns;
+    setAspect(name: string, value: string, storage?: GlobalPropertyStateAspectStorage | null): Promise<void>;
+    setAspectStorage(name: string, storage: GlobalPropertyStateAspectStorage | null): Promise<void>;
+    setBundleOptions(bundleOptions?: BundleOptions): void;
+}
+interface BundleOptions {
+    additionalHeaders?: {
+        [key: string]: string;
+    };
 }
-declare const designService: DesignService;
 
 /**
- * A scene is a collection of steps that can be used to group steps together.
+ * A collection of products that can be used to form a bundle.
  */
-interface Scene {
+declare class ProductCollection {
+    private readonly collection;
+    constructor(collection: ProductCollectionResource);
     /**
-     * The unique identifier for the scene.
+     * The ID of the product collection.
      */
-    id?: string;
+    getId(): string;
     /**
-     * The name of the scene.
+     * The name of the collection.
      */
-    name: string;
+    getName(): string;
     /**
-     * The steps that are part of the scene. A list of ids. See getStepById.
+     * A list of products in this collections with useful helpers for interacting with them.
      */
-    stepIds: string[];
+    getProducts(): CollectionProduct[];
+    /**
+     * A list of products in this collections with useful helpers for interacting with them.
+     */
+    fetchProducts(): Promise<CollectionProduct[]>;
+    getTransformCollection(): TransformCollection$1 | undefined;
+    /**
+     * The raw collection resource. This is generally not needed and should be avoided.
+     */
+    getResource(): ProductCollectionResource;
 }
 /**
- * State related to a workflow experience.
+ * A collection product is a product within a ProductCollection. It provides a simple interface for interacting with the product.
  */
-interface ExperienceOptions {
-    product: Product;
-    transaction: Transaction;
-    workflow?: Workflow;
+declare class CollectionProduct {
+    private readonly product;
+    private readonly productResource;
+    constructor(productCollectionProduct: ProductCollectionProductResource);
     /**
-     * @deprecated favor inject / eject functions.
+     * The ID of the product in SpiffCommerce.
+     * @returns
      */
-    previewService?: ThreeDPreviewService;
-    modelContainer?: ModelContainer;
-    renderableContextService?: LayoutPreviewService;
-    layouts: ILayout[];
-    reloadedState?: LayoutsState;
+    getId(): string;
     /**
-     * When true the experience is intended to be immutable.
+     * The name of the product. Human readable.
      */
-    readOnly?: boolean;
+    getName(): string;
     /**
-     * A function that communicates state changes to the server.
+     * A helper function for getting integrations
+     * @param type The type of integration you want.
+     * @param externalId An external integration ID to further filter by. Otherwise we return the first encountered.
+     * @returns The integration if found. Throws an error if not found as this data is typically a neccesity.
      */
-    stateMutationFunc: StateMutationFunc;
+    getIntegrationByType(type: IntegrationType, externalId?: string): IntegrationProductResource;
+    getCurrentIntegration(): IntegrationProductResource;
     /**
-     * Should be set to true when the experience is loaded from an existing transaction.
-     * FIXME: Wouldn't we know this from existance of reloadedState
+     * A helper function for pulling the default workflow.
      */
-    isReloadedTransaction?: boolean;
+    getDefaultWorkflow(): ProductWorkflow$1;
     /**
-     * When true the system will treat steps with
-     * a single variant as renderable. False
-     * by default.
+     * @returns All workflows associated with this Product.
      */
-    singleVariantsRenderable?: boolean;
+    getAllWorkflows(): ProductWorkflow$1[];
     /**
-     * When true, will delay syncing the workflow state until manually enabled.
+     * A list of all integrations this product is connected to.
      */
-    delayWorkflowStateSync?: boolean;
+    getIntegrations(): IntegrationProductResource[];
+    /**
+     * The raw product resource. This is generally not needed and should be avoided.
+     */
+    getResource(): Product;
+    /**
+     * Gets the base price of the product. Optionally include additional product pricing.
+     * @param includeAdditionalProduct Optionally include additional product pricing. You must provide at least one of the fields on this object.
+     * @returns
+     */
+    getBasePrice(includeAdditionalProduct?: {
+        /**
+         * The integration type to locate the additional product on.
+         */
+        integrationType?: IntegrationType;
+        /**
+         * The external ID of the integration to locate the additional product on.
+         */
+        externalId?: string;
+        /**
+         * The internal Spiff integration ID to locate the additional product on.
+         */
+        integrationId?: string;
+    }): number;
 }
 /**
- * A Workflow experience encapsulates the workflow manager and command context. It
- * provides a simplified interface for interacting with the workflow manager. You
- * should get an instance of this class from a Client you have constructed previously.
+ * Represents a the relationship between a workflow and a product.
  */
-interface WorkflowExperience {
+declare class ProductWorkflow$1 {
+    private readonly workflow;
+    constructor(workflow: ProductWorkflow);
     /**
-     * Get the bundle this experience is part of. May be undefined.
+     * @returns The ID of this workflow, to be used when starting an experience.
      */
-    getBundle(): Bundle | undefined;
+    getId(): string;
     /**
-     * Set the bundle this experience is part of. Can be cleared using undefined.
+     * @returns The name of the workflow.
      */
-    setBundle(bundle: Bundle | undefined): any;
+    getName(): string;
     /**
-     * Returns the client that was responsible for spawning this experience.
+     * An image to be used to display this workflow in a UI to the customer.
+     * @returns A resource URL.
      */
-    getClient(): SpiffCommerceClient;
+    getThumbnail(): string;
+}
+/**
+ * Represents a collection of transforms that can be applied inside a product collection.
+ */
+declare class TransformCollection$1 {
+    private readonly collection;
+    constructor(collection: TransformCollection);
     /**
-     * State related to the design of the user.
+     * @returns The ID of the transform collection.
      */
-    getCommandContext(): CommandContext;
+    getId(): string;
     /**
-     * Returns true when the user may only view the design.
+     * @returns The name of the transform collection.
      */
-    getIsReadOnly(): boolean;
+    getName(): string;
     /**
-     * Get the low level workflow amanager instance for this experience. Don't touch this unless you're willing to break things.
+     * @returns The transforms in this collection.
      */
-    getWorkflowManager(): WorkflowManager;
+    getTransforms(): Transform[];
+}
+/**
+ * Represents the translations, rotation & scale of a product in 3D space.
+ */
+declare class Transform {
+    private readonly transform;
+    constructor(position: TransformCollectionTransform);
     /**
-     * Returns the step matching a given name, undefined if not found.
-     * @param id The id the step must match.
+     * @returns The ID of the transform.
      */
-    getStepById(id: string): StepHandle<AnyStepData> | undefined;
+    getId(): string;
     /**
-     * Returns the step matching a given name, undefined if not found.
-     * @param name The name the step must match.
+     * @returns The name of the transform.
      */
-    getStepByName(name: string): StepHandle<AnyStepData> | undefined;
+    getName(): string;
     /**
-     * Returns all steps matching a specific type in the workflow. These steps
-     * may be across multiple scenes and may or may not be active based on condition state.
+     * @returns The transformation to be used to place the object.
      */
-    getStepsByType(type: StepType): StepHandle<AnyStepData>[];
+    get(): BundleStateTransform;
+}
+
+/**
+ * A bundle serves as a container for a set of workflow experience.
+ */
+interface Bundle$1 {
     /**
-     * Returns all steps that are children of a given scene.
-     * @param scene The scene you want the steps for.
+     * @returns The client that this bundle is associated with.
      */
-    getStepsByScene(scene: Scene): StepHandle<AnyStepData>[];
+    getClient(): SpiffCommerceClient;
     /**
-     * Returns all steps in the workflow that are currently active. Ordered by scene and appearance within their respective scenes.
+     * @returns The id of the bundle entity in the Spiff Commerce system.
      */
-    getSteps(): StepHandle<AnyStepData>[];
+    getId(): string;
     /**
-     * Returns a list of scenes that are configured in the workflow. Each scene
-     * contains a list of steps. See getStepsByScene to access these.
+     * @returns The name of the bundle.
      */
-    getScenes(): Scene[];
+    getName(): string;
     /**
-     * Returns the total cost in subunits for all selections made on the design.
-     * @param disablePriceBreaks Whether to exclude price breaks from the calculation.
+     * Set the name of the bundle.
+     * @param name The new name for the bundle.
+     * @returns A promise that resolves when the name has been updated in the Spiff Commerce system.
      */
-    getSelectionPriceSubunits(disablePriceBreaks?: boolean): number;
+    setName(name: string): Promise<void>;
     /**
-     * Returns the total cost in subunits for the base product.
-     * @param includeAdditionalProduct When true the additional product cost will be included in the total (if configured).
-     * @param disablePriceBreaks Whether to exclude price breaks from the calculation.
+     * @returns Custom metadata associated with this bundle.
      */
-    getBasePriceSubunits(includeAdditionalProduct?: boolean, disablePriceBreaks?: boolean): number;
+    getMetadata(): Map<string, string>;
     /**
-     * If an additional product is configured, returns the base price of that product. Returns undefined otherwise.
-     * @param disablePriceBreaks Whether to exclude price breaks from the calculation.
+     * Set custom metadata associated with this bundle.
+     * @param metadata Updated map of metadata items.
+     * @returns A promise that resolves when the metadata has been updated in the Spiff Commerce system.
      */
-    getAdditionalProductPriceSubunits(disablePriceBreaks?: boolean): number | undefined;
+    setMetadata(metadata: Map<string, string>): Promise<void>;
     /**
-     * A convenience function returning the sum of the selection and base price values.
-     * @param disablePriceBreaks Whether to exclude price breaks from the calculation.
+     * Set the name and metadata for this bundle.
+     * @param name The new name for the bundle.
+     * @param metadata Updated map of metadata items.
+     * @returns A promise that resolves when the name and metadata have been updated in the Spiff Commerce system.
      */
-    getTotalPriceSubunits(disablePriceBreaks?: boolean): number;
+    setNameAndMetadata(name: string, metadata: Map<string, string>): Promise<void>;
     /**
-     * The price break percentage that is expected to be applied in price calculations.
+     * Returns true if this bundle is associated with a Product Collection that is linked to a Global Property Configuration
      */
-    priceBreakToBeApplied(): number;
+    hasGlobalProperties(): boolean;
     /**
-     * Calculates the price break and fires the "PriceBreakChanged" event if required.
-     * This function is primarily intended for internal use.
+     * Get a handle to the global properties available within this bundle. Setting values
+     * via this method will make selections on all bundles that share the property.
      */
-    checkForPriceBreakChanges(): void;
+    getGlobalProperties(): Promise<GlobalPropertyHandle[]>;
     /**
-     * Takes selections made by the user in another workflow and applies them to this workflow. For
-     * selections to be copied they must both have a matching global property configuration.
-     * @param experience The experience to take selections from.
-     * @param filter A list of steps to apply the selections to. If undefined all steps will be updated.
+     * Get the low level state manager for this bundle. Don't use this unless you know what you're doing.
      */
-    copySelectionsViaGlobalConfiguration(bundle: Bundle, experience: WorkflowExperience, filter?: StepHandle<AnyStepData>[]): Promise<void>;
+    getGlobalPropertyStateManager(): GlobalPropertyStateManager;
     /**
-     * Attach specific details about the customer to the experience. This is useful for things like retargeting. Currently only
-     * email is supported. From SpiffCommerce hosted experiences these details will be attached whenever the customer has provided & given permission.
-     * @param details The new customer details. Only email is supported.
-     * @deprecated Use assignCustomerDetails instead.
+     * Get the total in subunits for all global properties in this bundle.
      */
-    attachCustomerDetails(details: {
-        /**
-         * An email used for things like sending a design to the user.
-         */
-        email: string;
-    }): Promise<void>;
+    getGlobalPropertyTotalSubunits(): Promise<number>;
     /**
-     * Attach specific details about the customer to the experience. This is useful for things like retargeting.
-     * From SpiffCommerce hosted experiences these details will be attached whenever the customer has provided & given permission.
-     * @param details The new customer details.
+     * Return the total in subunits for this bundle. This is the sum of the total for all individual transactions.
      */
-    assignCustomerDetails(details: CustomerDetailsInput): Promise<void>;
+    getTotalSubunits(): number;
     /**
-     * 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.
+     * Retrieves the product collection associated with this bundle.
+     * If the bundle is not associated with a product collection, this method will return undefined.
      */
-    attachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
+    getProductCollection(): ProductCollection | undefined;
     /**
-     * Detaches a listener from the scenes on a workflow experience.
+     * Add another workflow experience to this bundle.
+     * @param experience The workflow experience to add to this bundle.
      */
-    detachRenderableSceneListener(cb: (scenes: RenderableScene[]) => void): void;
+    addWorkflowExperience(experience: WorkflowExperience): Promise<void>;
     /**
-     * Saves this experience to storage. This may be local or remote depending
-     * on configuration.
-     * @param title The title for the saved design.
+     * Adds multiple workflow experiences to this bundle.
+     * @param experiences The workflow experiences to add to this bundle.
      */
-    save(title: string): Promise<SavedDesign>;
+    addWorkflowExperiences(experiences: WorkflowExperience[]): Promise<void>;
     /**
-     * Returns a copy of the currently loaded design as a new, seperated workflow experience with
-     * a fresh transaction.
+     * Remove a workflow experience from this bundle.
+     * @param experience The workflow experience to remove from this bundle.
      */
-    copy(): Promise<WorkflowExperience>;
+    removeWorkflowExperience(experience: WorkflowExperience): Promise<void>;
     /**
-     * Creates a data URL preview for the current design.
+     * Removes multiple workflow experiences from this bundle.
+     * @param experiences The workflow experiences to remove from this bundle.
      */
-    createPreviewImage(isThreeD?: boolean, resolution?: number): Promise<string>;
+    removeWorkflowExperiences(experiences: WorkflowExperience[]): Promise<void>;
     /**
-     * To be called when the workflow experience is considered completed by the user.
-     * @param onProgressUpdate Progress callback for finalizing the design. Optional
-     * @param capturePreviewImage When true a preview image will be generated for the design. Defaults to true.
+     * Remove a workflow experience from this bundle by transaction.
+     * @param transaction The transaction to remove from this bundle.
      */
-    onDesignFinished(onProgressUpdate?: DesignCreationProgressUpdate, capturePreviewImage?: boolean): Promise<DesignCreationMessage>;
+    removeWorkflowExperienceByTransaction(transaction: Transaction): Promise<void>;
     /**
-     * Returns the metadata associated with this workflow experience.
-     * This is a combination of the metadata from the workflow, and the selections made by the user.
+     * Removes multiple workflow experiences from this bundle by their transactions.
+     * @param transactions The transactions to remove from this bundle.
      */
-    getExportedData(): Map<string, {
-        [key: string]: string;
-    }>;
+    removeWorkflowExperiencesByTransactions(transactions: Transaction[]): Promise<void>;
     /**
-     * Get the quantity of this WorkflowExperience's Transaction.
-     * @returns The amount that was, or will be, ordered.
+     * Inserts the given workflow experience into the bundle at the given index.
+     * NOTE: If you intend to insert a workflow experience at the end of the bundle, use `addWorkflowExperience` instead as it is more efficient.
+     * @param experience The workflow experience to insert.
+     * @param index The index to insert the workflow experience at.
      */
-    getQuantity(): number;
+    insertWorkflowExperience(experience: WorkflowExperience, index: number): Promise<void>;
     /**
-     * Sets the quantity of this WorkflowExperience's Transaction.
-     * @throws {Error} if the WorkflowExperience is read-only.
-     * @throws {RangeError} if the value is below 1.
-     * @param quantity The amount that was, or will be, ordered.
-     * @returns A promise that resolves when the Transaction has been updated on the server.
+     * Replaces a workflow experience at the given index with the given workflow experience. This essentially removes the old one and inserts the new one.
+     * @param index The index to replace the workflow experience at.
+     * @param experience The workflow experience to replace the old one with.
      */
-    setQuantity(quantity: number): Promise<void>;
+    replaceWorkflowExperience(index: number, experience: WorkflowExperience): Promise<void>;
     /**
-     * Registers a callback function to be called when the specified event is raised.
-     * @param type The type of event to listen for.
-     * @param callback The function to call when the event occurs.
+     * Swaps the workflow experiences at the given indices.
      */
-    addEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
+    swapWorkflowExperiences(a: number, b: number): Promise<void>;
     /**
-     * Removes a previously registered callback.
-     * @param type The type of event.
-     * @param callback The function to remove.
+     * Returns all workflow experiences currently added to this bundle.
      */
-    removeEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
-}
-declare enum WorkflowExperienceEventType {
-    QuantityChanged = "QuantityChanged",
-    PriceBreakChanged = "PriceBreakChanged"
-}
-declare class WorkflowExperienceImpl implements WorkflowExperience {
-    readonly client: SpiffCommerceClient;
-    readonly commandContext: CommandContext;
-    readonly workflowManager: WorkflowManager;
-    readonly isReadOnly: boolean;
-    readonly cachedStepHandles: Map<string, StepHandle<any>>;
+    getWorkflowExperiences(): WorkflowExperience[];
     /**
-     * Bundle this experience has been added to.
+     * Sort the list of workflow experiences. The sorting is performed locally, and then the order is updated in the Spiff Commerce system.
+     * @returns A promise that resolves when the re-ordering of the workflow experiences has been updated in the Spiff Commerce system.
+     * The sorting will occur immediately, but the promise will not resolve until the Spiff Commerce system has been updated.
      */
-    private bundle?;
-    private currentPriceBreak;
-    private renderableScenes;
-    private renderableSceneCallbacks;
-    private eventCallbacks;
-    constructor(client: SpiffCommerceClient, experienceOptions: ExperienceOptions);
-    getBundle(): Bundle | undefined;
-    setBundle(bundle: Bundle): void;
-    getClient(): SpiffCommerceClient;
-    getIsReadOnly(): boolean;
-    getCommandContext(): CommandContext;
-    getWorkflowManager(): WorkflowManager;
-    createPreviewImage(isThreeD?: boolean, resolution?: number): Promise<string>;
-    getStepById(id: string): StepHandle<any> | undefined;
-    getSteps(): StepHandle<AnyStepData>[];
-    getScenes(): Scene[];
-    getSelectionPriceSubunits(disablePriceBreaks?: boolean): number;
-    getBasePriceSubunits(includeAdditionalProduct?: boolean, disablePriceBreaks?: boolean): number;
-    getAdditionalProductPriceSubunits(disablePriceBreaks?: boolean): number | undefined;
-    getTotalPriceSubunits(disablePriceBreaks?: boolean): number;
-    private getPriceSubUnitsAfterPriceBreaks;
-    priceBreakToBeApplied(): number;
-    checkForPriceBreakChanges(): void;
-    private getMatchingExperiencesFromBundle;
-    private updatePriceBreak;
-    copySelectionsViaGlobalConfiguration(bundle: Bundle, experience: WorkflowExperience, filter?: StepHandle<AnyStepData>[]): Promise<void>;
-    getStepByName(name: string): TextStepHandle | FrameStepHandle | ShapeStepHandle | InformationStepHandle | 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, capturePreviewImage?: boolean): Promise<DesignCreationMessage>;
+    sortWorkflowExperiences(sortFunc: (expA: WorkflowExperience, expB: WorkflowExperience) => number): Promise<void>;
     /**
-     * @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.
+     * @returns The number of workflow experiences in this bundle.
      */
-    private stepHasHandle;
-    private getCanvasObjectURLAsync;
-    getExportedData(): Map<string, {
-        [key: string]: string;
-    }>;
-    getQuantity(): number;
-    setQuantity(quantity: number): Promise<void>;
-    addEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
-    removeEventListener(type: WorkflowExperienceEventType, callback: (workflowExperience: WorkflowExperience) => void): void;
-    private callEvent;
-}
-
-/**
- * A GlobalPropertyHandle acts as an interface to global properties on our platform. Currently
- * bundles can return a handle for any global properties associated to the collection.
- */
-declare abstract class GlobalPropertyHandle {
-    protected readonly bundle: Bundle;
-    protected readonly property: GlobalPropertyConfigurationAspect;
-    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
+    getWorkflowExperienceCount(): number;
     /**
-     * @returns The name of the global property. This is the key used to store the property in the state.
+     * Add a stakeholder to this bundle. If the stakeholder already exists, it will be updated. Write access to the bundle is required.
+     * @param customerDetails The details of the customer to add. The emailAddress field is required.
+     * @param stakeholderType The type of stakeholder to add. Defaults to Owner.
      */
-    getName(): string;
+    addStakeholder(customerDetails: CustomerDetailsInput, stakeholderType?: StakeholderType): Promise<void>;
     /**
-     * @returns A human friendly title.
+     * Removes a stakeholder from this bundle. Write access to the bundle is required.
+     * @param emailAddress The email address of the stakeholder to remove.
      */
-    getTitle(): string;
+    removeStakeholder(emailAddress: string): Promise<void>;
     /**
-     * @returns A human friendly description.
+     * Updates all stakeholders associated with this bundle. Write access to the bundle is required.
+     * @param stakeholders An array of stakeholders to update. Unknown stakeholders will be added, and absent stakeholders will be removed.
      */
-    getDescription(): string;
+    updateStakeholders(stakeholders: BundleStakeholderInput[]): Promise<void>;
     /**
-     * @returns The type of the global property. Use this to determine how to render the property.
+     * Retrieves all stakeholders associated with this bundle.
      */
-    getType(): AspectType;
+    getAllStakeholders(): Promise<BundleStakeholder[]>;
     /**
-     * @returns The underlying property data object.
+     * Finalizes all experiences within the bundle. This will return a promise that resolves when all experiences have been finalized.
+     * The promise resolves with a list of messages that indicate the status of each experience including
+     * helpful details like what product to add to cart on supported e-commerce platforms.
+     * @param onProgressUpdate A callback that will be called when the progress of the finalization changes.
+     * @param createPreviewImage A callback that will be called when a preview image is required. This is used to generate a preview image for the design.
+     * If this callback is not provided, no preview image will be generated.
+     * @returns {BundleDesignCreationMessage} An object containing an array of design messages, along with the Bundle's Id and the event type.
      */
-    getRawProperty(): GlobalPropertyConfigurationAspect;
+    finish(onProgressUpdate?: DesignCreationProgressUpdate, createPreviewImage?: (workflowExperience: WorkflowExperience) => Promise<string | undefined>): Promise<BundleDesignCreationMessage>;
     /**
-     * Applies the global state to all shared steps, if the state is set.
-     * @param targetExperiences Optionally filter the workflow experiences it should be applied to.
+     * Add an event listener to this bundle.
+     * @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.
      */
-    abstract applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
+    addEventListener(event: BundleEventType, listener: (e: BundleEvent) => void): void;
     /**
-     * Returns all steps that share this property.
-     * @param targetExperiences Optionally filter the steps to only those in the given experiences.
+     * Remove a previously added event listener from this bundle.
      */
-    protected getSharedSteps(targetExperiences?: WorkflowExperience[]): StepHandle<_spiffcommerce_papyrus.AnyStepData>[];
-    protected getStateValue(): string | undefined;
-}
-/**
- * A file upload global property allows for setting a frame image against all shared steps.
- */
-declare class FileUploadGlobalPropertyHandle extends GlobalPropertyHandle {
-    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
+    removeEventListener(event: BundleEventType, listener: (e: BundleEvent) => void): void;
     /**
-     * Select an image to be used for all shared steps.
-     * @param asset The asset to use.
-     * @returns A promise resolving when all affected steps have been updated.
+     * 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.
      */
-    selectImage(asset: Asset): Promise<void>;
+    getPreviewService(): ThreeDPreviewService | undefined;
     /**
-     * Removes the background from an image, stores it in the state, and returns the new asset.
-     * @param applyNewAsset Optionally applies the new asset to all shared steps. Default: `true`.
-     * @returns A promise that resolves with the newly generated Asset.
+     * 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.
      */
-    removeBackgroundFromImage(applyNewAsset?: boolean): Promise<Asset>;
+    setPreviewService(previewService?: ThreeDPreviewService): Promise<void>;
     /**
-     * Returns `true` if the state has an image assigned, otherwise `false`.
+     * 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.
      */
-    hasImage(): boolean;
+    getInitializationPromise(): Promise<void>;
     /**
-     * Retrieves the current image selection, if one exists.
-     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
+     * Sets the position, rotation, and scale of a named transform for a workflow experience within this bundle.
+     * @param workflowExperience The workflow experience to update.
+     * @param transformName The name of the transform.
+     * @param transform An object containing `position`, `rotation`, and `scale` properties. Each property is an object with `x`, `y`, and `z` properties.
      */
-    getImage(): Promise<Asset | undefined>;
+    updateWorkflowExperienceTransform(workflowExperience: WorkflowExperience, transformName: string, transform: BundleStateTransform): Promise<void>;
     /**
-     * Retrieves the original, unmodified image selection, if one exists.
-     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
+     * Sets a transform of a workflow experience within this bundle to be the active one.
+     * @param workflowExperience The workflow experience to update.
+     * @param transform The name of the transform to make the active transform.
      */
-    getOriginalImage(): Promise<Asset | undefined>;
+    activateWorkflowExperienceTransform(workflowExperience: WorkflowExperience, transformName: string): Promise<void>;
     /**
-     * Retrieves the version of the image selection that has the background removed, if one exists.
-     * @returns A promise that resolves with an `Asset` object if one is assigned to the state, otherwise `undefined`.
+     * @returns The raw Global Property Configuration that is in use, otherwise `undefined`.
      */
-    getBackgroundRemovedImage(): Promise<Asset | undefined>;
-    getUseOriginalImage(): boolean;
-    setUseOriginalImage(value: boolean): Promise<void>;
-    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
-    private applyImageSelection;
-    private updateSharedStepStorage;
+    getGlobalPropertyConfiguration(): GlobalPropertyConfiguration | undefined;
+    setBundleOptions(bundleOptions?: BundleOptions): any;
 }
-declare class TextGlobalPropertyHandle extends GlobalPropertyHandle {
-    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect);
-    /**
-     * Gets the current text
-     */
-    getText(): string;
-    /**
-     * Set the text.
-     */
-    setText(text: string): Promise<void>;
-    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
-    private applyTextSelection;
+type BundleEventType = "conditional-global-properties-changed" | "workflow-experience-hover-enter" | "workflow-experience-hover-exit";
+type BundleEventData = ConditionalGlobalPropertiesChangedEventData | WorkflowExperienceHoverEventData;
+type BundleEvent = {
+    bundle: Bundle$1;
+    data: BundleEventData;
+    event: BundleEventType;
+};
+interface ConditionalGlobalPropertiesChangedEventData {
+    globalProperties: GlobalPropertyHandle[];
 }
-/**
- * An option property handle represents a property that can
- * affect the option of steps across multiple transactions.
- */
-declare class OptionGlobalPropertyHandle extends GlobalPropertyHandle {
-    protected optionResource?: OptionResource;
-    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
-    /**
-     * Gets the currently selected variant, or undefined if no variant is selected.
-     */
-    getCurrentVariant(): Variant | undefined;
-    /**
-     * @returns A list of valid variants for this step. Does not include disabled variants.
-     */
-    getAvailableVariants(): Variant[];
-    /**
-     * @returns A list of all variants for this step, including disabled ones.
-     */
-    getAllVariants(): Variant[];
-    /**
-     * Select a given variant on the option for all shared steps.
-     * @param variant The variant to select.
-     */
-    selectVariant(variant: Variant): Promise<void>;
-    applyGlobalState(targetExperiences?: WorkflowExperience[]): Promise<void>;
-    private applyVariantSelection;
+interface WorkflowExperienceHoverEventData {
+    workflowExperience: WorkflowExperience;
 }
+
 /**
- * A color option property handle represents a property that can
- * affect the option of steps across multiple transactions. This class is a specialization of the OptionGlobalPropertyHandle which includes functionality for
- * setting custom color values when a custom color variant is selected.
+ * A list of node types available in executions
  */
-declare class ColorOptionGlobalPropertyHandle extends OptionGlobalPropertyHandle {
-    constructor(bundle: Bundle, property: GlobalPropertyConfigurationAspect, optionResource: OptionResource | undefined);
-    /**
-     * Sets a custom color on the global state.
-     */
-    setCustomColor(color: string): void;
-    /**
-     * Gets the custom color used by the global state.
-     */
-    getCustomColor(): string;
+declare enum NodeType {
+    Split = "Split",
+    TextJoin = "TextJoin",
+    TextSlice = "TextSlice",
+    TextUpper = "TextUpper",
+    TextLower = "TextLower",
+    ParseJson = "ParseJson",
+    TextBuilder = "TextBuilder",
+    Design = "Design",
+    OverlayImage = "OverlayImage",
+    OverlayText = "OverlayText",
+    TableGenerator = "TableGenerator",
+    QR = "QR",
+    CSV = "CSV",
+    PDF = "PDF",
+    PNG = "PNG",
+    Email = "Email",
+    LocationDelivery = "LocationDelivery",
+    TemplateEmail = "TemplateEmail",
+    Map = "Map",
+    Sort = "Sort",
+    Group = "Group",
+    InnerJoin = "InnerJoin",
+    Contains = "Contains",
+    Flatten = "Flatten",
+    KeyValuePairs = "KeyValuePairs",
+    ListConcatenate = "ListConcatenate",
+    Repeat = "Repeat",
+    Size = "Size",
+    ListBuilder = "ListBuilder",
+    MapBuilder = "MapBuilder",
+    PairBuilder = "PairBuilder",
+    AND = "AND",
+    OR = "OR",
+    NOT = "NOT",
+    Equals = "Equals",
+    Present = "Present",
+    ManualOperation = "ManualOperation",
+    Switch = "Switch",
+    AssetMetadata = "AssetMetadata",
+    DataSelect = "DataSelect",
+    LayoutSelect = "LayoutSelect",
+    TransactionMetadata = "TransactionMetadata",
+    VariantSelection = "VariantSelection",
+    StartTerminal = "StartTerminal",
+    EndTerminal = "EndTerminal",
+    MiscNote = "MiscNote",
+    Assign = "Assign",
+    CsvVlookup = "CsvVlookup",
+    ProcessFlow = "ProcessFlow",
+    TemporaryAssetUrl = "TemporaryAssetUrl",
+    WebRequest = "WebRequest"
 }
-
-interface GlobalPropertyStateManager {
-    getInitializationPromise(): Promise<void>;
-    getGlobalPropertyState(): GlobalPropertyState | undefined;
-    getAspect(name: string): string | undefined;
-    getAspectStorage(name: string): GlobalPropertyStateAspectStorage | undefined;
-    /**
-     * Updates the value of a named aspect in the state.
-     * @param name The name (key) of the aspect. This must match the key in the associated Global Property Config
-     * @param value The value, represented as a string.
-     * @param storage Optional: Additional data storage for the aspect. Not specifying this parameter, or providing `undefined`, will not update the
-     * storage (if it already exists). Providing `null` will clear the existing storage.
-     */
-    setAspect(name: string, value: string, storage?: GlobalPropertyStateAspectStorage | null): Promise<void>;
-    setAspectStorage(name: string, storage: GlobalPropertyStateAspectStorage | null): Promise<void>;
-    setBundleOptions(bundleOptions?: BundleOptions): void;
+interface ExecutionNodeResponse {
+    id: string;
+    type: NodeType;
+    artifacts: string;
 }
-interface BundleOptions {
-    additionalHeaders?: {
-        [key: string]: string;
-    };
+interface ExecutionResponse {
+    id: string;
+    nodes: ExecutionNodeResponse[];
+    completedAt?: string;
+    failedAt?: string;
 }
-
 /**
- * A collection of products that can be used to form a bundle.
+ * A service containing functionality for interacting with the Spiff Commerce API to execute and inspect the result of process flows.
  */
-declare class ProductCollection {
-    private readonly collection;
-    constructor(collection: ProductCollectionResource);
-    /**
-     * The ID of the product collection.
-     */
-    getId(): string;
-    /**
-     * The name of the collection.
-     */
-    getName(): string;
-    /**
-     * A list of products in this collections with useful helpers for interacting with them.
-     */
-    getProducts(): CollectionProduct[];
-    /**
-     * A list of products in this collections with useful helpers for interacting with them.
-     */
-    fetchProducts(): Promise<CollectionProduct[]>;
-    getTransformCollection(): TransformCollection | undefined;
+declare class FlowService {
     /**
-     * The raw collection resource. This is generally not needed and should be avoided.
+     *
+     * @param id
+     * @param inputs
+     * @param options
+     * @returns
      */
-    getResource(): ProductCollectionResource;
+    execute(id: string, inputs: FlowExecutionInput[], options?: {
+        sleepTime?: number;
+        repeats?: number;
+    }): Promise<FlowExecutionResult>;
 }
 /**
- * A collection product is a product within a ProductCollection. It provides a simple interface for interacting with the product.
+ * Handles preparing a flow input for transmission to the server.
  */
-declare class CollectionProduct {
-    private readonly product;
-    private readonly productResource;
-    constructor(productCollectionProduct: ProductCollectionProductResource);
-    /**
-     * The ID of the product in SpiffCommerce.
-     * @returns
-     */
-    getId(): string;
+declare class FlowExecutionResult {
+    protected readonly execution: ExecutionResponse;
+    constructor(execution: ExecutionResponse);
     /**
-     * The name of the product. Human readable.
+     * @returns The raw response from the server.
      */
-    getName(): string;
+    getRaw(): ExecutionResponse;
     /**
-     * A helper function for getting integrations
-     * @param type The type of integration you want.
-     * @param externalId An external integration ID to further filter by. Otherwise we return the first encountered.
-     * @returns The integration if found. Throws an error if not found as this data is typically a neccesity.
+     * @returns The nodes contained within the execution.
      */
-    getIntegrationByType(type: IntegrationType, externalId?: string): IntegrationProductResource;
-    getCurrentIntegration(): IntegrationProductResource;
+    getNodes(): FlowExecutionNodeResult[];
     /**
-     * A helper function for pulling the default workflow.
+     * @param type The type of node to return.
+     * @returns A list of nodes matching the requested type.
      */
-    getDefaultWorkflow(): ProductWorkflow;
+    getNodesByType(type: NodeType): FlowExecutionNodeResult[];
     /**
-     * @returns All workflows associated with this Product.
+     * @returns A list of input nodes that exist in this execution.
      */
-    getAllWorkflows(): ProductWorkflow[];
+    getInputs(): FlowExecutionNodeResult[];
     /**
-     * A list of all integrations this product is connected to.
+     * @returns A list of out put nodes that exist in this execution.
      */
-    getIntegrations(): IntegrationProductResource[];
+    getOutputs(): FlowExecutionNodeResult[];
     /**
-     * The raw product resource. This is generally not needed and should be avoided.
+     * @returns A date object representing the point in time this execution completed.
      */
-    getResource(): Product;
+    getCompletedAt(): Date | undefined;
     /**
-     * Gets the base price of the product. Optionally include additional product pricing.
-     * @param includeAdditionalProduct Optionally include additional product pricing. You must provide at least one of the fields on this object.
-     * @returns
+     * @returns A date object representing the point in time this execution failed.
      */
-    getBasePrice(includeAdditionalProduct?: {
-        /**
-         * The integration type to locate the additional product on.
-         */
-        integrationType?: IntegrationType;
-        /**
-         * The external ID of the integration to locate the additional product on.
-         */
-        externalId?: string;
-        /**
-         * The internal Spiff integration ID to locate the additional product on.
-         */
-        integrationId?: string;
-    }): number;
+    getFailedAt(): Date | undefined;
 }
 /**
- * Represents a the relationship between a workflow and a product.
+ * Handles preparing a flow input for transmission to the server.
  */
-declare class ProductWorkflow {
-    private readonly workflow;
-    constructor(workflow: ProductWorkflow$1);
-    /**
-     * @returns The ID of this workflow, to be used when starting an experience.
-     */
+declare class FlowExecutionNodeResult {
+    protected readonly node: ExecutionNodeResponse;
+    constructor(node: ExecutionNodeResponse);
     getId(): string;
-    /**
-     * @returns The name of the workflow.
-     */
-    getName(): string;
-    /**
-     * An image to be used to display this workflow in a UI to the customer.
-     * @returns A resource URL.
-     */
-    getThumbnail(): string;
+    getType(): NodeType;
+    getArtifacts(): Map<string, any>;
+    getArtifactByName<T>(name: string): T;
 }
 /**
- * Represents a collection of transforms that can be applied inside a product collection.
+ * Handles preparing a flow input for transmission to the server.
  */
-declare class TransformCollection {
-    private readonly collection;
-    constructor(collection: TransformCollection$1);
-    /**
-     * @returns The ID of the transform collection.
-     */
+declare abstract class FlowExecutionInput {
+    protected readonly value: string;
+    constructor(value: string);
+    getRaw(): string;
+    getValueForTransmission(): string;
+}
+/**
+ * Represents the type of object being referenced by the input.
+ */
+declare const enum ObjectInputType {
+    Transaction = "Transaction",
+    Bundle = "Bundle",
+    Product = "Product",
+    Variant = "Variant",
+    Option = "Option",
+    LineItem = "LineItem",
+    Asset = "Asset"
+}
+declare class TextInput extends FlowExecutionInput {
+    constructor(input: string);
+}
+/**
+ * Handles validation of spiffObject structure for transmission to the server.
+ */
+declare class ObjectInput extends FlowExecutionInput {
+    constructor(id: string, type: ObjectInputType);
+    static validUUID(uuid: string): RegExpMatchArray | null;
+}
+/**
+ * Handles validation of array input for transmission to the server.
+ */
+declare class ArrayInput extends FlowExecutionInput {
+    constructor(elements: FlowExecutionInput[]);
+}
+
+declare class IntegrationProduct {
+    private readonly integrationProduct;
+    constructor(product: IntegrationProductResource);
     getId(): string;
+    getResource(): IntegrationProductResource;
+    getBasePrice(): number;
+    getDefaultWorkflow(): ProductWorkflow$1;
+    getAllWorkflows(): ProductWorkflow$1[];
+}
+
+declare const getWorkflows: (ids: string[], options?: GetWorkflowGraphqlOptions) => Promise<Workflow[]>;
+declare const getWorkflow: (id: string, options?: GetWorkflowGraphqlOptions) => Promise<Workflow>;
+/**
+ * Options that can be used during instantiation of the SpiffCommerce Javascript Client.
+ * Please refer to the documentation for more information.
+ */
+interface ClientOptions {
     /**
-     * @returns The name of the transform collection.
+     * When provided, the client will use the provided application key to
+     * authenticate with the SpiffCommerce API.
      */
-    getName(): string;
+    applicationKey?: string;
+}
+interface GetBundleGraphqlAssetsOptions {
+    metadata?: boolean;
+}
+interface GetBundleGraphqlProductCollectionOptions {
+    eagerFetchProducts?: boolean;
+}
+interface GetBundleGraphqlOptions {
+    productCollection?: GetBundleGraphqlProductCollectionOptions;
+    assets?: GetBundleGraphqlAssetsOptions;
+    additionalHeaders?: {
+        [key: string]: string;
+    };
+}
+interface GetBundleOptions {
     /**
-     * @returns The transforms in this collection.
+     * Configuration for the graphQL request made for bundles. Allows for retrieval
+     * of additional data.
      */
-    getTransforms(): Transform[];
+    graphql?: GetBundleGraphqlOptions;
 }
-/**
- * Represents the translations, rotation & scale of a product in 3D space.
- */
-declare class Transform {
-    private readonly transform;
-    constructor(position: TransformCollectionTransform);
+interface GetWorkflowGraphqlAssetsOptions {
+    metadata?: boolean;
+}
+interface GetWorkflowGraphqlOptions {
+    assets?: GetWorkflowGraphqlAssetsOptions;
+}
+interface GetWorkflowOptionsBase {
     /**
-     * @returns The ID of the transform.
+     * An existing preview service to use, instead of creating a new one.
      */
-    getId(): string;
+    previewService?: ThreeDPreviewService;
     /**
-     * @returns The name of the transform.
+     * Configuration related to the
+     * workflow and how the system interprets it.
      */
-    getName(): string;
+    workflowConfiguration?: {
+        /**
+         * False by default, when true the system will treat
+         * steps with a single variant
+         * as being renderable.
+         */
+        singleVariantsRenderable?: boolean;
+    };
     /**
-     * @returns The transformation to be used to place the object.
+     * Configuration for the graphQL request made for workflows. Allows for retrieval
+     * of additional data.
      */
-    get(): BundleStateTransform;
+    graphql?: GetWorkflowGraphqlOptions;
 }
-
+interface GetWorkflowFromTransactionOptions extends GetWorkflowOptionsBase {
+    /** 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 extends GetWorkflowOptionsBase {
+    /** The workflow to load. */
+    workflowId: string;
+    integrationProductId: string;
+    /** An existing workflow state, if available. */
+    workflowState?: string;
+    type: "integration";
+}
+interface GetWorkflowFromExternalProductOptions extends GetWorkflowOptionsBase {
+    /** 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;
+    type: "external";
+}
+type GetNewWorkflowOptions = GetWorkflowFromIntegrationProductOptions | GetWorkflowFromExternalProductOptions;
+type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetNewWorkflowOptions;
 /**
- * A bundle serves as a container for a set of workflow experience.
+ * The Spiff Commerce Javascript Client. Required for
+ * creating workflow experiences.
  */
-interface Bundle {
+declare class SpiffCommerceClient {
+    private options;
+    private initialized;
+    private currencyCode?;
+    private customer?;
+    private activeIntegration?;
     /**
-     * @returns The client that this bundle is associated with.
+     * @deprecated This object is passed to the WorkflowExperience constructor and is no longer needed on this object.
+     * Any functionality referencing this object will be removed in a future release.
      */
-    getClient(): SpiffCommerceClient;
+    private experienceOptions?;
+    constructor(options: ClientOptions);
     /**
-     * @returns The id of the bundle entity in the Spiff Commerce system.
+     * @returns The asset manager allows for common operations related to assets
+     * and the Spiff Commerce platform.
      */
-    getId(): string;
+    getAssetManager(): AssetManager;
+    getCurrencyCode(): string;
+    getFlowService(): FlowService;
+    getIntegration(): Promise<Integration>;
+    canUseAddon(addonHandle: AddonHandle): Promise<boolean>;
     /**
-     * @returns The name of the bundle.
+     * Attempts to load persisted authentication information from local storage, and authenticate with the Spiff Commerce API.
+     * @param bundleId The ID of the bundle you intend to load.
+     * @returns An object containing the success status of the authentication attempt, and the type of stakeholder when successful.
      */
-    getName(): string;
+    authenticateBundleFromLocalStorage(bundleId: string): Promise<{
+        stakeholderType?: StakeholderType;
+        success: boolean;
+    }>;
     /**
-     * Set the name of the bundle.
-     * @param name The new name for the bundle.
-     * @returns A promise that resolves when the name has been updated in the Spiff Commerce system.
+     * Attempts to load persisted authentication information from local storage, and authenticate with the Spiff Commerce API.
+     * @param transactionId The ID of the transaction that the user is attempting to load.
+     * @returns An object containing the following:
+     * - `customLogoLink`: A link to a custom logo to display in the header.
+     * - `transactionReadOnly`: Whether or not the transaction is read-only. Shadow will not accept any changes to the transaction if this is set to true.
+     * - `stakeholderType`: The type of stakeholder that the user is authenticated as.
+     * - `success`: Whether or not the authentication was successful.
+     * @throws An error if the transaction is not found.
      */
-    setName(name: string): Promise<void>;
+    authenticateTransactionFromLocalStorage(transactionId: string): Promise<{
+        customLogoLink?: string;
+        transactionReadOnly?: boolean;
+        stakeholderType?: StakeholderType;
+        success: boolean;
+        theme?: Theme;
+    }>;
+    clearCustomer(): void;
+    clearCustomerForTransaction(transactionId: string): void;
+    getStakeholderTypeForTransaction(transactionId: string): StakeholderType | undefined;
+    getOrCreateCustomer(emailAddress: string): Promise<{
+        customer: Customer;
+        isAuthenticated: boolean;
+    }>;
+    private authenticateCustomerId;
     /**
-     * @returns Custom metadata associated with this bundle.
+     * Generates a verification code for the given email address.
+     * @param emailAddress The email address to generate a verification code for. The user will be sent an email with the verification code.
      */
-    getMetadata(): Map<string, string>;
+    generateVerificationCode(emailAddress: string): Promise<void>;
     /**
-     * Set custom metadata associated with this bundle.
-     * @param metadata Updated map of metadata items.
-     * @returns A promise that resolves when the metadata has been updated in the Spiff Commerce system.
+     * Verifies the given email address with the given verification code.
+     * @param emailAddress The email address to verify.
+     * @param verificationCode The verification code to verify the email address with.
+     * @returns True if the verification was successful, false otherwise.
      */
-    setMetadata(metadata: Map<string, string>): Promise<void>;
+    verifyCode(emailAddress: string, verificationCode: string): Promise<boolean>;
     /**
-     * Set the name and metadata for this bundle.
-     * @param name The new name for the bundle.
-     * @param metadata Updated map of metadata items.
-     * @returns A promise that resolves when the name and metadata have been updated in the Spiff Commerce system.
+     * @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.
      */
-    setNameAndMetadata(name: string, metadata: Map<string, string>): Promise<void>;
+    getNewBundle(collectionId?: string, initialMetadata?: {
+        [key: string]: string;
+    }, options?: GetBundleOptions): Promise<Bundle$1>;
     /**
-     * Returns true if this bundle is associated with a Product Collection that is linked to a Global Property Configuration
+     * 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.
+     * @param graphqlOptions Optional: Options to configure loading the workflow.
+     * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
      */
-    hasGlobalProperties(): boolean;
+    getExistingBundle(bundleId: string, previewService?: ThreeDPreviewService, 
     /**
-     * Get a handle to the global properties available within this bundle. Setting values
-     * via this method will make selections on all bundles that share the property.
+     * @deprecated use GetBundleOptions instead. This attribute will be removed in the future.
      */
-    getGlobalProperties(): Promise<GlobalPropertyHandle[]>;
+    graphqlOptions?: GetBundleGraphqlOptions, options?: GetBundleOptions): Promise<Bundle$1>;
     /**
-     * Get the low level state manager for this bundle. Don't use this unless you know what you're doing.
+     * Retrieves all existing bundle stakeholders from the API, for the currently authenticated customer.
+     * @returns An array of bundle stakeholders.
      */
-    getGlobalPropertyStateManager(): GlobalPropertyStateManager;
+    getBundleStakeholders(): Promise<BundleStakeholder[]>;
     /**
-     * Get the total in subunits for all global properties in this bundle.
+     * Creates a new instance of WorkflowExperience. A high level wrapper for workflows.
+     * @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.
      */
-    getGlobalPropertyTotalSubunits(): Promise<number>;
-    /**
-     * Return the total in subunits for this bundle. This is the sum of the total for all individual transactions.
-     */
-    getTotalSubunits(): number;
+    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: Workflow) => ThreeDPreviewService, options?: GetWorkflowOptions): Promise<WorkflowExperience>;
     /**
-     * Retrieves the product collection associated with this bundle.
-     * If the bundle is not associated with a product collection, this method will return undefined.
+     * Gets multiple workflow experiences at once.
+     * @param optionsArray An array of options to configure loading the transactions and workflows.
+     * NOTE: The `previewService` field on the option is currently unsupported in this function, as loading multiple models at once will likely cause performance issues.
+     * @param graphqlOptions Options to configure loading the workflows.
+     * @returns An array of workflow experiences configured as requested.
      */
-    getProductCollection(): ProductCollection | undefined;
+    getWorkflowExperiences(optionsArray: GetWorkflowOptions[], graphqlOptions?: GetWorkflowGraphqlOptions): Promise<WorkflowExperience[]>;
     /**
-     * Add another workflow experience to this bundle.
-     * @param experience The workflow experience to add to this bundle.
+     * Initialize the client from an integration product.
+     * @param integrationProductId The integration product to use.
+     * @deprecated Use getWorkflowExperience to initialize the experience.
      */
-    addWorkflowExperience(experience: WorkflowExperience): Promise<void>;
+    initFromIntegrationProduct(integrationProductId: string): Promise<void>;
     /**
-     * Adds multiple workflow experiences to this bundle.
-     * @param experiences The workflow experiences to add to this bundle.
+     * 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.
      */
-    addWorkflowExperiences(experiences: WorkflowExperience[]): Promise<void>;
+    initFromTransaction(transactionId: string, readOnly?: boolean): Promise<void>;
     /**
-     * Remove a workflow experience from this bundle.
-     * @param experience The workflow experience to remove from this bundle.
+     * @deprecated Remove when the initFrom functions are removed.
      */
-    removeWorkflowExperience(experience: WorkflowExperience): Promise<void>;
+    private getWorkflowExperienceDeprecated;
     /**
-     * Removes multiple workflow experiences from this bundle.
-     * @param experiences The workflow experiences to remove from this bundle.
+     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `workflowExperience.getWorkflowManager().getPreviewService()` instead.
+     * @returns The preview service that was provided during construction.
      */
-    removeWorkflowExperiences(experiences: WorkflowExperience[]): Promise<void>;
+    getPreviewService(): ThreeDPreviewService | undefined;
     /**
-     * Remove a workflow experience from this bundle by transaction.
-     * @param transaction The transaction to remove from this bundle.
+     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `WorkflowManager.getProduct()` instead.
+     * @returns The product associated with this client.
      */
-    removeWorkflowExperienceByTransaction(transaction: Transaction): Promise<void>;
+    getProduct(): Product;
     /**
-     * Removes multiple workflow experiences from this bundle by their transactions.
-     * @param transactions The transactions to remove from this bundle.
+     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `WorkflowManager.getTransaction()` instead.
+     * @returns The transaction associated with this client.
      */
-    removeWorkflowExperiencesByTransactions(transactions: Transaction[]): Promise<void>;
+    getTransaction(): Transaction;
+    configureUrls(hubUrl: string, serverUrl: string, servicesApiUrl: string): void;
     /**
-     * Inserts the given workflow experience into the bundle at the given index.
-     * NOTE: If you intend to insert a workflow experience at the end of the bundle, use `addWorkflowExperience` instead as it is more efficient.
-     * @param experience The workflow experience to insert.
-     * @param index The index to insert the workflow experience at.
+     * A function used to synchronize transaction state with the server.
+     * @param options New state details. To be spread into the query.
+     * @returns
      */
-    insertWorkflowExperience(experience: WorkflowExperience, index: number): Promise<void>;
+    private updateTransactionState;
+    storeCustomer(customer: Customer): void;
+    getIntegrationProductById(integrationProductId: string): Promise<IntegrationProduct>;
+    getIntegrationProductFromExternalIds(externalIntegrationId: string, externalProductId: string): Promise<IntegrationProduct>;
+    getIntegrationProduct(options: Extendable<{
+        type: "integration";
+        integrationProductId: string;
+    }> | Extendable<{
+        type: "external";
+        externalIntegrationId: string;
+        externalProductId: string;
+    }>): Promise<IntegrationProduct>;
+}
+
+interface SilentIllustrationStepData extends SilentStepData, Placeable {
+}
+interface EditedSteps {
+    [stepName: string]: boolean;
+}
+interface MandatorySteps {
+    [stepName: string]: boolean;
+}
+type StepElements = {
+    [key: string]: RegionElement[];
+};
+type StepInitialised = {
+    [key: string]: boolean;
+};
+type StepMetadata = FrameMetadata | IllustrationMetadata | ModuleMetadata | TextMetadata;
+interface WorkflowStorage {
+    [stepName: string]: StepStorage;
+}
+interface WorkflowMetadata {
+    [stepName: string]: StepMetadata;
+}
+interface WorkflowSelections {
+    [stepName: string]: {
+        selections: VariantResource[];
+    };
+}
+interface InformationResult {
+    message: string;
+    messageType: InformationMessageType;
+    stepID: string;
+}
+declare enum InformationMessageType {
+    Error = "Error",
+    Warning = "Warning",
+    Info = "Info"
+}
+/**
+ * Services required for the operaiton of individual steps.
+ */
+interface StepSpecificServices {
+    frameService?: FrameService;
+    module?: ModuleProduct;
+}
+type DesignCreationProgressUpdate = (message: string) => void;
+type ConfirmCallback = (isConfirmed: boolean) => void;
+type EditedCallback = (editedSteps: EditedSteps) => void;
+type ElementsCallback = (elements: StepElements) => void;
+type InformationResultCallback = (messages: InformationResult[]) => void;
+type InitCallback = (stepInitialised: StepInitialised) => void;
+type MakingAdjustmentsCallback = (makingAdjustments: string) => void;
+type MandatoryCallback = (mandatorySteps: MandatorySteps) => void;
+type MetadataCallback = (metadata: WorkflowMetadata) => void;
+type SelectionCallback = (callbackOptions: {
+    selectionCost: number;
+    selections: StepSelections;
+    traversableScenes: WorkflowScene[];
+}) => void;
+type StepSpecificStorageCallback = (selections: StepStorage) => void;
+type StorageCallback = (storage: WorkflowStorage) => void;
+type StateMutationFunc = (options?: Omit<MutationOptions, "mutation">) => Promise<FetchResult<any, Record<string, any>, Record<string, any>>>;
+interface WorkflowManager {
+    addPoller: (poller: Poller) => void;
+    addConfirmCallback: (callback: ConfirmCallback) => void;
+    addEditedCallback: (callback: EditedCallback) => void;
+    addElementsCallback: (callback: ElementsCallback) => void;
+    addInformationResultCallback: (callback: InformationResultCallback) => void;
+    addInitCallback: (callback: InitCallback) => void;
+    addMakingAdjustmentsCallback: (callback: MakingAdjustmentsCallback) => void;
+    addMandatoryCallback: (callback: MandatoryCallback) => void;
+    addMetadataCallback: (callback: MetadataCallback) => void;
+    addSelectionCallback: (callback: SelectionCallback) => void;
+    addStepSpecificStorageCallback: (callback: StepSpecificStorageCallback, stepName: string) => void;
+    addStorageCallback: (callback: StorageCallback) => void;
+    getCommandDispatcher: () => (command: CanvasCommand) => void;
+    getCommandContext: () => CommandContext;
+    getLayouts: () => ILayout[];
+    getAllLayoutData: () => LayoutState[];
+    getLayoutPreviewService: () => LayoutPreviewService | undefined;
+    getPreviewService: () => ThreeDPreviewService | undefined;
+    getProfanities: () => string[];
+    getRegionElements: (stepName: string) => RegionElement[];
+    getSerializedStep: (stepName: string, serializedSteps: SerializableStep[]) => SerializableStep | undefined;
+    getStepSpecificServices: (stepName: string) => StepSpecificServices | undefined;
+    getStepStorage: (stepName: string) => StepStorage | undefined;
+    getMetadata: (stepName: string) => StepMetadata | undefined;
+    getWorkflowMetadata: () => WorkflowMetadata;
+    getInformationResults(): InformationResult[];
+    getTransaction: () => Transaction;
+    getTransactionCustomer: () => Customer | undefined;
+    setTransactionCustomer: (customer: Customer) => void;
     /**
-     * Replaces a workflow experience at the given index with the given workflow experience. This essentially removes the old one and inserts the new one.
-     * @param index The index to replace the workflow experience at.
-     * @param experience The workflow experience to replace the old one with.
+     * @deprecated Use setTransactionCustomer instead.
      */
-    replaceWorkflowExperience(index: number, experience: WorkflowExperience): Promise<void>;
+    setTransactionCustomerDetails: (details: {
+        email: string;
+    }) => void;
+    getWorkflow: () => Workflow;
+    getWorkflowSelections: () => WorkflowSelections;
+    getProduct: () => Product;
     /**
-     * Swaps the workflow experiences at the given indices.
+     * A promise resolving when the initial state of the workflow has completed loading.
      */
-    swapWorkflowExperiences(a: number, b: number): Promise<void>;
+    getInitializationPromise: () => Promise<void>;
     /**
-     * Returns all workflow experiences currently added to this bundle.
+     * Returns true when the initial state of the workflow has been loaded and settled.
      */
-    getWorkflowExperiences(): WorkflowExperience[];
+    isInitialized(): boolean;
+    markStepsAsInitialised: (stepNames: string[]) => void;
+    getUpdatesPending: () => boolean;
+    markUpdateCompleted: (id: string) => void;
+    markUpdatePending: () => string;
+    outstandingRequestsPromise: () => Promise<void>;
+    reset: () => Promise<void>;
+    setCurrentAdjustingStepId: (stepId: string) => void;
+    setEditedStatus: (stepName: string, status: boolean) => void;
+    setInformationResults: (results: InformationResult[]) => void;
+    setMandatoryFulfilled: (stepName: string, status: boolean) => void;
+    setSelectionsAndElements: (stepName: string, variants: VariantResource[], elements: RegionElement[], callback?: () => Promise<void>) => Promise<void>;
+    toggleDesignConfirmed: () => void;
+    updateMetadata: (stepName: string, update: any) => void;
     /**
-     * Sort the list of workflow experiences. The sorting is performed locally, and then the order is updated in the Spiff Commerce system.
-     * @returns A promise that resolves when the re-ordering of the workflow experiences has been updated in the Spiff Commerce system.
-     * The sorting will occur immediately, but the promise will not resolve until the Spiff Commerce system has been updated.
+     * @deprecated State updates are being pulled internally. This function will be removed in the future.
      */
-    sortWorkflowExperiences(sortFunc: (expA: WorkflowExperience, expB: WorkflowExperience) => number): Promise<void>;
+    updateStateWithServerImmediate: (getReducerState: () => CommandState) => Promise<void>;
+    updateStorage: (stepName: string, update: StepStorage) => void;
+    getModelContainer: () => ModelContainer | undefined;
+    setModelContainer: (container: ModelContainer) => void;
     /**
-     * @returns The number of workflow experiences in this bundle.
+     * Injects the model of this product into the preview service.
+     * This also overwrites the internal preview service.
+     * @param previewService The preview service to inject into.
+     * @param refocusCamera Optional: Run camera focus Defaults to `true`.
      */
-    getWorkflowExperienceCount(): number;
+    injectIntoPreviewService(previewService: ThreeDPreviewService, refocusCamera?: boolean): Promise<void>;
     /**
-     * Add a stakeholder to this bundle. If the stakeholder already exists, it will be updated. Write access to the bundle is required.
-     * @param customerDetails The details of the customer to add. The emailAddress field is required.
-     * @param stakeholderType The type of stakeholder to add. Defaults to Owner.
+     * Ejects the model of this product from the preview service. This also sets the internal preview service to undefined.
      */
-    addStakeholder(customerDetails: CustomerDetailsInput, stakeholderType?: StakeholderType): Promise<void>;
+    ejectFromPreviewService(): void;
     /**
-     * Removes a stakeholder from this bundle. Write access to the bundle is required.
-     * @param emailAddress The email address of the stakeholder to remove.
+     * Enables or disables uploading of workflow state to the server.
+     * @param enabled When true, workflow state will be uploaded to the server.
      */
-    removeStakeholder(emailAddress: string): Promise<void>;
+    setWorkflowStateSyncEnabled: (enabled: boolean) => void;
     /**
-     * Updates all stakeholders associated with this bundle. Write access to the bundle is required.
-     * @param stakeholders An array of stakeholders to update. Unknown stakeholders will be added, and absent stakeholders will be removed.
+     * Returns the client that was responsible for spawning this manager.
      */
-    updateStakeholders(stakeholders: BundleStakeholderInput[]): Promise<void>;
+    getClient(): SpiffCommerceClient;
+}
+
+interface StepService<T extends AnyStepData> {
     /**
-     * Retrieves all stakeholders associated with this bundle.
+     * Initialize the given step, or reload from serialized data if present.
      */
-    getAllStakeholders(): Promise<BundleStakeholder[]>;
+    init(stepData: Step<T>, workflowManager: WorkflowManager, reducerState?: LayoutsState): Promise<any>;
+}
+interface FileInfo {
     /**
-     * Finalizes all experiences within the bundle. This will return a promise that resolves when all experiences have been finalized.
-     * The promise resolves with a list of messages that indicate the status of each experience including
-     * helpful details like what product to add to cart on supported e-commerce platforms.
-     * @param onProgressUpdate A callback that will be called when the progress of the finalization changes.
-     * @param createPreviewImage A callback that will be called when a preview image is required. This is used to generate a preview image for the design.
-     * If this callback is not provided, no preview image will be generated.
-     * @returns {BundleDesignCreationMessage} An object containing an array of design messages, along with the Bundle's Id and the event type.
+     * The name of the file.
      */
-    finish(onProgressUpdate?: DesignCreationProgressUpdate, createPreviewImage?: (workflowExperience: WorkflowExperience) => Promise<string | undefined>): Promise<BundleDesignCreationMessage>;
+    name: string;
     /**
-     * Add an event listener to this bundle.
-     * @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.
+     * A blob object representing the
+     * data of the file.
      */
-    addEventListener(event: BundleEventType, listener: (e: BundleEvent) => void): void;
-    /**
-     * Remove a previously added event listener from this bundle.
+    blob: Blob;
+}
+/**
+ * A command along with a function to run afterwards.
+ */
+interface CommandWithFollowup {
+    command?: CanvasCommand;
+    followup?: () => Promise<void>;
+}
+/**
+ * The variant selections of a completed step.
+ */
+interface SelectedVariants {
+    [stepName: string]: {
+        id: string;
+        name: string;
+        priceModifier: number;
+    }[];
+}
+interface ExportedData {
+    [name: string]: {
+        value: string;
+        priceModifier: number;
+    };
+}
+interface DesignCreationMessage {
+    additionalExternalProductId?: string;
+    additionalExternalVariantId?: string;
+    baseCost?: number;
+    designProductId?: string;
+    designProductVariantId?: string;
+    event: string;
+    exportedData: ExportedData;
+    externalCartProductId?: string;
+    externalCartProductVariantId?: string;
+    lineItemImageUrl: string;
+    metadata?: {
+        [stepName: string]: string;
+    };
+    optionsCost: number;
+    processExecutionId?: string;
+    quantity?: number;
+    selectedVariants?: SelectedVariants;
+    sku?: string;
+    transactionId: string;
+    transactionOwnerId?: string;
+    weight?: number;
+    workflowViewerLink: string;
+    workflowViewerReadOnlyLink: string;
+}
+interface BundleDesignCreationMessage {
+    bundleId: string;
+    items: DesignCreationMessage[];
+}
+/**
+ * Represents a transaction.
+ */
+interface Transaction {
+    /**
+     * A unique identifier for this transaction. Useful for reloading and
+     * modifying state of the transaction.
      */
-    removeEventListener(event: BundleEventType, listener: (e: BundleEvent) => void): void;
+    id: string;
     /**
-     * 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.
+     * User-supplied name for the associated design.
      */
-    getPreviewService(): ThreeDPreviewService | undefined;
+    designName?: string;
     /**
-     * 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.
+     * The workflow associated with this transaction.
      */
-    setPreviewService(previewService?: ThreeDPreviewService): Promise<void>;
+    workflowId?: string;
     /**
-     * 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.
+     * Temporary ID that grants write permission to the transaction.
      */
-    getInitializationPromise(): Promise<void>;
+    transactionOwnerId?: string;
     /**
-     * Sets the position, rotation, and scale of a named transform for a workflow experience within this bundle.
-     * @param workflowExperience The workflow experience to update.
-     * @param transformName The name of the transform.
-     * @param transform An object containing `position`, `rotation`, and `scale` properties. Each property is an object with `x`, `y`, and `z` properties.
+     * The current state of the design.
      */
-    updateWorkflowExperienceTransform(workflowExperience: WorkflowExperience, transformName: string, transform: BundleStateTransform): Promise<void>;
+    workflowState?: string;
     /**
-     * Sets a transform of a workflow experience within this bundle to be the active one.
-     * @param workflowExperience The workflow experience to update.
-     * @param transform The name of the transform to make the active transform.
+     * URL to a partner-specific logo intended to display during the workflow experience.
      */
-    activateWorkflowExperienceTransform(workflowExperience: WorkflowExperience, transformName: string): Promise<void>;
+    customLogoLink?: string;
     /**
-     * @returns The raw Global Property Configuration that is in use, otherwise `undefined`.
+     * URL to a logo intended to display at the periphery of the workflow experience.
      */
-    getGlobalPropertyConfiguration(): GlobalPropertyConfiguration | undefined;
-    setBundleOptions(bundleOptions?: BundleOptions): any;
-}
-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;
-}
-
-/**
- * A list of node types available in executions
- */
-declare enum NodeType {
-    Split = "Split",
-    TextJoin = "TextJoin",
-    TextSlice = "TextSlice",
-    TextUpper = "TextUpper",
-    TextLower = "TextLower",
-    ParseJson = "ParseJson",
-    TextBuilder = "TextBuilder",
-    Design = "Design",
-    OverlayImage = "OverlayImage",
-    OverlayText = "OverlayText",
-    TableGenerator = "TableGenerator",
-    QR = "QR",
-    CSV = "CSV",
-    PDF = "PDF",
-    PNG = "PNG",
-    Email = "Email",
-    LocationDelivery = "LocationDelivery",
-    TemplateEmail = "TemplateEmail",
-    Map = "Map",
-    Sort = "Sort",
-    Group = "Group",
-    InnerJoin = "InnerJoin",
-    Contains = "Contains",
-    Flatten = "Flatten",
-    KeyValuePairs = "KeyValuePairs",
-    ListConcatenate = "ListConcatenate",
-    Repeat = "Repeat",
-    Size = "Size",
-    ListBuilder = "ListBuilder",
-    MapBuilder = "MapBuilder",
-    PairBuilder = "PairBuilder",
-    AND = "AND",
-    OR = "OR",
-    NOT = "NOT",
-    Equals = "Equals",
-    Present = "Present",
-    ManualOperation = "ManualOperation",
-    Switch = "Switch",
-    AssetMetadata = "AssetMetadata",
-    DataSelect = "DataSelect",
-    LayoutSelect = "LayoutSelect",
-    TransactionMetadata = "TransactionMetadata",
-    VariantSelection = "VariantSelection",
-    StartTerminal = "StartTerminal",
-    EndTerminal = "EndTerminal",
-    MiscNote = "MiscNote",
-    Assign = "Assign",
-    CsvVlookup = "CsvVlookup",
-    ProcessFlow = "ProcessFlow",
-    TemporaryAssetUrl = "TemporaryAssetUrl",
-    WebRequest = "WebRequest"
-}
-interface ExecutionNodeResponse {
-    id: string;
-    type: NodeType;
-    artifacts: string;
-}
-interface ExecutionResponse {
-    id: string;
-    nodes: ExecutionNodeResponse[];
-    completedAt?: string;
-    failedAt?: string;
-}
-/**
- * A service containing functionality for interacting with the Spiff Commerce API to execute and inspect the result of process flows.
- */
-declare class FlowService {
+    workflowFooterLogoLink?: string;
     /**
-     *
-     * @param id
-     * @param inputs
-     * @param options
-     * @returns
+     * URL to the corresponding integration in the REST API.
      */
-    execute(id: string, inputs: FlowExecutionInput[], options?: {
-        sleepTime?: number;
-        repeats?: number;
-    }): Promise<FlowExecutionResult>;
-}
-/**
- * Handles preparing a flow input for transmission to the server.
- */
-declare class FlowExecutionResult {
-    protected readonly execution: ExecutionResponse;
-    constructor(execution: ExecutionResponse);
+    restApiIntegrationLink?: string;
     /**
-     * @returns The raw response from the server.
+     * URL to redirect to when a workflow is finished.
      */
-    getRaw(): ExecutionResponse;
+    callbackUrl?: string;
     /**
-     * @returns The nodes contained within the execution.
+     * Product that this transaction belongs to.
      */
-    getNodes(): FlowExecutionNodeResult[];
+    product?: Product;
     /**
-     * @param type The type of node to return.
-     * @returns A list of nodes matching the requested type.
+     * The integration product related to this lineitem.
      */
-    getNodesByType(type: NodeType): FlowExecutionNodeResult[];
+    integrationProduct?: IntegrationProductResource;
     /**
-     * @returns A list of input nodes that exist in this execution.
+     * Whether this transaction has previously been ordered.
      */
-    getInputs(): FlowExecutionNodeResult[];
+    isOrdered?: boolean;
     /**
-     * @returns A list of out put nodes that exist in this execution.
+     * @deprecated use isOrdered to check whether transaction has been ordered instead.
      */
-    getOutputs(): FlowExecutionNodeResult[];
+    lineItem?: LineItem;
     /**
-     * @returns A date object representing the point in time this execution completed.
+     * The external product variant ID representing the design product related
+     * to this transaction, null unless the createDesignProduct flag was set
+     * and the design was finalized using createDesign operation.
      */
-    getCompletedAt(): Date | undefined;
+    /**@deprecated use externalCartProductVariantId instead of this moving forward */
+    externalDesignProductVariantId?: string;
     /**
-     * @returns A date object representing the point in time this execution failed.
+     * The external product id representing the design product related
+     * to this transaction, null unless the createDesignProduct flag was set
+     * and the design was finalized using createDesign operation.
      */
-    getFailedAt(): Date | undefined;
-}
-/**
- * Handles preparing a flow input for transmission to the server.
- */
-declare class FlowExecutionNodeResult {
-    protected readonly node: ExecutionNodeResponse;
-    constructor(node: ExecutionNodeResponse);
-    getId(): string;
-    getType(): NodeType;
-    getArtifacts(): Map<string, any>;
-    getArtifactByName<T>(name: string): T;
-}
-/**
- * Handles preparing a flow input for transmission to the server.
- */
-declare abstract class FlowExecutionInput {
-    protected readonly value: string;
-    constructor(value: string);
-    getRaw(): string;
-    getValueForTransmission(): string;
+    /**@deprecated use externalCartProductId instead of this moving forward. */
+    externalDesignProductId?: string;
+    /**
+     * The external product id representing the product related to the transaction.
+     * This value can hold any type of transaction such as design and standard products.
+     */
+    externalCartProductId?: string;
+    /**
+     * The external product variant id representing the product related to the transaction.
+     * This value can hold any type of transaction such as design and standard products.
+     */
+    externalCartProductVariantId?: string;
+    priceModifierTotal?: number;
+    /**
+     * URL to open the transaction in the workflow viewer.
+     */
+    workflowViewerLink?: string;
+    workflowViewerReadOnlyLink?: string;
+    previewImageLink?: string;
+    lastSyncedAt?: string;
+    /**
+     * The users who have access to this transaction.
+     */
+    stakeholders?: Stakeholder[];
+    /**
+     * The amount of this transaction that was, or will be, ordered
+     */
+    quantity?: number;
+    printFileUrl1?: string;
+    printFileUrl2?: string;
+    printFileUrl3?: string;
+    printFileUrl4?: string;
+    printFileUrl5?: string;
 }
 /**
- * Represents the type of object being referenced by the input.
+ * An integration product represents the connection of a product in SpiffCommerce with
+ * a product on a third party platform.
  */
-declare const enum ObjectInputType {
-    Transaction = "Transaction",
-    Bundle = "Bundle",
-    Product = "Product",
-    Variant = "Variant",
-    Option = "Option",
-    LineItem = "LineItem",
-    Asset = "Asset"
+interface IntegrationProductResource {
+    /**
+     * The ID of the IntegrationProduct entity. Used internally by SpiffCommerce.
+     */
+    id: string;
+    /**
+     * The ID of the product on the third party platform. For example a Shopify product ID.
+     */
+    externalProductId?: string;
+    /**
+     * The integration that this product is associated with. For example a Shopify integration.
+     */
+    integration?: Integration;
+    /**
+     * The ID of an additional product (on the third party platform) that should be added to the cart.
+     */
+    additionalExternalProductId?: string;
+    /**
+     * A supplementary ID for the additional product. Shopify uses the variant ids to add products to the cart.
+     */
+    additionalExternalVariantId?: string;
+    /**
+     * When the additionalExternalProductId is set, this is the IntegrationProduct that is associated with it.
+     * If no Spiff product has been associated with the additionalExternalProductId, this will be null.
+     */
+    additionalIntegrationProduct?: IntegrationProductResource;
+    /**
+     * The product that this integration product is associated with.
+     */
+    product?: Product;
 }
-declare class TextInput extends FlowExecutionInput {
-    constructor(input: string);
+interface Integration {
+    id: string;
+    enabled: boolean;
+    externalIntegrationId?: string;
+    type?: IntegrationType;
+    isCurrent?: boolean;
+    theme: Theme;
+    logo: string;
+    partner: Partner;
 }
-/**
- * Handles validation of spiffObject structure for transmission to the server.
- */
-declare class ObjectInput extends FlowExecutionInput {
-    constructor(id: string, type: ObjectInputType);
-    static validUUID(uuid: string): RegExpMatchArray | null;
+declare enum IntegrationType {
+    Hub = "Hub",
+    Shopify = "Shopify"
 }
 /**
- * Handles validation of array input for transmission to the server.
+ * Fields found in a variant within a line item resource.
  */
-declare class ArrayInput extends FlowExecutionInput {
-    constructor(elements: FlowExecutionInput[]);
+interface LineItemVariant {
+    currencyCode: string;
+    optionName: string;
+    priceModifier: number;
+    stepName: string;
+    variantName: string;
 }
-
-declare class IntegrationProduct {
-    private readonly integrationProduct;
-    constructor(product: IntegrationProductResource);
-    getId(): string;
-    getResource(): IntegrationProductResource;
-    getBasePrice(): number;
-    getDefaultWorkflow(): ProductWorkflow;
-    getAllWorkflows(): ProductWorkflow[];
+interface LineItem {
+    id: string;
+    transactionId?: string;
+    previewImageUrl?: string;
+    product: Product;
+    quantity: number;
+    metadata?: LineItemMetadata[];
+    variants: LineItemVariant[];
 }
-
-declare const getWorkflows: (ids: string[], options?: GetWorkflowGraphqlOptions) => Promise<Workflow[]>;
-declare const getWorkflow: (id: string, options?: GetWorkflowGraphqlOptions) => Promise<Workflow>;
-/**
- * Options that can be used during instantiation of the SpiffCommerce Javascript Client.
- * Please refer to the documentation for more information.
- */
-interface ClientOptions {
-    /**
-     * When provided, the client will use the provided application key to
-     * authenticate with the SpiffCommerce API.
-     */
-    applicationKey?: string;
+interface LineItemMetadata {
+    stepName: string;
+    metadata: string;
 }
-interface GetBundleGraphqlAssetsOptions {
-    metadata?: boolean;
+interface ProductWorkflow {
+    friendlyName: string;
+    id: string;
+    index?: number;
+    present?: boolean;
+    imageUrl: string;
+    workflowName: string;
 }
-interface GetBundleGraphqlProductCollectionOptions {
-    eagerFetchProducts?: boolean;
+interface Partner {
+    id?: string;
+    name?: string;
+    currencyCode?: string;
+    customerDetailsPromptMarkdown?: string;
+    activeAddons?: AddonHandle[];
 }
-interface GetBundleGraphqlOptions {
-    productCollection?: GetBundleGraphqlProductCollectionOptions;
-    assets?: GetBundleGraphqlAssetsOptions;
-    additionalHeaders?: {
-        [key: string]: string;
-    };
+declare enum AddonHandle {
+    BackgroundRemover = "Background Remover",
+    ConversionAccelerator = "Conversion Accelerator",
+    ProcessBuilder = "ProcessBuilder"
 }
-interface GetBundleOptions {
+interface Product {
     /**
-     * Configuration for the graphQL request made for bundles. Allows for retrieval
-     * of additional data.
+     * ID of the partner owner.
      */
-    graphql?: GetBundleGraphqlOptions;
-}
-interface GetWorkflowGraphqlAssetsOptions {
-    metadata?: boolean;
-}
-interface GetWorkflowGraphqlOptions {
-    assets?: GetWorkflowGraphqlAssetsOptions;
-}
-interface GetWorkflowOptionsBase {
+    partnerId?: string;
+    partner?: Partner;
     /**
-     * An existing preview service to use, instead of creating a new one.
+     * Whether a line item for this product is delivered as soon as the order is received.
      */
-    previewService?: ThreeDPreviewService;
+    autoprint: boolean;
     /**
-     * Configuration related to the
-     * workflow and how the system interprets it.
+     * Whether this product can be quickprinted.
      */
-    workflowConfiguration?: {
-        /**
-         * False by default, when true the system will treat
-         * steps with a single variant
-         * as being renderable.
-         */
-        singleVariantsRenderable?: boolean;
-    };
+    canQuickprint?: boolean;
     /**
-     * Configuration for the graphQL request made for workflows. Allows for retrieval
-     * of additional data.
+     * The internal identifier for this product.
      */
-    graphql?: GetWorkflowGraphqlOptions;
-}
-interface GetWorkflowFromTransactionOptions extends GetWorkflowOptionsBase {
-    /** 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 extends GetWorkflowOptionsBase {
-    /** The workflow to load. */
-    workflowId: string;
-    integrationProductId: string;
-    /** An existing workflow state, if available. */
-    workflowState?: string;
-    type: "integration";
-}
-interface GetWorkflowFromExternalProductOptions extends GetWorkflowOptionsBase {
-    /** 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;
-    type: "external";
-}
-type GetNewWorkflowOptions = GetWorkflowFromIntegrationProductOptions | GetWorkflowFromExternalProductOptions;
-type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetNewWorkflowOptions;
-/**
- * The Spiff Commerce Javascript Client. Required for
- * creating workflow experiences.
- */
-declare class SpiffCommerceClient {
-    private options;
-    private initialized;
-    private currencyCode?;
-    private customer?;
+    id: string;
     /**
-     * @deprecated This object is passed to the WorkflowExperience constructor and is no longer needed on this object.
-     * Any functionality referencing this object will be removed in a future release.
+     * The human friendly name of the product.
      */
-    private experienceOptions?;
-    constructor(options: ClientOptions);
+    name: string;
     /**
-     * @returns The asset manager allows for common operations related to assets
-     * and the Spiff Commerce platform.
+     * A URL to the image asset associated with this product.
      */
-    getAssetManager(): AssetManager;
-    getCurrencyCode(): string;
-    getFlowService(): FlowService;
-    getIntegration(): Promise<{
+    imageUrl?: string;
+    /**
+     * A resource url for a 3D model used to represent this product
+     * in the 3d editor. If not available we assume the product doesn't support 3D.
+     */
+    modelUrl?: string;
+    /**
+     * A URL for the image used as an overlay on any workflows
+     * that incorporate a product overlay step.
+     */
+    overlayImageUrl?: string;
+    /**
+     * Words which can't be used in a workflow for this product.
+     */
+    profanities?: {
         id: string;
-        theme: Theme;
-        partner: Partner;
-        logo: string;
-    }>;
+        createdAt: string;
+        userId: string;
+        word: string;
+    }[];
     /**
-     * Attempts to load persisted authentication information from local storage, and authenticate with the Spiff Commerce API.
-     * @param bundleId The ID of the bundle you intend to load.
-     * @returns An object containing the success status of the authentication attempt, and the type of stakeholder when successful.
+     * The max characters that can be typed for quickprint.
      */
-    authenticateBundleFromLocalStorage(bundleId: string): Promise<{
-        stakeholderType?: StakeholderType;
-        success: boolean;
-    }>;
+    quickprintMaxLength?: number;
     /**
-     * Attempts to load persisted authentication information from local storage, and authenticate with the Spiff Commerce API.
-     * @param transactionId The ID of the transaction that the user is attempting to load.
-     * @returns An object containing the following:
-     * - `customLogoLink`: A link to a custom logo to display in the header.
-     * - `transactionReadOnly`: Whether or not the transaction is read-only. Shadow will not accept any changes to the transaction if this is set to true.
-     * - `stakeholderType`: The type of stakeholder that the user is authenticated as.
-     * - `success`: Whether or not the authentication was successful.
-     * @throws An error if the transaction is not found.
+     * The name of the module to use for quickprint.
      */
-    authenticateTransactionFromLocalStorage(transactionId: string): Promise<{
-        customLogoLink?: string;
-        transactionReadOnly?: boolean;
-        stakeholderType?: StakeholderType;
-        success: boolean;
-        theme?: Theme;
-    }>;
-    clearCustomer(): void;
-    clearCustomerForTransaction(transactionId: string): void;
-    getStakeholderTypeForTransaction(transactionId: string): StakeholderType | undefined;
-    getOrCreateCustomer(emailAddress: string): Promise<{
-        customer: Customer;
-        isAuthenticated: boolean;
-    }>;
-    private authenticateCustomerId;
+    quickprintModuleName?: string;
     /**
-     * Generates a verification code for the given email address.
-     * @param emailAddress The email address to generate a verification code for. The user will be sent an email with the verification code.
+     * If true, the product should be displayed in the client as if it is available.
+     * Should be displayed as if it is unavailable otherwise.
      */
-    generateVerificationCode(emailAddress: string): Promise<void>;
+    enabled: boolean;
     /**
-     * Verifies the given email address with the given verification code.
-     * @param emailAddress The email address to verify.
-     * @param verificationCode The verification code to verify the email address with.
-     * @returns True if the verification was successful, false otherwise.
+     * Workflows which have been assigned to this product.
      */
-    verifyCode(emailAddress: string, verificationCode: string): Promise<boolean>;
+    workflows?: ProductWorkflow[];
     /**
-     * @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.
+     * The base price of this product in sub units. Essentially the cost of the
+     * product without any customisations applied.
      */
-    getNewBundle(collectionId?: string, initialMetadata?: {
-        [key: string]: string;
-    }, options?: GetBundleOptions): Promise<Bundle>;
+    basePrice?: number;
+    /**
+     * The weight of this product.
+     */
+    weight?: number;
+    /**
+     * When specified, represents a pre-rendered image of this product to be
+     * displayed to customers while the 3D preview is loading.
+     */
+    preloadImageUrl?: string;
+    /**
+     * When set the store owner has configured this product to prompt for
+     * customer details. In hosted experience, we'll offer to collect this information from the customer. In
+     * bespoke UIs created using the Core SDK you will need to check this flag and request the data accordingly.
+     * See attachCustomerDetails on the WorkflowExperience for how to supply us with the details you collect.
+     */
+    promptForCustomerDetails?: boolean;
+    /**
+     * Configuration for conversion. Optional.
+     */
+    conversionConfiguration?: ConversionConfiguration;
+    integrationProducts?: IntegrationProductResource[];
+    productTags?: ProductTag[];
+    /**
+     * The SKU of the product in the merchant's store.
+     */
+    sku?: string;
+    /**
+     * The Spiff SKU code for the product.
+     */
+    skuCode?: string;
+    /**
+     * Price breaks for this product when dealing with quantity.
+     */
+    priceBreaks?: ProductPriceBreak[];
+}
+/**
+ * A price break represents a minimum quantity of a product and the price that will be charged for that quantity.
+ * This can be seen as an override for the base price of the product.
+ */
+interface ProductPriceBreak {
+    /**
+     * The id of this price break.
+     */
+    id: string;
+    /**
+     * The minimum quantity of this price break. A positive integer.
+     */
+    minQty: number;
+    /**
+     * A percentage to apply to the overall price. A value between 0-1 where 1 retains 100% of the original price and 0 completely discounts it to free.
+     */
+    percentage: number;
+}
+interface ProductTag {
+    id: string;
+    name: string;
+}
+interface ColorOption {
+    id?: string;
+    fill?: string;
+    stroke?: string;
+    variant?: VariantResource;
+    colorProfileAssetKey?: string;
+}
+interface RegionElement {
+    id: string;
+    region?: Region;
+}
+interface FrameMetadata {
+    image: string;
+}
+interface IllustrationMetadata {
+    colors: string[];
+}
+interface ModuleMetadata {
+    text: string;
+}
+interface TextMetadata {
+    color?: string;
+    text: string;
+    fillImage?: string;
+}
+interface SelectionStorage {
+    selectedVariants?: VariantResource[];
+}
+interface TextStepStorage extends SelectionStorage {
+    color?: string;
+    defaultCleared?: boolean;
+    inputText?: string;
+    text?: string;
+    customiseAllText?: boolean;
+}
+type StepSelections = {
+    [key: string]: SelectionStorage;
+};
+interface FrameData {
     /**
-     * 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.
-     * @param graphqlOptions Optional: Options to configure loading the workflow.
-     * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
+     * The path data for a frame SVG
      */
-    getExistingBundle(bundleId: string, previewService?: ThreeDPreviewService, 
+    path: string;
     /**
-     * @deprecated use GetBundleOptions instead. This attribute will be removed in the future.
+     *  The viewbox width
      */
-    graphqlOptions?: GetBundleGraphqlOptions, options?: GetBundleOptions): Promise<Bundle>;
+    width: number;
     /**
-     * Retrieves all existing bundle stakeholders from the API, for the currently authenticated customer.
-     * @returns An array of bundle stakeholders.
+     * The viewbox height.
      */
-    getBundleStakeholders(): Promise<BundleStakeholder[]>;
+    height: number;
+}
+interface FrameThresholdSettings {
+    useThreshold: boolean;
+    invertThreshold: boolean;
+    threshold: number;
+    thresholdSaturation: number;
+}
+/**
+ * Defines the different behaviors supported by the camera system
+ * for control when viewing a product.
+ */
+declare enum ProductCameraRig {
+    Orbit = 0,
+    Pan = 1
+}
+/**
+ * Defines the locations at which a conversion attempt can take place.
+ */
+declare enum ConversionLocation {
     /**
-     * Creates a new instance of WorkflowExperience. A high level wrapper for workflows.
-     * @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.
+     * The client should expose a flow for allowing the user to optionally input details at any point.
      */
-    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: Workflow) => ThreeDPreviewService, options?: GetWorkflowOptions): Promise<WorkflowExperience>;
+    Manual = "Manual",
     /**
-     * Gets multiple workflow experiences at once.
-     * @param optionsArray An array of options to configure loading the transactions and workflows.
-     * NOTE: The `previewService` field on the option is currently unsupported in this function, as loading multiple models at once will likely cause performance issues.
-     * @param graphqlOptions Options to configure loading the workflows.
-     * @returns An array of workflow experiences configured as requested.
+     *  The client should show the conversion flow at the beginning of a workflow.
      */
-    getWorkflowExperiences(optionsArray: GetWorkflowOptions[], graphqlOptions?: GetWorkflowGraphqlOptions): Promise<WorkflowExperience[]>;
+    OnStart = "OnStart",
     /**
-     * Initialize the client from an integration product.
-     * @param integrationProductId The integration product to use.
-     * @deprecated Use getWorkflowExperience to initialize the experience.
+     * The client should allow the user to input details just before quitting the experience.
      */
-    initFromIntegrationProduct(integrationProductId: string): Promise<void>;
+    OnQuit = "OnQuit",
     /**
-     * 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.
+     * The client should ask the user for details prior to adding to cart.
      */
-    initFromTransaction(transactionId: string, readOnly?: boolean): Promise<void>;
+    OnEnd = "OnEnd"
+}
+/**
+ * The data configured to be requested.
+ */
+declare enum ConversionDataType {
+    Email = "Email",
+    FirstName = "FirstName",
+    LastName = "LastName",
+    Phone = "Phone"
+}
+interface ConversionData {
+    type: ConversionDataType;
+    mandatory: boolean;
+}
+/**
+ * The configuration for conversion, exposed on products currently.
+ */
+interface ConversionConfiguration {
+    id: string;
+    name?: string;
+    locations: ConversionLocation[];
+    requestedData: ConversionDataType[];
+    requestedDataItems: ConversionData[];
+    mandatory?: boolean;
+}
+/**
+ * Someone who has used a workflow experience and entered their contact details.
+ */
+interface Customer {
+    id?: string;
+    emailAddress: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+    loginToken?: string;
+    partner?: Partner;
+    stakeholders?: Stakeholder[];
+    bundleStakeholders?: BundleStakeholder[];
+}
+interface CustomerDetailsInput {
+    emailAddress: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+}
+declare enum StakeholderType {
+    Owner = "Owner",
+    Approver = "Approver",
+    Editor = "Editor",
+    Viewer = "Viewer"
+}
+interface Stakeholder {
+    id: string;
+    type?: StakeholderType;
+    transaction?: Transaction;
+    customer?: Customer;
+}
+interface Bundle {
+    id?: string;
+    bundleOwnerId?: string;
+    bundleStakeholders?: BundleStakeholder[];
+    bundleStateData?: string;
+    metadata?: {
+        key: string;
+        value: string;
+    }[];
+    name?: string;
+    partner?: Partner;
+    productCollection?: ProductCollectionResource;
+    transactions?: Transaction[];
+}
+interface BundleStakeholder {
+    id: string;
+    bundle?: Bundle;
+    customer?: Customer;
+    type?: StakeholderType;
+}
+interface BundleStakeholderInput {
+    type: StakeholderType;
+    customerDetails: CustomerDetailsInput;
+}
+type ProductCollectionResource = {
+    id: string;
+    globalPropertyConfiguration?: GlobalPropertyConfiguration;
+    productCollectionProducts?: ProductCollectionProductResource[];
+    name: string;
+    transformCollection?: TransformCollection;
+};
+type ProductCollectionProductResource = {
+    id: string;
+    productCollection?: ProductCollectionResource;
+    productCollectionId?: string;
+    product: Product;
+    productId: string;
+    workflowId?: string;
+};
+type GlobalPropertyState = {
+    id: string;
+    aspects: GlobalPropertyStateAspect[];
+};
+type GlobalPropertyStateAspect = {
+    name: string;
+    value: string;
+    type?: AspectType;
+    storage?: GlobalPropertyStateAspectStorage;
+};
+type GlobalPropertyStateAspectStorage = GlobalPropertyStateFileUploadStorage;
+type GlobalPropertyStateFileUploadStorage = {
+    originalAssetKey?: string;
+    backgroundRemovedAssetKey?: string;
+    useOriginalAsset?: boolean;
+};
+interface BundleStateTransform {
+    position: Vector3;
+    rotation: Vector3;
+    scale: Vector3;
+}
+interface Vector3 {
+    x: number;
+    y: number;
+    z: number;
+}
+interface TransformCollection {
+    id: string;
+    name: string;
+    transforms: TransformCollectionTransform[];
+}
+interface TransformCollectionTransform {
+    id: string;
+    name: string;
+    position: Vector3;
+    rotation: Vector3;
+    scale: Vector3;
+}
+type Extendable<T> = T & {
+    [key: string]: any;
+};
+
+interface StorageService {
     /**
-     * @deprecated Remove when the initFrom functions are removed.
+     * Get a value.
+     * @param key The key to lookup the value with.
      */
-    private getWorkflowExperienceDeprecated;
+    get(key: string): string | undefined;
     /**
-     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `workflowExperience.getWorkflowManager().getPreviewService()` instead.
-     * @returns The preview service that was provided during construction.
+     * Set a value.
+     * @param key The key to set.
+     * @param val The new value.
      */
-    getPreviewService(): ThreeDPreviewService | undefined;
+    set(key: string, val: string): void;
     /**
-     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `WorkflowManager.getProduct()` instead.
-     * @returns The product associated with this client.
+     * Remove a value.
+     * @param key The key to remove, does nothing if the key doesn't exist.
      */
-    getProduct(): Product;
+    remove(key: string): void;
     /**
-     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `WorkflowManager.getTransaction()` instead.
-     * @returns The transaction associated with this client.
+     * Get a map from persistence.
+     * @param key The key to search by.
      */
-    getTransaction(): Transaction;
-    configureUrls(hubUrl: string, serverUrl: string, servicesApiUrl: string): void;
+    getMap<K = any, V = any>(key: string): Map<K, V> | undefined;
     /**
-     * A function used to synchronize transaction state with the server.
-     * @param options New state details. To be spread into the query.
-     * @returns
+     * St a map into persistence.
+     * @param key The key to set the map at.
+     * @param val The map to set.
      */
-    private updateTransactionState;
-    storeCustomer(customer: Customer): void;
-    getIntegrationProductById(integrationProductId: string): Promise<IntegrationProduct>;
-    getIntegrationProductFromExternalIds(externalIntegrationId: string, externalProductId: string): Promise<IntegrationProduct>;
-    getIntegrationProduct(options: Extendable<{
-        type: "integration";
-        integrationProductId: string;
-    }> | Extendable<{
-        type: "external";
-        externalIntegrationId: string;
-        externalProductId: string;
-    }>): Promise<IntegrationProduct>;
+    setMap<K = any, V = any>(key: string, val: Map<K, V>): void;
 }
+declare const persistenceService: StorageService;
 
 declare class Configuration {
     private readonly defaultServerUrl;
@@ -2915,6 +2926,9 @@ declare class DigitalContentStepService implements StepService<DigitalContentSte
 declare const digitalContentStepService: DigitalContentStepService;
 
 declare class MockWorkflowManager implements WorkflowManager {
+    private client;
+    getClient(): SpiffCommerceClient;
+    setClient(client: SpiffCommerceClient): void;
     getInitializationPromise(): Promise<void>;
     getProduct: () => Product;
     isInitialized(): boolean;
@@ -3185,6 +3199,7 @@ declare class FrameStepHandle extends StepHandle<FrameStepData> {
      * @param storeAsOriginal Optional: Store this asset as the original, unmodified version of the image. Default: `true`.
      */
     selectImage(asset: Asset, storeAsOriginal?: boolean): Promise<void>;
+    canUseBackgroundRemover(): Promise<boolean>;
     /**
      * Removes the background from an image, stores it in the state, and returns the new asset.
      * @param applyNewAsset Optionally applies the new asset as the current image selection. Default: `true`.
@@ -3279,4 +3294,4 @@ declare class PromiseCache {
 }
 declare const promiseCache: PromiseCache;
 
-export { ArrayInput, AssetNotFoundError, Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ColorOptionGlobalPropertyHandle, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextGlobalPropertyHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };
+export { AddonHandle, ArrayInput, AssetNotFoundError, Bundle$1 as Bundle, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, CollectionProduct, ColorOption, ColorOptionGlobalPropertyHandle, ConditionalGlobalPropertiesChangedEventData, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextGlobalPropertyHandle, TextInput, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection$1 as TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };