assemblyai 1.0.1 → 2.0.1-beta

package/src/types/realtime/index.ts

@@ -0,0 +1,68 @@
+import {
+  FinalTranscript,
+  PartialTranscript,
+  RealtimeTranscript,
+  RealtimeTranscriptType,
+} from "../asyncapi.generated";
+
+type CreateRealtimeServiceParams = {
+  realtimeUrl?: string;
+  sampleRate?: number;
+  wordBoost?: string[];
+} & (
+  | {
+      apiKey?: string;
+    }
+  | {
+      token: string;
+    }
+);
+
+type RealtimeServiceParams = {
+  realtimeUrl?: string;
+  sampleRate?: number;
+  wordBoost?: string[];
+} & (
+  | {
+      apiKey: string;
+    }
+  | {
+      token: string;
+    }
+);
+
+type RealtimeEvents =
+  | "open"
+  | "close"
+  | "transcript"
+  | "transcript.partial"
+  | "transcript.final"
+  | "error";
+
+type SessionBeginsEventData = {
+  sessionId: string;
+  expiresAt: Date;
+};
+
+type RealtimeListeners = {
+  open?: (event: SessionBeginsEventData) => void;
+  close?: (code: number, reason: string) => void;
+  transcript?: (transcript: RealtimeTranscript) => void;
+  "transcript.partial"?: (transcript: PartialTranscript) => void;
+  "transcript.final"?: (transcript: FinalTranscript) => void;
+  error?: (error: Error) => void;
+};
+
+type RealtimeTokenParams = {
+  expires_in: number;
+};
+
+export type {
+  CreateRealtimeServiceParams,
+  RealtimeServiceParams,
+  RealtimeEvents,
+  RealtimeTranscriptType,
+  SessionBeginsEventData,
+  RealtimeListeners,
+  RealtimeTokenParams,
+};

package/src/types/services/abstractions.ts

@@ -0,0 +1,56 @@
+/**
+ * Interface for classes that can create resources.
+ * @template T The type of the resource.
+ * @template Parameters The type of the parameters required to create the resource.
+ */
+interface Createable<T, Parameters, Options = Record<string, any>> {
+  /**
+   * Create a new resource.
+   * @param params The parameters of the new resource.
+   * @param options The options used for creating the new resource.
+   * @return A promise that resolves to the newly created resource.
+   */
+  create(params: Parameters, options?: Options): Promise<T>;
+}
+
+/**
+ * Interface for classes that can retrieve resources.
+ * @template T The type of the resource.
+ * @template Id The type of the resource's identifier. Defaults to string.
+ */
+interface Retrieveable<T, Id = string> {
+  /**
+   * Get a resource.
+   * @param id The identifier of the resource to retrieve.
+   * @return A promise that resolves to the retrieved resource.
+   */
+  get(id: Id): Promise<T>;
+}
+
+/**
+ * Interface for classes that can delete resources.
+ * @template T The type of the resource.
+ * @template Id The type of the resource's identifier. Defaults to string.
+ */
+interface Deletable<T, Id = string> {
+  /**
+   * Delete a resource.
+   * @param id The identifier of the resource to delete.
+   * @return A promise that resolves to a boolean indicating whether the deletion was successful.
+   */
+  delete(id: Id): Promise<T>;
+}
+
+/**
+ * Interface for classes that can list resources.
+ * @template T The type of the resource.
+ */
+interface Listable<T, Page = string> {
+  /**
+   * List all resources.
+   * @return A promise that resolves to an array of resources.
+   */
+  list(page?: Page): Promise<T>;
+}
+
+export type { Createable, Retrieveable, Deletable, Listable };

package/src/types/services/index.ts

@@ -0,0 +1,7 @@
+type BaseServiceParams = {
+  apiKey: string;
+  baseUrl?: string;
+};
+
+export type * from "./abstractions";
+export type { BaseServiceParams };

