@tiptap/core 2.5.0-beta.3 → 2.5.0-beta.5

package/dist/packages/core/src/Extension.d.ts

@@ -338,6 +338,6 @@ export declare class Extension<Options = any, Storage = any> {
     config: ExtensionConfig;
     constructor(config?: Partial<ExtensionConfig<Options, Storage>>);
     static create<O = any, S = any>(config?: Partial<ExtensionConfig<O, S>>): Extension<O, S>;
-    configure(options?: Partial<Options>): Extension<Options, Storage>;
+    configure(options?: Partial<Options>): Extension<any, any>;
     extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<ExtensionConfig<ExtendedOptions, ExtendedStorage>>): Extension<ExtendedOptions, ExtendedStorage>;
 }

package/dist/packages/core/src/Mark.d.ts

@@ -442,7 +442,7 @@ export declare class Mark<Options = any, Storage = any> {
     config: MarkConfig;
     constructor(config?: Partial<MarkConfig<Options, Storage>>);
     static create<O = any, S = any>(config?: Partial<MarkConfig<O, S>>): Mark<O, S>;
-    configure(options?: Partial<Options>): Mark<Options, Storage>;
+    configure(options?: Partial<Options>): Mark<any, any>;
     extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<MarkConfig<ExtendedOptions, ExtendedStorage>>): Mark<ExtendedOptions, ExtendedStorage>;
     static handleExit({ editor, mark }: {
         editor: Editor;

package/dist/packages/core/src/Node.d.ts

@@ -606,6 +606,6 @@ export declare class Node<Options = any, Storage = any> {
     config: NodeConfig;
     constructor(config?: Partial<NodeConfig<Options, Storage>>);
     static create<O = any, S = any>(config?: Partial<NodeConfig<O, S>>): Node<O, S>;
-    configure(options?: Partial<Options>): Node<Options, Storage>;
+    configure(options?: Partial<Options>): Node<any, any>;
     extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<NodeConfig<ExtendedOptions, ExtendedStorage>>): Node<ExtendedOptions, ExtendedStorage>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/core",
   "description": "headless rich text editor",
-  "version": "2.5.0-beta.3",
+  "version": "2.5.0-beta.5",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -32,7 +32,7 @@
     "dist"
   ],
   "devDependencies": {
-    "@tiptap/pm": "^2.5.0-beta.3"
+    "@tiptap/pm": "^2.5.0-beta.5"
   },
   "peerDependencies": {
     "@tiptap/pm": "^2.0.0"

package/src/Extension.ts

@@ -457,17 +457,17 @@ export class Extension<Options = any, Storage = any> {
   configure(options: Partial<Options> = {}) {
     // return a new instance so we can use the same extension
     // with different calls of `configure`
-    const extension = this.extend()
-
+    const extension = this.extend({
+      ...this.config,
+      addOptions() {
+        return mergeDeep(this.parent?.() || {}, options) as Options
+      },
+    })
+
+    // Always preserve the current name
+    extension.name = this.name
+    // Set the parent to be our parent
     extension.parent = this.parent
-    extension.options = mergeDeep(this.options as Record<string, any>, options) as Options
-
-    extension.storage = callOrReturn(
-      getExtensionField<AnyConfig['addStorage']>(extension, 'addStorage', {
-        name: extension.name,
-        options: extension.options,
-      }),
-    )
 
     return extension
   }
@@ -483,7 +483,7 @@ export class Extension<Options = any, Storage = any> {
 
     extension.name = extendedConfig.name ? extendedConfig.name : extension.parent.name
 
-    if (extendedConfig.defaultOptions) {
+    if (extendedConfig.defaultOptions && Object.keys(extendedConfig.defaultOptions).length > 0) {
       console.warn(
         `[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${extension.name}".`,
       )

package/src/ExtensionManager.ts

@@ -181,7 +181,7 @@ export class ExtensionManager {
         let defaultBindings: Record<string, () => boolean> = {}
 
         // bind exit handling
-        if (extension.type === 'mark' && extension.config.exitable) {
+        if (extension.type === 'mark' && getExtensionField<AnyConfig['exitable']>(extension, 'exitable', context)) {
           defaultBindings.ArrowRight = () => Mark.handleExit({ editor, mark: extension as Mark })
         }
 

package/src/Mark.ts

@@ -589,16 +589,17 @@ export class Mark<Options = any, Storage = any> {
   configure(options: Partial<Options> = {}) {
     // return a new instance so we can use the same extension
     // with different calls of `configure`
-    const extension = this.extend()
-
-    extension.options = mergeDeep(this.options as Record<string, any>, options) as Options
+    const extension = this.extend({
+      ...this.config,
+      addOptions() {
+        return mergeDeep(this.parent?.() || {}, options) as Options
+      },
+    })
 
-    extension.storage = callOrReturn(
-      getExtensionField<AnyConfig['addStorage']>(extension, 'addStorage', {
-        name: extension.name,
-        options: extension.options,
-      }),
-    )
+    // Always preserve the current name
+    extension.name = this.name
+    // Set the parent to be our parent
+    extension.parent = this.parent
 
     return extension
   }
@@ -606,7 +607,7 @@ export class Mark<Options = any, Storage = any> {
   extend<ExtendedOptions = Options, ExtendedStorage = Storage>(
     extendedConfig: Partial<MarkConfig<ExtendedOptions, ExtendedStorage>> = {},
   ) {
-    const extension = new Mark<ExtendedOptions, ExtendedStorage>({ ...this.config, ...extendedConfig })
+    const extension = new Mark<ExtendedOptions, ExtendedStorage>(extendedConfig)
 
     extension.parent = this
 
@@ -614,7 +615,7 @@ export class Mark<Options = any, Storage = any> {
 
     extension.name = extendedConfig.name ? extendedConfig.name : extension.parent.name
 
-    if (extendedConfig.defaultOptions) {
+    if (extendedConfig.defaultOptions && Object.keys(extendedConfig.defaultOptions).length > 0) {
       console.warn(
         `[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${extension.name}".`,
       )

package/src/Node.ts

@@ -780,16 +780,17 @@ export class Node<Options = any, Storage = any> {
   configure(options: Partial<Options> = {}) {
     // return a new instance so we can use the same extension
     // with different calls of `configure`
-    const extension = this.extend()
-
-    extension.options = mergeDeep(this.options as Record<string, any>, options) as Options
+    const extension = this.extend({
+      ...this.config,
+      addOptions() {
+        return mergeDeep(this.parent?.() || {}, options) as Options
+      },
+    })
 
-    extension.storage = callOrReturn(
-      getExtensionField<AnyConfig['addStorage']>(extension, 'addStorage', {
-        name: extension.name,
-        options: extension.options,
-      }),
-    )
+    // Always preserve the current name
+    extension.name = this.name
+    // Set the parent to be our parent
+    extension.parent = this.parent
 
     return extension
   }
@@ -797,7 +798,7 @@ export class Node<Options = any, Storage = any> {
   extend<ExtendedOptions = Options, ExtendedStorage = Storage>(
     extendedConfig: Partial<NodeConfig<ExtendedOptions, ExtendedStorage>> = {},
   ) {
-    const extension = new Node<ExtendedOptions, ExtendedStorage>({ ...this.config, ...extendedConfig })
+    const extension = new Node<ExtendedOptions, ExtendedStorage>(extendedConfig)
 
     extension.parent = this
 
@@ -805,7 +806,7 @@ export class Node<Options = any, Storage = any> {
 
     extension.name = extendedConfig.name ? extendedConfig.name : extension.parent.name
 
-    if (extendedConfig.defaultOptions) {
+    if (extendedConfig.defaultOptions && Object.keys(extendedConfig.defaultOptions).length > 0) {
       console.warn(
         `[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${extension.name}".`,
       )

package/src/commands/insertContentAt.ts

@@ -84,11 +84,6 @@ export const insertContentAt: RawCommands['insertContentAt'] = (position, value,
       return false
     }
 
-    // don’t dispatch an empty fragment because this can lead to strange errors
-    if (content.toString() === '<>') {
-      return true
-    }
-
     let { from, to } = typeof position === 'number' ? { from: position, to: position } : { from: position.from, to: position.to }
 
     let isOnlyTextContent = true

package/src/commands/setContent.ts

@@ -1,4 +1,4 @@
-import { Fragment, Node as ProseMirrorNode, ParseOptions } from '@tiptap/pm/model'
+import { ParseOptions } from '@tiptap/pm/model'
 
 import { createDocument } from '../helpers/createDocument.js'
 import { Content, RawCommands } from '../types.js'
@@ -44,22 +44,34 @@ declare module '@tiptap/core' {
   }
 }
 
-export const setContent: RawCommands['setContent'] = (content, emitUpdate = false, parseOptions = {}, options = {}) => ({ tr, editor, dispatch }) => {
+export const setContent: RawCommands['setContent'] = (content, emitUpdate = false, parseOptions = {}, options = {}) => ({
+  editor, tr, dispatch, commands,
+}) => {
   const { doc } = tr
 
-  let document: Fragment | ProseMirrorNode
-
-  try {
-    document = createDocument(content, editor.schema, parseOptions, {
+  // This is to keep backward compatibility with the previous behavior
+  // TODO remove this in the next major version
+  if (parseOptions.preserveWhitespace !== 'full') {
+    const document = createDocument(content, editor.schema, parseOptions, {
       errorOnInvalidContent: options.errorOnInvalidContent ?? editor.options.enableContentCheck,
     })
-  } catch (e) {
-    return false
+
+    if (dispatch) {
+      tr.replaceWith(0, doc.content.size, document).setMeta('preventUpdate', !emitUpdate)
+    }
+    return true
   }
 
   if (dispatch) {
-    tr.replaceWith(0, doc.content.size, document).setMeta('preventUpdate', !emitUpdate)
+    tr.setMeta('preventUpdate', !emitUpdate)
   }
 
-  return true
+  return commands.insertContentAt(
+    { from: 0, to: doc.content.size },
+    content,
+    {
+      parseOptions,
+      errorOnInvalidContent: options.errorOnInvalidContent ?? editor.options.enableContentCheck,
+    },
+  )
 }

package/src/commands/updateAttributes.ts

@@ -1,7 +1,4 @@
-import {
-  Mark, MarkType, Node, NodeType,
-} from '@tiptap/pm/model'
-import { SelectionRange } from '@tiptap/pm/state'
+import { MarkType, NodeType } from '@tiptap/pm/model'
 
 import { getMarkType } from '../helpers/getMarkType.js'
 import { getNodeType } from '../helpers/getNodeType.js'
@@ -54,49 +51,37 @@ export const updateAttributes: RawCommands['updateAttributes'] = (typeOrName, at
   }
 
   if (dispatch) {
-    let lastPos: number | undefined
-    let lastNode: Node | undefined
-    let trimmedFrom: number
-    let trimmedTo: number
-
-    tr.selection.ranges.forEach((range: SelectionRange) => {
+    tr.selection.ranges.forEach(range => {
       const from = range.$from.pos
       const to = range.$to.pos
 
-      state.doc.nodesBetween(from, to, (node: Node, pos: number) => {
+      state.doc.nodesBetween(from, to, (node, pos) => {
         if (nodeType && nodeType === node.type) {
-          trimmedFrom = Math.max(pos, from)
-          trimmedTo = Math.min(pos + node.nodeSize, to)
-          lastPos = pos
-          lastNode = node
+          tr.setNodeMarkup(pos, undefined, {
+            ...node.attrs,
+            ...attributes,
+          })
         }
-      })
-    })
-
-    if (lastNode) {
 
-      if (lastPos !== undefined) {
-        tr.setNodeMarkup(lastPos, undefined, {
-          ...lastNode.attrs,
-          ...attributes,
-        })
-      }
+        if (markType && node.marks.length) {
+          node.marks.forEach(mark => {
+            if (markType === mark.type) {
+              const trimmedFrom = Math.max(pos, from)
+              const trimmedTo = Math.min(pos + node.nodeSize, to)
 
-      if (markType && lastNode.marks.length) {
-        lastNode.marks.forEach((mark: Mark) => {
-          if (markType === mark.type) {
-            tr.addMark(
-              trimmedFrom,
-              trimmedTo,
-              markType.create({
-                ...mark.attrs,
-                ...attributes,
-              }),
-            )
-          }
-        })
-      }
-    }
+              tr.addMark(
+                trimmedFrom,
+                trimmedTo,
+                markType.create({
+                  ...mark.attrs,
+                  ...attributes,
+                }),
+              )
+            }
+          })
+        }
+      })
+    })
   }
 
   return true

package/src/extensions/tabindex.ts

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

package/src/helpers/createNodeFromContent.ts

@@ -60,6 +60,7 @@ export function createNodeFromContent(
   if (isTextContent) {
     let schemaToUse = schema
     let hasInvalidContent = false
+    let invalidContent = ''
 
     // Only ever check for invalid content if we're supposed to throw an error
     if (options.errorOnInvalidContent) {
@@ -75,9 +76,11 @@ export function createNodeFromContent(
             parseDOM: [
               {
                 tag: '*',
-                getAttrs: () => {
+                getAttrs: e => {
                   // If this is ever called, we know that the content has something that we don't know how to handle in the schema
                   hasInvalidContent = true
+                  // Try to stringify the element for a more helpful error message
+                  invalidContent = typeof e === 'string' ? e : e.outerHTML
                   return null
                 },
               },
@@ -94,7 +97,7 @@ export function createNodeFromContent(
       : parser.parse(elementFromString(content), options.parseOptions)
 
     if (options.errorOnInvalidContent && hasInvalidContent) {
-      throw new Error('[tiptap error]: Invalid HTML content')
+      throw new Error('[tiptap error]: Invalid HTML content', { cause: new Error(`Invalid element found: ${invalidContent}`) })
     }
 
     return response

package/src/helpers/getSchemaByResolvedExtensions.ts

@@ -77,6 +77,7 @@ export function getSchemaByResolvedExtensions(extensions: Extensions, editor?: E
           getExtensionField<NodeConfig['draggable']>(extension, 'draggable', context),
         ),
         code: callOrReturn(getExtensionField<NodeConfig['code']>(extension, 'code', context)),
+        whitespace: callOrReturn(getExtensionField<NodeConfig['whitespace']>(extension, 'whitespace', context)),
         defining: callOrReturn(
           getExtensionField<NodeConfig['defining']>(extension, 'defining', context),
         ),