@platformatic/kafka 1.10.0 → 1.11.0

package/README.md

@@ -281,7 +281,28 @@ Many of the methods accept the same options as the client's constructors. The co
 
 ## Requirements
 
-- Node.js >= 22.14.0
+Node.js LTS versions: 
+
+- `20.19.4` or above
+- `22.18.0` or above
+- `24.6.0` or above
+
+## Testing
+
+To setup the local environment for testing
+
+```bash
+cd docker
+cp .env.sample .env
+```
+
+Edit .env file as needed, enabling or not `JAVA_OPTIONS`
+
+Start Kafka cluster locally
+
+```bash
+docker compose -f compose-local.yml up -d
+```
 
 ## License
 

package/dist/apis/callbacks.js

@@ -1,4 +1,5 @@
 import { MultipleErrors } from "../errors.js";
+import { PromiseWithResolvers } from "../utils.js";
 export const kCallbackPromise = Symbol('plt.kafka.callbackPromise');
 // This is only meaningful for testing
 export const kNoopCallbackReturnValue = Symbol('plt.kafka.noopCallbackReturnValue');
@@ -6,7 +7,7 @@ export const noopCallback = () => {
     return Promise.resolve(kNoopCallbackReturnValue);
 };
 export function createPromisifiedCallback() {
-    const { promise, resolve, reject } = Promise.withResolvers();
+    const { promise, resolve, reject } = PromiseWithResolvers();
     function callback(error, payload) {
         if (error) {
             reject(error);

package/dist/errors.d.ts

@@ -10,7 +10,7 @@ export declare class GenericError extends Error {
     code: string;
     [index: string]: any;
     [kGenericError]: true;
-    static isGenericError(error: Error): boolean;
+    static isGenericError(error: Error): error is GenericError | MultipleErrors;
     constructor(code: ErrorCode, message: string, { cause, ...rest }?: ErrorProperties);
     findBy<ErrorType extends GenericError = GenericError>(property: string, value: unknown): ErrorType | null;
 }
@@ -20,8 +20,8 @@ export declare class MultipleErrors extends AggregateError {
     [kGenericError]: true;
     [kMultipleErrors]: true;
     static code: ErrorCode;
-    static isGenericError(error: Error): boolean;
-    static isMultipleErrors(error: Error): boolean;
+    static isGenericError(error: Error): error is GenericError | MultipleErrors;
+    static isMultipleErrors(error: Error): error is MultipleErrors;
     constructor(message: string, errors: Error[], { cause, ...rest }?: ErrorProperties);
     findBy<ErrorType extends GenericError | MultipleErrors = MultipleErrors>(property: string, value: unknown): ErrorType | null;
 }

package/dist/protocol/compression.js

@@ -3,7 +3,6 @@ import zlib from 'node:zlib';
 import { UnsupportedCompressionError } from "../errors.js";
 import { DynamicBuffer } from "./dynamic-buffer.js";
 const require = createRequire(import.meta.url);
-// @ts-ignore - Added in Node.js 22.15.0
 const { zstdCompressSync, zstdDecompressSync, gzipSync, gunzipSync } = zlib;
 function ensureBuffer(data) {
     return DynamicBuffer.isDynamicBuffer(data) ? data.slice() : data;

package/dist/utils.d.ts

@@ -15,6 +15,7 @@ export interface DataValidationContext {
 }
 export type DebugDumpLogger = (...args: any[]) => void;
 export { setTimeout as sleep } from 'node:timers/promises';
+export declare const PromiseWithResolvers: <T>() => PromiseWithResolvers<T>;
 export declare const ajv: Ajv2020;
 export declare const loggers: Record<string, debug.Debugger>;
 export declare class NumericMap extends Map<string, number> {

package/dist/utils.js

@@ -2,6 +2,17 @@ import { Ajv2020 } from 'ajv/dist/2020.js';
 import debug from 'debug';
 import { inspect } from 'node:util';
 export { setTimeout as sleep } from 'node:timers/promises';
+function PromiseWithResolversPolyfill() {
+    let resolve;
+    let reject;
+    const promise = new Promise((_resolve, _reject) => {
+        resolve = _resolve;
+        reject = _reject;
+    });
+    // @ts-expect-error - resolve and reject are assigned in the promise constructor
+    return { promise, resolve, reject };
+}
+export const PromiseWithResolvers = Promise.withResolvers ? Promise.withResolvers.bind(Promise) : PromiseWithResolversPolyfill;
 export const ajv = new Ajv2020({ allErrors: true, coerceTypes: false, strict: true });
 export const loggers = {
     protocol: debug('plt:kafka:protocol'),

package/dist/version.js

@@ -1,2 +1,2 @@
 export const name = "@platformatic/kafka";
-export const version = "1.10.0";
+export const version = "1.11.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/kafka",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Modern and performant client for Apache Kafka",
   "homepage": "https://github.com/platformatic/kafka",
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
@@ -38,7 +38,7 @@
   "devDependencies": {
     "@platformatic/rdkafka": "^4.0.0",
     "@types/debug": "^4.1.12",
-    "@types/node": "^22.13.5",
+    "@types/node": "^22.17.2",
     "@types/semver": "^7.7.0",
     "@watchable/unpromise": "^1.0.2",
     "avsc": "^5.7.7",
@@ -61,11 +61,11 @@
     "typescript": "^5.7.3"
   },
   "engines": {
-    "node": ">= 22.14.0"
+    "node": ">= 20.19.4 || >= 22.18.0 || >= 24.6.0"
   },
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.base.json",
-    "postbuild": "node --experimental-strip-types scripts/postbuild.ts",
+    "postbuild": "node scripts/postbuild.ts",
     "lint": "eslint --cache",
     "typecheck": "tsc -p . --noEmit",
     "format": "prettier -w benchmarks playground src test",
@@ -74,8 +74,12 @@
     "test:docker:up": "node scripts/docker.ts up -d --wait",
     "test:docker:down": "node scripts/docker.ts down",
     "ci": "npm run build && npm run lint && npm run test:ci",
-    "generate:apis": "node --experimental-strip-types scripts/generate-apis.ts",
-    "generate:errors": "node --experimental-strip-types scripts/generate-errors.ts",
-    "create:api": "node --experimental-strip-types scripts/create-api.ts"
+    "generate:apis": "node scripts/generate-apis.ts",
+    "generate:errors": "node scripts/generate-errors.ts",
+    "create:api": "node scripts/create-api.ts",
+    "build:v20": "rm -rf dist && tsc -p tsconfig.json",
+    "postbuild:v20": "cp package.json dist/package.json && node dist/scripts/postbuild.js",
+    "test:v20": "npm run build:v20 && cp -R test/fixtures dist/test/fixtures && node --env-file=test/config/env --no-warnings --test --test-timeout=300000 dist/test/**/*.test.js",
+    "test:ci:v20": "npm run build:v20 && cp -R test/fixtures dist/test/fixtures && node --env-file=test/config/env --no-warnings --test --test-timeout=300000 dist/test/**/*.test.js"
   }
 }