@shware/analytics 0.1.17 → 0.1.18

package/dist/track/gtag.d.ts

@@ -0,0 +1,463 @@
+declare const standardEventNames: readonly ["add_payment_info", "add_shipping_info", "add_to_cart", "add_to_wishlist", "begin_checkout", "close_convert_lead", "close_unconvert_lead", "disqualify_lead", "earn_virtual_currency", "generate_lead", "join_group", "level_end", "level_start", "level_up", "login", "post_score", "purchase", "qualify_lead", "refund", "remove_from_cart", "search", "select_content", "select_item", "select_promotion", "share", "sign_up", "spend_virtual_currency", "tutorial_begin", "tutorial_complete", "unlock_achievement", "view_cart", "view_item", "view_item_list", "view_promotion", "working_lead"];
+declare const reservedEventNames: string[];
+type GaId = `G-${Uppercase<string>}`;
+type GtmId = `GTM-${Uppercase<string>}`;
+type CampaignMedium = 'email' | 'organic' | 'cpc' | 'banner' | 'social' | 'referral' | 'affiliate' | 'video' | 'display' | 'sms' | 'push' | 'qr' | 'audio' | (string & {});
+type CampaignSource = 'google' | 'googleads' | 'bing' | 'bingads' | 'metaads' | 'facebook' | 'twitter' | 'linkedin' | 'instagram' | 'tiktok' | 'youtube' | 'newsletter' | `website_${string}` | `affiliate_${string}` | (string & {});
+type Campaign = {
+    id?: string;
+    name?: string;
+    term?: string;
+    content?: string;
+    medium?: CampaignMedium;
+    source?: CampaignSource;
+};
+type Config = {
+    allow_google_signals?: boolean;
+    allow_ad_personalization_signals?: boolean;
+    campaign_content?: string;
+    campaign_id?: string;
+    campaign_medium?: CampaignMedium;
+    campaign_name?: string;
+    campaign_source?: CampaignSource;
+    campaign_term?: string;
+    /**
+     * @deprecated
+     * Key Point: Use the campaign_ prefixed version of each campaign value instead of this field.
+     */
+    campaign?: Campaign;
+    client_id?: string;
+    content_group?: string;
+    cookie_domain?: 'none' | 'auto' | string;
+    cookie_expires?: number;
+    cookie_flags?: string;
+    cookie_path?: string;
+    cookie_prefix?: string;
+    cookie_update?: boolean;
+    ignore_referrer?: boolean;
+    language?: string;
+    page_location?: string;
+    page_referrer?: string;
+    page_title?: string;
+    send_page_view?: boolean;
+    screen_resolution?: `${number}x${number}`;
+    user_id?: string;
+    user_property?: Record<string, string | boolean | number | null | undefined>;
+};
+type Item = {
+    item_id: string;
+    item_name: string;
+    affiliation?: 'Google Store' | (string & {});
+    coupon?: string;
+    discount?: number;
+    index?: number;
+    item_brand?: string;
+    item_category?: string;
+    item_category2?: string;
+    item_category3?: string;
+    item_category4?: string;
+    item_category5?: string;
+    item_list_id?: string;
+    item_list_name?: string;
+    item_variant?: string;
+    location_id?: string;
+    price?: number;
+    quantity?: number;
+};
+type PromotionItem = {
+    creative_name?: string;
+    creative_slot?: string;
+    promotion_id?: string;
+    promotion_name?: string;
+};
+/**
+ * ref: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag
+ * ref: https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event
+ * */
+type StandardEvents = {
+    add_payment_info: {
+        currency: string;
+        value: number;
+        coupon?: string;
+        payment_type?: string;
+        items: Item[];
+    };
+    add_shipping_info: {
+        currency: string;
+        value: number;
+        coupon?: string;
+        shipping_tier?: string;
+        items: Item[];
+    };
+    add_to_cart: {
+        currency: string;
+        value: number;
+        items: Item[];
+    };
+    add_to_wishlist: {
+        currency: string;
+        value: number;
+        items: Item[];
+    };
+    begin_checkout: {
+        currency: string;
+        value: number;
+        coupon?: string;
+        items: Item[];
+    };
+    close_convert_lead: {
+        currency: string;
+        value: number;
+    };
+    close_unconvert_lead: {
+        currency: string;
+        value: number;
+        unconvert_lead_reason?: string;
+    };
+    disqualify_lead: {
+        currency: string;
+        value: number;
+        disqualified_lead_reason?: string;
+    };
+    earn_virtual_currency: {
+        virtual_currency_name?: string;
+        value?: number;
+    };
+    generate_lead: {
+        currency: string;
+        value: number;
+        lead_source?: string;
+    };
+    join_group: {
+        group_id?: string;
+    };
+    level_end: {
+        level_name?: string;
+        success?: boolean;
+    };
+    level_start: {
+        level_name?: string;
+    };
+    level_up: {
+        level?: number;
+        level_name?: string;
+        character?: string;
+    };
+    login: {
+        method?: string;
+    };
+    post_score: {
+        score: number;
+        level?: number;
+        character?: string;
+    };
+    purchase: {
+        currency: string;
+        value: number;
+        transaction_id: string;
+        coupon?: string;
+        shipping?: number;
+        tax?: number;
+        items?: Item[];
+    };
+    qualify_lead: {
+        currency: string;
+        value: number;
+    };
+    refund: {
+        currency: string;
+        value: number;
+        transaction_id: string;
+        coupon?: string;
+        shipping?: number;
+        tax?: number;
+        items?: Item[];
+    };
+    remove_from_cart: {
+        currency: string;
+        value: number;
+        items: Item[];
+    };
+    search: {
+        search_term: string;
+    };
+    select_content: {
+        content_type?: string;
+        content_id?: string;
+    };
+    select_item: {
+        item_list_id?: string;
+        item_list_name?: string;
+        items: Item[];
+    };
+    select_promotion: {
+        creative_name?: string;
+        creative_slot?: string;
+        promotion_id?: string;
+        promotion_name?: string;
+        items?: (Item & PromotionItem)[];
+    };
+    share: {
+        method?: string;
+        content_type?: string;
+        item_id?: string;
+    };
+    sign_up: {
+        method?: string;
+    };
+    spend_virtual_currency: {
+        value: number;
+        virtual_currency_name: string;
+        item_name?: string;
+    };
+    tutorial_begin: undefined;
+    tutorial_complete: undefined;
+    unlock_achievement: {
+        achievement_id: string;
+    };
+    view_cart: {
+        currency: string;
+        value: number;
+        items: Item[];
+    };
+    view_item: {
+        currency: string;
+        value: number;
+        items: Item[];
+    };
+    view_item_list: {
+        currency: string;
+        item_list_id?: string;
+        item_list_name?: string;
+        items: Item[];
+    };
+    view_promotion: {
+        creative_name?: string;
+        creative_slot?: string;
+        promotion_id?: string;
+        promotion_name?: string;
+        items: (Item & PromotionItem)[];
+    };
+    working_lead: {
+        currency: string;
+        value: number;
+        lead_status?: string;
+    };
+    ad_impression: {
+        value?: number;
+        currency?: string;
+        ad_format?: string;
+        ad_platform?: string;
+        ad_source?: string;
+        ad_unit_name?: string;
+    };
+    app_open: undefined;
+    campaign_details: {
+        source: string;
+        medium: string;
+        campaign: string;
+        term?: string;
+        content?: string;
+        aclid?: string;
+        cp1?: string;
+    };
+    screen_view: {
+        screen_name?: string;
+        screen_class?: string;
+    };
+    view_search_results: {
+        search_term: string;
+    };
+    trial_begin: {
+        currency: string;
+        value: number;
+    };
+    subscribe: {
+        currency: string;
+        value: number;
+    };
+};
+/**
+ * reference: https://developers.google.com/analytics/devguides/collection/ga4/reference/config
+ * reference: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag
+ */
+interface Gtag {
+    /**
+     * To disable advertising features based on third-party advertising identifiers, set
+     * allow_google_signals to false.
+     *
+     * @param allow - Whether to allow Google signals.
+     * @default true
+     */
+    gtag(event: 'set', option: 'allow_google_signals', allow: boolean): void;
+    /**
+     * Set to false to disable advertising personalization features.
+     *
+     * @param allow - Whether to allow ad personalization signals.
+     * @default true
+     */
+    gtag(event: 'set', option: 'allow_ad_personalization_signals', allow: boolean): void;
+    /**
+     * Used for A/B testing and content-targeted ads. Use campaign_content to differentiate ads or
+     * links that point to the same URL.
+     */
+    gtag(event: 'set', option: 'campaign_content', content: string): void;
+    /**
+     * Used to identify which campaign this referral references. Use campaign_id to identify a
+     * specific campaign.
+     */
+    gtag(event: 'set', option: 'campaign_id', id: string): void;
+    /** Use campaign_medium to identify a medium such as email or cost-per-click. */
+    gtag(event: 'set', option: 'campaign_medium', medium: CampaignMedium): void;
+    /**
+     * Used for keyword analysis. Use campaign_name to identify a specific product promotion or
+     * strategic campaign.
+     */
+    gtag(event: 'set', option: 'campaign_name', name: string): void;
+    /** Use campaign_source to identify a search engine, newsletter name, or other source. */
+    gtag(event: 'set', option: 'campaign_source', source: CampaignSource): void;
+    /** Used for paid search. Use campaign_term to note the keywords for this ad. */
+    gtag(event: 'set', option: 'campaign_term', term: string): void;
+    /**
+     * @deprecated
+     * Key Point: Use the campaign_ prefixed version of each campaign value instead of this field.
+     */
+    gtag(event: 'set', option: 'campaign', params: Campaign): void;
+    /**
+     * Pseudonymously identifies a browser instance. By default, this value is stored as part of the
+     * first-party Analytics cookie with a two-year expiration.
+     */
+    gtag(event: 'set', option: 'client_id', id: string): void;
+    /** example: gtag('set', 'content_group', '/news/sports'); */
+    gtag(event: 'set', option: 'content_group', group: string): void;
+    /**
+     * Specifies the domain used to store the analytics cookie.
+     * Set to 'none' to set the cookie without specifying a domain.
+     * Set to 'auto' (the default value) to set the cookie to the top level domain plus one
+     * subdomain (eTLD +1). For example if cookie_domain is set to 'auto' https://example.com would
+     * use example.com for the domain, and https://subdomain.example.com would also use example.com
+     * for the domain.
+     *
+     * @param domain - The domain used to store the analytics cookie.
+     * @default 'auto'
+     */
+    gtag(event: 'set', option: 'cookie_domain', domain: 'none' | 'auto' | string): void;
+    /**
+     * Every time a hit is sent to Google Analytics, the cookie expiration time is updated to be the
+     * current time plus the value of the cookie_expires field. This means that if you use the default
+     * value time of two years (63072000 seconds), and a user visits your site every month, their
+     * cookie will never expire.
+     *
+     * If you set the cookie_expires time to 0 (zero) seconds, the cookie turns into a session based
+     * cookie and expires once the current browser session ends.
+     *
+     * Caution: If you set the cookie to expire too quickly, you will inflate your user count and
+     * decrease the quality of your measurement.
+     *
+     * @param expires - The number of seconds until the cookie expires.
+     * @default 63072000
+     */
+    gtag(event: 'set', option: 'cookie_expires', expires: number): void;
+    /**
+     * Appends additional flags to the cookie when set. Flags must be separated by semicolons. See
+     * [write a new cookie](https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie#write_a_new_cookie) for some examples of flags to set.
+     */
+    gtag(event: 'set', option: 'cookie_flags', flags: string): void;
+    /** Specifies the subpath used to store the analytics cookie. */
+    gtag(event: 'set', option: 'cookie_path', path: string): void;
+    /** Specifies a prefix to prepend to analytics cookie names. */
+    gtag(event: 'set', option: 'cookie_prefix', prefix: string): void;
+    /**
+     * When cookie_update is set to true, gtag.js will update cookies on each page load. This will
+     * update the cookie expiration to be set relative to the most recent visit to the site. For
+     * example, if cookie expiration is set to one week, and a user visits using the same browser
+     * every five days, the cookie expiration will be updated on each visit and will effectively
+     * never expire.
+     *
+     * When set to false, cookies are not updated on each page load. This has the effect of cookie
+     * expiration being relative to the first time a user visited the site.
+     *
+     * @param update - Whether to update the cookie on each page load.
+     * @default true
+     */
+    gtag(event: 'set', option: 'cookie_update', update: boolean): void;
+    /**
+     * Set to true to indicate to Analytics that the referrer shouldn't be displayed as a traffic
+     * source. [Learn when to use this field](https://support.google.com/analytics/answer/10327750#set-parameter)
+     *
+     * @param ignore - Whether to ignore the referrer.
+     * @default false
+     */
+    gtag(event: 'set', option: 'ignore_referrer', ignore: boolean): void;
+    /**
+     * Specifies the language preference of the user. Defaults to the user's navigator.language value.
+     *
+     * @param language - The language preference of the user.
+     * @default navigator.language
+     */
+    gtag(event: 'set', option: 'language', language: string): void;
+    /**
+     * Specifies the full URL of the page. Defaults to the user's document.location value.
+     *
+     * @param location - The full URL of the page. Character limit 1000
+     * @default document.location
+     */
+    gtag(event: 'set', option: 'page_location', location: string): void;
+    /**
+     * Specifies which referral source brought traffic to a page. This value is also used to compute
+     * the traffic source. The format of this value is a URL. Defaults to the user's document.referrer
+     * value.
+     *
+     * @param referrer - The referral source. Character limit 420
+     * @default document.referrer
+     */
+    gtag(event: 'set', option: 'page_referrer', referrer: string): void;
+    /**
+     * The title of the page or document. Defaults to the user's document.title value.
+     *
+     * @param title - The title of the page or document. Character limit 300
+     * @default document.title
+     */
+    gtag(event: 'set', option: 'page_title', title: string): void;
+    /**
+     * Set to false to prevent the default snippet from sending a page_view.
+     *
+     * @param send - Whether to send a page_view.
+     * @default true
+     */
+    gtag(event: 'set', option: 'send_page_view', send: boolean): void;
+    /**
+     * Specifies the resolution of the screen. Should be two positive integers separated by an x. For
+     * example, for an 800px by 600px screen, the value would be 800x600. Calculated from the user's
+     * window.screen value.
+     *
+     * @param resolution - The resolution of the screen.
+     * @default window.screen
+     */
+    gtag(event: 'set', option: 'screen_resolution', resolution: `${number}x${number}`): void;
+    /**
+     * Specifies a known identifier for a user provided by the site owner/library user. It must not
+     * itself be PII (personally identifiable information). The value should never be persisted in
+     * Google Analytics cookies or other Analytics provided storage.
+     *
+     * @param userId - The user ID. Character limit 256
+     */
+    gtag(event: 'set', option: 'user_id', userId: string): void;
+    /**
+     * User properties are attributes that can be used to describe segments of your user base, such
+     * as language preference or geographic location. Up to 25 additional user properties can be set
+     * per project.
+     *
+     * @param name - The name of the user property. Character limit 24
+     * @param value - The value of the user property. Character limit 36
+     */
+    gtag(event: 'set', option: 'user_property', properties: Record<string, string | boolean | number | null | undefined>): void;
+    /**
+     * gtag('config', ...) Set for a single stream
+     * gtag('set', ...) Set globally
+     */
+    gtag(event: 'config', gaId: GaId, config?: Config): void;
+    gtag<T extends string>(event: 'event', eventName: T extends keyof StandardEvents ? T : string, eventParams?: T extends keyof StandardEvents ? StandardEvents[T] : Record<string, string | number | boolean | null | undefined>): void;
+}
+
+export { type Campaign, type CampaignMedium, type CampaignSource, type Config, type GaId, type Gtag, type GtmId, type Item, type PromotionItem, type StandardEvents, reservedEventNames, standardEventNames };

