@codebolt/codeboltjs 1.1.30 → 1.1.32

package/index.d.ts

@@ -1,8 +1,6 @@
 /// <reference types="node" />
 import WebSocket from 'ws';
 import { EventEmitter } from 'events';
-export declare class CustomEventEmitter extends EventEmitter {
-}
 /**
  * @class Codebolt
  * @description This class provides a unified interface to interact with various modules.
@@ -13,35 +11,21 @@ declare class Codebolt {
      * @description Initializes the websocket connection.
      */
     constructor();
-    /**
-         * @method setupMessageListener
-         * @description Sets up a listener for incoming WebSocket messages.
-         */
-    userMessageListener(): CustomEventEmitter | undefined;
     /**
      * @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>;
-        listFile: (folderPath?: string | undefined) => void;
+        createFile: (fileName: string, source: string, filePath: string) => Promise<import("@codebolt/types").CreateFileResponse>;
+        createFolder: (folderName: string, folderPath: string) => Promise<import("@codebolt/types").CreateFolderResponse>;
+        readFile: (filename: string, filePath: string) => Promise<import("@codebolt/types").ReadFileResponse>;
+        updateFile: (filename: string, filePath: string, newContent: string) => Promise<import("@codebolt/types").UpdateFileResponse>;
+        deleteFile: (filename: string, filePath: string) => Promise<import("@codebolt/types").DeleteFileResponse>;
+        deleteFolder: (foldername: string, folderpath: string) => Promise<import("@codebolt/types").DeleteFolderResponse>;
+        listFile: (filePath: string) => Promise<unknown>;
     };
     git: {
         init: (path: string) => Promise<any>;
@@ -57,15 +41,15 @@ declare class Codebolt {
         diff: (commitHash: string, path: string) => Promise<any>;
     };
     llm: {
-        inference: (message: string, llmrole: string) => Promise<any>;
+        inference: (message: string, llmrole: string) => Promise<import("@codebolt/types").LLMResponse>;
     };
     browser: {
         newPage: () => void;
-        getUrl: () => Promise<unknown>;
-        goToPage: (url: string) => Promise<unknown>;
+        getUrl: () => Promise<import("@codebolt/types").UrlResponse>;
+        goToPage: (url: string) => Promise<import("@codebolt/types").GoToPageResponse>;
         screenshot: () => void;
-        getHTML: () => Promise<unknown>;
-        getMarkdown: () => Promise<unknown>;
+        getHTML: () => Promise<import("@codebolt/types").HtmlReceived>;
+        getMarkdown: () => Promise<import("@codebolt/types").GetMarkdownResponse>;
         getPDF: () => void;
         pdfToText: () => void;
         getContent: () => void;
@@ -78,30 +62,83 @@ declare class Codebolt {
         search: (elementid: string, query: string) => Promise<unknown>;
     };
     chat: {
-        eventEmitter: import("./modules/chat").CustomEventEmitter;
-        getChatHistory(): Promise<unknown>;
-        sendMessage(message: string): void;
-        waitforReply(message: string): Promise<any>;
-        processStarted(): {
-            event: import("./modules/chat").CustomEventEmitter;
+        getChatHistory: () => Promise<import("@codebolt/types").ChatMessage[]>;
+        userMessageListener: () => {
+            [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)[];
+        } | undefined;
+        sendMessage: (message: string) => void;
+        waitforReply: (message: string) => Promise<string>;
+        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;
         };
         stopProcess: () => void;
     };
     terminal: {
-        eventEmitter: import("./modules/terminal").CustomEventEmitter;
-        executeCommand: (command: string) => Promise<any>;
-        executeCommandRunUntilError: (command: string) => Promise<any>;
-        sendManualInterrupt(): Promise<any>;
-        executeCommandWithStream(command: string): import("./modules/terminal").CustomEventEmitter;
+        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)[];
+        };
+        executeCommand: (command: string) => Promise<import("@codebolt/types").CommandOutput | import("@codebolt/types").CommandError>;
+        executeCommandRunUntilError: (command: string) => Promise<import("@codebolt/types").CommandError>;
+        sendManualInterrupt(): Promise<import("@codebolt/types").TerminalInterruptResponse>;
+        executeCommandWithStream(command: string): EventEmitter<[never]>;
     };
     codeutils: {
-        getCodeTree: () => Promise<any>;
-        getJsTree: (filePath: string) => Promise<any>;
-        getAllFilesAsMarkDown: () => Promise<unknown>;
-        performMatch: (matcherDefinition: object, problemPatterns: [], problems: []) => Promise<unknown>;
-        getMatcherList: () => Promise<unknown>;
-        matchDetail: (matcher: string) => Promise<unknown>;
+        getJsTree: (filePath: string) => Promise<import("@codebolt/types").GetJsTreeResponse>; /**
+         * @constructor
+         * @description Initializes the websocket connection.
+         */
+        getAllFilesAsMarkDown: () => Promise<string>;
+        performMatch: (matcherDefinition: object, problemPatterns: any[], problems: any[]) => Promise<import("@codebolt/types").MatchProblemResponse>;
+        getMatcherList: () => Promise<import("@codebolt/types").GetMatcherListTreeResponse>;
+        matchDetail: (matcher: string) => Promise<import("@codebolt/types").getMatchDetail>;
     };
     docutils: {
         pdf_to_text: (pdf_path: any) => Promise<string>;
@@ -139,16 +176,16 @@ declare class Codebolt {
     };
     project: {
         getProjectSettings: (output: any) => void;
-        getProjectPath: () => Promise<any>;
+        getProjectPath: () => Promise<import("@codebolt/types").GetProjectPathResponse>;
     };
     dbmemory: {
-        addKnowledge: (key: string, value: any) => Promise<any>;
-        getKnowledge: (key: string) => Promise<any>;
+        addKnowledge: (key: string, value: any) => Promise<import("@codebolt/types").MemorySetResponse>;
+        getKnowledge: (key: string) => Promise<import("@codebolt/types").MemoryGetResponse>;
     };
     cbstate: {
-        getApplicationState: () => Promise<any>;
-        addToAgentState: (key: string, value: string) => Promise<void>;
-        getAgentState: () => Promise<any>;
+        getApplicationState: () => Promise<import("@codebolt/types").ApplicationState>;
+        addToAgentState: (key: string, value: string) => Promise<import("@codebolt/types").AddToAgentStateResponse>;
+        getAgentState: () => Promise<import("@codebolt/types").GetAgentStateResponse>;
     };
     taskplaner: {
         addTask: (task: string) => Promise<any>;
@@ -156,16 +193,17 @@ declare class Codebolt {
         updateTask: (task: string) => Promise<any>;
     };
     vectordb: {
-        getVector: (key: string) => Promise<any>;
-        addVectorItem: (item: any) => Promise<any>;
-        queryVectorItem: (key: string) => Promise<any>;
+        getVector: (key: string) => Promise<import("@codebolt/types").GetVectorResponse>;
+        addVectorItem: (item: any) => Promise<import("@codebolt/types").AddVectorItemResponse>;
+        queryVectorItem: (key: string) => Promise<import("@codebolt/types").QueryVectorItemResponse>;
     };
     debug: {
-        debug(log: string, type: import("./modules/debug").logType): Promise<unknown>;
-        openDebugBrowser(url: string, port: number): Promise<unknown>;
+        debug: (log: string, type: import("./modules/debug").logType) => Promise<import("@codebolt/types").DebugAddLogResponse>;
+        openDebugBrowser: (url: string, port: number) => Promise<import("@codebolt/types").OpenDebugBrowserResponse>;
     };
     tokenizer: {
-        addToken: (key: string) => Promise<any>;
+        addToken: (key: string) => Promise<import("@codebolt/types").AddTokenResponse>;
+        getToken: (key: string) => Promise<import("@codebolt/types").GetTokenResponse>;
     };
 }
 declare const _default: Codebolt;

package/index.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("./modules/websocket"));
 const fs_1 = __importDefault(require("./modules/fs"));
 const llm_1 = __importDefault(require("./modules/llm"));
