Skip to content
SumOfficeSumOfficeSumOffice
Menu
What SumOffice isProduct and deliveryAI and MCPContact us
Overview
SumDoc — what it isWhat SumDoc can do with a documentArchitecture: objects and relationshipsDocument lifecyclePlatforms and deploymentResponsibility and security
Getting started
Installation and verificationQuick start: your first JSONL sessionDiagnostics and checklist
Guides
Request and response objectsThe same contract over WebSocketStarting Web SurfaceEditor in the browser: embedding through iframeEmbedding SurfaceDocument structure: how to get itHit-testing by coordinate, selection, and document editsIntegration recipesHost API: commands, events, and agentsInternal objects of the SumDoc application window
Examples
Live example: editor in the browserSumDoc examples
Contract and boundaries
Interaction contract for a pilotReadiness and boundariesWhere to start the pilotSumDoc version history
Reference
SumDoc referenceSumDoc session and conventionsSumDoc transport and message formatRust Session Protocol — 41 commandsTyped editing typesBrowser surface interface (Browser Surface API)window.fastdocShell · documentwindow.fastdocShell · editwindow.fastdocShell · reviewwindow.fastdocShell · viewwindow.fastdocShell · marketwindow.fastdocShell · smokewindow.fastdocShell · other methodsEvents between the application and the editorDTO · api-document.tsDTO · Text and paragraphsDTO · Tables: structureDTO · Tables: cells and formattingDTO · Tables: placement on the pageDTO · Page setup and document structureDTO · Objects and drawingsDTO · Fields, footnotes, and referencesDTO · api-market.tsDTO · api-quick-parts.tsDTO · api-review.tsDTO · api-smoke.tsDTO · api-view.tsSession types in TypeScriptMissing APIs and compatibility

window.fastdocShell · view

Display: zoom, page modes, panels, full-screen reading. Methods: 40.

Display: zoom, page modes, panels, full-screen reading. Methods on this page: 40.

Methods on this page — 40

completeSaveBeforeClose

Section titled “completeSaveBeforeClose”
completeSaveBeforeClose(payload: { saved: boolean; message?: string | null }): void

web_to_host_event · send · fastdoc-shell:save-before-close-result · capability=view

computeTableAutofitToWindowCommandState

Section titled “computeTableAutofitToWindowCommandState”
computeTableAutofitToWindowCommandState(request: D37TableAutofitToWindowRequest): Promise<D37TableAutofitToWindowCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-autofit-to-window-command-state · capability=view

computeTableCellContentAlignmentCommandState

Section titled “computeTableCellContentAlignmentCommandState”
computeTableCellContentAlignmentCommandState(request: D37TableCellContentAlignmentRequest): Promise<D37TableCellContentAlignmentCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-cell-content-alignment-command-state · capability=view

computeTableCellExactSizeCommandState

Section titled “computeTableCellExactSizeCommandState”
computeTableCellExactSizeCommandState(request: D37TableCellExactSizeRequest): Promise<D37TableCellExactSizeCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-cell-exact-size-command-state · capability=view

computeTableCellMarginsCommandState

Section titled “computeTableCellMarginsCommandState”
computeTableCellMarginsCommandState(request: D37TableCellMarginsRequest): Promise<D37TableCellMarginsCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-cell-margins-command-state · capability=view

computeTableCellSpacingCommandState

Section titled “computeTableCellSpacingCommandState”
computeTableCellSpacingCommandState(request: D37TableCellSpacingRequest): Promise<D37TableCellSpacingCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-cell-spacing-command-state · capability=view

computeTableCellTextDirectionCommandState

Section titled “computeTableCellTextDirectionCommandState”
computeTableCellTextDirectionCommandState(request: D37TableCellTextDirectionRequest): Promise<D37TableCellTextDirectionCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-cell-text-direction-command-state · capability=view

computeTableCellTextWrappingCommandState

Section titled “computeTableCellTextWrappingCommandState”
computeTableCellTextWrappingCommandState(request: D37TableCellTextWrappingRequest): Promise<D37TableCellTextWrappingCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-cell-text-wrapping-command-state · capability=view

computeTableCellVerticalAlignmentCommandState

Section titled “computeTableCellVerticalAlignmentCommandState”
computeTableCellVerticalAlignmentCommandState(request: D37TableCellVerticalAlignmentRequest): Promise<D37TableCellVerticalAlignmentCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-cell-vertical-alignment-command-state · capability=view

