@tiptap/starter-kit 2.0.0-beta.105 → 2.0.0-beta.106

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

@@ -0,0 +1,193 @@
+import { Plugin, Transaction } from 'prosemirror-state';
+import { InputRule } from 'prosemirror-inputrules';
+import { Editor } from './Editor';
+import { Node } from './Node';
+import { Mark } from './Mark';
+import { Extensions, GlobalAttributes, RawCommands, ParentConfig, KeyboardShortcutCommand } from './types';
+import { ExtensionConfig } from '.';
+declare module '@tiptap/core' {
+    interface ExtensionConfig<Options = any> {
+        [key: string]: any;
+        /**
+         * Name
+         */
+        name: string;
+        /**
+         * Priority
+         */
+        priority?: number;
+        /**
+         * Default options
+         */
+        defaultOptions?: Options;
+        /**
+         * Global attributes
+         */
+        addGlobalAttributes?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<ExtensionConfig<Options>>['addGlobalAttributes'];
+        }) => GlobalAttributes | {};
+        /**
+         * Raw
+         */
+        addCommands?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['addCommands'];
+        }) => Partial<RawCommands>;
+        /**
+         * Keyboard shortcuts
+         */
+        addKeyboardShortcuts?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['addKeyboardShortcuts'];
+        }) => {
+            [key: string]: KeyboardShortcutCommand;
+        };
+        /**
+         * Input rules
+         */
+        addInputRules?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['addInputRules'];
+        }) => InputRule[];
+        /**
+         * Paste rules
+         */
+        addPasteRules?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['addPasteRules'];
+        }) => Plugin[];
+        /**
+         * ProseMirror plugins
+         */
+        addProseMirrorPlugins?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['addProseMirrorPlugins'];
+        }) => Plugin[];
+        /**
+         * Extensions
+         */
+        addExtensions?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<ExtensionConfig<Options>>['addExtensions'];
+        }) => Extensions;
+        /**
+         * Extend Node Schema
+         */
+        extendNodeSchema?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<ExtensionConfig<Options>>['extendNodeSchema'];
+        }, extension: Node) => Record<string, any>) | null;
+        /**
+         * Extend Mark Schema
+         */
+        extendMarkSchema?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<ExtensionConfig<Options>>['extendMarkSchema'];
+        }, extension: Mark) => Record<string, any>) | null;
+        /**
+         * The editor is not ready yet.
+         */
+        onBeforeCreate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['onBeforeCreate'];
+        }) => void) | null;
+        /**
+         * The editor is ready.
+         */
+        onCreate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['onCreate'];
+        }) => void) | null;
+        /**
+         * The content has changed.
+         */
+        onUpdate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['onUpdate'];
+        }) => void) | null;
+        /**
+         * The selection has changed.
+         */
+        onSelectionUpdate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['onSelectionUpdate'];
+        }) => void) | null;
+        /**
+         * The editor state has changed.
+         */
+        onTransaction?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['onTransaction'];
+        }, props: {
+            transaction: Transaction;
+        }) => void) | null;
+        /**
+         * The editor is focused.
+         */
+        onFocus?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['onFocus'];
+        }, props: {
+            event: FocusEvent;
+        }) => void) | null;
+        /**
+         * The editor isn’t focused anymore.
+         */
+        onBlur?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['onBlur'];
+        }, props: {
+            event: FocusEvent;
+        }) => void) | null;
+        /**
+         * The editor is destroyed.
+         */
+        onDestroy?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            parent: ParentConfig<ExtensionConfig<Options>>['onDestroy'];
+        }) => void) | null;
+    }
+}
+export declare class Extension<Options = any> {
+    type: string;
+    name: string;
+    parent: Extension | null;
+    child: Extension | null;
+    options: Options;
+    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>;
+}

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

@@ -0,0 +1,18 @@
+import { Schema } from 'prosemirror-model';
+import { Plugin } from 'prosemirror-state';
+import { Editor } from './Editor';
+import { Extensions, RawCommands } from './types';
+export default class ExtensionManager {
+    editor: Editor;
+    schema: Schema;
+    extensions: Extensions;
+    splittableMarks: string[];
+    constructor(extensions: Extensions, editor: Editor);
+    static resolve(extensions: Extensions): Extensions;
+    static flatten(extensions: Extensions): Extensions;
+    static sort(extensions: Extensions): Extensions;
+    get commands(): RawCommands;
+    get plugins(): Plugin[];
+    get attributes(): import("@tiptap/core").ExtensionAttribute[];
+    get nodeViews(): any;
+}

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

