kafka-crab-js 1.0.0 → 1.0.1

package/index.d.ts

@@ -3,57 +3,35 @@
  */
 export class KafkaClient {
     /**
-     * Creates a KafkaStreamReadable instance
-     * @param { KafkaConfiguration } config
+     * Creates a KafkaClient instance
+     * @param {KafkaConfiguration} config - The Kafka configuration object
+     * @throws {Error} If the configuration is invalid
      */
     constructor(config: KafkaConfiguration);
     kafkaConfiguration: KafkaConfiguration;
     kafkaClientConfig: KafkaClientConfig;
     /**
      * Creates a KafkaProducer instance
-     * @param { ProducerConfiguration | undefined } producerConfiguration
-     * @returns {KafkaProducer}
+     * @param {ProducerConfiguration} [producerConfiguration] - Optional producer configuration
+     * @returns {KafkaProducer} A KafkaProducer instance
      */
-    createProducer(producerConfiguration: ProducerConfiguration | undefined): KafkaProducer;
+    createProducer(producerConfiguration?: ProducerConfiguration | undefined): KafkaProducer;
     /**
      * Creates a KafkaConsumer instance
-     * @param {ConsumerConfiguration } consumerConfiguration
-     * @returns {KafkaConsumer}
+     * @param {ConsumerConfiguration} consumerConfiguration - Consumer configuration
+     * @returns {KafkaConsumer} A KafkaConsumer instance
+     * @throws {Error} If the configuration is invalid
      */
     createConsumer(consumerConfiguration: ConsumerConfiguration): KafkaConsumer;
     /**
      * Creates a KafkaStreamReadable instance
-     * @param { ConsumerConfiguration } consumerConfiguration
-     * @returns {KafkaStreamReadable}
+     * @param {ConsumerConfiguration} consumerConfiguration - Consumer configuration
+     * @returns {KafkaStreamReadable} A KafkaStreamReadable instance
+     * @throws {Error} If the configuration is invalid
      */
     createStreamConsumer(consumerConfiguration: ConsumerConfiguration): KafkaStreamReadable;
 }
-/**
- * KafkaStreamReadable class
- * @extends Readable
- */
-export class KafkaStreamReadable extends Readable {
-    /**
-     * Creates a KafkaStreamReadable instance
-     * @param { KafkaConsumer } kafkaConsumer
-     */
-    constructor(kafkaConsumer: KafkaConsumer);
-    kafkaConsumer: KafkaConsumer;
-    /**
-     * Subscribes to topics
-     * @param {string | Array<TopicPartitionConfig>} topics
-     * @returns
-     */
-    subscribe(topics: string | Array<TopicPartitionConfig>): Promise<void>;
-    /**
-     * Unsubscribe from topics
-     */
-    unsubscribe(): void;
-    /**
-     * The internal method called by the Readable stream to fetch data
-     */
-    _read(): Promise<void>;
-}
+import { KafkaStreamReadable } from "./kafka-stream-readable";
 import { ProducerConfiguration } from "./js-binding";
 import { ConsumerConfiguration } from "./js-binding";
 import { KafkaConfiguration } from "./js-binding";
@@ -64,5 +42,4 @@ import { SecurityProtocol } from "./js-binding";
 import { KafkaClientConfig } from "./js-binding";
 import { TopicPartitionConfig } from "./js-binding";
 import { KafkaProducer } from "./js-binding";
-import { Readable } from "stream";
-export { ProducerConfiguration, ConsumerConfiguration, KafkaConfiguration, KafkaConsumer, CommitMode, PartitionPosition, SecurityProtocol, KafkaClientConfig, TopicPartitionConfig, KafkaProducer };
+export { KafkaStreamReadable, ProducerConfiguration, ConsumerConfiguration, KafkaConfiguration, KafkaConsumer, CommitMode, PartitionPosition, SecurityProtocol, KafkaClientConfig, TopicPartitionConfig, KafkaProducer };

package/index.js

@@ -13,56 +13,16 @@ const {
   KafkaProducer,
 } = require('./js-binding')
 
