@hamsa-ai/voice-agents-sdk 0.2.0 → 0.2.2

package/src/classes/websocket_manager.js

@@ -1,170 +0,0 @@
-import AudioPlayer from './audio_player'
-import AudioRecorder from './audio_recorder'
-
-export default class WebSocketManager {
-    constructor(
-         url, 
-         conversationId,
-         onError,
-         onStart,
-         onTransciprtionRecieved,
-         onAnswerRecieved,
-         onSpeaking,
-         onListening,
-         onClosed,
-         voiceEnablement,
-         tools,
-         apiKey
-    ) {
-        this.url = `${url}/${conversationId}?api_key=${apiKey}`;
-        this.ws = null;
-        this.isConnected = false;
-        this.audioPlayer = null;
-        this.audioRecorder = null;
-        this.last_transcription_date = new Date();
-        this.last_voice_byte_date = new Date();
-        this.is_media = false;
-        this.onErrorCB = onError;
-        this.onStartCB = onStart;
-        this.onTransciprtionRecievedCB = onTransciprtionRecieved;
-        this.onAnswerRecievedCB = onAnswerRecieved;
-        this.onSpeakingCB = onSpeaking;
-        this.onListeningCB = onListening;
-        this.onClosedCB = onClosed;
-        this.voiceEnablement = voiceEnablement;
-        this.tools = tools;
-        this.apiKey = apiKey;
-        this.setVolume = this.setVolume.bind(this);
-	}
-
-	setVolume(volume) {
-		this.audioPlayer.setVolume(volume);
-    }
-
-    startCall() {
-        try {
-            if (!this.ws) {
-                this.ws = new WebSocket(this.url);
-                this.ws.onopen = this.onOpen.bind(this);
-                this.ws.onmessage = this.onMessage.bind(this);
-                this.ws.onclose = this.onClose.bind(this);
-                this.ws.onerror = this.onError.bind(this);
-                this.audioPlayer = new AudioPlayer(this.ws, this.onSpeakingCB, this.onListeningCB)
-                this.audioRecorder = new AudioRecorder() 
-            }  
-		}catch(e) {
-			console.log(e)
-        }
-    }
-
-    onOpen() {
-        this.ws.send(JSON.stringify({ event: 'start', streamSid: 'WEBSDK' }));
-        this.isConnected = true;
-        this.audioRecorder.startStreaming(this.ws);
-        if (this.onStartCB) this.onStartCB()
-    }
-
-    onMessage(event) {
-        const message = JSON.parse(event.data);
-        switch (message.event) {
-            case 'media':
-                if (message.media) {
-                    this.audioPlayer.enqueueAudio(message.media.payload);
-                }
-                break;
-            case 'clear':
-                this.audioPlayer.stopAndClear();
-                break;
-            case 'mark':
-                this.audioPlayer.addMark(message.mark.name);
-                break;
-            case 'transcription':
-                if (this.onTransciprtionRecievedCB) this.onTransciprtionRecievedCB(message.content)
-                break;
-            case 'answer':
-                if (this.onAnswerRecievedCB) this.onAnswerRecievedCB(message.content)
-                break;
-            case 'tools':
-                const tools_response = this.run_tools(message.content)
-                this.ws.send(JSON.stringify({ event: 'tools_response', tools_response: tools_response,  streamSid: 'WEBSDK' }));
-                break;            
-            default:
-                break;
-        }
-    }
-
-    onClose(event) {
-        if (this.onClosedCB) this.onClosedCB()
-        this.audioPlayer.stopAndClear();
-        this.audioRecorder.stop();
-        this.isConnected = false;
-        this.ws = null
-    }
-
-    onError(error) {
-        if (this.onErrorCB) this.onErrorCB(error)
-            
-    }
-
-    endCall() {
-        if (this.ws) {
-            this.audioPlayer.stopAndClear();
-            this.ws.send(JSON.stringify({ event: 'stop' }));
-            this.audioRecorder.stop();            
-            this.#closeWebSocket()
-            if (this.onClosedCB) this.onClosedCB()
-        }
-    }
-
-    pauseCall() {
-       this.audioPlayer.pause()
-       this.audioRecorder.pause() 
-    }
-    
-    resumeCall() {
-        this.audioPlayer.resume()
-        this.audioRecorder.resume() 
-    }
-
-    run_tools(tools_array) {
-        const results = [];
-        tools_array.forEach(item => {
-            if (item.type === 'function') {
-                const selected_function = this.#findFunctionByName(item.function.name)
-                const functionName = item.function.name;
-                const functionArgs = JSON.parse(item.function.arguments);
-                if (selected_function && typeof selected_function["fn"] === 'function') {
-                    const response = selected_function["fn"](...Object.values(functionArgs));
-                    results.push({
-                        id: item.id,
-                        function: {
-                            name: functionName,
-                            response: response
-                        }
-                    });
-                } else {
-                    results.push({
-                        id: item.id,
-                        function: {
-                            name: functionName,
-                            response: "Error could not find the function"
-                        }
-                    });                    
-                    console.log(`Function ${functionName} is not defined`);
-                }
-            }
-        });
-    
-        return results;
-    }
-
-    #findFunctionByName(functionName) {
-        return this.tools.find(item => item.function_name === functionName) || null;
-    }
-
-    #closeWebSocket() {
-        if (this.ws.readyState === WebSocket.OPEN) {
-            this.ws.close(1000, 'Normal Closure');
-        }
-    }            
-}

