@nuxt/scripts 0.6.3 → 0.6.5

package/dist/runtime/types.d.ts

@@ -1,5 +1,5 @@
 import type { UseScriptOptions, DataKeys, SchemaAugmentations, ScriptBase } from '@unhead/schema';
-import type { UseScriptInput, VueScriptInstance, MaybeComputedRefEntriesOnly } from '@unhead/vue';
+import type { UseScriptInput, VueScriptInstance } from '@unhead/vue';
 import type { ComputedRef, Ref } from 'vue';
 import type { InferInput, ObjectSchema } from 'valibot';
 import type { Import } from 'unimport';
@@ -21,8 +21,8 @@ import type { LemonSqueezyInput } from './registry/lemon-squeezy.js';
 import type { GoogleAdsenseInput } from './registry/google-adsense.js';
 import type { ClarityInput } from './registry/clarity.js';
 import type { CrispInput } from './registry/crisp.js';
-import type { Input as GoogleTagManagerInput } from '#build/nuxt-scripts/tpc/google-tag-manager';
-import type { Input as GoogleAnalyticsInput } from '#build/nuxt-scripts/tpc/google-analytics';
+import type { GoogleAnalyticsInput } from './registry/google-analytics.js';
+import type { GoogleTagManagerInput } from './registry/google-tag-manager.js';
 export type NuxtUseScriptOptions<T = any> = Omit<UseScriptOptions<T>, 'trigger'> & {
     /**
      * The trigger to load the script:
@@ -44,6 +44,25 @@ export type NuxtUseScriptOptions<T = any> = Omit<UseScriptOptions<T>, 'trigger'>
      * loading the actual script and not getting warnings.
      */
     skipValidation?: boolean;
+    /**
+     * @internal
+     */
+    performanceMarkFeature?: string;
+    /**
+     * @internal
+     */
+    devtools?: {
+        /**
+         * Key used to map to the registry script for Nuxt DevTools.
+         * @internal
+         */
+        registryKey?: string;
+        /**
+         * Extra metadata to show with the registry script
+         * @internal
+         */
+        registryMeta?: Record<string, string>;
+    };
 };
 export type NuxtUseScriptOptionsSerializable = Omit<NuxtUseScriptOptions, 'use' | 'skipValidation' | 'stub' | 'trigger' | 'eventContext' | 'beforeInit'> & {
     trigger?: 'client' | 'server' | 'onNuxtReady';
@@ -65,8 +84,9 @@ export interface ConsentScriptTriggerOptions {
      */
     postConsentTrigger?: NuxtUseScriptOptions['trigger'];
 }
-export interface NuxtAppScript {
-    key: string;
+export interface NuxtDevToolsScriptInstance {
+    registryKey?: string;
+    registryMeta?: Record<string, string>;
     src: string;
     $script: VueScriptInstance<any>;
     events: {
@@ -106,10 +126,22 @@ export type NuxtConfigScriptRegistry<T extends keyof ScriptRegistry = keyof Scri
 }>;
 declare const emptyOptions: ObjectSchema<{}, undefined>;
 export type EmptyOptionsSchema = typeof emptyOptions;
-export type RegistryScriptInput<T extends ObjectSchema<any, any> = EmptyOptionsSchema, Bundelable extends boolean = true> = InferInput<T> & {
-    scriptInput?: MaybeComputedRefEntriesOnly<Omit<ScriptBase & DataKeys & SchemaAugmentations['script'], 'src'>>;
-    scriptOptions?: Bundelable extends true ? Omit<NuxtUseScriptOptions, 'use'> : Omit<NuxtUseScriptOptions, 'bundle' | 'use'>;
-};
+type ScriptInput = ScriptBase & DataKeys & SchemaAugmentations['script'];
+export type RegistryScriptInput<T extends ObjectSchema<any, any> = EmptyOptionsSchema, Bundelable extends boolean = true, Usable extends boolean = false, CanBypassOptions extends boolean = true> = (InferInput<T> & {
+    /**
+     * A unique key to use for the script, this can be used to load multiple of the same script with different options.
+     */
+    key?: string;
+    scriptInput?: ScriptInput;
+    scriptOptions?: Omit<NuxtUseScriptOptions, Bundelable extends true ? '' : 'bundle' | Usable extends true ? '' : 'use'>;
+}) | Partial<InferInput<T>> & (CanBypassOptions extends true ? {
+    /**
+     * A unique key to use for the script, this can be used to load multiple of the same script with different options.
+     */
+    key?: string;
+    scriptInput: Required<Pick<ScriptInput, 'src'>> & ScriptInput;
+    scriptOptions?: Omit<NuxtUseScriptOptions, Bundelable extends true ? '' : 'bundle' | Usable extends true ? '' : 'use'>;
+} : never);
 export interface RegistryScript {
     import?: Import;
     scriptBundling?: false | ((options?: any) => string | false);

package/dist/runtime/utils.d.ts

@@ -8,7 +8,7 @@ type OptionsFn<O extends ObjectSchema<any, any>> = (options: InferInput<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 extends ObjectSchema<any, any> = EmptyOptionsSchema>(key: keyof ScriptRegistry | string, optionsFn: OptionsFn<O>, _userOptions?: RegistryScriptInput<O>): T & {
+export declare function useRegistryScript<T extends Record<string | symbol, any>, O extends ObjectSchema<any, any> = EmptyOptionsSchema>(registryKey: keyof ScriptRegistry | string, optionsFn: OptionsFn<O>, _userOptions?: RegistryScriptInput<O>): T & {
     $script: Promise<T> & VueScriptInstance<T>;
 };
 export {};

package/dist/runtime/utils.js

@@ -15,15 +15,31 @@ function validateScriptInputSchema(key, schema, options) {
 export function scriptRuntimeConfig(key) {
   return (useRuntimeConfig().public.scripts || {})[key];
 }
-export function useRegistryScript(key, optionsFn, _userOptions) {
-  const scriptConfig = scriptRuntimeConfig(key);
+export function useRegistryScript(registryKey, optionsFn, _userOptions) {
+  const scriptConfig = scriptRuntimeConfig(registryKey);
   const userOptions = Object.assign(_userOptions || {}, typeof scriptConfig === "object" ? scriptConfig : {});
   const options = optionsFn(userOptions);
-  const scriptInput = defu(userOptions.scriptInput, options.scriptInput, { key });
+  const scriptInput = defu(userOptions.scriptInput, options.scriptInput, { key: registryKey });
   const scriptOptions = Object.assign(userOptions?.scriptOptions || {}, options.scriptOptions || {});
+  if (import.meta.dev) {
+    scriptOptions.devtools = defu(scriptOptions.devtools, { registryKey });
+    if (options.schema) {
+      const registryMeta = {};
+      for (const k in options.schema.entries) {
+        if (options.schema.entries[k].type !== "optional") {
+          registryMeta[k] = String(userOptions[k]);
+        }
+      }
+      scriptOptions.devtools.registryMeta = registryMeta;
+    }
+  }
   const init = scriptOptions.beforeInit;
   scriptOptions.beforeInit = () => {
-    import.meta.dev && !scriptOptions.skipValidation && options.schema && validateScriptInputSchema(key, options.schema, userOptions);
+    if (import.meta.dev && !scriptOptions.skipValidation && options.schema) {
+      if (!userOptions.scriptInput?.src) {
+        validateScriptInputSchema(registryKey, options.schema, userOptions);
+      }
+    }
     init?.();
     if (import.meta.client) {
       options.clientInit?.();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxt/scripts",
   "type": "module",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "packageManager": "pnpm@9.5.0",
   "description": "Load third-party scripts with better performance, privacy and DX in Nuxt Apps.",
   "author": {
@@ -48,7 +48,8 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "test": "vitest",
-    "test:types": "npx nuxi typecheck"
+    "test:types": "npx nuxi typecheck",
+    "script:generate-tpc": "bun ./scripts/generateTpcScripts.ts && pnpm lint:fix"
   },
   "build": {
     "externals": [
@@ -59,8 +60,8 @@
       "third-party-capital",
       "knitwork",
       "estree-walker",
-      "#build/nuxt-scripts/tpc/google-tag-manager",
-      "#build/nuxt-scripts/tpc/google-analytics",
+      "#build/modules/nuxt-scripts-gtm",
+      "#build/modules/nuxt-scripts-ga",
       "@vimeo/player",
       "esbuild"
     ]
@@ -73,9 +74,8 @@
     "@types/stripe-v3": "^3.1.33",
     "@types/vimeo__player": "^2.18.3",
     "@types/youtube": "^0.0.50",
-    "@unhead/vue": "^1.9.15",
+    "@unhead/vue": "^1.9.16",
     "@vueuse/core": "^10.11.0",
-    "acorn": "^8.12.1",
     "consola": "^3.2.3",
     "defu": "^6.1.4",
     "h3": "^1.12.0",
@@ -89,7 +89,7 @@
     "shiki": "^1.10.3",
     "sirv": "^2.0.4",
     "std-env": "^3.7.0",
-    "third-party-capital": "^1.0.31",
+    "third-party-capital": "^2.1.1",
     "ufo": "^1.5.3",
     "unimport": "^3.7.2",
     "unplugin": "^1.11.0",
@@ -103,11 +103,11 @@
     "@nuxt/test-utils": "3.13.1",
     "@types/semver": "^7.5.8",
     "@typescript-eslint/typescript-estree": "^7.16.0",
-    "@unhead/schema": "^1.9.15",
+    "@unhead/schema": "^1.9.16",
     "acorn-loose": "^8.4.0",
     "bumpp": "^9.4.1",
     "changelogen": "^0.5.5",
-    "eslint": "9.6.0",
+    "eslint": "9.7.0",
     "eslint-plugin-n": "^17.9.0",
     "knitwork": "^1.1.0",
     "nuxt": "^3.12.3",
@@ -123,6 +123,7 @@
     "nuxt": "^3.12.3",
     "nuxt-scripts-devtools": "workspace:*",
     "vue": "^3.4.31",
-    "vue-router": "^4.4.0"
+    "vue-router": "^4.4.0",
+    "shiki": "1.10.3"
   }
-}
+}