DTO · api-edit.ts · часть 1

Источник: apps/fastdoc-shell/src/shell-contract/api-edit.ts.

Каталог разбит на несколько страниц: часть 1 · часть 2 · часть 3 · часть 4 · часть 5 · часть 6.

Типы на этой странице — 60

• MenuCommand
• SystemPastePayload
• ShellTableCellBorder
• ShellObservedBreak
• ShellReportSnapshot
• ShellFixtureOption
• ShellParagraphTabStop
• ShellComposedLineFragment
• ShellComposedParagraphLine
• ShellComposedParagraph
• ShellParagraphCompositionSnapshot
• BoundedLiveTextInsertRequest
• D37TableRangeRequest
• D37TableRangeResult
• D37TableCreateRequest
• D37TableCreateResult
• D37TableGridCreateRequest
• D37TableGridCreateResult
• EditorV0ConvertTextToTableRequest
• EditorV0ConvertTextToTableResult
• D37AnyTableCreateResult
• EditorV0InsertBreakKind
• EditorV0InsertDropCapKind
• EditorV0InsertBreakRequest
• EditorV0InsertDropCapRequest
• EditorV0InsertBreakResult
• EditorV0InsertImageObjectRequest
• EditorV0InsertTextBoxObjectRequest
• EditorV0InsertShapeObjectRequest
• EditorV0InsertEquationObjectRequest
• EditorV0EquationSymbolAuthoringRequest
• EditorV0EditEquationObjectRequest
• EditorV0ResizeDrawingObjectRequest
• EditorV0MoveDrawingObjectRequest
• EditorV0DistributeDrawingObjectsRequest
• EditorV0SetDrawingObjectStyleRequest
• EditorV0DeleteDrawingObjectRequest
• EditorV0SetDrawingObjectAnchorLockRequest
• EditorV0GroupDrawingObjectsRequest
• EditorV0UngroupDrawingObjectRequest
• EditorV0EditDrawingObjectTextRequest
• EditorV0InsertDateFieldRequest
• EditorV0InsertDateTimeFieldRequest
• EditorV0DateFieldKind
• EditorV0UpdateDateFieldResultRequest
• EditorV0InsertObjectTextFileSourceResult
• EditorV0InsertFootnoteRequest
• EditorV0ManageNoteKind
• EditorV0ManageNoteAction
• EditorV0ManageNoteRequest
• EditorV0InsertTableCaptionRequest
• EditorV0CrossReferenceFieldKind
• EditorV0InsertCrossReferenceRequest
• EditorV0UpdateCrossReferenceFieldResultRequest
• EditorV0UpdateSequenceFieldResultRequest
• EditorV0BibliographyStyleRequest
• EditorV0BibliographyCommandAction
• EditorV0BibliographyCommandRequest
• EditorV0IndexAuthoritiesCommandAction
• EditorV0IndexAuthoritiesCommandRequest

MenuCommand

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:7

type MenuCommand = "open-docx" | "editor-save-copy" | "editor-reopen-saved-copy" | "editor-open-user-copy-dialog" | "editor-insert-date-time" | "editor-select-all" | "editor-copy" | "editor-cut" | "editor-history-undo" | "editor-history-redo" | "editor-format-subscript" | "editor-format-superscript" | "reload-current-docx" | "toggle-left-panel" | "toggle-right-panel" | "hide-side-panels" | "set-mode-print" | "set-mode-paginate" | "set-mode-report" | "set-mode-review" | "previous-page" | "next-page" | "zoom-in" | "zoom-out" | "zoom-reset" | "view-fit-page-width" | "view-fit-whole-page" | "view-fit-multiple-pages" | "view-draft-layout" | "view-web-layout" | "view-outline" | "view-show-ruler" | "view-hide-ruler" | "view-scroll-horizontal" | "view-smooth-scroll" | "view-enter-full-screen-reading" | "view-exit-full-screen-reading" | "view-use-dark-mode" | "view-focus-mode" | "view-show-object-guides" | "view-split-view" | "view-restore-state" | "nav-place-caret-by-click" | "nav-caret-left" | "nav-caret-right" | "nav-caret-up" | "nav-caret-down" | "nav-word-previous" | "nav-word-next" | "nav-line-start" | "nav-line-end" | "nav-paragraph-start" | "nav-paragraph-end" | "nav-document-start" | "nav-document-end" | "nav-previous-page" | "nav-next-page" | "nav-search-previous" | "nav-search-next" | "nav-heading-next" | "nav-bookmark-next" | "nav-footnote-next" | "nav-endnote-next" | "nav-comment-anchor-next" | "nav-table-cell-next" | "nav-inline-object-next" | "nav-floating-object-next" | "nav-return-last-edit-point";

