@stesura/core/types

Position of the offending node — the panel selects it on click.

End of the offending content: the node’s end for a block or atom, the run’s end for a link. Carried because a link run can span several text nodes and only the checker knows where it stops.

Node type at pos when the finding was made. Findings are snapshots, so check pos still holds this type before acting on one later.

Short context for the panel row (link text, heading text, …).

Serialize this cell as th scope="col". DERIVED from the table’s hasHeaderRow by tableHeaderCellsPlugin — never set it directly; the plugin will overwrite it on the next transaction (A11Y-21).

Syntax-highlighting language. Named apart from the proofingLanguage global attribute because runtime behaviour is gated on attr presence.

Editor id stamped on clipboard copies (transformCopied) so paste can strip anchors from another document. Always null in the doc — paste clears it.

Editor id stamped on clipboard copies (transformCopied) so paste can strip anchors from another document. Always null in the doc — paste clears it.

True for every comment after the first in its thread — drives commentsExtended.xml reply linking.

Thread resolved state — becomes w15:done in commentsExtended.xml.

Resolves user ids to names and avatars (comment authors, mentions).

Shows a toast. Must render into an ARIA live region (role="status", or role="alert" for errors): some actions, like a refused nested table or a rejected upload, report their outcome ONLY here. When omitted, the mount warns once and messages go to console.warn.

Render toast.description, or switch on toast.key for your own copy.

Hosts (host[:port]) whose PDFs the file node may PREVIEW with @stesura/pdf-viewer-react. Undefined means no previews at all — every PDF is a card (SEC-70) — because the viewer’s browser fetches the file, so the integrator must name hosts trusted to serve only PDFs.

Non-http(s) schemes, loopback, private/link-local ranges and .local/.internal hosts are always refused, so a hostile document cannot make the viewer’s browser fetch their intranet.

Pagination and the PDF export use the same decision, so a print mount MUST get the same list as the editor.

Marks the PDF export’s print mount. Read via isPrintMount , so screen-only chrome (handles, floating menus, table outlines) can skip rendering instead of being hidden by CSS.

Config-time, not a store: a flag flipping mid-export would paginate one way and capture another.

See ConfigPluginProps["toastText"].

The owning editor; set only on sub-editors (footnote, header…). Store lookups fall through to it.

Previous counter text, captured when it shifts while track-changes is on. Visual cue only. Cleared once the text matches it again, or once no earlier paragraph in the instance has pending track changes.

Canvas color behind the pages. Named apart from blockStyling’s bgColor attr.

Default proofing language (BCP 47): the bottom of paragraph.proofingLanguage ?? style.language ?? doc.language, and the only level that always answers.

Default text direction: the bottom of paragraph.dir ?? section.dir ?? doc.dir, so a host can mount RTL-by-default without stamping every node.

Anchor id of the TOC item the viewport has scrolled to (highlight state). Kept out of toc so scroll tracking never churns the items array.

TOC nodeId → page breaks cutting through it. Written by the pagination engine after each recompute; the TOC nodeview renders row spacers from it.

Block nodeId → DISPLAYED page label (“iv”, “12”), honouring each section’s pageNumbering, so it matches the footers. Written by pagination after each recompute; undefined until then, or when it’s off. Read by the TOC.

sectionId → page count, iterated in DOCUMENT order, so a prefix sum is a section’s page offset and the full sum the document total (totalPages, the stats dialog). Written by pagination after each recompute; undefined until then, or when it’s off.

sectionId → pageNumbering, for sections that set one. Published by pagination next to pageCounts, so headers/footers resolve page numbers without subscribing to the document.

Whether the first pagination pass has produced a layout. null: nobody claims it (unpaginated, or pagination not loaded) and the canvas renders immediately. false: first pass outstanding — the canvas holds, so the unpaginated draft never flashes. true: every section has a layout, or the hold timed out.

The RAW doc.attrs.styleSheet, published by the stylesheet plugin. Sub-editor docs store no style definitions, so they read them here via the registry’s parent fall-through — same as listConfigs .

List configs (defaults + doc.attrs.listConfigs), published by the numbering plugin. Definitions are doc-global while counters are per story, so sub-editors read them here via the registry’s parent fall-through.

The root editor’s current doc, published by the numbering plugin’s view. Lets sub-editors answer cross-region questions, e.g. counting a listRef’s instances before deciding whether a config edit must fork (CORE-31).

Undefined when neither the attr nor the style names one — the level config’s suffix is the next fallback, then “tab”. Resolved by the numbering plugin, which is where the level configs are in hand.

