import type { Element, Editor, ElementIn, ElementOrTextIn, Location, Node, NodeIn, NodeProps, NodeSelection, Path, Selection, Value, } from '../../index'; import type { MaximizeMode, RangeMode } from '../../types/types'; import type { NodeForTypeSelector, PropsCompare, PropsMerge } from '../editor'; import type { NodeMatch, NodeTypeSelector } from '../node'; export interface NodeInsertSplitOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = undefined, > { match?: NodeMatch; type?: TType; } export interface NodeInsertNodesOptions< TSplit extends Node = Node, TType extends NodeTypeSelector | undefined = undefined, > { at?: Location; mode?: RangeMode; hanging?: boolean; select?: boolean; split?: NodeInsertSplitOptions; voids?: boolean; } export interface NodeRemoveNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location | NodeSelection; match?: NodeMatch; type?: TType; mode?: MaximizeMode; hanging?: boolean; voids?: boolean; } export interface NodeLiftNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location | NodeSelection; match?: NodeMatch; type?: TType; mode?: MaximizeMode; voids?: boolean; } export interface NodeMergeNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location | NodeSelection; match?: NodeMatch; type?: TType; mode?: RangeMode; hanging?: boolean; voids?: boolean; } export interface NodeMoveNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location | NodeSelection; match?: NodeMatch; type?: TType; mode?: MaximizeMode; to: Path; voids?: boolean; } export interface NodeSplitNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location; match?: NodeMatch; type?: TType; mode?: RangeMode; always?: boolean; height?: number; position?: number; voids?: boolean; } export interface NodeUnwrapNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location | NodeSelection; match?: NodeMatch; type?: TType; mode?: MaximizeMode; split?: boolean; voids?: boolean; } export interface NodeWrapNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location | NodeSelection; match?: NodeMatch; type?: TType; mode?: MaximizeMode; split?: boolean; voids?: boolean; } export type NodeDuplicateOptions = Pick< NodeInsertNodesOptions, 'hanging' | 'select' | 'voids' >; export type BlockDuplicateOptions< T extends Element = Element, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > = { at?: Location; match?: NodeMatch; type?: TType; mode?: RangeMode; voids?: boolean; } & Pick; export interface NodeReplaceChildrenOptions { at: Path; count?: number; index?: number; newSelection?: Selection; /** Preserve runtime keys for positionally corresponding replacements. */ preserveKeys?: boolean; } export interface NodeSetNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location | NodeSelection; match?: NodeMatch; type?: TType; mode?: MaximizeMode; hanging?: boolean; marks?: boolean; split?: boolean; voids?: boolean; compare?: PropsCompare; merge?: PropsMerge; } export interface NodeUnsetNodesOptions< T extends Node = Node, TType extends NodeTypeSelector | undefined = NodeTypeSelector | undefined, > { at?: Location | NodeSelection; match?: NodeMatch; type?: TType; mode?: MaximizeMode; hanging?: boolean; split?: boolean; voids?: boolean; } type NodeMutationTarget< V extends Value, TType extends NodeTypeSelector | undefined, > = undefined extends TType ? NodeIn : NodeForTypeSelector>; type OptionalSelectorOptions< TOptions extends { type?: NodeTypeSelector | undefined }, > = undefined extends TOptions['type'] ? TOptions : never; export interface NodeMutationMethods { /** * Insert nodes in the editor * at the specified location or (if not defined) the current selection or (if not defined) the end of the document. */ insertNodes: { < TValue extends V, TPlugins extends readonly unknown[], T extends ElementOrTextIn, const TType extends NodeTypeSelector | undefined, >( editor: Editor, nodes: T | readonly T[], options: NodeInsertNodesOptions< NodeMutationTarget, TType > & { split: NodeInsertNodesOptions< NodeMutationTarget, TType >['split'] & { type: TType }; } ): void; < TValue extends V, TPlugins extends readonly unknown[], T extends ElementOrTextIn, >( editor: Editor, nodes: T | readonly T[], options?: NodeInsertNodesOptions> ): void; }; /** * Lift nodes at a specific location upwards in the document tree, splitting * their parent in two if necessary. */ liftNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, options: NodeLiftNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeLiftNodesOptions> = NodeLiftNodesOptions>, >( editor: Editor, options?: OptionalSelectorOptions ): void; }; /** * Merge a node at a location with the previous node of the same depth, * removing any empty containing nodes after the merge if necessary. */ mergeNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, options: NodeMergeNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeMergeNodesOptions> = NodeMergeNodesOptions>, >( editor: Editor, options?: OptionalSelectorOptions ): void; }; /** * Move the nodes at a location to a new location. */ moveNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, options: NodeMoveNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeMoveNodesOptions> = NodeMoveNodesOptions>, >( editor: Editor, options: OptionalSelectorOptions ): void; }; /** * Remove the nodes at a specific location in the document. */ removeNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, options: NodeRemoveNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeRemoveNodesOptions> = NodeRemoveNodesOptions>, >( editor: Editor, options?: OptionalSelectorOptions ): void; }; /** Replace a range of children under an ancestor node atomically. */ replaceChildren: ( editor: Editor, children: ReadonlyArray>, options: NodeReplaceChildrenOptions ) => void; /** * Set new properties on the nodes at a location. */ setNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, props: Partial>>, options: NodeSetNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeSetNodesOptions> = NodeSetNodesOptions>, >( editor: Editor, props: Partial>>, options?: OptionalSelectorOptions ): void; }; /** * Split the nodes at a specific location. */ splitNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, options: NodeSplitNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeSplitNodesOptions> = NodeSplitNodesOptions>, >( editor: Editor, options?: OptionalSelectorOptions ): void; }; /** * Unset properties on the nodes at a location. */ unsetNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, props: string | readonly string[], options: NodeUnsetNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeUnsetNodesOptions> = NodeUnsetNodesOptions>, >( editor: Editor, props: string | readonly string[], options?: OptionalSelectorOptions ): void; }; /** * Unwrap the nodes at a location from a parent node, splitting the parent if * necessary to ensure that only the content in the range is unwrapped. */ unwrapNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, options: NodeUnwrapNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeUnwrapNodesOptions> = NodeUnwrapNodesOptions>, >( editor: Editor, options?: OptionalSelectorOptions ): void; }; /** * Wrap the nodes at a location in a new container node, splitting the edges * of the range first to ensure that only the content in the range is wrapped. */ wrapNodes: { < TValue extends V, TPlugins extends readonly unknown[], const TType extends NodeTypeSelector, >( editor: Editor, element: ElementIn, options: NodeWrapNodesOptions, TType> & { type: TType; } ): void; < TValue extends V, TPlugins extends readonly unknown[], const TOptions extends NodeWrapNodesOptions> = NodeWrapNodesOptions>, >( editor: Editor, element: ElementIn, options?: OptionalSelectorOptions ): void; }; }