feat: add insertContent() command, deprecate insertText(), insertHTML() and insertNode()

packages/core/src/commands/insertContent.ts

@@ -0,0 +1,35 @@
+import createNodeFromContent from '../helpers/createNodeFromContent'
+import selectionToInsertionEnd from '../helpers/selectionToInsertionEnd'
+import { Command, RawCommands, Content } from '../types'
+
+declare module '@tiptap/core' {
+  interface Commands {
+    insertContent: {
+      /**
+       * Insert a node or string of HTML at the current position.
+       */
+      insertContent: (value: Content) => Command,
+    }
+  }
+}
+
+export const insertContent: RawCommands['insertContent'] = value => ({ tr, dispatch, editor }) => {
+  if (dispatch) {
+    const content = createNodeFromContent(value, editor.schema)
+
+    if (typeof content === 'string') {
+      tr.insertText(content)
+
+      return true
+    }
+
+    if (!tr.selection.empty) {
+      tr.deleteSelection()
+    }
+
+    tr.insert(tr.selection.anchor, content)
+    selectionToInsertionEnd(tr, tr.steps.length - 1, -1)
+  }
+
+  return true
+}

packages/core/src/commands/insertHTML.ts

@@ -15,6 +15,8 @@ declare module '@tiptap/core' {
 }
 
 export const insertHTML: RawCommands['insertHTML'] = value => ({ tr, state, dispatch }) => {
+  console.warn('[tiptap warn]: insertHTML() is deprecated. please use insertContent() instead.')
+
   const { selection } = tr
   const element = elementFromString(value)
   const slice = DOMParser.fromSchema(state.schema).parseSlice(element)

packages/core/src/commands/insertNode.ts

@@ -14,6 +14,8 @@ declare module '@tiptap/core' {
 }
 
 export const insertNode: RawCommands['insertNode'] = (typeOrName, attributes = {}) => ({ tr, state, dispatch }) => {
+  console.warn('[tiptap warn]: insertNode() is deprecated. please use insertContent() instead.')
+
   const { selection } = tr
   const type = getNodeType(typeOrName, state.schema)
 

packages/core/src/commands/insertText.ts

@@ -12,6 +12,8 @@ declare module '@tiptap/core' {
 }
 
 export const insertText: RawCommands['insertText'] = value => ({ tr, dispatch }) => {
+  console.warn('[tiptap warn]: insertText() is deprecated. please use insertContent() instead.')
+
   if (dispatch) {
     tr.insertText(value)
   }

packages/core/src/commands/setContent.ts

@@ -1,5 +1,11 @@
 import { TextSelection } from 'prosemirror-state'
-import { AnyObject, Command, RawCommands } from '../types'
+import createDocument from '../helpers/createDocument'
+import {
+  AnyObject,
+  Command,
+  RawCommands,
+  Content,
+} from '../types'
 
 declare module '@tiptap/core' {
   interface Commands {
@@ -7,15 +13,18 @@ declare module '@tiptap/core' {
       /**
        * Replace the whole document with new content.
        */
-      setContent: (content: string, emitUpdate?: Boolean, parseOptions?: AnyObject) => Command,
+      setContent: (
+        content: Content,
+        emitUpdate?: Boolean,
+        parseOptions?: AnyObject,
+      ) => Command,
     }
   }
 }
 
 export const setContent: RawCommands['setContent'] = (content, emitUpdate = false, parseOptions = {}) => ({ tr, editor, dispatch }) => {
-  const { createDocument } = editor
   const { doc } = tr
-  const document = createDocument(content, parseOptions)
+  const document = createDocument(content, editor.schema, parseOptions)
   const selection = TextSelection.create(doc, 0, doc.content.size)
 
   if (dispatch) {