@vapi-ai/web 1.0.0 → 1.0.2

package/README.md

@@ -1 +1,74 @@
-# snippet
+# Vapi Web SDK
+
+This package lets you start Vapi calls directly in your webapp.
+
+## Installation
+
+You can install the package via npm:
+
+```bash
+npm install @vapi-ai/web
+```
+
+## Usage
+
+First, import the Vapi class from the package:
+
+```javascript
+import Vapi from '@vapi-ai/web';
+```
+
+Then, create a new instance of the Vapi class, passing your Client Token as a parameter to the constructor:
+
+```javascript
+const vapi = new Vapi('your-api-token');
+```
+
+You can start a new call by calling the `start` method and passing an `agent` object or `agentId`:
+
+```javascript
+vapi.start({
+  context: "You are a shopping assistant...",
+  voice: "steve",
+  ...
+});
+```
+```javascript
+vapi.start('your-agent-id');
+```
+
+The `start` method will initiate a new call. 
+
+You can stop the session by calling the `stop` method:
+
+```javascript
+vapi.stop();
+```
+
+This will stop the recording and close the connection.
+
+## License
+
+```
+MIT License
+
+Copyright (c) 2023 Vapi Labs Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

package/dist/player.d.ts

@@ -1,4 +1,6 @@
-export declare class ContinuousPlayer {
+/// <reference types="node" />
+import { EventEmitter } from "stream";
+export declare class ContinuousPlayer extends EventEmitter {
     private audioCtx;
     private nextStartTime;
     private audioQueue;

package/dist/player.js

@@ -11,15 +11,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContinuousPlayer = void 0;
 const async_1 = require("async"); // You need to install the async package
-class ContinuousPlayer {
+const stream_1 = require("stream");
+class ContinuousPlayer extends stream_1.EventEmitter {
     constructor(crossFadeDuration = 0.5) {
+        super();
         this.audioCtx = new AudioContext();
         this.nextStartTime = 0;
         this.audioQueue = this.createQueue();
         this.crossFadeDuration = crossFadeDuration;
     }
     createQueue() {
-        return (0, async_1.queue)((audioPromise, callback) => __awaiter(this, void 0, void 0, function* () {
+        const q = (0, async_1.queue)((audioPromise, callback) => __awaiter(this, void 0, void 0, function* () {
             const audioBuffer = yield audioPromise;
             const source = this.audioCtx.createBufferSource();
             source.buffer = audioBuffer;
@@ -40,6 +42,13 @@ class ContinuousPlayer {
                 callback();
             };
         }), 1);
+        q.drain(() => {
+            this.emit("speech-end");
+        });
+        q.saturated(() => {
+            this.emit("speech-start");
+        });
+        return q;
     }
     playChunk(audioData) {
         const decodePromise = this.audioCtx.decodeAudioData(audioData);

package/dist/vapi.d.ts

@@ -1,11 +1,13 @@
+/// <reference types="node" />
 import { CreateAgentDTO } from "./api";
-export default class Vapi {
+import { EventEmitter } from "stream";
+export default class Vapi extends EventEmitter {
     private started;
     private ws;
     private mediaRecorder;
     private player;
     constructor(apiToken: string);
-    start(agent: CreateAgentDTO): void;
+    start(agent: CreateAgentDTO | string): void;
     private startRecording;
     private onMessage;
     clear(): void;

package/dist/vapi.js

@@ -1,15 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const player_1 = require("./player");
+const stream_1 = require("stream");
 const client_1 = require("./client");
 const base64_arraybuffer_1 = require("base64-arraybuffer");
-class Vapi {
+class Vapi extends stream_1.EventEmitter {
     constructor(apiToken) {
+        super();
         this.started = false;
         this.ws = null;
         this.mediaRecorder = null;
-        this.player = new player_1.ContinuousPlayer();
         client_1.client.setSecurityData(apiToken);
+        this.player = new player_1.ContinuousPlayer();
+        this.player.on("speech-start", () => this.emit("speech-start"));
+        this.player.on("speech-end", () => this.emit("speech-end"));
     }
     start(agent) {
         if (this.started) {
@@ -18,7 +22,8 @@ class Vapi {
         this.started = true;
         client_1.client.call
             .callControllerCreateWebCall({
-            agent,
+            agent: typeof agent === "string" ? undefined : agent,
+            agentId: typeof agent === "string" ? agent : undefined,
         })
             .then(({ data }) => {
             const { callId, url } = data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vapi-ai/web",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "dist/vapi.js",
   "types": "dist/vapi.d.ts",

package/player.ts

@@ -1,12 +1,15 @@
 import { QueueObject, queue } from "async"; // You need to install the async package
 
-export class ContinuousPlayer {
+import { EventEmitter } from "stream";
+
+export class ContinuousPlayer extends EventEmitter {
   private audioCtx: AudioContext;
   private nextStartTime: number;
   private audioQueue: QueueObject<Promise<AudioBuffer>>;
   private crossFadeDuration: number; // Duration of the crossfade
 
   constructor(crossFadeDuration = 0.5) {
+    super();
     this.audioCtx = new AudioContext();
     this.nextStartTime = 0;
     this.audioQueue = this.createQueue();
@@ -14,7 +17,7 @@ export class ContinuousPlayer {
   }
 
   private createQueue() {
-    return queue(
+    const q = queue(
       async (audioPromise: Promise<AudioBuffer>, callback: Function) => {
         const audioBuffer = await audioPromise;
         const source = this.audioCtx.createBufferSource();
@@ -51,6 +54,15 @@ export class ContinuousPlayer {
       },
       1
     );
+
+    q.drain(() => {
+      this.emit("speech-end");
+    });
+    q.saturated(() => {
+      this.emit("speech-start");
+    });
+
+    return q;
   }
 
   playChunk(audioData: ArrayBuffer) {

package/vapi.ts

@@ -1,20 +1,26 @@
 import { Agent, CreateAgentDTO } from "./api";
 
 import { ContinuousPlayer } from "./player";
+import { EventEmitter } from "stream";
 import { client } from "./client";
 import { decode } from "base64-arraybuffer";
 
-export default class Vapi {
+export default class Vapi extends EventEmitter {
   private started: boolean = false;
   private ws: WebSocket | null = null;
   private mediaRecorder: MediaRecorder | null = null;
-  private player = new ContinuousPlayer();
+  private player: ContinuousPlayer;
 
   constructor(apiToken: string) {
+    super();
     client.setSecurityData(apiToken);
+    this.player = new ContinuousPlayer();
+
+    this.player.on("speech-start", () => this.emit("speech-start"));
+    this.player.on("speech-end", () => this.emit("speech-end"));
   }
 
-  start(agent: CreateAgentDTO): void {
+  start(agent: CreateAgentDTO | string): void {
     if (this.started) {
       return;
     }
@@ -23,7 +29,8 @@ export default class Vapi {
 
     client.call
       .callControllerCreateWebCall({
-        agent,
+        agent: typeof agent === "string" ? undefined : agent,
+        agentId: typeof agent === "string" ? agent : undefined,
       })
       .then(({ data }) => {
         const { callId, url } = data;