@exotel-npm-dev/exotel-ai-assist 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2026 Exotel Techcom Pvt. Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,294 @@
+# @exotel-npm-dev/exotel-ai-assist
+
+Real-time AI suggestions and live transcript for Exotel calls — delivered over WebSocket.
+
+## Features
+
+- **One WebSocket per browser session** — uses `SharedWorker` (with `BroadcastChannel` + Navigator Locks fallback) so multiple open tabs share a single connection
+- **Auto-reconnect** with exponential back-off
+- **Live `call_sid` switching** — closing the old connection and opening a new one automatically
+- **Framework-agnostic** — works in Vue, Angular, vanilla JS, or plain HTML
+- **React subpath** for React apps that want to avoid bundling React twice
+- **Headless controller** subpath for raw data with no UI
+
+---
+
+## Installation
+
+```bash
+npm install @exotel-npm-dev/exotel-ai-assist
+```
+
+React is **bundled inside** the default build. You do **not** need React installed for the default entry point.
+
+---
+
+## Quick Start — Plain HTML / Vanilla JS
+
+> **Note:** Browsers cannot resolve bare specifiers (`@exotel-npm-dev/...`) in `<script type="module">` without a bundler or an import map. Choose one of the approaches below.
+
+### Option A — Recommended: Vite (or any bundler)
+
+```bash
+npm create vite@latest my-app -- --template vanilla
+cd my-app
+npm install @exotel-npm-dev/exotel-ai-assist
+```
+
+```js
+// main.js
+import { mountExotelAIAssist } from "@exotel-npm-dev/exotel-ai-assist";
+
+mountExotelAIAssist(document.getElementById("ai-assist"), {
+  authToken: "your-auth-token",
+  call_sid: "CALL-SID-001",
+  accountId: "your-account-id",
+});
+```
+
+### Option B — Import map (no bundler, static server)
+
+Add an import map **before** your module script so the browser knows where to find the package:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <script type="importmap">
+      {
+        "imports": {
+          "@exotel-npm-dev/exotel-ai-assist": "./node_modules/@exotel-npm-dev/exotel-ai-assist/dist/index.js"
+        }
+      }
+    </script>
+  </head>
+  <body>
+    <div id="ai-assist" style="height: 500px;"></div>
+
+    <script type="module">
+      import { mountExotelAIAssist } from "@exotel-npm-dev/exotel-ai-assist";
+
+      mountExotelAIAssist(document.getElementById("ai-assist"), {
+        authToken: "your-auth-token",
+        call_sid: "CALL-SID-001",
+        accountId: "your-account-id",
+      });
+    </script>
+  </body>
+</html>
+```
+
+> Requires a local HTTP server (e.g. `npx serve .`) so that `node_modules` is accessible. Opening `index.html` as a `file://` URL will not work.
+
+### Unmounting
+
+```js
+import { unmountExotelAIAssist } from "@exotel-npm-dev/exotel-ai-assist";
+
+unmountExotelAIAssist(container);
+```
+
+---
+
+## React App — `/react` subpath
+
+Import from the subpath to avoid bundling React twice:
+
+```tsx
+import { ExotelAIAssist } from "@exotel-npm-dev/exotel-ai-assist/react";
+
+function AgentDashboard() {
+  return (
+    <div style={{ height: 500 }}>
+      <ExotelAIAssist authToken="your-auth-token" call_sid="CALL-SID-001" accountId="your-account-id" />
+    </div>
+  );
+}
+```
+
+### Using the hook directly
+
+```tsx
+import { useExotelAIAssist } from "@exotel-npm-dev/exotel-ai-assist/react";
+
+function MyCustomUI({ call_sid }: { call_sid: string }) {
+  const { status, suggestions, transcripts, lastError } = useExotelAIAssist({
+    authToken: "your-auth-token",
+    call_sid,
+    accountId: "your-account-id",
+  });
+
+  return (
+    <div>
+      <p>Status: {status}</p>
+      {suggestions.map((s) => (
+        <p key={s.id}>{s.text}</p>
+      ))}
+    </div>
+  );
+}
+```
+
+### Context Provider (share state across components)
+
+```tsx
+import { ExotelAIAssistProvider, useExotelAIAssistContext } from "@exotel-npm-dev/exotel-ai-assist/react";
+
+function App() {
+  return (
+    <ExotelAIAssistProvider authToken="your-auth-token" call_sid="CALL-SID-001" accountId="your-account-id">
+      <SuggestionsPanel />
+      <TranscriptPanel />
+    </ExotelAIAssistProvider>
+  );
+}
+
+function SuggestionsPanel() {
+  const { suggestions } = useExotelAIAssistContext();
+  return (
+    <ul>
+      {suggestions.map((s) => (
+        <li key={s.id}>{s.text}</li>
+      ))}
+    </ul>
+  );
+}
+```
+
+---
+
+## Headless Controller — `/controller` subpath
+
+For Vue, Angular, or any other framework where you want raw data with no React UI:
+
+```js
+import { ExotelAIAssistController } from "@exotel-npm-dev/exotel-ai-assist/controller";
+
+const ctrl = new ExotelAIAssistController({
+  authToken: "your-auth-token",
+  call_sid: "CALL-SID-001",
+  accountId: "your-account-id",
+});
+
+ctrl.on("suggestion", (s) => console.log("Suggestion:", s));
+ctrl.on("transcript", (t) => console.log("Transcript:", t));
+ctrl.on("statusChange", (status) => console.log("Status:", status));
+ctrl.on("error", (err) => console.error("Error:", err));
+
+ctrl.connect();
+
+// Switch to a new call
+ctrl.setParams({ call_sid: "CALL-SID-002" });
+
+// Clean up
+ctrl.destroy();
+```
+
+---
+
+## API Reference
+
+### `mountExotelAIAssist(container, params)`
+
+Mounts the widget into a DOM element.
+
+| Parameter   | Type                   | Required | Description           |
+| ----------- | ---------------------- | -------- | --------------------- |
+| `container` | `HTMLElement`          | ✓        | Target DOM element    |
+| `params`    | `ExotelAIAssistParams` | ✓        | Connection parameters |
+
+### `unmountExotelAIAssist(container)`
+
+Unmounts and cleans up the widget.
+
+---
+
+### `ExotelAIAssistController`
+
+Extends `EventEmitter`.
+
+#### Constructor options (`ExotelAIAssistParams`)
+
+| Field                  | Type     | Required | Default                  | Description                                              |
+| ---------------------- | -------- | -------- | ------------------------ | -------------------------------------------------------- |
+| `authToken`            | `string` | ✓        | —                        | Bearer token                                             |
+| `call_sid`             | `string` | ✓        | —                        | Active call SID                                          |
+| `accountId`            | `string` | ✓        | —                        | Exotel account identifier                                |
+| `wssBaseUrl`           | `string` | —        | Exotel AI Assist backend | Override only when pointing at a non-production endpoint |
+| `reconnectInterval`    | `number` | —        | `3000`                   | Base reconnect delay in ms                               |
+| `maxReconnectAttempts` | `number` | —        | `5`                      | Max retries before error                                 |
+| `[customParam]`        | `string` | —        | —                        | Max 3 params you can send                                |
+
+#### 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`             |
+
+#### Events
+
+| Event          | Payload            | Description                            |
+| -------------- | ------------------ | -------------------------------------- |
+| `suggestion`   | `Suggestion`       | New AI suggestion (capped at last 50)  |
+| `transcript`   | `TranscriptLine[]` | Live transcript update                 |
+| `sentiment`    | `Sentiment`        | Sentiment label update                 |
+| `onCallStart`  | `unknown`          | Connection opened                      |
+| `onCallEnd`    | `unknown`          | Connection closed                      |
+| `statusChange` | `ConnectionStatus` | Status transition                      |
+| `error`        | `Error`            | Any error (auth, parse, max-reconnect) |
+| `raw`          | `unknown`          | Every raw server message               |
+
+---
+
+### TypeScript Types
+
+```ts
+type ConnectionStatus = "idle" | "connecting" | "connected" | "disconnected" | "error";
+
+interface Suggestion {
+  id: string;
+  text: string;
+  timestamp: number;
+}
+
+interface TranscriptLine {
+  id: string;
+  text: string;
+  startTime: number;
+  endTime: number;
+  isFinal: boolean;
+}
+
+interface Sentiment {
+  label: "positive" | "neutral" | "negative";
+  timestamp: number;
+}
+```
+
+---
+
+## WebSocket Protocol
+
+### URL
+
+When `wssBaseUrl` is provided it overrides the host + path portion:
+
+```
+wss://<wssBaseUrl>?[customParam1=value1&customParam2=value2&...]
+```
+
+### Reconnection
+
+- Exponential back-off: `delay = Math.min(baseInterval × 2^attempt, 30 000)`
+- After `maxReconnectAttempts`: `error` emitted with `code = MAX_RECONNECT_EXCEEDED`
+
+---
+
+## License
+
+Apache 2.0

