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

package/src/view/textproxy.js

@@ -5,31 +5,32 @@
 /**
  * @module engine/view/textproxy
  */
-import TypeCheckable from './typecheckable.js';
+import { ViewTypeCheckable } from './typecheckable.js';
 import { CKEditorError } from '@ckeditor/ckeditor5-utils';
 /**
- * TextProxy is a wrapper for substring of {@link module:engine/view/text~Text}. Instance of this class is created by
- * {@link module:engine/view/treewalker~TreeWalker} when only a part of {@link module:engine/view/text~Text} needs to be returned.
+ * ViewTextProxy is a wrapper for substring of {@link module:engine/view/text~ViewText}. Instance of this class is created by
+ * {@link module:engine/view/treewalker~ViewTreeWalker} when only a part of {@link module:engine/view/text~ViewText} needs to be returned.
  *
- * `TextProxy` has an API similar to {@link module:engine/view/text~Text Text} and allows to do most of the common tasks performed
+ * `ViewTextProxy` has an API similar to {@link module:engine/view/text~ViewText Text} and allows to do most of the common tasks performed
  * on view nodes.
  *
- * **Note:** Some `TextProxy` instances may represent whole text node, not just a part of it.
- * See {@link module:engine/view/textproxy~TextProxy#isPartial}.
+ * **Note:** Some `ViewTextProxy` instances may represent whole text node, not just a part of it.
+ * See {@link module:engine/view/textproxy~ViewTextProxy#isPartial}.
  *
- * **Note:** `TextProxy` is a readonly interface.
+ * **Note:** `ViewTextProxy` is a readonly interface.
  *
- * **Note:** `TextProxy` instances are created on the fly basing on the current state of parent {@link module:engine/view/text~Text}.
+ * **Note:** `ViewTextProxy` instances are created on the fly basing
+ * on the current state of parent {@link module:engine/view/text~ViewText}.
  * Because of this it is highly unrecommended to store references to `TextProxy instances because they might get
- * invalidated due to operations on Document. Also TextProxy is not a {@link module:engine/view/node~Node} so it cannot be
- * inserted as a child of {@link module:engine/view/element~Element}.
+ * invalidated due to operations on Document. Also ViewTextProxy is not a {@link module:engine/view/node~ViewNode} so it cannot be
+ * inserted as a child of {@link module:engine/view/element~ViewElement}.
  *
- * `TextProxy` instances are created by {@link module:engine/view/treewalker~TreeWalker view tree walker}. You should not need to create
- * an instance of this class by your own.
+ * `ViewTextProxy` instances are created by {@link module:engine/view/treewalker~ViewTreeWalker view tree walker}.
+ * You should not need to create an instance of this class by your own.
  */
