@artisan-commerce/analytics-rn 0.3.0-canary.149 → 0.3.0-canary.151

package/dist/bundle.d.ts

@@ -155,7 +155,13 @@ interface GoogleAnalyticsProviderConfig {
  * @since 0.1.0
  * @extends EventCommonParams
  */
-interface GoogleAnalyticsCommonEventParams extends EventCommonParams {
+interface GoogleAnalyticsCommonEventParams extends EventCommonParams, EcommerceCommonParams {
+    callback?: () => void;
+    store_id?: string;
+    store_name?: string;
+    vendor_id?: string;
+    ocassion?: "delivery" | "pickup" | "coupon";
+    items?: Gtag.Item[];
 }
 /**
  * Google Analytics custom event shared parameters.
@@ -168,10 +174,11 @@ interface GoogleAnalyticsCustomEventParams {
 }
 declare namespace Gtag {
     interface Item {
-        item_id: string;
-        item_name: string;
+        item_id?: string;
+        item_name?: string;
         affiliation?: string;
         coupon?: string;
+        currency?: CurrencyCodes;
         creative_name?: string;
         creative_slot?: string;
         discount?: number;
@@ -186,10 +193,14 @@ declare namespace Gtag {
         item_list_name?: string;
         item_variant?: string;
         location_id?: string;
+        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;
     }
 }
 
@@ -256,6 +267,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.
@@ -1276,7 +1310,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 {
 }
 
 /**
@@ -1320,7 +1354,8 @@ interface RemoveProductFromCartCommonParams {
     product: CartProduct;
     cartId: ShoppingCart["id"];
     cartName?: ShoppingCart["name"];
-    store: Store;
+    storeId: Store["storeId"];
+    storeName: Store["storeName"];
     priceCategory?: PriceCategoryType;
 }
 /**
@@ -1492,18 +1527,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 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?: string;
 }
 /**
  * addProductToCart event params.
@@ -1998,12 +2037,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.
@@ -3337,6 +3376,219 @@ interface RequestAssistanceCommonParams {
  */
 type RequestAssistanceParams = RequestAssistanceParams$3 & RequestAssistanceParams$2 & RequestAssistanceParams$1;
 
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewPromotionParams
+ * @since 0.1.0
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ */
+interface ViewPromotionParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams {
+    promotionId?: string;
+    promotionName?: string;
+    creativeName?: string;
+    creativeSlot?: string;
+    originalItem?: Gtag.Item;
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewPromotionParams
+ * @since 0.1.0
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ */
+interface ViewPromotionParams$2 extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams {
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewPromotionParams
+ * @since 0.1.0
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends ViewPromotionCommonParams
+ */
+interface ViewPromotionParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, ViewPromotionCommonParams {
+}
+
+/**
+ * viewPromotion event interface
+ *
+ * @interface ViewPromotionCommonParams
+ * @since 0.1.0
+ */
+interface ViewPromotionCommonParams {
+}
+/**
+ * viewPromotion event params.
+ *
+ * @typedef ViewPromotionParams
+ * @since 0.1.0
+ */
+type ViewPromotionParams = ViewPromotionParams$3 & ViewPromotionParams$2 & ViewPromotionParams$1;
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectPromotionParams
+ * @since 0.1.0
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ */
+interface SelectPromotionParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams {
+    promotionId?: string;
+    promotionName?: string;
+    creativeName?: string;
+    creativeSlot?: string;
+    originalItem?: Gtag.Item;
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectPromotionParams
+ * @since 0.1.0
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ */
+interface SelectPromotionParams$2 extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams {
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectPromotionParams
+ * @since 0.1.0
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends SelectPromotionCommonParams
+ */
+interface SelectPromotionParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, SelectPromotionCommonParams {
+}
+
+/**
+ * selectPromotion event interface
+ *
+ * @interface SelectPromotionCommonParams
+ * @since 0.1.0
+ */
+interface SelectPromotionCommonParams {
+}
+/**
+ * selectItem event params.
+ *
+ * @typedef SelectPromotionParams
+ * @since 0.1.0
+ */
+type SelectPromotionParams = SelectPromotionParams$3 & SelectPromotionParams$2 & SelectPromotionParams$1;
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectItemParams
+ * @since 0.1.0
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ */
+interface ViewItemListParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams {
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewItemListParams
+ * @since 0.1.0
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ */
+interface ViewItemListParams$2 extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams {
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewItemListParams
+ * @since 0.1.0
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends ViewItemListCommonParams
+ */
+interface ViewItemListParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, ViewItemListCommonParams {
+}
+
+/**
+ * viewItemList event interface
+ *
+ * @interface ViewItemListCommonParams
+ * @since 0.1.0
+ */
+interface ViewItemListCommonParams {
+}
+/**
+ * selectItem event params.
+ *
+ * @typedef ViewItemListParams
+ * @since 0.1.0
+ */
+type ViewItemListParams = ViewItemListParams$3 & ViewItemListParams$2 & ViewItemListParams$1;
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectItemParams
+ * @since 0.1.0
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ */
+interface SelectItemParams$3 extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams {
+    item?: Gtag.Item;
+    list?: string;
+}
+
+/**
+ * Event allowed parameters.
+ *
+ * @interface SetLocationParams
+ * @since 0.1.0
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends SetLocationCommonParams
+ */
+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.
  *
@@ -5384,6 +5636,12 @@ declare const events: {
         logOutOfCoverage: (params?: OutOfCoverageParams) => void;
         logSetLocation: (params?: SetLocationParams) => void;
     };
+    global: {
+        logSelectItem: (params?: SelectItemParams) => void;
+        logViewItemList: (params?: ViewItemListParams) => void;
+        logSelectPromotion: (params?: SelectPromotionParams) => void;
+        logViewPromotion: (params?: ViewPromotionParams) => void;
+    };
     help: {
         logRequestAssistance: (params: RequestAssistanceParams) => void;
     };
@@ -5472,5 +5730,7 @@ declare const events: {
  */
 declare const updateActiveVendor: (vendor: Vendor | Vendor["id"] | -1 | undefined) => void;
 
-export { Gtag, Providers, events, initAnalytics, updateActiveVendor };
-export type { AnalyticsMeta, AuthProviderMethods, FacebookConversionsApiConfig, FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, FacebookPixelProvider, FacebookPixelProviderConfig, GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, GoogleAnalyticsProvider, GoogleAnalyticsProviderConfig, InitAnalyticsConfig, InitAnalyticsConfigMeta, SupportedProviders };
+declare const toItemProduct: (product: CartProduct) => Gtag.Item[];
+
+export { Gtag, Providers, events, initAnalytics, toItemProduct, updateActiveVendor };
+export type { AnalyticsMeta, AuthProviderMethods, FacebookConversionsApiConfig, FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, FacebookPixelProvider, FacebookPixelProviderConfig, GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, GoogleAnalyticsProvider, GoogleAnalyticsProviderConfig, InitAnalyticsConfig, InitAnalyticsConfigMeta, SupportedProviders, UserProperties };