@@ -27,11 +26,6 @@ const vectordb_1 = __importDefault(require("./modules/vectordb"));
 const debug_1 = __importDefault(require("./modules/debug"));
 const tokenizer_1 = __importDefault(require("./modules/tokenizer"));
 const ws_1 = __importDefault(require("ws"));
-const events_1 = require("events");
-class CustomEventEmitter extends events_1.EventEmitter {
-}
-exports.CustomEventEmitter = CustomEventEmitter;
-let eventEmitter = new CustomEventEmitter();
 /**
  * @class Codebolt
  * @description This class provides a unified interface to interact with various modules.
@@ -66,21 +60,6 @@ class Codebolt {
         this.tokenizer = tokenizer_1.default;
         this.websocket = websocket_1.default.getWebsocket;
     }
-    /**
-         * @method setupMessageListener
-         * @description Sets up a listener for incoming WebSocket messages.
-         */
-    userMessageListener() {
-        if (!this.websocket)
-            return;
-        this.websocket.on('message', (data) => {
-            const response = JSON.parse(data);
-            if (response.type === "messageResponse") {
-                eventEmitter.emit("userMessage", response.response);
-            }
-        });
-        return eventEmitter;
-    }
     /**
      * @method waitForConnection
      * @description Waits for the WebSocket connection to open.
@@ -104,17 +83,6 @@ class Codebolt {
             });
         });
     }
-    /**
-     * @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();
 // module.exports = new Codebolt();

package/modules/browser.d.ts

@@ -1,3 +1,4 @@
+import { GoToPageResponse, UrlResponse, GetMarkdownResponse, HtmlReceived } from '@codebolt/types';
 /**
  * A module for interacting with a browser through WebSockets.
  */
