@prosekit/extensions 0.0.0-next-20240621205958 → 0.0.0-next-20240626133927

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

@@ -1,4 +1,5 @@
 import { Attrs } from '@prosekit/pm/model';
+import { Attrs as Attrs_2 } from 'prosemirror-model';
 import { BundledLanguage } from 'shiki';
 import { BundledLanguageInfo } from 'shiki';
 import { bundledLanguagesInfo } from 'shiki';
@@ -7,23 +8,33 @@ import { BundledThemeInfo } from 'shiki';
 import { bundledThemesInfo } from 'shiki';
 import { Command } from '@prosekit/pm/state';
 import { DedentListOptions } from 'prosemirror-flat-list';
+import { config as default_alias_1 } from '@prosekit/dev/config-vitest';
 import { EditorState } from '@prosekit/pm/state';
 import { Extension } from '@prosekit/core';
+import { ExtensionTyping } from '@prosekit/core';
+import { ExtractMarks } from '@prosekit/core';
+import { ExtractNodes } from '@prosekit/core';
 import { getSingletonHighlighter } from 'shiki/bundle/full';
 import type { Highlighter } from 'shiki';
 import { IndentListOptions } from 'prosemirror-flat-list';
 import { InputRule } from '@prosekit/pm/inputrules';
 import { ListAttributes } from 'prosemirror-flat-list';
 import { ListDOMSerializer } from 'prosemirror-flat-list';
+import { MarkBuilder } from '@prosekit/core';
 import { MarkType } from '@prosekit/pm/model';
+import { MarkType as MarkType_2 } from 'prosemirror-model';
+import { Node as Node_2 } from 'prosemirror-model';
+import { NodeBuilder } from '@prosekit/core';
 import { NodeRange } from 'prosemirror-model';
 import { NodeType } from '@prosekit/pm/model';
+import { NodeType as NodeType_2 } from 'prosemirror-model';
 import { Options } from 'tsup';
 import { Parser } from 'prosemirror-highlight';
 import { Plugin as Plugin_2 } from '@prosekit/pm/state';
 import { PluginKey } from '@prosekit/pm/state';
 import { ProseMirrorNode } from '@prosekit/pm/model';
 import type { SpecialLanguage } from 'shiki';
+import { TestEditor } from '@prosekit/core/test';
 import { ToggleCollapsedOptions } from 'prosemirror-flat-list';
 import { Transaction } from '@prosekit/pm/state';
 import { UnwrapListOptions } from 'prosemirror-flat-list';