SystemPastePayload

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:77

type SystemPastePayload = {
  schema: "fastdoc.native-clipboard.v1";
  text: string;
  html: string;
  rtf: string;
  imagePngBase64: string | null;
  imagePath?: string | null;
  files: string[];
  internalJson: string | null;
  forcePlain: boolean;
  selectedFormat: "fastdoc-rich" | "rtf" | "html" | "image" | "files" | "plain-text" | "empty" | "rejected";
  availableFormats: string[];
  priority: readonly [
    "fastdoc-rich",
    "html",
    "rtf",
    "image",
    "files",
    "plain-text"
  ];
  fingerprint: string;
  totalBytes: number;
  rejectionReasons: string[];
};

ShellTableCellBorder

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:103

interface ShellTableCellBorder {
  edge: string;
  style: string;
  size_eighths?: number | null;
  width_milli_px?: number | null;
  color_rgb?: string | null;
}

ShellObservedBreak

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:114

interface ShellObservedBreak {
  break_kind: string;
  location: string;
  detail: string;
}

ShellReportSnapshot

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:120

interface ShellReportSnapshot {
  stage_id: string;
  part_count: number;
  relationship_count: number;
  detected_features?: ShellDetectedFeature[];
  relationships?: ShellRelationshipSnapshot[];
  support_state_counts?: Record<string, number>;
}

ShellFixtureOption

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:129

interface ShellFixtureOption {
  key: string;
  label: string;
  path: string;
  description: string;
}

ShellParagraphTabStop

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:136

interface ShellParagraphTabStop {
  alignment: string;
  position_twips: number;
  leader?: string | null;
  source: string;
  text?: string;
  width_milli_px?: number;
}

ShellComposedLineFragment

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:145

interface ShellComposedLineFragment {
  text: string;
  width_milli_px: number;
}

ShellComposedParagraphLine

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:150

interface ShellComposedParagraphLine {
  text: string;
  fragments: ShellComposedLineFragment[];
}

ShellComposedParagraph

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:155

interface ShellComposedParagraph {
  paragraph_index: number;
  paragraph_location: string;
  text: string;
  available_width_milli_px: number;
  line_break_mode: string;
  drop_cap_kind?: string | null;
  alignment_mode?: string | null;
  tab_run_count: number;
  tab_stops: ShellParagraphTabStop[];
  default_tab_stop_twips?: number | null;
  first_line_indent_twips?: number | null;
  left_indent_twips?: number | null;
  right_indent_twips?: number | null;
  spacing_before_twips?: number | null;
  spacing_after_twips?: number | null;
  line_spacing_twips?: number | null;
  line_spacing_rule?: string | null;
  fill_color_rgb?: string | null;
  keep_with_next?: boolean;
  keep_lines_together?: boolean;
  widow_control?: boolean;
  page_break_before?: boolean;
  blocked_reason?: string | null;
  lines?: ShellComposedParagraphLine[];
  support_markers?: ShellSupportMarker[];
}

ShellParagraphCompositionSnapshot

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:183

interface ShellParagraphCompositionSnapshot {
  model_version: string;
  stage_id: string;
  stage_name: string;
  line_break_mode: string;
  width_source: string;
  paragraph_count: number;
  non_empty_paragraph_count: number;
  composed_paragraph_count: number;
  blocked_paragraph_count: number;
  line_count: number;
  support_marker_count: number;
  paragraphs: ShellComposedParagraph[];
  support_markers?: ShellSupportMarker[];
}

BoundedLiveTextInsertRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:199

