Merge pull request #1459 from markgaylard/fix-custom-authenticator-types

Fix saslAuthenticate parameter type definitions
tulios · Oct 13, 2022 · b5db7ab · b5db7ab
2 parents fd28b46 + 8816d9b
commit b5db7ab
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 6 deletions.
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/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 {