@eventcatalog/core 4.1.2 → 4.1.4

package/dist/docs/development/guides/systems/04-model-relationships-and-actors.md

@@ -0,0 +1,86 @@
+---
+sidebar_position: 4
+keywords:
+- EventCatalog systems
+- system relationships
+- system actors
+sidebar_label: Model relationships and actors
+title: Model relationships and actors
+description: Model relationships between systems and the actors that interact with them.
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+
+<AddedIn version="4.0" />
+
+Systems can describe how they relate to other systems and which people, roles, or external participants interact with them.
+
+EventCatalog uses this information to render context diagrams for systems and domains.
+
+![Product Catalog System context diagram](./img/product-catalog-system-context-map.png)
+
+## Add relationships to other systems
+
+Use `relationships` to connect one system to another system.
+
+```md title="/domains/Shopping/systems/cart-system/index.mdx"
+---
+id: cart-system
+name: Cart System
+version: 1.0.0
+relationships:
+  # id of the system it has a relationship with
+  - id: promotion-system
+    # version of the system (optional)
+    version: 1.0.0
+    # label used for edge in graph
+    label: calculates discounts via
+---
+```
+
+The `label` is shown on the relationship edge in context diagrams.
+
+Relationships are one-directional. Define the relationship on the system that owns the source of the relationship.
+
+## Add actors
+
+Use `actors` to show people, roles, or external participants that interact with a system.
+
+```md title="/domains/Shopping/systems/cart-system/index.mdx"
+---
+id: cart-system
+name: Cart System
+version: 1.0.0
+# define any actors for that system
+actors:
+  # unique id for actor (shared across your catalog)
+  - id: shopper
+    name: Shopper
+    # label used in the edge
+    label: adds items and checks out
+    # inbound or outbound
+    direction: inbound
+---
+```
+
+Use `direction: inbound` when the actor interacts with the system.
+
+Use `direction: outbound` when the system reaches out to the actor, such as sending an email or notification.
+
+## Show the context diagram
+
+Add `<ContextDiagram />` to a system page to show the system in context with related systems and actors.
+
+```md title="/domains/Shopping/systems/cart-system/index.mdx"
+## Context Diagram
+
+<ContextDiagram />
+```
+
+You can also open the context diagram directly:
+
+```txt
+/visualiser/systems/{system-id}/{version}/context
+```
+
+For the complete relationship and actor fields, see the [systems reference](/docs/development/guides/systems/reference).

package/dist/docs/development/guides/systems/05-system-context-maps.md

@@ -0,0 +1,67 @@
+---
+sidebar_position: 5
+keywords:
+- EventCatalog systems
+- System context map
+- Architecture visualizer
+sidebar_label: System context maps
+title: System context maps
+description: Visualize systems from high-level context maps down to detailed resource maps.
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+
+<AddedIn version="4.0" />
+
+System context maps help teams understand how systems fit together across an architecture.
+
+They give users a high-level view of all systems, the actors that interact with them, and the relationships between systems. From there, users can drill into a specific system to see the resources that make it up, including APIs, services, messages, data stores, and flows.
+
+## Start with the system context map
+
+The global system context map shows your systems and how they relate to each other.
+
+Use this view when you want to answer questions like:
+
+- What systems exist in this architecture?
+- Which systems depend on each other?
+- Which people or roles interact with these systems?
+- Where should I drill in for more detail?
+
+![System context map showing systems, actors, and relationships](./img/system-context-map.png)
+
+You can open the global system context map at:
+
+```txt
+/visualiser/system-context-map
+```
+
+## Drill into a system
+
+After users understand the high-level context, they can click into a system and view its resource diagram.
+
+The resource diagram shows the detailed architecture inside that system. For example, a payment processing system can show the APIs, workers, commands, events, and data stores that work together to process payments.
+
+![System resource map showing APIs, messages, services, and data stores inside a system](./img/system-resource-map.png)
+
+You can open a system resource diagram at:
+
+```txt
+/visualiser/systems/{system-id}/{version}
+```
+
+For example:
+
+```txt
+/visualiser/systems/search-system/1.0.0
+```
+
+## High-level to detailed architecture
+
+The goal of systems is to let users move through your architecture at the right level of detail:
+
+- Start with a high-level context map to understand the systems and relationships.
+- Select a system to understand what it owns and depends on.
+- Drill into the resources inside that system to inspect APIs, messages, services, data stores, and flows.
+
+This gives teams a path from architecture overview to implementation detail without forcing every user to start at the lowest level.

