prosemirror-transform 1.7.5 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.8.0 (2023-10-01)
+
+### New features
+
+The new `DocAttrStep` can be used to set attributes on the document's top node.
+
+`Transform.setDocAttribute` can be used to create a `DocAttrStep` in a transform.
+
 ## 1.7.5 (2023-08-22)
 
 ### Bug fixes

package/dist/index.cjs

@@ -1823,15 +1823,81 @@ var AttrStep = function (_Step7) {
 
 Step.jsonID("attr", AttrStep);
 
+var DocAttrStep = function (_Step8) {
+  _inherits(DocAttrStep, _Step8);
+
+  var _super8 = _createSuper(DocAttrStep);
+
+  function DocAttrStep(attr, value) {
+    var _this10;
+
+    _classCallCheck(this, DocAttrStep);
+
+    _this10 = _super8.call(this);
+    _this10.attr = attr;
+    _this10.value = value;
+    return _this10;
+  }
+
+  _createClass(DocAttrStep, [{
+    key: "apply",
+    value: function apply(doc) {
+      var attrs = Object.create(null);
+
+      for (var name in doc.attrs) {
+        attrs[name] = doc.attrs[name];
+      }
+
+      attrs[this.attr] = this.value;
+      var updated = doc.type.create(attrs, doc.content, doc.marks);
+      return StepResult.ok(updated);
+    }
+  }, {
+    key: "getMap",
+    value: function getMap() {
+      return StepMap.empty;
+    }
+  }, {
+    key: "invert",
+    value: function invert(doc) {
+      return new DocAttrStep(this.attr, doc.attrs[this.attr]);
+    }
+  }, {
+    key: "map",
+    value: function map(mapping) {
+      return this;
+    }
+  }, {
+    key: "toJSON",
+    value: function toJSON() {
+      return {
+        stepType: "docAttr",
+        attr: this.attr,
+        value: this.value
+      };
+    }
+  }], [{
+    key: "fromJSON",
+    value: function fromJSON(schema, json) {
+      if (typeof json.attr != "string") throw new RangeError("Invalid input for DocAttrStep.fromJSON");
+      return new DocAttrStep(json.attr, json.value);
+    }
+  }]);
+
+  return DocAttrStep;
+}(Step);
+
+Step.jsonID("docAttr", DocAttrStep);
+
 exports.TransformError = function (_Error) {
   _inherits(TransformError, _Error);
 
-  var _super8 = _createSuper(TransformError);
+  var _super9 = _createSuper(TransformError);
 
   function TransformError() {
     _classCallCheck(this, TransformError);
 
-    return _super8.apply(this, arguments);
+    return _super9.apply(this, arguments);
   }
 
   return _createClass(TransformError);
@@ -1984,6 +2050,12 @@ var Transform = function () {
       this.step(new AttrStep(pos, attr, value));
       return this;
     }
+  }, {
+    key: "setDocAttribute",
+    value: function setDocAttribute(attr, value) {
+      this.step(new DocAttrStep(attr, value));
+      return this;
+    }
   }, {
     key: "addNodeMark",
     value: function addNodeMark(pos, mark) {
@@ -2042,6 +2114,7 @@ var Transform = function () {
 exports.AddMarkStep = AddMarkStep;
 exports.AddNodeMarkStep = AddNodeMarkStep;
 exports.AttrStep = AttrStep;
+exports.DocAttrStep = DocAttrStep;
 exports.MapResult = MapResult;
 exports.Mapping = Mapping;
 exports.RemoveMarkStep = RemoveMarkStep;

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, 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, Mappable, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep, Step, StepMap, StepResult, Transform, canJoin, canSplit, dropPoint, findWrapping, insertPoint, joinPoint, liftTarget, replaceStep };

package/dist/index.js

@@ -1746,6 +1746,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 +1995,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 +2072,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.8.0",
   "description": "ProseMirror document transformations",
   "type": "module",
   "main": "dist/index.cjs",

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/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))