prosemirror-transform 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.6.0 (2022-06-01)
+
+### Bug fixes
+
+Allow replace steps to be mapped through changes that delete content next to their start and end points, as long as no delete spans across those points.
+
+### New features
+
+`MapResult` objects now provide information about whether the tokens before, after, and around the position were deleted.
+
 ## 1.5.0 (2022-05-30)
 
 ### New features

package/dist/index.cjs

@@ -22,12 +22,12 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
 
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
 Object.defineProperty(exports, '__esModule', {
   value: true
 });
@@ -49,16 +49,44 @@ function recoverOffset(value) {
   return (value - (value & lower16)) / factor16;
 }
 
-var MapResult = _createClass(function MapResult(pos) {
-  var deleted = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-  var recover = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+var DEL_BEFORE = 1,
+    DEL_AFTER = 2,
+    DEL_ACROSS = 4,
+    DEL_SIDE = 8;
 
-  _classCallCheck(this, MapResult);
+var MapResult = function () {
+  function MapResult(pos, delInfo, recover) {
+    _classCallCheck(this, MapResult);
 
-  this.pos = pos;
-  this.deleted = deleted;
-  this.recover = recover;
-});
+    this.pos = pos;
+    this.delInfo = delInfo;
+    this.recover = recover;
+  }
+
+  _createClass(MapResult, [{
+    key: "deleted",
+    get: function get() {
+      return (this.delInfo & DEL_SIDE) > 0;
+    }
+  }, {
+    key: "deletedBefore",
+    get: function get() {
+      return (this.delInfo & (DEL_BEFORE | DEL_ACROSS)) > 0;
+    }
+  }, {
+    key: "deletedAfter",
+    get: function get() {
+      return (this.delInfo & (DEL_AFTER | DEL_ACROSS)) > 0;
+    }
+  }, {
+    key: "deletedAcross",
+    get: function get() {
+      return (this.delInfo & DEL_ACROSS) > 0;
+    }
+  }]);
+
+  return MapResult;
+}();
 
 var StepMap = function () {
   function StepMap(ranges) {
@@ -112,13 +140,15 @@ var StepMap = function () {
           var result = start + diff + (side < 0 ? 0 : newSize);
           if (simple) return result;
           var recover = pos == (assoc < 0 ? start : end) ? null : makeRecover(i / 3, pos - start);
-          return new MapResult(result, assoc < 0 ? pos != start : pos != end, recover);
+          var del = pos == start ? DEL_AFTER : pos == end ? DEL_BEFORE : DEL_ACROSS;
+          if (assoc < 0 ? pos != start : pos != end) del |= DEL_SIDE;
+          return new MapResult(result, del, recover);
         }
 
         diff += newSize - oldSize;
       }
 
-      return simple ? pos + diff : new MapResult(pos + diff);
+      return simple ? pos + diff : new MapResult(pos + diff, 0, null);
     }
   }, {
     key: "touches",
@@ -267,7 +297,7 @@ var Mapping = function () {
   }, {
     key: "_map",
     value: function _map(pos, assoc, simple) {
-      var deleted = false;
+      var delInfo = 0;
 
       for (var i = this.from; i < this.to; i++) {
         var map = this.maps[i],
@@ -283,11 +313,11 @@ var Mapping = function () {
           }
         }
 
-        if (result.deleted) deleted = true;
+        delInfo |= result.delInfo;
         pos = result.pos;
       }
 
-      return simple ? pos : new MapResult(pos, deleted);
+      return simple ? pos : new MapResult(pos, delInfo, null);
     }
   }]);
 
