@spiffcommerce/core 0.10.234 → 0.10.236

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/types.d.ts CHANGED
@@ -660,9 +660,9 @@ export interface Transaction {
660
660
  */
661
661
  externalCartProductId?: string;
662
662
  /**
663
- * The external product variant id representing the product related to the transaction.
664
- * This value can hold any type of transaction such as design and standard products.
665
- */
663
+ * The external product variant id representing the product related to the transaction.
664
+ * This value can hold any type of transaction such as design and standard products.
665
+ */
666
666
  externalCartProductVariantId?: string;
667
667
  priceModifierTotal?: number;
668
668
  /**
@@ -805,6 +805,10 @@ interface Product {
805
805
  * Configuration for bulk creations
806
806
  */
807
807
  bulkConfiguration?: BulkConfiguration;
808
+ /**
809
+ * Configuration for conversion. Optional.
810
+ */
811
+ conversionConfiguration?: ConversionConfiguration;
808
812
  }
809
813
  interface ColorOption {
810
814
  id?: string;
@@ -898,6 +902,42 @@ interface BulkConfiguration {
898
902
  maxVariations: number;
899
903
  pricingStrategy: BulkPriceCalculationStrategy;
900
904
  }
905
+ /**
906
+ * Defines the locations at which a conversion attempt can take place.
907
+ */
908
+ export enum ConversionLocation {
909
+ /**
910
+ * The client should expose a flow for allowing the user to optionally input details at any point.
911
+ */
912
+ Manual = "Manual",
913
+ /**
914
+ * The client should show the conversion flow at the beginning of a workflow.
915
+ */
916
+ OnStart = "OnStart",
917
+ /**
918
+ * The client should allow the user to input details just before quiting the experience.
919
+ */
920
+ OnQuit = "OnQuit",
921
+ /**
922
+ * The client should ask the user for details prior to adding to cart.
923
+ */
924
+ OnEnd = "OnEnd"
925
+ }
926
+ /**
927
+ * The data configured to be requested.
928
+ */
929
+ export enum ConversionData {
930
+ Email = "Email"
931
+ }
932
+ /**
933
+ * The configuration for conversion, exposed on products currently.
934
+ */
935
+ export interface ConversionConfiguration {
936
+ id: string;
937
+ name?: string;
938
+ locations: ConversionLocation[];
939
+ requestedData: ConversionData[];
940
+ }
901
941
  interface StorageService {
902
942
  /**
903
943
  * Get a value.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spiffcommerce/core",
3
- "version": "0.10.234",
3
+ "version": "0.10.236",
4
4
  "description": "Core client API for interacting with the Spiff Commerce backend.",
5
5
  "source": "src/index.ts",
6
6
  "main": "dist/main.js",