@ckeditor/ckeditor5-engine 37.1.0 → 38.0.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-engine",
-  "version": "37.1.0",
+  "version": "38.0.0-rc.1",
   "description": "The editing engine of CKEditor 5 – the best browser-based rich text editor.",
   "keywords": [
     "wysiwyg",
@@ -23,30 +23,30 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-utils": "^37.1.0",
+    "@ckeditor/ckeditor5-utils": "^38.0.0-rc.1",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^37.1.0",
-    "@ckeditor/ckeditor5-block-quote": "^37.1.0",
-    "@ckeditor/ckeditor5-clipboard": "^37.1.0",
-    "@ckeditor/ckeditor5-cloud-services": "^37.1.0",
-    "@ckeditor/ckeditor5-core": "^37.1.0",
-    "@ckeditor/ckeditor5-editor-classic": "^37.1.0",
-    "@ckeditor/ckeditor5-enter": "^37.1.0",
-    "@ckeditor/ckeditor5-essentials": "^37.1.0",
-    "@ckeditor/ckeditor5-heading": "^37.1.0",
-    "@ckeditor/ckeditor5-image": "^37.1.0",
-    "@ckeditor/ckeditor5-link": "^37.1.0",
-    "@ckeditor/ckeditor5-list": "^37.1.0",
-    "@ckeditor/ckeditor5-mention": "^37.1.0",
-    "@ckeditor/ckeditor5-paragraph": "^37.1.0",
-    "@ckeditor/ckeditor5-table": "^37.1.0",
-    "@ckeditor/ckeditor5-theme-lark": "^37.1.0",
-    "@ckeditor/ckeditor5-typing": "^37.1.0",
-    "@ckeditor/ckeditor5-ui": "^37.1.0",
-    "@ckeditor/ckeditor5-undo": "^37.1.0",
-    "@ckeditor/ckeditor5-widget": "^37.1.0",
+    "@ckeditor/ckeditor5-basic-styles": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-block-quote": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-clipboard": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-cloud-services": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-core": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-editor-classic": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-enter": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-essentials": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-heading": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-image": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-link": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-list": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-mention": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-paragraph": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-table": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-theme-lark": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-typing": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-ui": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-undo": "^38.0.0-rc.1",
+    "@ckeditor/ckeditor5-widget": "^38.0.0-rc.1",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"

package/src/conversion/conversion.d.ts

@@ -72,9 +72,9 @@ export default class Conversion {
     addAlias(alias: `${string}Downcast`, dispatcher: DowncastDispatcher): void;
     addAlias(alias: `${string}Upcast`, dispatcher: UpcastDispatcher): void;
     addAlias(alias: string, dispatcher: DowncastDispatcher | UpcastDispatcher): void;
-    for(groupName: 'downcast' | `${string}Downcast`): DowncastHelpers;
-    for(groupName: 'upcast' | `${string}Upcast`): UpcastHelpers;
-    for(groupName: string): DowncastHelpers | UpcastHelpers;
+    for(groupName: 'downcast' | 'dataDowncast' | 'editingDowncast'): DowncastHelpers;
+    for(groupName: 'upcast'): UpcastHelpers;
+    for<T extends string>(groupName: T): ConversionType<T>;
     /**
      * Sets up converters between the model and the view that convert a model element to a view element (and vice versa).
      * For example, the model `<paragraph>Foo</paragraph>` is turned into `<p>Foo</p>` in the view.
@@ -474,3 +474,5 @@ export default class Conversion {
      */
     private _createConversionHelpers;
 }
+type ConversionType<T extends string> = T extends `${string}Downcast` ? DowncastHelpers : T extends `${string}Upcast` ? UpcastHelpers : DowncastHelpers | UpcastHelpers;
+export {};

package/src/index.d.ts

@@ -28,6 +28,7 @@ export { default as AttributeOperation } from './model/operation/attributeoperat
 export { default as RenameOperation } from './model/operation/renameoperation';
 export { default as RootAttributeOperation } from './model/operation/rootattributeoperation';
 export { default as RootOperation } from './model/operation/rootoperation';
+export { default as NoOperation } from './model/operation/nooperation';
 export { transformSets } from './model/operation/transform';
 export { default as DocumentSelection, type DocumentSelectionChangeRangeEvent } from './model/documentselection';
 export { default as Range } from './model/range';
@@ -55,7 +56,7 @@ export type { default as Writer } from './model/writer';
 export { findOptimalInsertionRange } from './model/utils/findoptimalinsertionrange';
 export type { DocumentChangeEvent } from './model/document';
 export type { DocumentSelectionChangeEvent } from './model/documentselection';
-export type { ModelApplyOperationEvent, ModelDeleteContentEvent, ModelGetSelectedContentEvent, ModelInsertContentEvent, ModelInsertObjectEvent, ModelModifySelectionEvent } from './model/model';
+export type { ModelApplyOperationEvent, ModelDeleteContentEvent, ModelGetSelectedContentEvent, ModelInsertContentEvent, ModelInsertObjectEvent, ModelModifySelectionEvent, ModelCanEditAtEvent } from './model/model';
 export type { SelectionChangeRangeEvent } from './model/selection';
 export { default as DataTransfer } from './view/datatransfer';
 export { default as DomConverter } from './view/domconverter';
@@ -66,6 +67,7 @@ export { default as ViewText } from './view/text';
 export { default as ViewElement, type ElementAttributes as ViewElementAttributes } from './view/element';
 export { default as ViewContainerElement } from './view/containerelement';
 export { default as ViewEditableElement } from './view/editableelement';
+export { default as ViewRootEditableElement } from './view/rooteditableelement';
 export { default as ViewAttributeElement } from './view/attributeelement';
 export { default as ViewEmptyElement } from './view/emptyelement';
 export { default as ViewRawElement } from './view/rawelement';

package/src/index.js

@@ -22,6 +22,7 @@ export { default as AttributeOperation } from './model/operation/attributeoperat
 export { default as RenameOperation } from './model/operation/renameoperation';
 export { default as RootAttributeOperation } from './model/operation/rootattributeoperation';
 export { default as RootOperation } from './model/operation/rootoperation';
+export { default as NoOperation } from './model/operation/nooperation';
 export { transformSets } from './model/operation/transform';
 // Model.
 export { default as DocumentSelection } from './model/documentselection';
@@ -47,6 +48,7 @@ export { default as ViewText } from './view/text';
 export { default as ViewElement } from './view/element';
 export { default as ViewContainerElement } from './view/containerelement';
 export { default as ViewEditableElement } from './view/editableelement';
+export { default as ViewRootEditableElement } from './view/rooteditableelement';
 export { default as ViewAttributeElement } from './view/attributeelement';
 export { default as ViewEmptyElement } from './view/emptyelement';
 export { default as ViewRawElement } from './view/rawelement';

package/src/model/document.d.ts

@@ -56,6 +56,14 @@ export default class Document extends Document_base {
      * The model differ object. Its role is to buffer changes done on the model document and then calculate a diff of those changes.
      */
     readonly differ: Differ;
+    /**
+     * Defines whether the document is in a read-only mode.
+     *
+     * The user should not be able to change the data of a document that is read-only.
+     *
+     * @readonly
+     */
+    isReadOnly: boolean;
     /**
      * Post-fixer callbacks registered to the model document.
      */

package/src/model/document.js

@@ -41,6 +41,7 @@ export default class Document extends EmitterMixin() {
         this.selection = new DocumentSelection(this);
         this.roots = new Collection({ idProperty: 'rootName' });
         this.differ = new Differ(model.markers);
+        this.isReadOnly = false;
         this._postFixers = new Set();
         this._hasSelectionChangedFromTheLastChangeBlock = false;
         // Graveyard tree root. Document always have a graveyard root, which stores removed nodes.

package/src/model/markercollection.d.ts

@@ -137,9 +137,9 @@ export interface MarkerData {
 }
 declare const Marker_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
 /**
- * `Marker` is a continuous part of model (like a range), is named and represent some kind of information about marked
- * part of model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
- * model document tree, markers are not stored directly in document tree but in
+ * `Marker` is a continuous part of the model (like a range), is named and represents some kind of information about the
+ * marked part of the model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
+ * the model document tree, markers are not stored directly in the document tree but in the
  * {@link module:engine/model/model~Model#markers model markers' collection}. Still, they are document data, by giving
  * additional meaning to the part of a model document between marker start and marker end.
  *

package/src/model/markercollection.js

@@ -214,9 +214,9 @@ export default class MarkerCollection extends EmitterMixin() {
     }
 }
 /**
- * `Marker` is a continuous part of model (like a range), is named and represent some kind of information about marked
- * part of model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
- * model document tree, markers are not stored directly in document tree but in
+ * `Marker` is a continuous part of the model (like a range), is named and represents some kind of information about the
+ * marked part of the model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
+ * the model document tree, markers are not stored directly in the document tree but in the
  * {@link module:engine/model/model~Model#markers model markers' collection}. Still, they are document data, by giving
  * additional meaning to the part of a model document between marker start and marker end.
  *

package/src/model/model.d.ts

@@ -553,6 +553,20 @@ export default class Model extends Model_base {
         ignoreWhitespaces?: boolean;
         ignoreMarkers?: boolean;
     }): boolean;
+    /**
+     * Check whether given selectable is at a place in the model where it can be edited (returns `true`) or not (returns `false`).
+     *
+     * Should be used instead of {@link module:core/editor/editor~Editor#isReadOnly} to check whether a user action can happen at
+     * given selectable. It may be decorated and used differently in different environment (e.g. multi-root editor can disable
+     * a particular root).
+     *
+     * This method is decorated. Although this method accepts any parameter of `Selectable` type, the
+     * {@link ~Model#event:canEditAt `canEditAt` event} is fired with `selectable` normalized to an instance of
+     * {@link module:engine/model/selection~Selection} or {@link module:engine/model/documentselection~DocumentSelection}
+     *
+     * @fires canEditAt
+     */
+    canEditAt(selectable: Selectable): boolean;
     /**
      * Creates a position from the given root and path in that root.
      *
@@ -856,7 +870,7 @@ export type ModelInsertObjectEvent = {
  * Event fired when {@link ~Model#deleteContent} method is called.
  *
  * The {@link ~Model#deleteContent default action of that method} is implemented as a
- * listener to this event so it can be fully customized by the features.
+ * listener to this event, so it can be fully customized by the features.
  *
  * @eventName ~Model#deleteContent
  * @param args The arguments passed to the original method.
@@ -866,7 +880,7 @@ export type ModelDeleteContentEvent = DecoratedMethodEvent<Model, 'deleteContent
  * Event fired when {@link ~Model#modifySelection} method is called.
  *
  * The {@link ~Model#modifySelection default action of that method} is implemented as a
- * listener to this event so it can be fully customized by the features.
+ * listener to this event, so it can be fully customized by the features.
  *
  * @eventName ~Model#modifySelection
  * @param args The arguments passed to the original method.
@@ -876,10 +890,31 @@ export type ModelModifySelectionEvent = DecoratedMethodEvent<Model, 'modifySelec
  * Event fired when {@link ~Model#getSelectedContent} method is called.
  *
  * The {@link ~Model#getSelectedContent default action of that method} is implemented as a
- * listener to this event so it can be fully customized by the features.
+ * listener to this event, so it can be fully customized by the features.
  *
  * @eventName ~Model#getSelectedContent
  * @param args The arguments passed to the original method.
  */
 export type ModelGetSelectedContentEvent = DecoratedMethodEvent<Model, 'getSelectedContent'>;
+/**
+ * Event fired when {@link ~Model#canEditAt} method is called.
+ *
+ * The {@link ~Model#canEditAt default action of that method} is implemented as a
+ * listener to this event, so it can be fully customized by the features.
+ *
+ * Although the original method accepts any parameter of `Selectable` type, this event is fired with `selectable` normalized
+ * to an instance of {@link module:engine/model/selection~Selection} or {@link module:engine/model/documentselection~DocumentSelection}.
+ *
+ * @eventName ~Model#canEditAt
+ * @param args The arguments passed to the original method.
+ */
+export type ModelCanEditAtEvent = {
+    name: 'canEditAt';
+    args: [
+        [
+            selectable?: ModelSelection | DocumentSelection
+        ]
+    ];
+    return: boolean;
+};
 export {};

package/src/model/model.js

@@ -106,6 +106,15 @@ export default class Model extends ObservableMixin() {
         this.on('insertObject', (evt, [element, selection, options]) => {
             evt.return = insertObject(this, element, selection, options);
         });
+        // The base implementation for "decorated" method with remapped arguments.
+        this.on('canEditAt', evt => {
+            const canEditAt = !this.document.isReadOnly;
+            evt.return = canEditAt;
+            if (!canEditAt) {
+                // Prevent further processing if the selection is at non-editable place.
+                evt.stop();
+            }
+        });
         // @if CK_DEBUG_ENGINE // initDocumentDumping( this.document );
         // @if CK_DEBUG_ENGINE // this.on( 'applyOperation', () => {
         // @if CK_DEBUG_ENGINE // 	dumpTrees( this.document, this.document.version );
@@ -619,6 +628,23 @@ export default class Model extends ObservableMixin() {
         }
         return false;
     }
+    /**
+     * Check whether given selectable is at a place in the model where it can be edited (returns `true`) or not (returns `false`).
+     *
+     * Should be used instead of {@link module:core/editor/editor~Editor#isReadOnly} to check whether a user action can happen at
+     * given selectable. It may be decorated and used differently in different environment (e.g. multi-root editor can disable
+     * a particular root).
+     *
+     * This method is decorated. Although this method accepts any parameter of `Selectable` type, the
+     * {@link ~Model#event:canEditAt `canEditAt` event} is fired with `selectable` normalized to an instance of
+     * {@link module:engine/model/selection~Selection} or {@link module:engine/model/documentselection~DocumentSelection}
+     *
+     * @fires canEditAt
+     */
+    canEditAt(selectable) {
+        const selection = normalizeSelectable(selectable);
+        return this.fire('canEditAt', [selection]);
+    }
     /**
      * Creates a position from the given root and path in that root.
      *
@@ -803,7 +829,15 @@ function normalizeSelectable(selectable, placeOrOffset) {
         return selectable;
     }
     if (selectable instanceof Node) {
-        return new ModelSelection(selectable, placeOrOffset);
+        if (placeOrOffset || placeOrOffset === 0) {
+            return new ModelSelection(selectable, placeOrOffset);
+        }
+        else if (selectable.is('rootElement')) {
+            return new ModelSelection(selectable, 'in');
+        }
+        else {
+            return new ModelSelection(selectable, 'on');
+        }
     }
     return new ModelSelection(selectable);
 }

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

@@ -8,6 +8,7 @@
 import Operation from './operation';
 import Range from '../range';
 import type Document from '../document';
+import type { Selectable } from '../selection';
 /**
  * Operation to change nodes' attribute.
  *
@@ -62,6 +63,10 @@ export default class AttributeOperation extends Operation {
      * @inheritDoc
      */
     get type(): 'addAttribute' | 'removeAttribute' | 'changeAttribute';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

package/src/model/operation/attributeoperation.js

@@ -56,6 +56,12 @@ export default class AttributeOperation extends Operation {
             return 'changeAttribute';
         }
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return this.range.clone();
+    }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

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

@@ -7,6 +7,7 @@
  */
 import Operation from './operation';
 import type Position from '../position';
+import type { Selectable } from '../selection';
 /**
  * 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.
@@ -34,6 +35,10 @@ export default class DetachOperation extends Operation {
      * @inheritDoc
      */
     get type(): 'detach';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * @inheritDoc
      */

package/src/model/operation/detachoperation.js

@@ -33,6 +33,12 @@ export default class DetachOperation extends Operation {
     get type() {
         return 'detach';
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return null;
+    }
     /**
      * @inheritDoc
      */

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

@@ -9,6 +9,7 @@ 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.
@@ -49,6 +50,10 @@ export default class InsertOperation extends Operation {
      * 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.
      */

package/src/model/operation/insertoperation.js

@@ -44,6 +44,12 @@ export default class InsertOperation extends Operation {
     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.
      */

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

@@ -9,6 +9,7 @@ import Operation from './operation';
 import Range from '../range';
 import type Document from '../document';
 import type MarkerCollection from '../markercollection';
+import type { Selectable } from '../selection';
 export default class MarkerOperation extends Operation {
     /**
      * Marker name.
@@ -54,6 +55,10 @@ export default class MarkerOperation extends Operation {
      * @inheritDoc
      */
     get type(): 'marker';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

package/src/model/operation/markeroperation.js

@@ -32,6 +32,24 @@ export default class MarkerOperation extends Operation {
     get type() {
         return 'marker';
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        const ranges = [];
+        if (this.oldRange) {
+            ranges.push(this.oldRange.clone());
+        }
+        if (this.newRange) {
+            if (this.oldRange) {
+                ranges.push(...this.newRange.getDifference(this.oldRange));
+            }
+            else {
+                ranges.push(this.newRange.clone());
+            }
+        }
+        return ranges;
+    }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

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

@@ -9,6 +9,7 @@ import Operation from './operation';
 import Position from '../position';
 import Range from '../range';
 import type Document from '../document';
+import type { Selectable } from '../selection';
 /**
  * Operation to merge two {@link module:engine/model/element~Element elements}.
  *
@@ -59,6 +60,10 @@ export default class MergeOperation extends Operation {
      * The range starts at {@link ~MergeOperation#sourcePosition} and ends in the same parent, at `POSITIVE_INFINITY` offset.
      */
     get movedRange(): Range;
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

package/src/model/operation/mergeoperation.js

@@ -63,6 +63,18 @@ export default class MergeOperation extends Operation {
         const end = this.sourcePosition.getShiftedBy(Number.POSITIVE_INFINITY);
         return new Range(this.sourcePosition, end);
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        const mergedElement = this.sourcePosition.parent;
+        return [
+            Range._createOn(mergedElement),
+            // These could be positions but `Selectable` type only supports `Iterable<Range>`.
+            Range._createFromPositionAndShift(this.targetPosition, 0),
+            Range._createFromPositionAndShift(this.graveyardPosition, 0)
+        ];
+    }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

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

@@ -7,6 +7,7 @@
  */
 import Operation from './operation';
 import Position from '../position';
+import type { Selectable } from '../selection';
 import type Document from '../document';
 /**
  * Operation to move a range of {@link module:engine/model/item~Item model items}
@@ -40,6 +41,10 @@ export default class MoveOperation extends Operation {
      * @inheritDoc
      */
     get type(): 'move' | 'remove' | 'reinsert';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

package/src/model/operation/moveoperation.js

@@ -47,6 +47,15 @@ export default class MoveOperation extends Operation {
         }
         return 'move';
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return [
+            Range._createFromPositionAndShift(this.sourcePosition, this.howMany),
+            Range._createFromPositionAndShift(this.targetPosition, 0)
+        ];
+    }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

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

@@ -6,6 +6,7 @@
  * @module engine/model/operation/nooperation
  */
 import Operation from './operation';
+import type { Selectable } from '../selection';
 /**
  * Operation which is doing nothing ("empty operation", "do-nothing operation", "noop"). This is an operation,
  * which when executed does not change the tree model. It still has some parameters defined for transformation purposes.
@@ -16,6 +17,10 @@ import Operation from './operation';
  */
 export default class NoOperation extends Operation {
     get type(): 'noop';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

package/src/model/operation/nooperation.js

@@ -18,6 +18,12 @@ export default class NoOperation extends Operation {
     get type() {
         return 'noop';
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return null;
+    }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      */

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

@@ -4,6 +4,7 @@
  */
 import type Batch from '../batch';
 import type Document from '../document';
+import type { Selectable } from '../selection';
 /**
  * @module engine/model/operation/operation
  */
@@ -38,6 +39,12 @@ export default abstract class Operation {
      * can be applied or `null` if the operation operates on detached (non-document) tree.
      */
     constructor(baseVersion: number | null);
+    /**
+     * A selectable that will be affected by the operation after it is executed.
+     *
+     * The exact returned parameter differs between operation types.
+     */
+    abstract get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *

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

@@ -8,6 +8,7 @@
 import Operation from './operation';
 import Position from '../position';
 import type Document from '../document';
+import type { Selectable } from '../selection';
 /**
  * Operation to change element's name.
  *
@@ -40,6 +41,10 @@ export default class RenameOperation extends Operation {
      * @inheritDoc
      */
     get type(): 'rename';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *

package/src/model/operation/renameoperation.js

@@ -38,6 +38,12 @@ export default class RenameOperation extends Operation {
     get type() {
         return 'rename';
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return this.position.nodeAfter;
+    }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *

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

@@ -8,6 +8,7 @@
 import Operation from './operation';
 import type Document from '../document';
 import type RootElement from '../rootelement';
+import type { Selectable } from '../selection';
 /**
  * Operation to change root element's attribute. Using this class you can add, remove or change value of the attribute.
  *
@@ -55,6 +56,10 @@ export default class RootAttributeOperation extends Operation {
      * @inheritDoc
      */
     get type(): 'addRootAttribute' | 'removeRootAttribute' | 'changeRootAttribute';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *

package/src/model/operation/rootattributeoperation.js

@@ -50,6 +50,12 @@ export default class RootAttributeOperation extends Operation {
             return 'changeRootAttribute';
         }
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return this.root;
+    }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *

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

@@ -7,6 +7,7 @@
  */
 import Operation from './operation';
 import type Document from '../document';
+import type { Selectable } from '../selection';
 /**
  * Operation that creates (or attaches) or detaches a root element.
  */
@@ -41,6 +42,10 @@ export default class RootOperation extends Operation {
      * @inheritDoc
      */
     get type(): 'addRoot' | 'detachRoot';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * @inheritDoc
      */

package/src/model/operation/rootoperation.js

@@ -41,6 +41,12 @@ export default class RootOperation extends Operation {
     get type() {
         return this.isAdd ? 'addRoot' : 'detachRoot';
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        return this._document.getRoot(this.rootName);
+    }
     /**
      * @inheritDoc
      */

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

@@ -9,6 +9,7 @@ import Operation from './operation';
 import Position from '../position';
 import Range from '../range';
 import type Document from '../document';
+import type { Selectable } from '../selection';
 /**
  * Operation to split {@link module:engine/model/element~Element an element} at given
  * {@link module:engine/model/operation/splitoperation~SplitOperation#splitPosition split position} into two elements,
@@ -61,6 +62,10 @@ export default class SplitOperation extends Operation {
      * The range starts at {@link #splitPosition} and ends in the same parent, at `POSITIVE_INFINITY` offset.
      */
     get movedRange(): Range;
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *

package/src/model/operation/splitoperation.js

@@ -65,6 +65,20 @@ export default class SplitOperation extends Operation {
         const end = this.splitPosition.getShiftedBy(Number.POSITIVE_INFINITY);
         return new Range(this.splitPosition, end);
     }
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable() {
+        // These could be positions but `Selectable` type only supports `Iterable<Range>`.
+        const ranges = [
+            Range._createFromPositionAndShift(this.splitPosition, 0),
+            Range._createFromPositionAndShift(this.insertionPosition, 0)
+        ];
+        if (this.graveyardPosition) {
+            ranges.push(Range._createFromPositionAndShift(this.graveyardPosition, 0));
+        }
+        return ranges;
+    }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *

package/src/model/selection.js

@@ -719,7 +719,7 @@ function isTopBlockInRange(block, range) {
     return !isParentInRange;
 }
 /**
- * If a selection starts at the end of a block, that block is not returned as from user perspective this block wasn't selected.
+ * If a selection starts at the end of a block, that block is not returned as from the user's perspective this block wasn't selected.
  * See [#11585](https://github.com/ckeditor/ckeditor5/issues/11585) for more details.
  *
  * ```xml
@@ -747,7 +747,7 @@ function isStartBlockSelected(startBlock, range) {
     return isTopBlockInRange(startBlock, range);
 }
 /**
- * If a selection ends at the beginning of a block, that block is not returned as from user perspective this block wasn't selected.
+ * If a selection ends at the beginning of a block, that block is not returned as from the user's perspective this block wasn't selected.
  * See [#984](https://github.com/ckeditor/ckeditor5-engine/issues/984) for more details.
  *
  * ```xml

package/src/model/writer.d.ts

@@ -472,7 +472,7 @@ export default class Writer {
      * @param element The element to rename.
      * @param newName New element name.
      */
-    rename(element: Element, newName: string): void;
+    rename(element: Element | DocumentFragment, newName: string): void;
     /**
      * Splits elements starting from the given position and going to the top of the model tree as long as given
      * `limitElement` is reached. When `limitElement` is not defined then only the parent of the given position will be split.

package/src/view/datatransfer.d.ts

@@ -59,6 +59,10 @@ export default class DataTransfer {
      */
     set dropEffect(value: DropEffect);
     get dropEffect(): DropEffect;
+    /**
+     * Set a preview image of the dragged content.
+     */
+    setDragImage(image: Element, x: number, y: number): void;
     /**
      * Whether the dragging operation was canceled.
      */

package/src/view/datatransfer.js

@@ -71,6 +71,12 @@ export default class DataTransfer {
     get dropEffect() {
         return this._native.dropEffect;
     }
+    /**
+     * Set a preview image of the dragged content.
+     */
+    setDragImage(image, x, y) {
+        this._native.setDragImage(image, x, y);
+    }
     /**
      * Whether the dragging operation was canceled.
      */

package/src/view/domconverter.js

@@ -16,7 +16,7 @@ import ViewDocumentFragment from './documentfragment';
 import ViewTreeWalker from './treewalker';
 import { default as Matcher } from './matcher';
 import { BR_FILLER, INLINE_FILLER_LENGTH, NBSP_FILLER, MARKED_NBSP_FILLER, getDataWithoutFiller, isInlineFiller, startsWithFiller } from './filler';
-import { global, logWarning, indexOf, getAncestors, isText, isComment, first } from '@ckeditor/ckeditor5-utils';
+import { global, logWarning, indexOf, getAncestors, isText, isComment, isValidAttributeName, first } from '@ckeditor/ckeditor5-utils';
 const BR_FILLER_REF = BR_FILLER(global.document); // eslint-disable-line new-cap
 const NBSP_FILLER_REF = NBSP_FILLER(global.document); // eslint-disable-line new-cap
 const MARKED_NBSP_FILLER_REF = MARKED_NBSP_FILLER(global.document); // eslint-disable-line new-cap
@@ -305,6 +305,15 @@ export default class DomConverter {
         if (!shouldRenderAttribute) {
             logWarning('domconverter-unsafe-attribute-detected', { domElement, key, value });
         }
+        if (!isValidAttributeName(key)) {
+            /**
+             * Invalid attribute name was ignored during rendering.
+             *
+             * @error domconverter-invalid-attribute-detected
+             */
+            logWarning('domconverter-invalid-attribute-detected', { domElement, key, value });
+            return;
+        }
         // The old value was safe but the new value is unsafe.
         if (domElement.hasAttribute(key) && !shouldRenderAttribute) {
             domElement.removeAttribute(key);