@platformatic/kafka 1.26.0 → 1.27.0-alpha.2

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

@@ -5,4 +5,5 @@ export * from "./utils";
 export * from "./network/index";
 export * from "./protocol/index";
 export * from "./apis/index";
-export * from "./clients/index";
+export * from "./clients/index";
+export * from "./registries/index";

package/dist/typescript-4/dist/network/connection.d.ts

@@ -20,18 +20,19 @@ export interface ConnectionEvents extends TypedEvents {
   'sasl:authentication:extended': (authBytes?: Buffer) => void;
   drain: () => void;
 }
-export type SASLCredentialProvider<T = string> = () => T | Promise<T>;
+export type CredentialProvider<T = string> = () => T | Promise<T>;
+export type SASLCredentialProvider<T> = CredentialProvider<T>;
 export interface Broker {
   host: string;
   port: number;
 }
-export type SASLCustomAuthenticator = (mechanism: SASLMechanismValue, connection: Connection, authenticate: SASLAuthenticationAPI, usernameProvider: string | SASLCredentialProvider | undefined, passwordProvider: string | SASLCredentialProvider | undefined, tokenProvider: string | SASLCredentialProvider | undefined, callback: CallbackWithPromise<SaslAuthenticateResponse>) => void;
+export type SASLCustomAuthenticator = (mechanism: SASLMechanismValue, connection: Connection, authenticate: SASLAuthenticationAPI, usernameProvider: string | CredentialProvider | undefined, passwordProvider: string | CredentialProvider | undefined, tokenProvider: string | CredentialProvider | undefined, callback: CallbackWithPromise<SaslAuthenticateResponse>) => void;
 export interface SASLOptions {
   mechanism: SASLMechanismValue;
-  username?: string | SASLCredentialProvider;
-  password?: string | SASLCredentialProvider;
-  token?: string | SASLCredentialProvider;
-  oauthBearerExtensions?: Record<string, string> | SASLCredentialProvider<Record<string, string>>;
+  username?: string | CredentialProvider;
+  password?: string | CredentialProvider;
+  token?: string | CredentialProvider;
+  oauthBearerExtensions?: Record<string, string> | CredentialProvider<Record<string, string>>;
   authenticate?: SASLCustomAuthenticator;
   authBytesValidator?: (authBytes: Buffer, callback: CallbackWithPromise<Buffer>) => void;
 }

package/dist/typescript-4/dist/protocol/records.d.ts

@@ -17,6 +17,7 @@ export interface MessageBase<Key = Buffer, Value = Buffer> {
 }
 export interface MessageToProduce<Key = Buffer, Value = Buffer, HeaderKey = Buffer, HeaderValue = Buffer> extends MessageBase<Key, Value> {
   headers?: Map<HeaderKey, HeaderValue> | Record<string, HeaderValue>;
+  metadata?: unknown;
 }
 export interface MessageConsumerMetadata {
   coordinatorId: number;
@@ -67,6 +68,10 @@ export interface KafkaRecord {
   value: Buffer;
   headers: [Buffer, Buffer][];
 }
+export interface MessageToConsume extends KafkaRecord {
+  topic: string;
+  partition: number;
+}
 export interface RecordsBatch {
   firstOffset: bigint;
   length: number;
@@ -85,24 +90,8 @@ export interface RecordsBatch {
 export declare const messageSchema: {
   type: string;
   properties: {
-    key: {
-      oneOf: ({
-        type: string;
-        buffer?: undefined;
-      } | {
-        buffer: boolean;
-        type?: undefined;
-      })[];
-    };
-    value: {
-      oneOf: ({
-        type: string;
-        buffer?: undefined;
-      } | {
-        buffer: boolean;
-        type?: undefined;
-      })[];
-    };
+    key: boolean;
+    value: boolean;
     headers: {
       anyOf: ({
         map: boolean;

package/dist/typescript-4/dist/protocol/sasl/oauth-bearer.d.ts

@@ -1,6 +1,6 @@
 import { type CallbackWithPromise } from "../../apis/callbacks";
 import { type SASLAuthenticationAPI, type SaslAuthenticateResponse } from "../../apis/security/sasl-authenticate-v2";
-import { type Connection, type SASLCredentialProvider } from "../../network/connection";
+import { type Connection, type CredentialProvider } from "../../network/connection";
 export declare function jwtValidateAuthenticationBytes(authBytes: Buffer, callback: CallbackWithPromise<Buffer>): void;
-export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, tokenOrProvider: string | SASLCredentialProvider, extensions: Record<string, string> | SASLCredentialProvider<Record<string, string>>, callback: CallbackWithPromise<SaslAuthenticateResponse>): void;
-export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, tokenOrProvider: string | SASLCredentialProvider, extensions: Record<string, string> | SASLCredentialProvider<Record<string, string>>): Promise<SaslAuthenticateResponse>;
+export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, tokenOrProvider: string | CredentialProvider, extensions: Record<string, string> | CredentialProvider<Record<string, string>>, callback: CallbackWithPromise<SaslAuthenticateResponse>): void;
+export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, tokenOrProvider: string | CredentialProvider, extensions: Record<string, string> | CredentialProvider<Record<string, string>>): Promise<SaslAuthenticateResponse>;

package/dist/typescript-4/dist/protocol/sasl/plain.d.ts

@@ -1,5 +1,5 @@
 import { type CallbackWithPromise } from "../../apis/callbacks";
 import { type SASLAuthenticationAPI, type SaslAuthenticateResponse } from "../../apis/security/sasl-authenticate-v2";
-import { type Connection, type SASLCredentialProvider } from "../../network/connection";
-export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, usernameProvider: string | SASLCredentialProvider, passwordProvider: string | SASLCredentialProvider, callback: CallbackWithPromise<SaslAuthenticateResponse>): void;
-export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, usernameProvider: string | SASLCredentialProvider, passwordProvider: string | SASLCredentialProvider): Promise<SaslAuthenticateResponse>;
+import { type Connection, type CredentialProvider } from "../../network/connection";
+export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, usernameProvider: string | CredentialProvider, passwordProvider: string | CredentialProvider, callback: CallbackWithPromise<SaslAuthenticateResponse>): void;
+export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, usernameProvider: string | CredentialProvider, passwordProvider: string | CredentialProvider): Promise<SaslAuthenticateResponse>;

