Types: session, workbook, and sheets

Definitions of the names from the “TypeScript type” column on the operation pages.

Other dictionary topics: session, workbook, and sheets · cells and ranges · formulas and calculation · formatting · data and sheet objects · pivot tables · charts and graphics · printing and page layout · Power Query · VBA and macros · protection and review · general and utility.

Types on this page — 120

• CompatibilityCategory
• CompatibilityFinding
• CompatibilityFindingGroup
• CompatibilityInventoryReport
• CompatibilityLocation
• CompatibilityRedactedReport
• CompatibilitySeverity
• CompatibilityTarget
• ContractActiveSheetMeta
• ContractCapabilityLevel
• ContractContainerFamily
• ContractCurrentSubsetSaveRoute
• ContractCustomViewSheetSnapshot
• ContractCustomViewWindowSnapshot
• ContractDirectionPlaceholderSubset
• ContractDocumentPropertiesCapability
• ContractExternalWorkbookReferenceTrustMetadata
• ContractFillAcrossSheetsMode
• ContractForecastSheetPlan
• ContractForecastSheetPreviewRow
• ContractFormulaTrustCellsWindow
• ContractFreezePaneSubset
• ContractGeometrySubset
• ContractLayoutMetricsSubset
• ContractObjectStatusPlaceholderSubset
• ContractSaveCapability
• ContractSessionDirection
• ContractSheetBackgroundProjection
• ContractSheetKind
• ContractSheetObject
• ContractSheetObjectBounds
• ContractSheetObjectFamily
• ContractSheetObjectMutationAction
• ContractSheetObjectMutationIntent
• ContractSheetObjectPreservedSupportFamily
• ContractSheetObjectStatus
• ContractSheetVisibilityState
• ContractSourceTrustSessionBinding
• ContractSubsetSessionInfo
• ContractViewportReadiness
• ContractViewportReadinessState
• ContractWorkbookAccessibilityIntent
• ContractWorkbookAccessibilityIssue
• ContractWorkbookAccessibilityIssueKind
• ContractWorkbookAccessibilityLocation
• ContractWorkbookAccessibilityNavigationTarget
• ContractWorkbookAccessibilityPackageFix
• ContractWorkbookAccessibilityRemediation
• ContractWorkbookAccessibilityRemediationKind
• ContractWorkbookAccessibilityResult
• ContractWorkbookAccessibilitySeverity
• ContractWorkbookAccessibilityStatus
• ContractWorkbookCalculationMode
• ContractWorkbookConnectionDestination
• ContractWorkbookConnectionEntry
• ContractWorkbookConnectionLoadLink
• ContractWorkbookConnectionsProjection
• ContractWorkbookHistoryActiveSheetProjection
• ContractWorkbookHistoryDirection
• ContractWorkbookHistoryOwner
• ContractWorkbookHistoryProjection
• ContractWorkbookLinkCachedValueTruth
• ContractWorkbookLinkInventoryEntry
• ContractWorkbookLinkSourceKind
• ContractWorkbookLinkState
• ContractWorkbookLinkStructuredTable
• ContractWorkbookLinksIntent
• ContractWorkbookLinksResult
• ContractWorkbookLinksStatus
• ContractWorkbookNamedView
• ContractWorkbookNamedViewSnapshot
• ContractWorkbookObjectAnchorState
• ContractWorkbookObjectInventoryEntry
• ContractWorkbookObjectMutationCapabilities
• ContractWorkbookObjectPresenceStatus
• ContractWorkbookObjectRelationship
• ContractWorkbookObjectSupportState
• ContractWorkbookObjectTargetState
• ContractWorkbookObjectType
• ContractWorkbookReadiness
• ContractWorkbookReadinessPhase
• ContractWorkbookReadinessPhaseState
• ContractWorkbookRevisionCellState
• ContractWorkbookRevisionCellSummary
• ContractWorkbookRevisionConflict
• ContractWorkbookRevisionConflictKind
• ContractWorkbookRevisionDelta
• ContractWorkbookRevisionMergeOutcome
• ContractWorkbookRevisionMutation
• ContractWorkbookRevisionUnsupportedMutationKind
• ContractWorkbookSheetMeta
• ContractWorkbookThemeColorScheme
• ContractWorkbookThemeFontsProjection
• ContractWorkbookWindowCommandState
• ContractWorkbookWindowSessionAction
• ContractWorkbookWindowSessionIdentity
• ContractWorkbookWindowSessionProjection
• ContractWorkbookWindowViewProjection
• ContractWorkbookWindowViewState
• ContractXlsxSheetBackgroundPatch
• ContractXlsxSheetFormatPatch
• ContractXlsxTextBoxSheetPatch
• ContractXlsxWorkbookActiveSheetPatch
• ContractXlsxWorkbookThemeColorsPatch
• ContractXlsxWorkbookThemePatch
• ContractXlsxWorkbookViewSelectionPatch
• EditorSessionStamp
• FormulaSubsetStatus
• OpenWorkbookSubsetProjectionPayload
• SubsetSessionMode
• ViewportWindow
• WorkbookIdentityDescriptor
• WorkbookSelectorDescriptor
• WorkbookSourceDescriptor
• WorkbookVersionByteProvenance
• WorkbookVersionCategoryDiff
• WorkbookVersionCategorySupport
• WorkbookVersionCompareStatus
• WorkbookVersionFormat
• WorkbookVersionStructuralDiff

CompatibilityCategory

type CompatibilityCategory =
  | "workbook_structure"
  | "formulas_calculation"
  | "formatting_layout"
  | "objects_media"
  | "data_connections"
  | "metadata_package";

CompatibilityFinding

interface CompatibilityFinding {
  stableId: string;
  target: CompatibilityTarget;
  severity: CompatibilitySeverity;
  category: CompatibilityCategory;
  reasonCode: string;
  count: number;
  location: CompatibilityLocation;
}

CompatibilityFindingGroup

