@tiptap/core 2.0.0-beta.17 → 2.0.0-beta.170

package/src/commands/scrollIntoView.ts

@@ -1,12 +1,12 @@
-import { Command, RawCommands } from '../types'
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     scrollIntoView: {
       /**
        * Scroll the selection into view.
        */
-      scrollIntoView: () => Command,
+      scrollIntoView: () => ReturnType,
     }
   }
 }

package/src/commands/selectAll.ts

@@ -1,17 +1,19 @@
-import { selectAll as originalSelectAll } from 'prosemirror-commands'
-import { Command, RawCommands } from '../types'
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     selectAll: {
       /**
        * Select the whole document.
        */
-      selectAll: () => Command,
+      selectAll: () => ReturnType,
     }
   }
 }
 
-export const selectAll: RawCommands['selectAll'] = () => ({ state, dispatch }) => {
-  return originalSelectAll(state, dispatch)
+export const selectAll: RawCommands['selectAll'] = () => ({ tr, commands }) => {
+  return commands.setTextSelection({
+    from: 0,
+    to: tr.doc.content.size,
+  })
 }

package/src/commands/selectNodeBackward.ts

@@ -1,13 +1,13 @@
 import { selectNodeBackward as originalSelectNodeBackward } from 'prosemirror-commands'
-import { Command, RawCommands } from '../types'
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     selectNodeBackward: {
       /**
        * Select a node backward.
        */
-      selectNodeBackward: () => Command,
+      selectNodeBackward: () => ReturnType,
     }
   }
 }

package/src/commands/selectNodeForward.ts

@@ -1,13 +1,13 @@
 import { selectNodeForward as originalSelectNodeForward } from 'prosemirror-commands'
-import { Command, RawCommands } from '../types'
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     selectNodeForward: {
       /**
        * Select a node forward.
        */
-      selectNodeForward: () => Command,
+      selectNodeForward: () => ReturnType,
     }
   }
 }

package/src/commands/selectParentNode.ts

@@ -1,13 +1,13 @@
 import { selectParentNode as originalSelectParentNode } from 'prosemirror-commands'
-import { Command, RawCommands } from '../types'
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     selectParentNode: {
       /**
        * Select the parent node.
        */
-      selectParentNode: () => Command,
+      selectParentNode: () => ReturnType,
     }
   }
 }

package/src/commands/selectTextblockEnd.ts

@@ -0,0 +1,19 @@
+// @ts-ignore
+// TODO: add types to @types/prosemirror-commands
+import { selectTextblockEnd as originalSelectTextblockEnd } from 'prosemirror-commands'
+import { RawCommands } from '../types'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    selectTextblockEnd: {
+      /**
+       * Moves the cursor to the end of current text block.
+       */
+      selectTextblockEnd: () => ReturnType,
+    }
+  }
+}
+
+export const selectTextblockEnd: RawCommands['selectTextblockEnd'] = () => ({ state, dispatch }) => {
+  return originalSelectTextblockEnd(state, dispatch)
+}

package/src/commands/selectTextblockStart.ts

@@ -0,0 +1,19 @@
+// @ts-ignore
+// TODO: add types to @types/prosemirror-commands
+import { selectTextblockStart as originalSelectTextblockStart } from 'prosemirror-commands'
+import { RawCommands } from '../types'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    selectTextblockStart: {
+      /**
+       * Moves the cursor to the start of current text block.
+       */
+      selectTextblockStart: () => ReturnType,
+    }
+  }
+}
+
+export const selectTextblockStart: RawCommands['selectTextblockStart'] = () => ({ state, dispatch }) => {
+  return originalSelectTextblockStart(state, dispatch)
+}

package/src/commands/setContent.ts

@@ -1,23 +1,19 @@
 import { TextSelection } from 'prosemirror-state'
-import createDocument from '../helpers/createDocument'
-import {
-  AnyObject,
-  Command,
-  RawCommands,
-  Content,
-} from '../types'
+import { ParseOptions } from 'prosemirror-model'
+import { createDocument } from '../helpers/createDocument'
+import { RawCommands, Content } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     setContent: {
       /**
        * Replace the whole document with new content.
        */
       setContent: (
         content: Content,
-        emitUpdate?: Boolean,
-        parseOptions?: AnyObject,
-      ) => Command,
+        emitUpdate?: boolean,
+        parseOptions?: ParseOptions,
+      ) => ReturnType,
     }
   }
 }

