kafka-ts 0.0.1-beta → 0.0.2-beta

package/.github/workflows/release.yml

@@ -0,0 +1,17 @@
+name: Publish package
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2018 Túlio Ornelas (ornelas.tulio@gmail.com)
+Copyright (c) 2024 Priit Käärd (priit@hashtatic.com)
 
 Permission is hereby granted, free of charge,
 to any person obtaining a copy of this software and

package/README.md

@@ -1,13 +1,13 @@
 # KafkaTS
 
-**Please note that this project is still in early development and is not yet ready for production use. The interface before stable release is subject to change.**
-
 **KafkaTS** is a Apache Kafka client library for Node.js. It provides both a low-level API for communicating directly with the Apache Kafka cluster and high-level APIs for publishing and subscribing to Kafka topics.
 
+**Please note that this project is still in early development and is not yet ready for production use. The interface before stable release is subject to change.**
+
 ## Installation
 
 ```bash
-npm install kafkats
+npm install kafka-ts
 ```
 
 ## Quick start
@@ -77,12 +77,15 @@ The existing high-level libraries (e.g. kafkajs) are missing a few crucial featu
 
 ### New features compared to kafkajs
 
-* **Static consumer membership** - Rebalancing during rolling deployments cause delays. Using `groupInstanceId` in addition to `groupId` can avoid rebalancing and continue processing based on the existing assignment.
-* **Consuming messages without consumer groups** - When you don't need for the consumer to track the partition offsets, you can simply create a consumer without groupId and always either start consuming messages from the beginning or from the latest partition offset.
+* **Static consumer membership** - Rebalancing during rolling deployments causes delays. Using `groupInstanceId` in addition to `groupId` can avoid rebalancing and continue consuming partitions in the existing assignment.
+* **Consuming messages without consumer groups** - When you don't need the consumer to track the partition offsets, you can simply create a consumer without groupId and always either start consuming messages from the beginning or from the latest partition offset.
+* **Low-level API requests** - It's possible to communicate directly with the Kafka cluster using the kafka api protocol.
 
 ## Backlog
 
-- [ ] Consumer concurrency control
-- [ ] Partitioner
-- [ ] API versioning
-- [ ] SCRAM support
+Minimal set of features required before a stable release:
+
+- Consumer concurrency control (Currently each relevant broker is polled in sequence)
+- Partitioner (Currently have to specify the partition on producer.send())
+- API versioning (Currently only tested against Kafka 3.7+)
+- SASL SCRAM support (+ pluggable authentication providers)

package/examples/package-lock.json

@@ -9,11 +9,12 @@
       "version": "1.0.0",
       "license": "ISC",
       "dependencies": {
-        "kafkats": "file:../"
+        "kafka-ts": "file:../"
       }
     },
     "..": {
-      "version": "1.0.0",
+      "name": "kafka-ts",
+      "version": "0.0.1-beta",
       "license": "MIT",
       "devDependencies": {
         "@types/node": "^20.12.12",
@@ -22,7 +23,7 @@
         "vitest": "^1.6.0"
       }
     },
-    "node_modules/kafkats": {
+    "node_modules/kafka-ts": {
       "resolved": "..",
       "link": true
     }

package/examples/package.json

@@ -7,7 +7,7 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "kafkats": "file:../"
+    "kafka-ts": "file:../"
   },
   "author": "",
   "license": "ISC"

package/examples/src/client.ts

@@ -1,5 +1,5 @@
 import { readFileSync } from "fs";
-import { createKafkaClient } from "kafkats";
+import { createKafkaClient } from "kafka-ts";
 
 export const kafka = createKafkaClient({
     clientId: "examples",

package/examples/src/create-topic.ts

@@ -1,5 +1,5 @@
 import { kafka } from "./client";
-import { API } from "kafkats";
+import { API } from "kafka-ts";
 
 (async () => {
     const cluster = kafka.createCluster();

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "kafka-ts",
-  "version": "0.0.1-beta",
+  "version": "0.0.2-beta",
   "main": "dist/index.js",
   "author": "Priit Käärd",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/priitkaard/kafka-ts.git"
+  },
   "scripts": {
     "build": "tsc",
     "test": "vitest --testTimeout 60000 --bail 1"