assemblyai 4.12.1 → 4.13.0-beta.1

package/dist/index.cjs

@@ -63,7 +63,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.12.1" },
+    sdk: { name: "JavaScript", version: "4.13.0-beta.1" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -256,9 +256,48 @@ const RealtimeErrorMessages = {
 class RealtimeError extends Error {
 }
 
+const StreamingErrorType = {
+    BadSampleRate: 4000,
+    AuthFailed: 4001,
+    InsufficientFunds: 4002,
+    FreeTierUser: 4003,
+    NonexistentSessionId: 4004,
+    SessionExpired: 4008,
+    ClosedSession: 4010,
+    RateLimited: 4029,
+    UniqueSessionViolation: 4030,
+    SessionTimeout: 4031,
+    AudioTooShort: 4032,
+    AudioTooLong: 4033,
+    AudioTooSmallToTranscode: 4034,
+    BadSchema: 4101,
+    TooManyStreams: 4102,
+    Reconnected: 4103,
+};
+const StreamingErrorMessages = {
+    [StreamingErrorType.BadSampleRate]: "Sample rate must be a positive integer",
+    [StreamingErrorType.AuthFailed]: "Not Authorized",
+    [StreamingErrorType.InsufficientFunds]: "Insufficient funds",
+    [StreamingErrorType.FreeTierUser]: "This feature is paid-only and requires you to add a credit card. Please visit https://app.assemblyai.com/ to add a credit card to your account.",
+    [StreamingErrorType.NonexistentSessionId]: "Session ID does not exist",
+    [StreamingErrorType.SessionExpired]: "Session has expired",
+    [StreamingErrorType.ClosedSession]: "Session is closed",
+    [StreamingErrorType.RateLimited]: "Rate limited",
+    [StreamingErrorType.UniqueSessionViolation]: "Unique session violation",
+    [StreamingErrorType.SessionTimeout]: "Session Timeout",
+    [StreamingErrorType.AudioTooShort]: "Audio too short",
+    [StreamingErrorType.AudioTooLong]: "Audio too long",
+    [StreamingErrorType.AudioTooSmallToTranscode]: "Audio too small to transcode",
+    [StreamingErrorType.BadSchema]: "Bad schema",
+    [StreamingErrorType.TooManyStreams]: "Too many streams",
+    [StreamingErrorType.Reconnected]: "This session has been reconnected. This WebSocket is no longer valid.",
+};
+class StreamingError extends Error {
+}
+
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 const forceEndOfUtteranceMessage = `{"force_end_utterance":true}`;
-const terminateSessionMessage = `{"terminate_session":true}`;
+const terminateSessionMessage$1 = `{"terminate_session":true}`;
 /**
  * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
  */
@@ -453,11 +492,11 @@ class RealtimeTranscriber {
                         const sessionTerminatedPromise = new Promise((resolve) => {
                             this.sessionTerminatedResolve = resolve;
                         });
-                        this.socket.send(terminateSessionMessage);
+                        this.socket.send(terminateSessionMessage$1);
                         yield sessionTerminatedPromise;
                     }
                     else {
-                        this.socket.send(terminateSessionMessage);
+                        this.socket.send(terminateSessionMessage$1);
                     }
                 }
                 if ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.removeAllListeners)
@@ -820,7 +859,172 @@ function dataUrlToBlob(dataUrl) {
     return new Blob([u8arr], { type: mime });
 }
 
