@pie-lib/editable-html-tip-tap 2.1.3 → 2.1.5

package/src/extensions/__tests__/math.test.js

@@ -1,6 +1,6 @@
 import React from 'react';
 import { render, waitFor, fireEvent } from '@testing-library/react';
-import { MathNode, MathNodeView } from '../math';
+import { EnsureTextAfterMathPlugin, MathNode, MathNodeView, ZeroWidthSpaceHandlingPlugin } from '../math';
 
 jest.mock('@tiptap/react', () => ({
   NodeViewWrapper: ({ children, ...props }) => (
@@ -156,6 +156,151 @@ describe('MathNode', () => {
       expect(result).toBeDefined();
     });
   });
+
+  describe('addProseMirrorPlugins', () => {
+    it('registers ensure-text-after-math and zero-width-space plugins', () => {
+      const plugins = MathNode.addProseMirrorPlugins();
+
+      expect(plugins).toHaveLength(2);
+      expect(plugins[0].appendTransaction).toBeDefined();
+      expect(plugins[1].props.handleKeyDown).toBeDefined();
+    });
+  });
+});
+
+describe('EnsureTextAfterMathPlugin', () => {
+  it('inserts a zero-width space after a math node when no text follows', () => {
+    const plugin = EnsureTextAfterMathPlugin('math');
+    const textNode = { type: { name: 'text' } };
+    const mathNode = { type: { name: 'math' }, nodeSize: 3 };
+    const tr = { insert: jest.fn() };
+
+    const newState = {
+      schema: { text: jest.fn((value) => ({ type: textNode.type, text: value })) },
+      tr,
+      doc: {
+        descendants: (cb) => cb(mathNode, 5),
+        nodeAt: jest.fn(() => null),
+      },
+    };
+
+    const result = plugin.appendTransaction([{ docChanged: true }], {}, newState);
+
+    expect(tr.insert).toHaveBeenCalledWith(8, expect.anything());
+    expect(result).toBe(tr);
+  });
+
+  it('does not insert when text already follows the math node', () => {
+    const plugin = EnsureTextAfterMathPlugin('math');
+    const tr = { insert: jest.fn() };
+    const mathNode = { type: { name: 'math' }, nodeSize: 3 };
+
+    const newState = {
+      schema: { text: jest.fn() },
+      tr,
+      doc: {
+        descendants: (cb) => cb(mathNode, 5),
+        nodeAt: jest.fn(() => ({ type: { name: 'text' } })),
+      },
+    };
+
+    const result = plugin.appendTransaction([{ docChanged: true }], {}, newState);
+
+    expect(tr.insert).not.toHaveBeenCalled();
+    expect(result).toBeNull();
+  });
+
+  it('returns null when the document did not change', () => {
+    const plugin = EnsureTextAfterMathPlugin('math');
+
+    const result = plugin.appendTransaction([{ docChanged: false }], {}, {});
+    expect(result).toBeNull();
+  });
+});
+
+describe('ZeroWidthSpaceHandlingPlugin', () => {
+  const createDefaultDoc = () => ({
+    textBetween: jest.fn(() => '\u200b'),
+    resolve: jest.fn(() => ({
+      nodeAfter: null,
+      nodeBefore: null,
+    })),
+  });
+
+  const createView = ({ state: stateOverrides = {} } = {}) => {
+    const dispatch = jest.fn();
+    const tr = {
+      delete: jest.fn().mockReturnThis(),
+      setSelection: jest.fn().mockReturnThis(),
+    };
+
+    return {
+      state: {
+        selection: { from: 2, empty: true },
+        doc: createDefaultDoc(),
+        tr,
+        ...stateOverrides,
+        doc: { ...createDefaultDoc(), ...stateOverrides.doc },
+      },
+      dispatch,
+    };
+  };
+
+  it('deletes math and zero-width space on Backspace', () => {
+    const view = createView();
+    const event = { key: 'Backspace' };
+    const handled = ZeroWidthSpaceHandlingPlugin.props.handleKeyDown(view, event);
+
+    expect(handled).toBe(true);
+    expect(view.state.tr.delete).toHaveBeenCalledWith(0, 2);
+    expect(view.dispatch).toHaveBeenCalledWith(view.state.tr);
+  });
+
+  it('selects the math node on ArrowLeft before a zero-width space', () => {
+    const mathNode = { nodeSize: 3 };
+    const view = createView({
+      state: {
+        doc: {
+          resolve: jest
+            .fn()
+            .mockReturnValueOnce({ nodeAfter: mathNode, nodeBefore: null })
+            .mockReturnValueOnce({ pos: 4 }),
+        },
+      },
+    });
+    const { NodeSelection } = require('prosemirror-state');
+
+    const handled = ZeroWidthSpaceHandlingPlugin.props.handleKeyDown(view, { key: 'ArrowLeft' });
+
+    expect(handled).toBe(true);
+    expect(NodeSelection.create).toHaveBeenCalledWith(view.state.doc, 4);
+    expect(view.dispatch).toHaveBeenCalled();
+  });
+
+  it('moves the text cursor before the zero-width space when no inline node precedes it', () => {
+    const view = createView();
+    const { TextSelection } = require('prosemirror-state');
+
+    const handled = ZeroWidthSpaceHandlingPlugin.props.handleKeyDown(view, { key: 'ArrowLeft' });
+
+    expect(handled).toBe(true);
+    expect(TextSelection.create).toHaveBeenCalledWith(view.state.doc, 0);
+    expect(view.dispatch).toHaveBeenCalled();
+  });
+
+  it('returns false for unrelated keys', () => {
+    const view = createView({
+      state: {
+        doc: {
+          textBetween: jest.fn(() => 'a'),
+          resolve: jest.fn(),
+        },
+      },
+    });
+
+    const handled = ZeroWidthSpaceHandlingPlugin.props.handleKeyDown(view, { key: 'Enter' });
+    expect(handled).toBe(false);
+  });
 });
 
 describe('MathNodeView', () => {
@@ -167,6 +312,7 @@ describe('MathNodeView', () => {
       },
       tr: {
         setSelection: jest.fn().mockReturnThis(),
+        setMeta: jest.fn().mockReturnThis(),
       },
       doc: {},
     },
@@ -244,37 +390,30 @@ describe('MathNodeView', () => {
   });
 
   describe('toolbar positioning', () => {
-    it('uses _tiptapContainerEl for position calculation when available', async () => {
-      const containerEl = document.createElement('div');
-      containerEl.getBoundingClientRect = jest.fn(() => ({ top: -50, left: 20, width: 600, height: 400 }));
-
-      const editor = {
-        ...defaultProps.editor,
-        _tiptapContainerEl: containerEl,
-      };
-
-      const { container } = render(<MathNodeView {...defaultProps} editor={editor} selected={true} />);
+    it('uses a fixed top offset and horizontal position from coordsAtPos', async () => {
+      const { container } = render(<MathNodeView {...defaultProps} selected={true} />);
       await waitFor(() => {
         const toolbar = container.querySelector('[data-toolbar-for]');
         expect(toolbar).toBeInTheDocument();
-        // top = coordsAtPos.top (100) + Math.abs(containerEl.top (-50)) + 40 = 190
-        expect(toolbar.style.top).toBe('190px');
+        expect(toolbar.style.top).toBe('40px');
         expect(toolbar.style.left).toBe('50px');
       });
     });
 
-    it('falls back to document.body when _tiptapContainerEl is not set', async () => {
+    it('keeps the fixed top offset when the editor container is scrolled', async () => {
+      const containerEl = document.createElement('div');
+      containerEl.getBoundingClientRect = jest.fn(() => ({ top: -200, left: 0, width: 600, height: 400 }));
+
       const editor = {
         ...defaultProps.editor,
-        _tiptapContainerEl: undefined,
+        _tiptapContainerEl: containerEl,
       };
 
       const { container } = render(<MathNodeView {...defaultProps} editor={editor} selected={true} />);
       await waitFor(() => {
         const toolbar = container.querySelector('[data-toolbar-for]');
         expect(toolbar).toBeInTheDocument();
-        // top = coordsAtPos.top (100) + Math.abs(document.body.top (0)) + 40 = 140
-        expect(toolbar.style.top).toBe('140px');
+        expect(toolbar.style.top).toBe('40px');
         expect(toolbar.style.left).toBe('50px');
       });
     });
@@ -288,7 +427,7 @@ describe('MathNodeView', () => {
       });
     });
 
-    it('recalculates position when toolbar reopens', async () => {
+    it('updates horizontal position from coordsAtPos when selection changes', async () => {
       const editor = {
         ...defaultProps.editor,
         view: {
@@ -302,30 +441,11 @@ describe('MathNodeView', () => {
       await waitFor(() => {
         const toolbar = container.querySelector('[data-toolbar-for]');
         expect(toolbar).toBeInTheDocument();
-        // top = 200 + Math.abs(0) + 40 = 240
-        expect(toolbar.style.top).toBe('240px');
+        expect(toolbar.style.top).toBe('40px');
         expect(toolbar.style.left).toBe('150px');
       });
     });
 
-    it('accounts for negative container top (scrolled container)', async () => {
-      const containerEl = document.createElement('div');
-      containerEl.getBoundingClientRect = jest.fn(() => ({ top: -200, left: 0, width: 600, height: 400 }));
-
-      const editor = {
-        ...defaultProps.editor,
-        _tiptapContainerEl: containerEl,
-      };
-
-      const { container } = render(<MathNodeView {...defaultProps} editor={editor} selected={true} />);
-      await waitFor(() => {
-        const toolbar = container.querySelector('[data-toolbar-for]');
-        expect(toolbar).toBeInTheDocument();
-        // top = 100 + Math.abs(-200) + 40 = 340
-        expect(toolbar.style.top).toBe('340px');
-      });
-    });
-
     it('portals toolbar into _tiptapContainerEl when available', async () => {
       const containerEl = document.createElement('div');
       containerEl.getBoundingClientRect = jest.fn(() => ({ top: 0, left: 0, width: 600, height: 400 }));
@@ -410,8 +530,13 @@ describe('MathNodeView', () => {
     });
   });
 
-  it('closes toolbar on outside click', async () => {
-    const { queryByTestId } = render(<MathNodeView {...defaultProps} selected={true} />);
+  it('closes toolbar on outside click and runs handleDone', async () => {
+    const updateAttributes = jest.fn();
+    const editor = createMockEditor();
+    const { TextSelection } = require('prosemirror-state');
+    const { queryByTestId } = render(
+      <MathNodeView {...defaultProps} editor={editor} updateAttributes={updateAttributes} selected={true} />,
+    );
 
     await waitFor(() => {
       expect(queryByTestId('math-toolbar')).toBeInTheDocument();
@@ -421,6 +546,86 @@ describe('MathNodeView', () => {
 
     await waitFor(() => {
       expect(queryByTestId('math-toolbar')).not.toBeInTheDocument();
+      expect(updateAttributes).toHaveBeenCalledWith({ latex: 'x^2' });
+      expect(TextSelection.create).toHaveBeenCalledWith(editor.state.doc, 1);
+      expect(editor.state.tr.setSelection).toHaveBeenCalled();
+      expect(editor.view.dispatch).toHaveBeenCalledWith(editor.state.tr);
+      expect(editor.commands.focus).toHaveBeenCalled();
+      expect(editor._toolbarOpened).toBe(false);
+    });
+  });
+
+  it('does not close toolbar when clicking the math node preview', async () => {
+    const { getByTestId, queryByTestId } = render(<MathNodeView {...defaultProps} selected={true} />);
+
+    await waitFor(() => {
+      expect(queryByTestId('math-toolbar')).toBeInTheDocument();
+    });
+
+    fireEvent.click(getByTestId('math-preview'));
+
+    await waitFor(() => {
+      expect(queryByTestId('math-toolbar')).toBeInTheDocument();
+    });
+  });
+
+  describe('unique math-node class per instance', () => {
+    let dateNowSpy;
+
+    beforeEach(() => {
+      let timestamp = 1000;
+      dateNowSpy = jest.spyOn(Date, 'now').mockImplementation(() => timestamp++);
+    });
+
+    afterEach(() => {
+      dateNowSpy.mockRestore();
+    });
+
+    it('assigns a timestamp-based class to NodeViewWrapper', () => {
+      const { getByTestId } = render(<MathNodeView {...defaultProps} />);
+      const wrapper = getByTestId('node-view-wrapper');
+
+      expect(wrapper.className).toMatch(/^math-node-\d+$/);
+    });
+
+    it('assigns a different class to each MathNodeView instance', () => {
+      const { getAllByTestId } = render(
+        <>
+          <MathNodeView {...defaultProps} />
+          <MathNodeView {...defaultProps} node={{ attrs: { latex: 'y^2' } }} />
+        </>,
+      );
+
+      const wrappers = getAllByTestId('node-view-wrapper');
+      expect(wrappers[0].className).toBe('math-node-1000');
+      expect(wrappers[1].className).toBe('math-node-1001');
+    });
+
+    it('closes toolbar when clicking a different math node', async () => {
+      const updateAttributes = jest.fn();
+      const editorA = createMockEditor();
+      const editorB = createMockEditor();
+
+      const { getAllByTestId, queryAllByTestId } = render(
+        <>
+          <MathNodeView {...defaultProps} editor={editorA} updateAttributes={updateAttributes} selected={true} />
+          <MathNodeView {...defaultProps} editor={editorB} node={{ attrs: { latex: 'y^2' } }} selected={false} />
+        </>,
+      );
+
+      await waitFor(() => {
+        expect(queryAllByTestId('math-toolbar')).toHaveLength(1);
+      });
+
+      const secondPreview = getAllByTestId('math-preview')[1];
+      fireEvent.click(secondPreview);
+
+      await waitFor(() => {
+        expect(queryAllByTestId('math-toolbar')).toHaveLength(1);
+        expect(updateAttributes).toHaveBeenCalledWith({ latex: 'x^2' });
+        expect(editorA._toolbarOpened).toBe(false);
+        expect(getAllByTestId('math-input')[0]).toHaveValue('y^2');
+      });
     });
   });
 

package/src/extensions/math.js

@@ -5,6 +5,7 @@ import { NodeViewWrapper, ReactNodeViewRenderer } from '@tiptap/react';
 import { NodeSelection, Plugin, PluginKey, TextSelection } from 'prosemirror-state';
 import { MathPreview, MathToolbar } from '@pie-lib/math-toolbar';
 import { wrapMath } from '@pie-lib/math-rendering';
+import { setToolbarOpened } from '../utils/toolbar';
 
 const ensureTextAfterMathPluginKey = new PluginKey('ensureTextAfterMath');
 
@@ -183,6 +184,7 @@ export const MathNodeView = (props) => {
   const { node, updateAttributes, editor, selected, options } = props;
   const [showToolbar, setShowToolbar] = useState(selected);
   const toolbarRef = useRef(null);
+  const timestamp = useRef(Date.now());
   const [position, setPosition] = useState({ top: 0, left: 0 });
   const { math: mathOptions = {} } = options || {};
   const {
@@ -195,6 +197,23 @@ export const MathNodeView = (props) => {
 
   const latex = node.attrs.latex || '';
 
+  const handleChange = (newLatex) => {
+    updateAttributes({ latex: newLatex });
+  };
+
+  const handleDone = (newLatex) => {
+    updateAttributes({ latex: newLatex });
+    setShowToolbar(false);
+
+    const { selection, tr, doc } = editor.state;
+    const sel = TextSelection.create(doc, selection.from + 1);
+
+    // Build a fresh transaction from the current state and set the selection
+    tr.setSelection(sel);
+    editor.view.dispatch(tr);
+    editor.commands.focus();
+  };
+
   useEffect(() => {
     if (selected) {
       setShowToolbar(true);
@@ -202,17 +221,15 @@ export const MathNodeView = (props) => {
   }, [selected]);
 
   useEffect(() => {
-    editor._toolbarOpened = !!showToolbar;
-  }, [showToolbar]);
+    setToolbarOpened(editor, showToolbar);
+  }, [editor, showToolbar]);
 
   useEffect(() => {
     // Calculate position relative to selection
-    const container = editor?._tiptapContainerEl || document.body;
-    const bodyRect = container.getBoundingClientRect();
     const { from } = editor.state.selection;
     const start = editor.view.coordsAtPos(from);
     setPosition({
-      top: start.top + Math.abs(bodyRect.top) + 40, // shift above
+      top: 40, // shift above
       left: start.left,
     });
 
@@ -236,7 +253,7 @@ export const MathNodeView = (props) => {
       // will keep/re-open the toolbar. Without this guard, closing and then
       // immediately clicking the math node would fire this listener in the same
       // event cycle and close the toolbar before it could open.
-      const clickedMathNode = !!target?.closest?.('.math-node');
+      const clickedMathNode = !!target?.closest?.(`.math-node-${timestamp.current}`);
 
       if (
         toolbarRef.current &&
@@ -247,6 +264,7 @@ export const MathNodeView = (props) => {
         !clickedMathNode
       ) {
         setShowToolbar(false);
+        handleDone(node.attrs.latex);
       }
     };
 
@@ -261,28 +279,9 @@ export const MathNodeView = (props) => {
     return () => document.removeEventListener('click', handleClickOutside);
   }, [editor, showToolbar]);
 
-  const handleChange = (newLatex) => {
-    updateAttributes({ latex: newLatex });
-  };
-
-  const handleDone = (newLatex) => {
-    updateAttributes({ latex: newLatex });
-    setShowToolbar(false);
-
-    editor._toolbarOpened = false;
-
-    const { selection, tr, doc } = editor.state;
-    const sel = TextSelection.create(doc, selection.from + 1);
-
-    // Build a fresh transaction from the current state and set the selection
-    tr.setSelection(sel);
-    editor.view.dispatch(tr);
-    editor.commands.focus();
-  };
-
   return (
     <NodeViewWrapper
-      className="math-node"
+      className={`math-node-${timestamp.current}`}
       style={{
         display: 'inline-flex',
         cursor: 'pointer',

package/src/utils/__tests__/toolbar.test.js

@@ -0,0 +1,43 @@
+import { setToolbarOpened, TOOLBAR_OPENED_META_KEY } from '../toolbar';
+
+describe('setToolbarOpened', () => {
+  const createEditor = (toolbarOpened = false) => {
+    const tr = {
+      setMeta: jest.fn().mockReturnThis(),
+    };
+
+    return {
+      _toolbarOpened: toolbarOpened,
+      state: { tr },
+      view: {
+        dispatch: jest.fn(),
+      },
+    };
+  };
+
+  it('sets editor._toolbarOpened and dispatches a meta transaction', () => {
+    const editor = createEditor(false);
+
+    setToolbarOpened(editor, true);
+
+    expect(editor._toolbarOpened).toBe(true);
+    expect(editor.state.tr.setMeta).toHaveBeenCalledWith(TOOLBAR_OPENED_META_KEY, true);
+    expect(editor.view.dispatch).toHaveBeenCalledWith(editor.state.tr);
+  });
+
+  it('does nothing when the value is unchanged', () => {
+    const editor = createEditor(true);
+
+    setToolbarOpened(editor, true);
+
+    expect(editor.view.dispatch).not.toHaveBeenCalled();
+  });
+
+  it('coerces the opened value to a boolean', () => {
+    const editor = createEditor(false);
+
+    setToolbarOpened(editor, 1);
+
+    expect(editor._toolbarOpened).toBe(true);
+  });
+});

package/src/utils/toolbar.js

@@ -0,0 +1,15 @@
+export const TOOLBAR_OPENED_META_KEY = 'toolbarOpenedChanged';
+
+export const setToolbarOpened = (editor, opened) => {
+  const next = !!opened;
+
+  if (editor._toolbarOpened === next) {
+    return;
+  }
+
+  editor._toolbarOpened = next;
+
+  if (editor?.view && editor?.state?.tr) {
+    editor.view.dispatch(editor.state.tr.setMeta(TOOLBAR_OPENED_META_KEY, true));
+  }
+};