@eventcatalog/core 4.1.3 → 4.1.5

package/dist/docs/development/guides/agents/ownership/01-owners.md

@@ -1,67 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog
-- agents
-- owners
-sidebar_label: Owners
-title: Adding agent owners
-description: Adding owners to agents with EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="3.41.0" />
-
-Owners in EventCatalog are either **users** or **teams** and are optional. Assigning owners to an agent makes it clear who is responsible for keeping it up to date, responding to incidents, and approving model upgrades.
-
-## Add owners using frontmatter
-
-Add the `id` of any user or team to the `owners` array in your agent's frontmatter:
-
-```md title="/agents/FraudReviewAgent/index.mdx (example)"
----
-id: FraudReviewAgent
-version: 0.0.1
-owners:
-  - dboyne      # a user id
-  - full-stack  # a team id
----
-```
-
-:::tip Creating users and teams
-EventCatalog gives you the ability to create users and teams. You can read the documentation to get started.
-:::
-
-## Show owned agents on a team page
-
-<AddedIn version="3.41.0" />
-
-Teams and users gained an `ownedAgents` array alongside `ownedServices`. Add agent references to a team file to surface owned agents directly on the team's catalog page.
-
-```md title="/teams/full-stack.mdx (example)"
----
-id: full-stack
-name: Full Stack Team
-ownedAgents:
-  - id: FraudReviewAgent
-    version: 0.0.1
-  - id: OrderSupportAgent
-ownedServices:
-  - id: PaymentService
-    version: 0.0.1
----
-```
-
-The same field is available on user files:
-
-```md title="/users/dboyne.mdx (example)"
----
-id: dboyne
-name: David Boyne
-ownedAgents:
-  - id: InventoryRebalancingAgent
----
-```
-
-If no `version` is provided, EventCatalog uses the latest version of the agent.

package/dist/docs/development/guides/agents/ownership/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Ownership",
-  "position": 6,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/agents-ownership",
-    "description": "A collection of guides to help you manage ownership of agents in EventCatalog."
-  }
-}

package/dist/docs/development/guides/agents/versioning-and-lifecycle/01-versioning.md

@@ -1,48 +0,0 @@
----
-keywords:
-- versioning
-- agents
-sidebar_label: Versioning
-title: Versioning
-description: Learn how to version agents in EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="3.41.0" />
-
-All content in EventCatalog can be versioned. Versioning an agent lets you keep a historic snapshot whenever the agent's model, tools, or message connections change in a meaningful way.
-
-## Version an agent
-
-1. Create a `/versioned` directory inside your agent folder if one does not exist yet.
-1. Create a new folder with the version number you are archiving.
-    - Example: `/agents/FraudReviewAgent/versioned/0.0.1`
-1. Copy `index.mdx` (and any other files) into that folder.
-    - Example: `/agents/FraudReviewAgent/versioned/0.0.1/index.mdx`
-    - The `version` inside this file should match `0.0.1`.
-1. Bump the `version` in the root `index.mdx` to the next release.
-    - Example: change `version: 0.0.1` to `version: 0.0.2` in `/agents/FraudReviewAgent/index.mdx`.
-
-```
-agents/
-  FraudReviewAgent/
-    index.mdx          ← current version (0.0.2)
-    versioned/
-      0.0.1/
-        index.mdx      ← archived snapshot
-```
-
-## Navigate versions
-
-EventCatalog creates version links automatically on every agent page. Users can also navigate directly by adding the version to the URL (e.g. `/docs/agents/FraudReviewAgent/0.0.1` loads the `0.0.1` snapshot).
-
-## When to version
-
-Consider creating a new version when you:
-
-- Upgrade the underlying LLM to a new model or snapshot.
-- Add or remove a tool that changes what the agent can reach.
-- Change the messages the agent consumes or produces.
-
-Smaller documentation edits (fixing typos, improving descriptions) do not need a new version.

package/dist/docs/development/guides/agents/versioning-and-lifecycle/02-changelog.md

