DTO · api-review.ts

48 interfaces and 6 type aliases—review: comments, tracked changes, review snapshots and spelling.

Internal contract

These types describe the exchange inside the desktop SumDoc window. For embedding in your product, use the Rust Session Protocol or the browser surface interface.

Some types include internal tags such as backlog_id: "D38" or sharedSceneOwner: "D5" — these are the task numbers the feature was filed under inside the team. They appear in the response, but embedding doesn’t need them: there’s no reason to parse or store them.

Contract module: api-review.ts.

Types on this page — 54

• ShellCommentAnchorResolution
• ShellReviewComment
• ShellReviewTrackedChange
• ShellReviewSnapshot
• ShellProofingProviderState
• ShellProofingWordCheckRequest
• ShellProofingWordCheckResult
• ShellProofingDocumentPolicy
• ShellProofingDictionaryResult
• ShellReviewActionPreviewOperation
• ShellReviewActionPreviewRequest
• ShellReviewActionPreviewResult
• ShellReviewInsertCommentCopyRequest
• ShellReviewInsertCommentCopyResult
• ShellReviewDeleteCommentCopyRequest
• ShellReviewReplyCommentCopyRequest
• ShellReviewResolveCommentCopyRequest
• ShellReviewSetCommentResolvedCopyRequest
• ShellReviewResolveAllCommentsCopyRequest
• ShellReviewResolveCommentsAuthorCopyRequest
• ShellReviewResolveMyCommentsCopyRequest
• ShellReviewAcceptChangeCopyRequest
• ShellReviewRejectChangeCopyRequest
• ShellReviewModeCopyRequest
• ShellReviewNewDocumentCopyRequest
• ShellTrackedChangeMarkupModeRequest
• ShellTrackedChangeMarkupModeResult
• ShellReviewToolsActionId
• ShellFieldToolsActionId
• ShellDesignToolsActionId
• ShellInsertExtendedActionId
• ShellFileInterchangeActionId
• ShellReviewToolsWritebackRequest
• ShellFieldToolsWritebackRequest
• ShellDesignToolsWritebackRequest
• ShellInsertExtendedWritebackRequest
• ShellFileInterchangeActionRequest
• ShellReviewDeleteCommentCopyResult
• ShellReviewReplyCommentCopyResult
• ShellReviewResolveCommentCopyResult
• ShellReviewSetCommentResolvedCopyResult
• ShellReviewResolveAllCommentsCopyResult
• ShellReviewResolveCommentsAuthorCopyResult
• ShellReviewResolveMyCommentsCopyResult
• ShellReviewAcceptChangeCopyResult
• ShellReviewRejectChangeCopyResult
• ShellReviewModeCopyResult
• ShellReviewNewDocumentCopyResult
• ShellReviewToolsWritebackResult
• ShellFieldToolsWritebackResult
• ShellDesignToolsWritebackResult
• ShellInsertExtendedWritebackResult
• ShellFileInterchangeActionResult
• ShellReviewCommentRangeLineSegment

ShellCommentAnchorResolution

InterfaceDeclaration · api-review.ts

interface ShellCommentAnchorResolution {
  source_anchor_location: string;
  resolution_kind: string;
  paragraph_location: string | null;
  line_location: string | null;
  page_index: number | null;
  section_index: number | null;
  source_fragment_location: string | null;
  scene_x_milli_px: number | null;
  scene_y_milli_px: number | null;
  detail: string;
  support_markers?: ShellSupportMarker[];
}

ShellReviewComment

InterfaceDeclaration · api-review.ts

interface ShellReviewComment {
  comment_id: number;
  author?: string | null;
  initials?: string | null;
  date?: string | null;
  is_resolved?: boolean;
  resolve_action_state?: string;
  thread_parent_comment_id?: number | null;
  thread_role?: string;
  thread_identity_source?: string;
  paragraph_texts: string[];
  anchor_locations: string[];
  anchor_ownership?: string;
  deferred_anchor_count: number;
  resolved_anchor_count: number;
  anchor_resolutions?: ShellCommentAnchorResolution[];
  block_count?: number;
  support_markers?: ShellSupportMarker[];
}

ShellReviewTrackedChange

InterfaceDeclaration · api-review.ts