package/dist/docs/development/guides/systems/06-reference.md

@@ -0,0 +1,329 @@
+---
+sidebar_position: 6
+keywords:
+- EventCatalog systems
+- System frontmatter
+sidebar_label: Reference
+title: Systems reference
+description: Frontmatter fields, paths, and routes for systems in EventCatalog.
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+
+<AddedIn version="4.0" />
+
+This page lists the fields, paths, and routes supported by systems.
+
+## Paths
+
+Systems can be created at the root of your catalog:
+
+```txt
+/systems/{System Name}/index.mdx
+```
+
+Systems can also be created inside domains:
+
+```txt
+/domains/{Domain Name}/systems/{System Name}/index.mdx
+```
+
+Versioned systems use the same versioning pattern as other EventCatalog resources:
+
+```txt
+/systems/{System Name}/versioned/{version}/index.mdx
+/domains/{Domain Name}/systems/{System Name}/versioned/{version}/index.mdx
+```
+
+## Routes
+
+| Route | Description |
+|-------|-------------|
+| `/docs/systems/{system-id}/{version}` | System documentation page. |
+| `/visualiser/systems/{system-id}/{version}` | Resource diagram for one system. |
+| `/visualiser/systems/{system-id}/{version}/context` | Context diagram for one system. |
+| `/visualiser/system-context-map` | Global system context map. |
+
+## Required fields
+
+### `id` {#id}
+
+- Type: `string`
+
+Unique id of the system. EventCatalog uses this for URLs and resource references.
+
+```md title="Example"
+---
+id: checkout-system
+---
+```
+
+### `name` {#name}
+
+- Type: `string`
+
+Display name of the system.
+
+```md title="Example"
+---
+name: Checkout System
+---
+```
+
+### `version` {#version}
+
+- Type: `string`
+
+Version of the system documentation.
+
+```md title="Example"
+---
+version: 1.0.0
+---
+```
+
+## Optional fields
+
+### `summary` {#summary}
+
+- Type: `string`
+
+Short summary of what the system does.
+
+```md title="Example"
+---
+summary: Handles checkout, payment authorization, and order submission.
+---
+```
+
+### `owners` {#owners}
+
+- Type: `array`
+
+An array of team or user ids that own the system.
+
+```md title="Example"
+---
+owners:
+  - checkout-platform
+---
+```
+
+### `scope` {#scope}
+
+- Type: `internal` or `external`
+
+Whether the system is owned by your organization or is an external system. Defaults to `internal`.
+
+```md title="Example"
+---
+scope: external
+---
+```
+
+### `services` {#services}
+
+- Type: `array`
+
+Services that belong to the system.
+
+```md title="Example"
+---
+services:
+  - id: checkout-api
+    version: 1.0.0
+---
+```
+
+### `flows` {#flows}
+
+- Type: `array`
+
+Flows that belong to the system.
+
+```md title="Example"
+---
+flows:
+  - id: checkout-flow
+    version: 1.0.0
+---
+```
+
+### `entities` {#entities}
+
+- Type: `array`
+
+Entities that belong to the system.
+
+```md title="Example"
+---
+entities:
+  - id: order
+    version: 1.0.0
+---
+```
+
+### `containers` {#containers}
+
+- Type: `array`
+
+Containers or data stores that belong to the system.
+
+```md title="Example"
+---
+containers:
+  - id: checkout-database
+    version: 1.0.0
+---
+```
+
+### `relationships` {#relationships}
+
+- Type: `array`
+
+Other systems this system relates to.
+
+```md title="Example"
+---
+relationships:
+  - id: promotion-system
+    version: 1.0.0
+    label: calculates discounts via
+---
+```
+
+### `actors` {#actors}
+
+- Type: `array`
+
+People, roles, or external actors that interact with the system.
+
+```md title="Example"
+---
+actors:
+  - id: shopper
+    name: Shopper
+    label: adds items and checks out
+    direction: inbound
+---
+```
+
+### `badges` {#badges}
+
+- Type: `array`
+
+Badges rendered on the system page.
+
+```md title="Example"
+---
+badges:
+  - content: Critical
+    backgroundColor: red
+    textColor: red
+---
+```
+
+### `repository` {#repository}
+
+- Type: `object`
+
+Repository metadata for the system.
+
+```md title="Example"
+---
+repository:
+  language: TypeScript
+  url: https://github.com/acme/checkout
+---
+```
+
+### `diagrams` {#diagrams}
+
+- Type: `array`
+
+Diagrams associated with the system.
+
+```md title="Example"
+---
+diagrams:
+  - id: checkout-deployment
+    version: 1.0.0
+---
+```
+
+### `attachments` {#attachments}
+
+- Type: `array`
+
+External links or supporting documents attached to the system.
+
+```md title="Example"
+---
+attachments:
+  - title: Checkout runbook
+    url: https://runbooks.example.com/checkout
+    type: runbook
+---
+```
+
+## Resource pointers
+
+Systems reference resources using `id` and optional `version`.
+
+```md
+---
+services:
+  - id: cart-api
+    version: 1.0.0
+containers:
+  - id: cart-database
+flows:
+  - id: checkout-flow
+entities:
+  - id: cart
+---
+```
+
+If `version` is omitted, EventCatalog uses the latest version.
+
+## Relationship fields
+
+Relationships connect one system to another system.
+
+```md
+---
+relationships:
+  - id: promotion-system
+    version: 1.0.0
+    label: calculates discounts via
+---
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | `string` | Target system id. |
+| `version` | `string` | Target system version. Optional. Defaults to latest. |
+| `label` | `string` | Text shown on the relationship edge. |
+
+Relationships are one-directional. Define the relationship on the system that owns the source of the relationship.
+
+## Actor fields
+
+Actors are people, roles, or external participants that interact with a system.
+
+```md
+---
+actors:
+  - id: shopper
+    name: Shopper
+    label: adds items and checks out
+    direction: inbound
+---
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | `string` | Unique actor id. |
+| `name` | `string` | Display name shown in diagrams. Optional. |
+| `label` | `string` | Text shown on the actor relationship edge. Optional. |
+| `direction` | `inbound` or `outbound` | `inbound` means actor to system. `outbound` means system to actor. Defaults to `inbound`. |

