address feedback

Author: deyaaeldeen

src/beta/realtime/websocket.ts

@@ -100,18 +100,18 @@ export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
   }
 
   static async create(
-    client: Pick<OpenAI, 'apiKey' | 'baseURL' | '_setApiKey'>,
+    client: Pick<OpenAI, 'apiKey' | 'baseURL' | '_callApiKey'>,
     props: { model: string; dangerouslyAllowBrowser?: boolean },
   ): Promise<OpenAIRealtimeWebSocket> {
-    await client._setApiKey();
+    await client._callApiKey();
     return new OpenAIRealtimeWebSocket(props, client);
   }
 
   static async azure(
-    client: Pick<AzureOpenAI, '_setApiKey' | 'apiVersion' | 'apiKey' | 'baseURL' | 'deploymentName'>,
+    client: Pick<AzureOpenAI, '_callApiKey' | 'apiVersion' | 'apiKey' | 'baseURL' | 'deploymentName'>,
     options: { deploymentName?: string; dangerouslyAllowBrowser?: boolean } = {},
   ): Promise<OpenAIRealtimeWebSocket> {
-    const isToken = await client._setApiKey();
+    const isToken = await client._callApiKey();
     function onURL(url: URL) {
       if (isToken) {
         url.searchParams.set('Authorization', `Bearer ${client.apiKey}`);

src/beta/realtime/ws.ts

@@ -54,15 +54,15 @@ export class OpenAIRealtimeWS extends OpenAIRealtimeEmitter {
   }
 
   static async create(
-    client: Pick<OpenAI, 'apiKey' | 'baseURL' | '_setApiKey'>,
+    client: Pick<OpenAI, 'apiKey' | 'baseURL' | '_callApiKey'>,
     props: { model: string; options?: WS.ClientOptions | undefined },
   ): Promise<OpenAIRealtimeWS> {
-    await client._setApiKey();
+    await client._callApiKey();
     return new OpenAIRealtimeWS(props, client);
   }
 
   static async azure(
-    client: Pick<AzureOpenAI, '_setApiKey' | 'apiVersion' | 'apiKey' | 'baseURL' | 'deploymentName'>,
+    client: Pick<AzureOpenAI, '_callApiKey' | 'apiVersion' | 'apiKey' | 'baseURL' | 'deploymentName'>,
     options: { deploymentName?: string; options?: WS.ClientOptions | undefined } = {},
   ): Promise<OpenAIRealtimeWS> {
     const deploymentName = options.deploymentName ?? client.deploymentName;
@@ -92,8 +92,8 @@ export class OpenAIRealtimeWS extends OpenAIRealtimeEmitter {
   }
 }
 
-async function getAzureHeaders(client: Pick<AzureOpenAI, '_setApiKey' | 'apiKey'>) {
-  const isToken = await client._setApiKey();
+async function getAzureHeaders(client: Pick<AzureOpenAI, '_callApiKey' | 'apiKey'>) {
+  const isToken = await client._callApiKey();
   if (isToken) {
     return { Authorization: `Bearer ${isToken}` };
   } else {

src/client.ts

@@ -210,7 +210,15 @@ export type ApiKeySetter = () => Promise<string>;
 
 export interface ClientOptions {
   /**
-   * Defaults to process.env['OPENAI_API_KEY'].
+   * API key used for authentication.
+   *
+   * - Accepts either a static string or an async function that resolves to a string.
+   * - Defaults to process.env['OPENAI_API_KEY'].
+   * - When a function is provided, it is invoked before each request so you can rotate
+   *   or refresh credentials at runtime.
+   * - The function must return a non-empty string; otherwise an OpenAIError is thrown.
+   * - If the function throws, the error is wrapped in an OpenAIError with the original
+   *   error available as `cause`.
    */
   apiKey?: string | ApiKeySetter | undefined;
   /**
@@ -454,30 +462,29 @@ export class OpenAI {
     return Errors.APIError.generate(status, error, message, headers);
   }
 
-  async _setApiKey(): Promise<boolean> {
+  async _callApiKey(): Promise<boolean> {
     const apiKey = this._options.apiKey;
-    if (typeof apiKey === 'function') {
-      try {
-        const token = await apiKey();
-        if (!token || typeof token !== 'string') {
-          throw new Errors.OpenAIError(
-            `Expected 'apiKey' function argument to return a string but it returned ${token}`,
-          );
-        }
-        this.apiKey = token;
-        return true;
-      } catch (err: any) {
-        if (err instanceof Errors.OpenAIError) {
-          throw err;
-        }
-        throw new Errors.OpenAIError(
-          `Failed to get token from 'apiKey' function: ${err.message}`,
-          // @ts-ignore
-          { cause: err },
-        );
-      }
+    if (typeof apiKey !== 'function') return false;
+
+    let token: unknown;
+    try {
+      token = await apiKey();
+    } catch (err: any) {
+      if (err instanceof Errors.OpenAIError) throw err;
+      throw new Errors.OpenAIError(
+        `Failed to get token from 'apiKey' function: ${err.message}`,
+        // @ts-ignore
+        { cause: err },
+      );
     }
-    return false;
+
+    if (typeof token !== 'string' || !token) {
+      throw new Errors.OpenAIError(
+        `Expected 'apiKey' function argument to return a string but it returned ${token}`,
+      );
+    }
+    this.apiKey = token;
+    return true;
   }
 
   buildURL(
@@ -507,7 +514,7 @@ export class OpenAI {
    * Used as a callback for mutating the given `FinalRequestOptions` object.
    */
   protected async prepareOptions(options: FinalRequestOptions): Promise<void> {
-    await this._setApiKey();
+    await this._callApiKey();
   }
 
   /**

tests/lib/azure.test.ts

@@ -270,7 +270,7 @@ describe('instantiate azure client', () => {
 
     test('AAD token is refreshed', async () => {
       let fail = true;
-      const testFetch = async (url: any, { headers }: RequestInit = {}): Promise<Response> => {
+      const testFetch = async (url: RequestInfo, { headers }: RequestInit = {}): Promise<Response> => {
         if (fail) {
           fail = false;
           return new Response(undefined, {