package/src/main.js

@@ -1,178 +0,0 @@
-import WebSocketManager from './classes/websocket_manager';
-import { EventEmitter } from 'events';
-
-export class HamsaVoiceAgent extends EventEmitter {
-    constructor(apiKey) {
-        super();
-        this.webSocketManager = null;
-        this.apiKey = apiKey;
-        this.API_URL = "https://api.tryhamsa.com"
-        this.WS_URL = "wss://bots.tryhamsa.com/stream"
-    }
-
-	setVolume(volume) {
-		this.webSocketManager.setVolume(volume);
-    }
-
-    async start({
-        agentId = null,
-        params = {},
-        voiceEnablement = false,
-        tools = []
-    }) {
-        try {
-            const conversationId = await this.#init_conversation(agentId, params, voiceEnablement, tools);
-            if (!conversationId) {
-                throw new Error("Failed to initialize conversation.");
-            }
-            this.jobId = conversationId; // Store the jobId         
-        this.webSocketManager = new WebSocketManager(
-            this.WS_URL,
-            conversationId,
-            (error) => this.emit('error', error),
-            () => this.emit('start'),
-            (transcription) => this.emit('transcriptionReceived', transcription),
-            (answer) => this.emit('answerReceived', answer),
-            () => this.emit('speaking'),
-            () => this.emit('listening'),
-            () => this.emit('closed'),
-            voiceEnablement,
-            tools,
-            this.apiKey
-        );
-        this.webSocketManager.startCall();
-        this.emit('callStarted');
-        } catch (e) {
-            this.emit('error', new Error("Error in starting the call! Make sure you initialized the client with init()."));
-        }
-    }
-
-    end() {
-        try {
-            this.webSocketManager.endCall();
-            this.emit('callEnded');
-        } catch (e) {
-            this.emit('error', new Error("Error in ending the call! Make sure you initialized the client with init()."));
-        }
-    }
-
-    pause() {
-        this.webSocketManager.pauseCall();
-		this.emit('callPaused');
-    }
-
-    resume() {
-        this.webSocketManager.resumeCall();
-		this.emit('callResumed');
-    }
-    
-    /**
-     * Retrieves job details from the Hamsa API using the stored jobId.
-     * Implements retry logic with exponential backoff.
-     * @param {number} [maxRetries=5] - Maximum number of retry attempts.
-     * @param {number} [initialRetryInterval=1000] - Initial delay between retries in milliseconds.
-     * @param {number} [backoffFactor=2] - Factor by which the retry interval increases each attempt.
-     * @returns {Promise<Object>} Job details object.
-     */
-    async getJobDetails(maxRetries = 5, initialRetryInterval = 1000, backoffFactor = 2) {
-        if (!this.jobId) {
-            throw new Error("Cannot fetch job details: jobId is not set. Start a conversation first.");
-        }
-
-        const url = `${this.API_URL}/v1/job`;
-        const headers = {
-            "Authorization": `Token ${this.apiKey}`,
-            "Content-Type": "application/json"
-        };
-        const params = new URLSearchParams({ jobId: this.jobId });
-
-        let currentInterval = initialRetryInterval;
-
-        const fetchJobDetails = async (attempt = 1) => {
-            try {
-                const response = await fetch(`${url}?${params.toString()}`, { method: 'GET', headers });
-                if (!response.ok) {
-                    const errorText = await response.text();
-                    throw new Error(`API Error: ${response.status} ${response.statusText} - ${errorText}`);
-                }
-                const data = await response.json();
-                // check if the message is COMPLETED in the data to decide if we should retry
-                if (data.message === "COMPLETED") {
-                    return data;
-                } else {
-                    throw new Error(`Job status is not COMPLETED: ${data.message}`);
-                }
-            } catch (error) {
-                if (attempt < maxRetries) {
-                    console.warn(`Attempt ${attempt} failed: ${error.message}. Retrying in ${currentInterval / 1000} seconds...`);
-                    await this.#delay(currentInterval); // Wait before retrying
-                    currentInterval *= backoffFactor; // Increase the interval
-                    return fetchJobDetails(attempt + 1);
-                } else {
-                    throw new Error(`Failed to fetch job details after ${maxRetries} attempts: ${error.message}`);
-                }
-            }
-        };
-
-        return fetchJobDetails();
-    }
-    
-    async #init_conversation(voiceAgentId, params, voiceEnablement, tools) {
-        const headers = {
-            "Authorization": `Token ${this.apiKey}`,
-            "Content-Type": "application/json"
-        }
-        const llmtools = (voiceEnablement && tools) ? this.#convertToolsToLLMTools(tools) : []
-        const body = {
-            voiceAgentId,
-            params,
-            voiceEnablement,
-            tools: llmtools
-        }
-
-        const requestOptions = {
-            method: "POST",
-            headers: headers,
-            body: JSON.stringify(body),
-            redirect: "follow"
-          };
-          
-          try {
-            const response = await fetch(`${this.API_URL}/v1/voice-agents/conversation-init`, requestOptions);
-                        const result = await response.json();
-                            return result["data"]["jobId"]
-          } catch (error) {
-            this.emit('error', new Error("Error in initializing the call. Please double-check your API_KEY and ensure you have sufficient funds in your balance."));
-          };
-    }
-
-    #convertToolsToLLMTools(tools) {
-        return tools.map(item => ({
-            type: "function",
-            function: {
-                name: item.function_name,
-                description: item.description,
-                parameters: {
-                    type: "object",
-                    properties: item.parameters?.reduce((acc, param) => {
-                        acc[param.name] = {
-                            type: param.type,
-                            description: param.description
-                        };
-                        return acc;
-                    }, {}) || {}, 
-                    required: item.required || [] 
-                }
-            }
-        }));
-    }
-    /**
-     * Delays execution for a specified amount of time.
-     * @param {number} ms - Milliseconds to delay.
-     * @returns {Promise} Promise that resolves after the delay.
-     */
-    #delay(ms) {
-        return new Promise(resolve => setTimeout(resolve, ms));
-    }
-}
-

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-    "compilerOptions": {
-      "declaration": true,
-      "emitDeclarationOnly": true,
-      "outDir": "./types",
-      "target": "ES6",
-      "module": "ES6",
-      "allowJs": true,
-      "moduleResolution": "node",  // Try "nodenext" if "node" doesn't work
-      "esModuleInterop": true
-    },
-    "include": ["src/**/*.js"],
-    "exclude": ["types"]
-  }

