@nuancelabs/js-sdk 0.9.0 → 0.10.1

package/index.d.ts

@@ -376,6 +376,18 @@ export declare interface CreateNuanceConversationOptions {
 }
 
 
+/**
+ * Raised by {@link Conversation.connect} when the server refuses a guest's new
+ * session because a guest limit is used up. `reason` says which: `used` (this
+ * guest has had its conversations), `device` (so has this browser) or `network`
+ * (so has this network today). The message is the server's, written for the
+ * person.
+ */
+export declare class GuestLimitError extends Error {
+    readonly reason: string;
+    constructor(reason: string, message: string);
+}
+
 /**
  * Raised by {@link Conversation.connect} when the server refuses a new session
  * because the account has not completed onboarding or accepted the current
@@ -500,6 +512,10 @@ export declare interface SessionTokenResponse {
 /** When the avatar starts speaking: see {@link CreateNuanceConversationOptions.startOn}. */
 export declare type StartOn = "first-frame" | "full-quality";
 
+
+
+
+
 /**
  * The local user participant in a conversation.
  */

package/index.js

@@ -4,7 +4,7 @@ function isRecord(value) {
 }
 
 // src/core/sdk-version.ts
-var SDK_HEADER = `js/${"0.9.0"}`;
+var SDK_HEADER = `js/${"0.10.1"}`;
 
 // src/utils.ts
 function normalizeHost(host) {
@@ -108,6 +108,16 @@ class ActiveSessionError extends Error {
   }
 }
 
