nuxt-llms 0.1.4 → 0.3.0

package/README.md

@@ -87,6 +87,7 @@ That's it! You can visit `/llms.txt` to see the generated documentation ✨
 - `full`: The `llms-full.txt` configuration. Setting this option will enable the `llms-full.txt` route.
   - `title`: The title of the llms-full documentation
   - `description`: The description of the llms-full documentation
+- `prerender`: Whether to prerender `/llms.txt` (and `/llms-full.txt` when `full` is set) at build time. Defaults to `true`. Set it to `false` to serve them dynamically instead, for example when caching them with ISR.
 
 ## Documentation Formats
 
@@ -190,6 +191,8 @@ X-API-Key: <your-api-key>
 })
 ```
 
+On Nuxt 5, register the same hooks with `useServerHooks().hook()` from `nuxt/server`, which also types them.
+
 ### Using Hooks in Nuxt Modules
 
 If you're developing a Nuxt module that needs to extend the LLMs documentation:
@@ -269,5 +272,5 @@ Copyright (c) NuxtLabs
 [license-src]: https://img.shields.io/npm/l/nuxt-llms.svg?style=flat&colorA=020420&colorB=00DC82
 [license-href]: https://npmjs.com/package/nuxt-llms
 
-[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt
 [nuxt-href]: https://nuxt.com

package/dist/module.json

@@ -1,10 +1,10 @@
 {
   "name": "nuxt-llms",
   "configKey": "llms",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "docs": "https://github.com/nuxtlabs/nuxt-llms",
   "builder": {
-    "@nuxt/module-builder": "1.0.2",
+    "@nuxt/module-builder": "1.0.3",
     "unbuild": "3.6.1"
   }
 }

package/dist/module.mjs

@@ -1,6 +1,6 @@
 import { defineNuxtModule, useLogger, createResolver, addServerImports, addServerHandler, addPrerenderRoutes } from '@nuxt/kit';
 
-const version = "0.1.4";
+const version = "0.3.0";
 
 const module$1 = defineNuxtModule({
   meta: {
@@ -9,7 +9,9 @@ const module$1 = defineNuxtModule({
     version,
     docs: "https://github.com/nuxtlabs/nuxt-llms"
   },
-  defaults: {},
+  defaults: {
+    prerender: true
+  },
   setup(options, nuxt) {
     const logger = useLogger("nuxt-llms");
     const { resolve } = createResolver(import.meta.url);
@@ -24,9 +26,25 @@ const module$1 = defineNuxtModule({
       logger.warn("nuxt-llms require a domain to be set. `llms.domain` is missing.");
       return;
     }
-    addServerImports([{ name: "llmsHooks", from: resolve("./runtime/server/utils/hooks") }]);
-    addServerHandler({ route: "/llms.txt", handler: resolve("./runtime/server/routes/llms.txt.get") });
-    addPrerenderRoutes("/llms.txt");
+    addServerImports([
+      {
+        name: "llmsHooks",
+        from: {
+          nuxt: resolve("./runtime/server/utils/hooks"),
+          nitro2: resolve("./runtime/server/utils/hooks.legacy")
+        }
+      }
+    ]);
+    addServerHandler({
+      route: "/llms.txt",
+      handler: {
+        nuxt: resolve("./runtime/server/routes/llms.txt.get"),
+        nitro2: resolve("./runtime/server/routes/llms.txt.get.legacy")
+      }
+    });
+    if (options.prerender !== false) {
+      addPrerenderRoutes("/llms.txt");
+    }
     if (options.full) {
       llmsConfig.sections.unshift({
         title: "Documentation Sets",
@@ -38,8 +56,16 @@ const module$1 = defineNuxtModule({
           }
         ]
       });
-      addServerHandler({ route: "/llms-full.txt", handler: resolve("./runtime/server/routes/llms-full.txt.get") });
-      addPrerenderRoutes("/llms-full.txt");
+      addServerHandler({
+        route: "/llms-full.txt",
+        handler: {
+          nuxt: resolve("./runtime/server/routes/llms-full.txt.get"),
+          nitro2: resolve("./runtime/server/routes/llms-full.txt.get.legacy")
+        }
+      });
+      if (options.prerender !== false) {
+        addPrerenderRoutes("/llms-full.txt");
+      }
     }
   }
 });

package/dist/runtime/index.d.ts

@@ -1 +1 @@
-export * from './server/utils/hooks.js';
+export * from './server/utils/hooks.legacy.js';

package/dist/runtime/index.js

@@ -1 +1 @@
-export * from "./server/utils/hooks.js";
+export * from "./server/utils/hooks.legacy.js";

package/dist/runtime/server/routes/llms-full.txt.get.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string>>;
+declare const _default: import("nuxt/server").EventHandler<Promise<string>>;
 export default _default;

package/dist/runtime/server/routes/llms-full.txt.get.js

@@ -1,12 +1,11 @@
-import { eventHandler, setHeader } from "h3";
-import { llmsHooks } from "nuxt-llms/runtime";
-import { useRuntimeConfig, useNitroApp } from "#imports";
-export default eventHandler(async (event) => {
-  const options = useRuntimeConfig(event).llms;
+import { defineEventHandler, useRuntimeConfig, useServerHooks } from "nuxt/server";
+import { llmsHooks } from "../utils/hooks.js";
+export default defineEventHandler(async (event) => {
+  const options = useRuntimeConfig().llms;
   const contents = [];
   const llms = JSON.parse(JSON.stringify(options));
-  await useNitroApp().hooks.callHook("llms:generate:full", event, llms, contents);
+  await useServerHooks().callHook("llms:generate:full", event, llms, contents);
   await llmsHooks.callHook("generate:full", event, llms, contents);
-  setHeader(event, "Content-Type", "text/plain; charset=utf-8");
+  event.res.headers.set("Content-Type", "text/plain; charset=utf-8");
   return contents.join("\n\n");
 });

package/dist/runtime/server/routes/llms-full.txt.get.legacy.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string>>;
+export default _default;

package/dist/runtime/server/routes/llms-full.txt.get.legacy.js

@@ -0,0 +1,12 @@
+import { eventHandler, setHeader } from "h3";
+import { llmsHooks } from "nuxt-llms/runtime";
+import { useRuntimeConfig, useNitroApp } from "nitropack/runtime";
+export default eventHandler(async (event) => {
+  const options = useRuntimeConfig(event).llms;
+  const contents = [];
+  const llms = JSON.parse(JSON.stringify(options));
+  await useNitroApp().hooks.callHook("llms:generate:full", event, llms, contents);
+  await llmsHooks.callHook("generate:full", event, llms, contents);
+  setHeader(event, "Content-Type", "text/plain; charset=utf-8");
+  return contents.join("\n\n");
+});

package/dist/runtime/server/routes/llms.txt.get.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string>>;
+declare const _default: import("nuxt/server").EventHandler<Promise<string>>;
 export default _default;

package/dist/runtime/server/routes/llms.txt.get.js

@@ -1,14 +1,11 @@
-import { eventHandler, setHeader } from "h3";
-import { llmsHooks } from "nuxt-llms/runtime";
-import { useRuntimeConfig, useNitroApp } from "#imports";
-export default eventHandler(async (event) => {
-  const options = useRuntimeConfig(event).llms;
+import { defineEventHandler, useRuntimeConfig, useServerHooks } from "nuxt/server";
+import { llmsHooks } from "../utils/hooks.js";
+export default defineEventHandler(async (event) => {
+  const options = useRuntimeConfig().llms;
   const llms = JSON.parse(JSON.stringify(options));
-  await useNitroApp().hooks.callHook("llms:generate", event, llms);
+  await useServerHooks().callHook("llms:generate", event, llms);
   await llmsHooks.callHook("generate", event, llms);
-  const document = [
-    `# ${llms.title || "Documentation"}`
-  ];
+  const document = [`# ${llms.title || "Documentation"}`];
   if (llms.description) {
     document.push(`> ${llms.description}`);
   }
