@shware/analytics 0.1.17 → 0.2.0

package/dist/track/fbq.d.ts

@@ -0,0 +1,279 @@
+import { Item } from './gtag.js';
+import { EventName, TrackName, TrackProperties } from './types.js';
+
+type Content = {
+    id: string;
+    quantity: number;
+    item_price?: number;
+    title?: string;
+    description?: string;
+    brand?: string;
+    category?: string;
+    delivery_category?: string;
+};
+/**
+ * reference: https://developers.facebook.com/docs/meta-pixel/advanced/advanced-matching
+ * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters
+ */
+type MatchingParameters = {
+    /** Email: Unhashed lowercase or hashed SHA-256 */
+    em?: string;
+    /** First Name: Lowercase letters */
+    fn?: string;
+    /** Last Name: Lowercase letters */
+    ln?: string;
+    /** Phone Number: Digits only including country code and area code */
+    ph?: string;
+    /**
+     * External ID: Any unique ID from the advertiser, such as loyalty membership ID, user ID, and
+     * external cookie ID.
+     */
+    external_id?: string;
+    /** Gender: Single lowercase letter, f or m, if unknown, leave blank */
+    ge?: 'f' | 'm' | '';
+    /** Birthdate: Digits only with birth year, month, then day, YYYYMMDD */
+    db?: number;
+    /** City: Lowercase with any spaces removed, e.g. "menlopark" */
+    ct?: string;
+    /** State or Province: Lowercase two-letter state or province code, e.g. "ca" */
+    st?: string;
+    /** Zip or Postal Code: String */
+    zp?: string;
+    /** Country: Lowercase two-letter country code, e.g. "us" */
+    country?: string;
+    /** Client IP Address: Do not hash. */
+    client_ip_address?: string;
+    /** Client User Agent: Do not hash. */
+    client_user_agent?: string;
+    /**
+     * Click ID: Do not hash.
+     * The Facebook click ID value is stored in the _fbc browser cookie under your domain. See
+     * Managing fbc and fbp Parameters for how to get this value or generate this value from a fbclid
+     * query parameter.
+     *
+     * The format is fb.${subdomain_index}.${creation_time}.${fbclid}.
+     */
+    fbc?: string;
+    /**
+     * Browser ID: Do not hash.
+     * The Facebook browser ID value is stored in the _fbp browser cookie under your domain. See
+     * Managing fbc and fbp Parameters for how to get this value.
+     *
+     * The format is fb.${subdomain_index}.${creation_time}.${random_number}.
+     */
+    fbp?: string;
+    /**
+     * Subscription ID: Do not hash.
+     * The subscription ID for the user in this transaction; it is similar to the order ID for an
+     * individual product.
+     */
+    subscription_id?: string;
+    /**
+     * Facebook Login ID: Do not hash.
+     * The ID issued by Meta when a person first logs into an instance of an app. This is also known
+     * as App-Scoped ID.
+     */
+    fb_login_id?: number;
+    /**
+     * Lead ID: Do not hash.
+     * The ID associated with a lead generated by [Meta's Lead Ads](https://developers.facebook.com/docs/marketing-api/guides/lead-ads).
+     */
+    lead_id?: number;
+    /**
+     * Install ID: Do not hash.
+     * Your install ID. This field represents unique application installation instances.
+     * Note: This parameter is for app events only.
+     */
+    anon_id?: string;
+    /**
+     * Your mobile advertiser ID, the advertising ID from an Android device or the Advertising
+     * Identifier (IDFA) from an Apple device.
+     */
+    madid?: string;
+    /**
+     * Page ID: Do not hash.
+     * Your Page ID. Specifies the page ID associated with the event. Use the Facebook page ID of the
+     * page associated with the bot.
+     */
+    page_id?: string;
+    /**
+     * Page Scoped User ID: Do not hash.
+     * Specifies the page-scoped user ID associated with the messenger bot that logs the event. Use
+     * the page-scoped user ID provided to your webhook.
+     */
+    page_scoped_user_id?: string;
+    /**
+     * Do not hash.
+     * Click ID generated by Meta for ads that click to WhatsApp.
+     */
+    ctwa_clid?: string;
+    /**
+     * Do not hash.
+     * Instagram Account ID that is associated with the business.
+     */
+    ig_account_id?: string;
+    /**
+     * Do not hash.
+     * Users who interact with Instagram are identified by Instagram-Scoped User IDs (IGSID). IGSID
+     * can be obtained from this webhook.
+     */
+    ig_sid?: string;
+};
+/**
+ * You can include the following predefined object properties with any custom events, and any
+ * standard events that support them. Format your parameter object data using JSON. Learn more about
+ * event parameters with Blueprint.
+ */
+type ObjectProperties = {
+    content_category?: string;
+    content_ids?: string[];
+    content_name?: string;
+    /**
+     * Either product or product_group based on the content_ids or contents being passed. If the IDs
+     * being passed in content_ids or contents parameter are IDs of products, then the value should be
+     * product. If product group IDs are being passed, then the value should be product_group.
+     *
+     * If no content_type is provided, Meta will match the event to every item that has the same ID,
+     * independent of its type.
+     */
+    content_type?: 'product' | 'product_group' | (string & {});
+    contents?: Content[];
+    delivery_category?: 'in_store' | 'curbside' | 'home_delivery';
+    currency?: string;
+    num_items?: number;
+    predicted_ltv?: number;
+    search_string?: string;
+    /** Used with the CompleteRegistration event, to show the status of the registration. */
+    status?: boolean;
+    value?: number;
+};
+/**
+ * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/payload-helper
+ */
+type StandardEvents = {
+    AddPaymentInfo: {
+        content_ids?: string[];
+        contents?: Content[];
+        currency?: string;
+        value?: number;
+    };
+    AddToCart: {
+        content_ids?: string[];
+        content_type?: string;
+        contents?: Content[];
+        currency?: string;
+        value?: number;
+    };
+    AddToWishlist: {
+        content_ids?: string[];
+        contents?: Content[];
+        currency?: string;
+        value?: number;
+    };
+    CompleteRegistration: {
+        currency?: string;
+        value?: number;
+        method?: string;
+    };
+    Contact: {};
+    CustomizeProduct: {};
+    Donate: {};
+    FindLocation: {};
+    InitiateCheckout: {
+        content_ids?: string[];
+        contents?: Content[];
+        currency?: string;
+        num_items?: number;
+        value?: number;
+    };
+    Lead: {
+        currency?: string;
+        value?: number;
+    };
+    Purchase: {
+        content_ids?: string[];
+        content_type?: string;
+        contents?: Content[];
+        currency: string;
+        num_items?: number;
+        value: number;
+    };
+    Schedule: {};
+    Search: {
+        content_ids?: string[];
+        content_type?: string;
+        contents?: Content[];
+        currency?: string;
+        search_string?: string;
+        value?: number;
+    };
+    StartTrial: {
+        currency?: string;
+        predicted_ltv?: number;
+        value?: number;
+    };
+    SubmitApplication: {};
+    Subscribe: {
+        currency?: string;
+        predicted_ltv?: number;
+        value?: number;
+    };
+    ViewContent: {
+        content_ids?: string[];
+        content_type?: string;
+        contents?: Content[];
+        currency?: string;
+        value?: number;
+    };
+};
+type JSONValue = null | string | number | boolean | Array<JSONValue> | {
+    [value: string]: JSONValue;
+};
+type PixelId = `${number}`;
+type Options = {
+    eventID?: string;
+};
+/**
+ * reference: https://developers.facebook.com/docs/meta-pixel/reference#standard-events
+ *
+ * We determine if events are identical based on their ID and name. So, for an event to be deduplicated:
+ * - In corresponding events, a Meta Pixel's eventID must match the Conversion API's event_id.
+ * - In corresponding events, a Meta Pixel's event must match the Conversion API's event_name.
+ *
+ * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters
+ */
+interface Pixel {
+    /**
+     * reference: https://stackoverflow.com/questions/62304291/sending-user-data-parameters-via-pixel
+     *
+     * Call init the normal default way first:
+     * `fbq('init', 'XXXXX')`
+     *
+     * And at a later point in time, when you have obtained additional user data, you can call init
+     * again basically enriching the already running fbq instance with additional data:
+     * `fbq('init', 'XXXXX', { external_id: 1234, em: 'abc@abc.com' } )`
+     *
+     * Only caveat is that you have to send an event after this additional init call, otherwise the
+     * provided data will not be sent to Facebook.
+     */
+    fbq(type: 'init', pixelId: PixelId, parameters?: MatchingParameters): void;
+    /** Enable Manual Only mode. (value = false) */
+    fbq(type: 'set', key: 'autoConfig', value: boolean, pixelId: PixelId): void;
+    fbq<T extends keyof StandardEvents>(type: 'track', event: T, properties?: StandardEvents[T] & ObjectProperties, options?: Options): void;
+    fbq(type: 'trackCustom', event: string, properties?: Record<string, JSONValue> & ObjectProperties, options?: Options): void;
+    /** https://developers.facebook.com/docs/meta-pixel/guides/track-multiple-events/ */
+    fbq<T extends keyof StandardEvents>(type: 'trackSingle', pixelId: PixelId, event: T, properties?: StandardEvents[T] & ObjectProperties, options?: Options): void;
+    /** https://developers.facebook.com/docs/meta-pixel/guides/track-multiple-events/ */
+    fbq(type: 'trackSingleCustom', pixelId: PixelId, event: string, properties?: Record<string, JSONValue> & ObjectProperties, options?: Options): void;
+}
+/**
+ * Please download this CSV filefor examples of properly normalized and hashed data for the
+ * parameters below.
+ */
+declare function normalize(parameters: MatchingParameters): MatchingParameters;
+declare function mapItems(items?: Item[]): ObjectProperties;
+type Mapped<F extends keyof StandardEvents> = ['track', F, StandardEvents[F] & ObjectProperties];
+type Missed<F extends string> = ['trackCustom', F, Record<string, JSONValue> & ObjectProperties];
+declare function mapFBEvent<T extends EventName>(name: TrackName<T>, properties?: TrackProperties<T>): Mapped<keyof StandardEvents> | Missed<TrackName<T>>;
+
+export { type Content, type MatchingParameters, type ObjectProperties, type Options, type Pixel, type PixelId, type StandardEvents, mapFBEvent, mapItems, normalize };

