@eventcatalog/core 3.39.5 → 3.40.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 = "3.39.5";
+var version = "3.40.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-H5BZMNK3.js";
-import "../chunk-TNE5QSJ4.js";
+} from "../chunk-WFNAWDCB.js";
+import "../chunk-UPI6QQEZ.js";
 export {
   raiseEvent
 };

package/dist/analytics/log-build.cjs

@@ -111,7 +111,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "3.39.5";
+var version = "3.40.0";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,9 +1,9 @@
 import {
   log_build_default
-} from "../chunk-KVAEAYEP.js";
-import "../chunk-H5BZMNK3.js";
+} from "../chunk-72BKUYSR.js";
+import "../chunk-WFNAWDCB.js";
 import "../chunk-4UVFXLPI.js";
-import "../chunk-TNE5QSJ4.js";
+import "../chunk-UPI6QQEZ.js";
 import "../chunk-5T63CXKU.js";
 export {
   log_build_default as default

package/dist/{chunk-KVAEAYEP.js → chunk-72BKUYSR.js}

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

package/dist/{chunk-M4S7PORQ.js → chunk-J5CG7FRO.js}

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

package/dist/{chunk-S4HLJWQ7.js → chunk-K762FILQ.js}

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

package/dist/{chunk-TNE5QSJ4.js → chunk-UPI6QQEZ.js}

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

package/dist/{chunk-H5BZMNK3.js → chunk-WFNAWDCB.js}

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

package/dist/constants.cjs

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

package/dist/constants.js

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

package/dist/docs/api/03-domain-api.md

@@ -283,6 +283,22 @@ You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`,
 ---
 ```
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+  badges:
+    - content: View Runbook
+      url: https://runbooks.example.com/my-domain
+      backgroundColor: blue
+      textColor: white
+---
+```
+
 ### `specifications` {#specifications}
 
 <AddedIn version="2.6.0" />

package/dist/docs/api/04-service-api.md

@@ -263,6 +263,22 @@ You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`,
 ---
 ```
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+  badges:
+    - content: View Runbook
+      url: https://runbooks.example.com/my-service
+      backgroundColor: blue
+      textColor: white
+---
+```
+
 ### `specifications` {#specifications}
 
 <AddedIn version="2.39.1" />

package/dist/docs/api/05-command-api.md

@@ -186,6 +186,22 @@ You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`,
 ---
 ```
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+  badges:
+    - content: View Runbook
+      url: https://runbooks.example.com/my-command
+      backgroundColor: blue
+      textColor: white
+---
+```
+
 ### `schemaPath` {#schemaPath}
 
 Path to the schema of the message.

package/dist/docs/api/06-event-api.md

@@ -185,6 +185,22 @@ You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`,
 ---
 ```
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+  badges:
+    - content: View Runbook
+      url: https://runbooks.example.com/my-event
+      backgroundColor: blue
+      textColor: white
+---
+```
+
 ### `schemaPath` {#schemaPath}
 
 Path to the schema of the message.

package/dist/docs/api/06-query-api.md

@@ -183,6 +183,22 @@ You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`,
 ---
 ```
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+  badges:
+    - content: View Runbook
+      url: https://runbooks.example.com/my-query
+      backgroundColor: blue
+      textColor: white
+---
+```
+
 ### `schemaPath` {#schemaPath}
 
 Path to the schema of the message.

package/dist/docs/api/08-channel-api.md

@@ -251,6 +251,22 @@ You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`,
 ---
 ```
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+  badges:
+    - content: View Runbook
+      url: https://runbooks.example.com/my-channel
+      backgroundColor: blue
+      textColor: white
+---
+```
+
 ### `repository` {#repository}
 
 <AddedIn version="2.11.2" />

package/dist/docs/api/09-flow-api.md

@@ -360,6 +360,22 @@ You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`,
 ---
 ```
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+  badges:
+    - content: View Runbook
+      url: https://runbooks.example.com/my-flow
+      backgroundColor: blue
+      textColor: white
+---
+```
+
 ### `editUrl` {#editUrl}
 
 <AddedIn version="2.49.4" />

package/dist/docs/api/10-entity-api.md

@@ -233,6 +233,21 @@ You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`,
 ---
 ```
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+  badges:
+    - content: View Runbook
+      url: https://runbooks.example.com/my-entity
+      backgroundColor: blue
+      textColor: white
+---
+```
 
 ### `editUrl` {#editUrl}
 

package/dist/docs/api/12-data-product-api.md

@@ -229,6 +229,7 @@ Badge properties:
 | `content` | `string` | Yes | Text content of the badge |
 | `backgroundColor` | `string` | Yes | Background color (named token or CSS value) |
 | `textColor` | `string` | Yes | Text color (named token or CSS value) |
+| `url` | `string` | No | When set, the badge renders as a clickable link with an external-link icon |
 
 #### Use named colors
 
@@ -240,6 +241,22 @@ Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `
 
 You can also pass any valid CSS color value directly: hex (`#ff0000`), `rgb()`, `hsl()`, `oklch()`, or a CSS variable (`var(--my-color)`).
 
+#### Link to external URLs
+
+<AddedIn version="3.39.6" />
+
+Add a `url` to a badge to make it render as a clickable link with an external-link icon. When `url` is omitted, the badge renders as a plain label.
+
+```md title="Link badge example"
+---
+badges:
+  - content: View Runbook
+    url: https://runbooks.example.com/my-data-product
+    backgroundColor: blue
+    textColor: white
+---
+```
+
 ### `repository`
 
 - Type: `object`

package/dist/docs/development/01-fundamentals.md

@@ -29,6 +29,13 @@ EventCatalog is a [docs-as-code](https://www.writethedocs.org/guide/docs-as-code
 
 EventCatalog does not force you to use a specific broker, schema format, or stack. You can use it with any broker, schema format, or stack and can fit into any workflow you have. EventCatalog fits your workflow, not the other way around.
 
+### Visual editing
+
+You can also use [EventCatalog Editor](/docs/editor/overview) to maintain your catalog through a local visual workflow.
+
+The editor runs on top of your EventCatalog project, writes changes back to the same local files, and gives you a Git-backed way to review and publish changes. This helps developers, architects, analysts, and product owners contribute to the catalog without needing to work directly in Markdown files.
+
+
 ## Ready to build?
 
 Now that you understand the fundamentals, [get started with EventCatalog](/docs/development/getting-started/installation).

package/dist/docs/development/01-getting-started/installation.md

@@ -94,6 +94,14 @@ Look at my directory and generate EventCatalog documentation from information yo
 
 The generated files can be edited like any other EventCatalog documentation. Learn more about [EventCatalog skills](/docs/development/ask-your-architecture/skills/introduction).
 
+## Optional: Use EventCatalog Editor
+
+You can edit your catalog files directly in Markdown, or use [EventCatalog Editor](/docs/editor/overview) for a local visual editing workflow.
+
+The editor runs on top of your EventCatalog project, writes changes back to your local files, and gives you a Git-backed way to review and publish changes. This is useful when architects, developers, analysts, or product owners need to help maintain the catalog without working directly in Markdown.
+
+To use the editor, you need Git installed and editor access through [EventCatalog Cloud](https://eventcatalog.cloud). Learn how to [run EventCatalog Editor locally](/docs/editor/how-to/run-locally).
+
 ## Next steps
 
 - [Understand the project structure](/docs/development/getting-started/project-structure)

package/dist/docs/development/01-getting-started/project-structure.md

@@ -11,6 +11,8 @@ import ProjectTree from '@site/src/components/MDX/ProjectTree';
 
 An EventCatalog project is a folder of Markdown files that describe and model your architecture.
 
+You can edit these files directly, or use the optional [EventCatalog Editor](/docs/editor/overview) to create, preview, review, and commit catalog content through a visual workflow.
+
 Each resource in your catalog, such as a domain, service, event, command, query, team, or diagram, is represented by a file or folder in your project. EventCatalog reads those files and turns them into a catalog.
 
 You can also bring your own documentation into EventCatalog, such as architecture decision records, guides, onboarding material, or runbooks. Learn more about [bringing your own documentation](/docs/development/bring-your-own-documentation/introduction).

package/dist/docs/development/ask-your-architecture/03-mcp-server/getting-started.md

@@ -45,6 +45,78 @@ Visit the endpoint in your browser to verify. It returns available tools and res
 }
 ```
 
+### Protect with OAuth
+
+<AddedIn version="3.40.0" />
+
+The built-in MCP server can be protected with OAuth Bearer tokens, following the MCP authorization specification for HTTP transports.
+
+EventCatalog acts as the OAuth protected resource server for `/docs/mcp`. Your identity provider or authorization server remains responsible for user login, consent, client registration, `/authorize`, `/oauth/token`, and token refresh.
+
+Configure MCP authorization in `eventcatalog.config.js`:
+
+```js title="eventcatalog.config.js"
+module.exports = {
+  output: 'server',
+  mcp: {
+    auth: {
+      enabled: true,
+      resource: 'https://your-eventcatalog.com/docs/mcp',
+      authorizationServers: ['https://auth.example.com'],
+      issuer: 'https://auth.example.com',
+      audience: 'https://your-eventcatalog.com/docs/mcp',
+      requiredScopes: ['catalog:read'],
+      jwksUri: 'https://auth.example.com/.well-known/jwks.json',
+    },
+  },
+};
+```
+
+When enabled, EventCatalog serves protected resource metadata at `/.well-known/oauth-protected-resource`. Unauthenticated MCP clients receive a `401 Unauthorized` response with a `WWW-Authenticate` header pointing at that document. MCP clients then obtain an access token from the advertised authorization server and call `/docs/mcp` with:
+
+```http
+Authorization: Bearer <access-token>
+```
+
+The access token must be valid, unexpired, issued by the configured issuer, intended for the configured audience, and include all required scopes.
+
+#### Key signing options
+
+Choose one of the following strategies for token validation:
+
+| Strategy | Config fields |
+|---|---|
+| JWKS endpoint (recommended) | `jwksUri` |
+| Inline asymmetric public key | `publicKey` or `publicKeyEnvVar` |
+| Symmetric shared secret | `sharedSecret` or `sharedSecretEnvVar` |
+
+Prefer `publicKeyEnvVar` or `sharedSecretEnvVar` over inline values to avoid committing secrets to source control.
+
+#### All options
+
+| Field | Required | Description |
+|---|---|---|
+| `enabled` | Yes | Enables OAuth Bearer token validation |
+| `resource` | No | Absolute URL of the MCP resource. Set this explicitly when behind a proxy |
+| `protectedResourceMetadataUrl` | No | URL for the protected resource metadata document. Defaults to `/.well-known/oauth-protected-resource` |
+| `authorizationServers` | No | Authorization server URLs advertised to MCP clients |
+| `issuer` | No | Expected token issuer (`iss` claim) |
+| `audience` | No | Expected token audience (`aud` claim). Defaults to `resource` |
+| `requiredScopes` | No | Scopes every token must include |
+| `jwksUri` | No | JWKS endpoint for asymmetric JWT validation |
+| `publicKey` | No | Inline public key for asymmetric JWT validation |
+| `publicKeyEnvVar` | No | Environment variable containing the public key |
+| `sharedSecret` | No | Inline shared secret for symmetric JWT validation |
+| `sharedSecretEnvVar` | No | Environment variable containing the shared secret |
+
+:::note Existing website authentication
+The `auth.enabled` and `eventcatalog.auth.js` settings protect the EventCatalog website with browser sessions. MCP authorization is separate because MCP clients authenticate with Bearer tokens, not browser cookies.
+:::
+
+:::tip Authorization server discovery
+EventCatalog serves `/.well-known/oauth-protected-resource` for MCP client discovery. It does not serve `/.well-known/oauth-authorization-server`, `/authorize`, or `/oauth/token` -- those endpoints must be provided by the authorization server listed in `authorizationServers`. If your MCP client expects those endpoints on the catalog host, proxy the authorization server behind that host with your load balancer or reverse proxy.
+:::
+
 ### Connect clients
 
 <details>

package/dist/docs/development/bring-your-own-documentation/01-introduction.md

@@ -9,6 +9,8 @@ description: Bring your own documentation to EventCatalog
 
 EventCatalog allows you to centralise architecture documentation alongside your domains, services, and events — keeping knowledge and context in one place.
 
+You can write this documentation with Markdown and MDX, or use the optional [EventCatalog Editor](/docs/editor/overview) for a visual editing workflow.
+
 Common use cases include:
 
 - Architecture decision records (ADRs)
@@ -45,4 +47,4 @@ This can be useful if you want to document details tied to a specific domain, se
 
 EventCatalog will render your custom documentation alongside the resource it is tied to in the sidebar.
 
-[Read the resource docs guide](/docs/guides/bring-your-own-documentation/resource-docs).
+[Read the resource docs guide](/docs/guides/bring-your-own-documentation/resource-docs).

package/dist/docs/development/customization/customize-sidebars/00-application-sidebar.md

@@ -15,9 +15,11 @@ The application sidebar is the sidebar that is rendered on every page in EventCa
 
 ### Show/hide items in the application sidebar
 
+<AddedIn version="3.39.5" />
+
 You can show or hide items in the application sidebar by using the `sidebar` property in your `eventcatalog.config.js` file.
 
-**By default, all items is the sidebar are shown.**
+**By default, all items in the sidebar are shown.**
 
 ```js title="eventcatalog.config.js"
 // rest of the config
@@ -27,6 +29,11 @@ sidebar: [
     // This will hide the Schema Explorer
     visible: false,
   },
+  {
+    id: '/discover/events',
+    // This will hide the Events item
+    visible: false,
+  },
 ]
 ```
 
@@ -38,8 +45,41 @@ Options for the `sidebar` property:
 | ID | Description |
 | --- | --- |
 | `/` | The home page icon |
-| `/docs` | The documentation page icon |
-| `/discover` | The discover page icon |
-| `/directory` | The users directory page icon |
+| `/docs/custom` | The custom documentation page |
+| `/discover/domains` | The domains page |
+| `/discover/services` | The services page |
+| `/discover/external-systems` | The external systems page |
+| `/discover/events` | The events page |
+| `/discover/commands` | The commands page |
+| `/discover/queries` | The queries page |
+| `/discover/flows` | The flows page |
+| `/discover/containers` | The data stores page |
+| `/discover/data-products` | The data products page |
+| `/directory/teams` | The teams page |
+| `/directory/users` | The users page |
+| `/settings/general` | The settings page |
 | `/studio` | The EventCatalog Studio icon |
-| `/schemas/explorer` | The schema explorer page |
+| `/schemas/explorer` | The schema explorer page |
+| `/schemas/fields` | The schema insights page (SSR only) |
+
+### Use legacy group ids
+
+You can also use legacy group ids to hide all items in a section at once. Setting a group id to `visible: false` hides every item that belongs to that group.
+
+| Legacy ID | Items hidden |
+| --- | --- |
+| `/docs` | `/docs/custom` |
+| `/discover` | All discover items (domains, services, events, commands, queries, flows, data stores, data products, external systems) |
+| `/directory` | `/directory/teams` and `/directory/users` |
+| `/settings` | `/settings/general` |
+
+```js title="eventcatalog.config.js"
+// rest of the config
+sidebar: [
+  {
+    id: '/directory',
+    // This will hide both Teams and Users
+    visible: false,
+  },
+]
+```

package/dist/docs/editor/00-overview.md

@@ -0,0 +1,73 @@
+---
+sidebar_position: 1
+sidebar_label: Overview
+title: EventCatalog Editor
+description: Understand what EventCatalog Editor is, who it is for, and how it fits into your catalog workflow.
+---
+
+EventCatalog Editor is a local visual editor for maintaining an EventCatalog.
+
+It runs on your machine, opens your catalog from disk, lets you edit architecture resources without working directly in Markdown or MDX, and gives you a Git-backed view of the changes before you commit them.
+
+![EventCatalog Editor open on a service resource](./images/editor.png)
+
+## Who the editor is for
+
+The editor is for people who maintain an EventCatalog:
+
+- Architects documenting [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/services/introduction), [messages](/docs/development/guides/messages/overview), and [ownership](/docs/owners)
+- Developers keeping resource documentation, schemas, and specifications up to date
+- Analysts, product owners, or domain experts who can improve catalog content but do not want to edit MDX files directly
+
+You still own your catalog as files. The editor makes those files easier to browse, edit, preview, review, and commit.
+
+::::info Need an EventCatalog first?
+
+These docs assume you already have an EventCatalog project. If you are just getting started, create a catalog first with the [EventCatalog installation guide](/docs/development/getting-started/installation), then come back here.
+
+::::
+
+## What the editor does
+
+Use EventCatalog Editor to:
+
+- Open a local EventCatalog project
+- Browse [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/services/introduction), [messages](/docs/development/guides/messages/overview), [channels](/docs/development/guides/channels/introduction), [entities](/docs/development/guides/domains/entities/introduction), [data stores](/docs/development/guides/data/introduction), [flows](/docs/development/guides/flows/introduction), [users](/docs/development/guides/owners/users/introduction), and [teams](/docs/development/guides/owners/teams/introduction)
+- Edit documentation in a rich editor or source editor
+- Update common frontmatter fields through forms
+- Add schemas to [events](/docs/development/guides/messages/events/introduction), [commands](/docs/development/guides/messages/commands/introduction), and [queries](/docs/development/guides/messages/queries/introduction)
+- Add OpenAPI, AsyncAPI, and GraphQL specifications to domains and services
+- Preview resources in a running EventCatalog site
+- Inspect local Git changes, view diffs, revert files, and commit work
+- Invite editors through [EventCatalog Cloud](https://eventcatalog.cloud) and assign editor seats
+
+## Local workflow
+
+The editor sits on top of the same files that EventCatalog already uses.
+
+```mermaid
+flowchart LR
+  A[Local EventCatalog files] --> B[EventCatalog Editor]
+  B --> C[Markdown, MDX, schema, and config changes]
+  C --> D[Git changes view]
+  D --> E[Commit locally]
+  E --> F[Your existing review and publishing workflow]
+```
+
+The editor does not replace Git, Markdown, MDX, or your deployment process. It gives catalog maintainers a safer interface for making changes before those changes go through the workflow your team already uses.
+
+## Beta status
+
+EventCatalog Editor is in beta. You can use it today, but some workflows and features may change before general availability.
+
+The editor is a seat-based paid product. Community includes 1 editor seat, Starter includes 3 editor seats, Scale includes 10 editor seats, and Enterprise includes unlimited editor seats. See the [pricing page](/pricing) for current plan details.
+
+If you want to help shape the editor, join the [EventCatalog Discord](https://eventcatalog.dev/discord) or [open an issue in the editor repository](https://github.com/event-catalog/eventcatalog-editor-code/issues).
+
+## Next steps
+
+- Follow the [first edit tutorial](/docs/editor/first-edit).
+- Learn how to [run the editor locally](/docs/editor/how-to/run-locally).
+- Learn how to [use the Flow Editor](/docs/editor/how-to/use-flow-editor).
+- Learn how to [invite editors](/docs/editor/how-to/invite-editors).
+- Understand [how the editor works](/docs/editor/explanation/how-it-works).