@ckeditor/ckeditor5-typing 31.0.0 → 33.0.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor 5 typing feature** – https://github.com/ckeditor/ckeditor5-typing <br>
-Copyright (c) 2003-2021, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved.
+Copyright (c) 2003-2022, [CKSource](http://cksource.com) Holding sp. z o.o. All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
 
@@ -14,4 +14,4 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
 Trademarks
 ----------
 
-**CKEditor** is a trademark of [CKSource](http://cksource.com) Frederico Knabben. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
+**CKEditor** is a trademark of [CKSource](http://cksource.com) Holding sp. z o.o. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-typing",
-  "version": "31.0.0",
+  "version": "33.0.0",
   "description": "Typing feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,27 +12,27 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^31.0.0",
-    "@ckeditor/ckeditor5-engine": "^31.0.0",
-    "@ckeditor/ckeditor5-utils": "^31.0.0",
+    "@ckeditor/ckeditor5-core": "^33.0.0",
+    "@ckeditor/ckeditor5-engine": "^33.0.0",
+    "@ckeditor/ckeditor5-utils": "^33.0.0",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^31.0.0",
-    "@ckeditor/ckeditor5-block-quote": "^31.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^31.0.0",
-    "@ckeditor/ckeditor5-enter": "^31.0.0",
-    "@ckeditor/ckeditor5-essentials": "^31.0.0",
-    "@ckeditor/ckeditor5-heading": "^31.0.0",
-    "@ckeditor/ckeditor5-image": "^31.0.0",
-    "@ckeditor/ckeditor5-link": "^31.0.0",
-    "@ckeditor/ckeditor5-list": "^31.0.0",
-    "@ckeditor/ckeditor5-paragraph": "^31.0.0",
-    "@ckeditor/ckeditor5-undo": "^31.0.0",
-    "@ckeditor/ckeditor5-code-block": "^31.0.0"
+    "@ckeditor/ckeditor5-basic-styles": "^33.0.0",
+    "@ckeditor/ckeditor5-block-quote": "^33.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^33.0.0",
+    "@ckeditor/ckeditor5-enter": "^33.0.0",
+    "@ckeditor/ckeditor5-essentials": "^33.0.0",
+    "@ckeditor/ckeditor5-heading": "^33.0.0",
+    "@ckeditor/ckeditor5-image": "^33.0.0",
+    "@ckeditor/ckeditor5-link": "^33.0.0",
+    "@ckeditor/ckeditor5-list": "^33.0.0",
+    "@ckeditor/ckeditor5-paragraph": "^33.0.0",
+    "@ckeditor/ckeditor5-undo": "^33.0.0",
+    "@ckeditor/ckeditor5-code-block": "^33.0.0"
   },
   "engines": {
-    "node": ">=12.0.0",
+    "node": ">=14.0.0",
     "npm": ">=5.7.1"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/delete.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/deletecommand.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
  */
 
@@ -63,7 +63,8 @@ export default class DeleteCommand extends Command {
 	 *
 	 * @fires execute
 	 * @param {Object} [options] The command options.
-	 * @param {'character'} [options.unit='character'] See {@link module:engine/model/utils/modifyselection~modifySelection}'s options.
+	 * @param {'character'|'codePoint'|'word'} [options.unit='character']
+	 * See {@link module:engine/model/utils/modifyselection~modifySelection}'s options.
 	 * @param {Number} [options.sequence=1] A number describing which subsequent delete event it is without the key being released.
 	 * See the {@link module:engine/view/document~Document#event:delete} event data.
 	 * @param {module:engine/model/selection~Selection} [options.selection] Selection to remove. If not set, current model selection
@@ -88,7 +89,11 @@ export default class DeleteCommand extends Command {
 
 			// Try to extend the selection in the specified direction.
 			if ( selection.isCollapsed ) {
-				model.modifySelection( selection, { direction: this.direction, unit: options.unit } );
+				model.modifySelection( selection, {
+					direction: this.direction,
+					unit: options.unit,
+					treatEmojiAsSingleUnit: true
+				} );
 			}
 
 			// Check if deleting in an empty editor. See #61.

package/src/deleteobserver.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
  */
 
@@ -12,6 +12,7 @@ import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventd
 import BubblingEventInfo from '@ckeditor/ckeditor5-engine/src/view/observer/bubblingeventinfo';
 import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
 import env from '@ckeditor/ckeditor5-utils/src/env';
+import { isShiftDeleteOnNonCollapsedSelection } from './utils/utils';
 
 /**
  * Delete observer introduces the {@link module:engine/view/document~Document#event:delete} event.
@@ -35,6 +36,15 @@ export default class DeleteObserver extends Observer {
 		} );
 
 		document.on( 'keydown', ( evt, data ) => {
+			// Do not fire the `delete` event, if Shift + Delete key combination was pressed on a non-collapsed selection on Windows.
+			//
+			// The Shift + Delete key combination should work in the same way as the `cut` event on a non-collapsed selection on Windows.
+			// In fact, the native `cut` event is actually emitted in this case, but with lower priority. Therefore, in order to handle the
+			// Shift + Delete key combination correctly, it is enough not to emit the `delete` event.
+			if ( env.isWindows && isShiftDeleteOnNonCollapsedSelection( data, document ) ) {
+				return;
+			}
+
 			const deleteData = {};
 
 			if ( data.keyCode == keyCodes.delete ) {

package/src/index.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/input.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
  */
 
@@ -40,27 +40,4 @@ export default class Input extends Plugin {
 		injectUnsafeKeystrokesHandling( editor );
 		injectTypingMutationsHandling( editor );
 	}
-
-	/**
-	 * Checks batch if it is a result of user input - e.g. typing.
-	 *
-	 *		const input = editor.plugins.get( 'Input' );
-	 *
-	 *		editor.model.document.on( 'change:data', ( evt, batch ) => {
-	 *			if ( input.isInput( batch ) ) {
-	 *				console.log( 'The user typed something...' );
-	 *			}
-	 *		} );
-	 *
-	 * **Note:** This method checks if the batch was created using {@link module:typing/inputcommand~InputCommand 'input'}
-	 * command as typing changes coming from user input are inserted to the document using that command.
-	 *
-	 * @param {module:engine/model/batch~Batch} batch A batch to check.
-	 * @returns {Boolean}
-	 */
-	isInput( batch ) {
-		const inputCommand = this.editor.commands.get( 'input' );
-
-		return inputCommand._batches.has( batch );
-	}
 }

package/src/inputcommand.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
  */
 
@@ -35,15 +35,6 @@ export default class InputCommand extends Command {
 		 * @member {module:typing/utils/changebuffer~ChangeBuffer} #_buffer
 		 */
 		this._buffer = new ChangeBuffer( editor.model, undoStepSize );
-
-		/**
-		 * Stores batches created by the input command. The batches are used to differentiate input batches from other batches using
-		 * {@link module:typing/input~Input#isInput} method.
-		 *
-		 * @type {WeakSet<module:engine/model/batch~Batch>}
-		 * @protected
-		 */
-		this._batches = new WeakSet();
 	}
 
 	/**
@@ -89,9 +80,6 @@ export default class InputCommand extends Command {
 		model.enqueueChange( this._buffer.batch, writer => {
 			this._buffer.lock();
 
-			// Store the batch as an 'input' batch for the Input.isInput( batch ) check.
-			this._batches.add( this._buffer.batch );
-
 			model.deleteContent( selection );
 
 			if ( text ) {

package/src/texttransformation.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
  */
 
@@ -124,7 +124,6 @@ export default class TextTransformation extends Plugin {
 	_enableTransformationWatchers() {
 		const editor = this.editor;
 		const model = editor.model;
-		const inputPlugin = editor.plugins.get( 'Input' );
 		const deletePlugin = editor.plugins.get( 'Delete' );
 		const normalizedTransformations = normalizeTransformations( editor.config.get( 'typing.transformations' ) );
 
@@ -140,7 +139,7 @@ export default class TextTransformation extends Plugin {
 		};
 
 		const watcherCallback = ( evt, data ) => {
-			if ( !inputPlugin.isInput( data.batch ) ) {
+			if ( !data.batch.isTyping ) {
 				return;
 			}
 
@@ -249,8 +248,9 @@ function normalizeTransformations( config ) {
 	const configured = config.include.concat( extra ).filter( isNotRemoved );
 
 	return expandGroupsAndRemoveDuplicates( configured )
-		.filter( isNotRemoved ) // Filter out 'remove' transformations as they might be set in group
+		.filter( isNotRemoved ) // Filter out 'remove' transformations as they might be set in group.
 		.map( transformation => TRANSFORMATIONS[ transformation ] || transformation )
+		.filter( transformation => typeof transformation === 'object' ) // Filter out transformations set as string that has not been found.
 		.map( transformation => ( {
 			from: normalizeFrom( transformation.from ),
 			to: normalizeTo( transformation.to )

package/src/textwatcher.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
  */
 
@@ -117,7 +117,7 @@ export default class TextWatcher {
 		} );
 
 		this.listenTo( document, 'change:data', ( evt, batch ) => {
-			if ( batch.type == 'transparent' ) {
+			if ( batch.isUndo || !batch.isLocal ) {
 				return;
 			}
 

package/src/twostepcaretmovement.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/typing.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/utils/changebuffer.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
  */
 
@@ -70,10 +70,10 @@ export default class ChangeBuffer {
 		// The callback will check whether it is a new batch and in that case the buffer will be flushed.
 		//
 		// The reason why the buffer needs to be flushed whenever a new batch appears is that the changes added afterwards
-		// should be added to a new batch. For instance, when the  user types, then inserts an image, and then types again,
+		// should be added to a new batch. For instance, when the user types, then inserts an image, and then types again,
 		// the characters typed after inserting the image should be added to a different batch than the characters typed before.
 		this._changeCallback = ( evt, batch ) => {
-			if ( batch.type != 'transparent' && batch !== this._batch ) {
+			if ( batch.isLocal && batch.isUndoable && batch !== this._batch ) {
 				this._reset( true );
 			}
 		};
@@ -117,7 +117,7 @@ export default class ChangeBuffer {
 	 */
 	get batch() {
 		if ( !this._batch ) {
-			this._batch = this.model.createBatch();
+			this._batch = this.model.createBatch( { isTyping: true } );
 		}
 
 		return this._batch;

package/src/utils/findattributerange.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/utils/getlasttextline.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/utils/injecttypingmutationshandling.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/utils/injectunsafekeystrokeshandling.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
  */
 
@@ -9,6 +9,7 @@
 
 import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
 import env from '@ckeditor/ckeditor5-utils/src/env';
+import { isShiftDeleteOnNonCollapsedSelection } from './utils';
 
 /**
  * Handles keystrokes which are unsafe for typing. This handler's logic is explained
@@ -49,6 +50,15 @@ export default function injectUnsafeKeystrokesHandling( editor ) {
 	//
 	// @param {module:engine/view/observer/keyobserver~KeyEventData} evtData
 	function handleUnsafeKeystroke( evtData ) {
+		// Do not delete the content, if Shift + Delete key combination was pressed on a non-collapsed selection on Windows.
+		//
+		// The Shift + Delete key combination should work in the same way as the `cut` event on a non-collapsed selection on Windows.
+		// In fact, the native `cut` event is actually emitted in this case, but with lower priority. Therefore, in order to handle the
+		// Shift + Delete key combination correctly, it is enough to prevent the content deletion here.
+		if ( env.isWindows && isShiftDeleteOnNonCollapsedSelection( evtData, view.document ) ) {
+			return;
+		}
+
 		const doc = model.document;
 		const isComposing = view.document.isComposing;
 		const isSelectionUnchanged = latestCompositionSelection && latestCompositionSelection.isEqual( doc.selection );
@@ -111,7 +121,6 @@ export default function injectUnsafeKeystrokesHandling( editor ) {
 		buffer.lock();
 
 		const batch = buffer.batch;
-		inputCommand._batches.add( batch );
 
 		model.enqueueChange( batch, () => {
 			model.deleteContent( model.document.selection );

package/src/utils/inlinehighlight.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/utils/utils.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
  */
 
@@ -9,6 +9,7 @@
 
 import diff from '@ckeditor/ckeditor5-utils/src/diff';
 import diffToChanges from '@ckeditor/ckeditor5-utils/src/difftochanges';
+import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
 
 /**
  * Returns true if container children have mutated or more than a single text node was changed.
@@ -83,3 +84,21 @@ export function compareChildNodes( oldChild, newChild ) {
 		return oldChild === newChild;
 	}
 }
+
+/**
+ * Checks if <kbd>Shift</kbd> + <kbd>Delete</kbd> keystroke was pressed on a non-collapsed selection.
+ *
+ * This key combination has a special meaning on Windows machines and it should work in the same way as the `cut` event on a non-collapsed
+ * selection.
+ *
+ * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData Event data.
+ * @param {module:engine/view/document~Document} document The document instance on which the event has been fired.
+ * @returns {Boolean}
+ */
+export function isShiftDeleteOnNonCollapsedSelection( domEventData, document ) {
+	const selection = document.selection;
+	const isShiftDelete = domEventData.shiftKey && domEventData.keyCode === keyCodes.delete;
+	const isNonCollapsedSelection = !selection.isCollapsed;
+
+	return isShiftDelete && isNonCollapsedSelection;
+}