Public API

Typed command definitions and transaction factories shared by editor composition roots.

classDocCommandBussource ↗

class DocCommandBus

The supported execution entry point for document user and program actions.

constructorconstructor

DocCommandBus(platform?: Platform): DocCommandBus

Creates a command bus that reports boundary diagnostics through the host platform.

platform: Platform

propertysymbolstatic

readonly symbol: typeof symbol

DI token for resolving the command bus bound to one document editor instance.

methodbind

bind(context: DocCommandContext): void

Binds the command bus to the runtime services for one editor instance.

context: DocCommandContext

methoddestroy

destroy(): void

Clears editor binding, listeners, and command registrations during teardown.

methodenforceRegistrationBoundary

enforceRegistrationBoundary(assertWrite: (): void): void

Closes setup-time command registration after the editor is assembled.

assertWrite: (): void

methodgetRegisteredCommandIds

getRegisteredCommandIds(): readonly string[]

Returns a stable snapshot of all document commands exposed by this editor instance.

methodgetRegisteredCommands

getRegisteredCommands(): readonly DocCommandDefinition<unknown, DocCommandResult>[]

Returns the typed definitions registered on this editor instance.

methodhas

has(definition: string | DocCommandDefinition<unknown, DocCommandResult>): boolean

Returns whether this editor instance currently exposes a document command id.

definition: string | DocCommandDefinition<unknown, DocCommandResult>

methodisExecuting

isExecuting(): boolean

Whether this editor's command bus is currently dispatching a command.

methodregister

register<Definition>(definition: Definition, factory: DocCommandFactory<Definition>): (): void

Registers one feature-owned command factory. The returned function must be
called by lifecycle cleanup when a feature registers dynamically.

definition: Definition

factory: DocCommandFactory<Definition>

methodrun

run<Definition>(definition: Definition, input: DocCommandInput<Definition>): DocCommandDefinitionResult<Definition>

Executes a registered command through its feature-owned typed definition.

definition: Definition

input: DocCommandInput<Definition>

methodrunWithoutMutationAuthority

runWithoutMutationAuthority<Value>(callback: (): Value): Value

Invokes external observers without inheriting this editor's command write authority.

callback: (): Value

methodsubscribe

subscribe(listener: DocCommandListener): (): void

Subscribes to document command lifecycle events and returns an unsubscribe function.

listener: DocCommandListener

classDocCommandDispatchersource ↗

class DocCommandDispatcher

Executes document command objects against one command context.

constructorconstructor

DocCommandDispatcher(): DocCommandDispatcher

methodexecute

execute<Result>(context: DocCommandContext, command: DocEditorCommand<Result>): Result

Runs a command, validates its result and applies its operation/effects.

context: DocCommandContext

command: DocEditorCommand<Result>

classEffectCommandsource ↗

class EffectCommand extends SheetCommand<SheetCommandResult>

Command that emits local effects without mutating OT state.

constructorconstructor

EffectCommand(effects: readonly SheetCommandEffect[]): EffectCommand

Creates an effect-only command.

effects: readonly SheetCommandEffect[]

propertyid

readonly id: "effect.apply"

Stable id for effect-only command execution.

methodexecute

execute(_context: SheetCommandContext): SheetCommandResult

Returns an empty pipeline plus the local effects to apply.

_context: SheetCommandContext

classLocalActionCommandsource ↗

class LocalActionCommand extends SheetCommand<SheetCommandResult>

Runs a local, command-owned action that does not produce an OT transaction.

constructorconstructor

LocalActionCommand(id: string, run: (): void): LocalActionCommand

Creates a command that schedules one local action in a pipeline.

id: string

run: (): void

propertyid

readonly id: string

Stable, domain-owned command identifier for observability and automation.

methodexecute

execute(_context: SheetCommandContext): SheetCommandResult

Returns a pipeline containing only the local action step.

_context: SheetCommandContext

classPipelineExecutionCommandsource ↗

class PipelineExecutionCommand extends SheetCommand<SheetCommandResult>

Executes a complete, named pipeline through the command bus.

constructorconstructor

PipelineExecutionCommand(id: string, pipeline: Pipeline): PipelineExecutionCommand

Creates a command around an existing named pipeline.

id: string

pipeline: Pipeline

propertyid

readonly id: string

Stable, domain-owned command identifier for observability and automation.

methodexecute

execute(_context: SheetCommandContext): SheetCommandResult

Returns the provided pipeline unchanged.

_context: SheetCommandContext

classSheetAxisMoveBoundsErrorsource ↗

class SheetAxisMoveBoundsError extends SearError

A requested block or insertion boundary falls outside its axis.

constructorconstructor

SheetAxisMoveBoundsError(input: SheetMoveAxisInput, size: number): SheetAxisMoveBoundsError

input: SheetMoveAxisInput

size: number

propertycauseinherited

cause?: unknown

propertycode

readonly code: "SHEET_AXIS_MOVE_BOUNDS"

Stable machine-readable identifier for this error category.

propertydetailsinherited

readonly details: SearErrorDetails

propertymessageinherited

message: string

propertynameinherited

name: string

propertystackinherited

stack?: string

propertystackTraceLimitstaticinherited

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

methodreportinherited

report(): this

Reports this error with a compact, styled console header and diagnostics.
Returning the error keeps throw new SearError(...).report() ergonomic.

methodcaptureStackTracestaticinherited

captureStackTrace(targetObject: object, constructorOpt?: Function): void captureStackTrace(targetObject: object, constructorOpt?: Function): void

Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.

``js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to new Error().stack
`

The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.

The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:

`js
function a() {
b();
}

function b() {
c();
}

function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;

// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}

a();
``

targetObject: object

constructorOpt: Function

methodprepareStackTracestaticinherited

prepareStackTrace(err: Error, stackTraces: CallSite[]): any prepareStackTrace(err: Error, stackTraces: CallSite[]): any

err: Error

stackTraces: CallSite[]

classSheetCommandBussource ↗

class SheetCommandBus

The only supported execution entry point for sheet user and program actions.
Hosts bind it to one editor instance after the Core has been created.

constructorconstructor

SheetCommandBus(platform?: Platform): SheetCommandBus

Creates a command bus that reports boundary diagnostics through the host platform.

platform: Platform

propertysymbolstatic

readonly symbol: typeof symbol

DI token for resolving the command bus bound to one editor instance.

methodbind

bind(context: SheetCommandContext): void

Binds the command bus to the runtime services for one editor instance.

context: SheetCommandContext

methoddestroy

destroy(): void

Clears editor binding, listeners and command registrations during teardown.

methodenforceRegistrationBoundary

enforceRegistrationBoundary(assertWrite: (): void): void

Closes setup-time command registration after the editor is assembled.

assertWrite: (): void

methodgetRegisteredCommandIds

getRegisteredCommandIds(): readonly string[]

Returns a stable snapshot of all commands exposed by this editor instance.

methodgetRegisteredCommands

getRegisteredCommands(): readonly SheetCommandDefinition<unknown, SheetCommandResult>[]

Returns the typed definitions registered on this editor instance.

methodhas

has(definition: string | SheetCommandDefinition<unknown, SheetCommandResult>): boolean

Returns whether this editor instance currently exposes a command id.

definition: string | SheetCommandDefinition<unknown, SheetCommandResult>

methodisExecuting

isExecuting(): boolean

Whether this editor's command bus is currently dispatching a command.

methodregister

register<Definition>(definition: Definition, factory: SheetCommandFactory<Definition>): (): void

Registers one feature-owned command factory. The returned function must be
called by the feature's lifecycle cleanup when it registers dynamically.

definition: Definition

factory: SheetCommandFactory<Definition>

methodrun

run<Definition>(definition: Definition, input: SheetCommandInput<Definition>): SheetCommandDefinitionResult<Definition>

Executes a registered command through its feature-owned typed definition.

definition: Definition

input: SheetCommandInput<Definition>

methodrunWithoutMutationAuthority

runWithoutMutationAuthority<Value>(callback: (): Value): Value

Invokes external observers without inheriting this editor's command write authority.

callback: (): Value

methodsubscribe

subscribe(listener: SheetCommandListener): (): void

Subscribes to command lifecycle events and returns an unsubscribe function.

listener: SheetCommandListener

classSheetCommandDispatchersource ↗

class SheetCommandDispatcher

Executes command objects against one command context.

constructorconstructor

SheetCommandDispatcher(): SheetCommandDispatcher

methodexecute

execute<Result>(context: SheetCommandContext, command: SheetCommand<Result>): Result

Runs a command, validates its result and applies its pipeline/effects.

context: SheetCommandContext

command: SheetCommand<Result>

classSheetQueryRegistrysource ↗

class SheetQueryRegistry

Editor-local registry for typed, side-effect-free sheet queries.

constructorconstructor

SheetQueryRegistry(): SheetQueryRegistry

propertysymbolstatic

readonly symbol: typeof symbol

methoddestroy

destroy(): void

methodenforceWriteBoundary

enforceWriteBoundary(assertWrite: (): void): void

Requires editor command dispatch for registration changes after assembly.

assertWrite: (): void

methodgetRegisteredQueryIds

getRegisteredQueryIds(): readonly string[]

methodhas

has(definition: string | SheetQueryDefinition<unknown, unknown>): boolean

definition: string | SheetQueryDefinition<unknown, unknown>

methodregister

register<Definition>(definition: Definition, handler: SheetQueryHandler<SheetQueryInput<Definition>, SheetQueryResult<Definition>>): (): void

definition: Definition

handler: SheetQueryHandler<SheetQueryInput<Definition>, SheetQueryResult<Definition>>

methodrun

run<Definition>(definition: Definition, input: SheetQueryInput<Definition>): SheetQueryResult<Definition>

definition: Definition

input: SheetQueryInput<Definition>

classTransactionPipelineCommandsource ↗

class TransactionPipelineCommand extends SheetCommand<SheetCommandResult>

Executes an already-created transaction through the pipeline command boundary.

constructorconstructor

TransactionPipelineCommand(id: string, transaction: Transaction): TransactionPipelineCommand

Creates a command around an existing transaction.

id: string

transaction: Transaction

propertyid

readonly id: string

Stable, domain-owned command identifier for observability and automation.

methodexecute

execute(_context: SheetCommandContext): SheetCommandResult

Converts the provided transaction into a pipeline result.

_context: SheetCommandContext

interfaceDocCommandContextsource ↗

interface DocCommandContext

Runtime services exposed to document commands while they execute.

methodapplyEffect

applyEffect(effect: DocCommandEffect): void

Applies a local UI/runtime effect after the operation has been committed.

effect: DocCommandEffect

methodexecutePipeline

executePipeline(pipeline: Pipeline): void

Executes command-owned work through the document core's shared pipeline
boundary. Implementations commit document state before rendering.

pipeline: Pipeline

interfaceDocCommandDefinitionsource ↗

interface DocCommandDefinition<Input, Result>

A stable document command identifier carrying its input and result contract.

property[docCommandInputType]

readonly [docCommandInputType]: Input

Phantom field that preserves the command input type for callers.

property[docCommandResultType]

readonly [docCommandResultType]: Result

Phantom field that preserves the command result type for callers.

propertyid

readonly id: string

Globally stable command id owned by the document feature package that defines it.

interfaceDocCommandEventsource ↗

interface DocCommandEvent

Lifecycle event emitted by the document command bus for diagnostics and host UI.

propertyerror

readonly error?: unknown

Original thrown value when the command failed.

propertyid

readonly id: string

Stable command id being executed.

propertyphase

readonly phase: CommandExecutionPhase

Execution phase represented by this event.

propertyresult

readonly result?: DocCommandResult

Result returned by a completed command.

interfaceDocCommandResultsource ↗

interface DocCommandResult

Standard command result that document Core can execute and observe.

propertyeffects

readonly effects?: readonly DocCommandEffect[]

Optional local effects requested after operation execution.

propertypipeline

readonly pipeline: Pipeline

Command-owned pipeline containing mutation, render and local-action steps.

interfaceDocEditorCommandsource ↗

interface DocEditorCommand<Result>

Executable unit behind a typed document command definition.

propertyid

readonly id: string

Stable, domain-owned command identifier for observability and automation.

methodexecute

execute(context: DocCommandContext): Result

Runs command logic and returns a pipeline-backed result.

context: DocCommandContext

interfaceExtendSelectionCommandInputsource ↗

interface ExtendSelectionCommandInput

Input required to extend a sheet selection by keyboard navigation.

propertycursor

readonly cursor: SelectionPoint

Current moving edge before this navigation step.

propertydirection

readonly direction: SelectionMoveDirection

Direction requested by the user.

propertyfindMerge

readonly findMerge: (point: SelectionPoint): { end: SelectionPoint; start: SelectionPoint } | undefined

Lookup for merged ranges that should be selected as a whole.

propertyjumpToEdge

readonly jumpToEdge?: boolean

Whether navigation should jump to the sheet edge.

propertylastCol

readonly lastCol: number

Last valid column index.

propertylastRow

readonly lastRow: number

Last valid row index.

propertyorigin

readonly origin: SelectionPoint

Fixed selection anchor where extension began.

interfaceMoveSelectionCommandInputsource ↗

interface MoveSelectionCommandInput

Public contract for MoveSelectionCommandInput.

propertydirection

readonly direction: SelectionMoveDirection

propertyfindMerge

readonly findMerge: (point: SheetPoint): SheetMergedCellRange | undefined

propertyfocus

readonly focus: SheetPoint

propertyjumpToEdge

readonly jumpToEdge?: boolean

propertylastCol

readonly lastCol: number

propertylastRow

readonly lastRow: number

interfaceMoveSelectionCommandResultsource ↗

interface MoveSelectionCommandResult

Public contract for MoveSelectionCommandResult.

propertyanchor

readonly anchor: [number, number]

propertyfocus

readonly focus: [number, number]

interfaceSelectRangeCommandInputsource ↗

interface SelectRangeCommandInput

Public contract for SelectRangeCommandInput.

propertyend

readonly end: SelectionPoint

propertyfindMerge

