Agent Skills › openchamber/openchamber › ui-api-decoupling

ui-api-decoupling

GitHub

规范前端UI与后端API的解耦架构,定义OpenCode SDK、RuntimeAPIs及运行时适配器的边界。强制在修改用户可达行为前梳理多端(Web/桌面/插件)表面状态,确保传输层与领域逻辑分离,避免硬编码和跨层耦合。

.agents/skills/ui-api-decoupling/SKILL.md openchamber/openchamber

Trigger Scenarios

创建或修改共享UI数据访问逻辑 调整RuntimeAPIs或运行时代理 处理浏览器认证资产或URL路由 实现新的API路由或服务端接口

Install

npx skills add openchamber/openchamber --skill ui-api-decoupling -g -y
More Options

Non-standard path

npx skills add https://github.com/openchamber/openchamber/tree/main/.agents/skills/ui-api-decoupling -g -y

Use without installing

npx skills use openchamber/openchamber@ui-api-decoupling

指定 Agent (Claude Code)

npx skills add openchamber/openchamber --skill ui-api-decoupling -a claude-code -g -y

安装 repo 全部 skill

npx skills add openchamber/openchamber --all -g -y

预览 repo 内 skill

npx skills add openchamber/openchamber --list

SKILL.md

Frontmatter
{
    "name": "ui-api-decoupling",
    "description": "Use when creating or modifying OpenChamber shared UI data access, OpenCode SDK calls, `RuntimeAPIs`, runtime fetch\/auth\/URLs, authenticated browser assets, bridges\/proxies, runtime switching, or server API routes."
}

UI API Decoupling

