@eventcatalog/core 2.21.5 → 2.23.0

package/eventcatalog/src/layouts/VerticalSideBarLayout.astro

@@ -8,6 +8,7 @@ interface Props {
 import { BookOpenText, Workflow, TableProperties, House, BookUser } from 'lucide-react';
 import Header from '../components/Header.astro';
 import SEO from '../components/Seo.astro';
+import SideNav from '../components/SideNav/SideNav.astro';
 
 import { getCommands } from '@utils/commands';
 import { getDomains } from '@utils/collections/domains';
@@ -17,8 +18,6 @@ import { getFlows } from '@utils/collections/flows';
 import { isCollectionVisibleInCatalog } from '@eventcatalog';
 import { buildUrl } from '@utils/url-builder';
 import { getQueries } from '@utils/queries';
-import { getChannels } from '@utils/channels';
-import CatalogResourcesSideBar from '@components/SideBars/CatalogResourcesSideBar';
 import { hasLandingPageForDocs } from '@utils/pages';
 
 const events = await getEvents({ getAllVersions: false });
@@ -26,14 +25,8 @@ const commands = await getCommands({ getAllVersions: false });
 const queries = await getQueries({ getAllVersions: false });
 const services = await getServices({ getAllVersions: false });
 const domains = await getDomains({ getAllVersions: false });
-const channels = await getChannels({ getAllVersions: false });
 const flows = await getFlows({ getAllVersions: false });
 
-const messages = [...events, ...commands, ...queries];
-
-// @ts-ignore for large catalogs https://github.com/event-catalog/eventcatalog/issues/552
-const allData = [...domains, ...services, ...messages, ...channels, ...flows];
-
 const currentPath = Astro.url.pathname;
 
 const catalogHasDefaultLandingPageForDocs = await hasLandingPageForDocs();
@@ -101,45 +94,8 @@ const navigationItems = [
   },
 ];
 
-const allDataAsSideNav = allData.reduce((acc, item) => {
-  const title = item.collection;
-  const group = acc[title] || [];
-  const currentPath = Astro.url.pathname;
-  const route = currentPath.includes('visualiser') ? 'visualiser' : 'docs';
-
-  const navigationItem = {
-    label: item.data.name,
-    version: item.data.version,
-    visible: isCollectionVisibleInCatalog(item.collection),
-    // @ts-ignore
-    href: item.data.version
-      ? // @ts-ignore
-        buildUrl(`/${route}/${item.collection}/${item.data.id}/${item.data.version}`)
-      : buildUrl(`/${route}/${item.collection}/${item.data.id}`),
-    collection: item.collection,
-  };
-
-  group.push(navigationItem);
-
-  return {
-    ...acc,
-    [title]: group,
-  };
-}, {} as any);
-
-const sideNav = {
-  ...(currentPath.includes('visualiser')
-    ? {
-        'bounded context map': [
-          { label: 'Domain map', href: buildUrl('/visualiser/context-map'), collection: 'bounded-context-map' },
-        ],
-      }
-    : {}),
-  ...allDataAsSideNav,
-};
-
 const currentNavigationItem = navigationItems.find((item) => item.current);
-const { title, description, sidebar: showSideBarOverride } = Astro.props;
+const { title, description } = Astro.props;
 
 const showSideBarOnLoad = currentNavigationItem?.sidebar;
 
@@ -198,12 +154,10 @@ const canPageBeEmbedded = process.env.ENABLE_EMBED === 'true';
           </nav>
         </div>
 
-        <div
+        <SideNav
           id="sidebar"
-          class={`sidebar-transition h-content px-5 py-4 overflow-y-auto bg-white bg-gradient-to-b  border-r border-gray-100 w-60 ml-16 ${showSideBarOnLoad ? 'block' : 'hidden'}`}
-        >
-          <CatalogResourcesSideBar resources={sideNav} currentPath={currentPath} client:load />
-        </div>
+          class={`sidebar-transition h-content  overflow-y-auto bg-white  border-r border-gray-100 w-60 ml-16 ${showSideBarOnLoad ? 'block' : 'hidden'}`}
+        />
       </aside>
       <main
         class={`sidebar-transition w-full max-h-content overflow-y-auto ${showSideBarOnLoad ? 'ml-0' : 'ml-16'}`}

