@tiptap/core 2.5.8 → 2.6.0

package/dist/packages/core/src/Editor.d.ts

@@ -16,6 +16,10 @@ export declare class Editor extends EventEmitter<EditorEvents> {
     schema: Schema;
     view: EditorView;
     isFocused: boolean;
+    /**
+     * The editor is considered initialized after the `create` event has been emitted.
+     */
+    isInitialized: boolean;
     extensionStorage: Record<string, any>;
     options: EditorOptions;
     constructor(options?: Partial<EditorOptions>);

package/dist/packages/core/src/Extension.d.ts

@@ -17,10 +17,10 @@ declare module '@tiptap/core' {
          */
         name: string;
         /**
-         * The priority of your extension. The higher, the later it will be called
+         * The priority of your extension. The higher, the earlier it will be called
          * and will take precedence over other extensions with a lower priority.
-         * @default 1000
-         * @example 1001
+         * @default 100
+         * @example 101
          */
         priority?: number;
         /**
@@ -286,6 +286,7 @@ declare module '@tiptap/core' {
             editor: Editor;
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['onTransaction'];
         }, props: {
+            editor: Editor;
             transaction: Transaction;
         }) => void) | null;
         /**
@@ -338,6 +339,6 @@ export declare class Extension<Options = any, Storage = any> {
     config: ExtensionConfig;
     constructor(config?: Partial<ExtensionConfig<Options, Storage>>);
     static create<O = any, S = any>(config?: Partial<ExtensionConfig<O, S>>): Extension<O, S>;
-    configure(options?: Partial<Options>): Extension<any, any>;
+    configure(options?: Partial<Options>): Extension<Options, Storage>;
     extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<ExtensionConfig<ExtendedOptions, ExtendedStorage>>): Extension<ExtendedOptions, ExtendedStorage>;
 }

package/dist/packages/core/src/Mark.d.ts

@@ -17,10 +17,10 @@ declare module '@tiptap/core' {
          */
         name: string;
         /**
-         * The priority of your extension. The higher, the later it will be called
+         * The priority of your extension. The higher, the earlier it will be called
          * and will take precedence over other extensions with a lower priority.
-         * @default 1000
-         * @example 1001
+         * @default 100
+         * @example 101
          */
         priority?: number;
         /**
@@ -296,6 +296,7 @@ declare module '@tiptap/core' {
             type: MarkType;
             parent: ParentConfig<MarkConfig<Options, Storage>>['onTransaction'];
         }, props: {
+            editor: Editor;
             transaction: Transaction;
         }) => void) | null;
         /**
@@ -442,7 +443,7 @@ export declare class Mark<Options = any, Storage = any> {
     config: MarkConfig;
     constructor(config?: Partial<MarkConfig<Options, Storage>>);
     static create<O = any, S = any>(config?: Partial<MarkConfig<O, S>>): Mark<O, S>;
-    configure(options?: Partial<Options>): Mark<any, any>;
+    configure(options?: Partial<Options>): Mark<Options, Storage>;
     extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<MarkConfig<ExtendedOptions, ExtendedStorage>>): Mark<ExtendedOptions, ExtendedStorage>;
     static handleExit({ editor, mark }: {
         editor: Editor;

package/dist/packages/core/src/Node.d.ts

@@ -17,10 +17,10 @@ declare module '@tiptap/core' {
          */
         name: string;
         /**
-         * The priority of your extension. The higher, the later it will be called
+         * The priority of your extension. The higher, the earlier it will be called
          * and will take precedence over other extensions with a lower priority.
-         * @default 1000
-         * @example 1001
+         * @default 100
+         * @example 101
          */
         priority?: number;
         /**
@@ -297,6 +297,7 @@ declare module '@tiptap/core' {
             type: NodeType;
             parent: ParentConfig<NodeConfig<Options, Storage>>['onTransaction'];
         }, props: {
+            editor: Editor;
             transaction: Transaction;
         }) => void) | null;
         /**
@@ -606,6 +607,6 @@ export declare class Node<Options = any, Storage = any> {
     config: NodeConfig;
     constructor(config?: Partial<NodeConfig<Options, Storage>>);
     static create<O = any, S = any>(config?: Partial<NodeConfig<O, S>>): Node<O, S>;
-    configure(options?: Partial<Options>): Node<any, any>;
+    configure(options?: Partial<Options>): Node<Options, Storage>;
     extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<NodeConfig<ExtendedOptions, ExtendedStorage>>): Node<ExtendedOptions, ExtendedStorage>;
 }

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

@@ -1,3 +1,4 @@
+import type { Plugin, PluginKey } from '@tiptap/pm/state';
 import { RawCommands } from '../types.js';
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
@@ -8,7 +9,7 @@ declare module '@tiptap/core' {
              * @param value The value to store.
              * @example editor.commands.setMeta('foo', 'bar')
              */
-            setMeta: (key: string, value: any) => ReturnType;
+            setMeta: (key: string | Plugin | PluginKey, value: any) => ReturnType;
         };
     }
 }

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

