@tiptap/core 2.11.6 → 3.0.0-beta.0

package/src/commands/joinItemForward.ts

@@ -1,6 +1,6 @@
 import { joinPoint } from '@tiptap/pm/transform'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -14,26 +14,24 @@ declare module '@tiptap/core' {
   }
 }
 
-export const joinItemForward: RawCommands['joinItemForward'] = () => ({
-  state,
-  dispatch,
-  tr,
-}) => {
-  try {
-    const point = joinPoint(state.doc, state.selection.$from.pos, +1)
+export const joinItemForward: RawCommands['joinItemForward'] =
+  () =>
+  ({ state, dispatch, tr }) => {
+    try {
+      const point = joinPoint(state.doc, state.selection.$from.pos, +1)
 
-    if (point === null || point === undefined) {
-      return false
-    }
+      if (point === null || point === undefined) {
+        return false
+      }
 
-    tr.join(point, 2)
+      tr.join(point, 2)
 
-    if (dispatch) {
-      dispatch(tr)
-    }
+      if (dispatch) {
+        dispatch(tr)
+      }
 
-    return true
-  } catch {
-    return false
+      return true
+    } catch {
+      return false
+    }
   }
-}

package/src/commands/joinTextblockBackward.ts

@@ -1,6 +1,6 @@
 import { joinTextblockBackward as originalCommand } from '@tiptap/pm/commands'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -13,6 +13,8 @@ declare module '@tiptap/core' {
   }
 }
 
-export const joinTextblockBackward: RawCommands['joinTextblockBackward'] = () => ({ state, dispatch }) => {
-  return originalCommand(state, dispatch)
-}
+export const joinTextblockBackward: RawCommands['joinTextblockBackward'] =
+  () =>
+  ({ state, dispatch }) => {
+    return originalCommand(state, dispatch)
+  }

package/src/commands/joinTextblockForward.ts

@@ -1,6 +1,6 @@
 import { joinTextblockForward as originalCommand } from '@tiptap/pm/commands'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -13,6 +13,8 @@ declare module '@tiptap/core' {
   }
 }
 
-export const joinTextblockForward: RawCommands['joinTextblockForward'] = () => ({ state, dispatch }) => {
-  return originalCommand(state, dispatch)
-}
+export const joinTextblockForward: RawCommands['joinTextblockForward'] =
+  () =>
+  ({ state, dispatch }) => {
+    return originalCommand(state, dispatch)
+  }

package/src/commands/keyboardShortcut.ts

@@ -1,4 +1,4 @@
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 import { isiOS } from '../utilities/isiOS.js'
 import { isMacOS } from '../utilities/isMacOS.js'
 
@@ -64,42 +64,37 @@ declare module '@tiptap/core' {
        * @param name The name of the keyboard shortcut.
        * @example editor.commands.keyboardShortcut('Mod-b')
        */
-      keyboardShortcut: (name: string) => ReturnType,
+      keyboardShortcut: (name: string) => ReturnType
     }
   }
 }
 
