@handlewithcare/react-prosemirror 2.0.0

package/dist/esm/components/__tests__/ProseMirror.test.js

@@ -0,0 +1,339 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */ /* eslint-disable @typescript-eslint/no-non-null-assertion */ function _extends() {
+    _extends = Object.assign || function(target) {
+        for(var i = 1; i < arguments.length; i++){
+            var source = arguments[i];
+            for(var key in source){
+                if (Object.prototype.hasOwnProperty.call(source, key)) {
+                    target[key] = source[key];
+                }
+            }
+        }
+        return target;
+    };
+    return _extends.apply(this, arguments);
+}
+import { render, screen } from "@testing-library/react";
+import { Schema } from "prosemirror-model";
+import { EditorState, Plugin } from "prosemirror-state";
+import { doc, em, hr, li, p, schema, strong, ul } from "prosemirror-test-builder";
+import React, { forwardRef, useEffect, useState } from "react";
+import { useEditorEffect } from "../../hooks/useEditorEffect.js";
+import { useStopEvent } from "../../hooks/useStopEvent.js";
+import { reactKeys } from "../../plugins/reactKeys.js";
+import { tempEditor } from "../../testing/editorViewTestHelpers.js";
+import { ProseMirror } from "../ProseMirror.js";
+import { ProseMirrorDoc } from "../ProseMirrorDoc.js";
+describe("ProseMirror", ()=>{
+    it("renders a contenteditable", async ()=>{
+        const schema = new Schema({
+            nodes: {
+                text: {},
+                doc: {
+                    content: "text*"
+                }
+            }
+        });
+        const editorState = EditorState.create({
+            schema
+        });
+        function TestEditor() {
+            return /*#__PURE__*/ React.createElement(ProseMirror, {
+                defaultState: editorState
+            }, /*#__PURE__*/ React.createElement(ProseMirrorDoc, {
+                "data-testid": "editor"
+            }));
+        }
+        render(/*#__PURE__*/ React.createElement(TestEditor, null));
+        const editor = screen.getByTestId("editor");
+        editor.focus();
+        await browser.keys("H");
+        await browser.keys("e");
+        await browser.keys("l");
+        await browser.keys("l");
+        await browser.keys("o");
+        await browser.keys(",");
+        await browser.keys(" ");
+        await browser.keys("w");
+        await browser.keys("o");
+        await browser.keys("r");
+        await browser.keys("l");
+        await browser.keys("d");
+        await browser.keys("!");
+        expect(editor.textContent).toBe("Hello, world!");
+    });
+    it("supports lifted editor state", async ()=>{
+        const schema = new Schema({
+            nodes: {
+                text: {},
+                doc: {
+                    content: "text*"
+                }
+            }
+        });
+        let outerEditorState = EditorState.create({
+            schema
+        });
+        function TestEditor() {
+            const [editorState, setEditorState] = useState(outerEditorState);
+            useEffect(()=>{
+                outerEditorState = editorState;
+            }, [
+                editorState
+            ]);
+            return /*#__PURE__*/ React.createElement(ProseMirror, {
+                state: editorState,
+                dispatchTransaction: (tr)=>setEditorState(editorState.apply(tr))
+            }, /*#__PURE__*/ React.createElement(ProseMirrorDoc, {
+                "data-testid": "editor"
+            }));
+        }
+        render(/*#__PURE__*/ React.createElement(TestEditor, null));
+        const editor = screen.getByTestId("editor");
+        editor.focus();
+        await browser.keys("H");
+        await browser.keys("e");
+        await browser.keys("l");
+        await browser.keys("l");
+        await browser.keys("o");
+        await browser.keys(",");
+        await browser.keys(" ");
+        await browser.keys("w");
+        await browser.keys("o");
+        await browser.keys("r");
+        await browser.keys("l");
+        await browser.keys("d");
+        await browser.keys("!");
+        expect(outerEditorState.doc.textContent).toBe("Hello, world!");
+    });
+    it("supports React NodeViews", async ()=>{
+        const schema = new Schema({
+            nodes: {
+                text: {},
+                paragraph: {
+                    content: "text*",
+                    toDOM () {
+                        return [
+                            "p",
+                            0
+                        ];
+                    }
+                },
+                doc: {
+                    content: "paragraph+"
+                }
+            }
+        });
+        const editorState = EditorState.create({
+            schema
+        });
+        const Paragraph = /*#__PURE__*/ forwardRef(function Paragraph(param, ref) {
+            let { children  } = param;
+            return /*#__PURE__*/ React.createElement("p", {
+                ref: ref,
+                "data-testid": "paragraph"
+            }, children);
+        });
+        const reactNodeViews = {
+            paragraph: Paragraph
+        };
+        function TestEditor() {
+            return /*#__PURE__*/ React.createElement(ProseMirror, {
+                defaultState: editorState,
+                nodeViews: reactNodeViews
+            }, /*#__PURE__*/ React.createElement(ProseMirrorDoc, {
+                "data-testid": "editor"
+            }));
+        }
+        render(/*#__PURE__*/ React.createElement(TestEditor, null));
+        const editor = screen.getByTestId("editor");
+        editor.focus();
+        await browser.keys("H");
+        await browser.keys("e");
+        await browser.keys("l");
+        await browser.keys("l");
+        await browser.keys("o");
+        await browser.keys(",");
+        await browser.keys(" ");
+        await browser.keys("w");
+        await browser.keys("o");
+        await browser.keys("r");
+        await browser.keys("l");
+        await browser.keys("d");
+        await browser.keys("!");
+        expect(editor.textContent).toBe("Hello, world!");
+        // Ensure that ProseMirror really rendered our Paragraph
+        // component, not just any old <p> tag
+        expect(screen.getAllByTestId("paragraph").length).toBeGreaterThanOrEqual(1);
+    });
+    it("reflects the current state in .props", async ()=>{
+        const { view  } = tempEditor({
+            doc: doc(p())
+        });
+        expect(view.state).toBe(view.props.state);
+    });
+    it("calls handleScrollToSelection when appropriate", async ()=>{
+        let scrolled = 0;
+        const { view  } = tempEditor({
+            doc: doc(p()),
+            handleScrollToSelection: ()=>{
+                scrolled++;
+                return false;
+            }
+        });
+        view.dispatch(view.state.tr.scrollIntoView());
+        expect(scrolled).toBe(1);
+    });
+    it("can be queried for the DOM position at a doc position", async ()=>{
+        const { view  } = tempEditor({
+            doc: doc(ul(li(p(strong("foo")))))
+        });
+        const inText = view.domAtPos(4);
+        expect(inText.offset).toBe(1);
+        expect(inText.node.nodeValue).toBe("foo");
+        const beforeLI = view.domAtPos(1);
+        expect(beforeLI.offset).toBe(0);
+        expect(beforeLI.node.nodeName).toBe("UL");
+        const afterP = view.domAtPos(7);
+        expect(afterP.offset).toBe(1);
+        expect(afterP.node.nodeName).toBe("LI");
+    });
+    it("can bias DOM position queries to enter nodes", async ()=>{
+        const { view  } = tempEditor({
+            doc: doc(p(em(strong("a"), "b"), "c"))
+        });
+        function get(pos, bias) {
+            const r = view.domAtPos(pos, bias);
+            return (r.node.nodeType == 1 ? r.node.nodeName : r.node.nodeValue) + "@" + r.offset;
+        }
+        expect(get(1, 0)).toBe("P@0");
+        expect(get(1, -1)).toBe("P@0");
+        expect(get(1, 1)).toBe("a@0");
+        expect(get(2, -1)).toBe("a@1");
+        expect(get(2, 0)).toBe("EM@1");
+        expect(get(2, 1)).toBe("b@0");
+        expect(get(3, -1)).toBe("b@1");
+        expect(get(3, 0)).toBe("P@1");
+        expect(get(3, 1)).toBe("c@0");
+        expect(get(4, -1)).toBe("c@1");
+        expect(get(4, 0)).toBe("P@2");
+        expect(get(4, 1)).toBe("P@2");
+    });
+    it("can be queried for a node's DOM representation", async ()=>{
+        const { view  } = tempEditor({
+            doc: doc(p("foo"), hr())
+        });
+        expect(view.nodeDOM(0).nodeName).toBe("P");
+        expect(view.nodeDOM(5).nodeName).toBe("HR");
+        expect(view.nodeDOM(3)).toBeNull();
+    });
+    it("can map DOM positions to doc positions", async ()=>{
+        const { view  } = tempEditor({
+            doc: doc(p("foo"), hr())
+        });
+        expect(view.posAtDOM(view.dom.firstChild.firstChild, 2)).toBe(3);
+        expect(view.posAtDOM(view.dom, 1)).toBe(5);
+        expect(view.posAtDOM(view.dom, 2)).toBe(6);
+        expect(view.posAtDOM(view.dom.lastChild, 0, -1)).toBe(5);
+        expect(view.posAtDOM(view.dom.lastChild, 0, 1)).toBe(6);
+    });
+    it("binds this to itself in dispatchTransaction prop", async ()=>{
+        let thisBinding;
+        const { view  } = tempEditor({
+            doc: doc(p("foo"), hr()),
+            dispatchTransaction () {
+                // eslint-disable-next-line @typescript-eslint/no-this-alias
+                thisBinding = this;
+            }
+        });
+        view.dispatch(view.state.tr.insertText("x"));
+        expect(view).toBe(thisBinding);
+    });
+    it("replaces the EditorView when ProseMirror would redraw", async ()=>{
+        const viewPlugin = ()=>new Plugin({
+                props: {
+                    nodeViews: {
+                        horizontal_rule () {
+                            const dom = document.createElement("hr");
+                            return {
+                                dom
+                            };
+                        }
+                    }
+                }
+            });
+        const startDoc = doc(p());
+        const firstState = EditorState.create({
+            doc: startDoc,
+            schema,
+            plugins: [
+                viewPlugin(),
+                reactKeys()
+            ]
+        });
+        let firstView = null;
+        let secondView = null;
+        function Test() {
+            useEditorEffect((v)=>{
+                if (firstView === null) {
+                    firstView = v;
+                } else {
+                    secondView = v;
+                }
+            });
+            return null;
+        }
+        const Paragraph = /*#__PURE__*/ forwardRef(function Paragraph(param, ref) {
+            let { nodeProps , children , ...props } = param;
+            return /*#__PURE__*/ React.createElement("p", _extends({
+                ref: ref,
+                "data-testid": "node-view"
+            }, props), children);
+        });
+        const { rerender  } = render(/*#__PURE__*/ React.createElement(ProseMirror, {
+            state: firstState,
+            nodeViews: {
+                paragraph: Paragraph
+            }
+        }, /*#__PURE__*/ React.createElement(Test, null), /*#__PURE__*/ React.createElement(ProseMirrorDoc, null)));
+        expect(()=>screen.getByTestId("node-view")).not.toThrow();
+        const secondState = EditorState.create({
+            doc: startDoc,
+            schema,
+            plugins: [
+                viewPlugin(),
+                reactKeys()
+            ]
+        });
+        rerender(/*#__PURE__*/ React.createElement(ProseMirror, {
+            state: secondState,
+            nodeViews: {
+                paragraph: Paragraph
+            }
+        }, /*#__PURE__*/ React.createElement(Test, null), /*#__PURE__*/ React.createElement(ProseMirrorDoc, null)));
+        expect(()=>screen.getByTestId("node-view")).not.toThrow();
+        expect(firstView).not.toBeNull();
+        expect(secondView).not.toBeNull();
+        expect(firstView === secondView).toBeFalsy();
+    });
+    it("supports focusing interactive controls", async ()=>{
+        tempEditor({
+            doc: doc(hr()),
+            nodeViews: {
+                horizontal_rule: /*#__PURE__*/ forwardRef(function Button(param, ref) {
+                    let { nodeProps , ...props } = param;
+                    useStopEvent(()=>{
+                        return true;
+                    });
+                    return /*#__PURE__*/ React.createElement("button", _extends({
+                        id: "button",
+                        ref: ref,
+                        type: "button"
+                    }, props), "Click me");
+                })
+            }
+        });
+        const button = screen.getByText("Click me");
+        await $("#button").click();
+        expect(document.activeElement === button).toBeTruthy();
+    });
+});

