@ckeditor/ckeditor5-typing 35.2.1 → 35.3.0

package/src/typing.js

@@ -2,15 +2,12 @@
  * @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
  */
-
 /**
  * @module typing/typing
  */
-
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import Input from './input';
 import Delete from './delete';
-
 /**
  * The typing feature. It handles typing.
  *
@@ -20,44 +17,13 @@ import Delete from './delete';
  * @extends module:core/plugin~Plugin
  */
 export default class Typing extends Plugin {
-	static get requires() {
-		return [ Input, Delete ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'Typing';
-	}
+    static get requires() {
+        return [Input, Delete];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Typing';
+    }
 }
-
-/**
- * The configuration of the typing features. Used by the features from the `@ckeditor/ckeditor5-typing` package.
- *
- * Read more in {@link module:typing/typing~TypingConfig}.
- *
- * @member {module:typing/typing~TypingConfig} module:core/editor/editorconfig~EditorConfig#typing
- */
-
-/**
- * The configuration of the typing features. Used by the typing features in `@ckeditor/ckeditor5-typing` package.
- *
- *		ClassicEditor
- *			.create( editorElement, {
- * 				typing: ... // Typing feature options.
- *			} )
- *			.then( ... )
- *			.catch( ... );
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- *
- * @interface TypingConfig
- */
-
-/**
- * The granularity of undo/redo for typing and deleting. The value `20` means (more or less) that a new undo step
- * is created every 20 characters are inserted or deleted.
- *
- * @member {Number} [module:typing/typing~TypingConfig#undoStep=20]
- */

package/src/typingconfig.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/utils/changebuffer.js

@@ -2,11 +2,6 @@
  * @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
  */
-
-/**
- * @module typing/utils/changebuffer
- */
-
 /**
  * Change buffer allows to group atomic changes (like characters that have been typed) into
  * {@link module:engine/model/batch~Batch batches}.
@@ -26,150 +21,146 @@
  *
  */
 export default class ChangeBuffer {
-	/**
-	 * Creates a new instance of the change buffer.
-	 *
-	 * @param {module:engine/model/model~Model} model
-	 * @param {Number} [limit=20] The maximum number of atomic changes which can be contained in one batch.
-	 */
-	constructor( model, limit = 20 ) {
-		/**
-		 * The model instance.
-		 *
-		 * @readonly
-		 * @member {module:engine/model/model~Model} #model
-		 */
-		this.model = model;
-
-		/**
-		 * The number of atomic changes in the buffer. Once it exceeds the {@link #limit},
-		 * the {@link #batch batch} is set to a new one.
-		 *
-		 * @readonly
-		 * @member {Number} #size
-		 */
-		this.size = 0;
-
-		/**
-		 * The maximum number of atomic changes which can be contained in one batch.
-		 *
-		 * @readonly
-		 * @member {Number} #limit
-		 */
-		this.limit = limit;
-
-		/**
-		 * Whether the buffer is locked. A locked buffer cannot be reset unless it gets unlocked.
-		 *
-		 * @readonly
-		 * @member {Boolean} #isLocked
-		 */
-		this.isLocked = false;
-
-		// The function to be called in order to notify the buffer about batches which appeared in the document.
-		// 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,
-		// 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.isLocal && batch.isUndoable && batch !== this._batch ) {
-				this._reset( true );
-			}
-		};
-
-		this._selectionChangeCallback = () => {
-			this._reset();
-		};
-
-		this.model.document.on( 'change', this._changeCallback );
-
-		this.model.document.selection.on( 'change:range', this._selectionChangeCallback );
-		this.model.document.selection.on( 'change:attribute', this._selectionChangeCallback );
-
-		/**
-		 * The current batch instance.
-		 *
-		 * @private
-		 * @member #_batch
-		 */
-
-		/**
-		 * The callback to document the change event which later needs to be removed.
-		 *
-		 * @private
-		 * @member #_changeCallback
-		 */
-
-		/**
-		 * The callback to document selection `change:attribute` and `change:range` events which resets the buffer.
-		 *
-		 * @private
-		 * @member #_selectionChangeCallback
-		 */
-	}
-
-	/**
-	 * The current batch to which a feature should add its operations. Once the {@link #size}
-	 * is reached or exceeds the {@link #limit}, the batch is set to a new instance and the size is reset.
-	 *
-	 * @type {module:engine/model/batch~Batch}
-	 */
-	get batch() {
-		if ( !this._batch ) {
-			this._batch = this.model.createBatch( { isTyping: true } );
-		}
-
-		return this._batch;
-	}
-
-	/**
-	 * The input number of changes into the buffer. Once the {@link #size} is
-	 * reached or exceeds the {@link #limit}, the batch is set to a new instance and the size is reset.
-	 *
-	 * @param {Number} changeCount The number of atomic changes to input.
-	 */
-	input( changeCount ) {
-		this.size += changeCount;
-
-		if ( this.size >= this.limit ) {
-			this._reset( true );
-		}
-	}
-
-	/**
-	 * Locks the buffer.
-	 */
-	lock() {
-		this.isLocked = true;
-	}
-
-	/**
-	 * Unlocks the buffer.
-	 */
-	unlock() {
-		this.isLocked = false;
-	}
-
-	/**
-	 * Destroys the buffer.
-	 */
-	destroy() {
-		this.model.document.off( 'change', this._changeCallback );
-		this.model.document.selection.off( 'change:range', this._selectionChangeCallback );
-		this.model.document.selection.off( 'change:attribute', this._selectionChangeCallback );
-	}
-
-	/**
-	 * Resets the change buffer.
-	 *
-	 * @private
-	 * @param {Boolean} [ignoreLock] Whether internal lock {@link #isLocked} should be ignored.
-	 */
-	_reset( ignoreLock ) {
-		if ( !this.isLocked || ignoreLock ) {
-			this._batch = null;
-			this.size = 0;
-		}
-	}
+    /**
+     * Creates a new instance of the change buffer.
+     *
+     * @param {module:engine/model/model~Model} model
+     * @param {Number} [limit=20] The maximum number of atomic changes which can be contained in one batch.
+     */
+    constructor(model, limit = 20) {
+        this._batch = null;
+        /**
+         * The model instance.
+         *
+         * @readonly
+         * @member {module:engine/model/model~Model} #model
+         */
+        this.model = model;
+        /**
+         * The number of atomic changes in the buffer. Once it exceeds the {@link #limit},
+         * the {@link #batch batch} is set to a new one.
+         *
+         * @readonly
+         * @member {Number} #size
+         */
+        this._size = 0;
+        /**
+         * The maximum number of atomic changes which can be contained in one batch.
+         *
+         * @readonly
+         * @member {Number} #limit
+         */
+        this.limit = limit;
+        /**
+         * Whether the buffer is locked. A locked buffer cannot be reset unless it gets unlocked.
+         *
+         * @readonly
+         * @member {Boolean} #isLocked
+         */
+        this._isLocked = false;
+        // The function to be called in order to notify the buffer about batches which appeared in the document.
+        // 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,
+        // 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.isLocal && batch.isUndoable && batch !== this._batch) {
+                this._reset(true);
+            }
+        };
+        this._selectionChangeCallback = () => {
+            this._reset();
+        };
+        this.model.document.on('change', this._changeCallback);
+        this.model.document.selection.on('change:range', this._selectionChangeCallback);
+        this.model.document.selection.on('change:attribute', this._selectionChangeCallback);
+        /**
+         * The current batch instance.
+         *
+         * @private
+         * @member #_batch
+         */
+        /**
+         * The callback to document the change event which later needs to be removed.
+         *
+         * @private
+         * @member #_changeCallback
+         */
+        /**
+         * The callback to document selection `change:attribute` and `change:range` events which resets the buffer.
+         *
+         * @private
+         * @member #_selectionChangeCallback
+         */
+    }
+    /**
+     * The current batch to which a feature should add its operations. Once the {@link #size}
+     * is reached or exceeds the {@link #limit}, the batch is set to a new instance and the size is reset.
+     *
+     * @type {module:engine/model/batch~Batch}
+     */
+    get batch() {
+        if (!this._batch) {
+            this._batch = this.model.createBatch({ isTyping: true });
+        }
+        return this._batch;
+    }
+    /**
+     * The number of atomic changes in the buffer. Once it exceeds the {@link #limit},
+     * the {@link #batch batch} is set to a new one.
+     */
+    get size() {
+        return this._size;
+    }
+    /**
+     * The input number of changes into the buffer. Once the {@link #size} is
+     * reached or exceeds the {@link #limit}, the batch is set to a new instance and the size is reset.
+     *
+     * @param {Number} changeCount The number of atomic changes to input.
+     */
+    input(changeCount) {
+        this._size += changeCount;
+        if (this._size >= this.limit) {
+            this._reset(true);
+        }
+    }
+    /**
+     * Whether the buffer is locked. A locked buffer cannot be reset unless it gets unlocked.
+     */
+    get isLocked() {
+        return this._isLocked;
+    }
+    /**
+     * Locks the buffer.
+     */
+    lock() {
+        this._isLocked = true;
+    }
+    /**
+     * Unlocks the buffer.
+     */
+    unlock() {
+        this._isLocked = false;
+    }
+    /**
+     * Destroys the buffer.
+     */
+    destroy() {
+        this.model.document.off('change', this._changeCallback);
+        this.model.document.selection.off('change:range', this._selectionChangeCallback);
+        this.model.document.selection.off('change:attribute', this._selectionChangeCallback);
+    }
+    /**
+     * Resets the change buffer.
+     *
+     * @private
+     * @param {Boolean} [ignoreLock] Whether internal lock {@link #isLocked} should be ignored.
+     */
+    _reset(ignoreLock = false) {
+        if (!this.isLocked || ignoreLock) {
+            this._batch = null;
+            this._size = 0;
+        }
+    }
 }

