@azerion/bunosaurus-plugin-google-gtag 0.0.0-stage → 4.0.0

package/README.md

@@ -1,3 +1,7 @@
-# Temporary Holding Version
+# `@docusaurus/plugin-google-gtag`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Global Site Tag (gtag.js) plugin for Docusaurus.
+
+## Usage
+
+See [plugin-google-gtag documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag).

package/lib/gtag.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { ClientModule } from '@docusaurus/types';
+declare const clientModule: ClientModule;
+export default clientModule;

package/lib/gtag.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+const clientModule = {
+    onRouteDidUpdate({ location, previousLocation }) {
+        if (previousLocation &&
+            (location.pathname !== previousLocation.pathname ||
+                location.search !== previousLocation.search ||
+                location.hash !== previousLocation.hash)) {
+            // Normally, the document title is updated in the next tick due to how
+            // `react-helmet-async` updates it. We want to send the current document's
+            // title to gtag instead of the old one's, so we use `setTimeout` to defer
+            // execution to the next tick.
+            // See: https://github.com/facebook/docusaurus/issues/7420
+            setTimeout(() => {
+                // Always refer to the variable on window in case it gets overridden
+                // elsewhere.
+                window.gtag('set', 'page_path', location.pathname + location.search + location.hash);
+                window.gtag('event', 'page_view');
+            });
+        }
+    },
+};
+export default clientModule;

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { LoadContext, Plugin } from '@docusaurus/types';
+import type { PluginOptions, Options } from './options';
+export {} from './vendor-gtag';
+export default function pluginGoogleGtag(context: LoadContext, options: PluginOptions): Plugin | null;
+export { validateThemeConfig, validateOptions } from './options';
+export type { PluginOptions, Options };

package/lib/index.js

@@ -0,0 +1,78 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOptions = exports.validateThemeConfig = void 0;
+exports.default = pluginGoogleGtag;
+function createConfigSnippet({ trackingID, anonymizeIP, }) {
+    return `gtag('config', '${trackingID}', { ${anonymizeIP ? "'anonymize_ip': true" : ''} });`;
+}
+function createConfigSnippets({ trackingID: trackingIDArray, anonymizeIP, }) {
+    return trackingIDArray
+        .map((trackingID) => createConfigSnippet({ trackingID, anonymizeIP }))
+        .join('\n');
+}
+function pluginGoogleGtag(context, options) {
+    if (process.env.NODE_ENV !== 'production') {
+        return null;
+    }
+    const firstTrackingId = options.trackingID[0];
+    return {
+        name: 'docusaurus-plugin-google-gtag',
+        contentLoaded({ actions }) {
+            actions.setGlobalData(options);
+        },
+        getClientModules() {
+            return ['./gtag'];
+        },
+        injectHtmlTags() {
+            return {
+                // Gtag includes GA by default, so we also preconnect to
+                // google-analytics.
+                headTags: [
+                    {
+                        tagName: 'link',
+                        attributes: {
+                            rel: 'preconnect',
+                            href: 'https://www.google-analytics.com',
+                        },
+                    },
+                    {
+                        tagName: 'link',
+                        attributes: {
+                            rel: 'preconnect',
+                            href: 'https://www.googletagmanager.com',
+                        },
+                    },
+                    {
+                        tagName: 'script',
+                        attributes: {
+                            async: true,
+                            // We only include the first tracking id here because google says
+                            // we shouldn't install multiple tags/scripts on the same page
+                            // Instead we should load one script and use n * gtag("config",id)
+                            // See https://developers.google.com/tag-platform/gtagjs/install#add-products
+                            src: `https://www.googletagmanager.com/gtag/js?id=${firstTrackingId}`,
+                        },
+                    },
+                    {
+                        tagName: 'script',
+                        innerHTML: `
+              window.dataLayer = window.dataLayer || [];
+              function gtag(){dataLayer.push(arguments);}
+              gtag('js', new Date());
+              ${createConfigSnippets(options)};
+              `,
+                    },
+                ],
+            };
+        },
+    };
+}
+var options_1 = require("./options");
+Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return options_1.validateThemeConfig; } });
+Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/options.d.ts

