@prosekit/core 0.0.0-next-20240622120010 → 0.0.0-next-20240626133927

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

@@ -3,6 +3,7 @@ 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';
 import type { DirectEditorProps } from '@prosekit/pm/view';
 import type { DOMEventMap } from '@prosekit/pm/view';
 import { DOMParser as DOMParser_2 } from '@prosekit/pm/model';
@@ -71,6 +72,13 @@ export { addMark as addMark_alias_1 }
 
 export declare function applyAction(operator: Action): Command;
 
+export declare const applyMarkForTest: ApplyMarkFunction;
+
+/**
+ * @internal
+ */
+export declare type ApplyMarkFunction = (mark: Mark, children: ProseMirrorNode[]) => ProseMirrorNode[];
+
 /**
  * @internal
  */
@@ -148,6 +156,8 @@ export declare function baseToggleMark(markType: MarkType, attrs?: Attrs | null,
     removeWhenPresent: boolean;
 }): Command;
 
+export declare function buildNode(type: NodeType, args: [Attrs | NodeChild | null | undefined, ...NodeChild[]], createNode: CreateNodeFunction): ProseMirrorNode;
+
 export declare function cache<T>(fn: () => T): () => T;
 
 declare const canUseRegexLookbehind: () => boolean;
@@ -208,19 +218,35 @@ declare function createEditor<E extends Extension>(options: EditorOptions<E>): E
 export { createEditor }
 export { createEditor as createEditor_alias_1 }
 
-export declare function createMarkBuilder(getState: () => EditorState | null | undefined, type: MarkType): MarkBuilder;
+/**
+ * @internal
+ */
+export declare function createMarkBuilders(schema: Schema, getState: () => EditorState | null | undefined, applyMark?: ApplyMarkFunction): Record<string, MarkBuilder>;
+
+/**
+ * @internal
+ */
+export declare function createNodeBuilders(schema: Schema, getState: () => EditorState | null | undefined, createNode?: CreateNodeFunction): Record<string, NodeBuilder>;
+
+export declare const createNodeForTest: CreateNodeFunction;
 
-export declare function createNodeBuilder(getState: () => EditorState | null | undefined, type: NodeType): NodeBuilder;
+/**
+ * @internal
+ */
+export declare type CreateNodeFunction = (type: NodeType, attrs: Attrs | null, children: ProseMirrorNode[]) => ProseMirrorNode;
+
+/**
+ * @public
+ */
+declare function createTestEditor<E extends Extension>(options: EditorOptions<E>): TestEditor<E>;
+export { createTestEditor }
+export { createTestEditor as createTestEditor_alias_1 }
 
 export declare function deepEquals<T>(a: T, b: T): boolean;
 
 export declare const default_alias: Options | Options[] | ((overrideOptions: Options) => Options | Options[] | Promise<Options | Options[]>);
 
-export declare const default_alias_1: {
-    test: {
-        environment: "jsdom";
-    };
-};
+export { default_alias_1 }
 
 /**
  * @internal
@@ -323,7 +349,7 @@ declare function defineBaseKeymap(options?: {
      * @default Priority.low
      */
     priority?: Priority;
-}): Extension<any>;
+}): Extension<ExtensionTyping<any, any, any>>;
 export { defineBaseKeymap }
 export { defineBaseKeymap as defineBaseKeymap_alias_1 }
 
@@ -332,7 +358,7 @@ export { defineBaseKeymap as defineBaseKeymap_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleClick}
  */
-declare function defineClickHandler(handler: ClickHandler): Extension<any>;
+declare function defineClickHandler(handler: ClickHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineClickHandler }
 export { defineClickHandler as defineClickHandler_alias_1 }
 
@@ -341,7 +367,7 @@ export { defineClickHandler as defineClickHandler_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleClickOn}
  */
