deskbuddy 0.0.1 → 0.2.0-beta.0

package/hook/opencode.d.mts

@@ -0,0 +1,7 @@
+// hook/opencode.mjs 的类型声明（只给测试用；插件本体是零依赖 JS，跑在 opencode 自带的 bun 里）
+export function isHeadless(argv?: string[]): boolean
+export function toCcTool(tool: string, args: unknown): { tool_name: string; tool_input: Record<string, unknown> }
+export function askToCc(props: unknown): { tool_name: string; tool_input: Record<string, unknown> }
+export function openPermissions(cfg: unknown): void
+export const OC_GATED_KEYS: string[]
+export function make(opts?: { node?: string }): (ctx: unknown) => Promise<Record<string, unknown>>

package/hook/opencode.mjs

@@ -0,0 +1,329 @@
+// DeskBuddy 的 opencode 插件本体（二期 P9）。
+// `deskbuddy enable opencode` 在 opencode 的插件目录放一个入口文件 import 本文件；
+// 本文件随 hook.cjs / gate.cjs 一起同步到 ~/.deskbuddy/，CLI 升级即生效。
+//
+// 做的事只有翻译：把 opencode 的事件翻成 cc-hook 同构的输入，喂给同目录的 hook.cjs（状态上报）
+// 和 gate.cjs（授权关卡）。状态机、关卡、和设备打交道全在它们和 daemon 里，这里不重复。
+//
+// 实测依据（opencode 1.18.32；1.4.3 远程关卡与窗口确认同样实测通过，spec 2026-09-27-DeskBuddy二期 §P9 O1–O8）：
+// - 插件的 `permission.ask` 钩子不会被调用；授权只能从事件流的 permission.asked / permission.replied 拿
+// - `tool.execute.before` 在权限判断之前触发、可以 await 任意久、抛错 = 这次调用失败
+// - `opencode run` 遇到 ask 立即自动拒绝
+// - `config` 钩子原地改 permission 能生效（整对象替换不行）
+//
+// 🔴 远程任务（环境变量 DESKBUDDY_GATE_RUN）的安全模型，三层：
+//    ① daemon 起进程前确认插件装在 opencode 会读的位置（daemon/index.ts）；
+//    ② OPENCODE_CONFIG_CONTENT 把 OC_GATED_KEYS 逐项压成 deny（全局 + build agent 两级）。
+//       opencode 按"最后一条匹配的规则"生效且配置是深合并：只写 `*: deny` 挡不住用户配置里排在后面的
+//       `bash: allow`（评审 2026-09-28 实测），逐项写才会把同名键的值覆盖掉；
+//    ③ 本插件加载后才在 config 里放开、并在 tool.execute.before 里等设备。
+//    残余：用户给清单外的权限名写了 allow，且插件恰好加载失败 —— 那一项会放行。远程模式下本文件任何失败都必须走"拒绝"。
+// 🔴 窗口模式反过来：任何失败都不表态，授权框照常由人处理。
+
+import { spawn } from 'node:child_process'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const HERE = dirname(fileURLToPath(import.meta.url))
+const HOOK = join(HERE, 'hook.cjs')
+const GATE = join(HERE, 'gate.cjs')
+const TOOL = 'opencode'
+
+/** 设备允许过的工具调用，后续同一调用的第二个授权框直接代答（O6：rm /tmp/x 会连问 external_directory 和 bash） */
+const APPROVED_CALL_TTL_MS = 60 * 1000
+/** 工具调用参数的缓存时长：tool.execute.before 记下，随后的授权框靠它显示真实命令 */
+const CALL_TTL_MS = 10 * 60 * 1000
+/** hook.cjs 自己有 2 秒上报超时，这里再兜一层：一次卡死不能堵住后面所有状态 */
+const HOOK_KILL_MS = 10 * 1000
+
+/**
+ * 远程模式要压成 deny、插件加载后再放开的权限名。与 src/daemon/executor.ts 的 OPENCODE_GATED_KEYS 必须一致（有测试）。
+ * 新版本 opencode 多出来的权限名不在这里时，只剩 `*` 兜，见顶部"残余"
+ */
+export const OC_GATED_KEYS = [
+  '*', 'bash', 'edit', 'write', 'read', 'glob', 'grep', 'list', 'task', 'webfetch', 'websearch', 'codesearch',
+  'external_directory', 'todowrite', 'todoread', 'lsp', 'skill', 'doom_loop', 'patch', 'apply_patch',
+]
+
+function runIdFromEnv() {
+  const v = process.env.DESKBUDDY_GATE_RUN || ''
+  return /^[0-9a-zA-Z_-]{1,64}$/.test(v) ? v : ''
+}
+
+/**
+ * `opencode run` 是非交互（O2），其余（TUI、`opencode <目录>`）当窗口。编译版 argv = [bun, 入口, 子命令…]。
+ * 子命令前可能有全局参数（`--print-logs run`），所以看 `--` 之前有没有 `run`；误判成非交互只是少一个确认渠道
+ */
+export function isHeadless(argv = process.argv) {
+  const args = argv.slice(2)
+  const end = args.indexOf('--')
+  return (end >= 0 ? args.slice(0, end) : args).includes('run')
+}
+
+/** opencode 工具 → cc-hook 同构的 tool_name / tool_input（daemon 的 classify 按 Claude Code 的工具名判断） */
+export function toCcTool(tool, args) {
+  const a = args && typeof args === 'object' ? args : {}
+  const s = (v) => (typeof v === 'string' ? v : '')
+  switch (tool) {
+    case 'bash':
+      return { tool_name: 'Bash', tool_input: { command: s(a.command) } }
+    case 'read':
+      return { tool_name: 'Read', tool_input: { file_path: s(a.filePath) } }
+    case 'edit':
+      return { tool_name: 'Edit', tool_input: { file_path: s(a.filePath) } }
+    case 'write':
+      return { tool_name: 'Write', tool_input: { file_path: s(a.filePath) } }
+    case 'glob':
+      return { tool_name: 'Glob', tool_input: { pattern: s(a.pattern), path: s(a.path) } }
+    case 'grep':
+      return { tool_name: 'Grep', tool_input: { pattern: s(a.pattern), path: s(a.path) } }
+    case 'list':
+      return { tool_name: 'LS', tool_input: { path: s(a.path) } }
+    case 'webfetch':
+      return { tool_name: 'WebFetch', tool_input: { url: s(a.url) } }
+    case 'task':
+      return { tool_name: 'Task', tool_input: {} }
+    case 'todowrite':
+    case 'todoread':
+      return { tool_name: 'TodoWrite', tool_input: {} }
+    case 'patch':
+    case 'apply_patch':
+      return { tool_name: 'apply_patch', tool_input: { patch: s(a.patchText) || s(a.patch) || s(a.input) } }
+    default:
+      // 不认识的工具（MCP 等）原名原参数交出去：classify 对不认识的一律推设备
+      return { tool_name: String(tool || ''), tool_input: a }
+  }
+}
+
+/** permission.asked → PermissionRequest 的 tool_name / tool_input，给设备卡片生成摘要 */
+export function askToCc(props) {
+  const md = (props && props.metadata) || {}
+  if (typeof md.command === 'string' && md.command) return { tool_name: 'Bash', tool_input: { command: md.command } }
+  const file = md.filepath || md.filePath
+  if (typeof file === 'string' && file) return { tool_name: 'Edit', tool_input: { file_path: file } }
+  const patterns = Array.isArray(props && props.patterns) ? props.patterns.join(' ') : ''
+  return { tool_name: String((props && props.permission) || 'permission'), tool_input: { path: patterns } }
+}
+
+/**
+ * 远程模式：关卡改由 tool.execute.before 把，放开权限。🔴 必须原地改（整对象替换不生效，O8）。
+ * - OC_GATED_KEYS 是 daemon 压成 deny 的，放成 allow（用户原来在这些键上写的值已被覆盖，找不回来 —— 每一步都要过设备）
+ * - 其余键上的 ask 放成 allow（run 下 ask = 立即拒），用户显式的 deny 保留
+ * 全局与 build agent 两级都放（daemon 两级都压了）
+ */
+export function openPermissions(cfg) {
+  if (!cfg || typeof cfg !== 'object') return
+  const open = (perm) => {
+    const walk = (obj) => {
+      for (const k of Object.keys(obj)) {
+        const v = obj[k]
+        if (v === 'ask') obj[k] = 'allow'
+        else if (v && typeof v === 'object') walk(v)
+      }
+    }
+    walk(perm)
+    for (const k of OC_GATED_KEYS) perm[k] = 'allow'
+  }
+  if (!cfg.permission || typeof cfg.permission !== 'object') cfg.permission = {}
+  open(cfg.permission)
+  const build = cfg.agent && cfg.agent.build
+  if (build && build.permission && typeof build.permission === 'object') open(build.permission)
+}
+
+/** 活着的子进程；opencode 退出时一并结束，不留孤儿 gate 挂着设备卡片（评审） */
+const LIVE = new Set()
+process.on('exit', () => {
+  for (const c of LIVE) {
+    try {
+      c.kill('SIGTERM')
+    } catch (_) {
+      /* 已经退了 */
+    }
+  }
+})
+
+/** 起 node 子进程跑 hook.cjs / gate.cjs，stdin 喂 JSON。返回子进程句柄与结束结果（起不来 = code -1）。killMs > 0 时到点结束 */
+function startChild(node, script, args, input, killMs = 0) {
+  let child = null
+  const done = new Promise((resolve) => {
+    let out = ''
+    let err = ''
+    try {
+      child = spawn(node, [script, ...args], { stdio: ['pipe', 'pipe', 'pipe'] })
+    } catch (e) {
+      resolve({ code: -1, out, err: String(e) })
+      return
+    }
+    LIVE.add(child)
+    const timer = killMs > 0 ? setTimeout(() => child.kill('SIGKILL'), killMs) : null
+    const finish = (r) => {
+      LIVE.delete(child)
+      if (timer) clearTimeout(timer)
+      resolve(r)
+    }
+    child.stdout.on('data', (c) => (out += c))
+    child.stderr.on('data', (c) => (err += c))
+    child.on('error', (e) => finish({ code: -1, out, err: String(e) }))
+    child.on('close', (code) => finish({ code, out, err }))
+    child.stdin.on('error', () => {})
+    child.stdin.end(JSON.stringify(input))
+  })
+  return { child, done }
+}
+
+const runChild = (node, script, args, input, killMs) => startChild(node, script, args, input, killMs).done
+
+export function make(opts = {}) {
+  return async function DeskBuddy(ctx) {
+    const node = process.env.DESKBUDDY_NODE || opts.node || 'node'
+    const client = ctx && ctx.client
+    const cwd = (ctx && (ctx.directory || ctx.worktree)) || process.cwd()
+    const runId = runIdFromEnv()
+    const headless = isHeadless()
+
+    // ---- 状态上报：串行喂 hook.cjs，保证 PreToolUse / PostToolUse / Stop 的先后 ----
+    let queue = Promise.resolve()
+    const report = (event, sessionID, extra) => {
+      if (!sessionID) return
+      const input = { hook_event_name: event, session_id: sessionID, cwd, ...extra }
+      queue = queue.then(() => runChild(node, HOOK, [TOOL], input, HOOK_KILL_MS)).catch(() => {})
+    }
+
+    // ---- 窗口确认 ----
+    const pending = new Map() // requestID → gate 子进程
+    const approvedCalls = new Map() // callID → 允许时间
+    const calls = new Map() // callID → { cc, at }：这次工具调用的真实参数
+    const prune = () => {
+      const now = Date.now()
+      for (const [k, v] of calls) if (now - v.at > CALL_TTL_MS) calls.delete(k)
+      for (const [k, at] of approvedCalls) if (now - at > APPROVED_CALL_TTL_MS) approvedCalls.delete(k)
+    }
+
+    const reply = async (sessionID, id, response) => {
+      try {
+        await client.postSessionIdPermissionsPermissionId({ path: { id: sessionID, permissionID: id }, body: { response } })
+      } catch (_) {
+        /* 已被人答复过等，无所谓 */
+      }
+    }
+
+    const toast = async (message) => {
+      try {
+        await client.tui.showToast({ body: { message, variant: 'info' } })
+      } catch (_) {
+        /* 没有 TUI（web / acp）就不提示 */
+      }
+    }
+
+    const onAsked = async (p) => {
+      const { id, sessionID } = p || {}
+      if (!id || !sessionID) return
+      prune()
+      const callID = p.tool && p.tool.callID
+      // 🔴 卡片用这次工具调用的真实参数（tool.execute.before 先于授权触发，O3）。
+      //    external_directory 的 ask 自己不带命令，按它出卡片设备只看到"访问 /tmp/*"（评审）
+      const call = callID ? calls.get(callID) : null
+      const cc = call ? call.cc : askToCc(p)
+      report('PermissionRequest', sessionID, cc)
+      if (runId || headless || !client) return
+      // 同一调用的后续授权框直接代答：只在设备那张卡显示的就是真实参数时（approvedCalls 只在那时写入）
+      const at = callID && approvedCalls.get(callID)
+      if (at && Date.now() - at < APPROVED_CALL_TTL_MS) {
+        await reply(sessionID, id, 'once')
+        return
+      }
+      const input = { hook_event_name: 'PermissionRequest', session_id: sessionID, cwd, ...cc }
+      const { child, done } = startChild(node, GATE, ['--window', '--tool', TOOL], input)
+      if (child) pending.set(id, child)
+      const r = await done
+      pending.delete(id)
+      if (r.code !== 0 || !r.out) return
+      let out
+      try {
+        out = JSON.parse(r.out)
+      } catch (_) {
+        return
+      }
+      const d = out && out.hookSpecificOutput && out.hookSpecificOutput.decision
+      if (!d) return
+      if (d.behavior === 'allow') {
+        if (callID && call) approvedCalls.set(callID, Date.now())
+        await reply(sessionID, id, 'once')
+      } else if (d.behavior === 'deny') {
+        await reply(sessionID, id, 'reject')
+      } else return
+      if (typeof out.systemMessage === 'string' && out.systemMessage) await toast(out.systemMessage)
+    }
+
+    const onReplied = (p) => {
+      // 人先在窗口里答了：结束 gate 子进程，daemon 随之撤掉设备上的卡片
+      const child = p && pending.get(p.requestID)
+      if (child) {
+        pending.delete(p.requestID)
+        try {
+          child.kill('SIGTERM')
+        } catch (_) {
+          /* 已经退了 */
+        }
+      }
+    }
+
+    return {
+      config: async (cfg) => {
+        if (runId) openPermissions(cfg)
+      },
+
+      'chat.message': async (input) => {
+        report('UserPromptSubmit', input && input.sessionID)
+      },
+
+      'tool.execute.before': async (input, output) => {
+        const cc = toCcTool(input && input.tool, output && output.args)
+        if (input && input.callID) calls.set(input.callID, { cc, at: Date.now() })
+        report('PreToolUse', input && input.sessionID, cc)
+        if (!runId) return
+        // 远程关卡：等设备。任何失败都拒（见顶部）
+        const r = await runChild(node, GATE, ['--run', runId], {
+          hook_event_name: 'PreToolUse',
+          session_id: (input && input.sessionID) || '',
+          cwd,
+          ...cc,
+        })
+        let decision = ''
+        try {
+          decision = JSON.parse(r.out).hookSpecificOutput.permissionDecision
+        } catch (_) {
+          decision = ''
+        }
+        if (r.code === 0 && decision === 'allow') return
+        throw new Error((r.err || '').trim() || '用户在设备上拒绝了这一步')
+      },
+
+      'tool.execute.after': async (input) => {
+        if (input && input.callID) calls.delete(input.callID)
+        approvedCalls.delete(input && input.callID)
+        const cc = toCcTool(input && input.tool, input && input.args)
+        report('PostToolUse', input && input.sessionID, cc)
+      },
+
+      event: async ({ event }) => {
+        const p = (event && event.properties) || {}
+        switch (event && event.type) {
+          case 'permission.asked':
+            onAsked(p).catch(() => {})
+            break
+          case 'permission.replied':
+            onReplied(p)
+            break
+          case 'session.idle':
+            report('Stop', p.sessionID)
+            break
+          case 'session.deleted':
+            report('SessionEnd', (p.info && p.info.id) || p.sessionID)
+            break
+          default:
+        }
+      },
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deskbuddy",
-  "version": "0.0.1",
+  "version": "0.2.0-beta.0",
   "description": "把 Claude Code、Codex 等 AI 编码智能体每个会话窗口的状态，实时同步到桌面硬件屏幕",
   "keywords": [
     "ai",
@@ -14,17 +14,37 @@
   "license": "UNLICENSED",
   "type": "module",
   "bin": {
-    "deskbuddy": "bin/deskbuddy.js"
+    "deskbuddy": "dist/cli.js"
   },
   "files": [
-    "bin",
+    "dist",
+    "hook",
+    "docs/INSTALL.md",
     "README.md"
   ],
+  "scripts": {
+    "build": "tsup && cp hook/hook.cjs dist/hook.cjs && cp hook/gate.cjs dist/gate.cjs && cp hook/opencode.mjs dist/opencode.mjs",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
   "engines": {
     "node": ">=18"
   },
   "repository": {
     "type": "git",
     "url": "git+https://codeup.aliyun.com/692ff191ccf3499544d9ee64/deskbuddy-cli.git"
+  },
+  "devDependencies": {
+    "@types/node": "^26.5.0",
+    "@types/ws": "^8.18.1",
+    "smol-toml": "^1.8.0",
+    "tsup": "^8.5.1",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.11"
+  },
+  "dependencies": {
+    "qrcode-terminal": "^0.12.0",
+    "ws": "^8.21.3"
   }
 }

package/bin/deskbuddy.js

@@ -1,9 +0,0 @@
-#!/usr/bin/env node
-console.log(`
-DeskBuddy CLI —— 尚未发布正式版本
-
-本包用于把 Claude Code / Codex 等 AI 编码智能体每个会话窗口的状态，
-实时同步到 DeskBuddy 桌面硬件屏幕。
-
-当前为占位版本 (0.0.1)，功能开发中。
-`)