@devcxl/opencode-cabbage 1.2.0 → 2.0.0

package/dist/plugin/goal-store.d.ts

@@ -0,0 +1,64 @@
+import type { GoalData } from "./goal.js";
+/**
+ * goal 存储抽象（OpenCode V2）。
+ *
+ * V2 实现 = 会话 metadata（ctx.session.get/update）；
+ * 消息面用 session.context 投影；记账快照用会话累计 tokens。
+ * read 的 fail-closed 语义（异常 → null）由实现保证，调用方依赖此兜底。
+ */
+/** goal 宿主会话的最小面（V2 SessionInfo 子集） */
+export interface GoalSession {
+    parentID: string | null;
+    metadata: Record<string, unknown>;
+    agent?: string | null;
+    model?: {
+        providerID?: string;
+        id?: string;
+        variant?: string;
+    } | null;
+    tokens?: unknown;
+}
+/** V2 消息投影的最小形状（session.context 返回值的子集） */
+export interface GoalContextMessage {
+    type?: string;
+    time?: {
+        completed?: number;
+        created?: number;
+    } | null;
+    content?: Array<{
+        type?: string;
+        text?: string;
+    }>;
+}
+/**
+ * GoalStore V2 实现所需的 session 域最小面（ctx.session 的子集）。
+ * 参数/返回值放宽为 any：该接口是插件到存储的唯一适配边界，
+ * 内部做运行时形状校验后以强类型 GoalStore 暴露（避免把平台品牌类型渗入内核）。
+ */
+export interface GoalStoreSessionApi {
+    get(args: {
+        sessionID: string;
+    }): Promise<any>;
+    update(args: {
+        sessionID: string;
+        metadata: any;
+    }): Promise<any>;
+    context(args: {
+        sessionID: string;
+    }): Promise<any>;
+}
+/** goal 状态存储。read 的 fail-closed 语义（异常 → null）由实现保证，调用方依赖此兜底。 */
+export interface GoalStore {
+    read(sessionID: string): Promise<{
+        goal: GoalData | null;
+        session: GoalSession | null;
+    }>;
+    /** 写 goal；null 表示删除。existingSession 复用 read 结果避免二次读取。 */
+    write(sessionID: string, goal: GoalData | null, existingSession?: GoalSession | null): Promise<void>;
+    /** 会话消息投影（续接尾部检查与信号检测用）。异常/非数组时返回 null。 */
+    context(sessionID: string): Promise<GoalContextMessage[] | null>;
+    /** 会话累计 token 快照（预算护栏记账用）。异常时返回 null。 */
+    sessionTokens(sessionID: string): Promise<unknown | null>;
+}
+/** V2 实现：goal 持久化在 session metadata 的 goal 键；消息/tokens 走 session 域读取。 */
+export declare function createSessionGoalStore(session: GoalStoreSessionApi): GoalStore;

package/dist/plugin/goal-store.js

@@ -0,0 +1,57 @@
+function toGoalSession(session) {
+    return {
+        parentID: session?.parentID ?? null,
+        metadata: session?.metadata ?? {},
+        agent: session?.agent ?? null,
+        model: session?.model ?? null,
+        tokens: session?.tokens,
+    };
+}
+/** V2 实现：goal 持久化在 session metadata 的 goal 键；消息/tokens 走 session 域读取。 */
+export function createSessionGoalStore(session) {
+    return {
+        async read(sessionID) {
+            try {
+                const result = await session.get({ sessionID });
+                if (!result)
+                    return { goal: null, session: null };
+                const goalSession = toGoalSession(result);
+                if (!goalSession.metadata.goal)
+                    return { goal: null, session: goalSession };
+                return { goal: goalSession.metadata.goal, session: goalSession };
+            }
+            catch {
+                return { goal: null, session: null };
+            }
+        },
+        async write(sessionID, goal, existingSession) {
+            const current = existingSession ?? (await this.read(sessionID)).session;
+            if (!current)
+                throw new Error("Failed to get session");
+            const existing = current.metadata ?? {};
+            const metadata = goal === null
+                ? Object.fromEntries(Object.entries(existing).filter(([k]) => k !== "goal"))
+                : { ...existing, goal };
+            await session.update({ sessionID, metadata });
+        },
+        async context(sessionID) {
+            try {
+                const result = await session.context({ sessionID });
+                return Array.isArray(result) ? result : null;
+            }
+            catch {
+                return null;
+            }
+        },
+        async sessionTokens(sessionID) {
+            try {
+                const result = await session.get({ sessionID });
+                return result?.tokens ?? null;
+            }
+            catch {
+                return null;
+            }
+        },
+    };
+}
+//# sourceMappingURL=goal-store.js.map

