@deepgram/sdk 2.4.0 → 3.0.0-alpha.2

package/src/lib/helpers.ts

@@ -0,0 +1,80 @@
+import { Headers as CrossFetchHeaders } from "cross-fetch";
+import {
+  BufferSource,
+  DeepgramClientOptions,
+  PrerecordedSource,
+  ReadStreamSource,
+  UrlSource,
+} from "./types";
+
+export function stripTrailingSlash(url: string): string {
+  return url.replace(/\/$/, "");
+}
+
+export const isBrowser = () => typeof window !== "undefined";
+
+export function applySettingDefaults(
+  options: DeepgramClientOptions,
+  defaults: DeepgramClientOptions
+): DeepgramClientOptions {
+  const { global: globalOptions } = options;
+
+  const { global: DEFAULT_GLOBAL_OPTIONS } = defaults;
+
+  return {
+    global: {
+      ...DEFAULT_GLOBAL_OPTIONS,
+      ...globalOptions,
+    },
+  };
+}
+
+export function appendSearchParams(
+  searchParams: URLSearchParams,
+  options: Record<string, unknown>
+): void {
+  Object.keys(options).forEach((i) => {
+    if (Array.isArray(options[i])) {
+      const arrayParams = options[i] as Array<any>;
+      arrayParams.forEach((param) => {
+        searchParams.append(i, String(param));
+      });
+    } else {
+      searchParams.append(i, String(options[i]));
+    }
+  });
+}
+
+export const resolveHeadersConstructor = () => {
+  if (typeof Headers === "undefined") {
+    return CrossFetchHeaders;
+  }
+
+  return Headers;
+};
+
+export const isUrlSource = (providedSource: PrerecordedSource): providedSource is UrlSource => {
+  if ((providedSource as UrlSource).url) return true;
+
+  return false;
+};
+
+export const isBufferSource = (
+  providedSource: PrerecordedSource
+): providedSource is BufferSource => {
+  if ((providedSource as BufferSource).buffer) return true;
+
+  return false;
+};
+
+export const isReadStreamSource = (
+  providedSource: PrerecordedSource
+): providedSource is ReadStreamSource => {
+  if ((providedSource as ReadStreamSource).stream) return true;
+
+  return false;
+};
+
+export class CallbackUrl extends URL {
+  private callbackUrl = true;
+}

package/src/lib/types/AsyncPrerecordedResponse.ts

@@ -0,0 +1,3 @@
+export interface AsyncPrerecordedResponse {
+  request_id: string;
+}

package/src/lib/types/CreateOnPremCredentialsOptions.ts

@@ -0,0 +1,5 @@
+export interface CreateOnPremCredentialsOptions extends Record<string, unknown> {
+  comment?: string;
+  scopes?: string[];
+  provider?: string;
+}

package/src/lib/types/CreateProjectKeyOptions.ts

@@ -0,0 +1,16 @@
+export type CreateProjectKeyOptions = ExpirationOptions | TtlOptions;
+
+interface ExpirationOptions extends CommonOptions {
+  expiration_date?: string;
+}
+
+export interface TtlOptions extends CommonOptions {
+  time_to_live_in_seconds?: number;
+}
+
+interface CommonOptions extends Record<string, unknown> {
+  comment: string;
+  scopes: string[];
+  tags?: string[];
+  [key: string]: unknown;
+}

package/src/lib/types/CreateProjectKeyResponse.ts

@@ -0,0 +1,8 @@
+export interface CreateProjectKeyResponse {
+  api_key_id: string;
+  key: string;
+  comment?: string;
+  scopes: string[];
+  tags?: string[];
+  created: string;
+}

package/src/lib/types/DeepgramClientOptions.ts

@@ -0,0 +1,13 @@
+export interface DeepgramClientOptions {
+  global: {
+    /**
+     * Optional headers for initializing the client.
+     */
+    headers?: Record<string, string>;
+
+    /**
+     * The URL used to interact with production, On-prem and other Deepgram environments. Defaults to `api.deepgram.com`.
+     */
+    url?: string;
+  };
+}

