@eventcatalog/core 2.33.0 → 2.33.1

package/dist/analytics/analytics.cjs

@@ -37,7 +37,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.33.0";
+var version = "2.33.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-MC6EBL4I.js";
-import "../chunk-TNU27WQF.js";
+} from "../chunk-VDBGM3NV.js";
+import "../chunk-IVIWGH2J.js";
 export {
   raiseEvent
 };

package/dist/analytics/log-build.cjs

@@ -106,7 +106,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.33.0";
+var version = "2.33.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,8 +1,8 @@
 import {
   log_build_default
-} from "../chunk-MXEVMOGW.js";
-import "../chunk-MC6EBL4I.js";
-import "../chunk-TNU27WQF.js";
+} from "../chunk-R3X2SCY6.js";
+import "../chunk-VDBGM3NV.js";
+import "../chunk-IVIWGH2J.js";
 import "../chunk-E7TXTI7G.js";
 export {
   log_build_default as default

package/dist/{chunk-TNU27WQF.js → chunk-IVIWGH2J.js}

@@ -1,5 +1,5 @@
 // package.json
-var version = "2.33.0";
+var version = "2.33.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/{chunk-MXEVMOGW.js → chunk-R3X2SCY6.js}

@@ -1,6 +1,6 @@
 import {
   raiseEvent
-} from "./chunk-MC6EBL4I.js";
+} from "./chunk-VDBGM3NV.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile

package/dist/{chunk-MC6EBL4I.js → chunk-VDBGM3NV.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-TNU27WQF.js";
+} from "./chunk-IVIWGH2J.js";
 
 // src/analytics/analytics.js
 import axios from "axios";

package/dist/constants.cjs

