prosemirror-transform 1.7.5 → 1.9.0

package/dist/index.d.cts

@@ -414,9 +414,15 @@ declare class Transform {
     setNodeMarkup(pos: number, type?: NodeType | null, attrs?: Attrs | null, marks?: readonly Mark[]): this;
     /**
     Set a single attribute on a given node to a new value.
+    The `pos` addresses the document content. Use `setDocAttribute`
+    to set attributes on the document itself.
     */
     setNodeAttribute(pos: number, attr: string, value: any): this;
     /**
+    Set a single attribute on the document to a new value.
+    */
+    setDocAttribute(attr: string, value: any): this;
+    /**
     Add a mark to the node at position `pos`.
     */
     addNodeMark(pos: number, mark: Mark): this;
@@ -797,6 +803,30 @@ declare class AttrStep extends Step {
     toJSON(): any;
     static fromJSON(schema: Schema, json: any): AttrStep;
 }
+/**
+Update an attribute in the doc node.
+*/
+declare class DocAttrStep extends Step {
+    /**
+    The attribute to set.
+    */
+    readonly attr: string;
+    readonly value: any;
+    /**
+    Construct an attribute step.
+    */
+    constructor(
+    /**
+    The attribute to set.
+    */
+    attr: string, value: any);
+    apply(doc: Node): StepResult;
+    getMap(): StepMap;
+    invert(doc: Node): DocAttrStep;
+    map(mapping: Mappable): this;
+    toJSON(): any;
+    static fromJSON(schema: Schema, json: any): DocAttrStep;
+}
 
 /**
 ‘Fit’ a slice into a given position in the document, producing a
@@ -806,4 +836,4 @@ would be a no-op (an empty slice over an empty range).
 */
 declare function replaceStep(doc: Node, from: number, to?: number, slice?: Slice): Step | null;
 
-export { AddMarkStep, AddNodeMarkStep, AttrStep, MapResult, Mappable, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep, Step, StepMap, StepResult, Transform, canJoin, canSplit, dropPoint, findWrapping, insertPoint, joinPoint, liftTarget, replaceStep };
+export { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, MapResult, type Mappable, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep, Step, StepMap, StepResult, Transform, canJoin, canSplit, dropPoint, findWrapping, insertPoint, joinPoint, liftTarget, replaceStep };

package/dist/index.d.ts

@@ -414,9 +414,15 @@ declare class Transform {
     setNodeMarkup(pos: number, type?: NodeType | null, attrs?: Attrs | null, marks?: readonly Mark[]): this;
     /**
     Set a single attribute on a given node to a new value.
+    The `pos` addresses the document content. Use `setDocAttribute`
+    to set attributes on the document itself.
     */
     setNodeAttribute(pos: number, attr: string, value: any): this;
     /**
+    Set a single attribute on the document to a new value.
+    */
+    setDocAttribute(attr: string, value: any): this;
+    /**
     Add a mark to the node at position `pos`.
     */
     addNodeMark(pos: number, mark: Mark): this;
@@ -797,6 +803,30 @@ declare class AttrStep extends Step {
     toJSON(): any;
     static fromJSON(schema: Schema, json: any): AttrStep;
 }
+/**
+Update an attribute in the doc node.
+*/
+declare class DocAttrStep extends Step {
+    /**
+    The attribute to set.
+    */
+    readonly attr: string;
+    readonly value: any;
+    /**
+    Construct an attribute step.
+    */
+    constructor(
+    /**
+    The attribute to set.
+    */
+    attr: string, value: any);
+    apply(doc: Node): StepResult;
+    getMap(): StepMap;
+    invert(doc: Node): DocAttrStep;
+    map(mapping: Mappable): this;
+    toJSON(): any;
+    static fromJSON(schema: Schema, json: any): DocAttrStep;
+}
 
 /**
 ‘Fit’ a slice into a given position in the document, producing a
@@ -806,4 +836,4 @@ would be a no-op (an empty slice over an empty range).
 */
 declare function replaceStep(doc: Node, from: number, to?: number, slice?: Slice): Step | null;
 
-export { AddMarkStep, AddNodeMarkStep, AttrStep, MapResult, Mappable, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep, Step, StepMap, StepResult, Transform, canJoin, canSplit, dropPoint, findWrapping, insertPoint, joinPoint, liftTarget, replaceStep };
+export { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, MapResult, type Mappable, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep, Step, StepMap, StepResult, Transform, canJoin, canSplit, dropPoint, findWrapping, insertPoint, joinPoint, liftTarget, replaceStep };

package/dist/index.js

@@ -824,7 +824,8 @@ 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);
+        let gapFrom = this.from == this.gapFrom ? from.pos : mapping.map(this.gapFrom, -1);
+        let gapTo = this.to == this.gapTo ? to.pos : mapping.map(this.gapTo, 1);
         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);
