@eventcatalog/core 4.1.3 → 4.1.4

package/dist/docs/development/customization/custom-components/02-adding-components.md

@@ -1,145 +0,0 @@
----
-keywords:
-- EventCatalog components
-sidebar_label: Adding components
-title: Adding components
-description: Adding custom components to your catalog
----
-
-The **components** directory is where your custom components will be created and stored.
-
-:::tip Upgrading your catalog?
-    If you don't have a `components` directory, you will need to create one in the root of your catalog (e.g `/my-catalog/components`)
-:::
-
-## Types of components
-
-EventCatalog supports [astro components](https://docs.astro.build/en/basics/astro-components/#_top) and markdown components. 
-
-1. Astro components - Dynamic components **(recommended)**
-    - Example `/my-catalog/components/my-component.astro`
-1. Markdown components - Static markdown files 
-    - Example `/my-catalog/components/my-component.mdx`    
-
-## Astro components (.astro)
-
-### Component structure
-
-Astro components are split into two parts the script and the template.
-
-``` title="/components/my-component.astro"
----
-// Component Script (JavaScript)
----
-<!-- Component Template (HTML + JS Expressions) -->
-```
-
-- **Component script**: Define variables, data, import components and make API requests [(read more)](https://docs.astro.build/en/basics/astro-components/#the-component-script)
-- **Component template**: Determines the HTML output. Also supports style and script tags. [(read more)](https://docs.astro.build/en/basics/astro-components/#the-component-template)
-
-#### Example
-
-1. First define your component.
-
-```md title="/components/my-component.astro"
----
-# Import data from your eventcatalog.config.js file
-import config from "@config"
-# Access passed-in component props, like `<MyComponent title="Hello, World" />`
-const { subtitle } = Astro.props;
----
-
-<main>
-    <span>This catalog belongs to the company:{config.organizationName}</span>
-    <span>Data given to this component {subtitle}</span>
-</main>
-
-```
-
-2. Import your component inside your domain, service or message.
-```md title="/events/OrderAccepted/index.mdx"
----
-id: OrderAccepted
-name: Order Accepted
-# ... other event data
----
-
-<!-- Import the component into your page -->
-import MyComponent from '@catalog/components/my-component.astro"
-
-# Overview 
-
-This event represents when an order has been accepted on our system.
-
-<!-- Render the component and pass props into it -->
-<MyComponent subtitle="This is a component" />
-
-```
-
-Read the full [astro guide here](https://docs.astro.build/en/basics/astro-components/#the-component-script).
-
-### Define variables inside your resources
-
-EventCatalog allows you to define variables inside your domains, services and messages that can be used to pass through to your custom components.
-
-```md title="/events/OrderAccepted/index.mdx"
----
-id: OrderAccepted
-name: Order Accepted
-# ... other event data
----
-
-<!-- Define your custom variable to use on this page -->
-export const MyCustomVariable = "Hello world";
-
-<!-- Import the component into your page -->
-import MyComponent from '@catalog/components/my-component.astro"
-
-# Overview 
-
-This event represents when an order has been accepted on our system.
-
-<!-- Render the component and pass custom variable to it -->
-<MyComponent subtitle={MyCustomVariable} />
-
-```
-
-### Reference frontmatter data in your components
-
-If you want to reference your domain, service or message data, you can reference the frontmatter information.
-
-```md title="/events/OrderAccepted/index.mdx"
----
-id: OrderAccepted
-name: Order Accepted
-# ... other event data
----
-
-<!-- Import the component into your page -->
-import MyComponent from '@catalog/components/my-component.astro"
-
-# Overview 
-
-This event represents when an order has been accepted on our system.
-
-<!-- Reference the name defined in your frontmatter -->
-<MyComponent subtitle={frontmatter.name} />
-
-```
-
-### Reference eventcatalog.config.js data in your components
-
-If you want to reference your eventcatalog.config.js data you can import it within your component.
-
-```md title="/components/my-component.astro"
----
-# Import data from your eventcatalog.config.js file
-import config from "@config"
----
-
-<main>
-    <span>This catalog belongs to the company: {config.organizationName}</span>
-    <span>This catalog title is: {config.title}</span>
-</main>
-
-```

package/dist/docs/development/customization/custom-components/03-component-styling.md

@@ -1,27 +0,0 @@
----
-keywords:
-- EventCatalog components
-sidebar_label: Component styling
-title: Component styling
-description: Adding custom components to your catalog
----
-
-EventCatalog uses [Tailwind](https://tailwindcss.com/). This means your custom components can be styled with tailwind.
-
-```md title="/components/my-component.astro"
----
-# Import data from your eventcatalog.config.js file
-import config from "@config"
-# Access passed-in component props, like `<MyComponent title="Hello, World" />`
-const { subtitle } = Astro.props;
----
-
-<main class="flex justify-center">
-    <span class="block bg-red-500">This catalog belongs to the company:{config.organizationName}</span>
-    <span class="block bg-yellow-500">Data given to this component {subtitle}</span>
-</main>
-
-```
-
-Read the full [astro guide here](https://docs.astro.build/en/basics/astro-components/#the-component-script).
-

package/dist/docs/development/customization/custom-components/04-javascript-components.md

@@ -1,32 +0,0 @@
----
-keywords:
-  - EventCatalog components
-sidebar_label: Client side scripts
-title: Client side scripts
-description: Adding client side scripts to EventCatalog components
----
-
-EventCatalog allows you to add client side JavaScript to your components.
-
-```md title="/components/my-component.astro"
----
-# component template scripts.
----
-
-<button class="alert">Click me!</button>
-
-<!-- This script will get called in the browser -->
-<script>
-  // Find all buttons with the `alert` class on the page.
-  const buttons = document.querySelectorAll('button.alert');
-
-  // Handle clicks on each button.
-  buttons.forEach((button) => {
-    button.addEventListener('click', () => {
-      alert('Button was clicked!');
-    });
-  });
-</script>
-```
-
-Read the [astro documentation for more information](https://docs.astro.build/en/guides/client-side-scripts/#using-script-in-astro).

package/dist/docs/development/customization/custom-components/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Write your own components",
-  "position": 2,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/custom-components",
-    "description": "A collection of guides to help your understand and build custom components inside your catalog."
-  }
-}

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

@@ -1,85 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog application sidebar
-sidebar_label: Application Sidebar
-title: Application Sidebar
-description: Pick and customize the application sidebar.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-The application sidebar is the sidebar that is rendered on every page in EventCatalog.
-
-![Example](../../guides/img/custom-sidebars/application-sidebar.png)
-
-### 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 in the sidebar are shown.**
-
-```js title="eventcatalog.config.js"
-// rest of the config
-sidebar: [
-  {
-    id: '/schemas/explorer',
-    // This will hide the Schema Explorer
-    visible: false,
-  },
-  {
-    id: '/discover/events',
-    // This will hide the Events item
-    visible: false,
-  },
-]
-```
-
-Options for the `sidebar` property:
-
-- `id`: The id of the item to hide.
-- `visible`: Whether to show or hide the item.
-
-| ID | Description |
-| --- | --- |
-| `/` | The home 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/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/development/customization/customize-sidebars/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "Customize Sidebars",
-  "position": 3,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/customize-sidebars",
-    "description": "A collection of guides to help you customize the sidebars in your catalog."
-  }
-}

package/dist/docs/development/developer-tools/github-action.md

@@ -1,147 +0,0 @@
----
-sidebar_position: 6
-keywords:
-- EventCatalog components
-sidebar_label: AI Reviewer
-title: AI Reviewer
-description: Integrate EventCatalog with GitHub Actions
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-import EventCatalogPro from '@site/src/components/MDX/EventCatalogPro';
-
-<EventCatalogPro />
-
-
-
-The [EventCatalog GitHub Action](https://github.com/event-catalog/github-action) brings AI-powered insight into your Git workflows. It uses large language models (LLMs) to automatically review changes to your EventCatalog, helping you catch issues early—before they reach production. You can pick from OpenAI, Anthropic, or Google.
-
-Think of it as a smart assistant for your pull requests. It doesn't just lint code—it understands the implications of your changes.
-
-<details>
-<summary>Watch the video to see the GitHub Action in action</summary>
-
-<iframe width="100%" height="
-515" src="https://www.youtube.com/embed/xAQ20eAfKsI?si=ZNQMEcAkDSjfIa3b" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
-</details>
-
-**What it does:**
-
-- Detect breaking changes in schemas during pull requests
-- Score how likely a change is to cause issues
-- List affected consumers so you know who’s impacted
-- Recommend actions to resolve problems before merging
-
-By automating the review process, this GitHub Action saves your team hours of manual effort, reduces human error, and brings consistency to your EventCatalog maintenance.
-
-You’re always in control—the final merge decision is still up to you. But now, you’ll have the insights to make it with confidence.
-
-
-<img src="/img/github-actions.png" alt="EventCatalog GitHub Action" />
-
-### Functionality
-
-The GitHub action supports many different tasks, and you can use the same action for multiple tasks.
-
-Tasks:
-
-- [schema_review](./github-action.md#task-automated-schema-reviews):
-  -  Automatically review the schemas for breaking changes in your pull requests
-
-_More tasks will be added in the future_
-
-
-
-
----
-
-### Task: Automated schema reviews
-
-The schema review task is used to review schemas for breaking changes. This task let's you catch breaking changes in your schemas before they are deployed.
-
-The schema review supports any schema format, including (JSON, Avro, Protobuf, Thrift, etc.).
-
-<img src="/img/github-actions.png" alt="EventCatalog GitHub Action" width="30%" />
-
-
-
-**Why use the schema review task?**
-
-- Capture breaking changes in your schemas before they are deployed
-- Get a score of how likely the changes are to be breaking
-- See a list of consumers that will be affected by the changes
-- Take action to fix breaking changes before they are deployed
-
-**Workflow example:**
-
-1. Your team member makes a change to a schema in EventCatalog (inside your events, queries or commands folders)
-1. The action will review the schema for breaking changes using your configured LLM (OpenAI, Anthropic, Google)
-1. The action will return a summary of changes, and give you a score of how likely the changes are to be breaking
-1. The action will list affected consumers so you know who’s impacted
-1. Your team member is still in control of the merge decision, but now has the information to make a more informed decision
-
-#### Setup
-
-:::info EventCatalog Scale License
-The GitHub action requires an EventCatalog Scale License. 
-You can get a 14 day free trial from [EventCatalog Cloud](https://eventcatalog.dev/cloud).
-:::
-
-Set your EventCatalog Scale License key in the `license_key` parameter. We recommend storing the `license_key` value as a GitHub secret.
-
-To use the EventCatalog GitHub Action, create a new .github/workflows/eventcatalog-ci.yaml file in your repository with the following content:
-
-```yaml title=".github/workflows/eventcatalog-ci.yaml"
-name: EventCatalog CI
-on:
-  push:
-  pull_request:
-    types: [opened, synchronize, reopened, labeled, unlabeled]
-  delete:
-permissions:
-  contents: read
-  pull-requests: write
-jobs:
-  schema_review:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: event-catalog/github-action@main
-        with:
-          # The task to run, currently only schema_review is supported
-          task: schema_review
-          # The AI LLM provider to use (openai, anthropic, google)
-          provider: openai
-
-          # The model to use for the task, defaults to o4-mini
-          # Find the models in the documentation below
-          model: o4-mini
-
-          # Your API KEY for the LLM provider
-          api_key: ${{ secrets.OPENAI_API_KEY }}
-          
-          # Your EventCatalog Scale License key
-          license_key: ${{ secrets.EVENT_CATALOG_LICENSE_KEY }}
-
-          # Your GitHub token
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-
-```
-
-#### Configuration options
-
-<!-- Table with configuration options -->
-
-| Parameter | Description | Required | Default |
-|-----------|-------------|----------|---------|
-| `task` | The task to run, currently only `schema_review` is supported | Yes | N/A |
-| `catalog_directory` | The directory where the EventCatalog files are located. Useful for monorepos. By default, the action will review all files in the repository. If you have EventCatalog in a subdirectory, you can specify the directory here. | No | `./` |
-| `failure_threshold` | The score below which the action will fail. The score is a number between 0 and 100. The default is 25. The LLM will return a score between 0 and 100, based on the likelihood of the changes being breaking. | No | 25 |
-| `provider` | The AI LLM provider to use (openai, anthropic, google) | Yes | openai |
-| `model` | The model to use for the task, defaults to `o4-mini`. See the list of supported models: [OpenAI models](https://github.com/event-catalog/github-action/blob/bf92166b4e4c9414caf63e88bc7a315467b506b6/src/ai-models/openai.ts#L4), [Anthropic models](https://github.com/event-catalog/github-action/blob/bf92166b4e4c9414caf63e88bc7a315467b506b6/src/ai-models/anthropic.ts#L4), [Google models](https://github.com/event-catalog/github-action/blob/bf92166b4e4c9414caf63e88bc7a315467b506b6/src/ai-models/google.ts#L4) |Yes | o4-mini |
-| `api_key` | Your API KEY for the LLM provider | Yes | N/A |
-| `license_key` | Your EventCatalog Scale License key | Yes | N/A |
-
-#### Got an issue?
-
-If you have any issues with the GitHub action, please [open an issue](https://github.com/event-catalog/github-action) on the GitHub action repository.

package/dist/docs/development/guides/12-customize-your-sidebar.md

@@ -1,12 +0,0 @@
----
-sidebar_position: 200
-keywords:
-- EventCatalog custom documentation
-sidebar_label: Customize sidebar
-title: Customize your docs sidebar
-description: Customize your docs sidebar to show your own content.
----
-
-EventCatalog provides the ability to customize the documentation sidebar to show your own content.
-
-You can read and follow the guide on [how to customize the documentation sidebar](/docs/development/customization/customize-sidebars/documentation-sidebar).

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

@@ -1,152 +0,0 @@
----
-sidebar_position: 2
-keywords:
-- EventCatalog agents
-- AI agents
-- creating agents
-sidebar_label: Creating an agent
-title: Creating agents
-description: Creating and managing agents within EventCatalog.
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="3.41.0" />
-
-Agents in EventCatalog are a great way to document AI-powered capabilities in your architecture.
-
-You can also add [tools](/docs/development/guides/agents/adding-tools) and [model metadata](/docs/development/guides/agents/model-metadata) to your agents.
-
-### What do agents look like in EventCatalog?
-
-![Example](./img/agent-documentation.png)
-
-## Adding a new agent
-
-To add a new agent, create a folder inside an `agents` directory with an `index.mdx` file.
-
-- `/agents/{Agent Name}/index.mdx`
-  - (example `/agents/FraudReviewAgent/index.mdx`)
-
-You can also place agents inside a domain or subdomain:
-
-- `/domains/{Domain Name}/agents/{Agent Name}/index.mdx`
-  - (example `/domains/Payment/agents/FraudReviewAgent/index.mdx`)
-- `/domains/{Domain Name}/subdomains/{Subdomain Name}/agents/{Agent Name}/index.mdx`
-  - (example `/domains/E-Commerce/subdomains/Payment/agents/FraudReviewAgent/index.mdx`)
-
-_Here is an example of what an agent markdown file may look like._
-
-```md title="/agents/FraudReviewAgent/index.mdx (example)"
----
-# id of your agent, used for slugs and references in EventCatalog.
-id: FraudReviewAgent
-
-# Display name of the Agent, rendered in EventCatalog
-name: Fraud Review Agent
-
-# Version of the Agent
-version: 0.0.1
-
-# Short summary of your Agent
-summary: |
-  Reviews risky payments, explains fraud signals, and recommends whether payment processing should continue.
-
-# Optional owners, references teams or users
-owners:
-    - dboyne
-
-# Optional model metadata describing the LLM this agent runs on
-model:
-  provider: OpenAI
-  name: gpt-4.1
-  version: "2025-04-14"
-
-# Optional external tools the agent can call
-tools:
-  - name: Risk profile lookup
-    type: mcp
-    icon: /icons/tools/datadog.svg
-    url: https://mcp.example.com/fraud/risk-profile
-    description: Retrieves transaction anomaly, device fingerprint, and fraud model signals.
-
-# Optional messages this agent receives and it's version
-receives:
-  - id: PaymentInitiated
-    version: 0.0.1
-
-# Optional messages this agent sends and it's version
-sends:
-  - id: FraudReviewCompleted
-    version: 0.0.1
-
-# Optional data stores this agent reads from
-readsFrom:
-  - id: fraud-analytics-db
-    version: 0.0.1
-
-# Optional badges, rendered to UI by EventCatalog
-badges:
-    - content: AI Agent
-      backgroundColor: purple
-      textColor: purple
----
-
-## Overview
-
-The Fraud Review Agent reviews risky payment attempts before they continue through the payment gateway.
-
-<NodeGraph />
-
-## Tools
-
-<AgentTools />
-```
-
-## Adding content
-
-With **agents** you can write any Markdown you want and it will render on your page. Every agent gets its own page.
-
-Within your markdown content you can use [components](/docs/development/components/using-components) to add interactive components to your page.
-
-## Adding tools to your agent
-
-You can document the external tools (MCP servers, APIs, databases) an agent can call.
-
-You can read more about adding tools to your agent [here](/docs/development/guides/agents/adding-tools).
-
-## Attaching an agent to a domain
-
-To associate an agent with a domain, add its `id` to the `agents` array in the domain's frontmatter:
-
-```md title="/domains/Payment/index.mdx (example)"
----
-id: Payment
-name: Payment Domain
-version: 0.0.1
-agents:
-  - id: FraudReviewAgent
-    version: 0.0.1
-services:
-  - id: PaymentService
-    version: 0.0.1
----
-```
-
-EventCatalog will show the agent in the domain sidebar and include it in the domain visualiser.
-
-## Custom icon
-
-Set `styles.icon` in your frontmatter to display a custom icon on the agent. The icon appears in the visualiser node, sidebar navigation, page header, and search results.
-
-```md title="/agents/FraudReviewAgent/index.mdx (example)"
----
-id: FraudReviewAgent
-name: Fraud Review Agent
-version: 0.0.1
-styles:
-  icon: /icons/agents/fraud-review.svg
----
-```
-
-The value can be a path to a file in your catalog's `public/` folder (e.g. `/icons/logo.svg`) or an absolute URL. [Simple Icons CDN](https://cdn.simpleicons.org) is a useful source for brand logos.

package/dist/docs/development/guides/agents/adding-to-agents/_category_.json

@@ -1,10 +0,0 @@
-{
-  "label": "Adding to agents",
-  "position": 7,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/adding-to-agents"
-  }
-}