@eventcatalog/core 3.34.0 → 3.35.1

package/dist/docs/cli/events.md

@@ -0,0 +1,186 @@
+---
+id: cli-events
+title: Events
+sidebar_label: Events
+sidebar_position: 2
+---
+
+# Events CLI Commands
+
+Manage events in your EventCatalog from the command line.
+
+## getEvent
+
+Returns an event from EventCatalog by its ID
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the event to retrieve |
+| version | string | No | Specific version to retrieve (supports semver) |
+| options | json | No | Options object, e.g. {"attachSchema": true} |
+
+**Examples:**
+
+```bash
+# Get the latest version of an event
+npx @eventcatalog/cli getEvent "OrderCreated"
+
+# Get a specific version
+npx @eventcatalog/cli getEvent "OrderCreated" "1.0.0"
+```
+
+---
+
+## getEvents
+
+Returns all events from EventCatalog
+
+**Arguments:** None
+
+**Examples:**
+
+```bash
+# Get all events
+npx @eventcatalog/cli getEvents
+```
+
+---
+
+## writeEvent
+
+Writes an event to EventCatalog
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| event | json | Yes | Event object with id, name, version, and markdown |
+
+
+
+---
+
+## writeEventToService
+
+Writes an event to a specific service in EventCatalog
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| event | json | Yes | Event object with id, name, version, and markdown |
+| service | json | Yes | Service reference: {id, version?} |
+| options | json | No | Options: {path?, format?, override?} |
+
+
+
+---
+
+## rmEvent
+
+Removes an event by its path
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| path | string | Yes | Path to the event, e.g. /InventoryAdjusted |
+
+**Examples:**
+
+```bash
+# Remove an event by path
+npx @eventcatalog/cli rmEvent "/InventoryAdjusted"
+```
+
+---
+
+## rmEventById
+
+Removes an event by its ID
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the event to remove |
+| version | string | No | Specific version to remove |
+
+**Examples:**
+
+```bash
+# Remove latest version
+npx @eventcatalog/cli rmEventById "OrderCreated"
+
+# Remove specific version
+npx @eventcatalog/cli rmEventById "OrderCreated" "1.0.0"
+```
+
+---
+
+## versionEvent
+
+Moves the current event to a versioned directory
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the event to version |
+
+**Examples:**
+
+```bash
+# Version an event
+npx @eventcatalog/cli versionEvent "OrderCreated"
+```
+
+---
+
+## addFileToEvent
+
+Adds a file to an event
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the event |
+| file | json | Yes | File object: {content, fileName} |
+| version | string | No | Specific version to add file to |
+
+
+
+---
+
+## addSchemaToEvent
+
+Adds a schema file to an event
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the event |
+| schema | json | Yes | Schema object: {schema, fileName} |
+| version | string | No | Specific version to add schema to |
+
+
+
+---
+
+## eventHasVersion
+
+Checks if a specific version of an event exists
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the event |
+| version | string | Yes | Version to check (supports semver) |
+
+**Examples:**
+
+```bash
+# Check if version exists
+npx @eventcatalog/cli eventHasVersion "OrderCreated" "1.0.0"
+
+# Check with semver range
+npx @eventcatalog/cli eventHasVersion "OrderCreated" "1.0.x"
+```
+
+---

package/dist/docs/cli/export.md

@@ -0,0 +1,27 @@
+---
+id: cli-export
+title: Export
+sidebar_label: Export
+sidebar_position: 17
+---
+
+# Export CLI Commands
+
+Manage export in your EventCatalog from the command line.
+
+## export
+
+Export catalog resources to EventCatalog DSL (.ec) format
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| all | boolean | No | Export the entire catalog (all resource types) |
+| id | string | No | Resource ID (omit to export all of the given type) |
+| version | string | No | Resource version (defaults to latest) |
+| stdout | boolean | No | Print to stdout instead of writing a file |
+| output | string | No | Output file path (defaults to <id>.ec or catalog.ec) |
+
+
+
+---

package/dist/docs/cli/governance.md

