@nuancelabs/js-sdk 0.8.0 → 0.10.0

package/index.d.ts

@@ -344,6 +344,12 @@ export declare interface CreateNuanceConversationOptions {
      * ```
      */
     personality?: PersonalityChoice;
+    /**
+     * The longest the conversation may run, in seconds. The server holds it to
+     * the account's maximum, so a longer value runs for that maximum; left out,
+     * the conversation runs for the maximum.
+     */
+    maxSessionSeconds?: number;
     /**
      * Capture constraints for the user's camera.
      *
@@ -370,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

package/index.js

@@ -4,7 +4,7 @@ function isRecord(value) {
 }
 
 // src/core/sdk-version.ts
-var SDK_HEADER = `js/${"0.8.0"}`;
+var SDK_HEADER = `js/${"0.10.0"}`;
 
 // 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() {
@@ -2211,6 +2221,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";
 }
@@ -2236,6 +2249,7 @@ class NuanceConversation {
   sessionOverrides;
   personality;
   variant;
+  maxSessionSeconds;
   videoCapture;
   startOn;
   mediaDevices;
@@ -2273,6 +2287,7 @@ class NuanceConversation {
     this.sessionOverrides = options.sessionOverrides ?? {};
     this.personality = options.personality;
     this.variant = options.variant;
+    this.maxSessionSeconds = options.maxSessionSeconds;
     this.videoCapture = options.videoCapture;
     this.startOn = options.startOn ?? "first-frame";
     this.mediaDevices = options.mediaDevices;
@@ -2309,6 +2324,9 @@ class NuanceConversation {
           request.personality = this.personality;
         if (this.variant)
           request.variant = this.variant;
+        if (this.maxSessionSeconds !== undefined) {
+          request.max_session_seconds = this.maxSessionSeconds;
+        }
         conversation = await this.createWhenNotBusy(request, attempt);
       } catch (error) {
         if (error instanceof ApiError && error.status === 409) {
@@ -2320,6 +2338,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);
         }
@@ -2790,6 +2811,7 @@ export {
   MediaAccessError,
   MaintenanceError,
   LegalRequiredError,
+  GuestLimitError,
   ConversationState,
   ActiveSessionError
 };

package/package.json

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