@vogent/vogent-web-client 0.1.3 → 0.1.5

package/README.md

@@ -0,0 +1,265 @@
+# Vogent Web Client
+
+A TypeScript/JavaScript client library for integrating Vogent into web applications.
+
+## Installation
+
+### Bun
+```bash
+bun add @vogent/vogent-web-client
+```
+
+### NPM
+```bash
+npm install @vogent/vogent-web-client
+```
+
+### Yarn
+```bash
+yarn add @vogent/vogent-web-client
+```
+
+## Prerequisites
+
+Before using VogentCall, you need to obtain the following from the Vogent API:
+- `sessionId`: Unique session identifier
+- `dialId`: Unique dial/call identifier
+- `token`: Authentication token
+
+You may call the [Create Dial](https://docs.vogent.ai/api-reference/create-a-new-dial) endpoint on the browser to create a browser dial (not a phone call), **but you must be using a public API key**. Do not use a private API key on the client.
+
+## Usage
+
+```typescript
+import { VogentCall } from '@vogent/vogent-web-client';
+
+// First, create a dial using the Vogent API
+const response = await fetch('https://api.vogent.ai/api/dials', {
+  method: 'POST',
+  headers: {
+    'Authorization': 'Bearer pub_vogent_...', // Make sure this is a public key, and not a private key.
+    'Content-Type': 'application/json'
+  },
+  body: JSON.stringify({
+    callAgentId: 'your_call_agent_id',
+    browserCall: true  // Set to true for web-based calls
+  })
+});
+
+const { dialToken, sessionId, dialId } = await response.json();
+
+// Create a new call instance with the dial details
+const call = new VogentCall({
+  sessionId: sessionId,
+  dialId: dialId,
+  token: dialToken
+});
+
+// Start the call
+await call.start();
+
+// Connect audio
+const audioConn = await call.connectAudio();
+
+// Monitor transcripts in real-time
+const unsubscribe = call.monitorTranscript((transcript) => {
+  transcript.forEach(({ text, speaker }) => {
+    console.log(`${speaker}: ${text}`);
+  });
+});
+
+// Listen for status changes
+call.on('status', (status) => {
+  console.log('Call status:', status);
+});
+
+// When done, clean up
+unsubscribe();
+await call.hangup();
+```
+
+## API Reference
+
+### Constructor
+
+```typescript
+new VogentCall(dialDetails, config?)
+```
+
+**Parameters:**
+
+- `dialDetails` (required):
+  - `sessionId` (string): Unique session identifier
+  - `dialId` (string): Unique dial/call identifier
+  - `token` (string): Authentication token
+
+- `config` (optional):
+  - `baseUrl` (string): API base URL (defaults to 'https://api.vogent.ai')
+
+**Example:**
+
+```typescript
+const call = new VogentCall(
+  {
+    sessionId: "session_123",
+    dialId: "dial_456",
+    token: "auth_token_789"
+  },
+  {
+    baseUrl: "https://api.vogent.ai" // optional
+  }
+);
+```
+
+### Methods
+
+#### `start()`
+
+Starts the call session. Note: This does not connect audio automatically.
+
+```typescript
+await call.start();
+```
+
+**Returns:** `Promise<void>`
+
+---
+
+#### `connectAudio(liveListen?)`
+
+Establishes the audio connection for the call.
+
+```typescript
+const audioConn = await call.connectAudio();
+```
+
+**Parameters:**
+- `liveListen` (boolean, optional): Set to `true` for monitoring legs (e.g., humans listening to the call who the AI should not interact with). Defaults to `false`.
+
+**Returns:** `Promise<VogentAudioConn>` - Audio connection handle
+
+**Example:**
+
+```typescript
+// Regular participant
+const audioConn = await call.connectAudio();
+
+// Monitor-only participant (live listening)
+const monitorConn = await call.connectAudio(true);
+```
+
+---
+
+#### `monitorTranscript(callback)`
+
+Subscribes to real-time transcript updates.
+
+```typescript
+const unsubscribe = call.monitorTranscript((transcript) => {
+  // Handle transcript updates
+});
+```
+
+**Parameters:**
+- `callback` (function): Called with transcript updates. Receives an array of transcript objects.
+
+**Transcript Object:**
+```typescript
+type Transcript = {
+  text: string;      // The transcript text
+  speaker: string;   // 'HUMAN', 'AI', or 'IVR' (if IVR detection is enabled)
+}[];
+```
+
+**Returns:** `() => void` - Unsubscribe function
+
+**Example:**
+
+```typescript
+const unsubscribe = call.monitorTranscript((transcript) => {
+  transcript.forEach(({ text, speaker }) => {
+    if (speaker === 'AI') {
+      console.log('AI said:', text);
+    } else if (speaker === 'HUMAN') {
+      console.log('Human said:', text);
+    }
+  });
+});
+
+// Later, when you want to stop monitoring
+unsubscribe();
+```
+
+---
+
+#### `on(event, callback)`
+
+Registers an event handler for call status changes.
+
+```typescript
+call.on('status', (status) => {
+  console.log('Status changed:', status);
+});
+```
+
+**Parameters:**
+- `event` (string): Currently only supports `'status'`
+- `callback` (function): Called when the dial status changes
+---
+
+#### `setPaused(paused)`
+
+Pauses or resumes the AI during the call.
+
+```typescript
+await call.setPaused(true);  // Pause the AI
+await call.setPaused(false); // Resume the AI
+```
+
+**Parameters:**
+- `paused` (boolean): `true` to pause the AI, `false` to resume
+
+**Returns:** `Promise<void>`
+
+---
+
+#### `hangup()`
+
+Ends the current call.
+
+```typescript
+await call.hangup();
+```
+
+**Returns:** `Promise<void>`
+
+## Utilities
+
+### `dialStatusIsComplete(status)`
+
+Helper function to check if a dial status indicates the call has completed.
+
+```typescript
+import { dialStatusIsComplete } from '@vogent/vogent-web-client';
+
+call.on('status', (status) => {
+  if (dialStatusIsComplete(status)) {
+    console.log('Call is complete');
+    // Clean up resources
+  }
+});
+```
+
+## TypeScript Support
+
+This library is written in TypeScript and includes full type definitions.
+
+```typescript
+import { VogentCall, Transcript, VogentAudioConn } from '@vogent/vogent-web-client';
+```
+
+## Support
+
+For more information and support:
+- Documentation: [https://docs.vogent.ai](https://docs.vogent.ai)
+- Issues: Please report issues on the GitHub repository

package/dist/VogentCall.d.ts

@@ -71,7 +71,7 @@ export declare class VogentCall {
      * @param dialDetails.dialId - Unique dial/call identifier
      * @param dialDetails.token - Authentication token
      * @param config - Configuration options
-     * @param config.baseUrl - API base URL (defaults to 'https://api.getelto.com')
+     * @param config.baseUrl - API base URL (defaults to 'https://api.vogent.ai')
      */
     constructor(dialDetails: {
         sessionId: string;

package/dist/VogentCall.js

@@ -39,7 +39,7 @@
  * @see {@link https://docs.vogent.ai} for complete server documentation
  * @module VogentCall
  */
-import { ApolloClient, createHttpLink, InMemoryCache, split } from '@apollo/client/core';
+import { ApolloClient, createHttpLink, InMemoryCache, split, } from '@apollo/client/core';
 import { setContext } from '@apollo/client/link/context';
 import { GraphQLWsLink } from '@apollo/client/link/subscriptions';
 import { getMainDefinition } from '@apollo/client/utilities';
@@ -60,15 +60,15 @@ export class VogentCall {
      * @param dialDetails.dialId - Unique dial/call identifier
      * @param dialDetails.token - Authentication token
      * @param config - Configuration options
-     * @param config.baseUrl - API base URL (defaults to 'https://api.getelto.com')
+     * @param config.baseUrl - API base URL (defaults to 'https://api.vogent.ai')
      */
     constructor(dialDetails, config = {
-        baseUrl: 'https://api.getelto.com',
+        baseUrl: 'https://api.vogent.ai',
     }) {
         this._handlers = [];
         this.sessionId = dialDetails.sessionId;
         this.dialId = dialDetails.dialId;
-        let token = dialDetails.token;
+        const token = dialDetails.token;
         const authLink = setContext((_, { headers }) => {
             return {
                 headers: {
@@ -82,9 +82,9 @@ export class VogentCall {
             uri: `${this.baseUrl}/query`,
             headers: {
                 Authorization: `Bearer ${token}`,
-            }
+            },
         });
-        const wsBaseUrl = this.baseUrl.replace('https://', 'wss://').replace("http://", "ws://");
+        const wsBaseUrl = this.baseUrl.replace('https://', 'wss://').replace('http://', 'ws://');
         const wsLink = new GraphQLWsLink(createClient({
             url: `${wsBaseUrl}/query`,
             connectionParams: () => ({
@@ -175,12 +175,13 @@ export class VogentCall {
                 input: {
                     type: BrowserDialTokenType.DialSession,
                     dialSessionId: this.sessionId,
+                    liveListen: liveListen,
                 },
             },
         });
         let d;
         if (token.data.browserDialToken.telephonyProvider === 'livekit') {
-            d = await LivekitDevice.getDevice(token.data.browserDialToken.token, token.data.browserDialToken.url);
+            d = await LivekitDevice.getDevice(token.data.browserDialToken.token, token.data.browserDialToken.url ?? '');
         }
         else {
             d = await VonageDevice.getDevice(token.data.browserDialToken.token, true);

package/dist/devices/LivekitDevice.d.ts

@@ -1,5 +1,5 @@
-import { RemoteParticipant, RemoteTrack, RemoteTrackPublication, Room } from 'livekit-client';
 import { VogentAudioConn } from './VogentDevice';
+import { RemoteParticipant, RemoteTrack, RemoteTrackPublication, Room } from 'livekit-client';
 export declare class LivekitCall {
     _room: Room;
     _params: any;
@@ -8,8 +8,6 @@ export declare class LivekitCall {
         fn: (...args: any[]) => void;
     }[];
     constructor(room: Room);
-    handleTrackSubscribed(track: RemoteTrack, _publication: RemoteTrackPublication, _participant: RemoteParticipant): void;
-    handleTrackUnsubscribed(track: RemoteTrack, _publication: RemoteTrackPublication, _participant: RemoteParticipant): void;
     mute(status: boolean): void;
     sendDigits(k: string): void;
     disconnect(): void;
@@ -23,5 +21,7 @@ export declare class LivekitDevice {
     private constructor();
     static getDevice(sessionToken: string, url: string): Promise<LivekitDevice>;
     disconnect(): void;
+    handleTrackSubscribed(track: RemoteTrack, _publication: RemoteTrackPublication, _participant: RemoteParticipant): void;
+    handleTrackUnsubscribed(track: RemoteTrack, _publication: RemoteTrackPublication, _participant: RemoteParticipant): void;
     connect(_p: any): Promise<VogentAudioConn>;
 }

package/dist/devices/LivekitDevice.js

@@ -4,28 +4,6 @@ export class LivekitCall {
         this._room = room;
         this._params = {};
         this._handlers = [];
-        this._room
-            .on(RoomEvent.TrackSubscribed, (...args) => {
-            this.handleTrackSubscribed(...args);
-        })
-            .on(RoomEvent.TrackUnsubscribed, (...args) => this.handleTrackUnsubscribed(...args))
-            .on(RoomEvent.Disconnected, () => this.disconnect());
-    }
-    handleTrackSubscribed(track, _publication, _participant) {
-        console.log('Track subscribed', track);
-        if (track.kind === 'audio') {
-            const audioElement = track.attach();
-            document.body.appendChild(audioElement);
-            audioElement.style.display = 'none';
-        }
-        if (_participant.identity === 'livekit-ai-processor') {
-            this.sendEvent('track-added', track.mediaStreamTrack);
-        }
-    }
-    handleTrackUnsubscribed(track, _publication, _participant) {
-        if (track.kind === 'audio') {
-            console.log('Track unsubscribed', track);
-        }
     }
     mute(status) {
         if (status) {
@@ -70,6 +48,13 @@ export class LivekitDevice {
         this._url = url;
         // speeds up connection attempt
         this._room.prepareConnection(this._url, this._token);
+        this._room
+            .on(RoomEvent.TrackSubscribed, this.handleTrackSubscribed)
+            .on(RoomEvent.TrackUnsubscribed, this.handleTrackUnsubscribed)
+            .on(RoomEvent.Disconnected, (reason) => {
+            console.log('Disconnected', reason);
+            this.disconnect();
+        });
     }
     static async getDevice(sessionToken, url) {
         const room = new Room();
@@ -78,6 +63,18 @@ export class LivekitDevice {
     disconnect() {
         this._room.disconnect();
     }
+    handleTrackSubscribed(track, _publication, _participant) {
+        if (track.kind === 'audio') {
+            const audioElement = track.attach();
+            document.body.appendChild(audioElement);
+            audioElement.style.display = 'none';
+        }
+    }
+    handleTrackUnsubscribed(track, _publication, _participant) {
+        if (track.kind === 'audio') {
+            // console.log('Track unsubscribed', track);
+        }
+    }
     async connect(_p) {
         await this._room.connect(this._url, this._token, {});
         const lkcall = new LivekitCall(this._room);

package/dist/devices/VonageDevice.d.ts

@@ -14,7 +14,7 @@ export declare class VonageCall {
     sendDigits(k: string): void;
     disconnect(): void;
     sendEvent(evName: string, ...args: any[]): void;
-    on(ev: 'mute' | 'disconnect', fn: (...args: any[]) => void): void;
+    on(ev: 'mute' | 'disconnect' | 'track-added', fn: (...args: any[]) => void): void;
 }
 export declare class VonageDevice {
     _sessionId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vogent/vogent-web-client",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "license": "MIT",
   "dependencies": {
     "@apollo/client": "^3.12.4",
@@ -9,20 +9,41 @@
     "graphql-ws": "^5.16.0",
     "livekit-client": "2.15.8"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "github:vogent/vogent-web-client"
+  },
+  "publishConfig": {
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+      "dist"
+    ],
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     }
   },
   "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "yarn build"
+    "build": "bun run tsc",
+    "prepublishOnly": "bun run build",
+    "release:patch": "bun version patch && git push && git push --tags",
+    "release:minor": "bun version minor && git push && git push --tags",
+    "release:major": "bun version major && git push && git push --tags"
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.3",