assemblyai 3.0.0 → 3.1.0

package/README.md

@@ -8,7 +8,7 @@
 [![AssemblyAI Twitter](https://img.shields.io/twitter/follow/AssemblyAI?label=%40AssemblyAI&style=social)](https://twitter.com/AssemblyAI)
 [![AssemblyAI YouTube](https://img.shields.io/youtube/channel/subscribers/UCtatfZMf-8EkIwASXM4ts0A)](https://www.youtube.com/@AssemblyAI)
 [![Discord](https://img.shields.io/discord/875120158014853141?logo=discord&label=Discord&link=https%3A%2F%2Fdiscord.com%2Fchannels%2F875120158014853141&style=social)
-](https://discord.gg/5aQNZyq3)
+](https://assemblyai.com/discord)
 
 # AssemblyAI Node.js SDK
 
@@ -79,7 +79,7 @@ const transcript = await client.transcripts.create({
   poll: true,
   // How frequently the transcript is polled in ms. Defaults to 3000.
   pollingInterval: 1000,
-  // How long to wait in ms until the "Polling timeout" error is thrown. Defaults to 180000.
+  // How long to wait in ms until the "Polling timeout" error is thrown. Defaults to infinite (-1).
   pollingTimeout: 5000,
 })
 ```
@@ -92,9 +92,21 @@ This will return the transcript object in its current state. If the transcript i
 const transcript = await client.transcripts.get(transcript.id)
 ```
 
+If you disabled polling during transcript creation, you can still poll until the transcript `status` is `completed` or `error` using `waitUntilReady`:
+
+```javascript
+const transcript = await client.transcripts.waitUntilReady(transcript.id,
+{
+  // How frequently the transcript is polled in ms. Defaults to 3000.
+  pollingInterval: 1000,
+  // How long to wait in ms until the "Polling timeout" error is thrown. Defaults to infinite (-1).
+  pollingTimeout: 5000,
+})
+```
+
 ## List transcripts
 
-This will return a page of transcripts that you have transcript.
+This will return a page of transcripts you created.
 
 ```javascript
 const page = await client.transcripts.list()

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export type * from "./types";
+export * from "./types";
 export * from "./services";

package/dist/index.esm.js

@@ -1,24 +1,7 @@
-import axios, { isAxiosError } from 'axios';
 import WebSocket from 'ws';
-import { Writable } from 'stream';
+import Stream from 'stream';
 import fs from 'fs';
 
-function createAxiosClient(params) {
-    const client = axios.create({
-        baseURL: params.baseUrl,
-        headers: { Authorization: params.apiKey },
-    });
-    client.interceptors.response.use(undefined, throwApiError);
-    return client;
-}
-function throwApiError(error) {
-    var _a, _b;
-    if (isAxiosError(error) && ((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.error)) {
-        return Promise.reject(new Error(error.response.data.error));
-    }
-    return Promise.reject(error);
-}
-
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -57,36 +40,70 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 class BaseService {
     /**
      * Create a new service.
-     * @param params The AxiosInstance to send HTTP requests to the API.
+     * @param params The parameters to use for the service.
      */
-    constructor(client) {
-        this.client = client;
+    constructor(params) {
+        this.params = params;
+    }
+    fetch(input, init) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            init = init !== null && init !== void 0 ? init : {};
+            init.headers = (_a = init.headers) !== null && _a !== void 0 ? _a : {};
+            init.headers = Object.assign({ Authorization: this.params.apiKey, "Content-Type": "application/json" }, init.headers);
+            if (!input.startsWith("http"))
+                input = this.params.baseUrl + input;
+            const response = yield fetch(input, init);
+            if (response.status >= 400) {
+                let json;
+                const text = yield response.text();
+                if (text) {
+                    try {
+                        json = JSON.parse(text);
+                    }
+                    catch (_b) {
+                        /* empty */
+                    }
+                    if (json === null || json === void 0 ? void 0 : json.error)
+                        throw new Error(json.error);
+                    throw new Error(text);
+                }
+                throw new Error(`HTTP Error: ${response.status} ${response.statusText}`);
+            }
+            return response;
+        });
+    }
+    fetchJson(input, init) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.fetch(input, init);
+            return response.json();
+        });
     }
 }
 
 class LemurService extends BaseService {
     summary(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.post("/lemur/v3/generate/summary", params);
-            return data;
+        return this.fetchJson("/lemur/v3/generate/summary", {
+            method: "POST",
+            body: JSON.stringify(params),
         });
     }
     questionAnswer(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.post("/lemur/v3/generate/question-answer", params);
-            return data;
+        return this.fetchJson("/lemur/v3/generate/question-answer", {
+            method: "POST",
+            body: JSON.stringify(params),
         });
     }
     actionItems(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.post("/lemur/v3/generate/action-items", params);
-            return data;
+        return this.fetchJson("/lemur/v3/generate/action-items", {
+            method: "POST",
+            body: JSON.stringify(params),
         });
     }
     task(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.post("/lemur/v3/generate/task", params);
-            return data;
+        return this.fetchJson("/lemur/v3/generate/task", {
+            method: "POST",
+            body: JSON.stringify(params),
         });
     }
     /**
@@ -94,9 +111,8 @@ class LemurService extends BaseService {
      * @param id ID of the LeMUR request
      */
     purgeRequestData(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.delete(`/lemur/v3/${id}`);
-            return data;
+        return this.fetchJson(`/lemur/v3/${id}`, {
+            method: "DELETE",
         });
     }
 }
@@ -145,12 +161,11 @@ class RealtimeError extends Error {
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 class RealtimeService {
     constructor(params) {
-        var _a, _b, _c;
+        var _a, _b;
         this.listeners = {};
         this.realtimeUrl = (_a = params.realtimeUrl) !== null && _a !== void 0 ? _a : defaultRealtimeUrl;
         this.sampleRate = (_b = params.sampleRate) !== null && _b !== void 0 ? _b : 16000;
         this.wordBoost = params.wordBoost;
-        this.realtimeUrl = (_c = params.realtimeUrl) !== null && _c !== void 0 ? _c : defaultRealtimeUrl;
         if ("apiKey" in params)
             this.apiKey = params.apiKey;
         if ("token" in params)
@@ -258,7 +273,7 @@ class RealtimeService {
         this.socket.send(JSON.stringify(payload));
     }
     stream() {
-        const stream = new Writable({
+        const stream = new Stream.Writable({
             write: (chunk, encoding, next) => {
                 this.sendAudio(chunk);
                 next();
@@ -291,30 +306,33 @@ class RealtimeService {
     }
 }
 
-class RealtimeServiceFactory {
-    constructor(client, params) {
-        this.client = client;
-        this.params = params;
+class RealtimeServiceFactory extends BaseService {
+    constructor(params) {
+        super(params);
+        this.rtFactoryParams = params;
     }
     createService(params) {
         if (!params)
-            params = { apiKey: this.params.apiKey };
+            params = { apiKey: this.rtFactoryParams.apiKey };
         else if (!("token" in params) && !params.apiKey) {
-            params.apiKey = this.params.apiKey;
+            params.apiKey = this.rtFactoryParams.apiKey;
         }
         return new RealtimeService(params);
     }
     createTemporaryToken(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.client.post("/v2/realtime/token", params);
-            return response.data.token;
+            const data = yield this.fetchJson("/v2/realtime/token", {
+                method: "POST",
+                body: JSON.stringify(params),
+            });
+            return data.token;
         });
     }
 }
 
 class TranscriptService extends BaseService {
-    constructor(client, files) {
-        super(client);
+    constructor(params, files) {
+        super(params);
         this.files = files;
     }
     /**
@@ -331,16 +349,21 @@ class TranscriptService extends BaseService {
                 const uploadUrl = yield this.files.upload(path);
                 params.audio_url = uploadUrl;
             }
-            const res = yield this.client.post("/v2/transcript", params);
+            const data = yield this.fetchJson("/v2/transcript", {
+                method: "POST",
+                body: JSON.stringify(params),
+            });
             if ((_a = options === null || options === void 0 ? void 0 : options.poll) !== null && _a !== void 0 ? _a : true) {
-                return yield this.poll(res.data.id, options);
+                return yield this.waitUntilReady(data.id, options);
             }
-            return res.data;
+            return data;
         });
     }
-    poll(transcriptId, options) {
-        var _a;
+    waitUntilReady(transcriptId, options) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            const pollingInterval = (_a = options === null || options === void 0 ? void 0 : options.pollingInterval) !== null && _a !== void 0 ? _a : 3000;
+            const pollingTimeout = (_b = options === null || options === void 0 ? void 0 : options.pollingTimeout) !== null && _b !== void 0 ? _b : -1;
             const startTime = Date.now();
             // eslint-disable-next-line no-constant-condition
             while (true) {
@@ -348,12 +371,12 @@ class TranscriptService extends BaseService {
                 if (transcript.status === "completed" || transcript.status === "error") {
                     return transcript;
                 }
-                else if (Date.now() - startTime <
-                    ((_a = options === null || options === void 0 ? void 0 : options.pollingTimeout) !== null && _a !== void 0 ? _a : 180000)) {
-                    yield new Promise((resolve) => { var _a; return setTimeout(resolve, (_a = options === null || options === void 0 ? void 0 : options.pollingInterval) !== null && _a !== void 0 ? _a : 3000); });
+                else if (pollingTimeout > 0 &&
+                    Date.now() - startTime > pollingTimeout) {
+                    throw new Error("Polling timeout");
                 }
                 else {
-                    throw new Error("Polling timeout");
+                    yield new Promise((resolve) => setTimeout(resolve, pollingInterval));
                 }
             }
         });
@@ -364,10 +387,7 @@ class TranscriptService extends BaseService {
      * @returns A promise that resolves to the transcript.
      */
     get(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const res = yield this.client.get(`/v2/transcript/${id}`);
-            return res.data;
-        });
+        return this.fetchJson(`/v2/transcript/${id}`);
     }
     /**
      * Retrieves a page of transcript listings.
@@ -376,16 +396,19 @@ class TranscriptService extends BaseService {
     list(parameters) {
         return __awaiter(this, void 0, void 0, function* () {
             let url = "/v2/transcript";
-            let query;
             if (typeof parameters === "string") {
                 url = parameters;
             }
             else if (parameters) {
-                query = parameters;
+                url = `${url}?${new URLSearchParams(Object.keys(parameters).map((key) => {
+                    var _a;
+                    return [
+                        key,
+                        ((_a = parameters[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "",
+                    ];
+                }))}`;
             }
-            const { data } = yield this.client.get(url, {
-                params: query,
-            });
+            const data = yield this.fetchJson(url);
             for (const transcriptListItem of data.transcripts) {
                 transcriptListItem.created = new Date(transcriptListItem.created);
                 if (transcriptListItem.completed) {
@@ -401,27 +424,18 @@ class TranscriptService extends BaseService {
      * @returns A promise that resolves to the transcript.
      */
     delete(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const res = yield this.client.delete(`/v2/transcript/${id}`);
-            return res.data;
-        });
+        return this.fetchJson(`/v2/transcript/${id}`, { method: "DELETE" });
     }
     /**
      * 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 id Keywords to search for.
+     * @param words Keywords to search for.
      * @return A promise that resolves to the sentences.
      */
     wordSearch(id, words) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.get(`/v2/transcript/${id}/word-search`, {
-                params: {
-                    words: JSON.stringify(words),
-                },
-            });
-            return data;
-        });
+        const params = new URLSearchParams({ words: words.join(",") });
+        return this.fetchJson(`/v2/transcript/${id}/word-search?${params.toString()}`);
     }
     /**
      * Retrieve all sentences of a transcript.
@@ -429,10 +443,7 @@ class TranscriptService extends BaseService {
      * @return A promise that resolves to the sentences.
      */
     sentences(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.get(`/v2/transcript/${id}/sentences`);
-            return data;
-        });
+        return this.fetchJson(`/v2/transcript/${id}/sentences`);
     }
     /**
      * Retrieve all paragraphs of a transcript.
@@ -440,21 +451,25 @@ class TranscriptService extends BaseService {
      * @return A promise that resolves to the paragraphs.
      */
     paragraphs(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.get(`/v2/transcript/${id}/paragraphs`);
-            return data;
-        });
+        return this.fetchJson(`/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.
      */
-    subtitles(id, format = "srt") {
+    subtitles(id, format = "srt", chars_per_caption) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.get(`/v2/transcript/${id}/${format}`);
-            return data;
+            let url = `/v2/transcript/${id}/${format}`;
+            if (chars_per_caption) {
+                const params = new URLSearchParams();
+                params.set("chars_per_caption", chars_per_caption.toString());
+                url += `?${params.toString()}`;
+            }
+            const response = yield this.fetch(url);
+            return yield response.text();
         });
     }
     /**
@@ -463,10 +478,7 @@ class TranscriptService extends BaseService {
      * @return A promise that resolves to the subtitles text.
      */
     redactions(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.client.get(`/v2/transcript/${id}/redacted-audio`);
-            return data;
-        });
+        return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
     }
 }
 function getPath(path) {
@@ -496,28 +508,33 @@ class FileService extends BaseService {
                 fileData = fs.createReadStream(input);
             else
                 fileData = input;
-            const { data } = yield this.client.post("/v2/upload", fileData, {
+            const data = yield this.fetchJson("/v2/upload", {
+                method: "POST",
+                body: fileData,
                 headers: {
                     "Content-Type": "application/octet-stream",
                 },
+                duplex: "half",
             });
             return data.upload_url;
         });
     }
 }
 
+const defaultBaseUrl = "https://api.assemblyai.com";
 class AssemblyAI {
     /**
      * Create a new AssemblyAI client.
      * @param params The parameters for the service, including the API key and base URL, if any.
      */
     constructor(params) {
-        params.baseUrl = params.baseUrl || "https://api.assemblyai.com";
-        const client = createAxiosClient(params);
-        this.files = new FileService(client);
-        this.transcripts = new TranscriptService(client, this.files);
-        this.lemur = new LemurService(client);
-        this.realtime = new RealtimeServiceFactory(client, params);
+        params.baseUrl = params.baseUrl || defaultBaseUrl;
+        if (params.baseUrl && params.baseUrl.endsWith("/"))
+            params.baseUrl = params.baseUrl.slice(0, -1);
+        this.files = new FileService(params);
+        this.transcripts = new TranscriptService(params, this.files);
+        this.lemur = new LemurService(params);
+        this.realtime = new RealtimeServiceFactory(params);
     }
 }