@eventcatalog/core 2.51.0 → 2.52.0

package/README.md

@@ -34,7 +34,7 @@
 <h4>Features: Documentation for Event Driven Architectures, Integration with any broker, Generator from your OpenAPI and AsyncAPI documents, Docs and Code, Markdown driven, Document Domains/Services/Messages/Schemas and more, Content versioning, Assign Owners, Schemas, OpenAPI, MDX Components and more...</h4>
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-54-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-55-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [Read the Docs](https://www.eventcatalog.dev/docs/development/getting-started/introduction) | [View Demo](https://demo.eventcatalog.dev)
@@ -265,6 +265,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/VitaliiBalash"><img src="https://avatars.githubusercontent.com/u/4520809?v=4?s=100" width="100px;" alt="Vitalii Balash"/><br /><sub><b>Vitalii Balash</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=VitaliiBalash" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ababilone"><img src="https://avatars.githubusercontent.com/u/925013?v=4?s=100" width="100px;" alt="Arnaud Babilone"/><br /><sub><b>Arnaud Babilone</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=ababilone" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/alexanderhorner"><img src="https://avatars.githubusercontent.com/u/18349361?v=4?s=100" width="100px;" alt="Alexander Horner"/><br /><sub><b>Alexander Horner</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=alexanderhorner" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/simonwfarrow"><img src="https://avatars.githubusercontent.com/u/3245908?v=4?s=100" width="100px;" alt="simonwfarrow"/><br /><sub><b>simonwfarrow</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=simonwfarrow" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

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

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-2J3EYRYN.js";
-import "../chunk-CXGJYRWV.js";
+} from "../chunk-6DB32LQO.js";
+import "../chunk-GR53VD3Z.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.0";
+var version = "2.52.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,8 +1,8 @@
 import {
   log_build_default
-} from "../chunk-PRFUGFES.js";
-import "../chunk-2J3EYRYN.js";
-import "../chunk-CXGJYRWV.js";
+} from "../chunk-IXFKZMN2.js";
+import "../chunk-6DB32LQO.js";
+import "../chunk-GR53VD3Z.js";
 import "../chunk-E7TXTI7G.js";
 export {
   log_build_default as default

package/dist/{chunk-2J3EYRYN.js → chunk-6DB32LQO.js}

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

package/dist/{chunk-CXGJYRWV.js → chunk-GR53VD3Z.js}

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

package/dist/{chunk-PRFUGFES.js → chunk-IXFKZMN2.js}

@@ -1,6 +1,6 @@
 import {
   raiseEvent
-} from "./chunk-2J3EYRYN.js";
+} from "./chunk-6DB32LQO.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile

package/dist/constants.cjs

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

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-CXGJYRWV.js";
+} from "./chunk-GR53VD3Z.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.0";
+var version = "2.52.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-PRFUGFES.js";
-import "./chunk-2J3EYRYN.js";
+} from "./chunk-IXFKZMN2.js";
+import "./chunk-6DB32LQO.js";
 import {
   catalogToAstro,
   checkAndConvertMdToMdx
@@ -15,7 +15,7 @@ import {
 import "./chunk-LDBRNJIL.js";
 import {
   VERSION
-} from "./chunk-CXGJYRWV.js";
+} from "./chunk-GR53VD3Z.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/EntityMap/EntityMap.astro

@@ -5,7 +5,7 @@ import Admonition from '@components/MDX/Admonition';
 import NodeGraph from '../NodeGraph/NodeGraph';
 import { getVersionFromCollection } from '@utils/collections/versions';
 
-const { id, version = 'latest', maxHeight, includeKey = true } = Astro.props;
+const { id, version = 'latest', maxHeight, includeKey = true, entities } = Astro.props;
 
 // Find the flow for the given id and version
 const domains = await getDomains();
@@ -15,6 +15,7 @@ const domain = domainCollection[0];
 const { nodes, edges } = await getNodesAndEdges({
   id: id,
   version: domain?.data?.version,
+  ...(entities ? { entities } : {}), // Pass entities if provided
 });
 ---
 

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/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/eventcatalog/src/utils/node-graphs/domain-entity-map.ts

@@ -12,17 +12,25 @@ const elk = new ELK();
 interface Props {
   id: string;
   version: string;
+  entities?: string[]; // Optional: array of entity IDs/names to include
 }
 
-export const getNodesAndEdges = async ({ id, version }: Props) => {
+export const getNodesAndEdges = async ({ id, version, entities }: Props) => {
   let nodes = [] as any,
     edges = [] as any;
 
   const allDomains = await getDomains();
-  const entities = await getEntities();
+  const allEntities = await getEntities();
 
   const domain = getVersionFromCollection(allDomains, id, version)[0] as Domain;
-  const domainEntities = (domain?.data?.entities ?? []) as any;
+  let domainEntities = (domain?.data?.entities ?? []) as any;
+
+  // If entities filter is provided, filter domainEntities to only those specified
+  if (entities && Array.isArray(entities) && entities.length > 0) {
+    domainEntities = domainEntities.filter(
+      (entity: Entity) => entities.includes(entity.data.id) || entities.includes(entity.data.name)
+    );
+  }
 
   const entitiesWithReferences = domainEntities.filter((entity: Entity) =>
     entity.data.properties?.some((property: any) => property.references)
@@ -44,7 +52,7 @@ export const getNodesAndEdges = async ({ id, version }: Props) => {
     .flat()
     .filter((ref: any) => ref !== undefined);
 
-  const externalToDomain = [...new Set(listOfReferencedEntities)] // Remove duplicates
+  const externalToDomain = Array.from(new Set<string>(listOfReferencedEntities as string[])) // Remove duplicates
     .filter((entityId: any) => !domainEntities.some((domainEntity: any) => domainEntity.id === entityId));
 
   // Helper function to find which domain an entity belongs to
@@ -54,7 +62,7 @@ export const getNodesAndEdges = async ({ id, version }: Props) => {
 
   const addedExternalEntities = [];
   for (const entityId of externalToDomain) {
-    const externalEntity = getItemsFromCollectionByIdAndSemverOrLatest(entities, entityId as string, 'latest')[0] as Entity;
+    const externalEntity = getItemsFromCollectionByIdAndSemverOrLatest(allEntities, entityId as string, 'latest')[0] as Entity;
 
     if (externalEntity) {
       const nodeId = generateIdForNode(externalEntity);

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.51.0",
+  "version": "2.52.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",