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

package/dist/esm/hooks/useNodeViewDescription.js

@@ -2,7 +2,7 @@ import { useCallback, useContext, useMemo, useRef } from "react";
 import { ReactEditorView } from "../ReactEditorView.js";
 import { ChildDescriptionsContext } from "../contexts/ChildDescriptionsContext.js";
 import { EditorContext } from "../contexts/EditorContext.js";
-import { CompositionViewDesc, ReactNodeViewDesc, 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) {
@@ -131,32 +131,75 @@ export function useNodeViewDescription(getDOM, getContentDOM, constructor, props
         children.sort(sortViewDescs);
         for (const child of children){
             child.parent = viewDesc;
-            // Because TextNodeViews can't locate the DOM nodes
-            // for compositions, we need to override them here
-            if (child instanceof CompositionViewDesc) {
-                const compositionTopDOM = viewDesc?.contentDOM?.firstChild;
-                if (!compositionTopDOM) throw new Error(`Started a composition but couldn't find the text node it belongs to.`);
-                let textDOM = compositionTopDOM;
-                while(textDOM.firstChild){
-                    textDOM = textDOM.firstChild;
-                }
-                if (!textDOM || !(textDOM instanceof Text)) throw new Error(`Started a composition but couldn't find the text node it belongs to.`);
-                child.dom = compositionTopDOM;
-                child.textDOM = textDOM;
-                child.text = textDOM.data;
-                child.textDOM.pmViewDesc = child;
-                // It should not be possible to be in a composition because one could
-                // not start between the renders that switch the view type.
-                view.input.compositionNodes.push(child);
-            }
         }
     });
+    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;
+        let compositionTopDOM = null;
+        for (const childNode of viewDescRef.current.contentDOM.childNodes){
+            if (children.every((child)=>child.dom !== childNode)) {
+                compositionTopDOM = childNode;
+                break;
+            }
+        }
+        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;
+        }
+        if (!textDOM || !(textDOM instanceof Text)) {
+            console.error(compositionTopDOM, textDOM);
+            throw new Error(`Started a composition but couldn't find the text node it belongs to.`);
+        }
+        compositionViewDesc.dom = compositionTopDOM;
+        compositionViewDesc.textDOM = textDOM;
+        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

@@ -1,7 +1,10 @@
 import { Fragment, Slice } from "prosemirror-model";
 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;
@@ -44,33 +47,63 @@ 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;
-    let precompositionSnapshot = null;
     return new Plugin({
         props: {
             handleDOMEvents: {
                 compositionstart (view) {
-                    compositionMarks = view.state.storedMarks ?? view.state.selection.$from.marks();
-                    view.dispatch(view.state.tr.deleteSelection());
-                    handleGapCursorComposition(view);
+                    if (!(view instanceof ReactEditorView)) return false;
+                    view.compositionStarting = true;
                     const { state } = view;
-                    const $pos = state.selection.$from;
+                    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;
+                    // 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);
                     if (compositionMarks) {
-                        setCursorWrapper(widget(state.selection.from, CursorWrapper, {
-                            key: "cursor-wrapper",
-                            marks: 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();
+                        }
                     }
-                    // Snapshot the siblings of the node that contains the
-                    // current cursor. We'll restore this later, so that React
-                    // doesn't panic about unknown DOM nodes.
-                    const { node: parent } = view.domAtPos($pos.pos);
-                    precompositionSnapshot = [];
-                    for (const node of parent.childNodes){
-                        precompositionSnapshot.push(node);
-                    }
-                    // @ts-expect-error Internal property - input
+                    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;
                 },
@@ -78,40 +111,44 @@ export function beforeInputPlugin(setCursorWrapper) {
                     return true;
                 },
                 compositionend (view, event) {
-                    // @ts-expect-error Internal property - input
+                    if (!(view instanceof ReactEditorView)) return false;
+                    if (!view.composing) return false;
                     view.input.composing = false;
-                    const { state } = view;
-                    const { node: parent } = view.domAtPos(state.selection.from);
-                    if (precompositionSnapshot) {
-                        // Restore the snapshot of the parent node's children
-                        // from before the composition started. This gives us a
-                        // clean slate from which to dispatch our transaction
-                        // and trigger a React update.
-                        precompositionSnapshot.forEach((prevNode, i)=>{
-                            if (parent.childNodes.length <= i) {
-                                parent.appendChild(prevNode);
-                                return;
-                            }
-                            parent.replaceChild(prevNode, parent.childNodes.item(i));
-                        });
-                        if (parent.childNodes.length > precompositionSnapshot.length) {
-                            for(let i = precompositionSnapshot.length; i < parent.childNodes.length; i++){
-                                parent.removeChild(parent.childNodes.item(i));
-                            }
+                    compositionMarks = null;
+                    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;
                         }
                     }
-                    if (event.data) {
-                        insertText(view, event.data, {
-                            marks: compositionMarks
-                        });
+                    view.dispatch(view.state.tr.setMeta(reactKeysPluginKey, {
+                        cursorWrapper: null
+                    }));
+                    if (view.input.compositionNode && isCompositionNodeOrphaned(view.input.compositionNode)) {
+                        view.input.compositionNode.remove();
                     }
-                    compositionMarks = null;
-                    precompositionSnapshot = null;
-                    setCursorWrapper(null);
+                    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":
@@ -156,6 +193,63 @@ export function beforeInputPlugin(setCursorWrapper) {
                                 insertText(view, event.data);
                                 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
+                                const range = event.getTargetRanges()[0];
+                                const start = view.posAtDOM(range.startContainer, range.startOffset);
+                                const end = view.posAtDOM(range.endContainer, range.endOffset, 1);
+                                if (view.state.doc.textBetween(start, end, "**", "*") === event.data) {
+                                    return;
+                                }
+                                if (event.data) {
+                                    if (compositionMarks) tr.ensureMarks(compositionMarks);
+                                    tr.insertText(event.data, start, end);
+                                } 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
+                                });
+                                break;
+                            }
                         case "deleteWordBackward":
                         case "deleteHardLineBackward":
                         case "deleteSoftLineBackward":
@@ -189,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/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/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
@@ -235,7 +245,9 @@ export class ViewDesc {
                 prev = i ? this.children[i - 1] : null;
                 if (!prev || prev.dom.parentNode == this.contentDOM) break;
             }
-            if (prev && side && enter && !prev.border && !prev.domAtom) return prev.domFromPos(prev.size, side);
+            if (prev && side && enter && !prev.border && !prev.domAtom) {
+                return prev.domFromPos(prev.size, side);
+            }
             return {
                 node: this.contentDOM,
                 offset: prev ? domIndex(prev.dom) + 1 : 0
@@ -370,7 +382,9 @@ 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)) return;
+        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
         // (one where the focus is before the anchor), but not all
         // browsers support it yet.
@@ -645,7 +659,10 @@ export class TextViewDesc extends NodeViewDesc {
             skip: skip || true
         };
     }
-    update(_node, _outerDeco, _innerDeco, _view) {
+    update(node, outerDeco, _innerDeco, _view) {
+        if (this.dirty == NODE_DIRTY || this.dirty != NOT_DIRTY && !this.inParent() || !node.sameMarkup(this.node)) return false;
+        this.updateOuterDeco(outerDeco);
+        this.node = node;
         this.dirty = NOT_DIRTY;
         return true;
     }
@@ -763,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;
+}