nuxt-ai-ready 1.4.0 → 1.5.1

package/README.md

@@ -41,6 +41,8 @@ npx nuxi@latest module add nuxt-ai-ready
 > npx skilld add nuxt-ai-ready
 > ```
 
+💡 Made your site AI-ready? Preview how a page converts to LLM-readable markdown with the free [HTML→Markdown tool](https://nuxtseo.com/tools/html-to-markdown), or track how AI engines index, rank and cite your site with [Nuxt SEO Pro](https://nuxtseo.com/pro).
+
 ## Documentation
 
 [📖 Read the full documentation](https://nuxtseo.com/ai-ready) for more information.

package/dist/module.json

@@ -4,7 +4,7 @@
     "nuxt": ">=4.0.0"
   },
   "configKey": "aiReady",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -10,6 +10,7 @@ import { readPackageJSON, resolvePackageJSON } from 'pkg-types';
 import { parseSitemapXml } from '@nuxtjs/sitemap/utils';
 import { colorize } from 'consola/utils';
 import { withBase } from 'ufo';
+import { toMarkdownPath } from '../dist/runtime/markdown-path.js';
 import { initSchema, computeContentHash, insertPage, queryAllPages, exportDbDump } from '../dist/runtime/server/db/shared.js';
 import { comparePageHashes, submitToIndexNowShared } from '../dist/runtime/server/utils/indexnow-shared.js';
 import { buildLlmsFullTxtHeader, formatPageForLlmsFullTxt } from '../dist/runtime/server/utils/llms-full.js';
@@ -163,7 +164,7 @@ async function processSitemapEntry(state, nuxt, nitro, entry) {
   if (state.prerenderedRoutes.has(route)) {
     return { crawled: false, skipped: true };
   }
-  const mdRoute = route.endsWith("/") ? `${route}index.md` : `${route}.md`;
+  const mdRoute = toMarkdownPath(route);
   const mdUrl = withBase(mdRoute, nitro.options.baseURL);
   logger.debug(`Fetching markdown for ${route} \u2192 ${mdUrl}`);
   const res = await globalThis.$fetch(mdUrl, {
@@ -675,11 +676,13 @@ const module$1 = defineNuxtModule({
       nuxt.options.robots = robotsOpts;
       const groups = robotsOpts.groups || [];
       robotsOpts.groups = groups;
-      groups.push({
+      const group = {
         userAgent: "*",
-        contentUsage: [`train-ai=${config.contentSignal.aiTrain ? "y" : "n"}`],
         contentSignal: [`ai-train=${config.contentSignal.aiTrain ? "yes" : "no"}`, `search=${config.contentSignal.search ? "yes" : "no"}`, `ai-input=${config.contentSignal.aiInput ? "yes" : "no"}`]
-      });
+      };
+      if (config.contentSignal.contentUsage !== false)
+        group.contentUsage = [`train-ai=${config.contentSignal.aiTrain ? "y" : "n"}`];
+      groups.push(group);
     }
     registerTypeTemplates();
     const defaultLlmsTxtSections = [];

package/dist/runtime/app/plugins/md-alternate.server.js

@@ -1,4 +1,5 @@
 import { defineNuxtPlugin, useHead, useRequestURL } from "nuxt/app";
+import { toMarkdownPath } from "../../markdown-path.js";
 export default defineNuxtPlugin({
   setup() {
     const url = useRequestURL();
@@ -6,10 +7,9 @@ export default defineNuxtPlugin({
     const lastSegment = path.split("/").pop() || "";
     if (lastSegment.includes("."))
       return;
-    const mdPath = path === "/" ? "/index.md" : `${path.replace(/\/$/, "")}.md`;
     useHead({
       link: [
-        { rel: "alternate", type: "text/markdown", href: mdPath }
+        { rel: "alternate", type: "text/markdown", href: toMarkdownPath(path) }
       ]
     });
   }

package/dist/runtime/app/plugins/md-hints.prerender.js

@@ -1,21 +1,17 @@
 import { isPathFile } from "nuxt-site-config/urls";
 import { defineNuxtPlugin, prerenderRoutes } from "nuxt/app";
+import { toMarkdownPath } from "../../markdown-path.js";
 export default defineNuxtPlugin({
   setup(nuxtApp) {
     if (!import.meta.prerender) {
       return;
     }
     nuxtApp.hooks.hook("app:rendered", (ctx) => {
-      let url = ctx.ssrContext?.url || "";
+      const url = ctx.ssrContext?.url || "";
       if (isPathFile(url) || ctx.ssrContext?.error || ctx.ssrContext?.noSSR) {
         return;
       }
-      if (url.endsWith("/")) {
-        url = `${url}index.md`;
-      } else {
-        url = `${url}.md`;
-      }
-      prerenderRoutes(url);
+      prerenderRoutes(toMarkdownPath(url));
     });
   }
 });

package/dist/runtime/markdown-path.d.ts

@@ -0,0 +1 @@
+export declare function toMarkdownPath(path: string): string;

package/dist/runtime/markdown-path.js

@@ -0,0 +1,6 @@
+const RE_TRAILING_SLASHES = /\/+$/;
+export function toMarkdownPath(path) {
+  if (path === "/")
+    return "/index.md";
+  return `${path.replace(RE_TRAILING_SLASHES, "")}.md`;
+}

package/dist/runtime/server/db/drizzle/providers/libsql.js

@@ -4,9 +4,14 @@ import { useRuntimeConfig } from "nitropack/runtime";
 import * as schema from "#ai-ready-virtual/db-schema.mjs";
 import { logger } from "../../../logger.js";
 import { registerDriver } from "../raw.js";
+import { resolveWritableDbPath } from "./dbPath.js";
 export async function createClient(event) {
   const config = useRuntimeConfig(event)["nuxt-ai-ready"];
-  const dbUrl = config.database.url || `file:${config.database.filename || ".data/ai-ready/pages.db"}`;
+  let dbUrl = config.database.url || `file:${config.database.filename || ".data/ai-ready/pages.db"}`;
+  if (dbUrl.startsWith("file:") && !dbUrl.startsWith("file://")) {
+    const resolved = await resolveWritableDbPath(dbUrl.slice("file:".length));
+    dbUrl = `file:${resolved}`;
+  }
   logger.debug(`[drizzle] Connecting to LibSQL: ${dbUrl}`);
   const client = createLibSQLClient({ url: dbUrl, authToken: config.database.authToken });
   const db = drizzle(client, { schema });

package/dist/runtime/server/middleware/markdown.js

@@ -9,14 +9,14 @@ import { buildFrontmatter } from "../utils/frontmatter.js";
 import { computeLocaleAlternates, resolveLocaleFromRoute } from "../utils/i18n.js";
 import { buildLinkHeader } from "../utils/link-header.js";
 const INTERNAL_HEADER = "x-ai-ready-internal";
-function setNegotiationHeaders(event, path, config) {
+function setNegotiationHeaders(event, path, config, resolveUrl) {
   setHeader(event, "vary", "Accept, Sec-Fetch-Dest");
-  setHeader(event, "link", buildLinkHeader(path, "html", config));
+  setHeader(event, "link", buildLinkHeader(path, "html", config, resolveUrl));
 }
-function setMarkdownHeaders(event, path, config) {
+function setMarkdownHeaders(event, path, config, resolveUrl) {
   setHeader(event, "content-type", "text/markdown; charset=utf-8");
   setHeader(event, "vary", "Accept, Sec-Fetch-Dest");
-  setHeader(event, "link", buildLinkHeader(path, "markdown", config));
+  setHeader(event, "link", buildLinkHeader(path, "markdown", config, resolveUrl));
   if (config.markdownCacheHeaders) {
     const { maxAge, swr } = config.markdownCacheHeaders;
     const cacheControl = swr ? `public, max-age=${maxAge}, stale-while-revalidate=${maxAge}` : `public, max-age=${maxAge}`;
@@ -65,9 +65,10 @@ export default defineEventHandler(async (event) => {
   }
   const { path, isExplicit, negotiation } = renderInfo;
   const config = useRuntimeConfig(event)["nuxt-ai-ready"];
-  const canonicalUrl = withSiteUrl(event, path);
+  const resolveUrl = (path2) => withSiteUrl(event, path2);
+  const canonicalUrl = resolveUrl(path);
   if (negotiation === "html") {
-    setNegotiationHeaders(event, path, config);
+    setNegotiationHeaders(event, path, config, resolveUrl);
     return;
   }
   if (!isExplicit) {
@@ -85,7 +86,7 @@ export default defineEventHandler(async (event) => {
       canonical_url: canonicalUrl,
       last_updated: contentPage.updatedAt || (/* @__PURE__ */ new Date()).toISOString()
     });
-    setMarkdownHeaders(event, path, config);
+    setMarkdownHeaders(event, path, config, resolveUrl);
     return `${frontmatter}
 ${contentPage.markdown}`;
   }
@@ -98,7 +99,7 @@ ${contentPage.markdown}`;
     return null;
   });
   if (!response) {
-    setMarkdownHeaders(event, path, config);
+    setMarkdownHeaders(event, path, config, resolveUrl);
     return notFoundMarkdown(canonicalUrl, path, config);
   }
   if (response.status >= 300 && response.status < 400) {
@@ -113,12 +114,12 @@ ${contentPage.markdown}`;
     }
   }
   if (!response.ok) {
-    setMarkdownHeaders(event, path, config);
+    setMarkdownHeaders(event, path, config, resolveUrl);
     return notFoundMarkdown(canonicalUrl, path, config);
   }
   const contentType = response.headers.get("content-type") || "";
   if (!contentType.includes("text/html")) {
-    setMarkdownHeaders(event, path, config);
+    setMarkdownHeaders(event, path, config, resolveUrl);
     return notFoundMarkdown(canonicalUrl, path, config);
   }
   const html = await response.text();
@@ -144,6 +145,6 @@ ${contentPage.markdown}`;
       additionalFrontmatter
     }
   );
