@eventcatalog/core 3.46.0 → 3.47.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.46.0";
+var version = "3.47.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-JS6IYB55.js";
-import "../chunk-DOHA5HNJ.js";
+} from "../chunk-XYCPSZ4V.js";
+import "../chunk-GBC637Z2.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.46.0";
+var version = "3.47.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

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

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

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

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

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

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

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

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

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

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

@@ -1,6 +1,6 @@
 import {
   logger
-} from "./chunk-TLLUDBO4.js";
+} from "./chunk-ZM5P2252.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.46.0";
+var version = "3.47.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-DOHA5HNJ.js";
+} from "./chunk-GBC637Z2.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.46.0";
+var version = "3.47.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/eventcatalog.js

@@ -1,8 +1,7 @@
 import {
-  log_build_default
-} from "./chunk-FNOYJEUK.js";
-import "./chunk-JS6IYB55.js";
-import "./chunk-DAOXTQVS.js";
+  runMigrations
+} from "./chunk-XUAF2H54.js";
+import "./chunk-CA4U2JP7.js";
 import {
   resolve_catalog_dependencies_default
 } from "./chunk-LHR4G2UO.js";
@@ -13,9 +12,10 @@ import {
   watch
 } from "./chunk-3H2RT3CM.js";
 import {
-  runMigrations
-} from "./chunk-XUAF2H54.js";
-import "./chunk-CA4U2JP7.js";
+  log_build_default
+} from "./chunk-ALXVETEP.js";
+import "./chunk-XYCPSZ4V.js";
+import "./chunk-DAOXTQVS.js";
 import {
   catalogToAstro
 } from "./chunk-4SMA4HQ3.js";
@@ -28,13 +28,13 @@ import {
 } from "./chunk-B7HCX5HM.js";
 import {
   generate
-} from "./chunk-X4AESI6E.js";
+} from "./chunk-ZRLFPUCO.js";
 import {
   logger
-} from "./chunk-TLLUDBO4.js";
+} from "./chunk-ZM5P2252.js";
 import {
   VERSION
-} from "./chunk-DOHA5HNJ.js";
+} from "./chunk-GBC637Z2.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.46.0";
+var version = "3.47.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/generate.js

@@ -1,8 +1,8 @@
 import {
   generate
-} from "./chunk-X4AESI6E.js";
-import "./chunk-TLLUDBO4.js";
-import "./chunk-DOHA5HNJ.js";
+} from "./chunk-ZRLFPUCO.js";
+import "./chunk-ZM5P2252.js";
+import "./chunk-GBC637Z2.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.46.0";
+var version = "3.47.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/utils/cli-logger.js

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

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

@@ -4,6 +4,7 @@ import fs from 'node:fs/promises';
 import { getCollection } from 'astro:content';
 import JSONSchemaViewer from '@components/SchemaExplorer/JSONSchemaViewer';
 import AvroSchemaViewer from '@components/SchemaExplorer/AvroSchemaViewer';
+import ProtobufSchemaViewer from '@components/SchemaExplorer/ProtobufSchemaViewer';
 import Admonition from '../Admonition';
 import { getMDXComponentsByName } from '@utils/markdown';
 import { resolveProjectPath } from '@utils/files';
