@eventcatalog/core 3.44.2 → 3.46.0

package/dist/analytics/analytics.cjs

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(analytics_exports);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "3.44.2";
+var version = "3.46.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-LIIOK6SZ.js";
-import "../chunk-THDZCUFV.js";
+} from "../chunk-JS6IYB55.js";
+import "../chunk-DOHA5HNJ.js";
 export {
   raiseEvent
 };

package/dist/analytics/log-build.cjs

@@ -140,7 +140,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "3.44.2";
+var version = "3.46.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,9 +1,9 @@
 import {
   log_build_default
-} from "../chunk-BLJ5FRR3.js";
-import "../chunk-LIIOK6SZ.js";
+} from "../chunk-FNOYJEUK.js";
+import "../chunk-JS6IYB55.js";
 import "../chunk-DAOXTQVS.js";
-import "../chunk-THDZCUFV.js";
+import "../chunk-DOHA5HNJ.js";
 import "../chunk-6QENHZZP.js";
 export {
   log_build_default as default

package/dist/{chunk-THDZCUFV.js → chunk-DOHA5HNJ.js}

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

package/dist/{chunk-BLJ5FRR3.js → chunk-FNOYJEUK.js}

@@ -1,6 +1,6 @@
 import {
   raiseEvent
-} from "./chunk-LIIOK6SZ.js";
+} from "./chunk-JS6IYB55.js";
 import {
   countResources,
   serializeCounts

package/dist/{chunk-LIIOK6SZ.js → chunk-JS6IYB55.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-THDZCUFV.js";
+} from "./chunk-DOHA5HNJ.js";
 
 // src/analytics/analytics.js
 import os from "os";

package/dist/{chunk-IU3D7JRW.js → chunk-TLLUDBO4.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-THDZCUFV.js";
+} from "./chunk-DOHA5HNJ.js";
 
 // src/utils/cli-logger.ts
 import pc from "picocolors";

package/dist/{chunk-RUACTEJR.js → chunk-X4AESI6E.js}

@@ -1,6 +1,6 @@
 import {
   logger
-} from "./chunk-IU3D7JRW.js";
+} from "./chunk-TLLUDBO4.js";
 import {
   cleanup,
   getEventCatalogConfigFile

package/dist/constants.cjs

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

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-THDZCUFV.js";
+} from "./chunk-DOHA5HNJ.js";
 export {
   VERSION
 };

package/dist/eventcatalog.cjs

@@ -144,7 +144,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "3.44.2";
+var version = "3.46.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/eventcatalog.config.d.cts

@@ -58,6 +58,28 @@ type DirectorySource = {
     loadUsers?: () => Promise<DirectoryEntry[]>;
     loadTeams?: () => Promise<DirectoryEntry[]>;
 };
+type SchemaEntry = {
+    id: string;
+    name?: string;
+    format?: string;
+    content: string;
+    source: {
+        provider: string;
+        id?: string;
+        url?: string;
+        ref?: string;
+        path?: string;
+        [key: string]: unknown;
+    };
+};
+type SchemaSource = {
+    type: 'schemas';
+    name: string;
+    canResolve: (id: string) => boolean;
+    resolve: (id: string, context?: {
+        messageFilePath?: string;
+    }) => Promise<SchemaEntry | undefined>;
+};
 type DirectoryConfig = {
     /**
      * External sources that sync users and teams into EventCatalog.
@@ -71,6 +93,12 @@ type DirectoryConfig = {
      */
     conflictStrategy?: 'local-wins' | 'source-wins' | 'error';
 };
+type SchemaConfig = {
+    /**
+     * External sources that resolve message schema references into the generated schemas collection.
+     */
+    sources?: SchemaSource[];
+};
 type AuthConfig = {
     enabled: boolean;
 };
@@ -221,6 +249,7 @@ interface Config {
         domains?: ResourceDependency[];
     };
     directory?: DirectoryConfig;
