https://github.com/event-catalog/sdk
JS/TS SDK for EventCatalog
https://github.com/event-catalog/sdk
event-driven-architecture eventcatalog schemas
Last synced: 5 months ago
JSON representation
JS/TS SDK for EventCatalog
- Host: GitHub
- URL: https://github.com/event-catalog/sdk
- Owner: event-catalog
- Created: 2024-07-12T17:10:47.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T08:03:57.000Z (6 months ago)
- Last Synced: 2024-10-25T04:31:31.745Z (6 months ago)
- Topics: event-driven-architecture, eventcatalog, schemas
- Language: TypeScript
- Homepage: https://eventcatalog.dev/docs/sdk
- Size: 607 KB
- Stars: 7
- Watchers: 1
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/funding.yml
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## @eventcatalog/sdk
JavaScript/TypeScript SDK to interact with your EventCatalog. This SDK exposes various methods to help you automate your EventCatalog.
### Motivation
EventCatalog vision is to integrate with any broker or technlogy in the world. As its powered by Markdown and contents are built at build time, you can use the SDK
to generate these resources. For example you can integrate with your systems, create domains, services and messages for EventCatalog using this SDK.
The SDK supports standard CRUD operations for domains, service and messages in EventCatalog.
The SDK is useful for creating your own EventCatalog plugins and integrations (open source plugins coming in July 2024)
**Features**
- Create, read and delete resources in EventCatalog
- Version any resource in EventCatalog using the `version` SDK api.
- Add files or schemas to resources in EventCatalog
- and more more...
### Installation
```sh
npm i @eventcatalog/sdk
```
### Example usage
```typescript
import utils from '@eventcatalog/sdk';
const { getEvent, versionEvent, getService } = utils(PATH_TO_CATALOG);
// Gets event by id
const event = await getEvent('InventoryEvent');
// Gets event by id and version
const event2 = await getEvent('InventoryEvent', '1.0.0');
// Version the event InventoryEvent (e.g goes to /versioned/{version}/InventoryEvent)
await versionEvent('InventoryEvent');
// Returns the service /services/PaymentService
const service await getService('PaymentService');
```
See the [SDK docs](https://www.eventcatalog.dev/docs/sdk) for more information and examples
# Sponsors
Thank you to our project sponsors.
## Gold sponsors
_Sponsors help make EventCatalog sustainable, want to help the project? Get in touch! Or [visit our sponsor page](https://www.eventcatalog.dev/support)._
# Enterprise support
Interested in collaborating with us? Our offerings include dedicated support, priority assistance, feature development, custom integrations, and more.
Find more details on our [services page](https://eventcatalog.dev/services)