package/dist/track/{ga.mjs → gtag.mjs}

@@ -1,4 +1,4 @@
-// src/track/ga.ts
+// src/track/gtag.ts
 var standardEventNames = [
   "add_payment_info",
   "add_shipping_info",
@@ -73,4 +73,4 @@ export {
   reservedEventNames,
   standardEventNames
 };
-//# sourceMappingURL=ga.mjs.map
+//# sourceMappingURL=gtag.mjs.map

package/dist/track/gtag.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/track/gtag.ts"],"sourcesContent":["export const standardEventNames = [\n  'add_payment_info',\n  'add_shipping_info',\n  'add_to_cart',\n  'add_to_wishlist',\n  'begin_checkout',\n  'close_convert_lead',\n  'close_unconvert_lead',\n  'disqualify_lead',\n  'earn_virtual_currency',\n  'generate_lead',\n  'join_group',\n  'level_end',\n  'level_start',\n  'level_up',\n  'login',\n  'post_score',\n  'purchase',\n  'qualify_lead',\n  'refund',\n  'remove_from_cart',\n  'search',\n  'select_content',\n  'select_item',\n  'select_promotion',\n  'share',\n  'sign_up',\n  'spend_virtual_currency',\n  'tutorial_begin',\n  'tutorial_complete',\n  'unlock_achievement',\n  'view_cart',\n  'view_item',\n  'view_item_list',\n  'view_promotion',\n  'working_lead',\n] as const;\n\nexport const reservedEventNames = [\n  'ad_activeview',\n  'ad_click',\n  'ad_exposure',\n  'ad_query',\n  'ad_reward',\n  'adunit_exposure',\n  'app_background',\n  'app_clear_data',\n  'app_exception',\n  'app_remove',\n  'app_store_refund',\n  'app_store_subscription_cancel',\n  'app_store_subscription_convert',\n  'app_store_subscription_renew',\n  'app_update',\n  'app_upgrade',\n  'dynamic_link_app_open',\n  'dynamic_link_app_update',\n  'dynamic_link_first_open',\n  'error',\n  'first_open',\n  'first_visit',\n  'in_app_purchase',\n  'notification_dismiss',\n  'notification_foreground',\n  'notification_open',\n  'notification_receive',\n  'os_update',\n  'session_start',\n  'session_start_with_rollout',\n  'user_engagement',\n];\n\nexport type GaId = `G-${Uppercase<string>}`;\nexport type GtmId = `GTM-${Uppercase<string>}`;\n\nexport type CampaignMedium =\n  | 'email'\n  | 'organic'\n  | 'cpc'\n  | 'banner'\n  | 'social'\n  | 'referral'\n  | 'affiliate'\n  | 'video'\n  | 'display'\n  | 'sms'\n  | 'push'\n  | 'qr'\n  | 'audio'\n  | (string & {});\n\nexport type CampaignSource =\n  | 'google' // don't need to set\n  | 'googleads'\n  | 'bing'\n  | 'bingads'\n  | 'metaads'\n  | 'facebook'\n  | 'twitter'\n  | 'linkedin'\n  | 'instagram'\n  | 'tiktok'\n  | 'youtube'\n  | 'newsletter'\n  | `website_${string}`\n  | `affiliate_${string}`\n  | (string & {});\n\nexport type Campaign = {\n  id?: string;\n  name?: string;\n  term?: string;\n  content?: string;\n  medium?: CampaignMedium;\n  source?: CampaignSource;\n};\n\nexport type Config = {\n  allow_google_signals?: boolean;\n  allow_ad_personalization_signals?: boolean;\n\n  campaign_content?: string;\n  campaign_id?: string;\n  campaign_medium?: CampaignMedium;\n  campaign_name?: string;\n  campaign_source?: CampaignSource;\n  campaign_term?: string;\n\n  /**\n   * @deprecated\n   * Key Point: Use the campaign_ prefixed version of each campaign value instead of this field.\n   */\n  campaign?: Campaign;\n\n  client_id?: string;\n  content_group?: string;\n\n  cookie_domain?: 'none' | 'auto' | string;\n  cookie_expires?: number;\n  cookie_flags?: string;\n  cookie_path?: string;\n  cookie_prefix?: string;\n  cookie_update?: boolean;\n\n  ignore_referrer?: boolean;\n  language?: string;\n\n  page_location?: string;\n  page_referrer?: string;\n  page_title?: string;\n\n  send_page_view?: boolean;\n  screen_resolution?: `${number}x${number}`;\n  user_id?: string;\n  user_property?: Record<string, string | boolean | number | null | undefined>;\n};\n\nexport type Item = {\n  item_id: string;\n  item_name: string;\n  affiliation?: 'Google Store' | (string & {});\n  coupon?: string;\n  discount?: number;\n  index?: number;\n  item_brand?: string;\n  item_category?: string;\n  item_category2?: string;\n  item_category3?: string;\n  item_category4?: string;\n  item_category5?: string;\n  item_list_id?: string;\n  item_list_name?: string;\n  item_variant?: string;\n  location_id?: string;\n  price?: number;\n  quantity?: number;\n};\n\nexport type PromotionItem = {\n  creative_name?: string;\n  creative_slot?: string;\n  promotion_id?: string;\n  promotion_name?: string;\n};\n\n/**\n * ref: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag\n * ref: https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event\n * */\nexport type StandardEvents = {\n  // Google Analytics 4 Recommended Events\n  add_payment_info: {\n    currency: string;\n    value: number;\n    coupon?: string;\n    payment_type?: string;\n    items: Item[];\n  };\n  add_shipping_info: {\n    currency: string;\n    value: number;\n    coupon?: string;\n    shipping_tier?: string;\n    items: Item[];\n  };\n  add_to_cart: {\n    currency: string;\n    value: number;\n    items: Item[];\n  };\n  add_to_wishlist: {\n    currency: string;\n    value: number;\n    items: Item[];\n  };\n  begin_checkout: {\n    currency: string;\n    value: number;\n    coupon?: string;\n    items: Item[];\n  };\n  close_convert_lead: {\n    currency: string;\n    value: number;\n  };\n  close_unconvert_lead: {\n    currency: string;\n    value: number;\n    unconvert_lead_reason?: string;\n  };\n  disqualify_lead: {\n    currency: string;\n    value: number;\n    disqualified_lead_reason?: string;\n  };\n  earn_virtual_currency: {\n    virtual_currency_name?: string;\n    value?: number;\n  };\n  generate_lead: {\n    currency: string;\n    value: number;\n    lead_source?: string;\n  };\n  join_group: {\n    group_id?: string;\n  };\n  level_end: {\n    level_name?: string;\n    success?: boolean;\n  };\n  level_start: {\n    level_name?: string;\n  };\n  level_up: {\n    level?: number;\n    level_name?: string;\n    character?: string;\n  };\n  login: {\n    method?: string;\n  };\n  post_score: {\n    score: number;\n    level?: number;\n    character?: string;\n  };\n  purchase: {\n    currency: string;\n    value: number;\n    transaction_id: string;\n    coupon?: string;\n    shipping?: number; // Shipping cost associated with a transaction.\n    tax?: number;\n    items?: Item[];\n  };\n  qualify_lead: {\n    currency: string;\n    value: number;\n  };\n  refund: {\n    currency: string;\n    value: number;\n    transaction_id: string;\n    coupon?: string;\n    shipping?: number;\n    tax?: number;\n    items?: Item[];\n  };\n  remove_from_cart: {\n    currency: string;\n    value: number;\n    items: Item[];\n  };\n  search: {\n    search_term: string;\n  };\n  select_content: {\n    content_type?: string;\n    content_id?: string;\n  };\n  select_item: {\n    item_list_id?: string;\n    item_list_name?: string;\n    items: Item[];\n  };\n  select_promotion: {\n    creative_name?: string;\n    creative_slot?: string;\n    promotion_id?: string;\n    promotion_name?: string;\n    items?: (Item & PromotionItem)[];\n  };\n  share: {\n    method?: string;\n    content_type?: string;\n    item_id?: string;\n  };\n  sign_up: {\n    method?: string;\n  };\n  spend_virtual_currency: {\n    value: number;\n    virtual_currency_name: string;\n    item_name?: string;\n  };\n  tutorial_begin: undefined;\n  tutorial_complete: undefined;\n  unlock_achievement: {\n    achievement_id: string;\n  };\n  view_cart: {\n    currency: string;\n    value: number;\n    items: Item[];\n  };\n  view_item: {\n    currency: string;\n    value: number;\n    items: Item[];\n  };\n  view_item_list: {\n    currency: string;\n    item_list_id?: string;\n    item_list_name?: string;\n    items: Item[];\n  };\n  view_promotion: {\n    creative_name?: string;\n    creative_slot?: string;\n    promotion_id?: string;\n    promotion_name?: string;\n    items: (Item & PromotionItem)[];\n  };\n  working_lead: {\n    currency: string;\n    value: number;\n    lead_status?: string;\n  };\n\n  // Firebase Analytics events, event_name 40 characters limit, 25 parameters limit\n  ad_impression: {\n    value?: number;\n    currency?: string;\n    ad_format?: string;\n    ad_platform?: string;\n    ad_source?: string;\n    ad_unit_name?: string;\n  };\n  app_open: undefined;\n  campaign_details: {\n    source: string;\n    medium: string;\n    campaign: string;\n    term?: string;\n    content?: string;\n    aclid?: string;\n    cp1?: string;\n  };\n  screen_view: { screen_name?: string; screen_class?: string };\n  view_search_results: { search_term: string };\n\n  // Added events\n  trial_begin: {\n    currency: string;\n    value: number;\n  };\n\n  subscribe: {\n    currency: string;\n    value: number;\n  };\n};\n\n/**\n * reference: https://developers.google.com/analytics/devguides/collection/ga4/reference/config\n * reference: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag\n */\nexport interface Gtag {\n  /**\n   * To disable advertising features based on third-party advertising identifiers, set\n   * allow_google_signals to false.\n   *\n   * @param allow - Whether to allow Google signals.\n   * @default true\n   */\n  gtag(event: 'set', option: 'allow_google_signals', allow: boolean): void;\n\n  /**\n   * Set to false to disable advertising personalization features.\n   *\n   * @param allow - Whether to allow ad personalization signals.\n   * @default true\n   */\n  gtag(event: 'set', option: 'allow_ad_personalization_signals', allow: boolean): void;\n\n  /**\n   * Used for A/B testing and content-targeted ads. Use campaign_content to differentiate ads or\n   * links that point to the same URL.\n   */\n  gtag(event: 'set', option: 'campaign_content', content: string): void;\n\n  /**\n   * Used to identify which campaign this referral references. Use campaign_id to identify a\n   * specific campaign.\n   */\n  gtag(event: 'set', option: 'campaign_id', id: string): void;\n\n  /** Use campaign_medium to identify a medium such as email or cost-per-click. */\n  gtag(event: 'set', option: 'campaign_medium', medium: CampaignMedium): void;\n\n  /**\n   * Used for keyword analysis. Use campaign_name to identify a specific product promotion or\n   * strategic campaign.\n   */\n  gtag(event: 'set', option: 'campaign_name', name: string): void;\n\n  /** Use campaign_source to identify a search engine, newsletter name, or other source. */\n  gtag(event: 'set', option: 'campaign_source', source: CampaignSource): void;\n\n  /** Used for paid search. Use campaign_term to note the keywords for this ad. */\n  gtag(event: 'set', option: 'campaign_term', term: string): void;\n\n  /**\n   * @deprecated\n   * Key Point: Use the campaign_ prefixed version of each campaign value instead of this field.\n   */\n  gtag(event: 'set', option: 'campaign', params: Campaign): void;\n\n  /**\n   * Pseudonymously identifies a browser instance. By default, this value is stored as part of the\n   * first-party Analytics cookie with a two-year expiration.\n   */\n  gtag(event: 'set', option: 'client_id', id: string): void;\n\n  /** example: gtag('set', 'content_group', '/news/sports'); */\n  gtag(event: 'set', option: 'content_group', group: string): void;\n\n  /**\n   * Specifies the domain used to store the analytics cookie.\n   * Set to 'none' to set the cookie without specifying a domain.\n   * Set to 'auto' (the default value) to set the cookie to the top level domain plus one\n   * subdomain (eTLD +1). For example if cookie_domain is set to 'auto' https://example.com would\n   * use example.com for the domain, and https://subdomain.example.com would also use example.com\n   * for the domain.\n   *\n   * @param domain - The domain used to store the analytics cookie.\n   * @default 'auto'\n   */\n  gtag(event: 'set', option: 'cookie_domain', domain: 'none' | 'auto' | string): void;\n\n  /**\n   * Every time a hit is sent to Google Analytics, the cookie expiration time is updated to be the\n   * current time plus the value of the cookie_expires field. This means that if you use the default\n   * value time of two years (63072000 seconds), and a user visits your site every month, their\n   * cookie will never expire.\n   *\n   * If you set the cookie_expires time to 0 (zero) seconds, the cookie turns into a session based\n   * cookie and expires once the current browser session ends.\n   *\n   * Caution: If you set the cookie to expire too quickly, you will inflate your user count and\n   * decrease the quality of your measurement.\n   *\n   * @param expires - The number of seconds until the cookie expires.\n   * @default 63072000\n   */\n  gtag(event: 'set', option: 'cookie_expires', expires: number): void;\n\n  /**\n   * Appends additional flags to the cookie when set. Flags must be separated by semicolons. See\n   * [write a new cookie](https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie#write_a_new_cookie) for some examples of flags to set.\n   */\n  gtag(event: 'set', option: 'cookie_flags', flags: string): void;\n\n  /** Specifies the subpath used to store the analytics cookie. */\n  gtag(event: 'set', option: 'cookie_path', path: string): void;\n\n  /** Specifies a prefix to prepend to analytics cookie names. */\n  gtag(event: 'set', option: 'cookie_prefix', prefix: string): void;\n\n  /**\n   * When cookie_update is set to true, gtag.js will update cookies on each page load. This will\n   * update the cookie expiration to be set relative to the most recent visit to the site. For\n   * example, if cookie expiration is set to one week, and a user visits using the same browser\n   * every five days, the cookie expiration will be updated on each visit and will effectively\n   * never expire.\n   *\n   * When set to false, cookies are not updated on each page load. This has the effect of cookie\n   * expiration being relative to the first time a user visited the site.\n   *\n   * @param update - Whether to update the cookie on each page load.\n   * @default true\n   */\n  gtag(event: 'set', option: 'cookie_update', update: boolean): void;\n\n  /**\n   * Set to true to indicate to Analytics that the referrer shouldn't be displayed as a traffic\n   * source. [Learn when to use this field](https://support.google.com/analytics/answer/10327750#set-parameter)\n   *\n   * @param ignore - Whether to ignore the referrer.\n   * @default false\n   */\n  gtag(event: 'set', option: 'ignore_referrer', ignore: boolean): void;\n\n  /**\n   * Specifies the language preference of the user. Defaults to the user's navigator.language value.\n   *\n   * @param language - The language preference of the user.\n   * @default navigator.language\n   */\n  gtag(event: 'set', option: 'language', language: string): void;\n\n  /**\n   * Specifies the full URL of the page. Defaults to the user's document.location value.\n   *\n   * @param location - The full URL of the page. Character limit 1000\n   * @default document.location\n   */\n  gtag(event: 'set', option: 'page_location', location: string): void;\n\n  /**\n   * Specifies which referral source brought traffic to a page. This value is also used to compute\n   * the traffic source. The format of this value is a URL. Defaults to the user's document.referrer\n   * value.\n   *\n   * @param referrer - The referral source. Character limit 420\n   * @default document.referrer\n   */\n  gtag(event: 'set', option: 'page_referrer', referrer: string): void;\n\n  /**\n   * The title of the page or document. Defaults to the user's document.title value.\n   *\n   * @param title - The title of the page or document. Character limit 300\n   * @default document.title\n   */\n  gtag(event: 'set', option: 'page_title', title: string): void;\n\n  /**\n   * Set to false to prevent the default snippet from sending a page_view.\n   *\n   * @param send - Whether to send a page_view.\n   * @default true\n   */\n  gtag(event: 'set', option: 'send_page_view', send: boolean): void;\n\n  /**\n   * Specifies the resolution of the screen. Should be two positive integers separated by an x. For\n   * example, for an 800px by 600px screen, the value would be 800x600. Calculated from the user's\n   * window.screen value.\n   *\n   * @param resolution - The resolution of the screen.\n   * @default window.screen\n   */\n  gtag(event: 'set', option: 'screen_resolution', resolution: `${number}x${number}`): void;\n\n  /**\n   * Specifies a known identifier for a user provided by the site owner/library user. It must not\n   * itself be PII (personally identifiable information). The value should never be persisted in\n   * Google Analytics cookies or other Analytics provided storage.\n   *\n   * @param userId - The user ID. Character limit 256\n   */\n  gtag(event: 'set', option: 'user_id', userId: string): void;\n\n  /**\n   * User properties are attributes that can be used to describe segments of your user base, such\n   * as language preference or geographic location. Up to 25 additional user properties can be set\n   * per project.\n   *\n   * @param name - The name of the user property. Character limit 24\n   * @param value - The value of the user property. Character limit 36\n   */\n  gtag(\n    event: 'set',\n    option: 'user_property',\n    properties: Record<string, string | boolean | number | null | undefined>\n  ): void;\n\n  /**\n   * gtag('config', ...) Set for a single stream\n   * gtag('set', ...) Set globally\n   */\n  gtag(event: 'config', gaId: GaId, config?: Config): void;\n\n  gtag<T extends string>(\n    event: 'event',\n    eventName: T extends keyof StandardEvents ? T : string,\n    eventParams?: T extends keyof StandardEvents\n      ? StandardEvents[T]\n      : Record<string, string | number | boolean | null | undefined>\n  ): void;\n}\n"],"mappings":";AAAO,IAAM,qBAAqB;AAAA,EAChC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,qBAAqB;AAAA,EAChC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;","names":[]}

package/dist/track/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/track/index.ts"],"sourcesContent":["import { TokenBucket } from 'limiter';\nimport {\n  CreateTrackEventDTO,\n  EventName,\n  TrackProperties,\n  TrackEventResponse,\n} from '../types/index';\nimport { config } from '../setup/index';\nimport { getVisitor } from '../visitor/index';\n\nexport interface TrackOptions {\n  enableThirdPartyTracking?: boolean;\n  onSucceed?: (response?: TrackEventResponse) => void;\n  onError?: (error: unknown) => void;\n}\n\nconst defaultOptions: TrackOptions = { enableThirdPartyTracking: true };\n\nconst REQUEST_TOKENS = 2;\nconst tokenBucket = new TokenBucket({\n  bucketSize: 20,\n  interval: 'second',\n  tokensPerInterval: 1,\n});\n\nasync function trackAsync<T extends EventName = EventName>(\n  name: T,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  try {\n    await tokenBucket.removeTokens(REQUEST_TOKENS);\n    const dto: CreateTrackEventDTO<T> = {\n      name,\n      properties,\n      tags: await config.getTags(),\n      visitor_id: (await getVisitor()).id,\n      timestamp: new Date().toISOString(),\n    };\n    const { data } = await config.http.post<TrackEventResponse>(`/events`, dto);\n\n    // send to third-party loggers, for example Google Analytics and Facebook Pixel\n    if (!trackOptions.enableThirdPartyTracking || !config.thirdPartyTrackers) return;\n    config.thirdPartyTrackers.forEach((tracker) => tracker(name, properties, data.id));\n    trackOptions.onSucceed?.(data);\n  } catch (e: unknown) {\n    if (e instanceof Error) {\n      console.log('Failed to send track event:', e.message);\n    }\n    trackOptions.onError?.(e);\n  }\n}\n\nexport function track<T extends EventName = EventName>(\n  name: T,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  trackAsync(name, properties, trackOptions).catch(console.error);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAA4B;AAO5B,mBAAuB;AACvB,qBAA2B;AAQ3B,IAAM,iBAA+B,EAAE,0BAA0B,KAAK;AAEtE,IAAM,iBAAiB;AACvB,IAAM,cAAc,IAAI,2BAAY;AAAA,EAClC,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,mBAAmB;AACrB,CAAC;AAED,eAAe,WACb,MACA,YACA,eAA6B,gBAC7B;AA7BF;AA8BE,MAAI;AACF,UAAM,YAAY,aAAa,cAAc;AAC7C,UAAM,MAA8B;AAAA,MAClC;AAAA,MACA;AAAA,MACA,MAAM,MAAM,oBAAO,QAAQ;AAAA,MAC3B,aAAa,UAAM,2BAAW,GAAG;AAAA,MACjC,YAAW,oBAAI,KAAK,GAAE,YAAY;AAAA,IACpC;AACA,UAAM,EAAE,KAAK,IAAI,MAAM,oBAAO,KAAK,KAAyB,WAAW,GAAG;AAG1E,QAAI,CAAC,aAAa,4BAA4B,CAAC,oBAAO,mBAAoB;AAC1E,wBAAO,mBAAmB,QAAQ,CAAC,YAAY,QAAQ,MAAM,YAAY,KAAK,EAAE,CAAC;AACjF,uBAAa,cAAb,sCAAyB;AAAA,EAC3B,SAAS,GAAY;AACnB,QAAI,aAAa,OAAO;AACtB,cAAQ,IAAI,+BAA+B,EAAE,OAAO;AAAA,IACtD;AACA,uBAAa,YAAb,sCAAuB;AAAA,EACzB;AACF;AAEO,SAAS,MACd,MACA,YACA,eAA6B,gBAC7B;AACA,aAAW,MAAM,YAAY,YAAY,EAAE,MAAM,QAAQ,KAAK;AAChE;","names":[]}
+{"version":3,"sources":["../../src/track/index.ts"],"sourcesContent":["import { TokenBucket } from 'limiter';\nimport { config } from '../setup/index';\nimport { getVisitor } from '../visitor/index';\nimport type {\n  CreateTrackEventDTO,\n  EventName,\n  TrackName,\n  TrackProperties,\n  TrackEventResponse,\n} from './types';\n\nexport interface TrackOptions {\n  enableThirdPartyTracking?: boolean;\n  onSucceed?: (response?: TrackEventResponse) => void;\n  onError?: (error: unknown) => void;\n}\n\nconst defaultOptions: TrackOptions = { enableThirdPartyTracking: true };\n\nconst REQUEST_TOKENS = 2;\nconst tokenBucket = new TokenBucket({\n  bucketSize: 20,\n  interval: 'second',\n  tokensPerInterval: 1,\n});\n\nasync function trackAsync<T extends EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  try {\n    await tokenBucket.removeTokens(REQUEST_TOKENS);\n    const dto: CreateTrackEventDTO<T> = {\n      name,\n      properties,\n      tags: await config.getTags(),\n      visitor_id: (await getVisitor()).id,\n      timestamp: new Date().toISOString(),\n    };\n    const { data } = await config.http.post<TrackEventResponse>(`/events`, dto);\n\n    // send to third-party loggers, for example Google Analytics and Facebook Pixel\n    if (!trackOptions.enableThirdPartyTracking || !config.thirdPartyTrackers) return;\n    config.thirdPartyTrackers.forEach((tracker) => tracker(name, properties, data.id));\n    trackOptions.onSucceed?.(data);\n  } catch (e: unknown) {\n    if (e instanceof Error) {\n      console.log('Failed to send track event:', e.message);\n    }\n    trackOptions.onError?.(e);\n  }\n}\n\nexport function track<T extends EventName = EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  trackAsync(name, properties, trackOptions).catch(console.error);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAA4B;AAC5B,mBAAuB;AACvB,qBAA2B;AAe3B,IAAM,iBAA+B,EAAE,0BAA0B,KAAK;AAEtE,IAAM,iBAAiB;AACvB,IAAM,cAAc,IAAI,2BAAY;AAAA,EAClC,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,mBAAmB;AACrB,CAAC;AAED,eAAe,WACb,MACA,YACA,eAA6B,gBAC7B;AA9BF;AA+BE,MAAI;AACF,UAAM,YAAY,aAAa,cAAc;AAC7C,UAAM,MAA8B;AAAA,MAClC;AAAA,MACA;AAAA,MACA,MAAM,MAAM,oBAAO,QAAQ;AAAA,MAC3B,aAAa,UAAM,2BAAW,GAAG;AAAA,MACjC,YAAW,oBAAI,KAAK,GAAE,YAAY;AAAA,IACpC;AACA,UAAM,EAAE,KAAK,IAAI,MAAM,oBAAO,KAAK,KAAyB,WAAW,GAAG;AAG1E,QAAI,CAAC,aAAa,4BAA4B,CAAC,oBAAO,mBAAoB;AAC1E,wBAAO,mBAAmB,QAAQ,CAAC,YAAY,QAAQ,MAAM,YAAY,KAAK,EAAE,CAAC;AACjF,uBAAa,cAAb,sCAAyB;AAAA,EAC3B,SAAS,GAAY;AACnB,QAAI,aAAa,OAAO;AACtB,cAAQ,IAAI,+BAA+B,EAAE,OAAO;AAAA,IACtD;AACA,uBAAa,YAAb,sCAAuB;AAAA,EACzB;AACF;AAEO,SAAS,MACd,MACA,YACA,eAA6B,gBAC7B;AACA,aAAW,MAAM,YAAY,YAAY,EAAE,MAAM,QAAQ,KAAK;AAChE;","names":[]}

package/dist/track/index.d.cts

@@ -1,10 +1,11 @@
-import { EventName, TrackProperties, TrackEventResponse } from '../types/index.cjs';
+import { EventName, TrackName, TrackProperties, TrackEventResponse } from './types.cjs';
+import './gtag.cjs';
 
 interface TrackOptions {
     enableThirdPartyTracking?: boolean;
     onSucceed?: (response?: TrackEventResponse) => void;
     onError?: (error: unknown) => void;
 }
-declare function track<T extends EventName = EventName>(name: T, properties?: TrackProperties<T>, trackOptions?: TrackOptions): void;
+declare function track<T extends EventName = EventName>(name: TrackName<T>, properties?: TrackProperties<T>, trackOptions?: TrackOptions): void;
 
 export { type TrackOptions, track };

package/dist/track/index.d.ts

@@ -1,10 +1,11 @@
-import { EventName, TrackProperties, TrackEventResponse } from '../types/index.js';
+import { EventName, TrackName, TrackProperties, TrackEventResponse } from './types.js';
+import './gtag.js';
 
 interface TrackOptions {
     enableThirdPartyTracking?: boolean;
     onSucceed?: (response?: TrackEventResponse) => void;
     onError?: (error: unknown) => void;
 }
-declare function track<T extends EventName = EventName>(name: T, properties?: TrackProperties<T>, trackOptions?: TrackOptions): void;
+declare function track<T extends EventName = EventName>(name: TrackName<T>, properties?: TrackProperties<T>, trackOptions?: TrackOptions): void;
 
 export { type TrackOptions, track };

package/dist/track/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/track/index.ts"],"sourcesContent":["import { TokenBucket } from 'limiter';\nimport {\n  CreateTrackEventDTO,\n  EventName,\n  TrackProperties,\n  TrackEventResponse,\n} from '../types/index';\nimport { config } from '../setup/index';\nimport { getVisitor } from '../visitor/index';\n\nexport interface TrackOptions {\n  enableThirdPartyTracking?: boolean;\n  onSucceed?: (response?: TrackEventResponse) => void;\n  onError?: (error: unknown) => void;\n}\n\nconst defaultOptions: TrackOptions = { enableThirdPartyTracking: true };\n\nconst REQUEST_TOKENS = 2;\nconst tokenBucket = new TokenBucket({\n  bucketSize: 20,\n  interval: 'second',\n  tokensPerInterval: 1,\n});\n\nasync function trackAsync<T extends EventName = EventName>(\n  name: T,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  try {\n    await tokenBucket.removeTokens(REQUEST_TOKENS);\n    const dto: CreateTrackEventDTO<T> = {\n      name,\n      properties,\n      tags: await config.getTags(),\n      visitor_id: (await getVisitor()).id,\n      timestamp: new Date().toISOString(),\n    };\n    const { data } = await config.http.post<TrackEventResponse>(`/events`, dto);\n\n    // send to third-party loggers, for example Google Analytics and Facebook Pixel\n    if (!trackOptions.enableThirdPartyTracking || !config.thirdPartyTrackers) return;\n    config.thirdPartyTrackers.forEach((tracker) => tracker(name, properties, data.id));\n    trackOptions.onSucceed?.(data);\n  } catch (e: unknown) {\n    if (e instanceof Error) {\n      console.log('Failed to send track event:', e.message);\n    }\n    trackOptions.onError?.(e);\n  }\n}\n\nexport function track<T extends EventName = EventName>(\n  name: T,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  trackAsync(name, properties, trackOptions).catch(console.error);\n}\n"],"mappings":";AAAA,SAAS,mBAAmB;AAO5B,SAAS,cAAc;AACvB,SAAS,kBAAkB;AAQ3B,IAAM,iBAA+B,EAAE,0BAA0B,KAAK;AAEtE,IAAM,iBAAiB;AACvB,IAAM,cAAc,IAAI,YAAY;AAAA,EAClC,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,mBAAmB;AACrB,CAAC;AAED,eAAe,WACb,MACA,YACA,eAA6B,gBAC7B;AA7BF;AA8BE,MAAI;AACF,UAAM,YAAY,aAAa,cAAc;AAC7C,UAAM,MAA8B;AAAA,MAClC;AAAA,MACA;AAAA,MACA,MAAM,MAAM,OAAO,QAAQ;AAAA,MAC3B,aAAa,MAAM,WAAW,GAAG;AAAA,MACjC,YAAW,oBAAI,KAAK,GAAE,YAAY;AAAA,IACpC;AACA,UAAM,EAAE,KAAK,IAAI,MAAM,OAAO,KAAK,KAAyB,WAAW,GAAG;AAG1E,QAAI,CAAC,aAAa,4BAA4B,CAAC,OAAO,mBAAoB;AAC1E,WAAO,mBAAmB,QAAQ,CAAC,YAAY,QAAQ,MAAM,YAAY,KAAK,EAAE,CAAC;AACjF,uBAAa,cAAb,sCAAyB;AAAA,EAC3B,SAAS,GAAY;AACnB,QAAI,aAAa,OAAO;AACtB,cAAQ,IAAI,+BAA+B,EAAE,OAAO;AAAA,IACtD;AACA,uBAAa,YAAb,sCAAuB;AAAA,EACzB;AACF;AAEO,SAAS,MACd,MACA,YACA,eAA6B,gBAC7B;AACA,aAAW,MAAM,YAAY,YAAY,EAAE,MAAM,QAAQ,KAAK;AAChE;","names":[]}
+{"version":3,"sources":["../../src/track/index.ts"],"sourcesContent":["import { TokenBucket } from 'limiter';\nimport { config } from '../setup/index';\nimport { getVisitor } from '../visitor/index';\nimport type {\n  CreateTrackEventDTO,\n  EventName,\n  TrackName,\n  TrackProperties,\n  TrackEventResponse,\n} from './types';\n\nexport interface TrackOptions {\n  enableThirdPartyTracking?: boolean;\n  onSucceed?: (response?: TrackEventResponse) => void;\n  onError?: (error: unknown) => void;\n}\n\nconst defaultOptions: TrackOptions = { enableThirdPartyTracking: true };\n\nconst REQUEST_TOKENS = 2;\nconst tokenBucket = new TokenBucket({\n  bucketSize: 20,\n  interval: 'second',\n  tokensPerInterval: 1,\n});\n\nasync function trackAsync<T extends EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  try {\n    await tokenBucket.removeTokens(REQUEST_TOKENS);\n    const dto: CreateTrackEventDTO<T> = {\n      name,\n      properties,\n      tags: await config.getTags(),\n      visitor_id: (await getVisitor()).id,\n      timestamp: new Date().toISOString(),\n    };\n    const { data } = await config.http.post<TrackEventResponse>(`/events`, dto);\n\n    // send to third-party loggers, for example Google Analytics and Facebook Pixel\n    if (!trackOptions.enableThirdPartyTracking || !config.thirdPartyTrackers) return;\n    config.thirdPartyTrackers.forEach((tracker) => tracker(name, properties, data.id));\n    trackOptions.onSucceed?.(data);\n  } catch (e: unknown) {\n    if (e instanceof Error) {\n      console.log('Failed to send track event:', e.message);\n    }\n    trackOptions.onError?.(e);\n  }\n}\n\nexport function track<T extends EventName = EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  trackAsync(name, properties, trackOptions).catch(console.error);\n}\n"],"mappings":";AAAA,SAAS,mBAAmB;AAC5B,SAAS,cAAc;AACvB,SAAS,kBAAkB;AAe3B,IAAM,iBAA+B,EAAE,0BAA0B,KAAK;AAEtE,IAAM,iBAAiB;AACvB,IAAM,cAAc,IAAI,YAAY;AAAA,EAClC,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,mBAAmB;AACrB,CAAC;AAED,eAAe,WACb,MACA,YACA,eAA6B,gBAC7B;AA9BF;AA+BE,MAAI;AACF,UAAM,YAAY,aAAa,cAAc;AAC7C,UAAM,MAA8B;AAAA,MAClC;AAAA,MACA;AAAA,MACA,MAAM,MAAM,OAAO,QAAQ;AAAA,MAC3B,aAAa,MAAM,WAAW,GAAG;AAAA,MACjC,YAAW,oBAAI,KAAK,GAAE,YAAY;AAAA,IACpC;AACA,UAAM,EAAE,KAAK,IAAI,MAAM,OAAO,KAAK,KAAyB,WAAW,GAAG;AAG1E,QAAI,CAAC,aAAa,4BAA4B,CAAC,OAAO,mBAAoB;AAC1E,WAAO,mBAAmB,QAAQ,CAAC,YAAY,QAAQ,MAAM,YAAY,KAAK,EAAE,CAAC;AACjF,uBAAa,cAAb,sCAAyB;AAAA,EAC3B,SAAS,GAAY;AACnB,QAAI,aAAa,OAAO;AACtB,cAAQ,IAAI,+BAA+B,EAAE,OAAO;AAAA,IACtD;AACA,uBAAa,YAAb,sCAAuB;AAAA,EACzB;AACF;AAEO,SAAS,MACd,MACA,YACA,eAA6B,gBAC7B;AACA,aAAW,MAAM,YAAY,YAAY,EAAE,MAAM,QAAQ,KAAK;AAChE;","names":[]}

package/dist/{types/index.cjs → track/types.cjs}

@@ -13,7 +13,7 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/types/index.ts
+// src/track/types.ts
 var types_exports = {};
 module.exports = __toCommonJS(types_exports);
-//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=types.cjs.map

package/dist/track/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/track/types.ts"],"sourcesContent":["import type { StandardEvents } from './gtag';\n\nexport type { Item } from './gtag';\n\nexport type AllowedPropertyValues = string | number | boolean | null;\nexport type EventName = Lowercase<string> | 'CLS' | 'FCP' | 'FID' | 'INP' | 'LCP' | 'TTFB';\n\nexport type TrackName<T extends EventName> = T extends keyof StandardEvents ? T : EventName;\nexport type TrackProperties<T extends EventName> = T extends keyof StandardEvents\n  ? StandardEvents[T]\n  : Record<Lowercase<string>, AllowedPropertyValues>;\n\nexport interface UserData {\n  userId: string;\n  email?: string;\n  firstName?: string;\n  lastName?: string;\n  phone?: string;\n  dateOfBirth?: string;\n  gender?: string;\n  city?: string;\n  state?: string;\n  postal?: string;\n  country?: string;\n}\n\nexport type ThirdPartyTracker = <T extends EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>,\n  event_id?: string\n) => void;\n\nexport interface PlatformInfo {\n  os?: string;\n  os_name?: string;\n  os_version?: string;\n  browser?: string;\n  browser_name?: string;\n  browser_version?: string;\n  platform?: 'ios' | 'android' | 'web' | 'macos' | 'windows' | 'linux' | 'unknown';\n}\n\nexport interface DeviceInfo {\n  device?: string;\n  device_id?: string;\n  device_type?: string;\n  device_vendor?: string;\n  device_pixel_ratio?: string;\n  screen_resolution?: `${number}x${number}`;\n}\n\nexport interface EnvironmentInfo {\n  release?: string;\n  language?: string;\n  timezone?: string;\n  environment?: 'development' | 'production';\n}\n\nexport interface SourceInfo {\n  source_url?: string;\n  source?: 'app' | 'web' | 'offline';\n}\n\nexport interface ThirdPartyFields {\n  /**\n   * Meta pixel fields\n   * ref: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters#fbc\n   * Stored in the _fbc/_fbp browser cookie under your domain\n   */\n  fbc?: string;\n  fbp?: string;\n  /**\n   * Google Analytics fields\n   */\n  gclid?: string;\n}\n\nexport interface UTMParams {\n  utm_source?: string;\n  utm_medium?: string;\n  utm_campaign?: string;\n  utm_term?: string;\n  utm_content?: string;\n}\n\nexport interface TrackTags\n  extends PlatformInfo,\n    DeviceInfo,\n    EnvironmentInfo,\n    SourceInfo,\n    ThirdPartyFields,\n    UTMParams {\n  [key: string]: string | undefined;\n}\n\nexport interface CreateTrackEventDTO<T extends EventName = EventName> {\n  name: string;\n  tags: TrackTags;\n  visitor_id: string;\n  properties?: TrackProperties<T>;\n  timestamp: string;\n}\n\nexport interface TrackEventResponse {\n  /**\n   * track event id\n   * some tracking system will use event_id and event_name for deduplication\n   * */\n  id: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}