@mickorz/opencode-agentic-workflow 0.4.0 → 0.5.0

package/dist/plugin/progress-rpc.d.ts

@@ -0,0 +1,390 @@
+/**
+ * Workflow Progress RPC 契约（P2-8，server 与 TUI 双形态共享）
+ *
+ * 流向：
+ *   server RunJournal 状态转换 -> emitEvent("run.progress") -> ProgressBoard
+ *     --events.emit--> rpc.agentic-workflow-progress.progress { run 快照 }
+ *   TUI 面板：
+ *     <--call-- rpc "snapshot" -> { runs: [...] }（面板打开时初始同步）
+ *     --事件--> 实时更新（全量快照，无需增量对账）
+ *
+ * 快照小而可序列化（不含步骤 output——详情看 journal 文件）。
+ */
+import type { RunProgressSnapshot } from "../observability/events.js";
+import type { RunDetail } from "../state/recorder.js";
+/** 会话回放条目（session 方法输出；文本预览化，面板/工具侧消费） */
+export interface SessionReplayMessage {
+    /** 宿主消息类型（user / assistant …） */
+    type: string;
+    /** 文本内容（多 text part 合并，预览截断） */
+    text: string;
+}
+export interface SessionReplay {
+    /** 会话 ID（回放来源；null = 找不到会话） */
+    sessionID: string;
+    /** 所属步骤名（journal 定位用） */
+    step?: string;
+    /** 对话消息（时间顺序；条数与单条长度均截断） */
+    messages: SessionReplayMessage[];
+}
+export declare const ProgressRpc: {
+    readonly id: "agentic-workflow-progress";
+    readonly methods: {
+        /** TUI -> server：拉取当前 board（面板打开时初始同步） */
+        readonly snapshot: {
+            readonly input: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly additionalProperties: false;
+            };
+            readonly output: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly runs: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly runId: {
+                                    readonly type: "string";
+                                };
+                                readonly workflow: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly id: {
+                                            readonly type: "string";
+                                        };
+                                        readonly version: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly required: readonly ["id", "version"];
+                                    readonly additionalProperties: false;
+                                };
+                                readonly status: {
+                                    readonly type: "string";
+                                };
+                                readonly startedAt: {
+                                    readonly type: "number";
+                                };
+                                readonly completedAt: {
+                                    readonly type: "number";
+                                };
+                                readonly failure: {
+                                    readonly type: "string";
+                                };
+                                readonly parentRunId: {
+                                    readonly type: "string";
+                                };
+                                readonly depth: {
+                                    readonly type: "number";
+                                };
+                                readonly steps: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly index: {
+                                                readonly type: "number";
+                                            };
+                                            readonly name: {
+                                                readonly type: "string";
+                                            };
+                                            readonly status: {
+                                                readonly type: "string";
+                                            };
+                                            readonly startedAt: {
+                                                readonly type: "number";
+                                            };
+                                            readonly completedAt: {
+                                                readonly type: "number";
+                                            };
+                                        };
+                                        readonly required: readonly ["index", "status"];
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["runId", "workflow", "status", "startedAt", "steps"];
+                        };
+                    };
+                };
+                readonly required: readonly ["runs"];
+                readonly additionalProperties: false;
+            };
+        };
+        /** TUI -> server：单个 run 的节点详情（journal 单读，载荷为预览） */
+        readonly detail: {
+            readonly input: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly runId: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["runId"];
+                readonly additionalProperties: false;
+            };
+            readonly output: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly run: {
+                        readonly oneOf: readonly [{
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly runId: {
+                                    readonly type: "string";
+                                };
+                                readonly workflow: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly id: {
+                                            readonly type: "string";
+                                        };
+                                        readonly version: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly required: readonly ["id", "version"];
+                                    readonly additionalProperties: false;
+                                };
+                                readonly status: {
+                                    readonly type: "string";
+                                };
+                                readonly startedAt: {
+                                    readonly type: "number";
+                                };
+                                readonly completedAt: {
+                                    readonly type: "number";
+                                };
+                                readonly failure: {
+                                    readonly type: "string";
+                                };
+                                readonly parentRunId: {
+                                    readonly type: "string";
+                                };
+                                readonly depth: {
+                                    readonly type: "number";
+                                };
+                                readonly args: {
+                                    readonly type: "string";
+                                };
+                                readonly steps: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly index: {
+                                                readonly type: "number";
+                                            };
+                                            readonly name: {
+                                                readonly type: "string";
+                                            };
+                                            readonly status: {
+                                                readonly type: "string";
+                                            };
+                                            readonly startedAt: {
+                                                readonly type: "number";
+                                            };
+                                            readonly completedAt: {
+                                                readonly type: "number";
+                                            };
+                                            readonly input: {
+                                                readonly type: "string";
+                                            };
+                                            readonly output: {
+                                                readonly type: "string";
+                                            };
+                                            readonly error: {
+                                                readonly type: "string";
+                                            };
+                                            readonly usage: {
+                                                readonly type: "object";
+                                                readonly properties: {
+                                                    readonly input: {
+                                                        readonly type: "number";
+                                                    };
+                                                    readonly output: {
+                                                        readonly type: "number";
+                                                    };
+                                                    readonly reasoning: {
+                                                        readonly type: "number";
+                                                    };
+                                                };
+                                                readonly required: readonly ["input", "output", "reasoning"];
+                                                readonly additionalProperties: false;
+                                            };
+                                            readonly model: {
+                                                readonly type: "string";
+                                            };
+                                            readonly sessionIDs: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly required: readonly ["index", "status"];
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["runId", "workflow", "status", "startedAt", "steps"];
+                        }, {
+                            readonly type: "null";
+                        }];
+                    };
+                };
+                readonly required: readonly ["run"];
+                readonly additionalProperties: false;
+            };
+        };
+        /**
+         * TUI -> server：Open Session 回放——按 runId + 步骤名取该步骤子会话的
+         * 完整对话（文本预览）。index 选多会话步骤（pipeline）的第几个，缺省最后。
+         */
+        readonly session: {
+            readonly input: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly runId: {
+                        readonly type: "string";
+                    };
+                    readonly step: {
+                        readonly type: "string";
+                    };
+                    readonly index: {
+                        readonly type: "number";
+                    };
+                };
+                readonly required: readonly ["runId", "step"];
+                readonly additionalProperties: false;
+            };
+            readonly output: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly session: {
+                        readonly oneOf: readonly [{
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly sessionID: {
+                                    readonly type: "string";
+                                };
+                                readonly step: {
+                                    readonly type: "string";
+                                };
+                                readonly messages: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly type: {
+                                                readonly type: "string";
+                                            };
+                                            readonly text: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                        readonly required: readonly ["type", "text"];
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["sessionID", "messages"];
+                            readonly additionalProperties: false;
+                        }, {
+                            readonly type: "null";
+                        }];
+                    };
+                };
+                readonly required: readonly ["session"];
+                readonly additionalProperties: false;
+            };
+        };
+    };
+    readonly events: {
+        /** server -> TUI：run 全量快照 */
+        progress: {
+            schema: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly runId: {
+                        readonly type: "string";
+                    };
+                    readonly workflow: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                            };
+                            readonly version: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly required: readonly ["id", "version"];
+                        readonly additionalProperties: false;
+                    };
+                    readonly status: {
+                        readonly type: "string";
+                    };
+                    readonly startedAt: {
+                        readonly type: "number";
+                    };
+                    readonly completedAt: {
+                        readonly type: "number";
+                    };
+                    readonly failure: {
+                        readonly type: "string";
+                    };
+                    readonly parentRunId: {
+                        readonly type: "string";
+                    };
+                    readonly depth: {
+                        readonly type: "number";
+                    };
+                    readonly steps: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly index: {
+                                    readonly type: "number";
+                                };
+                                readonly name: {
+                                    readonly type: "string";
+                                };
+                                readonly status: {
+                                    readonly type: "string";
+                                };
+                                readonly startedAt: {
+                                    readonly type: "number";
+                                };
+                                readonly completedAt: {
+                                    readonly type: "number";
+                                };
+                            };
+                            readonly required: readonly ["index", "status"];
+                        };
+                    };
+                };
+                readonly required: readonly ["runId", "workflow", "status", "startedAt", "steps"];
+            };
+        };
+    };
+};
+/** TUI 订阅用事件名（字面量类型；与 ProgressRpc.id 的一致性由单测保证） */
+export declare const PROGRESS_EVENT: "rpc.agentic-workflow-progress.progress";
+/** 收窄事件/方法载荷为快照（事件 data 为 unknown 形状）；不合法返回 undefined */
+export declare function parseRunSnapshot(data: unknown): RunProgressSnapshot | undefined;
+/** 收窄 snapshot 方法输出为快照数组；不合法整体丢弃（面板回退到空态） */
+export declare function parseRunSnapshotList(data: unknown): RunProgressSnapshot[];
+/** 收窄 detail 方法入参为 runId；不合法（缺/非串）返回 undefined */
+export declare function parseRunDetailRequest(data: unknown): string | undefined;
+/** 收窄 detail 方法输出为详情；null（run 不存在/无 journal）或不合法返回 undefined */
+export declare function parseRunDetail(data: unknown): RunDetail | undefined;
+/** 收窄 session 方法入参；不合法返回 undefined */
+export declare function parseSessionReplayRequest(data: unknown): {
+    runId: string;
+    step: string;
+    index?: number;
+} | undefined;
+/** 收窄 session 方法输出；不合法返回 undefined */
+export declare function parseSessionReplay(data: unknown): SessionReplay | undefined;