package/dist/typescript-4/dist/protocol/sasl/scram-sha.d.ts

@@ -1,6 +1,6 @@
 import { type CallbackWithPromise } from "../../apis/callbacks";
 import { type SASLAuthenticationAPI, type SaslAuthenticateResponse } from "../../apis/security/sasl-authenticate-v2";
-import { type Connection, type SASLCredentialProvider } from "../../network/connection";
+import { type Connection, type CredentialProvider } from "../../network/connection";
 export interface ScramAlgorithmDefinition {
   keyLength: number;
   algorithm: string;
@@ -35,5 +35,5 @@ export declare function hi(definition: ScramAlgorithmDefinition, password: strin
 export declare function hmac(definition: ScramAlgorithmDefinition, key: Buffer, data: string | Buffer): Buffer;
 export declare function xor(a: Buffer, b: Buffer): Buffer;
 export declare const defaultCrypto: ScramCryptoModule;
-export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, algorithm: ScramAlgorithm, usernameProvider: string | SASLCredentialProvider, passwordProvider: string | SASLCredentialProvider, crypto: ScramCryptoModule, callback: CallbackWithPromise<SaslAuthenticateResponse>): void;
-export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, algorithm: ScramAlgorithm, usernameProvider: string | SASLCredentialProvider, passwordProvider: string | SASLCredentialProvider, crypto?: ScramCryptoModule): Promise<SaslAuthenticateResponse>;
+export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, algorithm: ScramAlgorithm, usernameProvider: string | CredentialProvider, passwordProvider: string | CredentialProvider, crypto: ScramCryptoModule, callback: CallbackWithPromise<SaslAuthenticateResponse>): void;
+export declare function authenticate(authenticateAPI: SASLAuthenticationAPI, connection: Connection, algorithm: ScramAlgorithm, usernameProvider: string | CredentialProvider, passwordProvider: string | CredentialProvider, crypto?: ScramCryptoModule): Promise<SaslAuthenticateResponse>;

package/dist/typescript-4/dist/protocol/sasl/utils.d.ts

@@ -1,4 +1,4 @@
 import { type CallbackWithPromise } from "../../apis/index";
-import { type SASLCredentialProvider } from "../../network/connection";
-export declare function getCredential<T>(label: string, credentialOrProvider: T | SASLCredentialProvider<T>, callback: CallbackWithPromise<T>): void;
-export declare function getCredential<T>(label: string, credentialOrProvider: T | SASLCredentialProvider<T>): Promise<T>;
+import { type CredentialProvider } from "../../network/connection";
+export declare function getCredential<T>(label: string, credentialOrProvider: T | CredentialProvider<T>, callback: CallbackWithPromise<T>): void;
+export declare function getCredential<T>(label: string, credentialOrProvider: T | CredentialProvider<T>): Promise<T>;

package/dist/typescript-4/dist/registries/abstract.d.ts

