@tiptap/core 3.0.0-next.3 → 3.0.0-next.4

package/src/commands/unsetMark.ts

@@ -30,34 +30,36 @@ declare module '@tiptap/core' {
   }
 }
 
-export const unsetMark: RawCommands['unsetMark'] = (typeOrName, options = {}) => ({ tr, state, dispatch }) => {
-  const { extendEmptyMarkRange = false } = options
-  const { selection } = tr
-  const type = getMarkType(typeOrName, state.schema)
-  const { $from, empty, ranges } = selection
+export const unsetMark: RawCommands['unsetMark'] =
+  (typeOrName, options = {}) =>
+  ({ tr, state, dispatch }) => {
+    const { extendEmptyMarkRange = false } = options
+    const { selection } = tr
+    const type = getMarkType(typeOrName, state.schema)
+    const { $from, empty, ranges } = selection
 
-  if (!dispatch) {
-    return true
-  }
+    if (!dispatch) {
+      return true
+    }
 
-  if (empty && extendEmptyMarkRange) {
-    let { from, to } = selection
-    const attrs = $from.marks().find(mark => mark.type === type)?.attrs
-    const range = getMarkRange($from, type, attrs)
+    if (empty && extendEmptyMarkRange) {
+      let { from, to } = selection
+      const attrs = $from.marks().find(mark => mark.type === type)?.attrs
+      const range = getMarkRange($from, type, attrs)
 
-    if (range) {
-      from = range.from
-      to = range.to
-    }
+      if (range) {
+        from = range.from
+        to = range.to
+      }
 
-    tr.removeMark(from, to, type)
-  } else {
-    ranges.forEach(range => {
-      tr.removeMark(range.$from.pos, range.$to.pos, type)
-    })
-  }
+      tr.removeMark(from, to, type)
+    } else {
+      ranges.forEach(range => {
+        tr.removeMark(range.$from.pos, range.$to.pos, type)
+      })
+    }
 
-  tr.removeStoredMark(type)
+    tr.removeStoredMark(type)
 
-  return true
-}
+    return true
+  }

package/src/commands/updateAttributes.ts

@@ -1,6 +1,4 @@
-import {
-  Mark, MarkType, Node, NodeType,
-} from '@tiptap/pm/model'
+import { Mark, MarkType, Node, NodeType } from '@tiptap/pm/model'
 import { SelectionRange } from '@tiptap/pm/state'
 
 import { getMarkType } from '../helpers/getMarkType.js'
@@ -32,117 +30,111 @@ declare module '@tiptap/core' {
   }
 }
 
