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

package/README.md

@@ -1,85 +1,163 @@
-# Deepgram Node.js SDK
-
- [![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4) [![CI](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml/badge.svg)](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml) [![npm (scoped)](https://img.shields.io/npm/v/@deepgram/sdk)](https://www.npmjs.com/package/@deepgram/sdk) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-rounded)](CODE_OF_CONDUCT.md)
-
-Official Node.js SDK for [Deepgram](https://www.deepgram.com/). Power your apps with world-class speech and Language AI models.
-> This SDK only supports hosted usage of api.deepgram.com.
-
-> ### Deprecated JS Browser SDK
->
-> As of version 2.x, the JS Browser SDK was removed from the Node SDK and will become an independent Client SDK.
-> To use the older SDK, please `npm i @deepgram/sdk@1.2.1` and use `@deepgram/sdk/browser`.
-
-* [Deepgram Node.js SDK](#deepgram-nodejs-sdk)
-* [Getting an API Key](#getting-an-api-key)
-* [Installation](#installation)
-* [Constructor](#constructor)
-* [Transcription](#transcription)
-  * [Remote Files](#remote-files)
-  * [Local Files](#local-files)
-  * [Live Audio](#live-audio)
-* [Projects](#projects)
-  * [Get Projects](#get-projects)
-  * [Get Project](#get-project)
-  * [Update Project](#update-project)
-  * [Delete Project](#delete-project)
-* [Keys](#keys)
-  * [List Keys](#list-keys)
-  * [Get Key](#get-key)
-  * [Create Key](#create-key)
-  * [Delete Key](#delete-key)
-* [Members](#members)
-  * [Get Members](#get-members)
-  * [Remove Member](#remove-member)
-* [Scopes](#scopes)
-  * [Get Member Scopes](#get-member-scopes)
-  * [Update Scope](#update-scope)
-* [Invitations](#invitations)
-  * [List Invites](#list-invites)
-  * [Send Invite](#send-invite)
-  * [Delete Invite](#delete-invite)
-  * [Leave Project](#leave-project)
-* [Usage](#usage)
-  * [Get All Requests](#get-all-requests)
-  * [Get Request](#get-request)
-  * [Summarize Usage](#summarize-usage)
-  * [Get Fields](#get-fields)
-* [Billing](#billing)
-  * [Get All Balances](#get-all-balances)
-  * [Get Balance](#get-balance)
-* [Development and Contributing](#development-and-contributing)
-* [Getting Help](#getting-help)
-
-# Getting an API Key
-
-🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).
+# Deepgram JavaScript SDK
+
+[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4) [![CI](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml/badge.svg)](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml) [![npm (scoped)](https://img.shields.io/npm/v/@deepgram/sdk)](https://www.npmjs.com/package/@deepgram/sdk) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-rounded)](CODE_OF_CONDUCT.md)
+
+Official JavaScript SDK for [Deepgram](https://www.deepgram.com/). Power your apps with world-class speech and Language AI models.
+
+- [Installation](#installation)
+  - [UMD](#umd)
+  - [ESM](#esm)
+- [Initialization](#initialization)
+  - [Getting an API Key](#getting-an-api-key)
+- [Scoped Configuration](#scoped-configuration)
+  - [Rest requests in the browser](#rest-requests-in-the-browser)
+- [Transcription](#transcription)
+  - [Remote Files](#remote-files)
+  - [Local Files](#local-files)
+  - [Live Audio](#live-audio)
+- [Transcribing to captions](#transcribing-to-captions)
+- [Projects](#projects)
+  - [Get Projects](#get-projects)
+  - [Get Project](#get-project)
+  - [Update Project](#update-project)
+  - [Delete Project](#delete-project)
+- [Keys](#keys)
+  - [List Keys](#list-keys)
+  - [Get Key](#get-key)
+  - [Create Key](#create-key)
+  - [Delete Key](#delete-key)
+- [Members](#members)
+  - [Get Members](#get-members)
+  - [Remove Member](#remove-member)
+- [Scopes](#scopes)
+  - [Get Member Scopes](#get-member-scopes)
+  - [Update Scope](#update-scope)
+- [Invitations](#invitations)
+  - [List Invites](#list-invites)
+  - [Send Invite](#send-invite)
+  - [Delete Invite](#delete-invite)
+  - [Leave Project](#leave-project)
+- [Usage](#usage)
+  - [Get All Requests](#get-all-requests)
+  - [Get Request](#get-request)
+  - [Summarize Usage](#summarize-usage)
+  - [Get Fields](#get-fields)
+- [Billing](#billing)
+  - [Get All Balances](#get-all-balances)
+  - [Get Balance](#get-balance)
+- [On-Prem APIs](#on-prem-apis)
+  - [List On-Prem credentials](#list-on-prem-credentials)
+  - [Get On-Prem credentials](#get-on-prem-credentials)
+  - [Create On-Prem credentials](#create-on-prem-credentials)
+  - [Delete On-Prem credentials](#delete-on-prem-credentials)
+- [Development and Contributing](#development-and-contributing)
+- [Getting Help](#getting-help)
 
 # Installation
 
+You can install this SDK directly from [npm](https://www.npmjs.com/package/@deepgram/sdk).
+
 ```bash
 npm install @deepgram/sdk
 # - or -
 # yarn add @deepgram/sdk
 ```
 
-# Constructor
+## UMD
+
+You can now use plain `<script>`s to import deepgram from CDNs, like:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@deepgram/sdk"></script>
+```
+
+or even:
+
+```html
+<script src="https://unpkg.com/@deepgram/sdk"></script>
+```
+
+Then you can use it from a global deepgram variable:
+
+```html
+<script>
+  const { createClient } = deepgram;
+  const _deepgram = createClient("deepgram-api-key");
+
+  console.log("Deepgram Instance: ", _deepgram);
+  // ...
+</script>
+```
+
+## ESM
+
+You can now use type="module" `<script>`s to import deepgram from CDNs, like:
+
+```html
+<script type="module">
+  import { createClient } from "https://cdn.jsdelivr.net/npm/@deepgram/sdk/+esm";
+  const deepgram = createClient("deepgram-api-key");
+
+  console.log("Deepgram Instance: ", deepgram);
+  // ...
+</script>
+```
+
+# Initialization
 
 ```js
-const { Deepgram } = require("@deepgram/sdk");
+import { createClient } from "@deepgram/sdk";
 // - or -
-// import { Deepgram } from "@deepgram/sdk";
+// const { createClient } = require("@deepgram/sdk");
 
-const deepgram = new Deepgram(DEEPGRAM_API_KEY);
+const deepgram = createClient(DEEPGRAM_API_KEY);
 ```
 
+## Getting an API Key
+
+🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).
+
+# Scoped Configuration
+
+A new feature is scoped configuration. You'll be able to configure various aspects of the SDK from the initialization.
+
+```js
+import { createClient } from "@deepgram/sdk";
+// - or -
+// const { createClient } = require("@deepgram/sdk");
+
+const deepgram = createClient(DEEPGRAM_API_KEY, {
+  global: { url: "https://api.beta.deepgram.com" },
+  // proxy: { url: "http://localhost:8080" }
+});
+```
+
+## Rest requests in the browser
+
+This SDK now works in the browser. If you'd like to make REST-based requests (pre-recorded transcription, on-premise, and management requests), then you'll need to use a proxy as we do not support custom CORS origins on our API. To set up your proxy, you configure the SDK like so:
+
+```js
+import { createClient } from "@deepgram/sdk";
+
+const deepgram = createClient("proxy", {
+  proxy: { url: "http://localhost:8080" },
+});
+```
+
+Your proxy service should replace the Authorization header with `Authorization: token <DEEPGRAM_API_KEY>` and return results verbatim to the SDK.
+
 # Transcription
 
 ## Remote Files
 
 ```js
-const response = await deepgram.transcription.preRecorded(
-  { url: URL_OF_FILE },
-  options
+const { result, error } = await deepgram.listen.prerecorded.transcribeUrl(
+  {
+    url: "https://dpgr.am/spacewalk.wav",
+  },
+  {
+    model: "nova",
+  }
 );
 ```
 
@@ -88,12 +166,22 @@ const response = await deepgram.transcription.preRecorded(
 ## Local Files
 
 ```js
-const response = await deepgram.transcription.preRecorded(
+const { result, error } = await deepgram.listen.prerecorded.transcribeFile(
+  fs.createReadStream("./examples/spacewalk.wav"),
   {
-    stream: fs.createReadStream("/path/to/file"),
-    mimetype: MIMETYPE_OF_FILE,
-  },
-  options
+    model: "nova",
+  }
+);
+```
+
+or
+
+```js
+const { result, error } = await deepgram.listen.prerecorded.transcribeFile(
+  fs.readFileSync("./examples/spacewalk.wav"),
+  {
+    model: "nova",
+  }
 );
 ```
 
@@ -102,17 +190,43 @@ const response = await deepgram.transcription.preRecorded(
 ## Live Audio
 
 ```js
-const ws = dg.transcription.live(options);
+const dgConnection = deepgram.listen.live({ model: "nova" });
+
+dgConnection.on(LiveTranscriptionEvents.Open, () => {
+  dgConnection.on(LiveTranscriptionEvents.Transcript, (data) => {
+    console.log(data);
+  });
 
-// source.addListener('got-some-audio', async (event) => {
-ws.send(event);
-// })
+  source.addListener("got-some-audio", async (event) => {
+    dgConnection.send(event.raw_audio_data);
+  });
+});
 ```
 
-See an example, here: [https://github.com/deepgram-devs/node-live-example](https://github.com/deepgram-devs/node-live-example).
+To see an example, [check out our Node.js example](https://github.com/deepgram-devs/node-live-example) or our [Browser example](https://github.com/deepgram-devs/js-live-example).
 
 [See our API reference for more info](https://developers.deepgram.com/reference/streaming).
 
+# Transcribing to captions
+
+```js
+import { webvtt /* , srt */ } from "@deepgram/captions";
+
+const { result, error } = await deepgram.listen.prerecorded.transcribeUrl(
+  {
+    url: "https://dpgr.am/spacewalk.wav",
+  },
+  {
+    model: "nova",
+  }
+);
+
+const vttOutput = webvtt(result);
+// const srtOutput = srt(result);
+```
+
+[See our standalone captions library for more information](https://github.com/deepgram/deepgram-node-captions).
+
 # Projects
 
 ## Get Projects
@@ -120,7 +234,7 @@ See an example, here: [https://github.com/deepgram-devs/node-live-example](https
 Returns all projects accessible by the API key.
 
 ```js
-const result = await deepgram.projects.list();
+const { result, error } = await deepgram.manage.getProjects();
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-projects).
@@ -130,7 +244,7 @@ const result = await deepgram.projects.list();
 Retrieves a specific project based on the provided project_id.
 
 ```js
-const result = await deepgram.projects.get(project_id);
+const { result, error } = await deepgram.manage.getProject(projectId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-project).
@@ -140,7 +254,7 @@ const result = await deepgram.projects.get(project_id);
 Update a project.
 
 ```js
-const result = await deepgram.projects.update(project_id, options);
+const { result, error } = await deepgram.manage.updateProject(projectId, options);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/update-project).
@@ -150,7 +264,7 @@ const result = await deepgram.projects.update(project_id, options);
 Delete a project.
 
 ```js
-await deepgram.projects.delete(project_id);
+const { error } = await deepgram.manage.deleteProject(projectId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/delete-project).
@@ -162,7 +276,7 @@ await deepgram.projects.delete(project_id);
 Retrieves all keys associated with the provided project_id.
 
 ```js
-const result = await deepgram.keys.list(project_id);
+const { result, error } = await deepgram.manage.getProjectKeys(projectId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/list-keys).
@@ -172,7 +286,7 @@ const result = await deepgram.keys.list(project_id);
 Retrieves a specific key associated with the provided project_id.
 
 ```js
-const result = await deepgram.keys.get(project_id, key_id);
+const { result, error } = await deepgram.manage.getProjectKey(projectId, projectKeyId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-key).
@@ -182,8 +296,7 @@ const result = await deepgram.keys.get(project_id, key_id);
 Creates an API key with the provided scopes.
 
 ```js
-let scopes = ["member", "etc"];
-const result = await deepgram.keys.create(project_id, comment, scopes, options);
+const { result, error } = await deepgram.manage.createProjectKey(projectId, options);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/create-key).
@@ -193,7 +306,7 @@ const result = await deepgram.keys.create(project_id, comment, scopes, options);
 Deletes a specific key associated with the provided project_id.
 
 ```js
-await deepgram.keys.delete(project_id, key_id);
+const { error } = await deepgram.manage.deleteProjectKey(projectId, projectKeyId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/delete-key).
@@ -205,7 +318,7 @@ await deepgram.keys.delete(project_id, key_id);
 Retrieves account objects for all of the accounts in the specified project_id.
 
 ```js
-const result = await deepgram.members.listMembers(project_id);
+const { result, error } = await deepgram.manage.getProjectMembers(projectId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-members).
@@ -215,7 +328,7 @@ const result = await deepgram.members.listMembers(project_id);
 Removes member account for specified member_id.
 
 ```js
-const result = await deepgram.members.removeMember(project_id, member_id);
+const { error } = await deepgram.manage.removeProjectMember(projectId, projectMemberId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/remove-member).
@@ -227,7 +340,7 @@ const result = await deepgram.members.removeMember(project_id, member_id);
 Retrieves scopes of the specified member in the specified project.
 
 ```js
-const result = await deepgram.scopes.get(project_id, member_id);
+const { result, error } = await deepgram.manage.getProjectMemberScopes(projectId, projectMemberId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-member-scopes).
@@ -237,8 +350,11 @@ const result = await deepgram.scopes.get(project_id, member_id);
 Updates the scope for the specified member in the specified project.
 
 ```js
-let scope = "member:read";
-const result = await deepgram.scopes.update(project_id, member_id, scope);
+const { result, error } = await deepgram.manage.updateProjectMemberScope(
+  projectId,
+  projectMemberId,
+  options
+);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/update-scope).
@@ -250,7 +366,7 @@ const result = await deepgram.scopes.update(project_id, member_id, scope);
 Retrieves all invitations associated with the provided project_id.
 
 ```js
-const result = await deepgram.invitations.list(project_id);
+const { result, error } = await deepgram.manage.getProjectInvites(projectId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/list-invites).
@@ -260,7 +376,7 @@ const result = await deepgram.invitations.list(project_id);
 Sends an invitation to the provided email address.
 
 ```js
-const result = await deepgram.invitation.send(project_id, options);
+const { result, error } = await deepgram.manage.sendProjectInvite(projectId, options);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/send-invites).
@@ -270,8 +386,7 @@ const result = await deepgram.invitation.send(project_id, options);
 Removes the specified invitation from the project.
 
 ```js
-let email = "devrel@deepgram.com";
-const result = await deepgram.invitation.delete(project_id, email);
+const { error } = await deepgram.manage.deleteProjectInvite(projectId, email);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/delete-invite).
@@ -281,7 +396,7 @@ const result = await deepgram.invitation.delete(project_id, email);
 Removes the authenticated user from the project.
 
 ```js
-const result = await deepgram.invitation.leave(project_id);
+const { result, error } = await deepgram.manage.leaveProject(projectId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/leave-project).
@@ -293,7 +408,7 @@ const result = await deepgram.invitation.leave(project_id);
 Retrieves all requests associated with the provided project_id based on the provided options.
 
 ```js
-const result = await deepgram.usage.listRequests(project_id, options);
+const { result, error } = await deepgram.manage.getProjectUsageRequest(projectId, requestId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-all-requests).
@@ -303,7 +418,7 @@ const result = await deepgram.usage.listRequests(project_id, options);
 Retrieves a specific request associated with the provided project_id.
 
 ```js
-const result = await deepgram.usage.getRequest(project_id, request_id);
+const { result, error } = await deepgram.manage.getProjectUsageRequest(projectId, requestId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-request).
@@ -313,7 +428,7 @@ const result = await deepgram.usage.getRequest(project_id, request_id);
 Retrieves usage associated with the provided project_id based on the provided options.
 
 ```js
-const result = await deepgram.usage.getUsage(project_id, options);
+const { result, error } = await deepgram.manage.getProjectUsageSummary(projectId, options);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/summarize-usage).
@@ -323,7 +438,7 @@ const result = await deepgram.usage.getUsage(project_id, options);
 Lists the features, models, tags, languages, and processing method used for requests in the specified project.
 
 ```js
-const result = await deepgram.usage.getFields(project_id, options);
+const { result, error } = await deepgram.manage.getProjectUsageFields(projectId, options);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-fields).
@@ -335,7 +450,7 @@ const result = await deepgram.usage.getFields(project_id, options);
 Retrieves the list of balance info for the specified project.
 
 ```js
-const result = await deepgram.billing.listBalances(project_id);
+const { result, error } = await deepgram.manage.getProjectBalances(projectId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-all-balances).
@@ -345,11 +460,37 @@ const result = await deepgram.billing.listBalances(project_id);
 Retrieves the balance info for the specified project and balance_id.
 
 ```js
-const result = await deepgram.billing.getBalance(project_id, balance_id);
+const { result, error } = await deepgram.manage.getProjectBalance(projectId, balanceId);
 ```
 
 [See our API reference for more info](https://developers.deepgram.com/reference/get-balance).
 
+# On-Prem APIs
+
+## List On-Prem credentials
+
+```js
+const { result, error } = await deepgram.onprem.listCredentials(projectId);
+```
+
+## Get On-Prem credentials
+
+```js
+const { result, error } = await deepgram.onprem.getCredentials(projectId, credentialId);
+```
+
+## Create On-Prem credentials
+
+```js
+const { result, error } = await deepgram.onprem.createCredentials(projectId, options);
+```
+
+## Delete On-Prem credentials
+
+```js
+const { result, error } = await deepgram.onprem.deleteCredentials(projectId, credentialId);
+```
+
 # Development and Contributing
 
 Interested in contributing? We ❤️ pull requests!
@@ -363,6 +504,6 @@ To make sure our community is safe for all, be sure to review and agree to our
 We love to hear from you so if you have questions, comments or find a bug in the
 project, let us know! You can either:
 
-- [Open an issue in this repository](https://github.com/deepgram/node-sdk/issues/new)
-- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
+- [Open an issue in this repository](https://github.com/deepgram/deepgram-node-sdk/issues/new)
 - [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
+- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)

package/dist/main/DeepgramClient.d.ts

@@ -1,19 +1,14 @@
+import { AbstractClient } from "./packages/AbstractClient";
 import { ListenClient } from "./packages/ListenClient";
 import { ManageClient } from "./packages/ManageClient";
 import { OnPremClient } from "./packages/OnPremClient";
-import type { DeepgramClientOptions } from "./lib/types/DeepgramClientOptions";
 /**
  * Deepgram Client.
  *
  * An isomorphic Javascript client for interacting with the Deepgram API.
  * @see https://developers.deepgram.com
  */
-export default class DeepgramClient {
-    protected apiKey: string;
-    protected key: string;
-    protected baseUrl: URL;
-    protected headers: Record<string, string>;
-    constructor(apiKey: string, options?: DeepgramClientOptions | undefined);
+export default class DeepgramClient extends AbstractClient {
     get listen(): ListenClient;
     get manage(): ManageClient;
     get onprem(): OnPremClient;

package/dist/main/DeepgramClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DeepgramClient.d.ts","sourceRoot":"","sources":["../../src/DeepgramClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IAM/B,SAAS,CAAC,MAAM,EAAE,MAAM;IAL1B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAG9B,MAAM,EAAE,MAAM,EACxB,OAAO,GAAE,qBAAqB,GAAG,SAA2B;IA8B9D,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;CACF"}
+{"version":3,"file":"DeepgramClient.d.ts","sourceRoot":"","sources":["../../src/DeepgramClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,cAAc;IACxD,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;CACF"}

package/dist/main/DeepgramClient.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const helpers_1 = require("./lib/helpers");
-const constants_1 = require("./lib/constants");
+const AbstractClient_1 = require("./packages/AbstractClient");
 const ListenClient_1 = require("./packages/ListenClient");
 const ManageClient_1 = require("./packages/ManageClient");
 const OnPremClient_1 = require("./packages/OnPremClient");
@@ -11,37 +10,15 @@ const OnPremClient_1 = require("./packages/OnPremClient");
  * An isomorphic Javascript client for interacting with the Deepgram API.
  * @see https://developers.deepgram.com
  */
-class DeepgramClient {
-    constructor(apiKey, options = constants_1.DEFAULT_OPTIONS) {
-        var _a, _b;
-        this.apiKey = apiKey;
-        this.key = apiKey;
-        if (!apiKey) {
-            this.key = process.env.DEEPGRAM_API_KEY;
-        }
-        if (!this.key) {
-            if (!apiKey)
-                throw new Error("A deepgram API key is required");
-        }
-        const settings = (0, helpers_1.applySettingDefaults)(options, constants_1.DEFAULT_OPTIONS);
-        if (!settings.global.url) {
-            throw new Error(`An API URL is required. It should be set to ${constants_1.DEFAULT_URL} by default. No idea what happened!`);
-        }
-        let url = settings.global.url;
-        if (!/^https?:\/\//i.test(url)) {
-            url = "https://" + url;
-        }
-        this.baseUrl = new URL((0, helpers_1.stripTrailingSlash)(url));
-        this.headers = (_b = (_a = settings.global) === null || _a === void 0 ? void 0 : _a.headers) !== null && _b !== void 0 ? _b : {};
-    }
+class DeepgramClient extends AbstractClient_1.AbstractClient {
     get listen() {
-        return new ListenClient_1.ListenClient(this.baseUrl, this.headers, this.key);
+        return new ListenClient_1.ListenClient(this.key, this.options);
     }
     get manage() {
-        return new ManageClient_1.ManageClient(this.baseUrl, this.headers, this.key);
+        return new ManageClient_1.ManageClient(this.key, this.options);
     }
     get onprem() {
-        return new OnPremClient_1.OnPremClient(this.baseUrl, this.headers, this.key);
+        return new OnPremClient_1.OnPremClient(this.key, this.options);
     }
 }
 exports.default = DeepgramClient;

package/dist/main/DeepgramClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeepgramClient.js","sourceRoot":"","sources":["../../src/DeepgramClient.ts"],"names":[],"mappings":";;AAAA,2CAAyE;AACzE,+CAA+D;AAC/D,0DAAuD;AACvD,0DAAuD;AACvD,0DAAuD;AAGvD;;;;;GAKG;AACH,MAAqB,cAAc;IAKjC,YACY,MAAc,EACxB,UAA6C,2BAAe;;QADlD,WAAM,GAAN,MAAM,CAAQ;QAGxB,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC;QAElB,IAAI,CAAC,MAAM,EAAE;YACX,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,gBAA0B,CAAC;SACnD;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SAChE;QAED,MAAM,QAAQ,GAAG,IAAA,8BAAoB,EAAC,OAAO,EAAE,2BAAe,CAAC,CAAC;QAEhE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE;YACxB,MAAM,IAAI,KAAK,CACb,+CAA+C,uBAAW,qCAAqC,CAChG,CAAC;SACH;QAED,IAAI,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;QAE9B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC9B,GAAG,GAAG,UAAU,GAAG,GAAG,CAAC;SACxB;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,IAAA,4BAAkB,EAAC,GAAG,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,MAAA,MAAA,QAAQ,CAAC,MAAM,0CAAE,OAAO,mCAAI,EAAE,CAAC;IAChD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,2BAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,2BAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,2BAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,CAAC;CACF;AAhDD,iCAgDC"}
+{"version":3,"file":"DeepgramClient.js","sourceRoot":"","sources":["../../src/DeepgramClient.ts"],"names":[],"mappings":";;AAAA,8DAA2D;AAC3D,0DAAuD;AACvD,0DAAuD;AACvD,0DAAuD;AAEvD;;;;;GAKG;AACH,MAAqB,cAAe,SAAQ,+BAAc;IACxD,IAAI,MAAM;QACR,OAAO,IAAI,2BAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,2BAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,2BAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;CACF;AAZD,iCAYC"}

package/dist/main/index.d.ts

@@ -8,8 +8,13 @@ export { createClient, DeepgramClient };
 /**
  * Helpful exports.
  */
+export * from "./packages";
 export * from "./lib/types";
 export * from "./lib/enums";
 export * from "./lib/constants";
 export * from "./lib/errors";
+/**
+ * Captions.
+ */
+export { webvtt, srt } from "@deepgram/captions";
 //# sourceMappingURL=index.d.ts.map

package/dist/main/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEzD;;GAEG;AACH,QAAA,MAAM,YAAY,WAAY,MAAM,YAAY,qBAAqB,KAAG,cAEvE,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAExC;;GAEG;AACH,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEzD;;GAEG;AACH,QAAA,MAAM,YAAY,WAAY,MAAM,YAAW,qBAAqB,KAAQ,cAE3E,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAExC;;GAEG;AACH,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAE7B;;GAEG;AACH,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC"}