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

@eventcatalog/core 4.10.13 → 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 (160) hide show

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

@@ -1,183 +0,0 @@
----
-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: &#123;latestOnly?, attachSchema?&#125; |
-**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: &#123;path?, override?, versionExistingContent?&#125; |
----
-## writeQueryToService
-Writes a query to a specific service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| query | json | Yes | Query object |
-| service | json | Yes | Service reference: &#123;id, version?&#125; |
-| options | json | No | Options: &#123;path?, format?, override?&#125; |
----
-## 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: &#123;content, fileName&#125; |
-| 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: &#123;schema, fileName&#125; |
-| 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"
-```
----

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

@@ -1,266 +0,0 @@
----
-id: cli-services
-title: Services
-sidebar_label: Services
-sidebar_position: 5
----
-# Services CLI Commands
-Manage services in your EventCatalog from the command line.
-## getService
-Returns a service from EventCatalog by its ID
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the service to retrieve |
-| version | string | No | Specific version to retrieve |
-**Examples:**
-```bash
-# Get the latest service
-npx @eventcatalog/cli getService "OrderService"
-# Get a specific version
-npx @eventcatalog/cli getService "OrderService" "1.0.0"
-```
----
-## getServices
-Returns all services from EventCatalog
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| options | json | No | Options: &#123;latestOnly?&#125; |
-**Examples:**
-```bash
-# Get all services
-npx @eventcatalog/cli getServices
-```
----
-## writeService
-Writes a service to EventCatalog
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| service | json | Yes | Service object with id, name, version, and markdown |
-| options | json | No | Options: &#123;path?, override?, versionExistingContent?&#125; |
----
-## writeServiceToDomain
-Writes a service to a specific domain
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| service | json | Yes | Service object |
-| domain | json | Yes | Domain reference: &#123;id, version?&#125; |
-| options | json | No | Options |
----
-## rmService
-Removes a service by its path
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| path | string | Yes | Path to the service |
-**Examples:**
-```bash
-# Remove a service
-npx @eventcatalog/cli rmService "/OrderService"
-```
----
-## rmServiceById
-Removes a service by its ID
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the service to remove |
-| version | string | No | Specific version to remove |
-**Examples:**
-```bash
-# Remove a service
-npx @eventcatalog/cli rmServiceById "OrderService"
-```
----
-## versionService
-Moves the current service to a versioned directory
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the service to version |
-**Examples:**
-```bash
-# Version a service
-npx @eventcatalog/cli versionService "OrderService"
-```
----
-## addFileToService
-Adds a file to a service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the service |
-| file | json | Yes | File object: &#123;content, fileName&#125; |
-| version | string | No | Specific version |
----
-## addEventToService
-Adds an event relationship to a service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| serviceId | string | Yes | The ID of the service |
-| direction | string | Yes | Direction: "sends" or "receives" |
-| event | json | Yes | Event reference: &#123;id, version&#125; |
-| serviceVersion | string | No | Specific service version |
----
-## addCommandToService
-Adds a command relationship to a service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| serviceId | string | Yes | The ID of the service |
-| direction | string | Yes | Direction: "sends" or "receives" |
-| command | json | Yes | Command reference: &#123;id, version&#125; |
-| serviceVersion | string | No | Specific service version |
----
-## addQueryToService
-Adds a query relationship to a service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| serviceId | string | Yes | The ID of the service |
-| direction | string | Yes | Direction: "sends" or "receives" |
-| query | json | Yes | Query reference: &#123;id, version&#125; |
-| serviceVersion | string | No | Specific service version |
----
-## addEntityToService
-Adds an entity to a service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| serviceId | string | Yes | The ID of the service |
-| entity | json | Yes | Entity reference: &#123;id, version&#125; |
-| serviceVersion | string | No | Specific service version |
----
-## addDataStoreToService
-Adds a data store relationship to a service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| serviceId | string | Yes | The ID of the service |
-| relationship | string | Yes | Relationship: "writesTo" or "readsFrom" |
-| dataStore | json | Yes | Data store reference: &#123;id, version&#125; |
-| serviceVersion | string | No | Specific service version |
----
-## serviceHasVersion
-Checks if a specific version of a service exists
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the service |
-| version | string | Yes | Version to check |
-**Examples:**
-```bash
-# Check if version exists
-npx @eventcatalog/cli serviceHasVersion "OrderService" "1.0.0"
-```
----
-## getSpecificationFilesForService
-Returns specification files (OpenAPI, AsyncAPI) for a service
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the service |
-| version | string | No | Specific version |
-**Examples:**
-```bash
-# Get spec files
-npx @eventcatalog/cli getSpecificationFilesForService "OrderService"
-```
----

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

@@ -1,44 +0,0 @@
----
-id: cli-snapshots
-title: Snapshots
-sidebar_label: Snapshots
-sidebar_position: 18
----
-# Snapshots CLI Commands
-Manage snapshots in your EventCatalog from the command line.
-## createSnapshot
-Take a point-in-time snapshot of the entire catalog, capturing all resources and their metadata as a JSON file
-**Arguments:** None
----
-## diffSnapshots
-Compare two snapshot files and output a structured diff showing added, removed, modified, and versioned resources plus relationship changes
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| fileA | string | Yes | Path to the first (older) snapshot file |
-| fileB | string | Yes | Path to the second (newer) snapshot file |
----
-## listSnapshots
-List all snapshots in the catalog .snapshots directory with their labels, timestamps, and git info
-**Arguments:** None
----

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

@@ -1,75 +0,0 @@
----
-id: cli-teams
-title: Teams
-sidebar_label: Teams
-sidebar_position: 8
----
-# Teams CLI Commands
-Manage teams in your EventCatalog from the command line.
-## getTeam
-Returns a team from EventCatalog by its ID
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the team to retrieve |
-**Examples:**
-```bash
-# Get a team
-npx @eventcatalog/cli getTeam "platform-team"
-```
----
-## getTeams
-Returns all teams from EventCatalog
-**Arguments:** None
-**Examples:**
-```bash
-# Get all teams
-npx @eventcatalog/cli getTeams
-```
----
-## writeTeam
-Writes a team to EventCatalog
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| team | json | Yes | Team object with id, name, and markdown |
-| options | json | No | Options: &#123;path?, override?&#125; |
----
-## rmTeamById
-Removes a team by its ID
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the team to remove |
-**Examples:**
-```bash
-# Remove a team
-npx @eventcatalog/cli rmTeamById "platform-team"
-```
----

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

@@ -1,75 +0,0 @@
----
-id: cli-users
-title: Users
-sidebar_label: Users
-sidebar_position: 9
----
-# Users CLI Commands
-Manage users in your EventCatalog from the command line.
-## getUser
-Returns a user from EventCatalog by their ID
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the user to retrieve |
-**Examples:**
-```bash
-# Get a user
-npx @eventcatalog/cli getUser "jsmith"
-```
----
-## getUsers
-Returns all users from EventCatalog
-**Arguments:** None
-**Examples:**
-```bash
-# Get all users
-npx @eventcatalog/cli getUsers
-```
----
-## writeUser
-Writes a user to EventCatalog
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| user | json | Yes | User object with id, name, and markdown |
-| options | json | No | Options: &#123;path?, override?&#125; |
----
-## rmUserById
-Removes a user by their ID
-**Arguments:**
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| id | string | Yes | The ID of the user to remove |
-**Examples:**
-```bash
-# Remove a user
-npx @eventcatalog/cli rmUserById "jsmith"
-```
----

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

@@ -1,43 +0,0 @@
----
-id: cli-utilities
-title: Utilities
-sidebar_label: Utilities
-sidebar_position: 16
----
-# Utilities CLI Commands
-Manage utilities in your EventCatalog from the command line.
-## dumpCatalog
-Dumps the entire catalog to a JSON structure
-**Arguments:** None
-**Examples:**
-```bash
-# Dump entire catalog
-npx @eventcatalog/cli dumpCatalog
-# Dump and save to file
-npx @eventcatalog/cli dumpCatalog > catalog.json
-```
----
-## getEventCatalogConfigurationFile
-Returns the EventCatalog configuration file
-**Arguments:** None
-**Examples:**
-```bash
-# Get config file
-npx @eventcatalog/cli getEventCatalogConfigurationFile
-```
----