@platformatic/kafka 2.7.0 → 2.9.0-alpha.1

package/dist/typescript-4/dist/apis/producer/produce-v6.d.ts

@@ -0,0 +1,29 @@
+import { type NullableString } from "../../protocol/definitions";
+import { type Reader } from "../../protocol/reader";
+import { type CreateRecordsBatchOptions, type MessageRecord } from "../../protocol/records";
+import { Writer } from "../../protocol/writer";
+export type ProduceRequest = Parameters<typeof createRequest>;
+export interface ProduceResponsePartitionRecordError {
+  batchIndex: number;
+  batchIndexErrorMessage: NullableString;
+}
+export interface ProduceResponsePartition {
+  index: number;
+  errorCode: number;
+  baseOffset: bigint;
+  logAppendTimeMs: bigint;
+  logStartOffset: bigint;
+  recordErrors: ProduceResponsePartitionRecordError[];
+  errorMessage: NullableString;
+}
+export interface ProduceResponseTopic {
+  name: string;
+  partitionResponses: ProduceResponsePartition[];
+}
+export interface ProduceResponse {
+  responses: ProduceResponseTopic[];
+  throttleTimeMs: number;
+}
+export declare function createRequest(acks: number | undefined, timeout: number | undefined, topicData: MessageRecord[], options?: Partial<CreateRecordsBatchOptions>): Writer;
+export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): ProduceResponse;
+export declare const api: import("../definitions").API<[acks: number | undefined, timeout: number | undefined, topicData: MessageRecord[], options?: Partial<CreateRecordsBatchOptions> | undefined], boolean | ProduceResponse>;

package/dist/typescript-4/dist/apis/producer/txn-offset-commit-v0.d.ts

@@ -0,0 +1,29 @@
+import { type NullableString } from "../../protocol/definitions";
+import { type Reader } from "../../protocol/reader";
+import { Writer } from "../../protocol/writer";
+export interface TxnOffsetCommitRequestPartition {
+  partitionIndex: number;
+  committedOffset: bigint;
+  committedLeaderEpoch: number;
+  committedMetadata?: NullableString;
+}
+export interface TxnOffsetCommitRequestTopic {
+  name: string;
+  partitions: TxnOffsetCommitRequestPartition[];
+}
+export type TxnOffsetCommitRequest = Parameters<typeof createRequest>;
+export interface TxnOffsetCommitResponsePartition {
+  partitionIndex: number;
+  errorCode: number;
+}
+export interface TxnOffsetCommitResponseTopic {
+  name: string;
+  partitions: TxnOffsetCommitResponsePartition[];
+}
+export interface TxnOffsetCommitResponse {
+  throttleTimeMs: number;
+  topics: TxnOffsetCommitResponseTopic[];
+}
+export declare function createRequest(transactionalId: string, groupId: string, producerId: bigint, producerEpoch: number, _generationId: number, _memberId: string, _groupInstanceId: NullableString, topics: TxnOffsetCommitRequestTopic[]): Writer;
+export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): TxnOffsetCommitResponse;
+export declare const api: import("../definitions").API<[transactionalId: string, groupId: string, producerId: bigint, producerEpoch: number, _generationId: number, _memberId: string, _groupInstanceId: NullableString, topics: TxnOffsetCommitRequestTopic[]], TxnOffsetCommitResponse>;

package/dist/typescript-4/dist/apis/producer/txn-offset-commit-v1.d.ts

