Codebolt
Class: Codebolt
Defined in: packages/codeboltjs/src/core/Codebolt.ts:71
Codebolt
Description
This class provides a unified interface to interact with various modules.
Constructors
Constructor
new Codebolt(): Codebolt;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:84
Returns
Codebolt
Description
Initializes the websocket connection.
Properties
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
actionBlock | { getDetail: (actionBlockName: string) => Promise<GetActionBlockDetailResponse>; list: (filter?: ActionBlockFilter) => Promise<ActionBlockListResponse>; start: (actionBlockName: string, params?: Record<string, any>) => Promise<StartActionBlockResponse>; } | cbactionBlock | - | packages/codeboltjs/src/core/Codebolt.ts:170 |
actionBlock.getDetail | (actionBlockName: string) => Promise<GetActionBlockDetailResponse> | undefined | Get detailed information about a specific ActionBlock | packages/codeboltjs/src/modules/actionBlock.ts:103 |
actionBlock.list | (filter?: ActionBlockFilter) => Promise<ActionBlockListResponse> | undefined | List all available ActionBlocks | packages/codeboltjs/src/modules/actionBlock.ts:87 |
actionBlock.start | (actionBlockName: string, params?: Record<string, any>) => Promise<StartActionBlockResponse> | undefined | Start an ActionBlock by name | packages/codeboltjs/src/modules/actionBlock.ts:120 |
actionPlan | { addGroupToActionPlan: (planId: string, group: ActionPlanGroup) => Promise<any>; addTaskToActionPlan: (planId: string, task: ActionPlanTask) => Promise<any>; createActionPlan: (payload: { agentId?: string; agentName?: string; description?: string; name: string; planId?: string; status?: string; }) => Promise<any>; getActionPlanDetail: (planId: string) => Promise<any>; getAllPlans: () => Promise<any>; getPlanDetail: (planId: string) => Promise<any>; startTaskStep: (planId: string, taskId: string) => Promise<any>; startTaskStepWithListener: (planId: string, taskId: string, onResponse: (response: TaskStepResponse) => void) => () => void; updateActionPlan: (planId: string, updateData: ActionPlanUpdateData) => Promise<any>; } | codeboltActionPlans | - | packages/codeboltjs/src/core/Codebolt.ts:164 |
actionPlan.addGroupToActionPlan | (planId: string, group: ActionPlanGroup) => Promise<any> | undefined | Add a group to an action plan | packages/codeboltjs/src/modules/actionPlan.ts:130 |
actionPlan.addTaskToActionPlan | (planId: string, task: ActionPlanTask) => Promise<any> | undefined | Add a task to an action plan | packages/codeboltjs/src/modules/actionPlan.ts:113 |
actionPlan.createActionPlan | (payload: { agentId?: string; agentName?: string; description?: string; name: string; planId?: string; status?: string; }) => Promise<any> | undefined | Create a new action plan | packages/codeboltjs/src/modules/actionPlan.ts:72 |
actionPlan.getActionPlanDetail | (planId: string) => Promise<any> | undefined | Get action plan detail by ID (alternative method) | packages/codeboltjs/src/modules/actionPlan.ts:56 |
actionPlan.getAllPlans | () => Promise<any> | undefined | Get all action plans | packages/codeboltjs/src/modules/actionPlan.ts:25 |
actionPlan.getPlanDetail | (planId: string) => Promise<any> | undefined | Get action plan detail by ID | packages/codeboltjs/src/modules/actionPlan.ts:40 |
actionPlan.startTaskStep | (planId: string, taskId: string) => Promise<any> | undefined | Start/execute a task step in an action plan | packages/codeboltjs/src/modules/actionPlan.ts:147 |
actionPlan.startTaskStepWithListener | (planId: string, taskId: string, onResponse: (response: TaskStepResponse) => void) => () => void | undefined | Start/execute a task step in an action plan with event listener | packages/codeboltjs/src/modules/actionPlan.ts:165 |
actionPlan.updateActionPlan | (planId: string, updateData: ActionPlanUpdateData) => Promise<any> | undefined | Update an existing action plan | packages/codeboltjs/src/modules/actionPlan.ts:96 |
agent | { findAgent: (task: string, maxResult: number, agents: never[], agentLocaltion: AgentLocation, getFrom: USE_VECTOR_DB) => Promise<FindAgentByTaskResponse>; getAgentsDetail: (agentList?: string[]) => Promise<AgentsDetailResponse>; getAgentsList: (type: Agents) => Promise<ListAgentsResponse>; startAgent: (agentId: string, task: string) => Promise<TaskCompletionResponse>; } | cbagent | - | packages/codeboltjs/src/core/Codebolt.ts:160 |
agent.findAgent | (task: string, maxResult: number, agents: never[], agentLocaltion: AgentLocation, getFrom: USE_VECTOR_DB) => Promise<FindAgentByTaskResponse> | undefined | Retrieves an agent based on the specified task. | packages/codeboltjs/src/modules/agent.ts:13 |
agent.getAgentsDetail | (agentList?: string[]) => Promise<AgentsDetailResponse> | undefined | Lists all available agents. | packages/codeboltjs/src/modules/agent.ts:64 |
agent.getAgentsList | (type: Agents) => Promise<ListAgentsResponse> | undefined | Lists all available agents. | packages/codeboltjs/src/modules/agent.ts:49 |
agent.startAgent | (agentId: string, task: string) => Promise<TaskCompletionResponse> | undefined | Starts an agent for the specified task. | packages/codeboltjs/src/modules/agent.ts:33 |
agentDeliberation | { create: (params: ICreateDeliberationParams) => Promise<ICreateDeliberationResponse>; get: (params: IGetDeliberationParams) => Promise<IGetDeliberationResponse>; getWinner: (params: IGetWinnerParams) => Promise<IGetWinnerResponse>; list: (params?: IListDeliberationsParams) => Promise<IListDeliberationsResponse>; respond: (params: IDeliberationRespondParams) => Promise<IDeliberationRespondResponse>; summary: (params: ISummaryParams) => Promise<ISummaryResponse>; update: (params: IUpdateDeliberationParams) => Promise<IUpdateDeliberationResponse>; vote: (params: IVoteParams) => Promise<IVoteResponse>; } | cbagentDeliberation | - | packages/codeboltjs/src/core/Codebolt.ts:140 |
agentDeliberation.create | (params: ICreateDeliberationParams) => Promise<ICreateDeliberationResponse> | undefined | - | packages/codeboltjs/src/modules/agentDeliberation.ts:24 |
agentDeliberation.get | (params: IGetDeliberationParams) => Promise<IGetDeliberationResponse> | undefined | - | packages/codeboltjs/src/modules/agentDeliberation.ts:31 |
agentDeliberation.getWinner | (params: IGetWinnerParams) => Promise<IGetWinnerResponse> | undefined | - | packages/codeboltjs/src/modules/agentDeliberation.ts:66 |
agentDeliberation.list | (params?: IListDeliberationsParams) => Promise<IListDeliberationsResponse> | undefined | - | packages/codeboltjs/src/modules/agentDeliberation.ts:38 |
agentDeliberation.respond | (params: IDeliberationRespondParams) => Promise<IDeliberationRespondResponse> | undefined | - | packages/codeboltjs/src/modules/agentDeliberation.ts:52 |
agentDeliberation.summary | (params: ISummaryParams) => Promise<ISummaryResponse> | undefined | - | packages/codeboltjs/src/modules/agentDeliberation.ts:73 |
agentDeliberation.update | (params: IUpdateDeliberationParams) => Promise<IUpdateDeliberationResponse> | undefined | - | packages/codeboltjs/src/modules/agentDeliberation.ts:45 |
agentDeliberation.vote | (params: IVoteParams) => Promise<IVoteResponse> | undefined | - | packages/codeboltjs/src/modules/agentDeliberation.ts:59 |
agentEventQueue | { _acknowledgeEvent: (eventId: string, success: boolean, errorMessage?: string) => Promise<AgentEventQueueResponse<any>>; _fetchPendingFromBackend: (params: GetPendingEventsInput) => Promise<AgentEventMessage[]>; acknowledgeEvent: (eventId: string, success: boolean, errorMessage?: string) => Promise<AgentEventQueueResponse<any>>; addEvent: (params: AddEventInput) => Promise<AgentEventQueueResponse<AddEventResponseData>>; checkForPendingExternalEvent: () => UnifiedExternalEvent | null; clearLocalCache: () => void; clearQueue: (agentId?: string) => Promise<AgentEventQueueResponse<any>>; getLocalCacheSize: () => number; getPendingExternalEventCount: () => number; getPendingExternalEvents: () => UnifiedExternalEvent[]; getPendingQueueEvents: (maxDepth?: number) => Promise<AgentEventMessage[]>; getQueueStats: () => Promise<AgentEventQueueResponse<QueueStatsResponseData>>; onQueueEvent: (handler: QueueEventHandler) => () => void; peekLocalCache: () => AgentEventMessage[]; sendAgentMessage: (params: SendAgentMessageInput) => Promise<AgentEventQueueResponse<AddEventResponseData>>; waitForAnyExternalEvent: () => Promise<UnifiedExternalEvent>; waitForNextQueueEvent: (maxDepth: number) => Promise< | AgentEventMessage | AgentEventMessage[]>; } | cbagentEventQueue | - | packages/codeboltjs/src/core/Codebolt.ts:193 |
agentEventQueue._acknowledgeEvent | (eventId: string, success: boolean, errorMessage?: string) => Promise<AgentEventQueueResponse<any>> | undefined | Acknowledge an event at the backend | packages/codeboltjs/src/modules/agentEventQueue.ts:225 |
agentEventQueue._fetchPendingFromBackend | (params: GetPendingEventsInput) => Promise<AgentEventMessage[]> | undefined | Fetch pending events from backend | packages/codeboltjs/src/modules/agentEventQueue.ts:245 |
agentEventQueue.acknowledgeEvent | (eventId: string, success: boolean, errorMessage?: string) => Promise<AgentEventQueueResponse<any>> | undefined | Manually acknowledge an event. Use this when handling events via onQueueEvent. | packages/codeboltjs/src/modules/agentEventQueue.ts:425 |
agentEventQueue.addEvent | (params: AddEventInput) => Promise<AgentEventQueueResponse<AddEventResponseData>> | undefined | Add an event to a target agent's queue | packages/codeboltjs/src/modules/agentEventQueue.ts:153 |
agentEventQueue.checkForPendingExternalEvent | () => UnifiedExternalEvent | null | undefined | Check for any pending external events without waiting. Returns the first pending event or null if none available. | packages/codeboltjs/src/modules/agentEventQueue.ts:471 |
agentEventQueue.clearLocalCache | () => void | undefined | Clear the local event cache (does not affect backend) | packages/codeboltjs/src/modules/agentEventQueue.ts:457 |
agentEventQueue.clearQueue | (agentId?: string) => Promise<AgentEventQueueResponse<any>> | undefined | Clear the queue for an agent | packages/codeboltjs/src/modules/agentEventQueue.ts:203 |
agentEventQueue.getLocalCacheSize | () => number | undefined | Get the number of events in the local cache | packages/codeboltjs/src/modules/agentEventQueue.ts:442 |
agentEventQueue.getPendingExternalEventCount | () => number | undefined | Get the count of pending external events. | packages/codeboltjs/src/modules/agentEventQueue.ts:495 |
agentEventQueue.getPendingExternalEvents | () => UnifiedExternalEvent[] | undefined | Get all pending external events. Returns all pending events and clears the cache. | packages/codeboltjs/src/modules/agentEventQueue.ts:484 |
agentEventQueue.getPendingQueueEvents | (maxDepth?: number) => Promise<AgentEventMessage[]> | undefined | Get pending events from local cache. Sends acknowledgement for each event and removes from local cache. If no local events, fetches from backend. | packages/codeboltjs/src/modules/agentEventQueue.ts:296 |
agentEventQueue.getQueueStats | () => Promise<AgentEventQueueResponse<QueueStatsResponseData>> | undefined | Get queue statistics | packages/codeboltjs/src/modules/agentEventQueue.ts:186 |
agentEventQueue.onQueueEvent | (handler: QueueEventHandler) => () => void | undefined | Register an event handler that will be called when events are received. The handler receives events as they arrive via WebSocket. Note: This does NOT automatically acknowledge events. | packages/codeboltjs/src/modules/agentEventQueue.ts:409 |
agentEventQueue.peekLocalCache | () => AgentEventMessage[] | undefined | Get all events currently in the local cache without removing them | packages/codeboltjs/src/modules/agentEventQueue.ts:450 |
agentEventQueue.sendAgentMessage | (params: SendAgentMessageInput) => Promise<AgentEventQueueResponse<AddEventResponseData>> | undefined | Send an inter-agent message (convenience wrapper) | packages/codeboltjs/src/modules/agentEventQueue.ts:170 |
agentEventQueue.waitForAnyExternalEvent | () => Promise<UnifiedExternalEvent> | undefined | Waits for any external event from multiple sources: - Agent queue events (from local cache or WebSocket) - Background agent completions - Grouped agent completions Returns the first event that occurs from any source. | packages/codeboltjs/src/modules/agentEventQueue.ts:509 |
agentEventQueue.waitForNextQueueEvent | (maxDepth: number) => Promise< | AgentEventMessage | AgentEventMessage[]> | undefined | Wait for the next event(s) from the queue. First checks local cache, then waits for WebSocket events. Sends acknowledgement and removes from cache before resolving. | packages/codeboltjs/src/modules/agentEventQueue.ts:366 |
agentPortfolio | { addAppreciation: (toAgentId: string, message: string) => Promise<AddAppreciationResponse>; addKarma: (toAgentId: string, amount: number, reason?: string) => Promise<AddKarmaResponse>; addTalent: (name: string, description?: string) => Promise<AddTalentResponse>; addTestimonial: (toAgentId: string, content: string, projectId?: string) => Promise<AddTestimonialResponse>; deleteTestimonial: (testimonialId: string) => Promise<DeleteTestimonialResponse>; endorseTalent: (talentId: string) => Promise<EndorseTalentResponse>; getConversations: (agentId: string, limit?: number, offset?: number) => Promise<GetConversationsResponse>; getKarmaHistory: (agentId: string, limit?: number) => Promise<GetKarmaHistoryResponse>; getPortfolio: (agentId: string) => Promise<GetPortfolioResponse>; getPortfoliosByProject: (projectId: string) => Promise<GetPortfoliosByProjectResponse>; getRanking: (limit?: number, sortBy?: "karma" | "testimonials" | "endorsements") => Promise<GetRankingResponse>; getTalents: (agentId?: string) => Promise<GetTalentsResponse>; updateProfile: (agentId: string, profile: { avatarUrl?: string; bio?: string; displayName?: string; location?: string; specialties?: string[]; website?: string; }) => Promise<UpdateProfileResponse>; updateTestimonial: (testimonialId: string, content: string) => Promise<UpdateTestimonialResponse>; } | cbagentPortfolio | - | packages/codeboltjs/src/core/Codebolt.ts:190 |
agentPortfolio.addAppreciation | (toAgentId: string, message: string) => Promise<AddAppreciationResponse> | undefined | Add an appreciation for an agent | packages/codeboltjs/src/modules/agentPortfolio.ts:178 |
agentPortfolio.addKarma | (toAgentId: string, amount: number, reason?: string) => Promise<AddKarmaResponse> | undefined | Add karma to an agent | packages/codeboltjs/src/modules/agentPortfolio.ts:134 |
agentPortfolio.addTalent | (name: string, description?: string) => Promise<AddTalentResponse> | undefined | Add a talent skill | packages/codeboltjs/src/modules/agentPortfolio.ts:199 |
agentPortfolio.addTestimonial | (toAgentId: string, content: string, projectId?: string) => Promise<AddTestimonialResponse> | undefined | Add a testimonial for an agent | packages/codeboltjs/src/modules/agentPortfolio.ts:73 |
agentPortfolio.deleteTestimonial | (testimonialId: string) => Promise<DeleteTestimonialResponse> | undefined | Delete a testimonial | packages/codeboltjs/src/modules/agentPortfolio.ts:116 |
agentPortfolio.endorseTalent | (talentId: string) => Promise<EndorseTalentResponse> | undefined | Endorse a talent skill | packages/codeboltjs/src/modules/agentPortfolio.ts:219 |
agentPortfolio.getConversations | (agentId: string, limit?: number, offset?: number) => Promise<GetConversationsResponse> | undefined | Get conversations involving an agent | packages/codeboltjs/src/modules/agentPortfolio.ts:49 |
agentPortfolio.getKarmaHistory | (agentId: string, limit?: number) => Promise<GetKarmaHistoryResponse> | undefined | Get the karma history of an agent | packages/codeboltjs/src/modules/agentPortfolio.ts:157 |
agentPortfolio.getPortfolio | (agentId: string) => Promise<GetPortfolioResponse> | undefined | Get the portfolio of an agent | packages/codeboltjs/src/modules/agentPortfolio.ts:31 |
agentPortfolio.getPortfoliosByProject | (projectId: string) => Promise<GetPortfoliosByProjectResponse> | undefined | Get portfolios by project | packages/codeboltjs/src/modules/agentPortfolio.ts:272 |
agentPortfolio.getRanking | (limit?: number, sortBy?: "karma" | "testimonials" | "endorsements") => Promise<GetRankingResponse> | undefined | Get agent ranking/leaderboard | packages/codeboltjs/src/modules/agentPortfolio.ts:252 |
agentPortfolio.getTalents | (agentId?: string) => Promise<GetTalentsResponse> | undefined | Get talents for an agent or all talents | packages/codeboltjs/src/modules/agentPortfolio.ts:235 |
agentPortfolio.updateProfile | (agentId: string, profile: { avatarUrl?: string; bio?: string; displayName?: string; location?: string; specialties?: string[]; website?: string; }) => Promise<UpdateProfileResponse> | undefined | Update agent profile | packages/codeboltjs/src/modules/agentPortfolio.ts:289 |
agentPortfolio.updateTestimonial | (testimonialId: string, content: string) => Promise<UpdateTestimonialResponse> | undefined | Update an existing testimonial | packages/codeboltjs/src/modules/agentPortfolio.ts:96 |
autoTesting | { addCaseToSuite: (params: IAddCaseToSuiteParams) => Promise<IAddCaseToSuiteResponse>; createCase: (params: ICreateCaseParams) => Promise<ICreateCaseResponse>; createRun: (params: ICreateRunParams) => Promise<ICreateRunResponse>; createSuite: (params: ICreateSuiteParams) => Promise<ICreateSuiteResponse>; deleteCase: (params: IDeleteCaseParams) => Promise<IDeleteCaseResponse>; deleteSuite: (params: IDeleteSuiteParams) => Promise<IDeleteSuiteResponse>; getCase: (params: IGetCaseParams) => Promise<IGetCaseResponse>; getRun: (params: IGetRunParams) => Promise<IGetRunResponse>; getSuite: (params: IGetSuiteParams) => Promise<IGetSuiteResponse>; listCases: (_params?: IListCasesParams) => Promise<IListCasesResponse>; listRuns: (params?: IListRunsParams) => Promise<IListRunsResponse>; listSuites: (_params?: IListSuitesParams) => Promise<IListSuitesResponse>; removeCaseFromSuite: (params: IRemoveCaseFromSuiteParams) => Promise<IRemoveCaseFromSuiteResponse>; updateCase: (params: IUpdateCaseParams) => Promise<IUpdateCaseResponse>; updateRunCaseStatus: (params: IUpdateRunCaseParams) => Promise<IUpdateRunCaseResponse>; updateRunStatus: (params: IUpdateRunStatusParams) => Promise<IUpdateRunStatusResponse>; updateRunStepStatus: (params: IUpdateRunStepParams) => Promise<IUpdateRunStepResponse>; updateSuite: (params: IUpdateSuiteParams) => Promise<IUpdateSuiteResponse>; } | cbautoTesting | - | packages/codeboltjs/src/core/Codebolt.ts:169 |
autoTesting.addCaseToSuite | (params: IAddCaseToSuiteParams) => Promise<IAddCaseToSuiteResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:75 |
autoTesting.createCase | (params: ICreateCaseParams) => Promise<ICreateCaseResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:88 |
autoTesting.createRun | (params: ICreateRunParams) => Promise<ICreateRunResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:119 |
autoTesting.createSuite | (params: ICreateSuiteParams) => Promise<ICreateSuiteResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:45 |
autoTesting.deleteCase | (params: IDeleteCaseParams) => Promise<IDeleteCaseResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:112 |
autoTesting.deleteSuite | (params: IDeleteSuiteParams) => Promise<IDeleteSuiteResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:69 |
autoTesting.getCase | (params: IGetCaseParams) => Promise<IGetCaseResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:94 |
autoTesting.getRun | (params: IGetRunParams) => Promise<IGetRunResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:125 |
autoTesting.getSuite | (params: IGetSuiteParams) => Promise<IGetSuiteResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:51 |
autoTesting.listCases | (_params?: IListCasesParams) => Promise<IListCasesResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:100 |
autoTesting.listRuns | (params?: IListRunsParams) => Promise<IListRunsResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:131 |
autoTesting.listSuites | (_params?: IListSuitesParams) => Promise<IListSuitesResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:57 |
autoTesting.removeCaseFromSuite | (params: IRemoveCaseFromSuiteParams) => Promise<IRemoveCaseFromSuiteResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:81 |
autoTesting.updateCase | (params: IUpdateCaseParams) => Promise<IUpdateCaseResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:106 |
autoTesting.updateRunCaseStatus | (params: IUpdateRunCaseParams) => Promise<IUpdateRunCaseResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:143 |
autoTesting.updateRunStatus | (params: IUpdateRunStatusParams) => Promise<IUpdateRunStatusResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:137 |
autoTesting.updateRunStepStatus | (params: IUpdateRunStepParams) => Promise<IUpdateRunStepResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:149 |
autoTesting.updateSuite | (params: IUpdateSuiteParams) => Promise<IUpdateSuiteResponse> | undefined | - | packages/codeboltjs/src/modules/autoTesting.ts:63 |
backgroundChildThreads | { addRunningAgent: (threadId: string, data: BackgroundAgentData, groupId?: string) => void; checkForBackgroundAgentCompletion: () => BackgroundAgentCompletion[] | null; checkForBackgroundGroupedAgentCompletion: () => BackgroundAgentCompletion | null; getRunningAgentCount: () => number; onBackgroundAgentCompletion: () => Promise<BackgroundAgentCompletion[] | null>; onBackgroundGroupedAgentCompletion: () => Promise<BackgroundAgentCompletion | null>; waitForAnyExternalEvent: () => Promise<BackgroundExternalEvent>; } | cbbackgroundChildThreads | - | packages/codeboltjs/src/core/Codebolt.ts:192 |
backgroundChildThreads.addRunningAgent | (threadId: string, data: BackgroundAgentData, groupId?: string) => void | undefined | Adds a running background agent to tracking. | packages/codeboltjs/src/modules/backgroundChildThreads.ts:79 |
backgroundChildThreads.checkForBackgroundAgentCompletion | () => BackgroundAgentCompletion[] | null | undefined | Checks if any background agent has completed. | packages/codeboltjs/src/modules/backgroundChildThreads.ts:101 |
backgroundChildThreads.checkForBackgroundGroupedAgentCompletion | () => BackgroundAgentCompletion | null | undefined | Checks if any grouped background agent has completed. | packages/codeboltjs/src/modules/backgroundChildThreads.ts:130 |
backgroundChildThreads.getRunningAgentCount | () => number | undefined | Gets the number of currently running background agents. | packages/codeboltjs/src/modules/backgroundChildThreads.ts:93 |
backgroundChildThreads.onBackgroundAgentCompletion | () => Promise<BackgroundAgentCompletion[] | null> | undefined | Waits for background agent completion. | packages/codeboltjs/src/modules/backgroundChildThreads.ts:114 |
backgroundChildThreads.onBackgroundGroupedAgentCompletion | () => Promise<BackgroundAgentCompletion | null> | undefined | Waits for grouped background agent completion. | packages/codeboltjs/src/modules/backgroundChildThreads.ts:146 |
backgroundChildThreads.waitForAnyExternalEvent | () => Promise<BackgroundExternalEvent> | undefined | Waits for any external event (background agent completion, grouped agent completion, or agent event). Returns the first event that occurs. | packages/codeboltjs/src/modules/backgroundChildThreads.ts:163 |
browser | { click: (elementid: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>; close: (options?: BrowserOperationOptions) => Promise<void>; closeBrowserInstance: (instanceId: string) => Promise<boolean>; enter: (options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>; executeOnInstance: (instanceId: string, operation: BrowserOperationType, params: BrowserOperationParams) => Promise<BrowserOperationResponse>; extractText: (options?: BrowserOperationOptions) => Promise<ExtractTextResponse>; getBrowserInfo: (options?: BrowserOperationOptions) => Promise<BrowserInfoResponse>; getBrowserInstance: (instanceId: string) => Promise<BrowserInstanceInfo | null>; getContent: (options?: BrowserOperationOptions) => Promise<GetContentResponse>; getHTML: (options?: BrowserOperationOptions) => Promise<HtmlReceived>; getMarkdown: (options?: BrowserOperationOptions) => Promise<GetMarkdownResponse>; getPDF: (options?: BrowserOperationOptions) => Promise<void>; getSnapShot: (options?: BrowserOperationOptions) => Promise<BrowserSnapshotResponse>; getUrl: (options?: BrowserOperationOptions) => Promise<UrlResponse>; goToPage: (url: string, options?: BrowserOperationOptions) => Promise<GoToPageResponse>; listBrowserInstances: () => Promise<BrowserInstanceInfo[]>; newPage: (options?: BrowserInstanceOptions) => Promise<BrowserActionResponseData>; openNewBrowserInstance: (options?: BrowserInstanceOptions) => Promise<{ instanceId: string; }>; pdfToText: (options?: BrowserOperationOptions) => Promise<void>; screenshot: (options?: BrowserScreenshotOptions) => Promise<BrowserScreenshotResponse>; scroll: (direction: string, pixels: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>; search: (elementid: string, query: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>; setActiveBrowserInstance: (instanceId: string) => Promise<boolean>; type: (elementid: string, text: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData>; } | cbbrowser | - | packages/codeboltjs/src/core/Codebolt.ts:141 |
browser.click | (elementid: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData> | undefined | Clicks on a specified element on the page. | packages/codeboltjs/src/modules/browser.ts:317 |
browser.close | (options?: BrowserOperationOptions) => Promise<void> | undefined | Closes the current page. | packages/codeboltjs/src/modules/browser.ts:260 |
browser.closeBrowserInstance | (instanceId: string) => Promise<boolean> | undefined | Close a browser instance | packages/codeboltjs/src/modules/browser.ts:441 |
browser.enter | (options?: BrowserOperationOptions) => Promise<BrowserActionResponseData> | undefined | Simulates the Enter key press on the current page. | packages/codeboltjs/src/modules/browser.ts:335 |
browser.executeOnInstance | (instanceId: string, operation: BrowserOperationType, params: BrowserOperationParams) => Promise<BrowserOperationResponse> | undefined | Execute action on specific browser instance | packages/codeboltjs/src/modules/browser.ts:464 |
browser.extractText | (options?: BrowserOperationOptions) => Promise<ExtractTextResponse> | undefined | Extracts text from the current page. | packages/codeboltjs/src/modules/browser.ts:244 |
browser.getBrowserInfo | (options?: BrowserOperationOptions) => Promise<BrowserInfoResponse> | undefined | Retrieves browser info like height width scrollx scrolly of the current page. | packages/codeboltjs/src/modules/browser.ts:227 |
browser.getBrowserInstance | (instanceId: string) => Promise<BrowserInstanceInfo | null> | undefined | Get a specific browser instance by ID | packages/codeboltjs/src/modules/browser.ts:397 |
browser.getContent | (options?: BrowserOperationOptions) => Promise<GetContentResponse> | undefined | Retrieves the content of the current page. | packages/codeboltjs/src/modules/browser.ts:195 |
browser.getHTML | (options?: BrowserOperationOptions) => Promise<HtmlReceived> | undefined | Retrieves the HTML content of the current page. | packages/codeboltjs/src/modules/browser.ts:135 |
browser.getMarkdown | (options?: BrowserOperationOptions) => Promise<GetMarkdownResponse> | undefined | Retrieves the Markdown content of the current page. | packages/codeboltjs/src/modules/browser.ts:152 |
browser.getPDF | (options?: BrowserOperationOptions) => Promise<void> | undefined | Retrieves the PDF content of the current page. | packages/codeboltjs/src/modules/browser.ts:168 |
browser.getSnapShot | (options?: BrowserOperationOptions) => Promise<BrowserSnapshotResponse> | undefined | Retrieves the snapshot of the current page. | packages/codeboltjs/src/modules/browser.ts:211 |
browser.getUrl | (options?: BrowserOperationOptions) => Promise<UrlResponse> | undefined | Retrieves the current URL of the browser's active page. | packages/codeboltjs/src/modules/browser.ts:79 |
browser.goToPage | (url: string, options?: BrowserOperationOptions) => Promise<GoToPageResponse> | undefined | Navigates to a specified URL. | packages/codeboltjs/src/modules/browser.ts:97 |
browser.listBrowserInstances | () => Promise<BrowserInstanceInfo[]> | undefined | List all open browser instances | packages/codeboltjs/src/modules/browser.ts:376 |
browser.newPage | (options?: BrowserInstanceOptions) => Promise<BrowserActionResponseData> | undefined | Opens a new page in the browser. | packages/codeboltjs/src/modules/browser.ts:61 |
browser.openNewBrowserInstance | (options?: BrowserInstanceOptions) => Promise<{ instanceId: string; }> | undefined | Open a new browser instance | packages/codeboltjs/src/modules/browser.ts:422 |
browser.pdfToText | (options?: BrowserOperationOptions) => Promise<void> | undefined | Converts the PDF content of the current page to text. | packages/codeboltjs/src/modules/browser.ts:181 |
browser.screenshot | (options?: BrowserScreenshotOptions) => Promise<BrowserScreenshotResponse> | undefined | Takes a screenshot of the current page. | packages/codeboltjs/src/modules/browser.ts:114 |
browser.scroll | (direction: string, pixels: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData> | undefined | Scrolls the current page in a specified direction by a specified number of pixels. | packages/codeboltjs/src/modules/browser.ts:276 |
browser.search | (elementid: string, query: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData> | undefined | Performs a search on the current page using a specified query. | packages/codeboltjs/src/modules/browser.ts:354 |
browser.setActiveBrowserInstance | (instanceId: string) => Promise<boolean> | undefined | Set the active browser instance | packages/codeboltjs/src/modules/browser.ts:407 |
browser.type | (elementid: string, text: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData> | undefined | Types text into a specified element on the page. | packages/codeboltjs/src/modules/browser.ts:297 |
calendar | { createEvent: (params: ICreateEventParams) => Promise<ICreateEventResponse>; deleteEvent: (params: IDeleteEventParams) => Promise<IDeleteEventResponse>; getEvent: (params: IGetEventParams) => Promise<IGetEventResponse>; getEventsInRange: (params: IGetEventsInRangeParams) => Promise<IGetEventsInRangeResponse>; getStatus: () => Promise<IGetStatusResponse>; getTriggeredEvents: (params: IGetTriggeredEventsParams) => Promise<IGetTriggeredEventsResponse>; getTriggeredEventsAndMarkComplete: () => Promise<IGetTriggeredEventsAndMarkCompleteResponse>; getUpcomingEvents: (params: IGetUpcomingEventsParams) => Promise<IGetUpcomingEventsResponse>; listEvents: (params: IListEventsParams) => Promise<IListEventsResponse>; markEventComplete: (params: IMarkEventCompleteParams) => Promise<IMarkEventCompleteResponse>; markEventsComplete: (params: IMarkEventsCompleteParams) => Promise<IMarkEventsCompleteResponse>; rsvp: (params: IRSVPParams) => Promise<IRSVPResponse>; updateEvent: (params: IUpdateEventParams) => Promise<IUpdateEventResponse>; } | cbcalendar | - | packages/codeboltjs/src/core/Codebolt.ts:173 |
calendar.createEvent | (params: ICreateEventParams) => Promise<ICreateEventResponse> | undefined | Create a new calendar event | packages/codeboltjs/src/modules/calendar.ts:273 |
calendar.deleteEvent | (params: IDeleteEventParams) => Promise<IDeleteEventResponse> | undefined | Delete a calendar event | packages/codeboltjs/src/modules/calendar.ts:303 |
calendar.getEvent | (params: IGetEventParams) => Promise<IGetEventResponse> | undefined | Get a single calendar event by ID | packages/codeboltjs/src/modules/calendar.ts:318 |
calendar.getEventsInRange | (params: IGetEventsInRangeParams) => Promise<IGetEventsInRangeResponse> | undefined | Get events within a specific date range | packages/codeboltjs/src/modules/calendar.ts:348 |
calendar.getStatus | () => Promise<IGetStatusResponse> | undefined | Get the calendar scheduler status | packages/codeboltjs/src/modules/calendar.ts:450 |
calendar.getTriggeredEvents | (params: IGetTriggeredEventsParams) => Promise<IGetTriggeredEventsResponse> | undefined | Get triggered events (events whose start time has passed) | packages/codeboltjs/src/modules/calendar.ts:378 |
calendar.getTriggeredEventsAndMarkComplete | () => Promise<IGetTriggeredEventsAndMarkCompleteResponse> | undefined | Get triggered events and mark them all as complete in one operation | packages/codeboltjs/src/modules/calendar.ts:422 |
calendar.getUpcomingEvents | (params: IGetUpcomingEventsParams) => Promise<IGetUpcomingEventsResponse> | undefined | Get upcoming events within a specified time window | packages/codeboltjs/src/modules/calendar.ts:363 |
calendar.listEvents | (params: IListEventsParams) => Promise<IListEventsResponse> | undefined | List calendar events with optional filters | packages/codeboltjs/src/modules/calendar.ts:333 |
calendar.markEventComplete | (params: IMarkEventCompleteParams) => Promise<IMarkEventCompleteResponse> | undefined | Mark a single event as complete | packages/codeboltjs/src/modules/calendar.ts:393 |
calendar.markEventsComplete | (params: IMarkEventsCompleteParams) => Promise<IMarkEventsCompleteResponse> | undefined | Mark multiple events as complete | packages/codeboltjs/src/modules/calendar.ts:408 |
calendar.rsvp | (params: IRSVPParams) => Promise<IRSVPResponse> | undefined | RSVP to a calendar event | packages/codeboltjs/src/modules/calendar.ts:436 |
calendar.updateEvent | (params: IUpdateEventParams) => Promise<IUpdateEventResponse> | undefined | Update an existing calendar event | packages/codeboltjs/src/modules/calendar.ts:288 |
capability | { getCapabilitiesByAuthor: (author: string) => Promise<ListCapabilitiesResponse>; getCapabilitiesByTag: (tag: string) => Promise<ListCapabilitiesResponse>; getCapabilityDetail: (capabilityName: string, capabilityType?: string) => Promise<GetCapabilityDetailResponse>; getExecutionStatus: (executionId: string) => Promise<GetExecutionStatusResponse>; listCapabilities: (filter?: CapabilityFilter) => Promise<ListCapabilitiesResponse>; listCapabilitiesByType: (capabilityType: string) => Promise<ListCapabilitiesResponse>; listExecutors: () => Promise<ListExecutorsResponse>; listPowers: () => Promise<ListCapabilitiesResponse>; listSkills: () => Promise<ListCapabilitiesResponse>; listTalents: () => Promise<ListCapabilitiesResponse>; startCapability: (capabilityName: string, capabilityType: string, params?: Record<string, any>, timeout?: number) => Promise<StartCapabilityResponse>; startPower: (powerName: string, params?: Record<string, any>, timeout?: number) => Promise<StartCapabilityResponse>; startSkill: (skillName: string, params?: Record<string, any>, timeout?: number) => Promise<StartCapabilityResponse>; startTalent: (talentName: string, params?: Record<string, any>, timeout?: number) => Promise<StartCapabilityResponse>; stopCapability: (executionId: string) => Promise<StopCapabilityResponse>; } | cbcapability | - | packages/codeboltjs/src/core/Codebolt.ts:167 |
capability.getCapabilitiesByAuthor | (author: string) => Promise<ListCapabilitiesResponse> | undefined | Get capabilities by author | packages/codeboltjs/src/modules/capability.ts:289 |
capability.getCapabilitiesByTag | (tag: string) => Promise<ListCapabilitiesResponse> | undefined | Get capabilities by tag | packages/codeboltjs/src/modules/capability.ts:271 |
capability.getCapabilityDetail | (capabilityName: string, capabilityType?: string) => Promise<GetCapabilityDetailResponse> | undefined | Get detailed information about a specific capability | packages/codeboltjs/src/modules/capability.ts:119 |
capability.getExecutionStatus | (executionId: string) => Promise<GetExecutionStatusResponse> | undefined | Get the status of a capability execution | packages/codeboltjs/src/modules/capability.ts:253 |
capability.listCapabilities | (filter?: CapabilityFilter) => Promise<ListCapabilitiesResponse> | undefined | List all available capabilities with optional filtering | packages/codeboltjs/src/modules/capability.ts:52 |
capability.listCapabilitiesByType | (capabilityType: string) => Promise<ListCapabilitiesResponse> | undefined | List capabilities by type | packages/codeboltjs/src/modules/capability.ts:70 |
capability.listExecutors | () => Promise<ListExecutorsResponse> | undefined | List all available capability executors | packages/codeboltjs/src/modules/capability.ts:140 |
capability.listPowers | () => Promise<ListCapabilitiesResponse> | undefined | List all available powers | packages/codeboltjs/src/modules/capability.ts:97 |
capability.listSkills | () => Promise<ListCapabilitiesResponse> | undefined | List all available skills | packages/codeboltjs/src/modules/capability.ts:87 |
capability.listTalents | () => Promise<ListCapabilitiesResponse> | undefined | List all available talents | packages/codeboltjs/src/modules/capability.ts:107 |
capability.startCapability | (capabilityName: string, capabilityType: string, params?: Record<string, any>, timeout?: number) => Promise<StartCapabilityResponse> | undefined | Start a capability execution | packages/codeboltjs/src/modules/capability.ts:160 |
capability.startPower | (powerName: string, params?: Record<string, any>, timeout?: number) => Promise<StartCapabilityResponse> | undefined | Start a power execution | packages/codeboltjs/src/modules/capability.ts:205 |
capability.startSkill | (skillName: string, params?: Record<string, any>, timeout?: number) => Promise<StartCapabilityResponse> | undefined | Start a skill execution | packages/codeboltjs/src/modules/capability.ts:188 |
capability.startTalent | (talentName: string, params?: Record<string, any>, timeout?: number) => Promise<StartCapabilityResponse> | undefined | Start a talent execution | packages/codeboltjs/src/modules/capability.ts:222 |
capability.stopCapability | (executionId: string) => Promise<StopCapabilityResponse> | undefined | Stop a running capability execution | packages/codeboltjs/src/modules/capability.ts:237 |
cbstate | { addToAgentState: (key: string, value: string) => Promise<AddToAgentStateResponse>; getAgentState: () => Promise<GetAgentStateResponse>; getApplicationState: () => Promise<ApplicationState>; getProjectState: () => Promise<GetProjectStateResponse>; updateProjectState: (key: string, value: any) => Promise<UpdateProjectStateResponse>; } | cbstate | - | packages/codeboltjs/src/core/Codebolt.ts:152 |
cbstate.addToAgentState | (key: string, value: string) => Promise<AddToAgentStateResponse> | undefined | Adds a key-value pair to the agent's state on the server via WebSocket. | packages/codeboltjs/src/modules/state.ts:28 |
cbstate.getAgentState | () => Promise<GetAgentStateResponse> | undefined | Retrieves the current state of the agent from the server via WebSocket. | packages/codeboltjs/src/modules/state.ts:46 |
cbstate.getApplicationState | () => Promise<ApplicationState> | undefined | Retrieves the current application state from the server via WebSocket. | packages/codeboltjs/src/modules/state.ts:13 |
cbstate.getProjectState | () => Promise<GetProjectStateResponse> | undefined | Retrieves the current project state from the server via WebSocket. | packages/codeboltjs/src/modules/state.ts:62 |
cbstate.updateProjectState | (key: string, value: any) => Promise<UpdateProjectStateResponse> | undefined | Updates the project state on the server via WebSocket. | packages/codeboltjs/src/modules/state.ts:78 |
chat | { askQuestion: (question: string, buttons: string[], withFeedback: boolean) => Promise<string>; checkForSteeringMessage: () => SteeringMessage | null; getChatHistory: (threadId: string) => Promise<ChatMessage>; onSteeringMessageReceived: () => Promise<SteeringMessage | null>; processFinished: () => void; processStarted: (onStopClicked?: (message: StopProcessMessage) => void) => ProcessControl | ProcessControlWithCleanup; sendConfirmationRequest: (confirmationMessage: string, buttons: string[], withFeedback: boolean) => Promise<string>; sendMessage: (message: string, payload?: object) => void; sendNotificationEvent: (notificationMessage: string, type: | "browser" | "terminal" | "git" | "debug" | "planner" | "editor" | "preview") => void; setRequestHandler: (handler: RequestHandler) => void; stopProcess: () => void; waitforReply: (message: string) => Promise<UserMessage>; } | cbchat | - | packages/codeboltjs/src/core/Codebolt.ts:142 |
chat.askQuestion | (question: string, buttons: string[], withFeedback: boolean) => Promise<string> | undefined | - | packages/codeboltjs/src/modules/chat.ts:186 |
chat.checkForSteeringMessage | () => SteeringMessage | null | undefined | Checks if any steering message has been received. | packages/codeboltjs/src/modules/chat.ts:213 |
chat.getChatHistory | (threadId: string) => Promise<ChatMessage> | undefined | Retrieves the chat history from the server. | packages/codeboltjs/src/modules/chat.ts:45 |
chat.onSteeringMessageReceived | () => Promise<SteeringMessage | null> | undefined | Waits for a steering message. | packages/codeboltjs/src/modules/chat.ts:229 |
chat.processFinished | () => void | undefined | Stops the ongoing process. Sends a specific message to the server to stop the process. | packages/codeboltjs/src/modules/chat.ts:166 |
chat.processStarted | (onStopClicked?: (message: StopProcessMessage) => void) => ProcessControl | ProcessControlWithCleanup | undefined | Notifies the server that a process has started and sets up a listener for stopProcessClicked events. | packages/codeboltjs/src/modules/chat.ts:115 |
chat.sendConfirmationRequest | (confirmationMessage: string, buttons: string[], withFeedback: boolean) => Promise<string> | undefined | Sends a confirmation request to the server with two options: Yes or No. | packages/codeboltjs/src/modules/chat.ts:175 |
chat.sendMessage | (message: string, payload?: object) => void | undefined | Sends a message through the WebSocket connection. | packages/codeboltjs/src/modules/chat.ts:89 |
chat.sendNotificationEvent | (notificationMessage: string, type: | "browser" | "terminal" | "git" | "debug" | "planner" | "editor" | "preview") => void | undefined | Sends a notification event to the server. | packages/codeboltjs/src/modules/chat.ts:201 |
chat.setRequestHandler | (handler: RequestHandler) => void | undefined | Sets a global request handler for all incoming messages | packages/codeboltjs/src/modules/chat.ts:58 |
chat.stopProcess | () => void | undefined | Stops the ongoing process. Sends a specific message to the server to stop the process. | packages/codeboltjs/src/modules/chat.ts:157 |
chat.waitforReply | (message: string) => Promise<UserMessage> | undefined | Waits for a reply to a sent message. | packages/codeboltjs/src/modules/chat.ts:101 |
chatSummary | { summarize: (messages: { content: string; role: string; }[], depth: number) => Promise<GetSummarizeResponse>; summarizeAll: () => Promise<GetSummarizeAllResponse>; } | chatSummary | - | packages/codeboltjs/src/core/Codebolt.ts:158 |
chatSummary.summarize | (messages: { content: string; role: string; }[], depth: number) => Promise<GetSummarizeResponse> | undefined | Summarizes a specific part of the chat history. | packages/codeboltjs/src/modules/history.ts:49 |
chatSummary.summarizeAll | () => Promise<GetSummarizeAllResponse> | undefined | Summarizes the entire chat history. | packages/codeboltjs/src/modules/history.ts:32 |
codebaseSearch | { search: (query: string, targetDirectories?: string[]) => Promise<CodebaseSearchResponse>; searchMcpTool: (query: string, tags?: string[]) => Promise<McpToolSearchResponse>; } | cbcodebaseSearch | - | packages/codeboltjs/src/core/Codebolt.ts:178 |
codebaseSearch.search | (query: string, targetDirectories?: string[]) => Promise<CodebaseSearchResponse> | undefined | Perform a semantic search across the codebase | packages/codeboltjs/src/modules/codebaseSearch.ts:21 |
codebaseSearch.searchMcpTool | (query: string, tags?: string[]) => Promise<McpToolSearchResponse> | undefined | Search for MCP tools by query and optional tags | packages/codeboltjs/src/modules/codebaseSearch.ts:39 |
codemap | { create: (data: CreateCodemapData, projectPath?: string) => Promise<CodemapCreateResponse>; delete: (codemapId: string, projectPath?: string) => Promise<CodemapDeleteResponse>; get: (codemapId: string, projectPath?: string) => Promise<CodemapGetResponse>; list: (projectPath?: string) => Promise<CodemapListResponse>; save: (codemapId: string, codemap: Codemap, projectPath?: string) => Promise<CodemapSaveResponse>; setStatus: (codemapId: string, status: CodemapStatus, error?: string, projectPath?: string) => Promise<CodemapUpdateResponse>; update: (codemapId: string, data: UpdateCodemapData, projectPath?: string) => Promise<CodemapUpdateResponse>; } | cbcodemap | - | packages/codeboltjs/src/core/Codebolt.ts:176 |
codemap.create | (data: CreateCodemapData, projectPath?: string) => Promise<CodemapCreateResponse> | undefined | Create a placeholder codemap (status: 'creating') Call this before generating the actual codemap content | packages/codeboltjs/src/modules/codemap.ts:58 |
codemap.delete | (codemapId: string, projectPath?: string) => Promise<CodemapDeleteResponse> | undefined | Delete a codemap | packages/codeboltjs/src/modules/codemap.ts:122 |
codemap.get | (codemapId: string, projectPath?: string) => Promise<CodemapGetResponse> | undefined | Get a specific codemap by ID | packages/codeboltjs/src/modules/codemap.ts:41 |
codemap.list | (projectPath?: string) => Promise<CodemapListResponse> | undefined | List all codemaps for a project | packages/codeboltjs/src/modules/codemap.ts:25 |
codemap.save | (codemapId: string, codemap: Codemap, projectPath?: string) => Promise<CodemapSaveResponse> | undefined | Save a complete codemap with content | packages/codeboltjs/src/modules/codemap.ts:74 |
codemap.setStatus | (codemapId: string, status: CodemapStatus, error?: string, projectPath?: string) => Promise<CodemapUpdateResponse> | undefined | Set the status of a codemap | packages/codeboltjs/src/modules/codemap.ts:90 |
codemap.update | (codemapId: string, data: UpdateCodemapData, projectPath?: string) => Promise<CodemapUpdateResponse> | undefined | Update codemap info (title, description, etc.) | packages/codeboltjs/src/modules/codemap.ts:106 |
codeutils | { getAllFilesAsMarkDown: () => Promise<string>; getMatcherList: () => Promise<GetMatcherListTreeResponse>; matchDetail: (matcher: string) => Promise<getMatchDetail>; performMatch: (matcherDefinition: object, problemPatterns: any[], problems: any[]) => Promise<MatchProblemResponse>; } | cbcodeutils | - | packages/codeboltjs/src/core/Codebolt.ts:144 |
codeutils.getAllFilesAsMarkDown | () => Promise<string> | undefined | Retrieves all files as Markdown. | packages/codeboltjs/src/modules/codeutils.ts:19 |
codeutils.getMatcherList | () => Promise<GetMatcherListTreeResponse> | undefined | Retrieves the list of matchers. | packages/codeboltjs/src/modules/codeutils.ts:55 |
codeutils.matchDetail | (matcher: string) => Promise<getMatchDetail> | undefined | Retrieves details of a match. | packages/codeboltjs/src/modules/codeutils.ts:70 |
codeutils.performMatch | (matcherDefinition: object, problemPatterns: any[], problems: any[]) => Promise<MatchProblemResponse> | undefined | Performs a matching operation based on the provided matcher definition and problem patterns. | packages/codeboltjs/src/modules/codeutils.ts:36 |
contextAssembly | { evaluateRules: (request: ContextAssemblyRequest, ruleEngineIds?: string[]) => Promise<RuleEvaluationResponse>; getContext: (request: ContextAssemblyRequest) => Promise<ContextAssemblyResponse>; getRequiredVariables: (memoryNames: string[]) => Promise<RequiredVariablesResponse>; listMemoryTypes: () => Promise<MemoryTypesResponse>; validate: (request: ContextAssemblyRequest) => Promise<ContextValidateResponse>; } | cbcontextAssembly | - | packages/codeboltjs/src/core/Codebolt.ts:188 |
contextAssembly.evaluateRules | (request: ContextAssemblyRequest, ruleEngineIds?: string[]) => Promise<RuleEvaluationResponse> | undefined | Evaluate rules only without fetching memory content | packages/codeboltjs/src/modules/contextAssembly.ts:67 |
contextAssembly.getContext | (request: ContextAssemblyRequest) => Promise<ContextAssemblyResponse> | undefined | Assemble context from various memory sources | packages/codeboltjs/src/modules/contextAssembly.ts:22 |
contextAssembly.getRequiredVariables | (memoryNames: string[]) => Promise<RequiredVariablesResponse> | undefined | Get required variables for specific memory types | packages/codeboltjs/src/modules/contextAssembly.ts:82 |
contextAssembly.listMemoryTypes | () => Promise<MemoryTypesResponse> | undefined | List available memory types | packages/codeboltjs/src/modules/contextAssembly.ts:51 |
contextAssembly.validate | (request: ContextAssemblyRequest) => Promise<ContextValidateResponse> | undefined | Validate a context assembly request | packages/codeboltjs/src/modules/contextAssembly.ts:37 |
contextRuleEngine | { create: (config: CreateContextRuleEngineParams) => Promise<ContextRuleEngineResponse>; delete: (id: string) => Promise<ContextRuleEngineDeleteResponse>; evaluate: (params: EvaluateRulesParams) => Promise<EvaluateRulesResponse>; get: (id: string) => Promise<ContextRuleEngineResponse>; getPossibleVariables: () => Promise<PossibleVariablesResponse>; list: () => Promise<ContextRuleEngineListResponse>; update: (id: string, updates: UpdateContextRuleEngineParams) => Promise<ContextRuleEngineResponse>; } | cbcontextRuleEngine | - | packages/codeboltjs/src/core/Codebolt.ts:189 |
contextRuleEngine.create | (config: CreateContextRuleEngineParams) => Promise<ContextRuleEngineResponse> | undefined | Create a new rule engine | packages/codeboltjs/src/modules/contextRuleEngine.ts:24 |
contextRuleEngine.delete | (id: string) => Promise<ContextRuleEngineDeleteResponse> | undefined | Delete a rule engine | packages/codeboltjs/src/modules/contextRuleEngine.ts:84 |
contextRuleEngine.evaluate | (params: EvaluateRulesParams) => Promise<EvaluateRulesResponse> | undefined | Evaluate rules against provided variables | packages/codeboltjs/src/modules/contextRuleEngine.ts:99 |
contextRuleEngine.get | (id: string) => Promise<ContextRuleEngineResponse> | undefined | Get a rule engine by ID | packages/codeboltjs/src/modules/contextRuleEngine.ts:39 |
contextRuleEngine.getPossibleVariables | () => Promise<PossibleVariablesResponse> | undefined | Get all possible variables for UI configuration | packages/codeboltjs/src/modules/contextRuleEngine.ts:113 |
contextRuleEngine.list | () => Promise<ContextRuleEngineListResponse> | undefined | List all rule engines | packages/codeboltjs/src/modules/contextRuleEngine.ts:53 |
contextRuleEngine.update | (id: string, updates: UpdateContextRuleEngineParams) => Promise<ContextRuleEngineResponse> | undefined | Update a rule engine | packages/codeboltjs/src/modules/contextRuleEngine.ts:69 |
crawler | { click: (id: string) => Promise<any>; goToPage: (url: string) => void; screenshot: () => void; scroll: (direction: string) => void; start: () => void; } | cbcrawler | - | packages/codeboltjs/src/core/Codebolt.ts:145 |
crawler.click | (id: string) => Promise<any> | undefined | Simulates a click event on an element with the specified ID. | packages/codeboltjs/src/modules/crawler.ts:52 |
crawler.goToPage | (url: string) => void | undefined | Directs the crawler to navigate to a specified URL. | packages/codeboltjs/src/modules/crawler.ts:29 |
crawler.screenshot | () => void | undefined | Takes a screenshot using the crawler. | packages/codeboltjs/src/modules/crawler.ts:19 |
crawler.scroll | (direction: string) => void | undefined | Scrolls the crawler in a specified direction. | packages/codeboltjs/src/modules/crawler.ts:40 |
crawler.start | () => void | undefined | Starts the crawler. | packages/codeboltjs/src/modules/crawler.ts:10 |
dbmemory | { addKnowledge: (key: string, value: MemoryValue) => Promise<MemorySetResponse>; getKnowledge: (key: string) => Promise<MemoryGetResponse>; } | dbmemory | - | packages/codeboltjs/src/core/Codebolt.ts:151 |
dbmemory.addKnowledge | (key: string, value: MemoryValue) => Promise<MemorySetResponse> | undefined | Adds a key-value pair to the in-memory database. | packages/codeboltjs/src/modules/dbmemory.ts:19 |
dbmemory.getKnowledge | (key: string) => Promise<MemoryGetResponse> | undefined | Retrieves a value from the in-memory database by key. | packages/codeboltjs/src/modules/dbmemory.ts:35 |
debug | { debug: (log: string, type: logType) => Promise<DebugAddLogResponse>; openDebugBrowser: (url: string, port: number) => Promise<OpenDebugBrowserResponse>; } | debug | - | packages/codeboltjs/src/core/Codebolt.ts:156 |
debug.debug | (log: string, type: logType) => Promise<DebugAddLogResponse> | undefined | Sends a log message to the debug websocket and waits for a response. | packages/codeboltjs/src/modules/debug.ts:20 |
debug.openDebugBrowser | (url: string, port: number) => Promise<OpenDebugBrowserResponse> | undefined | Requests to open a debug browser at the specified URL and port. | packages/codeboltjs/src/modules/debug.ts:39 |
episodicMemory | { appendEvent: (params: IAppendEventParams) => Promise<IAppendEventResponse>; archiveMemory: (params: IArchiveMemoryParams) => Promise<IArchiveMemoryResponse>; createMemory: (params: ICreateMemoryParams) => Promise<ICreateMemoryResponse>; getAgents: (params: IGetAgentsParams) => Promise<IGetAgentsResponse>; getEventTypes: (params: IGetEventTypesParams) => Promise<IGetEventTypesResponse>; getMemory: (params: IGetMemoryParams) => Promise<IGetMemoryResponse>; getTags: (params: IGetTagsParams) => Promise<IGetTagsResponse>; listMemories: () => Promise<IListMemoriesResponse>; queryEvents: (params: IQueryEventsParams) => Promise<IQueryEventsResponse>; unarchiveMemory: (params: IUnarchiveMemoryParams) => Promise<IUnarchiveMemoryResponse>; updateTitle: (params: IUpdateTitleParams) => Promise<IUpdateTitleResponse>; } | cbepisodicMemory | - | packages/codeboltjs/src/core/Codebolt.ts:174 |
episodicMemory.appendEvent | (params: IAppendEventParams) => Promise<IAppendEventResponse> | undefined | Append an event to an episodic memory | packages/codeboltjs/src/modules/episodicMemory.ts:233 |
episodicMemory.archiveMemory | (params: IArchiveMemoryParams) => Promise<IArchiveMemoryResponse> | undefined | Archive an episodic memory | packages/codeboltjs/src/modules/episodicMemory.ts:308 |
episodicMemory.createMemory | (params: ICreateMemoryParams) => Promise<ICreateMemoryResponse> | undefined | Create a new episodic memory | packages/codeboltjs/src/modules/episodicMemory.ts:190 |
episodicMemory.getAgents | (params: IGetAgentsParams) => Promise<IGetAgentsResponse> | undefined | Get unique agent IDs from an episodic memory | packages/codeboltjs/src/modules/episodicMemory.ts:293 |
episodicMemory.getEventTypes | (params: IGetEventTypesParams) => Promise<IGetEventTypesResponse> | undefined | Get unique event types from an episodic memory | packages/codeboltjs/src/modules/episodicMemory.ts:263 |
episodicMemory.getMemory | (params: IGetMemoryParams) => Promise<IGetMemoryResponse> | undefined | Get a specific episodic memory by ID | packages/codeboltjs/src/modules/episodicMemory.ts:218 |
episodicMemory.getTags | (params: IGetTagsParams) => Promise<IGetTagsResponse> | undefined | Get unique tags from an episodic memory | packages/codeboltjs/src/modules/episodicMemory.ts:278 |
episodicMemory.listMemories | () => Promise<IListMemoriesResponse> | undefined | List all episodic memories | packages/codeboltjs/src/modules/episodicMemory.ts:204 |
episodicMemory.queryEvents | (params: IQueryEventsParams) => Promise<IQueryEventsResponse> | undefined | Query events from an episodic memory with optional filters | packages/codeboltjs/src/modules/episodicMemory.ts:248 |
episodicMemory.unarchiveMemory | (params: IUnarchiveMemoryParams) => Promise<IUnarchiveMemoryResponse> | undefined | Unarchive an episodic memory | packages/codeboltjs/src/modules/episodicMemory.ts:323 |
episodicMemory.updateTitle | (params: IUpdateTitleParams) => Promise<IUpdateTitleResponse> | undefined | Update the title of an episodic memory | packages/codeboltjs/src/modules/episodicMemory.ts:338 |
eventLog | { appendEvent: (params: AppendEventParams) => Promise<EventLogAppendResponse>; appendEvents: (params: AppendEventsParams) => Promise<EventLogAppendMultipleResponse>; createInstance: (name: string, description?: string) => Promise<EventLogInstanceResponse>; deleteInstance: (instanceId: string) => Promise<EventLogInstanceResponse>; getInstance: (instanceId: string) => Promise<EventLogInstanceResponse>; getInstanceStats: (instanceId: string) => Promise<EventLogStatsResponse>; listInstances: () => Promise<EventLogInstanceListResponse>; queryEvents: (query: EventLogDSL) => Promise<EventLogQueryResponse>; updateInstance: (instanceId: string, updates: UpdateEventLogInstanceParams) => Promise<EventLogInstanceResponse>; } | cbeventLog | - | packages/codeboltjs/src/core/Codebolt.ts:184 |
eventLog.appendEvent | (params: AppendEventParams) => Promise<EventLogAppendResponse> | undefined | Append a single event to the log | packages/codeboltjs/src/modules/eventLog.ts:103 |
eventLog.appendEvents | (params: AppendEventsParams) => Promise<EventLogAppendMultipleResponse> | undefined | Append multiple events to the log | packages/codeboltjs/src/modules/eventLog.ts:118 |
eventLog.createInstance | (name: string, description?: string) => Promise<EventLogInstanceResponse> | undefined | Create a new event log instance | packages/codeboltjs/src/modules/eventLog.ts:28 |
eventLog.deleteInstance | (instanceId: string) => Promise<EventLogInstanceResponse> | undefined | Delete an event log instance | packages/codeboltjs/src/modules/eventLog.ts:88 |
eventLog.getInstance | (instanceId: string) => Promise<EventLogInstanceResponse> | undefined | Get an event log instance by ID | packages/codeboltjs/src/modules/eventLog.ts:43 |
eventLog.getInstanceStats | (instanceId: string) => Promise<EventLogStatsResponse> | undefined | Get instance statistics | packages/codeboltjs/src/modules/eventLog.ts:148 |
eventLog.listInstances | () => Promise<EventLogInstanceListResponse> | undefined | List all event log instances | packages/codeboltjs/src/modules/eventLog.ts:57 |
eventLog.queryEvents | (query: EventLogDSL) => Promise<EventLogQueryResponse> | undefined | Query events using DSL | packages/codeboltjs/src/modules/eventLog.ts:133 |
eventLog.updateInstance | (instanceId: string, updates: UpdateEventLogInstanceParams) => Promise<EventLogInstanceResponse> | undefined | Update an event log instance | packages/codeboltjs/src/modules/eventLog.ts:73 |
fileUpdateIntent | { cancel: (id: string, cancelledBy: string) => Promise<FileUpdateIntent>; checkOverlap: (environmentId: string, filePaths: string[], priority: number) => Promise<IntentOverlapResult>; complete: (id: string, closedBy: string) => Promise<FileUpdateIntent>; create: (data: CreateFileUpdateIntentRequest, claimedBy: string, claimedByName?: string) => Promise<{ intent?: FileUpdateIntent; overlap?: IntentOverlapResult; }>; delete: (id: string) => Promise<{ success: boolean; }>; get: (id: string) => Promise<FileUpdateIntent>; getBlockedFiles: (environmentId: string) => Promise<{ blockedFiles: string[]; }>; getByAgent: (agentId: string) => Promise<FileUpdateIntent[]>; getFilesWithIntents: (environmentId: string) => Promise<FileWithIntent[]>; list: (filters: FileUpdateIntentFilters) => Promise<FileUpdateIntent[]>; update: (id: string, data: UpdateFileUpdateIntentRequest) => Promise<FileUpdateIntent>; } | cbfileUpdateIntent | - | packages/codeboltjs/src/core/Codebolt.ts:179 |
fileUpdateIntent.cancel | (id: string, cancelledBy: string) => Promise<FileUpdateIntent> | undefined | Cancel an intent | packages/codeboltjs/src/modules/fileUpdateIntent.ts:100 |
fileUpdateIntent.checkOverlap | (environmentId: string, filePaths: string[], priority: number) => Promise<IntentOverlapResult> | undefined | Check for overlap without creating | packages/codeboltjs/src/modules/fileUpdateIntent.ts:116 |
fileUpdateIntent.complete | (id: string, closedBy: string) => Promise<FileUpdateIntent> | undefined | Complete an intent | packages/codeboltjs/src/modules/fileUpdateIntent.ts:84 |
fileUpdateIntent.create | (data: CreateFileUpdateIntentRequest, claimedBy: string, claimedByName?: string) => Promise<{ intent?: FileUpdateIntent; overlap?: IntentOverlapResult; }> | undefined | Create a new file update intent | packages/codeboltjs/src/modules/fileUpdateIntent.ts:20 |
fileUpdateIntent.delete | (id: string) => Promise<{ success: boolean; }> | undefined | Delete an intent | packages/codeboltjs/src/modules/fileUpdateIntent.ts:180 |
fileUpdateIntent.get | (id: string) => Promise<FileUpdateIntent> | undefined | Get a single intent | packages/codeboltjs/src/modules/fileUpdateIntent.ts:52 |
fileUpdateIntent.getBlockedFiles | (environmentId: string) => Promise<{ blockedFiles: string[]; }> | undefined | Get blocked files (level 4 locks) | packages/codeboltjs/src/modules/fileUpdateIntent.ts:132 |
fileUpdateIntent.getByAgent | (agentId: string) => Promise<FileUpdateIntent[]> | undefined | Get intents by agent | packages/codeboltjs/src/modules/fileUpdateIntent.ts:148 |
fileUpdateIntent.getFilesWithIntents | (environmentId: string) => Promise<FileWithIntent[]> | undefined | Get all files with intents | packages/codeboltjs/src/modules/fileUpdateIntent.ts:164 |
fileUpdateIntent.list | (filters: FileUpdateIntentFilters) => Promise<FileUpdateIntent[]> | undefined | List intents | packages/codeboltjs/src/modules/fileUpdateIntent.ts:68 |
fileUpdateIntent.update | (id: string, data: UpdateFileUpdateIntentRequest) => Promise<FileUpdateIntent> | undefined | Update an existing intent | packages/codeboltjs/src/modules/fileUpdateIntent.ts:36 |
fs | { createFile: (fileName: string, source: string, filePath: string) => Promise<CreateFileResponse>; createFolder: (folderName: string, folderPath: string) => Promise<CreateFolderResponse>; deleteFile: (filename: string, filePath: string) => Promise<DeleteFileResponse>; deleteFolder: (foldername: string, folderpath: string) => Promise<DeleteFolderResponse>; editFileWithDiff: (targetFile: string, codeEdit: string, diffIdentifier: string, prompt: string, applyModel?: string) => Promise<EditFileAndApplyDiffResponse>; fileSearch: (query: string) => Promise<FileSearchResponse>; grepSearch: (path: string, query: string, includePattern?: string, excludePattern?: string, caseSensitive: boolean) => Promise<GrepSearchResponse>; listCodeDefinitionNames: (path: string) => Promise<ListCodeDefinitionsResponse>; listDirectory: (params: { detailed?: boolean; ignore?: string[]; limit?: number; notifyUser?: boolean; path: string; show_hidden?: boolean; }) => Promise<ListDirectoryResponse>; listFile: (folderPath: string, isRecursive: boolean) => Promise<FileListResponse>; readFile: (filePath: string) => Promise<ReadFileResponse>; readManyFiles: (params: { exclude?: string[]; include?: string[]; include_metadata?: boolean; max_files?: number; max_total_size?: number; notifyUser?: boolean; paths: string[]; recursive?: boolean; separator_format?: string; use_default_excludes?: boolean; }) => Promise<ReadManyFilesResponse>; searchFiles: (path: string, regex: string, filePattern: string) => Promise<SearchFilesResponse>; updateFile: (filename: string, filePath: string, newContent: string) => Promise<UpdateFileResponse>; writeToFile: (relPath: string, newContent: string) => Promise<any>; } | cbfs | - | packages/codeboltjs/src/core/Codebolt.ts:135 |
fs.createFile | (fileName: string, source: string, filePath: string) => Promise<CreateFileResponse> | undefined | Function createFile Description Creates a new file. | packages/codeboltjs/src/modules/fs.ts:21 |
fs.createFolder | (folderName: string, folderPath: string) => Promise<CreateFolderResponse> | undefined | Function createFolder Description Creates a new folder. | packages/codeboltjs/src/modules/fs.ts:55 |
fs.deleteFile | (filename: string, filePath: string) => Promise<DeleteFileResponse> | undefined | Function deleteFile Description Deletes a file. | packages/codeboltjs/src/modules/fs.ts:120 |
fs.deleteFolder | (foldername: string, folderpath: string) => Promise<DeleteFolderResponse> | undefined | Function deleteFolder Description Deletes a folder. | packages/codeboltjs/src/modules/fs.ts:140 |
fs.editFileWithDiff | (targetFile: string, codeEdit: string, diffIdentifier: string, prompt: string, applyModel?: string) => Promise<EditFileAndApplyDiffResponse> | undefined | Function editFileWithDiff Description Edits a file by applying a diff. | packages/codeboltjs/src/modules/fs.ts:303 |
fs.fileSearch | (query: string) => Promise<FileSearchResponse> | undefined | Function fileSearch Description Performs a fuzzy search for files. | packages/codeboltjs/src/modules/fs.ts:280 |
fs.grepSearch | (path: string, query: string, includePattern?: string, excludePattern?: string, caseSensitive: boolean) => Promise<GrepSearchResponse> | undefined | Function grepSearch Description Performs a grep search in files. | packages/codeboltjs/src/modules/fs.ts:255 |
fs.listCodeDefinitionNames | (path: string) => Promise<ListCodeDefinitionsResponse> | undefined | Function listCodeDefinitionNames Description Lists all code definition names in a given path. | packages/codeboltjs/src/modules/fs.ts:179 |
fs.listDirectory | (params: { detailed?: boolean; ignore?: string[]; limit?: number; notifyUser?: boolean; path: string; show_hidden?: boolean; }) => Promise<ListDirectoryResponse> | undefined | Function listDirectory Description Lists directory contents using advanced directory listing tool. | packages/codeboltjs/src/modules/fs.ts:370 |
fs.listFile | (folderPath: string, isRecursive: boolean) => Promise<FileListResponse> | undefined | Function listFile Description Lists all files. | packages/codeboltjs/src/modules/fs.ts:158 |
fs.readFile | (filePath: string) => Promise<ReadFileResponse> | undefined | Function readFile Description Reads the content of a file. | packages/codeboltjs/src/modules/fs.ts:80 |
fs.readManyFiles | (params: { exclude?: string[]; include?: string[]; include_metadata?: boolean; max_files?: number; max_total_size?: number; notifyUser?: boolean; paths: string[]; recursive?: boolean; separator_format?: string; use_default_excludes?: boolean; }) => Promise<ReadManyFilesResponse> | undefined | Function readManyFiles Description Reads multiple files based on paths, patterns, or glob expressions. | packages/codeboltjs/src/modules/fs.ts:337 |
fs.searchFiles | (path: string, regex: string, filePattern: string) => Promise<SearchFilesResponse> | undefined | Function searchFiles Description Searches files in a given path using a regex pattern. | packages/codeboltjs/src/modules/fs.ts:200 |
fs.updateFile | (filename: string, filePath: string, newContent: string) => Promise<UpdateFileResponse> | undefined | Function updateFile Description Updates the content of a file. | packages/codeboltjs/src/modules/fs.ts:100 |
fs.writeToFile | (relPath: string, newContent: string) => Promise<any> | undefined | Function writeToFile Description Writes content to a file. | packages/codeboltjs/src/modules/fs.ts:221 |
git | { addAll: () => Promise<AddResponse>; branch: (branch: string) => Promise<GitBranchResponse>; checkout: (branch: string) => Promise<GitCheckoutResponse>; clone: (url: string, path?: string) => Promise<GitCloneResponse>; commit: (message: string) => Promise<GitCommitResponse>; diff: (commitHash: string) => Promise<GitDiffResponse>; init: (path: string) => Promise<GitInitResponse>; logs: (path: string) => Promise<GitLogsResponse>; pull: () => Promise<GitPullResponse>; push: () => Promise<GitPushResponse>; status: () => Promise<GitStatusResponse>; } | git | - | packages/codeboltjs/src/core/Codebolt.ts:136 |
git.addAll | () => Promise<AddResponse> | undefined | Adds changes in the local repository to the staging area at the given path. | packages/codeboltjs/src/modules/git.ts:87 |
git.branch | (branch: string) => Promise<GitBranchResponse> | undefined | Creates a new branch in the local repository at the given path. | packages/codeboltjs/src/modules/git.ts:133 |
git.checkout | (branch: string) => Promise<GitCheckoutResponse> | undefined | Checks out a branch or commit in the local repository at the given path. | packages/codeboltjs/src/modules/git.ts:117 |
git.clone | (url: string, path?: string) => Promise<GitCloneResponse> | undefined | Clones a remote Git repository to the specified path. | packages/codeboltjs/src/modules/git.ts:180 |
git.commit | (message: string) => Promise<GitCommitResponse> | undefined | Commits the staged changes in the local repository with the given commit message. | packages/codeboltjs/src/modules/git.ts:101 |
git.diff | (commitHash: string) => Promise<GitDiffResponse> | undefined | Retrieves the diff of changes for a specific commit in the local repository. | packages/codeboltjs/src/modules/git.ts:164 |
git.init | (path: string) => Promise<GitInitResponse> | undefined | Initializes a new Git repository at the given path. | packages/codeboltjs/src/modules/git.ts:28 |
git.logs | (path: string) => Promise<GitLogsResponse> | undefined | Retrieves the commit logs for the local repository at the given path. | packages/codeboltjs/src/modules/git.ts:148 |
git.pull | () => Promise<GitPullResponse> | undefined | Pulls the latest changes from the remote repository to the local repository at the given path. | packages/codeboltjs/src/modules/git.ts:44 |
git.push | () => Promise<GitPushResponse> | undefined | Pushes local repository changes to the remote repository at the given path. | packages/codeboltjs/src/modules/git.ts:58 |
git.status | () => Promise<GitStatusResponse> | undefined | Retrieves the status of the local repository at the given path. | packages/codeboltjs/src/modules/git.ts:73 |
groupFeedback | { create: (params: ICreateFeedbackParams) => Promise<ICreateFeedbackResponse>; get: (params: IGetFeedbackParams) => Promise<IGetFeedbackResponse>; list: (params?: IListFeedbacksParams) => Promise<IListFeedbacksResponse>; reply: (params: IReplyParams) => Promise<IReplyResponse>; respond: (params: IFeedbackRespondParams) => Promise<IFeedbackRespondResponse>; updateStatus: (params: IUpdateStatusParams) => Promise<IUpdateStatusResponse>; updateSummary: (params: IUpdateSummaryParams) => Promise<IUpdateSummaryResponse>; } | cbgroupFeedback | - | packages/codeboltjs/src/core/Codebolt.ts:139 |
groupFeedback.create | (params: ICreateFeedbackParams) => Promise<ICreateFeedbackResponse> | undefined | - | packages/codeboltjs/src/modules/groupFeedback.ts:22 |
groupFeedback.get | (params: IGetFeedbackParams) => Promise<IGetFeedbackResponse> | undefined | - | packages/codeboltjs/src/modules/groupFeedback.ts:29 |
groupFeedback.list | (params?: IListFeedbacksParams) => Promise<IListFeedbacksResponse> | undefined | - | packages/codeboltjs/src/modules/groupFeedback.ts:36 |
groupFeedback.reply | (params: IReplyParams) => Promise<IReplyResponse> | undefined | - | packages/codeboltjs/src/modules/groupFeedback.ts:50 |
groupFeedback.respond | (params: IFeedbackRespondParams) => Promise<IFeedbackRespondResponse> | undefined | - | packages/codeboltjs/src/modules/groupFeedback.ts:43 |
groupFeedback.updateStatus | (params: IUpdateStatusParams) => Promise<IUpdateStatusResponse> | undefined | - | packages/codeboltjs/src/modules/groupFeedback.ts:64 |
groupFeedback.updateSummary | (params: IUpdateSummaryParams) => Promise<IUpdateSummaryResponse> | undefined | - | packages/codeboltjs/src/modules/groupFeedback.ts:57 |
hook | { create: (config: HookConfig) => Promise<HookResponse>; delete: (hookId: string) => Promise<HookDeleteResponse>; disable: (hookId: string) => Promise<HookResponse>; enable: (hookId: string) => Promise<HookResponse>; get: (hookId: string) => Promise<HookResponse>; initialize: (projectPath: string) => Promise<HookInitializeResponse>; list: () => Promise<HookListResponse>; update: (hookId: string, config: Partial<HookConfig>) => Promise<HookResponse>; } | cbhook | - | packages/codeboltjs/src/core/Codebolt.ts:186 |
hook.create | (config: HookConfig) => Promise<HookResponse> | undefined | Create a new hook | packages/codeboltjs/src/modules/hook.ts:37 |
hook.delete | (hookId: string) => Promise<HookDeleteResponse> | undefined | Delete a hook | packages/codeboltjs/src/modules/hook.ts:70 |
hook.disable | (hookId: string) => Promise<HookResponse> | undefined | Disable a hook | packages/codeboltjs/src/modules/hook.ts:133 |
hook.enable | (hookId: string) => Promise<HookResponse> | undefined | Enable a hook | packages/codeboltjs/src/modules/hook.ts:117 |
hook.get | (hookId: string) => Promise<HookResponse> | undefined | Get a hook by ID | packages/codeboltjs/src/modules/hook.ts:101 |
hook.initialize | (projectPath: string) => Promise<HookInitializeResponse> | undefined | Initialize the hook manager for a project | packages/codeboltjs/src/modules/hook.ts:21 |
hook.list | () => Promise<HookListResponse> | undefined | List all hooks | packages/codeboltjs/src/modules/hook.ts:85 |
hook.update | (hookId: string, config: Partial<HookConfig>) => Promise<HookResponse> | undefined | Update an existing hook | packages/codeboltjs/src/modules/hook.ts:54 |
job | { acceptBid: (jobId: string, bidId: string) => Promise<JobBidAcceptResponse>; acceptSplitProposal: (jobId: string, proposalId: string) => Promise<JobSplitAcceptResponse>; addBid: (jobId: string, bid: AddBidData) => Promise<JobBidAddResponse>; addBlocker: (jobId: string, blocker: AddBlockerData) => Promise<JobBlockerAddResponse>; addDependency: (jobId: string, targetId: string, type?: DependencyType) => Promise<JobDependencyResponse>; addLabel: (label: string) => Promise<JobLabelsResponse>; addPheromoneType: (data: AddPheromoneTypeData) => Promise<JobPheromoneTypeResponse>; addSplitProposal: (jobId: string, proposal: AddSplitProposalData) => Promise<JobSplitProposeResponse>; addUnlockRequest: (jobId: string, request: AddUnlockRequestData) => Promise<JobUnlockRequestAddResponse>; approveUnlockRequest: (jobId: string, unlockRequestId: string, respondedBy: string) => Promise<JobUnlockRequestApproveResponse>; createJob: (groupId: string, data: CreateJobData) => Promise<JobCreateResponse>; createJobGroup: (data: CreateJobGroupData) => Promise<JobGroupCreateResponse>; deleteJob: (jobId: string) => Promise<JobDeleteResponse>; deleteJobs: (jobIds: string[]) => Promise<JobDeleteBulkResponse>; deleteSplitProposal: (jobId: string, proposalId: string) => Promise<JobSplitDeleteResponse>; deleteUnlockRequest: (jobId: string, unlockRequestId: string) => Promise<JobUnlockRequestDeleteResponse>; depositPheromone: (jobId: string, deposit: DepositPheromoneData) => Promise<JobPheromoneDepositResponse>; getBlockedJobs: (filters: JobListFilters) => Promise<JobReadyBlockedResponse>; getJob: (jobId: string) => Promise<JobShowResponse>; getPheromones: (jobId: string) => Promise<JobPheromoneListResponse>; getPheromonesAggregated: (jobId: string) => Promise<JobPheromoneAggregatedResponse>; getPheromonesAggregatedWithDecay: (jobId: string) => Promise<JobPheromoneAggregatedResponse>; getPheromonesWithDecay: (jobId: string) => Promise<JobPheromoneListResponse>; getPheromoneTypes: () => Promise<JobPheromoneTypesResponse>; getReadyJobs: (filters: JobListFilters) => Promise<JobReadyBlockedResponse>; isJobLocked: (jobId: string) => Promise<JobLockCheckResponse>; listBids: (jobId: string) => Promise<JobBidListResponse>; listJobs: (filters: JobListFilters) => Promise<JobListResponse>; listJobsByPheromone: (type: string, minIntensity?: number) => Promise<JobPheromoneSearchResponse>; listLabels: () => Promise<JobLabelsResponse>; lockJob: (jobId: string, agentId: string, agentName?: string) => Promise<JobLockAcquireResponse>; rejectUnlockRequest: (jobId: string, unlockRequestId: string, respondedBy: string) => Promise<JobUnlockRequestRejectResponse>; removeBlocker: (jobId: string, blockerId: string) => Promise<JobBlockerRemoveResponse>; removeDependency: (jobId: string, targetId: string) => Promise<JobDependencyResponse>; removeLabel: (label: string) => Promise<JobLabelsResponse>; removePheromone: (jobId: string, type: string, depositedBy?: string) => Promise<JobPheromoneRemoveResponse>; removePheromoneType: (name: string) => Promise<JobPheromoneTypeResponse>; resolveBlocker: (jobId: string, blockerId: string, resolvedBy: string) => Promise<JobBlockerResolveResponse>; unlockJob: (jobId: string, agentId: string) => Promise<JobLockReleaseResponse>; updateJob: (jobId: string, data: UpdateJobData) => Promise<JobUpdateResponse>; withdrawBid: (jobId: string, bidId: string) => Promise<JobBidWithdrawResponse>; } | job | - | packages/codeboltjs/src/core/Codebolt.ts:168 |
job.acceptBid | (jobId: string, bidId: string) => Promise<JobBidAcceptResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:570 |
job.acceptSplitProposal | (jobId: string, proposalId: string) => Promise<JobSplitAcceptResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:428 |
job.addBid | (jobId: string, bid: AddBidData) => Promise<JobBidAddResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:544 |
job.addBlocker | (jobId: string, blocker: AddBlockerData) => Promise<JobBlockerAddResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:600 |
job.addDependency | (jobId: string, targetId: string, type?: DependencyType) => Promise<JobDependencyResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:161 |
job.addLabel | (label: string) => Promise<JobLabelsResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:221 |
job.addPheromoneType | (data: AddPheromoneTypeData) => Promise<JobPheromoneTypeResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:277 |
job.addSplitProposal | (jobId: string, proposal: AddSplitProposalData) => Promise<JobSplitProposeResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:402 |
job.addUnlockRequest | (jobId: string, request: AddUnlockRequestData) => Promise<JobUnlockRequestAddResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:488 |
job.approveUnlockRequest | (jobId: string, unlockRequestId: string, respondedBy: string) => Promise<JobUnlockRequestApproveResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:501 |
job.createJob | (groupId: string, data: CreateJobData) => Promise<JobCreateResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:62 |
job.createJobGroup | (data: CreateJobGroupData) => Promise<JobGroupCreateResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:144 |
job.deleteJob | (jobId: string) => Promise<JobDeleteResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:101 |
job.deleteJobs | (jobIds: string[]) => Promise<JobDeleteBulkResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:114 |
job.deleteSplitProposal | (jobId: string, proposalId: string) => Promise<JobSplitDeleteResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:415 |
job.deleteUnlockRequest | (jobId: string, unlockRequestId: string) => Promise<JobUnlockRequestDeleteResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:527 |
job.depositPheromone | (jobId: string, deposit: DepositPheromoneData) => Promise<JobPheromoneDepositResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:307 |
job.getBlockedJobs | (filters: JobListFilters) => Promise<JobReadyBlockedResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:204 |
job.getJob | (jobId: string) => Promise<JobShowResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:75 |
job.getPheromones | (jobId: string) => Promise<JobPheromoneListResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:333 |
job.getPheromonesAggregated | (jobId: string) => Promise<JobPheromoneAggregatedResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:346 |
job.getPheromonesAggregatedWithDecay | (jobId: string) => Promise<JobPheromoneAggregatedResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:385 |
job.getPheromonesWithDecay | (jobId: string) => Promise<JobPheromoneListResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:372 |
job.getPheromoneTypes | () => Promise<JobPheromoneTypesResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:264 |
job.getReadyJobs | (filters: JobListFilters) => Promise<JobReadyBlockedResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:191 |
job.isJobLocked | (jobId: string) => Promise<JobLockCheckResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:471 |
job.listBids | (jobId: string) => Promise<JobBidListResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:583 |
job.listJobs | (filters: JobListFilters) => Promise<JobListResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:127 |
job.listJobsByPheromone | (type: string, minIntensity?: number) => Promise<JobPheromoneSearchResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:359 |
job.listLabels | () => Promise<JobLabelsResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:247 |
job.lockJob | (jobId: string, agentId: string, agentName?: string) => Promise<JobLockAcquireResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:445 |
job.rejectUnlockRequest | (jobId: string, unlockRequestId: string, respondedBy: string) => Promise<JobUnlockRequestRejectResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:514 |
job.removeBlocker | (jobId: string, blockerId: string) => Promise<JobBlockerRemoveResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:613 |
job.removeDependency | (jobId: string, targetId: string) => Promise<JobDependencyResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:174 |
job.removeLabel | (label: string) => Promise<JobLabelsResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:234 |
job.removePheromone | (jobId: string, type: string, depositedBy?: string) => Promise<JobPheromoneRemoveResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:320 |
job.removePheromoneType | (name: string) => Promise<JobPheromoneTypeResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:290 |
job.resolveBlocker | (jobId: string, blockerId: string, resolvedBy: string) => Promise<JobBlockerResolveResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:626 |
job.unlockJob | (jobId: string, agentId: string) => Promise<JobLockReleaseResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:458 |
job.updateJob | (jobId: string, data: UpdateJobData) => Promise<JobUpdateResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:88 |
job.withdrawBid | (jobId: string, bidId: string) => Promise<JobBidWithdrawResponse> | undefined | - | packages/codeboltjs/src/modules/job.ts:557 |
knowledge | { } | cbknowledge | - | packages/codeboltjs/src/core/Codebolt.ts:147 |
knowledgeGraph | { addEdge: (instanceId: string, edge: CreateKGEdgeParams) => Promise<KGEdgeResponse>; addEdges: (instanceId: string, edges: CreateKGEdgeParams[]) => Promise<KGEdgeListResponse>; addMemoryRecord: (instanceId: string, record: CreateKGMemoryRecordParams) => Promise<KGMemoryRecordResponse>; addMemoryRecords: (instanceId: string, records: CreateKGMemoryRecordParams[]) => Promise<KGMemoryRecordListResponse>; createInstance: (config: CreateKGInstanceParams) => Promise<KGInstanceResponse>; createInstanceTemplate: (config: CreateKGInstanceTemplateParams) => Promise<KGInstanceTemplateResponse>; createView: (config: CreateKGViewParams) => Promise<KGViewResponse>; createViewTemplate: (config: CreateKGViewTemplateParams) => Promise<KGViewTemplateResponse>; deleteEdge: (instanceId: string, edgeId: string) => Promise<KGDeleteResponse>; deleteInstance: (instanceId: string) => Promise<KGDeleteResponse>; deleteInstanceTemplate: (templateId: string) => Promise<KGDeleteResponse>; deleteMemoryRecord: (instanceId: string, recordId: string) => Promise<KGDeleteResponse>; deleteView: (viewId: string) => Promise<KGDeleteResponse>; deleteViewTemplate: (templateId: string) => Promise<KGDeleteResponse>; executeView: (viewId: string) => Promise<KGViewExecuteResponse>; getInstance: (instanceId: string) => Promise<KGInstanceResponse>; getInstanceTemplate: (templateId: string) => Promise<KGInstanceTemplateResponse>; getMemoryRecord: (instanceId: string, recordId: string) => Promise<KGMemoryRecordResponse>; getViewTemplate: (templateId: string) => Promise<KGViewTemplateResponse>; listEdges: (instanceId: string, filters?: ListKGEdgesParams) => Promise<KGEdgeListResponse>; listInstances: (templateId?: string) => Promise<KGInstanceListResponse>; listInstanceTemplates: () => Promise<KGInstanceTemplateListResponse>; listMemoryRecords: (instanceId: string, filters?: ListKGMemoryRecordsParams) => Promise<KGMemoryRecordListResponse>; listViews: (instanceId: string) => Promise<KGViewListResponse>; listViewTemplates: (applicableTemplateId?: string) => Promise<KGViewTemplateListResponse>; updateInstanceTemplate: (templateId: string, updates: Partial<CreateKGInstanceTemplateParams>) => Promise<KGInstanceTemplateResponse>; updateMemoryRecord: (instanceId: string, recordId: string, updates: Partial<CreateKGMemoryRecordParams>) => Promise<KGMemoryRecordResponse>; updateViewTemplate: (templateId: string, updates: Partial<CreateKGViewTemplateParams>) => Promise<KGViewTemplateResponse>; } | cbknowledgeGraph | - | packages/codeboltjs/src/core/Codebolt.ts:185 |
knowledgeGraph.addEdge | (instanceId: string, edge: CreateKGEdgeParams) => Promise<KGEdgeResponse> | undefined | Add an edge to an instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:287 |
knowledgeGraph.addEdges | (instanceId: string, edges: CreateKGEdgeParams[]) => Promise<KGEdgeListResponse> | undefined | Add multiple edges to an instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:303 |
knowledgeGraph.addMemoryRecord | (instanceId: string, record: CreateKGMemoryRecordParams) => Promise<KGMemoryRecordResponse> | undefined | Add a memory record to an instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:186 |
knowledgeGraph.addMemoryRecords | (instanceId: string, records: CreateKGMemoryRecordParams[]) => Promise<KGMemoryRecordListResponse> | undefined | Add multiple memory records to an instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:202 |
knowledgeGraph.createInstance | (config: CreateKGInstanceParams) => Promise<KGInstanceResponse> | undefined | Create a new knowledge graph instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:121 |
knowledgeGraph.createInstanceTemplate | (config: CreateKGInstanceTemplateParams) => Promise<KGInstanceTemplateResponse> | undefined | Create a new instance template | packages/codeboltjs/src/modules/knowledgeGraph.ts:42 |
knowledgeGraph.createView | (config: CreateKGViewParams) => Promise<KGViewResponse> | undefined | Create a view | packages/codeboltjs/src/modules/knowledgeGraph.ts:434 |
knowledgeGraph.createViewTemplate | (config: CreateKGViewTemplateParams) => Promise<KGViewTemplateResponse> | undefined | Create a view template | packages/codeboltjs/src/modules/knowledgeGraph.ts:354 |
knowledgeGraph.deleteEdge | (instanceId: string, edgeId: string) => Promise<KGDeleteResponse> | undefined | Delete an edge | packages/codeboltjs/src/modules/knowledgeGraph.ts:335 |
knowledgeGraph.deleteInstance | (instanceId: string) => Promise<KGDeleteResponse> | undefined | Delete an instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:166 |
knowledgeGraph.deleteInstanceTemplate | (templateId: string) => Promise<KGDeleteResponse> | undefined | Delete an instance template | packages/codeboltjs/src/modules/knowledgeGraph.ts:102 |
knowledgeGraph.deleteMemoryRecord | (instanceId: string, recordId: string) => Promise<KGDeleteResponse> | undefined | Delete a memory record | packages/codeboltjs/src/modules/knowledgeGraph.ts:267 |
knowledgeGraph.deleteView | (viewId: string) => Promise<KGDeleteResponse> | undefined | Delete a view | packages/codeboltjs/src/modules/knowledgeGraph.ts:479 |
knowledgeGraph.deleteViewTemplate | (templateId: string) => Promise<KGDeleteResponse> | undefined | Delete a view template | packages/codeboltjs/src/modules/knowledgeGraph.ts:415 |
knowledgeGraph.executeView | (viewId: string) => Promise<KGViewExecuteResponse> | undefined | Execute a view query | packages/codeboltjs/src/modules/knowledgeGraph.ts:464 |
knowledgeGraph.getInstance | (instanceId: string) => Promise<KGInstanceResponse> | undefined | Get an instance by ID | packages/codeboltjs/src/modules/knowledgeGraph.ts:136 |
knowledgeGraph.getInstanceTemplate | (templateId: string) => Promise<KGInstanceTemplateResponse> | undefined | Get an instance template by ID | packages/codeboltjs/src/modules/knowledgeGraph.ts:57 |
knowledgeGraph.getMemoryRecord | (instanceId: string, recordId: string) => Promise<KGMemoryRecordResponse> | undefined | Get a memory record by ID | packages/codeboltjs/src/modules/knowledgeGraph.ts:218 |
knowledgeGraph.getViewTemplate | (templateId: string) => Promise<KGViewTemplateResponse> | undefined | Get a view template by ID | packages/codeboltjs/src/modules/knowledgeGraph.ts:369 |
knowledgeGraph.listEdges | (instanceId: string, filters?: ListKGEdgesParams) => Promise<KGEdgeListResponse> | undefined | List edges in an instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:319 |
knowledgeGraph.listInstances | (templateId?: string) => Promise<KGInstanceListResponse> | undefined | List instances, optionally filtered by template | packages/codeboltjs/src/modules/knowledgeGraph.ts:151 |
knowledgeGraph.listInstanceTemplates | () => Promise<KGInstanceTemplateListResponse> | undefined | List all instance templates | packages/codeboltjs/src/modules/knowledgeGraph.ts:71 |
knowledgeGraph.listMemoryRecords | (instanceId: string, filters?: ListKGMemoryRecordsParams) => Promise<KGMemoryRecordListResponse> | undefined | List memory records in an instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:234 |
knowledgeGraph.listViews | (instanceId: string) => Promise<KGViewListResponse> | undefined | List views for an instance | packages/codeboltjs/src/modules/knowledgeGraph.ts:449 |
knowledgeGraph.listViewTemplates | (applicableTemplateId?: string) => Promise<KGViewTemplateListResponse> | undefined | List view templates | packages/codeboltjs/src/modules/knowledgeGraph.ts:384 |
knowledgeGraph.updateInstanceTemplate | (templateId: string, updates: Partial<CreateKGInstanceTemplateParams>) => Promise<KGInstanceTemplateResponse> | undefined | Update an instance template | packages/codeboltjs/src/modules/knowledgeGraph.ts:87 |
knowledgeGraph.updateMemoryRecord | (instanceId: string, recordId: string, updates: Partial<CreateKGMemoryRecordParams>) => Promise<KGMemoryRecordResponse> | undefined | Update a memory record | packages/codeboltjs/src/modules/knowledgeGraph.ts:251 |
knowledgeGraph.updateViewTemplate | (templateId: string, updates: Partial<CreateKGViewTemplateParams>) => Promise<KGViewTemplateResponse> | undefined | Update a view template | packages/codeboltjs/src/modules/knowledgeGraph.ts:400 |
kvStore | { createInstance: (name: string, description?: string) => Promise<KVInstanceResponse>; delete: (instanceId: string, namespace: string, key: string) => Promise<KVDeleteResponse>; deleteInstance: (instanceId: string) => Promise<KVDeleteResponse>; deleteNamespace: (instanceId: string, namespace: string) => Promise<KVDeleteNamespaceResponse>; get: (instanceId: string, namespace: string, key: string) => Promise<KVGetResponse>; getInstance: (instanceId: string) => Promise<KVInstanceResponse>; getNamespaces: (instanceId: string) => Promise<KVNamespacesResponse>; getRecordCount: (instanceId: string, namespace?: string) => Promise<KVRecordCountResponse>; listInstances: () => Promise<KVInstanceListResponse>; query: (query: KVQueryDSL) => Promise<KVQueryResponse>; set: (instanceId: string, namespace: string, key: string, value: any, autoCreateInstance: boolean) => Promise<KVSetResponse>; updateInstance: (instanceId: string, updates: UpdateKVInstanceParams) => Promise<KVInstanceResponse>; } | cbkvStore | - | packages/codeboltjs/src/core/Codebolt.ts:182 |
kvStore.createInstance | (name: string, description?: string) => Promise<KVInstanceResponse> | undefined | Create a new KV store instance | packages/codeboltjs/src/modules/kvStore.ts:30 |
kvStore.delete | (instanceId: string, namespace: string, key: string) => Promise<KVDeleteResponse> | undefined | Delete a value from the KV store | packages/codeboltjs/src/modules/kvStore.ts:149 |
kvStore.deleteInstance | (instanceId: string) => Promise<KVDeleteResponse> | undefined | Delete a KV store instance | packages/codeboltjs/src/modules/kvStore.ts:90 |
kvStore.deleteNamespace | (instanceId: string, namespace: string) => Promise<KVDeleteNamespaceResponse> | undefined | Delete an entire namespace from the KV store | packages/codeboltjs/src/modules/kvStore.ts:165 |
kvStore.get | (instanceId: string, namespace: string, key: string) => Promise<KVGetResponse> | undefined | Get a value from the KV store | packages/codeboltjs/src/modules/kvStore.ts:107 |
kvStore.getInstance | (instanceId: string) => Promise<KVInstanceResponse> | undefined | Get a KV store instance by ID | packages/codeboltjs/src/modules/kvStore.ts:45 |
kvStore.getNamespaces | (instanceId: string) => Promise<KVNamespacesResponse> | undefined | Get all namespaces in an instance | packages/codeboltjs/src/modules/kvStore.ts:195 |
kvStore.getRecordCount | (instanceId: string, namespace?: string) => Promise<KVRecordCountResponse> | undefined | Get record count for an instance or namespace | packages/codeboltjs/src/modules/kvStore.ts:211 |
kvStore.listInstances | () => Promise<KVInstanceListResponse> | undefined | List all KV store instances | packages/codeboltjs/src/modules/kvStore.ts:59 |
kvStore.query | (query: KVQueryDSL) => Promise<KVQueryResponse> | undefined | Query the KV store using DSL | packages/codeboltjs/src/modules/kvStore.ts:180 |
kvStore.set | (instanceId: string, namespace: string, key: string, value: any, autoCreateInstance: boolean) => Promise<KVSetResponse> | undefined | Set a value in the KV store | packages/codeboltjs/src/modules/kvStore.ts:126 |
kvStore.updateInstance | (instanceId: string, updates: UpdateKVInstanceParams) => Promise<KVInstanceResponse> | undefined | Update a KV store instance | packages/codeboltjs/src/modules/kvStore.ts:75 |
llm | { getModelConfig: (modelId?: string) => Promise<{ config: LLMModelConfig | null; error?: string; success: boolean; }>; inference: (params: LLMInferenceParams) => Promise<{ completion: LLMCompletion; }>; } | cbllm | - | packages/codeboltjs/src/core/Codebolt.ts:137 |
llm.getModelConfig | (modelId?: string) => Promise<{ config: LLMModelConfig | null; error?: string; success: boolean; }> | undefined | Gets the model configuration for a specific model or the default application model. If modelId is provided, returns configuration for that specific model. If modelId is not provided, returns the default application LLM configuration. | packages/codeboltjs/src/modules/llm.ts:51 |
llm.inference | (params: LLMInferenceParams) => Promise<{ completion: LLMCompletion; }> | undefined | Sends an inference request to the LLM using OpenAI message format with tools support. The model is selected based on the provided llmrole. If the specific model for the role is not found, it falls back to the default model for the current agent, and ultimately to the default application-wide LLM if necessary. | packages/codeboltjs/src/modules/llm.ts:28 |
mail | { acknowledge: (params: IAcknowledgeParams) => Promise<IAcknowledgeResponse>; archiveThread: (params: IArchiveThreadParams) => Promise<IArchiveThreadResponse>; checkConflicts: (params: ICheckConflictsParams) => Promise<ICheckConflictsResponse>; createThread: (params: ICreateThreadParams) => Promise<ICreateThreadResponse>; fetchInbox: (params: IFetchInboxParams) => Promise<IFetchInboxResponse>; findOrCreateThread: (params: IFindOrCreateThreadParams) => Promise<IFindOrCreateThreadResponse>; forceReserveFiles: (params: IForceReserveFilesParams) => Promise<IForceReserveFilesResponse>; getAgent: (params: IGetAgentParams) => Promise<IGetAgentResponse>; getMessage: (params: IGetMessageParams) => Promise<IGetMessageResponse>; getMessages: (params: IGetMessagesParams) => Promise<IGetMessagesResponse>; getThread: (params: IGetThreadParams) => Promise<IGetThreadResponse>; listAgents: () => Promise<IListAgentsResponse>; listReservations: (params: IListReservationsParams) => Promise<IListReservationsResponse>; listThreads: (params: IListThreadsParams) => Promise<IListThreadsResponse>; markRead: (params: IMarkReadParams) => Promise<IMarkReadResponse>; registerAgent: (params: IRegisterAgentParams) => Promise<IRegisterAgentResponse>; releaseFiles: (params: IReleaseFilesParams) => Promise<IReleaseFilesResponse>; replyMessage: (params: IReplyMessageParams) => Promise<IReplyMessageResponse>; reserveFiles: (params: IReserveFilesParams) => Promise<IReserveFilesResponse>; search: (params: ISearchParams) => Promise<ISearchResponse>; sendMessage: (params: ISendMessageParams) => Promise<ISendMessageResponse>; summarizeThread: (params: ISummarizeThreadParams) => Promise<ISummarizeThreadResponse>; updateThreadStatus: (params: IUpdateThreadStatusParams) => Promise<IUpdateThreadStatusResponse>; } | cbmail | - | packages/codeboltjs/src/core/Codebolt.ts:138 |
mail.acknowledge | (params: IAcknowledgeParams) => Promise<IAcknowledgeResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:226 |
mail.archiveThread | (params: IArchiveThreadParams) => Promise<IArchiveThreadResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:152 |
mail.checkConflicts | (params: ICheckConflictsParams) => Promise<ICheckConflictsResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:297 |
mail.createThread | (params: ICreateThreadParams) => Promise<ICreateThreadResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:100 |
mail.fetchInbox | (params: IFetchInboxParams) => Promise<IFetchInboxResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:163 |
mail.findOrCreateThread | (params: IFindOrCreateThreadParams) => Promise<IFindOrCreateThreadResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:111 |
mail.forceReserveFiles | (params: IForceReserveFilesParams) => Promise<IForceReserveFilesResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:277 |
mail.getAgent | (params: IGetAgentParams) => Promise<IGetAgentResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:89 |
mail.getMessage | (params: IGetMessageParams) => Promise<IGetMessageResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:196 |
mail.getMessages | (params: IGetMessagesParams) => Promise<IGetMessagesResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:206 |
mail.getThread | (params: IGetThreadParams) => Promise<IGetThreadResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:132 |
mail.listAgents | () => Promise<IListAgentsResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:80 |
mail.listReservations | (params: IListReservationsParams) => Promise<IListReservationsResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:287 |
mail.listThreads | (params: IListThreadsParams) => Promise<IListThreadsResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:122 |
mail.markRead | (params: IMarkReadParams) => Promise<IMarkReadResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:216 |
mail.registerAgent | (params: IRegisterAgentParams) => Promise<IRegisterAgentResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:70 |
mail.releaseFiles | (params: IReleaseFilesParams) => Promise<IReleaseFilesResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:267 |
mail.replyMessage | (params: IReplyMessageParams) => Promise<IReplyMessageResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:186 |
mail.reserveFiles | (params: IReserveFilesParams) => Promise<IReserveFilesResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:257 |
mail.search | (params: ISearchParams) => Promise<ISearchResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:236 |
mail.sendMessage | (params: ISendMessageParams) => Promise<ISendMessageResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:173 |
mail.summarizeThread | (params: ISummarizeThreadParams) => Promise<ISummarizeThreadResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:246 |
mail.updateThreadStatus | (params: IUpdateThreadStatusParams) => Promise<IUpdateThreadStatusResponse> | undefined | - | packages/codeboltjs/src/modules/mail.ts:142 |
mcp | { configureMCPServer: (name: string, config: MCPConfiguration) => Promise<ConfigureToolBoxResponse>; configureMcpTool: (mcpName: string, toolName: string, config: Record<string, unknown>) => Promise<ConfigureMCPToolResponse>; executeTool: (toolbox: string, toolName: string, params: ToolParameters) => Promise<ExecuteToolResponse>; getAllMcpTools: () => Promise<GetAllMCPToolsResponse>; getEnabledMcps: () => Promise<GetEnabledMCPSResponse>; getEnabledMCPServers: () => Promise<GetEnabledToolBoxesResponse>; getLocalMCPServers: () => Promise<GetLocalToolBoxesResponse>; getMcpList: () => Promise<GetMcpListResponse>; getMcpTools: (mcpNames?: string[]) => Promise<GetMcpToolsResponse>; getMentionedMCPServers: (userMessage: MCPUserMessage) => Promise<GetAvailableToolBoxesResponse>; getTools: (toolRequests: { toolbox: string; toolName: string; }[]) => Promise<GetToolsResponse>; listMcpFromServers: (toolBoxes: string[]) => Promise<ListToolsFromToolBoxesResponse>; searchAvailableMCPServers: (query: string) => Promise<SearchAvailableToolBoxesResponse>; } | codeboltTools | - | packages/codeboltjs/src/core/Codebolt.ts:159 |
mcp.configureMCPServer | (name: string, config: MCPConfiguration) => Promise<ConfigureToolBoxResponse> | undefined | Configures a specific toolbox with provided configuration. | packages/codeboltjs/src/modules/mcp.ts:180 |
mcp.configureMcpTool | (mcpName: string, toolName: string, config: Record<string, unknown>) => Promise<ConfigureMCPToolResponse> | undefined | Configures a specific MCP tool with provided configuration. | packages/codeboltjs/src/modules/mcp.ts:399 |
mcp.executeTool | (toolbox: string, toolName: string, params: ToolParameters) => Promise<ExecuteToolResponse> | undefined | Executes a specific tool with provided parameters. | packages/codeboltjs/src/modules/mcp.ts:249 |
mcp.getAllMcpTools | () => Promise<GetAllMCPToolsResponse> | undefined | Gets all tools from all enabled MCP servers. | packages/codeboltjs/src/modules/mcp.ts:358 |
mcp.getEnabledMcps | () => Promise<GetEnabledMCPSResponse> | undefined | Gets the list of enabled MCP servers. | packages/codeboltjs/src/modules/mcp.ts:381 |
mcp.getEnabledMCPServers | () => Promise<GetEnabledToolBoxesResponse> | undefined | Gets the list of currently enabled toolboxes. | packages/codeboltjs/src/modules/mcp.ts:71 |
mcp.getLocalMCPServers | () => Promise<GetLocalToolBoxesResponse> | undefined | Gets the list of locally available toolboxes. | packages/codeboltjs/src/modules/mcp.ts:86 |
mcp.getMcpList | () => Promise<GetMcpListResponse> | undefined | Gets the list of available MCP servers. | packages/codeboltjs/src/modules/mcp.ts:343 |
mcp.getMcpTools | (mcpNames?: string[]) => Promise<GetMcpToolsResponse> | undefined | Gets MCP tools from the specified servers. | packages/codeboltjs/src/modules/mcp.ts:308 |
mcp.getMentionedMCPServers | (userMessage: MCPUserMessage) => Promise<GetAvailableToolBoxesResponse> | undefined | Gets toolboxes mentioned in a user message. | packages/codeboltjs/src/modules/mcp.ts:102 |
mcp.getTools | (toolRequests: { toolbox: string; toolName: string; }[]) => Promise<GetToolsResponse> | undefined | Gets detailed information about specific tools. | packages/codeboltjs/src/modules/mcp.ts:198 |
mcp.listMcpFromServers | (toolBoxes: string[]) => Promise<ListToolsFromToolBoxesResponse> | undefined | Lists all tools from the specified toolboxes. | packages/codeboltjs/src/modules/mcp.ts:135 |
mcp.searchAvailableMCPServers | (query: string) => Promise<SearchAvailableToolBoxesResponse> | undefined | Searches for available toolboxes matching a query. | packages/codeboltjs/src/modules/mcp.ts:118 |
memory | { json: { delete: (memoryId: string) => Promise<DeleteMemoryResponse>; list: (filters: Record<string, unknown>) => Promise<ListMemoryResponse>; save: (json: any) => Promise<SaveMemoryResponse>; update: (memoryId: string, json: any) => Promise<UpdateMemoryResponse>; }; markdown: { delete: (memoryId: string) => Promise<DeleteMemoryResponse>; list: (filters: Record<string, unknown>) => Promise<ListMemoryResponse>; save: (markdown: string, metadata: Record<string, unknown>) => Promise<SaveMemoryResponse>; update: (memoryId: string, markdown: string, metadata: Record<string, unknown>) => Promise<UpdateMemoryResponse>; }; todo: { delete: (memoryId: string) => Promise<DeleteMemoryResponse>; list: (filters: Record<string, unknown>) => Promise<ListMemoryResponse>; save: (todo: | { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; } | { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; }[], metadata: Record<string, unknown>) => Promise<SaveMemoryResponse>; update: (memoryId: string, todo: { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; }) => Promise<UpdateMemoryResponse>; }; } | codebotMemory | - | packages/codeboltjs/src/core/Codebolt.ts:163 |
memory.json | { delete: (memoryId: string) => Promise<DeleteMemoryResponse>; list: (filters: Record<string, unknown>) => Promise<ListMemoryResponse>; save: (json: any) => Promise<SaveMemoryResponse>; update: (memoryId: string, json: any) => Promise<UpdateMemoryResponse>; } | undefined | - | packages/codeboltjs/src/modules/memory.ts:47 |
memory.json.delete | (memoryId: string) => Promise<DeleteMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:75 |
memory.json.list | (filters: Record<string, unknown>) => Promise<ListMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:88 |
memory.json.save | (json: any) => Promise<SaveMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:48 |
memory.json.update | (memoryId: string, json: any) => Promise<UpdateMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:61 |
memory.markdown | { delete: (memoryId: string) => Promise<DeleteMemoryResponse>; list: (filters: Record<string, unknown>) => Promise<ListMemoryResponse>; save: (markdown: string, metadata: Record<string, unknown>) => Promise<SaveMemoryResponse>; update: (memoryId: string, markdown: string, metadata: Record<string, unknown>) => Promise<UpdateMemoryResponse>; } | undefined | - | packages/codeboltjs/src/modules/memory.ts:158 |
memory.markdown.delete | (memoryId: string) => Promise<DeleteMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:188 |
memory.markdown.list | (filters: Record<string, unknown>) => Promise<ListMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:201 |
memory.markdown.save | (markdown: string, metadata: Record<string, unknown>) => Promise<SaveMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:159 |
memory.markdown.update | (memoryId: string, markdown: string, metadata: Record<string, unknown>) => Promise<UpdateMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:173 |
memory.todo | { delete: (memoryId: string) => Promise<DeleteMemoryResponse>; list: (filters: Record<string, unknown>) => Promise<ListMemoryResponse>; save: (todo: | { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; } | { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; }[], metadata: Record<string, unknown>) => Promise<SaveMemoryResponse>; update: (memoryId: string, todo: { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; }) => Promise<UpdateMemoryResponse>; } | undefined | - | packages/codeboltjs/src/modules/memory.ts:102 |
memory.todo.delete | (memoryId: string) => Promise<DeleteMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:131 |
memory.todo.list | (filters: Record<string, unknown>) => Promise<ListMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:144 |
memory.todo.save | (todo: | { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; } | { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; }[], metadata: Record<string, unknown>) => Promise<SaveMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:103 |
memory.todo.update | (memoryId: string, todo: { createdAt?: string; id?: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing"; tags?: string[]; title?: string; updatedAt?: string; }) => Promise<UpdateMemoryResponse> | undefined | - | packages/codeboltjs/src/modules/memory.ts:117 |
memoryIngestion | { activate: (pipelineId: string) => Promise<IngestionPipelineResponse>; create: (config: CreateIngestionPipelineParams) => Promise<IngestionPipelineResponse>; delete: (pipelineId: string) => Promise<IngestionPipelineResponse>; disable: (pipelineId: string) => Promise<IngestionPipelineResponse>; duplicate: (pipelineId: string, newId?: string, newLabel?: string) => Promise<IngestionPipelineResponse>; execute: (params: ExecuteIngestionParams) => Promise<IngestionExecuteResponse>; get: (pipelineId: string) => Promise<IngestionPipelineResponse>; getProcessorSpecs: () => Promise<IngestionProcessorSpecsResponse>; list: (filters?: ListIngestionPipelineParams) => Promise<IngestionPipelineListResponse>; update: (pipelineId: string, updates: UpdateIngestionPipelineParams) => Promise<IngestionPipelineResponse>; validate: (pipeline: CreateIngestionPipelineParams) => Promise<IngestionValidateResponse>; } | cbmemoryIngestion | - | packages/codeboltjs/src/core/Codebolt.ts:187 |
memoryIngestion.activate | (pipelineId: string) => Promise<IngestionPipelineResponse> | undefined | Activate an ingestion pipeline | packages/codeboltjs/src/modules/memoryIngestion.ts:145 |
memoryIngestion.create | (config: CreateIngestionPipelineParams) => Promise<IngestionPipelineResponse> | undefined | Create a new ingestion pipeline | packages/codeboltjs/src/modules/memoryIngestion.ts:25 |
memoryIngestion.delete | (pipelineId: string) => Promise<IngestionPipelineResponse> | undefined | Delete an ingestion pipeline | packages/codeboltjs/src/modules/memoryIngestion.ts:86 |
memoryIngestion.disable | (pipelineId: string) => Promise<IngestionPipelineResponse> | undefined | Disable an ingestion pipeline | packages/codeboltjs/src/modules/memoryIngestion.ts:160 |
memoryIngestion.duplicate | (pipelineId: string, newId?: string, newLabel?: string) => Promise<IngestionPipelineResponse> | undefined | Duplicate an ingestion pipeline | packages/codeboltjs/src/modules/memoryIngestion.ts:177 |
memoryIngestion.execute | (params: ExecuteIngestionParams) => Promise<IngestionExecuteResponse> | undefined | Execute an ingestion pipeline | packages/codeboltjs/src/modules/memoryIngestion.ts:101 |
memoryIngestion.get | (pipelineId: string) => Promise<IngestionPipelineResponse> | undefined | Get an ingestion pipeline by ID | packages/codeboltjs/src/modules/memoryIngestion.ts:40 |
memoryIngestion.getProcessorSpecs | () => Promise<IngestionProcessorSpecsResponse> | undefined | Get available processor specifications | packages/codeboltjs/src/modules/memoryIngestion.ts:130 |
memoryIngestion.list | (filters?: ListIngestionPipelineParams) => Promise<IngestionPipelineListResponse> | undefined | List ingestion pipelines | packages/codeboltjs/src/modules/memoryIngestion.ts:55 |
memoryIngestion.update | (pipelineId: string, updates: UpdateIngestionPipelineParams) => Promise<IngestionPipelineResponse> | undefined | Update an ingestion pipeline | packages/codeboltjs/src/modules/memoryIngestion.ts:71 |
memoryIngestion.validate | (pipeline: CreateIngestionPipelineParams) => Promise<IngestionValidateResponse> | undefined | Validate a pipeline configuration | packages/codeboltjs/src/modules/memoryIngestion.ts:116 |
notify | NotificationFunctions | notificationFunctions | - | packages/codeboltjs/src/core/Codebolt.ts:162 |
orchestrator | { createOrchestrator: (data: CreateOrchestratorParams) => Promise<OrchestratorResponse>; deleteOrchestrator: (orchestratorId: string) => Promise<OrchestratorResponse>; getOrchestrator: (orchestratorId: string) => Promise<OrchestratorResponse>; getOrchestratorSettings: (orchestratorId: string) => Promise<OrchestratorResponse>; listOrchestrators: () => Promise<OrchestratorResponse>; updateCodeboltJs: () => Promise<OrchestratorResponse>; updateOrchestrator: (orchestratorId: string, data: UpdateOrchestratorParams) => Promise<OrchestratorResponse>; updateOrchestratorSettings: (orchestratorId: string, settings: UpdateOrchestratorSettingsParams) => Promise<OrchestratorResponse>; updateOrchestratorStatus: (orchestratorId: string, status: OrchestratorStatus) => Promise<OrchestratorResponse>; } | orchestrator | - | packages/codeboltjs/src/core/Codebolt.ts:191 |
orchestrator.createOrchestrator | (data: CreateOrchestratorParams) => Promise<OrchestratorResponse> | undefined | Creates a new orchestrator | packages/codeboltjs/src/modules/orchestrator.ts:84 |
orchestrator.deleteOrchestrator | (orchestratorId: string) => Promise<OrchestratorResponse> | undefined | Deletes an orchestrator | packages/codeboltjs/src/modules/orchestrator.ts:125 |
orchestrator.getOrchestrator | (orchestratorId: string) => Promise<OrchestratorResponse> | undefined | Gets a specific orchestrator by ID | packages/codeboltjs/src/modules/orchestrator.ts:58 |
orchestrator.getOrchestratorSettings | (orchestratorId: string) => Promise<OrchestratorResponse> | undefined | Gets orchestrator settings | packages/codeboltjs/src/modules/orchestrator.ts:71 |
orchestrator.listOrchestrators | () => Promise<OrchestratorResponse> | undefined | Lists all orchestrators | packages/codeboltjs/src/modules/orchestrator.ts:45 |
orchestrator.updateCodeboltJs | () => Promise<OrchestratorResponse> | undefined | Initiates a Codebolt JS update | packages/codeboltjs/src/modules/orchestrator.ts:152 |
orchestrator.updateOrchestrator | (orchestratorId: string, data: UpdateOrchestratorParams) => Promise<OrchestratorResponse> | undefined | Updates an orchestrator | packages/codeboltjs/src/modules/orchestrator.ts:97 |
orchestrator.updateOrchestratorSettings | (orchestratorId: string, settings: UpdateOrchestratorSettingsParams) => Promise<OrchestratorResponse> | undefined | Updates orchestrator settings | packages/codeboltjs/src/modules/orchestrator.ts:111 |
orchestrator.updateOrchestratorStatus | (orchestratorId: string, status: OrchestratorStatus) => Promise<OrchestratorResponse> | undefined | Updates orchestrator status | packages/codeboltjs/src/modules/orchestrator.ts:138 |
outputparsers | { parseCSV: (csvString: string) => ParseResult<CSVRow[]>; parseErrors: (output: ParsableOutput) => string[]; parseJSON: (jsonString: string) => ParseResult<unknown>; parseText: (text: string) => ParseResult<string[]>; parseWarnings: (output: ParsableOutput) => string[]; parseXML: (xmlString: string) => ParseResult<{ [key: string]: unknown; rootElement: string; }>; } | cboutputparsers | - | packages/codeboltjs/src/core/Codebolt.ts:149 |
outputparsers.parseCSV | (csvString: string) => ParseResult<CSVRow[]> | undefined | Parses CSV string and returns a result object. | packages/codeboltjs/src/modules/outputparsers.ts:52 |
outputparsers.parseErrors | (output: ParsableOutput) => string[] | undefined | Parses the given output and returns all the error messages. | packages/codeboltjs/src/modules/outputparsers.ts:89 |
outputparsers.parseJSON | (jsonString: string) => ParseResult<unknown> | undefined | Parses JSON string and returns a result object. | packages/codeboltjs/src/modules/outputparsers.ts:24 |
outputparsers.parseText | (text: string) => ParseResult<string[]> | undefined | Parses text string and returns a result object with lines. | packages/codeboltjs/src/modules/outputparsers.ts:79 |
outputparsers.parseWarnings | (output: ParsableOutput) => string[] | undefined | Parses the given output and returns all the warning messages. | packages/codeboltjs/src/modules/outputparsers.ts:99 |
outputparsers.parseXML | (xmlString: string) => ParseResult<{ [key: string]: unknown; rootElement: string; }> | undefined | Parses XML string and returns a result object. | packages/codeboltjs/src/modules/outputparsers.ts:38 |
persistentMemory | { create: (config: CreatePersistentMemoryParams) => Promise<PersistentMemoryResponse>; delete: (memoryId: string) => Promise<PersistentMemoryResponse>; executeRetrieval: (memoryId: string, intent: PipelineExecutionIntent) => Promise<PersistentMemoryExecuteResponse>; get: (memoryId: string) => Promise<PersistentMemoryResponse>; getStepSpecs: () => Promise<PersistentMemoryStepSpecsResponse>; list: (filters?: ListPersistentMemoryParams) => Promise<PersistentMemoryListResponse>; update: (memoryId: string, updates: UpdatePersistentMemoryParams) => Promise<PersistentMemoryResponse>; validate: (memory: CreatePersistentMemoryParams) => Promise<PersistentMemoryValidateResponse>; } | cbpersistentMemory | - | packages/codeboltjs/src/core/Codebolt.ts:183 |
persistentMemory.create | (config: CreatePersistentMemoryParams) => Promise<PersistentMemoryResponse> | undefined | Create a new persistent memory configuration | packages/codeboltjs/src/modules/persistentMemory.ts:25 |
persistentMemory.delete | (memoryId: string) => Promise<PersistentMemoryResponse> | undefined | Delete a persistent memory | packages/codeboltjs/src/modules/persistentMemory.ts:86 |
persistentMemory.executeRetrieval | (memoryId: string, intent: PipelineExecutionIntent) => Promise<PersistentMemoryExecuteResponse> | undefined | Execute memory retrieval pipeline | packages/codeboltjs/src/modules/persistentMemory.ts:102 |
persistentMemory.get | (memoryId: string) => Promise<PersistentMemoryResponse> | undefined | Get a persistent memory by ID | packages/codeboltjs/src/modules/persistentMemory.ts:40 |
persistentMemory.getStepSpecs | () => Promise<PersistentMemoryStepSpecsResponse> | undefined | Get available step specifications | packages/codeboltjs/src/modules/persistentMemory.ts:131 |
persistentMemory.list | (filters?: ListPersistentMemoryParams) => Promise<PersistentMemoryListResponse> | undefined | List persistent memories | packages/codeboltjs/src/modules/persistentMemory.ts:55 |
persistentMemory.update | (memoryId: string, updates: UpdatePersistentMemoryParams) => Promise<PersistentMemoryResponse> | undefined | Update a persistent memory | packages/codeboltjs/src/modules/persistentMemory.ts:71 |
persistentMemory.validate | (memory: CreatePersistentMemoryParams) => Promise<PersistentMemoryValidateResponse> | undefined | Validate a memory configuration | packages/codeboltjs/src/modules/persistentMemory.ts:117 |
project | { getEditorFileStatus: () => Promise<any>; getProjectPath: () => Promise<GetProjectPathResponse>; getProjectSettings: () => Promise<GetProjectSettingsResponse>; getRepoMap: (message: any) => Promise<GetProjectPathResponse>; runProject: () => void; } | cbproject | - | packages/codeboltjs/src/core/Codebolt.ts:150 |
project.getEditorFileStatus | () => Promise<any> | undefined | - | packages/codeboltjs/src/modules/project.ts:51 |
project.getProjectPath | () => Promise<GetProjectPathResponse> | undefined | Retrieves the path of the current project. | packages/codeboltjs/src/modules/project.ts:26 |
project.getProjectSettings | () => Promise<GetProjectSettingsResponse> | undefined | Retrieves the project settings from the server. | packages/codeboltjs/src/modules/project.ts:13 |
project.getRepoMap | (message: any) => Promise<GetProjectPathResponse> | undefined | - | packages/codeboltjs/src/modules/project.ts:35 |
project.runProject | () => void | undefined | - | packages/codeboltjs/src/modules/project.ts:45 |
projectStructure | { addCommand: (packageId: string, command: Omit<RunCommand, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; addDependency: (packageId: string, dependency: Omit<Dependency, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; addDeployment: (packageId: string, config: Omit<DeploymentConfig, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; addRoute: (packageId: string, route: Omit<ApiRoute, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; addTable: (packageId: string, table: Omit<DatabaseTable, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; addUiRoute: (packageId: string, route: Omit<UiRoute, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; createPackage: (data: CreatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse>; deleteCommand: (packageId: string, commandId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>; deleteDependency: (packageId: string, dependencyId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>; deleteDeployment: (packageId: string, configId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>; deletePackage: (packageId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>; deleteRoute: (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>; deleteTable: (packageId: string, tableId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>; deleteUiRoute: (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>; getMetadata: (workspacePath?: string) => Promise<ProjectStructureMetadataResponse>; getPackage: (packageId: string, workspacePath?: string) => Promise<ProjectStructurePackageResponse>; getPackages: (workspacePath?: string) => Promise<ProjectStructurePackagesResponse>; updateCommand: (packageId: string, commandId: string, updates: Partial<RunCommand>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateDependency: (packageId: string, dependencyId: string, updates: Partial<Dependency>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateDeployment: (packageId: string, configId: string, updates: Partial<DeploymentConfig>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateDesignGuidelines: (packageId: string, guidelines: DesignGuidelines, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateFrontendFramework: (packageId: string, framework: FrameworkInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateGit: (gitInfo: GitInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateMetadata: (updates: Record<string, any>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updatePackage: (packageId: string, updates: UpdatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse>; updateRoute: (packageId: string, routeId: string, updates: Partial<ApiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateSection: (packageId: string, section: string, sectionData: any, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateTable: (packageId: string, tableId: string, updates: Partial<DatabaseTable>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; updateUiRoute: (packageId: string, routeId: string, updates: Partial<UiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>; } | cbprojectStructure | - | packages/codeboltjs/src/core/Codebolt.ts:177 |
projectStructure.addCommand | (packageId: string, command: Omit<RunCommand, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Add a run command to a package | packages/codeboltjs/src/modules/projectStructure.ts:312 |
projectStructure.addDependency | (packageId: string, dependency: Omit<Dependency, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Add a dependency to a package | packages/codeboltjs/src/modules/projectStructure.ts:260 |
projectStructure.addDeployment | (packageId: string, config: Omit<DeploymentConfig, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Add a deployment config to a package | packages/codeboltjs/src/modules/projectStructure.ts:416 |
projectStructure.addRoute | (packageId: string, route: Omit<ApiRoute, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Add an API route to a package | packages/codeboltjs/src/modules/projectStructure.ts:156 |
projectStructure.addTable | (packageId: string, table: Omit<DatabaseTable, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Add a database table to a package | packages/codeboltjs/src/modules/projectStructure.ts:208 |
projectStructure.addUiRoute | (packageId: string, route: Omit<UiRoute, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Add a UI route to a package | packages/codeboltjs/src/modules/projectStructure.ts:364 |
projectStructure.createPackage | (data: CreatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | undefined | Create a new package | packages/codeboltjs/src/modules/projectStructure.ts:104 |
projectStructure.deleteCommand | (packageId: string, commandId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a run command | packages/codeboltjs/src/modules/projectStructure.ts:344 |
projectStructure.deleteDependency | (packageId: string, dependencyId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a dependency | packages/codeboltjs/src/modules/projectStructure.ts:292 |
projectStructure.deleteDeployment | (packageId: string, configId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a deployment config | packages/codeboltjs/src/modules/projectStructure.ts:448 |
projectStructure.deletePackage | (packageId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a package | packages/codeboltjs/src/modules/projectStructure.ts:136 |
projectStructure.deleteRoute | (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete an API route | packages/codeboltjs/src/modules/projectStructure.ts:188 |
projectStructure.deleteTable | (packageId: string, tableId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a database table | packages/codeboltjs/src/modules/projectStructure.ts:240 |
projectStructure.deleteUiRoute | (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a UI route | packages/codeboltjs/src/modules/projectStructure.ts:396 |
projectStructure.getMetadata | (workspacePath?: string) => Promise<ProjectStructureMetadataResponse> | undefined | Get complete project metadata | packages/codeboltjs/src/modules/projectStructure.ts:36 |
projectStructure.getPackage | (packageId: string, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | undefined | Get a specific package by ID | packages/codeboltjs/src/modules/projectStructure.ts:88 |
projectStructure.getPackages | (workspacePath?: string) => Promise<ProjectStructurePackagesResponse> | undefined | Get all packages in the workspace | packages/codeboltjs/src/modules/projectStructure.ts:72 |
projectStructure.updateCommand | (packageId: string, commandId: string, updates: Partial<RunCommand>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a run command | packages/codeboltjs/src/modules/projectStructure.ts:328 |
projectStructure.updateDependency | (packageId: string, dependencyId: string, updates: Partial<Dependency>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a dependency | packages/codeboltjs/src/modules/projectStructure.ts:276 |
projectStructure.updateDeployment | (packageId: string, configId: string, updates: Partial<DeploymentConfig>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a deployment config | packages/codeboltjs/src/modules/projectStructure.ts:432 |
projectStructure.updateDesignGuidelines | (packageId: string, guidelines: DesignGuidelines, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update design guidelines for a package | packages/codeboltjs/src/modules/projectStructure.ts:484 |
projectStructure.updateFrontendFramework | (packageId: string, framework: FrameworkInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update frontend framework for a package | packages/codeboltjs/src/modules/projectStructure.ts:500 |
projectStructure.updateGit | (gitInfo: GitInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update git information | packages/codeboltjs/src/modules/projectStructure.ts:468 |
projectStructure.updateMetadata | (updates: Record<string, any>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update workspace metadata | packages/codeboltjs/src/modules/projectStructure.ts:52 |
projectStructure.updatePackage | (packageId: string, updates: UpdatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | undefined | Update a package | packages/codeboltjs/src/modules/projectStructure.ts:120 |
projectStructure.updateRoute | (packageId: string, routeId: string, updates: Partial<ApiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update an API route | packages/codeboltjs/src/modules/projectStructure.ts:172 |
projectStructure.updateSection | (packageId: string, section: string, sectionData: any, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a specific section of a package | packages/codeboltjs/src/modules/projectStructure.ts:516 |
projectStructure.updateTable | (packageId: string, tableId: string, updates: Partial<DatabaseTable>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a database table | packages/codeboltjs/src/modules/projectStructure.ts:224 |
projectStructure.updateUiRoute | (packageId: string, routeId: string, updates: Partial<UiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a UI route | packages/codeboltjs/src/modules/projectStructure.ts:380 |
projectStructureUpdateRequest | { addComment: (id: string, disputeId: string, data: AddCommentData, workspacePath?: string) => Promise<UpdateRequestResponse>; addDispute: (id: string, data: CreateDisputeData, workspacePath?: string) => Promise<UpdateRequestResponse>; complete: (id: string, workspacePath?: string) => Promise<UpdateRequestResponse>; create: (data: CreateUpdateRequestData, workspacePath?: string) => Promise<UpdateRequestResponse>; delete: (id: string, workspacePath?: string) => Promise<UpdateRequestResponse>; get: (id: string, workspacePath?: string) => Promise<UpdateRequestResponse>; list: (filters?: UpdateRequestFilters, workspacePath?: string) => Promise<UpdateRequestListResponse>; merge: (id: string, workspacePath?: string) => Promise<UpdateRequestResponse>; resolveDispute: (id: string, disputeId: string, resolutionSummary?: string, workspacePath?: string) => Promise<UpdateRequestResponse>; startWork: (id: string, workspacePath?: string) => Promise<UpdateRequestResponse>; submit: (id: string, workspacePath?: string) => Promise<UpdateRequestResponse>; unwatch: (id: string, watcherId: string, workspacePath?: string) => Promise<UpdateRequestResponse>; update: (id: string, updates: UpdateUpdateRequestData, workspacePath?: string) => Promise<UpdateRequestResponse>; watch: (id: string, data: AddWatcherData, workspacePath?: string) => Promise<UpdateRequestResponse>; } | cbprojectStructureUpdateRequest | - | packages/codeboltjs/src/core/Codebolt.ts:180 |
projectStructureUpdateRequest.addComment | (id: string, disputeId: string, data: AddCommentData, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Add a comment | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:198 |
projectStructureUpdateRequest.addDispute | (id: string, data: CreateDisputeData, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Add a dispute | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:166 |
projectStructureUpdateRequest.complete | (id: string, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Complete work on an update request | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:134 |
projectStructureUpdateRequest.create | (data: CreateUpdateRequestData, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Create a new update request | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:22 |
projectStructureUpdateRequest.delete | (id: string, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Delete an update request | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:86 |
projectStructureUpdateRequest.get | (id: string, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Get an update request by ID | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:38 |
projectStructureUpdateRequest.list | (filters?: UpdateRequestFilters, workspacePath?: string) => Promise<UpdateRequestListResponse> | undefined | List update requests | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:54 |
projectStructureUpdateRequest.merge | (id: string, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Merge an update request | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:150 |
projectStructureUpdateRequest.resolveDispute | (id: string, disputeId: string, resolutionSummary?: string, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Resolve a dispute | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:182 |
projectStructureUpdateRequest.startWork | (id: string, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Start working on an update request | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:118 |
projectStructureUpdateRequest.submit | (id: string, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Submit an update request for review | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:102 |
projectStructureUpdateRequest.unwatch | (id: string, watcherId: string, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Stop watching an update request | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:230 |
projectStructureUpdateRequest.update | (id: string, updates: UpdateUpdateRequestData, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Update an existing update request | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:70 |
projectStructureUpdateRequest.watch | (id: string, data: AddWatcherData, workspacePath?: string) => Promise<UpdateRequestResponse> | undefined | Watch an update request | packages/codeboltjs/src/modules/projectStructureUpdateRequest.ts:214 |
rag | { add_file: (filename: string, file_path: string) => void; init: () => void; retrieve_related_knowledge: (query: string, filename: string) => void; } | cbrag | - | packages/codeboltjs/src/core/Codebolt.ts:148 |
rag.add_file | (filename: string, file_path: string) => void | undefined | Adds a file to the CodeBolt File System. | packages/codeboltjs/src/modules/rag.ts:15 |
rag.init | () => void | undefined | Initializes the CodeBolt File System Module. | packages/codeboltjs/src/modules/rag.ts:8 |
rag.retrieve_related_knowledge | (query: string, filename: string) => void | undefined | Retrieves related knowledge for a given query and filename. | packages/codeboltjs/src/modules/rag.ts:23 |
requirementPlan | { addSection: (filePath: string, section: Omit<RequirementPlanSection, "id" | "order">, afterIndex?: number) => Promise<RequirementPlanSectionResponse>; create: (fileName: string) => Promise<RequirementPlanCreateResponse>; get: (filePath: string) => Promise<RequirementPlanGetResponse>; list: () => Promise<RequirementPlanListResponse>; removeSection: (filePath: string, sectionId: string) => Promise<RequirementPlanSectionResponse>; reorderSections: (filePath: string, sectionIds: string[]) => Promise<RequirementPlanSectionResponse>; review: (filePath: string) => Promise<RequirementPlanReviewResponse>; update: (filePath: string, content: | string | RequirementPlanDocument) => Promise<RequirementPlanUpdateResponse>; updateSection: (filePath: string, sectionId: string, updates: Partial<RequirementPlanSection>) => Promise<RequirementPlanSectionResponse>; } | cbrequirementPlan | - | packages/codeboltjs/src/core/Codebolt.ts:171 |
requirementPlan.addSection | (filePath: string, section: Omit<RequirementPlanSection, "id" | "order">, afterIndex?: number) => Promise<RequirementPlanSectionResponse> | undefined | Add a section to a requirement plan | packages/codeboltjs/src/modules/requirementPlan.ts:195 |
requirementPlan.create | (fileName: string) => Promise<RequirementPlanCreateResponse> | undefined | Create a new requirement plan file | packages/codeboltjs/src/modules/requirementPlan.ts:120 |
requirementPlan.get | (filePath: string) => Promise<RequirementPlanGetResponse> | undefined | Get a requirement plan by file path | packages/codeboltjs/src/modules/requirementPlan.ts:138 |
requirementPlan.list | () => Promise<RequirementPlanListResponse> | undefined | List all requirement plans in the project | packages/codeboltjs/src/modules/requirementPlan.ts:175 |
requirementPlan.removeSection | (filePath: string, sectionId: string) => Promise<RequirementPlanSectionResponse> | undefined | Remove a section from a requirement plan | packages/codeboltjs/src/modules/requirementPlan.ts:242 |
requirementPlan.reorderSections | (filePath: string, sectionIds: string[]) => Promise<RequirementPlanSectionResponse> | undefined | Reorder sections in a requirement plan | packages/codeboltjs/src/modules/requirementPlan.ts:261 |
requirementPlan.review | (filePath: string) => Promise<RequirementPlanReviewResponse> | undefined | Request a review for a requirement plan | packages/codeboltjs/src/modules/requirementPlan.ts:279 |
requirementPlan.update | (filePath: string, content: | string | RequirementPlanDocument) => Promise<RequirementPlanUpdateResponse> | undefined | Update a requirement plan | packages/codeboltjs/src/modules/requirementPlan.ts:157 |
requirementPlan.updateSection | (filePath: string, sectionId: string, updates: Partial<RequirementPlanSection>) => Promise<RequirementPlanSectionResponse> | undefined | Update a section in a requirement plan | packages/codeboltjs/src/modules/requirementPlan.ts:219 |
reviewMergeRequest | { addLinkedJob: (id: string, jobId: string) => Promise<{ request: ReviewMergeRequest; }>; addReview: (id: string, feedback: AddReviewFeedback) => Promise<{ request: ReviewMergeRequest; }>; byAgent: (agentId: string) => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }>; bySwarm: (swarmId: string) => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }>; create: (data: CreateReviewMergeRequest) => Promise<{ request: ReviewMergeRequest; }>; delete: (id: string) => Promise<{ deleted: boolean; }>; get: (id: string) => Promise<{ request: ReviewMergeRequest; }>; list: (filters: ReviewMergeRequestFilters) => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }>; merge: (id: string, mergedBy: string) => Promise<{ result: MergeResult; }>; pending: () => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }>; readyToMerge: () => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }>; removeLinkedJob: (id: string, jobId: string) => Promise<{ request: ReviewMergeRequest; }>; statistics: () => Promise<{ statistics: any; }>; update: (id: string, data: UpdateReviewMergeRequest) => Promise<{ request: ReviewMergeRequest; }>; updateStatus: (id: string, status: ReviewRequestStatus) => Promise<{ request: ReviewMergeRequest; }>; } | cbreviewMergeRequest | - | packages/codeboltjs/src/core/Codebolt.ts:181 |
reviewMergeRequest.addLinkedJob | (id: string, jobId: string) => Promise<{ request: ReviewMergeRequest; }> | undefined | Add linked job | packages/codeboltjs/src/modules/reviewMergeRequest.ts:149 |
reviewMergeRequest.addReview | (id: string, feedback: AddReviewFeedback) => Promise<{ request: ReviewMergeRequest; }> | undefined | Add review feedback | packages/codeboltjs/src/modules/reviewMergeRequest.ts:101 |
reviewMergeRequest.byAgent | (agentId: string) => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }> | undefined | Get requests by agent | packages/codeboltjs/src/modules/reviewMergeRequest.ts:213 |
reviewMergeRequest.bySwarm | (swarmId: string) => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }> | undefined | Get requests by swarm | packages/codeboltjs/src/modules/reviewMergeRequest.ts:229 |
reviewMergeRequest.create | (data: CreateReviewMergeRequest) => Promise<{ request: ReviewMergeRequest; }> | undefined | Create a new review merge request | packages/codeboltjs/src/modules/reviewMergeRequest.ts:53 |
reviewMergeRequest.delete | (id: string) => Promise<{ deleted: boolean; }> | undefined | Delete a review merge request | packages/codeboltjs/src/modules/reviewMergeRequest.ts:85 |
reviewMergeRequest.get | (id: string) => Promise<{ request: ReviewMergeRequest; }> | undefined | Get a single review merge request | packages/codeboltjs/src/modules/reviewMergeRequest.ts:37 |
reviewMergeRequest.list | (filters: ReviewMergeRequestFilters) => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }> | undefined | List review merge requests | packages/codeboltjs/src/modules/reviewMergeRequest.ts:21 |
reviewMergeRequest.merge | (id: string, mergedBy: string) => Promise<{ result: MergeResult; }> | undefined | Merge request | packages/codeboltjs/src/modules/reviewMergeRequest.ts:133 |
reviewMergeRequest.pending | () => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }> | undefined | Get pending reviews | packages/codeboltjs/src/modules/reviewMergeRequest.ts:181 |
reviewMergeRequest.readyToMerge | () => Promise<{ requests: ReviewMergeRequest[]; totalCount: number; }> | undefined | Get ready to merge requests | packages/codeboltjs/src/modules/reviewMergeRequest.ts:197 |
reviewMergeRequest.removeLinkedJob | (id: string, jobId: string) => Promise<{ request: ReviewMergeRequest; }> | undefined | Remove linked job | packages/codeboltjs/src/modules/reviewMergeRequest.ts:165 |
reviewMergeRequest.statistics | () => Promise<{ statistics: any; }> | undefined | Get statistics | packages/codeboltjs/src/modules/reviewMergeRequest.ts:245 |
reviewMergeRequest.update | (id: string, data: UpdateReviewMergeRequest) => Promise<{ request: ReviewMergeRequest; }> | undefined | Update an existing review merge request | packages/codeboltjs/src/modules/reviewMergeRequest.ts:69 |
reviewMergeRequest.updateStatus | (id: string, status: ReviewRequestStatus) => Promise<{ request: ReviewMergeRequest; }> | undefined | Update status | packages/codeboltjs/src/modules/reviewMergeRequest.ts:117 |
roadmap | { createFeature: (phaseId: string, data: CreateFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>; createIdea: (data: CreateIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>; createPhase: (data: CreatePhaseData, projectPath?: string) => Promise<RoadmapPhaseResponse>; deleteFeature: (featureId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>; deleteIdea: (ideaId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>; deletePhase: (phaseId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>; getAllFeatures: (projectPath?: string) => Promise<RoadmapFeaturesResponse>; getFeatures: (phaseId: string, projectPath?: string) => Promise<RoadmapFeaturesResponse>; getIdeas: (projectPath?: string) => Promise<RoadmapIdeasResponse>; getPhases: (projectPath?: string) => Promise<RoadmapPhasesResponse>; getRoadmap: (projectPath?: string) => Promise<RoadmapGetResponse>; moveFeature: (featureId: string, data: MoveFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>; moveIdeaToRoadmap: (ideaId: string, data: MoveIdeaToRoadmapData, projectPath?: string) => Promise<RoadmapMoveToRoadmapResponse>; reviewIdea: (ideaId: string, data: ReviewIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>; updateFeature: (featureId: string, data: UpdateFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>; updateIdea: (ideaId: string, data: UpdateIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>; updatePhase: (phaseId: string, data: UpdatePhaseData, projectPath?: string) => Promise<RoadmapPhaseResponse>; } | cbroadmap | - | packages/codeboltjs/src/core/Codebolt.ts:175 |
roadmap.createFeature | (phaseId: string, data: CreateFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse> | undefined | Create a new feature in a phase | packages/codeboltjs/src/modules/roadmap.ts:158 |
roadmap.createIdea | (data: CreateIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse> | undefined | Create a new idea | packages/codeboltjs/src/modules/roadmap.ts:242 |
roadmap.createPhase | (data: CreatePhaseData, projectPath?: string) => Promise<RoadmapPhaseResponse> | undefined | Create a new phase in the roadmap | packages/codeboltjs/src/modules/roadmap.ts:74 |
roadmap.deleteFeature | (featureId: string, projectPath?: string) => Promise<RoadmapDeleteResponse> | undefined | Delete a feature | packages/codeboltjs/src/modules/roadmap.ts:190 |
roadmap.deleteIdea | (ideaId: string, projectPath?: string) => Promise<RoadmapDeleteResponse> | undefined | Delete an idea | packages/codeboltjs/src/modules/roadmap.ts:274 |
roadmap.deletePhase | (phaseId: string, projectPath?: string) => Promise<RoadmapDeleteResponse> | undefined | Delete a phase from the roadmap | packages/codeboltjs/src/modules/roadmap.ts:106 |
roadmap.getAllFeatures | (projectPath?: string) => Promise<RoadmapFeaturesResponse> | undefined | Get all features across all phases | packages/codeboltjs/src/modules/roadmap.ts:142 |
roadmap.getFeatures | (phaseId: string, projectPath?: string) => Promise<RoadmapFeaturesResponse> | undefined | Get features in a specific phase | packages/codeboltjs/src/modules/roadmap.ts:126 |
roadmap.getIdeas | (projectPath?: string) => Promise<RoadmapIdeasResponse> | undefined | Get all ideas (pre-roadmap suggestions) | packages/codeboltjs/src/modules/roadmap.ts:226 |
roadmap.getPhases | (projectPath?: string) => Promise<RoadmapPhasesResponse> | undefined | Get all phases in the roadmap | packages/codeboltjs/src/modules/roadmap.ts:58 |
roadmap.getRoadmap | (projectPath?: string) => Promise<RoadmapGetResponse> | undefined | Get the complete roadmap for a project | packages/codeboltjs/src/modules/roadmap.ts:38 |
roadmap.moveFeature | (featureId: string, data: MoveFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse> | undefined | Move a feature to a different phase | packages/codeboltjs/src/modules/roadmap.ts:206 |
roadmap.moveIdeaToRoadmap | (ideaId: string, data: MoveIdeaToRoadmapData, projectPath?: string) => Promise<RoadmapMoveToRoadmapResponse> | undefined | Move an accepted idea to the roadmap as a feature | packages/codeboltjs/src/modules/roadmap.ts:306 |
roadmap.reviewIdea | (ideaId: string, data: ReviewIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse> | undefined | Review an idea (accept or reject) | packages/codeboltjs/src/modules/roadmap.ts:290 |
roadmap.updateFeature | (featureId: string, data: UpdateFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse> | undefined | Update an existing feature | packages/codeboltjs/src/modules/roadmap.ts:174 |
roadmap.updateIdea | (ideaId: string, data: UpdateIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse> | undefined | Update an existing idea | packages/codeboltjs/src/modules/roadmap.ts:258 |
roadmap.updatePhase | (phaseId: string, data: UpdatePhaseData, projectPath?: string) => Promise<RoadmapPhaseResponse> | undefined | Update an existing phase | packages/codeboltjs/src/modules/roadmap.ts:90 |
search | { get_first_link: (query: string) => Promise<string>; init: (engine?: string) => void; search: (query: string) => Promise<string>; } | cbsearch | - | packages/codeboltjs/src/core/Codebolt.ts:146 |
search.get_first_link | (query: string) => Promise<string> | undefined | Retrieves the first link from the search results for the given query. | packages/codeboltjs/src/modules/search.ts:26 |
search.init | (engine?: string) => void | undefined | Initializes the search module with the specified search engine. | packages/codeboltjs/src/modules/search.ts:9 |
search.search | (query: string) => Promise<string> | undefined | Performs a search operation for the given query. | packages/codeboltjs/src/modules/search.ts:16 |
sideExecution | { getStatus: (sideExecutionId: string) => Promise<GetSideExecutionStatusResponse>; listActionBlocks: (projectPath?: string) => Promise<ListActionBlocksResponse>; startWithActionBlock: (actionBlockPath: string, params?: Record<string, any>, timeout?: number) => Promise<StartSideExecutionResponse>; startWithCode: (inlineCode: string, params?: Record<string, any>, timeout?: number) => Promise<StartSideExecutionResponse>; stop: (sideExecutionId: string) => Promise<StopSideExecutionResponse>; } | cbsideExecution | - | packages/codeboltjs/src/core/Codebolt.ts:166 |
sideExecution.getStatus | (sideExecutionId: string) => Promise<GetSideExecutionStatusResponse> | undefined | Get the status of a side execution | packages/codeboltjs/src/modules/sideExecution.ts:110 |
sideExecution.listActionBlocks | (projectPath?: string) => Promise<ListActionBlocksResponse> | undefined | List all available ActionBlocks | packages/codeboltjs/src/modules/sideExecution.ts:94 |
sideExecution.startWithActionBlock | (actionBlockPath: string, params?: Record<string, any>, timeout?: number) => Promise<StartSideExecutionResponse> | undefined | Start a side execution with an ActionBlock path | packages/codeboltjs/src/modules/sideExecution.ts:32 |
sideExecution.startWithCode | (inlineCode: string, params?: Record<string, any>, timeout?: number) => Promise<StartSideExecutionResponse> | undefined | Start a side execution with inline JavaScript code | packages/codeboltjs/src/modules/sideExecution.ts:56 |
sideExecution.stop | (sideExecutionId: string) => Promise<StopSideExecutionResponse> | undefined | Stop a running side execution | packages/codeboltjs/src/modules/sideExecution.ts:78 |
swarm | { applyForVacancy: (swarmId: string, vacancyId: string, agentId: string, message?: string) => Promise<ApplyForVacancyResponse>; assignRole: (swarmId: string, roleId: string, agentId: string) => Promise<AssignRoleResponse>; closeVacancy: (swarmId: string, vacancyId: string, reason: string) => Promise<CloseVacancyResponse>; createRole: (swarmId: string, data: CreateRoleRequest) => Promise<CreateRoleResponse>; createSwarm: (data: CreateSwarmRequest) => Promise<CreateSwarmResponse>; createTeam: (swarmId: string, data: CreateTeamRequest) => Promise<CreateTeamResponse>; createVacancy: (swarmId: string, data: CreateVacancyRequest) => Promise<CreateVacancyResponse>; deleteRole: (swarmId: string, roleId: string) => Promise<DeleteRoleResponse>; deleteTeam: (swarmId: string, teamId: string) => Promise<DeleteTeamResponse>; getAgentsByRole: (swarmId: string, roleId: string) => Promise<GetAgentsByRoleResponse>; getDefaultJobGroup: (swarmId: string) => Promise<GetDefaultJobGroupResponse>; getRole: (swarmId: string, roleId: string) => Promise<GetRoleResponse>; getSwarm: (swarmId: string) => Promise<GetSwarmResponse>; getSwarmAgents: (swarmId: string) => Promise<GetSwarmAgentsResponse>; getSwarmStatusSummary: (swarmId: string) => Promise<GetStatusSummaryResponse>; getTeam: (swarmId: string, teamId: string) => Promise<GetTeamResponse>; joinTeam: (swarmId: string, teamId: string, agentId: string) => Promise<JoinTeamResponse>; leaveTeam: (swarmId: string, teamId: string, agentId: string) => Promise<LeaveTeamResponse>; listRoles: (swarmId: string) => Promise<ListRolesResponse>; listSwarms: () => Promise<ListSwarmsResponse>; listTeams: (swarmId: string) => Promise<ListTeamsResponse>; listVacancies: (swarmId: string) => Promise<ListVacanciesResponse>; registerAgent: (swarmId: string, data: AgentRegistration) => Promise<RegisterAgentResponse>; unassignRole: (swarmId: string, roleId: string, agentId: string) => Promise<UnassignRoleResponse>; unregisterAgent: (swarmId: string, agentId: string) => Promise<UnregisterAgentResponse>; updateAgentStatus: (swarmId: string, agentId: string, data: AgentStatusUpdate) => Promise<UpdateStatusResponse>; } | cbswarm | - | packages/codeboltjs/src/core/Codebolt.ts:172 |
swarm.applyForVacancy | (swarmId: string, vacancyId: string, agentId: string, message?: string) => Promise<ApplyForVacancyResponse> | undefined | Apply for a vacancy | packages/codeboltjs/src/modules/swarm.ts:526 |
swarm.assignRole | (swarmId: string, roleId: string, agentId: string) => Promise<AssignRoleResponse> | undefined | Assign a role to an agent | packages/codeboltjs/src/modules/swarm.ts:399 |
swarm.closeVacancy | (swarmId: string, vacancyId: string, reason: string) => Promise<CloseVacancyResponse> | undefined | Close a vacancy | packages/codeboltjs/src/modules/swarm.ts:554 |
swarm.createRole | (swarmId: string, data: CreateRoleRequest) => Promise<CreateRoleResponse> | undefined | Create a new role in a swarm | packages/codeboltjs/src/modules/swarm.ts:340 |
swarm.createSwarm | (data: CreateSwarmRequest) => Promise<CreateSwarmResponse> | undefined | Create a new swarm | packages/codeboltjs/src/modules/swarm.ts:95 |
swarm.createTeam | (swarmId: string, data: CreateTeamRequest) => Promise<CreateTeamResponse> | undefined | Create a new team in a swarm | packages/codeboltjs/src/modules/swarm.ts:214 |
swarm.createVacancy | (swarmId: string, data: CreateVacancyRequest) => Promise<CreateVacancyResponse> | undefined | Create a new vacancy in a swarm | packages/codeboltjs/src/modules/swarm.ts:486 |
swarm.deleteRole | (swarmId: string, roleId: string) => Promise<DeleteRoleResponse> | undefined | Delete a role from a swarm | packages/codeboltjs/src/modules/swarm.ts:462 |
swarm.deleteTeam | (swarmId: string, teamId: string) => Promise<DeleteTeamResponse> | undefined | Delete a team from a swarm | packages/codeboltjs/src/modules/swarm.ts:316 |
swarm.getAgentsByRole | (swarmId: string, roleId: string) => Promise<GetAgentsByRoleResponse> | undefined | Get all agents with a specific role | packages/codeboltjs/src/modules/swarm.ts:442 |
swarm.getDefaultJobGroup | (swarmId: string) => Promise<GetDefaultJobGroupResponse> | undefined | Get the default job group ID associated with a swarm | packages/codeboltjs/src/modules/swarm.ts:626 |
swarm.getRole | (swarmId: string, roleId: string) => Promise<GetRoleResponse> | undefined | Get details of a specific role | packages/codeboltjs/src/modules/swarm.ts:378 |
swarm.getSwarm | (swarmId: string) => Promise<GetSwarmResponse> | undefined | Get details of a specific swarm | packages/codeboltjs/src/modules/swarm.ts:129 |
swarm.getSwarmAgents | (swarmId: string) => Promise<GetSwarmAgentsResponse> | undefined | Get all agents in a swarm | packages/codeboltjs/src/modules/swarm.ts:147 |
swarm.getSwarmStatusSummary | (swarmId: string) => Promise<GetStatusSummaryResponse> | undefined | Get status summary for a swarm | packages/codeboltjs/src/modules/swarm.ts:604 |
swarm.getTeam | (swarmId: string, teamId: string) => Promise<GetTeamResponse> | undefined | Get details of a specific team | packages/codeboltjs/src/modules/swarm.ts:252 |
swarm.joinTeam | (swarmId: string, teamId: string, agentId: string) => Promise<JoinTeamResponse> | undefined | Add an agent to a team | packages/codeboltjs/src/modules/swarm.ts:273 |
swarm.leaveTeam | (swarmId: string, teamId: string, agentId: string) => Promise<LeaveTeamResponse> | undefined | Remove an agent from a team | packages/codeboltjs/src/modules/swarm.ts:295 |
swarm.listRoles | (swarmId: string) => Promise<ListRolesResponse> | undefined | List all roles in a swarm | packages/codeboltjs/src/modules/swarm.ts:359 |
swarm.listSwarms | () => Promise<ListSwarmsResponse> | undefined | List all available swarms | packages/codeboltjs/src/modules/swarm.ts:112 |
swarm.listTeams | (swarmId: string) => Promise<ListTeamsResponse> | undefined | List all teams in a swarm | packages/codeboltjs/src/modules/swarm.ts:233 |
swarm.listVacancies | (swarmId: string) => Promise<ListVacanciesResponse> | undefined | List all vacancies in a swarm | packages/codeboltjs/src/modules/swarm.ts:505 |
swarm.registerAgent | (swarmId: string, data: AgentRegistration) => Promise<RegisterAgentResponse> | undefined | Register an agent to a swarm | packages/codeboltjs/src/modules/swarm.ts:170 |
swarm.unassignRole | (swarmId: string, roleId: string, agentId: string) => Promise<UnassignRoleResponse> | undefined | Unassign a role from an agent | packages/codeboltjs/src/modules/swarm.ts:421 |
swarm.unregisterAgent | (swarmId: string, agentId: string) => Promise<UnregisterAgentResponse> | undefined | Unregister an agent from a swarm | packages/codeboltjs/src/modules/swarm.ts:190 |
swarm.updateAgentStatus | (swarmId: string, agentId: string, data: AgentStatusUpdate) => Promise<UpdateStatusResponse> | undefined | Update an agent's status | packages/codeboltjs/src/modules/swarm.ts:580 |
task | { assignAgentToTask: (taskId: string, agentId: string) => Promise<{ error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; type?: "updateTaskResponse"; }>; createTask: (options: { assignedTo?: string; controlFiles?: any[]; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: Date; environment?: string; environmentType?: "local" | "remote"; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; isKanbanTask?: boolean; isRemoteTask?: boolean; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: string; steps?: { agentId?: string; condition?: string; FlowData?: { edges?: any[]; nodes?: { data?: ...; id?: ...; position?: ...; type?: ...; }[]; }; isMainTask?: boolean; messageData?: { controlFiles?: string[]; environment?: Record<string, any>; isRemoteTask?: boolean; links?: string[]; llmProvider?: { model?: ... | ...; providerId?: ... | ...; }; mentionedAgents?: string[]; mentionedDocs?: string[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedFullPaths?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; uploadedImages?: string[]; }; position?: { x?: number; y?: number; }; status?: string; type?: string; userMessage?: string; }[]; tags?: string[]; taskType?: "scheduled" | "interactive"; threadId?: string; uploadedImages?: string[]; }) => Promise<{ error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; type?: "createTaskResponse"; }>; deleteTask: (taskId: string) => Promise<{ deleted?: boolean; error?: string; success?: boolean; taskId?: string; type?: "deleteTaskResponse"; }>; executeTaskWithAgent: (taskId: string, agentId: string) => Promise<{ activityId?: string; agentId?: string; error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; taskId?: string; type?: "startTaskWithAgentResponse"; }>; getTaskDetail: (options: { includeMessages?: boolean; includeSteps?: boolean; taskId?: string; }) => Promise<{ error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; taskId?: string; type?: "getTaskResponse"; }>; getTaskList: (options: { limit?: number; offset?: number; startedByUser?: string; status?: "pending" | "completed" | "processing" | "all"; threadId?: string; }) => Promise<{ error?: string; success?: boolean; tasks?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }[]; totalCount?: number; type?: "listTasksResponse"; }>; getTaskStatus: (taskId: string) => Promise<string | undefined>; getTaskSummary: (taskId: string) => Promise<string | undefined>; updateTask: (taskId: string, updates: { assignedTo?: string; completed?: boolean; dependsOnTaskId?: string; dependsOnTaskName?: string; dueDate?: Date; environment?: string; environmentType?: "local" | "remote"; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; groupId?: string; isKanbanTask?: boolean; isRemoteTask?: boolean; name?: string; selectedAgent?: any; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; steps?: { agentId?: string; condition?: string; FlowData?: { edges?: any[]; nodes?: { data?: ...; id?: ...; position?: ...; type?: ...; }[]; }; id?: string; isMainTask?: boolean; messageData?: { controlFiles?: string[]; environment?: Record<string, any>; isRemoteTask?: boolean; links?: string[]; llmProvider?: { model?: ... | ...; providerId?: ... | ...; }; mentionedAgents?: string[]; mentionedDocs?: string[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedFullPaths?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; uploadedImages?: string[]; }; position?: { x?: number; y?: number; }; status?: string; type?: string; userMessage?: string; }[]; taskType?: "scheduled" | "interactive"; }) => Promise<{ error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; type?: "updateTaskResponse"; }>; } | task | - | packages/codeboltjs/src/core/Codebolt.ts:153 |
task.assignAgentToTask | (taskId: string, agentId: string) => Promise<{ error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; type?: "updateTaskResponse"; }> | undefined | Assigns an agent to a task. | packages/codeboltjs/src/modules/task.ts:154 |
task.createTask | (options: { assignedTo?: string; controlFiles?: any[]; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: Date; environment?: string; environmentType?: "local" | "remote"; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; isKanbanTask?: boolean; isRemoteTask?: boolean; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: string; steps?: { agentId?: string; condition?: string; FlowData?: { edges?: any[]; nodes?: { data?: ...; id?: ...; position?: ...; type?: ...; }[]; }; isMainTask?: boolean; messageData?: { controlFiles?: string[]; environment?: Record<string, any>; isRemoteTask?: boolean; links?: string[]; llmProvider?: { model?: ... | ...; providerId?: ... | ...; }; mentionedAgents?: string[]; mentionedDocs?: string[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedFullPaths?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; uploadedImages?: string[]; }; position?: { x?: number; y?: number; }; status?: string; type?: string; userMessage?: string; }[]; tags?: string[]; taskType?: "scheduled" | "interactive"; threadId?: string; uploadedImages?: string[]; }) => Promise<{ error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; type?: "createTaskResponse"; }> | undefined | Creates a new task. | packages/codeboltjs/src/modules/task.ts:40 |
task.deleteTask | (taskId: string) => Promise<{ deleted?: boolean; error?: string; success?: boolean; taskId?: string; type?: "deleteTaskResponse"; }> | undefined | Deletes a task. | packages/codeboltjs/src/modules/task.ts:88 |
task.executeTaskWithAgent | (taskId: string, agentId: string) => Promise<{ activityId?: string; agentId?: string; error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; taskId?: string; type?: "startTaskWithAgentResponse"; }> | undefined | Executes a task with a specific agent. Assigns the agent and then starts the task. | packages/codeboltjs/src/modules/task.ts:167 |
task.getTaskDetail | (options: { includeMessages?: boolean; includeSteps?: boolean; taskId?: string; }) => Promise<{ error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; taskId?: string; type?: "getTaskResponse"; }> | undefined | Retrieves detailed information about a specific task. | packages/codeboltjs/src/modules/task.ts:132 |
task.getTaskList | (options: { limit?: number; offset?: number; startedByUser?: string; status?: "pending" | "completed" | "processing" | "all"; threadId?: string; }) => Promise<{ error?: string; success?: boolean; tasks?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }[]; totalCount?: number; type?: "listTasksResponse"; }> | undefined | Retrieves a list of tasks. | packages/codeboltjs/src/modules/task.ts:111 |
task.getTaskStatus | (taskId: string) => Promise<string | undefined> | undefined | Gets the status of a task. | packages/codeboltjs/src/modules/task.ts:191 |
task.getTaskSummary | (taskId: string) => Promise<string | undefined> | undefined | Gets the summary (description) of a task. | packages/codeboltjs/src/modules/task.ts:201 |
task.updateTask | (taskId: string, updates: { assignedTo?: string; completed?: boolean; dependsOnTaskId?: string; dependsOnTaskName?: string; dueDate?: Date; environment?: string; environmentType?: "local" | "remote"; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; groupId?: string; isKanbanTask?: boolean; isRemoteTask?: boolean; name?: string; selectedAgent?: any; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; steps?: { agentId?: string; condition?: string; FlowData?: { edges?: any[]; nodes?: { data?: ...; id?: ...; position?: ...; type?: ...; }[]; }; id?: string; isMainTask?: boolean; messageData?: { controlFiles?: string[]; environment?: Record<string, any>; isRemoteTask?: boolean; links?: string[]; llmProvider?: { model?: ... | ...; providerId?: ... | ...; }; mentionedAgents?: string[]; mentionedDocs?: string[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedFullPaths?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; uploadedImages?: string[]; }; position?: { x?: number; y?: number; }; status?: string; type?: string; userMessage?: string; }[]; taskType?: "scheduled" | "interactive"; }) => Promise<{ error?: string; success?: boolean; task?: { assignedTo?: string; cancellationReason?: string; children?: any[]; completed?: boolean; completedAt?: string | Date; controlFiles?: any[]; createdAt?: string | Date; dependsOnTaskId?: string; dependsOnTaskName?: string; description?: string; dueDate?: string | Date; errorMessage?: string; flowData?: any; groupId?: string; id?: number; links?: string[]; mentionedAgents?: any[]; mentionedDocs?: any[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; messages?: any[]; name?: string; order?: number; parentTaskId?: string; priority?: "low" | "medium" | "high" | "urgent"; projectId?: number; projectName?: string; projectPath?: string; selectedAgent?: any; selection?: any; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: string | Date; tags?: string[]; taskId?: string; updatedAt?: string | Date; uploadedImages?: string[]; }; type?: "updateTaskResponse"; }> | undefined | Updates an existing task. | packages/codeboltjs/src/modules/task.ts:64 |
terminal | { eventEmitter: CustomEventEmitter; executeCommand: (command: string, returnEmptyStringOnSuccess: boolean) => Promise<CommandOutput | CommandError | CommandFinish>; executeCommandRunUntilError: (command: string, executeInMain: boolean) => Promise<CommandError>; executeCommandRunUntilInterrupt: (command: string, executeInMain: boolean) => Promise<CommandError>; executeCommandWithStream: CustomEventEmitter; sendManualInterrupt: Promise<TerminalInterruptResponse>; } | cbterminal | - | packages/codeboltjs/src/core/Codebolt.ts:143 |
terminal.eventEmitter | CustomEventEmitter | undefined | - | packages/codeboltjs/src/modules/terminal.ts:31 |
terminal.executeCommand | (command: string, returnEmptyStringOnSuccess: boolean) => Promise<CommandOutput | CommandError | CommandFinish> | undefined | Executes a given command and returns the result. Listens for messages from the WebSocket that indicate the output, error, or finish state of the executed command and resolves the promise accordingly. | packages/codeboltjs/src/modules/terminal.ts:41 |
terminal.executeCommandRunUntilError | (command: string, executeInMain: boolean) => Promise<CommandError> | undefined | 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. | packages/codeboltjs/src/modules/terminal.ts:59 |
terminal.executeCommandRunUntilInterrupt | (command: string, executeInMain: boolean) => Promise<CommandError> | undefined | Executes a given command and keeps running until manually interrupted. Listens for messages from the WebSocket and resolves the promise when interrupted. | packages/codeboltjs/src/modules/terminal.ts:78 |
terminal.executeCommandWithStream | CustomEventEmitter | undefined | - | packages/codeboltjs/src/modules/terminal.ts:111 |
terminal.sendManualInterrupt | Promise<TerminalInterruptResponse> | undefined | - | packages/codeboltjs/src/modules/terminal.ts:95 |
thread | { createAndStartThread: (options: { activeStepId?: string; agentId?: string; currentStep?: any; description?: string; environment?: any; groupId?: string; isGrouped?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; metadata?: Record<string, any>; processId?: string; remixPrompt?: string; remoteProvider?: { id?: string; name?: string; }; selectedAgent?: any; selection?: { selectedText?: string; }; status?: string; stepId?: string; steps?: any[]; tags?: string[]; taskId?: string; title?: string; userMessage?: string; }) => Promise<{ activityId?: string; error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "startThreadResponse"; }>; createThread: (options: { activeStepId?: string; currentStep?: any; dependsOnTaskId?: string; dependsOnTaskName?: string; dueDate?: Date; environment?: string; environmentType?: "local" | "remote"; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; groupId?: string; isGrouped?: boolean; isKanbanTask?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; name?: string; processId?: string; remixPrompt?: string; remoteProvider?: { id?: string; name?: string; }; selectedAgent?: any; selection?: { selectedText?: string; }; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; stepId?: string; steps?: { agentId?: string; condition?: string; FlowData?: { edges?: any[]; nodes?: { data?: ...; id?: ...; position?: ...; type?: ...; }[]; }; isMainTask?: boolean; messageData?: { controlFiles?: string[]; environment?: Record<string, any>; isRemoteTask?: boolean; links?: string[]; llmProvider?: { model?: ... | ...; providerId?: ... | ...; }; mentionedAgents?: string[]; mentionedDocs?: string[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedFullPaths?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; uploadedImages?: string[]; }; position?: { x?: number; y?: number; }; status?: string; type?: string; userMessage?: string; }[]; taskType?: "scheduled" | "interactive"; threadId?: string; userMessage?: string; }) => Promise<{ error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; type?: "createThreadResponse"; }>; createThreadInBackground: (options: { activeStepId?: string; agentId?: string; currentStep?: any; description?: string; environment?: any; groupId?: string; isGrouped?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; metadata?: Record<string, any>; processId?: string; remixPrompt?: string; remoteProvider?: { id?: string; name?: string; }; selectedAgent?: any; selection?: { selectedText?: string; }; status?: string; stepId?: string; steps?: any[]; tags?: string[]; taskId?: string; title?: string; userMessage?: string; }) => Promise< | { agentId?: string; error?: string; instanceId?: string; success?: boolean; threadId?: string; type?: "ThreadAgentStarted"; } | { agentId?: string; error?: string; success?: boolean; threadId?: string; type?: "ThreadAgentStartFailed"; }>; deleteThread: (threadId: string) => Promise<{ deleted?: boolean; error?: string; success?: boolean; threadId?: string; type?: "deleteThreadResponse"; }>; getThreadDetail: (options: { includeMessages?: boolean; includeSteps?: boolean; taskId?: string; }) => Promise<{ error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "getThreadResponse"; }>; getThreadFileChanges: (threadId: string) => Promise<ThreadFileChangesResponse>; getThreadFileChangesSummary: (threadId: string) => Promise<ThreadFileChangesSummaryResponse>; getThreadList: (options: { limit?: number; offset?: number; startedByUser?: string; status?: "pending" | "completed" | "processing" | "all"; threadId?: string; }) => Promise<{ agentId?: string; error?: string; limit?: number; offset?: number; status?: string; success?: boolean; taskId?: string; threads?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: ... | ...; format?: ... | ... | ... | ...; id?: ... | ...; memoryId?: ... | ...; threadId?: ... | ...; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: ... | ...; id?: ... | ...; message?: ... | ...; messageId?: ... | ...; messageType?: ... | ... | ... | ... | ... | ... | ... | ...; priority?: ... | ... | ... | ...; stepId?: ... | ...; threadId?: ... | ...; timestamp?: ... | ...; userId?: ... | ...; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: ... | ...; agentId?: ... | ...; completedAt?: ... | ...; condition?: ... | ...; createdAt?: ... | ...; errorMessage?: ... | ...; flowData?: any; id?: ... | ...; isMainTask?: ... | ... | ...; metaData?: any; position?: ... | ...; result?: any; startedAt?: ... | ...; status?: ... | ... | ... | ... | ... | ... | ...; stepId?: ... | ...; threadId?: ... | ...; type?: ... | ...; updatedAt?: ... | ...; userMessage?: ... | ...; value?: ... | ...; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }[]; totalCount?: number; type?: "listThreadsResponse"; }>; getThreadMessages: (options: { limit?: number; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; offset?: number; stepId?: string; taskId?: string; }) => Promise<{ error?: string; limit?: number; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; offset?: number; success?: boolean; threadId?: string; totalCount?: number; type?: "getThreadMessagesResponse"; }>; startThread: (threadId: string) => Promise<{ activityId?: string; error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "startThreadResponse"; }>; updateThread: (threadId: string, updates: { activeStepId?: string; completed?: boolean; currentStep?: any; dependsOnTaskId?: string; dependsOnTaskName?: string; dueDate?: Date; environment?: string; environmentType?: "local" | "remote"; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; groupId?: string; isGrouped?: boolean; isKanbanTask?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; name?: string; processId?: string; remixPrompt?: string; remoteProvider?: { id?: string; name?: string; }; selectedAgent?: any; selection?: { selectedText?: string; }; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; stepId?: string; steps?: { agentId?: string; condition?: string; FlowData?: { edges?: any[]; nodes?: { data?: ...; id?: ...; position?: ...; type?: ...; }[]; }; id?: string; isMainTask?: boolean; messageData?: { controlFiles?: string[]; environment?: Record<string, any>; isRemoteTask?: boolean; links?: string[]; llmProvider?: { model?: ... | ...; providerId?: ... | ...; }; mentionedAgents?: string[]; mentionedDocs?: string[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedFullPaths?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; uploadedImages?: string[]; }; position?: { x?: number; y?: number; }; status?: string; type?: string; userMessage?: string; }[]; taskType?: "scheduled" | "interactive"; userMessage?: string; }) => Promise<{ error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "updateThreadResponse"; }>; updateThreadStatus: (threadId: string, status: string) => Promise<{ error?: string; status?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "updateThreadStatusResponse"; }>; } | thread | - | packages/codeboltjs/src/core/Codebolt.ts:154 |
thread.createAndStartThread | (options: { activeStepId?: string; agentId?: string; currentStep?: any; description?: string; environment?: any; groupId?: string; isGrouped?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; metadata?: Record<string, any>; processId?: string; remixPrompt?: string; remoteProvider?: { id?: string; name?: string; }; selectedAgent?: any; selection?: { selectedText?: string; }; status?: string; stepId?: string; steps?: any[]; tags?: string[]; taskId?: string; title?: string; userMessage?: string; }) => Promise<{ activityId?: string; error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "startThreadResponse"; }> | undefined | Creates and immediately starts a new thread. | packages/codeboltjs/src/modules/thread.ts:73 |
thread.createThread | (options: { activeStepId?: string; currentStep?: any; dependsOnTaskId?: string; dependsOnTaskName?: string; dueDate?: Date; environment?: string; environmentType?: "local" | "remote"; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; groupId?: string; isGrouped?: boolean; isKanbanTask?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; name?: string; processId?: string; remixPrompt?: string; remoteProvider?: { id?: string; name?: string; }; selectedAgent?: any; selection?: { selectedText?: string; }; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; stepId?: string; steps?: { agentId?: string; condition?: string; FlowData?: { edges?: any[]; nodes?: { data?: ...; id?: ...; position?: ...; type?: ...; }[]; }; isMainTask?: boolean; messageData?: { controlFiles?: string[]; environment?: Record<string, any>; isRemoteTask?: boolean; links?: string[]; llmProvider?: { model?: ... | ...; providerId?: ... | ...; }; mentionedAgents?: string[]; mentionedDocs?: string[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedFullPaths?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; uploadedImages?: string[]; }; position?: { x?: number; y?: number; }; status?: string; type?: string; userMessage?: string; }[]; taskType?: "scheduled" | "interactive"; threadId?: string; userMessage?: string; }) => Promise<{ error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; type?: "createThreadResponse"; }> | undefined | Creates a new thread with comprehensive options. | packages/codeboltjs/src/modules/thread.ts:53 |
thread.createThreadInBackground | (options: { activeStepId?: string; agentId?: string; currentStep?: any; description?: string; environment?: any; groupId?: string; isGrouped?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; metadata?: Record<string, any>; processId?: string; remixPrompt?: string; remoteProvider?: { id?: string; name?: string; }; selectedAgent?: any; selection?: { selectedText?: string; }; status?: string; stepId?: string; steps?: any[]; tags?: string[]; taskId?: string; title?: string; userMessage?: string; }) => Promise< | { agentId?: string; error?: string; instanceId?: string; success?: boolean; threadId?: string; type?: "ThreadAgentStarted"; } | { agentId?: string; error?: string; success?: boolean; threadId?: string; type?: "ThreadAgentStartFailed"; }> | undefined | Creates a thread in the background and resolves when the agent starts or fails. | packages/codeboltjs/src/modules/thread.ts:99 |
thread.deleteThread | (threadId: string) => Promise<{ deleted?: boolean; error?: string; success?: boolean; threadId?: string; type?: "deleteThreadResponse"; }> | undefined | Deletes a thread. | packages/codeboltjs/src/modules/thread.ts:218 |
thread.getThreadDetail | (options: { includeMessages?: boolean; includeSteps?: boolean; taskId?: string; }) => Promise<{ error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "getThreadResponse"; }> | undefined | Retrieves detailed information about a specific thread. | packages/codeboltjs/src/modules/thread.ts:149 |
thread.getThreadFileChanges | (threadId: string) => Promise<ThreadFileChangesResponse> | undefined | Retrieves file changes associated with a specific thread. | packages/codeboltjs/src/modules/thread.ts:287 |
thread.getThreadFileChangesSummary | (threadId: string) => Promise<ThreadFileChangesSummaryResponse> | undefined | Retrieves file changes summary for ChangesSummaryPanel. Returns data in the format: { title, changes, files } | packages/codeboltjs/src/modules/thread.ts:311 |
thread.getThreadList | (options: { limit?: number; offset?: number; startedByUser?: string; status?: "pending" | "completed" | "processing" | "all"; threadId?: string; }) => Promise<{ agentId?: string; error?: string; limit?: number; offset?: number; status?: string; success?: boolean; taskId?: string; threads?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: ... | ...; format?: ... | ... | ... | ...; id?: ... | ...; memoryId?: ... | ...; threadId?: ... | ...; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: ... | ...; id?: ... | ...; message?: ... | ...; messageId?: ... | ...; messageType?: ... | ... | ... | ... | ... | ... | ... | ...; priority?: ... | ... | ... | ...; stepId?: ... | ...; threadId?: ... | ...; timestamp?: ... | ...; userId?: ... | ...; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: ... | ...; agentId?: ... | ...; completedAt?: ... | ...; condition?: ... | ...; createdAt?: ... | ...; errorMessage?: ... | ...; flowData?: any; id?: ... | ...; isMainTask?: ... | ... | ...; metaData?: any; position?: ... | ...; result?: any; startedAt?: ... | ...; status?: ... | ... | ... | ... | ... | ... | ...; stepId?: ... | ...; threadId?: ... | ...; type?: ... | ...; updatedAt?: ... | ...; userMessage?: ... | ...; value?: ... | ...; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }[]; totalCount?: number; type?: "listThreadsResponse"; }> | undefined | Retrieves a list of threads with optional filtering. | packages/codeboltjs/src/modules/thread.ts:128 |
thread.getThreadMessages | (options: { limit?: number; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; offset?: number; stepId?: string; taskId?: string; }) => Promise<{ error?: string; limit?: number; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; offset?: number; success?: boolean; threadId?: string; totalCount?: number; type?: "getThreadMessagesResponse"; }> | undefined | Retrieves messages for a specific thread. | packages/codeboltjs/src/modules/thread.ts:266 |
thread.startThread | (threadId: string) => Promise<{ activityId?: string; error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "startThreadResponse"; }> | undefined | Starts a thread. | packages/codeboltjs/src/modules/thread.ts:170 |
thread.updateThread | (threadId: string, updates: { activeStepId?: string; completed?: boolean; currentStep?: any; dependsOnTaskId?: string; dependsOnTaskName?: string; dueDate?: Date; environment?: string; environmentType?: "local" | "remote"; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; groupId?: string; isGrouped?: boolean; isKanbanTask?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; name?: string; processId?: string; remixPrompt?: string; remoteProvider?: { id?: string; name?: string; }; selectedAgent?: any; selection?: { selectedText?: string; }; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; stepId?: string; steps?: { agentId?: string; condition?: string; FlowData?: { edges?: any[]; nodes?: { data?: ...; id?: ...; position?: ...; type?: ...; }[]; }; id?: string; isMainTask?: boolean; messageData?: { controlFiles?: string[]; environment?: Record<string, any>; isRemoteTask?: boolean; links?: string[]; llmProvider?: { model?: ... | ...; providerId?: ... | ...; }; mentionedAgents?: string[]; mentionedDocs?: string[]; mentionedFiles?: string[]; mentionedFolders?: string[]; mentionedFullPaths?: string[]; mentionedMCPs?: string[]; mentionedMultiFile?: string[]; uploadedImages?: string[]; }; position?: { x?: number; y?: number; }; status?: string; type?: string; userMessage?: string; }[]; taskType?: "scheduled" | "interactive"; userMessage?: string; }) => Promise<{ error?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "updateThreadResponse"; }> | undefined | Updates an existing thread. | packages/codeboltjs/src/modules/thread.ts:194 |
thread.updateThreadStatus | (threadId: string, status: string) => Promise<{ error?: string; status?: string; success?: boolean; thread?: { activeStepId?: string; assignedTo?: string; attachedMemories?: { createdAt?: Date; format?: "json" | "markdown" | "todo"; id?: number; memoryId?: string; threadId?: string; }[]; cancellationReason?: string; completed?: boolean; completedAt?: Date; createdAt?: Date; dependsOnThreadId?: string; dependsOnThreadName?: string; description?: string; environment?: Record<string, any>; environmentType?: "local" | "remote"; errorMessage?: string; executionType?: "scheduled" | "manual" | "immediate" | "conditional"; flowData?: any; groupId?: string; id?: number; isKanbanTask?: boolean; isRemoteTask?: boolean; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "info" | "error" | "warning" | "success" | "feedback" | "steering" | "instruction"; priority?: "low" | "medium" | "high"; stepId?: string; threadId?: string; timestamp?: Date; userId?: string; }[]; name?: string; priority?: "low" | "medium" | "high" | "urgent"; progress?: { completedSteps?: number; percentage?: number; totalSteps?: number; }; projectId?: number; projectName?: string; projectPath?: string; startOption?: "manual" | "immediately" | "based_on_group" | "ontaskfinish"; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "created" | "active" | "review" | "planned" | "waiting_user"; statusUpdatedAt?: Date; stepActivatedAt?: Date; steps?: { activatedAt?: Date; agentId?: string; completedAt?: Date; condition?: string; createdAt?: Date; errorMessage?: string; flowData?: any; id?: number; isMainTask?: boolean; metaData?: any; position?: { x?: ...; y?: ...; }; result?: any; startedAt?: Date; status?: | "pending" | "completed" | "failed" | "cancelled" | "in_progress" | "skipped"; stepId?: string; threadId?: string; type?: string; updatedAt?: Date; userMessage?: string; value?: string; }[]; tags?: string[]; threadId?: string; threadType?: "scheduled" | "interactive"; updatedAt?: Date; }; threadId?: string; type?: "updateThreadStatusResponse"; }> | undefined | Updates the status of a thread. | packages/codeboltjs/src/modules/thread.ts:242 |
todo | { addTodo: (params: { priority?: "low" | "medium" | "high"; tags?: string[]; title: string; }) => Promise<AddTodoResponse>; exportTodos: (params?: { format?: "json" | "markdown"; listId?: string; status?: string[]; }) => Promise<ExportTodosResponse>; getAllIncompleteTodos: () => Promise<GetAllIncompleteTodosResponse>; getTodoList: (params?: any) => Promise<GetTodoListResponse>; importTodos: (params: { data: string; format?: "json" | "markdown"; listId?: string; mergeStrategy?: "replace" | "merge"; }) => Promise<ImportTodosResponse>; updateTodo: (params: { id: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing" | "cancelled"; tags?: string[]; title?: string; }) => Promise<UpdateTodoResponse>; } | todo | - | packages/codeboltjs/src/core/Codebolt.ts:165 |
todo.addTodo | (params: { priority?: "low" | "medium" | "high"; tags?: string[]; title: string; }) => Promise<AddTodoResponse> | undefined | Function addTodo Description Adds a new todo item. | packages/codeboltjs/src/modules/todo.ts:26 |
todo.exportTodos | (params?: { format?: "json" | "markdown"; listId?: string; status?: string[]; }) => Promise<ExportTodosResponse> | undefined | Function exportTodos Description Exports todos in the specified format. | packages/codeboltjs/src/modules/todo.ts:102 |
todo.getAllIncompleteTodos | () => Promise<GetAllIncompleteTodosResponse> | undefined | Function getAllIncompleteTodos Description Retrieves all incomplete todo items. | packages/codeboltjs/src/modules/todo.ts:82 |
todo.getTodoList | (params?: any) => Promise<GetTodoListResponse> | undefined | Function getTodoList Description Retrieves the todo list. | packages/codeboltjs/src/modules/todo.ts:65 |
todo.importTodos | (params: { data: string; format?: "json" | "markdown"; listId?: string; mergeStrategy?: "replace" | "merge"; }) => Promise<ImportTodosResponse> | undefined | Function importTodos Description Imports todos from the specified format. | packages/codeboltjs/src/modules/todo.ts:123 |
todo.updateTodo | (params: { id: string; priority?: "low" | "medium" | "high"; status?: "pending" | "completed" | "processing" | "cancelled"; tags?: string[]; title?: string; }) => Promise<UpdateTodoResponse> | undefined | Function updateTodo Description Updates an existing todo item. | packages/codeboltjs/src/modules/todo.ts:48 |
tokenizer | { addToken: (key: string) => Promise<AddTokenResponse>; getToken: (key: string) => Promise<GetTokenResponse>; } | tokenizer | - | packages/codeboltjs/src/core/Codebolt.ts:157 |
tokenizer.addToken | (key: string) => Promise<AddTokenResponse> | undefined | Adds a token to the system via WebSocket. | packages/codeboltjs/src/modules/tokenizer.ts:14 |
tokenizer.getToken | (key: string) => Promise<GetTokenResponse> | undefined | Retrieves a token from the system via WebSocket. | packages/codeboltjs/src/modules/tokenizer.ts:32 |
userMessage | { clear: () => void; getCurrent: () => FlatUserMessage | undefined; getCurrentFile: () => string | undefined; getMentionedAgents: () => any[]; getMentionedFiles: () => string[]; getMentionedFolders: () => string[]; getMentionedMCPs: () => string[]; getMessageId: () => string | undefined; getProcessingConfig: () => AgentProcessingConfig; getRemixPrompt: () => string | undefined; getSelection: () => string | undefined; getSessionData: (key: string) => any; getText: () => string; getThreadId: () => string | undefined; getTimestamp: () => string | undefined; getUploadedImages: () => any[]; hasMessage: () => boolean; isProcessingEnabled: (type: | "processMentionedMCPs" | "processRemixPrompt" | "processMentionedFiles" | "processMentionedAgents") => boolean; setSessionData: (key: string, value: any) => void; updateProcessingConfig: (config: any) => void; } | userMessageUtilities | User message utilities for accessing current user message and context | packages/codeboltjs/src/core/Codebolt.ts:198 |
userMessage.clear | () => void | undefined | Clear current user message | packages/codeboltjs/src/modules/user-message-utilities.ts:133 |
userMessage.getCurrent | () => FlatUserMessage | undefined | undefined | Get the current user message object | packages/codeboltjs/src/modules/user-message-utilities.ts:16 |
userMessage.getCurrentFile | () => string | undefined | undefined | Get current file path | packages/codeboltjs/src/modules/user-message-utilities.ts:64 |
userMessage.getMentionedAgents | () => any[] | undefined | Get mentioned agents from current message | packages/codeboltjs/src/modules/user-message-utilities.ts:46 |
userMessage.getMentionedFiles | () => string[] | undefined | Get mentioned files from current message | packages/codeboltjs/src/modules/user-message-utilities.ts:34 |
userMessage.getMentionedFolders | () => string[] | undefined | Get mentioned folders from current message | packages/codeboltjs/src/modules/user-message-utilities.ts:40 |
userMessage.getMentionedMCPs | () => string[] | undefined | Get mentioned MCPs from current message | packages/codeboltjs/src/modules/user-message-utilities.ts:28 |
userMessage.getMessageId | () => string | undefined | undefined | Get message ID | packages/codeboltjs/src/modules/user-message-utilities.ts:76 |
userMessage.getProcessingConfig | () => AgentProcessingConfig | undefined | Get processing configuration | packages/codeboltjs/src/modules/user-message-utilities.ts:88 |
userMessage.getRemixPrompt | () => string | undefined | undefined | Get remix prompt from current message | packages/codeboltjs/src/modules/user-message-utilities.ts:52 |
userMessage.getSelection | () => string | undefined | undefined | Get text selection from current message | packages/codeboltjs/src/modules/user-message-utilities.ts:70 |
userMessage.getSessionData | (key: string) => any | undefined | Get session data | packages/codeboltjs/src/modules/user-message-utilities.ts:110 |
userMessage.getText | () => string | undefined | Get the user message text content | packages/codeboltjs/src/modules/user-message-utilities.ts:22 |
userMessage.getThreadId | () => string | undefined | undefined | Get thread ID | packages/codeboltjs/src/modules/user-message-utilities.ts:82 |
userMessage.getTimestamp | () => string | undefined | undefined | Get message timestamp | packages/codeboltjs/src/modules/user-message-utilities.ts:116 |
userMessage.getUploadedImages | () => any[] | undefined | Get uploaded images from current message | packages/codeboltjs/src/modules/user-message-utilities.ts:58 |
userMessage.hasMessage | () => boolean | undefined | Check if there's a current message | packages/codeboltjs/src/modules/user-message-utilities.ts:122 |
userMessage.isProcessingEnabled | (type: | "processMentionedMCPs" | "processRemixPrompt" | "processMentionedFiles" | "processMentionedAgents") => boolean | undefined | Check if a processing type is enabled | packages/codeboltjs/src/modules/user-message-utilities.ts:95 |
userMessage.setSessionData | (key: string, value: any) => void | undefined | Set session data | packages/codeboltjs/src/modules/user-message-utilities.ts:103 |
userMessage.updateProcessingConfig | (config: any) => void | undefined | Update processing configuration | packages/codeboltjs/src/modules/user-message-utilities.ts:128 |
utils | { editFileAndApplyDiff: (filePath: string, diff: string, diffIdentifier: string, prompt: string, applyModel?: string) => Promise<FsEditFileAndApplyDiffResponse>; } | cbutils | - | packages/codeboltjs/src/core/Codebolt.ts:161 |
utils.editFileAndApplyDiff | (filePath: string, diff: string, diffIdentifier: string, prompt: string, applyModel?: string) => Promise<FsEditFileAndApplyDiffResponse> | undefined | Edits a file and applies a diff with AI assistance. | packages/codeboltjs/src/modules/utils.ts:17 |
vectordb | { addVectorItem: (item: any) => Promise<AddVectorItemResponse>; getVector: (key: string) => Promise<GetVectorResponse>; queryVectorItem: (key: string) => Promise<QueryVectorItemResponse>; queryVectorItems: (items: [], dbPath: string) => Promise<QueryVectorItemResponse>; } | vectorDB | - | packages/codeboltjs/src/core/Codebolt.ts:155 |
vectordb.addVectorItem | (item: any) => Promise<AddVectorItemResponse> | undefined | Adds a new vector item to the vector database. | packages/codeboltjs/src/modules/vectordb.ts:31 |
vectordb.getVector | (key: string) => Promise<GetVectorResponse> | undefined | Retrieves a vector from the vector database based on the provided key. | packages/codeboltjs/src/modules/vectordb.ts:11 |
vectordb.queryVectorItem | (key: string) => Promise<QueryVectorItemResponse> | undefined | Queries a vector item from the vector database based on the provided key. | packages/codeboltjs/src/modules/vectordb.ts:50 |
vectordb.queryVectorItems | (items: [], dbPath: string) => Promise<QueryVectorItemResponse> | undefined | Queries a vector item from the vector database based on the provided key. | packages/codeboltjs/src/modules/vectordb.ts:68 |
websocket | WebSocket | null | null | - | packages/codeboltjs/src/core/Codebolt.ts:72 |
Accessors
ready
Get Signature
get ready(): boolean;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:131
Method
isReady
Description
Checks if the Codebolt instance is ready for use.
Returns
boolean
True if the instance is ready, false otherwise.
Methods
getMessage()
getMessage(): Promise<FlatUserMessage>;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:237
Gets the current or next incoming message. Priority order:
- Returns the current message being processed (if called during message handling)
- Returns a queued message (if any are waiting)
- Waits for the next message to arrive
This allows getMessage() to work both during active message processing and when waiting for new messages in a loop.
Returns
Promise<FlatUserMessage>
A promise that resolves with the message
onActionBlockInvocation()
onActionBlockInvocation(handler: (threadContext: any, metadata: {
parentAgentId: string;
parentAgentInstanceId: string;
sideExecutionId: string;
threadId: string;
timestamp: string;
}) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:405
Sets up a listener for ActionBlock invocation events. This is called when a Side Execution ActionBlock is invoked by a parent agent.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (threadContext: any, metadata: { parentAgentId: string; parentAgentInstanceId: string; sideExecutionId: string; threadId: string; timestamp: string; }) => any | The handler function to call when ActionBlock is invoked. - params: The parameters passed to the ActionBlock - threadContext: The thread context from the parent agent - metadata: Additional metadata (sideExecutionId, threadId, parentAgentId, etc.) |
Returns
void
onCloseSignal()
onCloseSignal(handler: () => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:996
Sets up a listener for close signal events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => any | The handler function to call when close signal is received. |
Returns
void
onCopyFile()
onCopyFile(handler: (sourcePath: string, destinationPath: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:876
Sets up a listener for copy file events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (sourcePath: string, destinationPath: string) => any | The handler function to call when copy file is requested. |
Returns
void
onCopyFolder()
onCopyFolder(handler: (sourcePath: string, destinationPath: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:916
Sets up a listener for copy folder events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (sourcePath: string, destinationPath: string) => any | The handler function to call when copy folder is requested. |
Returns
void
onCreateFolder()
onCreateFolder(handler: (path: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:836
Sets up a listener for create folder events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (path: string) => any | The handler function to call when create folder is requested. |
Returns
void
onCreatePatchRequest()
onCreatePatchRequest(handler: () => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1034
Sets up a listener for create patch request events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => any | The handler function to call when patch request is created. |
Returns
void
onCreatePullRequestRequest()
onCreatePullRequestRequest(handler: () => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1072
Sets up a listener for create pull request events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => any | The handler function to call when pull request is created. |
Returns
void
onDeleteFile()
onDeleteFile(handler: (path: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:716
Sets up a listener for delete file events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (path: string) => any | The handler function to call when delete file is requested. |
Returns
void
onDeleteFolder()
onDeleteFolder(handler: (path: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:756
Sets up a listener for delete folder events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (path: string) => any | The handler function to call when delete folder is requested. |
Returns
void
onEnvironmentHeartbeatRequest()
onEnvironmentHeartbeatRequest(handler: (request: {
environmentId: string;
providerId: string;
timestamp: string;
}) =>
| void
| Promise<void>
| {
remoteExecutorStatus: "error" | "running" | "starting" | "stopped" | "restarting";
status: "active" | "degraded" | "unreachable";
}
| Promise<{
remoteExecutorStatus: "error" | "running" | "starting" | "stopped" | "restarting";
status: "active" | "degraded" | "unreachable";
}>): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1342
Sets up a listener for environment heartbeat requests. Environment executors should respond with their current status.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (request: { environmentId: string; providerId: string; timestamp: string; }) => | void | Promise<void> | { remoteExecutorStatus: "error" | "running" | "starting" | "stopped" | "restarting"; status: "active" | "degraded" | "unreachable"; } | Promise<{ remoteExecutorStatus: "error" | "running" | "starting" | "stopped" | "restarting"; status: "active" | "degraded" | "unreachable"; }> | The handler function to call when heartbeat is requested |
Returns
void
onEnvironmentRestartRequest()
onEnvironmentRestartRequest(handler: (request: {
environmentId: string;
providerId: string;
}) =>
| void
| Promise<void>
| {
message?: string;
success: boolean;
}
| Promise<{
message?: string;
success: boolean;
}>): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1397
Sets up a listener for environment restart requests from the main application.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (request: { environmentId: string; providerId: string; }) => | void | Promise<void> | { message?: string; success: boolean; } | Promise<{ message?: string; success: boolean; }> | The handler function to restart the environment/remote executor |
Returns
void
onGetDiffFiles()
onGetDiffFiles(handler: () => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:597
Sets up a listener for get diff files events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => any | The handler function to call when diff files are requested. |
Returns
void
onGetFullProject()
onGetFullProject(handler: () => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:956
Sets up a listener for get full project events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => any | The handler function to call when get full project is requested. |
Returns
void
onGetTreeChildren()
onGetTreeChildren(handler: (path: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1190
Sets up a listener for get tree children events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (path: string) => any | The handler function to call when tree children are requested. |
Returns
void
onMergeAsPatch()
onMergeAsPatch(handler: () => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1110
Sets up a listener for merge as patch events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => any | The handler function to call when merge as patch is requested. |
Returns
void
onMessage()
onMessage(handler: (userMessage: FlatUserMessage, additionalVariable?: Record<string, string | undefined>) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:335
Sets up a listener for incoming messages with a direct handler function. Note: Message extraction and resolver handling is done by setupMessageListener. This method only adds the custom handler logic and sends processStoped response.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (userMessage: FlatUserMessage, additionalVariable?: Record<string, string | undefined>) => any | The handler function to call when a message is received. |
Returns
void
onProviderAgentStart()
onProviderAgentStart(handler: (userMessage: any) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:517
Sets up a listener for provider agent start events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (userMessage: any) => any | The handler function to call when provider agent starts. |
Returns
void
onProviderHeartbeatRequest()
onProviderHeartbeatRequest(handler: (request: {
providerId: string;
timestamp: string;
}) =>
| void
| Promise<void>
| {
connectedEnvironments: string[];
status: "error" | "healthy" | "degraded";
}
| Promise<{
connectedEnvironments: string[];
status: "error" | "healthy" | "degraded";
}>): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1294
Sets up a listener for provider heartbeat requests from the main application. Providers should respond with their current health status.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (request: { providerId: string; timestamp: string; }) => | void | Promise<void> | { connectedEnvironments: string[]; status: "error" | "healthy" | "degraded"; } | Promise<{ connectedEnvironments: string[]; status: "error" | "healthy" | "degraded"; }> | The handler function to call when heartbeat is requested |
Returns
void
onProviderStart()
onProviderStart(handler: (initvars: ProviderInitVars) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:479
Sets up a listener for provider start events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (initvars: ProviderInitVars) => any | The handler function to call when provider starts. |
Returns
void
onProviderStop()
onProviderStop(handler: (initvars: ProviderInitVars) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:558
Sets up a listener for provider stop events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (initvars: ProviderInitVars) => any | The handler function to call when provider stops. |
Returns
void
onRawMessage()
onRawMessage(handler: (userMessage: RawMessageForAgent) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:461
Parameters
| Parameter | Type |
|---|---|
handler | (userMessage: RawMessageForAgent) => any |
Returns
void
onReadFile()
onReadFile(handler: (path: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:636
Sets up a listener for read file events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (path: string) => any | The handler function to call when read file is requested. |
Returns
void
onReady()
onReady(handler: () => void | Promise<void>): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:206
Sets up a handler function to be executed when the WebSocket connection is established. If the connection is already established, the handler will be executed immediately.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => void | Promise<void> | The handler function to call when the connection is ready. |
Returns
void
onRenameItem()
onRenameItem(handler: (oldPath: string, newPath: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:796
Sets up a listener for rename item events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (oldPath: string, newPath: string) => any | The handler function to call when rename item is requested. |
Returns
void
onSendPR()
onSendPR(handler: () => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1150
Sets up a listener for send PR events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => any | The handler function to call when send PR is requested. |
Returns
void
onWriteFile()
onWriteFile(handler: (path: string, content: string) => any): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:676
Sets up a listener for write file events.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (path: string, content: string) => any | The handler function to call when write file is requested. |
Returns
void
sendEnvironmentHeartbeat()
sendEnvironmentHeartbeat(heartbeatData: {
environmentId: string;
providerId: string;
}): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1269
Sends an environment heartbeat request to the remote executor.
Parameters
| Parameter | Type | Description |
|---|---|---|
heartbeatData | { environmentId: string; providerId: string; } | The heartbeat data to send |
heartbeatData.environmentId | string | The environment ID |
heartbeatData.providerId | string | The provider ID |
Returns
void
sendProviderHeartbeat()
sendProviderHeartbeat(heartbeatData: {
connectedEnvironments: string[];
metadata?: Record<string, any>;
providerId: string;
status: "error" | "healthy" | "degraded";
uptime?: number;
}): void;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:1237
Sends a provider heartbeat to the main application. Should be called periodically by providers to indicate they are alive.
Parameters
| Parameter | Type | Description |
|---|---|---|
heartbeatData | { connectedEnvironments: string[]; metadata?: Record<string, any>; providerId: string; status: "error" | "healthy" | "degraded"; uptime?: number; } | The heartbeat data to send |
heartbeatData.connectedEnvironments | string[] | Array of connected environment IDs |
heartbeatData.metadata? | Record<string, any> | Optional metadata |
heartbeatData.providerId | string | The provider ID |
heartbeatData.status | "error" | "healthy" | "degraded" | The provider health status ('healthy', 'degraded', 'error') |
heartbeatData.uptime? | number | - |
Returns
void
waitForReady()
waitForReady(): Promise<void>;
Defined in: packages/codeboltjs/src/core/Codebolt.ts:122
Returns
Promise<void>
A promise that resolves when the instance is ready.
Method
waitForReady
Description
Waits for the Codebolt instance to be fully initialized.