package/src/types/transcripts/index.ts

@@ -0,0 +1,5 @@
+export type CreateTranscriptOptions = {
+  poll?: boolean;
+  pollingInterval?: number;
+  pollingTimeout?: number;
+};

package/src/utils/axios.ts

@@ -0,0 +1,19 @@
+import axios, { isAxiosError } from "axios";
+import { BaseServiceParams } from "../.";
+
+export function createAxiosClient(params: BaseServiceParams) {
+  const client = axios.create({
+    baseURL: params.baseUrl,
+    headers: { Authorization: params.apiKey },
+  });
+
+  client.interceptors.response.use(undefined, throwApiError);
+  return client;
+}
+
+export function throwApiError(error: unknown) {
+  if (isAxiosError(error) && error.response?.data?.error) {
+    return Promise.reject(new Error(error.response.data.error));
+  }
+  return Promise.reject(error);
+}

package/src/utils/errors/index.ts

@@ -0,0 +1,5 @@
+export {
+  default as RealtimeError,
+  RealtimeErrorType,
+  RealtimeErrorMessages,
+} from "./realtime";

package/src/utils/errors/realtime.ts

@@ -0,0 +1,45 @@
+enum RealtimeErrorType {
+  BadSampleRate = 4000,
+  AuthFailed = 4001,
+  // Both InsufficientFunds and FreeAccount error use 4002
+  InsufficientFundsOrFreeAccount = 4002,
+  NonexistentSessionId = 4004,
+  SessionExpired = 4008,
+  ClosedSession = 4010,
+  RateLimited = 4029,
+  UniqueSessionViolation = 4030,
+  SessionTimeout = 4031,
+  AudioTooShort = 4032,
+  AudioTooLong = 4033,
+  BadJson = 4100,
+  BadSchema = 4101,
+  TooManyStreams = 4102,
+  Reconnected = 4103,
+  ReconnectAttemptsExhausted = 1013,
+}
+
+const RealtimeErrorMessages: Record<RealtimeErrorType, string> = {
+  [RealtimeErrorType.BadSampleRate]: "Sample rate must be a positive integer",
+  [RealtimeErrorType.AuthFailed]: "Not Authorized",
+  [RealtimeErrorType.InsufficientFundsOrFreeAccount]:
+    "Insufficient funds or you are using a free account. This feature is paid-only and requires you to add a credit card. Please visit https://assemblyai.com/dashboard/ to add a credit card to your account.",
+  [RealtimeErrorType.NonexistentSessionId]: "Session ID does not exist",
+  [RealtimeErrorType.SessionExpired]: "Session has expired",
+  [RealtimeErrorType.ClosedSession]: "Session is closed",
+  [RealtimeErrorType.RateLimited]: "Rate limited",
+  [RealtimeErrorType.UniqueSessionViolation]: "Unique session violation",
+  [RealtimeErrorType.SessionTimeout]: "Session Timeout",
+  [RealtimeErrorType.AudioTooShort]: "Audio too short",
+  [RealtimeErrorType.AudioTooLong]: "Audio too long",
+  [RealtimeErrorType.BadJson]: "Bad JSON",
+  [RealtimeErrorType.BadSchema]: "Bad schema",
+  [RealtimeErrorType.TooManyStreams]: "Too many streams",
+  [RealtimeErrorType.Reconnected]: "Reconnected",
+  [RealtimeErrorType.ReconnectAttemptsExhausted]:
+    "Reconnect attempts exhausted",
+};
+
+class RealtimeError extends Error {}
+
+export { RealtimeErrorType, RealtimeErrorMessages };
+export default RealtimeError;

package/.eslintrc.json

@@ -1,3 +0,0 @@
-{
-    "extends": "standard"
-}

package/index.js

