API reference

SearSuite separates editor assembly, document state, optional plugins, rendering, and host services. Start with sear-assembly-setup to create an editor. The sections below follow those boundaries; the guide explains how they work together.

Assembly

Create editors, configure their capabilities, and connect a host.

Create an editor

sear-assembly-setup

Public Sheet and Doc editor composition, lifecycle, commands, queries, and host-adapter wiring.

sear-assembly-headless

Headless Sheet composition for tests, servers, and runtimes without a visual host.

sear-assembly-workbook

Workbook structure, Sheet mounting, workbook commands, sessions, and shared runtime services.

Commands and runtime

sear-assembly-commands

Run Sheet and Doc commands and build the transactions they commit.

sear-assembly-core

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

sear-assembly-doc

Composable rich-document plugins for nodes, layout, inline styles, commands, and observations.

sear-assembly-plugin

Plugin lifecycle, runtime capabilities, state contributions, and extension registries.

Configuration and testing

sear-assembly-config

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

sear-assembly-test

Reusable test platforms, render contexts, and editor fixtures for package consumers.

sear-sheet-editor-contract

Sheet-facing embedded rich-text editor contracts and test fakes without Doc-runtime dependencies.

Domain

Documents, state, transactions, and the data model.

Workbook and cell data

sear-domain-workbook

Stable workbook and Sheet identities, structure, and document-state contracts.

sear-domain-cell

Cell catalogs that compose commit, display, render, and clipboard behavior.

sear-domain-cell-types

Built-in cell identities and commit strategies for text, numbers, formulas, and rich text.

sear-domain-matrix

Sparse matrix storage, structural row and column operations, dimensions, and serialization.

sear-domain-format

Portable cell-format values and formatting contracts.

sear-domain-state

Typed data ownership, field projection, and state registry contracts.

Documents and editing

sear-domain-doc

Rich-document nodes, selections, schema helpers, inline styles, and layout contracts.

sear-domain-doc-schema

The dependency-free JSON protocol shared by standalone and embedded rich documents.

sear-domain-editor

Editor-local query, observation, capability, and lifecycle contracts shared by facades.

sear-domain-commands

Typed command definitions and the editor-local command bus contract.

Transactions and collaboration

sear-domain-transaction

The correctly spelled public entry point for SearSuite transaction contracts.

sear-domain-ot

Operational-transformation primitives for matrices, rectangles, and rich documents.

sear-domain-collaboration

Host-neutral revision, pending-operation, acknowledgement, catch-up, and rebase algorithms.

Formula evaluation

sear-domain-formula-engine

Host-neutral formula values, evaluation contracts, registries, references, and external-service boundaries.

sear-domain-formula-engine-ts

The TypeScript formula parser, evaluator, dependency graph, and built-in function runtime.

Plugins

Add editing behavior and optional sheet features.

Editing and navigation

sear-plugin-selection

Sheet selection state, navigation, observations, highlights, and commands.

sear-plugin-cell-editor

Sheet cell-edit sessions, text input, selection, and embedded-editor coordination.

sear-plugin-clipboard

Type-neutral Sheet clipboard traversal, serialization, and paste commands.

sear-plugin-history

Commit-driven Sheet and Doc undo and redo stacks.

Cell appearance

sear-plugin-alignment

Sheet horizontal and vertical alignment state, commands, rendering projections, and persistence.

sear-plugin-cell-border

Independent Sheet cell borders, commands, rendering, history and collaboration.

sear-plugin-cell-fill

Sparse Sheet fill state, commands, visual projection, collaboration, and export.

sear-plugin-cell-merge

Merged-range state, structural transforms, commands, rendering, and persistence.

sear-plugin-cell-format

Cell number-format state, commands, display projection, and persistence.

sear-plugin-clear-style

Owner-composed Sheet format clearing without content deletion.

sear-plugin-format-painter

Sheet format painting through state-owner contributions.

Data and calculations

sear-plugin-formula

Sheet formula source, evaluation scheduling, dependency tracking, and result projection.

sear-plugin-formula-engineering

Host-neutral Excel-compatible engineering formulas organized by category.

sear-plugin-data-validation

Sheet data validation rules, commands, queries, and editor-local evaluation.

sear-plugin-filter

Sheet range filtering with independent rules and row visibility.

sear-plugin-sort

Sheet range sorting commands and stable sparse row permutation helpers.

sear-plugin-duplicate

Sparse Sheet duplicate-highlight state and duplicate row commands.

Structure and viewport

sear-plugin-freeze

Persistent Sheet freeze boundaries and typed command surface.

sear-plugin-fixed-row

Sparse fixed-row state, structural transforms, visual projection, collaboration, and export.

sear-plugin-resize

Sheet row and column dimensions, resize interaction, rendering, and persistence.

sear-plugin-zoom

Editor-local zoom state, commands, observations, and render integration.

sear-plugin-header-highlight

Header highlight behavior derived from Sheet selections.

Integration and examples

sear-plugin-collab

Editor bridges that connect committed collaborative transactions to host transports.

sear-plugin-export

Versioned export envelopes, document-state codec registries, and durable persistence boundaries.

sear-plugin-export-node

Node CSV and XLSX adapters for Workbook document states.

sear-plugin-i18n

Editor-local locale registration and built-in English and Chinese formula locales.

sear-plugin-sheet-demo

A complete, optional Sheet state-owner plugin example.

sear-plugin-sheet-doc-adapter

The default Doc-backed rich-text editor adapter for Sheet cells.

sear-plugin-web-sheet-tabbar

Web workbook Sheet tabs and Sheet-structure commands.

Render

Paint the scene, handle input, and coordinate viewport updates.

Frames and scene nodes

sear-render-engine

Frame scheduling, dirty-region coordination, and Sheet render orchestration.

sear-render-node

Retained scene nodes, rich-text render registries, and spatial indexing.

sear-render-registry

Editor-local registries that connect cell types and Sheet state to renderers.

sear-render-strategy

Full, dirty-region, retained, and incremental rendering policies.

sear-render

Public rendering facade that composes contexts, nodes, strategies, and registries.

Drawing and coordinates

sear-render-context

Platform-neutral drawing contracts with Web Canvas, SVG, WebGL, and headless adapters.

sear-render-coord

Conversions between document, viewport, screen, and host-view coordinates.

sear-render-metrics

Platform-neutral text shaping and glyph measurement contracts.

Input and viewport

sear-render-event-engine

Hit testing and render-node event propagation.

sear-render-input

Keyboard, pointer, text-input, and composition routing contracts.

sear-render-cursor

Portable cursor policies with Web and headless host adapters.

sear-render-scroll

Logical scrolling, axis locking, boundary feedback, and host scroller adapters.

Foundation

Shared platform, geometry, storage, and dependency contracts.

Host services

sear-foundation-di

Editor-scoped dependency injection with explicit ownership and borrowed instances.

sear-foundation-storage

Abstract key-value storage contracts and in-memory adapters.

sear-foundation-subscription

Idempotent subscription ownership and reverse-order disposal utilities.

sear-foundation-user-interaction

Portable interaction-state contracts for host input and editor behavior.

Geometry

sear-foundation-rect

Immutable rectangle geometry and intersection utilities.

sear-foundation-range

Range primitives and normalization helpers used by Sheet and Doc domains.

Shared helpers

sear-foundation-common

Small dependency-free values and contracts shared across SearSuite packages.

sear-foundation-error

Structured public errors with stable codes and diagnostic details.

sear-foundation-keymap

Portable keyboard key values, chords, and binding contracts.

sear-foundation-utils

General-purpose algorithms and guards without editor-domain ownership.