@tiptap/core 2.0.0-beta.99 → 2.0.0-rc.1

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

@@ -1,12 +1,13 @@
-import { DOMOutputSpec, MarkSpec, Mark as ProseMirrorMark, MarkType } from 'prosemirror-model';
-import { Plugin, Transaction } from 'prosemirror-state';
-import { InputRule } from 'prosemirror-inputrules';
-import { Extensions, Attributes, RawCommands, GlobalAttributes, ParentConfig, KeyboardShortcutCommand } from './types';
-import { Node } from './Node';
+import { DOMOutputSpec, Mark as ProseMirrorMark, MarkSpec, MarkType } from '@tiptap/pm/model';
+import { Plugin, Transaction } from '@tiptap/pm/state';
 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,13 +21,29 @@ 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;
-            parent: ParentConfig<MarkConfig<Options>>['addGlobalAttributes'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addGlobalAttributes'];
         }) => GlobalAttributes | {};
         /**
          * Raw
@@ -34,9 +51,10 @@ declare module '@tiptap/core' {
         addCommands?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['addCommands'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addCommands'];
         }) => Partial<RawCommands>;
         /**
          * Keyboard shortcuts
@@ -44,9 +62,10 @@ declare module '@tiptap/core' {
         addKeyboardShortcuts?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['addKeyboardShortcuts'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addKeyboardShortcuts'];
         }) => {
             [key: string]: KeyboardShortcutCommand;
         };
@@ -56,9 +75,10 @@ declare module '@tiptap/core' {
         addInputRules?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['addInputRules'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addInputRules'];
         }) => InputRule[];
         /**
          * Paste rules
@@ -66,19 +86,21 @@ declare module '@tiptap/core' {
         addPasteRules?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['addPasteRules'];
-        }) => 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>>['addProseMirrorPlugins'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addProseMirrorPlugins'];
         }) => Plugin[];
         /**
          * Extensions
@@ -86,7 +108,8 @@ declare module '@tiptap/core' {
         addExtensions?: (this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['addExtensions'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addExtensions'];
         }) => Extensions;
         /**
          * Extend Node Schema
@@ -94,7 +117,8 @@ declare module '@tiptap/core' {
         extendNodeSchema?: ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['extendNodeSchema'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['extendNodeSchema'];
         }, extension: Node) => Record<string, any>) | null;
         /**
          * Extend Mark Schema
@@ -102,7 +126,8 @@ declare module '@tiptap/core' {
         extendMarkSchema?: ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['extendMarkSchema'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['extendMarkSchema'];
         }, extension: Mark) => Record<string, any>) | null;
         /**
          * The editor is not ready yet.
@@ -110,9 +135,10 @@ declare module '@tiptap/core' {
         onBeforeCreate?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['onBeforeCreate'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onBeforeCreate'];
         }) => void) | null;
         /**
          * The editor is ready.
@@ -120,9 +146,10 @@ declare module '@tiptap/core' {
         onCreate?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['onCreate'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onCreate'];
         }) => void) | null;
         /**
          * The content has changed.
@@ -130,9 +157,10 @@ declare module '@tiptap/core' {
         onUpdate?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['onUpdate'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onUpdate'];
         }) => void) | null;
         /**
          * The selection has changed.
@@ -140,9 +168,10 @@ declare module '@tiptap/core' {
         onSelectionUpdate?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['onSelectionUpdate'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onSelectionUpdate'];
         }) => void) | null;
         /**
          * The editor state has changed.
@@ -150,9 +179,10 @@ declare module '@tiptap/core' {
         onTransaction?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['onTransaction'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onTransaction'];
         }, props: {
             transaction: Transaction;
         }) => void) | null;
@@ -162,9 +192,10 @@ declare module '@tiptap/core' {
         onFocus?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['onFocus'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onFocus'];
         }, props: {
             event: FocusEvent;
         }) => void) | null;
@@ -174,9 +205,10 @@ declare module '@tiptap/core' {
         onBlur?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['onBlur'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onBlur'];
         }, props: {
             event: FocusEvent;
         }) => void) | null;
@@ -186,9 +218,10 @@ declare module '@tiptap/core' {
         onDestroy?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['onDestroy'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onDestroy'];
         }) => void) | null;
         /**
          * Keep mark after split node
@@ -200,7 +233,8 @@ declare module '@tiptap/core' {
         inclusive?: MarkSpec['inclusive'] | ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['inclusive'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['inclusive'];
         }) => MarkSpec['inclusive']);
         /**
          * Excludes
@@ -208,15 +242,21 @@ declare module '@tiptap/core' {
         excludes?: MarkSpec['excludes'] | ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['excludes'];
+            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;
-            parent: ParentConfig<MarkConfig<Options>>['group'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['group'];
         }) => MarkSpec['group']);
         /**
          * Spanning
@@ -224,15 +264,26 @@ declare module '@tiptap/core' {
         spanning?: MarkSpec['spanning'] | ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['spanning'];
+            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;
-            parent: ParentConfig<MarkConfig<Options>>['parseHTML'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['parseHTML'];
         }) => MarkSpec['parseDOM'];
         /**
          * Render HTML
@@ -240,7 +291,8 @@ declare module '@tiptap/core' {
         renderHTML?: ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['renderHTML'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['renderHTML'];
         }, props: {
             mark: ProseMirrorMark;
             HTMLAttributes: Record<string, any>;
@@ -251,19 +303,25 @@ declare module '@tiptap/core' {
         addAttributes?: (this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['addAttributes'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addAttributes'];
         }) => Attributes | {};
     }
 }
-export declare class Mark<Options = any> {
+export declare class Mark<Options = any, Storage = any> {
     type: string;
     name: string;
     parent: Mark | null;
     child: Mark | null;
     options: Options;
+    storage: Storage;
     config: MarkConfig;
-    constructor(config?: Partial<MarkConfig<Options>>);
-    static create<O>(config?: Partial<MarkConfig<O>>): Mark<O>;
-    configure(options?: Partial<Options>): Mark<Options>;
-    extend<ExtendedOptions = Options>(extendedConfig?: Partial<MarkConfig<ExtendedOptions>>): Mark<ExtendedOptions>;
+    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;
 }