window.fastdocShell · current-api

Внутренний API

window.fastdocShell доступен только в доверенном renderer настольного A4. Для внешней интеграции используйте Rust Session Protocol или Browser Surface API.

Методы на этой странице — 70

• applyCanonicalHistory
• applyEditorV0HomeFormattingCommand
• applyEditorV0MailMergeCommandAction
• applyOutlineMasterDocumentAction
• applyPersistentEditingComposition
• applyPersistentEditingStructuralCommand
• applyQuickPartsDocumentOperation
• arrangeDocumentWindows
• checkLocalProofingWords
• clearRecentDocuments
• closeCurrentDocument
• commitAutosaveRecovery
• commitUserTemplate
• completeSaveBeforeDocumentSwitch
• configureLocalProofingProvider
• createDocumentWindow
• createEditableOdtCopy
• createFromBuiltinTemplate
• createFromUserTemplate
• createQuickPartsBuildingBlock
• createVersionCheckpoint
• deleteQuickPartsBuildingBlock
• deleteUserTemplate
• deleteVersion
• finalizeAutosaveRecovery
• focusDocumentWindow
• getAutosaveRecoveryState
• getDocumentWindowSession
• getLocalProofingDocumentPolicy
• getPathForFile
• inspectEditorV0HomeFormatting
• inspectExternalChange
• invalidatePersistentEditingProductRoute
• linkVersionHistorySaveAs
• listDocumentWindows
• listFileStartTemplates
• listQuickPartsBuildingBlocks
• listVersionHistory
• materializeDocumentPageWindow
• mutateLocalProofingDictionary
• notifyCanonicalEditDropped
• notifyEditKeyDropped
• notifyPageHydrationDropped
• notifyPersistentSaveRefused
• notifyUserDocumentSaved
• onDocumentSessionSnapshot
• onSaveBeforeDocumentSwitch
• openMostRecentDocument
• openVersion
• prepareAutosaveRecovery
• preparePersistentSaveCopyTarget
• prepareUserTemplate
• publishDocumentSessionSnapshot
• removeRecentDocument
• requestDocumentWindowClose
• resolveAutosaveRecovery
• resolveExternalChange
• resolveFileSessionRecovery
• restoreVersion
• rollbackSaveAsOwnershipReservation
• runDocxCompatibility
• runEditorV0MailMergeBusiness
• saveOdtAsDocxCopy
• savePersistentEditingCheckpoint
• setPersistentEditingSelection
• setRecentDocumentPinned
• setRestoreLastDocument
• updateAutosaveRecoverySettings
• updateQuickPartsBuildingBlock
• updateVersionMetadata

applyCanonicalHistory

applyCanonicalHistory(direction: "undo" | "redo"): Promise<{ owner: "rust-session"; available: boolean; sessionId: string | null; documentId: string | null; transactionOrder: number; acceptedRevision: number; selectionRevision: number; publishedRevision: number; dirty: boolean; modelHash: string | null; undoDepth: number; redoDepth: number; direction: "undo" | "redo"; projectionPath: string; historyPreservedBySave: boolean; sceneModelHash: string; visibleSceneMatchesCanonicalModel: boolean; residueCount: 0; structuralProjection?: boolean; structuralStartBodyBlockIndex?: number; bridgeState?: ShellBridgeState; transition: { transitionKind: string; transactionOrder: number; beforeModelHash: string; afterModelHash: string; paragraphIndex?: number; beforeCaretSlotIndex?: number; afterCaretSlotIndex?: number; /** * Диапазон, который отменяемая операция съела. Приходит от владельца * истории (Rust M9) и позволяет вернуть на отмене само выделение, как * это делает Microsoft Word. Пуст для операций без выделения. */ beforeSelectionStartSlotIndex?: number; beforeSelectionEndSlotIndex?: number; paragraphOwner?: string; requestId?: string; }; persistentReceipt?: import("./api-edit.js").BoundedLiveTextInsertResult["persistentReceipt"]; }>

web_to_host_request_response · invoke · fastdoc-shell:apply-canonical-history · capability=not-in-generated-registry · preload.ts:432

applyEditorV0HomeFormattingCommand

applyEditorV0HomeFormattingCommand(request: EditorV0HomeFormattingRequest): Promise<EditorV0HomeFormattingResult>