computeTableFixedColumnWidthCommandState

Section titled “computeTableFixedColumnWidthCommandState”
computeTableFixedColumnWidthCommandState(request: D37TableFixedColumnWidthRequest): Promise<D37TableFixedColumnWidthCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-fixed-column-width-command-state · capability=view

computeTableFloatingPositionCommandState

Section titled “computeTableFloatingPositionCommandState”
computeTableFloatingPositionCommandState(request: D37TableFloatingPositionRequest): Promise<D37TableFloatingPositionCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-floating-position-command-state · capability=view

computeTableSelectionAlignmentCommandState

Section titled “computeTableSelectionAlignmentCommandState”
computeTableSelectionAlignmentCommandState(request: D37TableSelectionAlignmentRequest): Promise<D37TableSelectionAlignmentCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-alignment-command-state · capability=view

computeTableSelectionAllBordersCommandState

Section titled “computeTableSelectionAllBordersCommandState”
computeTableSelectionAllBordersCommandState(request: D37TableSelectionAllBordersRequest): Promise<D37TableSelectionAllBordersCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-all-borders-command-state · capability=view

computeTableSelectionCellRangeFormatCommandState

Section titled “computeTableSelectionCellRangeFormatCommandState”
computeTableSelectionCellRangeFormatCommandState(request: D37TableSelectionCellRangeFormatRequest): Promise<D37TableSelectionCellRangeFormatCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-cell-range-format-command-state · capability=view

computeTableSelectionClearContentFormatCommandState

Section titled “computeTableSelectionClearContentFormatCommandState”
computeTableSelectionClearContentFormatCommandState(request: D37TableSelectionClearContentFormatRequest): Promise<D37TableSelectionClearContentFormatCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-clear-content-format-command-state · capability=view

computeTableSelectionClearContentsCommandState

Section titled “computeTableSelectionClearContentsCommandState”
computeTableSelectionClearContentsCommandState(request: D37TableSelectionClearContentsRequest): Promise<D37TableSelectionClearContentsCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-clear-contents-command-state · capability=view

computeTableSelectionClearFillCommandState

Section titled “computeTableSelectionClearFillCommandState”
computeTableSelectionClearFillCommandState(request: D37TableSelectionClearFillRequest): Promise<D37TableSelectionClearFillCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-clear-fill-command-state · capability=view

computeTableSelectionClearFormattingCommandState

Section titled “computeTableSelectionClearFormattingCommandState”
computeTableSelectionClearFormattingCommandState(request: D37TableSelectionClearFormattingRequest): Promise<D37TableSelectionClearFormattingCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-clear-formatting-command-state · capability=view

computeTableSelectionColumnAutofitCommandState

Section titled “computeTableSelectionColumnAutofitCommandState”
computeTableSelectionColumnAutofitCommandState(request: D37TableSelectionColumnAutofitRequest): Promise<D37TableSelectionColumnAutofitCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-column-autofit-command-state · capability=view

computeTableSelectionEqualizeColumnsCommandState

Section titled “computeTableSelectionEqualizeColumnsCommandState”
computeTableSelectionEqualizeColumnsCommandState(request: D37TableSelectionEqualizeColumnsRequest): Promise<D37TableSelectionEqualizeColumnsCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-equalize-columns-command-state · capability=view

computeTableSelectionHeaderRepeatCommandState

Section titled “computeTableSelectionHeaderRepeatCommandState”
computeTableSelectionHeaderRepeatCommandState(request: D37TableSelectionHeaderRepeatRequest): Promise<D37TableSelectionHeaderRepeatCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-header-repeat-command-state · capability=view

computeTableSelectionInsideBordersCommandState

Section titled “computeTableSelectionInsideBordersCommandState”
computeTableSelectionInsideBordersCommandState(request: D37TableSelectionInsideBordersRequest): Promise<D37TableSelectionInsideBordersCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-inside-borders-command-state · capability=view

computeTableSelectionOutsideBordersCommandState

Section titled “computeTableSelectionOutsideBordersCommandState”
computeTableSelectionOutsideBordersCommandState(request: D37TableSelectionOutsideBordersRequest): Promise<D37TableSelectionOutsideBordersCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-outside-borders-command-state · capability=view

computeTableSelectionPencilEraserCommandState

