Yichen Jiang
b22cf68e50
Address the review of this pull request: - A failed image upload keeps the Host's attachment refusal reason. The thumbnail of a refused image names the reason instead of offering a retry that cannot succeed, and Enter while uploads hold the send names the first failure; a transport failure still offers retry, and an image without a file name uses the pending-image label. - An image upload stops reading at the smaller of the per-image and per-message byte limits. - A carried image draft moving to a Session that sends images inline drops its upload instead of staging it again. - The image upload ready state no longer carries an unread image ref. - Docs describe stored-image admission and the command image path, and the attachment rail test builds typed props instead of casting through unknown.
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, receive results or streams, send uplink items on an open stream, and observe 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 with their Client uplinks, and forwarded Host events. | ctx.typertGateway / ctx.remote |
remote-access/ |
Decides which Remote methods non-owner Peers may call, filters list results, and streams each Peer's access snapshot. | ctx.remoteAccess / ctx.remote.remoteAccess |
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 |
terminal-controller/ |
Session-owned interactive shells, screen recovery and browser terminal control. | ctx.terminalController / ctx.remote.terminal |
workspace-files/ |
Owns bounded workspace file access — stat, paged read, list, and the instrumented-operation changes feed — and the Client file resource provider over it. |
ctx.workspaceFiles / ctx.remote.workspaceFiles |
Remote calls run Client → Host over the application's shared Connection; stream items flow Host → Client on the Gateway mux, and a stream's uplink items flow Client → Host on the same logical stream. 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.
Related documentation
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,
/apitrust fence, and response envelopes behind every Remote call.
Dev Note
Working context for maintainers — click to expand
None.