@ckeditor/ckeditor5-engine 39.0.1 → 40.0.0

package/src/model/operation/detachoperation.js

@@ -1,77 +1,77 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/model/operation/detachoperation
- */
-import Operation from './operation';
-import Range from '../range';
-import { _remove } from './utils';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-// @if CK_DEBUG_ENGINE // const ModelRange = require( '../range' ).default;
-/**
- * Operation to permanently remove node from detached root.
- * Note this operation is only a local operation and won't be send to the other clients.
- */
-export default class DetachOperation extends Operation {
-    /**
-     * Creates an insert operation.
-     *
-     * @param sourcePosition Position before the first {@link module:engine/model/item~Item model item} to move.
-     * @param howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
-     * `sourcePosition` with offset shifted by `howMany`.
-     */
-    constructor(sourcePosition, howMany) {
-        super(null);
-        this.sourcePosition = sourcePosition.clone();
-        this.howMany = howMany;
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return 'detach';
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return null;
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.sourcePosition = this.sourcePosition.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        if (this.sourcePosition.root.document) {
-            /**
-             * Cannot detach document node.
-             *
-             * @error detach-operation-on-document-node
-             */
-            throw new CKEditorError('detach-operation-on-document-node', this);
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        _remove(Range._createFromPositionAndShift(this.sourcePosition, this.howMany));
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'DetachOperation';
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/operation/detachoperation
+ */
+import Operation from './operation';
+import Range from '../range';
+import { _remove } from './utils';
+import { CKEditorError } from '@ckeditor/ckeditor5-utils';
+// @if CK_DEBUG_ENGINE // const ModelRange = require( '../range' ).default;
+/**
+ * Operation to permanently remove node from detached root.
+ * Note this operation is only a local operation and won't be send to the other clients.
+ */
+export default class DetachOperation extends Operation {
+    /**
+     * Creates an insert operation.
+     *
+     * @param sourcePosition Position before the first {@link module:engine/model/item~Item model item} to move.
+     * @param howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
+     * `sourcePosition` with offset shifted by `howMany`.
+     */
+    constructor(sourcePosition, howMany) {
+        super(null);
+        this.sourcePosition = sourcePosition.clone();
+        this.howMany = howMany;
+    }
+    /**
+     * @inheritDoc
+     */
+    get type() {
+        return 'detach';
+    }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return null;
+    }
+    /**
+     * @inheritDoc
+     */
+    toJSON() {
+        const json = super.toJSON();
+        json.sourcePosition = this.sourcePosition.toJSON();
+        return json;
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate() {
+        if (this.sourcePosition.root.document) {
+            /**
+             * Cannot detach document node.
+             *
+             * @error detach-operation-on-document-node
+             */
+            throw new CKEditorError('detach-operation-on-document-node', this);
+        }
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute() {
+        _remove(Range._createFromPositionAndShift(this.sourcePosition, this.howMany));
+    }
+    /**
+     * @inheritDoc
+     */
+    static get className() {
+        return 'DetachOperation';
+    }
+}

package/src/model/operation/insertoperation.d.ts

@@ -1,90 +1,90 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/model/operation/insertoperation
- */
-import Operation from './operation';
-import Position from '../position';
-import NodeList from '../nodelist';
-import { type NodeSet } from './utils';
-import type { Selectable } from '../selection';
-import type Document from '../document';
-/**
- * Operation to insert one or more nodes at given position in the model.
- */
-export default class InsertOperation extends Operation {
-    /**
-     * Position of insertion.
-     *
-     * @readonly
-     */
-    position: Position;
-    /**
-     * List of nodes to insert.
-     *
-     * @readonly
-     */
-    nodes: NodeList;
-    /**
-     * 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: boolean;
-    /**
-     * Creates an insert operation.
-     *
-     * @param position Position of insertion.
-     * @param nodes The list of nodes to be inserted.
-     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(position: Position, nodes: NodeSet, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'insert';
-    /**
-     * Total offset size of inserted nodes.
-     */
-    get howMany(): number;
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone(): InsertOperation;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-    /**
-     * Creates `InsertOperation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): InsertOperation;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/operation/insertoperation
+ */
+import Operation from './operation';
+import Position from '../position';
+import NodeList from '../nodelist';
+import { type NodeSet } from './utils';
+import type { Selectable } from '../selection';
+import type Document from '../document';
+/**
+ * Operation to insert one or more nodes at given position in the model.
+ */
+export default class InsertOperation extends Operation {
+    /**
+     * Position of insertion.
+     *
+     * @readonly
+     */
+    position: Position;
+    /**
+     * List of nodes to insert.
+     *
+     * @readonly
+     */
+    nodes: NodeList;
+    /**
+     * 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: boolean;
+    /**
+     * Creates an insert operation.
+     *
+     * @param position Position of insertion.
+     * @param nodes The list of nodes to be inserted.
+     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
+     * can be applied or `null` if the operation operates on detached (non-document) tree.
+     */
+    constructor(position: Position, nodes: NodeSet, baseVersion: number | null);
+    /**
+     * @inheritDoc
+     */
+    get type(): 'insert';
+    /**
+     * Total offset size of inserted nodes.
+     */
+    get howMany(): number;
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     */
+    clone(): InsertOperation;
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     */
+    getReversed(): Operation;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate(): void;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute(): void;
+    /**
+     * @inheritDoc
+     */
+    toJSON(): unknown;
+    /**
+     * @inheritDoc
+     */
+    static get className(): string;
+    /**
+     * Creates `InsertOperation` object from deserialized object, i.e. from parsed JSON string.
+     *
+     * @param json Deserialized JSON object.
+     * @param document Document on which this operation will be applied.
+     */
+    static fromJSON(json: any, document: Document): InsertOperation;
+}

package/src/model/operation/insertoperation.js

@@ -1,135 +1,135 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/model/operation/insertoperation
- */
-import Operation from './operation';
-import Position from '../position';
-import NodeList from '../nodelist';
-import MoveOperation from './moveoperation';
-import { _insert, _normalizeNodes } from './utils';
-import Text from '../text';
-import Element from '../element';
-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 {
-    /**
-     * Creates an insert operation.
-     *
-     * @param position Position of insertion.
-     * @param nodes The list of nodes to be inserted.
-     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(position, nodes, baseVersion) {
-        super(baseVersion);
-        this.position = position.clone();
-        this.position.stickiness = 'toNone';
-        this.nodes = new NodeList(_normalizeNodes(nodes));
-        this.shouldReceiveAttributes = false;
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return 'insert';
-    }
-    /**
-     * Total offset size of inserted nodes.
-     */
-    get howMany() {
-        return this.nodes.maxOffset;
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return this.position.clone();
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone() {
-        const nodes = new NodeList([...this.nodes].map(node => node._clone(true)));
-        const insert = new InsertOperation(this.position, nodes, this.baseVersion);
-        insert.shouldReceiveAttributes = this.shouldReceiveAttributes;
-        return insert;
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        const graveyard = this.position.root.document.graveyard;
-        const gyPosition = new Position(graveyard, [0]);
-        return new MoveOperation(this.position, this.nodes.maxOffset, gyPosition, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        const targetElement = this.position.parent;
-        if (!targetElement || targetElement.maxOffset < this.position.offset) {
-            /**
-             * Insertion position is invalid.
-             *
-             * @error insert-operation-position-invalid
-             */
-            throw new CKEditorError('insert-operation-position-invalid', this);
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        // What happens here is that we want original nodes be passed to writer because we want original nodes
-        // to be inserted to the model. But in InsertOperation, we want to keep those nodes as they were added
-        // to the operation, not modified. For example, text nodes can get merged or cropped while Elements can
-        // get children. It is important that InsertOperation has the copy of original nodes in intact state.
-        const originalNodes = this.nodes;
-        this.nodes = new NodeList([...originalNodes].map(node => node._clone(true)));
-        _insert(this.position, originalNodes);
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.position = this.position.toJSON();
-        json.nodes = this.nodes.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'InsertOperation';
-    }
-    /**
-     * Creates `InsertOperation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json, document) {
-        const children = [];
-        for (const child of json.nodes) {
-            if (child.name) {
-                // If child has name property, it is an Element.
-                children.push(Element.fromJSON(child));
-            }
-            else {
-                // Otherwise, it is a Text node.
-                children.push(Text.fromJSON(child));
-            }
-        }
-        const insert = new InsertOperation(Position.fromJSON(json.position, document), children, json.baseVersion);
-        insert.shouldReceiveAttributes = json.shouldReceiveAttributes;
-        return insert;
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/operation/insertoperation
+ */
+import Operation from './operation';
+import Position from '../position';
+import NodeList from '../nodelist';
+import MoveOperation from './moveoperation';
+import { _insert, _normalizeNodes } from './utils';
+import Text from '../text';
+import Element from '../element';
+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 {
+    /**
+     * Creates an insert operation.
+     *
+     * @param position Position of insertion.
+     * @param nodes The list of nodes to be inserted.
+     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
+     * can be applied or `null` if the operation operates on detached (non-document) tree.
+     */
+    constructor(position, nodes, baseVersion) {
+        super(baseVersion);
+        this.position = position.clone();
+        this.position.stickiness = 'toNone';
+        this.nodes = new NodeList(_normalizeNodes(nodes));
+        this.shouldReceiveAttributes = false;
+    }
+    /**
+     * @inheritDoc
+     */
+    get type() {
+        return 'insert';
+    }
+    /**
+     * Total offset size of inserted nodes.
+     */
+    get howMany() {
+        return this.nodes.maxOffset;
+    }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return this.position.clone();
+    }
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     */
+    clone() {
+        const nodes = new NodeList([...this.nodes].map(node => node._clone(true)));
+        const insert = new InsertOperation(this.position, nodes, this.baseVersion);
+        insert.shouldReceiveAttributes = this.shouldReceiveAttributes;
+        return insert;
+    }
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     */
+    getReversed() {
+        const graveyard = this.position.root.document.graveyard;
+        const gyPosition = new Position(graveyard, [0]);
+        return new MoveOperation(this.position, this.nodes.maxOffset, gyPosition, this.baseVersion + 1);
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate() {
+        const targetElement = this.position.parent;
+        if (!targetElement || targetElement.maxOffset < this.position.offset) {
+            /**
+             * Insertion position is invalid.
+             *
+             * @error insert-operation-position-invalid
+             */
+            throw new CKEditorError('insert-operation-position-invalid', this);
+        }
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute() {
+        // What happens here is that we want original nodes be passed to writer because we want original nodes
+        // to be inserted to the model. But in InsertOperation, we want to keep those nodes as they were added
+        // to the operation, not modified. For example, text nodes can get merged or cropped while Elements can
+        // get children. It is important that InsertOperation has the copy of original nodes in intact state.
+        const originalNodes = this.nodes;
+        this.nodes = new NodeList([...originalNodes].map(node => node._clone(true)));
+        _insert(this.position, originalNodes);
+    }
+    /**
+     * @inheritDoc
+     */
+    toJSON() {
+        const json = super.toJSON();
+        json.position = this.position.toJSON();
+        json.nodes = this.nodes.toJSON();
+        return json;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get className() {
+        return 'InsertOperation';
+    }
+    /**
+     * Creates `InsertOperation` object from deserialized object, i.e. from parsed JSON string.
+     *
+     * @param json Deserialized JSON object.
+     * @param document Document on which this operation will be applied.
+     */
+    static fromJSON(json, document) {
+        const children = [];
+        for (const child of json.nodes) {
+            if (child.name) {
+                // If child has name property, it is an Element.
+                children.push(Element.fromJSON(child));
+            }
+            else {
+                // Otherwise, it is a Text node.
+                children.push(Text.fromJSON(child));
+            }
+        }
+        const insert = new InsertOperation(Position.fromJSON(json.position, document), children, json.baseVersion);
+        insert.shouldReceiveAttributes = json.shouldReceiveAttributes;
+        return insert;
+    }
+}