web_to_host_request_response · invoke · fastdoc-shell:apply-editor-v0-home-formatting-command · capability=not-in-generated-registry · preload.ts:2077

applyEditorV0MailMergeCommandAction

applyEditorV0MailMergeCommandAction(request: EditorV0MailMergeCommandRequest): Promise<EditorV0MailMergeCommandResult>
retired-rejected · Always rejects with MAIL_MERGE_LEGACY_COMMAND_OWNER_RETIRED. · preload.ts:1391

applyOutlineMasterDocumentAction

applyOutlineMasterDocumentAction(request: OutlineMasterDocumentRequest): Promise<OutlineMasterDocumentResult>

web_to_host_request_response · invoke · fastdoc-shell:apply-outline-master-document-action · capability=not-in-generated-registry · preload.ts:1422

applyPersistentEditingComposition

applyPersistentEditingComposition(request: import("../editing-session-contract.js").CompositionRequest): Promise<import("../editing-session-contract.js").CompositionReceipt>

web_to_host_request_response · invoke · fastdoc-shell:apply-persistent-editing-composition · capability=not-in-generated-registry · preload.ts:447

applyPersistentEditingStructuralCommand

applyPersistentEditingStructuralCommand(request: import("../editing-session-contract.js").EditRequest, options?: { projectionRefresh?: "full" | "page-window" | "model-only"; pageIndex?: number; }): Promise<{ receipt: import("../editing-session-contract.js").EditReceipt; model: Record<string, unknown>; document: ShellLoadedDocument; canonicalHistory: import("../session-bridge.js").CanonicalHistoryState; projectionRefresh: "full" | "page-window" | "model-only"; }>

web_to_host_request_response · invoke · fastdoc-shell:apply-persistent-editing-structural-command · capability=not-in-generated-registry · preload.ts:450

applyQuickPartsDocumentOperation

web_to_host_request_response · invoke · fastdoc-shell:apply-quick-parts-document-operation · capability=not-in-generated-registry · preload.ts:475

arrangeDocumentWindows

arrangeDocumentWindows(): Promise<{ arranged: number; bounds: Array<{ x: number; y: number; width: number; height: number }>; windows: ShellDocumentWindowDescriptor[]; }>

web_to_host_request_response · invoke · fastdoc-shell:arrange-document-windows · capability=not-in-generated-registry · preload.ts:2278

checkLocalProofingWords

checkLocalProofingWords(request: ShellProofingWordCheckRequest): Promise<ShellProofingWordCheckResult>

web_to_host_request_response · invoke · fastdoc-shell:check-local-proofing-words · capability=not-in-generated-registry · preload.ts:375

clearRecentDocuments

clearRecentDocuments(): Promise<{ cleared: boolean; persisted: boolean; recentDocuments: string[]; }>

web_to_host_request_response · invoke · fastdoc-shell:clear-recent-documents · capability=not-in-generated-registry · preload.ts:486

closeCurrentDocument

closeCurrentDocument(decision: "save" | "discard"): Promise<{ closed: boolean; path: string | null; decision: "save" | "discard"; }>

web_to_host_request_response · invoke · fastdoc-shell:close-current-document · capability=not-in-generated-registry · preload.ts:537

commitAutosaveRecovery

commitAutosaveRecovery(request: { recoveryId: string; stagedPath: string }): Promise<ShellAutosaveRecoveryCandidate>

web_to_host_request_response · invoke · fastdoc-shell:commit-autosave-recovery · capability=not-in-generated-registry · preload.ts:399

commitUserTemplate

commitUserTemplate(request: { id: string; title: string; sourcePath: string; previewText?: string; }): ReturnType<FastDocShellApi["listFileStartTemplates"]>

web_to_host_request_response · invoke · fastdoc-shell:commit-user-template · capability=not-in-generated-registry · preload.ts:512

completeSaveBeforeDocumentSwitch

completeSaveBeforeDocumentSwitch(result: { requestId: number; saved: boolean; savedPath: string | null; errorMessage: string | null; }): void

web_to_host_event · send · fastdoc-shell:document-switch-save-result · capability=not-in-generated-registry · preload.ts:2318

configureLocalProofingProvider

configureLocalProofingProvider(): Promise<ShellProofingProviderState>