interface ShellReviewTrackedChange {
  change_id?: number | null;
  change_kind: string;
  author?: string | null;
  date?: string | null;
  location: string;
  text: string;
  review_state: string;
  prior_run_properties?: {
    bold?: boolean | null;
    italic?: boolean | null;
    font_color_rgb?: string | null;
    font_underline?: string | null;
    font_underline_color_rgb?: string | null;
    text_highlight_color?: string | null;
    font_strikethrough?: string | null;
    vertical_alignment?: string | null;
    character_spacing_twips?: number | null;
    character_scale_percent?: number | null;
    character_position_half_points?: number | null;
    character_kerning_half_points?: number | null;
    text_effect?: string | null;
    font_all_caps?: boolean | null;
    font_small_caps?: boolean | null;
    font_hidden?: boolean | null;
    proofing_language?: string | null;
    no_proof?: boolean | null;
  } | null;
  prior_run_property_names?: string[];
  support_markers?: ShellSupportMarker[];
}

ShellReviewSnapshot

InterfaceDeclaration · api-review.ts

interface ShellReviewSnapshot {
  stage_id: string;
  comment_count: number;
  tracked_change_count: number;
  resolved_comment_anchor_count: number;
  deferred_comment_anchor_count: number;
  comments: ShellReviewComment[];
  tracked_changes: ShellReviewTrackedChange[];
  support_markers?: ShellSupportMarker[];
}

ShellProofingProviderState

InterfaceDeclaration · api-review.ts

interface ShellProofingProviderState {
  schema: "fastdoc.shell.proofing-provider-state.v1";
  providerKind: "nspell-local-hunspell";
  localOnly: true;
  ready: boolean;
  status: "ready" | "missing-dictionary" | "provider-error";
  availableLanguages: string[];
  activeLanguages: string[];
  requestedLanguages: string[];
  missingLanguages: string[];
  customWords: string[];
  customDictionaryPath: string;
  detail: string;
  cloudDependencyClaimed: false;
  grammarParityClaimed: false;
  arabicLinguisticParityClaimed: false;
}

ShellProofingWordCheckRequest

InterfaceDeclaration · api-review.ts

interface ShellProofingWordCheckRequest {
  words: Array<{
    word: string;
    language: "en-US" | "ru-RU";
  }>;
}

ShellProofingWordCheckResult

InterfaceDeclaration · api-review.ts

interface ShellProofingWordCheckResult {
  schema: "fastdoc.shell.proofing-word-check.v1";
  providerKind: "nspell-local-hunspell";
  localOnly: true;
  results: Array<{
    word: string;
    language: "en-US" | "ru-RU";
    misspelled: boolean;
    suggestions: string[];
  }>;
}

ShellProofingDocumentPolicy

InterfaceDeclaration · api-review.ts

interface ShellProofingDocumentPolicy {
  schema: "fastdoc.shell.proofing-document-policy.v1";
  documentPath: string;
  trackRevisionsEnabled: boolean;
}

ShellProofingDictionaryResult

InterfaceDeclaration · api-review.ts

interface ShellProofingDictionaryResult {
  schema: "fastdoc.shell.proofing-dictionary-result.v1";
  action: "add" | "remove" | "reset";
  applied: boolean;
  word: string | null;
  customWords: string[];
  persisted: boolean;
  documentModified: false;
}

ShellReviewActionPreviewOperation

TypeAliasDeclaration · api-review.ts

type ShellReviewActionPreviewOperation = "insert-comment" | "resolve-comment" | "accept-change" | "reject-change";

ShellReviewActionPreviewRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewActionPreviewRequest {
  operation: ShellReviewActionPreviewOperation;
  commentId?: number | null;
  changeId?: number | null;
  anchorLocation?: string | null;
  anchorStartOffset?: number | null;
  anchorEndOffset?: number | null;
  text?: string | null;
  author?: string | null;
}

ShellReviewActionPreviewResult

InterfaceDeclaration · api-review.ts

