@tiptap/core 2.0.0-beta.99 → 2.0.0-rc.2

package/src/Mark.ts

@@ -1,326 +1,412 @@
 import {
-  DOMOutputSpec,
-  MarkSpec,
-  Mark as ProseMirrorMark,
-  MarkType,
-} from 'prosemirror-model'
-import { Plugin, Transaction } from 'prosemirror-state'
-import { InputRule } from 'prosemirror-inputrules'
-import mergeDeep from './utilities/mergeDeep'
+  DOMOutputSpec, Mark as ProseMirrorMark, MarkSpec, MarkType,
+} from '@tiptap/pm/model'
+import { Plugin, Transaction } from '@tiptap/pm/state'
+
+import { MarkConfig } from '.'
+import { Editor } from './Editor'
+import { getExtensionField } from './helpers/getExtensionField'
+import { InputRule } from './InputRule'
+import { Node } from './Node'
+import { PasteRule } from './PasteRule'
 import {
-  Extensions,
+  AnyConfig,
   Attributes,
-  RawCommands,
+  Extensions,
   GlobalAttributes,
-  ParentConfig,
   KeyboardShortcutCommand,
+  ParentConfig,
+  RawCommands,
 } from './types'
-import { Node } from './Node'
-import { MarkConfig } from '.'
-import { Editor } from './Editor'
+import { callOrReturn } from './utilities/callOrReturn'
+import { mergeDeep } from './utilities/mergeDeep'
 
 declare module '@tiptap/core' {
-  export interface MarkConfig<Options = any> {
-    [key: string]: any;
+  export interface MarkConfig<Options = any, Storage = any> {
+    [key: string]: any
 
     /**
      * Name
      */
-    name: string,
+    name: string
 
     /**
      * Priority
      */
-    priority?: number,
+    priority?: number
 
     /**
      * Default options
      */
-    defaultOptions?: Options,
+    defaultOptions?: Options
+
+    /**
+     * Default Options
+     */
+    addOptions?: (this: {
+      name: string
+      parent: Exclude<ParentConfig<MarkConfig<Options, Storage>>['addOptions'], undefined>
+    }) => Options
+
+    /**
+     * Default Storage
+     */
+    addStorage?: (this: {
+      name: string
+      options: Options
+      parent: Exclude<ParentConfig<MarkConfig<Options, Storage>>['addStorage'], undefined>
+    }) => Storage
 
     /**
      * Global attributes
      */
     addGlobalAttributes?: (this: {
-      name: string,
-      options: Options,
-      parent: ParentConfig<MarkConfig<Options>>['addGlobalAttributes'],
-    }) => GlobalAttributes | {},
+      name: string
+      options: Options
+      storage: Storage
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addGlobalAttributes']
+    }) => GlobalAttributes | {}
 
     /**
      * Raw
      */
     addCommands?: (this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['addCommands'],
-    }) => Partial<RawCommands>,
+      name: string
+      options: Options
+      storage: Storage
+      editor: Editor
+      type: MarkType
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addCommands']
+    }) => Partial<RawCommands>
 
     /**
      * Keyboard shortcuts
      */
     addKeyboardShortcuts?: (this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['addKeyboardShortcuts'],
+      name: string
+      options: Options
+      storage: Storage
+      editor: Editor
+      type: MarkType
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addKeyboardShortcuts']
     }) => {
-      [key: string]: KeyboardShortcutCommand,
-    },
+      [key: string]: KeyboardShortcutCommand
+    }
 
     /**
      * Input rules
      */
     addInputRules?: (this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['addInputRules'],
-    }) => InputRule[],
+      name: string
+      options: Options
+      storage: Storage
+      editor: Editor
+      type: MarkType
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addInputRules']
+    }) => InputRule[]
 
     /**
      * Paste rules
      */
     addPasteRules?: (this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['addPasteRules'],
-    }) => Plugin[],
+      name: string
+      options: Options
+      storage: Storage
+      editor: Editor
+      type: MarkType
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addPasteRules']
+    }) => PasteRule[]
 
     /**
      * ProseMirror plugins
      */
     addProseMirrorPlugins?: (this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['addProseMirrorPlugins'],
-    }) => Plugin[],
+      name: string
+      options: Options
+      storage: Storage
+      editor: Editor
+      type: MarkType
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addProseMirrorPlugins']
+    }) => Plugin[]
 
     /**
      * Extensions
      */
     addExtensions?: (this: {
-      name: string,
-      options: Options,
-      parent: ParentConfig<MarkConfig<Options>>['addExtensions'],
-    }) => Extensions,
+      name: string
+      options: Options
+      storage: Storage
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addExtensions']
+    }) => Extensions
 
     /**
      * Extend Node Schema
      */