web_to_host_request_response · invoke · fastdoc-shell:configure-local-proofing-provider · capability=not-in-generated-registry · preload.ts:369

createDocumentWindow

createDocumentWindow(): Promise<{ created: boolean; windowId: number | null; documentPath: string | null; error: string | null; windows: ShellDocumentWindowDescriptor[]; }>

web_to_host_request_response · invoke · fastdoc-shell:create-document-window · capability=not-in-generated-registry · preload.ts:2263

createEditableOdtCopy

createEditableOdtCopy(): Promise<import("../odt-editable-copy-contract.js").OdtEditableCopyUiResult>

web_to_host_request_response · invoke · fastdoc-shell:create-editable-odt-copy · capability=not-in-generated-registry · preload.ts:558

createFromBuiltinTemplate

createFromBuiltinTemplate(templateId: string): Promise<{ opened: boolean; canceled: boolean; path: string | null; }>

web_to_host_request_response · invoke · fastdoc-shell:create-from-builtin-template · capability=not-in-generated-registry · preload.ts:518

createFromUserTemplate

createFromUserTemplate(templateId: string): Promise<{ opened: boolean; canceled: boolean; path: string | null; }>

web_to_host_request_response · invoke · fastdoc-shell:create-from-user-template · capability=not-in-generated-registry · preload.ts:521

createQuickPartsBuildingBlock

web_to_host_request_response · invoke · fastdoc-shell:create-quick-parts-building-block · capability=not-in-generated-registry · preload.ts:466

createVersionCheckpoint

createVersionCheckpoint(request: { reason: ShellVersionHistoryEntry["reason"]; name?: string | null; pinned?: boolean; recoverySessionId?: string | null; }): Promise<ShellVersionHistoryEntry>

web_to_host_request_response · invoke · fastdoc-shell:create-version-checkpoint · capability=not-in-generated-registry · preload.ts:387

deleteQuickPartsBuildingBlock

web_to_host_request_response · invoke · fastdoc-shell:delete-quick-parts-building-block · capability=not-in-generated-registry · preload.ts:472

deleteUserTemplate

deleteUserTemplate(templateId: string): ReturnType<FastDocShellApi["listFileStartTemplates"]>

web_to_host_request_response · invoke · fastdoc-shell:delete-user-template · capability=not-in-generated-registry · preload.ts:515

deleteVersion

deleteVersion(request: { versionId: string; confirmed: boolean }): Promise<{ deleted: true }>

web_to_host_request_response · invoke · fastdoc-shell:delete-version · capability=not-in-generated-registry · preload.ts:411

finalizeAutosaveRecovery

finalizeAutosaveRecovery(request: { recoveryId: string; action: "save" | "save-as" | "discard" | "cancel"; savedPath?: string | null; }): Promise<{ finalized: boolean; preserved: boolean }>

web_to_host_request_response · invoke · fastdoc-shell:finalize-autosave-recovery · capability=not-in-generated-registry · preload.ts:405

focusDocumentWindow

focusDocumentWindow(windowId: number): Promise<{ focused: boolean; windows: ShellDocumentWindowDescriptor[]; }>

web_to_host_request_response · invoke · fastdoc-shell:focus-document-window · capability=not-in-generated-registry · preload.ts:2275

getAutosaveRecoveryState

getAutosaveRecoveryState(): Promise<{ sessionId: string; settings: ShellAutosaveRecoverySettings; candidates: ShellAutosaveRecoveryCandidate[] }>

web_to_host_request_response · invoke · fastdoc-shell:get-autosave-recovery-state · capability=not-in-generated-registry · preload.ts:390

getDocumentWindowSession

getDocumentWindowSession(): Promise<ShellDocumentWindowSession>

web_to_host_request_response · invoke · fastdoc-shell:get-document-window-session · capability=not-in-generated-registry · preload.ts:2269

getLocalProofingDocumentPolicy

getLocalProofingDocumentPolicy(request: { documentPath: string }): Promise<ShellProofingDocumentPolicy>

web_to_host_request_response · invoke · fastdoc-shell:get-local-proofing-document-policy · capability=not-in-generated-registry · preload.ts:378

getPathForFile

getPathForFile(file: { readonly name: string }): string
electron-webutils-direct · Synchronous Electron webUtils adapter; not a Rust command. · preload.ts:564

