@tiptap/core 2.0.0-beta.2 → 2.0.0-beta.200

package/src/commands/newlineInCode.ts

@@ -1,13 +1,14 @@
 import { newlineInCode as originalNewlineInCode } from 'prosemirror-commands'
-import { Command, RawCommands } from '../types'
+
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     newlineInCode: {
       /**
        * Add a newline character in code.
        */
-      newlineInCode: () => Command,
+      newlineInCode: () => ReturnType,
     }
   }
 }

package/src/commands/resetAttributes.ts

@@ -0,0 +1,62 @@
+import { MarkType, NodeType } from 'prosemirror-model'
+
+import { getMarkType } from '../helpers/getMarkType'
+import { getNodeType } from '../helpers/getNodeType'
+import { getSchemaTypeNameByName } from '../helpers/getSchemaTypeNameByName'
+import { RawCommands } from '../types'
+import { deleteProps } from '../utilities/deleteProps'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    resetAttributes: {
+      /**
+       * Resets some node attributes to the default value.
+       */
+      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
+
+  const schemaType = getSchemaTypeNameByName(
+    typeof typeOrName === 'string'
+      ? typeOrName
+      : typeOrName.name,
+    state.schema,
+  )
+
+  if (!schemaType) {
+    return false
+  }
+
+  if (schemaType === 'node') {
+    nodeType = getNodeType(typeOrName as NodeType, 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 (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
+}

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,14 @@
 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,14 @@
 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,14 @@
 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,20 @@
+// @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,20 @@
+// @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,26 +1,29 @@
-import { TextSelection } from 'prosemirror-state'
-import { AnyObject, Command, RawCommands } from '../types'
+import { ParseOptions } from 'prosemirror-model'
+
+import { createDocument } from '../helpers/createDocument'
+import { Content, RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     setContent: {
       /**
        * Replace the whole document with new content.
        */
-      setContent: (content: string, emitUpdate?: Boolean, parseOptions?: AnyObject) => Command,
+      setContent: (
+        content: Content,
+        emitUpdate?: boolean,
+        parseOptions?: ParseOptions,
+      ) => ReturnType,
     }
   }
 }
 
 export const setContent: RawCommands['setContent'] = (content, emitUpdate = false, parseOptions = {}) => ({ tr, editor, dispatch }) => {
-  const { createDocument } = editor
   const { doc } = tr
-  const document = createDocument(content, parseOptions)
-  const selection = TextSelection.create(doc, 0, doc.content.size)
+  const document = createDocument(content, editor.schema, parseOptions)
 
   if (dispatch) {
-    tr.setSelection(selection)
-      .replaceSelectionWith(document, false)
+    tr.replaceWith(0, doc.content.size, document)
       .setMeta('preventUpdate', !emitUpdate)
   }
 

package/src/commands/setMark.ts

@@ -1,36 +1,104 @@
-import { MarkType } from 'prosemirror-model'
-import { AnyObject, Command, RawCommands } from '../types'
-import getMarkType from '../helpers/getMarkType'
-import getMarkAttributes from '../helpers/getMarkAttributes'
+import { MarkType, ResolvedPos } from 'prosemirror-model'
+import { EditorState, Transaction } from 'prosemirror-state'
+
+import { isTextSelection } from '../helpers'
+import { getMarkAttributes } from '../helpers/getMarkAttributes'
+import { getMarkType } from '../helpers/getMarkType'
+import { RawCommands } from '../types'
 
 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,
     }
   }
 }
 
+function canSetMark(state: EditorState, tr: Transaction, newMarkType: MarkType) {
+  const { selection } = tr
+  let cursor: ResolvedPos | null = null
+
+  if (isTextSelection(selection)) {
+    cursor = selection.$cursor
+  }
+
+  if (cursor) {
+    const currentMarks = state.storedMarks ?? cursor.marks()
+
+    // There can be no current marks that exclude the new mark
+    return !!newMarkType.isInSet(currentMarks) || !currentMarks.some(mark => mark.type.excludes(newMarkType))
+  }
+
+  const { ranges } = selection
+
+  return ranges.some(({ $from, $to }) => {
+    let someNodeSupportsMark = $from.depth === 0 ? state.doc.inlineContent && state.doc.type.allowsMarkType(newMarkType) : false
+
+    state.doc.nodesBetween($from.pos, $to.pos, (node, _pos, parent) => {
+      // If we already found a mark that we can enable, return false to bypass the remaining search
+      if (someNodeSupportsMark) {
+        return false
+      }
+
+      if (node.isInline) {
+        const parentAllowsMarkType = !parent || parent.type.allowsMarkType(newMarkType)
+        const currentMarksAllowMarkType = !!newMarkType.isInSet(node.marks) || !node.marks.some(otherMark => otherMark.type.excludes(newMarkType))
+
+        someNodeSupportsMark = parentAllowsMarkType && currentMarksAllowMarkType
+      }
+      return !someNodeSupportsMark
+    })
+
+    return someNodeSupportsMark
+  })
+
+}
 export const setMark: RawCommands['setMark'] = (typeOrName, attributes = {}) => ({ tr, state, dispatch }) => {
   const { selection } = tr
-  const { from, to, empty } = selection
+  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 {
-      tr.addMark(from, to, type.create(newAttributes))
+      ranges.forEach(range => {
+        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))
+          }
+        })
+      })
     }
   }
 