@@ -24,11 +21,8 @@ export default eventHandler(async (event) => {
     );
   }
   if (options.notes && options.notes.length) {
-    document.push(
-      "## Notes",
-      (options.notes || []).map((note) => `- ${note}`).join("\n")
-    );
+    document.push("## Notes", (options.notes || []).map((note) => `- ${note}`).join("\n"));
   }
-  setHeader(event, "Content-Type", "text/plain; charset=utf-8");
+  event.res.headers.set("Content-Type", "text/plain; charset=utf-8");
   return document.join("\n\n");
 });

package/dist/runtime/server/routes/llms.txt.get.legacy.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string>>;
+export default _default;

package/dist/runtime/server/routes/llms.txt.get.legacy.js

@@ -0,0 +1,29 @@
+import { eventHandler, setHeader } from "h3";
+import { llmsHooks } from "nuxt-llms/runtime";
+import { useRuntimeConfig, useNitroApp } from "nitropack/runtime";
+export default eventHandler(async (event) => {
+  const options = useRuntimeConfig(event).llms;
+  const llms = JSON.parse(JSON.stringify(options));
+  await useNitroApp().hooks.callHook("llms:generate", event, llms);
+  await llmsHooks.callHook("generate", event, llms);
+  const document = [`# ${llms.title || "Documentation"}`];
+  if (llms.description) {
+    document.push(`> ${llms.description}`);
+  }
+  for (const section of llms.sections) {
+    document.push(`## ${section.title}`);
+    if (section.description) {
+      document.push(section.description);
+    }
+    document.push(
+      section.links?.map((link) => {
+        return link.description ? `- [${link.title}](${link.href}): ${link.description}` : `- [${link.title}](${link.href})`;
+      }).join("\n") || ""
+    );
+  }
+  if (options.notes && options.notes.length) {
+    document.push("## Notes", (options.notes || []).map((note) => `- ${note}`).join("\n"));
+  }
+  setHeader(event, "Content-Type", "text/plain; charset=utf-8");
+  return document.join("\n\n");
+});