package/src/commands/setMark.ts

@@ -1,15 +1,15 @@
 import { MarkType } from 'prosemirror-model'
-import { AnyObject, Command, RawCommands } from '../types'
-import getMarkType from '../helpers/getMarkType'
-import getMarkAttributes from '../helpers/getMarkAttributes'
+import { RawCommands } from '../types'
+import { getMarkType } from '../helpers/getMarkType'
+import { getMarkAttributes } from '../helpers/getMarkAttributes'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     setMark: {
       /**
        * Add a mark with new attributes.
        */
-      setMark: (typeOrName: string | MarkType, attributes?: AnyObject) => Command,
+      setMark: (typeOrName: string | MarkType, attributes?: Record<string, any>) => ReturnType,
     }
   }
 }
@@ -18,18 +18,41 @@ export const setMark: RawCommands['setMark'] = (typeOrName, attributes = {}) =>
   const { selection } = tr
   const { empty, ranges } = selection
   const type = getMarkType(typeOrName, state.schema)
-  const oldAttributes = getMarkAttributes(state, type)
-  const newAttributes = {
-    ...oldAttributes,
-    ...attributes,
-  }
 
   if (dispatch) {
     if (empty) {
-      tr.addStoredMark(type.create(newAttributes))
+      const oldAttributes = getMarkAttributes(state, type)
+
+      tr.addStoredMark(type.create({
+        ...oldAttributes,
+        ...attributes,
+      }))
     } else {
       ranges.forEach(range => {
-        tr.addMark(range.$from.pos, range.$to.pos, type.create(newAttributes))
+        const from = range.$from.pos
+        const to = range.$to.pos
+
+        state.doc.nodesBetween(from, to, (node, pos) => {
+          const trimmedFrom = Math.max(pos, from)
+          const trimmedTo = Math.min(pos + node.nodeSize, to)
+          const someHasMark = node.marks.find(mark => mark.type === type)
+
+          // if there is already a mark of this type
+          // we know that we have to merge its attributes
+          // otherwise we add a fresh new mark
+          if (someHasMark) {
+            node.marks.forEach(mark => {
+              if (type === mark.type) {
+                tr.addMark(trimmedFrom, trimmedTo, type.create({
+                  ...mark.attrs,
+                  ...attributes,
+                }))
+              }
+            })
+          } else {
+            tr.addMark(trimmedFrom, trimmedTo, type.create(attributes))
+          }
+        })
       })
     }
   }

package/src/commands/setMeta.ts

@@ -0,0 +1,18 @@
+import { RawCommands } from '../types'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    setMeta: {
+      /**
+       * Store a metadata property in the current transaction.
+       */
+      setMeta: (key: string, value: any) => ReturnType,
+    }
+  }
+}
+
+export const setMeta: RawCommands['setMeta'] = (key, value) => ({ tr }) => {
+  tr.setMeta(key, value)
+
+  return true
+}

package/src/commands/setNode.ts

@@ -1,21 +1,42 @@
 import { NodeType } from 'prosemirror-model'
 import { setBlockType } from 'prosemirror-commands'
-import { AnyObject, Command, RawCommands } from '../types'
-import getNodeType from '../helpers/getNodeType'
+import { RawCommands } from '../types'
+import { getNodeType } from '../helpers/getNodeType'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     setNode: {
       /**
        * Replace a given range with a node.
        */
-      setNode: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
+      setNode: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType,
     }
   }
 }
 
