@shware/analytics 0.1.17 → 0.1.18

package/dist/track/fbq.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/track/fbq.ts"],"sourcesContent":["import type { EventName, TrackName, TrackProperties, Item } from './types';\nexport type Content = { id: string; quantity: number; [key: string]: unknown };\n\n/**\n * reference: https://developers.facebook.com/docs/meta-pixel/advanced/advanced-matching\n * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters\n */\nexport type MatchingParameters = {\n  /** Email: Unhashed lowercase or hashed SHA-256 */\n  em?: string;\n\n  /** First Name: Lowercase letters */\n  fn?: string;\n\n  /** Last Name: Lowercase letters */\n  ln?: string;\n\n  /** Phone Number: Digits only including country code and area code */\n  ph?: string;\n\n  /**\n   * External ID: Any unique ID from the advertiser, such as loyalty membership ID, user ID, and\n   * external cookie ID.\n   */\n  external_id?: string;\n\n  /** Gender: Single lowercase letter, f or m, if unknown, leave blank */\n  ge?: 'f' | 'm' | '';\n\n  /** Birthdate: Digits only with birth year, month, then day, YYYYMMDD */\n  db?: number;\n\n  /** City: Lowercase with any spaces removed, e.g. \"menlopark\" */\n  ct?: string;\n\n  /** State or Province: Lowercase two-letter state or province code, e.g. \"ca\" */\n  st?: string;\n\n  /** Zip or Postal Code: String */\n  zp?: string;\n\n  /** Country: Lowercase two-letter country code, e.g. \"us\" */\n  country?: string;\n\n  /** Client IP Address: Do not hash. */\n  client_ip_address?: string;\n\n  /** Client User Agent: Do not hash. */\n  client_user_agent?: string;\n\n  /**\n   * Click ID: Do not hash.\n   * The Facebook click ID value is stored in the _fbc browser cookie under your domain. See\n   * Managing fbc and fbp Parameters for how to get this value or generate this value from a fbclid\n   * query parameter.\n   *\n   * The format is fb.${subdomain_index}.${creation_time}.${fbclid}.\n   */\n  fbc?: string;\n\n  /**\n   * Browser ID: Do not hash.\n   * The Facebook browser ID value is stored in the _fbp browser cookie under your domain. See\n   * Managing fbc and fbp Parameters for how to get this value.\n   *\n   * The format is fb.${subdomain_index}.${creation_time}.${random_number}.\n   */\n  fbp?: string;\n\n  /**\n   * Subscription ID: Do not hash.\n   * The subscription ID for the user in this transaction; it is similar to the order ID for an\n   * individual product.\n   */\n  subscription_id?: string;\n\n  /**\n   * Facebook Login ID: Do not hash.\n   * The ID issued by Meta when a person first logs into an instance of an app. This is also known\n   * as App-Scoped ID.\n   */\n  fb_login_id?: number;\n\n  /**\n   * Lead ID: Do not hash.\n   * The ID associated with a lead generated by [Meta's Lead Ads](https://developers.facebook.com/docs/marketing-api/guides/lead-ads).\n   */\n  lead_id?: number;\n\n  /**\n   * Install ID: Do not hash.\n   * Your install ID. This field represents unique application installation instances.\n   * Note: This parameter is for app events only.\n   */\n  anon_id?: string;\n\n  /**\n   * Your mobile advertiser ID, the advertising ID from an Android device or the Advertising\n   * Identifier (IDFA) from an Apple device.\n   */\n  madid?: string;\n\n  /**\n   * Page ID: Do not hash.\n   * Your Page ID. Specifies the page ID associated with the event. Use the Facebook page ID of the\n   * page associated with the bot.\n   */\n  page_id?: string;\n\n  /**\n   * Page Scoped User ID: Do not hash.\n   * Specifies the page-scoped user ID associated with the messenger bot that logs the event. Use\n   * the page-scoped user ID provided to your webhook.\n   */\n  page_scoped_user_id?: string;\n\n  /**\n   * Do not hash.\n   * Click ID generated by Meta for ads that click to WhatsApp.\n   */\n  ctwa_clid?: string;\n\n  /**\n   * Do not hash.\n   * Instagram Account ID that is associated with the business.\n   */\n  ig_account_id?: string;\n\n  /**\n   * Do not hash.\n   * Users who interact with Instagram are identified by Instagram-Scoped User IDs (IGSID). IGSID\n   * can be obtained from this webhook.\n   */\n  ig_sid?: string;\n};\n\n/**\n * You can include the following predefined object properties with any custom events, and any\n * standard events that support them. Format your parameter object data using JSON. Learn more about\n * event parameters with Blueprint.\n */\nexport type ObjectProperties = {\n  content_category?: string;\n  content_ids?: string[];\n  content_name?: string;\n\n  /**\n   * Either product or product_group based on the content_ids or contents being passed. If the IDs\n   * being passed in content_ids or contents parameter are IDs of products, then the value should be\n   * product. If product group IDs are being passed, then the value should be product_group.\n   *\n   * If no content_type is provided, Meta will match the event to every item that has the same ID,\n   * independent of its type.\n   */\n  content_type?: 'product' | 'product_group' | (string & {});\n  contents?: Content[];\n  delivery_category?: 'in_store' | 'curbside' | 'home_delivery';\n  currency?: string;\n  num_items?: number;\n  predicted_ltv?: number;\n  search_string?: string;\n\n  /** Used with the CompleteRegistration event, to show the status of the registration. */\n  status?: boolean;\n  value?: number;\n};\n\n/**\n * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/payload-helper\n */\nexport type StandardEvents = {\n  AddPaymentInfo: {\n    content_ids?: string[];\n    contents?: Content[];\n    currency?: string;\n    value?: number;\n  };\n  AddToCart: {\n    content_ids?: string[];\n    content_type?: string;\n    contents?: Content[]; // Required for Advantage+ catalog ads: contents\n    currency?: string;\n    value?: number;\n  };\n  AddToWishlist: {\n    content_ids?: string[];\n    contents?: Content[];\n    currency?: string;\n    value?: number;\n  };\n  CompleteRegistration: {\n    currency?: string;\n    value?: number;\n    method?: string;\n  };\n  Contact: {};\n  CustomizeProduct: {};\n  Donate: {};\n  FindLocation: {};\n  InitiateCheckout: {\n    content_ids?: string[];\n    contents?: Content[];\n    currency?: string;\n    num_items?: number;\n    value?: number;\n  };\n  Lead: {\n    currency?: string;\n    value?: number;\n  };\n  Purchase: {\n    content_ids?: string[]; // Required for Advantage+ catalog ads: contents or content_ids\n    content_type?: string;\n    contents?: Content[]; // Required for Advantage+ catalog ads: contents or content_ids\n    currency: string; // required\n    num_items?: number;\n    value: number; // required\n  };\n  Schedule: {};\n  Search: {\n    content_ids?: string[]; // Required for Advantage+ catalog ads: contents or content_ids\n    content_type?: string;\n    contents?: Content[]; // Required for Advantage+ catalog ads: contents or content_ids\n    currency?: string;\n    search_string?: string;\n    value?: number;\n  };\n  StartTrial: {\n    currency?: string;\n    predicted_ltv?: number;\n    value?: number;\n  };\n  SubmitApplication: {};\n  Subscribe: {\n    currency?: string;\n    predicted_ltv?: number;\n    value?: number;\n  };\n  ViewContent: {\n    content_ids?: string[]; // Required for Advantage+ catalog ads: contents or content_ids\n    content_type?: string;\n    contents?: Content[]; // Required for Advantage+ catalog ads: contents or content_ids\n    currency?: string;\n    value?: number;\n  };\n};\n\ntype JSONValue =\n  | null\n  | string\n  | number\n  | boolean\n  | Array<JSONValue>\n  | { [value: string]: JSONValue };\n\nexport type PixelId = `${number}`;\n\n/**\n * reference: https://developers.facebook.com/docs/meta-pixel/reference#standard-events\n *\n * We determine if events are identical based on their ID and name. So, for an event to be deduplicated:\n * - In corresponding events, a Meta Pixel's eventID must match the Conversion API's event_id.\n * - In corresponding events, a Meta Pixel's event must match the Conversion API's event_name.\n *\n * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters\n */\nexport interface Fbq {\n  /**\n   * reference: https://stackoverflow.com/questions/62304291/sending-user-data-parameters-via-pixel\n   *\n   * Call init the normal default way first:\n   * `fbq('init', 'XXXXX')`\n   *\n   * And at a later point in time, when you have obtained additional user data, you can call init\n   * again basically enriching the already running fbq instance with additional data:\n   * `fbq('init', 'XXXXX', { external_id: 1234, em: 'abc@abc.com' } )`\n   *\n   * Only caveat is that you have to send an event after this additional init call, otherwise the\n   * provided data will not be sent to Facebook.\n   */\n  fbq(type: 'init', pixelId: PixelId, parameters?: MatchingParameters): void;\n\n  /** Enable Manual Only mode. (value = false) */\n  fbq(type: 'set', key: 'autoConfig', value: boolean, pixelId: PixelId): void;\n\n  fbq<T extends keyof StandardEvents>(\n    type: 'track',\n    event: T,\n    properties?: StandardEvents[T] & ObjectProperties,\n    options?: { eventID?: string }\n  ): void;\n\n  fbq(\n    type: 'trackCustom',\n    event: string,\n    properties?: Record<string, JSONValue> & ObjectProperties,\n    options?: { eventID?: string }\n  ): void;\n\n  /** https://developers.facebook.com/docs/meta-pixel/guides/track-multiple-events/ */\n  fbq<T extends keyof StandardEvents>(\n    type: 'trackSingle',\n    pixelId: PixelId,\n    event: T,\n    properties?: StandardEvents[T] & ObjectProperties,\n    options?: { eventID?: string }\n  ): void;\n\n  /** https://developers.facebook.com/docs/meta-pixel/guides/track-multiple-events/ */\n  fbq(\n    type: 'trackSingleCustom',\n    pixelId: PixelId,\n    event: string,\n    properties?: Record<string, JSONValue> & ObjectProperties,\n    options?: { eventID?: string }\n  ): void;\n}\n\n/**\n * Please download this CSV filefor examples of properly normalized and hashed data for the\n * parameters below.\n */\nexport function normalize(parameters: MatchingParameters): MatchingParameters {\n  return {\n    ...parameters,\n    em: parameters.em?.toLowerCase().trim(),\n    ph: parameters.ph?.replace(/[\\+\\-\\(\\)\\s]/g, '').replace(/^0+/, ''),\n    zp: parameters.zp?.split('-').at(0)?.trim(),\n    fn: parameters.fn?.toLowerCase().trim(),\n    ln: parameters.ln?.toLowerCase().trim(),\n    ct: parameters.ct?.toLowerCase().replace(/[s/-]/g, '').trim(),\n    st: parameters.st\n      ?.toLowerCase()\n      .replace(/[s/-/,.]/g, '')\n      .trim(),\n    country: parameters.country?.toLowerCase().replace(/[s/-]/g, '').trim(),\n  };\n}\n\nfunction mapItems(items?: Item[]): ObjectProperties {\n  if (!items) return {};\n  const categories = Array.from(new Set(items.map((i) => i.item_category).filter(Boolean)));\n  const contents = items.map(({ item_id, quantity, ...others }) => ({\n    id: item_id!,\n    quantity: quantity ?? 1,\n    ...Object.fromEntries(\n      Object.entries(others).map(([key, value]) => [key.replace('item_', ''), value])\n    ),\n  }));\n\n  return {\n    content_category: categories.length === 1 ? categories.at(0) : undefined,\n    contents,\n    content_ids: contents.map((c) => c.id),\n    num_items: items.reduce((acc, i) => acc + (i.quantity ?? 1), 0),\n  };\n}\n\nexport function mapAndSendFbqEvent<T extends EventName>(\n  fbq: Fbq['fbq'],\n  name: TrackName<T>,\n  properties?: TrackProperties<T>,\n  options?: { eventID?: string }\n) {\n  if (name === 'add_payment_info') {\n    const p = properties as TrackProperties<'add_payment_info'> | undefined;\n    fbq(\n      'track',\n      'AddPaymentInfo',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n      options\n    );\n  } else if (name === 'add_to_cart') {\n    const p = properties as TrackProperties<'add_to_cart'> | undefined;\n    fbq(\n      'track',\n      'AddToCart',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n      options\n    );\n  } else if (name === 'add_to_wishlist') {\n    const p = properties as TrackProperties<'add_to_wishlist'> | undefined;\n    fbq(\n      'track',\n      'AddToWishlist',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n      options\n    );\n  } else if (name === 'login') {\n    const p = properties as TrackProperties<'login'> | undefined;\n    fbq('track', 'CompleteRegistration', { method: p?.method }, options);\n  } else if (name === 'contact') {\n    fbq('track', 'Contact', {}, options);\n  } else if (name === 'customize_product') {\n    fbq('track', 'CustomizeProduct', {}, options);\n  } else if (name === 'donate') {\n    fbq('track', 'Donate', {}, options);\n  } else if (name === 'find_location') {\n    fbq('track', 'FindLocation', {}, options);\n  } else if (name === 'begin_checkout') {\n    const p = properties as TrackProperties<'begin_checkout'> | undefined;\n    fbq(\n      'track',\n      'InitiateCheckout',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n      options\n    );\n  } else if (name === 'generate_lead') {\n    const p = properties as TrackProperties<'generate_lead'> | undefined;\n    fbq('track', 'Lead', { currency: p?.currency, value: p?.value }, options);\n  } else if (name === 'purchase') {\n    const p = properties as TrackProperties<'purchase'> | undefined;\n    fbq(\n      'track',\n      'Purchase',\n      p ? { currency: p?.currency, value: p?.value, ...mapItems(p?.items) } : undefined,\n      options\n    );\n  } else if (name === 'schedule') {\n    fbq('track', 'Schedule', {}, options);\n  } else if (name === 'search') {\n    const p = properties as TrackProperties<'search'> | undefined;\n    fbq('track', 'Search', { search_string: p?.search_term }, options);\n  } else if (name === 'trial_begin') {\n    const p = properties as TrackProperties<'trial_begin'> | undefined;\n    fbq('track', 'StartTrial', { currency: p?.currency, value: p?.value }, options);\n  } else if (name === 'submit_application') {\n    fbq('track', 'SubmitApplication', {}, options);\n  } else if (name === 'subscribe') {\n    const p = properties as TrackProperties<'subscribe'> | undefined;\n    fbq('track', 'Subscribe', { currency: p?.currency, value: p?.value }, options);\n  } else if (name === 'view_item') {\n    const p = properties as TrackProperties<'view_item'> | undefined;\n    fbq(\n      'track',\n      'ViewContent',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n      options\n    );\n  } else {\n    fbq('trackCustom', name, properties, options);\n  }\n}\n"],"mappings":";AAkUO,SAAS,UAAU,YAAoD;AAlU9E;AAmUE,SAAO;AAAA,IACL,GAAG;AAAA,IACH,KAAI,gBAAW,OAAX,mBAAe,cAAc;AAAA,IACjC,KAAI,gBAAW,OAAX,mBAAe,QAAQ,iBAAiB,IAAI,QAAQ,OAAO;AAAA,IAC/D,KAAI,sBAAW,OAAX,mBAAe,MAAM,KAAK,GAAG,OAA7B,mBAAiC;AAAA,IACrC,KAAI,gBAAW,OAAX,mBAAe,cAAc;AAAA,IACjC,KAAI,gBAAW,OAAX,mBAAe,cAAc;AAAA,IACjC,KAAI,gBAAW,OAAX,mBAAe,cAAc,QAAQ,UAAU,IAAI;AAAA,IACvD,KAAI,gBAAW,OAAX,mBACA,cACD,QAAQ,aAAa,IACrB;AAAA,IACH,UAAS,gBAAW,YAAX,mBAAoB,cAAc,QAAQ,UAAU,IAAI;AAAA,EACnE;AACF;AAEA,SAAS,SAAS,OAAkC;AAClD,MAAI,CAAC,MAAO,QAAO,CAAC;AACpB,QAAM,aAAa,MAAM,KAAK,IAAI,IAAI,MAAM,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,OAAO,CAAC,CAAC;AACxF,QAAM,WAAW,MAAM,IAAI,CAAC,EAAE,SAAS,UAAU,GAAG,OAAO,OAAO;AAAA,IAChE,IAAI;AAAA,IACJ,UAAU,YAAY;AAAA,IACtB,GAAG,OAAO;AAAA,MACR,OAAO,QAAQ,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,IAAI,QAAQ,SAAS,EAAE,GAAG,KAAK,CAAC;AAAA,IAChF;AAAA,EACF,EAAE;AAEF,SAAO;AAAA,IACL,kBAAkB,WAAW,WAAW,IAAI,WAAW,GAAG,CAAC,IAAI;AAAA,IAC/D;AAAA,IACA,aAAa,SAAS,IAAI,CAAC,MAAM,EAAE,EAAE;AAAA,IACrC,WAAW,MAAM,OAAO,CAAC,KAAK,MAAM,OAAO,EAAE,YAAY,IAAI,CAAC;AAAA,EAChE;AACF;AAEO,SAAS,mBACd,KACA,MACA,YACA,SACA;AACA,MAAI,SAAS,oBAAoB;AAC/B,UAAM,IAAI;AACV;AAAA,MACE;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,MAChE;AAAA,IACF;AAAA,EACF,WAAW,SAAS,eAAe;AACjC,UAAM,IAAI;AACV;AAAA,MACE;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,MAChE;AAAA,IACF;AAAA,EACF,WAAW,SAAS,mBAAmB;AACrC,UAAM,IAAI;AACV;AAAA,MACE;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,MAChE;AAAA,IACF;AAAA,EACF,WAAW,SAAS,SAAS;AAC3B,UAAM,IAAI;AACV,QAAI,SAAS,wBAAwB,EAAE,QAAQ,uBAAG,OAAO,GAAG,OAAO;AAAA,EACrE,WAAW,SAAS,WAAW;AAC7B,QAAI,SAAS,WAAW,CAAC,GAAG,OAAO;AAAA,EACrC,WAAW,SAAS,qBAAqB;AACvC,QAAI,SAAS,oBAAoB,CAAC,GAAG,OAAO;AAAA,EAC9C,WAAW,SAAS,UAAU;AAC5B,QAAI,SAAS,UAAU,CAAC,GAAG,OAAO;AAAA,EACpC,WAAW,SAAS,iBAAiB;AACnC,QAAI,SAAS,gBAAgB,CAAC,GAAG,OAAO;AAAA,EAC1C,WAAW,SAAS,kBAAkB;AACpC,UAAM,IAAI;AACV;AAAA,MACE;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,MAChE;AAAA,IACF;AAAA,EACF,WAAW,SAAS,iBAAiB;AACnC,UAAM,IAAI;AACV,QAAI,SAAS,QAAQ,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,MAAM,GAAG,OAAO;AAAA,EAC1E,WAAW,SAAS,YAAY;AAC9B,UAAM,IAAI;AACV;AAAA,MACE;AAAA,MACA;AAAA,MACA,IAAI,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE,IAAI;AAAA,MACxE;AAAA,IACF;AAAA,EACF,WAAW,SAAS,YAAY;AAC9B,QAAI,SAAS,YAAY,CAAC,GAAG,OAAO;AAAA,EACtC,WAAW,SAAS,UAAU;AAC5B,UAAM,IAAI;AACV,QAAI,SAAS,UAAU,EAAE,eAAe,uBAAG,YAAY,GAAG,OAAO;AAAA,EACnE,WAAW,SAAS,eAAe;AACjC,UAAM,IAAI;AACV,QAAI,SAAS,cAAc,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,MAAM,GAAG,OAAO;AAAA,EAChF,WAAW,SAAS,sBAAsB;AACxC,QAAI,SAAS,qBAAqB,CAAC,GAAG,OAAO;AAAA,EAC/C,WAAW,SAAS,aAAa;AAC/B,UAAM,IAAI;AACV,QAAI,SAAS,aAAa,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,MAAM,GAAG,OAAO;AAAA,EAC/E,WAAW,SAAS,aAAa;AAC/B,UAAM,IAAI;AACV;AAAA,MACE;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,MAChE;AAAA,IACF;AAAA,EACF,OAAO;AACL,QAAI,eAAe,MAAM,YAAY,OAAO;AAAA,EAC9C;AACF;","names":[]}

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

@@ -17,13 +17,13 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/track/ga.ts
-var ga_exports = {};
-__export(ga_exports, {
+// src/track/gtag.ts
+var gtag_exports = {};
+__export(gtag_exports, {
   reservedEventNames: () => reservedEventNames,
   standardEventNames: () => standardEventNames
 });
-module.exports = __toCommonJS(ga_exports);
+module.exports = __toCommonJS(gtag_exports);
 var standardEventNames = [
   "add_payment_info",
   "add_shipping_info",
@@ -99,4 +99,4 @@ var reservedEventNames = [
   reservedEventNames,
   standardEventNames
 });
-//# sourceMappingURL=ga.cjs.map
+//# sourceMappingURL=gtag.cjs.map

package/dist/track/gtag.cjs.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":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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/gtag.d.cts

@@ -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 };