@tiptap/core 2.5.0-beta.2 → 2.5.0-beta.4

package/dist/packages/core/src/commands/keyboardShortcut.d.ts

@@ -1,14 +1,14 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        keyboardShortcut: {
-            /**
-             * Trigger a keyboard shortcut.
-             * @param name The name of the keyboard shortcut.
-             * @example editor.commands.keyboardShortcut('Mod-b')
-             */
-            keyboardShortcut: (name: string) => ReturnType;
-        };
-    }
-}
-export declare const keyboardShortcut: RawCommands['keyboardShortcut'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        keyboardShortcut: {
+            /**
+             * Trigger a keyboard shortcut.
+             * @param name The name of the keyboard shortcut.
+             * @example editor.commands.keyboardShortcut('Mod-b')
+             */
+            keyboardShortcut: (name: string) => ReturnType;
+        };
+    }
+}
+export declare const keyboardShortcut: RawCommands['keyboardShortcut'];

package/dist/packages/core/src/commands/lift.d.ts

@@ -1,17 +1,17 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        lift: {
-            /**
-             * Removes an existing wrap if possible lifting the node out of it
-             * @param typeOrName The type or name of the node.
-             * @param attributes The attributes of the node.
-             * @example editor.commands.lift('paragraph')
-             * @example editor.commands.lift('heading', { level: 1 })
-             */
-            lift: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType;
-        };
-    }
-}
-export declare const lift: RawCommands['lift'];
+import { NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        lift: {
+            /**
+             * Removes an existing wrap if possible lifting the node out of it
+             * @param typeOrName The type or name of the node.
+             * @param attributes The attributes of the node.
+             * @example editor.commands.lift('paragraph')
+             * @example editor.commands.lift('heading', { level: 1 })
+             */
+            lift: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const lift: RawCommands['lift'];

package/dist/packages/core/src/commands/liftEmptyBlock.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        liftEmptyBlock: {
-            /**
-             * If the cursor is in an empty textblock that can be lifted, lift the block.
-             * @example editor.commands.liftEmptyBlock()
-             */
-            liftEmptyBlock: () => ReturnType;
-        };
-    }
-}
-export declare const liftEmptyBlock: RawCommands['liftEmptyBlock'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        liftEmptyBlock: {
+            /**
+             * If the cursor is in an empty textblock that can be lifted, lift the block.
+             * @example editor.commands.liftEmptyBlock()
+             */
+            liftEmptyBlock: () => ReturnType;
+        };
+    }
+}
+export declare const liftEmptyBlock: RawCommands['liftEmptyBlock'];

package/dist/packages/core/src/commands/liftListItem.d.ts

@@ -1,15 +1,15 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        liftListItem: {
-            /**
-             * Create a command to lift the list item around the selection up into a wrapping list.
-             * @param typeOrName The type or name of the node.
-             * @example editor.commands.liftListItem('listItem')
-             */
-            liftListItem: (typeOrName: string | NodeType) => ReturnType;
-        };
-    }
-}
-export declare const liftListItem: RawCommands['liftListItem'];
+import { NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        liftListItem: {
+            /**
+             * Create a command to lift the list item around the selection up into a wrapping list.
+             * @param typeOrName The type or name of the node.
+             * @example editor.commands.liftListItem('listItem')
+             */
+            liftListItem: (typeOrName: string | NodeType) => ReturnType;
+        };
+    }
+}
+export declare const liftListItem: RawCommands['liftListItem'];

package/dist/packages/core/src/commands/newlineInCode.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        newlineInCode: {
-            /**
-             * Add a newline character in code.
-             * @example editor.commands.newlineInCode()
-             */
-            newlineInCode: () => ReturnType;
-        };
-    }
-}
-export declare const newlineInCode: RawCommands['newlineInCode'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        newlineInCode: {
+            /**
+             * Add a newline character in code.
+             * @example editor.commands.newlineInCode()
+             */
+            newlineInCode: () => ReturnType;
+        };
+    }
+}
+export declare const newlineInCode: RawCommands['newlineInCode'];