@@ -46,7 +47,7 @@ try {
               >
                 {schema.title && <h2 class="text-2xl font-bold mb-2 mt-0!">{schema.title}</h2>}
 
-                {/* Render AvroSchemaViewer for Avro schemas */}
+                {/* Render the viewer matching the schema format */}
                 {schema.isAvroSchema ? (
                   <AvroSchemaViewer
                     client:load
@@ -56,6 +57,15 @@ try {
                     search={schema.search}
                     showRequired={schema.showRequired}
                   />
+                ) : schema.isProtobufSchema ? (
+                  <ProtobufSchemaViewer
+                    client:load
+                    schema={schema.schema}
+                    maxHeight={schema.maxHeight}
+                    expand={schema.expand}
+                    search={schema.search}
+                    showRequired={schema.showRequired}
+                  />
                 ) : (
                   <JSONSchemaViewer
                     client:load

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

@@ -33,6 +33,69 @@ describe('resolveSchemaViewer', () => {
     expect(schema.schemaPath).toBe('git://contracts/events/OrderPlaced.schema.json');
   });
 
+  it('parses protobuf schemas from the schema collection', async () => {
+    const protoSchema = {
+      id: 'schema:events:FraudCheckCompleted:1.0.0:git://contracts/events/FraudCheckCompleted.proto',
+      data: {
+        ref: 'git://contracts/events/FraudCheckCompleted.proto',
+        format: 'protobuf',
+        content: 'syntax = "proto3";\nmessage FraudCheckCompleted {\n  string transaction_id = 1;\n}',
+        default: true,
+        message: {
+          collection: 'events',
+          id: 'FraudCheckCompleted',
+          version: '1.0.0',
+        },
+      },
+    };
+
+    const schema = await resolveSchemaViewer({
+      id: 'FraudCheckCompleted',
+      version: '1.0.0',
+      collection: 'events',
+      filePath: 'events/FraudCheckCompleted/index.mdx',
+      schemaViewerProps: {},
+      collectionSchemas: [protoSchema],
+      index: 0,
+    });
+
+    expect(schema.exists).toBe(true);
+    expect(schema.isProtobufSchema).toBe(true);
+    expect(schema.schema.syntax).toBe('proto3');
+    expect(schema.schema.messages[0].name).toBe('FraudCheckCompleted');
+    expect(schema.schema.messages[0].fields[0].name).toBe('transaction_id');
+  });
+
+  it('captures parse errors for invalid protobuf schemas', async () => {
+    const protoSchema = {
+      id: 'schema:events:FraudCheckCompleted:1.0.0:git://contracts/events/FraudCheckCompleted.proto',
+      data: {
+        ref: 'git://contracts/events/FraudCheckCompleted.proto',
+        format: 'protobuf',
+        content: '{"this": "is not protobuf"}',
+        default: true,
+        message: {
+          collection: 'events',
+          id: 'FraudCheckCompleted',
+          version: '1.0.0',
+        },
+      },
+    };
+
+    const schema = await resolveSchemaViewer({
+      id: 'FraudCheckCompleted',
+      version: '1.0.0',
+      collection: 'events',
+      filePath: 'events/FraudCheckCompleted/index.mdx',
+      schemaViewerProps: {},
+      collectionSchemas: [protoSchema],
+      index: 0,
+    });
+
+    expect(schema.exists).toBe(false);
+    expect(schema.parseError).toBeDefined();
+  });
+
   it('does not use the schema collection when a file is set and missing', async () => {
     const schema = await resolveSchemaViewer({
       id: 'OrderPlaced',

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

@@ -1,7 +1,8 @@
 import { readFile } from 'node:fs/promises';
 import { existsSync } from 'node:fs';
 import { load as loadYaml } from 'js-yaml';
-import { getAbsoluteFilePathForAstroFile, isAvroSchema } from '../../../utils/files';
+import { getAbsoluteFilePathForAstroFile, isAvroSchema, isProtobufSchema } from '../../../utils/files';
+import { parseProtobufSchema } from '../../../utils/protobuf-schema';
 
 type SchemaViewerProps = {
   id?: string;
@@ -48,13 +49,17 @@ const isYamlSchema = (schemaPath?: string, format?: string) =>
 const isAvroSchemaReference = (schemaPath?: string, format?: string) =>
   format === 'avro' || (schemaPath ? isAvroSchema(schemaPath) : false);
 
+const isProtobufSchemaReference = (schemaPath?: string, format?: string) =>
+  format === 'protobuf' || format === 'proto' || (schemaPath ? isProtobufSchema(schemaPath) : false);
+
 const parseSchemaContent = (content: string, schemaPath?: string, format?: string) => {
+  if (isProtobufSchemaReference(schemaPath, format)) return parseProtobufSchema(content);
   if (isYamlSchema(schemaPath, format)) return loadYaml(content);
   return JSON.parse(content);
 };
 
-const shouldRenderSchema = (schema: any, isAvro: boolean) => {
-  if (isAvro) return true;
+const shouldRenderSchema = (schema: any, alwaysRender: boolean) => {
+  if (alwaysRender) return true;
   return schema?.['x-eventcatalog-render-schema-viewer'] !== undefined ? schema['x-eventcatalog-render-schema-viewer'] : true;
 };
 
@@ -94,14 +99,20 @@ export const resolveSchemaViewer = async ({
   let schema;
   let render = true;
   let isAvro = false;
+  let isProtobuf = false;
   let schemaPath = localSchemaPath;
   let parseError;
 
   if (localSchemaExists && localSchemaPath) {
     isAvro = isAvroSchema(localSchemaPath);
+    isProtobuf = isProtobufSchema(localSchemaPath);
     const content = await readFile(localSchemaPath, 'utf-8');
-    schema = parseSchemaContent(content, localSchemaPath);
-    render = shouldRenderSchema(schema, isAvro);
+    try {
+      schema = parseSchemaContent(content, localSchemaPath);
+      render = shouldRenderSchema(schema, isAvro || isProtobuf);
+    } catch (error) {
+      parseError = error instanceof Error ? error.message : 'Unknown parsing error';
+    }
   } else if (!schemaViewerProps.file) {
     const collectionSchema = getCollectionSchemaForViewer({ collectionSchemas, collection, id, version });
     const content = collectionSchema?.data.content;
@@ -110,8 +121,9 @@ export const resolveSchemaViewer = async ({
     if (content) {
       try {
         isAvro = isAvroSchemaReference(schemaPath, collectionSchema?.data.format);
+        isProtobuf = isProtobufSchemaReference(schemaPath, collectionSchema?.data.format);
         schema = parseSchemaContent(content, schemaPath, collectionSchema?.data.format);
-        render = shouldRenderSchema(schema, isAvro);
+        render = shouldRenderSchema(schema, isAvro || isProtobuf);
       } catch (error) {
         parseError = error instanceof Error ? error.message : 'Unknown parsing error';
       }
@@ -120,11 +132,12 @@ export const resolveSchemaViewer = async ({
 
   return {
     id: schemaViewerProps.id || id,
-    exists: localSchemaExists || schema !== undefined,
+    exists: schema !== undefined,
     schema,
     schemaPath,
     schemaKey,
     isAvroSchema: isAvro,
+    isProtobufSchema: isProtobuf,
     parseError,
     ...schemaViewerProps,
     render,