readonly findMerge: (point: SelectionPoint): { end: SelectionPoint; start: SelectionPoint } | undefined

propertylastCol

readonly lastCol?: number

propertylastRow

readonly lastRow?: number

propertystart

readonly start: SelectionPoint

interfaceSelectRangeCommandResultsource ↗

interface SelectRangeCommandResult

Public contract for SelectRangeCommandResult.

propertyanchor

readonly anchor: [number, number]

propertyfocus

readonly focus: [number, number]

interfaceSheetClearRangeContentsCommandDataSourcesource ↗

interface SheetClearRangeContentsCommandDataSource<Cell>

Sheet cell data required to create clear-contents operations.

propertytarget

readonly target: PluginKey

Plugin key that owns the persisted sheet data matrix.

methodgetColumnCount

getColumnCount(): number

Current column count.

methodgetRowCount

getRowCount(): number

Current row count.

methodreadCell

readCell(row: number, column: number): Cell | null

Reads the current cell value at row, column.

row: number

column: number

interfaceSheetClearRangeContentsInputsource ↗

interface SheetClearRangeContentsInput extends SheetRangeInput

Public input for clearing persisted contents in a range.

propertyanchorinherited

readonly anchor: SheetCellPoint

One corner of the target range.

propertyfocusinherited

readonly focus: SheetCellPoint

Opposite corner of the target range.

interfaceSheetCommandsource ↗

interface SheetCommand<Result>

Executable unit behind a typed command definition.

propertyid

readonly id: string

Stable, domain-owned command identifier for observability and automation.

methodexecute

execute(context: SheetCommandContext): Result

Runs command logic and returns a pipeline-backed result.

context: SheetCommandContext

interfaceSheetCommandContextsource ↗

interface SheetCommandContext

Runtime services exposed to commands while they execute.

methodapplyEffect

applyEffect(effect: SheetCommandEffect): void

Applies a local UI/runtime effect after pipeline execution.

effect: SheetCommandEffect

methodexecutePipeline

executePipeline(pipeline: Pipeline): void

Applies the command-produced pipeline through the core transaction boundary.

pipeline: Pipeline

interfaceSheetCommandDefinitionsource ↗

interface SheetCommandDefinition<Input, Result>

A stable command identifier carrying its input and result contract.

property[sheetCommandInputType]

readonly [sheetCommandInputType]: Input

Phantom field that preserves the command input type for callers.

property[sheetCommandResultType]

readonly [sheetCommandResultType]: Result

Phantom field that preserves the command result type for callers.

propertyid

readonly id: string

Globally stable command id owned by the feature package that defines it.

interfaceSheetCommandEventsource ↗

interface SheetCommandEvent

Lifecycle event emitted by the command bus for diagnostics and host UI.

propertyerror

readonly error?: unknown

Original thrown value when the command failed.

propertyid

readonly id: string

Stable command id being executed.

propertyphase

readonly phase: CommandExecutionPhase

Execution phase represented by this event.

propertyresult

readonly result?: SheetCommandResult

Successfully executed command result, present only for the completed phase.

interfaceSheetCommandResultsource ↗

interface SheetCommandResult

Standard command result that Core can execute and observe.

propertycompletion

readonly completion?: Promise<unknown>

Optional asynchronous completion of a command-owned external effect.

propertyeffects

readonly effects?: readonly SheetCommandEffect[]

Optional local effects requested after pipeline execution.

propertypipeline

readonly pipeline: Pipeline

Pipeline containing transaction, render, interaction and local-action steps.

interfaceSheetDeleteColumnsInputsource ↗

interface SheetDeleteColumnsInput

Public input for deleting columns starting at index.

propertycount

readonly count?: number

propertyindex

readonly index: number

interfaceSheetDeleteRowsInputsource ↗

interface SheetDeleteRowsInput

Public input for deleting rows starting at index.

propertycount

readonly count?: number

propertyindex

readonly index: number

interfaceSheetInsertColumnsInputsource ↗

interface SheetInsertColumnsInput

Public input for inserting columns before index.

propertycount

readonly count?: number

propertyindex

readonly index: number

interfaceSheetInsertRowsInputsource ↗

interface SheetInsertRowsInput

Public input for inserting rows before index.

propertycount

readonly count?: number

propertyindex

readonly index: number

interfaceSheetMoveAxisInputsource ↗

interface SheetMoveAxisInput

Moves a contiguous block before a boundary in the original axis (0 through size).

propertybefore

readonly before: number

propertycount

readonly count?: number

propertyindex

readonly index: number

interfaceSheetQueryDefinitionsource ↗

interface SheetQueryDefinition<Input, Result>

A stable query identifier carrying its input and result contract.

property__input

readonly __input?: Input

property__result

readonly __result?: Result

propertyid

readonly id: string

propertyresultMode

readonly resultMode?: "reader"

Reader queries return a live, read-only projection instead of a data snapshot.

interfaceSheetRangeBoundssource ↗

interface SheetRangeBounds

Normalized rectangular sheet range bounds expressed as inclusive cell coordinates.

propertyend

readonly end: SheetCellPoint

Inclusive bottom-right cell coordinate.

propertystart

readonly start: SheetCellPoint

Inclusive top-left cell coordinate.

interfaceSheetRangeInputsource ↗

interface SheetRangeInput

Common range input accepted by explicit range commands.

propertyanchor

readonly anchor: SheetCellPoint

One corner of the target range.

propertyfocus

readonly focus: SheetCellPoint

Opposite corner of the target range.

interfaceSheetStructureCommandDataSourcesource ↗

interface SheetStructureCommandDataSource<Cell>

Sheet matrix access used by structure commands without depending on a concrete data package.

propertytarget

readonly target: PluginKey

Plugin key that owns the persisted sheet data matrix.

methodgetColumnCount

getColumnCount(): number

Current column count.

methodgetRowCount

getRowCount(): number

Current row count.

methodreadColumn

readColumn(index: number): Cell | null[]

Reads a dense column payload for invertible column deletion.

index: number

methodreadRow

readRow(index: number): Cell | null[]

Reads a dense row payload for invertible row deletion.

index: number

typeCommandExecutionPhasesource ↗

type CommandExecutionPhase = typeof CommandExecutionPhase[keyof typeof CommandExecutionPhase]

Public string union for command lifecycle event phases.

typeDocCommandDefinitionResultsource ↗

type DocCommandDefinitionResult = conditional

Extracts the result contract from a typed document command definition.

typeDocCommandEffectsource ↗

type DocCommandEffect = { type: "focus-document" } | { type: "reset-caret-blink" }

Local runtime effects that document commands can request outside document state.

typeDocCommandFactorysource ↗

type DocCommandFactory = (input: DocCommandInput<Definition>): DocEditorCommand<DocCommandDefinitionResult<Definition>>

Factory installed by a document feature plugin to create a command from typed input.

typeDocCommandInputsource ↗

type DocCommandInput = conditional

Extracts the input contract from a typed document command definition.

typeDocCommandListenersource ↗

type DocCommandListener = (event: DocCommandEvent): void

Observer invoked when document command execution starts, completes, or fails.

typeSelectionMoveDirectionsource ↗

type SelectionMoveDirection = typeof SelectionMoveDirection[keyof typeof SelectionMoveDirection]

Type contract for SelectionMoveDirection.

typeSheetCellPointsource ↗

type SheetCellPoint = readonly [number, number]

A zero-based sheet cell coordinate expressed as [row, column].

typeSheetCommandDefinitionResultsource ↗

type SheetCommandDefinitionResult = conditional

Extracts the result contract from a typed command definition.

typeSheetCommandFactorysource ↗

type SheetCommandFactory = (input: SheetCommandInput<Definition>): SheetCommand<SheetCommandDefinitionResult<Definition>>

Factory installed by a feature plugin to create a command from typed input.

typeSheetCommandInputsource ↗

type SheetCommandInput = conditional

Extracts the input contract from a typed command definition.

typeSheetCommandListenersource ↗

type SheetCommandListener = (event: SheetCommandEvent): void

Observer invoked when command execution starts, completes or fails.

typeSheetQueryHandlersource ↗

type SheetQueryHandler = (input: Input): Result

typeSheetQueryInputsource ↗

type SheetQueryInput = conditional

typeSheetQueryResultsource ↗

type SheetQueryResult = conditional

typeSheetRangeCommandDataSourcesource ↗

type SheetRangeCommandDataSource = SheetClearRangeContentsCommandDataSource<Cell>

Data source for the built-in clear-contents command.

variableClearRangeContentsCommandsource ↗

ClearRangeContentsCommand: SheetCommandDefinition<SheetClearRangeContentsInput, SheetCommandResult>

Clears persisted cell contents in an explicit rectangular range.

variableCommandExecutionPhasesource ↗

CommandExecutionPhase: { Completed: "completed"; Failed: "failed"; Started: "started" }

Stable lifecycle phases emitted by Sheet, Doc, and Workbook command buses.

variableDeleteColumnCommandsource ↗

DeleteColumnCommand: SheetCommandDefinition<SheetDeleteColumnsInput, SheetCommandResult>

Deletes one or more columns starting at the requested column index.

variableDeleteRowCommandsource ↗

DeleteRowCommand: SheetCommandDefinition<SheetDeleteRowsInput, SheetCommandResult>

Deletes one or more rows starting at the requested row index.

variableInsertColumnCommandsource ↗

InsertColumnCommand: SheetCommandDefinition<SheetInsertColumnsInput, SheetCommandResult>

Inserts one or more columns before the requested column index.

variableInsertRowCommandsource ↗

InsertRowCommand: SheetCommandDefinition<SheetInsertRowsInput, SheetCommandResult>

Inserts one or more rows before the requested row index.

variableMoveColumnsCommandsource ↗

MoveColumnsCommand: SheetCommandDefinition<SheetMoveAxisInput, SheetCommandResult>

Reorders complete columns without overwriting their neighbors.

variableMoveRowsCommandsource ↗

MoveRowsCommand: SheetCommandDefinition<SheetMoveAxisInput, SheetCommandResult>

Reorders complete rows without overwriting their neighbors.

variableSelectionMoveDirectionsource ↗

SelectionMoveDirection: { Down: "down"; Left: "left"; Right: "right"; Up: "up" }

Cardinal directions accepted by sheet-selection navigation commands.

functioncreateClearRangeContentsOperationssource ↗

createClearRangeContentsOperations<Cell>(input: SheetClearRangeContentsInput, dataSource: SheetClearRangeContentsCommandDataSource<Cell>): UpdateCellOTOperation<Cell>[]

Creates UpdateCell operations that clear non-empty cells inside a range.

input: SheetClearRangeContentsInput

dataSource: SheetClearRangeContentsCommandDataSource<Cell>

functioncreateDeleteColumnOperationssource ↗

createDeleteColumnOperations(input: SheetDeleteColumnsInput, dataSource: Pick<SheetStructureCommandDataSource, "getColumnCount" | "readColumn">): DeleteColOTOperation<unknown>[]

Creates ColDelete operations from public command input, ordered from right to left.

input: SheetDeleteColumnsInput

dataSource: Pick<SheetStructureCommandDataSource, "getColumnCount" | "readColumn">

functioncreateDeleteRowOperationssource ↗

createDeleteRowOperations(input: SheetDeleteRowsInput, dataSource: Pick<SheetStructureCommandDataSource, "getRowCount" | "readRow">): DeleteRowOTOperation<unknown>[]

Creates RowDelete operations from public command input, ordered from bottom to top.

input: SheetDeleteRowsInput

dataSource: Pick<SheetStructureCommandDataSource, "getRowCount" | "readRow">

functioncreateInsertColumnOperationssource ↗

createInsertColumnOperations(input: SheetInsertColumnsInput, dataSource: Pick<SheetStructureCommandDataSource, "getRowCount">): InsertColOTOperation<unknown>[]

Creates ColInsert operations from public command input.

input: SheetInsertColumnsInput

dataSource: Pick<SheetStructureCommandDataSource, "getRowCount">

functioncreateInsertRowOperationssource ↗

createInsertRowOperations(input: SheetInsertRowsInput, dataSource: Pick<SheetStructureCommandDataSource, "getColumnCount">): InsertRowOTOperation<unknown>[]

Creates RowInsert operations from public command input.

input: SheetInsertRowsInput

dataSource: Pick<SheetStructureCommandDataSource, "getColumnCount">

functioncreateMoveColumnsOperationssource ↗

createMoveColumnsOperations(input: SheetMoveAxisInput, size: number): MoveColOTOperation<unknown>[]

Creates column swaps implementing insertion at an original column boundary.

input: SheetMoveAxisInput

size: number

functioncreateMoveRowsOperationssource ↗

createMoveRowsOperations(input: SheetMoveAxisInput, size: number): MoveRowOTOperation<unknown>[]

Creates row swaps implementing insertion at an original row boundary.

input: SheetMoveAxisInput

size: number

functioncreateSheetTransactionsource ↗

createSheetTransaction<OperationType>(target: PluginKey, operations: readonly OperationType[], meta?: Readonly<Record<string, unknown>>): Transaction

Creates a transaction for command factories that need to produce pipeline transactions internally.

target: PluginKey

operations: readonly OperationType[]

meta: Readonly<Record<string, unknown>>

functiondefineDocCommandsource ↗

defineDocCommand<Input, Result>(id: string): DocCommandDefinition<Input, Result>

Creates an immutable, feature-owned document command contract.

id: string

functiondefineSheetCommandsource ↗

defineSheetCommand<Input, Result>(id: string): SheetCommandDefinition<Input, Result>

Creates an immutable, feature-owned command contract.

id: string

functiondefineSheetQuerysource ↗

defineSheetQuery<Input, Result>(id: string): SheetQueryDefinition<Input, Result>

Creates an immutable, feature-owned query contract.

id: string

functiondefineSheetReaderQuerysource ↗

defineSheetReaderQuery<Input, Result>(id: string): SheetQueryDefinition<Input, Result>

Defines a live reader whose methods own detached values at their read boundary.

id: string

