@eventcatalog/core 2.29.4 → 2.30.0

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

@@ -35,11 +35,18 @@ export async function getStaticPaths() {
 }
 
 // @ts-ignore
-const { data, catalog } = Astro.props;
+const { data, catalog, filePath } = Astro.props;
 const fileName = data.specifications?.openapiPath || 'openapi.yml';
-const pathToSpec = path.join(catalog.publicPath, fileName);
-const pathOnDisk = path.join(process.cwd(), 'public', pathToSpec);
-const fileExists = fs.existsSync(pathOnDisk);
+
+const directory = path.dirname(filePath || '');
+const pathToSpec = path.join(directory, fileName);
+const fileExists = fs.existsSync(pathToSpec);
+
+let content = '';
+
+if (fileExists) {
+  content = fs.readFileSync(pathToSpec, 'utf8');
+}
 ---
 
 <VerticalSideBarLayout title="OpenAPI Spec">
@@ -54,7 +61,7 @@ const fileExists = fs.existsSync(pathOnDisk);
       </div>
     ) : (
       <div>
-        <OpenAPISpec client:only="react" spec={buildUrl(pathToSpec, true)} />
+        <OpenAPISpec client:only="react" spec={content} />
       </div>
     )
   }

package/eventcatalog/src/pages/docs/[type]/[id]/[version].md.ts

@@ -46,8 +46,8 @@ export const GET: APIRoute = async ({ params, props }) => {
     return new Response('llms.txt is not enabled for this Catalog.', { status: 404 });
   }
 