@@ -1,40 +0,0 @@
----
-keywords:
-- changelog
-- agents
-sidebar_label: Adding a changelog
-title: Agent changelogs
-description: Adding changelogs to agents in EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="3.41.0" />
-
-EventCatalog supports changelogs for agents. When you version an agent you can attach a `changelog.mdx` to capture what changed and why.
-
-## Add a changelog
-
-1. Add a `changelog.mdx` to your agent folder (or a versioned snapshot):
-    - Current version: `/agents/{Agent}/changelog.mdx`
-    - Versioned snapshot: `/agents/{Agent}/versioned/0.0.1/changelog.mdx`
-
-```md title="/agents/FraudReviewAgent/changelog.mdx (example)"
----
-createdAt: 2025-06-01
-badges:
-  - content: Model upgrade
-    backgroundColor: purple
-    textColor: purple
----
-
-### Upgraded to GPT-4.1
-
-The agent now runs on `gpt-4.1` (snapshot `2025-04-14`). Response latency for fraud signal explanations dropped by ~30% compared to the previous model. No changes to tools or message connections.
-```
-
-Navigate to the changelog by clicking the **Changelog** button on the agent page, or visit `/docs/agents/{Agent}/{version}/changelog` directly.
-
-## Why add changelogs?
-
-Changelogs give your team the context behind model upgrades, tool additions, and prompt changes. They are especially valuable for agents because behavior can shift when the underlying model changes even without a code deployment.

package/dist/docs/development/guides/agents/versioning-and-lifecycle/03-deprecating.md

@@ -1,41 +0,0 @@
----
-keywords:
-- EventCatalog
-- agents
-- deprecation
-sidebar_label: Deprecating agents
-title: Deprecating agents
-description: Deprecating agents with EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="3.41.0" />
-
-Any resource in EventCatalog can be deprecated. Deprecating an agent displays a banner on its page so consumers know it is no longer actively maintained.
-
-## Deprecate using frontmatter
-
-Add the `deprecated` field to your agent's frontmatter:
-
-```md title="/agents/FraudReviewAgent/index.mdx (example)"
----
-id: FraudReviewAgent
-version: 0.0.1
-
-# Deprecated as an object (recommended — gives a date and reason)
-deprecated:
-  date: 2025-09-01
-  message: |
-    This agent has been replaced by **FraudReviewAgentV2**, which uses the updated risk scoring pipeline.
-    Contact the [Payments team](mailto:payments@example.com) for migration guidance.
-
-# Or deprecated as a simple boolean
-deprecated: true
----
-```
-
-Using an object is recommended because it gives readers a date and a reason. The `date` can be in the past (already deprecated) or the future (will be deprecated).
-
-- `deprecated.date` — Date in `YYYY-MM-DD` format.
-- `deprecated.message` — Markdown string explaining why the agent is deprecated and what to use instead.

package/dist/docs/development/guides/agents/versioning-and-lifecycle/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Versioning & lifecycle",
-  "position": 5,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/agents-versioning-and-lifecycle",
-    "description": "A collection of guides to help you version and manage the lifecycle of agents in EventCatalog."
-  }
-}

package/dist/docs/development/guides/channels/ownership-and-components/01-owners.md

@@ -1,44 +0,0 @@
----
-keywords:
-- EventCatalog
-- channels 
-- owners
-sidebar_label: Owners
-title: Adding channel owners
-description: Adding owners to channels with EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.13.0" />
-
-Owners in EventCatalog are either **users** or **teams** and are **optional**.
-
-To add an owner or a team, you need to add the user or team to the owners field of the channel.
-
-## Adding owners using frontmatter
-
-To add owners within a channel you need to add them to the `owners` array within your channel frontmatter API.
-
-You need to add the `id` of the owner.
-
-```md title="/channels/OrderChannel/index.mdx (example)"
----
-id: OrderChannel
-... # other channel frontmatter
-owners:
-    - dboyne # represents a user
-    - webTeam # represents a team
----
-
-<!-- Markdown contents... -->
-
-```
-
-Assigning owners to your channels can provide others with context of who owns this channel and how to contact them.
-
-:::tip Creating users and teams
-    EventCatalog gives you the ability to create users and teams. You can read the documentation to get started.
-:::
-
-

package/dist/docs/development/guides/channels/ownership-and-components/02-components.md

@@ -1,16 +0,0 @@
----
-keywords:
-    - components 
-    - domains
-sidebar_label: Components
-title: Components
-description: Component list for domains 
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.13.0" />
-
-You can add custom EventCatalog components to your services.
-
-[See the list of components and how to use them](/docs/development/components/using-components).

