@codingame/monaco-vscode-api 37.0.0 → 37.2.0

package/vscode/src/vs/workbench/contrib/chat/common/tools/builtinTools/askQuestionsTool.js

@@ -1,600 +0,0 @@
-
-import { __decorate, __param } from '../../../../../../../../../external/tslib/tslib.es6.js';
-import { CancellationError } from '../../../../../../base/common/errors.js';
-import { MarkdownString } from '../../../../../../base/common/htmlContent.js';
-import { Disposable } from '../../../../../../base/common/lifecycle.js';
-import { hasKey } from '../../../../../../base/common/types.js';
-import { generateUuid } from '../../../../../../base/common/uuid.js';
-import { localize } from '../../../../../../nls.js';
-import { IChatToolInvocation } from '../../chatService/chatService.js';
-import { IChatService } from '../../chatService/chatService.service.js';
-import { ChatQuestionCarouselData } from '../../model/chatProgressTypes/chatQuestionCarouselData.js';
-import { ChatPermissionLevel, ChatConfiguration } from '../../constants.js';
-import { IConfigurationService } from '../../../../../../platform/configuration/common/configuration.service.js';
-import { StopWatch } from '../../../../../../base/common/stopwatch.js';
-import { ILogService } from '../../../../../../platform/log/common/log.service.js';
-import { ITelemetryService } from '../../../../../../platform/telemetry/common/telemetry.service.js';
-import { ToolDataSource } from '../languageModelToolsService.js';
-import { ThemeIcon } from '../../../../../../base/common/themables.js';
-import { Codicon } from '../../../../../../base/common/codicons.js';
-import { raceCancellation } from '../../../../../../base/common/async.js';
-import { TerminalToolId } from '../terminalToolIds.js';
-
-const AUTOPILOT_ASK_USER_RESPONSE = "The user is not available to respond and will review your work later. Work autonomously and make good decisions.";
-const AskQuestionsToolId = "vscode_askQuestions";
-const SoftLimits = {
-    header: 50,
-    question: 200
-};
-const HardLimits = {
-    header: 75
-};
-function truncateToLimit(value, limit) {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value.length > limit) {
-        return value.slice(0, limit - 3) + "...";
-    }
-    return value;
-}
-function createAskQuestionsToolData() {
-    const questionSchema = {
-        type: "object",
-        properties: {
-            header: {
-                type: "string",
-                description: `Short identifier for the question. Must be unique so answers can be mapped back to the question. Maximum ${SoftLimits.header} characters.`,
-                maxLength: SoftLimits.header
-            },
-            question: {
-                type: "string",
-                description: `The question text to display to the user. Keep it concise, ideally one sentence. Maximum ${SoftLimits.question} characters.`,
-                maxLength: SoftLimits.question
-            },
-            multiSelect: {
-                type: "boolean",
-                description: "Allow selecting multiple options when options are provided."
-            },
-            allowFreeformInput: {
-                type: "boolean",
-                description: "Allow freeform text answers in addition to option selection. Defaults to true; set to false to restrict to predefined options only."
-            },
-            message: {
-                type: "string",
-                description: "Optional markdown message to display below the question text, providing additional context or details."
-            },
-            options: {
-                type: "array",
-                description: "Optional list of selectable answers. If omitted, the question is free text.",
-                items: {
-                    type: "object",
-                    properties: {
-                        label: {
-                            type: "string",
-                            description: "Display label and value for the option."
-                        },
-                        description: {
-                            type: "string",
-                            description: "Optional secondary text shown with the option."
-                        },
-                        recommended: {
-                            type: "boolean",
-                            description: "Mark this option as the recommended default."
-                        }
-                    },
-                    required: ["label"]
-                }
-            }
-        },
-        required: ["header", "question"]
-    };
-    const inputSchema = {
-        type: "object",
-        properties: {
-            questions: {
-                type: "array",
-                description: "List of questions to ask the user. Order is preserved.",
-                items: questionSchema,
-                minItems: 1
-            }
-        },
-        required: ["questions"]
-    };
-    return {
-        id: AskQuestionsToolId,
-        toolReferenceName: "askQuestions",
-        legacyToolReferenceFullNames: [AskQuestionsToolId, "vscode/askQuestions"],
-        canBeReferencedInPrompt: false,
-        icon: ThemeIcon.fromId(Codicon.question.id),
-        displayName: ( localize(10672, "Ask Clarifying Questions")),
-        userDescription: ( localize(
-            10673,
-            "Ask structured clarifying questions using single select, multi-select, or freeform inputs to collect task requirements before proceeding."
-        )),
-        modelDescription: "Use this tool to ask the user a small number of clarifying questions before proceeding. Provide the questions array with concise headers and prompts. Use options for fixed choices, set multiSelect when multiple selections are allowed. Users can always provide a freeform text answer alongside options unless you set allowFreeformInput to false.",
-        source: ToolDataSource.Internal,
-        inputSchema
-    };
-}
-const AskQuestionsToolData = createAskQuestionsToolData();
-let AskQuestionsTool = class AskQuestionsTool extends Disposable {
-    constructor(chatService, telemetryService, logService, configService) {
-        super();
-        this.chatService = chatService;
-        this.telemetryService = telemetryService;
-        this.logService = logService;
-        this.configService = configService;
-    }
-    async invoke(invocation, _countTokens, progress, token) {
-        const stopWatch = StopWatch.create(true);
-        const parameters = invocation.parameters;
-        const {
-            questions
-        } = parameters;
-        this.logService.trace(`[AskQuestionsTool] Invoking with ${questions?.length ?? 0} question(s)`);
-        if (!questions || questions.length === 0) {
-            throw ( new Error(( localize(
-                10674,
-                "No questions provided. The questions array must contain at least one question."
-            ))));
-        }
-        const chatSessionResource = invocation.context?.sessionResource;
-        const chatRequestId = invocation.chatRequestId;
-        const {
-            request,
-            sessionResource
-        } = this.getRequest(chatSessionResource, chatRequestId);
-        if (!sessionResource || !request) {
-            this.logService.warn(
-                "[AskQuestionsTool] Missing chat context; marking all questions as skipped."
-            );
-            return this.createSkippedResult(questions);
-        }
-        const resolveId = invocation.chatStreamToolCallId ?? invocation.callId;
-        if (request.modeInfo?.permissionLevel === ChatPermissionLevel.Autopilot || this.configService.getValue(ChatConfiguration.AutoReply)) {
-            const reason = request.modeInfo?.permissionLevel === ChatPermissionLevel.Autopilot ? "Autopilot mode" : "Auto-reply enabled";
-            this.logService.info(`[AskQuestionsTool] ${reason}: auto-responding to questions`);
-            const {
-                carousel,
-                idToHeaderMap
-            } = this.toQuestionCarousel(questions, resolveId);
-            carousel.terminalId = this.extractTerminalId(request);
-            carousel.data = this.buildAutopilotCarouselAnswers(questions, carousel, idToHeaderMap);
-            carousel.isUsed = true;
-            this.chatService.appendProgress(request, carousel);
-            return this.createAutopilotResult(questions);
-        }
-        const {
-            carousel,
-            idToHeaderMap
-        } = this.toQuestionCarousel(questions, resolveId);
-        carousel.terminalId = this.extractTerminalId(request);
-        this.logService.trace(
-            `[AskQuestionsTool] request=${request.id} terminalExecutionId=${request.terminalExecutionId ?? "undefined"} carousel.terminalId=${carousel.terminalId ?? "undefined"}`
-        );
-        this.chatService.appendProgress(request, carousel);
-        const externalAnswerListener = this.chatService.onDidReceiveQuestionCarouselAnswer(event => {
-            if (event.resolveId !== carousel.resolveId || carousel.isUsed) {
-                return;
-            }
-            carousel.dismiss(event.answers);
-        });
-        let answerResult;
-        try {
-            answerResult = await raceCancellation(carousel.completion.p, token);
-        } catch (error) {
-            if (error instanceof CancellationError) {
-                carousel.dismiss(undefined);
-            }
-            throw error;
-        } finally {
-            externalAnswerListener.dispose();
-        }
-        if (!answerResult) {
-            carousel.dismiss(undefined);
-            throw ( new CancellationError());
-        }
-        if (token.isCancellationRequested) {
-            throw ( new CancellationError());
-        }
-        if (carousel.dismissedByTerminalInput && carousel.terminalId) {
-            this.logService.info(
-                `[AskQuestionsTool] Carousel dismissed because user typed directly in terminal ${carousel.terminalId}`
-            );
-            return {
-                content: [{
-                    kind: "text",
-                    value: `The user is replying to the terminal prompts directly. Do not ask more questions or send input to the terminal. You will be automatically notified when the command in terminal ${carousel.terminalId} completes.`
-                }]
-            };
-        }
-        progress.report({
-            message: ( localize(10675, "Analyzing your answers..."))
-        });
-        const converted = this.convertCarouselAnswers(questions, answerResult?.answers, idToHeaderMap);
-        const {
-            answeredCount,
-            skippedCount,
-            freeTextCount,
-            recommendedAvailableCount,
-            recommendedSelectedCount
-        } = this.collectMetrics(questions, converted);
-        this.sendTelemetry(
-            invocation.chatRequestId,
-            questions.length,
-            answeredCount,
-            skippedCount,
-            freeTextCount,
-            recommendedAvailableCount,
-            recommendedSelectedCount,
-            stopWatch.elapsed()
-        );
-        const toolResultJson = JSON.stringify(converted);
-        this.logService.trace(
-            `[AskQuestionsTool] Returning tool result with metrics: questions=${questions.length}, answered=${answeredCount}, skipped=${skippedCount}, freeText=${freeTextCount}, recommendedAvailable=${recommendedAvailableCount}, recommendedSelected=${recommendedSelectedCount}`
-        );
-        return {
-            content: [{
-                kind: "text",
-                value: toolResultJson
-            }]
-        };
-    }
-    async prepareToolInvocation(context, _token) {
-        const parameters = context.parameters;
-        const {
-            questions
-        } = parameters;
-        if (!questions || questions.length === 0) {
-            throw ( new Error(( localize(
-                10674,
-                "No questions provided. The questions array must contain at least one question."
-            ))));
-        }
-        for (const question of questions) {
-            if (question.options && question.options.length === 1 && !question.allowFreeformInput) {
-                throw ( new Error(( localize(
-                    10676,
-                    "Question \"{0}\" must have at least two options, or set allowFreeformInput when providing a single option, or omit options for free text input.",
-                    question.header
-                ))));
-            }
-        }
-        const questionCount = questions.length;
-        const headers = ( questions.map(q => q.header)).join(", ");
-        const message = questionCount === 1 ? ( localize(10677, "Asking a question ({0})", headers)) : ( localize(10678, "Asking {0} questions ({1})", questionCount, headers));
-        const pastMessage = questionCount === 1 ? ( localize(10679, "Asked a question ({0})", headers)) : ( localize(10680, "Asked {0} questions ({1})", questionCount, headers));
-        return {
-            invocationMessage: ( new MarkdownString(message)),
-            pastTenseMessage: ( new MarkdownString(pastMessage))
-        };
-    }
-    getRequest(chatSessionResource, chatRequestId) {
-        if (!chatSessionResource) {
-            return {
-                request: undefined,
-                sessionResource: undefined
-            };
-        }
-        const model = this.chatService.getSession(chatSessionResource);
-        let request;
-        if (model) {
-            if (chatRequestId) {
-                request = model.getRequests().find(r => r.id === chatRequestId);
-            }
-            if (!request) {
-                request = model.getRequests().at(-1);
-            }
-        }
-        if (!request) {
-            return {
-                request: undefined,
-                sessionResource: chatSessionResource
-            };
-        }
-        return {
-            request,
-            sessionResource: chatSessionResource
-        };
-    }
-    extractTerminalId(request) {
-        if (request.terminalExecutionId) {
-            return request.terminalExecutionId;
-        }
-        const match = request.message.text.match(/\[Terminal (?<termId>\S+) notification:/);
-        if (match?.groups?.termId) {
-            return match.groups.termId;
-        }
-        const response = request.response;
-        if (response) {
-            const parts = response.response.value;
-            for (let i = parts.length - 1; i >= 0; i--) {
-                const part = parts[i];
-                if (part.kind === "toolInvocation" && part.toolId === TerminalToolId.RunInTerminal) {
-                    const state = part.state.get();
-                    if (state.type === IChatToolInvocation.StateKind.Completed && state.contentForModel) {
-                        for (const item of state.contentForModel) {
-                            if (item.kind === "text") {
-                                const idMatch = item.value.match(
-                                    /(?:running in terminal ID|may still be running in terminal ID) ([0-9a-fA-F-]+)/
-                                );
-                                if (idMatch) {
-                                    return idMatch[1];
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return undefined;
-    }
-    toQuestionCarousel(questions, resolveId) {
-        const idToHeaderMap = ( new Map());
-        const carouselResolveId = resolveId ?? generateUuid();
-        const mappedQuestions = ( questions.map(
-            (question, index) => this.toChatQuestion(question, idToHeaderMap, carouselResolveId, index)
-        ));
-        return {
-            carousel: ( new ChatQuestionCarouselData(mappedQuestions, true, carouselResolveId)),
-            idToHeaderMap
-        };
-    }
-    toChatQuestion(question, idToHeaderMap, resolveId, index) {
-        let type;
-        if (!question.options || question.options.length === 0) {
-            type = "text";
-        } else if (question.multiSelect) {
-            type = "multiSelect";
-        } else {
-            type = "singleSelect";
-        }
-        let defaultValue;
-        if (question.options) {
-            const recommendedOptions = question.options.filter(opt => opt.recommended);
-            if (recommendedOptions.length > 0) {
-                defaultValue = question.multiSelect ? ( recommendedOptions.map(opt => opt.label)) : recommendedOptions[0].label;
-            }
-        }
-        const internalId = `${resolveId}:${index}`;
-        idToHeaderMap.set(internalId, question.header);
-        const displayTitle = truncateToLimit(question.header, HardLimits.header) ?? question.header;
-        return {
-            id: internalId,
-            type,
-            title: displayTitle,
-            message: question.question,
-            detailedMessage: question.message,
-            options: question.options?.map(opt => ({
-                id: opt.label,
-                label: opt.description ? `${opt.label} - ${opt.description}` : opt.label,
-                value: opt.label
-            })),
-            defaultValue,
-            allowFreeformInput: question.allowFreeformInput ?? true
-        };
-    }
-    convertCarouselAnswers(questions, carouselAnswers, idToHeaderMap) {
-        const result = {
-            answers: {}
-        };
-        if (carouselAnswers) {
-            this.logService.trace(`[AskQuestionsTool] Carousel answer keys: ${( Object.keys(carouselAnswers)).join(", ")}`);
-            this.logService.trace(`[AskQuestionsTool] Question headers: ${( questions.map(q => q.header)).join(", ")}`);
-        }
-        const headerToIdMap = ( new Map());
-        for (const [internalId, originalHeader] of idToHeaderMap) {
-            headerToIdMap.set(originalHeader, internalId);
-        }
-        for (const question of questions) {
-            if (!carouselAnswers) {
-                result.answers[question.header] = {
-                    selected: [],
-                    freeText: null,
-                    skipped: true
-                };
-                continue;
-            }
-            const internalId = headerToIdMap.get(question.header);
-            const answer = internalId ? carouselAnswers[internalId] : undefined;
-            this.logService.trace(
-                `[AskQuestionsTool] Processing question "${question.header}" (internal ID: ${internalId}), raw answer: ${JSON.stringify(answer)}, type: ${typeof answer}`
-            );
-            if (answer === undefined) {
-                result.answers[question.header] = {
-                    selected: [],
-                    freeText: null,
-                    skipped: true
-                };
-            } else if (typeof answer === "string") {
-                if (question.options?.some(opt => opt.label === answer)) {
-                    result.answers[question.header] = {
-                        selected: [answer],
-                        freeText: null,
-                        skipped: false
-                    };
-                } else {
-                    result.answers[question.header] = {
-                        selected: [],
-                        freeText: answer,
-                        skipped: false
-                    };
-                }
-            } else if (Array.isArray(answer)) {
-                result.answers[question.header] = {
-                    selected: ( answer.map(a => String(a))),
-                    freeText: null,
-                    skipped: false
-                };
-            } else if (typeof answer === "object" && hasKey(answer, {
-                selectedValues: true
-            })) {
-                const {
-                    selectedValues,
-                    freeformValue
-                } = answer;
-                result.answers[question.header] = {
-                    selected: selectedValues,
-                    freeText: freeformValue ?? null,
-                    skipped: false
-                };
-            } else if (typeof answer === "object" && (hasKey(answer, {
-                selectedValue: true
-            }) || hasKey(answer, {
-                freeformValue: true
-            }))) {
-                const {
-                    selectedValue,
-                    freeformValue
-                } = answer;
-                if (freeformValue) {
-                    result.answers[question.header] = {
-                        selected: [],
-                        freeText: freeformValue,
-                        skipped: false
-                    };
-                } else if (selectedValue !== undefined) {
-                    if (question.options?.some(opt => opt.label === selectedValue)) {
-                        result.answers[question.header] = {
-                            selected: [selectedValue],
-                            freeText: null,
-                            skipped: false
-                        };
-                    } else {
-                        result.answers[question.header] = {
-                            selected: [],
-                            freeText: selectedValue,
-                            skipped: false
-                        };
-                    }
-                } else {
-                    result.answers[question.header] = {
-                        selected: [],
-                        freeText: null,
-                        skipped: true
-                    };
-                }
-            } else {
-                this.logService.warn(
-                    `[AskQuestionsTool] Unknown answer format for "${question.header}": ${JSON.stringify(answer)}`
-                );
-                result.answers[question.header] = {
-                    selected: [],
-                    freeText: null,
-                    skipped: true
-                };
-            }
-        }
-        return result;
-    }
-    collectMetrics(questions, result) {
-        const answers = ( Object.values(result.answers));
-        const answeredCount = answers.filter(a => !a.skipped).length;
-        const skippedCount = answers.filter(a => a.skipped).length;
-        const freeTextCount = answers.filter(a => a.freeText !== null).length;
-        const recommendedAvailableCount = questions.filter(q => q.options?.some(opt => opt.recommended)).length;
-        const recommendedSelectedCount = questions.filter(q => {
-            const answer = result.answers[q.header];
-            const recommendedOption = q.options?.find(opt => opt.recommended);
-            return answer && !answer.skipped && recommendedOption && answer.selected.includes(recommendedOption.label);
-        }).length;
-        return {
-            answeredCount,
-            skippedCount,
-            freeTextCount,
-            recommendedAvailableCount,
-            recommendedSelectedCount
-        };
-    }
-    createSkippedResult(questions) {
-        const skippedAnswers = {};
-        for (const question of questions) {
-            skippedAnswers[question.header] = {
-                selected: [],
-                freeText: null,
-                skipped: true
-            };
-        }
-        return {
-            content: [{
-                kind: "text",
-                value: JSON.stringify({
-                    answers: skippedAnswers
-                })
-            }]
-        };
-    }
-    createAutopilotResult(questions) {
-        const answers = {};
-        for (const question of questions) {
-            answers[question.header] = {
-                selected: [],
-                freeText: AUTOPILOT_ASK_USER_RESPONSE,
-                skipped: false
-            };
-        }
-        return {
-            content: [{
-                kind: "text",
-                value: JSON.stringify({
-                    answers
-                })
-            }]
-        };
-    }
-    buildAutopilotCarouselAnswers(questions, carousel, idToHeaderMap) {
-        const data = {};
-        const headerToIdMap = ( new Map());
-        for (const [internalId, originalHeader] of idToHeaderMap) {
-            headerToIdMap.set(originalHeader, internalId);
-        }
-        for (const question of questions) {
-            const internalId = headerToIdMap.get(question.header);
-            if (!internalId) {
-                continue;
-            }
-            const chatQuestion = carousel.questions.find(q => q.id === internalId);
-            if (!chatQuestion) {
-                continue;
-            }
-            if (chatQuestion.type === "multiSelect") {
-                data[internalId] = {
-                    selectedValues: [],
-                    freeformValue: AUTOPILOT_ASK_USER_RESPONSE
-                };
-            } else if (chatQuestion.type === "singleSelect") {
-                data[internalId] = {
-                    freeformValue: AUTOPILOT_ASK_USER_RESPONSE
-                };
-            } else {
-                data[internalId] = AUTOPILOT_ASK_USER_RESPONSE;
-            }
-        }
-        return data;
-    }
-    sendTelemetry(
-        requestId,
-        questionCount,
-        answeredCount,
-        skippedCount,
-        freeTextCount,
-        recommendedAvailableCount,
-        recommendedSelectedCount,
-        duration
-    ) {
-        this.telemetryService.publicLog2("askQuestionsToolInvoked", {
-            requestId,
-            questionCount,
-            answeredCount,
-            skippedCount,
-            freeTextCount,
-            recommendedAvailableCount,
-            recommendedSelectedCount,
-            duration
-        });
-    }
-};
-AskQuestionsTool = ( __decorate([( __param(0, IChatService)), ( __param(1, ITelemetryService)), ( __param(2, ILogService)), ( __param(3, IConfigurationService))], AskQuestionsTool));
-
-export { AUTOPILOT_ASK_USER_RESPONSE, AskQuestionsTool, AskQuestionsToolData, AskQuestionsToolId, createAskQuestionsToolData };

package/vscode/src/vs/workbench/contrib/chat/common/tools/builtinTools/confirmationTool.d.ts

@@ -1,36 +0,0 @@
-import { CancellationToken } from "../../../../../../base/common/cancellation.js";
-import { CountTokensCallback, IPreparedToolInvocation, IToolData, IToolImpl, IToolInvocation, IToolInvocationPreparationContext, IToolResult, ToolProgress } from "../languageModelToolsService.js";
-export declare const ConfirmationToolId = "vscode_get_confirmation";
-export declare const ConfirmationToolWithOptionsId = "vscode_get_confirmation_with_options";
-export declare const ModifiedFilesConfirmationToolId = "vscode_get_modified_files_confirmation";
-export declare const ConfirmationToolData: IToolData;
-export declare const ConfirmationToolWithOptionsData: IToolData;
-export declare const ModifiedFilesConfirmationToolData: IToolData;
-export interface IConfirmationToolParams {
-    title: string;
-    message: string;
-    confirmationType?: "basic" | "terminal";
-    terminalCommand?: string;
-    buttons?: string[];
-}
-export interface IModifiedFilesConfirmationToolParams {
-    title: string;
-    message: string;
-    options: string[];
-    modifiedFiles: {
-        uri: string;
-        originalUri?: string;
-        insertions?: number;
-        deletions?: number;
-        title?: string;
-        description?: string;
-    }[];
-}
-export declare class ConfirmationTool implements IToolImpl {
-    prepareToolInvocation(context: IToolInvocationPreparationContext, token: CancellationToken): Promise<IPreparedToolInvocation | undefined>;
-    invoke(invocation: IToolInvocation, countTokens: CountTokensCallback, progress: ToolProgress, token: CancellationToken): Promise<IToolResult>;
-}
-export declare class ModifiedFilesConfirmationTool implements IToolImpl {
-    prepareToolInvocation(context: IToolInvocationPreparationContext, token: CancellationToken): Promise<IPreparedToolInvocation | undefined>;
-    invoke(invocation: IToolInvocation, countTokens: CountTokensCallback, progress: ToolProgress, token: CancellationToken): Promise<IToolResult>;
-}