package/dist/packages/core/src/commands/resetAttributes.d.ts

@@ -1,16 +1,16 @@
-import { MarkType, NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        resetAttributes: {
-            /**
-             * Resets some node attributes to the default value.
-             * @param typeOrName The type or name of the node.
-             * @param attributes The attributes of the node to reset.
-             * @example editor.commands.resetAttributes('heading', 'level')
-             */
-            resetAttributes: (typeOrName: string | NodeType | MarkType, attributes: string | string[]) => ReturnType;
-        };
-    }
-}
-export declare const resetAttributes: RawCommands['resetAttributes'];
+import { MarkType, NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        resetAttributes: {
+            /**
+             * Resets some node attributes to the default value.
+             * @param typeOrName The type or name of the node.
+             * @param attributes The attributes of the node to reset.
+             * @example editor.commands.resetAttributes('heading', 'level')
+             */
+            resetAttributes: (typeOrName: string | NodeType | MarkType, attributes: string | string[]) => ReturnType;
+        };
+    }
+}
+export declare const resetAttributes: RawCommands['resetAttributes'];

package/dist/packages/core/src/commands/scrollIntoView.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        scrollIntoView: {
-            /**
-             * Scroll the selection into view.
-             * @example editor.commands.scrollIntoView()
-             */
-            scrollIntoView: () => ReturnType;
-        };
-    }
-}
-export declare const scrollIntoView: RawCommands['scrollIntoView'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        scrollIntoView: {
+            /**
+             * Scroll the selection into view.
+             * @example editor.commands.scrollIntoView()
+             */
+            scrollIntoView: () => ReturnType;
+        };
+    }
+}
+export declare const scrollIntoView: RawCommands['scrollIntoView'];

package/dist/packages/core/src/commands/selectAll.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        selectAll: {
-            /**
-             * Select the whole document.
-             * @example editor.commands.selectAll()
-             */
-            selectAll: () => ReturnType;
-        };
-    }
-}
-export declare const selectAll: RawCommands['selectAll'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        selectAll: {
+            /**
+             * Select the whole document.
+             * @example editor.commands.selectAll()
+             */
+            selectAll: () => ReturnType;
+        };
+    }
+}
+export declare const selectAll: RawCommands['selectAll'];

package/dist/packages/core/src/commands/selectNodeBackward.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        selectNodeBackward: {
-            /**
-             * Select a node backward.
-             * @example editor.commands.selectNodeBackward()
-             */
-            selectNodeBackward: () => ReturnType;
-        };
-    }
-}
-export declare const selectNodeBackward: RawCommands['selectNodeBackward'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        selectNodeBackward: {
+            /**
+             * Select a node backward.
+             * @example editor.commands.selectNodeBackward()
+             */
+            selectNodeBackward: () => ReturnType;
+        };
+    }
+}
+export declare const selectNodeBackward: RawCommands['selectNodeBackward'];

package/dist/packages/core/src/commands/selectNodeForward.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        selectNodeForward: {
-            /**
-             * Select a node forward.
-             * @example editor.commands.selectNodeForward()
-             */
-            selectNodeForward: () => ReturnType;
-        };
-    }
-}
-export declare const selectNodeForward: RawCommands['selectNodeForward'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        selectNodeForward: {
+            /**
+             * Select a node forward.
+             * @example editor.commands.selectNodeForward()
+             */
+            selectNodeForward: () => ReturnType;
+        };
+    }
+}
+export declare const selectNodeForward: RawCommands['selectNodeForward'];

