fix!: require Nuxt v3.16

harlan-zw · harlan-zw · commit 017e9f244609 · 2025-03-08T13:47:04.000+11:00
diff --git a/client/package.json b/client/package.json
@@ -14,8 +14,8 @@
     "@iconify-json/carbon": "^1.2.8",
     "@nuxt/devtools-kit": "^2.2.1",
     "@nuxt/devtools-ui-kit": "^2.2.1",
-    "@nuxt/kit": "^3.15.4",
-    "nuxt": "^3.15.4",
+    "@nuxt/kit": "^3.16.0",
+    "nuxt": "^3.16.0",
     "vue": "^3.5.13",
     "vue-router": "latest"
   }
diff --git a/docs/package.json b/docs/package.json
@@ -24,6 +24,6 @@
     "@vueuse/nuxt": "^12.8.2",
     "nuxt-content-twoslash": "^0.1.2",
     "nuxt-llms": "^0.1.0",
-    "shiki": "^2.5.0"
+    "shiki": "^3.1.0"
   }
 }
diff --git a/package.json b/package.json
@@ -69,7 +69,8 @@
     "@types/google.maps": "^3.58.1",
     "@types/vimeo__player": "^2.18.3",
     "@types/youtube": "^0.1.0",
-    "@unhead/vue": "^1 || ^2"
+    "@unhead/vue": "^2.0.0-rc.8",
+    "nuxt": "^3.16.0"
   },
   "peerDependenciesMeta": {
     "@stripe/stripe-js": {
@@ -109,16 +110,16 @@
     "@nuxt/devtools-ui-kit": "^2.2.1",
     "@nuxt/eslint-config": "^1.1.0",
     "@nuxt/module-builder": "^0.8.4",
+    "@nuxt/scripts": "workspace:*",
     "@nuxt/test-utils": "3.17.1",
     "@types/semver": "^7.5.8",
     "@typescript-eslint/typescript-estree": "^8.26.0",
     "acorn-loose": "^8.4.0",
     "bumpp": "^10.0.3",
-    "@unhead/ssr": "^1.11.20",
     "changelogen": "^0.6.1",
     "eslint": "9.21.0",
     "eslint-plugin-n": "^17.16.2",
-    "happy-dom": "^17.3.0",
+    "happy-dom": "^17.4.0",
     "knitwork": "^1.2.0",
     "nuxt": "catalog:",
     "playwright-core": "^1.51.0",
@@ -127,12 +128,12 @@
     "vitest": "^3.0.8",
     "vue": "^3.5.13",
     "vue-router": "^4.5.0",
-    "vue-tsc": "^2.2.8",
-    "@nuxt/scripts": "workspace:*"
+    "vue-tsc": "^2.2.8"
   },
   "resolutions": {
     "@nuxt/schema": "catalog:",
     "@nuxt/scripts": "workspace:*",
+    "@unhead/vue": "2.0.0-rc.8",
     "nuxt": "catalog:",
     "typescript": "5.8.2",
     "vue": "^3.5.13",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -4,6 +4,6 @@ packages:
   - docs
 
 catalog:
-  nuxt: ^3.15.4
-  '@nuxt/kit': ^3.15.4
-  '@nuxt/schema': ^3.15.4
+  nuxt: ^3.16.0
+  '@nuxt/kit': ^3.16.0
+  '@nuxt/schema': ^3.16.0
diff --git a/src/module.ts b/src/module.ts
@@ -7,11 +7,9 @@ import {
   createResolver,
   defineNuxtModule,
   hasNuxtModule,
-  resolvePath,
 } from '@nuxt/kit'
 import { readPackageJSON } from 'pkg-types'
-import { lt, gte } from 'semver'
-import { dirname, join } from 'pathe'
+import { gte } from 'semver'
 import type { FetchOptions } from 'ofetch'
 import { setupDevToolsUI } from './devtools'
 import { NuxtScriptBundleTransformer } from './plugins/transform'
@@ -89,7 +87,7 @@ export default defineNuxtModule<ModuleOptions>({
     name: '@nuxt/scripts',
     configKey: 'scripts',
     compatibility: {
-      nuxt: '>=3',
+      nuxt: '>=3.16',
       bridge: false,
     },
   },
@@ -118,23 +116,10 @@ export default defineNuxtModule<ModuleOptions>({
       logger.debug('The module is disabled, skipping setup.')
       return
     }
-    let isUnheadV2 = false
-    const unheadPath = await resolvePath('@unhead/vue')
-      .catch(() => undefined)
-      // compatibility
-      .then(p => p?.endsWith('index.mjs') ? dirname(p) : p)
     // couldn't be found for some reason, assume compatibility
-    if (unheadPath) {
-      const { version: unheadVersion } = await readPackageJSON(join(unheadPath, 'package.json'))
-      if (!unheadVersion || lt(unheadVersion, '1.10.0')) {
-        logger.error(`Nuxt Scripts requires Unhead >= 1.10.0, you are using v${unheadVersion}. Please run \`nuxi upgrade --clean\` to upgrade...`)
-      }
-      else if (lt(unheadVersion, '1.11.5')) {
-        logger.warn(`Nuxt Scripts recommends Unhead >= 1.11.5, you are using v${unheadVersion}. Please run \`nuxi upgrade --clean\` to upgrade...`)
-      }
-      else if (gte(unheadVersion, '2.0.0-beta.1')) {
-        isUnheadV2 = true
-      }
+    const { version: unheadVersion } = await readPackageJSON('@unhead/vue')
+    if (unheadVersion && gte(unheadVersion, '2.0.0-rc.8')) {
+      logger.error(`Nuxt Scripts requires Unhead >= 2, you are using v${unheadVersion}. Please run \`nuxi upgrade --clean\` to upgrade...`)
     }
     nuxt.options.runtimeConfig['nuxt-scripts'] = { version }
     nuxt.options.runtimeConfig.public['nuxt-scripts'] = {
@@ -143,7 +128,6 @@ export default defineNuxtModule<ModuleOptions>({
       defaultScriptOptions: config.defaultScriptOptions,
     }
     addImportsDir([
-      resolve(`./runtime/unhead-${isUnheadV2 ? 'v2' : 'v1'}`),
       resolve('./runtime/composables'),
       // auto-imports aren't working without this for some reason
       // TODO find solution as we're double-registering
diff --git a/src/runtime/composables/useScript.ts b/src/runtime/composables/useScript.ts
@@ -1,7 +1,5 @@
-// @ts-expect-error untyped
 import type { UseScriptInput, UseScriptOptions, VueScriptInstance } from '@unhead/vue/scripts'
 import { defu } from 'defu'
-// @ts-expect-error untyped
 import { useScript as _useScript } from '@unhead/vue/scripts'
 import { reactive } from 'vue'
 import type { NuxtDevToolsScriptInstance, NuxtUseScriptOptions, UseScriptContext } from '../types'
@@ -21,9 +19,9 @@ export function resolveScriptKey(input: any): string {
   return input.key || input.src || (typeof input.innerHTML === 'string' ? input.innerHTML : '')
 }
 
-export function useScript<T extends Record<symbol | string, any> = Record<symbol | string, any>, U = Record<symbol | string, any>>(input: UseScriptInput, options?: NuxtUseScriptOptions<T, U>): UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T, U>, T>> {
+export function useScript<T extends Record<symbol | string, any> = Record<symbol | string, any>>(input: UseScriptInput, options?: NuxtUseScriptOptions<T>): UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T>, T>> {
   input = typeof input === 'string' ? { src: input } : input
-  options = defu(options, useNuxtScriptRuntimeConfig()?.defaultScriptOptions) as NuxtUseScriptOptions<T, U>
+  options = defu(options, useNuxtScriptRuntimeConfig()?.defaultScriptOptions) as NuxtUseScriptOptions<T>
   // browser hint optimizations
   const id = String(resolveScriptKey(input) as keyof typeof nuxtApp._scripts)
   const nuxtApp = useNuxtApp()
@@ -40,7 +38,7 @@ export function useScript<T extends Record<symbol | string, any> = Record<symbol
     }
   }
 
-  const instance = _useScript<T>(input, options as any as UseScriptOptions<T>) as UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T, U>, T>>
+  const instance = _useScript<T>(input, options as any as UseScriptOptions<T>) as UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T>, T>>
   const _remove = instance.remove
   instance.remove = () => {
     nuxtApp.$scripts[id] = undefined
@@ -50,7 +48,7 @@ export function useScript<T extends Record<symbol | string, any> = Record<symbol
   // used for devtools integration
   if (import.meta.dev && import.meta.client) {
     if (exists) {
-      return instance as any as UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T, U>, T>>
+      return instance as any as UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T>, T>>
     }
     // sync scripts to nuxtApp with debug details
     const payload: NuxtDevToolsScriptInstance = {
@@ -67,6 +65,7 @@ export function useScript<T extends Record<symbol | string, any> = Record<symbol
     }
 
     if (!nuxtApp._scripts[instance.id]) {
+      // @ts-expect-error untyped
       head.hooks.hook('script:updated', (ctx) => {
         if (ctx.script.id !== instance.id)
           return
@@ -79,6 +78,7 @@ export function useScript<T extends Record<symbol | string, any> = Record<symbol
         payload.$script = instance
         syncScripts()
       })
+      // @ts-expect-error untyped
       head.hooks.hook('script:instance-fn', (ctx) => {
         if (ctx.script.id !== instance.id || String(ctx.fn).startsWith('__v_'))
           return
@@ -100,5 +100,5 @@ export function useScript<T extends Record<symbol | string, any> = Record<symbol
       syncScripts()
     }
   }
-  return instance as any as UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T, U>, T>>
+  return instance as any as UseScriptContext<UseFunctionType<NuxtUseScriptOptions<T>, T>>
 }
diff --git a/src/runtime/registry/google-analytics.ts b/src/runtime/registry/google-analytics.ts
@@ -42,7 +42,6 @@ export function useScriptGoogleAnalytics<T extends GoogleAnalyticsApi>(_options?
           gtag,
         }
       },
-      stub: import.meta.client ? undefined : ({ fn }) => { return fn === 'dataLayer' ? [] : void 0 },
       performanceMarkFeature: 'nuxt-third-parties-ga',
       tagPriority: 1,
     },
diff --git a/src/runtime/registry/google-tag-manager.ts b/src/runtime/registry/google-tag-manager.ts
@@ -51,7 +51,6 @@ export function useScriptGoogleTagManager<T extends GoogleTagManagerApi>(_option
       use: () => {
         return { dataLayer: (window as any)[options.l ?? 'dataLayer'] as DataLayer, google_tag_manager: window.google_tag_manager }
       },
-      stub: import.meta.client ? undefined : ({ fn }) => { return fn === 'dataLayer' ? [] : void 0 },
       performanceMarkFeature: 'nuxt-third-parties-gtm',
       tagPriority: 1,
     },
diff --git a/src/runtime/registry/matomo-analytics.ts b/src/runtime/registry/matomo-analytics.ts
@@ -38,12 +38,6 @@ export function useScriptMatomoAnalytics<T extends MatomoAnalyticsApi>(_options?
         use() {
           return { _paq: window._paq }
         },
-        // allow _paq to be accessed on the server
-        stub: import.meta.client
-          ? undefined
-          : ({ fn }) => {
-              return fn === '_paq' ? [] : undefined
-            },
       },
       clientInit: import.meta.server
         ? undefined
diff --git a/src/runtime/registry/segment.ts b/src/runtime/registry/segment.ts
@@ -69,21 +69,6 @@ export function useScriptSegment<T extends SegmentApi>(_options?: SegmentInput)
           },
       schema: import.meta.dev ? SegmentOptions : undefined,
       scriptOptions: {
-        stub: import.meta.server
-          // ensure ssr works
-          ? ({ fn }) => {
-              if (fn === 'analytics') {
-                return {
-                  track: () => {},
-                  page: () => {},
-                  identify: () => {},
-                  group: () => {},
-                  alias: () => {},
-                  reset: () => {},
-                }
-              }
-            }
-          : undefined,
         use() {
           return methods.reduce((acc, key) => {
             // @ts-expect-error untyped
diff --git a/src/runtime/types.ts b/src/runtime/types.ts
@@ -47,14 +47,14 @@ export type UseScriptContext<T extends Record<symbol | string, any>> =
     _warmupEl?: void | ActiveHeadEntry<any>
   }
 
-export type NuxtUseScriptOptions<T extends Record<symbol | string, any> = {}, U = {}> = Omit<UseScriptOptions<T, U>, 'trigger'> & {
+export type NuxtUseScriptOptions<T extends Record<symbol | string, any> = {}> = Omit<UseScriptOptions<T>, 'trigger'> & {
   /**
    * The trigger to load the script:
    * - `onNuxtReady` - Load the script when Nuxt is ready.
    * - `manual` - Load the script manually by calling `load()`.
    * - `Promise` - Load the script when the promise resolves.
    */
-  trigger?: UseScriptOptions<T, U>['trigger'] | 'onNuxtReady'
+  trigger?: UseScriptOptions<T>['trigger'] | 'onNuxtReady'
   /**
    * Should the script be bundled as an asset and loaded from your server. This is useful for improving the
    * performance by avoiding the extra DNS lookup and reducing the number of requests. It also
diff --git a/src/runtime/unhead-v1/useScript.ts b/src/runtime/unhead-v1/useScript.ts
diff --git a/src/runtime/utils.ts b/src/runtime/utils.ts
diff --git a/test/fixtures/basic/__runtime__/warmup.nuxt.test.ts b/test/fixtures/basic/__runtime__/warmup.nuxt.test.ts

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,6 @@`
`24`	`24`	`"@vueuse/nuxt": "^12.8.2",`
`25`	`25`	`"nuxt-content-twoslash": "^0.1.2",`
`26`	`26`	`"nuxt-llms": "^0.1.0",`
`27`		`- "shiki": "^2.5.0"`
	`27`	`+ "shiki": "^3.1.0"`
`28`	`28`	`}`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,6 @@ export function useScriptGoogleAnalytics<T extends GoogleAnalyticsApi>(_options?`
`42`	`42`	`gtag,`
`43`	`43`	`}`
`44`	`44`	`},`
`45`		`- stub: import.meta.client ? undefined : ({ fn }) => { return fn === 'dataLayer' ? [] : void 0 },`
`46`	`45`	`performanceMarkFeature: 'nuxt-third-parties-ga',`
`47`	`46`	`tagPriority: 1,`
`48`	`47`	`},`