assemblyai 4.4.0 → 4.5.0-beta.0

package/dist/deno.mjs

@@ -1,4 +1,4 @@
-import WebSocket from '#ws';
+import ws from 'ws';
 
 /**
  * Base class for services that communicate with the API.
@@ -88,6 +88,8 @@ const { WritableStream } = typeof window !== "undefined"
         ? global
         : globalThis;
 
+const factory = (url, params) => new ws(url, params);
+
 var RealtimeErrorType;
 (function (RealtimeErrorType) {
     RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
@@ -140,7 +142,6 @@ class RealtimeTranscriber {
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
         this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
-        this.enableExtraSessionInformation = params.enableExtraSessionInformation;
         this.disablePartialTranscripts = params.disablePartialTranscripts;
         if ("token" in params && params.token)
             this.token = params.token;
@@ -166,9 +167,7 @@ class RealtimeTranscriber {
         if (this.encoding) {
             searchParams.set("encoding", this.encoding);
         }
-        if (this.enableExtraSessionInformation) {
-            searchParams.set("enable_extra_session_information", this.enableExtraSessionInformation.toString());
-        }
+        searchParams.set("enable_extra_session_information", "true");
         if (this.disablePartialTranscripts) {
             searchParams.set("disable_partial_transcripts", this.disablePartialTranscripts.toString());
         }
@@ -186,10 +185,10 @@ class RealtimeTranscriber {
             }
             const url = this.connectionUrl();
             if (this.token) {
-                this.socket = new WebSocket(url.toString());
+                this.socket = factory(url.toString());
             }
             else {
-                this.socket = new WebSocket(url.toString(), {
+                this.socket = factory(url.toString(), {
                     headers: { Authorization: this.apiKey },
                 });
             }
@@ -282,14 +281,14 @@ class RealtimeTranscriber {
         this.send(`{"end_utterance_silence_threshold":${threshold}}`);
     }
     send(data) {
-        if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
+        if (!this.socket || this.socket.readyState !== this.socket.OPEN) {
             throw new Error("Socket is not open for communication");
         }
         this.socket.send(data);
     }
     async close(waitForSessionTermination = true) {
         if (this.socket) {
-            if (this.socket.readyState === WebSocket.OPEN) {
+            if (this.socket.readyState === this.socket.OPEN) {
                 if (waitForSessionTermination) {
                     const sessionTerminatedPromise = new Promise((resolve) => {
                         this.sessionTerminatedResolve = resolve;
@@ -301,7 +300,7 @@ class RealtimeTranscriber {
                     this.socket.send(terminateSessionMessage);
                 }
             }
-            if ("removeAllListeners" in this.socket)
+            if (this.socket?.removeAllListeners)
                 this.socket.removeAllListeners();
             this.socket.close();
         }

package/dist/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var WebSocket = require('#ws');
+var ws = require('ws');
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -135,6 +135,8 @@ const { WritableStream } = typeof window !== "undefined"
         ? global
         : globalThis;
 
+const factory = (url, params) => new ws(url, params);
+
 var RealtimeErrorType;
 (function (RealtimeErrorType) {
     RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
@@ -188,7 +190,6 @@ class RealtimeTranscriber {
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
         this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
-        this.enableExtraSessionInformation = params.enableExtraSessionInformation;
         this.disablePartialTranscripts = params.disablePartialTranscripts;
         if ("token" in params && params.token)
             this.token = params.token;
@@ -214,9 +215,7 @@ class RealtimeTranscriber {
         if (this.encoding) {
             searchParams.set("encoding", this.encoding);
         }
-        if (this.enableExtraSessionInformation) {
-            searchParams.set("enable_extra_session_information", this.enableExtraSessionInformation.toString());
-        }
+        searchParams.set("enable_extra_session_information", "true");
         if (this.disablePartialTranscripts) {
             searchParams.set("disable_partial_transcripts", this.disablePartialTranscripts.toString());
         }
@@ -234,10 +233,10 @@ class RealtimeTranscriber {
             }
             const url = this.connectionUrl();
             if (this.token) {
-                this.socket = new WebSocket(url.toString());
+                this.socket = factory(url.toString());
             }
             else {
-                this.socket = new WebSocket(url.toString(), {
+                this.socket = factory(url.toString(), {
                     headers: { Authorization: this.apiKey },
                 });
             }
@@ -333,15 +332,16 @@ class RealtimeTranscriber {
         this.send(`{"end_utterance_silence_threshold":${threshold}}`);
     }
     send(data) {
-        if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
+        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 === WebSocket.OPEN) {
+                if (this.socket.readyState === this.socket.OPEN) {
                     if (waitForSessionTermination) {
                         const sessionTerminatedPromise = new Promise((resolve) => {
                             this.sessionTerminatedResolve = resolve;
@@ -353,7 +353,7 @@ class RealtimeTranscriber {
                         this.socket.send(terminateSessionMessage);
                     }
                 }
-                if ("removeAllListeners" in this.socket)
+                if ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.removeAllListeners)
                     this.socket.removeAllListeners();
                 this.socket.close();
             }

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import WebSocket from '#ws';
+import ws from 'ws';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -133,6 +133,8 @@ const { WritableStream } = typeof window !== "undefined"
         ? global
         : globalThis;
 
+const factory = (url, params) => new ws(url, params);
+
 var RealtimeErrorType;
 (function (RealtimeErrorType) {
     RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
@@ -186,7 +188,6 @@ class RealtimeTranscriber {
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
         this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
-        this.enableExtraSessionInformation = params.enableExtraSessionInformation;
         this.disablePartialTranscripts = params.disablePartialTranscripts;
         if ("token" in params && params.token)
             this.token = params.token;
@@ -212,9 +213,7 @@ class RealtimeTranscriber {
         if (this.encoding) {
             searchParams.set("encoding", this.encoding);
         }
-        if (this.enableExtraSessionInformation) {
-            searchParams.set("enable_extra_session_information", this.enableExtraSessionInformation.toString());
-        }
+        searchParams.set("enable_extra_session_information", "true");
         if (this.disablePartialTranscripts) {
             searchParams.set("disable_partial_transcripts", this.disablePartialTranscripts.toString());
         }
@@ -232,10 +231,10 @@ class RealtimeTranscriber {
             }
             const url = this.connectionUrl();
             if (this.token) {
-                this.socket = new WebSocket(url.toString());
+                this.socket = factory(url.toString());
             }
             else {
-                this.socket = new WebSocket(url.toString(), {
+                this.socket = factory(url.toString(), {
                     headers: { Authorization: this.apiKey },
                 });
             }
@@ -331,15 +330,16 @@ class RealtimeTranscriber {
         this.send(`{"end_utterance_silence_threshold":${threshold}}`);
     }
     send(data) {
-        if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
+        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 === WebSocket.OPEN) {
+                if (this.socket.readyState === this.socket.OPEN) {
                     if (waitForSessionTermination) {
                         const sessionTerminatedPromise = new Promise((resolve) => {
                             this.sessionTerminatedResolve = resolve;
@@ -351,7 +351,7 @@ class RealtimeTranscriber {
                         this.socket.send(terminateSessionMessage);
                     }
                 }
-                if ("removeAllListeners" in this.socket)
+                if ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.removeAllListeners)
                     this.socket.removeAllListeners();
                 this.socket.close();
             }

package/dist/node.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
 var web = require('stream/web');
-var WebSocket = require('#ws');
+var ws = require('ws');
 var fs = require('fs');
 var stream = require('stream');
 
@@ -87,6 +87,8 @@ class LemurService extends BaseService {
     }
 }
 
+const factory = (url, params) => new ws(url, params);
+
 var RealtimeErrorType;
 (function (RealtimeErrorType) {
     RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
@@ -139,7 +141,6 @@ class RealtimeTranscriber {
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
         this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
-        this.enableExtraSessionInformation = params.enableExtraSessionInformation;
         this.disablePartialTranscripts = params.disablePartialTranscripts;
         if ("token" in params && params.token)
             this.token = params.token;
@@ -165,9 +166,7 @@ class RealtimeTranscriber {
         if (this.encoding) {
             searchParams.set("encoding", this.encoding);
         }
-        if (this.enableExtraSessionInformation) {
-            searchParams.set("enable_extra_session_information", this.enableExtraSessionInformation.toString());
-        }
+        searchParams.set("enable_extra_session_information", "true");
         if (this.disablePartialTranscripts) {
             searchParams.set("disable_partial_transcripts", this.disablePartialTranscripts.toString());
         }
@@ -185,10 +184,10 @@ class RealtimeTranscriber {
             }
             const url = this.connectionUrl();
             if (this.token) {
-                this.socket = new WebSocket(url.toString());
+                this.socket = factory(url.toString());
             }
             else {
-                this.socket = new WebSocket(url.toString(), {
+                this.socket = factory(url.toString(), {
                     headers: { Authorization: this.apiKey },
                 });
             }
@@ -281,14 +280,14 @@ class RealtimeTranscriber {
         this.send(`{"end_utterance_silence_threshold":${threshold}}`);
     }
     send(data) {
-        if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
+        if (!this.socket || this.socket.readyState !== this.socket.OPEN) {
             throw new Error("Socket is not open for communication");
         }
         this.socket.send(data);
     }
     async close(waitForSessionTermination = true) {
         if (this.socket) {
-            if (this.socket.readyState === WebSocket.OPEN) {
+            if (this.socket.readyState === this.socket.OPEN) {
                 if (waitForSessionTermination) {
                     const sessionTerminatedPromise = new Promise((resolve) => {
                         this.sessionTerminatedResolve = resolve;
@@ -300,7 +299,7 @@ class RealtimeTranscriber {
                     this.socket.send(terminateSessionMessage);
                 }
             }
-            if ("removeAllListeners" in this.socket)
+            if (this.socket?.removeAllListeners)
                 this.socket.removeAllListeners();
             this.socket.close();
         }

package/dist/node.mjs

@@ -1,5 +1,5 @@
 import { WritableStream } from 'stream/web';
-import WebSocket from '#ws';
+import ws from 'ws';
 import { createReadStream } from 'fs';
 import { Readable } from 'stream';
 
@@ -85,6 +85,8 @@ class LemurService extends BaseService {
     }
 }
 
+const factory = (url, params) => new ws(url, params);
+
 var RealtimeErrorType;
 (function (RealtimeErrorType) {
     RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
@@ -137,7 +139,6 @@ class RealtimeTranscriber {
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
         this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
-        this.enableExtraSessionInformation = params.enableExtraSessionInformation;
         this.disablePartialTranscripts = params.disablePartialTranscripts;
         if ("token" in params && params.token)
             this.token = params.token;
@@ -163,9 +164,7 @@ class RealtimeTranscriber {
         if (this.encoding) {
             searchParams.set("encoding", this.encoding);
         }
-        if (this.enableExtraSessionInformation) {
-            searchParams.set("enable_extra_session_information", this.enableExtraSessionInformation.toString());
-        }
+        searchParams.set("enable_extra_session_information", "true");
         if (this.disablePartialTranscripts) {
             searchParams.set("disable_partial_transcripts", this.disablePartialTranscripts.toString());
         }
@@ -183,10 +182,10 @@ class RealtimeTranscriber {
             }
             const url = this.connectionUrl();
             if (this.token) {
-                this.socket = new WebSocket(url.toString());
+                this.socket = factory(url.toString());
             }
             else {
-                this.socket = new WebSocket(url.toString(), {
+                this.socket = factory(url.toString(), {
                     headers: { Authorization: this.apiKey },
                 });
             }
@@ -279,14 +278,14 @@ class RealtimeTranscriber {
         this.send(`{"end_utterance_silence_threshold":${threshold}}`);
     }
     send(data) {
-        if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
+        if (!this.socket || this.socket.readyState !== this.socket.OPEN) {
             throw new Error("Socket is not open for communication");
         }
         this.socket.send(data);
     }
     async close(waitForSessionTermination = true) {
         if (this.socket) {
-            if (this.socket.readyState === WebSocket.OPEN) {
+            if (this.socket.readyState === this.socket.OPEN) {
                 if (waitForSessionTermination) {
                     const sessionTerminatedPromise = new Promise((resolve) => {
                         this.sessionTerminatedResolve = resolve;
@@ -298,7 +297,7 @@ class RealtimeTranscriber {
                     this.socket.send(terminateSessionMessage);
                 }
             }
-            if ("removeAllListeners" in this.socket)
+            if (this.socket?.removeAllListeners)
                 this.socket.removeAllListeners();
             this.socket.close();
         }

package/dist/polyfills/websocket/browser.d.ts

@@ -0,0 +1,3 @@
+import { PolyfillWebSocketFactory } from ".";
+export { PolyfillWebSocket } from ".";
+export declare const factory: PolyfillWebSocketFactory;

package/dist/polyfills/websocket/default.d.ts

@@ -0,0 +1,3 @@
+import { PolyfillWebSocketFactory } from ".";
+export { PolyfillWebSocket } from ".";
+export declare const factory: PolyfillWebSocketFactory;

package/dist/polyfills/websocket/index.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="node" />
+import ws, { Event, ErrorEvent, CloseEvent, MessageEvent } from "ws";
+export type PolyfillWebSocket = {
+    OPEN: typeof ws.OPEN;
+    binaryType: string;
+    onopen: ((event: Event) => void) | null;
+    onerror: ((event: ErrorEvent) => void) | null;
+    onclose: ((event: CloseEvent) => void) | null;
+    onmessage: ((event: MessageEvent) => void) | null;
+    readonly readyState: typeof ws.CONNECTING | typeof ws.OPEN | typeof ws.CLOSING | typeof ws.CLOSED;
+    removeAllListeners?: () => void;
+    send(data: string | number | Buffer | DataView | ArrayBufferView | Uint8Array | ArrayBuffer | SharedArrayBuffer | readonly unknown[] | readonly number[] | {
+        valueOf(): ArrayBuffer;
+    } | {
+        valueOf(): SharedArrayBuffer;
+    } | {
+        valueOf(): Uint8Array;
+    } | {
+        valueOf(): readonly number[];
+    } | {
+        valueOf(): string;
+    } | {
+        [Symbol.toPrimitive](hint: string): string;
+    }): unknown;
+    close(): unknown;
+};
+export type PolyfillWebSocketFactory = (url: string, params?: unknown) => PolyfillWebSocket;

package/dist/services/realtime/service.d.ts

@@ -7,7 +7,6 @@ export declare class RealtimeTranscriber {
     private apiKey?;
     private token?;
     private endUtteranceSilenceThreshold?;
-    private enableExtraSessionInformation?;
     private disablePartialTranscripts?;
     private socket?;
     private listeners;

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

@@ -29,7 +29,8 @@ type CreateRealtimeTranscriberParams = {
     /**
      * Enable extra session information.
      * Set to `true` to receive the `session_information` message before the session ends. Defaults to `false`.
-     * @defaultValue false
+     * @defaultValue true
+     * @deprecated This parameter is now ignored and will be removed. Session information will always be sent.
      */
     enableExtraSessionInformation?: boolean;
 } & ({
@@ -78,7 +79,8 @@ type RealtimeTranscriberParams = {
     /**
      * Enable extra session information.
      * Set to `true` to receive the `session_information` message before the session ends. Defaults to `false`.
-     * @defaultValue false
+     * @defaultValue true
+     * @deprecated This parameter is now ignored and will be removed. Session information will always be sent.
      */
     enableExtraSessionInformation?: boolean;
 } & ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.4.0",
+  "version": "4.5.0-beta.0",
   "description": "The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "engines": {
     "node": ">=18"
@@ -17,7 +17,7 @@
         "default": "./dist/deno.mjs"
       },
       "workerd": "./dist/index.mjs",
-      "browser": "./dist/index.mjs",
+      "browser": "./dist/browser.mjs",
       "node": {
         "types": "./dist/index.d.ts",
         "import": "./dist/node.mjs",
@@ -40,14 +40,10 @@
       "node": "./src/polyfills/streams/node.ts",
       "default": "./src/polyfills/streams/index.ts"
     },
-    "#ws": {
-      "types": "./src/polyfills/ws/index.d.ts",
-      "browser": "./src/polyfills/ws/browser.mjs",
-      "default": {
-        "types": "./src/polyfills/ws/index.d.ts",
-        "import": "./src/polyfills/ws/index.mjs",
-        "require": "./src/polyfills/ws/index.cjs"
-      }
+    "#websocket": {
+      "browser": "./src/polyfills/websocket/browser.ts",
+      "node": "./src/polyfills/websocket/default.ts",
+      "default": "./src/polyfills/websocket/default.ts"
     }
   },
   "type": "commonjs",
@@ -61,7 +57,7 @@
     "url": "git+https://github.com/AssemblyAI/assemblyai-node-sdk.git"
   },
   "publishConfig": {
-    "tag": "latest",
+    "tag": "beta",
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
@@ -70,7 +66,7 @@
     "clean": "rimraf dist/* && rimraf temp/* && rimraf temp-docs/*",
     "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}' && publint && tsc --noEmit -p tsconfig.json",
     "test": "pnpm run test:unit && pnpm run test:integration",
-    "test:unit": "jest --config jest.unit.config.js",
+    "test:unit": "jest --config jest.unit.config.js --testTimeout 1000",
     "test:integration": "jest --config jest.integration.config.js --testTimeout 360000",
     "format": "prettier '**/*' --write",
     "generate:types": "tsx ./scripts/generate-types.ts && prettier 'src/types/*.generated.ts' --write",

package/src/polyfills/websocket/browser.ts

@@ -0,0 +1,18 @@
+import { PolyfillWebSocketFactory, PolyfillWebSocket } from ".";
+export { PolyfillWebSocket } from ".";
+
+const PolyfillWebSocket =
+  WebSocket ?? global?.WebSocket ?? window?.WebSocket ?? self?.WebSocket;
+
+export const factory: PolyfillWebSocketFactory = (
+  url: string,
+  params?: unknown,
+) => {
+  if (params) {
+    return new PolyfillWebSocket(
+      url,
+      params as string | string[],
+    ) as unknown as PolyfillWebSocket;
+  }
+  return new PolyfillWebSocket(url) as unknown as PolyfillWebSocket;
+};

package/src/polyfills/websocket/default.ts

@@ -0,0 +1,8 @@
+import ws from "ws";
+import { PolyfillWebSocket, PolyfillWebSocketFactory } from ".";
+export { PolyfillWebSocket } from ".";
+
+export const factory: PolyfillWebSocketFactory = (
+  url: string,
+  params?: unknown,
+) => new ws(url, params as ws.ClientOptions) as unknown as PolyfillWebSocket;

package/src/polyfills/websocket/index.ts

@@ -0,0 +1,41 @@
+import ws, { Event, ErrorEvent, CloseEvent, MessageEvent } from "ws";
+
+export type PolyfillWebSocket = {
+  OPEN: typeof ws.OPEN;
+  binaryType: string;
+  onopen: ((event: Event) => void) | null;
+  onerror: ((event: ErrorEvent) => void) | null;
+  onclose: ((event: CloseEvent) => void) | null;
+  onmessage: ((event: MessageEvent) => void) | null;
+  readonly readyState:
+    | typeof ws.CONNECTING
+    | typeof ws.OPEN
+    | typeof ws.CLOSING
+    | typeof ws.CLOSED;
+  removeAllListeners?: () => void;
+  send(
+    data:
+      | string
+      | number
+      | Buffer
+      | DataView
+      | ArrayBufferView
+      | Uint8Array
+      | ArrayBuffer
+      | SharedArrayBuffer
+      | readonly unknown[]
+      | readonly number[]
+      | { valueOf(): ArrayBuffer }
+      | { valueOf(): SharedArrayBuffer }
+      | { valueOf(): Uint8Array }
+      | { valueOf(): readonly number[] }
+      | { valueOf(): string }
+      | { [Symbol.toPrimitive](hint: string): string },
+  ): unknown;
+  close(): unknown;
+};
+
+export type PolyfillWebSocketFactory = (
+  url: string,
+  params?: unknown,
+) => PolyfillWebSocket;