-export const keyboardShortcut: RawCommands['keyboardShortcut'] = name => ({
-  editor,
-  view,
-  tr,
-  dispatch,
-}) => {
-  const keys = normalizeKeyName(name).split(/-(?!$)/)
-  const key = keys.find(item => !['Alt', 'Ctrl', 'Meta', 'Shift'].includes(item))
-  const event = new KeyboardEvent('keydown', {
-    key: key === 'Space'
-      ? ' '
-      : key,
-    altKey: keys.includes('Alt'),
-    ctrlKey: keys.includes('Ctrl'),
-    metaKey: keys.includes('Meta'),
-    shiftKey: keys.includes('Shift'),
-    bubbles: true,
-    cancelable: true,
-  })
-
-  const capturedTransaction = editor.captureTransaction(() => {
-    view.someProp('handleKeyDown', f => f(view, event))
-  })
-
-  capturedTransaction?.steps.forEach(step => {
-    const newStep = step.map(tr.mapping)
-
-    if (newStep && dispatch) {
-      tr.maybeStep(newStep)
-    }
-  })
+export const keyboardShortcut: RawCommands['keyboardShortcut'] =
+  name =>
+  ({ editor, view, tr, dispatch }) => {
+    const keys = normalizeKeyName(name).split(/-(?!$)/)
+    const key = keys.find(item => !['Alt', 'Ctrl', 'Meta', 'Shift'].includes(item))
+    const event = new KeyboardEvent('keydown', {
+      key: key === 'Space' ? ' ' : key,
+      altKey: keys.includes('Alt'),
+      ctrlKey: keys.includes('Ctrl'),
+      metaKey: keys.includes('Meta'),
+      shiftKey: keys.includes('Shift'),
+      bubbles: true,
+      cancelable: true,
+    })
+
+    const capturedTransaction = editor.captureTransaction(() => {
+      view.someProp('handleKeyDown', f => f(view, event))
+    })
+
+    capturedTransaction?.steps.forEach(step => {
+      const newStep = step.map(tr.mapping)
+
+      if (newStep && dispatch) {
+        tr.maybeStep(newStep)
+      }
+    })
 
-  return true
-}
+    return true
+  }

package/src/commands/lift.ts

@@ -1,9 +1,9 @@
 import { lift as originalLift } from '@tiptap/pm/commands'
-import { NodeType } from '@tiptap/pm/model'
+import type { NodeType } from '@tiptap/pm/model'
 
 import { getNodeType } from '../helpers/getNodeType.js'
 import { isNodeActive } from '../helpers/isNodeActive.js'
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -20,13 +20,15 @@ declare module '@tiptap/core' {
   }
 }
 
-export const lift: RawCommands['lift'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
-  const type = getNodeType(typeOrName, state.schema)
-  const isActive = isNodeActive(state, type, attributes)
+export const lift: RawCommands['lift'] =
+  (typeOrName, attributes = {}) =>
+  ({ state, dispatch }) => {
+    const type = getNodeType(typeOrName, state.schema)
+    const isActive = isNodeActive(state, type, attributes)
 
-  if (!isActive) {
-    return false
-  }
+    if (!isActive) {
+      return false
+    }
 
-  return originalLift(state, dispatch)
-}
+    return originalLift(state, dispatch)
+  }

package/src/commands/liftEmptyBlock.ts

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

package/src/commands/liftListItem.ts

@@ -1,8 +1,8 @@
-import { NodeType } from '@tiptap/pm/model'
+import type { NodeType } from '@tiptap/pm/model'
 import { liftListItem as originalLiftListItem } from '@tiptap/pm/schema-list'
 
 import { getNodeType } from '../helpers/getNodeType.js'
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -17,8 +17,10 @@ declare module '@tiptap/core' {
   }
 }
 
-export const liftListItem: RawCommands['liftListItem'] = typeOrName => ({ state, dispatch }) => {
-  const type = getNodeType(typeOrName, state.schema)
+export const liftListItem: RawCommands['liftListItem'] =
+  typeOrName =>
+  ({ state, dispatch }) => {
+    const type = getNodeType(typeOrName, state.schema)
 
-  return originalLiftListItem(type)(state, dispatch)
-}
+    return originalLiftListItem(type)(state, dispatch)
+  }

package/src/commands/newlineInCode.ts

@@ -1,6 +1,6 @@
 import { newlineInCode as originalNewlineInCode } from '@tiptap/pm/commands'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -14,6 +14,8 @@ declare module '@tiptap/core' {
   }
 }
 
-export const newlineInCode: RawCommands['newlineInCode'] = () => ({ state, dispatch }) => {
-  return originalNewlineInCode(state, dispatch)
-}
+export const newlineInCode: RawCommands['newlineInCode'] =
+  () =>
+  ({ state, dispatch }) => {
+    return originalNewlineInCode(state, dispatch)
+  }

package/src/commands/resetAttributes.ts