package/dist/docs/development/guides/{messages/queries → systems}/_category_.json

@@ -1,11 +1,11 @@
 {
-  "label": "Queries",
-  "position": 4,
+  "label": "Systems",
+  "position": 2,
   "collapsible": true,
   "collapsed": true,
   "link": {
     "type": "generated-index",
-    "slug": "/queries",
-    "description": "A collection of guides to help you understand queries and how they work with EventCatalog."
+    "slug": "/systems",
+    "description": "A collection of guides to help you understand systems and how they work with EventCatalog."
   }
-}
+}

package/dist/docs/development/license-keys/_category_.json

@@ -7,6 +7,6 @@
     "type": "generated-index",
     "slug": "development/license-keys",
     "title": "License Keys",
-    "description": "How to get and use license keys for EventCatalog plans (Starter, Scale) and integrations (OpenAPI, AsyncAPI, and more)."
+    "description": "How to get and use license keys for EventCatalog Scale, Enterprise, and integrations (OpenAPI, AsyncAPI, and more)."
   }
 }

package/dist/docs/development/license-keys/integrations.md

@@ -8,34 +8,45 @@ keywords:
 - asyncapi
 sidebar_label: Integrations
 title: Getting a license key for integrations
-description: How to activate EventCatalog integrations (OpenAPI, AsyncAPI, Backstage, and more) and get your license key.
+description: How to use EventCatalog Scale with integrations such as OpenAPI, AsyncAPI, Backstage, and more.
 ---
 
 EventCatalog integrations (sometimes called plugins) let you generate your catalog from sources you already have — OpenAPI specs, AsyncAPI documents, Backstage, federated catalogs, and more. You can see the full list on the [integrations page](/integrations).
 
