assemblyai 4.3.1 → 4.3.3

package/dist/types/services/index.d.ts

@@ -2,5 +2,4 @@ type BaseServiceParams = {
     apiKey: string;
     baseUrl?: string;
 };
-export * from "./abstractions";
 export type { BaseServiceParams };

package/dist/types/transcripts/index.d.ts

@@ -1,21 +1,27 @@
 import { FileUploadParams } from "../files";
 import { TranscriptParams } from "../openapi.generated";
+/**
+ * Options for polling.
+ */
 export type PollingOptions = {
     /**
      * The amount of time to wait between polling requests.
-     * @default 3000 or every 3 seconds
+     * @defaultValue 3000 or every 3 seconds
      */
     pollingInterval?: number;
     /**
      * The maximum amount of time to wait for the transcript to be ready.
-     * @default -1 which means wait forever
+     * @defaultValue -1 which means wait forever
      */
     pollingTimeout?: number;
 };
+/**
+ * @deprecated Use `TranscriptService.transcribe` with `TranscribeOptions`.
+ */
 export type CreateTranscriptOptions = {
     /**
      * Whether to poll the transcript until it is ready.
-     * @default true
+     * @defaultValue true
      */
     poll?: boolean;
 } & PollingOptions;
@@ -26,9 +32,12 @@ export type AudioToTranscribe = FileUploadParams;
 /**
  * The parameters to transcribe an audio file.
  */
-export type TranscribeParams = {
+export type TranscribeParams = ({
+    /**
+     * The audio to transcribe. This can be a public URL, a local file path, a readable file stream, or a file buffer.
+     */
     audio: AudioToTranscribe;
-} & Omit<TranscriptParams, "audio_url">;
+} & Omit<TranscriptParams, "audio_url">) | TranscriptParams;
 /**
  * The parameters to start the transcription of an audio file.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.3.1",
+  "version": "4.3.3",
   "description": "The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "engines": {
     "node": ">=18"
@@ -67,8 +67,8 @@
   },
   "scripts": {
     "build": "pnpm clean && pnpm rollup -c",
-    "clean": "rimraf dist/*",
-    "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}' && publint",
+    "clean": "rimraf dist/* && rimraf temp/* && rimraf temp-docs/*",
+    "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}' && publint && tsc --noEmit -p tsconfig.json",
     "test": "jest --config jest.config.js",
     "format": "prettier '**/*' --write",
     "generate-types": "tsx ./scripts/generate-types.ts && pnpm format",
@@ -98,35 +98,36 @@
     "docs"
   ],
   "devDependencies": {
-    "@babel/preset-env": "^7.23.5",
+    "@babel/preset-env": "^7.24.0",
     "@babel/preset-typescript": "^7.23.3",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.5",
-    "@types/jest": "^29.5.5",
-    "@types/node": "^20.5.7",
-    "@types/websocket": "^1.0.8",
-    "@types/ws": "^8.5.5",
-    "@typescript-eslint/eslint-plugin": "^6.7.5",
-    "dotenv": "^16.3.1",
-    "eslint": "^8.48.0",
-    "jest": "^29.5.0",
-    "jest-cli": "^29.5.0",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^18.11.9",
+    "@types/websocket": "^1.0.10",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "jest": "^29.7.0",
+    "jest-cli": "^29.7.0",
     "jest-fetch-mock": "^3.0.3",
     "jest-junit": "^16.0.0",
-    "jest-websocket-mock": "^2.4.1",
-    "mock-socket": "^9.2.1",
-    "npm": "^9.7.1",
-    "openapi-typescript": "^6.6.1",
-    "prettier": "^2.8.8",
-    "publint": "^0.2.5",
-    "rimraf": "^5.0.1",
-    "rollup": "^3.25.1",
-    "ts-jest": "^29.1.0",
+    "jest-websocket-mock": "^2.5.0",
+    "mock-socket": "^9.3.1",
+    "openapi-typescript": "^6.7.5",
+    "prettier": "^3.2.5",
+    "publint": "^0.2.7",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.13.0",
+    "ts-jest": "^29.1.2",
     "tslib": "^2.5.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.2",
+    "typedoc": "^0.25.12"
   },
   "dependencies": {
-    "ws": "^8.13.0"
+    "ws": "^8.16.0"
   }
 }

