@ckeditor/ckeditor5-engine 44.3.0-alpha.7 → 45.0.0-alpha.0

package/src/model/node.js

@@ -37,6 +37,28 @@ import { compareArrays, toMap } from '@ckeditor/ckeditor5-utils';
  * follows same rules.
  */
 export default class Node extends TypeCheckable {
+    /**
+     * Parent of this node. It could be {@link module:engine/model/element~Element}
+     * or {@link module:engine/model/documentfragment~DocumentFragment}.
+     * Equals to `null` if the node has no parent.
+     */
+    parent = null;
+    /**
+     * Attributes set on this node.
+     */
+    _attrs;
+    /**
+     * Index of this node in its parent or `null` if the node has no parent.
+     *
+     * @internal
+     */
+    _index = null;
+    /**
+     * Offset at which this node starts in its parent or `null` if the node has no parent.
+     *
+     * @internal
+     */
+    _startOffset = null;
     /**
      * Creates a model node.
      *
@@ -46,24 +68,6 @@ export default class Node extends TypeCheckable {
      */
     constructor(attrs) {
         super();
-        /**
-         * Parent of this node. It could be {@link module:engine/model/element~Element}
-         * or {@link module:engine/model/documentfragment~DocumentFragment}.
-         * Equals to `null` if the node has no parent.
-         */
-        this.parent = null;
-        /**
-         * Index of this node in its parent or `null` if the node has no parent.
-         *
-         * @internal
-         */
-        this._index = null;
-        /**
-         * Offset at which this node starts in its parent or `null` if the node has no parent.
-         *
-         * @internal
-         */
-        this._startOffset = null;
         this._attrs = toMap(attrs);
     }
     /**

package/src/model/nodelist.js

@@ -13,6 +13,18 @@ import { CKEditorError, spliceArray } from '@ckeditor/ckeditor5-utils';
  * or {@link module:engine/model/documentfragment~DocumentFragment DocumentFragment}.
  */
 export default class NodeList {
+    /**
+     * Nodes contained in this node list.
+     */
+    _nodes = [];
+    /**
+     * This array maps numbers (offsets) to node that is placed at that offset.
+     *
+     * This array is similar to `_nodes` with the difference that one node may occupy multiple consecutive items in the array.
+     *
+     * This array is needed to quickly retrieve a node that is placed at given offset.
+     */
+    _offsetToNode = [];
     /**
      * Creates a node list.
      *
@@ -20,18 +32,6 @@ export default class NodeList {
      * @param nodes Nodes contained in this node list.
      */
     constructor(nodes) {
-        /**
-         * Nodes contained in this node list.
-         */
-        this._nodes = [];
-        /**
-         * This array maps numbers (offsets) to node that is placed at that offset.
-         *
-         * This array is similar to `_nodes` with the difference that one node may occupy multiple consecutive items in the array.
-         *
-         * This array is needed to quickly retrieve a node that is placed at given offset.
-         */
-        this._offsetToNode = [];
         if (nodes) {
             this._insertNodes(0, nodes);
         }

package/src/model/operation/attributeoperation.js

@@ -9,13 +9,37 @@ import Operation from './operation.js';
 import { _setAttribute } from './utils.js';
 import Range from '../range.js';
 import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-import { isEqual } from 'lodash-es';
+import { isEqual } from 'es-toolkit/compat';
 /**
  * Operation to change nodes' attribute.
  *
  * Using this class you can add, remove or change value of the attribute.
  */
 export default class AttributeOperation extends Operation {
+    /**
+     * Range on which operation should be applied.
+     *
+     * @readonly
+     */
+    range;
+    /**
+     * Key of an attribute to change or remove.
+     *
+     * @readonly
+     */
+    key;
+    /**
+     * Old value of the attribute with given key or `null`, if attribute was not set before.
+     *
+     * @readonly
+     */
+    oldValue;
+    /**
+     * New value of the attribute with given key or `null`, if operation should remove attribute.
+     *
+     * @readonly
+     */
+    newValue;
     /**
      * Creates an operation that changes, removes or adds attributes.
      *

package/src/model/operation/detachoperation.js

@@ -15,6 +15,14 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * Note this operation is only a local operation and won't be send to the other clients.
  */
 export default class DetachOperation extends Operation {
+    /**
+     * Position before the first {@link module:engine/model/item~Item model item} to detach.
+     */
+    sourcePosition;
+    /**
+     * Offset size of moved range.
+     */
+    howMany;
     /**
      * Creates an insert operation.
      *

package/src/model/operation/insertoperation.js

@@ -17,6 +17,24 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * Operation to insert one or more nodes at given position in the model.
  */
 export default class InsertOperation extends Operation {
+    /**
+     * Position of insertion.
+     *
+     * @readonly
+     */
+    position;
+    /**
+     * List of nodes to insert.
+     *
+     * @readonly
+     */
+    nodes;
+    /**
+     * Flag deciding how the operation should be transformed. If set to `true`, nodes might get additional attributes
+     * during operational transformation. This happens when the operation insertion position is inside of a range
+     * where attributes have changed.
+     */
+    shouldReceiveAttributes;
     /**
      * Creates an insert operation.
      *

package/src/model/operation/markeroperation.js

@@ -8,6 +8,35 @@
 import Operation from './operation.js';
 import Range from '../range.js';
 export default class MarkerOperation extends Operation {
+    /**
+     * Marker name.
+     *
+     * @readonly
+     */
+    name;
+    /**
+     * Marker range before the change.
+     *
+     * @readonly
+     */
+    oldRange;
+    /**
+     * Marker range after the change.
+     *
+     * @readonly
+     */
+    newRange;
+    /**
+     * Specifies whether the marker operation affects the data produced by the data pipeline
+     * (is persisted in the editor's data).
+     *
+     * @readonly
+     */
+    affectsData;
+    /**
+     * Marker collection on which change should be executed.
+     */
+    _markers;
     /**
      * @param name Marker name.
      * @param oldRange Marker range before the change.

package/src/model/operation/mergeoperation.js

@@ -20,6 +20,22 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * The merged element is moved to the graveyard at {@link ~MergeOperation#graveyardPosition}.
  */
 export default class MergeOperation extends Operation {
+    /**
+     * Position inside the merged element. All nodes from that element after that position will be moved to {@link #targetPosition}.
+     */
+    sourcePosition;
+    /**
+     * Summary offset size of nodes which will be moved from the merged element to the new parent.
+     */
+    howMany;
+    /**
+     * Position which the nodes from the merged elements will be moved to.
+     */
+    targetPosition;
+    /**
+     * Position in graveyard to which the merged element will be moved.
+     */
+    graveyardPosition;
     /**
      * Creates a merge operation.
      *

package/src/model/operation/moveoperation.js

@@ -16,6 +16,18 @@ import { CKEditorError, compareArrays } from '@ckeditor/ckeditor5-utils';
  * to given {@link module:engine/model/position~Position target position}.
  */
 export default class MoveOperation extends Operation {
+    /**
+     * Position before the first {@link module:engine/model/item~Item model item} to move.
+     */
+    sourcePosition;
+    /**
+     * Offset size of moved range.
+     */
+    howMany;
+    /**
+     * Position at which moved nodes will be inserted.
+     */
+    targetPosition;
     /**
      * Creates a move operation.
      *

package/src/model/operation/operation.js

@@ -6,6 +6,25 @@
  * Abstract base operation class.
  */
 export default class Operation {
+    /**
+     * {@link module:engine/model/document~Document#version} on which operation can be applied. If you try to
+     * {@link module:engine/model/model~Model#applyOperation apply} operation with different base version than the
+     * {@link module:engine/model/document~Document#version document version} the
+     * {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown.
+     */
+    baseVersion;
+    /**
+     * Defines whether operation is executed on attached or detached {@link module:engine/model/item~Item items}.
+     */
+    isDocumentOperation;
+    /**
+     * {@link module:engine/model/batch~Batch Batch} to which the operation is added or `null` if the operation is not
+     * added to any batch yet.
+     *
+     * Note, that a {@link #isDocumentOperation non-document operation} has this property always set to `null`, and is never added
+     * to any batch.
+     */
+    batch;
     /**
      * Base operation constructor.
      *

package/src/model/operation/renameoperation.js

@@ -15,6 +15,18 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * Using this class you can change element's name.
  */
 export default class RenameOperation extends Operation {
+    /**
+     * Position before an element to change.
+     */
+    position;
+    /**
+     * Current name of the element.
+     */
+    oldName;
+    /**
+     * New name for the element.
+     */
+    newName;
     /**
      * Creates an operation that changes element's name.
      *

package/src/model/operation/rootattributeoperation.js

@@ -18,6 +18,26 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * {@link module:engine/model/position~Position} can't be created before a root element.
  */
 export default class RootAttributeOperation extends Operation {
+    /**
+     * Root element to change.
+     */
+    root;
+    /**
+     * Key of an attribute to change or remove.
+     */
+    key;
+    /**
+     * Old value of the attribute with given key or `null`, if attribute was not set before.
+     *
+     * @readonly
+     */
+    oldValue;
+    /**
+     * New value of the attribute with given key or `null`, if operation should remove attribute.
+     *
+     * @readonly
+     */
+    newValue;
     /**
      * Creates an operation that changes, removes or adds attributes on root element.
      *

package/src/model/operation/rootoperation.js

@@ -10,6 +10,22 @@ import Operation from './operation.js';
  * Operation that creates (or attaches) or detaches a root element.
  */
 export default class RootOperation extends Operation {
+    /**
+     * Root name to create or detach.
+     */
+    rootName;
+    /**
+     * Root element name.
+     */
+    elementName;
+    /**
+     * Specifies whether the operation adds (`true`) or detaches the root (`false`).
+     */
+    isAdd;
+    /**
+     * Document which owns the root.
+     */
+    _document;
     /**
      * Creates an operation that creates or removes a root element.
      *

package/src/model/operation/splitoperation.js

@@ -17,6 +17,25 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * both containing a part of the element's original content.
  */
 export default class SplitOperation extends Operation {
+    /**
+     * Position at which an element should be split.
+     */
+    splitPosition;
+    /**
+     * Total offset size of elements that are in the split element after `position`.
+     */
+    howMany;
+    /**
+     * Position at which the clone of split element (or element from graveyard) will be inserted.
+     */
+    insertionPosition;
+    /**
+     * Position in the graveyard root before the element which should be used as a parent of the nodes after `position`.
+     * If it is not set, a copy of the the `position` parent will be used.
+     *
+     * The default behavior is to clone the split element. Element from graveyard is used during undo.
+     */
+    graveyardPosition;
     /**
      * Creates a split operation.
      *

package/src/model/operation/transform.js

@@ -342,6 +342,11 @@ export function transformSets(operationsA, operationsB, options) {
  * about two operations that are about to be transformed. This contextual information can be used for better conflict resolution.
  */
 class ContextFactory {
+    originalOperations;
+    _history;
+    _useRelations;
+    _forceWeakRemove;
+    _relations;
     /**
      * Creates `ContextFactory` instance.
      *

package/src/model/position.js

@@ -36,6 +36,46 @@ import { CKEditorError, compareArrays } from '@ckeditor/ckeditor5-utils';
  * In most cases, position with wrong path is caused by an error in code, but it is sometimes needed, as described above.
  */
 export default class Position extends TypeCheckable {
+    /**
+     * Root of the position path.
+     */
+    root;
+    /**
+     * Position of the node in the tree. **Path contains offsets, not indexes.**
+     *
+     * Position can be placed before, after or in a {@link module:engine/model/node~Node node} if that node has
+     * {@link module:engine/model/node~Node#offsetSize} greater than `1`. Items in position path are
+     * {@link module:engine/model/node~Node#startOffset starting offsets} of position ancestors, starting from direct root children,
+     * down to the position offset in it's parent.
+     *
+     * ```
+     * ROOT
+     *  |- P            before: [ 0 ]         after: [ 1 ]
+     *  |- UL           before: [ 1 ]         after: [ 2 ]
+     *     |- LI        before: [ 1, 0 ]      after: [ 1, 1 ]
+     *     |  |- foo    before: [ 1, 0, 0 ]   after: [ 1, 0, 3 ]
+     *     |- LI        before: [ 1, 1 ]      after: [ 1, 2 ]
+     *        |- bar    before: [ 1, 1, 0 ]   after: [ 1, 1, 3 ]
+     * ```
+     *
+     * `foo` and `bar` are representing {@link module:engine/model/text~Text text nodes}. Since text nodes has offset size
+     * greater than `1` you can place position offset between their start and end:
+     *
+     * ```
+     * ROOT
+     *  |- P
+     *  |- UL
+     *     |- LI
+     *     |  |- f^o|o  ^ has path: [ 1, 0, 1 ]   | has path: [ 1, 0, 2 ]
+     *     |- LI
+     *        |- b^a|r  ^ has path: [ 1, 1, 1 ]   | has path: [ 1, 1, 2 ]
+     * ```
+     */
+    path;
+    /**
+     * Position stickiness. See {@link module:engine/model/position~PositionStickiness}.
+     */
+    stickiness;
     /**
      * Creates a position.
      *

package/src/model/range.js

@@ -19,6 +19,14 @@ import { CKEditorError, compareArrays } from '@ckeditor/ckeditor5-utils';
  * {@link module:engine/model/model~Model} and {@link module:engine/model/writer~Writer}.
  */
 export default class Range extends TypeCheckable {
+    /**
+     * Start position.
+     */
+    start;
+    /**
+     * End position.
+     */
+    end;
     /**
      * Creates a range spanning from `start` position to `end` position.
      *

package/src/model/rootelement.js

@@ -10,6 +10,24 @@ import Element from './element.js';
  * Type of {@link module:engine/model/element~Element} that is a root of a model tree.
  */
 export default class RootElement extends Element {
+    /**
+     * Unique root name used to identify this root element by {@link module:engine/model/document~Document}.
+     */
+    rootName;
+    /**
+     * Document that is an owner of this root.
+     */
+    _document;
+    /**
+     * @internal
+     */
+    _isAttached = true;
+    /**
+     * Informs if the root element is loaded (default).
+     *
+     * @internal
+     */
+    _isLoaded = true;
     /**
      * Creates root element.
      *
@@ -19,16 +37,6 @@ export default class RootElement extends Element {
      */
     constructor(document, name, rootName = 'main') {
         super(name);
-        /**
-         * @internal
-         */
-        this._isAttached = true;
-        /**
-         * Informs if the root element is loaded (default).
-         *
-         * @internal
-         */
-        this._isLoaded = true;
         this._document = document;
         this.rootName = rootName;
     }

package/src/model/schema.js

@@ -25,34 +25,35 @@ import { CKEditorError, first, ObservableMixin } from '@ckeditor/ckeditor5-utils
  * * The {@glink framework/deep-dive/schema Schema deep-dive} guide.
  */
 export default class Schema extends /* #__PURE__ */ ObservableMixin() {
+    _sourceDefinitions = {};
+    /**
+     * A dictionary containing attribute properties.
+     */
+    _attributeProperties = Object.create(null);
+    /**
+     * Stores additional callbacks registered for schema items, which are evaluated when {@link ~Schema#checkChild} is called.
+     *
+     * Keys are schema item names for which the callbacks are registered. Values are arrays with the callbacks.
+     *
+     * Some checks are added under {@link ~Schema#_genericCheckSymbol} key, these are evaluated for every {@link ~Schema#checkChild} call.
+     */
+    _customChildChecks = new Map();
+    /**
+     * Stores additional callbacks registered for attribute names, which are evaluated when {@link ~Schema#checkAttribute} is called.
+     *
+     * Keys are schema attribute names for which the callbacks are registered. Values are arrays with the callbacks.
+     *
+     * Some checks are added under {@link ~Schema#_genericCheckSymbol} key, these are evaluated for every
+     * {@link ~Schema#checkAttribute} call.
+     */
+    _customAttributeChecks = new Map();
+    _genericCheckSymbol = Symbol('$generic');
+    _compiledDefinitions;
     /**
      * Creates a schema instance.
      */
     constructor() {
         super();
-        this._sourceDefinitions = {};
-        /**
-         * A dictionary containing attribute properties.
-         */
-        this._attributeProperties = Object.create(null);
-        /**
-         * Stores additional callbacks registered for schema items, which are evaluated when {@link ~Schema#checkChild} is called.
-         *
-         * Keys are schema item names for which the callbacks are registered. Values are arrays with the callbacks.
-         *
-         * Some checks are added under {@link ~Schema#_genericCheckSymbol} key, these are evaluated for every {@link ~Schema#checkChild} call.
-         */
-        this._customChildChecks = new Map();
-        /**
-         * Stores additional callbacks registered for attribute names, which are evaluated when {@link ~Schema#checkAttribute} is called.
-         *
-         * Keys are schema attribute names for which the callbacks are registered. Values are arrays with the callbacks.
-         *
-         * Some checks are added under {@link ~Schema#_genericCheckSymbol} key, these are evaluated for every
-         * {@link ~Schema#checkAttribute} call.
-         */
-        this._customAttributeChecks = new Map();
-        this._genericCheckSymbol = Symbol('$generic');
         this.decorate('checkChild');
         this.decorate('checkAttribute');
         this.on('checkAttribute', (evt, args) => {
@@ -1092,6 +1093,7 @@ export default class Schema extends /* #__PURE__ */ ObservableMixin() {
  * using these methods you need to use {@link module:engine/model/schema~SchemaContextDefinition}s.
  */
 export class SchemaContext {
+    _items;
     /**
      * Creates an instance of the context.
      */

package/src/model/selection.js

@@ -18,6 +18,16 @@ import { CKEditorError, EmitterMixin, isIterable } from '@ckeditor/ckeditor5-uti
  * should have those attributes – e.g. whether you type a bolded text).
  */
 export default class Selection extends /* #__PURE__ */ EmitterMixin(TypeCheckable) {
+    /**
+     * Specifies whether the last added range was added as a backward or forward range.
+     */
+    _lastRangeBackward = false;
+    /**
+     * List of attributes set on current selection.
+     */
+    _attrs = new Map();
+    /** @internal */
+    _ranges = [];
     /**
      * Creates a new selection instance based on the given {@link module:engine/model/selection~Selectable selectable}
      * or creates an empty selection if no arguments were passed.
@@ -72,16 +82,6 @@ export default class Selection extends /* #__PURE__ */ EmitterMixin(TypeCheckabl
      */
     constructor(...args) {
         super();
-        /**
-         * Specifies whether the last added range was added as a backward or forward range.
-         */
-        this._lastRangeBackward = false;
-        /**
-         * List of attributes set on current selection.
-         */
-        this._attrs = new Map();
-        /** @internal */
-        this._ranges = [];
         if (args.length) {
             this.setTo(...args);
         }

package/src/model/text.js

@@ -19,6 +19,12 @@ import Node from './node.js';
  * {@link module:engine/model/liveposition~LivePosition live position} placed before the text node.
  */
 export default class Text extends Node {
+    /**
+     * Text data contained in this text node.
+     *
+     * @internal
+     */
+    _data;
     /**
      * Creates a text node.
      *

package/src/model/textproxy.js

@@ -38,6 +38,18 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * an instance of this class by your own.
  */
 export default class TextProxy extends TypeCheckable {
+    /**
+     * Text node which part is represented by this text proxy.
+     */
+    textNode;
+    /**
+     * Text data represented by this text proxy.
+     */
+    data;
+    /**
+     * Offset in {@link module:engine/model/textproxy~TextProxy#textNode text node} from which the text proxy starts.
+     */
+    offsetInText;
     /**
      * Creates a text proxy.
      *