@artisan-commerce/analytics-web 0.2.0-canary.140 → 0.2.0-canary.142

package/dist/bundle.d.ts

@@ -34,8 +34,13 @@ interface GoogleAnalyticsProviderConfig {
  * @extends EventCommonParams
  * @property {Function} callback Fired when event is resolved
  */
-interface GoogleAnalyticsCommonEventParams extends EventCommonParams {
+interface GoogleAnalyticsCommonEventParams extends EventCommonParams, EcommerceCommonParams {
     callback?: () => void;
+    storeId?: string;
+    storeName?: string;
+    vendorId?: string;
+    ocassion?: "delivery" | "pickup" | "coupon";
+    items?: Gtag.Item[];
 }
 /**
  * Google Analytics custom event shared parameters.
@@ -46,6 +51,12 @@ interface GoogleAnalyticsCommonEventParams extends EventCommonParams {
 interface GoogleAnalyticsCustomEventParams {
     [key: string]: any;
 }
+interface CommonGoogleAnalyticsEventParams {
+    /** The item that the user is selecting */
+    item: Gtag.Item;
+    /** Param used to add `item_list_name` outside the items array */
+    list?: string;
+}
 declare namespace Gtag {
     interface Gtag {
         (command: "config", targetId: string, config?: ControlParams | EventParams | CustomParams): void;
@@ -87,22 +98,33 @@ declare namespace Gtag {
     }
     type Currency = string | number;
     interface Item {
-        brand?: string;
-        category?: string;
+        item_id?: string;
+        item_name?: string;
+        affiliation?: string;
+        coupon?: string;
+        currency?: CurrencyCodes;
         creative_name?: string;
         creative_slot?: string;
-        currency?: string;
+        discount?: number;
         index?: number;
         item_brand?: string;
         item_category?: string;
-        item_id?: string;
+        item_category2?: string;
+        item_category3?: string;
+        item_category4?: string;
+        item_category5?: string;
         item_list_id?: string;
         item_list_name?: string;
-        item_name?: string;
         item_variant?: string;
         location_id?: string;
-        price?: Currency;
+        price_in_usd?: number;
+        price?: number;
+        promotion_id?: string;
+        promotion_name?: string;
         quantity?: number;
+        original_item?: string;
+        item_revenue_in_usd?: number;
+        item_revenue?: number;
     }
     interface Promotion {
         creative_name?: string;
@@ -414,6 +436,29 @@ interface EventCommonParams {
     isAnonymous?: boolean;
     currency?: CurrencyCodes;
 }
+interface EcommerceCommonParams {
+    total_item_quantity?: number;
+    purchase_revenue_in_usd?: number;
+    purchase_revenue?: number;
+    refund_value_in_usd?: number;
+    refund_value?: number;
+    shipping_value_in_usd?: number;
+    shipping_value?: number;
+    tax_value_in_usd?: number;
+    tax_value?: number;
+    unique_items?: string;
+    transaction_id?: string;
+    payment_type?: string;
+    coupon?: boolean;
+    currency?: CurrencyCodes;
+}
+interface UserProperties {
+    first_open_time?: boolean;
+    user_type?: "registered" | "anonymous";
+    user_status?: "new" | "returning";
+    ga_session_id?: string;
+    ga_session_number?: string;
+}
 
 /**
  * Facebook Pixel Provider constructor configuration.
@@ -926,7 +971,7 @@ type SelectWorkflowParams = SelectWorkflowParams$3 & SelectWorkflowParams$2 & Se
  * @extends GoogleAnalyticsCustomEventParams
  * @extends SetVendorCommonParams
  */
-interface SetVendorParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, SetVendorCommonParams {
+interface SetVendorParams$3 extends Omit<GoogleAnalyticsCommonEventParams, "vendorId">, GoogleAnalyticsCustomEventParams, SetVendorCommonParams {
 }
 
 /**
@@ -1354,7 +1399,7 @@ interface ViewCartParams$2 extends FacebookPixelCommonEventParams, FacebookPixel
  * @property {Product[]} products The products in the cart
  */
 interface ViewCartParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, ViewCartCommonParams {
-    products: Product[];
+    products?: Product[];
 }
 
 /**
@@ -1362,12 +1407,9 @@ interface ViewCartParams$1 extends SegmentCommonEventParams, SegmentCustomEventP
  *
  * @interface ViewCartCommonParams
  * @since 0.1.0
- * @property {string} cartId Shopping cart identifier
- * @property {string} cartName Shopping cart name
  */
 interface ViewCartCommonParams {
-    cartId: ShoppingCart["id"];
-    cartName?: ShoppingCart["name"];
+    shoppingCart?: ShoppingCart;
 }
 /**
  * viewCart event params.
@@ -1574,7 +1616,7 @@ type RemoveProductFromWishlistParams = RemoveProductFromWishlistParams$3 & Remov
  * @extends GoogleAnalyticsCustomEventParams
  * @extends RemoveProductFromCartCommonParams
  */
-interface RemoveProductFromCartParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, RemoveProductFromCartCommonParams {
+interface RemoveProductFromCartParams$3 extends Omit<GoogleAnalyticsCommonEventParams, "storeId" | "storeName">, GoogleAnalyticsCustomEventParams, RemoveProductFromCartCommonParams {
 }
 
 /**
@@ -1618,7 +1660,8 @@ interface RemoveProductFromCartCommonParams {
     product: CartProduct;
     cartId: ShoppingCart["id"];
     cartName?: ShoppingCart["name"];
-    store: Store;
+    storeId: Store["storeId"];
+    storeName: Store["storeName"];
     priceCategory?: PriceCategoryType;
 }
 /**
@@ -1756,7 +1799,7 @@ type AddProductToWishlistParams = AddProductToWishlistParams$3 & AddProductToWis
  * @extends GoogleAnalyticsCustomEventParams
  * @extends AddProductToCartCommonParams
  */
-interface AddProductToCartParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, AddProductToCartCommonParams {
+interface AddProductToCartParams$3 extends Omit<GoogleAnalyticsCommonEventParams, "storeId" | "storeName">, GoogleAnalyticsCustomEventParams, AddProductToCartCommonParams {
 }
 
 /**
@@ -1790,18 +1833,22 @@ interface AddProductToCartParams$1 extends SegmentCommonEventParams, SegmentCust
  *
  * @interface AddProductToCartCommonParams
  * @since 0.1.0
- * @property {CartProduct} product The product that was added to the cart
- * @property {string} cartId Shopping cart identifier
- * @property {string} cartName Shopping cart name
- * @property {Store} store Store where the user is buying the product
- * @property {PriceCategoryType} priceCategory The product price category identifier
  */
 interface AddProductToCartCommonParams {
+    /** The product ID that was added to the cart */
     product: CartProduct;
+    /** Shopping cart identifier */
     cartId: ShoppingCart["id"];
+    /** Shopping cart name */
     cartName?: ShoppingCart["name"];
-    store: Store;
+    /** The store ID where the user is buying the product */
+    storeId: Store["storeId"];
+    /** The store name where the user is buying the product */
+    storeName: Store["storeName"];
+    /** The product price category identifier */
     priceCategory?: PriceCategoryType;
+    /** Param used to add `item_list_name` inside the items array */
+    list: CommonGoogleAnalyticsEventParams["list"];
 }
 /**
  * addProductToCart event params.
@@ -2097,7 +2144,7 @@ interface PurchaseSuccessParams$1 extends SegmentCommonEventParams, SegmentCusto
  */
 interface PurchaseSuccessCommonParams {
     /** The order shopping cart */
-    shoppingCart: ShoppingCart;
+    shoppingCart?: ShoppingCart;
     /** The selected payment type (e.g. Cash, Card) */
     selectedPaymentType: PaymentType;
     /** The workflow name (e.g. Delivery) */
@@ -2296,12 +2343,12 @@ interface ViewProductDetailsParams$1 extends SegmentCommonEventParams, SegmentCu
  *
  * @interface ViewProductDetailsCommonParams
  * @since 0.1.0
- * @property {Product} product the product that the details are being viewed
- * @property {string} categoryId if the user came from a category list, the category id
  */
 interface ViewProductDetailsCommonParams {
+    /** The details of the product that the user is viewing */
     product: Product;
-    categorId?: string;
+    /** The list that the product belongs to, this is used to add `item_list_name` to the items array */
+    list?: string;
 }
 /**
  * viewProductDetails event params.
@@ -3635,6 +3682,138 @@ interface RequestAssistanceCommonParams {
  */
 type RequestAssistanceParams = RequestAssistanceParams$3 & RequestAssistanceParams$2 & RequestAssistanceParams$1;
 
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectPromotionParams
+ * @since 0.1.0
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ */
+interface SelectPromotionParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, CommonGoogleAnalyticsEventParams {
+    promotionId?: string;
+    promotionName?: string;
+    creativeName?: string;
+    creativeSlot?: string;
+    originalItem?: Gtag.Item;
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewPromotionParams
+ * @since 0.1.0
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ */
+interface ViewPromotionParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, CommonGoogleAnalyticsEventParams {
+    promotionId?: string;
+    promotionName?: string;
+    creativeName?: string;
+    creativeSlot?: string;
+    originalItem?: Gtag.Item;
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectItemParams
+ * @since 0.1.0
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ */
+interface SelectItemParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, CommonGoogleAnalyticsEventParams {
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectItemParams
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends SelectItemCommonParams
+ */
+interface SelectItemParams$2 extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, SelectItemCommonParams {
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectItemParams
+ * @since 0.1.0
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends SelectItemCommonParams
+ */
+interface SelectItemParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, SelectItemCommonParams {
+}
+
+/**
+ * selectItem event interface
+ *
+ * @interface SelectItemCommonParams
+ * @since 0.1.0
+ */
+interface SelectItemCommonParams {
+}
+/**
+ * selectItem event params.
+ *
+ * @typedef SelectItemParams
+ * @since 0.1.0
+ */
+type SelectItemParams = SelectItemParams$3 & SelectItemParams$2 & SelectItemParams$1;
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewItemListParams
+ * @since 0.1.0
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ */
+interface ViewItemListParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, CommonGoogleAnalyticsEventParams {
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewItemListParams
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends ViewItemListCommonParams
+ */
+interface ViewItemListParams$2 extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, ViewItemListCommonParams {
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewItemListParams
+ * @since 0.1.0
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends CategoryImpressionCommonParams
+ */
+interface ViewItemListParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, ViewItemListCommonParams {
+}
+
+/**
+ * viewItemList event interface
+ *
+ * @interface ViewItemListCommonParams
+ * @since 0.1.0
+ */
+interface ViewItemListCommonParams {
+}
+/**
+ * viewItemList event params.
+ *
+ * @typedef ViewItemListParams
+ * @since 0.1.0
+ */
+type ViewItemListParams = ViewItemListParams$3 & ViewItemListParams$2 & ViewItemListParams$1;
+
 /**
  * Event allowed parameters.
  *
@@ -4825,9 +5004,9 @@ type SearchCategoryAttemptParams = SearchCategoryAttemptParams$3 & SearchCategor
  * @since 0.1.0
  * @extends GoogleAnalyticsCommonEventParams
  * @extends GoogleAnalyticsCustomEventParams
- * @property {string} itemBrand The item brand (e.g. El Español)
  */
 interface CategoryImpressionParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, CategoryImpressionCommonParams {
+    /** The item brand (e.g. El Español) */
     itemBrand?: string;
 }
 
@@ -4860,16 +5039,18 @@ interface CategoryImpressionParams$1 extends SegmentCommonEventParams, SegmentCu
  *
  * @interface CategoryImpressionCommonParams
  * @since 0.1.0
- * @property {Category} category the category a user had an impression on
- * @property {string} list the name of the list where the category is
- * @property {number} position the position in a list where the category is
- * @property {number} duration how long in milliseconds the user had an impression before interacting with the category or left
  */
 interface CategoryImpressionCommonParams {
+    /** The category the user is viewing */
     category: Category;
+    /** The name of the list where the category is */
     list?: string;
+    /** The position in a list where the category is */
     position?: number;
+    /** How long in milliseconds the user had an impression before interacting with the category or left */
     duration?: number;
+    /** `item_category` send inside items array */
+    itemCategory?: string;
 }
 /**
  * categoryImpression event params.
@@ -5682,6 +5863,12 @@ declare const events: {
         logOutOfCoverage: (params?: OutOfCoverageParams) => void;
         logSetLocation: (params?: SetLocationParams) => void;
     };
+    global: {
+        logViewItemList: (params: ViewItemListParams) => void;
+        logSelectItem: (params: SelectItemParams) => void;
+        logViewPromotion: (params: ViewPromotionParams) => void;
+        logSelectPromotion: (params: SelectPromotionParams) => void;
+    };
     help: {
         logRequestAssistance: (params: RequestAssistanceParams) => void;
     };
@@ -5786,5 +5973,7 @@ declare const identifyUser: (identify: Segment$1.Traits) => void;
  */
 declare const checkInit: () => boolean;
 
-export { Fbq, Gtag, Providers, Segment$1 as Segment, checkInit, events, identifyUser, initAnalytics, updateActiveVendor };
-export type { AnalyticsMeta, AnalyticsProvidersConfigs, AuthProviderMethods, FacebookConversionsApiConfig, FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, FacebookPixelProvider, FacebookPixelProviderConfig, GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, GoogleAnalyticsProvider, GoogleAnalyticsProviderConfig, InitAnalyticsConfig, InitAnalyticsConfigMeta, SegmentCommonEventParams, SegmentCustomEventParams, SegmentProvider, SegmentProviderConfig, SupportedProviders };
+declare const toItemProduct: (product: CartProduct) => Gtag.Item[];
+
+export { Fbq, Gtag, Providers, Segment$1 as Segment, checkInit, events, identifyUser, initAnalytics, toItemProduct, updateActiveVendor };
+export type { AnalyticsMeta, AnalyticsProvidersConfigs, AuthProviderMethods, CommonGoogleAnalyticsEventParams, FacebookConversionsApiConfig, FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, FacebookPixelProvider, FacebookPixelProviderConfig, GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, GoogleAnalyticsProvider, GoogleAnalyticsProviderConfig, InitAnalyticsConfig, InitAnalyticsConfigMeta, SegmentCommonEventParams, SegmentCustomEventParams, SegmentProvider, SegmentProviderConfig, SupportedProviders, UserProperties };