package/dist/packages/core/src/commands/selectParentNode.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        selectParentNode: {
-            /**
-             * Select the parent node.
-             * @example editor.commands.selectParentNode()
-             */
-            selectParentNode: () => ReturnType;
-        };
-    }
-}
-export declare const selectParentNode: RawCommands['selectParentNode'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        selectParentNode: {
+            /**
+             * Select the parent node.
+             * @example editor.commands.selectParentNode()
+             */
+            selectParentNode: () => ReturnType;
+        };
+    }
+}
+export declare const selectParentNode: RawCommands['selectParentNode'];

package/dist/packages/core/src/commands/selectTextblockEnd.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        selectTextblockEnd: {
-            /**
-             * Moves the cursor to the end of current text block.
-             * @example editor.commands.selectTextblockEnd()
-             */
-            selectTextblockEnd: () => ReturnType;
-        };
-    }
-}
-export declare const selectTextblockEnd: RawCommands['selectTextblockEnd'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        selectTextblockEnd: {
+            /**
+             * Moves the cursor to the end of current text block.
+             * @example editor.commands.selectTextblockEnd()
+             */
+            selectTextblockEnd: () => ReturnType;
+        };
+    }
+}
+export declare const selectTextblockEnd: RawCommands['selectTextblockEnd'];

package/dist/packages/core/src/commands/selectTextblockStart.d.ts

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        selectTextblockStart: {
-            /**
-             * Moves the cursor to the start of current text block.
-             * @example editor.commands.selectTextblockStart()
-             */
-            selectTextblockStart: () => ReturnType;
-        };
-    }
-}
-export declare const selectTextblockStart: RawCommands['selectTextblockStart'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        selectTextblockStart: {
+            /**
+             * Moves the cursor to the start of current text block.
+             * @example editor.commands.selectTextblockStart()
+             */
+            selectTextblockStart: () => ReturnType;
+        };
+    }
+}
+export declare const selectTextblockStart: RawCommands['selectTextblockStart'];

package/dist/packages/core/src/commands/setContent.d.ts

@@ -1,40 +1,40 @@
-import { ParseOptions } from '@tiptap/pm/model';
-import { Content, RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        setContent: {
-            /**
-             * Replace the whole document with new content.
-             * @param content The new content.
-             * @param emitUpdate Whether to emit an update event.
-             * @param parseOptions Options for parsing the content.
-             * @example editor.commands.setContent('<p>Example text</p>')
-             */
-            setContent: (
-            /**
-             * The new content.
-             */
-            content: Content, 
-            /**
-             * Whether to emit an update event.
-             * @default false
-             */
-            emitUpdate?: boolean, 
-            /**
-             * Options for parsing the content.
-             * @default {}
-             */
-            parseOptions?: ParseOptions, 
-            /**
-             * Options for `setContent`.
-             */
-            options?: {
-                /**
-                 * Whether to throw an error if the content is invalid.
-                 */
-                errorOnInvalidContent?: boolean;
-            }) => ReturnType;
-        };
-    }
-}
-export declare const setContent: RawCommands['setContent'];
+import { ParseOptions } from '@tiptap/pm/model';
+import { Content, RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        setContent: {
+            /**
+             * Replace the whole document with new content.
+             * @param content The new content.
+             * @param emitUpdate Whether to emit an update event.
+             * @param parseOptions Options for parsing the content.
+             * @example editor.commands.setContent('<p>Example text</p>')
+             */
+            setContent: (
+            /**
+             * The new content.
+             */
+            content: Content, 
+            /**
+             * Whether to emit an update event.
+             * @default false
+             */
+            emitUpdate?: boolean, 
+            /**
+             * Options for parsing the content.
+             * @default {}
+             */
+            parseOptions?: ParseOptions, 
+            /**
+             * Options for `setContent`.
+             */
+            options?: {
+                /**
+                 * Whether to throw an error if the content is invalid.
+                 */
+                errorOnInvalidContent?: boolean;
+            }) => ReturnType;
+        };
+    }
+}
+export declare const setContent: RawCommands['setContent'];

package/dist/packages/core/src/commands/setMark.d.ts

