@eventcatalog/cli 0.4.10 → 0.5.0

package/dist/cli/index.js

@@ -25,8 +25,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 // src/cli/index.ts
 var import_commander = require("commander");
-var import_node_fs4 = require("fs");
-var import_node_path3 = require("path");
+var import_node_fs7 = require("fs");
+var import_node_path6 = require("path");
 
 // src/cli/executor.ts
 var import_node_fs = require("fs");
@@ -497,8 +497,8 @@ ${messages.join("\n")}`);
   }
   return { outputs, program: program2 };
 }
-function extractResourceTypeFolder(path) {
-  const segments = path.split("/");
+function extractResourceTypeFolder(path3) {
+  const segments = path3.split("/");
   let lastTypeFolder = segments[0];
   for (const seg of segments) {
     if (RESOURCE_TYPE_FROM_FOLDER[seg]) {
@@ -690,8 +690,8 @@ function extractServiceContainerRefs(program2, nested = false) {
         ...stmt.ref.version ? { version: stmt.ref.version } : {}
       }));
       if (writesTo.length === 0 && readsFrom.length === 0) continue;
-      const path = buildServiceOutputPath(def.name, body, nested, parentPath);
-      refsByPath.set(path, {
+      const path3 = buildServiceOutputPath(def.name, body, nested, parentPath);
+      refsByPath.set(path3, {
         ...writesTo.length > 0 ? { writesTo } : {},
         ...readsFrom.length > 0 ? { readsFrom } : {}
       });
@@ -782,21 +782,21 @@ function getReader(sdk, type) {
   }
 }
 function promptConfirm(message) {
-  return new Promise((resolve4) => {
+  return new Promise((resolve5) => {
     const rl = (0, import_node_readline.createInterface)({ input: process.stdin, output: process.stdout });
     rl.question(`${message} `, (answer) => {
       rl.close();
       const normalized = answer.trim().toLowerCase();
-      resolve4(normalized === "" || normalized === "y" || normalized === "yes");
+      resolve5(normalized === "" || normalized === "y" || normalized === "yes");
     });
   });
 }
 function promptInput(message, defaultValue) {
-  return new Promise((resolve4) => {
+  return new Promise((resolve5) => {
     const rl = (0, import_node_readline.createInterface)({ input: process.stdin, output: process.stdout });
     rl.question(`${message} `, (answer) => {
       rl.close();
-      resolve4(answer.trim() || defaultValue);
+      resolve5(answer.trim() || defaultValue);
     });
   });
 }
@@ -1152,19 +1152,381 @@ function formatResult(result, dryRun) {
   return lines.join("\n");
 }
 function readStdin() {
-  return new Promise((resolve4, reject) => {
+  return new Promise((resolve5, reject) => {
     const chunks = [];
     process.stdin.on("data", (chunk) => chunks.push(chunk));
-    process.stdin.on("end", () => resolve4(Buffer.concat(chunks).toString("utf-8")));
+    process.stdin.on("end", () => resolve5(Buffer.concat(chunks).toString("utf-8")));
     process.stdin.on("error", reject);
   });
 }
 
+// src/cli/snapshot.ts
+var import_node_path3 = require("path");
+var import_node_fs4 = require("fs");
+var import_sdk5 = __toESM(require("@eventcatalog/sdk"));
+var snapshotCreate = async (opts) => {
+  const dir = (0, import_node_path3.resolve)(opts.dir);
+  const sdk = (0, import_sdk5.default)(dir);
+  const result = await sdk.createSnapshot({
+    label: opts.label,
+    outputDir: opts.output ? (0, import_node_path3.resolve)(opts.output) : void 0
+  });
+  if (opts.stdout) {
+    (0, import_node_fs4.rmSync)(result.filePath, { force: true });
+    return JSON.stringify(result.snapshot, null, 2);
+  }
+  const resources = result.snapshot.resources;
+  const counts = [
+    resources.services.length && `${resources.services.length} services`,
+    resources.messages.events.length && `${resources.messages.events.length} events`,
+    resources.messages.commands.length && `${resources.messages.commands.length} commands`,
+    resources.messages.queries.length && `${resources.messages.queries.length} queries`,
+    resources.domains.length && `${resources.domains.length} domains`,
+    resources.channels.length && `${resources.channels.length} channels`
+  ].filter(Boolean).join(", ");
+  return `Snapshot created: ${result.filePath}
+Resources: ${counts}`;
+};
+var formatDiffText = (diff) => {
+  const lines = [];
+  const labelA = diff.snapshotA.label;
+  const labelB = diff.snapshotB.label;
+  lines.push(`Comparing: ${labelA} vs ${labelB}`);
+  lines.push("");
+  if (diff.resources.length > 0) {
+    lines.push(`Resources (${diff.resources.length} changes):`);
+    for (const r of diff.resources) {
+      const prefix = r.changeType === "added" ? "+" : r.changeType === "removed" ? "-" : r.changeType === "versioned" ? "^" : "~";
+      const version2 = r.changeType === "versioned" ? `${r.previousVersion} -> ${r.newVersion}` : r.version;
+      const fields = r.changedFields ? ` (${r.changedFields.join(", ")})` : "";
+      lines.push(`  ${prefix} ${r.resourceId}@${version2}  [${r.type}] ${r.changeType}${fields}`);
+    }
+    lines.push("");
+  }
+  if (diff.relationships.length > 0) {
+    lines.push(`Relationships (${diff.relationships.length} changes):`);
+    for (const r of diff.relationships) {
+      const prefix = r.changeType === "added" ? "+" : "-";
+      lines.push(
+        `  ${prefix} ${r.serviceId} --${r.direction}--> ${r.resourceId}${r.resourceVersion ? `@${r.resourceVersion}` : ""}`
+      );
+    }
+    lines.push("");
+  }
+  if (diff.summary.totalChanges === 0) {
+    lines.push("No changes detected.");
+  } else {
+    lines.push(`Summary: ${diff.resources.length} resource changes, ${diff.relationships.length} relationship changes`);
+  }
+  return lines.join("\n");
+};
+var snapshotDiff = async (opts) => {
+  const dir = (0, import_node_path3.resolve)(opts.dir);
+  const sdk = (0, import_sdk5.default)(dir);
+  const diff = await sdk.diffSnapshots((0, import_node_path3.resolve)(opts.fileA), (0, import_node_path3.resolve)(opts.fileB));
+  if (opts.format === "json") {
+    return JSON.stringify(diff, null, 2);
+  }
+  return formatDiffText(diff);
+};
+var snapshotList = async (opts) => {
+  const dir = (0, import_node_path3.resolve)(opts.dir);
+  const sdk = (0, import_sdk5.default)(dir);
+  const snapshots = await sdk.listSnapshots();
+  if (opts.format === "json") {
+    return JSON.stringify(snapshots, null, 2);
+  }
+  if (snapshots.length === 0) {
+    return "No snapshots found.";
+  }
+  const lines = ["Snapshots:", ""];
+  for (const s of snapshots) {
+    const git = s.git ? ` (${s.git.branch} ${s.git.commit})` : "";
+    lines.push(`  ${s.label}  ${s.createdAt}${git}`);
+    lines.push(`    ${s.filePath}`);
+  }
+  return lines.join("\n");
+};
+
+// src/cli/governance/rules.ts
+var import_node_fs5 = __toESM(require("fs"));
+var import_node_path4 = __toESM(require("path"));
+var import_js_yaml = __toESM(require("js-yaml"));
+var loadGovernanceConfig = (catalogDir) => {
+  const configPath = import_node_path4.default.join(catalogDir, "governance.yaml");
+  if (!import_node_fs5.default.existsSync(configPath)) {
+    return { rules: [] };
+  }
+  const content = import_node_fs5.default.readFileSync(configPath, "utf-8");
+  const parsed = import_js_yaml.default.load(content);
+  return { rules: parsed?.rules || [] };
+};
+var TRIGGER_FILTERS = {
+  consumer_added: (c2) => c2.direction === "receives" && c2.changeType === "added",
+  consumer_removed: (c2) => c2.direction === "receives" && c2.changeType === "removed",
+  producer_added: (c2) => c2.direction === "sends" && c2.changeType === "added",
+  producer_removed: (c2) => c2.direction === "sends" && c2.changeType === "removed"
+};
+var buildServiceMessageSets = (snapshot2) => {
+  const produces = /* @__PURE__ */ new Map();
+  const consumes = /* @__PURE__ */ new Map();
+  for (const service of snapshot2.resources.services) {
+    const serviceId = service.id;
+    if (service.sends) {
+      const ids = /* @__PURE__ */ new Set();
+      for (const s of service.sends) ids.add(s.id);
+      produces.set(serviceId, ids);
+    }
+    if (service.receives) {
+      const ids = /* @__PURE__ */ new Set();
+      for (const r of service.receives) ids.add(r.id);
+      consumes.set(serviceId, ids);
+    }
+  }
+  return { produces, consumes };
+};
+var matchesResource = (change, resources, messageSets) => {
+  return resources.some((r) => {
+    if (r === "*") return true;
+    if (r.startsWith("service:")) return change.serviceId === r.slice(8);
+    if (r.startsWith("message:")) return change.resourceId === r.slice(8);
+    if (r.startsWith("produces:")) return messageSets?.produces.get(r.slice(9))?.has(change.resourceId) ?? false;
+    if (r.startsWith("consumes:")) return messageSets?.consumes.get(r.slice(9))?.has(change.resourceId) ?? false;
+    return false;
+  });
+};
+var REMOVED_TRIGGERS = /* @__PURE__ */ new Set(["consumer_removed", "producer_removed"]);
+var evaluateGovernanceRules = (diff, config, targetSnapshot, baseSnapshot) => {
+  const results = [];
+  const targetMessageSets = targetSnapshot ? buildServiceMessageSets(targetSnapshot) : void 0;
+  const baseMessageSets = baseSnapshot ? buildServiceMessageSets(baseSnapshot) : void 0;
+  for (const rule of config.rules) {
+    for (const trigger of rule.when) {
+      const filter = TRIGGER_FILTERS[trigger];
+      if (!filter) continue;
+      const messageSets = REMOVED_TRIGGERS.has(trigger) && baseMessageSets ? baseMessageSets : targetMessageSets;
+      const matchedChanges = diff.relationships.filter((c2) => filter(c2) && matchesResource(c2, rule.resources, messageSets));
+      if (matchedChanges.length > 0) {
+        results.push({ rule, trigger, matchedChanges });
+      }
+    }
+  }
+  return results;
+};
+var PRODUCER_TRIGGERS = /* @__PURE__ */ new Set(["producer_added", "producer_removed"]);
+var isProducerTrigger = (trigger) => PRODUCER_TRIGGERS.has(trigger);
+var getChangeVerb = (trigger, changeType) => {
+  const producer = isProducerTrigger(trigger);
+  return changeType === "added" ? producer ? "now producing" : "now consuming" : producer ? "no longer producing" : "no longer consuming";
+};
+var resolveEnvVars = (value) => {
+  return value.replace(/\$([A-Z_][A-Z0-9_]*)/g, (match, varName) => {
+    const envValue = process.env[varName];
+    if (envValue === void 0) {
+      throw new Error(`Environment variable ${varName} is not set`);
+    }
+    return envValue;
+  });
+};
+
+// src/cli/governance/actions.ts
+var import_node_crypto2 = require("crypto");
+var buildMessageTypeMap = (snapshot2) => {
+  const map = /* @__PURE__ */ new Map();
+  for (const event of snapshot2.resources.messages.events) {
+    map.set(event.id, "event");
+  }
+  for (const command of snapshot2.resources.messages.commands) {
+    map.set(command.id, "command");
+  }
+  for (const query of snapshot2.resources.messages.queries) {
+    map.set(query.id, "query");
+  }
+  return map;
+};
+var buildServiceOwnersMap = (snapshot2) => {
+  const map = /* @__PURE__ */ new Map();
+  for (const service of snapshot2.resources.services) {
+    if (service.owners && Array.isArray(service.owners) && service.owners.length > 0) {
+      map.set(service.id, service.owners);
+    }
+  }
+  return map;
+};
+var executeGovernanceActions = async (results, opts = {}) => {
+  const { messageTypes, status, serviceOwners } = opts;
+  const webhookCalls = [];
+  const now = (/* @__PURE__ */ new Date()).toISOString();
+  for (const result of results) {
+    for (const action of result.rule.actions) {
+      if (action.type !== "webhook") continue;
+      const url = resolveEnvVars(action.url);
+      const headers = { "Content-Type": "application/json" };
+      if (action.headers) {
+        for (const [key, value] of Object.entries(action.headers)) {
+          headers[key] = resolveEnvVars(value);
+        }
+      }
+      for (const change of result.matchedChanges) {
+        const verb = getChangeVerb(result.trigger, change.changeType);
+        const messageType = messageTypes?.get(change.resourceId) || "message";
+        const serviceRole = isProducerTrigger(result.trigger) ? "producer" : "consumer";
+        const payload = {
+          specversion: "1.0",
+          type: `eventcatalog.governance.${result.trigger}`,
+          source: "eventcatalog/governance",
+          id: (0, import_node_crypto2.randomUUID)(),
+          time: now,
+          datacontenttype: "application/json",
+          data: {
+            schemaVersion: 1,
+            ...status && { status },
+            summary: `${change.serviceId} is ${verb} the ${messageType} ${change.resourceId}`,
+            [serviceRole]: {
+              id: change.serviceId,
+              version: change.serviceVersion,
+              ...serviceOwners?.get(change.serviceId) && { owners: serviceOwners.get(change.serviceId) }
+            },
+            message: {
+              id: change.resourceId,
+              version: change.resourceVersion,
+              type: messageType
+            }
+          }
+        };
+        webhookCalls.push({
+          urlTemplate: action.url,
+          request: fetch(url, { method: "POST", headers, body: JSON.stringify(payload) })
+        });
+      }
+    }
+  }
+  const settled = await Promise.allSettled(webhookCalls.map((c2) => c2.request));
+  return settled.map((result, i) => {
+    const url = webhookCalls[i].urlTemplate;
+    if (result.status === "fulfilled") {
+      const res = result.value;
+      if (!res.ok) {
+        return `  Webhook failed: ${url} \u2717 (HTTP ${res.status})`;
+      }
+      return `  Webhook sent: ${url} \u2713`;
+    }
+    return `  Webhook failed: ${url} \u2717 (${result.reason instanceof Error ? result.reason.message : String(result.reason)})`;
+  });
+};
+
+// src/cli/governance/format.ts
+var formatGovernanceOutput = (results) => {
+  if (results.length === 0) {
+    return "No governance rules triggered. Catalog is compliant.";
+  }
+  const lines = ["Governance:", ""];
+  for (const result of results) {
+    lines.push(`  Rule "${result.rule.name}" triggered (${result.trigger}):`);
+    for (const change of result.matchedChanges) {
+      const prefix = change.changeType === "added" ? "+" : "-";
+      const verb = getChangeVerb(result.trigger, change.changeType);
+      lines.push(`    ${prefix} ${change.serviceId} is ${verb} ${change.resourceId}`);
+    }
+    lines.push("");
+  }
+  return lines.join("\n");
+};
+
+// src/cli/governance/check.ts
+var import_node_path5 = __toESM(require("path"));
+var import_node_child_process = require("child_process");
+var import_node_fs6 = require("fs");
+var import_node_os = require("os");
+var import_dotenv = __toESM(require("dotenv"));
+var import_sdk6 = __toESM(require("@eventcatalog/sdk"));
+var import_license = require("@eventcatalog/license");
+var BRANCH_NAME_RE = /^[a-zA-Z0-9._\-/]+$/;
+var extractBranchToTempDir = (branch, catalogDir, tempDirs) => {
+  if (!BRANCH_NAME_RE.test(branch)) {
+    throw new Error(`Invalid branch name: "${branch}"`);
+  }
+  const tmpDir = (0, import_node_fs6.mkdtempSync)(import_node_path5.default.join((0, import_node_os.tmpdir)(), "ec-governance-"));
+  tempDirs.push(tmpDir);
+  try {
+    (0, import_node_child_process.execSync)(`git archive ${branch} | tar -x -C ${tmpDir}`, { cwd: catalogDir, stdio: "pipe" });
+  } catch {
+    throw new Error(`Failed to extract branch "${branch}". Is it a valid git branch?`);
+  }
+  return tmpDir;
+};
+var governanceCheck = async (opts) => {
+  const dir = import_node_path5.default.resolve(opts.dir);
+  import_dotenv.default.config({ path: import_node_path5.default.join(dir, ".env") });
+  const isScale = await (0, import_license.isEventCatalogScaleEnabled)();
+  if (!isScale) {
+    throw new Error("Governance requires an EventCatalog Scale plan. Learn more at https://eventcatalog.dev/pricing");
+  }
+  const baseBranch = opts.base || "main";
+  const tempDirs = [];
+  const trackTempDir = (prefix) => {
+    const d = (0, import_node_fs6.mkdtempSync)(import_node_path5.default.join((0, import_node_os.tmpdir)(), prefix));
+    tempDirs.push(d);
+    return d;
+  };
+  try {
+    const baseTmpDir = extractBranchToTempDir(baseBranch, dir, tempDirs);
+    const baseSnapshotDir = trackTempDir("ec-snap-base-");
+    const targetSnapshotDir = trackTempDir("ec-snap-target-");
+    const baseSDK = (0, import_sdk6.default)(baseTmpDir);
+    const baseResult = await baseSDK.createSnapshot({ label: `base-${baseBranch}`, outputDir: baseSnapshotDir });
+    let targetResult;
+    if (opts.target) {
+      const targetTmpDir = extractBranchToTempDir(opts.target, dir, tempDirs);
+      const targetSDK = (0, import_sdk6.default)(targetTmpDir);
+      targetResult = await targetSDK.createSnapshot({ label: `target-${opts.target}`, outputDir: targetSnapshotDir });
+    } else {
+      const targetSDK = (0, import_sdk6.default)(dir);
+      targetResult = await targetSDK.createSnapshot({ label: "current", outputDir: targetSnapshotDir });
+    }
+    const diff = await baseSDK.diffSnapshots(baseResult.filePath, targetResult.filePath);
+    const config = loadGovernanceConfig(dir);
+    if (config.rules.length === 0) {
+      return "No governance.yaml found or no rules defined.";
+    }
+    const results = evaluateGovernanceRules(diff, config, targetResult.snapshot, baseResult.snapshot);
+    const messageTypes = buildMessageTypeMap(targetResult.snapshot);
+    const serviceOwners = buildServiceOwnersMap(targetResult.snapshot);
+    const actionOutput = await executeGovernanceActions(results, {
+      messageTypes,
+      status: opts.status,
+      serviceOwners
+    });
+    if (opts.format === "json") {
+      return JSON.stringify({ baseBranch, target: opts.target || "working directory", results, diff: diff.summary }, null, 2);
+    }
+    const targetLabel = opts.target || "working directory";
+    const lines = [`Governance check: comparing ${targetLabel} against ${baseBranch}`, ""];
+    lines.push(formatGovernanceOutput(results));
+    if (actionOutput.length > 0) {
+      lines.push("");
+      lines.push(...actionOutput);
+    }
+    if (results.length > 0) {
+      const webhookCount = actionOutput.filter((l) => l.includes("Webhook sent")).length;
+      const parts = [`${results.length} rule${results.length === 1 ? "" : "s"} triggered`];
+      if (webhookCount > 0) parts.push(`${webhookCount} webhook${webhookCount === 1 ? "" : "s"} sent`);
+      lines.push("");
+      lines.push(parts.join(", ") + ".");
+    }
+    return lines.join("\n");
+  } finally {
+    for (const d of tempDirs) {
+      (0, import_node_fs6.rmSync)(d, { recursive: true, force: true });
+    }
+  }
+};
+
 // src/cli/index.ts
 var version = "1.0.0";
 try {
-  const packageJsonPath = (0, import_node_path3.resolve)(__dirname, "../../package.json");
-  const packageJson = JSON.parse((0, import_node_fs4.readFileSync)(packageJsonPath, "utf-8"));
+  const packageJsonPath = (0, import_node_path6.resolve)(__dirname, "../../package.json");
+  const packageJson = JSON.parse((0, import_node_fs7.readFileSync)(packageJsonPath, "utf-8"));
   version = packageJson.version;
 } catch {
 }
@@ -1232,6 +1594,58 @@ import_commander.program.command("import [files...]").description("Import EventC
     process.exit(1);
   }
 });
+var snapshot = import_commander.program.command("snapshot").description("Create, diff, and list catalog snapshots");
+snapshot.command("create").description("Take a point-in-time snapshot of the catalog").option("--label <label>", "Human-readable label (default: ISO timestamp)").option("-o, --output <path>", "Output directory for the snapshot file").option("--stdout", "Print JSON to stdout instead of writing a file", false).action(async (opts) => {
+  try {
+    const globalOpts = import_commander.program.opts();
+    const dir = globalOpts.dir || ".";
+    const result = await snapshotCreate({ label: opts.label, output: opts.output, stdout: opts.stdout, dir });
+    console.log(result);
+  } catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exit(1);
+  }
+});
+snapshot.command("diff <fileA> <fileB>").description("Compare two snapshot files and output a structured diff").option("--format <format>", "Output format: text or json", "text").action(async (fileA, fileB, opts) => {
+  try {
+    const globalOpts = import_commander.program.opts();
+    const dir = globalOpts.dir || ".";
+    const result = await snapshotDiff({ fileA, fileB, format: opts.format, dir });
+    console.log(result);
+  } catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exit(1);
+  }
+});
+snapshot.command("list").description("List all snapshots in the catalog").option("--format <format>", "Output format: text or json", "text").action(async (opts) => {
+  try {
+    const globalOpts = import_commander.program.opts();
+    const dir = globalOpts.dir || ".";
+    const result = await snapshotList({ format: opts.format, dir });
+    console.log(result);
+  } catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exit(1);
+  }
+});
+var governance = import_commander.program.command("governance").description("Run governance rules against catalog changes");
+governance.command("check").description("Compare catalog against a base branch and evaluate governance rules").option("--base <branch>", "Base branch to compare against (default: main)").option("--target <branch>", "Target branch to compare (default: current working directory)").option("--format <format>", "Output format: text or json", "text").option("--status <status>", "Status label to include in webhook payloads (e.g. proposed, approved)").action(async (opts) => {
+  try {
+    const globalOpts = import_commander.program.opts();
+    const dir = globalOpts.dir || ".";
+    const result = await governanceCheck({
+      base: opts.base,
+      target: opts.target,
+      format: opts.format,
+      status: opts.status,
+      dir
+    });
+    console.log(result);
+  } catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exit(1);
+  }
+});
 import_commander.program.arguments("<function> [args...]").action(async (functionName, args) => {
   try {
     const options = import_commander.program.opts();