interface ShellReviewActionPreviewResult {
  schema: "fastdoc.shell.review-action-preview.v1";
  documentPath: string;
  operationKind: string;
  requestedTargetId: number;
  resultKind: string;
  mutationMode: string | null;
  targetCommentId: number | null;
  targetChangeId: number | null;
  targetChangeKind: string | null;
  targetLocation: string | null;
  affectedCommentId?: number | null;
  affectedCommentAuthor?: string | null;
  mutatedCommentText?: string | null;
  targetAnchorLocation?: string | null;
  originalCommentCount: number | null;
  mutatedCommentCount: number | null;
  originalTrackedChangeCount: number | null;
  mutatedTrackedChangeCount: number | null;
  bodyEffectKind: string | null;
  writebackState: "deferred";
  writebackPerformed: false;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  supportMarkerKinds: string[];
  snapshot: Record<string, unknown>;
}

ShellReviewInsertCommentCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewInsertCommentCopyRequest {
  documentPath: string;
  anchorLocation: string;
  anchorStartOffset?: number | null;
  anchorEndOffset?: number | null;
  text: string;
  author?: string | null;
  outputPath?: string | null;
  reopenAfterWrite?: boolean | null;
}

ShellReviewInsertCommentCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewInsertCommentCopyResult {
  schema: "fastdoc.shell.review-insert-comment-copy.v1";
  documentPath: string;
  outputPath: string | null;
  route: ReviewCommandRouteKind;
  anchorLocation: string | null;
  requestedText: string;
  requestedAuthor: string;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  affectedCommentId: number | null;
  affectedCommentAuthor: string | null;
  mutatedCommentText: string | null;
  targetAnchorLocation: string | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  supportMarkerKinds: string[];
  snapshot: Record<string, unknown>;
}

ShellReviewDeleteCommentCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewDeleteCommentCopyRequest {
  commentId: number;
}

ShellReviewReplyCommentCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewReplyCommentCopyRequest {
  commentId: number;
  text?: string;
  author?: string | null;
}

ShellReviewResolveCommentCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewResolveCommentCopyRequest {
  commentId: number;
}

ShellReviewSetCommentResolvedCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewSetCommentResolvedCopyRequest {
  commentId: number;
  resolved: boolean;
  historySafeOutput?: boolean;
}

ShellReviewResolveAllCommentsCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewResolveAllCommentsCopyRequest {
  requestId?: string;
  historySafeOutput?: boolean;
}

ShellReviewResolveCommentsAuthorCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewResolveCommentsAuthorCopyRequest {
  author: string;
  historySafeOutput?: boolean;
}

ShellReviewResolveMyCommentsCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewResolveMyCommentsCopyRequest {
  author: string;
  historySafeOutput?: boolean;
}

ShellReviewAcceptChangeCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewAcceptChangeCopyRequest {
  changeId: number;
  author?: string;
  changeKind?: string;
  changeOccurrence?: number;
  outputPath?: string;
  historySafeOutput?: boolean;
}

ShellReviewRejectChangeCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewRejectChangeCopyRequest {
  changeId: number;
  author?: string;
  changeKind?: string;
  changeOccurrence?: number;
  outputPath?: string;
  historySafeOutput?: boolean;
}

ShellReviewModeCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewModeCopyRequest {
  enabled?: boolean;
  outputPath?: string | null;
}

ShellReviewNewDocumentCopyRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewNewDocumentCopyRequest {
  reviewMode?: "on";
}

ShellTrackedChangeMarkupModeRequest

InterfaceDeclaration · api-review.ts

interface ShellTrackedChangeMarkupModeRequest {
  mode?: "in-line" | "balloon";
}

ShellTrackedChangeMarkupModeResult

InterfaceDeclaration · api-review.ts

interface ShellTrackedChangeMarkupModeResult {
  schema: "fastdoc.shell.tracked-change-markup-mode.v1";
  documentPath: string | null;
  requestedMode: "in-line" | "balloon";
  priorMode: "in-line" | "balloon";
  effectiveMode: "in-line" | "balloon";
  resultKind: "applied" | "no-op" | "no-document";
  sceneReloaded: boolean;
  balloonDrawOpCountBefore: number;
  balloonDrawOpCountAfter: number;
  documentModified: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
}

ShellReviewToolsActionId

TypeAliasDeclaration · api-review.ts