-export const setNode: RawCommands['setNode'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
+export const setNode: RawCommands['setNode'] = (typeOrName, attributes = {}) => ({ state, dispatch, chain }) => {
   const type = getNodeType(typeOrName, state.schema)
 
-  return setBlockType(type, attributes)(state, dispatch)
+  // TODO: use a fallback like insertContent?
+  if (!type.isTextblock) {
+    console.warn('[tiptap warn]: Currently "setNode()" only supports text block nodes.')
+
+    return false
+  }
+
+  return chain()
+    // try to convert node to default node if needed
+    .command(({ commands }) => {
+      const canSetBlock = setBlockType(type, attributes)(state)
+
+      if (canSetBlock) {
+        return true
+      }
+
+      return commands.clearNodes()
+    })
+    .command(({ state: updatedState }) => {
+      return setBlockType(type, attributes)(updatedState, dispatch)
+    })
+    .run()
 }

package/src/commands/setNodeSelection.ts

@@ -0,0 +1,28 @@
+import { Selection, NodeSelection } from 'prosemirror-state'
+import { minMax } from '../utilities/minMax'
+import { RawCommands } from '../types'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    setNodeSelection: {
+      /**
+       * Creates a NodeSelection.
+       */
+      setNodeSelection: (position: number) => ReturnType,
+    }
+  }
+}
+
+export const setNodeSelection: RawCommands['setNodeSelection'] = position => ({ tr, dispatch }) => {
+  if (dispatch) {
+    const { doc } = tr
+    const minPos = Selection.atStart(doc).from
+    const maxPos = Selection.atEnd(doc).to
+    const resolvedPos = minMax(position, minPos, maxPos)
+    const selection = NodeSelection.create(doc, resolvedPos)
+
+    tr.setSelection(selection)
+  }
+
+  return true
+}

package/src/commands/setTextSelection.ts

@@ -0,0 +1,32 @@
+import { Selection, TextSelection } from 'prosemirror-state'
+import { minMax } from '../utilities/minMax'
+import { RawCommands, Range } from '../types'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    setTextSelection: {
+      /**
+       * Creates a TextSelection.
+       */
+      setTextSelection: (position: number | Range) => ReturnType,
+    }
+  }
+}
+
+export const setTextSelection: RawCommands['setTextSelection'] = position => ({ tr, dispatch }) => {
+  if (dispatch) {
+    const { doc } = tr
+    const { from, to } = typeof position === 'number'
+      ? { from: position, to: position }
+      : position
+    const minPos = 0
+    const maxPos = tr.doc.content.size
+    const resolvedFrom = minMax(from, minPos, maxPos)
+    const resolvedEnd = minMax(to, minPos, maxPos)
+    const selection = TextSelection.create(doc, resolvedFrom, resolvedEnd)
+
+    tr.setSelection(selection)
+  }
+
+  return true
+}

package/src/commands/sinkListItem.ts

@@ -1,15 +1,15 @@
 import { sinkListItem as originalSinkListItem } from 'prosemirror-schema-list'
 import { NodeType } from 'prosemirror-model'
-import { Command, RawCommands } from '../types'
-import getNodeType from '../helpers/getNodeType'
+import { RawCommands } from '../types'
+import { getNodeType } from '../helpers/getNodeType'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     sinkListItem: {
       /**
        * Sink the list item down into an inner list.
        */
-      sinkListItem: (typeOrName: string | NodeType) => Command,
+      sinkListItem: (typeOrName: string | NodeType) => ReturnType,
     }
   }
 }

package/src/commands/splitBlock.ts

@@ -1,11 +1,11 @@
 import { canSplit } from 'prosemirror-transform'
-import { ContentMatch, Fragment } from 'prosemirror-model'
+import { ContentMatch } from 'prosemirror-model'
 import { EditorState, NodeSelection, TextSelection } from 'prosemirror-state'
