@shware/analytics 3.5.2 → 3.6.0

package/dist/track/gtag.d.cts

@@ -21,7 +21,7 @@ type UserProperties = {
  *
  * Usage: gtag('set', 'user_data', { email: 'abc@abc.com' })
  *
- * In order to standardize the hash results, prior to hashing one of these values you must:
+ * To standardize the hash results, before hashing one of these values, you must:
  *
  * - Remove leading and trailing whitespaces.
  * - Convert the text to lowercase.
@@ -43,7 +43,7 @@ type UserProvidedDataAddress = {
     country?: string;
 };
 /**
- * In order to standardize the hash results, prior to hashing one of these values you must:
+ * To standardize the hash results, before hashing one of these values, you must:
  *
  * - Remove leading and trailing whitespaces.
  * - Convert the text to lowercase.
@@ -495,17 +495,23 @@ type RecommendedEvents = {
         engagement_time_msec?: number;
     };
 };
+/**
+ * Extra commonly used events that are NOT part of the GA standard event set.
+ * Added to satisfy additional analytics needs.
+ */
 type AddedRecommendedEvents = {
     logout: undefined;
     trial_begin: {
         currency: string;
         value: number;
         source?: string;
+        items?: Item[];
     };
     subscribe: {
         currency: string;
         value: number;
         source?: string;
+        items?: Item[];
     };
     survey_shown: SurveyProperties;
     survey_sent: SurveyProperties & SurveyQA;
@@ -551,6 +557,8 @@ interface Gtag {
      * To disable advertising features based on third-party advertising identifiers, set
      * allow_google_signals to false.
      *
+     * @param event
+     * @param option
      * @param allow - Whether to allow Google signals.
      * @default true
      */
@@ -558,6 +566,8 @@ interface Gtag {
     /**
      * Set to false to disable advertising personalization features.
      *
+     * @param event
+     * @param option
      * @param allow - Whether to allow ad personalization signals.
      * @default true
      */
@@ -599,10 +609,12 @@ interface Gtag {
      * 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
+     * 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 event
+     * @param option
      * @param domain - The domain used to store the analytics cookie.
      * @default 'auto'
      */
@@ -610,15 +622,17 @@ interface Gtag {
     /**
      * 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
+     * value time of two years (63,072,000 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
+     * 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 event
+     * @param option
      * @param expires - The number of seconds until the cookie expires.
      * @default 63072000
      */
@@ -642,6 +656,8 @@ interface Gtag {
      * 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 event
+     * @param option
      * @param update - Whether to update the cookie on each page load.
      * @default true
      */
@@ -650,36 +666,46 @@ interface Gtag {
      * 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 event
+     * @param option
      * @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.
+     * Specifies the language preference of the user. Defaults to the user's `navigator.language` value.
      *
+     * @param event
+     * @param option
      * @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.
+     * Specifies the full URL of the page. Defaults to the user's `document.location` value.
      *
+     * @param event
+     * @param option
      * @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
+     * the traffic source. The format of this value is a URL. Defaults to the user's `document.referrer`
      * value.
      *
+     * @param event
+     * @param option
      * @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.
+     * The title of the page or document. Defaults to the user's `document.title` value.
      *
+     * @param event
+     * @param option
      * @param title - The title of the page or document. Character limit 300
      * @default document.title
      */
@@ -687,6 +713,8 @@ interface Gtag {
     /**
      * Set to false to prevent the default snippet from sending a page_view.
      *
+     * @param event
+     * @param option
      * @param send - Whether to send a page_view.
      * @default true
      */
@@ -696,6 +724,8 @@ interface Gtag {
      * example, for an 800px by 600px screen, the value would be 800x600. Calculated from the user's
      * window.screen value.
      *
+     * @param event
+     * @param option
      * @param resolution - The resolution of the screen.
      * @default window.screen
      */
@@ -703,8 +733,10 @@ interface Gtag {
     /**
      * 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.
+     * Google Analytics cookies or other Analytics-provided storage.
      *
+     * @param event
+     * @param option
      * @param userId - The user ID. Character limit 256
      */
     gtag(event: 'set', option: 'user_id', userId: string): void;
@@ -713,8 +745,9 @@ interface Gtag {
      * 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
+     * @param event
+     * @param option
+     * @param properties
      */
     gtag(event: 'set', option: 'user_properties', properties: UserProperties): void;
     gtag(event: 'set', option: 'user_data', data: UserProvidedData): void;

package/dist/track/gtag.d.ts

@@ -21,7 +21,7 @@ type UserProperties = {
  *
  * Usage: gtag('set', 'user_data', { email: 'abc@abc.com' })
  *
- * In order to standardize the hash results, prior to hashing one of these values you must:
+ * To standardize the hash results, before hashing one of these values, you must:
  *
  * - Remove leading and trailing whitespaces.
  * - Convert the text to lowercase.
@@ -43,7 +43,7 @@ type UserProvidedDataAddress = {
     country?: string;
 };
 /**
- * In order to standardize the hash results, prior to hashing one of these values you must:
+ * To standardize the hash results, before hashing one of these values, you must:
  *
  * - Remove leading and trailing whitespaces.
  * - Convert the text to lowercase.
@@ -495,17 +495,23 @@ type RecommendedEvents = {
         engagement_time_msec?: number;
     };
 };
+/**
+ * Extra commonly used events that are NOT part of the GA standard event set.
+ * Added to satisfy additional analytics needs.
+ */
 type AddedRecommendedEvents = {
     logout: undefined;
     trial_begin: {
         currency: string;
         value: number;
         source?: string;
+        items?: Item[];
     };
     subscribe: {
         currency: string;
         value: number;
         source?: string;
+        items?: Item[];
     };
     survey_shown: SurveyProperties;
     survey_sent: SurveyProperties & SurveyQA;
@@ -551,6 +557,8 @@ interface Gtag {
      * To disable advertising features based on third-party advertising identifiers, set
      * allow_google_signals to false.
      *
+     * @param event
+     * @param option
      * @param allow - Whether to allow Google signals.
      * @default true
      */
@@ -558,6 +566,8 @@ interface Gtag {
     /**
      * Set to false to disable advertising personalization features.
      *
+     * @param event
+     * @param option
      * @param allow - Whether to allow ad personalization signals.
      * @default true
      */
@@ -599,10 +609,12 @@ interface Gtag {
      * 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
+     * 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 event
+     * @param option
      * @param domain - The domain used to store the analytics cookie.
      * @default 'auto'
      */
@@ -610,15 +622,17 @@ interface Gtag {
     /**
      * 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
+     * value time of two years (63,072,000 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
+     * 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 event
+     * @param option
      * @param expires - The number of seconds until the cookie expires.
      * @default 63072000
      */
@@ -642,6 +656,8 @@ interface Gtag {
      * 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 event
+     * @param option
      * @param update - Whether to update the cookie on each page load.
      * @default true
      */
@@ -650,36 +666,46 @@ interface Gtag {
      * 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 event
+     * @param option
      * @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.
+     * Specifies the language preference of the user. Defaults to the user's `navigator.language` value.
      *
+     * @param event
+     * @param option
      * @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.
+     * Specifies the full URL of the page. Defaults to the user's `document.location` value.
      *
+     * @param event
+     * @param option
      * @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
+     * the traffic source. The format of this value is a URL. Defaults to the user's `document.referrer`
      * value.
      *
+     * @param event
+     * @param option
      * @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.
+     * The title of the page or document. Defaults to the user's `document.title` value.
      *
+     * @param event
+     * @param option
      * @param title - The title of the page or document. Character limit 300
      * @default document.title
      */
@@ -687,6 +713,8 @@ interface Gtag {
     /**
      * Set to false to prevent the default snippet from sending a page_view.
      *
+     * @param event
+     * @param option
      * @param send - Whether to send a page_view.
      * @default true
      */
@@ -696,6 +724,8 @@ interface Gtag {
      * example, for an 800px by 600px screen, the value would be 800x600. Calculated from the user's
      * window.screen value.
      *
+     * @param event
+     * @param option
      * @param resolution - The resolution of the screen.
      * @default window.screen
      */
@@ -703,8 +733,10 @@ interface Gtag {
     /**
      * 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.
+     * Google Analytics cookies or other Analytics-provided storage.
      *
+     * @param event
+     * @param option
      * @param userId - The user ID. Character limit 256
      */
     gtag(event: 'set', option: 'user_id', userId: string): void;
@@ -713,8 +745,9 @@ interface Gtag {
      * 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
+     * @param event
+     * @param option
+     * @param properties
      */
     gtag(event: 'set', option: 'user_properties', properties: UserProperties): void;
     gtag(event: 'set', option: 'user_data', data: UserProvidedData): void;

package/dist/track/gtag.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/track/gtag.ts"],"sourcesContent":["/** reference: https://support.google.com/analytics/answer/13316687 */\nconst reservedWebEventNames = [\n  'app_remove',\n  'app_store_refund',\n  'app_store_subscription_cancel',\n  'app_store_subscription_renew',\n  'click',\n  'error',\n  'file_download',\n  'first_open',\n  'first_visit',\n  'form_start',\n  'form_submit',\n  'in_app_purchase',\n  'page_view',\n  'scroll',\n  'session_start',\n  'user_engagement',\n  'view_complete',\n  'video_progress',\n  'video_start',\n  'view_search_results',\n] as const;\n\nconst reservedAppEventNames = [\n  'ad_activeview',\n  'ad_click',\n  'ad_exposure',\n  'ad_impression',\n  'ad_query',\n  'ad_reward',\n  'adunit_exposure',\n  'app_clear_data',\n  'app_exception',\n  'app_install',\n  'app_remove',\n  'app_store_refund',\n  'app_update',\n  'app_upgrade',\n  'dynamic_link_app_open',\n  'dynamic_link_app_update',\n  'dynamic_link_first_open',\n  'error',\n  'firebase_campaign',\n  'firebase_in_app_message_action',\n  'firebase_in_app_message_dismiss',\n  'firebase_in_app_message_impression',\n  'first_open',\n  'first_visit',\n  'in_app_purchase',\n  'notification_dismiss',\n  'notification_foreground',\n  'notification_open',\n  'notification_receive',\n  'notification_send',\n  'os_update',\n  'screen_view',\n  'session_start',\n  'user_engagement',\n] as const;\n\nexport const reservedEventNames = [...reservedWebEventNames, ...reservedAppEventNames] as const;\n\ntype ReservedWebEventNames = (typeof reservedWebEventNames)[number];\ntype ReservedAppEventNames = (typeof reservedAppEventNames)[number];\nexport type ReservedEventNames = ReservedWebEventNames | ReservedAppEventNames;\n\nexport type ReservedEventValues =\n  | 'cid'\n  | 'currency'\n  | 'customer_id'\n  | 'customerid'\n  | 'dclid'\n  | 'gclid'\n  | 'session_id'\n  | 'sessionid'\n  | 'sfmc_id'\n  | 'sid'\n  | 'srsltid'\n  | 'uid'\n  | 'user_id'\n  | 'userid'\n  | `_${string}`\n  | `firebase_${string}`\n  | `ga_${string}`\n  | `google_${string}`\n  | `gtag.${string}`;\n\nexport type ReservedUserPropertiesNames =\n  | 'cid'\n  | 'customer_id'\n  | 'customerid'\n  | 'first_open_after_install'\n  | 'first_open_time'\n  | 'first_visit_time'\n  | 'google_allow_ad_personalization_signals'\n  | 'last_advertising_id_reset'\n  | 'last_deep_link_referrer'\n  | 'last_gclid'\n  | 'lifetime_user_engagement'\n  | 'non_personalized_ads'\n  | 'session_id'\n  | 'session_number'\n  | 'sessionid'\n  | 'sfmc_id'\n  | 'sid'\n  | 'uid'\n  | 'user_id'\n  | 'userid'\n  | `_${string}`\n  | `firebase_${string}`\n  | `ga_${string}`\n  | `google_${string}`;\n\nexport type UserPropertiesValue = string | boolean | number | null | undefined;\nexport type UserProperties = {\n  [key: string]: UserPropertiesValue;\n} & {\n  [key in ReservedUserPropertiesNames]?: never;\n};\n\n/**\n * reference: https://support.google.com/analytics/answer/14078702\n * You must turn on user-provided data collection in Google Analytics.\n *\n * Validate your user-provided data implementation: https://support.google.com/analytics/answer/14171683\n *\n * Usage: gtag('set', 'user_data', { email: 'abc@abc.com' })\n *\n * In order to standardize the hash results, prior to hashing one of these values you must:\n *\n * - Remove leading and trailing whitespaces.\n * - Convert the text to lowercase.\n * - Format phone numbers according to the E164 standard.\n * - Remove all periods (.) that precede the domain name in gmail.com and googlemail.com email addresses.\n * */\ntype UserProvidedDataAddress = {\n  first_name?: string;\n  last_name?: string;\n  street?: string;\n  city?: string;\n  /** User province, state, or region. Example: `Hampshire` */\n  region?: string;\n  postal_code?: string;\n  /**\n   * User country code.\n   * Example: 'UK'. Use 2-letter country codes, per the ISO 3166-1 alpha-2 standard.\n   */\n  country?: string;\n};\n\n/**\n * In order to standardize the hash results, prior to hashing one of these values you must:\n *\n * - Remove leading and trailing whitespaces.\n * - Convert the text to lowercase.\n * - Format phone numbers according to the E164 standard.\n * - Remove all periods (.) that precede the domain name in gmail.com and googlemail.com email addresses.\n */\nexport type UserProvidedData = {\n  email?: string | string[];\n  /**\n   * User phone number. Must be in E.164 format, which means it must be 11 to 15 digits including a\n   * plus sign (+) prefix and country code with no dashes, parentheses, or spaces.\n   *\n   * Example: ‘+11231234567’\n   */\n  phone_number?: string | string[];\n  address?: UserProvidedDataAddress | UserProvidedDataAddress[];\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_properties?: UserProperties;\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\nexport type SurveyProperties = {\n  id?: string;\n  feature?: Lowercase<string>;\n  trigger?: Lowercase<string>;\n};\n\nexport type SurveyQA = {\n  q1: string;\n  a1: string;\n  q2?: string;\n  a2?: string;\n  q3?: string;\n  a3?: string;\n  q4?: string;\n  a4?: string;\n  q5?: string;\n  a5?: string;\n  q6?: string;\n  a6?: string;\n  completed?: boolean;\n};\n\nexport type NPSScore = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | number;\nexport type CASTScore = 1 | 2 | 3 | 4 | 5 | number;\nexport type CESScore = 1 | 2 | 3 | 4 | 5 | number;\n\n/** ref: https://support.google.com/analytics/answer/9216061 */\nexport type EnhancedMeasurementEvents = {\n  page_view: {\n    page_path: string;\n    page_title: string;\n    page_referrer?: string;\n    page_location?: string;\n    previous_page_path?: string;\n    engagement_time_msec?: number;\n  };\n  // Scrolls: the first time a user reaches the bottom of each page\n  // (i.e., when a 90% vertical depth becomes visible)\n  scroll: {\n    engagement_time_msec: number;\n  };\n  // Outbound clicks\n  click: {\n    link_id: string;\n    link_url: string;\n    link_text: string; // added\n    link_domain: string;\n    link_classes: string;\n    outbound: boolean;\n  };\n  // Site search\n  view_search_results: {\n    search_term: string;\n  };\n  // Video engagement\n  video_start: {\n    video_current_time: number;\n    video_duration: number;\n    video_percent: number;\n    video_provider: 'youtube' | 'vimeo' | 'html5' | (string & {});\n    video_title: string;\n    video_url: string;\n    visible: boolean;\n  };\n  video_progress: {\n    video_current_time: number;\n    video_duration: number;\n    video_percent: number;\n    video_provider: 'youtube' | 'vimeo' | 'html5' | (string & {});\n    video_title: string;\n    video_url: string;\n    visible: boolean;\n  };\n  video_complete: {\n    video_current_time: number;\n    video_duration: number;\n    video_percent: number;\n    video_provider: 'youtube' | 'vimeo' | 'html5' | (string & {});\n    video_title: string;\n    video_url: string;\n    visible: boolean;\n  };\n  // File downloads:\n  file_download: {\n    file_extension: string;\n    file_name: string;\n    link_classes: string;\n    link_id: string;\n    link_text: string;\n    link_url: string;\n  };\n  // Form interactions\n  form_start: {\n    form_id: string;\n    form_name: string;\n    form_destination: string;\n  };\n  form_submit: {\n    form_id: string;\n    form_name: string;\n    form_destination: string;\n    form_submit_text: string;\n  };\n};\n\n/** ref: https://support.google.com/analytics/answer/9234069  */\nexport type AutomaticallyCollectedEvents = EnhancedMeasurementEvents & {\n  first_visit: {\n    page_path: string;\n    page_title: string;\n    page_referrer?: string;\n    page_location?: string;\n  };\n  first_open: {\n    screen_name: string;\n    screen_class: string;\n  };\n  in_app_purchase: {\n    product_id: string;\n    price: number;\n    value: number;\n    currency: string;\n    quantity: number;\n    subscription?: boolean;\n    free_trial?: boolean;\n    introductory_price?: number;\n  };\n  notification_dismiss: {\n    // Android only\n    topic: string;\n    label: string;\n    message_id: string;\n    message_name: string;\n    message_time: number;\n    message_device_time: number;\n    message_channel: string;\n  };\n  notification_foreground: {\n    topic: string;\n    label: string;\n    message_id: string;\n    message_name: string;\n    message_type: string;\n    message_time: number;\n    message_device_time: number;\n    message_channel: string;\n  };\n  notification_open: {\n    topic: string;\n    label: string;\n    message_id: string;\n    message_name: string;\n    message_time: number;\n    message_device_time: number;\n    message_channel: string;\n  };\n  notification_receive: {\n    // Android only\n    topic: string;\n    label: string;\n    message_id: string;\n    message_name: string;\n    message_type: string;\n    message_time: number;\n    message_device_time: number;\n    message_channel: string;\n  };\n  // Note: The 'screen_view' event is automatically sent only when using Android or iOS native SDKs.\n  // If you are using React Native, you need to send this event manually; it should not be ignored.\n  session_start: undefined;\n  user_engagement: {\n    engagement_time_msec: number;\n    trigger: 'pagehide' | 'visibilitychange' | 'background';\n  };\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 RecommendedEvents = {\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    source?: string; // added\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?:\n      | 'google'\n      | 'apple'\n      | 'facebook'\n      | 'twitter'\n      | 'linkedin'\n      | 'github'\n      | 'microsoft'\n      | 'wechat'\n      | 'onetap'\n      | 'phone'\n      | 'email'\n      | (string & {});\n    source?: string; // added\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    source?: string; // added\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    system_activity_type?: string; // added\n    platform_post_id?: string; // added\n  };\n  sign_up: {\n    method?: string;\n    source?: string; // added\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: {\n    screen_name?: string;\n    screen_class?: string;\n    previous_screen_class?: string; // added\n    engagement_time_msec?: number;\n  };\n};\n\nexport type AddedRecommendedEvents = {\n  logout: undefined;\n  trial_begin: {\n    currency: string;\n    value: number;\n    source?: string; // added\n  };\n  subscribe: {\n    currency: string;\n    value: number;\n    source?: string; // added\n  };\n  // survey\n  survey_shown: SurveyProperties;\n  survey_sent: SurveyProperties & SurveyQA;\n  survey_dismissed: SurveyProperties;\n  /**\n   * Net promoter score: Get an industry-recognized benchmark\n   * How likely are you to recommend us to a friend?\n   * */\n  nps_shown: SurveyProperties;\n  nps_sent: SurveyProperties & { score: NPSScore; feedback?: string };\n  nps_dismissed: SurveyProperties;\n  /**\n   * Customer satisfaction score: Works best after a checkout or support flow\n   * How satisfied are you with xxx?\n   * */\n  cast_shown: SurveyProperties;\n  cast_sent: SurveyProperties & { score: CASTScore; feedback?: string };\n  cast_dismissed: SurveyProperties;\n  /**\n   * Customer effort score: Works well with churn surveys\n   * How easy is it to use the feature?\n   * */\n  ces_shown: SurveyProperties;\n  ces_sent: SurveyProperties & { score: CESScore; feedback?: string };\n  ces_dismissed: SurveyProperties;\n};\n\nexport type StandardEvents = AutomaticallyCollectedEvents &\n  RecommendedEvents &\n  AddedRecommendedEvents;\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(event: 'set', option: 'user_properties', properties: UserProperties): void;\n\n  gtag(event: 'set', option: 'user_data', data: UserProvidedData): 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":";AACA,IAAM,wBAAwB;AAAA,EAC5B;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;AAEA,IAAM,wBAAwB;AAAA,EAC5B;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,CAAC,GAAG,uBAAuB,GAAG,qBAAqB;","names":[]}
+{"version":3,"sources":["../../src/track/gtag.ts"],"sourcesContent":["/** reference: https://support.google.com/analytics/answer/13316687 */\nconst reservedWebEventNames = [\n  'app_remove',\n  'app_store_refund',\n  'app_store_subscription_cancel',\n  'app_store_subscription_renew',\n  'click',\n  'error',\n  'file_download',\n  'first_open',\n  'first_visit',\n  'form_start',\n  'form_submit',\n  'in_app_purchase',\n  'page_view',\n  'scroll',\n  'session_start',\n  'user_engagement',\n  'view_complete',\n  'video_progress',\n  'video_start',\n  'view_search_results',\n] as const;\n\nconst reservedAppEventNames = [\n  'ad_activeview',\n  'ad_click',\n  'ad_exposure',\n  'ad_impression',\n  'ad_query',\n  'ad_reward',\n  'adunit_exposure',\n  'app_clear_data',\n  'app_exception',\n  'app_install',\n  'app_remove',\n  'app_store_refund',\n  'app_update',\n  'app_upgrade',\n  'dynamic_link_app_open',\n  'dynamic_link_app_update',\n  'dynamic_link_first_open',\n  'error',\n  'firebase_campaign',\n  'firebase_in_app_message_action',\n  'firebase_in_app_message_dismiss',\n  'firebase_in_app_message_impression',\n  'first_open',\n  'first_visit',\n  'in_app_purchase',\n  'notification_dismiss',\n  'notification_foreground',\n  'notification_open',\n  'notification_receive',\n  'notification_send',\n  'os_update',\n  'screen_view',\n  'session_start',\n  'user_engagement',\n] as const;\n\nexport const reservedEventNames = [...reservedWebEventNames, ...reservedAppEventNames] as const;\n\ntype ReservedWebEventNames = (typeof reservedWebEventNames)[number];\ntype ReservedAppEventNames = (typeof reservedAppEventNames)[number];\nexport type ReservedEventNames = ReservedWebEventNames | ReservedAppEventNames;\n\nexport type ReservedEventValues =\n  | 'cid'\n  | 'currency'\n  | 'customer_id'\n  | 'customerid'\n  | 'dclid'\n  | 'gclid'\n  | 'session_id'\n  | 'sessionid'\n  | 'sfmc_id'\n  | 'sid'\n  | 'srsltid'\n  | 'uid'\n  | 'user_id'\n  | 'userid'\n  | `_${string}`\n  | `firebase_${string}`\n  | `ga_${string}`\n  | `google_${string}`\n  | `gtag.${string}`;\n\nexport type ReservedUserPropertiesNames =\n  | 'cid'\n  | 'customer_id'\n  | 'customerid'\n  | 'first_open_after_install'\n  | 'first_open_time'\n  | 'first_visit_time'\n  | 'google_allow_ad_personalization_signals'\n  | 'last_advertising_id_reset'\n  | 'last_deep_link_referrer'\n  | 'last_gclid'\n  | 'lifetime_user_engagement'\n  | 'non_personalized_ads'\n  | 'session_id'\n  | 'session_number'\n  | 'sessionid'\n  | 'sfmc_id'\n  | 'sid'\n  | 'uid'\n  | 'user_id'\n  | 'userid'\n  | `_${string}`\n  | `firebase_${string}`\n  | `ga_${string}`\n  | `google_${string}`;\n\nexport type UserPropertiesValue = string | boolean | number | null | undefined;\nexport type UserProperties = {\n  [key: string]: UserPropertiesValue;\n} & {\n  [key in ReservedUserPropertiesNames]?: never;\n};\n\n/**\n * reference: https://support.google.com/analytics/answer/14078702\n * You must turn on user-provided data collection in Google Analytics.\n *\n * Validate your user-provided data implementation: https://support.google.com/analytics/answer/14171683\n *\n * Usage: gtag('set', 'user_data', { email: 'abc@abc.com' })\n *\n * To standardize the hash results, before hashing one of these values, you must:\n *\n * - Remove leading and trailing whitespaces.\n * - Convert the text to lowercase.\n * - Format phone numbers according to the E164 standard.\n * - Remove all periods (.) that precede the domain name in gmail.com and googlemail.com email addresses.\n * */\ntype UserProvidedDataAddress = {\n  first_name?: string;\n  last_name?: string;\n  street?: string;\n  city?: string;\n  /** User province, state, or region. Example: `Hampshire` */\n  region?: string;\n  postal_code?: string;\n  /**\n   * User country code.\n   * Example: 'UK'. Use 2-letter country codes, per the ISO 3166-1 alpha-2 standard.\n   */\n  country?: string;\n};\n\n/**\n * To standardize the hash results, before hashing one of these values, you must:\n *\n * - Remove leading and trailing whitespaces.\n * - Convert the text to lowercase.\n * - Format phone numbers according to the E164 standard.\n * - Remove all periods (.) that precede the domain name in gmail.com and googlemail.com email addresses.\n */\nexport type UserProvidedData = {\n  email?: string | string[];\n  /**\n   * User phone number. Must be in E.164 format, which means it must be 11 to 15 digits including a\n   * plus sign (+) prefix and country code with no dashes, parentheses, or spaces.\n   *\n   * Example: ‘+11231234567’\n   */\n  phone_number?: string | string[];\n  address?: UserProvidedDataAddress | UserProvidedDataAddress[];\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_properties?: UserProperties;\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\nexport type SurveyProperties = {\n  id?: string;\n  feature?: Lowercase<string>;\n  trigger?: Lowercase<string>;\n};\n\nexport type SurveyQA = {\n  q1: string;\n  a1: string;\n  q2?: string;\n  a2?: string;\n  q3?: string;\n  a3?: string;\n  q4?: string;\n  a4?: string;\n  q5?: string;\n  a5?: string;\n  q6?: string;\n  a6?: string;\n  completed?: boolean;\n};\n\nexport type NPSScore = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | number;\nexport type CASTScore = 1 | 2 | 3 | 4 | 5 | number;\nexport type CESScore = 1 | 2 | 3 | 4 | 5 | number;\n\n/** ref: https://support.google.com/analytics/answer/9216061 */\nexport type EnhancedMeasurementEvents = {\n  page_view: {\n    page_path: string;\n    page_title: string;\n    page_referrer?: string;\n    page_location?: string;\n    previous_page_path?: string;\n    engagement_time_msec?: number;\n  };\n  // Scrolls: the first time a user reaches the bottom of each page\n  // (i.e., when a 90% vertical depth becomes visible)\n  scroll: {\n    engagement_time_msec: number;\n  };\n  // Outbound clicks\n  click: {\n    link_id: string;\n    link_url: string;\n    link_text: string; // added\n    link_domain: string;\n    link_classes: string;\n    outbound: boolean;\n  };\n  // Site search\n  view_search_results: {\n    search_term: string;\n  };\n  // Video engagement\n  video_start: {\n    video_current_time: number;\n    video_duration: number;\n    video_percent: number;\n    video_provider: 'youtube' | 'vimeo' | 'html5' | (string & {});\n    video_title: string;\n    video_url: string;\n    visible: boolean;\n  };\n  video_progress: {\n    video_current_time: number;\n    video_duration: number;\n    video_percent: number;\n    video_provider: 'youtube' | 'vimeo' | 'html5' | (string & {});\n    video_title: string;\n    video_url: string;\n    visible: boolean;\n  };\n  video_complete: {\n    video_current_time: number;\n    video_duration: number;\n    video_percent: number;\n    video_provider: 'youtube' | 'vimeo' | 'html5' | (string & {});\n    video_title: string;\n    video_url: string;\n    visible: boolean;\n  };\n  // File downloads:\n  file_download: {\n    file_extension: string;\n    file_name: string;\n    link_classes: string;\n    link_id: string;\n    link_text: string;\n    link_url: string;\n  };\n  // Form interactions\n  form_start: {\n    form_id: string;\n    form_name: string;\n    form_destination: string;\n  };\n  form_submit: {\n    form_id: string;\n    form_name: string;\n    form_destination: string;\n    form_submit_text: string;\n  };\n};\n\n/** ref: https://support.google.com/analytics/answer/9234069  */\nexport type AutomaticallyCollectedEvents = EnhancedMeasurementEvents & {\n  first_visit: {\n    page_path: string;\n    page_title: string;\n    page_referrer?: string;\n    page_location?: string;\n  };\n  first_open: {\n    screen_name: string;\n    screen_class: string;\n  };\n  in_app_purchase: {\n    product_id: string;\n    price: number;\n    value: number;\n    currency: string;\n    quantity: number;\n    subscription?: boolean;\n    free_trial?: boolean;\n    introductory_price?: number;\n  };\n  notification_dismiss: {\n    // Android only\n    topic: string;\n    label: string;\n    message_id: string;\n    message_name: string;\n    message_time: number;\n    message_device_time: number;\n    message_channel: string;\n  };\n  notification_foreground: {\n    topic: string;\n    label: string;\n    message_id: string;\n    message_name: string;\n    message_type: string;\n    message_time: number;\n    message_device_time: number;\n    message_channel: string;\n  };\n  notification_open: {\n    topic: string;\n    label: string;\n    message_id: string;\n    message_name: string;\n    message_time: number;\n    message_device_time: number;\n    message_channel: string;\n  };\n  notification_receive: {\n    // Android only\n    topic: string;\n    label: string;\n    message_id: string;\n    message_name: string;\n    message_type: string;\n    message_time: number;\n    message_device_time: number;\n    message_channel: string;\n  };\n  // Note: The 'screen_view' event is automatically sent only when using Android or iOS native SDKs.\n  // If you are using React Native, you need to send this event manually; it should not be ignored.\n  session_start: undefined;\n  user_engagement: {\n    engagement_time_msec: number;\n    trigger: 'pagehide' | 'visibilitychange' | 'background';\n  };\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 RecommendedEvents = {\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    source?: string; // added\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?:\n      | 'google'\n      | 'apple'\n      | 'facebook'\n      | 'twitter'\n      | 'linkedin'\n      | 'github'\n      | 'microsoft'\n      | 'wechat'\n      | 'onetap'\n      | 'phone'\n      | 'email'\n      | (string & {});\n    source?: string; // added\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    source?: string; // added\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    system_activity_type?: string; // added\n    platform_post_id?: string; // added\n  };\n  sign_up: {\n    method?: string;\n    source?: string; // added\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: {\n    screen_name?: string;\n    screen_class?: string;\n    previous_screen_class?: string; // added\n    engagement_time_msec?: number;\n  };\n};\n\n/**\n * Extra commonly used events that are NOT part of the GA standard event set.\n * Added to satisfy additional analytics needs.\n */\nexport type AddedRecommendedEvents = {\n  logout: undefined;\n  trial_begin: {\n    currency: string;\n    value: number;\n    source?: string; // added\n    items?: Item[]; // added, the plan(s) enrolled (first item's id maps to OpenAI plan_id)\n  };\n  subscribe: {\n    currency: string;\n    value: number;\n    source?: string; // added\n    items?: Item[]; // added, the plan(s) enrolled (first item's id maps to OpenAI plan_id)\n  };\n  // survey\n  survey_shown: SurveyProperties;\n  survey_sent: SurveyProperties & SurveyQA;\n  survey_dismissed: SurveyProperties;\n  /**\n   * Net promoter score: Get an industry-recognized benchmark\n   * How likely are you to recommend us to a friend?\n   * */\n  nps_shown: SurveyProperties;\n  nps_sent: SurveyProperties & { score: NPSScore; feedback?: string };\n  nps_dismissed: SurveyProperties;\n  /**\n   * Customer satisfaction score: Works best after a checkout or support flow\n   * How satisfied are you with xxx?\n   * */\n  cast_shown: SurveyProperties;\n  cast_sent: SurveyProperties & { score: CASTScore; feedback?: string };\n  cast_dismissed: SurveyProperties;\n  /**\n   * Customer effort score: Works well with churn surveys\n   * How easy is it to use the feature?\n   * */\n  ces_shown: SurveyProperties;\n  ces_sent: SurveyProperties & { score: CESScore; feedback?: string };\n  ces_dismissed: SurveyProperties;\n};\n\nexport type StandardEvents = AutomaticallyCollectedEvents &\n  RecommendedEvents &\n  AddedRecommendedEvents;\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 (63,072,000 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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\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 event\n   * @param option\n   * @param properties\n   */\n  gtag(event: 'set', option: 'user_properties', properties: UserProperties): void;\n\n  gtag(event: 'set', option: 'user_data', data: UserProvidedData): 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":";AACA,IAAM,wBAAwB;AAAA,EAC5B;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;AAEA,IAAM,wBAAwB;AAAA,EAC5B;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,CAAC,GAAG,uBAAuB,GAAG,qBAAqB;","names":[]}