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

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

@@ -1,15 +1,15 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        sinkListItem: {
-            /**
-             * Sink the list item down into an inner list.
-             * @param typeOrName The type or name of the node.
-             * @example editor.commands.sinkListItem('listItem')
-             */
-            sinkListItem: (typeOrName: string | NodeType) => ReturnType;
-        };
-    }
-}
-export declare const sinkListItem: RawCommands['sinkListItem'];
+import { NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        sinkListItem: {
+            /**
+             * Sink the list item down into an inner list.
+             * @param typeOrName The type or name of the node.
+             * @example editor.commands.sinkListItem('listItem')
+             */
+            sinkListItem: (typeOrName: string | NodeType) => ReturnType;
+        };
+    }
+}
+export declare const sinkListItem: RawCommands['sinkListItem'];

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

@@ -1,17 +1,17 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        splitBlock: {
-            /**
-             * Forks a new node from an existing node.
-             * @param options.keepMarks Keep marks from the previous node.
-             * @example editor.commands.splitBlock()
-             * @example editor.commands.splitBlock({ keepMarks: true })
-             */
-            splitBlock: (options?: {
-                keepMarks?: boolean;
-            }) => ReturnType;
-        };
-    }
-}
-export declare const splitBlock: RawCommands['splitBlock'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        splitBlock: {
+            /**
+             * Forks a new node from an existing node.
+             * @param options.keepMarks Keep marks from the previous node.
+             * @example editor.commands.splitBlock()
+             * @example editor.commands.splitBlock({ keepMarks: true })
+             */
+            splitBlock: (options?: {
+                keepMarks?: boolean;
+            }) => ReturnType;
+        };
+    }
+}
+export declare const splitBlock: RawCommands['splitBlock'];

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

@@ -1,15 +1,15 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        splitListItem: {
-            /**
-             * Splits one list item into two list items.
-             * @param typeOrName The type or name of the node.
-             * @example editor.commands.splitListItem('listItem')
-             */
-            splitListItem: (typeOrName: string | NodeType) => ReturnType;
-        };
-    }
-}
-export declare const splitListItem: RawCommands['splitListItem'];
+import { NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        splitListItem: {
+            /**
+             * Splits one list item into two list items.
+             * @param typeOrName The type or name of the node.
+             * @example editor.commands.splitListItem('listItem')
+             */
+            splitListItem: (typeOrName: string | NodeType) => ReturnType;
+        };
+    }
+}
+export declare const splitListItem: RawCommands['splitListItem'];

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

