@codebolt/codeboltjs 1.0.4 → 1.0.5

package/modules/chat.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// chat.ts
+const websocket_1 = __importDefault(require("./websocket"));
+const events_1 = require("events");
+/**
+ * CustomEventEmitter class that extends the Node.js EventEmitter class.
+ */
+class CustomEventEmitter extends events_1.EventEmitter {
+}
+/**
+ * Chat module to interact with the WebSocket server.
+ */
+const cbchat = {
+    eventEmitter: new CustomEventEmitter(),
+    /**
+     * Sends a message through the WebSocket connection.
+     * @param {string} message - The message to be sent.
+     */
+    sendMessage(message) {
+        console.log(message);
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "sendMessage",
+            "message": message
+        }));
+    },
+    /**
+     * Waits for a reply to a sent message.
+     * @param {string} message - The message for which a reply is expected.
+     * @returns {Promise<any>} A promise that resolves with the reply.
+     */
+    waitforReply(message) {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "waitforReply",
+                "message": message
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "messageResponse") {
+                    resolve(response); // Resolve the Promise with the response data
+                }
+            });
+        });
+    },
+    /**
+     * Notifies the server that a process has started and sets up an event listener for stopProcessClicked events.
+     * @returns An object containing the event emitter and a stopProcess method.
+     */
+    processStarted() {
+        // Send the process started message
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "processStarted"
+        }));
+        // Register event listener for WebSocket messages
+        websocket_1.default.getWebsocket.on('message', (data) => {
+            const message = JSON.parse(data);
+            console.log("Received message:", message);
+            if (message.type === 'stopProcessClicked')
+                // Emit a custom event based on the message type
+                this.eventEmitter.emit("stopProcessClicked", message);
+        });
+        // Return an object that includes the event emitter and the stopProcess method
+        return {
+            event: this.eventEmitter,
+            stopProcess: () => {
+                // Implement the logic to stop the process here
+                console.log("Stopping process...");
+                // For example, you might want to send a specific message to the server to stop the process
+                websocket_1.default.getWebsocket.send(JSON.stringify({
+                    "type": "processStoped"
+                }));
+            }
+        };
+    }
+};
+exports.default = cbchat;

package/modules/codeparsers.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A collection of code parser functions.
+ */
+declare const cbcodeparsers: {
+    /**
+     * Retrieves the classes in a given file.
+     * @param file The file to parse for classes.
+     */
+    getClassesInFile: (file: any) => void;
+    /**
+     * Retrieves the functions in a given class within a file.
+     * @param file The file containing the class.
+     * @param className The name of the class to parse for functions.
+     */
+    getFunctionsinClass: (file: any, className: any) => void;
+    /**
+     * Generates an Abstract Syntax Tree (AST) for a given file.
+     * @param file The file to generate an AST for.
+     * @param className The name of the class to focus the AST generation on.
+     */
+    getAstTreeInFile: (file: any, className: any) => void;
+};
+export default cbcodeparsers;

package/modules/codeparsers.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A collection of code parser functions.
+ */
+const cbcodeparsers = {
+    /**
+     * Retrieves the classes in a given file.
+     * @param file The file to parse for classes.
+     */
+    getClassesInFile: (file) => {
+        console.log('Code parsers initialized');
+    },
+    /**
+     * Retrieves the functions in a given class within a file.
+     * @param file The file containing the class.
+     * @param className The name of the class to parse for functions.
+     */
+    getFunctionsinClass: (file, className) => {
+        console.log('Code parsers initialized');
+    },
+    /**
+     * Generates an Abstract Syntax Tree (AST) for a given file.
+     * @param file The file to generate an AST for.
+     * @param className The name of the class to focus the AST generation on.
+     */
+    getAstTreeInFile: (file, className) => {
+    }
+};
+exports.default = cbcodeparsers;

package/modules/codeutils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A utility module for working with code.
+ */
+declare const cbcodeutils: {
+    /**
+     * Asynchronously generates a code tree from the provided source code.
+     * @param {any} fileName - The name of the file.
+     * @param {any} source - The source code to generate the tree from.
+     * @param {any} filePath - The file path where the source code is located.
+     * @returns {Promise<any>} A promise that resolves with the code tree.
+     */
+    getCodeTree: (fileName: any, source: any, filePath: any) => Promise<any>;
+};
+export default cbcodeutils;