-import { Command, RawCommands } from '../types'
-import getSplittedAttributes from '../helpers/getSplittedAttributes'
+import { RawCommands } from '../types'
+import { getSplittedAttributes } from '../helpers/getSplittedAttributes'
 
 function defaultBlockAt(match: ContentMatch) {
-  for (let i = 0; i < match.edgeCount; i + 1) {
+  for (let i = 0; i < match.edgeCount; i += 1) {
     const { type } = match.edge(i)
 
     if (type.isTextblock && !type.hasRequiredAttrs()) {
@@ -27,12 +27,12 @@ function ensureMarks(state: EditorState, splittableMarks?: string[]) {
 }
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     splitBlock: {
       /**
        * Forks a new node from an existing node.
        */
-      splitBlock: (options?: { keepMarks?: boolean }) => Command,
+      splitBlock: (options?: { keepMarks?: boolean }) => ReturnType,
     }
   }
 }
@@ -110,12 +110,17 @@ export const splitBlock: RawCommands['splitBlock'] = ({ keepMarks = true } = {})
       tr.split(tr.mapping.map($from.pos), 1, types)
 
       if (
-        !atEnd
+        deflt
+        && !atEnd
         && !$from.parentOffset
         && $from.parent.type !== deflt
-        && $from.node(-1).canReplace($from.index(-1), $from.indexAfter(-1), Fragment.from(deflt?.create()))
       ) {
-        tr.setNodeMarkup(tr.mapping.map($from.before()), deflt || undefined)
+        const first = tr.mapping.map($from.before())
+        const $first = tr.doc.resolve(first)
+
+        if ($from.node(-1).canReplaceWith($first.index(), $first.index() + 1, deflt)) {
+          tr.setNodeMarkup(tr.mapping.map($from.before()), deflt)
+        }
       }
     }
 

package/src/commands/splitListItem.ts

@@ -6,17 +6,17 @@ import {
 } from 'prosemirror-model'
 import { canSplit } from 'prosemirror-transform'
 import { TextSelection } from 'prosemirror-state'
-import { Command, RawCommands } from '../types'
-import getNodeType from '../helpers/getNodeType'
-import getSplittedAttributes from '../helpers/getSplittedAttributes'
+import { RawCommands } from '../types'
+import { getNodeType } from '../helpers/getNodeType'
+import { getSplittedAttributes } from '../helpers/getSplittedAttributes'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     splitListItem: {
       /**
        * Splits one list item into two list items.
        */
-      splitListItem: (typeOrName: string | NodeType) => Command,
+      splitListItem: (typeOrName: string | NodeType) => ReturnType,
     }
   }
 }