@@ -1,18 +1,18 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        toggleList: {
-            /**
-             * Toggle between different list types.
-             * @param listTypeOrName The type or name of the list.
-             * @param itemTypeOrName The type or name of the list item.
-             * @param keepMarks Keep marks when toggling.
-             * @param attributes Attributes for the new list.
-             * @example editor.commands.toggleList('bulletList', 'listItem')
-             */
-            toggleList: (listTypeOrName: string | NodeType, itemTypeOrName: string | NodeType, keepMarks?: boolean, attributes?: Record<string, any>) => ReturnType;
-        };
-    }
-}
-export declare const toggleList: RawCommands['toggleList'];
+import { NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        toggleList: {
+            /**
+             * Toggle between different list types.
+             * @param listTypeOrName The type or name of the list.
+             * @param itemTypeOrName The type or name of the list item.
+             * @param keepMarks Keep marks when toggling.
+             * @param attributes Attributes for the new list.
+             * @example editor.commands.toggleList('bulletList', 'listItem')
+             */
+            toggleList: (listTypeOrName: string | NodeType, itemTypeOrName: string | NodeType, keepMarks?: boolean, attributes?: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const toggleList: RawCommands['toggleList'];

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

@@ -1,30 +1,30 @@
-import { MarkType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        toggleMark: {
-            /**
-             * Toggle a mark on and off.
-             * @param typeOrName The mark type or name.
-             * @param attributes The attributes of the mark.
-             * @param options.extendEmptyMarkRange Removes the mark even across the current selection. Defaults to `false`.
-             * @example editor.commands.toggleMark('bold')
-             */
-            toggleMark: (
-            /**
-             * The mark type or name.
-             */
-            typeOrName: string | MarkType, 
-            /**
-             * The attributes of the mark.
-             */
-            attributes?: Record<string, any>, options?: {
-                /**
-                 * Removes the mark even across the current selection. Defaults to `false`.
-                 */
-                extendEmptyMarkRange?: boolean;
-            }) => ReturnType;
-        };
-    }
-}
-export declare const toggleMark: RawCommands['toggleMark'];
+import { MarkType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        toggleMark: {
+            /**
+             * Toggle a mark on and off.
+             * @param typeOrName The mark type or name.
+             * @param attributes The attributes of the mark.
+             * @param options.extendEmptyMarkRange Removes the mark even across the current selection. Defaults to `false`.
+             * @example editor.commands.toggleMark('bold')
+             */
+            toggleMark: (
+            /**
+             * The mark type or name.
+             */
+            typeOrName: string | MarkType, 
+            /**
+             * The attributes of the mark.
+             */
+            attributes?: Record<string, any>, options?: {
+                /**
+                 * Removes the mark even across the current selection. Defaults to `false`.
+                 */
+                extendEmptyMarkRange?: boolean;
+            }) => ReturnType;
+        };
+    }
+}
+export declare const toggleMark: RawCommands['toggleMark'];

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

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

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

@@ -1,16 +1,16 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        toggleWrap: {
-            /**
-             * Wraps nodes in another node, or removes an existing wrap.
-             * @param typeOrName The type or name of the node.
-             * @param attributes The attributes of the node.
-             * @example editor.commands.toggleWrap('blockquote')
-             */
-            toggleWrap: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType;
-        };
-    }
-}
-export declare const toggleWrap: RawCommands['toggleWrap'];
+import { NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        toggleWrap: {
+            /**
+             * Wraps nodes in another node, or removes an existing wrap.
+             * @param typeOrName The type or name of the node.
+             * @param attributes The attributes of the node.
+             * @example editor.commands.toggleWrap('blockquote')
+             */
+            toggleWrap: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const toggleWrap: RawCommands['toggleWrap'];

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

@@ -1,13 +1,13 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        undoInputRule: {
-            /**
-             * Undo an input rule.
-             * @example editor.commands.undoInputRule()
-             */
-            undoInputRule: () => ReturnType;
-        };
-    }
-}
-export declare const undoInputRule: RawCommands['undoInputRule'];
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        undoInputRule: {
+            /**
+             * Undo an input rule.
+             * @example editor.commands.undoInputRule()
+             */
+            undoInputRule: () => ReturnType;
+        };
+    }
+}
+export declare const undoInputRule: RawCommands['undoInputRule'];

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

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

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

@@ -1,25 +1,25 @@
-import { MarkType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        unsetMark: {
-            /**
-             * Remove all marks in the current selection.
-             * @param typeOrName The mark type or name.
-             * @param options.extendEmptyMarkRange Removes the mark even across the current selection. Defaults to `false`.
-             * @example editor.commands.unsetMark('bold')
-             */
-            unsetMark: (
-            /**
-             * The mark type or name.
-             */
-            typeOrName: string | MarkType, options?: {
-                /**
-                 * Removes the mark even across the current selection. Defaults to `false`.
-                 */
-                extendEmptyMarkRange?: boolean;
-            }) => ReturnType;
-        };
-    }
-}
-export declare const unsetMark: RawCommands['unsetMark'];
+import { MarkType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        unsetMark: {
+            /**
+             * Remove all marks in the current selection.
+             * @param typeOrName The mark type or name.
+             * @param options.extendEmptyMarkRange Removes the mark even across the current selection. Defaults to `false`.
+             * @example editor.commands.unsetMark('bold')
+             */
+            unsetMark: (
+            /**
+             * The mark type or name.
+             */
+            typeOrName: string | MarkType, options?: {
+                /**
+                 * Removes the mark even across the current selection. Defaults to `false`.
+                 */
+                extendEmptyMarkRange?: boolean;
+            }) => ReturnType;
+        };
+    }
+}
+export declare const unsetMark: RawCommands['unsetMark'];

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

