diff --git a/README.md b/README.md index cf8e77be..c0c13d13 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,14 @@ Monorepo - [server-interface/](runtimes/server-interface) - server type definition to create language servers - [types/](types) - type definitions for the runtimes +## Artifacts + +This repo produces these NPM packages: + +- https://www.npmjs.com/package/@aws/chat-client-ui-types +- https://www.npmjs.com/package/@aws/language-server-runtimes +- https://www.npmjs.com/package/@aws/language-server-runtimes-types + ## Contributing - [How to contribute](CONTRIBUTING.md#contributing) diff --git a/types/chat.ts b/types/chat.ts index 570e5c35..cc90e400 100644 --- a/types/chat.ts +++ b/types/chat.ts @@ -134,6 +134,7 @@ export interface QuickActions { export interface TabData { placeholderText?: string + /** New or updated messages (depending on `messageId`). */ messages: ChatMessage[] } diff --git a/types/workspace.ts b/types/workspace.ts index 4e34c7fd..ca0f6d7f 100644 --- a/types/workspace.ts +++ b/types/workspace.ts @@ -1,5 +1,6 @@ import { URI, TextDocument } from './lsp' +/** Server to client. Used to ask the user to select a folder, if the workspace folder is too big */ export const SELECT_WORKSPACE_ITEM_REQUEST_METHOD = 'aws/selectWorkspaceItem' export const OPEN_FILE_DIFF_NOTIFICATION_METHOD = 'aws/openFileDiff' @@ -18,7 +19,9 @@ export interface SelectWorkspaceItemResult { } export interface OpenFileDiffParams { + /** The initial version of the file. */ originalFileUri: URI + /** Indicates if the original file was deleted and fileContent contains the new/updated file contents. */ isDeleted: boolean fileContent?: string }