@@ -0,0 +1,12 @@
+import type { OptionValidationContext, ThemeConfig, ThemeConfigValidationContext } from '@docusaurus/types';
+export type PluginOptions = {
+    trackingID: [string, ...string[]];
+    anonymizeIP: boolean;
+};
+export type Options = {
+    trackingID: string | [string, ...string[]];
+    anonymizeIP?: boolean;
+};
+export declare const DEFAULT_OPTIONS: Partial<PluginOptions>;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;
+export declare function validateThemeConfig({ themeConfig, }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig;

package/lib/options.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_OPTIONS = void 0;
+exports.validateOptions = validateOptions;
+exports.validateThemeConfig = validateThemeConfig;
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+const utils_validation_1 = require("@docusaurus/utils-validation");
+exports.DEFAULT_OPTIONS = {
+    anonymizeIP: false,
+};
+const pluginOptionsSchema = utils_validation_1.Joi.object({
+    // We normalize trackingID as a string[]
+    trackingID: utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().required(), {
+        then: utils_validation_1.Joi.custom((val) => [val]),
+    }), utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required()))
+        .required(),
+    anonymizeIP: utils_validation_1.Joi.boolean().default(exports.DEFAULT_OPTIONS.anonymizeIP),
+});
+function validateOptions({ validate, options, }) {
+    return validate(pluginOptionsSchema, options);
+}
+function validateThemeConfig({ themeConfig, }) {
+    if ('gtag' in themeConfig) {
+        throw new Error('The "gtag" field in themeConfig should now be specified as option for plugin-google-gtag. More information at https://github.com/facebook/docusaurus/pull/5832.');
+    }
+    return themeConfig;
+}

