@tiptap/core 2.0.0-beta.17 → 2.0.0-beta.170

package/src/Mark.ts

@@ -5,15 +5,26 @@ import {
   MarkType,
 } from 'prosemirror-model'
 import { Plugin, Transaction } from 'prosemirror-state'
-import { Command as ProseMirrorCommand } from 'prosemirror-commands'
-import { InputRule } from 'prosemirror-inputrules'
-import mergeDeep from './utilities/mergeDeep'
-import { Attributes, RawCommands, GlobalAttributes } from './types'
+import { InputRule } from './InputRule'
+import { PasteRule } from './PasteRule'
+import { mergeDeep } from './utilities/mergeDeep'
+import { callOrReturn } from './utilities/callOrReturn'
+import { getExtensionField } from './helpers/getExtensionField'
+import {
+  AnyConfig,
+  Extensions,
+  Attributes,
+  RawCommands,
+  GlobalAttributes,
+  ParentConfig,
+  KeyboardShortcutCommand,
+} from './types'
+import { Node } from './Node'
 import { MarkConfig } from '.'
 import { Editor } from './Editor'
 
 declare module '@tiptap/core' {
-  export interface MarkConfig<Options = any> {
+  export interface MarkConfig<Options = any, Storage = any> {
     [key: string]: any;
 
     /**
@@ -21,123 +32,187 @@ declare module '@tiptap/core' {
      */
     name: string,
 
+    /**
+     * Priority
+     */
+    priority?: number,
+
     /**
      * Default 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,
+      storage: Storage,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addGlobalAttributes'],
     }) => GlobalAttributes | {},
 
     /**
      * Raw
      */
     addCommands?: (this: {
+      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,
+      storage: Storage,
       editor: Editor,
       type: MarkType,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addKeyboardShortcuts'],
     }) => {
-      [key: string]: ProseMirrorCommand,
+      [key: string]: KeyboardShortcutCommand,
     },
 
     /**
      * Input rules
      */
     addInputRules?: (this: {
+      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,
+      storage: Storage,
       editor: Editor,
       type: MarkType,
-    }) => Plugin[],
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addPasteRules'],
+    }) => PasteRule[],
 
     /**
      * ProseMirror plugins
      */
     addProseMirrorPlugins?: (this: {
+      name: string,
       options: Options,
+      storage: Storage,
       editor: Editor,
       type: MarkType,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addProseMirrorPlugins'],
     }) => Plugin[],
 
+    /**
+     * Extensions
+     */
+    addExtensions?: (this: {
+      name: string,
+      options: Options,
+      storage: Storage,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['addExtensions'],
+    }) => Extensions,
+
     /**
      * Extend Node Schema
      */
     extendNodeSchema?: ((
       this: {
+        name: string,
         options: Options,
+        storage: Storage,
+        parent: ParentConfig<MarkConfig<Options, Storage>>['extendNodeSchema'],
       },
       extension: Node,
-    ) => {
-      [key: string]: any,
-    }) | null,
+    ) => Record<string, any>) | null,
 
     /**
      * Extend Mark Schema
      */
     extendMarkSchema?: ((
       this: {
+        name: string,
         options: Options,
+        storage: Storage,
+        parent: ParentConfig<MarkConfig<Options, Storage>>['extendMarkSchema'],
       },
-      extension: Node,
-    ) => {
-      [key: string]: any,
-    }) | null,
+      extension: Mark,
+    ) => Record<string, any>) | null,
 
     /**
-     * The editor is ready.
+     * The editor is not ready yet.
      */
