SumDoc reference

If this is your first time here

The reference answers “what is it called and what does it accept”, not “where do I start”. The full workflow is shown in the quick start: starting the processor, opening a DOCX file, editing with a command, saving, and checking the result.

The request and response format is covered in Request and response objects, embedding the ready-made surface in Embedding the surface, and if something isn’t working, in diagnostics. Term definitions are in the glossary, and the session rules common to all commands are in SumDoc session and conventions.

This section is a machine-verified reference for SumDoc’s external API. It describes four independent surfaces:

Surface	What it is	Pages
Rust Session Protocol	41 commands of the document session: exchanging JSON lines over standard input/output or over WebSocket on the local interface. The main path for external integration.	Transport, Session commands, Typed editing types
Browser Surface API	Embedding the ready-made editor surface and the events it sends to your application.	Browser surface interface
window.fastdocShell	321 methods inside the desktop SumDoc window. An internal contract, not a public interface.	document … other methods
Type catalog	487 internal contract types and 31 generated session types.	api-document.ts … Session types

What’s in the type catalog, and what isn’t

The catalog holds data types: what a request consists of, what comes back in the response, how state is described. Twenty-two contract types were deliberately left out — they describe not data but the bus itself: the list of domains (ShellContractDomain), exchange directions (BridgeDirection), capability groups (ShellCapability), the channel registry, and one composite type per domain (DocumentBridgeContract and its siblings).

They matter to whoever rebuilds the shell itself, and are useless to whoever builds a request. They live in the same place, in shell-contract, next to the data types.

How to choose the right API

For embedding in someone else’s product, use the Rust Session Protocol or the Browser Surface API. window.fastdocShell is the desktop application’s internal contract. It isn’t a public interface and doesn’t carry over into someone else’s shell.

What the reference consists of

Session protocol · surface interface · internal window objects · events · types

Metric	Value
Rust Session Protocol	41 commands · fastdoc.session-protocol-descriptor.v1
window.fastdocShell	321 methods / 323 signatures
Types	487 internal contract types and 31 generated session types
Reference status	First-version draft: names and contents may be refined before the public interface ships