Core Boundary

  • Official OpenCode API calls use @opencode/client (OpenCode 2.x, /api/* routes) through opencodeClient; only packages/ui/src/lib/opencode/ may see wire types, everything else uses the domain model in lib/opencode/model.ts.
  • OpenChamber-owned HTTP capabilities use RuntimeAPIs where runtime-specific behavior exists, otherwise explicit OpenChamber routes through runtimeFetch.
  • Browser/realtime consumers use shared runtime URL/socket helpers.
  • Shared UI never hardcodes localhost, ports, API origins, credentials, or one runtime's transport assumptions.
  • Treat runtime adapters as the imperative shell: they own transport, auth, serialization, and platform mechanics. Shared feature code receives trusted contracts and owns domain decisions.

Classify First

Need Correct path
Official OpenCode endpoint opencodeClient or its SDK client
SDK gap for official OpenCode Narrow documented wrapper in opencodeClient preserving request fidelity
OpenChamber HTTP route runtimeFetch('/api/...')
Runtime-owned capability Extend RuntimeAPIs and implement each applicable runtime
Browser-owned authenticated URL Runtime URL resolver and scoped URL auth
SSE/WebSocket Owning realtime transport; also load relay-transport

Name The Surfaces Before Editing

Before writing code that changes what a user can reach or do, write the surface list: every runtime this behavior exists on, and one line per runtime saying what happens there. Runtimes are web, Electron desktop, VS Code, hosted mobile, and Capacitor mobile.

The step is done when no runtime is missing a line. "Not applicable" is a line; silence is not. A stable unsupported response is a valid outcome, an accidental fallthrough is not.

Carry the list into the pull request description, which asks for the same table. It is the same artifact: written once while deciding, restated once while handing off. A surface you cannot answer for is the finding — say so in the list rather than leaving the row blank.

This applies to any user-reachable behavior, not only shared UI data access. A sequence that spans native shell, server, and renderer has surfaces too; so does a capability that only one runtime implements today.

Load References By Task

Task Required reference
Iframes, downloads, raw images, object URLs, URL tokens references/browser-assets-and-auth.md
Adding runtime capabilities, VS Code behavior, Electron privilege/security, unsupported runtime behavior references/runtime-parity.md
Locating implementations, route registration, runtime switching, or focused tests references/implementation-map.md

Load every matching reference before editing.

Mandatory Rules

  1. Do not bypass the SDK for official OpenCode APIs. Preserve SDK-generated method, body, headers, query, auth, and abort signal.
  2. Keep OpenChamber routes explicit. Register them before the generic OpenCode proxy.
  3. Use runtime APIs for runtime-owned capabilities. Components consume hooks/providers, not runtime globals.
  4. Resolve runtime state at call time. Do not cache runtime base URLs, resolver output, credentials, or SDK clients across endpoint switches.
  5. Let transport own auth. HTTP uses runtime bearer handling; browser/realtime URLs use scoped short-lived URL auth where headers are impossible.
  6. Never put long-lived client credentials in URLs. Do not manually append URL tokens.
  7. Define runtime parity explicitly. Shared UI needs deliberate web, Electron, VS Code, hosted-mobile, and Capacitor behavior or stable unsupported responses.
  8. Authoritative fetches must signal failure. Do not convert failure into a valid empty value that callers use to clear state.
  9. Keep privileges at the native/runtime boundary. UI visibility and prompts are not authorization.
  10. Confirm trust-boundary mutations. Host imports, credential writes, privileged deep links, and runtime switching require explicit user intent.
  11. Parse at the boundary. Treat external, persisted, bridge, IPC, and network payloads as unknown until a schema, parser, or narrow constructor produces the trusted type consumed by shared code. Do not validate fields and then continue passing the raw payload.
  12. Model the real contract. Prefer precise result/state unions and required dependencies over loose strings, boolean combinations, optional callback bags, any, or repeated casts. Make unsupported runtime behavior and failure distinct from valid empty success.
  13. Keep adapters deep and bridges thin. Hide meaningful protocol or platform mechanics behind an intention-revealing runtime operation; do not add pass-through layers that only rename SDK, fetch, or bridge calls.

HTTP Decision Rules

Pass route paths directly to runtimeFetch:

await runtimeFetch('/health');
await runtimeFetch('/api/config/settings');
await runtimeFetch('/api/fs/raw', { query: { path } });

Do not immediately fetch a URL produced by getRuntimeUrlResolver(). Use the resolver only when the browser/realtime API itself consumes the URL:

const imageSrc = getRuntimeUrlResolver().authenticatedAsset('/api/fs/raw?path=diagram.png');
const eventUrl = getRuntimeUrlResolver().sse('/api/event');

Plain fetch is reserved for intentional external origins that are not the active OpenChamber/OpenCode runtime.

Runtime Switch Safety

Review runtime base URL, auth, SDK clients, terminal/realtime transports, stores, session memory, and caches. Key caches by runtime identity where IDs, paths, or URLs can collide. Reset or reconnect affected state through the established runtime-switch flow.

Re-parse values obtained after a switch at their owning boundary. A type established for one runtime response does not make cached raw data from another runtime trustworthy.

Common Anti-Patterns

Avoid Use
Raw feature fetch to official OpenCode SDK wrapper/client
Component reads runtime globals useRuntimeAPIs() / provider
Hardcoded runtime URL runtimeFetch or runtime URL resolver
Browser URL containing bearer/client token Scoped URL-auth helper
Web-only shared route Explicit VS Code/mobile decision
Returning [] after authoritative fetch failure Throw or distinct failure result
Rebuilding SDK Request from URL only Preserve original request body/headers/signal
Component validates unknown JSON then passes it onward Adapter parses once and returns a trusted contract
Boolean/nullable combinations for exclusive outcomes Discriminated result or state union

Verification

  • Official calls use SDK paths or documented SDK-gap wrappers.
  • OpenChamber routes win before generic proxy fallback.
  • Request fidelity, auth, abort, query, and body behavior are tested.
  • Browser/realtime auth uses narrow allowlists and scoped tokens.
  • Every applicable runtime has implementation or explicit unsupported behavior, and the surface list written before editing has a line for each.
  • Runtime switching cannot reuse stale endpoint/auth/cache state.
  • Privileged Electron/extension behavior is enforced outside the renderer.
  • Focused transport, bridge, proxy, auth, and runtime tests pass; static type/lint checks alone are insufficient.

Version History

  • 1f0004f Current 2026-09-28 05:11

    将OpenChamber迁移至OpenCode 2.x,SDK调用从v1 HTTP API更新为@opencode/client 2.0.3,并同步更新了API路径和客户端引用规范。

  • 336e192 2026-09-22 17:58

    引入强制性的运行时行为清单步骤,要求PR必须包含Live-run声明以验证实际效果;将抽象的一致性规则转化为具体的检查动作。

  • 2db90f7 2026-08-20 04:55

    新增browser-assets-and-auth.md参考文档;移除预览代理逻辑,采用真实Chromium视图替代。

  • 74b1bd8 2026-07-25 10:37

Same Skill Collection

.agents/skills/changelog-authoring/SKILL.md
.agents/skills/clack-cli-patterns/SKILL.md
.agents/skills/communication-style/SKILL.md
.agents/skills/desktop-shell/SKILL.md
.agents/skills/drag-to-reorder/SKILL.md
.agents/skills/isolated-space-boundary/SKILL.md
.agents/skills/locale-ui-patterns/SKILL.md
.agents/skills/openchamber-change-discipline/SKILL.md
.agents/skills/opencode-v2/SKILL.md
.agents/skills/performance-engineering/SKILL.md
.agents/skills/pr-review/SKILL.md
.agents/skills/relay-transport/SKILL.md
.agents/skills/serve-sim/SKILL.md
.agents/skills/settings-ui-patterns/SKILL.md
.agents/skills/sync-state-invariants/SKILL.md
.agents/skills/theme-system/SKILL.md
.agents/skills/triage-issues/SKILL.md
.agents/skills/triage-prs/SKILL.md
.agents/skills/update-changelog/SKILL.md
.agents/skills/writing-for-agents/SKILL.md

Metadata

Files
0
Version
1f0004f
Hash
e21719d9
Indexed
2026-07-25 10:37

ホーム - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-09-30 21:59
浙ICP备14020137号-1