nuxt-ai-ready 0.0.0

package/dist/runtime/types.d.ts

@@ -0,0 +1,166 @@
+import type { H3Event } from 'h3';
+import type { HTMLToMarkdownOptions } from 'mdream';
+export interface ModuleOptions {
+    /**
+     * Enable/disable module
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Debug mode
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Bulk data API (JSONL streaming)
+     * @default '/_ai-ready/bulk'
+     */
+    bulkRoute: string | false;
+    /**
+     * Options to pass to mdream htmlToMarkdown function
+     */
+    mdreamOptions?: HTMLToMarkdownOptions & {
+        /**
+         * Preset to apply to the htmlToMarkdown function
+         */
+        preset?: 'minimal';
+    };
+    /**
+     * Cache configuration
+     */
+    markdownCacheHeaders?: {
+        /**
+         * Cache duration in seconds
+         * @default 3600 (1 hour)
+         */
+        maxAge?: number;
+        /**
+         * Enable stale-while-revalidate
+         * @default true
+         */
+        swr?: boolean;
+    };
+    /**
+     * Structured llms.txt configuration
+     */
+    llmsTxt?: LlmsTxtConfig;
+}
+/**
+ * Individual chunk entry in bulk.jsonl (one per chunk)
+ * Consumers can reassemble by route if needed
+ */
+export interface BulkChunk {
+    id: string;
+    route: string;
+    chunkIndex: number;
+    content: string;
+    headers?: Record<string, string>;
+    loc?: {
+        lines: {
+            from: number;
+            to: number;
+        };
+    };
+    title: string;
+    description: string;
+}
+/**
+ * Hook context for markdown processing (Nitro runtime hook)
+ *
+ * This hook is called during HTML→Markdown conversion in the runtime middleware.
+ * You can modify the markdown content before it's returned to the client.
+ *
+ * @example Modify markdown content
+ * nitroApp.hooks.hook('mdream:markdown', async (context) => {
+ *   // Add a footer to all markdown
+ *   context.markdown += '\n\n---\n*Generated with mdream*'
+ * })
+ *
+ * @example Track conversions and add headers
+ * nitroApp.hooks.hook('mdream:markdown', async (context) => {
+ *   console.log(`Converted ${context.route} (${context.title})`)
+ *
+ *   // Add custom headers
+ *   if (context.event) {
+ *     setHeader(context.event, 'X-Markdown-Title', context.title)
+ *   }
+ * })
+ */
+export interface MarkdownContext {
+    /** The original HTML content */
+    html: string;
+    /** The generated markdown content - modify this to change output */
+    markdown: string;
+    /** The route being processed (e.g., '/about') */
+    route: string;
+    /** The page title extracted from HTML */
+    title: string;
+    /** Page description extracted from meta tags or content */
+    description: string;
+    /** Whether this is during prerendering (true) or runtime (false) */
+    isPrerender: boolean;
+    /** The H3 event object for accessing request/response */
+    event: H3Event;
+}
+/**
+ * Link in llms.txt section
+ */
+export interface LlmsTxtLink {
+    /** The title of the link */
+    title: string;
+    /** The description of the link */
+    description?: string;
+    /** The href of the link */
+    href: string;
+}
+/**
+ * Section in llms.txt
+ */
+export interface LlmsTxtSection {
+    /** The title of the section */
+    title: string;
+    /** The description of the section (can be array for multiple paragraphs) */
+    description?: string | string[];
+    /** The links of the section */
+    links?: LlmsTxtLink[];
+}
+/**
+ * Structured llms.txt configuration
+ */
+export interface LlmsTxtConfig {
+    /** The sections of the documentation */
+    sections?: LlmsTxtSection[];
+    /** Notes section (always appears at the end) */
+    notes?: string | string[];
+}
+/**
+ * Hook context for chunk processing (Nitro build-time hook)
+ *
+ * Called during prerender for each generated chunk, allowing modules
+ * to implement RAG tooling (e.g., vector embeddings, search indexing)
+ *
+ * @example Process chunks for vector search
+ * nitro.hooks.hook('ai-ready:chunk', async (context) => {
+ *   const embedding = await generateEmbedding(context.chunk.content)
+ *   await vectorDb.insert({
+ *     id: context.chunk.id,
+ *     embedding,
+ *     metadata: {
+ *       route: context.route,
+ *       title: context.title,
+ *     }
+ *   })
+ * })
+ */
+export interface ChunkContext {
+    /** The chunk data that will be written to bulk JSONL */
+    chunk: BulkChunk;
+    /** The route being processed (e.g., '/about') */
+    route: string;
+    /** Page title extracted from HTML */
+    title: string;
+    /** Page description from meta tags */
+    description: string;
+    /** Headings extracted from the page */
+    headings: Array<Record<string, string>>;
+}