-    extendNodeSchema?: ((
-      this: {
-        name: string,
-        options: Options,
-        parent: ParentConfig<MarkConfig<Options>>['extendNodeSchema'],
-      },
-      extension: Node,
-    ) => Record<string, any>) | null,
+    extendNodeSchema?:
+      | ((
+          this: {
+            name: string
+            options: Options
+            storage: Storage
+            parent: ParentConfig<MarkConfig<Options, Storage>>['extendNodeSchema']
+          },
+          extension: Node,
+        ) => Record<string, any>)
+      | null
 
     /**
      * Extend Mark Schema
      */
-    extendMarkSchema?: ((
-      this: {
-        name: string,
-        options: Options,
-        parent: ParentConfig<MarkConfig<Options>>['extendMarkSchema'],
-      },
-      extension: Mark,
-    ) => Record<string, any>) | null,
+    extendMarkSchema?:
+      | ((
+          this: {
+            name: string
+            options: Options
+            storage: Storage
+            parent: ParentConfig<MarkConfig<Options, Storage>>['extendMarkSchema']
+          },
+          extension: Mark,
+        ) => Record<string, any>)
+      | null
 
     /**
      * The editor is not ready yet.
      */
-    onBeforeCreate?: ((this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['onBeforeCreate'],
-    }) => void) | null,
+    onBeforeCreate?:
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          editor: Editor
+          type: MarkType
+          parent: ParentConfig<MarkConfig<Options, Storage>>['onBeforeCreate']
+        }) => void)
+      | null
 
     /**
      * The editor is ready.
      */
-    onCreate?: ((this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['onCreate'],
-    }) => void) | null,
+    onCreate?:
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          editor: Editor
+          type: MarkType
+          parent: ParentConfig<MarkConfig<Options, Storage>>['onCreate']
+        }) => void)
+      | null
 
     /**
      * The content has changed.
      */
-    onUpdate?: ((this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['onUpdate'],
-    }) => void) | null,
+    onUpdate?:
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          editor: Editor
+          type: MarkType
+          parent: ParentConfig<MarkConfig<Options, Storage>>['onUpdate']
+        }) => void)
+      | null
 
     /**
      * The selection has changed.
      */
-    onSelectionUpdate?: ((this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['onSelectionUpdate'],
-    }) => void) | null,
+    onSelectionUpdate?:
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          editor: Editor
+          type: MarkType
+          parent: ParentConfig<MarkConfig<Options, Storage>>['onSelectionUpdate']
+        }) => void)
+      | null
 
     /**
      * The editor state has changed.
      */
-    onTransaction?: ((
-      this: {
-        name: string,
-        options: Options,
-        editor: Editor,
-        type: MarkType,
-        parent: ParentConfig<MarkConfig<Options>>['onTransaction'],
-      },
-      props: {
-        transaction: Transaction,
-      },
-    ) => void) | null,
+    onTransaction?:
+      | ((
+          this: {
+            name: string
+            options: Options
+            storage: Storage
+            editor: Editor
+            type: MarkType
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onTransaction']
+          },
+          props: {
+            transaction: Transaction
+          },
+        ) => void)
+      | null
 
     /**
      * The editor is focused.
      */
-    onFocus?: ((
-      this: {
-        name: string,
-        options: Options,
-        editor: Editor,
-        type: MarkType,
-        parent: ParentConfig<MarkConfig<Options>>['onFocus'],
-      },
-      props: {
-        event: FocusEvent,
-      },
-    ) => void) | null,
+    onFocus?:
+      | ((
+          this: {
+            name: string
+            options: Options
+            storage: Storage
+            editor: Editor
+            type: MarkType
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onFocus']
+          },
+          props: {
+            event: FocusEvent
+          },
+        ) => void)
+      | null
 
     /**
      * The editor isn’t focused anymore.
      */