package/lib/vendor-gtag.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+declare var gtag: Gtag.Gtag;
+declare namespace Gtag {
+    interface GtagCommands {
+        config: [
+            targetId: string,
+            config?: ControlParams | EventParams | ConfigParams | CustomParams
+        ];
+        set: [targetId: string, config: CustomParams | boolean | string] | [config: CustomParams];
+        js: [config: Date];
+        event: [
+            eventName: EventNames | (string & {}),
+            eventParams?: ControlParams | EventParams | CustomParams
+        ];
+        get: [
+            targetId: string,
+            fieldName: FieldNames | string,
+            callback?: (field: string | CustomParams | undefined) => any
+        ];
+        consent: [
+            consentArg: ConsentArg | (string & {}),
+            consentParams: ConsentParams
+        ];
+    }
+    interface Gtag {
+        <Command extends keyof GtagCommands>(command: Command, ...args: GtagCommands[Command]): void;
+    }
+    interface ConfigParams {
+        page_title?: string | undefined;
+        page_location?: string | undefined;
+        page_path?: string | undefined;
+        send_page_view?: boolean | undefined;
+    }
+    interface CustomParams {
+        [key: string]: any;
+    }
+    interface ControlParams {
+        groups?: string | string[] | undefined;
+        send_to?: string | string[] | undefined;
+        event_callback?: (() => void) | undefined;
+        event_timeout?: number | undefined;
+    }
+    type EventNames = 'add_payment_info' | 'add_shipping_info' | 'add_to_cart' | 'add_to_wishlist' | 'begin_checkout' | 'checkout_progress' | 'earn_virtual_currency' | 'exception' | 'generate_lead' | 'join_group' | 'level_end' | 'level_start' | 'level_up' | 'login' | 'page_view' | 'post_score' | 'purchase' | 'refund' | 'remove_from_cart' | 'screen_view' | 'search' | 'select_content' | 'select_item' | 'select_promotion' | 'set_checkout_option' | 'share' | 'sign_up' | 'spend_virtual_currency' | 'tutorial_begin' | 'tutorial_complete' | 'unlock_achievement' | 'timing_complete' | 'view_cart' | 'view_item' | 'view_item_list' | 'view_promotion' | 'view_search_results';
+    interface EventParams {
+        checkout_option?: string | undefined;
+        checkout_step?: number | undefined;
+        content_id?: string | undefined;
+        content_type?: string | undefined;
+        coupon?: string | undefined;
+        currency?: string | undefined;
+        description?: string | undefined;
+        fatal?: boolean | undefined;
+        items?: Item[] | undefined;
+        method?: string | undefined;
+        number?: string | undefined;
+        promotions?: Promotion[] | undefined;
+        screen_name?: string | undefined;
+        search_term?: string | undefined;
+        shipping?: Currency | undefined;
+        tax?: Currency | undefined;
+        transaction_id?: string | undefined;
+        value?: number | undefined;
+        event_label?: string | undefined;
+        event_category?: string | undefined;
+        /** @see {@link https://developers.google.com/analytics/devguides/collection/gtagjs/sending-data#specify_different_transport_mechanisms specify_different_transport_mechanisms} */
+        transport_type?: 'image' | 'xhr' | 'beacon' | undefined;
+    }
+    type Currency = string | number;
+    /**
+     * Interface of an item object used in lists for this event.
+     *
+     * Reference:
+     * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#view_item_item view_item_item}
+     * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#view_item_list_item view_item_list_item}
+     * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#select_item_item select_item_item}
+     * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#add_to_cart_item add_to_cart_item}
+     * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#view_cart_item view_cart_item}
+     */
+    interface Item {
+        item_id?: string | undefined;
+        item_name?: string | undefined;
+        affiliation?: string | undefined;
+        coupon?: string | undefined;
+        currency?: string | undefined;
+        creative_name?: string | undefined;
+        creative_slot?: string | undefined;
+        discount?: Currency | undefined;
+        index?: number | undefined;
+        item_brand?: string | undefined;
+        item_category?: string | undefined;
+        item_category2?: string | undefined;
+        item_category3?: string | undefined;
+        item_category4?: string | undefined;
+        item_category5?: string | undefined;
+        item_list_id?: string | undefined;
+        item_list_name?: string | undefined;
+        item_variant?: string | undefined;
+        location_id?: string | undefined;
+        price?: Currency | undefined;
+        promotion_id?: string | undefined;
+        promotion_name?: string | undefined;
+        quantity?: number | undefined;
+    }
+    interface Promotion {
+        creative_name?: string | undefined;
+        creative_slot?: string | undefined;
+        promotion_id?: string | undefined;
+        promotion_name?: string | undefined;
+    }
+    type FieldNames = 'client_id' | 'session_id' | 'gclid';
+    type ConsentArg = 'default' | 'update';
+    /**
+     * Reference:
+     * @see {@link https://support.google.com/tagmanager/answer/10718549#consent-types consent-types}
+     * @see {@link https://developers.google.com/tag-platform/devguides/consent consent}
+     */
+    interface ConsentParams {
+        ad_personalization?: 'granted' | 'denied' | undefined;
+        ad_user_data?: 'granted' | 'denied' | undefined;
+        ad_storage?: 'granted' | 'denied' | undefined;
+        analytics_storage?: 'granted' | 'denied' | undefined;
+        functionality_storage?: 'granted' | 'denied' | undefined;
+        personalization_storage?: 'granted' | 'denied' | undefined;
+        security_storage?: 'granted' | 'denied' | undefined;
+        wait_for_update?: number | undefined;
+        region?: string[] | undefined;
+    }
+}

package/lib/vendor-gtag.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "@azerion/bunosaurus-plugin-google-gtag",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "4.0.0",
+  "description": "Global Site Tag (gtag.js) plugin for Docusaurus.",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc --build && copy-untyped-files",
+    "watch": "run-p -c copy:watch build:watch",
+    "build:watch": "tsc --build --watch",
+    "copy:watch": "copy-untyped-files --watch"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/azerion/bunosaurus.git",
+    "directory": "packages/docusaurus-plugin-google-gtag"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@docusaurus/core": "npm:@azerion/bunosaurus-core@4.0.0",
+    "@docusaurus/types": "npm:@azerion/bunosaurus-types@4.0.0",
+    "@docusaurus/utils-validation": "npm:@azerion/bunosaurus-utils-validation@4.0.0",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "npm:@azerion/bunosaurus-module-type-aliases@4.0.0"
+  },
+  "peerDependencies": {
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0"
+  },
+  "engines": {
+    "bun": ">=1.4.1"
+  }
+}