interface BoundedLiveTextInsertRequest {
  documentPath?: string | null;
  sourcePath?: string | null;
  saveAsOwnershipReservationId?: string | null;
  paragraphIndex: number;
  offset: number;
  text?: string;
  insertText?: string;
  structuredCommentAnchorTargetText?: string;
  semanticBoundaryAffinity?: "before" | "after";
  semanticBoundaryNoteId?: number;
  deleteCount?: number;
  persistentEdit?: import("../session-bridge.js").OptimisticEditRequest;
  canonicalTransitionKind?: "typing" | "replacement" | "paste" | "ime" | "format";
  canonicalBeforeCaretSlotIndex?: number;
  canonicalAfterCaretSlotIndex?: number;
  canonicalProjectionPageIndex?: number;
  canonicalProjectionRefresh?: "full";
  canonicalAutocorrect?: {
    kind: "user-replacement" | "built-in-replacement" | "sentence-start" | "caps-lock" | "smart-quote" | "hyphen-to-dash" | "ordinal" | "common-symbol" | "hyperlink" | "bullet-list" | "numbered-list" | "border-line";
    rawText: string;
    correctedText: string;
  };
  trackRevisions?: boolean;
  noTextMutation?: boolean;
  reopenAfterWrite?: boolean;
  outputKind?: "live-bounded-text-continue" | "editor-v0-text-continue" | "editor-v0-txt001-collapsed-typing" | "editor-v0-txt003-delete-previous-character" | "editor-v0-txt007-split-paragraph" | "editor-v0-txt008-join-paragraphs" | "editor-v0-txt009-insert-soft-line-break" | "editor-v0-txt010-insert-non-breaking-space" | "editor-v0-txt011-insert-non-breaking-hyphen" | "editor-v0-txt012-insert-optional-hyphen" | "editor-v0-text-continue-commands" | "editor-v0-undo" | "editor-v0-redo" | "editor-v0-save-as-dialog" | "editor-v0-save-state" | "editor-v0-nonblocking-typing" | "editor-v0-double-space-period-autocorrect" | "editor-v0-selection-replace" | "editor-v0-selection-edit-2" | "editor-v0-selection-edit-3" | "editor-v0-selection-edit-4" | "editor-v0-save-open-loop" | "editor-v0-autosave-toggle-action" | "editor-v0-open-saved-copy-ui" | "editor-v0-multistep-undo" | "editor-v0-save-copy-shortcuts" | "editor-v0-save-copy-destination-polish" | "editor-v0-save-copy-as-user-path" | "editor-v0-quick-save-copy-action" | "editor-v0-quick-open-copy-action" | "editor-v0-quick-open-docx-action" | "editor-v0-open-user-copy-dialog" | "editor-v0-save-open-recent-copy" | "editor-v0-formatted-run-edit" | "editor-v0-formatted-selection-edit" | "editor-v0-formatted-text-tranche" | "editor-v0-formatted-selection-ui" | "editor-v0-formatted-selection-controls" | "editor-v0-run-boundary-edit" | "editor-v0-run-boundary-edit-controls" | "editor-v0-run-boundary-insert-controls" | "editor-v0-run-boundary-text-input-controls" | "editor-v0-cross-run-selection-input" | "editor-v0-paragraph-split-merge" | "editor-v0-paragraph-text-flow" | "editor-v0-paragraph-text-flow-commands" | "editor-v0-styled-paragraph-flow" | "editor-v0-styled-paragraph-merge-controls" | "editor-v0-styled-paragraph-text-after-merge" | "editor-v0-paragraph-boundary-insert" | "editor-v0-paragraph-boundary-delete-controls" | "editor-v0-user-paragraph-boundary-edit" | "editor-v0-user-paragraph-multiline-flow" | "editor-v0-styled-multiline-boundary-edit" | "editor-v0-styled-multiline-live-toolbar-state" | "editor-v0-styled-multiline-second-fixture" | "editor-v0-toolbar-format-commands-bounded" | "editor-v0-toolbar-format-commands-italic-blue" | "editor-v0-home-chr-tranche2-market" | "editor-v0-font-family-size-commands" | "editor-v0-home-character-formatting-market" | "editor-v0-home-color-highlight-market" | "editor-v0-text-case-toolbar-command" | "editor-v0-format-toolbar-multi-command-chain" | "editor-v0-format-clear-command" | "editor-v0-format-clear-partial-selection" | "editor-v0-format-apply-partial-selection" | "editor-v0-mixed-format-selection-workflow" | "editor-v0-mixed-format-clear-or-paste-rules" | "editor-v0-mixed-format-paste-rules" | "editor-v0-clipboard-copy-cut-paste" | "editor-v0-paste-options-extended-selection" | "editor-v0-paste-options-keyboard-access" | "editor-v0-wrap-aware-selection-commands" | "editor-v0-wrap-aware-selection-manual-commands-polish" | "editor-v0-wrap-aware-paragraph-editing" | "editor-v0-wrap-aware-paragraph-manual-ux" | "editor-v0-wrap-aware-paragraph-commands-polish" | "editor-v0-wrap-aware-paragraph-reflow-polish" | "editor-v0-paste-format-options-bounded" | "editor-v0-sel007-select-all-body-content" | "editor-v0-sel008-select-range-by-drag" | "editor-v0-sel009-extend-selection-to-word-boundary" | "editor-v0-save-in-place" | "editor-v0-save-in-place-conflicts" | "editor-v0-close-warning-probe" | "editor-v0-editing-top-action" | "doc-br-001-manual-line-break" | "doc-br-001-slice3-rendering-caret" | "doc-br-001-slice4-docx-roundtrip" | "doc-br-001-slice6-selection-replacement" | "doc-br-001-slice7-guards" | "editor-v0-styled-multiline-toolbar-state" | "editor-v0-wrap-aware-paragraph-continuous-typing" | "editor-v0-wrap-aware-continuous-typing-reflow" | "editor-v0-wrap-aware-continuous-typing-manual-ux" | "editor-v0-wrap-aware-paragraph-selection-delete-polish" | "editor-v0-wrap-aware-paragraph-continuous-selection-delete" | "editor-v0-wrap-aware-paragraph-selection-delete-manual-ux" | "editor-v0-text-effect-toolbar-command" | "editor-v0-underline-style-toolbar-command" | "editor-v0-highlight-toolbar-command" | "editor-v0-font-color-toolbar-command" | "editor-v0-home-font-color-red-row" | "editor-v0-home-highlight-red-row" | "editor-v0-home-highlight-red-row-visual" | "editor-v0-style-heading1-toolbar-command" | "editor-v0-style-heading2-toolbar-command" | "editor-v0-style-heading3-toolbar-command" | "editor-v0-style-normal-card-action" | "editor-v0-quick-access-more-menu" | "editor-v0-comments-top-action" | "editor-v0-editing-top-action" | "editor-v0-share-top-action" | "editor-v0-focus-top-action" | "editor-v0-insert-tab-action" | "editor-v0-draw-tab-surface" | "editor-v0-ribbon-real-actions" | "editor-v0-ribbon-insert-drop-cap" | "editor-v0-ribbon-insert-table" | "editor-v0-tbl-sel-txt-editing-workflow" | "editor-v0-ribbon-draw-table" | "editor-v0-ribbon-convert-text-to-table" | "editor-v0-ribbon-insert-table-custom-dialog" | "editor-v0-ribbon-insert-table-size-matrix" | "editor-v0-table-contextual-tabs" | "editor-v0-table-layout-rows-columns-commands" | "editor-v0-table-layout-merge-split-commands" | "editor-v0-table-layout-delete-dropdown-commands" | "editor-v0-table-layout-delete-cells-dialog" | "editor-v0-table-layout-properties-dialog" | "editor-v0-table-context-menu-delete-actions" | "editor-v0-ribbon-delete-table" | "editor-v0-ribbon-insert-image" | "editor-v0-ribbon-insert-object-text-file" | "editor-v0-ribbon-insert-text-box" | "editor-v0-ribbon-insert-equation-edit" | "editor-v0-ribbon-insert-shape-rect" | "editor-v0-ribbon-insert-basic-shapes" | "editor-v0-ribbon-insert-date-time" | "editor-v0-ribbon-insert-symbols-market" | "editor-v0-ribbon-insert-hyperlink" | "editor-v0-ribbon-insert-bookmark" | "editor-v0-ribbon-insert-header-footer-page-number" | "editor-v0-ribbon-insert-caption-position" | "editor-v0-ribbon-insert-comment" | "editor-v0-ribbon-insert-cross-reference" | "editor-v0-ribbon-cross-reference" | "editor-v0-ribbon-cross-reference-caption" | "editor-v0-ribbon-caption-cross-reference-market" | "references-captions-crossrefs-toc-workflow" | "editor-v0-ribbon-toc" | "editor-v0-ribbon-add-text" | "editor-v0-ribbon-update-table" | "editor-v0-ribbon-table-of-figures" | "editor-v0-ribbon-update-table-of-figures" | "editor-v0-ribbon-insert-citation" | "editor-v0-ribbon-bibliography-sources" | "editor-v0-ribbon-bibliography-style" | "editor-v0-ribbon-bibliography-command-group" | "editor-v0-ribbon-index-authorities-market" | "editor-v0-ribbon-mailings-mail-merge-market" | "editor-v0-ribbon-review-market" | "editor-v0-ribbon-review-tools-market" | "editor-v0-ribbon-review-proofing-actions-market" | "editor-v0-ribbon-review-protection-controls-market" | "editor-v0-review-command-center-market" | "editor-v0-page-command-center-market" | "editor-v0-ribbon-field-tools-market" | "editor-v0-field-command-center-market" | "forms-fields-business-doc-user-workflow" | "editor-v0-market-launch-center-market" | "editor-v0-market-launch-center-full-matrix" | "editor-v0-market-launch-center-launch-pack" | "editor-v0-market-launch-center-validation" | "editor-v0-market-launch-center-repair" | "editor-v0-market-launch-center-package-prepare" | "editor-v0-market-launch-center-release-gate" | "editor-v0-market-launch-center-market-handoff-acceptance" | "editor-v0-ribbon-design-appearance-market" | "editor-v0-ribbon-insert-extended-market" | "editor-v0-file-interchange-workflow-market" | "editor-v0-file-interchange-import-workflow-market" | "editor-v0-file-lifecycle-market" | "a4-file-document-lifecycle" | "a4-writing-styles-lists-user-workflow" | "a4-authoring-workday-continuity" | "editing-reliability-v3-user-workflows" | "editor-v0-document-safety-market" | "editor-v0-document-command-center-market" | "editor-v0-ribbon-footnotes-command-group" | "pgn-footnotes-user-workflow" | "document-assembly-layout-user-workflow" | "editor-v0-tools-action-menu" | "editor-v0-style-pane-action-menu" | "editor-v0-paragraph-layout-basics" | "editor-v0-paragraph-alignment-toolbar-command" | "editor-v0-paragraph-indent-toolbar-command" | "editor-v0-paragraph-line-spacing-toolbar-command" | "editor-v0-paragraph-numbering-toolbar-command" | "editor-v0-paragraph-bullets-toolbar-command" | "editor-v0-paragraph-multilevel-toolbar-command" | "editor-v0-paragraph-fill-toolbar-command" | "editor-v0-paragraph-border-toolbar-command" | "editor-v0-paragraph-sort-toolbar-command" | "editor-v0-ruler-drag-writeback" | "editor-v0-control-sheet-ruler-tracking" | "editor-v0-d6-ruler-sensitive-action-cockpit-lock" | "editor-v0-d6-ruler-indent-reflow-lane-vector" | "editor-v0-vertical-ruler-margin-writeback" | "editor-v0-ruler-tab-selector-contract" | "editor-v0-toolbar-caret-word-after-selection" | "editor-v0-mixed-format-selection-typing-rules" | "editor-v0-clipboard-ui-polish" | "editor-v0-clipboard-shortcuts-visible-state" | "editor-v0-formatted-paste-across-paragraphs" | "editor-v0-formatted-paste-across-paragraphs-ux" | "editor-v0-user-created-paragraph-paste" | "editor-v0-user-created-paragraph-paste-options" | "editor-v0-user-created-paragraph-paste-options-keyboard" | "editor-v0-user-created-paragraph-paste-options-multiparagraph" | "editor-v0-user-created-rich-source-multiparagraph-paste" | "editor-v0-visible-multiparagraph-selection-rich-paste" | "editor-v0-user-created-format-paste-replace-flow" | "a4-clipboard-format-preservation-workflow" | "editor-v0-user-created-multiparagraph-source-paste" | "editor-v0-collapsed-paragraph-format-paste" | "editor-v0-collapsed-paragraph-cut-paste" | "editor-v0-collapsed-paragraph-format-clear-paste" | "editor-v0-collapsed-paragraph-cut-clear-paste" | "editor-v0-cut-clear-paste-extended-selection" | "editor-v0-cut-clear-paste-target-index-expansion" | "editor-v0-cut-clear-paste-target-toolbar-state" | "editor-v0-wide-target-keyboard-toolbar-state" | "editor-v0-keyboard-wide-target-action-chain" | "editor-v0-keyboard-wide-target-manual-ux" | "editor-v0-keyboard-wide-target-manual-commands-richer-content" | "editor-v0-find-text-navigation" | "editor-v0-find-text-result-controls" | "editor-v0-editing-replace-first-command" | "editor-v0-editing-replace-all-command" | "editor-v0-search-options-current-replace-command" | "editor-v0-search-options-replace-all-command" | "editor-v0-home-editing-group" | "editor-v0-paste-options-menu";
  pasteStyleStrategy?: "inherit-start" | "plain" | "source";
  pasteStyleSegments?: Array<{
    offset: number;
    length: number;
    bold: boolean;
    italic: boolean;
    colorRgb: string | null;
    underline?: string | null;
    fontFamilyName?: string | null;
    fontSizeHalfPoints?: number | null;
  }> | null;
  pasteParagraphLayout?: {
    alignment: "left" | "center" | "right" | "both";
    leftIndentTwips: number;
    firstLineIndentTwips?: number | null;
    rightIndentTwips?: number | null;
    tabStops?: Array<{
      alignment: "left" | "center" | "right" | "decimal" | "bar";
      positionTwips: number;
      leader?: "dot" | "hyphen" | "underscore" | "middleDot" | "heavy" | null;
    }>;
    spacingBeforeTwips?: number | null;
    spacingAfterTwips: number;
    lineSpacingTwips: number;
    numbering?: {
      kind?: "decimal" | "bullet";
      numId: number;
      ilvl: number;
      start: number;
      numFormat: "decimal" | "bullet";
      levelText: "%1." | "•";
    } | null;
  } | null;
  pasteParagraphStyle?: "Normal" | "Heading1" | "Heading2" | "Heading3" | null;
  pasteParagraphDirection?: "ltr" | "rtl" | null;
  pasteHyperlinks?: Array<{
    offset: number;
    length: number;
    url: string;
  }> | null;
  pasteParagraphBorder?: "box-single" | null;
  pasteSectionPageMargins?: {
    topMarginTwips: number;
    rightMarginTwips: number;
    bottomMarginTwips: number;
    leftMarginTwips: number;
  } | null;
  saveAsPath?: string | null;
  operationKind?: "delete-multiparagraph-range";
  endParagraphIndex?: number;
  endOffset?: number;
}

