assemblyai 4.0.0 → 4.1.0

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

@@ -1,8 +1,9 @@
-import { FinalTranscript, PartialTranscript, RealtimeTranscript, RealtimeTranscriptType } from "../asyncapi.generated";
+import { AudioEncoding, FinalTranscript, PartialTranscript, RealtimeTranscript, RealtimeTranscriptType } from "../asyncapi.generated";
 type CreateRealtimeServiceParams = {
     realtimeUrl?: string;
     sampleRate?: number;
     wordBoost?: string[];
+    encoding?: AudioEncoding;
 } & ({
     apiKey?: string;
 } | {
@@ -12,6 +13,7 @@ type RealtimeServiceParams = {
     realtimeUrl?: string;
     sampleRate?: number;
     wordBoost?: string[];
+    encoding?: AudioEncoding;
 } & ({
     apiKey: string;
 } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.0.0",
+  "version": "4.1.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"

package/src/services/realtime/factory.ts

@@ -16,12 +16,12 @@ export class RealtimeServiceFactory extends BaseService {
   }
 
   createService(params?: CreateRealtimeServiceParams): RealtimeService {
-    if (!params) params = { apiKey: this.rtFactoryParams.apiKey };
-    else if (!("token" in params) && !params.apiKey) {
-      params.apiKey = this.rtFactoryParams.apiKey;
+    const serviceParams = { ...params } as Record<string, unknown>;
+    if (!serviceParams.token && !serviceParams.apiKey) {
+      serviceParams.apiKey = this.rtFactoryParams.apiKey;
     }
 
-    return new RealtimeService(params as RealtimeServiceParams);
+    return new RealtimeService(serviceParams as RealtimeServiceParams);
   }
 
   async createTemporaryToken(params: RealtimeTokenParams) {

package/src/services/realtime/service.ts

@@ -10,6 +10,7 @@ import {
   PartialTranscript,
   FinalTranscript,
   SessionBeginsEventData,
+  AudioEncoding,
 } from "../..";
 import {
   RealtimeError,
@@ -23,6 +24,7 @@ export class RealtimeService {
   private realtimeUrl: string;
   private sampleRate: number;
   private wordBoost?: string[];
+  private encoding?: AudioEncoding;
   private apiKey?: string;
   private token?: string;
   private socket?: WebSocket;
@@ -33,10 +35,11 @@ export class RealtimeService {
     this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
     this.sampleRate = params.sampleRate ?? 16_000;
     this.wordBoost = params.wordBoost;
-    if ("apiKey" in params && params.apiKey) this.apiKey = params.apiKey;
+    this.encoding = params.encoding;
     if ("token" in params && params.token) this.token = params.token;
+    if ("apiKey" in params && params.apiKey) this.apiKey = params.apiKey;
 
-    if (!(this.apiKey || this.token)) {
+    if (!(this.token || this.apiKey)) {
       throw new Error("API key or temporary token is required.");
     }
   }
@@ -56,6 +59,9 @@ export class RealtimeService {
     if (this.wordBoost && this.wordBoost.length > 0) {
       searchParams.set("word_boost", JSON.stringify(this.wordBoost));
     }
+    if (this.encoding) {
+      searchParams.set("encoding", this.encoding);
+    }
     url.search = searchParams.toString();
 
     return url;

package/src/types/asyncapi.generated.ts

@@ -2,6 +2,8 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import { LiteralUnion } from "./helpers";
+
 /** OneOf type helpers */
 type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
 type XOR<T, U> = T | U extends object
@@ -18,6 +20,13 @@ export type AudioData = {
   audio_data: string;
 };
 
+/**
+ * @description The encoding of the audio data
+ * @default pcm_s16le
+ * @enum {string}
+ */
+export type AudioEncoding = "pcm_s16le" | "pcm_mulaw";
+
 export type FinalTranscript = RealtimeBaseTranscript & {
   /**
    * @description Describes the type of message
@@ -95,7 +104,10 @@ export type SessionBegins = RealtimeBaseMessage & {
    * @constant
    */
   message_type: "SessionBegins";
-  /** @description Unique identifier for the established session */
+  /**
+   * Format: uuid
+   * @description Unique identifier for the established session
+   */
   session_id: string;
 };
 

package/src/types/helpers/index.ts

@@ -0,0 +1,4 @@
+// source: https://github.com/sindresorhus/type-fest/blob/main/source/literal-union.d.ts
+export type LiteralUnion<LiteralType, BaseType> =
+  | LiteralType
+  | (BaseType & Record<never, never>);