Merge branch 'master' into master

tulios · Oct 17, 2022 · ca37eb5 · ca37eb5
2 parents 7d57406 + 4abd8e4
commit ca37eb5
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+## [2.2.1] - 2022-10-13
+
+### Fixed
+  - Fixed Typescript definitions for custom authentication mechanisms #1459
+
 ## [2.2.0] - 2022-08-16
 
 ### Added

diff --git a/docs/CustomAuthenticationMechanism.md b/docs/CustomAuthenticationMechanism.md
@@ -24,13 +24,17 @@ configure your brokers.
 A custom authentication mechanism needs to fulfill the following interface:
 
 ```ts
+type SaslAuthenticateArgs<ParseResult> = {
+  request: SaslAuthenticationRequest
+  response?: SaslAuthenticationResponse<ParseResult>
+}
+
 type AuthenticationProviderArgs = {
   host: string
   port: number
   logger: Logger
   saslAuthenticate: <ParseResult>(
-    request: SaslAuthenticationRequest,
-    response?: SaslAuthenticationResponse<ParseResult>
+    args: SaslAuthenticateArgs<ParseResult>
   ) => Promise<ParseResult | void>
 }
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "kafkajs",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "A modern Apache Kafka client for node.js",
   "author": "Tulio Ornelas <[email protected]>",
   "main": "index.js",

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -28,13 +28,17 @@ export type Authenticator = {
   authenticate: () => Promise<void>
 }
 
+export type SaslAuthenticateArgs<ParseResult> = {
+  request: SaslAuthenticationRequest
+  response?: SaslAuthenticationResponse<ParseResult>
+}
+
 export type AuthenticationProviderArgs = {
   host: string
   port: number
   logger: Logger
   saslAuthenticate: <ParseResult>(
-    request: SaslAuthenticationRequest,
-    response?: SaslAuthenticationResponse<ParseResult>
+    args: SaslAuthenticateArgs<ParseResult>
   ) => Promise<ParseResult | void>
 }
 
@@ -259,7 +263,7 @@ export interface ReplicaAssignment {
 }
 
 export interface PartitionReassignment {
-  topic: string,
+  topic: string
   partitionAssignment: Array<ReplicaAssignment>
 }
 
@@ -694,7 +698,10 @@ export type Broker = {
     topics: PartitionReassignment[]
     timeout?: number
   }): Promise<any>
-  listPartitionReassignments(request: { topics?: TopicPartitions[]; timeout?: number }): Promise<ListPartitionReassignmentsResponse>
+  listPartitionReassignments(request: {
+    topics?: TopicPartitions[]
+    timeout?: number
+  }): Promise<ListPartitionReassignmentsResponse>
 }
 
 interface MessageSetEntry {