package/dist/track/fbq.mjs

@@ -0,0 +1,115 @@
+// src/track/fbq.ts
+function normalize(parameters) {
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i;
+  return {
+    ...parameters,
+    em: (_a = parameters.em) == null ? void 0 : _a.toLowerCase().trim(),
+    ph: (_b = parameters.ph) == null ? void 0 : _b.replace(/[\+\-\(\)\s]/g, "").replace(/^0+/, ""),
+    zp: (_d = (_c = parameters.zp) == null ? void 0 : _c.split("-").at(0)) == null ? void 0 : _d.trim(),
+    fn: (_e = parameters.fn) == null ? void 0 : _e.toLowerCase().trim(),
+    ln: (_f = parameters.ln) == null ? void 0 : _f.toLowerCase().trim(),
+    ct: (_g = parameters.ct) == null ? void 0 : _g.toLowerCase().replace(/[s/-]/g, "").trim(),
+    st: (_h = parameters.st) == null ? void 0 : _h.toLowerCase().replace(/[s/-/,.]/g, "").trim(),
+    country: (_i = parameters.country) == null ? void 0 : _i.toLowerCase().replace(/[s/-]/g, "").trim()
+  };
+}
+function mapItems(items) {
+  if (!items) return {};
+  const categories = Array.from(new Set(items.map((i) => i.item_category).filter(Boolean)));
+  const contents = items.map(
+    ({ item_id, quantity, price, item_name, item_brand, item_category, ...others }) => ({
+      id: item_id,
+      quantity: quantity ?? 1,
+      item_price: price,
+      title: item_name,
+      brand: item_brand,
+      category: item_category
+    })
+  );
+  return {
+    content_category: categories.length === 1 ? categories.at(0) : void 0,
+    contents,
+    content_ids: contents.map((c) => c.id),
+    num_items: items.reduce((acc, i) => acc + (i.quantity ?? 1), 0)
+  };
+}
+function mapFBEvent(name, properties) {
+  if (name === "add_payment_info") {
+    const p = properties;
+    return [
+      "track",
+      "AddPaymentInfo",
+      { currency: p == null ? void 0 : p.currency, value: p == null ? void 0 : p.value, ...mapItems(p == null ? void 0 : p.items) }
+    ];
+  } else if (name === "add_to_cart") {
+    const p = properties;
+    return [
+      "track",
+      "AddToCart",
+      { currency: p == null ? void 0 : p.currency, value: p == null ? void 0 : p.value, ...mapItems(p == null ? void 0 : p.items) }
+    ];
+  } else if (name === "add_to_wishlist") {
+    const p = properties;
+    return [
+      "track",
+      "AddToWishlist",
+      { currency: p == null ? void 0 : p.currency, value: p == null ? void 0 : p.value, ...mapItems(p == null ? void 0 : p.items) }
+    ];
+  } else if (name === "login") {
+    const p = properties;
+    return ["track", "CompleteRegistration", { method: p == null ? void 0 : p.method }];
+  } else if (name === "contact") {
+    return ["track", "Contact", {}];
+  } else if (name === "customize_product") {
+    return ["track", "CustomizeProduct", {}];
+  } else if (name === "donate") {
+    return ["track", "Donate", {}];
+  } else if (name === "find_location") {
+    return ["track", "FindLocation", {}];
+  } else if (name === "begin_checkout") {
+    const p = properties;
+    return [
+      "track",
+      "InitiateCheckout",
+      { currency: p == null ? void 0 : p.currency, value: p == null ? void 0 : p.value, ...mapItems(p == null ? void 0 : p.items) }
+    ];
+  } else if (name === "generate_lead") {
+    const p = properties;
+    return ["track", "Lead", { currency: p == null ? void 0 : p.currency, value: p == null ? void 0 : p.value }];
+  } else if (name === "purchase") {
+    const p = properties;
+    return [
+      "track",
+      "Purchase",
+      { currency: (p == null ? void 0 : p.currency) ?? "usd", value: (p == null ? void 0 : p.value) ?? 0, ...mapItems(p == null ? void 0 : p.items) }
+    ];
+  } else if (name === "schedule") {
+    return ["track", "Schedule", {}];
+  } else if (name === "search") {
+    const p = properties;
+    return ["track", "Search", { search_string: p == null ? void 0 : p.search_term }];
+  } else if (name === "trial_begin") {
+    const p = properties;
+    return ["track", "StartTrial", { currency: p == null ? void 0 : p.currency, value: p == null ? void 0 : p.value }];
+  } else if (name === "submit_application") {
+    return ["track", "SubmitApplication", {}];
+  } else if (name === "subscribe") {
+    const p = properties;
+    return ["track", "Subscribe", { currency: p == null ? void 0 : p.currency, value: p == null ? void 0 : p.value }];
+  } else if (name === "view_item") {
+    const p = properties;
+    return [
+      "track",
+      "ViewContent",
+      { currency: p == null ? void 0 : p.currency, value: p == null ? void 0 : p.value, ...mapItems(p == null ? void 0 : p.items) }
+    ];
+  } else {
+    return ["trackCustom", name, properties ?? {}];
+  }
+}
+export {
+  mapFBEvent,
+  mapItems,
+  normalize
+};
+//# sourceMappingURL=fbq.mjs.map

