@tiptap/core 2.0.0-beta.21 → 2.0.0-beta.210

package/src/commands/updateAttributes.ts

@@ -1,16 +1,20 @@
-import { NodeType, MarkType } from 'prosemirror-model'
-import getNodeType from '../helpers/getNodeType'
-import getMarkType from '../helpers/getMarkType'
-import getSchemaTypeNameByName from '../helpers/getSchemaTypeNameByName'
-import { AnyObject, Command, RawCommands } from '../types'
+import { MarkType, NodeType } from '@tiptap/pm/model'
+
+import { getMarkType } from '../helpers/getMarkType'
+import { getNodeType } from '../helpers/getNodeType'
+import { getSchemaTypeNameByName } from '../helpers/getSchemaTypeNameByName'
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     updateAttributes: {
       /**
        * Update attributes of a node or mark.
        */
-      updateAttributes: (typeOrName: string | NodeType | MarkType, attributes: AnyObject) => Command,
+      updateAttributes: (
+        typeOrName: string | NodeType | MarkType,
+        attributes: Record<string, any>,
+      ) => ReturnType
     }
   }
 }
@@ -20,9 +24,7 @@ export const updateAttributes: RawCommands['updateAttributes'] = (typeOrName, at
   let markType: MarkType | null = null
 
   const schemaType = getSchemaTypeNameByName(
-    typeof typeOrName === 'string'
-      ? typeOrName
-      : typeOrName.name,
+    typeof typeOrName === 'string' ? typeOrName : typeOrName.name,
     state.schema,
   )
 
@@ -40,7 +42,10 @@ export const updateAttributes: RawCommands['updateAttributes'] = (typeOrName, at
 
   if (dispatch) {
     tr.selection.ranges.forEach(range => {
-      state.doc.nodesBetween(range.$from.pos, range.$to.pos, (node, pos) => {
+      const from = range.$from.pos
+      const to = range.$to.pos
+
+      state.doc.nodesBetween(from, to, (node, pos) => {
         if (nodeType && nodeType === node.type) {
           tr.setNodeMarkup(pos, undefined, {
             ...node.attrs,
@@ -51,10 +56,17 @@ export const updateAttributes: RawCommands['updateAttributes'] = (typeOrName, at
         if (markType && node.marks.length) {
           node.marks.forEach(mark => {
             if (markType === mark.type) {
-              tr.addMark(pos, pos + node.nodeSize, markType.create({
-                ...mark.attrs,
-                ...attributes,
-              }))
+              const trimmedFrom = Math.max(pos, from)
+              const trimmedTo = Math.min(pos + node.nodeSize, to)
+
+              tr.addMark(
+                trimmedFrom,
+                trimmedTo,
+                markType.create({
+                  ...mark.attrs,
+                  ...attributes,
+                }),
+              )
             }
           })
         }

package/src/commands/wrapIn.ts

@@ -1,27 +1,22 @@
-import { wrapIn as originalWrapIn } from 'prosemirror-commands'
-import { NodeType } from 'prosemirror-model'
-import { AnyObject, Command, RawCommands } from '../types'
-import isNodeActive from '../helpers/isNodeActive'
-import getNodeType from '../helpers/getNodeType'
+import { wrapIn as originalWrapIn } from '@tiptap/pm/commands'
+import { NodeType } from '@tiptap/pm/model'
+
+import { getNodeType } from '../helpers/getNodeType'
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     wrapIn: {
       /**
        * Wraps nodes in another node.
        */
-      wrapIn: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
+      wrapIn: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType
     }
   }
 }
 
 export const wrapIn: RawCommands['wrapIn'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
   const type = getNodeType(typeOrName, state.schema)
-  const isActive = isNodeActive(state, type, attributes)
-
-  if (isActive) {
-    return false
-  }
 
   return originalWrapIn(type, attributes)(state, dispatch)
 }

package/src/commands/wrapInList.ts

@@ -1,15 +1,16 @@
-import { wrapInList as originalWrapInList } from 'prosemirror-schema-list'
-import { NodeType } from 'prosemirror-model'
-import { AnyObject, Command, RawCommands } from '../types'
-import getNodeType from '../helpers/getNodeType'
+import { NodeType } from '@tiptap/pm/model'
+import { wrapInList as originalWrapInList } from '@tiptap/pm/schema-list'
+
+import { getNodeType } from '../helpers/getNodeType'
+import { RawCommands } from '../types'
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     wrapInList: {
       /**
        * Wrap a node in a list.
        */
-      wrapInList: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
+      wrapInList: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType
     }
   }
 }

package/src/extensions/clipboardTextSerializer.ts

@@ -1,40 +1,11 @@
-import { Editor } from '@tiptap/core'
-import { Plugin, PluginKey } from 'prosemirror-state'
-import { Extension } from '../Extension'
-
-const textBetween = (
-  editor: Editor,
-  from: number,
-  to: number,
-  blockSeparator?: string,
-  leafText?: string,
-): string => {
-  let text = ''
-  let separated = true
-
-  editor.state.doc.nodesBetween(from, to, (node, pos) => {
-    const textSerializer = editor.extensionManager.textSerializers[node.type.name]
+import { Plugin, PluginKey } from '@tiptap/pm/state'
 
-    if (textSerializer) {
-      text += textSerializer({ node })
-      separated = !blockSeparator
-    } else if (node.isText) {
-      text += node?.text?.slice(Math.max(from, pos) - pos, to - pos)
-      separated = !blockSeparator
-    } else if (node.isLeaf && leafText) {
-      text += leafText
-      separated = !blockSeparator
-    } else if (!separated && node.isBlock) {
-      text += blockSeparator
-      separated = true
-    }
-  }, 0)
-
-  return text
-}
+import { Extension } from '../Extension'
+import { getTextBetween } from '../helpers/getTextBetween'
+import { getTextSerializersFromSchema } from '../helpers/getTextSerializersFromSchema'
 
 export const ClipboardTextSerializer = Extension.create({
-  name: 'editable',
+  name: 'clipboardTextSerializer',
 
   addProseMirrorPlugins() {
     return [
@@ -43,9 +14,17 @@ export const ClipboardTextSerializer = Extension.create({
         props: {
           clipboardTextSerializer: () => {
             const { editor } = this
-            const { from, to } = editor.state.selection
+            const { state, schema } = editor
+            const { doc, selection } = state
+            const { ranges } = selection
+            const from = Math.min(...ranges.map(range => range.$from.pos))
+            const to = Math.max(...ranges.map(range => range.$to.pos))
+            const textSerializers = getTextSerializersFromSchema(schema)
+            const range = { from, to }
 
-            return textBetween(editor, from, to, '\n')
+            return getTextBetween(doc, range, {
+              textSerializers,
+            })
           },
         },
       }),

package/src/extensions/commands.ts

@@ -1,158 +1,14 @@
+import * as commands from '../commands'
 import { Extension } from '../Extension'
-import * as blur from '../commands/blur'
-import * as clearContent from '../commands/clearContent'
-import * as clearNodes from '../commands/clearNodes'
-import * as command from '../commands/command'
-import * as createParagraphNear from '../commands/createParagraphNear'
-import * as deleteRange from '../commands/deleteRange'
-import * as deleteSelection from '../commands/deleteSelection'
-import * as enter from '../commands/enter'
-import * as exitCode from '../commands/exitCode'
-import * as extendMarkRange from '../commands/extendMarkRange'
-import * as first from '../commands/first'
-import * as focus from '../commands/focus'
-import * as insertContent from '../commands/insertContent'
-import * as insertHTML from '../commands/insertHTML'
-import * as insertNode from '../commands/insertNode'
-import * as insertText from '../commands/insertText'
-import * as joinBackward from '../commands/joinBackward'
-import * as joinForward from '../commands/joinForward'
-import * as keyboardShortcut from '../commands/keyboardShortcut'
-import * as lift from '../commands/lift'
-import * as liftEmptyBlock from '../commands/liftEmptyBlock'
-import * as liftListItem from '../commands/liftListItem'
-import * as newlineInCode from '../commands/newlineInCode'
-import * as replace from '../commands/replace'
-import * as replaceRange from '../commands/replaceRange'
-import * as resetAttributes from '../commands/resetAttributes'
-import * as resetNodeAttributes from '../commands/resetNodeAttributes'
-import * as scrollIntoView from '../commands/scrollIntoView'
-import * as selectAll from '../commands/selectAll'
-import * as selectNodeBackward from '../commands/selectNodeBackward'
-import * as selectNodeForward from '../commands/selectNodeForward'
-import * as selectParentNode from '../commands/selectParentNode'
-import * as setContent from '../commands/setContent'
-import * as setMark from '../commands/setMark'
-import * as setNode from '../commands/setNode'
-import * as sinkListItem from '../commands/sinkListItem'
-import * as splitBlock from '../commands/splitBlock'
-import * as splitListItem from '../commands/splitListItem'
-import * as toggleList from '../commands/toggleList'
-import * as toggleMark from '../commands/toggleMark'
-import * as toggleNode from '../commands/toggleNode'
-import * as toggleWrap from '../commands/toggleWrap'
-import * as undoInputRule from '../commands/undoInputRule'
-import * as unsetAllMarks from '../commands/unsetAllMarks'
-import * as unsetMark from '../commands/unsetMark'
-import * as updateAttributes from '../commands/updateAttributes'
-import * as updateNodeAttributes from '../commands/updateNodeAttributes'
-import * as wrapIn from '../commands/wrapIn'
-import * as wrapInList from '../commands/wrapInList'
 
-export { blur }
-export { clearContent }
-export { clearNodes }
-export { command }
-export { createParagraphNear }
-export { deleteRange }
-export { deleteSelection }
-export { enter }
-export { exitCode }
-export { extendMarkRange }
-export { first }
-export { focus }
-export { insertContent }
-export { insertHTML }
-export { insertNode }
-export { insertText }
-export { joinBackward }
-export { joinForward }
-export { keyboardShortcut }
-export { lift }
-export { liftEmptyBlock }
-export { liftListItem }
-export { newlineInCode }
-export { replace }
-export { replaceRange }
-export { resetAttributes }
-export { resetNodeAttributes }
-export { scrollIntoView }
-export { selectAll }
-export { selectNodeBackward }
-export { selectNodeForward }
-export { selectParentNode }
-export { setContent }
-export { setMark }
-export { setNode }
-export { sinkListItem }
-export { splitBlock }
-export { splitListItem }
-export { toggleList }
-export { toggleMark }
-export { toggleNode }
-export { toggleWrap }
-export { undoInputRule }
-export { unsetAllMarks }
-export { unsetMark }
-export { updateAttributes }
-export { updateNodeAttributes }
-export { wrapIn }
-export { wrapInList }
+export * from '../commands'
 
 export const Commands = Extension.create({
   name: 'commands',
 
   addCommands() {
     return {
-      ...blur,
-      ...clearContent,
-      ...clearNodes,
-      ...command,
-      ...createParagraphNear,
-      ...deleteRange,
-      ...deleteSelection,
-      ...enter,
-      ...exitCode,
-      ...extendMarkRange,
-      ...first,
-      ...focus,
-      ...insertContent,
-      ...insertHTML,
-      ...insertNode,
-      ...insertText,
-      ...joinBackward,
-      ...joinForward,
-      ...keyboardShortcut,
-      ...lift,
-      ...liftEmptyBlock,
-      ...liftListItem,
-      ...newlineInCode,
-      ...replace,
-      ...replaceRange,
-      ...resetAttributes,
-      ...resetNodeAttributes,
-      ...scrollIntoView,
-      ...selectAll,
-      ...selectNodeBackward,
-      ...selectNodeForward,
-      ...selectParentNode,
-      ...setContent,
-      ...setMark,
-      ...setNode,
-      ...sinkListItem,
-      ...splitBlock,
-      ...splitListItem,
-      ...toggleList,
-      ...toggleMark,
-      ...toggleNode,
-      ...toggleWrap,
-      ...undoInputRule,
-      ...unsetAllMarks,
-      ...unsetMark,
-      ...updateAttributes,
-      ...updateNodeAttributes,
-      ...wrapIn,
-      ...wrapInList,
+      ...commands,
     }
   },
 })

package/src/extensions/editable.ts

@@ -1,4 +1,5 @@
-import { Plugin, PluginKey } from 'prosemirror-state'
+import { Plugin, PluginKey } from '@tiptap/pm/state'
+
 import { Extension } from '../Extension'
 
 export const Editable = Extension.create({

package/src/extensions/focusEvents.ts

@@ -1,4 +1,5 @@
-import { Plugin, PluginKey } from 'prosemirror-state'
+import { Plugin, PluginKey } from '@tiptap/pm/state'
+
 import { Extension } from '../Extension'
 
 export const FocusEvents = Extension.create({
@@ -11,11 +12,8 @@ export const FocusEvents = Extension.create({
       new Plugin({
         key: new PluginKey('focusEvents'),
         props: {
-          attributes: {
-            tabindex: '0',
-          },
           handleDOMEvents: {
-            focus: (view, event) => {
+            focus: (view, event: Event) => {
               editor.isFocused = true
 
               const transaction = editor.state.tr
@@ -26,7 +24,7 @@ export const FocusEvents = Extension.create({
 
               return false
             },
-            blur: (view, event) => {
+            blur: (view, event: Event) => {
               editor.isFocused = false
 
               const transaction = editor.state.tr

package/src/extensions/index.ts

@@ -3,3 +3,4 @@ export { Commands } from './commands'
 export { Editable } from './editable'
 export { FocusEvents } from './focusEvents'
 export { Keymap } from './keymap'
+export { Tabindex } from './tabindex'

package/src/extensions/keymap.ts

@@ -1,4 +1,10 @@
+import { Plugin, PluginKey, Selection } from '@tiptap/pm/state'
+
+import { CommandManager } from '../CommandManager'
 import { Extension } from '../Extension'
+import { createChainableState } from '../helpers/createChainableState'
+import { isiOS } from '../utilities/isiOS'
+import { isMacOS } from '../utilities/isMacOS'
 
 export const Keymap = Extension.create({
   name: 'keymap',
@@ -6,6 +12,19 @@ export const Keymap = Extension.create({
   addKeyboardShortcuts() {
     const handleBackspace = () => this.editor.commands.first(({ commands }) => [
       () => commands.undoInputRule(),
+      // maybe convert first text block node to default node
+      () => commands.command(({ tr }) => {
+        const { selection, doc } = tr
+        const { empty, $anchor } = selection
+        const { pos, parent } = $anchor
+        const isAtStart = Selection.atStart(doc).from === pos
+
+        if (!empty || !isAtStart || !parent.type.isTextblock || parent.textContent.length) {
+          return false
+        }
+
+        return commands.clearNodes()
+      }),
       () => commands.deleteSelection(),
       () => commands.joinBackward(),
       () => commands.selectNodeBackward(),
@@ -13,24 +32,98 @@ export const Keymap = Extension.create({
 
     const handleDelete = () => this.editor.commands.first(({ commands }) => [
       () => commands.deleteSelection(),
+      () => commands.deleteCurrentNode(),
       () => commands.joinForward(),
       () => commands.selectNodeForward(),
     ])
 
-    return {
-      Enter: () => this.editor.commands.first(({ commands }) => [
-        () => commands.newlineInCode(),
-        () => commands.createParagraphNear(),
-        () => commands.liftEmptyBlock(),
-        () => commands.splitBlock(),
-      ]),
+    const handleEnter = () => this.editor.commands.first(({ commands }) => [
+      () => commands.newlineInCode(),
+      () => commands.createParagraphNear(),
+      () => commands.liftEmptyBlock(),
+      () => commands.splitBlock(),
+    ])
+
+    const baseKeymap = {
+      Enter: handleEnter,
       'Mod-Enter': () => this.editor.commands.exitCode(),
-      Backspace: () => handleBackspace(),
-      'Mod-Backspace': () => handleBackspace(),
-      Delete: () => handleDelete(),
-      'Mod-Delete': () => handleDelete(),
-      // we don’t need a custom `selectAll` for now
-      // 'Mod-a': () => this.editor.commands.selectAll(),
+      Backspace: handleBackspace,
+      'Mod-Backspace': handleBackspace,
+      'Shift-Backspace': handleBackspace,
+      Delete: handleDelete,
+      'Mod-Delete': handleDelete,
+      'Mod-a': () => this.editor.commands.selectAll(),
+    }
+
+    const pcKeymap = {
+      ...baseKeymap,
+    }
+
+    const macKeymap = {
+      ...baseKeymap,
+      'Ctrl-h': handleBackspace,
+      'Alt-Backspace': handleBackspace,
+      'Ctrl-d': handleDelete,
+      'Ctrl-Alt-Backspace': handleDelete,
+      'Alt-Delete': handleDelete,
+      'Alt-d': handleDelete,
+      'Ctrl-a': () => this.editor.commands.selectTextblockStart(),
+      'Ctrl-e': () => this.editor.commands.selectTextblockEnd(),
+    }
+
+    if (isiOS() || isMacOS()) {
+      return macKeymap
     }
+
+    return pcKeymap
+  },
+
+  addProseMirrorPlugins() {
+    return [
+      // With this plugin we check if the whole document was selected and deleted.
+      // In this case we will additionally call `clearNodes()` to convert e.g. a heading
+      // to a paragraph if necessary.
+      // This is an alternative to ProseMirror's `AllSelection`, which doesn’t work well
+      // with many other commands.
+      new Plugin({
+        key: new PluginKey('clearDocument'),
+        appendTransaction: (transactions, oldState, newState) => {
+          const docChanges = transactions.some(transaction => transaction.docChanged)
+            && !oldState.doc.eq(newState.doc)
+
+          if (!docChanges) {
+            return
+          }
+
+          const { empty, from, to } = oldState.selection
+          const allFrom = Selection.atStart(oldState.doc).from
+          const allEnd = Selection.atEnd(oldState.doc).to
+          const allWasSelected = from === allFrom && to === allEnd
+          const isEmpty = newState.doc.textBetween(0, newState.doc.content.size, ' ', ' ').length === 0
+
+          if (empty || !allWasSelected || !isEmpty) {
+            return
+          }
+
+          const tr = newState.tr
+          const state = createChainableState({
+            state: newState,
+            transaction: tr,
+          })
+          const { commands } = new CommandManager({
+            editor: this.editor,
+            state,
+          })
+
+          commands.clearNodes()
+
+          if (!tr.steps.length) {
+            return
+          }
+
+          return tr
+        },
+      }),
+    ]
   },
 })

package/src/extensions/tabindex.ts

@@ -0,0 +1,18 @@
+import { Plugin, PluginKey } from '@tiptap/pm/state'
+
+import { Extension } from '../Extension'
+
+export const Tabindex = Extension.create({
+  name: 'tabindex',
+
+  addProseMirrorPlugins() {
+    return [
+      new Plugin({
+        key: new PluginKey('tabindex'),
+        props: {
+          attributes: this.editor.isEditable ? { tabindex: '0' } : {},
+        },
+      }),
+    ]
+  },
+})

package/src/helpers/combineTransactionSteps.ts

@@ -0,0 +1,21 @@
+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.
+ */
+export function combineTransactionSteps(
+  oldDoc: ProseMirrorNode,
+  transactions: Transaction[],
+): Transform {
+  const transform = new Transform(oldDoc)
+
+  transactions.forEach(transaction => {
+    transaction.steps.forEach(step => {
+      transform.step(step)
+    })
+  })
+
+  return transform
+}

package/src/helpers/createChainableState.ts

@@ -0,0 +1,38 @@
+import { EditorState, Transaction } from '@tiptap/pm/state'
+
+export function createChainableState(config: {
+  transaction: Transaction
+  state: EditorState
+}): EditorState {
+  const { state, transaction } = config
+  let { selection } = transaction
+  let { doc } = transaction
+  let { storedMarks } = transaction
+
+  return {
+    ...state,
+    apply: state.apply.bind(state),
+    applyTransaction: state.applyTransaction.bind(state),
+    filterTransaction: state.filterTransaction,
+    plugins: state.plugins,
+    schema: state.schema,
+    reconfigure: state.reconfigure.bind(state),
+    toJSON: state.toJSON.bind(state),
+    get storedMarks() {
+      return storedMarks
+    },
+    get selection() {
+      return selection
+    },
+    get doc() {
+      return doc
+    },
+    get tr() {
+      selection = transaction.selection
+      doc = transaction.doc
+      storedMarks = transaction.storedMarks
+
+      return transaction
+    },
+  }
+}

package/src/helpers/createDocument.ts

@@ -1,13 +1,12 @@
-import { Schema, Node as ProseMirrorNode } from 'prosemirror-model'
-import { AnyObject } from '../types'
-import createNodeFromContent from './createNodeFromContent'
+import { Node as ProseMirrorNode, ParseOptions, Schema } from '@tiptap/pm/model'
 
-export type Content = string | JSON | null
+import { Content } from '../types'
+import { createNodeFromContent } from './createNodeFromContent'
 
-export default function createDocument(
+export function createDocument(
   content: Content,
   schema: Schema,
-  parseOptions: AnyObject = {},
+  parseOptions: ParseOptions = {},
 ): ProseMirrorNode {
   return createNodeFromContent(content, schema, { slice: false, parseOptions }) as ProseMirrorNode
 }