{"id":20756653,"url":"https://github.com/event-catalog/sdk","last_synced_at":"2025-04-28T20:02:07.224Z","repository":{"id":248999106,"uuid":"827922437","full_name":"event-catalog/sdk","owner":"event-catalog","description":"JS/TS SDK for EventCatalog","archived":false,"fork":false,"pushed_at":"2025-04-20T12:39:09.000Z","size":971,"stargazers_count":8,"open_issues_count":11,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T12:40:58.644Z","etag":null,"topics":["event-driven-architecture","eventcatalog","schemas"],"latest_commit_sha":null,"homepage":"https://eventcatalog.dev/docs/sdk","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/event-catalog.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/funding.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["boyney123"]}},"created_at":"2024-07-12T17:10:47.000Z","updated_at":"2025-04-20T12:04:51.000Z","dependencies_parsed_at":"2024-09-13T00:22:07.327Z","dependency_job_id":"fe2918c2-fd39-43ba-a3c7-056bac2435ca","html_url":"https://github.com/event-catalog/sdk","commit_stats":null,"previous_names":["event-catalog/sdk"],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/event-catalog%2Fsdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/event-catalog%2Fsdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/event-catalog%2Fsdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/event-catalog%2Fsdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/event-catalog","download_url":"https://codeload.github.com/event-catalog/sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251380914,"owners_count":21580338,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["event-driven-architecture","eventcatalog","schemas"],"created_at":"2024-11-17T09:34:18.550Z","updated_at":"2025-04-28T20:02:07.017Z","avatar_url":"https://github.com/event-catalog.png","language":"TypeScript","funding_links":["https://github.com/sponsors/boyney123"],"categories":[],"sub_categories":[],"readme":"## @eventcatalog/sdk\n\nJavaScript/TypeScript SDK to interact with your EventCatalog. This SDK exposes various methods to help you automate your EventCatalog.\n\n### Motivation\n\nEventCatalog 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\nto generate these resources. For example you can integrate with your systems, create domains, services and messages for EventCatalog using this SDK.\n\nThe SDK supports standard CRUD operations for domains, service and messages in EventCatalog.\n\nThe SDK is useful for creating your own EventCatalog plugins and integrations (open source plugins coming in July 2024)\n\n**Features**\n\n- Create, read and delete resources in EventCatalog\n- Version any resource in EventCatalog using the `version` SDK api.\n- Add files or schemas to resources in EventCatalog\n- and more more...\n\n### Installation\n\n```sh\nnpm i @eventcatalog/sdk\n```\n\n### Example usage\n\n```typescript\nimport utils from '@eventcatalog/sdk';\n\nconst { getEvent, versionEvent, getService } = utils(PATH_TO_CATALOG);\n\n// Gets event by id\nconst event = await getEvent('InventoryEvent');\n\n// Gets event by id and version\nconst event2 = await getEvent('InventoryEvent', '1.0.0');\n\n// Version the event InventoryEvent (e.g goes to /versioned/{version}/InventoryEvent)\nawait versionEvent('InventoryEvent');\n\n// Returns the service /services/PaymentService\nconst service await getService('PaymentService');\n```\n\nSee the [SDK docs](https://www.eventcatalog.dev/docs/sdk) for more information and examples\n\n# Sponsors\n\nThank you to our project sponsors.\n\n## Gold sponsors\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"hookdeck\" src=\"./images/sponsors/hookdeck.svg\" /\u003e\n  \u003cp style=\"margin: 0; padding: 0;\"\u003eServerless infrastructure for event-driven architecture. \u003c/p\u003e\n  \u003ca href=\"https://hookdeck.com/?ref=eventcatalog-sponsor\" target=\"_blank\" \u003eLearn more\u003c/a\u003e\n\u003c/div\u003e\n\n\u003chr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"hookdeck\" src=\"./images/sponsors/gravitee-logo-black.svg\" width=\"50%\" /\u003e\n  \u003cp style=\"margin: 0; padding: 0;\"\u003eManage, secure, and govern every API in your organization\u003c/p\u003e\n  \u003ca href=\"https://www.gravitee.io/?ref=eventcatalog-sponsor\" target=\"_blank\" \u003eLearn more\u003c/a\u003e\n\u003c/div\u003e\n\n\u003chr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"oso\" src=\"./images/sponsors/oso-logo-green.png\" width=\"40%\" /\u003e\n  \u003cp style=\"margin: 0; padding: 0;\"\u003eDelivering Apache Kafka professional services to your business\u003c/p\u003e\n  \u003ca href=\"https://oso.sh/?utm_source=eventcatalog\u0026utm_medium=web\u0026utm_campaign=sponsorship\" target=\"_blank\" \u003eLearn more\u003c/a\u003e\n\u003c/div\u003e\n\n\u003chr /\u003e\n\n_Sponsors help make EventCatalog sustainable, want to help the project? Get in touch! Or [visit our sponsor page](https://www.eventcatalog.dev/support)._\n\n# Enterprise support\n\nInterested in collaborating with us? Our offerings include dedicated support, priority assistance, feature development, custom integrations, and more.\n\nFind more details on our [services page](https://eventcatalog.dev/services).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevent-catalog%2Fsdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevent-catalog%2Fsdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevent-catalog%2Fsdk/lists"}