Merge pull request #966 from tulios/fix-aws-auth-types

Fix SaslOptions type for aws specific fields
tulios · Nov 19, 2020 · 2c55fc1 · 2c55fc1
2 parents d13acd5 + c8b428d
commit 2c55fc1
Showing 1 changed file with 10 additions and 7 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -41,19 +41,22 @@ export interface ISocketFactoryArgs {
 
 export type ISocketFactory = (args: ISocketFactoryArgs) => net.Socket
 
-export type SASLMechanism = 'plain' | 'scram-sha-256' | 'scram-sha-512' | 'aws' | 'oauthbearer'
-
 export interface OauthbearerProviderResponse {
   value: string
 }
 
-export interface SASLOptions {
-  mechanism: SASLMechanism
-  username?: string
-  password?: string
-  oauthBearerProvider?: () => Promise<OauthbearerProviderResponse>
+type SASLMechanismOptionsMap = {
+  'plain': { username: string, password: string },
+  'scram-sha-256': { username: string, password: string },
+  'scram-sha-512': { username: string, password: string },
+  'aws': { authorizationIdentity: string, accessKeyId: string, secretAccessKey: string, sessionToken?: string },
+  'oauthbearer': { oauthBearerProvider: () => Promise<OauthbearerProviderResponse> }
 }
 
+export type SASLMechanism = keyof SASLMechanismOptionsMap
+type SASLMechanismOptions<T> = T extends SASLMechanism ? { mechanism: T } & SASLMechanismOptionsMap[T] : never
+export type SASLOptions = SASLMechanismOptions<SASLMechanism>
+
 export interface ProducerConfig {
   createPartitioner?: ICustomPartitioner
   retry?: RetryOptions