assemblyai 4.0.0-beta.0 → 4.0.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,92 @@
+# Changelog
+
+## [4.0.0]
+
+### Added
+
+- Add `browser` and `workerd` (Cloudflare Workers) exports to package.json. These exports are compatible versions of the SDK, with a few limitations. You can't use the file system and you have to use a temporary auth token with the real-time transcriber.
+- Add `dist/assemblyai.umd.js` and `dist/assemblyai.umd.min.js`. You can reference these script files directly in the browser and the SDK will be available at the global `assemblyai` variable.
+
+### Changed
+
+- `RealtimeService.sendAudio` accepts audio via type `ArrayBufferLike`.
+- **Breaking**: `RealtimeService.stream` returns a [WHATWG Streams Standard stream](https://nodejs.org/api/webstreams.html), instead of a Node stream. In the browser, the native web standard stream will be used.
+- `ws` is used as the WebSocket client as before, but in the browser, the native WebSocket client is used.
+- Rename Node SDK to JavaScript SDK as the SDK is compatible with more runtimes now.
+
+## [3.1.1] - 2023-11-21
+
+### Added
+
+- Add `client.transcripts.transcribe` function to transcribe an audio file with polling until transcript status is `completed` or `error`. This function takes an `audio` option which can be an audio file URL, path, stream, or buffer.
+- Add `client.transcripts.submit` function to queue a transcript. You can use `client.transcripts.waitUntilReady` to poll the transcript returned by `submit`. This function also takes an `audio` option which can be an audio file URL, path, stream, or buffer.
+
+### Changed
+
+- Deprecated `client.transcripts.create` in favor of `transcribe` and `submit`, to be more consistent with other AssemblyAI SDKs.
+- Renamed types
+  - Renamed `Parameters` type suffix with `Params` type suffix
+  - Renamed `CreateTranscriptParameters` to `TranscriptParams`
+  - Renamed `CreateTranscriptOptionalParameters` to `TranscriptOptionalParams`.
+- Added deprecated aliases for the forementioned types
+- Improved type docs
+
+## [3.1.0] - 2023-11-16
+
+### Added
+
+- Add `AssemblyAI.transcripts.waitUntilReady` function to wait until a transcript is ready, meaning `status` is `completed` or `error`.
+- Add `chars_per_caption` parameter to `AssemblyAI.transcripts.subtitles` function.
+- Add `input_text` property to LeMUR functions. Instead of using `transcript_ids`, you can use `input_text` to provide custom formatted transcripts as input to LeMUR.
+
+### Changed
+
+- Change default timeout from 3 minutes to infinite (-1). Fixes [#17](https://github.com/AssemblyAI/assemblyai-node-sdk/issues/17)
+
+### Fixed
+
+- Correctly serialize the keywords for `client.transcripts.wordSearch`.
+- Use more widely compatible syntax for wildcard exporting types. Fixes [#18](https://github.com/AssemblyAI/assemblyai-node-sdk/issues/18).
+
+## [3.0.1] - 2023-10-30
+
+### Changed
+
+- The SDK uses `fetch` instead of Axios. This removes the Axios dependency. Axios relies on XMLHttpRequest which isn't supported in Cloudflare Workers, Deno, Bun, etc. By using `fetch`, the SDK is now more compatible on the forementioned runtimes.
+
+### Fixed
+
+- The SDK uses relative imports instead of using path aliases, to make the library transpilable with tsc for consumers. Fixes [#14](https://github.com/AssemblyAI/assemblyai-node-sdk/issues/14).
+- Added `speaker` property to the `TranscriptUtterance` type, and removed `channel` property.
+
+## [3.0.0] - 2023-10-24
+
+### Changed
+
+- `AssemblyAI.files.upload` accepts streams and buffers, in addition to a string (path to file).
+
+### Removed
+
+- **Breaking**: The module does not have a default export anymore, because of inconsistent functionality across module systems. Instead, use `AssemblyAI` as a named import like this: `import { AssemblyAI } from 'assemblyai'`.
+
+## [2.0.2] - 2023-10-13
+
+### Added
+
+- `AssemblyAI.transcripts.wordSearch` searches for keywords in the transcript.
+- `AssemblyAI.lemur.purgeRequestData` deletes data related to your LeMUR request.
+- `RealtimeService.stream` creates a writable stream that you can write audio data to instead of using `RealtimeService.sendAudio``.
+
+### Fixed
+
+- The AssemblyAI class would be exported as default named export instead in certain module systems.
+
+## [2.0.1] - 2023-10-10
+
+Re-implement the Node SDK in TypeScript and add all AssemblyAI APIs.
+
+### Added
+
+- Transcript API client
+- LeMUR API client
+- Real-time transcript client

package/dist/assemblyai.umd.js

@@ -146,32 +146,26 @@
       ByteLengthQueuingStrategy,
       CountQueuingStrategy,
       TextEncoderStream,
-      TextDecoderStream,
-    } = window;
-
-    // Polyfill to make ReadableStream async-iterable with for-await
-    // https://jakearchibald.com/2017/async-iterators-and-generators/#making-streams-iterate
-    if (!ReadableStream.prototype[Symbol.asyncIterator]) {
-      async function* streamAsyncIterator() {
-        // Get a lock on the stream
-        const reader = this.getReader();
-
-        try {
-          while (true) {
-            // Read from the stream
-            const { done, value } = await reader.read();
-            // Exit if we're done
-            if (done) return;
-            // Else yield the chunk
-            yield value;
+      TextDecoderStream
+    } = typeof window !== "undefined" ? window : typeof global !== "undefined" ? global : globalThis;
+    (function(ReadableStream2) {
+      if (!ReadableStream2.prototype[Symbol.asyncIterator]) {
+        async function* streamAsyncIterator() {
+          const reader = this.getReader();
+          try {
+            while (true) {
+              const { done, value } = await reader.read();
+              if (done)
+                return;
+              yield value;
+            }
+          } finally {
+            reader.releaseLock();
           }
-        } finally {
-          reader.releaseLock();
         }
+        ReadableStream2.prototype[Symbol.asyncIterator] = streamAsyncIterator;
       }
-
-      ReadableStream.prototype[Symbol.asyncIterator] = streamAsyncIterator;
-    }
+    })(ReadableStream);
 
     // https://github.com/maxogden/websocket-stream/blob/48dc3ddf943e5ada668c31ccd94e9186f02fafbd/ws-fallback.js
 
@@ -240,9 +234,9 @@
             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;
-            if ("apiKey" in params)
+            if ("apiKey" in params && params.apiKey)
                 this.apiKey = params.apiKey;
-            if ("token" in params)
+            if ("token" in params && params.token)
                 this.token = params.token;
             if (!(this.apiKey || this.token)) {
                 throw new Error("API key or temporary token is required.");
@@ -628,7 +622,7 @@
     }
 
     function throwError() {
-      throw new Error("Function is not supported in this environment.");
+      throw new Error("'fs' is not supported in this environment.");
     }
 
     const createReadStream = throwError;

package/dist/assemblyai.umd.min.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).assemblyai={})}(this,(function(e){"use strict";function t(e,t,o,s){return new(o||(o=Promise))((function(r,i){function n(e){try{l(s.next(e))}catch(e){i(e)}}function a(e){try{l(s.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?r(e.value):(t=e.value,t instanceof o?t:new o((function(e){e(t)}))).then(n,a)}l((s=s.apply(e,t||[])).next())}))}"function"==typeof SuppressedError&&SuppressedError;class o{constructor(e){this.params=e}fetch(e,o){var s;return t(this,void 0,void 0,(function*(){(o=null!=o?o:{}).headers=null!==(s=o.headers)&&void 0!==s?s:{},o.headers=Object.assign({Authorization:this.params.apiKey,"Content-Type":"application/json"},o.headers),e.startsWith("http")||(e=this.params.baseUrl+e);const t=yield fetch(e,o);if(t.status>=400){let e;const o=yield t.text();if(o){try{e=JSON.parse(o)}catch(e){}if(null==e?void 0:e.error)throw new Error(e.error);throw new Error(o)}throw new Error(`HTTP Error: ${t.status} ${t.statusText}`)}return t}))}fetchJson(e,o){return t(this,void 0,void 0,(function*(){return(yield this.fetch(e,o)).json()}))}}class s extends o{summary(e){return this.fetchJson("/lemur/v3/generate/summary",{method:"POST",body:JSON.stringify(e)})}questionAnswer(e){return this.fetchJson("/lemur/v3/generate/question-answer",{method:"POST",body:JSON.stringify(e)})}actionItems(e){return this.fetchJson("/lemur/v3/generate/action-items",{method:"POST",body:JSON.stringify(e)})}task(e){return this.fetchJson("/lemur/v3/generate/task",{method:"POST",body:JSON.stringify(e)})}purgeRequestData(e){return this.fetchJson(`/lemur/v3/${e}`,{method:"DELETE"})}}const{ReadableStream:r,ReadableStreamDefaultReader:i,ReadableStreamBYOBReader:n,ReadableStreamBYOBRequest:a,ReadableByteStreamController:l,ReadableStreamDefaultController:c,TransformStream:d,TransformStreamDefaultController:u,WritableStream:h,WritableStreamDefaultWriter:f,WritableStreamDefaultController:p,ByteLengthQueuingStrategy:m,CountQueuingStrategy:y,TextEncoderStream:S,TextDecoderStream:v}=window;if(!r.prototype[Symbol.asyncIterator]){async function*P(){const e=this.getReader();try{for(;;){const{done:t,value:o}=await e.read();if(t)return;yield o}}finally{e.releaseLock()}}r.prototype[Symbol.asyncIterator]=P}var w=null;"undefined"!=typeof WebSocket?w=WebSocket:"undefined"!=typeof MozWebSocket?w=MozWebSocket:"undefined"!=typeof global?w=global.WebSocket||global.MozWebSocket:"undefined"!=typeof window?w=window.WebSocket||window.MozWebSocket:"undefined"!=typeof self&&(w=self.WebSocket||self.MozWebSocket);var b,g=w;!function(e){e[e.BadSampleRate=4e3]="BadSampleRate",e[e.AuthFailed=4001]="AuthFailed",e[e.InsufficientFundsOrFreeAccount=4002]="InsufficientFundsOrFreeAccount",e[e.NonexistentSessionId=4004]="NonexistentSessionId",e[e.SessionExpired=4008]="SessionExpired",e[e.ClosedSession=4010]="ClosedSession",e[e.RateLimited=4029]="RateLimited",e[e.UniqueSessionViolation=4030]="UniqueSessionViolation",e[e.SessionTimeout=4031]="SessionTimeout",e[e.AudioTooShort=4032]="AudioTooShort",e[e.AudioTooLong=4033]="AudioTooLong",e[e.BadJson=4100]="BadJson",e[e.BadSchema=4101]="BadSchema",e[e.TooManyStreams=4102]="TooManyStreams",e[e.Reconnected=4103]="Reconnected",e[e.ReconnectAttemptsExhausted=1013]="ReconnectAttemptsExhausted"}(b||(b={}));const k={[b.BadSampleRate]:"Sample rate must be a positive integer",[b.AuthFailed]:"Not Authorized",[b.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.",[b.NonexistentSessionId]:"Session ID does not exist",[b.SessionExpired]:"Session has expired",[b.ClosedSession]:"Session is closed",[b.RateLimited]:"Rate limited",[b.UniqueSessionViolation]:"Unique session violation",[b.SessionTimeout]:"Session Timeout",[b.AudioTooShort]:"Audio too short",[b.AudioTooLong]:"Audio too long",[b.BadJson]:"Bad JSON",[b.BadSchema]:"Bad schema",[b.TooManyStreams]:"Too many streams",[b.Reconnected]:"Reconnected",[b.ReconnectAttemptsExhausted]:"Reconnect attempts exhausted"};class T extends Error{}class R{constructor(e){var t,o;if(this.listeners={},this.realtimeUrl=null!==(t=e.realtimeUrl)&&void 0!==t?t:"wss://api.assemblyai.com/v2/realtime/ws",this.sampleRate=null!==(o=e.sampleRate)&&void 0!==o?o:16e3,this.wordBoost=e.wordBoost,"apiKey"in e&&(this.apiKey=e.apiKey),"token"in e&&(this.token=e.token),!this.apiKey&&!this.token)throw new Error("API key or temporary token is required.")}connectionUrl(){const e=new URL(this.realtimeUrl);if("wss:"!==e.protocol)throw new Error("Invalid protocol, must be wss");const t=new URLSearchParams;return this.token&&t.set("token",this.token),t.set("sample_rate",this.sampleRate.toString()),this.wordBoost&&this.wordBoost.length>0&&t.set("word_boost",JSON.stringify(this.wordBoost)),e.search=t.toString(),e}on(e,t){this.listeners[e]=t}connect(){return new Promise((e=>{if(this.socket)throw new Error("Already connected");const t=this.connectionUrl();this.token?this.socket=new g(t.toString()):this.socket=new g(t.toString(),{headers:{Authorization:this.apiKey}}),this.socket.onclose=({code:e,reason:t})=>{var o,s;t||e in b&&(t=k[e]),null===(s=(o=this.listeners).close)||void 0===s||s.call(o,e,t)},this.socket.onerror=e=>{var t,o,s,r;e.error?null===(o=(t=this.listeners).error)||void 0===o||o.call(t,e.error):null===(r=(s=this.listeners).error)||void 0===r||r.call(s,new Error(e.message))},this.socket.onmessage=({data:t})=>{var o,s,r,i,n,a,l,c,d,u,h,f,p;const m=JSON.parse(t.toString());if("error"in m)null===(s=(o=this.listeners).error)||void 0===s||s.call(o,new T(m.error));else switch(m.message_type){case"SessionBegins":{const t={sessionId:m.session_id,expiresAt:new Date(m.expires_at)};e(t),null===(i=(r=this.listeners).open)||void 0===i||i.call(r,t);break}case"PartialTranscript":m.created=new Date(m.created),null===(a=(n=this.listeners).transcript)||void 0===a||a.call(n,m),null===(c=(l=this.listeners)["transcript.partial"])||void 0===c||c.call(l,m);break;case"FinalTranscript":m.created=new Date(m.created),null===(u=(d=this.listeners).transcript)||void 0===u||u.call(d,m),null===(f=(h=this.listeners)["transcript.final"])||void 0===f||f.call(h,m);break;case"SessionTerminated":null===(p=this.sessionTerminatedResolve)||void 0===p||p.call(this)}}}))}sendAudio(e){if(!this.socket||this.socket.readyState!==g.OPEN)throw new Error("Socket is not open for communication");let t;t="undefined"!=typeof Buffer?Buffer.from(e).toString("base64"):btoa(new Uint8Array(e).reduce(((e,t)=>e+String.fromCharCode(t)),""));const o={audio_data:t};this.socket.send(JSON.stringify(o))}stream(){return new h({write:e=>{this.sendAudio(e)}})}close(e=!0){return t(this,void 0,void 0,(function*(){if(this.socket){if(this.socket.readyState===g.OPEN){const t='{"terminate_session": true}';if(e){const e=new Promise((e=>{this.sessionTerminatedResolve=e}));this.socket.send(t),yield e}else this.socket.send(t)}"removeAllListeners"in this.socket&&this.socket.removeAllListeners(),this.socket.close()}this.listeners={},this.socket=void 0}))}}class O extends o{constructor(e){super(e),this.rtFactoryParams=e}createService(e){return e?"token"in e||e.apiKey||(e.apiKey=this.rtFactoryParams.apiKey):e={apiKey:this.rtFactoryParams.apiKey},new R(e)}createTemporaryToken(e){return t(this,void 0,void 0,(function*(){return(yield this.fetchJson("/v2/realtime/token",{method:"POST",body:JSON.stringify(e)})).token}))}}class x extends o{constructor(e,t){super(e),this.files=t}transcribe(e,o){return t(this,void 0,void 0,(function*(){const t=yield this.submit(e);return yield this.waitUntilReady(t.id,o)}))}submit(e){return t(this,void 0,void 0,(function*(){const{audio:t}=e,o=function(e,t){var o={};for(var s in e)Object.prototype.hasOwnProperty.call(e,s)&&t.indexOf(s)<0&&(o[s]=e[s]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var r=0;for(s=Object.getOwnPropertySymbols(e);r<s.length;r++)t.indexOf(s[r])<0&&Object.prototype.propertyIsEnumerable.call(e,s[r])&&(o[s[r]]=e[s[r]])}return o}(e,["audio"]);let s;if("string"==typeof t){const e=J(t);s=null!==e?yield this.files.upload(e):t}else s=yield this.files.upload(t);return yield this.fetchJson("/v2/transcript",{method:"POST",body:JSON.stringify(Object.assign(Object.assign({},o),{audio_url:s}))})}))}create(e,o){var s;return t(this,void 0,void 0,(function*(){const t=J(e.audio_url);if(null!==t){const o=yield this.files.upload(t);e.audio_url=o}const r=yield this.fetchJson("/v2/transcript",{method:"POST",body:JSON.stringify(e)});return null===(s=null==o?void 0:o.poll)||void 0===s||s?yield this.waitUntilReady(r.id,o):r}))}waitUntilReady(e,o){var s,r;return t(this,void 0,void 0,(function*(){const t=null!==(s=null==o?void 0:o.pollingInterval)&&void 0!==s?s:3e3,i=null!==(r=null==o?void 0:o.pollingTimeout)&&void 0!==r?r:-1,n=Date.now();for(;;){const o=yield this.get(e);if("completed"===o.status||"error"===o.status)return o;if(i>0&&Date.now()-n>i)throw new Error("Polling timeout");yield new Promise((e=>setTimeout(e,t)))}}))}get(e){return this.fetchJson(`/v2/transcript/${e}`)}list(e){return t(this,void 0,void 0,(function*(){let t="/v2/transcript";"string"==typeof e?t=e:e&&(t=`${t}?${new URLSearchParams(Object.keys(e).map((t=>{var o;return[t,(null===(o=e[t])||void 0===o?void 0:o.toString())||""]})))}`);const o=yield this.fetchJson(t);for(const e of o.transcripts)e.created=new Date(e.created),e.completed&&(e.completed=new Date(e.completed));return o}))}delete(e){return this.fetchJson(`/v2/transcript/${e}`,{method:"DELETE"})}wordSearch(e,t){const o=new URLSearchParams({words:t.join(",")});return this.fetchJson(`/v2/transcript/${e}/word-search?${o.toString()}`)}sentences(e){return this.fetchJson(`/v2/transcript/${e}/sentences`)}paragraphs(e){return this.fetchJson(`/v2/transcript/${e}/paragraphs`)}subtitles(e,o="srt",s){return t(this,void 0,void 0,(function*(){let t=`/v2/transcript/${e}/${o}`;if(s){const e=new URLSearchParams;e.set("chars_per_caption",s.toString()),t+=`?${e.toString()}`}const r=yield this.fetch(t);return yield r.text()}))}redactions(e){return this.fetchJson(`/v2/transcript/${e}/redacted-audio`)}}function J(e){let t;try{return t=new URL(e),"file:"===t.protocol?t.pathname:null}catch(t){return e}}var A={createReadStream:function(){throw new Error("Function is not supported in this environment.")}};class E extends o{upload(e){return t(this,void 0,void 0,(function*(){let t;t="string"==typeof e?A.createReadStream(e):e;return(yield this.fetchJson("/v2/upload",{method:"POST",body:t,headers:{"Content-Type":"application/octet-stream"},duplex:"half"})).upload_url}))}}e.AssemblyAI=class{constructor(e){e.baseUrl=e.baseUrl||"https://api.assemblyai.com",e.baseUrl&&e.baseUrl.endsWith("/")&&(e.baseUrl=e.baseUrl.slice(0,-1)),this.files=new E(e),this.transcripts=new x(e,this.files),this.lemur=new s(e),this.realtime=new O(e)}},e.FileService=E,e.LemurService=s,e.RealtimeService=R,e.RealtimeServiceFactory=O,e.TranscriptService=x}));
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).assemblyai={})}(this,(function(e){"use strict";function t(e,t,o,s){return new(o||(o=Promise))((function(r,i){function n(e){try{l(s.next(e))}catch(e){i(e)}}function a(e){try{l(s.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?r(e.value):(t=e.value,t instanceof o?t:new o((function(e){e(t)}))).then(n,a)}l((s=s.apply(e,t||[])).next())}))}"function"==typeof SuppressedError&&SuppressedError;class o{constructor(e){this.params=e}fetch(e,o){var s;return t(this,void 0,void 0,(function*(){(o=null!=o?o:{}).headers=null!==(s=o.headers)&&void 0!==s?s:{},o.headers=Object.assign({Authorization:this.params.apiKey,"Content-Type":"application/json"},o.headers),e.startsWith("http")||(e=this.params.baseUrl+e);const t=yield fetch(e,o);if(t.status>=400){let e;const o=yield t.text();if(o){try{e=JSON.parse(o)}catch(e){}if(null==e?void 0:e.error)throw new Error(e.error);throw new Error(o)}throw new Error(`HTTP Error: ${t.status} ${t.statusText}`)}return t}))}fetchJson(e,o){return t(this,void 0,void 0,(function*(){return(yield this.fetch(e,o)).json()}))}}class s extends o{summary(e){return this.fetchJson("/lemur/v3/generate/summary",{method:"POST",body:JSON.stringify(e)})}questionAnswer(e){return this.fetchJson("/lemur/v3/generate/question-answer",{method:"POST",body:JSON.stringify(e)})}actionItems(e){return this.fetchJson("/lemur/v3/generate/action-items",{method:"POST",body:JSON.stringify(e)})}task(e){return this.fetchJson("/lemur/v3/generate/task",{method:"POST",body:JSON.stringify(e)})}purgeRequestData(e){return this.fetchJson(`/lemur/v3/${e}`,{method:"DELETE"})}}const{ReadableStream:r,ReadableStreamDefaultReader:i,ReadableStreamBYOBReader:n,ReadableStreamBYOBRequest:a,ReadableByteStreamController:l,ReadableStreamDefaultController:c,TransformStream:d,TransformStreamDefaultController:u,WritableStream:h,WritableStreamDefaultWriter:f,WritableStreamDefaultController:p,ByteLengthQueuingStrategy:m,CountQueuingStrategy:y,TextEncoderStream:S,TextDecoderStream:v}="undefined"!=typeof window?window:"undefined"!=typeof global?global:globalThis;!function(e){if(!e.prototype[Symbol.asyncIterator]){async function*t(){const e=this.getReader();try{for(;;){const{done:t,value:o}=await e.read();if(t)return;yield o}}finally{e.releaseLock()}}e.prototype[Symbol.asyncIterator]=t}}(r);var w=null;"undefined"!=typeof WebSocket?w=WebSocket:"undefined"!=typeof MozWebSocket?w=MozWebSocket:"undefined"!=typeof global?w=global.WebSocket||global.MozWebSocket:"undefined"!=typeof window?w=window.WebSocket||window.MozWebSocket:"undefined"!=typeof self&&(w=self.WebSocket||self.MozWebSocket);var b,g=w;!function(e){e[e.BadSampleRate=4e3]="BadSampleRate",e[e.AuthFailed=4001]="AuthFailed",e[e.InsufficientFundsOrFreeAccount=4002]="InsufficientFundsOrFreeAccount",e[e.NonexistentSessionId=4004]="NonexistentSessionId",e[e.SessionExpired=4008]="SessionExpired",e[e.ClosedSession=4010]="ClosedSession",e[e.RateLimited=4029]="RateLimited",e[e.UniqueSessionViolation=4030]="UniqueSessionViolation",e[e.SessionTimeout=4031]="SessionTimeout",e[e.AudioTooShort=4032]="AudioTooShort",e[e.AudioTooLong=4033]="AudioTooLong",e[e.BadJson=4100]="BadJson",e[e.BadSchema=4101]="BadSchema",e[e.TooManyStreams=4102]="TooManyStreams",e[e.Reconnected=4103]="Reconnected",e[e.ReconnectAttemptsExhausted=1013]="ReconnectAttemptsExhausted"}(b||(b={}));const k={[b.BadSampleRate]:"Sample rate must be a positive integer",[b.AuthFailed]:"Not Authorized",[b.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.",[b.NonexistentSessionId]:"Session ID does not exist",[b.SessionExpired]:"Session has expired",[b.ClosedSession]:"Session is closed",[b.RateLimited]:"Rate limited",[b.UniqueSessionViolation]:"Unique session violation",[b.SessionTimeout]:"Session Timeout",[b.AudioTooShort]:"Audio too short",[b.AudioTooLong]:"Audio too long",[b.BadJson]:"Bad JSON",[b.BadSchema]:"Bad schema",[b.TooManyStreams]:"Too many streams",[b.Reconnected]:"Reconnected",[b.ReconnectAttemptsExhausted]:"Reconnect attempts exhausted"};class T extends Error{}class R{constructor(e){var t,o;if(this.listeners={},this.realtimeUrl=null!==(t=e.realtimeUrl)&&void 0!==t?t:"wss://api.assemblyai.com/v2/realtime/ws",this.sampleRate=null!==(o=e.sampleRate)&&void 0!==o?o:16e3,this.wordBoost=e.wordBoost,"apiKey"in e&&e.apiKey&&(this.apiKey=e.apiKey),"token"in e&&e.token&&(this.token=e.token),!this.apiKey&&!this.token)throw new Error("API key or temporary token is required.")}connectionUrl(){const e=new URL(this.realtimeUrl);if("wss:"!==e.protocol)throw new Error("Invalid protocol, must be wss");const t=new URLSearchParams;return this.token&&t.set("token",this.token),t.set("sample_rate",this.sampleRate.toString()),this.wordBoost&&this.wordBoost.length>0&&t.set("word_boost",JSON.stringify(this.wordBoost)),e.search=t.toString(),e}on(e,t){this.listeners[e]=t}connect(){return new Promise((e=>{if(this.socket)throw new Error("Already connected");const t=this.connectionUrl();this.token?this.socket=new g(t.toString()):this.socket=new g(t.toString(),{headers:{Authorization:this.apiKey}}),this.socket.onclose=({code:e,reason:t})=>{var o,s;t||e in b&&(t=k[e]),null===(s=(o=this.listeners).close)||void 0===s||s.call(o,e,t)},this.socket.onerror=e=>{var t,o,s,r;e.error?null===(o=(t=this.listeners).error)||void 0===o||o.call(t,e.error):null===(r=(s=this.listeners).error)||void 0===r||r.call(s,new Error(e.message))},this.socket.onmessage=({data:t})=>{var o,s,r,i,n,a,l,c,d,u,h,f,p;const m=JSON.parse(t.toString());if("error"in m)null===(s=(o=this.listeners).error)||void 0===s||s.call(o,new T(m.error));else switch(m.message_type){case"SessionBegins":{const t={sessionId:m.session_id,expiresAt:new Date(m.expires_at)};e(t),null===(i=(r=this.listeners).open)||void 0===i||i.call(r,t);break}case"PartialTranscript":m.created=new Date(m.created),null===(a=(n=this.listeners).transcript)||void 0===a||a.call(n,m),null===(c=(l=this.listeners)["transcript.partial"])||void 0===c||c.call(l,m);break;case"FinalTranscript":m.created=new Date(m.created),null===(u=(d=this.listeners).transcript)||void 0===u||u.call(d,m),null===(f=(h=this.listeners)["transcript.final"])||void 0===f||f.call(h,m);break;case"SessionTerminated":null===(p=this.sessionTerminatedResolve)||void 0===p||p.call(this)}}}))}sendAudio(e){if(!this.socket||this.socket.readyState!==g.OPEN)throw new Error("Socket is not open for communication");let t;t="undefined"!=typeof Buffer?Buffer.from(e).toString("base64"):btoa(new Uint8Array(e).reduce(((e,t)=>e+String.fromCharCode(t)),""));const o={audio_data:t};this.socket.send(JSON.stringify(o))}stream(){return new h({write:e=>{this.sendAudio(e)}})}close(e=!0){return t(this,void 0,void 0,(function*(){if(this.socket){if(this.socket.readyState===g.OPEN){const t='{"terminate_session": true}';if(e){const e=new Promise((e=>{this.sessionTerminatedResolve=e}));this.socket.send(t),yield e}else this.socket.send(t)}"removeAllListeners"in this.socket&&this.socket.removeAllListeners(),this.socket.close()}this.listeners={},this.socket=void 0}))}}class O extends o{constructor(e){super(e),this.rtFactoryParams=e}createService(e){return e?"token"in e||e.apiKey||(e.apiKey=this.rtFactoryParams.apiKey):e={apiKey:this.rtFactoryParams.apiKey},new R(e)}createTemporaryToken(e){return t(this,void 0,void 0,(function*(){return(yield this.fetchJson("/v2/realtime/token",{method:"POST",body:JSON.stringify(e)})).token}))}}class x extends o{constructor(e,t){super(e),this.files=t}transcribe(e,o){return t(this,void 0,void 0,(function*(){const t=yield this.submit(e);return yield this.waitUntilReady(t.id,o)}))}submit(e){return t(this,void 0,void 0,(function*(){const{audio:t}=e,o=function(e,t){var o={};for(var s in e)Object.prototype.hasOwnProperty.call(e,s)&&t.indexOf(s)<0&&(o[s]=e[s]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var r=0;for(s=Object.getOwnPropertySymbols(e);r<s.length;r++)t.indexOf(s[r])<0&&Object.prototype.propertyIsEnumerable.call(e,s[r])&&(o[s[r]]=e[s[r]])}return o}(e,["audio"]);let s;if("string"==typeof t){const e=J(t);s=null!==e?yield this.files.upload(e):t}else s=yield this.files.upload(t);return yield this.fetchJson("/v2/transcript",{method:"POST",body:JSON.stringify(Object.assign(Object.assign({},o),{audio_url:s}))})}))}create(e,o){var s;return t(this,void 0,void 0,(function*(){const t=J(e.audio_url);if(null!==t){const o=yield this.files.upload(t);e.audio_url=o}const r=yield this.fetchJson("/v2/transcript",{method:"POST",body:JSON.stringify(e)});return null===(s=null==o?void 0:o.poll)||void 0===s||s?yield this.waitUntilReady(r.id,o):r}))}waitUntilReady(e,o){var s,r;return t(this,void 0,void 0,(function*(){const t=null!==(s=null==o?void 0:o.pollingInterval)&&void 0!==s?s:3e3,i=null!==(r=null==o?void 0:o.pollingTimeout)&&void 0!==r?r:-1,n=Date.now();for(;;){const o=yield this.get(e);if("completed"===o.status||"error"===o.status)return o;if(i>0&&Date.now()-n>i)throw new Error("Polling timeout");yield new Promise((e=>setTimeout(e,t)))}}))}get(e){return this.fetchJson(`/v2/transcript/${e}`)}list(e){return t(this,void 0,void 0,(function*(){let t="/v2/transcript";"string"==typeof e?t=e:e&&(t=`${t}?${new URLSearchParams(Object.keys(e).map((t=>{var o;return[t,(null===(o=e[t])||void 0===o?void 0:o.toString())||""]})))}`);const o=yield this.fetchJson(t);for(const e of o.transcripts)e.created=new Date(e.created),e.completed&&(e.completed=new Date(e.completed));return o}))}delete(e){return this.fetchJson(`/v2/transcript/${e}`,{method:"DELETE"})}wordSearch(e,t){const o=new URLSearchParams({words:t.join(",")});return this.fetchJson(`/v2/transcript/${e}/word-search?${o.toString()}`)}sentences(e){return this.fetchJson(`/v2/transcript/${e}/sentences`)}paragraphs(e){return this.fetchJson(`/v2/transcript/${e}/paragraphs`)}subtitles(e,o="srt",s){return t(this,void 0,void 0,(function*(){let t=`/v2/transcript/${e}/${o}`;if(s){const e=new URLSearchParams;e.set("chars_per_caption",s.toString()),t+=`?${e.toString()}`}const r=yield this.fetch(t);return yield r.text()}))}redactions(e){return this.fetchJson(`/v2/transcript/${e}/redacted-audio`)}}function J(e){let t;try{return t=new URL(e),"file:"===t.protocol?t.pathname:null}catch(t){return e}}var A={createReadStream:function(){throw new Error("'fs' is not supported in this environment.")}};class E extends o{upload(e){return t(this,void 0,void 0,(function*(){let t;t="string"==typeof e?A.createReadStream(e):e;return(yield this.fetchJson("/v2/upload",{method:"POST",body:t,headers:{"Content-Type":"application/octet-stream"},duplex:"half"})).upload_url}))}}e.AssemblyAI=class{constructor(e){e.baseUrl=e.baseUrl||"https://api.assemblyai.com",e.baseUrl&&e.baseUrl.endsWith("/")&&(e.baseUrl=e.baseUrl.slice(0,-1)),this.files=new E(e),this.transcripts=new x(e,this.files),this.lemur=new s(e),this.realtime=new O(e)}},e.FileService=E,e.LemurService=s,e.RealtimeService=R,e.RealtimeServiceFactory=O,e.TranscriptService=x}));

package/dist/index.cjs

@@ -2,7 +2,6 @@
 
 var isomorphicStreams = require('@swimburger/isomorphic-streams');
 var WebSocket = require('isomorphic-ws');
-var fs = require('fs');
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -180,9 +179,9 @@ class RealtimeService {
         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;
-        if ("apiKey" in params)
+        if ("apiKey" in params && params.apiKey)
             this.apiKey = params.apiKey;
-        if ("token" in params)
+        if ("token" in params && params.token)
             this.token = params.token;
         if (!(this.apiKey || this.token)) {
             throw new Error("API key or temporary token is required.");
@@ -567,6 +566,15 @@ function getPath(path) {
     }
 }
 
+function throwError() {
+  throw new Error("'fs' is not supported in this environment.");
+}
+
+const createReadStream = throwError;
+var fs = {
+  createReadStream,
+};
+
 class FileService extends BaseService {
     /**
      * Upload a local file to AssemblyAI.

package/dist/index.mjs

@@ -1,6 +1,5 @@
 import { WritableStream } from '@swimburger/isomorphic-streams';
 import WebSocket from 'isomorphic-ws';
-import fs from 'fs';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -178,9 +177,9 @@ class RealtimeService {
         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;
-        if ("apiKey" in params)
+        if ("apiKey" in params && params.apiKey)
             this.apiKey = params.apiKey;
-        if ("token" in params)
+        if ("token" in params && params.token)
             this.token = params.token;
         if (!(this.apiKey || this.token)) {
             throw new Error("API key or temporary token is required.");
@@ -565,6 +564,15 @@ function getPath(path) {
     }
 }
 
+function throwError() {
+  throw new Error("'fs' is not supported in this environment.");
+}
+
+const createReadStream = throwError;
+var fs = {
+  createReadStream,
+};
+
 class FileService extends BaseService {
     /**
      * Upload a local file to AssemblyAI.

package/dist/index.node.cjs

@@ -0,0 +1,618 @@
+'use strict';
+
+var isomorphicStreams = require('@swimburger/isomorphic-streams');
+var WebSocket = require('isomorphic-ws');
+var fs = require('fs');
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+
+
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+/**
+ * Base class for services that communicate with the API.
+ */
+class BaseService {
+    /**
+     * Create a new service.
+     * @param params The parameters to use for the service.
+     */
+    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 this.fetchJson("/lemur/v3/generate/summary", {
+            method: "POST",
+            body: JSON.stringify(params),
+        });
+    }
+    questionAnswer(params) {
+        return this.fetchJson("/lemur/v3/generate/question-answer", {
+            method: "POST",
+            body: JSON.stringify(params),
+        });
+    }
+    actionItems(params) {
+        return this.fetchJson("/lemur/v3/generate/action-items", {
+            method: "POST",
+            body: JSON.stringify(params),
+        });
+    }
+    task(params) {
+        return this.fetchJson("/lemur/v3/generate/task", {
+            method: "POST",
+            body: JSON.stringify(params),
+        });
+    }
+    /**
+     * Delete the data for a previously submitted LeMUR request.
+     * @param id ID of the LeMUR request
+     */
+    purgeRequestData(id) {
+        return this.fetchJson(`/lemur/v3/${id}`, {
+            method: "DELETE",
+        });
+    }
+}
+
+var RealtimeErrorType;
+(function (RealtimeErrorType) {
+    RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
+    RealtimeErrorType[RealtimeErrorType["AuthFailed"] = 4001] = "AuthFailed";
+    // Both InsufficientFunds and FreeAccount error use 4002
+    RealtimeErrorType[RealtimeErrorType["InsufficientFundsOrFreeAccount"] = 4002] = "InsufficientFundsOrFreeAccount";
+    RealtimeErrorType[RealtimeErrorType["NonexistentSessionId"] = 4004] = "NonexistentSessionId";
+    RealtimeErrorType[RealtimeErrorType["SessionExpired"] = 4008] = "SessionExpired";
+    RealtimeErrorType[RealtimeErrorType["ClosedSession"] = 4010] = "ClosedSession";
+    RealtimeErrorType[RealtimeErrorType["RateLimited"] = 4029] = "RateLimited";
+    RealtimeErrorType[RealtimeErrorType["UniqueSessionViolation"] = 4030] = "UniqueSessionViolation";
+    RealtimeErrorType[RealtimeErrorType["SessionTimeout"] = 4031] = "SessionTimeout";
+    RealtimeErrorType[RealtimeErrorType["AudioTooShort"] = 4032] = "AudioTooShort";
+    RealtimeErrorType[RealtimeErrorType["AudioTooLong"] = 4033] = "AudioTooLong";
+    RealtimeErrorType[RealtimeErrorType["BadJson"] = 4100] = "BadJson";
+    RealtimeErrorType[RealtimeErrorType["BadSchema"] = 4101] = "BadSchema";
+    RealtimeErrorType[RealtimeErrorType["TooManyStreams"] = 4102] = "TooManyStreams";
+    RealtimeErrorType[RealtimeErrorType["Reconnected"] = 4103] = "Reconnected";
+    RealtimeErrorType[RealtimeErrorType["ReconnectAttemptsExhausted"] = 1013] = "ReconnectAttemptsExhausted";
+})(RealtimeErrorType || (RealtimeErrorType = {}));
+const RealtimeErrorMessages = {
+    [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 {
+}
+
+const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
+class RealtimeService {
+    constructor(params) {
+        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;
+        if ("apiKey" in params && params.apiKey)
+            this.apiKey = params.apiKey;
+        if ("token" in params && params.token)
+            this.token = params.token;
+        if (!(this.apiKey || this.token)) {
+            throw new Error("API key or temporary token is required.");
+        }
+    }
+    connectionUrl() {
+        const url = new URL(this.realtimeUrl);
+        if (url.protocol !== "wss:") {
+            throw new Error("Invalid protocol, must be wss");
+        }
+        const searchParams = new URLSearchParams();
+        if (this.token) {
+            searchParams.set("token", this.token);
+        }
+        searchParams.set("sample_rate", this.sampleRate.toString());
+        if (this.wordBoost && this.wordBoost.length > 0) {
+            searchParams.set("word_boost", JSON.stringify(this.wordBoost));
+        }
+        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();
+            if (this.token) {
+                this.socket = new WebSocket(url.toString());
+            }
+            else {
+                this.socket = new WebSocket(url.toString(), {
+                    headers: { Authorization: this.apiKey },
+                });
+            }
+            this.socket.onclose = ({ code, reason }) => {
+                var _a, _b;
+                if (!reason) {
+                    if (code in RealtimeErrorType) {
+                        reason = RealtimeErrorMessages[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, _h, _j, _k, _l, _m, _o;
+                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 RealtimeError(message.error));
+                    return;
+                }
+                switch (message.message_type) {
+                    case "SessionBegins": {
+                        const openObject = {
+                            sessionId: message.session_id,
+                            expiresAt: new Date(message.expires_at),
+                        };
+                        resolve(openObject);
+                        (_d = (_c = this.listeners).open) === null || _d === void 0 ? void 0 : _d.call(_c, openObject);
+                        break;
+                    }
+                    case "PartialTranscript": {
+                        // message.created is actually a string when coming from the socket
+                        message.created = new Date(message.created);
+                        (_f = (_e = this.listeners).transcript) === null || _f === void 0 ? void 0 : _f.call(_e, message);
+                        (_h = (_g = this.listeners)["transcript.partial"]) === null || _h === void 0 ? void 0 : _h.call(_g, message);
+                        break;
+                    }
+                    case "FinalTranscript": {
+                        // message.created is actually a string when coming from the socket
+                        message.created = new Date(message.created);
+                        (_k = (_j = this.listeners).transcript) === null || _k === void 0 ? void 0 : _k.call(_j, message);
+                        (_m = (_l = this.listeners)["transcript.final"]) === null || _m === void 0 ? void 0 : _m.call(_l, message);
+                        break;
+                    }
+                    case "SessionTerminated": {
+                        (_o = this.sessionTerminatedResolve) === null || _o === void 0 ? void 0 : _o.call(this);
+                        break;
+                    }
+                }
+            };
+        });
+    }
+    sendAudio(audio) {
+        if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
+            throw new Error("Socket is not open for communication");
+        }
+        let audioData;
+        if (typeof Buffer !== "undefined") {
+            audioData = Buffer.from(audio).toString("base64");
+        }
+        else {
+            // Buffer is not available in the browser by default
+            // https://stackoverflow.com/a/42334410/2919731
+            audioData = btoa(new Uint8Array(audio).reduce((data, byte) => data + String.fromCharCode(byte), ""));
+        }
+        const payload = {
+            audio_data: audioData,
+        };
+        this.socket.send(JSON.stringify(payload));
+    }
+    stream() {
+        return new isomorphicStreams.WritableStream({
+            write: (chunk) => {
+                this.sendAudio(chunk);
+            },
+        });
+    }
+    close(waitForSessionTermination = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.socket) {
+                if (this.socket.readyState === WebSocket.OPEN) {
+                    const terminateSessionMessage = `{"terminate_session": true}`;
+                    if (waitForSessionTermination) {
+                        const sessionTerminatedPromise = new Promise((resolve) => {
+                            this.sessionTerminatedResolve = resolve;
+                        });
+                        this.socket.send(terminateSessionMessage);
+                        yield sessionTerminatedPromise;
+                    }
+                    else {
+                        this.socket.send(terminateSessionMessage);
+                    }
+                }
+                if ("removeAllListeners" in this.socket)
+                    this.socket.removeAllListeners();
+                this.socket.close();
+            }
+            this.listeners = {};
+            this.socket = undefined;
+        });
+    }
+}
+
+class RealtimeServiceFactory extends BaseService {
+    constructor(params) {
+        super(params);
+        this.rtFactoryParams = params;
+    }
+    createService(params) {
+        if (!params)
+            params = { apiKey: this.rtFactoryParams.apiKey };
+        else if (!("token" in params) && !params.apiKey) {
+            params.apiKey = this.rtFactoryParams.apiKey;
+        }
+        return new RealtimeService(params);
+    }
+    createTemporaryToken(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.fetchJson("/v2/realtime/token", {
+                method: "POST",
+                body: JSON.stringify(params),
+            });
+            return data.token;
+        });
+    }
+}
+
+class TranscriptService extends BaseService {
+    constructor(params, files) {
+        super(params);
+        this.files = files;
+    }
+    /**
+     * 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.
+     * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
+     */
+    transcribe(params, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const transcript = yield this.submit(params);
+            return yield this.waitUntilReady(transcript.id, options);
+        });
+    }
+    /**
+     * 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.
+     * @returns A promise that resolves to the queued transcript.
+     */
+    submit(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { audio } = params, createParams = __rest(params, ["audio"]);
+            let audioUrl;
+            if (typeof audio === "string") {
+                const path = getPath(audio);
+                if (path !== null) {
+                    // audio is local path, upload local file
+                    audioUrl = yield this.files.upload(path);
+                }
+                else {
+                    // audio is not a local path, assume it's a URL
+                    audioUrl = audio;
+                }
+            }
+            else {
+                // audio is of uploadable type
+                audioUrl = yield this.files.upload(audio);
+            }
+            const data = yield this.fetchJson("/v2/transcript", {
+                method: "POST",
+                body: JSON.stringify(Object.assign(Object.assign({}, createParams), { audio_url: audioUrl })),
+            });
+            return data;
+        });
+    }
+    /**
+     * Create a 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.
+     */
+    create(params, options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const path = getPath(params.audio_url);
+            if (path !== null) {
+                const uploadUrl = yield this.files.upload(path);
+                params.audio_url = uploadUrl;
+            }
+            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.waitUntilReady(data.id, options);
+            }
+            return data;
+        });
+    }
+    /**
+     * 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.
+     * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
+     */
+    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) {
+                const transcript = yield this.get(transcriptId);
+                if (transcript.status === "completed" || transcript.status === "error") {
+                    return transcript;
+                }
+                else if (pollingTimeout > 0 &&
+                    Date.now() - startTime > pollingTimeout) {
+                    throw new Error("Polling timeout");
+                }
+                else {
+                    yield new Promise((resolve) => setTimeout(resolve, pollingInterval));
+                }
+            }
+        });
+    }
+    /**
+     * Retrieve a transcript.
+     * @param id The identifier of the transcript.
+     * @returns A promise that resolves to the transcript.
+     */
+    get(id) {
+        return this.fetchJson(`/v2/transcript/${id}`);
+    }
+    /**
+     * 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.
+     */
+    list(parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = "/v2/transcript";
+            if (typeof parameters === "string") {
+                url = parameters;
+            }
+            else if (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.fetchJson(url);
+            for (const transcriptListItem of data.transcripts) {
+                transcriptListItem.created = new Date(transcriptListItem.created);
+                if (transcriptListItem.completed) {
+                    transcriptListItem.completed = new Date(transcriptListItem.completed);
+                }
+            }
+            return data;
+        });
+    }
+    /**
+     * Delete a transcript
+     * @param id The identifier of the transcript.
+     * @returns A promise that resolves to the transcript.
+     */
+    delete(id) {
+        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 words Keywords to search for.
+     * @return A promise that resolves to the sentences.
+     */
+    wordSearch(id, words) {
+        const params = new URLSearchParams({ words: words.join(",") });
+        return this.fetchJson(`/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.
+     */
+    sentences(id) {
+        return this.fetchJson(`/v2/transcript/${id}/sentences`);
+    }
+    /**
+     * Retrieve all paragraphs of a transcript.
+     * @param id The identifier of the transcript.
+     * @return A promise that resolves to the paragraphs.
+     */
+    paragraphs(id) {
+        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", chars_per_caption) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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();
+        });
+    }
+    /**
+     * Retrieve redactions of a transcript.
+     * @param id The identifier of the transcript.
+     * @return A promise that resolves to the subtitles text.
+     */
+    redactions(id) {
+        return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
+    }
+}
+function getPath(path) {
+    let url;
+    try {
+        url = new URL(path);
+        if (url.protocol === "file:")
+            return url.pathname;
+        else
+            return null;
+    }
+    catch (_a) {
+        return path;
+    }
+}
+
+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.
+     */
+    upload(input) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let fileData;
+            if (typeof input === "string")
+                fileData = fs.createReadStream(input);
+            else
+                fileData = input;
+            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 || 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);
+    }
+}
+
+exports.AssemblyAI = AssemblyAI;
+exports.FileService = FileService;
+exports.LemurService = LemurService;
+exports.RealtimeService = RealtimeService;
+exports.RealtimeServiceFactory = RealtimeServiceFactory;
+exports.TranscriptService = TranscriptService;

