@prosekit/core 0.7.7 → 0.7.9

package/dist/_tsup-dts-rollup.d.ts

@@ -1,28 +1,30 @@
 import { AllSelection } from '@prosekit/pm/state';
-import { Attrs } from '@prosekit/pm/model';
+import type { Attrs } from '@prosekit/pm/model';
 import { Command } from '@prosekit/pm/state';
 import type { ContentMatch } from '@prosekit/pm/model';
 import { config as default_alias_1 } from '@prosekit/dev/config-vitest';
 import type { DirectEditorProps } from '@prosekit/pm/view';
 import type { DOMEventMap } from '@prosekit/pm/view';
+import type { DOMOutputSpec } from '@prosekit/pm/model';
 import { DOMParser as DOMParser_2 } from '@prosekit/pm/model';
 import { DOMSerializer } from '@prosekit/pm/model';
 import { EditorState } from '@prosekit/pm/state';
 import type { EditorStateConfig } from '@prosekit/pm/state';
 import { EditorView } from '@prosekit/pm/view';
+import { Fragment } from '@prosekit/pm/model';
 import type { IsEqual } from 'type-fest';
 import { Mark } from '@prosekit/pm/model';
 import type { MarkSpec } from '@prosekit/pm/model';
-import { MarkType } from '@prosekit/pm/model';
+import type { MarkType } from '@prosekit/pm/model';
 import type { Node as Node_2 } from '@prosekit/pm/model';
 import { NodeSelection } from '@prosekit/pm/state';
 import type { NodeSpec } from '@prosekit/pm/model';
-import { NodeType } from '@prosekit/pm/model';
+import type { NodeType } from '@prosekit/pm/model';
 import { NodeType as NodeType_2 } from 'prosemirror-model';
 import type { NodeView } from '@prosekit/pm/view';
 import type { NodeViewConstructor } from '@prosekit/pm/view';
 import { Options } from 'tsup';
-import type { ParseOptions } from '@prosekit/pm/model';
+import { ParseOptions } from '@prosekit/pm/model';
 import { Plugin as Plugin_2 } from '@prosekit/pm/state';
 import { ProseMirrorFragment } from '@prosekit/pm/model';
 import { ProseMirrorNode } from '@prosekit/pm/model';
@@ -32,7 +34,8 @@ import { SchemaSpec } from '@prosekit/pm/model';
 import { Selection as Selection_2 } from '@prosekit/pm/state';
 import { Selection as Selection_3 } from 'prosemirror-state';
 import type { Simplify } from 'type-fest';
-import type { Slice } from '@prosekit/pm/model';
+import { Slice } from '@prosekit/pm/model';
+import type { TagParseRule } from '@prosekit/pm/model';
 import { TextSelection } from '@prosekit/pm/state';
 import { Transaction } from '@prosekit/pm/state';
 import type { UnionToIntersection } from 'type-fest';
@@ -120,6 +123,12 @@ export declare function assertTypeEqual<T, U>(_val: IsEqual<T, U>): void;
  */
 export declare function assertTypeEqual_alias_1<T, U>(_val: IsEqual<T, U>): void;
 
+declare interface AttrOptions {
+    attr: string;
+    toDOM?: (value: unknown) => [key: string, value: string] | null | undefined;
+    parseDOM?: (node: HTMLElement) => unknown;
+}
+
 export declare function attrsMatch(nodeOrMark: ProseMirrorNode | Mark, attrs: Attrs): boolean;
 
 /**
@@ -224,10 +233,6 @@ declare interface BaseNodeViewOptions {
 export { BaseNodeViewOptions }
 export { BaseNodeViewOptions as BaseNodeViewOptions_alias_1 }
 
-export declare function baseToggleMark(markType: MarkType, attrs?: Attrs | null, options?: {
-    removeWhenPresent: boolean;
-}): Command;
-
 declare type BoldExtension = Extension<{
     Marks: {
         bold: Attrs;
@@ -269,16 +274,27 @@ declare type CodeBlockExtension = Extension<{
     };
 }>;
 
+/**
+ * Collects all children of a node or a fragment, and returns them as an array.
+ *
+ * @public
+ */
+declare function collectChildren(parent: ProseMirrorNode | Fragment): ProseMirrorNode[];
+export { collectChildren }
+export { collectChildren as collectChildren_alias_1 }
+
 /**
  * Collects all nodes from a given content.
  *
+ * @deprecated Use `collectChildren` instead.
+ *
  * @public
  */
 declare function collectNodes(content: NodeContent): ProseMirrorNode[];
 export { collectNodes }
 export { collectNodes as collectNodes_alias_1 }
 
