@eventcatalog/core 4.7.4 → 4.7.5

package/dist/federation/federate.cjs

@@ -31,12 +31,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var federate_exports = {};
 __export(federate_exports, {
   FederationConflictError: () => FederationConflictError,
+  FederationDiagnosticError: () => FederationDiagnosticError,
   federateCatalog: () => federateCatalog
 });
 module.exports = __toCommonJS(federate_exports);
 var import_node_crypto4 = require("crypto");
-var import_promises6 = __toESM(require("fs/promises"), 1);
-var import_node_path6 = __toESM(require("path"), 1);
+var import_promises7 = __toESM(require("fs/promises"), 1);
+var import_node_path7 = __toESM(require("path"), 1);
 var import_sdk3 = __toESM(require("@eventcatalog/sdk"), 1);
 
 // src/eventcatalog-config-file-utils.js
@@ -149,28 +150,287 @@ var createFederationContentCache = (projectDirectory, options = {}) => {
   };
 };
 
-// src/federation/public-assets.ts
-var import_node_crypto2 = require("crypto");
+// src/federation/diagnostics.ts
+var federationRuleDefaults = {
+  "federation/duplicate-source": "error",
+  "federation/type-collision": "error",
+  "federation/pointer-type-mismatch": "error",
+  "federation/facet-disagreement": "error",
+  "federation/asset-collision": "warn",
+  "federation/missing-resource": "warn",
+  "federation/unresolved-version": "warn"
+};
+var resolveFederationRules = (rules = {}) => {
+  for (const [rule, level] of Object.entries(rules)) {
+    if (!Object.hasOwn(federationRuleDefaults, rule)) throw new Error(`Unknown federation rule "${rule}".`);
+    if (level !== "off" && level !== "warn" && level !== "error") {
+      throw new Error(`Invalid level "${String(level)}" for federation rule "${rule}". Expected off, warn, or error.`);
+    }
+  }
+  return { ...federationRuleDefaults, ...rules };
+};
+var getExternalResource = (external) => `${external.id}${external.version === void 0 ? "" : `@${external.version}`}`;
+var getVersionedResource = (id, version) => `${id}${version == null ? "" : `@${version}`}`;
+var getDocumentedResourceType = (type) => {
+  const usesAn = type === "adr" || type === "agent" || type === "entity" || type === "event";
+  return `documented as ${usesAn ? "an" : "a"} ${type}`;
+};
+var getConflictDiagnostic = (conflict, graph) => {
+  const catalogs = { label: "catalogs", value: conflict.sources.join(", ") };
+  switch (conflict.kind) {
+    case "duplicate-source":
+      return {
+        severity: "error",
+        message: "Resource has multiple owners",
+        rule: "federation/duplicate-source",
+        attributes: [
+          { label: "resource", value: conflict.id },
+          catalogs,
+          { label: "resolution", value: "assign a single owning catalog" }
+        ]
+      };
+    case "type-collision": {
+      const types = [
+        ...new Map(
+          graph.entities.filter((entity) => entity.id === conflict.id).map(
+            (entity) => [
+              `${entity.resolvedFrom.source}:${entity.type}`,
+              { label: entity.resolvedFrom.source, value: getDocumentedResourceType(entity.type) }
+            ]
+          )
+        ).values()
+      ];
+      return {
+        severity: "error",
+        message: "Resource ID has conflicting types",
+        rule: "federation/type-collision",
+        attributes: [{ label: "resource", value: conflict.id }, ...types.length > 0 ? types : [catalogs]]
+      };
+    }
+    case "pointer-type-mismatch": {
+      const typeMismatch = /^Expected (.+) but found (.+)$/.exec(conflict.detail ?? "");
+      return {
+        severity: "error",
+        message: "Reference type does not match resource",
+        rule: "federation/pointer-type-mismatch",
+        attributes: [
+          { label: "resource", value: conflict.id },
+          ...typeMismatch ? [
+            { label: "expected type", value: typeMismatch[1] },
+            { label: "actual type", value: typeMismatch[2] }
+          ] : conflict.detail ? [{ label: "detail", value: conflict.detail }] : [],
+          catalogs
+        ]
+      };
+    }
+    case "facet-disagreement":
+      return {
+        severity: "error",
+        message: "Catalogs disagree about this resource",
+        rule: "federation/facet-disagreement",
+        attributes: [
+          { label: "resource", value: conflict.id },
+          ...conflict.detail ? [{ label: "detail", value: conflict.detail }] : [],
+          catalogs
+        ]
+      };
+  }
+};
+var getFederationDiagnostics = (graph, rules = {}) => {
+  const resolvedRules = resolveFederationRules(rules);
+  const diagnostics = graph.conflicts.map((conflict) => getConflictDiagnostic(conflict, graph));
+  for (const external of graph.externals) {
+    const resource = getExternalResource(external);
+    for (const referencedBy of external.referencedBy) {
+      const referrer = graph.entities.find((entity) => entity.id === referencedBy);
+      diagnostics.push({
+        severity: "warning",
+        message: "Referenced EventCatalog resource does not exist",
+        rule: "federation/missing-resource",
+        attributes: [
+          { label: "source catalog", value: referrer?.resolvedFrom.source ?? "unknown" },
+          { label: "referenced by", value: referencedBy },
+          { label: "missing resource", value: resource }
+        ]
+      });
+    }
+  }
+  for (const edge of graph.edges.filter((edge2) => edge2.status === "unresolved")) {
+    const availableVersions = [
+      ...new Set(graph.entities.filter((entity) => entity.id === edge.to).map((entity) => entity.version ?? "unversioned"))
+    ].sort((left, right) => left.localeCompare(right, void 0, { numeric: true }));
+    diagnostics.push({
+      severity: "warning",
+      message: "Referenced EventCatalog resource version does not exist",
+      rule: "federation/unresolved-version",
+      attributes: [
+        { label: "source catalog", value: edge.fromResolvedFrom.source },
+        { label: "referenced by", value: getVersionedResource(edge.from, edge.fromVersion) },
+        { label: "resource", value: edge.to },
+        { label: "requested version", value: edge.pointer ?? "unspecified" },
+        { label: "available versions", value: availableVersions.join(", ") }
+      ]
+    });
+  }
+  for (const warning of graph.warnings) {
+    diagnostics.push({
+      severity: "warning",
+      message: "Asset collision",
+      rule: "federation/asset-collision",
+      attributes: [
+        { label: "asset", value: warning.path },
+        { label: "sources", value: warning.sources.join(", ") },
+        { label: "winner", value: warning.winner },
+        { label: "resolution", value: "last configured source wins" }
+      ]
+    });
+  }
+  return diagnostics.flatMap((diagnostic) => {
+    const level = resolvedRules[diagnostic.rule];
+    if (level === "off") return [];
+    return [{ ...diagnostic, severity: level === "error" ? "error" : "warning" }];
+  }).sort(
+    (left, right) => (left.severity === right.severity ? 0 : left.severity === "error" ? -1 : 1) || left.rule.localeCompare(right.rule) || (left.attributes[0]?.value ?? "").localeCompare(right.attributes[0]?.value ?? "")
+  );
+};
+
+// src/federation/output-transaction.ts
 var import_promises3 = __toESM(require("fs/promises"), 1);
 var import_node_path3 = __toESM(require("path"), 1);