@@ -0,0 +1,29 @@
+import { type NullableString } from "../../protocol/definitions";
+import { type Reader } from "../../protocol/reader";
+import { Writer } from "../../protocol/writer";
+export interface TxnOffsetCommitRequestPartition {
+  partitionIndex: number;
+  committedOffset: bigint;
+  committedLeaderEpoch: number;
+  committedMetadata?: NullableString;
+}
+export interface TxnOffsetCommitRequestTopic {
+  name: string;
+  partitions: TxnOffsetCommitRequestPartition[];
+}
+export type TxnOffsetCommitRequest = Parameters<typeof createRequest>;
+export interface TxnOffsetCommitResponsePartition {
+  partitionIndex: number;
+  errorCode: number;
+}
+export interface TxnOffsetCommitResponseTopic {
+  name: string;
+  partitions: TxnOffsetCommitResponsePartition[];
+}
+export interface TxnOffsetCommitResponse {
+  throttleTimeMs: number;
+  topics: TxnOffsetCommitResponseTopic[];
+}
+export declare function createRequest(transactionalId: string, groupId: string, producerId: bigint, producerEpoch: number, _generationId: number, _memberId: string, _groupInstanceId: NullableString, topics: TxnOffsetCommitRequestTopic[]): Writer;
+export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): TxnOffsetCommitResponse;
+export declare const api: import("../definitions").API<[transactionalId: string, groupId: string, producerId: bigint, producerEpoch: number, _generationId: number, _memberId: string, _groupInstanceId: NullableString, topics: TxnOffsetCommitRequestTopic[]], TxnOffsetCommitResponse>;

package/dist/typescript-4/dist/apis/producer/txn-offset-commit-v2.d.ts

@@ -0,0 +1,29 @@
+import { type NullableString } from "../../protocol/definitions";
+import { type Reader } from "../../protocol/reader";
+import { Writer } from "../../protocol/writer";
+export interface TxnOffsetCommitRequestPartition {
+  partitionIndex: number;
+  committedOffset: bigint;
+  committedLeaderEpoch: number;
+  committedMetadata?: NullableString;
+}
+export interface TxnOffsetCommitRequestTopic {
+  name: string;
+  partitions: TxnOffsetCommitRequestPartition[];
+}
+export type TxnOffsetCommitRequest = Parameters<typeof createRequest>;
+export interface TxnOffsetCommitResponsePartition {
+  partitionIndex: number;
+  errorCode: number;
+}
+export interface TxnOffsetCommitResponseTopic {
+  name: string;
+  partitions: TxnOffsetCommitResponsePartition[];
+}
+export interface TxnOffsetCommitResponse {
+  throttleTimeMs: number;
+  topics: TxnOffsetCommitResponseTopic[];
+}
+export declare function createRequest(transactionalId: string, groupId: string, producerId: bigint, producerEpoch: number, _generationId: number, _memberId: string, _groupInstanceId: NullableString, topics: TxnOffsetCommitRequestTopic[]): Writer;
+export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): TxnOffsetCommitResponse;
+export declare const api: import("../definitions").API<[transactionalId: string, groupId: string, producerId: bigint, producerEpoch: number, _generationId: number, _memberId: string, _groupInstanceId: NullableString, topics: TxnOffsetCommitRequestTopic[]], TxnOffsetCommitResponse>;

package/dist/typescript-4/dist/apis/security/index.d.ts

@@ -1,2 +1,5 @@
+export * as saslAuthenticateV0 from "./sasl-authenticate-v0";
+export * as saslAuthenticateV1 from "./sasl-authenticate-v1";
 export * as saslAuthenticateV2 from "./sasl-authenticate-v2";
+export * as saslHandshakeV0 from "./sasl-handshake-v0";
 export * as saslHandshakeV1 from "./sasl-handshake-v1";

package/dist/typescript-4/dist/apis/security/sasl-authenticate-v0.d.ts

@@ -0,0 +1,15 @@
+import { type NullableString } from "../../protocol/definitions";
+import { type Reader } from "../../protocol/reader";
+import { Writer } from "../../protocol/writer";
+import { type API } from "../definitions";
+export type SaslAuthenticateRequest = Parameters<typeof createRequest>;
+export interface SaslAuthenticateResponse {
+  errorCode: number;
+  errorMessage: NullableString;
+  authBytes: Buffer;
+  sessionLifetimeMs: bigint;
+}
+export type SASLAuthenticationAPI = API<[Buffer], SaslAuthenticateResponse>;
+export declare function createRequest(authBytes: Buffer): Writer;
+export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): SaslAuthenticateResponse;
+export declare const api: API<[authBytes: Buffer], SaslAuthenticateResponse>;