package/src/utils/findattributerange.js

@@ -2,11 +2,6 @@
  * @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
  */
-
-/**
- * @module typing/utils/findattributerange
- */
-
 /**
  * Returns a model range that covers all consecutive nodes with the same `attributeName` and its `value`
  * that intersect the given `position`.
@@ -20,13 +15,9 @@
  * @param {module:engine/model/model~Model} model The model instance.
  * @returns {module:engine/model/range~Range} The link range.
  */
-export default function findAttributeRange( position, attributeName, value, model ) {
-	return model.createRange(
-		_findBound( position, attributeName, value, true, model ),
-		_findBound( position, attributeName, value, false, model )
-	);
+export default function findAttributeRange(position, attributeName, value, model) {
+    return model.createRange(_findBound(position, attributeName, value, true, model), _findBound(position, attributeName, value, false, model));
 }
-
 // Walks forward or backward (depends on the `lookBack` flag), node by node, as long as they have the same attribute value
 // and returns a position just before or after (depends on the `lookBack` flag) the last matched node.
 //
@@ -35,17 +26,14 @@ export default function findAttributeRange( position, attributeName, value, mode
 // @param {String} value The attribute value.
 // @param {Boolean} lookBack Whether the walk direction is forward (`false`) or backward (`true`).
 // @returns {module:engine/model/position~Position} The position just before the last matched node.
-function _findBound( position, attributeName, value, lookBack, model ) {
-	// Get node before or after position (depends on `lookBack` flag).
-	// When position is inside text node then start searching from text node.
-	let node = position.textNode || ( lookBack ? position.nodeBefore : position.nodeAfter );
-
-	let lastNode = null;
-
-	while ( node && node.getAttribute( attributeName ) == value ) {
-		lastNode = node;
-		node = lookBack ? node.previousSibling : node.nextSibling;
-	}
-
-	return lastNode ? model.createPositionAt( lastNode, lookBack ? 'before' : 'after' ) : position;
+function _findBound(position, attributeName, value, lookBack, model) {
+    // Get node before or after position (depends on `lookBack` flag).
+    // When position is inside text node then start searching from text node.
+    let node = position.textNode || (lookBack ? position.nodeBefore : position.nodeAfter);
+    let lastNode = null;
+    while (node && node.getAttribute(attributeName) == value) {
+        lastNode = node;
+        node = lookBack ? node.previousSibling : node.nextSibling;
+    }
+    return lastNode ? model.createPositionAt(lastNode, lookBack ? 'before' : 'after') : position;
 }

package/src/utils/getlasttextline.js

@@ -2,11 +2,6 @@
  * @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
  */
-
-/**
- * @module typing/utils/getlasttextline
- */
-
 /**
  * Returns the last text line from the given range.
  *
@@ -33,28 +28,15 @@
  * @param {module:engine/model/model~Model} model
  * @returns {module:typing/utils/getlasttextline~LastTextLineData}
  */
-export default function getLastTextLine( range, model ) {
-	let start = range.start;
-
-	const text = Array.from( range.getItems() ).reduce( ( rangeText, node ) => {
-		// Trim text to a last occurrence of an inline element and update range start.
-		if ( !( node.is( '$text' ) || node.is( '$textProxy' ) ) ) {
-			start = model.createPositionAfter( node );
-
-			return '';
-		}
-
-		return rangeText + node.data;
-	}, '' );
-
-	return { text, range: model.createRange( start, range.end ) };
+export default function getLastTextLine(range, model) {
+    let start = range.start;
+    const text = Array.from(range.getItems()).reduce((rangeText, node) => {
+        // Trim text to a last occurrence of an inline element and update range start.
+        if (!(node.is('$text') || node.is('$textProxy'))) {
+            start = model.createPositionAfter(node);
+            return '';
+        }
+        return rangeText + node.data;
+    }, '');
+    return { text, range: model.createRange(start, range.end) };
 }
-
-/**
- * The value returned by {@link module:typing/utils/getlasttextline~getLastTextLine}.
- *
- * @typedef {Object} module:typing/utils/getlasttextline~LastTextLineData
- *
- * @property {String} text The text from the text nodes in the last text line.
- * @property {module:engine/model/range~Range} range The range set on the text nodes in the last text line.
- */

package/src/utils/inlinehighlight.js

@@ -2,13 +2,10 @@
  * @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
  */
-
 import findAttributeRange from './findattributerange';
-
 /**
  * @module typing/utils/inlinehighlight
  */
-
 /**
  * Adds a visual highlight style to an attribute element in which the selection is anchored.
  * Together with two-step caret movement, they indicate that the user is typing inside the element.
@@ -34,53 +31,42 @@ import findAttributeRange from './findattributerange';
  * @param {String} tagName The tagName of a view item.
  * @param {String} className The class name to apply in the view.
  */
-export default function inlineHighlight( editor, attributeName, tagName, className ) {
-	const view = editor.editing.view;
-	const highlightedElements = new Set();
-
-	// Adding the class.
-	view.document.registerPostFixer( writer => {
-		const selection = editor.model.document.selection;
-		let changed = false;
-
-		if ( selection.hasAttribute( attributeName ) ) {
-			const modelRange = findAttributeRange(
-				selection.getFirstPosition(),
-				attributeName,
-				selection.getAttribute( attributeName ),
-				editor.model
-			);
-			const viewRange = editor.editing.mapper.toViewRange( modelRange );
-
-			// There might be multiple view elements in the `viewRange`, for example, when the `a` element is
-			// broken by a UIElement.
-			for ( const item of viewRange.getItems() ) {
-				if ( item.is( 'element', tagName ) && !item.hasClass( className ) ) {
-					writer.addClass( className, item );
-					highlightedElements.add( item );
-					changed = true;
-				}
-			}
-		}
-
-		return changed;
-	} );
-
-	// Removing the class.
-	editor.conversion.for( 'editingDowncast' ).add( dispatcher => {
-		// Make sure the highlight is removed on every possible event, before conversion is started.
-		dispatcher.on( 'insert', removeHighlight, { priority: 'highest' } );
-		dispatcher.on( 'remove', removeHighlight, { priority: 'highest' } );
-		dispatcher.on( 'attribute', removeHighlight, { priority: 'highest' } );
-		dispatcher.on( 'selection', removeHighlight, { priority: 'highest' } );
-
-		function removeHighlight() {
-			view.change( writer => {
-				for ( const item of highlightedElements.values() ) {
-					writer.removeClass( className, item );
-					highlightedElements.delete( item );
-				}
-			} );
-		}
-	} );
+export default function inlineHighlight(editor, attributeName, tagName, className) {
+    const view = editor.editing.view;
+    const highlightedElements = new Set();
+    // Adding the class.
+    view.document.registerPostFixer(writer => {
+        const selection = editor.model.document.selection;
+        let changed = false;
+        if (selection.hasAttribute(attributeName)) {
+            const modelRange = findAttributeRange(selection.getFirstPosition(), attributeName, selection.getAttribute(attributeName), editor.model);
+            const viewRange = editor.editing.mapper.toViewRange(modelRange);
+            // There might be multiple view elements in the `viewRange`, for example, when the `a` element is
+            // broken by a UIElement.
+            for (const item of viewRange.getItems()) {
+                if (item.is('element', tagName) && !item.hasClass(className)) {
+                    writer.addClass(className, item);
+                    highlightedElements.add(item);
+                    changed = true;
+                }
+            }
+        }
+        return changed;
+    });
+    // Removing the class.
+    editor.conversion.for('editingDowncast').add(dispatcher => {
+        // Make sure the highlight is removed on every possible event, before conversion is started.
+        dispatcher.on('insert', removeHighlight, { priority: 'highest' });
+        dispatcher.on('remove', removeHighlight, { priority: 'highest' });
+        dispatcher.on('attribute', removeHighlight, { priority: 'highest' });
+        dispatcher.on('selection', removeHighlight, { priority: 'highest' });
+        function removeHighlight() {
+            view.change(writer => {
+                for (const item of highlightedElements.values()) {
+                    writer.removeClass(className, item);
+                    highlightedElements.delete(item);
+                }
+            });
+        }
+    });
 }