package/src/polyfills/fs/index.ts

@@ -1,8 +1,8 @@
 export const readFile = async function (
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  path: string
+  path: string,
 ): Promise<ReadableStream<Uint8Array>> {
   throw new Error(
-    "Interacting with the file system is not supported in this environment."
+    "Interacting with the file system is not supported in this environment.",
   );
 };

package/src/polyfills/fs/node.ts

@@ -3,5 +3,5 @@ import { Readable } from "stream";
 
 export const readFile = async (path: string) =>
   Readable.toWeb(
-    createReadStream(path)
+    createReadStream(path),
   ) as unknown as ReadableStream<Uint8Array>;

package/src/polyfills/streams/index.ts

@@ -2,5 +2,5 @@ export const { WritableStream } =
   typeof window !== "undefined"
     ? window
     : typeof global !== "undefined"
-    ? global
-    : globalThis;
+      ? global
+      : globalThis;

package/src/services/base.ts

@@ -7,12 +7,12 @@ import { Error as JsonError } from "..";
 export abstract class BaseService {
   /**
    * Create a new service.
-   * @param params The parameters to use for the service.
+   * @param params - The parameters to use for the service.
    */
   constructor(private params: BaseServiceParams) {}
   protected async fetch(
     input: string,
-    init?: RequestInit | undefined
+    init?: RequestInit | undefined,
   ): Promise<Response> {
     init = init ?? {};
     init.headers = init.headers ?? {};
@@ -45,7 +45,7 @@ export abstract class BaseService {
 
   protected async fetchJson<T>(
     input: string,
-    init?: RequestInit | undefined
+    init?: RequestInit | undefined,
   ): Promise<T> {
     const response = await this.fetch(input, init);
     return response.json() as Promise<T>;

package/src/services/files/index.ts

@@ -5,8 +5,8 @@ import { UploadedFile, FileUploadParams, FileUploadData } from "../..";
 export class FileService extends BaseService {
   /**
    * Upload a local file to AssemblyAI.
-   * @param input The local file path to upload, or a stream or buffer of the file to upload.
-   * @return A promise that resolves to the uploaded file URL.
+   * @param input - The local file path to upload, or a stream or buffer of the file to upload.
+   * @returns A promise that resolves to the uploaded file URL.
    */
   async upload(input: FileUploadParams): Promise<string> {
     let fileData: FileUploadData;

package/src/services/index.ts

@@ -34,7 +34,7 @@ class AssemblyAI {
 
   /**
    * Create a new AssemblyAI client.
-   * @param params The parameters for the service, including the API key and base URL, if any.
+   * @param params - The parameters for the service, including the API key and base URL, if any.
    */
   constructor(params: BaseServiceParams) {
     params.baseUrl = params.baseUrl || defaultBaseUrl;

package/src/services/lemur/index.ts

@@ -20,26 +20,26 @@ export class LemurService extends BaseService {
   }
 
   questionAnswer(
-    params: LemurQuestionAnswerParams
+    params: LemurQuestionAnswerParams,
   ): Promise<LemurQuestionAnswerResponse> {
     return this.fetchJson<LemurQuestionAnswerResponse>(
       "/lemur/v3/generate/question-answer",
       {
         method: "POST",
         body: JSON.stringify(params),
-      }
+      },
     );
   }
 
   actionItems(
-    params: LemurActionItemsParams
+    params: LemurActionItemsParams,
   ): Promise<LemurActionItemsResponse> {
     return this.fetchJson<LemurActionItemsResponse>(
       "/lemur/v3/generate/action-items",
       {
         method: "POST",
         body: JSON.stringify(params),
-      }
+      },
     );
   }
 
@@ -52,7 +52,7 @@ export class LemurService extends BaseService {
 
   /**
    * Delete the data for a previously submitted LeMUR request.
-   * @param id ID of the LeMUR request
+   * @param id - ID of the LeMUR request
    */
   purgeRequestData(id: string): Promise<PurgeLemurRequestDataResponse> {
     return this.fetchJson<PurgeLemurRequestDataResponse>(`/lemur/v3/${id}`, {

package/src/services/realtime/factory.ts

@@ -38,7 +38,7 @@ export class RealtimeTranscriberFactory extends BaseService {
       {
         method: "POST",
         body: JSON.stringify(params),
-      }
+      },
     );
     return data.token;
   }

package/src/services/realtime/service.ts

@@ -58,8 +58,7 @@ export class RealtimeTranscriber {
     this.sampleRate = params.sampleRate ?? 16_000;
     this.wordBoost = params.wordBoost;
     this.encoding = params.encoding;
-    this.endUtteranceSilenceThreshold =
-      params.endUtteranceSilenceThreshold;
+    this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
     if ("token" in params && params.token) this.token = params.token;
     if ("apiKey" in params && params.apiKey) this.apiKey = params.apiKey;
 
@@ -94,15 +93,15 @@ export class RealtimeTranscriber {
   on(event: "open", listener: (event: SessionBeginsEventData) => void): void;
   on(
     event: "transcript",
-    listener: (transcript: RealtimeTranscript) => void
+    listener: (transcript: RealtimeTranscript) => void,
   ): void;
   on(
     event: "transcript.partial",
-    listener: (transcript: PartialTranscript) => void
+    listener: (transcript: PartialTranscript) => void,
   ): void;
   on(
     event: "transcript.final",
-    listener: (transcript: FinalTranscript) => void
+    listener: (transcript: FinalTranscript) => void,
   ): void;
   on(event: "error", listener: (error: Error) => void): void;
   on(event: "close", listener: (code: number, reason: string) => void): void;
@@ -136,7 +135,7 @@ export class RealtimeTranscriber {
           return;
         }
         this.configureEndUtteranceSilenceThreshold(
-          this.endUtteranceSilenceThreshold
+          this.endUtteranceSilenceThreshold,
         );
       };
 
@@ -214,8 +213,8 @@ export class RealtimeTranscriber {
 
   /**
    * Configure the threshold for how long to wait before ending an utterance. Default is 700ms.
-   * @param threshold The duration of the end utterance silence threshold in milliseconds
-   * @format integer
+   * @param threshold - The duration of the end utterance silence threshold in milliseconds.
+   * This value must be an integer between 0 and 20_000.
    */
   configureEndUtteranceSilenceThreshold(threshold: number) {
     this.send(`{"end_utterance_silence_threshold":${threshold}}`);

package/src/services/transcripts/index.ts

@@ -6,10 +6,6 @@ import {
   TranscriptList,
   TranscriptParams,
   CreateTranscriptOptions,
-  Createable,
-  Deletable,
-  Listable,
-  Retrieveable,
   SubtitleFormat,
   RedactedAudioResponse,
   ListTranscriptParams,
@@ -23,27 +19,23 @@ import {
 import { FileService } from "../files";
 import { getPath } from "../../utils/path";
 
-export class TranscriptService
-  extends BaseService
-  implements
-    Createable<Transcript, TranscriptParams, CreateTranscriptOptions>,
-    Retrieveable<Transcript>,
-    Deletable<Transcript>,
-    Listable<TranscriptList>
-{
-  constructor(params: BaseServiceParams, private files: FileService) {
+export class TranscriptService extends BaseService {
+  constructor(
+    params: BaseServiceParams,
+    private files: FileService,
+  ) {
     super(params);
   }
 
   /**
    * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
-   * @param params The parameters to transcribe an audio file.
-   * @param options The options to transcribe an audio file.
+   * @param params - The parameters to transcribe an audio file.
+   * @param options - The options to transcribe an audio file.
    * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
    */
   async transcribe(
     params: TranscribeParams,
-    options?: TranscribeOptions
+    options?: TranscribeOptions,
   ): Promise<Transcript> {
     const transcript = await this.submit(params);
     return await this.waitUntilReady(transcript.id, options);
@@ -51,43 +43,49 @@ export class TranscriptService
 
   /**
    * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
-   * @param params The parameters to start the transcription of an audio file.
+   * @param params - The parameters to start the transcription of an audio file.
    * @returns A promise that resolves to the queued transcript.
    */
   async submit(params: SubmitParams): Promise<Transcript> {
-    const { audio, ...createParams } = params;
     let audioUrl;
-    if (typeof audio === "string") {
-      const path = getPath(audio);
-      if (path !== null) {
-        // audio is local path, upload local file
-        audioUrl = await this.files.upload(path);
+    let transcriptParams: TranscriptParams | undefined = undefined;
+    if ("audio" in params) {
+      const { audio, ...audioTranscriptParams } = params;
+      if (typeof audio === "string") {
+        const path = getPath(audio);
+        if (path !== null) {
+          // audio is local path, upload local file
+          audioUrl = await this.files.upload(path);
+        } else {
+          // audio is not a local path, assume it's a URL
+          audioUrl = audio;
+        }
       } else {
-        // audio is not a local path, assume it's a URL
-        audioUrl = audio;
+        // audio is of uploadable type
+        audioUrl = await this.files.upload(audio);
       }
+      transcriptParams = { ...audioTranscriptParams, audio_url: audioUrl };
     } else {
-      // audio is of uploadable type
-      audioUrl = await this.files.upload(audio);
+      transcriptParams = params;
     }
 
     const data = await this.fetchJson<Transcript>("/v2/transcript", {
       method: "POST",
-      body: JSON.stringify({ ...createParams, audio_url: audioUrl }),
+      body: JSON.stringify(transcriptParams),
     });
     return data;
   }
 
   /**
    * Create a transcript.
-   * @param params The parameters to create a transcript.
-   * @param options The options used for creating the new transcript.
+   * @param params - The parameters to create a transcript.
+   * @param options - The options used for creating the new transcript.
    * @returns A promise that resolves to the transcript.
    * @deprecated Use `transcribe` instead to transcribe a audio file that includes polling, or `submit` to transcribe a audio file without polling.
    */
   async create(
     params: TranscriptParams,
-    options?: CreateTranscriptOptions
+    options?: CreateTranscriptOptions,
   ): Promise<Transcript> {
     const path = getPath(params.audio_url);
     if (path !== null) {
@@ -109,13 +107,13 @@ export class TranscriptService
 
   /**
    * Wait until the transcript ready, either the status is "completed" or "error".
-   * @param transcriptId The ID of the transcript.
-   * @param options The options to wait until the transcript is ready.
+   * @param transcriptId - The ID of the transcript.
+   * @param options - The options to wait until the transcript is ready.
    * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
    */
   async waitUntilReady(
     transcriptId: string,
-    options?: PollingOptions
+    options?: PollingOptions,
   ): Promise<Transcript> {
     const pollingInterval = options?.pollingInterval ?? 3_000;
     const pollingTimeout = options?.pollingTimeout ?? -1;
@@ -138,7 +136,7 @@ export class TranscriptService
 
   /**
    * Retrieve a transcript.
-   * @param id The identifier of the transcript.
+   * @param id - The identifier of the transcript.
    * @returns A promise that resolves to the transcript.
    */
   get(id: string): Promise<Transcript> {
@@ -147,20 +145,18 @@ export class TranscriptService
 
   /**
    * Retrieves a page of transcript listings.
-   * @param parameters The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
+   * @param params - The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
    */
-  async list(
-    parameters?: ListTranscriptParams | string
-  ): Promise<TranscriptList> {
+  async list(params?: ListTranscriptParams | string): Promise<TranscriptList> {
     let url = "/v2/transcript";
-    if (typeof parameters === "string") {
-      url = parameters;
-    } else if (parameters) {
+    if (typeof params === "string") {
+      url = params;
+    } else if (params) {
       url = `${url}?${new URLSearchParams(
-        Object.keys(parameters).map((key) => [
+        Object.keys(params).map((key) => [
           key,
-          parameters[key as keyof ListTranscriptParams]?.toString() || "",
-        ])
+          params[key as keyof ListTranscriptParams]?.toString() || "",
+        ]),
       )}`;
     }
     const data = await this.fetchJson<TranscriptList>(url);
@@ -176,7 +172,7 @@ export class TranscriptService
 
   /**
    * Delete a transcript
-   * @param id The identifier of the transcript.
+   * @param id - The identifier of the transcript.
    * @returns A promise that resolves to the transcript.
    */
   delete(id: string): Promise<Transcript> {
@@ -186,21 +182,21 @@ export class TranscriptService
   /**
    * Search through the transcript for a specific set of keywords.
    * You can search for individual words, numbers, or phrases containing up to five words or numbers.
-   * @param id The identifier of the transcript.
-   * @param words Keywords to search for.
-   * @return A promise that resolves to the sentences.
+   * @param id - The identifier of the transcript.
+   * @param words - Keywords to search for.
+   * @returns A promise that resolves to the sentences.
    */
   wordSearch(id: string, words: string[]): Promise<WordSearchResponse> {
     const params = new URLSearchParams({ words: words.join(",") });
     return this.fetchJson<WordSearchResponse>(
-      `/v2/transcript/${id}/word-search?${params.toString()}`
+      `/v2/transcript/${id}/word-search?${params.toString()}`,
     );
   }
 
   /**
    * Retrieve all sentences of a transcript.
-   * @param id The identifier of the transcript.
-   * @return A promise that resolves to the sentences.
+   * @param id - The identifier of the transcript.
+   * @returns A promise that resolves to the sentences.
    */
   sentences(id: string): Promise<SentencesResponse> {
     return this.fetchJson<SentencesResponse>(`/v2/transcript/${id}/sentences`);
@@ -208,26 +204,26 @@ export class TranscriptService
 
   /**
    * Retrieve all paragraphs of a transcript.
-   * @param id The identifier of the transcript.
-   * @return A promise that resolves to the paragraphs.
+   * @param id - The identifier of the transcript.
+   * @returns A promise that resolves to the paragraphs.
    */
   paragraphs(id: string): Promise<ParagraphsResponse> {
     return this.fetchJson<ParagraphsResponse>(
-      `/v2/transcript/${id}/paragraphs`
+      `/v2/transcript/${id}/paragraphs`,
     );
   }
 
   /**
    * Retrieve subtitles of a transcript.
-   * @param id The identifier of the transcript.
-   * @param format The format of the subtitles.
-   * @param chars_per_caption The maximum number of characters per caption.
-   * @return A promise that resolves to the subtitles text.
+   * @param id - The identifier of the transcript.
+   * @param format - The format of the subtitles.
+   * @param chars_per_caption - The maximum number of characters per caption.
+   * @returns A promise that resolves to the subtitles text.
    */
   async subtitles(
     id: string,
     format: SubtitleFormat = "srt",
-    chars_per_caption?: number
+    chars_per_caption?: number,
   ): Promise<string> {
     let url = `/v2/transcript/${id}/${format}`;
     if (chars_per_caption) {
@@ -241,12 +237,12 @@ export class TranscriptService
 
   /**
    * Retrieve redactions of a transcript.
-   * @param id The identifier of the transcript.
-   * @return A promise that resolves to the subtitles text.
+   * @param id - The identifier of the transcript.
+   * @returns A promise that resolves to the subtitles text.
    */
   redactions(id: string): Promise<RedactedAudioResponse> {
     return this.fetchJson<RedactedAudioResponse>(
-      `/v2/transcript/${id}/redacted-audio`
+      `/v2/transcript/${id}/redacted-audio`,
     );
   }
 }