package/dist/typescript-4/dist/apis/security/sasl-authenticate-v1.d.ts

@@ -0,0 +1,15 @@
+import { type NullableString } from "../../protocol/definitions";
+import { type Reader } from "../../protocol/reader";
+import { Writer } from "../../protocol/writer";
+import { type API } from "../definitions";
+export type SaslAuthenticateRequest = Parameters<typeof createRequest>;
+export interface SaslAuthenticateResponse {
+  errorCode: number;
+  errorMessage: NullableString;
+  authBytes: Buffer;
+  sessionLifetimeMs: bigint;
+}
+export type SASLAuthenticationAPI = API<[Buffer], SaslAuthenticateResponse>;
+export declare function createRequest(authBytes: Buffer): Writer;
+export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): SaslAuthenticateResponse;
+export declare const api: API<[authBytes: Buffer], SaslAuthenticateResponse>;

package/dist/typescript-4/dist/apis/security/sasl-handshake-v0.d.ts

@@ -0,0 +1,10 @@
+import { type Reader } from "../../protocol/reader";
+import { Writer } from "../../protocol/writer";
+export type SaslHandshakeRequest = Parameters<typeof createRequest>;
+export interface SaslHandshakeResponse {
+  errorCode: number;
+  mechanisms: string[];
+}
+export declare function createRequest(mechanism: string): Writer;
+export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): SaslHandshakeResponse;
+export declare const api: import("../definitions").API<[mechanism: string], SaslHandshakeResponse>;

package/dist/typescript-4/dist/apis/tagged-fields.d.ts

@@ -0,0 +1,7 @@
+import { Reader } from "../protocol/reader";
+export type TaggedFieldHandler = (reader: Reader) => void;
+export type TaggedFieldHandlers = Readonly<Record<number, TaggedFieldHandler>>;
+/**
+ * Decodes known flexible-version tagged fields and skips fields the caller does not handle.
+ */
+export declare function readKnownTaggedFields(reader: Reader, handlers: TaggedFieldHandlers): void;

package/dist/typescript-4/dist/apis/telemetry/compression-types.d.ts

@@ -0,0 +1,8 @@
+export declare const TelemetryCompressionTypes: {
+  readonly NONE: 0;
+  readonly GZIP: 1;
+  readonly SNAPPY: 2;
+  readonly LZ4: 3;
+  readonly ZSTD: 4;
+};
+export type TelemetryCompressionType = (typeof TelemetryCompressionTypes)[keyof typeof TelemetryCompressionTypes];

package/dist/typescript-4/dist/apis/telemetry/get-telemetry-subscriptions-v0.d.ts

@@ -1,13 +1,14 @@
 import { type NullableString } from "../../protocol/definitions";
 import { type Reader } from "../../protocol/reader";
 import { Writer } from "../../protocol/writer";
+import { type TelemetryCompressionType } from "./compression-types";
 export type GetTelemetrySubscriptionsRequest = Parameters<typeof createRequest>;
 export interface GetTelemetrySubscriptionsResponse {
   throttleTimeMs: number;
   errorCode: number;
   clientInstanceId: string;
   subscriptionId: number;
-  acceptedCompressionTypes: number[];
+  acceptedCompressionTypes: TelemetryCompressionType[];
   pushIntervalMs: number;
   telemetryMaxBytes: number;
   deltaTemporality: boolean;

package/dist/typescript-4/dist/apis/telemetry/index.d.ts

@@ -1,3 +1,6 @@
+export { TelemetryCompressionTypes, type TelemetryCompressionType } from "./compression-types";
 export * as getTelemetrySubscriptionsV0 from "./get-telemetry-subscriptions-v0";
 export * as listClientMetricsResourcesV0 from "./list-client-metrics-resources-v0";
+export * as listConfigResourcesV1 from "./list-config-resources-v1";
+export * as listClientMetricsResourcesV1 from "./list-config-resources-v1";
 export * as pushTelemetryV0 from "./push-telemetry-v0";

package/dist/typescript-4/dist/apis/telemetry/list-client-metrics-resources-v0.d.ts

@@ -1,14 +1,16 @@
 import { type Reader } from "../../protocol/reader";
 import { Writer } from "../../protocol/writer";
+import { type ConfigResourceTypeValue } from "../enumerations";
 export type ListClientMetricsResourcesRequest = Parameters<typeof createRequest>;
 export interface ListClientMetricsResourcesResource {
-  name: string;
+  resourceName: string;
+  resourceType: ConfigResourceTypeValue;
 }
 export interface ListClientMetricsResourcesResponse {
   throttleTimeMs: number;
   errorCode: number;
-  clientMetricsResources: ListClientMetricsResourcesResource[];
+  configResources: ListClientMetricsResourcesResource[];
 }
-export declare function createRequest(): Writer;
+export declare function createRequest(_resourceTypes?: ConfigResourceTypeValue[]): Writer;
 export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): ListClientMetricsResourcesResponse;