interface CompatibilityFindingGroup {
  severity: CompatibilitySeverity;
  category: CompatibilityCategory;
  findingCount: number;
}

CompatibilityInventoryReport

interface CompatibilityInventoryReport {
  schemaVersion: number;
  status: "scanned" | "blocked";
  reasonCode: string;
  sourceFormat: string;
  selectedTarget: CompatibilityTarget;
  availableTargets: CompatibilityTarget[];
  totalFindingCount: number;
  returnedFindingCount: number;
  truncated: boolean;
  signedPackage: boolean;
  readOnly: boolean;
  copyAllowed: boolean;
  reportFingerprint: string;
  findings: CompatibilityFinding[];
  groups: CompatibilityFindingGroup[];
  redactedReport: CompatibilityRedactedReport;
}

CompatibilityLocation

type CompatibilityLocation =
  | { kind: "package" }
  | { kind: "sheet"; sheetKey: string; sheetName: string }
  | { kind: "cell"; sheetKey: string; sheetName: string; cellRef: string; row: number; col: number; }
  | { kind: "object"; sheetKey: string; sheetName: string; stableId: string; label: string; };

CompatibilityRedactedReport

interface CompatibilityRedactedReport {
  schemaVersion: number;
  target: CompatibilityTarget;
  reportFingerprint: string;
  totalFindingCount: number;
  returnedFindingCount: number;
  truncated: boolean;
  reasonCodes: string[];
  stableFindingIds: string[];
  groups: CompatibilityFindingGroup[];
}

CompatibilitySeverity

type CompatibilitySeverity = "error" | "warning" | "info";

CompatibilityTarget

type CompatibilityTarget = "xlsx" | "xls" | "csv" | "ods";

ContractActiveSheetMeta

interface ContractActiveSheetMeta {
  index: number;
  name: string;
  path: string;

  autoFilterRef?: string;
}

ContractCapabilityLevel

type ContractCapabilityLevel = (typeof CONTRACT_CAPABILITY_LEVEL_IDS)[number];

ContractContainerFamily

type ContractContainerFamily = (typeof CONTRACT_CONTAINER_FAMILY_IDS)[number];

ContractCurrentSubsetSaveRoute

type ContractCurrentSubsetSaveRoute = (typeof CONTRACT_CURRENT_SUBSET_SAVE_ROUTE_IDS)[number];

ContractCustomViewSheetSnapshot

interface ContractCustomViewSheetSnapshot {
  sheetKey: string;
  hiddenRows: number[];
  hiddenColumns: number[];
  filters: ContractCustomViewFilterSnapshot[];
  outline: ContractCustomViewOutlineTrack[];
  workbookViewMode?: "normal" | "page-layout" | "page-break-preview";
  gridLinesVisible?: boolean;
  headingsVisible?: boolean;
  printOptionsXml?: string;
  pageMarginsXml?: string;
  pageSetupXml?: string;
  rowBreaksXml?: string;
  columnBreaksXml?: string;
  headerFooterXml?: string;
}

ContractCustomViewWindowSnapshot

interface ContractCustomViewWindowSnapshot {
  activeSheetKey: string;
  activeCell: string;
  selection: string;
  scrollTopLeftCell: string;
  zoomScale: number;
  paneMode: "none" | "frozen" | "split";
  freezePane?: ContractFreezePaneSubset;
}

ContractDirectionPlaceholderSubset

interface ContractDirectionPlaceholderSubset {
  kind: ContractDirectionPlaceholderKind;
  workbookDirection: ContractSessionDirection;
  activeSheetDirection: ContractSessionDirection;
  writingMode: ContractWritingModePlaceholder;
}

ContractDocumentPropertiesCapability

type ContractDocumentPropertiesCapability = "edit_live" | "save_copy_only" | "blocked";

ContractExternalWorkbookReferenceTrustMetadata

interface ContractExternalWorkbookReferenceTrustMetadata {
  label: string;
  externalWorkbookIdentity: string;
  sheetName?: string | null;
  referenceText: string;
  shape: string;
  resolutionState: string;
}

ContractFillAcrossSheetsMode

type ContractFillAcrossSheetsMode = "all" | "contents" | "formats";

ContractForecastSheetPlan

interface ContractForecastSheetPlan {
  generation: number;
  sourcePointCount: number;
  normalizedPointCount: number;
  forecastPointCount: number;
  missingPointCount: number;
  duplicatePointCount: number;
  step: number;
  forecastEnd: number;
  seasonality: number;
  confidenceLevel: number;
  dateSystem: string;
  outputSheetName: string;
  tableStableId: string;
  chartStableId: string;
  chartType: "line" | "column";
  previewTruncated: boolean;
  rows: ContractForecastSheetPreviewRow[];
  warnings: string[];
}

ContractForecastSheetPreviewRow

interface ContractForecastSheetPreviewRow {
  timeline: number;
  actual?: number | null;
  forecast?: number | null;
  lowerConfidenceBound?: number | null;
  upperConfidenceBound?: number | null;
}

ContractFormulaTrustCellsWindow

interface ContractFormulaTrustCellsWindow {
  sheetKey: string;
  top: number;
  left: number;
  rows: number;
  cols: number;
}

ContractFreezePaneSubset

interface ContractFreezePaneSubset {
  topLeftCell?: string;
  xSplit?: number;
  ySplit?: number;
}

ContractGeometrySubset

interface ContractGeometrySubset {
  usedRange: string;
  usedRangeProvenance?:
    | "worksheet-dimension"
    | "indexed-cell-extent"
    | "delimited-record-index"
    | "parsed-cell-extent"
    | "session-recalculation";

  usedRangeFinality?: "provisional" | "final";
  maxRow: number;
  maxCol: number;
  presentCellCount: number;
}

ContractLayoutMetricsSubset

interface ContractLayoutMetricsSubset {
  normalStyleFont?: ContractNormalStyleFont | null;
  rowHeights: ContractRowHeight[];