Section titled “computeTableSelectionPencilEraserCommandState”
computeTableSelectionPencilEraserCommandState(request: D37TableSelectionPencilEraserRequest): Promise<D37TableSelectionPencilEraserCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-pencil-eraser-command-state · capability=view

computeTableSelectionRowFitCommandState

Section titled “computeTableSelectionRowFitCommandState”
computeTableSelectionRowFitCommandState(request: D37TableSelectionRowFitRequest): Promise<D37TableSelectionRowFitCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-row-fit-command-state · capability=view

computeTableSelectionStructureCommandState

Section titled “computeTableSelectionStructureCommandState”
computeTableSelectionStructureCommandState(request: D37TableSelectionStructureEditRequest): Promise<D37TableSelectionStructureCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-structure-command-state · capability=view

computeTableSelectionWidthFitCommandState

Section titled “computeTableSelectionWidthFitCommandState”
computeTableSelectionWidthFitCommandState(request: D37TableSelectionWidthFitRequest): Promise<D37TableSelectionWidthFitCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-selection-width-fit-command-state · capability=view

computeTableWrappingStyleCommandState

Section titled “computeTableWrappingStyleCommandState”
computeTableWrappingStyleCommandState(request: D37TableWrappingStyleRequest): Promise<D37TableWrappingStyleCommandState>

web_to_host_request_response · invoke · fastdoc-shell:compute-table-wrapping-style-command-state · capability=view

createTableFromClipboard

Section titled “createTableFromClipboard”
createTableFromClipboard(request: D37TableCreateRequest): Promise<D37TableCreateResult>

web_to_host_request_response · invoke · fastdoc-shell:create-table-from-clipboard · capability=view

getState

Section titled “getState”
getState(): Promise<ShellBridgeState>

web_to_host_request_response · invoke · fastdoc-shell:get-state · capability=view

notifyUnsavedState

Section titled “notifyUnsavedState”
notifyUnsavedState(hasUnsavedChanges: boolean): void

web_to_host_event · send · fastdoc-shell:unsaved-state · capability=view

onMenuCommand

Section titled “onMenuCommand”
onMenuCommand(callback: (command: MenuCommand) => void): () => void

host_to_web_event · on · fastdoc-shell:menu-command · capability=view

onSaveBeforeClose

Section titled “onSaveBeforeClose”
onSaveBeforeClose(callback: () => void): () => void

host_to_web_event · on · fastdoc-shell:save-before-close · capability=view

onSaveBeforeCloseFailed

Section titled “onSaveBeforeCloseFailed”
onSaveBeforeCloseFailed(callback: (payload: { message: string }) => void): () => void

host_to_web_event · on · fastdoc-shell:save-before-close-failed · capability=view

onStateChanged

Section titled “onStateChanged”
onStateChanged(callback: (state: ShellBridgeState) => void): () => void

host_to_web_event · on · fastdoc-shell:state-changed · capability=view

onSystemPaste

Section titled “onSystemPaste”
onSystemPaste(callback: (payload: SystemPastePayload) => void): () => void

host_to_web_event · on · fastdoc-shell:system-paste · capability=view

Section titled “openExternalHyperlink”
openExternalHyperlink(target: string): Promise<OpenExternalHyperlinkResult>

web_to_host_request_response · invoke · fastdoc-shell:open-external-hyperlink · capability=view

readEditorClipboardText

Section titled “readEditorClipboardText”
readEditorClipboardText(): Promise< SystemPastePayload & { length: number;
    reserveConfig?: { cycles: number;
    durationMs: number;
  richPayloadBytes: number } | null;
  externalSource?: string | null;
} >

web_to_host_request_response · invoke · fastdoc-shell:read-editor-clipboard-text · capability=view

revealPath

Section titled “revealPath”
revealPath(path: string): Promise<ShellRevealPathResult>

web_to_host_request_response · invoke · fastdoc-shell:reveal-path · capability=view

writeEditorClipboardText

Section titled “writeEditorClipboardText”
writeEditorClipboardText(text: string, representations?: { html?: string | null;
  rtf?: string | null;
  internalJson?: string | null }): Promise<{ written: boolean;
  length: number;
  formats: string[];
fingerprint: string }>

web_to_host_request_response · invoke · fastdoc-shell:write-editor-clipboard-text · capability=view

Documentation assistant

Answers are assembled from the documentation and may be inaccurate — check the sources.