package/dist/{index.browser.js → index.node.mjs}

@@ -1,3 +1,7 @@
+import { WritableStream } from '@swimburger/isomorphic-streams';
+import WebSocket from 'isomorphic-ws';
+import fs from 'fs';
+
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -125,66 +129,6 @@ class LemurService extends BaseService {
     }
 }
 
-const {
-  ReadableStream,
-  ReadableStreamDefaultReader,
-  ReadableStreamBYOBReader,
-  ReadableStreamBYOBRequest,
-  ReadableByteStreamController,
-  ReadableStreamDefaultController,
-  TransformStream,
-  TransformStreamDefaultController,
-  WritableStream,
-  WritableStreamDefaultWriter,
-  WritableStreamDefaultController,
-  ByteLengthQueuingStrategy,
-  CountQueuingStrategy,
-  TextEncoderStream,
-  TextDecoderStream,
-} = window;
-
-// Polyfill to make ReadableStream async-iterable with for-await
-// https://jakearchibald.com/2017/async-iterators-and-generators/#making-streams-iterate
-if (!ReadableStream.prototype[Symbol.asyncIterator]) {
-  async function* streamAsyncIterator() {
-    // Get a lock on the stream
-    const reader = this.getReader();
-
-    try {
-      while (true) {
-        // Read from the stream
-        const { done, value } = await reader.read();
-        // Exit if we're done
-        if (done) return;
-        // Else yield the chunk
-        yield value;
-      }
-    } finally {
-      reader.releaseLock();
-    }
-  }
-
-  ReadableStream.prototype[Symbol.asyncIterator] = streamAsyncIterator;
-}
-
-// https://github.com/maxogden/websocket-stream/blob/48dc3ddf943e5ada668c31ccd94e9186f02fafbd/ws-fallback.js
-
-var ws = null;
-
-if (typeof WebSocket !== 'undefined') {
-  ws = WebSocket;
-} else if (typeof MozWebSocket !== 'undefined') {
-  ws = MozWebSocket;
-} else if (typeof global !== 'undefined') {
-  ws = global.WebSocket || global.MozWebSocket;
-} else if (typeof window !== 'undefined') {
-  ws = window.WebSocket || window.MozWebSocket;
-} else if (typeof self !== 'undefined') {
-  ws = self.WebSocket || self.MozWebSocket;
-}
-
-var WebSocket$1 = ws;
-
 var RealtimeErrorType;
 (function (RealtimeErrorType) {
     RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
@@ -234,9 +178,9 @@ class RealtimeService {
         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;
-        if ("apiKey" in params)
+        if ("apiKey" in params && params.apiKey)
             this.apiKey = params.apiKey;
-        if ("token" in params)
+        if ("token" in params && params.token)
             this.token = params.token;
         if (!(this.apiKey || this.token)) {
             throw new Error("API key or temporary token is required.");
@@ -269,10 +213,10 @@ class RealtimeService {
             }
             const url = this.connectionUrl();
             if (this.token) {
-                this.socket = new WebSocket$1(url.toString());
+                this.socket = new WebSocket(url.toString());
             }
             else {
-                this.socket = new WebSocket$1(url.toString(), {
+                this.socket = new WebSocket(url.toString(), {
                     headers: { Authorization: this.apiKey },
                 });
             }
@@ -332,7 +276,7 @@ class RealtimeService {
         });
     }
     sendAudio(audio) {
-        if (!this.socket || this.socket.readyState !== WebSocket$1.OPEN) {
+        if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
             throw new Error("Socket is not open for communication");
         }
         let audioData;
@@ -359,7 +303,7 @@ class RealtimeService {
     close(waitForSessionTermination = true) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.socket) {
-                if (this.socket.readyState === WebSocket$1.OPEN) {
+                if (this.socket.readyState === WebSocket.OPEN) {
                     const terminateSessionMessage = `{"terminate_session": true}`;
                     if (waitForSessionTermination) {
                         const sessionTerminatedPromise = new Promise((resolve) => {
@@ -621,15 +565,6 @@ function getPath(path) {
     }
 }
 
-function throwError() {
-  throw new Error("Function is not supported in this environment.");
-}
-
-const createReadStream = throwError;
-var fs = {
-  createReadStream,
-};
-
 class FileService extends BaseService {
     /**
      * Upload a local file to AssemblyAI.

package/docs/compat.md

@@ -0,0 +1,59 @@
+# SDK Compatibility
+
+The JavaScript SDK is developed for Node.js but is also compatible with other runtimes
+such as the browser, Deno, Bun, Cloudflare Workers, etc.
+
+## Browser compatibility
+
+To make the SDK compatible with the browser, the SDK aims to use web standards as much as possible.
+However, there are still incompatibilities between Node.js and the browser.
+
+- `RealtimeService` doesn't support the AssemblyAI API key in the browser.
+  Instead, you have to generate a temporary auth token using `client.realtime.createTemporaryToken`, and pass in the resulting token to the real-time transcriber.
+
+  Generate a temporary auth token on the server.
+
+  ```js
+  import { AssemblyAI } from "assemblyai"
+  // Ideally, to avoid embedding your API key client side,
+  // you generate this token on the server, and pass it to the client via an API.
+  const client = new AssemblyAI({ apiKey: "YOUR_API_KEY" });
+  const token = await client.realtime.createTemporaryToken({ expires_in = 480 });
+  ```
+
+  > [!NOTE]
+  > We recommend generating the token on the server, so you don't embed your AssemblyAI API key in your client app.
+  > If you embed the API key on the client, everyone can see it and use it for themselves.
+
+  Then pass the token via an API to the client.
+  On the client, create an instance of `RealtimeService` using the token.
+
+  ```js
+  import { RealtimeService } from "assemblyai";
+  // or the following if you're using UMD
+  // const { RealtimeService } = assemblyai;
+
+  const token = getToken(); // getToken is a function for you to implement
+
+  const rt = new RealtimeService({
+    token: token,
+  });
+  ```
+
+- You can't pass local audio file paths to `client.files.upload`, `client.transcripts.transcribe`, and `client.transcripts.submit`. If you do, you'll get the following error: "'fs' is not supported in this environment.".
+  If you want to transcribe audio files, you must use a public URL, a stream, or a buffer.
+
+> [!WARNING]
+> The SDK is usable from the browser, but we strongly recommend you don't embed the AssemblyAI API key into your client apps.
+> If you embed the API key on the client, everyone can see it and use it for themselves.
+> Instead, create use the SDK on the server and provide APIs for your client to call.
+
+## Deno, Bun, Cloudflare Workers, etc.
+
+Most server-side JavaScript runtimes include a compatibility layer with Node.js.
+Our SDK is developed for Node.js, which makes it compatible with other runtimes through their compatibility layer.
+The bugs in these compatibility layers may introduce issues in our SDK.
+
+## Report issues
+
+If you find any (undocumented) bugs when using the SDK, [submit a GitHub issue](https://github.com/AssemblyAI/assemblyai-node-sdk). We'll try to fix it or at least document the compatibility issue.

package/package.json

@@ -1,22 +1,39 @@
 {
   "name": "assemblyai",
-  "version": "4.0.0-beta.0",
+  "version": "4.0.0-beta.1",
   "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.",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
+      "node": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.node.mjs",
+        "require": "./dist/index.node.cjs"
+      },
+      "bun": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.node.mjs",
+        "require": "./dist/index.node.cjs"
+      },
+      "deno": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.node.mjs",
+        "require": "./dist/index.node.cjs"
+      },
+      "workerd": "./dist/index.mjs",
+      "browser": "./dist/index.mjs",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs",
-      "browser": "./dist/index.browser.js",
       "default": "./dist/index.cjs"
     },
     "./package.json": "./package.json"
   },
   "type": "commonjs",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "typings": "dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "require": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "typings": "./dist/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AssemblyAI/assemblyai-node-sdk.git"
@@ -30,8 +47,7 @@
     "build": "pnpm clean && pnpm rollup -c",
     "clean": "rimraf dist",
     "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}' && publint",
-    "test": "pnpm lint && pnpm test:unit",
-    "test:unit": "jest --config jest.config.rollup.ts",
+    "test": "jest --config jest.config.rollup.ts",
     "format": "prettier '**/*' --write",
     "generate-types": "tsx ./scripts/generate-types.ts && pnpm format",
     "copybara:dry-run": "./copybara.sh dry_run --init-history",
@@ -49,7 +65,11 @@
   "homepage": "https://www.assemblyai.com/docs",
   "files": [
     "dist",
-    "src"
+    "src",
+    "package.json",
+    "README.md",
+    "CHANGELOG.md",
+    "docs"
   ],
   "devDependencies": {
     "@rollup/plugin-alias": "^5.0.1",
@@ -83,7 +103,7 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@swimburger/isomorphic-streams": "^1.0.5",
+    "@swimburger/isomorphic-streams": "^1.1.1",
     "isomorphic-ws": "^5.0.0",
     "ws": "^8.13.0"
   }

package/src/{browser/fs.ts → polyfills/no-fs.ts}

@@ -1,5 +1,5 @@
 function throwError() {
-  throw new Error("Function is not supported in this environment.");
+  throw new Error("'fs' is not supported in this environment.");
 }
 
 export const createReadStream = throwError;

package/src/services/realtime/service.ts

@@ -33,8 +33,8 @@ export class RealtimeService {
     this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
     this.sampleRate = params.sampleRate ?? 16_000;
     this.wordBoost = params.wordBoost;
-    if ("apiKey" in params) this.apiKey = params.apiKey;
-    if ("token" in params) this.token = params.token;
+    if ("apiKey" in params && params.apiKey) this.apiKey = params.apiKey;
+    if ("token" in params && params.token) this.token = params.token;
 
     if (!(this.apiKey || this.token)) {
       throw new Error("API key or temporary token is required.");