@weave_protocol/ward 0.2.0 → 0.3.1

package/README.md

@@ -160,6 +160,19 @@ const result = evaluateToolCall(policy, "Bash", { command: "curl https://a.examp
 - **Relative paths** resolve against `cwd`.
 - **Strictness:** the strictest result wins (deny, then require_approval, then allow).
 
+### Reporting decisions to the dashboard (0.3.0+)
+
+`reportEvent()` sends an enforcement decision to a local Weave API (`@weave_protocol/api`), which shows it on its dashboard. The Weave adapters, browser guard and Hundredmen call it for you. Its surfaces are `mcp`, `claude-code`, `antigravity`, `msaf`, `browser`, `gemini-cli`, `codex`, `opencode` and `cursor` (the last four from 0.3.1).
+
+```bash
+export WEAVE_DASHBOARD_URL=http://localhost:3000   # where the API runs
+export WEAVE_API_KEY=...                            # the API's key
+```
+
+- **Off by default.** Nothing is sent unless `WEAVE_DASHBOARD_URL` is set.
+- **Sent:** the surface, the decision, the tool name or a URL with its query string removed, and a truncated reason with any argument value stripped. Command text and argument contents are never sent.
+- **Never in the way.** A report never changes a decision, gives up after 250 ms, and never throws.
+
 ---
 
 ## Policy sections

package/dist/index.d.ts

@@ -25,5 +25,7 @@ export { splitSections, normalizeKey } from "./parser/markdown.js";
 export { checkFilesystem, checkNetwork, checkCapability, checkDataEgress, checkBehavioral, matchGlob, normalizePath, canonicalUrl, } from "./enforcer/index.js";
 export type { Decision, CheckResult, RuntimeState } from "./enforcer/index.js";
 export { evaluateToolCall } from "./enforcer/toolcall.js";
+export { reportEvent, dashboardUrl } from "./report.js";
+export type { EnforcementEvent, ReportOptions, ReportSurface, ReportDecision } from "./report.js";
 export type { ToolMapping, ToolCallCheck, ToolCallEvaluation, EvaluateOptions } from "./enforcer/toolcall.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,mBAAmB,YAAY,CAAC;AAGhC,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGnE,OAAO,EACL,eAAe,EACf,YAAY,EACZ,eAAe,EACf,eAAe,EACf,eAAe,EACf,SAAS,EACT,aAAa,EACb,YAAY,GACb,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,mBAAmB,YAAY,CAAC;AAGhC,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGnE,OAAO,EACL,eAAe,EACf,YAAY,EACZ,eAAe,EACf,eAAe,EACf,eAAe,EACf,SAAS,EACT,aAAa,EACb,YAAY,GACb,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClG,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -25,4 +25,5 @@ export { splitSections, normalizeKey } from "./parser/markdown.js";
 // Enforcer
 export { checkFilesystem, checkNetwork, checkCapability, checkDataEgress, checkBehavioral, matchGlob, normalizePath, canonicalUrl, } from "./enforcer/index.js";
 export { evaluateToolCall } from "./enforcer/toolcall.js";
+export { reportEvent, dashboardUrl } from "./report.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAKH,SAAS;AACT,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEnE,WAAW;AACX,OAAO,EACL,eAAe,EACf,YAAY,EACZ,eAAe,EACf,eAAe,EACf,eAAe,EACf,SAAS,EACT,aAAa,EACb,YAAY,GACb,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAKH,SAAS;AACT,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEnE,WAAW;AACX,OAAO,EACL,eAAe,EACf,YAAY,EACZ,eAAe,EACf,eAAe,EACf,eAAe,EACf,SAAS,EACT,aAAa,EACb,YAAY,GACb,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/report.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Report enforcement decisions to a local Weave API dashboard.
+ *
+ * Off unless a dashboard URL is configured (WEAVE_DASHBOARD_URL, or the
+ * `url` option). Reporting never changes a decision and never holds the
+ * caller longer than a short timeout: failures are swallowed.
+ *
+ * Only a summary is sent: the surface, the decision, the tool name or a
+ * URL without its query string, and a truncated reason with any quoted
+ * argument removed. Command text and argument contents are never sent.
+ *
+ * Uses fetch, so it works in Node 18+ and in browsers (no Node built-ins).
+ */
+import type { Decision } from "./enforcer/index.js";
+export type ReportSurface = "mcp" | "claude-code" | "antigravity" | "msaf" | "browser" | "gemini-cli" | "codex" | "opencode" | "cursor";
+export type ReportDecision = Decision | "ipi_detected" | "scan";
+export interface EnforcementEvent {
+    surface: ReportSurface;
+    decision: ReportDecision;
+    /** Tool name, or a URL (its query string and fragment are dropped) */
+    subject: string;
+    reason?: string;
+    /** ms since epoch; defaults to now */
+    timestamp?: number;
+}
+export interface ReportOptions {
+    /** Dashboard base URL, e.g. http://localhost:3000. Default: $WEAVE_DASHBOARD_URL */
+    url?: string;
+    /** API key. Default: $WEAVE_API_KEY */
+    apiKey?: string;
+    /** Default 250ms */
+    timeoutMs?: number;
+}
+/** The dashboard URL reportEvent would use, or undefined when reporting is off. */
+export declare function dashboardUrl(opts?: ReportOptions): string | undefined;
+/**
+ * Send one event to the dashboard. Resolves when sent, failed or timed out;
+ * never rejects. A no-op when no dashboard URL is configured.
+ */
+export declare function reportEvent(event: EnforcementEvent, opts?: ReportOptions): Promise<void>;
+//# sourceMappingURL=report.d.ts.map

package/dist/report.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,MAAM,aAAa,GACrB,KAAK,GACL,aAAa,GACb,aAAa,GACb,MAAM,GACN,SAAS,GACT,YAAY,GACZ,OAAO,GACP,UAAU,GACV,QAAQ,CAAC;AACb,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,cAAc,GAAG,MAAM,CAAC;AAEhE,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,sEAAsE;IACtE,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,oFAAoF;IACpF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oBAAoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,mFAAmF;AACnF,wBAAgB,YAAY,CAAC,IAAI,GAAE,aAAkB,GAAG,MAAM,GAAG,SAAS,CAGzE;AAqBD;;;GAGG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CA0BlG"}

package/dist/report.js

@@ -0,0 +1,73 @@
+/**
+ * Report enforcement decisions to a local Weave API dashboard.
+ *
+ * Off unless a dashboard URL is configured (WEAVE_DASHBOARD_URL, or the
+ * `url` option). Reporting never changes a decision and never holds the
+ * caller longer than a short timeout: failures are swallowed.
+ *
+ * Only a summary is sent: the surface, the decision, the tool name or a
+ * URL without its query string, and a truncated reason with any quoted
+ * argument removed. Command text and argument contents are never sent.
+ *
+ * Uses fetch, so it works in Node 18+ and in browsers (no Node built-ins).
+ */
+const MAX = 200;
+const env = (key) => globalThis.process?.env?.[key];
+/** The dashboard URL reportEvent would use, or undefined when reporting is off. */
+export function dashboardUrl(opts = {}) {
+    const url = opts.url ?? env("WEAVE_DASHBOARD_URL");
+    return url ? url.replace(/\/+$/, "") : undefined;
+}
+/** Strip a URL to origin + path, so tokens in query strings never leave. */
+function safeSubject(subject) {
+    if (/^[a-z][a-z0-9+.-]*:\/\//i.test(subject)) {
+        try {
+            const u = new URL(subject);
+            return `${u.origin}${u.pathname}`.slice(0, MAX);
+        }
+        catch {
+            return "(unparseable URL)";
+        }
+    }
+    return subject.slice(0, MAX);
+}
+/** Drop the "(arg=value)" suffix evaluateToolCall adds, which can hold argument contents. */
+function safeReason(reason) {
+    if (!reason)
+        return undefined;
+    return reason.replace(/\s*\([^()]*\)\s*$/, "").slice(0, MAX);
+}
+/**
+ * Send one event to the dashboard. Resolves when sent, failed or timed out;
+ * never rejects. A no-op when no dashboard URL is configured.
+ */
+export async function reportEvent(event, opts = {}) {
+    const base = dashboardUrl(opts);
+    const doFetch = globalThis.fetch;
+    if (!base || !doFetch)
+        return;
+    const apiKey = opts.apiKey ?? env("WEAVE_API_KEY");
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), opts.timeoutMs ?? 250);
+    try {
+        await doFetch(`${base}/api/v1/events`, {
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...(apiKey ? { "X-API-Key": apiKey } : {}) },
+            body: JSON.stringify({
+                surface: event.surface,
+                decision: event.decision,
+                subject: safeSubject(event.subject),
+                reason: safeReason(event.reason),
+                timestamp: event.timestamp ?? Date.now(),
+            }),
+            signal: controller.signal,
+        });
+    }
+    catch {
+        // The dashboard is optional: never let it affect enforcement.
+    }
+    finally {
+        clearTimeout(timer);
+    }
+}
+//# sourceMappingURL=report.js.map

