@adkinn/astro-ai-readiness 0.0.7

package/dist/config.js

@@ -0,0 +1,6 @@
+import {
+  aiReadinessConfigSchema
+} from "./chunk-CO2DB4IE.js";
+export {
+  aiReadinessConfigSchema
+};

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { AstroIntegration } from 'astro';
+import { AiReadinessConfig } from './config.js';
+export { AgentsMdConfig, FounderConfig, LlmsFullConfig, LlmsTxtConfig, McpConfig, OrganizationConfig, RobotsTxtConfig, WebSiteConfig } from './config.js';
+import 'zod';
+
+declare function aiReadiness(options: AiReadinessConfig): AstroIntegration;
+
+export { AiReadinessConfig, aiReadiness as default };

package/dist/index.js

@@ -0,0 +1,103 @@
+import {
+  writeMcpJson
+} from "./chunk-BDGAXJOB.js";
+import {
+  writeRobotsTxt
+} from "./chunk-36CGBNB5.js";
+import {
+  aiReadinessConfigSchema
+} from "./chunk-CO2DB4IE.js";
+import {
+  writeLlmsTxt
+} from "./chunk-WP6D4L7O.js";
+import {
+  writeLlmsFullTxt
+} from "./chunk-THSVWYUX.js";
+import {
+  writeAgentsMd
+} from "./chunk-CADNETPK.js";
+import "./chunk-V22PCH7G.js";
+
+// src/index.ts
+import { ZodError } from "zod";
+var VIRTUAL_ID = "virtual:ai-readiness-config";
+var RESOLVED_VIRTUAL_ID = "\0" + VIRTUAL_ID;
+function parseConfigOrThrow(options) {
+  try {
+    return aiReadinessConfigSchema.parse(options);
+  } catch (err) {
+    if (err instanceof ZodError) {
+      const lines = err.issues.map((issue) => {
+        const path = issue.path.length > 0 ? issue.path.join(".") : "<root>";
+        return `  \u2022 ${path}: ${issue.message}`;
+      });
+      throw new Error(
+        `aiReadiness: invalid config in aiReadiness({...}):
+${lines.join("\n")}`,
+        { cause: err }
+      );
+    }
+    throw err;
+  }
+}
+function aiReadiness(options) {
+  const config = parseConfigOrThrow(options);
+  const serialized = JSON.stringify(config);
+  return {
+    name: "@adkinn/astro-ai-readiness",
+    hooks: {
+      "astro:config:setup": ({ updateConfig, logger, config: astroConfig }) => {
+        updateConfig({
+          vite: {
+            plugins: [
+              {
+                name: "ai-readiness-virtual-config",
+                resolveId(id) {
+                  if (id === VIRTUAL_ID) return RESOLVED_VIRTUAL_ID;
+                  return null;
+                },
+                load(id) {
+                  if (id === RESOLVED_VIRTUAL_ID) {
+                    return `export const config = ${serialized}
+export default config
+`;
+                  }
+                  return null;
+                }
+              }
+            ]
+          }
+        });
+        const hasSitemap = astroConfig.integrations.some(
+          (i) => i.name === "@astrojs/sitemap"
+        );
+        if (!hasSitemap) {
+          logger.warn(
+            "@astrojs/sitemap not detected. Install it (`npm install @astrojs/sitemap`) so AI agents can discover your sitemap.xml \u2014 sitemap is an AI Readiness baseline (per D-8). See https://docs.astro.build/en/guides/integrations-guide/sitemap/"
+          );
+        }
+        logger.info("aiReadiness integration registered");
+      },
+      "astro:build:done": async ({ dir, logger }) => {
+        if (config.llmsTxt) {
+          await writeLlmsTxt(config, dir, logger);
+        }
+        if (config.llmsFull) {
+          await writeLlmsFullTxt(config, dir, logger);
+        }
+        if (config.agentsMd) {
+          await writeAgentsMd(config, dir, logger);
+        }
+        if (config.mcp) {
+          await writeMcpJson(config, dir, logger);
+        }
+        if (config.robotsTxt) {
+          await writeRobotsTxt(config, dir, logger);
+        }
+      }
+    }
+  };
+}
+export {
+  aiReadiness as default
+};

package/dist/outputs/agents-md.d.ts

@@ -0,0 +1,19 @@
+import { AiReadinessConfig, AgentsMdConfig } from '../config.js';
+import 'zod';
+
+/**
+ * Pure composer — returns the agents.md content string. Testable without filesystem.
+ * Format: H1 (org name) / blockquote summary / fixed H2 sections.
+ *
+ * Like llms.txt, agents.md string fields are emitted as raw markdown — consumers
+ * responsible for escaping their own punctuation when shipping user-generated content.
+ */
+declare function composeAgentsMd(config: AiReadinessConfig & {
+    agentsMd: AgentsMdConfig;
+}): string;
+declare function writeAgentsMd(config: AiReadinessConfig, dir: URL, logger: {
+    info: (msg: string) => void;
+    warn: (msg: string) => void;
+}): Promise<void>;
+
+export { composeAgentsMd, writeAgentsMd };