-export declare const api: import("../definitions").API<[], ListClientMetricsResourcesResponse>;
+export declare const api: import("../definitions").API<[_resourceTypes?: ConfigResourceTypeValue[] | undefined], ListClientMetricsResourcesResponse>;

package/dist/typescript-4/dist/apis/telemetry/list-config-resources-v1.d.ts

@@ -0,0 +1,16 @@
+import { type Reader } from "../../protocol/reader";
+import { Writer } from "../../protocol/writer";
+import { type ConfigResourceTypeValue } from "../enumerations";
+export type ListConfigResourcesRequest = Parameters<typeof createRequest>;
+export interface ListConfigResourcesResource {
+  resourceName: string;
+  resourceType: ConfigResourceTypeValue;
+}
+export interface ListConfigResourcesResponse {
+  throttleTimeMs: number;
+  errorCode: number;
+  configResources: ListConfigResourcesResource[];
+}
+export declare function createRequest(resourceTypes?: ConfigResourceTypeValue[]): Writer;
+export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): ListConfigResourcesResponse;
+export declare const api: import("../definitions").API<[resourceTypes?: ConfigResourceTypeValue[] | undefined], ListConfigResourcesResponse>;

package/dist/typescript-4/dist/apis/telemetry/push-telemetry-v0.d.ts

@@ -1,10 +1,11 @@
 import { type Reader } from "../../protocol/reader";
 import { Writer } from "../../protocol/writer";
+import { type TelemetryCompressionType } from "./compression-types";
 export type PushTelemetryRequest = Parameters<typeof createRequest>;
 export interface PushTelemetryResponse {
   throttleTimeMs: number;
   errorCode: number;
 }
-export declare function createRequest(clientInstanceId: string, subscriptionId: number, terminating: boolean, compressionType: number, metrics: Buffer): Writer;
+export declare function createRequest(clientInstanceId: string, subscriptionId: number, terminating: boolean, compressionType: TelemetryCompressionType, metrics: Buffer): Writer;
 export declare function parseResponse(_correlationId: number, apiKey: number, apiVersion: number, reader: Reader): PushTelemetryResponse;
-export declare const api: import("../definitions").API<[clientInstanceId: string, subscriptionId: number, terminating: boolean, compressionType: number, metrics: Buffer], PushTelemetryResponse>;
+export declare const api: import("../definitions").API<[clientInstanceId: string, subscriptionId: number, terminating: boolean, compressionType: TelemetryCompressionType, metrics: Buffer], PushTelemetryResponse>;

package/dist/typescript-4/dist/clients/admin/options.d.ts