  recalculateRowHeights?: number[];
  columnWidths: ContractColumnWidth[];
  defaultRowHeight?: number | null;
  defaultColumnWidth?: number | null;

  baseColumnWidth?: number | null;
  hiddenRows?: number[];
  manualHiddenRows?: number[];
  filterHiddenRows?: number[];
  hiddenColumns?: number[];
  merges?: string[];
  freezePane?: ContractFreezePaneSubset;
  gridLinesVisible?: boolean | null;

  showFormulas?: boolean | null;
  headingsVisible?: boolean | null;
  workbookViewMode?: "normal" | "page-layout" | "page-break-preview" | null;
  scrollTopLeftCell?: string | null;
  zoomScale?: number | null;
  activeCell?: string | null;
  selection?: string | null;
  selectionPane?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | null;
  sheetViews?: ContractWorkbookNamedView[] | null;
  sheetViewActiveId?: string | null;
  customViews?: ContractWorkbookNamedView[] | null;
  customViewActiveId?: string | null;
}

ContractObjectStatusPlaceholderSubset

interface ContractObjectStatusPlaceholderSubset {
  scope: ContractObjectPlaceholderScope;
  families: ContractObjectFamilyStatusPlaceholder[];
}

ContractSaveCapability

type ContractSaveCapability = (typeof CONTRACT_SAVE_CAPABILITY_IDS)[number];

ContractSessionDirection

type ContractSessionDirection = "ltr";

ContractSheetBackgroundProjection

interface ContractSheetBackgroundProjection {
  mimeType: "image/png" | "image/jpeg" | "image/gif";
  dataUrl: string;
}

ContractSheetKind

type ContractSheetKind = "worksheet" | "chartSheet";

ContractSheetObject

interface ContractSheetObject {
  id: string;

  stableId?: string;
  name?: string | null;
  altText?: string | null;
  title?: string | null;
  description?: string | null;
  decorative?: boolean;
  family: ContractSheetObjectFamily;
  status: ContractSheetObjectStatus;
  preservedSupportFamily?: ContractSheetObjectPreservedSupportFamily | null;
  renderMode?: string | null;
  bounds?: ContractSheetObjectBounds;
  anchor: ContractObjectAnchor;
  relTarget?: string | null;
  targetMode?: string | null;
  payloadRef: string;
  zOrder: number;
  readingOrder?: number;

  visible?: boolean;
  locked?: boolean;
  printObject?: boolean;
  locksWithSheet?: boolean;
  groupId?: string | null;
  parentGroupId?: string | null;
  groupDepth?: number;
  rotationDeg?: number | null;
  imageFlipH?: boolean;
  imageFlipV?: boolean;
  aspectLocked?: boolean;
  imageCrop?: ContractDrawingObjectImageCrop | null;
  imagePayload?: ContractImagePayload | null;

  graphicKind?: "svg" | null;
  linkedPicturePayload?: ContractLinkedPicturePayload | null;
  chartPayload?: ContractChartPayload | null;
  legacyNotePayload?: ContractLegacyNotePayload | null;
  threadedCommentPayload?: ContractThreadedCommentPayload | null;
  textPayload?: ContractTextPayload | null;
  smartArtPayload?: ContractSmartArtPayload | null;
  wordArtPayload?: ContractWordArtPayload | null;
  slicerPayload?: ContractSlicerPayload | null;
  groupMembers?: ContractSheetObject[] | null;

  presetGeometry?: string | null;
  shapePayload?: {
    prst: string;
    fill?: string | null;

    fillThemeSlot?: number | null;
    fillThemeLumMod?: number | null;
    fillThemeLumOff?: number | null;
    fillThemeTint?: number | null;
    fillThemeShade?: number | null;
    stroke?: string | null;
    strokeThemeSlot?: number | null;
    strokeThemeLumMod?: number | null;
    strokeThemeLumOff?: number | null;
    strokeThemeTint?: number | null;
    strokeThemeShade?: number | null;
    adjust?: number | null;

    sourceId?: string | number | null;
    sourceAnchor?: string | null;
    targetId?: string | number | null;
    targetAnchor?: string | null;
    flipH?: boolean;
    flipV?: boolean;
    routePoints?: number[] | null;
    lineKind?: "line" | "arrow" | "doubleArrow";
    lineWidthEmu?: number | null;

    rawAnchorXml?: string | null;
    adjustments?: ReadonlyArray<{ name: string; val: number }> | null;
    strokeDash?: string | null;
    isManagedShape?: boolean;
    originalNvId?: number | null;

    freeformPoints?: ReadonlyArray<{
      x: number;
      y: number;
      c1x?: number | null;
      c1y?: number | null;
      c2x?: number | null;
      c2y?: number | null;
    }> | null;
    isClosed?: boolean | null;

    fillOpacity?: number | null;
    strokeWidth?: number | null;
    strokeOpacity?: number | null;
    strokeCap?: string | null;
    strokeJoin?: string | null;
    shadowColor?: string | null;
    shadowBlur?: number | null;
    shadowAngle?: number | null;
    shadowDist?: number | null;
    shadowOpacity?: number | null;
    glowColor?: string | null;
    glowSize?: number | null;
    glowOpacity?: number | null;
    softEdges?: number | null;
    reflectionOpacity?: number | null;
    reflectionBlur?: number | null;
    reflectionDistance?: number | null;
    reflectionSize?: number | null;
    bevelTopPreset?: string | null;
    bevelTopWidth?: number | null;
    bevelTopHeight?: number | null;
    bevelBottomPreset?: string | null;
    bevelBottomWidth?: number | null;
    bevelBottomHeight?: number | null;
    depthColor?: string | null;
    depth?: number | null;
    contourColor?: string | null;
    contourWidth?: number | null;
    material?: string | null;
    lightingRig?: string | null;
    lightingAngle?: number | null;
    cameraPreset?: string | null;
    rotationX?: number | null;
    rotationY?: number | null;
    rotationZ?: number | null;
    perspective?: number | null;
    gradientFill?: boolean | null;
    gradientAngle?: number | null;
    gradientColor1?: string | null;
    gradientColor2?: string | null;
    arrowBeginType?: string | null;
    arrowBeginSize?: string | null;
    arrowBeginLength?: string | null;
    arrowBeginWidth?: string | null;
    arrowEndType?: string | null;
    arrowEndSize?: string | null;
    arrowEndLength?: string | null;
    arrowEndWidth?: string | null;
    strokeCompound?: string | null;
    headEnd?: string | null;
    tailEnd?: string | null;
  } | null;
}