functionextendSelectionsource ↗

extendSelection(input: ExtendSelectionCommandInput): { anchor: [number, number]; cursor: [number, number]; focus: [number, number] }

Extends a selection by one keyboard navigation step.

ReturnsNormalized selection range and updated moving cursor.

input: ExtendSelectionCommandInput

Current selection extension state.

functionmoveSelectionsource ↗

moveSelection(input: MoveSelectionCommandInput): MoveSelectionCommandResult

Resolves navigation as a sheet interaction, including merged-range boundaries.

input: MoveSelectionCommandInput

functionregisterSheetRangeCommandssource ↗

registerSheetRangeCommands(commands: SheetCommandBus, dataSource: SheetRangeCommandDataSource): void

Registers the built-in range commands on one sheet command bus.

commands: SheetCommandBus

dataSource: SheetRangeCommandDataSource

functionregisterSheetStructureCommandssource ↗

registerSheetStructureCommands(commands: SheetCommandBus, dataSource: SheetStructureCommandDataSource, moves?: SheetStructureMoveRegistry): void

Registers the default sheet row/column structure commands.

commands: SheetCommandBus

dataSource: SheetStructureCommandDataSource

moves: SheetStructureMoveRegistry

functionselectRangesource ↗

selectRange(input: SelectRangeCommandInput): SelectRangeCommandResult

Normalizes pointer or test-provided ranges so intersected merged cells are selected whole.

input: SelectRangeCommandInput

classSheetQueryBussource ↗

class SheetQueryBus

Editor-local registry for typed, side-effect-free sheet queries.

constructorconstructor

SheetQueryRegistry(): SheetQueryRegistry

propertysymbolstatic

readonly symbol: typeof symbol

methoddestroy

destroy(): void

methodenforceWriteBoundary

enforceWriteBoundary(assertWrite: (): void): void

Requires editor command dispatch for registration changes after assembly.

assertWrite: (): void

methodgetRegisteredQueryIds

getRegisteredQueryIds(): readonly string[]

methodhas

has(definition: string | SheetQueryDefinition<unknown, unknown>): boolean

definition: string | SheetQueryDefinition<unknown, unknown>

methodregister

register<Definition>(definition: Definition, handler: SheetQueryHandler<SheetQueryInput<Definition>, SheetQueryResult<Definition>>): (): void

definition: Definition

handler: SheetQueryHandler<SheetQueryInput<Definition>, SheetQueryResult<Definition>>

methodrun

run<Definition>(definition: Definition, input: SheetQueryInput<Definition>): SheetQueryResult<Definition>

definition: Definition

input: SheetQueryInput<Definition>

Editor-local configuration storage, defaults, and typed configuration access.

classConfigEnginesource ↗

class ConfigEngine<TConfig>

Registry and merger for one editor-owned configuration scope.

constructorconstructor

ConfigEngine<TConfig>(defaults?: TConfig, initialConfig?: EditorDefaultConfigOverrides<TConfig>): ConfigEngine<TConfig>

Creates the engine for one composition-root-owned default configuration object.

defaults: TConfig

initialConfig: EditorDefaultConfigOverrides<TConfig>

propertysymbolstatic

readonly symbol: symbol

DI token for resolving the shared configuration engine.

methodenforceCommandBoundary

enforceCommandBoundary(isCommandExecuting: (): boolean): void

Seals retained configuration handles after editor initialization.

isCommandExecuting: (): boolean

methodgetCombinedConfig

getCombinedConfig<T>(): ConfigUnit<T> & T

Get merged config of all plugins

ReturnsMerged config

methodgetDefaultConfig

getDefaultConfig(): TConfig

Returns this editor's defaults merged with its host/runtime overrides.

methodgetPluginConfig

getPluginConfig<T>(pluginKey: ConfigKey): ConfigUnit<T> & T | undefined

Get config of specified plugin

ReturnsPlugin configuration

pluginKey: ConfigKey

Stable key whose configuration should be returned.

methodregisterPluginConfig

registerPluginConfig<T>(pluginKey: ConfigKey, pluginConfig: T): void

Register plugin config

pluginKey: ConfigKey

Stable key that owns the configuration.

pluginConfig: T

Plugin config

methodupdateDefaultConfigOverrides

updateDefaultConfigOverrides(overrides: EditorDefaultConfigOverrides<TConfig>): void

Merges host/runtime default overrides into future default-config reads.

overrides: EditorDefaultConfigOverrides<TConfig>

classConfigUnitsource ↗

class ConfigUnit<T>

Mutable configuration unit registered by a plugin or assembly module.

constructorconstructor

ConfigUnit<T>(initialConfig?: T): ConfigUnit<T>

Creates a config unit by copying the provided initial values.

initialConfig: T

interfaceDocConfigsource ↗

interface DocConfig

Configuration owned by a standalone Doc editor.

propertydevicePixelRatio

readonly devicePixelRatio: number

propertydocFontFamily

readonly docFontFamily: string

propertydocFontSize

readonly docFontSize: number

propertydocLineHeightMultiplier

readonly docLineHeightMultiplier: number

Default paragraph line-height multiplier used by standalone Doc.

propertydocParagraphSpacingAfter

readonly docParagraphSpacingAfter: number

Default paragraph spacing after each non-final block.

propertydocVerticalAlign

readonly docVerticalAlign: "center" | "top"

propertyincrementalRenderPolicyLimits

readonly incrementalRenderPolicyLimits: IncrementalRenderPolicyLimitsConfig

interfaceIncrementalRenderPolicyLimitsConfigsource ↗

interface IncrementalRenderPolicyLimitsConfig

Guardrails for accepting an incremental document render plan.

propertymaxCopiedAreaRatio

readonly maxCopiedAreaRatio: number

propertymaxCopyCount

readonly maxCopyCount: number

propertymaxInvalidAreaRatio

readonly maxInvalidAreaRatio: number

propertymaxInvalidRectCount

readonly maxInvalidRectCount: number

interfaceSheetConfigsource ↗

interface SheetConfig

Configuration owned by a standalone Sheet editor.

propertycellPadding

readonly cellPadding: number

propertydefaultCellAlign

readonly defaultCellAlign: SheetHorizontalAlignment

propertydefaultCellVerticalAlign

readonly defaultCellVerticalAlign: SheetVerticalAlignment

propertydefaultColumnSize

readonly defaultColumnSize: number

propertydefaultRowSize

readonly defaultRowSize: number

propertydevicePixelRatio

readonly devicePixelRatio: number

propertysheetCellFontFamily

readonly sheetCellFontFamily: string

propertysheetCellFontSize

readonly sheetCellFontSize: number

propertysheetOffsetX

readonly sheetOffsetX: number

propertysheetOffsetY

readonly sheetOffsetY: number

typeEditorDefaultConfigOverridessource ↗

type EditorDefaultConfigOverrides = Partial<TConfig> & Record<string, unknown>

Host-provided overrides for one editor-owned configuration object.

variabledefaultDocConfigsource ↗

defaultDocConfig: DocConfig

Built-in defaults for standalone Doc editors.

variabledefaultSheetConfigsource ↗

defaultSheetConfig: SheetConfig

Built-in defaults for ordinary Sheet cells and Sheet viewport services.

The staged Sheet and Doc runtimes that execute pipelines and commit transactions.

enumPipelineStepKindsource ↗

enum PipelineStepKind

Built-in pipeline step kinds understood by SearCoreSheet.

enum memberInteraction

Interaction: "interaction"

Update local sheet interaction state; never synchronized through OT.

enum memberLocalAction

LocalAction: "local-action"

Run a command-owned local action; never synchronized through OT.

enum memberPostCommit

PostCommit: "post-commit"

Publish a command-owned local state change only after staging succeeds.

enum memberPostRender

PostRender: "post-render"

Re-render after the current frame's dirty regions have been flushed.

enum memberPreparedAction

PreparedAction: "prepared-action"

Prepare a local resource and return its rollback for failed staging.

enum memberRender

Render: "render"

Re-render a single plugin (no state change).

enum memberTransaction

Transaction: "transaction"

Stage a Transaction for atomic commit after every pipeline step succeeds.

classConsolePipelineLoggersource ↗

class ConsolePipelineLogger extends PipelineLifecycle

Console logger middleware for Pipeline lifecycle events.

Registers as a PipelineLifecycle hook and emits styled console
output at each stage:

🚀 Pipeline: edit-exit-and-select (3 steps, 1 dirty)
📝 commit-cell-value → set R0C0 = {richtext}
✅ commit-cell-value
📝 exit-edit-mode → clear editor
✅ exit-edit-mode
🏁 Pipeline done — rendered

This is the **only** place that touches console — the execution
engine and caller code are fully decoupled from logging.

constructorconstructor

ConsolePipelineLogger(): ConsolePipelineLogger

methodonComplete

onComplete(_pipeline: Pipeline, rendered: boolean): void

Handles the complete lifecycle event.

_pipeline: Pipeline

rendered: boolean

methodonStart

onStart(pipeline: Pipeline): void

Handles the start lifecycle event.

pipeline: Pipeline

methodonStepComplete

onStepComplete(step: PipelineStep, _pipeline: Pipeline): void

Handles the step complete lifecycle event.

step: PipelineStep

_pipeline: Pipeline

methodonStepStart

onStepStart(step: PipelineStep, _pipeline: Pipeline, detail: string): void

Handles the step start lifecycle event.

step: PipelineStep

_pipeline: Pipeline

detail: string

classDocCompositionManagersource ↗

class DocCompositionManager extends DocCompositionProvider

Owns optional IME composition state independently from cursor and selection state.

constructorconstructor

DocCompositionManager(textShaper: TextShaper): DocCompositionManager

textShaper: TextShaper

propertysymbolstatic

readonly symbol: symbol

DI token for resolving DocCompositionManager.

methodclear

clear(teardownToken?: object): void

Clears all composing state.

teardownToken: object

methodenforceCommandBoundary

enforceCommandBoundary(isCommandExecuting: (): boolean, teardownToken?: object): void

Closes direct composition writes after editor assembly.

isCommandExecuting: (): boolean

teardownToken: object

methodgetCaretOffset

getCaretOffset(): number

Returns the logical caret offset inside the composing text.

methodgetCaretPixelOffset

getCaretPixelOffset(): number

Returns the latest measured caret pixel offset.

methodgetText

getText(): string

Returns the current composing text.

methodmeasure

measure(font?: string): DocCompositionLayout

Measures current composing text and records the caret pixel offset for rendering.

font: string

methodsetText

setText(text: string, caretOffset?: number): void

Updates the active composing text and logical caret offset.

text: string

caretOffset: number

classDocCursorManagersource ↗

class DocCursorManager

Injectable singleton that bridges document input state and render-node drawing.

- The plugin computes pixel cursor coordinates (via DocLayoutEngine) and
calls setCursor() before triggering a rerender.
- Document overlay render nodes read getCursor() and draw the cursor bar if set.
- clearCursor() is called on edit-session end so stale state is never drawn.

constructorconstructor

DocCursorManager(): DocCursorManager

propertysymbolstatic

readonly symbol: symbol

DI token for resolving DocCursorManager.

methodclearCursor

clearCursor(teardownToken?: object): void

Clear cursor and selection state (call on edit-session end).

teardownToken: object

methodenforceCommandBoundary

enforceCommandBoundary(isCommandExecuting: (): boolean, teardownToken: object): void

Seals assembled cursor writes while preserving command-owned rendering.

isCommandExecuting: (): boolean

teardownToken: object

methodgetCursor

getCursor(): CursorRenderInfo | null

Read the cursor render info. Returns null when no edit session is active.

methodgetSelectionRects

getSelectionRects(): SelectionRect[]

Read the selection highlight rectangles.

methodsetCursor

setCursor(info: CursorRenderInfo): void

Set (or update) the cursor render info for the upcoming draw call.

info: CursorRenderInfo

methodsetSelectionRects

setSelectionRects(rects: SelectionRect[]): void

Set selection highlight rectangles for the upcoming draw call.

rects: SelectionRect[]

classDocImmediateRenderPaintersource ↗

class DocImmediateRenderPainter

Shared painter for embedded rich-document content and transient viewport output.

constructorconstructor

DocImmediateRenderPainter(cursorManager: DocCursorManager, scrollManager: ScrollManager, lineRenderer: RichTextLineRenderer, compositionManager?: DocCompositionManager | null): DocImmediateRenderPainter

Creates a painter over the document cursor and scroll services.

cursorManager: DocCursorManager

scrollManager: ScrollManager

lineRenderer: RichTextLineRenderer

compositionManager: DocCompositionManager | null

methoddrawContent

drawContent(context: RenderContext, input: DocImmediateRenderPainterContentInput): void

Draws text lines from a layout snapshot in the caller's current transform.

context: RenderContext

input: DocImmediateRenderPainterContentInput

methoddrawSelectionRectsInViewport

drawSelectionRectsInViewport(context: RenderContext): void

Draws selection rectangles in viewport coordinates under an identity transform.

context: RenderContext

methoddrawSelectionRectsInWorld

drawSelectionRectsInWorld(context: RenderContext): void

Draws selection rectangles using the caller's current world transform.

context: RenderContext

methoddrawTextCursorOverlayInViewport

drawTextCursorOverlayInViewport(context: RenderContext): void

Draws IME composing text and caret in viewport coordinates.

context: RenderContext

classDocInputPluginsource ↗

class DocInputPlugin extends Plugin<SearCoreDoc, NodeProperties, DocInputState>

Plugin that applies rich-document text input and cursor navigation commands.

constructorconstructor

DocInputPlugin(docLayoutEngine: DocLayoutEngine, platform?: Platform): DocInputPlugin

Constructs the document input plugin with editor-session state only.

docLayoutEngine: DocLayoutEngine

platform: Platform

propertydepthinherited

readonly depth: number

Draw and event ordering hint; lower values run earlier.

propertydocumentStateinherited

readonly documentState?: PluginDocumentStateContribution<DocInputState, object> | readonly PluginDocumentStateContribution<DocInputState, object>[]

