Add support for custom keys (#36)

* Rework all providers into classes

* Switch from consts to types

* Update tests

* Update docs

* Update providers.tsx

* Last fixes

* Resolves #30

* Misc key fixes

* Misc fixes

Author: haydenbleasel

Diff for: __tests__/assembly.test.ts

@@ -1,9 +1,11 @@
 import { readFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { transcribe } from '../src';
-import { assembly } from '../src/assembly';
+import { AssemblyAI } from '../src/assembly';
 
 describe('AssemblyAI Tests', () => {
+  const assembly = new AssemblyAI();
+
   it('should convert speech to text', async () => {
     const file = await readFile('./__tests__/test.mp3');
     const audio = new File([file], 'test.mp3', { type: 'audio/mp3' });

Diff for: __tests__/azure.openai.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak, transcribe } from '../src';
-import { openaiAzure } from '../src/azure.openai';
+import { AzureOpenAI } from '../src/azure.openai';
 
 describe('Azure OpenAI Tests', () => {
+  const openaiAzure = new AzureOpenAI();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: openaiAzure.tts('tts-hd', 'alloy'),

Diff for: __tests__/azure.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak, transcribe } from '../src';
-import { azure } from '../src/azure';
+import { Azure } from '../src/azure';
 
 describe('Azure Tests', () => {
+  const azure = new Azure();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: azure.tts('en-US-KaiNeural'),

Diff for: __tests__/cleanvoice.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { isolate, transcribe } from '../src';
-import { cleanvoice } from '../src/cleanvoice';
+import { CleanVoice } from '../src/cleanvoice';
 
 describe('CleanVoice Tests', () => {
+  const cleanvoice = new CleanVoice();
+
   it('should convert speech to text', async () => {
     const file = await readFile('./__tests__/test.mp3');
     const audio = new File([file], 'test.mp3', { type: 'audio/mp3' });

Diff for: __tests__/deepgram.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak, transcribe } from '../src';
-import { deepgram } from '../src/deepgram';
+import { Deepgram } from '../src/deepgram';
 
 describe('Deepgram Tests', () => {
+  const deepgram = new Deepgram();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: deepgram.tts('aura', 'arcas-en'),

Diff for: __tests__/elevenlabs.test.ts

@@ -1,12 +1,14 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { change, isolate, speak, transcribe } from '../src';
-import { elevenlabs } from '../src/elevenlabs';
+import { ElevenLabs } from '../src/elevenlabs';
 
 describe('ElevenLabs Tests', () => {
+  const elevenlabs = new ElevenLabs();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
-      model: elevenlabs.tts('multilingual_v2', 'bill'),
+      model: elevenlabs.tts('eleven_multilingual_v2', 'bill'),
       prompt: 'Friends, Romans, countrymen, lend me your ears!',
     });
 
@@ -35,7 +37,7 @@ describe('ElevenLabs Tests', () => {
   it('should convert text to speech with a custom voice', async () => {
     const speech = await speak({
       model: elevenlabs.tts(
-        'multilingual_v2',
+        'eleven_multilingual_sts_v2',
         process.env.ELEVENLABS_CUSTOM_VOICE_ID
       ),
       prompt: 'Friends, Romans, countrymen, lend me your ears!',

Diff for: __tests__/fal.test.ts

@@ -1,9 +1,11 @@
 import { readFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { transcribe } from '../src';
-import { fal } from '../src/fal';
+import { Fal } from '../src/fal';
 
 describe('fal Tests', () => {
+  const fal = new Fal();
+
   it('should convert speech to text', async () => {
     const file = await readFile('./__tests__/test.mp3');
     const audio = new File([file], 'test.mp3', { type: 'audio/mp3' });

Diff for: __tests__/gladia.test.ts

@@ -1,9 +1,11 @@
 import { readFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { transcribe } from '../src';
-import { gladia } from '../src/gladia';
+import { Gladia } from '../src/gladia';
 
 describe('Gladia Tests', () => {
+  const gladia = new Gladia();
+
   it('should convert speech to text', async () => {
     const file = await readFile('./__tests__/test.mp3');
     const audio = new File([file], 'test.mp3', { type: 'audio/mp3' });

Diff for: __tests__/google.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak, transcribe } from '../src';
-import { google } from '../src/google';
+import { Google } from '../src/google';
 
 describe('Google Tests', () => {
+  const google = new Google();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: google.tts('en-US-Journey-D'),

Diff for: __tests__/groq.test.ts

@@ -1,9 +1,11 @@
 import { readFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { transcribe } from '../src';
-import { groq } from '../src/groq';
+import { Groq } from '../src/groq';
 
 describe('Groq Tests', () => {
+  const groq = new Groq();
+
   it('should convert speech to text', async () => {
     const file = await readFile('./__tests__/test.mp3');
     const audio = new File([file], 'test.mp3', { type: 'audio/mp3' });

Diff for: __tests__/hume.test.ts

@@ -1,9 +1,11 @@
 import { writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak } from '../src';
-import { hume } from '../src/hume';
+import { Hume } from '../src/hume';
 
 describe('Hume Tests', () => {
+  const hume = new Hume();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: hume.tts('A Roman senator'),

Diff for: __tests__/ibm.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak, transcribe } from '../src';
-import { ibm } from '../src/ibm';
+import { IBM } from '../src/ibm';
 
 describe('IBM Tests', () => {
+  const ibm = new IBM();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: ibm.tts('en-US_MichaelExpressive'),

Diff for: __tests__/lmnt.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { change, speak } from '../src';
-import { lmnt } from '../src/lmnt';
+import { LMNT } from '../src/lmnt';
 
 describe('LMNT Tests', () => {
+  const lmnt = new LMNT();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: lmnt.tts('blizzard', 'zeke'),

Diff for: __tests__/murf.test.ts

@@ -1,9 +1,11 @@
 import { writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak } from '../src';
-import { murf } from '../src/murf';
+import { Murf } from '../src/murf';
 
 describe('Murf Tests', () => {
+  const murf = new Murf();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: murf.tts('GEN2', 'en-US-terrell'),

Diff for: __tests__/openai.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak, transcribe } from '../src';
-import { openai } from '../src/openai';
+import { OpenAI } from '../src/openai';
 
 describe('OpenAI Tests', () => {
+  const openai = new OpenAI();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: openai.tts('tts-1', 'ash'),

Diff for: __tests__/play.test.ts

@@ -1,9 +1,11 @@
 import { writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak } from '../src';
-import { play } from '../src/play';
+import { Play } from '../src/play';
 
 describe('Play.ai Tests', () => {
+  const play = new Play();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: play.tts('Play3.0-mini', 'Angelo'),

Diff for: __tests__/replicate.test.ts

@@ -1,9 +1,11 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { isolate, speak, transcribe } from '../src';
-import { replicate } from '../src/replicate';
+import { Replicate } from '../src/replicate';
 
 describe('Replicate Tests', () => {
+  const replicate = new Replicate();
+
   it('should convert text to speech using jaaari/kokoro-82m', async () => {
     const speech = await speak({
       model: replicate.tts(

Diff for: __tests__/rev.test.ts

@@ -1,9 +1,11 @@
 import { readFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { transcribe } from '../src';
-import { rev } from '../src/rev';
+import { Rev } from '../src/rev';
 
 describe('Rev Tests', () => {
+  const rev = new Rev();
+
   it('should convert speech to text', async () => {
     const file = await readFile('./__tests__/test.mp3');
     const audio = new File([file], 'test.mp3', { type: 'audio/mp3' });

Diff for: __tests__/speechify.test.ts

@@ -1,9 +1,11 @@
 import { writeFile } from 'node:fs/promises';
 import { describe, expect, it } from 'vitest';
 import { speak } from '../src';
-import { speechify } from '../src/speechify';
+import { Speechify } from '../src/speechify';
 
 describe('Speechify Tests', () => {
+  const speechify = new Speechify();
+
   it('should convert text to speech', async () => {
     const speech = await speak({
       model: speechify.tts('simba-english', 'henry'),

Diff for: src/assembly.ts

@@ -1,34 +1,34 @@
-import { AssemblyAI } from 'assemblyai';
+import { AssemblyAI as AssemblyAISDK } from 'assemblyai';
 import type { SpeechModel, TranscribeParams } from 'assemblyai';
 
-const createProvider = () => {
-  const apiKey = process.env.ASSEMBLYAI_API_KEY;
+export class AssemblyAI {
+  private provider: AssemblyAISDK;
 
-  if (!apiKey) {
-    throw new Error('ASSEMBLYAI_API_KEY is not set');
-  }
+  constructor(apiKey?: string) {
+    const key = apiKey || process.env.ASSEMBLYAI_API_KEY;
+
+    if (!key) {
+      throw new Error('ASSEMBLYAI_API_KEY is not set');
+    }
 
-  return new AssemblyAI({ apiKey });
-};
+    this.provider = new AssemblyAISDK({ apiKey: key });
+  }
 
-export const assembly = {
   /**
    * Creates a speech-to-text transcription function using AssemblyAI
    * @param {SpeechModel} model - The speech model to use for transcription. Defaults to 'best'
    * @param {Omit<TranscribeParams, 'audio' | 'speech_model'>} options - Additional options for the transcription
    * @returns {Function} Async function that takes audio and returns transcribed text
    */
-  stt: (
+  stt(
     model: SpeechModel = 'best',
     options?: Omit<TranscribeParams, 'audio' | 'speech_model'>
-  ) => {
-    const provider = createProvider();
-
+  ) {
     return async (audio: File) => {
       const buffer = await audio.arrayBuffer();
       const audioBuffer = Buffer.from(buffer);
 
-      const response = await provider.transcripts.transcribe({
+      const response = await this.provider.transcripts.transcribe({
         audio: audioBuffer,
         speech_model: model,
         ...options,
@@ -39,7 +39,7 @@ export const assembly = {
       }
 
       while (true) {
-        const transcript = await provider.transcripts.get(response.id);
+        const transcript = await this.provider.transcripts.get(response.id);
 
         if (transcript.status === 'error') {
           throw new Error(transcript.error);
@@ -56,5 +56,5 @@ export const assembly = {
         await new Promise((resolve) => setTimeout(resolve, 1000));
       }
     };
-  },
-};
+  }
+}