@ai-sdk/deepgram 2.0.10 → 2.0.12

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @ai-sdk/deepgram
 
+## 2.0.12
+
+### Patch Changes
+
+- Updated dependencies [462ad00]
+  - @ai-sdk/provider-utils@4.0.10
+
+## 2.0.11
+
+### Patch Changes
+
+- 4de5a1d: chore: excluded tests from src folder in npm package
+- Updated dependencies [4de5a1d]
+  - @ai-sdk/provider@3.0.5
+  - @ai-sdk/provider-utils@4.0.9
+
 ## 2.0.10
 
 ### Patch Changes

package/dist/index.js

@@ -593,7 +593,7 @@ var DeepgramSpeechModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "2.0.10" : "0.0.0-test";
+var VERSION = true ? "2.0.12" : "0.0.0-test";
 
 // src/deepgram-provider.ts
 function createDeepgram(options = {}) {

package/dist/index.mjs

@@ -579,7 +579,7 @@ var DeepgramSpeechModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "2.0.10" : "0.0.0-test";
+var VERSION = true ? "2.0.12" : "0.0.0-test";
 
 // src/deepgram-provider.ts
 function createDeepgram(options = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/deepgram",
-  "version": "2.0.10",
+  "version": "2.0.12",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -10,6 +10,10 @@
     "dist/**/*",
     "docs/**/*",
     "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/**/__snapshots__",
+    "!src/**/__fixtures__",
     "CHANGELOG.md",
     "README.md"
   ],
@@ -25,16 +29,16 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "3.0.4",
-    "@ai-sdk/provider-utils": "4.0.8"
+    "@ai-sdk/provider": "3.0.5",
+    "@ai-sdk/provider-utils": "4.0.10"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
     "tsup": "^8",
     "typescript": "5.6.3",
     "zod": "3.25.76",
-    "@ai-sdk/test-server": "1.0.2",
-    "@vercel/ai-tsconfig": "0.0.0"
+    "@vercel/ai-tsconfig": "0.0.0",
+    "@ai-sdk/test-server": "1.0.3"
   },
   "peerDependencies": {
     "zod": "^3.25.76 || ^4.1.8"

package/src/deepgram-error.test.ts

@@ -1,34 +0,0 @@
-import { safeParseJSON } from '@ai-sdk/provider-utils';
-import { deepgramErrorDataSchema } from './deepgram-error';
-import { describe, expect, it } from 'vitest';
-
-describe('deepgramErrorDataSchema', () => {
-  it('should parse Deepgram resource exhausted error', async () => {
-    const error = `
-{"error":{"message":"{\\n  \\"error\\": {\\n    \\"code\\": 429,\\n    \\"message\\": \\"Resource has been exhausted (e.g. check quota).\\",\\n    \\"status\\": \\"RESOURCE_EXHAUSTED\\"\\n  }\\n}\\n","code":429}}
-`;
-
-    const result = await safeParseJSON({
-      text: error,
-      schema: deepgramErrorDataSchema,
-    });
-
-    expect(result).toStrictEqual({
-      success: true,
-      value: {
-        error: {
-          message:
-            '{\n  "error": {\n    "code": 429,\n    "message": "Resource has been exhausted (e.g. check quota).",\n    "status": "RESOURCE_EXHAUSTED"\n  }\n}\n',
-          code: 429,
-        },
-      },
-      rawValue: {
-        error: {
-          message:
-            '{\n  "error": {\n    "code": 429,\n    "message": "Resource has been exhausted (e.g. check quota).",\n    "status": "RESOURCE_EXHAUSTED"\n  }\n}\n',
-          code: 429,
-        },
-      },
-    });
-  });
-});

package/src/deepgram-speech-model.test.ts

@@ -1,355 +0,0 @@
-import { createTestServer } from '@ai-sdk/test-server/with-vitest';
-import { createDeepgram } from './deepgram-provider';
-import { DeepgramSpeechModel } from './deepgram-speech-model';
-import { describe, it, expect, vi } from 'vitest';
-
-vi.mock('./version', () => ({
-  VERSION: '0.0.0-test',
-}));
-
-const provider = createDeepgram({ apiKey: 'test-api-key' });
-const model = provider.speech('aura-2-helena-en');
-
-const server = createTestServer({
-  'https://api.deepgram.com/v1/speak': {},
-});
-
-describe('doGenerate', () => {
-  function prepareAudioResponse({
-    headers,
-  }: {
-    headers?: Record<string, string>;
-  } = {}) {
-    const audioBuffer = new Uint8Array(100); // Mock audio data
-    server.urls['https://api.deepgram.com/v1/speak'].response = {
-      type: 'binary',
-      headers: {
-        'content-type': 'audio/mp3',
-        ...headers,
-      },
-      body: Buffer.from(audioBuffer),
-    };
-    return audioBuffer;
-  }
-
-  it('should pass the model and text', async () => {
-    prepareAudioResponse();
-
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-    });
-
-    expect(await server.calls[0].requestBodyJson).toMatchObject({
-      text: 'Hello, welcome to Deepgram!',
-    });
-
-    const url = new URL(server.calls[0].requestUrl);
-    expect(url.searchParams.get('model')).toBe('aura-2-helena-en');
-  });
-
-  it('should pass headers', async () => {
-    prepareAudioResponse();
-
-    const provider = createDeepgram({
-      apiKey: 'test-api-key',
-      headers: {
-        'Custom-Provider-Header': 'provider-header-value',
-      },
-    });
-
-    await provider.speech('aura-2-helena-en').doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      headers: {
-        'Custom-Request-Header': 'request-header-value',
-      },
-    });
-
-    expect(server.calls[0].requestHeaders).toMatchObject({
-      authorization: 'Token test-api-key',
-      'content-type': 'application/json',
-      'custom-provider-header': 'provider-header-value',
-      'custom-request-header': 'request-header-value',
-    });
-
-    expect(server.calls[0].requestUserAgent).toContain(
-      `ai-sdk/deepgram/0.0.0-test`,
-    );
-  });
-
-  it('should pass query parameters for model', async () => {
-    prepareAudioResponse();
-
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-    });
-
-    const url = new URL(server.calls[0].requestUrl);
-    expect(url.searchParams.get('model')).toBe('aura-2-helena-en');
-  });
-
-  it('should map outputFormat to encoding/container', async () => {
-    prepareAudioResponse();
-
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      outputFormat: 'wav',
-    });
-
-    const url = new URL(server.calls[0].requestUrl);
-    expect(url.searchParams.get('container')).toBe('wav');
-    expect(url.searchParams.get('encoding')).toBe('linear16');
-  });
-
-  it('should pass provider options', async () => {
-    prepareAudioResponse();
-
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      providerOptions: {
-        deepgram: {
-          encoding: 'mp3',
-          bitRate: 48000,
-          container: 'wav',
-          callback: 'https://example.com/callback',
-          callbackMethod: 'POST',
-          mipOptOut: true,
-          tag: 'test-tag',
-        },
-      },
-    });
-
-    const url = new URL(server.calls[0].requestUrl);
-    expect(url.searchParams.get('encoding')).toBe('mp3');
-    expect(url.searchParams.get('bit_rate')).toBe('48000');
-    // mp3 doesn't support container, so it should be removed
-    expect(url.searchParams.get('container')).toBeNull();
-    expect(url.searchParams.get('callback')).toBe(
-      'https://example.com/callback',
-    );
-    expect(url.searchParams.get('callback_method')).toBe('POST');
-    expect(url.searchParams.get('mip_opt_out')).toBe('true');
-    expect(url.searchParams.get('tag')).toBe('test-tag');
-  });
-
-  it('should handle array tag', async () => {
-    prepareAudioResponse();
-
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      providerOptions: {
-        deepgram: {
-          tag: ['tag1', 'tag2'],
-        },
-      },
-    });
-
-    const url = new URL(server.calls[0].requestUrl);
-    expect(url.searchParams.get('tag')).toBe('tag1,tag2');
-  });
-
-  it('should return audio data', async () => {
-    const audio = new Uint8Array(100); // Mock audio data
-    prepareAudioResponse({
-      headers: {
-        'x-request-id': 'test-request-id',
-      },
-    });
-
-    const result = await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-    });
-
-    expect(result.audio).toStrictEqual(audio);
-  });
-
-  it('should include response data with timestamp, modelId and headers', async () => {
-    prepareAudioResponse({
-      headers: {
-        'x-request-id': 'test-request-id',
-      },
-    });
-
-    const testDate = new Date(0);
-    const customModel = new DeepgramSpeechModel('aura-2-helena-en', {
-      provider: 'test-provider',
-      url: () => 'https://api.deepgram.com/v1/speak',
-      headers: () => ({}),
-      _internal: {
-        currentDate: () => testDate,
-      },
-    });
-
-    const result = await customModel.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-    });
-
-    expect(result.response).toMatchObject({
-      timestamp: testDate,
-      modelId: 'aura-2-helena-en',
-      headers: {
-        'content-type': 'audio/mp3',
-        'x-request-id': 'test-request-id',
-      },
-    });
-  });
-
-  it('should warn about unsupported voice parameter', async () => {
-    prepareAudioResponse();
-
-    const result = await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      voice: 'different-voice',
-    });
-
-    expect(result.warnings).toMatchInlineSnapshot(`
-      [
-        {
-          "details": "Deepgram TTS models embed the voice in the model ID. The voice parameter "different-voice" was ignored. Use the model ID to select a voice (e.g., "aura-2-helena-en").",
-          "feature": "voice",
-          "type": "unsupported",
-        },
-      ]
-    `);
-  });
-
-  it('should warn about unsupported speed parameter', async () => {
-    prepareAudioResponse();
-
-    const result = await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      speed: 1.5,
-    });
-
-    expect(result.warnings).toMatchInlineSnapshot(`
-      [
-        {
-          "details": "Deepgram TTS REST API does not support speed adjustment. Speed parameter was ignored.",
-          "feature": "speed",
-          "type": "unsupported",
-        },
-      ]
-    `);
-  });
-
-  it('should warn about unsupported language parameter', async () => {
-    prepareAudioResponse();
-
-    const result = await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      language: 'en',
-    });
-
-    expect(result.warnings).toMatchInlineSnapshot(`
-      [
-        {
-          "details": "Deepgram TTS models are language-specific via the model ID. Language parameter "en" was ignored. Select a model with the appropriate language suffix (e.g., "-en" for English).",
-          "feature": "language",
-          "type": "unsupported",
-        },
-      ]
-    `);
-  });
-
-  it('should warn about unsupported instructions parameter', async () => {
-    prepareAudioResponse();
-
-    const result = await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      instructions: 'Speak slowly',
-    });
-
-    expect(result.warnings).toMatchInlineSnapshot(`
-      [
-        {
-          "details": "Deepgram TTS REST API does not support instructions. Instructions parameter was ignored.",
-          "feature": "instructions",
-          "type": "unsupported",
-        },
-      ]
-    `);
-  });
-
-  it('should include request body in response', async () => {
-    prepareAudioResponse();
-
-    const result = await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-    });
-
-    expect(result.request?.body).toBe(
-      JSON.stringify({ text: 'Hello, welcome to Deepgram!' }),
-    );
-  });
-
-  it('should clean up incompatible parameters when encoding changes via providerOptions', async () => {
-    prepareAudioResponse();
-
-    // Test case 1: outputFormat sets sample_rate, encoding changed to mp3 (fixed sample rate)
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      outputFormat: 'linear16_16000', // Sets: encoding=linear16, sample_rate=16000
-      providerOptions: {
-        deepgram: {
-          encoding: 'mp3', // Changes encoding to mp3
-        },
-      },
-    });
-
-    const url1 = new URL(server.calls[0].requestUrl);
-    expect(url1.searchParams.get('encoding')).toBe('mp3');
-    expect(url1.searchParams.get('sample_rate')).toBeNull(); // Should be removed
-
-    // Test case 2: outputFormat sets container for linear16, encoding changed to opus
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      outputFormat: 'linear16_16000', // Sets: encoding=linear16, container=wav
-      providerOptions: {
-        deepgram: {
-          encoding: 'opus', // Changes encoding to opus
-        },
-      },
-    });
-
-    const url2 = new URL(server.calls[1].requestUrl);
-    expect(url2.searchParams.get('encoding')).toBe('opus');
-    expect(url2.searchParams.get('container')).toBe('ogg'); // Should be ogg, not wav
-    expect(url2.searchParams.get('sample_rate')).toBeNull(); // Should be removed
-
-    // Test case 3: outputFormat sets bit_rate, encoding changed to linear16 (no bitrate support)
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      outputFormat: 'mp3', // Sets: encoding=mp3
-      providerOptions: {
-        deepgram: {
-          encoding: 'linear16', // Changes encoding to linear16
-          bitRate: 48000, // Try to set bitrate
-        },
-      },
-    });
-
-    const url3 = new URL(server.calls[2].requestUrl);
-    expect(url3.searchParams.get('encoding')).toBe('linear16');
-    expect(url3.searchParams.get('bit_rate')).toBeNull(); // Should be removed
-  });
-
-  it('should clean up incompatible parameters when container changes encoding implicitly', async () => {
-    prepareAudioResponse();
-
-    // Test case: outputFormat sets sample_rate, container changes encoding to opus
-    await model.doGenerate({
-      text: 'Hello, welcome to Deepgram!',
-      outputFormat: 'linear16_16000', // Sets: encoding=linear16, sample_rate=16000
-      providerOptions: {
-        deepgram: {
-          container: 'ogg', // Changes encoding to opus implicitly
-        },
-      },
-    });
-
-    const callIndex = server.calls.length - 1;
-    const url = new URL(server.calls[callIndex].requestUrl);
-    expect(url.searchParams.get('encoding')).toBe('opus');
-    expect(url.searchParams.get('container')).toBe('ogg');
-    expect(url.searchParams.get('sample_rate')).toBeNull(); // Should be removed (opus has fixed sample rate)
-  });
-});

