@eventcatalog/core 4.10.13 → 4.10.14

package/dist/docs/cli/domains.md

@@ -1,280 +0,0 @@
----
-id: cli-domains
-title: Domains
-sidebar_label: Domains
-sidebar_position: 6
----
-
-# Domains CLI Commands
-
-Manage domains in your EventCatalog from the command line.
-
-## getDomain
-
-Returns a domain from EventCatalog by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the domain to retrieve |
-| version | string | No | Specific version to retrieve |
-
-**Examples:**
-
-```bash
-# Get the latest domain
-npx @eventcatalog/cli getDomain "Orders"
-
-# Get a specific version
-npx @eventcatalog/cli getDomain "Orders" "1.0.0"
-```
-
----
-
-## getDomains
-
-Returns all domains from EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| options | json | No | Options: {latestOnly?} |
-
-**Examples:**
-
-```bash
-# Get all domains
-npx @eventcatalog/cli getDomains
-```
-
----
-
-## writeDomain
-
-Writes a domain to EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domain | json | Yes | Domain object with id, name, version, and markdown |
-| options | json | No | Options: {path?, override?, versionExistingContent?} |
-
-
-
----
-
-## rmDomain
-
-Removes a domain by its path
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| path | string | Yes | Path to the domain |
-
-**Examples:**
-
-```bash
-# Remove a domain
-npx @eventcatalog/cli rmDomain "/Orders"
-```
-
----
-
-## rmDomainById
-
-Removes a domain by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the domain to remove |
-| version | string | No | Specific version to remove |
-
-**Examples:**
-
-```bash
-# Remove a domain
-npx @eventcatalog/cli rmDomainById "Orders"
-```
-
----
-
-## versionDomain
-
-Moves the current domain to a versioned directory
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the domain to version |
-
-**Examples:**
-
-```bash
-# Version a domain
-npx @eventcatalog/cli versionDomain "Orders"
-```
-
----
-
-## addFileToDomain
-
-Adds a file to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the domain |
-| file | json | Yes | File object: {content, fileName} |
-| version | string | No | Specific version |
-
-
-
----
-
-## addServiceToDomain
-
-Adds a service to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the domain |
-| service | json | Yes | Service reference: {id, version} |
-| domainVersion | string | No | Specific domain version |
-
-
-
----
-
-## addSubDomainToDomain
-
-Adds a subdomain to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the parent domain |
-| subDomain | json | Yes | Subdomain reference: {id, version} |
-| domainVersion | string | No | Specific domain version |
-
-
-
----
-
-## addEntityToDomain
-
-Adds an entity to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the domain |
-| entity | json | Yes | Entity reference: {id, version} |
-| domainVersion | string | No | Specific domain version |
-
-
-
----
-
-## addEventToDomain
-
-Adds an event relationship to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the domain |
-| direction | string | Yes | Direction: "sends" or "receives" |
-| event | json | Yes | Event reference: {id, version} |
-| domainVersion | string | No | Specific domain version |
-
-
-
----
-
-## addCommandToDomain
-
-Adds a command relationship to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the domain |
-| direction | string | Yes | Direction: "sends" or "receives" |
-| command | json | Yes | Command reference: {id, version} |
-| domainVersion | string | No | Specific domain version |
-
-
-
----
-
-## addQueryToDomain
-
-Adds a query relationship to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the domain |
-| direction | string | Yes | Direction: "sends" or "receives" |
-| query | json | Yes | Query reference: {id, version} |
-| domainVersion | string | No | Specific domain version |
-
-
-
----
-
-## addUbiquitousLanguageToDomain
-
-Adds ubiquitous language definitions to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the domain |
-| dictionary | json | Yes | Array of {term, definition} objects |
-| domainVersion | string | No | Specific domain version |
-
-
-
----
-
-## getUbiquitousLanguageFromDomain
-
-Gets ubiquitous language definitions from a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the domain |
-| domainVersion | string | No | Specific domain version |
-
-**Examples:**
-
-```bash
-# Get ubiquitous language
-npx @eventcatalog/cli getUbiquitousLanguageFromDomain "Orders"
-```
-
----
-
-## domainHasVersion
-
-Checks if a specific version of a domain exists
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the domain |
-| version | string | Yes | Version to check |
-
-**Examples:**
-
-```bash
-# Check if version exists
-npx @eventcatalog/cli domainHasVersion "Orders" "1.0.0"
-```
-
----

package/dist/docs/cli/entities.md

@@ -1,138 +0,0 @@
----
-id: cli-entities
-title: Entities
-sidebar_label: Entities
-sidebar_position: 11
----
-
-# Entities CLI Commands
-
-Manage entities in your EventCatalog from the command line.
-
-## getEntity
-
-Returns an entity from EventCatalog by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the entity to retrieve |
-| version | string | No | Specific version to retrieve |
-
-**Examples:**
-
-```bash
-# Get the latest entity
-npx @eventcatalog/cli getEntity "Order"
-
-# Get a specific version
-npx @eventcatalog/cli getEntity "Order" "1.0.0"
-```
-
----
-
-## getEntities
-
-Returns all entities from EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| options | json | No | Options: {latestOnly?} |
-
-**Examples:**
-
-```bash
-# Get all entities
-npx @eventcatalog/cli getEntities
-```
-
----
-
-## writeEntity
-
-Writes an entity to EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| entity | json | Yes | Entity object with id, name, version, and markdown |
-| options | json | No | Options: {path?, override?, versionExistingContent?} |
-
-
-
----
-
-## rmEntity
-
-Removes an entity by its path
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| path | string | Yes | Path to the entity |
-
-**Examples:**
-
-```bash
-# Remove an entity
-npx @eventcatalog/cli rmEntity "/Order"
-```
-
----
-
-## rmEntityById
-
-Removes an entity by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the entity to remove |
-| version | string | No | Specific version to remove |
-
-**Examples:**
-
-```bash
-# Remove an entity
-npx @eventcatalog/cli rmEntityById "Order"
-```
-
----
-
-## versionEntity
-
-Moves the current entity to a versioned directory
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the entity to version |
-
-**Examples:**
-
-```bash
-# Version an entity
-npx @eventcatalog/cli versionEntity "Order"
-```
-
----
-
-## entityHasVersion
-
-Checks if a specific version of an entity exists
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the entity |
-| version | string | Yes | Version to check |
-
-**Examples:**
-
-```bash
-# Check if version exists
-npx @eventcatalog/cli entityHasVersion "Order" "1.0.0"
-```
-
----

package/dist/docs/cli/events.md

@@ -1,186 +0,0 @@
----
-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

@@ -1,27 +0,0 @@
----
-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

@@ -1,24 +0,0 @@
----
-id: cli-governance
-title: Governance
-sidebar_label: Governance
-sidebar_position: 19
----
-
-# 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/messages.md

@@ -1,69 +0,0 @@
----
-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"
-```
-
----