Skip to content

Commit dfeb1b5

Browse files
authored
feat(client): generate complete protocol client (anomalyco#34164)
1 parent 61a7f6d commit dfeb1b5

11 files changed

Lines changed: 2614 additions & 201 deletions

File tree

‎packages/client/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Private generation target for clients derived directly from OpenCode's authorita
77
- `@opencode-ai/client`: zero-Effect Promise client using `fetch`.
88
- `@opencode-ai/client/effect`: rich Effect network client using an environment-provided `HttpClient`.
99

10-
The generated surface starts with the Session group from Server's concrete API. The build compiler reads `@opencode-ai/server/api`; the generated Effect runtime imports a client-local projection built from Protocol, with a generation-equivalence test preventing transport drift. Run `bun run generate` after changing the contract and `bun run check:generated` to detect committed-output drift.
10+
The generated surface includes every standard HTTP group from Server's concrete API. The build compiler reads `@opencode-ai/server/api`; the generated Effect runtime imports a client-local projection built from Protocol, with a generation-equivalence test preventing transport drift. Custom transports such as the PTY WebSocket connection remain outside the generic HTTP client. Run `bun run generate` after changing the contract and `bun run check:generated` to detect committed-output drift.
1111

1212
The Effect entrypoint uses canonical decoded values such as `Session.ID`, `Location.Ref`, and `Prompt`. These datatypes come from the lightweight `@opencode-ai/schema` package and are re-exported so callers depend only on the client surface. Protocol owns endpoint construction and middleware placement; Server supplies the concrete middleware keys used by the build-time API.
1313

‎packages/client/script/build.ts‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
import { NodeFileSystem } from "@effect/platform-node"
22
import { compile, emitEffectImported, emitPromise, write } from "@opencode-ai/httpapi-codegen"
3-
import { ClientApi } from "../src/contract"
3+
import { ClientApi, endpointNames, groupNames, omitEndpoints } from "../src/contract"
44
import { Effect } from "effect"
55
import { fileURLToPath } from "url"
66

7-
const contract = compile(ClientApi, {
8-
groupNames: { "server.session": "sessions", "server.event": "events" },
9-
})
7+
const contract = compile(ClientApi, { groupNames, endpointNames, omitEndpoints })
108

119
await Effect.runPromise(
1210
Effect.all(

‎packages/client/src/contract.ts‎

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { makeDefaultApi } from "@opencode-ai/protocol/api"
22
import { InvalidRequestError, SessionNotFoundError } from "@opencode-ai/protocol/errors"
3-
import { HttpApi, HttpApiMiddleware } from "effect/unstable/httpapi"
3+
import { HttpApiMiddleware } from "effect/unstable/httpapi"
44

55
class LocationMiddleware extends HttpApiMiddleware.Service<LocationMiddleware>()(
66
"@opencode-ai/client/LocationMiddleware",
@@ -11,11 +11,43 @@ class SessionLocationMiddleware extends HttpApiMiddleware.Service<SessionLocatio
1111
{ error: [InvalidRequestError, SessionNotFoundError] },
1212
) {}
1313

14-
const Api = makeDefaultApi({
14+
export const ClientApi = makeDefaultApi({
1515
locationMiddleware: LocationMiddleware,
1616
sessionLocationMiddleware: SessionLocationMiddleware,
1717
})
1818

19-
export const SessionGroup = Api.groups["server.session"]
20-
export const EventGroup = Api.groups["server.event"]
21-
export const ClientApi = HttpApi.make("opencode-client").add(SessionGroup).add(EventGroup)
19+
export const groupNames = {
20+
"server.health": "health",
21+
"server.location": "location",
22+
"server.agent": "agents",
23+
"server.session": "sessions",
24+
"server.message": "messages",
25+
"server.model": "models",
26+
"server.provider": "providers",
27+
"server.integration": "integrations",
28+
"server.credential": "credentials",
29+
"server.permission": "permissions",
30+
"server.fs": "files",
31+
"server.command": "commands",
32+
"server.skill": "skills",
33+
"server.event": "events",
34+
"server.pty": "ptys",
35+
"server.question": "questions",
36+
"server.reference": "references",
37+
"server.projectCopy": "projectCopies",
38+
} as const
39+
40+
export const endpointNames = {
41+
"session.messages": "list",
42+
"integration.connect.key": "connectKey",
43+
"integration.connect.oauth": "connectOauth",
44+
"integration.attempt.status": "attemptStatus",
45+
"integration.attempt.complete": "attemptComplete",
46+
"integration.attempt.cancel": "attemptCancel",
47+
"permission.request.list": "listRequests",
48+
"permission.saved.list": "listSaved",
49+
"permission.saved.remove": "removeSaved",
50+
"question.request.list": "listRequests",
51+
} as const
52+
53+
export const omitEndpoints = new Set(["fs.read", "pty.connect", "pty.connectToken"])

‎packages/client/src/effect.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,24 @@
22
// Core or Server. Preserve these datatype exports so internal model reorganizations do not require caller migrations.
33
export * from "./generated-effect/index"
44
export { Agent } from "@opencode-ai/schema/agent"
5+
export { Command } from "@opencode-ai/schema/command"
6+
export { Credential } from "@opencode-ai/schema/credential"
7+
export { FileSystem } from "@opencode-ai/schema/filesystem"
8+
export { Integration } from "@opencode-ai/schema/integration"
59
export { Location } from "@opencode-ai/schema/location"
610
export { Model } from "@opencode-ai/schema/model"
11+
export { Permission } from "@opencode-ai/schema/permission"
12+
export { PermissionSaved } from "@opencode-ai/schema/permission-saved"
13+
export { Project } from "@opencode-ai/schema/project"
14+
export { ProjectCopy } from "@opencode-ai/schema/project-copy"
715
export { Provider } from "@opencode-ai/schema/provider"
16+
export { Pty } from "@opencode-ai/schema/pty"
17+
export { Question } from "@opencode-ai/schema/question"
18+
export { Reference } from "@opencode-ai/schema/reference"
819
export { AbsolutePath, RelativePath } from "@opencode-ai/schema/schema"
920
export { Session } from "@opencode-ai/schema/session"
1021
export { SessionInput } from "@opencode-ai/schema/session-input"
1122
export { SessionMessage } from "@opencode-ai/schema/session-message"
23+
export { Skill } from "@opencode-ai/schema/skill"
1224
export { Prompt } from "@opencode-ai/schema/prompt"
1325
export type { OpenCodeEvent } from "@opencode-ai/protocol/groups/event"

0 commit comments

Comments
 (0)