+// src/core/guest-limit-error.ts
+class GuestLimitError extends Error {
+  reason;
+  constructor(reason, message) {
+    super(message);
+    this.name = "GuestLimitError";
+    this.reason = reason;
+  }
+}
+
 // src/core/legal-required-error.ts
 class LegalRequiredError extends Error {
   constructor() {
@@ -1088,6 +1098,17 @@ function parseSessionEvent(payload) {
   if (decoded.type === "floor") {
     return { type: "floor", speaking: decoded.state === "speaking" };
   }
+  if (decoded.type === "tool.call" && typeof decoded.call_id === "string" && typeof decoded.name === "string" && isRecord(decoded.arguments)) {
+    return {
+      type: "tool-call",
+      call: {
+        callId: decoded.call_id,
+        name: decoded.name,
+        label: typeof decoded.label === "string" ? decoded.label : "",
+        arguments: decoded.arguments
+      }
+    };
+  }
   if (decoded.type === "session.status" && decoded.status === "ended") {
     return {
       type: "ended",
@@ -1534,6 +1555,7 @@ class LiveKitUserParticipant {
 // src/providers/livekit/conversation.ts
 var DATA_EVENT_TOPIC = "nuance.data";
 var SESSION_TOPIC = "nuance.v1";
+var PACKET_MAX_BYTES = 14000;
 var RUNTIME_TOPIC = "runtime";
 var CLOCK_SYNC_TOPIC = "clock-sync";
 var STATS_FLUSH_TIMEOUT_MS = 300;
@@ -1541,6 +1563,7 @@ var SESSION_END_TIMEOUT_MS = 300;
 var SESSION_END_ID = "client-session-end";
 var REFUSAL_REASON_WAIT_MS = 500;
 var COMMAND_TIMEOUT_MS = 5000;
+var STREAM_TIMEOUT_MS = 30000;
 var BACKGROUND_ID = /^[a-z0-9][a-z0-9_-]{0,63}$/;
 var AVATAR_RETURN_TIMEOUT_MS = 8000;
 function isReconnecting(lkState) {
@@ -1754,9 +1777,24 @@ class LiveKitConversation {
   async releaseAgent() {
     return this.command({ type: "floor.release" });
   }
+  async sendToolResult(callId, output, options = {}) {
+    return this.command({
+      type: "tool.result",
+      call_id: callId,
+      output,
+      ...options.images?.length && {
+        images: options.images.map(({ mediaType, data }) => ({
+          media_type: mediaType,
+          data
+        }))
+      },
+      is_error: options.isError ?? false,
+      final: options.final ?? true
+    });
+  }
   onChange(handler) {
     return this.onEvent((event) => {
-      if (event.type !== "data-event" && event.type !== "screen-share-changed")
+      if (event.type !== "data-event" && event.type !== "screen-share-changed" && event.type !== "tool-call")
         handler(event);
     });
   }
@@ -1773,6 +1811,12 @@ class LiveKitConversation {
       }
     });
   }
+  onToolCall(handler) {
+    return this.onEvent((event) => {
+      if (event.type === "tool-call")
+        handler(event.call);
+    });
+  }
   async command(command) {
     if (this.room.state !== ConnectionState2.Connected) {
       throw new Error("Not connected — call connect() first");
@@ -1784,11 +1828,18 @@ class LiveKitConversation {
     const answer = Promise.withResolvers();
     this.commands.set(id, { type: command.type, settle: answer.resolve });
     let timer;
+    const text = JSON.stringify({ ...command, id });
+    const payload = new TextEncoder().encode(text);
+    const streamed = payload.byteLength > PACKET_MAX_BYTES;
+    const sent = streamed ? this.room.localParticipant.sendText(text, { topic: SESSION_TOPIC }) : this.room.localParticipant.publishData(payload, {
+      reliable: true,
+      topic: SESSION_TOPIC
+    });
     try {
       return await Promise.race([
-        this.room.localParticipant.publishData(new TextEncoder().encode(JSON.stringify({ ...command, id })), { reliable: true, topic: SESSION_TOPIC }).then(() => answer.promise),
+        sent.then(() => answer.promise),
         new Promise((_, reject) => {
-          timer = setTimeout(() => reject(new Error(`The runtime did not answer ${command.type}`)), COMMAND_TIMEOUT_MS);
+          timer = setTimeout(() => reject(new Error(`The runtime did not answer ${command.type}`)), streamed ? STREAM_TIMEOUT_MS : COMMAND_TIMEOUT_MS);
         })
       ]);
     } finally {
@@ -1996,6 +2047,8 @@ class LiveKitConversation {
       }
     } else if (event.type === "floor") {
       this.setAvatarSpeaking(event.speaking);
+    } else if (event.type === "tool-call") {
+      this.emit({ type: "tool-call", call: event.call });
     } else if (event.type === "ended") {
       this.answered?.();
       if (!event.byClient)
@@ -2211,6 +2264,9 @@ function isMaintenanceBody(body) {
 function isBusyBody(body) {
   return isRecord(body) && body.code === "busy";
 }
+function isGuestLimitBody(body) {
+  return isRecord(body) && body.code === "guest_limit";
+}
 function isCurfewBody(body) {
   return isRecord(body) && body.code === "policy_curfew";
 }
@@ -2325,6 +2381,9 @@ class NuanceConversation {
         if (error instanceof ApiError && error.status === 503 && isMaintenanceBody(error.body)) {
           throw new MaintenanceError(typeof error.body.detail === "string" ? error.body.detail : "The service is under maintenance");
         }
+        if (error instanceof ApiError && error.status === 429 && isGuestLimitBody(error.body)) {
+          throw new GuestLimitError(typeof error.body.reason === "string" ? error.body.reason : "used", typeof error.body.detail === "string" ? error.body.detail : "You've had your free conversation");
+        }
         if (error instanceof ApiError && error.status === 403 && isCurfewBody(error.body)) {
           throw new PolicyCurfewError(typeof error.body.retry_after_seconds === "number" ? error.body.retry_after_seconds : null);
         }
@@ -2430,9 +2489,15 @@ class NuanceConversation {
     }
     return this.delegate.releaseAgent();
   }
+  async sendToolResult(callId, output, options) {
+    if (!this.delegate) {
+      throw new Error("Not connected — call connect() first");
+    }
+    return this.delegate.sendToolResult(callId, output, options);
+  }
   onChange(handler) {
     return this.onEvent((event) => {
-      if (event.type !== "data-event" && event.type !== "screen-share-changed")
+      if (event.type !== "data-event" && event.type !== "screen-share-changed" && event.type !== "tool-call")
         handler(event);
     });
   }
@@ -2449,6 +2514,12 @@ class NuanceConversation {
       }
     });
   }
+  onToolCall(handler) {
+    return this.onEvent((event) => {
+      if (event.type === "tool-call")
+        handler(event.call);
+    });
+  }
   async waitForSlot(conversationId, attempt) {
     const admission = await this.followEvents(conversationId, attempt);
     if (admission !== null) {
@@ -2795,6 +2866,7 @@ export {
   MediaAccessError,
   MaintenanceError,
   LegalRequiredError,
+  GuestLimitError,
   ConversationState,
   ActiveSessionError
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuancelabs/js-sdk",
-  "version": "0.9.0",
+  "version": "0.10.1",
   "description": "JavaScript SDK for Nuance Labs conversation video AI avatar",
   "license": "UNLICENSED",
   "repository": {