-export const updateAttributes: RawCommands['updateAttributes'] = (typeOrName, attributes = {}) => ({ tr, state, dispatch }) => {
+export const updateAttributes: RawCommands['updateAttributes'] =
+  (typeOrName, attributes = {}) =>
+  ({ tr, state, dispatch }) => {
+    let nodeType: NodeType | null = null
+    let markType: MarkType | null = null
 
-  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 === '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: SelectionRange) => {
+    if (!schemaType) {
+      return false
+    }
 
-      const from = range.$from.pos
-      const to = range.$to.pos
+    if (schemaType === 'node') {
+      nodeType = getNodeType(typeOrName as NodeType, state.schema)
+    }
 
-      let lastPos: number | undefined
-      let lastNode: Node | undefined
-      let trimmedFrom: number
-      let trimmedTo: number
+    if (schemaType === 'mark') {
+      markType = getMarkType(typeOrName as MarkType, state.schema)
+    }
 
-      if (tr.selection.empty) {
-        state.doc.nodesBetween(from, to, (node: Node, pos: number) => {
+    if (dispatch) {
+      tr.selection.ranges.forEach((range: SelectionRange) => {
+        const from = range.$from.pos
+        const to = range.$to.pos
 
-          if (nodeType && nodeType === node.type) {
-            trimmedFrom = Math.max(pos, from)
-            trimmedTo = Math.min(pos + node.nodeSize, to)
-            lastPos = pos
-            lastNode = node
-          }
-        })
-      } else {
-        state.doc.nodesBetween(from, to, (node: Node, pos: number) => {
-
-          if (pos < from && nodeType && nodeType === node.type) {
-            trimmedFrom = Math.max(pos, from)
-            trimmedTo = Math.min(pos + node.nodeSize, to)
-            lastPos = pos
-            lastNode = node
-          }
-
-          if (pos >= from && pos <= to) {
+        let lastPos: number | undefined
+        let lastNode: Node | undefined
+        let trimmedFrom: number
+        let trimmedTo: number
 
+        if (tr.selection.empty) {
+          state.doc.nodesBetween(from, to, (node: Node, pos: number) => {
             if (nodeType && nodeType === node.type) {
-              tr.setNodeMarkup(pos, undefined, {
-                ...node.attrs,
-                ...attributes,
-              })
+              trimmedFrom = Math.max(pos, from)
+              trimmedTo = Math.min(pos + node.nodeSize, to)
+              lastPos = pos
+              lastNode = node
             }
-
-            if (markType && node.marks.length) {
-              node.marks.forEach((mark: Mark) => {
-
-                if (markType === mark.type) {
-                  const trimmedFrom2 = Math.max(pos, from)
-                  const trimmedTo2 = Math.min(pos + node.nodeSize, to)
-
-                  tr.addMark(
-                    trimmedFrom2,
-                    trimmedTo2,
-                    markType.create({
-                      ...mark.attrs,
-                      ...attributes,
-                    }),
-                  )
-                }
-              })
+          })
+        } else {
+          state.doc.nodesBetween(from, to, (node: Node, pos: number) => {
+            if (pos < from && nodeType && nodeType === node.type) {
+              trimmedFrom = Math.max(pos, from)
+              trimmedTo = Math.min(pos + node.nodeSize, to)
+              lastPos = pos
+              lastNode = node
             }
-          }
-        })
-      }
 
-      if (lastNode) {
-
-        if (lastPos !== undefined) {
-          tr.setNodeMarkup(lastPos, undefined, {
-            ...lastNode.attrs,
-            ...attributes,
+            if (pos >= from && pos <= to) {
+              if (nodeType && nodeType === node.type) {
+                tr.setNodeMarkup(pos, undefined, {
+                  ...node.attrs,
+                  ...attributes,
+                })
+              }
+
+              if (markType && node.marks.length) {
+                node.marks.forEach((mark: Mark) => {
+                  if (markType === mark.type) {
+                    const trimmedFrom2 = Math.max(pos, from)
+                    const trimmedTo2 = Math.min(pos + node.nodeSize, to)
+
+                    tr.addMark(
+                      trimmedFrom2,
+                      trimmedTo2,
+                      markType.create({
+                        ...mark.attrs,
+                        ...attributes,
+                      }),
+                    )
+                  }
+                })
+              }
+            }
           })
         }
 
-        if (markType && lastNode.marks.length) {
-          lastNode.marks.forEach((mark: Mark) => {
+        if (lastNode) {
+          if (lastPos !== undefined) {
+            tr.setNodeMarkup(lastPos, undefined, {
+              ...lastNode.attrs,
+              ...attributes,
+            })
+          }
 
-            if (markType === mark.type) {
-              tr.addMark(
-                trimmedFrom,
-                trimmedTo,
-                markType.create({
-                  ...mark.attrs,
-                  ...attributes,
-                }),
-              )
-            }
-          })
+          if (markType && lastNode.marks.length) {
+            lastNode.marks.forEach((mark: Mark) => {
+              if (markType === mark.type) {
+                tr.addMark(
+                  trimmedFrom,
+                  trimmedTo,
+                  markType.create({
+                    ...mark.attrs,
+                    ...attributes,
+                  }),
+                )
+              }
+            })
+          }
         }
-      }
-    })
-  }
+      })
+    }
 
-  return true
-}
+    return true
+  }

package/src/commands/wrapIn.ts

@@ -18,8 +18,10 @@ declare module '@tiptap/core' {
   }
 }
 
-export const wrapIn: RawCommands['wrapIn'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
-  const type = getNodeType(typeOrName, state.schema)
+export const wrapIn: RawCommands['wrapIn'] =
+  (typeOrName, attributes = {}) =>
+  ({ state, dispatch }) => {
+    const type = getNodeType(typeOrName, state.schema)
 
-  return originalWrapIn(type, attributes)(state, dispatch)
-}
+    return originalWrapIn(type, attributes)(state, dispatch)
+  }

package/src/commands/wrapInList.ts

@@ -18,8 +18,10 @@ declare module '@tiptap/core' {
   }
 }
 