package/types/classes/audio-player-processor.d.ts

@@ -1 +0,0 @@
-declare const audioProcessorURL: "\nclass AudioPlayerProcessor extends AudioWorkletProcessor {\n    constructor() {\n        super();\n        this.audioData = [];\n        this.isPaused = false;\n        this.marks = [];\n        this.isDone = false;\n\n        this.port.onmessage = (event) => {\n            if (event.data.type === 'enqueue') {\n                this.audioData.push(...event.data.audioSamples);\n                this.isPaused = false;\n                this.isDone = false;\n            } else if (event.data.type === 'pause') {\n                this.isPaused = true;\n            } else if (event.data.type === 'resume') {\n                this.isPaused = false;\n            } else if (event.data.type === 'addMark') {\n                this.marks.push(event.data.markName);\n            } else if (event.data.type === 'clear') {\n                this.clearAllData();\n            }\n        };\n    }\n\n    clearAllData() {\n        this.audioData = []; // Clear the audio data buffer\n        this.marks = []; // Clear any pending marks\n        this.isPaused = true; // Optionally, pause processing to ensure no data is played\n    }\n\n    process(inputs, outputs) {\n        const output = outputs[0];\n\n        if (this.isPaused) {\n            for (let channel = 0; channel < output.length; channel++) {\n                output[channel].fill(0); // Output silence if paused or cleared\n            }\n            return true;\n        }\n\n        for (let channel = 0; channel < output.length; channel++) {\n            const outputData = output[channel];\n            const inputData = this.audioData.splice(0, outputData.length);\n\n            if (inputData.length > 0) {\n                outputData.set(inputData);\n            } else {\n                outputData.fill(0); // Output silence when no data is available\n            }\n        }\n        if (this.audioData.length === 0 && !this.isDone) {\n            this.isDone = true; \n            this.port.postMessage({ type: 'finished' });\n        }\n\n        // Process marks if all audio data has been played\n        if (this.marks.length > 0 && this.audioData.length === 0) {\n            const mark_name = this.marks.shift();\n            this.port.postMessage({ type: 'mark', markName: mark_name });\n        }\n\n\n\n        return true; // Keep the processor active\n    }\n}\n\nregisterProcessor('audio-player-processor', AudioPlayerProcessor);\n";

