kafka-crab-js 1.1.2 → 1.3.0

package/README.md

@@ -24,7 +24,7 @@ A lightweight, flexible, and reliable Kafka client for JavaScript/TypeScript. It
 
 1. [Installation](#installation)
 2. [Quick Start](#quick-start)
-3. [Consumer Examples](#consumer-examples)
+3. [Consumer Examples](#basic-consumer-setup)
 4. [Producer Examples](#producer-examples)
 5. [Stream Processing](#stream-processing)
 6. [Configuration](#configuration)

package/index.d.ts

@@ -1,4 +1,4 @@
-export type { ConsumerConfiguration, KafkaConfiguration, KafkaCrabError, Message, MessageProducer, OffsetModel, PartitionOffset, ProducerConfiguration, ProducerRecord, RecordMetadata, RetryStrategy, TopicPartitionConfig, } from './js-binding';
-export { CommitMode, KafkaClientConfig, KafkaConsumer, KafkaProducer, PartitionPosition, SecurityProtocol, } from './js-binding';
+export type { ConsumerConfiguration, KafkaConfiguration, KafkaCrabError, KafkaEvent, KafkaEventPayload, Message, MessageProducer, OffsetModel, PartitionOffset, ProducerConfiguration, ProducerRecord, RecordMetadata, RetryStrategy, TopicPartition, TopicPartitionConfig, } from './js-binding';
+export { CommitMode, KafkaClientConfig, KafkaConsumer, KafkaEventName, KafkaProducer, PartitionPosition, SecurityProtocol, } from './js-binding';
 export { KafkaClient } from './kafka-client';
 export { KafkaStreamReadable } from './kafka-stream-readable';

package/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KafkaStreamReadable = exports.KafkaClient = exports.SecurityProtocol = exports.PartitionPosition = exports.KafkaProducer = exports.KafkaConsumer = exports.KafkaClientConfig = exports.CommitMode = void 0;
+exports.KafkaStreamReadable = exports.KafkaClient = exports.SecurityProtocol = exports.PartitionPosition = exports.KafkaProducer = exports.KafkaEventName = exports.KafkaConsumer = exports.KafkaClientConfig = exports.CommitMode = void 0;
 var js_binding_1 = require("./js-binding");
 Object.defineProperty(exports, "CommitMode", { enumerable: true, get: function () { return js_binding_1.CommitMode; } });
 Object.defineProperty(exports, "KafkaClientConfig", { enumerable: true, get: function () { return js_binding_1.KafkaClientConfig; } });
 Object.defineProperty(exports, "KafkaConsumer", { enumerable: true, get: function () { return js_binding_1.KafkaConsumer; } });
+Object.defineProperty(exports, "KafkaEventName", { enumerable: true, get: function () { return js_binding_1.KafkaEventName; } });
 Object.defineProperty(exports, "KafkaProducer", { enumerable: true, get: function () { return js_binding_1.KafkaProducer; } });
 Object.defineProperty(exports, "PartitionPosition", { enumerable: true, get: function () { return js_binding_1.PartitionPosition; } });
 Object.defineProperty(exports, "SecurityProtocol", { enumerable: true, get: function () { return js_binding_1.SecurityProtocol; } });

package/js-binding.d.ts

@@ -3,6 +3,20 @@
 
 /* auto-generated by NAPI-RS */
 
+export interface KafkaEventPayload {
+  action?: string
+  tpl: Array<TopicPartition>
+  error?: string
+}
+export enum KafkaEventName {
+  PreRebalance = 'PreRebalance',
+  PostRebalance = 'PostRebalance',
+  CommitCallback = 'CommitCallback'
+}
+export interface KafkaEvent {
+  name: KafkaEventName
+  payload: KafkaEventPayload
+}
 export interface RetryStrategy {
   retries: number
   retryTopic?: string
@@ -25,7 +39,8 @@ export interface ConsumerConfiguration {
 export enum PartitionPosition {
   Beginning = 'Beginning',
   End = 'End',
-  Stored = 'Stored'
+  Stored = 'Stored',
+  Invalid = 'Invalid'
 }
 export interface OffsetModel {
   offset?: number
@@ -40,6 +55,10 @@ export interface TopicPartitionConfig {
   allOffsets?: OffsetModel
   partitionOffset?: Array<PartitionOffset>
 }
+export interface TopicPartition {
+  topic: string
+  partitionOffset: Array<PartitionOffset>
+}
 export enum SecurityProtocol {
   Plaintext = 'Plaintext',
   Ssl = 'Ssl',
@@ -88,12 +107,14 @@ export interface ProducerConfiguration {
   configuration?: Record<string, string>
 }
 export declare class KafkaConsumer {
+  onEvents(callback: (error: Error | undefined, event: KafkaEvent) => void): void
   subscribe(topicConfigs: string | Array<TopicPartitionConfig>): Promise<void>
   pause(): void
   resume(): void
   unsubscribe(): void
-  shutdownConsumer(): Promise<void>
+  disconnect(): Promise<void>
   seek(topic: string, partition: number, offsetModel: OffsetModel, timeout?: number | undefined | null): void
+  assignment(): Array<TopicPartition>
   recv(): Promise<Message | null>
   commit(topic: string, partition: number, offset: number, commit: CommitMode): void
 }

package/js-binding.js

@@ -310,8 +310,9 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { KafkaConsumer, CommitMode, PartitionPosition, SecurityProtocol, KafkaClientConfig, KafkaProducer } = nativeBinding
+const { KafkaEventName, KafkaConsumer, CommitMode, PartitionPosition, SecurityProtocol, KafkaClientConfig, KafkaProducer } = nativeBinding
 
+module.exports.KafkaEventName = KafkaEventName
 module.exports.KafkaConsumer = KafkaConsumer
 module.exports.CommitMode = CommitMode
 module.exports.PartitionPosition = PartitionPosition

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kafka-crab-js",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "main": "index.js",
   "types": "index.d.ts",
   "module": "commonjs",
@@ -42,11 +42,11 @@
   "devDependencies": {
     "@faker-js/faker": "9.3.0",
     "@napi-rs/cli": "^2.18.4",
-    "@types/node": "22.10.1",
+    "@types/node": "22.10.5",
     "ava": "6.2.0",
     "dprint": "^0.48.0",
     "nanoid": "5.0.9",
-    "typescript": "5.7.2",
+    "typescript": "5.7.3",
     "copyfiles": "^2.4.1",
     "@types/copyfiles": "^2.4.4",
     "rimraf": "^6.0.1"
@@ -65,10 +65,10 @@
     "version": "napi version",
     "fmt": "dprint fmt"
   },
-  "packageManager": "pnpm@9.15.2",
+  "packageManager": "pnpm@9.15.3",
   "optionalDependencies": {
-    "kafka-crab-js-darwin-arm64": "1.1.2",
-    "kafka-crab-js-darwin-x64": "1.1.2",
-    "kafka-crab-js-linux-x64-gnu": "1.1.2"
+    "kafka-crab-js-darwin-arm64": "1.3.0",
+    "kafka-crab-js-darwin-x64": "1.3.0",
+    "kafka-crab-js-linux-x64-gnu": "1.3.0"
   }
 }