package/eventcatalog/src/pages/docs/[type]/[id]/[version].md.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?.data?.pathToFile) {
+    const file = fs.readFileSync(props.content.data.pathToFile, 'utf8');
+    return new Response(file, { status: 200 });
+  }
+
+  return new Response('Not found', { status: 404 });
+};

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

@@ -0,0 +1,31 @@
+import { getCollection } from 'astro:content';
+import config from '@config';
+import type { APIRoute } from 'astro';
+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 teams = await getCollection('teams');
+const users = await getCollection('users');
+
+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 content = resources
+    .map((item) => {
+      if (!item.data.pathToFile) return '';
+      return fs.readFileSync(item.data.pathToFile, 'utf8');
+    })
+    .join('\n');
+
+  return new Response(content, {
+    headers: { 'Content-Type': 'text/plain; charset=utf-8' },
+  });
+};

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

@@ -0,0 +1,47 @@
+import { getCollection } from 'astro:content';
+import config from '@config';
+import type { APIRoute } from 'astro';
+
+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 teams = await getCollection('teams');
+const users = await getCollection('users');
+
+export const GET: APIRoute = async ({ params, request }) => {
+  const url = new URL(request.url);
+  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}`;
+
+  const formatSimpleItem = (item: any, type: string) =>
+    `- [${item.id.replace('.md', '')}](${baseUrl}/docs/${type}/${item.data.id}.md) - ${item.data.name}`;
+
+  const content = [
+    `# ${config.organizationName} EventCatalog Documentation\n`,
+    `> ${config.tagline}`,
+    '\n## Events',
+    events.map((item) => formatVersionedItem(item, 'events')).join(''),
+    '\n## Commands',
+    commands.map((item) => formatVersionedItem(item, 'commands')).join(''),
+    '\n## Queries',
+    queries.map((item) => formatVersionedItem(item, 'queries')).join(''),
+    '\n## Services',
+    services.map((item) => formatVersionedItem(item, 'services')).join(''),
+    '\n## Domains',
+    domains.map((item) => formatVersionedItem(item, 'domains')).join(''),
+    '\n## Teams',
+    teams.map((item) => formatSimpleItem(item, 'teams')).join('\n'),
+    '\n## Users',
+    users.map((item) => formatSimpleItem(item, 'users')).join('\n'),
+  ].join('\n');
+
+  return new Response(content, {
+    headers: { 'Content-Type': 'text/plain; charset=utf-8' },
+  });
+};

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

@@ -0,0 +1,40 @@
+// 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 teams = await getCollection('teams');
+
+export async function getStaticPaths() {
+  // Just return empty array if LLMs are not enabled
+  if (!config.llmsTxt?.enabled) {
+    return [];
+  }
+
+  console.log(teams);
+
+  return teams.map((team) => ({
+    params: { type: 'teams', id: team.data.id },
+    props: { content: team },
+  }));
+}
+
+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 });
+  }
+
+  console.log(props.context);
+
+  if (props?.content?.data?.pathToFile) {
+    const file = fs.readFileSync(props.content.data.pathToFile, 'utf8');
+    return new Response(file, { status: 200 });
+  }
+
+  return new Response('Not found', { status: 404 });
+};

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

@@ -0,0 +1,36 @@
+// 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 users = await getCollection('users');
+
+export async function getStaticPaths() {
+  // Just return empty array if LLMs are not enabled
+  if (!config.llmsTxt?.enabled) {
+    return [];
+  }
+
+  return users.map((user) => ({
+    params: { type: 'users', id: user.data.id },
+    props: { content: user },
+  }));
+}
+
+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?.data?.pathToFile) {
+    const file = fs.readFileSync(props.content.data.pathToFile, 'utf8');
+    return new Response(file, { status: 200 });
+  }
+
+  return new Response('Not found', { status: 404 });
+};

package/package.json

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