@@ -562,7 +592,7 @@ var ReplaceStep = function (_Step3) {
     value: function map(mapping) {
       var from = mapping.mapResult(this.from, 1),
           to = mapping.mapResult(this.to, -1);
-      if (from.deleted && to.deleted) return null;
+      if (from.deletedAcross && to.deletedAcross) return null;
       return new ReplaceStep(from.pos, Math.max(from.pos, to.pos), this.slice);
     }
   }, {
@@ -657,7 +687,7 @@ var ReplaceAroundStep = function (_Step4) {
           to = mapping.mapResult(this.to, -1);
       var gapFrom = mapping.map(this.gapFrom, -1),
           gapTo = mapping.map(this.gapTo, 1);
-      if (from.deleted && to.deleted || gapFrom < from.pos || gapTo > to.pos) return null;
+      if (from.deletedAcross && to.deletedAcross || gapFrom < from.pos || gapTo > to.pos) return null;
       return new ReplaceAroundStep(from.pos, to.pos, gapFrom, gapTo, this.slice, this.insert, this.structure);
     }
   }, {

package/dist/index.d.ts

@@ -32,10 +32,25 @@ declare class MapResult {
     */
     readonly pos: number;
     /**
-    Tells you whether the position was deleted, that is, whether
-    the step removed its surroundings from the document.
+    Tells you whether the position was deleted, that is, whether the
+    step removed the token on the side queried (via the `assoc`)
+    argument from the document.
     */
-    readonly deleted: boolean;
+    get deleted(): boolean;
+    /**
+    Tells you whether the token before the mapped position was deleted.
+    */
+    get deletedBefore(): boolean;
+    /**
+    True when the token after the mapped position was deleted.
+    */
+    get deletedAfter(): boolean;
+    /**
+    Tells whether any of the steps mapped through deletes across the
+    position (including both the token before and after the
+    position).
+    */
+    get deletedAcross(): boolean;
 }
 /**
 A map describing the deletions and insertions made by a step, which

package/dist/index.js

@@ -14,6 +14,7 @@ const factor16 = Math.pow(2, 16);
 function makeRecover(index, offset) { return index + offset * factor16; }
 function recoverIndex(value) { return value & lower16; }
 function recoverOffset(value) { return (value - (value & lower16)) / factor16; }
+const DEL_BEFORE = 1, DEL_AFTER = 2, DEL_ACROSS = 4, DEL_SIDE = 8;
 /**
 An object representing a mapped position with extra
 information.
@@ -28,18 +29,37 @@ class MapResult {
     */
     pos, 
     /**
-    Tells you whether the position was deleted, that is, whether
-    the step removed its surroundings from the document.
+    @internal
     */
-    deleted = false, 
+    delInfo, 
     /**
     @internal
     */
-    recover = null) {
+    recover) {
         this.pos = pos;
-        this.deleted = deleted;
+        this.delInfo = delInfo;
         this.recover = recover;
     }
+    /**
+    Tells you whether the position was deleted, that is, whether the
+    step removed the token on the side queried (via the `assoc`)
+    argument from the document.
+    */
+    get deleted() { return (this.delInfo & DEL_SIDE) > 0; }
+    /**
+    Tells you whether the token before the mapped position was deleted.
+    */
+    get deletedBefore() { return (this.delInfo & (DEL_BEFORE | DEL_ACROSS)) > 0; }
+    /**
+    True when the token after the mapped position was deleted.
+    */
+    get deletedAfter() { return (this.delInfo & (DEL_AFTER | DEL_ACROSS)) > 0; }
+    /**
+    Tells whether any of the steps mapped through deletes across the
+    position (including both the token before and after the
+    position).
+    */
+    get deletedAcross() { return (this.delInfo & DEL_ACROSS) > 0; }
 }
 /**
 A map describing the deletions and insertions made by a step, which
@@ -95,11 +115,14 @@ class StepMap {
                 if (simple)
                     return result;
                 let recover = pos == (assoc < 0 ? start : end) ? null : makeRecover(i / 3, pos - start);
-                return new MapResult(result, assoc < 0 ? pos != start : pos != end, recover);
+                let del = pos == start ? DEL_AFTER : pos == end ? DEL_BEFORE : DEL_ACROSS;
+                if (assoc < 0 ? pos != start : pos != end)
+                    del |= DEL_SIDE;
+                return new MapResult(result, del, recover);
             }
             diff += newSize - oldSize;
         }
-        return simple ? pos + diff : new MapResult(pos + diff);
+        return simple ? pos + diff : new MapResult(pos + diff, 0, null);
     }
     /**
     @internal
@@ -279,7 +302,7 @@ class Mapping {
     @internal
     */
     _map(pos, assoc, simple) {
-        let deleted = false;
+        let delInfo = 0;
         for (let i = this.from; i < this.to; i++) {
             let map = this.maps[i], result = map.mapResult(pos, assoc);
             if (result.recover != null) {
@@ -290,11 +313,10 @@ class Mapping {
                     continue;
                 }
             }
-            if (result.deleted)
-                deleted = true;
+            delInfo |= result.delInfo;
             pos = result.pos;
         }
-        return simple ? pos : new MapResult(pos, deleted);
+        return simple ? pos : new MapResult(pos, delInfo, null);
     }
 }
 
@@ -583,7 +605,7 @@ class ReplaceStep extends Step {
     }
     map(mapping) {
         let from = mapping.mapResult(this.from, 1), to = mapping.mapResult(this.to, -1);
-        if (from.deleted && to.deleted)
+        if (from.deletedAcross && to.deletedAcross)
             return null;
         return new ReplaceStep(from.pos, Math.max(from.pos, to.pos), this.slice);
     }
