@spiffcommerce/core 1.0.0 → 1.1.0

package/dist/types.d.ts

@@ -492,6 +492,11 @@ export interface WorkflowManager {
     getWorkflowMetadata: () => WorkflowMetadata;
     getInformationResults(): InformationResult[];
     getTransaction: () => Transaction;
+    getTransactionCustomer: () => Customer | undefined;
+    setTransactionCustomer: (customer: Customer) => void;
+    /**
+     * @deprecated Use setTransactionCustomer instead.
+     */
     setTransactionCustomerDetails: (details: {
         email: string;
     }) => void;
@@ -935,8 +940,15 @@ export enum ConversionLocation {
 /**
  * The data configured to be requested.
  */
-export enum ConversionData {
-    Email = "Email"
+export enum ConversionDataType {
+    Email = "Email",
+    FirstName = "FirstName",
+    LastName = "LastName",
+    Phone = "Phone"
+}
+export interface ConversionData {
+    type: ConversionDataType;
+    mandatory: boolean;
 }
 /**
  * The configuration for conversion, exposed on products currently.
@@ -948,6 +960,34 @@ export interface ConversionConfiguration {
     requestedData: ConversionData[];
     mandatory?: boolean;
 }
+/**
+ * Someone who has used a workflow experience and entered their contact details.
+ */
+export interface Customer {
+    id?: string;
+    emailAddress: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+}
+export interface CustomerDetailsInput {
+    emailAddress: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+}
+enum StakeholderType {
+    Owner = "Owner",
+    Approver = "Approver",
+    Editor = "Editor",
+    Viewer = "Viewer"
+}
+export interface Stakeholder {
+    id: string;
+    type?: StakeholderType;
+    transaction?: Transaction;
+    customer?: Customer;
+}
 interface StorageService {
     /**
      * Get a value.
@@ -1616,6 +1656,7 @@ export interface WorkflowExperience {
      * 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.
      */
     attachCustomerDetails(details: {
         /**
@@ -1623,6 +1664,12 @@ export interface WorkflowExperience {
          */
         email: string;
     }): Promise<void>;
+    /**
+     * 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.
+     */
+    assignCustomerDetails(details: CustomerDetailsInput): 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.
@@ -1762,6 +1809,8 @@ export class MockWorkflowManager implements WorkflowManager {
     getTransaction(): {
         id: string;
     };
+    getTransactionCustomer(): undefined;
+    setTransactionCustomer(): void;
     setTransactionCustomerDetails(): void;
     getWorkflow(): {
         id: string;

package/package.json

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