Document-state export modules owned by this plugin state.

propertyinterestedIninherited

interestedIn: string[]

Declares which Sheet OT action names this plugin is interested in.
The engine will only call apply when a transaction contains
at least one operation matching these action names, unless the transaction
is owned by this plugin.

- ['uc', 'rr', 'rc'] — only called for UpdateCell, ResizeRow, ResizeCol
- ['*'] — called for any transaction (wildcard)
- [] — only called for this plugin's own transactions

propertypluginKeyinherited

pluginKey: PluginKey

Stable plugin key used by PluginManager and SceneGraph ownership maps.

propertytransactionHistoryinherited

readonly transactionHistory?: PluginTransactionHistoryAdapter

Optional history behavior for transactions owned by this plugin.

propertytransactionOT

readonly transactionOT: { definition: TransactionOTDefinition<RichDocOTOperation>; ownerId: "doc.input"; relations: readonly [OTTransformRelation<RichDocOTOperation, RichDocOTOperation>] }

All document data mutations use the shared RichDoc OT operation family.

propertywarnOnDuplicateDepthinherited

readonly warnOnDuplicateDepth: boolean

Whether PluginManager should warn when another ordered plugin shares this depth.

propertypluginKeystatic

readonly pluginKey: PluginKey

Stable plugin key for document input state.

propertysymbolstatic

readonly symbol: symbol

DI token for resolving the document input plugin.

memberkeyinherited

key: unknown

membersession

session: unknown

methodapply

apply(state: DocInputState, transaction: Transaction): DocInputState | null

Applies rich-document OT transactions owned by the document input plugin.

state: DocInputState

transaction: Transaction

methodclearSession

clearSession(): void

Clears the current edit session state.

methodcreateArrowTransaction

createArrowTransaction(direction: DocCursorDirection, shiftKey: boolean): Transaction

Builds a transaction for arrow-key cursor navigation.

direction: DocCursorDirection

shiftKey: boolean

methodcreateDeleteTransaction

createDeleteTransaction(): Transaction

Builds a transaction for Backspace deletion.

methodcreateInputTransaction

createInputTransaction(text: string): Transaction

Builds a transaction for committed text input.

text: string

methodcreateReplaceDocumentTransaction

createReplaceDocumentTransaction(document: RichDocNode[], selection?: DocSelection): Transaction

Builds a RichDoc OT transaction that replaces the active document session.

document: RichDocNode[]

selection: DocSelection

methodcreateSelectAllTransaction

createSelectAllTransaction(): Transaction

Builds a transaction that selects all content in the current document session.

methodcreateSoftEnterTransaction

createSoftEnterTransaction(): Transaction

Builds a transaction for soft-enter paragraph splitting.

methodcreateTransaction

createTransaction(command: DocCommand, docTransaction?: DocTransaction): Transaction

Builds a workspace transaction from a rich-document domain command.

command: DocCommand

docTransaction: DocTransaction

methoddirtyRectinherited

dirtyRect(searCore: SearCoreDoc, transaction: Transaction): PositionRect<unknown> | null | undefined

Optional. Return the pixel-space dirty rectangle that needs to be
redrawn after this plugin processes transaction.

When implemented, SearCoreSheet.dispatch will call markDirty with
the returned rect and skip a full-canvas re-render for this plugin.
When omitted (or when null/undefined is returned), dispatch falls
back to a full render pass.

searCore: SearCoreDoc

transaction: Transaction

methodenforceRuntimeWriteBoundaryinherited

enforceRuntimeWriteBoundary(assertWrite: (): void): void

Installs the editor's command check for plugin-owned runtime sessions.

assertWrite: (): void

methodenforceSessionWriteBoundary

enforceSessionWriteBoundary(isCommandExecuting: (): boolean, commitToken: object, runWithoutMutationAuthority?: <Value>(callback: (): Value): Value): void

Binds the owning editor's command and commit boundary after initial state registration.

isCommandExecuting: (): boolean

commitToken: object

runWithoutMutationAuthority: <Value>(callback: (): Value): Value

methodenforceStateWriteBoundaryinherited

enforceStateWriteBoundary(commitToken: object): void

Restricts state replacement to the owning editor's commit phase.

commitToken: object

methodgetLastSnapshot

getLastSnapshot(): LayoutSnapshot | null

Returns the derived layout snapshot used for vertical cursor movement.

methodgetPluginConfig

getPluginConfig(_searCore: SearCoreDoc): null

Document input has no plugin configuration.

_searCore: SearCoreDoc

methodgetStateinherited

getState(): DocInputState

Returns the plugin-owned state currently registered with the manager.

methodhandleArrow

handleArrow(direction: DocCursorDirection, shiftKey: boolean): DocInputDispatchResult

Handles arrow-key cursor navigation.

direction: DocCursorDirection

shiftKey: boolean

methodhandleDelete

handleDelete(): DocInputDispatchResult

Handles Backspace deletion.

methodhandleInput

handleInput(text: string): DocInputDispatchResult

Handles committed text input.

text: string

methodhandleSelectAll

handleSelectAll(): DocInputDispatchResult

Selects all content in the current document session.

methodhandleSoftEnter

handleSoftEnter(): DocInputDispatchResult

Handles soft-enter paragraph splitting.

methodhasStateWriteBoundaryinherited

hasStateWriteBoundary(): boolean

Reports whether the owning runtime has taken control of state replacement.

methodlockCommittedStateinherited

lockCommittedState(state: DocInputState): void

Optionally locks a committed plugin-owned local state value against retained handles.

state: DocInputState

methodonClickinherited

onClick(earCore: SearCoreDoc, event: EventWithOffsetAndTarget<NodeProperties>): boolean | void

Plugin pointer event handlers.

Return value contract:
- Return false to stop subsequent plugins from handling the same event.
- Return true / undefined / void to continue dispatching.

This mechanism allows a plugin to explicitly suppress downstream handlers
after it has consumed an event, replacing the old coupled approach where
one plugin directly modified another plugin's state.

earCore: SearCoreDoc

event: EventWithOffsetAndTarget<NodeProperties>

methodonDblClickinherited

onDblClick(earCore: SearCoreDoc, event: EventWithOffsetAndTarget<NodeProperties>): boolean | void

Handles a double-click pointer event.

earCore: SearCoreDoc

event: EventWithOffsetAndTarget<NodeProperties>

methodonInitialDataCellinherited

onInitialDataCell(searCore: SearCoreDoc, cell: unknown, row: number, col: number): void

Receives one non-empty cell during SearCoreSheet's shared startup scan.
The scan runs once after every plugin state has been registered, so
plugins can build derived indexes without independently traversing the
whole sheet.

searCore: SearCoreDoc

cell: unknown

row: number

col: number

methodonInitialDataCompleteinherited

onInitialDataComplete(searCore: SearCoreDoc): void

Called after the final cell of the shared startup scan is delivered.

searCore: SearCoreDoc

methodonMouseDowninherited

onMouseDown(searCore: SearCoreDoc, event: EventWithOffsetAndTarget<NodeProperties>): boolean | void

Handles the start of a pointer press sequence.

searCore: SearCoreDoc

event: EventWithOffsetAndTarget<NodeProperties>

methodonMouseMoveinherited

onMouseMove(searCore: SearCoreDoc, event: EventWithOffsetAndTarget<NodeProperties>): boolean | void

Handles pointer movement over the host surface.

searCore: SearCoreDoc

event: EventWithOffsetAndTarget<NodeProperties>

methodonMouseUpinherited

onMouseUp(searCore: SearCoreDoc, event: EventWithOffsetAndTarget<NodeProperties>): boolean | void

Handles the end of a pointer press sequence.

searCore: SearCoreDoc

event: EventWithOffsetAndTarget<NodeProperties>

methodonResizeinherited

onResize(): void

Optional hook invoked when the host viewport or sheet dimensions change.

methodonScrollinherited

onScroll(scrollManagerState: ScrollManagerState): void

Receives scroll state changes from the active scroll manager.

scrollManagerState: ScrollManagerState

methodonTransactionCommitted

onTransactionCommitted(transaction: Transaction): void

Publishes committed document and selection projections after Core commits this plugin's transaction.

transaction: Transaction

methodprojectTransactioninherited

projectTransaction(state: DocInputState, transaction: Transaction): readonly Transaction<Operation>[]

Purely plans owner-targeted prerequisites before another owner's explicit transaction.
Sheet runtimes stage these once, atomically with the original transaction, and retain
them in the command pipeline for history and collaboration. Never mutate input state.

state: DocInputState

transaction: Transaction

methodregisterConfiginherited

registerConfig(): PluginConfigRegistration<Record<string, unknown>>[]

Registers default configuration values owned by this plugin.

methodregisterState

registerState(): { key: PluginKey; state: DocInputState }

Registers document input state under the plugin key.

methodrender

render(_searCore: SearCoreDoc): Node<NodeProperties>[] | null

Document input does not render scene nodes directly.

_searCore: SearCoreDoc

methodresetSession

resetSession(doc: RichDocNode[], selection?: DocSelection): void

Replaces the current edit session document and selection.

doc: RichDocNode[]

selection: DocSelection

methodrestoreSelection

restoreSelection(selection: DocSelection): void

Replaces local selection during session restoration without changing document content.

selection: DocSelection

methodsealRuntimeMetadatainherited

sealRuntimeMetadata(): void

Fixes transaction and export metadata after the editor takes ownership.

methodsealRuntimeMethodsinherited

sealRuntimeMethods(): void

Pins transaction and render hooks after plugin startup.

methodsealRuntimeWritesinherited

sealRuntimeWrites(): void

Closes runtime-owned extension writes after every plugin has initialized and started.

methodsealSessionRestoration

sealSessionRestoration(): void

Closes the document initialization and session restoration phase.

methodsetLastSnapshot

setLastSnapshot(snapshot: LayoutSnapshot | null): void

Stores the last layout snapshot for cursor navigation.

snapshot: LayoutSnapshot | null

methodsetStateinherited

setState(state: DocInputState, commitToken?: object): void

Replaces the plugin-owned state after an apply or runtime transition.

state: DocInputState

commitToken: object

methodsubscribeDocument

subscribeDocument(listener: (): void): (): void

Subscribes to committed document projection changes.

listener: (): void

methodsubscribeSelection

subscribeSelection(listener: (): void): (): void

Subscribes to committed selection projection changes.

listener: (): void

classDocRenderEnginesource ↗

class DocRenderEngine extends RenderEngine<NodeProperties, RenderCoordinatorManager>

Document render engine that mirrors Sheet's fixed strategy chain.

Domain-specific layout and SceneGraph projection
happen before this class. The render engine owns only SceneGraph painting,
dirty marks, viewport resizing, and ordered strategy dispatch.

constructorconstructor

DocRenderEngine(scrollManager: ScrollManager, renderContext: RenderContext, configEngine: ConfigEngine, renderCoordinatorManager: RenderCoordinatorManager, stage: SceneGraph<NodeProperties>, renderStrategyManager: RenderStrategyManager<NodeProperties>, screenRenderStrategy: ScreenRenderStrategy<NodeProperties>, dirtyRenderStrategy: DirtyRenderStrategy<NodeProperties>, stickyRenderStrategy: StickyRenderStrategy<NodeProperties>, overlayRenderStrategy: OverlayRenderStrategy<NodeProperties>): DocRenderEngine

Creates a render engine for one document editor instance.

scrollManager: ScrollManager

renderContext: RenderContext

configEngine: ConfigEngine

renderCoordinatorManager: RenderCoordinatorManager

stage: SceneGraph<NodeProperties>

renderStrategyManager: RenderStrategyManager<NodeProperties>

screenRenderStrategy: ScreenRenderStrategy<NodeProperties>

dirtyRenderStrategy: DirtyRenderStrategy<NodeProperties>

stickyRenderStrategy: StickyRenderStrategy<NodeProperties>

overlayRenderStrategy: OverlayRenderStrategy<NodeProperties>

propertyconfigEngineinherited

readonly configEngine: ConfigEngine

propertyrenderContextinherited

readonly renderContext: RenderContext

propertyrenderCoordinatorManagerinherited

readonly renderCoordinatorManager: RenderCoordinatorManager

propertyrenderStrategyManagerinherited

readonly renderStrategyManager: RenderStrategyManager<NodeProperties>

propertyscrollManagerinherited

readonly scrollManager: ScrollManager

propertysymbolstatic

readonly symbol: symbol

DI token for resolving DocRenderEngine.

methodgetLastScreenRenderMode

getLastScreenRenderMode(): ScreenRenderFrameMode | null

Returns the screen strategy mode used by the last render pass, if it painted.

methodinitialize

initialize(): void

Initializes DocRenderEngine.

methodinvalidateScreenCache

invalidateScreenCache(): void

Invalidates the off-screen body cache used by the screen strategy.

methodmarkDirty

markDirty(rect: PositionRect<templateLiteral>): void

Marks one document-world rectangle dirty for the next dirty pass.

rect: PositionRect<templateLiteral>

methodrender

render(node: Node<NodeProperties>): void

Runs the configured document render strategies over the current scene graph.

node: Node<NodeProperties>

methodresize

resize(width: number, height: number, scale: number): void

Resizes all Doc render layers and invalidates screen-cache reuse.

width: number

height: number

scale: number

methodsetBlockRasterCopyPlan

setBlockRasterCopyPlan(plan: BlockRasterCopyPlan | null): void

Supplies one layout-shift raster-copy plan for the next screen render pass.

plan: BlockRasterCopyPlan | null

methodsetViewport

setViewport(viewport: DocRenderViewport): void

Updates the viewport model used by subsequent render frames.

viewport: DocRenderViewport

methodsetViewScale

setViewScale(scale: number): void

Updates the view scale on every render strategy context.

scale: number

classNoopDocCompositionProvidersource ↗

class NoopDocCompositionProvider extends DocCompositionProvider

Null provider used when no composition plugin is installed.

constructorconstructor

NoopDocCompositionProvider(): NoopDocCompositionProvider

methodmeasure

measure(_font: string): DocCompositionLayout

