@eventcatalog/core 4.10.13 → 4.10.15

package/dist/docs/cli/channels.md

@@ -1,180 +0,0 @@
----
-id: cli-channels
-title: Channels
-sidebar_label: Channels
-sidebar_position: 7
----
-
-# Channels CLI Commands
-
-Manage channels in your EventCatalog from the command line.
-
-## getChannel
-
-Returns a channel from EventCatalog by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the channel to retrieve |
-| version | string | No | Specific version to retrieve |
-
-**Examples:**
-
-```bash
-# Get the latest channel
-npx @eventcatalog/cli getChannel "orders.events"
-
-# Get a specific version
-npx @eventcatalog/cli getChannel "orders.events" "1.0.0"
-```
-
----
-
-## getChannels
-
-Returns all channels from EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| options | json | No | Options: {latestOnly?} |
-
-**Examples:**
-
-```bash
-# Get all channels
-npx @eventcatalog/cli getChannels
-```
-
----
-
-## writeChannel
-
-Writes a channel to EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| channel | json | Yes | Channel object with id, name, version, and markdown |
-| options | json | No | Options: {path?, override?} |
-
-
-
----
-
-## rmChannel
-
-Removes a channel by its path
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| path | string | Yes | Path to the channel |
-
-**Examples:**
-
-```bash
-# Remove a channel
-npx @eventcatalog/cli rmChannel "/orders.events"
-```
-
----
-
-## rmChannelById
-
-Removes a channel by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the channel to remove |
-| version | string | No | Specific version to remove |
-
-**Examples:**
-
-```bash
-# Remove a channel
-npx @eventcatalog/cli rmChannelById "orders.events"
-```
-
----
-
-## versionChannel
-
-Moves the current channel to a versioned directory
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the channel to version |
-
-**Examples:**
-
-```bash
-# Version a channel
-npx @eventcatalog/cli versionChannel "orders.events"
-```
-
----
-
-## addEventToChannel
-
-Adds an event to a channel
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| channelId | string | Yes | The ID of the channel |
-| event | json | Yes | Event reference: {id, version, parameters?} |
-
-
-
----
-
-## addCommandToChannel
-
-Adds a command to a channel
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| channelId | string | Yes | The ID of the channel |
-| command | json | Yes | Command reference: {id, version, parameters?} |
-
-
-
----
-
-## addQueryToChannel
-
-Adds a query to a channel
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| channelId | string | Yes | The ID of the channel |
-| query | json | Yes | Query reference: {id, version, parameters?} |
-
-
-
----
-
-## channelHasVersion
-
-Checks if a specific version of a channel exists
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the channel |
-| version | string | Yes | Version to check |
-
-**Examples:**
-
-```bash
-# Check if version exists
-npx @eventcatalog/cli channelHasVersion "orders.events" "1.0.0"
-```
-
----

package/dist/docs/cli/commands.md

@@ -1,183 +0,0 @@
----
-id: cli-commands
-title: Commands
-sidebar_label: Commands
-sidebar_position: 3
----
-
-# Commands CLI Commands
-
-Manage commands in your EventCatalog from the command line.
-
-## getCommand
-
-Returns a command from EventCatalog by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the command to retrieve |
-| version | string | No | Specific version to retrieve (supports semver) |
-
-**Examples:**
-
-```bash
-# Get the latest command
-npx @eventcatalog/cli getCommand "CreateOrder"
-
-# Get a specific version
-npx @eventcatalog/cli getCommand "CreateOrder" "1.0.0"
-```
-
----
-
-## getCommands
-
-Returns all commands from EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| options | json | No | Options: {latestOnly?, attachSchema?} |
-
-**Examples:**
-
-```bash
-# Get all commands
-npx @eventcatalog/cli getCommands
-```
-
----
-
-## writeCommand
-
-Writes a command to EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| command | json | Yes | Command object with id, name, version, and markdown |
-| options | json | No | Options: {path?, override?, versionExistingContent?} |
-
-
-
----
-
-## writeCommandToService
-
-Writes a command to a specific service
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| command | json | Yes | Command object |
-| service | json | Yes | Service reference: {id, version?} |
-| options | json | No | Options: {path?, format?, override?} |
-
-
-
----
-
-## rmCommand
-
-Removes a command by its path
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| path | string | Yes | Path to the command |
-
-**Examples:**
-
-```bash
-# Remove a command
-npx @eventcatalog/cli rmCommand "/CreateOrder"
-```
-
----
-
-## rmCommandById
-
-Removes a command by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the command to remove |
-| version | string | No | Specific version to remove |
-
-**Examples:**
-
-```bash
-# Remove a command
-npx @eventcatalog/cli rmCommandById "CreateOrder"
-```
-
----
-
-## versionCommand
-
-Moves the current command to a versioned directory
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the command to version |
-
-**Examples:**
-
-```bash
-# Version a command
-npx @eventcatalog/cli versionCommand "CreateOrder"
-```
-
----
-
-## addFileToCommand
-
-Adds a file to a command
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the command |
-| file | json | Yes | File object: {content, fileName} |
-| version | string | No | Specific version |
-
-
-
----
-
-## addSchemaToCommand
-
-Adds a schema to a command
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the command |
-| schema | json | Yes | Schema object: {schema, fileName} |
-| version | string | No | Specific version |
-
-
-
----
-
-## commandHasVersion
-
-Checks if a specific version of a command exists
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the command |
-| version | string | Yes | Version to check |
-
-**Examples:**
-
-```bash
-# Check if version exists
-npx @eventcatalog/cli commandHasVersion "CreateOrder" "1.0.0"
-```
-
----