package/dist/esm/contexts/ChildDescriptorsContext.js

@@ -0,0 +1,9 @@
+import { createContext } from "react";
+export const ChildDescriptorsContext = createContext({
+    parentRef: {
+        current: undefined
+    },
+    siblingsRef: {
+        current: []
+    }
+});

package/dist/esm/contexts/EditorContext.js

@@ -0,0 +1,7 @@
+/* Copyright (c) The New York Times Company */ import { createContext } from "react";
+/**
+ * Provides the EditorView, as well as the current
+ * EditorState. Should not be consumed directly; instead
+ * see `useEditorState`, `useEditorViewEvent`, and
+ * `useEditorViewLayoutEffect`.
+ */ export const EditorContext = createContext(null);

package/dist/esm/contexts/EditorStateContext.js

@@ -0,0 +1,2 @@
+import { createContext } from "react";
+export const EditorStateContext = createContext(null);

package/dist/esm/contexts/LayoutGroupContext.js

@@ -0,0 +1,2 @@
+/* Copyright (c) The New York Times Company */ import { createContext } from "react";
+export const LayoutGroupContext = /*#__PURE__*/ createContext(null);

package/dist/esm/contexts/NodeViewContext.js

@@ -0,0 +1,2 @@
+import { createContext } from "react";
+export const NodeViewContext = /*#__PURE__*/ createContext(null);