ContractSheetObjectBounds

interface ContractSheetObjectBounds {
  x: number;
  y: number;
  width: number;
  height: number;
}

ContractSheetObjectFamily

type ContractSheetObjectFamily = "chart" | "image" | "shape" | "media" | "comments-notes";

ContractSheetObjectMutationAction

type ContractSheetObjectMutationAction = "create" | "edit" | "move" | "resize" | "delete";

ContractSheetObjectMutationIntent

interface ContractSheetObjectMutationIntent {
  sheetId: string;
  action: ContractSheetObjectMutationAction;
  stableId?: string | null;
}

ContractSheetObjectPreservedSupportFamily

type ContractSheetObjectPreservedSupportFamily =
  | "smart-art"
  | "ink"
  | "embedded-ole"
  | "embedded-package"
  | "media-placeholder"
  | "control-placeholder"
  | "active-x-control"
  | "form-control"
  | "audio"
  | "video"
  | "unknown";

ContractSheetObjectStatus

type ContractSheetObjectStatus = | "cataloged" | "placeholder" | "broken-rel" | "external-target" | "unsupported";

ContractSheetVisibilityState

type ContractSheetVisibilityState = "visible" | "hidden" | "veryHidden";

ContractSourceTrustSessionBinding

interface ContractSourceTrustSessionBinding {
  sourceIdentity: string;
  authority: Exclude<ContractSourceTrustAuthority, "none" | "editing_session">;
}

ContractSubsetSessionInfo

interface ContractSubsetSessionInfo {
  mode: SubsetSessionMode;
  reusableWithinProcess: boolean;
  reusableAcrossProcessLaunches: boolean;
  note: string;
}

ContractViewportReadiness

interface ContractViewportReadiness {
  schemaVersion: 1;
  state: ContractViewportReadinessState;
  subsetId: string;
  generation: number;
  terminal: boolean;
  retryOnTransition: boolean;
  projectionPublished: boolean;
  detail: string;
}

ContractViewportReadinessState

type ContractViewportReadinessState = "ready" | "deferred" | "cancelled" | "superseded" | "failed";

ContractWorkbookAccessibilityIntent

type ContractWorkbookAccessibilityIntent =
  | { action: "scan" }
  | { action: "apply";
    issueId: string;
    remediation: ContractWorkbookAccessibilityRemediationKind;
    value?: string;
  }
  | { action: "fix_all" }
  | { action: "undo" }
  | { action: "redo" };

ContractWorkbookAccessibilityIssue

interface ContractWorkbookAccessibilityIssue {
  stableId: string;
  kind: ContractWorkbookAccessibilityIssueKind;
  severity: ContractWorkbookAccessibilitySeverity;
  location: ContractWorkbookAccessibilityLocation;
  explanationCode: string;
  navigationTarget: ContractWorkbookAccessibilityNavigationTarget;
  observedRevision: number;
  remediations?: ContractWorkbookAccessibilityRemediation[];
}

ContractWorkbookAccessibilityIssueKind

type ContractWorkbookAccessibilityIssueKind =
  | "missing-object-alt-text"
  | "weak-object-alt-text"
  | "decorative-object"
  | "decorative-metadata-conflict"
  | "low-text-fill-contrast"
  | "merged-cell-hazard"
  | "blank-table-header"
  | "duplicate-table-header"
  | "ambiguous-hyperlink-text"
  | "hidden-sheet-with-content"
  | "empty-sheet-name"
  | "inaccessible-comment-authorship"
  | "inaccessible-note-authorship"
  | "chart-title-gap"
  | "chart-description-gap"
  | "non-text-content";

ContractWorkbookAccessibilityLocation

interface ContractWorkbookAccessibilityLocation {
  sheetId: string;
  sheetName: string;
  label: string;
  cellRef?: string;
  objectStableId?: string;
  tableName?: string;
}

ContractWorkbookAccessibilityNavigationTarget

type ContractWorkbookAccessibilityNavigationTarget =
  | { kind: "cell"; sheetId: string; row: number; col: number; cellRef: string }
  | { kind: "object"; sheetId: string; stableId: string }
  | { kind: "sheet"; sheetId: string }
  | { kind: "table-header"; sheetId: string; tableName: string; columnIndex: number; cellRef: string; };

ContractWorkbookAccessibilityPackageFix

type ContractWorkbookAccessibilityPackageFix =
  | { action: "set-object-accessibility";
    sheetId: string;
    stableId: string;
    title?: string;
    description?: string;
    decorative: boolean;
  }
  | { action: "set-chart-title"; sheetId: string; stableId: string; chartPath: string; title: string; }
  | { action: "set-table-header"; sheetId: string; tableName: string; columnIndex: number; value: string; }
  | { action: "set-hyperlink-text"; sheetId: string; row: number; col: number; value: string; }
  | { action: "set-sheet-state"; sheetId: string; name?: string; visibility?: ContractSheetVisibilityState; };

ContractWorkbookAccessibilityRemediation

interface ContractWorkbookAccessibilityRemediation {
  kind: ContractWorkbookAccessibilityRemediationKind;
  requiresValue: boolean;
  defaultValue?: string;
  fixAllEligible: boolean;
}

ContractWorkbookAccessibilityRemediationKind

