kafka-crab-js 0.2.0 → 0.3.0

package/README.md

@@ -1,7 +1,5 @@
 # Kafka Crab Js
 
-🚧 Project in Alpha Stage: API Subject to Breaking Changes 🚧
-
 Kafka-Crab-JS is a powerful Node.js library that allows developers to interact with Apache Kafka using Rust programming language, seamlessly integrated with Node.js applications. This documentation provides an overview of the Kafka-Crab-JS library, including installation instructions, usage guidelines, and examples.
 
 The plugin can be found on [npm](https://www.npmjs.com/package/kafka-crab-js) and the source code is available on [GitHub](https://github.com/inaiat/kafka-crab-js).

package/example/sample.mjs

@@ -1,29 +1,29 @@
 /* eslint-disable no-await-in-loop */
 
 import timersPromises from 'node:timers/promises';
-import {Buffer} from 'node:buffer';
-import {nanoid} from 'nanoid';
-import {KafkaClient, CommitMode, PartitionPosition, ConsumerResult} from '../index.js';
+import { Buffer } from 'node:buffer';
+import { nanoid } from 'nanoid';
+import { KafkaClient, CommitMode, PartitionPosition, ConsumerResult } from '../index.js';
 
 const kafkaClient = new KafkaClient({
   brokers: 'localhost:29092',
   clientId: 'my-js-group',
   logLevel: 'info',
-  enableAnsiLogger: true});
+});
 const topic = `topic-${nanoid()}`;
 
 const consumer = kafkaClient.createConsumer({
   topic,
   groupId: 'my-js-group',
-  CommitMode: CommitMode.AutoCommit,
-  offset: {position: PartitionPosition.Stored},
-  configuration: {'auto.offset.reset': 'earliest'},
+  commitMode: CommitMode.AutoCommit,
+  offset: { position: PartitionPosition.Stored },
+  configuration: { 'auto.offset.reset': 'earliest' },
   retryStrategy: {
     retries: 5,
     pauseConsumerDuration: 5000,
   },
 });
-const producer = kafkaClient.createProducer({topic, configuration: {'message.timeout.ms': '5000'}});
+const producer = kafkaClient.createProducer({ topic, configuration: { 'message.timeout.ms': '5000' } });
 
 async function produce() {
   for (let i = 0; i < 10; i++) {
@@ -31,7 +31,7 @@ async function produce() {
       const result = await producer.send(
         {
           topic,
-          messages: [{value: Buffer.from(`{"_id":"${i}","name":"Elizeu Drummond Sample js","phone":"555"}`)}],
+          messages: [{ value: Buffer.from(`{"_id":"${i}","name":"Elizeu Drummond Sample js","phone":"555"}`) }],
         },
       );
       console.log('Js message sent. Offset:', result);
@@ -42,7 +42,7 @@ async function produce() {
 }
 
 async function startConsumer() {
-  consumer.startConsumer(async (error, {value, partition, offset}) => {
+  consumer.startConsumer(async (error, { value, partition, offset }) => {
     if (error) {
       console.error('Js Consumer error', error);
       return;

package/index.d.ts

@@ -101,7 +101,7 @@ export class KafkaClient {
 }
 export class ProducerHelper { }
 export class KafkaConsumer {
-  startConsumer(callback: (err: Error | null, result: Payload) => Promise<ConsumerResult | undefined>): Promise<void>
+  startConsumer(callback: (error: Error | undefined, result: Payload) => Promise<ConsumerResult | undefined>): Promise<void>
 }
 export class KafkaProducer {
   send(producerRecord: ProducerRecord): Promise<Array<RecordMetadata>>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kafka-crab-js",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "main": "index.js",
   "types": "index.d.ts",
   "napi": {
@@ -41,7 +41,8 @@
   "xo": {
     "space": true,
     "rules": {
-      "new-cap": "off"
+      "new-cap": "off",
+      "object-curly-spacing": "off"
     }
   },
   "scripts": {
@@ -55,8 +56,8 @@
   },
   "packageManager": "yarn@3.6.0",
   "optionalDependencies": {
-    "kafka-crab-js-darwin-arm64": "0.2.0",
-    "kafka-crab-js-darwin-x64": "0.2.0",
-    "kafka-crab-js-linux-x64-gnu": "0.2.0"
+    "kafka-crab-js-darwin-arm64": "0.3.0",
+    "kafka-crab-js-darwin-x64": "0.3.0",
+    "kafka-crab-js-linux-x64-gnu": "0.3.0"
   }
 }

package/src/kafka/kafka_consumer.rs

@@ -150,7 +150,7 @@ impl KafkaConsumer {
   }
 
   #[napi(
-    ts_args_type = "callback: (err: Error | null, result: Payload) => Promise<ConsumerResult | undefined>"
+    ts_args_type = "callback: (error: Error | undefined, result: Payload) => Promise<ConsumerResult | undefined>"
   )]
   pub async fn start_consumer(&self, func: ThreadsafeFunction<Payload>) -> Result<()> {
     let ConsumerConfiguration { retry_strategy, .. } = self.consumer_configuration.clone();