@deepgram/sdk 2.4.0 → 3.0.0-alpha.2

package/src/packages/PrerecordedClient.ts

@@ -0,0 +1,188 @@
+import { AbstractRestfulClient } from "./AbstractRestfulClient";
+import {
+  CallbackUrl,
+  appendSearchParams,
+  isBufferSource,
+  isReadStreamSource,
+  isUrlSource,
+} from "../lib/helpers";
+import { DeepgramError, isDeepgramError } from "../lib/errors";
+import type {
+  AsyncPrerecordedResponse,
+  DeepgramResponse,
+  Fetch,
+  FileSource,
+  PrerecordedOptions,
+  SyncPrerecordedResponse,
+  UrlSource,
+} from "../lib/types";
+
+export class PrerecordedClient extends AbstractRestfulClient {
+  async transcribeUrl(
+    source: UrlSource,
+    options?: PrerecordedOptions,
+    endpoint = "v1/listen"
+  ): Promise<DeepgramResponse<SyncPrerecordedResponse>> {
+    try {
+      let body;
+      if (isUrlSource(source)) {
+        body = JSON.stringify(source);
+      } else {
+        throw new DeepgramError("Unknown transcription source type");
+      }
+
+      if (options !== undefined && "callback" in options) {
+        throw new DeepgramError(
+          "Callback cannot be provided as an option to a synchronous transcription. Use `asyncPrerecordedUrl` or `asyncPrerecordedFile` instead."
+        );
+      }
+
+      const transcriptionOptions: PrerecordedOptions = { ...{}, ...options };
+
+      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,
+      });
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
+
+  async transcribeFile(
+    source: FileSource,
+    options?: PrerecordedOptions,
+    endpoint = "v1/listen"
+  ): Promise<DeepgramResponse<SyncPrerecordedResponse>> {
+    try {
+      if (source.mimetype === undefined || source.mimetype.length === 0) {
+        throw new DeepgramError(
+          "Mimetype must be provided if the source is a Buffer or a Readable"
+        );
+      }
+
+      this.headers["Content-Type"] = source.mimetype;
+
+      let body;
+      if (isBufferSource(source)) {
+        body = source.buffer;
+      } else if (isReadStreamSource(source)) {
+        body = source.stream;
+      } else {
+        throw new DeepgramError("Unknown transcription source type");
+      }
+
+      if (options !== undefined && "callback" in options) {
+        throw new DeepgramError(
+          "Callback cannot be provided as an option to a synchronous transcription. Use `asyncPrerecordedUrl` or `asyncPrerecordedFile` instead."
+        );
+      }
+
+      const transcriptionOptions: PrerecordedOptions = { ...{}, ...options };
+
+      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,
+      });
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
+
+  async transcribeUrlCallback(
+    source: UrlSource,
+    callback: CallbackUrl,
+    options?: PrerecordedOptions,
+    endpoint = "v1/listen"
+  ): Promise<DeepgramResponse<AsyncPrerecordedResponse>> {
+    try {
+      let body;
+      if (isUrlSource(source)) {
+        body = JSON.stringify(source);
+      } else {
+        throw new DeepgramError("Unknown transcription source type");
+      }
+
+      const transcriptionOptions: PrerecordedOptions = {
+        ...options,
+        ...{ callback: callback.toString() },
+      };
+
+      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,
+      });
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
+
+  async transcribeFileCallback(
+    source: FileSource,
+    callback: CallbackUrl,
+    options?: PrerecordedOptions,
+    endpoint = "v1/listen"
+  ): Promise<DeepgramResponse<AsyncPrerecordedResponse>> {
+    try {
+      if (source.mimetype === undefined || source.mimetype.length === 0) {
+        throw new DeepgramError(
+          "Mimetype must be provided if the source is a Buffer or a Readable"
+        );
+      }
+
+      this.headers["Content-Type"] = source.mimetype;
+
+      let body;
+      if (isBufferSource(source)) {
+        body = source.buffer;
+      } else if (isReadStreamSource(source)) {
+        body = source.stream;
+      } else {
+        throw new DeepgramError("Unknown transcription source type");
+      }
+
+      const transcriptionOptions: PrerecordedOptions = {
+        ...options,
+        ...{ callback: callback.toString() },
+      };
+
+      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,
+      });
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
+}

package/.devcontainer/Dockerfile

@@ -1,14 +0,0 @@
-# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
-ARG VARIANT=16-bullseye
-FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:0-${VARIANT}
-
-# [Optional] Uncomment this section to install additional OS packages.
-# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-#     && apt-get -y install --no-install-recommends <your-package-list-here>
-
-# [Optional] Uncomment if you want to install an additional version of node using nvm
-# ARG EXTRA_NODE_VERSION=10
-# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
-
-# [Optional] Uncomment if you want to install more global node packages
-# RUN su node -c "npm install -g <your-package-list -here>"