package/dist/esm/contexts/SelectNodeContext.js

@@ -0,0 +1,2 @@
+import { createContext } from "react";
+export const SelectNodeContext = createContext(null);

package/dist/esm/contexts/StopEventContext.js

@@ -0,0 +1,2 @@
+import { createContext } from "react";
+export const StopEventContext = createContext(null);

package/dist/esm/contexts/__tests__/DeferredLayoutEffects.test.js

@@ -0,0 +1,98 @@
+import { act, render, screen } from "@testing-library/react";
+import React, { useLayoutEffect, useState } from "react";
+import { LayoutGroup } from "../../components/LayoutGroup.js";
+import { useLayoutGroupEffect } from "../../hooks/useLayoutGroupEffect.js";
+describe("DeferredLayoutEffects", ()=>{
+    jest.useFakeTimers("modern");
+    it("registers multiple effects and runs them", ()=>{
+        function Parent() {
+            return /*#__PURE__*/ React.createElement(LayoutGroup, null, /*#__PURE__*/ React.createElement(Child, null));
+        }
+        function Child() {
+            const [double, setDouble] = useState(1);
+            useLayoutEffect(()=>{
+                if (double === 2) {
+                    setTimeout(()=>{
+                        setDouble((d)=>d * 2.5);
+                    }, 500);
+                }
+                if (double === 20) {
+                    setDouble((d)=>d * 2.5);
+                }
+            }, [
+                double
+            ]);
+            useLayoutGroupEffect(()=>{
+                const timeout = setTimeout(()=>{
+                    setDouble((d)=>d * 2);
+                }, 1000);
+                return ()=>{
+                    clearTimeout(timeout);
+                };
+            }, [
+                double
+            ]);
+            return /*#__PURE__*/ React.createElement("div", null, /*#__PURE__*/ React.createElement("div", {
+                "data-testid": "double"
+            }, double));
+        }
+        // The component mounts ...
+        // ... the initial value should be 1
+        // ... there should be one timeout scheduled by the deferred effect
+        render(/*#__PURE__*/ React.createElement(Parent, null));
+        expect(screen.getByTestId("double").innerHTML).toBe("1");
+        // This block assert that deferred effects run.
+        // --------------------------------------------
+        // 1000 milliseconds go by ...
+        // ... the timeout set by the deferred effect should run
+        // ... the timeout should double the new value to 2
+        // ... the immediate effect should set a timeout
+        // ... the deferred effect should set a timeout
+        act(()=>{
+            jest.advanceTimersByTime(1000);
+        });
+        expect(screen.getByTestId("double").innerHTML).toBe("2");
+        // The next three blocks assert that cleanup of deferred effects run.
+        // ------------------------------------------------------------------
+        // 500 milliseconds go by ...
+        // ... the timeout set by the immediate effect should run
+        // ... the timeout should set the value to 5
+        // ... the old deferred effect should cancel its timeout
+        // ... the new deferred effect should set a new timeout
+        act(()=>{
+            jest.advanceTimersByTime(500);
+        });
+        expect(screen.getByTestId("double").innerHTML).toBe("5");
+        // ... 500 more milliseconds go by ...
+        // ... the canceled timeout should not run
+        // ... the rescheduled timoeut should not yet run
+        act(()=>{
+            jest.advanceTimersByTime(500);
+        });
+        expect(screen.getByTestId("double").innerHTML).toBe("5");
+        // ... 500 more milliseconds go by ...
+        // ... the rescheduled timeout should run
+        // ... the timeout should double the value to 10
+        // ... the deferred effect should set a new timeout
+        act(()=>{
+            jest.advanceTimersByTime(500);
+        });
+        expect(screen.getByTestId("double").innerHTML).toBe("10");
+        // The next block asserts that cancelation of deferred effects works.
+        // ------------------------------------------------------------------
+        // 1000 milliseconds go by ...
+        // ... the timeout set by the deferred effect should run
+        // ... the timeout should double the value to 20
+        // ... the immediate effect should then set the value to 50
+        // ... the deferred effect from the first render should not run
+        // ... the deferred effect from the second render should run
+        // ... the deferred effect that does run should set a new timeout
+        act(()=>{
+            jest.advanceTimersByTime(1000);
+        });
+        // For this assertion, we need to clear a timer from the React scheduler.
+        jest.advanceTimersByTime(1);
+        expect(screen.getByTestId("double").innerHTML).toBe("50");
+        expect(jest.getTimerCount()).toBe(1);
+    });
+});