+    schemas?: SchemaConfig;
     mermaid?: {
         maxTextSize?: number;
         iconPacks?: string[];

package/dist/eventcatalog.config.d.ts

@@ -58,6 +58,28 @@ type DirectorySource = {
     loadUsers?: () => Promise<DirectoryEntry[]>;
     loadTeams?: () => Promise<DirectoryEntry[]>;
 };
+type SchemaEntry = {
+    id: string;
+    name?: string;
+    format?: string;
+    content: string;
+    source: {
+        provider: string;
+        id?: string;
+        url?: string;
+        ref?: string;
+        path?: string;
+        [key: string]: unknown;
+    };
+};
+type SchemaSource = {
+    type: 'schemas';
+    name: string;
+    canResolve: (id: string) => boolean;
+    resolve: (id: string, context?: {
+        messageFilePath?: string;
+    }) => Promise<SchemaEntry | undefined>;
+};
 type DirectoryConfig = {
     /**
      * External sources that sync users and teams into EventCatalog.
@@ -71,6 +93,12 @@ type DirectoryConfig = {
      */
     conflictStrategy?: 'local-wins' | 'source-wins' | 'error';
 };
+type SchemaConfig = {
+    /**
+     * External sources that resolve message schema references into the generated schemas collection.
+     */
+    sources?: SchemaSource[];
+};
 type AuthConfig = {
     enabled: boolean;
 };
@@ -221,6 +249,7 @@ interface Config {
         domains?: ResourceDependency[];
     };
     directory?: DirectoryConfig;
+    schemas?: SchemaConfig;
     mermaid?: {
         maxTextSize?: number;
         iconPacks?: string[];

package/dist/eventcatalog.js

@@ -1,7 +1,8 @@
 import {
-  runMigrations
-} from "./chunk-XUAF2H54.js";
-import "./chunk-CA4U2JP7.js";
+  log_build_default
+} from "./chunk-FNOYJEUK.js";
+import "./chunk-JS6IYB55.js";
+import "./chunk-DAOXTQVS.js";
 import {
   resolve_catalog_dependencies_default
 } from "./chunk-LHR4G2UO.js";
@@ -12,10 +13,9 @@ import {
   watch
 } from "./chunk-3H2RT3CM.js";
 import {
-  log_build_default
-} from "./chunk-BLJ5FRR3.js";
-import "./chunk-LIIOK6SZ.js";
-import "./chunk-DAOXTQVS.js";
+  runMigrations
+} from "./chunk-XUAF2H54.js";
+import "./chunk-CA4U2JP7.js";
 import {
   catalogToAstro
 } from "./chunk-4SMA4HQ3.js";
@@ -28,13 +28,13 @@ import {
 } from "./chunk-B7HCX5HM.js";
 import {
   generate
-} from "./chunk-RUACTEJR.js";
+} from "./chunk-X4AESI6E.js";
 import {
   logger
-} from "./chunk-IU3D7JRW.js";
+} from "./chunk-TLLUDBO4.js";
 import {
   VERSION
-} from "./chunk-THDZCUFV.js";
+} from "./chunk-DOHA5HNJ.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile

package/dist/generate.cjs

@@ -108,7 +108,7 @@ var getEventCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "3.44.2";
+var version = "3.46.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/generate.js

@@ -1,8 +1,8 @@
 import {
   generate
-} from "./chunk-RUACTEJR.js";
-import "./chunk-IU3D7JRW.js";
-import "./chunk-THDZCUFV.js";
+} from "./chunk-X4AESI6E.js";
+import "./chunk-TLLUDBO4.js";
+import "./chunk-DOHA5HNJ.js";
 import "./chunk-6QENHZZP.js";
 export {
   generate

package/dist/utils/cli-logger.cjs

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(cli_logger_exports);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "3.44.2";
+var version = "3.46.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/utils/cli-logger.js

@@ -1,7 +1,7 @@
 import {
   logger
-} from "../chunk-IU3D7JRW.js";
-import "../chunk-THDZCUFV.js";
+} from "../chunk-TLLUDBO4.js";
+import "../chunk-DOHA5HNJ.js";
 export {
   logger
 };

