@ohos-ports/confluentinc-kafka-javascript 1.10.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,457 @@
+# confluent-kafka-javascript 1.10.0
+
+v1.10.0 is a feature release. It is supported for all usage.
+
+## Enhancements
+1. References librdkafka v2.15.0. Refer to the [librdkafka v2.15.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.15.0) for more information.
+2. Support for union-of-pools/auto-pool mapping for schema registry (#500)
+
+## Fixes
+1. Handle non-HTTP errors during retries (#499)
+
+
+# confluent-kafka-javascript 1.9.1
+
+v1.9.1 is a maintenance release. It is supported for all usage.
+
+## Enhancements
+1. References librdkafka v2.14.2. Refer to the [librdkafka v2.14.2 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.14.2) for more information.
+
+## Fixes
+1. Handle anyOf/allOf in JSON transforms (#479)
+2. Preserve custom subjectNameStrategy in serde constructors (#482)
+3. Correct the TypeScript return type of `admin.fetchTopicMetadata` to `Promise<Array<ITopicMetadata>>` (#367)
+4. Correct the TypeScript `MemberDescription` shape returned by `admin.describeGroups` so `assignment`/`targetAssignment` wrap a `topicPartitions` array and `memberAssignment`/`memberMetadata` are nullable (#487)
+5. Correct the TypeScript `FetchOffsetsPartition.error` type returned by `admin.fetchOffsets` to `LibrdKafkaError | null`, matching the runtime which always populates the field. It never returnes undefined. (#489)
+6. Correct broken "types" path so TS consumers get types (#484)
+7. Resolve IHeaders import for installed clients (#492)
+8. Fix error callback passing and object to the logger instead of a string (#483)
+9. Fix security vulnerabilities in dependencies (#478)
+10. Handle missing Protobuf message index bytes in ProtobufDeserializer (#481)
+
+
+# confluent-kafka-javascript 1.9.0
+
+v1.9.0 is a feature release. It is supported for all usage.
+
+## Enhancements
+1. References librdkafka v2.14.0. Refer to the [librdkafka v2.14.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.14.0) for more information.
+2. Add AssociatedNameStrategy (#454).
+3. Add enableAt to RuleSet (#470).
+
+
+# confluent-kafka-javascript 1.8.2
+
+v1.8.2 is a maintenance release. It is supported for all usage.
+
+## Enhancements
+
+1. Minor enhancement to JSON Schema validation reporting (#434)
+2. Minor upgrade axios to 1.13.5 (#447)
+
+## Fixes
+
+1. Fix security vulnerabilities in dependencies (#437)
+2. Process Avro arrays sequentially to avoid race conditions (#445)
+3. Add NULL checks to prevent segfaults when Kafka metadata contains NULL values during broker restarts. This fix adds comprehensive NULL safety checks for node pointers, partition leaders, ISR arrays, and replica arrays in the native C++ code, JavaScript wrapper, and TypeScript definitions.
+
+There was no v1.8.1 release.
+
+# confluent-kafka-javascript 1.8.0
+
+v1.8.0 is a feature release. It is supported for all usage.
+
+## Enhancements
+
+1. References librdkafka v2.13.0. Refer to the [librdkafka v2.13.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.13.0) for more information.
+2. Export CelExecutor/CelFieldExecutor in schemaregistry index.ts (#412).
+3. Minor improvement to rule failure message (#419).
+4. Prevent a condition that causes fetch failures when max
+   batch size is set or the default one and there's a low consumption 
+   rate (#418 @LucioFranco, #424).
+
+## Fixes
+
+1. fix(deps): update dependency validator to v13.15.22 [security] (#413).
+2. Prevent max message cache size reaching zero by having a minimum of 1 message per worker after the round up (#424).
+
+# confluent-kafka-javascript 1.7.0
+
+v1.7.0 is a feature release. It is supported for all usage.
+
+### Enhancements
+
+1. References librdkafka v2.12.1. Refer to the [librdkafka v2.12.1 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.12.1) for more information.
+2. Configurable batch size through the `js.consumer.max.batch.size` property 
+   and cache size through the `js.consumer.max.cache.size.per.worker.ms` 
+   property (#393).
+3. Statistics callback now available when using the promisified API with all
+   client types (#399).
+4. Fix for at-least-once guarantee not ensured in case a seek happens on one
+partition and there are messages being fetched about other partitions (#393).
+5. Avoid returning a negative lag in case there is no cached offset for 
+   the HWM (#406).
+
+# confluent-kafka-javascript 1.6.0
+
+v1.6.0 is a feature release. It is supported for all usage.
+
+### Enhancements
+
+1. References librdkafka v2.12.0. Refer to the [librdkafka v2.12.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.12.0) for more information.
+2. OAuth OIDC method example for Kafka metadata based authentication with
+  an Azure IMDS endpoint using an attached managed identity as principal (#377).
+
+
+# confluent-kafka-javascript 1.5.0
+
+v1.5.0 is a feature release. It is supported for all usage.
+
+### Enhancements
+
+1. Adds support for `highWatermark`, `offsetLag()`, and `offsetLagLow()` in `eachBatch` callback (#317).
+
+
+## Fixes
+
+1. Fix issue of delay of up to 5s in receiving messages after pause and resume, or seek (#285, #363).
+
+
+# confluent-kafka-javascript v1.4.1
+
+v1.4.1 is a maintenance release. It is supported for all usage.
+
+## Enhancements
+
+1. References librdkafka v2.11.1. Refer to the [librdkafka v2.11.1 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.11.1) for more information.
+
+
+# confluent-kafka-javascript v1.4.0
+
+v1.4.0 is a feature release. It is supported for all usage.
+
+## Enhancements
+
+1. References librdkafka v2.11.0. Refer to the [librdkafka v2.11.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.11.0) for more information.
+2. [KIP-848] `describeGroups()` now supports KIP-848 introduced `consumer` groups. Two new fields for consumer group type and target assignment have also been added. Type defines whether this group is a `classic` or `consumer` group. Target assignment is only valid for the `consumer` protocol and it defaults to being undefined (#329).
+3. [KIP-848] Admin API for listing consumer groups now has an optional filter to return only groups of given types (#328).
+4. Add support for Node v24 pre-built binaries (@weyert, #307, #337).
+
+
+# confluent-kafka-javascript v1.3.2
+
+v1.3.2 is a maintenance release. It is supported for all usage.
+
+## Enhancements
+
+1. References librdkafka v2.10.1. Refer to the [librdkafka v2.10.1 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.10.1) for more information.
+2. Support for schema id in header (#303)
+3. Add CEL support for Data Quality rules (#313)
+
+## Fixes
+
+1. Fix missing await during JSON deserialization (#301)
+2. Fix possible NPE in CSFLE executor (#305)
+
+
+# confluent-kafka-javascript v1.3.1
+
+v1.3.1 is a maintenance release. It is supported for all usage.
+
+## Fixes
+
+1. Avoid a race condition that causes 100% usage of a CPU core when
+   consuming with `partitionsConsumedConcurrently > 1` and all messages
+   are consumed (#300)
+2. Fix type definition for `Kafka()` constructor and for passing topic configurations
+   to the `producer()` and `consumer()` in the promisified API (@davidkhala, #297, #321).
+
+
+# confluent-kafka-javascript v1.3.0
+
+v1.3.0 is a feature release. It is supported for all usage.
+
+## Enhancements
+
+1. References librdkafka v2.10.0. Refer to the [librdkafka v2.10.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.10.0) for more information.
+
+## Fixes
+
+1. Support Protobuf oneof fields in Data Contract rules (#261)
+2. Ensure use of DEK object is thread-safe (#268)
+3. Fix token fetch to return after successful request (#278)
+4. Add loose OAuth authorization (#289)
+
+
+# confluent-kafka-javascript v1.2.0
+
+v1.2.0 is a feature release. It is supported for all usage.
+
+## Enhancements
+
+1. Add support for an Admin API to fetch topic offsets by timestamp (#206).
+2. References librdkafka v2.8.0. Refer to the [librdkafka v2.8.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.8.0) for more information.
+
+## Fixes
+
+1. Fixes an issue where the `eachBatch` callback was being called for the same partition concurrently (#224).
+2. Uses a Debian based builder instead of an Ubuntu based builder to ensure compatibility with older, but supported versions of Linux (#228).
+
+
+# confluent-kafka-javascript v1.1.0
+
+v1.1.0 is a feature release. It is supported for all usage.
+
+## Fixes
+
+1. Ensure algorithm query param is passed for CSFLE (#230)
+2. Handle records nested in arrays/maps when searching for tags (#231)
+
+
+# confluent-kafka-javascript v1.0.0
+
+v1.0.0 is a feature release. It is supported for all usage.
+
+## Enhancements
+
+1. Add support for an Admin API to fetch topic offsets (#156).
+2. Add support for Node v23 pre-built binaries (#158).
+3. Add KafkaJS-compatible errors to promisified Admin API (createTopics, deleteGroups, deleteTopicRecords) (#159).
+4. Include error types within Type definitions for promisified API (#210).
+
+## Fixes
+
+1. Fixes an issue where `uv_async_init` was being called off the event loop thread,
+   causing the node process to hang (#190).
+
+
+# confluent-kafka-javascript v0.6.1
+
+v0.6.1 is a limited availability maintenance release. It is supported for all usage.
+
+## Fixes
+
+### Schema Registry
+
+1. Sync aws-sdk packages to the same versioning.
+
+2. Minor enhancement to allow AWS profile to be specified.
+
+3. Add ability to override disable flag and actions on a rule.
+
+# confluent-kafka-javascript v0.6.0
+
+v0.6.0 is a limited availability maintenance release. It is supported for all usage.
+
+## Fixes
+
+### Schema Registry
+
+1. Add AWS AssumeRole support to AWS KMS. You can now specify a role arn, and optional
+role session name and optional role external id.
+
+2. Ensure different key ids use different client instances.
+
+# confluent-kafka-javascript v0.5.2
+
+v0.5.2 is a limited availability maintenance release. It is supported for all usage.
+
+Note: v0.5.2 has no code changes from v0.5.1, version is bumped to sync with @confluentinc/schemaregistry.
+
+
+# confluent-kafka-javascript v0.5.1
+
+v0.5.1 is a limited availability maintenance release. It is supported for all usage.
+
+## Fixes
+
+1. Fix an issue where `sendOffsets` wasn't working correctly in the transactional
+   producer (#172).
+
+
+# confluent-kafka-javascript v0.5.0
+
+v0.5.0 is a limited availability feature release. It is supported for all usage.
+
+Note: v0.5.0 was not released because of the bug mentioned in v0.5.1 section. Instead,
+      v0.5.1 was released with the fix directly.
+
+## Enhancements
+
+1. Add support for an Admin API to delete records.(#141).
+2. Add support for an Admin API to describe topics.(#155).
+3. Add support for dependent Admin client (#153).
+4. References librdkafka v2.6.1. Refer to the [librdkafka v2.6.1 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.6.1) for more information.
+
+## Fixes
+
+1. Fixes an issue with unresolved raced Promises leaking in the consumer (#151).
+2. Removes schemaregistry dependencies from root package.json to prevent issues with Node 18 (#162).
+
+
+# confluent-kafka-javascript v0.4.0
+
+v0.4.0 is a limited availability feature release. It is supported for all usage.
+
+## Enhancements
+
+1. Fixes an issue where headers were not passed correctly to the `eachBatch` callback (#130).
+2. Add support for an Admin API to list a consumer group's offsets (#49).
+3. Reduce consumer poll timeout to nil and add wakeups for new messages. This improves
+   the consumer efficiency, and resolves issues while running multiple consumers within
+   the same node process (#135).
+4. Add pre-built binaries for macOS (Intel).
+
+
+# confluent-kafka-javascript v0.3.0
+
+v0.3.0 is a limited availability feature release. It is supported for all usage.
+
+## Enhancements
+
+1. References librdkafka v2.6.0. Refer to the [librdkafka v2.6.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.6.0) for more information.
+1. Minor optimization to reduce schema ID lookups (#123).
+
+
+# confluent-kafka-javascript v0.2.1
+
+v0.2.1 is a limited availability release. It is supported for all usage.
+
+## Features
+
+1. Update README, docs, and examples for Confluent's Schema Registry client.
+
+
+# confluent-kafka-javascript v0.2.0
+
+v0.2.0 is a limited availability release. It is supported for all usage.
+
+## Features
+
+1. Switch to using `librdkafka` on the latest released tag `v2.5.3` instead of `master`.
+
+
+# confluent-kafka-javascript v0.1.17-devel
+
+v0.1.17-devel is a pre-production, early-access release.
+
+## Features
+
+1. Add a commitCb method to the callback-based API which allows committing asynchronously.
+2. Pass assign/unassign functions to the rebalance callback in the promisified API, allowing
+   the user to control the assignment of partitions, or pause just after a rebalance.
+3. Remove store from promisified API and let the library handle all the stores.
+4. Add JavaScript-level debug logging to the client for debugging issues within the binding.
+5. Various fixes for performance and robustness of the consumer cache.
+6. Remove `consumerGroupId` argument from the `sendOffsets` method of the transactional producer,
+   and instead, only allow using a `consumer`.
+
+## Fixes
+
+1. Do not modify RegExps which don't start with a ^, instead, throw an error so
+   that there is no unexpected behaviour for the user (Issue [#64](https://github.com/confluentinc/confluent-kafka-javascript/issues/64)).
+2. Do not mutate arguments in run, pause and resume (Issue [#61](https://github.com/confluentinc/confluent-kafka-javascript/issues/61)).
+3. Fix a segmentation fault in `listGroups` when passing `matchConsumerGroupStates` as undefined.
+
+
+# confluent-kafka-javascript v0.1.16-devel
+
+v0.1.16-devel is a pre-production, early-access release.
+
+## Features
+
+1. Add per-partition concurrency to consumer.
+2. Add true `eachBatch` support to consumer.
+3. Add a `leaderEpoch` field to the topic partitions where required (listing, committing, etc.).
+
+
+# confluent-kafka-javascript v0.1.15-devel
+
+v0.1.15-devel is a pre-production, early-access release.
+
+## Features
+
+1. Add Node v22 builds and bump librdkafka version on each version bump of this library.
+
+
+# confluent-kafka-javascript v0.1.14-devel
+
+v0.1.14-devel is a pre-production, early-access release.
+
+## Features
+
+1. Add metadata to offset commit and offset store (non-promisified API).
+2. Add types for logger and loglevel to configuration.
+3. Add Producer polling from background thread. This improves performance for cases when send is awaited on.
+4. Enable consume optimization from v0.1.13-devel (Features #2) by default for the promisified API.
+
+## Bug Fixes
+
+1. Fix issues with the header conversions from promisified API to the non-promisified API to match
+   the type signature and allow Buffers to be passed as header values in the C++ layer.
+
+
+# confluent-kafka-javascript v0.1.13-devel
+
+v0.1.13-devel is a pre-production, early-access release.
+
+## Features
+
+1. Add support for `storeOffsets` in the consumer API.
+2. Add optimization while consuming, in cases where the size of messages pending in our subscription is less than the consumer cache size.
+
+## Bug Fixes
+
+1. Fix memory leak in incremental assign (@martijnimhoff, #35).
+2. Fix various issues with typings, and reconcile typings, JavaScript code, and MIGRATION.md to be consistent.
+
+
+# confluent-kafka-javascript v0.1.12-devel
+
+v0.1.12-devel is a pre-production, early-access release.
+
+## Features
+
+1. Add support for `listTopics` in the Admin API.
+2. Add support for OAUTHBEARER token refresh callback for both promisified and non promisified API.
+
+## Bug Fixes
+
+1. Fix aliasing bug between `NodeKafka::Conf` and `RdKafka::ConfImpl`.
+2. Fix issue where `assign/unassign` were called instead of `incrementalAssign/incrementalUnassign` while using
+   the Cooperative Sticky assigner, and setting the `rebalance_cb` as a boolean rather than as a function.
+3. Fix memory leaks in Dispatcher and Conf (both leaked memory at client close).
+4. Fix type definitions and make `KafkaJS` and `RdKafka` separate namespaces, while maintaining compatibility
+   with node-rdkafka's type definitions.
+
+
+# confluent-kafka-javascript v0.1.11-devel
+
+v0.1.11-devel is a pre-production, early-access release.
+
+## Features
+
+1. Add support for `eachBatch` in the Consumer API (partial support for API compatibility).
+2. Add support for `listGroups`, `describeGroups` and `deleteGroups` in the Admin API.
+
+
+# confluent-kafka-javascript v0.1.10-devel
+
+v0.1.10-devel is a pre-production, early-access release.
+
+## Features
+
+1. Pre-built binaries for Windows (x64) added on an experimental basis.
+
+
+# confluent-kafka-javascript v0.1.9-devel
+
+v0.1.9-devel is a pre-production, early-access release.
+
+## Features
+
+1. Pre-built binaries for Linux (both amd64 and arm64, both musl and glibc), for macOS (m1), for node versions 18, 20 and 21.
+2. Promisified API for Consumer, Producer and Admin Client.
+3. Allow passing topic configuration properties via the global configuration block.
+4. Remove dependencies with security issues.
+5. Support for the Cooperative Sticky assignor.

package/LICENSE.kafkajs

@@ -0,0 +1,31 @@
+The promisified API (lib/kafkajs) is inspired by kafkajs (github.com/tulios/kafkajs).
+The promisified tests (test/promisified) are also adapted from there.
+Many error types are also adapted from there.
+The license notice is reproduced below.
+
+----
+
+The MIT License
+
+Copyright (c) 2018 Túlio Ornelas (ornelas.tulio@gmail.com)
+
+Permission is hereby granted, free of charge,
+to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to
+deal in the Software without restriction, including
+without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom
+the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/LICENSE.node-rdkafka

@@ -0,0 +1,25 @@
+This project is based on node-rdkafka (github.com/Blizzard/node-rdkafka).
+The license notice is reproduced below.
+
+--------
+
+The MIT License (MIT)
+Copyright (c) 2016 Blizzard Entertainment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

package/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2023 Confluent, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,133 @@
+Confluent's JavaScript Client for Apache Kafka®
+===============================================
+
+**confluent-kafka-javascript** is Confluent's JavaScript client for [Apache Kafka](http://kafka.apache.org/) and the
+[Confluent Platform](https://www.confluent.io/product/compare/). The goal is to provide an highly performant, reliable and easy to use JavaScript client that is based on [node-rdkafka](https://github.com/Blizzard/node-rdkafka) yet also API compatible with [KafkaJS](https://github.com/tulios/kafkajs) to provide flexibility to users and streamline migrations from other clients.
+
+Features:
+
+- **High performance** - confluent-kafka-javascript is a lightweight wrapper around
+[librdkafka](https://github.com/confluentinc/librdkafka), a finely tuned C
+client.
+
+- **Reliability** - There are a lot of details to get right when writing an Apache Kafka
+client. We get them right in one place (librdkafka) and leverage this work
+across all of our clients.
+
+- **Supported** - Commercial support is offered by [Confluent](https://confluent.io/).
+
+- **Future proof** - Confluent, founded by the
+creators of Kafka, is building a [streaming platform](https://www.confluent.io/product/)
+with Apache Kafka at its core. It's high priority for us that client features keep
+pace with core Apache Kafka and components of the [Confluent Platform](https://www.confluent.io/product/).
+
+This library leverages the work and concepts from two popular Apache Kafka JavaScript clients: [node-rdkafka](https://github.com/Blizzard/node-rdkafka) and [KafkaJS](https://github.com/tulios/kafkajs). The core is heavily based on the node-rdkafka library, which uses our own [librdkafka](https://github.com/confluentinc/librdkafka) library for core client functionality. However, we leverage a promisified API and a more idiomatic interface, similar to the one in KafkaJS, making it easy for developers to migrate and adopt this client depending on the patterns and interface they prefer. We're very happy to have been able to leverage the excellent work of the many authors of these libraries!
+
+To use **Schema Registry**, use the [@confluentinc/schemaregistry](https://www.npmjs.com/package/@confluentinc/schemaregistry) library that is compatible with this library. For a simple schema registry example, see [sr.js](https://github.com/confluentinc/confluent-kafka-javascript/blob/master/examples/kafkajs/sr.js).
+
+## Requirements
+
+The following configurations are supported:
+
+* Linux (x64 and arm64) - we support both musl and glibc based distributions:
+
+| Distribution                              | Supported Node Versions |
+| ----------------------------------------- | ----------------------- |
+| Debian Bullseye/Ubuntu 20.04              | 18, 20, 21, 22, 23, 24  |
+| Debian Bookworm/Ubuntu 22.04              | 18, 20, 21, 22, 23, 24  |
+| Alpine Linux 3.20+                        | 18, 20, 21, 22, 23, 24  |
+| AlmaLinux 9/Rocky Linux 9/CentOS Stream 9 | 18, 20, 21, 22, 23, 24  |
+
+Other distributions will probably work given a modern version of gcc/glibc, but we don't test the pre-built binaries with them.
+
+* macOS - arm64/m1. macOS (Intel) is supported on a best-effort basis. Node versions 18, 20, 21, 22, 23 and 24 are supported.
+* Windows - x64. Node versions 18, 20, 21, 22, 23 and 24 are supported.
+
+> [!WARNING]
+> Pre-built binary support will be dropped after the EOL of the node version or the OS.
+
+Installation on any of these platforms is meant to be seamless, without any C/C++ compilation required.
+
+```bash
+npm install @confluentinc/kafka-javascript
+```
+
+In case your system configuration is not within the supported ones, check the detailed [installation instructions](./INTRODUCTION.md#Installation-Instructions) for more information.
+
+Yarn and pnpm support is experimental.
+
+# Getting Started
+
+Below is a simple produce example using the promisified API.
+
+```javascript
+const { Kafka } = require('@confluentinc/kafka-javascript').KafkaJS;
+
+async function producerStart() {
+    const producer = new Kafka().producer({
+        'bootstrap.servers': '<fill>',
+        'security.protocol': 'SASL_SSL',
+        'sasl.mechanisms': 'PLAIN',
+        'sasl.username': '<fill>',
+        'sasl.password': '<fill>',
+    });
+
+    await producer.connect();
+    console.log("Connected successfully");
+
+    const res = []
+    for (let i = 0; i < 50; i++) {
+        res.push(producer.send({
+            topic: 'test-topic',
+            messages: [
+                { value: 'v', partition: 0, key: 'x' },
+            ]
+        }));
+    }
+    await Promise.all(res);
+
+    await producer.disconnect();
+    console.log("Disconnected successfully");
+}
+
+producerStart();
+```
+
+There are two variants of the API offered by this library. A promisified API and a callback-based API.
+
+1. If you're starting afresh, you should use the [promisified API](INTRODUCTION.md#promisified-api).
+2. If you're migrating from `kafkajs`, you can use the [migration guide](MIGRATION.md#kafkajs) to get started quickly.
+3. If you're migrating from `node-rdkafka`, you can use the [migration guide](MIGRATION.md#node-rdkafka).
+
+An in-depth reference may be found at [INTRODUCTION.md](INTRODUCTION.md).
+
+## Contributing
+
+Bug reports and feedback is appreciated in the form of Github Issues.
+For guidelines on contributing please see [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## Librdkafka Version
+
+| confluent-kafka-javascript | librdkafka |
+| -------------------------- | ---------- |
+| 1.0.0                      | 2.6.1      |
+| 1.2.0                      | 2.8.0      |
+| 1.3.0                      | 2.10.0     |
+| 1.3.1                      | 2.10.0     |
+| 1.3.2                      | 2.10.1     |
+| 1.4.0                      | 2.11.0     |
+| 1.4.1                      | 2.11.1     |
+| 1.5.0                      | 2.11.1     |
+| 1.6.0                      | 2.12.0     |
+| 1.7.0                      | 2.12.1     |
+| 1.8.0                      | 2.13.0     |
+| 1.8.2                      | 2.13.2     |
+| 1.9.0                      | 2.14.0     |
+| 1.9.1                      | 2.14.2     |
+| 1.10.0                     | 2.15.0     |
+
+This mapping is applicable if you're using a pre-built binary. Otherwise, you can check the librdkafka version with the following command:
+
+```bash
+node -e 'console.log(require("@confluentinc/kafka-javascript").librdkafkaVersion)'
+```