package/.devcontainer/base.Dockerfile

@@ -1,17 +0,0 @@
-# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
-ARG VARIANT=16-bullseye
-FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
-
-# Install tslint, typescript. eslint is installed by javascript image
-ARG NODE_MODULES="tslint-to-eslint-config typescript"
-COPY library-scripts/meta.env /usr/local/etc/vscode-dev-containers
-RUN su node -c "umask 0002 && npm install -g ${NODE_MODULES}" \
-    && npm cache clean --force > /dev/null 2>&1
-
-# [Optional] Uncomment this section to install additional OS packages.
-# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-#     && apt-get -y install --no-install-recommends <your-package-list-here>
-
-# [Optional] Uncomment if you want to install an additional version of node using nvm
-# ARG EXTRA_NODE_VERSION=10
-# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"

package/.devcontainer/devcontainer.json

@@ -1,34 +0,0 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
-// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/typescript-node
-{
-	"name": "Node.js & TypeScript",
-	"build": {
-		"dockerfile": "Dockerfile",
-		// Update 'VARIANT' to pick a Node version: 18, 16, 14.
-		// Append -bullseye or -buster to pin to an OS version.
-		// Use -bullseye variants on local on arm64/Apple Silicon.
-		"args": { 
-			"VARIANT": "16-bullseye"
-		}
-	},
-
-	// Configure tool-specific properties.
-	"customizations": {
-		// Configure properties specific to VS Code.
-		"vscode": {
-			// Add the IDs of extensions you want installed when the container is created.
-			"extensions": [
-				"dbaeumer.vscode-eslint"
-			]
-		}
-	},
-
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
-
-	// Use 'postCreateCommand' to run commands after the container is created.
-	// "postCreateCommand": "yarn install",
-
-	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
-	"remoteUser": "node"
-}