-  return true
+  return canSetMark(state, tr, type)
 }

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,43 @@
-import { NodeType } from 'prosemirror-model'
 import { setBlockType } from 'prosemirror-commands'
-import { AnyObject, Command, RawCommands } from '../types'
-import getNodeType from '../helpers/getNodeType'
+import { NodeType } from 'prosemirror-model'
+
+import { getNodeType } from '../helpers/getNodeType'
+import { RawCommands } from '../types'
 
 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,27 @@
+import { NodeSelection } from 'prosemirror-state'
+
+import { RawCommands } from '../types'
+import { minMax } from '../utilities/minMax'
+
+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 from = minMax(position, 0, doc.content.size)
+    const selection = NodeSelection.create(doc, from)
+
+    tr.setSelection(selection)
+  }
+
+  return true
+}

package/src/commands/setTextSelection.ts

@@ -0,0 +1,33 @@
+import { TextSelection } from 'prosemirror-state'
+
+import { Range, RawCommands } from '../types'
+import { minMax } from '../utilities/minMax'
+
+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 = TextSelection.atStart(doc).from
+    const maxPos = TextSelection.atEnd(doc).to
+    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,16 @@
-import { sinkListItem as originalSinkListItem } from 'prosemirror-schema-list'
 import { NodeType } from 'prosemirror-model'
-import { Command, RawCommands } from '../types'
-import getNodeType from '../helpers/getNodeType'
+import { sinkListItem as originalSinkListItem } from 'prosemirror-schema-list'
+
+import { getNodeType } from '../helpers/getNodeType'
+import { RawCommands } from '../types'
 
 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,36 +1,28 @@
-import { canSplit } from 'prosemirror-transform'
-import { ContentMatch, Fragment } from 'prosemirror-model'
 import { EditorState, NodeSelection, TextSelection } from 'prosemirror-state'
-import { Command, RawCommands } from '../types'
-import getSplittedAttributes from '../helpers/getSplittedAttributes'
-
-function defaultBlockAt(match: ContentMatch) {
-  for (let i = 0; i < match.edgeCount; i + 1) {
-    const { type } = match.edge(i)
+import { canSplit } from 'prosemirror-transform'
 
-    if (type.isTextblock && !type.hasRequiredAttrs()) {
-      return type
-    }
-  }
-  return null
-}
+import { defaultBlockAt } from '../helpers/defaultBlockAt'
+import { getSplittedAttributes } from '../helpers/getSplittedAttributes'
+import { RawCommands } from '../types'
 
-function ensureMarks(state: EditorState) {
+function ensureMarks(state: EditorState, splittableMarks?: string[]) {
   const marks = state.storedMarks
     || (state.selection.$to.parentOffset && state.selection.$from.marks())
 
   if (marks) {
-    state.tr.ensureMarks(marks)
+    const filteredMarks = marks.filter(mark => splittableMarks?.includes(mark.type.name))
+
+    state.tr.ensureMarks(filteredMarks)
   }
 }
 
 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,
     }
   }
 }
@@ -57,7 +49,7 @@ export const splitBlock: RawCommands['splitBlock'] = ({ keepMarks = true } = {})
 
     if (dispatch) {
       if (keepMarks) {
-        ensureMarks(state)
+        ensureMarks(state, editor.extensionManager.splittableMarks)
       }
 
       tr.split($from.pos).scrollIntoView()
@@ -108,17 +100,22 @@ 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)
+        }
       }
     }
 
     if (keepMarks) {
-      ensureMarks(state)
+      ensureMarks(state, editor.extensionManager.splittableMarks)
     }
 
     tr.scrollIntoView()