@ckeditor/ckeditor5-engine 37.0.1 → 37.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-engine",
-  "version": "37.0.1",
+  "version": "37.1.0",
   "description": "The editing engine of CKEditor 5 – the best browser-based rich text editor.",
   "keywords": [
     "wysiwyg",
@@ -23,30 +23,30 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-utils": "^37.0.1",
+    "@ckeditor/ckeditor5-utils": "^37.1.0",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^37.0.1",
-    "@ckeditor/ckeditor5-block-quote": "^37.0.1",
-    "@ckeditor/ckeditor5-clipboard": "^37.0.1",
-    "@ckeditor/ckeditor5-cloud-services": "^37.0.1",
-    "@ckeditor/ckeditor5-core": "^37.0.1",
-    "@ckeditor/ckeditor5-editor-classic": "^37.0.1",
-    "@ckeditor/ckeditor5-enter": "^37.0.1",
-    "@ckeditor/ckeditor5-essentials": "^37.0.1",
-    "@ckeditor/ckeditor5-heading": "^37.0.1",
-    "@ckeditor/ckeditor5-image": "^37.0.1",
-    "@ckeditor/ckeditor5-link": "^37.0.1",
-    "@ckeditor/ckeditor5-list": "^37.0.1",
-    "@ckeditor/ckeditor5-mention": "^37.0.1",
-    "@ckeditor/ckeditor5-paragraph": "^37.0.1",
-    "@ckeditor/ckeditor5-table": "^37.0.1",
-    "@ckeditor/ckeditor5-theme-lark": "^37.0.1",
-    "@ckeditor/ckeditor5-typing": "^37.0.1",
-    "@ckeditor/ckeditor5-ui": "^37.0.1",
-    "@ckeditor/ckeditor5-undo": "^37.0.1",
-    "@ckeditor/ckeditor5-widget": "^37.0.1",
+    "@ckeditor/ckeditor5-basic-styles": "^37.1.0",
+    "@ckeditor/ckeditor5-block-quote": "^37.1.0",
+    "@ckeditor/ckeditor5-clipboard": "^37.1.0",
+    "@ckeditor/ckeditor5-cloud-services": "^37.1.0",
+    "@ckeditor/ckeditor5-core": "^37.1.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.1.0",
+    "@ckeditor/ckeditor5-enter": "^37.1.0",
+    "@ckeditor/ckeditor5-essentials": "^37.1.0",
+    "@ckeditor/ckeditor5-heading": "^37.1.0",
+    "@ckeditor/ckeditor5-image": "^37.1.0",
+    "@ckeditor/ckeditor5-link": "^37.1.0",
+    "@ckeditor/ckeditor5-list": "^37.1.0",
+    "@ckeditor/ckeditor5-mention": "^37.1.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.1.0",
+    "@ckeditor/ckeditor5-table": "^37.1.0",
+    "@ckeditor/ckeditor5-theme-lark": "^37.1.0",
+    "@ckeditor/ckeditor5-typing": "^37.1.0",
+    "@ckeditor/ckeditor5-ui": "^37.1.0",
+    "@ckeditor/ckeditor5-undo": "^37.1.0",
+    "@ckeditor/ckeditor5-widget": "^37.1.0",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"

package/src/controller/editingcontroller.js

@@ -5,13 +5,14 @@
 /**
  * @module engine/controller/editingcontroller
  */
-import { CKEditorError, ObservableMixin } from '@ckeditor/ckeditor5-utils';
+import { CKEditorError, ObservableMixin, env } from '@ckeditor/ckeditor5-utils';
 import RootEditableElement from '../view/rooteditableelement';
 import View from '../view/view';
 import Mapper from '../conversion/mapper';
 import DowncastDispatcher from '../conversion/downcastdispatcher';
 import { clearAttributes, convertCollapsedSelection, convertRangeSelection, insertAttributesAndChildren, insertText, remove } from '../conversion/downcasthelpers';
 import { convertSelectionChange } from '../conversion/upcasthelpers';
+import { tryFixingRange } from '../model/utils/selection-post-fixer';
 // @if CK_DEBUG_ENGINE // const { dumpTrees, initDocumentDumping } = require( '../dev-utils/utils' );
 /**
  * A controller for the editing pipeline. The editing pipeline controls the {@link ~EditingController#model model} rendering,
@@ -59,6 +60,8 @@ export default class EditingController extends ObservableMixin() {
         }, { priority: 'low' });
         // Convert selection from the view to the model when it changes in the view.
         this.listenTo(this.view.document, 'selectionChange', convertSelectionChange(this.model, this.mapper));
+        // Fix `beforeinput` target ranges so that they map to the valid model ranges.
+        this.listenTo(this.view.document, 'beforeinput', fixTargetRanges(this.mapper, this.model.schema, this.view), { priority: 'high' });
         // Attach default model converters.
         this.downcastDispatcher.on('insert:$text', insertText(), { priority: 'lowest' });
         this.downcastDispatcher.on('insert', insertAttributesAndChildren(), { priority: 'lowest' });
@@ -163,3 +166,26 @@ export default class EditingController extends ObservableMixin() {
         });
     }
 }
+/**
+ * Checks whether the target ranges provided by the `beforeInput` event can be properly mapped to model ranges and fixes them if needed.
+ *
+ * This is using the same logic as the selection post-fixer.
+ */
+function fixTargetRanges(mapper, schema, view) {
+    return (evt, data) => {
+        // The Renderer is disabled while composing on non-android browsers, so we can't be sure that target ranges
+        // could be properly mapped to view and model because the DOM and view tree drifted apart.
+        if (view.document.isComposing && !env.isAndroid) {
+            return;
+        }
+        for (let i = 0; i < data.targetRanges.length; i++) {
+            const viewRange = data.targetRanges[i];
+            const modelRange = mapper.toModelRange(viewRange);
+            const correctedRange = tryFixingRange(modelRange, schema);
+            if (!correctedRange || correctedRange.isEqual(modelRange)) {
+                continue;
+            }
+            data.targetRanges[i] = mapper.toViewRange(correctedRange);
+        }
+    };
+}

package/src/conversion/downcasthelpers.js

@@ -1958,7 +1958,7 @@ function createChangeReducerCallback(model) {
             }
         }
         else {
-            /* istanbul ignore else: This is always true because otherwise it would not register a reducer callback. */
+            /* istanbul ignore else: This is always true because otherwise it would not register a reducer callback. -- @preserve */
             if (model.children) {
                 return true;
             }

package/src/model/markercollection.d.ts

@@ -137,7 +137,7 @@ export interface MarkerData {
 }
 declare const Marker_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
 /**
- * `Marker` is a continuous parts of model (like a range), is named and represent some kind of information about marked
+ * `Marker` is a continuous part of model (like a range), is named and represent some kind of information about marked
  * part of model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
  * model document tree, markers are not stored directly in document tree but in
  * {@link module:engine/model/model~Model#markers model markers' collection}. Still, they are document data, by giving

package/src/model/markercollection.js

@@ -214,7 +214,7 @@ export default class MarkerCollection extends EmitterMixin() {
     }
 }
 /**
- * `Marker` is a continuous parts of model (like a range), is named and represent some kind of information about marked
+ * `Marker` is a continuous part of model (like a range), is named and represent some kind of information about marked
  * part of model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
  * model document tree, markers are not stored directly in document tree but in
  * {@link module:engine/model/model~Model#markers model markers' collection}. Still, they are document data, by giving

package/src/model/model.js

@@ -168,7 +168,7 @@ export default class Model extends ObservableMixin() {
         }
         catch (err) {
             // @if CK_DEBUG // throw err;
-            /* istanbul ignore next */
+            /* istanbul ignore next -- @preserve */
             CKEditorError.rethrowUnexpectedError(err, this);
         }
     }
