@ckeditor/ckeditor5-engine 47.1.0 → 47.2.0-alpha.0

package/README.md

@@ -2,7 +2,7 @@ CKEditor 5 editing engine
 ========================================
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-engine.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)
-[![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
+[![codecov](https://codecov.io/gh/ckeditor/ckeditor5/branch/master/graph/badge.svg)](https://codecov.io/gh/ckeditor/ckeditor5)
 [![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5?branch=master)
 
 The CKEditor 5 editing engine implements a flexible MVC-based architecture for creating rich text editing features.

package/dist/index.js

@@ -194,6 +194,18 @@ let hasDisplayedPlaceholderDeprecationWarning = false;
             continue;
         }
         const hostElement = getChildPlaceholderHostSubstitute(element);
+        // If host element changed, remove the placeholder from the previous one.
+        // This can happen when user replaces the first child element of the parent element
+        // with new one, but the previous one is still in the view tree.
+        // See:
+        // https://github.com/ckeditor/ckeditor5/issues/14354
+        // https://github.com/ckeditor/ckeditor5/issues/18149
+        if (hostElement !== config.hostElement && config.hostElement) {
+            writer.removeAttribute('data-placeholder', config.hostElement);
+            hideViewPlaceholder(writer, config.hostElement);
+            config.hostElement = null;
+            wasViewModified = true;
+        }
         // When not a direct host, it could happen that there is no child element
         // capable of displaying a placeholder.
         if (!hostElement) {
@@ -16810,13 +16822,14 @@ ModelRange.prototype.is = function(type) {
 	 * @param markers Markers related to the model fragment to convert.
 	 * @param writer The view writer that should be used to modify the view document.
 	 */ convertChanges(differ, markers, writer) {
-        const conversionApi = this._createConversionApi(writer, differ.getRefreshedItems());
+        const refreshedItems = differ.getRefreshedItems();
+        const conversionApi = this._createConversionApi(writer, refreshedItems);
         // Before the view is updated, remove markers which have changed.
         for (const change of differ.getMarkersToRemove()){
             this._convertMarkerRemove(change.name, change.range, conversionApi);
         }
         // Let features modify the change list (for example to allow reconversion).
-        const changes = this._reduceChanges(differ.getChanges());
+        const changes = this._reduceChanges(differ.getChanges(), refreshedItems);
         // Convert changes that happened on model tree.
         for (const entry of changes){
             if (entry.type === 'insert') {
@@ -16988,7 +17001,7 @@ ModelRange.prototype.is = function(type) {
         }
     }
     /**
-	 * Fires re-insertion conversion (with a `reconversion` flag passed to `insert` events)
+	 * Fires re-insertion conversion (with a `reconversion` flag passed to `remove` and `insert` events)
 	 * of a range of elements (only elements on the range depth, without children).
 	 *
 	 * For each node in the range on its depth (without children), {@link #event:insert `insert` event} is fired.
@@ -17007,6 +17020,13 @@ ModelRange.prototype.is = function(type) {
         this._addConsumablesForInsert(conversionApi.consumable, walkerValues);
         // Fire a separate insert event for each node and text fragment contained shallowly in the range.
         for (const data of walkerValues.map(walkerValueToEventData)){
+            // For backward compatibility and handlers that does not recognize reconversion.
+            this.fire(`remove:${data.item.is('element') ? data.item.name : '$text'}`, {
+                position: data.range.start,
+                length: data.item.offsetSize,
+                reconversion: true
+            }, conversionApi);
+            // Reinsert the view element.
             this._testAndFire('insert', {
                 ...data,
                 reconversion: true
@@ -17086,9 +17106,10 @@ ModelRange.prototype.is = function(type) {
 	 * `DowncastHelpers.elementToStructure()`} is using this event to trigger reconversion.
 	 *
 	 * @fires reduceChanges
-	 */ _reduceChanges(changes) {
+	 */ _reduceChanges(changes, refreshedItems) {
         const data = {
-            changes
+            changes,
+            refreshedItems
         };
         this.fire('reduceChanges', data);
         return data.changes;
@@ -20771,6 +20792,10 @@ function cloneNodes(nodes) {
  * @internal
  */ function remove() {
     return (evt, data, conversionApi)=>{
+        // Ignore reconversion related remove as it is handled in the `insert` of reconversion.
+        if (data.reconversion) {
+            return;
+        }
         // Find the view range start position by mapping the model position at which the remove happened.
         const viewStart = conversionApi.mapper.toViewPosition(data.position);
         const modelEnd = data.position.getShiftedBy(data.length);
@@ -20779,14 +20804,7 @@ function cloneNodes(nodes) {
         });
         const viewRange = conversionApi.writer.createRange(viewStart, viewEnd);
         // Trim the range to remove in case some UI elements are on the view range boundaries.
-        const removed = conversionApi.writer.remove(viewRange.getTrimmed());
-        // After the range is removed, unbind all view elements from the model.
-        // Range inside view document fragment is used to unbind deeply.
-        for (const child of conversionApi.writer.createRangeIn(removed).getItems()){
-            conversionApi.mapper.unbindViewElement(child, {
-                defer: true
-            });
-        }
+        removeRangeAndUnbind(viewRange.getTrimmed(), conversionApi);
     };
 }
 /**
@@ -21030,7 +21048,7 @@ function cloneNodes(nodes) {
         }
         // Consume an element insertion and all present attributes that are specified as a reconversion triggers.
         consumer(data.item, conversionApi.consumable);
-        const viewPosition = conversionApi.mapper.toViewPosition(data.range.start);
+        const viewPosition = data.reconversion && removeElementAndUnbind(data.item, conversionApi) || conversionApi.mapper.toViewPosition(data.range.start);
         conversionApi.mapper.bindElements(data.item, viewElement);
         conversionApi.writer.insert(viewPosition, viewElement);
         // Convert attributes before converting children.
@@ -21073,7 +21091,7 @@ function cloneNodes(nodes) {
         validateSlotsChildren(data.item, slotsMap, conversionApi);
         // Consume an element insertion and all present attributes that are specified as a reconversion triggers.
         consumer(data.item, conversionApi.consumable);
-        const viewPosition = conversionApi.mapper.toViewPosition(data.range.start);
+        const viewPosition = data.reconversion && removeElementAndUnbind(data.item, conversionApi) || conversionApi.mapper.toViewPosition(data.range.start);
         conversionApi.mapper.bindElements(data.item, viewElement);
         conversionApi.writer.insert(viewPosition, viewElement);
         // Convert attributes before converting children.
@@ -21134,6 +21152,25 @@ function cloneNodes(nodes) {
         evt.stop();
     };
 }
+/**
+ * Removes given view range content and unbinds removed elements.
+ */ function removeRangeAndUnbind(viewRange, conversionApi) {
+    const removed = conversionApi.writer.remove(viewRange);
+    // After the range is removed, unbind all view elements from the model.
+    // Range inside view document fragment is used to unbind deeply.
+    for (const child of conversionApi.writer.createRangeIn(removed).getItems()){
+        conversionApi.mapper.unbindViewElement(child, {
+            defer: true
+        });
+    }
+    return viewRange.start;
+}
+/**
+ * Removes view element for given model element and unbinds removed view elements.
+ */ function removeElementAndUnbind(modelElement, conversionApi) {
+    const viewElement = conversionApi.mapper.toViewElement(modelElement);
+    return viewElement && removeRangeAndUnbind(conversionApi.writer.createRangeOn(viewElement), conversionApi);
+}
 /**
  * Function factory that returns a default downcast converter for removing a {@link module:engine/view/uielement~ViewUIElement UI element}
  * based on marker remove change.
@@ -21949,10 +21986,14 @@ function getFromAttributeCreator(config) {
             // For attribute use node affected by the change.
             // For insert or remove use parent element because we need to check if it's added/removed child.
             const node = change.type == 'attribute' ? change.range.start.nodeAfter : change.position.parent;
-            if (!node || !shouldReplace(node, change)) {
+            if (!node || !shouldReplace(node, change) || change.type == 'reinsert') {
                 reducedChanges.push(change);
                 continue;
             }
+            // Force to not-reuse view elements renamed in model.
+            if (change.type == 'insert' && change.action == 'rename') {
+                data.refreshedItems.add(change.position.nodeAfter);
+            }
             // If it's already marked for reconversion, so skip this change, otherwise add the diff items.
             if (!data.reconvertedElements.has(node)) {
                 data.reconvertedElements.add(node);
@@ -21971,11 +22012,6 @@ function getFromAttributeCreator(config) {
                     changeIndex = i;
                 }
                 reducedChanges.splice(changeIndex, 0, {
-                    type: 'remove',
-                    name: node.name,
-                    position,
-                    length: 1
-                }, {
                     type: 'reinsert',
                     name: node.name,
                     position,
@@ -22080,6 +22116,7 @@ function getFromAttributeCreator(config) {
     // Fill slots with nested view nodes.
     for ([currentSlot, currentSlotNodes] of slotsMap){
         reinsertOrConvertNodes(viewElement, currentSlotNodes, conversionApi, options);
+        conversionApi.writer.setCustomProperty('$structureSlotParent', true, currentSlot.parent);
         conversionApi.writer.move(conversionApi.writer.createRangeIn(currentSlot), conversionApi.writer.createPositionBefore(currentSlot));
         conversionApi.writer.remove(currentSlot);
     }
@@ -35460,7 +35497,10 @@ function removeRangeContent(range, writer) {
 	 * @param nodes Nodes to insert.
 	 */ handleNodes(nodes) {
         for (const node of Array.from(nodes)){
-            this._handleNode(node);
+            // Ignore empty nodes, especially empty text nodes.
+            if (node.offsetSize > 0) {
+                this._handleNode(node);
+            }
         }
         // Insert nodes collected in temporary ModelDocumentFragment.
         this._insertPartialFragment();
@@ -35536,7 +35576,7 @@ function removeRangeContent(range, writer) {
             return;
         }
         // Add node to the current temporary ModelDocumentFragment.
-        this._appendToFragment(node);
+        node = this._appendToFragment(node);
         // Store the first and last nodes for easy access for merging with sibling nodes.
         if (!this._firstNode) {
             this._firstNode = node;
@@ -35598,6 +35638,11 @@ function removeRangeContent(range, writer) {
         }
         this.writer.insert(node, this._documentFragmentPosition);
         this._documentFragmentPosition = this._documentFragmentPosition.getShiftedBy(node.offsetSize);
+        // In case text node was merged with already inserted text node, we need to get the actual node that is in the document.
+        // This happens when there is a non-allowed object between text nodes.
+        if (!node.parent) {
+            node = this._documentFragmentPosition.nodeBefore;
+        }
         // The last inserted object should be selected because we can't put a collapsed selection after it.
         if (this.schema.isObject(node) && !this.schema.checkChild(this.position, '$text')) {
             this._nodeToSelect = node;
@@ -35605,6 +35650,7 @@ function removeRangeContent(range, writer) {
             this._nodeToSelect = null;
         }
         this._filterAttributesOf.push(node);
+        return node;
     }
     /**
 	 * Sets `_affectedStart` and `_affectedEnd` to the given `position`. Should be used before a change is done during insertion process to
@@ -35848,12 +35894,13 @@ function removeRangeContent(range, writer) {
 	 * @param contextElement The element in which context the node should be checked.
 	 * @param childNode The node to check.
 	 */ _getAllowedIn(contextElement, childNode) {
+        const context = this.schema.createContext(contextElement);
         // Check if a node can be inserted in the given context...
-        if (this.schema.checkChild(contextElement, childNode)) {
+        if (this.schema.checkChild(context, childNode)) {
             return contextElement;
         }
         // ...or it would be accepted if a paragraph would be inserted.
-        if (this.schema.checkChild(contextElement, 'paragraph') && this.schema.checkChild('paragraph', childNode)) {
+        if (this.schema.checkChild(context, 'paragraph') && this.schema.checkChild(context.push('paragraph'), childNode)) {
             return contextElement;
         }
         // If the child wasn't allowed in the context element and the element is a limit there's no point in
@@ -35933,8 +35980,9 @@ function removeRangeContent(range, writer) {
         }
         let elementToInsert = object;
         const insertionPositionParent = insertionSelection.anchor.parent;
-        // Autoparagraphing of an inline objects.
-        if (!model.schema.checkChild(insertionPositionParent, object) && model.schema.checkChild(insertionPositionParent, 'paragraph') && model.schema.checkChild('paragraph', object)) {
+        const context = model.schema.createContext(insertionPositionParent);
+        // Auto-paragraphing of an inline objects.
+        if (!model.schema.checkChild(context, object) && model.schema.checkChild(context, 'paragraph') && model.schema.checkChild(context.push('paragraph'), object)) {
             elementToInsert = writer.createElement('paragraph');
             writer.insert(object, elementToInsert);
         }