@eventcatalog/sdk 0.0.1
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.
- package/README.md +24 -0
- package/package.json +50 -0
package/README.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
## @eventcatalog/sdk
|
|
2
|
+
|
|
3
|
+
_Warning: Still currently in beta, and APIs may change. Looking for stable release in July 2024._
|
|
4
|
+
|
|
5
|
+
### Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm i @eventcatalog/sdk
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import utils from '@eventcatalog/sdk';
|
|
15
|
+
|
|
16
|
+
const { getEvent } = utils(PATH_TO_CATALOG);
|
|
17
|
+
|
|
18
|
+
// Gets event by id
|
|
19
|
+
await getEvent('InventoryEvent');
|
|
20
|
+
|
|
21
|
+
// Gets event by id and version
|
|
22
|
+
await getEvent('InventoryEvent', '1.0.0');
|
|
23
|
+
```
|
|
24
|
+
|
package/package.json
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@eventcatalog/sdk",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "SDK to integrate with EventCatalog",
|
|
5
|
+
"publishConfig": {
|
|
6
|
+
"access": "public"
|
|
7
|
+
},
|
|
8
|
+
"keywords": [],
|
|
9
|
+
"author": "",
|
|
10
|
+
"license": "ISC",
|
|
11
|
+
"devDependencies": {
|
|
12
|
+
"@types/fs-extra": "^11.0.4",
|
|
13
|
+
"@types/node": "^20.14.10",
|
|
14
|
+
"prettier": "^3.3.3",
|
|
15
|
+
"tsup": "^8.1.0",
|
|
16
|
+
"typescript": "^5.5.3",
|
|
17
|
+
"vitest": "^2.0.2"
|
|
18
|
+
},
|
|
19
|
+
"files": [
|
|
20
|
+
"dist",
|
|
21
|
+
"package.json"
|
|
22
|
+
],
|
|
23
|
+
"exports": {
|
|
24
|
+
".": {
|
|
25
|
+
"require": "./dist/index.js",
|
|
26
|
+
"import": "./dist/index.mjs",
|
|
27
|
+
"types": [
|
|
28
|
+
"./dist/index.d.ts",
|
|
29
|
+
"./dist/events.t.ts"
|
|
30
|
+
]
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"main": "./dist/index.js",
|
|
34
|
+
"module": "./dist/index.mjs",
|
|
35
|
+
"types": "./dist/index.d.ts",
|
|
36
|
+
"dependencies": {
|
|
37
|
+
"@changesets/cli": "^2.27.7",
|
|
38
|
+
"fs-extra": "^11.2.0",
|
|
39
|
+
"glob": "^11.0.0",
|
|
40
|
+
"gray-matter": "^4.0.3"
|
|
41
|
+
},
|
|
42
|
+
"scripts": {
|
|
43
|
+
"build": "tsup ./src",
|
|
44
|
+
"test": "vitest",
|
|
45
|
+
"format": "prettier --write .",
|
|
46
|
+
"format:diff": "prettier --list-different .",
|
|
47
|
+
"changeset": "changeset",
|
|
48
|
+
"release": "changeset publish"
|
|
49
|
+
}
|
|
50
|
+
}
|