package/dist/plugin/goal-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"goal-store.js","sourceRoot":"","sources":["../../src/plugin/goal-store.ts"],"names":[],"mappings":"AAgDA,SAAS,aAAa,CAAC,OAMH;IAClB,OAAO;QACL,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,IAAI;QACnC,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,EAAE;QACjC,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,CAAA;AACH,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,sBAAsB,CAAC,OAA4B;IACjE,OAAO;QACL,KAAK,CAAC,IAAI,CAAC,SAAS;YAClB,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;gBAC/C,IAAI,CAAC,MAAM;oBAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;gBACjD,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,CAAA;gBACzC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI;oBAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,CAAA;gBAC3E,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,IAAgB,EAAE,OAAO,EAAE,WAAW,EAAE,CAAA;YAC9E,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;YACtC,CAAC;QACH,CAAC;QAED,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,eAAe;YAC1C,MAAM,OAAO,GAAG,eAAe,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAA;YACvE,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;YAEtD,MAAM,QAAQ,GAA4B,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAA;YAChE,MAAM,QAAQ,GAAG,IAAI,KAAK,IAAI;gBAC5B,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC;gBAC5E,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAE,CAAA;YAEzB,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAA;QAC/C,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,SAAS;YACrB,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;gBACnD,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;YAC9C,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,KAAK,CAAC,aAAa,CAAC,SAAS;YAC3B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;gBAC/C,OAAO,MAAM,EAAE,MAAM,IAAI,IAAI,CAAA;YAC/B,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;KACF,CAAA;AACH,CAAC"}

package/dist/plugin/goal.d.ts

@@ -1,13 +1,14 @@
-import type { ToolContext, ToolResult } from "@opencode-ai/plugin";
-import { createOpencodeClient } from "@opencode-ai/sdk/v2";
-import type { Session } from "@opencode-ai/sdk/v2";
+import type { GoalSession, GoalStore } from "./goal-store.js";
 export type GoalStatus = "active" | "paused" | "complete";
-/** 用户最后使用的会话配置快照：续接注入时显式传回，防止 idle 后回落/切换默认 agent 与模型 */
+/** 用户最后使用的会话配置快照：续接注入时显式传回，防止回落/切换默认 agent 与模型 */
 export interface GoalSessionProfile {
     agent: string;
+    /** V1 存量语义：{providerID, modelID}；V2 新写入为 {providerID, id, variant?}，读取时两种都接受 */
     model?: {
         providerID: string;
-        modelID: string;
+        modelID?: string;
+        id?: string;
+        variant?: string;
     };
 }
 /** 最小化 goal（§10.2）：目标与验收条件从 Flow Record（Parent Issue body）读取 */