-  setMarkdownHeaders(event, path, config);
+  setMarkdownHeaders(event, path, config, resolveUrl);
   return result.markdown;
 });

package/dist/runtime/server/utils/link-header.d.ts

@@ -7,7 +7,9 @@ import type { ModulePublicRuntimeConfig } from '../../../module.js';
  * `encodeURI` preserves `/` separators and other reserved URL characters.
  */
 export declare function encodePathForHeader(path: string): string;
+type LinkUrlResolver = (path: string) => string;
 /**
  * Build a comma-joined Link header value with the standard alternates plus i18n hreflang variants.
  */
-export declare function buildLinkHeader(path: string, variant: 'html' | 'markdown', config: ModulePublicRuntimeConfig): string;
+export declare function buildLinkHeader(path: string, variant: 'html' | 'markdown', config: ModulePublicRuntimeConfig, resolveUrl?: LinkUrlResolver): string;
+export {};

package/dist/runtime/server/utils/link-header.js

@@ -1,13 +1,18 @@
+import { toMarkdownPath } from "../../markdown-path.js";
 import { computeLocaleAlternates } from "./i18n.js";
 export function encodePathForHeader(path) {
   return encodeURI(path);
 }
-function toMarkdownPath(path) {
-  if (path === "/" || path.endsWith("/"))
-    return `${path}index.md`;
-  return `${path}.md`;
+function resolveHeaderUrl(path, resolveUrl) {
+  if (!resolveUrl)
+    return path;
+  try {
+    return resolveUrl(path);
+  } catch {
+    return path;
+  }
 }
-export function buildLinkHeader(path, variant, config) {
+export function buildLinkHeader(path, variant, config, resolveUrl) {
   const parts = [];
   if (variant === "html") {
     parts.push(`<${encodePathForHeader(toMarkdownPath(path))}>; rel="alternate"; type="text/markdown"`);
@@ -18,7 +23,7 @@ export function buildLinkHeader(path, variant, config) {
     const alternates = computeLocaleAlternates(path, config.i18n);
     for (const alt of alternates) {
       const href = variant === "markdown" ? toMarkdownPath(alt.path) : alt.path;
-      parts.push(`<${encodePathForHeader(href)}>; rel="alternate"; hreflang="${alt.hreflang}"`);
+      parts.push(`<${encodePathForHeader(resolveHeaderUrl(href, resolveUrl))}>; rel="alternate"; hreflang="${alt.hreflang}"`);
     }
   }
   return parts.join(", ");

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

@@ -1,6 +1,7 @@
 import type { ContentNegotiationResult } from '@mdream/js/negotiate';
 import type { H3Event } from 'h3';
 import type { ModulePublicRuntimeConfig } from '../../module.js';
+export { toMarkdownPath } from '../markdown-path.js';
 export declare function negotiateRepresentation(event: H3Event): ContentNegotiationResult;
 export declare function getMarkdownRenderInfo(event: H3Event, explicitOnly?: boolean): {
     path: string;
@@ -9,7 +10,6 @@ export declare function getMarkdownRenderInfo(event: H3Event, explicitOnly?: boo
 } | {
     notAcceptable: true;
 } | null;
-export declare function toMarkdownPath(path: string): string;
 export declare function clientPrefersMarkdown(event: H3Event): boolean;
 export declare function extractLastUpdated(html: string): string | undefined;
 interface ConvertHtmlOptions {
@@ -32,4 +32,3 @@ export declare function convertHtmlToMarkdown(html: string, url: string, mdreamO
     metaKeywords: string;
     textContent: string;
 }>;
-export {};

package/dist/runtime/server/utils.js

@@ -3,6 +3,7 @@ import { getBotInfo } from "@nuxtjs/robots/util";
 import { getHeader, getHeaders } from "h3";
 import { htmlToMarkdown } from "mdream";
 import { useNitroApp } from "nitropack/runtime";
+export { toMarkdownPath } from "../markdown-path.js";
 const RE_NBSP = /\u00A0/g;
 function normalizeWhitespace(text) {
   return text.replace(RE_NBSP, " ");
@@ -47,6 +48,8 @@ function buildMdreamOptions(url, mdreamOptions, meta, extractUpdatedAt, addition
   };
 }
 export function negotiateRepresentation(event) {
+  if (import.meta.prerender || getHeader(event, "x-nitro-prerender"))
+    return "html";
   const accept = getHeader(event, "accept");
   const secFetchDest = getHeader(event, "sec-fetch-dest");
   if (negotiateContent(accept) === "markdown")
@@ -91,11 +94,6 @@ function normalizePath(path) {
     return path.slice(0, -5) || "/";
   return path;
 }
-export function toMarkdownPath(path) {
-  if (path === "/" || path.endsWith("/"))
-    return `${path}index.md`;
-  return `${path}.md`;
-}
 export function clientPrefersMarkdown(event) {
   return negotiateRepresentation(event) === "markdown";
 }

package/dist/runtime/types.d.ts

@@ -42,6 +42,12 @@ export interface ModuleOptions {
          * Allow Training or fine-tuning AI models.
          */
         aiTrain?: boolean;
+        /**
+         * Emit the draft Content-Usage robots.txt directive.
+         * Set to false to avoid robots.txt validators that do not support it yet.
+         * @default true
+         */
+        contentUsage?: boolean;
         /**
          * Allow building a search index and providing search results (e.g., returning hyperlinks and short excerpts from your website's contents).
          * Search does not include providing AI-generated search summaries.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-ai-ready",
   "type": "module",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "Best practice AI & LLM discoverability for Nuxt sites.",
   "author": {
     "name": "Harlan Wilton",
@@ -57,56 +57,56 @@
     }
   },
   "dependencies": {
-    "@mdream/js": "^1.3.0",
+    "@mdream/js": "^1.4.1",
     "@nuxt/kit": "^4.4.8",
     "citty": "^0.2.2",
     "consola": "^3.4.2",
     "defu": "^6.1.7",
     "drizzle-orm": "^0.45.2",
-    "mdream": "^1.3.0",
-    "nuxt-site-config": "^4.1.0",
-    "nuxtseo-shared": "^5.2.6",
+    "mdream": "^1.4.1",
+    "nuxt-site-config": "^4.1.1",
+    "nuxtseo-shared": "^5.3.1",
     "pathe": "^2.0.3",
     "pkg-types": "^2.3.1",
-    "site-config-stack": "^4.0.8",
+    "site-config-stack": "^4.1.1",
     "ufo": "^1.6.4",
     "uncrypto": "^0.1.3"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^9.0.0",
-    "@arethetypeswrong/cli": "^0.18.3",
-    "@libsql/client": "^0.17.3",
+    "@antfu/eslint-config": "^9.1.0",
+    "@arethetypeswrong/cli": "^0.18.4",
+    "@libsql/client": "^0.17.4",
     "@nuxt/content": "^3.14.0",
     "@nuxt/module-builder": "^1.0.2",
     "@nuxt/test-utils": "^4.0.3",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
     "@nuxtjs/mcp-toolkit": "^0.17.2",
-    "@nuxtjs/robots": "^6.0.9",
-    "@nuxtjs/sitemap": "^8.2.0",
+    "@nuxtjs/robots": "^6.1.1",
+    "@nuxtjs/sitemap": "^8.2.1",
     "@types/better-sqlite3": "^7.6.13",
-    "@vitest/coverage-v8": "^4.1.8",
+    "@vitest/coverage-v8": "^4.1.9",
     "@vue/test-utils": "^2.4.11",
     "@vueuse/nuxt": "^14.3.0",
-    "better-sqlite3": "^12.10.0",
+    "better-sqlite3": "^12.11.1",
     "bumpp": "^11.1.0",
-    "eslint": "^10.4.1",
+    "eslint": "^10.5.0",
     "eslint-plugin-harlanzw": "^0.17.0",
     "execa": "^9.6.1",
-    "happy-dom": "^20.10.2",
+    "happy-dom": "^20.10.6",
     "nitropack": "^2.13.4",
     "nuxt": "^4.4.8",
-    "nuxt-site-config": "^4.1.0",
-    "nuxtseo-layer-devtools": "^5.2.6",
-    "playwright": "^1.60.0",
-    "playwright-core": "^1.60.0",
+    "nuxt-site-config": "^4.1.1",
+    "nuxtseo-layer-devtools": "^5.3.1",
+    "playwright": "^1.61.1",
+    "playwright-core": "^1.61.1",
     "tinyglobby": "^0.2.17",
     "typescript": "^6.0.3",
     "unbuild": "^3.6.1",
-    "vitest": "^4.1.8",
-    "vue": "^3.5.35",
+    "vitest": "^4.1.9",
+    "vue": "^3.5.38",
     "vue-router": "^5.1.0",
-    "vue-tsc": "^3.3.4",
-    "wrangler": "^4.99.0",
+    "vue-tsc": "^3.3.5",
+    "wrangler": "^4.104.0",
     "zod": "^4.4.3"
   },
   "scripts": {