PluginClient
Class: PluginClient
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:111
PluginClient is the main facade for building CodeBolt plugins.
Unlike codeboltjs (which is for agents), PluginClient provides:
- Plugin-specific lifecycle (onStart/onStop instead of onMessage)
- WebSocket modules for server interaction (same as agents, via cliLib)
- HTTP API modules for client-like operations (from clientsdk pattern)
- Notification functions for UI communication
Constructors
Constructor
new PluginClient(config?: Partial<CodeBoltConfig>): PluginClient;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:216
Parameters
| Parameter | Type |
|---|---|
config? | Partial<CodeBoltConfig> |
Returns
PluginClient
Properties
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:163 |
browser.click | (elementid: string, options?: BrowserOperationOptions) => Promise<BrowserActionResponseData> | undefined | Clicks on a specified element on the page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:317 |
browser.close | (options?: BrowserOperationOptions) => Promise<void> | undefined | Closes the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:260 |
browser.closeBrowserInstance | (instanceId: string) => Promise<boolean> | undefined | Close a browser instance | CodeBolt/packages/pluginSdk/src/modules/browser.ts:441 |
browser.enter | (options?: BrowserOperationOptions) => Promise<BrowserActionResponseData> | undefined | Simulates the Enter key press on the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:335 |
browser.executeOnInstance | (instanceId: string, operation: BrowserOperationType, params: BrowserOperationParams) => Promise<BrowserOperationResponse> | undefined | Execute action on specific browser instance | CodeBolt/packages/pluginSdk/src/modules/browser.ts:464 |
browser.extractText | (options?: BrowserOperationOptions) => Promise<ExtractTextResponse> | undefined | Extracts text from the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:244 |
browser.getBrowserInfo | (options?: BrowserOperationOptions) => Promise<BrowserInfoResponse> | undefined | Retrieves browser info like height width scrollx scrolly of the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:227 |
browser.getBrowserInstance | (instanceId: string) => Promise<BrowserInstanceInfo | null> | undefined | Get a specific browser instance by ID | CodeBolt/packages/pluginSdk/src/modules/browser.ts:397 |
browser.getContent | (options?: BrowserOperationOptions) => Promise<GetContentResponse> | undefined | Retrieves the content of the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:195 |
browser.getHTML | (options?: BrowserOperationOptions) => Promise<HtmlReceived> | undefined | Retrieves the HTML content of the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:135 |
browser.getMarkdown | (options?: BrowserOperationOptions) => Promise<GetMarkdownResponse> | undefined | Retrieves the Markdown content of the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:152 |
browser.getPDF | (options?: BrowserOperationOptions) => Promise<void> | undefined | Retrieves the PDF content of the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:168 |
browser.getSnapShot | (options?: BrowserOperationOptions) => Promise<BrowserSnapshotResponse> | undefined | Retrieves the snapshot of the current page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:211 |
browser.getUrl | (options?: BrowserOperationOptions) => Promise<UrlResponse> | undefined | Retrieves the current URL of the browser's active page. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:79 |
browser.goToPage | (url: string, options?: BrowserOperationOptions) => Promise<GoToPageResponse> | undefined | Navigates to a specified URL. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:97 |
browser.listBrowserInstances | () => Promise<BrowserInstanceInfo[]> | undefined | List all open browser instances | CodeBolt/packages/pluginSdk/src/modules/browser.ts:376 |
browser.newPage | (options?: BrowserInstanceOptions) => Promise<BrowserActionResponseData> | undefined | Opens a new page in the browser. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:61 |
browser.openNewBrowserInstance | (options?: BrowserInstanceOptions) => Promise<{ instanceId: string; }> | undefined | Open a new browser instance | CodeBolt/packages/pluginSdk/src/modules/browser.ts:422 |
browser.pdfToText | (options?: BrowserOperationOptions) => Promise<void> | undefined | Converts the PDF content of the current page to text. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:181 |
browser.screenshot | (options?: BrowserScreenshotOptions) => Promise<BrowserScreenshotResponse> | undefined | Takes a screenshot of the current page. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/browser.ts:354 |
browser.setActiveBrowserInstance | (instanceId: string) => Promise<boolean> | undefined | Set the active browser instance | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:177 |
calendar.createEvent | (params: ICreateEventParams) => Promise<ICreateEventResponse> | undefined | Create a new calendar event | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:273 |
calendar.deleteEvent | (params: IDeleteEventParams) => Promise<IDeleteEventResponse> | undefined | Delete a calendar event | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:303 |
calendar.getEvent | (params: IGetEventParams) => Promise<IGetEventResponse> | undefined | Get a single calendar event by ID | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:318 |
calendar.getEventsInRange | (params: IGetEventsInRangeParams) => Promise<IGetEventsInRangeResponse> | undefined | Get events within a specific date range | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:348 |
calendar.getStatus | () => Promise<IGetStatusResponse> | undefined | Get the calendar scheduler status | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:450 |
calendar.getTriggeredEvents | (params: IGetTriggeredEventsParams) => Promise<IGetTriggeredEventsResponse> | undefined | Get triggered events (events whose start time has passed) | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:378 |
calendar.getTriggeredEventsAndMarkComplete | () => Promise<IGetTriggeredEventsAndMarkCompleteResponse> | undefined | Get triggered events and mark them all as complete in one operation | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:422 |
calendar.getUpcomingEvents | (params: IGetUpcomingEventsParams) => Promise<IGetUpcomingEventsResponse> | undefined | Get upcoming events within a specified time window | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:363 |
calendar.listEvents | (params: IListEventsParams) => Promise<IListEventsResponse> | undefined | List calendar events with optional filters | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:333 |
calendar.markEventComplete | (params: IMarkEventCompleteParams) => Promise<IMarkEventCompleteResponse> | undefined | Mark a single event as complete | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:393 |
calendar.markEventsComplete | (params: IMarkEventsCompleteParams) => Promise<IMarkEventsCompleteResponse> | undefined | Mark multiple events as complete | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:408 |
calendar.rsvp | (params: IRSVPParams) => Promise<IRSVPResponse> | undefined | RSVP to a calendar event | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:436 |
calendar.updateEvent | (params: IUpdateEventParams) => Promise<IUpdateEventResponse> | undefined | Update an existing calendar event | CodeBolt/packages/pluginSdk/src/modules/calendar.ts:288 |
calendarApi | CalendarApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:209 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:182 |
cbstate.addToAgentState | (key: string, value: string) => Promise<AddToAgentStateResponse> | undefined | Adds a key-value pair to the agent's state on the server via WebSocket. | CodeBolt/packages/pluginSdk/src/modules/state.ts:28 |
cbstate.getAgentState | () => Promise<GetAgentStateResponse> | undefined | Retrieves the current state of the agent from the server via WebSocket. | CodeBolt/packages/pluginSdk/src/modules/state.ts:46 |
cbstate.getApplicationState | () => Promise<ApplicationState> | undefined | Retrieves the current application state from the server via WebSocket. | CodeBolt/packages/pluginSdk/src/modules/state.ts:13 |
cbstate.getProjectState | () => Promise<GetProjectStateResponse> | undefined | Retrieves the current project state from the server via WebSocket. | CodeBolt/packages/pluginSdk/src/modules/state.ts:62 |
cbstate.updateProjectState | (key: string, value: any) => Promise<UpdateProjectStateResponse> | undefined | Updates the project state on the server via WebSocket. | CodeBolt/packages/pluginSdk/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: | "editor" | "browser" | "terminal" | "git" | "debug" | "planner" | "preview") => void; setRequestHandler: (handler: RequestHandler) => void; stopProcess: () => void; waitforReply: (message: string) => Promise<UserMessage>; } | cbchat | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:162 |
chat.askQuestion | (question: string, buttons: string[], withFeedback: boolean) => Promise<string> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/chat.ts:186 |
chat.checkForSteeringMessage | () => SteeringMessage | null | undefined | Checks if any steering message has been received. | CodeBolt/packages/pluginSdk/src/modules/chat.ts:213 |
chat.getChatHistory | (threadId: string) => Promise<ChatMessage> | undefined | Retrieves the chat history from the server. | CodeBolt/packages/pluginSdk/src/modules/chat.ts:45 |
chat.onSteeringMessageReceived | () => Promise<SteeringMessage | null> | undefined | Waits for a steering message. | CodeBolt/packages/pluginSdk/src/modules/chat.ts:229 |
chat.processFinished | () => void | undefined | Stops the ongoing process. Sends a specific message to the server to stop the process. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/chat.ts:175 |
chat.sendMessage | (message: string, payload?: object) => void | undefined | Sends a message through the WebSocket connection. | CodeBolt/packages/pluginSdk/src/modules/chat.ts:89 |
chat.sendNotificationEvent | (notificationMessage: string, type: | "editor" | "browser" | "terminal" | "git" | "debug" | "planner" | "preview") => void | undefined | Sends a notification event to the server. | CodeBolt/packages/pluginSdk/src/modules/chat.ts:201 |
chat.setRequestHandler | (handler: RequestHandler) => void | undefined | Sets a global request handler for all incoming messages | CodeBolt/packages/pluginSdk/src/modules/chat.ts:58 |
chat.stopProcess | () => void | undefined | Stops the ongoing process. Sends a specific message to the server to stop the process. | CodeBolt/packages/pluginSdk/src/modules/chat.ts:157 |
chat.waitforReply | (message: string) => Promise<UserMessage> | undefined | Waits for a reply to a sent message. | CodeBolt/packages/pluginSdk/src/modules/chat.ts:101 |
chatApi | ChatApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:198 |
codebaseSearch | { search: (query: string, targetDirectories?: string[]) => Promise<CodebaseSearchResponse>; searchMcpTool: (query: string, tags?: string[]) => Promise<McpToolSearchResponse>; } | cbcodebaseSearch | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:180 |
codebaseSearch.search | (query: string, targetDirectories?: string[]) => Promise<CodebaseSearchResponse> | undefined | Perform a semantic search across the codebase | CodeBolt/packages/pluginSdk/src/modules/codebaseSearch.ts:21 |
codebaseSearch.searchMcpTool | (query: string, tags?: string[]) => Promise<McpToolSearchResponse> | undefined | Search for MCP tools by query and optional tags | CodeBolt/packages/pluginSdk/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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:179 |
codemap.create | (data: CreateCodemapData, projectPath?: string) => Promise<CodemapCreateResponse> | undefined | Create a placeholder codemap (status: 'creating') Call this before generating the actual codemap content | CodeBolt/packages/pluginSdk/src/modules/codemap.ts:58 |
codemap.delete | (codemapId: string, projectPath?: string) => Promise<CodemapDeleteResponse> | undefined | Delete a codemap | CodeBolt/packages/pluginSdk/src/modules/codemap.ts:122 |
codemap.get | (codemapId: string, projectPath?: string) => Promise<CodemapGetResponse> | undefined | Get a specific codemap by ID | CodeBolt/packages/pluginSdk/src/modules/codemap.ts:41 |
codemap.list | (projectPath?: string) => Promise<CodemapListResponse> | undefined | List all codemaps for a project | CodeBolt/packages/pluginSdk/src/modules/codemap.ts:25 |
codemap.save | (codemapId: string, codemap: Codemap, projectPath?: string) => Promise<CodemapSaveResponse> | undefined | Save a complete codemap with content | CodeBolt/packages/pluginSdk/src/modules/codemap.ts:74 |
codemap.setStatus | (codemapId: string, status: CodemapStatus, error?: string, projectPath?: string) => Promise<CodemapUpdateResponse> | undefined | Set the status of a codemap | CodeBolt/packages/pluginSdk/src/modules/codemap.ts:90 |
codemap.update | (codemapId: string, data: UpdateCodemapData, projectPath?: string) => Promise<CodemapUpdateResponse> | undefined | Update codemap info (title, description, etc.) | CodeBolt/packages/pluginSdk/src/modules/codemap.ts:106 |
debug | { debug: (log: string, type: logType) => Promise<DebugAddLogResponse>; openDebugBrowser: (url: string, port: number) => Promise<OpenDebugBrowserResponse>; } | debug | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:181 |
debug.debug | (log: string, type: logType) => Promise<DebugAddLogResponse> | undefined | Sends a log message to the debug websocket and waits for a response. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/debug.ts:39 |
dynamicPanel | { close: (panelId: string) => Promise<DynamicPanelResponse>; list: () => Promise<DynamicPanelListResponse>; offMessage: (panelId: string) => void; onMessage: (panelId: string, handler: (data: any) => void) => void; open: (panelId: string, title: string, html: string, opts?: DynamicPanelOpenOptions) => Promise<DynamicPanelOpenResponse>; send: (panelId: string, data: any) => Promise<DynamicPanelResponse>; update: (panelId: string, html: string) => Promise<DynamicPanelResponse>; } | cbdynamicPanel | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:172 |
dynamicPanel.close | (panelId: string) => Promise<DynamicPanelResponse> | undefined | Closes a DynamicPanel and removes it from the UI. | CodeBolt/packages/pluginSdk/src/modules/dynamicPanel.ts:140 |
dynamicPanel.list | () => Promise<DynamicPanelListResponse> | undefined | Lists all currently active DynamicPanels. | CodeBolt/packages/pluginSdk/src/modules/dynamicPanel.ts:172 |
dynamicPanel.offMessage | (panelId: string) => void | undefined | Removes the message handler for a specific panel. | CodeBolt/packages/pluginSdk/src/modules/dynamicPanel.ts:202 |
dynamicPanel.onMessage | (panelId: string, handler: (data: any) => void) => void | undefined | Registers a handler for messages coming from a specific panel's iframe. The iframe sends messages via window.parent.postMessage(\{ type: '...', data: \{...\} \}, '*'). Only one handler per panelId is supported. Calling this again for the same panelId replaces the previous handler. | CodeBolt/packages/pluginSdk/src/modules/dynamicPanel.ts:192 |
dynamicPanel.open | (panelId: string, title: string, html: string, opts?: DynamicPanelOpenOptions) => Promise<DynamicPanelOpenResponse> | undefined | Opens a new DynamicPanel with the given HTML content. When opts.waitForResponse is true the call blocks until the panel iframe sends a \{ type: 'submit', data: \{...\} \} message via window.parent.postMessage(). The resolved value then contains the submitted data. | CodeBolt/packages/pluginSdk/src/modules/dynamicPanel.ts:103 |
dynamicPanel.send | (panelId: string, data: any) => Promise<DynamicPanelResponse> | undefined | Pushes arbitrary data into the panel's iframe via postMessage. The iframe receives this in its window.addEventListener('message', ...) handler. | CodeBolt/packages/pluginSdk/src/modules/dynamicPanel.ts:159 |
dynamicPanel.update | (panelId: string, html: string) => Promise<DynamicPanelResponse> | undefined | Replaces the HTML content of an existing DynamicPanel. | CodeBolt/packages/pluginSdk/src/modules/dynamicPanel.ts:125 |
environment | { createEnvironment: (environmentData: { config?: any; description?: string; name: string; provider: any; }) => Promise<any>; deleteEnvironment: (environmentId: string) => Promise<any>; getEnvironment: (environmentId: string) => Promise<any>; getEnvironmentStatistics: () => Promise<any>; getEnvironmentStatus: (environmentId: string) => Promise<any>; getLocalProviders: () => Promise<any>; getRunningProviders: () => Promise<any>; listEnvironments: () => Promise<any>; restartEnvironment: (environmentId: string) => Promise<any>; sendMessageToEnvironment: (environmentId: string, message: any) => Promise<any>; startAgentInEnvironment: (environmentId: string, task: string, agentId?: string, threadId?: string) => Promise<any>; startEnvironment: (environmentId: string) => Promise<any>; stopEnvironment: (environmentId: string) => Promise<any>; updateEnvironment: (environmentId: string, updateData: any) => Promise<any>; } | cbenvironment | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:173 |
environment.createEnvironment | (environmentData: { config?: any; description?: string; name: string; provider: any; }) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:21 |
environment.deleteEnvironment | (environmentId: string) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:40 |
environment.getEnvironment | (environmentId: string) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:14 |
environment.getEnvironmentStatistics | () => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:89 |
environment.getEnvironmentStatus | (environmentId: string) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:68 |
environment.getLocalProviders | () => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:82 |
environment.getRunningProviders | () => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:75 |
environment.listEnvironments | () => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:7 |
environment.restartEnvironment | (environmentId: string) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:61 |
environment.sendMessageToEnvironment | (environmentId: string, message: any) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:96 |
environment.startAgentInEnvironment | (environmentId: string, task: string, agentId?: string, threadId?: string) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:103 |
environment.startEnvironment | (environmentId: string) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:47 |
environment.stopEnvironment | (environmentId: string) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:54 |
environment.updateEnvironment | (environmentId: string, updateData: any) => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/environment.ts:33 |
environmentsApi | EnvironmentsApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:206 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:176 |
eventLog.appendEvent | (params: AppendEventParams) => Promise<EventLogAppendResponse> | undefined | Append a single event to the log | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:103 |
eventLog.appendEvents | (params: AppendEventsParams) => Promise<EventLogAppendMultipleResponse> | undefined | Append multiple events to the log | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:118 |
eventLog.createInstance | (name: string, description?: string) => Promise<EventLogInstanceResponse> | undefined | Create a new event log instance | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:28 |
eventLog.deleteInstance | (instanceId: string) => Promise<EventLogInstanceResponse> | undefined | Delete an event log instance | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:88 |
eventLog.getInstance | (instanceId: string) => Promise<EventLogInstanceResponse> | undefined | Get an event log instance by ID | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:43 |
eventLog.getInstanceStats | (instanceId: string) => Promise<EventLogStatsResponse> | undefined | Get instance statistics | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:148 |
eventLog.listInstances | () => Promise<EventLogInstanceListResponse> | undefined | List all event log instances | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:57 |
eventLog.queryEvents | (query: EventLogDSL) => Promise<EventLogQueryResponse> | undefined | Query events using DSL | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:133 |
eventLog.updateInstance | (instanceId: string, updates: UpdateEventLogInstanceParams) => Promise<EventLogInstanceResponse> | undefined | Update an event log instance | CodeBolt/packages/pluginSdk/src/modules/eventLog.ts:73 |
executionGateway | { claim: () => Promise<ExecutionGatewayClaimResponse>; offNotification: (callback: (notification: ExecutionNotification) => void) => void; offRequest: (callback: (request: ExecutionRequest) => void) => void; onNotification: (callback: (notification: ExecutionNotification) => void) => void; onRequest: (callback: (request: ExecutionRequest) => void) => void; relinquish: () => Promise<ExecutionGatewayResponse>; sendReply: (requestId: string, result: any, success: boolean) => void; subscribe: () => Promise<ExecutionGatewayResponse>; unsubscribe: () => Promise<ExecutionGatewayResponse>; } | cbExecutionGateway | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:187 |
executionGateway.claim | () => Promise<ExecutionGatewayClaimResponse> | undefined | Claim exclusive handling of execution requests. Only one plugin can claim at a time. Returns an error if already claimed. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:121 |
executionGateway.offNotification | (callback: (notification: ExecutionNotification) => void) => void | undefined | Remove a previously registered notification callback. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:214 |
executionGateway.offRequest | (callback: (request: ExecutionRequest) => void) => void | undefined | Remove a previously registered request callback. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:155 |
executionGateway.onNotification | (callback: (notification: ExecutionNotification) => void) => void | undefined | Register a callback for execution notifications. These are broadcast after any locally-executed agent action. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:206 |
executionGateway.onRequest | (callback: (request: ExecutionRequest) => void) => void | undefined | Register a callback for incoming execution requests. These are proxied agent messages that the claiming plugin must handle. After processing, call sendReply() with the requestId and result. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:147 |
executionGateway.relinquish | () => Promise<ExecutionGatewayResponse> | undefined | Release the claim on the execution gateway. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:132 |
executionGateway.sendReply | (requestId: string, result: any, success: boolean) => void | undefined | Send a reply for a specific execution request. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:167 |
executionGateway.subscribe | () => Promise<ExecutionGatewayResponse> | undefined | Subscribe to execution notifications. Notifications are broadcast whenever the server handles a message locally. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:181 |
executionGateway.unsubscribe | () => Promise<ExecutionGatewayResponse> | undefined | Unsubscribe from execution notifications. | CodeBolt/packages/pluginSdk/src/modules/executionGateway.ts:192 |
fileApi | FileApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:207 |
fileReadApi | FileReadApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:208 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:159 |
fs.createFile | (fileName: string, source: string, filePath: string) => Promise<CreateFileResponse> | undefined | Function createFile Description Creates a new file. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:21 |
fs.createFolder | (folderName: string, folderPath: string) => Promise<CreateFolderResponse> | undefined | Function createFolder Description Creates a new folder. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:55 |
fs.deleteFile | (filename: string, filePath: string) => Promise<DeleteFileResponse> | undefined | Function deleteFile Description Deletes a file. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:120 |
fs.deleteFolder | (foldername: string, folderpath: string) => Promise<DeleteFolderResponse> | undefined | Function deleteFolder Description Deletes a folder. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:303 |
fs.fileSearch | (query: string) => Promise<FileSearchResponse> | undefined | Function fileSearch Description Performs a fuzzy search for files. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:255 |
fs.listCodeDefinitionNames | (path: string) => Promise<ListCodeDefinitionsResponse> | undefined | Function listCodeDefinitionNames Description Lists all code definition names in a given path. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:370 |
fs.listFile | (folderPath: string, isRecursive: boolean) => Promise<FileListResponse> | undefined | Function listFile Description Lists all files. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:158 |
fs.readFile | (filePath: string) => Promise<ReadFileResponse> | undefined | Function readFile Description Reads the content of a file. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:100 |
fs.writeToFile | (relPath: string, newContent: string) => Promise<any> | undefined | Function writeToFile Description Writes content to a file. | CodeBolt/packages/pluginSdk/src/modules/fs.ts:221 |
gateway | { offMessageToChannel: (callback: (message: ChannelMessage) => void) => void; offReply: (callback: (reply: GatewayReply) => void) => void; onMessageToChannel: (callback: (message: ChannelMessage) => void) => void; onReply: (callback: (reply: GatewayReply) => void) => void; registerChannel: (request: RegisterChannelRequest) => Promise<RegisterChannelResponse>; routeMessage: (message: PluginGatewayMessage) => Promise<GatewayRouteResponse>; unregisterChannel: () => Promise<void>; } | cbgateway | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:186 |
gateway.offMessageToChannel | (callback: (message: ChannelMessage) => void) => void | undefined | Remove a previously registered messageToChannel callback. | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:245 |
gateway.offReply | (callback: (reply: GatewayReply) => void) => void | undefined | Remove a previously registered reply callback. | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:192 |
gateway.onMessageToChannel | (callback: (message: ChannelMessage) => void) => void | undefined | Register a callback for proactive messages from the application. When the server wants to send a notification/message to a platform user, it pushes a gateway.messageToChannel event which triggers this callback. | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:237 |
gateway.onReply | (callback: (reply: GatewayReply) => void) => void | undefined | Register a callback for agent replies. When an agent sends a response on a gateway-managed thread, the server pushes a gateway.reply message which triggers this callback. | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:184 |
gateway.registerChannel | (request: RegisterChannelRequest) => Promise<RegisterChannelResponse> | undefined | Register this plugin as a channel in the ChannelStore so it appears in the Routing Rules view. Should be called once during plugin startup. | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:204 |
gateway.routeMessage | (message: PluginGatewayMessage) => Promise<GatewayRouteResponse> | undefined | Route an incoming platform message to the RoutingGateway. The server resolves the thread, finds/spawns the agent, and delivers the message. | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:166 |
gateway.unregisterChannel | () => Promise<void> | undefined | Unregister this plugin's channel from the ChannelStore. Should be called during plugin shutdown. | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:219 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:160 |
git.addAll | () => Promise<AddResponse> | undefined | Adds changes in the local repository to the staging area at the given path. | CodeBolt/packages/pluginSdk/src/modules/git.ts:87 |
git.branch | (branch: string) => Promise<GitBranchResponse> | undefined | Creates a new branch in the local repository at the given path. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/git.ts:117 |
git.clone | (url: string, path?: string) => Promise<GitCloneResponse> | undefined | Clones a remote Git repository to the specified path. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/git.ts:164 |
git.init | (path: string) => Promise<GitInitResponse> | undefined | Initializes a new Git repository at the given path. | CodeBolt/packages/pluginSdk/src/modules/git.ts:28 |
git.logs | (path: string) => Promise<GitLogsResponse> | undefined | Retrieves the commit logs for the local repository at the given path. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/git.ts:44 |
git.push | () => Promise<GitPushResponse> | undefined | Pushes local repository changes to the remote repository at the given path. | CodeBolt/packages/pluginSdk/src/modules/git.ts:58 |
git.status | () => Promise<GitStatusResponse> | undefined | Retrieves the status of the local repository at the given path. | CodeBolt/packages/pluginSdk/src/modules/git.ts:73 |
gitApi | GitApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:203 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:175 |
hook.create | (config: HookConfig) => Promise<HookResponse> | undefined | Create a new hook | CodeBolt/packages/pluginSdk/src/modules/hook.ts:37 |
hook.delete | (hookId: string) => Promise<HookDeleteResponse> | undefined | Delete a hook | CodeBolt/packages/pluginSdk/src/modules/hook.ts:70 |
hook.disable | (hookId: string) => Promise<HookResponse> | undefined | Disable a hook | CodeBolt/packages/pluginSdk/src/modules/hook.ts:133 |
hook.enable | (hookId: string) => Promise<HookResponse> | undefined | Enable a hook | CodeBolt/packages/pluginSdk/src/modules/hook.ts:117 |
hook.get | (hookId: string) => Promise<HookResponse> | undefined | Get a hook by ID | CodeBolt/packages/pluginSdk/src/modules/hook.ts:101 |
hook.initialize | (projectPath: string) => Promise<HookInitializeResponse> | undefined | Initialize the hook manager for a project | CodeBolt/packages/pluginSdk/src/modules/hook.ts:21 |
hook.list | () => Promise<HookListResponse> | undefined | List all hooks | CodeBolt/packages/pluginSdk/src/modules/hook.ts:85 |
hook.update | (hookId: string, config: Partial<HookConfig>) => Promise<HookResponse> | undefined | Update an existing hook | CodeBolt/packages/pluginSdk/src/modules/hook.ts:54 |
hooksApi | HooksApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:214 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:171 |
job.acceptBid | (jobId: string, bidId: string) => Promise<JobBidAcceptResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:570 |
job.acceptSplitProposal | (jobId: string, proposalId: string) => Promise<JobSplitAcceptResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:428 |
job.addBid | (jobId: string, bid: AddBidData) => Promise<JobBidAddResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:544 |
job.addBlocker | (jobId: string, blocker: AddBlockerData) => Promise<JobBlockerAddResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:600 |
job.addDependency | (jobId: string, targetId: string, type?: DependencyType) => Promise<JobDependencyResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:161 |
job.addLabel | (label: string) => Promise<JobLabelsResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:221 |
job.addPheromoneType | (data: AddPheromoneTypeData) => Promise<JobPheromoneTypeResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:277 |
job.addSplitProposal | (jobId: string, proposal: AddSplitProposalData) => Promise<JobSplitProposeResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:402 |
job.addUnlockRequest | (jobId: string, request: AddUnlockRequestData) => Promise<JobUnlockRequestAddResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:488 |
job.approveUnlockRequest | (jobId: string, unlockRequestId: string, respondedBy: string) => Promise<JobUnlockRequestApproveResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:501 |
job.createJob | (groupId: string, data: CreateJobData) => Promise<JobCreateResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:62 |
job.createJobGroup | (data: CreateJobGroupData) => Promise<JobGroupCreateResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:144 |
job.deleteJob | (jobId: string) => Promise<JobDeleteResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:101 |
job.deleteJobs | (jobIds: string[]) => Promise<JobDeleteBulkResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:114 |
job.deleteSplitProposal | (jobId: string, proposalId: string) => Promise<JobSplitDeleteResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:415 |
job.deleteUnlockRequest | (jobId: string, unlockRequestId: string) => Promise<JobUnlockRequestDeleteResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:527 |
job.depositPheromone | (jobId: string, deposit: DepositPheromoneData) => Promise<JobPheromoneDepositResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:307 |
job.getBlockedJobs | (filters: JobListFilters) => Promise<JobReadyBlockedResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:204 |
job.getJob | (jobId: string) => Promise<JobShowResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:75 |
job.getPheromones | (jobId: string) => Promise<JobPheromoneListResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:333 |
job.getPheromonesAggregated | (jobId: string) => Promise<JobPheromoneAggregatedResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:346 |
job.getPheromonesAggregatedWithDecay | (jobId: string) => Promise<JobPheromoneAggregatedResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:385 |
job.getPheromonesWithDecay | (jobId: string) => Promise<JobPheromoneListResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:372 |
job.getPheromoneTypes | () => Promise<JobPheromoneTypesResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:264 |
job.getReadyJobs | (filters: JobListFilters) => Promise<JobReadyBlockedResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:191 |
job.isJobLocked | (jobId: string) => Promise<JobLockCheckResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:471 |
job.listBids | (jobId: string) => Promise<JobBidListResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:583 |
job.listJobs | (filters: JobListFilters) => Promise<JobListResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:127 |
job.listJobsByPheromone | (type: string, minIntensity?: number) => Promise<JobPheromoneSearchResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:359 |
job.listLabels | () => Promise<JobLabelsResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:247 |
job.lockJob | (jobId: string, agentId: string, agentName?: string) => Promise<JobLockAcquireResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:445 |
job.rejectUnlockRequest | (jobId: string, unlockRequestId: string, respondedBy: string) => Promise<JobUnlockRequestRejectResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:514 |
job.removeBlocker | (jobId: string, blockerId: string) => Promise<JobBlockerRemoveResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:613 |
job.removeDependency | (jobId: string, targetId: string) => Promise<JobDependencyResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:174 |
job.removeLabel | (label: string) => Promise<JobLabelsResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:234 |
job.removePheromone | (jobId: string, type: string, depositedBy?: string) => Promise<JobPheromoneRemoveResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:320 |
job.removePheromoneType | (name: string) => Promise<JobPheromoneTypeResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:290 |
job.resolveBlocker | (jobId: string, blockerId: string, resolvedBy: string) => Promise<JobBlockerResolveResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:626 |
job.unlockJob | (jobId: string, agentId: string) => Promise<JobLockReleaseResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:458 |
job.updateJob | (jobId: string, data: UpdateJobData) => Promise<JobUpdateResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:88 |
job.withdrawBid | (jobId: string, bidId: string) => Promise<JobBidWithdrawResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/job.ts:557 |
jobsApi | JobsApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:204 |
knowledge | { } | cbknowledge | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:165 |
knowledgeApi | KnowledgeApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:205 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:167 |
kvStore.createInstance | (name: string, description?: string) => Promise<KVInstanceResponse> | undefined | Create a new KV store instance | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:30 |
kvStore.delete | (instanceId: string, namespace: string, key: string) => Promise<KVDeleteResponse> | undefined | Delete a value from the KV store | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:149 |
kvStore.deleteInstance | (instanceId: string) => Promise<KVDeleteResponse> | undefined | Delete a KV store instance | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:90 |
kvStore.deleteNamespace | (instanceId: string, namespace: string) => Promise<KVDeleteNamespaceResponse> | undefined | Delete an entire namespace from the KV store | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:165 |
kvStore.get | (instanceId: string, namespace: string, key: string) => Promise<KVGetResponse> | undefined | Get a value from the KV store | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:107 |
kvStore.getInstance | (instanceId: string) => Promise<KVInstanceResponse> | undefined | Get a KV store instance by ID | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:45 |
kvStore.getNamespaces | (instanceId: string) => Promise<KVNamespacesResponse> | undefined | Get all namespaces in an instance | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:195 |
kvStore.getRecordCount | (instanceId: string, namespace?: string) => Promise<KVRecordCountResponse> | undefined | Get record count for an instance or namespace | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:211 |
kvStore.listInstances | () => Promise<KVInstanceListResponse> | undefined | List all KV store instances | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:59 |
kvStore.query | (query: KVQueryDSL) => Promise<KVQueryResponse> | undefined | Query the KV store using DSL | CodeBolt/packages/pluginSdk/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 | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:126 |
kvStore.updateInstance | (instanceId: string, updates: UpdateKVInstanceParams) => Promise<KVInstanceResponse> | undefined | Update a KV store instance | CodeBolt/packages/pluginSdk/src/modules/kvStore.ts:75 |
kvStoreApi | KvStoreApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:211 |
llm | { getModelConfig: (modelId?: string) => Promise<{ config: LLMModelConfig | null; error?: string; success: boolean; }>; inference: (params: LLMInferenceParams) => Promise<{ completion: LLMCompletion; }>; } | cbllm | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:164 |
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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/llm.ts:28 |
llmProvider | { onCompletionRequest: (callback: (req: LlmCompletionRequest) => void) => void; onLoginRequest: (callback: (req: LlmLoginRequest) => void) => void; onStreamRequest: (callback: (req: LlmStreamRequest) => void) => void; register: (manifest: LlmProviderManifest) => Promise<LlmProviderRegisterResponse>; sendChunk: (requestId: string, chunk: any) => void; sendError: (requestId: string, error: string) => void; sendReply: (requestId: string, response: any, success: boolean) => void; unregister: (providerId: string) => Promise<LlmProviderResponse>; } | cbLlmProvider | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:188 |
llmProvider.onCompletionRequest | (callback: (req: LlmCompletionRequest) => void) => void | undefined | Subscribe to incoming non-streaming completion requests. Reply with sendReply(requestId, response) or sendError(requestId, error). | CodeBolt/packages/pluginSdk/src/modules/llmProvider.ts:195 |
llmProvider.onLoginRequest | (callback: (req: LlmLoginRequest) => void) => void | undefined | Subscribe to incoming login requests (triggered by the UI login button). The plugin should run its authentication flow (e.g. OAuth) and then call sendReply(requestId, { authenticated: true }) or sendError(). | CodeBolt/packages/pluginSdk/src/modules/llmProvider.ts:215 |
llmProvider.onStreamRequest | (callback: (req: LlmStreamRequest) => void) => void | undefined | Subscribe to incoming streaming completion requests. Stream tokens with sendChunk(requestId, chunk), then finalize with sendReply(requestId, finalResponse) or sendError(requestId, error). | CodeBolt/packages/pluginSdk/src/modules/llmProvider.ts:205 |
llmProvider.register | (manifest: LlmProviderManifest) => Promise<LlmProviderRegisterResponse> | undefined | Register this plugin as a custom LLM provider on the server. After registration, the provider appears in the provider list and can be selected by users like any built-in provider. | CodeBolt/packages/pluginSdk/src/modules/llmProvider.ts:172 |
llmProvider.sendChunk | (requestId: string, chunk: any) => void | undefined | Send a streaming chunk for an in-flight stream request. The chunk shape should match multillm StreamChunk (id, model, choices: [{delta: {content, ...}}]). | CodeBolt/packages/pluginSdk/src/modules/llmProvider.ts:225 |
llmProvider.sendError | (requestId: string, error: string) => void | undefined | Send an error for a completion or stream request. | CodeBolt/packages/pluginSdk/src/modules/llmProvider.ts:252 |
llmProvider.sendReply | (requestId: string, response: any, success: boolean) => void | undefined | Send the final reply for a completion or stream request. For non-streaming: this is the only message you send. For streaming: send after all chunks have been emitted. | CodeBolt/packages/pluginSdk/src/modules/llmProvider.ts:239 |
llmProvider.unregister | (providerId: string) => Promise<LlmProviderResponse> | undefined | Unregister this plugin's provider. | CodeBolt/packages/pluginSdk/src/modules/llmProvider.ts:183 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:178 |
mail.acknowledge | (params: IAcknowledgeParams) => Promise<IAcknowledgeResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:226 |
mail.archiveThread | (params: IArchiveThreadParams) => Promise<IArchiveThreadResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:152 |
mail.checkConflicts | (params: ICheckConflictsParams) => Promise<ICheckConflictsResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:297 |
mail.createThread | (params: ICreateThreadParams) => Promise<ICreateThreadResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:100 |
mail.fetchInbox | (params: IFetchInboxParams) => Promise<IFetchInboxResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:163 |
mail.findOrCreateThread | (params: IFindOrCreateThreadParams) => Promise<IFindOrCreateThreadResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:111 |
mail.forceReserveFiles | (params: IForceReserveFilesParams) => Promise<IForceReserveFilesResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:277 |
mail.getAgent | (params: IGetAgentParams) => Promise<IGetAgentResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:89 |
mail.getMessage | (params: IGetMessageParams) => Promise<IGetMessageResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:196 |
mail.getMessages | (params: IGetMessagesParams) => Promise<IGetMessagesResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:206 |
mail.getThread | (params: IGetThreadParams) => Promise<IGetThreadResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:132 |
mail.listAgents | () => Promise<IListAgentsResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:80 |
mail.listReservations | (params: IListReservationsParams) => Promise<IListReservationsResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:287 |
mail.listThreads | (params: IListThreadsParams) => Promise<IListThreadsResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:122 |
mail.markRead | (params: IMarkReadParams) => Promise<IMarkReadResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:216 |
mail.registerAgent | (params: IRegisterAgentParams) => Promise<IRegisterAgentResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:70 |
mail.releaseFiles | (params: IReleaseFilesParams) => Promise<IReleaseFilesResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:267 |
mail.replyMessage | (params: IReplyMessageParams) => Promise<IReplyMessageResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:186 |
mail.reserveFiles | (params: IReserveFilesParams) => Promise<IReserveFilesResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:257 |
mail.search | (params: ISearchParams) => Promise<ISearchResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:236 |
mail.sendMessage | (params: ISendMessageParams) => Promise<ISendMessageResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:173 |
mail.summarizeThread | (params: ISummarizeThreadParams) => Promise<ISummarizeThreadResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:246 |
mail.updateThreadStatus | (params: IUpdateThreadStatusParams) => Promise<IUpdateThreadStatusResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/mail.ts:142 |
mailApi | MailApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:210 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:174 |
mcp.configureMCPServer | (name: string, config: MCPConfiguration) => Promise<ConfigureToolBoxResponse> | undefined | Configures a specific toolbox with provided configuration. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:99 |
mcp.configureMcpTool | (mcpName: string, toolName: string, config: Record<string, unknown>) => Promise<ConfigureMCPToolResponse> | undefined | Configures a specific MCP tool with provided configuration. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:196 |
mcp.executeTool | (toolbox: string, toolName: string, params: ToolParameters) => Promise<ExecuteToolResponse> | undefined | Executes a specific tool with provided parameters. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:128 |
mcp.getAllMcpTools | () => Promise<GetAllMCPToolsResponse> | undefined | Gets all tools from all enabled MCP servers. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:170 |
mcp.getEnabledMcps | () => Promise<GetEnabledMCPSResponse> | undefined | Gets the list of enabled MCP servers. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:183 |
mcp.getEnabledMCPServers | () => Promise<GetEnabledToolBoxesResponse> | undefined | Gets the list of currently enabled toolboxes. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:32 |
mcp.getLocalMCPServers | () => Promise<GetLocalToolBoxesResponse> | undefined | Gets the list of locally available toolboxes. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:45 |
mcp.getMcpList | () => Promise<GetMcpListResponse> | undefined | Gets the list of available MCP servers. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:157 |
mcp.getMcpTools | (mcpNames?: string[]) => Promise<GetMcpToolsResponse> | undefined | Gets MCP tools from the specified servers. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:143 |
mcp.getMentionedMCPServers | (userMessage: MCPUserMessage) => Promise<GetAvailableToolBoxesResponse> | undefined | Gets toolboxes mentioned in a user message. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:58 |
mcp.getTools | (toolRequests: { toolbox: string; toolName: string; }[]) => Promise<GetToolsResponse> | undefined | Gets detailed information about specific tools. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:114 |
mcp.listMcpFromServers | (toolBoxes: string[]) => Promise<ListToolsFromToolBoxesResponse> | undefined | Lists all tools from the specified toolboxes. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:85 |
mcp.searchAvailableMCPServers | (query: string) => Promise<SearchAvailableToolBoxesResponse> | undefined | Searches for available toolboxes matching a query. | CodeBolt/packages/pluginSdk/src/modules/mcp.ts:71 |
memory | { addKnowledge: (key: string, value: MemoryValue) => Promise<MemorySetResponse>; getKnowledge: (key: string) => Promise<MemoryGetResponse>; } | dbmemory | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:183 |
memory.addKnowledge | (key: string, value: MemoryValue) => Promise<MemorySetResponse> | undefined | Adds a key-value pair to the in-memory database. | CodeBolt/packages/pluginSdk/src/modules/dbmemory.ts:19 |
memory.getKnowledge | (key: string) => Promise<MemoryGetResponse> | undefined | Retrieves a value from the in-memory database by key. | CodeBolt/packages/pluginSdk/src/modules/dbmemory.ts:35 |
notify | NotificationFunctions | notificationFunctions | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:193 |
project | { getEditorFileStatus: () => Promise<any>; getProjectPath: () => Promise<GetProjectPathResponse>; getProjectSettings: () => Promise<GetProjectSettingsResponse>; getRepoMap: (message: any) => Promise<GetProjectPathResponse>; runProject: () => void; } | cbproject | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:184 |
project.getEditorFileStatus | () => Promise<any> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/project.ts:51 |
project.getProjectPath | () => Promise<GetProjectPathResponse> | undefined | Retrieves the path of the current project. | CodeBolt/packages/pluginSdk/src/modules/project.ts:26 |
project.getProjectSettings | () => Promise<GetProjectSettingsResponse> | undefined | Retrieves the project settings from the server. | CodeBolt/packages/pluginSdk/src/modules/project.ts:13 |
project.getRepoMap | (message: any) => Promise<GetProjectPathResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/project.ts:35 |
project.runProject | () => void | undefined | - | CodeBolt/packages/pluginSdk/src/modules/project.ts:45 |
projectsApi | ProjectsApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:201 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:185 |
projectStructure.addCommand | (packageId: string, command: Omit<RunCommand, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Add a run command to a package | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:312 |
projectStructure.addDependency | (packageId: string, dependency: Omit<Dependency, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Add a dependency to a package | CodeBolt/packages/pluginSdk/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 | CodeBolt/packages/pluginSdk/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 | CodeBolt/packages/pluginSdk/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 | CodeBolt/packages/pluginSdk/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 | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:364 |
projectStructure.createPackage | (data: CreatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | undefined | Create a new package | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:104 |
projectStructure.deleteCommand | (packageId: string, commandId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a run command | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:344 |
projectStructure.deleteDependency | (packageId: string, dependencyId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a dependency | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:292 |
projectStructure.deleteDeployment | (packageId: string, configId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a deployment config | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:448 |
projectStructure.deletePackage | (packageId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a package | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:136 |
projectStructure.deleteRoute | (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete an API route | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:188 |
projectStructure.deleteTable | (packageId: string, tableId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a database table | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:240 |
projectStructure.deleteUiRoute | (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | undefined | Delete a UI route | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:396 |
projectStructure.getMetadata | (workspacePath?: string) => Promise<ProjectStructureMetadataResponse> | undefined | Get complete project metadata | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:36 |
projectStructure.getPackage | (packageId: string, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | undefined | Get a specific package by ID | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:88 |
projectStructure.getPackages | (workspacePath?: string) => Promise<ProjectStructurePackagesResponse> | undefined | Get all packages in the workspace | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:72 |
projectStructure.updateCommand | (packageId: string, commandId: string, updates: Partial<RunCommand>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a run command | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:328 |
projectStructure.updateDependency | (packageId: string, dependencyId: string, updates: Partial<Dependency>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a dependency | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:276 |
projectStructure.updateDeployment | (packageId: string, configId: string, updates: Partial<DeploymentConfig>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a deployment config | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:432 |
projectStructure.updateDesignGuidelines | (packageId: string, guidelines: DesignGuidelines, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update design guidelines for a package | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:484 |
projectStructure.updateFrontendFramework | (packageId: string, framework: FrameworkInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update frontend framework for a package | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:500 |
projectStructure.updateGit | (gitInfo: GitInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update git information | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:468 |
projectStructure.updateMetadata | (updates: Record<string, any>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update workspace metadata | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:52 |
projectStructure.updatePackage | (packageId: string, updates: UpdatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | undefined | Update a package | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:120 |
projectStructure.updateRoute | (packageId: string, routeId: string, updates: Partial<ApiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update an API route | CodeBolt/packages/pluginSdk/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 | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:516 |
projectStructure.updateTable | (packageId: string, tableId: string, updates: Partial<DatabaseTable>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a database table | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:224 |
projectStructure.updateUiRoute | (packageId: string, routeId: string, updates: Partial<UiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | undefined | Update a UI route | CodeBolt/packages/pluginSdk/src/modules/projectStructure.ts:380 |
systemApi | SystemApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:202 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:168 |
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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/task.ts:40 |
task.deleteTask | (taskId: string) => Promise<{ deleted?: boolean; error?: string; success?: boolean; taskId?: string; type?: "deleteTaskResponse"; }> | undefined | Deletes a task. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/task.ts:111 |
task.getTaskStatus | (taskId: string) => Promise<string | undefined> | undefined | Gets the status of a task. | CodeBolt/packages/pluginSdk/src/modules/task.ts:191 |
task.getTaskSummary | (taskId: string) => Promise<string | undefined> | undefined | Gets the summary (description) of a task. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/task.ts:64 |
tasksApi | TasksApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:199 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:161 |
terminal.eventEmitter | CustomEventEmitter | undefined | - | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/terminal.ts:78 |
terminal.executeCommandWithStream | CustomEventEmitter | undefined | - | CodeBolt/packages/pluginSdk/src/modules/terminal.ts:111 |
terminal.sendManualInterrupt | Promise<TerminalInterruptResponse> | undefined | - | CodeBolt/packages/pluginSdk/src/modules/terminal.ts:95 |
thread | { createAndStartThread: (options: { activeStepId?: string; agentId?: string; currentStep?: any; description?: string; environment?: any; environmentName?: string; environmentProvider?: { name?: string; providerId?: string; unique_id?: string; }; groupId?: string; isGrouped?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; metadata?: Record<string, any>; processId?: string; remixPrompt?: string; remoteEnv?: boolean; 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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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; environmentName?: string; environmentProvider?: { name?: string; providerId?: string; unique_id?: string; }; groupId?: string; isGrouped?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; metadata?: Record<string, any>; processId?: string; remixPrompt?: string; remoteEnv?: boolean; 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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; offset?: number; stepId?: string; taskId?: string; }) => Promise<{ error?: string; limit?: number; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:169 |
thread.createAndStartThread | (options: { activeStepId?: string; agentId?: string; currentStep?: any; description?: string; environment?: any; environmentName?: string; environmentProvider?: { name?: string; providerId?: string; unique_id?: string; }; groupId?: string; isGrouped?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; metadata?: Record<string, any>; processId?: string; remixPrompt?: string; remoteEnv?: boolean; 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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:76 |
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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:53 |
thread.createThreadInBackground | (options: { activeStepId?: string; agentId?: string; currentStep?: any; description?: string; environment?: any; environmentName?: string; environmentProvider?: { name?: string; providerId?: string; unique_id?: string; }; groupId?: string; isGrouped?: boolean; isRemoteTask?: boolean; mentionedAgents?: any[]; mentionedMCPs?: any[]; messageId?: string; metadata?: Record<string, any>; processId?: string; remixPrompt?: string; remoteEnv?: boolean; 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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:105 |
thread.deleteThread | (threadId: string) => Promise<{ deleted?: boolean; error?: string; success?: boolean; threadId?: string; type?: "deleteThreadResponse"; }> | undefined | Deletes a thread. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:224 |
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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:155 |
thread.getThreadFileChanges | (threadId: string) => Promise<ThreadFileChangesResponse> | undefined | Retrieves file changes associated with a specific thread. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:293 |
thread.getThreadFileChangesSummary | (threadId: string) => Promise<ThreadFileChangesSummaryResponse> | undefined | Retrieves file changes summary for ChangesSummaryPanel. Returns data in the format: { title, changes, files } | CodeBolt/packages/pluginSdk/src/modules/thread.ts:317 |
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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:134 |
thread.getThreadMessages | (options: { limit?: number; messageType?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; offset?: number; stepId?: string; taskId?: string; }) => Promise<{ error?: string; limit?: number; messages?: { agentId?: string; id?: number; message?: string; messageId?: string; messageType?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:272 |
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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:176 |
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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:200 |
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?: | "error" | "success" | "info" | "warning" | "feedback" | "instruction" | "steering"; 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. | CodeBolt/packages/pluginSdk/src/modules/thread.ts:248 |
threadsApi | ThreadsApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:200 |
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 | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:170 |
todo.addTodo | (params: { priority?: "low" | "medium" | "high"; tags?: string[]; title: string; }) => Promise<AddTodoResponse> | undefined | Function addTodo Description Adds a new todo item. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/todo.ts:102 |
todo.getAllIncompleteTodos | () => Promise<GetAllIncompleteTodosResponse> | undefined | Function getAllIncompleteTodos Description Retrieves all incomplete todo items. | CodeBolt/packages/pluginSdk/src/modules/todo.ts:82 |
todo.getTodoList | (params?: any) => Promise<GetTodoListResponse> | undefined | Function getTodoList Description Retrieves the todo list. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/todo.ts:48 |
todosApi | TodosApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:213 |
vectordb | { addVectorItem: (item: any) => Promise<AddVectorItemResponse>; getVector: (key: string) => Promise<GetVectorResponse>; queryVectorItem: (key: string) => Promise<QueryVectorItemResponse>; queryVectorItems: (items: [], dbPath: string) => Promise<QueryVectorItemResponse>; } | vectorDB | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:166 |
vectordb.addVectorItem | (item: any) => Promise<AddVectorItemResponse> | undefined | Adds a new vector item to the vector database. | CodeBolt/packages/pluginSdk/src/modules/vectordb.ts:31 |
vectordb.getVector | (key: string) => Promise<GetVectorResponse> | undefined | Retrieves a vector from the vector database based on the provided key. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/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. | CodeBolt/packages/pluginSdk/src/modules/vectordb.ts:68 |
vectordbApi | VectorDbApi | undefined | - | CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:212 |
Accessors
manifest
Get Signature
get manifest(): any;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:456
Get the plugin manifest.
Returns
any
pluginDir
Get Signature
get pluginDir(): string;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:449
Get the plugin working directory.
Returns
string
pluginId
Get Signature
get pluginId(): string;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:442
Get the plugin ID (from environment or start context).
Returns
string
ready
Get Signature
get ready(): boolean;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:431
Check if the plugin is ready.
Returns
boolean
sockets
Get Signature
get sockets(): PluginSockets;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:259
Returns
Methods
getConnectionManager()
getConnectionManager(): SocketConnectionManager;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:582
Get the underlying multiplexed socket connection manager for advanced usage.
Returns
getHttpClient()
getHttpClient(): HttpClient;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:575
Get the underlying HTTP client for advanced usage.
Returns
onRawMessage()
onRawMessage(handler: (message: any) => void | Promise<void>): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:559
Listen for raw WebSocket messages of any type. Useful for handling custom message types.
Parameters
| Parameter | Type |
|---|---|
handler | (message: any) => void | Promise<void> |
Returns
void
onReady()
onReady(handler: () => void | Promise<void>): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:468
Register a handler for when the WebSocket connection is ready. If already ready, the handler executes immediately.
Parameters
| Parameter | Type |
|---|---|
handler | () => void | Promise<void> |
Returns
void
onStart()
onStart(handler: (context: PluginContext) => any): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:491
Register a handler for the plugin start event. Called when the server sends a pluginStartMessage with context.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (context: PluginContext) => any | Receives plugin context (pluginId, pluginDir, manifest) |
Returns
void
onStop()
onStop(handler: () => void | Promise<void>): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:532
Register a handler for the plugin stop event. Called when the server requests the plugin to stop. The handler should perform cleanup before the process exits.
Parameters
| Parameter | Type |
|---|---|
handler | () => void | Promise<void> |
Returns
void
waitForReady()
waitForReady(): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/core/PluginClient.ts:424
Wait for the plugin to be fully connected and ready.
Returns
Promise<void>