package/dist/esm/decorations/ReactWidgetType.js

@@ -0,0 +1,40 @@
+import { Decoration } from "prosemirror-view";
+function compareObjs(a, b) {
+    if (a == b) return true;
+    for(const p in a)if (a[p] !== b[p]) return false;
+    for(const p in b)if (!(p in a)) return false;
+    return true;
+}
+const noSpec = {
+    side: 0
+};
+export class ReactWidgetType {
+    Component;
+    side;
+    spec;
+    constructor(Component, spec){
+        this.Component = Component;
+        this.spec = spec ?? noSpec;
+        this.side = this.spec.side ?? 0;
+    }
+    map(mapping, span, offset, oldOffset) {
+        const { pos, deleted } = mapping.mapResult(span.from + oldOffset, this.side < 0 ? -1 : 1);
+        // @ts-expect-error The Decoration constructor is private/internal, but
+        // we need to use it for our custom widget implementation here.
+        return deleted ? null : new Decoration(pos - offset, pos - offset, this);
+    }
+    valid() {
+        return true;
+    }
+    eq(other) {
+        return this == other || other instanceof ReactWidgetType && (this.spec.key && this.spec.key == other.spec.key || this.Component == other.Component && compareObjs(this.spec, other.spec));
+    }
+    destroy() {
+    // Can be implemented with React effect hooks
+    }
+}
+export function widget(pos, component, spec) {
+    // @ts-expect-error The Decoration constructor is private/internal, but
+    // we need to use it for our custom widget implementation here.
+    return new Decoration(pos, pos, new ReactWidgetType(component, spec));
+}