@@ -1,9 +1,9 @@
-import { MarkType, NodeType } from '@tiptap/pm/model'
+import type { MarkType, NodeType } from '@tiptap/pm/model'
 
 import { getMarkType } from '../helpers/getMarkType.js'
 import { getNodeType } from '../helpers/getNodeType.js'
 import { getSchemaTypeNameByName } from '../helpers/getSchemaTypeNameByName.js'
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 import { deleteProps } from '../utilities/deleteProps.js'
 
 declare module '@tiptap/core' {
@@ -15,56 +15,51 @@ declare module '@tiptap/core' {
        * @param attributes The attributes of the node to reset.
        * @example editor.commands.resetAttributes('heading', 'level')
        */
-      resetAttributes: (
-        typeOrName: string | NodeType | MarkType,
-        attributes: string | string[],
-      ) => ReturnType
+      resetAttributes: (typeOrName: string | NodeType | MarkType, attributes: string | string[]) => ReturnType
     }
   }
 }
 
-export const resetAttributes: RawCommands['resetAttributes'] = (typeOrName, attributes) => ({ tr, state, dispatch }) => {
-  let nodeType: NodeType | null = null
-  let markType: MarkType | null = null
+export const resetAttributes: RawCommands['resetAttributes'] =
+  (typeOrName, attributes) =>
+  ({ tr, state, dispatch }) => {
+    let nodeType: NodeType | null = null
+    let markType: MarkType | null = null
 
-  const schemaType = getSchemaTypeNameByName(
-    typeof typeOrName === 'string' ? typeOrName : typeOrName.name,
-    state.schema,
-  )
+    const schemaType = getSchemaTypeNameByName(
+      typeof typeOrName === 'string' ? typeOrName : typeOrName.name,
+      state.schema,
+    )
 
-  if (!schemaType) {
-    return false
-  }
+    if (!schemaType) {
+      return false
+    }
 
-  if (schemaType === 'node') {
-    nodeType = getNodeType(typeOrName as NodeType, state.schema)
-  }
+    if (schemaType === 'node') {
+      nodeType = getNodeType(typeOrName as NodeType, state.schema)
+    }
 
-  if (schemaType === 'mark') {
-    markType = getMarkType(typeOrName as MarkType, state.schema)
-  }
+    if (schemaType === 'mark') {
+      markType = getMarkType(typeOrName as MarkType, state.schema)
+    }
 
-  if (dispatch) {
-    tr.selection.ranges.forEach(range => {
-      state.doc.nodesBetween(range.$from.pos, range.$to.pos, (node, pos) => {
-        if (nodeType && nodeType === node.type) {
-          tr.setNodeMarkup(pos, undefined, deleteProps(node.attrs, attributes))
-        }
+    if (dispatch) {
+      tr.selection.ranges.forEach(range => {
+        state.doc.nodesBetween(range.$from.pos, range.$to.pos, (node, pos) => {
+          if (nodeType && nodeType === node.type) {
+            tr.setNodeMarkup(pos, undefined, deleteProps(node.attrs, attributes))
+          }
 
-        if (markType && node.marks.length) {
-          node.marks.forEach(mark => {
-            if (markType === mark.type) {
-              tr.addMark(
-                pos,
-                pos + node.nodeSize,
-                markType.create(deleteProps(mark.attrs, attributes)),
-              )
-            }
-          })
-        }
+          if (markType && node.marks.length) {
+            node.marks.forEach(mark => {
+              if (markType === mark.type) {
+                tr.addMark(pos, pos + node.nodeSize, markType.create(deleteProps(mark.attrs, attributes)))
+              }
+            })
+          }
+        })
       })
-    })
-  }
+    }
 
-  return true
-}
+    return true
+  }

package/src/commands/scrollIntoView.ts

@@ -1,4 +1,4 @@
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -7,15 +7,17 @@ declare module '@tiptap/core' {
        * Scroll the selection into view.
        * @example editor.commands.scrollIntoView()
        */
-      scrollIntoView: () => ReturnType,
+      scrollIntoView: () => ReturnType
     }
   }
 }
 