type ShellReviewToolsActionId =
  | "check-spelling"
  | "accept-spelling-suggestion"
  | "ignore-spelling-issue"
  | "add-word-to-dictionary"
  | "check-grammar"
  | "accept-grammar-suggestion"
  | "set-proofing-language"
  | "translate-selection"
  | "compare-documents"
  | "combine-documents"
  | "accept-all-changes"
  | "reject-all-changes"
  | "accept-filtered-changes"
  | "reject-filtered-changes"
  | "preserve-review-markup-on-export"
  | "protect-review-markup"
  | "mark-as-final"
  | "always-open-read-only"
  | "block-authors"
  | "restrict-editing-read-only"
  | "restrict-editing-tracked-changes"
  | "restrict-editing-comments"
  | "restrict-editing-forms"
  | "protected-view-enable-editing"
  | "protected-view-close"
  | "remove-review-protection";

ShellFieldToolsActionId

TypeAliasDeclaration · api-review.ts

type ShellFieldToolsActionId = "edit-hyperlink" | "remove-hyperlink" | "follow-hyperlink" | "toggle-field-codes" | "show-field-result" | "lock-field" | "unlock-field";

ShellDesignToolsActionId

TypeAliasDeclaration · api-review.ts

type ShellDesignToolsActionId =
  | "apply-style-set-standard"
  | "apply-style-set-plain"
  | "apply-style-set-blue-accent"
  | "apply-style-set-red-accent"
  | "apply-style-set-warm"
  | "apply-style-set-dark"
  | "apply-style-set-teal"
  | "apply-style-set-blue"
  | "apply-style-set-green"
  | "apply-style-set-classic"
  | "apply-theme-standard"
  | "apply-theme-headlines"
  | "apply-theme-aspect"
  | "apply-colors-office"
  | "apply-colors-blue-green"
  | "apply-colors-grayscale"
  | "apply-fonts-aptos"
  | "apply-fonts-calibri"
  | "apply-fonts-cambria"
  | "apply-effects-subtle"
  | "apply-effects-soft"
  | "apply-effects-intense"
  | "apply-paragraph-spacing-compact"
  | "apply-paragraph-spacing-open"
  | "apply-paragraph-spacing-relaxed"
  | "apply-page-color-none"
  | "apply-page-color-theme-blue"
  | "apply-page-color-warm"
  | "apply-watermark-confidential"
  | "apply-watermark-text"
  | "apply-watermark-picture"
  | "remove-watermark"
  | "apply-page-border-none"
  | "apply-page-border-box"
  | "apply-page-border-shadow"
  | "set-current-design-default";

ShellInsertExtendedActionId

TypeAliasDeclaration · api-review.ts

type ShellInsertExtendedActionId =
  | "insert-cover-page"
  | "insert-blank-page"
  | "insert-wordart"
  | "insert-field-page"
  | "insert-icon-star"
  | "insert-picture-search-image"
  | "insert-picture-stock-image"
  | "insert-picture-online"
  | "insert-3d-model-package"
  | "insert-smartart-process"
  | "insert-chart-column"
  | "insert-screenshot-capture"
  | "insert-object-embedded-document"
  | "insert-media-link"
  | "insert-textbox-vertical";

ShellFileInterchangeActionId

TypeAliasDeclaration · api-review.ts

type ShellFileInterchangeActionId =
  | "open-docx-dialog"
  | "open-import-dialog"
  | "save-as-dialog"
  | "open-recent-file"
  | "document-open-integrity-check"
  | "document-save-clean-copy"
  | "document-recovery-snapshot"
  | "document-title-path-stability"
  | "export-html"
  | "export-txt"
  | "export-odt"
  | "export-fb2"
  | "export-epub"
  | "export-pdf"
  | "export-rtf"
  | "save-docx-as"
  | "convert-doc-html"
  | "import-fb2"
  | "import-epub"
  | "import-html"
  | "import-txt"
  | "import-rtf"
  | "import-odt"
  | "import-xodt";

ShellReviewToolsWritebackRequest

InterfaceDeclaration · api-review.ts

interface ShellReviewToolsWritebackRequest {
  actionId: ShellReviewToolsActionId;
  routeId?: "ribbon" | "review-command-center" | "market-launch-center";
  originalPath?: string | null;
  revisedPath?: string | null;
  outputPath?: string | null;
  author?: string | null;
  date?: string | null;
  changeIds?: number[];
  changeAuthors?: string[];
  changeKinds?: string[];
  changeOccurrences?: number[];
  historySafeOutput?: boolean;
  password?: string | null;
  permissionRanges?: Array<{
    id: string;
    user?: string | null;
    group?: string | null;
    startLocation: string;
    endLocation: string;
  }>;
}

