make extension configs extendable

packages/core/src/Mark.ts

@@ -7,188 +7,235 @@ import {
 import { Plugin, Transaction } from 'prosemirror-state'
 import { Command as ProseMirrorCommand } from 'prosemirror-commands'
 import { InputRule } from 'prosemirror-inputrules'
-import { ExtensionConfig } from './Extension'
 import mergeDeep from './utilities/mergeDeep'
-import { Attributes, Overwrite, RawCommands } from './types'
+import {
+  Attributes,
+  RawCommands,
+  GlobalAttributes,
+  MarkConfig,
+} from './types'
 import { Editor } from './Editor'
 
-export interface MarkConfig<Options = any> extends Overwrite<ExtensionConfig<Options>, {
-  /**
-   * Inclusive
-   */
-  inclusive?: MarkSpec['inclusive'] | ((this: { options: Options }) => MarkSpec['inclusive']),
+declare module '@tiptap/core' {
+  export interface MarkConfig<Options = any> {
+    /**
+     * Name
+     */
+    name: string,
 
-  /**
-   * Excludes
-   */
-  excludes?: MarkSpec['excludes'] | ((this: { options: Options }) => MarkSpec['excludes']),
+    /**
+     * Default options
+     */
+    defaultOptions?: Options,
 
-  /**
-   * Group
-   */
-  group?: MarkSpec['group'] | ((this: { options: Options }) => MarkSpec['group']),
-
-  /**
-   * Spanning
-   */
-  spanning?: MarkSpec['spanning'] | ((this: { options: Options }) => MarkSpec['spanning']),
-
-  /**
-   * Parse HTML
-   */
-  parseHTML?: (
-    this: {
+    /**
+     * Global attributes
+     */
+    addGlobalAttributes?: (this: {
       options: Options,
-    },
-  ) => MarkSpec['parseDOM'],
+    }) => GlobalAttributes | {},
 
-  /**
-   * Render HTML
-   */
-  renderHTML?: ((
-    this: {
-      options: Options,
-    },
-    props: {
-      mark: ProseMirrorMark,
-      HTMLAttributes: { [key: string]: any },
-    }
-  ) => DOMOutputSpec) | null,
-
-  /**
-   * Attributes
-   */
-  addAttributes?: (
-    this: {
-      options: Options,
-    },
-  ) => Attributes | {},
-
-  /**
-   * Commands
-   */
-  addCommands?: (this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => Partial<RawCommands>,
-
-  /**
-   * Keyboard shortcuts
-   */
-  addKeyboardShortcuts?: (this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => {
-    [key: string]: ProseMirrorCommand,
-  },
-
-  /**
-   * Input rules
-   */
-  addInputRules?: (this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => InputRule[],
-
-  /**
-   * Paste rules
-   */
-  addPasteRules?: (this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => Plugin[],
-
-  /**
-   * ProseMirror plugins
-   */
-  addProseMirrorPlugins?: (this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => Plugin[],
-
-  /**
-   * The editor is ready.
-   */
-  onCreate?: ((this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => void) | null,
-
-  /**
-   * The content has changed.
-   */
-  onUpdate?: ((this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => void) | null,
-
-  /**
-   * The selection has changed.
-   */
-  onSelection?: ((this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => void) | null,
-
-  /**
-   * The editor state has changed.
-   */
-  onTransaction?: ((
-    this: {
+    /**
+     * Raw
+     */
+    addCommands?: (this: {
       options: Options,
       editor: Editor,
       type: MarkType,
-    },
-    props: {
-      transaction: Transaction,
-    },
-  ) => void) | null,
+    }) => Partial<RawCommands>,
 
-  /**
-   * The editor is focused.
-   */
-  onFocus?: ((
-    this: {
+    /**
+     * Keyboard shortcuts
+     */
+    addKeyboardShortcuts?: (this: {
       options: Options,
       editor: Editor,
       type: MarkType,
+    }) => {
+      [key: string]: ProseMirrorCommand,
     },
-    props: {
-      event: FocusEvent,
-    },
-  ) => void) | null,
 
-  /**
-   * The editor isn’t focused anymore.
-   */
-  onBlur?: ((
-    this: {
+    /**
+     * Input rules
+     */
+    addInputRules?: (this: {
       options: Options,
       editor: Editor,
       type: MarkType,
-    },
-    props: {
-      event: FocusEvent,
-    },
-  ) => void) | null,
+    }) => InputRule[],
 
-  /**
-   * The editor is destroyed.
-   */
-  onDestroy?: ((this: {
-    options: Options,
-    editor: Editor,
-    type: MarkType,
-  }) => void) | null,
-}> {}
+    /**
+     * Paste rules
+     */
+    addPasteRules?: (this: {
+      options: Options,
+      editor: Editor,
+      type: MarkType,
+    }) => Plugin[],
+
+    /**
+     * ProseMirror plugins
+     */
+    addProseMirrorPlugins?: (this: {
+      options: Options,
+      editor: Editor,
+      type: MarkType,
+    }) => Plugin[],
+
+    /**
+     * Extend Node Schema
+     */
+    extendNodeSchema?: ((
+      this: {
+        options: Options,
+      },
+      extension: Node,
+    ) => {
+      [key: string]: any,
+    }) | null,
+
+    /**
+     * Extend Mark Schema
+     */
+    extendMarkSchema?: ((
+      this: {
+        options: Options,
+      },
+      extension: Node,
+    ) => {
+      [key: string]: any,
+    }) | null,
+
+    /**
+     * The editor is ready.
+     */
+    onCreate?: ((this: {
+      options: Options,
+      editor: Editor,
+      type: MarkType,
+    }) => void) | null,
+
+    /**
+     * The content has changed.
+     */
+    onUpdate?: ((this: {
+      options: Options,
+      editor: Editor,
+      type: MarkType,
+    }) => void) | null,
+
+    /**
+     * The selection has changed.
+     */
+    onSelection?: ((this: {
+      options: Options,
+      editor: Editor,
+      type: MarkType,
+    }) => void) | null,
+
+    /**
+     * The editor state has changed.
+     */
+    onTransaction?: ((
+      this: {
+        options: Options,
+        editor: Editor,
+        type: MarkType,
+      },
+      props: {
+        transaction: Transaction,
+      },
+    ) => void) | null,
+
+    /**
+     * The editor is focused.
+     */
+    onFocus?: ((
+      this: {
+        options: Options,
+        editor: Editor,
+        type: MarkType,
+      },
+      props: {
+        event: FocusEvent,
+      },
+    ) => void) | null,
+
+    /**
+     * The editor isn’t focused anymore.
+     */
+    onBlur?: ((
+      this: {
+        options: Options,
+        editor: Editor,
+        type: MarkType,
+      },
+      props: {
+        event: FocusEvent,
+      },
+    ) => void) | null,
+
+    /**
+     * The editor is destroyed.
+     */
+    onDestroy?: ((this: {
+      options: Options,
+      editor: Editor,
+      type: MarkType,
+    }) => void) | null,
+
+    /**
+     * Inclusive
+     */
+    inclusive?: MarkSpec['inclusive'] | ((this: { options: Options }) => MarkSpec['inclusive']),
+
+    /**
+     * Excludes
+     */
+    excludes?: MarkSpec['excludes'] | ((this: { options: Options }) => MarkSpec['excludes']),
+
+    /**
+     * Group
+     */
+    group?: MarkSpec['group'] | ((this: { options: Options }) => MarkSpec['group']),
+
+    /**
+     * Spanning
+     */
+    spanning?: MarkSpec['spanning'] | ((this: { options: Options }) => MarkSpec['spanning']),
+
+    /**
+     * Parse HTML
+     */
+    parseHTML?: (
+      this: {
+        options: Options,
+      },
+    ) => MarkSpec['parseDOM'],
+
+    /**
+     * Render HTML
+     */
+    renderHTML?: ((
+      this: {
+        options: Options,
+      },
+      props: {
+        mark: ProseMirrorMark,
+        HTMLAttributes: { [key: string]: any },
+      }
+    ) => DOMOutputSpec) | null,
+
+    /**
+     * Attributes
+     */
+    addAttributes?: (
+      this: {
+        options: Options,
+      },
+    ) => Attributes | {},
+  }
+}
 
 export class Mark<Options = any> {
   type = 'mark'