@ckeditor/ckeditor5-engine 36.0.1 → 37.0.0-alpha.1

package/src/view/documentfragment.js

@@ -20,90 +20,66 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
     /**
      * Creates new DocumentFragment instance.
      *
-     * @protected
-     * @param {module:engine/view/document~Document} document The document to which this document fragment belongs.
-     * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
-     * A list of nodes to be inserted into the created document fragment.
+     * @internal
+     * @param document The document to which this document fragment belongs.
+     * @param children A list of nodes to be inserted into the created document fragment.
      */
     constructor(document, children) {
         super();
-        /**
-         * The document to which this document fragment belongs.
-         *
-         * @readonly
-         * @member {module:engine/view/document~Document}
-         */
-        this.document = document;
         /**
          * Array of child nodes.
-         *
-         * @protected
-         * @member {Array.<module:engine/view/node~Node>} module:engine/view/documentfragment~DocumentFragment#_children
          */
         this._children = [];
-        if (children) {
-            this._insertChild(0, children);
-        }
         /**
          * Map of custom properties.
          * Custom properties can be added to document fragment instance.
-         *
-         * @protected
-         * @member {Map}
          */
         this._customProperties = new Map();
+        this.document = document;
+        if (children) {
+            this._insertChild(0, children);
+        }
     }
     /**
      * Iterable interface.
      *
      * Iterates over nodes added to this document fragment.
-     *
-     * @returns {Iterable.<module:engine/view/node~Node>}
      */
     [Symbol.iterator]() {
         return this._children[Symbol.iterator]();
     }
     /**
      * Number of child nodes in this document fragment.
-     *
-     * @readonly
-     * @type {Number}
      */
     get childCount() {
         return this._children.length;
     }
     /**
      * Is `true` if there are no nodes inside this document fragment, `false` otherwise.
-     *
-     * @readonly
-     * @type {Boolean}
      */
     get isEmpty() {
         return this.childCount === 0;
     }
     /**
      * Artificial root of `DocumentFragment`. Returns itself. Added for compatibility reasons.
-     *
-     * @readonly
-     * @type {module:engine/model/documentfragment~DocumentFragment}
      */
     get root() {
         return this;
     }
     /**
      * Artificial parent of `DocumentFragment`. Returns `null`. Added for compatibility reasons.
-     *
-     * @readonly
-     * @type {null}
      */
     get parent() {
         return null;
     }