package/controller.js

@@ -0,0 +1,5 @@
+// Webpack 4 / CRA 4 compatibility shim.
+// Modern bundlers (webpack 5+) use the "exports" field in package.json and
+// never load this file.  Webpack 4 does not understand "exports", so it
+// resolves @exotel-npm-dev/exotel-ai-assist/controller to this CJS file directly.
+module.exports = require("./dist/controller/index.js");

package/dist/components/EmptyState.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+interface EmptyStateProps {
+    title: string;
+    subtitle: string;
+}
+export declare const EmptyState: React.FC<EmptyStateProps>;
+export {};

package/dist/components/ExotelAIAssistApp.d.ts

@@ -0,0 +1,7 @@
+import { ExotelAIAssistParams } from "../types";
+import "../styles/index.css";
+export interface ExotelAIAssistProps extends ExotelAIAssistParams {
+    className?: string;
+}
+export declare function ExotelAIAssist({ className, ...params }: ExotelAIAssistProps): JSX.Element;
+export { ExotelAIAssist as ExotelAIAssistApp };

package/dist/components/ExotelAIAssistProvider.d.ts

@@ -0,0 +1,12 @@
+import { ReactNode } from "react";
+import { UseExotelAIAssistReturn } from "../hooks/useExotelAIAssist";
+import { ExotelAIAssistParams } from "../types";
+export interface ExotelAIAssistProviderProps extends ExotelAIAssistParams {
+    children: ReactNode;
+}
+/**
+ * Provides the AI-assist state to any descendant via `useExotelAIAssistContext`.
+ * Useful when multiple child components need to consume the same stream.
+ */
+export declare function ExotelAIAssistProvider({ children, ...params }: ExotelAIAssistProviderProps): JSX.Element;
+export declare function useExotelAIAssistContext(): UseExotelAIAssistReturn;