-Each integration is licensed individually and comes with a **14 day free trial**. Activate one from your [integrations dashboard](https://eventcatalog.cloud/dashboard/integrations) — see the [Quick start in the overview](/docs/development/license-keys/overview#quick-start) for the full step-by-step.
+Official integrations are included with EventCatalog Scale. Start Scale from your [EventCatalog Cloud dashboard](https://eventcatalog.cloud/dashboard) and use your Scale license key to unlock supported integrations in your catalog.
 
 ![Pick your integrations in EventCatalog Cloud](./images/pick-your-integraions.png)
 
-Once activated, your license key for the integration appears on your [API keys page](https://eventcatalog.cloud/dashboard/api-keys):
+Once Scale is active, your license key appears on your [API keys page](https://eventcatalog.cloud/dashboard/api-keys):
 
 ![Your license keys in the EventCatalog Cloud API keys dashboard](./images/api-keys-dashboard.png)
 
-## Adding your license key to your catalog
+## Adding your Scale key to your catalog
 
-Copy the license key from your dashboard into your `.env` file. Each integration uses its own environment variable — the exact name is shown next to the key on your dashboard and in the integration's own documentation. For example:
+Copy your Scale license key from your dashboard into your `.env` file:
 
 ```bash title=".env"
-EVENTCATALOG_OPENAPI_LICENSE_KEY=your-license-key-here
-EVENTCATALOG_ASYNCAPI_LICENSE_KEY=your-license-key-here
+EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key-here
 ```
 
 Then configure the integration in your `eventcatalog.config.js` as described in the [integration's documentation](/integrations).
 
+:::info Using plugin API keys?
+If you already have older plugin-specific API keys, you can still use them with the environment variables shown in each integration's documentation.
+
+For example, the OpenAPI plugin supports:
+
+```bash title=".env"
+EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key-here
+```
+
+For new projects, use `EVENTCATALOG_SCALE_LICENSE_KEY`.
+:::
+
 ## Trying multiple integrations
 
-You can activate as many integrations as you want from your [integrations dashboard](https://eventcatalog.cloud/dashboard/integrations). Each one has its own 14 day trial and its own license key.
+Scale includes all official integrations, so you can configure multiple integrations in the same catalog with the same Scale license key.
 
 ## Need more time?
 
-If 14 days isn't enough to evaluate an integration in your environment, email us at `hello@eventcatalog.dev` and we'll extend your trial.
+If 30 days isn't enough to evaluate Scale and integrations in your environment, email us at `hello@eventcatalog.dev` and we'll extend your trial.

package/dist/docs/development/license-keys/overview.md

@@ -9,7 +9,7 @@ title: License Keys Overview
 description: Learn how license keys work in EventCatalog, how to get a free trial, and where to find your keys.
 ---
 
-EventCatalog is open source with a [community edition and a commercial edition](/pricing). The commercial editions (Starter, Scale, Enterprise) and the [integrations](/integrations) (OpenAPI, AsyncAPI, Backstage, and others) are unlocked using **license keys**.
+EventCatalog is open source with a [community edition and commercial plans](/pricing). EventCatalog Scale, Enterprise, and commercial integrations are unlocked using **license keys**.
 
 If you are using the community edition, you don't need a license key and can skip this section.
 
@@ -21,8 +21,8 @@ You can then add those keys to your `.env` file (or set them as environment vari
 
 ## Free trials
 
-:::tip 14 day free trials
-Every plan and every integration comes with a **14 day free trial**. No payment is required to start one — just sign in to [EventCatalog Cloud](https://eventcatalog.cloud) and activate what you want to try.
+:::tip 30-day free trials
+Every plan and every integration comes with a **30-day free trial**. No payment is required to start one — just sign in to [EventCatalog Cloud](https://eventcatalog.cloud) and activate what you want to try.
 
 Need longer to evaluate? Email us at `hello@eventcatalog.dev` and we'll happily extend your trial.
 :::
@@ -30,23 +30,12 @@ Need longer to evaluate? Email us at `hello@eventcatalog.dev` and we'll happily
 ## Quick start
 
 1. Create an account at [eventcatalog.cloud](https://eventcatalog.cloud).
-2. From your [dashboard](https://eventcatalog.cloud/dashboard), pick what you need:
-   - [Pick your plan](https://eventcatalog.cloud/dashboard) (Starter or Scale) — see [Starting a plan](/docs/development/license-keys/plans).
-
-     ![Pick your plan in EventCatalog Cloud](./images/pick-your-plan.png)
-
-   - [Pick your integrations](https://eventcatalog.cloud/dashboard/integrations) (OpenAPI, AsyncAPI, etc.) — see [Getting integration keys](/docs/development/license-keys/integrations).
-
-     ![Pick your integrations in EventCatalog Cloud](./images/pick-your-integraions.png)
-
-3. Copy your license keys from the [API keys page](https://eventcatalog.cloud/dashboard/api-keys) into your `.env` file.
-
-   ![Your license keys in the EventCatalog Cloud API keys dashboard](./images/api-keys-dashboard.png)
-
-4. Run your catalog — your commercial features are now unlocked.
+1. Start your [EventCatalog Scale Trial](https://eventcatalog.cloud/dashboard)
+1. Pick your [integrations](https://eventcatalog.cloud/dashboard/integrations)
+4. Run your catalog with integrations and commercial features are now unlocked.
 
 ## Next steps
 
-- [Starting a Starter or Scale plan](/docs/development/license-keys/plans)
+- [Starting an EventCatalog Scale plan](/docs/development/license-keys/plans)
 - [Getting license keys for integrations](/docs/development/license-keys/integrations)
 - [How license validation works (online and offline)](/docs/development/license-keys/license-validation)

package/dist/docs/development/license-keys/plans.md

@@ -2,29 +2,22 @@
 sidebar_position: 2
 keywords:
 - licenses
-- starter
 - scale
 - plans
-sidebar_label: Starter & Scale Plans
-title: Getting a license key for Starter or Scale
-description: How to start a Starter or Scale plan in EventCatalog Cloud and get your license key.
+sidebar_label: Scale Plan
+title: Getting a license key for EventCatalog Scale
+description: How to start an EventCatalog Scale plan in EventCatalog Cloud and get your license key.
 ---
 
-EventCatalog offers two commercial plans you can self-serve from [EventCatalog Cloud](https://eventcatalog.cloud):
+EventCatalog Scale is the self-serve commercial plan for teams that need automation, integrations, governance, and a living architecture catalog that stays in sync with code, specs, teams, and tools.
 
-- **Starter** — for small teams getting started with commercial features.
-- **Scale** — for larger teams that need the full set of advanced capabilities.
-
-See the [pricing page](/pricing) for a full breakdown of what each plan includes.
+See the [pricing page](/pricing) for a full breakdown of what Scale includes.
 
 ## Starting a plan
 
-1. Sign in to [EventCatalog Cloud](https://eventcatalog.cloud). If you don't have an account yet, sign up — it's free.
+1. Sign in to [EventCatalog Cloud](https://eventcatalog.cloud).
 2. Go to your [dashboard](https://eventcatalog.cloud/dashboard).
-3. Choose **Starter** or **Scale** and start your plan. Every plan comes with a **14 day free trial**, so you can try it before you commit.
-
-   ![Pick your plan in EventCatalog Cloud](./images/pick-your-plan.png)
-
+3. Start your Scale Trial License.
 4. Once the plan is active, head to your [API keys page](https://eventcatalog.cloud/dashboard/api-keys) to find your license key.
 
    ![Your license keys in the EventCatalog Cloud API keys dashboard](./images/api-keys-dashboard.png)
@@ -34,16 +27,14 @@ See the [pricing page](/pricing) for a full breakdown of what each plan includes
 Copy the license key from your dashboard into your `.env` file:
 
 ```bash title=".env"
-EVENTCATALOG_STARTER_LICENSE_KEY=your-license-key-here
-# or for Scale
 EVENTCATALOG_SCALE_LICENSE_KEY=your-license-key-here
 ```
 
-Then start EventCatalog as normal. The commercial features for your plan will be unlocked automatically.
+Then start EventCatalog as normal. Scale features will be unlocked automatically.
 
 ## Need more time?
 
-The default trial is 14 days. If you need longer to evaluate, email us at `hello@eventcatalog.dev` and we'll extend it for you.
+The default trial is 30 days. If you need longer to evaluate, email us at `hello@eventcatalog.dev` and we'll extend it for you.
 
 ## Enterprise
 

package/dist/docs/development/upgrading/v2.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 keywords:
 - Upgrade EventCatalog
 sidebar_label: v2 
@@ -66,4 +66,3 @@ The build output has changed from v1 from being `out` directory to `dist` direct
 ## Any other issues?
 
 If you have any issues or questions please [feel free to reach us on Discord](https://discord.com/invite/3rjaZMmrAm).
-