True when the list came from the paragraph’s style rather than its attrs.

Absolute URL of the file.

Preview height in CSS px, UNPAGINATED only (the resize handle writes it). Under pagination the box is the section’s page height and this is ignored.

Original filename, as uploaded. Null on documents that predate it.

Content type sniffed at upload (never the browser’s file.type). Null on documents that predate it, which could only ever hold PDFs.

Byte size at upload, for the card.

Whole-file rotation, degrees clockwise. ADDED to each page’s own rotation (effectiveRotation) by both preview and export.

Whether a PDF renders as a PREVIEW (its pages) or as a card. Default true: mounting the viewer package is the migration trigger, and what you see is what you export — a card prints as a card with its link.

Anchor id of the TOC item the viewport has scrolled to (highlight state). Kept out of toc so scroll tracking never churns the items array.

TOC nodeId → page breaks cutting through it. Written by the pagination engine after each recompute; the TOC nodeview renders row spacers from it.

Block nodeId → DISPLAYED page label (“iv”, “12”), honouring each section’s pageNumbering, so it matches the footers. Written by pagination after each recompute; undefined until then, or when it’s off. Read by the TOC.

sectionId → page count, iterated in DOCUMENT order, so a prefix sum is a section’s page offset and the full sum the document total (totalPages, the stats dialog). Written by pagination after each recompute; undefined until then, or when it’s off.

sectionId → pageNumbering, for sections that set one. Published by pagination next to pageCounts, so headers/footers resolve page numbers without subscribing to the document.

Whether the first pagination pass has produced a layout. null: nobody claims it (unpaginated, or pagination not loaded) and the canvas renders immediately. false: first pass outstanding — the canvas holds, so the unpaginated draft never flashes. true: every section has a layout, or the hold timed out.

The RAW doc.attrs.styleSheet, published by the stylesheet plugin. Sub-editor docs store no style definitions, so they read them here via the registry’s parent fall-through — same as listConfigs .

List configs (defaults + doc.attrs.listConfigs), published by the numbering plugin. Definitions are doc-global while counters are per story, so sub-editors read them here via the registry’s parent fall-through.

The root editor’s current doc, published by the numbering plugin’s view. Lets sub-editors answer cross-region questions, e.g. counting a listRef’s instances before deciding whether a config edit must fork (CORE-31).

Attrs merged into the node spec’s own attrs.

Extra DOM attributes merged into the node’s own toDOM output. class values are combined, style strings concatenated, the rest spread.

Attr values recovered from the DOM, merged into every parseDOM rule of the node.

Attrs merged into the node spec’s own attrs.

Extra DOM attributes merged into the node’s own toDOM output. class values are combined, style strings concatenated, the rest spread.

Attr values recovered from the DOM, merged into every parseDOM rule of the node.

Per-level indentation in px — Word’s w:lvl/w:pPr/w:ind. The LOWEST tier of the indent cascade (see resolveNumberedIndent); a paragraph’s own indent always beats it.

Only start, by and special are meaningful; end is kept so a round trip cannot drop a value an imported file set.

Minimum counter-cell width in px, measured from where the number STARTS (Word measures from the margin; the DOCX layer translates). Only meaningful when followed by a tab. Local extension — strip before docx.js export.

Grammatical gender for the word-based formats (cardinalText, ordinalText, ordinal) — “Parte Prima” vs “Capitolo Primo”. Defaults to masculine; ignored by digit formats and single-gender languages.

Local extension with no w:lvl equivalent: stripped before docx.js export and lost on a DOCX round trip.

Casing for the word-based formats — “FORTY-TWO” vs “forty-two”. Undefined is the converters’ native output (every word capitalised).

Local extension, like gender: stripped before docx.js export and lost on a DOCX round trip.

Unique id (assigned by the uniqueId plugin — inline nodes are opted in explicitly).

Horizontal offset (px) from the anchor point — used by front/behind.

Vertical offset (px) from the anchor point — front/behind; top margin for floats.

Find all decorations in this set which touch the given range (including decorations that start or end directly at the boundaries) and match the given predicate on their spec. When start and end are omitted, all decorations in the set are considered. When predicate isn’t given, all decorations are assumed to match.

Map the set of decorations in response to a change in the document.

Add the given array of decorations to the ones in the set, producing a new set. Consumes the decorations array. Needs access to the current document to create the appropriate tree structure.

Create a new set that contains the decorations in this set, minus the ones in the given array.