@@ -57,14 +57,26 @@ export const splitListItem: RawCommands['splitListItem'] = typeOrName => ({
 
     if (dispatch) {
       let wrap = Fragment.empty
-      const keepItem = $from.index(-1) > 0
+      // eslint-disable-next-line
+      const depthBefore = $from.index(-1)
+        ? 1
+        : $from.index(-2)
+          ? 2
+          : 3
 
       // Build a fragment containing empty versions of the structure
       // from the outer list item to the parent node of the cursor
-      for (let d = $from.depth - (keepItem ? 1 : 2); d >= $from.depth - 3; d -= 1) {
+      for (let d = $from.depth - depthBefore; d >= $from.depth - 3; d -= 1) {
         wrap = Fragment.from($from.node(d).copy(wrap))
       }
 
+      // eslint-disable-next-line
+      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,
@@ -72,16 +84,30 @@ export const splitListItem: RawCommands['splitListItem'] = typeOrName => ({
         $from.node().attrs,
       )
       const nextType = type.contentMatch.defaultType?.createAndFill(newNextTypeAttributes) || undefined
+
       wrap = wrap.append(Fragment.from(type.createAndFill(null, nextType) || undefined))
 
-      tr
-        .replace(
-          $from.before(keepItem ? undefined : -1),
-          $from.after(-3),
-          new Slice(wrap, keepItem ? 3 : 2, 2),
-        )
-        .setSelection(TextSelection.near(tr.doc.resolve($from.pos + (keepItem ? 3 : 2))))
-        .scrollIntoView()
+      const start = $from.before($from.depth - (depthBefore - 1))
+
+      tr.replace(start, $from.after(-depthAfter), new Slice(wrap, 4 - depthBefore, 0))
+
+      let sel = -1
+
+      tr.doc.nodesBetween(start, tr.doc.content.size, (n, pos) => {
+        if (sel > -1) {
+          return false
+        }
+
+        if (n.isTextblock && n.content.size === 0) {
+          sel = pos + 1
+        }
+      })
+
+      if (sel > -1) {
+        tr.setSelection(TextSelection.near(tr.doc.resolve(sel)))
+      }
+
+      tr.scrollIntoView()
     }
 
     return true

package/src/commands/toggleList.ts

@@ -1,16 +1,70 @@
 import { NodeType } from 'prosemirror-model'
-import { Command, RawCommands } from '../types'
-import getNodeType from '../helpers/getNodeType'
-import findParentNode from '../helpers/findParentNode'
-import isList from '../helpers/isList'
+import { Transaction } from 'prosemirror-state'
+import { canJoin } from 'prosemirror-transform'
+import { RawCommands } from '../types'
+import { getNodeType } from '../helpers/getNodeType'
+import { findParentNode } from '../helpers/findParentNode'
+import { isList } from '../helpers/isList'
+
+const joinListBackwards = (tr: Transaction, listType: NodeType): boolean => {
+  const list = findParentNode(node => node.type === listType)(tr.selection)
+
+  if (!list) {
+    return true
+  }
+
+  const before = tr.doc.resolve(Math.max(0, list.pos - 1)).before(list.depth)
+
+  if (before === undefined) {
+    return true
+  }
+
+  const nodeBefore = tr.doc.nodeAt(before)
+  const canJoinBackwards = list.node.type === nodeBefore?.type
+    && canJoin(tr.doc, list.pos)
+
+  if (!canJoinBackwards) {
+    return true
+  }
+
+  tr.join(list.pos)
+
+  return true
+}
+
+const joinListForwards = (tr: Transaction, listType: NodeType): boolean => {
+  const list = findParentNode(node => node.type === listType)(tr.selection)
+
+  if (!list) {
+    return true
+  }
+
+  const after = tr.doc.resolve(list.start).after(list.depth)
+
+  if (after === undefined) {
+    return true
+  }
+
+  const nodeAfter = tr.doc.nodeAt(after)
+  const canJoinForwards = list.node.type === nodeAfter?.type
+    && canJoin(tr.doc, after)
+
+  if (!canJoinForwards) {
+    return true
+  }
+
+  tr.join(after)
+
+  return true
+}
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     toggleList: {
       /**
        * Toggle between different list types.
        */
-      toggleList: (listTypeOrName: string | NodeType, itemTypeOrName: string | NodeType) => Command,
+      toggleList: (listTypeOrName: string | NodeType, itemTypeOrName: string | NodeType) => ReturnType,
     }
   }
 }
@@ -18,7 +72,7 @@ declare module '@tiptap/core' {
 export const toggleList: RawCommands['toggleList'] = (listTypeOrName, itemTypeOrName) => ({
   editor, tr, state, dispatch, chain, commands, can,
 }) => {
-  const { extensions } = editor.options
+  const { extensions } = editor.extensionManager
   const listType = getNodeType(listTypeOrName, state.schema)
   const itemType = getNodeType(itemTypeOrName, state.schema)
   const { selection } = state
@@ -43,21 +97,31 @@ export const toggleList: RawCommands['toggleList'] = (listTypeOrName, itemTypeOr
       && listType.validContent(parentList.node.content)
       && dispatch
     ) {
-      tr.setNodeMarkup(parentList.pos, listType)
+      return chain()
+        .command(() => {
+          tr.setNodeMarkup(parentList.pos, listType)
 
-      return true
+          return true
+        })
+        .command(() => joinListBackwards(tr, listType))
+        .command(() => joinListForwards(tr, listType))
+        .run()
     }
   }
 
-  const canWrapInList = can().wrapInList(listType)
+  return chain()
+    // try to convert node to default node if needed
+    .command(() => {
+      const canWrapInList = can().wrapInList(listType)
 
-  // try to convert node to paragraph if needed
-  if (!canWrapInList) {
-    return chain()
-      .clearNodes()
-      .wrapInList(listType)
-      .run()
-  }
+      if (canWrapInList) {
+        return true
+      }
 
-  return commands.wrapInList(listType)
+      return commands.clearNodes()
+    })
+    .wrapInList(listType)
+    .command(() => joinListBackwards(tr, listType))
+    .command(() => joinListForwards(tr, listType))
+    .run()
 }