feat(auth): add support for DEEPGRAM_ACCESS_TOKEN as per the other SDKs

Author: lukeocodes

src/packages/AbstractClient.ts

@@ -36,6 +36,7 @@ export abstract class AbstractClient extends EventEmitter {
    *
    * @param options - The options to configure the DeepgramClient instance.
    * @param options.key - The Deepgram API key to use for authentication. If not provided, the `DEEPGRAM_API_KEY` environment variable will be used.
+   * @param options.accessToken - The Deepgram access token to use for authentication. If not provided, the `DEEPGRAM_ACCESS_TOKEN` environment variable will be used.
    * @param options.global - Global options that apply to all requests made by the DeepgramClient instance.
    * @param options.global.fetch - Options to configure the fetch requests made by the DeepgramClient instance.
    * @param options.global.fetch.options - Additional options to pass to the fetch function, such as `url` and `headers`.
@@ -60,14 +61,20 @@ export abstract class AbstractClient extends EventEmitter {
       this.key = options.key;
     }
 
-    // if we still have neither, try to use the DEEPGRAM_API_KEY environment variable
+    // implement priority-based credential resolution for environment variables
     if (!this.key && !this.accessToken) {
-      this.key = process.env.DEEPGRAM_API_KEY as string;
+      // check for DEEPGRAM_ACCESS_TOKEN first (higher priority)
+      this.accessToken = process.env.DEEPGRAM_ACCESS_TOKEN as string;
+
+      // if still no access token, fall back to DEEPGRAM_API_KEY (lower priority)
+      if (!this.accessToken) {
+        this.key = process.env.DEEPGRAM_API_KEY as string;
+      }
     }
 
     // if we STILL have neither, throw an error
     if (!this.key && !this.accessToken) {
-      throw new DeepgramError("A deepgram API key or temporary auth token is required.");
+      throw new DeepgramError("A deepgram API key or access token is required.");
     }
 
     options = convertLegacyOptions(options);

test/client.test.ts

@@ -27,15 +27,15 @@ describe("testing creation of a deepgram client object", () => {
   });
 
   it("it should throw an error if no valid apiKey is provided", () => {
-    expect(() => createClient("")).to.throw("A deepgram API key is required");
+    expect(() => createClient("")).to.throw("A deepgram API key or access token is required");
   });
 
   it("it should throw an error if invalid options are provided", () => {
     // const client = createClient({ global: { fetch: { options: { url: "" } } } });
     // console.log(client);
     // process.exit(1);
     expect(() => createClient({ global: { fetch: { options: { url: "" } } } })).to.throw(
-      `A deepgram API key is required.`
+      `A deepgram API key or access token is required.`
     );
   });
 

test/fetch.test.ts

@@ -9,7 +9,30 @@ describe("fetchWithAuth", () => {
       expect(headers?.get("Authorization")).to.equal(`Token ${apiKey}`);
       return new Response();
     };
-    const fetchWithAuthInstance = fetchWithAuth(apiKey, customFetch);
+    const fetchWithAuthInstance = fetchWithAuth({ apiKey, customFetch });
+    await fetchWithAuthInstance("https://example.com");
+  });
+
+  it("should include the Authorization header with Bearer for access token", async () => {
+    const accessToken = "test-access-token";
+    const customFetch = async (input: RequestInfo | URL, init?: RequestInit | undefined) => {
+      const headers = new Headers(init?.headers);
+      expect(headers?.get("Authorization")).to.equal(`Bearer ${accessToken}`);
+      return new Response();
+    };
+    const fetchWithAuthInstance = fetchWithAuth({ accessToken, customFetch });
+    await fetchWithAuthInstance("https://example.com");
+  });
+
+  it("should prioritize access token over API key when both are provided", async () => {
+    const apiKey = "test-api-key";
+    const accessToken = "test-access-token";
+    const customFetch = async (input: RequestInfo | URL, init?: RequestInit | undefined) => {
+      const headers = new Headers(init?.headers);
+      expect(headers?.get("Authorization")).to.equal(`Bearer ${accessToken}`);
+      return new Response();
+    };
+    const fetchWithAuthInstance = fetchWithAuth({ apiKey, accessToken, customFetch });
     await fetchWithAuthInstance("https://example.com");
   });
 
@@ -20,7 +43,7 @@ describe("fetchWithAuth", () => {
       expect(headers?.get("Authorization")).to.equal("existing-token");
       return new Response();
     };
-    const fetchWithAuthInstance = fetchWithAuth(apiKey, customFetch);
+    const fetchWithAuthInstance = fetchWithAuth({ apiKey, customFetch });
     await fetchWithAuthInstance("https://example.com", {
       headers: { Authorization: "existing-token" },
     });