package/src/gtag.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type {ClientModule} from '@docusaurus/types';
+
+const clientModule: ClientModule = {
+  onRouteDidUpdate({location, previousLocation}) {
+    if (
+      previousLocation &&
+      (location.pathname !== previousLocation.pathname ||
+        location.search !== previousLocation.search ||
+        location.hash !== previousLocation.hash)
+    ) {
+      // Normally, the document title is updated in the next tick due to how
+      // `react-helmet-async` updates it. We want to send the current document's
+      // title to gtag instead of the old one's, so we use `setTimeout` to defer
+      // execution to the next tick.
+      // See: https://github.com/facebook/docusaurus/issues/7420
+      setTimeout(() => {
+        // Always refer to the variable on window in case it gets overridden
+        // elsewhere.
+        window.gtag(
+          'set',
+          'page_path',
+          location.pathname + location.search + location.hash,
+        );
+        window.gtag('event', 'page_view');
+      });
+    }
+  },
+};
+
+export default clientModule;

package/src/index.ts

@@ -0,0 +1,103 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type {LoadContext, Plugin} from '@docusaurus/types';
+import type {PluginOptions, Options} from './options';
+
+// Not sure why it's needed to expose vendored types 🤷‍️
+export {} from './vendor-gtag';
+
+function createConfigSnippet({
+  trackingID,
+  anonymizeIP,
+}: {
+  trackingID: string;
+  anonymizeIP: boolean;
+}): string {
+  return `gtag('config', '${trackingID}', { ${
+    anonymizeIP ? "'anonymize_ip': true" : ''
+  } });`;
+}
+
+function createConfigSnippets({
+  trackingID: trackingIDArray,
+  anonymizeIP,
+}: PluginOptions): string {
+  return trackingIDArray
+    .map((trackingID) => createConfigSnippet({trackingID, anonymizeIP}))
+    .join('\n');
+}
+
+export default function pluginGoogleGtag(
+  context: LoadContext,
+  options: PluginOptions,
+): Plugin | null {
+  if (process.env.NODE_ENV !== 'production') {
+    return null;
+  }
+
+  const firstTrackingId = options.trackingID[0];
+
+  return {
+    name: 'docusaurus-plugin-google-gtag',
+
+    contentLoaded({actions}) {
+      actions.setGlobalData(options);
+    },
+
+    getClientModules() {
+      return ['./gtag'];
+    },
+
+    injectHtmlTags() {
+      return {
+        // Gtag includes GA by default, so we also preconnect to
+        // google-analytics.
+        headTags: [
+          {
+            tagName: 'link',
+            attributes: {
+              rel: 'preconnect',
+              href: 'https://www.google-analytics.com',
+            },
+          },
+          {
+            tagName: 'link',
+            attributes: {
+              rel: 'preconnect',
+              href: 'https://www.googletagmanager.com',
+            },
+          },
+          {
+            tagName: 'script',
+            attributes: {
+              async: true,
+              // We only include the first tracking id here because google says
+              // we shouldn't install multiple tags/scripts on the same page
+              // Instead we should load one script and use n * gtag("config",id)
+              // See https://developers.google.com/tag-platform/gtagjs/install#add-products
+              src: `https://www.googletagmanager.com/gtag/js?id=${firstTrackingId}`,
+            },
+          },
+          {
+            tagName: 'script',
+            innerHTML: `
+              window.dataLayer = window.dataLayer || [];
+              function gtag(){dataLayer.push(arguments);}
+              gtag('js', new Date());
+              ${createConfigSnippets(options)};
+              `,
+          },
+        ],
+      };
+    },
+  };
+}
+
+export {validateThemeConfig, validateOptions} from './options';
+
+export type {PluginOptions, Options};

package/src/options.ts