package/dist/components/LoadingBox.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+interface LoadingBoxProps {
+    message?: string;
+    skeletonCount?: number;
+    className?: string;
+}
+/**
+ * Reusable loading component with animated gradient border (snake effect).
+ * All styles are inline for portability — no external CSS classes required.
+ */
+declare const LoadingBox: React.FC<LoadingBoxProps>;
+export default LoadingBox;

package/dist/components/Toast.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+export type ToastType = "success" | "error";
+interface ToastContextValue {
+    success: (message: string) => void;
+    error: (message: string) => void;
+}
+export declare function ToastProvider({ children }: {
+    children: React.ReactNode;
+}): JSX.Element;
+export declare function useToast(): ToastContextValue;
+export {};

package/dist/components/key-components/Header.d.ts

@@ -0,0 +1,5 @@
+import { Sentiment, BotConfig } from "../../types";
+export declare function Header({ sentiment, botConfig }: {
+    sentiment: Sentiment | null;
+    botConfig: BotConfig | null;
+}): JSX.Element;

package/dist/components/key-components/SuggestionTab.d.ts

@@ -0,0 +1,7 @@
+import { Suggestion, BotConfig } from "../../types";
+import "../../styles/index.css";
+export declare function SuggestionsTab({ suggestions, connected, botConfig }: {
+    suggestions: Suggestion[];
+    connected: boolean;
+    botConfig: BotConfig | null;
+}): JSX.Element;

package/dist/components/key-components/TranscriptTab.d.ts

@@ -0,0 +1,7 @@
+import { TranscriptLine, BotConfig } from "../../types";
+import "../../styles/index.css";
+export declare function TranscriptTab({ transcripts, connected, botConfig }: {
+    transcripts: TranscriptLine[];
+    connected: boolean;
+    botConfig: BotConfig | null;
+}): JSX.Element;

package/dist/components/logos/NoInteraction.d.ts

@@ -0,0 +1 @@
+export declare function NoInteraction(): JSX.Element;

package/dist/components/logos/Sparkle.d.ts

@@ -0,0 +1 @@
+export declare function Sparkle(): JSX.Element;

package/dist/controller/index.d.ts

@@ -0,0 +1,25 @@
+import EventEmitter from "eventemitter3";
+import { ExotelAIAssistParams, ConnectionStatus, ControllerEvents } from "../types";
+export declare class ExotelAIAssistController extends EventEmitter<ControllerEvents> {
+    private params;
+    private transport;
+    private status;
+    private reconnectAttempt;
+    private reconnectTimer;
+    private destroyed;
+    private readonly reconnectInterval;
+    private readonly maxReconnectAttempts;
+    constructor(params: ExotelAIAssistParams);
+    connect(): void;
+    disconnect(): void;
+    setParams(patch: Partial<ExotelAIAssistParams>): void;
+    destroy(): void;
+    getStatus(): ConnectionStatus;
+    private _ensureTransport;
+    private _handleTransportMessage;
+    private _handleServerPayload;
+    private _scheduleReconnect;
+    private _clearReconnectTimer;
+    private _setStatus;
+    private _log;
+}