package/src/lib/types/DeepgramResponse.ts

@@ -0,0 +1,13 @@
+import { DeepgramError } from "../errors";
+
+export type DeepgramResponse<T> = SuccessResponse<T> | ErrorResponse;
+
+interface SuccessResponse<T> {
+  result: T;
+  error: null;
+}
+
+interface ErrorResponse {
+  result: null;
+  error: DeepgramError;
+}

package/src/lib/types/Fetch.ts

@@ -0,0 +1,17 @@
+export type Fetch = typeof fetch;
+
+export interface FetchOptions {
+  headers?: {
+    [key: string]: string;
+  };
+  noResolveJson?: boolean;
+}
+
+export type RequestMethodType = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+
+export interface FetchParameters {
+  /**
+   * Pass in an AbortController's signal to cancel the request.
+   */
+  signal?: AbortSignal;
+}

package/src/lib/types/GetProjectBalancesResponse.ts

@@ -0,0 +1,10 @@
+export interface GetProjectBalancesResponse {
+  balances: [GetProjectBalanceResponse];
+}
+
+export interface GetProjectBalanceResponse {
+  balance_id: string;
+  amount: number;
+  units: string;
+  purchase: string;
+}

package/src/lib/types/GetProjectInvitesResponse.ts

@@ -0,0 +1,8 @@
+export interface GetProjectInvitesResponse {
+  invites: [Invite];
+}
+
+interface Invite {
+  email: string;
+  scope: string;
+}

package/src/lib/types/GetProjectKeysResponse.ts

@@ -0,0 +1,23 @@
+export interface GetProjectKeysResponse {
+  api_keys: [GetProjectKeyResponse];
+}
+
+export interface GetProjectKeyResponse {
+  member: Member;
+  api_key: Key;
+}
+
+interface Member {
+  member_id: string;
+  email: string;
+  first_name: string;
+  last_name: string;
+}
+
+interface Key {
+  api_key_id: string;
+  comment?: string;
+  scopes: string[];
+  tags?: string[];
+  created: string;
+}

package/src/lib/types/GetProjectMemberScopesResponse.ts

@@ -0,0 +1,3 @@
+export interface GetProjectMemberScopesResponse {
+  scopes: string[];
+}

package/src/lib/types/GetProjectMembersResponse.ts

@@ -0,0 +1,11 @@
+export interface GetProjectMembersResponse {
+  members: [Member];
+}
+
+interface Member {
+  member_id: string;
+  first_name: string;
+  last_name: string;
+  scopes: string[];
+  email: string;
+}

package/src/lib/types/GetProjectResponse.ts

@@ -0,0 +1,5 @@
+export interface GetProjectResponse {
+  project_id: string;
+  name: string;
+  company: string;
+}

package/src/lib/types/GetProjectUsageFieldsOptions.ts

@@ -0,0 +1,4 @@
+export interface GetProjectUsageFieldsOptions extends Record<string, unknown> {
+  start?: string;
+  end: string;
+}

package/src/lib/types/GetProjectUsageFieldsResponse.ts

@@ -0,0 +1,14 @@
+export interface GetProjectUsageFieldsResponse {
+  tags: string[];
+  models: [UsageModel];
+  processing_methods: string[];
+  languages: string[];
+  features: string[];
+}
+
+interface UsageModel {
+  name: string;
+  language: string;
+  version: string;
+  model_id: string;
+}

package/src/lib/types/GetProjectUsageRequestsOptions.ts

@@ -0,0 +1,6 @@
+export interface GetProjectUsageRequestsOptions extends Record<string, unknown> {
+  start?: string;
+  end?: string;
+  limit?: number;
+  status?: string;
+}

package/src/lib/types/GetProjectUsageRequestsResponse.ts

