shopkit-analytics 1.0.1 → 1.0.3

package/dist/types.d.mts

@@ -3,7 +3,6 @@
  */
 declare enum EventType {
     PRODUCT_VIEW = "product_view",
-    STARTED_ORDER = "started_order",
     PAGE_VIEW = "page_view",
     BUTTON_CLICK = "button_click",
     FORM_SUBMISSION = "form_submission",
@@ -16,11 +15,6 @@ declare enum EventType {
     CHECKOUT_STARTED = "checkout_started",
     CHECKOUT_COMPLETED = "checkout_completed",
     SEARCH = "search",
-    CART_PAGE_LAND = "cart_page_land",
-    CLOSE_CART = "close_cart",
-    QUANTITY_CHANGE = "quantity_change",
-    FILTER_APPLIED = "filter_applied",
-    NEWSLETTER_SUBSCRIPTION = "newsletter_subscription",
     USER_SIGNUP = "user_signup",
     USER_LOGIN = "user_login",
     CUSTOM = "custom",
@@ -31,25 +25,11 @@ declare enum EventType {
     FORM_START = "form_start",
     ADD_PAYMENT_INFO = "add_payment_info",
     CART_VIEWED = "cart_viewed",
-    PAGES_SCREENS_PER_SESSION = "pages_screens_per_session",
     VIEW_CONTENT = "view_content",
     PURCHASE = "purchase",
     VIEW_SEARCH_RESULTS = "view_search_results",
     ORDER_PLACED = "order_placed",
     BEGIN_CHECKOUT = "begin_checkout",
-    ITEM_PURCHASED = "item_purchased",
-    UPDATE_CART = "update_cart",
-    CUSTOMER_REGISTERED = "customer_registered",
-    CUSTOMER_LOGGED_IN = "customer_logged_in",
-    SHOPIFY_CHECKOUT_UPDATED = "shopify_checkout_updated",
-    SHOPIFY_ABANDONED_CHECKOUT = "shopify_abandoned_checkout",
-    SHOPIFY_ORDER_FULFILLED = "shopify_order_fulfilled",
-    SHOPIFY_CHECKOUT_STARTED = "shopify_checkout_started",
-    SHOPIFY_ADD_TO_CART = "shopify_add_to_cart",
-    SHOPIFY_REMOVED_FROM_CART = "shopify_removed_from_cart",
-    SHOPIFY_UPDATE_CART = "shopify_update_cart",
-    SPINFORM_RESULT = "spinform_result",
-    COUPON_COPIED = "coupon_copied",
     STARTED_CHECKOUT_GK = "started_checkout_gk",
     MOBILE_ADDED_GK = "mobile_added_gk",
     ADDRESS_SELECTED_GK = "address_selected_gk",
@@ -59,17 +39,7 @@ declare enum EventType {
     ORDER_SUCCESS = "order_success",
     ORDER_COMPLETED = "order_completed",
     PIN_CODE_ADDED_GK = "pin_code_added_gk",
-    ADDRESS_ADDED_GK = "address_added_gk",
-    KP_MP_PHONE_NUMBER_LOGGED_IN = "kp_mp_phone_number_logged_in",
-    KP_PHONE_NUMBER_LOGGED_IN = "kp_phone_number_logged_in",
-    KP_MP_SHOPIFY_LOGGED_IN = "kp_mp_shopify_logged_in",
-    KP_MP_SUCCESSFULLY_LOGGED_OUT = "kp_mp_successfully_logged_out",
-    KP_WHATSAPP_LOGGED_IN = "kp_whatsapp_logged_in",
-    KP_MP_TRUECALLER_LOGGED_IN = "kp_mp_truecaller_logged_in",
-    KP_MP_WHATSAPP_LOGGED_IN = "kp_mp_whatsapp_logged_in",
-    KP_TRUECALLER_LOGGED_IN = "kp_truecaller_logged_in",
-    KP_SHOPIFY_LOGGED_IN = "kp_shopify_logged_in",
-    KP_SUCCESSFULLY_LOGGED_OUT = "kp_successfully_logged_out"
+    ADDRESS_ADDED_GK = "address_added_gk"
 }
 /**
  * Base event interface that all events should implement
@@ -77,6 +47,7 @@ declare enum EventType {
 interface BaseEvent {
     type: EventType;
     timestamp?: number;
+    eventId?: string;
     event_category?: string;
     description?: string;
     [key: string]: any;
@@ -424,22 +395,6 @@ interface ISearchEvent extends BaseEvent {
     content_ids: string[];
     resultsCount?: number;
 }
-/**
- * Filter applied event
- */
-interface IFilterAppliedEvent extends BaseEvent {
-    type: EventType.FILTER_APPLIED;
-    filterType: string;
-    filterValue: string | number | boolean;
-}
-/**
- * Newsletter subscription event
- */
-interface INewsletterSubscriptionEvent extends BaseEvent {
-    type: EventType.NEWSLETTER_SUBSCRIPTION;
-    email: string;
-    success: boolean;
-}
 /**
  * View content event (for Facebook Pixel ViewContent)
  */
@@ -603,170 +558,6 @@ interface IAddPaymentInfoEvent extends BaseEvent {
         variant?: string;
     }>;
 }
-/**
- * Item purchased event
- */
-interface IItemPurchasedEvent extends BaseEvent {
-    type: EventType.ITEM_PURCHASED;
-    productId: string;
-    productName: string;
-    price: number;
-    currency?: string;
-    quantity: number;
-    variant?: string;
-    orderId?: string;
-}
-/**
- * Update cart event
- */
-interface IUpdateCartEvent extends BaseEvent {
-    type: EventType.UPDATE_CART;
-    productId: string;
-    productName: string;
-    price: number;
-    currency?: string;
-    quantity: number;
-    variant?: string;
-}
-/**
- * Customer registered event
- */
-interface ICustomerRegisteredEvent extends BaseEvent {
-    type: EventType.CUSTOMER_REGISTERED;
-    userId: string;
-    email?: string;
-    phone?: string;
-    firstName?: string;
-    lastName?: string;
-}
-/**
- * Customer logged in event
- */
-interface ICustomerLoggedInEvent extends BaseEvent {
-    type: EventType.CUSTOMER_LOGGED_IN;
-    userId: string;
-    email?: string;
-    phone?: string;
-    method?: string;
-}
-/**
- * Shopify checkout updated event
- */
-interface IShopifyCheckoutUpdatedEvent extends BaseEvent {
-    type: EventType.SHOPIFY_CHECKOUT_UPDATED;
-    checkoutId: string;
-    cartValue: number;
-    currency?: string;
-    itemCount: number;
-    items: Array<{
-        productId: string;
-        productName: string;
-        price: number;
-        quantity: number;
-        variant?: string;
-    }>;
-}
-/**
- * Shopify abandoned checkout event
- */
-interface IShopifyAbandonedCheckoutEvent extends BaseEvent {
-    type: EventType.SHOPIFY_ABANDONED_CHECKOUT;
-    checkoutId: string;
-    cartValue: number;
-    currency?: string;
-    itemCount: number;
-    items: Array<{
-        productId: string;
-        productName: string;
-        price: number;
-        quantity: number;
-        variant?: string;
-    }>;
-}
-/**
- * Shopify order fulfilled event
- */
-interface IShopifyOrderFulfilledEvent extends BaseEvent {
-    type: EventType.SHOPIFY_ORDER_FULFILLED;
-    orderId: string;
-    cartValue: number;
-    currency?: string;
-    itemCount: number;
-    items: Array<{
-        productId: string;
-        productName: string;
-        price: number;
-        quantity: number;
-        variant?: string;
-    }>;
-}
-/**
- * Shopify checkout started event
- */
-interface IShopifyCheckoutStartedEvent extends BaseEvent {
-    type: EventType.SHOPIFY_CHECKOUT_STARTED;
-    checkoutId: string;
-    cartValue: number;
-    currency?: string;
-    itemCount: number;
-    items: Array<{
-        productId: string;
-        productName: string;
-        price: number;
-        quantity: number;
-        variant?: string;
-    }>;
-}
-/**
- * Shopify add to cart event
- */
-interface IShopifyAddToCartEvent extends BaseEvent {
-    type: EventType.SHOPIFY_ADD_TO_CART;
-    productId: string;
-    productName: string;
-    price: number;
-    currency?: string;
-    quantity: number;
-    variant?: string;
-}
-/**
- * Shopify remove from cart event
- */
-interface IShopifyRemoveFromCartEvent extends BaseEvent {
-    type: EventType.SHOPIFY_REMOVED_FROM_CART;
-    productId: string;
-    productName: string;
-    price: number;
-    currency?: string;
-    quantity: number;
-    variant?: string;
-}
-/**
- * Shopify update cart event
- */
-interface IShopifyUpdateCartEvent extends BaseEvent {
-    type: EventType.SHOPIFY_UPDATE_CART;
-    productId: string;
-    productName: string;
-    price: number;
-    currency?: string;
-    quantity: number;
-    variant?: string;
-}
-/**
- * Spinform result event
- */
-interface ISpinformResultEvent extends BaseEvent {
-    type: EventType.SPINFORM_RESULT;
-    result?: string;
-}
-/**
- * Coupon copied event
- */
-interface ICouponCopiedEvent extends BaseEvent {
-    type: EventType.COUPON_COPIED;
-    couponCode?: string;
-}
 /**
  * Started checkout GK event
  */
@@ -829,34 +620,6 @@ interface IOrderCompletedEvent extends BaseEvent {
     amount?: number;
     currency?: string;
 }
-/**
- * Cart page land event
- */
-interface ICartPageLandEvent extends BaseEvent {
-    type: EventType.CART_PAGE_LAND;
-    event_category: string;
-    description: string;
-}
-/**
- * Close cart event
- */
-interface ICloseCartEvent extends BaseEvent {
-    type: EventType.CLOSE_CART;
-    event_category: string;
-    description: string;
-}
-/**
- * Quantity change event
- */
-interface IQuantityChangeEvent extends BaseEvent {
-    type: EventType.QUANTITY_CHANGE;
-    event_category: string;
-    description: string;
-    productId: string;
-    productName: string;
-    price: number;
-    quantity: number;
-}
 /**
  * PIN code added GK event
  */
@@ -871,105 +634,6 @@ interface IAddressAddedGKEvent extends BaseEvent {
     type: EventType.ADDRESS_ADDED_GK;
     addressId?: string;
 }
-/**
- * KP MP phone number logged in event
- */
-interface IKPMPPhoneNumberLoggedInEvent extends BaseEvent {
-    type: EventType.KP_MP_PHONE_NUMBER_LOGGED_IN;
-    phone?: string;
-}
-/**
- * KP phone number logged in event
- */
-interface IKPPhoneNumberLoggedInEvent extends BaseEvent {
-    type: EventType.KP_PHONE_NUMBER_LOGGED_IN;
-    phone?: string;
-}
-/**
- * KP MP Shopify logged in event
- */
-interface IKPMPShopifyLoggedInEvent extends BaseEvent {
-    type: EventType.KP_MP_SHOPIFY_LOGGED_IN;
-    userId?: string;
-}
-/**
- * KP MP successfully logged out event
- */
-interface IKPMPSuccessfullyLoggedOutEvent extends BaseEvent {
-    type: EventType.KP_MP_SUCCESSFULLY_LOGGED_OUT;
-    userId?: string;
-}
-/**
- * KP WhatsApp logged in event
- */
-interface IKPWhatsAppLoggedInEvent extends BaseEvent {
-    type: EventType.KP_WHATSAPP_LOGGED_IN;
-    phone?: string;
-}
-/**
- * KP MP Truecaller logged in event
- */
-interface IKPMPTruecallerLoggedInEvent extends BaseEvent {
-    type: EventType.KP_MP_TRUECALLER_LOGGED_IN;
-    phone?: string;
-}
-/**
- * KP MP WhatsApp logged in event
- */
-interface IKPMPWhatsAppLoggedInEvent extends BaseEvent {
-    type: EventType.KP_MP_WHATSAPP_LOGGED_IN;
-    phone?: string;
-}
-/**
- * KP Truecaller logged in event
- */
-interface IKPTruecallerLoggedInEvent extends BaseEvent {
-    type: EventType.KP_TRUECALLER_LOGGED_IN;
-    phone?: string;
-}
-/**
- * KP Shopify logged in event
- */
-interface IKPShopifyLoggedInEvent extends BaseEvent {
-    type: EventType.KP_SHOPIFY_LOGGED_IN;
-    userId?: string;
-}
-/**
- * KP successfully logged out event
- */
-interface IKPSuccessfullyLoggedOutEvent extends BaseEvent {
-    type: EventType.KP_SUCCESSFULLY_LOGGED_OUT;
-    userId?: string;
-}
-/**
- * Pages screens per session event
- */
-interface IPagesScreensPerSessionEvent extends BaseEvent {
-    type: EventType.PAGES_SCREENS_PER_SESSION;
-    currency: string;
-    firebase_conversion: boolean;
-    ga_session_id: string;
-    ga_session_number: number;
-    synthetic_bundle: boolean;
-    value: number;
-}
-/**
- * Started order event
- */
-interface IStartedOrderEvent extends BaseEvent {
-    type: EventType.STARTED_ORDER;
-    cartValue: number;
-    currency?: string;
-    itemCount: number;
-    items: Array<{
-        productId: string;
-        productName: string;
-        price: number;
-        quantity: number;
-    }>;
-    event_category: string;
-    description: string;
-}
 /**
  * Product view event
  */
@@ -986,6 +650,6 @@ interface IProductViewEvent extends BaseEvent {
 /**
  * Union type of all possible events
  */
-type TEvent = IProductViewEvent | IPageViewEvent | IButtonClickEvent | IFormSubmissionEvent | ICartPageLandEvent | ICloseCartEvent | IQuantityChangeEvent | IViewItemEvent | IPCollectionViewEvent | IAddToCartEvent | IRemoveFromCartEvent | ICheckoutStartedEvent | ICheckoutCompletedEvent | ICartViewedEvent | ISearchEvent | IFilterAppliedEvent | INewsletterSubscriptionEvent | IUserSignupEvent | IUserLoginEvent | IViewContentEvent | IPurchaseEvent | IViewSearchResultsEvent | IOrderPlacedEvent | IBeginCheckoutEvent | ICustomEvent | IUserEngagementEvent | ISessionStartEvent | IFirstVisitEvent | IScrollEvent | IFormStartEvent | IAddPaymentInfoEvent | IItemPurchasedEvent | IUpdateCartEvent | ICustomerRegisteredEvent | ICustomerLoggedInEvent | IShopifyCheckoutUpdatedEvent | IShopifyAbandonedCheckoutEvent | IShopifyOrderFulfilledEvent | IShopifyCheckoutStartedEvent | IShopifyAddToCartEvent | IShopifyRemoveFromCartEvent | IShopifyUpdateCartEvent | ISpinformResultEvent | ICouponCopiedEvent | IStartedCheckoutGKEvent | IMobileAddedGKEvent | IAddressSelectedGKEvent | IAddressCompletedGKEvent | IPaymentMethodSelectedGKEvent | IPaymentCompletedGKEvent | IOrderSuccessEvent | IOrderCompletedEvent | IPinCodeAddedGKEvent | IAddressAddedGKEvent | IKPMPPhoneNumberLoggedInEvent | IKPPhoneNumberLoggedInEvent | IKPMPShopifyLoggedInEvent | IKPMPSuccessfullyLoggedOutEvent | IKPWhatsAppLoggedInEvent | IKPMPTruecallerLoggedInEvent | IKPMPWhatsAppLoggedInEvent | IKPTruecallerLoggedInEvent | IKPShopifyLoggedInEvent | IKPSuccessfullyLoggedOutEvent | IPagesScreensPerSessionEvent | IViewedProductEvent | ICheckoutPaymentEvent | IStartedOrderEvent;
+type TEvent = IProductViewEvent | IPageViewEvent | IButtonClickEvent | IFormSubmissionEvent | IViewItemEvent | IPCollectionViewEvent | IAddToCartEvent | IRemoveFromCartEvent | ICheckoutStartedEvent | ICheckoutCompletedEvent | ICartViewedEvent | ISearchEvent | IUserSignupEvent | IUserLoginEvent | IViewContentEvent | IPurchaseEvent | IViewSearchResultsEvent | IOrderPlacedEvent | IBeginCheckoutEvent | ICustomEvent | IUserEngagementEvent | ISessionStartEvent | IFirstVisitEvent | IScrollEvent | IFormStartEvent | IAddPaymentInfoEvent | IStartedCheckoutGKEvent | IMobileAddedGKEvent | IAddressSelectedGKEvent | IAddressCompletedGKEvent | IPaymentMethodSelectedGKEvent | IPaymentCompletedGKEvent | IOrderSuccessEvent | IOrderCompletedEvent | IPinCodeAddedGKEvent | IAddressAddedGKEvent | IViewedProductEvent | ICheckoutPaymentEvent;
 
-export { type BaseEvent, EventType, type IAddPaymentInfoEvent, type IAddToCartEvent, type IAddressAddedGKEvent, type IAddressCompletedGKEvent, type IAddressSelectedGKEvent, type IBeginCheckoutEvent, type IButtonClickEvent, type ICartPageLandEvent, type ICartViewedEvent, type ICheckoutCompletedEvent, type ICheckoutPaymentEvent, type ICheckoutStartedEvent, type ICloseCartEvent, type ICouponCopiedEvent, type ICustomEvent, type ICustomerLoggedInEvent, type ICustomerRegisteredEvent, type IFilterAppliedEvent, type IFirstVisitEvent, type IFormStartEvent, type IFormSubmissionEvent, type IItemPurchasedEvent, type IKPMPPhoneNumberLoggedInEvent, type IKPMPShopifyLoggedInEvent, type IKPMPSuccessfullyLoggedOutEvent, type IKPMPTruecallerLoggedInEvent, type IKPMPWhatsAppLoggedInEvent, type IKPPhoneNumberLoggedInEvent, type IKPShopifyLoggedInEvent, type IKPSuccessfullyLoggedOutEvent, type IKPTruecallerLoggedInEvent, type IKPWhatsAppLoggedInEvent, type IMobileAddedGKEvent, type INewsletterSubscriptionEvent, type IOrderCompletedEvent, type IOrderPlacedEvent, type IOrderSuccessEvent, type IPCollectionViewEvent, type IPageViewEvent, type IPagesScreensPerSessionEvent, type IPaymentCompletedGKEvent, type IPaymentMethodSelectedGKEvent, type IPinCodeAddedGKEvent, type IProductViewEvent, type IPurchaseEvent, type IQuantityChangeEvent, type IRemoveFromCartEvent, type IScrollEvent, type ISearchEvent, type ISessionStartEvent, type IShopifyAbandonedCheckoutEvent, type IShopifyAddToCartEvent, type IShopifyCheckoutStartedEvent, type IShopifyCheckoutUpdatedEvent, type IShopifyOrderFulfilledEvent, type IShopifyRemoveFromCartEvent, type IShopifyUpdateCartEvent, type ISpinformResultEvent, type IStartedCheckoutGKEvent, type IStartedOrderEvent, type IUpdateCartEvent, type IUserEngagementEvent, type IUserLoginEvent, type IUserSignupEvent, type IViewContentEvent, type IViewItemEvent, type IViewSearchResultsEvent, type IViewedProductEvent, type TEvent };
+export { type BaseEvent, EventType, type IAddPaymentInfoEvent, type IAddToCartEvent, type IAddressAddedGKEvent, type IAddressCompletedGKEvent, type IAddressSelectedGKEvent, type IBeginCheckoutEvent, type IButtonClickEvent, type ICartViewedEvent, type ICheckoutCompletedEvent, type ICheckoutPaymentEvent, type ICheckoutStartedEvent, type ICustomEvent, type IFirstVisitEvent, type IFormStartEvent, type IFormSubmissionEvent, type IMobileAddedGKEvent, type IOrderCompletedEvent, type IOrderPlacedEvent, type IOrderSuccessEvent, type IPCollectionViewEvent, type IPageViewEvent, type IPaymentCompletedGKEvent, type IPaymentMethodSelectedGKEvent, type IPinCodeAddedGKEvent, type IProductViewEvent, type IPurchaseEvent, type IRemoveFromCartEvent, type IScrollEvent, type ISearchEvent, type ISessionStartEvent, type IStartedCheckoutGKEvent, type IUserEngagementEvent, type IUserLoginEvent, type IUserSignupEvent, type IViewContentEvent, type IViewItemEvent, type IViewSearchResultsEvent, type IViewedProductEvent, type TEvent };