@prosekit/core 0.7.1 → 0.7.3

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

@@ -1,6 +1,5 @@
 import { AllSelection } from '@prosekit/pm/state';
 import { Attrs } from '@prosekit/pm/model';
-import { Attrs as Attrs_2 } from 'prosemirror-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';
@@ -15,9 +14,7 @@ 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 { MarkType as MarkType_2 } from 'prosemirror-model';
-import { Node as Node_2 } from 'prosemirror-model';
-import type { Node as Node_3 } 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';
@@ -50,7 +47,14 @@ declare type Action = (options: {
  *
  * @public
  */
-declare function addMark(options: {
+declare function addMark(options: AddMarkOptions): Command;
+export { addMark }
+export { addMark as addMark_alias_1 }
+
+/**
+ * @public
+ */
+declare interface AddMarkOptions {
     /**
      * The type of the mark to add.
      */
@@ -67,9 +71,9 @@ declare function addMark(options: {
      * The end position of the document. By default it will be the end position of current selection.
      */
     to?: number;
-}): Command;
-export { addMark }
-export { addMark as addMark_alias_1 }
+}
+export { AddMarkOptions }
+export { AddMarkOptions as AddMarkOptions_alias_1 }
 
 export declare function applyAction(operator: Action): Command;
 
@@ -169,7 +173,7 @@ declare type ClickHandler = (view: EditorView, pos: number, event: MouseEvent) =
 export { ClickHandler }
 export { ClickHandler as ClickHandler_alias_1 }
 
-declare type ClickOnHandler = (view: EditorView, pos: number, node: Node_3, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
+declare type ClickOnHandler = (view: EditorView, pos: number, node: Node_2, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
 export { ClickOnHandler }
 export { ClickOnHandler as ClickOnHandler_alias_1 }
 
@@ -295,49 +299,16 @@ declare function defineBaseCommands(): Extension<{
             from?: number;
             to?: number;
         }];
-        insertNode: [options: {
-            node: Node_2;
-            pos?: number;
-            type?: undefined;
-            attrs?: undefined;
-        } | {
-            node?: undefined;
-            pos?: number;
-            type: string;
-            attrs?: Attrs_2;
-        }];
-        removeNode: [options: {
-            type: string | NodeType_2;
-            pos?: number;
-        }];
-        wrap: [{
-            nodeType: NodeType_2;
-            attrs?: Attrs_2 | null;
-        }];
-        setBlockType: [options: {
-            type: NodeType_2 | string;
-            attrs?: Attrs_2 | null;
-            from?: number;
-            to?: number;
-        }];
-        setNodeAttrs: [options: {
-            type: string | NodeType_2 | string[] | NodeType_2[];
-            attrs: Attrs_2;
-            pos?: number;
-        }];
+        insertNode: [options: InsertNodeOptions];
+        removeNode: [options: RemoveNodeOptions];
+        wrap: [WrapOptions];
+        setBlockType: [options: SetBlockTypeOptions];
+        setNodeAttrs: [options: SetNodeAttrsOptions];
         selectAll: [];
-        addMark: [options: {
-            type: string | MarkType_2;
-            attrs?: Attrs_2 | null;
-            from?: number;
-            to?: number;
-        }];
-        removeMark: [options: {
-            type: string | MarkType_2;
-            attrs?: Attrs_2 | null;
-            from?: number;
-            to?: number;
-        }];
+        addMark: [options: AddMarkOptions];
+        removeMark: [options: RemoveMarkOptions];
+        unsetBlockType: [options?: UnsetBlockTypeOptions | undefined];
+        unsetMark: [options?: UnsetMarkOptions | undefined];
     };
     Nodes: never;
     Marks: never;
@@ -494,13 +465,15 @@ export { defineFocusChangeHandler as defineFocusChangeHandler_alias_1 }
 
 /**
  * Add undo/redo history to the editor.
+ *
+ * @public
  */
-declare function defineHistory(): Extension<    {
+declare function defineHistory({ depth, newGroupDelay, }?: HistoryOptions): Extension<    {
 Nodes: never;
 Marks: never;
 Commands: {
-undo: [];
-redo: [];
+readonly undo: [];
+readonly redo: [];
 };
 }>;
 export { defineHistory }
@@ -657,61 +630,28 @@ export { defineScrollToSelectionHandler as defineScrollToSelectionHandler_alias_
 /**
  * @internal
  */
-export declare function defineTestExtension(): Extension<    {
-Nodes: "text" | "doc" | "paragraph";
-Marks: "bold";
-Commands: {
-undo: [];
-redo: [];
-insertText: [{
-text: string;
-from?: number;
-to?: number;
-}];
-insertNode: [options: {
-node: Node_2;
-pos?: number;
-type?: undefined;
-attrs?: undefined;
-} | {
-node?: undefined;
-pos?: number;
-type: string;
-attrs?: Attrs_2;
-}];
-removeNode: [options: {
-type: string | NodeType_2;
-pos?: number;
-}];
-wrap: [{
-nodeType: NodeType_2;
-attrs?: Attrs_2 | null;
-}];
-setBlockType: [options: {
-type: NodeType_2 | string;
-attrs?: Attrs_2 | null;
-from?: number;
-to?: number;
-}];
-setNodeAttrs: [options: {
-type: string | NodeType_2 | string[] | NodeType_2[];
-attrs: Attrs_2;
-pos?: number;
-}];
-selectAll: [];
-addMark: [options: {
-type: string | MarkType_2;
-attrs?: Attrs_2 | null;
-from?: number;
-to?: number;
-}];
-removeMark: [options: {
-type: string | MarkType_2;
-attrs?: Attrs_2 | null;
-from?: number;
-to?: number;
-}];
-};
+export declare function defineTestExtension(): Extension<{
+    Nodes: "text" | "doc" | "paragraph" | "heading";
+    Marks: "bold" | "italic";
+    Commands: {
+        insertText: [{
+            text: string;
+            from?: number;
+            to?: number;
+        }];
+        insertNode: [options: InsertNodeOptions];
+        removeNode: [options: RemoveNodeOptions];
+        wrap: [WrapOptions];
+        setBlockType: [options: SetBlockTypeOptions];
+        setNodeAttrs: [options: SetNodeAttrsOptions];
+        selectAll: [];
+        addMark: [options: AddMarkOptions];
+        removeMark: [options: RemoveMarkOptions];
+        unsetBlockType: [options?: UnsetBlockTypeOptions | undefined];
+        unsetMark: [options?: UnsetMarkOptions | undefined];
+        readonly undo: [];
+        readonly redo: [];
+    };
 }>;
 
 /**
@@ -838,7 +778,7 @@ declare type DoubleClickHandler = (view: EditorView, pos: number, event: MouseEv
 export { DoubleClickHandler }
 export { DoubleClickHandler as DoubleClickHandler_alias_1 }
 
-declare type DoubleClickOnHandler = (view: EditorView, pos: number, node: Node_3, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
+declare type DoubleClickOnHandler = (view: EditorView, pos: number, node: Node_2, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
 export { DoubleClickOnHandler }
 export { DoubleClickOnHandler as DoubleClickOnHandler_alias_1 }
 
@@ -1012,14 +952,21 @@ export { elementFromNode as elementFromNode_alias_1 }
  *
  * @public
  */
-declare function expandMark(options: {
+declare function expandMark(options: ExpandMarkOptions): Command;
+export { expandMark }
+export { expandMark as expandMark_alias_1 }
+
+/**
+ * @public
+ */
+declare interface ExpandMarkOptions {
     /**
      * The type of the mark to expand.
      */
     type: string | MarkType;
-}): Command;
-export { expandMark }
-export { expandMark as expandMark_alias_1 }
+}
+export { ExpandMarkOptions }
+export { ExpandMarkOptions as ExpandMarkOptions_alias_1 }
 
 /**
  * @public
@@ -1226,6 +1173,30 @@ export declare type GroupedEntries<T extends Record<string, any>> = {
 
 export declare function groupEntries<T extends Record<string, any>>(entries: ObjectEntries<T>[]): GroupedEntries<T>;
 
+/**
+ * Options for {@link defineHistory}.
+ *
+ * @public
+ */
+declare interface HistoryOptions {
+    /**
+     * The amount of history events that are collected before the oldest events
+     * are discarded.
+     *
+     * @default 200
+     */
+    depth?: number;
+    /**
+     * The delay in milliseconds between changes after which a new group should be
+     * started.
+     *
+     * @default 250
+     */
+    newGroupDelay?: number;
+}
+export { HistoryOptions }
+export { HistoryOptions as HistoryOptions_alias_1 }
+
 /**
  * @internal
  */
@@ -1255,17 +1226,7 @@ export { htmlFromNode as htmlFromNode_alias_1 }
  *
  * @public
  */
-declare function insertNode(options: {
-    node: ProseMirrorNode;
-    pos?: number;
-    type?: undefined;
-    attrs?: undefined;
-} | {
-    node?: undefined;
-    pos?: number;
-    type: string;
-    attrs?: Attrs;
-}): Command;
+declare function insertNode(options: InsertNodeOptions): Command;
 export { insertNode }
 export { insertNode as insertNode_alias_1 }
 
@@ -1274,6 +1235,31 @@ export declare function insertNodeAction({ node, pos, }: {
     pos?: number;
 }): Action;
 
+/**
+ * @public
+ */
+declare interface InsertNodeOptions {
+    /**
+     * The node to insert. Either this or `type` must be provided.
+     */
+    node?: ProseMirrorNode;
+    /**
+     * The type of the node to insert. Either this or `node` must be provided.
+     */
+    type?: string | NodeType;
+    /**
+     * When `type` is provided, the attributes of the node to insert.
+     */
+    attrs?: Attrs;
+    /**
+     * The position to insert the node at. By default it will be the anchor
+     * position of current selection.
+     */
+    pos?: number;
+}
+export { InsertNodeOptions }
+export { InsertNodeOptions as InsertNodeOptions_alias_1 }
+
 /**
  * Returns a command that inserts the given text.
  *
@@ -1299,6 +1285,15 @@ declare const isApple: boolean;
 export { isApple }
 export { isApple as isApple_alias_1 }
 
+/**
+ * Whether the selection is an empty text selection at the start of a block.
+ *
+ * @internal
+ */
+declare function isAtBlockStart(state: EditorState, view?: EditorView): ResolvedPos | null;
+export { isAtBlockStart }
+export { isAtBlockStart as isAtBlockStart_alias_1 }
+
 export declare function isElement(value: unknown): value is Element;
 
 /**
@@ -1734,7 +1729,14 @@ export { ProseKitError as ProseKitError_alias_1 }
  *
  * @public
  */
-declare function removeMark(options: {
+declare function removeMark(options: RemoveMarkOptions): Command;
+export { removeMark }
+export { removeMark as removeMark_alias_1 }
+
+/**
+ * @public
+ */
+declare interface RemoveMarkOptions {
     /**
      * The type of the mark to remove.
      */
@@ -1751,16 +1753,23 @@ declare function removeMark(options: {
      * The end position of the document. By default it will be the end position of current selection.
      */
     to?: number;
-}): Command;
-export { removeMark }
-export { removeMark as removeMark_alias_1 }
+}
+export { RemoveMarkOptions }
+export { RemoveMarkOptions as RemoveMarkOptions_alias_1 }
 
 /**
  * Returns a command to remove the nearest ancestor node of a specific type from the current position.
  *
  * @public
  */
-declare function removeNode(options: {
+declare function removeNode(options: RemoveNodeOptions): Command;
+export { removeNode }
+export { removeNode as removeNode_alias_1 }
+
+/**
+ * @public
+ */
+declare interface RemoveNodeOptions {
     /**
      * The type of the node to remove.
      */
@@ -1769,9 +1778,9 @@ declare function removeNode(options: {
      * The document position to start searching node. By default it will be the anchor position of current selection.
      */
     pos?: number;
-}): Command;
-export { removeNode }
-export { removeNode as removeNode_alias_1 }
+}
+export { RemoveNodeOptions }
+export { RemoveNodeOptions as RemoveNodeOptions_alias_1 }
 
 export declare const rootFacet: Facet<RootPayload, RootOutput>;
 
@@ -1825,21 +1834,35 @@ export { SelectionJSON as SelectionJSON_alias_1 }
  *
  * @public
  */
-declare function setBlockType(options: {
+declare function setBlockType(options: SetBlockTypeOptions): Command;
+export { setBlockType }
+export { setBlockType as setBlockType_alias_1 }
+
+/**
+ * @public
+ */
+declare interface SetBlockTypeOptions {
     type: NodeType | string;
     attrs?: Attrs | null;
     from?: number;
     to?: number;
-}): Command;
-export { setBlockType }
-export { setBlockType as setBlockType_alias_1 }
+}
+export { SetBlockTypeOptions }
+export { SetBlockTypeOptions as SetBlockTypeOptions_alias_1 }
 
 /**
  * Returns a command that set the attributes of the current node.
  *
  * @public
  */
-declare function setNodeAttrs(options: {
+declare function setNodeAttrs(options: SetNodeAttrsOptions): Command;
+export { setNodeAttrs }
+export { setNodeAttrs as setNodeAttrs_alias_1 }
+
+/**
+ * @public
+ */
+declare interface SetNodeAttrsOptions {
     /**
      * The type of node to set the attributes of.
      *
@@ -1855,9 +1878,9 @@ declare function setNodeAttrs(options: {
      * containing the current selection.
      */
     pos?: number;
-}): Command;
-export { setNodeAttrs }
-export { setNodeAttrs as setNodeAttrs_alias_1 }
+}
+export { SetNodeAttrsOptions }
+export { SetNodeAttrsOptions as SetNodeAttrsOptions_alias_1 }
 
 export declare function setSelectionAround(tr: Transaction, pos: number): void;
 
@@ -1871,6 +1894,46 @@ export declare type Setter<T> = (value: T) => void;
  */
 export declare function setupEditorExtension<E extends Extension>(options: EditorOptions<E>): E;
 
+/**
+ * @internal
+ */
+export declare function setupTest(): {
+    editor: TestEditor<Extension<{
+        Nodes: "text" | "doc" | "paragraph" | "heading";
+        Marks: "bold" | "italic";
+        Commands: {
+            insertText: [{
+                text: string;
+                from?: number;
+                to?: number;
+            }];
+            insertNode: [options: InsertNodeOptions];
+            removeNode: [options: RemoveNodeOptions];
+            wrap: [WrapOptions];
+            setBlockType: [options: SetBlockTypeOptions];
+            setNodeAttrs: [options: SetNodeAttrsOptions];
+            selectAll: [];
+            addMark: [options: AddMarkOptions];
+            removeMark: [options: RemoveMarkOptions];
+            unsetBlockType: [options?: UnsetBlockTypeOptions | undefined];
+            unsetMark: [options?: UnsetMarkOptions | undefined];
+            readonly undo: [];
+            readonly redo: [];
+        };
+    }>>;
+    n: Record<"text" | "doc" | "paragraph" | "heading", NodeBuilder>;
+    m: Record<"bold" | "italic", MarkBuilder>;
+};
+
+/**
+ * @internal
+ */
+export declare function setupTestFromExtension<E extends Extension>(extension: E): {
+    editor: TestEditor<E>;
+    n: Record<ExtractNodes<E>, NodeBuilder>;
+    m: Record<ExtractMarks<E>, MarkBuilder>;
+};
+
 /**
  * @internal
  */
@@ -1984,33 +2047,53 @@ export declare type ToCommandCreators<T extends CommandTyping> = {
  *
  * @public
  */
-declare function toggleMark({ type, attrs, }: {
-    type: string | MarkType;
-    attrs?: Attrs | null;
-}): Command;
+declare function toggleMark({ type, attrs }: ToggleMarkOptions): Command;
 export { toggleMark }
 export { toggleMark as toggleMark_alias_1 }
 
+/**
+ * @public
+ */
+declare interface ToggleMarkOptions {
+    type: string | MarkType;
+    attrs?: Attrs | null;
+}
+export { ToggleMarkOptions }
+export { ToggleMarkOptions as ToggleMarkOptions_alias_1 }
+
 /**
  * Returns a command that set the selected textblocks to the given node type
  * with the given attributes.
  *
  * @public
  */
-declare function toggleNode({ type, attrs, }: {
-    type: string | NodeType;
-    attrs?: Attrs | null;
-}): Command;
+declare function toggleNode({ type, attrs }: ToggleNodeOptions): Command;
 export { toggleNode }
 export { toggleNode as toggleNode_alias_1 }
 
+/**
+ * @public
+ */
+declare interface ToggleNodeOptions {
+    /**
+     * The type of the node to toggle.
+     */
+    type: string | NodeType;
+    /**
+     * The attributes of the node to toggle.
+     */
+    attrs?: Attrs | null;
+}
+export { ToggleNodeOptions }
+export { ToggleNodeOptions as ToggleNodeOptions_alias_1 }
+
 export declare function toReversed<T>(arr: T[]): T[];
 
 declare type TripleClickHandler = (view: EditorView, pos: number, event: MouseEvent) => boolean | void;
 export { TripleClickHandler }
 export { TripleClickHandler as TripleClickHandler_alias_1 }
 
-declare type TripleClickOnHandler = (view: EditorView, pos: number, node: Node_3, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
+declare type TripleClickOnHandler = (view: EditorView, pos: number, node: Node_2, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
 export { TripleClickOnHandler }
 export { TripleClickOnHandler as TripleClickOnHandler_alias_1 }
 
@@ -2087,6 +2170,57 @@ declare type UnmountHandler = () => void;
 export { UnmountHandler }
 export { UnmountHandler as UnmountHandler_alias_1 }
 
+/**
+ * Returns a command that set the type of all textblocks between the given range
+ * to the default type (usually `paragraph`).
+ *
+ * @public
+ */
+declare function unsetBlockType(options?: UnsetBlockTypeOptions): Command;
+export { unsetBlockType }
+export { unsetBlockType as unsetBlockType_alias_1 }
+
+/**
+ * @public
+ */
+declare interface UnsetBlockTypeOptions {
+    /**
+     * The start position of the document. By default it will be the start position of current selection.
+     */
+    from?: number;
+    /**
+     * The end position of the document. By default it will be the end position of current selection.
+     */
+    to?: number;
+}
+export { UnsetBlockTypeOptions }
+export { UnsetBlockTypeOptions as UnsetBlockTypeOptions_alias_1 }
+
+/**
+ * Returns a command that removes all marks.
+ *
+ * @public
+ */
+declare function unsetMark(options?: UnsetMarkOptions): Command;
+export { unsetMark }
+export { unsetMark as unsetMark_alias_1 }
+
+/**
+ * @public
+ */
+declare interface UnsetMarkOptions {
+    /**
+     * The start position of the document. By default it will be the start position of current selection.
+     */
+    from?: number;
+    /**
+     * The end position of the document. By default it will be the end position of current selection.
+     */
+    to?: number;
+}
+export { UnsetMarkOptions }
+export { UnsetMarkOptions as UnsetMarkOptions_alias_1 }
+
 /**
  * A function that is called when the editor state is updated.
  *
@@ -2134,10 +2268,19 @@ export { withSkipCodeBlock as withSkipCodeBlock_alias_1 }
  *
  * @public
  */
-export declare function wrap({ nodeType, attrs, }: {
+declare function wrap({ nodeType, attrs }: WrapOptions): Command;
+export { wrap }
+export { wrap as wrap_alias_1 }
+
+/**
+ * @public
+ */
+declare interface WrapOptions {
     nodeType: NodeType;
     attrs?: Attrs | null;
-}): Command;
+}
+export { WrapOptions }
+export { WrapOptions as WrapOptions_alias_1 }
 
 export declare function zip<T, P>(a: T[], b: P[]): [T, P][];