@@ -0,0 +1,49 @@
+export interface GetProjectUsageRequestsResponse {
+  page: number;
+  limit: number;
+  requests: [GetProjectUsageRequestResponse];
+}
+
+export interface GetProjectUsageRequestResponse {
+  request_id: string;
+  created: string;
+  path: string;
+  api_key_id: string;
+  response: {
+    details: {
+      usd?: number;
+      duration?: number;
+      total_audio?: number;
+      channels?: number;
+      streams?: number;
+      models?: string[];
+      method?: string;
+      tags?: string[];
+      features?: string[];
+      config?: {
+        alternatives?: number;
+        callback?: string;
+        diarize?: boolean;
+        keywords?: string[];
+        language?: string;
+        model?: string;
+        multichannel?: boolean;
+        ner?: boolean;
+        numerals?: boolean;
+        profanity_filter?: boolean;
+        punctuate?: boolean;
+        redact?: string[];
+        search?: string[];
+        utterances?: boolean;
+        [key: string]: unknown;
+      };
+    };
+    code?: number;
+    completed?: string;
+  };
+  callback?: {
+    attempts?: number;
+    code?: number;
+    completed?: string;
+  };
+}

package/src/lib/types/GetProjectUsageSummaryOptions.ts

@@ -0,0 +1,23 @@
+export interface GetProjectUsageSummaryOptions extends Record<string, unknown> {
+  start?: string;
+  end: string;
+  accessor?: string;
+  tag?: string;
+  method?: string;
+  model?: string;
+  multichannel?: boolean;
+  interim_results?: boolean;
+  punctuate?: boolean;
+  ner?: boolean;
+  utterances?: boolean;
+  replace?: boolean;
+  profanity_filter?: boolean;
+  keywords?: boolean;
+  detect_topics?: boolean;
+  diarize?: boolean;
+  search?: boolean;
+  redact?: boolean;
+  alternatives?: boolean;
+  numerals?: boolean;
+  smart_format?: boolean;
+}

package/src/lib/types/GetProjectUsageSummaryResponse.ts

@@ -0,0 +1,17 @@
+export interface GetProjectUsageSummaryResponse {
+  start: string;
+  end: string;
+  resolution: {
+    units: string;
+    amount: number;
+  };
+  results: [UsageSummary];
+}
+
+interface UsageSummary {
+  start: string;
+  end: string;
+  hours: number;
+  total_hours: number;
+  requests: number;
+}

package/src/lib/types/GetProjectsResponse.ts

@@ -0,0 +1,8 @@
+export interface GetProjectsResponse {
+  projects: [Project];
+}
+
+interface Project {
+  project_id: string;
+  name: string;
+}

package/src/lib/types/ListOnPremCredentialsResponse.ts

@@ -0,0 +1,17 @@
+export interface ListOnPremCredentialsResponse {
+  distribution_credentials: [OnPremCredentialResponse];
+}
+
+export interface OnPremCredentialResponse {
+  member: {
+    member_id: string;
+    email: string;
+  };
+  distribution_credentials: {
+    distribution_credentials_id: string;
+    provider: string;
+    comment: string;
+    scopes: string[];
+    created: string;
+  };
+}

package/src/lib/types/LiveConfigOptions.ts

@@ -0,0 +1,3 @@
+export interface LiveConfigOptions {
+  numerals?: boolean;
+}

package/src/lib/types/LiveMetadataEvent.ts

@@ -0,0 +1,9 @@
+export interface LiveMetadataEvent {
+  type: "Metadata";
+  transaction_key: string;
+  request_id: string;
+  sha256: string;
+  created: string;
+  duration: number;
+  channels: number;
+}

package/src/lib/types/LiveTranscriptionEvent.ts

@@ -0,0 +1,34 @@
+export interface LiveTranscriptionEvent {
+  type: "Results";
+  channel_index: number[];
+  duration: number;
+  start: number;
+  is_final?: boolean;
+  speech_final?: boolean;
+  channel: {
+    alternatives: [
+      {
+        transcript: string;
+        confidence: boolean;
+        words: [
+          {
+            word: string;
+            start: number;
+            end: number;
+            confidence: number;
+            punctuated_word: string;
+          }
+        ];
+      }
+    ];
+  };
+  metadata: {
+    request_id: string;
+    model_info: {
+      name: string;
+      version: string;
+      arch: string;
+    };
+    model_uuid: string;
+  };
+}

