@codebolt/codeboltjs 1.1.30 → 1.1.32

package/modules/codeutils.js

@@ -8,20 +8,11 @@ const websocket_1 = __importDefault(require("./websocket"));
  * A utility module for working with code.
  */
 const cbcodeutils = {
-    getCodeTree: () => {
-        return new Promise((resolve, reject) => {
-            websocket_1.default.getWebsocket.send(JSON.stringify({
-                "type": "codeEvent",
-                "action": "getCodeTree"
-            }));
-            websocket_1.default.getWebsocket.on('message', (data) => {
-                const response = JSON.parse(data);
-                if (response.type === "getCodeTreeResponse") {
-                    resolve(response.markdown); // Resolve the Promise with the response data
-                }
-            });
-        });
-    },
+    /**
+     * Retrieves a JavaScript tree structure for a given file path.
+     * @param {string} filePath - The path of the file to retrieve the JS tree for.
+     * @returns {Promise<GetJsTreeResponse>} A promise that resolves with the JS tree response.
+     */
     getJsTree: (filePath) => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
@@ -34,11 +25,15 @@ const cbcodeutils = {
             websocket_1.default.getWebsocket.on('message', (data) => {
                 const response = JSON.parse(data);
                 if (response.type === "getJsTreeResponse") {
-                    resolve(resolve); // Resolve the Promise with the response data
+                    resolve(response); // Resolve the Promise with the response data
                 }
             });
         });
     },
+    /**
+     * Retrieves all files as Markdown.
+     * @returns {Promise<string>} A promise that resolves with the Markdown content of all files.
+     */
     getAllFilesAsMarkDown: () => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
@@ -48,11 +43,18 @@ const cbcodeutils = {
             websocket_1.default.getWebsocket.on('message', (data) => {
                 const response = JSON.parse(data);
                 if (response.type === "getAllFilesMarkdownResponse") {
-                    resolve(response.markdown); // Resolve the Promise with the response data
+                    resolve(response); // Resolve the Promise with the response data
                 }
             });
         });
     },
+    /**
+     * Performs a matching operation based on the provided matcher definition and problem patterns.
+     * @param {object} matcherDefinition - The definition of the matcher.
+     * @param {Array} problemPatterns - The patterns to match against.
+     * @param {Array} problems - The list of problems.
+     * @returns {Promise<MatchProblemResponse>} A promise that resolves with the matching problem response.
+     */
     performMatch: (matcherDefinition, problemPatterns, problems) => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
@@ -66,11 +68,15 @@ const cbcodeutils = {
             websocket_1.default.getWebsocket.on('message', (data) => {
                 const response = JSON.parse(data);
                 if (response.type === "getgetJsTreeResponse") {
-                    resolve(resolve); // Resolve the Promise with the response data
+                    resolve(response); // Resolve the Promise with the response data
                 }
             });
         });
     },
+    /**
+     * Retrieves the list of matchers.
+     * @returns {Promise<GetMatcherListTreeResponse>} A promise that resolves with the list of matchers response.
+     */
     getMatcherList: () => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
@@ -80,11 +86,16 @@ const cbcodeutils = {
             websocket_1.default.getWebsocket.on('message', (data) => {
                 const response = JSON.parse(data);
                 if (response.type === "getMatcherListTreeResponse") {
-                    resolve(resolve); // Resolve the Promise with the response data
+                    resolve(response); // Resolve the Promise with the response data
                 }
             });
         });
     },
+    /**
+     * Retrieves details of a match.
+     * @param {string} matcher - The matcher to retrieve details for.
+     * @returns {Promise<getMatchDetail>} A promise that resolves with the match detail response.
+     */
     matchDetail: (matcher) => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
@@ -97,7 +108,7 @@ const cbcodeutils = {
             websocket_1.default.getWebsocket.on('message', (data) => {
                 const response = JSON.parse(data);
                 if (response.type === "matchDetailTreeResponse") {
-                    resolve(resolve); // Resolve the Promise with the response data
+                    resolve(response); // Resolve the Promise with the response data
                 }
             });
         });

package/modules/dbmemory.d.ts

@@ -1,3 +1,4 @@
+import { MemorySetResponse, MemoryGetResponse } from '@codebolt/types';
 /**
  * A module for handling in-memory database operations via WebSocket.
  */