@@ -1,15 +0,0 @@
-const Transcript = require('./src/api/Transcript')
-const Model = require('./src/api/Model')
-const Upload = require('./src/api/Upload')
-const Client = require('./src/Client')
-
-module.exports = {
-  Transcript,
-  Model,
-  Upload,
-  setAPIKey (key) {
-    Client.API_KEY = key
-  }
-}
-
-

package/src/Client.js

@@ -1,28 +0,0 @@
-let _apiKey = ''
-
-class Client {
-  static set API_KEY (key) {
-    _apiKey = key
-  }
-
-  static get API_KEY () {
-    return _apiKey
-  }
-
-  static checkKey () {
-    if (process.env.ASSEMBLYAI_API_KEY) {
-      _apiKey = process.env.ASSEMBLYAI_API_KEY
-    }
-    if (!_apiKey) {
-      throw new Error(`
-        Unable to find the API Key.
-        You can set this value by using the setAPIKey method.
-        Example: """ const assemblyai = require('assemblyai')
-                     assemblyai.setAPIKey('example') """
-      `)
-    }
-    return true
-  }
-}
-
-module.exports = Client

package/src/api/Http/Request.js

@@ -1,108 +0,0 @@
-const request = require('request')
-const Client = require('../../Client')
-
-class Request {
-  /**
-   * Initializes the class
-   * @param {Object} options The HTTP Options
-   * @param {String} options.method The HTTP Method
-   * @param {String} options.url THE HTTP URL
-   * @param {Object} options.body optional HTTP Body
-   */
-  constructor (options) {
-    this.method = options.method || 'GET'
-    this.url = options.url || ''
-    this.body = options.body || ''
-  }
-
-  /**
-   * Sends an HTTP request using the node HTTP module
-   *
-   * @returns {Promise<Object>} Parsed JSON of the response
-   */
-  _request (isJSON) {
-    const options = {
-      uri: this.url,
-      method: this.method,
-      headers: {
-        authorization: Client.API_KEY
-      }
-    }
-
-    if (this.method === 'POST' || this.method === 'PUT') {
-      if (this.body && this.body.constructor !== String) {
-        options.body = JSON.stringify(this.body)
-      } else {
-        options.body = ''
-      }
-    }
-
-    return new Promise((resolve, reject) => {
-      request(options, (err, response, body) => {
-        if (err) return reject(err)
-        try {
-          if (isJSON) {
-            resolve(JSON.parse(body))
-          } else {
-            resolve(body)
-          }
-        } catch (e) {
-          console.log('HERE:', e)
-          reject(new Error(`
-            Unable to recieve a proper JSON response from the API.
-            Please contact customer service.
-          `))
-        }
-      })
-    })
-  }
-
-  /**
-   * Sends a request to the API
-   *
-   * @throws {Error} the error receieved from the API
-   */
-  async send (isJSON = true) {
-    Client.checkKey()
-    let response = null
-    let retries = 1
-    while (!response) {
-      if (retries === 5) {
-        throw new Error(`
-          Retry limit reached. Some things that could cause this to happen
-          would be your network connection or slow internet (request timeout).
-          Please look into this before continuing to use this SDK
-        `)
-      }
-
-      response = await new Promise(resolve => {
-        setTimeout(async () => {
-          try {
-            const res = await this._request(isJSON)
-            resolve(res)
-          } catch (e) {
-            retries += 1
-            /**
-             * The reason for resolving the null value would be so response is still *falsey*
-             * allowing the loop to run again. If no value is resolved here, the loop will hang
-             * until the value is resolved (which would be never)
-             */
-            resolve(null)
-          }
-        }, (retries * retries) * 100) // TODO: exponential timeout. Change this value to whatever you want
-      })
-    }
-    return response
-  }
-}
-
-module.exports = Request
-
-// curl --request POST \
-//     --url https://api.assemblyai.com/transcript \
-//     --header 'authorization: 6f33815060fa4eb29e96356a3ec536c8' \
-//     --data '
-//     {
-//       "audio_src_url": "https://s3-us-west-2.amazonaws.com/blog.assemblyai.com/audio/8-7-2018-post/7510.mp3",
-//       "model_id": 265
-//     }'

