fix: Nuxt 4 type compatibility

Author: dargmuesli

docs/content/4.releases/4.v5.md

@@ -22,10 +22,10 @@ The v4 of Nuxt Robots provided a backward compatibility `rules` config. As it wa
 
 ```diff
 export default defineNuxtConfig({
-	robots: {
--    	rules: {},
-+    	groups: {}
-	}
+    robots: {
+-       rules: {},
++       groups: {}
+  }
 })
 ```
 

src/kit.ts

@@ -1,37 +1,9 @@
 import type { Nuxt } from '@nuxt/schema'
 import type { NitroConfig } from 'nitropack'
 import type { NuxtModule } from 'nuxt/schema'
-import { addTemplate, createResolver, loadNuxtModuleInstance, useNuxt } from '@nuxt/kit'
-import { relative } from 'pathe'
+import { loadNuxtModuleInstance, useNuxt } from '@nuxt/kit'
 import { env, provider } from 'std-env'
 
-export function extendTypes(module: string, template: (options: { typesPath: string }) => string | Promise<string>) {
-  const nuxt = useNuxt()
-  const { resolve } = createResolver(import.meta.url)
-  // paths.d.ts
-  addTemplate({
-    filename: `module/${module}.d.ts`,
-    getContents: async () => {
-      const typesPath = relative(resolve(nuxt!.options.rootDir, nuxt!.options.buildDir, 'module'), resolve('runtime/types'))
-      const s = await template({ typesPath })
-      return `// Generated by ${module}
-${s}
-export {}
-`
-    },
-  })
-
-  nuxt.hooks.hook('prepare:types', ({ references }) => {
-    references.push({ path: resolve(nuxt.options.buildDir, `module/${module}.d.ts`) })
-  })
-  nuxt.hooks.hook('nitro:config', (config) => {
-    config.typescript = config.typescript || {}
-    config.typescript.tsConfig = config.typescript.tsConfig || {}
-    config.typescript.tsConfig.include = config.typescript.tsConfig.include || []
-    config.typescript.tsConfig.include.push(`./module/${module}.d.ts`)
-  })
-}
-
 const autodetectableProviders = {
   azure_static: 'azure',
   cloudflare_pages: 'cloudflare-pages',

src/module.ts

@@ -6,6 +6,7 @@ import {
   addServerHandler,
   addServerImportsDir,
   addServerPlugin,
+  addTypeTemplate,
   createResolver,
   defineNuxtModule,
   hasNuxtModule,
@@ -19,11 +20,13 @@ import { withoutTrailingSlash, withTrailingSlash } from 'ufo'
 import { AiBots, NonHelpfulBots } from './const'
 import { setupDevToolsUI } from './devtools'
 import { resolveI18nConfig, splitPathForI18nLocales } from './i18n'
-import { extendTypes, isNuxtGenerate, resolveNitroPreset } from './kit'
+import { isNuxtGenerate, resolveNitroPreset } from './kit'
 import { logger } from './logger'
 import {
-  asArray,
   normaliseRobotsRouteRule,
+} from './runtime/server/nitro'
+import {
+  asArray,
   normalizeGroup,
   parseRobotsTxt,
   validateRobots,
@@ -461,8 +464,40 @@ export default defineNuxtModule<ModuleOptions>({
       }
     })
 
-    extendTypes('nuxt-robots', ({ typesPath }) => {
-      return `
+    addTypeTemplate({
+      filename: 'module/nuxt-robots.d.ts',
+      getContents: (data) => {
+        const typesPath = relative(resolve(data.nuxt!.options.rootDir, data.nuxt!.options.buildDir, 'module'), resolve('runtime/types'))
+        return `// Generated by nuxt-robots
+
+import type { RobotsContext } from '#robots/types'
+
+declare module 'nitropack/types' {
+  interface NitroApp {
+    _robots: {
+      ctx: import('${typesPath}').HookRobotsConfigContext
+      nuxtContentUrls?: Set<string>
+    },
+    _robotsRuleMatcher: (url: string) => string
+  }
+  interface NitroRouteRules {
+    robots?: boolean | string | {
+      indexable: boolean
+      rule: string
+    }
+  }
+  interface NitroRouteConfig {
+    robots?: boolean | string | {
+      indexable: boolean
+      rule: string
+    }
+  }
+  interface NitroRuntimeHooks {
+    'robots:config': (ctx: import('${typesPath}').HookRobotsConfigContext) => void | Promise<void>
+    'robots:robots-txt': (ctx: import('${typesPath}').HookRobotsTxtContext) => void | Promise<void>
+  }
+}
+
 declare module 'nitropack' {
   interface NitroApp {
     _robots: {
@@ -488,13 +523,18 @@ declare module 'nitropack' {
     'robots:robots-txt': (ctx: import('${typesPath}').HookRobotsTxtContext) => void | Promise<void>
   }
 }
+
 declare module 'h3' {
-  import type { RobotsContext } from '#robots/types'
   interface H3EventContext {
     robots: RobotsContext
   }
 }
+
+export {}
 `
+      },
+    }, {
+      nitro: true,
     })
 
     // only prerender for `nuxi generate`

src/runtime/server/composables/getPathRobotConfig.ts

@@ -3,8 +3,9 @@ import type { RobotsContext } from '../../types'
 import { getRequestHeader } from 'h3'
 import { useNitroApp, useRuntimeConfig } from 'nitropack/runtime'
 import { withoutTrailingSlash } from 'ufo'
-import { matchPathToRule, normaliseRobotsRouteRule } from '../../util'
+import { matchPathToRule } from '../../util'
 import { createNitroRouteRuleMatcher } from '../kit'
+import { normaliseRobotsRouteRule } from '../nitro'
 import { getSiteRobotConfig } from './getSiteRobotConfig'
 
 export function getPathRobotConfig(e: H3Event, options?: { userAgent?: string, skipSiteIndexable?: boolean, path?: string }): RobotsContext {

src/runtime/server/nitro.ts

@@ -0,0 +1,24 @@
+import type { NitroRouteConfig } from 'nitropack/types'
+
+export function normaliseRobotsRouteRule(config: NitroRouteConfig) {
+  // parse allow
+  let allow: boolean | undefined
+  if (typeof config.robots === 'boolean')
+    allow = config.robots
+  else if (typeof config.robots === 'object' && typeof config.robots.indexable !== 'undefined')
+    allow = config.robots.indexable
+  // parse rule
+  let rule: string | undefined
+  if (typeof config.robots === 'object' && typeof config.robots.rule !== 'undefined')
+    rule = config.robots.rule
+  else if (typeof config.robots === 'string')
+    rule = config.robots
+  if (rule && !allow)
+    allow = rule !== 'none' && !rule.includes('noindex')
+  if (typeof allow === 'undefined' && typeof rule === 'undefined')
+    return
+  return {
+    allow,
+    rule,
+  }
+}

src/util.ts

@@ -1,4 +1,3 @@
-import type { NitroRouteConfig } from 'nitropack'
 import type { ParsedRobotsTxt, RobotsGroupInput, RobotsGroupResolved } from './runtime/types'
 import { createDefu } from 'defu'
 import { withoutLeadingSlash } from 'ufo'
@@ -284,26 +283,3 @@ export function isInternalRoute(_path: string) {
   const lastSegment = path.split('/').pop() || path
   return lastSegment.includes('.') || path.startsWith('@')
 }
-
-export function normaliseRobotsRouteRule(config: NitroRouteConfig) {
-  // parse allow
-  let allow: boolean | undefined
-  if (typeof config.robots === 'boolean')
-    allow = config.robots
-  else if (typeof config.robots === 'object' && typeof config.robots.indexable !== 'undefined')
-    allow = config.robots.indexable
-  // parse rule
-  let rule: string | undefined
-  if (typeof config.robots === 'object' && typeof config.robots.rule !== 'undefined')
-    rule = config.robots.rule
-  else if (typeof config.robots === 'string')
-    rule = config.robots
-  if (rule && !allow)
-    allow = rule !== 'none' && !rule.includes('noindex')
-  if (typeof allow === 'undefined' && typeof rule === 'undefined')
-    return
-  return {
-    allow,
-    rule,
-  }
-}