package/dist/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAmCH,MAAM,GAAG,GAAG,GAAG,CAAC;AAChB,MAAM,GAAG,GAAG,CAAC,GAAW,EAAsB,EAAE,CAC7C,UAAyE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;AAEjG,mFAAmF;AACnF,MAAM,UAAU,YAAY,CAAC,IAAI,GAAkB,EAAE;IACnD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACnD,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACnD,CAAC;AAED,4EAA4E;AAC5E,SAAS,WAAW,CAAC,OAAe;IAClC,IAAI,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;YAC3B,OAAO,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,mBAAmB,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC/B,CAAC;AAED,6FAA6F;AAC7F,SAAS,UAAU,CAAC,MAA0B;IAC5C,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,OAAO,MAAM,CAAC,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,KAAuB,EAAE,IAAI,GAAkB,EAAE;IACjF,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,OAAO,GAAI,UAAuC,CAAC,KAAK,CAAC;IAC/D,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO;QAAE,OAAO;IAE9B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC;IAC1E,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,IAAI,gBAAgB,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;YAC3F,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;gBACnC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC;gBAChC,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE;aACzC,CAAC;YACF,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,8DAA8D;IAChE,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weave_protocol/ward",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "WARD.md — the agent security policy standard. Define what your agents can and cannot do, version-controlled alongside AGENTS.md and SKILL.md.",
   "type": "module",
   "main": "dist/index.js",