@eventcatalog/core 2.65.0 → 3.0.0-beta.0

package/eventcatalog/src/pages/docs/[type]/[id]/index.astro

@@ -1,14 +1,14 @@
 ---
 import Seo from '@components/Seo.astro';
 import { buildUrl } from '@utils/url-builder';
-import { getEvents } from '@utils/events';
-import { getEntities } from '@utils/entities';
-import { getCommands } from '@utils/commands';
+import { getEvents } from '@utils/collections/events';
+import { getEntities } from '@utils/collections/entities';
+import { getCommands } from '@utils/collections/commands';
 import { getServices } from '@utils/collections/services';
 import { getDomains } from '@utils/collections/domains';
 import type { CollectionEntry } from 'astro:content';
 import type { CollectionTypes } from '@types';
-import { getChannels } from '@utils/channels';
+import { getChannels } from '@utils/collections/channels';
 
 export async function getStaticPaths() {
   const [events, commands, services, domains, channels, entities] = await Promise.all([

package/eventcatalog/src/pages/docs/[type]/[id]/language/_index.data.ts

@@ -18,10 +18,7 @@ export class Page extends HybridPage {
         type: item.collection,
         id: item.data.id,
       },
-      props: {
-        type: item.collection,
-        ...item,
-      },
+      props: {},
     }));
   }
 

package/eventcatalog/src/pages/docs/[type]/[id]/language/index.astro

@@ -25,36 +25,12 @@ const { subdomains, duplicateTerms } = ubiquitousLanguageData;
   <main class="flex sm:px-6 docs-layout h-full" data-pagefind-body data-pagefind-meta={`title:${pageTitle}`}>
     <div class="flex docs-layout w-full">
       <div class="w-full lg:mr-2 pr-8 overflow-y-auto pt-6 pb-8 min-h-[50em]">
-        {/* Breadcrumb */}
-        <nav class="mb-4 flex items-center space-x-2 text-sm text-gray-500" aria-label="Breadcrumb">
-          <a
-            href={buildUrl(`/docs/${props.type}/${props.data.id}/${props.data.latestVersion}`)}
-            class="hover:text-gray-700 hover:underline flex items-center gap-2"
-          >
-            <RectangleGroupIcon className="h-4 w-4" />
-            {props.data.name}
-          </a>
-          <svg class="h-4 w-4" fill="none" stroke="currentColor" viewBox="0 0 24 24" stroke-width="2">
-            <path stroke-linecap="round" stroke-linejoin="round" d="M9 5l7 7-7 7"></path>
-          </svg>
-          <span class="text-gray-900 flex items-center gap-2">
-            {
-              (() => {
-                const BookOpen = LucideIcons.BookOpen;
-                //@ts-ignore
-                return <BookOpen className="h-4 w-4" />;
-              })()
-            }
-            Ubiquitous Language Explorer
-          </span>
-        </nav>
-
         {/* Title Section */}
         <div class="relative border-b border-gray-200 mb-4 pb-4">
           <div class="xl:flex xl:items-start xl:justify-between">
             <div class="min-w-0 flex-1">
               <div class="flex items-center gap-2">