@@ -8,29 +9,29 @@ declare const cbbrowser: {
     newPage: () => void;
     /**
      * Retrieves the current URL of the browser's active page.
-     * @returns {Promise<any>} A promise that resolves with the URL.
+     * @returns {Promise<UrlResponse>} A promise that resolves with the URL.
      */
-    getUrl: () => Promise<unknown>;
+    getUrl: () => Promise<UrlResponse>;
     /**
      * Navigates to a specified URL.
      * @param {string} url - The URL to navigate to.
-     * @returns {Promise<any>} A promise that resolves when navigation is complete.
+     * @returns {Promise<GoToPageResponse>} A promise that resolves when navigation is complete.
      */
-    goToPage: (url: string) => Promise<unknown>;
+    goToPage: (url: string) => Promise<GoToPageResponse>;
     /**
      * 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.
+     * @returns {Promise<HtmlReceived>} A promise that resolves with the HTML content.
      */
-    getHTML: () => Promise<unknown>;
+    getHTML: () => Promise<HtmlReceived>;
     /**
      * Retrieves the Markdown content of the current page.
-     * @returns {Promise<any>} A promise that resolves with the Markdown content.
+     * @returns {Promise<GetMarkdownResponse>} A promise that resolves with the Markdown content.
      */
-    getMarkdown: () => Promise<unknown>;
+    getMarkdown: () => Promise<GetMarkdownResponse>;
     /**
      * Retrieves the PDF content of the current page.
      */
@@ -85,3 +86,9 @@ declare const cbbrowser: {
     search: (elementid: string, query: string) => Promise<unknown>;
 };
 export default cbbrowser;
+/***
+
+start_browser(objective: string, url: string, previous_command: string, browser_content: string) {
+    cbbrowser.newPage();
+}
+ */ 

package/modules/browser.js

@@ -19,7 +19,7 @@ const cbbrowser = {
     },
     /**
      * Retrieves the current URL of the browser's active page.
-     * @returns {Promise<any>} A promise that resolves with the URL.
+     * @returns {Promise<UrlResponse>} A promise that resolves with the URL.
      */
     getUrl: () => {
         return new Promise((resolve, reject) => {
@@ -38,7 +38,7 @@ const cbbrowser = {
     /**
      * Navigates to a specified URL.
      * @param {string} url - The URL to navigate to.
-     * @returns {Promise<any>} A promise that resolves when navigation is complete.
+     * @returns {Promise<GoToPageResponse>} A promise that resolves when navigation is complete.
      */
     goToPage: (url) => {
         return new Promise((resolve, reject) => {
@@ -66,7 +66,7 @@ const cbbrowser = {
     },
     /**
      * Retrieves the HTML content of the current page.
-     * @returns {Promise<string>} A promise that resolves with the HTML content.
+     * @returns {Promise<HtmlReceived>} A promise that resolves with the HTML content.
      */
     getHTML: () => {
         return new Promise((resolve, reject) => {
@@ -84,7 +84,7 @@ const cbbrowser = {
     },
     /**
      * Retrieves the Markdown content of the current page.
-     * @returns {Promise<any>} A promise that resolves with the Markdown content.
+     * @returns {Promise<GetMarkdownResponse>} A promise that resolves with the Markdown content.
      */
     getMarkdown: () => {
         return new Promise((resolve, reject) => {
@@ -251,3 +251,9 @@ const cbbrowser = {
     }
 };
 exports.default = cbbrowser;
+/***
+
+start_browser(objective: string, url: string, previous_command: string, browser_content: string) {
+    cbbrowser.newPage();
+}
+ */ 

package/modules/chat.d.ts

@@ -1,35 +1,48 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
+import { ChatMessage } from '@codebolt/types';
 /**
  * CustomEventEmitter class that extends the Node.js EventEmitter class.
  */
-export declare class CustomEventEmitter extends EventEmitter {
+declare class CustomEventEmitter extends EventEmitter {
 }
 /**
  * Chat module to interact with the WebSocket server.
  */
 declare const cbchat: {
-    eventEmitter: CustomEventEmitter;
-    getChatHistory(): Promise<unknown>;
+    /**
+     * Retrieves the chat history from the server.
+     * @returns {Promise<ChatMessage[]>} A promise that resolves with an array of ChatMessage objects representing the chat history.
+     */
+    getChatHistory: () => Promise<ChatMessage[]>;
+    /**
+     * Sets up a listener for incoming WebSocket messages and emits a custom event when a message is received.
+     * @returns {EventEmitter} The event emitter used for emitting custom events.
+     */
+    userMessageListener: () => CustomEventEmitter | undefined;
     /**
      * Sends a message through the WebSocket connection.
      * @param {string} message - The message to be sent.
      */
-    sendMessage(message: string): void;
+    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.
+     * @returns {Promise<string>} A promise that resolves with the reply.
      */
-    waitforReply(message: string): Promise<any>;
+    waitforReply: (message: string) => Promise<string>;
     /**
      * 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(): {
+    processStarted: () => {
         event: CustomEventEmitter;
         stopProcess: () => void;
     };
+    /**
+     * Stops the ongoing process.
+     * Sends a specific message to the server to stop the process.
+     */
     stopProcess: () => void;
 };
 export default cbchat;

package/modules/chat.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;
 // chat.ts
 const websocket_1 = __importDefault(require("./websocket"));
 const events_1 = require("events");
@@ -12,13 +11,16 @@ const events_1 = require("events");
  */
 class CustomEventEmitter extends events_1.EventEmitter {
 }
-exports.CustomEventEmitter = CustomEventEmitter;
+let eventEmitter = new CustomEventEmitter();
 /**
  * Chat module to interact with the WebSocket server.
  */
 const cbchat = {
-    eventEmitter: new CustomEventEmitter(),
-    getChatHistory() {
+    /**
+     * Retrieves the chat history from the server.
+     * @returns {Promise<ChatMessage[]>} A promise that resolves with an array of ChatMessage objects representing the chat history.
+     */
+    getChatHistory: () => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
                 "type": "getChatHistory"
@@ -31,11 +33,26 @@ const cbchat = {
             });
         });
     },
+    /**
+     * Sets up a listener for incoming WebSocket messages and emits a custom event when a message is received.
+     * @returns {EventEmitter} The event emitter used for emitting custom events.
+     */
+    userMessageListener: () => {
+        if (!websocket_1.default.getWebsocket)
+            return;
+        websocket_1.default.getWebsocket.on('message', (data) => {
+            const response = JSON.parse(data);
+            if (response.type === "messageResponse") {
+                eventEmitter.emit("userMessage", response.response);
+            }
+        });
+        return eventEmitter;
+    },
     /**
      * Sends a message through the WebSocket connection.
      * @param {string} message - The message to be sent.
      */
-    sendMessage(message) {
+    sendMessage: (message) => {
         console.log(message);
         websocket_1.default.getWebsocket.send(JSON.stringify({
             "type": "sendMessage",
@@ -45,9 +62,9 @@ const cbchat = {
     /**
      * 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.
+     * @returns {Promise<string>} A promise that resolves with the reply.
      */
-    waitforReply(message) {
+    waitforReply: (message) => {
         return new Promise((resolve, reject) => {
             websocket_1.default.getWebsocket.send(JSON.stringify({
                 "type": "waitforReply",
@@ -65,7 +82,7 @@ const cbchat = {
      * 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() {
+    processStarted: () => {
         // Send the process started message
         websocket_1.default.getWebsocket.send(JSON.stringify({
             "type": "processStarted"
@@ -76,11 +93,11 @@ const cbchat = {
             console.log("Received message:", message);
             if (message.type === 'stopProcessClicked')
                 // Emit a custom event based on the message type
-                this.eventEmitter.emit("stopProcessClicked", message);
+                eventEmitter.emit("stopProcessClicked", message);
         });
         // Return an object that includes the event emitter and the stopProcess method
         return {
-            event: this.eventEmitter,
+            event: eventEmitter,
             stopProcess: () => {
                 // Implement the logic to stop the process here
                 console.log("Stopping process...");
@@ -91,6 +108,10 @@ const cbchat = {
             }
         };
     },
+    /**
+     * Stops the ongoing process.
+     * Sends a specific message to the server to stop the process.
+     */
     stopProcess: () => {
         // Implement the logic to stop the process here
         console.log("Stopping process...");

package/modules/codeutils.d.ts

@@ -1,12 +1,37 @@
+import { GetJsTreeResponse, MatchProblemResponse, GetMatcherListTreeResponse, getMatchDetail } from '@codebolt/types';
 /**
  * A utility module for working with code.
  */
 declare const cbcodeutils: {
-    getCodeTree: () => Promise<any>;
-    getJsTree: (filePath: string) => Promise<any>;
-    getAllFilesAsMarkDown: () => Promise<unknown>;
-    performMatch: (matcherDefinition: object, problemPatterns: [], problems: []) => Promise<unknown>;
-    getMatcherList: () => Promise<unknown>;
-    matchDetail: (matcher: string) => Promise<unknown>;
+    /**
+     * 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: string) => Promise<GetJsTreeResponse>;
+    /**
+     * Retrieves all files as Markdown.
+     * @returns {Promise<string>} A promise that resolves with the Markdown content of all files.
+     */
+    getAllFilesAsMarkDown: () => Promise<string>;
+    /**
+     * 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: object, problemPatterns: any[], problems: any[]) => Promise<MatchProblemResponse>;
+    /**
+     * Retrieves the list of matchers.
+     * @returns {Promise<GetMatcherListTreeResponse>} A promise that resolves with the list of matchers response.
+     */
+    getMatcherList: () => Promise<GetMatcherListTreeResponse>;
+    /**
+     * 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: string) => Promise<getMatchDetail>;
 };
 export default cbcodeutils;