@eventcatalog/core 2.24.2 → 2.25.0

package/eventcatalog/src/pages/docs/index.astro

@@ -1,6 +1,5 @@
 ---
 import Footer from '@layouts/Footer.astro';
-import DefaultDocsLandingPage from '@layouts/CustomDocsPageLayout.astro';
 import components from '@components/MDX/page-components';
 import { getIndexPage } from '@utils/pages';
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
@@ -11,24 +10,20 @@ let CustomContent = null;
 if (page) {
   const { Content } = await page.render();
   CustomContent = Content;
+} else {
+  CustomContent = await import('./_default-docs.mdx').then((mod) => mod.default);
 }
 ---
 
-{
-  CustomContent && (
-    <VerticalSideBarLayout title="EventCatalog">
-      <main class="flex sm:px-8 docs-layout h-full">
-        <div class="flex docs-layout w-full">
-          <div class="w-full lg:mr-2 pr-8 overflow-y-auto py-8">
-            <div class="prose prose-md w-full !max-w-none">
-              <CustomContent components={components} />
-            </div>
-            <Footer />
-          </div>
+<VerticalSideBarLayout title="EventCatalog">
+  <main class="flex sm:px-8 docs-layout h-full">
+    <div class="flex docs-layout w-full">
+      <div class="w-full lg:mr-2 pr-8 overflow-y-auto py-8">
+        <div class="prose prose-md w-full !max-w-none">
+          <CustomContent components={components} />
         </div>
-      </main>
-    </VerticalSideBarLayout>
-  )
-}
-
-{!CustomContent && <DefaultDocsLandingPage title="EventCatalog" />}
+        <Footer />
+      </div>
+    </div>
+  </main>
+</VerticalSideBarLayout>

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.24.2",
+  "version": "2.25.0",
   "publishConfig": {
     "access": "public"
   },
@@ -29,7 +29,7 @@
     "@asyncapi/avro-schema-parser": "^3.0.24",
     "@asyncapi/parser": "^3.4.0",
     "@asyncapi/react-component": "^2.4.3",
-    "@eventcatalog/generator-ai": "^0.1.2",
+    "@eventcatalog/generator-ai": "^0.1.5",
     "@headlessui/react": "^2.0.3",
     "@heroicons/react": "^2.1.3",
     "@huggingface/transformers": "^3.3.3",
@@ -37,6 +37,7 @@
     "@langchain/community": "^0.3.32",
     "@mlc-ai/web-llm": "^0.2.78",
     "@parcel/watcher": "^2.4.1",
+    "@radix-ui/react-context-menu": "^2.2.6",
     "@radix-ui/react-dialog": "^1.1.6",
     "@stoplight/json-schema-viewer": "^4.16.4",
     "@tailwindcss/typography": "^0.5.13",

package/default-files-for-collections/pages.md

@@ -1,7 +0,0 @@
----
-id: index
-slug: index
-hidden: true
----
-
-<!-- Do not delete this file, required for EC, you an ignore this file -->

package/eventcatalog/src/components/DocsNavigation.astro

