From 8ac8247ca990f08335257edd496aa9d326dd02de Mon Sep 17 00:00:00 2001 From: Hannes Rudolph Date: Wed, 27 Aug 2025 18:10:38 -0600 Subject: [PATCH] chore(shared): dedupe WebviewMessage.type union; add WebviewMessagePayload alias; clarify ExtensionMessage header comment --- src/shared/ExtensionMessage.ts | 9 ++++++--- src/shared/WebviewMessage.ts | 6 +++--- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/shared/ExtensionMessage.ts b/src/shared/ExtensionMessage.ts index b90f62eaea..194fdcfbe0 100644 --- a/src/shared/ExtensionMessage.ts +++ b/src/shared/ExtensionMessage.ts @@ -57,9 +57,12 @@ export interface LanguageModelChatSelector { id?: string } -// Represents JSON data that is sent from extension to webview, called -// ExtensionMessage and has 'type' enum which can be 'plusButtonClicked' or -// 'settingsButtonClicked' or 'hello'. Webview will hold state. +/** + * Message sent from the VS Code extension to the webview UI. + * The 'type' union below enumerates outbound notifications and data updates + * (e.g., "state", "theme", "indexingStatusUpdate", "filesChanged") that the + * webview consumes to render and synchronize state. See the full union below. + */ export interface ExtensionMessage { type: | "action" diff --git a/src/shared/WebviewMessage.ts b/src/shared/WebviewMessage.ts index 76be88c666..54d17ed652 100644 --- a/src/shared/WebviewMessage.ts +++ b/src/shared/WebviewMessage.ts @@ -83,7 +83,6 @@ export interface WebviewMessage { | "allowedMaxRequests" | "allowedMaxCost" | "alwaysAllowSubtasks" - | "alwaysAllowUpdateTodoList" | "autoCondenseContext" | "autoCondenseContextPercent" | "condensingApiConfigId" @@ -186,7 +185,6 @@ export interface WebviewMessage { | "indexCleared" | "focusPanelRequest" | "profileThresholds" - | "setHistoryPreviewCollapsed" | "openExternal" | "filterMarketplaceItems" | "marketplaceButtonClicked" @@ -197,7 +195,6 @@ export interface WebviewMessage { | "marketplaceInstallResult" | "fetchMarketplaceData" | "switchTab" - | "profileThresholds" | "shareTaskSuccess" | "exportMode" | "exportModeResult" @@ -346,3 +343,6 @@ export type WebViewMessagePayload = | IndexClearedPayload | InstallMarketplaceItemWithParametersPayload | UpdateTodoListPayload + +// Alias for consistent naming (prefer 'Webview' spelling in new code) +export type WebviewMessagePayload = WebViewMessagePayload