@@ -15,15 +16,15 @@ export interface GoalData {
     parentIssueNumber: number;
     status: GoalStatus;
     continuationCount: number;
-    /** 用户最后使用的 agent/模型（create 或用户消息时快照） */
+    /** 用户最后使用的 agent/模型（create 或用户切换时快照） */
     sessionProfile?: GoalSessionProfile;
     /** 可选 token 预算（护栏）：tokensUsed 达限后自动 pause，防止长跑成本失控 */
     tokenBudget?: number;
-    /** 已用 token（快照法：最新完成 assistant 轮 input+cache.read+output − baseline，单调不减） */
+    /** 已用 token（会话累计快照 − baseline，单调不减；护栏非账单） */
     tokensUsed?: number;
-    /** 记账基线：create 时点最新完成 assistant 轮的快照（compaction 不做分段，护栏非账单） */
+    /** 记账基线：create 时点的会话累计 token 快照 */
     tokensBaseline?: number;
-    /** goal 创建时刻（ms）：记账基线初始化与诊断用 */
+    /** goal 创建时刻（ms）：记账基线与诊断用 */
     createdAt?: number;
     /** 状态原因：'resumed' 是 UI/resume 的 kickoff 信号（首次 tick 豁免 blocked 检测后消费清除） */
     statusReason?: string;
@@ -31,11 +32,22 @@ export interface GoalData {
 export declare function createGoal(parentIssueNumber: number, sessionProfile?: GoalSessionProfile, tokenBudget?: number): GoalData;
 export declare function canTransitionTo(goal: GoalData, target: GoalStatus): boolean;
 export declare function formatGoal(goal: GoalData): string;
+/** 把存储的 profile.model（V1/V2 两种形状）归一为 V2 的 ModelRef；无法识别时返回 null */
+export declare function normalizeProfileModel(model: {
+    providerID?: string;
+    modelID?: string;
+    id?: string;
+    variant?: string;
+} | undefined): {
+    providerID: string;
+    id: string;
+    variant?: string;
+} | null;
 export declare const MAX_CONTINUATIONS = 50;
 /**
- * 单条消息的 token 快照 = input + reasoning + cache.read + output。
- * 与 OpenChamber 记账同源：OpenCode 每轮的 cache.read 已含此前所有轮次付费 token，
- * 最新完成轮的快照即整段成本，无需跨消息求和。reasoning 也计费，护栏方向偏严。
+ * token 快照 = input + reasoning + cache.read + output。
+ * OpenCode 每轮的 cache.read 已含此前所有轮次付费 token，
+ * 最新快照即整段成本，无需跨消息求和。reasoning 也计费，护栏方向偏严。
  */
 export declare function snapshotTokenTotal(tokens: unknown): number;
 /** token 预算护栏：达到或超过预算即应暂停（null 表示未设预算） */
@@ -53,39 +65,84 @@ export declare function isBlockedReport(text: string): boolean;
 export declare const DONE_REPORT_RE: RegExp;
 export declare function isDoneReport(text: string): boolean;
 export declare function continuationPrompt(parentIssueNumber: number): string;
-export declare function createGoalClient(serverUrl: URL, v1Client: any): import("@opencode-ai/sdk/v2").OpencodeClient;
-export declare function readGoal(client: ReturnType<typeof createOpencodeClient>, sessionID: string): Promise<{
-    goal: GoalData | null;
-    session: Session | null;
-}>;
-export declare function writeGoal(client: ReturnType<typeof createOpencodeClient>, sessionID: string, goal: GoalData | null, existingSession?: Session | null): Promise<void>;
 /**
  * 带锁的 goal 读-改-写单一入口：同一 sessionID 的操作串行，杜绝并发丢失更新。
- * fn 接收当前 goal 与 session，返回写回的 goal（null 表示删除）与调用方结果 value。
+ * fn 接收当前 goal 与宿主会话，返回写回的 goal（null 表示删除）与调用方结果 value。
  * 当前无 goal 且 fn 也返回 null 时跳过写回（避免对不存在 goal 的无谓删除/写入）。
  */
-export declare function mutateGoal<T>(client: ReturnType<typeof createOpencodeClient>, sessionID: string, fn: (goal: GoalData | null, session: Session | null) => Promise<{
+export declare function mutateGoal<T>(store: GoalStore, sessionID: string, fn: (goal: GoalData | null, session: GoalSession | null) => Promise<{
     goal: GoalData | null;
     value: T;
 }>): Promise<T>;
-export declare function createGoalTool(client: ReturnType<typeof createOpencodeClient>, projectDirFallback?: string): {
+/** goal 工具执行时可见的 context 最小面（V2 ToolContext 子集） */
+export interface GoalToolContext {
+    sessionID: string;
+    agent?: string;
+}
+export interface GoalToolInput {
+    op: "create" | "get" | "complete" | "resume" | "cancel" | "pause" | "edit";
+    parent_issue_number?: number;
+    token_budget?: number;
+}
+export interface GoalToolResult {
+    content: string;
+}
+/**
+ * goal 工具的允许名单（与权限规则层一致）。
+ * 规则层通过 agent permissions 隐藏/放行工具；此处的检查是工具级兜底，
+ * 覆盖规则层未覆盖的 agent（例如后续新注册的 agent）。
+ */
+export declare const GOAL_ALLOWED_AGENTS: Set<string>;
+export declare const GOAL_TOOL_INPUT_SCHEMA: {
+    readonly type: "object";
+    readonly properties: {
+        readonly op: {
+            readonly type: "string";
+            readonly enum: readonly ["create", "get", "complete", "resume", "cancel", "pause", "edit"];
+            readonly description: "Goal operation";
+        };
+        readonly parent_issue_number: {
+            readonly type: "number";
+            readonly description: "Parent GitHub Issue number of the Flow Record (required for create; editable via edit)";
+        };
+        readonly token_budget: {
+            readonly type: "number";
+            readonly description: "Optional token budget guardrail; goal auto-pauses when tokensUsed reaches it. Pass 0 via edit to remove the budget";
+        };
+    };
+    readonly required: readonly ["op"];
+    readonly additionalProperties: false;
+};
+export declare const GOAL_TOOL_DESCRIPTION = "Manage the active goal-mode objective (minimal: parentIssueNumber/status/continuationCount).\n\nUse a single op field:\n- create: starts a goal bound to a Flow Record. Requires parent_issue_number.\n- get: returns the current goal.\n- resume: re-activates a paused goal.\n- cancel: discards the current goal.\n- pause: pauses the active goal.\n- complete: marks the goal as completed. Follow the returned instructions.";
+/**
+ * 构建 goal 工具描述符：{name, description, input(JSON Schema), options, execute}。
+ * execute 返回 {content}（V2 Tool.Result 形状）；授权在工具内自检（见 GOAL_ALLOWED_AGENTS）。
+ */
+export declare function buildGoalTool(store: GoalStore, projectDir: string): {
+    name: string;
     description: string;
-    args: {
-        op: import("zod").ZodEnum<{
-            complete: "complete";
-            create: "create";
-            get: "get";
-            resume: "resume";
-            cancel: "cancel";
-            pause: "pause";
-            edit: "edit";
-        }>;
-        parent_issue_number: import("zod").ZodOptional<import("zod").ZodNumber>;
-        token_budget: import("zod").ZodOptional<import("zod").ZodNumber>;
+    input: {
+        readonly type: "object";
+        readonly properties: {
+            readonly op: {
+                readonly type: "string";
+                readonly enum: readonly ["create", "get", "complete", "resume", "cancel", "pause", "edit"];
+                readonly description: "Goal operation";
+            };
+            readonly parent_issue_number: {
+                readonly type: "number";
+                readonly description: "Parent GitHub Issue number of the Flow Record (required for create; editable via edit)";
+            };
+            readonly token_budget: {
+                readonly type: "number";
+                readonly description: "Optional token budget guardrail; goal auto-pauses when tokensUsed reaches it. Pass 0 via edit to remove the budget";
+            };
+        };
+        readonly required: readonly ["op"];
+        readonly additionalProperties: false;
+    };
+    options: {
+        permission: string;
     };
-    execute(args: {
-        op: "complete" | "create" | "get" | "resume" | "cancel" | "pause" | "edit";
-        parent_issue_number?: number | undefined;
-        token_budget?: number | undefined;
-    }, context: ToolContext): Promise<ToolResult>;
+    execute(args: GoalToolInput, context: GoalToolContext): Promise<GoalToolResult>;
 };