@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import {Joi} from '@docusaurus/utils-validation';
+import type {
+  OptionValidationContext,
+  ThemeConfig,
+  ThemeConfigValidationContext,
+} from '@docusaurus/types';
+
+export type PluginOptions = {
+  trackingID: [string, ...string[]];
+  // TODO deprecate anonymizeIP after June 2023
+  // "In Google Analytics 4, IP masking is not necessary
+  // since IP addresses are not logged or stored."
+  // https://support.google.com/analytics/answer/2763052?hl=en
+  anonymizeIP: boolean;
+};
+
+export type Options = {
+  trackingID: string | [string, ...string[]];
+  anonymizeIP?: boolean;
+};
+
+export const DEFAULT_OPTIONS: Partial<PluginOptions> = {
+  anonymizeIP: false,
+};
+
+const pluginOptionsSchema = Joi.object<PluginOptions>({
+  // We normalize trackingID as a string[]
+  trackingID: Joi.alternatives()
+    .try(
+      Joi.alternatives().conditional(Joi.string().required(), {
+        then: Joi.custom((val: boolean) => [val]),
+      }),
+      Joi.array().items(Joi.string().required()),
+    )
+    .required(),
+  anonymizeIP: Joi.boolean().default(DEFAULT_OPTIONS.anonymizeIP),
+});
+
+export function validateOptions({
+  validate,
+  options,
+}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
+  return validate(pluginOptionsSchema, options);
+}
+
+export function validateThemeConfig({
+  themeConfig,
+}: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig {
+  if ('gtag' in themeConfig) {
+    throw new Error(
+      'The "gtag" field in themeConfig should now be specified as option for plugin-google-gtag. More information at https://github.com/facebook/docusaurus/pull/5832.',
+    );
+  }
+  return themeConfig;
+}

package/src/types.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/// <reference types="@docusaurus/module-type-aliases" />

package/src/vendor-gtag.ts

@@ -0,0 +1,196 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// Types directly copied from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gtag.js
+// I'd prefer not do that, but this should fix our StackBlitz playground
+// See https://github.com/facebook/docusaurus/pull/12080
+// See https://github.com/facebook/docusaurus/issues/11615
+
+/* eslint-disable */
+declare var gtag: Gtag.Gtag;
+declare namespace Gtag {
+  interface GtagCommands {
+    config: [
+      targetId: string,
+      config?: ControlParams | EventParams | ConfigParams | CustomParams,
+    ];
+    // eslint-disable-next-line @definitelytyped/no-single-element-tuple-type
+    set:
+      | [targetId: string, config: CustomParams | boolean | string]
+      | [config: CustomParams];
+    // eslint-disable-next-line @definitelytyped/no-single-element-tuple-type
+    js: [config: Date];
+    event: [
+      eventName: EventNames | (string & {}),
+      eventParams?: ControlParams | EventParams | CustomParams,
+    ];
+    get: [
+      targetId: string,
+      fieldName: FieldNames | string,
+      callback?: (field: string | CustomParams | undefined) => any,
+    ];
+    consent: [
+      consentArg: ConsentArg | (string & {}),
+      consentParams: ConsentParams,
+    ];
+  }
+
+  interface Gtag {
+    <Command extends keyof GtagCommands>(
+      command: Command,
+      ...args: GtagCommands[Command]
+    ): void;
+  }
+
+  interface ConfigParams {
+    page_title?: string | undefined;
+    page_location?: string | undefined;
+    page_path?: string | undefined;
+    send_page_view?: boolean | undefined;
+  }
+
+  interface CustomParams {
+    [key: string]: any;
+  }
+
+  interface ControlParams {
+    groups?: string | string[] | undefined;
+    send_to?: string | string[] | undefined;
+    event_callback?: (() => void) | undefined;
+    event_timeout?: number | undefined;
+  }
+
+  type EventNames =
+    | 'add_payment_info'
+    | 'add_shipping_info'
+    | 'add_to_cart'
+    | 'add_to_wishlist'
+    | 'begin_checkout'
+    | 'checkout_progress'
+    | 'earn_virtual_currency'
+    | 'exception'
+    | 'generate_lead'
+    | 'join_group'
+    | 'level_end'
+    | 'level_start'
+    | 'level_up'
+    | 'login'
+    | 'page_view'
+    | 'post_score'
+    | 'purchase'
+    | 'refund'
+    | 'remove_from_cart'
+    | 'screen_view'
+    | 'search'
+    | 'select_content'
+    | 'select_item'
+    | 'select_promotion'
+    | 'set_checkout_option'
+    | 'share'
+    | 'sign_up'
+    | 'spend_virtual_currency'
+    | 'tutorial_begin'
+    | 'tutorial_complete'
+    | 'unlock_achievement'
+    | 'timing_complete'
+    | 'view_cart'
+    | 'view_item'
+    | 'view_item_list'
+    | 'view_promotion'
+    | 'view_search_results';
+
+  interface EventParams {
+    checkout_option?: string | undefined;
+    checkout_step?: number | undefined;
+    content_id?: string | undefined;
+    content_type?: string | undefined;
+    coupon?: string | undefined;
+    currency?: string | undefined;
+    description?: string | undefined;
+    fatal?: boolean | undefined;
+    items?: Item[] | undefined;
+    method?: string | undefined;
+    number?: string | undefined;
+    promotions?: Promotion[] | undefined;
+    screen_name?: string | undefined;
+    search_term?: string | undefined;
+    shipping?: Currency | undefined;
+    tax?: Currency | undefined;
+    transaction_id?: string | undefined;
+    value?: number | undefined;
+    event_label?: string | undefined;
+    event_category?: string | undefined;
+    /** @see {@link https://developers.google.com/analytics/devguides/collection/gtagjs/sending-data#specify_different_transport_mechanisms specify_different_transport_mechanisms} */
+    transport_type?: 'image' | 'xhr' | 'beacon' | undefined;
+  }
+
+  type Currency = string | number;
+
+  /**
+   * Interface of an item object used in lists for this event.
+   *
+   * Reference:
+   * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#view_item_item view_item_item}
+   * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#view_item_list_item view_item_list_item}
+   * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#select_item_item select_item_item}
+   * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#add_to_cart_item add_to_cart_item}
+   * @see {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/events#view_cart_item view_cart_item}
+   */
+  interface Item {
+    item_id?: string | undefined;
+    item_name?: string | undefined;
+    affiliation?: string | undefined;
+    coupon?: string | undefined;
+    currency?: string | undefined;
+    creative_name?: string | undefined;
+    creative_slot?: string | undefined;
+    discount?: Currency | undefined;
+    index?: number | undefined;
+    item_brand?: string | undefined;
+    item_category?: string | undefined;
+    item_category2?: string | undefined;
+    item_category3?: string | undefined;
+    item_category4?: string | undefined;
+    item_category5?: string | undefined;
+    item_list_id?: string | undefined;
+    item_list_name?: string | undefined;
+    item_variant?: string | undefined;
+    location_id?: string | undefined;
+    price?: Currency | undefined;
+    promotion_id?: string | undefined;
+    promotion_name?: string | undefined;
+    quantity?: number | undefined;
+  }
+
+  interface Promotion {
+    creative_name?: string | undefined;
+    creative_slot?: string | undefined;
+    promotion_id?: string | undefined;
+    promotion_name?: string | undefined;
+  }
+
+  type FieldNames = 'client_id' | 'session_id' | 'gclid';
+
+  type ConsentArg = 'default' | 'update';
+
+  /**
+   * Reference:
+   * @see {@link https://support.google.com/tagmanager/answer/10718549#consent-types consent-types}
+   * @see {@link https://developers.google.com/tag-platform/devguides/consent consent}
+   */
+  interface ConsentParams {
+    ad_personalization?: 'granted' | 'denied' | undefined;
+    ad_user_data?: 'granted' | 'denied' | undefined;
+    ad_storage?: 'granted' | 'denied' | undefined;
+    analytics_storage?: 'granted' | 'denied' | undefined;
+    functionality_storage?: 'granted' | 'denied' | undefined;
+    personalization_storage?: 'granted' | 'denied' | undefined;
+    security_storage?: 'granted' | 'denied' | undefined;
+    wait_for_update?: number | undefined;
+    region?: string[] | undefined;
+  }
+}