@eventferry/schema-registry 1.0.0 → 1.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 +16 -4
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,16 +1,24 @@
|
|
|
1
1
|
# @eventferry/schema-registry
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@eventferry/schema-registry)
|
|
4
|
+
|
|
5
|
+
Confluent **Schema Registry serializer** for [eventferry](https://github.com/SametGoktepe/eventferry) —
|
|
4
6
|
encode outbox payloads as **Avro / Protobuf / JSON Schema** in the Confluent wire
|
|
5
|
-
format
|
|
7
|
+
format instead of plain JSON. It's a drop-in `Serializer` for the relay.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
6
10
|
|
|
7
11
|
```bash
|
|
8
12
|
npm i @eventferry/schema-registry @kafkajs/confluent-schema-registry
|
|
9
13
|
```
|
|
10
14
|
|
|
15
|
+
`@kafkajs/confluent-schema-registry` is an optional peer (the underlying registry client).
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
11
19
|
```ts
|
|
12
|
-
import { SchemaRegistrySerializer } from "@eventferry/schema-registry";
|
|
13
20
|
import { Relay } from "@eventferry/core";
|
|
21
|
+
import { SchemaRegistrySerializer } from "@eventferry/schema-registry";
|
|
14
22
|
|
|
15
23
|
const serializer = new SchemaRegistrySerializer({
|
|
16
24
|
host: "http://localhost:8081",
|
|
@@ -24,4 +32,8 @@ Topics without a configured schema use the subject's latest registered schema
|
|
|
24
32
|
(default subject: `${topic}-value`). On the consumer, decode with the same client:
|
|
25
33
|
`await registry.decode(message.value)`.
|
|
26
34
|
|
|
27
|
-
|
|
35
|
+
📖 **Full documentation:** [github.com/SametGoktepe/eventferry](https://github.com/SametGoktepe/eventferry#readme)
|
|
36
|
+
|
|
37
|
+
## License
|
|
38
|
+
|
|
39
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eventferry/schema-registry",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Confluent Schema Registry serializer for @eventferry (Avro/Protobuf/JSON Schema)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"bugs": "https://github.com/SametGoktepe/eventferry/issues",
|
|
35
35
|
"peerDependencies": {
|
|
36
36
|
"@kafkajs/confluent-schema-registry": "^3.0.0",
|
|
37
|
-
"@eventferry/core": "1.0.
|
|
37
|
+
"@eventferry/core": "1.0.1"
|
|
38
38
|
},
|
|
39
39
|
"peerDependenciesMeta": {
|
|
40
40
|
"@kafkajs/confluent-schema-registry": {
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"tsup": "^8.3.5",
|
|
47
47
|
"typescript": "^5.7.2",
|
|
48
48
|
"vitest": "^2.1.8",
|
|
49
|
-
"@eventferry/core": "1.0.
|
|
49
|
+
"@eventferry/core": "1.0.1"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "tsup",
|