feat: support token-based auth endpoint

Author: naomi-lgbt

examples/node-auth/index.js

@@ -0,0 +1,29 @@
+const { createClient } = require("../../dist/main/index");
+const fs = require("fs");
+const path = require("path");
+
+const transcribeUrl = async () => {
+  const deepgram = createClient(process.env.DEEPGRAM_API_KEY);
+  const { result: token, error: tokenError } = await deepgram.auth.grantToken();
+  if (tokenError) {
+    throw tokenError;
+  }
+  console.log("Token", token);
+
+  console.log("Transcribing URL", "https://dpgr.am/spacewalk.wav");
+  deepgram.token = token.access_token;
+  const { result, error } = await deepgram.listen.prerecorded.transcribeUrl(
+    {
+      url: "https://dpgr.am/spacewalk.wav",
+    },
+    {
+      model: "nova-3",
+      keyterm: ["spacewalk"],
+    }
+  );
+
+  if (error) console.error(error);
+  if (!error) console.dir(result, { depth: 5 });
+};
+
+transcribeUrl();

src/DeepgramClient.ts

@@ -2,6 +2,7 @@ import { DeepgramVersionError } from "./lib/errors";
 import {
   AbstractClient,
   AgentLiveClient,
+  AuthRestClient,
   ListenClient,
   ManageClient,
   ReadClient,
@@ -91,6 +92,10 @@ export default class DeepgramClient extends AbstractClient {
     return new AgentLiveClient(this.options, endpoint);
   }
 
+  get auth(): AuthRestClient {
+    return new AuthRestClient(this.options);
+  }
+
   /**
    * @deprecated
    * @see https://dpgr.am/js-v3

src/lib/types/GrantTokenResponse.ts

@@ -0,0 +1,4 @@
+export interface GrantTokenResponse {
+  access_token: string;
+  expires_in: number;
+}

src/lib/types/index.ts

@@ -26,6 +26,7 @@ export * from "./GetProjectUsageRequestsSchema";
 export * from "./GetProjectUsageSummaryResponse";
 export * from "./GetProjectUsageSummarySchema";
 export * from "./GetTokenDetailsResponse";
+export * from "./GrantTokenResponse";
 export * from "./ListOnPremCredentialsResponse";
 export * from "./LiveConfigOptions";
 export * from "./LiveMetadataEvent";

src/packages/AuthRestClient.ts

@@ -0,0 +1,27 @@
+import { isDeepgramError } from "../lib/errors";
+import type { DeepgramResponse } from "../lib/types/DeepgramResponse";
+import type { GrantTokenResponse } from "../lib/types/GrantTokenResponse";
+import { AbstractRestClient } from "./AbstractRestClient";
+
+export class AuthRestClient extends AbstractRestClient {
+  public namespace: string = "auth";
+
+  public async grantToken(
+    endpoint = ":version/auth/grant"
+  ): Promise<DeepgramResponse<GrantTokenResponse>> {
+    try {
+      const requestUrl = this.getRequestUrl(endpoint);
+      const result: GrantTokenResponse = await this.post(requestUrl, "").then((result) =>
+        result.json()
+      );
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
+}

src/packages/index.ts

@@ -2,6 +2,7 @@ export * from "./AbstractClient";
 export * from "./AbstractLiveClient";
 export * from "./AbstractRestClient";
 export * from "./AgentLiveClient";
+export * from "./AuthRestClient";
 export * from "./ListenClient";
 export * from "./ListenLiveClient";
 export * from "./ListenRestClient";