feat: add new alpha client (#249)

Author: lukeocodes

src/DeepgramClient.ts

@@ -4,6 +4,7 @@ import { ListenClient } from "./packages/ListenClient";
 import { ManageClient } from "./packages/ManageClient";
 import { OnPremClient } from "./packages/OnPremClient";
 import { ReadClient } from "./packages/ReadClient";
+import { SpeakClient } from "./packages/SpeakClient";
 
 /**
  * Deepgram Client.
@@ -28,6 +29,10 @@ export default class DeepgramClient extends AbstractClient {
     return new ReadClient(this.key, this.options);
   }
 
+  get speak(): SpeakClient {
+    return new SpeakClient(this.key, this.options);
+  }
+
   /**
    * Major version fallback errors are below
    *

src/lib/types/DeepgramSpeakResponse.ts

@@ -0,0 +1,7 @@
+import { DeepgramError } from "../errors";
+
+export type DeepgramSpeakResponse = ReadableStream | ErrorResponse;
+
+interface ErrorResponse {
+  error: DeepgramError;
+}

src/lib/types/SpeakSchema.ts

@@ -0,0 +1,29 @@
+export interface SpeakSchema extends Record<string, unknown> {
+  /**
+   * The model, voice, language, and version of the voice.
+   * Follows the format of[modelname]-[voicename]-[language]-[version].
+   */
+  model?: string;
+
+  /**
+   * Encoding options for the output audio. Default is 'mp3'.
+   */
+  encoding?: "linear16" | "mulaw" | "alaw" | "mp3" | "opus" | "flac" | "aac";
+
+  /**
+   * File format wrapper for the audio.
+   */
+  container?: string;
+
+  /**
+   * Sample rate of the audio output.
+   */
+  sample_rate?: number;
+
+  /**
+   * Bit rate of the audio output.
+   */
+  bit_rate?: number;
+
+  [key: string]: unknown;
+}

src/lib/types/index.ts

@@ -42,6 +42,7 @@ export type {
   AnalyzeSource,
 } from "./DeepgramSource";
 export type { SendProjectInviteSchema } from "./SendProjectInviteSchema";
+export type { SpeakSchema } from "./SpeakSchema";
 export type { SpeechStartedEvent } from "./SpeechStartedEvent";
 export type { SyncPrerecordedResponse } from "./SyncPrerecordedResponse";
 export type { SyncAnalyzeResponse } from "./SyncAnalyzeResponse";

src/packages/SpeakClient.ts

@@ -0,0 +1,39 @@
+import { AbstractRestfulClient } from "./AbstractRestfulClient";
+import { DeepgramError, isDeepgramError } from "../lib/errors";
+import { appendSearchParams, isTextSource } from "../lib/helpers";
+import { Fetch, SpeakSchema, TextSource } from "../lib/types";
+import { DeepgramSpeakResponse } from "../lib/types/DeepgramSpeakResponse";
+
+export class SpeakClient extends AbstractRestfulClient {
+  /**
+   * @see https://developers.deepgram.com/reference/text-to-speech-preview-api
+   */
+  async stream(
+    source: TextSource,
+    options?: SpeakSchema,
+    endpoint = "v1/speak"
+  ): Promise<DeepgramSpeakResponse> {
+    try {
+      let body;
+
+      if (isTextSource(source)) {
+        body = JSON.stringify(source);
+      } else {
+        throw new DeepgramError("Unknown transcription source type");
+      }
+
+      const speakOptions: SpeakSchema = { ...{ model: "alpha-asteria-en" }, ...options };
+
+      const url = new URL(endpoint, this.baseUrl);
+      appendSearchParams(url.searchParams, speakOptions);
+
+      return await this.post(this.fetch as Fetch, url, body);
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { error };
+      }
+
+      throw error;
+    }
+  }
+}