package/dist/runtime/server/utils/hooks.d.ts

@@ -1,26 +1,13 @@
-import type { H3Event } from 'h3';
-import type { NitroRuntimeHooks } from 'nitropack/types';
+import type { RequestEvent } from 'nuxt/server';
 import type { ModuleOptions } from 'nuxt-llms';
 /**
- * @deprecated Custom hooks are deprecated in favor of NitroRuntimeHooks.
+ * @deprecated Custom hooks are deprecated in favor of NuxtServerHooks.
  */
 export interface LLMSHooks {
-    'generate': (event: H3Event, options: ModuleOptions) => void;
-    'generate:full': (event: H3Event, options: ModuleOptions, contents: string[]) => void;
+    generate: (event: RequestEvent, options: ModuleOptions) => void;
+    'generate:full': (event: RequestEvent, options: ModuleOptions, contents: string[]) => void;
 }
 /**
- * @deprecated Custom hooks are deprecated in favor of NitroRuntimeHooks.
+ * @deprecated Custom hooks are deprecated in favor of NuxtServerHooks.
  */
 export declare const llmsHooks: import("hookable").Hookable<LLMSHooks, import("hookable").HookKeys<LLMSHooks>>;
-/**
- * Run a callback when LLMs is being generated.
- *
- * @deprecated Use `useNitroApp().hooks.hook('llms:generate', (event, options) => {})` instead
- */
-export declare function onLLMsGenerate(cb: NitroRuntimeHooks['llms:generate']): any;
-/**
- * Run a callback when Full LLMs is being generated.
- *
- * @deprecated Use `useNitroApp().hooks.hook('llms:generate:full', (event, options, contents) => {})` instead
- */
-export declare function onLLMsGenerateFull(cb: NitroRuntimeHooks['llms:generate:full']): any;