package/types/classes/audio-processor.d.ts

@@ -1 +0,0 @@
-declare const audioRecorderProcessor: "\nclass AudioProcessor extends AudioWorkletProcessor {\n    encodeBase64(bytes) {\n        const base64abc = [\n            'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',\n            'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',\n            'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v',\n            'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'\n        ];\n\n        let result = '';\n        let i;\n        const l = bytes.length;\n        for (i = 2; i < l; i += 3) {\n            result += base64abc[bytes[i - 2] >> 2];\n            result += base64abc[((bytes[i - 2] & 0x03) << 4) | (bytes[i - 1] >> 4)];\n            result += base64abc[((bytes[i - 1] & 0x0f) << 2) | (bytes[i] >> 6)];\n            result += base64abc[bytes[i] & 0x3f];\n        }\n        if (i === l + 1) { // 1 octet yet to write\n            result += base64abc[bytes[i - 2] >> 2];\n            result += base64abc[(bytes[i - 2] & 0x03) << 4];\n            result += '==';\n        }\n        if (i === l) { // 2 octets yet to write\n            result += base64abc[bytes[i - 2] >> 2];\n            result += base64abc[((bytes[i - 2] & 0x03) << 4) | (bytes[i - 1] >> 4)];\n            result += base64abc[(bytes[i - 1] & 0x0f) << 2];\n            result += '=';\n        }\n        return result;\n    }\n\n    process(inputs, outputs, parameters) {\n        const input = inputs[0];\n        if (input && input[0]) {\n            const inputData = input[0];\n            const rawAudioData = new Float32Array(inputData.length);\n            rawAudioData.set(inputData);\n\n            // Convert the audio data to a Uint8Array for base64 encoding\n            const uint8Array = new Uint8Array(rawAudioData.buffer);\n\n            // Use the custom base64 encoding function\n            const base64String = this.encodeBase64(uint8Array);\n\n            // Send the base64 string to the main thread via the port\n            this.port.postMessage({ event: 'media', streamSid: 'WEBSDK', media: { payload: base64String } });\n        }\n\n        return true;\n    }\n}\n\nregisterProcessor('audio-processor', AudioProcessor);\n";

package/types/classes/event_listeners.d.ts

@@ -1,3 +0,0 @@
-export class EvenetsListener {
-    initListeners(): void;
-}

package/types/classes/facny_button.d.ts

@@ -1,17 +0,0 @@
-export default class FancyButton {
-    constructor(voiceEnablement: any);
-    isCallStarted: boolean;
-    iframe: HTMLIFrameElement;
-    isIframeLoaded: boolean;
-    voiceEnablement: any;
-    createFloatingButton(WSManager: any): void;
-    WSManager: any;
-    toggleCall(): void;
-    startCall(): void;
-    endCall(): void;
-    updateButtonAppearance(): void;
-    startWaveAnimation(): void;
-    stopWaveAnimation(): void;
-    createIframe(callback: any): void;
-    removeIframe(): void;
-}

package/webpack.config.js

@@ -1,44 +0,0 @@
-const path = require('path');
-
-module.exports = {
-    entry: './src/main.js',
-    output: {
-        path: path.resolve(__dirname, 'dist'),
-        filename: 'index.js',
-        library: {
-            name: 'Hamsa Voice-Agents SDK',
-            type: 'umd',  // UMD ensures compatibility across environments
-        },
-        globalObject: 'this',
-        umdNamedDefine: true
-    },
-    target: 'web',  // 'web' should cover most browser-based environments
-    module: {
-        rules: [   
-            {
-                test: /\.worklet\.js/,
-                loader: "audio-worklet-loader",
-                options: {
-                    inline: "no-fallback",
-                }
-            },                
-            {
-                test: /\.js$/,
-                exclude: /node_modules/,
-                use: 'babel-loader',
-            },
-            {
-                test: /\.css$/,
-                use: ['style-loader', 'css-loader'],
-            },     
-        ]
-    },
-    resolve: {
-        extensions: ['.js'],
-        fallback: {
-            "events": require.resolve("events/")
-        }
-    },
-    mode: 'production',
-    externals: [],  // Define any external dependencies that should not be bundled
-};