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

package/src/view/selection.js

@@ -32,44 +32,48 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * * {@link module:engine/view/view~View#createSelection `View#createSelection()`},
      * * {@link module:engine/view/upcastwriter~UpcastWriter#createSelection `UpcastWriter#createSelection()`}.
      *
-     * 		// Creates empty selection without ranges.
-     *		const selection = writer.createSelection();
+     * ```ts
+     * // Creates empty selection without ranges.
+     * const selection = writer.createSelection();
      *
-     *		// Creates selection at the given range.
-     *		const range = writer.createRange( start, end );
-     *		const selection = writer.createSelection( range );
+     * // Creates selection at the given range.
+     * const range = writer.createRange( start, end );
+     * const selection = writer.createSelection( range );
      *
-     *		// Creates selection at the given ranges
-     * 		const ranges = [ writer.createRange( start1, end2 ), writer.createRange( star2, end2 ) ];
-     *		const selection = writer.createSelection( ranges );
+     * // Creates selection at the given ranges
+     * const ranges = [ writer.createRange( start1, end2 ), writer.createRange( star2, end2 ) ];
+     * const selection = writer.createSelection( ranges );
      *
-     *		// Creates selection from the other selection.
-     *		const otherSelection = writer.createSelection();
-     *		const selection = writer.createSelection( otherSelection );
+     * // Creates selection from the other selection.
+     * const otherSelection = writer.createSelection();
+     * const selection = writer.createSelection( otherSelection );
      *
-     *		// Creates selection from the document selection.
-     *		const selection = writer.createSelection( editor.editing.view.document.selection );
+     * // Creates selection from the document selection.
+     * const selection = writer.createSelection( editor.editing.view.document.selection );
      *
-     * 		// Creates selection at the given position.
-     *		const position = writer.createPositionFromPath( root, path );
-     *		const selection = writer.createSelection( position );
+     * // Creates selection at the given position.
+     * const position = writer.createPositionFromPath( root, path );
+     * const selection = writer.createSelection( position );
      *
-     *		// Creates collapsed selection at the position of given item and offset.
-     *		const paragraph = writer.createContainerElement( 'paragraph' );
-     *		const selection = writer.createSelection( paragraph, offset );
+     * // Creates collapsed selection at the position of given item and offset.
+     * const paragraph = writer.createContainerElement( 'paragraph' );
+     * const selection = writer.createSelection( 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 = writer.createSelection( paragraph, 'in' );
+     * // 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 = writer.createSelection( 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 = writer.createSelection( paragraph, 'on' );
+     * // 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 = writer.createSelection( paragraph, 'on' );
+     * ```
      *
      * `Selection`'s constructor allow passing additional options (`backward`, `fake` and `label`) as the last argument.
      *
-     *		// Creates backward selection.
-     *		const selection = writer.createSelection( range, { backward: true } );
+     * ```ts
+     * // Creates backward selection.
+     * const selection = writer.createSelection( 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
@@ -78,45 +82,18 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * 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).
      *
-     *		// Creates fake selection with label.
-     *		const selection = writer.createSelection( range, { fake: true, label: 'foo' } );
+     * ```ts
+     * // Creates fake selection with label.
+     * const selection = writer.createSelection( range, { fake: true, label: 'foo' } );
+     * ```
      *
-     * @param {module:engine/view/selection~Selectable} [selectable=null]
-     * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Offset or place when selectable is an `Item`.
-     * @param {Object} [options]
-     * @param {Boolean} [options.backward] Sets this selection instance to be backward.
-     * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`.
-     * @param {String} [options.label] Label for the fake selection.
+     * @internal
      */
     constructor(...args) {
         super();
-        /**
-         * Stores all ranges that are selected.
-         *
-         * @protected
-         * @member {Array.<module:engine/view/range~Range>}
-         */
         this._ranges = [];
-        /**
-         * Specifies whether the last added range was added as a backward or forward range.
-         *
-         * @protected
-         * @member {Boolean}
-         */
         this._lastRangeBackward = false;
-        /**
-         * Specifies whether selection instance is fake.
-         *
-         * @private
-         * @member {Boolean}
-         */
         this._isFake = false;
-        /**
-         * Fake selection's label.
-         *
-         * @private
-         * @member {String}
-         */
         this._fakeSelectionLabel = '';
         if (args.length) {
             this.setTo(...args);
@@ -126,7 +103,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * Returns true if selection instance is marked as `fake`.
      *
      * @see #setTo
-     * @type {Boolean}
      */
     get isFake() {
         return this._isFake;
@@ -135,7 +111,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * Returns fake selection label.
      *
      * @see #setTo
-     * @type {String}
      */
     get fakeSelectionLabel() {
         return this._fakeSelectionLabel;
@@ -147,7 +122,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * It may be a bit unintuitive when there are multiple ranges in selection.
      *
      * @see #focus
-     * @type {module:engine/view/position~Position}
      */
     get anchor() {
         if (!this._ranges.length) {
@@ -161,7 +135,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * Selection focus. Focus is a position where the selection ends.
      *
      * @see #anchor
-     * @type {module:engine/view/position~Position}
      */
     get focus() {
         if (!this._ranges.length) {
@@ -174,24 +147,18 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
     /**
      * Returns whether the selection is collapsed. Selection is collapsed when there is exactly one range which is
      * collapsed.
-     *
-     * @type {Boolean}
      */
     get isCollapsed() {
         return this.rangeCount === 1 && this._ranges[0].isCollapsed;
     }
     /**
      * Returns number of ranges in selection.
-     *
-     * @type {Number}
      */
     get rangeCount() {
         return this._ranges.length;
     }
     /**
      * Specifies whether the {@link #focus} precedes {@link #anchor}.
-     *
-     * @type {Boolean}
      */
     get isBackward() {
         return !this.isCollapsed && this._lastRangeBackward;
@@ -199,8 +166,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
     /**
      * {@link module:engine/view/editableelement~EditableElement EditableElement} instance that contains this selection, or `null`
      * if the selection is not inside an editable element.
-     *
-     * @type {module:engine/view/editableelement~EditableElement|null}
      */
     get editableElement() {
         if (this.anchor) {
@@ -210,8 +175,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
     }
     /**
      * Returns an iterable that contains copies of all ranges added to the selection.
-     *
-     * @returns {Iterable.<module:engine/view/range~Range>}
      */
     *getRanges() {
         for (const range of this._ranges) {
@@ -223,8 +186,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * {@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.
-     *
-     * @returns {module:engine/view/range~Range|null}
      */
     getFirstRange() {
         let first = null;
@@ -239,8 +200,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * 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.
-     *
-     * @returns {module:engine/view/range~Range|null}
      */
     getLastRange() {
         let last = null;
@@ -255,8 +214,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * 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.
-     *
-     * @returns {module:engine/view/position~Position|null}
      */
     getFirstPosition() {
         const firstRange = this.getFirstRange();
@@ -266,8 +223,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * 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.
-     *
-     * @returns {module:engine/view/position~Position|null}
      */
     getLastPosition() {
         const lastRange = this.getLastRange();
@@ -277,9 +232,8 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * 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 {module:engine/view/selection~Selection|module:engine/view/documentselection~DocumentSelection} otherSelection
-     * Selection to compare with.
-     * @returns {Boolean} `true` if selections are equal, `false` otherwise.
+     * @param otherSelection Selection to compare with.
+     * @returns `true` if selections are equal, `false` otherwise.
      */
     isEqual(otherSelection) {
         if (this.isFake != otherSelection.isFake) {
@@ -316,9 +270,8 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * 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 {module:engine/view/selection~Selection|module:engine/view/documentselection~DocumentSelection} otherSelection
-     * Selection to compare with.
-     * @returns {Boolean} `true` if selections are similar, `false` otherwise.
+     * @param otherSelection Selection to compare with.
+     * @returns `true` if selections are similar, `false` otherwise.
      */
     isSimilar(otherSelection) {
         if (this.isBackward != otherSelection.isBackward) {
@@ -357,8 +310,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * 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.
-     *
-     * @returns {module:engine/view/element~Element|null}
      */
     getSelectedElement() {
         if (this.rangeCount !== 1) {
@@ -370,44 +321,52 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * Sets this selection's ranges and direction to the specified location based on the given
      * {@link module:engine/view/selection~Selectable selectable}.
      *
-     *		// Sets selection to the given range.
-     *		const range = writer.createRange( start, end );
-     *		selection.setTo( range );
+     * ```ts
+     * // Sets selection to the given range.
+     * const range = writer.createRange( start, end );
+     * selection.setTo( range );
      *
-     *		// Sets selection to given ranges.
-     * 		const ranges = [ writer.createRange( start1, end2 ), writer.createRange( star2, end2 ) ];
-     *		selection.setTo( range );
+     * // Sets selection to given ranges.
+     * const ranges = [ writer.createRange( start1, end2 ), writer.createRange( star2, end2 ) ];
+     * selection.setTo( range );
      *
-     *		// Sets selection to the other selection.
-     *		const otherSelection = writer.createSelection();
-     *		selection.setTo( otherSelection );
+     * // Sets selection to the other selection.
+     * const otherSelection = writer.createSelection();
+     * selection.setTo( otherSelection );
      *
-     *	 	// Sets selection to contents of DocumentSelection.
-     *		selection.setTo( editor.editing.view.document.selection );
+     * // Sets selection to contents of DocumentSelection.
+     * selection.setTo( editor.editing.view.document.selection );
      *
-     * 		// Sets collapsed selection at the given position.
-     *		const position = writer.createPositionAt( root, path );
-     *		selection.setTo( position );
+     * // Sets collapsed selection at the given position.
+     * const position = writer.createPositionAt( root, path );
+     * selection.setTo( position );
      *
-     * 		// Sets collapsed selection at the position of given item and offset.
-     *		selection.setTo( paragraph, offset );
+     * // Sets collapsed selection at the position of given item and offset.
+     * selection.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.
      *
-     *		selection.setTo( paragraph, 'in' );
+     * ```ts
+     * selection.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.
      *
-     *		selection.setTo( paragraph, 'on' );
+     * ```ts
+     * selection.setTo( paragraph, 'on' );
      *
-     * 		// Clears selection. Removes all ranges.
-     *		selection.setTo( null );
+     * // Clears selection. Removes all ranges.
+     * selection.setTo( null );
+     * ```
      *
      * `Selection#setTo()` method allow passing additional options (`backward`, `fake` and `label`) as the last argument.
      *
-     *		// Sets selection as backward.
-     *		selection.setTo( range, { backward: true } );
+     * ```ts
+     * // Sets selection as backward.
+     * selection.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
@@ -416,16 +375,12 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * 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).
      *
-     *		// Creates fake selection with label.
-     *		selection.setTo( range, { fake: true, label: 'foo' } );
+     * ```ts
+     * // Creates fake selection with label.
+     * selection.setTo( range, { fake: true, label: 'foo' } );
+     * ```
      *
      * @fires change
-     * @param {module:engine/view/selection~Selectable} selectable
-     * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection.
-     * @param {Object} [options]
-     * @param {Boolean} [options.backward] Sets this selection instance to be backward.
-     * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`.
-     * @param {String} [options.label] Label for the fake selection.
      */
     setTo(...args) {
         let [selectable, placeOrOffset, options] = args;
@@ -495,9 +450,7 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * parameters.
      *
      * @fires change
-     * @param {module:engine/view/item~Item|module:engine/view/position~Position} itemOrPosition
-     * @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
-     * first parameter is a {@link module:engine/view/item~Item view item}.
+     * @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, offset) {
         if (this.anchor === null) {
@@ -527,9 +480,8 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * is treated like the last added range and is used to set {@link #anchor anchor} and {@link #focus focus}.
      * Accepts a flag describing in which way the selection is made.
      *
-     * @private
-     * @param {Iterable.<module:engine/view/range~Range>} newRanges Iterable object of ranges to set.
-     * @param {Boolean} [isLastBackward=false] Flag describing if last added range was selected forward - from start to end
+     * @param newRanges Iterable object of ranges to set.
+     * @param isLastBackward Flag describing if last added range was selected forward - from start to end
      * (`false`) or backward - from end to start (`true`). Defaults to `false`.
      */
     _setRanges(newRanges, isLastBackward = false) {
@@ -549,11 +501,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      *
      * 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).
-     *
-     * @private
-     * @param {Object} [options] Options.
-     * @param {Boolean} [options.fake] If set to true selection will be marked as `fake`.
-     * @param {String} [options.label=''] Fake selection label.
      */
     _setFakeOptions(options = {}) {
         this._isFake = !!options.fake;
@@ -570,11 +517,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      *
      * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-selection-range-intersects` if added range intersects
      * with ranges already stored in Selection instance.
-     *
-     * @private
-     * @fires change
-     * @param {module:engine/view/range~Range} range
-     * @param {Boolean} [isBackward]
      */
     _addRange(range, isBackward = false) {
         if (!(range instanceof Range)) {
@@ -593,9 +535,6 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      *
      * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-selection-range-intersects` if added range intersects
      * with ranges already stored in selection instance.
-     *
-     * @private
-     * @param {module:engine/view/range~Range} range
      */
     _pushRange(range) {
         for (const storedRange of this._ranges) {
@@ -613,21 +552,8 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
         this._ranges.push(new Range(range.start, range.end));
     }
 }
-/**
- * Checks whether this object is of the given type.
- *
- *		selection.is( 'selection' ); // -> true
- *		selection.is( 'view:selection' ); // -> true
- *
- *		selection.is( 'model:selection' ); // -> false
- *		selection.is( 'element' ); // -> false
- *		selection.is( 'range' ); // -> 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.
 Selection.prototype.is = function (type) {
     return type === 'selection' || type === 'view:selection';
 };

package/src/view/styles/background.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @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/styles/background
+ */
+import type { StylesProcessor } from '../stylesmap';
+/**
+ * Adds a background CSS styles processing rules.
+ *
+ * ```ts
+ * editor.data.addStyleProcessorRules( addBackgroundRules );
+ * ```
+ *
+ * The normalized value is stored as:
+ *
+ * ```ts
+ * const styles = {
+ * 	background: {
+ * 		color,
+ * 		repeat,
+ * 		position,
+ * 		attachment,
+ * 		image
+ * 	}
+ * };
+ * ````
+ *
+ * **Note**: Currently only `'background-color'` longhand value is parsed besides `'background'` shorthand. The reducer also supports only
+ * `'background-color'` value.
+ */
+export declare function addBackgroundRules(stylesProcessor: StylesProcessor): void;

package/src/view/styles/background.js

@@ -6,24 +6,26 @@ import { getShorthandValues, isAttachment, isColor, isPosition, isRepeat, isURL
 /**
  * Adds a background CSS styles processing rules.
  *
- *		editor.data.addStyleProcessorRules( addBackgroundRules );
+ * ```ts
+ * editor.data.addStyleProcessorRules( addBackgroundRules );
+ * ```
  *
  * The normalized value is stored as:
  *
- *		const styles = {
- *			background: {
- *				color,
- *				repeat,
- *				position,
- *				attachment,
- *				image
- *			}
- *		};
+ * ```ts
+ * const styles = {
+ * 	background: {
+ * 		color,
+ * 		repeat,
+ * 		position,
+ * 		attachment,
+ * 		image
+ * 	}
+ * };
+ * ````
  *
  * **Note**: Currently only `'background-color'` longhand value is parsed besides `'background'` shorthand. The reducer also supports only
  * `'background-color'` value.
- *
- * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor
  */
 export function addBackgroundRules(stylesProcessor) {
     stylesProcessor.setNormalizer('background', getBackgroundNormalizer());

package/src/view/styles/border.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @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/styles/border
+ */
+import type { StylesProcessor } from '../stylesmap';
+/**
+ * Adds a border CSS styles processing rules.
+ *
+ * ```ts
+ * editor.data.addStyleProcessorRules( addBorderRules );
+ * ```
+ *
+ * This rules merges all [border](https://developer.mozilla.org/en-US/docs/Web/CSS/border) styles notation shorthands:
+ *
+ * - border
+ * - border-top
+ * - border-right
+ * - border-bottom
+ * - border-left
+ * - border-color
+ * - border-style
+ * - border-width
+ *
+ * and all corresponding longhand forms (like `border-top-color`, `border-top-style`, etc).
+ *
+ * It does not handle other shorthands (like `border-radius` or `border-image`).
+ *
+ * The normalized model stores border values as:
+ *
+ * ```ts
+ * const styles = {
+ * 	border: {
+ * 		color: { top, right, bottom, left },
+ * 		style: { top, right, bottom, left },
+ * 		width: { top, right, bottom, left },
+ * 	}
+ * };
+ * ```
+ */
+export declare function addBorderRules(stylesProcessor: StylesProcessor): void;