package/dist/esm/decorations/computeDocDeco.js

@@ -0,0 +1,44 @@
+import { Decoration } from "prosemirror-view";
+const DocDecorationsCache = new WeakMap();
+/**
+ * Produces the outer decorations for the doc node, based
+ * on the attributes editor prop.
+ *
+ * The return value of this function is memoized; if it is to
+ * return an equivalent value to the last time it was called for
+ * a given EditorView, it will return exactly that previous value.
+ *
+ * This makes it safe to call in a React render function, even
+ * if its result is used in a dependencies array for a hook.
+ */ export function computeDocDeco(view) {
+    const attrs = Object.create(null);
+    attrs.class = "ProseMirror";
+    attrs.contenteditable = String(view.editable);
+    view.someProp("attributes", (value)=>{
+        if (typeof value == "function") value = value(view.state);
+        if (value) for(const attr in value){
+            if (attr == "class") attrs.class += " " + value[attr];
+            else if (attr == "style") attrs.style = (attrs.style ? attrs.style + ";" : "") + value[attr];
+            else if (!attrs[attr] && attr != "contenteditable" && attr != "nodeName") attrs[attr] = String(value[attr]);
+        }
+    });
+    if (!attrs.translate) attrs.translate = "no";
+    const next = [
+        Decoration.node(0, view.state.doc.content.size, attrs)
+    ];
+    const previous = DocDecorationsCache.get(view);
+    if (!previous) {
+        DocDecorationsCache.set(view, next);
+        return next;
+    }
+    if (previous[0].to !== view.state.doc.content.size) {
+        DocDecorationsCache.set(view, next);
+        return next;
+    }
+    // @ts-expect-error Internal property (Decoration.type)
+    if (!previous[0].type.eq(next[0].type)) {
+        DocDecorationsCache.set(view, next);
+        return next;
+    }
+    return previous;
+}