-export declare function combineEventHandlers<Handler extends (...args: any[]) => boolean | void, Args extends Parameters<Handler> = Parameters<Handler>>(): readonly [(handlers: Handler[]) => void, (...args: Args) => boolean];
+export declare function combineEventHandlers<Handler extends (...args: any[]) => boolean | void, Args extends Parameters<Handler> = Parameters<Handler>>(): readonly [(eventHandlers: Handler[]) => void, (...args: Args) => boolean];
 
 /**
  * A function to apply a command to the editor. It will return `true` if the command was applied, and `false` otherwise.
@@ -288,7 +304,21 @@ export declare function combineEventHandlers<Handler extends (...args: any[]) =>
  * @public
  */
 declare interface CommandAction<Args extends any[] = any[]> {
+    /**
+     * Execute the current command. Return `true` if the command was successfully
+     * executed, otherwise `false`.
+     */
     (...args: Args): boolean;
+    /**
+     * Check if the current command can be executed. Return `true` if the command
+     * can be executed, otherwise `false`.
+     */
+    canExec(...args: Args): boolean;
+    /**
+     * An alias for `canExec`.
+     *
+     * @deprecated Use `canExec` instead.
+     */
     canApply(...args: Args): boolean;
 }
 export { CommandAction }
@@ -389,7 +419,7 @@ declare interface DefaultStateOptions {
     defaultHTML?: string | HTMLElement;
     /**
      * A JSON object representing the starting selection to use when creating the
-     * editor. It's only used when `defaultDoc` or `defaultHTML` is also provided.
+     * editor. It's only used when `defaultContent` is also provided.
      */
     defaultSelection?: SelectionJSON;
 }
@@ -450,9 +480,11 @@ export { defineCommands as defineCommands_alias_1 }
 /**
  * Define a default state for the editor.
  *
+ * @param options
+ *
  * @public
  */
-declare function defineDefaultState(options: DefaultStateOptions): PlainExtension;
+declare function defineDefaultState({ defaultSelection, defaultContent, defaultDoc, defaultHTML, }: DefaultStateOptions): PlainExtension;
 export { defineDefaultState }
 export { defineDefaultState as defineDefaultState_alias_1 }
 
@@ -554,6 +586,8 @@ export { defineFocusChangeHandler as defineFocusChangeHandler_alias_1 }
 /**
  * Add undo/redo history to the editor.
  *
+ * @param options
+ *
  * @public
  */
 declare function defineHistory({ depth, newGroupDelay, }?: HistoryOptions): HistoryExtension;
