npm - @eventcatalog/core - Versions diffs - 4.10.12 → 4.10.14 - Mend

@eventcatalog/core 4.10.12 → 4.10.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (179) hide show

package/dist/docs/cli/commands.md DELETED Viewed

@@ -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: &#123;latestOnly?, attachSchema?&#125; |
-**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: &#123;path?, override?, versionExistingContent?&#125; |
----
-## writeCommandToService
-Writes a command to a specific service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| command | json | Yes | Command object |
-| service | json | Yes | Service reference: &#123;id, version?&#125; |
-| options | json | No | Options: &#123;path?, format?, override?&#125; |
----
-## 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: &#123;content, fileName&#125; |
-| 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: &#123;schema, fileName&#125; |
-| 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 DELETED Viewed

@@ -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: &#123;path?&#125; |
-**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: &#123;path?, override?&#125; |
----
-## 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 DELETED Viewed

@@ -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: &#123;latestOnly?&#125; |
-**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: &#123;path?, override?, versionExistingContent?&#125; |
----
-## 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: &#123;id, version?&#125; |
-| 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: &#123;content, fileName&#125; |
-| 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: &#123;id, version&#125; |
-| 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 |
----

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

@@ -1,166 +0,0 @@
----
-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: &#123;latestOnly?&#125; |
-**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: &#123;path?, override?, versionExistingContent?&#125; |
----
-## 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: &#123;id, version?&#125; |
----
-## 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: &#123;content, fileName&#125; |
-| 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"
-```
----