@xyz-agent/extension-protocol 0.3.0 → 0.3.1-dev.0

package/dist/index.d.mts

@@ -195,6 +195,8 @@ interface AskUserQuestion {
      *  - 有 options 时：默认 true，前端在选项末尾追加 Other 输入框；设 false 则不追加
      *  - 无 options 时：整个问题就是自由输入，此字段被忽略 */
     allowOther?: boolean;
+    /** 是否允许附加评论。选中后可追加短文本（4.0.1 restore：0.3.0 误删导致 pi-ask-user@4.0.0 ESM import 崩溃，见 .changeset/restore-ask-user-comment.md） */
+    allowComment?: boolean;
 }
 interface AskUserOption {
     /** 显示标签 */
@@ -212,10 +214,12 @@ interface AskUserOption {
  * - 多选：value = JSON.stringify(选中项 value 数组)，如 '["pg","mysql"]'
  *   （不用逗号 join——option value 可能含逗号导致 split 歧义）
  * - Other 文本：单独 key `${header}__other`，value = 自由文本（不混进选中项数组）
+ * - comment：单独 key `${header}__comment`，value = 评论文本
  *
  * extension 解析示例：
  *   const selected = JSON.parse(answers[header])  // 多选 → string[]
  *   const other = answers[`${header}__other`]     // Other 自由文本
+ *   const comment = answers[`${header}__comment`] // 评论
  */
 type AskUserAnswers = Record<string, string>;
 
@@ -262,10 +266,12 @@ declare function askUserInteract(ctx: GuiContext, questions: AskUserQuestion[],
 declare function getAskUserAnswer(answers: AskUserAnswers, question: AskUserQuestion): string | string[] | undefined;
 /** 从 answers 中提取 Other 自由文本 */
 declare function getAskUserOther(answers: AskUserAnswers, question: AskUserQuestion): string | undefined;
+/** 从 answers 中提取评论（4.0.1 restore：ask-user TUI 评论模式与 renderer AskUserOverlay 仍消费此 helper） */
+declare function getAskUserComment(answers: AskUserAnswers, question: AskUserQuestion): string | undefined;
 /**
  * 类型守卫：验证 unknown 是否为合法的 AskUserQuestion。
  * 用于前端从 runtime 透传的 askUserQuestions（unknown[]）中安全收窄。
  */
 declare function isAskUserQuestion(value: unknown): value is AskUserQuestion;
 
-export { ASK_USER_MARKER, type AskUserAnswers, type AskUserOption, type AskUserQuestion, GUI_WIDGET_MARKER, type GuiComponent, type GuiComponentProps, type GuiComponentType, type GuiContext, type GuiRenderResult, PROTOCOL_VERSION, type StatItem, type TreeItem, type TreeItemIcon, askUserInteract, extractGui, getAskUserAnswer, getAskUserOther, guiComponent, guiResult, guiSetWidget, isAskUserQuestion, isGuiCapable, isGuiComponent };
+export { ASK_USER_MARKER, type AskUserAnswers, type AskUserOption, type AskUserQuestion, GUI_WIDGET_MARKER, type GuiComponent, type GuiComponentProps, type GuiComponentType, type GuiContext, type GuiRenderResult, PROTOCOL_VERSION, type StatItem, type TreeItem, type TreeItemIcon, askUserInteract, extractGui, getAskUserAnswer, getAskUserComment, getAskUserOther, guiComponent, guiResult, guiSetWidget, isAskUserQuestion, isGuiCapable, isGuiComponent };

package/dist/index.mjs

@@ -100,10 +100,13 @@ function getAskUserAnswer(answers, question) {
 function getAskUserOther(answers, question) {
   return answers[`${askUserKey(question)}__other`];
 }
+function getAskUserComment(answers, question) {
+  return answers[`${askUserKey(question)}__comment`];
+}
 function isAskUserQuestion(value) {
   if (typeof value !== "object" || value === null) return false;
   const q = value;
-  return typeof q.question === "string" && (q.header === void 0 || typeof q.header === "string") && (q.options === void 0 || Array.isArray(q.options)) && (q.multiSelect === void 0 || typeof q.multiSelect === "boolean") && (q.allowOther === void 0 || typeof q.allowOther === "boolean");
+  return typeof q.question === "string" && (q.header === void 0 || typeof q.header === "string") && (q.options === void 0 || Array.isArray(q.options)) && (q.multiSelect === void 0 || typeof q.multiSelect === "boolean") && (q.allowOther === void 0 || typeof q.allowOther === "boolean") && (q.allowComment === void 0 || typeof q.allowComment === "boolean");
 }
 export {
   ASK_USER_MARKER,
@@ -112,6 +115,7 @@ export {
   askUserInteract,
   extractGui,
   getAskUserAnswer,
+  getAskUserComment,
   getAskUserOther,
   guiComponent,
   guiResult,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyz-agent/extension-protocol",
-  "version": "0.3.0",
+  "version": "0.3.1-dev.0",
   "description": "Extension GUI rendering protocol: types and helpers for pi extension dual-mode (TUI/GUI) rendering",
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",