package/eventcatalog/astro.config.mjs

@@ -19,6 +19,11 @@ import rehypeExpressiveCode from 'rehype-expressive-code';
 /** @type {import('bin/eventcatalog.config').Config} */
 import config from './eventcatalog.config';
 import expressiveCode from 'astro-expressive-code';
+// Expressive Code options (including the non-serializable `themeCssSelector`
+// function) live in ec.config.mjs. The `expressiveCode()` integration loads that
+// file automatically; the rehype plugin used by mdx() below needs it passed
+// explicitly, so we import it here to keep a single source of truth.
+import expressiveCodeConfig from './ec.config.mjs';
 import ecstudioWatcher from './integrations/ecstudio-watcher.mjs';
 import eventCatalogIntegration from './src/enterprise/integrations/eventcatalog-features.ts';
 
@@ -30,13 +35,6 @@ const isDevMode = process.env.EVENTCATALOG_DEV_MODE === 'true';
 const effectiveOutput = isDevMode ? 'server' : config.output || 'static';
 const searchType = config.search?.type || 'resource';
 
-const expressiveCodeConfig = {
-  themes: ['github-light', 'github-dark'],
-  defaultProps: {
-    wrap: true,
-  },
-};
-
 const markdownRemarkPlugins = [remarkDirective, remarkDirectives, remarkComment, mermaid, plantuml];
 const mdxRemarkPlugins = [...markdownRemarkPlugins, remarkResourceRef];
 
