@eventcatalog/core 2.51.1 → 2.53.0

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.51.1";
+var version = "2.53.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-IAZKU3ZK.js";
-import "../chunk-GWDFHYDT.js";
+} from "../chunk-AYGHOQI3.js";
+import "../chunk-UPR7DQB2.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.51.1";
+var version = "2.53.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,8 +1,8 @@
 import {
   log_build_default
-} from "../chunk-JH4IFYVJ.js";
-import "../chunk-IAZKU3ZK.js";
-import "../chunk-GWDFHYDT.js";
+} from "../chunk-K5EGYLT5.js";
+import "../chunk-AYGHOQI3.js";
+import "../chunk-UPR7DQB2.js";
 import "../chunk-E7TXTI7G.js";
 export {
   log_build_default as default

package/dist/{chunk-IAZKU3ZK.js → chunk-AYGHOQI3.js}

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

package/dist/{chunk-JH4IFYVJ.js → chunk-K5EGYLT5.js}

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

package/dist/{chunk-GWDFHYDT.js → chunk-UPR7DQB2.js}

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

package/dist/constants.cjs

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

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-GWDFHYDT.js";
+} from "./chunk-UPR7DQB2.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.51.1";
+var version = "2.53.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/eventcatalog.js

@@ -6,8 +6,8 @@ import {
 } from "./chunk-XE6PFSH5.js";
 import {
   log_build_default
-} from "./chunk-JH4IFYVJ.js";
-import "./chunk-IAZKU3ZK.js";
+} from "./chunk-K5EGYLT5.js";
+import "./chunk-AYGHOQI3.js";
 import {
   catalogToAstro,
   checkAndConvertMdToMdx
@@ -15,7 +15,7 @@ import {
 import "./chunk-LDBRNJIL.js";
 import {
   VERSION
-} from "./chunk-GWDFHYDT.js";
+} from "./chunk-UPR7DQB2.js";
 import {
   isAuthEnabled,
   isBackstagePluginEnabled,

package/eventcatalog/astro.config.mjs

@@ -92,6 +92,11 @@ export default defineConfig({
        */
       '__EC_TRAILING_SLASH__': config.trailingSlash || false,
     },
+    server: {
+      fs: {
+        allow: ['..', './node_modules/@fontsource']
+      }
+    },
     worker: {
       format: 'es',
     },

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

@@ -0,0 +1,177 @@
+---
+import jsonpath from 'jsonpath';
+import SchemaViewer from './SchemaViewer/SchemaViewer.astro';
+import { Code } from 'astro-expressive-code/components';
+import { isPrivateRemoteSchemaEnabled } from '@utils/feature';
+
+const {
+  url,
+  headers = {},
+  jsonPath = null,
+  renderAs = 'auto',
+  title = 'Remote Schema',
+  maxHeight = '400',
+  ...props
+} = Astro.props;
+
+function resolveTemplates(input: any): any {
+  if (typeof input === 'string') {
+    return input.replace(/\$\{(\w+)\}/g, (_, varName) => import.meta.env[varName] || '');
+  }
+
+  if (typeof input === 'object' && input !== null) {
+    return Object.fromEntries(Object.entries(input).map(([k, v]) => [k, resolveTemplates(v)]));
+  }
+
+  return input;
+}
+
+function isValidJSON(str: string): boolean {
+  try {
+    JSON.parse(str);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function isJSONSchema(data: any): boolean {
+  if (!data || typeof data !== 'object') return false;
+
+  // Check for common JSON Schema indicators
+  const hasSchemaIndicators =
+    data.$schema ||
+    data.type ||
+    data.properties ||
+    data.items ||
+    data.definitions ||
+    data.$defs ||
+    data.allOf ||
+    data.oneOf ||
+    data.anyOf ||
+    (data.components && data.components.schemas); // OpenAPI style
+
+  return Boolean(hasSchemaIndicators);
+}
+
+function extractWithJSONPath(data: any, path: string): any {
+  try {
+    const result = jsonpath.query(data, path);
+    // If the result is an array with a single element, return the element itself
+    // unless the original query was meant to return an array
+    if (Array.isArray(result) && result.length === 1 && !path.includes('[*]') && !path.includes('.*')) {
+      return result[0];
+    }
+    return result.length > 0 ? result : data;
+  } catch (error) {
+    console.error('JSONPath error:', error);
+    return data;
+  }
+}
+
+const resolvedUrl = resolveTemplates(url);
+const resolvedHeaders = isPrivateRemoteSchemaEnabled() ? resolveTemplates(headers) : {};
+
+let content = '';
+let processedData: any = null;
+let contentType = 'text';
+let isSchema = false;
+let error = null;
+let showPaidFeatureMessage = false;
+
+// Check if headers were provided but private remote schema is not enabled
+if (Object.keys(headers).length > 0 && !isPrivateRemoteSchemaEnabled()) {
+  error = '401 Unauthorized - Headers provided but private remote schema feature is not enabled';
+  showPaidFeatureMessage = true;
+}
+
+try {
+  const response = await fetch(resolvedUrl, {
+    headers: resolvedHeaders,
+  });
+
+  if (!response.ok) {
+    throw new Error(`Failed to fetch: ${response.status} ${response.statusText}`);
+  }
+
+  content = await response.text();
+
+  // Detect content type
+  if (isValidJSON(content)) {
+    contentType = 'json';
+    processedData = JSON.parse(content);
+
+    // Check if it's a JSON Schema
+    isSchema = isJSONSchema(processedData);
+
+    // Apply JSONPath if provided
+    if (jsonPath) {
+      content = extractWithJSONPath(processedData, jsonPath);
+    } else {
+      content = JSON.stringify(processedData, null, 2);
+    }
+  }
+} catch (e) {
+  if (!showPaidFeatureMessage) {
+    error = e instanceof Error ? e.message : String(e);
+  }
+}
+
+// Determine rendering method
+let finalRenderAs = renderAs;
+if (renderAs === 'auto') {
+  if (contentType === 'json' && isSchema) {
+    finalRenderAs = 'schema';
+  } else {
+    finalRenderAs = 'raw';
+  }
+}
+---
+
+{
+  error ? (
+    <div class="bg-red-50 border border-red-200 text-red-700 px-4 py-3 rounded not-prose">
+      <strong>
+        Error loading remote file: <span class=" text-red-900">{url}</span>
+      </strong>
+      <p class="text-xs py-2">{` ${error} `}</p>
+      {showPaidFeatureMessage && (
+        <div class="my-1 p-3 bg-white border border-gray-200 rounded text-gray-700">
+          <strong>Private API Access</strong>
+          <p class="mt-1 text-xs">
+            Fetching files from private APIs with headers is a paid feature.
+            <a href="https://eventcatalog.cloud" class="underline hover:no-underline" target="_blank" rel="noopener noreferrer">
+              Sign up for a EventCatalog Scale license key
+            </a>{' '}
+            to access this functionality.
+          </p>
+        </div>
+      )}
+    </div>
+  ) : (
+    <div class="remote-file-content">
+      {finalRenderAs === 'schema' ? (
+        <SchemaViewer
+          schema={processedData}
+          schemaPath={resolvedUrl}
+          title={title}
+          maxHeight={maxHeight}
+          file="remote"
+          id={`remote-schema-${Math.random().toString(36).substring(2, 9)}`}
+          expand={false}
+          search={true}
+        />
+      ) : (
+        <div class="not-prose max-w-4xl overflow-x-auto" style={`max-height: ${maxHeight}px;`}>
+          <Code code={content} title={title || ''} lang="json" />
+        </div>
+      )}
+
+      {jsonPath && (
+        <div class="mt-2 text-xs text-gray-500">
+          Applied JSONPath: <code class="bg-gray-100 px-1 rounded">{jsonPath}</code>
+        </div>
+      )}
+    </div>
+  )
+}

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

@@ -0,0 +1,22 @@
+---
+import { isSSR } from '@utils/feature';
+import Admonition from './Admonition';
+import RemoteFile from './RemoteFile.astro';
+const { url, headers, jsonPath, renderAs, ...props } = Astro.props;
+---
+
+{
+  isSSR() ? (
+    <RemoteFile url={url} headers={headers} jsonPath={jsonPath} renderAs={renderAs} {...props} />
+  ) : (
+    <Admonition type="warning">
+      <div>
+        <span class="block font-bold">{`<RemoteSchema/>`} is only available on the server</span>
+        <span class="block">
+          You are trying to load a remote file, but this component is not supported in the client. You must switch to SSR mode to
+          use this component.
+        </span>
+      </div>
+    </Admonition>
+  )
+}

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

@@ -28,6 +28,7 @@ import FigJam from '@components/MDX/FigJam/FigJam.astro';
 import NodeGraphPortal from '@components/MDX/NodeGraph/NodeGraphPortal';
 import SchemaViewerPortal from '@components/MDX/SchemaViewer/SchemaViewerPortal';
 import { jsx } from 'astro/jsx-runtime';
+import RemoteSchema from '@components/MDX/RemoteSchema.astro';
 
 const components = (props: any) => {
   return {
@@ -37,6 +38,7 @@ const components = (props: any) => {
     AsyncAPI,
     ChannelInformation: (mdxProp: any) => ChannelInformation({ ...props.data, ...mdxProp }),
     File: (mdxProp: any) => File({ ...props, ...mdxProp }),
+    RemoteSchema,
     Flow,
     Link: (mdxProp: any) => jsx(Link, { ...props, ...mdxProp }),
     MessageTable: (mdxProp: any) => jsx(MessageTable, { ...props, ...mdxProp }),

package/eventcatalog/src/components/SideBars/ChannelSideBar.astro

@@ -75,12 +75,20 @@ const consumersList = consumers.map((c) => ({
   tag: `v${c.data.version}`,
   href: buildUrl(`/docs/${c.collection}/${c.data.id}/${c.data.version}`),
 }));
+
+const shouldRenderSideBarSection = (section: string) => {
+  if (!channel.data.detailsPanel) {
+    return true;
+  }
+  // @ts-ignore
+  return channel.data.detailsPanel[section]?.visible ?? true;
+};
 ---
 
 <aside class="sticky top-28 left-0 space-y-8 h-full overflow-y-auto py-4">
   <div class="">
     {
-      producersList.length > 0 && (
+      producersList.length > 0 && shouldRenderSideBarSection('producers') && (
         <PillListFlat
           title={`Producers (${producersList.length})`}
           pills={producersList}
@@ -92,7 +100,7 @@ const consumersList = consumers.map((c) => ({
     }
 
     {
-      consumersList.length > 0 && (
+      consumersList.length > 0 && shouldRenderSideBarSection('consumers') && (
         <PillListFlat
           title={`Consumers (${consumersList.length})`}
           pills={consumersList}
@@ -104,7 +112,7 @@ const consumersList = consumers.map((c) => ({
     }
 
     {
-      messageList.length > 0 && (
+      messageList.length > 0 && shouldRenderSideBarSection('messages') && (
         <PillListFlat
           title={`Messages using channel (${messageList.length})`}
           pills={messageList}
@@ -116,13 +124,13 @@ const consumersList = consumers.map((c) => ({
     }
 
     {
-      protocolList.length > 0 && (
+      protocolList.length > 0 && shouldRenderSideBarSection('protocols') && (
         <ProtocolList color="pink" title={`Protocols (${protocolList.length})`} pills={protocolList} client:load />
       )
     }
 
     {
-      channel.data.versions && (
+      channel.data.versions && shouldRenderSideBarSection('versions') && (
         <VersionList
           title={`Versions (${channel.data.versions?.length})`}
           versions={channel.data.versions}
@@ -131,27 +139,31 @@ const consumersList = consumers.map((c) => ({
       )
     }
 
-    <OwnersList
-      title={`Owners (${filteredOwners.length})`}
-      owners={ownersList}
-      emptyMessage={`This channel does not have any documented owners.`}
-      client:load
-    />
+    {
+      ownersList.length > 0 && shouldRenderSideBarSection('owners') && (
+        <OwnersList
+          title={`Owners (${filteredOwners.length})`}
+          owners={ownersList}
+          emptyMessage={`This channel does not have any documented owners.`}
+          client:load
+        />
+      )
+    }
 
     {
-      channel.data.repository && (
+      channel.data.repository && shouldRenderSideBarSection('repository') && (
         <RepositoryList repository={channel.data.repository?.url} language={channel.data.repository?.language} />
       )
     }
 
     {
-      paramsList.length > 0 && (
+      paramsList.length > 0 && shouldRenderSideBarSection('parameters') && (
         <PillListFlat color="pink" title={`Parameters (${paramsList.length})`} pills={paramsList} client:load />
       )
     }
 
     {
-      isChangelogEnabled() && (
+      isChangelogEnabled() && shouldRenderSideBarSection('changelog') && (
         <div class="space-y-2">
           <a
             href={buildUrl(`/docs/${channel.collection}/${channel.data.id}/${channel.data.latestVersion}/changelog`)}

package/eventcatalog/src/components/SideBars/DomainSideBar.astro

@@ -105,12 +105,20 @@ const ownersList = filteredOwners.map((o) => ({
   avatarUrl: o.collection === 'users' ? o.data.avatarUrl : '',
   href: buildUrl(`/docs/${o.collection}/${o.data.id}`),
 }));
+
+const shouldRenderSideBarSection = (section: string) => {
+  if (!domain.data.detailsPanel) {
+    return true;
+  }
+  // @ts-ignore
+  return domain.data.detailsPanel[section]?.visible ?? true;
+};
 ---
 
 <aside class="sticky top-28 left-0 space-y-8 h-full overflow-y-auto py-4">
   <div>
     {
-      parentDomains.length > 0 && (
+      parentDomains.length > 0 && shouldRenderSideBarSection('parentDomains') && (
         <PillListFlat
           title={`Parent domains (${parentDomains.length})`}
           pills={parentDomainList}
@@ -123,7 +131,7 @@ const ownersList = filteredOwners.map((o) => ({
     }
 
     {
-      subDomains.length > 0 && (
+      subDomains.length > 0 && shouldRenderSideBarSection('subdomains') && (
         <PillListFlat
           title={`Subdomains (${subDomains.length})`}
           pills={subDomainList}
@@ -139,29 +147,41 @@ const ownersList = filteredOwners.map((o) => ({
         .filter((section) => section.items.length > 0 && section.sidebar)
         .map((section) => <CustomSideBarSectionList section={section} />)
     }
-    <PillListFlat
-      title={`Services (${services.length})`}
-      pills={serviceList}
-      emptyMessage={`This domain does not contain any services.`}
-      color="pink"
-      client:load
-    />
-    <PillListFlat
-      title={`Sends messages (${sendsList.length})`}
-      pills={sendsList}
-      emptyMessage={`This domain does not send any messages.`}
-      color="orange"
-      client:load
-    />
-    <PillListFlat
-      title={`Receives messages (${receivesList.length})`}
-      pills={receivesList}
-      emptyMessage={`This domain does not receive any messages.`}
-      color="orange"
-      client:load
-    />
     {
-      ubiquitousLanguageList && hasUbiquitousLanguage && (
+      shouldRenderSideBarSection('services') && (
+        <PillListFlat
+          title={`Services (${services.length})`}
+          pills={serviceList}
+          emptyMessage={`This domain does not contain any services.`}
+          color="pink"
+          client:load
+        />
+      )
+    }
+    {
+      shouldRenderSideBarSection('messages') && (
+        <PillListFlat
+          title={`Sends messages (${sendsList.length})`}
+          pills={sendsList}
+          emptyMessage={`This domain does not send any messages.`}
+          color="orange"
+          client:load
+        />
+      )
+    }
+    {
+      shouldRenderSideBarSection('messages') && (
+        <PillListFlat
+          title={`Receives messages (${receivesList.length})`}
+          pills={receivesList}
+          emptyMessage={`This domain does not receive any messages.`}
+          color="orange"
+          client:load
+        />
+      )
+    }
+    {
+      ubiquitousLanguageList && hasUbiquitousLanguage && shouldRenderSideBarSection('ubiquitousLanguage') && (
         <PillListFlat
           title={`Ubiquitous Language Dictionary (${ubiquitousLanguageDictionary?.length})`}
           pills={ubiquitousLanguageList}
@@ -173,7 +193,7 @@ const ownersList = filteredOwners.map((o) => ({
       )
     }
     {
-      entities.length > 0 && (
+      entities.length > 0 && shouldRenderSideBarSection('entities') && (
         <PillListFlat
           title={`Entities (${entities.length})`}
           pills={entityList}
@@ -183,18 +203,26 @@ const ownersList = filteredOwners.map((o) => ({
         />
       )
     }
-    {domain.data.versions && <VersionList versions={domain.data.versions} collectionItem={domain} />}
     {
-      domain.data.repository && (
+      domain.data.versions && shouldRenderSideBarSection('versions') && (
+        <VersionList versions={domain.data.versions} collectionItem={domain} />
+      )
+    }
+    {
+      domain.data.repository && shouldRenderSideBarSection('repository') && (
         <RepositoryList repository={domain.data.repository?.url} language={domain.data.repository?.language} />
       )
     }
-    <OwnersList
-      title={`Owners (${ownersList.length})`}
-      owners={ownersList}
-      emptyMessage={`This domain does not have any documented owners.`}
-      client:load
-    />
+    {
+      shouldRenderSideBarSection('owners') && (
+        <OwnersList
+          title={`Owners (${ownersList.length})`}
+          owners={ownersList}
+          emptyMessage={`This domain does not have any documented owners.`}
+          client:load
+        />
+      )
+    }
 
     <div class="space-y-2">
       <a
@@ -205,7 +233,7 @@ const ownersList = filteredOwners.map((o) => ({
         <span class="block">View in visualiser</span>
       </a>
       {
-        isChangelogEnabled() && (
+        isChangelogEnabled() && shouldRenderSideBarSection('changelog') && (
           <a
             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"

package/eventcatalog/src/components/SideBars/EntitySideBar.astro

@@ -48,12 +48,20 @@ const domainsList = domains.map((p) => ({
   tag: `v${p.data.version}`,
   href: buildUrl(`/docs/${p.collection}/${p.data.id}/${p.data.version}`),
 }));
+
+const shouldRenderSideBarSection = (section: string) => {
+  if (!entity.data.detailsPanel) {
+    return true;
+  }
+  // @ts-ignore
+  return entity.data.detailsPanel[section]?.visible ?? true;
+};
 ---
 
 <aside class="sticky top-28 left-0 space-y-8 h-full overflow-y-auto py-4">
   <div class="">
     {
-      (
+      shouldRenderSideBarSection('domains') && (
         <PillListFlat
           title={`Domains (${domainsList.length})`}
           pills={domainsList}
@@ -64,7 +72,7 @@ const domainsList = domains.map((p) => ({
       )
     }
     {
-      servicesList.length > 0 && (
+      servicesList.length > 0 && shouldRenderSideBarSection('services') && (
         <PillListFlat
           title={`Services (${servicesList.length})`}
           pills={servicesList}
@@ -74,16 +82,24 @@ const domainsList = domains.map((p) => ({
         />
       )
     }
-    {entity.data.versions && <VersionList versions={entity.data.versions} collectionItem={entity} />}
-    <OwnersList
-      title={`Owners (${filteredOwners.length})`}
-      owners={ownersList}
-      emptyMessage={`This entity does not have any documented owners.`}
-      client:load
-    />
+    {
+      entity.data.versions && shouldRenderSideBarSection('versions') && (
+        <VersionList versions={entity.data.versions} collectionItem={entity} />
+      )
+    }
+    {
+      filteredOwners.length > 0 && shouldRenderSideBarSection('owners') && (
+        <OwnersList
+          title={`Owners (${filteredOwners.length})`}
+          owners={ownersList}
+          emptyMessage={`This entity does not have any documented owners.`}
+          client:load
+        />
+      )
+    }
 
     {
-      isChangelogEnabled() && (
+      isChangelogEnabled() && shouldRenderSideBarSection('changelog') && (
         <div class="space-y-2">
           <a
             href={buildUrl(`/docs/${entity.collection}/${entity.data.id}/${entity.data.latestVersion}/changelog`)}

package/eventcatalog/src/components/SideBars/FlowSideBar.astro

@@ -29,6 +29,14 @@ const ownersList = filteredOwners.map((o) => ({
 }));
 
 const isRSSEnabled = config.rss?.enabled;
+
+const shouldRenderSideBarSection = (section: string) => {
+  if (!flow.data.detailsPanel) {
+    return true;
+  }
+  // @ts-ignore
+  return flow.data.detailsPanel[section]?.visible ?? true;
+};
 ---
 
 <aside class="sticky top-28 left-0 h-full overflow-y-auto pr-6 py-4">
@@ -38,14 +46,22 @@ const isRSSEnabled = config.rss?.enabled;
         .filter((section) => section.items.length > 0 && section.sidebar)
         .map((section) => <CustomSideBarSectionList section={section} />)
     }
-    {flow.data.versions && <VersionList versions={flow.data.versions} collectionItem={flow} />}
+    {
+      flow.data.versions && shouldRenderSideBarSection('versions') && (
+        <VersionList versions={flow.data.versions} collectionItem={flow} />
+      )
+    }
 
-    <OwnersList
-      title={`Owners (${ownersList.length})`}
-      owners={ownersList}
-      emptyMessage={`This flow does not have any documented owners.`}
-      client:load
-    />
+    {
+      shouldRenderSideBarSection('owners') && (
+        <OwnersList
+          title={`Owners (${ownersList.length})`}
+          owners={ownersList}
+          emptyMessage={`This flow does not have any documented owners.`}
+          client:load
+        />
+      )
+    }
 
     {
       isRSSEnabled && (
@@ -72,7 +88,7 @@ const isRSSEnabled = config.rss?.enabled;
         <span class="block">View in visualiser</span>
       </a>
       {
-        isChangelogEnabled() && (
+        isChangelogEnabled() && shouldRenderSideBarSection('changelog') && (
           <a
             href={buildUrl(`/docs/${flow.collection}/${flow.data.id}/${flow.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"

package/eventcatalog/src/components/SideBars/MessageSideBar.astro

@@ -98,6 +98,14 @@ const publicPath = message?.catalog?.publicPath;
 
 const schemaFilePath = message?.data?.schemaPath;
 const schemaURL = path.join(publicPath, schemaFilePath || '');
+
+const shouldRenderSideBarSection = (section: string) => {
+  if (!message.data.detailsPanel) {
+    return true;
+  }
+  // @ts-ignore
+  return message.data.detailsPanel[section]?.visible ?? true;
+};
 ---
 
 <aside class="sticky top-28 left-0 space-y-8 h-full overflow-y-auto py-4">
@@ -108,7 +116,7 @@ const schemaURL = path.join(publicPath, schemaFilePath || '');
         .map((section) => <CustomSideBarSectionList section={section} />)
     }
     {
-      producerList.length > 0 && (
+      producerList.length > 0 && shouldRenderSideBarSection('producers') && (
         <PillListFlat
           color="pink"
           title={`Producers (${producerList.length})`}
@@ -119,7 +127,7 @@ const schemaURL = path.join(publicPath, schemaFilePath || '');
       )
     }
     {
-      consumerList.length > 0 && (
+      consumerList.length > 0 && shouldRenderSideBarSection('consumers') && (
         <PillListFlat
           color="pink"
           title={`Consumers (${consumerList.length})`}
@@ -130,13 +138,13 @@ const schemaURL = path.join(publicPath, schemaFilePath || '');
       )
     }
     {
-      channelList.length > 0 && (
+      channelList.length > 0 && shouldRenderSideBarSection('channels') && (
         <PillListFlat color="pink" title={`Channels (${channelList.length})`} pills={channelList} client:load />
       )
     }
 
     {
-      message.data.versions && (
+      message.data.versions && shouldRenderSideBarSection('versions') && (
         <VersionList
           title={`Versions (${message.data.versions?.length})`}
           versions={message.data.versions}
@@ -145,15 +153,19 @@ const schemaURL = path.join(publicPath, schemaFilePath || '');
       )
     }
 
-    <OwnersList
-      title={`Owners (${ownersList.length})`}
-      owners={ownersList}
-      emptyMessage={`This ${type} does not have any documented owners.`}
-      client:load
-    />
+    {
+      ownersList.length > 0 && shouldRenderSideBarSection('owners') && (
+        <OwnersList
+          title={`Owners (${ownersList.length})`}
+          owners={ownersList}
+          emptyMessage={`This ${type} does not have any documented owners.`}
+          client:load
+        />
+      )
+    }
 
     {
-      message.data.repository && (
+      message.data.repository && shouldRenderSideBarSection('repository') && (
         <RepositoryList repository={message.data.repository?.url} language={message.data.repository?.language} />
       )
     }
@@ -196,7 +208,7 @@ const schemaURL = path.join(publicPath, schemaFilePath || '');
       </a>
 
       {
-        isChangelogEnabled() && (
+        isChangelogEnabled() && shouldRenderSideBarSection('changelog') && (
           <a
             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"

package/eventcatalog/src/components/SideBars/ServiceSideBar.astro

@@ -87,6 +87,14 @@ const isRSSEnabled = config.rss?.enabled;
 const publicPath = service?.catalog?.publicPath;
 const schemaFilePath = service?.data?.schemaPath;
 const schemaURL = join(publicPath, schemaFilePath || '');
+
+const shouldRenderSideBarSection = (section: string) => {
+  if (!service.data.detailsPanel) {
+    return true;
+  }
+  // @ts-ignore
+  return service.data.detailsPanel[section]?.visible ?? true;
+};
 ---
 
 <aside class="sticky top-28 left-0 h-full overflow-y-auto pr-6 py-4">
@@ -97,7 +105,7 @@ const schemaURL = join(publicPath, schemaFilePath || '');
         .map((section) => <CustomSideBarSectionList section={section} />)
     }
     {
-      domainList.length > 0 && (
+      domainList.length > 0 && shouldRenderSideBarSection('domains') && (
         <PillListFlat
           title={`Domains (${domainList.length})`}
           pills={domainList}
@@ -107,26 +115,40 @@ const schemaURL = join(publicPath, schemaFilePath || '');
         />
       )
     }
-    <PillListFlat
-      title={`Receives Messages (${receivesList.length})`}
-      pills={receivesList}
-      emptyMessage={`This service does not receive any messages.`}
-      color="orange"
-      client:load
-    />
-    <PillListFlat
-      title={`Sends Messages (${sendsList.length})`}
-      pills={sendsList}
-      emptyMessage={`This service does not send any messages.`}
-      color="orange"
-      client:load
-    />
-    {service.data.versions && <VersionList versions={service.data.versions} collectionItem={service} />}
-
-    {service.data.specifications && <SpecificationsList collectionItem={service} />}
+    {
+      shouldRenderSideBarSection('messages') && (
+        <>
+          <PillListFlat
+            title={`Receives Messages (${receivesList.length})`}
+            pills={receivesList}
+            emptyMessage={`This service does not receive any messages.`}
+            color="orange"
+            client:load
+          />
+          <PillListFlat
+            title={`Sends Messages (${sendsList.length})`}
+            pills={sendsList}
+            emptyMessage={`This service does not send any messages.`}
+            color="orange"
+            client:load
+          />
+        </>
+      )
+    }
+    {
+      service.data.versions && shouldRenderSideBarSection('versions') && (
+        <VersionList versions={service.data.versions} collectionItem={service} />
+      )
+    }
+
+    {
+      service.data.specifications && shouldRenderSideBarSection('specifications') && (
+        <SpecificationsList collectionItem={service} />
+      )
+    }
 
     {
-      entities.length > 0 && (
+      entities.length > 0 && shouldRenderSideBarSection('entities') && (
         <PillListFlat
           title={`Entities (${entities.length})`}
           pills={entityList}
@@ -137,15 +159,19 @@ const schemaURL = join(publicPath, schemaFilePath || '');
       )
     }
 
-    <OwnersList
-      title={`Owners (${ownersList.length})`}
-      owners={ownersList}
-      emptyMessage={`This service does not have any documented owners.`}
-      client:load
-    />
+    {
+      shouldRenderSideBarSection('owners') && (
+        <OwnersList
+          title={`Owners (${ownersList.length})`}
+          owners={ownersList}
+          emptyMessage={`This service does not have any documented owners.`}
+          client:load
+        />
+      )
+    }
 
     {
-      service.data.repository && (
+      service.data.repository && shouldRenderSideBarSection('repository') && (
         <RepositoryList repository={service.data.repository?.url} language={service.data.repository?.language} />
       )
     }
@@ -187,7 +213,7 @@ const schemaURL = join(publicPath, schemaFilePath || '');
         <span class="block">View in visualiser</span>
       </a>
       {
-        isChangelogEnabled() && (
+        isChangelogEnabled() && shouldRenderSideBarSection('changelog') && (
           <a
             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"

package/eventcatalog/src/content.config.ts

@@ -31,6 +31,10 @@ const pointer = z.object({
   version: z.string().optional().default('latest'),
 });
 
+const detailPanelPropertySchema = z.object({
+  visible: z.boolean().optional(),
+});
+
 const channelPointer = z
   .object({
     parameters: z.record(z.string()).optional(),
@@ -175,6 +179,13 @@ const flows = defineCollection({
   }),
   schema: z
     .object({
+      detailsPanel: z
+        .object({
+          owners: detailPanelPropertySchema.optional(),
+          versions: detailPanelPropertySchema.optional(),
+          changelog: detailPanelPropertySchema.optional(),
+        })
+        .optional(),
       steps: z.array(
         z
           .object({
@@ -185,6 +196,7 @@ const flows = defineCollection({
             message: pointer.optional(),
             service: pointer.optional(),
             flow: pointer.optional(),
+
             actor: z
               .object({
                 name: z.string(),
@@ -233,6 +245,16 @@ const flows = defineCollection({
     .merge(baseSchema),
 });
 
+const messageDetailsPanelPropertySchema = z.object({
+  producers: detailPanelPropertySchema.optional(),
+  consumers: detailPanelPropertySchema.optional(),
+  channels: detailPanelPropertySchema.optional(),
+  versions: detailPanelPropertySchema.optional(),
+  repository: detailPanelPropertySchema.optional(),
+  owners: detailPanelPropertySchema.optional(),
+  changelog: detailPanelPropertySchema.optional(),
+});
+
 const events = defineCollection({
   loader: glob({
     pattern: ['**/events/*/index.(md|mdx)', '**/events/*/versioned/*/index.(md|mdx)'],
@@ -248,6 +270,7 @@ const events = defineCollection({
       channels: z.array(channelPointer).optional(),
       // Used by eventcatalog
       messageChannels: z.array(reference('channels')).optional(),
+      detailsPanel: messageDetailsPanelPropertySchema.optional(),
     })
     .merge(baseSchema),
 });
@@ -265,6 +288,7 @@ const commands = defineCollection({
       producers: z.array(reference('services')).optional(),
       consumers: z.array(reference('services')).optional(),
       channels: z.array(channelPointer).optional(),
+      detailsPanel: messageDetailsPanelPropertySchema.optional(),
       // Used by eventcatalog
       messageChannels: z.array(reference('channels')).optional(),
     })
@@ -284,6 +308,7 @@ const queries = defineCollection({
       producers: z.array(reference('services')).optional(),
       consumers: z.array(reference('services')).optional(),
       channels: z.array(channelPointer).optional(),
+      detailsPanel: messageDetailsPanelPropertySchema.optional(),
       // Used by eventcatalog
       messageChannels: z.array(reference('channels')).optional(),
     })
@@ -314,6 +339,18 @@ const services = defineCollection({
       sends: z.array(pointer).optional(),
       receives: z.array(pointer).optional(),
       entities: z.array(pointer).optional(),
+      detailsPanel: z
+        .object({
+          domains: detailPanelPropertySchema.optional(),
+          messages: detailPanelPropertySchema.optional(),
+          versions: detailPanelPropertySchema.optional(),
+          specifications: detailPanelPropertySchema.optional(),
+          entities: detailPanelPropertySchema.optional(),
+          repository: detailPanelPropertySchema.optional(),
+          owners: detailPanelPropertySchema.optional(),
+          changelog: detailPanelPropertySchema.optional(),
+        })
+        .optional(),
     })
     .merge(baseSchema),
 });
@@ -356,6 +393,20 @@ const domains = defineCollection({
       services: z.array(pointer).optional(),
       domains: z.array(pointer).optional(),
       entities: z.array(pointer).optional(),
+      detailsPanel: z
+        .object({
+          parentDomains: detailPanelPropertySchema.optional(),
+          subdomains: detailPanelPropertySchema.optional(),
+          services: detailPanelPropertySchema.optional(),
+          entities: detailPanelPropertySchema.optional(),
+          messages: detailPanelPropertySchema.optional(),
+          ubiquitousLanguage: detailPanelPropertySchema.optional(),
+          repository: detailPanelPropertySchema.optional(),
+          versions: detailPanelPropertySchema.optional(),
+          owners: detailPanelPropertySchema.optional(),
+          changelog: detailPanelPropertySchema.optional(),
+        })
+        .optional(),
     })
     .merge(baseSchema),
 });
@@ -383,6 +434,19 @@ const channels = defineCollection({
         )
         .optional(),
       messages: z.array(z.object({ collection: z.string(), name: z.string(), ...pointer.shape })).optional(),
+      detailsPanel: z
+        .object({
+          producers: detailPanelPropertySchema.optional(),
+          consumers: detailPanelPropertySchema.optional(),
+          messages: detailPanelPropertySchema.optional(),
+          protocols: detailPanelPropertySchema.optional(),
+          parameters: detailPanelPropertySchema.optional(),
+          versions: detailPanelPropertySchema.optional(),
+          repository: detailPanelPropertySchema.optional(),
+          owners: detailPanelPropertySchema.optional(),
+          changelog: detailPanelPropertySchema.optional(),
+        })
+        .optional(),
     })
     .merge(baseSchema),
 });
@@ -438,6 +502,16 @@ const entities = defineCollection({
         .optional(),
       services: z.array(reference('services')).optional(),
       domains: z.array(reference('domains')).optional(),
+      detailsPanel: z
+        .object({
+          domains: detailPanelPropertySchema.optional(),
+          services: detailPanelPropertySchema.optional(),
+          messages: detailPanelPropertySchema.optional(),
+          versions: detailPanelPropertySchema.optional(),
+          owners: detailPanelPropertySchema.optional(),
+          changelog: detailPanelPropertySchema.optional(),
+        })
+        .optional(),
     })
 
     .merge(baseSchema),

package/eventcatalog/src/utils/feature.ts

@@ -19,6 +19,8 @@ import { join } from 'path';
 export const isEventCatalogStarterEnabled = () => process.env.EVENTCATALOG_STARTER === 'true';
 export const isEventCatalogScaleEnabled = () => process.env.EVENTCATALOG_SCALE === 'true';
 
+export const isPrivateRemoteSchemaEnabled = () => isEventCatalogScaleEnabled() || isEventCatalogStarterEnabled();
+
 export const showEventCatalogBranding = () => {
   const override = process.env.EVENTCATALOG_SHOW_BRANDING;
   // if any value we return true

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.51.1",
+  "version": "2.53.0",
   "publishConfig": {
     "access": "public"
   },
@@ -77,6 +77,7 @@
     "gray-matter": "^4.0.3",
     "html-to-image": "^1.11.11",
     "js-yaml": "^4.1.0",
+    "jsonpath": "^1.1.1",
     "jsonwebtoken": "^9.0.2",
     "langchain": "^0.3.19",
     "lodash.debounce": "^4.0.8",
@@ -110,6 +111,7 @@
     "@types/dagre": "^0.7.52",
     "@types/diff": "^5.2.2",
     "@types/js-yaml": "^4.0.9",
+    "@types/jsonpath": "^0.2.4",
     "@types/jsonwebtoken": "^9.0.10",
     "@types/lodash.debounce": "^4.0.9",
     "@types/lodash.merge": "4.6.9",