@@ -6,9 +6,10 @@ declare module '@tiptap/core' {
             /**
              * Splits one list item into two list items.
              * @param typeOrName The type or name of the node.
+             * @param overrideAttrs The attributes to ensure on the new node.
              * @example editor.commands.splitListItem('listItem')
              */
-            splitListItem: (typeOrName: string | NodeType) => ReturnType;
+            splitListItem: (typeOrName: string | NodeType, overrideAttrs?: Record<string, any>) => ReturnType;
         };
     }
 }

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

@@ -1,8 +1,14 @@
 import { Node as ProseMirrorNode } from '@tiptap/pm/model';
 /**
- * Returns true if the given node is empty.
- * When `checkChildren` is true (default), it will also check if all children are empty.
+ * Returns true if the given prosemirror node is empty.
  */
-export declare function isNodeEmpty(node: ProseMirrorNode, { checkChildren }?: {
-    checkChildren: boolean;
+export declare function isNodeEmpty(node: ProseMirrorNode, { checkChildren, ignoreWhitespace, }?: {
+    /**
+     * When true (default), it will also check if all children are empty.
+     */
+    checkChildren?: boolean;
+    /**
+     * When true, it will ignore whitespace when checking for emptiness.
+     */
+    ignoreWhitespace?: boolean;
 }): boolean;

package/dist/packages/core/src/pasteRules/nodePasteRule.d.ts

@@ -1,6 +1,6 @@
 import { NodeType } from '@tiptap/pm/model';
 import { PasteRule, PasteRuleFinder } from '../PasteRule.js';
-import { ExtendedRegExpMatchArray } from '../types.js';
+import { ExtendedRegExpMatchArray, JSONContent } from '../types.js';
 /**
  * Build an paste rule that adds a node when the
  * matched text is pasted into it.
@@ -10,4 +10,5 @@ export declare function nodePasteRule(config: {
     find: PasteRuleFinder;
     type: NodeType;
     getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray, event: ClipboardEvent) => Record<string, any>) | false | null;
+    getContent?: JSONContent[] | ((attrs: Record<string, any>) => JSONContent[]) | false | null;
 }): PasteRule;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/core",
   "description": "headless rich text editor",
-  "version": "2.5.8",
+  "version": "2.6.0",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -32,10 +32,10 @@
     "dist"
   ],
   "devDependencies": {
-    "@tiptap/pm": "^2.5.8"
+    "@tiptap/pm": "^2.6.0"
   },
   "peerDependencies": {
-    "@tiptap/pm": "^2.5.8"
+    "@tiptap/pm": "^2.6.0"
   },
   "repository": {
     "type": "git",

package/src/Editor.ts

@@ -57,6 +57,11 @@ export class Editor extends EventEmitter<EditorEvents> {
 
   public isFocused = false
 
+  /**
+   * The editor is considered initialized after the `create` event has been emitted.
+   */
+  public isInitialized = false
+
   public extensionStorage: Record<string, any> = {}
 
   public options: EditorOptions = {
@@ -111,6 +116,7 @@ export class Editor extends EventEmitter<EditorEvents> {
 
       this.commands.focus(this.options.autofocus)
       this.emit('create', { editor: this })
+      this.isInitialized = true
     }, 0)
   }
 

package/src/Extension.ts

@@ -32,10 +32,10 @@ declare module '@tiptap/core' {
     name: string
 
     /**
-     * The priority of your extension. The higher, the later it will be called
+     * The priority of your extension. The higher, the earlier it will be called
      * and will take precedence over other extensions with a lower priority.
-     * @default 1000
-     * @example 1001
+     * @default 100
+     * @example 101
      */
     priority?: number
 
@@ -339,6 +339,7 @@ declare module '@tiptap/core' {
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['onTransaction']
           },
           props: {
+            editor: Editor
             transaction: Transaction
           },
         ) => void)