-declare function defineClickOnHandler(handler: ClickOnHandler): Extension<any>;
+declare function defineClickOnHandler(handler: ClickOnHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineClickOnHandler }
 export { defineClickOnHandler as defineClickOnHandler_alias_1 }
 
@@ -375,7 +401,7 @@ export { defineDoc as defineDoc_alias_1 }
  *
  * @public
  */
-declare function defineDocChangeHandler(handler: DocChangeHandler): Extension<any>;
+declare function defineDocChangeHandler(handler: DocChangeHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineDocChangeHandler }
 export { defineDocChangeHandler as defineDocChangeHandler_alias_1 }
 
@@ -384,7 +410,7 @@ export { defineDocChangeHandler as defineDocChangeHandler_alias_1 }
  *
  * @public
  */
-declare function defineDOMEventHandler<Event extends keyof DOMEventMap = string>(event: Event, handler: DOMEventHandler<Event>): Extension<any>;
+declare function defineDOMEventHandler<Event extends keyof DOMEventMap = string>(event: Event, handler: DOMEventHandler<Event>): Extension<ExtensionTyping<any, any, any>>;
 export { defineDOMEventHandler }
 export { defineDOMEventHandler as defineDOMEventHandler_alias_1 }
 
@@ -393,7 +419,7 @@ export { defineDOMEventHandler as defineDOMEventHandler_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleDoubleClick}
  */
-declare function defineDoubleClickHandler(handler: DoubleClickHandler): Extension<any>;
+declare function defineDoubleClickHandler(handler: DoubleClickHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineDoubleClickHandler }
 export { defineDoubleClickHandler as defineDoubleClickHandler_alias_1 }
 
@@ -402,7 +428,7 @@ export { defineDoubleClickHandler as defineDoubleClickHandler_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleDoubleClickOn}
  */
-declare function defineDoubleClickOnHandler(handler: DoubleClickOnHandler): Extension<any>;
+declare function defineDoubleClickOnHandler(handler: DoubleClickOnHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineDoubleClickOnHandler }
 export { defineDoubleClickOnHandler as defineDoubleClickOnHandler_alias_1 }
 
@@ -411,7 +437,7 @@ export { defineDoubleClickOnHandler as defineDoubleClickOnHandler_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleDrop}
  */
-declare function defineDropHandler(handler: DropHandler): Extension<any>;
+declare function defineDropHandler(handler: DropHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineDropHandler }
 export { defineDropHandler as defineDropHandler_alias_1 }
 
@@ -454,7 +480,7 @@ export { defineFacetPayload as defineFacetPayload_alias_1 }
  *
  * @public
  */
-declare function defineFocusChangeHandler(handler: FocusChangeHandler): Extension<any>;
+declare function defineFocusChangeHandler(handler: FocusChangeHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineFocusChangeHandler }
 export { defineFocusChangeHandler as defineFocusChangeHandler_alias_1 }
 
@@ -462,10 +488,11 @@ export { defineFocusChangeHandler as defineFocusChangeHandler_alias_1 }
  * Add undo/redo history to the editor.
  */
 declare function defineHistory(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: never;
+Marks: never;
 Commands: {
-[x: string]: any;
+undo: [];
+redo: [];
 };
 }>;
 export { defineHistory }
@@ -476,7 +503,7 @@ export { defineHistory as defineHistory_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleKeyDown}
  */
-declare function defineKeyDownHandler(handler: KeyDownHandler): Extension<any>;
+declare function defineKeyDownHandler(handler: KeyDownHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineKeyDownHandler }
 export { defineKeyDownHandler as defineKeyDownHandler_alias_1 }
 
@@ -492,7 +519,7 @@ export { defineKeymap as defineKeymap_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleKeyPress}
  */
-declare function defineKeyPressHandler(handler: KeyPressHandler): Extension<any>;
+declare function defineKeyPressHandler(handler: KeyPressHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineKeyPressHandler }
 export { defineKeyPressHandler as defineKeyPressHandler_alias_1 }
 