package/dist/types.d.mts

@@ -0,0 +1,12 @@
+import type { ModuleHooks, ModulePublicRuntimeConfig } from './module.mjs'
+
+declare module '@nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+export { type BulkChunk, type ModuleOptions } from '../dist/runtime/types.js'
+
+export { default } from './module.mjs'
+
+export { type ModuleHooks, type ModulePublicRuntimeConfig } from './module.mjs'

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "nuxt-ai-ready",
+  "type": "module",
+  "version": "0.0.0",
+  "description": "Best practice AI & LLM discoverability for Nuxt sites.",
+  "author": {
+    "name": "Harlan Wilton",
+    "email": "harlan@harlanzw.com",
+    "url": "https://harlanzw.com/"
+  },
+  "contributors": [
+    "Harlan Wilton <harlan@harlanzw.com>"
+  ],
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/harlan-zw",
+  "homepage": "https://nuxtseo.com/ai-ready",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nuxt-seo-pro/nuxt-ai-ready.git"
+  },
+  "bugs": {
+    "url": "https://github.com/nuxt-seo-pro/nuxt-ai-ready/issues"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@nuxt/kit": "4.2.1",
+    "consola": "^3.4.2",
+    "defu": "^6.1.4",
+    "mdream": "^0.14.0",
+    "minimatch": "^10.1.1",
+    "nuxt-site-config": "^3.2.11",
+    "pathe": "^2.0.3",
+    "pkg-types": "^2.3.0",
+    "std-env": "^3.10.0",
+    "tokenx": "^1.2.1",
+    "ufo": "^1.6.1"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^6.2.0",
+    "@arethetypeswrong/cli": "^0.18.2",
+    "@headlessui/vue": "^1.7.23",
+    "@nuxt/content": "^3.8.2",
+    "@nuxt/devtools-ui-kit": "^3.1.1",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/test-utils": "^3.20.1",
+    "@nuxtjs/color-mode": "^4.0.0",
+    "@nuxtjs/eslint-config-typescript": "^12.1.0",
+    "@nuxtjs/i18n": "^10.2.1",
+    "@nuxtjs/mcp-toolkit": "^0.4.1",
+    "@nuxtjs/robots": "^5.6.0",
+    "@nuxtjs/sitemap": "^7.4.7",
+    "@vitest/coverage-v8": "^4.0.14",
+    "@vueuse/nuxt": "^14.1.0",
+    "better-sqlite3": "^12.5.0",
+    "bumpp": "^10.3.2",
+    "eslint": "^9.39.1",
+    "execa": "^9.6.1",
+    "happy-dom": "^20.0.11",
+    "nuxt": "^4.2.1",
+    "nuxt-site-config": "^3.2.11",
+    "playwright-core": "^1.57.0",
+    "postgres": "^3.4.7",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.14",
+    "vue": "^3.5.25",
+    "vue-router": "^4.6.3",
+    "vue-tsc": "^3.1.5",
+    "zod": "^4.1.13"
+  },
+  "resolutions": {
+    "nuxt-ai-ready": "workspace:*"
+  },
+  "scripts": {
+    "lint": "eslint . --fix",
+    "build": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:minimal": "nuxi dev playground",
+    "prepare:fixtures": "nuxi prepare playground && nuxi prepare playground && nuxi prepare test/fixtures/basic",
+    "dev:build": "nuxi build playground",
+    "dev:build:minimal": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build && nuxi prepare playground",
+    "dev:prepare:minimal": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build && nuxi prepare playground",
+    "release": "pnpm build && bumpp -x \"npx changelogen --output=CHANGELOG.md\"",
+    "test": "pnpm run prepare:fixtures && vitest",
+    "test:unit": "vitest run --project=unit",
+    "test:e2e": "pnpm run prepare:fixtures && vitest run --project=e2e",
+    "typecheck": "tsc --noEmit",
+    "test:attw": "attw --pack"
+  }
+}