prosemirror-changeset 2.1.1 → 2.2.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 2.2.0 (2022-05-30)
+
+### New features
+
+Include TypeScript type declarations.
+
+## 2.1.2 (2019-11-20)
+
+### Bug fixes
+
+Rename ES module files to use a .js extension, since Webpack gets confused by .mjs
+
 ## 2.1.1 (2019-11-19)
 
 ### Bug fixes

package/README.md

@@ -19,13 +19,12 @@ It is possible to associate arbitrary data values with such spans, for
 example to track the user that made the change, the timestamp at which
 it was made, or the step data necessary to invert it again.
 
-### class Change
+### class Change`<Data = any>`
 
 A replaced range with metadata associated with it.
 
  * **`fromA`**`: number`\
-   The start of the range deleted/replaced in the old
-   document.
+   The start of the range deleted/replaced in the old document.
 
  * **`toA`**`: number`\
    The end of the range in the old document.
@@ -36,35 +35,42 @@ A replaced range with metadata associated with it.
  * **`toB`**`: number`\
    The end of the range in the new document.
 
- * **`deleted`**`: [Span]`\
-   Data associated with the deleted content. The length
-   of these spans adds up to `this.toA - this.fromA`.
+ * **`deleted`**`: readonly Span[]`\
+   Data associated with the deleted content. The length of these
+   spans adds up to `this.toA - this.fromA`.
 
- * **`inserted`**`: [Span]`\
-   Data associated with the inserted content. Length
-   adds up to `this.toB - this.toA`.
+ * **`inserted`**`: readonly Span[]`\
+   Data associated with the inserted content. Length adds up to
+   `this.toB - this.toA`.
 
+ * `static `**`merge`**`<Data>(x: readonly Change[], y: readonly Change[], combine: fn(dataA: Data, dataB: Data) → Data) → readonly Change[]`\
+   This merges two changesets (the end document of x should be the
+   start document of y) into a single one spanning the start of x to
+   the end of y.
 
-### class Span
+
+### class Span`<Data = any>`
 
 Stores metadata for a part of a change.
 
- * **`length`**`: number`
+ * **`length`**`: number`\
+   The length of this span.
 
- * **`data`**`: any`
+ * **`data`**`: Data`\
+   The data associated with this span.
 
 
-### class ChangeSet
+### class ChangeSet`<Data = any>`
 
-A change set tracks the changes to a document from a given
-point in the past. It condenses a number of step maps down to a
-flat sequence of replacements, and simplifies replacments that
+A change set tracks the changes to a document from a given point
+in the past. It condenses a number of step maps down to a flat
+sequence of replacements, and simplifies replacments that
 partially undo themselves by comparing their content.
 
- * **`changes`**`: [Change]`\
+ * **`changes`**`: readonly Change[]`\
    Replaced regions.
 
- * **`addSteps`**`(newDoc: Node, maps: [StepMap], data: [any] | any) → ChangeSet`\
+ * **`addSteps`**`(newDoc: Node, maps: readonly StepMap[], data: Data | readonly Data[]) → ChangeSet`\
    Computes a new changeset by adding the given step maps and
    metadata (either as an array, per-map, or as a single value to be
    associated with all maps) to the current set. Will not mutate the
@@ -79,25 +85,25 @@ partially undo themselves by comparing their content.
  * **`startDoc`**`: Node`\
    The starting document of the change set.
 
- * **`map`**`(f: fn(range: Change) → any) → ChangeSet`\
+ * **`map`**`(f: fn(range: Span) → Data) → ChangeSet`\
    Map the span's data values in the given set through a function
    and construct a new set with the resulting data.
 
- * **`changedRange`**`(b: ChangeSet, maps: ?[StepMap]) → ?{from: number, to: number}`\
+ * **`changedRange`**`(b: ChangeSet, maps?: readonly StepMap[]) → {from: number, to: number}`\
    Compare two changesets and return the range in which they are
    changed, if any. If the document changed between the maps, pass
    the maps for the steps that changed it as second argument, and
    make sure the method is called on the old set and passed the new
    set. The returned positions will be in new document coordinates.
 
- * `static `**`create`**`(doc: Node, combine: ?fn(a: any, b: any) → any) → ChangeSet`\
+ * `static `**`create`**`<Data = any>(doc: Node, combine?: fn(dataA: Data, dataB: Data) → Data = (a, b) => a === b ? a : null as any) → ChangeSet`\
    Create a changeset with the given base object and configuration.
    The `combine` function is used to compare and combine metadata—it
    should return null when metadata isn't compatible, and a combined
    version for a merged range when it is.
 
 
- * **`simplifyChanges`**`(changes: [Change], doc: Node) → [Change]`\
+ * **`simplifyChanges`**`(changes: readonly Change[], doc: Node) → Change[]`\
    Simplifies a set of changes for presentation. This makes the
    assumption that having both insertions and deletions within a word
    is confusing, and, when such changes occur without a word boundary