+const defaultStreamingUrl$1 = "wss://streaming.assemblyai.com/v3/ws";
+const terminateSessionMessage = `{"type":"Terminate"}`;
+class StreamingTranscriber {
+    constructor(params) {
+        this.listeners = {};
+        this.params = Object.assign(Object.assign({}, params), { websocketBaseUrl: params.websocketBaseUrl || defaultStreamingUrl$1 });
+        if ("token" in params && params.token)
+            this.token = params.token;
+        if ("apiKey" in params && params.apiKey)
+            this.apiKey = params.apiKey;
+        if (!(this.token || this.apiKey)) {
+            throw new Error("API key or temporary token is required.");
+        }
+    }
+    connectionUrl() {
+        var _a;
+        const url = new URL((_a = this.params.websocketBaseUrl) !== null && _a !== void 0 ? _a : "");
+        if (url.protocol !== "wss:") {
+            throw new Error("Invalid protocol, must be wss");
+        }
+        const searchParams = new URLSearchParams();
+        searchParams.set("sample_rate", this.params.sampleRate.toString());
+        if (this.params.wordFinalizationMaxWaitTime) {
+            searchParams.set("word_finalization_max_wait_time", this.params.wordFinalizationMaxWaitTime.toString());
+        }
+        if (this.params.endOfTurnConfidenceThreshold) {
+            searchParams.set("end_of_turn_confidence_threshold", this.params.endOfTurnConfidenceThreshold.toString());
+        }
+        if (this.params.minEndOfTurnSilenceWhenConfident) {
+            searchParams.set("min_end_of_turn_silence_when_confident", this.params.minEndOfTurnSilenceWhenConfident.toString());
+        }
+        if (this.params.maxTurnSilence) {
+            searchParams.set("max_turn_silence", this.params.maxTurnSilence.toString());
+        }
+        if (this.params.formattedFinals) {
+            searchParams.set("formatted_finals", this.params.formattedFinals.toString());
+        }
+        url.search = searchParams.toString();
+        return url;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    on(event, listener) {
+        this.listeners[event] = listener;
+    }
+    connect() {
+        return new Promise((resolve) => {
+            if (this.socket) {
+                throw new Error("Already connected");
+            }
+            const url = this.connectionUrl();
+            this.socket = factory(url.toString(), {
+                headers: { Authorization: this.token || this.apiKey },
+            });
+            this.socket.binaryType = "arraybuffer";
+            this.socket.onopen = () => { };
+            this.socket.onclose = ({ code, reason }) => {
+                var _a, _b;
+                if (!reason) {
+                    if (code in StreamingErrorMessages) {
+                        reason = StreamingErrorMessages[code];
+                    }
+                }
+                (_b = (_a = this.listeners).close) === null || _b === void 0 ? void 0 : _b.call(_a, code, reason);
+            };
+            this.socket.onerror = (event) => {
+                var _a, _b, _c, _d;
+                if (event.error)
+                    (_b = (_a = this.listeners).error) === null || _b === void 0 ? void 0 : _b.call(_a, event.error);
+                else
+                    (_d = (_c = this.listeners).error) === null || _d === void 0 ? void 0 : _d.call(_c, new Error(event.message));
+            };
+            this.socket.onmessage = ({ data }) => {
+                var _a, _b, _c, _d, _e, _f, _g;
+                const message = JSON.parse(data.toString());
+                if ("error" in message) {
+                    (_b = (_a = this.listeners).error) === null || _b === void 0 ? void 0 : _b.call(_a, new StreamingError(message.error));
+                    return;
+                }
+                switch (message.type) {
+                    case "Begin": {
+                        resolve(message);
+                        (_d = (_c = this.listeners).open) === null || _d === void 0 ? void 0 : _d.call(_c, message);
+                        break;
+                    }
+                    case "Turn": {
+                        (_f = (_e = this.listeners).turn) === null || _f === void 0 ? void 0 : _f.call(_e, message);
+                        break;
+                    }
+                    case "Termination": {
+                        (_g = this.sessionTerminatedResolve) === null || _g === void 0 ? void 0 : _g.call(this);
+                        break;
+                    }
+                }
+            };
+        });
+    }
+    stream() {
+        return new WritableStream({
+            write: (chunk) => {
+                this.sendAudio(chunk);
+            },
+        });
+    }
+    sendAudio(audio) {
+        this.send(audio);
+    }
+    send(data) {
+        if (!this.socket || this.socket.readyState !== this.socket.OPEN) {
+            throw new Error("Socket is not open for communication");
+        }
+        this.socket.send(data);
+    }
+    close() {
+        return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
+            var _a;
+            if (this.socket) {
+                if (this.socket.readyState === this.socket.OPEN) {
+                    if (waitForSessionTermination) {
+                        const sessionTerminatedPromise = new Promise((resolve) => {
+                            this.sessionTerminatedResolve = resolve;
+                        });
+                        this.socket.send(terminateSessionMessage);
+                        yield sessionTerminatedPromise;
+                    }
+                    else {
+                        this.socket.send(terminateSessionMessage);
+                    }
+                }
+                if ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.removeAllListeners)
+                    this.socket.removeAllListeners();
+                this.socket.close();
+            }
+            this.listeners = {};
+            this.socket = undefined;
+        });
+    }
+}
+
+class StreamingTranscriberFactory extends BaseService {
+    constructor(params) {
+        super(params);
+    }
+    transcriber(params) {
+        return new StreamingTranscriber(params);
+    }
+    createTemporaryToken(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const searchParams = new URLSearchParams();
+            // Add each param to the search params
+            Object.entries(params).forEach(([key, value]) => {
+                if (value !== undefined && value !== null) {
+                    searchParams.append(key, String(value));
+                }
+            });
+            const queryString = searchParams.toString();
+            const url = queryString ? `/v3/token?${queryString}` : "/v3/token";
+            const data = yield this.fetchJson(url, {
+                method: "GET",
+            });
+            return data.token;
+        });
+    }
+}
+
 const defaultBaseUrl = "https://api.assemblyai.com";