@@ -125,11 +136,7 @@ export declare function createMarkInputRule({ regex, type, attrs, }: MarkInputRu
 
 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 }
 
 export declare function defaultCanMatch({ state }: {
     state: EditorState;
@@ -141,18 +148,16 @@ export declare function defineAutocomplete(rule: AutocompleteRule): Extension;
  * @public
  */
 export declare function defineBlockquote(): Extension<    {
-Nodes: any;
-Marks: any;
-Commands: {
-[x: string]: any;
-};
+Nodes: "blockquote";
+Marks: never;
+Commands: never;
 }>;
 
 /**
  * Wraps the text block in a blockquote when `>` is typed at the start of a new
  * line followed by a space.
  */
-export declare function defineBlockquoteInputRule(): Extension<any>;
+export declare function defineBlockquoteInputRule(): Extension<ExtensionTyping<any, any, any>>;
 
 export declare function defineBlockquoteSpec(): Extension<    {
 Nodes: "blockquote";
@@ -164,10 +169,10 @@ Commands: never;
  * @public
  */
 export declare function defineBold(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: never;
+Marks: "bold";
 Commands: {
-[x: string]: any;
+toggleBold: [];
 };
 }>;
 
@@ -179,9 +184,9 @@ Nodes: never;
 Marks: never;
 }>;
 
-export declare function defineBoldInputRule(): Extension<any>;
+export declare function defineBoldInputRule(): Extension<ExtensionTyping<any, any, any>>;
 
-export declare function defineBoldKeymap(): Extension<any>;
+export declare function defineBoldKeymap(): Extension<ExtensionTyping<any, any, any>>;
 
 export declare function defineBoldSpec(): Extension<    {
 Marks: "bold";
@@ -193,10 +198,10 @@ Commands: never;
  * @public
  */
 export declare function defineCode(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: never;
+Marks: "code";
 Commands: {
-[x: string]: any;
+toggleCode: [];
 };
 }>;
 
@@ -212,10 +217,13 @@ Commands: {
  * @public
  */
 declare function defineCodeBlock(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: "codeBlock";
+Marks: never;
 Commands: {
-[x: string]: any;
+setCodeBlock: [attrs?: CodeBlockAttrs | undefined];
+insertCodeBlock: [attrs?: CodeBlockAttrs | undefined];
+toggleCodeBlock: [attrs?: CodeBlockAttrs | undefined];
+setCodeBlockAttrs: [attrs: CodeBlockAttrs];
 };
 }>;
 export { defineCodeBlock }
@@ -244,7 +252,7 @@ export { defineCodeBlockCommands as defineCodeBlockCommands_alias_1 }
  *
  * @public
  */
-declare function defineCodeBlockEnterRule(): Extension<any>;
+declare function defineCodeBlockEnterRule(): Extension<ExtensionTyping<any, any, any>>;
 export { defineCodeBlockEnterRule }
 export { defineCodeBlockEnterRule as defineCodeBlockEnterRule_alias_1 }
 
@@ -267,14 +275,14 @@ export { defineCodeBlockHighlight as defineCodeBlockHighlight_alias_1 }
  *
  * @public
  */
-declare function defineCodeBlockInputRule(): Extension<any>;
+declare function defineCodeBlockInputRule(): Extension<ExtensionTyping<any, any, any>>;
 export { defineCodeBlockInputRule }
 export { defineCodeBlockInputRule as defineCodeBlockInputRule_alias_1 }
 
 /**
  * Defines the keymap for code blocks.
  */
-export declare function defineCodeBlockKeymap(): Extension<any>;
+export declare function defineCodeBlockKeymap(): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * Adds syntax highlighting to code blocks using the [shiki](https://github.com/shikijs/shiki) package.
@@ -306,9 +314,9 @@ Nodes: never;
 Marks: never;
 }>;
 
-export declare function defineCodeInputRule(): Extension<any>;
+export declare function defineCodeInputRule(): Extension<ExtensionTyping<any, any, any>>;
 
-export declare function defineCodeKeymap(): Extension<any>;
+export declare function defineCodeKeymap(): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * @public
@@ -326,7 +334,7 @@ Commands: never;
  *
  * @public
  */
-export declare function defineDropCursor(options?: DropCursorOptions): Extension<any>;
+export declare function defineDropCursor(options?: DropCursorOptions): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * Defines an enter rule. An enter rule applies when the text directly in front of
@@ -341,10 +349,12 @@ export declare function defineEnterRule({ regex, handler, stop, }: EnterRuleOpti
  * @public
  */
 export declare function defineHeading(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: "heading";
+Marks: never;
 Commands: {
-[x: string]: any;
+setHeading: [attrs?: HeadingAttrs | undefined];
+insertHeading: [attrs?: HeadingAttrs | undefined];
+toggleHeading: [attrs?: HeadingAttrs | undefined];
 };
 }>;
 
@@ -362,9 +372,9 @@ Marks: never;
  * Converts the text block to a heading when `#` is typed at the start of a new
  * line followed by a space.
  */
-export declare function defineHeadingInputRule(): Extension<any>;
+export declare function defineHeadingInputRule(): Extension<ExtensionTyping<any, any, any>>;
 
-export declare function defineHeadingKeymap(): Extension<any>;
+export declare function defineHeadingKeymap(): Extension<ExtensionTyping<any, any, any>>;
 
 export declare function defineHeadingSpec(): Extension<    {
 Nodes: "heading";
@@ -410,10 +420,10 @@ export declare function defineInputRule(rule: InputRule): Extension;
  * @public
  */
 export declare function defineItalic(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: never;
+Marks: "italic";
 Commands: {
-[x: string]: any;
+toggleItalic: [];
 };
 }>;
 
@@ -425,9 +435,9 @@ Nodes: never;
 Marks: never;
 }>;
 
-export declare function defineItalicInputRule(): Extension<any>;
+export declare function defineItalicInputRule(): Extension<ExtensionTyping<any, any, any>>;
 
-export declare function defineItalicKeymap(): Extension<any>;
+export declare function defineItalicKeymap(): Extension<ExtensionTyping<any, any, any>>;
 
 export declare function defineItalicSpec(): Extension<    {
 Marks: "italic";
@@ -439,10 +449,13 @@ Commands: never;
  * @public
  */
 export declare function defineLink(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: never;
+Marks: "link";
 Commands: {
-[x: string]: any;
+addLink: [attrs: LinkAttrs];
+removeLink: [];
+toggleLink: [attrs: LinkAttrs];
+expandLink: [];
 };
 }>;
 
@@ -460,17 +473,17 @@ Marks: never;
 /**
  * Apply link marks after typing Enter.
  */
-export declare function defineLinkEnterRule(): Extension<any>;
+export declare function defineLinkEnterRule(): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * Apply link marks after pressing Space.
  */
-export declare function defineLinkInputRule(): Extension<any>;
+export declare function defineLinkInputRule(): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * Apply and remove link marks to the text during typing.
  */
-export declare function defineLinkMarkRule(): Extension<any>;
+export declare function defineLinkMarkRule(): Extension<ExtensionTyping<any, any, any>>;
 
 export declare function defineLinkSpec(): Extension<    {
 Marks: "link";
@@ -482,10 +495,18 @@ Commands: never;
  * @public
  */
 export declare function defineList(): Extension<{
-    Nodes: any;
-    Marks: any;
+    Nodes: "list";
+    Marks: never;
     Commands: {
-        [x: string]: any;
+        dedentList: [options?: DedentListOptions | undefined];
+        indentList: [options?: IndentListOptions | undefined];
+        moveList: [direction: "up" | "down"];
+        splitList: [];
+        toggleCollapsed: [(ToggleCollapsedOptions | undefined)?];
+        toggleList: [attrs: ListAttributes];
+        unwrapList: [options?: UnwrapListOptions | undefined];
+        wrapInList: [getAttrs: ListAttributes | ((range: NodeRange) => ListAttributes | null)];
+        insertList: [attrs?: ListAttributes | undefined];
     };
 }>;
 
@@ -512,9 +533,9 @@ export declare function defineListInputRules(): Extension;
  *
  * @public
  */
-export declare function defineListKeymap(): Extension<any>;
+export declare function defineListKeymap(): Extension<ExtensionTyping<any, any, any>>;
 
-export declare function defineListPlugins(): Extension<any>;
+export declare function defineListPlugins(): Extension<ExtensionTyping<any, any, any>>;
 
 export declare function defineListSpec(): Extension<{
     Nodes: "list";
@@ -534,7 +555,7 @@ export declare function defineMarkInputRule(options: MarkInputRuleOptions): Exte
  * A mark rule is something that can automatically apply marks to text if it
  * matches a certain pattern, and remove them if it doesn't match anymore.
  */
-declare function defineMarkRule(options: MarkRuleOptions): Extension<any>;
+declare function defineMarkRule(options: MarkRuleOptions): Extension<ExtensionTyping<any, any, any>>;
 export { defineMarkRule }
 export { defineMarkRule as defineMarkRule_alias_1 }
 
@@ -578,12 +599,12 @@ export declare function defineModClickPrevention(): Extension;
  * Add a placeholder text to the editor when the current block or document is
  * empty.
  */
-export declare function definePlaceholder(options: PlaceholderOptions): Extension<any>;
+export declare function definePlaceholder(options: PlaceholderOptions): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * Make the editor read-only.
  */
-export declare function defineReadonly(): Extension<any>;
+export declare function defineReadonly(): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * Defines commands for search and replace.
@@ -610,16 +631,16 @@ Marks: never;
  *
  * @public
  */
-export declare function defineSearchQuery(options: SearchQueryOptions): Extension<any>;
+export declare function defineSearchQuery(options: SearchQueryOptions): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * @public
  */
 export declare function defineStrike(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: never;
+Marks: "strike";
 Commands: {
-[x: string]: any;
+toggleStrike: [];
 };
 }>;
 
@@ -631,9 +652,9 @@ Nodes: never;
 Marks: never;
 }>;
 
-export declare function defineStrikeInputRule(): Extension<any>;
+export declare function defineStrikeInputRule(): Extension<ExtensionTyping<any, any, any>>;
 
-export declare function defineStrikeKeymap(): Extension<any>;
+export declare function defineStrikeKeymap(): Extension<ExtensionTyping<any, any, any>>;
 
 export declare function defineStrikeSpec(): Extension<    {
 Marks: "strike";
@@ -645,10 +666,15 @@ Commands: never;
  * @public
  */
 export declare function defineTable(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: "table" | "tableRow" | "tableCell" | "tableHeaderCell";
+Marks: never;
 Commands: {
-[x: string]: any;
+insertTable: [{
+row: number;
+col: number;
+header: boolean;
+}];
+exitTable: [];
 };
 }>;
 
@@ -691,7 +717,7 @@ export { defineTableHeaderCellSpec as defineTableHeaderCellSpec_alias_1 }
 /**
  * @public
  */
-declare function defineTablePlugins(): Extension<any>;
+declare function defineTablePlugins(): Extension<ExtensionTyping<any, any, any>>;
 export { defineTablePlugins }
 export { defineTablePlugins as defineTablePlugins_alias_1 }
 
@@ -711,6 +737,94 @@ Commands: never;
 export { defineTableSpec }
 export { defineTableSpec as defineTableSpec_alias_1 }
 
+/**
+ * @internal
+ */
+export declare function defineTestExtension(): Extension<{
+    Nodes: "blockquote" | "table" | "text" | "doc" | "paragraph" | "heading" | "image" | "list" | "tableRow" | "tableCell" | "tableHeaderCell";
+    Marks: "code" | "link" | "bold" | "strike" | "italic" | "underline";
+    Commands: {
+        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;
+        }];
+        toggleItalic: [];
+        undo: [];
+        redo: [];
+        toggleBold: [];
+        toggleCode: [];
+        setHeading: [attrs?: HeadingAttrs | undefined];
+        insertHeading: [attrs?: HeadingAttrs | undefined];
+        toggleHeading: [attrs?: HeadingAttrs | undefined];
+        insertImage: [attrs?: ImageAttrs | undefined];
+        addLink: [attrs: LinkAttrs];
+        removeLink: [];
+        toggleLink: [attrs: LinkAttrs];
+        expandLink: [];
+        dedentList: [options?: DedentListOptions | undefined];
+        indentList: [options?: IndentListOptions | undefined];
+        moveList: [direction: "up" | "down"];
+        splitList: [];
+        toggleCollapsed: [(ToggleCollapsedOptions | undefined)?];
+        toggleList: [attrs: ListAttributes];
+        unwrapList: [options?: UnwrapListOptions | undefined];
+        wrapInList: [getAttrs: ListAttributes | ((range: NodeRange) => ListAttributes | null)];
+        insertList: [attrs?: ListAttributes | undefined];
+        toggleStrike: [];
+        insertTable: [{
+            row: number;
+            col: number;
+            header: boolean;
+        }];
+        exitTable: [];
+        toggleUnderline: [];
+    };
+}>;
+
 /**
  * Adds a `textAlign` attribute to the specified nodes. This will be rendered as
  * a CSS `text-align` style.
@@ -718,10 +832,10 @@ export { defineTableSpec as defineTableSpec_alias_1 }
  * @public
  */
 export declare function defineTextAlign(options: TextAlignOptions): Extension<{
-    Nodes: any;
-    Marks: any;
+    Nodes: never;
+    Marks: never;
     Commands: {
-        [x: string]: any;
+        setTextAlign: [value: string | null];
     };
 }>;
 
@@ -739,7 +853,7 @@ export declare function defineTextAlignCommands(types: string[]): Extension<{
 /**
  * @internal
  */
-export declare function defineTextAlignKeymap(types: string[]): Extension<any>;
+export declare function defineTextAlignKeymap(types: string[]): Extension<ExtensionTyping<any, any, any>>;
 
 /**
  * Defines an enter rule that replaces the matched text with a block node.
@@ -779,10 +893,10 @@ export declare function defineTextBlockInputRule({ regex, type, attrs, }: {
  * @public
  */
 export declare function defineUnderline(): Extension<    {
-Nodes: any;
-Marks: any;
+Nodes: never;
+Marks: "underline";
 Commands: {
-[x: string]: any;
+toggleUnderline: [];
 };
 }>;
 
@@ -794,7 +908,7 @@ Nodes: never;
 Marks: never;
 }>;
 
-export declare function defineUnderlineKeymap(): Extension<any>;
+export declare function defineUnderlineKeymap(): Extension<ExtensionTyping<any, any, any>>;
 
 export declare function defineUnderlineSpec(): Extension<    {
 Marks: "underline";
@@ -1132,6 +1246,107 @@ export declare function setTextAlign({ types, value, }: {
 
 export declare function setTrMeta(tr: Transaction, meta: PredictionPluginState): Transaction;
 
+/**
+ * @internal
+ */
+export declare function setupDefaultTest(): {
+    editor: TestEditor<Extension<{
+        Nodes: "blockquote" | "table" | "text" | "doc" | "paragraph" | "heading" | "image" | "list" | "tableRow" | "tableCell" | "tableHeaderCell";
+        Marks: "code" | "link" | "bold" | "strike" | "italic" | "underline";
+        Commands: {
+            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;
+            }];
+            toggleItalic: [];
+            undo: [];
+            redo: [];
+            toggleBold: [];
+            toggleCode: [];
+            setHeading: [attrs?: HeadingAttrs | undefined];
+            insertHeading: [attrs?: HeadingAttrs | undefined];
+            toggleHeading: [attrs?: HeadingAttrs | undefined];
+            insertImage: [attrs?: ImageAttrs | undefined];
+            addLink: [attrs: LinkAttrs];
+            removeLink: [];
+            toggleLink: [attrs: LinkAttrs];
+            expandLink: [];
+            dedentList: [options?: DedentListOptions | undefined];
+            indentList: [options?: IndentListOptions | undefined];
+            moveList: [direction: "up" | "down"];
+            splitList: [];
+            toggleCollapsed: [(ToggleCollapsedOptions | undefined)?];
+            toggleList: [attrs: ListAttributes];
+            unwrapList: [options?: UnwrapListOptions | undefined];
+            wrapInList: [getAttrs: ListAttributes | ((range: NodeRange) => ListAttributes | null)];
+            insertList: [attrs?: ListAttributes | undefined];
+            toggleStrike: [];
+            insertTable: [{
+                row: number;
+                col: number;
+                header: boolean;
+            }];
+            exitTable: [];
+            toggleUnderline: [];
+        };
+    }>>;
+    n: Record<"blockquote" | "table" | "text" | "doc" | "paragraph" | "heading" | "image" | "list" | "tableRow" | "tableCell" | "tableHeaderCell", NodeBuilder>;
+    m: Record<"code" | "link" | "bold" | "strike" | "italic" | "underline", MarkBuilder>;
+};
+
+/**
+ * @internal
+ */
+export declare function setupTest<E extends Extension>(extension: E): {
+    editor: TestEditor<E>;
+    n: Record<ExtractNodes<E>, NodeBuilder>;
+    m: Record<ExtractMarks<E>, MarkBuilder>;
+};
+
 export declare interface TextAlignOptions {
     /**
      * The names of node to add the attribute to.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/extensions",
   "type": "module",
-  "version": "0.0.0-next-20240621205958",
+  "version": "0.0.0-next-20240626133927",
   "private": false,
   "author": {
     "name": "ocavue",
@@ -176,13 +176,14 @@
     "prosemirror-search": "^0.1.0",
     "prosemirror-tables": "^1.3.7",
     "shiki": "^1.9.0",
-    "@prosekit/core": "^0.0.0-next-20240621205958",
-    "@prosekit/pm": "^0.0.0-next-20240621205958"
+    "@prosekit/pm": "^0.0.0-next-20240626133927",
+    "@prosekit/core": "^0.0.0-next-20240626133927"
   },
   "devDependencies": {
+    "@vitest/browser": "^2.0.0-beta.12",
     "tsup": "^8.1.0",
-    "typescript": "^5.4.5",
-    "vitest": "^1.6.0",
+    "typescript": "^5.5.2",
+    "vitest": "^2.0.0-beta.12",
     "@prosekit/dev": "0.0.0"
   },
   "scripts": {