@codingame/monaco-vscode-chat-service-override 26.2.2 → 27.0.0

package/vscode/src/vs/workbench/contrib/chat/browser/chatTipService.d.ts

@@ -1,26 +1,156 @@
-import { IProductService } from "@codingame/monaco-vscode-api/vscode/vs/platform/product/common/productService.service";
 import { MarkdownString } from "@codingame/monaco-vscode-api/vscode/vs/base/common/htmlContent";
+import { ContextKeyExpression } from "@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey";
 import { IContextKeyService } from "@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey.service";
+import { IInstantiationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/instantiation/common/instantiation";
+import { IProductService } from "@codingame/monaco-vscode-api/vscode/vs/platform/product/common/productService.service";
 import { IConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/configuration/common/configuration.service";
+import { Disposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
+import { ICommandService } from "@codingame/monaco-vscode-api/vscode/vs/platform/commands/common/commands.service";
+import { IStorageService } from "@codingame/monaco-vscode-api/vscode/vs/platform/storage/common/storage.service";
+import { AgentFileType } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/promptSyntax/service/promptsService";
+import { IPromptsService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/promptSyntax/service/promptsService.service";
+import { PromptsType } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/promptSyntax/promptTypes";
+import { ILogService } from "@codingame/monaco-vscode-api/vscode/vs/platform/log/common/log.service";
+import { ILanguageModelToolsService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/tools/languageModelToolsService.service";
+import { IChatService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/chatService/chatService.service";
+import { IChatEntitlementService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/chat/common/chatEntitlementService.service";
+import { ITelemetryService } from "@codingame/monaco-vscode-api/vscode/vs/platform/telemetry/common/telemetry.service";
 import { IChatTipService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/browser/chatTipService.service";
+export declare const ATTACH_FILES_REFERENCE_TRACKING_COMMAND = "chat.tips.attachFiles.referenceUsed";
+export declare const CREATE_AGENT_INSTRUCTIONS_TRACKING_COMMAND = "chat.tips.createAgentInstructions.commandUsed";
+export declare const CREATE_PROMPT_TRACKING_COMMAND = "chat.tips.createPrompt.commandUsed";
+export declare const CREATE_AGENT_TRACKING_COMMAND = "chat.tips.createAgent.commandUsed";
+export declare const CREATE_SKILL_TRACKING_COMMAND = "chat.tips.createSkill.commandUsed";
 export interface IChatTip {
     readonly id: string;
     readonly content: MarkdownString;
+    readonly enabledCommands?: readonly string[];
 }
-export declare class ChatTipService implements IChatTipService {
-    private readonly _productService;
-    private readonly _configurationService;
-    readonly _serviceBrand: undefined;
+export interface ITipDefinition {
+    readonly id: string;
+    readonly message: string;
+    /**
+     * When clause expression that determines if this tip is eligible to be shown.
+     * If undefined, the tip is always eligible.
+     */
+    readonly when?: ContextKeyExpression;
+    /**
+     * Command IDs that are allowed to be executed from this tip's markdown.
+     */
+    readonly enabledCommands?: string[];
+    /**
+     * Chat model IDs for which this tip is eligible.
+     * Compared against the lowercased `chatModelId` context key.
+     */
+    readonly onlyWhenModelIds?: readonly string[];
+    /**
+     * Command IDs that, if ever executed in this workspace, make this tip ineligible.
+     * The tip won't be shown if the user has already performed the action it suggests.
+     */
+    readonly excludeWhenCommandsExecuted?: string[];
+    /**
+     * Chat mode names that, if ever used in this workspace, make this tip ineligible.
+     * The tip won't be shown if the user has already used the mode it suggests.
+     * Matches against both mode kind (e.g. 'agent') and mode name (e.g. 'Plan').
+     */
+    readonly excludeWhenModesUsed?: string[];
+    /**
+     * Tool IDs that, if ever invoked in this workspace, make this tip ineligible.
+     * The tip won't be shown if the tool it describes has already been used.
+     */
+    readonly excludeWhenToolsInvoked?: string[];
     /**
-     * Timestamp when this service was instantiated.
-     * Used to only show tips for requests created after this time.
+     * If set, exclude this tip when prompt files of the specified type exist in the workspace.
      */
-    private readonly _createdAt;
+    readonly excludeWhenPromptFilesExist?: {
+        readonly promptType: PromptsType;
+        /** Also check for this specific agent instruction file type. */
+        readonly agentFileType?: AgentFileType;
+        /** If true, exclude the tip until the async file check completes. Default: false. */
+        readonly excludeUntilChecked?: boolean;
+    };
     /**
-     * Whether a tip has already been shown in this window session.
-     * Only one tip is shown per session.
+     * Setting keys that, if changed from their default value, make this tip ineligible.
+     * The tip won't be shown if the user has already customized the setting it describes.
      */
-    private _hasShownTip;
+    readonly excludeWhenSettingsChanged?: string[];
+    /**
+     * Command IDs that dismiss this tip when clicked from the tip markdown
+     * while the tip is currently shown.
+     */
+    readonly dismissWhenCommandsClicked?: string[];
+}
+/**
+ * Tracks user-level signals that determine whether certain tips should be
+ * excluded. Persists state to application storage and disposes listeners once all
+ * signals of interest have been observed.
+ */
+export declare class TipEligibilityTracker extends Disposable {
+    private readonly _storageService;
+    private readonly _promptsService;
+    private readonly _languageModelToolsService;
+    private readonly _logService;
+    private static readonly _COMMANDS_STORAGE_KEY;
+    private static readonly _MODES_STORAGE_KEY;
+    private static readonly _TOOLS_STORAGE_KEY;
+    private readonly _executedCommands;
+    private readonly _usedModes;
+    private readonly _invokedTools;
+    private readonly _pendingCommands;
+    private readonly _pendingModes;
+    private readonly _pendingTools;
+    private readonly _commandListener;
+    private readonly _toolListener;
+    /**
+     * Tip IDs excluded because prompt files of the required type exist in the workspace.
+     * Tips with `excludeUntilChecked` are pre-added and removed if no files are found.
+     */
+    private readonly _excludedByFiles;
+    /** Tips that have file-based exclusions, kept for re-checks. */
+    private readonly _tipsWithFileExclusions;
+    /** Generation counter per tip ID to discard stale async file-check results. */
+    private readonly _fileCheckGeneration;
+    private readonly _fileChecksInFlight;
+    constructor(tips: readonly ITipDefinition[], commandService: ICommandService, _storageService: IStorageService, _promptsService: IPromptsService, _languageModelToolsService: ILanguageModelToolsService, _logService: ILogService);
+    recordCommandExecuted(commandId: string): void;
+    /**
+     * Records the current chat mode (kind + name) so future tip eligibility
+     * checks can exclude mode-related tips. No-ops once all tracked modes
+     * have been observed.
+     */
+    recordCurrentMode(contextKeyService: IContextKeyService): void;
+    /**
+     * Returns `true` when the tip should be **excluded** from the eligible set.
+     */
+    isExcluded(tip: ITipDefinition): boolean;
+    /**
+     * Revalidates all file-based tip exclusions. Tips with `excludeUntilChecked`
+     * are conservatively hidden until the re-check completes.
+     */
+    refreshPromptFileExclusions(): void;
+    private _checkForPromptFiles;
+    private _doCheckForPromptFiles;
+    private _persistSet;
+    private _readApplicationWithProfileFallback;
+}
+export declare class ChatTipService extends Disposable implements IChatTipService {
+    private readonly _productService;
+    private readonly _configurationService;
+    private readonly _storageService;
+    private readonly _chatService;
+    private readonly _logService;
+    private readonly _chatEntitlementService;
+    private readonly _commandService;
+    private readonly _telemetryService;
+    readonly _serviceBrand: undefined;
+    private readonly _onDidDismissTip;
+    readonly onDidDismissTip: import("@codingame/monaco-vscode-api/vscode/vs/base/common/event").Event<void>;
+    private readonly _onDidNavigateTip;
+    readonly onDidNavigateTip: import("@codingame/monaco-vscode-api/vscode/vs/base/common/event").Event<IChatTip>;
+    private readonly _onDidHideTip;
+    readonly onDidHideTip: import("@codingame/monaco-vscode-api/vscode/vs/base/common/event").Event<void>;
+    private readonly _onDidDisableTips;
+    readonly onDidDisableTips: import("@codingame/monaco-vscode-api/vscode/vs/base/common/event").Event<void>;
     /**
      * The request ID that was assigned a tip (for stable rerenders).
      */
@@ -29,9 +159,48 @@ export declare class ChatTipService implements IChatTipService {
      * The tip that was shown (for stable rerenders).
      */
     private _shownTip;
-    constructor(_productService: IProductService, _configurationService: IConfigurationService);
-    getNextTip(requestId: string, requestTimestamp: number, contextKeyService: IContextKeyService): IChatTip | undefined;
+    /**
+     * The scoped context key service from the chat widget, stored when
+     * {@link getWelcomeTip} is first called so that navigation methods
+     * can evaluate when-clause eligibility against the correct context.
+     */
+    private _contextKeyService;
+    private static readonly _DISMISSED_TIP_KEY;
+    private static readonly _LAST_TIP_ID_KEY;
+    private static readonly _YOLO_EVER_ENABLED_KEY;
+    private static readonly _THINKING_PHRASES_EVER_MODIFIED_KEY;
+    private readonly _tracker;
+    private readonly _createSlashCommandsUsageTracker;
+    private _yoloModeEverEnabled;
+    private _thinkingPhrasesEverModified;
+    private readonly _tipCommandListener;
+    constructor(_productService: IProductService, _configurationService: IConfigurationService, _storageService: IStorageService, _chatService: IChatService, instantiationService: IInstantiationService, _logService: ILogService, _chatEntitlementService: IChatEntitlementService, _commandService: ICommandService, _telemetryService: ITelemetryService);
+    private _hasFileOrFolderReference;
+    private _getCreateSlashCommandTrackingId;
+    private _toCreateSlashCommandTrackingId;
+    resetSession(): void;
+    dismissTip(): void;
+    clearDismissedTips(): void;
+    private _getDismissedTipIds;
+    hideTip(): void;
+    disableTips(): Promise<void>;
+    getWelcomeTip(contextKeyService: IContextKeyService): IChatTip | undefined;
+    private _findNextEligibleTip;
+    private _pickTip;
+    navigateToNextTip(): IChatTip | undefined;
+    navigateToPreviousTip(): IChatTip | undefined;
+    hasMultipleTips(): boolean;
+    private _navigateTip;
+    private _hasNavigableTip;
+    private _getNavigableTip;
     private _isEligible;
+    private _isSettingModified;
+    private _getCurrentChatModelId;
+    private _isChatLocation;
+    private _isChatQuotaExceeded;
     private _isCopilotEnabled;
     private _createTip;
+    private _logTipTelemetry;
+    private _trackTipCommandClicks;
+    private _readApplicationWithProfileFallback;
 }