ShellFieldToolsWritebackRequest

InterfaceDeclaration · api-review.ts

interface ShellFieldToolsWritebackRequest {
  actionId: ShellFieldToolsActionId;
  routeId?: "ribbon" | "field-command-center" | "market-launch-center";
}

ShellDesignToolsWritebackRequest

InterfaceDeclaration · api-review.ts

interface ShellDesignToolsWritebackRequest {
  actionId: ShellDesignToolsActionId;
  defaultActionIds?: ShellDesignToolsActionId[] | null;
  selectPictureOnly?: boolean | null;
  watermarkText?: string | null;
  watermarkFont?: string | null;
  watermarkSizePoints?: number | null;
  watermarkColor?: string | null;
  watermarkTransparencyPercent?: number | null;
  watermarkOrientation?: "horizontal" | "diagonal" | null;
  picturePath?: string | null;
  reuseEmbeddedPicture?: boolean | null;
  pictureScalePercent?: number | null;
  pictureWashout?: boolean | null;
}

ShellInsertExtendedWritebackRequest

InterfaceDeclaration · api-review.ts

interface ShellInsertExtendedWritebackRequest {
  actionId: ShellInsertExtendedActionId;
  paragraphIndex?: number | null;
  offset?: number | null;
  screenshotDataUrl?: string | null;
  screenshotSourceLabel?: string | null;
  screenshotSourcePageIndex?: number | null;
  chartOperation?: "insert" | "update" | "resize" | "move" | "copy" | "delete";
  chartTargetLocation?: string | null;
  chartLocation?: string | null;
  chartSpec?: {
    chart_type: "column" | "line" | "pie";
    title: string;
    legend_position: "none" | "right" | "left" | "top" | "bottom";
    data_labels: boolean;
    categories: string[];
    series: Array<{
      name: string;
      values: string[];
      color_rgb: string;
    }>;
  } | null;
  chartWidthEmu?: number | null;
  chartHeightEmu?: number | null;
  chartXOffsetEmu?: number | null;
  chartYOffsetEmu?: number | null;
  expectedDocumentPath?: string | null;
  sourceDocumentPath?: string | null;
}

ShellFileInterchangeActionRequest

InterfaceDeclaration · api-review.ts

interface ShellFileInterchangeActionRequest {
  actionId: ShellFileInterchangeActionId;
  routeId?: "file-menu" | "document-command-center" | "market-launch-center";
  path?: string | null;
}

ShellReviewDeleteCommentCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewDeleteCommentCopyResult {
  schema: "fastdoc.shell.review-delete-comment-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedCommentId: number;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewReplyCommentCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewReplyCommentCopyResult {
  schema: "fastdoc.shell.review-reply-comment-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedCommentId: number;
  requestedReplyText: string;
  requestedAuthor: string;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewResolveCommentCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewResolveCommentCopyResult {
  schema: "fastdoc.shell.review-resolve-comment-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedCommentId: number;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewSetCommentResolvedCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewSetCommentResolvedCopyResult {
  schema: "fastdoc.shell.review-set-comment-resolved-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedCommentId: number;
  requestedResolvedState: boolean;
  beforeResolvedState: boolean | null;
  afterResolvedState: boolean | null;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  passwordEncryptionParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewResolveAllCommentsCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewResolveAllCommentsCopyResult {
  schema: "fastdoc.shell.review-resolve-all-comments-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedCommentCount: number;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewResolveCommentsAuthorCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewResolveCommentsAuthorCopyResult {
  schema: "fastdoc.shell.review-resolve-comments-author-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedAuthor: string;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  beforeAuthorCommentCount: number;
  afterAuthorCommentCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewResolveMyCommentsCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewResolveMyCommentsCopyResult {
  schema: "fastdoc.shell.review-resolve-my-comments-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedAuthor: string;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  beforeAuthorCommentCount: number;
  afterAuthorCommentCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewAcceptChangeCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewAcceptChangeCopyResult {
  schema: "fastdoc.shell.review-accept-change-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedChangeId: number;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeTrackedChangeCount: number;
  afterTrackedChangeCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  bodyEffectKind: string | null;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewRejectChangeCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewRejectChangeCopyResult {
  schema: "fastdoc.shell.review-reject-change-copy.v1";
  documentPath: string;
  outputPath: string | null;
  requestedChangeId: number;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeTrackedChangeCount: number;
  afterTrackedChangeCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  bodyEffectKind: string | null;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewModeCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewModeCopyResult {
  schema: "fastdoc.shell.review-mode-copy.v1";
  documentPath: string;
  outputPath: string | null;
  route: ReviewModeRouteKind;
  requestedReviewMode: "on" | "off";
  priorReviewMode: "on" | "off" | null;
  effectiveReviewMode: "on" | "off" | null;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeTrackedChangeCount: number;
  afterTrackedChangeCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string | null;
  snapshot: Record<string, unknown>;
}

ShellReviewNewDocumentCopyResult

InterfaceDeclaration · api-review.ts

interface ShellReviewNewDocumentCopyResult {
  schema: "fastdoc.shell.review-new-document-copy.v1";
  outputPath: string | null;
  requestedReviewMode: "on";
  effectiveReviewMode: "on" | "off" | "unknown";
  reviewModeDefaultEnabled: boolean;
  reviewState: string | null;
  resultKind: string;
  writebackResultKind: "written";
  writebackPerformed: true;
  trackedChangeCount: number;
  commentCount: number;
  fullReviewParityClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  detail: string;
  snapshot: Record<string, unknown>;
}

ShellReviewToolsWritebackResult

InterfaceDeclaration · api-review.ts

interface ShellReviewToolsWritebackResult {
  schema: "fastdoc.shell.review-tools-writeback.v1";
  documentPath: string;
  outputPath: string | null;
  requestedActionId: ShellReviewToolsActionId;
  routeId?: "ribbon" | "review-command-center" | "market-launch-center";
  taskId: string | null;
  operationKind: string | null;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  beforeCommentCount: number;
  afterCommentCount: number | null;
  beforeTrackedChangeCount: number;
  afterTrackedChangeCount: number | null;
  changedPartCount: number;
  preservedPartCount: number;
  documentXmlMarkers: unknown[];
  settingsXmlMarkers: unknown[];
  customXmlParts: unknown[];
  commentsXmlWritten: boolean;
  proofingLanguage: string | null;
  targetLanguage: string | null;
  protectionMode: string | null;
  fullWordProofingEngineClaimed: false;
  fullWordTranslationEngineClaimed: false;
  fullWordCompareEngineClaimed: false;
  legalRedlineParityClaimed: false;
  collaborationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  documentProtectionPasswordParityClaimed: false;
  passwordMetadataPersisted?: boolean;
  wrongPassword?: boolean;
  sourceUnchanged?: boolean;
  historyEntryCreated?: boolean;
  dirtyStateChanged?: boolean;
  signaturePresentBefore?: boolean;
  signatureInvalidatedByMutation?: boolean;
  signatureMessage?: string | null;
  canceled?: boolean;
  originalPath?: string | null;
  revisedPath?: string | null;
  originalSha256?: string | null;
  revisedSha256?: string | null;
  boundedScope?: string | null;
  revisionIdRebaseCount?: number;
  commentIdRebaseCount?: number;
  atomicOutput?: boolean;
  partialOutputPossible?: false;
  snapshot: Record<string, unknown>;
}

ShellFieldToolsWritebackResult

InterfaceDeclaration · api-review.ts

interface ShellFieldToolsWritebackResult {
  schema: "fastdoc.shell.field-tools-writeback.v1";
  documentPath: string;
  outputPath: string | null;
  documentPathAfterReopen?: string | null;
  currentDocumentReopened?: boolean;
  requestedActionId: ShellFieldToolsActionId;
  routeId?: "ribbon" | "field-command-center" | "market-launch-center";
  taskId: string | null;
  operationKind: string | null;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  changedPartCount: number;
  preservedPartCount: number;
  fieldCountBefore: number | null;
  fieldCountAfter: number | null;
  hyperlinkCountBefore: number | null;
  hyperlinkCountAfter: number | null;
  lockedFieldCountBefore: number | null;
  lockedFieldCountAfter: number | null;
  displayMode: string | null;
  hyperlinkTarget: string | null;
  documentXmlMarkers: unknown[];
  relationshipMarkers: unknown[];
  customXmlParts: unknown[];
  fullWordFieldEngineClaimed: false;
  recomputeParityClaimed: false;
  browserNavigationParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  snapshot: Record<string, unknown>;
}

ShellDesignToolsWritebackResult

InterfaceDeclaration · api-review.ts

interface ShellDesignToolsWritebackResult {
  schema: "fastdoc.shell.design-tools-writeback.v1";
  documentPath: string;
  outputPath: string | null;
  outputSha256AtWriteback?: string | null;
  saveReopenCount?: number;
  selectedPicturePath?: string | null;
  requestedActionId: ShellDesignToolsActionId;
  taskId: string | null;
  operationKind: string | null;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  changedPartCount: number;
  preservedPartCount: number;
  documentXmlMarkers: unknown[];
  stylesXmlMarkers: unknown[];
  themeXmlMarkers: unknown[];
  settingsXmlMarkers: unknown[];
  headerXmlMarkers: unknown[];
  customXmlParts: unknown[];
  designChoice: string | null;
  pageBackgroundColor: string | null;
  watermarkKind: string | null;
  watermarkStoryPartNames: string[];
  applicationDefaultPersisted?: boolean;
  applicationDefaultActionIds?: ShellDesignToolsActionId[];
  fullWordThemeEngineClaimed: false;
  normalTemplateDefaultClaimed: false;
  fullWordWatermarkVmlParityClaimed: false;
  wordSurfacePixelParityClaimed: false;
  snapshot: Record<string, unknown>;
}

ShellInsertExtendedWritebackResult

InterfaceDeclaration · api-review.ts

interface ShellInsertExtendedWritebackResult {
  schema: "fastdoc.shell.insert-extended-writeback.v1";
  documentPath: string;
  outputPath: string | null;
  requestedActionId: ShellInsertExtendedActionId;
  taskId: string | null;
  operationKind: string | null;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  changedPartCount: number;
  preservedPartCount: number;
  documentXmlMarkers: unknown[];
  relationshipMarkers: unknown[];
  customXmlParts: unknown[];
  contentPartNames: unknown[];
  insertedVisibleText: unknown[];
  screenshotCapture?: Record<string, unknown> | null;
  fullWordInsertGalleryClaimed: false;
  fullWordIconsGalleryClaimed: false;
  fullWordSmartArtEngineClaimed: false;
  fullWordChartEngineClaimed: false;
  fullWordMediaEmbeddingClaimed: false;
  fullWordFieldEngineClaimed: false;
  fullWord3dModelEngineClaimed: false;
  wordSurfacePixelParityClaimed: false;
  snapshot: Record<string, unknown>;
}

ShellFileInterchangeActionResult

InterfaceDeclaration · api-review.ts

interface ShellFileInterchangeActionResult {
  schema: "fastdoc.shell.file-interchange-action.v1";
  routeId?: "file-menu" | "document-command-center" | "market-launch-center";
  documentPath: string | null;
  sourceInputPath: string | null;
  outputPath: string | null;
  requestedActionId: ShellFileInterchangeActionId;
  cliCommand: string;
  resultKind: string;
  writebackResultKind: string;
  writebackPerformed: boolean;
  outputKind: "html" | "fb2" | "epub" | "pdf" | "docx" | string;
  outputByteCount: number;
  documentTitleBefore: string | null;
  documentSubtitleBefore: string | null;
  documentPathAfter: string | null;
  documentTitleAfter: string | null;
  documentSubtitleAfter: string | null;
  currentDocumentReopened: boolean;
  dialogKind?: string | null;
  nativeDialogManualPath?: boolean;
  smokeDialogOverrideUsed?: boolean;
  systemOpenDialogInvoked?: boolean;
  systemSaveDialogInvoked?: boolean;
  recentPath?: string | null;
  shellUiRouteClaimed: true;
  boundedWritebackClaimed: boolean;
  fullFormatFidelityClaimed: false;
  wordSameRouteClaimed: false;
  wordSurfacePixelParityClaimed: false;
  cloudImportExportClaimed: false;
  snapshot: Record<string, unknown>;
}

ShellReviewCommentRangeLineSegment

InterfaceDeclaration · api-review.ts

interface ShellReviewCommentRangeLineSegment {
  page_index: number;
  line_location: string;
  scene_x_milli_px: number;
  scene_width_milli_px: number;
  page_scene_fingerprint: string;
}