@tiptap/core 2.5.0-beta.2 → 2.5.0-beta.4

package/dist/packages/core/src/utilities/objectIncludes.d.ts

@@ -1,8 +1,8 @@
-/**
- * Check if object1 includes object2
- * @param object1 Object
- * @param object2 Object
- */
-export declare function objectIncludes(object1: Record<string, any>, object2: Record<string, any>, options?: {
-    strict: boolean;
-}): boolean;
+/**
+ * Check if object1 includes object2
+ * @param object1 Object
+ * @param object2 Object
+ */
+export declare function objectIncludes(object1: Record<string, any>, object2: Record<string, any>, options?: {
+    strict: boolean;
+}): boolean;

package/dist/packages/core/src/utilities/removeDuplicates.d.ts

@@ -1,8 +1,8 @@
-/**
- * Removes duplicated values within an array.
- * Supports numbers, strings and objects.
- */
-export declare function removeDuplicates<T>(array: T[], by?: {
-    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
-    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
-}): T[];
+/**
+ * Removes duplicated values within an array.
+ * Supports numbers, strings and objects.
+ */
+export declare function removeDuplicates<T>(array: T[], by?: {
+    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
+    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
+}): T[];

package/package.json

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

package/src/Extension.ts

@@ -20,6 +20,7 @@ import { mergeDeep } from './utilities/mergeDeep.js'
 
 declare module '@tiptap/core' {
   interface ExtensionConfig<Options = any, Storage = any> {
+    // @ts-ignore - this is a dynamic key
     [key: string]: any
 
     /**
@@ -108,8 +109,9 @@ declare module '@tiptap/core' {
       name: string
       options: Options
       storage: Storage
+      extensions: (Node | Mark)[]
       parent: ParentConfig<ExtensionConfig<Options, Storage>>['addGlobalAttributes']
-    }) => GlobalAttributes | {}
+    }) => GlobalAttributes
 
     /**
      * This function adds commands to the editor
@@ -455,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
   }
@@ -481,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

@@ -3,7 +3,7 @@ import { Node as ProsemirrorNode, Schema } from '@tiptap/pm/model'
 import { Plugin } from '@tiptap/pm/state'
 import { Decoration, EditorView } from '@tiptap/pm/view'
 
-import { Editor } from './Editor.js'
+import type { Editor } from './Editor.js'
 import { getAttributesFromExtensions } from './helpers/getAttributesFromExtensions.js'
 import { getExtensionField } from './helpers/getExtensionField.js'
 import { getNodeType } from './helpers/getNodeType.js'
@@ -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

@@ -23,6 +23,7 @@ import { mergeDeep } from './utilities/mergeDeep.js'
 
 declare module '@tiptap/core' {
   export interface MarkConfig<Options = any, Storage = any> {
+    // @ts-ignore - this is a dynamic key
     [key: string]: any
 
     /**
@@ -111,8 +112,9 @@ declare module '@tiptap/core' {
       name: string
       options: Options
       storage: Storage
+      extensions: (Node | Mark)[]
       parent: ParentConfig<MarkConfig<Options, Storage>>['addGlobalAttributes']
-    }) => GlobalAttributes | {}
+    }) => GlobalAttributes
 
     /**
      * This function adds commands to the editor
@@ -587,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
   }
@@ -604,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
 
@@ -612,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

@@ -7,6 +7,7 @@ import { Editor } from './Editor.js'
 import { getExtensionField } from './helpers/getExtensionField.js'
 import { NodeConfig } from './index.js'
 import { InputRule } from './InputRule.js'
+import { Mark } from './Mark.js'
 import { PasteRule } from './PasteRule.js'
 import {
   AnyConfig,
@@ -23,6 +24,7 @@ import { mergeDeep } from './utilities/mergeDeep.js'
 
 declare module '@tiptap/core' {
   interface NodeConfig<Options = any, Storage = any> {
+    // @ts-ignore - this is a dynamic key
     [key: string]: any
 
     /**
@@ -111,8 +113,9 @@ declare module '@tiptap/core' {
       name: string
       options: Options
       storage: Storage
+      extensions: (Node | Mark)[]
       parent: ParentConfig<NodeConfig<Options, Storage>>['addGlobalAttributes']
-    }) => GlobalAttributes | {}
+    }) => GlobalAttributes
 
     /**
      * This function adds commands to the editor
@@ -777,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
   }
@@ -794,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
 
@@ -802,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

@@ -57,7 +57,7 @@ declare module '@tiptap/core' {
 }
 
 const isFragment = (nodeOrFragment: ProseMirrorNode | Fragment): nodeOrFragment is Fragment => {
-  return nodeOrFragment.toString().startsWith('<')
+  return !('type' in nodeOrFragment)
 }
 
 export const insertContentAt: RawCommands['insertContentAt'] = (position, value, options) => ({ tr, dispatch, editor }) => {

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/getAttributesFromExtensions.ts

@@ -5,7 +5,6 @@ import {
   Attributes,
   ExtensionAttribute,
   Extensions,
-  GlobalAttributes,
 } from '../types.js'
 import { getExtensionField } from './getExtensionField.js'
 import { splitExtensions } from './splitExtensions.js'
@@ -32,6 +31,7 @@ export function getAttributesFromExtensions(extensions: Extensions): ExtensionAt
       name: extension.name,
       options: extension.options,
       storage: extension.storage,
+      extensions: nodeAndMarkExtensions,
     }
 
     const addGlobalAttributes = getExtensionField<AnyConfig['addGlobalAttributes']>(
@@ -44,8 +44,7 @@ export function getAttributesFromExtensions(extensions: Extensions): ExtensionAt
       return
     }
 
-    // TODO: remove `as GlobalAttributes`
-    const globalAttributes = addGlobalAttributes() as GlobalAttributes
+    const globalAttributes = addGlobalAttributes()
 
     globalAttributes.forEach(globalAttribute => {
       globalAttribute.types.forEach(type => {

package/src/helpers/getSchemaByResolvedExtensions.ts

@@ -1,4 +1,6 @@
-import { MarkSpec, NodeSpec, Schema } from '@tiptap/pm/model'
+import {
+  MarkSpec, NodeSpec, Schema, TagParseRule,
+} from '@tiptap/pm/model'
 
 import { Editor, MarkConfig, NodeConfig } from '../index.js'
 import { AnyConfig, Extensions } from '../types.js'
@@ -75,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),
         ),
@@ -93,7 +96,7 @@ export function getSchemaByResolvedExtensions(extensions: Extensions, editor?: E
       )
 
       if (parseHTML) {
-        schema.parseDOM = parseHTML.map(parseRule => injectExtensionAttributesToParseRule(parseRule, extensionAttributes))
+        schema.parseDOM = parseHTML.map(parseRule => injectExtensionAttributesToParseRule(parseRule, extensionAttributes)) as TagParseRule[]
       }
 
       const renderHTML = getExtensionField<NodeConfig['renderHTML']>(

package/src/helpers/injectExtensionAttributesToParseRule.ts

@@ -13,13 +13,13 @@ export function injectExtensionAttributesToParseRule(
   parseRule: ParseRule,
   extensionAttributes: ExtensionAttribute[],
 ): ParseRule {
-  if (parseRule.style) {
+  if ('style' in parseRule) {
     return parseRule
   }
 
   return {
     ...parseRule,
-    getAttrs: node => {
+    getAttrs: (node: HTMLElement) => {
       const oldAttributes = parseRule.getAttrs ? parseRule.getAttrs(node) : parseRule.attrs
 
       if (oldAttributes === false) {
@@ -28,8 +28,8 @@ export function injectExtensionAttributesToParseRule(
 
       const newAttributes = extensionAttributes.reduce((items, item) => {
         const value = item.attribute.parseHTML
-          ? item.attribute.parseHTML(node as HTMLElement)
-          : fromString((node as HTMLElement).getAttribute(item.name))
+          ? item.attribute.parseHTML(node)
+          : fromString((node).getAttribute(item.name))
 
         if (value === null || value === undefined) {
           return items

package/src/helpers/isNodeEmpty.ts

@@ -1,8 +1,11 @@
 import { Node as ProseMirrorNode } from '@tiptap/pm/model'
 
 export function isNodeEmpty(node: ProseMirrorNode): boolean {
-  const defaultContent = node.type.createAndFill()?.toJSON()
-  const content = node.toJSON()
+  const defaultContent = node.type.createAndFill()
 
-  return JSON.stringify(defaultContent) === JSON.stringify(content)
+  if (!defaultContent) {
+    return false
+  }
+
+  return node.eq(defaultContent)
 }

package/src/types.ts

@@ -152,7 +152,13 @@ export type ExtensionAttribute = {
 }
 
 export type GlobalAttributes = {
+  /**
+   * The node & mark types this attribute should be applied to.
+   */
   types: string[]
+  /**
+   * The attributes to add to the node or mark types.
+   */
   attributes: {
     [key: string]: Attribute
   }

package/src/utilities/mergeDeep.ts

@@ -5,14 +5,10 @@ export function mergeDeep(target: Record<string, any>, source: Record<string, an
 
   if (isPlainObject(target) && isPlainObject(source)) {
     Object.keys(source).forEach(key => {
-      if (isPlainObject(source[key])) {
-        if (!(key in target)) {
-          Object.assign(output, { [key]: source[key] })
-        } else {
-          output[key] = mergeDeep(target[key], source[key])
-        }
+      if (isPlainObject(source[key]) && isPlainObject(target[key])) {
+        output[key] = mergeDeep(target[key], source[key])
       } else {
-        Object.assign(output, { [key]: source[key] })
+        output[key] = source[key]
       }
     })
   }