add ChatAgentResponseItemMetadata to stream builder methods, gives place for future annotations

Author: jrieken

src/vs/workbench/api/common/extHostChatAgents2.ts

@@ -73,31 +73,32 @@ class ChatAgentResponseStream {
 			};
 
 			this._apiObject = {
-				markdown(value) {
+				markdown(value, meta) {
 					throwIfDone(this.markdown);
 					_report({
 						kind: 'markdownContent',
 						content: typeConvert.MarkdownString.from(value)
 					});
 					return this;
 				},
-				text(value) {
+				text(value, meta) {
 					throwIfDone(this.text);
-					this.markdown(new MarkdownString().appendText(value));
+					this.markdown(new MarkdownString().appendText(value), meta);
 					return this;
 				},
-				files(value) {
+				files(value, meta) {
 					throwIfDone(this.files);
 					_report({
 						kind: 'treeData',
 						treeData: value
 					});
 					return this;
 				},
-				anchor(value) {
+				anchor(value, meta) {
 					throwIfDone(this.anchor);
 					_report({
 						kind: 'inlineReference',
+						name: meta?.title,
 						inlineReference: !URI.isUri(value) ? typeConvert.Location.from(<vscode.Location>value) : value
 					});
 					return this;
@@ -118,10 +119,6 @@ class ChatAgentResponseStream {
 					});
 					return this;
 				},
-				// annotation(value) {
-				// 	_report(value);
-				// 	return this;
-				// },
 				report(progress) {
 					throwIfDone(this.report);
 					if ('placeholder' in progress && 'resolvedContent' in progress) {

src/vscode-dts/vscode.proposed.chatAgents2.d.ts

@@ -274,25 +274,32 @@ declare module 'vscode' {
 		variables: Record<string, ChatVariableValue[]>;
 	}
 
+	export interface ChatAgentResponseItemMetadata {
+		title: string;
+		// annotations: any[]; // future OffsetbasedAnnotation and Annotation
+	}
+
 	export interface ChatAgentResponseStream {
 
 		// RENDERED
-		markdown(value: string | MarkdownString): ChatAgentResponseStream;
-		text(value: string): ChatAgentResponseStream;
-		files(value: ChatAgentFileTreeData): ChatAgentResponseStream;
-		// TODO@jrieken is this sugar for markdown syntax? should we have more like codeblock, bulletlist etc?
-		anchor(value: Uri | Location, attributes?: { title?: string }): ChatAgentResponseStream;
+
+		text(value: string, meta?: ChatAgentResponseItemMetadata): ChatAgentResponseStream;
+
+		markdown(value: string | MarkdownString, meta?: ChatAgentResponseItemMetadata): ChatAgentResponseStream;
+
+		files(value: ChatAgentFileTreeData, meta?: ChatAgentResponseItemMetadata): ChatAgentResponseStream;
+
+		anchor(value: Uri | Location, meta?: ChatAgentResponseItemMetadata): ChatAgentResponseStream;
 
 		// META
+
 		// TODO@API this influences the rendering, it inserts new lines which is likely a bug
 		progress(value: string): ChatAgentResponseStream;
 
 		// TODO@API support non-file uris, like http://example.com
+		// TODO@API support mapped edits
 		reference(value: Uri | Location): ChatAgentResponseStream;
 
-		// TODO@API define support annotations
-		// annotation(value: string | MarkdownString | ChatXYZAnnotation, references?: string): ChatAgentResponseStream;
-
 		/**
 		 * @deprecated use above methods instread
 		 */