package/dist/docs/cli/custom-docs.md

@@ -1,78 +0,0 @@
----
-id: cli-custom-docs
-title: Custom Docs
-sidebar_label: Custom Docs
-sidebar_position: 10
----
-
-# Custom Docs CLI Commands
-
-Manage custom docs in your EventCatalog from the command line.
-
-## getCustomDoc
-
-Returns a custom doc from EventCatalog by its path
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| path | string | Yes | Path to the custom doc |
-
-**Examples:**
-
-```bash
-# Get a custom doc
-npx @eventcatalog/cli getCustomDoc "/getting-started"
-```
-
----
-
-## getCustomDocs
-
-Returns all custom docs from EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| options | json | No | Options: {path?} |
-
-**Examples:**
-
-```bash
-# Get all custom docs
-npx @eventcatalog/cli getCustomDocs
-```
-
----
-
-## writeCustomDoc
-
-Writes a custom doc to EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| customDoc | json | Yes | Custom doc object with id, title, and markdown |
-| options | json | No | Options: {path?, override?} |
-
-
-
----
-
-## rmCustomDoc
-
-Removes a custom doc by its path
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| path | string | Yes | Path to the custom doc to remove |
-
-**Examples:**
-
-```bash
-# Remove a custom doc
-npx @eventcatalog/cli rmCustomDoc "/getting-started"
-```
-
----

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

@@ -1,177 +0,0 @@
----
-id: cli-data-products
-title: Data Products
-sidebar_label: Data Products
-sidebar_position: 13
----
-
-# Data Products CLI Commands
-
-Manage data products in your EventCatalog from the command line.
-
-## getDataProduct
-
-Returns a data product from EventCatalog by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the data product to retrieve |
-| version | string | No | Specific version to retrieve |
-
-**Examples:**
-
-```bash
-# Get the latest data product
-npx @eventcatalog/cli getDataProduct "customer-360"
-
-# Get a specific version
-npx @eventcatalog/cli getDataProduct "customer-360" "1.0.0"
-```
-
----
-
-## getDataProducts
-
-Returns all data products from EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| options | json | No | Options: {latestOnly?} |
-
-**Examples:**
-
-```bash
-# Get all data products
-npx @eventcatalog/cli getDataProducts
-```
-
----
-
-## writeDataProduct
-
-Writes a data product to EventCatalog
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| options | json | No | Options: {path?, override?, versionExistingContent?} |
-
-
-
----
-
-## writeDataProductToDomain
-
-Writes a data product to a specific domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| dataProduct | json | Yes | Data product object |
-| domain | json | Yes | Domain reference: {id, version?} |
-| options | json | No | Options |
-
-
-
----
-
-## rmDataProduct
-
-Removes a data product by its path
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| path | string | Yes | Path to the data product |
-
-**Examples:**
-
-```bash
-# Remove a data product
-npx @eventcatalog/cli rmDataProduct "/customer-360"
-```
-
----
-
-## rmDataProductById
-
-Removes a data product by its ID
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the data product to remove |
-| version | string | No | Specific version to remove |
-
-**Examples:**
-
-```bash
-# Remove a data product
-npx @eventcatalog/cli rmDataProductById "customer-360"
-```
-
----
-
-## versionDataProduct
-
-Moves the current data product to a versioned directory
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the data product to version |
-
-**Examples:**
-
-```bash
-# Version a data product
-npx @eventcatalog/cli versionDataProduct "customer-360"
-```
-
----
-
-## addFileToDataProduct
-
-Adds a file to a data product
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the data product |
-| file | json | Yes | File object: {content, fileName} |
-| version | string | No | Specific version |
-
-
-
----
-
-## addDataProductToDomain
-
-Adds a data product reference to a domain
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| domainId | string | Yes | The ID of the domain |
-| dataProduct | json | Yes | Data product reference: {id, version} |
-| domainVersion | string | No | Specific domain version |
-
-
-
----
-
-## dataProductHasVersion
-
-Checks if a specific version of a data product exists
-
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the data product |
-| version | string | Yes | Version to check |
-
-
-
----