fix: support Nuxt 5 and Nitro 3 runtimes (#311)

Author: harlan-zw

devtools/lib/robots/state.ts

@@ -53,7 +53,10 @@ export async function refreshProductionData() {
   // Try full debug endpoint first (requires debug: true in production)
   const remoteDebug: ProductionDebugResponse | null = await appFetch.value('/__robots__/debug-production.json', {
     query: { url: productionUrl.value, mode: 'debug' },
-  }).catch(() => null)
+  }).catch(() => {
+    // Production sites may disable the debug route; the public endpoint below is the fallback.
+    return null
+  })
   if (remoteDebug && !remoteDebug.error && remoteDebug.hasRemoteDebug) {
     productionData.value = remoteDebug
     productionLoading.value = false

package.json

@@ -55,7 +55,8 @@
     "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build && nuxt prepare playground && pnpm run client:build",
     "release": "pnpm build && bumpp -x \"npx changelogen --output=CHANGELOG.md\"",
     "prepack": "pnpm run build",
-    "test": "pnpm run prepare:fixtures && vitest",
+    "test": "pnpm run prepare:fixtures && vitest && pnpm run test:attw && pnpm run test:nuxt5",
+    "test:nuxt5": "pnpm pack --out test/fixtures/nuxt5/module.tgz && pnpm --dir test/fixtures/nuxt5 install --frozen-lockfile && pnpm --dir test/fixtures/nuxt5 test",
     "typecheck": "nuxt typecheck",
     "test:attw": "attw --pack"
   },
@@ -75,6 +76,7 @@
     "h3": "catalog:",
     "nuxt-site-config": "catalog:",
     "nuxtseo-shared": "catalog:",
+    "ofetch": "catalog:",
     "pathe": "catalog:",
     "pkg-types": "catalog:",
     "ufo": "catalog:"

pnpm-lock.yaml

@@ -14,9 +14,9 @@ minimumReleaseAgeExclude:
   - '@vue/server-renderer@3.5.38'
   - '@vue/shared@3.5.38'
   - vue@3.5.38
-  - nuxt-site-config-kit@4.1.1
-  - nuxt-site-config@4.1.1
-  - site-config-stack@4.1.1
+  - nuxt-site-config-kit@4.1.4
+  - nuxt-site-config@4.1.4
+  - site-config-stack@4.1.4
   - '@nuxt/kit@4.5.0'
   - '@nuxt/nitro-server@4.5.0'
   - '@nuxt/schema@4.5.0'
@@ -59,9 +59,10 @@ catalog:
   h3: ^1.15.11
   happy-dom: ^20.10.6
   nuxt: ^4.5.0
-  nuxt-site-config: ^4.1.1
+  nuxt-site-config: ^4.1.4
   nuxtseo-layer-devtools: ^5.3.2
-  nuxtseo-shared: ^5.3.6
+  nuxtseo-shared: ^5.3.8
+  ofetch: ^1.5.1
   pathe: ^2.0.3
   pkg-types: ^2.3.1
   radix3: ^1.1.2

pnpm-workspace.yaml

@@ -13,9 +13,10 @@ import {
   defineNuxtModule,
   extendRouteRules,
   hasNuxtModule,
+  resolveModule,
 } from '@nuxt/kit'
 import { installNuxtSiteConfig, updateSiteConfig } from 'nuxt-site-config/kit'
-import { useModuleLogger } from 'nuxtseo-shared/kit'
+import { setupNitroRuntimeCompatibility, useModuleLogger } from 'nuxtseo-shared/kit'
 import { relative } from 'pathe'
 import { readPackageJSON } from 'pkg-types'
 import { withoutTrailingSlash, withTrailingSlash } from 'ufo'
@@ -40,6 +41,7 @@ export type {
   HookRobotsTxtContext,
   PatternMapValue,
   RobotsContext,
+  RobotsRouteRuleConfig,
   RobotsValue,
 } from './runtime/types'
 
