@spiffcommerce/core 0.10.233 → 0.10.235

package/dist/types.d.ts

@@ -567,6 +567,8 @@ export interface DesignCreationMessage {
     weight?: number;
     designProductId?: string;
     designProductVariantId?: string;
+    externalCartProductId?: string;
+    externalCartProductVariantId?: string;
     event: string;
     exportedData: ExportedData;
     lineItemImageUrl: string;
@@ -643,13 +645,25 @@ export interface Transaction {
      * to this transaction, null unless the createDesignProduct flag was set
      * and the design was finalized using createDesign operation.
      */
+    /**@deprecated use externalCartProductVariantId instead of this moving forward */
     externalDesignProductVariantId?: string;
     /**
      * 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.
      */
+    /**@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;
     /**
      * The amount of variations associated with this transaction.
@@ -791,6 +805,10 @@ interface Product {
      * Configuration for bulk creations
      */
     bulkConfiguration?: BulkConfiguration;
+    /**
+     * Configuration for conversion. Optional.
+     */
+    conversionConfiguration?: ConversionConfiguration;
 }
 interface ColorOption {
     id?: string;
@@ -884,6 +902,42 @@ interface BulkConfiguration {
     maxVariations: number;
     pricingStrategy: BulkPriceCalculationStrategy;
 }
+/**
+ * Defines the locations at which a conversion attempt can take place.
+ */
+export enum ConversionLocation {
+    /**
+     * The client should expose a flow for allowing the user to optionally input details at any point.
+     */
+    Manual = "Manual",
+    /**
+     *  The client should show the conversion flow at the beginning of a workflow.
+     */
+    OnStart = "OnStart",
+    /**
+     * The client should allow the user to input details just before quiting the experience.
+     */
+    OnQuit = "OnQuit",
+    /**
+     * The client should ask the user for details prior to adding to cart.
+     */
+    OnEnd = "OnEnd"
+}
+/**
+ * The data configured to be requested.
+ */
+export enum ConversionData {
+    Email = "Email"
+}
+/**
+ * The configuration for conversion, exposed on products currently.
+ */
+export interface ConversionConfiguration {
+    id: string;
+    name?: string;
+    locations: ConversionLocation[];
+    requestedData: ConversionData[];
+}
 interface StorageService {
     /**
      * Get a value.

package/package.json

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