@handlewithcare/react-prosemirror 3.1.0-tiptap.51 → 3.1.0-tiptap.53

package/dist/esm/hooks/useNodeViewDescription.js

@@ -1,10 +1,8 @@
 import { useCallback, useContext, useMemo, useRef } from "react";
 import { ReactEditorView } from "../ReactEditorView.js";
-import { CursorWrapper } from "../components/CursorWrapper.js";
 import { ChildDescriptionsContext } from "../contexts/ChildDescriptionsContext.js";
 import { EditorContext } from "../contexts/EditorContext.js";
-import { ReactWidgetType } from "../decorations/ReactWidgetType.js";
-import { CompositionViewDesc, MarkViewDesc, ReactNodeViewDesc, WidgetViewDesc, sortViewDescs } from "../viewdesc.js";
+import { ReactNodeViewDesc, TextViewDesc, sortViewDescs } from "../viewdesc.js";
 import { useClientLayoutEffect } from "./useClientLayoutEffect.js";
 import { useEffectEvent } from "./useEffectEvent.js";
 export function useNodeViewDescription(getDOM, getContentDOM, constructor, props) {
@@ -134,30 +132,51 @@ export function useNodeViewDescription(getDOM, getContentDOM, constructor, props
         for (const child of children){
             child.parent = viewDesc;
         }
+    });
+    const findCompositionDOM = useCallback((compositionViewDesc)=>{
         if (!props.node.isTextblock) return;
+        const children = childrenRef.current;
         // Because TextNodeViews can't locate the DOM nodes
         // for compositions, we need to override them here
         if (!viewDescRef.current?.contentDOM) return;
-        const compositionChildIndex = children.findIndex((child)=>child instanceof CompositionViewDesc);
-        if (compositionChildIndex === -1) return;
-        const compositionViewDesc = children[compositionChildIndex];
-        if (!(compositionViewDesc instanceof CompositionViewDesc)) return;
         let compositionTopDOM = null;
-        let search = children[compositionChildIndex - 1];
-        while(search instanceof MarkViewDesc){
-            search = search.children[0];
-        }
-        if (search instanceof WidgetViewDesc && search.widget.type instanceof ReactWidgetType && search.widget.type.Component === CursorWrapper) {
-            compositionTopDOM = search.dom.nextSibling;
-        } else {
-            for (const childNode of viewDescRef.current.contentDOM.childNodes){
-                if (children.every((child)=>child.dom !== childNode)) {
-                    compositionTopDOM = childNode;
-                    break;
-                }
+        for (const childNode of viewDescRef.current.contentDOM.childNodes){
+            if (children.every((child)=>child.dom !== childNode)) {
+                compositionTopDOM = childNode;
+                break;
             }
         }
-        if (!compositionTopDOM) return;
+        if (!compositionTopDOM) {
+            // Otherwise the IME extended an existing tracked text node. Take it over.
+            const reactView = view;
+            const imeTextNode = reactView.input.compositionNode;
+            if (!imeTextNode || !viewDescRef.current.contentDOM.contains(imeTextNode.parentNode)) {
+                return;
+            }
+            const claimedDesc = imeTextNode.pmViewDesc;
+            if (!(claimedDesc instanceof TextViewDesc)) return;
+            if (claimedDesc.node.text === imeTextNode.nodeValue) return; // not extended
+            // Walk up to the direct child of contentDOM that contains the IME text node
+            // (could be the text node itself, could be wrapped in a mark span).
+            let topDOM = imeTextNode;
+            while(topDOM.parentNode !== viewDescRef.current.contentDOM){
+                const next = topDOM.parentNode;
+                if (!next) return;
+                topDOM = next;
+            }
+            // Detach the displaced TextViewDesc from the sibling list so sibling-size
+            // accounting (used by posBeforeChild) doesn't double-count this text node.
+            const displacedIdx = children.indexOf(claimedDesc);
+            if (displacedIdx >= 0) children.splice(displacedIdx, 1);
+            reactView.displacedNodes.push(claimedDesc);
+            compositionViewDesc.dom = topDOM;
+            compositionViewDesc.textDOM = imeTextNode;
+            compositionViewDesc.text = imeTextNode.data;
+            imeTextNode.pmViewDesc = compositionViewDesc;
+            compositionViewDesc._displacedDesc = claimedDesc;
+            reactView.input.compositionNodes.push(compositionViewDesc);
+            return;
+        }
         let textDOM = compositionTopDOM;
         while(textDOM.firstChild){
             textDOM = textDOM.firstChild;
@@ -171,13 +190,16 @@ export function useNodeViewDescription(getDOM, getContentDOM, constructor, props
         compositionViewDesc.text = textDOM.data;
         compositionViewDesc.textDOM.pmViewDesc = compositionViewDesc;
         view.input.compositionNodes.push(compositionViewDesc);
-    });
+    }, [
+        props.node.isTextblock,
+        view
+    ]);
     const childContextValue = useMemo(()=>({
             parentRef: viewDescRef,
-            siblingsRef: childrenRef
+            siblingsRef: childrenRef,
+            findCompositionDOM
         }), [
-        childrenRef,
-        viewDescRef
+        findCompositionDOM
     ]);
     return {
         childContextValue,

package/dist/esm/plugins/beforeInputPlugin.js

@@ -3,6 +3,8 @@ import { Plugin, TextSelection } from "prosemirror-state";
 import { ReactEditorView } from "../ReactEditorView.js";
 import { CursorWrapper } from "../components/CursorWrapper.js";
 import { widget } from "../decorations/ReactWidgetType.js";
+import { TextViewDesc, sortViewDescs } from "../viewdesc.js";
+import { reactKeysPluginKey } from "./reactKeys.js";
 function insertText(view, eventData) {
     let options = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : {};
     if (eventData === null) return false;
@@ -45,26 +47,64 @@ function handleGapCursorComposition(view) {
     tr.setSelection(TextSelection.near(tr.doc.resolve($from.pos + 1)));
     view.dispatch(tr);
 }
-export function beforeInputPlugin(setCursorWrapper) {
+export function beforeInputPlugin() {
     let compositionMarks = null;
     return new Plugin({
         props: {
             handleDOMEvents: {
                 compositionstart (view) {
                     if (!(view instanceof ReactEditorView)) return false;
-                    view.input.composing = true;
+                    view.compositionStarting = true;
+                    const { state } = view;
+                    const { selection } = state;
+                    const isEmptyTr = state.tr.delete(selection.from, selection.to);
+                    const $from = isEmptyTr.doc.resolve(isEmptyTr.mapping.map(selection.from));
+                    const isEmptyTextblock = $from.parent.isTextblock && $from.parent.childCount === 0;
                     compositionMarks = view.state.storedMarks;
-                    const tr = view.state.tr.deleteSelection().setStoredMarks(null);
+                    // Render a CursorWrapper with empty marks if starting a composition in an
+                    // empty textblock with no marks. This prevents the browser from adding a
+                    // <br> to the text block when it becomes empty (either via canceling the
+                    // composition with the escape key or deleting all composition text when
+                    // the composition node is the only text node in the text block)
+                    if (compositionMarks === null && isEmptyTextblock) {
+                        compositionMarks = [];
+                    }
+                    const tr = view.state.tr.setStoredMarks(null);
                     view.dispatch(tr);
                     handleGapCursorComposition(view);
-                    const { state } = view;
-                    if (compositionMarks?.length) {
-                        setCursorWrapper(widget(state.selection.from, CursorWrapper, {
-                            key: "cursor-wrapper",
-                            marks: compositionMarks,
-                            side: 1
+                    if (compositionMarks) {
+                        view.dispatch(view.state.tr.setMeta(reactKeysPluginKey, {
+                            cursorWrapper: widget(state.selection.from, CursorWrapper, {
+                                key: "cursor-wrapper",
+                                marks: compositionMarks,
+                                side: 0,
+                                raw: true
+                            })
                         }));
+                    // Pin the DOM cursor to PM's canonical position before the IME
+                    // captures wherever the browser happened to leave it. Without this,
+                    // a cursor at a mark boundary lands in either the left or right text
+                    // node depending on the user's last navigation direction, and the
+                    // IME composes into whichever one it found.
+                    } else if (view.state.selection.empty) {
+                        // @ts-expect-error internal method
+                        view.domObserver.disconnectSelection();
+                        try {
+                            view.docView.setSelection(view.state.selection.anchor, view.state.selection.head, view, true // force — skip the isEquivalentPosition early-return
+                            );
+                        } finally{
+                            // @ts-expect-error internal method
+                            view.domObserver.setCurSelection();
+                            // @ts-expect-error internal method
+                            view.domObserver.connectSelection();
+                        }
                     }
+                    view.compositionStarting = false;
+                    // We set composing to true after creating the cursor wrapper
+                    // so that no existing text nodes try to protect themselves
+                    // while we're creating the cursor wrapper, which may need
+                    // to split a text node.
+                    view.input.composing = true;
                     return true;
                 },
                 compositionupdate () {
@@ -75,17 +115,40 @@ export function beforeInputPlugin(setCursorWrapper) {
                     if (!view.composing) return false;
                     view.input.composing = false;
                     compositionMarks = null;
-                    setCursorWrapper(null);
-                    if (view.input.compositionNode && !view.input.compositionNode.pmViewDesc) {
+                    for (const displaced of view.displacedNodes){
+                        // Put the displaced TextViewDesc back into its parent's child list.
+                        const parent = displaced.parent;
+                        if (parent && !parent.children.includes(displaced)) {
+                            parent.children.push(displaced);
+                            parent.children.sort(sortViewDescs);
+                        }
+                        // Restore pmViewDesc claim on the text node.
+                        displaced.dom.pmViewDesc = displaced;
+                        // Truncate the IME text node back to what the displaced PM node says it
+                        // is. The composed content lives in PM state; the next React render will
+                        // mount a sibling TextNodeView that inserts its own DOM (e.g.
+                        // `<span class="word">k</span>`) right after this node.
+                        const claimedText = displaced.node.text ?? "";
+                        if (displaced.nodeDOM.nodeValue !== claimedText) {
+                            displaced.nodeDOM.nodeValue = claimedText;
+                        }
+                    }
+                    view.dispatch(view.state.tr.setMeta(reactKeysPluginKey, {
+                        cursorWrapper: null
+                    }));
+                    if (view.input.compositionNode && isCompositionNodeOrphaned(view.input.compositionNode)) {
                         view.input.compositionNode.remove();
                     }
                     view.input.compositionEndedAt = event.timeStamp;
                     view.input.compositionNode = null;
+                    view.input.compositionNodes = [];
                     view.input.compositionID++;
                     return true;
                 },
                 beforeinput (view, event) {
-                    event.preventDefault();
+                    if (event.inputType !== "insertFromComposition") {
+                        event.preventDefault();
+                    }
                     switch(event.inputType){
                         case "insertParagraph":
                         case "insertLineBreak":
@@ -131,7 +194,10 @@ export function beforeInputPlugin(setCursorWrapper) {
                                 break;
                             }
                         case "insertCompositionText":
+                        case "deleteCompositionText":
+                        case "insertFromComposition":
                             {
+                                if (!(view instanceof ReactEditorView)) break;
                                 const { tr } = view.state;
                                 // There's always a range on insertCompositionText beforeinput events
                                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -147,7 +213,37 @@ export function beforeInputPlugin(setCursorWrapper) {
                                 } else {
                                     tr.delete(start, end);
                                 }
+                                // When updating a composition within an existing text node,
+                                // we need to avoid remounting it. If the composition is at
+                                // the very beginning of the text node, the start position of
+                                // that node will either be mapped forward (if inserting new
+                                // content) or deleted (if replacing existing content).
+                                //
+                                // This will cause the reactKeys plugin to mint a new key for
+                                // that node, which triggers a remount. So we check to see whether
+                                // we're working on a composition at the very beginning of a text
+                                // node, and if so, tell the react keys plugin not to change the
+                                // key for that node.
+                                //
+                                // We need to check that the marks are the same — if they're not,
+                                // then we're inserting text _before_ this text node, not at the
+                                // start of it, so we actually _do_ want to map the exsting node
+                                // forward.
+                                const $start = view.state.doc.resolve(start);
+                                const $end = view.state.doc.resolve(end);
+                                const marks = compositionMarks ?? $start.marksAcross($end) ?? [];
+                                if ($start.textOffset === 0 && $end.nodeAfter?.marks.every((m)=>m.isInSet(marks))) {
+                                    tr.setMeta(reactKeysPluginKey, {
+                                        overrides: {
+                                            [start]: start
+                                        }
+                                    });
+                                }
                                 view.dom.addEventListener("input", ()=>{
+                                    const sel = view.domSelectionRange();
+                                    if (sel.focusNode && sel.focusNode.nodeType === 3) {
+                                        view.input.compositionNode = sel.focusNode;
+                                    }
                                     view.dispatch(tr);
                                 }, {
                                     once: true
@@ -187,3 +283,11 @@ export function beforeInputPlugin(setCursorWrapper) {
         }
     });
 }
+function isCompositionNodeOrphaned(tn) {
+    if (tn.pmViewDesc) return false;
+    for(let parent = tn.parentNode; parent; parent = parent.parentNode){
+        const desc = parent.pmViewDesc;
+        if (desc instanceof TextViewDesc && desc.nodeDOM === tn) return false;
+    }
+    return true;
+}

package/dist/esm/plugins/componentEventListeners.js

@@ -1,4 +1,3 @@
-import { Plugin, PluginKey } from "prosemirror-state";
 import { unstable_batchedUpdates as batch } from "react-dom";
 export function componentEventListeners(eventHandlerRegistry) {
     const domEventHandlers = {};
@@ -7,7 +6,7 @@ export function componentEventListeners(eventHandlerRegistry) {
             for (const handler of handlers){
                 let handled = false;
                 batch(()=>{
-                    handled = !!handler.call(this, view, event);
+                    handled = !!handler(view, event);
                 });
                 if (handled || event.defaultPrevented) return true;
             }
@@ -15,11 +14,5 @@ export function componentEventListeners(eventHandlerRegistry) {
         }
         domEventHandlers[eventType] = handleEvent;
     }
-    const plugin = new Plugin({
-        key: new PluginKey("@handlewithcare/react-prosemirror/componentEventListeners"),
-        props: {
-            handleDOMEvents: domEventHandlers
-        }
-    });
-    return plugin;
+    return domEventHandlers;
 }

package/dist/esm/plugins/reactKeys.js

@@ -1,4 +1,6 @@
 import { Plugin, PluginKey } from "prosemirror-state";
+import { DecorationSet } from "prosemirror-view";
+import { widget } from "../decorations/ReactWidgetType.js";
 export function createNodeKey() {
     const key = Math.floor(Math.random() * 0xffffffffffff).toString(16);
     return key;
@@ -11,14 +13,14 @@ export const reactKeysPluginKey = new PluginKey("@handlewithcare/react-prosemirr
  * key for a given node can be accessed by that node's
  * current position in the document, and vice versa.
  */ export function reactKeys() {
-    let composing = false;
     return new Plugin({
         key: reactKeysPluginKey,
         state: {
             init (_, state) {
                 const next = {
                     posToKey: new Map(),
-                    keyToPos: new Map()
+                    keyToPos: new Map(),
+                    cursorWrapper: null
                 };
                 state.doc.descendants((_, pos)=>{
                     const key = createNodeKey();
@@ -36,14 +38,20 @@ export const reactKeysPluginKey = new PluginKey("@handlewithcare/react-prosemirr
        * and assign its key to that new position, dropping it if the
        * node was deleted.
        */ apply (tr, value, _, newState) {
-                if (!tr.docChanged || composing) {
-                    return value;
-                }
-                const overrides = tr.getMeta(reactKeysPluginKey)?.overrides;
+                const meta = tr.getMeta(reactKeysPluginKey);
+                const overrides = meta && "overrides" in meta ? meta.overrides : {};
+                const cursorWrapper = meta && "cursorWrapper" in meta ? meta.cursorWrapper : undefined;
                 const next = {
                     posToKey: new Map(),
-                    keyToPos: new Map()
+                    keyToPos: new Map(),
+                    cursorWrapper: cursorWrapper === undefined ? value.cursorWrapper ? widget(tr.mapping.map(value.cursorWrapper.from, -1), value.cursorWrapper.type.Component, value.cursorWrapper.spec) : null : cursorWrapper
                 };
+                if (!tr.docChanged) {
+                    return {
+                        ...value,
+                        cursorWrapper: next.cursorWrapper
+                    };
+                }
                 const posToKeyEntries = Array.from(value.posToKey.entries()).sort((param, param1)=>{
                     let [a] = param, [b] = param1;
                     return a - b;
@@ -69,13 +77,12 @@ export const reactKeysPluginKey = new PluginKey("@handlewithcare/react-prosemirr
             }
         },
         props: {
-            handleDOMEvents: {
-                compositionstart: ()=>{
-                    composing = true;
-                },
-                compositionend: ()=>{
-                    composing = false;
-                }
+            decorations (state) {
+                const deco = reactKeysPluginKey.getState(state)?.cursorWrapper;
+                if (!deco) return DecorationSet.empty;
+                return DecorationSet.create(state.doc, [
+                    deco
+                ]);
             }
         }
     });

package/dist/esm/tiptap/hooks/useTiptapEditor.js

@@ -2,7 +2,13 @@ import { StaticEditorView } from "../../StaticEditorView.js";
 import { ReactProseMirror } from "../extensions/ReactProseMirror.js";
 import { ReactProseMirrorCommands } from "../extensions/ReactProseMirrorCommands.js";
 import { useEditor } from "./useEditor.js";
-export function useTiptapEditor(options, deps) {
+/**
+ * Create a React ProseMirror integrated Tiptap Editor instance.
+ * @param options The editor options
+ * @param deps The dependencies to watch for changes
+ * @returns The editor instance
+ * @example const editor = useEditor({ extensions: [...] })
+ */ export function useTiptapEditor(options, deps) {
     const extensions = [
         ReactProseMirror,
         ...options.extensions ?? []

package/dist/esm/tiptap/utils/ssrJSDOMPatch.js

@@ -0,0 +1,56 @@
+/**
+ * This file is used to patch global DOM variables in a NodeJS environment.
+ * This is needed for ProseMirror to work in a NodeJS environment.
+ */ if (typeof window === "undefined") {
+    // Make sure to import JSDOM only in a NodeJS environment.
+    // The magic comments prevent bundlers from statically analyzing this require:
+    // - webpackIgnore: true  → webpack / Next.js
+    // - @vite-ignore         → Vite
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const jsdom = require(/* webpackIgnore: true */ /* @vite-ignore */ "jsdom");
+    const html = `
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Testing</title>
+  </head>
+  <body></body>
+</html>
+`;
+    const { window: window1 } = new jsdom.JSDOM(html);
+    global.window = window1;
+    global.document = window1.document;
+    // Use Object.defineProperty for navigator since it's read-only in Node.js 22+
+    Object.defineProperty(global, "navigator", {
+        value: window1.navigator,
+        writable: true,
+        configurable: true
+    });
+    global.innerHeight = 0;
+    global.SVGElement = window1.SVGElement;
+    // @ts-expect-error stub getSelection for SSR
+    document.getSelection = ()=>({});
+    document.createRange = ()=>({
+            setStart () {},
+            setEnd () {},
+            // @ts-expect-error stub getBoundingClientRect for SSR
+            getClientRects () {
+                return {
+                    left: 0,
+                    top: 0,
+                    right: 0,
+                    bottom: 0
+                };
+            },
+            // @ts-expect-error stub getBoundingClientRect for SSR
+            getBoundingClientRect () {
+                return {
+                    left: 0,
+                    top: 0,
+                    right: 0,
+                    bottom: 0
+                };
+            }
+        });
+}
+export { };

package/dist/esm/viewdesc.js

@@ -16,7 +16,17 @@ import { domIndex, isEquivalentPosition } from "./dom.js";
 export function sortViewDescs(a, b) {
     if (a instanceof TrailingHackViewDesc) return 1;
     if (b instanceof TrailingHackViewDesc) return -1;
-    return a.getPos() - b.getPos();
+    const posDiff = a.getPos() - b.getPos();
+    if (posDiff !== 0) return posDiff;
+    // When two descs share the same PM position (e.g. a zero-width widget
+    // and a text node that starts at the same position), fall back to DOM
+    // order so that the viewdesc children match the actual DOM layout.
+    // Without this, position computations like `posBeforeChild` can return
+    // the wrong PM position for the widget's container.
+    const cmp = a.dom.compareDocumentPosition(b.dom);
+    if (cmp & 4 /* DOCUMENT_POSITION_FOLLOWING */ ) return -1;
+    if (cmp & 2 /* DOCUMENT_POSITION_PRECEDING */ ) return 1;
+    return 0;
 }
 const NOT_DIRTY = 0, CHILD_DIRTY = 1, CONTENT_DIRTY = 2, NODE_DIRTY = 3;
 // Superclass for the various kinds of descriptions. Defines their
@@ -372,7 +382,7 @@ export class ViewDesc {
             const after = selRange.focusNode.childNodes[selRange.focusOffset];
             if (after && after.contentEditable == "false") force = true;
         }
-        if (!(force || brKludge && browser.safari) && isEquivalentPosition(anchorDOM.node, anchorDOM.offset, selRange.anchorNode, selRange.anchorOffset) && isEquivalentPosition(headDOM.node, headDOM.offset, selRange.focusNode, selRange.focusOffset)) {
+        if (view.composing || !(force || brKludge && browser.safari) && isEquivalentPosition(anchorDOM.node, anchorDOM.offset, selRange.anchorNode, selRange.anchorOffset) && isEquivalentPosition(headDOM.node, headDOM.offset, selRange.focusNode, selRange.focusOffset)) {
             return;
         }
         // Selection.extend can be used to create an 'inverted' selection
@@ -770,3 +780,33 @@ export function sameOuterDeco(a, b) {
     for(let i = 0; i < a.length; i++)if (!a[i].type.eq(b[i].type)) return false;
     return true;
 }
+// Find a piece of text in an inline fragment, overlapping from-to.
+// Ported from prosemirror-view's findTextInFragment.
+export function findTextInFragment(frag, text, from, to) {
+    for(let i = 0, pos = 0; i < frag.childCount && pos <= to;){
+        const child = frag.child(i++);
+        const childStart = pos;
+        pos += child.nodeSize;
+        if (!child.isText) continue;
+        let str = child.text;
+        while(i < frag.childCount){
+            const next = frag.child(i++);
+            pos += next.nodeSize;
+            if (!next.isText) break;
+            str += next.text;
+        }
+        if (pos >= from) {
+            if (pos >= to && str.slice(to - text.length - childStart, to - childStart) === text) {
+                return to - text.length;
+            }
+            const found = childStart < to ? str.lastIndexOf(text, to - childStart - 1) : -1;
+            if (found >= 0 && found + text.length + childStart >= from) {
+                return childStart + found;
+            }
+            if (from === to && str.length >= to + text.length - childStart && str.slice(to - childStart, to - childStart + text.length) === text) {
+                return to;
+            }
+        }
+    }
+    return -1;
+}