@@ -1,145 +0,0 @@
----
-import { getCommands } from '@utils/commands';
-import { getDomains } from '@utils/collections/domains';
-import { getEvents } from '@utils/events';
-import { getServices } from '@utils/collections/services';
-import { getFlows } from '@utils/collections/flows';
-import { getTeams } from '@utils/teams';
-import { getUsers } from '@utils/users';
-import config, { type CatalogConfig } from '@utils/eventcatalog-config/catalog';
-import { buildUrl } from '@utils/url-builder';
-import { getQueries } from '@utils/queries';
-
-const events = await getEvents({ getAllVersions: false });
-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 flows = await getFlows({ getAllVersions: false });
-const teams = await getTeams();
-const users = await getUsers();
-
-const messages = [...events, ...commands, ...queries];
-
-// @ts-ignore for large catalogs https://github.com/event-catalog/eventcatalog/issues/552
-const allData = [...domains, ...services, ...messages, ...flows, ...teams, ...users];
-
-const eventCatalogConfig = config as CatalogConfig;
-const {
-  services: servicesConfig,
-  domains: domainsConfig,
-  messages: messagesConfig,
-  flows: flowsConfig,
-  teams: teamsConfig,
-  users: usersConfig,
-  showPageHeadings = true,
-} = eventCatalogConfig?.docs?.sidebar || {};
-
-const getConfigValue = (obj: any, key: string, defaultValue: any) => {
-  return obj?.[key] ?? defaultValue;
-};
-
-const visibleCollections: { [key: string]: boolean } = {
-  events: getConfigValue(messagesConfig, 'visible', true),
-  commands: getConfigValue(messagesConfig, 'visible', true),
-  domains: getConfigValue(domainsConfig, 'visible', true),
-  flows: getConfigValue(flowsConfig, 'visible', true),
-  services: getConfigValue(servicesConfig, 'visible', true),
-  teams: getConfigValue(teamsConfig, 'visible', true),
-  users: getConfigValue(usersConfig, 'visible', true),
-};
-
-const fetchHeadings = allData.map(async (item) => {
-  const renderHeadings = showPageHeadings;
-  const headings = renderHeadings ? await item.render() : { headings: [] };
-  return {
-    ...item,
-    headings: headings.headings,
-  };
-});
-
-const withHeadings = await Promise.all(fetchHeadings);
-
-const sideNav = withHeadings.reduce((acc, item) => {
-  const title = item.collection === 'events' || item.collection === 'commands' ? 'Messages' : item.collection;
-
-  const group = acc[title] || [];
-
-  const navigationItem = {
-    label: item.data.name,
-    version: item.collection === 'teams' || item.collection === 'users' ? null : item.data.version,
-    items: item.collection === 'users' ? [] : item.headings,
-    visible: visibleCollections[item.collection],
-    // @ts-ignore
-    href: item.data.version
-      ? // @ts-ignore
-        buildUrl(`/docs/${item.collection}/${item.data.id}/${item.data.version}`)
-      : buildUrl(`/docs/${item.collection}/${item.data.id}`),
-  };
-
-  group.push(navigationItem);
-
-  return {
-    ...acc,
-    [title]: group,
-  };
-}, {} as any);
-
-const currentPath = Astro.url.pathname;
----
-
-<div class="font-light w-full xl:pr-10 pb-20">
-  {
-    Object.keys(sideNav).map((key) => {
-      const collection = sideNav[key];
-      if (collection[0] && collection[0].visible === false) return null;
-      return (
-        <ul class=" w-full space-y-2 pb-8">
-          <li class="font-semibold capitalize ">{key}</li>
-          {collection.map((item: any) => {
-            return (
-              <li class="px-2 w-full text-md xl:text-lg border-l border-gray-200 space-y-2 scroll-m-20" id={item.href}>
-                <a
-                  class={`flex justify-between items-center w-full px-2 rounded-md font-normal ${currentPath.includes(item.href) ? 'bg-primary/5 text-primary ' : 'font-thin'}`}
-                  href={`${item.href}`}
-                >
-                  <span class="block truncate !whitespace-normal">{item.label}</span>
-                  {item.version && (
-                    <span class="block text-sm bg-primary/10 p-0.5 px-1 text-gray-600  rounded-md font-light">
-                      v{item.version}
-                    </span>
-                  )}
-                </a>
-                <ul class="hidden xl:block px-4  text-gray-500 text-md space-y-2  ">
-                  {item.items.map((heading: any) => {
-                    return (
-                      <li class="text-xs">
-                        <a href={`${item.href}#${heading.slug}`}>{heading.text}</a>
-                      </li>
-                    );
-                  })}
-                </ul>
-              </li>
-            );
-          })}
-        </ul>
-      );
-    })
-  }
-</div>
-
-<script>
-  // Scroll to the current page element
-  // document.addEventListener('DOMContentLoaded', () => {
-  //   const currentPath = document.location.pathname;
-  //   const currentElement = document.getElementById(currentPath);
-  //   if (currentElement) {
-  //     // scroll to the current element with padding
-  //     currentElement.scrollIntoView({
-  //       behavior: 'auto',
-  //       block: 'start',
-  //       inline: 'start',
-  //     });
-  //   }
-  // });
-</script>

package/eventcatalog/src/layouts/CustomDocsPageLayout.astro