inspectEditorV0HomeFormatting

inspectEditorV0HomeFormatting(): Promise<EditorV0HomeFormattingSnapshot>

web_to_host_request_response · invoke · fastdoc-shell:inspect-editor-v0-home-formatting · capability=not-in-generated-registry · preload.ts:2074

inspectExternalChange

inspectExternalChange(request: { dirty: boolean }): Promise<ShellExternalChangePromptState>

web_to_host_request_response · invoke · fastdoc-shell:inspect-external-change · capability=not-in-generated-registry · preload.ts:423

invalidatePersistentEditingProductRoute

invalidatePersistentEditingProductRoute(reason: string): Promise<{ invalidated: true }>

web_to_host_request_response · invoke · fastdoc-shell:invalidate-persistent-editing-product-route · capability=not-in-generated-registry · preload.ts:457

linkVersionHistorySaveAs

linkVersionHistorySaveAs(request: { previousPath: string; nextPath: string }): Promise<{ linked: true }>

web_to_host_request_response · invoke · fastdoc-shell:link-version-history-save-as · capability=not-in-generated-registry · preload.ts:420

listDocumentWindows

listDocumentWindows(): Promise<ShellDocumentWindowDescriptor[]>

web_to_host_request_response · invoke · fastdoc-shell:list-document-windows · capability=not-in-generated-registry · preload.ts:2266

listFileStartTemplates

listFileStartTemplates(): Promise<{ builtInTemplates: Array<{ id: "blank" | "letter" | "report" | "meeting-notes"; title: string; description: string; previewText: string; }>; userTemplates: Array<{ id: string; title: string; sourcePath: string; previewText: string; createdAt: string; }>; }>

web_to_host_request_response · invoke · fastdoc-shell:list-file-start-templates · capability=not-in-generated-registry · preload.ts:506

listQuickPartsBuildingBlocks

web_to_host_request_response · invoke · fastdoc-shell:list-quick-parts-building-blocks · capability=not-in-generated-registry · preload.ts:463

listVersionHistory

listVersionHistory(): Promise<ShellVersionHistoryResult>

web_to_host_request_response · invoke · fastdoc-shell:list-version-history · capability=not-in-generated-registry · preload.ts:384

materializeDocumentPageWindow

materializeDocumentPageWindow(request: { path: string; pageIndex: number; }): Promise<ShellDocumentPageWindowResult>

web_to_host_request_response · invoke · fastdoc-shell:materialize-document-page-window · capability=not-in-generated-registry · preload.ts:561

mutateLocalProofingDictionary

mutateLocalProofingDictionary(request: { action: "add" | "remove" | "reset"; word?: string | null; }): Promise<ShellProofingDictionaryResult>

web_to_host_request_response · invoke · fastdoc-shell:mutate-local-proofing-dictionary · capability=not-in-generated-registry · preload.ts:372

notifyCanonicalEditDropped

notifyCanonicalEditDropped(payload: { code: string; requestId: string; commandType: string; }): void

web_to_host_event · send · fastdoc-shell:canonical-edit-dropped · capability=not-in-generated-registry · preload.ts:2355

notifyEditKeyDropped

notifyEditKeyDropped(payload: { code: string; inputType: string; selectionShape: string; inputRoute: string; contextRefusal: string; pressIndex: number; }): void

web_to_host_event · send · fastdoc-shell:edit-key-dropped · capability=not-in-generated-registry · preload.ts:2365

notifyPageHydrationDropped

notifyPageHydrationDropped(payload: { code: string; stage: string }): void

web_to_host_event · send · fastdoc-shell:page-hydration-dropped · capability=not-in-generated-registry · preload.ts:2362

notifyPersistentSaveRefused

notifyPersistentSaveRefused(payload: { code: string; requestId: string; saveAs: boolean; }): void

web_to_host_event · send · fastdoc-shell:persistent-save-refused · capability=not-in-generated-registry · preload.ts:2375

notifyUserDocumentSaved

notifyUserDocumentSaved(savedPath: string): Promise<{ recorded: boolean }>

web_to_host_request_response · invoke · fastdoc-shell:user-document-saved · capability=not-in-generated-registry · preload.ts:2321