Extract a DecorationSource containing decorations for the given child node at the given offset.

Call the given function for each decoration set in the group.

When false and no upload strategy is installed, dropped/pasted images are refused instead of being embedded as base64 data URIs — docs that sync or persist server-side must not carry inline blobs.

Notified when an image is refused because inline fallbacks are disabled.

One widget at the content end of every atom-final block, kept whether or not markers are shown: it is also the caret’s text anchor after an atom, without which Chrome sizes the caret by the line box (PIL-1c). The pilcrow glyph is gated in CSS.

BCP 47 tag put on the editor’s content root, from doc.attrs.language.

lang node decorations for blocks that differ from their context.

Level-config tabStop in px (see ILevelsOptions.tabStop).

Level-config gender (see ILevelsOptions.gender).

Level-config casing (see ILevelsOptions.casing).

Show only every Nth line’s number (Word’s “Count by”). Every line is still counted.

Gap in px between the gutter and the section’s text edge (OOXML stores twips).

Where the counter resets: never, on every page, or at the section’s first line.

The first line’s number, 1-based (Word’s floor is 1).

Whether the format appears in the level-format picker. Most entries exist only so IMPORTED files render faithfully (⑴, - 5 -, Devanagari digits).

Unitless multiplier (1.5 lines) or an exact “Xpt” height.

The list this paragraph numbers against. INHERIT_LIST_REF means “take the list from the resolved style”; null is the off-sentinel (see NumberingAttrValue).

level / instanceId / followBy are USER data:

• on a directly-numbered paragraph they are the canonical storage and the numbering plugin keeps them stamped;
• on a style-numbered paragraph (INHERIT_LIST_REF) they are OVERRIDES and stay absent unless the user explicitly set one (level change at an unbound level, restart, context-menu followBy). The style cascade fills the gaps — stamping derived values here froze the binding (CORE-37).

Per-instance override of the level config’s tabStop (px, see ILevelsOptions.tabStop).

Caches the numbering plugin stamps on style-numbered paragraphs only: the values the cascade produced on the last walk. Read-only outside the plugin. DOM serialization and DOCX export use them as display fallbacks; the effective-numbering resolver ignores them, so a binding edit always re-derives.

Word’s keepLines: the paragraph is never split across pages. Carried so the DOCX round trip keeps it; the engine does not honour it yet.

Node decorations marking engine-detected oversized nodes with data-oversized-id. The actual clamp (max-height + overflow: hidden) comes from a store-driven stylesheet, NOT from decoration styles — see the pagination plugin’s oversizedClamps module.

Signature of the clamp set the decorations were built from, compared by the poke helper to skip redundant dispatches.

Block fill. null resets (cleared here, not inherited), as with numbering/outlineLevel; absent inherits.

Style-linked numbering. Inherits through basedOn as a whole object (no field merge). null resets to unnumbered; absent inherits.

Unitless multiplier (1.5 lines) or an exact “Xpt” height.

“atLeast”: the “Xpt” lineHeight is a minimum (see the paragraph attr).

Tab stops, as a whole list: a paragraph’s own tabStops replaces the style’s rather than adding to it. Inherits through basedOn; null resets to the default stops.

Heading level (1–9; Word’s w:outlineLvl is 0-based). A style with an outline level IS a heading. Inherits through basedOn; null resets to body text, absent inherits.

Pagination props (Word: keepNext / keepLines / widowControl / pageBreakBefore), in the node attr’s PaginationAttrs shape so both levels resolve the same way. One object because Word edits them together in its Paragraph dialog — the right granularity for OT and track changes.

Whole-object override through basedOn: absent inherits, null resets. Unset fields fall back to widowOrphan true and the rest false (see getStylePaginationProps). Not rendered as CSS.

Text content of the code block.

Start position of the code block.

The node’s nodeSize.

pdf.js worker script. The one asset without which nothing renders.

Directory of the CMap files, for CJK documents. Trailing slash.

Directory of the standard 14 font files. Trailing slash.

Directory of the JPX/OpenJPEG WASM modules. Trailing slash.

Directory of the ICC colour-profile WASM module. Trailing slash.

The config plugin’s allowedFileHosts. Undefined → every PDF is a card.

Pages rendered before the preview stops and says how many are left.

Content-Length above which the file is a card with the reason.

Already normalized and policy-checked by the node view.

The node’s whole-file rotation, ADDED to each page’s own.

Display name, for the preview region’s accessible name.

Box height in CSS px: the page height paginated, the height attr otherwise.

