View as Markdown

---

@eventcatalog/sdk

EventCatalog SDK

The EventCatalog SDK provides methods to interact with domains, services, and messages.

Installation

npm install @eventcatalog/sdk

Usage

import utils from '@eventcatalog/sdk';

const { getEvent } = utils(PATH_TO_CATALOG);

// Get an event by the id
const event = getEvent('event-name');

// Get an event by the id and it's version
const event = getEvent('event-name', '0.3.4');

Classes

Class	Description
FlowBuilder	Build EventCatalog flow resources using a fluent API.

Type Aliases

Type alias	Description
FlowActorStepInput	Payload for a flow step that represents a user or actor.
FlowBuilderInput	Input used to create a flow builder.
FlowCustomStepInput	Payload for a custom flow step.
FlowDataProductStepInput	Payload for a flow step that references a data product.
FlowDataStoreStepInput	Payload for a flow step that references a data store/container.
FlowExternalSystemStepInput	Payload for a flow step that represents an external system.
FlowMessageStepInput	Payload for a flow step that references an event, command, or query.
FlowServiceStepInput	Payload for a flow step that references a service.
FlowStepInput	Payload for a generic flow step.
FlowSubFlowStepInput	Payload for a flow step that references another flow.

Functions

Function	Description
addDataProductToDomain	Add a data product to a domain by its id. Optionally specify a version to add the data product to a specific version of the domain.
addDataStoreToService	Add a data store to a service by it's id.
addEntityToDomain	Add an entity to a domain by its id. Optionally specify a version to add the entity to a specific version of the domain.
addEntityToService	Add an entity to a service by its id.
addExampleToCommand	Add an example file to a command.
addExampleToEvent	Add an example file to an event.
addExampleToQuery	Add an example file to a query.
addFileToCommand	Add a file to a command by it's id.
addFileToDataProduct	Add a file to a data product by its id.
addFileToDataStore	Add a file to a data store (e.g. database, cache, etc.) by it's id.
addFileToDiagram	Adds a file to the given diagram.
addFileToDomain	Add a file to a domain by it's id.
addFileToEvent	Add a file to an event by it's id.
addFileToFlow	Adds a file to the given flow.
addFileToQuery	Add a file to a query by it's id.
addFileToService	Add a file to a service by it's id.
addMessageToChannel	Add an event/command/query to a channel by it's id.
addMessageToDomain	Add an event/command/query to a domain by its id.
addMessageToService	Add an event/command to a service by it's id.
addSchemaToCommand	Add a schema to a command by it's id.
addSchemaToEvent	Add a schema to an event by it's id.
addSchemaToQuery	Add a schema to a query by it's id.
addServiceToDomain	Add a service to a domain by it's id.
addSubDomainToDomain	Add a subdomain to a domain by it's id. Optionally specify a version to add the subdomain to a specific version of the domain
addUbiquitousLanguageToDomain	Adds a ubiquitous language dictionary to a domain.
appendChangelog	Appends a changelog entry to an existing changelog for a resource. If no changelog exists, one is created.
channelHasVersion	Check to see if the catalog has a version for the given channel.
commandHasVersion	Check to see if the catalog has a version for the given command.
dataProductHasVersion	Check to see if the catalog has a version for the given data product.
dataStoreHasVersion	Check to see if the catalog has a version for the given data store (e.g. database, cache, etc.).
diagramHasVersion	Check to see if the catalog has a version for the given diagram.
domainHasVersion	Check to see if the catalog has a version for the given domain.
dumpCatalog	Dumps the catalog to a JSON file.
entityHasVersion	Check to see if the catalog has a version for the given entity.
eventHasVersion	Check to see if the catalog has a version for the given event.
flowHasVersion	Check to see if the catalog has a version for the given flow.
getChangelog	Returns the changelog for a resource in EventCatalog.
getChannel	Returns a channel from EventCatalog.
getChannels	Returns all channels from EventCatalog.
getCommand	Returns a command from EventCatalog.
getCommands	Returns all commands from EventCatalog.
getConsumersOfSchema	Returns the consumers of a given schema path.
getCustomDoc	Returns a custom doc from EventCatalog by the given file path.
getCustomDocs	Returns all custom docs for the project.
getDataProduct	Returns a data product from EventCatalog.
getDataProducts	Returns all data products from EventCatalog.
getDataStore	Returns a data store (e.g. database, cache, etc.) from EventCatalog.
getDataStores	Returns all data stores (e.g. databases, caches, etc.) from EventCatalog.
getDiagram	Returns a diagram from EventCatalog.
getDiagrams	Returns all diagrams from EventCatalog.
getDomain	Returns a domain from EventCatalog.
getDomains	Returns all domains from EventCatalog.
getEntities	Returns all entities from EventCatalog.
getEntity	Returns an entity from EventCatalog.
getEvent	Returns an event from EventCatalog.
getEventCatalogConfigurationFile	Returns the event catalog configuration file. The event catalog configuration file is the file that contains the configuration for the event catalog.
getEvents	Returns all events from EventCatalog.
getExamplesFromCommand	Get all examples from a command.
getExamplesFromEvent	Get all examples from an event.
getExamplesFromQuery	Get all examples from a query.
getFlow	Returns a flow from EventCatalog.
getFlows	Returns all flows from EventCatalog.
getMessageBySchemaPath	Returns a message from EventCatalog by a given schema path.
getOwnersForResource	Returns the owners for a given resource (e.g domain, service, event, command, query, etc.)
getProducersAndConsumersForMessage	Returns the producers and consumers (services) for a given message.
getProducersOfSchema	Returns the producers of a given schema path.
getQueries	Returns all queries from EventCatalog.
getQuery	Returns a query from EventCatalog.
getSchemaForMessage	Returns the schema for a given message (event, command or query) by its id and version.
getService	Returns a service from EventCatalog.
getServiceByPath	Returns a service from EventCatalog by it's path.
getServices	Returns all services from EventCatalog.
getSpecificationFilesForService	Returns specification files for a service
getTeam	Returns a team from EventCatalog.
getTeams	Returns all teams from EventCatalog.
getUbiquitousLanguageFromDomain	Returns the ubiquitous language dictionary from a domain.
getUser	Returns a user from EventCatalog.
getUsers	Returns all users from EventCatalog.
isService	Check to see if the path is a service.
queryHasVersion	Check to see if the catalog has a version for the given query.
removeExampleFromCommand	Remove an example file from a command.
removeExampleFromEvent	Remove an example file from an event.
removeExampleFromQuery	Remove an example file from a query.
rmChangelog	Removes the changelog for a resource in EventCatalog.
rmChannel	Delete a channel at it's given path.
rmChannelById	Delete a channel by it's id.
rmCommand	Delete a command at it's given path.
rmCommandById	Delete a command by it's id.
rmCustomDoc	Delete a custom doc by its' path
rmDataProduct	Delete a data product at its given path.
rmDataProductById	Delete a data product by its id.
rmDataStore	Delete an data store (e.g. database, cache, etc.) at its given path.
rmDataStoreById	Delete an data store (e.g. database, cache, etc.) by its id.
rmDiagram	Delete a diagram at its given path.
rmDiagramById	Delete a diagram by its id.
rmDomain	Delete a domain at it's given path.
rmDomainById	Delete a domain by it's id.
rmEntity	Delete an entity at its given path.
rmEntityById	Delete an entity by its id.
rmEvent	Delete an event at it's given path.
rmEventById	Delete an event by it's id.
rmFlow	Delete a flow at its given path.
rmFlowById	Delete a flow by its id.
rmQuery	Delete a query at it's given path.
rmQueryById	Delete a query by it's id.
rmService	Delete a service at it's given path.
rmServiceById	Delete a service by it's id.
rmTeamById	Delete a team by it's id.
rmUserById	Delete a user by it's id.
serviceHasVersion	Check to see if the catalog has a version for the given service.
toService	Takes a given raw file and converts it to a service.
versionChannel	Version a channel by it's id.
versionCommand	Version a command by it's id.
versionDataProduct	Version a data product by its id.
versionDataStore	Version an data store (e.g. database, cache, etc.) by its id.
versionDiagram	Version a diagram by its id.
versionDomain	Version a domain by it's id.
versionEntity	Version an entity by its id.
versionEvent	Version an event by it's id.
versionFlow	Version a flow by its id.
versionQuery	Version a query by it's id.
versionService	Version a service by it's id.
writeChangelog	Writes a changelog entry to a resource in EventCatalog.
writeChannel	Write a channel to EventCatalog.
writeCommand	Write a command to EventCatalog.
writeCommandToService	Write an command to a service in EventCatalog.
writeCustomDoc	Write a custom doc to EventCatalog.
writeDataProduct	Write a data product to EventCatalog.
writeDataProductToDomain	Write a data product to a domain in EventCatalog.
writeDataStore	Write a data store (e.g. database, cache, etc.) to EventCatalog.
writeDataStoreToService	Write an data store (e.g. database, cache, etc.) to a service in EventCatalog.
writeDiagram	Write a diagram to EventCatalog.
writeDomain	Write a domain to EventCatalog.
writeEntity	Write an entity to EventCatalog.
writeEvent	Write an event to EventCatalog.
writeEventToService	Write an event to a service in EventCatalog.
writeFlow	Write a flow to EventCatalog.
writeFlowToDomain	Write a flow to a domain in EventCatalog.
writeFlowToService	Write a flow to a service in EventCatalog.
writeQuery	Write a query to EventCatalog.
writeQueryToService	Write a query to a service in EventCatalog.
writeService	Write a Service to EventCatalog.
writeServiceToDomain	Write a service to a domain in EventCatalog.
writeTeam	Write a team to EventCatalog.
writeUser	Write a user to EventCatalog.
writeVersionedFlow	Write a versioned flow to EventCatalog.
writeVersionedService	Write a versioned service to EventCatalog.