@@ -1,15 +1,15 @@
-import { MarkType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        setMark: {
-            /**
-             * Add a mark with new attributes.
-             * @param typeOrName The mark type or name.
-             * @example editor.commands.setMark('bold', { level: 1 })
-             */
-            setMark: (typeOrName: string | MarkType, attributes?: Record<string, any>) => ReturnType;
-        };
-    }
-}
-export declare const setMark: RawCommands['setMark'];
+import { MarkType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        setMark: {
+            /**
+             * Add a mark with new attributes.
+             * @param typeOrName The mark type or name.
+             * @example editor.commands.setMark('bold', { level: 1 })
+             */
+            setMark: (typeOrName: string | MarkType, attributes?: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const setMark: RawCommands['setMark'];

package/dist/packages/core/src/commands/setMeta.d.ts

@@ -1,15 +1,15 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        setMeta: {
-            /**
-             * Store a metadata property in the current transaction.
-             * @param key The key of the metadata property.
-             * @param value The value to store.
-             * @example editor.commands.setMeta('foo', 'bar')
-             */
-            setMeta: (key: string, value: any) => ReturnType;
-        };
-    }
-}
-export declare const setMeta: RawCommands['setMeta'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        setMeta: {
+            /**
+             * Store a metadata property in the current transaction.
+             * @param key The key of the metadata property.
+             * @param value The value to store.
+             * @example editor.commands.setMeta('foo', 'bar')
+             */
+            setMeta: (key: string, value: any) => ReturnType;
+        };
+    }
+}
+export declare const setMeta: RawCommands['setMeta'];

package/dist/packages/core/src/commands/setNode.d.ts

@@ -1,16 +1,16 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        setNode: {
-            /**
-             * Replace a given range with a node.
-             * @param typeOrName The type or name of the node
-             * @param attributes The attributes of the node
-             * @example editor.commands.setNode('paragraph')
-             */
-            setNode: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType;
-        };
-    }
-}
-export declare const setNode: RawCommands['setNode'];
+import { NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        setNode: {
+            /**
+             * Replace a given range with a node.
+             * @param typeOrName The type or name of the node
+             * @param attributes The attributes of the node
+             * @example editor.commands.setNode('paragraph')
+             */
+            setNode: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const setNode: RawCommands['setNode'];

package/dist/packages/core/src/commands/setNodeSelection.d.ts

@@ -1,14 +1,14 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        setNodeSelection: {
-            /**
-             * Creates a NodeSelection.
-             * @param position - Position of the node.
-             * @example editor.commands.setNodeSelection(10)
-             */
-            setNodeSelection: (position: number) => ReturnType;
-        };
-    }
-}
-export declare const setNodeSelection: RawCommands['setNodeSelection'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        setNodeSelection: {
+            /**
+             * Creates a NodeSelection.
+             * @param position - Position of the node.
+             * @example editor.commands.setNodeSelection(10)
+             */
+            setNodeSelection: (position: number) => ReturnType;
+        };
+    }
+}
+export declare const setNodeSelection: RawCommands['setNodeSelection'];

package/dist/packages/core/src/commands/setTextSelection.d.ts

@@ -1,14 +1,14 @@
-import { Range, RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        setTextSelection: {
-            /**
-             * Creates a TextSelection.
-             * @param position The position of the selection.
-             * @example editor.commands.setTextSelection(10)
-             */
-            setTextSelection: (position: number | Range) => ReturnType;
-        };
-    }
-}
-export declare const setTextSelection: RawCommands['setTextSelection'];
+import { Range, RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        setTextSelection: {
+            /**
+             * Creates a TextSelection.
+             * @param position The position of the selection.
+             * @example editor.commands.setTextSelection(10)
+             */
+            setTextSelection: (position: number | Range) => ReturnType;
+        };
+    }
+}
+export declare const setTextSelection: RawCommands['setTextSelection'];