@ckeditor/ckeditor5-engine 45.0.0 → 45.1.0-alpha.1

package/src/model/utils/insertcontent.js

@@ -39,7 +39,6 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * @param model The model in context of which the insertion should be performed.
  * @param content The content to insert.
  * @param selectable Selection into which the content should be inserted.
- * @param placeOrOffset Sets place or offset of the selection.
  * @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.
@@ -401,8 +400,8 @@ class Insertion {
              * Given node cannot be inserted on the given position.
              *
              * @error insertcontent-wrong-position
-             * @param node Node to insert.
-             * @param position Position to insert the node at.
+             * @param {module:engine/model/node~Node} node Node to insert.
+             * @param {module:engine/model/position~Position} position Position to insert the node at.
              */
             throw new CKEditorError('insertcontent-wrong-position', this, { node, position: this.position });
         }

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

@@ -23,7 +23,6 @@ import type Range from '../range.js';
  * @param object An object to be inserted into the model document.
  * @param selectable A selectable where the content should be inserted. If not specified, the current
  * {@link module:engine/model/document~Document#selection document selection} will be used instead.
- * @param placeOrOffset Specifies the exact place or offset for the insertion to take place, relative to `selectable`.
  * @param options Additional options.
  * @param options.findOptimalPosition An option that, when set, adjusts the insertion position (relative to
  * `selectable` and `placeOrOffset`) so that the content of `selectable` is not split upon insertion (a.k.a. non-destructive insertion).

package/src/model/utils/insertobject.js

@@ -16,7 +16,6 @@ import { CKEditorError, first } from '@ckeditor/ckeditor5-utils';
  * @param object An object to be inserted into the model document.
  * @param selectable A selectable where the content should be inserted. If not specified, the current
  * {@link module:engine/model/document~Document#selection document selection} will be used instead.
- * @param placeOrOffset Specifies the exact place or offset for the insertion to take place, relative to `selectable`.
  * @param options Additional options.
  * @param options.findOptimalPosition An option that, when set, adjusts the insertion position (relative to
  * `selectable` and `placeOrOffset`) so that the content of `selectable` is not split upon insertion (a.k.a. non-destructive insertion).

package/src/model/writer.d.ts

@@ -371,7 +371,7 @@ export default class Writer {
      *
      * Note that items can be moved only within the same tree. It means that you can move items within the same root
      * (element or document fragment) or between {@link module:engine/model/document~Document#roots documents roots},
-     * but you can not move items from document fragment to the document or from one detached element to another. Use
+     * but you cannot move items from document fragment to the document or from one detached element to another. Use
      * {@link module:engine/model/writer~Writer#insert} in such cases.
      *
      * @param range Source range.

package/src/model/writer.js

@@ -377,7 +377,7 @@ export default class Writer {
      *
      * Note that items can be moved only within the same tree. It means that you can move items within the same root
      * (element or document fragment) or between {@link module:engine/model/document~Document#roots documents roots},
-     * but you can not move items from document fragment to the document or from one detached element to another. Use
+     * but you cannot move items from document fragment to the document or from one detached element to another. Use
      * {@link module:engine/model/writer~Writer#insert} in such cases.
      *
      * @param range Source range.
@@ -601,7 +601,7 @@ export default class Writer {
         let splitElement = position.parent;
         if (!splitElement.parent) {
             /**
-             * Element with no parent can not be split.
+             * Element with no parent cannot be split.
              *
              * @error writer-split-element-no-parent
              */

package/src/view/domconverter.d.ts

@@ -294,7 +294,7 @@ export default class DomConverter {
     domSelectionToView(domSelection: DomSelection): ViewSelection;
     /**
      * Converts DOM Range to view {@link module:engine/view/range~Range}.
-     * If the start or end position can not be converted `null` is returned.
+     * If the start or end position cannot be converted `null` is returned.
      *
      * @param domRange DOM range.
      * @returns View range.
@@ -442,7 +442,7 @@ export default class DomConverter {
     /**
      * Returns `true` if given selection is a backward selection, that is, if it's `focus` is before `anchor`.
      *
-     * @param DOM Selection instance to check.
+     * @param selection Selection instance to check.
      */
     isDomSelectionBackward(selection: DomSelection): boolean;
     /**
@@ -660,7 +660,7 @@ export {};
  * ```
  *
  * @error domconverter-unsafe-attribute-detected
- * @param domElement The DOM element the attribute was set on.
- * @param key The original name of the attribute
- * @param value The value of the original attribute
+ * @param {HTMLElement} domElement The DOM element the attribute was set on.
+ * @param {string} key The original name of the attribute
+ * @param {string} value The value of the original attribute
  */

package/src/view/domconverter.js

@@ -646,7 +646,7 @@ export default class DomConverter {
     }
     /**
      * Converts DOM Range to view {@link module:engine/view/range~Range}.
-     * If the start or end position can not be converted `null` is returned.
+     * If the start or end position cannot be converted `null` is returned.
      *
      * @param domRange DOM range.
      * @returns View range.
@@ -942,7 +942,7 @@ export default class DomConverter {
     /**
      * Returns `true` if given selection is a backward selection, that is, if it's `focus` is before `anchor`.
      *
-     * @param DOM Selection instance to check.
+     * @param selection Selection instance to check.
      */
     isDomSelectionBackward(selection) {
         if (selection.isCollapsed) {
@@ -1643,7 +1643,7 @@ function isGeckoRestrictedDomSelection(domSelection) {
  * ```
  *
  * @error domconverter-unsafe-attribute-detected
- * @param domElement The DOM element the attribute was set on.
- * @param key The original name of the attribute
- * @param value The value of the original attribute
+ * @param {HTMLElement} domElement The DOM element the attribute was set on.
+ * @param {string} key The original name of the attribute
+ * @param {string} value The value of the original attribute
  */

package/src/view/downcastwriter.d.ts

@@ -164,7 +164,8 @@ export default class DowncastWriter {
      * The location can be specified in the same form as {@link module:engine/view/view~View#createPositionAt view.createPositionAt()}
      * parameters.
      *
-     * @param Offset or one of the flags. Used only when the first parameter is a {@link module:engine/view/item~Item view item}.
+     * @param itemOrPosition
+     * @param offset Offset or one of the flags. Used only when the first parameter is a {@link module:engine/view/item~Item view item}.
      */
     setSelectionFocus(itemOrPosition: Item | Position, offset?: PositionOffset): void;
     /**
@@ -893,7 +894,7 @@ export default class DowncastWriter {
      * conversionApi.writer.insert( viewPosition, viewSlot );
      * ```
      *
-     * While providing a filtered slot, make sure to provide slots for all child nodes. A single node can not be downcasted into
+     * While providing a filtered slot, make sure to provide slots for all child nodes. A single node cannot be downcasted into
      * multiple slots.
      *
      * **Note**: You should not change the order of nodes. View elements should be in the same order as model nodes.

package/src/view/downcastwriter.js

@@ -62,7 +62,8 @@ export default class DowncastWriter {
      * The location can be specified in the same form as {@link module:engine/view/view~View#createPositionAt view.createPositionAt()}
      * parameters.
      *
-     * @param Offset or one of the flags. Used only when the first parameter is a {@link module:engine/view/item~Item view item}.
+     * @param itemOrPosition
+     * @param offset Offset or one of the flags. Used only when the first parameter is a {@link module:engine/view/item~Item view item}.
      */
     setSelectionFocus(itemOrPosition, offset) {
         this.document.selection._setFocus(itemOrPosition, offset);
@@ -910,7 +911,7 @@ export default class DowncastWriter {
      * conversionApi.writer.insert( viewPosition, viewSlot );
      * ```
      *
-     * While providing a filtered slot, make sure to provide slots for all child nodes. A single node can not be downcasted into
+     * While providing a filtered slot, make sure to provide slots for all child nodes. A single node cannot be downcasted into
      * multiple slots.
      *
      * **Note**: You should not change the order of nodes. View elements should be in the same order as model nodes.

package/src/view/editableelement.d.ts

@@ -53,7 +53,7 @@ export default class EditableElement extends /* #__PURE__ */ EditableElement_bas
      * @internal
      * @param document The document instance to which this element belongs.
      * @param name Node name.
-     * @param attrs Collection of attributes.
+     * @param attributes Collection of attributes.
      * @param children A list of nodes to be inserted into created element.
      */
     constructor(document: Document, name: string, attributes?: ElementAttributes, children?: Node | Iterable<Node>);

package/src/view/editableelement.js

@@ -24,7 +24,7 @@ export default class EditableElement extends /* #__PURE__ */ ObservableMixin(Con
      * @internal
      * @param document The document instance to which this element belongs.
      * @param name Node name.
-     * @param attrs Collection of attributes.
+     * @param attributes Collection of attributes.
      * @param children A list of nodes to be inserted into created element.
      */
     constructor(document, name, attributes, children) {

package/src/view/emptyelement.d.ts

@@ -26,7 +26,7 @@ export default class EmptyElement extends Element {
      * @internal
      * @param document The document instance to which this element belongs.
      * @param name Node name.
-     * @param attrs Collection of attributes.
+     * @param attributes Collection of attributes.
      * @param children A list of nodes to be inserted into created element.
      */
     constructor(document: Document, name: string, attributes?: ElementAttributes, children?: Node | Iterable<Node>);

package/src/view/emptyelement.js

@@ -25,7 +25,7 @@ export default class EmptyElement extends Element {
      * @internal
      * @param document The document instance to which this element belongs.
      * @param name Node name.
-     * @param attrs Collection of attributes.
+     * @param attributes Collection of attributes.
      * @param children A list of nodes to be inserted into created element.
      */
     constructor(document, name, attributes, children) {

package/src/view/filler.d.ts

@@ -13,7 +13,7 @@ import type View from './view.js';
  * * Block filler is an element which fill block elements, like `<p>`. CKEditor uses `<br>` as a block filler during the editing,
  * as browsers do natively. So instead of an empty `<p>` there will be `<p><br></p>`. The advantage of block filler is that
  * it is transparent for the selection, so when the caret is before the `<br>` and user presses right arrow he will be
- * moved to the next paragraph, not after the `<br>`. The disadvantage is that it breaks a block, so it can not be used
+ * moved to the next paragraph, not after the `<br>`. The disadvantage is that it breaks a block, so it cannot be used
  * in the middle of a line of text. The {@link module:engine/view/filler~BR_FILLER `<br>` filler} can be replaced with any other
  * character in the data output, for instance {@link module:engine/view/filler~NBSP_FILLER non-breaking space} or
  * {@link module:engine/view/filler~MARKED_NBSP_FILLER marked non-breaking space}.

package/src/view/filler.js

@@ -13,7 +13,7 @@ import { keyCodes, isText } from '@ckeditor/ckeditor5-utils';
  * * Block filler is an element which fill block elements, like `<p>`. CKEditor uses `<br>` as a block filler during the editing,
  * as browsers do natively. So instead of an empty `<p>` there will be `<p><br></p>`. The advantage of block filler is that
  * it is transparent for the selection, so when the caret is before the `<br>` and user presses right arrow he will be
- * moved to the next paragraph, not after the `<br>`. The disadvantage is that it breaks a block, so it can not be used
+ * moved to the next paragraph, not after the `<br>`. The disadvantage is that it breaks a block, so it cannot be used
  * in the middle of a line of text. The {@link module:engine/view/filler~BR_FILLER `<br>` filler} can be replaced with any other
  * character in the data output, for instance {@link module:engine/view/filler~NBSP_FILLER non-breaking space} or
  * {@link module:engine/view/filler~MARKED_NBSP_FILLER marked non-breaking space}.

package/src/view/observer/compositionobserver.js

@@ -33,7 +33,7 @@ export default class CompositionObserver extends DomEventObserver {
             // @if CK_DEBUG_TYPING // 	) );
             // @if CK_DEBUG_TYPING // }
             document.isComposing = true;
-        }, { priority: 'low' });
+        });
         document.on('compositionend', () => {
             // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
             // @if CK_DEBUG_TYPING // 	console.log( ..._buildLogMessage( this, 'CompositionObserver',
@@ -42,7 +42,7 @@ export default class CompositionObserver extends DomEventObserver {
             // @if CK_DEBUG_TYPING // 	) );
             // @if CK_DEBUG_TYPING // }
             document.isComposing = false;
-        }, { priority: 'low' });
+        });
     }
     /**
      * @inheritDoc

package/src/view/observer/inputobserver.js

@@ -8,6 +8,7 @@
 import DomEventObserver from './domeventobserver.js';
 import DataTransfer from '../datatransfer.js';
 import { env } from '@ckeditor/ckeditor5-utils';
+import { INLINE_FILLER_LENGTH, startsWithFiller } from '../filler.js';
 // @if CK_DEBUG_TYPING // const { _debouncedLine, _buildLogMessage } = require( '../../dev-utils/utils.js' );
 /**
  * Observer for events connected with data input.
@@ -27,7 +28,7 @@ export default class InputObserver extends DomEventObserver {
         // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
         // @if CK_DEBUG_TYPING // 	_debouncedLine();
         // @if CK_DEBUG_TYPING // 	console.group( ..._buildLogMessage( this, 'InputObserver',
-        // @if CK_DEBUG_TYPING // 		`${ domEvent.type }: ${ domEvent.inputType }`
+        // @if CK_DEBUG_TYPING // 		`${ domEvent.type }: ${ domEvent.inputType } - ${ domEvent.isComposing ? 'is' : 'not' } composing`,
         // @if CK_DEBUG_TYPING // 	) );
         // @if CK_DEBUG_TYPING // }
         const domTargetRanges = domEvent.getTargetRanges();
@@ -64,6 +65,8 @@ export default class InputObserver extends DomEventObserver {
         if (viewDocument.selection.isFake) {
             // Future-proof: in case of multi-range fake selections being possible.
             targetRanges = Array.from(viewDocument.selection.getRanges());
+            // Do not allow typing inside a fake selection container, we will handle it manually.
+            domEvent.preventDefault();
             // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
             // @if CK_DEBUG_TYPING // 	console.info( ..._buildLogMessage( this, 'InputObserver',
             // @if CK_DEBUG_TYPING // 		'%cusing fake selection:',
@@ -79,8 +82,31 @@ export default class InputObserver extends DomEventObserver {
                 // We try to fall back to collapsed range at the valid end position.
                 // See https://github.com/ckeditor/ckeditor5/issues/14411.
                 // See https://github.com/ckeditor/ckeditor5/issues/14050.
-                const viewStart = view.domConverter.domPositionToView(domRange.startContainer, domRange.startOffset);
+                let viewStart = view.domConverter.domPositionToView(domRange.startContainer, domRange.startOffset);
                 const viewEnd = view.domConverter.domPositionToView(domRange.endContainer, domRange.endOffset);
+                // When text replacement is enabled and browser tries to replace double space with dot, and space,
+                // but the first space is no longer where browser put it (it was moved to an attribute element),
+                // then we must extend the target range so it does not include a part of an inline filler.
+                if (viewStart && startsWithFiller(domRange.startContainer) && domRange.startOffset < INLINE_FILLER_LENGTH) {
+                    // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
+                    // @if CK_DEBUG_TYPING // 	console.info( ..._buildLogMessage( this, 'InputObserver',
+                    // @if CK_DEBUG_TYPING // 		'Target range starts in an inline filler - adjusting it',
+                    // @if CK_DEBUG_TYPING // 	) );
+                    // @if CK_DEBUG_TYPING // }
+                    domEvent.preventDefault();
+                    let count = INLINE_FILLER_LENGTH - domRange.startOffset;
+                    viewStart = viewStart.getLastMatchingPosition(value => {
+                        // Ignore attribute and UI elements but stop on container elements.
+                        if (value.item.is('attributeElement') || value.item.is('uiElement')) {
+                            return true;
+                        }
+                        // Skip as many characters as inline filler was overlapped.
+                        if (value.item.is('$textProxy') && count--) {
+                            return true;
+                        }
+                        return false;
+                    }, { direction: 'backward', singleCharacters: true });
+                }
                 if (viewStart) {
                     return view.createRange(viewStart, viewEnd);
                 }
@@ -126,7 +152,7 @@ export default class InputObserver extends DomEventObserver {
         }
         // Normalize the insertText data that includes new-line characters.
         // https://github.com/ckeditor/ckeditor5/issues/2045.
-        if (domEvent.inputType == 'insertText' && data && data.includes('\n')) {
+        if (['insertText', 'insertReplacementText'].includes(domEvent.inputType) && data && data.includes('\n')) {
             // There might be a single new-line or double for new paragraph, but we translate
             // it to paragraphs as it is our default action for enter handling.
             const parts = data.split(/\n{1,2}/g);

package/src/view/position.js

@@ -291,10 +291,10 @@ export default class Position extends TypeCheckable {
         }
         if (!item.parent) {
             /**
-             * You can not make a position after a root.
+             * You cannot make a position after a root.
              *
              * @error view-position-after-root
-             * @param {module:engine/view/node~Node} root
+             * @param {module:engine/view/node~Node} root A root item.
              */
             throw new CKEditorError('view-position-after-root', item, { root: item });
         }
@@ -316,7 +316,7 @@ export default class Position extends TypeCheckable {
              * You cannot make a position before a root.
              *
              * @error view-position-before-root
-             * @param {module:engine/view/node~Node} root
+             * @param {module:engine/view/node~Node} root A root item.
              */
             throw new CKEditorError('view-position-before-root', item, { root: item });
         }

package/src/view/renderer.js

@@ -366,6 +366,14 @@ export default class Renderer extends /* #__PURE__ */ ObservableMixin() {
         const domFillerNode = this._inlineFiller;
         // Something weird happened and the stored node doesn't contain the filler's text.
         if (!startsWithFiller(domFillerNode)) {
+            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
+            // @if CK_DEBUG_TYPING // 	console.log( ..._buildLogMessage( this, 'Renderer',
+            // @if CK_DEBUG_TYPING // 		'Inline filler node: ' +
+            // @if CK_DEBUG_TYPING // 		`%c${ _escapeTextNodeData( domFillerNode.data ) }%c (${ domFillerNode.data.length })`,
+            // @if CK_DEBUG_TYPING // 		'color: blue',
+            // @if CK_DEBUG_TYPING // 		''
+            // @if CK_DEBUG_TYPING // 	) );
+            // @if CK_DEBUG_TYPING // }
             /**
              * The inline filler node was lost. Most likely, something overwrote the filler text node
              * in the DOM.

package/src/view/textproxy.d.ts

@@ -25,7 +25,7 @@ import type Text from './text.js';
  *
  * **Note:** `TextProxy` instances are created on the fly basing on the current state of parent {@link module:engine/view/text~Text}.
  * 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 can not be
+ * 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}.
  *
  * `TextProxy` instances are created by {@link module:engine/view/treewalker~TreeWalker view tree walker}. You should not need to create
@@ -52,7 +52,6 @@ export default class TextProxy extends TypeCheckable {
      * @param offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#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.
-     * @constructor
      */
     constructor(textNode: Text, offsetInText: number, length: number);
     /**

package/src/view/textproxy.js

@@ -21,7 +21,7 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  *
  * **Note:** `TextProxy` instances are created on the fly basing on the current state of parent {@link module:engine/view/text~Text}.
  * 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 can not be
+ * 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}.
  *
  * `TextProxy` instances are created by {@link module:engine/view/treewalker~TreeWalker view tree walker}. You should not need to create
@@ -48,7 +48,6 @@ export default class TextProxy extends TypeCheckable {
      * @param offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#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.
-     * @constructor
      */
     constructor(textNode, offsetInText, length) {
         super();