@platformatic/kafka 1.13.0 → 1.14.0

package/dist/apis/enumerations.d.ts

@@ -1,5 +1,12 @@
-export declare const SASLMechanisms: readonly ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512", "OAUTHBEARER"];
-export type SASLMechanism = (typeof SASLMechanisms)[number];
+export declare const SASLMechanisms: {
+    readonly PLAIN: "PLAIN";
+    readonly SCRAM_SHA_256: "SCRAM-SHA-256";
+    readonly SCRAM_SHA_512: "SCRAM-SHA-512";
+    readonly OAUTHBEARER: "OAUTHBEARER";
+};
+export declare const allowedSASLMechanisms: SASLMechanismValue[];
+export type SASLMechanism = keyof typeof SASLMechanisms;
+export type SASLMechanismValue = (typeof SASLMechanisms)[keyof typeof SASLMechanisms];
 export declare const FindCoordinatorKeyTypes: {
     readonly GROUP: 0;
     readonly TRANSACTION: 1;
@@ -11,11 +18,13 @@ export declare const ProduceAcks: {
     readonly NO_RESPONSE: 0;
     readonly LEADER: 1;
 };
+export declare const allowedProduceAcks: number[];
 export type ProduceAck = keyof typeof ProduceAcks;
 export declare const FetchIsolationLevels: {
     READ_UNCOMMITTED: number;
     READ_COMMITTED: number;
 };
+export declare const allowedFetchIsolationLevels: number[];
 export type FetchIsolationLevel = keyof typeof FetchIsolationLevels;
 export declare const ListOffsetTimestamps: {
     LATEST: bigint;

package/dist/apis/enumerations.js

@@ -1,5 +1,11 @@
 // SASL Authentication
-export const SASLMechanisms = ['PLAIN', 'SCRAM-SHA-256', 'SCRAM-SHA-512', 'OAUTHBEARER'];
+export const SASLMechanisms = {
+    PLAIN: 'PLAIN',
+    SCRAM_SHA_256: 'SCRAM-SHA-256',
+    SCRAM_SHA_512: 'SCRAM-SHA-512',
+    OAUTHBEARER: 'OAUTHBEARER'
+};
+export const allowedSASLMechanisms = Object.values(SASLMechanisms);
 // Metadata API
 // ./metadata/find-coordinator.ts
 export const FindCoordinatorKeyTypes = { GROUP: 0, TRANSACTION: 1, SHARE: 2 };
@@ -9,9 +15,11 @@ export const ProduceAcks = {
     NO_RESPONSE: 0,
     LEADER: 1
 };
+export const allowedProduceAcks = Object.values(ProduceAcks);
 // Consumer API
 // ./consumer/fetch.ts
 export const FetchIsolationLevels = { READ_UNCOMMITTED: 0, READ_COMMITTED: 1 };
+export const allowedFetchIsolationLevels = Object.values(FetchIsolationLevels);
 export const ListOffsetTimestamps = { LATEST: -1n, EARLIEST: -2n };
 // Admin API
 // ./admin/*-acls.ts - See: https://cwiki.apache.org/confluence/display/KAFKA/KIP-140%3A+Add+administrative+RPCs+for+adding%2C+deleting%2C+and+listing+ACLs

package/dist/clients/base/options.d.ts

@@ -88,7 +88,7 @@ export declare const baseOptionsSchema: {
             properties: {
                 mechanism: {
                     type: string;
-                    enum: readonly ["PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512", "OAUTHBEARER"];
+                    enum: import("../../apis/enumerations.ts").SASLMechanismValue[];
                 };
                 username: {
                     oneOf: ({

package/dist/clients/base/options.js

@@ -1,4 +1,4 @@
-import { SASLMechanisms } from "../../apis/enumerations.js";
+import { allowedSASLMechanisms } from "../../apis/enumerations.js";
 import { ajv } from "../../utils.js";
 import { version } from "../../version.js";
 // Note: clientSoftwareName can only contain alphanumeric characters, hyphens and dots
@@ -36,7 +36,7 @@ export const baseOptionsSchema = {
         sasl: {
             type: 'object',
             properties: {
-                mechanism: { type: 'string', enum: SASLMechanisms },
+                mechanism: { type: 'string', enum: allowedSASLMechanisms },
                 username: { oneOf: [{ type: 'string' }, { function: true }] },
                 password: { oneOf: [{ type: 'string' }, { function: true }] },
                 token: { oneOf: [{ type: 'string' }, { function: true }] },

package/dist/clients/consumer/messages-stream.js

@@ -39,7 +39,9 @@ export class MessagesStream extends Readable {
     #metricsConsumedMessages;
     #corruptedMessageHandler;
     constructor(consumer, options) {
-        const { autocommit, mode, fallbackMode, maxFetches, offsets, deserializers, onCorruptedMessage, ...otherOptions } = options;
+        const { autocommit, mode, fallbackMode, maxFetches, offsets, deserializers, onCorruptedMessage, 
+        // The options below are only destructured to avoid being part of structuredClone below
+        partitionAssigner: _partitionAssigner, ...otherOptions } = options;
         if (offsets && mode !== MessagesStreamModes.MANUAL) {
             throw new UserError('Cannot specify offsets when the stream mode is not MANUAL.');
         }

package/dist/clients/consumer/options.d.ts

@@ -93,7 +93,7 @@ export declare const consumeOptionsProperties: {
     };
     isolationLevel: {
         type: string;
-        enum: string[];
+        enum: number[];
     };
     deserializers: {
         type: string;
@@ -196,7 +196,7 @@ export declare const consumeOptionsSchema: {
         };
         isolationLevel: {
             type: string;
-            enum: string[];
+            enum: number[];
         };
         deserializers: {
             type: string;
@@ -275,11 +275,11 @@ export declare const consumeOptionsSchema: {
         };
         mode: {
             type: string;
-            enum: ("latest" | "earliest" | "committed" | "manual")[];
+            enum: import("./types.ts").MessagesStreamModeValue[];
         };
         fallbackMode: {
             type: string;
-            enum: ("latest" | "earliest" | "fail")[];
+            enum: import("./types.ts").MessagesStreamFallbackModeValue[];
         };
         maxFetches: {
             type: string;
@@ -340,7 +340,7 @@ export declare const consumerOptionsSchema: {
         };
         isolationLevel: {
             type: string;
-            enum: string[];
+            enum: number[];
         };
         deserializers: {
             type: string;
@@ -444,7 +444,7 @@ export declare const fetchOptionsSchema: {
         };
         isolationLevel: {
             type: string;
-            enum: string[];
+            enum: number[];
         };
         deserializers: {
             type: string;
@@ -639,7 +639,7 @@ export declare const listOffsetsOptionsSchema: {
         };
         isolationLevel: {
             type: string;
-            enum: string[];
+            enum: number[];
         };
         timestamp: {
             bigint: boolean;

package/dist/clients/consumer/options.js

@@ -1,8 +1,8 @@
-import { FetchIsolationLevels } from "../../apis/enumerations.js";
+import { allowedFetchIsolationLevels } from "../../apis/enumerations.js";
 import { ajv } from "../../utils.js";
 import { idProperty, topicWithPartitionAndOffsetProperties } from "../base/options.js";
 import { serdeProperties } from "../serde.js";
-import { MessagesStreamFallbackModes, MessagesStreamModes } from "./types.js";
+import { allowedMessagesStreamFallbackModes, allowedMessagesStreamModes } from "./types.js";
 export const groupOptionsProperties = {
     sessionTimeout: { type: 'number', minimum: 0 },
     rebalanceTimeout: { type: 'number', minimum: 0 },
@@ -56,7 +56,7 @@ export const consumeOptionsProperties = {
     minBytes: { type: 'number', minimum: 0 },
     maxBytes: { type: 'number', minimum: 0 },
     maxWaitTime: { type: 'number', minimum: 0 },
-    isolationLevel: { type: 'string', enum: Object.keys(FetchIsolationLevels) },
+    isolationLevel: { type: 'string', enum: allowedFetchIsolationLevels },
     deserializers: serdeProperties,
     highWaterMark: { type: 'number', minimum: 1 }
 };
@@ -69,8 +69,8 @@ export const consumeOptionsSchema = {
     type: 'object',
     properties: {
         topics: { type: 'array', items: idProperty },
-        mode: { type: 'string', enum: Object.values(MessagesStreamModes) },
-        fallbackMode: { type: 'string', enum: Object.values(MessagesStreamFallbackModes) },
+        mode: { type: 'string', enum: allowedMessagesStreamModes },
+        fallbackMode: { type: 'string', enum: allowedMessagesStreamFallbackModes },
         maxFetches: { type: 'number', minimum: 0, default: 0 },
         offsets: {
             type: 'array',
@@ -187,7 +187,7 @@ export const listOffsetsOptionsSchema = {
                 items: { type: 'number', minimum: 0 }
             }
         },
-        isolationLevel: { type: 'string', enum: Object.keys(FetchIsolationLevels) },
+        isolationLevel: { type: 'string', enum: allowedFetchIsolationLevels },
         timestamp: { bigint: true }
     },
     required: ['topics'],

package/dist/clients/consumer/types.d.ts

@@ -33,6 +33,7 @@ export declare const MessagesStreamModes: {
     readonly COMMITTED: "committed";
     readonly MANUAL: "manual";
 };
+export declare const allowedMessagesStreamModes: MessagesStreamModeValue[];
 export type MessagesStreamMode = keyof typeof MessagesStreamModes;
 export type MessagesStreamModeValue = (typeof MessagesStreamModes)[keyof typeof MessagesStreamModes];
 export declare const MessagesStreamFallbackModes: {
@@ -40,6 +41,7 @@ export declare const MessagesStreamFallbackModes: {
     readonly EARLIEST: "earliest";
     readonly FAIL: "fail";
 };
+export declare const allowedMessagesStreamFallbackModes: MessagesStreamFallbackModeValue[];
 export type MessagesStreamFallbackMode = keyof typeof MessagesStreamFallbackModes;
 export type MessagesStreamFallbackModeValue = (typeof MessagesStreamFallbackModes)[keyof typeof MessagesStreamFallbackModes];
 export interface GroupOptions {

package/dist/clients/consumer/types.js

@@ -4,8 +4,10 @@ export const MessagesStreamModes = {
     COMMITTED: 'committed',
     MANUAL: 'manual'
 };
+export const allowedMessagesStreamModes = Object.values(MessagesStreamModes);
 export const MessagesStreamFallbackModes = {
     LATEST: 'latest',
     EARLIEST: 'earliest',
     FAIL: 'fail'
 };
+export const allowedMessagesStreamFallbackModes = Object.values(MessagesStreamFallbackModes);

package/dist/clients/producer/options.d.ts

@@ -11,14 +11,14 @@ export declare const produceOptionsProperties: {
     acks: {
         type: string;
         enumeration: {
-            allowed: (0 | 1 | -1)[];
+            allowed: number[];
             errorMessage: string;
         };
     };
     compression: {
         type: string;
         enumeration: {
-            allowed: string[];
+            allowed: import("../../protocol/compression.ts").CompressionAlgorithmValue[];
             errorMessage: string;
         };
     };
@@ -47,14 +47,14 @@ export declare const produceOptionsSchema: {
         acks: {
             type: string;
             enumeration: {
-                allowed: (0 | 1 | -1)[];
+                allowed: number[];
                 errorMessage: string;
             };
         };
         compression: {
             type: string;
             enumeration: {
-                allowed: string[];
+                allowed: import("../../protocol/compression.ts").CompressionAlgorithmValue[];
                 errorMessage: string;
             };
         };
@@ -87,14 +87,14 @@ export declare const sendOptionsSchema: {
         acks: {
             type: string;
             enumeration: {
-                allowed: (0 | 1 | -1)[];
+                allowed: number[];
                 errorMessage: string;
             };
         };
         compression: {
             type: string;
             enumeration: {
-                allowed: string[];
+                allowed: import("../../protocol/compression.ts").CompressionAlgorithmValue[];
                 errorMessage: string;
             };
         };

package/dist/clients/producer/options.js

@@ -1,5 +1,5 @@
-import { ProduceAcks } from "../../apis/enumerations.js";
-import { compressionsAlgorithms } from "../../protocol/compression.js";
+import { allowedProduceAcks, ProduceAcks } from "../../apis/enumerations.js";
+import { allowedCompressionsAlgorithms, compressionsAlgorithms } from "../../protocol/compression.js";
 import { messageSchema } from "../../protocol/records.js";
 import { ajv, enumErrorMessage } from "../../utils.js";
 import { serdeProperties } from "../serde.js";
@@ -10,15 +10,15 @@ export const produceOptionsProperties = {
     acks: {
         type: 'number',
         enumeration: {
-            allowed: Object.values(ProduceAcks),
+            allowed: allowedProduceAcks,
             errorMessage: enumErrorMessage(ProduceAcks)
         }
     },
     compression: {
         type: 'string',
         enumeration: {
-            allowed: Object.keys(compressionsAlgorithms),
-            errorMessage: enumErrorMessage(compressionsAlgorithms, true)
+            allowed: allowedCompressionsAlgorithms,
+            errorMessage: enumErrorMessage(compressionsAlgorithms)
         }
     },
     partitioner: { function: true },

package/dist/network/connection.d.ts

@@ -3,7 +3,7 @@ import { type Socket } from 'node:net';
 import { type ConnectionOptions as TLSConnectionOptions } from 'node:tls';
 import { type CallbackWithPromise } from '../apis/callbacks.ts';
 import { type Callback, type ResponseParser } from '../apis/definitions.ts';
-import { type SASLMechanism } from '../apis/enumerations.ts';
+import { type SASLMechanismValue } from '../apis/enumerations.ts';
 import { Writer } from '../protocol/writer.ts';
 export type SASLCredentialProvider = () => string | Promise<string>;
 export interface Broker {
@@ -11,7 +11,7 @@ export interface Broker {
     port: number;
 }
 export interface SASLOptions {
-    mechanism: SASLMechanism;
+    mechanism: SASLMechanismValue;
     username?: string | SASLCredentialProvider;
     password?: string | SASLCredentialProvider;
     token?: string | SASLCredentialProvider;

package/dist/network/connection.js

@@ -3,7 +3,7 @@ import EventEmitter from 'node:events';
 import { createConnection } from 'node:net';
 import { connect as createTLSConnection } from 'node:tls';
 import { createPromisifiedCallback, kCallbackPromise } from "../apis/callbacks.js";
-import { SASLMechanisms } from "../apis/enumerations.js";
+import { allowedSASLMechanisms, SASLMechanisms } from "../apis/enumerations.js";
 import { saslAuthenticateV2, saslHandshakeV1 } from "../apis/index.js";
 import { connectionsApiChannel, connectionsConnectsChannel, createDiagnosticContext, notifyCreation } from "../diagnostic.js";
 import { AuthenticationError, NetworkError, TimeoutError, UnexpectedCorrelationIdError, UserError } from "../errors.js";
@@ -237,7 +237,7 @@ export class Connection extends EventEmitter {
             this.#status = ConnectionStatuses.AUTHENTICATING;
         }
         const { mechanism, username, password, token } = this.#options.sasl;
-        if (!SASLMechanisms.includes(mechanism)) {
+        if (!allowedSASLMechanisms.includes(mechanism)) {
             this.#onConnectionError(host, port, diagnosticContext, new UserError(`SASL mechanism ${mechanism} not supported.`));
             return;
         }
@@ -248,10 +248,10 @@ export class Connection extends EventEmitter {
             }
             this.emit('sasl:handshake', response.mechanisms);
             const callback = this.#onSaslAuthenticate.bind(this, host, port, diagnosticContext);
-            if (mechanism === 'PLAIN') {
+            if (mechanism === SASLMechanisms.PLAIN) {
                 saslPlain.authenticate(saslAuthenticateV2.api, this, username, password, callback);
             }
-            else if (mechanism === 'OAUTHBEARER') {
+            else if (mechanism === SASLMechanisms.OAUTHBEARER) {
                 saslOAuthBearer.authenticate(saslAuthenticateV2.api, this, token, callback);
             }
             else {
@@ -345,7 +345,7 @@ export class Connection extends EventEmitter {
     }
     #onSaslAuthenticationValidation(host, port, diagnosticContext, sessionLifetimeMs, error, authBytes) {
         if (error) {
-            this.#onConnectionError(host, port, diagnosticContext, error);
+            this.#onConnectionError(host, port, diagnosticContext, new AuthenticationError('SASL authentication failed.', { cause: error }));
             return;
         }
         if (sessionLifetimeMs > 0) {

package/dist/protocol/compression.d.ts

@@ -14,6 +14,7 @@ export declare const CompressionAlgorithms: {
     readonly LZ4: "lz4";
     readonly ZSTD: "zstd";
 };
+export declare const allowedCompressionsAlgorithms: CompressionAlgorithmValue[];
 export type CompressionAlgorithm = keyof typeof CompressionAlgorithms;
 export type CompressionAlgorithmValue = (typeof CompressionAlgorithms)[keyof typeof CompressionAlgorithms];
 export declare const compressionsAlgorithms: {

package/dist/protocol/compression.js

@@ -11,6 +11,7 @@ export const CompressionAlgorithms = {
     LZ4: 'lz4',
     ZSTD: 'zstd'
 };
+export const allowedCompressionsAlgorithms = Object.values(CompressionAlgorithms);
 function ensureBuffer(data) {
     return DynamicBuffer.isDynamicBuffer(data) ? data.slice() : data;
 }

package/dist/protocol/sasl/oauth-bearer.js

@@ -2,9 +2,12 @@ import { createPromisifiedCallback, kCallbackPromise } from "../../apis/callback
 import { AuthenticationError } from "../../errors.js";
 import { getCredential } from "./credential-provider.js";
 export function jwtValidateAuthenticationBytes(authBytes, callback) {
-    let authData;
+    let authData = {};
     try {
-        authData = authBytes.length > 0 ? JSON.parse(authBytes.toString('utf-8')) : {};
+        if (authBytes.length > 0) {
+            authData = JSON.parse(authBytes.toString('utf-8'));
+        }
+        /* c8 ignore next 8  - Hard to test */
     }
     catch (e) {
         callback(new AuthenticationError('Invalid authBytes in SASL/OAUTHBEARER response', { authBytes }), undefined);

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/kafka",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "Modern and performant client for Apache Kafka",
   "homepage": "https://github.com/platformatic/kafka",
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
@@ -69,12 +69,12 @@
     "lint": "eslint --cache",
     "typecheck": "tsc -p . --noEmit",
     "format": "prettier -w benchmarks playground src test",
-    "test": "c8 -c test/config/c8-local.json node --env-file=test/config/env --no-warnings --test --test-timeout=300000 'test/**/*.test.ts'",
-    "test:ci": "c8 -c test/config/c8-ci.json node --env-file=test/config/env --no-warnings --test --test-timeout=300000 'test/**/*.test.ts'",
+    "test": "c8 -c test/config/c8-local.json node --env-file=test/config/env --no-warnings --test --test-timeout=600000 'test/**/*.test.ts'",
+    "test:ci": "c8 -c test/config/c8-ci.json node --env-file=test/config/env --no-warnings --test --test-timeout=600000 'test/**/*.test.ts'",
     "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",
-    "ci:v20": "npm run lint && rm -rf dist && tsc -p tsconfig.json && node dist/scripts/postbuild.js && cd dist && c8 -c ../test/config/c8-ci.json node --env-file=../test/config/env --no-warnings --test --test-timeout=300000",
+    "ci:v20": "npm run lint && rm -rf dist && tsc -p tsconfig.json && node dist/scripts/postbuild.js && cd dist && c8 -c ../test/config/c8-ci.json node --env-file=../test/config/env --no-warnings --test --test-timeout=600000",
     "generate:apis": "node scripts/generate-apis.ts",
     "generate:errors": "node scripts/generate-errors.ts",
     "create:api": "node scripts/create-api.ts"