@deepgram/sdk 3.0.0-alpha.9 → 3.0.0-beta.1

package/src/packages/LiveClient.ts

@@ -1,33 +1,40 @@
-import { EventEmitter } from "events";
+import { AbstractWsClient } from "./AbstractWsClient";
 import { appendSearchParams, isBrowser } from "../lib/helpers";
-import WebSocket from "modern-isomorphic-ws";
+import { DeepgramError } from "../lib/errors";
+import { DEFAULT_OPTIONS } from "../lib/constants";
 import { LiveConnectionState, LiveTranscriptionEvents } from "../lib/enums";
+import WebSocket from "modern-isomorphic-ws";
+
 import type {
   LiveSchema,
   LiveConfigOptions,
   LiveMetadataEvent,
   LiveTranscriptionEvent,
+  DeepgramClientOptions,
 } from "../lib/types";
-import { DEFAULT_HEADERS } from "../lib/constants";
 
-export class LiveClient extends EventEmitter {
+export class LiveClient extends AbstractWsClient {
   private _socket: WebSocket;
 
-  constructor(baseUrl: URL, apiKey: string, options: LiveSchema, endpoint = "v1/listen") {
-    super();
+  constructor(
+    protected key: string,
+    protected options: DeepgramClientOptions | undefined = DEFAULT_OPTIONS,
+    private transcriptionOptions: LiveSchema = {},
+    endpoint = "v1/listen"
+  ) {
+    super(key, options);
 
-    const transcriptionOptions: LiveSchema = { ...{}, ...options };
-    const url = new URL(endpoint, baseUrl);
+    const url = new URL(endpoint, this.baseUrl);
     url.protocol = url.protocol.toLowerCase().replace(/(http)(s)?/gi, "ws$2");
-    appendSearchParams(url.searchParams, transcriptionOptions);
+    appendSearchParams(url.searchParams, this.transcriptionOptions);
 
     if (isBrowser()) {
-      this._socket = new WebSocket(url.toString(), ["token", apiKey]);
+      this._socket = new WebSocket(url.toString(), ["token", this.key]);
     } else {
       this._socket = new WebSocket(url.toString(), {
         headers: {
-          Authorization: `token ${apiKey}`,
-          ...DEFAULT_HEADERS,
+          Authorization: `token ${this.key}`,
+          ...this.options?.global?.headers,
         },
       });
     }
@@ -101,16 +108,21 @@ export class LiveClient extends EventEmitter {
    * Sends data to the Deepgram API via websocket connection
    * @param data Audio data to send to Deepgram
    *
-   * Conforms to RFC #146 - does not send an empty byte.
+   * Conforms to RFC #146 for Node.js - does not send an empty byte.
+   * In the browser, a Blob will contain length with no audio.
    * @see https://github.com/deepgram/deepgram-python-sdk/issues/146
    */
-  public send(data: string | ArrayBufferLike | ArrayBufferView): void {
+  public send(data: string | ArrayBufferLike | Blob): void {
     if (this._socket.readyState === LiveConnectionState.OPEN) {
       if (typeof data === "string") {
         this._socket.send(data); // send text data
+      } else if ((data as any) instanceof Blob) {
+        this._socket.send(data as unknown as ArrayBufferLike); // send blob data
       } else {
-        if (data.byteLength > 0) {
-          this._socket.send(data); // send buffer when not zero-byte
+        const buffer = data as ArrayBufferLike;
+
+        if (buffer.byteLength > 0) {
+          this._socket.send(buffer); // send buffer when not zero-byte (or browser)
         } else {
           this.emit(
             LiveTranscriptionEvents.Warning,
@@ -119,7 +131,7 @@ export class LiveClient extends EventEmitter {
         }
       }
     } else {
-      this.emit(LiveTranscriptionEvents.Error, "Could not send. Connection not open.");
+      throw new DeepgramError("Could not send. Connection not open.");
     }
   }
 

package/src/packages/ManageClient.ts

@@ -38,9 +38,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint;
 
-      const result: GetProjectsResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectsResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -63,9 +61,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId);
 
-      const result: GetProjectResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -91,9 +87,7 @@ export class ManageClient extends AbstractRestfulClient {
 
       const body = JSON.stringify(options);
 
-      const result: MessageResponse = await this.patch(this.fetch as Fetch, url, body, {
-        headers: this.headers,
-      });
+      const result: MessageResponse = await this.patch(this.fetch as Fetch, url, body);
 
       return { result, error: null };
     } catch (error) {
@@ -116,9 +110,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId);
 
-      await this.delete(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      await this.delete(this.fetch as Fetch, url);
 
       return { error: null };
     } catch (error) {
@@ -141,9 +133,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId);
 
-      const result: GetProjectKeysResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectKeysResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -167,9 +157,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId).replace(/:keyId/, keyId);
 
-      const result: GetProjectKeyResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectKeyResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -195,9 +183,7 @@ export class ManageClient extends AbstractRestfulClient {
 
       const body = JSON.stringify(options);
 
-      const result: CreateProjectKeyResponse = await this.post(this.fetch as Fetch, url, body, {
-        headers: this.headers,
-      });
+      const result: CreateProjectKeyResponse = await this.post(this.fetch as Fetch, url, body);
 
       return { result, error: null };
     } catch (error) {
@@ -221,9 +207,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId).replace(/:keyId/, keyId);
 
-      await this.delete(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      await this.delete(this.fetch as Fetch, url);
 
       return { error: null };
     } catch (error) {
@@ -246,9 +230,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId);
 
-      const result: GetProjectMembersResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectMembersResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -272,9 +254,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId).replace(/:memberId/, memberId);
 
-      await this.delete(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      await this.delete(this.fetch as Fetch, url);
 
       return { error: null };
     } catch (error) {
@@ -298,9 +278,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId).replace(/:memberId/, memberId);
 
-      const result: GetProjectMemberScopesResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectMemberScopesResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -327,9 +305,7 @@ export class ManageClient extends AbstractRestfulClient {
 
       const body = JSON.stringify(options);
 
-      const result: MessageResponse = await this.put(this.fetch as Fetch, url, body, {
-        headers: this.headers,
-      });
+      const result: MessageResponse = await this.put(this.fetch as Fetch, url, body);
 
       return { result, error: null };
     } catch (error) {
@@ -352,9 +328,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId);
 
-      const result: GetProjectInvitesResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectInvitesResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -380,9 +354,7 @@ export class ManageClient extends AbstractRestfulClient {
 
       const body = JSON.stringify(options);
 
-      const result: MessageResponse = await this.post(this.fetch as Fetch, url, body, {
-        headers: this.headers,
-      });
+      const result: MessageResponse = await this.post(this.fetch as Fetch, url, body);
 
       return { result, error: null };
     } catch (error) {
@@ -406,9 +378,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId).replace(/:email/, email);
 
-      await this.delete(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      await this.delete(this.fetch as Fetch, url);
 
       return { error: null };
     } catch (error) {
@@ -431,9 +401,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId);
 
-      const result: MessageResponse = await this.delete(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: MessageResponse = await this.delete(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -458,9 +426,7 @@ export class ManageClient extends AbstractRestfulClient {
       url.pathname = endpoint.replace(/:projectId/, projectId);
       appendSearchParams(url.searchParams, options);
 
-      const result: GetProjectUsageRequestsResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectUsageRequestsResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -484,9 +450,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId).replace(/:requestId/, requestId);
 
-      const result: GetProjectUsageRequestResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectUsageRequestResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -511,9 +475,7 @@ export class ManageClient extends AbstractRestfulClient {
       url.pathname = endpoint.replace(/:projectId/, projectId);
       appendSearchParams(url.searchParams, options);
 
-      const result: GetProjectUsageSummaryResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectUsageSummaryResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -538,9 +500,7 @@ export class ManageClient extends AbstractRestfulClient {
       url.pathname = endpoint.replace(/:projectId/, projectId);
       appendSearchParams(url.searchParams, options);
 
-      const result: GetProjectUsageFieldsResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectUsageFieldsResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -563,9 +523,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId);
 
-      const result: GetProjectBalancesResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectBalancesResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -589,9 +547,7 @@ export class ManageClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId).replace(/:balanceId/, balanceId);
 
-      const result: GetProjectBalanceResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: GetProjectBalanceResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {

package/src/packages/OnPremClient.ts

@@ -21,9 +21,7 @@ export class OnPremClient extends AbstractRestfulClient {
       const url = new URL(this.baseUrl);
       url.pathname = endpoint.replace(/:projectId/, projectId);
 
-      const result: ListOnPremCredentialsResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: ListOnPremCredentialsResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -49,9 +47,7 @@ export class OnPremClient extends AbstractRestfulClient {
         .replace(/:projectId/, projectId)
         .replace(/:credentialsId/, credentialsId);
 
-      const result: OnPremCredentialResponse = await this.get(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: OnPremCredentialResponse = await this.get(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {
@@ -77,9 +73,7 @@ export class OnPremClient extends AbstractRestfulClient {
 
       const body = JSON.stringify(options);
 
-      const result: OnPremCredentialResponse = await this.post(this.fetch as Fetch, url, body, {
-        headers: this.headers,
-      });
+      const result: OnPremCredentialResponse = await this.post(this.fetch as Fetch, url, body);
 
       return { result, error: null };
     } catch (error) {
@@ -105,9 +99,7 @@ export class OnPremClient extends AbstractRestfulClient {
         .replace(/:projectId/, projectId)
         .replace(/:credentialsId/, credentialsId);
 
-      const result: MessageResponse = await this.delete(this.fetch as Fetch, url, {
-        headers: this.headers,
-      });
+      const result: MessageResponse = await this.delete(this.fetch as Fetch, url);
 
       return { result, error: null };
     } catch (error) {

package/src/packages/PrerecordedClient.ts

@@ -37,9 +37,7 @@ export class PrerecordedClient extends AbstractRestfulClient {
       const url = new URL(endpoint, this.baseUrl);
       appendSearchParams(url.searchParams, transcriptionOptions);
 
-      const result: SyncPrerecordedResponse = await this.post(this.fetch as Fetch, url, body, {
-        headers: this.headers,
-      });
+      const result: SyncPrerecordedResponse = await this.post(this.fetch as Fetch, url, body);
 
       return { result, error: null };
     } catch (error) {
@@ -57,9 +55,6 @@ export class PrerecordedClient extends AbstractRestfulClient {
     endpoint = "v1/listen"
   ): Promise<DeepgramResponse<SyncPrerecordedResponse>> {
     try {
-      // deepgram ignores the mimetype if it's not `application/json`
-      this.headers["Content-Type"] = "deepgram/audio+video";
-
       let body;
 
       if (isFileSource(source)) {
@@ -80,7 +75,7 @@ export class PrerecordedClient extends AbstractRestfulClient {
       appendSearchParams(url.searchParams, transcriptionOptions);
 
       const result: SyncPrerecordedResponse = await this.post(this.fetch as Fetch, url, body, {
-        headers: this.headers,
+        "Content-Type": "deepgram/audio+video",
       });
 
       return { result, error: null };
@@ -116,9 +111,7 @@ export class PrerecordedClient extends AbstractRestfulClient {
       const url = new URL(endpoint, this.baseUrl);
       appendSearchParams(url.searchParams, transcriptionOptions);
 
-      const result: AsyncPrerecordedResponse = await this.post(this.fetch as Fetch, url, body, {
-        headers: this.headers,
-      });
+      const result: AsyncPrerecordedResponse = await this.post(this.fetch as Fetch, url, body);
 
       return { result, error: null };
     } catch (error) {
@@ -137,9 +130,6 @@ export class PrerecordedClient extends AbstractRestfulClient {
     endpoint = "v1/listen"
   ): Promise<DeepgramResponse<AsyncPrerecordedResponse>> {
     try {
-      // deepgram ignores the mimetype if it's not `application/json`
-      this.headers["Content-Type"] = "deepgram/audio+video";
-
       let body;
 
       if (isFileSource(source)) {
@@ -157,7 +147,7 @@ export class PrerecordedClient extends AbstractRestfulClient {
       appendSearchParams(url.searchParams, transcriptionOptions);
 
       const result: AsyncPrerecordedResponse = await this.post(this.fetch as Fetch, url, body, {
-        headers: this.headers,
+        "Content-Type": "deepgram/audio+video",
       });
 
       return { result, error: null };

package/src/packages/index.ts

@@ -0,0 +1,8 @@
+export { AbstractClient } from "./AbstractClient";
+export { AbstractRestfulClient } from "./AbstractRestfulClient";
+export { AbstractWsClient } from "./AbstractWsClient";
+export { ListenClient } from "./ListenClient";
+export { LiveClient } from "./LiveClient";
+export { ManageClient } from "./ManageClient";
+export { OnPremClient } from "./OnPremClient";
+export { PrerecordedClient } from "./PrerecordedClient";