kafka-crab-js 1.0.0 → 1.0.2

package/index.d.ts

@@ -1,68 +1,4 @@
-/**
- * KafkaClient class
- */
-export class KafkaClient {
-    /**
-     * Creates a KafkaStreamReadable instance
-     * @param { KafkaConfiguration } config
-     */
-    constructor(config: KafkaConfiguration);
-    kafkaConfiguration: KafkaConfiguration;
-    kafkaClientConfig: KafkaClientConfig;
-    /**
-     * Creates a KafkaProducer instance
-     * @param { ProducerConfiguration | undefined } producerConfiguration
-     * @returns {KafkaProducer}
-     */
-    createProducer(producerConfiguration: ProducerConfiguration | undefined): KafkaProducer;
-    /**
-     * Creates a KafkaConsumer instance
-     * @param {ConsumerConfiguration } consumerConfiguration
-     * @returns {KafkaConsumer}
-     */
-    createConsumer(consumerConfiguration: ConsumerConfiguration): KafkaConsumer;
-    /**
-     * Creates a KafkaStreamReadable instance
-     * @param { ConsumerConfiguration } consumerConfiguration
-     * @returns {KafkaStreamReadable}
-     */
-    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 { ProducerConfiguration } from "./js-binding";
-import { ConsumerConfiguration } from "./js-binding";
-import { KafkaConfiguration } from "./js-binding";
-import { KafkaConsumer } from "./js-binding";
-import { CommitMode } from "./js-binding";
-import { PartitionPosition } from "./js-binding";
-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 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 { KafkaClient } from './kafka-client';
+export { KafkaStreamReadable } from './kafka-stream-readable';

package/index.js

@@ -1,116 +1,14 @@
-const { Readable } = require('stream')
-
-const {
-  ProducerConfiguration,
-  ConsumerConfiguration,
-  KafkaConfiguration,
-  KafkaConsumer,
-  CommitMode,
-  PartitionPosition,
-  SecurityProtocol,
-  KafkaClientConfig,
-  TopicPartitionConfig,
-  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
-    }
-  }
-}
-
-/**
- * KafkaClient class
- */
-class KafkaClient {
-  /**
-   * Creates a KafkaStreamReadable instance
-   * @param { KafkaConfiguration } config
-   */
-  constructor(config) {
-    this.kafkaConfiguration = config
-    this.kafkaClientConfig = new KafkaClientConfig(config)
-  }
-
-  /**
-   * Creates a KafkaProducer instance
-   * @param { ProducerConfiguration | undefined } producerConfiguration
-   * @returns {KafkaProducer}
-   */
-  createProducer(producerConfiguration) {
-    if (producerConfiguration) {
-      return this.kafkaClientConfig.createProducer(producerConfiguration)
-    }
-    return this.kafkaClientConfig.createProducer({})
-  }
-
-  /**
-   * Creates a KafkaConsumer instance
-   * @param {ConsumerConfiguration } consumerConfiguration
-   * @returns {KafkaConsumer}
-   */
-  createConsumer(consumerConfiguration) {
-    return this.kafkaClientConfig.createConsumer(consumerConfiguration)
-  }
-
-  /**
-   * Creates a KafkaStreamReadable instance
-   * @param { ConsumerConfiguration } consumerConfiguration
-   * @returns {KafkaStreamReadable}
-   */
-  createStreamConsumer(consumerConfiguration) {
-    return new KafkaStreamReadable(this.kafkaClientConfig.createConsumer(consumerConfiguration))
-  }
-}
-
-module.exports = {
-  KafkaClient,
-  KafkaStreamReadable,
-  ProducerConfiguration,
-  ConsumerConfiguration,
-  KafkaConfiguration,
-  KafkaConsumer,
-  CommitMode,
-  PartitionPosition,
-  SecurityProtocol,
-  KafkaClientConfig,
-  TopicPartitionConfig,
-  KafkaProducer,
-}
+"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;
+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, "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; } });
+var kafka_client_1 = require("./kafka-client");
+Object.defineProperty(exports, "KafkaClient", { enumerable: true, get: function () { return kafka_client_1.KafkaClient; } });
+var kafka_stream_readable_1 = require("./kafka-stream-readable");
+Object.defineProperty(exports, "KafkaStreamReadable", { enumerable: true, get: function () { return kafka_stream_readable_1.KafkaStreamReadable; } });

package/js-binding.d.ts