@@ -696,7 +718,7 @@ class ReplaceAroundStep extends Step {
     map(mapping) {
         let from = mapping.mapResult(this.from, 1), to = mapping.mapResult(this.to, -1);
         let gapFrom = mapping.map(this.gapFrom, -1), gapTo = mapping.map(this.gapTo, 1);
-        if ((from.deleted && to.deleted) || gapFrom < from.pos || gapTo > to.pos)
+        if ((from.deletedAcross && to.deletedAcross) || gapFrom < from.pos || gapTo > to.pos)
             return null;
         return new ReplaceAroundStep(from.pos, to.pos, gapFrom, gapTo, this.slice, this.insert, this.structure);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prosemirror-transform",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "ProseMirror document transformations",
   "type": "module",
   "main": "dist/index.cjs",

package/src/map.ts

@@ -33,6 +33,8 @@ function makeRecover(index: number, offset: number) { return index + offset * fa
 function recoverIndex(value: number) { return value & lower16 }
 function recoverOffset(value: number) { return (value - (value & lower16)) / factor16 }
 
+const DEL_BEFORE = 1, DEL_AFTER = 2, DEL_ACROSS = 4, DEL_SIDE = 8
+
 /// An object representing a mapped position with extra
 /// information.
 export class MapResult {
@@ -40,12 +42,27 @@ export class MapResult {
   constructor(
     /// The mapped version of the position.
     readonly pos: number,
-    /// Tells you whether the position was deleted, that is, whether
-    /// the step removed its surroundings from the document.
-    readonly deleted: boolean = false,
     /// @internal
-    readonly recover: number | null = null
+    readonly delInfo: number,
+    /// @internal
+    readonly recover: number | null
   ) {}
+
+  /// Tells you whether the position was deleted, that is, whether the
+  /// step removed the token on the side queried (via the `assoc`)
+  /// argument from the document.
+  get deleted() { return (this.delInfo & DEL_SIDE) > 0 }
+
+  /// Tells you whether the token before the mapped position was deleted.
+  get deletedBefore() { return (this.delInfo & (DEL_BEFORE | DEL_ACROSS)) > 0 }
+
+  /// True when the token after the mapped position was deleted.
+  get deletedAfter() { return (this.delInfo & (DEL_AFTER | DEL_ACROSS)) > 0 }
+
+  /// Tells whether any of the steps mapped through deletes across the
+  /// position (including both the token before and after the
+  /// position).
+  get deletedAcross() { return (this.delInfo & DEL_ACROSS) > 0 }
 }
 
 /// A map describing the deletions and insertions made by a step, which
@@ -89,11 +106,13 @@ export class StepMap implements Mappable {
         let result = start + diff + (side < 0 ? 0 : newSize)
         if (simple) return result
         let recover = pos == (assoc < 0 ? start : end) ? null : makeRecover(i / 3, pos - start)
-        return new MapResult(result, assoc < 0 ? pos != start : pos != end, recover)
+        let del = pos == start ? DEL_AFTER : pos == end ? DEL_BEFORE : DEL_ACROSS
+        if (assoc < 0 ? pos != start : pos != end) del |= DEL_SIDE
+        return new MapResult(result, del, recover)
       }
       diff += newSize - oldSize
     }
-    return simple ? pos + diff : new MapResult(pos + diff)
+    return simple ? pos + diff : new MapResult(pos + diff, 0, null)
   }
 
   /// @internal
@@ -234,7 +253,7 @@ export class Mapping implements Mappable {
 
   /// @internal
   _map(pos: number, assoc: number, simple: boolean) {
-    let deleted = false
+    let delInfo = 0
 
     for (let i = this.from; i < this.to; i++) {
       let map = this.maps[i], result = map.mapResult(pos, assoc)
@@ -247,10 +266,10 @@ export class Mapping implements Mappable {
         }
       }
 
-      if (result.deleted) deleted = true
+      delInfo |= result.delInfo
       pos = result.pos
     }
 
-    return simple ? pos : new MapResult(pos, deleted)
+    return simple ? pos : new MapResult(pos, delInfo, null)
   }
 }

package/src/replace_step.ts

@@ -41,7 +41,7 @@ export class ReplaceStep extends Step {
 
   map(mapping: Mappable) {
     let from = mapping.mapResult(this.from, 1), to = mapping.mapResult(this.to, -1)
-    if (from.deleted && to.deleted) return null
+    if (from.deletedAcross && to.deletedAcross) return null
     return new ReplaceStep(from.pos, Math.max(from.pos, to.pos), this.slice)
   }
 
@@ -135,7 +135,7 @@ export class ReplaceAroundStep extends Step {
   map(mapping: Mappable) {
     let from = mapping.mapResult(this.from, 1), to = mapping.mapResult(this.to, -1)
     let gapFrom = mapping.map(this.gapFrom, -1), gapTo = mapping.map(this.gapTo, 1)
-    if ((from.deleted && to.deleted) || gapFrom < from.pos || gapTo > to.pos) return null
+    if ((from.deletedAcross && to.deletedAcross) || gapFrom < from.pos || gapTo > to.pos) return null
     return new ReplaceAroundStep(from.pos, to.pos, gapFrom, gapTo, this.slice, this.insert, this.structure)
   }