@togatherlabs/event-sdk 1.0.0 → 1.0.2
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 +9 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,13 +6,11 @@ This repository contains **event schemas** for the **toGather event-driven backe
|
|
|
6
6
|
## Table of Contents
|
|
7
7
|
|
|
8
8
|
1. [Directory Structure](#directory-structure)
|
|
9
|
-
2. [Development](#development)
|
|
10
|
-
|
|
9
|
+
2. [SDK Development](#development)
|
|
11
10
|
* [Adding New Proto Files](#adding-new-proto-files)
|
|
12
11
|
* [Linting](#linting)
|
|
13
12
|
* [Code Generation](#code-generation)
|
|
14
13
|
3. [Using Generated Code](#using-generated-code)
|
|
15
|
-
|
|
16
14
|
* [TypeScript](#typescript)
|
|
17
15
|
* [Python](#python)
|
|
18
16
|
4. [Best Practices](#best-practices)
|
|
@@ -29,6 +27,9 @@ proto/
|
|
|
29
27
|
└── <version>/
|
|
30
28
|
└── <event>.proto
|
|
31
29
|
```
|
|
30
|
+
1. **Domain**: The feature or module (e.g., `user`)
|
|
31
|
+
2. **Version**: The event schema version (e.g., `v1`)
|
|
32
|
+
|
|
32
33
|
|
|
33
34
|
Example:
|
|
34
35
|
|
|
@@ -36,9 +37,6 @@ Example:
|
|
|
36
37
|
proto/user/create/v1/user.proto
|
|
37
38
|
```
|
|
38
39
|
|
|
39
|
-
* **Domain**: The feature or module (e.g., `user`)
|
|
40
|
-
* **Version**: The event schema version (e.g., `v1`)
|
|
41
|
-
|
|
42
40
|
> This structure ensures forward-compatibility and makes schema evolution manageable.
|
|
43
41
|
|
|
44
42
|
|
|
@@ -73,7 +71,7 @@ Lint your proto files to ensure consistency and adherence to standards:
|
|
|
73
71
|
pnpm buf:lint
|
|
74
72
|
```
|
|
75
73
|
|
|
76
|
-
|
|
74
|
+
This checks for things like missing packages, incorrect directory structure, and other style issues.
|
|
77
75
|
|
|
78
76
|
### Code Generation
|
|
79
77
|
|
|
@@ -105,7 +103,7 @@ pnpm add @bufbuild/protobuf@^2.9.0
|
|
|
105
103
|
**Example usage:**
|
|
106
104
|
|
|
107
105
|
```ts
|
|
108
|
-
import { UserCreated, UserCreatedSchema } from '
|
|
106
|
+
import { UserCreated, UserCreatedSchema } from '<path>/user/create/v1/user_pb';
|
|
109
107
|
import { create, toBinary, fromBinary, toJson } from '@bufbuild/protobuf';
|
|
110
108
|
|
|
111
109
|
// Create a new message
|
|
@@ -128,6 +126,9 @@ const json = toJson(UserCreatedSchema, decoded);
|
|
|
128
126
|
|
|
129
127
|
> **Tip:** Use `toBinary`/`fromBinary` for Kafka or network transmission. Use `toJson`/`fromJson` for logging or debugging.
|
|
130
128
|
|
|
129
|
+
|
|
130
|
+
<br>
|
|
131
|
+
|
|
131
132
|
### Python
|
|
132
133
|
|
|
133
134
|
**Dependencies:**
|
package/package.json
CHANGED