description, kind
| description | kind |
|---|---|
| Host and Client workspace control: mutate workspace navigation and follow its complete projection. | package-reference |
Workspace Controller
English | 中文
Summary
@deepseek-ai/dsh-api-workspace-controller owns the Host ctx.workspaceController service and the generated Client ctx.remote.workspace namespace. Its Remote methods create, rename, remove, and reorder Workspaces, reorder Sessions within a Workspace, archive and unarchive Sessions from Workspace navigation, and follow the complete Workspace projection. Use it through API Gateway when a Client must change or follow Workspace navigation. The package also owns ctx.directoryPickerController and the generated ctx.remote.directoryPicker namespace, because the directory-picking seam it carries is abstract and never a Loader entry of its own.
Table of Contents
Use this package
The Host controller serializes mutations whose correctness depends on current registry state and throws RemoteError with a stable error code for expected failures. Its follow() stream synchronously attaches to durable Workspace changes, emits one complete baseline first, then emits ordered upsert, remove, order, archived, and pinned increments. Archive and pin sets are Session id arrays, with the most recently pinned id first in the pin array. A reconnect starts another generation with a replacement baseline, so consumers do not depend on receiving every increment while disconnected.
The Client entry provides ClientWorkspaceModel and createWorkspaceStateStream(). The model owns Workspace rows, registry order, archived and pinned Session identities, unary mutation echoes, and stream/unary race resolution. A newer Host row wins by updatedAt; a committed stream order outranks an older unary response; a removed Workspace id cannot be resurrected by delayed data. Pin snapshots change only when their identities or order change. The package exposes framework-neutral snapshots and subscriptions, leaving navigation policy and React hooks to the UI owner.
First-use Workspace
workspace.initializeDefault({ directoryName, title }) returns the durable default Workspace; the Client service exposes the same request as workspaces.initializeDefault(request, signal?). The Workspace Client resolves these names from its startup language. The Host places the directory under its account's <Documents>/deepseek-harness, including on remote Web hosts. The directory name must be one non-blank segment without separators, colon, NUL, surrounding whitespace, or a trailing dot; the title must be non-blank. OS filename restrictions also apply. Linux system lookup requires xdg-user-dir with an enabled Documents directory; hosts without it must configure documentsDirectory or use the folder picker.
The Workspace registry owns eligibility, directory creation, and durable initialization. An existing default Workspace is returned without another Documents lookup; request names do not rename it. Ineligible first use returns undefined, so startup can leave directory selection to the user. Invalid names reject with gateway/bad-request; lookup and creation failures use standard Remote error handling. Initialization creates no Session and sends no message.
| Configuration | Default | Purpose |
|---|---|---|
documentsDirectory |
System Documents directory | Fully qualified Host directory override |
documentsLookupTimeoutMs |
10000 |
Positive maximum duration of OS directory lookup, in milliseconds |
Documents lookup holds the registry mutation queue, so other Workspace mutations, including registration of a picked directory, can wait up to documentsLookupTimeoutMs. Cancellation can stop the lookup; after resolution succeeds, it does not roll back creation or registration.
Model Experience
None, as Workspace organization is browser and Host control state and registers no prompt, tool, or session event.
KV Cache effect
No direct effect; Workspace mutations do not alter model requests.
Known Limitations and Deferred Work
follow()replaces the whole projection after reconnect and has no durable cursor or incremental catch-up protocol.- Process-local deletion markers prevent delayed data from reviving a removed Workspace only for the lifetime of the Client model.
Dev Note
Working context for maintainers — click to expand
None.
Runtime invariant: No companion is published. Workspace Registry owns persistence; every stream generation is a full projection.