@@ -0,0 +1,24 @@
+---
+id: cli-governance
+title: Governance
+sidebar_label: Governance
+sidebar_position: 20
+---
+
+# Governance CLI Commands
+
+Manage governance in your EventCatalog from the command line.
+
+## governanceCheck
+
+Compare the current catalog (or a target branch) against a base branch and evaluate governance rules defined in governance.yaml (or governance.yml)
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| --base | string | No | Base branch to compare against (default: main) |
+| --format | string | No | Output format: text or json (default: text) |
+
+
+
+---

package/dist/docs/cli/import.md

@@ -0,0 +1,26 @@
+---
+id: cli-import
+title: Import
+sidebar_label: Import
+sidebar_position: 18
+---
+
+# Import CLI Commands
+
+Manage import in your EventCatalog from the command line.
+
+## import
+
+Import EventCatalog DSL (.ec) files into catalog markdown files. Existing resources with the same version are overridden. Importing a newer version automatically moves the old version into the versioned/ folder.
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| files | string | No | One or more .ec file paths to import |
+| stdin | boolean | No | Read DSL from stdin |
+| dry-run | boolean | No | Preview resources without writing |
+| no-init | boolean | No | Skip catalog initialization prompt |
+
+
+
+---

package/dist/docs/cli/index.md

@@ -0,0 +1,121 @@
+---
+id: cli-overview
+title: CLI Reference
+sidebar_label: Overview
+sidebar_position: 1
+---
+
+# EventCatalog CLI
+
+The EventCatalog CLI allows you to interact with your EventCatalog directly from the command line. Execute any SDK function without writing code.
+
+## Installation
+
+You can run the CLI directly using `npx` without installing:
+
+```bash
+npx @eventcatalog/cli <function> [args...]
+```
+
+Or install globally:
+
+```bash
+npm install -g @eventcatalog/cli
+```
+
+Then use the `eventcatalog` command:
+
+```bash
+eventcatalog <function> [args...]
+```
+
+## Basic Usage
+
+### Specifying the catalog directory
+
+By default, the CLI uses the current directory. Use `--dir` to specify a different path:
+
+```bash
+npx @eventcatalog/cli --dir /path/to/catalog getEvents
+```
+
+### Listing available functions
+
+```bash
+npx @eventcatalog/cli list
+```
+
+### Getting help
+
+```bash
+npx @eventcatalog/cli --help
+```
+
+## Output Format
+
+All commands output JSON, making it easy to pipe to other tools like `jq`:
+
+```bash
+# Get all events and extract IDs
+npx @eventcatalog/cli getEvents | jq '.[].id'
+
+# Count total events
+npx @eventcatalog/cli getEvents | jq 'length'
+
+# Filter events by version
+npx @eventcatalog/cli getEvents | jq '.[] | select(.version == "1.0.0")'
+```
+
+## Argument Types
+
+Arguments are automatically parsed:
+
+| Type | Format | Example |
+|------|--------|---------|
+| String | Plain text or quoted | `"OrderCreated"` |
+| Number | Numeric value | `42` or `3.14` |
+| Boolean | `true` or `false` | `true` |
+| JSON Object | `'{...}'` | `'{"id":"test","version":"1.0.0"}'` |
+| JSON Array | `'[...]'` | `'["item1","item2"]'` |
+
+## Quick Examples
+
+### Read operations
+
+```bash
+# Get a specific event
+npx @eventcatalog/cli getEvent "OrderCreated"
+
+# Get all services (latest versions only)
+npx @eventcatalog/cli getServices '{"latestOnly":true}'
+
+# Check if a version exists
+npx @eventcatalog/cli eventHasVersion "OrderCreated" "1.0.0"
+```
+
+### Write operations
+
+```bash
+# Create a new event
+npx @eventcatalog/cli writeEvent '{"id":"OrderCreated","name":"Order Created","version":"1.0.0","markdown":"# Order Created Event"}'
+
+# Add a service to a domain
+npx @eventcatalog/cli addServiceToDomain "Orders" '{"id":"OrderService","version":"1.0.0"}'
+```
+
+### Delete operations
+
+```bash
+# Remove an event by ID
+npx @eventcatalog/cli rmEventById "OrderCreated"
+
+# Remove a specific version
+npx @eventcatalog/cli rmEventById "OrderCreated" "1.0.0"
+```
+
+### Version operations
+
+```bash
+# Version an event (move current to versioned directory)
+npx @eventcatalog/cli versionEvent "OrderCreated"
+```