-    onBlur?: ((
-      this: {
-        name: string,
-        options: Options,
-        editor: Editor,
-        type: MarkType,
-        parent: ParentConfig<MarkConfig<Options>>['onBlur'],
-      },
-      props: {
-        event: FocusEvent,
-      },
-    ) => void) | null,
+    onBlur?:
+      | ((
+          this: {
+            name: string
+            options: Options
+            storage: Storage
+            editor: Editor
+            type: MarkType
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onBlur']
+          },
+          props: {
+            event: FocusEvent
+          },
+        ) => void)
+      | null
 
     /**
      * The editor is destroyed.
      */
-    onDestroy?: ((this: {
-      name: string,
-      options: Options,
-      editor: Editor,
-      type: MarkType,
-      parent: ParentConfig<MarkConfig<Options>>['onDestroy'],
-    }) => void) | null,
+    onDestroy?:
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          editor: Editor
+          type: MarkType
+          parent: ParentConfig<MarkConfig<Options, Storage>>['onDestroy']
+        }) => void)
+      | null
 
     /**
      * Keep mark after split node
      */
-    keepOnSplit?: boolean | (() => boolean),
+    keepOnSplit?: boolean | (() => boolean)
 
     /**
      * Inclusive
      */
-    inclusive?: MarkSpec['inclusive'] | ((this: {
-      name: string,
-      options: Options,
-      parent: ParentConfig<MarkConfig<Options>>['inclusive'],
-    }) => MarkSpec['inclusive']),
+    inclusive?:
+      | MarkSpec['inclusive']
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          parent: ParentConfig<MarkConfig<Options, Storage>>['inclusive']
+        }) => MarkSpec['inclusive'])
 
     /**
      * Excludes
      */
-    excludes?: MarkSpec['excludes'] | ((this: {
-      name: string,
-      options: Options,
-      parent: ParentConfig<MarkConfig<Options>>['excludes'],
-    }) => MarkSpec['excludes']),
+    excludes?:
+      | MarkSpec['excludes']
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          parent: ParentConfig<MarkConfig<Options, Storage>>['excludes']
+        }) => MarkSpec['excludes'])
+
+    /**
+     * Marks this Mark as exitable
+     */
+    exitable?: boolean | (() => boolean)
 
     /**
      * Group
      */
-    group?: MarkSpec['group'] | ((this: {
-      name: string,
-      options: Options,
-      parent: ParentConfig<MarkConfig<Options>>['group'],
-    }) => MarkSpec['group']),
+    group?:
+      | MarkSpec['group']
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          parent: ParentConfig<MarkConfig<Options, Storage>>['group']
+        }) => MarkSpec['group'])
 
     /**
      * Spanning
      */
-    spanning?: MarkSpec['spanning'] | ((this: {
-      name: string,
-      options: Options,
-      parent: ParentConfig<MarkConfig<Options>>['spanning'],
-    }) => MarkSpec['spanning']),
+    spanning?:
+      | MarkSpec['spanning']
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          parent: ParentConfig<MarkConfig<Options, Storage>>['spanning']
+        }) => MarkSpec['spanning'])
+
+    /**
+     * Code
+     */
+    code?:
+      | boolean
+      | ((this: {
+          name: string
+          options: Options
+          storage: Storage
+          parent: ParentConfig<MarkConfig<Options, Storage>>['code']
+        }) => boolean)
 
     /**
      * Parse HTML
      */
-    parseHTML?: (
-      this: {
-        name: string,
-        options: Options,
-        parent: ParentConfig<MarkConfig<Options>>['parseHTML'],
-      },
-    ) => MarkSpec['parseDOM'],
+    parseHTML?: (this: {
+      name: string
+      options: Options
+      storage: Storage
+      parent: ParentConfig<MarkConfig<Options, Storage>>['parseHTML']
+    }) => MarkSpec['parseDOM']
 
     /**
      * Render HTML
      */
-    renderHTML?: ((
-      this: {
-        name: string,
-        options: Options,
-        parent: ParentConfig<MarkConfig<Options>>['renderHTML'],
-      },
-      props: {
-        mark: ProseMirrorMark,
-        HTMLAttributes: Record<string, any>,
-      },
-    ) => DOMOutputSpec) | null,
+    renderHTML?:
+      | ((
+          this: {
+            name: string
+            options: Options
+            storage: Storage
+            parent: ParentConfig<MarkConfig<Options, Storage>>['renderHTML']
+          },
+          props: {
+            mark: ProseMirrorMark
+            HTMLAttributes: Record<string, any>
+          },
+        ) => DOMOutputSpec)
+      | null
 
     /**
      * Attributes
      */