+const defaultStreamingUrl = "https://streaming.assemblyai.com";
 class AssemblyAI {
     /**
      * Create a new AssemblyAI client.
@@ -835,6 +1039,7 @@ class AssemblyAI {
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
         this.realtime = new RealtimeTranscriberFactory(params);
+        this.streaming = new StreamingTranscriberFactory(Object.assign(Object.assign({}, params), { baseUrl: params.streamingBaseUrl || defaultStreamingUrl }));
     }
 }
 
@@ -845,4 +1050,5 @@ exports.RealtimeService = RealtimeService;
 exports.RealtimeServiceFactory = RealtimeServiceFactory;
 exports.RealtimeTranscriber = RealtimeTranscriber;
 exports.RealtimeTranscriberFactory = RealtimeTranscriberFactory;
+exports.StreamingTranscriber = StreamingTranscriber;
 exports.TranscriptService = TranscriptService;

package/dist/index.mjs

@@ -61,7 +61,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.12.1" },
+    sdk: { name: "JavaScript", version: "4.13.0-beta.1" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -254,9 +254,48 @@ const RealtimeErrorMessages = {
 class RealtimeError extends Error {
 }
 
+const StreamingErrorType = {
+    BadSampleRate: 4000,
+    AuthFailed: 4001,
+    InsufficientFunds: 4002,
+    FreeTierUser: 4003,
+    NonexistentSessionId: 4004,
+    SessionExpired: 4008,
+    ClosedSession: 4010,
+    RateLimited: 4029,
+    UniqueSessionViolation: 4030,
+    SessionTimeout: 4031,
+    AudioTooShort: 4032,
+    AudioTooLong: 4033,
+    AudioTooSmallToTranscode: 4034,
+    BadSchema: 4101,
+    TooManyStreams: 4102,
+    Reconnected: 4103,
+};
+const StreamingErrorMessages = {
+    [StreamingErrorType.BadSampleRate]: "Sample rate must be a positive integer",
+    [StreamingErrorType.AuthFailed]: "Not Authorized",
+    [StreamingErrorType.InsufficientFunds]: "Insufficient funds",
+    [StreamingErrorType.FreeTierUser]: "This feature is paid-only and requires you to add a credit card. Please visit https://app.assemblyai.com/ to add a credit card to your account.",
+    [StreamingErrorType.NonexistentSessionId]: "Session ID does not exist",
+    [StreamingErrorType.SessionExpired]: "Session has expired",
+    [StreamingErrorType.ClosedSession]: "Session is closed",
+    [StreamingErrorType.RateLimited]: "Rate limited",
+    [StreamingErrorType.UniqueSessionViolation]: "Unique session violation",
+    [StreamingErrorType.SessionTimeout]: "Session Timeout",
+    [StreamingErrorType.AudioTooShort]: "Audio too short",
+    [StreamingErrorType.AudioTooLong]: "Audio too long",
+    [StreamingErrorType.AudioTooSmallToTranscode]: "Audio too small to transcode",
+    [StreamingErrorType.BadSchema]: "Bad schema",
+    [StreamingErrorType.TooManyStreams]: "Too many streams",
+    [StreamingErrorType.Reconnected]: "This session has been reconnected. This WebSocket is no longer valid.",
+};
+class StreamingError extends Error {
+}
+
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 const forceEndOfUtteranceMessage = `{"force_end_utterance":true}`;
-const terminateSessionMessage = `{"terminate_session":true}`;
+const terminateSessionMessage$1 = `{"terminate_session":true}`;
 /**
  * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
  */
@@ -451,11 +490,11 @@ class RealtimeTranscriber {
                         const sessionTerminatedPromise = new Promise((resolve) => {
                             this.sessionTerminatedResolve = resolve;
                         });
-                        this.socket.send(terminateSessionMessage);
+                        this.socket.send(terminateSessionMessage$1);
                         yield sessionTerminatedPromise;
                     }
                     else {
-                        this.socket.send(terminateSessionMessage);
+                        this.socket.send(terminateSessionMessage$1);
                     }
                 }
                 if ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.removeAllListeners)