+var getSafePublicPath = (publicDirectory, relativePath) => {
+  const normalizedPath = import_node_path3.default.posix.normalize(relativePath);
+  const unsafe = relativePath.length === 0 || relativePath.includes("\0") || relativePath.includes("\\") || import_node_path3.default.posix.isAbsolute(relativePath) || /^[a-zA-Z]:\//.test(relativePath) || normalizedPath !== relativePath || normalizedPath === ".." || normalizedPath.startsWith("../");
+  if (unsafe) return void 0;
+  const destinationPath = import_node_path3.default.resolve(publicDirectory, relativePath);
+  const relativeDestinationPath = import_node_path3.default.relative(publicDirectory, destinationPath);
+  return relativeDestinationPath !== "" && relativeDestinationPath !== ".." && !relativeDestinationPath.startsWith(`..${import_node_path3.default.sep}`) && !import_node_path3.default.isAbsolute(relativeDestinationPath) ? destinationPath : void 0;
+};
+var beginFederationOutputTransaction = async (projectDirectory, outDir, relativePublicPaths) => {
+  const transactionDirectory = await import_promises3.default.mkdtemp(import_node_path3.default.join(projectDirectory, ".eventcatalog-federation-transaction-"));
+  const previousOutDir = import_node_path3.default.join(transactionDirectory, "federated");
+  const publicBackupDirectory = import_node_path3.default.join(transactionDirectory, "public");
+  const publicDirectory = import_node_path3.default.resolve(projectDirectory, "public");
+  const publicSnapshots = [];
+  const missingPublicDirectories = /* @__PURE__ */ new Set();
+  let hadPreviousOutDir = false;
+  try {
+    for (const relativePath of new Set(relativePublicPaths)) {
+      const destinationPath = getSafePublicPath(publicDirectory, relativePath);
+      if (!destinationPath) continue;
+      try {
+        const stat = await import_promises3.default.lstat(destinationPath);
+        if (!stat.isFile()) continue;
+        const backupPath = import_node_path3.default.join(publicBackupDirectory, `${publicSnapshots.length}`);
+        await import_promises3.default.mkdir(import_node_path3.default.dirname(backupPath), { recursive: true });
+        await import_promises3.default.copyFile(destinationPath, backupPath);
+        publicSnapshots.push({ backupPath, destinationPath, state: "file" });
+      } catch (error) {
+        const code = error.code;
+        if (code === "ENOTDIR") continue;
+        if (code !== "ENOENT") throw error;
+        publicSnapshots.push({ destinationPath, state: "missing" });
+        let directory = import_node_path3.default.dirname(destinationPath);
+        while (directory !== publicDirectory) {
+          try {
+            await import_promises3.default.lstat(directory);
+            break;
+          } catch (directoryError) {
+            const directoryCode = directoryError.code;
+            if (directoryCode === "ENOTDIR") break;
+            if (directoryCode !== "ENOENT") throw directoryError;
+            missingPublicDirectories.add(directory);
+            directory = import_node_path3.default.dirname(directory);
+          }
+        }
+      }
+    }
+    try {
+      await import_promises3.default.rename(outDir, previousOutDir);
+      hadPreviousOutDir = true;
+    } catch (error) {
+      if (error.code !== "ENOENT") throw error;
+    }
+  } catch (error) {
+    await import_promises3.default.rm(transactionDirectory, { recursive: true, force: true });
+    throw error;
+  }
+  return {
+    commit: async () => {
+      await import_promises3.default.rm(transactionDirectory, { recursive: true, force: true }).catch(() => void 0);
+    },
+    rollback: async () => {
+      const rollbackErrors = [];
+      const attempt = async (operation) => {
+        try {
+          await operation();
+        } catch (error) {
+          rollbackErrors.push(error);
+        }
+      };
+      await attempt(() => import_promises3.default.rm(outDir, { recursive: true, force: true }));
+      if (hadPreviousOutDir) await attempt(() => import_promises3.default.rename(previousOutDir, outDir));
+      for (const snapshot of publicSnapshots) {
+        if (snapshot.state === "missing") {
+          await attempt(() => import_promises3.default.rm(snapshot.destinationPath, { force: true }));
+          continue;
+        }
+        await attempt(async () => {
+          await import_promises3.default.mkdir(import_node_path3.default.dirname(snapshot.destinationPath), { recursive: true });
+          await import_promises3.default.copyFile(snapshot.backupPath, snapshot.destinationPath);
+        });
+      }
+      for (const directory of [...missingPublicDirectories].sort((left, right) => right.length - left.length)) {
+        await attempt(async () => {
+          try {
+            await import_promises3.default.rmdir(directory);
+          } catch (error) {
+            if (!["ENOENT", "ENOTEMPTY"].includes(error.code ?? "")) throw error;
+          }
+        });
+      }
+      await attempt(() => import_promises3.default.rm(transactionDirectory, { recursive: true, force: true }));
+      if (rollbackErrors.length > 0) throw new AggregateError(rollbackErrors, "Failed to restore the previous federation output");
+    }
+  };
+};
+var withFederationOutputTransaction = async (projectDirectory, outDir, relativePublicPaths, update) => {
+  const transaction = await beginFederationOutputTransaction(projectDirectory, outDir, relativePublicPaths);
+  try {
+    const result = await update();
+    await transaction.commit();
+    return result;
+  } catch (error) {
+    try {
+      await transaction.rollback();
+    } catch (rollbackError) {
+      throw new AggregateError([error, rollbackError], "Federation failed and the previous output could not be restored");
+    }
+    throw error;
+  }
+};
+
+// src/federation/public-assets.ts
+var import_node_crypto2 = require("crypto");
+var import_promises4 = __toESM(require("fs/promises"), 1);
+var import_node_path4 = __toESM(require("path"), 1);
 var getContentHash2 = (content) => `sha256:${(0, import_node_crypto2.createHash)("sha256").update(content).digest("hex")}`;
 var getFileHash = async (filePath) => {
   try {
-    const stat = await import_promises3.default.lstat(filePath);
-    return stat.isFile() ? getContentHash2(await import_promises3.default.readFile(filePath)) : void 0;
+    const stat = await import_promises4.default.lstat(filePath);
+    return stat.isFile() ? getContentHash2(await import_promises4.default.readFile(filePath)) : void 0;
   } catch (error) {
     if (error.code === "ENOENT") return void 0;
     throw error;
   }
 };
 var getSafePath = (directory, relativePath) => {
-  const normalizedPath = import_node_path3.default.posix.normalize(relativePath);
-  const unsafe = relativePath.length === 0 || relativePath.includes("\0") || relativePath.includes("\\") || import_node_path3.default.posix.isAbsolute(relativePath) || /^[a-zA-Z]:\//.test(relativePath) || normalizedPath !== relativePath || normalizedPath === ".." || normalizedPath.startsWith("../");
+  const normalizedPath = import_node_path4.default.posix.normalize(relativePath);
+  const unsafe = relativePath.length === 0 || relativePath.includes("\0") || relativePath.includes("\\") || import_node_path4.default.posix.isAbsolute(relativePath) || /^[a-zA-Z]:\//.test(relativePath) || normalizedPath !== relativePath || normalizedPath === ".." || normalizedPath.startsWith("../");
   if (unsafe) return void 0;
-  const resolvedDirectory = import_node_path3.default.resolve(directory);
-  const resolvedPath = import_node_path3.default.resolve(resolvedDirectory, relativePath);
-  const relativeResolvedPath = import_node_path3.default.relative(resolvedDirectory, resolvedPath);
-  if (relativeResolvedPath === "" || relativeResolvedPath === ".." || relativeResolvedPath.startsWith(`..${import_node_path3.default.sep}`) || import_node_path3.default.isAbsolute(relativeResolvedPath)) {
+  const resolvedDirectory = import_node_path4.default.resolve(directory);
+  const resolvedPath = import_node_path4.default.resolve(resolvedDirectory, relativePath);
+  const relativeResolvedPath = import_node_path4.default.relative(resolvedDirectory, resolvedPath);
+  if (relativeResolvedPath === "" || relativeResolvedPath === ".." || relativeResolvedPath.startsWith(`..${import_node_path4.default.sep}`) || import_node_path4.default.isAbsolute(relativeResolvedPath)) {
     return void 0;
   }
   return resolvedPath;
@@ -178,23 +438,23 @@ var getSafePath = (directory, relativePath) => {
 var listFiles = async (directory, relativeDirectory = "") => {
   let entries;
   try {
-    entries = await import_promises3.default.readdir(import_node_path3.default.join(directory, relativeDirectory), { withFileTypes: true });
+    entries = await import_promises4.default.readdir(import_node_path4.default.join(directory, relativeDirectory), { withFileTypes: true });
   } catch (error) {
     if (error.code === "ENOENT") return [];
     throw error;
   }
   const files = await Promise.all(
     entries.map(async (entry) => {
-      const relativePath = import_node_path3.default.join(relativeDirectory, entry.name);
+      const relativePath = import_node_path4.default.join(relativeDirectory, entry.name);
       if (entry.isDirectory()) return listFiles(directory, relativePath);
-      return entry.isFile() ? [relativePath.split(import_node_path3.default.sep).join("/")] : [];
+      return entry.isFile() ? [relativePath.split(import_node_path4.default.sep).join("/")] : [];
     })
   );
   return files.flat().sort();
 };
 var pathExists = async (filePath) => {
   try {
-    await import_promises3.default.lstat(filePath);
+    await import_promises4.default.lstat(filePath);
     return true;
   } catch (error) {
     if (error.code === "ENOENT") return false;
@@ -202,27 +462,27 @@ var pathExists = async (filePath) => {
   }
 };
 var hasBlockingParent = async (publicDirectory, destinationPath) => {
-  let currentPath = import_node_path3.default.dirname(destinationPath);
+  let currentPath = import_node_path4.default.dirname(destinationPath);
   while (currentPath !== publicDirectory) {
     try {
-      if (!(await import_promises3.default.lstat(currentPath)).isDirectory()) return true;
+      if (!(await import_promises4.default.lstat(currentPath)).isDirectory()) return true;
     } catch (error) {
       if (error.code !== "ENOENT") throw error;
     }
-    currentPath = import_node_path3.default.dirname(currentPath);
+    currentPath = import_node_path4.default.dirname(currentPath);
   }
   return false;
 };
 var pruneEmptyDirectories = async (publicDirectory, filePath) => {
-  let currentPath = import_node_path3.default.dirname(filePath);
+  let currentPath = import_node_path4.default.dirname(filePath);
   while (currentPath !== publicDirectory) {
     try {
-      await import_promises3.default.rmdir(currentPath);
+      await import_promises4.default.rmdir(currentPath);
     } catch (error) {
       if (!["ENOENT", "ENOTEMPTY"].includes(error.code ?? "")) throw error;
       if (error.code === "ENOTEMPTY") return;
     }
-    currentPath = import_node_path3.default.dirname(currentPath);
+    currentPath = import_node_path4.default.dirname(currentPath);
   }
 };
 var composePublicAssets = async ({
@@ -232,8 +492,8 @@ var composePublicAssets = async ({
   previousFiles = {},
   collisionPaths = /* @__PURE__ */ new Set()
 }) => {
-  const publicDirectory = import_node_path3.default.resolve(projectDirectory, "public");
-  const federatedPublicDirectory = import_node_path3.default.resolve(federatedDirectory, "public");
+  const publicDirectory = import_node_path4.default.resolve(projectDirectory, "public");
+  const federatedPublicDirectory = import_node_path4.default.resolve(federatedDirectory, "public");
   const sourceFiles = await listFiles(federatedPublicDirectory);
   const sourceFileSet = new Set(sourceFiles);
   const managedFiles = /* @__PURE__ */ new Set();
@@ -246,7 +506,7 @@ var composePublicAssets = async ({
     if (sourceFileSet.has(relativePath)) continue;
     const destinationPath = getSafePath(publicDirectory, relativePath);
     if (!destinationPath) continue;
-    await import_promises3.default.rm(destinationPath, { force: true });
+    await import_promises4.default.rm(destinationPath, { force: true });
     await pruneEmptyDirectories(publicDirectory, destinationPath);
     removed += 1;
   }
@@ -268,31 +528,31 @@ var composePublicAssets = async ({
     }
     const asset = publicAssetsByPath.get(relativePath);
     if (!asset) throw new Error(`Cannot identify the source of federated public asset "${relativePath}"`);
-    const content = await import_promises3.default.readFile(sourcePath);
-    await import_promises3.default.mkdir(import_node_path3.default.dirname(destinationPath), { recursive: true });
-    await import_promises3.default.writeFile(destinationPath, content);
+    const content = await import_promises4.default.readFile(sourcePath);
+    await import_promises4.default.mkdir(import_node_path4.default.dirname(destinationPath), { recursive: true });
+    await import_promises4.default.writeFile(destinationPath, content);
     files[relativePath] = { source: asset.resolvedFrom.source, hash: getContentHash2(content) };
     copied += 1;
     if (collisionPaths.has(`public/${relativePath}`)) overwritten += 1;
   }
-  await import_promises3.default.rm(federatedPublicDirectory, { recursive: true, force: true });
+  await import_promises4.default.rm(federatedPublicDirectory, { recursive: true, force: true });
   return { files, copied, skipped, overwritten, removed };
 };
 
 // src/federation/filesystem-source-provider.ts
 var import_node_crypto3 = require("crypto");
-var import_promises4 = __toESM(require("fs/promises"), 1);
-var import_node_path4 = __toESM(require("path"), 1);
+var import_promises5 = __toESM(require("fs/promises"), 1);
+var import_node_path5 = __toESM(require("path"), 1);
 var import_sdk = __toESM(require("@eventcatalog/sdk"), 1);
 var FILESYSTEM_SOURCE_PREFIX = "file:";
 var isWithinDirectory = (directory, target) => {
-  const relativePath = import_node_path4.default.relative(directory, target);
-  return relativePath === "" || !relativePath.startsWith(`..${import_node_path4.default.sep}`) && relativePath !== ".." && !import_node_path4.default.isAbsolute(relativePath);
+  const relativePath = import_node_path5.default.relative(directory, target);
+  return relativePath === "" || !relativePath.startsWith(`..${import_node_path5.default.sep}`) && relativePath !== ".." && !import_node_path5.default.isAbsolute(relativePath);
 };
 var assertPortableRelativePath = (filePath, label, allowRoot = true) => {
   const portablePath = filePath.replaceAll("\\", "/");
-  const normalizedPath = import_node_path4.default.posix.normalize(portablePath);
-  const isUnsafe = filePath.includes("\\") || filePath.includes("\0") || import_node_path4.default.posix.isAbsolute(normalizedPath) || /^[a-zA-Z]:\//.test(normalizedPath) || normalizedPath === ".." || normalizedPath.startsWith("../") || !allowRoot && (normalizedPath === "." || normalizedPath === "");
+  const normalizedPath = import_node_path5.default.posix.normalize(portablePath);
+  const isUnsafe = filePath.includes("\\") || filePath.includes("\0") || import_node_path5.default.posix.isAbsolute(normalizedPath) || /^[a-zA-Z]:\//.test(normalizedPath) || normalizedPath === ".." || normalizedPath.startsWith("../") || !allowRoot && (normalizedPath === "." || normalizedPath === "");
   if (isUnsafe) throw new Error(`${label} "${filePath}" escapes its filesystem source`);
   return normalizedPath;
 };
@@ -302,22 +562,22 @@ var getSourceRoot = (projectDirectory, source) => {
   }
   const locator = source.source.slice(FILESYSTEM_SOURCE_PREFIX.length);
   if (!locator.trim()) throw new Error(`Filesystem federation source "${source.id}" requires a path after "file:".`);
-  return import_node_path4.default.resolve(projectDirectory, locator);
+  return import_node_path5.default.resolve(projectDirectory, locator);
 };
 var getCatalogDirectory = async (projectDirectory, source) => {
   if (source.ref) throw new Error(`Filesystem federation source "${source.id}" does not support "ref".`);
   const sourceRoot = getSourceRoot(projectDirectory, source);
   const catalogPath = assertPortableRelativePath(source.path ?? ".", "Catalog path");
-  const catalogDirectory = import_node_path4.default.resolve(sourceRoot, ...catalogPath.split("/"));
+  const catalogDirectory = import_node_path5.default.resolve(sourceRoot, ...catalogPath.split("/"));
   if (!isWithinDirectory(sourceRoot, catalogDirectory)) {
     throw new Error(`Catalog path "${source.path}" escapes source "${source.id}"`);
   }
   try {
-    const [realSourceRoot, realCatalogDirectory] = await Promise.all([import_promises4.default.realpath(sourceRoot), import_promises4.default.realpath(catalogDirectory)]);
+    const [realSourceRoot, realCatalogDirectory] = await Promise.all([import_promises5.default.realpath(sourceRoot), import_promises5.default.realpath(catalogDirectory)]);
     if (!isWithinDirectory(realSourceRoot, realCatalogDirectory)) {
       throw new Error(`Catalog path "${source.path}" escapes source "${source.id}"`);
     }
-    if (!(await import_promises4.default.stat(realCatalogDirectory)).isDirectory()) {
+    if (!(await import_promises5.default.stat(realCatalogDirectory)).isDirectory()) {
       throw new Error(`Filesystem federation source "${source.id}" is not a directory: ${catalogDirectory}`);
     }
     return realCatalogDirectory;
@@ -330,12 +590,12 @@ var getCatalogDirectory = async (projectDirectory, source) => {
 };
 var getArtifactPath = async (catalogDirectory, source, artifactPath) => {
   const normalizedPath = assertPortableRelativePath(artifactPath, "Federated artifact path", false);
-  const filePath = import_node_path4.default.resolve(catalogDirectory, ...normalizedPath.split("/"));
+  const filePath = import_node_path5.default.resolve(catalogDirectory, ...normalizedPath.split("/"));
   if (!isWithinDirectory(catalogDirectory, filePath)) {
     throw new Error(`Federated artifact path "${artifactPath}" escapes source "${source.id}"`);
   }
   try {
-    const realFilePath = await import_promises4.default.realpath(filePath);
+    const realFilePath = await import_promises5.default.realpath(filePath);
     if (!isWithinDirectory(catalogDirectory, realFilePath)) {
       throw new Error(`Federated artifact path "${artifactPath}" escapes source "${source.id}"`);
     }
@@ -362,15 +622,15 @@ var createFileSystemSourceProvider = (projectDirectory) => ({
   },
   async fetchContent({ source, path: artifactPath }) {
     const catalogDirectory = await getCatalogDirectory(projectDirectory, source);
-    return import_promises4.default.readFile(await getArtifactPath(catalogDirectory, source, artifactPath));
+    return import_promises5.default.readFile(await getArtifactPath(catalogDirectory, source, artifactPath));
   }
 });
 
 // src/federation/github-source-provider.ts
 var import_node_child_process = require("child_process");
-var import_promises5 = __toESM(require("fs/promises"), 1);
+var import_promises6 = __toESM(require("fs/promises"), 1);
 var import_node_os2 = __toESM(require("os"), 1);
-var import_node_path5 = __toESM(require("path"), 1);
+var import_node_path6 = __toESM(require("path"), 1);
 var import_node_util = require("util");
 var import_sdk2 = __toESM(require("@eventcatalog/sdk"), 1);
 var execFileAsync = (0, import_node_util.promisify)(import_node_child_process.execFile);
@@ -381,8 +641,8 @@ var parseGitHubSource = (source) => {
 };
 var assertSafeCatalogPath = (source) => {
   const catalogPath = source.path ?? ".";
-  const normalized = import_node_path5.default.posix.normalize(catalogPath.replaceAll("\\", "/"));
-  if (catalogPath.includes("\\") || import_node_path5.default.posix.isAbsolute(normalized) || normalized === ".." || normalized.startsWith("../")) {
+  const normalized = import_node_path6.default.posix.normalize(catalogPath.replaceAll("\\", "/"));
+  if (catalogPath.includes("\\") || import_node_path6.default.posix.isAbsolute(normalized) || normalized === ".." || normalized.startsWith("../")) {
     throw new Error(`Catalog path "${catalogPath}" escapes source "${source.id}"`);
   }
 };
@@ -425,8 +685,8 @@ var getGitEnvironment = (token) => {
 };
 var createCheckout = (executeFile, token) => async (source, ref, callback) => {
   const { owner, repository } = parseGitHubSource(source);
-  const catalogPath = import_node_path5.default.posix.normalize(source.path ?? ".");
-  const directory = await import_promises5.default.mkdtemp(import_node_path5.default.join(import_node_os2.default.tmpdir(), "eventcatalog-federation-"));
+  const catalogPath = import_node_path6.default.posix.normalize(source.path ?? ".");
+  const directory = await import_promises6.default.mkdtemp(import_node_path6.default.join(import_node_os2.default.tmpdir(), "eventcatalog-federation-"));
   const env = getGitEnvironment(token);
   try {
     const git = (args) => executeFile("git", args, { cwd: directory, env, encoding: "utf8" });
@@ -440,22 +700,22 @@ var createCheckout = (executeFile, token) => async (source, ref, callback) => {
     await git(["checkout", "--quiet", "--detach", "FETCH_HEAD"]);
     return await callback(directory);
   } finally {
-    await import_promises5.default.rm(directory, { recursive: true, force: true });
+    await import_promises6.default.rm(directory, { recursive: true, force: true });
   }
 };
 var generateIndex = async (source, ref, checkout, executeFile) => checkout(source, ref, async (directory) => {
   const { stdout } = await executeFile("git", ["rev-parse", "HEAD"], { cwd: directory, encoding: "utf8" });
   const commit = stdout.trim();
-  const catalogDirectory = import_node_path5.default.resolve(directory, source.path ?? ".");
-  const relativeCatalogDirectory = import_node_path5.default.relative(directory, catalogDirectory);
-  if (relativeCatalogDirectory.startsWith("..") || import_node_path5.default.isAbsolute(relativeCatalogDirectory)) {
+  const catalogDirectory = import_node_path6.default.resolve(directory, source.path ?? ".");
+  const relativeCatalogDirectory = import_node_path6.default.relative(directory, catalogDirectory);
+  if (relativeCatalogDirectory.startsWith("..") || import_node_path6.default.isAbsolute(relativeCatalogDirectory)) {
     throw new Error(`Catalog path "${source.path}" escapes source "${source.id}"`);
   }
   const index = await (0, import_sdk2.default)(catalogDirectory).buildIndex({ source: source.id, commit });
   return { bytes: Buffer.from(JSON.stringify(index)), index, commit, generated: true };
 });
 var fetchPublishedIndex = async (source, ref, fetcher, token) => {
-  const indexPath = import_node_path5.default.posix.join(source.path ?? ".", "catalog.index.json");
+  const indexPath = import_node_path6.default.posix.join(source.path ?? ".", "catalog.index.json");
   const bytes = await fetchBytes(source, ref, indexPath, fetcher, token);
   if (!bytes) return void 0;
   const index = (0, import_sdk2.parseIndex)(JSON.parse(bytes.toString("utf8")));
@@ -478,7 +738,7 @@ var createGitHubSourceProvider = (options = {}) => {
     },
     async fetchContent({ source, commit, path: artifactPath }) {
       assertSafeCatalogPath(source);
-      const catalogPath = import_node_path5.default.posix.join(source.path ?? ".", artifactPath);
+      const catalogPath = import_node_path6.default.posix.join(source.path ?? ".", artifactPath);
       const content = await fetchBytes(source, commit, catalogPath, fetcher, token);
       if (!content) throw new Error(`Federated artifact not found for "${source.id}": ${artifactPath}`);
       return content;
@@ -516,6 +776,16 @@ ${details}`);
     this.conflicts = conflicts;
   }
 };
+var FederationDiagnosticError = class extends Error {
+  diagnostics;
+  constructor(diagnostics) {
+    const details = diagnostics.map((diagnostic) => `${diagnostic.rule}: ${diagnostic.message}`).join("\n");
+    super(`Federation diagnostics prevent hydration:
+${details}`);
+    this.name = "FederationDiagnosticError";
+    this.diagnostics = diagnostics;
+  }
+};
 var validateSources = (sources) => {
   const ids = /* @__PURE__ */ new Set();
   for (const source of sources) {
@@ -524,19 +794,46 @@ var validateSources = (sources) => {
     ids.add(source.id);
   }
 };
+var createDiagnosticGraph = (graph, ownershipGraph, remoteSourceIds, localSourceId) => {
+  const edges = ownershipGraph.edges.filter((edge) => remoteSourceIds.has(edge.fromResolvedFrom.source));
+  const externalsByPointer = /* @__PURE__ */ new Map();
+  for (const edge of edges.filter((edge2) => edge2.status === "external")) {
+    const version = edge.pointer ?? void 0;
+    const key = `${edge.to}@${version ?? ""}`;
+    const external = externalsByPointer.get(key) ?? {
+      id: edge.to,
+      ...version === void 0 ? {} : { version },
+      referencedBy: []
+    };
+    if (!external.referencedBy.includes(edge.from)) external.referencedBy.push(edge.from);
+    externalsByPointer.set(key, external);
+  }
+  return {
+    ...graph,
+    entities: [
+      ...graph.entities,
+      ...ownershipGraph.entities.filter(
+        (entity) => entity.resolvedFrom.source === localSourceId && entity.resolvedFrom.commit === "local"
+      )
+    ],
+    edges,
+    conflicts: ownershipGraph.conflicts,
+    externals: [...externalsByPointer.values()]
+  };
+};
 var writeLock = async (lockPath, lock) => {
   const temporaryPath = `${lockPath}.tmp-${process.pid}`;
   try {
-    await import_promises6.default.writeFile(temporaryPath, `${JSON.stringify(lock, null, 2)}
+    await import_promises7.default.writeFile(temporaryPath, `${JSON.stringify(lock, null, 2)}
 `, "utf8");
-    await import_promises6.default.rename(temporaryPath, lockPath);
+    await import_promises7.default.rename(temporaryPath, lockPath);
   } finally {
-    await import_promises6.default.rm(temporaryPath, { force: true });
+    await import_promises7.default.rm(temporaryPath, { force: true });
   }
 };
 var readLock = async (lockPath) => {
   try {
-    return JSON.parse(await import_promises6.default.readFile(lockPath, "utf8"));
+    return JSON.parse(await import_promises7.default.readFile(lockPath, "utf8"));
   } catch (error) {
     if (error.code === "ENOENT") return void 0;
     throw new Error(`Cannot read federation lock at "${lockPath}"`, { cause: error });
@@ -544,7 +841,7 @@ var readLock = async (lockPath) => {
 };
 var pathExists2 = async (filePath) => {
   try {
-    await import_promises6.default.access(filePath);
+    await import_promises7.default.access(filePath);
     return true;
   } catch (error) {
     if (error.code === "ENOENT") return false;
@@ -552,20 +849,27 @@ var pathExists2 = async (filePath) => {
   }
 };
 var cleanupPreviousFederation = async (projectDirectory, onProgress) => {
-  const outDir = import_node_path6.default.join(projectDirectory, "federated");
-  const lockPath = import_node_path6.default.join(projectDirectory, "eventcatalog.lock");
+  const outDir = import_node_path7.default.join(projectDirectory, "federated");
+  const lockPath = import_node_path7.default.join(projectDirectory, "eventcatalog.lock");
   const previousLock = await readLock(lockPath);
   const hadFederatedOutput = await pathExists2(outDir);
   const hadLock = previousLock !== void 0;
   if (!hadFederatedOutput && !hadLock) return;
-  await import_promises6.default.rm(outDir, { recursive: true, force: true });
-  const publicResult = await composePublicAssets({
+  const publicResult = await withFederationOutputTransaction(
     projectDirectory,
-    federatedDirectory: outDir,
-    assets: [],
-    previousFiles: previousLock?.publicFiles
-  });
-  await import_promises6.default.rm(lockPath, { force: true });
+    outDir,
+    Object.keys(previousLock?.publicFiles ?? {}),
+    async () => {
+      const result = await composePublicAssets({
+        projectDirectory,
+        federatedDirectory: outDir,
+        assets: [],
+        previousFiles: previousLock?.publicFiles
+      });
+      await import_promises7.default.rm(lockPath, { force: true });
+      return result;
+    }
+  );
   onProgress?.({
     type: "cleanup:complete",
     federated: hadFederatedOutput,
@@ -587,6 +891,7 @@ var federateCatalog = async (projectDirectory, options = {}) => {
     );
   }
   validateSources(sources);
+  const rules = resolveFederationRules(config.federation?.rules);
   if (options.useCache === false) options.onProgress?.({ type: "cache:disabled" });
   const provider = options.provider ?? createFederationSourceProvider(projectDirectory);
   const resolvedSources = [];
@@ -610,8 +915,8 @@ var federateCatalog = async (projectDirectory, options = {}) => {
       throw new Error(`Failed to federate source "${source.id}": ${message}`, { cause: error });
     }
   }
-  const outDir = import_node_path6.default.join(projectDirectory, "federated");
-  const lockPath = import_node_path6.default.join(projectDirectory, "eventcatalog.lock");
+  const outDir = import_node_path7.default.join(projectDirectory, "federated");
+  const lockPath = import_node_path7.default.join(projectDirectory, "eventcatalog.lock");
   const previousLock = await readLock(lockPath);
   const resources = resolvedSources.reduce((total, source) => total + source.resolved.index.resources.length, 0);
   const remoteIndexes = resolvedSources.map(({ resolved }) => resolved.index);
@@ -625,60 +930,79 @@ var federateCatalog = async (projectDirectory, options = {}) => {
   options.onProgress?.({ type: "local:complete", resources: localIndex.resources.length });
   options.onProgress?.({ type: "resolving", resources, localResources: localIndex.resources.length });
   const ownershipGraph = (0, import_sdk3.resolve)([localIndex, ...remoteIndexes]);
-  if (ownershipGraph.conflicts.length > 0) {
-    options.onProgress?.({ type: "resolved", graph: ownershipGraph });
-    throw new FederationConflictError(ownershipGraph.conflicts);
-  }
   const graph = (0, import_sdk3.resolve)(remoteIndexes);
-  options.onProgress?.({ type: "resolved", graph });
-  const sourcesById = new Map(sources.map((source) => [source.id, source]));
-  options.onProgress?.({ type: "hydrating", outDir });
-  let hydratedFiles = 0;
-  let cachedFiles = 0;
-  const hydrateResult = await (0, import_sdk3.hydrate)(graph, {
+  const diagnosticGraph = createDiagnosticGraph(
+    graph,
+    ownershipGraph,
+    new Set(remoteIndexes.map((index) => index.source)),
+    localIndex.source
+  );
+  const diagnostics = getFederationDiagnostics(diagnosticGraph, rules);
+  options.onProgress?.({ type: "resolved", graph, diagnostics });
+  const blockingConflicts = ownershipGraph.conflicts.filter((conflict) => rules[`federation/${conflict.kind}`] === "error");
+  if (blockingConflicts.length > 0) throw new FederationConflictError(blockingConflicts);
+  const blockingDiagnostics = diagnostics.filter((diagnostic) => diagnostic.severity === "error");
+  if (blockingDiagnostics.length > 0) throw new FederationDiagnosticError(blockingDiagnostics);
+  const publicPaths = [
+    ...Object.keys(previousLock?.publicFiles ?? {}),
+    ...graph.assets.filter((asset) => asset.path.startsWith("public/")).map((asset) => asset.path.slice("public/".length))
+  ];
+  const { hydrateResult, publicResult } = await withFederationOutputTransaction(
+    projectDirectory,
     outDir,
-    cache: createFederationContentCache(projectDirectory, {
-      read: options.useCache !== false,
-      onHit: () => {
-        cachedFiles += 1;
-        options.onProgress?.({ type: "hydrate:cache", files: cachedFiles });
-      }
-    }),
-    modes: Object.fromEntries(sources.map((source) => [source.id, source.mode ?? "hydrate"])),
-    fetch: async ({ source: sourceId, commit, path: artifactPath }) => {
-      const source = sourcesById.get(sourceId);
-      if (!source) throw new Error(`Cannot fetch content for unconfigured source "${sourceId}"`);
-      const content = await provider.fetchContent({ source, commit, path: artifactPath });
-      hydratedFiles += 1;
-      options.onProgress?.({ type: "hydrate:file", files: hydratedFiles, source: sourceId, path: artifactPath });
-      return content;
+    publicPaths,
+    async () => {
+      const sourcesById = new Map(sources.map((source) => [source.id, source]));
+      options.onProgress?.({ type: "hydrating", outDir });
+      let hydratedFiles = 0;
+      let cachedFiles = 0;
+      const hydrateResult2 = await (0, import_sdk3.hydrate)(graph, {
+        outDir,
+        cache: createFederationContentCache(projectDirectory, {
+          read: options.useCache !== false,
+          onHit: () => {
+            cachedFiles += 1;
+            options.onProgress?.({ type: "hydrate:cache", files: cachedFiles });
+          }
+        }),
+        fetch: async ({ source: sourceId, commit, path: artifactPath }) => {
+          const source = sourcesById.get(sourceId);
+          if (!source) throw new Error(`Cannot fetch content for unconfigured source "${sourceId}"`);
+          const content = await provider.fetchContent({ source, commit, path: artifactPath });
+          hydratedFiles += 1;
+          options.onProgress?.({ type: "hydrate:file", files: hydratedFiles, source: sourceId, path: artifactPath });
+          return content;
+        }
+      });
+      const publicResult2 = await composePublicAssets({
+        projectDirectory,
+        federatedDirectory: outDir,
+        assets: graph.assets,
+        previousFiles: previousLock?.publicFiles,
+        collisionPaths: new Set(
+          graph.warnings.filter((warning) => warning.kind === "asset-collision").map((warning) => warning.path)
+        )
+      });
+      options.onProgress?.({ type: "public:complete", result: publicResult2 });
+      const resolvedAt = (options.now ?? (() => /* @__PURE__ */ new Date()))().toISOString();
+      await writeLock(lockPath, {
+        lockVersion: 1,
+        sources: resolvedSources.map(({ config: source, resolved }) => ({
+          id: source.id,
+          digest: `sha256:${(0, import_node_crypto4.createHash)("sha256").update(resolved.bytes).digest("hex")}`,
+          commit: resolved.commit,
+          resolvedAt
+        })).sort((left, right) => left.id.localeCompare(right.id)),
+        publicFiles: publicResult2.files
+      });
+      return { hydrateResult: hydrateResult2, publicResult: publicResult2 };
     }
-  });
-  const publicResult = await composePublicAssets({
-    projectDirectory,
-    federatedDirectory: outDir,
-    assets: graph.assets,
-    previousFiles: previousLock?.publicFiles,
-    collisionPaths: new Set(
-      graph.warnings.filter((warning) => warning.kind === "asset-collision").map((warning) => warning.path)
-    )
-  });
-  options.onProgress?.({ type: "public:complete", result: publicResult });
-  const resolvedAt = (options.now ?? (() => /* @__PURE__ */ new Date()))().toISOString();
-  await writeLock(lockPath, {
-    lockVersion: 1,
-    sources: resolvedSources.map(({ config: source, resolved }) => ({
-      id: source.id,
-      digest: `sha256:${(0, import_node_crypto4.createHash)("sha256").update(resolved.bytes).digest("hex")}`,
-      commit: resolved.commit,
-      resolvedAt
-    })).sort((left, right) => left.id.localeCompare(right.id)),
-    publicFiles: publicResult.files
-  });
+  );
   const result = {
     sources: sources.length,
     resources,
     graph,
+    diagnostics,
     hydrate: hydrateResult,
     public: publicResult,
     outDir,
@@ -690,5 +1014,6 @@ var federateCatalog = async (projectDirectory, options = {}) => {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   FederationConflictError,
+  FederationDiagnosticError,
   federateCatalog
 });