@zhushanwen/pi-pending-notifications 0.8.5 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhushanwen/pi-pending-notifications",
-  "version": "0.8.5",
+  "version": "0.9.0",
   "description": "Cross-extension async operation registration/query mechanism for Pi.",
   "type": "module",
   "main": "src/index.ts",
@@ -30,12 +30,18 @@
   },
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": "^1.0.0",
+    "@earendil-works/pi-tui": "^1.0.0",
     "typebox": "1.3.27"
   },
   "dependencies": {
-    "@zhushanwen/extension-protocol": "0.20.0",
+    "@zhushanwen/extension-protocol": "0.21.0",
     "@zhushanwen/pi-extension-logger": "0.6.2"
   },
+  "peerDependenciesMeta": {
+    "@earendil-works/pi-tui": {
+      "optional": true
+    }
+  },
   "scripts": {
     "typecheck": "npx tsc --noEmit",
     "test": "vitest run"

package/src/__tests__/summary.test.ts

@@ -0,0 +1,151 @@
+// pending_notifications 收起态摘要测试：buildPendingNotificationsSummary 纯函数文案 +
+// execute 产出的 details.summary + renderResult 折叠/展开形态。
+//
+// mock 形态沿用 pending-notifications.test.ts（最小 ExtensionAPI/ExtensionContext mock）。
+
+import type { Theme } from "@earendil-works/pi-coding-agent";
+import { describe, expect, it, vi } from "vitest";
+
+import pendingNotificationsExtension, { buildPendingNotificationsSummary } from "../index";
+import { renderPendingNotificationsResult } from "../render-result";
+
+// ── mock（最小 ExtensionAPI / ExtensionContext）──────
+
+function setup() {
+	const registerToolMock = vi.fn();
+	const entries: Array<{ customType: string; data: Record<string, unknown> }> = [];
+	const pi = {
+		appendEntry: vi.fn((customType: string, data: Record<string, unknown>) => {
+			entries.push({ customType, data });
+		}),
+		registerTool: registerToolMock,
+		sendMessage: vi.fn(),
+		on: vi.fn(),
+		events: { emit: vi.fn(), on: vi.fn() },
+	};
+	pendingNotificationsExtension(pi as never);
+	const ctx = {
+		sessionManager: {
+			getEntries: () => entries,
+			getSessionId: () => "sess-current",
+		},
+	};
+	return { registerToolMock, entries, ctx };
+}
+
+async function runTool(
+	setup: ReturnType<typeof setup>,
+	params: { action: "count" | "list" },
+): Promise<{ content: Array<{ type: string; text: string }>; details: Record<string, unknown> }> {
+	const tool = setup.registerToolMock.mock.calls[0]![0] as {
+		execute: (
+			toolCallId: string,
+			p: unknown,
+			signal: AbortSignal | undefined,
+			onUpdate: unknown,
+			ctx: unknown,
+		) => Promise<{ content: Array<{ type: string; text: string }>; details: unknown }>;
+	};
+	const res = await tool.execute("test-call-id", params, undefined, undefined, setup.ctx);
+	return { ...res, details: res.details as Record<string, unknown> };
+}
+
+/** 注入 2 条活跃 pending entry（register 落盘、无 unregister） */
+function seedActive(setup: ReturnType<typeof setup>, ids: string[]): void {
+	for (const id of ids) {
+		setup.entries.push({
+			customType: "pending:register",
+			data: { id, type: "workflow", name: `op-${id}`, registeredAt: 0, sessionId: "sess-current" },
+		});
+	}
+}
+
+// ── buildPendingNotificationsSummary ────────────────
+
+describe("buildPendingNotificationsSummary", () => {
+	it("count → N pending operations", () => {
+		expect(buildPendingNotificationsSummary({ action: "count", count: 2 })).toBe(
+			"2 pending operations",
+		);
+	});
+
+	it("list → N entries listed", () => {
+		expect(buildPendingNotificationsSummary({ action: "list", count: 4 })).toBe(
+			"4 entries listed",
+		);
+	});
+
+	it("零值 → No pending operations（与 content 文案零值口径一致）", () => {
+		expect(buildPendingNotificationsSummary({ action: "count", count: 0 })).toBe(
+			"No pending operations",
+		);
+		expect(buildPendingNotificationsSummary({ action: "list", count: 0 })).toBe(
+			"No pending operations",
+		);
+	});
+});
+
+// ── execute 产出的 details.summary ───────────────────
+
+describe("pending_notifications execute details.summary", () => {
+	it("count action → details 带现有字段 + summary", async () => {
+		const s = setup();
+		const res = await runTool(s, { action: "count" });
+		expect(res.details).toMatchObject({ action: "count", count: 0, summary: "No pending operations" });
+	});
+
+	it("list action → details 带现有字段 + summary", async () => {
+		const s = setup();
+		seedActive(s, ["a", "b", "c", "d"]);
+		const res = await runTool(s, { action: "list" });
+		expect(res.details).toMatchObject({ action: "list", count: 4, summary: "4 entries listed" });
+		expect(Array.isArray(res.details.items)).toBe(true);
+	});
+});
+
+// ── renderPendingNotificationsResult（TUI renderResult）──
+
+const mockTheme = {
+	fg: (_color: string, text: string) => text,
+	bg: (_color: string, text: string) => text,
+	bold: (text: string) => text,
+	italic: (text: string) => text,
+	underline: (text: string) => text,
+	inverse: (text: string) => text,
+	strikethrough: (text: string) => text,
+	getFgAnsi: (_color: string) => "",
+	getBgAnsi: (_color: string) => "",
+	getColorMode: () => "truecolor" as const,
+	getThinkingBorderColor: () => (text: string) => text,
+	getBashModeBorderColor: () => (text: string) => text,
+} as unknown as Theme;
+
+function renderedText(result: unknown, expanded: boolean): string {
+	return renderPendingNotificationsResult(result, { expanded }, mockTheme)
+		.render(400)
+		.map((line) => line.trimEnd())
+		.join("\n");
+}
+
+describe("renderPendingNotificationsResult", () => {
+	it("折叠态 → details.summary 一行", () => {
+		const r = {
+			content: [{ type: "text", text: "2 pending operation(s):\n- [workflow] a" }],
+			details: { action: "count", count: 2, summary: "2 pending operations" },
+		};
+		expect(renderedText(r, false)).toBe("2 pending operations");
+	});
+
+	it("展开态 → content 纯文本", () => {
+		const r = {
+			content: [{ type: "text", text: "line1\nline2" }],
+			details: { action: "list", count: 2, summary: "2 entries listed" },
+		};
+		expect(renderedText(r, true)).toBe("line1\nline2");
+	});
+
+	it("无 summary（旧 entry）→ 折叠态回退 content 首行", () => {
+		const r = { content: [{ type: "text", text: "2 pending operation(s):\n- [workflow] a" }], details: {} };
+		expect(renderedText(r, false)).toBe("2 pending operation(s):");
+	});
+});

package/src/index.ts

@@ -47,7 +47,7 @@
  * workflow 侧通过 deps.eventBus 注入 pi.events（同一总线）。
  */
 
-import type { ExtensionAPI, ExtensionContext } from "@earendil-works/pi-coding-agent";
+import type { ExtensionAPI, ExtensionContext, Theme } from "@earendil-works/pi-coding-agent";
 import { mapReasonToStatus as mapReasonToStatusImpl } from "@zhushanwen/extension-protocol";
 import { getLogger } from "@zhushanwen/pi-extension-logger";
 import { Type } from "typebox";
@@ -61,6 +61,7 @@ import {
 	type PendingStatus,
 	type PendingType,
 } from "./state.ts";
+import { renderPendingNotificationsResult } from "./render-result.ts";
 
 // 跨扩展消费 API：goal（continuation 守卫）/ subagent-workflow（agent_end 后代判定）
 // 直接 import 本包导出的 countActiveFromEntries，避免各自复制差集逻辑。导出面只保留
@@ -84,11 +85,13 @@ const PendingNotificationsParams = Type.Object({
 });
 
 /** pending_notifications 工具的 details 形状。两个分支共用同一结构（items 缺省时 undefined），
- *  让 registerTool 泛型对 TDetails 推断一致，避免 union 细节冲突。 */
+ *  让 registerTool 泛型对 TDetails 推断一致，避免 union 细节冲突。summary 是收起态一行摘要
+ *  （GUI 收起态与 TUI 折叠态共用，buildPendingNotificationsSummary 产出）。 */
 interface PendingToolDetails {
 	action: string;
 	count: number;
 	items?: PendingEntry[];
+	summary: string;
 }
 
 /**
@@ -241,16 +244,29 @@ export default function pendingNotificationsExtension(pi: ExtensionAPI): void {
 			if (params.action === "count") {
 				return {
 					content: [{ type: "text" as const, text: `${active.length} pending operation(s)` }],
-					details: { action: "count", count: active.length },
+					details: {
+						action: "count",
+						count: active.length,
+						summary: buildPendingNotificationsSummary({ action: "count", count: active.length }),
+					},
 				};
 			}
 
 			// action === "list"
 			return {
 				content: [{ type: "text" as const, text: formatList(active) }],
-				details: { action: "list", count: active.length, items: active },
+				details: {
+					action: "list",
+					count: active.length,
+					items: active,
+					summary: buildPendingNotificationsSummary({ action: "list", count: active.length }),
+				},
 			};
 		},
+
+		renderResult(result: unknown, options: { expanded: boolean }, theme: Theme) {
+			return renderPendingNotificationsResult(result, options, theme);
+		},
 	});
 }
 
@@ -307,3 +323,15 @@ function formatList(active: PendingEntry[]): string {
 	const lines = active.map((op) => `- [${op.type}] ${op.name} (id=${op.id})`);
 	return `${active.length} pending operation(s):\n${lines.join("\n")}`;
 }
+
+/** 收起态一行摘要：count → "N pending operations"；list → "N entries listed"；零值统一
+ *  "No pending operations"（与 content 文案的零值口径一致）。 */
+export function buildPendingNotificationsSummary(details: {
+	action: string;
+	count: number;
+}): string {
+	if (details.count === 0) return "No pending operations";
+	return details.action === "count"
+		? `${details.count} pending operations`
+		: `${details.count} entries listed`;
+}

package/src/render-result.ts

@@ -0,0 +1,43 @@
+/**
+ * pending_notifications 工具的 TUI renderResult（折叠态一行摘要 / 展开态 content 纯文本）。
+ */
+
+import type { Theme } from "@earendil-works/pi-coding-agent";
+import { Text } from "@earendil-works/pi-tui";
+import { firstContentText } from "@zhushanwen/extension-protocol";
+
+/** content[0] 的 text 纯文本（content 缺失或非 text 类型时兜底空串）。 */
+function contentText(result: unknown): string {
+	const content = fieldValue(result, "content");
+	if (!Array.isArray(content)) return "";
+	return firstContentText({ content });
+}
+
+/** unknown 值按字段名安全取值（index-signature 收窄，替代全可选结构断言）。 */
+function fieldValue(v: unknown, key: string): unknown {
+	if (typeof v !== "object" || v === null) return undefined;
+	return (v as Record<string, unknown>)[key];
+}
+
+/** 从 details 安全读取 summary（容错非对象形态与旧版本 entry）。 */
+function readDetailsSummary(result: unknown): string | undefined {
+	const summary = fieldValue(fieldValue(result, "details"), "summary");
+	return typeof summary === "string" && summary !== "" ? summary : undefined;
+}
+
+/** 折叠态回退：content 文本首行（保持一行摘要形态）。 */
+function firstLine(text: string): string {
+	const idx = text.indexOf("\n");
+	return idx === -1 ? text : text.slice(0, idx);
+}
+
+/** 折叠态（expanded=false）= details.summary 一行（dim）；展开态 = content 纯文本。 */
+export function renderPendingNotificationsResult(
+	result: unknown,
+	options: { expanded: boolean },
+	theme: Theme,
+): Text {
+	if (options.expanded) return new Text(contentText(result), 0, 0);
+	const summary = readDetailsSummary(result) ?? firstLine(contentText(result));
+	return new Text(theme.fg("dim", summary), 0, 0);
+}