@eventcatalog/core 3.34.0 → 3.35.1

package/dist/docs/cli/data-stores.md

@@ -0,0 +1,166 @@
+---
+id: cli-data-stores
+title: Data Stores
+sidebar_label: Data Stores
+sidebar_position: 12
+---
+
+# Data Stores CLI Commands
+
+Manage data stores in your EventCatalog from the command line.
+
+## getDataStore
+
+Returns a data store from EventCatalog by its ID
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the data store to retrieve |
+| version | string | No | Specific version to retrieve |
+
+**Examples:**
+
+```bash
+# Get the latest data store
+npx @eventcatalog/cli getDataStore "orders-db"
+
+# Get a specific version
+npx @eventcatalog/cli getDataStore "orders-db" "1.0.0"
+```
+
+---
+
+## getDataStores
+
+Returns all data stores from EventCatalog
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| options | json | No | Options: {latestOnly?} |
+
+**Examples:**
+
+```bash
+# Get all data stores
+npx @eventcatalog/cli getDataStores
+```
+
+---
+
+## writeDataStore
+
+Writes a data store to EventCatalog
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| options | json | No | Options: {path?, override?, versionExistingContent?} |
+
+
+
+---
+
+## writeDataStoreToService
+
+Writes a data store to a specific service
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| dataStore | json | Yes | Data store object |
+| service | json | Yes | Service reference: {id, version?} |
+
+
+
+---
+
+## rmDataStore
+
+Removes a data store by its path
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| path | string | Yes | Path to the data store |
+
+**Examples:**
+
+```bash
+# Remove a data store
+npx @eventcatalog/cli rmDataStore "/orders-db"
+```
+
+---
+
+## rmDataStoreById
+
+Removes a data store by its ID
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the data store to remove |
+| version | string | No | Specific version to remove |
+
+**Examples:**
+
+```bash
+# Remove a data store
+npx @eventcatalog/cli rmDataStoreById "orders-db"
+```
+
+---
+
+## versionDataStore
+
+Moves the current data store to a versioned directory
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the data store to version |
+
+**Examples:**
+
+```bash
+# Version a data store
+npx @eventcatalog/cli versionDataStore "orders-db"
+```
+
+---
+
+## addFileToDataStore
+
+Adds a file to a data store
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the data store |
+| file | json | Yes | File object: {content, fileName} |
+| version | string | No | Specific version |
+
+
+
+---
+
+## dataStoreHasVersion
+
+Checks if a specific version of a data store exists
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the data store |
+| version | string | Yes | Version to check |
+
+**Examples:**
+
+```bash
+# Check if version exists
+npx @eventcatalog/cli dataStoreHasVersion "orders-db" "1.0.0"
+```
+
+---

package/dist/docs/cli/diagrams.md

@@ -0,0 +1,147 @@
+---
+id: cli-diagrams
+title: Diagrams
+sidebar_label: Diagrams
+sidebar_position: 14
+---
+
+# Diagrams CLI Commands
+
+Manage diagrams in your EventCatalog from the command line.
+
+## getDiagram
+
+Returns a diagram from EventCatalog by its ID
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the diagram to retrieve |
+| version | string | No | Specific version to retrieve |
+
+**Examples:**
+
+```bash
+# Get the latest diagram
+npx @eventcatalog/cli getDiagram "ArchitectureDiagram"
+
+# Get a specific version
+npx @eventcatalog/cli getDiagram "ArchitectureDiagram" "1.0.0"
+```
+
+---
+
+## getDiagrams
+
+Returns all diagrams from EventCatalog
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| options | json | No | Options: {latestOnly?} |
+
+**Examples:**
+
+```bash
+# Get all diagrams
+npx @eventcatalog/cli getDiagrams
+```
+
+---
+
+## writeDiagram
+
+Writes a diagram to EventCatalog
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| options | json | No | Options: {path?, override?, versionExistingContent?} |
+
+
+
+---
+
+## rmDiagram
+
+Removes a diagram by its path
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| path | string | Yes | Path to the diagram |
+
+**Examples:**
+
+```bash
+# Remove a diagram
+npx @eventcatalog/cli rmDiagram "/ArchitectureDiagram"
+```
+
+---
+
+## rmDiagramById
+
+Removes a diagram by its ID
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the diagram to remove |
+| version | string | No | Specific version to remove |
+
+**Examples:**
+
+```bash
+# Remove a diagram
+npx @eventcatalog/cli rmDiagramById "ArchitectureDiagram"
+```
+
+---
+
+## versionDiagram
+
+Moves the current diagram to a versioned directory
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the diagram to version |
+
+**Examples:**
+
+```bash
+# Version a diagram
+npx @eventcatalog/cli versionDiagram "ArchitectureDiagram"
+```
+
+---
+
+## addFileToDiagram
+
+Adds a file to a diagram
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the diagram |
+| file | json | Yes | File object: {content, fileName} |
+| version | string | No | Specific version |
+
+
+
+---
+
+## diagramHasVersion
+
+Checks if a specific version of a diagram exists
+
+**Arguments:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| id | string | Yes | The ID of the diagram |
+| version | string | Yes | Version to check |
+
+
+
+---

package/dist/docs/cli/domains.md

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

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