@spiffcommerce/core 32.3.1 → 32.4.0-beta.31f8a4dd-4f9f-572b-8792-9d8d6243c25e

package/CHANGELOG.md

@@ -14,6 +14,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [33.0.0] - 14-10-2025
+
+## Changed
+
+- Updated `WorkflowExperience` to store `transaction`, `product`, `profanityList`, and `workflow` as direct properties, initialized in the constructor for improved encapsulation and performance.
+
+## Added
+
+- Added new methods to `WorkflowExperience`: `getProduct()`, `getProfanityList()`, `setProduct(integrationProductId: string)`, `getTransaction()`, `getWorkflow()`, and `setWorkflow(workflow: Workflow)` for easier access and mutation of core experience data.
+- Introduced `getIntegrationProductIds()` and `addIntegrationProductId(id: string)` methods to `Bundle` and `BundleImpl` for tracking associated integration product IDs.
+- Added GraphQL mutation for updating a transaction's integration product, enabling backend synchronization of integration product changes.
+- Added `getState()` method to `BundleStateManager` for easier external access to the current bundle state.
+
+## [32.4.0] - 16-10-2025
+
+## Added
+
+- The interface `GetWorkflowFromIntegrationProductOptions` now has optional `quantity` and `recipient` arguments.
+
 ## [32.3.1] - 09-10-2025
 
 ## Added

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { FunctionComponent, ReactNode } from 'preact/compat';
 import * as _apollo_client_core from '@apollo/client/core';
 import { OperationVariables, QueryOptions, ApolloQueryResult, DefaultContext, MutationOptions, FetchResult, ApolloClient } from '@apollo/client/core';
-import { RenderableContextService, RenderableContext, ThreeDPreviewService, ModelContainer } from '@spiffcommerce/preview';
+import { RenderableContextService, RenderableContext, ModelContainer, ThreeDPreviewService } from '@spiffcommerce/preview';
 import * as lodash from 'lodash';
 import { CompleteQuoteMessage, ThemeInstallConfigurationGraphQl, ConversionConfiguration } from '@spiffcommerce/theme-bridge';
 export { ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation } from '@spiffcommerce/theme-bridge';