@@ -933,6 +967,16 @@ declare class Editor<E extends Extension = any> {
      *   - The string "end" (to set selection at the end)
      */
     setContent: (content: ProseMirrorNode | NodeJSON | string | HTMLElement, selection?: SelectionJSON | Selection_2 | "start" | "end") => void;
+    /**
+     * Execute the given command. Return `true` if the command was successfully
+     * executed, otherwise `false`.
+     */
+    exec: (command: Command) => boolean;
+    /**
+     * Check if the given command can be executed. Return `true` if the command
+     * can be executed, otherwise `false`.
+     */
+    canExec: (command: Command) => boolean;
     /**
      * All {@link CommandAction}s defined by the editor.
      */
@@ -966,6 +1010,7 @@ export declare class EditorInstance {
     constructor(extension: Extension);
     getState: () => EditorState;
     updateState(state: EditorState): void;
+    private dispatch;
     setContent(content: NodeJSON | string | HTMLElement | ProseMirrorNode, selection?: SelectionJSON | Selection_2 | 'start' | 'end'): void;
     private updateExtension;
     use(extension: Extension): VoidFunction;
@@ -975,6 +1020,8 @@ export declare class EditorInstance {
     get assertView(): EditorView;
     definePlugins(plugins: readonly Plugin_2[]): void;
     removePlugins(plugins: readonly Plugin_2[]): void;
+    exec(command: Command): boolean;
+    canExec(command: Command): boolean;
     defineCommand<Args extends any[] = any[]>(name: string, commandCreator: CommandCreator<Args>): void;
     removeCommand(name: string): void;
 }
@@ -1017,7 +1064,7 @@ declare interface EditorOptions<E extends Extension> {
     defaultHTML?: string | HTMLElement;
     /**
      * A JSON object representing the starting selection to use when creating the
-     * editor. It's only used when `defaultDoc` or `defaultHTML` is also provided.
+     * editor. It's only used when `defaultContent` is also provided.
      */
     defaultSelection?: SelectionJSON;
 }
@@ -1252,10 +1299,63 @@ export declare function findBrowserWindow(options?: {
     document?: Document;
 }): (Window & typeof globalThis) | null | undefined;
 
-export declare function findParentNode(nodeType: NodeType, $pos: ResolvedPos): {
-    from: number | null;
-    to: number | null;
-};
+/**
+ * Find the closest parent node that satisfies the predicate.
+ *
+ * @public
+ */
+declare function findParentNode(
+/**
+ * The predicate to test the parent node.
+ */
+predicate: (node: ProseMirrorNode) => boolean, 
+/**
+ * The position to start searching from.
+ */
+$pos: ResolvedPos): FindParentNodeResult | undefined;
+export { findParentNode }
+export { findParentNode as findParentNode_alias_1 }
+
+/**
+ * Finds the closest parent node that matches the given node type.
+ *
+ * @public
+ */
+declare function findParentNodeOfType(
+/**
+ * The type of the node to find.
+ */
+type: NodeType | string, 
+/**
+ * The position to start searching from.
+ */
+$pos: ResolvedPos): FindParentNodeResult | undefined;
+export { findParentNodeOfType }
+export { findParentNodeOfType as findParentNodeOfType_alias_1 }
+
+/**
+ * @public
+ */
+declare interface FindParentNodeResult {
+    /**
+     * The closest parent node that satisfies the predicate.
+     */
+    node: ProseMirrorNode;
+    /**
+     * The position directly before the node.
+     */
+    pos: number;
+    /**
+     * The position at the start of the node.
+     */
+    start: number;
+    /**
+     * The depth of the node.
+     */
+    depth: number;
+}
+export { FindParentNodeResult }
+export { FindParentNodeResult as FindParentNodeResult_alias_1 }
 
 /**
  * A function that is called when the editor gains or loses focus.
@@ -1316,12 +1416,12 @@ export declare function getNodeTypes(schema: Schema, types: string | NodeType |
 
 declare type GetStateFunction = () => EditorState | null | undefined;
 
-export declare type GroupedEntries<T extends Record<string, any>> = {
+export declare function groupBy<K extends PropertyKey, T>(items: Iterable<T>, keySelector: (item: T) => K): Partial<Record<K, T[]>>;
+
+export declare function groupEntries<T extends Record<string, any>>(entries: ObjectEntries<T>[]): {
     [K in keyof T]?: T[K][];
 };
 
-export declare function groupEntries<T extends Record<string, any>>(entries: ObjectEntries<T>[]): GroupedEntries<T>;
-
 declare type HeadingExtension = Extension<{
     Nodes: {
         heading: Attrs;
@@ -1429,6 +1529,8 @@ declare interface InsertNodeOptions {
 export { InsertNodeOptions }
 export { InsertNodeOptions as InsertNodeOptions_alias_1 }
 
+export declare function insertOutputSpecAttrs(dom: DOMOutputSpec, attrs: Array<[key: string, value: string]>): DOMOutputSpec;
+
 /**
  * Returns a command that inserts the given text.
  *
@@ -1446,7 +1548,9 @@ export declare type InsertTextOptions = {
 };
 
 /**
- * @internal
+ * Checks if the given object is a `AllSelection` instance.
+ *
+ * @public
  */
 declare function isAllSelection(sel: Selection_2): sel is AllSelection;
 export { isAllSelection }
@@ -1470,6 +1574,15 @@ export { isAtBlockStart as isAtBlockStart_alias_1 }
 
 export declare function isElement(el: unknown): el is Element;
 
+/**
+ * Checks if the given object is a `Fragment` instance.
+ *
+ * @public
+ */
+declare function isFragment(fragment: unknown): fragment is Fragment;
+export { isFragment }
+export { isFragment as isFragment_alias_1 }
+
 /**
  * Check if the selection is in a code block.
  *
@@ -1480,7 +1593,9 @@ export { isInCodeBlock }
 export { isInCodeBlock as isInCodeBlock_alias_1 }
 
 /**
- * @internal
+ * Checks if the given object is a `Mark` instance.
+ *
+ * @public
  */
 declare function isMark(mark: unknown): mark is Mark;
 export { isMark }
@@ -1507,30 +1622,46 @@ export { isMarkActive as isMarkActive_alias_1 }
 export declare function isNodeActive(state: EditorState, type: string | NodeType, attrs?: Attrs | null): boolean;
 
 /**
- * @internal
+ * Checks if the given object is a `NodeSelection` instance.
+ *
+ * @public
  */
 declare function isNodeSelection(sel: Selection_2): sel is NodeSelection;
 export { isNodeSelection }
 export { isNodeSelection as isNodeSelection_alias_1 }
 
-export declare function isNotNull<T>(value: T | null | undefined): value is T;
+/**
+ * @internal
+ */
+export declare function isNotNullish<T>(value: T | null | undefined | void): value is T;
 
 export declare function isObject(v: unknown): v is Record<string, unknown>;
 
 /**
- * @internal
+ * Checks if the given object is a `ProseMirrorNode` instance.
  */
 declare function isProseMirrorNode(node: unknown): node is ProseMirrorNode;
 export { isProseMirrorNode }
 export { isProseMirrorNode as isProseMirrorNode_alias_1 }
 
 /**
- * @internal
+ * Checks if the given object is a `Selection` instance.
+ *
+ * @public
  */
 declare function isSelection(sel: unknown): sel is Selection_2;
 export { isSelection }
 export { isSelection as isSelection_alias_1 }
 
+/**
+ * Checks if the given object is a `Slice` instance.
+ *
+ * @public
+ */
+declare function isSlice(slice: unknown): slice is Slice;
+export { isSlice }
+export { isSlice as isSlice_alias_1 }
+
 /**
  * Check if `subset` is a subset of `superset`.
  *
@@ -1539,7 +1670,9 @@ export { isSelection as isSelection_alias_1 }
 export declare function isSubset(subset: Record<string, unknown>, superset: Record<string, unknown>): boolean;
 
 /**
- * @internal
+ * Checks if the given object is a `TextSelection` instance.
+ *
+ * @public
  */
 declare function isTextSelection(sel: Selection_2): sel is TextSelection;
 export { isTextSelection }
@@ -1668,13 +1801,18 @@ declare interface MarkAttrOptions<MarkName extends string = string, AttrName ext
      */
     attr: AttrName;
     /**
-     * Returns the attribute key and value to be set on the DOM node.
+     * Returns the attribute key and value to be set on the HTML element.
+     *
+     * If the returned `key` is `"style"`, the value is a string of CSS properties and will
+     * be prepended to the existing `style` attribute on the DOM node.
+     *
+     * @param value - The value of the attribute of current ProseMirror node.
      */
-    toDOM?: (value: any) => [key: string, value: string] | null | void;
+    toDOM?: (value: AttrType) => [key: string, value: string] | null | undefined;
     /**
      * Parses the attribute value from the DOM.
      */
-    parseDOM?: (node: HTMLElement) => any;
+    parseDOM?: (node: HTMLElement) => AttrType;
 }
 export { MarkAttrOptions }
 export { MarkAttrOptions as MarkAttrOptions_alias_1 }
@@ -1720,6 +1858,12 @@ declare function maybeRun<T, R = T extends (...args: any[]) => void ? ReturnType
 export { maybeRun }
 export { maybeRun as maybeRun_alias_1 }
 
+export declare function mergeObjects<T extends object>(...objects: Array<Partial<T> | null | undefined>): Partial<T>;
+
+export declare function mergeSpecs(a: NodeSpec, b: NodeSpec): NodeSpec;
+
+export declare function mergeSpecs(a: MarkSpec, b: MarkSpec): MarkSpec;
+
 /**
  * A function that is called when the editor view is mounted.
  *
@@ -1774,16 +1918,18 @@ declare interface NodeAttrOptions<NodeName extends string = string, AttrName ext
      */
     splittable?: boolean;
     /**
-     * Returns the attribute key and value to be set on the DOM node.
+     * Returns the attribute key and value to be set on the HTML element.
      *
-     * If the `key` is `"style"`, the value is a string of CSS properties and will
+     * If the returned `key` is `"style"`, the value is a string of CSS properties and will
      * be prepended to the existing `style` attribute on the DOM node.
+     *
+     * @param value - The value of the attribute of current ProseMirror node.
      */
-    toDOM?: (value: any) => [key: string, value: string] | null | void;
+    toDOM?: (value: AttrType) => [key: string, value: string] | null | undefined;
     /**
      * Parses the attribute value from the DOM.
      */
-    parseDOM?: (node: HTMLElement) => any;
+    parseDOM?: (node: HTMLElement) => AttrType;
 }
 export { NodeAttrOptions }
 export { NodeAttrOptions as NodeAttrOptions_alias_1 }
