chatSessions: id -> type (https://github.com/microsoft/vscode/pull/258334/files#diff-0f4d792a351bc468d9e62ba13096beed7f624481cae13c82707455b12d61c328) (#7437)

Author: joshspicer

package.json

@@ -71,7 +71,7 @@
 	"contributes": {
 		"chatSessions": [
 			{
-				"id": "copilot-swe-agent",
+				"type": "copilot-swe-agent",
 				"name": "copilot",
 				"displayName": "GitHub Copilot Coding Agent",
 				"description": "Chat session for GitHub Copilot coding agent"

src/@types/vscode.proposed.chatSessionsProvider.d.ts

@@ -31,9 +31,8 @@ declare module 'vscode' {
 
 		/**
 		 * Provides a list of chat sessions.
-		 *
-		 * TODO: Do we need a flag to try auth if needed?
 		 */
+		// TODO: Do we need a flag to try auth if needed?
 		provideChatSessionItems(token: CancellationToken): ProviderResult<ChatSessionItem[]>;
 	}
 
@@ -60,10 +59,9 @@ declare module 'vscode' {
 		 * The full history of the session
 		 *
 		 * This should not include any currently active responses
-		 *
-		 * TODO: Are these the right types to use?
-		 * TODO: link request + response to encourage correct usage?
 		 */
+		// TODO: Are these the right types to use?
+		// TODO: link request + response to encourage correct usage?
 		readonly history: ReadonlyArray<ChatRequestTurn | ChatResponseTurn2>;
 
 		/**
@@ -79,27 +77,41 @@ declare module 'vscode' {
 		 * Handles new request for the session.
 		 *
 		 * If not set, then the session will be considered read-only and no requests can be made.
-		 *
-		 * TODO: Should we introduce our own type for `ChatRequestHandler` since not all field apply to chat sessions?
 		 */
+		// TODO: Should we introduce our own type for `ChatRequestHandler` since not all field apply to chat sessions?
 		readonly requestHandler: ChatRequestHandler | undefined;
 	}
 
 	export interface ChatSessionContentProvider {
 		/**
 		 * Resolves a chat session into a full `ChatSession` object.
 		 *
-		 * @param uri The URI of the chat session to open. Uris as structured as `vscode-chat-session:<chatSessionType>/id`
+		 * @param sessionId The id of the chat session to open.
 		 * @param token A cancellation token that can be used to cancel the operation.
 		 */
-		provideChatSessionContent(id: string, token: CancellationToken): Thenable<ChatSession>;
+		provideChatSessionContent(sessionId: string, token: CancellationToken): Thenable<ChatSession> | ChatSession;
 	}
 
 	export namespace chat {
+		/**
+		 * Registers a new {@link ChatSessionItemProvider chat session item provider}.
+		 *
+		 * To use this, also make sure to also add `chatSessions` contribution in the `package.json`.
+		 *
+		 * @param chatSessionType The type of chat session the provider is for.
+		 * @param provider The provider to register.
+		 *
+		 * @returns A disposable that unregisters the provider when disposed.
+		 */
 		export function registerChatSessionItemProvider(chatSessionType: string, provider: ChatSessionItemProvider): Disposable;
 
 		/**
+		 * Registers a new {@link ChatSessionContentProvider chat session content provider}.
+		 *
 		 * @param chatSessionType A unique identifier for the chat session type. This is used to differentiate between different chat session providers.
+		 * @param provider The provider to register.
+		 *
+		 * @returns A disposable that unregisters the provider when disposed.
 		 */
 		export function registerChatSessionContentProvider(chatSessionType: string, provider: ChatSessionContentProvider): Disposable;
 	}
@@ -114,7 +126,9 @@ declare module 'vscode' {
 	}
 
 	export namespace window {
-
-		export function showChatSession(chatSessionType: string, id: string, options: ChatSessionShowOptions): Thenable<void>;
+		/**
+		 * Shows a chat session in the panel or editor.
+		 */
+		export function showChatSession(chatSessionType: string, sessionId: string, options: ChatSessionShowOptions): Thenable<void>;
 	}
 }