@@ -191,7 +191,7 @@ export default class Model extends ObservableMixin() {
         }
         catch (err) {
             // @if CK_DEBUG // throw err;
-            /* istanbul ignore next */
+            /* istanbul ignore next -- @preserve */
             CKEditorError.rethrowUnexpectedError(err, this);
         }
     }

package/src/model/selection.d.ts

@@ -362,13 +362,23 @@ export default class Selection extends Selection_base {
      * </block>
      * ```
      *
-     * **Special case**: If a selection ends at the beginning of a block, that block is not returned as from user perspective
-     * this block wasn't selected. See [#984](https://github.com/ckeditor/ckeditor5-engine/issues/984) for more details.
+     * **Special case**: Selection ignores first and/or last blocks if nothing (from user perspective) is selected in them.
      *
      * ```xml
+     * // Selection ends and the beginning of the last block.
      * <paragraph>[a</paragraph>
      * <paragraph>b</paragraph>
-     * <paragraph>]c</paragraph> // this block will not be returned
+     * <paragraph>]c</paragraph> // This block will not be returned
+     *
+     * // Selection begins at the end of the first block.
+     * <paragraph>a[</paragraph> // This block will not be returned
+     * <paragraph>b</paragraph>
+     * <paragraph>c]</paragraph>
+     *
+     * // Selection begings at the end of the first block and ends at the beginning of the last block.
+     * <paragraph>a[</paragraph> // This block will not be returned
+     * <paragraph>b</paragraph>
+     * <paragraph>]c</paragraph> // This block will not be returned
      * ```
      */
     getSelectedBlocks(): IterableIterator<Element>;

package/src/model/selection.js

@@ -557,13 +557,23 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
      * </block>
      * ```
      *