Suggested corrections in LanguageTool’s object shape (PR-2). Capped at five.

Problem positions are relative to the node’s content (doc token accounting: atoms = 1, inline node boundaries = 1 each).

Epoch ms when the node was seen deleted; the entry is kept briefly so an undo needs no new api call. A number, not a Date: entries round-trip through JSON, and a Date would come back as a string that never expires.

Cache format version. Entries whose version doesn’t match the current format are treated as misses.

Whether word is in the dictionary for language (primary subtag) or globally.

Word’s w:style/@w:type; absent means “paragraph”. A "character" entry never applies to a block: it is absent from the style picker, not a valid styleId, carries no paragraphStyle, bases only on character styles, and renders against its MARK’s selector rather than .pm-style-<id>.

Only HTMLCode (code mark) and Hyperlink (link mark) are recognised; every other w:rStyle flattens onto its runs at import.

Proofing language (BCP 47), the middle of paragraph.proofingLanguage ?? style.language ?? doc.language — Word’s w:style/w:rPr/w:lang. Top-level, not in characterStyle, so it never reaches textStyleToCss. Inherits through basedOn; null resets to the document language, absent inherits.

Word’s w:trHeight/@w:hRule: exact pins the row, atLeast (or null) lets content grow it. Carried for the DOCX round trip — the editor renders both as a minimum.

null: continue from the previous section, in decimal.

ProseMirror JSON (a doc of paragraphs). Undefined once soft-deleted.

Word’s “don’t add space between paragraphs of the same style” (w:contextualSpacing): between two blocks of one style, the before/after of a block that sets it is ignored. Inherits through the style like the other fields; null inherits.

Word’s w:style/@w:type; absent means “paragraph”. A "character" entry never applies to a block: it is absent from the style picker, not a valid styleId, carries no paragraphStyle, bases only on character styles, and renders against its MARK’s selector rather than .pm-style-<id>.

Only HTMLCode (code mark) and Hyperlink (link mark) are recognised; every other w:rStyle flattens onto its runs at import.

Proofing language (BCP 47), the middle of paragraph.proofingLanguage ?? style.language ?? doc.language — Word’s w:style/w:rPr/w:lang. Top-level, not in characterStyle, so it never reaches textStyleToCss. Inherits through basedOn; null resets to the document language, absent inherits.

doc.attrs.styleSheet as stored — what sub-editors read off the store.

“#RRGGBB”, the AUTO_COLOR sentinel "auto" (Word’s automatic color: flips black/white against the nearest background at render time), or null (the stylesheet decides). “auto” is legal ONLY here and in TextStyle.color; every other color slot treats it as absent.

“#RRGGBB”, the AUTO_COLOR sentinel "auto" (Word’s automatic color: flips black/white against the nearest background at render time), or null (the stylesheet decides). “auto” is legal ONLY here and in TextStyle.color; every other color slot treats it as absent.

Properties this run turns OFF against its paragraph’s style. Always in TEXT_STYLE_OFF order and never [] — a reordered or empty array is a different mark to Mark.eq, so adjacent text stops merging. Write through withOff.

“#RRGGBB”, the AUTO_COLOR sentinel "auto" (Word’s automatic color: flips black/white against the nearest background at render time), or null (the stylesheet decides). “auto” is legal ONLY here and in TextStyle.color; every other color slot treats it as absent.

ProseMirror JSON (a doc of paragraphs). Undefined once soft-deleted.

Set when the comment has been soft-deleted.

Dotted leader between text and the right-aligned number (only meaningful with alignNumberRight).

“document” lists every section’s headings (Word default); “section” only the TOC’s own.

Node type name of the anchor (“heading”, “paragraph”, …).

Plain-text projection of runs (math omitted) — for search/aria/compact lists.

0-based index of the section the anchor lives in — lets a section-scoped TOC filter.

The still-pending insertion this deletion/deleteClosure overwrote — set only when a reviewer deletes ANOTHER user’s inserted block (the attr is a single slot, unlike inline marks which stack). Rejecting the deletion restores it, so the original proposal returns to pending instead of being silently accepted. Never nests: an insertion carries no previous.

markId → lastActivityTimestamp, driving the merge of adjacent marks by the same user within a short window. On plugin state so editors don’t share it.

Whether the doc holds ANY pending track change, kept incrementally so toolbar probes are O(1). When absent (tests, states without the plugin) consumers fall back to a cached full-doc walk.

Not type, which on a mark reads as mark.type. The DOM form stays data-underline-type.