@ckeditor/ckeditor5-engine 46.0.2 → 46.1.0-alpha.0

package/src/view/observer/selectionobserver.js

@@ -262,7 +262,15 @@ export class SelectionObserver extends Observer {
             this._reportInfiniteLoop();
             return;
         }
-        if (this.selection.isSimilar(newViewSelection)) {
+        if (!isSelectionWithinRootElements(newViewSelection)) {
+            // Occasionally, such as when removing markers during a focus change, the selection may end up inside a view element
+            // whose parent has already been detached from the DOM. In most cases this is harmless, but if the selectionchange
+            // event fires before the view is fully synchronized with the DOM converter, some elements in the selection may become orphans.
+            // This can result in the view being out of sync with the actual DOM structure.
+            // See: https://github.com/ckeditor/ckeditor5/issues/18744
+            this.view.forceRender();
+        }
+        else if (this.selection.isSimilar(newViewSelection)) {
             // If selection was equal and we are at this point of algorithm, it means that it was incorrect.
             // Just re-render it, no need to fire any events, etc.
             this.view.forceRender();
@@ -295,3 +303,16 @@ export class SelectionObserver extends Observer {
         this._loopbackCounter = 0;
     }
 }
+/**
+ * Checks if all roots of the selection's range boundaries are root elements.
+ * Returns true if the selection is fully contained within root elements (not orphaned).
+ *
+ * @param selection The view selection to check.
+ * @returns True if all range boundaries are within root elements, false otherwise.
+ */
+function isSelectionWithinRootElements(selection) {
+    return Array
+        .from(selection.getRanges())
+        .flatMap(range => [range.start.root, range.end.root])
+        .every(root => root && root.is('rootElement'));
+}

package/src/view/position.d.ts

@@ -145,6 +145,12 @@ export declare class ViewPosition extends ViewTypeCheckable {
      * Clones this position.
      */
     clone(): ViewPosition;
+    /**
+     * Converts `ViewPosition` instance to plain object and returns it.
+     *
+     * @returns `ViewPosition` instance converted to plain object.
+     */
+    toJSON(): unknown;
     /**
      * Creates position at the given location. The location can be specified as:
      *

package/src/view/position.js

@@ -235,6 +235,17 @@ export class ViewPosition extends ViewTypeCheckable {
     clone() {
         return new ViewPosition(this.parent, this.offset);
     }
+    /**
+     * Converts `ViewPosition` instance to plain object and returns it.
+     *
+     * @returns `ViewPosition` instance converted to plain object.
+     */
+    toJSON() {
+        return {
+            parent: this.parent.toJSON(),
+            offset: this.offset
+        };
+    }
     /**
      * Creates position at the given location. The location can be specified as:
      *

package/src/view/range.d.ts

@@ -244,6 +244,12 @@ export declare class ViewRange extends ViewTypeCheckable implements Iterable<Vie
      * @returns True if ranges intersect.
      */
     isIntersecting(otherRange: ViewRange): boolean;
+    /**
+     * Converts `ViewRange` instance to plain object and returns it.
+     *
+     * @returns `ViewRange` instance converted to plain object.
+     */
+    toJSON(): unknown;
     /**
      * Creates a range from the given parents and offsets.
      *

package/src/view/range.js

@@ -378,6 +378,17 @@ export class ViewRange extends ViewTypeCheckable {
     isIntersecting(otherRange) {
         return this.start.isBefore(otherRange.end) && this.end.isAfter(otherRange.start);
     }
+    /**
+     * Converts `ViewRange` instance to plain object and returns it.
+     *
+     * @returns `ViewRange` instance converted to plain object.
+     */
+    toJSON() {
+        return {
+            start: this.start.toJSON(),
+            end: this.end.toJSON()
+        };
+    }
     /**
      * Creates a range from the given parents and offsets.
      *

package/src/view/rawelement.d.ts

@@ -42,6 +42,12 @@ export declare class ViewRawElement extends ViewElement {
      * @param children A list of nodes to be inserted into created element.
      */
     constructor(document: ViewDocument, name: string, attrs?: ViewElementAttributes, children?: ViewNode | Iterable<ViewNode>);
+    /**
+     * Converts `ViewRawElement` instance to plain object and returns it.
+     *
+     * @returns `ViewRawElement` instance converted to plain object.
+     */
+    toJSON(): unknown;
     /**
      * Overrides the {@link module:engine/view/element~ViewElement#_insertChild} method.
      * Throws the `view-rawelement-cannot-add` {@link module:utils/ckeditorerror~CKEditorError CKEditorError} to prevent

package/src/view/rawelement.js

@@ -44,6 +44,16 @@ export class ViewRawElement extends ViewElement {
         // Returns `null` because filler is not needed for raw elements.
         this.getFillerOffset = getFillerOffset;
     }
+    /**
+     * Converts `ViewRawElement` instance to plain object and returns it.
+     *
+     * @returns `ViewRawElement` instance converted to plain object.
+     */
+    toJSON() {
+        const json = super.toJSON();
+        json.type = 'RawElement';
+        return json;
+    }
     /**
      * Overrides the {@link module:engine/view/element~ViewElement#_insertChild} method.
      * Throws the `view-rawelement-cannot-add` {@link module:utils/ckeditorerror~CKEditorError CKEditorError} to prevent

package/src/view/rooteditableelement.d.ts

@@ -29,6 +29,12 @@ export declare class ViewRootEditableElement extends ViewEditableElement {
      */
     get rootName(): string;
     set rootName(rootName: string);
+    /**
+     * Converts `ViewRootEditableElement` instance to string and returns it.
+     *
+     * @returns `ViewRootEditableElement` instance converted to string.
+     */
+    toJSON(): unknown;
     /**
      * Overrides old element name and sets new one.
      * This is needed because view roots are created before they are attached to the DOM.

package/src/view/rooteditableelement.js

@@ -36,6 +36,14 @@ export class ViewRootEditableElement extends ViewEditableElement {
     set rootName(rootName) {
         this._setCustomProperty(rootNameSymbol, rootName);
     }
+    /**
+     * Converts `ViewRootEditableElement` instance to string and returns it.
+     *
+     * @returns `ViewRootEditableElement` instance converted to string.
+     */
+    toJSON() {
+        return this.rootName;
+    }
     /**
      * Overrides old element name and sets new one.
      * This is needed because view roots are created before they are attached to the DOM.

package/src/view/selection.d.ts

@@ -298,6 +298,12 @@ export declare class ViewSelection extends /* #__PURE__ */ ViewSelection_base {
      * @param offset Offset or one of the flags. Used only when first parameter is a {@link module:engine/view/item~ViewItem view item}.
      */
     setFocus(itemOrPosition: ViewItem | ViewPosition, offset?: ViewPositionOffset): void;
+    /**
+     * Converts `ViewSelection` instance to plain object and returns it.
+     *
+     * @returns `ViewSelection` instance converted to plain object.
+     */
+    toJSON(): unknown;
     /**
      * Replaces all ranges that were added to the selection with given array of ranges. Last range of the array
      * is treated like the last added range and is used to set {@link #anchor anchor} and {@link #focus focus}.

package/src/view/selection.js

@@ -493,6 +493,23 @@ export class ViewSelection extends /* #__PURE__ */ EmitterMixin(ViewTypeCheckabl
         }
         this.fire('change');
     }
+    /**
+     * Converts `ViewSelection` instance to plain object and returns it.
+     *
+     * @returns `ViewSelection` instance converted to plain object.
+     */
+    toJSON() {
+        const json = {
+            ranges: Array.from(this.getRanges()).map(range => range.toJSON())
+        };
+        if (this.isBackward) {
+            json.isBackward = true;
+        }
+        if (this.isFake) {
+            json.isFake = true;
+        }
+        return json;
+    }
     /**
      * Replaces all ranges that were added to the selection with given array of ranges. Last range of the array
      * is treated like the last added range and is used to set {@link #anchor anchor} and {@link #focus focus}.

package/src/view/text.d.ts

@@ -64,6 +64,12 @@ export declare class ViewText extends ViewNode {
      * @param otherNode Node to check if it is same as this node.
      */
     isSimilar(otherNode: ViewNode): boolean;
+    /**
+     * Converts `ViewText` instance to plain object and returns it.
+     *
+     * @returns `ViewText` instance converted to plain object.
+     */
+    toJSON(): unknown;
     /**
      * Clones this node.
      *

package/src/view/text.js

@@ -78,6 +78,17 @@ export class ViewText extends ViewNode {
         }
         return this === otherNode || this.data === otherNode.data;
     }
+    /**
+     * Converts `ViewText` instance to plain object and returns it.
+     *
+     * @returns `ViewText` instance converted to plain object.
+     */
+    toJSON() {
+        const json = super.toJSON();
+        json.type = 'Text';
+        json.data = this.data;
+        return json;
+    }
     /**
      * Clones this node.
      *

package/src/view/uielement.d.ts

@@ -82,6 +82,12 @@ export declare class ViewUIElement extends ViewElement {
      * Note that each time this method is called new DOM element is created.
      */
     toDomElement(domDocument: DomDocument): DomElement;
+    /**
+     * Converts `ViewUIElement` instance to plain object and returns it.
+     *
+     * @returns `ViewUIElement` instance converted to plain object.
+     */
+    toJSON(): unknown;
 }
 /**
  * This function injects UI element handling to the given {@link module:engine/view/document~ViewDocument document}.

package/src/view/uielement.js

@@ -100,6 +100,16 @@ export class ViewUIElement extends ViewElement {
         }
         return domElement;
     }
+    /**
+     * Converts `ViewUIElement` instance to plain object and returns it.
+     *
+     * @returns `ViewUIElement` instance converted to plain object.
+     */
+    toJSON() {
+        const json = super.toJSON();
+        json.type = 'UIElement';
+        return json;
+    }
 }
 // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
 // Proper overload would interfere with that.