@tiptap/react 2.0.0-beta.83 → 2.0.0-beta.87

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

@@ -16,8 +16,13 @@ export declare class Editor extends EventEmitter<EditorEvents> {
     schema: Schema;
     view: EditorView;
     isFocused: boolean;
+    extensionStorage: Record<string, any>;
     options: EditorOptions;
     constructor(options?: Partial<EditorOptions>);
+    /**
+     * Returns the editor storage.
+     */
+    get storage(): Record<string, any>;
     /**
      * An object of all registered commands.
      */

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

@@ -7,7 +7,7 @@ import { Mark } from './Mark';
 import { Extensions, GlobalAttributes, RawCommands, ParentConfig, KeyboardShortcutCommand } from './types';
 import { ExtensionConfig } from '.';
 declare module '@tiptap/core' {
-    interface ExtensionConfig<Options = any> {
+    interface ExtensionConfig<Options = any, Storage = any> {
         [key: string]: any;
         /**
          * Name
@@ -21,13 +21,29 @@ declare module '@tiptap/core' {
          * Default options
          */
         defaultOptions?: Options;
+        /**
+         * Default Options
+         */
+        addOptions?: (this: {
+            name: string;
+            parent: Exclude<ParentConfig<ExtensionConfig<Options, Storage>>['addOptions'], undefined>;
+        }) => Options;
+        /**
+         * Default Storage
+         */
+        addStorage?: (this: {
+            name: string;
+            options: Options;
+            parent: Exclude<ParentConfig<ExtensionConfig<Options, Storage>>['addStorage'], undefined>;
+        }) => Storage;
         /**
          * Global attributes
          */
         addGlobalAttributes?: (this: {
             name: string;
             options: Options;
-            parent: ParentConfig<ExtensionConfig<Options>>['addGlobalAttributes'];
+            storage: Storage;
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addGlobalAttributes'];
         }) => GlobalAttributes | {};
         /**
          * Raw
@@ -35,8 +51,9 @@ declare module '@tiptap/core' {
         addCommands?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['addCommands'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addCommands'];
         }) => Partial<RawCommands>;
         /**
          * Keyboard shortcuts
@@ -44,8 +61,9 @@ declare module '@tiptap/core' {
         addKeyboardShortcuts?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['addKeyboardShortcuts'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addKeyboardShortcuts'];
         }) => {
             [key: string]: KeyboardShortcutCommand;
         };
@@ -55,8 +73,9 @@ declare module '@tiptap/core' {
         addInputRules?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['addInputRules'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addInputRules'];
         }) => InputRule[];
         /**
          * Paste rules
@@ -64,8 +83,9 @@ declare module '@tiptap/core' {
         addPasteRules?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['addPasteRules'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addPasteRules'];
         }) => PasteRule[];
         /**
          * ProseMirror plugins
@@ -73,8 +93,9 @@ declare module '@tiptap/core' {
         addProseMirrorPlugins?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['addProseMirrorPlugins'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addProseMirrorPlugins'];
         }) => Plugin[];
         /**
          * Extensions
@@ -82,7 +103,8 @@ declare module '@tiptap/core' {
         addExtensions?: (this: {
             name: string;
             options: Options;
-            parent: ParentConfig<ExtensionConfig<Options>>['addExtensions'];
+            storage: Storage;
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addExtensions'];
         }) => Extensions;
         /**
          * Extend Node Schema
@@ -90,7 +112,8 @@ declare module '@tiptap/core' {
         extendNodeSchema?: ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<ExtensionConfig<Options>>['extendNodeSchema'];
+            storage: Storage;
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['extendNodeSchema'];
         }, extension: Node) => Record<string, any>) | null;
         /**
          * Extend Mark Schema
@@ -98,7 +121,8 @@ declare module '@tiptap/core' {
         extendMarkSchema?: ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<ExtensionConfig<Options>>['extendMarkSchema'];
+            storage: Storage;
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['extendMarkSchema'];
         }, extension: Mark) => Record<string, any>) | null;
         /**
          * The editor is not ready yet.
@@ -106,8 +130,9 @@ declare module '@tiptap/core' {
         onBeforeCreate?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['onBeforeCreate'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['onBeforeCreate'];
         }) => void) | null;
         /**
          * The editor is ready.
@@ -115,8 +140,9 @@ declare module '@tiptap/core' {
         onCreate?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['onCreate'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['onCreate'];
         }) => void) | null;
         /**
          * The content has changed.
@@ -124,8 +150,9 @@ declare module '@tiptap/core' {
         onUpdate?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['onUpdate'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['onUpdate'];
         }) => void) | null;
         /**
          * The selection has changed.
@@ -133,8 +160,9 @@ declare module '@tiptap/core' {
         onSelectionUpdate?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['onSelectionUpdate'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['onSelectionUpdate'];
         }) => void) | null;
         /**
          * The editor state has changed.
@@ -142,8 +170,9 @@ declare module '@tiptap/core' {
         onTransaction?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['onTransaction'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['onTransaction'];
         }, props: {
             transaction: Transaction;
         }) => void) | null;
@@ -153,8 +182,9 @@ declare module '@tiptap/core' {
         onFocus?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['onFocus'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['onFocus'];
         }, props: {
             event: FocusEvent;
         }) => void) | null;
@@ -164,8 +194,9 @@ declare module '@tiptap/core' {
         onBlur?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['onBlur'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['onBlur'];
         }, props: {
             event: FocusEvent;
         }) => void) | null;
@@ -175,20 +206,22 @@ declare module '@tiptap/core' {
         onDestroy?: ((this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['onDestroy'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['onDestroy'];
         }) => void) | null;
     }
 }
-export declare class Extension<Options = any> {
+export declare class Extension<Options = any, Storage = any> {
     type: string;
     name: string;
     parent: Extension | null;
     child: Extension | null;
     options: Options;
+    storage: Storage;
     config: ExtensionConfig;
-    constructor(config?: Partial<ExtensionConfig<Options>>);
-    static create<O>(config?: Partial<ExtensionConfig<O>>): Extension<O>;
-    configure(options?: Partial<Options>): Extension<Options>;
-    extend<ExtendedOptions = Options>(extendedConfig?: Partial<ExtensionConfig<ExtendedOptions>>): Extension<ExtendedOptions>;
+    constructor(config?: Partial<ExtensionConfig<Options, Storage>>);
+    static create<O = any, S = any>(config?: Partial<ExtensionConfig<O, S>>): Extension<O, S>;
+    configure(options?: Partial<Options>): Extension<Options, Storage>;
+    extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<ExtensionConfig<ExtendedOptions, ExtendedStorage>>): Extension<ExtendedOptions, ExtendedStorage>;
 }

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

@@ -7,7 +7,7 @@ import { Node } from './Node';
 import { MarkConfig } from '.';
 import { Editor } from './Editor';
 declare module '@tiptap/core' {
-    interface MarkConfig<Options = any> {
+    interface MarkConfig<Options = any, Storage = any> {
         [key: string]: any;
         /**
          * Name
@@ -21,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
@@ -35,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
@@ -45,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;
         };
@@ -57,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
@@ -67,9 +86,10 @@ declare module '@tiptap/core' {
         addPasteRules?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
             type: MarkType;
-            parent: ParentConfig<MarkConfig<Options>>['addPasteRules'];
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addPasteRules'];
         }) => PasteRule[];
         /**
          * ProseMirror plugins
@@ -77,9 +97,10 @@ declare module '@tiptap/core' {
         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
@@ -87,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
@@ -95,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
@@ -103,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.
@@ -111,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.
@@ -121,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.
@@ -131,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.
@@ -141,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.
@@ -151,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;
@@ -163,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;
@@ -175,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;
@@ -187,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
@@ -201,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
@@ -209,7 +242,8 @@ 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']);
         /**
          * Group
@@ -217,7 +251,8 @@ declare module '@tiptap/core' {
         group?: MarkSpec['group'] | ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['group'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['group'];
         }) => MarkSpec['group']);
         /**
          * Spanning
@@ -225,7 +260,8 @@ 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
@@ -233,7 +269,8 @@ declare module '@tiptap/core' {
         code?: boolean | ((this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['code'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['code'];
         }) => boolean);
         /**
          * Parse HTML
@@ -241,7 +278,8 @@ declare module '@tiptap/core' {
         parseHTML?: (this: {
             name: string;
             options: Options;
-            parent: ParentConfig<MarkConfig<Options>>['parseHTML'];
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['parseHTML'];
         }) => MarkSpec['parseDOM'];
         /**
          * Render HTML
@@ -249,7 +287,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>;
@@ -260,19 +299,21 @@ 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>;
 }