@searsuite/sear-plugin-formula

DI token for resolving FormulaSchedulerDataSource.

Creates a registry with the built-in cell-to-formula semantics.

DI token for resolving CellFormulaValueConverterRegistry.

Registers or overrides formula semantics for one cell type.

ReturnsDisposer that restores the previous converter only if this registration is still active.

Converts a persisted sheet cell into the formula value contract.

ReturnsFormula value, including canonical propagated formula errors or #VALUE! for malformed error payloads.

Creates a trace hub bound to one editor instance.

DI token for resolving FormulaCalculationTraceBus.

Emits one calculation trace event to current subscribers.

Listener failures are reported through Platform.warn and do not interrupt formula recalculation, dependency maintenance, rendering invalidation, or other subscribers.

Seals event publication after initial formula data has been scanned.

Subscribes to formula calculation trace events for one editor instance.

ReturnsFunction that removes the listener; calling it more than once is safe.

Creates a FormulaRefShifter instance.

DI token for resolving FormulaRefShifter.

Handles structural changes by traversing all formula ASTs and shifting references.

ReturnsFormula list that needs updates (key -> new AST).

DI token for resolving FormulaRenderInvalidator.

Registers the legacy formula-result callback for one editor instance.

ReturnsDisposer that removes this handler if it is still active.

Reports formula result changes to displayed-value subscribers.

DI token for resolving the registry owned by one SheetEditor instance.

Binds post-assembly registration and disposal to the owning command bus.

Visits derived result coordinates published by registered providers, once per position.

Reads the first defined result supplied by registered providers.

Registers one formula result provider and returns an idempotent disposer.

Removes one provider inside the formula owner's unregister command.

Creates a FormulaResultStore instance.

DI token for resolving FormulaResultStore.

Converts a CellMatrixElement to a FormulaValue.

Used when evaluators read cell data:

• formula cells: read the local calculated result from this store; derived and unsynced.
• richtext/string cells: return text values, converting numeric strings to numbers.
• null/undefined: return 0 for empty cells.

Called by both SheetFormulaPlugin.apply for aggCache delta calculation and RecalcScheduler.createEvalContext, so it lives on the store to avoid duplicated logic or callback plumbing.

Clears state owned by FormulaResultStore.

Removes the calculated result for one formula cell.

Closes direct result writes after the owning Sheet has started.

Visits projected spill coordinates in a range; formula anchors live in the Sheet data matrix.

Returns the value.

Reads an anchor or projected spill value at any sheet coordinate.

Returns whether value exists.

Updates the value.

Stores a formula result and projects a rectangular array into derived spill cells.

DI token for resolving IFormulaSourceProvider.

Gets the formula source that should be presented to the user for one cell.

Providers may return undefined when they do not own the queried cell. The default sheet formula provider returns the persisted formula text, while workbook-aware providers can return display text formatted from stable workbook bindings and the current sheet names.

Creates a RecalcScheduler instance.

DI token for resolving RecalcScheduler.

Binds the formula owner's cache during plugin setup.

Binds asynchronous formula work to the owning editor's command bus.

Gives the owning editor lifecycle exclusive authority to dispose the mounted scheduler.

Discards pending formula batches when committed formula inputs are replaced.

Releases scheduler-owned subscriptions.

Iterates formula coordinates without exposing the cache for mutation.

Triggers recalculation.

Performs only two actions:

1. Mark dirty formulas, propagated by BFS without sorting.
2. Start the async scheduling loop without blocking the current frame.

Recalculates formulas that contain any of the supplied function names.

Runs one budgeted batch inside the formula owner's command.

Starts an explicit recalculation epoch for every formula containing a volatile call.

Resumes pending work inside a viewport or external-service command.

Resolves when the scheduler has no running or pending formula work.

Creates a SheetFormulaPlugin instance.

Operation types listened to by this plugin:

• uc: UpdateCell
• ri: RowInsert
• rd: RowDelete
• ci: ColInsert
• cd: ColDelete

Stable plugin key for SheetFormulaPlugin.

DI token for resolving SheetFormulaPlugin.

Rejects unsupported structure operations before the owning transaction commits. Derived ASTs are not staged as plugin state.

Seals provider registration once every configured Sheet plugin has started.

Exposes derived spill coordinates to sparse range consumers.

IFormulaStatusProvider implementation used by hosts and plugins to inspect formula source, result, dirty state, and dependency edges without touching plugin-owned caches directly.

IFormulaResultProvider implementation used by rendering to read formula results.

Returns FormulaValue from resultStore, or undefined when it has not been calculated yet. The rendering layer (FormulaCell) converts it to display text.

IFormulaSourceProvider implementation used by editors to read persisted formula text.

Returns the plugin config.

Receives cells from shared startup scanning and builds AST/dependency indexes for existing formula cells.

Initial data such as content.json is injected directly into SheetDataPlugin and does not pass through the command pipeline -> apply, so formula-derived indexes must be built here.

Starts one recalculation after dependencies for all initial formulas have been registered.

Rebuilds derived indexes after the owning document transaction commits.

Registers formula host commands.

Registers default configuration values owned by this plugin.

Registers formula calculation trace as an editor-local host observation.

Contributes formula identity updates to the same atomic cell-move plan.

Formula indexes are editor-local and do not enter Sheet document views.

Plans persisted reference rewrites for complete row and column reordering.

Render method; the formula plugin does not render nodes directly.

Formula cells are rendered by FormulaCell through render-registry registration. This plugin owns data updates, not visual presentation.

Creates a SheetFormulaReferenceHighlightPlugin instance.

Draw above regular cells and below Selection's edit overlay.

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

Stable key for the formula-reference highlight contribution.

Stable plugin key for SheetFormulaReferenceHighlightPlugin.

DI token for resolving SheetFormulaReferenceHighlightPlugin.

Applies a transaction to SheetFormulaReferenceHighlightPlugin state.

Binds an optional workbook-owned reference source for this Sheet instance.

The provider contract consumed by SheetHighlightPlugin.

Returns the plugin config.

Registers the state.

Renders SheetFormulaReferenceHighlightPlugin scene output.

Persisted cell type identifier handled by this converter.

Converts one sheet matrix element into a formula-engine value.

ReturnsFormula value used by formula evaluation and dependency recalculation.

Column index (0-based).

Row index (0-based).

Formula status snapshot returned by the formula status provider.

Column index (0-based).

A1 notation for display in product UI.

Row index (0-based).

Queried cell with display label.

Direct formula cells that depend on the queried cell.

Direct precedent references used by the formula in the queried cell.

Underlying formula status snapshot for consumers that need result/error/dirty details.

Transitive dependent formula cells, only populated when requested.

Transitive precedent cells, only populated when requested.

Column index (0-based).

Whether to include transitive dependency/dependent cells beyond direct edges.

Maximum traversal depth used when includeTransitive is true. Defaults to 8.

Row index (0-based).

Product-facing dependency snapshot for the queried cell.

Promise resolved when the formula scheduler becomes idle.

Resolves after all currently scheduled formula work has completed.

Opacity of the referenced-cell overlay under the formula cursor.

Stable, high-contrast colors assigned to formula references.

Opacity of referenced-cell overlays when the cursor is elsewhere.

Higher priority providers are queried first.

Provider queried for formula results.

Builds the latest evaluation context for a recalculation batch.

ReturnsEvalContext for the current committed sheet snapshot.

Selects formula keys that are currently visible and should be evaluated first.

ReturnsFormula keys inside the current visible viewport.

Subscribes to host-service cache changes that require selected functions to be evaluated again.

Subscribes to viewport changes that should wake pending formula recalculation.

ReturnsDisposer for the subscription.