@ckeditor/ckeditor5-engine 45.2.1 → 46.0.0-alpha.0

package/src/model/typecheckable.d.ts

@@ -6,24 +6,24 @@
  * @module engine/model/typecheckable
  */
 import type { Marker } from './markercollection.js';
-import type DocumentFragment from './documentfragment.js';
-import type DocumentSelection from './documentselection.js';
-import type Element from './element.js';
-import type LivePosition from './liveposition.js';
-import type LiveRange from './liverange.js';
-import type Node from './node.js';
-import type Position from './position.js';
-import type Range from './range.js';
-import type RootElement from './rootelement.js';
-import type Selection from './selection.js';
-import type Text from './text.js';
-import type TextProxy from './textproxy.js';
-export default abstract class TypeCheckable {
+import { type ModelDocumentFragment } from './documentfragment.js';
+import { type ModelDocumentSelection } from './documentselection.js';
+import { type ModelElement } from './element.js';
+import { type ModelLivePosition } from './liveposition.js';
+import { type ModelLiveRange } from './liverange.js';
+import { type ModelNode } from './node.js';
+import { type ModelPosition } from './position.js';
+import { type ModelRange } from './range.js';
+import { type ModelRootElement } from './rootelement.js';
+import { type ModelSelection } from './selection.js';
+import { type ModelText } from './text.js';
+import { type ModelTextProxy } from './textproxy.js';
+export declare abstract class ModelTypeCheckable {
     /**
-     * Checks whether the object is of type {@link module:engine/model/node~Node} or its subclass.
+     * Checks whether the object is of type {@link module:engine/model/node~ModelNode} or its subclass.
      *
      * This method is useful when processing model objects that are of unknown type. For example, a function
-     * may return a {@link module:engine/model/documentfragment~DocumentFragment} or a {@link module:engine/model/node~Node}
+     * may return a {@link module:engine/model/documentfragment~ModelDocumentFragment} or a {@link module:engine/model/node~ModelNode}
      * that can be either a text node or an element. This method can be used to check what kind of object is returned.
      *
      * ```ts
@@ -50,9 +50,9 @@ export default abstract class TypeCheckable {
      *
      * @label NODE
      */
-    is(type: 'node' | 'model:node'): this is Node | Element | Text | RootElement;
+    is(type: 'node' | 'model:node'): this is ModelNode | ModelElement | ModelText | ModelRootElement;
     /**
-     * Checks whether the object is of type {@link module:engine/model/element~Element} or its subclass.
+     * Checks whether the object is of type {@link module:engine/model/element~ModelElement} or its subclass.
      *
      * ```ts
      * element.is( 'element' ); // -> true
@@ -65,7 +65,7 @@ export default abstract class TypeCheckable {
      * ```
      *
      * Assuming that the object being checked is an element, you can also check its
-     * {@link module:engine/model/element~Element#name name}:
+     * {@link module:engine/model/element~ModelElement#name name}:
      *
      * ```ts
      * element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
@@ -74,9 +74,9 @@ export default abstract class TypeCheckable {
      *
      * @label ELEMENT
      */
-    is(type: 'element' | 'model:element'): this is Element | RootElement;
+    is(type: 'element' | 'model:element'): this is ModelElement | ModelRootElement;
     /**
-     * Checks whether the object is of type {@link module:engine/model/rootelement~RootElement}.
+     * Checks whether the object is of type {@link module:engine/model/rootelement~ModelRootElement}.
      *
      * ```ts
      * rootElement.is( 'rootElement' ); // -> true
@@ -91,7 +91,7 @@ export default abstract class TypeCheckable {
      * ```
      *
      * Assuming that the object being checked is an element, you can also check its
-     * {@link module:engine/model/element~Element#name name}:
+     * {@link module:engine/model/element~ModelElement#name name}:
      *
      * ```ts
      * rootElement.is( 'rootElement', '$root' ); // -> same as above
@@ -99,9 +99,9 @@ export default abstract class TypeCheckable {
      *
      * @label ROOT_ELEMENT
      */
-    is(type: 'rootElement' | 'model:rootElement'): this is RootElement;
+    is(type: 'rootElement' | 'model:rootElement'): this is ModelRootElement;
     /**
-     * Checks whether the object is of type {@link module:engine/model/text~Text}.
+     * Checks whether the object is of type {@link module:engine/model/text~ModelText}.
      *
      * ```ts
      * text.is( '$text' ); // -> true
@@ -118,9 +118,9 @@ export default abstract class TypeCheckable {
      *
      * @label TEXT
      */
-    is(type: '$text' | 'model:$text'): this is Text;
+    is(type: '$text' | 'model:$text'): this is ModelText;
     /**
-     * Checks whether the object is of type {@link module:engine/model/position~Position} or its subclass.
+     * Checks whether the object is of type {@link module:engine/model/position~ModelPosition} or its subclass.
      *
      * ```ts
      * position.is( 'position' ); // -> true
@@ -132,9 +132,9 @@ export default abstract class TypeCheckable {
      *
      * @label POSITION
      */
-    is(type: 'position' | 'model:position'): this is Position | LivePosition;
+    is(type: 'position' | 'model:position'): this is ModelPosition | ModelLivePosition;
     /**
-     * Checks whether the object is of type {@link module:engine/model/liveposition~LivePosition}.
+     * Checks whether the object is of type {@link module:engine/model/liveposition~ModelLivePosition}.
      *
      * ```ts
      * livePosition.is( 'position' ); // -> true
@@ -148,9 +148,9 @@ export default abstract class TypeCheckable {
      *
      * @label LIVE_POSITION
      */
-    is(type: 'livePosition' | 'model:livePosition'): this is LivePosition;
+    is(type: 'livePosition' | 'model:livePosition'): this is ModelLivePosition;
     /**
-     * Checks whether the object is of type {@link module:engine/model/range~Range} or its subclass.
+     * Checks whether the object is of type {@link module:engine/model/range~ModelRange} or its subclass.
      *
      * ```ts
      * range.is( 'range' ); // -> true
@@ -162,9 +162,9 @@ export default abstract class TypeCheckable {
      *
      * @label RANGE
      */
-    is(type: 'range' | 'model:range'): this is Range | LiveRange;
+    is(type: 'range' | 'model:range'): this is ModelRange | ModelLiveRange;
     /**
-     * Checks whether the object is of type {@link module:engine/model/liverange~LiveRange}.
+     * Checks whether the object is of type {@link module:engine/model/liverange~ModelLiveRange}.
      *
      * ```ts
      * liveRange.is( 'range' ); // -> true
@@ -178,9 +178,9 @@ export default abstract class TypeCheckable {
      *
      * @label LIVE_RANGE
      */
-    is(type: 'liveRange' | 'model:liveRange'): this is LiveRange;
+    is(type: 'liveRange' | 'model:liveRange'): this is ModelLiveRange;
     /**
-     * Checks whether the object is of type {@link module:engine/model/documentfragment~DocumentFragment}.
+     * Checks whether the object is of type {@link module:engine/model/documentfragment~ModelDocumentFragment}.
      *
      * ```ts
      * docFrag.is( 'documentFragment' ); // -> true
@@ -193,10 +193,10 @@ export default abstract class TypeCheckable {
      *
      * @label DOCUMENT_FRAGMENT
      */
-    is(type: 'documentFragment' | 'model:documentFragment'): this is DocumentFragment;
+    is(type: 'documentFragment' | 'model:documentFragment'): this is ModelDocumentFragment;
     /**
-     * Checks whether the object is of type {@link module:engine/model/selection~Selection}
-     * or {@link module:engine/model/documentselection~DocumentSelection}.
+     * Checks whether the object is of type {@link module:engine/model/selection~ModelSelection}
+     * or {@link module:engine/model/documentselection~ModelDocumentSelection}.
      *
      * ```ts
      * selection.is( 'selection' ); // -> true
@@ -208,9 +208,9 @@ export default abstract class TypeCheckable {
      *
      * @label SELECTION
      */
-    is(type: 'selection' | 'model:selection'): this is Selection | DocumentSelection;
+    is(type: 'selection' | 'model:selection'): this is ModelSelection | ModelDocumentSelection;
     /**
-     * Checks whether the object is of type {@link module:engine/model/documentselection~DocumentSelection}.
+     * Checks whether the object is of type {@link module:engine/model/documentselection~ModelDocumentSelection}.
      *
      * ```ts
      * selection.is( 'selection' ); // -> true
@@ -225,7 +225,7 @@ export default abstract class TypeCheckable {
      *
      * @label DOCUMENT_SELECTION
      */
-    is(type: 'documentSelection' | 'model:documentSelection'): this is DocumentSelection;
+    is(type: 'documentSelection' | 'model:documentSelection'): this is ModelDocumentSelection;
     /**
      * Checks whether the object is of type {@link module:engine/model/markercollection~Marker}.
      *
@@ -241,7 +241,7 @@ export default abstract class TypeCheckable {
      */
     is(type: 'marker' | 'model:marker'): this is Marker;
     /**
-     * Checks whether the object is of type {@link module:engine/model/textproxy~TextProxy}.
+     * Checks whether the object is of type {@link module:engine/model/textproxy~ModelTextProxy}.
      *
      * ```ts
      * textProxy.is( '$textProxy' ); // -> true
@@ -256,9 +256,9 @@ export default abstract class TypeCheckable {
      *
      * @label TEXT_PROXY
      */
-    is(type: '$textProxy' | 'model:$textProxy'): this is TextProxy;
+    is(type: '$textProxy' | 'model:$textProxy'): this is ModelTextProxy;
     /**
-     * Checks whether the object is of type {@link module:engine/model/element~Element} or its subclass and has the specified `name`.
+     * Checks whether the object is of type {@link module:engine/model/element~ModelElement} or its subclass and has the specified `name`.
      *
      * ```ts
      * element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
@@ -267,11 +267,11 @@ export default abstract class TypeCheckable {
      *
      * @label ELEMENT_NAME
      */
-    is<N extends string>(type: 'element' | 'model:element', name: N): this is (Element | RootElement) & {
+    is<N extends string>(type: 'element' | 'model:element', name: N): this is (ModelElement | ModelRootElement) & {
         name: N;
     };
     /**
-     * Checks whether the object is of type {@link module:engine/model/rootelement~RootElement} and has the specified `name`.
+     * Checks whether the object is of type {@link module:engine/model/rootelement~ModelRootElement} and has the specified `name`.
      *
      * ```ts
      * rootElement.is( 'rootElement', '$root' );
@@ -279,7 +279,7 @@ export default abstract class TypeCheckable {
      *
      * @label ROOT_ELEMENT_NAME
      */
-    is<N extends string>(type: 'rootElement' | 'model:rootElement', name: N): this is RootElement & {
+    is<N extends string>(type: 'rootElement' | 'model:rootElement', name: N): this is ModelRootElement & {
         name: N;
     };
 }

package/src/model/typecheckable.js

@@ -2,7 +2,7 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-export default class TypeCheckable {
+export class ModelTypeCheckable {
     /* istanbul ignore next -- @preserve */
     is() {
         // There are a lot of overloads above.

package/src/model/utils/autoparagraphing.d.ts

@@ -2,10 +2,10 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-import type Node from '../node.js';
-import type Position from '../position.js';
-import type Schema from '../schema.js';
-import type Writer from '../writer.js';
+import { type ModelNode } from '../node.js';
+import { type ModelPosition } from '../position.js';
+import { type ModelSchema } from '../schema.js';
+import { type ModelWriter } from '../writer.js';
 /**
  * @module engine/model/utils/autoparagraphing
  */
@@ -16,7 +16,7 @@ import type Writer from '../writer.js';
  * @param writer The model writer.
  * @returns `true` if any change has been applied, `false` otherwise.
  */
-export declare function autoParagraphEmptyRoots(writer: Writer): boolean;
+export declare function autoParagraphEmptyRoots(writer: ModelWriter): boolean;
 /**
  * Checks if the given node wrapped with a paragraph would be accepted by the schema in the given position.
  *
@@ -25,7 +25,7 @@ export declare function autoParagraphEmptyRoots(writer: Writer): boolean;
  * @param nodeOrType The child node or child type to check.
  * @param schema A schema instance used for element validation.
  */
-export declare function isParagraphable(position: Position, nodeOrType: Node | string, schema: Schema): boolean;
+export declare function isParagraphable(position: ModelPosition, nodeOrType: ModelNode | string, schema: ModelSchema): boolean;
 /**
  * Inserts a new paragraph at the given position and returns a position inside that paragraph.
  *
@@ -34,4 +34,4 @@ export declare function isParagraphable(position: Position, nodeOrType: Node | s
  * @param writer The model writer.
  * @returns  Position inside the created paragraph.
  */
-export declare function wrapInParagraph(position: Position, writer: Writer): Position;
+export declare function wrapInParagraph(position: ModelPosition, writer: ModelWriter): ModelPosition;

package/src/model/utils/deletecontent.d.ts

@@ -5,9 +5,9 @@
 /**
  * @module engine/model/utils/deletecontent
  */
-import DocumentSelection from '../documentselection.js';
-import type Model from '../model.js';
-import type Selection from '../selection.js';
+import { ModelDocumentSelection } from '../documentselection.js';
+import { type Model } from '../model.js';
+import { type ModelSelection } from '../selection.js';
 /**
  * Deletes content of the selection and merge siblings. The resulting selection is always collapsed.
  *
@@ -25,7 +25,7 @@ import type Selection from '../selection.js';
  * * `<heading>x^y</heading>` with the option disabled (`leaveUnmerged == false`)
  * * `<heading>x^</heading><paragraph>y</paragraph>` with enabled (`leaveUnmerged == true`).
  *
- * Note: {@link module:engine/model/schema~Schema#isObject object} and {@link module:engine/model/schema~Schema#isLimit limit}
+ * Note: {@link module:engine/model/schema~ModelSchema#isObject object} and {@link module:engine/model/schema~ModelSchema#isLimit limit}
  * elements will not be merged.
  *
  * @param options.doNotResetEntireContent Whether to skip replacing the entire content with a
@@ -62,8 +62,10 @@ import type Selection from '../selection.js';
  *
  * However, in some cases, it is expected to remove content exactly as selected in the selection, without any fixing. In these cases,
  * this flag can be set to `true`, which will prevent fixing the selection.
+ *
+ * @internal
  */
-export default function deleteContent(model: Model, selection: Selection | DocumentSelection, options?: {
+export declare function deleteContent(model: Model, selection: ModelSelection | ModelDocumentSelection, options?: {
     leaveUnmerged?: boolean;
     doNotResetEntireContent?: boolean;
     doNotAutoparagraph?: boolean;

package/src/model/utils/deletecontent.js

@@ -5,9 +5,9 @@
 /**
  * @module engine/model/utils/deletecontent
  */
-import DocumentSelection from '../documentselection.js';
-import LivePosition from '../liveposition.js';
-import Range from '../range.js';
+import { ModelDocumentSelection } from '../documentselection.js';
+import { ModelLivePosition } from '../liveposition.js';
+import { ModelRange } from '../range.js';
 /**
  * Deletes content of the selection and merge siblings. The resulting selection is always collapsed.
  *
@@ -25,7 +25,7 @@ import Range from '../range.js';
  * * `<heading>x^y</heading>` with the option disabled (`leaveUnmerged == false`)
  * * `<heading>x^</heading><paragraph>y</paragraph>` with enabled (`leaveUnmerged == true`).
  *
- * Note: {@link module:engine/model/schema~Schema#isObject object} and {@link module:engine/model/schema~Schema#isLimit limit}
+ * Note: {@link module:engine/model/schema~ModelSchema#isObject object} and {@link module:engine/model/schema~ModelSchema#isLimit limit}
  * elements will not be merged.
  *
  * @param options.doNotResetEntireContent Whether to skip replacing the entire content with a
@@ -62,8 +62,10 @@ import Range from '../range.js';
  *
  * However, in some cases, it is expected to remove content exactly as selected in the selection, without any fixing. In these cases,
  * this flag can be set to `true`, which will prevent fixing the selection.
+ *
+ * @internal
  */
-export default function deleteContent(model, selection, options = {}) {
+export function deleteContent(model, selection, options = {}) {
     if (selection.isCollapsed) {
         return;
     }
@@ -94,8 +96,8 @@ export default function deleteContent(model, selection, options = {}) {
             [startPosition, endPosition] = getLivePositionsForSelectedBlocks(selRange);
         }
         else {
-            startPosition = LivePosition.fromPosition(selRange.start, 'toPrevious');
-            endPosition = LivePosition.fromPosition(selRange.end, 'toNext');
+            startPosition = ModelLivePosition.fromPosition(selRange.start, 'toPrevious');
+            endPosition = ModelLivePosition.fromPosition(selRange.end, 'toNext');
         }
         // 2. Remove the content if there is any.
         if (!startPosition.isTouching(endPosition)) {
@@ -170,8 +172,8 @@ function getLivePositionsForSelectedBlocks(range) {
         }
     }
     return [
-        LivePosition.fromPosition(startPosition, 'toPrevious'),
-        LivePosition.fromPosition(endPosition, 'toNext')
+        ModelLivePosition.fromPosition(startPosition, 'toPrevious'),
+        ModelLivePosition.fromPosition(endPosition, 'toNext')
     ];
 }
 /**
@@ -457,7 +459,7 @@ function shouldAutoparagraph(schema, position) {
  * Usually, widget and caption are marked as objects/limits in the schema, so in this case merging will be blocked.
  */
 function isCrossingLimitElement(leftPos, rightPos, schema) {
-    const rangeToCheck = new Range(leftPos, rightPos);
+    const rangeToCheck = new ModelRange(leftPos, rightPos);
     for (const value of rangeToCheck.getWalker()) {
         if (schema.isLimit(value.item)) {
             return false;
@@ -498,7 +500,7 @@ function shouldEntireContentBeReplacedWithParagraph(schema, selection) {
  * uses a different method to set it.
  */
 function collapseSelectionAt(writer, selection, positionOrRange) {
-    if (selection instanceof DocumentSelection) {
+    if (selection instanceof ModelDocumentSelection) {
         writer.setSelection(positionOrRange);
     }
     else {

package/src/model/utils/getselectedcontent.d.ts

@@ -2,10 +2,10 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-import type DocumentFragment from '../documentfragment.js';
-import type DocumentSelection from '../documentselection.js';
-import type Model from '../model.js';
-import type Selection from '../selection.js';
+import { type ModelDocumentFragment } from '../documentfragment.js';
+import { type ModelDocumentSelection } from '../documentselection.js';
+import { type Model } from '../model.js';
+import { type ModelSelection } from '../selection.js';
 /**
  * @module engine/model/utils/getselectedcontent
  */
@@ -26,5 +26,6 @@ import type Selection from '../selection.js';
  *
  * @param model The model in context of which the selection modification should be performed.
  * @param selection The selection of which content will be returned.
+ * @internal
  */
-export default function getSelectedContent(model: Model, selection: Selection | DocumentSelection): DocumentFragment;
+export declare function getSelectedContent(model: Model, selection: ModelSelection | ModelDocumentSelection): ModelDocumentFragment;

package/src/model/utils/getselectedcontent.js

@@ -22,8 +22,9 @@
  *
  * @param model The model in context of which the selection modification should be performed.
  * @param selection The selection of which content will be returned.
+ * @internal
  */
-export default function getSelectedContent(model, selection) {
+export function getSelectedContent(model, selection) {
     return model.change(writer => {
         const frag = writer.createDocumentFragment();
         const range = selection.getFirstRange();

package/src/model/utils/insertcontent.d.ts

@@ -5,12 +5,12 @@
 /**
  * @module engine/model/utils/insertcontent
  */
-import DocumentSelection from '../documentselection.js';
-import Range from '../range.js';
-import type DocumentFragment from '../documentfragment.js';
-import type Item from '../item.js';
-import type Model from '../model.js';
-import type Selection from '../selection.js';
+import { ModelDocumentSelection } from '../documentselection.js';
+import { ModelRange } from '../range.js';
+import { type ModelDocumentFragment } from '../documentfragment.js';
+import { type ModelItem } from '../item.js';
+import { type Model } from '../model.js';
+import { type ModelSelection } from '../selection.js';
 /**
  * Inserts content into the editor (specified selection) as one would expect the paste functionality to work.
  *
@@ -26,7 +26,7 @@ import type Selection from '../selection.js';
  * <p>x</p>[<img />]<p>z</p> + <p>y</p> => <p>x</p>^<p>z</p> + <p>y</p> => <p>x</p><p>y[]</p><p>z</p>
  * ```
  *
- * If an instance of {@link module:engine/model/selection~Selection} is passed as `selectable` it will be modified
+ * If an instance of {@link module:engine/model/selection~ModelSelection} is passed as `selectable` it will be modified
  * to the insertion selection (equal to a range to be selected after insertion).
  *
  * If `selectable` is not passed, the content will be inserted using the current selection of the model document.
@@ -41,5 +41,6 @@ import type Selection from '../selection.js';
  * @returns Range which contains all the performed changes. This is a range that, if removed,
  * would return the model to the state before the insertion. If no changes were preformed by `insertContent`, returns a range collapsed
  * at the insertion position.
+ * @internal
  */
-export default function insertContent(model: Model, content: Item | DocumentFragment, selectable?: Selection | DocumentSelection): Range;
+export declare function insertContent(model: Model, content: ModelItem | ModelDocumentFragment, selectable?: ModelSelection | ModelDocumentSelection): ModelRange;