@nuxt/scripts 0.11.2 → 0.11.4

package/dist/runtime/registry/google-analytics.d.ts

@@ -1,21 +1,65 @@
 import type { RegistryScriptInput } from '#nuxt-scripts/types';
-type ConsentOptions = 'default' | 'update';
+export type GtagCustomParams = Record<string, any>;
+export type ConsentStatus = 'granted' | 'denied';
+export interface ConsentOptions {
+    ad_user_data?: ConsentStatus;
+    ad_personalization?: ConsentStatus;
+    ad_storage?: ConsentStatus;
+    analytics_storage?: ConsentStatus;
+    functionality_storage?: ConsentStatus;
+    personalization_storage?: ConsentStatus;
+    security_storage?: ConsentStatus;
+    wait_for_update?: number;
+    region?: string[];
+}
+export interface ConfigParams extends GtagCustomParams {
+    send_page_view?: boolean;
+    transport_url?: string;
+    cookie_domain?: string;
+    cookie_prefix?: string;
+    cookie_expires?: number;
+    cookie_update?: boolean;
+    cookie_flags?: string;
+    user_id?: string;
+}
+export interface EventParameters extends GtagCustomParams {
+    value?: number;
+    currency?: string;
+    transaction_id?: string;
+    items?: Array<{
+        item_id?: string;
+        item_name?: string;
+        item_category?: string;
+        item_variant?: string;
+        price?: number;
+        quantity?: number;
+        [key: string]: any;
+    }>;
+    [key: string]: any;
+}
+export type DefaultEventName = 'add_payment_info' | 'add_shipping_info' | 'add_to_cart' | 'add_to_wishlist' | 'begin_checkout' | 'purchase' | 'refund' | 'remove_from_cart' | 'select_item' | 'select_promotion' | 'view_cart' | 'view_item' | 'view_item_list' | 'view_promotion' | 'login' | 'sign_up' | 'search' | 'page_view' | 'screen_view' | string;
 export interface GTag {
-    (fn: 'js', opt: Date): void;
-    (fn: 'config' | 'get', opt: string): void;
-    (fn: 'event', opt: string, opt2?: Record<string, any>): void;
-    (fn: 'set', opt: Record<string, string>): void;
-    (fn: 'consent', opt: ConsentOptions, opt2: Record<string, string | number>): void;
+    (command: 'js', value: Date): void;
+    (command: 'config', targetId: string, configParams?: ConfigParams): void;
+    (command: 'get', targetId: string, fieldName: string, callback?: (field: any) => void): void;
+    (command: 'event', eventName: DefaultEventName, eventParams?: EventParameters): void;
+    (command: 'set', params: GtagCustomParams): void;
+    (command: 'consent', consentArg: 'default' | 'update', consentParams: ConsentOptions): void;
+}
+export interface DataLayerObject {
+    event?: string;
+    [key: string]: any;
+}
+export type DataLayer = Array<DataLayerObject>;
+export interface GoogleAnalyticsApi {
+    gtag: GTag;
+    dataLayer: DataLayer;
 }
-type DataLayer = Array<Parameters<GTag> | Record<string, unknown>>;
 export declare const GoogleAnalyticsOptions: import("valibot").ObjectSchema<{
     readonly id: import("valibot").StringSchema<undefined>;
     readonly l: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
 }, undefined>;
 export type GoogleAnalyticsInput = RegistryScriptInput<typeof GoogleAnalyticsOptions>;
-export interface GoogleAnalyticsApi {
-    gtag: GTag;
-    dataLayer: DataLayer;
-}
-export declare function useScriptGoogleAnalytics<T extends GoogleAnalyticsApi>(_options?: GoogleAnalyticsInput): import("#nuxt-scripts/types").UseScriptContext<T>;
-export {};
+export declare function useScriptGoogleAnalytics<T extends GoogleAnalyticsApi>(_options?: GoogleAnalyticsInput & {
+    onBeforeGtagStart?: (gtag: GTag) => void;
+}): import("#nuxt-scripts/types").UseScriptContext<T>;

package/dist/runtime/registry/google-analytics.js