-  if (props?.content?.data?.pathToFile) {
-    const file = fs.readFileSync(props.content.data.pathToFile, 'utf8');
+  if (props?.content?.filePath) {
+    const file = fs.readFileSync(props.content.filePath, 'utf8');
     return new Response(file, { status: 200 });
   }
 

package/eventcatalog/src/pages/docs/[type]/[id]/[version].mdx.ts

@@ -0,0 +1,55 @@
+// This file exposes the markdown for EventCatalog in the Url
+// For example http://localhost:3000/docs/events/OrderAmended/0.0.1 loads the Page and http://localhost:3000/docs/events/OrderAmended/0.0.1.md loads the markdown
+// This is used for the LLMs to load the markdown for the given item (llms.txt);
+
+import type { APIRoute } from 'astro';
+import { getCollection } from 'astro:content';
+import config from '@config';
+import fs from 'fs';
+
+const events = await getCollection('events');
+const commands = await getCollection('commands');
+const queries = await getCollection('queries');
+const services = await getCollection('services');
+const domains = await getCollection('domains');
+const flows = await getCollection('flows');
+const channels = await getCollection('channels');
+
+export async function getStaticPaths() {
+  // Just return empty array if LLMs are not enabled
+  if (!config.llmsTxt?.enabled) {
+    return [];
+  }
+
+  const collections = {
+    events,
+    commands,
+    queries,
+    services,
+    domains,
+    flows,
+    channels,
+  };
+  const paths = Object.keys(collections).map((type) => {
+    return collections[type as keyof typeof collections].map((item: { data: { id: string; version: string } }) => ({
+      params: { type, id: item.data.id, version: item.data.version },
+      props: { content: item },
+    }));
+  });
+
+  return paths.flat();
+}
+
+export const GET: APIRoute = async ({ params, props }) => {
+  // Just return empty array if LLMs are not enabled
+  if (!config.llmsTxt?.enabled) {
+    return new Response('llms.txt is not enabled for this Catalog.', { status: 404 });
+  }
+
+  if (props?.content?.filePath) {
+    const file = fs.readFileSync(props.content.filePath, 'utf8');
+    return new Response(file, { status: 200 });
+  }
+
+  return new Response('Not found', { status: 404 });
+};

package/eventcatalog/src/pages/docs/llm/llms-full.txt.ts

@@ -20,8 +20,8 @@ export const GET: APIRoute = async ({ params, request }) => {
 
   const content = resources
     .map((item) => {
-      if (!item.data.pathToFile) return '';
-      return fs.readFileSync(item.data.pathToFile, 'utf8');
+      if (!item.filePath) return '';
+      return fs.readFileSync(item.filePath, 'utf8');
     })
     .join('\n');
 

package/eventcatalog/src/pages/docs/llm/llms.txt.ts

@@ -17,10 +17,10 @@ export const GET: APIRoute = async ({ params, request }) => {
   const baseUrl = `${url.protocol}//${url.host}`;
 
   const formatVersionedItem = (item: any, type: string) =>
-    `- [${item.data.name} - ${item.data.id} - ${item.data.version}](${baseUrl}/docs/${type}/${item.data.id}/${item.data.version}.md) - ${item.data.summary}`;
+    `- [${item.data.name} - ${item.data.id} - ${item.data.version}](${baseUrl}/docs/${type}/${item.data.id}/${item.data.version}.mdx) - ${item.data.summary}`;
 
   const formatSimpleItem = (item: any, type: string) =>
-    `- [${item.id.replace('.md', '')}](${baseUrl}/docs/${type}/${item.data.id}.md) - ${item.data.name}`;
+    `- [${item.id.replace('.mdx', '')}](${baseUrl}/docs/${type}/${item.data.id}.mdx) - ${item.data.name}`;
 
   const content = [
     `# ${config.organizationName} EventCatalog Documentation\n`,

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

@@ -27,8 +27,8 @@ export const GET: APIRoute = async ({ params, props }) => {
     return new Response('llms.txt is not enabled for this Catalog.', { status: 404 });
   }
 
-  if (props?.content?.data?.pathToFile) {
-    const file = fs.readFileSync(props.content.data.pathToFile, 'utf8');
+  if (props?.content?.filePath) {
+    const file = fs.readFileSync(props.content.filePath, 'utf8');
     return new Response(file, { status: 200 });
   }
 

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

@@ -27,8 +27,8 @@ export const GET: APIRoute = async ({ params, props }) => {
     return new Response('llms.txt is not enabled for this Catalog.', { status: 404 });
   }
 
-  if (props?.content?.data?.pathToFile) {
-    const file = fs.readFileSync(props.content.data.pathToFile, 'utf8');
+  if (props?.content?.filePath) {
+    const file = fs.readFileSync(props.content?.filePath, 'utf8');
     return new Response(file, { status: 200 });
   }
 

package/eventcatalog/src/pages/rss/[resource]/rss.xml.js

@@ -37,9 +37,9 @@ export async function GET(context) {
 
   const rssItems = items
     // Make sure the item is valid before we try and get the git history
-    .filter((item) => item?.data?.pathToFile)
+    .filter((item) => item?.filePath)
     .map((event) => {
-      const pathToFile = event.data.pathToFile;
+      const pathToFile = event.filePath;
 
       let modifiedDate;
       let modifiedAuthor;

package/eventcatalog/src/utils/channels.ts

@@ -33,7 +33,7 @@ export const getChannels = async ({ getAllVersions = true }: Props = {}): Promis
   }
 
   const channels = await getCollection('channels', (query) => {
-    return (getAllVersions || !query.data?.pathToFile?.includes('versioned')) && query.data.hidden !== true;
+    return (getAllVersions || !query.filePath?.includes('versioned')) && query.data.hidden !== true;
   });
 
   const { commands, events, queries } = await getMessages();
@@ -68,7 +68,7 @@ export const getChannels = async ({ getAllVersions = true }: Props = {}): Promis
         absoluteFilePath: path.join(PROJECT_DIR, channel.collection, channel.id.replace('/index.mdx', '/index.md')),
         astroContentFilePath: path.join(process.cwd(), 'src', 'content', channel.collection, channel.id),
         filePath: path.join(process.cwd(), 'src', 'catalog-files', channel.collection, channel.id.replace('/index.mdx', '')),
-        publicPath: path.join('/generated', channel.collection, channel.id.replace('/index.mdx', '')),
+        publicPath: path.join('/generated', channel.collection, channel.id.replace(`-${channel.data.version}`, '')),
         type: 'event',
       },
     };

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

@@ -1,14 +1,18 @@
 import type { CollectionTypes } from '@types';
 import { getCollection, type CollectionEntry } from 'astro:content';
+import path from 'node:path';
 
 export type ChangeLog = CollectionEntry<'changelogs'>;
 
 export const getChangeLogs = async (item: CollectionEntry<CollectionTypes>): Promise<ChangeLog[]> => {
-  const { collection, data, slug } = item;
+  const { collection, data, filePath } = item;
 
   // Get all logs for collection type and filter by given collection
   const logs = await getCollection('changelogs', (log) => {
-    return log.id.includes(`${collection}/`) && log.slug.includes('/' + slug + '/');
+    const collectionDirectory = path.dirname(item?.filePath || '');
+    const isRootChangeLog = path.join(collectionDirectory, 'changelog.md') === log.filePath;
+    const isVersionedChangeLog = log.filePath?.includes(path.join(collectionDirectory, 'versioned'));
+    return log.id.includes(`${collection}/`) && (isRootChangeLog || isVersionedChangeLog);
   });
 
   const hydratedLogs = logs.map((log) => {

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

@@ -28,7 +28,7 @@ export const getDomains = async ({ getAllVersions = true }: Props = {}): Promise
 
   // Get all the domains that are not versioned
   const domains = await getCollection('domains', (domain) => {
-    return (getAllVersions || !domain.data?.pathToFile?.includes('versioned')) && domain.data.hidden !== true;
+    return (getAllVersions || !domain.filePath?.includes('versioned')) && domain.data.hidden !== true;
   });
 
   // Get all the services that are not versioned
@@ -60,7 +60,7 @@ export const getDomains = async ({ getAllVersions = true }: Props = {}): Promise
         absoluteFilePath: path.join(PROJECT_DIR, domain.collection, domain.id.replace('/index.mdx', '/index.md')),
         astroContentFilePath: path.join(process.cwd(), 'src', 'content', domain.collection, domain.id),
         filePath: path.join(process.cwd(), 'src', 'catalog-files', domain.collection, domain.id.replace('/index.mdx', '')),
-        publicPath: path.join('/generated', domain.collection, domain.id.replace('/index.mdx', '')),
+        publicPath: path.join('/generated', domain.collection, domain.id.replace(`-${domain.data.version}`, '')),
         type: 'service',
       },
     };
@@ -102,7 +102,9 @@ export const getMessagesForDomain = async (
 
 export const getUbiquitousLanguage = async (domain: Domain): Promise<UbiquitousLanguage[]> => {
   const ubiquitousLanguages = await getCollection('ubiquitousLanguages', (ubiquitousLanguage: UbiquitousLanguage) => {
-    return ubiquitousLanguage.slug.startsWith(`${domain.collection}/${domain.slug}`);
+    const domainFolder = path.dirname(domain.filePath || '');
+    const ubiquitousLanguageFolder = path.dirname(ubiquitousLanguage.filePath || '');
+    return domainFolder === ubiquitousLanguageFolder;
   });
 
   return ubiquitousLanguages;

package/eventcatalog/src/utils/collections/file-diffs.ts

@@ -29,7 +29,7 @@ export async function getFilesForDiffInCollection(
   collection: CollectionEntry<CollectionTypes>
 ): Promise<Array<{ file: string; dir: string }>> {
   // @ts-ignore
-  const pathToFolder = collection.data.pathToFile;
+  const pathToFolder = collection.filePath;
   if (!pathToFolder) return [];
 
   const dir = dirname(pathToFolder);

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

@@ -26,7 +26,7 @@ export const getFlows = async ({ getAllVersions = true }: Props = {}): Promise<F
 
   // Get flows that are not versioned
   const flows = await getCollection('flows', (flow) => {
-    return (getAllVersions || !flow.data.pathToFile?.includes('versioned')) && flow.data.hidden !== true;
+    return (getAllVersions || !flow.filePath?.includes('versioned')) && flow.data.hidden !== true;
   });
 
   const events = await getCollection('events');
@@ -63,7 +63,7 @@ export const getFlows = async ({ getAllVersions = true }: Props = {}): Promise<F
         absoluteFilePath: path.join(PROJECT_DIR, flow.collection, flow.id.replace('/index.mdx', '/index.md')),
         astroContentFilePath: path.join(process.cwd(), 'src', 'content', flow.collection, flow.id),
         filePath: path.join(process.cwd(), 'src', 'catalog-files', flow.collection, flow.id.replace('/index.mdx', '')),
-        publicPath: path.join('/generated', flow.collection, flow.id.replace('/index.mdx', '')),
+        publicPath: path.join('/generated', flow.collection),
         type: 'flow',
       },
     };

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

@@ -21,15 +21,16 @@ let cachedServices: Record<string, Service[]> = {
 export const getServices = async ({ getAllVersions = true }: Props = {}): Promise<Service[]> => {
   const cacheKey = getAllVersions ? 'allVersions' : 'currentVersions';
 
-  // Check if we have cached domains for this specific getAllVersions value
-  if (cachedServices[cacheKey].length > 0) {
-    return cachedServices[cacheKey];
-  }
+  // // Check if we have cached domains for this specific getAllVersions value
+  // if (cachedServices[cacheKey].length > 0) {
+  //   return cachedServices[cacheKey];
+  // }
 
   // Get services that are not versioned
   const services = await getCollection('services', (service) => {
-    return (getAllVersions || !service.data?.pathToFile?.includes('versioned')) && service.data.hidden !== true;
+    return (getAllVersions || !service.filePath?.includes('versioned')) && service.data.hidden !== true;
   });
+
   const events = await getCollection('events');
   const commands = await getCollection('commands');
   const queries = await getCollection('queries');
@@ -73,7 +74,8 @@ export const getServices = async ({ getAllVersions = true }: Props = {}): Promis
         absoluteFilePath: path.join(PROJECT_DIR, service.collection, service.id.replace('/index.mdx', '/index.md')),
         astroContentFilePath: path.join(process.cwd(), 'src', 'content', service.collection, service.id),
         filePath: path.join(process.cwd(), 'src', 'catalog-files', service.collection, service.id.replace('/index.mdx', '')),
-        publicPath: path.join('/generated', service.collection, service.id.replace('/index.mdx', '')),
+        // service will be MySerive-0.0.1 remove the version
+        publicPath: path.join('/generated', service.collection, service.id.replace(`-${service.data.version}`, '')),
         type: 'service',
       },
     };

package/eventcatalog/src/utils/commands.ts

@@ -31,7 +31,7 @@ export const getCommands = async ({ getAllVersions = true }: Props = {}): Promis
   }
 
   const commands = await getCollection('commands', (command) => {
-    return (getAllVersions || !command.data?.pathToFile?.includes('versioned')) && command.data.hidden !== true;
+    return (getAllVersions || !command.filePath?.includes('versioned')) && command.data.hidden !== true;
   });
 
   const services = await getCollection('services');
@@ -74,7 +74,7 @@ export const getCommands = async ({ getAllVersions = true }: Props = {}): Promis
         absoluteFilePath: path.join(PROJECT_DIR, command.collection, command.id.replace('/index.mdx', '/index.md')),
         astroContentFilePath: path.join(process.cwd(), 'src', 'content', command.collection, command.id),
         filePath: path.join(process.cwd(), 'src', 'catalog-files', command.collection, command.id.replace('/index.mdx', '')),
-        publicPath: path.join('/generated', command.collection, command.id.replace('/index.mdx', '')),
+        publicPath: path.join('/generated', command.collection, command.id.replace(`-${command.data.version}`, '')),
         type: 'command',
       },
     };

package/eventcatalog/src/utils/events.ts

@@ -31,7 +31,7 @@ export const getEvents = async ({ getAllVersions = true }: Props = {}): Promise<
   }
 
   const events = await getCollection('events', (event) => {
-    return (getAllVersions || !event.data?.pathToFile?.includes('versioned')) && event.data.hidden !== true;
+    return (getAllVersions || !event.filePath?.includes('versioned')) && event.data.hidden !== true;
   });
 
   const services = await getCollection('services');
@@ -74,7 +74,7 @@ export const getEvents = async ({ getAllVersions = true }: Props = {}): Promise<
         absoluteFilePath: path.join(PROJECT_DIR, event.collection, event.id.replace('/index.mdx', '/index.md')),
         astroContentFilePath: path.join(process.cwd(), 'src', 'content', event.collection, event.id),
         filePath: path.join(process.cwd(), 'src', 'catalog-files', event.collection, event.id.replace('/index.mdx', '')),
-        publicPath: path.join('/generated', event.collection, event.id.replace('/index.mdx', '')),
+        publicPath: path.join('/generated', event.collection, event.id.replace(`-${event.data.version}`, '')),
         type: 'event',
       },
     };

package/eventcatalog/src/utils/queries.ts

@@ -31,7 +31,7 @@ export const getQueries = async ({ getAllVersions = true }: Props = {}): Promise
   }
 
   const queries = await getCollection('queries', (query) => {
-    return (getAllVersions || !query.data?.pathToFile?.includes('versioned')) && query.data.hidden !== true;
+    return (getAllVersions || !query.filePath?.includes('versioned')) && query.data.hidden !== true;
   });
 
   const services = await getCollection('services');
@@ -74,7 +74,7 @@ export const getQueries = async ({ getAllVersions = true }: Props = {}): Promise
         absoluteFilePath: path.join(PROJECT_DIR, query.collection, query.id.replace('/index.mdx', '/index.md')),
         astroContentFilePath: path.join(process.cwd(), 'src', 'content', query.collection, query.id),
         filePath: path.join(process.cwd(), 'src', 'catalog-files', query.collection, query.id.replace('/index.mdx', '')),
-        publicPath: path.join('/generated', query.collection, query.id.replace('/index.mdx', '')),
+        publicPath: path.join('/generated', query.collection, query.id.replace(`-${query.data.version}`, '')),
         type: 'event',
       },
     };

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.29.4",
+  "version": "2.30.0",
   "publishConfig": {
     "access": "public"
   },
