prosemirror-view 1.24.0-beta.2 → 1.24.1

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 1.24.1 (2022-05-30)
+
+### Bug fixes
+
+Fix a regression that caused the key handler to crash.
+
+## 1.24.0 (2022-05-30)
+
+### Bug fixes
+
+Fix an issue where bogus table wrappers could be added when copy-pasting table content nodes within an editor.
+
+Fix a crash that could occur when two textblocks were joined in the editor DOM.
+
+Treat ctrl-b/f/p/n on macOS similar to arrow key presses, anticipating cursor motion.
+
+### New features
+
+Include TypeScript type declarations.
+
 ## 1.23.13 (2022-04-26)
 
 ### Bug fixes

package/dist/index.cjs

@@ -2866,13 +2866,13 @@ function captureKeyDown(view, event) {
     return stopNativeHorizontalDelete(view, 1) || skipIgnoredNodesRight(view);
   } else if (code == 13 || code == 27) {
     return true;
-  } else if (code == 37) {
+  } else if (code == 37 || mac && code == 66 && mods == "c") {
     return selectHorizontally(view, -1, mods) || skipIgnoredNodesLeft(view);
-  } else if (code == 39) {
+  } else if (code == 39 || mac && code == 70 && mods == "c") {
     return selectHorizontally(view, 1, mods) || skipIgnoredNodesRight(view);
-  } else if (code == 38) {
+  } else if (code == 38 || mac && code == 80 && mods == "c") {
     return selectVertically(view, -1, mods) || skipIgnoredNodesLeft(view);
-  } else if (code == 40) {
+  } else if (code == 40 || mac && code == 78 && mods == "c") {
     return safariDownArrowBug(view) || selectVertically(view, 1, mods) || skipIgnoredNodesRight(view);
   } else if (mods == (mac ? "m" : "c") && (code == 66 || code == 73 || code == 89 || code == 90)) {
     return true;
@@ -2902,7 +2902,8 @@ function serializeForClipboard(view, slice) {
     document: doc
   }));
   var firstChild = wrap.firstChild,
-      needsWrap;
+      needsWrap,
+      wrappers = 0;
 
   while (firstChild && firstChild.nodeType == 1 && (needsWrap = wrapMap[firstChild.nodeName.toLowerCase()])) {
     for (var i = needsWrap.length - 1; i >= 0; i--) {
@@ -2913,17 +2914,13 @@ function serializeForClipboard(view, slice) {
       }
 
       wrap.appendChild(wrapper);
-
-      if (needsWrap[i] != "tbody") {
-        openStart++;
-        openEnd++;
-      }
+      wrappers++;
     }
 
     firstChild = wrap.firstChild;
   }
 
-  if (firstChild && firstChild.nodeType == 1) firstChild.setAttribute("data-pm-slice", "".concat(openStart, " ").concat(openEnd, " ").concat(JSON.stringify(context)));
+  if (firstChild && firstChild.nodeType == 1) firstChild.setAttribute("data-pm-slice", "".concat(openStart, " ").concat(openEnd).concat(wrappers ? " -".concat(wrappers) : "", " ").concat(JSON.stringify(context)));
   var text = view.someProp("clipboardTextSerializer", function (f) {
     return f(slice);
   }) || slice.content.textBetween(0, slice.content.size, "\n\n");
@@ -2969,7 +2966,10 @@ function parseFromClipboard(view, text, html, plainText, $context) {
   }
 
   var contextNode = dom && dom.querySelector("[data-pm-slice]");
