@spiffcommerce/core 8.0.3 → 8.1.0

package/dist/types.d.ts

@@ -1805,6 +1805,7 @@ interface ClientOptions {
     /**
      * When set to true, the client will treat the workflow as a bulk order
      * containing multiple variations of the base design.
+     * @deprecated Specify when calling getWorkflowExperience instead.
      */
     bulk?: boolean;
     /**
@@ -1813,6 +1814,37 @@ interface ClientOptions {
      */
     applicationKey?: string;
 }
+interface GetWorkflowFromTransactionOptions {
+    /** The existing Transaction to use. */
+    transactionId: string;
+    /** If set to true, the workflow will display in a read-only mode. */
+    readOnly?: boolean;
+    /** An existing workflow state, if available. */
+    workflowState?: string;
+    type: "transaction";
+}
+interface GetWorkflowFromIntegrationProductOptions {
+    /** The workflow to load. */
+    workflowId: string;
+    integrationProductId: string;
+    /** An existing workflow state, if available. */
+    workflowState?: string;
+    bulk?: boolean;
+    type: "integration";
+}
+interface GetWorkflowFromExternalProductOptions {
+    /** The workflow to load. */
+    workflowId: string;
+    /** The external ID associated with an integration. */
+    externalIntegrationId: string;
+    /** The ID of the product from the external system. */
+    externalProductId: string;
+    /** An existing workflow state, if available. */
+    workflowState?: string;
+    bulk?: boolean;
+    type: "external";
+}
+export type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetWorkflowFromIntegrationProductOptions | GetWorkflowFromExternalProductOptions;
 /**
  * The Spiff Commerce Javascript Client. Required for
  * creating workflow experiences.
@@ -1828,22 +1860,25 @@ export class SpiffCommerceClient {
     /**
      * Initialize the client from an integration product.
      * @param integrationProductId The integration product to use.
+     * @deprecated Use getWorkflowExperience to initialize the experience.
      */
     initFromIntegrationProduct(integrationProductId: string): Promise<void>;
     /**
      * Initialize the client from an existing transaction.
      * @param transactionId The id of the transaction
      * @returns A promise resolving at initialization completion.
+     * @deprecated Use getWorkflowExperience to initialize the experience.
      */
     initFromTransaction(transactionId: string, readOnly?: boolean): Promise<void>;
     /**
      * Creates a new instance of WorkflowExperience. A high level wrapper for workflows.
-     * @param workflowId The id of the workflow to be run.
-     * @param workflowState An existing workflow state if available.
+     * @param workflowId The id of the workflow to be run. Deprecated: Provide options instead.
+     * @param workflowState An existing workflow state if available. Deprecated: Provide options instead.
      * @param previewServiceConstructor A function called during initialization. Takes a class implementing ThreeDPreviewService in return.
+     * @param options Options to configure loading the transaction and workflow.
      * @returns A workflow experience configured as requested.
      */
-    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: _Workflow1) => any): Promise<WorkflowExperience>;
+    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: _Workflow1) => any, options?: GetWorkflowOptions): Promise<WorkflowExperience>;
     /**
      * @returns The preview service that was provided during construction.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "8.0.3",
+    "version": "8.1.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",