package/modules/codeutils.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A utility module for working with code.
+ */
+const cbcodeutils = {
+    /**
+     * Asynchronously generates a code tree from the provided source code.
+     * @param {any} fileName - The name of the file.
+     * @param {any} source - The source code to generate the tree from.
+     * @param {any} filePath - The file path where the source code is located.
+     * @returns {Promise<any>} A promise that resolves with the code tree.
+     */
+    getCodeTree: (fileName, source, filePath) => {
+        return new Promise((resolve, reject) => {
+            // Implementation would go here
+        });
+    }
+};
+exports.default = cbcodeutils;

package/modules/crawler.d.ts

@@ -0,0 +1,45 @@
+/**
+ * A module for controlling a web crawler through WebSocket messages.
+ */
+declare const cbcrawler: {
+    /**
+     * Starts the crawler.
+     */
+    start: () => void;
+    /**
+     * Takes a screenshot using the crawler.
+     */
+    screenshot: () => void;
+    /**
+     * Directs the crawler to navigate to a specified URL.
+     * @param url - The URL for the crawler to navigate to.
+     */
+    goToPage: (url: string) => void;
+    /**
+     * Scrolls the crawler in a specified direction.
+     * @param direction - The direction to scroll ('up', 'down', 'left', 'right').
+     */
+    scroll: (direction: string) => void;
+    /**
+     * Simulates a click event on an element with the specified ID.
+     * @param id - The ID of the element to be clicked.
+     * @returns {Promise<any>} A promise that resolves when the click action is complete.
+     */
+    click: (id: string) => Promise<unknown>;
+    /**
+     * Types the provided text into an element with the specified ID.
+     * @param id - The ID of the element where text will be typed.
+     * @param text - The text to type into the element.
+     * @returns {Promise<any>} A promise that resolves when the type action is complete.
+     */
+    type: (id: string, text: string) => Promise<unknown>;
+    /**
+     * Simulates the Enter key press using the crawler.
+     */
+    enter: () => void;
+    /**
+     * Initiates a crawl process.
+     */
+    crawl: () => void;
+};
+export default cbcrawler;

package/modules/crawler.js

@@ -0,0 +1,112 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const websocket_1 = __importDefault(require("./websocket"));
+/**
+ * A module for controlling a web crawler through WebSocket messages.
+ */
+const cbcrawler = {
+    /**
+     * Starts the crawler.
+     */
+    start: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "crawlerEvent",
+            action: 'start'
+        }));
+    },
+    /**
+     * Takes a screenshot using the crawler.
+     */
+    screenshot: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "crawlerEvent",
+            action: 'screenshot'
+        }));
+    },
+    /**
+     * Directs the crawler to navigate to a specified URL.
+     * @param url - The URL for the crawler to navigate to.
+     */
+    goToPage: (url) => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "crawlerEvent",
+            action: 'goToPage',
+            url
+        }));
+    },
+    /**
+     * Scrolls the crawler in a specified direction.
+     * @param direction - The direction to scroll ('up', 'down', 'left', 'right').
+     */
+    scroll: (direction) => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "crawlerEvent",
+            action: 'scroll',
+            direction
+        }));
+    },
+    /**
+     * Simulates a click event on an element with the specified ID.
+     * @param id - The ID of the element to be clicked.
+     * @returns {Promise<any>} A promise that resolves when the click action is complete.
+     */
+    click: (id) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "crawlerEvent",
+                action: 'click',
+                id
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "clickFinished") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Types the provided text into an element with the specified ID.
+     * @param id - The ID of the element where text will be typed.
+     * @param text - The text to type into the element.
+     * @returns {Promise<any>} A promise that resolves when the type action is complete.
+     */
+    type: (id, text) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "crawlerEvent",
+                action: 'type',
+                id,
+                text
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "typeFinished") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Simulates the Enter key press using the crawler.
+     */
+    enter: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "crawlerEvent",
+            action: 'enter'
+        }));
+    },
+    /**
+     * Initiates a crawl process.
+     */
+    crawl: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "crawlerEvent",
+            action: 'crawl'
+        }));
+    }
+};
+exports.default = cbcrawler;

package/modules/dbmemory.d.ts

@@ -0,0 +1,19 @@
+/**
+ * A module for handling in-memory database operations via WebSocket.
+ */
+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.
+     */
+    addKnowledge: (key: string, value: any) => Promise<any>;
+    /**
+     * 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.
+     */
+    getKnowledge: (key: string) => Promise<any>;
+};
+export default dbmemory;

