@ckeditor/ckeditor5-engine 31.1.0 → 34.0.0

package/src/model/differ.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
@@ -58,11 +58,12 @@ export default class Differ {
 		 * A map that stores all changed markers.
 		 *
 		 * The keys of the map are marker names.
-		 * The values of the map are objects with the `oldRange` and `newRange` properties. They store the marker range
-		 * state before and after the change.
+		 * The values of the map are objects with the following properties:
+		 * - `oldMarkerData`,
+		 * - `newMarkerData`.
 		 *
 		 * @private
-		 * @type {Map}
+		 * @type {Map.<String, Object>}
 		 */
 		this._changedMarkers = new Map();
 
@@ -98,6 +99,14 @@ export default class Differ {
 		 * @type {Array.<Object>|null}
 		 */
 		this._cachedChangesWithGraveyard = null;
+
+		/**
+		 * Set of model items that were marked to get refreshed in {@link #_refreshItem}.
+		 *
+		 * @private
+		 * @type {Set.<module:engine/model/item~Item>}
+		 */
+		this._refreshedItems = new Set();
 	}
 
 	/**
@@ -110,32 +119,6 @@ export default class Differ {
 		return this._changesInElement.size == 0 && this._changedMarkers.size == 0;
 	}
 
-	/**
-	 * Marks given `item` in differ to be "refreshed". It means that the item will be marked as removed and inserted in the differ changes
-	 * set, so it will be effectively re-converted when differ changes will be handled by a dispatcher.
-	 *
-	 * @param {module:engine/model/item~Item} item Item to refresh.
-	 */
-	refreshItem( item ) {
-		if ( this._isInInsertedElement( item.parent ) ) {
-			return;
-		}
-
-		this._markRemove( item.parent, item.startOffset, item.offsetSize );
-		this._markInsert( item.parent, item.startOffset, item.offsetSize );
-
-		const range = Range._createOn( item );
-
-		for ( const marker of this._markerCollection.getMarkersIntersectingRange( range ) ) {
-			const markerRange = marker.getRange();
-
-			this.bufferMarkerChange( marker.name, markerRange, markerRange, marker.affectsData );
-		}
-
-		// Clear cache after each buffered operation as it is no longer valid.
-		this._cachedChanges = null;
-	}
-
 	/**
 	 * Buffers the given operation. An operation has to be buffered before it is executed.
 	 *
@@ -208,9 +191,9 @@ export default class Differ {
 				const range = Range._createFromPositionAndShift( operation.position, 1 );
 
 				for ( const marker of this._markerCollection.getMarkersIntersectingRange( range ) ) {
-					const markerRange = marker.getRange();
+					const markerData = marker.getData();
 
-					this.bufferMarkerChange( marker.name, markerRange, markerRange, marker.affectsData );
+					this.bufferMarkerChange( marker.name, markerData, markerData );
 				}
 
 				break;
@@ -267,27 +250,23 @@ export default class Differ {
 	 * Buffers a marker change.
 	 *
 	 * @param {String} markerName The name of the marker that changed.
-	 * @param {module:engine/model/range~Range|null} oldRange Marker range before the change or `null` if the marker has just
-	 * been created.
-	 * @param {module:engine/model/range~Range|null} newRange Marker range after the change or `null` if the marker was removed.
-	 * @param {Boolean} affectsData Flag indicating whether marker affects the editor data.
+	 * @param {module:engine/model/markercollection~MarkerData} oldMarkerData Marker data before the change.
+	 * @param {module:engine/model/markercollection~MarkerData} newMarkerData Marker data after the change.
 	 */
-	bufferMarkerChange( markerName, oldRange, newRange, affectsData ) {
+	bufferMarkerChange( markerName, oldMarkerData, newMarkerData ) {
 		const buffered = this._changedMarkers.get( markerName );
 
 		if ( !buffered ) {
 			this._changedMarkers.set( markerName, {
-				oldRange,
-				newRange,
-				affectsData
+				newMarkerData,
+				oldMarkerData
 			} );
 		} else {
-			buffered.newRange = newRange;
-			buffered.affectsData = affectsData;
+			buffered.newMarkerData = newMarkerData;
 
-			if ( buffered.oldRange == null && buffered.newRange == null ) {
-				// The marker is going to be removed (`newRange == null`) but it did not exist before the first buffered change
-				// (`buffered.oldRange == null`). In this case, do not keep the marker in buffer at all.
+			if ( buffered.oldMarkerData.range == null && newMarkerData.range == null ) {
+				// The marker is going to be removed (`newMarkerData.range == null`) but it did not exist before the first buffered change
+				// (`buffered.oldMarkerData.range == null`). In this case, do not keep the marker in buffer at all.
 				this._changedMarkers.delete( markerName );
 			}
 		}
@@ -302,8 +281,8 @@ export default class Differ {
 		const result = [];
 
 		for ( const [ name, change ] of this._changedMarkers ) {
-			if ( change.oldRange != null ) {
-				result.push( { name, range: change.oldRange } );
+			if ( change.oldMarkerData.range != null ) {
+				result.push( { name, range: change.oldMarkerData.range } );
 			}
 		}
 
@@ -319,8 +298,8 @@ export default class Differ {
 		const result = [];
 
 		for ( const [ name, change ] of this._changedMarkers ) {
-			if ( change.newRange != null ) {
-				result.push( { name, range: change.newRange } );
+			if ( change.newMarkerData.range != null ) {
+				result.push( { name, range: change.newMarkerData.range } );
 			}
 		}
 
@@ -333,12 +312,12 @@ export default class Differ {
 	 * @returns {Array.<Object>}
 	 */
 	getChangedMarkers() {
-		return Array.from( this._changedMarkers ).map( item => (
+		return Array.from( this._changedMarkers ).map( ( [ name, change ] ) => (
 			{
-				name: item[ 0 ],
+				name,
 				data: {
-					oldRange: item[ 1 ].oldRange,
-					newRange: item[ 1 ].newRange
+					oldRange: change.oldMarkerData.range,
+					newRange: change.newMarkerData.range
 				}
 			}
 		) );
@@ -351,19 +330,33 @@ export default class Differ {
 	 *
 	 * * model structure changes,
 	 * * attribute changes,
-	 * * changes of markers which were defined as `affectingData`.
+	 * * changes of markers which were defined as `affectsData`,
+	 * * changes of markers' `affectsData` property.
 	 *
 	 * @returns {Boolean}
 	 */
 	hasDataChanges() {
-		for ( const [ , change ] of this._changedMarkers ) {
-			if ( change.affectsData ) {
+		if ( this._changesInElement.size > 0 ) {
+			return true;
+		}
+
+		for ( const { newMarkerData, oldMarkerData } of this._changedMarkers.values() ) {
+			if ( newMarkerData.affectsData !== oldMarkerData.affectsData ) {
 				return true;
 			}
+
+			if ( newMarkerData.affectsData ) {
+				const markerAdded = newMarkerData.range && !oldMarkerData.range;
+				const markerRemoved = !newMarkerData.range && oldMarkerData.range;
+				const markerChanged = newMarkerData.range && oldMarkerData.range && !newMarkerData.range.isEqual( oldMarkerData.range );
+
+				if ( markerAdded || markerRemoved || markerChanged ) {
+					return true;
+				}
+			}
 		}
 
-		// If markers do not affect the data, check whether there are some changes in elements.
-		return this._changesInElement.size > 0;
+		return false;
 	}
 
 	/**
@@ -430,12 +423,12 @@ export default class Differ {
 			for ( const action of actions ) {
 				if ( action === 'i' ) {
 					// Generate diff item for this element and insert it into the diff set.
-					diffSet.push( this._getInsertDiff( element, i, elementChildren[ i ].name ) );
+					diffSet.push( this._getInsertDiff( element, i, elementChildren[ i ] ) );
 
 					i++;
 				} else if ( action === 'r' ) {
 					// Generate diff item for this element and insert it into the diff set.
-					diffSet.push( this._getRemoveDiff( element, i, snapshotChildren[ j ].name ) );
+					diffSet.push( this._getRemoveDiff( element, i, snapshotChildren[ j ] ) );
 
 					j++;
 				} else if ( action === 'a' ) {
@@ -540,16 +533,25 @@ export default class Differ {
 		this._changeCount = 0;
 
 		// Cache changes.
-		this._cachedChangesWithGraveyard = diffSet.slice();
+		this._cachedChangesWithGraveyard = diffSet;
 		this._cachedChanges = diffSet.filter( _changesInGraveyardFilter );
 
 		if ( options.includeChangesInGraveyard ) {
-			return this._cachedChangesWithGraveyard;
+			return this._cachedChangesWithGraveyard.slice();
 		} else {
-			return this._cachedChanges;
+			return this._cachedChanges.slice();
 		}
 	}
 
+	/**
+	 * Returns a set of model items that were marked to get refreshed.
+	 *
+	 * @return {Set.<module:engine/model/item~Item>}
+	 */
+	getRefreshedItems() {
+		return new Set( this._refreshedItems );
+	}
+
 	/**
 	 * Resets `Differ`. Removes all buffered changes.
 	 */
@@ -557,6 +559,36 @@ export default class Differ {
 		this._changesInElement.clear();
 		this._elementSnapshots.clear();
 		this._changedMarkers.clear();
+		this._refreshedItems = new Set();
+		this._cachedChanges = null;
+	}
+
+	/**
+	 * Marks the given `item` in differ to be "refreshed". It means that the item will be marked as removed and inserted
+	 * in the differ changes set, so it will be effectively re-converted when the differ changes are handled by a dispatcher.
+	 *
+	 * @protected
+	 * @param {module:engine/model/item~Item} item Item to refresh.
+	 */
+	_refreshItem( item ) {
+		if ( this._isInInsertedElement( item.parent ) ) {
+			return;
+		}
+
+		this._markRemove( item.parent, item.startOffset, item.offsetSize );
+		this._markInsert( item.parent, item.startOffset, item.offsetSize );
+
+		this._refreshedItems.add( item );
+
+		const range = Range._createOn( item );
+
+		for ( const marker of this._markerCollection.getMarkersIntersectingRange( range ) ) {
+			const markerData = marker.getData();
+
+			this.bufferMarkerChange( marker.name, markerData, markerData );
+		}
+
+		// Clear cache after each buffered operation as it is no longer valid.
 		this._cachedChanges = null;
 	}
 
@@ -897,14 +929,15 @@ export default class Differ {
 	 * @private
 	 * @param {module:engine/model/element~Element} parent The element in which the change happened.
 	 * @param {Number} offset The offset at which change happened.
-	 * @param {String} name The name of the removed element or `'$text'` for a character.
+	 * @param {Object} elementSnapshot The snapshot of the removed element a character.
 	 * @returns {Object} The diff item.
 	 */
-	_getInsertDiff( parent, offset, name ) {
+	_getInsertDiff( parent, offset, elementSnapshot ) {
 		return {
 			type: 'insert',
 			position: Position._createAt( parent, offset ),
-			name,
+			name: elementSnapshot.name,
+			attributes: new Map( elementSnapshot.attributes ),
 			length: 1,
 			changeCount: this._changeCount++
 		};
@@ -916,14 +949,15 @@ export default class Differ {
 	 * @private
 	 * @param {module:engine/model/element~Element} parent The element in which change happened.
 	 * @param {Number} offset The offset at which change happened.
-	 * @param {String} name The name of the removed element or `'$text'` for a character.
+	 * @param {Object} elementSnapshot The snapshot of the removed element a character.
 	 * @returns {Object} The diff item.
 	 */
-	_getRemoveDiff( parent, offset, name ) {
+	_getRemoveDiff( parent, offset, elementSnapshot ) {
 		return {
 			type: 'remove',
 			position: Position._createAt( parent, offset ),
-			name,
+			name: elementSnapshot.name,
+			attributes: new Map( elementSnapshot.attributes ),
 			length: 1,
 			changeCount: this._changeCount++
 		};
@@ -1201,6 +1235,12 @@ function _changesInGraveyardFilter( entry ) {
  * @member {String} module:engine/model/differ~DiffItemInsert#name
  */
 
+/**
+ * Map of attributes that were set on the item while it was inserted.
+ *
+ * @member {Map.<String,*>} module:engine/model/differ~DiffItemInsert#attributes
+ */
+
 /**
  * The position where the node was inserted.
  *
@@ -1232,6 +1272,12 @@ function _changesInGraveyardFilter( entry ) {
  * @member {String} module:engine/model/differ~DiffItemRemove#name
  */
 
+/**
+ * Map of attributes that were set on the item while it was removed.
+ *
+ * @member {Map.<String,*>} module:engine/model/differ~DiffItemRemove#attributes
+ */
+
 /**
  * The position where the node was removed.
  *

package/src/model/document.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
@@ -157,14 +157,23 @@ export default class Document {
 		// Buffer marker changes.
 		// This is not covered in buffering operations because markers may change outside of them (when they
 		// are modified using `model.markers` collection, not through `MarkerOperation`).
-		this.listenTo( model.markers, 'update', ( evt, marker, oldRange, newRange ) => {
+		this.listenTo( model.markers, 'update', ( evt, marker, oldRange, newRange, oldMarkerData ) => {
+			// Copy the `newRange` to the new marker data as during the marker removal the range is not updated.
+			const newMarkerData = { ...marker.getData(), range: newRange };
+
 			// Whenever marker is updated, buffer that change.
-			this.differ.bufferMarkerChange( marker.name, oldRange, newRange, marker.affectsData );
+			this.differ.bufferMarkerChange( marker.name, oldMarkerData, newMarkerData );
 
 			if ( oldRange === null ) {
 				// If this is a new marker, add a listener that will buffer change whenever marker changes.
 				marker.on( 'change', ( evt, oldRange ) => {
-					this.differ.bufferMarkerChange( marker.name, oldRange, marker.getRange(), marker.affectsData );
+					const markerData = marker.getData();
+
+					this.differ.bufferMarkerChange(
+						marker.name,
+						{ ...markerData, range: oldRange },
+						markerData
+					);
 				} );
 			}
 		} );

package/src/model/documentfragment.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/model/documentselection.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/model/element.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/model/history.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/model/item.jsdoc

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/model/liveposition.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/model/liverange.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/model/markercollection.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
@@ -106,6 +106,8 @@ export default class MarkerCollection {
 		const oldMarker = this._markers.get( markerName );
 
 		if ( oldMarker ) {
+			const oldMarkerData = oldMarker.getData();
+
 			const oldRange = oldMarker.getRange();
 			let hasChanged = false;
 
@@ -125,7 +127,7 @@ export default class MarkerCollection {
 			}
 
 			if ( hasChanged ) {
-				this.fire( 'update:' + markerName, oldMarker, oldRange, range );
+				this.fire( 'update:' + markerName, oldMarker, oldRange, range, oldMarkerData );
 			}
 
 			return oldMarker;
@@ -135,7 +137,7 @@ export default class MarkerCollection {
 		const marker = new Marker( markerName, liveRange, managedUsingOperations, affectsData );
 
 		this._markers.set( markerName, marker );
-		this.fire( 'update:' + markerName, marker, null, range );
+		this.fire( 'update:' + markerName, marker, null, range, { ...marker.getData(), range: null } );
 
 		return marker;
 	}
@@ -154,7 +156,7 @@ export default class MarkerCollection {
 
 		if ( oldMarker ) {
 			this._markers.delete( markerName );
-			this.fire( 'update:' + markerName, oldMarker, oldMarker.getRange(), null );
+			this.fire( 'update:' + markerName, oldMarker, oldMarker.getRange(), null, oldMarker.getData() );
 
 			this._destroyMarker( oldMarker );
 
@@ -188,7 +190,7 @@ export default class MarkerCollection {
 
 		const range = marker.getRange();
 
-		this.fire( 'update:' + markerName, marker, range, range, marker.managedUsingOperations, marker.affectsData );
+		this.fire( 'update:' + markerName, marker, range, range, marker.getData() );
 	}
 
 	/**
@@ -273,11 +275,20 @@ export default class MarkerCollection {
 	 * means that marker is just added.
 	 * @param {module:engine/model/range~Range|null} newRange Marker range after update. When is not defined it
 	 * means that marker is just removed.
+	 * @param {module:engine/model/markercollection~MarkerData} oldMarkerData Data of the marker before the change.
 	 */
 }
 
 mix( MarkerCollection, EmitterMixin );
 
+/**
+ * @typedef {Object} module:engine/model/markercollection~MarkerData
+ *
+ * @property {module:engine/model/range~Range|null} range Marker range. `null` if the marker was removed.
+ * @property {Boolean} affectsData A property defining if the marker affects data.
+ * @property {Boolean} managedUsingOperations A property defining if the marker is managed using operations.
+ */
+
 /**
  * `Marker` is a continuous parts 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
@@ -418,6 +429,19 @@ class Marker {
 		return this._affectsData;
 	}
 
+	/**
+	 * Returns the marker data (properties defining the marker).
+	 *
+	 * @returns {module:engine/model/markercollection~MarkerData}
+	 */
+	getData() {
+		return {
+			range: this.getRange(),
+			affectsData: this.affectsData,
+			managedUsingOperations: this.managedUsingOperations
+		};
+	}
+
 	/**
 	 * Returns current marker start position.
 	 *