-                <h1 class="text-xl font-bold leading-7 text-gray-900 sm:text-2xl xl:text-3xl">Ubiquitous Language Explorer</h1>
+                <h1 class="text-xl font-bold leading-7 text-gray-900 sm:text-2xl xl:text-3xl">Ubiquitous Language</h1>
               </div>
               <p class="mt-2 text-sm text-gray-500">
                 Browse and discover ubiquitous language terms in the {props.data.name} domain{
@@ -145,7 +121,7 @@ const { subdomains, duplicateTerms } = ubiquitousLanguageData;
                                 {term.description && (
                                   <div class="prose prose-sm prose-p:my-3">
                                     <a
-                                      href={buildUrl(`/docs/${props.type}/${props.data.id}/language/${term.id}`)}
+                                      href={buildUrl(`/docs/${props.collection}/${props.data.id}/language/${term.id}`)}
                                       class="show-more-text text-sm text-primary font-medium hover:underline"
                                     >
                                       Read more
@@ -213,7 +189,7 @@ const { subdomains, duplicateTerms } = ubiquitousLanguageData;
                                   {term.description && (
                                     <div class="prose prose-sm prose-p:my-3">
                                       <a
-                                        href={buildUrl(`/docs/${props.type}/${subdomain.data.id}/language/${term.id}`)}
+                                        href={buildUrl(`/docs/${props.collection}/${subdomain.data.id}/language/${term.id}`)}
                                         class="show-more-text text-sm text-primary font-medium hover:underline"
                                       >
                                         Read more

package/eventcatalog/src/pages/docs/teams/[id]/_index.data.ts

@@ -12,7 +12,7 @@ export class Page extends HybridPage {
       return [];
     }
 
-    const { getTeams } = await import('@utils/teams');
+    const { getTeams } = await import('@utils/collections/teams');
     const teams = await getTeams();
 
     return teams.map((team) => ({
@@ -28,7 +28,7 @@ export class Page extends HybridPage {
       return null;
     }
 
-    const { getTeams } = await import('@utils/teams');
+    const { getTeams } = await import('@utils/collections/teams');
     const teams = await getTeams();
 
     // Find the specific team by id

package/eventcatalog/src/pages/docs/users/[id]/_index.data.ts

@@ -12,7 +12,7 @@ export class Page extends HybridPage {
       return [];
     }
 
-    const { getUsers } = await import('@utils/users');
+    const { getUsers } = await import('@utils/collections/users');
     const users = await getUsers();
 
     return users.map((user) => ({
@@ -28,7 +28,7 @@ export class Page extends HybridPage {
       return null;
     }
 
-    const { getUsers } = await import('@utils/users');
+    const { getUsers } = await import('@utils/collections/users');
     const users = await getUsers();
 
     // Find the specific team by id

package/eventcatalog/src/pages/index.astro

@@ -7,8 +7,9 @@ import NodeGraph from '@components/MDX/NodeGraph/NodeGraph.astro';
 import { getMDXComponentsByName } from '@utils/markdown';
 import { resourceToCollectionMap } from '@utils/collections/util';
 import { buildUrl } from '@utils/url-builder';
-import { isCustomLandingPageEnabled } from '@utils/feature';
+import { isCustomLandingPageEnabled, isVisualiserEnabled } from '@utils/feature';
 import DefaultAstroLandingPage from './_index.astro';
+import config from '@config';
 
 let nodeGraphs: any[] = [];
 let CustomContent = null;
@@ -28,6 +29,10 @@ if (existsSync(pathToUserDefinedLandingPage) && isCustomLandingPageEnabled()) {
   const rawContent = readFileSync(pathToUserDefinedLandingPage, 'utf-8');
   nodeGraphs = getMDXComponentsByName(rawContent, 'NodeGraph') || [];
 }
+
+if (config.landingPage) {
+  return Astro.redirect(buildUrl(config.landingPage));
+}
 ---
 
 {
@@ -53,10 +58,14 @@ if (existsSync(pathToUserDefinedLandingPage) && isCustomLandingPageEnabled()) {
                 title={nodeGraph.title}
                 mode="simple"
                 linksToVisualiser={true}
-                href={{
-                  label: 'Open in Visualiser',
-                  url: buildUrl(`/visualiser/${collection}/${nodeGraph.id}/${nodeGraph.version}`),
-                }}
+                href={
+                  isVisualiserEnabled()
+                    ? {
+                        label: 'Open in Visualiser',
+                        url: buildUrl(`/visualiser/${collection}/${nodeGraph.id}/${nodeGraph.version}`),
+                      }
+                    : undefined
+                }
               />
             );
           })}

package/eventcatalog/src/pages/nav-index.json.ts

@@ -0,0 +1,30 @@
+// src/pages/nav-index.json.ts
+import { getCollection } from 'astro:content';
+
+export const prerender = true;
+
+export async function GET() {
+  //   const services = await getCollection('services');
+  //   const domains = await getCollection('domains');
+  //   // ...other collections
+
+  //   const index = buildNavIndex({ services, domains }); // your map logic
+
+  const index = [
+    {
+      type: 'group',
+      title: 'Domains',
+      pages: [
+        {
+          type: 'item',
+          title: 'Inventory Domain',
+          icon: 'ServerIcon',
+        },
+      ],
+    },
+  ];
+
+  return new Response(JSON.stringify(index), {
+    headers: { 'Content-Type': 'application/json' },
+  });
+}

package/eventcatalog/src/pages/schemas/[type]/[id]/[version]/_index.data.ts

@@ -0,0 +1,77 @@
+import { isSSR } from '@utils/feature';
+import { HybridPage } from '@utils/page-loaders/hybrid-page';
+import type { PageTypes } from '@types';
+import { pageDataLoader } from '@utils/page-loaders/page-data-loader';
+
+/**
+ * Documentation page class for all collection types with versioning
+ */
+export class Page extends HybridPage {
+  static async getStaticPaths() {
+    if (isSSR()) {
+      return [];
+    }
+
+    const itemTypes: PageTypes[] = [
+      'events',
+      'commands',
+      'queries',
+      // 'services',
+      // 'domains',
+      // 'flows',
+      // 'channels',
+      // 'entities',
+      // 'containers',
+    ];
+    const allItems = await Promise.all(itemTypes.map((type) => pageDataLoader[type]()));
+
+    // We only care about any item that has data.schemaPath
+    const itemsWithSchema = allItems.flatMap((items) => items.filter((item) => item.data.schemaPath));
+
+    // return allItems.flatMap((items, index) =>
+    return itemsWithSchema.map((item, index) => ({
+      params: {
+        type: item.collection,
+        id: item.data.id,
+        version: item.data.version,
+      },
+      props: {
+        type: item.collection,
+        ...item,
+        // Not everything needs the body of the page itself.
+        body: undefined,
+      },
+    }));
+    // );
+  }
+
+  protected static async fetchData(params: any) {
+    const { type, id, version } = params;
+
+    if (!type || !id || !version) {
+      return null;
+    }
+
+    // Get all items of the specified type
+    const items = await pageDataLoader[type as PageTypes]();
+
+    // Find the specific item by id and version
+    const item = items.find((i) => i.data.id === id && i.data.version === version);
+
+    if (!item) {
+      return null;
+    }
+
+    return {
+      type,
+      ...item,
+    };
+  }
+
+  protected static createNotFoundResponse(): Response {
+    return new Response(null, {
+      status: 404,
+      statusText: 'Documentation not found',
+    });
+  }
+}

package/eventcatalog/src/pages/schemas/[type]/[id]/[version]/index.astro

@@ -0,0 +1,90 @@
+---
+import type { PageTypes } from '@types';
+import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
+import { Page } from './_index.data';
+import SchemaPageViewer from '@components/SchemaExplorer/SchemaPageViewer';
+import { pageDataLoader } from '@utils/page-loaders/page-data-loader';
+import { sortVersioned } from '@utils/collections/util';
+import { isEventCatalogScaleEnabled } from '@utils/feature';
+import fs from 'fs';
+import path from 'path';
+import type { SchemaItem } from '@components/SchemaExplorer/types';
+
+export const prerender = Page.prerender;
+export const getStaticPaths = Page.getStaticPaths;
+
+// Get data
+const props = await Page.getData(Astro);
+const { type, data } = props as { type: PageTypes; data: any };
+const pageTitle = `${type} | ${data.name}`.replace(/^\w/, (c) => c.toUpperCase());
+
+const allItems = await pageDataLoader[type]();
+const versions = allItems.filter((item) => item.data.id === data.id);
+
+// Transform to SchemaItems
+const availableVersions = await Promise.all(
+  versions
+    .filter((message) => message.data.schemaPath)
+    .filter((message) => fs.existsSync(path.join(path.dirname(message.filePath ?? ''), message.data.schemaPath ?? '')))
+    .map(async (message) => {
+      try {
+        const schemaPath = message.data.schemaPath;
+        const fullSchemaPath = path.join(path.dirname(message.filePath ?? ''), schemaPath ?? '');
+
+        let schemaContent = '';
+        if (fs.existsSync(fullSchemaPath)) {
+          schemaContent = fs.readFileSync(fullSchemaPath, 'utf-8');
+        }
+
+        const schemaExtension = path.extname(schemaPath ?? '').slice(1);
+
+        return {
+          collection: message.collection,
+          data: {
+            id: message.data.id,
+            name: message.data.name,
+            version: message.data.version,
+            summary: message.data.summary,
+            schemaPath: message.data.schemaPath,
+            // @ts-ignore
+            producers: message.data.producers || [],
+            // @ts-ignore
+            consumers: message.data.consumers || [],
+          },
+          schemaContent,
+          schemaExtension,
+        } as SchemaItem;
+      } catch (error) {
+        console.error(`Error reading schema for ${message.data.id}:`, error);
+        return null;
+      }
+    })
+);
+
+const validVersions = availableVersions.filter((v): v is SchemaItem => v !== null);
+
+// Sort versions descending (newest first)
+const sortedVersions = sortVersioned(validVersions, (item) => item.data.version);
+
+const currentMessage = sortedVersions.find((v) => v.data.version === data.version);
+const apiAccessEnabled = isEventCatalogScaleEnabled();
+---
+
+<VerticalSideBarLayout title={pageTitle}>
+  <div class="h-[calc(100vh-4rem)] w-full overflow-hidden flex flex-col">
+    {
+      currentMessage ? (
+        <SchemaPageViewer
+          client:load
+          message={currentMessage}
+          availableVersions={sortedVersions}
+          apiAccessEnabled={apiAccessEnabled}
+          showOwners={false}
+          showProducersConsumers={false}
+        />
+      ) : (
+        <div class="p-8 flex items-center justify-center h-full text-gray-500">Schema not found or could not be loaded.</div>
+      )
+    }
+  </div>
+</VerticalSideBarLayout>

package/eventcatalog/src/pages/schemas/{index.astro → explorer/index.astro}

@@ -1,8 +1,8 @@
 ---
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
-import { getEvents } from '@utils/events';
-import { getCommands } from '@utils/commands';
-import { getQueries } from '@utils/queries';
+import { getEvents } from '@utils/collections/events';
+import { getCommands } from '@utils/collections/commands';
+import { getQueries } from '@utils/collections/queries';
 import { getServices, getSpecificationsForService } from '@utils/collections/services';
 import SchemaExplorer from '@components/SchemaExplorer/SchemaExplorer';
 import { isEventCatalogScaleEnabled } from '@utils/feature';

package/eventcatalog/src/pages/studio.astro

@@ -1,12 +1,12 @@
 ---
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
-import { getEvents } from '@utils/events';
-import { getCommands } from '@utils/commands';
+import { getEvents } from '@utils/collections/events';
+import { getCommands } from '@utils/collections/commands';
 import { getServices } from '@utils/collections/services';
 import { BoltIcon, ServerIcon, RectangleGroupIcon } from '@heroicons/react/24/outline';
 import { SquareDashedMousePointerIcon, ArrowLeftRightIcon } from 'lucide-react';
 import StudioPageModal from '@components/Studio/StudioPageModal';
-import { getChannels } from '@utils/channels';
+import { getChannels } from '@utils/collections/channels';
 
 const [events, commands, services, channels] = await Promise.all([
   getEvents().catch(() => []),

package/eventcatalog/src/pages/visualiser/[type]/[id]/[version]/_index.data.ts

@@ -3,12 +3,13 @@ import { HybridPage } from '@utils/page-loaders/hybrid-page';
 import { isAuthEnabled } from '@utils/feature';
 import type { PageTypes } from '@types';
 import { pageDataLoader } from '@utils/page-loaders/page-data-loader';
+import { isVisualiserEnabled } from '@utils/feature';
 
 type PageTypesWithFlows = PageTypes | 'flows';
 
 export class Page extends HybridPage {
   static async getStaticPaths(): Promise<Array<{ params: any; props: any }>> {
-    if (isAuthEnabled()) {
+    if (isAuthEnabled() || !isVisualiserEnabled()) {
       return [];
     }
 
@@ -42,7 +43,7 @@ export class Page extends HybridPage {
   protected static async fetchData(params: any) {
     const { type, id, version } = params;
 
-    if (!type || !id || !version) {
+    if (!type || !id || !version || !isVisualiserEnabled()) {
       return null;
     }
 
@@ -77,7 +78,7 @@ export class Page extends HybridPage {
   }
 
   static get clientAuthScript(): string {
-    if (!isAuthEnabled()) {
+    if (!isAuthEnabled() || !isVisualiserEnabled()) {
       return '';
     }
 

package/eventcatalog/src/pages/visualiser/[type]/[id]/index.astro

@@ -1,8 +1,8 @@
 ---
 import Seo from '@components/Seo.astro';
 import { buildUrl } from '@utils/url-builder';
-import { getEvents } from '@utils/events';
-import { getCommands } from '@utils/commands';
+import { getEvents } from '@utils/collections/events';
+import { getCommands } from '@utils/collections/commands';
 import { getServices } from '@utils/collections/services';
 import { getDomains } from '@utils/collections/domains';
 import { getContainers } from '@utils/collections/containers';

package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/entity-map/_index.data.ts

@@ -1,10 +1,11 @@
 import { HybridPage } from '@utils/page-loaders/hybrid-page';
 import { isAuthEnabled } from '@utils/feature';
 import { domainHasEntities, getDomains, type Domain } from '@utils/collections/domains';
+import { isVisualiserEnabled } from '@utils/feature';
 
 export class Page extends HybridPage {
   static async getStaticPaths(): Promise<Array<{ params: any; props: any }>> {
-    if (isAuthEnabled()) {
+    if (isAuthEnabled() || !isVisualiserEnabled()) {
       return [];
     }
 
@@ -29,7 +30,7 @@ export class Page extends HybridPage {
   protected static async fetchData(params: any) {
     const { id, version } = params;
 
-    if (!id || !version) {
+    if (!id || !version || !isVisualiserEnabled()) {
       return null;
     }
 
@@ -54,7 +55,7 @@ export class Page extends HybridPage {
   }
 
   static get clientAuthScript(): string {
-    if (!isAuthEnabled()) {
+    if (!isAuthEnabled() || !isVisualiserEnabled()) {
       return '';
     }
 

package/eventcatalog/src/stores/favorites-store.ts

@@ -0,0 +1,83 @@
+import { atom } from 'nanostores';
+
+const FAVORITES_KEY = 'eventcatalog-sidebar-favorites';
+
+export type FavoriteItem = {
+  nodeKey: string; // The key of the favorited node
+  path: string[]; // Path of keys to reach this node
+  title: string; // Display title
+  badge?: string; // Type badge (Domain, Service, etc.)
+  href?: string; // Direct link if it's a leaf item
+};
+
+export const favoritesStore = atom<FavoriteItem[]>([]);
+
+// Initialize store from localStorage on client side
+const initStore = () => {
+  if (typeof window !== 'undefined') {
+    try {
+      const stored = localStorage.getItem(FAVORITES_KEY);
+      if (stored) {
+        const parsed = JSON.parse(stored);
+        if (JSON.stringify(favoritesStore.get()) !== stored) {
+          favoritesStore.set(parsed);
+        }
+      }
+    } catch (e) {
+      console.warn('Failed to load favorites:', e);
+    }
+  }
+};
+
+if (typeof window !== 'undefined') {
+  initStore();
+
+  // Listen for storage events (cross-tab sync)
+  window.addEventListener('storage', (e) => {
+    if (e.key === FAVORITES_KEY) {
+      initStore();
+    }
+  });
+
+  // Listen for custom events (same-tab sync between instances)
+  window.addEventListener('favorites-updated', () => {
+    initStore();
+  });
+}
+
+export const saveFavorites = (favorites: FavoriteItem[]) => {
+  favoritesStore.set(favorites);
+  if (typeof window !== 'undefined') {
+    try {
+      localStorage.setItem(FAVORITES_KEY, JSON.stringify(favorites));
+      // Dispatch event to notify other store instances/components
+      window.dispatchEvent(new CustomEvent('favorites-updated'));
+    } catch (e) {
+      console.warn('Failed to save favorites:', e);
+    }
+  }
+};
+
+export const addFavorite = (item: FavoriteItem) => {
+  const current = favoritesStore.get();
+  const exists = current.some((fav) => fav.nodeKey === item.nodeKey);
+  if (!exists) {
+    saveFavorites([...current, item]);
+  }
+};
+
+export const removeFavorite = (nodeKey: string) => {
+  const current = favoritesStore.get();
+  saveFavorites(current.filter((fav) => fav.nodeKey !== nodeKey));
+};
+
+export const toggleFavorite = (item: FavoriteItem) => {
+  const current = favoritesStore.get();
+  const exists = current.some((fav) => fav.nodeKey === item.nodeKey);
+
+  if (exists) {
+    removeFavorite(item.nodeKey);
+  } else {
+    addFavorite(item);
+  }
+};

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

@@ -0,0 +1,8 @@
+import { atom } from 'nanostores';
+import type { NavigationData } from '../components/SideNav/NestedSideBar/sidebar-builder';
+
+export const sidebarStore = atom<NavigationData | null>(null);
+
+export const setSidebarData = (data: NavigationData) => {
+  sidebarStore.set(data);
+};

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

@@ -7,12 +7,15 @@ export type ChangeLog = CollectionEntry<'changelogs'>;
 export const getChangeLogs = async (item: CollectionEntry<CollectionTypes>): Promise<ChangeLog[]> => {
   const { collection, data, filePath } = item;
 
+  const collectionDirectory = path.dirname(item?.filePath || '');
+  // Ensure the path follows <collectionDirectory>/versioned/<version>/changelog.mdx
+  // Pre-compile regex
+  const versionedPathPattern = new RegExp(`${collectionDirectory}/versioned/[^/]+/changelog\\.mdx$`);
+  const rootChangeLogPath = path.join(collectionDirectory, 'changelog.mdx');
+
   // Get all logs for collection type and filter by given collection
   const logs = await getCollection('changelogs', (log) => {
-    const collectionDirectory = path.dirname(item?.filePath || '');
-    const isRootChangeLog = path.join(collectionDirectory, 'changelog.mdx') === log.filePath;
-    // Ensure the path follows <collectionDirectory>/versioned/<version>/changelog.mdx
-    const versionedPathPattern = new RegExp(`${collectionDirectory}/versioned/[^/]+/changelog\\.mdx$`);
+    const isRootChangeLog = rootChangeLogPath === log.filePath;
     const isVersionedChangeLog = versionedPathPattern.test(log.filePath!);
     return log.id.includes(`${collection}/`) && (isRootChangeLog || isVersionedChangeLog);
   });