`@stesura/core/sub-editor`

Shared machinery behind nested editors (footnotes, endnotes, headers/footers). One SubEditorKindConfig per kind drives the inner schema (buildSubEditorSchema), the inner state (createSubEditorState) and the main-to-inner binding plugin (createSubEditorBindingPlugin). Edits flow back to the main editor through forwardInnerSteps.

Functions & values

`buildSubEditorSchema`

Parameters:

Name	Type	Default
`base`	`Schema<any, any>`
`config`	`Pick<SubEditorKindConfig<K>, "kind" \| "wrapperName" \| "regionNodeName" \| "contentExpr" \| "filterOutNodes">`

Returns:

Schema<any, any>

`createSubEditorBindingPlugin`

Parameters:

Name	Type	Default
`config`	`SubEditorKindConfig<K>`

Returns:

Plugin<any>

`createSubEditorRegistry`

Parameters:

Name	Type	Default
`keyId`	`(key: K) => string`

Returns:

SubEditorRegistry<K>

`createSubEditorState`

Parameters:

Name	Type	Default
`plugins`	`Plugin<any>[]`
`schema`	`Schema<any, any>`
`config`	`CreateDocConfig`
`wrapperAttrs`	`Attrs`
`blockContent`	`Node[] \| Fragment`

Returns:

EditorState | null

`describeSubEditorFailure`

Parameters:

Name	Type	Default
`failure`	`SubEditorBuildFailure`

Returns:

string

`findUnrepresentableNodeTypes`

Parameters:

Name	Type	Default
`content`	`Fragment`
`inner`	`Schema<any, any>`

Returns:

string[]

`forwardInnerSteps`

Parameters:

Name	Type	Default
`__0`	`{ outerTr: Transaction; outerSchema: Schema<any, any>; transactions: readonly Transaction[]; regionPos: number; logContext: string; }`

Returns:

boolean

`getAllSubEditors`

Parameters:

Name	Type	Default
`mainEditorId`	`string`

Returns:

AnySubEditor[]

`recoverSubEditorAfterFailedForward`

Parameters:

Name	Type	Default
`config`	`SubEditorKindConfig<K>`
`editor`	`ActiveSubEditor<K>`
`outerState`	`EditorState`

Returns:

void

`subscribeSubEditors`

Parameters:

Name	Type	Default
`listener`	`() => void`

Returns:

() => void

Types

`ActiveSubEditor`

Name	Type	Default
`view`	`EditorView`
`key`	`K`
`mainEditorId`	`string` The main editor this sub-editor belongs to. Registries are page-global, so without it two editors showing the same note/section would collide and a binding plugin would push its edits into the other editor’s panel.

`AnySubEditor`

Name	Type	Default
`view`	`EditorView`
`mainEditorId`	`string`

`SubEditorBuildFailure`

Name	Type	Default
`reason`	`"schema" \| "unrepresentable"`

`SubEditorDocResult`

Name	Type	Default
`ok`	`boolean`

`SubEditorKindConfig`

Name	Type	Default
`kind`	`string` Human-readable kind name, used in log messages (“headerFooter”, “footnote”, …).
`pluginKey`	`PluginKey<any>` The binding plugin’s key. MUST keep its existing string label — sub-editor plugin exclusion lists and host plugin filtering match on it.
`registry`	`SubEditorRegistry<K>` Registry of currently mounted sub-editors of this kind.
`wrapperName`	`string` Inner wrapper node name; its spec is the main `section`’s, so section CSS vars and plugins keep working. E.g. “section_footer_header”, “section”.
`regionNodeName`	`string` The main-doc node this kind binds to (“header_footer_content”, “footnote_body”, …). The inner `section_content` takes ITS content expression, so the two can never drift; `buildSubEditorSchema` also asserts the derived schema can hold everything this node allows.
`contentExpr`	`string \| ((base: Schema<any, any>) => string)` Override for the inner `section_content` expression. Leave unset (no built-in kind sets it): the region node’s own expression keeps the schemas in step. An override must be at least as strict as the region node, or inner edits produce steps the main doc rejects.
`filterOutNodes`	`string[]` Node names stripped from the base schema when deriving the inner schema.
`validateContentAgainst`	`string` Inner node whose spec validates the initial content in `createSubEditorState` (default “section_content”). Notes use their body node type.
`findRegion`	`(state: EditorState, key: K) => SubEditorRegion \| null` Locate the bound region in a main-editor state.
`isRegionNode`	`(node: Node, key: K) => boolean` Recognize the region node of a given key among removed nodes, so the binding can react when the region disappears (e.g. a remote user deletes the note whose body is being edited). Omit when removal is handled elsewhere (the header/footer panel watches the main state itself).
`onRegionRemoved`	`(key: K, state: EditorState) => void` Called (outside the render cycle) after the binding unregisters an editor whose region was removed. Feature-level cleanup: close the panel, toast.
`onForwardRegionMissing`	`(key: K) => void` Called when inner→outer forwarding can’t find the region in the main doc (defensive — normally the binding’s removal path fires first).
`prepareOuterTr`	`(tr: Transaction) => void` Stamp kind-specific metas on the outer transaction built from inner steps (headers/footers add `enableHeaderFooterEdits` for the guard plugin). `fromSubEditor` and `skipTrackChanges` are always set by the machinery.
`extraExcludedPlugins`	`string[]` Plugin key labels to exclude from the sub-editor ON TOP of the shared base list.
`extraPlugins`	`(schema: Schema<any, any>) => Plugin<any>[]` Kind-specific plugins, placed AHEAD of the host’s filtered plugins so they win for the same key binding — headers/footers use this to suppress document-wide keys (Mod-A, Mod-F).
`editorId`	`(key: K, mainEditorId: string) => string` The sub-editor’s editorId (store scoping, toolbar routing). MUST include `mainEditorId`: the store registry is page-global, so a bare key would cross-wire two editors open on the same note.
`matchesSearchRegion`	`(region: SearchMatchRegion, key: K) => boolean` True when a classified search-match region belongs to the sub-editor `key`.
`viewSpec`	`((view: EditorView) => PluginView) \| undefined` Plugin `view` spec for the binding plugin on the MAIN editor. Notes use it to turn a NodeSelection into a TextSelection when a panel opens (the anchor may be deleted concurrently).

`SubEditorRegion`

Name	Type	Default
`pos`	`number`
`node`	`Node`

`SubEditorRegistry`

Name	Type	Default
`atom`	`WritableAtom<ActiveSubEditor<K>[]>`
`keyId`	`(key: K) => string` Stable identity for a key within one main editor.
`register`	`(entry: ActiveSubEditor<K>) => void`
`unregister`	`(mainEditorId: string, key: K) => void`
`getAll`	`(mainEditorId: string) => ActiveSubEditor<K>[]` Entries belonging to `mainEditorId` only.
`get`	`(mainEditorId: string, key: K) => ActiveSubEditor<K> \| undefined` The registered editor bound to `key` under `mainEditorId`, if mounted.

Other exports

Export	Type	Description
`SUB_EDITOR_EXCLUDED_PLUGINS`	`string[]`	Plugin key labels stripped from the main editor’s plugins before mounting any sub-editor. Kinds add more via `SubEditorKindConfig.extraExcludedPlugins`.