@@ -519,7 +546,7 @@ export { defineMarkSpec as defineMarkSpec_alias_1 }
  *
  * @public
  */
-declare function defineMountHandler(handler: MountHandler): Extension<any>;
+declare function defineMountHandler(handler: MountHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineMountHandler }
 export { defineMountHandler as defineMountHandler_alias_1 }
 
@@ -585,7 +612,7 @@ Commands: never;
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handlePaste}
  */
-declare function definePasteHandler(handler: PasteHandler): Extension<any>;
+declare function definePasteHandler(handler: PasteHandler): Extension<ExtensionTyping<any, any, any>>;
 export { definePasteHandler }
 export { definePasteHandler as definePasteHandler_alias_1 }
 
@@ -608,10 +635,70 @@ export { definePlugin as definePlugin_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleScrollToSelection}
  */
-declare function defineScrollToSelectionHandler(handler: ScrollToSelectionHandler): Extension<any>;
+declare function defineScrollToSelectionHandler(handler: ScrollToSelectionHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineScrollToSelectionHandler }
 export { defineScrollToSelectionHandler as defineScrollToSelectionHandler_alias_1 }
 
+/**
+ * @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;
+}];
+};
+}>;
+
 /**
  * @public
  */
@@ -628,7 +715,7 @@ export { defineText as defineText_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleTextInput}
  */
-declare function defineTextInputHandler(handler: TextInputHandler): Extension<any>;
+declare function defineTextInputHandler(handler: TextInputHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineTextInputHandler }
 export { defineTextInputHandler as defineTextInputHandler_alias_1 }
 
@@ -637,7 +724,7 @@ export { defineTextInputHandler as defineTextInputHandler_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleTripleClick}
  */
-declare function defineTripleClickHandler(handler: TripleClickHandler): Extension<any>;
+declare function defineTripleClickHandler(handler: TripleClickHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineTripleClickHandler }
 export { defineTripleClickHandler as defineTripleClickHandler_alias_1 }
 