D37TableRangeRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:541

interface D37TableRangeRequest {
  bodyBlockIndex: number;
  rowIndex: number;
  columnIndex: number;
  rowCount: number;
  columnCount: number;
  clipboardText?: string;
  clipboardHtml?: string;
  trackRevisions?: boolean;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableRangeResult

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:554

interface D37TableRangeResult {
  schema: "fastdoc.shell.d37-table-range-clipboard.v1";
  operationKind: "copy-table-cell-text-range" | "paste-table-cell-text-into-range";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  clipboardText: string | null;
  clipboardHtml: string | null;
  range: {
    bodyBlockIndex: number;
    rowIndex: number;
    columnIndex: number;
    rowCount: number;
    columnCount: number;
  };
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
}

D37TableCreateRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:574

interface D37TableCreateRequest {
  bodyBlockIndex: number;
  clipboardText?: string;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableCreateResult

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:581

interface D37TableCreateResult {
  schema: "fastdoc.shell.d37-table-create-clipboard.v1";
  operationKind: "create-simple-table-from-clipboard";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  clipboardText: string | null;
  bodyBlockIndex: number;
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
}

D37TableGridCreateRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:594

interface D37TableGridCreateRequest {
  bodyBlockIndex: number;
  targetKind?: "body-block" | "table-cell";
  rowIndex?: number | null;
  columnIndex?: number | null;
  rowCount: number;
  columnCount: number;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableGridCreateResult

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:605

interface D37TableGridCreateResult {
  schema: "fastdoc.shell.d37-table-create-grid.v1";
  operationKind: "create-simple-table" | "create-nested-simple-table";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  targetKind: "body-block" | "table-cell";
  rowIndex: number | null;
  columnIndex: number | null;
  rowCount: number;
  columnCount: number;
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
}

EditorV0ConvertTextToTableRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:622

interface EditorV0ConvertTextToTableRequest {
  bodyBlockIndex: number;
  clipboardText: string;
  separator: "paragraphs" | "tabs" | "semicolons" | `other:${string}`;
  columnCount: number;
  autofitMode: "fixed-auto" | "fixed" | "contents" | "window";
  fixedColumnWidthTwips?: number | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0ConvertTextToTableResult

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:633

interface EditorV0ConvertTextToTableResult {
  schema: "fastdoc.shell.editor-v0-convert-text-to-table.v1";
  operationKind: "convert-text-to-table";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  transientWrite?: boolean;
  clipboardText: string | null;
  bodyBlockIndex: number;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  separator: string;
  autofitMode: string;
  fixedColumnWidthTwips: number | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
}

D37AnyTableCreateResult

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:653

type D37AnyTableCreateResult = D37TableCreateResult | D37TableGridCreateResult;

EditorV0InsertBreakKind

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:655

type EditorV0InsertBreakKind = "line-break" | "page-break" | "column-break" | "section-break-next-page" | "section-break-continuous" | "section-break-even-page" | "section-break-odd-page";

EditorV0InsertDropCapKind

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:664

type EditorV0InsertDropCapKind = "none" | "drop" | "margin";

EditorV0InsertBreakRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:666

interface EditorV0InsertBreakRequest {
  breakKind: EditorV0InsertBreakKind;
  paragraphIndex: number;
  offset?: number | null;
  deleteCount?: number | null;
  reopenAfterWrite?: boolean;
  sourcePath?: string | null;
  outputPath?: string | null;
}

EditorV0InsertDropCapRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:676

interface EditorV0InsertDropCapRequest {
  dropCapKind: EditorV0InsertDropCapKind;
  paragraphIndex: number;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0InsertBreakResult

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:683

interface EditorV0InsertBreakResult {
  schema: "fastdoc.shell.editor-v0-insert-break-action.v1";
  operationKind: "insert-line-break" | "delete-line-break" | "insert-page-break" | "insert-column-break" | "insert-section-break";
  breakKind: EditorV0InsertBreakKind;
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  paragraphIndex: number;
  offset: number | null;
  deleteCount: number;
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
  popupWarningShown: false;
  technicalPanelAdded: false;
  wordParityClaim: false;
  pixelParityClaim: false;
}

EditorV0InsertImageObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:709

interface EditorV0InsertImageObjectRequest {
  paragraphIndex: number;
  imagePath: string;
  wrapMode?: "inline" | "square" | "tight" | "through" | "top-bottom" | "behind-text" | "in-front-of-text" | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0InsertTextBoxObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:725

interface EditorV0InsertTextBoxObjectRequest {
  paragraphIndex: number;
  text?: string | null;
  displayName?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
  widthEmu?: number | null;
  heightEmu?: number | null;
}

EditorV0InsertShapeObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:735

interface EditorV0InsertShapeObjectRequest {
  paragraphIndex: number;
  shape?: "rect" | string | null;
  displayName?: string | null;
  text?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
  widthEmu?: number | null;
  heightEmu?: number | null;
}

EditorV0InsertEquationObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:746

interface EditorV0InsertEquationObjectRequest {
  schema?: "fastdoc.shell.equation-symbol-authoring.request.v1";
  operationKind?: "insert-equation" | "edit-equation" | "delete-equation" | "insert-symbol";
  selection?: {
    partName: string;
    paragraphLocation: string;
    textOffset: number;
  } | null;
  equationIndex?: number | null;
  linearInput?: string | null;
  symbol?: string | null;
  expectedDocumentPath?: string | null;
  expectedPartHash?: string | null;
  historyDepth?: number | null;
  paragraphIndex?: number;
  text?: string;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0EquationSymbolAuthoringRequest

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:766

type EditorV0EquationSymbolAuthoringRequest = EditorV0InsertEquationObjectRequest;

EditorV0EditEquationObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:768

interface EditorV0EditEquationObjectRequest {
  equationIndex?: number | null;
  text: string;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0ResizeDrawingObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:775

interface EditorV0ResizeDrawingObjectRequest {
  objectLocation?: string | null;
  sourceLocation?: string | null;
  widthEmu: number;
  heightEmu: number;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0MoveDrawingObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:784

interface EditorV0MoveDrawingObjectRequest {
  objectLocation?: string | null;
  sourceLocation?: string | null;
  xOffsetEmu: number;
  yOffsetEmu: number;
  xRelativeFrom?: string | null;
  yRelativeFrom?: string | null;
  sourcePart?: string | null;
  sourceDrawingIndex?: number | null;
  wrapMode?: "inline" | "square" | "tight" | "through" | "top-bottom" | "behind-text" | "in-front-of-text" | null;
  positionBehavior?: "move-with-text" | "fix-position-on-page" | null;
  arrangeMode?: "bring-forward" | "bring-front" | "send-backward" | "send-back" | "behind-text" | "in-front-of-text" | null;
  alignHorizontal?: "left" | "center" | "right" | null;
  alignVertical?: "top" | "center" | "bottom" | null;
  alignRelativeFrom?: "margin" | "page" | null;
  rotateDegrees?: number | null;
  locked?: boolean | null;
  hidden?: boolean | null;
  duplicateTargetPart?: string | null;
  duplicateTargetStory?: "body" | "table" | "header" | "footer" | null;
  duplicateTargetParagraphIndex?: number | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0DistributeDrawingObjectsRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:809

interface EditorV0DistributeDrawingObjectsRequest {
  objectLocations: string[];
  axis: "horizontal" | "vertical";
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0SetDrawingObjectStyleRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:816

interface EditorV0SetDrawingObjectStyleRequest {
  objectLocation?: string | null;
  sourceLocation?: string | null;
  fillRgb?: string | null;
  fillOpacityPercent?: number | null;
  outlineRgb?: string | null;
  outlineWidthEmu?: number | null;
  outlineOpacityPercent?: number | null;
  textDirection?: "horizontal" | "vertical" | "vertical-270" | null;
  textAutofit?: "none" | "resize-shape" | "shrink-text" | null;
  displayName?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0DeleteDrawingObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:831

interface EditorV0DeleteDrawingObjectRequest {
  objectLocation?: string | null;
  sourceLocation?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0SetDrawingObjectAnchorLockRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:838

interface EditorV0SetDrawingObjectAnchorLockRequest {
  objectLocation?: string | null;
  sourceLocation?: string | null;
  locked: boolean;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0GroupDrawingObjectsRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:846

interface EditorV0GroupDrawingObjectsRequest {
  objectLocations: string[];
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0UngroupDrawingObjectRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:852

interface EditorV0UngroupDrawingObjectRequest {
  objectLocation?: string | null;
  sourceLocation?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0EditDrawingObjectTextRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:859

interface EditorV0EditDrawingObjectTextRequest {
  objectLocation?: string | null;
  sourceLocation?: string | null;
  text?: string | null;
  textSourcePath?: string | null;
  textFromFile?: boolean;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0InsertDateFieldRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:869

interface EditorV0InsertDateFieldRequest {
  paragraphIndex: number;
  offset?: number | null;
  isoDate: string;
  picture?: string | null;
  language?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0InsertDateTimeFieldRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:881

interface EditorV0InsertDateTimeFieldRequest {
  paragraphIndex: number;
  offset?: number | null;
  isoDateTime: string;
  picture?: string | null;
  language?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0DateFieldKind

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:893

type EditorV0DateFieldKind = "date" | "date-time";

EditorV0UpdateDateFieldResultRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:895

interface EditorV0UpdateDateFieldResultRequest {
  paragraphIndex: number;
  fieldKind?: EditorV0DateFieldKind | null;
  currentResult: string;
  updatedResult: string;
  picture?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0InsertObjectTextFileSourceResult

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:906

interface EditorV0InsertObjectTextFileSourceResult {
  canceled: boolean;
  path: string | null;
  text: string;
  length: number;
}

EditorV0InsertFootnoteRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:913

interface EditorV0InsertFootnoteRequest {
  paragraphIndex: number;
  offset?: number | null;
  noteText?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0ManageNoteKind

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:921

type EditorV0ManageNoteKind = "footnote" | "endnote";

EditorV0ManageNoteAction

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:922

type EditorV0ManageNoteAction = "edit" | "delete";

EditorV0ManageNoteRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:924

interface EditorV0ManageNoteRequest {
  kind: EditorV0ManageNoteKind;
  action: EditorV0ManageNoteAction;
  noteId?: number | null;
  noteText?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0InsertTableCaptionRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:933

interface EditorV0InsertTableCaptionRequest {
  bodyBlockIndex: number;
  label?: string | null;
  captionText?: string | null;
  captionPosition?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0CrossReferenceFieldKind

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:942

type EditorV0CrossReferenceFieldKind = "REF" | "PAGEREF" | "NOTEREF";

EditorV0InsertCrossReferenceRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:944

interface EditorV0InsertCrossReferenceRequest {
  paragraphIndex: number;
  fieldKind?: EditorV0CrossReferenceFieldKind | null;
  targetBookmark: string;
  resultText: string;
  targetKind?: "bookmark" | "caption" | null;
  referenceKind?: "stored-result" | "only-label-and-number" | null;
  captionLabel?: string | null;
  captionParagraphIndex?: number | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0UpdateCrossReferenceFieldResultRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:957

interface EditorV0UpdateCrossReferenceFieldResultRequest {
  paragraphIndex: number;
  fieldKind?: EditorV0CrossReferenceFieldKind | null;
  targetBookmark: string;
  currentResult: string;
  updatedResult: string;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0UpdateSequenceFieldResultRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:967

interface EditorV0UpdateSequenceFieldResultRequest {
  paragraphIndex: number;
  fieldLabel: string;
  currentResult: string;
  updatedResult: string;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0BibliographyStyleRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:976

interface EditorV0BibliographyStyleRequest {
  selectedStyle: string;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0BibliographyCommandAction

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:982

type EditorV0BibliographyCommandAction = "insert-citation" | "add-source" | "insert-bibliography";

EditorV0BibliographyCommandRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:985

interface EditorV0BibliographyCommandRequest {
  action: EditorV0BibliographyCommandAction;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0IndexAuthoritiesCommandAction

TypeAliasDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:991

type EditorV0IndexAuthoritiesCommandAction = "mark-index-entry" | "insert-index" | "update-index" | "mark-authority-citation" | "insert-table-of-authorities" | "update-table-of-authorities";

EditorV0IndexAuthoritiesCommandRequest

InterfaceDeclaration · apps/fastdoc-shell/src/shell-contract/api-edit.ts:999

interface EditorV0IndexAuthoritiesCommandRequest {
  action: EditorV0IndexAuthoritiesCommandAction;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}