Merge pull request #91 from AssemblyAI/DAF0BAB42D2DA65E0EFFC2912E49A516

Sync from internal repo (2025-06-05)

Author: marcusolsson

README.md

@@ -1,6 +1,6 @@
 <img src="https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/assemblyai.png?raw=true" width="500"/>
 
----
+______________________________________________________________________
 
 [![npm](https://img.shields.io/npm/v/assemblyai)](https://www.npmjs.com/package/assemblyai)
 [![Test](https://github.com/AssemblyAI/assemblyai-node-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/AssemblyAI/assemblyai-node-sdk/actions/workflows/test.yml)
@@ -13,7 +13,7 @@
 # AssemblyAI JavaScript SDK
 
 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.
+which supports async and streaming transcription, as well as the latest LeMUR models.
 It is written primarily for Node.js in TypeScript with all types exported, but also [compatible with other runtimes](./docs/compat.md).
 
 ## Documentation
@@ -73,11 +73,11 @@ You can use automatic CDNs like [UNPKG](https://unpkg.com/) to load the library
 ```
 
 The script creates a global `assemblyai` variable containing all the services.
-Here's how you create a `RealtimeTranscriber` object.
+Here's how you create a `StreamingTranscriber` object.
 
 ```js
-const { RealtimeTranscriber } = assemblyai;
-const transcriber = new RealtimeTranscriber({
+const { StreamingTranscriber } = assemblyai;
+const transcriber = new StreamingTranscriber({
   token: "[GENERATE TEMPORARY AUTH TOKEN IN YOUR API]",
   ...
 });
@@ -101,7 +101,7 @@ let transcript = await client.transcripts.transcribe({
 });
 ```
 
-> **Note**
+> [!NOTE]
 > You can also pass a local file path, a stream, or a buffer as the `audio` property.
 
 `transcribe` queues a transcription job and polls it until the `status` is `completed` or `error`.
@@ -242,20 +242,18 @@ const res = await client.transcripts.delete(transcript.id);
 
 ### Transcribe in real-time
 
-Create the real-time transcriber.
+Create the streaming transcriber.
 
 ```typescript
-const rt = client.realtime.transcriber();
+const rt = client.streaming.transcriber();
 ```
 
 You can also pass in the following options.
 
 ```typescript
-const rt = client.realtime.transcriber({
-  realtimeUrl: 'wss://localhost/override',
+const rt = client.streaming.transcriber({
   apiKey: process.env.ASSEMBLYAI_API_KEY // The API key passed to `AssemblyAI` will be used by default,
   sampleRate: 16_000,
-  wordBoost: ['foo', 'bar']
 });
 ```
 
@@ -265,30 +263,29 @@ const rt = client.realtime.transcriber({
 > _Server code_:
 >
 > ```typescript
-> const token = await client.realtime.createTemporaryToken({ expires_in = 60 });
+> const token = await client.streaming.createTemporaryToken({ expires_in_seconds = 60 });
 > // TODO: return token to client
 > ```
 >
 > _Client code_:
 >
 > ```typescript
-> import { RealtimeTranscriber } from "assemblyai"; // or "assemblyai/streaming"
+> import { StreamingTranscriber } from "assemblyai";
 > // TODO: implement getToken to retrieve token from server
 > const token = await getToken();
-> const rt = new RealtimeTranscriber({
+> const rt = new StreamingTranscriber({
 >   token,
 > });
 > ```
 
 You can configure the following events.
 
 <!-- prettier-ignore -->
+
 ```typescript
-rt.on("open", ({ sessionId, expiresAt }) => console.log('Session ID:', sessionId, 'Expires at:', expiresAt));
+rt.on("open", ({ id, expires_at }) => console.log('Session ID:', id, 'Expires at:', expires_at));
 rt.on("close", (code: number, reason: string) => console.log('Closed', code, reason));
-rt.on("transcript", (transcript: TranscriptMessage) => console.log('Transcript:', transcript));
-rt.on("transcript.partial", (transcript: PartialTranscriptMessage) => console.log('Partial transcript:', transcript));
-rt.on("transcript.final", (transcript: FinalTranscriptMessage) => console.log('Final transcript:', transcript));
+rt.on("turn", ({ transcript }) => console.log('Transcript:', transcript));
 rt.on("error", (error: Error) => console.error('Error', error));
 ```
 
@@ -307,7 +304,7 @@ getAudio((chunk) => {
 });
 ```
 
-Or send audio data via a stream by piping to the real-time stream.
+Or send audio data via a stream:
 
 ```typescript
 audioStream.pipeTo(rt.stream());

package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.13.1",
+  "version": "4.13.2",
   "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"

src/services/streaming/service.ts

@@ -4,6 +4,7 @@ import {
   factory as polyfillWebSocketFactory,
 } from "#websocket";
 import { ErrorEvent, MessageEvent, CloseEvent } from "ws";
+import { conditions } from "#conditions";
 import {
   StreamingEvents,
   StreamingListeners,
@@ -69,6 +70,10 @@ export class StreamingTranscriber {
 
     const searchParams = new URLSearchParams();
 
+    if (this.token) {
+      searchParams.set("token", this.token);
+    }
+
     searchParams.set("sample_rate", this.params.sampleRate.toString());
 
     if (this.params.endOfTurnConfidenceThreshold) {
@@ -118,9 +123,20 @@ export class StreamingTranscriber {
 
       const url = this.connectionUrl();
 
-      this.socket = polyfillWebSocketFactory(url.toString(), {
-        headers: { Authorization: this.token || this.apiKey },
-      });
+      if (this.token) {
+        this.socket = polyfillWebSocketFactory(url.toString());
+      } else {
+        if (conditions.browser) {
+          console.warn(
+            `API key authentication is not supported for the StreamingTranscriber in browser environment. Use temporary token authentication instead.
+Learn more at https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/docs/compat.md#browser-compatibility.`,
+          );
+        }
+
+        this.socket = polyfillWebSocketFactory(url.toString(), {
+          headers: { Authorization: this.apiKey },
+        });
+      }
 
       this.socket.binaryType = "arraybuffer";