npm - @ainyc/canonry - Versions diffs - 2.9.0 → 2.10.1 - Mend

@ainyc/canonry 2.9.0 → 2.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/assets/assets/{index-U1lA1GKP.js → index-PhLDQh1e.js} +103 -102
package/assets/index.html +1 -1
package/dist/{chunk-FPZUQADO.js → chunk-KWQCQMPY.js} +78 -1
package/dist/{chunk-MGBXRWLX.js → chunk-SZSWQG3J.js} +29 -10
package/dist/cli.js +23 -8
package/dist/index.js +2 -2
package/dist/mcp.js +71 -8
package/package.json +7 -7

package/assets/index.html CHANGED Viewed

@@ -12,7 +12,7 @@
     <link rel="icon" type="image/png" sizes="32x32" href="./favicon-32.png" />
     <link rel="apple-touch-icon" href="./apple-touch-icon.png" />
     <title>Canonry</title>
-    <script type="module" crossorigin src="./assets/index-U1lA1GKP.js"></script>
+    <script type="module" crossorigin src="./assets/index-PhLDQh1e.js"></script>
     <link rel="stylesheet" crossorigin href="./assets/index-CAewPdsZ.css">
   </head>
   <body>

package/dist/{chunk-FPZUQADO.js → chunk-KWQCQMPY.js} RENAMED Viewed

