Update analytics ecommerce event and param types (#2728)

Author: hsubox76

packages/analytics-types/index.d.ts

@@ -143,6 +143,13 @@ export interface EventParams {
   value?: number;
   event_label?: string;
   event_category?: string;
+  shipping_tier?: string;
+  item_list_id?: string;
+  item_list_name?: string;
+  promotion_id?: string;
+  promotion_name?: string;
+  payment_type?: string;
+  affiliation?: string;
 }
 
 /**
@@ -158,6 +165,7 @@ export interface CustomParams {
  */
 export type EventNameString =
   | 'add_payment_info'
+  | 'add_shipping_info'
   | 'add_to_cart'
   | 'add_to_wishlist'
   | 'begin_checkout'
@@ -172,10 +180,13 @@ export type EventNameString =
   | 'screen_view'
   | 'search'
   | 'select_content'
+  | 'select_item'
+  | 'select_promotion'
   | 'set_checkout_option'
   | 'share'
   | 'sign_up'
   | 'timing_complete'
+  | 'view_cart'
   | 'view_item'
   | 'view_item_list'
   | 'view_promotion'
@@ -184,17 +195,39 @@ export type EventNameString =
 export type Currency = string | number;
 
 export interface Item {
-  brand?: string;
-  category?: string;
+  item_id?: string;
+  item_name?: string;
+  item_brand?: string;
+  item_category?: string;
+  item_category2?: string;
+  item_category3?: string;
+  item_category4?: string;
+  item_category5?: string;
+  item_variant?: string;
+  price?: Currency;
+  quantity?: number;
+  index?: string;
+  coupon?: string;
+  item_list_name?: string;
+  item_list_id?: string;
+  discount?: Currency;
+  affiliation?: string;
   creative_name?: string;
   creative_slot?: string;
-  id?: string;
+  promotion_id?: string;
+  promotion_name?: string;
   location_id?: string;
+  /** @deprecated Use item_brand instead. */
+  brand?: string;
+  /** @deprecated Use item_category instead. */
+  category?: string;
+  /** @deprecated Use item_id instead. */
+  id?: string;
+  /** @deprecated Use item_name instead. */
   name?: string;
-  price?: Currency;
-  quantity?: number;
 }
 
+/** @deprecated Use Item instead. */
 export interface Promotion {
   creative_name?: string;
   creative_slot?: string;

packages/analytics/src/constants.ts

@@ -34,10 +34,12 @@ export enum GtagCommand {
  * Any other string is also allowed.
  */
 export enum EventName {
+  ADD_SHIPPING_INFO = 'add_shipping_info',
   ADD_PAYMENT_INFO = 'add_payment_info',
   ADD_TO_CART = 'add_to_cart',
   ADD_TO_WISHLIST = 'add_to_wishlist',
   BEGIN_CHECKOUT = 'begin_checkout',
+  /** @deprecated */
   CHECKOUT_PROGRESS = 'checkout_progress',
   EXCEPTION = 'exception',
   GENERATE_LEAD = 'generate_lead',
@@ -49,10 +51,14 @@ export enum EventName {
   SCREEN_VIEW = 'screen_view',
   SEARCH = 'search',
   SELECT_CONTENT = 'select_content',
+  SELECT_ITEM = 'select_item',
+  SELECT_PROMOTION = 'select_promotion',
+  /** @deprecated */
   SET_CHECKOUT_OPTION = 'set_checkout_option',
   SHARE = 'share',
   SIGN_UP = 'sign_up',
   TIMING_COMPLETE = 'timing_complete',
+  VIEW_CART = 'view_cart',
   VIEW_ITEM = 'view_item',
   VIEW_ITEM_LIST = 'view_item_list',
   VIEW_PROMOTION = 'view_promotion',