prosemirror-transform 1.10.2 → 1.10.3

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.10.3 (2025-03-04)
+
+### Bug fixes
+
+Make sure `Mapping.appendMap` doesn't mutate shared arrays passed to its constructor.
+
 ## 1.10.2 (2024-10-11)
 
 ### Bug fixes

package/dist/index.cjs

@@ -167,41 +167,45 @@ var StepMap = function () {
 }();
 StepMap.empty = new StepMap([]);
 var Mapping = function () {
-  function Mapping() {
-    var maps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-    var mirror = arguments.length > 1 ? arguments[1] : undefined;
+  function Mapping(maps, mirror) {
     var from = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
-    var to = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : maps.length;
+    var to = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : maps ? maps.length : 0;
     _classCallCheck(this, Mapping);
-    this.maps = maps;
     this.mirror = mirror;
     this.from = from;
     this.to = to;
+    this._maps = maps || [];
+    this.ownData = !(maps || mirror);
   }
   _createClass(Mapping, [{
+    key: "maps",
+    get: function get() {
+      return this._maps;
+    }
+  }, {
     key: "slice",
     value: function slice() {
       var from = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
       var to = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.maps.length;
-      return new Mapping(this.maps, this.mirror, from, to);
-    }
-  }, {
-    key: "copy",
-    value: function copy() {
-      return new Mapping(this.maps.slice(), this.mirror && this.mirror.slice(), this.from, this.to);
+      return new Mapping(this._maps, this.mirror, from, to);
     }
   }, {
     key: "appendMap",
     value: function appendMap(map, mirrors) {
-      this.to = this.maps.push(map);
-      if (mirrors != null) this.setMirror(this.maps.length - 1, mirrors);
+      if (!this.ownData) {
+        this._maps = this._maps.slice();
+        this.mirror = this.mirror && this.mirror.slice();
+        this.ownData = true;
+      }
+      this.to = this._maps.push(map);
+      if (mirrors != null) this.setMirror(this._maps.length - 1, mirrors);
     }
   }, {
     key: "appendMapping",
     value: function appendMapping(mapping) {
-      for (var i = 0, startSize = this.maps.length; i < mapping.maps.length; i++) {
+      for (var i = 0, startSize = this._maps.length; i < mapping._maps.length; i++) {
         var mirr = mapping.getMirror(i);
-        this.appendMap(mapping.maps[i], mirr != null && mirr < i ? startSize + mirr : undefined);
+        this.appendMap(mapping._maps[i], mirr != null && mirr < i ? startSize + mirr : undefined);
       }
     }
   }, {
@@ -218,9 +222,9 @@ var Mapping = function () {
   }, {
     key: "appendMappingInverted",
     value: function appendMappingInverted(mapping) {
-      for (var i = mapping.maps.length - 1, totalSize = this.maps.length + mapping.maps.length; i >= 0; i--) {
+      for (var i = mapping.maps.length - 1, totalSize = this._maps.length + mapping._maps.length; i >= 0; i--) {
         var mirr = mapping.getMirror(i);
-        this.appendMap(mapping.maps[i].invert(), mirr != null && mirr > i ? totalSize - mirr - 1 : undefined);
+        this.appendMap(mapping._maps[i].invert(), mirr != null && mirr > i ? totalSize - mirr - 1 : undefined);
       }
     }
   }, {
@@ -235,7 +239,7 @@ var Mapping = function () {
     value: function map(pos) {
       var assoc = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1;
       if (this.mirror) return this._map(pos, assoc, true);
-      for (var i = this.from; i < this.to; i++) pos = this.maps[i].map(pos, assoc);
+      for (var i = this.from; i < this.to; i++) pos = this._maps[i].map(pos, assoc);
       return pos;
     }
   }, {
@@ -249,13 +253,13 @@ var Mapping = function () {
     value: function _map(pos, assoc, simple) {
       var delInfo = 0;
       for (var i = this.from; i < this.to; i++) {
-        var map = this.maps[i],
+        var map = this._maps[i],
           result = map.mapResult(pos, assoc);
         if (result.recover != null) {
           var corr = this.getMirror(i);
           if (corr != null && corr > i && corr < this.to) {
             i = corr;
-            pos = this.maps[corr].recover(result.recover);
+            pos = this._maps[corr].recover(result.recover);
             continue;
           }
         }

package/dist/index.d.cts

@@ -101,14 +101,10 @@ A mapping represents a pipeline of zero or more [step
 maps](https://prosemirror.net/docs/ref/#transform.StepMap). It has special provisions for losslessly
 handling mapping positions through a series of steps in which some
 steps are inverted versions of earlier steps. (This comes up when
-‘[rebasing](/docs/guide/#transform.rebasing)’ steps for
+‘[rebasing](https://prosemirror.net/docs/guide/#transform.rebasing)’ steps for
 collaboration or history management.)
 */
 declare class Mapping implements Mappable {
-    /**
-    The step maps in this mapping.
-    */
-    readonly maps: StepMap[];
     /**
     The starting position in the `maps` array, used when `map` or
     `mapResult` is called.
@@ -121,11 +117,7 @@ declare class Mapping implements Mappable {
     /**
     Create a new mapping with the given position maps.
     */
-    constructor(
-    /**
-    The step maps in this mapping.
-    */
-    maps?: StepMap[], 
+    constructor(maps?: readonly StepMap[], 
     /**
     @internal
     */
@@ -140,6 +132,12 @@ declare class Mapping implements Mappable {
     */
     to?: number);
     /**
+    The step maps in this mapping.
+    */
+    get maps(): readonly StepMap[];
+    private _maps;
+    private ownData;
+    /**
     Create a mapping that maps only through a part of this one.
     */
     slice(from?: number, to?: number): Mapping;
@@ -436,7 +434,7 @@ declare class Transform {
     greater than one, any number of nodes above that. By default, the
     parts split off will inherit the node type of the original node.
     This can be changed by passing an array of types and attributes to
-    use after the split.
+    use after the split (with the outermost nodes coming first).
     */
     split(pos: number, depth?: number, typesAfter?: (null | {
         type: NodeType;

package/dist/index.d.ts

@@ -101,14 +101,10 @@ A mapping represents a pipeline of zero or more [step
 maps](https://prosemirror.net/docs/ref/#transform.StepMap). It has special provisions for losslessly
 handling mapping positions through a series of steps in which some
 steps are inverted versions of earlier steps. (This comes up when
-‘[rebasing](/docs/guide/#transform.rebasing)’ steps for
+‘[rebasing](https://prosemirror.net/docs/guide/#transform.rebasing)’ steps for
 collaboration or history management.)
 */
 declare class Mapping implements Mappable {
-    /**
-    The step maps in this mapping.
-    */
-    readonly maps: StepMap[];
     /**
     The starting position in the `maps` array, used when `map` or
     `mapResult` is called.
@@ -121,11 +117,7 @@ declare class Mapping implements Mappable {
     /**
     Create a new mapping with the given position maps.
     */
-    constructor(
-    /**
-    The step maps in this mapping.
-    */
-    maps?: StepMap[], 
+    constructor(maps?: readonly StepMap[], 
     /**
     @internal
     */
@@ -140,6 +132,12 @@ declare class Mapping implements Mappable {
     */
     to?: number);
     /**
+    The step maps in this mapping.
+    */
+    get maps(): readonly StepMap[];
+    private _maps;
+    private ownData;
+    /**
     Create a mapping that maps only through a part of this one.
     */
     slice(from?: number, to?: number): Mapping;
@@ -436,7 +434,7 @@ declare class Transform {
     greater than one, any number of nodes above that. By default, the
     parts split off will inherit the node type of the original node.
     This can be changed by passing an array of types and attributes to
-    use after the split.
+    use after the split (with the outermost nodes coming first).
     */
     split(pos: number, depth?: number, typesAfter?: (null | {
         type: NodeType;

package/dist/index.js

@@ -185,18 +185,14 @@ A mapping represents a pipeline of zero or more [step
 maps](https://prosemirror.net/docs/ref/#transform.StepMap). It has special provisions for losslessly
 handling mapping positions through a series of steps in which some
 steps are inverted versions of earlier steps. (This comes up when
-‘[rebasing](/docs/guide/#transform.rebasing)’ steps for
+‘[rebasing](https://prosemirror.net/docs/guide/#transform.rebasing)’ steps for
 collaboration or history management.)
 */
 class Mapping {
     /**
     Create a new mapping with the given position maps.
     */
-    constructor(
-    /**
-    The step maps in this mapping.
-    */
-    maps = [], 
+    constructor(maps, 
     /**
     @internal
     */
@@ -209,23 +205,22 @@ class Mapping {
     /**
     The end position in the `maps` array.
     */
-    to = maps.length) {
-        this.maps = maps;
+    to = maps ? maps.length : 0) {
         this.mirror = mirror;
         this.from = from;
         this.to = to;
+        this._maps = maps || [];
+        this.ownData = !(maps || mirror);
     }
     /**
-    Create a mapping that maps only through a part of this one.
+    The step maps in this mapping.
     */
-    slice(from = 0, to = this.maps.length) {
-        return new Mapping(this.maps, this.mirror, from, to);
-    }
+    get maps() { return this._maps; }
     /**
-    @internal
+    Create a mapping that maps only through a part of this one.
     */
-    copy() {
-        return new Mapping(this.maps.slice(), this.mirror && this.mirror.slice(), this.from, this.to);
+    slice(from = 0, to = this.maps.length) {
+        return new Mapping(this._maps, this.mirror, from, to);
     }
     /**
     Add a step map to the end of this mapping. If `mirrors` is
@@ -233,18 +228,23 @@ class Mapping {
     image of this one.
     */
     appendMap(map, mirrors) {
-        this.to = this.maps.push(map);
+        if (!this.ownData) {
+            this._maps = this._maps.slice();
+            this.mirror = this.mirror && this.mirror.slice();
+            this.ownData = true;
+        }
+        this.to = this._maps.push(map);
         if (mirrors != null)
-            this.setMirror(this.maps.length - 1, mirrors);
+            this.setMirror(this._maps.length - 1, mirrors);
     }
     /**
     Add all the step maps in a given mapping to this one (preserving
     mirroring information).
     */
     appendMapping(mapping) {
-        for (let i = 0, startSize = this.maps.length; i < mapping.maps.length; i++) {
+        for (let i = 0, startSize = this._maps.length; i < mapping._maps.length; i++) {
             let mirr = mapping.getMirror(i);
-            this.appendMap(mapping.maps[i], mirr != null && mirr < i ? startSize + mirr : undefined);
+            this.appendMap(mapping._maps[i], mirr != null && mirr < i ? startSize + mirr : undefined);
         }
     }
     /**
@@ -270,9 +270,9 @@ class Mapping {
     Append the inverse of the given mapping to this one.
     */
     appendMappingInverted(mapping) {
-        for (let i = mapping.maps.length - 1, totalSize = this.maps.length + mapping.maps.length; i >= 0; i--) {
+        for (let i = mapping.maps.length - 1, totalSize = this._maps.length + mapping._maps.length; i >= 0; i--) {
             let mirr = mapping.getMirror(i);
-            this.appendMap(mapping.maps[i].invert(), mirr != null && mirr > i ? totalSize - mirr - 1 : undefined);
+            this.appendMap(mapping._maps[i].invert(), mirr != null && mirr > i ? totalSize - mirr - 1 : undefined);
         }
     }
     /**
@@ -290,7 +290,7 @@ class Mapping {
         if (this.mirror)
             return this._map(pos, assoc, true);
         for (let i = this.from; i < this.to; i++)
-            pos = this.maps[i].map(pos, assoc);
+            pos = this._maps[i].map(pos, assoc);
         return pos;
     }
     /**
@@ -304,12 +304,12 @@ class Mapping {
     _map(pos, assoc, simple) {
         let delInfo = 0;
         for (let i = this.from; i < this.to; i++) {
-            let map = this.maps[i], result = map.mapResult(pos, assoc);
+            let map = this._maps[i], result = map.mapResult(pos, assoc);
             if (result.recover != null) {
                 let corr = this.getMirror(i);
                 if (corr != null && corr > i && corr < this.to) {
                     i = corr;
-                    pos = this.maps[corr].recover(result.recover);
+                    pos = this._maps[corr].recover(result.recover);
                     continue;
                 }
             }
@@ -2111,7 +2111,7 @@ class Transform {
     greater than one, any number of nodes above that. By default, the
     parts split off will inherit the node type of the original node.
     This can be changed by passing an array of types and attributes to
-    use after the split.
+    use after the split (with the outermost nodes coming first).
     */
     split(pos, depth = 1, typesAfter) {
         split(this, pos, depth, typesAfter);

package/package.json

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

package/src/map.ts

@@ -172,41 +172,50 @@ export class StepMap implements Mappable {
 export class Mapping implements Mappable {
   /// Create a new mapping with the given position maps.
   constructor(
-    /// The step maps in this mapping.
-    readonly maps: StepMap[] = [],
+    maps?: readonly StepMap[],
     /// @internal
     public mirror?: number[],
     /// The starting position in the `maps` array, used when `map` or
     /// `mapResult` is called.
     public from = 0,
     /// The end position in the `maps` array.
-    public to = maps.length
-  ) {}
+    public to = maps ? maps.length : 0
+  ) {
+    this._maps = (maps as StepMap[]) || []
+    this.ownData = !(maps || mirror)
+  }
+
+  /// The step maps in this mapping.
+  get maps(): readonly StepMap[] { return this._maps }
+
+  private _maps: StepMap[]
+  // False if maps/mirror are shared arrays that we shouldn't mutate
+  private ownData: boolean
 
   /// Create a mapping that maps only through a part of this one.
   slice(from = 0, to = this.maps.length) {
-    return new Mapping(this.maps, this.mirror, from, to)
-  }
-
-  /// @internal
-  copy() {
-    return new Mapping(this.maps.slice(), this.mirror && this.mirror.slice(), this.from, this.to)
+    return new Mapping(this._maps, this.mirror, from, to)
   }
 
   /// Add a step map to the end of this mapping. If `mirrors` is
   /// given, it should be the index of the step map that is the mirror
   /// image of this one.
   appendMap(map: StepMap, mirrors?: number) {
-    this.to = this.maps.push(map)
-    if (mirrors != null) this.setMirror(this.maps.length - 1, mirrors)
+    if (!this.ownData) {
+      this._maps = this._maps.slice()
+      this.mirror = this.mirror && this.mirror.slice()
+      this.ownData = true
+    }
+    this.to = this._maps.push(map)
+    if (mirrors != null) this.setMirror(this._maps.length - 1, mirrors)
   }
 
   /// Add all the step maps in a given mapping to this one (preserving
   /// mirroring information).
   appendMapping(mapping: Mapping) {
-    for (let i = 0, startSize = this.maps.length; i < mapping.maps.length; i++) {
+    for (let i = 0, startSize = this._maps.length; i < mapping._maps.length; i++) {
       let mirr = mapping.getMirror(i)
-      this.appendMap(mapping.maps[i], mirr != null && mirr < i ? startSize + mirr : undefined)
+      this.appendMap(mapping._maps[i], mirr != null && mirr < i ? startSize + mirr : undefined)
     }
   }
 
@@ -226,9 +235,9 @@ export class Mapping implements Mappable {
 
   /// Append the inverse of the given mapping to this one.
   appendMappingInverted(mapping: Mapping) {
-    for (let i = mapping.maps.length - 1, totalSize = this.maps.length + mapping.maps.length; i >= 0; i--) {
+    for (let i = mapping.maps.length - 1, totalSize = this._maps.length + mapping._maps.length; i >= 0; i--) {
       let mirr = mapping.getMirror(i)
-      this.appendMap(mapping.maps[i].invert(), mirr != null && mirr > i ? totalSize - mirr - 1 : undefined)
+      this.appendMap(mapping._maps[i].invert(), mirr != null && mirr > i ? totalSize - mirr - 1 : undefined)
     }
   }
 
@@ -243,7 +252,7 @@ export class Mapping implements Mappable {
   map(pos: number, assoc = 1) {
     if (this.mirror) return this._map(pos, assoc, true) as number
     for (let i = this.from; i < this.to; i++)
-      pos = this.maps[i].map(pos, assoc)
+      pos = this._maps[i].map(pos, assoc)
     return pos
   }
 
@@ -256,12 +265,12 @@ export class Mapping implements Mappable {
     let delInfo = 0
 
     for (let i = this.from; i < this.to; i++) {
-      let map = this.maps[i], result = map.mapResult(pos, assoc)
+      let map = this._maps[i], result = map.mapResult(pos, assoc)
       if (result.recover != null) {
         let corr = this.getMirror(i)
         if (corr != null && corr > i && corr < this.to) {
           i = corr
-          pos = this.maps[corr].recover(result.recover)
+          pos = this._maps[corr].recover(result.recover)
           continue
         }
       }

package/src/transform.ts

@@ -215,7 +215,7 @@ export class Transform {
   /// greater than one, any number of nodes above that. By default, the
   /// parts split off will inherit the node type of the original node.
   /// This can be changed by passing an array of types and attributes to
-  /// use after the split.
+  /// use after the split (with the outermost nodes coming first).
   split(pos: number, depth = 1, typesAfter?: (null | {type: NodeType, attrs?: Attrs | null})[]) {
     split(this, pos, depth, typesAfter)
     return this