package/dist/outputs/agents-md.js

@@ -0,0 +1,9 @@
+import {
+  composeAgentsMd,
+  writeAgentsMd
+} from "../chunk-CADNETPK.js";
+import "../chunk-V22PCH7G.js";
+export {
+  composeAgentsMd,
+  writeAgentsMd
+};

package/dist/outputs/llms-full.d.ts

@@ -0,0 +1,18 @@
+import { AiReadinessConfig, LlmsFullConfig } from '../config.js';
+import 'zod';
+
+/**
+ * Pure composer for llms-full.txt.
+ *
+ * This is intentionally config-driven for v0.0.7. Content-collection
+ * introspection can layer on later without reintroducing inert config.
+ */
+declare function composeLlmsFullTxt(config: AiReadinessConfig & {
+    llmsFull: LlmsFullConfig;
+}): string;
+declare function writeLlmsFullTxt(config: AiReadinessConfig, dir: URL, logger: {
+    info: (msg: string) => void;
+    warn: (msg: string) => void;
+}): Promise<void>;
+
+export { composeLlmsFullTxt, writeLlmsFullTxt };

package/dist/outputs/llms-full.js

@@ -0,0 +1,9 @@
+import {
+  composeLlmsFullTxt,
+  writeLlmsFullTxt
+} from "../chunk-THSVWYUX.js";
+import "../chunk-V22PCH7G.js";
+export {
+  composeLlmsFullTxt,
+  writeLlmsFullTxt
+};

package/dist/outputs/llms-txt.d.ts

@@ -0,0 +1,19 @@
+import { AiReadinessConfig, LlmsTxtConfig } from '../config.js';
+import 'zod';
+
+/**
+ * Pure composer — returns the llms.txt content string. Testable without filesystem.
+ *
+ * Format follows llmstxt.org: H1 / blockquote / free-form markdown body /
+ * H2 sections with bulleted links / optional defer-to footer. No sitemap section
+ * per the matrix — sitemap reference lives in robots.txt (Plan 12).
+ */
+declare function composeLlmsTxt(config: AiReadinessConfig & {
+    llmsTxt: LlmsTxtConfig;
+}): string;
+declare function writeLlmsTxt(config: AiReadinessConfig, dir: URL, logger: {
+    info: (msg: string) => void;
+    warn: (msg: string) => void;
+}): Promise<void>;
+
+export { composeLlmsTxt, writeLlmsTxt };

package/dist/outputs/llms-txt.js

@@ -0,0 +1,9 @@
+import {
+  composeLlmsTxt,
+  writeLlmsTxt
+} from "../chunk-WP6D4L7O.js";
+import "../chunk-V22PCH7G.js";
+export {
+  composeLlmsTxt,
+  writeLlmsTxt
+};

package/dist/outputs/mcp-json.d.ts

@@ -0,0 +1,21 @@
+import { AiReadinessConfig, McpConfig } from '../config.js';
+import 'zod';
+
+/**
+ * Pure composer — returns the mcp.json content string. Testable without filesystem.
+ * Pretty-printed (2-space indent) + single trailing newline (POSIX).
+ */
+declare function composeMcpJson(config: AiReadinessConfig & {
+    mcp: McpConfig;
+}): string;
+/**
+ * Filesystem writer — composes content + writes to dist/.well-known/mcp.json.
+ * Creates the .well-known/ subdirectory first (idempotent via { recursive: true }).
+ * Skips (and warns) if the consumer already ships the file. See writeOutput.
+ */
+declare function writeMcpJson(config: AiReadinessConfig, dir: URL, logger: {
+    info: (msg: string) => void;
+    warn: (msg: string) => void;
+}): Promise<void>;
+
+export { composeMcpJson, writeMcpJson };

package/dist/outputs/mcp-json.js

@@ -0,0 +1,9 @@
+import {
+  composeMcpJson,
+  writeMcpJson
+} from "../chunk-BDGAXJOB.js";
+import "../chunk-V22PCH7G.js";
+export {
+  composeMcpJson,
+  writeMcpJson
+};

package/dist/outputs/robots-txt.d.ts

@@ -0,0 +1,20 @@
+import { AiReadinessConfig, RobotsTxtConfig } from '../config.js';
+import 'zod';
+
+/**
+ * Pure composer for robots.txt.
+ *
+ * Presets are intentionally conservative: `training-opt-out` keeps ordinary
+ * search discovery open and opts out of common model-training tokens. Some
+ * vendors bundle training and grounding under one token, so consumers can
+ * override the rules when answer-engine inclusion matters more than opt-out.
+ */
+declare function composeRobotsTxt(config: AiReadinessConfig & {
+    robotsTxt: RobotsTxtConfig;
+}): string;
+declare function writeRobotsTxt(config: AiReadinessConfig, dir: URL, logger: {
+    info: (msg: string) => void;
+    warn: (msg: string) => void;
+}): Promise<void>;
+
+export { composeRobotsTxt, writeRobotsTxt };

package/dist/outputs/robots-txt.js