package/src/api/Http/Response.js

@@ -1,23 +0,0 @@
-class Response {
-  constructor (responseJSON) {
-    this.json = responseJSON
-    if (responseJSON.error) {
-      throw new Error(responseJSON.error)
-    }
-    this.type = responseJSON.transcript ? 'transcript' : 'model'
-  }
-
-  toString () {
-    return JSON.stringify(this.json[this.type])
-  }
-
-  stringify () {
-    return this.toString()
-  }
-
-  get () {
-    return this.json[this.type]
-  }
-}
-
-module.exports = Response

package/src/api/Model.js

@@ -1,17 +0,0 @@
-const { Poll, Create } = require('./util')
-
-class Model {
-  constructor () {
-    this.url = 'https://api.assemblyai.com/model'
-  }
-
-  poll (id) {
-    return Poll(this.url, id)
-  }
-
-  create (options) {
-    return Create(this.url, options)
-  }
-}
-
-module.exports = Model

package/src/api/Transcript.js

@@ -1,16 +0,0 @@
-const { Poll, Create } = require('./util')
-class Transcript {
-  constructor () {
-    this.url = 'https://api.assemblyai.com/transcript'
-  }
-
-  poll (id) {
-    return Poll(this.url, id)
-  }
-
-  create (options) {
-    return Create(this.url, options)
-  }
-}
-
-module.exports = Transcript

package/src/api/Upload.js

@@ -1,41 +0,0 @@
-const fs = require('fs')
-const Request = require('./Http/Request')
-const request = require('request')
-
-const Transcribe = require('./Transcript')
-
-class Upload {
-  constructor (filePath) {
-    this.url = 'https://api.assemblyai.com/upload'
-    this.filePath = filePath
-  }
-
-  async create () {
-    const req = new Request({
-      method: 'POST',
-      url: this.url
-    })
-    const uploadUrl = await req.send(false)
-
-    await new Promise((resolve, reject) => {
-      fs.readFile(this.filePath, (err, data) => {
-        if (err) return reject(err)
-        request.put(uploadUrl, { body: data }, (err, response, body) => {
-          if (err) return reject(err)
-          resolve(body)
-        })
-      })
-    })
-
-    const url = uploadUrl.split('?')[0]
-    const transcribe = new Transcribe()
-    const response = await transcribe.create({
-      audio_src_url: url
-    })
-    const { id } = response.get()
-
-    return transcribe.poll(id)
-  }
-}
-
-module.exports = Upload

package/src/api/util.js

@@ -1,48 +0,0 @@
-const Request = require('./Http/Request')
-const Response = require('./Http/Response')
-
-module.exports = {
-  Poll (url, id) {
-    return new Promise((resolve, reject) => {
-      const request = new Request({
-        method: 'GET',
-        url: `${url}/${id}`
-      })
-
-      const interval = setInterval(async () => {
-        try {
-          const apiResponse = await request.send()
-          const response = new Response(apiResponse)
-          const json = response.get()
-          if (json.status === 'completed') {
-            clearInterval(interval)
-            resolve(response)
-          }
-          if (json.status === 'trained') {
-            clearInterval(interval)
-            resolve(response)
-          }
-          if (json.status === 'error') {
-            clearInterval(interval)
-            reject(json.error)
-          }
-        } catch (e) {
-          clearInterval(interval)
-          reject(e)
-        }
-      }, 3000)
-    })
-  },
-  async Create (url, options) {
-    const request = new Request({
-      method: 'POST',
-      url: url,
-      body: options.upload ? '' : options || {}
-    })
-    const apiResponse = await request.send()
-    if (options.json === false) {
-      return apiResponse
-    }
-    return new Response(apiResponse)
-  }
-}