phonic 0.14.0 → 0.16.0

package/README.md

@@ -65,7 +65,10 @@ if (error === null) {
 ### Get conversation by external id
 
 ```ts
-const { data, error } = await phonic.conversations.getByExternalId("CAdb9c032c809fec7feb932ea4c96d71e1");
+const { data, error } = await phonic.conversations.getByExternalId({
+  project: "main",
+  externalId: "CAdb9c032c809fec7feb932ea4c96d71e1"
+});
 
 if (error === null) {
   console.log(data.conversation);
@@ -76,6 +79,7 @@ if (error === null) {
 
 ```ts
 const { data, error } = await phonic.conversations.list({
+  project: "main",
   durationMin: 10, // sec
   durationMax: 20, // sec
   startedAtMin: "2025-04-17", // 00:00:00 UTC time is assumed
@@ -92,21 +96,16 @@ if (error === null) {
 To start a conversation, open a WebSocket connection:
 
 ```ts
-const { data, error } = await phonic.sts.websocket({
+const phonicWebSocket = phonic.sts.websocket({
   input_format: "mulaw_8000",
 
   // Optional fields
+  project: "main",
   system_prompt: "You are a helpful assistant.",
   welcome_message: "Hello, how can I help you?",
   voice_id: "meredith",
   output_format: "mulaw_8000"
 });
-
-if (error !== null) {
-  throw new Error(`Failed to start conversation: ${error.message}`);
-}
-
-const { phonicWebSocket } = data;
 ```
 
 Stream input (user) audio chunks:

package/dist/index.d.mts

@@ -63,8 +63,12 @@ declare class Conversations {
     private readonly phonic;
     constructor(phonic: Phonic);
     get(id: string): DataOrError<ConversationSuccessResponse>;
-    getByExternalId(externalId: string): DataOrError<ConversationSuccessResponse>;
-    list({ durationMin, durationMax, startedAtMin, startedAtMax, }: {
+    getByExternalId({ project, externalId, }: {
+        project?: string;
+        externalId: string;
+    }): DataOrError<ConversationSuccessResponse>;
+    list({ project, durationMin, durationMax, startedAtMin, startedAtMax, }: {
+        project?: string;
         durationMin?: number;
         durationMax?: number;
         startedAtMin?: ISODate | ISODateTime$1;
@@ -73,7 +77,7 @@ declare class Conversations {
 }
 
 type PhonicSTSConfig = {
-    project_id: string;
+    project: string;
     input_format: "pcm_44100" | "mulaw_8000";
     system_prompt?: string;
     welcome_message?: string;
@@ -92,6 +96,9 @@ type PhonicSTSWebSocketResponseMessage = {
 } | {
     type: "is_user_speaking";
     isUserSpeaking: boolean;
+} | {
+    type: "interrupted_response";
+    interruptedResponse: string;
 } | {
     type: "error";
     error: {
@@ -112,10 +119,13 @@ type OnErrorCallback = (event: WebSocket.ErrorEvent) => void;
 
 declare class PhonicSTSWebSocket {
     private readonly ws;
+    private readonly config;
     private onMessageCallback;
     private onCloseCallback;
     private onErrorCallback;
-    constructor(ws: WebSocket);
+    private buffer;
+    private isOpen;
+    constructor(ws: WebSocket, config: PhonicSTSConfig);
     onMessage(callback: OnMessageCallback): void;
     onClose(callback: OnCloseCallback): void;
     onError(callback: OnErrorCallback): void;
@@ -134,10 +144,7 @@ declare class PhonicSTSWebSocket {
 declare class SpeechToSpeech {
     private readonly phonic;
     constructor(phonic: Phonic);
-    private connectToPhonicAPI;
-    websocket(config: PhonicSTSConfig): DataOrError<{
-        phonicWebSocket: PhonicSTSWebSocket;
-    }>;
+    websocket(config: PhonicSTSConfig): PhonicSTSWebSocket;
 }
 
 type Voice = {

package/dist/index.d.ts

@@ -63,8 +63,12 @@ declare class Conversations {
     private readonly phonic;
     constructor(phonic: Phonic);
     get(id: string): DataOrError<ConversationSuccessResponse>;
-    getByExternalId(externalId: string): DataOrError<ConversationSuccessResponse>;
-    list({ durationMin, durationMax, startedAtMin, startedAtMax, }: {
+    getByExternalId({ project, externalId, }: {
+        project?: string;
+        externalId: string;
+    }): DataOrError<ConversationSuccessResponse>;
+    list({ project, durationMin, durationMax, startedAtMin, startedAtMax, }: {
+        project?: string;
         durationMin?: number;
         durationMax?: number;
         startedAtMin?: ISODate | ISODateTime$1;
@@ -73,7 +77,7 @@ declare class Conversations {
 }
 
 type PhonicSTSConfig = {
-    project_id: string;
+    project: string;
     input_format: "pcm_44100" | "mulaw_8000";
     system_prompt?: string;
     welcome_message?: string;
@@ -92,6 +96,9 @@ type PhonicSTSWebSocketResponseMessage = {
 } | {
     type: "is_user_speaking";
     isUserSpeaking: boolean;
+} | {
+    type: "interrupted_response";
+    interruptedResponse: string;
 } | {
     type: "error";
     error: {
@@ -112,10 +119,13 @@ type OnErrorCallback = (event: WebSocket.ErrorEvent) => void;
 
 declare class PhonicSTSWebSocket {
     private readonly ws;
+    private readonly config;
     private onMessageCallback;
     private onCloseCallback;
     private onErrorCallback;
-    constructor(ws: WebSocket);
+    private buffer;
+    private isOpen;
+    constructor(ws: WebSocket, config: PhonicSTSConfig);
     onMessage(callback: OnMessageCallback): void;
     onClose(callback: OnCloseCallback): void;
     onError(callback: OnErrorCallback): void;
@@ -134,10 +144,7 @@ declare class PhonicSTSWebSocket {
 declare class SpeechToSpeech {
     private readonly phonic;
     constructor(phonic: Phonic);
-    private connectToPhonicAPI;
-    websocket(config: PhonicSTSConfig): DataOrError<{
-        phonicWebSocket: PhonicSTSWebSocket;
-    }>;
+    websocket(config: PhonicSTSConfig): PhonicSTSWebSocket;
 }
 
 type Voice = {

package/dist/index.js

@@ -35,7 +35,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.14.0";
+var version = "0.16.0";
 
 // src/conversations/index.ts
 var Conversations = class {
@@ -48,8 +48,12 @@ var Conversations = class {
     );
     return response;
   }
-  async getByExternalId(externalId) {
+  async getByExternalId({
+    project,
+    externalId
+  }) {
     const queryString = new URLSearchParams({
+      ...project !== void 0 && { project },
       external_id: externalId
     }).toString();
     const response = await this.phonic.get(
@@ -58,12 +62,14 @@ var Conversations = class {
     return response;
   }
   async list({
+    project,
     durationMin,
     durationMax,
     startedAtMin,
     startedAtMax
   }) {
     const queryString = new URLSearchParams({
+      ...project !== void 0 && { project },
       ...durationMin !== void 0 && { duration_min: String(durationMin) },
       ...durationMax !== void 0 && { duration_max: String(durationMax) },
       ...startedAtMin !== void 0 && { started_at_min: startedAtMin },
@@ -81,8 +87,21 @@ var import_ws = __toESM(require("ws"));
 
 // src/sts/websocket.ts
 var PhonicSTSWebSocket = class {
-  constructor(ws) {
+  constructor(ws, config) {
     this.ws = ws;
+    this.config = config;
+    this.buffer.push(
+      JSON.stringify({
+        type: "config",
+        ...this.config
+      })
+    );
+    this.ws.onopen = () => {
+      for (const message of this.buffer) {
+        this.ws.send(message);
+      }
+      this.isOpen = true;
+    };
     this.ws.onmessage = (event) => {
       if (this.onMessageCallback === null) {
         return;
@@ -116,6 +135,8 @@ var PhonicSTSWebSocket = class {
   onMessageCallback = null;
   onCloseCallback = null;
   onErrorCallback = null;
+  buffer = [];
+  isOpen = false;
   onMessage(callback) {
     this.onMessageCallback = callback;
   }
@@ -126,28 +147,37 @@ var PhonicSTSWebSocket = class {
     this.onErrorCallback = callback;
   }
   audioChunk({ audio }) {
-    this.ws.send(
-      JSON.stringify({
-        type: "audio_chunk",
-        audio
-      })
-    );
+    const audiochunkMessage = JSON.stringify({
+      type: "audio_chunk",
+      audio
+    });
+    if (this.isOpen) {
+      this.ws.send(audiochunkMessage);
+    } else {
+      this.buffer.push(audiochunkMessage);
+    }
   }
   updateSystemPrompt({ systemPrompt }) {
-    this.ws.send(
-      JSON.stringify({
-        type: "update_system_prompt",
-        system_prompt: systemPrompt
-      })
-    );
+    const updateSystemPromptMessage = JSON.stringify({
+      type: "update_system_prompt",
+      system_prompt: systemPrompt
+    });
+    if (this.isOpen) {
+      this.ws.send(updateSystemPromptMessage);
+    } else {
+      this.buffer.push(updateSystemPromptMessage);
+    }
   }
   setExternalId({ externalId }) {
-    this.ws.send(
-      JSON.stringify({
-        type: "set_external_id",
-        external_id: externalId
-      })
-    );
+    const setExternalIdMessage = JSON.stringify({
+      type: "set_external_id",
+      external_id: externalId
+    });
+    if (this.isOpen) {
+      this.ws.send(setExternalIdMessage);
+    } else {
+      this.buffer.push(setExternalIdMessage);
+    }
   }
   close(code) {
     this.ws.close(code ?? 1e3);
@@ -155,64 +185,11 @@ var PhonicSTSWebSocket = class {
 };
 
 // src/sts/index.ts
-var phonicApiCloseCodes = {
-  insuffucientCapacityAvailable: 4004
-};
 var SpeechToSpeech = class {
   constructor(phonic) {
     this.phonic = phonic;
   }
-  async connectToPhonicAPI(phonicApiWsUrl, config) {
-    return new Promise((resolve) => {
-      const ws = new import_ws.default(phonicApiWsUrl, {
-        headers: this.phonic.headers
-      });
-      ws.onopen = () => {
-        ws.send(
-          JSON.stringify({
-            type: "config",
-            ...config
-          })
-        );
-      };
-      ws.onmessage = (event) => {
-        if (typeof event.data !== "string") {
-          throw new Error("Received non-string message");
-        }
-        const dataObj = JSON.parse(
-          event.data
-        );
-        if (dataObj.type === "ready_to_start_conversation") {
-          resolve({
-            data: {
-              phonicWebSocket: new PhonicSTSWebSocket(ws)
-            },
-            error: null
-          });
-        }
-      };
-      ws.onerror = (error) => {
-        resolve({
-          data: null,
-          error: {
-            message: error.message
-          }
-        });
-      };
-      ws.onclose = (event) => {
-        if (event.code === phonicApiCloseCodes.insuffucientCapacityAvailable) {
-          resolve({
-            data: null,
-            error: {
-              message: event.reason,
-              code: "insuffucient_capacity_available"
-            }
-          });
-        }
-      };
-    });
-  }
-  async websocket(config) {
+  websocket(config) {
     const wsBaseUrl = this.phonic.baseUrl.replace(/^http/, "ws");
     const queryString = new URLSearchParams({
       ...this.phonic.__downstreamWebSocketUrl !== null && {
@@ -220,31 +197,10 @@ var SpeechToSpeech = class {
       }
     }).toString();
     const phonicApiWsUrl = `${wsBaseUrl}/v1/sts/ws?${queryString}`;
-    let retryNumber = 0;
-    const maxRetries = 14;
-    const retryDelay = 15e3;
-    while (true) {
-      const connectResult = await this.connectToPhonicAPI(
-        phonicApiWsUrl,
-        config
-      );
-      if (connectResult.data !== null) {
-        return connectResult;
-      }
-      if (connectResult.error.code === "insuffucient_capacity_available") {
-        if (retryNumber >= maxRetries) {
-          return connectResult;
-        }
-        console.info(
-          `${connectResult.error.message}, will retry in ${retryDelay / 1e3}sec`
-        );
-        await new Promise((resolve) => setTimeout(resolve, retryDelay));
-        retryNumber += 1;
-        console.info(`Retrying... ${retryNumber}/${maxRetries}`);
-        continue;
-      }
-      return connectResult;
-    }
+    const ws = new import_ws.default(phonicApiWsUrl, {
+      headers: this.phonic.headers
+    });
+    return new PhonicSTSWebSocket(ws, config);
   }
 };
 
@@ -304,18 +260,27 @@ var Phonic = class {
         headers: this.headers,
         ...options
       });
-      if (!response.ok) {
-        const statusText = await response.text();
-        console.error(response);
+      if (response.ok) {
+        const data = await response.json();
+        return { data, error: null };
+      }
+      try {
+        const data = await response.json();
+        const errorMessage = data.error.message || response.statusText;
+        return {
+          data: null,
+          error: {
+            message: errorMessage
+          }
+        };
+      } catch (error) {
         return {
           data: null,
           error: {
-            message: statusText
+            message: response.statusText
           }
         };
       }
-      const data = await response.json();
-      return { data, error: null };
     } catch (error) {
       console.error(error);
       return {

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // package.json
-var version = "0.14.0";
+var version = "0.16.0";
 
 // src/conversations/index.ts
 var Conversations = class {
@@ -12,8 +12,12 @@ var Conversations = class {
     );
     return response;
   }
-  async getByExternalId(externalId) {
+  async getByExternalId({
+    project,
+    externalId
+  }) {
     const queryString = new URLSearchParams({
+      ...project !== void 0 && { project },
       external_id: externalId
     }).toString();
     const response = await this.phonic.get(
@@ -22,12 +26,14 @@ var Conversations = class {
     return response;
   }
   async list({
+    project,
     durationMin,
     durationMax,
     startedAtMin,
     startedAtMax
   }) {
     const queryString = new URLSearchParams({
+      ...project !== void 0 && { project },
       ...durationMin !== void 0 && { duration_min: String(durationMin) },
       ...durationMax !== void 0 && { duration_max: String(durationMax) },
       ...startedAtMin !== void 0 && { started_at_min: startedAtMin },
@@ -45,8 +51,21 @@ import WebSocket from "ws";
 
 // src/sts/websocket.ts
 var PhonicSTSWebSocket = class {
-  constructor(ws) {
+  constructor(ws, config) {
     this.ws = ws;
+    this.config = config;
+    this.buffer.push(
+      JSON.stringify({
+        type: "config",
+        ...this.config
+      })
+    );
+    this.ws.onopen = () => {
+      for (const message of this.buffer) {
+        this.ws.send(message);
+      }
+      this.isOpen = true;
+    };
     this.ws.onmessage = (event) => {
       if (this.onMessageCallback === null) {
         return;
@@ -80,6 +99,8 @@ var PhonicSTSWebSocket = class {
   onMessageCallback = null;
   onCloseCallback = null;
   onErrorCallback = null;
+  buffer = [];
+  isOpen = false;
   onMessage(callback) {
     this.onMessageCallback = callback;
   }
@@ -90,28 +111,37 @@ var PhonicSTSWebSocket = class {
     this.onErrorCallback = callback;
   }
   audioChunk({ audio }) {
-    this.ws.send(
-      JSON.stringify({
-        type: "audio_chunk",
-        audio
-      })
-    );
+    const audiochunkMessage = JSON.stringify({
+      type: "audio_chunk",
+      audio
+    });
+    if (this.isOpen) {
+      this.ws.send(audiochunkMessage);
+    } else {
+      this.buffer.push(audiochunkMessage);
+    }
   }
   updateSystemPrompt({ systemPrompt }) {
-    this.ws.send(
-      JSON.stringify({
-        type: "update_system_prompt",
-        system_prompt: systemPrompt
-      })
-    );
+    const updateSystemPromptMessage = JSON.stringify({
+      type: "update_system_prompt",
+      system_prompt: systemPrompt
+    });
+    if (this.isOpen) {
+      this.ws.send(updateSystemPromptMessage);
+    } else {
+      this.buffer.push(updateSystemPromptMessage);
+    }
   }
   setExternalId({ externalId }) {
-    this.ws.send(
-      JSON.stringify({
-        type: "set_external_id",
-        external_id: externalId
-      })
-    );
+    const setExternalIdMessage = JSON.stringify({
+      type: "set_external_id",
+      external_id: externalId
+    });
+    if (this.isOpen) {
+      this.ws.send(setExternalIdMessage);
+    } else {
+      this.buffer.push(setExternalIdMessage);
+    }
   }
   close(code) {
     this.ws.close(code ?? 1e3);
@@ -119,64 +149,11 @@ var PhonicSTSWebSocket = class {
 };
 
 // src/sts/index.ts
-var phonicApiCloseCodes = {
-  insuffucientCapacityAvailable: 4004
-};
 var SpeechToSpeech = class {
   constructor(phonic) {
     this.phonic = phonic;
   }
-  async connectToPhonicAPI(phonicApiWsUrl, config) {
-    return new Promise((resolve) => {
-      const ws = new WebSocket(phonicApiWsUrl, {
-        headers: this.phonic.headers
-      });
-      ws.onopen = () => {
-        ws.send(
-          JSON.stringify({
-            type: "config",
-            ...config
-          })
-        );
-      };
-      ws.onmessage = (event) => {
-        if (typeof event.data !== "string") {
-          throw new Error("Received non-string message");
-        }
-        const dataObj = JSON.parse(
-          event.data
-        );
-        if (dataObj.type === "ready_to_start_conversation") {
-          resolve({
-            data: {
-              phonicWebSocket: new PhonicSTSWebSocket(ws)
-            },
-            error: null
-          });
-        }
-      };
-      ws.onerror = (error) => {
-        resolve({
-          data: null,
-          error: {
-            message: error.message
-          }
-        });
-      };
-      ws.onclose = (event) => {
-        if (event.code === phonicApiCloseCodes.insuffucientCapacityAvailable) {
-          resolve({
-            data: null,
-            error: {
-              message: event.reason,
-              code: "insuffucient_capacity_available"
-            }
-          });
-        }
-      };
-    });
-  }
-  async websocket(config) {
+  websocket(config) {
     const wsBaseUrl = this.phonic.baseUrl.replace(/^http/, "ws");
     const queryString = new URLSearchParams({
       ...this.phonic.__downstreamWebSocketUrl !== null && {
@@ -184,31 +161,10 @@ var SpeechToSpeech = class {
       }
     }).toString();
     const phonicApiWsUrl = `${wsBaseUrl}/v1/sts/ws?${queryString}`;
-    let retryNumber = 0;
-    const maxRetries = 14;
-    const retryDelay = 15e3;
-    while (true) {
-      const connectResult = await this.connectToPhonicAPI(
-        phonicApiWsUrl,
-        config
-      );
-      if (connectResult.data !== null) {
-        return connectResult;
-      }
-      if (connectResult.error.code === "insuffucient_capacity_available") {
-        if (retryNumber >= maxRetries) {
-          return connectResult;
-        }
-        console.info(
-          `${connectResult.error.message}, will retry in ${retryDelay / 1e3}sec`
-        );
-        await new Promise((resolve) => setTimeout(resolve, retryDelay));
-        retryNumber += 1;
-        console.info(`Retrying... ${retryNumber}/${maxRetries}`);
-        continue;
-      }
-      return connectResult;
-    }
+    const ws = new WebSocket(phonicApiWsUrl, {
+      headers: this.phonic.headers
+    });
+    return new PhonicSTSWebSocket(ws, config);
   }
 };
 
@@ -268,18 +224,27 @@ var Phonic = class {
         headers: this.headers,
         ...options
       });
-      if (!response.ok) {
-        const statusText = await response.text();
-        console.error(response);
+      if (response.ok) {
+        const data = await response.json();
+        return { data, error: null };
+      }
+      try {
+        const data = await response.json();
+        const errorMessage = data.error.message || response.statusText;
+        return {
+          data: null,
+          error: {
+            message: errorMessage
+          }
+        };
+      } catch (error) {
         return {
           data: null,
           error: {
-            message: statusText
+            message: response.statusText
           }
         };
       }
-      const data = await response.json();
-      return { data, error: null };
     } catch (error) {
       console.error(error);
       return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phonic",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Phonic Node.js SDK",
   "scripts": {
     "build": "tsup",
@@ -41,7 +41,7 @@
     "@changesets/cli": "2.28.1",
     "@types/bun": "1.2.8",
     "tsup": "8.4.0",
-    "typescript": "5.8.2",
+    "typescript": "5.8.3",
     "zod": "3.24.2"
   },
   "files": ["dist/**"],