assemblyai 4.5.0-beta.0 → 4.6.0

package/dist/index.cjs

@@ -46,6 +46,45 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 };
 
+const DEFAULT_FETCH_INIT = {
+    cache: "no-store",
+};
+
+const buildUserAgent = (userAgent) => defaultUserAgentString +
+    (userAgent === false
+        ? ""
+        : " AssemblyAI/1.0 (" +
+            Object.entries(Object.assign(Object.assign({}, defaultUserAgent), userAgent))
+                .map(([key, item]) => item ? `${key}=${item.name}/${item.version}` : "")
+                .join(" ") +
+            ")");
+let defaultUserAgentString = "";
+if (typeof navigator !== "undefined" && navigator.userAgent) {
+    defaultUserAgentString += navigator.userAgent;
+}
+const defaultUserAgent = {
+    sdk: { name: "JavaScript", version: "4.6.0" },
+};
+if (typeof process !== "undefined") {
+    if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
+        defaultUserAgent.runtime_env = {
+            name: "Node",
+            version: process.versions.node,
+        };
+    }
+    if (process.versions.bun && defaultUserAgentString.indexOf("Bun") === -1) {
+        defaultUserAgent.runtime_env = {
+            name: "Bun",
+            version: process.versions.bun,
+        };
+    }
+}
+if (typeof Deno !== "undefined") {
+    if (process.versions.bun && defaultUserAgentString.indexOf("Deno") === -1) {
+        defaultUserAgent.runtime_env = { name: "Deno", version: Deno.version.deno };
+    }
+}
+
 /**
  * Base class for services that communicate with the API.
  */
@@ -56,13 +95,33 @@ class BaseService {
      */
     constructor(params) {
         this.params = params;
+        if (params.userAgent === false) {
+            this.userAgent = undefined;
+        }
+        else {
+            this.userAgent = buildUserAgent(params.userAgent || {});
+        }
     }
     fetch(input, init) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            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);
+            init = Object.assign(Object.assign({}, DEFAULT_FETCH_INIT), init);
+            let headers = {
+                Authorization: this.params.apiKey,
+                "Content-Type": "application/json",
+            };
+            if (DEFAULT_FETCH_INIT === null || DEFAULT_FETCH_INIT === void 0 ? void 0 : DEFAULT_FETCH_INIT.headers)
+                headers = Object.assign(Object.assign({}, headers), DEFAULT_FETCH_INIT.headers);
+            if (init === null || init === void 0 ? void 0 : init.headers)
+                headers = Object.assign(Object.assign({}, headers), init.headers);
+            if (this.userAgent) {
+                headers["User-Agent"] = this.userAgent;
+                // chromium browsers have a bug where the user agent can't be modified
+                if (typeof window !== "undefined" && "chrome" in window) {
+                    headers["AssemblyAI-Agent"] =
+                        this.userAgent;
+                }
+            }
+            init.headers = headers;
             if (!input.startsWith("http"))
                 input = this.params.baseUrl + input;
             const response = yield fetch(input, init);
@@ -73,7 +132,7 @@ class BaseService {
                     try {
                         json = JSON.parse(text);
                     }
-                    catch (_b) {
+                    catch (_a) {
                         /* empty */
                     }
                     if (json === null || json === void 0 ? void 0 : json.error)
@@ -118,6 +177,9 @@ class LemurService extends BaseService {
             body: JSON.stringify(params),
         });
     }