@@ -646,7 +733,7 @@ export { defineTripleClickHandler as defineTripleClickHandler_alias_1 }
  *
  * See {@link https://prosemirror.net/docs/ref/#view.EditorProps.handleTripleClickOn}
  */
-declare function defineTripleClickOnHandler(handler: TripleClickOnHandler): Extension<any>;
+declare function defineTripleClickOnHandler(handler: TripleClickOnHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineTripleClickOnHandler }
 export { defineTripleClickOnHandler as defineTripleClickOnHandler_alias_1 }
 
@@ -655,7 +742,7 @@ export { defineTripleClickOnHandler as defineTripleClickOnHandler_alias_1 }
  *
  * @public
  */
-declare function defineUnmountHandler(handler: UnmountHandler): Extension<any>;
+declare function defineUnmountHandler(handler: UnmountHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineUnmountHandler }
 export { defineUnmountHandler as defineUnmountHandler_alias_1 }
 
@@ -664,7 +751,7 @@ export { defineUnmountHandler as defineUnmountHandler_alias_1 }
  *
  * @public
  */
-declare function defineUpdateHandler(handler: UpdateHandler): Extension<any>;
+declare function defineUpdateHandler(handler: UpdateHandler): Extension<ExtensionTyping<any, any, any>>;
 export { defineUpdateHandler }
 export { defineUpdateHandler as defineUpdateHandler_alias_1 }
 
@@ -749,8 +836,11 @@ export { DropHandler as DropHandler_alias_1 }
  */
 declare class Editor<E extends Extension = any> {
     private instance;
-    private constructor();
     private afterMounted;
+    /**
+     * @internal
+     */
+    constructor(instance: EditorInstance);
     /**
      * @internal
      */
@@ -767,6 +857,9 @@ declare class Editor<E extends Extension = any> {
      * The editor schema.
      */
     get schema(): Schema<ExtractNodes<E>, ExtractMarks<E>>;
+    /**
+     * All commands defined by the editor.
+     */
     get commands(): ExtractCommandAppliers<E>;
     /**
      * Whether the editor is focused.
@@ -789,14 +882,55 @@ declare class Editor<E extends Extension = any> {
      * Blur the editor.
      */
     blur(): void;
+    /**
+     * Register an extension to the editor. Return a function to unregister the
+     * extension.
+     */
     use(extension: Extension): VoidFunction;
+    /**
+     * The editor's current state.
+     */
     get state(): EditorState;
+    /**
+     * Update the editor's state.
+     *
+     * @remarks
+     *
+     * This is an advanced method. Use it only if you have a specific reason to
+     * directly manipulate the editor's state.
+     */
+    updateState(state: EditorState): void;
     get nodes(): Record<ExtractNodes<E>, NodeBuilder>;
     get marks(): Record<ExtractMarks<E>, MarkBuilder>;
 }
 export { Editor }
 export { Editor as Editor_alias_1 }
 
+/**
+ * @internal
+ */
+export declare class EditorInstance {
+    view: EditorView | null;
+    schema: Schema;
+    nodeBuilders: Record<string, NodeBuilder>;
+    markBuilders: Record<string, MarkBuilder>;
+    commandAppliers: Record<string, CommandApplier>;
+    private tree;
+    private directEditorProps;
+    constructor(extension: Extension);
+    getState: () => EditorState;
+    updateState(state: EditorState): void;
+    updateExtension(extension: Extension, add: boolean): void;
+    mount(place: HTMLElement): void;
+    unmount(): void;
+    get mounted(): boolean;
+    get assertView(): EditorView;
+    definePlugins(plugins: readonly Plugin_2[]): void;
+    removePlugins(plugins: readonly Plugin_2[]): void;
+    defineCommand<Args extends any[] = any[]>(name: string, commandCreator: CommandCreator<Args>): void;
+    removeCommand(name: string): void;
+}
+
 /**
  * @internal
  */
@@ -875,7 +1009,7 @@ export { expandMark as expandMark_alias_1 }
 /**
  * @public
  */
-declare interface Extension<T extends ExtensionTyping<any, any, any> = any> {
+declare interface Extension<T extends ExtensionTyping<any, any, any> = ExtensionTyping<any, any, any>> {
     extension: Extension | Extension[];
     priority?: Priority;
     _type?: T;
@@ -933,10 +1067,12 @@ declare type ExtractNodes<E extends Extension> = ExtractTyping<E>['Nodes'];
 export { ExtractNodes }
 export { ExtractNodes as ExtractNodes_alias_1 }
 
+export declare function extractTags(node: TaggedProseMirrorNode): Record<string, number>;
+
 /**
  * @internal
  */
-export declare type ExtractTyping<E extends Extension> = E extends Extension<infer T> ? T : never;
+export declare type ExtractTyping<E extends Extension> = E extends Extension<ExtensionTyping<infer N, infer M, infer C>> ? ExtensionTyping<PickStringLiteral<N>, PickStringLiteral<M>, PickKnownCommandTyping<C>> : never;
 
 /**
  * @internal
@@ -1310,11 +1446,16 @@ declare interface MarkAttrOptions {
 export { MarkAttrOptions }
 export { MarkAttrOptions as MarkAttrOptions_alias_1 }
 
-export declare interface MarkBuilder {
+/**
+ * @public
+ */
+declare interface MarkBuilder {
     (attrs: Attrs | null, ...children: NodeChild[]): ProseMirrorNode[];
     (...children: NodeChild[]): ProseMirrorNode[];
-    isActive(attrs?: Attrs): boolean;
+    isActive: (attrs?: Attrs) => boolean;
 }
+export { MarkBuilder }
+export { MarkBuilder as MarkBuilder_alias_1 }
 
 /**
  * @public
@@ -1384,12 +1525,20 @@ declare interface NodeAttrOptions {
 export { NodeAttrOptions }
 export { NodeAttrOptions as NodeAttrOptions_alias_1 }
 
-export declare interface NodeBuilder {
+/**
+ * @public
+ */
+declare interface NodeBuilder {
     (attrs: Attrs | null, ...children: NodeChild[]): ProseMirrorNode;
     (...children: NodeChild[]): ProseMirrorNode;
-    isActive(attrs?: Attrs): boolean;
+    isActive: (attrs?: Attrs) => boolean;
 }
+export { NodeBuilder }
+export { NodeBuilder as NodeBuilder_alias_1 }
 
+/**
+ * @public
+ */
 export declare type NodeChild = ProseMirrorNode | string | NodeChild[];
 
 export declare type NodeContent = ProseMirrorNode | ProseMirrorFragment | NodeContent[];
@@ -1501,6 +1650,18 @@ export { PasteHandler as PasteHandler_alias_1 }
  */
 export declare type Payloads<T> = Tuple5<T[]>;
 
+/**
+ * @internal
+ */
+export declare type PickKnownCommandTyping<T extends CommandTyping> = [
+CommandTyping
+] extends [T] ? never : T;
+
+/**
+ * @internal
+ */
+export declare type PickStringLiteral<T extends string> = [string] extends [T] ? never : T;
+
 /**
  * @internal
  */
@@ -1679,6 +1840,11 @@ export declare function setSelectionAround(tr: Transaction, pos: number): void;
  */
 export declare type Setter<T> = (value: T) => void;
 
+/**
+ * @internal
+ */
+export declare function setupEditorExtension<E extends Extension>(options: EditorOptions<E>): E;
+
 /**
  * @internal
  */
@@ -1729,6 +1895,37 @@ export declare type StatePayload = (ctx: {
  */
 export declare function subtractFacetNode<I, O>(a: FacetNode<I, O>, b: FacetNode<I, O>): FacetNode<I, O>;
 
+export declare type TaggedProseMirrorNode = ProseMirrorNode & {
+    tags?: Tags;
+};
+
+declare type Tags = Record<string, number>;
+
+/**
+ * An editor for testing purposes.
+ * @public
+ */
+declare class TestEditor<E extends Extension = Extension> extends Editor<E> {
+    constructor(instance: EditorInstance);
+    /**
+     * Set the editor state to the given document. You can use special tokens
+     * `<a>` and `<b>` to set the anchor and head positions of the selection.
+     *
+     * @example
+     *
+     * ```ts
+     * const editor = createTestEditor({ extension })
+     * const n = editor.nodes
+     * const doc = n.doc(n.paragraph('<a>Hello<b> world!'))
+     * editor.set(doc) // "Hello" is selected.
+     * ```
+     */
+    set(doc: ProseMirrorNode): void;
+    dispatchEvent(event: Event): void;
+}
+export { TestEditor }
+export { TestEditor as TestEditor_alias_1 }
+
 declare type TextInputHandler = (view: EditorView, from: number, to: number, text: string) => boolean | void;
 export { TextInputHandler }
 export { TextInputHandler as TextInputHandler_alias_1 }
@@ -1788,14 +1985,14 @@ export declare type Tuple5<T> = [T, T, T, T, T];
  *
  * @public
  */
-declare function union<E extends Extension | Extension[]>(extension: E): UnionExtension<E>;
+declare function union<const E extends Extension | readonly Extension[]>(extension: E): UnionExtension<E>;
 export { union }
 export { union as union_alias_1 }
 
 /**
  * @internal
  */
-declare type UnionExtension<E extends Extension | Extension[]> = E extends Extension[] ? Extension<{
+declare type UnionExtension<E extends Extension | readonly Extension[]> = E extends readonly Extension[] ? Extension<{
     Nodes: ExtractNodes<E[number]>;
     Marks: ExtractMarks<E[number]>;
     Commands: ExtractCommands<E[number]>;