@@ -13,7 +13,7 @@ export interface RetryStrategy {
 }
 export enum CommitMode {
   Sync = 0,
-  Async = 1
+  Async = 1,
 }
 export interface ConsumerConfiguration {
   groupId: string
@@ -25,7 +25,7 @@ export interface ConsumerConfiguration {
 export enum PartitionPosition {
   Beginning = 'Beginning',
   End = 'End',
-  Stored = 'Stored'
+  Stored = 'Stored',
 }
 export interface OffsetModel {
   offset?: number
@@ -44,7 +44,7 @@ export enum SecurityProtocol {
   Plaintext = 'Plaintext',
   Ssl = 'Ssl',
   SaslPlaintext = 'SaslPlaintext',
-  SaslSsl = 'SaslSsl'
+  SaslSsl = 'SaslSsl',
 }
 export interface KafkaConfiguration {
   brokers: string
@@ -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/js-binding.js

@@ -63,7 +63,7 @@ switch (platform) {
     switch (arch) {
       case 'x64':
         localFileExisted = existsSync(
-          join(__dirname, 'kafka-crab-js.win32-x64-msvc.node')
+          join(__dirname, 'kafka-crab-js.win32-x64-msvc.node'),
         )
         try {
           if (localFileExisted) {
@@ -77,7 +77,7 @@ switch (platform) {
         break
       case 'ia32':
         localFileExisted = existsSync(
-          join(__dirname, 'kafka-crab-js.win32-ia32-msvc.node')
+          join(__dirname, 'kafka-crab-js.win32-ia32-msvc.node'),
         )
         try {
           if (localFileExisted) {
@@ -91,7 +91,7 @@ switch (platform) {
         break
       case 'arm64':
         localFileExisted = existsSync(
-          join(__dirname, 'kafka-crab-js.win32-arm64-msvc.node')
+          join(__dirname, 'kafka-crab-js.win32-arm64-msvc.node'),
         )
         try {
           if (localFileExisted) {
@@ -132,7 +132,7 @@ switch (platform) {
         break
       case 'arm64':
         localFileExisted = existsSync(
-          join(__dirname, 'kafka-crab-js.darwin-arm64.node')
+          join(__dirname, 'kafka-crab-js.darwin-arm64.node'),
         )
         try {
           if (localFileExisted) {
@@ -168,7 +168,7 @@ switch (platform) {
       case 'x64':
         if (isMusl()) {
           localFileExisted = existsSync(
-            join(__dirname, 'kafka-crab-js.linux-x64-musl.node')
+            join(__dirname, 'kafka-crab-js.linux-x64-musl.node'),
           )
           try {
             if (localFileExisted) {
@@ -181,7 +181,7 @@ switch (platform) {
           }
         } else {
           localFileExisted = existsSync(
-            join(__dirname, 'kafka-crab-js.linux-x64-gnu.node')
+            join(__dirname, 'kafka-crab-js.linux-x64-gnu.node'),
           )
           try {
             if (localFileExisted) {
@@ -197,7 +197,7 @@ switch (platform) {
       case 'arm64':
         if (isMusl()) {
           localFileExisted = existsSync(
-            join(__dirname, 'kafka-crab-js.linux-arm64-musl.node')
+            join(__dirname, 'kafka-crab-js.linux-arm64-musl.node'),
           )
           try {
             if (localFileExisted) {
@@ -210,7 +210,7 @@ switch (platform) {
           }
         } else {
           localFileExisted = existsSync(
-            join(__dirname, 'kafka-crab-js.linux-arm64-gnu.node')
+            join(__dirname, 'kafka-crab-js.linux-arm64-gnu.node'),
           )
           try {
             if (localFileExisted) {
@@ -226,7 +226,7 @@ switch (platform) {
       case 'arm':
         if (isMusl()) {
           localFileExisted = existsSync(
-            join(__dirname, 'kafka-crab-js.linux-arm-musleabihf.node')
+            join(__dirname, 'kafka-crab-js.linux-arm-musleabihf.node'),
           )
           try {
             if (localFileExisted) {
@@ -239,7 +239,7 @@ switch (platform) {
           }
         } else {
           localFileExisted = existsSync(
-            join(__dirname, 'kafka-crab-js.linux-arm-gnueabihf.node')
+            join(__dirname, 'kafka-crab-js.linux-arm-gnueabihf.node'),
           )
           try {
             if (localFileExisted) {
@@ -255,7 +255,7 @@ switch (platform) {
       case 'riscv64':
         if (isMusl()) {
           localFileExisted = existsSync(
-            join(__dirname, 'kafka-crab-js.linux-riscv64-musl.node')
+            join(__dirname, 'kafka-crab-js.linux-riscv64-musl.node'),
           )
           try {
             if (localFileExisted) {
@@ -268,7 +268,7 @@ switch (platform) {
           }
         } else {
           localFileExisted = existsSync(
-            join(__dirname, 'kafka-crab-js.linux-riscv64-gnu.node')
+            join(__dirname, 'kafka-crab-js.linux-riscv64-gnu.node'),
           )
           try {
             if (localFileExisted) {
@@ -283,7 +283,7 @@ switch (platform) {
         break
       case 's390x':
         localFileExisted = existsSync(
-          join(__dirname, 'kafka-crab-js.linux-s390x-gnu.node')
+          join(__dirname, 'kafka-crab-js.linux-s390x-gnu.node'),
         )
         try {
           if (localFileExisted) {
@@ -310,7 +310,8 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { KafkaConsumer, CommitMode, PartitionPosition, SecurityProtocol, KafkaClientConfig, KafkaProducer } = nativeBinding
+const { KafkaConsumer, CommitMode, PartitionPosition, SecurityProtocol, KafkaClientConfig, KafkaProducer } =
+  nativeBinding
 
 module.exports.KafkaConsumer = KafkaConsumer
 module.exports.CommitMode = CommitMode

package/kafka-client.d.ts

@@ -0,0 +1,34 @@
+import { ConsumerConfiguration, KafkaConfiguration, ProducerConfiguration } from './js-binding.js';
+import { KafkaStreamReadable } from './kafka-stream-readable';
+/**
+ * KafkaClient class
+ */
+export declare class KafkaClient {
+    private readonly kafkaConfiguration;
+    private readonly kafkaClientConfig;
+    /**
+     * Creates a KafkaClient instance
+     * @throws {Error} If the configuration is invalid
+     */
+    constructor(kafkaConfiguration: KafkaConfiguration);
+    /**
+     * Creates a KafkaProducer instance
+     * @param {ProducerConfiguration} [producerConfiguration] - Optional producer configuration
+     * @returns {KafkaProducer} A KafkaProducer instance
+     */
+    createProducer(producerConfiguration: ProducerConfiguration): import("./js-binding.js").KafkaProducer;
+    /**
+     * Creates a KafkaConsumer instance
+     * @param {ConsumerConfiguration} consumerConfiguration - Consumer configuration
+     * @returns {KafkaConsumer} A KafkaConsumer instance
+     * @throws {Error} If the configuration is invalid
+     */
+    createConsumer(consumerConfiguration: ConsumerConfiguration): import("./js-binding.js").KafkaConsumer;
+    /**
+     * Creates a KafkaStreamReadable instance
+     * @param {ConsumerConfiguration} consumerConfiguration - Consumer configuration
+     * @returns {KafkaStreamReadable} A KafkaStreamReadable instance
+     * @throws {Error} If the configuration is invalid
+     */
+    createStreamConsumer(consumerConfiguration: ConsumerConfiguration): KafkaStreamReadable;
+}

package/kafka-client.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KafkaClient = void 0;
+const js_binding_js_1 = require("./js-binding.js");
+const kafka_stream_readable_1 = require("./kafka-stream-readable");
+/**
+ * KafkaClient class
+ */
+class KafkaClient {
+    /**
+     * Creates a KafkaClient instance
+     * @throws {Error} If the configuration is invalid
+     */
+    constructor(kafkaConfiguration) {
+        this.kafkaConfiguration = kafkaConfiguration;
+        this.kafkaClientConfig = new js_binding_js_1.KafkaClientConfig(kafkaConfiguration);
+    }
+    /**
+     * Creates a KafkaProducer instance
+     * @param {ProducerConfiguration} [producerConfiguration] - Optional producer configuration
+     * @returns {KafkaProducer} A KafkaProducer instance
+     */
+    createProducer(producerConfiguration) {
+        if (producerConfiguration) {
+            return this.kafkaClientConfig.createProducer(producerConfiguration);
+        }
+        return this.kafkaClientConfig.createProducer({});
+    }
+    /**
+     * Creates a KafkaConsumer instance
+     * @param {ConsumerConfiguration} consumerConfiguration - Consumer configuration
+     * @returns {KafkaConsumer} A KafkaConsumer instance
+     * @throws {Error} If the configuration is invalid
+     */
+    createConsumer(consumerConfiguration) {
+        return this.kafkaClientConfig.createConsumer(consumerConfiguration);
+    }
+    /**
+     * Creates a KafkaStreamReadable instance
+     * @param {ConsumerConfiguration} consumerConfiguration - Consumer configuration
+     * @returns {KafkaStreamReadable} A KafkaStreamReadable instance
+     * @throws {Error} If the configuration is invalid
+     */
+    createStreamConsumer(consumerConfiguration) {
+        return new kafka_stream_readable_1.KafkaStreamReadable(this.kafkaClientConfig.createConsumer(consumerConfiguration));
+    }
+}
+exports.KafkaClient = KafkaClient;

package/kafka-stream-readable.d.ts

@@ -0,0 +1,31 @@
+import { Readable } from 'stream';
+import { KafkaConsumer, TopicPartitionConfig } from './js-binding';
+/**
+ * KafkaStreamReadable class
+ * @extends Readable
+ */
+export declare class KafkaStreamReadable extends Readable {
+    private readonly kafkaConsumer;
+    /**
+     * Creates a KafkaStreamReadable instance
+     */
+    constructor(kafkaConsumer: KafkaConsumer);
+    /**
+     * Subscribes to topics
+     */
+    subscribe(topics: string | Array<TopicPartitionConfig>): Promise<void>;
+    /**
+     * Unsubscribe from topics
+     */
+    unsubscribe(): void;
+    /**
+     * Returns the raw Kafka consumer
+     * @returns {KafkaConsumer} The Kafka consumer instance
+     */
+    rawConsumer(): KafkaConsumer;
+    /**
+     * Internal method called by the Readable stream to fetch data
+     * @private
+     */
+    _read(): Promise<void>;
+}

package/kafka-stream-readable.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KafkaStreamReadable = void 0;
+const stream_1 = require("stream");
+/**
+ * KafkaStreamReadable class
+ * @extends Readable
+ */
+class KafkaStreamReadable extends stream_1.Readable {
+    /**
+     * Creates a KafkaStreamReadable instance
+     */
+    constructor(kafkaConsumer) {
+        super({ objectMode: true });
+        this.kafkaConsumer = kafkaConsumer;
+        if (!kafkaConsumer) {
+            throw new Error('A valid KafkaConsumer instance is required.');
+        }
+        this.kafkaConsumer = kafkaConsumer;
+    }
+    /**
+     * Subscribes to topics
+     */
+    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
+     */
+    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) {
+            if (error instanceof Error) {
+                this.destroy(error);
+            }
+            else {
+                this.destroy();
+            }
+        }
+    }
+}
+exports.KafkaStreamReadable = KafkaStreamReadable;

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "kafka-crab-js",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "index.js",
   "types": "index.d.ts",
   "module": "commonjs",
   "files": [
     "index.d.ts",
     "index.js",
+    "kafka-client.js",
+    "kafka-client.d.ts",
+    "kafka-stream-readable.js",
+    "kafka-stream-readable.d.ts",
     "js-binding.js",
     "js-binding.d.ts"
   ],
@@ -42,15 +46,18 @@
     "ava": "6.2.0",
     "dprint": "^0.47.5",
     "nanoid": "5.0.8",
-    "typescript": "5.6.3"
+    "typescript": "5.6.3",
+    "copyfiles": "^2.4.1",
+    "@types/copyfiles": "^2.4.4",
+    "rimraf": "^6.0.1"
   },
   "ava": {
     "timeout": "3m"
   },
   "scripts": {
     "artifacts": "napi artifacts",
-    "build": "napi build --js js-binding.js --dts js-binding.d.ts --no-const-enum --platform --release",
-    "postbuild": "tsc",
+    "build": "napi build --js js-src/js-binding.js --dts js-src/js-binding.d.ts --no-const-enum --platform --release",
+    "postbuild": "rimraf dist && tsc && copyfiles -f js-src/js-binding.d.ts js-src/js-binding.js ./dist/*.js ./dist/*.d.ts .",
     "build:debug": "napi build --platform",
     "prepublishOnly": "napi prepublish -t npm",
     "test": "ava",
@@ -60,8 +67,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.2",
+    "kafka-crab-js-darwin-x64": "1.0.2",
+    "kafka-crab-js-linux-x64-gnu": "1.0.2"
   }
 }