@@ -457,7 +458,7 @@ export class Extension<Options = any, Storage = any> {
   configure(options: Partial<Options> = {}) {
     // return a new instance so we can use the same extension
     // with different calls of `configure`
-    const extension = this.extend({
+    const extension = this.extend<Options, Storage>({
       ...this.config,
       addOptions: () => {
         return mergeDeep(this.options as Record<string, any>, options) as Options

package/src/Mark.ts

@@ -35,10 +35,10 @@ declare module '@tiptap/core' {
     name: string
 
     /**
-     * The priority of your extension. The higher, the later it will be called
+     * The priority of your extension. The higher, the earlier it will be called
      * and will take precedence over other extensions with a lower priority.
-     * @default 1000
-     * @example 1001
+     * @default 100
+     * @example 101
      */
     priority?: number
 
@@ -352,6 +352,7 @@ declare module '@tiptap/core' {
             parent: ParentConfig<MarkConfig<Options, Storage>>['onTransaction']
           },
           props: {
+            editor: Editor
             transaction: Transaction
           },
         ) => void)
@@ -589,7 +590,7 @@ export class Mark<Options = any, Storage = any> {
   configure(options: Partial<Options> = {}) {
     // return a new instance so we can use the same extension
     // with different calls of `configure`
-    const extension = this.extend({
+    const extension = this.extend<Options, Storage>({
       ...this.config,
       addOptions: () => {
         return mergeDeep(this.options as Record<string, any>, options) as Options

package/src/Node.ts

@@ -36,10 +36,10 @@ declare module '@tiptap/core' {
     name: string
 
     /**
-     * The priority of your extension. The higher, the later it will be called
+     * The priority of your extension. The higher, the earlier it will be called
      * and will take precedence over other extensions with a lower priority.
-     * @default 1000
-     * @example 1001
+     * @default 100
+     * @example 101
      */
     priority?: number
 
@@ -354,6 +354,7 @@ declare module '@tiptap/core' {
             parent: ParentConfig<NodeConfig<Options, Storage>>['onTransaction']
           },
           props: {
+            editor: Editor
             transaction: Transaction
           },
         ) => void)
@@ -780,7 +781,7 @@ export class Node<Options = any, Storage = any> {
   configure(options: Partial<Options> = {}) {
     // return a new instance so we can use the same extension
     // with different calls of `configure`
-    const extension = this.extend({
+    const extension = this.extend<Options, Storage>({
       ...this.config,
       addOptions: () => {
         return mergeDeep(this.options as Record<string, any>, options) as Options

package/src/commands/setMeta.ts

@@ -1,3 +1,5 @@
+import type { Plugin, PluginKey } from '@tiptap/pm/state'
+
 import { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
@@ -9,7 +11,7 @@ declare module '@tiptap/core' {
        * @param value The value to store.
        * @example editor.commands.setMeta('foo', 'bar')
        */
-      setMeta: (key: string, value: any) => ReturnType,
+      setMeta: (key: string | Plugin | PluginKey, value: any) => ReturnType,
     }
   }
 }

package/src/commands/splitListItem.ts

@@ -14,14 +14,15 @@ declare module '@tiptap/core' {
       /**
        * Splits one list item into two list items.
        * @param typeOrName The type or name of the node.
+       * @param overrideAttrs The attributes to ensure on the new node.
        * @example editor.commands.splitListItem('listItem')
        */
-      splitListItem: (typeOrName: string | NodeType) => ReturnType
+      splitListItem: (typeOrName: string | NodeType, overrideAttrs?: Record<string, any>) => ReturnType
     }
   }
 }
 
-export const splitListItem: RawCommands['splitListItem'] = typeOrName => ({
+export const splitListItem: RawCommands['splitListItem'] = (typeOrName, overrideAttrs = {}) => ({
   tr, state, dispatch, editor,
 }) => {
   const type = getNodeType(typeOrName, state.schema)
@@ -70,11 +71,14 @@ export const splitListItem: RawCommands['splitListItem'] = typeOrName => ({
         const depthAfter = $from.indexAfter(-1) < $from.node(-2).childCount ? 1 : $from.indexAfter(-2) < $from.node(-3).childCount ? 2 : 3
 
       // Add a second list item with an empty default start node
-      const newNextTypeAttributes = getSplittedAttributes(
-        extensionAttributes,
-        $from.node().type.name,
-        $from.node().attrs,
-      )
+      const newNextTypeAttributes = {
+        ...getSplittedAttributes(
+          extensionAttributes,
+          $from.node().type.name,
+          $from.node().attrs,
+        ),
+        ...overrideAttrs,
+      }
       const nextType = type.contentMatch.defaultType?.createAndFill(newNextTypeAttributes) || undefined
 
       wrap = wrap.append(Fragment.from(type.createAndFill(null, nextType) || undefined))
@@ -107,16 +111,22 @@ export const splitListItem: RawCommands['splitListItem'] = typeOrName => ({
 
   const nextType = $to.pos === $from.end() ? grandParent.contentMatchAt(0).defaultType : null
 
-  const newTypeAttributes = getSplittedAttributes(
-    extensionAttributes,
-    grandParent.type.name,
-    grandParent.attrs,
-  )
-  const newNextTypeAttributes = getSplittedAttributes(
-    extensionAttributes,
-    $from.node().type.name,
-    $from.node().attrs,
-  )
+  const newTypeAttributes = {
+    ...getSplittedAttributes(
+      extensionAttributes,
+      grandParent.type.name,
+      grandParent.attrs,
+    ),
+    ...overrideAttrs,
+  }
+  const newNextTypeAttributes = {
+    ...getSplittedAttributes(
+      extensionAttributes,
+      $from.node().type.name,
+      $from.node().attrs,
+    ),
+    ...overrideAttrs,
+  }
 
   tr.delete($from.pos, $to.pos)
 

package/src/helpers/getMarksBetween.ts

@@ -12,7 +12,7 @@ export function getMarksBetween(from: number, to: number, doc: ProseMirrorNode):
       .resolve(from)
       .marks()
       .forEach(mark => {
-        const $pos = doc.resolve(from - 1)
+        const $pos = doc.resolve(from)
         const range = getMarkRange($pos, mark.type)
 
         if (!range) {

package/src/helpers/isNodeEmpty.ts

@@ -1,40 +1,61 @@
 import { Node as ProseMirrorNode } from '@tiptap/pm/model'
 
 /**
- * Returns true if the given node is empty.
- * When `checkChildren` is true (default), it will also check if all children are empty.
+ * Returns true if the given prosemirror node is empty.
  */
 export function isNodeEmpty(
   node: ProseMirrorNode,
-  { checkChildren }: { checkChildren: boolean } = { checkChildren: true },
+  {
+    checkChildren = true,
+    ignoreWhitespace = false,
+  }: {
+    /**
+     * When true (default), it will also check if all children are empty.
+     */
+    checkChildren?: boolean;
+    /**
+     * When true, it will ignore whitespace when checking for emptiness.
+     */
+    ignoreWhitespace?: boolean;
+  } = {},
 ): boolean {
+  if (ignoreWhitespace) {
+    if (node.type.name === 'hardBreak') {
+      // Hard breaks are considered empty
+      return true
+    }
+    if (node.isText) {
+      return /^\s*$/m.test(node.text ?? '')
+    }
+  }
+
   if (node.isText) {
     return !node.text
   }
 
-  if (node.content.childCount === 0) {
-    return true
+  if (node.isAtom || node.isLeaf) {
+    return false
   }
 
-  if (node.isLeaf) {
-    return false
+  if (node.content.childCount === 0) {
+    return true
   }
 
   if (checkChildren) {
-    let hasSameContent = true
+    let isContentEmpty = true
 
     node.content.forEach(childNode => {
-      if (hasSameContent === false) {
+      if (isContentEmpty === false) {
         // Exit early for perf
         return
       }
 
-      if (!isNodeEmpty(childNode)) {
-        hasSameContent = false
+      if (!isNodeEmpty(childNode, { ignoreWhitespace, checkChildren })) {
+        isContentEmpty = false
       }
     })
 
-    return hasSameContent
+    return isContentEmpty
   }
 
   return false

package/src/pasteRules/nodePasteRule.ts

@@ -1,7 +1,7 @@
 import { NodeType } from '@tiptap/pm/model'
 
 import { PasteRule, PasteRuleFinder } from '../PasteRule.js'
-import { ExtendedRegExpMatchArray } from '../types.js'
+import { ExtendedRegExpMatchArray, JSONContent } from '../types.js'
 import { callOrReturn } from '../utilities/index.js'
 
 /**
@@ -17,6 +17,11 @@ export function nodePasteRule(config: {
     | ((match: ExtendedRegExpMatchArray, event: ClipboardEvent) => Record<string, any>)
     | false
     | null
+  getContent?:
+    | JSONContent[]
+    | ((attrs: Record<string, any>) => JSONContent[])
+    | false
+    | null
 }) {
   return new PasteRule({
     find: config.find,
@@ -24,16 +29,20 @@ export function nodePasteRule(config: {
       match, chain, range, pasteEvent,
     }) {
       const attributes = callOrReturn(config.getAttributes, undefined, match, pasteEvent)
+      const content = callOrReturn(config.getContent, undefined, attributes)
 
       if (attributes === false || attributes === null) {
         return null
       }
 
+      const node = { type: config.type.name, attrs: attributes } as JSONContent
+
+      if (content) {
+        node.content = content
+      }
+
       if (match.input) {
-        chain().deleteRange(range).insertContentAt(range.from, {
-          type: config.type.name,
-          attrs: attributes,
-        })
+        chain().deleteRange(range).insertContentAt(range.from, node)
       }
     },
   })

package/src/utilities/findDuplicates.ts

@@ -1,5 +1,5 @@
 export function findDuplicates(items: any[]): any[] {
   const filtered = items.filter((el, index) => items.indexOf(el) !== index)
 
-  return [...new Set(filtered)]
+  return Array.from(new Set(filtered))
 }