package/dist/esm/decorations/internalTypes.js

@@ -0,0 +1 @@
+export { };

package/dist/esm/decorations/iterDeco.js

@@ -0,0 +1,73 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */ import { ReactWidgetType } from "./ReactWidgetType.js";
+function compareSide(a, b) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return a.type.side - b.type.side;
+}
+// This function abstracts iterating over the nodes and decorations in
+// a fragment. Calls `onNode` for each node, with its local and child
+// decorations. Splits text nodes when there is a decoration starting
+// or ending inside of them. Calls `onWidget` for each widget.
+export function iterDeco(parent, deco, // Callbacks have been slightly modified to pass
+// the offset, so that we can pass the position as
+// a prop to components
+onWidget, onNode) {
+    const locals = deco.locals(parent);
+    let offset = 0;
+    // Simple, cheap variant for when there are no local decorations
+    if (locals.length == 0) {
+        for(let i = 0; i < parent.childCount; i++){
+            const child = parent.child(i);
+            onNode(child, locals, deco.forChild(offset, child), offset, i);
+            offset += child.nodeSize;
+        }
+        return;
+    }
+    let decoIndex = 0;
+    const active = [];
+    let restNode = null;
+    for(let parentIndex = 0;;){
+        if (decoIndex < locals.length && locals[decoIndex].to == offset) {
+            const widget = locals[decoIndex++];
+            let widgets;
+            while(decoIndex < locals.length && locals[decoIndex].to == offset)(widgets || (widgets = [
+                widget
+            ])).push(locals[decoIndex++]);
+            if (widgets) {
+                widgets.sort(compareSide);
+                for(let i = 0; i < widgets.length; i++)onWidget(widgets[i], // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                !(widgets[i].type instanceof ReactWidgetType), offset, parentIndex + i, !!restNode);
+            } else {
+                onWidget(widget, // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                !(widget.type instanceof ReactWidgetType), offset, parentIndex, !!restNode);
+            }
+        }
+        let child, index;
+        if (restNode) {
+            index = -1;
+            child = restNode;
+            restNode = null;
+        } else if (parentIndex < parent.childCount) {
+            index = parentIndex;
+            child = parent.child(parentIndex++);
+        } else {
+            break;
+        }
+        for(let i = 0; i < active.length; i++)if (active[i].to <= offset) active.splice(i--, 1);
+        while(decoIndex < locals.length && locals[decoIndex].from <= offset && locals[decoIndex].to > offset)active.push(locals[decoIndex++]);
+        let end = offset + child.nodeSize;
+        if (child.isText) {
+            let cutAt = end;
+            if (decoIndex < locals.length && locals[decoIndex].from < cutAt) cutAt = locals[decoIndex].from;
+            for(let i = 0; i < active.length; i++)if (active[i].to < cutAt) cutAt = active[i].to;
+            if (cutAt < end) {
+                restNode = child.cut(cutAt - offset);
+                child = child.cut(0, cutAt - offset);
+                end = cutAt;
+                index = -1;
+            }
+        }
+        const outerDeco = child.isInline && !child.isLeaf ? active.filter((d)=>!d.inline) : active.slice();
+        onNode(child, outerDeco, deco.forChild(offset, child), offset, index);
+        offset = end;
+    }
+}