@eventcatalog/core 3.2.1 → 3.3.0

package/eventcatalog/src/stores/sidebar-store/builders/service.ts

@@ -1,7 +1,7 @@
 import type { CollectionEntry } from 'astro:content';
 import { buildUrl } from '@utils/url-builder';
 import { getSpecificationsForService } from '@utils/collections/services';
-import type { NavNode, ChildRef } from './shared';
+import type { NavNode, ChildRef, ResourceGroupContext } from './shared';
 import {
   uniqueBy,
   buildQuickReferenceSection,
@@ -10,11 +10,12 @@ import {
   buildResourceGroupSections,
   buildRepositorySection,
   buildAttachmentsSection,
+  buildDiagramNavItems,
 } from './shared';
 import { isVisualiserEnabled } from '@utils/feature';
 import { pluralizeMessageType } from '@utils/collections/messages';
 
-export const buildServiceNode = (service: CollectionEntry<'services'>, owners: any[], context: any): NavNode => {
+export const buildServiceNode = (service: CollectionEntry<'services'>, owners: any[], context: ResourceGroupContext): NavNode => {
   const sendsMessages = service.data.sends || [];
   const receivesMessages = service.data.receives || [];
   const serviceEntities = service.data.entities || [];
@@ -44,6 +45,11 @@ export const buildServiceNode = (service: CollectionEntry<'services'>, owners: a
   const renderOwners = owners.length > 0 && shouldRenderSideBarSection(service, 'owners');
   const renderRepository = service.data.repository && shouldRenderSideBarSection(service, 'repository');
 
+  // Diagrams
+  const serviceDiagrams = service.data.diagrams || [];
+  const diagramNavItems = buildDiagramNavItems(serviceDiagrams, context.diagrams);
+  const hasDiagrams = diagramNavItems.length > 0;
+
   return {
     type: 'item',
     title: service.data.name,
@@ -55,17 +61,17 @@ export const buildServiceNode = (service: CollectionEntry<'services'>, owners: a
       ]),
       {
         type: 'group',
-        title: 'Architecture & Design',
+        title: 'Architecture',
         icon: 'Workflow',
         pages: [
           {
             type: 'item',
-            title: 'Architecture Overview',
+            title: 'Overview',
             href: buildUrl(`/architecture/services/${service.data.id}/${service.data.version}`),
           },
           renderVisualiser && {
             type: 'item',
-            title: 'Interaction Map',
+            title: 'Map',
             href: buildUrl(`/visualiser/services/${service.data.id}/${service.data.version}`),
           },
           renderVisualiser &&
@@ -74,7 +80,13 @@ export const buildServiceNode = (service: CollectionEntry<'services'>, owners: a
               title: 'Data Map',
               href: buildUrl(`/visualiser/services/${service.data.id}/${service.data.version}/data`),
             },
-        ],
+        ].filter(Boolean) as ChildRef[],
+      },
+      hasDiagrams && {
+        type: 'group',
+        title: 'Diagrams',
+        icon: 'FileImage',
+        pages: diagramNavItems,
       },
       renderSpecifications && {
         type: 'group',

package/eventcatalog/src/stores/sidebar-store/builders/shared.ts

@@ -54,6 +54,7 @@ export type ResourceGroupContext = {
   queries: CollectionEntry<'queries'>[];
   flows: CollectionEntry<'flows'>[];
   containers: CollectionEntry<'containers'>[];
+  diagrams: CollectionEntry<'diagrams'>[];
 };
 
 export const buildQuickReferenceSection = (items: { title: string; href: string }[]): NavNode => ({
@@ -158,3 +159,22 @@ export const shouldRenderSideBarSection = (resource: any, section: string) => {
   }
   return resource.data.detailsPanel[section]?.visible ?? true;
 };
+
+export const buildDiagramNavItems = (
+  diagrams: Array<{ id: string; version?: string }> | undefined,
+  allDiagrams: CollectionEntry<'diagrams'>[]
+): NavNode[] => {
+  if (!diagrams || diagrams.length === 0) return [];
+
+  return diagrams.map((ref) => {
+    const diagram = allDiagrams.find(
+      (d) => d.data.id === ref.id && (ref.version === 'latest' || !ref.version || d.data.version === ref.version)
+    );
+    const version = diagram?.data.version || ref.version || 'latest';
+    return {
+      type: 'item' as const,
+      title: diagram?.data.name || ref.id,
+      href: buildUrl(`/diagrams/${ref.id}/${version}`),
+    };
+  });
+};

package/eventcatalog/src/stores/sidebar-store/state.ts

@@ -6,6 +6,7 @@ import { getOwner } from '@utils/collections/owners';
 import { getFlows } from '@utils/collections/flows';
 import { getUsers } from '@utils/collections/users';
 import { getTeams } from '@utils/collections/teams';
+import { getDiagrams } from '@utils/collections/diagrams';
 import { buildUrl } from '@utils/url-builder';
 import type { NavigationData, NavNode, ChildRef } from './builders/shared';
 import { buildDomainNode } from './builders/domain';
@@ -30,7 +31,7 @@ export const getNestedSideBarData = async (): Promise<NavigationData> => {
     return memoryCache;
   }
 
-  const [domains, services, { events, commands, queries }, containers, flows, users, teams, designs, channels] =
+  const [domains, services, { events, commands, queries }, containers, flows, users, teams, designs, channels, diagrams] =
     await Promise.all([
       getDomains({ getAllVersions: false, includeServicesInSubdomains: false }),
       getServices({ getAllVersions: false }),
@@ -41,6 +42,7 @@ export const getNestedSideBarData = async (): Promise<NavigationData> => {
       getTeams(),
       getDesigns(),
       getChannels({ getAllVersions: false }),
+      getDiagrams({ getAllVersions: false }),
     ]);
 
   // Calculate derived lists to avoid extra fetches
@@ -57,6 +59,7 @@ export const getNestedSideBarData = async (): Promise<NavigationData> => {
     queries,
     flows,
     containers,
+    diagrams,
   };
 
   // Process all domains with their owners first (async)
@@ -136,9 +139,9 @@ export const getNestedSideBarData = async (): Promise<NavigationData> => {
     (acc, { message, owners }) => {
       const type = pluralizeMessageType(message as any);
 
-      acc[`${type}:${message.data.id}:${message.data.version}`] = buildMessageNode(message, owners);
+      acc[`${type}:${message.data.id}:${message.data.version}`] = buildMessageNode(message, owners, context);
       if (message.data.latestVersion === message.data.version) {
-        acc[`${type}:${message.data.id}`] = buildMessageNode(message, owners);
+        acc[`${type}:${message.data.id}`] = buildMessageNode(message, owners, context);
       }
       return acc;
     },
@@ -147,9 +150,9 @@ export const getNestedSideBarData = async (): Promise<NavigationData> => {
 
   const containerNodes = containerWithOwners.reduce(
     (acc, { container, owners }) => {
-      acc[`container:${container.data.id}:${container.data.version}`] = buildContainerNode(container, owners);
+      acc[`container:${container.data.id}:${container.data.version}`] = buildContainerNode(container, owners, context);
       if (container.data.latestVersion === container.data.version) {
-        acc[`container:${container.data.id}`] = buildContainerNode(container, owners);
+        acc[`container:${container.data.id}`] = buildContainerNode(container, owners, context);
       }
       return acc;
     },
@@ -383,6 +386,25 @@ export const getNestedSideBarData = async (): Promise<NavigationData> => {
     ...(allList ? { 'list:all': allList as NavNode } : {}),
   };
 
+  // System-level views (only show if visualiser is enabled and there are domains)
+  const systemNode: Record<string, NavNode> = {};
+  const visualiserEnabled = config?.visualiser?.enabled !== false;
+
+  if (visualiserEnabled && domains.length > 0) {
+    systemNode['list:system'] = {
+      type: 'group',
+      title: 'System',
+      icon: 'Globe',
+      pages: [
+        {
+          type: 'item',
+          title: 'Domain Map',
+          href: buildUrl('/visualiser/domain-integrations'),
+        },
+      ],
+    };
+  }
+
   const allGeneratedNodes = {
     ...rootDomainsNodes,
     ...domainNodes,
@@ -394,11 +416,17 @@ export const getNestedSideBarData = async (): Promise<NavigationData> => {
     ...userNodes,
     ...teamNodes,
     ...designNodes,
+    ...systemNode,
     ...allNodes,
   };
 
   // only filter if child is string
-  const rootNavigationConfig = config?.navigation?.pages || ['list:top-level-domains', 'list:all'];
+  const defaultPages = ['list:top-level-domains', 'list:all'];
+  // Add system section if it exists
+  if (systemNode['list:system']) {
+    defaultPages.push('list:system');
+  }
+  const rootNavigationConfig = config?.navigation?.pages || defaultPages;
 
   const navigationConfig = {
     roots: rootNavigationConfig,

package/eventcatalog/src/types/index.ts

@@ -7,7 +7,8 @@ export type CollectionTypes =
   | 'flows'
   | 'channels'
   | 'entities'
-  | 'containers';
+  | 'containers'
+  | 'diagrams';
 export type CollectionMessageTypes = 'commands' | 'events' | 'queries';
 export type CollectionUserTypes = 'users';
 export type PageTypes =
@@ -19,7 +20,8 @@ export type PageTypes =
   | 'channels'
   | 'flows'
   | 'entities'
-  | 'containers';
+  | 'containers'
+  | 'diagrams';
 
 export type TableConfiguration = {
   columns: {

package/eventcatalog/src/utils/collections/diagrams.ts

@@ -0,0 +1,64 @@
+import { getCollection } from 'astro:content';
+import type { CollectionEntry } from 'astro:content';
+import path from 'path';
+import { createVersionedMap } from '@utils/collections/util';
+
+const CACHE_ENABLED = process.env.DISABLE_EVENTCATALOG_CACHE !== 'true';
+export type Diagram = CollectionEntry<'diagrams'>;
+
+interface Props {
+  getAllVersions?: boolean;
+}
+
+// Cache for build time
+let memoryCache: Record<string, Diagram[]> = {};
+
+export const getDiagrams = async ({ getAllVersions = true }: Props = {}): Promise<Diagram[]> => {
+  const cacheKey = getAllVersions ? 'allVersions' : 'currentVersions';
+
+  if (memoryCache[cacheKey] && memoryCache[cacheKey].length > 0 && CACHE_ENABLED) {
+    return memoryCache[cacheKey];
+  }
+
+  const allDiagrams = await getCollection('diagrams');
+
+  // Build optimized map for version lookups
+  const diagramMap = createVersionedMap(allDiagrams);
+
+  // Filter diagrams
+  const targetDiagrams = allDiagrams.filter((diagram) => {
+    if (!getAllVersions && diagram.filePath?.includes('versioned')) return false;
+    return true;
+  });
+
+  // Enrich diagrams with version info
+  const processedDiagrams = targetDiagrams.map((diagram) => {
+    const diagramVersions = diagramMap.get(diagram.data.id) || [];
+    const latestVersion = diagramVersions[0]?.data.version || diagram.data.version;
+    const versions = diagramVersions.map((d) => d.data.version);
+
+    return {
+      ...diagram,
+      data: {
+        ...diagram.data,
+        versions,
+        latestVersion,
+      },
+      catalog: {
+        path: path.join(diagram.collection, diagram.id.replace('/index.mdx', '')),
+        filePath: path.join(process.cwd(), 'src', 'catalog-files', diagram.collection, diagram.id.replace('/index.mdx', '')),
+        publicPath: path.join('/generated', diagram.collection),
+        type: 'diagram',
+      },
+    };
+  });
+
+  // Sort by name
+  processedDiagrams.sort((a, b) => {
+    return (a.data.name || a.data.id).localeCompare(b.data.name || b.data.id);
+  });
+
+  memoryCache[cacheKey] = processedDiagrams;
+
+  return processedDiagrams;
+};

package/eventcatalog/src/utils/collections/util.ts

@@ -117,6 +117,7 @@ export const resourceToCollectionMap = {
   team: 'teams',
   container: 'containers',
   entity: 'entities',
+  diagram: 'diagrams',
 } as const;
 
 export const collectionToResourceMap = {
@@ -131,6 +132,7 @@ export const collectionToResourceMap = {
   teams: 'team',
   containers: 'container',
   entities: 'entity',
+  diagrams: 'diagram',
 } as const;
 
 export const getDeprecatedDetails = (item: CollectionEntry<CollectionTypes>) => {

package/eventcatalog/src/utils/feature.ts

@@ -50,8 +50,8 @@ export const isEventCatalogChatEnabled = () => {
 export const isEventCatalogUpgradeEnabled = () => !isEventCatalogStarterEnabled() && !isEventCatalogScaleEnabled();
 export const isCustomLandingPageEnabled = () => isEventCatalogStarterEnabled() || isEventCatalogScaleEnabled();
 
-export const isMarkdownDownloadEnabled = () => config?.llmsTxt?.enabled ?? false;
-export const isLLMSTxtEnabled = () => (config?.llmsTxt?.enabled || isEventCatalogChatEnabled()) ?? true;
+export const isMarkdownDownloadEnabled = () => config?.llmsTxt?.enabled ?? true;
+export const isLLMSTxtEnabled = () => config?.llmsTxt?.enabled ?? true;
 
 export const isAuthEnabled = () => {
   const isAuthEnabledInCatalog = config?.auth?.enabled ?? false;
@@ -67,3 +67,5 @@ export const isVisualiserEnabled = () => config?.visualiser?.enabled ?? true;
 export const isCustomStylesEnabled = () => {
   return isEventCatalogStarterEnabled() || isEventCatalogScaleEnabled();
 };
+
+export const isDiagramComparisonEnabled = () => isEventCatalogScaleEnabled();

package/eventcatalog/src/utils/page-loaders/page-data-loader.ts

@@ -7,6 +7,7 @@ import { getServices } from '@utils/collections/services';
 import { getFlows } from '@utils/collections/flows';
 import { getEntities } from '@utils/collections/entities';
 import { getContainers } from '@utils/collections/containers';
+import { getDiagrams } from '@utils/collections/diagrams';
 import type { CollectionEntry } from 'astro:content';
 
 export const pageDataLoader: Record<PageTypes, () => Promise<CollectionEntry<CollectionTypes>[]>> = {
@@ -19,4 +20,5 @@ export const pageDataLoader: Record<PageTypes, () => Promise<CollectionEntry<Col
   flows: getFlows,
   entities: getEntities,
   containers: getContainers,
+  diagrams: getDiagrams,
 };

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -34,7 +34,7 @@
     "@eventcatalog/generator-ai": "^1.1.0",
     "@eventcatalog/license": "^0.0.7",
     "@eventcatalog/linter": "^0.0.2",
-    "@eventcatalog/sdk": "^2.9.9",
+    "@eventcatalog/sdk": "^2.10.0",
     "@eventcatalog/visualizer": "^0.0.6",
     "@fontsource/inter": "^5.2.5",
     "@headlessui/react": "^2.0.3",