Measures no composing text.

_font: string

classPipelinesource ↗

class Pipeline

An observable, ordered conduit for state changes and renders.

The Pipeline is **not** a batch-optimisation — it is a monitoring and
debugging tool. Every operation (transaction dispatch, render-only
refresh, editor input, cell selection…) should be pushed through a
Pipeline so that the full lifecycle is logged and traceable.

Lifecycle hooks (PipelineLifecycle) can be registered via use().
The execution engine calls these hooks at each stage, keeping the
Pipeline itself decoupled from any specific logging or metrics logic.

Usage:
``ts
// A single-transaction dispatch (selection, collab, etc.)
const p = Pipeline.fromTransaction('select-cell', tx);
searCore.executePipeline(p);

// A multi-step operation (edit-exit-and-select)
const p = new Pipeline(featurePipelineName);
p.add(featureCommitStepName, cellValueTx);
p.add(featureCleanupStepName, cleanupTx);
p.addRender(featureRefreshStepName, selectionPluginKey);
p.markDirty(editorRect);
searCore.executePipeline(p);
``

constructorconstructor

Pipeline(name: string): Pipeline

Creates a named pipeline for diagnostics and command results.

name: string

propertydirtyRects

readonly dirtyRects: PositionRect<templateLiteral>[]

Dirty rectangles accumulated before the render phase.

propertyname

readonly name: string

propertysteps

readonly steps: PipelineStep[]

Ordered steps that will be executed by the pipeline executor.

methodadd

add(stepName: string, transaction: Transaction): this

Append a transaction step (shorthand).

stepName: string

transaction: Transaction

methodaddCustom

addCustom(stepName: string, kind: string, data?: unknown): this

Add a step handled by an executor registered by the host or an extension.

stepName: string

kind: string

data: unknown

methodaddInteraction

addInteraction(stepName: string, interaction: SheetInteractionSignal): this

Append a local interaction-state transition.

stepName: string

interaction: SheetInteractionSignal

methodaddLocalAction

addLocalAction(stepName: string, localAction: (): void): this

Append a command-owned local action step.

stepName: string

localAction: (): void

methodaddPostCommit

addPostCommit(stepName: string, postCommit: (): void): this

Append a local state publication deferred until all steps have staged successfully.

stepName: string

postCommit: (): void

methodaddPostRender

addPostRender(stepName: string, pluginKey: PluginKey): this

Schedule a visual refresh after this pipeline's normal frame has
completed. Use this when a second scene update must not consume dirty
regions produced by transaction-driven plugins in the same frame.

stepName: string

pluginKey: PluginKey

methodaddPreparedAction

addPreparedAction(stepName: string, prepare: (): (): void): this

Prepare an editor-local resource that is released if later staging fails.

stepName: string

prepare: (): (): void

methodaddRender

addRender(stepName: string, pluginKey: PluginKey): this

Append a render-only step for the given plugin.

stepName: string

pluginKey: PluginKey

methodaddTransaction

addTransaction(stepName: string, transaction: Transaction): this

Append a transaction step.

stepName: string

transaction: Transaction

methodemitComplete

emitComplete(rendered: boolean): void

Notify all hooks that the pipeline has completed.

rendered: boolean

methodemitStart

emitStart(): void

Notify all hooks that the pipeline is starting.

methodemitStepComplete

emitStepComplete(step: PipelineStep): void

Notify all hooks that a step has completed.

step: PipelineStep

methodemitStepStart

emitStepStart(step: PipelineStep): void

Notify all hooks that a step is starting. Provides auto-derived detail.

step: PipelineStep

methodmarkDirty

markDirty(rect: PositionRect<templateLiteral>): this

Defers a dirty rectangle until the pipeline executor reaches render.

rect: PositionRect<templateLiteral>

methoduse

use(hook: PipelineLifecycle): this

Register a lifecycle hook (middleware). Hooks fire in registration order.

hook: PipelineLifecycle

methodfromRenderstatic

fromRender(name: string, pluginKey: PluginKey): Pipeline

Creates a pipeline containing one render step for a plugin key.

name: string

pluginKey: PluginKey

methodfromTransactionstatic

fromTransaction(name: string, transaction: Transaction): Pipeline

Creates a pipeline containing one transaction step.

name: string

transaction: Transaction

classPipelineStepExecutorRegistrysource ↗

class PipelineStepExecutorRegistry

Per-container registry of Pipeline step executors.

The sheet core owns frame flushing; executors only perform their local work
through PipelineStepExecutionContext. This keeps custom steps extensible
without allowing them to bypass dirty-region or render-frame boundaries.

constructorconstructor

PipelineStepExecutorRegistry(): PipelineStepExecutorRegistry

propertysymbolstatic

readonly symbol: typeof symbol

DI token for resolving PipelineStepExecutorRegistry.

methodget

get(kind: string): PipelineStepExecutor | undefined

Returns the value.

kind: string

methodregister

register(executor: PipelineStepExecutor): (): void

Registers the value.

executor: PipelineStepExecutor

classSearContractViolationErrorsource ↗

class SearContractViolationError extends SearError

Error thrown when an internal assembly contract is violated.

constructorconstructor

SearContractViolationError(message: string, details?: SearErrorDetails): SearContractViolationError

Creates a SearContractViolationError instance.

message: string

details: SearErrorDetails

propertycauseinherited

cause?: unknown

propertycode

readonly code: "SEAR_CONTRACT_VIOLATION"

Stable machine-readable error code.

propertydetailsinherited

readonly details: SearErrorDetails

propertymessageinherited

message: string

propertynameinherited

name: string

propertystackinherited

stack?: string

propertystackTraceLimitstaticinherited

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

methodreportinherited

report(): this

Reports this error with a compact, styled console header and diagnostics.
Returning the error keeps throw new SearError(...).report() ergonomic.

methodcaptureStackTracestaticinherited

captureStackTrace(targetObject: object, constructorOpt?: Function): void captureStackTrace(targetObject: object, constructorOpt?: Function): void

Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.

``js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to new Error().stack
`

The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.

The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:

`js
function a() {
b();
}

function b() {
c();
}

function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;

// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}

a();
``

targetObject: object

constructorOpt: Function

methodprepareStackTracestaticinherited

prepareStackTrace(err: Error, stackTraces: CallSite[]): any prepareStackTrace(err: Error, stackTraces: CallSite[]): any

err: Error

stackTraces: CallSite[]

classSearCoresource ↗

class SearCore<ChildType, NodeTypeProperties, RenderCoordinatorManagerType>

Platform-neutral core contract shared by sheet and document hosts.

constructorconstructor

SearCore<ChildType, NodeTypeProperties, RenderCoordinatorManagerType>(): SearCore<ChildType, NodeTypeProperties, RenderCoordinatorManagerType>

propertysymbolstatic

readonly symbol: symbol

DI token for resolving the active core implementation.

methodgetPlugin

getPlugin(pluginKey: PluginKey): unknown

Retrieves a plugin instance by plugin key.

pluginKey: PluginKey

methodregisterPlugin

registerPlugin<T>(plugin: Plugin<SearCore<ChildType, NodeTypeProperties, RenderCoordinatorManagerType>, NodeTypeProperties, T>): void

Registers a plugin with the core's plugin manager.

plugin: Plugin<SearCore<ChildType, NodeTypeProperties, RenderCoordinatorManagerType>, NodeTypeProperties, T>

classSearCoreDocsource ↗

class SearCoreDoc extends SearCore<SearCoreDoc, NodeProperties, unknown>

Stages and commits rich-document transactions for one editor runtime.

constructorconstructor

SearCoreDoc(blockManager: BlockManager, docCursorManager: DocCursorManager, docCompositionManager: DocCompositionManager, docLayoutEngine: DocLayoutEngine, pluginManager: PluginManager<SearCoreDoc, NodeProperties>, stepExecutorRegistry?: PipelineStepExecutorRegistry, runtimeLayers?: SearCoreDocRuntimeLayers): SearCoreDoc

Creates a SearCoreDoc instance.

blockManager: BlockManager

docCursorManager: DocCursorManager

docCompositionManager: DocCompositionManager

docLayoutEngine: DocLayoutEngine

pluginManager: PluginManager<SearCoreDoc, NodeProperties>

stepExecutorRegistry: PipelineStepExecutorRegistry

runtimeLayers: SearCoreDocRuntimeLayers

propertyblockManager

blockManager: BlockManager

propertyconfigEngine

configEngine: ConfigEngine<any> | null

Configuration layer used by standalone document hosts when configured by assembly.

propertyeventEngine

eventEngine: EventEngine<NodeProperties> | null

Event pipeline and hit-testing facade used by standalone document hosts.

propertypluginManager

readonly pluginManager: PluginManager<SearCoreDoc, NodeProperties>

Plugin manager for document runtime service plugins.

propertyrenderEngine

renderEngine: DocRenderEngine | null

Render engine used by standalone document hosts when configured by assembly.

propertyrenderStage

renderStage: SceneGraph<NodeProperties> | null

Scene graph used by standalone document rendering when configured by assembly.

propertypluginManagerSymbolstatic

readonly pluginManagerSymbol: symbol

DI token for resolving the Doc-owned PluginManager without colliding with Sheet managers.

propertyruntimeLayersSymbolstatic

readonly runtimeLayersSymbol: symbol

DI token for resolving the Doc runtime layers owned by this Core instance.

propertysymbolstatic

readonly symbol: symbol

DI token for resolving SearCoreDoc.

methodbindDocRenderRequestHandler

bindDocRenderRequestHandler(handler: DocRenderRequestHandler): void

Binds the document render scheduler used by hosts that execute document commands.

handler: DocRenderRequestHandler

methodclearDocRenderRequests

clearDocRenderRequests(): void

Clears diagnostic document render request history.

methoddestroy

destroy(ownerToken?: object): void

Releases standalone document runtime ownership held by Core.

ownerToken: object

methodenforceCommandBoundary

enforceCommandBoundary(isCommandExecuting: (): boolean, runWithoutMutationAuthority?: <Value>(callback: (): Value): Value): void

Permanently require command dispatch for state-changing pipelines in an assembled editor.

isCommandExecuting: (): boolean

runWithoutMutationAuthority: <Value>(callback: (): Value): Value

methodenforceTeardownBoundary

enforceTeardownBoundary(ownerToken: object): void

Reserves assembled Doc Core cleanup for its editor facade.

ownerToken: object

methodexecutePipeline

executePipeline(pipeline: Pipeline): void

Executes document command work through the shared observable Pipeline contract.

pipeline: Pipeline

methodexportSnapshot

exportSnapshot(document?: readonly RichDocNode[]): Schema[]

Exports a runtime document as the shared rich-document schema snapshot.

document: readonly RichDocNode[]

methodgetDocRenderLayoutState

getDocRenderLayoutState(): DocRenderLayoutState | null

Returns the layout state consumed by DocPlugin.render().

methodgetDocRenderRequests

getDocRenderRequests(): readonly DocRenderRequest[]

Returns a diagnostic snapshot of document render requests seen by this core.

methodgetLayoutSnapshot

getLayoutSnapshot(): LayoutSnapshot | null

Returns the latest document layout snapshot prepared by Core.

methodgetPlugin

getPlugin<T>(pluginKey: PluginKey): T | undefined

Returns the plugin.

pluginKey: PluginKey

methodgetPluginInstance

getPluginInstance(pluginKey: PluginKey): Plugin<SearCoreDoc, NodeProperties, any> | undefined

Get a plugin instance by key (for calling plugin-specific methods).

pluginKey: PluginKey

methodinitialize

initialize(): void

Initializes core-owned state, scene nodes, and runtime services.

methodloadSnapshot

loadSnapshot(snapshot: readonly Schema[]): RichDocNode[]

Loads one shared rich-document schema snapshot into this Core runtime.

snapshot: readonly Schema[]

methodmaterializeSnapshot

materializeSnapshot(snapshot: readonly Schema[]): RichDocNode[]

Converts a shared snapshot into detached runtime nodes without changing Core state.

snapshot: readonly Schema[]

methodprepareEditorRenderLayout

prepareEditorRenderLayout(input: DocEditorRenderLayoutInput): DocPreparedEditorRenderLayout

Prepares the current editable document frame through the Doc-owned layout
path used by standalone document hosts and embedded editors.

input: DocEditorRenderLayoutInput

methodregisterPlugin

registerPlugin<T>(plugin: Plugin<SearCoreDoc, NodeProperties, T>): (): void

Registers the plugin.

plugin: Plugin<SearCoreDoc, NodeProperties, T>

methodrequestDocRender

requestDocRender(pluginKey?: PluginKey): void

Requests a document render for plugin-owned render nodes.

pluginKey: PluginKey

methodresolveCursorFromPoint

resolveCursorFromPoint(x: number, y: number, snapshot: LayoutSnapshot): DocCursorPos

Resolves a point inside the editable document frame to the closest
document cursor position.

x: number

y: number

snapshot: LayoutSnapshot

methodsetDocRenderLayoutState

setDocRenderLayoutState(state: DocRenderLayoutState | null): void

Sets the layout state consumed by DocPlugin.render().

state: DocRenderLayoutState | null

methodstart

start(): void

Starts standalone document runtime layers after initial plugin-node construction.

methodunregisterPlugin

unregisterPlugin(pluginKey: PluginKey): void

Unregisters a plugin and removes core-owned runtime output for it.

pluginKey: PluginKey

classSearCoreSheetsource ↗

class SearCoreSheet extends SearCore<SearCoreSheet, CellProperties, SheetRenderCoordinatorManager>

Sheet-specific core runtime that coordinates plugins, data, render, events and pipeline execution.

constructorconstructor

SearCoreSheet(stage: SceneGraph<CellProperties>, pluginManager: PluginManager<SearCoreSheet, CellProperties>, dataEngine: SheetDataEngine, renderEngine: RenderEngine<CellProperties, SheetRenderCoordinatorManager>, eventEngine: EventEngine<CellProperties>, configEngine: ConfigEngine, lifecycleCoordinator: SheetLifecycleCoordinator, interactionStore: SheetInteractionStore, stepExecutorRegistry: PipelineStepExecutorRegistry, platform?: Platform): SearCoreSheet