@@ -1806,6 +1952,8 @@ export { NodeChild as NodeChild_alias_1 }
 
 /**
  * @public
+ *
+ * @deprecated
  */
 declare type NodeContent = ProseMirrorNode | ProseMirrorFragment | NodeContent[];
 export { NodeContent }
@@ -2082,13 +2230,16 @@ declare interface RemoveNodeOptions {
      */
     type: string | NodeType;
     /**
-     * The document position to start searching node. By default it will be the anchor position of current selection.
+     * The document position to start searching node. By default it will be the
+     * anchor position of current selection.
      */
     pos?: number;
 }
 export { RemoveNodeOptions }
 export { RemoveNodeOptions as RemoveNodeOptions_alias_1 }
 
+export declare function removeUndefinedValues<T extends object>(obj: T): T;
+
 export declare const rootFacet: Facet<RootPayload, RootOutput>;
 
 export declare type RootOutput = {
@@ -2383,9 +2534,11 @@ export declare type ToCommandCreators<T extends CommandTyping> = {
 /**
  * Returns a command that toggles the given mark with the given attributes.
  *
+ * @param options
+ *
  * @public
  */
-declare function toggleMark({ type, attrs }: ToggleMarkOptions): Command;
+declare function toggleMark({ type, attrs, removeWhenPresent, enterInlineAtoms, }: ToggleMarkOptions): Command;
 export { toggleMark }
 export { toggleMark as toggleMark_alias_1 }
 
@@ -2393,8 +2546,30 @@ export { toggleMark as toggleMark_alias_1 }
  * @public
  */
 declare interface ToggleMarkOptions {
+    /**
+     * The mark type to toggle.
+     */
     type: string | MarkType;
+    /**
+     * The optional attributes to set on the mark.
+     */
     attrs?: Attrs | null;
+    /**
+     * Controls whether, when part of the selected range has the mark
+     * already and part doesn't, the mark is removed (`true`) or added
+     * (`false`).
+     *
+     * @default false
+     */
+    removeWhenPresent?: boolean;
+    /**
+     * Whether the command should act on the content of inline nodes marked as
+     * [atoms](https://prosemirror.net/docs/ref/#model.NodeSpec.atom) that are
+     * completely covered by a selection range.
+     *
+     * @default true
+     */
+    enterInlineAtoms?: boolean;
 }
 export { ToggleMarkOptions }
 export { ToggleMarkOptions as ToggleMarkOptions_alias_1 }
@@ -2403,6 +2578,8 @@ export { ToggleMarkOptions as ToggleMarkOptions_alias_1 }
  * Returns a command that set the selected textblocks to the given node type
  * with the given attributes.
  *
+ * @param options
+ *
  * @public
  */
 declare function toggleNode({ type, attrs }: ToggleNodeOptions): Command;
@@ -2470,7 +2647,8 @@ export { Union }
 export { Union as Union_alias_1 }
 
 /**
- * Merge multiple extensions into one.
+ * Merges multiple extensions into one. You can pass multiple extensions as
+ * arguments or a single array containing multiple extensions.
  *
  * @throws If no extensions are provided.
  *
@@ -2478,6 +2656,17 @@ export { Union as Union_alias_1 }
  *
  * ```ts
  * function defineFancyNodes() {
+ *   return union(
+ *     defineFancyParagraph(),
+ *     defineFancyHeading(),
+ *   )
+ * }
+ * ```
+ *
+ * @example
+ *
+ * ```ts
+ * function defineFancyNodes() {
  *   return union([
  *     defineFancyParagraph(),
  *     defineFancyHeading(),
@@ -2633,12 +2822,13 @@ export { withSkipCodeBlock }
 export { withSkipCodeBlock as withSkipCodeBlock_alias_1 }
 
 /**
- * Returns a command that wraps the selected textblock with the given node type
- * with the given attributes.
+ * Returns a command that wraps the selected textblock with the given node type.
+ *
+ * @param options
  *
  * @public
  */
-declare function wrap({ nodeType, attrs }: WrapOptions): Command;
+declare function wrap(options: WrapOptions): Command;
 export { wrap }
 export { wrap as wrap_alias_1 }
 
@@ -2646,12 +2836,26 @@ export { wrap as wrap_alias_1 }
  * @public
  */
 declare interface WrapOptions {
-    nodeType: NodeType;
+    /**
+     * The node type to wrap the selected textblock with.
+     */
+    type: NodeType | string;
+    /**
+     * @deprecated Use `nodeSpec` instead.
+     */
+    nodeType?: NodeType;
+    /**
+     * Optional attributes to apply to the node.
+     */
     attrs?: Attrs | null;
 }
 export { WrapOptions }
 export { WrapOptions as WrapOptions_alias_1 }
 
+export declare function wrapOutputSpecAttrs<T extends ProseMirrorNode | Mark, Args extends readonly unknown[]>(toDOM: (node: T, ...args: Args) => DOMOutputSpec, options: AttrOptions[]): (node: T, ...args: Args) => DOMOutputSpec;
+
+export declare function wrapTagParseRuleAttrs(rule: TagParseRule, options: AttrOptions[]): TagParseRule;
+
 export declare function zip<T, P>(a: T[], b: P[]): [T, P][];
 
 export { }