@eventcatalog/core 3.39.5 → 3.39.6

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.39.6";
 
 // 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-ORVOST63.js";
+import "../chunk-IKZ5ITXP.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.39.6";
 
 // 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-MQAZ4LXP.js";
+import "../chunk-ORVOST63.js";
 import "../chunk-4UVFXLPI.js";
-import "../chunk-TNE5QSJ4.js";
+import "../chunk-IKZ5ITXP.js";
 import "../chunk-5T63CXKU.js";
 export {
   log_build_default as default

package/dist/{chunk-M4S7PORQ.js → chunk-4OSFLWLG.js}

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

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

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

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

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

package/dist/{chunk-KVAEAYEP.js → chunk-MQAZ4LXP.js}

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

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

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

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-TNE5QSJ4.js";
+} from "./chunk-IKZ5ITXP.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/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).

package/dist/docs/editor/01-first-edit.md

@@ -0,0 +1,124 @@
+---
+sidebar_position: 2
+sidebar_label: First edit tutorial
+title: Make your first edit with EventCatalog Editor
+description: Learn the basic editor workflow by opening a local catalog, changing a resource, previewing it, and reviewing the Git change.
+slug: /editor/first-edit
+---
+
+This tutorial takes you through the first successful editor workflow:
+
+1. Run EventCatalog locally
+2. Run EventCatalog Editor
+3. Open a catalog resource
+4. Make a small documentation change
+5. Preview the resource
+6. Review the Git diff
+7. Publish the change
+
+The goal is not to document a whole architecture. The goal is to learn the editor loop.
+
+::::info Need a catalog?
+
+This tutorial assumes you already have an EventCatalog project on your machine. If you do not, follow the [EventCatalog installation guide](/docs/development/getting-started/installation) first.
+
+::::
+
+## Prerequisites
+
+Before you start, make sure you have:
+
+- Node.js 22 or later
+- Git installed
+- An EventCatalog project containing `eventcatalog.config.js`
+- Access to EventCatalog Editor through [EventCatalog Cloud](https://eventcatalog.cloud)
+- A terminal open in or near your catalog project
+
+If a teammate needs access, an organization admin can [invite them as an editor](/docs/editor/how-to/invite-editors).
+
+Check Node and Git with:
+
+```bash
+node -v
+git --version
+```
+
+## Start your EventCatalog preview
+
+Open a terminal in your EventCatalog project and start EventCatalog:
+
+```bash
+npm run dev
+```
+
+By default, EventCatalog runs at [http://localhost:3000](http://localhost:3000).
+
+The editor can still run without a preview, but preview links are only available when EventCatalog is running locally.
+
+## Start the editor
+
+Open another terminal in the same catalog directory and run:
+
+```bash
+npx @eventcatalog/editor
+```
+
+The editor starts on [http://localhost:3900](http://localhost:3900) and opens your browser.
+
+If the editor asks you to sign in, sign in with [EventCatalog Cloud](https://eventcatalog.cloud) and return to the local editor.
+
+## Open a resource
+
+Choose a resource from the left navigation. A good first edit is a [service](/docs/development/guides/services/introduction), [domain](/docs/development/guides/domains/introduction), [event](/docs/development/guides/messages/events/introduction), [command](/docs/development/guides/messages/commands/introduction), or [query](/docs/development/guides/messages/queries/introduction) that already exists in your catalog.
+
+The editor shows:
+
+- The resource list on the left
+- The resource documentation in the center
+- Metadata and relationship fields around the editor
+
+![Service resource open in EventCatalog Editor](./images/editor.png)
+
+## Make a small change
+
+Change a short paragraph, summary, [owner](/docs/owners), badge, or other low-risk field.
+
+The editor writes changes back to your local catalog files. For example, editing a service updates the matching `index.mdx` file in your catalog.
+
+You can use the rich editor for normal writing, or switch to source mode when you need to work directly with Markdown, MDX, or frontmatter.
+
+## Preview the resource
+
+Use **Open Preview** to view the resource in your running EventCatalog site.
+
+![Open Preview button in EventCatalog Editor](./images/open-preview.png)
+
+Preview opens the page from your local EventCatalog development server. If preview is unavailable, check that EventCatalog is running and that the editor detected the correct preview port.
+
+## Review the change
+
+Open **Changes** from the editor navigation.
+
+The changes page groups local Git changes by EventCatalog resource. Open the changed file to inspect the diff.
+
+![Changes page showing a local Git diff](./images/change-diff.png)
+
+## Publish the change
+
+When the diff looks right, click **Publish** in the editor.
+
+In the beta editor, **Publish** commits your changes locally to Git. It does not deploy your catalog or open a pull request.
+
+After publishing, continue with your team's normal review and release workflow. For example, you might push a branch and open a pull request, or push directly if that is how your catalog is maintained.
+
+## What you learned
+
+You have completed the core editor loop:
+
+- Open a local catalog
+- Edit a resource
+- Preview the resource locally
+- Review the Git diff
+- Publish a local commit
+
+Next, learn how to [edit resources](/docs/editor/how-to/edit-resource), [add schemas and specifications](/docs/editor/how-to/add-schemas-and-specifications), or [review and publish changes](/docs/editor/how-to/review-and-commit-changes).