@@ -0,0 +1,9 @@
+import {
+  composeRobotsTxt,
+  writeRobotsTxt
+} from "../chunk-36CGBNB5.js";
+import "../chunk-V22PCH7G.js";
+export {
+  composeRobotsTxt,
+  writeRobotsTxt
+};

package/dist/utils/json-ld.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Serialize a JSON-LD payload for safe embedding inside an inline
+ * `<script type="application/ld+json">` block.
+ *
+ * @internal
+ *   Used by the toolkit's components via relative import (`../utils/json-ld`)
+ *   from `dist/components/*.astro`. Not part of the public API; intentionally
+ *   excluded from `package.json.exports`. The file ships as a build artifact
+ *   so the relative-import resolution works at consumer build time, but no
+ *   subpath like `@adkinn/astro-ai-readiness/utils/json-ld` is exposed.
+ *   If you find yourself wanting to import this directly, file an issue —
+ *   we'll consider promoting it to a public subpath.
+ *
+ * Three escapes:
+ * - `<` -> `\u003c` so a literal `</script>` in any string cannot break
+ *   the host HTML parser (XSS / parser confusion vector).
+ * - U+2028 line separator and U+2029 paragraph separator: legal in JSON
+ *   strings but illegal in pre-ES2019 JS string literals; consumer
+ *   toolchains vary. Cheap insurance.
+ *
+ * The escaped form is canonical JSON-LD; validator.schema.org and every
+ * search-engine consumer decode the escapes transparently.
+ */
+declare function jsonLd(obj: Record<string, unknown>): string;
+
+export { jsonLd };

package/dist/utils/json-ld.js

@@ -0,0 +1,7 @@
+// src/utils/json-ld.ts
+function jsonLd(obj) {
+  return JSON.stringify(obj).replace(/</g, "\\u003c").replace(/\u2028/g, "\\u2028").replace(/\u2029/g, "\\u2029");
+}
+export {
+  jsonLd
+};

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@adkinn/astro-ai-readiness",
+  "version": "0.0.7",
+  "description": "AI Readiness toolkit for Astro — six JSON-LD components plus llms.txt, llms-full.txt, agents.md, robots.txt, and .well-known/mcp.json outputs.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "schemas",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup && cp src/components/*.astro dist/components/",
+    "typecheck": "tsc --noEmit",
+    "test": "npm run build && node --test tests/*.test.mjs",
+    "lint": "npm run typecheck && npm run build && node scripts/lint-package.mjs"
+  },
+  "dependencies": {
+    "zod": "^3.23.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.6.0",
+    "astro": "^6.1.9",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0"
+  },
+  "keywords": [
+    "ai-readiness",
+    "aeo",
+    "agent-readable",
+    "llms-txt",
+    "llms-full-txt",
+    "agents-md",
+    "mcp",
+    "robots-txt",
+    "schema-org",
+    "json-ld",
+    "astro-integration",
+    "astro-component",
+    "withastro"
+  ],
+  "author": {
+    "name": "Adam Kinney",
+    "url": "https://adamkinney.com"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adkinn/astro-ai-readiness.git"
+  },
+  "homepage": "https://github.com/adkinn/astro-ai-readiness#readme",
+  "bugs": {
+    "url": "https://github.com/adkinn/astro-ai-readiness/issues"
+  },
+  "peerDependencies": {
+    "astro": "^5.0.0 || ^6.0.0"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/schemas/mcp/v1.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/adkinn/astro-ai-readiness/v0.0.7/schemas/mcp/v1.json",
+  "title": "astro-ai-readiness MCP Discovery v1",
+  "description": "Discovery file shape emitted by @adkinn/astro-ai-readiness for /.well-known/mcp.json. Per D-22, includes a toolkit-specific status: 'active' | 'planned' field gating tools (active) vs planned_tools (planned).",
+  "type": "object",
+  "required": ["version", "servers"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": { "type": "string", "format": "uri" },
+    "version": { "type": "string" },
+    "servers": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": ["status", "name", "url", "description", "tools"],
+            "additionalProperties": false,
+            "properties": {
+              "status": { "const": "active" },
+              "name": { "type": "string", "minLength": 1 },
+              "url": { "type": "string", "format": "uri" },
+              "description": { "type": "string", "minLength": 1 },
+              "tools": {
+                "type": "array",
+                "minItems": 1,
+                "items": { "$ref": "#/definitions/tool" }
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": ["status", "name", "description", "planned_tools"],
+            "additionalProperties": false,
+            "properties": {
+              "status": { "const": "planned" },
+              "name": { "type": "string", "minLength": 1 },
+              "description": { "type": "string", "minLength": 1 },
+              "planned_tools": {
+                "type": "array",
+                "minItems": 1,
+                "items": { "$ref": "#/definitions/tool" }
+              }
+            }
+          }
+        ]
+      }
+    }
+  },
+  "definitions": {
+    "tool": {
+      "type": "object",
+      "required": ["name", "description"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "description": { "type": "string", "minLength": 1 }
+      }
+    }
+  }
+}