`@stesura/core/testing`

Helpers for writing tests against the Stesura schema. Build documents with the tb builders and testDoc, which wraps content in a section and validates it against the schema.

Requires prosemirror-test-builder, an optional peer dependency that is not auto-installed: add it to your devDependencies. tempEditor mounts a real EditorView, so it needs a DOM (for example jsdom).

Functions & values

`checkedDoc`

Parameters:

Name	Type	Default
`doc`	`T`

Returns:

T

`colCount`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

number

`collectAttr`

Parameters:

Name	Type	Default
`doc`	`Node`
`attrName`	`string`
`predicate`	`(node: Node) => boolean`

Returns:

{ pos: number; value: unknown; }[]

`findFirstInContent`

Parameters:

Name	Type	Default
`doc`	`Node`
`typeName`	`string`

Returns:

{ node: Node; pos: number; } | null

`getAllSections`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

Node[]

`getCommentAttrs`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

{ open?: CommentOpenAttrs; close?: CommentOpenAttrs; }

`getCursorSection`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

Node

`getTableNode`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

Node

`make2x2State`

Parameters:

This function does not accept any parameters.

Returns:

EditorState

`make3x3State`

Parameters:

This function does not accept any parameters.

Returns:

EditorState

`makeCell`

Parameters:

Name	Type	Default
`colwidth`	`number`

Returns:

Node

`makeCellWithText`

Parameters:

Name	Type	Default
`text`	`string`
`colwidth`	`number`

Returns:

Node

`makeLinkEditorState`

Parameters:

Name	Type	Default
`doc`	`TaggedNode`
`from`	`number`
`to`	`number`

Returns:

EditorState

`makeRow`

Parameters:

Name	Type	Default
`cells`	`Node[]`

Returns:

Node

`makeTable`

Parameters:

Name	Type	Default
`rows`	`Node[]`

Returns:

Node

`rowCount`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

number

`selectionInContent`

Parameters:

Name	Type	Default
`doc`	`Node`

Returns:

TextSelection

`singleSectionState`

Parameters:

Name	Type	Default
`content`	`[attrsOrFirstChild?: ChildSpec \| Attrs \| undefined, ...children: ChildSpec[]]`

Returns:

EditorState

`stateWithCursorAt`

Parameters:

Name	Type	Default
`table`	`Node`
`rowIndex`	`number`
`colIndex`	`number`

Returns:

EditorState

`stateWithSelectedImage`

Parameters:

Name	Type	Default
`imageAttrs`	`Record<string, unknown>`

Returns:

EditorState

`stateWithTable`

Parameters:

Name	Type	Default
`table`	`Node`

Returns:

EditorState

`tb`

Name	Type	Default
`schema`	`Schema<"doc" \| "paragraph" \| "heading" \| "counter_node" \| "toc" \| "horizontal_rule" \| "page_break" \| "image" \| "image_anchored" \| "math_inline" \| "math_display" \| "table" \| "table_row" \| ... 22 more ... \| "text", "link" \| ... 13 more ... \| "modification">`
`doc`	`NodeBuilder`
`paragraph`	`NodeBuilder`
`heading`	`NodeBuilder`
`counter_node`	`NodeBuilder`
`toc`	`NodeBuilder`
`horizontal_rule`	`NodeBuilder`
`page_break`	`NodeBuilder`
`image`	`NodeBuilder`
`image_anchored`	`NodeBuilder`
`math_inline`	`NodeBuilder`
`math_display`	`NodeBuilder`
`table`	`NodeBuilder`
`table_row`	`NodeBuilder`
`table_cell`	`NodeBuilder`
`code_block`	`NodeBuilder`
`hard_break`	`NodeBuilder`
`boundary_open_node`	`NodeBuilder`
`boundary_close_node`	`NodeBuilder`
`page_number`	`NodeBuilder`
`comment_open`	`NodeBuilder`
`comment_close`	`NodeBuilder`
`upload_block`	`NodeBuilder`
`file`	`NodeBuilder`
`header_footer_content`	`NodeBuilder`
`section`	`NodeBuilder`
`section_header`	`NodeBuilder`
`section_footer`	`NodeBuilder`
`section_content`	`NodeBuilder`
`footnotes`	`NodeBuilder`
`footnote_anchor`	`NodeBuilder`
`footnote_body`	`NodeBuilder`
`endnotes`	`NodeBuilder`
`endnote_anchor`	`NodeBuilder`
`endnote_body`	`NodeBuilder`
`cross_reference`	`NodeBuilder`
`text`	`NodeBuilder`
`link`	`MarkBuilder`
`em`	`MarkBuilder`
`strong`	`MarkBuilder`
`code`	`MarkBuilder`
`underline`	`MarkBuilder`
`strikethrough`	`MarkBuilder`
`superscript`	`MarkBuilder`
`subscript`	`MarkBuilder`
`highlight`	`MarkBuilder`
`border`	`MarkBuilder`
`textStyle`	`MarkBuilder`
`proofReadIgnore`	`MarkBuilder`
`deletion`	`MarkBuilder`
`insertion`	`MarkBuilder`
`modification`	`MarkBuilder`