Creates a sheet core from the DI-provided runtime services.

stage: SceneGraph<CellProperties>

pluginManager: PluginManager<SearCoreSheet, CellProperties>

dataEngine: SheetDataEngine

renderEngine: RenderEngine<CellProperties, SheetRenderCoordinatorManager>

eventEngine: EventEngine<CellProperties>

configEngine: ConfigEngine

lifecycleCoordinator: SheetLifecycleCoordinator

interactionStore: SheetInteractionStore

stepExecutorRegistry: PipelineStepExecutorRegistry

platform: Platform

propertyconfigEngine

configEngine: ConfigEngine

Configuration registry used by sheet plugins.

propertydataEngine

dataEngine: DataEngine

Data registry for plugin-owned sheet state.

propertyeventEngine

eventEngine: EventEngine<CellProperties>

Event pipeline and hit-testing facade for sheet interactions.

propertypluginManager

readonly pluginManager: PluginManager<SearCoreSheet, CellProperties>

Ordered plugin registry for this sheet runtime.

propertyrenderEngine

renderEngine: RenderEngine<CellProperties, SheetRenderCoordinatorManager>

Render pipeline facade for visible sheet scene updates.

propertysymbolstaticinherited

readonly symbol: symbol

DI token for resolving the active core implementation.

methoddestroy

destroy(token?: object): void

Releases runtime controllers and their subscriptions owned by this sheet.

token: object

methodenforceCommandBoundary

enforceCommandBoundary(isCommandExecuting: (): boolean): void

Permanently require command dispatch for state-changing pipelines in an assembled editor.

isCommandExecuting: (): boolean

methodenforceTeardownBoundary

enforceTeardownBoundary(token: object): void

Reserves assembled runtime teardown for the owning editor facade.

token: object

methodexecutePipeline

executePipeline(pipeline: Pipeline): void

Execute a Pipeline — the single monitoring conduit for all state
changes and render triggers.

Lifecycle hooks on the Pipeline emit observability events. Callers that
construct a Pipeline can attach ConsolePipelineLogger explicitly when
console diagnostics are desired.

pipeline: Pipeline

methodgetDataEngine

getDataEngine(): SheetDataEngine

Returns the sheet data engine with sheet-specific helpers.

methodgetPlugin

getPlugin(pluginKey: PluginKey): unknown

Returns state owned by the plugin identified by the given key.

pluginKey: PluginKey

methodgetRenderEngine

getRenderEngine(): RenderEngine<CellProperties, SheetRenderCoordinatorManager>

Returns the render engine bound to this sheet core.

methodgetStage

getStage(): SceneGraph<CellProperties>

Returns the scene graph used by render and event strategies.

methodinitialize

initialize(): void

Builds plugin state and initial scene nodes without starting runtime effects.

methodregisterPlugin

registerPlugin<T>(plugin: Plugin<SearCoreSheet, CellProperties, T>): void

Registers and initializes a plugin after core startup.

plugin: Plugin<SearCoreSheet, CellProperties, T>

methodrequestRender

requestRender<T>(plugin: Plugin<SearCoreSheet, CellProperties, T>): void

Convenience: wrap a render-only refresh in a Pipeline and execute it.

plugin: Plugin<SearCoreSheet, CellProperties, T>

methodstart

start(): void

Starts rendering, events, and lifecycle-owned runtime controllers.

classSearDocParseErrorsource ↗

class SearDocParseError extends SearError

Error thrown when document input cannot be parsed.

constructorconstructor

SearDocParseError(message: string, details?: SearErrorDetails): SearDocParseError

Creates a SearDocParseError instance.

message: string

details: SearErrorDetails

propertycauseinherited

cause?: unknown

propertycode

readonly code: "SEAR_DOC_PARSE"

Stable machine-readable error code.

propertydetailsinherited

readonly details: SearErrorDetails

propertymessageinherited

message: string

propertynameinherited

name: string

propertystackinherited

stack?: string

propertystackTraceLimitstaticinherited

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

methodreportinherited

report(): this

Reports this error with a compact, styled console header and diagnostics.
Returning the error keeps throw new SearError(...).report() ergonomic.

methodcaptureStackTracestaticinherited

captureStackTrace(targetObject: object, constructorOpt?: Function): void captureStackTrace(targetObject: object, constructorOpt?: Function): void

Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.

``js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to new Error().stack
`

The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.

The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:

`js
function a() {
b();
}

function b() {
c();
}

function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;

// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}

a();
``

targetObject: object

constructorOpt: Function

methodprepareStackTracestaticinherited

prepareStackTrace(err: Error, stackTraces: CallSite[]): any prepareStackTrace(err: Error, stackTraces: CallSite[]): any

err: Error

stackTraces: CallSite[]

classSearLifecycleErrorsource ↗

class SearLifecycleError extends SearError

Error thrown for invalid sheet lifecycle transitions.

constructorconstructor

SearLifecycleError(operation: string, state: string, message?: string): SearLifecycleError

Creates a SearLifecycleError instance.

operation: string

state: string

message: string

propertycauseinherited

cause?: unknown

propertycode

readonly code: "SEAR_LIFECYCLE_INVALID_STATE"

Stable machine-readable error code.

propertydetailsinherited

readonly details: SearErrorDetails

propertymessageinherited

message: string

propertynameinherited

name: string

propertystackinherited

stack?: string

propertystackTraceLimitstaticinherited

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

methodreportinherited

report(): this

Reports this error with a compact, styled console header and diagnostics.
Returning the error keeps throw new SearError(...).report() ergonomic.

methodcaptureStackTracestaticinherited

captureStackTrace(targetObject: object, constructorOpt?: Function): void captureStackTrace(targetObject: object, constructorOpt?: Function): void

Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.

``js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to new Error().stack
`

The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.

The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:

`js
function a() {
b();
}

function b() {
c();
}

function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;

// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}

a();
``

targetObject: object

constructorOpt: Function

methodprepareStackTracestaticinherited

prepareStackTrace(err: Error, stackTraces: CallSite[]): any prepareStackTrace(err: Error, stackTraces: CallSite[]): any

err: Error

stackTraces: CallSite[]

classSearPipelineStepExecutorNotFoundErrorsource ↗

class SearPipelineStepExecutorNotFoundError extends SearError

Error thrown when a pipeline step kind has no registered executor.

constructorconstructor

SearPipelineStepExecutorNotFoundError(kind: string): SearPipelineStepExecutorNotFoundError

Creates a SearPipelineStepExecutorNotFoundError instance.

kind: string

propertycauseinherited

cause?: unknown

propertycode

readonly code: "SEAR_PIPELINE_STEP_EXECUTOR_NOT_FOUND"

Stable machine-readable error code.

propertydetailsinherited

readonly details: SearErrorDetails

propertymessageinherited

message: string

propertynameinherited

name: string

propertystackinherited

stack?: string

propertystackTraceLimitstaticinherited

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

methodreportinherited

report(): this

Reports this error with a compact, styled console header and diagnostics.
Returning the error keeps throw new SearError(...).report() ergonomic.

methodcaptureStackTracestaticinherited

captureStackTrace(targetObject: object, constructorOpt?: Function): void captureStackTrace(targetObject: object, constructorOpt?: Function): void

Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.

``js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to new Error().stack
`

The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.

The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:

`js
function a() {
b();
}

function b() {
c();
}

function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;

// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}

a();
``

targetObject: object

constructorOpt: Function

methodprepareStackTracestaticinherited

prepareStackTrace(err: Error, stackTraces: CallSite[]): any prepareStackTrace(err: Error, stackTraces: CallSite[]): any

err: Error

stackTraces: CallSite[]

classSearRegistryConflictErrorsource ↗

class SearRegistryConflictError extends SearError

Error thrown when a registry key is registered more than once.

constructorconstructor

SearRegistryConflictError(registry: string, key: string, message?: string): SearRegistryConflictError

Creates a SearRegistryConflictError instance.

registry: string

key: string

message: string

propertycauseinherited

cause?: unknown

propertycode

readonly code: "SEAR_REGISTRY_CONFLICT"

Stable machine-readable error code.

propertydetailsinherited

readonly details: SearErrorDetails

propertymessageinherited

message: string

propertynameinherited

name: string

propertystackinherited

stack?: string

propertystackTraceLimitstaticinherited

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

methodreportinherited

report(): this

Reports this error with a compact, styled console header and diagnostics.
Returning the error keeps throw new SearError(...).report() ergonomic.

methodcaptureStackTracestaticinherited

captureStackTrace(targetObject: object, constructorOpt?: Function): void captureStackTrace(targetObject: object, constructorOpt?: Function): void

Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.

``js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to new Error().stack
`

The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.

The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:

`js
function a() {
b();
}

function b() {
c();
}

function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;

// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}

a();
``

targetObject: object

constructorOpt: Function

methodprepareStackTracestaticinherited

prepareStackTrace(err: Error, stackTraces: CallSite[]): any prepareStackTrace(err: Error, stackTraces: CallSite[]): any

err: Error

stackTraces: CallSite[]

classSearRegistryEntryNotFoundErrorsource ↗

class SearRegistryEntryNotFoundError extends SearError

Error thrown when a required registry entry is missing.

constructorconstructor

SearRegistryEntryNotFoundError(registry: string, key: string, message?: string): SearRegistryEntryNotFoundError

Creates a SearRegistryEntryNotFoundError instance.

registry: string

key: string

message: string

propertycauseinherited

cause?: unknown

propertycode

readonly code: "SEAR_REGISTRY_ENTRY_NOT_FOUND"

Stable machine-readable error code.

propertydetailsinherited

readonly details: SearErrorDetails

propertymessageinherited

message: string

propertynameinherited

name: string

propertystackinherited

stack?: string

propertystackTraceLimitstaticinherited

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

methodreportinherited

report(): this

Reports this error with a compact, styled console header and diagnostics.
Returning the error keeps throw new SearError(...).report() ergonomic.

methodcaptureStackTracestaticinherited

captureStackTrace(targetObject: object, constructorOpt?: Function): void captureStackTrace(targetObject: object, constructorOpt?: Function): void

Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.

``js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to new Error().stack
`

The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.

The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:

`js
function a() {
b();
}

function b() {
c();
}

function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;

// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}

a();
``

targetObject: object

constructorOpt: Function

methodprepareStackTracestaticinherited

prepareStackTrace(err: Error, stackTraces: CallSite[]): any prepareStackTrace(err: Error, stackTraces: CallSite[]): any

err: Error

stackTraces: CallSite[]

classSheetInteractionReducerRegistrysource ↗

class SheetInteractionReducerRegistry

Extensible dispatch table for local interaction-state transitions.

constructorconstructor

SheetInteractionReducerRegistry(): SheetInteractionReducerRegistry

propertysymbolstatic

readonly symbol: typeof symbol

DI token for resolving SheetInteractionReducerRegistry.

methodget

get(type: string): SheetInteractionReducer | undefined

Returns the value.

type: string

methodregister

register(reducer: SheetInteractionReducer): (): void

Registers the value.

reducer: SheetInteractionReducer

classSheetInteractionStoresource ↗

class SheetInteractionStore

Per-sheet, local-only interaction state. It deliberately does not use OT:
these transitions are view/session concerns and must never be synchronized.

constructorconstructor

SheetInteractionStore(reducers: SheetInteractionReducerRegistry, platform?: Platform): SheetInteractionStore

Creates a SheetInteractionStore instance.

reducers: SheetInteractionReducerRegistry

platform: Platform

propertysymbolstatic

readonly symbol: typeof symbol

DI token for resolving SheetInteractionStore.

methodapply

apply(signal: SheetInteractionSignal): void

Applies a transaction to SheetInteractionStore state.

signal: SheetInteractionSignal

methodcommit

commit(state: SheetInteractionState, signals: readonly SheetInteractionSignal[]): void

Publishes a previously staged interaction state after pipeline commit.

state: SheetInteractionState

Final interaction state to make visible.

signals: readonly SheetInteractionSignal[]

Ordered signals to deliver to subscribers.

methodenforceCommandBoundary

enforceCommandBoundary(isCommandExecuting: (): boolean, runWithoutMutationAuthority?: <Value>(callback: (): Value): Value): void

Requires an editor command for every assembled interaction-state commit.

isCommandExecuting: (): boolean

runWithoutMutationAuthority: <Value>(callback: (): Value): Value

methodgetState

getState(): Readonly<SheetInteractionState>

Returns the state.

methodreduce

reduce(state: Readonly<SheetInteractionState>, signal: SheetInteractionSignal): SheetInteractionState

Reduces a signal without publishing it or changing the stored state.
Pipeline execution uses this to stage interaction transitions until every
other step has succeeded.

ReturnsThe prospective interaction state.

state: Readonly<SheetInteractionState>

Interaction state visible before the signal.

signal: SheetInteractionSignal

Local interaction transition to reduce.

methodsubscribe

subscribe(listener: (state: Readonly<SheetInteractionState>, signal: SheetInteractionSignal): void): (): void

Subscribes to state changes and returns an idempotent disposer.

listener: (state: Readonly<SheetInteractionState>, signal: SheetInteractionSignal): void

classSheetLifecycleCoordinatorsource ↗

class SheetLifecycleCoordinator

Starts and disposes the runtime controllers owned by one sheet instance.

constructorconstructor

SheetLifecycleCoordinator(): SheetLifecycleCoordinator

propertysymbolstatic

readonly symbol: typeof symbol

DI token for resolving SheetLifecycleCoordinator.

methodbeginTeardown

beginTeardown(token: object): void

Permits cleanup only for the owning editor.

token: object

methoddestroy

destroy(): void

Releases resources owned by SheetLifecycleCoordinator.

methodenforceCommandBoundary

enforceCommandBoundary(assertCommandWrite: (): void, teardownToken: object): void

Closes runtime registration after editor assembly.

assertCommandWrite: (): void

teardownToken: object

