@tiptap/core 2.0.0-beta.182 → 2.0.0-beta.193

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/core",
   "description": "headless rich text editor",
-  "version": "2.0.0-beta.182",
+  "version": "2.0.0-beta.193",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -37,6 +37,5 @@
     "url": "https://github.com/ueberdosis/tiptap",
     "directory": "packages/core"
   },
-  "sideEffects": false,
-  "gitHead": "3e05093f00dd4f52ddefeb2451622d3661a25123"
+  "sideEffects": false
 }

package/src/CommandManager.ts

@@ -107,13 +107,13 @@ export class CommandManager {
 
   public createCan(startTr?: Transaction): CanCommands {
     const { rawCommands, state } = this
-    const dispatch = undefined
+    const dispatch = false
     const tr = startTr || state.tr
     const props = this.buildProps(tr, dispatch)
     const formattedCommands = Object.fromEntries(Object
       .entries(rawCommands)
       .map(([name, command]) => {
-        return [name, (...args: never[]) => command(...args)({ ...props, dispatch })]
+        return [name, (...args: never[]) => command(...args)({ ...props, dispatch: undefined })]
       })) as unknown as SingleCommands
 
     return {

package/src/Editor.ts

@@ -169,6 +169,7 @@ export class Editor extends EventEmitter<EditorEvents> {
    */
   public setEditable(editable: boolean): void {
     this.setOptions({ editable })
+    this.emit('update', { editor: this, transaction: this.state.tr })
   }
 
   /**

package/src/ExtensionManager.ts

@@ -3,7 +3,7 @@ import { Node as ProsemirrorNode, Schema } from 'prosemirror-model'
 import { Plugin } from 'prosemirror-state'
 import { Decoration, EditorView } from 'prosemirror-view'
 
-import { NodeConfig } from '.'
+import { Mark, NodeConfig } from '.'
 import { Editor } from './Editor'
 import { getAttributesFromExtensions } from './helpers/getAttributesFromExtensions'
 import { getExtensionField } from './helpers/getExtensionField'
@@ -252,6 +252,13 @@ export class ExtensionManager {
           context,
         )
 
+        let defaultBindings: Record<string, () => boolean> = {}
+
+        // bind exit handling
+        if (extension.type === 'mark' && extension.config.exitable) {
+          defaultBindings.ArrowRight = () => Mark.handleExit({ editor, mark: (extension as Mark) })
+        }
+
         if (addKeyboardShortcuts) {
           const bindings = Object.fromEntries(
             Object
@@ -261,11 +268,13 @@ export class ExtensionManager {
               }),
           )
 
-          const keyMapPlugin = keymap(bindings)
-
-          plugins.push(keyMapPlugin)
+          defaultBindings = { ...defaultBindings, ...bindings }
         }
 
+        const keyMapPlugin = keymap(defaultBindings)
+
+        plugins.push(keyMapPlugin)
+
         const addInputRules = getExtensionField<AnyConfig['addInputRules']>(
           extension,
           'addInputRules',

package/src/Mark.ts

@@ -304,6 +304,11 @@ declare module '@tiptap/core' {
       parent: ParentConfig<MarkConfig<Options, Storage>>['excludes'],
     }) => MarkSpec['excludes']),
 
+    /**
+     * Marks this Mark as exitable
+     */
+    exitable?: boolean | (() => boolean),
+
     /**
      * Group
      */
@@ -486,4 +491,38 @@ export class Mark<Options = any, Storage = any> {
 
     return extension
   }
+
+  static handleExit({
+    editor,
+    mark,
+  }: {
+    editor: Editor
+    mark: Mark
+  }) {
+    const { tr } = editor.state
+    const currentPos = editor.state.selection.$from
+    const isAtEnd = currentPos.pos === currentPos.end()
+
+    if (isAtEnd) {
+      const currentMarks = currentPos.marks()
+      const isInMark = !!currentMarks.find(m => m?.type.name === mark.name)
+
+      if (!isInMark) {
+        return false
+      }
+
+      const removeMark = currentMarks.find(m => m?.type.name === mark.name)
+
+      if (removeMark) {
+        tr.removeStoredMark(removeMark)
+      }
+      tr.insertText(' ', currentPos.pos)
+
+      editor.view.dispatch(tr)
+
+      return true
+    }
+
+    return false
+  }
 }

package/src/PasteRule.ts

@@ -229,7 +229,7 @@ export function pasteRulesPlugin(props: { editor: Editor, rules: PasteRule[] }):
           editor,
           state: chainableState,
           from: Math.max(from - 1, 0),
-          to: to.b,
+          to: to.b - 1,
           rule,
         })
 

package/src/commands/setNodeSelection.ts

@@ -1,4 +1,4 @@
-import { NodeSelection, Selection } from 'prosemirror-state'
+import { NodeSelection } from 'prosemirror-state'
 
 import { RawCommands } from '../types'
 import { minMax } from '../utilities/minMax'
@@ -17,10 +17,8 @@ declare module '@tiptap/core' {
 export const setNodeSelection: RawCommands['setNodeSelection'] = position => ({ tr, dispatch }) => {
   if (dispatch) {
     const { doc } = tr
-    const minPos = Selection.atStart(doc).from
-    const maxPos = Selection.atEnd(doc).to
-    const resolvedPos = minMax(position, minPos, maxPos)
-    const selection = NodeSelection.create(doc, resolvedPos)
+    const from = minMax(position, 0, doc.content.size)
+    const selection = NodeSelection.create(doc, from)
 
     tr.setSelection(selection)
   }

package/src/commands/splitBlock.ts

@@ -1,21 +1,10 @@
-import { ContentMatch } from 'prosemirror-model'
 import { EditorState, NodeSelection, TextSelection } from 'prosemirror-state'
 import { canSplit } from 'prosemirror-transform'
 
+import { defaultBlockAt } from '../helpers/defaultBlockAt'
 import { getSplittedAttributes } from '../helpers/getSplittedAttributes'
 import { RawCommands } from '../types'
 
-function defaultBlockAt(match: ContentMatch) {
-  for (let i = 0; i < match.edgeCount; i += 1) {
-    const { type } = match.edge(i)
-
-    if (type.isTextblock && !type.hasRequiredAttrs()) {
-      return type
-    }
-  }
-  return null
-}
-
 function ensureMarks(state: EditorState, splittableMarks?: string[]) {
   const marks = state.storedMarks
     || (state.selection.$to.parentOffset && state.selection.$from.marks())

package/src/helpers/isNodeSelection.ts

@@ -1,7 +1,5 @@
 import { NodeSelection } from 'prosemirror-state'
 
-import { isObject } from '../utilities/isObject'
-
 export function isNodeSelection(value: unknown): value is NodeSelection {
-  return isObject(value) && value instanceof NodeSelection
+  return value instanceof NodeSelection
 }

package/src/helpers/isTextSelection.ts

@@ -1,7 +1,5 @@
 import { TextSelection } from 'prosemirror-state'
 
-import { isObject } from '../utilities/isObject'
-
 export function isTextSelection(value: unknown): value is TextSelection {
-  return isObject(value) && value instanceof TextSelection
+  return value instanceof TextSelection
 }

package/src/pasteRules/nodePasteRule.ts

@@ -29,7 +29,7 @@ export function nodePasteRule(config: {
       if (match.input) {
         chain()
           .deleteRange(range)
-          .insertContent({
+          .insertContentAt(range.from, {
             type: config.type.name,
             attrs: attributes,
           })

package/LICENSE.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021, überdosis GbR
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

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

@@ -1,20 +0,0 @@
-import { EditorState, Transaction } from 'prosemirror-state';
-import { Editor } from './Editor';
-import { AnyCommands, CanCommands, ChainedCommands, CommandProps, SingleCommands } from './types';
-export declare class CommandManager {
-    editor: Editor;
-    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;
-}

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

@@ -1,147 +0,0 @@
-import { MarkType, NodeType, Schema } from 'prosemirror-model';
-import { EditorState, Plugin, PluginKey, Transaction } from 'prosemirror-state';
-import { EditorView } from 'prosemirror-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<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.
-     */
-    get commands(): SingleCommands;
-    /**
-     * Create a command chain to call multiple commands at once.
-     */
-    chain(): ChainedCommands;
-    /**
-     * Check if a command or a command chain can be executed. Without executing it.
-     */
-    can(): CanCommands;
-    /**
-     * Inject CSS styles.
-     */
-    private injectCSS;
-    /**
-     * Update editor options.
-     *
-     * @param options A list of options
-     */
-    setOptions(options?: Partial<EditorOptions>): void;
-    /**
-     * Update editable state of the editor.
-     */
-    setEditable(editable: boolean): void;
-    /**
-     * Returns whether the editor is editable.
-     */
-    get isEditable(): boolean;
-    /**
-     * Returns the editor state.
-     */
-    get state(): EditorState;
-    /**
-     * Register a ProseMirror plugin.
-     *
-     * @param plugin A ProseMirror plugin
-     * @param handlePlugins Control how to merge the plugin into the existing plugins.
-     */
-    registerPlugin(plugin: Plugin, handlePlugins?: (newPlugin: Plugin, plugins: Plugin[]) => Plugin[]): void;
-    /**
-     * Unregister a ProseMirror plugin.
-     *
-     * @param nameOrPluginKey The plugins name
-     */
-    unregisterPlugin(nameOrPluginKey: string | PluginKey): void;
-    /**
-     * Creates an extension manager.
-     */
-    private createExtensionManager;
-    /**
-     * Creates an command manager.
-     */
-    private createCommandManager;
-    /**
-     * Creates a ProseMirror schema.
-     */
-    private createSchema;
-    /**
-     * Creates a ProseMirror view.
-     */
-    private createView;
-    /**
-     * Creates all node views.
-     */
-    createNodeViews(): void;
-    isCapturingTransaction: boolean;
-    private capturedTransaction;
-    captureTransaction(fn: Function): Transaction | null;
-    /**
-     * The callback over which to send transactions (state updates) produced by the view.
-     *
-     * @param transaction An editor state transaction
-     */
-    private dispatchTransaction;
-    /**
-     * Get attributes of the currently selected node or mark.
-     */
-    getAttributes(nameOrType: string | NodeType | MarkType): Record<string, any>;
-    /**
-     * Returns if the currently selected node or mark is active.
-     *
-     * @param name Name of the node or mark
-     * @param attributes Attributes of the node or mark
-     */
-    isActive(name: string, attributes?: {}): boolean;
-    isActive(attributes: {}): boolean;
-    /**
-     * Get the document as JSON.
-     */
-    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;
-    /**
-     * Destroy the editor.
-     */
-    destroy(): void;
-    /**
-     * Check if the editor is already destroyed.
-     */
-    get isDestroyed(): boolean;
-}

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

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