package/dist/docs/cli/messages.md

@@ -0,0 +1,69 @@
+---
+id: cli-messages
+title: Messages
+sidebar_label: Messages
+sidebar_position: 15
+---
+
+# Messages CLI Commands
+
+Manage messages in your EventCatalog from the command line.
+
+## getProducersAndConsumersForMessage
+
+Returns the producers and consumers (services) for a given message
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the message |
+| version | string | No | Specific version |
+
+
+
+---
+
+## getConsumersOfSchema
+
+Returns services that consume a given schema
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| schemaPath | string | Yes | Path to the schema file |
+
+
+
+---
+
+## getProducersOfSchema
+
+Returns services that produce a given schema
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| schemaPath | string | Yes | Path to the schema file |
+
+
+
+---
+
+## getOwnersForResource
+
+Returns the owners (users/teams) for a given resource
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the resource |
+| version | string | No | Specific version |
+
+**Examples:**
+
+```bash
+# Get owners for a resource
+npx @eventcatalog/cli getOwnersForResource "OrderService"
+```
+
+---

package/dist/docs/cli/queries.md

@@ -0,0 +1,183 @@
+---
+id: cli-queries
+title: Queries
+sidebar_label: Queries
+sidebar_position: 4
+---
+
+# Queries CLI Commands
+
+Manage queries in your EventCatalog from the command line.
+
+## getQuery
+
+Returns a query from EventCatalog by its ID
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the query to retrieve |
+| version | string | No | Specific version to retrieve |
+
+**Examples:**
+
+```bash
+# Get the latest query
+npx @eventcatalog/cli getQuery "GetOrder"
+
+# Get a specific version
+npx @eventcatalog/cli getQuery "GetOrder" "1.0.0"
+```
+
+---
+
+## getQueries
+
+Returns all queries from EventCatalog
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| options | json | No | Options: {latestOnly?, attachSchema?} |
+
+**Examples:**
+
+```bash
+# Get all queries
+npx @eventcatalog/cli getQueries
+```
+
+---
+
+## writeQuery
+
+Writes a query to EventCatalog
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| query | json | Yes | Query object with id, name, version, and markdown |
+| options | json | No | Options: {path?, override?, versionExistingContent?} |
+
+
+
+---
+
+## writeQueryToService
+
+Writes a query to a specific service
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| query | json | Yes | Query object |
+| service | json | Yes | Service reference: {id, version?} |
+| options | json | No | Options: {path?, format?, override?} |
+
+
+
+---
+
+## rmQuery
+
+Removes a query by its path
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| path | string | Yes | Path to the query |
+
+**Examples:**
+
+```bash
+# Remove a query
+npx @eventcatalog/cli rmQuery "/GetOrder"
+```
+
+---
+
+## rmQueryById
+
+Removes a query by its ID
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the query to remove |
+| version | string | No | Specific version to remove |
+
+**Examples:**
+
+```bash
+# Remove a query
+npx @eventcatalog/cli rmQueryById "GetOrder"
+```
+
+---
+
+## versionQuery
+
+Moves the current query to a versioned directory
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the query to version |
+
+**Examples:**
+
+```bash
+# Version a query
+npx @eventcatalog/cli versionQuery "GetOrder"
+```
+
+---
+
+## addFileToQuery
+
+Adds a file to a query
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the query |
+| file | json | Yes | File object: {content, fileName} |
+| version | string | No | Specific version |
+
+
+
+---
+
+## addSchemaToQuery
+
+Adds a schema to a query
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the query |
+| schema | json | Yes | Schema object: {schema, fileName} |
+| version | string | No | Specific version |
+
+
+
+---
+
+## queryHasVersion
+
+Checks if a specific version of a query exists
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the query |
+| version | string | Yes | Version to check |
+
+**Examples:**
+
+```bash
+# Check if version exists
+npx @eventcatalog/cli queryHasVersion "GetOrder" "1.0.0"
+```
+
+---