@codebolt/codeboltjs 2.0.16 → 2.1.0

package/dist/agentlib/promptbuilder.d.ts

@@ -1,382 +0,0 @@
-import { UserMessage as CLIUserMessage } from "../types/socketMessageTypes";
-import type { OpenAIMessage, OpenAITool, ConversationEntry, CodeboltAPI, ToolResult } from "../types/libFunctionTypes";
-import type { MCPTool, Agent, InitialUserMessage } from "../types/commonTypes";
-/**
- * PromptBuilder class for constructing prompts using a fluent interface.
- * Allows chaining methods to build complex prompts from user messages.
- */
-declare class InitialPromptBuilder {
-    /** The main message text */
-    private message;
-    /** List of mentioned files */
-    private mentionedFiles;
-    /** List of mentioned MCP tools */
-    private mentionedMCPs;
-    /** List of mentioned agents */
-    private mentionedAgents;
-    /** Array of prompt parts that will be joined */
-    private promptParts;
-    /** System prompt text */
-    private systemPromptText;
-    /** Task instruction text */
-    private taskInstructionText;
-    /** Available tools */
-    private tools;
-    /** Conversation history */
-    private conversationHistory;
-    /** Environment details */
-    private environmentDetails;
-    /** File contents cache */
-    private fileContents;
-    /** Codebolt API instance */
-    private codebolt?;
-    private shouldLoadMCPTools;
-    private mcpAdditionalServers;
-    private shouldLoadAgentTools;
-    private shouldLoadEnvironmentDetails;
-    private shouldLoadAll;
-    /**
-     * Creates a new PromptBuilder instance.
-     *
-     * @param userMessage - The initial user message containing text and mentioned entities
-     * @param codebolt - Optional codebolt API instance for automatic tool and environment loading
-     */
-    constructor(userMessage: InitialUserMessage | CLIUserMessage, codebolt?: CodeboltAPI);
-    /**
-     * Sets the codebolt API instance for automatic operations.
-     *
-     * @param codebolt - The codebolt API instance
-     * @returns The PromptBuilder instance for chaining
-     */
-    setCodeboltAPI(codebolt: CodeboltAPI): this;
-    /**
-     * Marks MCP tools to be loaded during build from the mentioned MCPs and additional servers.
-     *
-     * @param additionalServers - Additional MCP servers to load tools from
-     * @returns The PromptBuilder instance for chaining
-     */
-    addMCPTools(additionalServers?: string[]): this;
-    /**
-     * Marks mentioned agents to be converted to OpenAI tool format during build.
-     *
-     * @returns The PromptBuilder instance for chaining
-     */
-    addAgentTools(): this;
-    /**
-     * Marks environment details to be loaded during build.
-     *
-     * @returns The PromptBuilder instance for chaining
-     */
-    addEnvironmentDetails(): this;
-    /**
-     * Convenience method to mark all tools and environment details to be loaded during build.
-     * Equivalent to calling addMCPTools(), addAgentTools(), and addEnvironmentDetails().
-     *
-     * @param additionalServers - Additional MCP servers to load tools from
-     * @returns The PromptBuilder instance for chaining
-     */
-    addAllAutomatic(additionalServers?: string[]): this;
-    /**
-     * Loads MCP tools from the codebolt API.
-     * Internal method called during build.
-     */
-    private loadMCPTools;
-    /**
-     * Converts mentioned agents to OpenAI tool format.
-     * Internal method called during build.
-     */
-    private loadAgentTools;
-    /**
-     * Loads file contents and environment details from the codebolt API.
-     * Internal method called during build.
-     */
-    private loadEnvironmentDetails;
-    /**
-     * Adds system prompt from a YAML file.
-     *
-     * @param filepath - Path to the YAML file containing system prompts
-     * @param key - Key identifier for the specific prompt
-     * @param exampleFilePath - Optional path to example file to append
-     * @returns The PromptBuilder instance for chaining
-     */
-    addSystemPrompt(filepath: string, key: string, exampleFilePath?: string): this;
-    /**
-     * Adds task instruction from a YAML file.
-     *
-     * @param filepath - Path to the YAML file containing task instructions
-     * @param refsection - Section name within the YAML file
-     * @returns The PromptBuilder instance for chaining
-     */
-    addTaskInstruction(filepath: string, refsection: string): this;
-    /**
-     * Manually adds environment details with file listing.
-     * Use addEnvironmentDetails() for automatic loading instead.
-     *
-     * @param projectPath - The project path
-     * @param fileListResult - The file listing result
-     * @returns The PromptBuilder instance for chaining
-     */
-    setEnvironmentDetails(projectPath: string, fileListResult: string): this;
-    /**
-     * Adds MCP tools information to the prompt.
-     * Only adds content if there are mentioned MCPs.
-     *
-     * @returns The PromptBuilder instance for chaining
-     */
-    addMCPToolsToPrompt(): this;
-    /**
-     * Adds agent information to the prompt.
-     * Only adds content if there are mentioned agents.
-     *
-     * @returns The PromptBuilder instance for chaining
-     */
-    addAgentsToPrompt(): this;
-    /**
-     * Manually sets the available tools for the conversation.
-     * Use addMCPTools() and addAgentTools() for automatic loading instead.
-     *
-     * @param tools - Array of OpenAI tools
-     * @returns The PromptBuilder instance for chaining
-     */
-    setTools(tools: OpenAITool[]): this;
-    /**
-     * Adds additional tools to the existing tool list.
-     *
-     * @param tools - Array of OpenAI tools to add
-     * @returns The PromptBuilder instance for chaining
-     */
-    addTools(tools: OpenAITool[]): this;
-    /**
-     * Builds the user message content with files (without environment details).
-     *
-     * @returns Array of content blocks
-     */
-    private buildUserMessageContent;
-    /**
-     * Builds the OpenAI conversation format.
-     *
-     * @returns Array of OpenAI messages
-     */
-    buildOpenAIMessages(): OpenAIMessage[];
-    /**
-     * Gets the available tools in OpenAI format.
-     *
-     * @returns Array of OpenAI tools
-     */
-    getTools(): OpenAITool[];
-    /**
-     * Gets the loaded file contents.
-     *
-     * @returns Map of file paths to their contents
-     */
-    getFileContents(): Map<string, string>;
-    /**
-     * Adds a message to the conversation history.
-     *
-     * @param role - The role of the message sender
-     * @param content - The content of the message
-     * @param toolCallId - Optional tool call ID for tool messages
-     * @param toolCalls - Optional tool calls for assistant messages
-     * @returns The PromptBuilder instance for chaining
-     */
-    addToConversationHistory(role: 'user' | 'assistant' | 'tool', content: string | Array<{
-        type: string;
-        text: string;
-    }>, toolCallId?: string, toolCalls?: any[]): this;
-    /**
-     * Gets the current conversation history.
-     *
-     * @returns Array of conversation entries
-     */
-    getConversationHistory(): ConversationEntry[];
-    /**
-     * Adds an LLM response to the conversation history.
-     * This method processes the LLM response and adds the assistant's message to the conversation.
-     * It handles both resolved responses and promises that resolve to responses.
-     *
-     * @param llmResponse - The LLM response (can be a promise or resolved response)
-     * @returns The PromptBuilder instance for chaining
-     *
-     * @example
-     * ```typescript
-     * // Example of using addLLMResponse in an agent workflow loop
-     * import { PromptBuilder } from './promptbuilder';
-     * import llm from '../modules/llm';
-     *
-     * async function agentWorkflowWithLLMResponse(userMessage: any, codebolt: CodeboltAPI) {
-     *     // Step 1: Build initial prompt
-     *     const promptBuilder = new PromptBuilder(userMessage, codebolt);
-     *     let currentPrompt = await promptBuilder
-     *         .addMCPTools()
-     *         .addAgentTools()
-     *         .addEnvironmentDetails()
-     *         .buildInferenceParams();
-     *
-     *     let completed = false;
-     *     let maxTurns = 20;
-     *     let turn = 0;
-     *
-     *     // Step 2: Main conversation loop (similar to agent.ts while loop)
-     *     while (!completed && turn < maxTurns) {
-     *         // Get LLM response
-     *         const llmResponse = llm.inference(currentPrompt);
-     *
-     *         // Add LLM response to conversation history
-     *         await promptBuilder.addLLMResponse(llmResponse);
-     *
-     *         // Process the response using LLMOutputHandler
-     *         const outputHandler = new LLMOutputHandler(llmResponse, codebolt);
-     *         await outputHandler.sendMessageToUser();
-     *
-     *         // Check if task is completed
-     *         if (outputHandler.isCompleted()) {
-     *             completed = true;
-     *             break;
-     *         }
-     *
-     *         // Execute tools and get results
-     *         const toolResults = await outputHandler.runTools();
-     *
-     *         // Add tool results to conversation
-     *         if (toolResults.length > 0) {
-     *             promptBuilder.addToolResults(toolResults);
-     *         } else {
-     *             // Add default continuation message when no tools executed
-     *             promptBuilder.addDefaultContinuationMessage();
-     *         }
-     *
-     *         // Build next prompt for the loop
-     *         currentPrompt = await promptBuilder.buildInferenceParams();
-     *         turn++;
-     *     }
-     * }
-     * ```
-     */
-    addLLMResponse(llmResponse: Promise<{
-        completion: any;
-    }> | {
-        completion: any;
-    }): Promise<this>;
-    /**
-     * Adds tool results to the conversation history.
-     * This method is typically used after executing tools from an LLM response.
-     *
-     * @param toolResults - Array of tool results to add to the conversation
-     * @returns The PromptBuilder instance for chaining
-     */
-    addToolResults(toolResults: ToolResult[]): this;
-    /**
-     * Adds a user message to the conversation history.
-     * Useful for adding follow-up questions or additional context during the conversation.
-     *
-     * @param message - The user message to add
-     * @returns The PromptBuilder instance for chaining
-     */
-    addUserMessage(message: string | Array<{
-        type: string;
-        text: string;
-    }>): this;
-    /**
-     * Adds a default continuation message when no tools were executed.
-     * This is used in the agent workflow to prompt the LLM to either complete the task
-     * or ask for more information.
-     *
-     * @returns The PromptBuilder instance for chaining
-     */
-    addDefaultContinuationMessage(): this;
-    /**
-     * Adds a custom text section to the prompt.
-     *
-     * @param title - Optional title for the section
-     * @param content - The content to add
-     * @returns The PromptBuilder instance for chaining
-     */
-    addCustomSection(title: string, content: string): this;
-    /**
-     * Adds a system instruction to the prompt.
-     *
-     * @param instruction - The system instruction to add
-     * @returns The PromptBuilder instance for chaining
-     */
-    addSystemInstruction(instruction: string): this;
-    /**
-     * Adds context information to the prompt.
-     *
-     * @param context - The context information to add
-     * @returns The PromptBuilder instance for chaining
-     */
-    addContext(context: string): this;
-    /**
-     * Builds and returns the OpenAI message format with tools.
-     * This method performs all async operations that were marked during setup.
-     *
-     * @returns Object with messages, tools, and other LLM parameters
-     */
-    build(): Promise<{
-        messages: OpenAIMessage[];
-        tools: OpenAITool[];
-        full: boolean;
-        max_tokens: number;
-        tool_choice: "auto";
-    }>;
-    /**
-     * Gets the current prompt parts without building the final string.
-     * Useful for debugging or inspection.
-     *
-     * @returns Array of current prompt parts
-     */
-    getPromptParts(): string[];
-    /**
-     * Clears all prompt parts except the initial message.
-     * Useful for starting over with the same message.
-     *
-     * @returns The PromptBuilder instance for chaining
-     */
-    reset(): this;
-    /**
-     * Creates an LLM inference parameters object in the format expected by the sample code.
-     * This method performs all async operations that were marked during setup.
-     *
-     * @returns Object with messages, tools, and other LLM parameters
-     */
-    buildInferenceParams(): Promise<{
-        full: boolean;
-        messages: OpenAIMessage[];
-        tools: OpenAITool[];
-        tool_choice: "auto";
-    }>;
-    /**
-     * Creates a minimal LLM inference parameters object with only the user message.
-     * This is useful for simple completions or when no tools/context are needed.
-     *
-     * @returns Object with messages (user only), no tools, and default tool_choice
-     */
-    buildDefaultInferenceParams(): {
-        full: boolean;
-        messages: string[];
-        tools: never[];
-        tool_choice: "auto";
-    };
-    /**
-     * Checks if the last LLM response indicates task completion.
-     * This method examines the conversation history for completion signals.
-     *
-     * @returns Boolean indicating if the task appears to be completed
-     */
-    isTaskCompleted(): boolean;
-    /**
-     * Gets the current conversation length (number of messages).
-     * Useful for determining when to summarize the conversation.
-     *
-     * @returns Number of messages in the conversation history
-     */
-    getConversationLength(): number;
-    /**
-     * Checks if the conversation should be summarized based on length.
-     *
-     * @param maxLength - Maximum conversation length before summarization (default: 50)
-     * @returns Boolean indicating if summarization is needed
-     */
-    shouldSummarizeConversation(maxLength?: number): boolean;
-}
-export { InitialPromptBuilder, MCPTool, Agent, InitialUserMessage, OpenAIMessage, OpenAITool, ConversationEntry, CodeboltAPI };