package/dist/track/fbq.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/track/fbq.ts"],"sourcesContent":["import type { Item } from './gtag';\nimport type { EventName, TrackName, TrackProperties } from './types';\n\nexport type Content = {\n  id: string;\n  quantity: number;\n  item_price?: number;\n  title?: string;\n  description?: string;\n  brand?: string;\n  category?: string;\n  delivery_category?: string;\n};\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}`;\nexport type Options = { eventID?: string };\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 Pixel {\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?: Options\n  ): void;\n\n  fbq(\n    type: 'trackCustom',\n    event: string,\n    properties?: Record<string, JSONValue> & ObjectProperties,\n    options?: Options\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?: Options\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?: Options\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\nexport function 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: Content[] = items.map(\n    ({ item_id, quantity, price, item_name, item_brand, item_category, ...others }) => ({\n      id: item_id!,\n      quantity: quantity ?? 1,\n      item_price: price,\n      title: item_name,\n      brand: item_brand,\n      category: item_category,\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\ntype Mapped<F extends keyof StandardEvents> = ['track', F, StandardEvents[F] & ObjectProperties];\ntype Missed<F extends string> = ['trackCustom', F, Record<string, JSONValue> & ObjectProperties];\n\nexport function mapFBEvent<T extends EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>\n): Mapped<keyof StandardEvents> | Missed<TrackName<T>> {\n  if (name === 'add_payment_info') {\n    const p = properties as TrackProperties<'add_payment_info'> | undefined;\n    return [\n      'track',\n      'AddPaymentInfo',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n    ];\n  } else if (name === 'add_to_cart') {\n    const p = properties as TrackProperties<'add_to_cart'> | undefined;\n    return [\n      'track',\n      'AddToCart',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n    ];\n  } else if (name === 'add_to_wishlist') {\n    const p = properties as TrackProperties<'add_to_wishlist'> | undefined;\n    return [\n      'track',\n      'AddToWishlist',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n    ];\n  } else if (name === 'login') {\n    const p = properties as TrackProperties<'login'> | undefined;\n    return ['track', 'CompleteRegistration', { method: p?.method }];\n  } else if (name === 'contact') {\n    return ['track', 'Contact', {}];\n  } else if (name === 'customize_product') {\n    return ['track', 'CustomizeProduct', {}];\n  } else if (name === 'donate') {\n    return ['track', 'Donate', {}];\n  } else if (name === 'find_location') {\n    return ['track', 'FindLocation', {}];\n  } else if (name === 'begin_checkout') {\n    const p = properties as TrackProperties<'begin_checkout'> | undefined;\n    return [\n      'track',\n      'InitiateCheckout',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n    ];\n  } else if (name === 'generate_lead') {\n    const p = properties as TrackProperties<'generate_lead'> | undefined;\n    return ['track', 'Lead', { currency: p?.currency, value: p?.value }];\n  } else if (name === 'purchase') {\n    const p = properties as TrackProperties<'purchase'> | undefined;\n    return [\n      'track',\n      'Purchase',\n      { currency: p?.currency ?? 'usd', value: p?.value ?? 0, ...mapItems(p?.items) },\n    ];\n  } else if (name === 'schedule') {\n    return ['track', 'Schedule', {}];\n  } else if (name === 'search') {\n    const p = properties as TrackProperties<'search'> | undefined;\n    return ['track', 'Search', { search_string: p?.search_term }];\n  } else if (name === 'trial_begin') {\n    const p = properties as TrackProperties<'trial_begin'> | undefined;\n    return ['track', 'StartTrial', { currency: p?.currency, value: p?.value }];\n  } else if (name === 'submit_application') {\n    return ['track', 'SubmitApplication', {}];\n  } else if (name === 'subscribe') {\n    const p = properties as TrackProperties<'subscribe'> | undefined;\n    return ['track', 'Subscribe', { currency: p?.currency, value: p?.value }];\n  } else if (name === 'view_item') {\n    const p = properties as TrackProperties<'view_item'> | undefined;\n    return [\n      'track',\n      'ViewContent',\n      { currency: p?.currency, value: p?.value, ...mapItems(p?.items) },\n    ];\n  } else {\n    return ['trackCustom', name, properties ?? {}];\n  }\n}\n"],"mappings":";AA8UO,SAAS,UAAU,YAAoD;AA9U9E;AA+UE,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;AAEO,SAAS,SAAS,OAAkC;AACzD,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,WAAsB,MAAM;AAAA,IAChC,CAAC,EAAE,SAAS,UAAU,OAAO,WAAW,YAAY,eAAe,GAAG,OAAO,OAAO;AAAA,MAClF,IAAI;AAAA,MACJ,UAAU,YAAY;AAAA,MACtB,YAAY;AAAA,MACZ,OAAO;AAAA,MACP,OAAO;AAAA,MACP,UAAU;AAAA,IACZ;AAAA,EACF;AAEA,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;AAKO,SAAS,WACd,MACA,YACqD;AACrD,MAAI,SAAS,oBAAoB;AAC/B,UAAM,IAAI;AACV,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,IAClE;AAAA,EACF,WAAW,SAAS,eAAe;AACjC,UAAM,IAAI;AACV,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,IAClE;AAAA,EACF,WAAW,SAAS,mBAAmB;AACrC,UAAM,IAAI;AACV,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,IAClE;AAAA,EACF,WAAW,SAAS,SAAS;AAC3B,UAAM,IAAI;AACV,WAAO,CAAC,SAAS,wBAAwB,EAAE,QAAQ,uBAAG,OAAO,CAAC;AAAA,EAChE,WAAW,SAAS,WAAW;AAC7B,WAAO,CAAC,SAAS,WAAW,CAAC,CAAC;AAAA,EAChC,WAAW,SAAS,qBAAqB;AACvC,WAAO,CAAC,SAAS,oBAAoB,CAAC,CAAC;AAAA,EACzC,WAAW,SAAS,UAAU;AAC5B,WAAO,CAAC,SAAS,UAAU,CAAC,CAAC;AAAA,EAC/B,WAAW,SAAS,iBAAiB;AACnC,WAAO,CAAC,SAAS,gBAAgB,CAAC,CAAC;AAAA,EACrC,WAAW,SAAS,kBAAkB;AACpC,UAAM,IAAI;AACV,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,IAClE;AAAA,EACF,WAAW,SAAS,iBAAiB;AACnC,UAAM,IAAI;AACV,WAAO,CAAC,SAAS,QAAQ,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,MAAM,CAAC;AAAA,EACrE,WAAW,SAAS,YAAY;AAC9B,UAAM,IAAI;AACV,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,EAAE,WAAU,uBAAG,aAAY,OAAO,QAAO,uBAAG,UAAS,GAAG,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,IAChF;AAAA,EACF,WAAW,SAAS,YAAY;AAC9B,WAAO,CAAC,SAAS,YAAY,CAAC,CAAC;AAAA,EACjC,WAAW,SAAS,UAAU;AAC5B,UAAM,IAAI;AACV,WAAO,CAAC,SAAS,UAAU,EAAE,eAAe,uBAAG,YAAY,CAAC;AAAA,EAC9D,WAAW,SAAS,eAAe;AACjC,UAAM,IAAI;AACV,WAAO,CAAC,SAAS,cAAc,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,MAAM,CAAC;AAAA,EAC3E,WAAW,SAAS,sBAAsB;AACxC,WAAO,CAAC,SAAS,qBAAqB,CAAC,CAAC;AAAA,EAC1C,WAAW,SAAS,aAAa;AAC/B,UAAM,IAAI;AACV,WAAO,CAAC,SAAS,aAAa,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,MAAM,CAAC;AAAA,EAC1E,WAAW,SAAS,aAAa;AAC/B,UAAM,IAAI;AACV,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,EAAE,UAAU,uBAAG,UAAU,OAAO,uBAAG,OAAO,GAAG,SAAS,uBAAG,KAAK,EAAE;AAAA,IAClE;AAAA,EACF,OAAO;AACL,WAAO,CAAC,eAAe,MAAM,cAAc,CAAC,CAAC;AAAA,EAC/C;AACF;","names":[]}

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

@@ -17,71 +17,57 @@ 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, {
-  reservedEventNames: () => reservedEventNames,
-  standardEventNames: () => standardEventNames
+// src/track/gtag.ts
+var gtag_exports = {};
+__export(gtag_exports, {
+  reservedEventNames: () => reservedEventNames
 });
-module.exports = __toCommonJS(ga_exports);
-var standardEventNames = [
-  "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"
+module.exports = __toCommonJS(gtag_exports);
+var reservedWebEventNames = [
+  "app_remove",
+  "app_store_refund",
+  "app_store_subscription_cancel",
+  "app_store_subscription_renew",
+  "click",
+  "error",
+  "file_download",
+  "first_open",
+  "first_visit",
+  "form_start",
+  "form_submit",
+  "in_app_purchase",
+  "page_view",
+  "scroll",
+  "session_start",
+  "user_engagement",
+  "view_complete",
+  "video_progress",
+  "video_start",
+  "view_search_results"
 ];
-var reservedEventNames = [
+var reservedAppEventNames = [
   "ad_activeview",
   "ad_click",
   "ad_exposure",
+  "ad_impression",
   "ad_query",
   "ad_reward",
   "adunit_exposure",
-  "app_background",
   "app_clear_data",
   "app_exception",
+  "app_install",
   "app_remove",
   "app_store_refund",
-  "app_store_subscription_cancel",
-  "app_store_subscription_convert",
-  "app_store_subscription_renew",
   "app_update",
   "app_upgrade",
   "dynamic_link_app_open",
   "dynamic_link_app_update",
   "dynamic_link_first_open",
   "error",
+  "firebase_campaign",
+  "firebase_in_app_message_action",
+  "firebase_in_app_message_dismiss",
+  "firebase_in_app_message_impression",
   "first_open",
   "first_visit",
   "in_app_purchase",
@@ -89,14 +75,15 @@ var reservedEventNames = [
   "notification_foreground",
   "notification_open",
   "notification_receive",
+  "notification_send",
   "os_update",
+  "screen_view",
   "session_start",
-  "session_start_with_rollout",
   "user_engagement"
 ];
+var reservedEventNames = [...reservedWebEventNames, ...reservedAppEventNames];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  reservedEventNames,
-  standardEventNames
+  reservedEventNames
 });
-//# 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":["/** 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\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(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":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;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":[]}