type ContractWorkbookAccessibilityRemediationKind =
  | "set-object-alt-text"
  | "mark-object-decorative"
  | "repair-table-header"
  | "add-chart-title"
  | "add-chart-description"
  | "rename-hyperlink-text"
  | "rename-sheet"
  | "unhide-sheet";

ContractWorkbookAccessibilityResult

interface ContractWorkbookAccessibilityResult {
  requestId: string;
  generation: number;
  revision: number;
  status: ContractWorkbookAccessibilityStatus;
  reason?: string;
  totalIssueCount: number;
  returnedIssueCount: number;
  truncated: boolean;
  undoDepth: number;
  redoDepth: number;
  issues: ContractWorkbookAccessibilityIssue[];
  approvedPackageFixes?: ContractWorkbookAccessibilityPackageFix[];
}

ContractWorkbookAccessibilitySeverity

type ContractWorkbookAccessibilitySeverity = "error" | "warning" | "info";

ContractWorkbookAccessibilityStatus

type ContractWorkbookAccessibilityStatus = "scanned" | "mutated" | "undone" | "redone" | "blocked";

ContractWorkbookCalculationMode

type ContractWorkbookCalculationMode = "automatic" | "automatic_except_data_tables" | "manual" | "unknown";

ContractWorkbookConnectionDestination

type ContractWorkbookConnectionDestination =
  | { mode: "connection_only" }
  | { mode: "existing_sheet"; sheetName: string; anchor: string }
  | { mode: "new_sheet"; sheetName: string };

ContractWorkbookConnectionEntry

interface ContractWorkbookConnectionEntry {
  identity: string;
  id: string;
  ownerQueryIdentity?: string | null;
  name?: string | null;
  description?: string | null;
  connectionTypeCode?: string | null;
  refreshedVersion?: string | null;
  backgroundRefresh?: boolean | null;
  saveData?: boolean | null;
  provider?: string | null;
  queryLocation?: string | null;
  command?: string | null;
  connectionStringWhollyRedacted: boolean;

  sourceKind: string;
  loadDestination: string;
  refreshState: string;
  packageOwner: string;
  packageParts: string[];
  legacyReadOnly: boolean;
}

ContractWorkbookConnectionLoadLink

interface ContractWorkbookConnectionLoadLink {
  identity: string;
  connectionId: string;
  queryIdentity?: string | null;
  connectionName?: string | null;
  queryLocation?: string | null;
  queryTableName?: string | null;
  queryTablePart?: string | null;
}

ContractWorkbookConnectionsProjection

interface ContractWorkbookConnectionsProjection {
  scope: string;
  source: string;
  connectionCount: number;
  connections: ContractWorkbookConnectionEntry[];
  loadLinks: ContractWorkbookConnectionLoadLink[];
  note: string;
}

ContractWorkbookHistoryActiveSheetProjection

interface ContractWorkbookHistoryActiveSheetProjection {
  activeSheet: ContractActiveSheetMeta;
  workbookSheets: ContractWorkbookSheetMeta[];
  geometry: ContractGeometrySubset;
  viewport: ViewportWindow;
  previewCells: ContractPreviewCell[];
  layoutMetrics?: ContractLayoutMetricsSubset;
}

ContractWorkbookHistoryDirection

type ContractWorkbookHistoryDirection = "undo" | "redo";

ContractWorkbookHistoryOwner

type ContractWorkbookHistoryOwner =
  | "cell"
  | "range"
  | "revision_merge"
  | "defined_names"
  | "sheet_lifecycle"
  | "review_annotations"
  | "table_lifecycle"
  | "drawing_objects"
  | "sparklines"
  | "scenarios"
  | "custom_views"
  | "theme_colors"
  | "fill_across_sheets"
  | "calculation_properties";

ContractWorkbookHistoryProjection

interface ContractWorkbookHistoryProjection {
  owner?: ContractWorkbookHistoryOwner | null;
  undoDepth: number;
  redoDepth: number;

  revision: number;
}

ContractWorkbookLinkCachedValueTruth

type ContractWorkbookLinkCachedValueTruth = "imported_cache" | "refreshed" | "frozen_value" | "unavailable";

ContractWorkbookLinkInventoryEntry

interface ContractWorkbookLinkInventoryEntry {
  id: string;
  displayName: string;
  sourceKind: ContractWorkbookLinkSourceKind;
  state: ContractWorkbookLinkState;
  cachedValueTruth: ContractWorkbookLinkCachedValueTruth;
  formulaCellCount: number;
  definedNameCount: number;
  cachedCellCount: number;
  structuredTables: ContractWorkbookLinkStructuredTable[];
  sourceRevision?: string;
  canUpdate: boolean;
  canChangeSource: boolean;
  canOpenSource: boolean;
  canBreakLink: boolean;
}

ContractWorkbookLinkSourceKind

type ContractWorkbookLinkSourceKind = "local" | "network" | "cloud" | "unknown";

ContractWorkbookLinkState

type ContractWorkbookLinkState = | "cached" | "trusted" | "current" | "missing" | "moved" | "corrupt" | "blocked" | "broken";

ContractWorkbookLinkStructuredTable

interface ContractWorkbookLinkStructuredTable {
  workbookIdentity: string;
  sheetName: string;
  tableName: string;
  columnNames: string[];
  totalsRowPresent: boolean;
}

ContractWorkbookLinksIntent

type ContractWorkbookLinksIntent =
  | { action: "list" }
  | { action: "startup_decision"; trustLocalSources: boolean; expectedRevision: number; }
  | { action: "update_values"; linkIds?: string[]; expectedRevision: number }
  | { action: "change_source"; linkId: string; sourceUri: string; expectedRevision: number; }
  | { action: "open_source"; linkId: string; expectedRevision: number }
  | { action: "break_link"; linkIds?: string[]; expectedRevision: number }
  | { action: "undo"; expectedRevision: number }
  | { action: "redo"; expectedRevision: number };