@@ -1049,16 +1049,10 @@ interface Scene {
  * State related to a workflow experience.
  */
 interface ExperienceOptions {
-    product: Product;
     transaction: Transaction;
     workflow?: Workflow;
-    /**
-     * @deprecated favor inject / eject functions.
-     */
-    previewService?: ThreeDPreviewService;
     modelContainer?: ModelContainer;
     renderableContextService?: LayoutPreviewService;
-    layouts: ILayout[];
     reloadedState?: LayoutsState;
     /**
      * When true the experience is intended to be immutable.
@@ -1094,6 +1088,10 @@ interface ExperienceOptions {
  * should get an instance of this class from a Client you have constructed previously.
  */
 interface WorkflowExperience {
+    /**
+     * Get the current transaction for this experience.
+     */
+    getTransaction(): Transaction;
     /**
      * Get the bundle this experience is part of. May be undefined.
      */
@@ -1102,6 +1100,28 @@ interface WorkflowExperience {
      * Set the bundle this experience is part of. Can be cleared using undefined.
      */
     setBundle(bundle: Bundle$1 | undefined): any;
+    /**
+     * Get the current product for this experience. May be undefined.
+     */
+    getProduct(): Product | undefined;
+    /**
+     * Get the current profanity list for this experience. May be empty.
+     */
+    getProfanityList(): string[];
+    /**
+     * Set the current product for this experience.
+     * @param product The new product to set.
+     */
+    setProduct(integrationProductId: string): Promise<void>;
+    /**
+     * Get the current workflow for this experience. May be undefined.
+     */
+    getWorkflow(): Workflow | undefined;
+    /**
+     * Set the current workflow for this experience.
+     * @param workflow The new workflow to set.
+     */
+    setWorkflow(workflow: Workflow): Promise<void>;
     /**
      * Returns the client that was responsible for spawning this experience.
      */
@@ -1290,7 +1310,7 @@ declare enum WorkflowExperienceEventType {
 }
 declare class WorkflowExperienceImpl implements WorkflowExperience {
     readonly client: SpiffCommerceClient;
-    readonly commandContext: CommandContext;
+    readonly transaction: Transaction;
     readonly graphQlClient: GraphQlClientFunc;
     readonly workflowManager: WorkflowManager;
     readonly isReadOnly: boolean;
@@ -1299,11 +1319,20 @@ declare class WorkflowExperienceImpl implements WorkflowExperience {
      * Bundle this experience has been added to.
      */
     private bundle?;
+    private product?;
+    private profanityList;
+    private workflow?;
     private currentPriceBreak;
     private renderableScenes;
     private renderableSceneCallbacks;
     private eventCallbacks;
     constructor(client: SpiffCommerceClient, experienceOptions: ExperienceOptions);
+    getTransaction(): Transaction;
+    getProduct(): Product | undefined;
+    getProfanityList(): string[];
+    setProduct(integrationProductId: string): Promise<void>;
+    getWorkflow(): Workflow | undefined;
+    setWorkflow(workflow: Workflow): Promise<void>;
     attachAddress(streetAddress?: string, apartment?: string, city?: string, country?: string, state?: string, postCode?: string): Promise<void>;
     attachOrganization(name: string): Promise<void>;
     getBundle(): Bundle$1 | undefined;
@@ -1784,6 +1813,9 @@ declare class Transform {
 }
 declare const getProductCollections: (ids: string[]) => Promise<ProductCollection[] | undefined>;
 
+interface BundleIntegrationProductsAddedEventData {
+    integrationProductIds: string[];
+}
 interface ConditionalGlobalPropertiesChangedEventData {
     globalProperties: GlobalPropertyHandle[];
 }
@@ -1801,6 +1833,7 @@ interface WorkflowExperienceAddedEventData {
 interface WorkflowExperienceRemovedEventData extends WorkflowExperienceAddedEventData {
 }
 type BundleEventMap = {
+    "bundle-integration-products-added": BundleIntegrationProductsAddedEventData;
     "conditional-global-properties-changed": ConditionalGlobalPropertiesChangedEventData;
     "global-properties-mandatory-changed": GlobalPropertiesMandatoryChangedEventData;
     "workflow-experience-hover-enter": WorkflowExperienceHoverEventData;
@@ -1809,7 +1842,7 @@ type BundleEventMap = {
     "workflow-experience-removed": WorkflowExperienceRemovedEventData;
 };
 type BundleEventType = keyof BundleEventMap;
-type BundleEventData = WorkflowExperienceHoverEventData | ConditionalGlobalPropertiesChangedEventData | WorkflowExperienceAddedEventData;
+type BundleEventData = BundleIntegrationProductsAddedEventData | WorkflowExperienceHoverEventData | ConditionalGlobalPropertiesChangedEventData | WorkflowExperienceAddedEventData;
 type BundleEvent<K extends BundleEventType = BundleEventType> = BundleEventMap[K];
 
 /**
@@ -2053,6 +2086,8 @@ interface Bundle$1 {
     generateQuoteId(): Promise<string>;
     getQuoteCompleteMessage(): CompleteQuoteMessage;
     applyGlobalPropertyState(state: GlobalPropertyState): Promise<void>;
+    getIntegrationProductIds(): undefined | string[];
+    addIntegrationProductId(id: string): void;
 }
 
 /**
@@ -2357,27 +2392,32 @@ interface GetWorkflowFromTransactionOptions extends GetWorkflowOptionsBase {
     workflowState?: string;
     type: "transaction";
 }
-interface GetNewWorkflowOptionsBase extends GetWorkflowOptionsBase {
+interface GetNewWorkflowExperienceOptionsBase extends GetWorkflowOptionsBase {
     /** A name for the new transaction. */
     designName?: string;
     /** The workflow to load. */
-    workflowId: string;
+    workflowId?: string;
     /** An existing workflow state, if available. */
     workflowState?: string;
 }
-interface GetWorkflowFromIntegrationProductOptions extends GetNewWorkflowOptionsBase {
+interface GetWorkflowExperienceFromBlankOptions extends GetNewWorkflowExperienceOptionsBase {
+    type: "blank";
+}
+interface GetWorkflowExperienceFromIntegrationProductOptions extends GetNewWorkflowExperienceOptionsBase {
     integrationProductId: string;
+    quantity?: number;
+    recipient?: any;
     type: "integration";
 }
-interface GetWorkflowFromExternalProductOptions extends GetNewWorkflowOptionsBase {
+interface GetWorkflowExperienceFromExternalProductOptions extends GetNewWorkflowExperienceOptionsBase {
     /** The external ID associated with an integration. */
     externalIntegrationId: string;
     /** The ID of the product from the external system. */
     externalProductId: string;
     type: "external";
 }
-type GetNewWorkflowOptions = GetWorkflowFromIntegrationProductOptions | GetWorkflowFromExternalProductOptions;
-type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetNewWorkflowOptions;
+type GetNewWorkflowExperienceOptions = GetWorkflowExperienceFromBlankOptions | GetWorkflowExperienceFromIntegrationProductOptions | GetWorkflowExperienceFromExternalProductOptions;
+type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetNewWorkflowExperienceOptions;
 interface ClientConfiguration {
     hubUrl: string;
     serverUrl: string;
@@ -2657,7 +2697,6 @@ interface WorkflowManager {
     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;
@@ -2665,19 +2704,22 @@ interface WorkflowManager {
     getMetadata: (stepName: string) => StepMetadata | undefined;
     getWorkflowMetadata: () => WorkflowMetadata;
     getInformationResults(): InformationResult[];
-    getTransaction: () => Transaction;
     getTransactionCustomer: () => Customer | undefined;
     setTransactionCustomer: (customer: Customer) => void;
+    /**
+     * Sets the current workflow for this experience.
+     * @param workflow The new workflow to set.
+     * @returns A promise that resolves when the workflow has been set.
+     */
+    setWorkflow: (workflow: Workflow) => Promise<void>;
     /**
      * @deprecated Use setTransactionCustomer instead.
      */
     setTransactionCustomerDetails: (details: {
         email: string;
     }) => void;
-    getWorkflow: () => Workflow;
     getWorkflowSelections: () => WorkflowSelections;
     getStepSelections: () => StepSelections;
-    getProduct: () => Product;
     /**
      * A promise resolving when the initial state of the workflow has completed loading.
      */
@@ -5176,6 +5218,7 @@ declare class MockWorkflowManager implements WorkflowManager {
     getWorkflowExperience(): WorkflowExperience;
     setClient(client: SpiffCommerceClient): void;
     getInitializationPromise(): Promise<void>;
+    setWorkflow: (workflow: Workflow) => Promise<void>;
     getProduct: () => Product;
     isInitialized(): boolean;
     getCommandContext: () => CommandContext;
@@ -5206,7 +5249,6 @@ declare class MockWorkflowManager implements WorkflowManager {
     getPreviewService(): undefined;
     setModelContainer: (container: any) => void;
     getModelContainer(): undefined;
-    getProfanities(): never[];
     getRegionElements(_stepName: string): never[];
     getSerializedStep(_stepName: string, _serializedSteps: SerializableStep[]): undefined;
     getStepSpecificServices(_stepName: string): undefined;
@@ -6032,4 +6074,4 @@ declare const overrideWorkflowExperienceRecipientAddress: (workflowExperience: W
  */
 declare const getGlobalPropertyStateForBundle: (bundleId: string) => Promise<GlobalPropertyState | undefined>;
 
-export { AddonHandle, type AddressComponent, type AddressValidationJob, AddressValidationJobStatus, type AddressValidationResult, AddressValidationResultConfirmationLevel, AddressValidationStatus, type Animatable, type AnyStepData, ArrayInput, AspectType, type Asset, type AssetConfiguration, AssetNotFoundError, type AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, type Bundle$1 as Bundle, BundleDesignCreationCartAddMode, type BundleDesignCreationMessage, type BundleEvent, type BundleEventData, type BundleEventType, type Bundle as BundleRaw, type BundleStakeholder, CanvasCommand, CollectionProduct, type ColorDefinition, type ColorOption, ColorOptionGlobalPropertyHandle, type ColorProfileProps, CommandContext, type CommandState, type Condition, type ConditionalGlobalPropertiesChangedEventData, CreateElementCommand, CreateLayoutCommand, CurrencyContext, CurrencyService, type Customer, type CustomerDetailsInput, DeleteElementCommand, type DesignCreationMessage, type DesignCreationProgressUpdate, type DesignInputStep, type DigitalContentStepData, DigitalContentStepHandle, type EditedSteps, type ExportedStepData, type ExportedStepDataProperty, type ExportedStepDataPropertyType, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, type FrameElement, FrameService, FrameStep, type FrameStepData, FrameStepHandle, type FrameThresholdSettings, type GetNewWorkflowOptions, type GetWorkflowOptions, type GlobalPropertiesMandatoryChangedEventData, type GlobalPropertyConfiguration, GlobalPropertyHandle, GroupCommand, type ILayout, type IllustrationElement, type IllustrationStepData, IllustrationStepHandle, type ImageElement, InformationMessageType, type InformationResult, type InformationStepData, InformationStepHandle, type Integration, type IntegrationOptionResource, IntegrationProduct, IntegrationType, type LayoutComponentConfiguration, type LayoutData, type LayoutElement, LayoutElementFactory, LayoutElementType, LayoutNotFoundError, LayoutRenderingPurpose, type LayoutState, type LayoutsState, type MandatorySteps, MaterialEffectMode, type MaterialStepData, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, type ModelStepData, ModelStepHandle, type ModuleStepData, ModuleStepHandle, MoveCommand, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, type OptionResource, type Order, type OrderItem, type PapyrusComponent, ParseError, type PictureStepData, PictureStepHandle, type Placeable, type PmsSearchResult, type Point, type Product, ProductCameraRig, ProductCollection, ProductCollectionProductSortKey, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, type QuestionStepData, QuestionStepHandle, QueueablePromise, type Recipient, type Region, type RegionElement, type RenderableScene, ResizeCommand, ResourceNotFoundError, RotateCommand, type SavedDesign, ScaleAxis, type SelectionStorage, SendBackwardsCommand, type ShapeStepData, ShapeStepHandle, type ShareAction, ShareActionType, type SilentIllustrationStepData, SpiffCommerceClient, type Stakeholder, StakeholderType, type StateMutationFunc, type Step, type StepAspect, StepAspectType, type StepElements, type StepGroup, StepHandle, type StepStorage, StepType, TextAlgorithm, TextChangeCommand, type TextChangeResult, TextGlobalPropertyHandle, TextInput, type TextStepData, TextStepHandle, type TextStepStorage, type TextboxElement, type Theme, type ToastCallback, type Transaction, Transform, TransformCollection$1 as TransformCollection, UnhandledBehaviorError, UnitOfMeasurement, UpdateImageSourceCommand, Variant, type VariantResource, type Vector3, type Workflow, type WorkflowExperience, WorkflowExperienceEventType, type WorkflowExperienceHoverEventData, WorkflowExperienceImpl, type WorkflowManager, type WorkflowMetadata, type WorkflowPanel, type WorkflowScene, type WorkflowSelections, type WorkflowStorage, assetService, browserColorToHex, cmPerPixel, createDesign, currentDirection, dataUrlFromExternalUrl, deleteBundle, designService, determineCorrectFontSizeAndLines, digitalContentStepService, domParser, duplicateBundle, duplicateTransaction, fetchAsString, findAngle, findElement, findPmsColors, frameDataCache, frameStepService, generate, generateCommands, generateSVGWithUnknownColors, generateStateFromDesignInputSteps, getAddressValidationJobs, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getBoundedOffsets, getBundleThemeConfiguration, getCustomer, getCustomerBundles, getElementVertices, getFrameData, getGlobalPropertyStateForBundle, getIntegration, getNEPoint, getNWPoint, getOrderedTransactions, getOverrideThemeConfiguration, getPointOfRotation, getProductCollections, getSEPoint, getSvgElement, getTemplateBundles, getTemplateTransactions, getTransaction, getTransactionThemeConfiguration, getTransactionsForBundle, getTrueCoordinates, getUnorderedTransactions, getValidationJobsForWorkflowExperiences, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, isCloseToValue, loadFont, matchHexToPms, materialStepService, metafieldManager, mmPerPixel, modelStepService, modifySVGColors, moduleStepService, nameBundle, nameTransaction, optionService, outlineFontsInSvg, overrideWorkflowExperienceRecipientAddress, patternImageDataCache, persistenceService, pictureStepService, pmsToRgb, questionStepService, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, rgbToPms, rotateAroundPoint, sanitizeSvgTree, setBearerAuthenticationToken, setCanvasModule, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, svgColorValueToDefinition, svgStringDimensions, svgToDataUrl, textStepService, toast, validateWorkflowExperienceRecipient, validateWorkflowExperienceRecipients, xmlSerializer };
+export { AddonHandle, type AddressComponent, type AddressValidationJob, AddressValidationJobStatus, type AddressValidationResult, AddressValidationResultConfirmationLevel, AddressValidationStatus, type Animatable, type AnyStepData, ArrayInput, AspectType, type Asset, type AssetConfiguration, AssetNotFoundError, type AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, type Bundle$1 as Bundle, BundleDesignCreationCartAddMode, type BundleDesignCreationMessage, type BundleEvent, type BundleEventData, type BundleEventType, type Bundle as BundleRaw, type BundleStakeholder, CanvasCommand, CollectionProduct, type ColorDefinition, type ColorOption, ColorOptionGlobalPropertyHandle, type ColorProfileProps, CommandContext, type CommandState, type Condition, type ConditionalGlobalPropertiesChangedEventData, CreateElementCommand, CreateLayoutCommand, CurrencyContext, CurrencyService, type Customer, type CustomerDetailsInput, DeleteElementCommand, type DesignCreationMessage, type DesignCreationProgressUpdate, type DesignInputStep, type DigitalContentStepData, DigitalContentStepHandle, type EditedSteps, type ExportedStepData, type ExportedStepDataProperty, type ExportedStepDataPropertyType, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, type FrameElement, FrameService, FrameStep, type FrameStepData, FrameStepHandle, type FrameThresholdSettings, type GetNewWorkflowExperienceOptions as GetNewWorkflowOptions, type GetWorkflowOptions, type GlobalPropertiesMandatoryChangedEventData, type GlobalPropertyConfiguration, GlobalPropertyHandle, GroupCommand, type ILayout, type IllustrationElement, type IllustrationStepData, IllustrationStepHandle, type ImageElement, InformationMessageType, type InformationResult, type InformationStepData, InformationStepHandle, type Integration, type IntegrationOptionResource, IntegrationProduct, IntegrationType, type LayoutComponentConfiguration, type LayoutData, type LayoutElement, LayoutElementFactory, LayoutElementType, LayoutNotFoundError, LayoutRenderingPurpose, type LayoutState, type LayoutsState, type MandatorySteps, MaterialEffectMode, type MaterialStepData, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, type ModelStepData, ModelStepHandle, type ModuleStepData, ModuleStepHandle, MoveCommand, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, type OptionResource, type Order, type OrderItem, type PapyrusComponent, ParseError, type PictureStepData, PictureStepHandle, type Placeable, type PmsSearchResult, type Point, type Product, ProductCameraRig, ProductCollection, ProductCollectionProductSortKey, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, type QuestionStepData, QuestionStepHandle, QueueablePromise, type Recipient, type Region, type RegionElement, type RenderableScene, ResizeCommand, ResourceNotFoundError, RotateCommand, type SavedDesign, ScaleAxis, type SelectionStorage, SendBackwardsCommand, type ShapeStepData, ShapeStepHandle, type ShareAction, ShareActionType, type SilentIllustrationStepData, SpiffCommerceClient, type Stakeholder, StakeholderType, type StateMutationFunc, type Step, type StepAspect, StepAspectType, type StepElements, type StepGroup, StepHandle, type StepStorage, StepType, TextAlgorithm, TextChangeCommand, type TextChangeResult, TextGlobalPropertyHandle, TextInput, type TextStepData, TextStepHandle, type TextStepStorage, type TextboxElement, type Theme, type ToastCallback, type Transaction, Transform, TransformCollection$1 as TransformCollection, UnhandledBehaviorError, UnitOfMeasurement, UpdateImageSourceCommand, Variant, type VariantResource, type Vector3, type Workflow, type WorkflowExperience, WorkflowExperienceEventType, type WorkflowExperienceHoverEventData, WorkflowExperienceImpl, type WorkflowManager, type WorkflowMetadata, type WorkflowPanel, type WorkflowScene, type WorkflowSelections, type WorkflowStorage, assetService, browserColorToHex, cmPerPixel, createDesign, currentDirection, dataUrlFromExternalUrl, deleteBundle, designService, determineCorrectFontSizeAndLines, digitalContentStepService, domParser, duplicateBundle, duplicateTransaction, fetchAsString, findAngle, findElement, findPmsColors, frameDataCache, frameStepService, generate, generateCommands, generateSVGWithUnknownColors, generateStateFromDesignInputSteps, getAddressValidationJobs, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getBoundedOffsets, getBundleThemeConfiguration, getCustomer, getCustomerBundles, getElementVertices, getFrameData, getGlobalPropertyStateForBundle, getIntegration, getNEPoint, getNWPoint, getOrderedTransactions, getOverrideThemeConfiguration, getPointOfRotation, getProductCollections, getSEPoint, getSvgElement, getTemplateBundles, getTemplateTransactions, getTransaction, getTransactionThemeConfiguration, getTransactionsForBundle, getTrueCoordinates, getUnorderedTransactions, getValidationJobsForWorkflowExperiences, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, isCloseToValue, loadFont, matchHexToPms, materialStepService, metafieldManager, mmPerPixel, modelStepService, modifySVGColors, moduleStepService, nameBundle, nameTransaction, optionService, outlineFontsInSvg, overrideWorkflowExperienceRecipientAddress, patternImageDataCache, persistenceService, pictureStepService, pmsToRgb, questionStepService, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, rgbToPms, rotateAroundPoint, sanitizeSvgTree, setBearerAuthenticationToken, setCanvasModule, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, svgColorValueToDefinition, svgStringDimensions, svgToDataUrl, textStepService, toast, validateWorkflowExperienceRecipient, validateWorkflowExperienceRecipients, xmlSerializer };