-export const scrollIntoView: RawCommands['scrollIntoView'] = () => ({ tr, dispatch }) => {
-  if (dispatch) {
-    tr.scrollIntoView()
-  }
+export const scrollIntoView: RawCommands['scrollIntoView'] =
+  () =>
+  ({ tr, dispatch }) => {
+    if (dispatch) {
+      tr.scrollIntoView()
+    }
 
-  return true
-}
+    return true
+  }

package/src/commands/selectAll.ts

@@ -1,6 +1,6 @@
 import { AllSelection } from '@tiptap/pm/state'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -9,17 +9,19 @@ declare module '@tiptap/core' {
        * Select the whole document.
        * @example editor.commands.selectAll()
        */
-      selectAll: () => ReturnType,
+      selectAll: () => ReturnType
     }
   }
 }
 
-export const selectAll: RawCommands['selectAll'] = () => ({ tr, dispatch }) => {
-  if (dispatch) {
-    const selection = new AllSelection(tr.doc)
+export const selectAll: RawCommands['selectAll'] =
+  () =>
+  ({ tr, dispatch }) => {
+    if (dispatch) {
+      const selection = new AllSelection(tr.doc)
 
-    tr.setSelection(selection)
-  }
+      tr.setSelection(selection)
+    }
 
-  return true
-}
+    return true
+  }

package/src/commands/selectNodeBackward.ts

@@ -1,6 +1,6 @@
 import { selectNodeBackward as originalSelectNodeBackward } from '@tiptap/pm/commands'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -14,6 +14,8 @@ declare module '@tiptap/core' {
   }
 }
 
-export const selectNodeBackward: RawCommands['selectNodeBackward'] = () => ({ state, dispatch }) => {
-  return originalSelectNodeBackward(state, dispatch)
-}
+export const selectNodeBackward: RawCommands['selectNodeBackward'] =
+  () =>
+  ({ state, dispatch }) => {
+    return originalSelectNodeBackward(state, dispatch)
+  }

package/src/commands/selectNodeForward.ts

@@ -1,6 +1,6 @@
 import { selectNodeForward as originalSelectNodeForward } from '@tiptap/pm/commands'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -14,6 +14,8 @@ declare module '@tiptap/core' {
   }
 }
 
-export const selectNodeForward: RawCommands['selectNodeForward'] = () => ({ state, dispatch }) => {
-  return originalSelectNodeForward(state, dispatch)
-}
+export const selectNodeForward: RawCommands['selectNodeForward'] =
+  () =>
+  ({ state, dispatch }) => {
+    return originalSelectNodeForward(state, dispatch)
+  }

package/src/commands/selectParentNode.ts

@@ -1,6 +1,6 @@
 import { selectParentNode as originalSelectParentNode } from '@tiptap/pm/commands'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -14,6 +14,8 @@ declare module '@tiptap/core' {
   }
 }
 
-export const selectParentNode: RawCommands['selectParentNode'] = () => ({ state, dispatch }) => {
-  return originalSelectParentNode(state, dispatch)
-}
+export const selectParentNode: RawCommands['selectParentNode'] =
+  () =>
+  ({ state, dispatch }) => {
+    return originalSelectParentNode(state, dispatch)
+  }

package/src/commands/selectTextblockEnd.ts

@@ -2,7 +2,7 @@
 // TODO: add types to @types/prosemirror-commands
 import { selectTextblockEnd as originalSelectTextblockEnd } from '@tiptap/pm/commands'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -16,6 +16,8 @@ declare module '@tiptap/core' {
   }
 }
 
-export const selectTextblockEnd: RawCommands['selectTextblockEnd'] = () => ({ state, dispatch }) => {
-  return originalSelectTextblockEnd(state, dispatch)
-}
+export const selectTextblockEnd: RawCommands['selectTextblockEnd'] =
+  () =>
+  ({ state, dispatch }) => {
+    return originalSelectTextblockEnd(state, dispatch)
+  }

package/src/commands/selectTextblockStart.ts

@@ -2,7 +2,7 @@
 // TODO: add types to @types/prosemirror-commands
 import { selectTextblockStart as originalSelectTextblockStart } from '@tiptap/pm/commands'
 
