address feedback

Author: deyaaeldeen

src/azure.ts

@@ -38,6 +38,7 @@ export interface AzureClientOptions extends ClientOptions {
 export class AzureOpenAI extends OpenAI {
   deploymentName: string | undefined;
   apiVersion: string = '';
+  override apiKey: string;
 
   /**
    * API Client for interfacing with the Azure OpenAI API.
@@ -109,16 +110,15 @@ export class AzureOpenAI extends OpenAI {
     }
 
     super({
-      apiKey,
+      apiKey: !azureADTokenProvider ? apiKey : async () => ({ token: await azureADTokenProvider() }),
       baseURL,
-      tokenProvider:
-        !azureADTokenProvider ? undefined : async () => ({ token: await azureADTokenProvider() }),
       ...opts,
       ...(dangerouslyAllowBrowser !== undefined ? { dangerouslyAllowBrowser } : {}),
     });
 
     this.apiVersion = apiVersion;
     this.deploymentName = deployment;
+    this.apiKey = apiKey ?? 'PLACEHOLDER_FOR_AZURE_AD_TOKEN_PROVIDER';
   }
 
   override async buildRequest(

src/beta/realtime/websocket.ts

@@ -39,8 +39,9 @@ export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
     const dangerouslyAllowBrowser =
       props.dangerouslyAllowBrowser ??
       (client as any)?._options?.dangerouslyAllowBrowser ??
-      (client?.apiKey.startsWith('ek_') ? true : null);
-
+      (typeof (client as any)?._options?.apiKey === 'string' && client?.apiKey?.startsWith('ek_') ?
+        true
+      : null);
     if (!dangerouslyAllowBrowser && isRunningInBrowser()) {
       throw new OpenAIError(
         "It looks like you're running in a browser-like environment.\n\nThis is disabled by default, as it risks exposing your secret API credentials to attackers.\n\nYou can avoid this error by creating an ephemeral session token:\nhttps://platform.openai.com/docs/api-reference/realtime-sessions\n",
@@ -49,6 +50,10 @@ export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
 
     client ??= new OpenAI({ dangerouslyAllowBrowser });
 
+    if (typeof (client as any)?._options?.apiKey !== 'string') {
+      throw new Error('Call the create method instead to construct the client');
+    }
+
     this.url = buildRealtimeURL(client, props.model);
     props.onURL?.(this.url);
 

src/beta/realtime/ws.ts

@@ -13,7 +13,9 @@ export class OpenAIRealtimeWS extends OpenAIRealtimeEmitter {
   ) {
     super();
     client ??= new OpenAI();
-
+    if (typeof (client as any)._options.apiKey !== 'string') {
+      throw new Error('Call the create method instead to construct the client');
+    }
     this.url = buildRealtimeURL(client, props.model);
     this.socket = new WS.WebSocket(this.url, {
       ...props.options,

src/client.ts

@@ -215,11 +215,7 @@ export interface ClientOptions {
   /**
    * Defaults to process.env['OPENAI_API_KEY'].
    */
-  apiKey?: string | undefined;
-  /**
-   * A function that returns a token to use for authentication.
-   */
-  tokenProvider?: TokenProvider | undefined;
+  apiKey?: string | TokenProvider | undefined;
   /**
    * Defaults to process.env['OPENAI_ORG_ID'].
    */
@@ -330,7 +326,6 @@ export class OpenAI {
   #encoder: Opts.RequestEncoder;
   protected idempotencyHeader?: string;
   private _options: ClientOptions;
-  private _tokenProvider: TokenProvider | undefined;
 
   /**
    * API Client for interfacing with the OpenAI API.
@@ -354,18 +349,11 @@ export class OpenAI {
     organization = readEnv('OPENAI_ORG_ID') ?? null,
     project = readEnv('OPENAI_PROJECT_ID') ?? null,
     webhookSecret = readEnv('OPENAI_WEBHOOK_SECRET') ?? null,
-    tokenProvider,
     ...opts
   }: ClientOptions = {}) {
-    if (apiKey === undefined && !tokenProvider) {
-      throw new Errors.OpenAIError(
-        'Missing credentials. Please pass one of `apiKey` and `tokenProvider`, or set the `OPENAI_API_KEY` environment variable.',
-      );
-    }
-
-    if (tokenProvider && apiKey) {
+    if (apiKey === undefined) {
       throw new Errors.OpenAIError(
-        'The `apiKey` and `tokenProvider` arguments are mutually exclusive; only one can be passed at a time.',
+        'Missing credentials. Please pass an `apiKey`, or set the `OPENAI_API_KEY` environment variable.',
       );
     }
 
@@ -374,7 +362,6 @@ export class OpenAI {
       organization,
       project,
       webhookSecret,
-      tokenProvider,
       ...opts,
       baseURL: baseURL || `https://api.openai.com/v1`,
     };
@@ -402,8 +389,7 @@ export class OpenAI {
 
     this._options = options;
 
-    this.apiKey = apiKey ?? 'Missing Key';
-    this._tokenProvider = tokenProvider;
+    this.apiKey = typeof apiKey === 'string' ? apiKey : 'Missing Key';
     this.organization = organization;
     this.project = project;
     this.webhookSecret = webhookSecret;
@@ -423,7 +409,6 @@ export class OpenAI {
       fetch: this.fetch,
       fetchOptions: this.fetchOptions,
       apiKey: this.apiKey,
-      tokenProvider: this._tokenProvider,
       organization: this.organization,
       project: this.project,
       webhookSecret: this.webhookSecret,
@@ -473,12 +458,13 @@ export class OpenAI {
   }
 
   async _setToken(): Promise<boolean> {
-    if (typeof this._tokenProvider === 'function') {
+    const apiKey = this._options.apiKey;
+    if (typeof apiKey === 'function') {
       try {
-        const token = await this._tokenProvider();
+        const token = await apiKey();
         if (!token || typeof token.token !== 'string') {
           throw new Errors.OpenAIError(
-            `Expected 'tokenProvider' argument to return a string but it returned ${token}`,
+            `Expected 'apiKey' function argument to return a string but it returned ${token}`,
           );
         }
         this.apiKey = token.token;
@@ -488,7 +474,7 @@ export class OpenAI {
           throw err;
         }
         throw new Errors.OpenAIError(
-          `Failed to get token from 'tokenProvider' function: ${err.message}`,
+          `Failed to get token from 'apiKey' function: ${err.message}`,
           // @ts-ignore
           { cause: err },
         );

tests/index.test.ts

@@ -736,7 +736,7 @@ describe('retries', () => {
       };
       const client = new OpenAI({
         baseURL: 'http://localhost:5000/',
-        tokenProvider: async () => ({ token: 'my token' }),
+        apiKey: async () => ({ token: 'my token' }),
         fetch: testFetch,
       });
       expect(
@@ -763,12 +763,12 @@ describe('retries', () => {
         });
       };
       let counter = 0;
-      async function tokenProvider() {
+      async function apiKey() {
         return { token: `token-${counter++}` };
       }
       const client = new OpenAI({
         baseURL: 'http://localhost:5000/',
-        tokenProvider,
+        apiKey,
         fetch: testFetch,
       });
       expect(
@@ -783,21 +783,6 @@ describe('retries', () => {
       ).toEqual('Bearer token-1');
     });
 
-    test('mutual exclusive', () => {
-      try {
-        new OpenAI({
-          baseURL: 'http://localhost:5000/',
-          tokenProvider: async () => ({ token: 'my token' }),
-          apiKey: 'my api key',
-        });
-      } catch (error: any) {
-        expect(error).toBeInstanceOf(Error);
-        expect(error.message).toEqual(
-          'The `apiKey` and `tokenProvider` arguments are mutually exclusive; only one can be passed at a time.',
-        );
-      }
-    });
-
     test('at least one', () => {
       try {
         new OpenAI({