-  var sliceData = contextNode && /^(\d+) (\d+) (.*)/.exec(contextNode.getAttribute("data-pm-slice") || "");
+  var sliceData = contextNode && /^(\d+) (\d+)(?: -(\d+))? (.*)/.exec(contextNode.getAttribute("data-pm-slice") || "");
+  if (sliceData && sliceData[3]) for (var i = +sliceData[3]; i > 0 && dom.firstChild; i--) {
+    dom = dom.firstChild;
+  }
 
   if (!slice) {
     var parser = view.someProp("clipboardParser") || view.someProp("domParser") || prosemirrorModel.DOMParser.fromSchema(view.state.schema);
@@ -2986,7 +2986,7 @@ function parseFromClipboard(view, text, html, plainText, $context) {
   }
 
   if (sliceData) {
-    slice = addContext(closeSlice(slice, +sliceData[1], +sliceData[2]), sliceData[3]);
+    slice = addContext(closeSlice(slice, +sliceData[1], +sliceData[2]), sliceData[4]);
   } else {
     slice = prosemirrorModel.Slice.maxOpen(normalizeSiblings(slice.content, $context), true);
 
@@ -5111,7 +5111,8 @@ function readDOMChange(view, from, to, typeOver, addedNodes) {
 
   var $from = parse.doc.resolveNoCache(change.start - parse.from);
   var $to = parse.doc.resolveNoCache(change.endB - parse.from);
-  var inlineChange = $from.sameParent($to) && $from.parent.inlineContent;
+  var $fromA = doc.resolve(change.start);
+  var inlineChange = $from.sameParent($to) && $from.parent.inlineContent && $fromA.end() >= change.endA;
   var nextSel;
 
   if ((ios && view.input.lastIOSEnter > Date.now() - 225 && (!inlineChange || addedNodes.some(function (n) {
@@ -5144,7 +5145,7 @@ function readDOMChange(view, from, to, typeOver, addedNodes) {
 
   var chFrom = change.start,
       chTo = change.endA;
-  var tr, storedMarks, markChange, $from1;
+  var tr, storedMarks, markChange;
 
   if (inlineChange) {
     if ($from.pos == $to.pos) {
@@ -5157,7 +5158,7 @@ function readDOMChange(view, from, to, typeOver, addedNodes) {
 
       tr = view.state.tr["delete"](chFrom, chTo);
       storedMarks = doc.resolve(change.start).marksAcross(doc.resolve(change.endA));
-    } else if (change.endA == change.endB && ($from1 = doc.resolve(change.start)) && (markChange = isMarkChange($from.parent.content.cut($from.parentOffset, $to.parentOffset), $from1.parent.content.cut($from1.parentOffset, change.endA - $from1.start())))) {
+    } else if (change.endA == change.endB && (markChange = isMarkChange($from.parent.content.cut($from.parentOffset, $to.parentOffset), $fromA.parent.content.cut($fromA.parentOffset, change.endA - $fromA.start())))) {
       tr = view.state.tr;
       if (markChange.type == "add") tr.addMark(chFrom, chTo, markChange.mark);else tr.removeMark(chFrom, chTo, markChange.mark);
     } else if ($from.parent.child($from.index()).isText && $from.index() == $to.index() - ($to.textOffset ? 0 : 1)) {

package/dist/index.d.ts

@@ -538,6 +538,14 @@ declare class EditorView {
 }
 declare type NodeViewConstructor = (node: Node, view: EditorView, getPos: () => number | undefined, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView;
 /**
+Helper type that maps event names to event object types, but
+includes events that TypeScript's HTMLElementEventMap doesn't know
+about.
+*/
+interface DOMEventMap extends HTMLElementEventMap {
+    [event: string]: Event;
+}
+/**
 Props are configuration values that can be passed to an editor view
 or included in a plugin. This interface lists the supported props.
 
@@ -563,7 +571,7 @@ interface EditorProps {
     default behavior).
     */
     handleDOMEvents?: {
-        [event: string]: (view: EditorView, event: Event) => boolean | void;
+        [event in string]: (view: EditorView, event: DOMEventMap[event]) => boolean | void;
     };
     /**
     Called when the editor receives a `keydown` event.
@@ -788,4 +796,4 @@ interface DirectEditorProps extends EditorProps {
     dispatchTransaction?: (tr: Transaction) => void;
 }
 
-export { Decoration, DecorationAttrs, DecorationSet, DecorationSource, DirectEditorProps, EditorProps, EditorView, NodeView };
+export { DOMEventMap, Decoration, DecorationAttrs, DecorationSet, DecorationSource, DirectEditorProps, EditorProps, EditorView, NodeView };

package/dist/index.js

@@ -2509,16 +2509,16 @@ function captureKeyDown(view, event) {
     else if (code == 13 || code == 27) { // Enter, Esc
         return true;
     }
-    else if (code == 37) { // Left arrow
+    else if (code == 37 || (mac && code == 66 && mods == "c")) { // Left arrow, Ctrl-b on Mac
         return selectHorizontally(view, -1, mods) || skipIgnoredNodesLeft(view);
     }
-    else if (code == 39) { // Right arrow
+    else if (code == 39 || (mac && code == 70 && mods == "c")) { // Right arrow, Ctrl-f on Mac
         return selectHorizontally(view, 1, mods) || skipIgnoredNodesRight(view);
     }
-    else if (code == 38) { // Up arrow
+    else if (code == 38 || (mac && code == 80 && mods == "c")) { // Up arrow, Ctrl-p on Mac
         return selectVertically(view, -1, mods) || skipIgnoredNodesLeft(view);
     }
-    else if (code == 40) { // Down arrow
+    else if (code == 40 || (mac && code == 78 && mods == "c")) { // Down arrow, Ctrl-n on Mac
         return safariDownArrowBug(view) || selectVertically(view, 1, mods) || skipIgnoredNodesRight(view);
     }
     else if (mods == (mac ? "m" : "c") &&
@@ -2540,22 +2540,19 @@ function serializeForClipboard(view, slice) {
     let serializer = view.someProp("clipboardSerializer") || DOMSerializer.fromSchema(view.state.schema);
     let doc = detachedDoc(), wrap = doc.createElement("div");
     wrap.appendChild(serializer.serializeFragment(content, { document: doc }));
-    let firstChild = wrap.firstChild, needsWrap;
+    let firstChild = wrap.firstChild, needsWrap, wrappers = 0;
     while (firstChild && firstChild.nodeType == 1 && (needsWrap = wrapMap[firstChild.nodeName.toLowerCase()])) {
         for (let i = needsWrap.length - 1; i >= 0; i--) {
             let wrapper = doc.createElement(needsWrap[i]);
             while (wrap.firstChild)
                 wrapper.appendChild(wrap.firstChild);
             wrap.appendChild(wrapper);
-            if (needsWrap[i] != "tbody") {
-                openStart++;
-                openEnd++;
-            }
+            wrappers++;
         }
         firstChild = wrap.firstChild;
     }
     if (firstChild && firstChild.nodeType == 1)
-        firstChild.setAttribute("data-pm-slice", `${openStart} ${openEnd} ${JSON.stringify(context)}`);
+        firstChild.setAttribute("data-pm-slice", `${openStart} ${openEnd}${wrappers ? ` -${wrappers}` : ""} ${JSON.stringify(context)}`);
     let text = view.someProp("clipboardTextSerializer", f => f(slice)) ||
         slice.content.textBetween(0, slice.content.size, "\n\n");
     return { dom: wrap, text };
@@ -2593,7 +2590,10 @@ function parseFromClipboard(view, text, html, plainText, $context) {
             restoreReplacedSpaces(dom);
     }
     let contextNode = dom && dom.querySelector("[data-pm-slice]");
-    let sliceData = contextNode && /^(\d+) (\d+) (.*)/.exec(contextNode.getAttribute("data-pm-slice") || "");
+    let sliceData = contextNode && /^(\d+) (\d+)(?: -(\d+))? (.*)/.exec(contextNode.getAttribute("data-pm-slice") || "");
+    if (sliceData && sliceData[3])
+        for (let i = +sliceData[3]; i > 0 && dom.firstChild; i--)
+            dom = dom.firstChild;
     if (!slice) {
         let parser = view.someProp("clipboardParser") || view.someProp("domParser") || DOMParser.fromSchema(view.state.schema);
         slice = parser.parseSlice(dom, {
@@ -2608,7 +2608,7 @@ function parseFromClipboard(view, text, html, plainText, $context) {
         });
     }
     if (sliceData) {
-        slice = addContext(closeSlice(slice, +sliceData[1], +sliceData[2]), sliceData[3]);
+        slice = addContext(closeSlice(slice, +sliceData[1], +sliceData[2]), sliceData[4]);
     }
     else { // HTML wasn't created by ProseMirror. Make sure top-level siblings are coherent
         slice = Slice.maxOpen(normalizeSiblings(slice.content, $context), true);
@@ -4566,7 +4566,8 @@ function readDOMChange(view, from, to, typeOver, addedNodes) {
     }
     let $from = parse.doc.resolveNoCache(change.start - parse.from);
     let $to = parse.doc.resolveNoCache(change.endB - parse.from);
-    let inlineChange = $from.sameParent($to) && $from.parent.inlineContent;
+    let $fromA = doc.resolve(change.start);
+    let inlineChange = $from.sameParent($to) && $from.parent.inlineContent && $fromA.end() >= change.endA;
     let nextSel;
     // If this looks like the effect of pressing Enter (or was recorded
     // as being an iOS enter press), just dispatch an Enter key instead.
@@ -4609,7 +4610,7 @@ function readDOMChange(view, from, to, typeOver, addedNodes) {
         }, 20);
     }
     let chFrom = change.start, chTo = change.endA;
-    let tr, storedMarks, markChange, $from1;
+    let tr, storedMarks, markChange;
     if (inlineChange) {
         if ($from.pos == $to.pos) { // Deletion
             // IE11 sometimes weirdly moves the DOM selection around after
@@ -4622,8 +4623,8 @@ function readDOMChange(view, from, to, typeOver, addedNodes) {
             storedMarks = doc.resolve(change.start).marksAcross(doc.resolve(change.endA));
         }
         else if ( // Adding or removing a mark
-        change.endA == change.endB && ($from1 = doc.resolve(change.start)) &&
-            (markChange = isMarkChange($from.parent.content.cut($from.parentOffset, $to.parentOffset), $from1.parent.content.cut($from1.parentOffset, change.endA - $from1.start())))) {
+        change.endA == change.endB &&
+            (markChange = isMarkChange($from.parent.content.cut($from.parentOffset, $to.parentOffset), $fromA.parent.content.cut($fromA.parentOffset, change.endA - $fromA.start())))) {
             tr = view.state.tr;
             if (markChange.type == "add")
                 tr.addMark(chFrom, chTo, markChange.mark);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prosemirror-view",
-  "version": "1.24.0-beta.2",
+  "version": "1.24.1",
   "description": "ProseMirror's view component",
   "type": "module",
   "main": "dist/index.cjs",

package/src/README.md

@@ -14,6 +14,8 @@ this module.
 
 @NodeView
 
+@DOMEventMap
+
 ### Decorations
 
 Decorations make it possible to influence the way the document is

package/src/capturekeys.ts

@@ -256,13 +256,13 @@ export function captureKeyDown(view: EditorView, event: KeyboardEvent) {
     return stopNativeHorizontalDelete(view, 1) || skipIgnoredNodesRight(view)
   } else if (code == 13 || code == 27) { // Enter, Esc
     return true
-  } else if (code == 37) { // Left arrow
+  } else if (code == 37 || (browser.mac && code == 66 && mods == "c")) { // Left arrow, Ctrl-b on Mac
     return selectHorizontally(view, -1, mods) || skipIgnoredNodesLeft(view)
-  } else if (code == 39) { // Right arrow
+  } else if (code == 39 || (browser.mac && code == 70 && mods == "c")) { // Right arrow, Ctrl-f on Mac
     return selectHorizontally(view, 1, mods) || skipIgnoredNodesRight(view)
-  } else if (code == 38) { // Up arrow
+  } else if (code == 38 || (browser.mac && code == 80 && mods == "c")) { // Up arrow, Ctrl-p on Mac
     return selectVertically(view, -1, mods) || skipIgnoredNodesLeft(view)
-  } else if (code == 40) { // Down arrow
+  } else if (code == 40 || (browser.mac && code == 78 && mods == "c")) { // Down arrow, Ctrl-n on Mac
     return safariDownArrowBug(view) || selectVertically(view, 1, mods) || skipIgnoredNodesRight(view)
   } else if (mods == (browser.mac ? "m" : "c") &&
              (code == 66 || code == 73 || code == 89 || code == 90)) { // Mod-[biyz]

package/src/clipboard.ts

@@ -16,22 +16,20 @@ export function serializeForClipboard(view: EditorView, slice: Slice) {
   let doc = detachedDoc(), wrap = doc.createElement("div")
   wrap.appendChild(serializer.serializeFragment(content, {document: doc}))
 
-  let firstChild = wrap.firstChild, needsWrap
+  let firstChild = wrap.firstChild, needsWrap, wrappers = 0
   while (firstChild && firstChild.nodeType == 1 && (needsWrap = wrapMap[firstChild.nodeName.toLowerCase()])) {
     for (let i = needsWrap.length - 1; i >= 0; i--) {
       let wrapper = doc.createElement(needsWrap[i])
       while (wrap.firstChild) wrapper.appendChild(wrap.firstChild)
       wrap.appendChild(wrapper)
-      if (needsWrap[i] != "tbody") {
-        openStart++
-        openEnd++
-      }
+      wrappers++
     }
     firstChild = wrap.firstChild
   }
 
   if (firstChild && firstChild.nodeType == 1)
-    (firstChild as HTMLElement).setAttribute("data-pm-slice", `${openStart} ${openEnd} ${JSON.stringify(context)}`)
+    (firstChild as HTMLElement).setAttribute(
+      "data-pm-slice", `${openStart} ${openEnd}${wrappers ? ` -${wrappers}` : ""} ${JSON.stringify(context)}`)
 
   let text = view.someProp("clipboardTextSerializer", f => f(slice)) ||
       slice.content.textBetween(0, slice.content.size, "\n\n")
@@ -67,7 +65,10 @@ export function parseFromClipboard(view: EditorView, text: string, html: string
   }
 
   let contextNode = dom && dom.querySelector("[data-pm-slice]")
-  let sliceData = contextNode && /^(\d+) (\d+) (.*)/.exec(contextNode.getAttribute("data-pm-slice") || "")
+  let sliceData = contextNode && /^(\d+) (\d+)(?: -(\d+))? (.*)/.exec(contextNode.getAttribute("data-pm-slice") || "")
+  if (sliceData && sliceData[3]) for (let i = +sliceData[3]; i > 0 && dom!.firstChild; i--)
+    dom = dom!.firstChild as HTMLElement
+
   if (!slice) {
     let parser = view.someProp("clipboardParser") || view.someProp("domParser") || DOMParser.fromSchema(view.state.schema)
     slice = parser.parseSlice(dom!, {
@@ -81,7 +82,7 @@ export function parseFromClipboard(view: EditorView, text: string, html: string
     })
   }
   if (sliceData) {
-    slice = addContext(closeSlice(slice, +sliceData[1], +sliceData[2]), sliceData[3])
+    slice = addContext(closeSlice(slice, +sliceData[1], +sliceData[2]), sliceData[4])
   } else { // HTML wasn't created by ProseMirror. Make sure top-level siblings are coherent
     slice = Slice.maxOpen(normalizeSiblings(slice.content, $context), true)
     if (slice.openStart || slice.openEnd) {

package/src/domchange.ts

@@ -167,7 +167,8 @@ export function readDOMChange(view: EditorView, from: number, to: number, typeOv
 
   let $from = parse.doc.resolveNoCache(change.start - parse.from)
   let $to = parse.doc.resolveNoCache(change.endB - parse.from)
-  let inlineChange = $from.sameParent($to) && $from.parent.inlineContent
+  let $fromA = doc.resolve(change.start)
+  let inlineChange = $from.sameParent($to) && $from.parent.inlineContent && $fromA.end() >= change.endA
   let nextSel
   // If this looks like the effect of pressing Enter (or was recorded
   // as being an iOS enter press), just dispatch an Enter key instead.
@@ -213,7 +214,7 @@ export function readDOMChange(view: EditorView, from: number, to: number, typeOv
 
   let chFrom = change.start, chTo = change.endA
 
-  let tr, storedMarks, markChange, $from1
+  let tr, storedMarks, markChange
   if (inlineChange) {
     if ($from.pos == $to.pos) { // Deletion
       // IE11 sometimes weirdly moves the DOM selection around after
@@ -225,9 +226,9 @@ export function readDOMChange(view: EditorView, from: number, to: number, typeOv
       tr = view.state.tr.delete(chFrom, chTo)
       storedMarks = doc.resolve(change.start).marksAcross(doc.resolve(change.endA))
     } else if ( // Adding or removing a mark
-      change.endA == change.endB && ($from1 = doc.resolve(change.start)) &&
+      change.endA == change.endB &&
       (markChange = isMarkChange($from.parent.content.cut($from.parentOffset, $to.parentOffset),
-                                 $from1.parent.content.cut($from1.parentOffset, change.endA - $from1.start())))
+                                 $fromA.parent.content.cut($fromA.parentOffset, change.endA - $fromA.start())))
     ) {
       tr = view.state.tr
       if (markChange.type == "add") tr.addMark(chFrom, chTo, markChange.mark)

package/src/index.ts

@@ -498,6 +498,13 @@ function checkStateComponent(plugin: Plugin) {
 type NodeViewConstructor = (node: Node, view: EditorView, getPos: () => number | undefined,
                             decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView
 
+/// Helper type that maps event names to event object types, but
+/// includes events that TypeScript's HTMLElementEventMap doesn't know
+/// about.
+export interface DOMEventMap extends HTMLElementEventMap {
+  [event: string]: Event
+}
+
 /// Props are configuration values that can be passed to an editor view
 /// or included in a plugin. This interface lists the supported props.
 ///
@@ -519,7 +526,9 @@ export interface EditorProps {
   /// from such a function, you are responsible for calling
   /// `preventDefault` yourself (or not, if you want to allow the
   /// default behavior).
-  handleDOMEvents?: {[event: string]: (view: EditorView, event: Event) => boolean | void}
+  handleDOMEvents?: {
+    [event in string]: (view: EditorView, event: DOMEventMap[event]) => boolean | void
+  }
 
   /// Called when the editor receives a `keydown` event.
   handleKeyDown?: (view: EditorView, event: KeyboardEvent) => boolean | void