feat(types): add protocol for open file dialog for import image as context (#564)

* feat(types): add protocol for open file dialog

* feat(types): register open file dialog events

* feat(types): add drag and drop uiContract

Author: yzhangok

chat-client-ui-types/src/uiContracts.ts

@@ -8,6 +8,8 @@ import {
     GET_SERIALIZED_CHAT_REQUEST_METHOD,
     GetSerializedChatResult,
     ChatPrompt,
+    OpenFileDialogParams,
+    DropFilesParams,
 } from '@aws/language-server-runtimes-types'
 export { InsertToCursorPositionParams } from '@aws/language-server-runtimes-types'
 
@@ -30,7 +32,8 @@ export const DISCLAIMER_ACKNOWLEDGED = 'disclaimerAcknowledged'
 export const CHAT_PROMPT_OPTION_ACKNOWLEDGED = 'chatPromptOptionAcknowledged'
 export const STOP_CHAT_RESPONSE = 'stopChatResponse'
 export const OPEN_SETTINGS = 'openSettings'
-
+export const OPEN_FILE_DIALOG = 'openFileDialog'
+export const FILES_DROPPED = 'filesDropped'
 /**
  * A message sent from Chat Client to Extension in response to various actions triggered from Chat UI.
  */
@@ -51,6 +54,8 @@ export type UiMessageCommand =
     | typeof CHAT_PROMPT_OPTION_ACKNOWLEDGED
     | typeof STOP_CHAT_RESPONSE
     | typeof OPEN_SETTINGS
+    | typeof OPEN_FILE_DIALOG
+    | typeof FILES_DROPPED
 
 export type UiMessageParams =
     | InsertToCursorPositionParams
@@ -63,6 +68,8 @@ export type UiMessageParams =
     | ChatPromptOptionAcknowledgedParams
     | StopChatResponseParams
     | OpenSettingsParams
+    | OpenFileDialogParams
+    | DropFilesParams
 
 export interface SendToPromptParams {
     selection: string
@@ -159,6 +166,12 @@ export interface OpenSettingsParams {
     settingKey: string
 }
 
+export interface FilesDroppedParams {
+    tabId: string
+    insertPosition: number
+    files: string[]
+}
+
 /**
  * A message sent from Chat Client to Extension in response to request triggered from Extension.
  * As Chat Client uses PostMessage API for transport with integrating Extensions, this is a loose implementation of request-response model.

runtimes/protocol/chat.ts

@@ -85,6 +85,9 @@ import {
     PINNED_CONTEXT_REMOVE_NOTIFICATION_METHOD,
     ActiveEditorChangedParams,
     ACTIVE_EDITOR_CHANGED_NOTIFICATION_METHOD,
+    OPEN_FILE_DIALOG_METHOD,
+    OpenFileDialogParams,
+    OpenFileDialogResult,
 } from './lsp'
 
 export const chatRequestType = new AutoParameterStructuresProtocolRequestType<
@@ -94,6 +97,13 @@ export const chatRequestType = new AutoParameterStructuresProtocolRequestType<
     void,
     void
 >(CHAT_REQUEST_METHOD)
+export const openFileDialogRequestType = new AutoParameterStructuresProtocolRequestType<
+    OpenFileDialogParams,
+    OpenFileDialogResult,
+    OpenFileDialogResult,
+    void,
+    void
+>(OPEN_FILE_DIALOG_METHOD)
 export const inlineChatRequestType = new AutoParameterStructuresProtocolRequestType<
     InlineChatParams | EncryptedChatParams,
     InlineChatResult | string,

runtimes/protocol/window.ts

@@ -3,6 +3,9 @@ import {
     SHOW_SAVE_FILE_DIALOG_REQUEST_METHOD,
     ShowSaveFileDialogParams,
     ShowSaveFileDialogResult,
+    ShowOpenDialogResult,
+    ShowOpenDialogParams,
+    SHOW_OPEN_FILE_DIALOG_REQUEST_METHOD,
 } from './lsp'
 
 /**
@@ -16,3 +19,11 @@ export const ShowSaveFileDialogRequestType = new ProtocolRequestType<
     void,
     void
 >(SHOW_SAVE_FILE_DIALOG_REQUEST_METHOD)
+
+export const ShowOpenDialogRequestType = new ProtocolRequestType<
+    ShowOpenDialogParams,
+    ShowOpenDialogResult,
+    never,
+    void,
+    void
+>(SHOW_OPEN_FILE_DIALOG_REQUEST_METHOD)

runtimes/runtimes/base-runtime.ts

@@ -33,6 +33,7 @@ import {
     ShowMessageNotification,
     ShowMessageRequest,
     ShowDocumentRequest,
+    ShowOpenDialogRequestType,
     openTabRequestType,
     openFileDiffNotificationType,
     selectWorkspaceItemRequestType,
@@ -57,6 +58,7 @@ import {
     activeEditorChangedNotificationType,
     onPinnedContextAddNotificationType,
     onPinnedContextRemoveNotificationType,
+    openFileDialogRequestType,
 } from '../protocol'
 import { createConnection } from 'vscode-languageserver/browser'
 import {
@@ -190,6 +192,7 @@ export const baseRuntime = (connections: { reader: MessageReader; writer: Messag
         onTabBarAction: handler => lspConnection.onRequest(tabBarActionRequestType.method, handler),
         onPromptInputOptionChange: handler =>
             lspConnection.onNotification(promptInputOptionChangeNotificationType.method, handler),
+        onOpenFileDialog: handler => lspConnection.onRequest(openFileDialogRequestType.method, handler),
         onRuleClick: handler => lspConnection.onRequest(ruleClickRequestType.method, handler),
     }
 
@@ -258,6 +261,7 @@ export const baseRuntime = (connections: { reader: MessageReader; writer: Messag
                 showMessageRequest: params => lspConnection.sendRequest(ShowMessageRequest.method, params),
                 showDocument: params => lspConnection.sendRequest(ShowDocumentRequest.method, params),
                 showSaveFileDialog: params => lspConnection.sendRequest(ShowSaveFileDialogRequestType.method, params),
+                showOpenDialog: params => lspConnection.sendRequest(ShowOpenDialogRequestType.method, params),
             },
             publishDiagnostics: params => lspConnection.sendNotification(PublishDiagnosticsNotification.method, params),
             sendProgress: <P>(type: ProgressType<P>, token: ProgressToken, value: P) => {

runtimes/runtimes/chat/baseChat.ts

@@ -82,6 +82,9 @@ import {
     activeEditorChangedNotificationType,
     onPinnedContextAddNotificationType,
     onPinnedContextRemoveNotificationType,
+    OpenFileDialogParams,
+    OpenFileDialogResult,
+    openFileDialogRequestType,
 } from '../../protocol'
 import { Chat } from '../../server-interface'
 
@@ -92,6 +95,10 @@ export class BaseChat implements Chat {
         this.connection.onRequest(chatRequestType.method, handler)
     }
 
+    public onOpenFileDialog(handler: RequestHandler<OpenFileDialogParams, OpenFileDialogResult, OpenFileDialogResult>) {
+        this.connection.onRequest(openFileDialogRequestType.method, handler)
+    }
+
     public onInlineChatPrompt(
         handler: RequestHandler<InlineChatParams, InlineChatResult | null | undefined, InlineChatResult>
     ) {

runtimes/runtimes/standalone.ts

@@ -28,6 +28,8 @@ import {
     didWriteFileNotificationType,
     didAppendFileNotificationType,
     didCreateDirectoryNotificationType,
+    ShowOpenDialogParams,
+    ShowOpenDialogRequestType,
 } from '../protocol'
 import { ProposedFeatures, createConnection } from 'vscode-languageserver/node'
 import {
@@ -393,6 +395,8 @@ export const standalone = (props: RuntimeProps) => {
                     showDocument: params => lspConnection.sendRequest(ShowDocumentRequest.method, params),
                     showSaveFileDialog: (params: ShowSaveFileDialogParams) =>
                         lspConnection.sendRequest(ShowSaveFileDialogRequestType.method, params),
+                    showOpenDialog: (params: ShowOpenDialogParams) =>
+                        lspConnection.sendRequest(ShowOpenDialogRequestType.method, params),
                 },
                 publishDiagnostics: params =>
                     lspConnection.sendNotification(PublishDiagnosticsNotification.method, params),

runtimes/server-interface/chat.ts

@@ -41,6 +41,8 @@ import {
     ListMcpServersResult,
     McpServerClickResult,
     McpServerClickParams,
+    OpenFileDialogParams,
+    OpenFileDialogResult,
     RuleClickParams,
     ListRulesParams,
     ListRulesResult,
@@ -70,7 +72,9 @@ export type Chat = {
     getSerializedChat: (params: GetSerializedChatParams) => Promise<GetSerializedChatResult>
     onListRules: (handler: RequestHandler<ListRulesParams, ListRulesResult, void>) => void
     onRuleClick: (handler: RequestHandler<RuleClickParams, RuleClickResult, void>) => void
-
+    onOpenFileDialog: (
+        handler: RequestHandler<OpenFileDialogParams, OpenFileDialogResult, OpenFileDialogResult>
+    ) => void
     // Notifications
     onSendFeedback: (handler: NotificationHandler<FeedbackParams>) => void
     onReady: (handler: NotificationHandler<void>) => void

runtimes/server-interface/lsp.ts

@@ -59,6 +59,8 @@ import {
     SelectWorkspaceItemResult,
     ShowSaveFileDialogParams,
     ShowSaveFileDialogResult,
+    ShowOpenDialogParams,
+    ShowOpenDialogResult,
 } from '../protocol'
 
 // Re-export whole surface of LSP protocol used in Runtimes.
@@ -151,6 +153,7 @@ export type Lsp = {
         showMessageRequest: (params: ShowMessageRequestParams) => Promise<MessageActionItem | null>
         showDocument: (params: ShowDocumentParams) => Promise<ShowDocumentResult>
         showSaveFileDialog: (params: ShowSaveFileDialogParams) => Promise<ShowSaveFileDialogResult>
+        showOpenDialog: (params: ShowOpenDialogParams) => Promise<ShowOpenDialogResult>
     }
     extensions: {
         onInlineCompletionWithReferences: (

types/chat.ts

@@ -22,6 +22,7 @@ export const INLINE_CHAT_REQUEST_METHOD = 'aws/chat/sendInlineChatPrompt'
 export const TAB_BAR_ACTION_REQUEST_METHOD = 'aws/chat/tabBarAction'
 export const CHAT_OPTIONS_UPDATE_NOTIFICATION_METHOD = 'aws/chat/chatOptionsUpdate'
 export const PROMPT_INPUT_OPTION_CHANGE_METHOD = 'aws/chat/promptInputOptionChange'
+export const OPEN_FILE_DIALOG_METHOD = 'aws/chat/openFileDialog'
 // context
 export const CONTEXT_COMMAND_NOTIFICATION_METHOD = 'aws/chat/sendContextCommands'
 export const CREATE_PROMPT_NOTIFICATION_METHOD = 'aws/chat/createPrompt'
@@ -417,7 +418,7 @@ export interface ContextCommandGroup {
 export interface ContextCommand extends QuickActionCommand {
     id?: string
     route?: string[]
-    label?: 'file' | 'folder' | 'code'
+    label?: 'file' | 'folder' | 'code' | 'image'
     children?: ContextCommandGroup[]
 }
 
@@ -436,6 +437,27 @@ export interface CreatePromptParams {
     isRule?: boolean
 }
 
+export interface OpenFileDialogParams {
+    tabId: string
+    fileType: 'image' | ''
+    insertPosition: number
+}
+
+export interface OpenFileDialogResult {
+    tabId: string
+    fileType: 'image' | ''
+    filePaths: string[]
+    errorMessage?: string
+    insertPosition: number
+}
+
+export interface DropFilesParams {
+    tabId: string
+    files: FileList
+    insertPosition: number
+    errorMessage?: string
+}
+
 export interface ProgrammingLanguage {
     languageName: string
 }

types/window.ts

@@ -1,7 +1,7 @@
 import { URI } from 'vscode-languageserver-types'
 
 export const SHOW_SAVE_FILE_DIALOG_REQUEST_METHOD = 'aws/showSaveFileDialog'
-
+export const SHOW_OPEN_FILE_DIALOG_REQUEST_METHOD = 'aws/showOpenFileDialog'
 export interface ShowSaveFileDialogParams {
     // Using untyped string to avoid locking this too strictly.
     // TODO: Migrate to LanguageKind when it is released in 3.18.0
@@ -13,3 +13,17 @@ export interface ShowSaveFileDialogParams {
 export interface ShowSaveFileDialogResult {
     targetUri: URI
 }
+
+// bridge to consume ide's api
+export interface ShowOpenDialogParams {
+    canSelectFiles?: boolean
+    canSelectFolders?: boolean
+    canSelectMany?: boolean
+    filters?: { [key: string]: string[] }
+    defaultUri?: URI
+    title?: string
+}
+
+export interface ShowOpenDialogResult {
+    uris: URI[]
+}