package/dist/runtime/server/utils/hooks.js

@@ -1,16 +1,13 @@
 import { createHooks } from "hookable";
-import { useNitroApp } from "#imports";
 export const llmsHooks = createHooks();
 llmsHooks.beforeEach(() => {
   const hooks = Object.values(llmsHooks._hooks || {});
-  const hasRegisteredHook = hooks.some((hooksList) => Array.isArray(hooksList) && hooksList.length > 0);
+  const hasRegisteredHook = hooks.some(
+    (hooksList) => Array.isArray(hooksList) && hooksList.length > 0
+  );
   if (hasRegisteredHook) {
-    console.warn("[nuxt-llms] `llmsHooks` are deprecated and will be removed in future versions. Use `useNitroApp().hooks.hook('llms:generate', (event, options) => {})` instead");
+    console.warn(
+      "[nuxt-llms] `llmsHooks` are deprecated and will be removed in future versions. Use `useServerHooks().hook('llms:generate', (event, options) => {})` instead"
+    );
   }
 });
-export function onLLMsGenerate(cb) {
-  return useNitroApp().hooks.hook("llms:generate", cb);
-}
-export function onLLMsGenerateFull(cb) {
-  return useNitroApp().hooks.hook("llms:generate:full", cb);
-}

package/dist/runtime/server/utils/hooks.legacy.d.ts

@@ -0,0 +1,26 @@
+import type { H3Event } from 'h3';
+import type { NitroRuntimeHooks } from 'nitropack/types';
+import type { ModuleOptions } from 'nuxt-llms';
+/**
+ * @deprecated Custom hooks are deprecated in favor of NitroRuntimeHooks.
+ */
+export interface LLMSHooks {
+    generate: (event: H3Event, options: ModuleOptions) => void;
+    'generate:full': (event: H3Event, options: ModuleOptions, contents: string[]) => void;
+}
+/**
+ * @deprecated Custom hooks are deprecated in favor of NitroRuntimeHooks.
+ */
+export declare const llmsHooks: import("hookable").Hookable<LLMSHooks, import("hookable").HookKeys<LLMSHooks>>;
+/**
+ * Run a callback when LLMs is being generated.
+ *
+ * @deprecated Use `useNitroApp().hooks.hook('llms:generate', (event, options) => {})` instead
+ */
+export declare function onLLMsGenerate(cb: NitroRuntimeHooks['llms:generate']): () => void;
+/**
+ * Run a callback when Full LLMs is being generated.
+ *
+ * @deprecated Use `useNitroApp().hooks.hook('llms:generate:full', (event, options, contents) => {})` instead
+ */
+export declare function onLLMsGenerateFull(cb: NitroRuntimeHooks['llms:generate:full']): () => void;

package/dist/runtime/server/utils/hooks.legacy.js

@@ -0,0 +1,20 @@
+import { createHooks } from "hookable";
+import { useNitroApp } from "nitropack/runtime";
+export const llmsHooks = createHooks();
+llmsHooks.beforeEach(() => {
+  const hooks = Object.values(llmsHooks._hooks || {});
+  const hasRegisteredHook = hooks.some(
+    (hooksList) => Array.isArray(hooksList) && hooksList.length > 0
+  );
+  if (hasRegisteredHook) {
+    console.warn(
+      "[nuxt-llms] `llmsHooks` are deprecated and will be removed in future versions. Use `useNitroApp().hooks.hook('llms:generate', (event, options) => {})` instead"
+    );
+  }
+});
+export function onLLMsGenerate(cb) {
+  return useNitroApp().hooks.hook("llms:generate", cb);
+}
+export function onLLMsGenerateFull(cb) {
+  return useNitroApp().hooks.hook("llms:generate:full", cb);
+}

package/dist/runtime/types.d.ts

@@ -1,10 +1,30 @@
 import type { H3Event } from 'h3';
