import { Plugin, Transaction } from '@tiptap/pm/state' import { Editor } from './Editor.js' import { getExtensionField } from './helpers/getExtensionField.js' import { ExtensionConfig } from './index.js' import { InputRule } from './InputRule.js' import { Mark } from './Mark.js' import { Node } from './Node.js' import { PasteRule } from './PasteRule.js' import { AnyConfig, Extensions, GlobalAttributes, KeyboardShortcutCommand, ParentConfig, RawCommands, } from './types.js' import { callOrReturn } from './utilities/callOrReturn.js' import { mergeDeep } from './utilities/mergeDeep.js' declare module '@tiptap/core' { interface ExtensionConfig { [key: string]: any /** * Name */ name: string /** * Priority */ priority?: number /** * Default options */ defaultOptions?: Options /** * Default Options */ addOptions?: (this: { name: string parent: Exclude>['addOptions'], undefined> }) => Options /** * Default Storage */ addStorage?: (this: { name: string options: Options parent: Exclude>['addStorage'], undefined> }) => Storage /** * Global attributes */ addGlobalAttributes?: (this: { name: string options: Options storage: Storage parent: ParentConfig>['addGlobalAttributes'] }) => GlobalAttributes | {} /** * Raw */ addCommands?: (this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['addCommands'] }) => Partial /** * Keyboard shortcuts */ addKeyboardShortcuts?: (this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['addKeyboardShortcuts'] }) => { [key: string]: KeyboardShortcutCommand } /** * Input rules */ addInputRules?: (this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['addInputRules'] }) => InputRule[] /** * Paste rules */ addPasteRules?: (this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['addPasteRules'] }) => PasteRule[] /** * ProseMirror plugins */ addProseMirrorPlugins?: (this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['addProseMirrorPlugins'] }) => Plugin[] /** * Extensions */ addExtensions?: (this: { name: string options: Options storage: Storage parent: ParentConfig>['addExtensions'] }) => Extensions /** * Extend Node Schema */ extendNodeSchema?: | (( this: { name: string options: Options storage: Storage parent: ParentConfig>['extendNodeSchema'] }, extension: Node, ) => Record) | null /** * Extend Mark Schema */ extendMarkSchema?: | (( this: { name: string options: Options storage: Storage parent: ParentConfig>['extendMarkSchema'] }, extension: Mark, ) => Record) | null /** * The editor is not ready yet. */ onBeforeCreate?: | ((this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['onBeforeCreate'] }) => void) | null /** * The editor is ready. */ onCreate?: | ((this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['onCreate'] }) => void) | null /** * The content has changed. */ onUpdate?: | ((this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['onUpdate'] }) => void) | null /** * The selection has changed. */ onSelectionUpdate?: | ((this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['onSelectionUpdate'] }) => void) | null /** * The editor state has changed. */ onTransaction?: | (( this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['onTransaction'] }, props: { transaction: Transaction }, ) => void) | null /** * The editor is focused. */ onFocus?: | (( this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['onFocus'] }, props: { event: FocusEvent }, ) => void) | null /** * The editor isn’t focused anymore. */ onBlur?: | (( this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['onBlur'] }, props: { event: FocusEvent }, ) => void) | null /** * The editor is destroyed. */ onDestroy?: | ((this: { name: string options: Options storage: Storage editor: Editor parent: ParentConfig>['onDestroy'] }) => void) | null } } export class Extension { type = 'extension' name = 'extension' parent: Extension | null = null child: Extension | null = null options: Options storage: Storage config: ExtensionConfig = { name: this.name, defaultOptions: {}, } constructor(config: Partial> = {}) { this.config = { ...this.config, ...config, } this.name = this.config.name if (config.defaultOptions && Object.keys(config.defaultOptions).length > 0) { 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(this, 'addOptions', { name: this.name, }), ) } this.storage = callOrReturn( getExtensionField(this, 'addStorage', { name: this.name, options: this.options, }), ) || {} } static create(config: Partial> = {}) { return new Extension(config) } configure(options: Partial = {}) { // 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, options) as Options extension.storage = callOrReturn( getExtensionField(extension, 'addStorage', { name: extension.name, options: extension.options, }), ) return extension } extend( extendedConfig: Partial> = {}, ) { const extension = new Extension({ ...this.config, ...extendedConfig }) extension.parent = this 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(extension, 'addOptions', { name: extension.name, }), ) extension.storage = callOrReturn( getExtensionField(extension, 'addStorage', { name: extension.name, options: extension.options, }), ) return extension } }