@eventcatalog/core 4.1.3 → 4.1.5

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

@@ -1,445 +0,0 @@
----
-sidebar_position: 12
-sidebar_label: Data Product API
-title: Data Product frontmatter API
-description: Understanding the API for data products
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="3.8.0" />
-
-:::warning Beta Feature
-
-Data Products are currently in **beta** and accepting feedback. The frontmatter API and supported fields may change based on community input.
-
-:::
-
-## Overview
-
-[Data products](/docs/development/guides/data-products/introduction) are markdown files with Content, MDX components and [front-matter](https://jekyllrb.com/docs/front-matter/).
-
-Here is an example of a basic data product.
-
-```md title="/data-products/PaymentAnalytics/index.mdx (example)"
----
-# Unique identifier for your data product
-id: payment-analytics
-
-# Display name rendered in EventCatalog
-name: Payment Analytics
-
-# Version of the data product
-version: 1.0.0
-
-# Brief summary of what this data product provides
-summary: Payment performance metrics and fraud detection insights
-
-# Optional owners (references teams or users)
-owners:
-  - analytics-team
-
-# Optional badges for categorization
-badges:
-  - content: Analytics
-    backgroundColor: purple
-    textColor: purple
-
-# Input dependencies (events, services, data stores)
-inputs:
-  - id: PaymentProcessed
-  - id: FraudCheckCompleted
-  - id: PaymentService
-
-# Output data products (events, services, data stores with optional contracts)
-outputs:
-  - id: payment-analytics-db
-    contract:
-      path: payment-metrics-contract.json
-      name: Payment Metrics Contract
-      type: json-schema
----
-
-## Overview
-
-The Payment Analytics data product transforms payment events into actionable insights.
-
-<NodeGraph />
-```
-
-## Required fields
-
-### `id`
-
-- Type: `string`
-
-Unique id of the data product. EventCatalog uses this for references and slugs.
-
-```mdx title="Example"
----
-  id: payment-analytics
----
-```
-
-### `name`
-
-- Type: `string`
-
-Name of the data product used to display on the UI.
-
-```mdx title="Example"
----
-  name: Payment Analytics
----
-```
-
-### `version`
-
-- Type: `string`
-
-Version of the data product.
-
-```mdx title="Example"
----
-  version: 1.0.0
----
-```
-
-## Optional fields
-
-### `summary`
-
-Short summary of your data product, shown on summary pages.
-
-```mdx title="Example"
----
-  summary: |
-    Comprehensive payment performance metrics including success rates,
-    failure analysis, and fraud detection insights.
----
-```
-
-### `inputs`
-
-- Type: `array`
-
-Array of input dependencies that feed the data product. Inputs can be events, commands, queries, services, data stores, or channels.
-
-```mdx title="Example"
----
-inputs:
-  - id: PaymentProcessed
-  - id: OrderConfirmed
-  - id: PaymentService
-  - id: payments-db
----
-```
-
-Each input can optionally specify a version:
-
-```mdx title="Example with versions"
----
-inputs:
-  - id: PaymentProcessed
-    version: 2.1.0
-  - id: OrderConfirmed
-    version: latest  # Default if not specified
----
-```
-
-### `outputs`
-
-- Type: `array`
-
-Array of outputs produced by the data product. Outputs can be events, commands, queries, services, or data stores.
-
-```mdx title="Example"
----
-outputs:
-  - id: OrderMetricsCalculated
-  - id: NotificationService
-  - id: orders-analytics-db
----
-```
-
-Outputs can include contracts to define schema specifications:
-
-```mdx title="Example with contracts"
----
-outputs:
-  - id: payment-analytics-db
-    contract:
-      path: payment-metrics-contract.json
-      name: Payment Metrics Contract
-      type: json-schema
-  - id: daily-sales-db
-    contract:
-      path: daily-sales-odcs.yaml
-      name: Daily Sales ODCS
-      type: odcs
----
-```
-
-Contract properties:
-
-| Property | Type | Required | Description |
-| -------- | ---- | -------- | ----------- |
-| `path` | `string` | Yes | File path relative to data product directory |
-| `name` | `string` | Yes | Display name for the contract |
-| `type` | `string` | Yes | Contract format: `json-schema` or `odcs` |
-
-### `owners`
-
-- Type: `array`
-
-Array of owners for the data product. Owners reference teams or users defined in your catalog.
-
-```mdx title="Example"
----
-owners:
-  - analytics-team
-  - dboyne
----
-```
-
-### `badges`
-
-<AddedIn version="3.39.4" />
-
-- Type: `array`
-
-Array of badges to display on the data product page.
-
-```mdx title="Example"
----
-badges:
-  - content: Analytics
-    backgroundColor: purple
-    textColor: purple
-  - content: dbt
-    backgroundColor: orange
-    textColor: orange
----
-```
-
-Badge properties:
-
-| Property | Type | Required | Description |
-| -------- | ---- | -------- | ----------- |
-| `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
-
-Set `backgroundColor` or `textColor` to a named palette token for automatic light/dark mode adaptation.
-
-Supported names: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
-
-#### Use any CSS color
-
-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`
-
-Repository information for the data product.
-
-```mdx title="Example"
----
-repository:
-  language: Python
-  url: https://github.com/example/payment-analytics
----
-```
-
-Properties:
-
-| Property | Type | Required | Description |
-| -------- | ---- | -------- | ----------- |
-| `language` | `string` | No | Programming language |
-| `url` | `string` | No | Repository URL |
-
-### `schemaPath`
-
-- Type: `string`
-
-Path to the main schema file for the data product.
-
-```mdx title="Example"
----
-schemaPath: ./payment-schema.json
----
-```
-
-### `sidebar`
-
-- Type: `object`
-
-Customize sidebar appearance for the data product.
-
-```mdx title="Example"
----
-sidebar:
-  label: Payment Analytics
-  badge: New
-  color: "#4F46E5"
-  backgroundColor: "#EEF2FF"
----
-```
-
-### `specifications`
-
-- Type: `array`
-
-Array of specification files for the data product (OpenAPI, AsyncAPI, GraphQL).
-
-```mdx title="Example"
----
-specifications:
-  - type: openapi
-    path: ./api-spec.yaml
-    name: Payment Analytics API
----
-```
-
-### `hidden`
-
-- Type: `boolean`
-
-Hide the data product from the catalog UI.
-
-```mdx title="Example"
----
-hidden: true
----
-```
-
-### `editUrl`
-
-- Type: `string`
-
-Custom edit URL for the data product documentation.
-
-```mdx title="Example"
----
-editUrl: https://github.com/example/docs/edit/main/data-products/PaymentAnalytics/index.mdx
----
-```
-
-### `resourceGroups`
-
-- Type: `array`
-
-Define groups of related resources to display on the data product page.
-
-```mdx title="Example"
----
-resourceGroups:
-  - id: input-events
-    title: Input Events
-    items:
-      - id: PaymentProcessed
-        type: event
-      - id: FraudCheckCompleted
-        type: event
-    limit: 10
-    sidebar: true
----
-```
-
-### `styles`
-
-- Type: `object`
-
-Custom styling for the data product.
-
-```mdx title="Example"
----
-styles:
-  icon: DatabaseIcon
-  node:
-    color: "#4F46E5"
-    label: Payment Analytics
----
-```
-
-### `deprecated`
-
-- Type: `boolean | object`
-
-Mark the data product as deprecated.
-
-```mdx title="Example (boolean)"
----
-deprecated: true
----
-```
-
-```mdx title="Example (object)"
----
-deprecated:
-  message: Migrate to PaymentAnalyticsV2
-  date: 2026-06-01
----
-```
-
-### `visualiser`
-
-- Type: `boolean`
-
-Enable or disable the visualizer for the data product. Defaults to `true`.
-
-```mdx title="Example"
----
-visualiser: false
----
-```
-
-### `attachments`
-
-- Type: `array`
-
-Array of attachments for the data product.
-
-```mdx title="Example"
----
-attachments:
-  - url: https://example.com/pipeline-diagram.png
-    title: Pipeline Architecture
-    description: Data flow diagram for Payment Analytics
-    type: architecture-diagram
-    icon: FileTextIcon
----
-```
-
-Attachments can be URLs (strings) or objects with additional properties.
-
-Object properties:
-
-| Property | Type | Required | Description |
-| -------- | ---- | -------- | ----------- |
-| `url` | `string` | Yes | URL of the attachment |
-| `title` | `string` | No | Title of the attachment |
-| `description` | `string` | No | Description |
-| `type` | `string` | No | Type for grouping attachments |
-| `icon` | `string` | No | Icon from [lucide icons](https://lucide.dev/icons/) |
-

package/dist/docs/development/components/external-diagram-embeds/05-icepanel.md

@@ -1,68 +0,0 @@
----
-sidebar_position: 5
-keywords:
-- components
-- icepanel
-- diagrams
-sidebar_label: <IcePanel />
-title: <IcePanel />
-description: Embed an IcePanel diagram in your documentation
-id: icepanel
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-
-<AddedIn version="3.2.1" />
-
-The `<IcePanel />` component renders an [IcePanel diagram](https://icepanel.io/) in your documentation.
-
-Each IcePanel diagram embedded can also be loaded in a full screen mode, letting your teams explore the diagram in detail.
-
-### Support
-
-The `<IcePanel />` component is supported in domains, services, all messages and [custom documentation](/docs/development/bring-your-own-documentation/custom-pages/introduction).
-
-### Usage
-
-1. Get your IcePanel share URL from your IcePanel diagram (click "Share" and copy the embed URL)
-2. Include the `<IcePanel />` component inside the markdown
-    - e.g `/events/MyEvent/index.mdx`
-
-**Basic Example**
-
-```md /events/OrderAmended/index.mdx
----
-#event frontmatter
----
-
-<IcePanel url="https://s.icepanel.io/OpQVdslrqhZkyb/0QfB" />
-```
-
-**Example with title and description**
-
-```md /events/OrderAmended/index.mdx
----
-#event frontmatter
----
-
-<IcePanel
-  url="https://s.icepanel.io/OpQVdslrqhZkyb/0QfB"
-  title="System Architecture"
-  description="Overview of our microservices architecture and communication patterns."
-  height="800"
-/>
-```
-
-### Output example in EventCatalog
-
-![Example output](/img/ice-panel.png)
-
-### Props
-| Name          | Type     | Default | Required | Description                                                                                                     |
-| ------------- | -------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `url`         | `string` |         | Yes      | The share URL of the IcePanel diagram. To get the URL, click "Share" in IcePanel and copy the embed/share URL. |
-| `title`       | `string` |         | No       | The title to display above the diagram.                                                                         |
-| `description` | `string` |         | No       | A description to display below the title.                                                                       |
-| `height`      | `string` | `600`   | No       | The height of the embedded diagram in pixels.                                                                   |
-| `width`       | `string` | `100%`  | No       | The width of the embedded diagram.                                                                              |
-

package/dist/docs/development/components/external-diagram-embeds/_category_.json

@@ -1,12 +0,0 @@
-{
-  "label": "External diagram embeds",
-  "position": 5,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "components/external-diagram-embeds",
-    "title": "External diagram embeds",
-    "description": "Embed external diagramming tools in EventCatalog documentation."
-  }
-}

package/dist/docs/development/customization/custom-components/00-what-is-mdx.md

@@ -1,73 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog components
-sidebar_label: What is MDX?
-title: What is MDX?
-description: What is MDX?
----
-
-EventCatalog uses [MDX](https://mdxjs.com/) file format for documentation.
-
-Markdown is what powers EventCatalog, we encourage and follow a [docs-as-code approach](https://www.writethedocs.org/guide/docs-as-code/). This lets you write documentation in your favorite IDE and version control system, review changes, merge and deploy them.
-
-Using MDX gives you powerful features like:
-
-- [Writing and adding custom components to your documentation](/docs/development/customization/custom-components/introduction)
-- [Referring your frontmatter (title, description, image, etc) in your documentation](#how-to-refer-to-frontmatter-in-your-documentation)
-- [Using variables in your documentation](#how-to-use-variables-in-your-documentation)
-- And much more.
-
-## How to refer to frontmatter in your documentation
-
-You can refer to your frontmatter in your documentation using the `frontmatter` variable.
-
-```md title="events/MyEvent/index.mdx"
----
-id: MyEvent
-name: My Event
-version: 1.0.0
-summary: My Event Summary
----
-
-<!-- This will render My Event -->
-# {frontmatter.name}
-
-<!-- This will render My Event Summary -->
-{frontmatter.summary}
-```
-
-## How to use variables in your documentation
-
-MDX supports using the `export` statements to add variables to your documentation.
-
-For example you can export a `title` field from an MDX page or component and use it as a heading.
-
-```md title="events/MyEvent/index.mdx"
----
-id: MyEvent
-name: My Event
-version: 1.0.0
-summary: My Event Summary
----
-
-<!-- This will export the variable title -->
-export const title = "My Event"
-
-<!-- This will render the title -->
-# {title}
-
-```
-
-
-
-
-
-
-
-
-
-
-
-
-

package/dist/docs/development/customization/custom-components/01-introduction.md

@@ -1,28 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- EventCatalog components
-sidebar_label: What are custom components?
-title: Introduction
-description: Add custom components to your catalog
----
-
-EventCatalog provides the ability to add custom components to your domains, services and messages within your catalog. These features include:
-
-- Adding reuseable content across all your resources
-- Styling components with [Tailwind CSS](https://tailwindcss.com/) 
-- Adding custom [JavaScript to your pages](https://docs.astro.build/en/guides/client-side-scripts/#using-script-in-astro)
-
-
-
-### Why create components?
-
-Components are a great way to customize your EventCatalog and write shared snippets of code or content you can reuse across your EventCatalog.
-
-Components can be either [markdown files (component.mdx) or astro files (component.astro)](/docs/development/customization/custom-components/adding-components#types-of-components).
-
-:::info Astro components
-Custom components are powered by [Astro Components](https://docs.astro.build/en/basics/astro-components/). Read the Astro documentation to learn more about what you can include in your components. Custom components can be very powerful and allow some great customization.
-:::
-
-