@fiducian/alerts 0.4.0

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import type { Violation } from "@fiducian/conductor";
+export interface AlertPayload {
+    source: "fiducia-trace";
+    passed: boolean;
+    violationCount: number;
+    violations: Violation[];
+    specPath?: string;
+}
+export interface AlertOptions {
+    webhookUrl?: string;
+    slackWebhookUrl?: string;
+    specPath?: string;
+}
+export declare function notifyTraceResult(result: {
+    passed: boolean;
+    violations: Violation[];
+}, options: AlertOptions): Promise<{
+    webhook?: boolean;
+    slack?: boolean;
+}>;
+export declare function formatSlackMessage(payload: AlertPayload): string;
+export declare function notifyViolations(violations: Violation[], options: AlertOptions): Promise<{
+    webhook?: boolean;
+    slack?: boolean;
+}>;

package/dist/index.js

@@ -0,0 +1,44 @@
+export async function notifyTraceResult(result, options) {
+    const payload = {
+        source: "fiducia-trace",
+        passed: result.passed,
+        violationCount: result.violations.length,
+        violations: result.violations,
+        specPath: options.specPath,
+    };
+    const sent = {};
+    if (options.webhookUrl) {
+        const res = await fetch(options.webhookUrl, {
+            method: "POST",
+            headers: { "content-type": "application/json" },
+            body: JSON.stringify(payload),
+        });
+        sent.webhook = res.ok;
+    }
+    if (options.slackWebhookUrl) {
+        const text = formatSlackMessage(payload);
+        const res = await fetch(options.slackWebhookUrl, {
+            method: "POST",
+            headers: { "content-type": "application/json" },
+            body: JSON.stringify({ text }),
+        });
+        sent.slack = res.ok;
+    }
+    return sent;
+}
+export function formatSlackMessage(payload) {
+    if (payload.passed) {
+        return `:white_check_mark: *Fiducia Trace* passed${payload.specPath ? ` (\`${payload.specPath}\`)` : ""}`;
+    }
+    const lines = payload.violations.slice(0, 5).map((v) => `• \`${v.contextId}\` — ${v.message}`);
+    return [
+        `:rotating_light: *Fiducia Trace* — ${payload.violationCount} violation(s)`,
+        payload.specPath ? `Spec: \`${payload.specPath}\`` : "",
+        ...lines,
+    ]
+        .filter(Boolean)
+        .join("\n");
+}
+export async function notifyViolations(violations, options) {
+    return notifyTraceResult({ passed: violations.length === 0, violations }, options);
+}

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,26 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { formatSlackMessage } from "./index.js";
+test("formatSlackMessage passes", () => {
+    const msg = formatSlackMessage({
+        source: "fiducia-trace",
+        passed: true,
+        violationCount: 0,
+        violations: [],
+        specPath: "pizza.waltz",
+    });
+    assert.match(msg, /passed/);
+});
+test("formatSlackMessage violations", () => {
+    const violations = [
+        { contextId: "ctx-1", message: "Out-of-order step" },
+    ];
+    const msg = formatSlackMessage({
+        source: "fiducia-trace",
+        passed: false,
+        violationCount: 1,
+        violations,
+    });
+    assert.match(msg, /violation/);
+    assert.match(msg, /ctx-1/);
+});

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@fiducian/alerts",
+  "version": "0.4.0",
+  "description": "Webhook and Slack notifications for Fiducian Trace violations",
+  "license": "AGPL-3.0-or-later",
+  "keywords": ["fiducia", "fiducia", "slack", "webhook", "alerts"],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thesnmc/Fiducian.git",
+    "directory": "trace/packages/alerts"
+  },
+  "publishConfig": { "access": "public" },
+  "files": ["dist"],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@fiducian/conductor": "0.4.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "node --test dist/**/*.test.js",
+    "prepublishOnly": "npm run build"
+  }
+}