@eventcatalog/core 2.12.0 → 2.12.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @eventcatalog/core
 
+## 2.12.2
+
+### Patch Changes
+
+- 93e224c: fix(core): custom defined landing page for docs now render on docs tab
+
+## 2.12.1
+
+### Patch Changes
+
+- a57282e: fix(core): new property for AsyncAPI rendering
+- d739d7b: fix(core): changelog buttons now render the correct changelog
+
 ## 2.12.0
 
 ### Minor Changes

package/README.md

@@ -133,6 +133,15 @@ Thank you to our project  sponsors.
 
 <hr />
 
+<div align="center">
+  <img alt="oso" src="./images/sponsors/oso-logo-green.png" width="30%" />
+  <p style="margin: 0; padding: 0;">Delivering Apache Kafka professional services to your business
+</p>
+  <a href="https://oso.sh/?utm_source=eventcatalog&utm_medium=web&utm_campaign=sponsorship" target="_blank" >Learn more</a>
+</div>
+
+<hr />
+
 _Sponsors help make EventCatalog sustainable, want to help the project? Get in touch! Or [visit our sponsor page](https://www.eventcatalog.dev/support)._
 
 # Enterprise support

package/bin/dist/eventcatalog.config.d.cts

@@ -16,6 +16,9 @@ interface Config {
         src: string;
         text?: string;
     };
+    asyncAPI?: {
+        renderParsedSchemas?: boolean;
+    };
     mdxOptimize?: boolean;
     docs: {
         sidebar: {

package/bin/dist/eventcatalog.config.d.ts

@@ -16,6 +16,9 @@ interface Config {
         src: string;
         text?: string;
     };
+    asyncAPI?: {
+        renderParsedSchemas?: boolean;
+    };
     mdxOptimize?: boolean;
     docs: {
         sidebar: {

package/bin/eventcatalog.config.ts

@@ -17,6 +17,9 @@ export interface Config {
     src: string;
     text?: string;
   };
+  asyncAPI?: {
+    renderParsedSchemas?: boolean;
+  };
   mdxOptimize?: boolean;
   docs: {
     sidebar: {

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.12.0",
+  "version": "2.12.2",
   "publishConfig": {
     "access": "public"
   },
@@ -41,7 +41,7 @@
     "@astrojs/mdx": "^3.1.8",
     "@astrojs/react": "^3.6.2",
     "@astrojs/tailwind": "^5.1.2",
-    "@asyncapi/react-component": "^2.2.2",
+    "@asyncapi/react-component": "^2.4.3",
     "@headlessui/react": "^2.0.3",
     "@heroicons/react": "^2.1.3",
     "@parcel/watcher": "^2.4.1",

package/src/components/SideBars/DomainSideBar.astro

@@ -66,7 +66,7 @@ const ownersList = owners.map((o) => ({
         <span class="block">View in visualiser</span>
       </a>
       <a
-        href={buildUrl(`/docs/${domain.collection}/${domain.data.id}/${domain.data.version}/changelog`)}
+        href={buildUrl(`/docs/${domain.collection}/${domain.data.id}/${domain.data.latestVersion}/changelog`)}
         class="flex items-center space-x-2 justify-center text-center rounded-md w-full bg-white px-3.5 py-2.5 text-sm font-semibold text-gray-900 shadow-sm ring-1 ring-inset ring-gray-300 hover:bg-gray-100/60 hover:text-primary"
       >
         <ScrollText strokeWidth={2} size={16} />

package/src/components/SideBars/MessageSideBar.astro

@@ -151,7 +151,7 @@ const schemaURL = path.join(publicPath, schemaFilePath || '');
       </a>
 
       <a
-        href={buildUrl(`/docs/${message.collection}/${message.data.id}/${message.data.version}/changelog`)}
+        href={buildUrl(`/docs/${message.collection}/${message.data.id}/${message.data.latestVersion}/changelog`)}
         class="flex items-center space-x-2 justify-center text-center rounded-md w-full bg-white px-3.5 py-2.5 text-sm font-semibold text-gray-900 shadow-sm ring-1 ring-inset ring-gray-300 hover:bg-gray-100/60 hover:text-primary"
       >
         <ScrollText strokeWidth={2} size={16} />

package/src/components/SideBars/ServiceSideBar.astro

@@ -107,7 +107,7 @@ const schemaURL = join(publicPath, schemaFilePath || '');
         <span class="block">View in visualiser</span>
       </a>
       <a
-        href={buildUrl(`/docs/${service.collection}/${service.data.id}/${service.data.version}/changelog`)}
+        href={buildUrl(`/docs/${service.collection}/${service.data.id}/${service.data.latestVersion}/changelog`)}
         class="flex items-center space-x-2 justify-center text-center rounded-md w-full bg-white px-3.5 py-2.5 text-sm font-semibold text-gray-900 shadow-sm ring-1 ring-inset ring-gray-300 hover:bg-gray-100/60 hover:text-primary"
       >
         <ScrollText strokeWidth={2} size={16} />

package/src/layouts/VerticalSideBarLayout.astro

@@ -16,10 +16,11 @@ import { getServices } from '@utils/services/services';
 import { getFlows } from '@utils/flows/flows';
 import { getTeams } from '@utils/teams';
 import { getUsers } from '@utils/users';
-import config, { type CatalogConfig } from '@eventcatalog';
+import { isCollectionVisibleInCatalog } from '@eventcatalog';
 import { buildUrl } from '@utils/url-builder';
 import { getQueries } from '@utils/queries';
 import CatalogResourcesSideBar from '@components/SideBars/CatalogResourcesSideBar';
+import { hasLandingPageForDocs } from '@utils/pages';
 
 const events = await getEvents({ getAllVersions: false });
 const commands = await getCommands({ getAllVersions: false });
@@ -37,12 +38,23 @@ const allData = [...domains, ...services, ...messages, ...flows, ...teams, ...us
 
 const currentPath = Astro.url.pathname;
 
+const catalogHasDefaultLandingPageForDocs = await hasLandingPageForDocs();
+
 const getDefaultUrl = (route: string, defaultValue: string) => {
-  if (domains.length > 0) return buildUrl(`/${route}/domains/${domains[0].data.id}/${domains[0].data.latestVersion}`);
-  if (services.length > 0) return buildUrl(`/${route}/services/${services[0].data.id}/${services[0].data.latestVersion}`);
-  if (messages.length > 0)
-    return buildUrl(`/${route}/${messages[0].collection}/${messages[0].data.id}/${messages[0].data.latestVersion}`);
-  if (flows.length > 0) return buildUrl(`/${route}/flows/${flows[0].data.id}/${flows[0].data.latestVersion}`);
+  const collections = [
+    { data: domains, key: 'domains' },
+    { data: services, key: 'services' },
+    { data: messages, key: 'messages' },
+    { data: flows, key: 'flows' },
+  ];
+
+  for (const { data, key } of collections) {
+    if (data.length > 0 && isCollectionVisibleInCatalog(key)) {
+      const item = data[0];
+      return buildUrl(`/${route}/${key}/${item.data.id}/${item.data.latestVersion}`);
+    }
+  }
+
   return buildUrl(defaultValue);
 };
 
@@ -59,7 +71,7 @@ const navigationItems = [
     id: '/docs',
     label: 'Documentation',
     icon: BookOpenText,
-    href: getDefaultUrl('docs', '/docs'),
+    href: catalogHasDefaultLandingPageForDocs ? buildUrl('/docs') : getDefaultUrl('docs', '/docs'),
     current: currentPath.includes('/docs'),
     sidebar: true,
   },
@@ -81,31 +93,6 @@ const navigationItems = [
   },
 ];
 
-const eventCatalogConfig = config as CatalogConfig;
-
-const {
-  services: servicesConfig,
-  domains: domainsConfig,
-  messages: messagesConfig,
-  flows: flowsConfig,
-  teams: teamsConfig,
-  users: usersConfig,
-} = 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 sideNav = allData.reduce((acc, item) => {
   const title = item.collection;
   const group = acc[title] || [];
@@ -120,7 +107,7 @@ const sideNav = allData.reduce((acc, item) => {
     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],
+    visible: isCollectionVisibleInCatalog(item.collection),
     // @ts-ignore
     href: item.data.version
       ? // @ts-ignore

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

@@ -7,14 +7,13 @@ import { Parser } from '@asyncapi/parser';
 
 import type { CollectionTypes, PageTypes } from '@types';
 
-import PlainPage from '@layouts/PlainPage.astro';
-
 import '@asyncapi/react-component/styles/default.min.css';
 import js from '@asyncapi/react-component/browser/standalone/without-parser.js?url';
 import { AsyncApiComponentWP, type ConfigInterface } from '@asyncapi/react-component';
 import { pageDataLoader } from '@utils/pages/pages';
 import type { CollectionEntry } from 'astro:content';
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
+import Config from '@eventcatalog';
 
 export async function getStaticPaths() {
   const itemTypes: PageTypes[] = ['events', 'commands', 'queries', 'services', 'domains'];
@@ -45,7 +44,9 @@ const pathToSpec = path.join(catalog.publicPath, fileName);
 const pathOnDisk = path.join(process.cwd(), 'public', pathToSpec);
 const fileContent = readFileSync(pathOnDisk, 'utf-8');
 
-const parsed = await new Parser().parse(fileContent);
+// AsyncAPI parser will parser schemas for users, they can turn this off.
+const parseSchemas = Config?.asyncAPI?.renderParsedSchemas ?? true;
+const parsed = await new Parser().parse(fileContent, { parseSchemas });
 const stringified = parsed.document?.json();
 const config: ConfigInterface = { show: { sidebar: true, errors: true } };
 

package/src/pages/docs/index.astro

@@ -17,11 +17,15 @@ if (page) {
 {
   CustomContent && (
     <VerticalSideBarLayout title="EventCatalog">
-      <main class="py-8 px-8">
-        <div class="prose prose-md w-full !max-w-none">
-          <CustomContent components={components} />
+      <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>
         </div>
-        <Footer />
       </main>
     </VerticalSideBarLayout>
   )

package/src/utils/config/catalog.ts

@@ -18,4 +18,19 @@ export type CatalogConfig = {
   };
 };
 
+const getConfigValue = (obj: any, key: string, defaultValue: any) => {
+  return obj?.[key] ?? defaultValue;
+};
+
+export const isCollectionVisibleInCatalog = (collection: string) => {
+  const sidebarConfig = config?.default?.docs?.sidebar || {};
+  const collections = ['events', 'commands', 'queries', 'domains', 'flows', 'services', 'teams', 'users'];
+
+  if (!collections.includes(collection)) return false;
+
+  const collectionConfig =
+    sidebarConfig[collection === 'events' || collection === 'commands' || collection === 'queries' ? 'messages' : collection];
+  return getConfigValue(collectionConfig, 'visible', true);
+};
+
 export default config.default;

package/src/utils/pages.ts

@@ -13,3 +13,8 @@ export const getIndexPage = async (): Promise<Page> => {
   const pages = await getCollection('pages');
   return pages.find((page) => page.slug === 'index')!;
 };
+
+export const hasLandingPageForDocs = async (): Promise<boolean> => {
+  const pages = await getCollection('pages');
+  return pages.some((page) => page.slug === 'index')!;
+};