@@ -0,0 +1,269 @@
+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 { MarkConfig } from '.';
+import { Editor } from './Editor';
+declare module '@tiptap/core' {
+    interface MarkConfig<Options = any> {
+        [key: string]: any;
+        /**
+         * Name
+         */
+        name: string;
+        /**
+         * Priority
+         */
+        priority?: number;
+        /**
+         * Default options
+         */
+        defaultOptions?: Options;
+        /**
+         * Global attributes
+         */
+        addGlobalAttributes?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['addGlobalAttributes'];
+        }) => GlobalAttributes | {};
+        /**
+         * Raw
+         */
+        addCommands?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['addCommands'];
+        }) => Partial<RawCommands>;
+        /**
+         * Keyboard shortcuts
+         */
+        addKeyboardShortcuts?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['addKeyboardShortcuts'];
+        }) => {
+            [key: string]: KeyboardShortcutCommand;
+        };
+        /**
+         * Input rules
+         */
+        addInputRules?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['addInputRules'];
+        }) => InputRule[];
+        /**
+         * Paste rules
+         */
+        addPasteRules?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['addPasteRules'];
+        }) => Plugin[];
+        /**
+         * ProseMirror plugins
+         */
+        addProseMirrorPlugins?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['addProseMirrorPlugins'];
+        }) => Plugin[];
+        /**
+         * Extensions
+         */
+        addExtensions?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['addExtensions'];
+        }) => Extensions;
+        /**
+         * Extend Node Schema
+         */
+        extendNodeSchema?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['extendNodeSchema'];
+        }, extension: Node) => Record<string, any>) | null;
+        /**
+         * Extend Mark Schema
+         */
+        extendMarkSchema?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['extendMarkSchema'];
+        }, extension: Mark) => Record<string, any>) | null;
+        /**
+         * The editor is not ready yet.
+         */
+        onBeforeCreate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['onBeforeCreate'];
+        }) => void) | null;
+        /**
+         * The editor is ready.
+         */
+        onCreate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['onCreate'];
+        }) => void) | null;
+        /**
+         * The content has changed.
+         */
+        onUpdate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['onUpdate'];
+        }) => void) | null;
+        /**
+         * The selection has changed.
+         */
+        onSelectionUpdate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['onSelectionUpdate'];
+        }) => void) | null;
+        /**
+         * The editor state has changed.
+         */
+        onTransaction?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['onTransaction'];
+        }, props: {
+            transaction: Transaction;
+        }) => void) | null;
+        /**
+         * The editor is focused.
+         */
+        onFocus?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['onFocus'];
+        }, props: {
+            event: FocusEvent;
+        }) => void) | null;
+        /**
+         * The editor isn’t focused anymore.
+         */
+        onBlur?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['onBlur'];
+        }, props: {
+            event: FocusEvent;
+        }) => void) | null;
+        /**
+         * The editor is destroyed.
+         */
+        onDestroy?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options>>['onDestroy'];
+        }) => void) | null;
+        /**
+         * Keep mark after split node
+         */
+        keepOnSplit?: boolean | (() => boolean);
+        /**
+         * Inclusive
+         */
+        inclusive?: MarkSpec['inclusive'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['inclusive'];
+        }) => MarkSpec['inclusive']);
+        /**
+         * Excludes
+         */
+        excludes?: MarkSpec['excludes'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['excludes'];
+        }) => MarkSpec['excludes']);
+        /**
+         * Group
+         */
+        group?: MarkSpec['group'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['group'];
+        }) => MarkSpec['group']);
+        /**
+         * Spanning
+         */
+        spanning?: MarkSpec['spanning'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['spanning'];
+        }) => MarkSpec['spanning']);
+        /**
+         * Parse HTML
+         */
+        parseHTML?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['parseHTML'];
+        }) => MarkSpec['parseDOM'];
+        /**
+         * Render HTML
+         */
+        renderHTML?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['renderHTML'];
+        }, props: {
+            mark: ProseMirrorMark;
+            HTMLAttributes: Record<string, any>;
+        }) => DOMOutputSpec) | null;
+        /**
+         * Attributes
+         */
+        addAttributes?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<MarkConfig<Options>>['addAttributes'];
+        }) => Attributes | {};
+    }
+}
+export declare class Mark<Options = any> {
+    type: string;
+    name: string;
+    parent: Mark | null;
+    child: Mark | null;
+    options: Options;
+    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>;
+}