-import { RawCommands } from '../types.js'
+import type { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -16,6 +16,8 @@ declare module '@tiptap/core' {
   }
 }
 
-export const selectTextblockStart: RawCommands['selectTextblockStart'] = () => ({ state, dispatch }) => {
-  return originalSelectTextblockStart(state, dispatch)
-}
+export const selectTextblockStart: RawCommands['selectTextblockStart'] =
+  () =>
+  ({ state, dispatch }) => {
+    return originalSelectTextblockStart(state, dispatch)
+  }

package/src/commands/setContent.ts

@@ -1,7 +1,7 @@
-import { Fragment, Node as ProseMirrorNode, ParseOptions } from '@tiptap/pm/model'
+import type { Fragment, Node as ProseMirrorNode, ParseOptions } from '@tiptap/pm/model'
 
 import { createDocument } from '../helpers/createDocument.js'
-import { Content, RawCommands } from '../types.js'
+import type { Content, RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
   interface Commands<ReturnType> {
@@ -19,55 +19,56 @@ declare module '@tiptap/core' {
          */
         content: Content | Fragment | ProseMirrorNode,
 
-        /**
-         * Whether to emit an update event.
-         * @default false
-         */
-        emitUpdate?: boolean,
-
-        /**
-         * Options for parsing the content.
-         * @default {}
-         */
-        parseOptions?: ParseOptions,
         /**
          * Options for `setContent`.
          */
         options?: {
+          /**
+           * Options for parsing the content.
+           * @default {}
+           */
+          parseOptions?: ParseOptions
+
           /**
            * Whether to throw an error if the content is invalid.
            */
-          errorOnInvalidContent?: boolean;
-        }
-      ) => ReturnType;
-    };
+          errorOnInvalidContent?: boolean
+
+          /**
+           * Whether to emit an update event.
+           * @default true
+           */
+          emitUpdate?: boolean
+        },
+      ) => ReturnType
+    }
   }
 }
 
-export const setContent: RawCommands['setContent'] = (content, emitUpdate = false, parseOptions = {}, options = {}) => ({
-  editor, tr, dispatch, commands,
-}) => {
-  const { doc } = tr
+export const setContent: RawCommands['setContent'] =
+  (content, { errorOnInvalidContent, emitUpdate = true, parseOptions = {} } = {}) =>
+  ({ editor, tr, dispatch, commands }) => {
+    const { doc } = tr
 
-  // This is to keep backward compatibility with the previous behavior
-  // TODO remove this in the next major version
-  if (parseOptions.preserveWhitespace !== 'full') {
-    const document = createDocument(content, editor.schema, parseOptions, {
-      errorOnInvalidContent: options.errorOnInvalidContent ?? editor.options.enableContentCheck,
-    })
+    // This is to keep backward compatibility with the previous behavior
+    // TODO remove this in the next major version
+    if (parseOptions.preserveWhitespace !== 'full') {
+      const document = createDocument(content, editor.schema, parseOptions, {
+        errorOnInvalidContent: errorOnInvalidContent ?? editor.options.enableContentCheck,
+      })
+
+      if (dispatch) {
+        tr.replaceWith(0, doc.content.size, document).setMeta('preventUpdate', !emitUpdate)
+      }
+      return true
+    }
 
     if (dispatch) {
-      tr.replaceWith(0, doc.content.size, document).setMeta('preventUpdate', !emitUpdate)
+      tr.setMeta('preventUpdate', !emitUpdate)
     }
-    return true
-  }
 
-  if (dispatch) {
-    tr.setMeta('preventUpdate', !emitUpdate)
+    return commands.insertContentAt({ from: 0, to: doc.content.size }, content, {
+      parseOptions,
+      errorOnInvalidContent: errorOnInvalidContent ?? editor.options.enableContentCheck,
+    })
   }
-
-  return commands.insertContentAt({ from: 0, to: doc.content.size }, content, {
-    parseOptions,
-    errorOnInvalidContent: options.errorOnInvalidContent ?? editor.options.enableContentCheck,
-  })
-}