+    /**
+     * Artificial element name. Returns `undefined`. Added for compatibility reasons.
+     */
+    get name() {
+        return undefined;
+    }
     /**
      * Returns the custom property value for the given key.
-     *
-     * @param {String|Symbol} key
-     * @returns {*}
      */
     getCustomProperty(key) {
         return this._customProperties.get(key);
@@ -111,8 +87,6 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
     /**
      * Returns an iterator which iterates over this document fragment's custom properties.
      * Iterator provides `[ key, value ]` pairs for each stored property.
-     *
-     * @returns {Iterable.<*>}
      */
     *getCustomProperties() {
         yield* this._customProperties.entries();
@@ -121,8 +95,9 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
      * {@link module:engine/view/documentfragment~DocumentFragment#_insertChild Insert} a child node or a list of child nodes at the end
      * and sets the parent of these nodes to this fragment.
      *
-     * @param {module:engine/view/item~Item|Iterable.<module:engine/view/item~Item>} items Items to be inserted.
-     * @returns {Number} Number of appended nodes.
+     * @internal
+     * @param items Items to be inserted.
+     * @returns Number of appended nodes.
      */
     _appendChild(items) {
         return this._insertChild(this.childCount, items);
@@ -130,8 +105,8 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
     /**
      * Gets child at the given index.
      *
-     * @param {Number} index Index of child.
-     * @returns {module:engine/view/node~Node} Child node.
+     * @param index Index of child.
+     * @returns Child node.
      */
     getChild(index) {
         return this._children[index];
@@ -139,8 +114,8 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
     /**
      * Gets index of the given child node. Returns `-1` if child node is not found.
      *
-     * @param {module:engine/view/node~Node} node Child node.
-     * @returns {Number} Index of the child node.
+     * @param node Child node.
+     * @returns Index of the child node.
      */
     getChildIndex(node) {
         return this._children.indexOf(node);
@@ -148,7 +123,7 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
     /**
      * Gets child nodes iterator.
      *
-     * @returns {Iterable.<module:engine/view/node~Node>} Child nodes iterator.
+     * @returns Child nodes iterator.
      */
     getChildren() {
         return this._children[Symbol.iterator]();
@@ -157,9 +132,10 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
      * Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to
      * this fragment.
      *
-     * @param {Number} index Position where nodes should be inserted.
-     * @param {module:engine/view/item~Item|Iterable.<module:engine/view/item~Item>} items Items to be inserted.
-     * @returns {Number} Number of inserted nodes.
+     * @internal
+     * @param index Position where nodes should be inserted.
+     * @param items Items to be inserted.
+     * @returns Number of inserted nodes.
      */
     _insertChild(index, items) {
         this._fireChange('children', this);
@@ -181,9 +157,9 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
      * Removes number of child nodes starting at the given index and set the parent of these nodes to `null`.
      *
      * @internal
-     * @param {Number} index Number of the first node to remove.
-     * @param {Number} [howMany=1] Number of nodes to remove.
-     * @returns {Array.<module:engine/view/node~Node>} The array of removed nodes.
+     * @param index Number of the first node to remove.
+     * @param howMany Number of nodes to remove.
+     * @returns The array of removed nodes.
      */
     _removeChildren(index, howMany = 1) {
         this._fireChange('children', this);
@@ -195,10 +171,9 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
     /**
      * Fires `change` event with given type of the change.
      *
-     * @private
-     * @param {module:engine/view/document~ChangeType} type Type of the change.
-     * @param {module:engine/view/node~Node} node Changed node.
-     * @fires module:engine/view/node~Node#change
+     * @internal
+     * @param type Type of the change.
+     * @param node Changed node.
      */
     _fireChange(type, node) {
         this.fire('change:' + type, node);
@@ -207,9 +182,7 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
      * Sets a custom property. They can be used to add special data to elements.
      *
      * @see module:engine/view/downcastwriter~DowncastWriter#setCustomProperty
-     * @protected
-     * @param {String|Symbol} key
-     * @param {*} value
+     * @internal
      */
     _setCustomProperty(key, value) {
         this._customProperties.set(key, value);
@@ -218,36 +191,21 @@ export default class DocumentFragment extends EmitterMixin(TypeCheckable) {
      * Removes the custom property stored under the given key.
      *
      * @see module:engine/view/downcastwriter~DowncastWriter#removeCustomProperty
-     * @protected
-     * @param {String|Symbol} key
-     * @returns {Boolean} Returns true if property was removed.
+     * @internal
+     * @returns Returns true if property was removed.
      */
     _removeCustomProperty(key) {
         return this._customProperties.delete(key);
     }
 }
-/**
- * Checks whether this object is of the given type.
- *
- *		docFrag.is( 'documentFragment' ); // -> true
- *		docFrag.is( 'view:documentFragment' ); // -> true
- *
- *		docFrag.is( 'model:documentFragment' ); // -> false
- *		docFrag.is( 'element' ); // -> false
- *		docFrag.is( 'node' ); // -> false
- *
- * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
- *
- * @param {String} type
- * @returns {Boolean}
- */
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
 DocumentFragment.prototype.is = function (type) {
     return type === 'documentFragment' || type === 'view:documentFragment';
 };
-// Converts strings to Text and non-iterables to arrays.
-//
-// @param {String|module:engine/view/item~Item|Iterable.<String|module:engine/view/item~Item>}
-// @returns {Iterable.<module:engine/view/node~Node>}
+/**
+ * Converts strings to Text and non-iterables to arrays.
+ */
 function normalize(document, nodes) {
     // Separate condition because string is iterable.
     if (typeof nodes == 'string') {

package/src/view/documentselection.d.ts

@@ -0,0 +1,306 @@
+/**
+ * @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/view/documentselection
+ */
+import TypeCheckable from './typecheckable';
+import Selection, { type PlaceOrOffset, type Selectable, type SelectionOptions, type ViewSelectionChangeEvent } from './selection';
+import type EditableElement from './editableelement';
+import type Element from './element';
+import type Node from './node';
+import type Item from './item';
+import type { default as Position, PositionOffset } from './position';
+import type Range from './range';
+declare const DocumentSelection_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
+/**
+ * Class representing the document selection in the view.
+ *
+ * Its instance is available in {@link module:engine/view/document~Document#selection `Document#selection`}.
+ *
+ * It is similar to {@link module:engine/view/selection~Selection} but
+ * it has a read-only API and can be modified only by the writer available in
+ * the {@link module:engine/view/view~View#change `View#change()`} block
+ * (so via {@link module:engine/view/downcastwriter~DowncastWriter#setSelection `DowncastWriter#setSelection()`}).
+ */
+export default class DocumentSelection extends DocumentSelection_base {
+    /**
+     * Selection is used internally (`DocumentSelection` is a proxy to that selection).
+     */
+    private readonly _selection;
+    /**
+     * Creates new DocumentSelection instance.
+     *
+     * ```ts
+     * // Creates collapsed selection at the position of given item and offset.
+     * const paragraph = writer.createContainerElement( 'paragraph' );
+     * const selection = new DocumentSelection( paragraph, offset );
+     *
+     * // Creates a range inside an {@link module:engine/view/element~Element element} which starts before the
+     * // first child of that element and ends after the last child of that element.
+     * const selection = new DocumentSelection( paragraph, 'in' );
+     *
+     * // Creates a range on an {@link module:engine/view/item~Item item} which starts before the item and ends
+     * // just after the item.
+     * const selection = new DocumentSelection( paragraph, 'on' );
+     * ```
+     *
+     * `Selection`'s constructor allow passing additional options (`backward`, `fake` and `label`) as the last argument.
+     *
+     * ```ts
+     * // Creates backward selection.
+     * const selection = new DocumentSelection( element, 'in', { backward: true } );
+     * ```
+     *
+     * Fake selection does not render as browser native selection over selected elements and is hidden to the user.
+     * This way, no native selection UI artifacts are displayed to the user and selection over elements can be
+     * represented in other way, for example by applying proper CSS class.
+     *
+     * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM
+     * (and be  properly handled by screen readers).
+     *
+     * ```ts
+     * // Creates fake selection with label.
+     * const selection = new DocumentSelection( element, 'in', { fake: true, label: 'foo' } );
+     * ```
+     *
+     * See also: {@link #constructor:SELECTABLE `constructor( selectable, options )`}.
+     *
+     * @label NODE_OFFSET
+     */
+    constructor(selectable: Node, placeOrOffset: PlaceOrOffset, options?: SelectionOptions);
+    /**
+     * Creates new DocumentSelection instance.
+     *
+     * ```ts
+     * // Creates empty selection without ranges.
+     * const selection = new DocumentSelection();
+     *
+     * // Creates selection at the given range.
+     * const range = writer.createRange( start, end );
+     * const selection = new DocumentSelection( range );
+     *
+     * // Creates selection at the given ranges
+     * const ranges = [ writer.createRange( start1, end2 ), writer.createRange( start2, end2 ) ];
+     * const selection = new DocumentSelection( ranges );
+     *
+     * // Creates selection from the other selection.
+     * const otherSelection = writer.createSelection();
+     * const selection = new DocumentSelection( otherSelection );
+     *
+     * // Creates selection at the given position.
+     * const position = writer.createPositionAt( root, offset );
+     * const selection = new DocumentSelection( position );
+     * ```
+     *
+     * `Selection`'s constructor allow passing additional options (`backward`, `fake` and `label`) as the last argument.
+     *
+     * ```ts
+     * // Creates backward selection.
+     * const selection = new DocumentSelection( range, { backward: true } );
+     * ```
+     *
+     * Fake selection does not render as browser native selection over selected elements and is hidden to the user.
+     * This way, no native selection UI artifacts are displayed to the user and selection over elements can be
+     * represented in other way, for example by applying proper CSS class.
+     *
+     * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM
+     * (and be  properly handled by screen readers).
+     *
+     * ```ts
+     * // Creates fake selection with label.
+     * const selection = new DocumentSelection( range, { fake: true, label: 'foo' } );
+     * ```
+     *
+     * See also: {@link #constructor:NODE_OFFSET `constructor( node, placeOrOffset, options )`}.
+     *
+     * @label SELECTABLE
+     */
+    constructor(selectable?: Exclude<Selectable, Node>, options?: SelectionOptions);
+    /**
+     * Returns true if selection instance is marked as `fake`.
+     *
+     * @see #_setTo
+     */
+    get isFake(): boolean;
+    /**
+     * Returns fake selection label.
+     *
+     * @see #_setTo
+     */
+    get fakeSelectionLabel(): string;
+    /**
+     * Selection anchor. Anchor may be described as a position where the selection starts. Together with
+     * {@link #focus focus} they define the direction of selection, which is important
+     * when expanding/shrinking selection. Anchor is always the start or end of the most recent added range.
+     * It may be a bit unintuitive when there are multiple ranges in selection.
+     *
+     * @see #focus
+     */
+    get anchor(): Position | null;
+    /**
+     * Selection focus. Focus is a position where the selection ends.
+     *
+     * @see #anchor
+     */
+    get focus(): Position | null;
+    /**
+     * Returns whether the selection is collapsed. Selection is collapsed when there is exactly one range which is
+     * collapsed.
+     */
+    get isCollapsed(): boolean;
+    /**
+     * Returns number of ranges in selection.
+     */
+    get rangeCount(): number;
+    /**
+     * Specifies whether the {@link #focus} precedes {@link #anchor}.
+     */
+    get isBackward(): boolean;
+    /**
+     * {@link module:engine/view/editableelement~EditableElement EditableElement} instance that contains this selection, or `null`
+     * if the selection is not inside an editable element.
+     */
+    get editableElement(): EditableElement | null;
+    /**
+     * Used for the compatibility with the {@link module:engine/view/selection~Selection#isEqual} method.
+     *
+     * @internal
+     */
+    get _ranges(): Array<Range>;
+    /**
+     * Returns an iterable that contains copies of all ranges added to the selection.
+     */
+    getRanges(): IterableIterator<Range>;
+    /**
+     * Returns copy of the first range in the selection. First range is the one which
+     * {@link module:engine/view/range~Range#start start} position {@link module:engine/view/position~Position#isBefore is before} start
+     * position of all other ranges (not to confuse with the first range added to the selection).
+     * Returns `null` if no ranges are added to selection.
+     */
+    getFirstRange(): Range | null;
+    /**
+     * Returns copy of the last range in the selection. Last range is the one which {@link module:engine/view/range~Range#end end}
+     * position {@link module:engine/view/position~Position#isAfter is after} end position of all other ranges (not to confuse
+     * with the last range added to the selection). Returns `null` if no ranges are added to selection.
+     */
+    getLastRange(): Range | null;
+    /**
+     * Returns copy of the first position in the selection. First position is the position that
+     * {@link module:engine/view/position~Position#isBefore is before} any other position in the selection ranges.
+     * Returns `null` if no ranges are added to selection.
+     */
+    getFirstPosition(): Position | null;
+    /**
+     * Returns copy of the last position in the selection. Last position is the position that
+     * {@link module:engine/view/position~Position#isAfter is after} any other position in the selection ranges.
+     * Returns `null` if no ranges are added to selection.
+     */
+    getLastPosition(): Position | null;
+    /**
+     * Returns the selected element. {@link module:engine/view/element~Element Element} is considered as selected if there is only
+     * one range in the selection, and that range contains exactly one element.
+     * Returns `null` if there is no selected element.
+     */
+    getSelectedElement(): Element | null;
+    /**
+     * Checks whether, this selection is equal to given selection. Selections are equal if they have same directions,
+     * same number of ranges and all ranges from one selection equal to a range from other selection.
+     *
+     * @param otherSelection Selection to compare with.
+     * @returns `true` if selections are equal, `false` otherwise.
+     */
+    isEqual(otherSelection: Selection | DocumentSelection): boolean;
+    /**
+     * Checks whether this selection is similar to given selection. Selections are similar if they have same directions, same
+     * number of ranges, and all {@link module:engine/view/range~Range#getTrimmed trimmed} ranges from one selection are
+     * equal to any trimmed range from other selection.
+     *
+     * @param otherSelection Selection to compare with.
+     * @returns `true` if selections are similar, `false` otherwise.
+     */
+    isSimilar(otherSelection: Selection | DocumentSelection): boolean;
+    /**
+     * Sets this selection's ranges and direction to the specified location based on the given
+     * {@link module:engine/view/selection~Selectable selectable}.
+     *
+     * ```ts
+     * // Sets selection to the given range.
+     * const range = writer.createRange( start, end );
+     * documentSelection._setTo( range );
+     *
+     * // Sets selection to given ranges.
+     * const ranges = [ writer.createRange( start1, end2 ), writer.createRange( start2, end2 ) ];
+     * documentSelection._setTo( range );
+     *
+     * // Sets selection to the other selection.
+     * const otherSelection = writer.createSelection();
+     * documentSelection._setTo( otherSelection );
+     *
+     * // Sets collapsed selection at the given position.
+     * const position = writer.createPositionAt( root, offset );
+     * documentSelection._setTo( position );
+     *
+     * // Sets collapsed selection at the position of given item and offset.
+     * documentSelection._setTo( paragraph, offset );
+     * ```
+     *
+     * Creates a range inside an {@link module:engine/view/element~Element element} which starts before the first child of
+     * that element and ends after the last child of that element.
+     *
+     * ```ts
+     * documentSelection._setTo( paragraph, 'in' );
+     * ```
+     *
+     * Creates a range on an {@link module:engine/view/item~Item item} which starts before the item and ends just after the item.
+     *
+     * ```ts
+     * documentSelection._setTo( paragraph, 'on' );
+     *
+     * // Clears selection. Removes all ranges.
+     * documentSelection._setTo( null );
+     * ```
+     *
+     * `Selection#_setTo()` method allow passing additional options (`backward`, `fake` and `label`) as the last argument.
+     *
+     * ```ts
+     * // Sets selection as backward.
+     * documentSelection._setTo( range, { backward: true } );
+     * ```
+     *
+     * Fake selection does not render as browser native selection over selected elements and is hidden to the user.
+     * This way, no native selection UI artifacts are displayed to the user and selection over elements can be
+     * represented in other way, for example by applying proper CSS class.
+     *
+     * Additionally fake's selection label can be provided. It will be used to des cribe fake selection in DOM
+     * (and be  properly handled by screen readers).
+     *
+     * ```ts
+     * // Creates fake selection with label.
+     * documentSelection._setTo( range, { fake: true, label: 'foo' } );
+     * ```
+     *
+     * @internal
+     * @fires change
+     */
+    _setTo(...args: Parameters<Selection['setTo']>): void;
+    /**
+     * Moves {@link #focus} to the specified location.
+     *
+     * The location can be specified in the same form as {@link module:engine/view/view~View#createPositionAt view.createPositionAt()}
+     * parameters.
+     *
+     * @internal
+     * @fires change
+     * @param offset Offset or one of the flags. Used only when first parameter is a {@link module:engine/view/item~Item view item}.
+     */
+    _setFocus(itemOrPosition: Item | Position, offset?: PositionOffset): void;
+}
+/**
+ * Fired whenever selection ranges are changed through {@link ~DocumentSelection Selection API}.
+ *
+ * @eventName ~DocumentSelection#change
+ */
+export type ViewDocumentSelectionChangeEvent = ViewSelectionChangeEvent;
+export {};