package/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-
-# Code of Conduct
-
-The Deepgram developer community is filled with amazing, clever and creative people, and we're excited for you to join us. Our goal is to create safe and inclusive spaces, have meaningful conversations, and explore ways to make sure that every voice is heard and understood.
-
-#### Being a Good Community Member
-
-Because we prioritize creating a safe space for our members, we believe in actively working on how we, as individuals, can ensure a positive community environment through our own actions and mindsets.
-
-Every supportive community starts with each member. We feel it’s important to be open to others, respectful, and supportive. As part of the Deepgram community, please begin by thinking carefully about and agreeing with the following statements:
-
-- I will be welcoming to everyone at the table;
-- I will be patient and open to learning from everyone around me;
-- I will treat everyone with respect, because they deserve it;
-- I will be mindful of the needs and boundaries of others;
-
-We strive to create a space where we learn and grow together. Here are some other key things you can do to make the community great:
-
-### BE HUMBLE
-
-People come from all different places, and it’s best not to make assumptions about what they think or feel. Approach others with curiosity and openness. We **all** have a lot to learn from each other.
-
-### BE HELPFUL
-
-If someone asks for help, consider jumping in. You don’t have to be an expert to talk through a problem, suggest a resource, or help find a solution. We all have something to contribute.
-
-### ENCOURAGE OTHERS
-
-There’s no one path to have a career in technology or to this community. Let’s engage others in ways that create opportunities for learning and fun for all of us.
-
-## Our Pledge
-
-Everyone who participates in our community must agree to abide by our Code of Conduct. By agreeing, you help create a welcoming, respectful, and friendly community based on respect and trust. We are committed to creating a harassment-free community.
-
-These rules will be strictly enforced in any and all of our official spaces, including direct messages, social media, and physical and virtual events. Everyone who participates in these spaces is required to agree to this community code. We also ask and expect community members to observe these rules anywhere the community is meeting (for example, online chats on unofficial platforms or event after-parties).
-
-## Our Standards
-
-### BE RESPECTFUL
-
-Exercise consideration and respect in your speech and actions. Be willing to accept and give feedback gracefully.
-
-Don’t make offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, neuro(a)typicality, physical appearance, body size, race, ethnicity, immigration status, religion, experience level, socioeconomic status, nationality, or other identity markers.
-
-Additionally, don’t insult or demean others. This includes making unwelcome comments about a person’s lifestyle choices and practices, including things related to diet, health, parenting, drugs, or employment. It’s not okay to insult or demean others if it’s "just a joke."
-
-### BE WELCOMING AND OPEN
-
-Encourage others, be supportive and willing to listen, and be willing to learn from others’ perspectives and experiences. Lead with empathy and kindness.
-
-Don’t engage in gatekeeping behaviors, like questioning the intelligence or knowledge of others as a way to prove their credentials. And don’t exclude people for prejudicial reasons.
-
-### RESPECT PRIVACY
-
-Do not publish private communications without consent. Additionally, never disclose private aspects of a person’s personal identity without consent, except as necessary to protect them from intentional abuse.
-
-### RESPECT PERSONAL BOUNDARIES
-
-Do not introduce gratuitous or off-topic sexual images, languages, or behavior in spaces where they are not appropriate. Never make physical contact or simulated physical contact without consent or after a request to stop. Additionally, do not continue to message others about anything if they ask you to stop or leave them alone.
-
-#### BE A GOOD NEIGHBOR
-
-Contribute to the community in a positive and thoughtful way. Consider what’s best for the overall community. Do not make threats of violence, intimidate others, incite violence or intimidation against others, incite self-harm, stalk, follow, or otherwise harass others. Be mindful of your surroundings and of your fellow participants.
-
-Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
-
-# Additional rules for online spaces
-
-For Deepgram’s official online spaces, like our YouTube & Twitch chats, we have some additional rules. Any of the following behaviors can result in a ban without warning.
-
-### DON'T SPAM
-
-Don't spam. We'll ban you.
-
-### KEEP IT LEGAL
-
-If it’s illegal, it’s not allowed on our websites or in our online spaces. Please don’t share links to pirated material or other nefarious things.
-
-### NO TROLLING
-
-Please be earnest. Don’t use excessive sarcasm to annoy or undermine other people. And don’t bait them with bad faith comments or abuse.
-
-### PORNOGRAPHY AND OTHER NSFW STUFF
-
-Please don’t post it or link to it. It doesn’t belong in our online spaces.
-
-### FOUL AND GRAPHIC LANGUAGE
-
-Please do not use excessive curse words. Additionally, do not use graphic sexual or violent language — again, think of our spaces as places for people of all ages.
-
-# Enforcement & Reporting
-
-If you are being harassed by a member of the Deepgram developer community, if you observe someone else being harassed, or you experience actions or behaviors that are contrary to our Code of Conduct, please report the behavior using our [Code of Conduct Report Form](https://developers.deepgram.com/code-of-conduct/report-form/).
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**_Community Impact:_** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**_Consequence:_** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**_Community Impact:_** A violation through a single incident or series of actions.
-
-**_Consequence:_** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**_Community Impact:_** A serious violation of community standards, including sustained inappropriate behavior.
-
-**_Consequence:_** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**_Community Impact:_** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**_Consequence:_** A permanent ban from any sort of public interaction within the community.
-
-# Attribution
-
-This Code of Conduct is adapted from:
-
-- Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct
-- https://eventhandler.community/conduct/, which itself is inspired by Quest, who in turn provides credit to Scripto, the #botALLY Code of Conduct, the LGBTQ in Tech code of Conduct, and the XOXO Code of Conduct.
-
-Community Impact Guidelines, which were copied from InnerSource Commons, were inspired by Mozilla’s code of conduct enforcement ladder.
-
-For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,50 +0,0 @@
-# Contributing Guidelines
-
-Want to contribute to this project? We ❤️ it!
-
-Here are a few types of contributions that we would be interested in hearing about.
-
-- Bug fixes
-  - If you find a bug, please first report it using Github Issues.
-  - Issues that have already been identified as a bug will be labeled `🐛 bug`.
-    - If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
-      - Include a test that isolates the bug and verifies that it was fixed.
-- New Features
-  - If you'd like to accomplish something in the extension that it doesn't already do, describe the problem in a new Github Issue.
-    - Issues that have been identified as a feature request will be labeled `✨ enhancement`.
-    - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending
-      too much time writing the code. In some cases, `✨ enhancement`s may not align well with the project objectives at
-      the time.
-- Tests, Documentation, Miscellaneous
-  - If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative
-    implementation of something that may have more advantages, or any other change we would still be glad hear about
-    it.
-    - If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
-    - If not, open a Github Issue to discuss the idea first.
-- Snippets
-  - To add snippets:
-    - Add a directory in the `snippets` folder with the name of the language.
-    - Add one or more files in the language directory with snippets.
-    - Update the `package.json` to include the snippets you added.
-
-We also welcome anyone to work on any existing issues with the `👋🏽 good first issue` tag.
-
-## Requirements
-
-For a contribution to be accepted:
-
-- The test suite must be complete and pass
-- Code must follow existing styling conventions
-- Commit messages must be descriptive. Related issues should be mentioned by number.
-
-If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still
-continue to add more commits to the branch you have sent the Pull Request from.
-
-## How To
-
-1. Fork this repository on GitHub.
-1. Clone/fetch your fork to your local development machine.
-1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out.
-1. Make your changes and commit them. (Did the tests pass? No linting errors?)
-1. Push your new branch to your fork. (e.g. `git push myname issue-12`)
-1. Open a Pull Request from your new branch to the original fork's `main` branch.

package/dist/billing.d.ts

@@ -1,25 +0,0 @@
-import { BalanceList, Balance, RequestFunction } from "./types";
-export declare class Billing {
-    private _credentials;
-    private _apiUrl;
-    private _requireSSL;
-    private _request;
-    constructor(_credentials: string, _apiUrl: string, _requireSSL: boolean, _request: RequestFunction);
-    /**
-     * Retrieves list of balance info of the specified project.
-     * @param {string} projectId Unique identifier of the project
-     * @param {string} endpoint Custom API endpoint
-     *
-     * @returns {Promise<BalanceList>}
-     */
-    listBalances(projectId: string, endpoint?: string): Promise<BalanceList>;
-    /**
-     * Retrieves balance info of a specified balance_id in the specified project.
-     * @param {string} projectId Unique identifier of the project
-     * @param {string} balanceId Unique identifier of the balance
-     * @param {string} endpoint Custom API endpoint
-     *
-     * @returns {Promise<Balance>}
-     */
-    getBalance(projectId: string, balanceId: string, endpoint?: string): Promise<Balance>;
-}

package/dist/constants/defaultOptions.d.ts

@@ -1,7 +0,0 @@
-/**
- * Default SDK options
- */
-export declare const DefaultOptions: {
-    apiUrl: string;
-    requireSSL: boolean;
-};

package/dist/constants/index.d.ts

@@ -1 +0,0 @@
-export * from "./defaultOptions";

package/dist/enums/alternatives.d.ts

@@ -1,4 +0,0 @@
-export declare const enum Alternatives {
-    One = "one-alternative",
-    Multiple = "multiple-alternatives"
-}

package/dist/enums/connectionState.d.ts

@@ -1,6 +0,0 @@
-export declare enum ConnectionState {
-    CONNECTING = 0,
-    OPEN = 1,
-    CLOSING = 2,
-    CLOSED = 3
-}

package/dist/enums/diarization.d.ts

@@ -1,4 +0,0 @@
-export declare const enum Diarization {
-    Diarized = "diarized",
-    NonDiarized = "non-diarized"
-}

package/dist/enums/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./alternatives";
-export * from "./connectionState";
-export * from "./diarization";
-export * from "./liveTranscriptionEvents";
-export * from "./models";
-export * from "./punctuation";
-export * from "./searchKind";

package/dist/enums/liveTranscriptionEvents.d.ts

@@ -1,6 +0,0 @@
-export declare const enum LiveTranscriptionEvents {
-    Open = "open",
-    Close = "close",
-    TranscriptReceived = "transcriptReceived",
-    Error = "error"
-}

package/dist/enums/models.d.ts

@@ -1,5 +0,0 @@
-export declare const enum Models {
-    General = "general",
-    Meeting = "meeting",
-    PhoneCall = "phonecall"
-}

package/dist/enums/punctuation.d.ts

@@ -1,4 +0,0 @@
-export declare const enum Punctuation {
-    NonPunctuated = "non-punctuated",
-    Punctuated = "punctuated"
-}

package/dist/enums/searchKind.d.ts

@@ -1,4 +0,0 @@
-export declare const enum SearchKind {
-    NoSearch = "no-search",
-    WithSearch = "with-search"
-}

package/dist/helpers/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./secondsToTimestamp";
-export * from "./validateOptions";

package/dist/helpers/secondsToTimestamp.d.ts

@@ -1 +0,0 @@
-export declare function secondsToTimestamp(seconds: number, format?: string): string;

package/dist/helpers/validateOptions.d.ts

@@ -1 +0,0 @@
-export declare function validateOptions(apiKey: string, apiUrl: string): void;

package/dist/httpRequest.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Readable } from "stream";
-export declare function _request<T>(method: string, apiKey: string, apiURL: string, requireSSL: boolean, path: string, payload?: string | Buffer | Readable, options?: Object): Promise<T>;

package/dist/index.d.ts

@@ -1,22 +0,0 @@
-import { Keys } from "./keys";
-import { Projects } from "./projects";
-import { Transcriber } from "./transcription";
-import { Usage } from "./usage";
-import { Members } from "./members";
-import { Invitation } from "./invitation";
-import { Billing } from "./billing";
-import { Scopes } from "./scopes";
-export declare class Deepgram {
-    private _apiUrl;
-    private _apiKey;
-    private _requireSSL;
-    keys: Keys;
-    projects: Projects;
-    transcription: Transcriber;
-    usage: Usage;
-    members: Members;
-    invitation: Invitation;
-    billing: Billing;
-    scopes: Scopes;
-    constructor(apiKey: string, apiUrl?: string, requireSSL?: boolean);
-}