onDocumentSessionSnapshot

onDocumentSessionSnapshot(callback: (snapshot: ShellDocumentSessionSnapshot) => void): () => void

host_to_web_event · on · fastdoc-shell:document-session-snapshot · capability=not-in-generated-registry · preload.ts:2284

onSaveBeforeDocumentSwitch

onSaveBeforeDocumentSwitch(callback: (request: { requestId: number }) => void): () => void

host_to_web_event · on · fastdoc-shell:save-before-document-switch · capability=not-in-generated-registry · preload.ts:2309

openMostRecentDocument

openMostRecentDocument(): Promise<{ opened: boolean; canceled: boolean; path: string | null; }>

web_to_host_request_response · invoke · fastdoc-shell:open-most-recent-document · capability=not-in-generated-registry · preload.ts:524

openVersion

openVersion(request: { versionId: string; mode: "preview" | "read-only" | "compare"; }): Promise<{ opened: true; mode: "preview" | "read-only" | "compare"; snapshotPath: string; sourceHash: string }>

web_to_host_request_response · invoke · fastdoc-shell:open-version · capability=not-in-generated-registry · preload.ts:414

prepareAutosaveRecovery

prepareAutosaveRecovery(request: { recoveryId?: string | null; documentId?: string | null; displayName: string; sourcePath: string | null; serializationPath: string; }): Promise<{ recoveryId: string; documentId: string; stagingPath: string; settings: ShellAutosaveRecoverySettings }>

web_to_host_request_response · invoke · fastdoc-shell:prepare-autosave-recovery · capability=not-in-generated-registry · preload.ts:396

preparePersistentSaveCopyTarget

preparePersistentSaveCopyTarget(request?: { outputKind?: string; saveAsPath?: string | null; }): Promise<{ status: "canceled" | "reserved"; canceled: boolean; path: string | null; reservationId: string | null; }>

web_to_host_request_response · invoke · fastdoc-shell:prepare-persistent-save-copy-target · capability=not-in-generated-registry · preload.ts:438

prepareUserTemplate

prepareUserTemplate(request: { title: string; previewText?: string }): Promise<{ id: string; title: string; targetPath: string; previewText: string; }>

web_to_host_request_response · invoke · fastdoc-shell:prepare-user-template · capability=not-in-generated-registry · preload.ts:509

publishDocumentSessionSnapshot

publishDocumentSessionSnapshot(snapshot: ShellDocumentSessionSnapshot): Promise<{ accepted: boolean; revision: number; recipients: number; }>

web_to_host_request_response · invoke · fastdoc-shell:publish-document-session-snapshot · capability=not-in-generated-registry · preload.ts:2281

removeRecentDocument

removeRecentDocument(path: string): Promise<{ removed: boolean; persisted: boolean; recentDocuments: string[]; }>

web_to_host_request_response · invoke · fastdoc-shell:remove-recent-document · capability=not-in-generated-registry · preload.ts:493

requestDocumentWindowClose

requestDocumentWindowClose(): Promise<{ requested: boolean; remaining: number; }>

web_to_host_request_response · invoke · fastdoc-shell:request-document-window-close · capability=not-in-generated-registry · preload.ts:2272

resolveAutosaveRecovery

resolveAutosaveRecovery(request: { recoveryId: string; action: "recover" | "open-copy" | "delete" | "dismiss"; outputPath?: string | null; }): Promise<{ action: string; documentPath: string | null; candidates: ShellAutosaveRecoveryCandidate[] }>

web_to_host_request_response · invoke · fastdoc-shell:resolve-autosave-recovery · capability=not-in-generated-registry · preload.ts:402

resolveExternalChange

resolveExternalChange(request: { decision: "keep-current" | "keep-mine" | "reload-disk" | "save-mine-copy" | "compare" | "cancel"; revision: number; }): Promise<{ resolved: boolean; stale: boolean; decision: string; requiresRendererSaveAs: boolean; documentPath: string | null; }>

web_to_host_request_response · invoke · fastdoc-shell:resolve-external-change · capability=not-in-generated-registry · preload.ts:426

resolveFileSessionRecovery

resolveFileSessionRecovery(request: { decision: "recover" | "decline" | "open-original"; }): Promise<{ state: ShellFileSessionRecoveryState; recovered: boolean; declined: boolean; openedOriginal: boolean; documentPath: string | null; }>

