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

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

@@ -1,13 +1,20 @@
-import { EditorState, Transaction } from 'prosemirror-state';
+import { EditorState, Transaction } from '@tiptap/pm/state';
 import { Editor } from './Editor';
-import { SingleCommands, ChainedCommands, CanCommands, AnyCommands, CommandProps } from './types';
-export default class CommandManager {
+import { AnyCommands, CanCommands, ChainedCommands, CommandProps, SingleCommands } from './types';
+export declare class CommandManager {
     editor: Editor;
-    commands: AnyCommands;
-    constructor(editor: Editor, commands: AnyCommands);
-    createCommands(): SingleCommands;
+    rawCommands: AnyCommands;
+    customState?: EditorState;
+    constructor(props: {
+        editor: Editor;
+        state?: EditorState;
+    });
+    get hasCustomState(): boolean;
+    get state(): EditorState;
+    get commands(): SingleCommands;
+    get chain(): () => ChainedCommands;
+    get can(): () => CanCommands;
     createChain(startTr?: Transaction, shouldDispatch?: boolean): ChainedCommands;
     createCan(startTr?: Transaction): CanCommands;
     buildProps(tr: Transaction, shouldDispatch?: boolean): CommandProps;
-    chainableState(tr: Transaction, state: EditorState): EditorState;
 }

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

@@ -1,23 +1,28 @@
-import { EditorState, Plugin, PluginKey, Transaction } from 'prosemirror-state';
-import { EditorView } from 'prosemirror-view';
-import { Schema, MarkType, NodeType } from 'prosemirror-model';
-import ExtensionManager from './ExtensionManager';
-import EventEmitter from './EventEmitter';
-import { EditorOptions, CanCommands, ChainedCommands, SingleCommands } from './types';
+import { MarkType, NodeType, Schema } from '@tiptap/pm/model';
+import { EditorState, Plugin, PluginKey, Transaction } from '@tiptap/pm/state';
+import { EditorView } from '@tiptap/pm/view';
+import { EventEmitter } from './EventEmitter';
+import { ExtensionManager } from './ExtensionManager';
 import * as extensions from './extensions';
+import { CanCommands, ChainedCommands, EditorEvents, EditorOptions, JSONContent, SingleCommands, TextSerializer } from './types';
 export { extensions };
 export interface HTMLElement {
     editor?: Editor;
 }
-export declare class Editor extends EventEmitter {
+export declare class Editor extends EventEmitter<EditorEvents> {
     private commandManager;
     extensionManager: ExtensionManager;
     private css;
     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.
      */
@@ -43,7 +48,7 @@ export declare class Editor extends EventEmitter {
     /**
      * Update editable state of the editor.
      */
-    setEditable(editable: boolean): void;
+    setEditable(editable: boolean, emitUpdate?: boolean): void;
     /**
      * Returns whether the editor is editable.
      */
@@ -62,7 +67,7 @@ export declare class Editor extends EventEmitter {
     /**
      * Unregister a ProseMirror plugin.
      *
-     * @param name The plugins name
+     * @param nameOrPluginKey The plugins name
      */
     unregisterPlugin(nameOrPluginKey: string | PluginKey): void;
     /**
@@ -87,7 +92,7 @@ export declare class Editor extends EventEmitter {
     createNodeViews(): void;
     isCapturingTransaction: boolean;
     private capturedTransaction;
-    captureTransaction(fn: Function): Transaction<any> | null;
+    captureTransaction(fn: Function): Transaction | null;
     /**
      * The callback over which to send transactions (state updates) produced by the view.
      *
@@ -109,17 +114,26 @@ export declare class Editor extends EventEmitter {
     /**
      * Get the document as JSON.
      */
-    getJSON(): Record<string, any>;
+    getJSON(): JSONContent;
     /**
      * Get the document as HTML.
      */
     getHTML(): string;
+    /**
+     * Get the document as text.
+     */
+    getText(options?: {
+        blockSeparator?: string;
+        textSerializers?: Record<string, TextSerializer>;
+    }): string;
     /**
      * Check if there is no content.
      */
     get isEmpty(): boolean;
     /**
      * Get the number of characters for the current document.
+     *
+     * @deprecated
      */
     getCharacterCount(): number;
     /**

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

@@ -1,7 +1,11 @@
-export default class EventEmitter {
+declare type StringKeyOf<T> = Extract<keyof T, string>;
+declare type CallbackType<T extends Record<string, any>, EventName extends StringKeyOf<T>> = T[EventName] extends any[] ? T[EventName] : [T[EventName]];
+declare type CallbackFunction<T extends Record<string, any>, EventName extends StringKeyOf<T>> = (...props: CallbackType<T, EventName>) => any;
+export declare class EventEmitter<T extends Record<string, any>> {
     private callbacks;
-    on(event: string, fn: Function): this;
-    protected emit(event: string, ...args: any): this;
-    off(event: string, fn?: Function): this;
+    on<EventName extends StringKeyOf<T>>(event: EventName, fn: CallbackFunction<T, EventName>): this;
+    protected emit<EventName extends StringKeyOf<T>>(event: EventName, ...args: CallbackType<T, EventName>): this;
+    off<EventName extends StringKeyOf<T>>(event: EventName, fn?: CallbackFunction<T, EventName>): this;
     protected removeAllListeners(): void;
 }
+export {};

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

@@ -1,12 +1,13 @@
-import { Plugin, Transaction } from 'prosemirror-state';
-import { InputRule } from 'prosemirror-inputrules';
+import { Plugin, Transaction } from '@tiptap/pm/state';
+import { ExtensionConfig } from '.';
 import { Editor } from './Editor';
-import { Node } from './Node';
+import { InputRule } from './InputRule';
 import { Mark } from './Mark';
-import { Extensions, GlobalAttributes, RawCommands, ParentConfig, KeyboardShortcutCommand } from './types';
-import { ExtensionConfig } from '.';
+import { Node } from './Node';
+import { PasteRule } from './PasteRule';
+import { Extensions, GlobalAttributes, KeyboardShortcutCommand, ParentConfig, RawCommands } from './types';
 declare module '@tiptap/core' {
-    interface ExtensionConfig<Options = any> {
+    interface ExtensionConfig<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<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
@@ -34,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
@@ -43,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;
         };
@@ -54,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
@@ -63,17 +83,19 @@ declare module '@tiptap/core' {
         addPasteRules?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['addPasteRules'];
-        }) => Plugin[];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addPasteRules'];
+        }) => PasteRule[];
         /**
          * ProseMirror plugins
          */
         addProseMirrorPlugins?: (this: {
             name: string;
             options: Options;
+            storage: Storage;
             editor: Editor;
-            parent: ParentConfig<ExtensionConfig<Options>>['addProseMirrorPlugins'];
+            parent: ParentConfig<ExtensionConfig<Options, Storage>>['addProseMirrorPlugins'];
         }) => Plugin[];
         /**
          * Extensions
@@ -81,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
@@ -89,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
@@ -97,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.
@@ -105,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.
@@ -114,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.
@@ -123,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.
@@ -132,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.
@@ -141,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;
@@ -152,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;
@@ -163,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;
@@ -174,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/ExtensionManager.d.ts

@@ -1,8 +1,8 @@
-import { Schema } from 'prosemirror-model';
-import { Plugin } from 'prosemirror-state';
+import { Schema } from '@tiptap/pm/model';
+import { Plugin } from '@tiptap/pm/state';
 import { Editor } from './Editor';
 import { Extensions, RawCommands } from './types';
-export default class ExtensionManager {
+export declare class ExtensionManager {
     editor: Editor;
     schema: Schema;
     extensions: Extensions;
@@ -15,5 +15,4 @@ export default class ExtensionManager {
     get plugins(): Plugin[];
     get attributes(): import("@tiptap/core").ExtensionAttribute[];
     get nodeViews(): any;
-    get textSerializers(): any;
 }

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

@@ -0,0 +1,42 @@
+import { EditorState, Plugin } from '@tiptap/pm/state';
+import { Editor } from './Editor';
+import { CanCommands, ChainedCommands, ExtendedRegExpMatchArray, Range, SingleCommands } from './types';
+export declare type InputRuleMatch = {
+    index: number;
+    text: string;
+    replaceWith?: string;
+    match?: RegExpMatchArray;
+    data?: Record<string, any>;
+};
+export declare type InputRuleFinder = RegExp | ((text: string) => InputRuleMatch | null);
+export declare class InputRule {
+    find: InputRuleFinder;
+    handler: (props: {
+        state: EditorState;
+        range: Range;
+        match: ExtendedRegExpMatchArray;
+        commands: SingleCommands;
+        chain: () => ChainedCommands;
+        can: () => CanCommands;
+    }) => void | null;
+    constructor(config: {
+        find: InputRuleFinder;
+        handler: (props: {
+            state: EditorState;
+            range: Range;
+            match: ExtendedRegExpMatchArray;
+            commands: SingleCommands;
+            chain: () => ChainedCommands;
+            can: () => CanCommands;
+        }) => void | null;
+    });
+}
+/**
+ * Create an input rules plugin. When enabled, it will cause text
+ * input that matches any of the given rules to trigger the rule’s
+ * action.
+ */
+export declare function inputRulesPlugin(props: {
+    editor: Editor;
+    rules: InputRule[];
+}): Plugin;