package/modules/dbmemory.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const websocket_1 = __importDefault(require("./websocket"));
+/**
+ * A module for handling in-memory database operations via WebSocket.
+ */
+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.
+     */
+    addKnowledge: (key, value) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "memoryEvent",
+                'action': 'set',
+                key,
+                value
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "memorySetResponse") {
+                    resolve(response); // Resolve the Promise with the response data
+                }
+            });
+        });
+    },
+    /**
+     * 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.
+     */
+    getKnowledge: (key) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "memoryEvent",
+                'action': 'get',
+                key
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "memoryGetResponse") {
+                    resolve(response); // Resolve the Promise with the response data
+                }
+            });
+        });
+    }
+};
+exports.default = dbmemory;

package/modules/docutils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A module for document utility functions.
+ */
+declare const cbdocutils: {
+    /**
+     * Converts a PDF document to text.
+     * @param pdf_path - The file path to the PDF document to be converted.
+     * @returns {Promise<string>} A promise that resolves with the converted text.
+     */
+    pdf_to_text: (pdf_path: any) => Promise<string>;
+};
+export default cbdocutils;

package/modules/docutils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A module for document utility functions.
+ */
+const cbdocutils = {
+    /**
+     * Converts a PDF document to text.
+     * @param pdf_path - The file path to the PDF document to be converted.
+     * @returns {Promise<string>} A promise that resolves with the converted text.
+     */
+    pdf_to_text: (pdf_path) => {
+        // Implementation would go here
+        return new Promise((resolve, reject) => {
+            // PDF to text conversion logic
+        });
+    }
+};
+exports.default = cbdocutils;

package/modules/fs.d.ts

@@ -0,0 +1,57 @@
+/**
+ * @module cbfs
+ * @description This module provides functionality to interact with the filesystem.
+ */
+declare const cbfs: {
+    /**
+     * @function createFile
+     * @description Creates a new file.
+     * @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.
+     */
+    createFile: (fileName: string, source: string, filePath: string) => Promise<any>;
+    /**
+     * @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.
+     */
+    createFolder: (folderName: string, folderPath: string) => Promise<any>;
+    /**
+     * @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.
+     */
+    readFile: (filename: string, filePath: string) => Promise<any>;
+    /**
+     * @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.
+     */
+    updateFile: (filename: string, filePath: string, newContent: string) => Promise<any>;
+    /**
+     * @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.
+     */
+    deleteFile: (filename: string, filePath: string) => Promise<any>;
+    /**
+     * @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.
+     */
+    deleteFolder: (foldername: string, folderpath: string) => Promise<any>;
+};
+export default cbfs;

package/modules/fs.js

@@ -0,0 +1,167 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const websocket_1 = __importDefault(require("./websocket"));
+/**
+ * @module cbfs
+ * @description This module provides functionality to interact with the filesystem.
+ */
+const cbfs = {
+    /**
+     * @function createFile
+     * @description Creates a new file.
+     * @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.
+     */
+    createFile: (fileName, source, filePath) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "fsEvent",
+                "action": "createFile",
+                "message": {
+                    fileName,
+                    source,
+                    filePath
+                },
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "createFileResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * @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.
+     */
+    createFolder: (folderName, folderPath) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "fsEvent",
+                "action": "createFolder",
+                "message": {
+                    folderName,
+                    folderPath
+                },
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "createFolderResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * @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.
+     */
+    readFile: (filename, filePath) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "fsEvent",
+                "action": "readFile",
+                "message": {
+                    filename,
+                    filePath
+                },
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "readFileResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * @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.
+     */
+    updateFile: (filename, filePath, newContent) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "fsEvent",
+                "action": "updateFile",
+                "message": {
+                    filename,
+                    filePath,
+                    newContent
+                },
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "commandOutput") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * @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.
+     */
+    deleteFile: (filename, filePath) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "fsEvent",
+                "action": "deleteFile",
+                "message": {
+                    filename,
+                    filePath
+                },
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "deleteFileResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * @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.
+     */
+    deleteFolder: (foldername, folderpath) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "fsEvent",
+                "action": "deleteFolder",
+                "message": {
+                    foldername,
+                    folderpath
+                },
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.type === "deleteFolderResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    }
+};
+exports.default = cbfs;