@exotel-npm-dev/exotel-ai-assist 1.2.5 → 1.2.6

package/README.md

@@ -123,11 +123,12 @@ function MyCustomUI({ call_sid }: { call_sid: string }) {
 
   if (streamState === "throttled") return <p>AI Assist is at capacity — available on your next call.</p>;
   if (streamState === "disconnected") return <p>AI Assist disconnected.</p>;
+  if (streamState === "connection_timeout") return <p>Connection timed out.</p>;
 
   return (
     <div>
       {suggestions.map((s) => (
-        <p key={s.id}>{s.text}</p>
+        <p key={s.id}>{s.value}</p>
       ))}
     </div>
   );
@@ -153,7 +154,7 @@ function SuggestionsPanel() {
   return (
     <ul>
       {suggestions.map((s) => (
-        <li key={s.id}>{s.text}</li>
+        <li key={s.id}>{s.value}</li>
       ))}
     </ul>
   );
@@ -188,7 +189,7 @@ ctrl.on("suggestion", (s) => console.log("Suggestion:", s));
 ctrl.on("transcript", (t) => console.log("Transcript:", t));
 ctrl.on("streamState", (state) => {
   console.log("Stream state:", state);
-  // state: "connected" | "throttled" | "disconnected"
+  // state: "connected" | "throttled" | "pending" | "disconnected" | "connection_timeout"
 });
 ctrl.on("error", (err) => console.error("Error:", err));
 
@@ -238,14 +239,14 @@ Extends `EventEmitter`.
 
 #### Methods
 
-| Method             | Description                                    |
-| ------------------ | ---------------------------------------------- |
-| `connect()`        | Open the WebSocket                             |
-| `disconnect()`     | Close cleanly                                  |
-| `setParams(patch)` | Merge params; reconnects if `call_sid` changes |
-| `destroy()`        | Dispose controller and remove all listeners    |
-| `getStatus()`      | Returns current `ConnectionStatus`             |
-| `getStreamState()` | Returns current `StreamState \| null`          |
+| Method                                  | Description                                    |
+| --------------------------------------- | ---------------------------------------------- |
+| `connect()`                             | Open the WebSocket                             |
+| `disconnect()`                          | Close cleanly                                  |
+| `setParams(patch)`                      | Merge params; reconnects if `call_sid` changes |
+| `destroy()`                             | Dispose controller and remove all listeners    |
+| `getStatus()`                           | Returns current `ConnectionStatus`             |
+| `getStreamState()`                      | Returns current `StreamState \| null`          |
 
 #### Events
 
@@ -255,7 +256,7 @@ Extends `EventEmitter`.
 | `suggestion`   | `Suggestion`       | New AI suggestion (capped at last 50)                                                                           |
 | `transcript`   | `TranscriptLine[]` | Live transcript update                                                                                          |
 | `sentiment`    | `Sentiment`        | Sentiment label update                                                                                          |
-| `streamState`  | `StreamState`      | Server stream state change (`connected`, `throttled`, `disconnected`)                                           |
+| `streamState`  | `StreamState`      | Server stream state change (`connected`, `throttled`, `pending`, `disconnected`, `connection_timeout`)          |
 | `onCallStart`  | —                  | Connection opened                                                                                               |
 | `onCallEnd`    | —                  | Connection closed                                                                                               |
 | `statusChange` | `ConnectionStatus` | WebSocket-level status transition (internal)                                                                    |
@@ -266,36 +267,36 @@ Extends `EventEmitter`.
 
 ### `useExotelAIAssist(params)` — Hook return values
 
-| Field          | Type                    | Description                                                                  |
-| -------------- | ----------------------- | ---------------------------------------------------------------------------- |
-| `isReady`      | `boolean`               | `true` after connected + server ack. Multi-tab safe. `false` on disconnect   |
-| `streamState`  | `StreamState \| null`   | Server stream state: `"connected"`, `"throttled"`, or `"disconnected"`. `null` until the first `stream_status` message |
-| `suggestions`  | `Suggestion[]`          | AI suggestions, oldest first, capped at 50                                   |
-| `transcripts`  | `TranscriptLine[]`      | Live transcript lines, ordered by start time                                 |
-| `sentiment`    | `Sentiment \| null`     | Latest sentiment reading                                                     |
-| `lastError`    | `Error \| null`         | Most recent error                                                            |
-| `connect()`    | `() => void`            | Manually open the connection                                                 |
-| `disconnect()` | `() => void`            | Manually close the connection                                                |
-| `setParams()`  | `(patch) => void`       | Merge params; reconnects if connection params change                         |
+| Field                      | Type                    | Description                                                                  |
+| -------------------------- | ----------------------- | ---------------------------------------------------------------------------- |
+| `isReady`                  | `boolean`               | `true` after connected + server ack. Multi-tab safe. `false` on disconnect   |
+| `streamState`              | `StreamState \| null`   | Server stream state: `"connected"`, `"throttled"`, `"pending"`, `"disconnected"`, or `"connection_timeout"`. `null` until the first `stream_status` message |
+| `suggestions`              | `Suggestion[]`          | AI suggestions, oldest first, capped at 50                                   |
+| `transcripts`              | `TranscriptLine[]`      | Live transcript lines, ordered by start time                                 |
+| `sentiment`                | `Sentiment \| null`     | Latest sentiment reading                                                     |
+| `lastError`                | `Error \| null`         | Most recent error                                                            |
+| `connect()`                | `() => void`            | Manually open the connection                                                 |
+| `disconnect()`             | `() => void`            | Manually close the connection                                                |
+| `setParams()`              | `(patch) => void`       | Merge params; reconnects if connection params change                         |
 
 ---
 
 ### TypeScript Types
 
 ```ts
-type StreamState = "connected" | "throttled" | "disconnected";
+type StreamState = "connected" | "throttled" | "pending" | "disconnected" | "connection_timeout";
 
 type ConnectionStatus = "idle" | "connecting" | "connected" | "disconnected" | "error";
 
 interface Suggestion {
   id: string;
-  text: string;
+  value: string;
   timestamp: number;
 }
 
 interface TranscriptLine {
   id: string;
-  text: string;
+  value: string;
   startTime: number;
   endTime: number;
   isFinal: boolean;
@@ -330,15 +331,17 @@ wss://<wssBaseUrl>?[customParam1=value1&customParam2=value2&...]
   "type": "stream_status",
   "config": { /* bot config, populated on connected, null otherwise */ },
   "events": [ /* accumulated events since last message, usually [] */ ],
-  "stream_state": "connected" | "throttled" | "disconnected"
+  "stream_state": "connected" | "throttled" | "pending" | "disconnected" | "connection_timeout"
 }
 ```
 
-| `stream_state`  | Meaning                                                   |
-| --------------- | --------------------------------------------------------- |
-| `connected`     | Stream is active — suggestions, transcript, and sentiment flow normally |
-| `throttled`     | Capacity full — AI Assist cannot join this call; available on the next call |
-| `disconnected`  | Stream ended or dropped                                   |
+| `stream_state`       | Meaning                                                   |
+| -------------------- | --------------------------------------------------------- |
+| `connected`          | Stream is active — suggestions, transcript, and sentiment flow normally |
+| `throttled`          | Capacity full — AI Assist cannot join this call; available on the next call |
+| `pending`            | Stream is pending — waiting for a definitive state |
+| `disconnected`       | Stream ended or dropped                                   |
+| `connection_timeout` | Connection timeout occurred                               |
 
 ### Reconnection
 

package/dist/controller/index.js

@@ -1774,14 +1774,14 @@ class ExotelAIAssistController extends EventEmitter {
     for (const event of events) {
       if (!event) continue;
       if (event.event_type === "transcript" && event.value) {
-        const transcripts = Array.isArray(event === null || event === void 0 ? void 0 : event.value) ? event.value : (_c = event === null || event === void 0 ? void 0 : event.transcript) !== null && _c !== void 0 ? _c : [];
+        const transcripts = Array.isArray(event.value) ? event.value : (_c = event.transcript) !== null && _c !== void 0 ? _c : [];
         const lines = transcripts.map(msg => {
-          var _a, _b, _c, _d, _e;
+          var _a, _b, _c;
           const first = (_a = msg.transcript_segments) === null || _a === void 0 ? void 0 : _a[0];
           const last = (_b = msg.transcript_segments) === null || _b === void 0 ? void 0 : _b[msg.transcript_segments.length - 1];
           return {
             id: String(msg.sequence),
-            value: (_e = (_d = (_c = msg.transcript_segments) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.text) !== null && _e !== void 0 ? _e : "",
+            value: (_c = first === null || first === void 0 ? void 0 : first.text) !== null && _c !== void 0 ? _c : "",
             startTime: (first === null || first === void 0 ? void 0 : first.start_timestamp) ? Date.parse(first.start_timestamp) : now,
             endTime: (last === null || last === void 0 ? void 0 : last.end_timestamp) ? Date.parse(last.end_timestamp) : now,
             isFinal: msg.transcript_segments.every(s => s.is_final)
@@ -1792,7 +1792,7 @@ class ExotelAIAssistController extends EventEmitter {
       if (event.event_type === "suggestion" && event.value) {
         const suggestion = {
           id: Utils.getUniqueId(),
-          value: event.value,
+          value: event.value.text,
           timestamp: now
         };
         this.emit("suggestion", suggestion);

package/dist/index.js

@@ -21192,14 +21192,14 @@ class ExotelAIAssistController extends EventEmitter {
     for (const event of events) {
       if (!event) continue;
       if (event.event_type === "transcript" && event.value) {
-        const transcripts = Array.isArray(event === null || event === void 0 ? void 0 : event.value) ? event.value : (_c = event === null || event === void 0 ? void 0 : event.transcript) !== null && _c !== void 0 ? _c : [];
+        const transcripts = Array.isArray(event.value) ? event.value : (_c = event.transcript) !== null && _c !== void 0 ? _c : [];
         const lines = transcripts.map(msg => {
-          var _a, _b, _c, _d, _e;
+          var _a, _b, _c;
           const first = (_a = msg.transcript_segments) === null || _a === void 0 ? void 0 : _a[0];
           const last = (_b = msg.transcript_segments) === null || _b === void 0 ? void 0 : _b[msg.transcript_segments.length - 1];
           return {
             id: String(msg.sequence),
-            value: (_e = (_d = (_c = msg.transcript_segments) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.text) !== null && _e !== void 0 ? _e : "",
+            value: (_c = first === null || first === void 0 ? void 0 : first.text) !== null && _c !== void 0 ? _c : "",
             startTime: (first === null || first === void 0 ? void 0 : first.start_timestamp) ? Date.parse(first.start_timestamp) : now,
             endTime: (last === null || last === void 0 ? void 0 : last.end_timestamp) ? Date.parse(last.end_timestamp) : now,
             isFinal: msg.transcript_segments.every(s => s.is_final)
@@ -21210,7 +21210,7 @@ class ExotelAIAssistController extends EventEmitter {
       if (event.event_type === "suggestion" && event.value) {
         const suggestion = {
           id: Utils.getUniqueId(),
-          value: event.value,
+          value: event.value.text,
           timestamp: now
         };
         this.emit("suggestion", suggestion);
@@ -21902,7 +21902,7 @@ function ExotelAIAssist(_a) {
     if (streamState === "connection_timeout") {
       return jsxRuntimeExports.jsx(EmptyState, {
         title: "AI Assist is currently inactive",
-        subtitle: "we were unable to establish a connection."
+        subtitle: "We were unable to establish a connection."
       });
     }
     return null;

package/dist/react/index.js

@@ -6478,14 +6478,14 @@ class ExotelAIAssistController extends EventEmitter {
     for (const event of events) {
       if (!event) continue;
       if (event.event_type === "transcript" && event.value) {
-        const transcripts = Array.isArray(event === null || event === void 0 ? void 0 : event.value) ? event.value : (_c = event === null || event === void 0 ? void 0 : event.transcript) !== null && _c !== void 0 ? _c : [];
+        const transcripts = Array.isArray(event.value) ? event.value : (_c = event.transcript) !== null && _c !== void 0 ? _c : [];
         const lines = transcripts.map(msg => {
-          var _a, _b, _c, _d, _e;
+          var _a, _b, _c;
           const first = (_a = msg.transcript_segments) === null || _a === void 0 ? void 0 : _a[0];
           const last = (_b = msg.transcript_segments) === null || _b === void 0 ? void 0 : _b[msg.transcript_segments.length - 1];
           return {
             id: String(msg.sequence),
-            value: (_e = (_d = (_c = msg.transcript_segments) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.text) !== null && _e !== void 0 ? _e : "",
+            value: (_c = first === null || first === void 0 ? void 0 : first.text) !== null && _c !== void 0 ? _c : "",
             startTime: (first === null || first === void 0 ? void 0 : first.start_timestamp) ? Date.parse(first.start_timestamp) : now,
             endTime: (last === null || last === void 0 ? void 0 : last.end_timestamp) ? Date.parse(last.end_timestamp) : now,
             isFinal: msg.transcript_segments.every(s => s.is_final)
@@ -6496,7 +6496,7 @@ class ExotelAIAssistController extends EventEmitter {
       if (event.event_type === "suggestion" && event.value) {
         const suggestion = {
           id: Utils.getUniqueId(),
-          value: event.value,
+          value: event.value.text,
           timestamp: now
         };
         this.emit("suggestion", suggestion);
@@ -7188,7 +7188,7 @@ function ExotelAIAssist(_a) {
     if (streamState === "connection_timeout") {
       return jsxRuntime.jsx(EmptyState, {
         title: "AI Assist is currently inactive",
-        subtitle: "we were unable to establish a connection."
+        subtitle: "We were unable to establish a connection."
       });
     }
     return null;

package/dist/types/index.d.ts

@@ -50,17 +50,34 @@ interface TranscriptSegment {
     is_final: boolean;
     end_timestamp: string;
     start_timestamp: string;
-    value: string;
+    speaker: string;
+    text: string;
 }
 interface TranscriptMessage {
     sequence: number;
     transcript_segments: TranscriptSegment[];
 }
-export interface WssEvent {
-    event_type: "suggestion" | "sentiment" | "transcript";
+export interface SuggestionValue {
+    sequence: number;
+    text: string;
+}
+interface WssEventBase {
     transcript: TranscriptMessage[];
+    text: string;
+}
+interface WssTranscriptEvent extends WssEventBase {
+    event_type: "transcript";
+    value: TranscriptMessage[];
+}
+interface WssSentimentEvent extends WssEventBase {
+    event_type: "sentiment";
     value: string;
 }
+interface WssSuggestionEvent extends WssEventBase {
+    event_type: "suggestion";
+    value: SuggestionValue;
+}
+export type WssEvent = WssTranscriptEvent | WssSentimentEvent | WssSuggestionEvent;
 export interface InitialHandshakeResponse {
     type: string;
     config: BotConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exotel-npm-dev/exotel-ai-assist",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "AI-powered real-time suggestions, transcript, and sentiment for agent calls",
   "license": "Apache-2.0",
   "main": "dist/index.js",

package/src/components/ExotelAIAssistApp.tsx

@@ -42,7 +42,7 @@ export function ExotelAIAssist({ className, onReady, ...params }: ExotelAIAssist
       );
     }
     if (streamState === "connection_timeout") {
-      return <EmptyState title="AI Assist is currently inactive" subtitle="we were unable to establish a connection." />;
+      return <EmptyState title="AI Assist is currently inactive" subtitle="We were unable to establish a connection." />;
     }
     return null;
   }

package/src/controller/index.ts

@@ -225,16 +225,16 @@ export class ExotelAIAssistController extends EventEmitter<ControllerEvents> {
       if (!event) continue;
 
       if (event.event_type === "transcript" && event.value) {
-        const transcripts = Array.isArray(event?.value) ? event.value : (event?.transcript ?? []);
+        const transcripts = Array.isArray(event.value) ? event.value : (event.transcript ?? []);
         const lines: TranscriptLine[] = transcripts.map((msg) => {
           const first = msg.transcript_segments?.[0];
           const last = msg.transcript_segments?.[msg.transcript_segments.length - 1];
           return {
             id: String(msg.sequence),
-            value: msg.transcript_segments?.[0]?.text ?? "",
+            value: first?.text ?? "",
             startTime: first?.start_timestamp ? Date.parse(first.start_timestamp) : now,
             endTime: last?.end_timestamp ? Date.parse(last.end_timestamp) : now,
-            isFinal: msg.transcript_segments.every((s: any) => s.is_final),
+            isFinal: msg.transcript_segments.every((s) => s.is_final),
           };
         });
         this.emit("transcript", lines);
@@ -243,7 +243,7 @@ export class ExotelAIAssistController extends EventEmitter<ControllerEvents> {
       if (event.event_type === "suggestion" && event.value) {
         const suggestion: Suggestion = {
           id: Utils.getUniqueId(),
-          value: event.value,
+          value: event.value.text,
           timestamp: now,
         };
         this.emit("suggestion", suggestion);

package/src/types/index.ts

@@ -61,7 +61,8 @@ interface TranscriptSegment {
   is_final: boolean;
   end_timestamp: string;
   start_timestamp: string;
-  value: string;
+  speaker: string;
+  text: string;
 }
 
 interface TranscriptMessage {
@@ -69,12 +70,33 @@ interface TranscriptMessage {
   transcript_segments: TranscriptSegment[];
 }
 
-export interface WssEvent {
-  event_type: "suggestion" | "sentiment" | "transcript";
+export interface SuggestionValue {
+  sequence: number;
+  text: string;
+}
+
+interface WssEventBase {
   transcript: TranscriptMessage[];
+  text: string;
+}
+
+interface WssTranscriptEvent extends WssEventBase {
+  event_type: "transcript";
+  value: TranscriptMessage[];
+}
+
+interface WssSentimentEvent extends WssEventBase {
+  event_type: "sentiment";
   value: string;
 }
 
+interface WssSuggestionEvent extends WssEventBase {
+  event_type: "suggestion";
+  value: SuggestionValue;
+}
+
+export type WssEvent = WssTranscriptEvent | WssSentimentEvent | WssSuggestionEvent;
+
 export interface InitialHandshakeResponse {
   type: string;
   config: BotConfig;