@@ -818,7 +857,172 @@ function dataUrlToBlob(dataUrl) {
     return new Blob([u8arr], { type: mime });
 }
 
+const defaultStreamingUrl$1 = "wss://streaming.assemblyai.com/v3/ws";
+const terminateSessionMessage = `{"type":"Terminate"}`;
+class StreamingTranscriber {
+    constructor(params) {
+        this.listeners = {};
+        this.params = Object.assign(Object.assign({}, params), { websocketBaseUrl: params.websocketBaseUrl || defaultStreamingUrl$1 });
+        if ("token" in params && params.token)
+            this.token = params.token;
+        if ("apiKey" in params && params.apiKey)
+            this.apiKey = params.apiKey;
+        if (!(this.token || this.apiKey)) {
+            throw new Error("API key or temporary token is required.");
+        }
+    }
+    connectionUrl() {
+        var _a;
+        const url = new URL((_a = this.params.websocketBaseUrl) !== null && _a !== void 0 ? _a : "");
+        if (url.protocol !== "wss:") {
+            throw new Error("Invalid protocol, must be wss");
+        }
+        const searchParams = new URLSearchParams();
+        searchParams.set("sample_rate", this.params.sampleRate.toString());
+        if (this.params.wordFinalizationMaxWaitTime) {
+            searchParams.set("word_finalization_max_wait_time", this.params.wordFinalizationMaxWaitTime.toString());
+        }
+        if (this.params.endOfTurnConfidenceThreshold) {
+            searchParams.set("end_of_turn_confidence_threshold", this.params.endOfTurnConfidenceThreshold.toString());
+        }
+        if (this.params.minEndOfTurnSilenceWhenConfident) {
+            searchParams.set("min_end_of_turn_silence_when_confident", this.params.minEndOfTurnSilenceWhenConfident.toString());
+        }
+        if (this.params.maxTurnSilence) {
+            searchParams.set("max_turn_silence", this.params.maxTurnSilence.toString());
+        }
+        if (this.params.formattedFinals) {
+            searchParams.set("formatted_finals", this.params.formattedFinals.toString());
+        }
+        url.search = searchParams.toString();
+        return url;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    on(event, listener) {
+        this.listeners[event] = listener;
+    }
+    connect() {
+        return new Promise((resolve) => {
+            if (this.socket) {
+                throw new Error("Already connected");
+            }
+            const url = this.connectionUrl();
+            this.socket = factory(url.toString(), {
+                headers: { Authorization: this.token || this.apiKey },
+            });
+            this.socket.binaryType = "arraybuffer";
+            this.socket.onopen = () => { };
+            this.socket.onclose = ({ code, reason }) => {
+                var _a, _b;
+                if (!reason) {
+                    if (code in StreamingErrorMessages) {
+                        reason = StreamingErrorMessages[code];
+                    }
+                }
+                (_b = (_a = this.listeners).close) === null || _b === void 0 ? void 0 : _b.call(_a, code, reason);
+            };
+            this.socket.onerror = (event) => {
+                var _a, _b, _c, _d;
+                if (event.error)
+                    (_b = (_a = this.listeners).error) === null || _b === void 0 ? void 0 : _b.call(_a, event.error);
+                else
+                    (_d = (_c = this.listeners).error) === null || _d === void 0 ? void 0 : _d.call(_c, new Error(event.message));
+            };
+            this.socket.onmessage = ({ data }) => {
+                var _a, _b, _c, _d, _e, _f, _g;
+                const message = JSON.parse(data.toString());
+                if ("error" in message) {
+                    (_b = (_a = this.listeners).error) === null || _b === void 0 ? void 0 : _b.call(_a, new StreamingError(message.error));
+                    return;
+                }
+                switch (message.type) {
+                    case "Begin": {
+                        resolve(message);
+                        (_d = (_c = this.listeners).open) === null || _d === void 0 ? void 0 : _d.call(_c, message);
+                        break;
+                    }
+                    case "Turn": {
+                        (_f = (_e = this.listeners).turn) === null || _f === void 0 ? void 0 : _f.call(_e, message);
+                        break;
+                    }
+                    case "Termination": {
+                        (_g = this.sessionTerminatedResolve) === null || _g === void 0 ? void 0 : _g.call(this);
+                        break;
+                    }
+                }
+            };
+        });
+    }
+    stream() {
+        return new WritableStream({
+            write: (chunk) => {
+                this.sendAudio(chunk);
+            },
+        });
+    }
+    sendAudio(audio) {
+        this.send(audio);
+    }
+    send(data) {
+        if (!this.socket || this.socket.readyState !== this.socket.OPEN) {
+            throw new Error("Socket is not open for communication");
+        }
+        this.socket.send(data);
+    }
+    close() {
+        return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
+            var _a;
+            if (this.socket) {
+                if (this.socket.readyState === this.socket.OPEN) {
+                    if (waitForSessionTermination) {
+                        const sessionTerminatedPromise = new Promise((resolve) => {
+                            this.sessionTerminatedResolve = resolve;
+                        });
+                        this.socket.send(terminateSessionMessage);
+                        yield sessionTerminatedPromise;
+                    }
+                    else {
+                        this.socket.send(terminateSessionMessage);
+                    }
+                }
+                if ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.removeAllListeners)
+                    this.socket.removeAllListeners();
+                this.socket.close();
+            }
+            this.listeners = {};
+            this.socket = undefined;
+        });
+    }
+}
+
+class StreamingTranscriberFactory extends BaseService {
+    constructor(params) {
+        super(params);
+    }
+    transcriber(params) {
+        return new StreamingTranscriber(params);
+    }
+    createTemporaryToken(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const searchParams = new URLSearchParams();
+            // Add each param to the search params
+            Object.entries(params).forEach(([key, value]) => {
+                if (value !== undefined && value !== null) {
+                    searchParams.append(key, String(value));
+                }
+            });
+            const queryString = searchParams.toString();
+            const url = queryString ? `/v3/token?${queryString}` : "/v3/token";
+            const data = yield this.fetchJson(url, {
+                method: "GET",
+            });
+            return data.token;
+        });
+    }
+}
+
 const defaultBaseUrl = "https://api.assemblyai.com";
+const defaultStreamingUrl = "https://streaming.assemblyai.com";
 class AssemblyAI {
     /**
      * Create a new AssemblyAI client.
@@ -833,7 +1037,8 @@ class AssemblyAI {
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
         this.realtime = new RealtimeTranscriberFactory(params);
+        this.streaming = new StreamingTranscriberFactory(Object.assign(Object.assign({}, params), { baseUrl: params.streamingBaseUrl || defaultStreamingUrl }));
     }
 }
 
-export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, RealtimeTranscriber, RealtimeTranscriberFactory, TranscriptService };
+export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, RealtimeTranscriber, RealtimeTranscriberFactory, StreamingTranscriber, TranscriptService };