Files
deepseek-harness/packages/api
Yichen Jiang b48c05d117 refactor(jobs): type the producer face by the record declaration, tidy review residue
- `JobStart` is a union discriminated by `record`: `RecordingJobStart.run`
  receives `RecordingJob` (with `append`), `PlainJobStart.run` receives the
  plain `RunningJob`, and the registry builds the plain face without the
  method, so the former warn-and-drop path is unrepresentable.
- Remove the duplicated JSDoc opener in the registry seam and correct the
  job-list slot comment (order 20 sits before the subagent catalog's 30).
- Restore the `cordis-tool-round` session fixture whose only change was a
  re-recorded `createdAt`.
- Update the 2026-08-08 job-display note's stale service-disposal and slot
  ordering facts; archive the superseded 2026-08-25 unified-task-list note
  and point its remaining inbound links at the archived snapshot.
2026-09-03 13:15:23 +08:00
..
2026-09-03 02:27:19 +08:00

description, kind
description kind
Package map for the application's Remote layer: typed Client-to-Host capability calls, results, and forwarded events, for users and maintainers navigating the group. package-group

api/ — Remote API layers

English | 中文

Summary

The api/ group provides the application's Remote layer: a Client environment can call the business capabilities running on the Host — manage goals, run commands, list the plugin inventory, discover file and session references — as typed method calls, and receive the results or forwarded Host events. remotes decides which capabilities are exposed and how each call reaches the right session's agent; gateway carries the calls and their results between Client and Host. The stack runs over the application's shared Connection; streaming session data is deliberately outside it.

Table of Contents


Packages

The packages below provide the Remote layer; the package READMEs own the exhaustive contracts.

Package Role ctx key
remotes/ Chooses which Host capabilities and events the Client can consume. —
gateway/ Carries typed unary calls, multiplexed streams, and forwarded Host events. ctx.typertGateway / ctx.remote
job-controller/ Streams one background job's observation record to the Client. ctx.jobController / ctx.remote.job
session-controller/ Owns Session commands, history streams, live control state, and Agent/Session identity policy. ctx.sessionController / ctx.remote.session
settings-controller/ Owns the configuration-surface reads and writes over the settings-domain seams. ctx.settingsController, ctx.credentialsController / ctx.remote.settings, ctx.remote.credentials
workspace-controller/ Owns Workspace mutations and the complete Client Workspace projection. ctx.workspaceController / ctx.remote.workspace

Remote calls run Client → Host over the application's shared Connection. API Gateway owns Remote transport, while the controller packages own Session, configuration-surface, and Workspace behavior. Feature packages register exact Connection Fetch routes for responses that do not fit Remote invocation, such as streamed downloads.


Start with the API Gateway reference to see the Remote model end to end, then the Typert subsystem page for the shared definitions and Connection for the physical carrier.

  • API Gateway reference — the current-state reference for the Typert API Gateway: programming model, generation pipeline, and runtime invocation.
  • Typert subsystem reference — the public contracts shared by protocol, Gateway, and consumer assemblies.
  • Connection — the RPC carrier, /api trust fence, and response envelopes behind every Remote call.

Dev Note

Working context for maintainers — click to expand

None.