package/src/deepgram-transcription-model.test.ts

@@ -1,249 +0,0 @@
-import { createTestServer } from '@ai-sdk/test-server/with-vitest';
-import { DeepgramTranscriptionModel } from './deepgram-transcription-model';
-import { createDeepgram } from './deepgram-provider';
-import { readFile } from 'node:fs/promises';
-import path from 'node:path';
-import { describe, it, expect, vi } from 'vitest';
-
-vi.mock('./version', () => ({
-  VERSION: '0.0.0-test',
-}));
-
-const audioData = await readFile(path.join(__dirname, 'transcript-test.mp3'));
-const provider = createDeepgram({ apiKey: 'test-api-key' });
-const model = provider.transcription('nova-3');
-
-const server = createTestServer({
-  'https://api.deepgram.com/v1/listen': {},
-});
-
-describe('doGenerate', () => {
-  function prepareJsonResponse({
-    headers,
-    detectedLanguage,
-  }: {
-    headers?: Record<string, string>;
-    detectedLanguage?: string;
-  } = {}) {
-    server.urls['https://api.deepgram.com/v1/listen'].response = {
-      type: 'json-value',
-      headers,
-      body: {
-        metadata: {
-          transaction_key: 'deprecated',
-          request_id: '2479c8c8-8185-40ac-9ac6-f0874419f793',
-          sha256:
-            '154e291ecfa8be6ab8343560bcc109008fa7853eb5372533e8efdefc9b504c33',
-          created: '2024-02-06T19:56:16.180Z',
-          duration: 25.933313,
-          channels: 1,
-          models: ['30089e05-99d1-4376-b32e-c263170674af'],
-          model_info: {
-            '30089e05-99d1-4376-b32e-c263170674af': {
-              name: '2-general-nova',
-              version: '2024-01-09.29447',
-              arch: 'nova-3',
-            },
-          },
-        },
-        results: {
-          channels: [
-            {
-              detected_language: detectedLanguage,
-              alternatives: [
-                {
-                  transcript: 'Hello world!',
-                  confidence: 0.99902344,
-                  words: [
-                    {
-                      word: 'hello',
-                      start: 0.08,
-                      end: 0.32,
-                      confidence: 0.9975586,
-                      punctuated_word: 'Hello.',
-                    },
-                    {
-                      word: 'world',
-                      start: 0.32,
-                      end: 0.79999995,
-                      confidence: 0.9921875,
-                      punctuated_word: 'World',
-                    },
-                  ],
-                  paragraphs: {
-                    transcript: 'Hello world!',
-                    paragraphs: [
-                      {
-                        sentences: [
-                          {
-                            text: 'Hello world!',
-                            start: 0.08,
-                            end: 0.32,
-                          },
-                        ],
-                        num_words: 2,
-                        start: 0.08,
-                        end: 0.79999995,
-                      },
-                    ],
-                  },
-                },
-              ],
-            },
-          ],
-        },
-      },
-    };
-  }
-
-  it('should pass the model', async () => {
-    prepareJsonResponse();
-
-    await model.doGenerate({
-      audio: audioData,
-      mediaType: 'audio/wav',
-    });
-
-    expect(await server.calls[0].requestBodyMultipart).toMatchObject({});
-  });
-
-  it('should pass headers', async () => {
-    prepareJsonResponse();
-
-    const provider = createDeepgram({
-      apiKey: 'test-api-key',
-      headers: {
-        'Custom-Provider-Header': 'provider-header-value',
-      },
-    });
-
-    await provider.transcription('nova-3').doGenerate({
-      audio: audioData,
-      mediaType: 'audio/wav',
-      headers: {
-        'Custom-Request-Header': 'request-header-value',
-      },
-    });
-
-    expect(server.calls[0].requestHeaders).toMatchObject({
-      authorization: 'Token test-api-key',
-      'content-type': 'audio/wav',
-      'custom-provider-header': 'provider-header-value',
-      'custom-request-header': 'request-header-value',
-    });
-    expect(server.calls[0].requestUserAgent).toContain(
-      `ai-sdk/deepgram/0.0.0-test`,
-    );
-  });
-
-  it('should extract the transcription text', async () => {
-    prepareJsonResponse();
-
-    const result = await model.doGenerate({
-      audio: audioData,
-      mediaType: 'audio/wav',
-    });
-
-    expect(result.text).toBe('Hello world!');
-  });
-
-  it('should include response data with timestamp, modelId and headers', async () => {
-    prepareJsonResponse({
-      headers: {
-        'x-request-id': 'test-request-id',
-        'x-ratelimit-remaining': '123',
-      },
-    });
-
-    const testDate = new Date(0);
-    const customModel = new DeepgramTranscriptionModel('nova-3', {
-      provider: 'test-provider',
-      url: () => 'https://api.deepgram.com/v1/listen',
-      headers: () => ({}),
-      _internal: {
-        currentDate: () => testDate,
-      },
-    });
-
-    const result = await customModel.doGenerate({
-      audio: audioData,
-      mediaType: 'audio/wav',
-    });
-
-    expect(result.response).toMatchObject({
-      timestamp: testDate,
-      modelId: 'nova-3',
-      headers: {
-        'content-type': 'application/json',
-        'x-request-id': 'test-request-id',
-        'x-ratelimit-remaining': '123',
-      },
-    });
-  });
-
-  it('should use real date when no custom date provider is specified', async () => {
-    prepareJsonResponse();
-
-    const testDate = new Date(0);
-    const customModel = new DeepgramTranscriptionModel('nova-3', {
-      provider: 'test-provider',
-      url: () => 'https://api.deepgram.com/v1/listen',
-      headers: () => ({}),
-      _internal: {
-        currentDate: () => testDate,
-      },
-    });
-
-    const result = await customModel.doGenerate({
-      audio: audioData,
-      mediaType: 'audio/wav',
-    });
-
-    expect(result.response.timestamp.getTime()).toEqual(testDate.getTime());
-    expect(result.response.modelId).toBe('nova-3');
-  });
-
-  it('should pass detectLanguage as detect_language query parameter', async () => {
-    prepareJsonResponse();
-
-    await model.doGenerate({
-      audio: audioData,
-      mediaType: 'audio/wav',
-      providerOptions: {
-        deepgram: {
-          detectLanguage: true,
-        },
-      },
-    });
-
-    const requestUrl = server.calls[0].requestUrl;
-    expect(requestUrl).toContain('detect_language=true');
-  });
-
-  it('should return detected language from response', async () => {
-    prepareJsonResponse({ detectedLanguage: 'sv' });
-
-    const result = await model.doGenerate({
-      audio: audioData,
-      mediaType: 'audio/wav',
-      providerOptions: {
-        deepgram: {
-          detectLanguage: true,
-        },
-      },
-    });
-
-    expect(result.language).toBe('sv');
-  });
-
-  it('should return undefined language when not detected', async () => {
-    prepareJsonResponse();
-
-    const result = await model.doGenerate({
-      audio: audioData,
-      mediaType: 'audio/wav',
-    });
-
-    expect(result.language).toBeUndefined();
-  });
-});