@eventferry/kafka 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 +39 -2
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,5 +1,42 @@
|
|
|
1
1
|
# @eventferry/kafka
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@eventferry/kafka)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
The **Kafka / Redpanda publisher** for [eventferry](https://github.com/SametGoktepe/eventferry) —
|
|
6
|
+
a transactional outbox toolkit for PostgreSQL + Kafka/Redpanda.
|
|
7
|
+
|
|
8
|
+
One `KafkaPublisher` over two interchangeable drivers — `kafkajs` (pure JS) and
|
|
9
|
+
`@confluentinc/kafka-javascript` (librdkafka-backed) — with idempotent and optional
|
|
10
|
+
transactional (EOS) producers, plus dead-letter (DLQ) routing.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm i @eventferry/kafka @eventferry/core
|
|
16
|
+
|
|
17
|
+
# pick ONE Kafka client (both are optional peers):
|
|
18
|
+
npm i kafkajs # pure JS, zero native deps
|
|
19
|
+
npm i @confluentinc/kafka-javascript # librdkafka-backed, higher throughput
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { KafkaPublisher } from "@eventferry/kafka";
|
|
26
|
+
|
|
27
|
+
const publisher = new KafkaPublisher({
|
|
28
|
+
driver: "kafkajs", // or "confluent"
|
|
29
|
+
brokers: ["localhost:19092"],
|
|
30
|
+
idempotent: true,
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
// Hand it to a Relay from @eventferry/core.
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
You can also pass a `customDriver` implementing the `KafkaDriver` interface.
|
|
37
|
+
|
|
38
|
+
📖 **Full documentation:** [github.com/SametGoktepe/eventferry](https://github.com/SametGoktepe/eventferry#readme)
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eventferry/kafka",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Kafka/Redpanda publisher for @eventferry (kafkajs + confluent drivers)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"peerDependencies": {
|
|
35
35
|
"kafkajs": "^2.0.0",
|
|
36
36
|
"@confluentinc/kafka-javascript": "^1.0.0",
|
|
37
|
-
"@eventferry/core": "1.0.
|
|
37
|
+
"@eventferry/core": "1.0.1"
|
|
38
38
|
},
|
|
39
39
|
"peerDependenciesMeta": {
|
|
40
40
|
"kafkajs": {
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"tsup": "^8.3.5",
|
|
50
50
|
"typescript": "^5.7.2",
|
|
51
51
|
"vitest": "^2.1.8",
|
|
52
|
-
"@eventferry/core": "1.0.
|
|
52
|
+
"@eventferry/core": "1.0.1"
|
|
53
53
|
},
|
|
54
54
|
"scripts": {
|
|
55
55
|
"build": "tsup",
|