-/**
- * KafkaStreamReadable class
- * @extends Readable
- */
-class KafkaStreamReadable extends Readable {
-  /**
-   * Creates a KafkaStreamReadable instance
-   * @param { KafkaConsumer } kafkaConsumer
-   */
-  constructor(kafkaConsumer) {
-    super({ objectMode: true })
-    this.kafkaConsumer = kafkaConsumer
-  }
-
-  /**
-   * Subscribes to topics
-   * @param {string | Array<TopicPartitionConfig>} topics
-   * @returns
-   */
-  async subscribe(topics) {
-    return this.kafkaConsumer.subscribe(topics)
-  }
-
-  /**
-   * Unsubscribe from topics
-   */
-  unsubscribe() {
-    this.kafkaConsumer.unsubscribe()
-  }
-
-  /**
-   * The internal method called by the Readable stream to fetch data
-   */
-  async _read() {
-    const message = await this.kafkaConsumer.recv() // Call the napi-rs method
-    if (message) {
-      this.push(message) // Push message into the stream
-    } else {
-      this.push(null) // No more data, end of stream
-    }
-  }
-}
+const { KafkaStreamReadable } = require('./kafka-stream-readable')
 
 /**
  * KafkaClient class
  */
 class KafkaClient {
   /**
-   * Creates a KafkaStreamReadable instance
-   * @param { KafkaConfiguration } config
+   * Creates a KafkaClient instance
+   * @param {KafkaConfiguration} config - The Kafka configuration object
+   * @throws {Error} If the configuration is invalid
    */
   constructor(config) {
     this.kafkaConfiguration = config
@@ -71,8 +31,8 @@ class KafkaClient {
 
   /**
    * Creates a KafkaProducer instance
-   * @param { ProducerConfiguration | undefined } producerConfiguration
-   * @returns {KafkaProducer}
+   * @param {ProducerConfiguration} [producerConfiguration] - Optional producer configuration
+   * @returns {KafkaProducer} A KafkaProducer instance
    */
   createProducer(producerConfiguration) {
     if (producerConfiguration) {
@@ -83,8 +43,9 @@ class KafkaClient {
 
   /**
    * Creates a KafkaConsumer instance
-   * @param {ConsumerConfiguration } consumerConfiguration
-   * @returns {KafkaConsumer}
+   * @param {ConsumerConfiguration} consumerConfiguration - Consumer configuration
+   * @returns {KafkaConsumer} A KafkaConsumer instance
+   * @throws {Error} If the configuration is invalid
    */
   createConsumer(consumerConfiguration) {
     return this.kafkaClientConfig.createConsumer(consumerConfiguration)
@@ -92,8 +53,9 @@ class KafkaClient {
 
   /**
    * Creates a KafkaStreamReadable instance
-   * @param { ConsumerConfiguration } consumerConfiguration
-   * @returns {KafkaStreamReadable}
+   * @param {ConsumerConfiguration} consumerConfiguration - Consumer configuration
+   * @returns {KafkaStreamReadable} A KafkaStreamReadable instance
+   * @throws {Error} If the configuration is invalid
    */
   createStreamConsumer(consumerConfiguration) {
     return new KafkaStreamReadable(this.kafkaClientConfig.createConsumer(consumerConfiguration))

package/js-binding.d.ts

@@ -89,6 +89,8 @@ export interface ProducerConfiguration {
 }
 export declare class KafkaConsumer {
   subscribe(topicConfigs: string | Array<TopicPartitionConfig>): Promise<void>
+  pause(): void
+  resume(): void
   unsubscribe(): void
   seek(topic: string, partition: number, offsetModel: OffsetModel, timeout?: number | undefined | null): void
   recv(): Promise<Message>

package/kafka-stream-readable.js

@@ -0,0 +1,73 @@
+const { Readable } = require('stream')
+
+const {
+  KafkaConsumer,
+  TopicPartitionConfig,
+} = require('./js-binding')
+
+/**
+ * KafkaStreamReadable class
+ * @extends Readable
+ */
+class KafkaStreamReadable extends Readable {
+  /**
+   * Creates a KafkaStreamReadable instance
+   * @param { KafkaConsumer } kafkaConsumer - The Kafka consumer instance
+   */
+  constructor(kafkaConsumer) {
+    super({ objectMode: true })
+    if (!kafkaConsumer) {
+      throw new Error('A valid KafkaConsumer instance is required.')
+    }
+    this.kafkaConsumer = kafkaConsumer
+  }
+
+  /**
+   * Subscribes to topics
+   * @param {string | Array<TopicPartitionConfig>} topics  - Topics to subscribe to
+   * @returns {Promise<void>} - A promise that resolves when the subscription is successful
+   */
+  async subscribe(topics) {
+    if (!topics || (Array.isArray(topics) && topics.length === 0)) {
+      throw new Error('Topics must be a non-empty string or array.')
+    }
+    await this.kafkaConsumer.subscribe(topics)
+  }
+
+  /**
+   * Unsubscribe from topics
+   * @returns {void}
+   */
+  unsubscribe() {
+    this.kafkaConsumer.unsubscribe()
+  }
+
+  /**
+   * Returns the raw Kafka consumer
+   * @returns {KafkaConsumer} The Kafka consumer instance
+   */
+  rawConsumer() {
+    return this.kafkaConsumer
+  }
+
+  /**
+   * Internal method called by the Readable stream to fetch data
+   * @private
+   */
+  async _read() {
+    try {
+      const message = await this.kafkaConsumer.recv() // Call the napi-rs method
+      if (message) {
+        this.push(message) // Push message into the stream
+      } else {
+        this.push(null) // No more data, end of stream
+      }
+    } catch (error) {
+      this.destroy(error)
+    }
+  }
+}
+
+module.exports = {
+  KafkaStreamReadable,
+}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "kafka-crab-js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "index.js",
   "types": "index.d.ts",
   "module": "commonjs",
   "files": [
     "index.d.ts",
     "index.js",
+    "kafka-stream-readable.js",
     "js-binding.js",
     "js-binding.d.ts"
   ],
@@ -60,8 +61,8 @@
   },
   "packageManager": "pnpm@9.14.2",
   "optionalDependencies": {
-    "kafka-crab-js-darwin-arm64": "1.0.0",
-    "kafka-crab-js-darwin-x64": "1.0.0",
-    "kafka-crab-js-linux-x64-gnu": "1.0.0"
+    "kafka-crab-js-darwin-arm64": "1.0.1",
+    "kafka-crab-js-darwin-x64": "1.0.1",
+    "kafka-crab-js-linux-x64-gnu": "1.0.1"
   }
 }