@handlewithcare/react-prosemirror 3.1.0-tiptap.48 → 3.1.0-tiptap.49

package/dist/esm/components/TextNodeView.js

@@ -1,7 +1,5 @@
-import { TextSelection } from "prosemirror-state";
 import { DecorationSet } from "prosemirror-view";
 import { Component } from "react";
-import { ReactEditorView } from "../ReactEditorView.js";
 import { findDOMNode } from "../findDOMNode.js";
 import { CompositionViewDesc, TextViewDesc, sortViewDescs } from "../viewdesc.js";
 import { wrapInDeco } from "./ChildNodeViews.js";
@@ -30,144 +28,72 @@ function shallowEqual(objA, objB) {
 export class TextNodeView extends Component {
     viewDescRef = null;
     renderRef = null;
-    wasProtecting = false;
-    containsCompositionNodeText = true;
-    // This is basically NodeViewDesc.localCompositionInfo
-    // from prosemirror-view. It's been slightly adjusted so that
-    // it can be used accurately during render, before we've
-    // necessarily found (or even let the browser create)
-    // view.input.compositionNode
-    shouldProtect(props) {
-        const { view, getPos, node } = props;
-        if (!(view instanceof ReactEditorView)) return false;
-        if (!view.composing) {
-            return false;
-        }
-        const pos = getPos();
-        const { from, to } = view.state.selection;
-        if (!(view.state.selection instanceof TextSelection) || from < pos || // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        to > pos + node.nodeSize) {
-            return false;
-        }
-        return this.containsCompositionNodeText;
-    }
-    handleCompositionEnd = ()=>{
-        if (!this.wasProtecting) return;
-        this.forceUpdate();
-        return;
-    };
-    create() {
+    updateEffect() {
         const { view, decorations, siblingsRef, parentRef, getPos, node } = this.props;
+        // There simply is no other way to ref a text node
+        // eslint-disable-next-line react/no-find-dom-node
         const dom = findDOMNode(this);
-        if (!dom && !view.composing) return null;
-        let textNode = dom;
-        while(textNode?.firstChild){
-            textNode = textNode.firstChild;
-        }
-        if (!(textNode instanceof Text)) {
-            textNode = null;
-        }
-        let viewDesc;
-        if (this.shouldProtect(this.props)) {
-            viewDesc = new CompositionViewDesc(parentRef.current, getPos, // If we can't
-            // actually find the correct DOM nodes from here (
-            // which is the case in a composition in a newly
-            // created text node), we let our parent do it.
+        // We only need to explicitly create a CompositionViewDesc
+        // when a composition was started that produces a new text node.
+        // Otherwise we just rely on re-rendering the renderRef
+        if (!dom) {
+            if (!view.composing) return;
+            this.viewDescRef = new CompositionViewDesc(parentRef.current, getPos, // These are just placeholders/dummies. We can't
+            // actually find the correct DOM nodes from here,
+            // so we let our parent do it.
             // Passing a valid element here just so that the
             // ViewDesc constructor doesn't blow up.
-            dom ?? document.createElement("div"), textNode ?? document.createTextNode(node.text ?? ""), node.text ?? "");
-        } else {
-            if (!dom || !textNode) return null;
-            viewDesc = new TextViewDesc(parentRef.current, [], getPos, node, decorations, DecorationSet.empty, dom, textNode);
+            document.createElement("div"), document.createTextNode(node.text ?? ""), node.text ?? "");
+            return;
         }
-        siblingsRef.current.push(viewDesc);
-        siblingsRef.current.sort(sortViewDescs);
-        return viewDesc;
-    }
-    update() {
-        const { view, node, decorations } = this.props;
-        if (!(view instanceof ReactEditorView)) return false;
-        const viewDesc = this.viewDescRef;
-        if (!viewDesc) return false;
-        if (this.shouldProtect(this.props) !== viewDesc instanceof CompositionViewDesc) {
-            return false;
+        let textNode = dom;
+        while(textNode.firstChild){
+            textNode = textNode.firstChild;
         }
-        if (viewDesc instanceof CompositionViewDesc) return false;
-        const dom = findDOMNode(this);
-        if (!dom || dom !== viewDesc.dom) return false;
-        if (!dom.contains(viewDesc.nodeDOM)) return false;
-        return viewDesc.matchesNode(node, decorations, DecorationSet.empty) || viewDesc.update(node, decorations, DecorationSet.empty, view);
-    }
-    destroy() {
-        const viewDesc = this.viewDescRef;
-        if (!viewDesc) return;
-        viewDesc.destroy();
-        const siblings = this.props.siblingsRef.current;
-        if (siblings.includes(viewDesc)) {
-            const index = siblings.indexOf(viewDesc);
-            siblings.splice(index, 1);
+        if (!this.viewDescRef || this.viewDescRef instanceof CompositionViewDesc) {
+            this.viewDescRef = new TextViewDesc(undefined, [], getPos, node, decorations, DecorationSet.empty, dom, textNode);
+        } else {
+            this.viewDescRef.parent = parentRef.current;
+            this.viewDescRef.children = [];
+            this.viewDescRef.node = node;
+            this.viewDescRef.outerDeco = decorations;
+            this.viewDescRef.innerDeco = DecorationSet.empty;
+            this.viewDescRef.dom = dom;
+            this.viewDescRef.dom.pmViewDesc = this.viewDescRef;
+            this.viewDescRef.nodeDOM = textNode;
         }
-    }
-    updateEffect() {
-        if (!this.update()) {
-            this.destroy();
-            this.viewDescRef = this.create();
+        if (!siblingsRef.current.includes(this.viewDescRef)) {
+            siblingsRef.current.push(this.viewDescRef);
         }
-        setTimeout(()=>{
-            const { view, node } = this.props;
-            if (!(view instanceof ReactEditorView)) {
-                this.containsCompositionNodeText = true;
-                return;
-            }
-            const textNode = view.input.compositionNode;
-            if (!textNode) {
-                this.containsCompositionNodeText = true;
-                return;
-            }
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const text = textNode.nodeValue;
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            this.containsCompositionNodeText = node.text === text;
-        });
+        siblingsRef.current.sort(sortViewDescs);
     }
     shouldComponentUpdate(nextProps) {
-        // When leaving the protected state, force a re-render so React's
-        // virtual DOM resyncs with whatever the IME wrote into the real DOM
-        // while we were returning a stale renderRef.
-        if (this.wasProtecting && !this.shouldProtect(nextProps)) {
-            return true;
-        }
         return !shallowEqual(this.props, nextProps);
     }
     componentDidMount() {
-        this.viewDescRef = null;
-        // After a composition, force an update so that we re-check whether we need
-        // to be protecting our rendered content and allow React to re-sync with the
-        // DOM.
-        const { registerEventListener } = this.props;
-        registerEventListener("compositionend", this.handleCompositionEnd);
         this.updateEffect();
     }
     componentDidUpdate() {
         this.updateEffect();
     }
     componentWillUnmount() {
-        const { unregisterEventListener } = this.props;
-        unregisterEventListener("compositionend", this.handleCompositionEnd);
-        this.destroy();
+        const { siblingsRef } = this.props;
+        if (!this.viewDescRef) return;
+        if (siblingsRef.current.includes(this.viewDescRef)) {
+            const index = siblingsRef.current.indexOf(this.viewDescRef);
+            siblingsRef.current.splice(index, 1);
+        }
     }
     render() {
-        const { node, decorations } = this.props;
+        const { view, getPos, node, decorations } = this.props;
         // During a composition, it's crucial that we don't try to
         // update the DOM that the user is working in. If there's
         // an active composition and the selection is in this node,
         // we freeze the DOM of this element so that it doesn't
         // interrupt the composition
-        if (this.shouldProtect(this.props)) {
-            this.wasProtecting = true;
+        if (view.composing && view.state.selection.from >= getPos() && view.state.selection.from <= getPos() + node.nodeSize) {
             return this.renderRef;
         }
-        this.wasProtecting = false;
         this.renderRef = decorations.reduce(wrapInDeco, node.text);
         return this.renderRef;
     }

package/dist/esm/hooks/useEditor.js

@@ -101,19 +101,11 @@ let didWarnValueDefaultValue = false;
         // running effects. Running effects will reattach selection
         // change listeners if the EditorView has been destroyed.
         if (view instanceof ReactEditorView && !view.isDestroyed) {
-            if (view.deferPendingEffects) {
-                setTimeout(()=>{
-                    flushSyncRef.current = false;
-                    view.commitPendingEffects();
-                    flushSyncRef.current = true;
-                });
-            } else {
-                // Plugins might dispatch transactions from their
-                // view update lifecycle hooks
-                flushSyncRef.current = false;
-                view.commitPendingEffects();
-                flushSyncRef.current = true;
-            }
+            // Plugins might dispatch transactions from their
+            // view update lifecycle hooks
+            flushSyncRef.current = false;
+            view.commitPendingEffects();
+            flushSyncRef.current = true;
         }
     });
     view.update(directEditorProps);

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 { CompositionViewDesc, ReactNodeViewDesc, sortViewDescs } from "../viewdesc.js";
 import { useClientLayoutEffect } from "./useClientLayoutEffect.js";
 import { useEffectEvent } from "./useEffectEvent.js";
 export function useNodeViewDescription(getDOM, getContentDOM, constructor, props) {
@@ -133,46 +131,25 @@ export function useNodeViewDescription(getDOM, getContentDOM, constructor, props
         children.sort(sortViewDescs);
         for (const child of children){
             child.parent = viewDesc;
-        }
-        setTimeout(()=>{
             // Because TextNodeViews can't locate the DOM nodes
             // for compositions, we need to override them here
-            if (!viewDescRef.current?.contentDOM) return;
-            const children = viewDescRef.current?.children;
-            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;
-                    }
+            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);
             }
-            if (!compositionTopDOM) 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);
-        });
+        }
     });
     const childContextValue = useMemo(()=>({
             parentRef: viewDescRef,

package/dist/esm/plugins/beforeInputPlugin.js

@@ -1,6 +1,5 @@
 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";
 function insertText(view, eventData) {
@@ -47,23 +46,31 @@ function handleGapCursorComposition(view) {
 }
 export function beforeInputPlugin(setCursorWrapper) {
     let compositionMarks = null;
+    let precompositionSnapshot = null;
     return new Plugin({
         props: {
             handleDOMEvents: {
                 compositionstart (view) {
-                    if (!(view instanceof ReactEditorView)) return false;
-                    compositionMarks = view.state.storedMarks;
+                    compositionMarks = view.state.storedMarks ?? view.state.selection.$from.marks();
                     view.dispatch(view.state.tr.deleteSelection());
                     handleGapCursorComposition(view);
                     const { state } = view;
-                    // const $pos = state.selection.$from;
-                    if (compositionMarks?.length) {
+                    const $pos = state.selection.$from;
+                    if (compositionMarks) {
                         setCursorWrapper(widget(state.selection.from, CursorWrapper, {
                             key: "cursor-wrapper",
-                            marks: compositionMarks,
-                            side: 1
+                            marks: compositionMarks
                         }));
                     }
+                    // 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.input.composing = true;
                     return true;
                 },
@@ -71,17 +78,36 @@ export function beforeInputPlugin(setCursorWrapper) {
                     return true;
                 },
                 compositionend (view, event) {
-                    if (!(view instanceof ReactEditorView)) return false;
-                    if (!view.composing) return false;
+                    // @ts-expect-error Internal property - input
                     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));
+                            }
+                        }
+                    }
+                    if (event.data) {
+                        insertText(view, event.data, {
+                            marks: compositionMarks
+                        });
+                    }
                     compositionMarks = null;
+                    precompositionSnapshot = null;
                     setCursorWrapper(null);
-                    if (view.input.compositionNode && !view.input.compositionNode.pmViewDesc && (view.input.compositionNode instanceof Text || view.input.compositionNode instanceof Element)) {
-                        view.input.compositionNode.remove();
-                    }
-                    view.input.compositionEndedAt = event.timeStamp;
-                    view.input.compositionNode = null;
-                    view.input.compositionID++;
                     return true;
                 },
                 beforeinput (view, event) {
@@ -130,38 +156,6 @@ export function beforeInputPlugin(setCursorWrapper) {
                                 insertText(view, event.data);
                                 break;
                             }
-                        case "insertCompositionText":
-                            {
-                                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 we insert the text that corresponds to an ongoing composition,
-                                // the relevant TextNodeView will pause re-rendering so that React doesn't
-                                // clobber the composition in the DOM. This means that we have to wait for
-                                // the browser to update the DOM itself before attempting to reconcile
-                                // the selection, so we specifically defer pending effects to the next
-                                // macro task
-                                if (view instanceof ReactEditorView) {
-                                    view.deferPendingEffects = true;
-                                }
-                                view.dispatch(tr);
-                                if (view instanceof ReactEditorView) {
-                                    view.deferPendingEffects = false;
-                                }
-                                break;
-                            }
                         case "deleteWordBackward":
                         case "deleteHardLineBackward":
                         case "deleteSoftLineBackward":