-    onCreate?: ((this: {
+    onBeforeCreate?: ((this: {
+      name: string,
       options: Options,
+      storage: Storage,
       editor: Editor,
       type: MarkType,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['onBeforeCreate'],
     }) => void) | null,
 
     /**
-     * The content has changed.
+     * The editor is ready.
      */
-    onUpdate?: ((this: {
+    onCreate?: ((this: {
+      name: string,
       options: Options,
+      storage: Storage,
       editor: Editor,
       type: MarkType,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['onCreate'],
     }) => void) | null,
 
     /**
-     * The selection has changed.
+     * The content has changed.
      */
-    onSelectionUpdate?: ((this: {
+    onUpdate?: ((this: {
+      name: string,
       options: Options,
+      storage: Storage,
       editor: Editor,
       type: MarkType,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['onUpdate'],
     }) => void) | null,
 
     /**
-     * The view has changed.
+     * The selection has changed.
      */
-    onViewUpdate?: ((this: {
+    onSelectionUpdate?: ((this: {
+      name: string,
       options: Options,
+      storage: Storage,
       editor: Editor,
       type: MarkType,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['onSelectionUpdate'],
     }) => void) | null,
 
     /**
@@ -145,9 +220,12 @@ declare module '@tiptap/core' {
      */
     onTransaction?: ((
       this: {
+        name: string,
         options: Options,
+        storage: Storage,
         editor: Editor,
         type: MarkType,
+        parent: ParentConfig<MarkConfig<Options, Storage>>['onTransaction'],
       },
       props: {
         transaction: Transaction,
@@ -159,9 +237,12 @@ declare module '@tiptap/core' {
      */
     onFocus?: ((
       this: {
+        name: string,
         options: Options,
+        storage: Storage,
         editor: Editor,
         type: MarkType,
+        parent: ParentConfig<MarkConfig<Options, Storage>>['onFocus'],
       },
       props: {
         event: FocusEvent,
@@ -173,9 +254,12 @@ declare module '@tiptap/core' {
      */
     onBlur?: ((
       this: {
+        name: string,
         options: Options,
+        storage: Storage,
         editor: Editor,
         type: MarkType,
+        parent: ParentConfig<MarkConfig<Options, Storage>>['onBlur'],
       },
       props: {
         event: FocusEvent,
@@ -186,9 +270,12 @@ declare module '@tiptap/core' {
      * The editor is destroyed.
      */
     onDestroy?: ((this: {
+      name: string,
       options: Options,
+      storage: Storage,
       editor: Editor,
       type: MarkType,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['onDestroy'],
     }) => void) | null,
 
     /**
@@ -199,29 +286,62 @@ declare module '@tiptap/core' {
     /**
      * Inclusive
      */
-    inclusive?: MarkSpec['inclusive'] | ((this: { options: Options }) => 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: { options: Options }) => MarkSpec['excludes']),
+    excludes?: MarkSpec['excludes'] | ((this: {
+      name: string,
+      options: Options,
+      storage: Storage,
+      parent: ParentConfig<MarkConfig<Options, Storage>>['excludes'],
+    }) => MarkSpec['excludes']),
 
     /**
      * Group
      */
-    group?: MarkSpec['group'] | ((this: { options: Options }) => 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: { options: Options }) => 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,
+        storage: Storage,
+        parent: ParentConfig<MarkConfig<Options, Storage>>['parseHTML'],
       },
     ) => MarkSpec['parseDOM'],
 
@@ -230,12 +350,15 @@ declare module '@tiptap/core' {
      */
     renderHTML?: ((
       this: {
+        name: string,
         options: Options,
+        storage: Storage,
+        parent: ParentConfig<MarkConfig<Options, Storage>>['renderHTML'],
       },
       props: {
         mark: ProseMirrorMark,
-        HTMLAttributes: { [key: string]: any },
-      }
+        HTMLAttributes: Record<string, any>,
+      },
     ) => DOMOutputSpec) | null,
 
     /**
@@ -243,51 +366,123 @@ declare module '@tiptap/core' {
      */
     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'
+
+  parent: Mark | null = null
+
+  child: Mark | null = null
+
+  options: Options
+
+  storage: Storage
+
   config: MarkConfig = {
-    name: 'mark',
+    name: this.name,
     defaultOptions: {},
   }
 
-  options!: Options
-
-  constructor(config: 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: 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> = {}) {
-    return Mark
-      .create<Options>(this.config as MarkConfig<Options>)
-      .#configure(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, options) as Options
+
+    extension.storage = callOrReturn(getExtensionField<AnyConfig['addStorage']>(
+      extension,
+      'addStorage',
+      {
+        name: extension.name,
+        options: extension.options,
+      },
+    ))
+
+    return extension
   }
 
-  #configure = (options: Partial<Options>) => {
-    this.options = mergeDeep(this.config.defaultOptions, options) as Options
+  extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig: Partial<MarkConfig<ExtendedOptions, ExtendedStorage>> = {}) {
+    const extension = new Mark<ExtendedOptions, ExtendedStorage>(extendedConfig)
 
-    return this
-  }
+    extension.parent = this
 
-  extend<ExtendedOptions = Options>(extendedConfig: Partial<MarkConfig<ExtendedOptions>>) {
-    return new Mark<ExtendedOptions>({
-      ...this.config,
-      ...extendedConfig,
-    } as MarkConfig<ExtendedOptions>)
+    this.child = extension
+
+    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 = 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
   }
 }