`tempEditor`

Parameters:

Name	Type	Default
`opts`	`{ doc?: Node; plugins?: Plugin<any>[]; }`

Returns:

EditorView

`testDoc`

Parameters:

Name	Type	Default
`content`	`[attrsOrFirstChild?: ChildSpec \| Attrs \| undefined, ...children: ChildSpec[]]`

Returns:

TaggedNode

`testSection`

Parameters:

Name	Type	Default
`content`	`[attrsOrFirstChild?: ChildSpec \| Attrs \| undefined, ...children: ChildSpec[]]`
`attrs`	`Partial<SectionAttrs>`

Returns:

Node & { tag: Tags; }

`twoSectionState`

Parameters:

This function does not accept any parameters.

Returns:

EditorState

`uncheckedTestDoc`

Parameters:

Name	Type	Default
`content`	`[attrsOrFirstChild?: ChildSpec \| Attrs \| undefined, ...children: ChildSpec[]]`

Returns:

TaggedNode

Types

`TaggedNode`

Name	Type	Default
`type`	`NodeType` The type of node that this is.
`attrs`	`Attrs` An object mapping attribute names to values. The kind of attributes allowed and required are determined by the node type.
`marks`	`readonly Mark[]` The marks (things like whether it is emphasized or part of a link) applied to this node.
`content`	`Fragment` A container holding the node’s children.
`children`	`readonly Node[]` The array of this node’s child nodes.
`text`	`string \| undefined` For text nodes, this contains the node’s text content.
`nodeSize`	`number` The size of this node, as defined by the integer-based indexing scheme . For text nodes, this is the amount of characters. For other leaf nodes, it is one. For non-leaf nodes, it is the size of the content plus two (the start and end token).
`childCount`	`number` The number of children that the node has.
`child`	`(index: number) => Node` Get the child node at the given index. Raises an error when the index is out of range.
`maybeChild`	`(index: number) => Node \| null` Get the child node at the given index, if it exists.
`forEach`	`(f: (node: Node, offset: number, index: number) => void) => void` Call `f` for every child node, passing the node, its offset into this parent node, and its index.
`nodesBetween`	`(from: number, to: number, f: (node: Node, pos: number, parent: Node \| null, index: number) => boolean \| void, startPos?: number \| undefined) => void` Invoke a callback for all descendant nodes recursively overlapping the given two positions that are relative to start of this node’s content. This includes all ancestors of the nodes containing the two positions. The callback is invoked with the node, its position relative to the original node (method receiver), its parent node, and its child index. When the callback returns false for a given node, that node’s children will not be recursed over. The last parameter can be used to specify a starting position to count from.
`descendants`	`(f: (node: Node, pos: number, parent: Node \| null, index: number) => boolean \| void) => void` Call the given callback for every descendant node. Doesn’t descend into a node when the callback returns `false`.
`textContent`	`string` Concatenates all the text nodes found in this fragment and its children.
`textBetween`	`(from: number, to: number, blockSeparator?: string \| null \| undefined, leafText?: string \| ((leafNode: Node) => string) \| null \| undefined) => string` Get all text between positions `from` and `to`. When `blockSeparator` is given, it will be inserted to separate text from different block nodes. If `leafText` is given, it’ll be inserted for every non-text leaf node encountered, otherwise `leafText` will be used.
`firstChild`	`Node \| null` Returns this node’s first child, or `null` if there are no children.
`lastChild`	`Node \| null` Returns this node’s last child, or `null` if there are no children.
`eq`	`(other: Node) => boolean` Test whether two nodes represent the same piece of document.
`sameMarkup`	`(other: Node) => boolean` Compare the markup (type, attributes, and marks) of this node to those of another. Returns `true` if both have the same markup.
`hasMarkup`	`(type: NodeType, attrs?: Attrs \| null \| undefined, marks?: readonly Mark[] \| undefined) => boolean` Check whether this node’s markup correspond to the given type, attributes, and marks.
`copy`	`(content?: Fragment \| null \| undefined) => Node` Create a new node with the same markup as this node, containing the given content (or empty, if no content is given).
`mark`	`(marks: readonly Mark[]) => Node` Create a copy of this node, with the given set of marks instead of the node’s own marks.
`cut`	`(from: number, to?: number \| undefined) => Node` Create a copy of this node with only the content between the given positions. If `to` is not given, it defaults to the end of the node.
`slice`	`(from: number, to?: number \| undefined, includeParents?: boolean \| undefined) => Slice` Cut out the part of the document between the given positions, and return it as a `Slice` object.
`replace`	`(from: number, to: number, slice: Slice) => Node` Replace the part of the document between the given positions with the given slice. The slice must ‘fit’, meaning its open sides must be able to connect to the surrounding content, and its content nodes must be valid children for the node they are placed into. If any of this is violated, an error of type `ReplaceError` is thrown.
`nodeAt`	`(pos: number) => Node \| null` Find the node directly after the given position.
`childAfter`	`(pos: number) => { node: Node \| null; index: number; offset: number; }` Find the (direct) child node after the given offset, if any, and return it along with its index and offset relative to this node.
`childBefore`	`(pos: number) => { node: Node \| null; index: number; offset: number; }` Find the (direct) child node before the given offset, if any, and return it along with its index and offset relative to this node.
`resolve`	`(pos: number) => ResolvedPos` Resolve the given position in the document, returning an object with information about its context.
`rangeHasMark`	`(from: number, to: number, type: Mark \| MarkType) => boolean` Test whether a given mark or mark type occurs in this document between the two given positions.
`isBlock`	`boolean` True when this is a block (non-inline node)
`isTextblock`	`boolean` True when this is a textblock node, a block node with inline content.
`inlineContent`	`boolean` True when this node allows inline content.
`isInline`	`boolean` True when this is an inline node (a text node or a node that can appear among text).
`isText`	`boolean` True when this is a text node.
`isLeaf`	`boolean` True when this is a leaf node.
`isAtom`	`boolean` True when this is an atom, i.e. when it does not have directly editable content. This is usually the same as `isLeaf`, but can be configured with the `atom` property on a node’s spec (typically used when the node is displayed as an uneditable node view ).
`toString`	`() => string` Return a string representation of this node for debugging purposes.
`contentMatchAt`	`(index: number) => ContentMatch` Get the content match in this node at the given index.
`canReplace`	`(from: number, to: number, replacement?: Fragment \| undefined, start?: number \| undefined, end?: number \| undefined) => boolean` Test whether replacing the range between `from` and `to` (by child index) with the given replacement fragment (which defaults to the empty fragment) would leave the node’s content valid. You can optionally pass `start` and `end` indices into the replacement fragment.
`canReplaceWith`	`(from: number, to: number, type: NodeType, marks?: readonly Mark[] \| undefined) => boolean` Test whether replacing the range `from` to `to` (by index) with a node of the given type would leave the node’s content valid.
`canAppend`	`(other: Node) => boolean` Test whether the given node’s content could be appended to this node. If that node is empty, this will only return true if there is at least one node type that can appear in both nodes (to avoid merging completely incompatible nodes).
`check`	`() => void` Check whether this node and its descendants conform to the schema, and raise an exception when they do not.
`toJSON`	`() => any` Return a JSON-serializeable representation of this node.
`tag`	`Record<string, number>`