@spiffcommerce/core 0.10.203 → 0.10.205

package/dist/types.d.ts

@@ -581,6 +581,9 @@ export interface WorkflowManager {
     getInformationResults(): InformationResult[];
     getServer(): ServerService;
     getTransaction: () => Transaction;
+    setTransactionCustomerDetails: (details: {
+        email: string;
+    }) => void;
     getWorkflow: () => _Workflow1;
     getWorkflowSelections: () => WorkflowSelections;
     getProduct: () => Product;
@@ -867,6 +870,13 @@ interface Product {
      * 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;
 }
 interface ColorOption {
     id?: string;
@@ -1543,6 +1553,17 @@ export interface WorkflowExperience {
      * @param scene The scene you want the steps for.
      */
     getStepsByScene(scene: StepGroup): StepHandle<_AnyStepData1>[];
+    /**
+     * 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.
+     */
+    attachCustomerDetails(details: {
+        /**
+         * An email used for things like sending a design to the user.
+         */
+        email: string;
+    }): Promise<void>;
     /**
      * 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.
@@ -1685,6 +1706,7 @@ export class MockWorkflowManager implements WorkflowManager {
     getTransaction(): {
         id: string;
     };
+    setTransactionCustomerDetails(): void;
     getWorkflow(): {
         id: string;
         name: string;

package/package.json

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