web_to_host_request_response · invoke · fastdoc-shell:resolve-file-session-recovery · capability=not-in-generated-registry · preload.ts:478

restoreVersion

restoreVersion(request: { versionId: string; mode: "current" | "copy"; outputPath?: string | null; }): Promise<{ restored: boolean; canceled: boolean; mode: "current" | "copy"; outputPath: string | null }>

web_to_host_request_response · invoke · fastdoc-shell:restore-version · capability=not-in-generated-registry · preload.ts:417

rollbackSaveAsOwnershipReservation

rollbackSaveAsOwnershipReservation(request: { reservationId: string; targetPath: string; }): Promise<{ rolledBack: boolean }>

web_to_host_request_response · invoke · fastdoc-shell:rollback-save-as-ownership-reservation · capability=not-in-generated-registry · preload.ts:441

runDocxCompatibility

runDocxCompatibility(request: { action: "check" | "inspect" | "repair-copy"; sourcePath?: string | null; selectSource?: boolean; }): Promise<ShellDocxCompatibilityOperationResult>

web_to_host_request_response · invoke · fastdoc-shell:run-docx-compatibility · capability=not-in-generated-registry · preload.ts:381

runEditorV0MailMergeBusiness

runEditorV0MailMergeBusiness(request: Record<string, unknown>): Promise<Record<string, unknown>>

web_to_host_request_response · invoke · fastdoc-shell:run-editor-v0-mail-merge-business · capability=not-in-generated-registry · preload.ts:1396

saveOdtAsDocxCopy

saveOdtAsDocxCopy(): Promise<import("../odt-docx-conversion-contract.js").OdtDocxConversionUiResult>

web_to_host_request_response · invoke · fastdoc-shell:save-odt-as-docx-copy · capability=not-in-generated-registry · preload.ts:555

savePersistentEditingCheckpoint

savePersistentEditingCheckpoint(request?: { saveAs?: boolean; targetPath?: string; saveAsOwnershipReservationId?: string; }): Promise< import("./api-edit.js").BoundedLiveTextInsertResult | null >

web_to_host_request_response · invoke · fastdoc-shell:save-persistent-editing-checkpoint · capability=not-in-generated-registry · preload.ts:435

setPersistentEditingSelection

setPersistentEditingSelection(request: import("../editing-session-contract.js").SelectionUpdateRequest): Promise<import("../editing-session-contract.js").SelectionUpdateReceipt>
setPersistentEditingSelection(request: SelectionUpdateRequest): Promise<SelectionUpdateReceipt>

web_to_host_request_response · invoke · fastdoc-shell:set-persistent-editing-selection · capability=not-in-generated-registry · preload.ts:444

setRecentDocumentPinned

setRecentDocumentPinned(path: string, pinned: boolean): Promise<{ pinned: boolean; persisted: boolean; }>

web_to_host_request_response · invoke · fastdoc-shell:set-recent-document-pinned · capability=not-in-generated-registry · preload.ts:500

setRestoreLastDocument

setRestoreLastDocument(enabled: boolean): Promise<{ enabled: boolean; persisted: boolean; }>

web_to_host_request_response · invoke · fastdoc-shell:set-restore-last-document · capability=not-in-generated-registry · preload.ts:531

updateAutosaveRecoverySettings

updateAutosaveRecoverySettings(request: Partial<Pick<ShellAutosaveRecoverySettings, "enabled" | "intervalSeconds">> & { retention?: Partial<ShellAutosaveRecoverySettings["retention"]>; }): Promise<ShellAutosaveRecoverySettings>

web_to_host_request_response · invoke · fastdoc-shell:update-autosave-recovery-settings · capability=not-in-generated-registry · preload.ts:393

updateQuickPartsBuildingBlock

web_to_host_request_response · invoke · fastdoc-shell:update-quick-parts-building-block · capability=not-in-generated-registry · preload.ts:469

updateVersionMetadata

updateVersionMetadata(request: { versionId: string; name?: string | null; pinned?: boolean; }): Promise<ShellVersionHistoryEntry>

web_to_host_request_response · invoke · fastdoc-shell:update-version-metadata · capability=not-in-generated-registry · preload.ts:408