@tiptap/core 2.0.0-beta.20 → 2.0.0-beta.200

package/dist/packages/core/src/Mark.d.ts

@@ -1,12 +1,13 @@
-import { DOMOutputSpec, MarkSpec, Mark as ProseMirrorMark, MarkType } from 'prosemirror-model';
+import { DOMOutputSpec, Mark as ProseMirrorMark, MarkSpec, MarkType } from 'prosemirror-model';
 import { Plugin, Transaction } from 'prosemirror-state';
-import { Command as ProseMirrorCommand } from 'prosemirror-commands';
-import { InputRule } from 'prosemirror-inputrules';
-import { Attributes, RawCommands, GlobalAttributes } from './types';
 import { MarkConfig } from '.';
 import { Editor } from './Editor';
+import { InputRule } from './InputRule';
+import { Node } from './Node';
+import { PasteRule } from './PasteRule';
+import { Attributes, Extensions, GlobalAttributes, KeyboardShortcutCommand, ParentConfig, RawCommands } from './types';
 declare module '@tiptap/core' {
-    interface MarkConfig<Options = any> {
+    interface MarkConfig<Options = any, Storage = any> {
         [key: string]: any;
         /**
          * Name
@@ -20,109 +21,168 @@ declare module '@tiptap/core' {
          * 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;
-        }, extension: Node) => {
-            [key: string]: any;
-        }) | null;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['extendNodeSchema'];
+        }, extension: Node) => Record<string, any>) | null;
         /**
          * Extend Mark Schema
          */
         extendMarkSchema?: ((this: {
+            name: string;
             options: Options;
-        }, extension: Node) => {
-            [key: string]: any;
-        }) | null;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['extendMarkSchema'];
+        }, 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;
         /**
          * The editor state has changed.
          */
         onTransaction?: ((this: {
+            name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onTransaction'];
         }, props: {
             transaction: Transaction;
         }) => void) | null;
@@ -130,9 +190,12 @@ declare module '@tiptap/core' {
          * The editor is focused.
          */
         onFocus?: ((this: {
+            name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onFocus'];
         }, props: {
             event: FocusEvent;
         }) => void) | null;
@@ -140,9 +203,12 @@ declare module '@tiptap/core' {
          * The editor isn’t focused anymore.
          */
         onBlur?: ((this: {
+            name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onBlur'];
         }, props: {
             event: FocusEvent;
         }) => void) | null;
@@ -150,9 +216,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;
         /**
          * Keep mark after split node
@@ -162,58 +231,97 @@ declare module '@tiptap/core' {
          * 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;
+            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;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['group'];
         }) => MarkSpec['group']);
         /**
          * 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'];
         /**
          * Render HTML
          */
         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;
         /**
          * Attributes
          */
         addAttributes?: (this: {
+            name: string;
             options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addAttributes'];
         }) => Attributes | {};
     }
 }
-export declare class Mark<Options = any> {
-    #private;
+export declare class Mark<Options = any, Storage = any> {
     type: string;
-    config: MarkConfig;
+    name: string;
+    parent: Mark | null;
+    child: Mark | null;
     options: Options;
-    constructor(config: MarkConfig<Options>);
-    static create<O>(config: MarkConfig<O>): Mark<O>;
-    configure(options?: Partial<Options>): Mark<Options>;
-    extend<ExtendedOptions = Options>(extendedConfig: Partial<MarkConfig<ExtendedOptions>>): Mark<ExtendedOptions>;
+    storage: Storage;
+    config: MarkConfig;
+    constructor(config?: Partial<MarkConfig<Options, Storage>>);
+    static create<O = any, S = any>(config?: Partial<MarkConfig<O, S>>): Mark<O, S>;
+    configure(options?: Partial<Options>): Mark<Options, Storage>;
+    extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<MarkConfig<ExtendedOptions, ExtendedStorage>>): Mark<ExtendedOptions, ExtendedStorage>;
+    static handleExit({ editor, mark, }: {
+        editor: Editor;
+        mark: Mark;
+    }): boolean;
 }