@@ -0,0 +1,22 @@
+import { type Callback } from "../apis/definitions";
+import { type BeforeDeserializationHook, type BeforeHookPayloadType, type BeforeSerializationHook, type Deserializers, type Serializers } from "../clients/serde";
+import { type MessageToProduce } from "../protocol/records";
+export interface SchemaRegistry<Id = unknown, Schema = unknown, Key = Buffer, Value = Buffer, HeaderKey = Buffer, HeaderValue = Buffer> {
+  get(id: Id): Schema | undefined;
+  fetch(id: Id, callback?: (error?: Error) => void): void | Promise<void>;
+  getSchemaId(payload: Buffer | MessageToProduce<Key, Value, HeaderKey, HeaderValue>, type?: BeforeHookPayloadType): Id;
+  getSerializers(): Serializers<Key, Value, HeaderKey, HeaderValue>;
+  getDeserializers(): Deserializers<Key, Value, HeaderKey, HeaderValue>;
+  getBeforeSerializationHook(): BeforeSerializationHook<Key, Value, HeaderKey, HeaderValue>;
+  getBeforeDeserializationHook(): BeforeDeserializationHook;
+}
+export declare function runAsyncSeries<V>(operation: (item: V, cb: Callback<void>) => void | Promise<void>, collection: V[], index: number, callback: Callback<void>): void;
+export declare class AbstractSchemaRegistry<Id = unknown, Schema = unknown, Key = Buffer, Value = Buffer, HeaderKey = Buffer, HeaderValue = Buffer> implements SchemaRegistry<Id, Schema, Key, Value, HeaderKey, HeaderValue> {
+  get(_: Id): Schema | undefined;
+  fetch(_i: unknown, _c?: (error?: Error) => void): void | Promise<void>;
+  getSchemaId(_p: Buffer | MessageToProduce<Key, Value, HeaderKey, HeaderValue>, _t?: BeforeHookPayloadType): Id;
+  getSerializers(): Serializers<Key, Value, HeaderKey, HeaderValue>;
+  getDeserializers(): Deserializers<Key, Value, HeaderKey, HeaderValue>;
+  getBeforeSerializationHook(): BeforeSerializationHook<Key, Value, HeaderKey, HeaderValue>;
+  getBeforeDeserializationHook(): BeforeDeserializationHook;
+}

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

@@ -0,0 +1,41 @@
+import { 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 MessageToConsume, type MessageToProduce } from "../protocol/records";
+import { AbstractSchemaRegistry } from "./abstract";
+type ConfluentSchemaRegistryMessageToProduce = MessageToProduce<unknown, unknown, unknown, unknown>;
+export interface ConfluentSchemaRegistryMetadata {
+  schemas?: Record<BeforeHookPayloadType, number>;
+}
+export type ConfluentSchemaRegistryProtobufTypeMapper = (id: number, type: BeforeHookPayloadType, context: ConfluentSchemaRegistryMessageToProduce | MessageToConsume) => string;
+export interface ConfluentSchemaRegistryOptions {
+  url: string;
+  auth?: {
+    username?: string | CredentialProvider;
+    password?: string | CredentialProvider;
+    token?: string | CredentialProvider;
+  };
+  protobufTypeMapper?: ConfluentSchemaRegistryProtobufTypeMapper;
+  jsonValidateSend?: boolean;
+}
+export interface Schema {
+  id: number;
+  type: 'avro' | 'protobuf' | 'json';
+  schema: Type | Root | ValidateFunction;
+}
+export declare function defaultProtobufTypeMapper(_: number, type: BeforeHookPayloadType, context: ConfluentSchemaRegistryMessageToProduce | MessageToConsume): string;
+export declare class ConfluentSchemaRegistry<Key = Buffer, Value = Buffer, HeaderKey = Buffer, HeaderValue = Buffer> extends AbstractSchemaRegistry<number | undefined, Schema, Key, Value, HeaderKey, HeaderValue> {
+  #private;
+  constructor(options: ConfluentSchemaRegistryOptions);
+  getSchemaId(message: Buffer | MessageToProduce<Key, Value, HeaderKey, HeaderValue>, type?: BeforeHookPayloadType): number | undefined;
+  get(id: number): Schema | undefined;
+  fetchSchema(id: number, callback: Callback<void>): Promise<void>;
+  getSerializers(): Serializers<Key, Value, HeaderKey, HeaderValue>;
+  getDeserializers(): Deserializers<Key, Value, HeaderKey, HeaderValue>;
+  getBeforeSerializationHook(): BeforeSerializationHook<Key, Value, HeaderKey, HeaderValue>;
+  getBeforeDeserializationHook(): BeforeDeserializationHook;
+}
+export {};

package/dist/typescript-4/dist/registries/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./abstract";
+export * from "./confluent-schema-registry";

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/kafka",
-  "version": "1.26.0",
+  "version": "1.27.0-alpha.2",
   "description": "Modern and performant client for Apache Kafka",
   "homepage": "https://github.com/platformatic/kafka",
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
@@ -34,6 +34,7 @@
   "optionalDependencies": {
     "@node-rs/crc32": "^1.10.6",
     "lz4-napi": "^2.9.0",
+    "protobufjs": "^8.0.0",
     "snappy": "^7.3.3"
   },
   "devDependencies": {
@@ -64,8 +65,8 @@
     "kerberos": "^2.2.2",
     "neostandard": "^0.12.2",
     "parse5": "^7.3.0",
-    "prettier": "^3.6.2",
-    "prettier-plugin-space-before-function-paren": "^0.0.8",
+    "prettier": "^3.8.1",
+    "prettier-plugin-space-before-function-paren": "^0.0.10",
     "prom-client": "^15.1.3",
     "semver": "^7.7.2",
     "table": "^6.9.0",