@kirkelabs/agent-readiness-scan 0.1.0 → 0.2.0

package/src/index.js

@@ -1,126 +1,127 @@
-/**
- * index.js — the scan orchestrator (public API).
- *
- * Programmatic entry point:
- *   import { scan } from '@kirkelabs/agent-readiness-scan';
- *   const result = await scan('https://example.com');
- *
- * Pre-fetches the target page + robots.txt + 7 .well-known/* paths in
- * parallel, then runs 8 pure check functions against the assembled
- * context. Each check is a synchronous module that exports
- * `meta` ({id, title, weight, why}) and `run(ctx)`.
- */
-
-import { load } from 'cheerio';
-import { fetchAsCrawler, fetchSibling } from './fetcher.js';
-import { generateCustomsDeclaration } from './generators.js';
-
-import * as c01 from './checks/01-per-bot-policy.js';
-import * as c02 from './checks/02-declared-use-signals.js';
-import * as c03 from './checks/03-bot-auth-readiness.js';
-import * as c04 from './checks/04-mcp-exposure.js';
-import * as c05 from './checks/05-agentic-commerce.js';
-import * as c06 from './checks/06-product-offer.js';
-import * as c07 from './checks/07-identity-corroboration.js';
-import * as c08 from './checks/08-source-regulatory.js';
-
-const CHECKS = [c01, c02, c03, c04, c05, c06, c07, c08];
-
-const WELL_KNOWN_PATHS = {
-  securityTxt: '/.well-known/security.txt',
-  mcpServerCard: '/.well-known/mcp/server-card.json',
-  acpManifest: '/.well-known/acp/manifest.json',
-  ucp: '/.well-known/ucp',
-  botAuthDirectory: '/.well-known/http-message-signatures-directory',
-  oauthProtectedResource: '/.well-known/oauth-protected-resource',
-  oauthAuthorizationServer: '/.well-known/oauth-authorization-server',
-};
-
-async function fetchWellKnown(baseUrl, opts) {
-  const entries = await Promise.all(
-    Object.entries(WELL_KNOWN_PATHS).map(async ([key, path]) => {
-      const res = await fetchSibling(baseUrl, path, opts);
-      return [
-        key,
-        {
-          found: res.ok && res.html && res.html.trim().length > 0,
-          content: res.html,
-          headers: res.headers,
-          status: res.status,
-        },
-      ];
-    }),
-  );
-  return Object.fromEntries(entries);
-}
-
-export async function scan(url, opts = {}) {
-  const page = await fetchAsCrawler(url, opts);
-  if (!page.ok && !page.html) {
-    return {
-      url,
-      ok: false,
-      error: page.error || `HTTP ${page.status}`,
-      score: 0,
-      grade: 'F',
-      dimensions: [],
-    };
-  }
-
-  const $ = load(page.html);
-  const [robots, wellKnown] = await Promise.all([
-    fetchSibling(url, '/robots.txt', opts),
-    fetchWellKnown(url, opts),
-  ]);
-
-  const ctx = {
-    $,
-    html: page.html,
-    finalUrl: page.finalUrl,
-    headers: page.headers,
-    robotsTxt: robots.ok ? robots.html : null,
-    wellKnown,
-  };
-
-  const dimensions = [];
-  let weightedSum = 0;
-  let weightTotal = 0;
-
-  for (const mod of CHECKS) {
-    const res = mod.run(ctx);
-    const w = mod.meta.weight;
-    weightedSum += (res.score / res.max) * w;
-    weightTotal += w;
-    dimensions.push({
-      id: mod.meta.id,
-      title: mod.meta.title,
-      why: mod.meta.why,
-      weight: w,
-      score: res.score,
-      max: res.max,
-      findings: res.findings,
-      detail: res.detail || {},
-    });
-  }
-
-  const score = Math.round((weightedSum / weightTotal) * 100);
-  return {
-    url,
-    finalUrl: page.finalUrl,
-    ok: true,
-    status: page.status,
-    scannedAt: new Date().toISOString(),
-    score,
-    grade: grade(score),
-    dimensions,
-    generated: generateCustomsDeclaration(ctx),
-  };
-}
-
-export function grade(s) {
-  if (s >= 90) return 'A';
-  if (s >= 80) return 'B';
-  if (s >= 65) return 'C';
-  if (s >= 50) return 'D';
-  return 'F';
-}
+/**
+ * index.js — the scan orchestrator (public API).
+ *
+ * Programmatic entry point:
+ *   import { scan } from '@kirkelabs/agent-readiness-scan';
+ *   const result = await scan('https://example.com');
+ *
+ * Pre-fetches the target page + robots.txt + 8 .well-known/* paths in
+ * parallel, then runs 8 pure check functions against the assembled
+ * context. Each check is a synchronous module that exports
+ * `meta` ({id, title, weight, why}) and `run(ctx)`.
+ */
+
+import { load } from 'cheerio';
+import { fetchAsCrawler, fetchSibling } from './fetcher.js';
+import { generateCustomsDeclaration } from './generators.js';
+
+import * as c01 from './checks/01-per-bot-policy.js';
+import * as c02 from './checks/02-declared-use-signals.js';
+import * as c03 from './checks/03-bot-auth-readiness.js';
+import * as c04 from './checks/04-mcp-exposure.js';
+import * as c05 from './checks/05-agentic-commerce.js';
+import * as c06 from './checks/06-product-offer.js';
+import * as c07 from './checks/07-identity-corroboration.js';
+import * as c08 from './checks/08-source-regulatory.js';
+
+const CHECKS = [c01, c02, c03, c04, c05, c06, c07, c08];
+
+const WELL_KNOWN_PATHS = {
+  securityTxt: '/.well-known/security.txt',
+  mcpServerCard: '/.well-known/mcp/server-card.json',
+  acpManifest: '/.well-known/acp/manifest.json',
+  ucp: '/.well-known/ucp',
+  agentAccess: '/.well-known/agent-access.json',
+  botAuthDirectory: '/.well-known/http-message-signatures-directory',
+  oauthProtectedResource: '/.well-known/oauth-protected-resource',
+  oauthAuthorizationServer: '/.well-known/oauth-authorization-server',
+};
+
+async function fetchWellKnown(baseUrl, opts) {
+  const entries = await Promise.all(
+    Object.entries(WELL_KNOWN_PATHS).map(async ([key, path]) => {
+      const res = await fetchSibling(baseUrl, path, opts);
+      return [
+        key,
+        {
+          found: res.ok && res.html && res.html.trim().length > 0,
+          content: res.html,
+          headers: res.headers,
+          status: res.status,
+        },
+      ];
+    }),
+  );
+  return Object.fromEntries(entries);
+}
+
+export async function scan(url, opts = {}) {
+  const page = await fetchAsCrawler(url, opts);
+  if (!page.ok && !page.html) {
+    return {
+      url,
+      ok: false,
+      error: page.error || `HTTP ${page.status}`,
+      score: 0,
+      grade: 'F',
+      dimensions: [],
+    };
+  }
+
+  const $ = load(page.html);
+  const [robots, wellKnown] = await Promise.all([
+    fetchSibling(url, '/robots.txt', opts),
+    fetchWellKnown(url, opts),
+  ]);
+
+  const ctx = {
+    $,
+    html: page.html,
+    finalUrl: page.finalUrl,
+    headers: page.headers,
+    robotsTxt: robots.ok ? robots.html : null,
+    wellKnown,
+  };
+
+  const dimensions = [];
+  let weightedSum = 0;
+  let weightTotal = 0;
+
+  for (const mod of CHECKS) {
+    const res = mod.run(ctx);
+    const w = mod.meta.weight;
+    weightedSum += (res.score / res.max) * w;
+    weightTotal += w;
+    dimensions.push({
+      id: mod.meta.id,
+      title: mod.meta.title,
+      why: mod.meta.why,
+      weight: w,
+      score: res.score,
+      max: res.max,
+      findings: res.findings,
+      detail: res.detail || {},
+    });
+  }
+
+  const score = Math.round((weightedSum / weightTotal) * 100);
+  return {
+    url,
+    finalUrl: page.finalUrl,
+    ok: true,
+    status: page.status,
+    scannedAt: new Date().toISOString(),
+    score,
+    grade: grade(score),
+    dimensions,
+    generated: generateCustomsDeclaration(ctx),
+  };
+}
+
+export function grade(s) {
+  if (s >= 90) return 'A';
+  if (s >= 80) return 'B';
+  if (s >= 65) return 'C';
+  if (s >= 50) return 'D';
+  return 'F';
+}