@relvehq/agent-ready 0.3.0 → 0.4.0

package/dist/core/report.d.ts

@@ -1,9 +1,11 @@
 import type { HitEvent } from "./config";
+/** Relve's ingest URL, used when AGENT_READY_ENDPOINT is not set. */
+export declare const DEFAULT_HITS_ENDPOINT = "https://relvehq.com/api/agent-ready/v1/hits";
 export interface ReporterOptions {
     /** The venture's dashboard key. */
     key: string;
-    /** Ingest URL that receives { key, event }. */
-    endpoint: string;
+    /** Ingest URL that receives { key, client, event }. Default: Relve's. */
+    endpoint?: string;
     /** Give up after this long. Default 2000 ms. */
     timeoutMs?: number;
     /** Injected for tests. */
@@ -11,5 +13,9 @@ export interface ReporterOptions {
 }
 /** An `onHit` that sends each event to the dashboard. */
 export declare function reporter(opts: ReporterOptions): (event: HitEvent) => Promise<void>;
-/** A reporter from env (AGENT_READY_KEY + AGENT_READY_ENDPOINT), or null when either is missing. */
+/**
+ * A reporter from env, or null when AGENT_READY_KEY is missing.
+ * AGENT_READY_ENDPOINT is optional (Relve's by default); when set it must be
+ * http(s), else null.
+ */
 export declare function reporterFromEnv(env: Record<string, string | undefined>): ((event: HitEvent) => Promise<void>) | null;

package/dist/core/report.js

@@ -2,28 +2,42 @@
 // Measure, the easy way: send every agent visit to a dashboard with one key
 // (changes/agent-ready-engine, "easy setup"). Replaces writing an `onHit`.
 //
-//   AGENT_READY_KEY=ar_live_xxx            (the venture's key)
-//   AGENT_READY_ENDPOINT=https://.../hits  (the dashboard's ingest URL)
+//   AGENT_READY_KEY=ar_live_yoursite          (your key: ar_ + 3-64 of A-Z a-z 0-9 _ -)
+//   AGENT_READY_ENDPOINT=https://.../hits     (optional: another dashboard)
 //
-// `reporter()` returns an `onHit` that POSTs { key, event } as JSON, with a
-// short timeout and keepalive. Fire-and-forget like every `onHit`: it never
-// throws and the response never waits for it.
+// With only AGENT_READY_KEY set, visits go to Relve's dashboard
+// (DEFAULT_HITS_ENDPOINT, changes/agent-ready-telemetry). Nothing is sent
+// unless the key is set: reporting is opt-in.
+//
+// What one report holds: the key, the package version and the HitEvent
+// (time, host, path, how the Markdown was asked for and where it came from,
+// status, tokens, bytes, the visitor's user agent, duration). Never the
+// Markdown, never the visitor's IP.
+//
+// `reporter()` returns an `onHit` that POSTs { key, client, event } as JSON,
+// with a short timeout and keepalive. Fire-and-forget like every `onHit`: it
+// never throws and the response never waits for it.
 //
 // EDGE-SAFE. No Node APIs.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_HITS_ENDPOINT = void 0;
 exports.reporter = reporter;
 exports.reporterFromEnv = reporterFromEnv;
+const version_1 = require("./version");
+/** Relve's ingest URL, used when AGENT_READY_ENDPOINT is not set. */
+exports.DEFAULT_HITS_ENDPOINT = "https://relvehq.com/api/agent-ready/v1/hits";
 /** An `onHit` that sends each event to the dashboard. */
 function reporter(opts) {
     const f = opts.fetch ?? fetch;
+    const endpoint = opts.endpoint ?? exports.DEFAULT_HITS_ENDPOINT;
     return async (event) => {
         const ctl = new AbortController();
         const timer = setTimeout(() => ctl.abort(), opts.timeoutMs ?? 2000);
         try {
-            await f(opts.endpoint, {
+            await f(endpoint, {
                 method: "POST",
                 headers: { "content-type": "application/json", authorization: `Bearer ${opts.key}` },
-                body: JSON.stringify({ key: opts.key, event }),
+                body: JSON.stringify({ key: opts.key, client: `npm/${version_1.PACKAGE_VERSION}`, event }),
                 keepalive: true,
                 signal: ctl.signal,
             });
@@ -36,11 +50,17 @@ function reporter(opts) {
         }
     };
 }
-/** A reporter from env (AGENT_READY_KEY + AGENT_READY_ENDPOINT), or null when either is missing. */
+/**
+ * A reporter from env, or null when AGENT_READY_KEY is missing.
+ * AGENT_READY_ENDPOINT is optional (Relve's by default); when set it must be
+ * http(s), else null.
+ */
 function reporterFromEnv(env) {
     const key = env.AGENT_READY_KEY?.trim();
     const endpoint = env.AGENT_READY_ENDPOINT?.trim();
-    if (!key || !endpoint || !/^https?:\/\//.test(endpoint))
+    if (!key)
+        return null;
+    if (endpoint && !/^https?:\/\//.test(endpoint))
         return null;
-    return reporter({ key, endpoint });
+    return reporter({ key, endpoint: endpoint || undefined });
 }

package/dist/core/version.d.ts

@@ -0,0 +1 @@
+export declare const PACKAGE_VERSION = "0.4.0";

package/dist/core/version.js

@@ -0,0 +1,8 @@
+"use strict";
+// The package version, in one place: the refine user agent and the visit
+// reporter both send it, so Relve can tell which release a venture runs
+// (changes/agent-ready-telemetry). Keep in step with package.json.
+// EDGE-SAFE.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PACKAGE_VERSION = void 0;
+exports.PACKAGE_VERSION = "0.4.0";

package/dist/index.d.ts

@@ -6,7 +6,8 @@ export { buildLlmsTxt, type BuildLlmsOptions } from "./core/llms";
 export { byteLength, etagFor, ifNoneMatchHits, markdownResponse, MARKDOWN_CONTENT_TYPE, type RespondOptions } from "./core/respond";
 export { COMMON_PRIVATE_PATHS, createAgentReady, enabledFromEnv, siteFromEnv, type EasyOptions, type Env } from "./core/easy";
 export { entriesFromUrls, humanize, parseSitemap, sitemapEntries, type ParsedSitemap, type SitemapEntriesOptions } from "./core/sitemap";
-export { reporter, reporterFromEnv, type ReporterOptions } from "./core/report";
+export { DEFAULT_HITS_ENDPOINT, reporter, reporterFromEnv, type ReporterOptions } from "./core/report";
+export { PACKAGE_VERSION } from "./core/version";
 export { ANSWER_BOT_TOKENS, classifyAgent, isAnswerBot, type Bot, type BotKind } from "./proof/bots";
 export { filterHits, memoryHitStore, teeHits, type HitQuery, type HitStore } from "./proof/hits";
 export { formatSummary, summarize, type Count, type HitSummary } from "./proof/stats";

package/dist/index.js

@@ -8,7 +8,8 @@
 //   @relvehq/agent-ready/next/route     Next.js route handler
 // and the Next.js middleware adapter lives at @relvehq/agent-ready/next.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatAudit = exports.blockedBots = exports.auditSite = exports.renderDashboard = exports.summarize = exports.formatSummary = exports.teeHits = exports.memoryHitStore = exports.filterHits = exports.isAnswerBot = exports.classifyAgent = exports.ANSWER_BOT_TOKENS = exports.reporterFromEnv = exports.reporter = exports.sitemapEntries = exports.parseSitemap = exports.humanize = exports.entriesFromUrls = exports.siteFromEnv = exports.enabledFromEnv = exports.createAgentReady = exports.COMMON_PRIVATE_PATHS = exports.MARKDOWN_CONTENT_TYPE = exports.markdownResponse = exports.ifNoneMatchHits = exports.etagFor = exports.byteLength = exports.buildLlmsTxt = exports.jsonLdFacts = exports.hasFrontMatter = exports.frontMatter = exports.estimateTokens = exports.enrich = exports.wantsMarkdown = exports.stripMdSuffix = exports.normalizePath = exports.mdUrlPath = exports.isExcluded = exports.isEnabled = exports.emitHit = exports.defineAgentReady = exports.VIA_HEADER = exports.DEFAULT_NEGOTIATED_CACHE_CONTROL = exports.DEFAULT_INTERNAL_PREFIX = exports.DEFAULT_INTERNAL_HEADER = exports.DEFAULT_CACHE_CONTROL = exports.ALWAYS_EXCLUDE = exports.parseAccept = exports.chooseFormat = void 0;
+exports.blockedBots = exports.auditSite = exports.renderDashboard = exports.summarize = exports.formatSummary = exports.teeHits = exports.memoryHitStore = exports.filterHits = exports.isAnswerBot = exports.classifyAgent = exports.ANSWER_BOT_TOKENS = exports.PACKAGE_VERSION = exports.reporterFromEnv = exports.reporter = exports.DEFAULT_HITS_ENDPOINT = exports.sitemapEntries = exports.parseSitemap = exports.humanize = exports.entriesFromUrls = exports.siteFromEnv = exports.enabledFromEnv = exports.createAgentReady = exports.COMMON_PRIVATE_PATHS = exports.MARKDOWN_CONTENT_TYPE = exports.markdownResponse = exports.ifNoneMatchHits = exports.etagFor = exports.byteLength = exports.buildLlmsTxt = exports.jsonLdFacts = exports.hasFrontMatter = exports.frontMatter = exports.estimateTokens = exports.enrich = exports.wantsMarkdown = exports.stripMdSuffix = exports.normalizePath = exports.mdUrlPath = exports.isExcluded = exports.isEnabled = exports.emitHit = exports.defineAgentReady = exports.VIA_HEADER = exports.DEFAULT_NEGOTIATED_CACHE_CONTROL = exports.DEFAULT_INTERNAL_PREFIX = exports.DEFAULT_INTERNAL_HEADER = exports.DEFAULT_CACHE_CONTROL = exports.ALWAYS_EXCLUDE = exports.parseAccept = exports.chooseFormat = void 0;
+exports.formatAudit = void 0;
 var accept_1 = require("./core/accept");
 Object.defineProperty(exports, "chooseFormat", { enumerable: true, get: function () { return accept_1.chooseFormat; } });
 Object.defineProperty(exports, "parseAccept", { enumerable: true, get: function () { return accept_1.parseAccept; } });
@@ -54,8 +55,11 @@ Object.defineProperty(exports, "humanize", { enumerable: true, get: function ()
 Object.defineProperty(exports, "parseSitemap", { enumerable: true, get: function () { return sitemap_1.parseSitemap; } });
 Object.defineProperty(exports, "sitemapEntries", { enumerable: true, get: function () { return sitemap_1.sitemapEntries; } });
 var report_1 = require("./core/report");
+Object.defineProperty(exports, "DEFAULT_HITS_ENDPOINT", { enumerable: true, get: function () { return report_1.DEFAULT_HITS_ENDPOINT; } });
 Object.defineProperty(exports, "reporter", { enumerable: true, get: function () { return report_1.reporter; } });
 Object.defineProperty(exports, "reporterFromEnv", { enumerable: true, get: function () { return report_1.reporterFromEnv; } });
+var version_1 = require("./core/version");
+Object.defineProperty(exports, "PACKAGE_VERSION", { enumerable: true, get: function () { return version_1.PACKAGE_VERSION; } });
 // Proof: who reads, how much, and how agent-ready a site is.
 var bots_1 = require("./proof/bots");
 Object.defineProperty(exports, "ANSWER_BOT_TOKENS", { enumerable: true, get: function () { return bots_1.ANSWER_BOT_TOKENS; } });

package/dist/refine/check.d.ts

@@ -1,6 +1,6 @@
 import type { PageInput } from "./types";
 import type { PromptSettings } from "./prompts";
-export type IssueKind = "number" | "url" | "frontmatter" | "hash" | "section" | "h1" | "html" | "placeholder" | "tokens" | "empty";
+export type IssueKind = "number" | "url" | "frontmatter" | "hash" | "section" | "h1" | "html" | "placeholder" | "tokens" | "empty" | "plan";
 export interface CheckIssue {
     kind: IssueKind;
     detail: string;
@@ -15,3 +15,5 @@ export interface CheckOptions {
     countTokens?: (text: string) => number;
 }
 export declare function checkDoc(doc: string, input: PageInput, settings: PromptSettings, opts?: CheckOptions): CheckResult;
+/** First-column names of the tables under "## Pricing" / "## Plans" headings. */
+export declare function planNames(prose: string): string[];

package/dist/refine/check.js

@@ -12,6 +12,9 @@
 //   h1           not exactly one H1
 //   html         HTML tags in the document
 //   placeholder  a {{PLACEHOLDER}} or <Template field> left in
+//   plan         a plan named in a "## Pricing" / "## Plans" table that the
+//                input never names (e.g. a made-up "Basic" built from the
+//                prices of other products shown on the page; 2026-10-29)
 //   tokens       over the prompt's token budget
 //   empty        no real body
 //
@@ -20,6 +23,7 @@
 // EDGE-SAFE (pure). It cannot catch a reworded claim; people still read.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkDoc = checkDoc;
+exports.planNames = planNames;
 const enrich_1 = require("../core/enrich");
 const URL_RE = /https?:\/\/[^\s<>()[\]|"'`]+/g;
 const NUM_RE = /\d+(?:[.,]\d+)*/g;
@@ -100,8 +104,47 @@ function checkDoc(doc, input, settings, opts = {}) {
         seen.add(c);
         add("number", n);
     }
+    // Plans: every plan a Pricing / Plans table names must be named in the
+    // input. The number check alone passes a plan stitched together from
+    // prices that are on the page but belong to something else.
+    for (const name of planNames(prose)) {
+        if (!namedIn(haystack, name))
+            add("plan", name);
+    }
     return { ok: issues.length === 0, issues, tokens };
 }
+/** First-column names of the tables under "## Pricing" / "## Plans" headings. */
+function planNames(prose) {
+    const names = [];
+    for (const section of prose.split(/^(?=##\s)/m)) {
+        const heading = /^##\s+(.+)$/m.exec(section);
+        if (!heading || !/^(pricing|plans)\b/i.test(heading[1].trim()))
+            continue;
+        let header = true;
+        for (const line of section.split("\n")) {
+            if (!line.trim().startsWith("|")) {
+                header = true; // a new table starts with its own header row
+                continue;
+            }
+            if (/^\|[\s:|-]+\|?\s*$/.test(line.trim()))
+                continue; // separator row
+            if (header) {
+                header = false;
+                continue;
+            }
+            const cell = line.trim().replace(/^\|/, "").split("|")[0] ?? "";
+            const name = cell.replace(/[*_`]/g, "").replace(/\s+/g, " ").trim();
+            if (name)
+                names.push(name);
+        }
+    }
+    return names;
+}
+/** The name appears in the text as a whole word or phrase, ignoring case and spacing. */
+function namedIn(text, name) {
+    const words = name.split(" ").map(escapeRe).join("\\s+");
+    return new RegExp(`(?<![A-Za-z0-9])${words}(?![A-Za-z0-9])`, "i").test(text);
+}
 /** "1,400" = "1400", "0.10" = "0.1", "05" = "5". */
 function canonNum(s) {
     const plain = s.replace(/,(?=\d{3}\b)/g, "");

package/dist/refine/remote.d.ts

@@ -1,7 +1,8 @@
-export declare const PACKAGE_VERSION = "0.3.0";
+import { PACKAGE_VERSION } from "../core/version";
+export { PACKAGE_VERSION };
 export declare const DEFAULT_REFINE_ENDPOINT = "https://relvehq.com/api/agent-ready/v1/refine";
 export declare const REFINE_MODELS: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini"];
-export declare const USER_AGENT = "agent-ready/0.3.0 (+https://relvehq.com/agent-ready)";
+export declare const USER_AGENT = "agent-ready/0.4.0 (+https://relvehq.com/agent-ready)";
 export type RemoteStatus = "ok" | "unchanged" | "rejected" | "error" | "skipped";
 export interface RemoteItem {
     path: string;

package/dist/refine/remote.js

@@ -52,10 +52,11 @@ exports.savedFingerprint = savedFingerprint;
 exports.refineRemote = refineRemote;
 exports.stopMessage = stopMessage;
 const file_store_1 = require("./file-store");
-exports.PACKAGE_VERSION = "0.3.0";
+const version_1 = require("../core/version");
+Object.defineProperty(exports, "PACKAGE_VERSION", { enumerable: true, get: function () { return version_1.PACKAGE_VERSION; } });
 exports.DEFAULT_REFINE_ENDPOINT = "https://relvehq.com/api/agent-ready/v1/refine";
 exports.REFINE_MODELS = ["gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini"];
-exports.USER_AGENT = `agent-ready/${exports.PACKAGE_VERSION} (+https://relvehq.com/agent-ready)`;
+exports.USER_AGENT = `agent-ready/${version_1.PACKAGE_VERSION} (+https://relvehq.com/agent-ready)`;
 /** Errors that mean every later call would fail the same way: the run stops. */
 const FATAL = new Set(["openai_auth", "openai_quota", "missing_key"]);
 /** The saved JSON's fingerprint, else one built from a local run's sourceHash, else null. */