ContractWorkbookLinksResult

interface ContractWorkbookLinksResult {
  status: ContractWorkbookLinksStatus;
  revision: number;
  links: ContractWorkbookLinkInventoryEntry[];
  transactionId?: string;
  openSourceUri?: string;
  reason?: string;
}

ContractWorkbookLinksStatus

type ContractWorkbookLinksStatus =
  | "listed"
  | "trust_applied"
  | "updated"
  | "source_changed"
  | "source_opened"
  | "links_broken"
  | "undone"
  | "redone"
  | "blocked";

ContractWorkbookNamedView

interface ContractWorkbookNamedView {
  id: string;
  name: string;
  snapshot: ContractWorkbookNamedViewSnapshot;
}

ContractWorkbookNamedViewSnapshot

interface ContractWorkbookNamedViewSnapshot {
  workbookViewMode?: "normal" | "page-layout" | "page-break-preview" | null;
  gridLinesVisible?: boolean | null;
  headingsVisible?: boolean | null;
  formulaBarVisible?: boolean | null;
  rulerVisible?: boolean | null;
  zoomScale?: number | null;
  windowCount?: number | null;
  windowActive?: number | null;
  windowArranged?: boolean | null;
  windowSideBySide?: boolean | null;
  windowSynchronousScrolling?: boolean | null;
}

ContractWorkbookObjectAnchorState

type ContractWorkbookObjectAnchorState = "resolved" | "unavailable" | "broken";

ContractWorkbookObjectInventoryEntry

interface ContractWorkbookObjectInventoryEntry {
  stableId: string;
  objectId: string;
  sheetIndex: number;
  sheetName: string;
  sheetPath: string;
  objectType: ContractWorkbookObjectType;
  name: string;
  title?: string | null;
  description?: string | null;

  altText?: string | null;
  decorative: boolean;
  supportState: ContractWorkbookObjectSupportState;
  presenceStatus: ContractWorkbookObjectPresenceStatus;
  targetState: ContractWorkbookObjectTargetState;
  editable: boolean;
  navigable: boolean;
  mutationCapabilities: ContractWorkbookObjectMutationCapabilities;
  anchorState: ContractWorkbookObjectAnchorState;
  anchor: ContractObjectAnchor;
  relationships: ContractWorkbookObjectRelationship[];
  zOrder: number;

  readingOrder: number;
  visible: boolean;
  locked: boolean;
  printObject: boolean;
  locksWithSheet: boolean;
  groupId?: string | null;
  parentGroupId?: string | null;
  groupDepth: number;
  cellRef?: string | null;
  formControl?: ContractFormControlView | null;
  smartArtPayload?: ContractSmartArtPayload | null;
  wordArtPayload?: ContractWordArtPayload | null;
}

ContractWorkbookObjectMutationCapabilities

interface ContractWorkbookObjectMutationCapabilities {
  moveObject: boolean;
  copyObject: boolean;
  deleteObject: boolean;
  rename: boolean;
  visibility: boolean;
  accessibility: boolean;
  print: boolean;
}

ContractWorkbookObjectPresenceStatus

type ContractWorkbookObjectPresenceStatus = "present" | "selected" | "hidden" | "locked" | "unsupported" | "error";

ContractWorkbookObjectRelationship

interface ContractWorkbookObjectRelationship {
  id: string;
  relationshipType: string;
  ownerPart: string;
  target: string;
  targetMode?: string | null;
  targetState: ContractWorkbookObjectTargetState;
}

ContractWorkbookObjectSupportState

type ContractWorkbookObjectSupportState = "live" | "stale" | "broken" | "unsupported";

ContractWorkbookObjectTargetState

type ContractWorkbookObjectTargetState = "resolved" | "broken" | "orphan" | "external" | "unsupported";

ContractWorkbookObjectType

type ContractWorkbookObjectType =
  | "chart"
  | "picture"
  | "shape"
  | "text-box"
  | "connector"
  | "group"
  | "comment"
  | "note"
  | "smart-art"
  | "word-art"
  | "ink"
  | "embedded-ole"
  | "embedded-package"
  | "active-x-control"
  | "form-control"
  | "audio"
  | "video"
  | "media"
  | "control"
  | "slicer"
  | "unknown";

ContractWorkbookReadiness

interface ContractWorkbookReadiness {
  schemaVersion: 1;
  generation: number;
  packageOpened: ContractWorkbookReadinessPhase;
  activeSheetKnown: ContractWorkbookReadinessPhase;
  firstViewportReady: ContractWorkbookReadinessPhase;
  editingReady: ContractWorkbookReadinessPhase;
  backgroundIndexing: ContractWorkbookReadinessPhase;
  fullyIndexed: ContractWorkbookReadinessPhase;
  deferredRegionCount: number;
  deferredRecalc: boolean;
}

ContractWorkbookReadinessPhase

interface ContractWorkbookReadinessPhase {
  state: ContractWorkbookReadinessPhaseState;
  terminal: boolean;
  detail: string;
}

ContractWorkbookReadinessPhaseState

type ContractWorkbookReadinessPhaseState = "pending" | "running" | "ready" | "failed" | "cancelled" | "not_required";

ContractWorkbookRevisionCellState

type ContractWorkbookRevisionCellState =
  | { kind: "absent" }
  | { kind: "blank" }
  | { kind: "empty-string" }
  | { kind: "number"; value: string }
  | { kind: "boolean"; value: boolean }
  | { kind: "text"; value: string }
  | { kind: "formula"; formula: string }
  | { kind: "error"; code: string };

ContractWorkbookRevisionCellSummary

interface ContractWorkbookRevisionCellSummary {
  kind: string;

  detail: string;
}

ContractWorkbookRevisionConflict

interface ContractWorkbookRevisionConflict {
  sheetKey: string;
  row?: number | null;
  col?: number | null;
  address: string;
  kind: ContractWorkbookRevisionConflictKind;
  base: ContractWorkbookRevisionCellSummary;
  local: ContractWorkbookRevisionCellSummary;
  incoming: ContractWorkbookRevisionCellSummary;
}