methodregister

register(controller: SheetLifecycleController): (): void

Adds a controller. Controllers registered after startup begin immediately,
so applications can add lifecycle behavior without changing SearCoreSheet.

controller: SheetLifecycleController

methodstart

start(context: SheetLifecycleContext): void

Starts SheetLifecycleCoordinator.

context: SheetLifecycleContext

classSheetMatrixsource ↗

class SheetMatrix extends CSRMatrix<CellMatrixElement>

SheetMatrix public API.

constructorconstructor

SheetMatrix(data?: { data: CellMatrixElement[]; indices: number[]; indptr: number[] }, shape?: [number, number]): SheetMatrix

Constructs a CSRMatrix instance.

data: { data: CellMatrixElement[]; indices: number[]; indptr: number[] }

The data for the matrix.

shape: [number, number]

The shape of the matrix as [numRows, numCols].

propertynameinherited

name: string

The name of the matrix state.

propertyndiminherited

readonly ndim: number

Number of dimensions in the matrix.
For a standard sparse matrix, this is always 2 (rows and columns).
Kept as a property for potential future extensions (e.g., 3D arrays).

membernnzinherited

nnz: unknown

membershapeinherited

shape: unknown

methodaddColumninherited

addColumn(targetIndex: number, col: CellMatrixElement | null[]): SheetMatrix

Adds a new column to the matrix at the specified index.

ReturnsThe updated matrix instance.

ThrowsIf the length of the column does not match the number of rows in the matrix.

targetIndex: number

The index where the new column should be inserted.

col: CellMatrixElement | null[]

An array representing the column to be added. The length of this array must match the number of rows in the matrix.

methodaddIteminherited

addItem(row: number, col: number, value: CellMatrixElement): SheetMatrix

Adds an item to the matrix at the specified row and column.

ReturnsThe current instance for chaining.

row: number

The row index.

col: number

The column index.

value: CellMatrixElement

The value to add.

methodaddListenerinherited

addListener(listener: Listener): void

Registers a listener for future state changes.

listener: Listener

Callback invoked after notifyListeners().

methodaddRowinherited

addRow(targetIndex: number, row: CellMatrixElement | null[]): SheetMatrix

Adds a row to the matrix at the specified index.

ReturnsThe current instance for chaining.

ThrowsWill throw an error if the length of the row does not match the number of columns.

targetIndex: number

The index at which to add the row.

row: CellMatrixElement | null[]

The row to add.

methodclone

clone(): this

Copies stored cell payloads as well as sparse indexes.

methodcloneCommittedViewinherited

cloneCommittedView(detachExtra?: (value: unknown): unknown): this

Detaches subclass-private slots while sharing already frozen sparse storage.

detachExtra: (value: unknown): unknown

methodcloneDetachedinherited

cloneDetached(cloneValue: (value: CellMatrixElement): CellMatrixElement): this

Copies stored values for a detached snapshot without probing empty cells.

cloneValue: (value: CellMatrixElement): CellMatrixElement

methodcloneForStaginginherited

cloneForStaging(cloneValue?: <Value>(value: Value): Value): this

Copies visible sparse state without invoking subclass constructors or clone hooks.

cloneValue: <Value>(value: Value): Value

methoddeleteColumnsinherited

deleteColumns(targetIndex: number, numDeleteColumns?: number): SheetMatrix

Deletes one or more columns from the matrix starting at the specified index.

ReturnsThe updated matrix instance.

ThrowsIf the range of columns to be deleted exceeds the current number of columns.

targetIndex: number

The index of the first column to be deleted.

numDeleteColumns: number

The number of columns to delete. Defaults to 1.

methoddeleteRowsinherited

deleteRows(targetIndex: number, numDeleteRows?: number): SheetMatrix

Deletes rows from the matrix starting at the specified index.

ReturnsThe current instance for chaining.

ThrowsWill throw an error if the number of rows to delete is out of bounds.

targetIndex: number

The index at which to start deleting rows.

numDeleteRows: number

The number of rows to delete.

methoddispatchinherited

dispatch(operations: MatrixOTOperation<CellMatrixElement>[]): SheetMatrix

Applies a set of matrix operations to the current matrix.

ReturnsThe updated matrix instance.

operations: MatrixOTOperation<CellMatrixElement>[]

An array of operations to be applied to the matrix.

methoddotinherited

dot<U>(other: SparseMatrix<U>): void

Computes the dot product with another sparse matrix.

The dot product (scalar product) of two matrices is a standard linear algebra operation.
For efficiency, implementations should take advantage of the sparse structure.

ReturnsThe resulting matrix from the dot product

ThrowsUnless a subclass provides dot-product semantics.

other: SparseMatrix<U>

The other matrix to compute the dot product with

methodforEachinherited

forEach(callback: (value: CellMatrixElement | null, row: number, col: number): void): void

Iterates over every element in the matrix and applies a callback function.

This method iterates through all rows and columns, calling the callback for each position.
For a sparse matrix, this might iterate many times over empty/null values.
Consider using specialized iterators for better performance on large sparse matrices.

Example

let sum = 0;
matrix.forEach((value, row, col) => {
  if (value !== null) sum += value;
});

callback: (value: CellMatrixElement | null, row: number, col: number): void

The function to execute for each element
- value: The element at [row, col]
- row: The row index
- col: The column index

Time Complexity: O(rows * cols)

methodforEachStoredinherited

forEachStored(callback: (value: CellMatrixElement, row: number, col: number): void): void

Visits the entries encoded in CSR storage without probing empty cells.

This is the appropriate traversal for startup indexes and import-time
processors. Its complexity is O(rows + number of stored entries), instead
of O(rows × columns).

callback: (value: CellMatrixElement, row: number, col: number): void

methodforEachStoredInRangeinherited

forEachStoredInRange(startRow: number, startColumn: number, endRow: number, endColumn: number, callback: (value: CellMatrixElement, row: number, column: number): void): void

Visits stored entries in an inclusive rectangle, skipping empty CSR rows and out-of-range columns.

startRow: number

startColumn: number

endRow: number

endColumn: number

callback: (value: CellMatrixElement, row: number, column: number): void

methodforEachStoredInRowinherited

forEachStoredInRow(row: number, callback: (value: CellMatrixElement, col: number): void): void

Visits the CSR segment for one row in O(stored entries in that row).

row: number

callback: (value: CellMatrixElement, col: number): void

methodfromDenseinherited

fromDense(denseArray: CellMatrixElement | null[][]): SheetMatrix

Converts a dense array to a CSRMatrix.

ReturnsThe current instance for chaining.

denseArray: CellMatrixElement | null[][]

The dense array to convert.

methodgetColinherited

getCol(colIndex: number): void

Retrieves a specific column from the matrix.

Abstract method - must be implemented by subclasses for efficiency.
Similar to getRow but returns a single column instead.

ReturnsThe column as an array

ThrowsUnless a subclass provides column lookup.

colIndex: number

The index of the column to retrieve

methodgetDefaultValueinherited

getDefaultValue(): CellMatrixElement | undefined

Returns the configured fallback used for absent sparse entries, if one exists.

methodgetIteminherited

getItem(row: number, col: number): CellMatrixElement | null

Retrieves an item from the matrix at the specified row and column.

ReturnsThe item at the specified position or null if not present.

row: number

The row index.

col: number

The column index.

methodgetRowinherited

getRow(rowIndex: number): void

Retrieves a specific row from the matrix.

Abstract method - must be implemented by subclasses for efficiency.
A naive implementation would use getItem for each column, but sparse implementations
can optimize this significantly.

ReturnsThe row as an array

ThrowsUnless a subclass provides row lookup.

rowIndex: number

The index of the row to retrieve

methodlockMutationsinherited

lockMutations(): void

Prevents writes to a committed matrix while leaving clones mutable for transaction staging.

methodmultiplyinherited

multiply<U>(other: SparseMatrix<U>): void

Multiplies this matrix with another sparse matrix (matrix multiplication).

Standard matrix multiplication: result[i][j] = sum(this[i][k] * other[k][j])
For efficiency, implementations should take advantage of the sparse structure.

ReturnsThe resulting matrix from the multiplication

ThrowsUnless a subclass provides multiplication semantics.

other: SparseMatrix<U>

The matrix to multiply with

methodremoveIteminherited

removeItem(row: number, col: number): SheetMatrix | undefined

Removes an item from the matrix at the specified row and column.

ReturnsThe current instance for chaining.

row: number

The row index.

col: number

The column index.

methodremoveListenerinherited

removeListener(listener: Listener): void

Removes a previously registered listener.

listener: Listener

Callback to detach from this state object.

methodsetDefaultValueinherited

setDefaultValue(value: CellMatrixElement): void

Sets the default value that will be returned for missing/unset elements.

By default, getItem returns null for missing values. If a default value is set,
missing values will return this default instead of null.

Example

matrix.setDefaultValue(0); // Return 0 for missing cells
const value = matrix.getItem(5, 5); // Returns 0 if not set

value: CellMatrixElement

The default value to return for missing elements

methodsuminherited

sum(axis: 0 | 1 | null): void

Sums the elements of the matrix along the specified axis.

ReturnsThe sum result (varies based on axis parameter)

ThrowsUnless a subclass provides summation semantics.

axis: 0 | 1 | null

The axis to sum along:
- null: Sum all elements (single value)
- 0: Sum along rows (column sums, returns row vector)
- 1: Sum along columns (row sums, returns column vector)

methodswapColumninherited

swapColumn(targetIndex: number, sourceIndex: number): SheetMatrix

Swaps two columns in the matrix at the specified indices.

ReturnsThe updated matrix instance.

targetIndex: number

The index of the first column to be swapped.

sourceIndex: number

The index of the second column to be swapped.

methodswapRowinherited

swapRow(targetIndex: number, sourceIndex: number): SheetMatrix

Swaps two rows in the matrix.

ReturnsThe current instance for chaining.

targetIndex: number

The index of the target row.

sourceIndex: number

The index of the source row.

methodtoArrayinherited

toArray(): CellMatrixElement[][]

Converts the matrix to a 2D array representation.

ReturnsA 2D array representing the matrix, with each element initialized to null if not set.

methodtransposeinherited

transpose(): void

Transposes the matrix (swaps rows and columns).

The transpose operation creates a new matrix where rows become columns and vice versa.
Sparse structure should be preserved in the result.

ReturnsThe transposed matrix

ThrowsUnless a subclass provides transpose semantics.

classSheetViewportResizeControllersource ↗

class SheetViewportResizeController extends SheetLifecycleController

Keeps rendering, scrolling, and viewport-culled plugin nodes in sync with viewport size.

constructorconstructor

SheetViewportResizeController(subscriptionManager: SubscriptionManager): SheetViewportResizeController

Creates a SheetViewportResizeController instance.

subscriptionManager: SubscriptionManager

propertysymbolstatic

readonly symbol: typeof symbol

DI token for resolving SheetViewportResizeController.

methodapplyViewportResize

applyViewportResize(width: number, height: number): void

Applies a resize inside the command dispatched by the owning editor.

width: number

height: number

methoddestroy

destroy(): void

Releases resources owned by SheetViewportResizeController.

methodsetResizeExecutor

setResizeExecutor(executor: (size: { height: number; width: number }): void): void

Routes platform resize notifications through the owning editor's command bus.

executor: (size: { height: number; width: number }): void

methodstart

start(context: SheetLifecycleContext): void

Starts SheetViewportResizeController.

context: SheetLifecycleContext

interfaceCellMatrixElementsource ↗

interface CellMatrixElement

Persisted cell payload stored in the sheet matrix.

propertyformula

formula?: string

Formula source text for formula cells; calculated results live in formula plugin state.

propertyformulaEvaluationMode

formulaEvaluationMode?: "dynamic" | "legacy"

Array evaluation mode used when the formula was entered.

propertytype

type: string

Cell type identifier owned by the cell type catalog.

propertyvalue

value?: unknown

Raw value whose shape is owned by the cell type.

interfaceCursorRenderInfosource ↗

interface CursorRenderInfo

Pre-computed pixel cursor state set by document layout before each render.

propertyheight

height: number

Line height in pixels (used to size the cursor bar).

propertyvisible

visible: boolean

Whether the cursor bar is currently visible (blink phase).

propertyx

x: number

Absolute canvas X for the committed text caret.

propertyy

y: number

Absolute canvas Y for the laid-out line that owns the cursor.

interfaceDocCompositionLayoutsource ↗

interface DocCompositionLayout

Layout contribution from an in-flight IME composition.

propertyactive

readonly active: boolean

Whether there is active composing text to render.

propertycaretPixelOffset

readonly caretPixelOffset: number

Pixel offset from the composing-text start to the IME caret.

propertytext

readonly text: string

Current in-flight composing text.

propertytextWidth

readonly textWidth: number

Full composing text width in pixels.

interfaceDocCompositionProvidersource ↗

interface DocCompositionProvider

Provider used by layout code to account for optional IME composition.

methodmeasure

measure(font: string): DocCompositionLayout

Measures the active composing text against the current render font.

font: string

interfaceDocEditorRenderLayoutInputsource ↗

interface DocEditorRenderLayoutInput

Input used by SearCoreDoc to initialize one editable document frame.

propertycompositionProvider

readonly compositionProvider?: DocCompositionProvider

Optional IME composition provider installed by a feature plugin or embedded host.

propertycursorVisible

readonly cursorVisible?: boolean

Whether the transient text cursor should be visible in this frame.

propertydocument

readonly document: RichDocNode[]

Rich-document content to lay out and render.

propertyfitContentWidth

readonly fitContentWidth?: boolean

Whether the editable frame may grow horizontally to fit unwrapped content.

propertyfont

readonly font?: string

Font descriptor used by the text shaper for this layout.

propertyminContentWidth

readonly minContentWidth?: number

Optional minimum width needed to preserve pre-edit overflow sizing.

propertyminHeight

readonly minHeight: number

Minimum editor height supplied by the host surface.

propertyminWidth

readonly minWidth: number

Minimum editor width supplied by the host surface.