@@ -3,36 +3,38 @@ import { useRegistryScript } from "#nuxt-scripts/utils";
 import { object, string, optional } from "#nuxt-scripts-validator";
 export const GoogleAnalyticsOptions = object({
   id: string(),
+  // The GA4 measurement ID (format: G-XXXXXXXX)
   l: optional(string())
+  // Optional global name for dataLayer (defaults to 'dataLayer')
 });
 export function useScriptGoogleAnalytics(_options) {
-  return useRegistryScript(_options?.key || "googleAnalytics", (options) => ({
-    scriptInput: {
-      src: withQuery("https://www.googletagmanager.com/gtag/js", { id: options?.id, l: options?.l })
-    },
-    schema: import.meta.dev ? GoogleAnalyticsOptions : void 0,
-    scriptOptions: {
-      use: () => {
-        const gtag = function(...args) {
-          window["gtag-" + (options.l ?? "dataLayer")](...args);
-        };
-        return {
-          dataLayer: window[options.l ?? "dataLayer"],
-          gtag
-        };
+  return useRegistryScript(_options?.key || "googleAnalytics", (options) => {
+    const dataLayerName = options?.l ?? "dataLayer";
+    const w = import.meta.client ? window : {};
+    return {
+      scriptInput: {
+        src: withQuery("https://www.googletagmanager.com/gtag/js", { id: options?.id, l: options?.l })
       },
-      performanceMarkFeature: "nuxt-third-parties-ga",
-      tagPriority: 1
-    },
-    clientInit: import.meta.server ? void 0 : () => {
-      const dataLayerName = options?.l ?? "dataLayer";
-      const dataLayer = window[dataLayerName] || [];
-      window[dataLayerName] = dataLayer;
-      window["gtag-" + dataLayerName] = function() {
-        window[dataLayerName].push(arguments);
-      };
-      window["gtag-" + dataLayerName]("js", /* @__PURE__ */ new Date());
-      window["gtag-" + dataLayerName]("config", options?.id);
-    }
-  }), _options);
+      schema: import.meta.dev ? GoogleAnalyticsOptions : void 0,
+      scriptOptions: {
+        use: () => {
+          return {
+            dataLayer: w[dataLayerName],
+            gtag: w.gtag
+          };
+        },
+        performanceMarkFeature: "nuxt-third-parties-ga",
+        tagPriority: 1
+      },
+      clientInit: import.meta.server ? void 0 : () => {
+        w[dataLayerName] = w[dataLayerName] || [];
+        w.gtag = function() {
+          w[dataLayerName].push(arguments);
+        };
+        _options?.onBeforeGtagStart?.(w.gtag);
+        w.gtag("js", /* @__PURE__ */ new Date());
+        w.gtag("config", options?.id);
+      }
+    };
+  }, _options);
 }

package/dist/runtime/registry/google-tag-manager.d.ts

@@ -1,41 +1,103 @@
 import type { GTag } from './google-analytics.js';
-import type { RegistryScriptInput } from '#nuxt-scripts/types';
-type DataLayer = Array<Parameters<GTag> | Record<string, unknown>>;
-interface GoogleTagManagerDataLayerApi {
-    name: 'dataLayer';
-    set: (opt: {
-        [key: string]: string;
-    }) => void;
-    get: (key: string) => void;
+import type { NuxtUseScriptOptions, RegistryScriptInput, UseFunctionType, UseScriptContext } from '#nuxt-scripts/types';
+/**
+ * Improved DataLayer type that better reflects GTM's capabilities
+ * Can contain either gtag event parameters or custom data objects
+ */
+export type DataLayerItem = Parameters<GTag> | Record<string, unknown>;
+export type DataLayer = Array<DataLayerItem>;
+/**
+ * DataLayer push function type
+ */
+export interface DataLayerPush {
+    (...args: Parameters<GTag>): void;
+    (obj: Record<string, unknown>): void;
+}
+/**
+ * Improved DataLayer API type with more precise methods
+ */
+export interface GoogleTagManagerDataLayerApi {
+    name: string;
+    push: DataLayerPush;
+    set: (config: Record<string, unknown>) => void;
+    get: <T = unknown>(key: string) => T;
     reset: () => void;
+    listeners: Array<() => void>;
 }
-interface GoogleTagManagerDataLayerStatus {
+/**
+ * DataLayer status information
+ */
+export interface GoogleTagManagerDataLayerStatus {
     dataLayer: {
         gtmDom: boolean;
         gtmLoad: boolean;
         subscribers: number;
+        [key: string]: unknown;
     };
 }
-type GoogleTagManagerInstance = GoogleTagManagerDataLayerStatus & {
-    [key: string]: {
-        callback: () => void;
-        dataLayer: GoogleTagManagerDataLayerApi;
-    };
-};
-interface GoogleTagManagerApi {
+/**
+ * Container instance type
+ */
+export interface GoogleTagManagerContainer {
+    callback: () => void;
+    dataLayer: GoogleTagManagerDataLayerApi;
+    state: Record<string, unknown>;
+}
+/**
+ * Complete GTM instance object
+ */
+export interface GoogleTagManagerInstance extends GoogleTagManagerDataLayerStatus {
+    [containerId: string]: GoogleTagManagerContainer | any;
+}
+/**
+ * Complete Google Tag Manager API accessible via window
+ */
+export interface GoogleTagManagerApi {
     google_tag_manager: GoogleTagManagerInstance;
-    dataLayer: DataLayer;
+    dataLayer: DataLayer & {
+        push: DataLayerPush;
+    };
 }
+/**
+ * Enhanced window type with GTM
+ */
 declare global {
     interface Window extends GoogleTagManagerApi {
     }
 }
+/**
+ * GTM configuration options with improved documentation
+ */
 export declare const GoogleTagManagerOptions: import("valibot").ObjectSchema<{
+    /** GTM container ID (format: GTM-XXXXXX) */
     readonly id: import("valibot").StringSchema<undefined>;
+    /** Optional dataLayer variable name */
     readonly l: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
+    /** Authentication token for environment-specific container versions */
+    readonly auth: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
+    /** Preview environment name */
+    readonly preview: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
+    /** Forces GTM cookies to take precedence when true */
+    readonly cookiesWin: import("valibot").OptionalSchema<import("valibot").UnionSchema<[import("valibot").BooleanSchema<undefined>, import("valibot").LiteralSchema<"x", undefined>], undefined>, undefined>;
+    /** Enables debug mode when true */
+    readonly debug: import("valibot").OptionalSchema<import("valibot").UnionSchema<[import("valibot").BooleanSchema<undefined>, import("valibot").LiteralSchema<"x", undefined>], undefined>, undefined>;
+    /** No Personal Advertising - disables advertising features when true */
+    readonly npa: import("valibot").OptionalSchema<import("valibot").UnionSchema<[import("valibot").BooleanSchema<undefined>, import("valibot").LiteralSchema<"1", undefined>], undefined>, undefined>;
+    /** Custom dataLayer name (alternative to "l" property) */
+    readonly dataLayer: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
+    /** Environment name for environment-specific container */
+    readonly envName: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
+    /** Referrer policy for analytics requests */
+    readonly authReferrerPolicy: import("valibot").OptionalSchema<import("valibot").StringSchema<undefined>, undefined>;
 }, undefined>;
 export type GoogleTagManagerInput = RegistryScriptInput<typeof GoogleTagManagerOptions>;
-export declare function useScriptGoogleTagManager<T extends GoogleTagManagerApi>(_options?: GoogleTagManagerInput & {
-    onBeforeGtmStart?: (gtag: GTag) => void;
-}): import("#nuxt-scripts/types").UseScriptContext<T>;
-export {};
+/**
+ * Hook to use Google Tag Manager in Nuxt applications
+ */
+export declare function useScriptGoogleTagManager<T extends GoogleTagManagerApi>(options?: GoogleTagManagerInput & {
+    /**
+     * Optional callback that runs before GTM starts
+     * Allows for custom initialization or configuration
+     */
+    onBeforeGtmStart?: (gtag: DataLayerPush) => void;
+}): UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T>, T>>;

package/dist/runtime/registry/google-tag-manager.js

@@ -1,31 +1,72 @@
 import { withQuery } from "ufo";
 import { useRegistryScript } from "#nuxt-scripts/utils";
-import { object, string, optional } from "#nuxt-scripts-validator";
+import { object, string, optional, boolean, union, literal } from "#nuxt-scripts-validator";
 export const GoogleTagManagerOptions = object({
+  /** GTM container ID (format: GTM-XXXXXX) */
   id: string(),
-  l: optional(string())
+  /** Optional dataLayer variable name */
+  l: optional(string()),
+  /** Authentication token for environment-specific container versions */
+  auth: optional(string()),
+  /** Preview environment name */
+  preview: optional(string()),
+  /** Forces GTM cookies to take precedence when true */
+  cookiesWin: optional(union([boolean(), literal("x")])),
+  /** Enables debug mode when true */
+  debug: optional(union([boolean(), literal("x")])),
+  /** No Personal Advertising - disables advertising features when true */
+  npa: optional(union([boolean(), literal("1")])),
+  /** Custom dataLayer name (alternative to "l" property) */
+  dataLayer: optional(string()),
+  /** Environment name for environment-specific container */
+  envName: optional(string()),
+  /** Referrer policy for analytics requests */
+  authReferrerPolicy: optional(string())
 });
-export function useScriptGoogleTagManager(_options) {
-  return useRegistryScript(_options?.key || "googleTagManager", (options) => ({
-    scriptInput: {
-      src: withQuery("https://www.googletagmanager.com/gtm.js", { id: options?.id, l: options?.l })
+export function useScriptGoogleTagManager(options) {
+  return useRegistryScript(
+    options?.key || "googleTagManager",
+    (opts) => {
+      const dataLayerName = opts?.l ?? opts?.dataLayer ?? "dataLayer";
+      return {
+        scriptInput: {
+          src: withQuery("https://www.googletagmanager.com/gtm.js", {
+            id: opts.id,
+            l: opts.l,
+            gtm_auth: opts.auth,
+            gtm_preview: opts.preview,
+            gtm_cookies_win: opts.cookiesWin ? "x" : void 0,
+            gtm_debug: opts.debug ? "x" : void 0,
+            gtm_npa: opts.npa ? "1" : void 0,
+            gtm_data_layer: opts.dataLayer,
+            gtm_env: opts.envName,
+            gtm_auth_referrer_policy: opts.authReferrerPolicy
+          })
+        },
+        schema: import.meta.dev ? GoogleTagManagerOptions : void 0,
+        scriptOptions: {
+          use: () => {
+            return {
+              dataLayer: window[dataLayerName],
+              google_tag_manager: window.google_tag_manager
+            };
+          },
+          performanceMarkFeature: "nuxt-third-parties-gtm",
+          tagPriority: 1
+        },
+        clientInit: import.meta.server ? void 0 : () => {
+          window[dataLayerName] = window[dataLayerName] || [];
+          function gtag(...args) {
+            window[dataLayerName].push(args);
+          }
+          options?.onBeforeGtmStart?.(gtag);
+          window[dataLayerName].push({
+            "gtm.start": (/* @__PURE__ */ new Date()).getTime(),
+            "event": "gtm.js"
+          });
+        }
+      };
     },
-    schema: import.meta.dev ? GoogleTagManagerOptions : void 0,
-    scriptOptions: {
-      use: () => {
-        return { dataLayer: window[options.l ?? "dataLayer"], google_tag_manager: window.google_tag_manager };
-      },
-      performanceMarkFeature: "nuxt-third-parties-gtm",
-      tagPriority: 1
-    },
-    clientInit: import.meta.server ? void 0 : () => {
-      const dataLayerName = options?.l ?? "dataLayer";
-      window[dataLayerName] = window[options?.l ?? "dataLayer"] || [];
-      function gtag() {
-        window[dataLayerName].push(arguments);
-      }
-      _options?.onBeforeGtmStart?.(gtag);
-      window[dataLayerName].push({ "gtm.start": (/* @__PURE__ */ new Date()).getTime(), "event": "gtm.js" });
-    }
-  }), _options);
+    options
+  );
 }

package/dist/runtime/utils.d.ts

@@ -9,6 +9,6 @@ type OptionsFn<O> = (options: InferIfSchema<O>) => ({
     clientInit?: () => void;
 });
 export declare function scriptRuntimeConfig<T extends keyof ScriptRegistry>(key: T): ScriptRegistry[T];
-export declare function useRegistryScript<T extends Record<string | symbol, any>, O = EmptyOptionsSchema, U = {}>(registryKey: keyof ScriptRegistry | string, optionsFn: OptionsFn<O>, _userOptions?: RegistryScriptInput<O>): UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T>, T>>;
+export declare function useRegistryScript<T extends Record<string | symbol, any>, O = EmptyOptionsSchema>(registryKey: keyof ScriptRegistry | string, optionsFn: OptionsFn<O>, _userOptions?: RegistryScriptInput<O>): UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T>, T>>;
 export declare function pick(obj: Record<string, any>, keys: string[]): Record<string, any>;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxt/scripts",
   "type": "module",
-  "version": "0.11.2",
+  "version": "0.11.4",
   "description": "Load third-party scripts with better performance, privacy and DX in Nuxt Apps.",
   "author": {
     "website": "https://harlanzw.com",
@@ -71,9 +71,9 @@
     }
   },
   "dependencies": {
-    "@nuxt/kit": "^3.16.0",
+    "@nuxt/kit": "^3.16.1",
     "@vueuse/core": "^13.0.0",
-    "consola": "^3.4.0",
+    "consola": "^3.4.2",
     "defu": "^6.1.4",
     "h3": "^1.15.1",
     "magic-string": "^0.30.17",
@@ -84,39 +84,40 @@
     "sirv": "^3.0.1",
     "std-env": "^3.8.1",
     "ufo": "^1.5.4",
-    "unplugin": "^2.2.0",
+    "unplugin": "^2.2.2",
     "unstorage": "^1.15.0",
-    "valibot": "^1.0.0-rc.4"
+    "valibot": "^1.0.0"
   },
   "devDependencies": {
-    "@nuxt/devtools-kit": "^2.3.0",
-    "@nuxt/devtools-ui-kit": "^2.3.0",
+    "@nuxt/devtools-kit": "^2.3.1",
+    "@nuxt/devtools-ui-kit": "^2.3.1",
     "@nuxt/eslint-config": "^1.2.0",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/test-utils": "3.17.1",
+    "@nuxt/test-utils": "3.17.2",
     "@types/semver": "^7.5.8",
-    "@typescript-eslint/typescript-estree": "^8.26.1",
+    "@typescript-eslint/typescript-estree": "^8.28.0",
     "acorn-loose": "^8.4.0",
     "bumpp": "^10.1.0",
     "changelogen": "^0.6.1",
-    "eslint": "9.21.0",
+    "eslint": "9.23.0",
     "eslint-plugin-n": "^17.16.2",
     "happy-dom": "^17.4.4",
     "knitwork": "^1.2.0",
-    "nuxt": "^3.16.0",
-    "playwright-core": "^1.51.0",
+    "nuxt": "^3.16.1",
+    "playwright-core": "^1.51.1",
     "shiki": "2.5.0",
     "typescript": "5.8.2",
-    "vitest": "^3.0.8",
+    "vitest": "^3.0.9",
     "vue": "^3.5.13",
     "vue-router": "^4.5.0",
     "vue-tsc": "^2.2.8",
-    "@nuxt/scripts": "0.11.2"
+    "@nuxt/scripts": "0.11.4"
   },
   "resolutions": {
     "@nuxt/schema": "catalog:",
     "@nuxt/scripts": "workspace:*",
-    "@unhead/vue": "2.0.0-rc.12",
+    "@unhead/vue": "2.0.1",
+    "unhead": "2.0.1",
     "nuxt": "catalog:",
     "typescript": "5.8.2",
     "vue": "^3.5.13",