refactor(client): namespace service exports and share the registration contract

packages/client/src/effect/index.ts

@@ -2,7 +2,6 @@
 // Core or Server. Preserve these datatype exports so internal model reorganizations do not require caller migrations.
 export * from "./generated/index"
 export { Service } from "./service.js"
-export type { Transport, ServiceOptions } from "./service.js"
 export { Agent } from "@opencode-ai/schema/agent"
 export { Command } from "@opencode-ai/schema/command"
 export { Credential } from "@opencode-ai/schema/credential"

packages/client/src/effect/service.ts

@@ -16,7 +16,7 @@ export type Transport = {
   readonly headers?: RequestInit["headers"]
 }
 
-export type ServiceOptions = {
+export type Options = {
   // Absolute path to the service registration file. Defaults to
   // opencode/service.json in the XDG state directory.
   readonly file?: string
@@ -30,21 +30,21 @@ export type ServiceOptions = {
 
 // Read-only lookup: registration file plus health check and version gate.
 // Never spawns; escalation to start() is the caller's policy.
-export const discover = Effect.fn("service.discover")(function* (options: ServiceOptions = {}) {
-  const registration = yield* read(options.file)
-  if (registration === undefined) return undefined
-  if (options.version !== undefined && registration.version !== options.version) return undefined
-  const found = yield* probe(registration)
+export const discover = Effect.fn("service.discover")(function* (options: Options = {}) {
+  const info = yield* read(options.file)
+  if (info === undefined) return undefined
+  if (options.version !== undefined && info.version !== options.version) return undefined
+  const found = yield* probe(info)
   return found?.transport
 })
 
 // Idempotent ensure-running: reuses a healthy compatible server, replaces a
 // version-mismatched one, and otherwise spawns the service command detached.
-export const start = Effect.fn("service.start")(function* (options: ServiceOptions = {}) {
+export const start = Effect.fn("service.start")(function* (options: Options = {}) {
   const compatible = yield* discover(options)
   if (compatible !== undefined) return compatible
   const mismatched = yield* find(options)
-  if (mismatched !== undefined) yield* kill(mismatched.registration, options).pipe(Effect.ignore)
+  if (mismatched !== undefined) yield* kill(mismatched.info, options).pipe(Effect.ignore)
 
   const [command, ...args] = options.command ?? ["opencode", "serve", "--service"]
   if (command === undefined) return yield* Effect.fail(new Error("Missing service command"))
@@ -64,10 +64,10 @@ export const start = Effect.fn("service.start")(function* (options: ServiceOptio
   )
 })
 
-export const stop = Effect.fn("service.stop")(function* (options: ServiceOptions = {}) {
+export const stop = Effect.fn("service.stop")(function* (options: Options = {}) {
   const fs = yield* FileSystem.FileSystem
   const existing = yield* find(options)
-  if (existing !== undefined) yield* kill(existing.registration, options)
+  if (existing !== undefined) yield* kill(existing.info, options)
   yield* fs.remove(options.file ?? fallback()).pipe(Effect.ignore)
 })
 
@@ -80,18 +80,18 @@ function auth(password: string): RequestInit["headers"] {
   return { authorization: "Basic " + btoa("opencode:" + password) }
 }
 
-const Registration = Schema.Struct({
+export const Info = Schema.Struct({
   id: Schema.optional(Schema.String),
   version: Schema.optional(Schema.String),
   url: Schema.String,
   pid: Schema.Int.check(Schema.isGreaterThan(0)),
   password: Schema.optional(Schema.String),
 })
-type Registration = typeof Registration.Type
+export type Info = typeof Info.Type
 
-const decode = Schema.decodeUnknownEffect(Schema.fromJsonString(Registration))
+const decode = Schema.decodeUnknownEffect(Schema.fromJsonString(Info))
 
-// A missing or corrupt file means no valid registration; callers treat both
+// A missing or corrupt file means no valid info; callers treat both
 // the same (the registering server self-evicts, clients rediscover).
 const read = Effect.fnUntraced(function* (file?: string) {
   const fs = yield* FileSystem.FileSystem
@@ -101,14 +101,14 @@ const read = Effect.fnUntraced(function* (file?: string) {
 })
 
 type LocalService = {
-  readonly registration: Registration
+  readonly info: Info
   readonly transport: Transport
 }
 
-const probe = Effect.fnUntraced(function* (registration: Registration) {
-  const headers = registration.password === undefined ? undefined : auth(registration.password)
+const probe = Effect.fnUntraced(function* (info: Info) {
+  const headers = info.password === undefined ? undefined : auth(info.password)
   const healthy = yield* Effect.tryPromise(() =>
-    fetch(new URL("/api/health", registration.url), {
+    fetch(new URL("/api/health", info.url), {
       headers,
       signal: AbortSignal.timeout(2_000),
     }),
@@ -117,15 +117,15 @@ const probe = Effect.fnUntraced(function* (registration: Registration) {
     Effect.orElseSucceed(() => false),
   )
   if (!healthy) return undefined
-  return { registration, transport: { url: registration.url, headers } } satisfies LocalService
+  return { info, transport: { url: info.url, headers } } satisfies LocalService
 })
 
 // Health-checked lookup without the version gate: lifecycle operations must be
 // able to see (and replace or stop) a server from a different version.
-const find = Effect.fnUntraced(function* (options: ServiceOptions) {
-  const registration = yield* read(options.file)
-  if (registration === undefined) return undefined
-  return yield* probe(registration)
+const find = Effect.fnUntraced(function* (options: Options) {
+  const info = yield* read(options.file)
+  if (info === undefined) return undefined
+  return yield* probe(info)
 })
 
 // 50ms cadence bounded at ~5s, shared by stop escalation and start readiness.
@@ -142,22 +142,22 @@ const stopped = Effect.fnUntraced(function* (pid: number) {
   return yield* Effect.fail(new Error(`Server process ${pid} is still running`))
 })
 
-function same(left: Registration, right: Registration) {
+function same(left: Info, right: Info) {
   return left.id === right.id && left.version === right.version && left.url === right.url && left.pid === right.pid
 }
 
-const kill = Effect.fnUntraced(function* (info: Registration, options: ServiceOptions) {
+const kill = Effect.fnUntraced(function* (info: Info, options: Options) {
   // A stale registration may point at a PID that has since been reused by
   // another process. Only signal the PID after authenticating the server.
   const current = yield* find(options)
-  if (current === undefined || !same(current.registration, info)) return
+  if (current === undefined || !same(current.info, info)) return
 
   yield* signal(info.pid, "SIGTERM")
   const done = yield* stopped(info.pid).pipe(Effect.retry(poll), Effect.option)
   if (Option.isSome(done)) return
 
   const latest = yield* find(options)
-  if (latest === undefined || !same(latest.registration, info)) return
+  if (latest === undefined || !same(latest.info, info)) return
   yield* signal(info.pid, "SIGKILL")
   yield* stopped(info.pid).pipe(Effect.retry(poll))
 })