-export default class TextProxy extends TypeCheckable {
+export class ViewTextProxy extends ViewTypeCheckable {
     /**
-     * Reference to the {@link module:engine/view/text~Text} element which TextProxy is a substring.
+     * Reference to the {@link module:engine/view/text~ViewText} element which ViewTextProxy is a substring.
      */
     textNode;
     /**
@@ -37,7 +38,7 @@ export default class TextProxy extends TypeCheckable {
      */
     data;
     /**
-     * Offset in the `textNode` where this `TextProxy` instance starts.
+     * Offset in the `textNode` where this `ViewTextProxy` instance starts.
      */
     offsetInText;
     /**
@@ -45,7 +46,7 @@ export default class TextProxy extends TypeCheckable {
      *
      * @internal
      * @param textNode Text node which part is represented by this text proxy.
-     * @param offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#textNode text node}
+     * @param offsetInText Offset in {@link module:engine/view/textproxy~ViewTextProxy#textNode text node}
      * from which the text proxy starts.
      * @param length Text proxy length, that is how many text node's characters, starting from `offsetInText` it represents.
      */
@@ -78,11 +79,11 @@ export default class TextProxy extends TypeCheckable {
         return this.data.length;
     }
     /**
-     * Flag indicating whether `TextProxy` instance covers only part of the original {@link module:engine/view/text~Text text node}
+     * Flag indicating whether `ViewTextProxy` instance covers only part of the original {@link module:engine/view/text~ViewText text node}
      * (`true`) or the whole text node (`false`).
      *
-     * This is `false` when text proxy starts at the very beginning of {@link module:engine/view/textproxy~TextProxy#textNode textNode}
-     * ({@link module:engine/view/textproxy~TextProxy#offsetInText offsetInText} equals `0`) and text proxy sizes is equal to
+     * This is `false` when text proxy starts at the very beginning of {@link module:engine/view/textproxy~ViewTextProxy#textNode textNode}
+     * ({@link module:engine/view/textproxy~ViewTextProxy#offsetInText offsetInText} equals `0`) and text proxy sizes is equal to
      * text node size.
      */
     get isPartial() {
@@ -101,8 +102,8 @@ export default class TextProxy extends TypeCheckable {
         return this.textNode.root;
     }
     /**
-     * {@link module:engine/view/document~Document View document} that owns this text proxy, or `null` if the text proxy is inside
-     * {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
+     * {@link module:engine/view/document~ViewDocument View document} that owns this text proxy, or `null` if the text proxy is inside
+     * {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment}.
      */
     get document() {
         return this.textNode.document;
@@ -128,7 +129,7 @@ export default class TextProxy extends TypeCheckable {
 }
 // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
 // Proper overload would interfere with that.
-TextProxy.prototype.is = function (type) {
+ViewTextProxy.prototype.is = function (type) {
     return type === '$textProxy' || type === 'view:$textProxy' ||
         // This are legacy values kept for backward compatibility.
         type === 'textProxy' || type === 'view:textProxy';

package/src/view/tokenlist.d.ts

@@ -6,11 +6,11 @@
  * @module engine/view/tokenlist
  */
 import { type ArrayOrItem } from '@ckeditor/ckeditor5-utils';
-import type { ElementAttributeValue } from './element.js';
+import type { ViewElementAttributeValue } from './element.js';
 /**
  * Token list. Allows handling (adding, removing, retrieving) a set of tokens (for example class names).
  */
-export default class TokenList implements ElementAttributeValue {
+export declare class ViewTokenList implements ViewElementAttributeValue {
     /**
      * The set of tokens.
      */
@@ -54,7 +54,7 @@ export default class TokenList implements ElementAttributeValue {
     /**
      * Returns `true` if both attributes have the same tokens.
      */
-    isSimilar(other: TokenList): boolean;
+    isSimilar(other: ViewTokenList): boolean;
     /**
      * Clones the attribute value.
      *
@@ -78,32 +78,32 @@ export default class TokenList implements ElementAttributeValue {
      */
     _getConsumables(name?: string): Array<string>;
     /**
-     * Used by {@link module:engine/view/element~Element#_canMergeAttributesFrom} to verify if the given attribute
+     * Used by {@link module:engine/view/element~ViewElement#_canMergeAttributesFrom} to verify if the given attribute
      * can be merged without conflicts into the attribute.
      *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~DowncastWriter} while downcasting
-     * an {@link module:engine/view/attributeelement~AttributeElement} to merge it with other `AttributeElement`.
+     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while downcasting
+     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other `AttributeElement`.
      *
      * @internal
      */
     _canMergeFrom(): boolean;
     /**
-     * Used by {@link module:engine/view/element~Element#_mergeAttributesFrom} to merge a given attribute into the attribute.
+     * Used by {@link module:engine/view/element~ViewElement#_mergeAttributesFrom} to merge a given attribute into the attribute.
      *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~DowncastWriter} while down-casting
-     * an {@link module:engine/view/attributeelement~AttributeElement} to merge it with other AttributeElement.
+     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
+     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other ViewAttributeElement.
      *
      * @internal
      */
-    _mergeFrom(other: TokenList): void;
+    _mergeFrom(other: ViewTokenList): void;
     /**
-     * Used by {@link module:engine/view/element~Element#_canSubtractAttributesOf} to verify if the given attribute
+     * Used by {@link module:engine/view/element~ViewElement#_canSubtractAttributesOf} to verify if the given attribute
      * can be fully subtracted from the attribute.
      *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~DowncastWriter} while down-casting
-     * an {@link module:engine/view/attributeelement~AttributeElement} to unwrap the AttributeElement.
+     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
+     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to unwrap the ViewAttributeElement.
      *
      * @internal
      */
-    _isMatching(other: TokenList): boolean;
+    _isMatching(other: ViewTokenList): boolean;
 }

package/src/view/tokenlist.js

@@ -9,7 +9,7 @@ import { toArray } from '@ckeditor/ckeditor5-utils';
 /**
  * Token list. Allows handling (adding, removing, retrieving) a set of tokens (for example class names).
  */
-export default class TokenList {
+export class ViewTokenList {
     /**
      * The set of tokens.
      */
@@ -148,11 +148,11 @@ export default class TokenList {
         return name ? [name] : this.keys();
     }
     /**
-     * Used by {@link module:engine/view/element~Element#_canMergeAttributesFrom} to verify if the given attribute
+     * Used by {@link module:engine/view/element~ViewElement#_canMergeAttributesFrom} to verify if the given attribute
      * can be merged without conflicts into the attribute.
      *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~DowncastWriter} while downcasting
-     * an {@link module:engine/view/attributeelement~AttributeElement} to merge it with other `AttributeElement`.
+     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while downcasting
+     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other `AttributeElement`.
      *
      * @internal
      */
@@ -160,10 +160,10 @@ export default class TokenList {
         return true;
     }
     /**
-     * Used by {@link module:engine/view/element~Element#_mergeAttributesFrom} to merge a given attribute into the attribute.
+     * Used by {@link module:engine/view/element~ViewElement#_mergeAttributesFrom} to merge a given attribute into the attribute.
      *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~DowncastWriter} while down-casting
-     * an {@link module:engine/view/attributeelement~AttributeElement} to merge it with other AttributeElement.
+     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
+     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other ViewAttributeElement.
      *
      * @internal
      */
@@ -175,11 +175,11 @@ export default class TokenList {
         }
     }
     /**
-     * Used by {@link module:engine/view/element~Element#_canSubtractAttributesOf} to verify if the given attribute
+     * Used by {@link module:engine/view/element~ViewElement#_canSubtractAttributesOf} to verify if the given attribute
      * can be fully subtracted from the attribute.
      *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~DowncastWriter} while down-casting
-     * an {@link module:engine/view/attributeelement~AttributeElement} to unwrap the AttributeElement.
+     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
+     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to unwrap the ViewAttributeElement.
      *
      * @internal
      */

package/src/view/treewalker.d.ts

@@ -2,17 +2,17 @@
  * @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 Position from './position.js';
-import type Item from './item.js';
-import type Range from './range.js';
+import { ViewPosition } from './position.js';
+import { type ViewItem } from './item.js';
+import { type ViewRange } from './range.js';
 /**
  * Position iterator class. It allows to iterate forward and backward over the document.
  */
-export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
+export declare class ViewTreeWalker implements IterableIterator<ViewTreeWalkerValue> {
     /**
      * Walking direction. Defaults `'forward'`.
      */
-    readonly direction: TreeWalkerDirection;
+    readonly direction: ViewTreeWalkerDirection;
     /**
      * Iterator boundaries.
      *
@@ -21,10 +21,10 @@ export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
      *
      * If boundaries are not defined they are set before first and after last child of the root node.
      */
-    readonly boundaries: Range | null;
+    readonly boundaries: ViewRange | null;
     /**
-     * Flag indicating whether all characters from {@link module:engine/view/text~Text} should be returned as one
-     * {@link module:engine/view/text~Text} or one by one as {@link module:engine/view/textproxy~TextProxy}.
+     * Flag indicating whether all characters from {@link module:engine/view/text~ViewText} should be returned as one
+     * {@link module:engine/view/text~ViewText} or one by one as {@link module:engine/view/textproxy~ViewTextProxy}.
      */
     readonly singleCharacters: boolean;
     /**
@@ -34,7 +34,7 @@ export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
     readonly shallow: boolean;
     /**
      * Flag indicating whether iterator should ignore `elementEnd` tags. If set to `true`, walker will not
-     * return a parent node of the start position. Each {@link module:engine/view/element~Element} will be returned once.
+     * return a parent node of the start position. Each {@link module:engine/view/element~ViewElement} will be returned once.
      * When set to `false` each element might be returned twice: for `'elementStart'` and `'elementEnd'`.
      */
     readonly ignoreElementEnd: boolean;
@@ -56,16 +56,16 @@ export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
      *
      * @param options Object with configuration.
      */
-    constructor(options?: TreeWalkerOptions);
+    constructor(options?: ViewTreeWalkerOptions);
     /**
      * Iterable interface.
      */
-    [Symbol.iterator](): IterableIterator<TreeWalkerValue>;
+    [Symbol.iterator](): IterableIterator<ViewTreeWalkerValue>;
     /**
      * Iterator position. If start position is not defined then position depends on {@link #direction}. If direction is
      * `'forward'` position starts form the beginning, when direction is `'backward'` position starts from the end.
      */
-    get position(): Position;
+    get position(): ViewPosition;
     /**
      * Moves {@link #position} in the {@link #direction} skipping values as long as the callback function returns `true`.
      *
@@ -77,17 +77,17 @@ export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
      * walker.skip( value => false ); // Do not move the position.
      * ```
      *
-     * @param skip Callback function. Gets {@link module:engine/view/treewalker~TreeWalkerValue} and should
+     * @param skip Callback function. Gets {@link module:engine/view/treewalker~ViewTreeWalkerValue} and should
      * return `true` if the value should be skipped or `false` if not.
      */
-    skip(skip: (value: TreeWalkerValue) => boolean): void;
+    skip(skip: (value: ViewTreeWalkerValue) => boolean): void;
     /**
      * Moves tree walker {@link #position} to provided `position`. Tree walker will
      * continue traversing from that position.
      *
-     * Note: in contrary to {@link ~TreeWalker#skip}, this method does not iterate over the nodes along the way.
+     * Note: in contrary to {@link ~ViewTreeWalker#skip}, this method does not iterate over the nodes along the way.
      * It simply sets the current tree walker position to a new one.
-     * From the performance standpoint, it is better to use {@link ~TreeWalker#jumpTo} rather than {@link ~TreeWalker#skip}.
+     * From the performance standpoint, it is better to use {@link ~ViewTreeWalker#jumpTo} rather than {@link ~ViewTreeWalker#skip}.
      *
      * If the provided position is before the start boundary, the position will be
      * set to the start boundary. If the provided position is after the end boundary,
@@ -96,14 +96,14 @@ export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
      *
      * @param position Position to jump to.
      */
-    jumpTo(position: Position): void;
+    jumpTo(position: ViewPosition): void;
     /**
      * Gets the next tree walker's value.
      *
      * @returns Object implementing iterator interface, returning
      * information about taken step.
      */
-    next(): IteratorResult<TreeWalkerValue, undefined>;
+    next(): IteratorResult<ViewTreeWalkerValue, undefined>;
     /**
      * Makes a step forward in view. Moves the {@link #position} to the next position and returns the encountered value.
      */
@@ -113,7 +113,8 @@ export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
      */
     private _previous;
     /**
-     * Format returned data and adjust `previousPosition` and `nextPosition` if reach the bound of the {@link module:engine/view/text~Text}.
+     * Format returned data and adjust `previousPosition` and `nextPosition` if
+     * reach the bound of the {@link module:engine/view/text~ViewText}.
      *
      * @param type Type of step.
      * @param item Item between old and new position.
@@ -124,44 +125,44 @@ export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
     private _formatReturnValue;
 }
 /**
- * Type of the step made by {@link module:engine/view/treewalker~TreeWalker}.
+ * Type of the step made by {@link module:engine/view/treewalker~ViewTreeWalker}.
  * Possible values: `'elementStart'` if walker is at the beginning of a node, `'elementEnd'` if walker is at the end
  * of node, or `'text'` if walker traversed over single and multiple characters.
- * For {@link module:engine/view/text~Text} `elementStart` and `elementEnd` is not returned.
+ * For {@link module:engine/view/text~ViewText} `elementStart` and `elementEnd` is not returned.
  */
-export type TreeWalkerValueType = 'elementStart' | 'elementEnd' | 'text';
+export type ViewTreeWalkerValueType = 'elementStart' | 'elementEnd' | 'text';
 /**
- * Object returned by {@link module:engine/view/treewalker~TreeWalker} when traversing tree view.
+ * Object returned by {@link module:engine/view/treewalker~ViewTreeWalker} when traversing tree view.
  */
-export interface TreeWalkerValue {
+export interface ViewTreeWalkerValue {
     /**
-     * Type of the step made by {@link module:engine/view/treewalker~TreeWalker}.
+     * Type of the step made by {@link module:engine/view/treewalker~ViewTreeWalker}.
      */
-    type: TreeWalkerValueType;
+    type: ViewTreeWalkerValueType;
     /**
      * Item between the old and the new positions of the tree walker.
      */
-    item: Item;
+    item: ViewItem;
     /**
      * Previous position of the iterator.
      * * Forward iteration: For `'elementEnd'` it is the last position inside the element. For all other types it is the
      * position before the item.
      * * Backward iteration: For `'elementStart'` it is the first position inside the element. For all other types it is
      * the position after item.
-     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~Text} it is always moved from the
+     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~ViewText} it is always moved from the
      * inside of the text to its parent just before or just after that text.
      */
-    previousPosition: Position;
+    previousPosition: ViewPosition;
     /**
      * Next position of the iterator.
      * * Forward iteration: For `'elementStart'` it is the first position inside the element. For all other types it is
      * the position after the item.
      * * Backward iteration: For `'elementEnd'` it is last position inside element. For all other types it is the position
      * before the item.
-     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~Text} it is always moved from the
+     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~ViewText} it is always moved from the
      * inside of the text to its parent just before or just after that text.
      */
-    nextPosition: Position;
+    nextPosition: ViewPosition;
     /**
      * Length of the item. For `'elementStart'` it is `1`. For `'text'` it is
      * the length of that text. For `'elementEnd'` it is `undefined`.
@@ -171,29 +172,30 @@ export interface TreeWalkerValue {
 /**
  * Tree walking direction.
  */
-export type TreeWalkerDirection = 'forward' | 'backward';
+export type ViewTreeWalkerDirection = 'forward' | 'backward';
 /**
- * The configuration of {@link ~TreeWalker}.
+ * The configuration of {@link ~ViewTreeWalker}.
  */
-export interface TreeWalkerOptions {
+export interface ViewTreeWalkerOptions {
     /**
      * Walking direction.
      *
      * @default 'forward'
      */
-    direction?: TreeWalkerDirection;
+    direction?: ViewTreeWalkerDirection;
     /**
      * Range to define boundaries of the iterator.
      */
-    boundaries?: Range | null;
+    boundaries?: ViewRange | null;
     /**
      * Starting position.
      */
-    startPosition?: Position;
+    startPosition?: ViewPosition;
     /**
      * Flag indicating whether all characters from
-     * {@link module:engine/view/text~Text} should be returned as one {@link module:engine/view/text~Text} (`false`) or one by one as
-     * {@link module:engine/view/textproxy~TextProxy} (`true`).
+     * {@link module:engine/view/text~ViewText} should be returned as one
+     * {@link module:engine/view/text~ViewText} (`false`) or one by one as
+     * {@link module:engine/view/textproxy~ViewTextProxy} (`true`).
      */
     singleCharacters?: boolean;
     /**
@@ -204,7 +206,7 @@ export interface TreeWalkerOptions {
     /**
      * Flag indicating whether iterator should ignore `elementEnd`
      * tags. If the option is true walker will not return a parent node of start position. If this option is `true`
-     * each {@link module:engine/view/element~Element} will be returned once, while if the option is `false` they might be returned
+     * each {@link module:engine/view/element~ViewElement} will be returned once, while if the option is `false` they might be returned
      * twice: for `'elementStart'` and `'elementEnd'`.
      */
     ignoreElementEnd?: boolean;