@@ -1,131 +0,0 @@
----
-interface Props {
-  title: string;
-}
-
-import Footer from '@layouts/Footer.astro';
-import Header from '@components/Header.astro';
-import SideBar from '@components/DocsNavigation.astro';
-import { buildUrl } from '@utils/url-builder';
----
-
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="description" content="Astro description" />
-    <meta name="viewport" content="width=device-width" />
-    <link rel="icon" type="image/svg+xml" href={buildUrl('/favicon.ico', true)} />
-    <meta name="generator" content={Astro.generator} />
-    <title>EventCatalog</title>
-  </head>
-  <body>
-    <div class="px-10 max-w-[120em] mx-auto">
-      <Header />
-
-      <div class="md:pt-4">
-        <nav class="hidden sm:flex grow w-56 xl:w-[19em] fixed overflow-y-auto h-full py-2">
-          <div class="w-full">
-            <SideBar />
-          </div>
-        </nav>
-
-        <div class="pl-0 sm:pl-56 xl:pl-80 w-full pt-8 pb-40">
-          <div class="prose prose-sm">
-            <div class="bg-white">
-              <div class="mx-auto max-w-7xl">
-                <div class="mx-auto max-w-2xl lg:mx-0 lg:max-w-none">
-                  <h1 class="mt-2 text-3xl font-bold tracking-tight text-gray-900 sm:text-4xl mb-0">EventCatalog</h1>
-                  <div class="grid max-w-xl grid-cols-1 md:gap-8 text-base leading-7 text-gray-700 lg:max-w-none lg:grid-cols-1">
-                    <div>
-                      <p>
-                        Welcome to <a href="https://www.eventcatalog.dev/">EventCatalog</a>.
-                      </p>
-                      <p>
-                        This open-source project is designed to help you and your teams bring discoverability and clarity to your
-                        event-driven architectures (EDA).
-                      </p>
-                      <p>
-                        To get started you can read the following guides:
-                        <ul>
-                          <li>
-                            <a class="text-primary" href="https://eventcatalog.dev/docs/development/getting-started/introduction"
-                              >Getting started with EventCatalog</a
-                            >
-                          </li>
-                          <li>
-                            <a class="text-primary" href="https://eventcatalog.dev/docs/development/guides/domains/adding-domains"
-                              >Creating domains</a
-                            >
-                          </li>
-                          <li>
-                            <a
-                              class="text-primary"
-                              href="https://eventcatalog.dev/docs/development/guides/services/adding-services"
-                              >Creating services</a
-                            >
-                          </li>
-                          <li>
-                            <a
-                              class="text-primary"
-                              href="https://eventcatalog.dev/docs/development/guides/messages/commands/introduction"
-                              >Creating commands</a
-                            >
-                          </li>
-                          <li>
-                            <a
-                              class="text-primary"
-                              href="https://eventcatalog.dev/docs/development/guides/messages/events/introduction"
-                              >Creating events</a
-                            >
-                          </li>
-                          <li>
-                            <a class="text-primary" href="https://eventcatalog.dev/docs/owners">Assigning owners to resources</a>
-                          </li>
-                          <li>
-                            <a class="text-primary" href="https://eventcatalog.dev/docs/development/components/using-components"
-                              >Using components in your pages (Schemas, OpenAPI, etc)</a
-                            >
-                          </li>
-                          <li>
-                            <a class="text-primary" href="https://eventcatalog.dev/docs/development/deployment"
-                              >Deploying and hosting your EventCatalog</a
-                            >
-                          </li>
-                        </ul>
-                      </p>
-                      <h3>Join the community</h3>
-                      <p>
-                        Got questions about EventCatalog? Feature requests or need support? <a
-                          class="text-primary"
-                          href="https://discord.gg/3rjaZMmrAm">Join our community on Discord.</a
-                        >
-                      </p>
-                      <h3>Enterprise support</h3>
-                      <p>
-                        Using EventCatalog and needs enterprise support? Work with us, find out what we offer on our <a
-                          class="text-primary"
-                          href="https://eventcatalog.dev/enterprise">enterprise page</a
-                        >.
-                      </p>
-                    </div>
-                  </div>
-
-                  <Footer />
-                </div>
-              </div>
-            </div>
-
-            <!-- <slot /> -->
-          </div>
-        </div>
-      </div>
-    </div>
-  </body>
-</html>
-
-<style>
-  .prose {
-    max-width: none;
-  }
-</style>

package/eventcatalog/src/layouts/PlainPage.astro

@@ -1,29 +0,0 @@
----
-interface Props {
-  title: string;
-  description?: string;
-}
-
-const { title, description } = Astro.props;
-
-import Header from '@components/Header.astro';
-import SEO from '@components/Seo.astro';
----
-
-<!doctype html>
-<html lang="en">
-  <head>
-    <SEO title={`EventCatalog | ${title}`} description={description} ogTitle={title} />
-  </head>
-  <body>
-    <div class="px-10 max-w-[120em] mx-auto">
-      <Header />
-
-      <div class="md:pt-4">
-        <div>
-          <slot />
-        </div>
-      </div>
-    </div>
-  </body>
-</html>