package/dist/docs/development/guides/channels/ownership-and-components/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Ownership & components",
-  "position": 3,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/channels/ownership-and-components",
-    "description": "A collection of guides to help you understand entities and how they work with EventCatalog."
-  }
-}

package/dist/docs/development/guides/channels/versioning-and-lifecycle/01-versioning.md

@@ -1,31 +0,0 @@
----
-keywords:
-- versioning
-- channels
-sidebar_label: Versioning
-title: Versioning
-description: Learn how to version channels
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.13.0" />
-
-All content in EventCatalog can be versioned. This allows you to keep historic versions of content which can give context to users why things are changing.
-
-## How to version a channel
-
-1. Create a `/versioned` directory inside the `/channels` folder if one is not created already.
-1. Create a new folder with the version number inside the folder.
-    - Example: `/channels/OrdersChannel/versioned/0.0.1`
-1. Copy contents into the new folder, it at least needs your index.mdx file.
-    - Example: `/channels/OrdersChannel/versioned/0.0.1/index.mdx`
-    - Note: the version inside this index.mdx file would be `0.0.1`
-1. Bump the version of the `index.mdx` file in the route of the channel.
-    - Example `/channels/OrdersChannel/index.mdx`, change the `version` to `0.0.2`
-
-## How to navigate to versions
-
-EventCatalog will automatically create links for you within your latest version of your document. Users will also be able to navigate to any version by adding the version in the url (e.g /docs/channels/OrdersChannel/1.0.2 would load the 1.0.2 version of this channel).
-
-![Example](../../img/channels/versions.png)

package/dist/docs/development/guides/channels/versioning-and-lifecycle/02-changelog.md

@@ -1,56 +0,0 @@
----
-keywords:
-    - changelog 
-    - channels
-sidebar_label: Adding a changelog
-title: Service changelogs 
-description: Adding changelogs to your channels
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.13.0" />
-
-EventCatalog supports changelogs for [domains](/docs/domains), [services](/docs/services), [messages](/docs/messages) and [channels](/docs/channels).
-
-When you [version a channel](/docs/development/guides/channels/versioning-and-lifecycle/versioning) in EventCatalog, you can also attach a `changelog.mdx` to that service or versioned service.
-
-### Adding a changelog
-
-1. Add a `changelog.mdx` to your channel (or versioned channel)
-    - example `/channels/{Channel}/changelog.mdx`
-    - versioned example `/channels/{Channel}/versioned/1.0.0/changelog.mdx`
-
-**Example**
-```md title="/channels/OrdersChannel/changelog.mdx"
----
-createdAt: 2024-08-01
-badges:
-    - content: New channel created
-      backgroundColor: green
-      textColor: green
----
-
-### Channel protocol update
-
-The OrdersChannel now accepts messages using kafka.
-
-``` 
-
-Navigate to your change log page for your channel or **click on the Changelog button** on your channel page.
-
-:::tip "What do add to your change log?"
-Changelogs are just markdown files, this allows you to add anything you want (e.g code blocks, tables)
-
-EventCatalog code blocks supports diffs, code labels which are great features for changelogs. You can [read more here](/docs/api/code-blocks).
-
-:::
-
-### Why add changelogs?
-
-Changelogs can provide your team with the context behind the reasons and choices for changes within your channel and also be used for auditing purposes.
-
-Changelogs are visualized by EventCatalog.
-
-
-

package/dist/docs/development/guides/channels/versioning-and-lifecycle/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Versioning & lifecycle",
-  "position": 3,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/channels/versioning-and-lifecycle",
-    "description": "A collection of guides to help you understand entities and how they work with EventCatalog."
-  }
-}

package/dist/docs/development/guides/data/01-introduction.md