ContractWorkbookRevisionConflictKind

type ContractWorkbookRevisionConflictKind =
  | "concurrent-edit"
  | "formula-value"
  | "edit-clear"
  | "unsupported-mutation"
  | "base-mismatch"
  | "missing-sheet"
  | "local-state-mismatch";

ContractWorkbookRevisionDelta

interface ContractWorkbookRevisionDelta {
  editionId: string;
  baseRevision: number;
  revision: number;
  mutations: ContractWorkbookRevisionMutation[];
}

ContractWorkbookRevisionMergeOutcome

type ContractWorkbookRevisionMergeOutcome = "merged" | "conflicts" | "already-applied";

ContractWorkbookRevisionMutation

type ContractWorkbookRevisionMutation =
  | { mutationKind: "cell";
    sheetKey: string;
    row: number;
    col: number;
    base: ContractWorkbookRevisionCellState;
    value: ContractWorkbookRevisionCellState;
  }
  | { mutationKind: "unsupported"; sheetKey: string; row?: number
  | null; col?: number
  | null; kind: ContractWorkbookRevisionUnsupportedMutationKind; };

ContractWorkbookRevisionUnsupportedMutationKind

type ContractWorkbookRevisionUnsupportedMutationKind =
  | "sheet-lifecycle"
  | "defined-name"
  | "formatting"
  | "range-structure"
  | "table"
  | "data-validation"
  | "protection"
  | "object"
  | "workbook-metadata"
  | "external-data"
  | "power-query"
  | "vba"
  | "package-publication"
  | "unknown";

ContractWorkbookSheetMeta

interface ContractWorkbookSheetMeta {
  index: number;
  name: string;
  path: string;

  kind?: ContractSheetKind;
  visibilityState?: ContractSheetVisibilityState;
  tabColorRgb?: string | null;
  codeName?: string | null;
  sheetProtected?: boolean | null;
  sheetProtectionAllowedActions?: ContractSheetProtectionAllowedAction[] | null;
  rightToLeft?: boolean | null;
  usedRange?: string | null;
  usedRangeDirty?: boolean | null;

  sheetBackground?: ContractSheetBackgroundProjection | null;

  nonEmptyCellCount?: number | null;

  formulaCellCount?: number | null;

  isPqOutputSheet?: boolean;
}

ContractWorkbookThemeColorScheme

interface ContractWorkbookThemeColorScheme {
  name: string;
  dk1: string;
  lt1: string;
  dk2: string;
  lt2: string;
  accent1: string;
  accent2: string;
  accent3: string;
  accent4: string;
  accent5: string;
  accent6: string;
  hlink: string;
  folHlink: string;
}

ContractWorkbookThemeFontsProjection

interface ContractWorkbookThemeFontsProjection {
  major: string;
  minor: string;
}

ContractWorkbookWindowCommandState

interface ContractWorkbookWindowCommandState {
  commandId: string;
  enabled: boolean;
  active: boolean;
}

ContractWorkbookWindowSessionAction

type ContractWorkbookWindowSessionAction =
  | { action: "register_window";
    shellWindowHandle: string;
    visible: boolean;
    focused: boolean;
    view: ContractWorkbookWindowViewState;
  }
  | { action: "state"; windowId?: string
  | null }
  | { action: "activate_window"; windowId: string; focus: string }
  | { action: "update_view"; windowId: string; view: ContractWorkbookWindowViewState; }
  | { action: "set_show_formulas"; windowId: string; enabled: boolean }
  | { action: "record_activity";
    windowId: string;
    recordHistory?: boolean;
    clipboardTransferReady?: boolean;
  }
  | { action: "set_visibility"; windowId: string; visible: boolean }
  | { action: "arrange"; windowId: string }
  | { action: "set_side_by_side"; windowId: string; enabled: boolean }
  | { action: "set_synchronous_scrolling"; windowId: string; enabled: boolean }
  | { action: "close_window"; windowId: string };

ContractWorkbookWindowSessionIdentity

interface ContractWorkbookWindowSessionIdentity {
  workbookId: string;
  sessionId: string;
  subsetId: string;
}

ContractWorkbookWindowSessionProjection

interface ContractWorkbookWindowSessionProjection {
  identity: ContractWorkbookWindowSessionIdentity;
  activeWorkbookId: string;
  activeSessionId: string;
  currentWindowId: string;
  activeWindowId: string;
  viewCount: number;
  arranged: boolean;
  sideBySide: boolean;
  synchronousScrolling: boolean;
  dirty: boolean;
  windows: ContractWorkbookWindowViewProjection[];
  commandStates: ContractWorkbookWindowCommandState[];
}

ContractWorkbookWindowViewProjection

interface ContractWorkbookWindowViewProjection {
  windowId: string;
  shellWindowHandle: string;
  visible: boolean;
  focused: boolean;
  view: ContractWorkbookWindowViewState;
  historyUndoDepth: number;
  historyRedoDepth: number;
  clipboardTransferReady: boolean;
}

ContractWorkbookWindowViewState

interface ContractWorkbookWindowViewState {
  activeSheetKey: string;
  activeCell: string;
  selection: string;
  focus: string;
  viewport: ViewportWindow;

  showFormulas?: boolean;
  showFormulasPersistence?: ContractFormulaAuditingStatePersistence;
}

ContractXlsxSheetBackgroundPatch

interface ContractXlsxSheetBackgroundPatch {
  activeSheetPath: string;
  sheetName?: string | null;
  mimeType?: "image/png" | "image/jpeg" | "image/gif" | null;
  dataUrl?: string | null;
  fileName?: string | null;
  remove?: boolean | null;
}

ContractXlsxSheetFormatPatch