@@ -1,24 +1,24 @@
-import { MarkType, NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        updateAttributes: {
-            /**
-             * Update attributes of a node or mark.
-             * @param typeOrName The type or name of the node or mark.
-             * @param attributes The attributes of the node or mark.
-             * @example editor.commands.updateAttributes('mention', { userId: "2" })
-             */
-            updateAttributes: (
-            /**
-             * The type or name of the node or mark.
-             */
-            typeOrName: string | NodeType | MarkType, 
-            /**
-             * The attributes of the node or mark.
-             */
-            attributes: Record<string, any>) => ReturnType;
-        };
-    }
-}
-export declare const updateAttributes: RawCommands['updateAttributes'];
+import { MarkType, NodeType } from '@tiptap/pm/model';
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        updateAttributes: {
+            /**
+             * Update attributes of a node or mark.
+             * @param typeOrName The type or name of the node or mark.
+             * @param attributes The attributes of the node or mark.
+             * @example editor.commands.updateAttributes('mention', { userId: "2" })
+             */
+            updateAttributes: (
+            /**
+             * The type or name of the node or mark.
+             */
+            typeOrName: string | NodeType | MarkType, 
+            /**
+             * The attributes of the node or mark.
+             */
+            attributes: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const updateAttributes: RawCommands['updateAttributes'];

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

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

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

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

package/dist/packages/core/src/extensions/clipboardTextSerializer.d.ts

@@ -1,5 +1,5 @@
-import { Extension } from '../Extension.js';
-export declare type ClipboardTextSerializerOptions = {
-    blockSeparator?: string;
-};
-export declare const ClipboardTextSerializer: Extension<ClipboardTextSerializerOptions, any>;
+import { Extension } from '../Extension.js';
+export type ClipboardTextSerializerOptions = {
+    blockSeparator?: string;
+};
+export declare const ClipboardTextSerializer: Extension<ClipboardTextSerializerOptions, any>;

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

@@ -1,3 +1,3 @@
-import { Extension } from '../Extension.js';
-export * from '../commands/index.js';
-export declare const Commands: Extension<any, any>;
+import { Extension } from '../Extension.js';
+export * from '../commands/index.js';
+export declare const Commands: Extension<any, any>;

package/dist/packages/core/src/extensions/editable.d.ts

@@ -1,2 +1,2 @@
-import { Extension } from '../Extension.js';
-export declare const Editable: Extension<any, any>;
+import { Extension } from '../Extension.js';
+export declare const Editable: Extension<any, any>;

package/dist/packages/core/src/extensions/focusEvents.d.ts

@@ -1,2 +1,2 @@
-import { Extension } from '../Extension.js';
-export declare const FocusEvents: Extension<any, any>;
+import { Extension } from '../Extension.js';
+export declare const FocusEvents: Extension<any, any>;

package/dist/packages/core/src/extensions/index.d.ts

@@ -1,6 +1,6 @@
-export { ClipboardTextSerializer } from './clipboardTextSerializer.js';
-export { Commands } from './commands.js';
-export { Editable } from './editable.js';
-export { FocusEvents } from './focusEvents.js';
-export { Keymap } from './keymap.js';
-export { Tabindex } from './tabindex.js';
+export { ClipboardTextSerializer } from './clipboardTextSerializer.js';
+export { Commands } from './commands.js';
+export { Editable } from './editable.js';
+export { FocusEvents } from './focusEvents.js';
+export { Keymap } from './keymap.js';
+export { Tabindex } from './tabindex.js';

package/dist/packages/core/src/extensions/keymap.d.ts

@@ -1,2 +1,2 @@
-import { Extension } from '../Extension.js';
-export declare const Keymap: Extension<any, any>;
+import { Extension } from '../Extension.js';
+export declare const Keymap: Extension<any, any>;

package/dist/packages/core/src/extensions/tabindex.d.ts

@@ -1,2 +1,2 @@
-import { Extension } from '../Extension.js';
-export declare const Tabindex: Extension<any, any>;
+import { Extension } from '../Extension.js';
+export declare const Tabindex: Extension<any, any>;

package/dist/packages/core/src/helpers/combineTransactionSteps.d.ts

@@ -1,10 +1,10 @@
-import { Node as ProseMirrorNode } from '@tiptap/pm/model';
-import { Transaction } from '@tiptap/pm/state';
-import { Transform } from '@tiptap/pm/transform';
-/**
- * Returns a new `Transform` based on all steps of the passed transactions.
- * @param oldDoc The Prosemirror node to start from
- * @param transactions The transactions to combine
- * @returns A new `Transform` with all steps of the passed transactions
- */
-export declare function combineTransactionSteps(oldDoc: ProseMirrorNode, transactions: Transaction[]): Transform;
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { Transaction } from '@tiptap/pm/state';
+import { Transform } from '@tiptap/pm/transform';
+/**
+ * Returns a new `Transform` based on all steps of the passed transactions.
+ * @param oldDoc The Prosemirror node to start from
+ * @param transactions The transactions to combine
+ * @returns A new `Transform` with all steps of the passed transactions
+ */
+export declare function combineTransactionSteps(oldDoc: ProseMirrorNode, transactions: Transaction[]): Transform;

package/dist/packages/core/src/helpers/createChainableState.d.ts

@@ -1,10 +1,10 @@
-import { EditorState, Transaction } from '@tiptap/pm/state';
-/**
- * Takes a Transaction & Editor State and turns it into a chainable state object
- * @param config The transaction and state to create the chainable state from
- * @returns A chainable Editor state object
- */
-export declare function createChainableState(config: {
-    transaction: Transaction;
-    state: EditorState;
-}): EditorState;
+import { EditorState, Transaction } from '@tiptap/pm/state';
+/**
+ * Takes a Transaction & Editor State and turns it into a chainable state object
+ * @param config The transaction and state to create the chainable state from
+ * @returns A chainable Editor state object
+ */
+export declare function createChainableState(config: {
+    transaction: Transaction;
+    state: EditorState;
+}): EditorState;

package/dist/packages/core/src/helpers/createDocument.d.ts

@@ -1,12 +1,12 @@
-import { Node as ProseMirrorNode, ParseOptions, Schema } from '@tiptap/pm/model';
-import { Content } from '../types.js';
-/**
- * Create a new Prosemirror document node from content.
- * @param content The JSON or HTML content to create the document from
- * @param schema The Prosemirror schema to use for the document
- * @param parseOptions Options for the parser
- * @returns The created Prosemirror document node
- */
-export declare function createDocument(content: Content, schema: Schema, parseOptions?: ParseOptions, options?: {
-    errorOnInvalidContent?: boolean;
-}): ProseMirrorNode;
+import { Node as ProseMirrorNode, ParseOptions, Schema } from '@tiptap/pm/model';
+import { Content } from '../types.js';
+/**
+ * Create a new Prosemirror document node from content.
+ * @param content The JSON or HTML content to create the document from
+ * @param schema The Prosemirror schema to use for the document
+ * @param parseOptions Options for the parser
+ * @returns The created Prosemirror document node
+ */
+export declare function createDocument(content: Content, schema: Schema, parseOptions?: ParseOptions, options?: {
+    errorOnInvalidContent?: boolean;
+}): ProseMirrorNode;