+/**
+ * The request event `nuxt/server` passes to hooks on Nuxt 5. Declared here since
+ * `nuxt/schema` only exports `RequestEvent` from Nuxt 4.6.
+ */
+export interface LLMsRequestEvent {
+    readonly req: Request;
+    url: URL;
+    readonly res: {
+        status?: number;
+        statusText?: string;
+        readonly headers: Headers;
+    };
+    readonly context: object;
+}
 declare module 'nitropack/types' {
     interface NitroRuntimeHooks {
         'llms:generate': (event: H3Event, options: ModuleOptions) => void;
         'llms:generate:full': (event: H3Event, options: ModuleOptions, contents: string[]) => void;
     }
 }
+declare module 'nuxt/schema' {
+    interface NuxtServerHooks {
+        'llms:generate': (event: LLMsRequestEvent, options: ModuleOptions) => void;
+        'llms:generate:full': (event: LLMsRequestEvent, options: ModuleOptions, contents: string[]) => void;
+    }
+}
 export interface LLMsSection {
     title: string;
     description?: string;
@@ -30,4 +50,10 @@ export interface ModuleOptions {
     title?: string;
     description?: string;
     notes?: string[];
+    /**
+     * Prerender `/llms.txt` and `/llms-full.txt` at build time.
+     * Disable to serve them dynamically, for example with ISR.
+     * @default true
+     */
+    prerender?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-llms",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "description": "Generate llms.txt documentation for your Nuxt application",
   "repository": {
     "type": "git",
@@ -36,8 +36,10 @@
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
-    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
-    "lint": "eslint .",
+    "release": "npm run lint && npm run test && npm run prepack && release-it",
+    "lint:fix": "oxlint --fix && oxfmt src test playground",
+    "lint": "oxlint && oxfmt --check src test playground",
+    "format": "oxlint --fix && oxfmt src test playground",
     "typecheck": "nuxi typecheck",
     "test": "vitest run",
     "test:watch": "vitest watch",
@@ -45,23 +47,32 @@
     "verify": "npm run dev:prepare && npm run prepack && npm run lint && npm run test && npm run typecheck"
   },
   "dependencies": {
-    "@nuxt/kit": "^4.2.2"
+    "@nuxt/kit": "^4.6.2"
   },
   "devDependencies": {
-    "@nuxt/content": "^3.10.0",
-    "@nuxt/devtools": "^3.1.1",
-    "@nuxt/eslint-config": "^1.12.1",
-    "@nuxt/module-builder": "^1.0.2",
-    "@nuxt/schema": "^4.2.2",
-    "@nuxt/test-utils": "^3.23.0",
-    "@types/node": "^25.0.7",
-    "changelogen": "^0.6.2",
-    "eslint": "^9.39.2",
-    "nuxt": "^4.2.2",
+    "@nuxt/content": "^3.16.2",
+    "@nuxt/devtools": "^3.4.4",
+    "@nuxt/module-builder": "^1.0.3",
+    "@nuxt/schema": "^4.6.2",
+    "@nuxt/test-utils": "^4.3.4",
+    "@types/node": "^26.6.5",
+    "nuxt": "^4.6.2",
     "nuxt-llms": "link:",
-    "typescript": "~5.9.3",
-    "vitest": "^4.0.17",
-    "vue-tsc": "^3.2.2"
+    "oxfmt": "^0.74.0",
+    "oxlint": "^1.89.0",
+    "release-it": "^21.1.1",
+    "typescript": "~6.0.3",
+    "vitest": "^5.0.5",
+    "vue-tsc": "^3.3.13"
   },
-  "packageManager": "pnpm@10.28.0"
+  "release-it": {
+    "git": {
+      "commitMessage": "chore(release): release v${version}"
+    },
+    "github": {
+      "release": true,
+      "releaseName": "v${version}"
+    }
+  },
+  "packageManager": "pnpm@12.14.0"
 }