Fix types and add typescript examples

Author: milindl

examples/typescript/.gitignore

@@ -0,0 +1 @@
+*.js

examples/typescript/kafkajs.ts

@@ -0,0 +1,82 @@
+import { KafkaJS } from '@confluentinc/kafka-javascript';
+
+const bootstrapServer = '<fill>';
+
+async function runProducer() {
+    const kafka = new KafkaJS.Kafka({
+        kafkaJS: {
+            brokers: [bootstrapServer],
+        },
+    });
+
+    const producer = kafka.producer({
+        kafkaJS: {
+            allowAutoTopicCreation: true,
+            acks: 1,
+            compression: KafkaJS.CompressionTypes.GZIP,
+        }
+    });
+
+    await producer.connect();
+
+    await producer.send({
+        topic: 'test-topic',
+        messages: [
+            { value: 'Hello World!', key: 'key1' },
+        ],
+    });
+
+    await producer.disconnect();
+}
+
+async function runConsumer() {
+    const kafka = new KafkaJS.Kafka({
+        kafkaJS: {
+            brokers: [bootstrapServer],
+        },
+    });
+
+    const consumer = kafka.consumer({
+        kafkaJS: {
+            groupId: 'test-group' + Math.random(),
+            fromBeginning: true,
+            partitionAssigners: [KafkaJS.PartitionAssigners.roundRobin],
+        },
+    });
+
+    await consumer.connect();
+    await consumer.subscribe({ topic: 'test-topic' });
+
+    await consumer.run({
+        eachMessage: async ({ message }) => {
+            console.log({
+                key: message.key ? message.key.toString() : null,
+                value: message.value ? message.value.toString() : null,
+            });
+        },
+    });
+
+    await new Promise((resolve) => setTimeout(resolve, 30000));
+    await consumer.disconnect();
+}
+
+async function runAdminClient() {
+    const kafka = new KafkaJS.Kafka({
+        kafkaJS: {
+            brokers: [bootstrapServer],
+        },
+    });
+
+    const admin = kafka.admin()
+    await admin.connect();
+
+    await admin.createTopics({ topics: [{ topic: 'test-topic' }] });
+    console.log("Created topic");
+
+    await admin.disconnect();
+}
+
+runAdminClient()
+    .then(runProducer)
+    .then(runConsumer)
+    .catch(console.error);

examples/typescript/node-rdkafka.ts

@@ -0,0 +1,82 @@
+import * as RdKafka from '@confluentinc/kafka-javascript';
+
+const bootstrapServers = '<fill>';
+
+function runProducer() {
+    const producer = new RdKafka.Producer({
+        'bootstrap.servers': bootstrapServers,
+        'dr_msg_cb': true,
+    });
+
+    producer.connect();
+
+    producer.on('ready', () => {
+        console.log("Producer is ready");
+        producer.setPollInterval(100);
+        producer.produce('test-topic', null, Buffer.from('Hello World!'), null, Date.now());
+    });
+
+    producer.on('event.error', (err) => {
+        console.error(err);
+    });
+
+    producer.on('delivery-report', (err, report) => {
+        console.log("Delivery report received:");
+        console.log({err, report});
+        producer.disconnect(err => {
+            if (err)
+                console.log("Error disconnecting producer ", err);
+            console.log("Disconnected producer");
+        });
+    });
+}
+
+function runConsumer() {
+    const consumer = new RdKafka.KafkaConsumer({
+        'group.id': 'test-group',
+        'bootstrap.servers': bootstrapServers,
+    }, {
+        'auto.offset.reset': 'earliest',
+    });
+
+    consumer.connect();
+
+    consumer.on('ready', () => {
+        console.log("Consumer is ready");
+        consumer.subscribe(['test-topic']);
+        consumer.consume();
+    });
+
+    consumer.on('data', (data) => {
+        console.log("Received data");
+        console.log(data);
+    });
+
+    consumer.on('event.error', (err) => {
+        console.error(err);
+    });
+
+    setTimeout(() => consumer.disconnect(), 30000);
+}
+
+function runAdminClient() {
+    const admin = RdKafka.AdminClient.create({
+        "bootstrap.servers": bootstrapServers,
+    });
+
+    admin.createTopic({ topic: "test-topic", num_partitions: 1, replication_factor: 1 }, (err) => {
+        if (err) {
+            console.error(err);
+            admin.disconnect();
+            return;
+        }
+        console.log("Created topic");
+        admin.disconnect();
+    });
+
+}
+
+// As an example, run each with some time gap to allow the prior one to finish.
+runAdminClient();
+setTimeout(runProducer, 5000);
+setTimeout(runConsumer, 25000);

examples/typescript/package-lock.json

@@ -0,0 +1,19 @@
+{
+  "name": "typescript",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@confluentinc/kafka-javascript": "file:../..",
+    "node-rdkafka": "^2.18.0",
+    "typescript": "^5.4.4"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.5"
+  }
+}