@@ -1,34 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog services
-- Services
-sidebar_label: What are data stores?
-title: Understanding data stores
-description: What are data resources in EventCatalog?
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.59.0" />
-
-In EventCatalog **data stores** (containers) represent data stores that are used in your architecture (e.g. databases, caches, objectStore, searchIndexes, etc).
-
-Using the data store resource in EventCatalog you can define how your [services](/docs/development/guides/services/introduction) read/write to data stores in your architecture, helping your teams understand how your services interact with data in your architecture. You can read more about how to add data stores to services [here](/docs/development/guides/services/adding-to-services/adding-data-stores-to-services).
-
-:::tip Data stores are containers (not docker containers!)
-
-Rather than create a new `data` resource directly, we choose to call these `containers`. 
-
-This follows the C4 naming convention for containers (not docker containers!) in your architecture. To learn more about containers you can read the [c4 model](https://c4model.com/abstractions/container).
-
-**For now we only use the data store from c4 model.**
-
-:::
-
-
-<!-- 
-### Further reading
-- [Event-driven architecture and domain-driven design](https://eda-visuals.boyney.io/visuals/eda-and-ddd)
-- [Domain, Subdomain, Bounded Context: Problem/Solution Space in DDD: Clearly Defined](https://medium.com/nick-tune-tech-strategy-blog/domains-subdomain-problem-solution-space-in-ddd-clearly-defined-e0b49c7b586c)
-- [Building Blocks of DDD](https://redis.io/glossary/domain-driven-design-ddd/) -->

package/dist/docs/development/guides/data/02-adding-data.md

@@ -1,86 +0,0 @@
----
-sidebar_position: 2
-keywords:
-- EventCatalog domains
-sidebar_label: Creating a data store  
-title: Creating data stores
-description: Creating and managing services within EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.59.0" />
-
-Data stores live in a `/containers` folder. This folder can be placed anywhere in your catalog.
-
-The contents are split into two sections, **frontmatter** and the **markdown content**.
-
-_Here is an example of what a data store markdown file may look like._
-
-```md title="/containers/OrdersDatabase/index.mdx (example)"
----
-# id of your data store, used for slugs and references in EventCatalog.
-id: orders-db
-# Display name of the data store, rendered in EventCatalog.
-name: Orders DB
-# Version of the data store
-version: 0.0.1
-# Type of the data store (e.g. database, cache, objectStore, searchIndex)
-container_type: database
-# Technology of the data store (e.g. postgres@14, redis@7, etc)
-technology: postgres@14
-# Classification of the data store (e.g. internal, external, etc)
-classification: internal
-# Retention of the data store (e.g. 7y, 10y, etc)
-retention: 7y
-# Residency of the data store (e.g. eu-west-1, us-east-1, etc)
-residency: eu-west-1
----
-
-## Overview
-
-This orders database stores all orders and order lines for the orders domain.
-
-<NodeGraph />
-
-```
-
-Once this file is added, the event will automatically appear across EventCatalog.
-
-## Writing data store content
-
-You can write any Markdown inside a data store.
-
-Each data store gets its own page, so use this space to fully explain how it works.
-
-You can also use [interactive components](/docs/development/components/using-components) to enrich your documentation.
-
-## Assign read/write relationships to data stores
-
-You can assign read/write relationships to data stores in EventCatalog. You can read more about how to do this [here](/docs/development/guides/services/adding-to-services/adding-data-stores-to-services).
-
-## Custom icon
-
-<AddedIn version="3.28.1" />
-
-Set `styles.icon` in your frontmatter to display a custom icon on the data store. The icon appears in the visualiser node, sidebar navigation, page header, and search results.
-
-```md title="/containers/OrdersDatabase/index.mdx (example)"
----
-id: orders-db
-name: Orders DB
-version: 0.0.1
-container_type: database
-technology: postgres@14
-styles:
-  icon: /icons/database/postgresql.svg
----
-```
-
-The value can be a path to a file in your catalog's `public/` folder (e.g. `/icons/database/postgresql.svg`) or an absolute URL. Drop SVG, PNG, or WEBP files into your catalog's `public/` folder and reference them by path.
-
-### What do data stores look like in EventCatalog?
-
-![Example](../img/containers/data-example.png)
-
-_You can see an example of a data store in the [EventCatalog demo](https://demo.eventcatalog.dev/docs/containers/order-metadata-store/0.0.1)._

package/dist/docs/development/guides/data/03a-adding-schemas-to-data-stores.md

@@ -1,73 +0,0 @@
----
-sidebar_position: 2
-keywords:
-- EventCatalog domains
-sidebar_label: Adding schemas to data stores
-title: Adding schemas to data stores
-description: Adding schemas to data stores
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.59.0" />
-
-EventCatalog supports any schema format.
-
-When you document your data stores, you may want to also include schemas, queries, or other files that are relevant to your data store.
-
-You can attach this information in two ways:
-
-- [Use codeblocks to render your schema](#using-codeblocks-to-render-your-schema)
-- [Use the `<Schema/>` component to render your schema from a file](#using-the-schema-component-to-render-your-schema-from-a-file)
-
-## Using codeblocks to render your schema
-
-You can use codeblocks to render your schema in your markdown files.
-
-Here is an example of a SQL codeblock:
-
-```md
-```sql
-  CREATE TABLE users (
-    id INT PRIMARY KEY,
-    name VARCHAR(255),
-    email VARCHAR(255)
-  );
-```_
-```
-
-You can learn more about codeblocks and configuring them in the [codeblocks documentation](/docs/api/code-blocks).
-
-## Using the `<Schema/>` component to render your schema from a file
-
-If you prefer to have your schemas, or information about your data store in a file, you can use the `<Schema/>` component to render your schema from a file.
-
-First you need to add your file in the directory of your data store
-
-Example
-
-- `/containers/OrdersDatabase/schema.sql`
-- `/containers/OrdersDatabase/queries.sql`
-
-```md
-<!-- Render the file into your page -->
-<Schema file="schema.sql" lang="sql" title="Users Table" />
-
-<!-- Render the schemas separately in an AccordionGroup -->
-<AccordionGroup>
-  <Accordion title="Users Table">
-    <!-- Load the schema from the file -->
-    <Schema file="schema.sql" lang="sql" title="Users Table" />
-  </Accordion>
-  <Accordion title="Common Queries">
-    <!-- Load the queries from the file -->
-    <Schema file="queries.sql" lang="sql" title="Common Queries" />
-  </Accordion>
-</AccordionGroup>
-```
-
-You can an example of this in the [EventCatalog Demo](https://demo.eventcatalog.dev/docs/containers/orders-db/0.0.1).
-
-:::tip Versioning information
-Remember everything in EventCatalog can be versioned. So when your data store changes you can [version your data stores](/docs/development/guides/data/versioning-and-lifecycle/versioning), and write [changes logs](/docs/development/guides/data/versioning-and-lifecycle/changelog) to help your teams understand what has changed.
-:::

package/dist/docs/development/guides/data/ownership-and-components/01-owners.md

@@ -1,45 +0,0 @@
----
-sidebar_position: 5
-keywords:
-- EventCatalog
-- services 
-- owners
-sidebar_label: Owners
-title: Adding data store owners
-description: Adding owners to data stores with EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.59.0" />
-
-Owners in EventCatalog are either **users** or **teams** and are **optional**.
-
-To add an owner or a team, you need to add the user or team to the owners field of the data store.
-
-## Adding owners using frontmatter
-
-To add owners within a data store you need to add them to the `owners` array within your data store frontmatter API.
-
-You need to add the `id` of the owner.
-
-```md title="/services/OrderService/containers/OrderDatabase/index.mdx (example)"
----
-id: OrderDatabase
-... # other data store frontmatter
-owners:
-    - dboyne # represents a user
-    - webTeam # represents a team
----
-
-<!-- Markdown contents... -->
-
-```
-
-Assigning owners to your data stores can provide others with context of who owns this data store and how to contact them.
-
-:::tip Creating users and teams
-    EventCatalog gives you the ability to create users and teams. You can [read the documentation to get started](/docs/owners).
-:::
-
-

package/dist/docs/development/guides/data/ownership-and-components/02-components.md

@@ -1,17 +0,0 @@
----
-sidebar_position: 8
-keywords:
-    - components 
-    - data stores
-sidebar_label: Components
-title: Components
-description: Component list for data stores 
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="2.59.0" />
-
-You can add custom EventCatalog components to your data stores.
-
-[See the list of components and how to use them](/docs/development/components/using-components).

package/dist/docs/development/guides/data/ownership-and-components/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Ownership & components",
-  "position": 3,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/data/ownership-and-components",
-    "description": "A collection of guides to help you understand entities and how they work with EventCatalog."
-  }
-}