@eventcatalog/core 5.9.0 → 5.10.0

package/eventcatalog/src/utils/node-graphs/domain-entity-map.ts

@@ -1,24 +1,22 @@
 import { getCollection, getEntry } from 'astro:content';
 import { generateIdForNode } from './utils/utils';
-import ELK from 'elkjs/lib/elk.bundled.js';
 import { MarkerType } from '@xyflow/react';
 import { createVersionedMap, findInMap } from '@utils/collections/util';
 import { getVersionFromCollection } from '@utils/collections/versions';
 import { getEntities, type Entity } from '@utils/collections/entities';
 import { getDomains, type Domain } from '@utils/collections/domains';
 import { getServices, type Service } from '@utils/collections/services';
-
-const elk = new ELK();
+import { layoutEntityNodes } from './entity-layout';
 
 export const ENTITY_TARGET_HANDLE_ID = '__eventcatalog-entity-target';
 
-const getReferencedEntityId = (property: any, entityMap: Map<string, Entity[]>) => {
+export const getReferencedEntityId = (property: any, entityMap: Map<string, Entity[]>) => {
   if (property.references) return property.references;
   if (property.type === 'array' && property.items?.type && entityMap.has(property.items.type)) return property.items.type;
   return undefined;
 };
 
-const getReferencePropertyNames = (entity: Entity, entityMap: Map<string, Entity[]>) =>
+export const getReferencePropertyNames = (entity: Entity, entityMap: Map<string, Entity[]>) =>
   entity.data.properties
     ?.filter((property: any) => getReferencedEntityId(property, entityMap))
     .map((property: any) => property.name) ?? [];
@@ -151,6 +149,19 @@ export const getNodesAndEdges = async ({ id, version, entities, type = 'domains'
   // Create complete list of entities for edge creation and layout
   const allEntitiesInGraph = [...resourceEntities, ...addedExternalEntities];
 
+  edges = createEntityReferenceEdges(entitiesWithReferences, allEntitiesInGraph, entityMap);
+
+  return { nodes: await layoutEntityNodes(nodes, edges), edges };
+};
+
+/** The edges between entities: one for each property referencing another entity in the graph */
+export const createEntityReferenceEdges = (
+  entitiesWithReferences: Entity[],
+  allEntitiesInGraph: Entity[],
+  entityMap: Map<string, Entity[]>
+) => {
+  const edges: any[] = [];
+
   // Go through any entities that are related to other entities
   for (const entity of entitiesWithReferences) {
     // Get a list of properties that reference other entities
@@ -220,60 +231,5 @@ export const getNodesAndEdges = async ({ id, version, entities, type = 'domains'
     }
   }
 
-  // No virtual edges - only show actual relationships between entities
-
-  // Separate entities with and without relationships (including external entities)
-  const entitiesWithRelationships = allEntitiesInGraph.filter((entity) => {
-    // Has outgoing references
-    const hasOutgoingRefs = entity.data.properties?.some((property: any) => getReferencedEntityId(property, entityMap));
-    // Has incoming references (is referenced by others)
-    const hasIncomingRefs = entitiesWithReferences.some((e: any) =>
-      e.data.properties?.some((prop: any) => getReferencedEntityId(prop, entityMap) === entity.data.id)
-    );
-    return hasOutgoingRefs || hasIncomingRefs;
-  });
-
-  // Prepare ELK graph structure
-  const elkNodes = nodes.map((node: any) => ({
-    id: node.id,
-    width: 220,
-    height: Math.max(120, 72 + (node.data.entity.data.properties?.length ?? 0) * 40),
-  }));
-
-  const elkEdges = edges.map((edge: any) => ({
-    id: edge.id,
-    sources: [edge.source],
-    targets: [edge.target],
-  }));
-
-  const elkGraph = {
-    id: 'root',
-    layoutOptions: {
-      'elk.algorithm': 'force',
-      'elk.force.iterations': '300',
-      'elk.spacing.nodeNode': '45',
-      'elk.spacing.componentComponent': '50',
-      'elk.padding': '[top=30,left=30,bottom=30,right=30]',
-      'elk.separateConnectedComponents': 'true',
-    },
-    children: elkNodes,
-    edges: elkEdges,
-  };
-
-  // Run ELK layout
-  const layoutedGraph = await elk.layout(elkGraph);
-
-  // Apply positions to nodes
-  const positionedNodes = nodes.map((node: any) => {
-    const elkNode = layoutedGraph.children?.find((n: any) => n.id === node.id);
-    return {
-      ...node,
-      position: {
-        x: elkNode?.x || 0,
-        y: elkNode?.y || 0,
-      },
-    };
-  });
-
-  return { nodes: positionedNodes, edges };
+  return edges;
 };

package/eventcatalog/src/utils/node-graphs/entity-layout.ts

@@ -0,0 +1,53 @@
+/**
+ * How entity maps are laid out: ELK's force layout, each entity sized by how many properties it has.
+ * Kept apart from the graph builders (which read the catalog's collections), so the catalog's entity
+ * map can lay out what it shows in the browser the same way.
+ */
+import ELK from 'elkjs/lib/elk.bundled.js';
+import { getNodeSize } from '@eventcatalog/visualiser/layout';
+
+const elk = new ELK();
+
+/** Places entities with ELK's force layout, sized by how many properties they have */
+export const layoutEntityNodes = async (nodes: any[], edges: any[]) => {
+  // Prepare ELK graph structure
+  // Sized as the visualiser estimates them (a row for each property), so the catalog and the browser agree
+  const elkNodes = nodes.map((node: any) => ({ id: node.id, ...getNodeSize(node) }));
+
+  const elkEdges = edges.map((edge: any) => ({
+    id: edge.id,
+    sources: [edge.source],
+    targets: [edge.target],
+  }));
+
+  const elkGraph = {
+    id: 'root',
+    layoutOptions: {
+      'elk.algorithm': 'force',
+      'elk.force.iterations': '300',
+      'elk.spacing.nodeNode': '45',
+      'elk.spacing.componentComponent': '50',
+      'elk.padding': '[top=30,left=30,bottom=30,right=30]',
+      'elk.separateConnectedComponents': 'true',
+    },
+    children: elkNodes,
+    edges: elkEdges,
+  };
+
+  // Run ELK layout
+  const layoutedGraph = await elk.layout(elkGraph);
+
+  // Apply positions to nodes
+  const positionedNodes = nodes.map((node: any) => {
+    const elkNode = layoutedGraph.children?.find((n: any) => n.id === node.id);
+    return {
+      ...node,
+      position: {
+        x: elkNode?.x || 0,
+        y: elkNode?.y || 0,
+      },
+    };
+  });
+
+  return positionedNodes;
+};

package/eventcatalog/src/utils/node-graphs/flow-lanes.ts

@@ -30,8 +30,8 @@ type Resource = { data: { id: string; name?: string; owners?: (string | { id: st
 
 // Lanes use the latest version of each domain and system (as the collection
 // utils do when they don't ask for every version)
-const isLatest = (entry: { filePath?: string }) => !entry.filePath?.includes('versioned');
-const toLane = (entry: Resource): Lane => ({ id: entry.data.id, name: entry.data.name || entry.data.id });
+export const isLatest = (entry: { filePath?: string }) => !entry.filePath?.includes('versioned');
+export const toLane = (entry: Resource): Lane => ({ id: entry.data.id, name: entry.data.name || entry.data.id });
 const pointerIds = (pointers?: { id: string }[]) => (pointers || []).map((pointer) => pointer.id);
 
 /**

package/package.json

@@ -7,7 +7,7 @@
   },
   "license": "BUSL-1.1",
   "type": "module",
-  "version": "5.9.0",
+  "version": "5.10.0",
   "publishConfig": {
     "access": "public"
   },
@@ -63,7 +63,7 @@
     "@hocuspocus/provider": "^4.7.0",
     "@hocuspocus/server": "^4.7.0",
     "@iconify-json/logos": "^1.2.4",
-    "@mcp-b/webmcp-polyfill": "5.1.0",
+    "@mcp-b/webmcp-polyfill": "6.0.3",
     "@mermaid-js/layout-elk": "^0.2.0",
     "@modelcontextprotocol/client": "2.3.1",
     "@modelcontextprotocol/ext-apps": "2.0.3",
@@ -95,7 +95,7 @@
     "diff2html": "^3.4.56",
     "dotenv": "^16.5.0",
     "elkjs": "^0.10.0",
-    "glob": "^13.0.6",
+    "glob": "^13.0.7",
     "gray-matter": "^4.0.3",
     "hono": "^4.13.7",
     "html-to-image": "^1.11.11",
@@ -142,10 +142,10 @@
     "yjs": "^13.6.33",
     "zod": "^4.6.6",
     "@eventcatalog/exporters": "0.1.4",
-    "@eventcatalog/sdk": "2.32.0",
-    "@eventcatalog/visualiser": "^5.2.5",
     "@eventcatalog/fitness": "0.1.1",
-    "@eventcatalog/linter": "1.3.1"
+    "@eventcatalog/linter": "1.3.1",
+    "@eventcatalog/sdk": "2.32.0",
+    "@eventcatalog/visualiser": "^5.3.0"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.10",