@@ -25,7 +25,7 @@ __export(constants_exports, {
 module.exports = __toCommonJS(constants_exports);
 
 // package.json
-var version = "2.33.0";
+var version = "2.33.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-TNU27WQF.js";
+} from "./chunk-IVIWGH2J.js";
 export {
   VERSION
 };

package/dist/eventcatalog.cjs

@@ -157,7 +157,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.33.0";
+var version = "2.33.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/eventcatalog.js

@@ -6,15 +6,15 @@ import {
 } from "./chunk-UKJ7F5WR.js";
 import {
   log_build_default
-} from "./chunk-MXEVMOGW.js";
-import "./chunk-MC6EBL4I.js";
+} from "./chunk-R3X2SCY6.js";
+import "./chunk-VDBGM3NV.js";
 import {
   catalogToAstro,
   checkAndConvertMdToMdx
 } from "./chunk-7SI5EVOX.js";
 import {
   VERSION
-} from "./chunk-TNU27WQF.js";
+} from "./chunk-IVIWGH2J.js";
 import {
   isBackstagePluginEnabled,
   isEventCatalogScaleEnabled,

package/eventcatalog/src/components/Lists/CustomSideBarSectionList.astro

@@ -3,6 +3,7 @@ import { buildUrl } from '@utils/url-builder';
 import { getCollection } from 'astro:content';
 import { getItemsFromCollectionByIdAndSemverOrLatest } from '@utils/collections/util';
 import PillListFlat from './PillListFlat';
+import { resourceToCollectionMap } from '@utils/collections/util';
 interface Props {
   section?: {
     title?: string;
@@ -20,19 +21,6 @@ const title = section?.title || 'Custom Section';
 const limit = section?.limit || 10;
 const sectionItems = section?.items || [];
 
-// Type-safe mapping of resource types to collection names
-const resourceToCollectionMap = {
-  service: 'services',
-  event: 'events',
-  command: 'commands',
-  query: 'queries',
-  domain: 'domains',
-  flow: 'flows',
-  channel: 'channels',
-  user: 'users',
-  team: 'teams',
-} as const; // Make this a const assertion
-
 // Array to store resolved related resources
 const resolvedResources = [];
 

package/eventcatalog/src/components/MDX/ResourceGroupTable/ResourceGroupTable.astro

@@ -4,6 +4,7 @@ import { getCollection } from 'astro:content';
 import { getItemsFromCollectionByIdAndSemverOrLatest } from '@utils/collections/util';
 import ResourceGroupTableClient from './ResourceGroupTable.client';
 import Admonition from '../Admonition';
+import { resourceToCollectionMap } from '@utils/collections/util';
 
 export interface Props extends CollectionEntry<'services'> {
   limit?: number;
@@ -31,19 +32,6 @@ const section = resource.data.resourceGroups?.find((section: any) => section.id
 
 const collection = Astro.props.collection as 'services' | 'domains';
 
-// Type-safe mapping of resource types to collection names
-const resourceToCollectionMap = {
-  service: 'services',
-  event: 'events',
-  command: 'commands',
-  query: 'queries',
-  domain: 'domains',
-  flow: 'flows',
-  channel: 'channels',
-  user: 'users',
-  team: 'teams',
-} as const;
-
 // This will hold our processed resources for the client component
 const resolvedResources: any[] = [];
 

package/eventcatalog/src/components/MDX/ResourceLink/ResourceLink.astro

@@ -1,17 +1,6 @@
 ---
 import { buildUrl } from '@utils/url-builder';
-
-const resourceToCollectionMap = {
-  service: 'services',
-  event: 'events',
-  command: 'commands',
-  query: 'queries',
-  domain: 'domains',
-  flow: 'flows',
-  channel: 'channels',
-  user: 'users',
-  team: 'teams',
-} as const;
+import { resourceToCollectionMap } from '@utils/collections/util';
 
 const { id, version, type } = Astro.props;
 const collection = resourceToCollectionMap[type as keyof typeof resourceToCollectionMap];

package/eventcatalog/src/components/MDX/SchemaViewer/SchemaViewer.astro

@@ -6,39 +6,13 @@ import yaml from 'js-yaml';
 import path from 'path';
 import SchemaViewerClient from './SchemaViewer';
 import Admonition from '../Admonition';
-let schemas = [];
-
-function findSchemaViewers(document: string) {
-  // Define regex pattern to match <SchemaViewer ... />
-  const pattern = /<SchemaViewer\s+([^>]*)\/>/g;
-
-  // Find all matches of the pattern
-  const matches = [...document.matchAll(pattern)];
-
-  // Extract the properties of each SchemaViewer
-  const schemaViewers = matches.map((match) => {
-    const propsString = match[1];
-    const props = {};
-
-    // Use regex to extract key-value pairs from propsString
-    const propsPattern = /(\w+)=["']([^"']+)["']/g;
-    let propMatch;
-    while ((propMatch = propsPattern.exec(propsString)) !== null) {
-      const key = propMatch[1];
-      const value = propMatch[2];
-      // @ts-ignore
-      props[key] = value;
-    }
-
-    return props;
-  });
+import { getMDXComponentsByName } from '@utils/markdown';
 
-  return schemaViewers;
-}
+let schemas = [];
 
 try {
   const file = await fs.readFile(filePath, 'utf-8');
-  const schemaViewers = findSchemaViewers(file);
+  const schemaViewers = getMDXComponentsByName(file, 'SchemaViewer');
 
   // Loop around all the possible SchemaViewers in the file.
   const getAllComponents = schemaViewers.map(async (schemaViewerProps: any) => {

package/eventcatalog/src/components/MDX/components.tsx

@@ -34,7 +34,7 @@ const components = (props: any) => {
     Flow,
     Link: (mdxProp: any) => jsx(Link, { ...props, ...mdxProp }),
     MessageTable: (mdxProp: any) => jsx(MessageTable, { ...props, ...mdxProp }),
-    NodeGraph: (mdxProp: any) => NodeGraphPortal({ ...props.data, ...mdxProp }),
+    NodeGraph: (mdxProp: any) => jsx(NodeGraphPortal, { ...props.data, ...mdxProp, props, mdxProp }),
     OpenAPI,
     ResourceGroupTable: (mdxProp: any) => jsx(ResourceGroupTable, { ...props, ...mdxProp }),
     ResourceLink: (mdxProp: any) => jsx(ResourceLink, { ...props, ...mdxProp }),

package/eventcatalog/src/enterprise/custom-documentation/pages/docs/custom/index.astro

@@ -9,15 +9,19 @@ import OwnersList from '@components/Lists/OwnersList';
 
 import { getOwner } from '@utils/collections/owners';
 import { buildUrl } from '@utils/url-builder';
+import { resourceToCollectionMap } from '@utils/collections/util';
+import { getMDXComponentsByName } from '@utils/markdown';
+import { getAdjacentPages } from '@enterprise/custom-documentation/utils/custom-docs';
 
 import CustomDocsNav from '@enterprise/custom-documentation/components/CustomDocsNav/CustomDocsNav.astro';
-import { getAdjacentPages } from '@enterprise/custom-documentation/utils/custom-docs';
+import NodeGraph from '@components/MDX/NodeGraph/NodeGraph.astro';
 
 const props = Astro.props;
 const doc = props.data;
 const { Content, headings } = await render(props as any);
 const currentSlug = props.id;
 
+const nodeGraphs = getMDXComponentsByName(props.body, 'NodeGraph') || [];
 // Get sidebar data
 const sidebar = config?.customDocs?.sidebar || [];
 
@@ -116,6 +120,27 @@ const badges = doc?.badges || [];
           <Content components={{ ...mdxComponents(props) }} />
         </div>
 
+        {
+          nodeGraphs.length > 0 &&
+            nodeGraphs.map((nodeGraph: any) => {
+              const collection = resourceToCollectionMap[nodeGraph.type as keyof typeof resourceToCollectionMap];
+              return (
+                <NodeGraph
+                  id={nodeGraph.id}
+                  version={nodeGraph.version}
+                  collection={collection}
+                  title={nodeGraph.title}
+                  mode="simple"
+                  linksToVisualiser={true}
+                  href={{
+                    label: 'Open in Visualiser',
+                    url: buildUrl(`/visualiser/${collection}/${nodeGraph.id}/${nodeGraph.version}`),
+                  }}
+                />
+              );
+            })
+        }
+
         <!-- Previous / Next Navigation -->
         <div class="py-8 border-t border-gray-200 mt-8">
           <div class="flex flex-col sm:flex-row justify-between w-full gap-4">

package/eventcatalog/src/pages/docs/custom/[...path].mdx.ts

@@ -0,0 +1,32 @@
+// 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, GetStaticPaths } from 'astro';
+import { getCollection } from 'astro:content';
+import config from '@config';
+import fs from 'fs';
+
+export const getStaticPaths = (async () => {
+  const docs = await getCollection('customPages');
+  const paths = docs.map((doc) => ({
+    params: { path: doc.id.replace('docs/', '') },
+    props: doc,
+    type: 'custom',
+  }));
+  return paths;
+}) satisfies GetStaticPaths;
+
+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.filePath) {
+    const file = fs.readFileSync(props.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

@@ -1,7 +1,10 @@
-import { getCollection } from 'astro:content';
+import { getCollection, type CollectionEntry } from 'astro:content';
 import config from '@config';
 import type { APIRoute } from 'astro';
 import fs from 'fs';
+import { isCustomDocsEnabled } from '@utils/feature';
+
+type AllowedCollections = 'events' | 'commands' | 'queries' | 'services' | 'domains' | 'teams' | 'users' | 'customPages';
 
 const events = await getCollection('events');
 const commands = await getCollection('commands');
@@ -11,12 +14,26 @@ const domains = await getCollection('domains');
 const teams = await getCollection('teams');
 const users = await getCollection('users');
 
+const customDocs = await getCollection('customPages');
+
 export const GET: APIRoute = async ({ params, request }) => {
   if (!config.llmsTxt?.enabled) {
     return new Response('llms.txt is not enabled for this Catalog.', { status: 404 });
   }
 
-  const resources = [...events, ...commands, ...queries, ...services, ...domains, ...teams, ...users];
+  const resources: CollectionEntry<AllowedCollections>[] = [
+    ...events,
+    ...commands,
+    ...queries,
+    ...services,
+    ...domains,
+    ...teams,
+    ...users,
+  ];
+
+  if (isCustomDocsEnabled()) {
+    resources.push(...(customDocs as CollectionEntry<AllowedCollections>[]));
+  }
 
   const content = resources
     .map((item) => {

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

@@ -2,6 +2,8 @@ import { getCollection } from 'astro:content';
 import config from '@config';
 import type { APIRoute } from 'astro';
 
+import { isCustomDocsEnabled } from '@utils/feature';
+
 const events = await getCollection('events');
 const commands = await getCollection('commands');
 const queries = await getCollection('queries');
@@ -12,6 +14,8 @@ const domains = await getCollection('domains');
 const teams = await getCollection('teams');
 const users = await getCollection('users');
 
+const customDocs = await getCollection('customPages');
+
 export const GET: APIRoute = async ({ params, request }) => {
   const url = new URL(request.url);
   const baseUrl = `${url.protocol}//${url.host}`;
@@ -22,6 +26,9 @@ export const GET: APIRoute = async ({ params, request }) => {
   const formatSimpleItem = (item: any, type: string) =>
     `- [${item.id.replace('.mdx', '')}](${baseUrl}/docs/${type}/${item.data.id}.mdx) - ${item.data.name}`;
 
+  const formatCustomDoc = (item: any, route: string) =>
+    `- [${item.data.title}](${baseUrl}/${route}/${item.id.replace('docs\/', '')}.mdx) - ${item.data.summary || ''}`;
+
   const content = [
     `# ${config.organizationName} EventCatalog Documentation\n`,
     `> ${config.tagline}`,
@@ -39,6 +46,9 @@ export const GET: APIRoute = async ({ params, request }) => {
     teams.map((item) => formatSimpleItem(item, 'teams')).join('\n'),
     '\n## Users',
     users.map((item) => formatSimpleItem(item, 'users')).join('\n'),
+    ...(isCustomDocsEnabled()
+      ? ['\n## Custom Docs', customDocs.map((item) => formatCustomDoc(item, 'docs/custom')).join('\n')]
+      : []),
   ].join('\n');
 
   return new Response(content, {

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

@@ -97,3 +97,15 @@ export const findMatchingNodes = (
     });
   });
 };
+
+export const resourceToCollectionMap = {
+  service: 'services',
+  event: 'events',
+  command: 'commands',
+  query: 'queries',
+  domain: 'domains',
+  flow: 'flows',
+  channel: 'channels',
+  user: 'users',
+  team: 'teams',
+} as const;

package/eventcatalog/src/utils/markdown.ts

@@ -0,0 +1,30 @@
+// Method returns MDX components and there props in markdown files
+// rarely used, but useful for components that need to know how many times
+// the user wants to render a component in a markdown file
+export const getMDXComponentsByName = (document: string, componentName: string) => {
+  // Define regex pattern to match <SchemaViewer ... />
+  const pattern = new RegExp(`<${componentName}\\s+([^>]*)\\/>`, 'g');
+
+  // Find all matches of the pattern
+  const matches = [...document.matchAll(pattern)];
+
+  // Extract the properties of each SchemaViewer
+  const components = matches.map((match) => {
+    const propsString = match[1];
+    const props = {};
+
+    // Use regex to extract key-value pairs from propsString
+    const propsPattern = /(\w+)=["']([^"']+)["']/g;
+    let propMatch;
+    while ((propMatch = propsPattern.exec(propsString)) !== null) {
+      const key = propMatch[1];
+      const value = propMatch[2];
+      // @ts-ignore
+      props[key] = value;
+    }
+
+    return props;
+  });
+
+  return components;
+};

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.33.0",
+  "version": "2.33.1",
   "publishConfig": {
     "access": "public"
   },