@@ -21,15 +21,15 @@
     "default-files-for-collections/"
   ],
   "dependencies": {
-    "@astrojs/markdown-remark": "^6.2.0",
-    "@astrojs/mdx": "^4.1.0",
+    "@astrojs/markdown-remark": "^6.3.0",
+    "@astrojs/mdx": "^4.2.0",
     "@astrojs/react": "^4.2.1",
     "@astrojs/rss": "^4.0.11",
     "@astrojs/tailwind": "^6.0.0",
     "@asyncapi/avro-schema-parser": "^3.0.24",
     "@asyncapi/parser": "^3.4.0",
     "@asyncapi/react-component": "^2.4.3",
-    "@eventcatalog/generator-ai": "^0.1.5",
+    "@eventcatalog/generator-ai": "^1.0.0",
     "@fontsource/inter": "^5.2.5",
     "@headlessui/react": "^2.0.3",
     "@heroicons/react": "^2.1.3",
@@ -45,7 +45,7 @@
     "@tailwindcss/typography": "^0.5.13",
     "@tanstack/react-table": "^8.17.3",
     "@xyflow/react": "^12.3.6",
-    "astro": "^5.4.1",
+    "astro": "^5.5.2",
     "astro-expressive-code": "^0.40.1",
     "astro-pagefind": "^1.6.0",
     "astro-seo": "^0.8.4",
@@ -99,6 +99,7 @@
     "@types/semver": "^7.5.8",
     "@types/shelljs": "^0.8.15",
     "@types/update-notifier": "^6.0.8",
+    "@types/uuid": "^10.0.0",
     "prettier": "^3.3.3",
     "prettier-plugin-astro": "^0.14.1",
     "tsup": "^8.1.0",

package/dist/chunk-R2NILSWL.js

@@ -1,82 +0,0 @@
-import {
-  addPropertyToFrontMatter,
-  verifyRequiredFieldsAreInCatalogConfigFile
-} from "./chunk-E7TXTI7G.js";
-import {
-  mapCatalogToAstro
-} from "./chunk-FIY5JLSQ.js";
-
-// src/catalog-to-astro-content-directory.js
-import { glob } from "glob";
-import * as path from "node:path";
-import fs from "fs";
-import { fileURLToPath } from "url";
-import os from "node:os";
-var __filename = fileURLToPath(import.meta.url);
-var rootPkg = path.resolve(path.dirname(__filename), "../");
-var copyFiles = async (source, target) => {
-  const files = await glob(path.join(source, "**"), {
-    nodir: true,
-    windowsPathsNoEscape: os.platform() == "win32"
-  });
-  for (const file of files) {
-    mapCatalogToAstro({
-      filePath: file,
-      astroDir: target,
-      projectDir: source
-    }).map((astroPath) => {
-      fs.cpSync(file, astroPath);
-      return { oldPath: file, newPath: astroPath };
-    }).map(({ oldPath, newPath }) => {
-      if (!oldPath.endsWith(".md") && !oldPath.endsWith(".mdx")) return;
-      try {
-        const content = fs.readFileSync(newPath, "utf-8");
-        const frontmatter = addPropertyToFrontMatter(content, "pathToFile", oldPath);
-        fs.writeFileSync(newPath, frontmatter);
-      } catch (error) {
-      }
-    });
-  }
-};
-var ensureAstroCollectionNotEmpty = async (astroDir) => {
-  const COLLECTIONS = [
-    "events",
-    "commands",
-    "services",
-    "domains",
-    "flows",
-    "changelogs",
-    "queries",
-    "channels",
-    "ubiquitousLanguages"
-  ];
-  const emptyCollections = [];
-  for (const collection of COLLECTIONS) {
-    const markdownFiles = await glob(path.join(astroDir, "src/content/", collection, "**"), {
-      nodir: true,
-      windowsPathsNoEscape: os.platform() == "win32"
-    });
-    if (markdownFiles.length === 0) emptyCollections.push(collection);
-  }
-  const defaultCollectionFilesDir = path.join(rootPkg, "default-files-for-collections");
-  for (const collection of emptyCollections) {
-    const defaultFile = path.join(defaultCollectionFilesDir, `${collection}.md`);
-    const targetDir = path.join(astroDir, "src/content/", collection);
-    if (!fs.existsSync(targetDir)) {
-      fs.mkdirSync(targetDir, { recursive: true });
-    }
-    fs.cpSync(defaultFile, path.join(targetDir, `${collection}.md`));
-  }
-};
-var catalogToAstro = async (source, astroDir) => {
-  const astroContentDir = path.join(astroDir, "src/content/");
-  if (fs.existsSync(astroContentDir)) fs.rmSync(astroContentDir, { recursive: true });
-  fs.mkdirSync(astroContentDir);
-  await verifyRequiredFieldsAreInCatalogConfigFile(source);
-  await copyFiles(source, astroDir);
-  await ensureAstroCollectionNotEmpty(astroDir);
-};
-
-export {
-  catalogToAstro
-};