@codebolt/codeboltjs 1.0.4 → 1.0.5

package/index.d.ts

@@ -0,0 +1,164 @@
+/// <reference types="node" />
+import WebSocket from 'ws';
+/**
+ * @class Codebolt
+ * @description This class provides a unified interface to interact with various modules.
+ */
+declare class Codebolt {
+    /**
+     * @constructor
+     * @description Initializes the websocket connection.
+     */
+    constructor();
+    /**
+     * @method waitForConnection
+     * @description Waits for the WebSocket connection to open.
+     * @returns {Promise<void>} A promise that resolves when the WebSocket connection is open.
+     */
+    waitForConnection(): Promise<void>;
+    /**
+     * @method start_browser
+     * @description Starts a new browser page.
+     * @param {string} objective - The objective of the browser session.
+     * @param {string} url - The URL to navigate to.
+     * @param {string} previous_command - The previous command executed.
+     * @param {string} browser_content - The content of the browser.
+     */
+    start_browser(objective: string, url: string, previous_command: string, browser_content: string): void;
+    websocket: WebSocket | null;
+    fs: {
+        createFile: (fileName: string, source: string, filePath: string) => Promise<any>;
+        createFolder: (folderName: string, folderPath: string) => Promise<any>;
+        readFile: (filename: string, filePath: string) => Promise<any>;
+        updateFile: (filename: string, filePath: string, newContent: string) => Promise<any>;
+        deleteFile: (filename: string, filePath: string) => Promise<any>;
+        deleteFolder: (foldername: string, folderpath: string) => Promise<any>;
+    };
+    git: {
+        init: (path: string) => Promise<any>;
+        clone: (url: string, path: string) => Promise<any>;
+        pull: (path: string) => Promise<any>;
+        push: (path: string) => Promise<any>;
+        status: (path: string) => Promise<any>;
+        add: (path: string) => Promise<any>;
+        commit: (message: string) => Promise<any>;
+        checkout: (path: string, branch: string) => Promise<any>;
+        branch: (path: string, branch: string) => Promise<any>;
+        logs: (path: string) => Promise<any>;
+        diff: (commitHash: string, path: string) => Promise<any>;
+    };
+    llm: {
+        inference: (message: string, llmrole: string) => Promise<any>;
+    };
+    browser: {
+        newPage: () => void;
+        getUrl: () => Promise<unknown>;
+        goToPage: (url: string) => Promise<unknown>;
+        screenshot: () => void;
+        getHTML: () => Promise<unknown>;
+        getMarkdown: () => Promise<unknown>;
+        getPDF: () => void;
+        pdfToText: () => void;
+        getContent: () => void;
+        extractText: () => void;
+        close: () => void;
+        scroll: (direction: string, pixels: string) => Promise<unknown>;
+        type: (elementid: string, text: string) => Promise<unknown>;
+        click: (elementid: string) => Promise<unknown>;
+        enter: () => Promise<unknown>;
+        search: (elementid: string, query: string) => Promise<unknown>;
+    };
+    chat: {
+        eventEmitter: {
+            [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
+            addListener<K_1>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+            on<K_2>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+            once<K_3>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+            removeListener<K_4>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+            off<K_5>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+            removeAllListeners(eventName?: string | symbol | undefined): any;
+            setMaxListeners(n: number): any;
+            getMaxListeners(): number;
+            listeners<K_6>(eventName: string | symbol): Function[];
+            rawListeners<K_7>(eventName: string | symbol): Function[];
+            emit<K_8>(eventName: string | symbol, ...args: any[]): boolean;
+            listenerCount<K_9>(eventName: string | symbol, listener?: Function | undefined): number;
+            prependListener<K_10>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+            prependOnceListener<K_11>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+            eventNames(): (string | symbol)[];
+        };
+        sendMessage(message: string): void;
+        waitforReply(message: string): Promise<any>;
+        processStarted(): {
+            event: {
+                [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
+                addListener<K_1>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+                on<K_2>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+                once<K_3>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+                removeListener<K_4>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+                off<K_5>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+                removeAllListeners(eventName?: string | symbol | undefined): any;
+                setMaxListeners(n: number): any;
+                getMaxListeners(): number;
+                listeners<K_6>(eventName: string | symbol): Function[];
+                rawListeners<K_7>(eventName: string | symbol): Function[];
+                emit<K_8>(eventName: string | symbol, ...args: any[]): boolean;
+                listenerCount<K_9>(eventName: string | symbol, listener?: Function | undefined): number;
+                prependListener<K_10>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+                prependOnceListener<K_11>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+                eventNames(): (string | symbol)[];
+            };
+            stopProcess: () => void;
+        };
+    };
+    terminal: {
+        executeCommand: (command: string) => Promise<any>;
+    };
+    codeutils: {
+        getCodeTree: (fileName: any, source: any, filePath: any) => Promise<any>;
+    };
+    docutils: {
+        pdf_to_text: (pdf_path: any) => Promise<string>;
+    };
+    crawler: {
+        start: () => void;
+        screenshot: () => void;
+        goToPage: (url: string) => void;
+        scroll: (direction: string) => void;
+        click: (id: string) => Promise<unknown>;
+        type: (id: string, text: string) => Promise<unknown>;
+        enter: () => void;
+        crawl: () => void;
+    };
+    search: {
+        init: (engine?: string) => void;
+        search: (query: string) => Promise<string>;
+        get_first_link: (query: string) => Promise<string>;
+    };
+    knowledge: {};
+    rag: {
+        init: () => void;
+        add_file: (filename: string, file_path: string) => void;
+        retrieve_related_knowledge: (query: string, filename: string) => void;
+    };
+    codeparsers: {
+        getClassesInFile: (file: any) => void;
+        getFunctionsinClass: (file: any, className: any) => void;
+        getAstTreeInFile: (file: any, className: any) => void;
+    };
+    outputparsers: {
+        init: (output: any) => void;
+        parseErrors: (output: any) => string[];
+        parseWarnings: (output: any) => string[];
+    };
+    project: {
+        getProjectSettings: (output: any) => void;
+        getProjectPath: () => Promise<any>;
+    };
+    dbmemory: {
+        addKnowledge: (key: string, value: any) => Promise<any>;
+        getKnowledge: (key: string) => Promise<any>;
+    };
+}
+declare const _default: Codebolt;
+export default _default;

package/index.js

@@ -0,0 +1,88 @@
+"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("./modules/websocket"));
+const fs_1 = __importDefault(require("./modules/fs"));
+const llm_1 = __importDefault(require("./modules/llm"));
+const terminal_1 = __importDefault(require("./modules/terminal"));
+const browser_1 = __importDefault(require("./modules/browser"));
+const chat_1 = __importDefault(require("./modules/chat"));
+const codeutils_1 = __importDefault(require("./modules/codeutils"));
+const docutils_1 = __importDefault(require("./modules/docutils"));
+const crawler_1 = __importDefault(require("./modules/crawler"));
+const search_1 = __importDefault(require("./modules/search"));
+const knowledge_1 = __importDefault(require("./modules/knowledge"));
+const rag_1 = __importDefault(require("./modules/rag"));
+const codeparsers_1 = __importDefault(require("./modules/codeparsers"));
+const outputparsers_1 = __importDefault(require("./modules/outputparsers"));
+const project_1 = __importDefault(require("./modules/project"));
+const git_1 = __importDefault(require("./modules/git"));
+const dbmemory_1 = __importDefault(require("./modules/dbmemory"));
+const ws_1 = __importDefault(require("ws"));
+/**
+ * @class Codebolt
+ * @description This class provides a unified interface to interact with various modules.
+ */
+class Codebolt {
+    /**
+     * @constructor
+     * @description Initializes the websocket connection.
+     */
+    constructor() {
+        this.websocket = null;
+        this.fs = fs_1.default;
+        this.git = git_1.default;
+        this.llm = llm_1.default;
+        this.browser = browser_1.default;
+        this.chat = chat_1.default;
+        this.terminal = terminal_1.default;
+        this.codeutils = codeutils_1.default;
+        this.docutils = docutils_1.default;
+        this.crawler = crawler_1.default;
+        this.search = search_1.default;
+        this.knowledge = knowledge_1.default;
+        this.rag = rag_1.default;
+        this.codeparsers = codeparsers_1.default;
+        this.outputparsers = outputparsers_1.default;
+        this.project = project_1.default;
+        this.dbmemory = dbmemory_1.default;
+        this.websocket = websocket_1.default.getWebsocket;
+    }
+    /**
+     * @method waitForConnection
+     * @description Waits for the WebSocket connection to open.
+     * @returns {Promise<void>} A promise that resolves when the WebSocket connection is open.
+     */
+    async waitForConnection() {
+        return new Promise((resolve, reject) => {
+            if (!this.websocket) {
+                reject(new Error('WebSocket is not initialized'));
+                return;
+            }
+            if (this.websocket.readyState === ws_1.default.OPEN) {
+                resolve();
+                return;
+            }
+            this.websocket.addEventListener('open', () => {
+                resolve();
+            });
+            this.websocket.addEventListener('error', (error) => {
+                reject(error);
+            });
+        });
+    }
+    /**
+     * @method start_browser
+     * @description Starts a new browser page.
+     * @param {string} objective - The objective of the browser session.
+     * @param {string} url - The URL to navigate to.
+     * @param {string} previous_command - The previous command executed.
+     * @param {string} browser_content - The content of the browser.
+     */
+    start_browser(objective, url, previous_command, browser_content) {
+        browser_1.default.newPage();
+    }
+}
+exports.default = new Codebolt();

package/modules/browser.d.ts

@@ -0,0 +1,87 @@
+/**
+ * A module for interacting with a browser through WebSockets.
+ */
+declare const cbbrowser: {
+    /**
+     * Opens a new page in the browser.
+     */
+    newPage: () => void;
+    /**
+     * Retrieves the current URL of the browser's active page.
+     * @returns {Promise<any>} A promise that resolves with the URL.
+     */
+    getUrl: () => Promise<unknown>;
+    /**
+     * Navigates to a specified URL.
+     * @param {string} url - The URL to navigate to.
+     * @returns {Promise<any>} A promise that resolves when navigation is complete.
+     */
+    goToPage: (url: string) => Promise<unknown>;
+    /**
+     * Takes a screenshot of the current page.
+     */
+    screenshot: () => void;
+    /**
+     * Retrieves the HTML content of the current page.
+     * @returns {Promise<string>} A promise that resolves with the HTML content.
+     */
+    getHTML: () => Promise<unknown>;
+    /**
+     * Retrieves the Markdown content of the current page.
+     * @returns {Promise<any>} A promise that resolves with the Markdown content.
+     */
+    getMarkdown: () => Promise<unknown>;
+    /**
+     * Retrieves the PDF content of the current page.
+     */
+    getPDF: () => void;
+    /**
+     * Converts the PDF content of the current page to text.
+     */
+    pdfToText: () => void;
+    /**
+     * Retrieves the content of the current page.
+     */
+    getContent: () => void;
+    /**
+     * Extracts text from the current page.
+     */
+    extractText: () => void;
+    /**
+     * Closes the current page.
+     */
+    close: () => void;
+    /**
+     * Scrolls the current page in a specified direction by a specified number of pixels.
+     * @param {string} direction - The direction to scroll.
+     * @param {string} pixels - The number of pixels to scroll.
+     * @returns {Promise<any>} A promise that resolves when the scroll action is complete.
+     */
+    scroll: (direction: string, pixels: string) => Promise<unknown>;
+    /**
+     * Types text into a specified element on the page.
+     * @param {string} elementid - The ID of the element to type into.
+     * @param {string} text - The text to type.
+     * @returns {Promise<any>} A promise that resolves when the typing action is complete.
+     */
+    type: (elementid: string, text: string) => Promise<unknown>;
+    /**
+     * Clicks on a specified element on the page.
+     * @param {string} elementid - The ID of the element to click.
+     * @returns {Promise<any>} A promise that resolves when the click action is complete.
+     */
+    click: (elementid: string) => Promise<unknown>;
+    /**
+     * Simulates the Enter key press on the current page.
+     * @returns {Promise<any>} A promise that resolves when the Enter action is complete.
+     */
+    enter: () => Promise<unknown>;
+    /**
+     * Performs a search on the current page using a specified query.
+     * @param {string} elementid - The ID of the element to perform the search in.
+     * @param {string} query - The search query.
+     * @returns {Promise<any>} A promise that resolves with the search results.
+     */
+    search: (elementid: string, query: string) => Promise<unknown>;
+};
+export default cbbrowser;

package/modules/browser.js

@@ -0,0 +1,253 @@
+"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 interacting with a browser through WebSockets.
+ */
+const cbbrowser = {
+    /**
+     * Opens a new page in the browser.
+     */
+    newPage: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "browserEvent",
+            action: 'newPage'
+        }));
+    },
+    /**
+     * Retrieves the current URL of the browser's active page.
+     * @returns {Promise<any>} A promise that resolves with the URL.
+     */
+    getUrl: () => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'getUrl'
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "getUrlResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Navigates to a specified URL.
+     * @param {string} url - The URL to navigate to.
+     * @returns {Promise<any>} A promise that resolves when navigation is complete.
+     */
+    goToPage: (url) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'goToPage',
+                url
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "goToPageResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Takes a screenshot of the current page.
+     */
+    screenshot: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "browserEvent",
+            action: 'screenshot'
+        }));
+    },
+    /**
+     * Retrieves the HTML content of the current page.
+     * @returns {Promise<string>} A promise that resolves with the HTML content.
+     */
+    getHTML: () => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'getHTML'
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "htmlReceived") {
+                    resolve(response.htmlResponse);
+                }
+            });
+        });
+    },
+    /**
+     * Retrieves the Markdown content of the current page.
+     * @returns {Promise<any>} A promise that resolves with the Markdown content.
+     */
+    getMarkdown: () => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'getMarkdown'
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "getMarkdownResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Retrieves the PDF content of the current page.
+     */
+    getPDF: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "browserEvent",
+            action: 'getPDF'
+        }));
+    },
+    /**
+     * Converts the PDF content of the current page to text.
+     */
+    pdfToText: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "browserEvent",
+            action: 'pdfToText'
+        }));
+    },
+    /**
+     * Retrieves the content of the current page.
+     */
+    getContent: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "browserEvent",
+            action: 'getContent'
+        }));
+    },
+    /**
+     * Extracts text from the current page.
+     */
+    extractText: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "browserEvent",
+            action: 'extractText'
+        }));
+    },
+    /**
+     * Closes the current page.
+     */
+    close: () => {
+        websocket_1.default.getWebsocket.send(JSON.stringify({
+            "type": "browserEvent",
+            action: 'close'
+        }));
+    },
+    /**
+     * Scrolls the current page in a specified direction by a specified number of pixels.
+     * @param {string} direction - The direction to scroll.
+     * @param {string} pixels - The number of pixels to scroll.
+     * @returns {Promise<any>} A promise that resolves when the scroll action is complete.
+     */
+    scroll: (direction, pixels) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'scroll',
+                direction,
+                pixels
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "scrollResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Types text into a specified element on the page.
+     * @param {string} elementid - The ID of the element to type into.
+     * @param {string} text - The text to type.
+     * @returns {Promise<any>} A promise that resolves when the typing action is complete.
+     */
+    type: (elementid, text) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'type',
+                text,
+                elementid
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "typeResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Clicks on a specified element on the page.
+     * @param {string} elementid - The ID of the element to click.
+     * @returns {Promise<any>} A promise that resolves when the click action is complete.
+     */
+    click: (elementid) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'click',
+                elementid
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "clickResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Simulates the Enter key press on the current page.
+     * @returns {Promise<any>} A promise that resolves when the Enter action is complete.
+     */
+    enter: () => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'enter'
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "EnterResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    },
+    /**
+     * Performs a search on the current page using a specified query.
+     * @param {string} elementid - The ID of the element to perform the search in.
+     * @param {string} query - The search query.
+     * @returns {Promise<any>} A promise that resolves with the search results.
+     */
+    search: (elementid, query) => {
+        return new Promise((resolve, reject) => {
+            websocket_1.default.getWebsocket.send(JSON.stringify({
+                "type": "browserEvent",
+                action: 'search',
+                elementid,
+                query
+            }));
+            websocket_1.default.getWebsocket.on('message', (data) => {
+                const response = JSON.parse(data);
+                if (response.event === "searchResponse") {
+                    resolve(response);
+                }
+            });
+        });
+    }
+};
+exports.default = cbbrowser;

package/modules/chat.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+/**
+ * CustomEventEmitter class that extends the Node.js EventEmitter class.
+ */
+declare class CustomEventEmitter extends EventEmitter {
+}
+/**
+ * Chat module to interact with the WebSocket server.
+ */
+declare const cbchat: {
+    eventEmitter: CustomEventEmitter;
+    /**
+     * Sends a message through the WebSocket connection.
+     * @param {string} message - The message to be sent.
+     */
+    sendMessage(message: string): void;
+    /**
+     * 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: string): Promise<any>;
+    /**
+     * 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(): {
+        event: CustomEventEmitter;
+        stopProcess: () => void;
+    };
+};
+export default cbchat;