package/src/lib/types/MessageResponse.ts

@@ -0,0 +1,3 @@
+export interface MessageResponse {
+  message: string;
+}

package/src/lib/types/PrerecordedSource.ts

@@ -0,0 +1,19 @@
+import { Readable } from "stream";
+
+export type PrerecordedSource = UrlSource | BufferSource | ReadStreamSource;
+
+export type FileSource = BufferSource | ReadStreamSource;
+
+export interface ReadStreamSource {
+  stream: Readable;
+  mimetype: string;
+}
+
+export interface UrlSource {
+  url: string;
+}
+
+export interface BufferSource {
+  buffer: Buffer;
+  mimetype: string;
+}

package/src/lib/types/SendProjectInviteOptions.ts

@@ -0,0 +1,4 @@
+export interface SendProjectInviteOptions extends Record<string, unknown> {
+  email: string;
+  scope: string;
+}

package/src/lib/types/SyncPrerecordedResponse.ts

@@ -0,0 +1,137 @@
+export interface SyncPrerecordedResponse {
+  metadata: Metadata;
+  results: Result;
+}
+
+interface Alternative {
+  transcript: string;
+  confidence: number;
+  words: Array<WordBase>;
+  summaries?: Array<Summary>;
+  paragraphs?: ParagraphGroup;
+  entities?: Array<Entity>;
+  translations?: Array<Translation>;
+  topics?: Array<TopicGroup>;
+}
+
+interface Channel {
+  search?: Array<Search>;
+  alternatives: Array<Alternative>;
+  detected_language?: string;
+}
+
+interface Entity {
+  label: string;
+  value: string;
+  confidence: number;
+  start_word: number;
+  end_word: number;
+}
+
+interface Hit {
+  confidence: number;
+  start: number;
+  end: number;
+  snippet: string;
+}
+
+interface Metadata {
+  transaction_key: string;
+  request_id: string;
+  sha256: string;
+  created: string;
+  duration: number;
+  channels: number;
+  models: Array<string>;
+  model_info: Record<string, ModelInfo>;
+  warnings?: Array<Warning>;
+}
+
+interface ModelInfo {
+  name: string;
+  version: string;
+  arch: string;
+}
+
+interface Paragraph {
+  sentences: Array<Sentence>;
+  start: number;
+  end: number;
+  num_words: number;
+}
+
+interface ParagraphGroup {
+  transcript: string;
+  paragraphs: Array<Paragraph>;
+}
+
+interface Result {
+  channels: Array<Channel>;
+  utterances?: Array<Utterance>;
+  summary?: TranscriptionSummary;
+}
+
+interface Search {
+  query: string;
+  hits: Array<Hit>;
+}
+
+interface Sentence {
+  text: string;
+  start: number;
+  end: number;
+}
+
+interface Summary {
+  summary?: string;
+  start_word?: number;
+  end_word?: number;
+}
+interface TranscriptionSummary {
+  result: string;
+  short: string;
+}
+
+interface Topic {
+  topic: string;
+  confidence: number;
+}
+
+interface TopicGroup {
+  topics: Array<Topic>;
+  text: string;
+  start_word: number;
+  end_word: number;
+}
+
+interface Translation {
+  language: string;
+  translation: string;
+}
+
+interface Utterance {
+  start: number;
+  end: number;
+  confidence: number;
+  channel: number;
+  transcript: string;
+  words: Array<WordBase>;
+  speaker?: number;
+  id: string;
+}
+
+interface Warning {
+  parameter: string;
+  type: string;
+  message: string;
+}
+
+interface WordBase {
+  word: string;
+  start: number;
+  end: number;
+  confidence: number;
+  punctuated_word?: string;
+  speaker?: number;
+  speaker_confidence?: number;
+}