document

An SDK conversion failure that retains every diagnostic.

Append a new, empty block of the given type as the last child of a block.

Append a new block as the last child of an existing block.

Write a native field's current (text, marks) back into the document as real rich text, and sync the store's selection to the field's reported caret. This is the point where a NotionFieldEditEvent from NotionTextField becomes a real document transaction.

Apply a matched Markdown shortcut: convert the block and replace its text with the remainder typed after the trigger, selecting the end of that remainder.

Bind the full command surface to one document store.

Create the pure TypeScript editor engine.

Decode a structured block clipboard fragment, rejecting anything malformed or oversized.

Decode a structured field clipboard fragment, rejecting anything malformed or oversized.

Delete a block by its stable editor identity.

Duplicate a block (and its descendants) as the next sibling, with freshly generated editor ids throughout so the copy is independently editable.

Encode whole blocks for the structured clipboard, used when a selection spans multiple fields.

Encode a single field's selected rich text for the structured clipboard.

Reconstruct rich text from a field's current (text, marks) state. Untouched atoms splice their original item back in unchanged; overlapping range marks are flattened into runs so each emitted item carries one consistent annotation set.

Find the path to a block by its stable editor identity, searching depth-first.

Import SDK response/request-shaped blocks without making network requests.

A fresh, unique editor id for a block created at runtime by a command, distinct from the parser's and adapters' path-derived default ids.

Find a block by its stable editor identity.

Read the block at a known path, without searching.

Read a block's own caption payload, for block types that have one.

Read one cell's rich text from a table_row block.

Read a block's own rich_text payload, for block types that have one.

List editable fields in document order, including nested and table-cell fields.

Return the stable editor identity for a block.

Dispatch a structural boundary event a native field could not resolve on its own.

Nest a block as the last child of its immediately preceding sibling.

Nest a block as the last child of its immediately preceding sibling. A no-op when the block is already first in its container, since there is no preceding sibling to become its parent.

Insert a new, empty block of the given type immediately after another block, and select its start.

Insert a resolved mention at a field position, replacing any selected text there. The command layer's entry point for a host's "@" mention search -- resolving candidates from a query is the host's own responsibility, this only splices the chosen one in.

Insert a new block immediately before or after an existing one, as its sibling.

Insert a new text block immediately after a block and select its start.

Whether a block type is a list item that continues the list on Enter and outdents on Backspace-at-start, rather than merging with the previous block.

Whether a block type has its own editable rich_text field, as opposed to carrying text only through children or table cells.

Build a new, empty block of the given type with a fresh editor id.

Map an existing endpoint to a replacement document, clamping when its field disappeared.

Test a field's current plain text against the Markdown shortcut patterns, longest trigger first (headings before a bare "#", for example) so the most specific match wins.

Concatenate two field states, shifting the second's marks past the first's text. The inverse of splitFieldMarks for a split made at first.text.length.

Swap a block with its previous or next sibling.

Swap a block with its previous or next sibling. A no-op at either end of the sibling list.

Map a flattened UTF-16 position to a field endpoint. Separators occupy one unit.

Map a field endpoint to its flattened UTF-16 position.

Un-nest a block to become the next sibling of its own parent.

Un-nest a block to become the next sibling of its own parent. A no-op for a top-level block, since it has no parent to become a sibling of.

Parse enhanced Markdown into the versioned Notion document model.

Remove one block by its stable editor identity.

Flatten a block's rich text into plain text plus formatting/atom marks for a native field. Each atomic element occupies exactly one NOTION_ATOM_PLACEHOLDER character.

Filter the insertable-block catalog for a "/" insert search query. An empty query returns the full catalog.

Serialize a document into canonical enhanced Markdown.

Set or clear the text color/background over the current selection, across every field it touches.

Set or clear a value-carrying mark (color or link) over [start, end). Existing marks of the same kind are clipped out of the range first; passing undefined simply clears it.

Set or clear a link over the current selection, across every field it touches.

Return a copy of a block with its caption payload replaced, for block types that have one.

Return a copy of a table_row block with one cell's rich text replaced.

Return a copy of a block with its rich_text payload replaced, for block types that have one.

Split (text, marks) at a UTF-16 offset into two independent field states. A range mark straddling the offset is clipped into two pieces; an atom cannot straddle a split point since it occupies exactly one unit, so a split always lands on an atom's own boundary.

Toggle a boolean formatting mark over [start, end). When the range is already fully covered by that mark, it is removed from the range; otherwise it is added, merging with any adjacent or overlapping run of the same kind.

Toggle a boolean formatting mark over the current selection, across every field it touches. A no-op when the selection is collapsed or absent -- formatting a caret with no range applies to the host's own pending-mark state, not the document, and belongs to the UI layer.

Export SDK request payloads and retain explicit conversion diagnostics.

Convert a block to a different type, carrying its rich_text forward.

Convert a block to a different type, carrying its rich_text forward and discarding the old type's payload. Children, id, and metadata are preserved untouched.

Replace or remove one block by its stable editor identity. Returning undefined from updater removes the block; any other document with no matching block is returned unchanged.

Options for creating a document editor store.

Text and inline marks used to edit one document field.

Options for importing blocks from the Notion SDK shape.

Document and diagnostics returned by a Notion block import.

A request from the selection overlay to scroll the host's list while dragging a handle.

A structured clipboard fragment carrying whole blocks, for cross-field selections.

The full command surface, bound to one document store.

A parser or conversion diagnostic.

A versioned, recursive document tree.

The current document, selection, revision, and history availability.

State and transaction operations exposed by the document editor store.

A boundary event reported by a native field.

A structured clipboard fragment carrying one field's rich text selection.

A uniquely identified command sent to one native field.

The native description of one editable field, supplied by the host document.

A revisioned edit reported by a native field.

A focus/blur signal reported by a native field.

An explicit start/end range within one field.

One atomic inline element (mention, citation, custom emoji, or equation).

A non-atomic inline formatting range within a field's flattened text.

One entry in the Insert/Turn-into catalog: a block type a host UI can offer to create.

Data retained for Markdown-only features and editor identity.

An optional structural parser extension evaluated before built-in block rules.

A Markdown shortcut match: convert the block and keep the text typed after the trigger.

A resolved mention candidate ready to insert, typically from a host's "@" search results.

The anchor and focus points of a document selection.

A UTF-16 selection point within a given editable field.

A source location in the original Markdown string. Lines and columns are one-based.

A document change with its corresponding source and revision.

Options for parsing Notion-enhanced Markdown.

Document and diagnostics returned by the Markdown parser.

Options for exporting document blocks to the Notion SDK shape.

SDK blocks and diagnostics returned by a Notion block export.

A recursive document block with a given Notion block type and additive metadata.

A sequence of child-array indices from the document root down to one block.

A cross-field selection reported by the selection overlay. Structurally a NotionSelection.

Input accepted by the document parser and editor store.

A field that can be edited on a given document block.

A listener called with the current editor state and corresponding transaction.

Actions understood by a native editable field.

A structural signal a field cannot resolve locally; the command layer decides the outcome.

A kind of editable text field within a block.

Boolean formatting marks that toggle on/off over a range, as opposed to carrying a value.

A formatting or atomic range over a field's flattened text.

Block names supported by the enhanced Markdown format.

Colors accepted by the enhanced Markdown format.

Rich text accepted by the document model.

A rich-text item with an additive, namespaced metadata field.

The source label associated with a document transaction.

The SDK payload for one block type, excluding the envelope and children.