@@ -6,14 +7,14 @@ declare const dbmemory: {
      * Adds a key-value pair to the in-memory database.
      * @param {string} key - The key under which to store the value.
      * @param {any} value - The value to be stored.
-     * @returns {Promise<any>} A promise that resolves with the response from the memory set event.
+     * @returns {Promise<MemorySetResponse>} A promise that resolves with the response from the memory set event.
      */
-    addKnowledge: (key: string, value: any) => Promise<any>;
+    addKnowledge: (key: string, value: any) => Promise<MemorySetResponse>;
     /**
      * Retrieves a value from the in-memory database by key.
      * @param {string} key - The key of the value to retrieve.
-     * @returns {Promise<any>} A promise that resolves with the response from the memory get event.
+     * @returns {Promise<MemoryGetResponse>} A promise that resolves with the response from the memory get event.
      */
-    getKnowledge: (key: string) => Promise<any>;
+    getKnowledge: (key: string) => Promise<MemoryGetResponse>;
 };
 export default dbmemory;

package/modules/dbmemory.js

@@ -12,7 +12,7 @@ const dbmemory = {
      * Adds a key-value pair to the in-memory database.
      * @param {string} key - The key under which to store the value.
      * @param {any} value - The value to be stored.
-     * @returns {Promise<any>} A promise that resolves with the response from the memory set event.
+     * @returns {Promise<MemorySetResponse>} A promise that resolves with the response from the memory set event.
      */
     addKnowledge: (key, value) => {
         return new Promise((resolve, reject) => {
@@ -33,7 +33,7 @@ const dbmemory = {
     /**
      * Retrieves a value from the in-memory database by key.
      * @param {string} key - The key of the value to retrieve.
-     * @returns {Promise<any>} A promise that resolves with the response from the memory get event.
+     * @returns {Promise<MemoryGetResponse>} A promise that resolves with the response from the memory get event.
      */
     getKnowledge: (key) => {
         return new Promise((resolve, reject) => {

package/modules/debug.d.ts

@@ -1,10 +1,23 @@
+import { DebugAddLogResponse, OpenDebugBrowserResponse } from '@codebolt/types';
 export declare enum logType {
     info = "info",
     error = "error",
     warning = "warning"
 }
 export declare const debug: {
-    debug(log: string, type: logType): Promise<unknown>;
-    openDebugBrowser(url: string, port: number): Promise<unknown>;
+    /**
+     * Sends a log message to the debug websocket and waits for a response.
+     * @param {string} log - The log message to send.
+     * @param {logType} type - The type of the log message (info, error, warning).
+     * @returns {Promise<DebugAddLogResponse>} A promise that resolves with the response from the debug event.
+     */
+    debug: (log: string, type: logType) => Promise<DebugAddLogResponse>;
+    /**
+     * Requests to open a debug browser at the specified URL and port.
+     * @param {string} url - The URL where the debug browser should be opened.
+     * @param {number} port - The port on which the debug browser will listen.
+     * @returns {Promise<OpenDebugBrowserResponse>} A promise that resolves with the response from the open debug browser event.
+     */
+    openDebugBrowser: (url: string, port: number) => Promise<OpenDebugBrowserResponse>;
 };
 export default debug;

package/modules/debug.js

@@ -12,7 +12,13 @@ var logType;
     logType["warning"] = "warning";
 })(logType || (exports.logType = logType = {}));
 exports.debug = {
-    debug(log, type) {
+    /**
+     * Sends a log message to the debug websocket and waits for a response.
+     * @param {string} log - The log message to send.
+     * @param {logType} type - The type of the log message (info, error, warning).
+     * @returns {Promise<DebugAddLogResponse>} A promise that resolves with the response from the debug event.
+     */
+    debug: (log, type) => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
                 "type": "debugEvent",
@@ -30,7 +36,13 @@ exports.debug = {
             });
         });
     },
-    openDebugBrowser(url, port) {
+    /**
+     * Requests to open a debug browser at the specified URL and port.
+     * @param {string} url - The URL where the debug browser should be opened.
+     * @param {number} port - The port on which the debug browser will listen.
+     * @returns {Promise<OpenDebugBrowserResponse>} A promise that resolves with the response from the open debug browser event.
+     */
+    openDebugBrowser: (url, port) => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
                 "type": "debugEvent",

package/modules/fs.d.ts

@@ -1,3 +1,4 @@
+import { CreateFileResponse, CreateFolderResponse, ReadFileResponse, UpdateFileResponse, DeleteFileResponse, DeleteFolderResponse } from '@codebolt/types';
 /**
  * @module cbfs
  * @description This module provides functionality to interact with the filesystem.
@@ -9,50 +10,55 @@ declare const cbfs: {
      * @param {string} fileName - The name of the file to create.
      * @param {string} source - The source content to write into the file.
      * @param {string} filePath - The path where the file should be created.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<CreateFileResponse>} A promise that resolves with the server response.
      */
-    createFile: (fileName: string, source: string, filePath: string) => Promise<any>;
+    createFile: (fileName: string, source: string, filePath: string) => Promise<CreateFileResponse>;
     /**
      * @function createFolder
      * @description Creates a new folder.
      * @param {string} folderName - The name of the folder to create.
      * @param {string} folderPath - The path where the folder should be created.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<CreateFolderResponse>} A promise that resolves with the server response.
      */
-    createFolder: (folderName: string, folderPath: string) => Promise<any>;
+    createFolder: (folderName: string, folderPath: string) => Promise<CreateFolderResponse>;
     /**
      * @function readFile
      * @description Reads the content of a file.
      * @param {string} filename - The name of the file to read.
      * @param {string} filePath - The path of the file to read.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<ReadFileResponse>} A promise that resolves with the server response.
      */
-    readFile: (filename: string, filePath: string) => Promise<any>;
+    readFile: (filename: string, filePath: string) => Promise<ReadFileResponse>;
     /**
      * @function updateFile
      * @description Updates the content of a file.
      * @param {string} filename - The name of the file to update.
      * @param {string} filePath - The path of the file to update.
      * @param {string} newContent - The new content to write into the file.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<UpdateFileResponse>} A promise that resolves with the server response.
      */
-    updateFile: (filename: string, filePath: string, newContent: string) => Promise<any>;
+    updateFile: (filename: string, filePath: string, newContent: string) => Promise<UpdateFileResponse>;
     /**
      * @function deleteFile
      * @description Deletes a file.
      * @param {string} filename - The name of the file to delete.
      * @param {string} filePath - The path of the file to delete.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<DeleteFileResponse>} A promise that resolves with the server response.
      */
-    deleteFile: (filename: string, filePath: string) => Promise<any>;
+    deleteFile: (filename: string, filePath: string) => Promise<DeleteFileResponse>;
     /**
      * @function deleteFolder
      * @description Deletes a folder.
      * @param {string} foldername - The name of the folder to delete.
      * @param {string} folderpath - The path of the folder to delete.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<DeleteFolderResponse>} A promise that resolves with the server response.
      */
-    deleteFolder: (foldername: string, folderpath: string) => Promise<any>;
-    listFile: (folderPath?: string) => void;
+    deleteFolder: (foldername: string, folderpath: string) => Promise<DeleteFolderResponse>;
+    /**
+     * @function listFile
+     * @description Lists all files.
+     * @returns {Promise<FileListResponse>} A promise that resolves with the list of files.
+     */
+    listFile: (filePath: string) => Promise<unknown>;
 };
 export default cbfs;

package/modules/fs.js

@@ -15,7 +15,7 @@ const cbfs = {
      * @param {string} fileName - The name of the file to create.
      * @param {string} source - The source content to write into the file.
      * @param {string} filePath - The path where the file should be created.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<CreateFileResponse>} A promise that resolves with the server response.
      */
     createFile: (fileName, source, filePath) => {
         return new Promise((resolve, reject) => {
@@ -41,7 +41,7 @@ const cbfs = {
      * @description Creates a new folder.
      * @param {string} folderName - The name of the folder to create.
      * @param {string} folderPath - The path where the folder should be created.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<CreateFolderResponse>} A promise that resolves with the server response.
      */
     createFolder: (folderName, folderPath) => {
         return new Promise((resolve, reject) => {
@@ -66,7 +66,7 @@ const cbfs = {
      * @description Reads the content of a file.
      * @param {string} filename - The name of the file to read.
      * @param {string} filePath - The path of the file to read.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<ReadFileResponse>} A promise that resolves with the server response.
      */
     readFile: (filename, filePath) => {
         return new Promise((resolve, reject) => {
@@ -92,7 +92,7 @@ const cbfs = {
      * @param {string} filename - The name of the file to update.
      * @param {string} filePath - The path of the file to update.
      * @param {string} newContent - The new content to write into the file.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<UpdateFileResponse>} A promise that resolves with the server response.
      */
     updateFile: (filename, filePath, newContent) => {
         return new Promise((resolve, reject) => {
@@ -118,7 +118,7 @@ const cbfs = {
      * @description Deletes a file.
      * @param {string} filename - The name of the file to delete.
      * @param {string} filePath - The path of the file to delete.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<DeleteFileResponse>} A promise that resolves with the server response.
      */
     deleteFile: (filename, filePath) => {
         return new Promise((resolve, reject) => {
@@ -143,7 +143,7 @@ const cbfs = {
      * @description Deletes a folder.
      * @param {string} foldername - The name of the folder to delete.
      * @param {string} folderpath - The path of the folder to delete.
-     * @returns {Promise<any>} A promise that resolves with the server response.
+     * @returns {Promise<DeleteFolderResponse>} A promise that resolves with the server response.
      */
     deleteFolder: (foldername, folderpath) => {
         return new Promise((resolve, reject) => {
@@ -163,7 +163,24 @@ const cbfs = {
             });
         });
     },
-    listFile: (folderPath) => {
+    /**
+     * @function listFile
+     * @description Lists all files.
+     * @returns {Promise<FileListResponse>} A promise that resolves with the list of files.
+     */
+    listFile: (filePath) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "fsEvent",
+                "action": "fileList",
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "fileListResponse") {
+                    resolve(response);
+                }
+            });
+        });
     },
 };
 exports.default = cbfs;

package/modules/llm.d.ts

@@ -1,3 +1,4 @@
+import { LLMResponse } from '@codebolt/types';
 /**
  * A module for interacting with language learning models (LLMs) via WebSocket.
  */
@@ -10,8 +11,8 @@ declare const cbllm: {
      *
      * @param {string} message - The input message or prompt to be sent to the LLM.
      * @param {string} llmrole - The role of the LLM to determine which model to use.
-     * @returns {Promise<any>} A promise that resolves with the LLM's response.
+     * @returns {Promise<LLMResponse>} A promise that resolves with the LLM's response.
      */
-    inference: (message: string, llmrole: string) => Promise<any>;
+    inference: (message: string, llmrole: string) => Promise<LLMResponse>;
 };
 export default cbllm;

package/modules/llm.js

@@ -16,7 +16,7 @@ const cbllm = {
      *
      * @param {string} message - The input message or prompt to be sent to the LLM.
      * @param {string} llmrole - The role of the LLM to determine which model to use.
-     * @returns {Promise<any>} A promise that resolves with the LLM's response.
+     * @returns {Promise<LLMResponse>} A promise that resolves with the LLM's response.
      */
     inference: async (message, llmrole) => {
         return new Promise((resolve, reject) => {

package/modules/project.d.ts

@@ -1,3 +1,4 @@
+import { GetProjectPathResponse } from '@codebolt/types';
 /**
  * A module for interacting with project settings and paths.
  */
@@ -10,8 +11,8 @@ declare const cbproject: {
     getProjectSettings: (output: any) => void;
     /**
      * Retrieves the path of the current project.
-     * @returns {Promise<any>} A promise that resolves with the project path response.
+     * @returns {Promise<GetProjectPathResponse>} A promise that resolves with the project path response.
      */
-    getProjectPath: () => Promise<any>;
+    getProjectPath: () => Promise<GetProjectPathResponse>;
 };
 export default cbproject;

package/modules/project.js

@@ -18,7 +18,7 @@ const cbproject = {
     },
     /**
      * Retrieves the path of the current project.
-     * @returns {Promise<any>} A promise that resolves with the project path response.
+     * @returns {Promise<GetProjectPathResponse>} A promise that resolves with the project path response.
      */
     getProjectPath: () => {
         return new Promise((resolve, reject) => {

package/modules/state.d.ts

@@ -1,10 +1,21 @@
-/**
- * Retrieves the application state asynchronously.
- * @returns {Promise<any>} A promise that resolves with the application state.
- */
+import { ApplicationState, AddToAgentStateResponse, GetAgentStateResponse } from '@codebolt/types';
 declare const cbstate: {
-    getApplicationState: () => Promise<any>;
-    addToAgentState: (key: string, value: string) => Promise<void>;
-    getAgentState: () => Promise<any>;
+    /**
+     * Retrieves the current application state from the server via WebSocket.
+     * @returns {Promise<ApplicationState>} A promise that resolves with the application state.
+     */
+    getApplicationState: () => Promise<ApplicationState>;
+    /**
+     * Adds a key-value pair to the agent's state on the server via WebSocket.
+     * @param {string} key - The key to add to the agent's state.
+     * @param {string} value - The value associated with the key.
+     * @returns {Promise<AddToAgentStateResponse>} A promise that resolves with the response to the addition request.
+     */
+    addToAgentState: (key: string, value: string) => Promise<AddToAgentStateResponse>;
+    /**
+     * Retrieves the current state of the agent from the server via WebSocket.
+     * @returns {Promise<GetAgentStateResponse>} A promise that resolves with the agent's state.
+     */
+    getAgentState: () => Promise<GetAgentStateResponse>;
 };
 export default cbstate;

package/modules/state.js

@@ -4,11 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const websocket_1 = __importDefault(require("./websocket"));
-/**
- * Retrieves the application state asynchronously.
- * @returns {Promise<any>} A promise that resolves with the application state.
- */
 const cbstate = {
+    /**
+     * Retrieves the current application state from the server via WebSocket.
+     * @returns {Promise<ApplicationState>} A promise that resolves with the application state.
+     */
     getApplicationState: async () => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
@@ -22,6 +22,12 @@ const cbstate = {
             });
         });
     },
+    /**
+     * Adds a key-value pair to the agent's state on the server via WebSocket.
+     * @param {string} key - The key to add to the agent's state.
+     * @param {string} value - The value associated with the key.
+     * @returns {Promise<AddToAgentStateResponse>} A promise that resolves with the response to the addition request.
+     */
     addToAgentState: async (key, value) => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
@@ -40,6 +46,10 @@ const cbstate = {
             });
         });
     },
+    /**
+     * Retrieves the current state of the agent from the server via WebSocket.
+     * @returns {Promise<GetAgentStateResponse>} A promise that resolves with the agent's state.
+     */
     getAgentState: async () => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({

package/modules/task.d.ts

@@ -5,18 +5,18 @@ declare const taskplaner: {
     /**
      * Adds a task using a WebSocket message.
      * @param {string} task - The task to be added.
-     * @returns {Promise<any>} A promise that resolves with the response from the add task event.
+     * @returns {Promise<AddTaskResponse>} A promise that resolves with the response from the add task event.
      */
     addTask: (task: string) => Promise<any>;
     /**
      * Retrieves all tasks using a WebSocket message.
-     * @returns {Promise<any>} A promise that resolves with the response from the get tasks event.
+     * @returns {Promise<GetTasksResponse>} A promise that resolves with the response from the get tasks event.
      */
     getTasks: () => Promise<any>;
     /**
      * Updates an existing task using a WebSocket message.
      * @param {string} task - The updated task information.
-     * @returns {Promise<any>} A promise that resolves with the response from the update task event.
+     * @returns {Promise<UpdateTasksResponse>} A promise that resolves with the response from the update task event.
      */
     updateTask: (task: string) => Promise<any>;
 };

package/modules/task.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const websocket_1 = __importDefault(require("./websocket"));
+// import {AddTaskResponse,GetTasksResponse,UpdateTasksResponse } from '@codebolt/types';
 /**
  * Manages task operations via WebSocket communication.
  */
@@ -11,7 +12,7 @@ const taskplaner = {
     /**
      * Adds a task using a WebSocket message.
      * @param {string} task - The task to be added.
-     * @returns {Promise<any>} A promise that resolves with the response from the add task event.
+     * @returns {Promise<AddTaskResponse>} A promise that resolves with the response from the add task event.
      */
     addTask: async (task) => {
         return new Promise((resolve, reject) => {
@@ -32,7 +33,7 @@ const taskplaner = {
     },
     /**
      * Retrieves all tasks using a WebSocket message.
-     * @returns {Promise<any>} A promise that resolves with the response from the get tasks event.
+     * @returns {Promise<GetTasksResponse>} A promise that resolves with the response from the get tasks event.
      */
     getTasks: async () => {
         return new Promise((resolve, reject) => {
@@ -51,7 +52,7 @@ const taskplaner = {
     /**
      * Updates an existing task using a WebSocket message.
      * @param {string} task - The updated task information.
-     * @returns {Promise<any>} A promise that resolves with the response from the update task event.
+     * @returns {Promise<UpdateTasksResponse>} A promise that resolves with the response from the update task event.
      */
     updateTask: async (task) => {
         return new Promise((resolve, reject) => {

package/modules/terminal.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
+import { CommandError, CommandOutput, TerminalInterruptResponse } from '@codebolt/types';
 /**
  * CustomEventEmitter class that extends the Node.js EventEmitter class.
  */
-export declare class CustomEventEmitter extends EventEmitter {
+declare class CustomEventEmitter extends EventEmitter {
 }
 /**
  * A module for executing commands in a terminal-like environment via WebSocket.
@@ -16,30 +17,30 @@ declare const cbterminal: {
      * of the executed command and resolves the promise accordingly.
      *
      * @param {string} command - The command to be executed.
-     * @returns {Promise<any>} A promise that resolves with the command's output, error, or finish signal.
+     * @returns {Promise<CommandOutput|CommandError>} A promise that resolves with the command's output, error, or finish signal.
      */
-    executeCommand: (command: string) => Promise<any>;
+    executeCommand: (command: string) => Promise<CommandOutput | CommandError>;
     /**
      * Executes a given command and keeps running until an error occurs.
      * Listens for messages from the WebSocket and resolves the promise when an error is encountered.
      *
      * @param {string} command - The command to be executed.
-     * @returns {Promise<any>} A promise that resolves when an error occurs during command execution.
+     * @returns {Promise<CommandError>} A promise that resolves when an error occurs during command execution.
      */
-    executeCommandRunUntilError: (command: string) => Promise<any>;
+    executeCommandRunUntilError: (command: string) => Promise<CommandError>;
     /**
      * Sends a manual interrupt signal to the terminal.
      *
-     * @returns {void}
+     * @returns {Promise<TerminalInterruptResponse>}
      */
-    sendManualInterrupt(): Promise<any>;
+    sendManualInterrupt(): Promise<TerminalInterruptResponse>;
     /**
      * Executes a given command and streams the output.
      * Listens for messages from the WebSocket and streams the output data.
      *
      * @param {string} command - The command to be executed.
-     * @returns {Promise<any>} A promise that streams the output data during command execution.
+     * @returns {EventEmitter} A promise that streams the output data during command execution.
      */
-    executeCommandWithStream(command: string): CustomEventEmitter;
+    executeCommandWithStream(command: string): EventEmitter;
 };
 export default cbterminal;

package/modules/terminal.js

@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomEventEmitter = void 0;
 const websocket_1 = __importDefault(require("./websocket"));
 const events_1 = require("events");
 /**
@@ -11,7 +10,6 @@ const events_1 = require("events");
  */
 class CustomEventEmitter extends events_1.EventEmitter {
 }
-exports.CustomEventEmitter = CustomEventEmitter;
 /**
  * A module for executing commands in a terminal-like environment via WebSocket.
  */
@@ -23,7 +21,7 @@ const cbterminal = {
      * of the executed command and resolves the promise accordingly.
      *
      * @param {string} command - The command to be executed.
-     * @returns {Promise<any>} A promise that resolves with the command's output, error, or finish signal.
+     * @returns {Promise<CommandOutput|CommandError>} A promise that resolves with the command's output, error, or finish signal.
      */
     executeCommand: async (command) => {
         return new Promise((resolve, reject) => {
@@ -44,7 +42,7 @@ const cbterminal = {
      * Listens for messages from the WebSocket and resolves the promise when an error is encountered.
      *
      * @param {string} command - The command to be executed.
-     * @returns {Promise<any>} A promise that resolves when an error occurs during command execution.
+     * @returns {Promise<CommandError>} A promise that resolves when an error occurs during command execution.
      */
     executeCommandRunUntilError: async (command) => {
         return new Promise((resolve, reject) => {
@@ -63,7 +61,7 @@ const cbterminal = {
     /**
      * Sends a manual interrupt signal to the terminal.
      *
-     * @returns {void}
+     * @returns {Promise<TerminalInterruptResponse>}
      */
     sendManualInterrupt() {
         return new Promise((resolve, reject) => {
@@ -83,7 +81,7 @@ const cbterminal = {
      * Listens for messages from the WebSocket and streams the output data.
      *
      * @param {string} command - The command to be executed.
-     * @returns {Promise<any>} A promise that streams the output data during command execution.
+     * @returns {EventEmitter} A promise that streams the output data during command execution.
      */
     executeCommandWithStream(command) {
         // Send the process started message