-    addAttributes?: (
-      this: {
-        name: string,
-        options: Options,
-        parent: ParentConfig<MarkConfig<Options>>['addAttributes'],
-      },
-    ) => Attributes | {},
+    addAttributes?: (this: {
+      name: string
+      options: Options
+      storage: Storage
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addAttributes']
+    }) => Attributes | {}
   }
 }
 
-export class Mark<Options = any> {
+export class Mark<Options = any, Storage = any> {
   type = 'mark'
 
   name = 'mark'
@@ -331,23 +417,48 @@ export class Mark<Options = any> {
 
   options: Options
 
+  storage: Storage
+
   config: MarkConfig = {
     name: this.name,
     defaultOptions: {},
   }
 
-  constructor(config: Partial<MarkConfig<Options>> = {}) {
+  constructor(config: Partial<MarkConfig<Options, Storage>> = {}) {
     this.config = {
       ...this.config,
       ...config,
     }
 
     this.name = this.config.name
+
+    if (config.defaultOptions) {
+      console.warn(
+        `[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${this.name}".`,
+      )
+    }
+
+    // TODO: remove `addOptions` fallback
     this.options = this.config.defaultOptions
+
+    if (this.config.addOptions) {
+      this.options = callOrReturn(
+        getExtensionField<AnyConfig['addOptions']>(this, 'addOptions', {
+          name: this.name,
+        }),
+      )
+    }
+
+    this.storage = callOrReturn(
+      getExtensionField<AnyConfig['addStorage']>(this, 'addStorage', {
+        name: this.name,
+        options: this.options,
+      }),
+    ) || {}
   }
 
-  static create<O>(config: Partial<MarkConfig<O>> = {}) {
-    return new Mark<O>(config)
+  static create<O = any, S = any>(config: Partial<MarkConfig<O, S>> = {}) {
+    return new Mark<O, S>(config)
   }
 
   configure(options: Partial<Options> = {}) {
@@ -355,26 +466,76 @@ export class Mark<Options = any> {
     // with different calls of `configure`
     const extension = this.extend()
 
-    extension.options = mergeDeep(this.options, options) as Options
+    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
   }
 
-  extend<ExtendedOptions = Options>(extendedConfig: Partial<MarkConfig<ExtendedOptions>> = {}) {
-    const extension = new Mark<ExtendedOptions>(extendedConfig)
+  extend<ExtendedOptions = Options, ExtendedStorage = Storage>(
+    extendedConfig: Partial<MarkConfig<ExtendedOptions, ExtendedStorage>> = {},
+  ) {
+    const extension = new Mark<ExtendedOptions, ExtendedStorage>(extendedConfig)
 
     extension.parent = this
 
     this.child = extension
 
-    extension.name = extendedConfig.name
-      ? extendedConfig.name
-      : extension.parent.name
+    extension.name = extendedConfig.name ? extendedConfig.name : extension.parent.name
+
+    if (extendedConfig.defaultOptions) {
+      console.warn(
+        `[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${extension.name}".`,
+      )
+    }
 
-    extension.options = extendedConfig.defaultOptions
-      ? extendedConfig.defaultOptions
-      : extension.parent.options
+    extension.options = callOrReturn(
+      getExtensionField<AnyConfig['addOptions']>(extension, 'addOptions', {
+        name: extension.name,
+      }),
+    )
+
+    extension.storage = callOrReturn(
+      getExtensionField<AnyConfig['addStorage']>(extension, 'addStorage', {
+        name: extension.name,
+        options: extension.options,
+      }),
+    )
 
     return extension
   }
+
+  static handleExit({ editor, mark }: { editor: Editor; mark: Mark }) {
+    const { tr } = editor.state
+    const currentPos = editor.state.selection.$from
+    const isAtEnd = currentPos.pos === currentPos.end()
+
+    if (isAtEnd) {
+      const currentMarks = currentPos.marks()
+      const isInMark = !!currentMarks.find(m => m?.type.name === mark.name)
+
+      if (!isInMark) {
+        return false
+      }
+
+      const removeMark = currentMarks.find(m => m?.type.name === mark.name)
+
+      if (removeMark) {
+        tr.removeStoredMark(removeMark)
+      }
+      tr.insertText(' ', currentPos.pos)
+
+      editor.view.dispatch(tr)
+
+      return true
+    }
+
+    return false
+  }
 }