@@ -78,9 +76,8 @@ export default defineConfig({
   devToolbar: { enabled: false },
   integrations: [
     react(),
-    expressiveCode({
-      ...expressiveCodeConfig,
-    }),
+    // Options are loaded automatically from ec.config.mjs.
+    expressiveCode(),
     mdx({
       // https://docs.astro.build/en/guides/integrations-guide/mdx/#optimize
       optimize: config.mdxOptimize || false,

package/eventcatalog/ec.config.mjs

@@ -0,0 +1,20 @@
+import { defineEcConfig } from 'astro-expressive-code';
+
+// Expressive Code configuration lives in this dedicated file (rather than inline
+// in astro.config.mjs) because it contains non-serializable options such as the
+// `themeCssSelector` function. Astro's `<Code>` component (used on the print
+// pages) requires Expressive Code options coming from the Astro config to be
+// JSON-serializable, so functions must be defined here instead.
+//
+// `useDarkModeMediaQuery: false` + `themeCssSelector` make code blocks follow
+// EventCatalog's own `data-theme` toggle instead of the OS `prefers-color-scheme`
+// media query, so they stay readable when the catalog theme and the OS
+// preference disagree (see issue #2607).
+export default defineEcConfig({
+  themes: ['github-light', 'github-dark'],
+  useDarkModeMediaQuery: false,
+  themeCssSelector: (theme) => `[data-theme='${theme.type}']`,
+  defaultProps: {
+    wrap: true,
+  },
+});

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

@@ -5,7 +5,7 @@ const SchemaViewerPortal = (props: any) => {
 
   return (
     <div
-      id={`${props.id}-${props.file}-SchemaViewer-portal`}
+      data-schema-viewer-portal-id={props.id}
       data-expand={expandBool ? 'true' : 'false'}
       data-max-height={props.maxHeight}
       data-search={searchBool ? 'true' : 'false'}

package/eventcatalog/src/components/MDX/SchemaViewer/SchemaViewerRoot.astro

@@ -1,13 +1,13 @@
 ---
-const { id, filePath } = Astro.props;
+const { id, filePath, collection, version } = Astro.props;
 import fs from 'node:fs/promises';
-import { existsSync } from 'fs';
-import yaml from 'js-yaml';
+import { getCollection } from 'astro:content';
 import JSONSchemaViewer from '@components/SchemaExplorer/JSONSchemaViewer';
 import AvroSchemaViewer from '@components/SchemaExplorer/AvroSchemaViewer';
 import Admonition from '../Admonition';
 import { getMDXComponentsByName } from '@utils/markdown';
-import { getAbsoluteFilePathForAstroFile, resolveProjectPath, isAvroSchema } from '@utils/files';
+import { resolveProjectPath } from '@utils/files';
+import { resolveSchemaViewer } from './schema-viewer-utils';
 
 let schemas = [];
 
@@ -15,45 +15,11 @@ try {
   const absoluteFilePath = resolveProjectPath(filePath);
   const file = await fs.readFile(absoluteFilePath, 'utf-8');
   const schemaViewers = getMDXComponentsByName(file, 'SchemaViewer');
+  const collectionSchemas = collection && version ? await getCollection('schemas') : [];
 
-  // Loop around all the possible SchemaViewers in the file.
-  const getAllComponents = schemaViewers.map(async (schemaViewerProps: any, index: number) => {
-    const schemaPath = getAbsoluteFilePathForAstroFile(filePath, schemaViewerProps.file);
-    const exists = existsSync(schemaPath);
-    let schema;
-    let render = true;
-    let isAvro = false;
-
-    if (exists) {
-      // Check if this is an Avro schema file
-      isAvro = isAvroSchema(schemaPath);
-
-      // Load the schema for the component
-      schema = await fs.readFile(schemaPath, 'utf-8');
-
-      if (schemaPath.endsWith('.yml') || schemaPath.endsWith('.yaml')) {
-        schema = yaml.load(schema);
-      } else {
-        schema = JSON.parse(schema);
-
-        // For non-Avro schemas, let JSON schema control if the component should be rendered
-        if (!isAvro && schema['x-eventcatalog-render-schema-viewer'] !== undefined) {
-          render = schema['x-eventcatalog-render-schema-viewer'];
-        }
-      }
-    }
-
-    return {
-      id: schemaViewerProps.id || id,
-      exists,
-      schema,
-      schemaPath,
-      isAvroSchema: isAvro,
-      ...schemaViewerProps,
-      render,
-      index,
-    };
-  });
+  const getAllComponents = schemaViewers.map((schemaViewerProps: any, index: number) =>
+    resolveSchemaViewer({ id, version, collection, filePath, schemaViewerProps, collectionSchemas, index })
+  );
 
   schemas = await Promise.all(getAllComponents);
 } catch (error) {
@@ -71,8 +37,10 @@ try {
           <div>
             {schema.exists && (
               <div
-                id={`${schema.id}-${schema.file}-SchemaViewer-client`}
+                id={`${schema.id}-${schema.index}-SchemaViewer-client`}
                 class="not-prose my-4"
+                data-schema-viewer-client-id={schema.id}
+                data-schema-viewer-index={schema.index}
                 data-expand={schema.expand ? 'true' : 'false'}
                 data-search={schema.search !== false ? 'true' : 'false'}
               >
@@ -105,7 +73,11 @@ try {
               <Admonition type="warning">
                 <div>
                   <span class="block font-bold">{`<SchemaViewer/>`} failed to load</span>
-                  <span class="block">Tried to load schema from {schema.schemaPath}, but no schema can be found</span>
+                  <span class="block">
+                    {schema.parseError
+                      ? `Tried to parse schema from ${schema.schemaPath}, but it failed: ${schema.parseError}`
+                      : `Tried to load schema from ${schema.schemaPath || schema.file || 'the message schema collection'}, but no schema can be found`}
+                  </span>
                 </div>
               </Admonition>
             )}
@@ -120,9 +92,9 @@ try {
   // and then we can move the SchemaViewerClient to that container?
 
   function moveSchemaViewerToPortal(schema) {
-    const portalId = `${schema.id}-${schema.file}-SchemaViewer-portal`;
-    const schemaViewerContainer = document.getElementById(portalId);
-    const schemaViewerClient = document.getElementById(`${schema.id}-${schema.file}-SchemaViewer-client`);
+    const schemaViewerContainers = document.querySelectorAll(`[data-schema-viewer-portal-id="${schema.id}"]`);
+    const schemaViewerContainer = schemaViewerContainers[schema.index];
+    const schemaViewerClient = document.getElementById(`${schema.id}-${schema.index}-SchemaViewer-client`);
 
     if (schemaViewerContainer && schemaViewerClient) {
       // Get attributes from the portal

package/eventcatalog/src/components/MDX/SchemaViewer/schema-viewer-utils.spec.ts

@@ -0,0 +1,53 @@
+import { describe, expect, it } from 'vitest';
+import { resolveSchemaViewer } from './schema-viewer-utils';
+
+const currentMessageSchema = {
+  id: 'schema:events:OrderPlaced:1.0.0:git://contracts/events/OrderPlaced.schema.json',
+  data: {
+    ref: 'git://contracts/events/OrderPlaced.schema.json',
+    format: 'jsonschema',
+    content: '{"type":"object","title":"OrderPlaced"}',
+    default: true,
+    message: {
+      collection: 'events',
+      id: 'OrderPlaced',
+      version: '1.0.0',
+    },
+  },
+};
+
+describe('resolveSchemaViewer', () => {
+  it('uses the current message default schema when no file is set', async () => {
+    const schema = await resolveSchemaViewer({
+      id: 'OrderPlaced',
+      version: '1.0.0',
+      collection: 'events',
+      filePath: 'events/OrderPlaced/index.mdx',
+      schemaViewerProps: {},
+      collectionSchemas: [currentMessageSchema],
+      index: 0,
+    });
+
+    expect(schema.exists).toBe(true);
+    expect(schema.schema.title).toBe('OrderPlaced');
+    expect(schema.schemaPath).toBe('git://contracts/events/OrderPlaced.schema.json');
+  });
+
+  it('does not use the schema collection when a file is set and missing', async () => {
+    const schema = await resolveSchemaViewer({
+      id: 'OrderPlaced',
+      version: '1.0.0',
+      collection: 'events',
+      filePath: 'events/OrderPlaced/index.mdx',
+      schemaViewerProps: {
+        file: 'missing-schema.json',
+      },
+      collectionSchemas: [currentMessageSchema],
+      index: 0,
+    });
+
+    expect(schema.exists).toBe(false);
+    expect(schema.schema).toBeUndefined();
+    expect(schema.schemaKey).toBe('missing-schema.json');
+  });
+});

package/eventcatalog/src/components/MDX/SchemaViewer/schema-viewer-utils.ts

@@ -0,0 +1,133 @@
+import { readFile } from 'node:fs/promises';
+import { existsSync } from 'node:fs';
+import { load as loadYaml } from 'js-yaml';
+import { getAbsoluteFilePathForAstroFile, isAvroSchema } from '../../../utils/files';
+
+type SchemaViewerProps = {
+  id?: string;
+  file?: string;
+  [key: string]: any;
+};
+
+type CollectionSchema = {
+  id: string;
+  data: {
+    content?: string;
+    file?: string;
+    filePath?: string;
+    ref?: string;
+    format?: string;
+    default?: boolean;
+    source?: {
+      path?: string;
+      branch?: string;
+    };
+    message?: {
+      collection: string;
+      id: string;
+      version: string;
+    };
+  };
+};
+
+type ResolveSchemaViewerOptions = {
+  id: string;
+  version?: string;
+  collection?: string;
+  filePath: string;
+  schemaViewerProps: SchemaViewerProps;
+  collectionSchemas: CollectionSchema[];
+  index: number;
+};
+
+export const getSchemaViewerKey = (schemaViewerProps: SchemaViewerProps) => schemaViewerProps.file || 'default';
+
+const isYamlSchema = (schemaPath?: string, format?: string) =>
+  schemaPath?.endsWith('.yml') || schemaPath?.endsWith('.yaml') || format === 'yaml';
+
+const isAvroSchemaReference = (schemaPath?: string, format?: string) =>
+  format === 'avro' || (schemaPath ? isAvroSchema(schemaPath) : false);
+
+const parseSchemaContent = (content: string, schemaPath?: string, format?: string) => {
+  if (isYamlSchema(schemaPath, format)) return loadYaml(content);
+  return JSON.parse(content);
+};
+
+const shouldRenderSchema = (schema: any, isAvro: boolean) => {
+  if (isAvro) return true;
+  return schema?.['x-eventcatalog-render-schema-viewer'] !== undefined ? schema['x-eventcatalog-render-schema-viewer'] : true;
+};
+
+const getCollectionSchemaForViewer = ({
+  collectionSchemas,
+  collection,
+  id,
+  version,
+}: Pick<ResolveSchemaViewerOptions, 'collectionSchemas' | 'collection' | 'id' | 'version'>) => {
+  if (!collection || !version) return undefined;
+
+  const resourceSchemas = collectionSchemas.filter((schema) => {
+    const message = schema.data.message;
+    if (!message) return false;
+    return message.collection === collection && message.id === id && message.version === version;
+  });
+
+  return resourceSchemas.find((schema) => schema.data.default) || resourceSchemas[0];
+};
+
+const getCollectionSchemaPath = (schema?: CollectionSchema) =>
+  schema?.data.filePath || schema?.data.file || schema?.data.source?.path || schema?.data.ref;
+
+export const resolveSchemaViewer = async ({
+  id,
+  version,
+  collection,
+  filePath,
+  schemaViewerProps,
+  collectionSchemas,
+  index,
+}: ResolveSchemaViewerOptions) => {
+  const schemaKey = getSchemaViewerKey(schemaViewerProps);
+  const localSchemaPath = schemaViewerProps.file ? getAbsoluteFilePathForAstroFile(filePath, schemaViewerProps.file) : undefined;
+  const localSchemaExists = localSchemaPath ? existsSync(localSchemaPath) : false;
+
+  let schema;
+  let render = true;
+  let isAvro = false;
+  let schemaPath = localSchemaPath;
+  let parseError;
+
+  if (localSchemaExists && localSchemaPath) {
+    isAvro = isAvroSchema(localSchemaPath);
+    const content = await readFile(localSchemaPath, 'utf-8');
+    schema = parseSchemaContent(content, localSchemaPath);
+    render = shouldRenderSchema(schema, isAvro);
+  } else if (!schemaViewerProps.file) {
+    const collectionSchema = getCollectionSchemaForViewer({ collectionSchemas, collection, id, version });
+    const content = collectionSchema?.data.content;
+    schemaPath = getCollectionSchemaPath(collectionSchema);
+
+    if (content) {
+      try {
+        isAvro = isAvroSchemaReference(schemaPath, collectionSchema?.data.format);
+        schema = parseSchemaContent(content, schemaPath, collectionSchema?.data.format);
+        render = shouldRenderSchema(schema, isAvro);
+      } catch (error) {
+        parseError = error instanceof Error ? error.message : 'Unknown parsing error';
+      }
+    }
+  }
+
+  return {
+    id: schemaViewerProps.id || id,
+    exists: localSchemaExists || schema !== undefined,
+    schema,
+    schemaPath,
+    schemaKey,
+    isAvroSchema: isAvro,
+    parseError,
+    ...schemaViewerProps,
+    render,
+    index,
+  };
+};