@artisan-commerce/analytics-web 0.2.0-canary.32 → 0.2.0-canary.34

package/dist/bundle.d.ts

@@ -1,4 +1,4 @@
-import { CurrencyCodes, Account, Vendor, Store, Catalogue, ArtisnPlatform, Product, ShoppingCart, CartProduct, PriceCategoryType, ShippingAddress, BillingData, Category } from '@artisan-commerce/types';
+import { CurrencyCodes, Account, Vendor, Store, Catalogue, ArtisnPlatform, Product, ShoppingCart, CartProduct, PriceCategoryType, ShippingAddress, BillingData, Order, Category } from '@artisan-commerce/types';
 
 /**
  * Google Analytics Provider constructor configuration,
@@ -790,16 +790,16 @@ interface UpdateWorkflowParams$1 extends SegmentCommonEventParams, SegmentCustom
  * Workflow types.
  *
  * @typedef Workflow
- * @since 0.5.14
+ * @since 0.1.0
  */
 declare type Workflow = "Delivery" | "Pickup" | "Other";
 /**
  * PaymentType types
  *
  * @typedef PaymentType
- * @since 0.5.14
+ * @since 0.1.0
  */
-declare type PaymentType = "Credit" | "Debit" | "Cash" | "Dataphone" | "Other";
+declare type PaymentType = "Cash" | "Card" | "Dataphone" | "Other";
 
 /**
  * updateWorkflow event interface.
@@ -2051,29 +2051,29 @@ interface PurchaseSuccessParams$1 extends SegmentCommonEventParams, SegmentCusto
  * purchaseSuccess event interface
  *
  * @interface PurchaseSuccessCommonParams
- * @since 0.5.14
- * @property {ShoppingCart} shoppingCart The order shopping cart
- * @property {PaymentType} selectedPaymentType The selected payment type (e.g. Cash, Credit, Debit)
- * @property {Workflow} fulfillmentType The workflow name (e.g. Delivery)
- * @property {string} cardType If paying with card the card provider (e.g. visa)
- * @property {number} shippingAddressId The selected shipping address identifier
- * @property {number} billingInfoId The selected billing info identifier
- * @property {string} orderId The order identifier
+ * @since 0.1.0
  */
 interface PurchaseSuccessCommonParams {
+    /** The order shopping cart */
     shoppingCart: ShoppingCart;
+    /** The selected payment type (e.g. Cash, Card) */
     selectedPaymentType: PaymentType;
+    /** The workflow name (e.g. Delivery) */
     fulfillmentType: Workflow;
+    /** If paying with card the card provider (e.g. visa) */
     cardType?: string;
+    /** The selected shipping address identifier */
     shippingAddressId?: ShippingAddress["id"];
+    /** The selected billing info identifier */
     billingInfoId?: BillingData["id"];
-    orderId: string;
+    /** The order identifier */
+    orderId: Order["id"];
 }
 /**
  * purchaseSuccess event params.
  *
  * @typedef PurchaseSuccessParams
- * @since 0.5.14
+ * @since 0.1.0
  */
 declare type PurchaseSuccessParams = PurchaseSuccessParams$3 & PurchaseSuccessParams$2 & PurchaseSuccessParams$1;
 
@@ -2119,31 +2119,31 @@ interface PurchaseFailParams$1 extends SegmentCommonEventParams, SegmentCustomEv
  * purchaseFail event interface
  *
  * @interface PurchaseFailCommonParams
- * @since 0.5.14
- * @property {ShoppingCart} shoppingCart The order shopping cart
- * @property {string} errorMessage Server error message
- * @property {number} statusCode Server response status code
- * @property {PaymentType} selectedPaymentType The selected payment type (e.g. Cash, Credit, Debit)
- * @property {Workflow} fulfillmentType The workflow name (e.g. Delivery)
- * @property {string} cardType If paying with card the card provider (e.g. visa)
- * @property {number} shippingAddressId The selected shipping address identifier
- * @property {number} billingInfoId The selected billing info identifier
+ * @since 0.1.0
  */
 interface PurchaseFailCommonParams {
+    /** The order shopping cart */
     shoppingCart: ShoppingCart;
+    /** Server error message */
     errorMessage: string;
-    statusCode: number;
+    /** Server response status code */
+    statusCode?: number;
+    /** The selected payment type (e.g. Cash, Card) */
     selectedPaymentType: PaymentType;
+    /** The workflow name (e.g. Delivery) */
     fulfillmentType: Workflow;
+    /** If paying with card the card provider (e.g. visa) */
     cardType?: string;
+    /** The selected shipping address identifier */
     shippingAddressId?: ShippingAddress["id"];
+    /** The selected billing info identifier */
     billingInfoId?: BillingData["id"];
 }
 /**
  * purchaseFail event params.
  *
  * @typedef PurchaseFailParams
- * @since 0.5.14
+ * @since 0.1.0
  */
 declare type PurchaseFailParams = PurchaseFailParams$3 & PurchaseFailParams$2 & PurchaseFailParams$1;
 

package/dist/bundle.esm.js

@@ -35,7 +35,7 @@ const getState$1 = () => {
 
 var name = "@artisan-commerce/analytics-web";
 var description = "Artisn commerce analytics web library";
-var version = "0.2.0-canary.31";
+var version = "0.2.0-canary.33";
 var main = "./dist/bundle.cjs.js";
 var module = "./dist/bundle.esm.js";
 var types = "./dist/bundle.d.ts";
@@ -77,7 +77,7 @@ var dependencies = {
 };
 var devDependencies = {
 	"@artisan-commerce/products": "0.9.0-canary.23",
-	"@artisan-commerce/shopping-cart": "0.12.0-canary.30",
+	"@artisan-commerce/shopping-cart": "0.12.0-canary.31",
 	"@artisan-commerce/types": "0.14.0-canary.19",
 	"@babel/core": "^7.10.5",
 	"@babel/preset-env": "^7.10.4",