-export const wrapInList: RawCommands['wrapInList'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
-  const type = getNodeType(typeOrName, state.schema)
+export const wrapInList: RawCommands['wrapInList'] =
+  (typeOrName, attributes = {}) =>
+  ({ state, dispatch }) => {
+    const type = getNodeType(typeOrName, state.schema)
 
-  return originalWrapInList(type, attributes)(state, dispatch)
-}
+    return originalWrapInList(type, attributes)(state, dispatch)
+  }

package/src/extensions/clipboardTextSerializer.ts

@@ -5,7 +5,7 @@ import { getTextBetween } from '../helpers/getTextBetween.js'
 import { getTextSerializersFromSchema } from '../helpers/getTextSerializersFromSchema.js'
 
 export type ClipboardTextSerializerOptions = {
-  blockSeparator?: string,
+  blockSeparator?: string
 }
 
 export const ClipboardTextSerializer = Extension.create<ClipboardTextSerializerOptions>({
@@ -33,9 +33,7 @@ export const ClipboardTextSerializer = Extension.create<ClipboardTextSerializerO
             const range = { from, to }
 
             return getTextBetween(doc, range, {
-              ...(this.options.blockSeparator !== undefined
-                ? { blockSeparator: this.options.blockSeparator }
-                : {}),
+              ...(this.options.blockSeparator !== undefined ? { blockSeparator: this.options.blockSeparator } : {}),
               textSerializers,
             })
           },

package/src/extensions/focusEvents.ts

@@ -16,9 +16,7 @@ export const FocusEvents = Extension.create({
             focus: (view, event: Event) => {
               editor.isFocused = true
 
-              const transaction = editor.state.tr
-                .setMeta('focus', { event })
-                .setMeta('addToHistory', false)
+              const transaction = editor.state.tr.setMeta('focus', { event }).setMeta('addToHistory', false)
 
               view.dispatch(transaction)
 
@@ -27,9 +25,7 @@ export const FocusEvents = Extension.create({
             blur: (view, event: Event) => {
               editor.isFocused = false
 
-              const transaction = editor.state.tr
-                .setMeta('blur', { event })
-                .setMeta('addToHistory', false)
+              const transaction = editor.state.tr.setMeta('blur', { event }).setMeta('addToHistory', false)
 
               view.dispatch(transaction)
 

package/src/extensions/keymap.ts

@@ -11,54 +11,59 @@ export const Keymap = Extension.create({
   name: 'keymap',
 
   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 $parentPos = $anchor.parent.isTextblock && pos > 0 ? tr.doc.resolve(pos - 1) : $anchor
-        const parentIsIsolating = $parentPos.parent.type.spec.isolating
-
-        const parentPos = $anchor.pos - $anchor.parentOffset
-
-        const isAtStart = (parentIsIsolating && $parentPos.parent.childCount === 1)
-          ? parentPos === $anchor.pos
-          : Selection.atStart(doc).from === pos
-
-        if (
-          !empty
-          || !parent.type.isTextblock
-          || parent.textContent.length
-          || !isAtStart
-          || (isAtStart && $anchor.parent.type.name === 'paragraph') // prevent clearNodes when no nodes to clear, otherwise history stack is appended
-        ) {
-          return false
-        }
-
-        return commands.clearNodes()
-      }),
-
-      () => commands.deleteSelection(),
-      () => commands.joinBackward(),
-      () => commands.selectNodeBackward(),
-    ])
-
-    const handleDelete = () => this.editor.commands.first(({ commands }) => [
-      () => commands.deleteSelection(),
-      () => commands.deleteCurrentNode(),
-      () => commands.joinForward(),
-      () => commands.selectNodeForward(),
-    ])
-
-    const handleEnter = () => this.editor.commands.first(({ commands }) => [
-      () => commands.newlineInCode(),
-      () => commands.createParagraphNear(),
-      () => commands.liftEmptyBlock(),
-      () => commands.splitBlock(),
-    ])
+    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 $parentPos = $anchor.parent.isTextblock && pos > 0 ? tr.doc.resolve(pos - 1) : $anchor
+            const parentIsIsolating = $parentPos.parent.type.spec.isolating
+
+            const parentPos = $anchor.pos - $anchor.parentOffset
+
+            const isAtStart =
+              parentIsIsolating && $parentPos.parent.childCount === 1
+                ? parentPos === $anchor.pos
+                : Selection.atStart(doc).from === pos
+
+            if (
+              !empty ||
+              !parent.type.isTextblock ||
+              parent.textContent.length ||
+              !isAtStart ||
+              (isAtStart && $anchor.parent.type.name === 'paragraph') // prevent clearNodes when no nodes to clear, otherwise history stack is appended
+            ) {
+              return false
+            }
+
+            return commands.clearNodes()
+          }),
+
+        () => commands.deleteSelection(),
+        () => commands.joinBackward(),
+        () => commands.selectNodeBackward(),
+      ])
+
+    const handleDelete = () =>
+      this.editor.commands.first(({ commands }) => [
+        () => commands.deleteSelection(),
+        () => commands.deleteCurrentNode(),
+        () => commands.joinForward(),
+        () => commands.selectNodeForward(),
+      ])
+
+    const handleEnter = () =>
+      this.editor.commands.first(({ commands }) => [
+        () => commands.newlineInCode(),
+        () => commands.createParagraphNear(),
+        () => commands.liftEmptyBlock(),
+        () => commands.splitBlock(),
+      ])
 
     const baseKeymap = {
       Enter: handleEnter,
@@ -104,8 +109,7 @@ export const Keymap = Extension.create({
       new Plugin({
         key: new PluginKey('clearDocument'),
         appendTransaction: (transactions, oldState, newState) => {
-          const docChanges = transactions.some(transaction => transaction.docChanged)
-            && !oldState.doc.eq(newState.doc)
+          const docChanges = transactions.some(transaction => transaction.docChanged) && !oldState.doc.eq(newState.doc)
 
           const ignoreTr = transactions.some(transaction => transaction.getMeta('preventClearDocument'))
 

package/src/extensions/paste.ts

@@ -6,7 +6,6 @@ export const Paste = Extension.create({
   name: 'paste',
 
   addProseMirrorPlugins() {
-
     return [
       new Plugin({
         key: new PluginKey('tiptapPaste'),

package/src/extensions/tabindex.ts

@@ -10,7 +10,7 @@ export const Tabindex = Extension.create({
       new Plugin({
         key: new PluginKey('tabindex'),
         props: {
-          attributes: (): { [name: string]: string; } => (this.editor.isEditable ? { tabindex: '0' } : {}),
+          attributes: (): { [name: string]: string } => (this.editor.isEditable ? { tabindex: '0' } : {}),
         },
       }),
     ]

package/src/helpers/combineTransactionSteps.ts

@@ -8,10 +8,7 @@ import { Transform } from '@tiptap/pm/transform'
  * @param transactions The transactions to combine
  * @returns A new `Transform` with all steps of the passed transactions
  */
-export function combineTransactionSteps(
-  oldDoc: ProseMirrorNode,
-  transactions: Transaction[],
-): Transform {
+export function combineTransactionSteps(oldDoc: ProseMirrorNode, transactions: Transaction[]): Transform {
   const transform = new Transform(oldDoc)
 
   transactions.forEach(transaction => {

package/src/helpers/createChainableState.ts

@@ -5,10 +5,7 @@ import { EditorState, Transaction } from '@tiptap/pm/state'
  * @param config The transaction and state to create the chainable state from
  * @returns A chainable Editor state object
  */
-export function createChainableState(config: {
-  transaction: Transaction
-  state: EditorState
-}): EditorState {
+export function createChainableState(config: { transaction: Transaction; state: EditorState }): EditorState {
   const { state, transaction } = config
   let { selection } = transaction
   let { doc } = transaction

package/src/helpers/createDocument.ts

@@ -1,6 +1,4 @@
-import {
-  Fragment, Node as ProseMirrorNode, ParseOptions, Schema,
-} from '@tiptap/pm/model'
+import { Fragment, Node as ProseMirrorNode, ParseOptions, Schema } from '@tiptap/pm/model'
 
 import { Content } from '../types.js'
 import { createNodeFromContent } from './createNodeFromContent.js'

package/src/helpers/createNodeFromContent.ts

@@ -1,10 +1,4 @@
-import {
-  DOMParser,
-  Fragment,
-  Node as ProseMirrorNode,
-  ParseOptions,
-  Schema,
-} from '@tiptap/pm/model'
+import { DOMParser, Fragment, Node as ProseMirrorNode, ParseOptions, Schema } from '@tiptap/pm/model'
 
 import { Content } from '../types.js'
 import { elementFromString } from '../utilities/elementFromString.js'
@@ -67,7 +61,6 @@ export function createNodeFromContent(
   }
 
   if (isTextContent) {
-
     // Check for invalid content
     if (options.errorOnInvalidContent) {
       let hasInvalidContent = false
@@ -106,7 +99,9 @@ export function createNodeFromContent(
       }
 
       if (options.errorOnInvalidContent && hasInvalidContent) {
-        throw new Error('[tiptap error]: Invalid HTML content', { cause: new Error(`Invalid element found: ${invalidContent}`) })
+        throw new Error('[tiptap error]: Invalid HTML content', {
+          cause: new Error(`Invalid element found: ${invalidContent}`),
+        })
       }
     }
 
@@ -117,7 +112,6 @@ export function createNodeFromContent(
     }
 
     return parser.parse(elementFromString(content), options.parseOptions)
-
   }
 
   return createNodeFromContent('', schema, options)

package/src/helpers/findChildrenInRange.ts

@@ -9,11 +9,7 @@ import { NodeWithPos, Predicate, Range } from '../types.js'
  * @param predicate The predicate to match
  * @returns An array of nodes with their positions
  */
-export function findChildrenInRange(
-  node: ProseMirrorNode,
-  range: Range,
-  predicate: Predicate,
-): NodeWithPos[] {
+export function findChildrenInRange(node: ProseMirrorNode, range: Range, predicate: Predicate): NodeWithPos[] {
   const nodesWithPos: NodeWithPos[] = []
 
   // if (range.from === range.to) {

package/src/helpers/findParentNode.ts

@@ -11,6 +11,8 @@ import { findParentNodeClosestToPos } from './findParentNodeClosestToPos.js'
  * findParentNode(node => node.type.name === 'paragraph')
  * ```
  */
-export function findParentNode(predicate: Predicate) {
+export function findParentNode(
+  predicate: Predicate,
+): (selection: Selection) => ReturnType<typeof findParentNodeClosestToPos> {
   return (selection: Selection) => findParentNodeClosestToPos(selection.$from, predicate)
 }

package/src/helpers/flattenExtensions.ts

@@ -0,0 +1,30 @@
+import { AnyConfig, Extensions } from '../types.js'
+import { getExtensionField } from './getExtensionField.js'
+
+/**
+ * Create a flattened array of extensions by traversing the `addExtensions` field.
+ * @param extensions An array of Tiptap extensions
+ * @returns A flattened array of Tiptap extensions
+ */
+export function flattenExtensions(extensions: Extensions): Extensions {
+  return (
+    extensions
+      .map(extension => {
+        const context = {
+          name: extension.name,
+          options: extension.options,
+          storage: extension.storage,
+        }
+
+        const addExtensions = getExtensionField<AnyConfig['addExtensions']>(extension, 'addExtensions', context)
+
+        if (addExtensions) {
+          return [extension, ...flattenExtensions(addExtensions())]
+        }
+
+        return extension
+      })
+      // `Infinity` will break TypeScript so we set a number that is probably high enough
+      .flat(10)
+  )
+}

package/src/helpers/getAttributes.ts

@@ -11,10 +11,7 @@ import { getSchemaTypeNameByName } from './getSchemaTypeNameByName.js'
  * @param typeOrName The node or mark type or name
  * @returns The attributes of the node or mark or an empty object
  */
-export function getAttributes(
-  state: EditorState,
-  typeOrName: string | NodeType | MarkType,
-): Record<string, any> {
+export function getAttributes(state: EditorState, typeOrName: string | NodeType | MarkType): Record<string, any> {
   const schemaType = getSchemaTypeNameByName(
     typeof typeOrName === 'string' ? typeOrName : typeOrName.name,
     state.schema,