@@ -129,7 +129,7 @@ export declare const listGroupsOptionsSchema: {
       items: {
         type: string;
         enumeration: {
-          allowed: readonly ["PREPARING_REBALANCE", "COMPLETING_REBALANCE", "STABLE", "DEAD", "EMPTY"];
+          allowed: ("Unknown" | "PreparingRebalance" | "CompletingRebalance" | "Stable" | "Dead" | "Empty" | "Assigning" | "Reconciling" | "NotReady" | "PREPARING_REBALANCE" | "COMPLETING_REBALANCE" | "STABLE" | "DEAD" | "EMPTY")[];
           errorMessage: string;
         };
       };

package/dist/typescript-4/dist/clients/admin/types.d.ts

@@ -33,7 +33,7 @@ export interface GroupMember {
 export interface GroupBase {
   id: string;
   state: ConsumerGroupStateValue;
-  groupType: string;
+  groupType?: string;
   protocolType: string;
 }
 export interface Group extends Omit<GroupBase, 'groupType'> {

package/dist/typescript-4/dist/clients/base/base.d.ts

@@ -1,7 +1,7 @@
 import { type ValidateFunction } from 'ajv';
 import { type CallbackWithPromise } from "../../apis/callbacks";
 import { type API, type Callback } from "../../apis/definitions";
-import { type ApiVersionsResponseApi } from "../../apis/metadata/api-versions-v3";
+import { type ApiVersionsResponseApi } from "../../apis/metadata/api-versions-v1";
 import { type ClientType } from "../../diagnostic";
 import { TypedEventEmitter, type TypedEvents } from "../../events";
 import { ConnectionPool, type ConnectionPoolEventPayload } from "../../network/connection-pool";

package/dist/typescript-4/dist/clients/consumer/options.d.ts

@@ -372,6 +372,9 @@ export declare const consumeOptionsSchema: {
     onCorruptedMessage: {
       function: boolean;
     };
+    onDeserializationError: {
+      function: boolean;
+    };
   };
   required: string[];
   additionalProperties: boolean;

package/dist/typescript-4/dist/clients/consumer/types.d.ts

@@ -5,7 +5,7 @@ import { type ConnectionPool } from "../../network/connection-pool";
 import { type KafkaRecord, type Message } from "../../protocol/records";
 import { type SchemaRegistry } from "../../registries/abstract";
 import { type BaseOptions, type ClusterMetadata, type TopicWithPartitionAndOffset } from "../base/types";
-import { type BeforeDeserializationHook, type Deserializers } from "../serde";
+import { type BeforeDeserializationHook, type BeforeHookPayloadType, type Deserializers } from "../serde";
 export interface GroupProtocolSubscription {
   name: string;
   version: number;
@@ -32,6 +32,25 @@ export interface PreferredReadReplica {
   node: number;
   expiresAt: number;
 }
+export declare const DeserializationErrorActions: {
+  readonly FAIL: "fail";
+  readonly SKIP: "skip";
+};
+export type DeserializationErrorAction = (typeof DeserializationErrorActions)[keyof typeof DeserializationErrorActions];
+export interface DeserializationErrorContext {
+  error: unknown;
+  payloadType: BeforeHookPayloadType;
+  record: KafkaRecord;
+  topic: string;
+  partition: number;
+  offset: bigint;
+  timestamp: bigint;
+  commit: Message['commit'];
+}
+export type DeserializationErrorHandler = (context: DeserializationErrorContext) => DeserializationErrorAction;
+/**
+ * @deprecated Use `DeserializationErrorHandler` instead.
+ */
 export type CorruptedMessageHandler = (record: KafkaRecord, topic: string, partition: number, firstTimestamp: bigint, firstOffset: bigint, commit: Message['commit'], error: unknown) => boolean;
 export type GroupPartitionsAssigner = (current: string, members: Map<string, ExtendedGroupProtocolSubscription>, topics: Set<string>, metadata: ClusterMetadata) => GroupPartitionsAssignments[];
 export type GroupProtocolsMetadataCallback = (protocols: GroupProtocolSubscription[], topics: string[], metadata: ClusterMetadata, callback: Callback<Buffer>) => Buffer | Promise<Buffer> | undefined;
@@ -89,6 +108,10 @@ export interface StreamOptions {
   fallbackMode?: MessagesStreamFallbackModeValue;
   maxFetches?: number;
   offsets?: TopicWithPartitionAndOffset[];
+  onDeserializationError?: DeserializationErrorHandler;
+  /**
+   * @deprecated Use `onDeserializationError` instead.
+   */
   onCorruptedMessage?: CorruptedMessageHandler;
 }
 export type ConsumeOptions<Key, Value, HeaderKey, HeaderValue> = StreamOptions & ConsumeBaseOptions<Key, Value, HeaderKey, HeaderValue> & GroupOptions;

package/dist/typescript-4/dist/registries/confluent-schema-registry.d.ts

@@ -1,9 +1,9 @@
-import { type Options, type ValidateFunction } from 'ajv';
+import { type ErrorObject, type Options, type ValidateFunction } from 'ajv';
 import { type Type } from 'avsc';
 import { type Root } from 'protobufjs';
 import { type Callback } from "../apis/definitions";
 import { type BeforeDeserializationHook, type BeforeHookPayloadType, type BeforeSerializationHook, type Deserializers, type Serializers } from "../clients/serde";
-import { type CredentialProvider } from "../index";
+import { type CredentialProvider, UserError } from "../index";
 import { type MessageToConsume, type MessageToProduce } from "../protocol/records";
 import { AbstractSchemaRegistry } from "./abstract";
 type ConfluentSchemaRegistryMessageToProduce = MessageToProduce<unknown, unknown, unknown, unknown>;
@@ -22,6 +22,28 @@ export interface ConfluentSchemaRegistryOptions {
   jsonValidateSend?: boolean;
   jsonAjvOptions?: Options;
 }
+export type SchemaValidationPhase = 'serialization' | 'deserialization';
+export interface SchemaValidationErrorProperties {
+  schemaId: number;
+  schemaType: 'json';
+  phase: SchemaValidationPhase;
+  payloadType: BeforeHookPayloadType;
+  type: BeforeHookPayloadType;
+  data: unknown;
+  headers?: ReadonlyMap<unknown, unknown>;
+  validationErrors: ErrorObject[] | null | undefined;
+}
+export declare class SchemaValidationError extends UserError {
+  readonly schemaId: number;
+  readonly schemaType: 'json';
+  readonly phase: SchemaValidationPhase;
+  readonly payloadType: BeforeHookPayloadType;
+  readonly type: BeforeHookPayloadType;
+  readonly data: unknown;
+  readonly headers?: ReadonlyMap<unknown, unknown>;
+  readonly validationErrors: ErrorObject[] | null | undefined;
+  constructor(message: string, properties: SchemaValidationErrorProperties);
+}
 export interface Schema {
   id: number;
   type: 'avro' | 'protobuf' | 'json';

package/dist/version.js

@@ -1,2 +1,2 @@
 export const name = "@platformatic/kafka";
-export const version = "2.7.0";
+export const version = "2.9.0-alpha.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/kafka",
-  "version": "2.7.0",
+  "version": "2.9.0-alpha.1",
   "description": "Modern and performant client for Apache Kafka",
   "homepage": "https://github.com/platformatic/kafka",
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
@@ -28,6 +28,7 @@
     "@platformatic/dynamic-buffer": "^0.3.1",
     "@platformatic/wasm-utils": "^0.2.1",
     "ajv": "^8.17.1",
+    "ajv-draft-04": "^1.0.0",
     "avsc": "^5.7.9",
     "debug": "^4.4.3",
     "fastq": "^1.19.1",
@@ -97,6 +98,7 @@
     "test:regression": "npm run test:integrity",
     "test:regression:all": "npm run test:integrity && npm run test:performance",
     "test:all": "npm test && npm run test:regression:all",
+    "test:compat": "./scripts/node --test --test-reporter=cleaner-spec-reporter 'test/integration/*.compat-test.ts'",
     "test:memory": "NODE_OPTIONS='--expose-gc' ./scripts/node --test --test-reporter=cleaner-spec-reporter 'test/**/*.memory-test.ts'",
     "test:docker:up": "docker-compose up -d --wait",
     "test:docker:down": "docker-compose down",