@@ -254,6 +256,8 @@ export default defineNuxtModule<ModuleOptions>({
       nuxt.options.nitro.alias['#internal/nuxt-robots'] = resolve('./runtime/server/mock-composables')
       return
     }
+    const nitroCompatibility = setupNitroRuntimeCompatibility(nuxt)
+    nuxt.options.nitro.alias!.ofetch ||= resolveModule('ofetch', { url: new URL(import.meta.url) })
 
     // Allow `definePageMeta({ robots: false })` to set per-page robots rules
     nuxt.options.experimental.extraPageMetaExtractionKeys = nuxt.options.experimental.extraPageMetaExtractionKeys || []
@@ -535,7 +539,7 @@ export default defineNuxtModule<ModuleOptions>({
       nuxt.options.runtimeConfig.public['nuxt-robots'] = robotsRuntimeConfig as any
     })
 
-    registerTypeTemplates({ nuxt, config })
+    registerTypeTemplates({ nitroCompatibility })
 
     // only prerender for `nuxi generate`
     const isFirebase = nitroPreset === 'firebase'

src/module.ts

@@ -1,7 +1,7 @@
-import type { H3Event } from 'h3'
+import type { H3Event } from '#nuxtseo/h3'
 import { getBotDetection as getBotDetectionFromHeaders, getBotInfo as getBotInfoFromHeaders, isBot as isBotFromHeaders } from '@nuxtjs/robots/util'
-import { getHeaders } from 'h3'
-import { useNitroApp } from 'nitropack/runtime'
+import { getHeaders } from '#nuxtseo/h3'
+import { useNitroApp } from '#nuxtseo/nitro'
 
 // Re-export the interface from util
 export type { BotDetectionContext } from '@nuxtjs/robots/util'

src/runtime/server/composables/getBotDetection.ts

@@ -1,13 +1,18 @@
-import type { H3Event } from 'h3'
-import type { RobotsContext } from '../../types'
+import type { H3Event } from '#nuxtseo/h3'
+import type { RobotsContext, RobotsValue } from '../../types'
 import { matchPathToRule, normaliseRobotsRouteRule } from '@nuxtjs/robots/util'
-import { getRequestHeader } from 'h3'
-import { useNitroApp, useRuntimeConfig } from 'nitropack/runtime'
 import { createNitroRouteRuleMatcher } from 'nuxtseo-shared/server'
 import { withoutTrailingSlash } from 'ufo'
+import { getRequestHeader } from '#nuxtseo/h3'
+import { useNitroApp, useRuntimeConfig } from '#nuxtseo/nitro'
 import { getSiteRobotConfig } from './getSiteRobotConfig'
 import { useRuntimeConfigNuxtRobots } from './useRuntimeConfigNuxtRobots'
 
+interface RobotsRouteRules {
+  robots?: RobotsValue | { indexable: boolean, rule: string }
+  ssr?: boolean
+}
+
 export function getPathRobotConfig(e: H3Event, options?: { userAgent?: string, skipSiteIndexable?: boolean, path?: string }): RobotsContext {
   const runtimeConfig = useRuntimeConfig(e)
   // has already been resolved
@@ -109,7 +114,7 @@ export function getPathRobotConfig(e: H3Event, options?: { userAgent?: string, s
   }
 
   // 4. nitro route rules
-  nitroApp._robotsRuleMatcher = nitroApp._robotsRuleMatcher || createNitroRouteRuleMatcher(runtimeConfig)
+  nitroApp._robotsRuleMatcher = nitroApp._robotsRuleMatcher || createNitroRouteRuleMatcher<RobotsRouteRules>(runtimeConfig)
   let robotRouteRules = nitroApp._robotsRuleMatcher(path)
   let routeRulesPath = path
   // if we're using i18n we need to strip leading prefixes so the rule will match

src/runtime/server/composables/getPathRobotConfig.ts

@@ -1,6 +1,6 @@
-import type { H3Event } from 'h3'
+import type { H3Event } from '#nuxtseo/h3'
 import type { ParsedRobotsTxt } from '../../types'
-import { getQuery } from 'h3'
+import { getQuery } from '#nuxtseo/h3'
 import { getSiteConfig } from '#site-config/server/composables'
 import { getSiteIndexable } from '#site-config/server/composables/getSiteIndexable'
 import { useRuntimeConfigNuxtRobots } from './useRuntimeConfigNuxtRobots'

src/runtime/server/composables/getSiteRobotConfig.ts

@@ -1,6 +1,6 @@
-import type { H3Event } from 'h3'
+import type { H3Event } from '#nuxtseo/h3'
 import type { NuxtRobotsRuntimeConfig } from '../../types'
-import { useRuntimeConfig } from 'nitropack/runtime'
+import { useRuntimeConfig } from '#nuxtseo/nitro'
 
 export function useRuntimeConfigNuxtRobots(event?: H3Event): NuxtRobotsRuntimeConfig {
   return useRuntimeConfig(event)['nuxt-robots'] as NuxtRobotsRuntimeConfig

src/runtime/server/composables/useRuntimeConfigNuxtRobots.ts

@@ -1,4 +1,4 @@
-import { defineEventHandler, getQuery, setHeader } from 'h3'
+import { defineEventHandler, getQuery, setHeader } from '#nuxtseo/h3'
 import { getPathRobotConfig } from '../composables/getPathRobotConfig'
 import { useRuntimeConfigNuxtRobots } from '../composables/useRuntimeConfigNuxtRobots'