@@ -376,6 +376,18 @@ var runTriggerRequestSchema = z2.object({
   (data) => Number(Boolean(data.location)) + Number(Boolean(data.allLocations)) + Number(Boolean(data.noLocation)) <= 1,
   { message: 'Only one of "location", "allLocations", or "noLocation" may be provided' }
 );
+var runProviderErrorSchema = z2.object({
+  /** Human-readable error message (best-effort extracted from `raw.error.message` / `raw.message`, otherwise the raw text with any `[provider-X]` prefix stripped). */
+  message: z2.string(),
+  /** Original provider response payload, if the underlying error body parsed as JSON. Use this for structured fields like HTTP status, error code, etc. */
+  raw: z2.unknown().optional()
+});
+var runErrorSchema = z2.object({
+  /** Top-level message for runs that failed without a per-provider error (e.g. user cancellation, internal scheduling failures). */
+  message: z2.string().optional(),
+  /** Per-provider errors for visibility-sweep runs that had at least one provider fail. */
+  providers: z2.record(z2.string(), runProviderErrorSchema).optional()
+});
 var runDtoSchema = z2.object({
   id: z2.string(),
   projectId: z2.string(),
@@ -385,9 +397,70 @@ var runDtoSchema = z2.object({
   location: z2.string().nullable().optional(),
   startedAt: z2.string().nullable().optional(),
   finishedAt: z2.string().nullable().optional(),
-  error: z2.string().nullable().optional(),
+  error: runErrorSchema.nullable().optional(),
   createdAt: z2.string()
 });
+var PROVIDER_PREFIX = /^\[provider-[a-zA-Z0-9_-]+\]\s+/;
+function parseProviderErrorMessage(msg) {
+  const stripped = msg.replace(PROVIDER_PREFIX, "");
+  try {
+    const raw = JSON.parse(stripped);
+    if (raw && typeof raw === "object") {
+      const inner = raw;
+      const fromErrorMessage = typeof inner.error?.message === "string" ? inner.error.message : void 0;
+      const fromMessage = typeof inner.message === "string" ? inner.message : void 0;
+      return { message: fromErrorMessage ?? fromMessage ?? stripped, raw };
+    }
+  } catch {
+  }
+  return { message: stripped };
+}
+function parseRunError(raw) {
+  if (!raw) return null;
+  let parsed;
+  try {
+    parsed = JSON.parse(raw);
+  } catch {
+    return { message: raw };
+  }
+  if (!parsed || typeof parsed !== "object") {
+    return { message: raw };
+  }
+  const obj = parsed;
+  const hasProviders = obj.providers && typeof obj.providers === "object";
+  const hasMessage = typeof obj.message === "string";
+  if (hasProviders || hasMessage) {
+    return parsed;
+  }
+  const providers = {};
+  for (const [name, val] of Object.entries(obj)) {
+    providers[name] = parseProviderErrorMessage(typeof val === "string" ? val : JSON.stringify(val));
+  }
+  return { providers };
+}
+function buildRunErrorFromMessages(messages) {
+  const providers = {};
+  for (const [name, msg] of messages) {
+    providers[name] = parseProviderErrorMessage(msg);
+  }
+  return { providers };
+}
+function serializeRunError(err) {
+  return JSON.stringify(err);
+}
+function formatRunErrorOneLine(err) {
+  if (err.providers) {
+    const entries = Object.entries(err.providers);
+    if (entries.length === 1) {
+      const [provider, detail] = entries[0];
+      return `${provider}: ${detail.message}`;
+    }
+    if (entries.length > 1) {
+      return entries.map(([p, d]) => `${p}: ${d.message}`).join(" \u2022 ");
+    }
+  }
+  return err.message ?? "Run failed.";
+}
 var groundingSourceSchema = z2.object({
   uri: z2.string(),
   title: z2.string()
@@ -2131,6 +2204,10 @@ export {
   RunKinds,
   RunTriggers,
   runTriggerRequestSchema,
+  parseRunError,
+  buildRunErrorFromMessages,
+  serializeRunError,
+  formatRunErrorOneLine,
   snapshotRequestSchema,
   scheduleUpsertRequestSchema,
   parseWindow,

package/dist/{chunk-MGBXRWLX.js → chunk-SZSWQG3J.js} RENAMED Viewed

@@ -16,6 +16,7 @@ import {
   authInvalid,
   authRequired,
   brandKeyFromText,
+  buildRunErrorFromMessages,
   categorizeSource,
   categoryLabel,
   competitorBatchRequestSchema,
@@ -36,6 +37,7 @@ import {
   normalizeProjectDomain,
   notFound,
   notImplemented,
+  parseRunError,
   parseWindow,
   projectConfigSchema,
   projectUpsertRequestSchema,
@@ -45,13 +47,14 @@ import {
   runTriggerRequestSchema,
   saveConfigPatch,
   scheduleUpsertRequestSchema,
+  serializeRunError,
   snapshotRequestSchema,
   unsupportedKind,
   validationError,
   visibilityStateFromAnswerMentioned,
   windowCutoff,
   wordpressEnvSchema
-} from "./chunk-FPZUQADO.js";
+} from "./chunk-KWQCQMPY.js";
 import {
   IntelligenceService,
   agentMemory,
@@ -1043,7 +1046,7 @@ async function runRoutes(app, opts) {
     const terminalStatuses = /* @__PURE__ */ new Set(["completed", "partial", "failed", "cancelled"]);
     if (terminalStatuses.has(run.status)) throw runNotCancellable(run.id, run.status);
     const now = (/* @__PURE__ */ new Date()).toISOString();
-    app.db.update(runs).set({ status: "cancelled", finishedAt: now, error: "Cancelled by user" }).where(eq7(runs.id, run.id)).run();
+    app.db.update(runs).set({ status: "cancelled", finishedAt: now, error: serializeRunError({ message: "Cancelled by user" }) }).where(eq7(runs.id, run.id)).run();
     writeAuditLog(app.db, {
       projectId: run.projectId,
       actor: "api",
@@ -1080,7 +1083,7 @@ function formatRun(row) {
     location: row.location,
     startedAt: row.startedAt,
     finishedAt: row.finishedAt,
-    error: row.error,
+    error: parseRunError(row.error),
     createdAt: row.createdAt
   };
 }
@@ -2255,6 +2258,20 @@ function buildCategoryCounts(counts) {
 // ../api-routes/src/intelligence.ts
 import { eq as eq11, desc as desc4, and as and2 } from "drizzle-orm";
+function emptyHealthSnapshot(projectId) {
+  return {
+    id: `no-data:${projectId}`,
+    projectId,
+    runId: null,
+    overallCitedRate: 0,
+    totalPairs: 0,
+    citedPairs: 0,
+    providerBreakdown: {},
+    createdAt: "",
+    status: "no-data",
+    reason: "no-runs-yet"
+  };
+}
 function mapInsightRow(r) {
   return {
     id: r.id,
@@ -2280,7 +2297,8 @@ function mapHealthRow(r) {
     totalPairs: r.totalPairs,
     citedPairs: r.citedPairs,
     providerBreakdown: parseJsonColumn(r.providerBreakdown, {}),
-    createdAt: r.createdAt
+    createdAt: r.createdAt,
+    status: "ready"
   };
 }
 async function intelligenceRoutes(app) {
@@ -2316,7 +2334,7 @@ async function intelligenceRoutes(app) {
     const project = resolveProject(app.db, request.params.name);
     const row = app.db.select().from(healthSnapshots).where(eq11(healthSnapshots.projectId, project.id)).orderBy(desc4(healthSnapshots.createdAt)).limit(1).get();
     if (!row) {
-      throw notFound("Health data for project", request.params.name);
+      return reply.send(emptyHealthSnapshot(project.id));
     }
     return reply.send(mapHealthRow(row));
   });
@@ -4533,10 +4551,11 @@ var routeCatalog = [
     method: "get",
     path: "/api/v1/projects/{name}/health/latest",
     summary: "Get latest health snapshot",
+    description: 'Returns the latest health snapshot. Always 200 once the project exists: when no snapshot exists yet (newly-created project, or only failed runs), the response carries `status: "no-data"` with `reason: "no-runs-yet"` and zeroed metrics. Real snapshots carry `status: "ready"`.',
     tags: ["intelligence"],
     parameters: [nameParameter],
     responses: {
-      200: { description: "Health snapshot returned." },
+      200: { description: "Health snapshot or no-data sentinel returned." },
       404: { description: "Project not found." }
     }
   },
@@ -10279,7 +10298,7 @@ function mapRunRow(row) {
     location: row.location ?? null,
     startedAt: row.startedAt ?? null,
     finishedAt: row.finishedAt ?? null,
-    error: row.error ?? null,
+    error: parseRunError(row.error),
     createdAt: row.createdAt
   };
 }
@@ -13489,10 +13508,10 @@ var JobRunner = class {
       const allFailed = totalSnapshotsInserted === 0 && providerErrors.size > 0;
       const someFailed = providerErrors.size > 0;
       if (allFailed) {
-        const errorDetail = JSON.stringify(Object.fromEntries(providerErrors));
+        const errorDetail = serializeRunError(buildRunErrorFromMessages(providerErrors));
         this.db.update(runs).set({ status: "failed", finishedAt: (/* @__PURE__ */ new Date()).toISOString(), error: errorDetail }).where(eq19(runs.id, runId)).run();
       } else if (someFailed) {
-        const errorDetail = JSON.stringify(Object.fromEntries(providerErrors));
+        const errorDetail = serializeRunError(buildRunErrorFromMessages(providerErrors));
         this.db.update(runs).set({ status: "partial", finishedAt: (/* @__PURE__ */ new Date()).toISOString(), error: errorDetail }).where(eq19(runs.id, runId)).run();
       } else {
         this.db.update(runs).set({ status: "completed", finishedAt: (/* @__PURE__ */ new Date()).toISOString() }).where(eq19(runs.id, runId)).run();
@@ -15295,7 +15314,7 @@ function buildGetHealthTool(ctx) {
   return {
     name: "get_health",
     label: "Get health",
-    description: "Latest visibility health snapshot including overall cited rate, pair counts, and per-provider breakdown.",
+    description: 'Latest visibility health snapshot including overall cited rate, pair counts, and per-provider breakdown. Returns `status: "no-data"` with `reason: "no-runs-yet"` and zeroed metrics for projects with no successful runs yet.',
     parameters: HealthSchema,
     execute: async () => {
       const health = await ctx.client.getHealth(ctx.projectName);

package/dist/cli.js CHANGED Viewed

@@ -17,7 +17,7 @@ import {
   setGoogleAuthConfig,
   showFirstRunNotice,
   trackEvent
-} from "./chunk-MGBXRWLX.js";
+} from "./chunk-SZSWQG3J.js";
 import {
   CcReleaseSyncStatuses,
   CliError,
@@ -29,6 +29,7 @@ import {
   createApiClient,
   determineAnswerMentioned,
   effectiveDomains,
+  formatRunErrorOneLine,
   getConfigDir,
   getConfigPath,
   isEndpointMissing,
@@ -40,7 +41,7 @@ import {
   saveConfig,
   saveConfigPatch,
   usageError
-} from "./chunk-FPZUQADO.js";
+} from "./chunk-KWQCQMPY.js";
 import {
   apiKeys,
   competitors,
@@ -677,7 +678,7 @@ async function backlinksExtract(opts) {
     return;
   }
   if (opts.wait) process.stderr.write("\n");
-  console.log(`Run ${final.id} (${final.status})${final.error ? " \u2014 " + final.error : ""}`);
+  console.log(`Run ${final.id} (${final.status})${final.error ? " \u2014 " + formatRunErrorOneLine(final.error) : ""}`);
 }
 async function backlinksCachePrune(opts) {
   if (!opts.release) {
@@ -4923,7 +4924,14 @@ function printRunDetail(run) {
   if (run.startedAt) console.log(`  Started:  ${run.startedAt}`);
   if (run.finishedAt) console.log(`  Finished: ${run.finishedAt}`);
   if (run.createdAt) console.log(`  Created:  ${run.createdAt}`);
-  if (run.error) console.log(`  Error:    ${run.error}`);
+  if (run.error) {
+    if (run.error.message) console.log(`  Error:    ${run.error.message}`);
+    if (run.error.providers) {
+      for (const [provider, detail] of Object.entries(run.error.providers)) {
+        console.log(`  Error (${provider}): ${detail.message}`);
+      }
+    }
+  }
   if (run.snapshots && run.snapshots.length > 0) {
     console.log(`
   Snapshots: ${run.snapshots.length}`);
@@ -6002,6 +6010,10 @@ async function showHealth(project, opts) {
     console.log(JSON.stringify(health, null, 2));
     return;
   }
+  if (health.status === "no-data") {
+    console.log("No health data yet \u2014 run a sweep first (canonry run <project>).");
+    return;
+  }
   const rate = (health.overallCitedRate * 100).toFixed(1);
   console.log(`Health: ${rate}% cited (${health.citedPairs}/${health.totalPairs} pairs)`);
   console.log("");
@@ -6689,9 +6701,14 @@ Config saved to ${getConfigPath()}`);
 }
 // src/commands/serve.ts
+function resolveServePort(envPort, configPort) {
+  const trimmed = envPort?.trim();
+  if (trimmed) return parseInt(trimmed, 10);
+  return configPort ?? 4100;
+}
 async function serveCommand(format = "text") {
   const config = loadConfig();
-  const port = parseInt(process.env.CANONRY_PORT ?? "4100", 10);
+  const port = resolveServePort(process.env.CANONRY_PORT, config.port);
   const host = process.env.CANONRY_HOST ?? "127.0.0.1";
   config.port = port;
   const db = createClient(config.database);
@@ -6881,11 +6898,9 @@ function applyServerEnv(values) {
   const port = typeof values.port === "string" ? values.port : void 0;
   const host = typeof values.host === "string" ? values.host : void 0;
   const basePath = typeof values["base-path"] === "string" ? values["base-path"] : void 0;
-  process.env.CANONRY_PORT = port ?? "4100";
+  if (port) process.env.CANONRY_PORT = port;
   if (host) process.env.CANONRY_HOST = host;
-  else delete process.env.CANONRY_HOST;
   if (basePath) process.env.CANONRY_BASE_PATH = basePath;
-  else delete process.env.CANONRY_BASE_PATH;
 }
 var SYSTEM_CLI_COMMANDS = [
   {

package/dist/index.js CHANGED Viewed

@@ -1,9 +1,9 @@
 import {
   createServer
-} from "./chunk-MGBXRWLX.js";
+} from "./chunk-SZSWQG3J.js";
 import {
   loadConfig
-} from "./chunk-FPZUQADO.js";
+} from "./chunk-KWQCQMPY.js";
 import "./chunk-PYHANJ3B.js";
 import "./chunk-MLKGABMK.js";
 export {

package/dist/mcp.js CHANGED Viewed

@@ -10,7 +10,7 @@ import {
   projectUpsertRequestSchema,
   runTriggerRequestSchema,
   scheduleUpsertRequestSchema
-} from "./chunk-FPZUQADO.js";
+} from "./chunk-KWQCQMPY.js";
 import "./chunk-MLKGABMK.js";
 // src/mcp/cli.ts
@@ -319,7 +319,7 @@ var canonryMcpTools = [
   defineTool({
     name: "canonry_health_latest",
     title: "Get latest health",
-    description: "Get the latest health snapshot for a Canonry project.",
+    description: 'Get the latest health snapshot for a Canonry project. Always returns a snapshot once the project exists: real data carries `status: "ready"`; newly-created projects (or projects with only failed runs) carry `status: "no-data"` with `reason: "no-runs-yet"` and zeroed metrics.',
     access: "read",
     tier: "monitoring",
     inputSchema: projectInputSchema,
@@ -753,6 +753,7 @@ var CANONRY_MCP_READ_TOOL_COUNT = canonryMcpTools.filter((tool) => tool.access =
 var CANONRY_MCP_CORE_TOOL_COUNT = canonryMcpTools.filter((tool) => tool.tier === "core").length;
 // src/mcp/results.ts
+import { ZodError } from "zod";
 function jsonToolResult(value) {
   const result = value === void 0 ? { ok: true } : value;
   return {
@@ -783,6 +784,15 @@ async function withToolErrors(handler) {
   }
 }
 function toCanonryErrorEnvelope(error) {
+  if (error instanceof ZodError) {
+    return {
+      error: {
+        code: "VALIDATION_ERROR",
+        message: zodErrorMessage(error),
+        details: { issues: error.issues.map(formatZodIssue) }
+      }
+    };
+  }
   if (error instanceof CliError) {
     return {
       error: {
@@ -821,6 +831,15 @@ function hasErrorEnvelope(value) {
   const error = value.error;
   return Boolean(error && typeof error === "object");
 }
+function formatZodIssue(issue) {
+  return { path: issue.path.map(String).join("."), message: issue.message };
+}
+function zodErrorMessage(error) {
+  const first = error.issues[0];
+  if (!first) return "Input validation failed";
+  const path = first.path.map(String).join(".");
+  return path ? `${path}: ${first.message}` : first.message;
+}
 // src/mcp/toolkits.ts
 var CANONRY_MCP_TOOLKIT_NAMES = ["monitoring", "setup", "gsc", "ga", "agent"];
@@ -942,6 +961,7 @@ function createCanonryMcpServerWithCatalog(options = {}) {
     name: "canonry",
     version: PACKAGE_VERSION
   });
+  server.validateToolInput = async (_tool, args) => args;
   const entries = [];
   for (const registryTool of getCanonryMcpTools(scope)) {
     const tool = registryTool;
@@ -954,7 +974,10 @@ function createCanonryMcpServerWithCatalog(options = {}) {
         inputSchema: tool.inputSchema,
         annotations: tool.annotations
       },
-      async (input) => withToolErrors(() => handler(client, input))
+      async (input) => withToolErrors(async () => {
+        const parsed = tool.inputSchema.parse(input ?? {});
+        return handler(client, parsed);
+      })
     );
     entries.push({ tool, registered });
   }
@@ -963,6 +986,9 @@ function createCanonryMcpServerWithCatalog(options = {}) {
   registerMetaTools(server, catalog);
   return { server, catalog };
 }
+var loadToolkitInputSchema = z3.object({
+  name: z3.enum(CANONRY_MCP_TOOLKIT_NAMES).describe("Toolkit name. List options with canonry_help.")
+});
 function registerMetaTools(server, catalog) {
   server.registerTool(
     "canonry_help",
@@ -979,12 +1005,13 @@ function registerMetaTools(server, catalog) {
     {
       title: "Load a Canonry MCP toolkit",
       description: "Register a toolkit's tools for this session and emit notifications/tools/list_changed. Idempotent. Loaded toolkits remain loaded for the rest of the session.",
-      inputSchema: {
-        name: z3.enum(CANONRY_MCP_TOOLKIT_NAMES).describe("Toolkit name. List options with canonry_help.")
-      },
+      inputSchema: loadToolkitInputSchema.shape,
       annotations: { readOnlyHint: false, idempotentHint: true, destructiveHint: false }
     },
-    async ({ name }) => withToolErrors(async () => catalog.loadToolkit(name))
+    async (input) => withToolErrors(async () => {
+      const parsed = loadToolkitInputSchema.parse(input ?? {});
+      return catalog.loadToolkit(parsed.name);
+    })
   );
 }
 function getCanonryMcpTools(scope = "all") {
@@ -992,12 +1019,46 @@ function getCanonryMcpTools(scope = "all") {
 }
 // src/mcp/cli.ts
+var HELP_TEXT = `Usage: canonry-mcp [--read-only | --scope=<all|read-only>] [--eager]
+Stdio MCP adapter over the Canonry public API. Inherits config from
+~/.canonry/config.yaml (or $CANONRY_CONFIG_DIR/config.yaml).
+Flags:
+  --read-only          Expose read tools only
+  --scope=<all|read-only>
+                       Same as --read-only when "read-only"
+  --eager              Load all toolkits at start (skip progressive discovery)
+  --help, -h           Show this message
+Environment variables:
+  CANONRY_MCP_SCOPE    "all" (default) or "read-only"
+  CANONRY_MCP_EAGER    "1" / "true" / "yes" to enable eager mode
+`;
+var HelpRequested = class extends Error {
+  constructor() {
+    super("canonry-mcp --help requested");
+    this.name = "HelpRequested";
+  }
+};
 async function main(argv = process.argv.slice(2)) {
-  const options = parseCliOptions(argv);
+  let options;
+  try {
+    options = parseCliOptions(argv);
+  } catch (error) {
+    if (error instanceof HelpRequested) {
+      process.stderr.write(HELP_TEXT);
+      return;
+    }
+    throw error;
+  }
   const server = createCanonryMcpServer({ scope: options.scope, eager: options.eager });
   await server.connect(new StdioServerTransport());
 }
 function parseCliOptions(argv, env = process.env) {
+  if (argv.includes("--help") || argv.includes("-h")) {
+    throw new HelpRequested();
+  }
   let scope = normalizeScope(env.CANONRY_MCP_SCOPE);
   let eager = parseEagerEnv(env.CANONRY_MCP_EAGER);
   for (let i = 0; i < argv.length; i += 1) {
@@ -1044,6 +1105,8 @@ if (import.meta.url === `file://${process.argv[1]}`) {
   });
 }
 export {
+  HELP_TEXT,
+  HelpRequested,
   main,
   parseCliOptions
 };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@ainyc/canonry",
-  "version": "2.9.0",
+  "version": "2.10.1",
   "type": "module",
   "description": "Agent-first open-source AEO operating platform - track how answer engines cite your domain",
   "license": "FSL-1.1-ALv2",
@@ -59,21 +59,21 @@
     "@types/node-cron": "^3.0.11",
     "tsup": "^8.5.1",
     "tsx": "^4.19.0",
-    "@ainyc/canonry-api-routes": "0.0.0",
     "@ainyc/canonry-config": "0.0.0",
     "@ainyc/canonry-intelligence": "0.0.0",
-    "@ainyc/canonry-contracts": "0.0.0",
     "@ainyc/canonry-db": "0.0.0",
+    "@ainyc/canonry-api-routes": "0.0.0",
     "@ainyc/canonry-integration-bing": "0.0.0",
+    "@ainyc/canonry-integration-commoncrawl": "0.0.0",
     "@ainyc/canonry-integration-google": "0.0.0",
+    "@ainyc/canonry-contracts": "0.0.0",
     "@ainyc/canonry-integration-wordpress": "0.0.0",
     "@ainyc/canonry-provider-cdp": "0.0.0",
-    "@ainyc/canonry-integration-commoncrawl": "0.0.0",
     "@ainyc/canonry-provider-claude": "0.0.0",
-    "@ainyc/canonry-provider-gemini": "0.0.0",
     "@ainyc/canonry-provider-local": "0.0.0",
-    "@ainyc/canonry-provider-openai": "0.0.0",
-    "@ainyc/canonry-provider-perplexity": "0.0.0"
+    "@ainyc/canonry-provider-perplexity": "0.0.0",
+    "@ainyc/canonry-provider-gemini": "0.0.0",
+    "@ainyc/canonry-provider-openai": "0.0.0"
   },
   "scripts": {
     "build": "tsx scripts/copy-agent-assets.ts && tsup && tsx build-web.ts",