@@ -936,7 +937,7 @@ function removeMark(tr, from, to, mark) {
     });
     matched.forEach(m => tr.step(new RemoveMarkStep(m.from, m.to, m.style)));
 }
-function clearIncompatible(tr, pos, parentType, match = parentType.contentMatch) {
+function clearIncompatible(tr, pos, parentType, match = parentType.contentMatch, clearNewlines = true) {
     let node = tr.doc.nodeAt(pos);
     let replSteps = [], cur = pos + 1;
     for (let i = 0; i < node.childCount; i++) {
@@ -950,7 +951,7 @@ function clearIncompatible(tr, pos, parentType, match = parentType.contentMatch)
             for (let j = 0; j < child.marks.length; j++)
                 if (!parentType.allowsMarkType(child.marks[j].type))
                     tr.step(new RemoveMarkStep(cur, end, child.marks[j]));
-            if (child.isText && !parentType.spec.code) {
+            if (clearNewlines && child.isText && parentType.whitespace != "pre") {
                 let m, newline = /\r?\n|\r/g, slice;
                 while (m = newline.exec(child.text)) {
                     if (!slice)
@@ -1075,15 +1076,46 @@ function setBlockType(tr, from, to, type, attrs) {
     let mapFrom = tr.steps.length;
     tr.doc.nodesBetween(from, to, (node, pos) => {
         if (node.isTextblock && !node.hasMarkup(type, attrs) && canChangeType(tr.doc, tr.mapping.slice(mapFrom).map(pos), type)) {
+            let convertNewlines = null;
+            if (type.schema.linebreakReplacement) {
+                let pre = type.whitespace == "pre", supportLinebreak = !!type.contentMatch.matchType(type.schema.linebreakReplacement);
+                if (pre && !supportLinebreak)
+                    convertNewlines = false;
+                else if (!pre && supportLinebreak)
+                    convertNewlines = true;
+            }
             // Ensure all markup that isn't allowed in the new node type is cleared
-            tr.clearIncompatible(tr.mapping.slice(mapFrom).map(pos, 1), type);
+            if (convertNewlines === false)
+                replaceLinebreaks(tr, node, pos, mapFrom);
+            clearIncompatible(tr, tr.mapping.slice(mapFrom).map(pos, 1), type, undefined, convertNewlines === null);
             let mapping = tr.mapping.slice(mapFrom);
             let startM = mapping.map(pos, 1), endM = mapping.map(pos + node.nodeSize, 1);
             tr.step(new ReplaceAroundStep(startM, endM, startM + 1, endM - 1, new Slice(Fragment.from(type.create(attrs, null, node.marks)), 0, 0), 1, true));
+            if (convertNewlines === true)
+                replaceNewlines(tr, node, pos, mapFrom);
             return false;
         }
     });
 }
+function replaceNewlines(tr, node, pos, mapFrom) {
+    node.forEach((child, offset) => {
+        if (child.isText) {
+            let m, newline = /\r?\n|\r/g;
+            while (m = newline.exec(child.text)) {
+                let start = tr.mapping.slice(mapFrom).map(pos + 1 + offset + m.index);
+                tr.replaceWith(start, start + 1, node.type.schema.linebreakReplacement.create());
+            }
+        }
+    });
+}
+function replaceLinebreaks(tr, node, pos, mapFrom) {
+    node.forEach((child, offset) => {
+        if (child.type == child.type.schema.linebreakReplacement) {
+            let start = tr.mapping.slice(mapFrom).map(pos + 1 + offset);
+            tr.replaceWith(start, start + 1, node.type.schema.text("\n"));
+        }
+    });
+}
 function canChangeType(doc, pos, type) {
     let $pos = doc.resolve(pos), index = $pos.index();
     return $pos.parent.canReplaceWith(index, index + 1, type);
@@ -1746,6 +1778,51 @@ class AttrStep extends Step {
     }
 }
 Step.jsonID("attr", AttrStep);
+/**
+Update an attribute in the doc node.
+*/
+class DocAttrStep extends Step {
+    /**
+    Construct an attribute step.
+    */
+    constructor(
+    /**
+    The attribute to set.
+    */
+    attr, 
+    // The attribute's new value.
+    value) {
+        super();
+        this.attr = attr;
+        this.value = value;
+    }
+    apply(doc) {
+        let attrs = Object.create(null);
+        for (let name in doc.attrs)
+            attrs[name] = doc.attrs[name];
+        attrs[this.attr] = this.value;
+        let updated = doc.type.create(attrs, doc.content, doc.marks);
+        return StepResult.ok(updated);
+    }
+    getMap() {
+        return StepMap.empty;
+    }
+    invert(doc) {
+        return new DocAttrStep(this.attr, doc.attrs[this.attr]);
+    }
+    map(mapping) {
+        return this;
+    }
+    toJSON() {
+        return { stepType: "docAttr", attr: this.attr, value: this.value };
+    }
+    static fromJSON(schema, json) {
+        if (typeof json.attr != "string")
+            throw new RangeError("Invalid input for DocAttrStep.fromJSON");
+        return new DocAttrStep(json.attr, json.value);
+    }
+}
+Step.jsonID("docAttr", DocAttrStep);
 
 /**
 @internal
@@ -1950,12 +2027,21 @@ class Transform {
     }
     /**
     Set a single attribute on a given node to a new value.
+    The `pos` addresses the document content. Use `setDocAttribute`
+    to set attributes on the document itself.
     */
     setNodeAttribute(pos, attr, value) {
         this.step(new AttrStep(pos, attr, value));
         return this;
     }
     /**
+    Set a single attribute on the document to a new value.
+    */
+    setDocAttribute(attr, value) {
+        this.step(new DocAttrStep(attr, value));
+        return this;
+    }
+    /**
     Add a mark to the node at position `pos`.
     */
     addNodeMark(pos, mark) {
@@ -2018,4 +2104,4 @@ class Transform {
     }
 }
 
-export { AddMarkStep, AddNodeMarkStep, AttrStep, MapResult, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep, Step, StepMap, StepResult, Transform, TransformError, canJoin, canSplit, dropPoint, findWrapping, insertPoint, joinPoint, liftTarget, replaceStep };
+export { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, MapResult, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep, Step, StepMap, StepResult, Transform, TransformError, canJoin, canSplit, dropPoint, findWrapping, insertPoint, joinPoint, liftTarget, replaceStep };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prosemirror-transform",
-  "version": "1.7.5",
+  "version": "1.9.0",
   "description": "ProseMirror document transformations",
   "type": "module",
   "main": "dist/index.cjs",
@@ -24,7 +24,7 @@
     "url": "git://github.com/prosemirror/prosemirror-transform.git"
   },
   "dependencies": {
-    "prosemirror-model": "^1.0.0"
+    "prosemirror-model": "^1.21.0"
   },
   "devDependencies": {
     "@prosemirror/buildhelper": "^0.1.5",

package/src/README.md

@@ -23,6 +23,7 @@ called a [`Transform`](#transform.Transform).
 @AddNodeMarkStep
 @RemoveNodeMarkStep
 @AttrStep
+@DocAttrStep
 
 ### Position Mapping
 

package/src/attr_step.ts

@@ -51,3 +51,48 @@ export class AttrStep extends Step {
 }
 
 Step.jsonID("attr", AttrStep)
+
+/// Update an attribute in the doc node.
+export class DocAttrStep extends Step {
+  /// Construct an attribute step.
+  constructor(
+    /// The attribute to set.
+    readonly attr: string,
+    // The attribute's new value.
+    readonly value: any
+  ) {
+    super()
+  }
+
+  apply(doc: Node) {
+    let attrs = Object.create(null)
+    for (let name in doc.attrs) attrs[name] = doc.attrs[name]
+    attrs[this.attr] = this.value
+    let updated = doc.type.create(attrs, doc.content, doc.marks)
+    return StepResult.ok(updated)
+  }
+
+  getMap() {
+    return StepMap.empty
+  }
+
+  invert(doc: Node) {
+    return new DocAttrStep(this.attr, doc.attrs[this.attr])
+  }
+
+  map(mapping: Mappable) {
+    return this
+  }
+
+  toJSON(): any {
+    return {stepType: "docAttr", attr: this.attr, value: this.value}
+  }
+
+  static fromJSON(schema: Schema, json: any) {
+    if (typeof json.attr != "string")
+      throw new RangeError("Invalid input for DocAttrStep.fromJSON")
+    return new DocAttrStep(json.attr, json.value)
+  }
+}
+
+Step.jsonID("docAttr", DocAttrStep)

package/src/index.ts

@@ -6,6 +6,6 @@ export {joinPoint, canJoin, canSplit, insertPoint, dropPoint, liftTarget, findWr
 export {StepMap, MapResult, Mapping, Mappable} from "./map"
 export {AddMarkStep, RemoveMarkStep, AddNodeMarkStep, RemoveNodeMarkStep} from "./mark_step"
 export {ReplaceStep, ReplaceAroundStep} from "./replace_step"
-export {AttrStep} from "./attr_step"
+export {AttrStep, DocAttrStep} from "./attr_step"
 import "./mark"
 export {replaceStep} from "./replace"

package/src/mark.ts

@@ -72,7 +72,9 @@ export function removeMark(tr: Transform, from: number, to: number, mark?: Mark
   matched.forEach(m => tr.step(new RemoveMarkStep(m.from, m.to, m.style)))
 }
 
-export function clearIncompatible(tr: Transform, pos: number, parentType: NodeType, match = parentType.contentMatch) {
+export function clearIncompatible(tr: Transform, pos: number, parentType: NodeType,
+                                  match = parentType.contentMatch,
+                                  clearNewlines = true) {
   let node = tr.doc.nodeAt(pos)!
   let replSteps: Step[] = [], cur = pos + 1
   for (let i = 0; i < node.childCount; i++) {
@@ -85,7 +87,7 @@ export function clearIncompatible(tr: Transform, pos: number, parentType: NodeTy
       for (let j = 0; j < child.marks.length; j++) if (!parentType.allowsMarkType(child.marks[j].type))
         tr.step(new RemoveMarkStep(cur, end, child.marks[j]))
 
-      if (child.isText && !parentType.spec.code) {
+      if (clearNewlines && child.isText && parentType.whitespace != "pre") {
         let m, newline = /\r?\n|\r/g, slice
         while (m = newline.exec(child.text!)) {
           if (!slice) slice = new Slice(Fragment.from(parentType.schema.text(" ", parentType.allowedMarks(child.marks))),

package/src/replace_step.ts

@@ -134,7 +134,8 @@ 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)
+    let gapFrom = this.from == this.gapFrom ? from.pos : mapping.map(this.gapFrom, -1)
+    let gapTo = this.to == this.gapTo ? to.pos : mapping.map(this.gapTo, 1)
     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/src/structure.ts

@@ -2,6 +2,7 @@ import {Slice, Fragment, NodeRange, NodeType, Node, Mark, Attrs, ContentMatch} f
 
 import {Transform} from "./transform"
 import {ReplaceStep, ReplaceAroundStep} from "./replace_step"
+import {clearIncompatible} from "./mark"
 
 function canCut(node: Node, start: number, end: number) {
   return (start == 0 || node.canReplace(start, node.childCount)) &&
@@ -116,17 +117,46 @@ export function setBlockType(tr: Transform, from: number, to: number, type: Node
   let mapFrom = tr.steps.length
   tr.doc.nodesBetween(from, to, (node, pos) => {
     if (node.isTextblock && !node.hasMarkup(type, attrs) && canChangeType(tr.doc, tr.mapping.slice(mapFrom).map(pos), type)) {
+      let convertNewlines = null
+      if (type.schema.linebreakReplacement) {
+        let pre = type.whitespace == "pre", supportLinebreak = !!type.contentMatch.matchType(type.schema.linebreakReplacement)
+        if (pre && !supportLinebreak) convertNewlines = false
+        else if (!pre && supportLinebreak) convertNewlines = true
+      }
       // Ensure all markup that isn't allowed in the new node type is cleared
-      tr.clearIncompatible(tr.mapping.slice(mapFrom).map(pos, 1), type)
+      if (convertNewlines === false) replaceLinebreaks(tr, node, pos, mapFrom)
+      clearIncompatible(tr, tr.mapping.slice(mapFrom).map(pos, 1), type, undefined, convertNewlines === null)
       let mapping = tr.mapping.slice(mapFrom)
       let startM = mapping.map(pos, 1), endM = mapping.map(pos + node.nodeSize, 1)
       tr.step(new ReplaceAroundStep(startM, endM, startM + 1, endM - 1,
                                       new Slice(Fragment.from(type.create(attrs, null, node.marks)), 0, 0), 1, true))
+      if (convertNewlines === true) replaceNewlines(tr, node, pos, mapFrom)
       return false
     }
   })
 }
 
+function replaceNewlines(tr: Transform, node: Node, pos: number, mapFrom: number) {
+  node.forEach((child, offset) => {
+    if (child.isText) {
+      let m, newline = /\r?\n|\r/g
+      while (m = newline.exec(child.text!)) {
+        let start = tr.mapping.slice(mapFrom).map(pos + 1 + offset + m.index)
+        tr.replaceWith(start, start + 1, node.type.schema.linebreakReplacement!.create())
+      }
+    }
+  })
+}
+
+function replaceLinebreaks(tr: Transform, node: Node, pos: number, mapFrom: number) {
+  node.forEach((child, offset) => {
+    if (child.type == child.type.schema.linebreakReplacement) {
+      let start = tr.mapping.slice(mapFrom).map(pos + 1 + offset)
+      tr.replaceWith(start, start + 1, node.type.schema.text("\n"))
+    }
+  })
+}
+
 function canChangeType(doc: Node, pos: number, type: NodeType) {
   let $pos = doc.resolve(pos), index = $pos.index()
   return $pos.parent.canReplaceWith(index, index + 1, type)

package/src/transform.ts

@@ -5,7 +5,7 @@ import {Step} from "./step"
 import {addMark, removeMark, clearIncompatible} from "./mark"
 import {replaceStep, replaceRange, replaceRangeWith, deleteRange} from "./replace"
 import {lift, wrap, setBlockType, setNodeMarkup, split, join} from "./structure"
-import {AttrStep} from "./attr_step"
+import {AttrStep, DocAttrStep} from "./attr_step"
 import {AddNodeMarkStep, RemoveNodeMarkStep} from "./mark_step"
 
 /// @internal
@@ -179,11 +179,19 @@ export class Transform {
   }
 
   /// Set a single attribute on a given node to a new value.
+  /// The `pos` addresses the document content. Use `setDocAttribute`
+  /// to set attributes on the document itself.
   setNodeAttribute(pos: number, attr: string, value: any): this {
     this.step(new AttrStep(pos, attr, value))
     return this
   }
 
+  /// Set a single attribute on the document to a new value.
+  setDocAttribute(attr: string, value: any): this {
+    this.step(new DocAttrStep(attr, value))
+    return this
+  }
+
   /// Add a mark to the node at position `pos`.
   addNodeMark(pos: number, mark: Mark): this {
     this.step(new AddNodeMarkStep(pos, mark))