import { DOMOutputSpec, MarkSpec, Mark as ProseMirrorMark, 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 { MarkConfig } from '.' import { Editor } from './Editor' declare module '@tiptap/core' { export interface MarkConfig { [key: string]: any; /** * Name */ name: string, /** * Default options */ defaultOptions?: Options, /** * Global attributes */ addGlobalAttributes?: (this: { options: Options, }) => GlobalAttributes | {}, /** * Raw */ addCommands?: (this: { options: Options, editor: Editor, type: MarkType, }) => Partial, /** * 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[], /** * 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 not ready yet. */ onBeforeCreate?: ((this: { options: Options, editor: Editor, type: MarkType, }) => void) | 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. */ onSelectionUpdate?: ((this: { options: Options, editor: Editor, type: MarkType, }) => void) | null, /** * The view has changed. */ onViewUpdate?: ((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, /** * Keep mark after split node */ keepOnSplit?: boolean | (() => boolean), /** * 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 { type = 'mark' config: MarkConfig = { name: 'mark', defaultOptions: {}, } options!: Options constructor(config: MarkConfig) { this.config = { ...this.config, ...config, } this.options = this.config.defaultOptions } static create(config: MarkConfig) { return new Mark(config) } configure(options: Partial = {}) { return Mark .create(this.config as MarkConfig) .#configure(options) } #configure = (options: Partial) => { this.options = mergeDeep(this.config.defaultOptions, options) as Options return this } extend(extendedConfig: Partial>) { return new Mark({ ...this.config, ...extendedConfig, } as MarkConfig) } }