propertyorigin

readonly origin: Pick<PositionRectProps, "x" | "y">

Editor origin in world coordinates.

propertypadding

readonly padding?: number

Padding inside the editable frame.

propertyselection

readonly selection: DocSelection

Current document selection.

propertyverticalAlign

readonly verticalAlign?: DocVerticalAlign

Vertical positioning inside the editable frame. Defaults to center for embedded cell editors.

interfaceDocImmediateRenderPainterContentInputsource ↗

interface DocImmediateRenderPainterContentInput

Input for immediate rendering of laid-out document content lines.

propertyblockIndexes

readonly blockIndexes?: readonly number[]

Optional block indexes to draw; omitted means all blocks.

propertyclipRect

readonly clipRect?: PositionRect<templateLiteral>

Optional world-coordinate clipping rectangle.

propertyfont

readonly font?: string

Base font selected by the host for this document frame.

propertyorigin

readonly origin: Pick<PositionRectProps, "x" | "y">

Content origin in world coordinates.

propertysnapshot

readonly snapshot: LayoutSnapshot

Layout snapshot whose lines are relative to the content origin.

interfaceDocInputDispatchResultsource ↗

interface DocInputDispatchResult

Result of applying one domain input command to the active document input session.

propertycontentChanged

readonly contentChanged: boolean

Whether the command produced document OT operations.

propertyselection

readonly selection: DocSelection

Selection after all command steps have been applied and mapped.

propertyselectionOnly

readonly selectionOnly: boolean

Whether the command only changed selection/caret state.

interfaceDocInputStatesource ↗

interface DocInputState

State for an active rich-document input session.

propertydocSelection

docSelection: DocSelection

Current rich-document selection.

propertypendingDoc

pendingDoc: RichDocNode[]

Pending document content owned by the current edit session.

propertypreferredX

preferredX: number | null

Preferred x-position for repeated vertical cursor movement.

interfaceDocPreparedEditorRenderLayoutsource ↗

interface DocPreparedEditorRenderLayout

Doc-owned layout result consumed by host render surfaces.

propertycomposingCaretPixelOffset

readonly composingCaretPixelOffset: number

Pixel offset from composing-text start to the IME caret.

propertycontentWidth

readonly contentWidth: number

Width available to document content after padding.

propertycursorRelative

readonly cursorRelative: { height: number; x: number; y: number }

Cursor point relative to the editor frame.

propertypositionRect

readonly positionRect: PositionRectProps

Final editor frame in world coordinates.

propertysnapshot

readonly snapshot: LayoutSnapshot

Layout snapshot owned by the Doc input/render session.

interfaceDocRenderLayoutStatesource ↗

interface DocRenderLayoutState

Layout and viewport state exposed to document plugins during render().

propertyblockLayoutDiff

readonly blockLayoutDiff: DocBlockLayoutDiff

Block-level diff between the previous and current layout caches.

propertyblockRender

readonly blockRender?: DocBlockRenderDebugSnapshot

Debug and performance stats for the most recent block-render frame.

propertycontentRect

readonly contentRect: PositionRectProps

Editable content rectangle in viewport coordinates.

propertydocumentRect

readonly documentRect: PositionRectProps

Current document layout rectangle in world coordinates.

propertyfont

readonly font: string

Font selected by the host for this document render layout.

propertylayoutCache

readonly layoutCache: DocLayoutCache

Latest full-document layout cache.

propertyscroll

readonly scroll: { x: number; y: number }

Current viewport scroll offset.

propertyviewport

readonly viewport: { height: number; width: number }

Visible viewport dimensions.

propertyvisibleBlocks

readonly visibleBlocks: readonly DocBlockLayout[]

Laid-out blocks selected for the current viewport.

interfaceDocRenderOperationsource ↗

interface DocRenderOperation

Render-facing operation derived from a RichDoc OT operation.

propertyot

readonly ot: RichDocOTOperation

propertytype

readonly type: DocTransactionRenderOperationType

interfaceDocRenderRequestsource ↗

interface DocRenderRequest

One queued render request targeting plugin-owned document render nodes.

propertyrenderOperations

readonly renderOperations?: DocRenderOperations

Render-facing operations derived from committed RichDoc OT, or null when they cannot be converted safely.

propertyrenderPluginKey

readonly renderPluginKey?: PluginKey

Plugin whose render nodes should be refreshed. Omitted means every document plugin may refresh.

interfaceDocRenderViewportsource ↗

interface DocRenderViewport

Snapshot of the current document viewport used by render strategies.

propertycontentRect

readonly contentRect: PositionRectProps

Editable content rectangle inside the viewport.

propertyheight

readonly height: number

Visible viewport height in host-view units.

propertywidth

readonly width: number

Visible viewport width in host-view units.

interfacePipelineLifecyclesource ↗

interface PipelineLifecycle

Observer hooks emitted while a pipeline executes.

methodonComplete

onComplete(pipeline: Pipeline, rendered: boolean): void

Pipeline finished (all steps + render).

pipeline: Pipeline

rendered: boolean

methodonStart

onStart(pipeline: Pipeline): void

Pipeline begins execution.

pipeline: Pipeline

methodonStepComplete

onStepComplete(step: PipelineStep, pipeline: Pipeline): void

A single step has finished executing.

step: PipelineStep

pipeline: Pipeline

methodonStepStart

onStepStart(step: PipelineStep, pipeline: Pipeline, detail: string): void

A single step is about to execute. Receives auto-derived detail.

step: PipelineStep

pipeline: Pipeline

detail: string

interfacePipelineStepsource ↗

interface PipelineStep

One ordered unit of work inside a pipeline.

propertydata

data?: unknown

Extension-owned payload for a custom step executor.

propertyinteraction

interaction?: SheetInteractionSignal

Local interaction transition for interaction steps.

propertykind

kind: string

Built-in or extension-provided executor key.

propertylocalAction

localAction?: (): void

Command-owned action for local-action steps.

propertyname

name: string

Human-readable step name used by diagnostics.

propertypostCommit

postCommit?: (): void

Deferred local state publication after document and interaction commits.

propertyprepare

prepare?: (): (): void

Local preparation that returns its rollback action.

propertyrenderPluginKey

renderPluginKey?: PluginKey

Plugin key to re-render for render steps.

propertytransaction

transaction?: Transaction<Operation>

Transaction payload for transaction steps.

interfacePipelineStepExecutionContextsource ↗

interface PipelineStepExecutionContext

Effects an executor may request without taking ownership of frame flushing.

methodapplyInteraction

applyInteraction(step: PipelineStep): void

step: PipelineStep

methodexecuteTransaction

executeTransaction(step: PipelineStep): void

step: PipelineStep

methodmarkDirty

markDirty(rect: PositionRect<templateLiteral>): void

rect: PositionRect<templateLiteral>

methodprepareLocalAction

prepareLocalAction(step: PipelineStep): void

step: PipelineStep

methodrenderPlugin

renderPlugin(step: PipelineStep): void

step: PipelineStep

methodrunLocalAction

runLocalAction(step: PipelineStep): void

step: PipelineStep

methodschedulePostCommit

schedulePostCommit(step: PipelineStep): void

step: PipelineStep

methodschedulePostRender

schedulePostRender(step: PipelineStep): void

step: PipelineStep

interfacePipelineStepExecutorsource ↗

interface PipelineStepExecutor

Handles one extensible Pipeline step kind.

propertykind

readonly kind: string

methodexecute

execute(context: PipelineStepExecutionContext, step: PipelineStep): void

context: PipelineStepExecutionContext

step: PipelineStep

interfaceSearCoreDocRuntimeLayerssource ↗

interface SearCoreDocRuntimeLayers

Runtime layers owned by one SearCoreDoc instance.

propertyconfigEngine

readonly configEngine?: ConfigEngine<any> | null

Configuration layer used by standalone document hosts.

propertyeventEngine

readonly eventEngine?: EventEngine<NodeProperties> | null

Event pipeline and hit-testing facade used by standalone document hosts.

propertyplatform

readonly platform?: Platform | null

Platform diagnostics adapter used by document core guard clauses.

propertyrenderEngine

readonly renderEngine?: DocRenderEngine | null

Render engine used by standalone document hosts.

propertyrenderStage

readonly renderStage?: SceneGraph<NodeProperties> | null

Scene graph used by standalone document rendering.

interfaceSelectionRectsource ↗

interface SelectionRect

A single selection highlight rectangle in canvas coordinates.

propertyheight

height: number

propertywidth

width: number

propertyx

x: number

propertyy

y: number

interfaceSheetEditSessionsource ↗

interface SheetEditSession

Public contract for SheetEditSession.

propertyeditor

editor: string

propertytarget

target: readonly [number, number]

interfaceSheetInteractionReducersource ↗

interface SheetInteractionReducer

Reduces one local interaction signal into the per-sheet interaction state.

propertytype

readonly type: string

methodreduce

reduce(state: Readonly<SheetInteractionState>, signal: SheetInteractionSignal): SheetInteractionState

state: Readonly<SheetInteractionState>

signal: SheetInteractionSignal

interfaceSheetInteractionSignalsource ↗

interface SheetInteractionSignal

A local interaction event. Event names and payloads are owned by the
feature that publishes and reduces them; Core only routes the event.

propertytype

type: string

interfaceSheetInteractionStatesource ↗

interface SheetInteractionState

Public contract for SheetInteractionState.

propertyeditSession

editSession: SheetEditSession | null

propertyselection

selection: { anchor: readonly [number, number]; focus: readonly [number, number]; source: string } | null

propertyselectionRevision

selectionRevision: number

Increments for every explicit selection transition.

propertysuppressedSelectionRevision

suppressedSelectionRevision: number | null

The selection revision consumed when the current/last edit session began.

interfaceSheetLifecycleContextsource ↗

interface SheetLifecycleContext

Shared context supplied to lifecycle controllers for one sheet instance.

propertycore

readonly core: SearCoreSheet

methodrefreshSheetBoundaries

refreshSheetBoundaries(): void

interfaceSheetLifecycleControllersource ↗

interface SheetLifecycleController

A startable and disposable runtime concern owned by a sheet instance.

methoddestroy

destroy(): void

methodstart

start(context: SheetLifecycleContext): void

context: SheetLifecycleContext

typeDocRenderDirtyBlockIdssource ↗

type DocRenderDirtyBlockIds = ReadonlySet<DocNodeId> | null

Dirty block ids extracted from document render operations, or null when reflow cannot be localized safely.

typeDocRenderOperationssource ↗

type DocRenderOperations = readonly DocRenderOperation[] | null

Render operations derived from document transactions, or null when they cannot be converted safely.

typeDocRenderRequestHandlersource ↗

type DocRenderRequestHandler = (requests: readonly DocRenderRequest[]): void

Function that handles committed document render requests.

variableDocInputTransactionMetasource ↗

DocInputTransactionMeta: { PreferredX: "docInput.preferredX"; RenderOperation: "docInput.renderOperation"; ReplaceSelection: "docInput.replaceSelection"; SelectionOnly: "docInput.selectionOnly"; Steps: "docInput.steps" }

Transaction metadata key containing selection mapping for DocInputPlugin.

variableSearAssemblyErrorCodesource ↗

SearAssemblyErrorCode: { contractViolation: "SEAR_CONTRACT_VIOLATION"; docParse: "SEAR_DOC_PARSE"; lifecycleInvalidState: "SEAR_LIFECYCLE_INVALID_STATE"; pipelineStepExecutorNotFound: "SEAR_PIPELINE_STEP_EXECUTOR_NOT_FOUND"; registryConflict: "SEAR_REGISTRY_CONFLICT"; registryEntryNotFound: "SEAR_REGISTRY_ENTRY_NOT_FOUND" }

Stable machine-readable error codes owned by assembly packages.

functioncollectDocReflowBlockIdssource ↗

collectDocReflowBlockIds(renderOperations: DocRenderOperations, document: readonly RichDocNode[]): DocRenderDirtyBlockIds

Collects blocks whose layout cache must be refreshed for reflow operations.

renderOperations: DocRenderOperations

document: readonly RichDocNode[]

functioncollectDocRenderOperationssource ↗

collectDocRenderOperations(transactions: readonly Transaction<Operation>[]): DocRenderOperations

Collects render operations derived from committed RichDoc OT transactions.

transactions: readonly Transaction<Operation>[]

functioncollectDocRepaintBlockIdssource ↗

collectDocRepaintBlockIds(renderOperations: DocRenderOperations, document: readonly RichDocNode[]): ReadonlySet<DocNodeId>

Collects blocks whose render nodes must be repainted without invalidating layout cache.

renderOperations: DocRenderOperations

document: readonly RichDocNode[]

functiongetActiveCommandIdsource ↗

getActiveCommandId(): string | null

functiongetCommandObserverEpochsource ↗

getCommandObserverEpoch(): number

Identifies the active observer scope so an older command cannot lend it write authority.

functionisInsideCommandExecutionsource ↗

isInsideCommandExecution(): boolean

functionlockCommittedSheetStatesource ↗

lockCommittedSheetState(state: unknown): void

Locks document-owned state after initialization or a successful transaction commit.

state: unknown

functionrunInsideCommandExecutionsource ↗

runInsideCommandExecution<T>(commandId: string, callback: CommandExecutionCallback<T>): T

commandId: string

callback: CommandExecutionCallback<T>

functionrunOutsideCommandExecutionsource ↗

runOutsideCommandExecution<T>(callback: CommandExecutionCallback<T>): T

Runs observers without inheriting the enclosing command's mutation authority.

callback: CommandExecutionCallback<T>

functionwarnIfOutsideCommandExecutionsource ↗

warnIfOutsideCommandExecution(operationName: string, warn?: CommandExecutionWarningReporter): void

operationName: string

warn: CommandExecutionWarningReporter

functionwarnIfSyntheticCommandDefinitionsource ↗

warnIfSyntheticCommandDefinition(busName: string, commandId: string, warn?: CommandExecutionWarningReporter): void

busName: string

commandId: string

warn: CommandExecutionWarningReporter