+    getResponse(id) {
+        return this.fetchJson(`/lemur/v3/${id}`);
+    }
     /**
      * Delete the data for a previously submitted LeMUR request.
      * @param id - ID of the LeMUR request
@@ -181,7 +243,14 @@ class RealtimeError extends Error {
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 const forceEndOfUtteranceMessage = `{"force_end_utterance":true}`;
 const terminateSessionMessage = `{"terminate_session":true}`;
+/**
+ * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
+ */
 class RealtimeTranscriber {
+    /**
+     * Create a new RealtimeTranscriber.
+     * @param params - Parameters to configure the RealtimeTranscriber
+     */
     constructor(params) {
         var _a, _b;
         this.listeners = {};
@@ -222,10 +291,19 @@ class RealtimeTranscriber {
         url.search = searchParams.toString();
         return url;
     }
+    /**
+     * Add a listener for an event.
+     * @param event - The event to listen for.
+     * @param listener - The function to call when the event is emitted.
+     */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event, listener) {
         this.listeners[event] = listener;
     }
+    /**
+     * Connect to the server and begin a new session.
+     * @returns A promise that resolves when the connection is established and the session begins.
+     */
     connect() {
         return new Promise((resolve) => {
             if (this.socket) {
@@ -307,9 +385,17 @@ class RealtimeTranscriber {
             };
         });
     }
+    /**
+     * Send audio data to the server.
+     * @param audio - The audio data to send to the server.
+     */
     sendAudio(audio) {
         this.send(audio);
     }
+    /**
+     * Create a writable stream that can be used to send audio data to the server.
+     * @returns A writable stream that can be used to send audio data to the server.
+     */
     stream() {
         return new WritableStream({
             write: (chunk) => {
@@ -337,6 +423,11 @@ class RealtimeTranscriber {
         }
         this.socket.send(data);
     }
+    /**
+     * Close the connection to the server.
+     * @param waitForSessionTermination - If true, the method will wait for the session to be terminated before closing the connection.
+     * While waiting for the session to be terminated, you will receive the final transcript and session information.
+     */
     close() {
         return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
             var _a;
@@ -407,6 +498,8 @@ function getPath(path) {
         return null;
     if (path.startsWith("https"))
         return null;
+    if (path.startsWith("data:"))
+        return null;
     if (path.startsWith("file://"))
         return path.substring(7);
     if (path.startsWith("file:"))
@@ -451,8 +544,13 @@ class TranscriptService extends BaseService {
                         audioUrl = yield this.files.upload(path);
                     }
                     else {
-                        // audio is not a local path, assume it's a URL
-                        audioUrl = audio;
+                        if (audio.startsWith("data:")) {
+                            audioUrl = yield this.files.upload(audio);
+                        }
+                        else {
+                            // audio is not a local path, and not a data-URI, assume it's a normal URL
+                            audioUrl = audio;
+                        }
                     }
                 }
                 else {
@@ -617,13 +715,45 @@ class TranscriptService extends BaseService {
         });
     }
     /**
-     * Retrieve redactions of a transcript.
+     * Retrieve the redacted audio URL of a transcript.
      * @param id - The identifier of the transcript.
-     * @returns A promise that resolves to the subtitles text.
+     * @returns A promise that resolves to the details of the redacted audio.
+     * @deprecated Use `redactedAudio` instead.
      */
     redactions(id) {
+        return this.redactedAudio(id);
+    }
+    /**
+     * Retrieve the redacted audio URL of a transcript.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the details of the redacted audio.
+     */
+    redactedAudio(id) {
         return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
     }
+    /**
+     * Retrieve the redacted audio file of a transcript.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the fetch HTTP response of the redacted audio file.
+     */
+    redactedAudioFile(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { redacted_audio_url, status } = yield this.redactedAudio(id);
+            if (status !== "redacted_audio_ready") {
+                throw new Error(`Redacted audio status is ${status}`);
+            }
+            const response = yield fetch(redacted_audio_url);
+            if (!response.ok) {
+                throw new Error(`Failed to fetch redacted audio: ${response.statusText}`);
+            }
+            return {
+                arrayBuffer: response.arrayBuffer.bind(response),
+                blob: response.blob.bind(response),
+                body: response.body,
+                bodyUsed: response.bodyUsed,
+            };
+        });
+    }
 }
 function deprecateConformer2(params) {
     if (!params)
@@ -650,8 +780,14 @@ class FileService extends BaseService {
     upload(input) {
         return __awaiter(this, void 0, void 0, function* () {
             let fileData;
-            if (typeof input === "string")
-                fileData = yield readFile();
+            if (typeof input === "string") {
+                if (input.startsWith("data:")) {
+                    fileData = dataUrlToBlob(input);
+                }
+                else {
+                    fileData = yield readFile();
+                }
+            }
             else
                 fileData = input;
             const data = yield this.fetchJson("/v2/upload", {
@@ -666,6 +802,17 @@ class FileService extends BaseService {
         });
     }
 }
+function dataUrlToBlob(dataUrl) {
+    const arr = dataUrl.split(",");
+    const mime = arr[0].match(/:(.*?);/)[1];
+    const bstr = atob(arr[1]);
+    let n = bstr.length;
+    const u8arr = new Uint8Array(n);
+    while (n--) {
+        u8arr[n] = bstr.charCodeAt(n);
+    }
+    return new Blob([u8arr], { type: mime });
+}
 
 const defaultBaseUrl = "https://api.assemblyai.com";
 class AssemblyAI {
@@ -675,8 +822,9 @@ class AssemblyAI {
      */
     constructor(params) {
         params.baseUrl = params.baseUrl || defaultBaseUrl;
-        if (params.baseUrl && params.baseUrl.endsWith("/"))
+        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);

package/dist/index.mjs

@@ -44,6 +44,45 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 };
 
+const DEFAULT_FETCH_INIT = {
+    cache: "no-store",
+};
+
+const buildUserAgent = (userAgent) => defaultUserAgentString +
+    (userAgent === false
+        ? ""
+        : " AssemblyAI/1.0 (" +
+            Object.entries(Object.assign(Object.assign({}, defaultUserAgent), userAgent))
+                .map(([key, item]) => item ? `${key}=${item.name}/${item.version}` : "")
+                .join(" ") +
+            ")");
+let defaultUserAgentString = "";
+if (typeof navigator !== "undefined" && navigator.userAgent) {
+    defaultUserAgentString += navigator.userAgent;
+}
+const defaultUserAgent = {
+    sdk: { name: "JavaScript", version: "4.6.0" },
+};
+if (typeof process !== "undefined") {
+    if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
+        defaultUserAgent.runtime_env = {
+            name: "Node",
+            version: process.versions.node,
+        };
+    }
+    if (process.versions.bun && defaultUserAgentString.indexOf("Bun") === -1) {
+        defaultUserAgent.runtime_env = {
+            name: "Bun",
+            version: process.versions.bun,
+        };
+    }
+}
+if (typeof Deno !== "undefined") {
+    if (process.versions.bun && defaultUserAgentString.indexOf("Deno") === -1) {
+        defaultUserAgent.runtime_env = { name: "Deno", version: Deno.version.deno };
+    }
+}
+
 /**
  * Base class for services that communicate with the API.
  */
@@ -54,13 +93,33 @@ class BaseService {
      */
     constructor(params) {
         this.params = params;
+        if (params.userAgent === false) {
+            this.userAgent = undefined;
+        }
+        else {
+            this.userAgent = buildUserAgent(params.userAgent || {});
+        }
     }
     fetch(input, init) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            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);
+            init = Object.assign(Object.assign({}, DEFAULT_FETCH_INIT), init);
+            let headers = {
+                Authorization: this.params.apiKey,
+                "Content-Type": "application/json",
+            };
+            if (DEFAULT_FETCH_INIT === null || DEFAULT_FETCH_INIT === void 0 ? void 0 : DEFAULT_FETCH_INIT.headers)
+                headers = Object.assign(Object.assign({}, headers), DEFAULT_FETCH_INIT.headers);
+            if (init === null || init === void 0 ? void 0 : init.headers)
+                headers = Object.assign(Object.assign({}, headers), init.headers);
+            if (this.userAgent) {
+                headers["User-Agent"] = this.userAgent;
+                // chromium browsers have a bug where the user agent can't be modified
+                if (typeof window !== "undefined" && "chrome" in window) {
+                    headers["AssemblyAI-Agent"] =
+                        this.userAgent;
+                }
+            }
+            init.headers = headers;
             if (!input.startsWith("http"))
                 input = this.params.baseUrl + input;
             const response = yield fetch(input, init);
@@ -71,7 +130,7 @@ class BaseService {
                     try {
                         json = JSON.parse(text);
                     }
-                    catch (_b) {
+                    catch (_a) {
                         /* empty */
                     }
                     if (json === null || json === void 0 ? void 0 : json.error)
@@ -116,6 +175,9 @@ class LemurService extends BaseService {
             body: JSON.stringify(params),
         });
     }
+    getResponse(id) {
+        return this.fetchJson(`/lemur/v3/${id}`);
+    }
     /**
      * Delete the data for a previously submitted LeMUR request.
      * @param id - ID of the LeMUR request
@@ -179,7 +241,14 @@ class RealtimeError extends Error {
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 const forceEndOfUtteranceMessage = `{"force_end_utterance":true}`;
 const terminateSessionMessage = `{"terminate_session":true}`;
+/**
+ * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
+ */
 class RealtimeTranscriber {
+    /**
+     * Create a new RealtimeTranscriber.
+     * @param params - Parameters to configure the RealtimeTranscriber
+     */
     constructor(params) {
         var _a, _b;
         this.listeners = {};
@@ -220,10 +289,19 @@ class RealtimeTranscriber {
         url.search = searchParams.toString();
         return url;
     }
+    /**
+     * Add a listener for an event.
+     * @param event - The event to listen for.
+     * @param listener - The function to call when the event is emitted.
+     */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event, listener) {
         this.listeners[event] = listener;
     }
+    /**
+     * Connect to the server and begin a new session.
+     * @returns A promise that resolves when the connection is established and the session begins.
+     */
     connect() {
         return new Promise((resolve) => {
             if (this.socket) {
@@ -305,9 +383,17 @@ class RealtimeTranscriber {
             };
         });
     }
+    /**
+     * Send audio data to the server.
+     * @param audio - The audio data to send to the server.
+     */
     sendAudio(audio) {
         this.send(audio);
     }
+    /**
+     * Create a writable stream that can be used to send audio data to the server.
+     * @returns A writable stream that can be used to send audio data to the server.
+     */
     stream() {
         return new WritableStream({
             write: (chunk) => {
@@ -335,6 +421,11 @@ class RealtimeTranscriber {
         }
         this.socket.send(data);
     }
+    /**
+     * Close the connection to the server.
+     * @param waitForSessionTermination - If true, the method will wait for the session to be terminated before closing the connection.
+     * While waiting for the session to be terminated, you will receive the final transcript and session information.
+     */
     close() {
         return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
             var _a;
@@ -405,6 +496,8 @@ function getPath(path) {
         return null;
     if (path.startsWith("https"))
         return null;
+    if (path.startsWith("data:"))
+        return null;
     if (path.startsWith("file://"))
         return path.substring(7);
     if (path.startsWith("file:"))
@@ -449,8 +542,13 @@ class TranscriptService extends BaseService {
                         audioUrl = yield this.files.upload(path);
                     }
                     else {
-                        // audio is not a local path, assume it's a URL
-                        audioUrl = audio;
+                        if (audio.startsWith("data:")) {
+                            audioUrl = yield this.files.upload(audio);
+                        }
+                        else {
+                            // audio is not a local path, and not a data-URI, assume it's a normal URL
+                            audioUrl = audio;
+                        }
                     }
                 }
                 else {
@@ -615,13 +713,45 @@ class TranscriptService extends BaseService {
         });
     }
     /**
-     * Retrieve redactions of a transcript.
+     * Retrieve the redacted audio URL of a transcript.
      * @param id - The identifier of the transcript.
-     * @returns A promise that resolves to the subtitles text.
+     * @returns A promise that resolves to the details of the redacted audio.
+     * @deprecated Use `redactedAudio` instead.
      */
     redactions(id) {
+        return this.redactedAudio(id);
+    }
+    /**
+     * Retrieve the redacted audio URL of a transcript.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the details of the redacted audio.
+     */
+    redactedAudio(id) {
         return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
     }
+    /**
+     * Retrieve the redacted audio file of a transcript.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the fetch HTTP response of the redacted audio file.
+     */
+    redactedAudioFile(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { redacted_audio_url, status } = yield this.redactedAudio(id);
+            if (status !== "redacted_audio_ready") {
+                throw new Error(`Redacted audio status is ${status}`);
+            }
+            const response = yield fetch(redacted_audio_url);
+            if (!response.ok) {
+                throw new Error(`Failed to fetch redacted audio: ${response.statusText}`);
+            }
+            return {
+                arrayBuffer: response.arrayBuffer.bind(response),
+                blob: response.blob.bind(response),
+                body: response.body,
+                bodyUsed: response.bodyUsed,
+            };
+        });
+    }
 }
 function deprecateConformer2(params) {
     if (!params)
@@ -648,8 +778,14 @@ class FileService extends BaseService {
     upload(input) {
         return __awaiter(this, void 0, void 0, function* () {
             let fileData;
-            if (typeof input === "string")
-                fileData = yield readFile();
+            if (typeof input === "string") {
+                if (input.startsWith("data:")) {
+                    fileData = dataUrlToBlob(input);
+                }
+                else {
+                    fileData = yield readFile();
+                }
+            }
             else
                 fileData = input;
             const data = yield this.fetchJson("/v2/upload", {
@@ -664,6 +800,17 @@ class FileService extends BaseService {
         });
     }
 }
+function dataUrlToBlob(dataUrl) {
+    const arr = dataUrl.split(",");
+    const mime = arr[0].match(/:(.*?);/)[1];
+    const bstr = atob(arr[1]);
+    let n = bstr.length;
+    const u8arr = new Uint8Array(n);
+    while (n--) {
+        u8arr[n] = bstr.charCodeAt(n);
+    }
+    return new Blob([u8arr], { type: mime });
+}
 
 const defaultBaseUrl = "https://api.assemblyai.com";
 class AssemblyAI {
@@ -673,8 +820,9 @@ class AssemblyAI {
      */
     constructor(params) {
         params.baseUrl = params.baseUrl || defaultBaseUrl;
-        if (params.baseUrl && params.baseUrl.endsWith("/"))
+        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);