-     * **Special case**: If a selection ends at the beginning of a block, that block is not returned as from user perspective
-     * this block wasn't selected. See [#984](https://github.com/ckeditor/ckeditor5-engine/issues/984) for more details.
+     * **Special case**: Selection ignores first and/or last blocks if nothing (from user perspective) is selected in them.
      *
      * ```xml
+     * // Selection ends and the beginning of the last block.
      * <paragraph>[a</paragraph>
      * <paragraph>b</paragraph>
-     * <paragraph>]c</paragraph> // this block will not be returned
+     * <paragraph>]c</paragraph> // This block will not be returned
+     *
+     * // Selection begins at the end of the first block.
+     * <paragraph>a[</paragraph> // This block will not be returned
+     * <paragraph>b</paragraph>
+     * <paragraph>c]</paragraph>
+     *
+     * // Selection begings at the end of the first block and ends at the beginning of the last block.
+     * <paragraph>a[</paragraph> // This block will not be returned
+     * <paragraph>b</paragraph>
+     * <paragraph>]c</paragraph> // This block will not be returned
      * ```
      */
     *getSelectedBlocks() {
@@ -571,7 +581,7 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
         for (const range of this.getRanges()) {
             // Get start block of range in case of a collapsed range.
             const startBlock = getParentBlock(range.start, visited);
-            if (startBlock && isTopBlockInRange(startBlock, range)) {
+            if (isStartBlockSelected(startBlock, range)) {
                 yield startBlock;
             }
             for (const value of range.getWalker()) {
@@ -581,8 +591,7 @@ export default class Selection extends EmitterMixin(TypeCheckable) {
                 }
             }
             const endBlock = getParentBlock(range.end, visited);
-            // #984. Don't return the end block if the range ends right at its beginning.
-            if (endBlock && !range.end.isTouching(Position._createAt(endBlock, 0)) && isTopBlockInRange(endBlock, range)) {
+            if (isEndBlockSelected(endBlock, range)) {
                 yield endBlock;
             }
         }
@@ -709,6 +718,62 @@ function isTopBlockInRange(block, range) {
     const isParentInRange = range.containsRange(Range._createOn(parentBlock), true);
     return !isParentInRange;
 }
+/**
+ * If a selection starts at the end of a block, that block is not returned as from user perspective this block wasn't selected.
+ * See [#11585](https://github.com/ckeditor/ckeditor5/issues/11585) for more details.
+ *
+ * ```xml
+ * <paragraph>a[</paragraph> // This block will not be returned
+ * <paragraph>b</paragraph>
+ * <paragraph>c]</paragraph>
+ * ```
+ *
+ * Collapsed selection is not affected by it:
+ *
+ * ```xml
+ * <paragraph>a[]</paragraph> // This block will be returned
+ * ```
+ */
+function isStartBlockSelected(startBlock, range) {
+    if (!startBlock) {
+        return false;
+    }
+    if (range.isCollapsed || startBlock.isEmpty) {
+        return true;
+    }
+    if (range.start.isTouching(Position._createAt(startBlock, startBlock.maxOffset))) {
+        return false;
+    }
+    return isTopBlockInRange(startBlock, range);
+}
+/**
+ * If a selection ends at the beginning of a block, that block is not returned as from user perspective this block wasn't selected.
+ * See [#984](https://github.com/ckeditor/ckeditor5-engine/issues/984) for more details.
+ *
+ * ```xml
+ * <paragraph>[a</paragraph>
+ * <paragraph>b</paragraph>
+ * <paragraph>]c</paragraph> // this block will not be returned
+ * ```
+ *
+ * Collapsed selection is not affected by it:
+ *
+ * ```xml
+ * <paragraph>[]a</paragraph> // this block will be returned
+ * ```
+ */
+function isEndBlockSelected(endBlock, range) {
+    if (!endBlock) {
+        return false;
+    }
+    if (range.isCollapsed || endBlock.isEmpty) {
+        return true;
+    }
+    if (range.end.isTouching(Position._createAt(endBlock, 0))) {
+        return false;
+    }
+    return isTopBlockInRange(endBlock, range);
+}
 /**
  * Returns first ancestor block of a node.
  */

package/src/model/typecheckable.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 export default class TypeCheckable {
-    /* istanbul ignore next */
+    /* istanbul ignore next -- @preserve */
     is() {
         // There are a lot of overloads above.
         // Overriding method in derived classes remove them and only `is( type: string ): boolean` is visible which we don't want.

package/src/model/utils/insertcontent.js

@@ -162,7 +162,7 @@ export default function insertContent(model, content, selectable) {
                 selectionLiveRange.detach();
             }
         }
-        /* istanbul ignore else */
+        /* istanbul ignore else -- @preserve */
         if (newRange) {
             if (selection instanceof DocumentSelection) {
                 writer.setSelection(newRange);
@@ -253,7 +253,7 @@ class Insertion {
         // If the real end was after the last auto paragraph then update relevant properties.
         if (positionAfterNode.isAfter(positionAfterLastNode)) {
             this._lastNode = node;
-            /* istanbul ignore if */
+            /* istanbul ignore if -- @preserve */
             if (this.position.parent != node || !this.position.isAtEnd) {
                 // Algorithm's correctness check. We should never end up here but it's good to know that we did.
                 // At this point the insertion position should be at the end of the last auto paragraph.
@@ -386,7 +386,7 @@ class Insertion {
      * @param node The node to insert.
      */
     _appendToFragment(node) {
-        /* istanbul ignore if */
+        /* istanbul ignore if -- @preserve */
         if (!this.schema.checkChild(this.position, node)) {
             // Algorithm's correctness check. We should never end up here but it's good to know that we did.
             // Note that it would often be a silent issue if we insert node in a place where it's not allowed.
@@ -517,7 +517,7 @@ class Insertion {
         }
         const mergePosRight = LivePosition._createAfter(node);
         mergePosRight.stickiness = 'toNext';
-        /* istanbul ignore if */
+        /* istanbul ignore if -- @preserve */
         if (!this.position.isEqual(mergePosRight)) {
             // Algorithm's correctness check. We should never end up here but it's good to know that we did.
             // At this point the insertion position should be after the node we'll merge. If it isn't,

package/src/model/utils/selection-post-fixer.d.ts

@@ -4,6 +4,7 @@
  */
 import Range from '../range';
 import type Model from '../model';
+import type Schema from '../schema';
 /**
  * Injects selection post-fixer to the model.
  *
@@ -56,6 +57,14 @@ import type Model from '../model';
  * them to select `isLimit=true` elements.
  */
 export declare function injectSelectionPostFixer(model: Model): void;
+/**
+ * Tries fixing a range if it's incorrect.
+ *
+ * **Note:** This helper is used by the selection post-fixer and to fix the `beforeinput` target ranges.
+ *
+ * @returns Returns fixed range or null if range is valid.
+ */
+export declare function tryFixingRange(range: Range, schema: Schema): Range | null;
 /**
  * Returns a minimal non-intersecting array of ranges without duplicates.
  *

package/src/model/utils/selection-post-fixer.js

@@ -97,9 +97,11 @@ function selectionPostFixer(writer, model) {
 /**
  * Tries fixing a range if it's incorrect.
  *
+ * **Note:** This helper is used by the selection post-fixer and to fix the `beforeinput` target ranges.
+ *
  * @returns Returns fixed range or null if range is valid.
  */
-function tryFixingRange(range, schema) {
+export function tryFixingRange(range, schema) {
     if (range.isCollapsed) {
         return tryFixingCollapsedRange(range, schema);
     }

package/src/view/domconverter.js

@@ -641,7 +641,8 @@ export default class DomConverter {
             }
             else {
                 const domBefore = domParent.childNodes[domOffset - 1];
-                if (isText(domBefore) && isInlineFiller(domBefore)) {
+                // Jump over an inline filler (and also on Firefox jump over a block filler while pressing backspace in an empty paragraph).
+                if (isText(domBefore) && isInlineFiller(domBefore) || domBefore && this.isBlockFiller(domBefore)) {
                     return this.domPositionToView(domBefore.parentNode, indexOf(domBefore));
                 }
                 const viewBefore = isText(domBefore) ?

package/src/view/matcher.js

@@ -423,7 +423,7 @@ function matchAttributes(patterns, element) {
  */
 function matchClasses(patterns, element) {
     // We don't need `getter` here because patterns for classes are always normalized to `[ className, true ]`.
-    return matchPatterns(patterns, element.getClassNames(), /* istanbul ignore next */ () => { });
+    return matchPatterns(patterns, element.getClassNames(), /* istanbul ignore next -- @preserve */ () => { });
 }
 /**
  * Checks if styles of provided element can be matched against provided patterns.

package/src/view/observer/bubblingemittermixin.js

@@ -77,7 +77,7 @@ export default function BubblingEmitterMixin(base) {
             }
             catch (err) {
                 // @if CK_DEBUG // throw err;
-                /* istanbul ignore next */
+                /* istanbul ignore next -- @preserve */
                 CKEditorError.rethrowUnexpectedError(err, this);
             }
         }

package/src/view/observer/selectionobserver.js

@@ -116,7 +116,7 @@ export default class SelectionObserver extends Observer {
         this._fireSelectionChangeDoneDebounced.cancel();
         this._documentIsSelectingInactivityTimeoutDebounced.cancel();
     }
-    /* istanbul ignore next */
+    /* istanbul ignore next -- @preserve */
     _reportInfiniteLoop() {
         // @if CK_DEBUG //		throw new Error(
         // @if CK_DEBUG //			'Selection change observer detected an infinite rendering loop.\n\n' +

package/src/view/position.js

@@ -209,11 +209,8 @@ export default class Position extends TypeCheckable {
                 return 'before';
             case 'extension':
                 return 'after';
-            /* istanbul ignore next */
-            case 'same':
-                // Already covered by `this.isEqual` above. Added so TypeScript can infer `result` as number in `default` case.
-                return 'same';
             default:
+                // Cast to number to avoid having 'same' as a type of `result`.
                 return thisPath[result] < otherPath[result] ? 'before' : 'after';
         }
     }

package/src/view/typecheckable.js

@@ -6,7 +6,7 @@
  * @module engine/view/typecheckable
  */
 export default class TypeCheckable {
-    /* istanbul ignore next */
+    /* istanbul ignore next -- @preserve */
     is() {
         // There are a lot of overloads above.
         // Overriding method in derived classes remove them and only `is( type: string ): boolean` is visible which we don't want.

package/src/view/view.js

@@ -397,7 +397,7 @@ export default class View extends ObservableMixin() {
         }
         catch (err) {
             // @if CK_DEBUG // throw err;
-            /* istanbul ignore next */
+            /* istanbul ignore next -- @preserve */
             CKEditorError.rethrowUnexpectedError(err, this);
         }
     }