@ckeditor/ckeditor5-engine 35.0.1 → 35.2.0

package/src/view/observer/arrowkeysobserver.js

@@ -2,16 +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 engine/view/observer/arrowkeysobserver
  */
-
 import Observer from './observer';
 import BubblingEventInfo from './bubblingeventinfo';
-
 import { isArrowKeyCode } from '@ckeditor/ckeditor5-utils';
-
 /**
  * Arrow keys observer introduces the {@link module:engine/view/document~Document#event:arrowKey `Document#arrowKey`} event.
  *
@@ -20,31 +16,26 @@ import { isArrowKeyCode } from '@ckeditor/ckeditor5-utils';
  * @extends module:engine/view/observer/observer~Observer
  */
 export default class ArrowKeysObserver extends Observer {
-	/**
-	 * @inheritDoc
-	 */
-	constructor( view ) {
-		super( view );
-
-		this.document.on( 'keydown', ( event, data ) => {
-			if ( this.isEnabled && isArrowKeyCode( data.keyCode ) ) {
-				const eventInfo = new BubblingEventInfo( this.document, 'arrowKey', this.document.selection.getFirstRange() );
-
-				this.document.fire( eventInfo, data );
-
-				if ( eventInfo.stop.called ) {
-					event.stop();
-				}
-			}
-		} );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	observe() {}
+    /**
+     * @inheritDoc
+     */
+    constructor(view) {
+        super(view);
+        this.document.on('keydown', (event, data) => {
+            if (this.isEnabled && isArrowKeyCode(data.keyCode)) {
+                const eventInfo = new BubblingEventInfo(this.document, 'arrowKey', this.document.selection.getFirstRange());
+                this.document.fire(eventInfo, data);
+                if (eventInfo.stop.called) {
+                    event.stop();
+                }
+            }
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    observe() { }
 }
-
 /**
  * Event fired when the user presses an arrow keys.
  *

package/src/view/observer/bubblingemittermixin.js

@@ -2,21 +2,15 @@
  * @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 engine/view/observer/bubblingemittermixin
  */
-
 import EventInfo from '@ckeditor/ckeditor5-utils/src/eventinfo';
 import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
-
-import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
+import { Emitter } from '@ckeditor/ckeditor5-utils/src/emittermixin';
 import toArray from '@ckeditor/ckeditor5-utils/src/toarray';
-
 import BubblingEventInfo from './bubblingeventinfo';
-
-const contextsSymbol = Symbol( 'bubbling contexts' );
-
+const contextsSymbol = Symbol('bubbling contexts');
 /**
  * Bubbling emitter mixin for the view document as described in the
  * {@link ~BubblingEmitter} interface.
@@ -24,126 +18,102 @@ const contextsSymbol = Symbol( 'bubbling contexts' );
  * @mixin BubblingEmitterMixin
  * @implements module:engine/view/observer/bubblingemittermixin~BubblingEmitter
  */
-const BubblingEmitterMixin = {
-	/**
-	 * @inheritDoc
-	 */
-	fire( eventOrInfo, ...eventArgs ) {
-		try {
-			const eventInfo = eventOrInfo instanceof EventInfo ? eventOrInfo : new EventInfo( this, eventOrInfo );
-			const eventContexts = getBubblingContexts( this );
-
-			if ( !eventContexts.size ) {
-				return;
-			}
-
-			updateEventInfo( eventInfo, 'capturing', this );
-
-			// The capture phase of the event.
-			if ( fireListenerFor( eventContexts, '$capture', eventInfo, ...eventArgs ) ) {
-				return eventInfo.return;
-			}
-
-			const startRange = eventInfo.startRange || this.selection.getFirstRange();
-			const selectedElement = startRange ? startRange.getContainedElement() : null;
-			const isCustomContext = selectedElement ? Boolean( getCustomContext( eventContexts, selectedElement ) ) : false;
-
-			let node = selectedElement || getDeeperRangeParent( startRange );
-
-			updateEventInfo( eventInfo, 'atTarget', node );
-
-			// For the not yet bubbling event trigger for $text node if selection can be there and it's not a custom context selected.
-			if ( !isCustomContext ) {
-				if ( fireListenerFor( eventContexts, '$text', eventInfo, ...eventArgs ) ) {
-					return eventInfo.return;
-				}
-
-				updateEventInfo( eventInfo, 'bubbling', node );
-			}
-
-			while ( node ) {
-				// Root node handling.
-				if ( node.is( 'rootElement' ) ) {
-					if ( fireListenerFor( eventContexts, '$root', eventInfo, ...eventArgs ) ) {
-						return eventInfo.return;
-					}
-				}
-
-				// Element node handling.
-				else if ( node.is( 'element' ) ) {
-					if ( fireListenerFor( eventContexts, node.name, eventInfo, ...eventArgs ) ) {
-						return eventInfo.return;
-					}
-				}
-
-				// Check custom contexts (i.e., a widget).
-				if ( fireListenerFor( eventContexts, node, eventInfo, ...eventArgs ) ) {
-					return eventInfo.return;
-				}
-
-				node = node.parent;
-
-				updateEventInfo( eventInfo, 'bubbling', node );
-			}
-
-			updateEventInfo( eventInfo, 'bubbling', this );
-
-			// Document context.
-			fireListenerFor( eventContexts, '$document', eventInfo, ...eventArgs );
-
-			return eventInfo.return;
-		} catch ( err ) {
-			// @if CK_DEBUG // throw err;
-			/* istanbul ignore next */
-			CKEditorError.rethrowUnexpectedError( err, this );
-		}
-	},
-
-	/**
-	 * @inheritDoc
-	 */
-	_addEventListener( event, callback, options ) {
-		const contexts = toArray( options.context || '$document' );
-		const eventContexts = getBubblingContexts( this );
-
-		for ( const context of contexts ) {
-			let emitter = eventContexts.get( context );
-
-			if ( !emitter ) {
-				emitter = Object.create( EmitterMixin );
-				eventContexts.set( context, emitter );
-			}
-
-			this.listenTo( emitter, event, callback, options );
-		}
-	},
-
-	/**
-	 * @inheritDoc
-	 */
-	_removeEventListener( event, callback ) {
-		const eventContexts = getBubblingContexts( this );
-
-		for ( const emitter of eventContexts.values() ) {
-			this.stopListening( emitter, event, callback );
-		}
-	}
-};
-
-export default BubblingEmitterMixin;
-
+export default function BubblingEmitterMixin(base) {
+    class Mixin extends base {
+        fire(eventOrInfo, ...eventArgs) {
+            try {
+                const eventInfo = eventOrInfo instanceof EventInfo ? eventOrInfo : new EventInfo(this, eventOrInfo);
+                const eventContexts = getBubblingContexts(this);
+                if (!eventContexts.size) {
+                    return;
+                }
+                updateEventInfo(eventInfo, 'capturing', this);
+                // The capture phase of the event.
+                if (fireListenerFor(eventContexts, '$capture', eventInfo, ...eventArgs)) {
+                    return eventInfo.return;
+                }
+                const startRange = eventInfo.startRange || this.selection.getFirstRange();
+                const selectedElement = startRange ? startRange.getContainedElement() : null;
+                const isCustomContext = selectedElement ? Boolean(getCustomContext(eventContexts, selectedElement)) : false;
+                let node = selectedElement || getDeeperRangeParent(startRange);
+                updateEventInfo(eventInfo, 'atTarget', node);
+                // For the not yet bubbling event trigger for $text node if selection can be there and it's not a custom context selected.
+                if (!isCustomContext) {
+                    if (fireListenerFor(eventContexts, '$text', eventInfo, ...eventArgs)) {
+                        return eventInfo.return;
+                    }
+                    updateEventInfo(eventInfo, 'bubbling', node);
+                }
+                while (node) {
+                    // Root node handling.
+                    if (node.is('rootElement')) {
+                        if (fireListenerFor(eventContexts, '$root', eventInfo, ...eventArgs)) {
+                            return eventInfo.return;
+                        }
+                    }
+                    // Element node handling.
+                    else if (node.is('element')) {
+                        if (fireListenerFor(eventContexts, node.name, eventInfo, ...eventArgs)) {
+                            return eventInfo.return;
+                        }
+                    }
+                    // Check custom contexts (i.e., a widget).
+                    if (fireListenerFor(eventContexts, node, eventInfo, ...eventArgs)) {
+                        return eventInfo.return;
+                    }
+                    node = node.parent;
+                    updateEventInfo(eventInfo, 'bubbling', node);
+                }
+                updateEventInfo(eventInfo, 'bubbling', this);
+                // Document context.
+                fireListenerFor(eventContexts, '$document', eventInfo, ...eventArgs);
+                return eventInfo.return;
+            }
+            catch (err) {
+                // @if CK_DEBUG // throw err;
+                /* istanbul ignore next */
+                CKEditorError.rethrowUnexpectedError(err, this);
+            }
+        }
+        _addEventListener(event, callback, options) {
+            const contexts = toArray(options.context || '$document');
+            const eventContexts = getBubblingContexts(this);
+            for (const context of contexts) {
+                let emitter = eventContexts.get(context);
+                if (!emitter) {
+                    emitter = new Emitter();
+                    eventContexts.set(context, emitter);
+                }
+                this.listenTo(emitter, event, callback, options);
+            }
+        }
+        _removeEventListener(event, callback) {
+            const eventContexts = getBubblingContexts(this);
+            for (const emitter of eventContexts.values()) {
+                this.stopListening(emitter, event, callback);
+            }
+        }
+    }
+    return Mixin;
+}
+// Backward compatibility with `mix`.
+{
+    const mixin = BubblingEmitterMixin(Object);
+    ['fire', '_addEventListener', '_removeEventListener'].forEach(key => {
+        BubblingEmitterMixin[key] = mixin.prototype[key];
+    });
+}
 // Update the event info bubbling fields.
 //
 // @param {module:utils/eventinfo~EventInfo} eventInfo The event info object to update.
 // @param {'none'|'capturing'|'atTarget'|'bubbling'} eventPhase The current event phase.
 // @param {module:engine/view/document~Document|module:engine/view/node~Node} currentTarget The current bubbling target.
-function updateEventInfo( eventInfo, eventPhase, currentTarget ) {
-	if ( eventInfo instanceof BubblingEventInfo ) {
-		eventInfo._eventPhase = eventPhase;
-		eventInfo._currentTarget = currentTarget;
-	}
+function updateEventInfo(eventInfo, eventPhase, currentTarget) {
+    if (eventInfo instanceof BubblingEventInfo) {
+        eventInfo._eventPhase = eventPhase;
+        eventInfo._currentTarget = currentTarget;
+    }
 }
-
 // Fires the listener for the specified context. Returns `true` if event was stopped.
 //
 // @private
@@ -152,156 +122,43 @@ function updateEventInfo( eventInfo, eventPhase, currentTarget ) {
 // @param {module:utils/eventinfo~EventInfo} eventInfo The `EventInfo` object.
 // @param {...*} [eventArgs] Additional arguments to be passed to the callbacks.
 // @returns {Boolean} True if event stop was called.
-function fireListenerFor( eventContexts, context, eventInfo, ...eventArgs ) {
-	const emitter = typeof context == 'string' ? eventContexts.get( context ) : getCustomContext( eventContexts, context );
-
-	if ( !emitter ) {
-		return false;
-	}
-
-	emitter.fire( eventInfo, ...eventArgs );
-
-	return eventInfo.stop.called;
+function fireListenerFor(eventContexts, context, eventInfo, ...eventArgs) {
+    const emitter = typeof context == 'string' ? eventContexts.get(context) : getCustomContext(eventContexts, context);
+    if (!emitter) {
+        return false;
+    }
+    emitter.fire(eventInfo, ...eventArgs);
+    return eventInfo.stop.called;
 }
-
 // Returns an emitter for a specified view node.
 //
 // @private
 // @param {Map.<String|Function, module:utils/emittermixin~Emitter>} eventContexts
 // @param {module:engine/view/node~Node} node
 // @returns {module:utils/emittermixin~Emitter|null}
-function getCustomContext( eventContexts, node ) {
-	for ( const [ context, emitter ] of eventContexts ) {
-		if ( typeof context == 'function' && context( node ) ) {
-			return emitter;
-		}
-	}
-
-	return null;
+function getCustomContext(eventContexts, node) {
+    for (const [context, emitter] of eventContexts) {
+        if (typeof context == 'function' && context(node)) {
+            return emitter;
+        }
+    }
+    return null;
 }
-
 // Returns bubbling contexts map for the source (emitter).
-function getBubblingContexts( source ) {
-	if ( !source[ contextsSymbol ] ) {
-		source[ contextsSymbol ] = new Map();
-	}
-
-	return source[ contextsSymbol ];
+function getBubblingContexts(source) {
+    if (!source[contextsSymbol]) {
+        source[contextsSymbol] = new Map();
+    }
+    return source[contextsSymbol];
 }
-
 // Returns the deeper parent element for the range.
-function getDeeperRangeParent( range ) {
-	if ( !range ) {
-		return null;
-	}
-
-	const startParent = range.start.parent;
-	const endParent = range.end.parent;
-
-	const startPath = startParent.getPath();
-	const endPath = endParent.getPath();
-
-	return startPath.length > endPath.length ? startParent : endParent;
+function getDeeperRangeParent(range) {
+    if (!range) {
+        return null;
+    }
+    const startParent = range.start.parent;
+    const endParent = range.end.parent;
+    const startPath = startParent.getPath();
+    const endPath = endParent.getPath();
+    return startPath.length > endPath.length ? startParent : endParent;
 }
-
-/**
- * Bubbling emitter for the view document.
- *
- * Bubbling emitter is triggering events in the context of specified {@link module:engine/view/element~Element view element} name,
- * predefined `'$text'`, `'$root'`, `'$document'` and `'$capture'` contexts, and context matchers provided as a function.
- *
- * Before bubbling starts, listeners for `'$capture'` context are triggered. Then the bubbling starts from the deeper selection
- * position (by firing event on the `'$text'` context) and propagates the view document tree up to the `'$root'` and finally
- * the listeners at `'$document'` context are fired (this is the default context).
- *
- * Examples:
- *
- *		// Listeners registered in the context of the view element names:
- *		this.listenTo( viewDocument, 'enter', ( evt, data ) => {
- *			// ...
- *		}, { context: 'blockquote' } );
- *
- *		this.listenTo( viewDocument, 'enter', ( evt, data ) => {
- *			// ...
- *		}, { context: 'li' } );
- *
- *		// Listeners registered in the context of the '$text' and '$root' nodes.
- *		this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- *			// ...
- *		}, { context: '$text', priority: 'high' } );
- *
- *		this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- *			// ...
- *		}, { context: '$root' } );
- *
- *		// Listeners registered in the context of custom callback function.
- *		this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- *			// ...
- *		}, { context: isWidget } );
- *
- *		this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- *			// ...
- *		}, { context: isWidget, priority: 'high' } );
- *
- * Example flow for selection in text:
- *
- *		<blockquote><p>Foo[]bar</p></blockquote>
- *
- * Fired events on contexts:
- * 1. `'$capture'`
- * 2. `'$text'`
- * 3. `'p'`
- * 4. `'blockquote'`
- * 5. `'$root'`
- * 6. `'$document'`
- *
- * Example flow for selection on element (i.e., Widget):
- *
- *		<blockquote><p>Foo[<widget/>]bar</p></blockquote>
- *
- * Fired events on contexts:
- * 1. `'$capture'`
- * 2. *widget* (custom matcher)
- * 3. `'p'`
- * 4. `'blockquote'`
- * 5. `'$root'`
- * 6. `'$document'`
- *
- * There could be multiple listeners registered for the same context and at different priority levels:
- *
- *		<p>Foo[]bar</p>
- *
- * 1. `'$capture'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 2. `'$text'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 3. `'p'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 4. `'$root'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 5. `'$document'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- *
- * @interface BubblingEmitter
- * @extends module:utils/emittermixin~Emitter
- */

package/src/view/observer/bubblingeventinfo.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
  */
-
 /**
  * @module engine/view/observer/bubblingeventinfo
  */
-
 import EventInfo from '@ckeditor/ckeditor5-utils/src/eventinfo';
-
 /**
  * The event object passed to bubbling event callbacks. It is used to provide information about the event as well as a tool to
  * manipulate it.
@@ -16,56 +13,51 @@ import EventInfo from '@ckeditor/ckeditor5-utils/src/eventinfo';
  * @extends module:utils/eventinfo~EventInfo
  */
 export default class BubblingEventInfo extends EventInfo {
-	/**
-	 * @param {Object} source The emitter.
-	 * @param {String} name The event name.
-	 * @param {module:engine/view/range~Range} startRange The view range that the bubbling should start from.
-	 */
-	constructor( source, name, startRange ) {
-		super( source, name );
-
-		/**
-		 * The view range that the bubbling should start from.
-		 *
-		 * @readonly
-		 * @member {module:engine/view/range~Range}
-		 */
-		this.startRange = startRange;
-
-		/**
-		 * The current event phase.
-		 *
-		 * @protected
-		 * @member {'none'|'capturing'|'atTarget'|'bubbling'}
-		 */
-		this._eventPhase = 'none';
-
-		/**
-		 * The current bubbling target.
-		 *
-		 * @protected
-		 * @member {module:engine/view/document~Document|module:engine/view/node~Node|null}
-		 */
-		this._currentTarget = null;
-	}
-
-	/**
-	 * The current event phase.
-	 *
-	 * @readonly
-	 * @member {'none'|'capturing'|'atTarget'|'bubbling'}
-	 */
-	get eventPhase() {
-		return this._eventPhase;
-	}
-
-	/**
-	 * The current bubbling target.
-	 *
-	 * @readonly
-	 * @member {module:engine/view/document~Document|module:engine/view/node~Node|null}
-	 */
-	get currentTarget() {
-		return this._currentTarget;
-	}
+    /**
+     * @param {Object} source The emitter.
+     * @param {String} name The event name.
+     * @param {module:engine/view/range~Range} startRange The view range that the bubbling should start from.
+     */
+    constructor(source, name, startRange) {
+        super(source, name);
+        /**
+         * The view range that the bubbling should start from.
+         *
+         * @readonly
+         * @member {module:engine/view/range~Range}
+         */
+        this.startRange = startRange;
+        /**
+         * The current event phase.
+         *
+         * @protected
+         * @member {'none'|'capturing'|'atTarget'|'bubbling'}
+         */
+        this._eventPhase = 'none';
+        /**
+         * The current bubbling target.
+         *
+         * @protected
+         * @member {module:engine/view/document~Document|module:engine/view/node~Node|null}
+         */
+        this._currentTarget = null;
+    }
+    /**
+     * The current event phase.
+     *
+     * @readonly
+     * @member {'none'|'capturing'|'atTarget'|'bubbling'}
+     */
+    get eventPhase() {
+        return this._eventPhase;
+    }
+    /**
+     * The current bubbling target.
+     *
+     * @readonly
+     * @member {module:engine/view/document~Document|module:engine/view/node~Node|null}
+     */
+    get currentTarget() {
+        return this._currentTarget;
+    }
 }

package/src/view/observer/clickobserver.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
  */
-
 /**
  * @module engine/view/observer/clickobserver
  */
-
 import DomEventObserver from './domeventobserver';
-
 /**
  * {@link module:engine/view/document~Document#event:click Click} event observer.
  *
@@ -19,17 +16,14 @@ import DomEventObserver from './domeventobserver';
  * @extends module:engine/view/observer/domeventobserver~DomEventObserver
  */
 export default class ClickObserver extends DomEventObserver {
-	constructor( view ) {
-		super( view );
-
-		this.domEventType = 'click';
-	}
-
-	onDomEvent( domEvent ) {
-		this.fire( domEvent.type, domEvent );
-	}
+    constructor(view) {
+        super(view);
+        this.domEventType = 'click';
+    }
+    onDomEvent(domEvent) {
+        this.fire(domEvent.type, domEvent);
+    }
 }
-
 /**
  * Fired when one of the editables has been clicked.
  *