@codemirror/state 6.0.1 → 6.1.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 6.1.0 (2022-06-30)
+
+### Bug fixes
+
+Refine change mapping to preserve insertions made by concurrent changes.
+
+### New features
+
+The `enables` option to `Facet.define` may now take a function, which will be called with the facet value to create the extensions.
+
 ## 6.0.1 (2022-06-17)
 
 ### Bug fixes

package/dist/index.cjs

@@ -1130,51 +1130,65 @@ function iterChanges(desc, f, individual) {
     }
 }
 function mapSet(setA, setB, before, mkSet = false) {
+    // Produce a copy of setA that applies to the document after setB
+    // has been applied (assuming both start at the same document).
     let sections = [], insert = mkSet ? [] : null;
     let a = new SectionIter(setA), b = new SectionIter(setB);
-    for (let posA = 0, posB = 0;;) {
-        if (a.ins == -1) {
-            posA += a.len;
-            a.next();
-        }
-        else if (b.ins == -1 && posB < posA) {
-            let skip = Math.min(b.len, posA - posB);
-            b.forward(skip);
-            addSection(sections, skip, -1);
-            posB += skip;
+    // Iterate over both sets in parallel. inserted tracks, for changes
+    // in A that have to be processed piece-by-piece, whether their
+    // content has been inserted already, and refers to the section
+    // index.
+    for (let inserted = -1;;) {
+        if (a.ins == -1 && b.ins == -1) {
+            // Move across ranges skipped by both sets.
+            let len = Math.min(a.len, b.len);
+            addSection(sections, len, -1);
+            a.forward(len);
+            b.forward(len);
         }
-        else if (b.ins >= 0 && (a.done || posB < posA || posB == posA && (b.len < a.len || b.len == a.len && !before))) {
+        else if (b.ins >= 0 && (a.ins < 0 || inserted == a.i || a.off == 0 && (b.len < a.len || b.len == a.len && !before))) {
+            // If there's a change in B that comes before the next change in
+            // A (ordered by start pos, then len, then before flag), skip
+            // that (and process any changes in A it covers).
+            let len = b.len;
             addSection(sections, b.ins, -1);
-            while (posA > posB && !a.done && posA + a.len < posB + b.len) {
-                posA += a.len;
-                a.next();
+            while (len) {
+                let piece = Math.min(a.len, len);
+                if (a.ins >= 0 && inserted < a.i && a.len <= piece) {
+                    addSection(sections, 0, a.ins);
+                    if (insert)
+                        addInsert(insert, sections, a.text);
+                    inserted = a.i;
+                }
+                a.forward(piece);
+                len -= piece;
             }
-            posB += b.len;
             b.next();
         }
         else if (a.ins >= 0) {
-            let len = 0, end = posA + a.len;
-            for (;;) {
-                if (b.ins >= 0 && posB > posA && posB + b.len < end) {
-                    len += b.ins;
-                    posB += b.len;
-                    b.next();
+            // Process the part of a change in A up to the start of the next
+            // non-deletion change in B (if overlapping).
+            let len = 0, left = a.len;
+            while (left) {
+                if (b.ins == -1) {
+                    let piece = Math.min(left, b.len);
+                    len += piece;
+                    left -= piece;
+                    b.forward(piece);
                 }
-                else if (b.ins == -1 && posB < end) {
-                    let skip = Math.min(b.len, end - posB);
-                    len += skip;
-                    b.forward(skip);
-                    posB += skip;
+                else if (b.ins == 0 && b.len < left) {
+                    left -= b.len;
+                    b.next();
                 }
                 else {
                     break;
                 }
             }
-            addSection(sections, len, a.ins);
-            if (insert)
+            addSection(sections, len, inserted < a.i ? a.ins : 0);
+            if (insert && inserted < a.i)
                 addInsert(insert, sections, a.text);
-            posA = end;
-            a.next();
+            inserted = a.i;
+            a.forward(a.len - left);
         }
         else if (a.done && b.done) {
             return insert ? ChangeSet.createSet(sections, insert) : ChangeDesc.create(sections);
@@ -1556,21 +1570,17 @@ class Facet {
     /**
     @internal
     */
-    compare, isStatic, 
-    /**
-    @internal
-    */
-    extensions) {
+    compare, isStatic, enables) {
         this.combine = combine;
         this.compareInput = compareInput;
         this.compare = compare;
         this.isStatic = isStatic;
-        this.extensions = extensions;
         /**
         @internal
         */
         this.id = nextID++;
         this.default = combine([]);
+        this.extensions = typeof enables == "function" ? enables(this) : enables;
     }
     /**
     Define a new facet.
@@ -2712,7 +2722,7 @@ class EditorState {
         if (fields)
             for (let prop in fields) {
                 let value = fields[prop];
-                if (value instanceof StateField)
+                if (value instanceof StateField && this.config.address[value.id] != null)
                     result[prop] = value.spec.toJSON(this.field(fields[prop]), this);
             }
         return result;
@@ -2729,8 +2739,10 @@ class EditorState {
         let fieldInit = [];
         if (fields)
             for (let prop in fields) {
-                let field = fields[prop], value = json[prop];
-                fieldInit.push(field.init(state => field.spec.fromJSON(value, state)));
+                if (Object.prototype.hasOwnProperty.call(json, prop)) {
+                    let field = fields[prop], value = json[prop];
+                    fieldInit.push(field.init(state => field.spec.fromJSON(value, state)));
+                }
             }
         return EditorState.create({
             doc: json.doc,

package/dist/index.d.ts

@@ -505,13 +505,14 @@ declare type FacetConfig<Input, Output> = {
     */
     static?: boolean;
     /**
-    If given, these extension(s) will be added to any state where
-    this facet is provided. (Note that, while a facet's default
-    value can be read from a state even if the facet wasn't present
-    in the state at all, these extensions won't be added in that
+    If given, these extension(s) (or the result of calling the given
+    function with the facet) will be added to any state where this
+    facet is provided. (Note that, while a facet's default value can
+    be read from a state even if the facet wasn't present in the
+    state at all, these extensions won't be added in that
     situation.)
     */
-    enables?: Extension;
+    enables?: Extension | ((self: Facet<Input, Output>) => Extension);
 };
 /**
 A facet is a labeled value that is associated with an editor

package/dist/index.js

@@ -1125,51 +1125,65 @@ function iterChanges(desc, f, individual) {
     }
 }
 function mapSet(setA, setB, before, mkSet = false) {
+    // Produce a copy of setA that applies to the document after setB
+    // has been applied (assuming both start at the same document).
     let sections = [], insert = mkSet ? [] : null;
     let a = new SectionIter(setA), b = new SectionIter(setB);
-    for (let posA = 0, posB = 0;;) {
-        if (a.ins == -1) {
-            posA += a.len;
-            a.next();
-        }
-        else if (b.ins == -1 && posB < posA) {
-            let skip = Math.min(b.len, posA - posB);
-            b.forward(skip);
-            addSection(sections, skip, -1);
-            posB += skip;
+    // Iterate over both sets in parallel. inserted tracks, for changes
+    // in A that have to be processed piece-by-piece, whether their
+    // content has been inserted already, and refers to the section
+    // index.
+    for (let inserted = -1;;) {
+        if (a.ins == -1 && b.ins == -1) {
+            // Move across ranges skipped by both sets.
+            let len = Math.min(a.len, b.len);
+            addSection(sections, len, -1);
+            a.forward(len);
+            b.forward(len);
         }
-        else if (b.ins >= 0 && (a.done || posB < posA || posB == posA && (b.len < a.len || b.len == a.len && !before))) {
+        else if (b.ins >= 0 && (a.ins < 0 || inserted == a.i || a.off == 0 && (b.len < a.len || b.len == a.len && !before))) {
+            // If there's a change in B that comes before the next change in
+            // A (ordered by start pos, then len, then before flag), skip
+            // that (and process any changes in A it covers).
+            let len = b.len;
             addSection(sections, b.ins, -1);
-            while (posA > posB && !a.done && posA + a.len < posB + b.len) {
-                posA += a.len;
-                a.next();
+            while (len) {
+                let piece = Math.min(a.len, len);
+                if (a.ins >= 0 && inserted < a.i && a.len <= piece) {
+                    addSection(sections, 0, a.ins);
+                    if (insert)
+                        addInsert(insert, sections, a.text);
+                    inserted = a.i;
+                }
+                a.forward(piece);
+                len -= piece;
             }
-            posB += b.len;
             b.next();
         }
         else if (a.ins >= 0) {
-            let len = 0, end = posA + a.len;
-            for (;;) {
-                if (b.ins >= 0 && posB > posA && posB + b.len < end) {
-                    len += b.ins;
-                    posB += b.len;
-                    b.next();
+            // Process the part of a change in A up to the start of the next
+            // non-deletion change in B (if overlapping).
+            let len = 0, left = a.len;
+            while (left) {
+                if (b.ins == -1) {
+                    let piece = Math.min(left, b.len);
+                    len += piece;
+                    left -= piece;
+                    b.forward(piece);
                 }
-                else if (b.ins == -1 && posB < end) {
-                    let skip = Math.min(b.len, end - posB);
-                    len += skip;
-                    b.forward(skip);
-                    posB += skip;
+                else if (b.ins == 0 && b.len < left) {
+                    left -= b.len;
+                    b.next();
                 }
                 else {
                     break;
                 }
             }
-            addSection(sections, len, a.ins);
-            if (insert)
+            addSection(sections, len, inserted < a.i ? a.ins : 0);
+            if (insert && inserted < a.i)
                 addInsert(insert, sections, a.text);
-            posA = end;
-            a.next();
+            inserted = a.i;
+            a.forward(a.len - left);
         }
         else if (a.done && b.done) {
             return insert ? ChangeSet.createSet(sections, insert) : ChangeDesc.create(sections);
@@ -1551,21 +1565,17 @@ class Facet {
     /**
     @internal
     */
-    compare, isStatic, 
-    /**
-    @internal
-    */
-    extensions) {
+    compare, isStatic, enables) {
         this.combine = combine;
         this.compareInput = compareInput;
         this.compare = compare;
         this.isStatic = isStatic;
-        this.extensions = extensions;
         /**
         @internal
         */
         this.id = nextID++;
         this.default = combine([]);
+        this.extensions = typeof enables == "function" ? enables(this) : enables;
     }
     /**
     Define a new facet.
@@ -2706,7 +2716,7 @@ class EditorState {
         if (fields)
             for (let prop in fields) {
                 let value = fields[prop];
-                if (value instanceof StateField)
+                if (value instanceof StateField && this.config.address[value.id] != null)
                     result[prop] = value.spec.toJSON(this.field(fields[prop]), this);
             }
         return result;
@@ -2723,8 +2733,10 @@ class EditorState {
         let fieldInit = [];
         if (fields)
             for (let prop in fields) {
-                let field = fields[prop], value = json[prop];
-                fieldInit.push(field.init(state => field.spec.fromJSON(value, state)));
+                if (Object.prototype.hasOwnProperty.call(json, prop)) {
+                    let field = fields[prop], value = json[prop];
+                    fieldInit.push(field.init(state => field.spec.fromJSON(value, state)));
+                }
             }
         return EditorState.create({
             doc: json.doc,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/state",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "description": "Editor state data structures for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",