feat: support Nuxt 5

src/features/llms/module.ts

@@ -1,5 +1,5 @@
 import defu from 'defu'
-import { createResolver, defineNuxtModule, addTypeTemplate, addServerPlugin, addServerHandler } from '@nuxt/kit'
+import { createResolver, defineNuxtModule, addTypeTemplate, addNitroPlugin, addServerHandler } from '@nuxt/kit'
 
 export default defineNuxtModule({
   meta: {
@@ -9,7 +9,10 @@ export default defineNuxtModule({
   setup(_opts, nuxt) {
     const { resolve } = createResolver(import.meta.url)
 
-    addServerPlugin(resolve('runtime/server/content-llms.plugin'))
+    addNitroPlugin({
+      nitro3: resolve('runtime/server/content-llms.plugin'),
+      nitro2: resolve('runtime/server/content-llms.plugin.legacy'),
+    })
 
     // This module is installed at `modules:done`, every module has had a chance to set `llms.contentRawMarkdown` by now
     const llmsOption = (nuxt.options as unknown as { llms?: { contentRawMarkdown?: false | { excludeCollections?: string[] } } }).llms
@@ -20,7 +23,13 @@ export default defineNuxtModule({
         })
 
     if (contentRawMarkdown !== false) {
-      addServerHandler({ route: '/raw/**:slug.md', handler: resolve('runtime/server/routes/raw/[...slug].md.get') })
+      addServerHandler({
+        route: '/raw/**:slug.md',
+        handler: {
+          nuxt: resolve('runtime/server/routes/raw/[...slug].md.get'),
+          nitro2: resolve('runtime/server/routes/raw/[...slug].md.get.legacy'),
+        },
+      })
     }
 
     // @ts-expect-error -- TODO: fix types

src/features/llms/runtime/server/content-llms.plugin.legacy.ts

@@ -0,0 +1,17 @@
+import { appendHeader } from 'h3'
+import type { NitroApp } from 'nitropack/types'
+import { defineNitroPlugin } from 'nitropack/runtime'
+import { registerContentLLMSHooks } from './content-llms'
+import type { ContentLLMSHooks } from './content-llms'
+
+export default defineNitroPlugin((nitroApp: NitroApp) => {
+  const prerenderPaths = registerContentLLMSHooks(nitroApp.hooks as unknown as ContentLLMSHooks)
+
+  if (['nitro-prerender', 'nitro-dev'].includes(import.meta.preset as string)) {
+    nitroApp.hooks.hook('beforeResponse', (event) => {
+      if (event.path === '/') {
+        appendHeader(event, 'x-nitro-prerender', Array.from(prerenderPaths))
+      }
+    })
+  }
+})

src/features/llms/runtime/server/content-llms.plugin.ts

@@ -1,110 +1,22 @@
-import { appendHeader } from 'h3'
-import { withBase } from 'ufo'
-import type { NitroApp } from 'nitropack/types'
-import type { ContentLLMSCollectionSection } from './utils'
-import { createDocumentGenerator, prepareContentSections } from './utils'
-import type { PageCollectionItemBase } from '@nuxt/content'
-import { defineNitroPlugin } from 'nitropack/runtime'
-// @ts-expect-error - typecheck does not detect queryCollection in imports
-import { queryCollection } from '#imports'
-import type { ModuleOptions } from 'nuxt-llms'
+import { useRuntimeConfig } from 'nuxt/server'
+import { withoutBase } from 'ufo'
+import { registerContentLLMSHooks } from './content-llms'
+import type { ContentLLMSHooks } from './content-llms'
 
-export default defineNitroPlugin((nitroApp: NitroApp) => {
-  const prerenderPaths = new Set<string>()
-  nitroApp.hooks.hook('llms:generate', async (event, options) => {
-    prepareContentSections(options.sections)
+interface NitroApp {
+  hooks: ContentLLMSHooks
+}
 
-    const sectionsToRemove = [] as string[]
-    for (const index in options.sections) {
-      const section = options.sections[index] as ContentLLMSCollectionSection
-      if (!section.contentCollection) {
-        continue
-      }
-
-      const query = queryCollection(event, section.contentCollection)
-        .select('path', 'title', 'seo', 'description')
-        .where('path', 'NOT LIKE', '%/.navigation')
-
-      const filters = section.contentFilters || []
-      for (const filter of filters) {
-        query.where(filter.field, filter.operator, filter.value)
-      }
-
-      const docs = await query.all() as PageCollectionItemBase[]
-
-      if (docs.length === 0 && section.__nuxt_content_auto_generate) {
-        sectionsToRemove.push(index)
-        continue
-      }
-
-      section.links ||= []
-      section.links.push(...docs.map((doc) => {
-        return {
-          title: doc.title || doc?.seo?.title || '',
-          description: doc.description || doc?.seo?.description || '',
-          href: getDocumentLink(doc.path, section.contentCollection!, options),
-        }
-      }))
-    }
-
-    // Delete emoty auto generated sections
-    sectionsToRemove.reverse().forEach((index) => {
-      options.sections.splice(Number(index), 1)
-    })
-  })
-
-  nitroApp.hooks.hook('llms:generate:full', async (event, options, contents) => {
-    prepareContentSections(options.sections)
-
-    const generateDocument = await createDocumentGenerator()
-    for (const index in options.sections) {
-      const section = options.sections[index] as ContentLLMSCollectionSection
-      if (!section.contentCollection) {
-        // Ignore non content sections
-        continue
-      }
-
-      const query = queryCollection(event, section.contentCollection)
-        .where('path', 'NOT LIKE', '%/.navigation')
-
-      const filters = section.contentFilters || []
-      for (const filter of filters) {
-        query.where(filter.field, filter.operator, filter.value)
-      }
-
-      const docs = await query.all()
-
-      for (const doc of docs) {
-        // @ts-expect-error -- TODO: fix types
-        await nitroApp.hooks.callHook('content:llms:generate:document', event, doc, options)
-        const markdown = await generateDocument(doc, options)
-        contents.push(markdown!)
-      }
-    }
-  })
+// Nitro 3 plugin, `definePlugin` from `nitro` only returns the function it is given
+export default (nitroApp: NitroApp) => {
+  const prerenderPaths = registerContentLLMSHooks(nitroApp.hooks)
 
   if (['nitro-prerender', 'nitro-dev'].includes(import.meta.preset as string)) {
-    nitroApp.hooks.hook('beforeResponse', (event) => {
-      if (event.path === '/') {
-        appendHeader(event, 'x-nitro-prerender', Array.from(prerenderPaths))
+    nitroApp.hooks.hook('response', (response: Response, event: { req: Request }) => {
+      const path = withoutBase(new URL(event.req.url).pathname, useRuntimeConfig().app.baseURL)
+      if (path === '/' && prerenderPaths.size) {
+        response.headers.append('x-nitro-prerender', Array.from(prerenderPaths).join(', '))
       }
     })
   }
-
-  function getDocumentLink(link: string, collection: string, options: ModuleOptions) {
-    const contentRawMarkdown = (options as unknown as { contentRawMarkdown: false | { rewriteLLMSTxt: boolean, excludeCollections: string[] } })?.contentRawMarkdown
-    if (contentRawMarkdown === false || contentRawMarkdown?.rewriteLLMSTxt === false || contentRawMarkdown?.excludeCollections?.includes(collection)) {
-      return withBase(link, options.domain)
-    }
-
-    link = `/raw${link}.md`
-
-    if (link.endsWith('/.md')) {
-      link = link.slice(0, -3) + 'index.md'
-    }
-
-    prerenderPaths.add(link)
-
-    return withBase(link, options.domain)
-  }
-})
+}

src/features/llms/runtime/server/content-llms.ts

@@ -0,0 +1,109 @@
+import { withBase } from 'ufo'
+import { queryCollection } from '../../../../runtime/server'
+import type { ModuleOptions } from 'nuxt-llms'
+import type { Collections, PageCollectionItemBase } from '@nuxt/content'
+import type { ContentEvent } from '../../../../runtime/internal/event'
+import type { ContentLLMSCollectionSection } from './utils'
+import { createDocumentGenerator, prepareContentSections } from './utils'
+
+export interface ContentLLMSHooks {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  hook: (name: string, fn: (...args: any[]) => unknown) => unknown
+  callHook: (name: string, ...args: unknown[]) => unknown
+}
+
+/**
+ * Add the content collections to the `llms.txt` sections, and return the raw markdown paths to prerender.
+ */
+export function registerContentLLMSHooks(hooks: ContentLLMSHooks) {
+  const prerenderPaths = new Set<string>()
+  hooks.hook('llms:generate', async (event: ContentEvent, options: ModuleOptions) => {
+    prepareContentSections(options.sections)
+
+    const sectionsToRemove = [] as string[]
+    for (const index in options.sections) {
+      const section = options.sections[index] as ContentLLMSCollectionSection
+      if (!section.contentCollection) {
+        continue
+      }
+
+      const query = queryCollection(event, section.contentCollection as keyof Collections)
+        .select('path', 'title', 'seo', 'description')
+        .where('path', 'NOT LIKE', '%/.navigation')
+
+      const filters = section.contentFilters || []
+      for (const filter of filters) {
+        query.where(filter.field, filter.operator, filter.value)
+      }
+
+      const docs = await query.all() as unknown as PageCollectionItemBase[]
+
+      if (docs.length === 0 && section.__nuxt_content_auto_generate) {
+        sectionsToRemove.push(index)
+        continue
+      }
+
+      section.links ||= []
+      section.links.push(...docs.map((doc) => {
+        return {
+          title: doc.title || doc?.seo?.title || '',
+          description: doc.description || doc?.seo?.description || '',
+          href: getDocumentLink(doc.path, section.contentCollection!, options),
+        }
+      }))
+    }
+
+    // Delete emoty auto generated sections
+    sectionsToRemove.reverse().forEach((index) => {
+      options.sections.splice(Number(index), 1)
+    })
+  })
+
+  hooks.hook('llms:generate:full', async (event: ContentEvent, options: ModuleOptions, contents: string[]) => {
+    prepareContentSections(options.sections)
+
+    const generateDocument = await createDocumentGenerator()
+    for (const index in options.sections) {
+      const section = options.sections[index] as ContentLLMSCollectionSection
+      if (!section.contentCollection) {
+        // Ignore non content sections
+        continue
+      }
+
+      const query = queryCollection(event, section.contentCollection as keyof Collections)
+        .where('path', 'NOT LIKE', '%/.navigation')
+
+      const filters = section.contentFilters || []
+      for (const filter of filters) {
+        query.where(filter.field, filter.operator, filter.value)
+      }
+
+      const docs = await query.all() as PageCollectionItemBase[]
+
+      for (const doc of docs) {
+        await hooks.callHook('content:llms:generate:document', event, doc, options)
+        const markdown = await generateDocument(doc, options)
+        contents.push(markdown!)
+      }
+    }
+  })
+
+  function getDocumentLink(link: string, collection: string, options: ModuleOptions) {
+    const contentRawMarkdown = (options as unknown as { contentRawMarkdown: false | { rewriteLLMSTxt: boolean, excludeCollections: string[] } })?.contentRawMarkdown
+    if (contentRawMarkdown === false || contentRawMarkdown?.rewriteLLMSTxt === false || contentRawMarkdown?.excludeCollections?.includes(collection)) {
+      return withBase(link, options.domain)
+    }
+
+    link = `/raw${link}.md`
+
+    if (link.endsWith('/.md')) {
+      link = link.slice(0, -3) + 'index.md'
+    }
+
+    prerenderPaths.add(link)
+
+    return withBase(link, options.domain)
+  }
+
+  return prerenderPaths
+}

src/features/llms/runtime/server/raw-markdown.ts

@@ -0,0 +1,62 @@
+import { withLeadingSlash } from 'ufo'
+import { stringify } from 'minimark/stringify'
+import { queryCollection } from '../../../../runtime/server'
+import type { Collections, PageCollectionItemBase, ResolvedCollection } from '@nuxt/content'
+import type { MinimarkNode } from '../../../../types/tree'
+import type { ContentEvent } from '../../../../runtime/internal/event'
+import collections from '#content/manifest'
+
+export interface ContentRawMarkdownConfig {
+  contentRawMarkdown: false | { excludeCollections: string[] }
+}
+
+/**
+ * The raw markdown of the page a `/raw/<path>.md` slug points to, or `undefined` when there is none.
+ */
+export async function getRawMarkdown(event: ContentEvent, slug: string | undefined, llmsConfig: ContentRawMarkdownConfig | undefined) {
+  if (!slug?.endsWith('.md') || llmsConfig?.contentRawMarkdown === false) {
+    return
+  }
+
+  let path = withLeadingSlash(slug.replace('.md', ''))
+  if (path.endsWith('/index')) {
+    path = path.substring(0, path.length - 6)
+  }
+
+  const excludeCollections = llmsConfig?.contentRawMarkdown?.excludeCollections || []
+  const _collections = Object.entries(collections as Record<string, ResolvedCollection>)
+    .filter(([_key, value]) => value.type === 'page' && !excludeCollections.includes(_key))
+    .map(([key]) => key) as string[]
+
+  let page: PageCollectionItemBase | null = null
+  for (const collection of _collections) {
+    page = await queryCollection(event, collection as keyof Collections).path(path).first() as PageCollectionItemBase | null
+    if (page) {
+      break
+    }
+  }
+
+  if (!page) {
+    return
+  }
+
+  // Add title and description to the top of the page if missing
+  if (page.body.value[0]?.[0] !== 'h1') {
+    page.body.value.unshift(['blockquote', {}, page.description])
+    page.body.value.unshift(['h1', {}, page.title])
+  }
+
+  // Append related links at the end if present
+  const links = (page as unknown as Record<string, unknown>).links || (page.meta as Record<string, unknown>)?.links
+  if (Array.isArray(links) && links.length > 0) {
+    const linkItems = links
+      .filter((link: { label?: string, to?: string }) => link.label && link.to)
+      .map((link: { label: string, to: string }) => ['li', {}, ['a', { href: link.to }, link.label]])
+    if (linkItems.length > 0) {
+      page.body.value.push(['hr'] as unknown as MinimarkNode)
+      page.body.value.push(['ul', {}, ...linkItems] as unknown as MinimarkNode)
+    }
+  }
+
+  return stringify({ ...page.body, type: 'minimark' }, { format: 'markdown/html' })
+}

src/features/llms/runtime/server/routes/raw/[...slug].md.get.legacy.ts

@@ -0,0 +1,15 @@
+import { getRouterParams, eventHandler, createError, setHeader } from 'h3'
+import { useRuntimeConfig } from 'nitropack/runtime'
+import { getRawMarkdown } from '../../raw-markdown'
+import type { ContentRawMarkdownConfig } from '../../raw-markdown'
+
+export default eventHandler(async (event) => {
+  const config = useRuntimeConfig(event)
+  const markdown = await getRawMarkdown(event, getRouterParams(event)['slug.md'], config.llms as ContentRawMarkdownConfig)
+  if (markdown === undefined) {
+    throw createError({ statusCode: 404, statusMessage: 'Page not found', fatal: true })
+  }
+
+  setHeader(event, 'Content-Type', 'text/markdown; charset=utf-8')
+  return markdown
+})