interface ContractXlsxSheetFormatPatch {
  activeSheetPath: string;
  defaultRowHeight?: number | null;
  defaultColWidth?: number | null;
  baseColWidth?: number | null;
  customHeight?: boolean | null;
}

ContractXlsxTextBoxSheetPatch

interface ContractXlsxTextBoxSheetPatch {
  activeSheetPath: string;
  objects: ContractXlsxTextBoxObjectPatch[];
}

ContractXlsxWorkbookActiveSheetPatch

interface ContractXlsxWorkbookActiveSheetPatch {
  activeSheetPath: string;
}

ContractXlsxWorkbookThemeColorsPatch

interface ContractXlsxWorkbookThemeColorsPatch {
  colorSetId: string;
}

ContractXlsxWorkbookThemePatch

interface ContractXlsxWorkbookThemePatch {
  presetId: string;
}

ContractXlsxWorkbookViewSelectionPatch

interface ContractXlsxWorkbookViewSelectionPatch {
  activeSheetPath: string;
  activeCell: string;
  sqref: string;
  pane?: string | null;
}

EditorSessionStamp

interface EditorSessionStamp {
  editorSessionId: string;
  generation: number;
}

FormulaSubsetStatus

type FormulaSubsetStatus = "supported" | "unsupported" | "not-formula";

OpenWorkbookSubsetProjectionPayload

interface OpenWorkbookSubsetProjectionPayload {
  operation: "open_workbook_subset";
  subsetId: string;
  sheetCount: number;
  session: ContractSubsetSessionInfo;
  readiness: ContractWorkbookReadiness;
  formatCapabilities?: ContractFormatCapabilities | null;
  xlsbDirtySaveProfile?: ContractXlsbDirtySaveProfile | null;
  activeSheet: ContractActiveSheetMeta;
  workbookSheets?: ContractWorkbookSheetMeta[];
  themeFonts?: ContractWorkbookThemeFontsProjection | null;
  tableMetadata?: ContractTableMetadataProjection | null;
  workbookTableMetadata?: ContractTableMetadataProjection | null;
  workbookConnections?: ContractWorkbookConnectionsProjection | null;
  worksheetAutoFilterMetadata?: ContractWorksheetAutoFilterMetadata | null;
  directionPlaceholder?: ContractDirectionPlaceholderSubset | null;
  objectStatusPlaceholder?: ContractObjectStatusPlaceholderSubset | null;
  surfaceObjects?: ContractSheetObject[] | null;
  objectInventory?: ContractWorkbookObjectInventoryEntry[] | null;
  inkProjection?: ContractReviewInkProjectionItem[] | null;
  geometry: ContractGeometrySubset;
  recalcNeeded: boolean;
  viewport: ViewportWindow;
  previewCells: ContractPreviewCell[];
  conditionalFormattingRules?: ContractConditionalRule[];
  dataValidationMetadata?: ContractDataValidationMetadata;

  frozenBandCells?: ContractPreviewCell[];

  bodyMergeAnchorCells?: ContractPreviewCell[];
  bodyTextOverflowAnchorCells?: ContractPreviewCell[];
  layoutMetrics?: ContractLayoutMetricsSubset | null;
  formulaTrustSnapshot?: ContractFormulaTrustSnapshot | null;
  themeColorPalette?: string[];

  viewportReadiness?: ContractViewportReadiness;
}

SubsetSessionMode

type SubsetSessionMode = "transient-non-reusable" | "process-reusable" | "persistent";

ViewportWindow

interface ViewportWindow {
  top: number;
  left: number;
  rows: number;
  cols: number;
}

WorkbookIdentityDescriptor

type WorkbookIdentityDescriptor =
  | { kind: "sheet"; name: string }
  | { kind: "table"; name: string }
  | { kind: "named"; name: string };

WorkbookSelectorDescriptor

type WorkbookSelectorDescriptor =
  | { kind: "sheet"; name: string }
  | { kind: "table"; name: string }
  | { kind: "named-range"; name: string };

WorkbookSourceDescriptor

interface WorkbookSourceDescriptor {
  workbookId: string;
  queryId?: string;
  source: WorkbookIdentityDescriptor;
  request: SourceRequestDescriptor;
  grid: SourceGridDescriptor;
  revoked?: boolean;
}

WorkbookVersionByteProvenance

interface WorkbookVersionByteProvenance {
  format: WorkbookVersionFormat;
  byteLength: number;
  sha256: string;
  readOnly: boolean;
  macroEnabled: boolean;
  signaturePresent: boolean;
}

WorkbookVersionCategoryDiff

interface WorkbookVersionCategoryDiff {
  category:
    | "values"
    | "formulas"
    | "styles"
    | "comments"
    | "sheets"
    | "names"
    | "tables"
    | "pivots"
    | "drawings"
    | "relationships";
  support: WorkbookVersionCategorySupport;
  currentCount: number;
  versionCount: number;
  addedCount: number;
  removedCount: number;
  changedCount: number;
  currentFingerprint: string;
  versionFingerprint: string;
  reasonCode: string;
  truncated: boolean;
}

WorkbookVersionCategorySupport

type WorkbookVersionCategorySupport = "compared" | "detect_only" | "unsupported" | "blocked";

WorkbookVersionCompareStatus

type WorkbookVersionCompareStatus = "identical" | "different" | "blocked";

WorkbookVersionFormat

type WorkbookVersionFormat = "xlsx" | "xlsm" | "xltm" | "csv" | "ods";

WorkbookVersionStructuralDiff

interface WorkbookVersionStructuralDiff {
  schemaVersion: 1;
  status: WorkbookVersionCompareStatus;
  current: WorkbookVersionByteProvenance;
  version: WorkbookVersionByteProvenance;
  categories: WorkbookVersionCategoryDiff[];
  changedCategoryCount: number;
  detectOnlyCategoryCount: number;
  unsupportedCategoryCount: number;
  blockedReasonCode?: string | null;
  redactionProfile: "stable-hashes-counts-reason-codes-only-v1";
}