@ckeditor/ckeditor5-utils 35.0.1 → 35.1.0

package/CHANGELOG.md

@@ -166,7 +166,7 @@ Internal changes only (updated dependencies, documentation, etc.).
 
 ### Other changes
 
-* Vairous fixes in the API docs. Thanks to [@denisname](https://github.com/denisname)!
+* Various fixes in the API docs. Thanks to [@denisname](https://github.com/denisname)!
 
 
 ## [11.0.0](https://github.com/ckeditor/ckeditor5-utils/compare/v10.2.1...v11.0.0) (2018-10-08)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "35.0.1",
+  "version": "35.1.0",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -14,10 +14,10 @@
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-build-classic": "^35.0.1",
-    "@ckeditor/ckeditor5-editor-classic": "^35.0.1",
-    "@ckeditor/ckeditor5-core": "^35.0.1",
-    "@ckeditor/ckeditor5-engine": "^35.0.1",
+    "@ckeditor/ckeditor5-build-classic": "^35.1.0",
+    "@ckeditor/ckeditor5-editor-classic": "^35.1.0",
+    "@ckeditor/ckeditor5-core": "^35.1.0",
+    "@ckeditor/ckeditor5-engine": "^35.1.0",
     "@types/lodash-es": "^4.17.6",
     "typescript": "^4.6.4"
   },

package/src/collection.js

@@ -5,11 +5,10 @@
 /**
  * @module utils/collection
  */
-import EmitterMixin from './emittermixin';
+import { Emitter } from './emittermixin';
 import CKEditorError from './ckeditorerror';
 import uid from './uid';
 import isIterable from './isiterable';
-import mix from './mix';
 /**
  * Collections are ordered sets of objects. Items in the collection can be retrieved by their indexes
  * in the collection (like in an array) or by their ids.
@@ -22,7 +21,7 @@ import mix from './mix';
  *
  * @mixes module:utils/emittermixin~EmitterMixin
  */
-class Collection {
+export default class Collection extends Emitter {
     /**
      * Creates a new Collection instance.
      *
@@ -60,6 +59,7 @@ class Collection {
      * Items that do not have such a property will be assigned one when added to the collection.
      */
     constructor(initialItemsOrOptions = {}, options = {}) {
+        super();
         const hasInitialItems = isIterable(initialItemsOrOptions);
         if (!hasInitialItems) {
             options = initialItemsOrOptions;
@@ -615,5 +615,3 @@ class Collection {
         return this._items[Symbol.iterator]();
     }
 }
-mix(Collection, EmitterMixin);
-export default Collection;

package/src/dom/emittermixin.js

@@ -2,15 +2,14 @@
  * @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
  */
+/* eslint-disable new-cap */
 /**
  * @module utils/dom/emittermixin
  */
-import { default as EmitterMixin, _getEmitterListenedTo, _setEmitterId } from '../emittermixin';
+import { _getEmitterListenedTo, _setEmitterId, Emitter as BaseEmitter } from '../emittermixin';
 import uid from '../uid';
 import isNode from './isnode';
 import isWindow from './iswindow';
-import { extend } from 'lodash-es';
-import mix from '../mix';
 /**
  * Mixin that injects the DOM events API into its host. It provides the API
  * compatible with {@link module:utils/emittermixin~EmitterMixin}.
@@ -20,9 +19,9 @@ import mix from '../mix';
  *
  *		import mix from '../utils/mix.js';
  *		import DomEmitterMixin from '../utils/dom/emittermixin.js';
+ *		import { Emitter } from '../utils/emittermixin.js';
  *
- *		class SomeView {}
- *		mix( SomeView, DomEmitterMixin );
+ *		class SomeView extends DomEmitterMixin( Emitter ) {}
  *
  *		const view = new SomeView();
  *		view.listenTo( domElement, ( evt, domEvt ) => {
@@ -33,99 +32,79 @@ import mix from '../mix';
  * @mixes module:utils/emittermixin~EmitterMixin
  * @implements module:utils/dom/emittermixin~Emitter
  */
-const DomEmitterMixin = extend({}, EmitterMixin, {
-    /**
-     * Registers a callback function to be executed when an event is fired in a specific Emitter or DOM Node.
-     * It is backwards compatible with {@link module:utils/emittermixin~EmitterMixin#listenTo}.
-     *
-     * @param {module:utils/emittermixin~Emitter|Node|Window} emitter The object that fires the event.
-     * @param {String} event The name of the event.
-     * @param {Function} callback The function to be called on event.
-     * @param {Object} [options={}] Additional options.
-     * @param {module:utils/priorities~PriorityString|Number} [options.priority='normal'] The priority of this event callback. The higher
-     * the priority value the sooner the callback will be fired. Events having the same priority are called in the
-     * order they were added.
-     * @param {Boolean} [options.useCapture=false] Indicates that events of this type will be dispatched to the registered
-     * listener before being dispatched to any EventTarget beneath it in the DOM tree.
-     * @param {Boolean} [options.usePassive=false] Indicates that the function specified by listener will never call preventDefault()
-     * and prevents blocking browser's main thread by this event handler.
-     */
-    listenTo(emitter, event, callback, options = {}) {
-        // Check if emitter is an instance of DOM Node. If so, use corresponding ProxyEmitter (or create one if not existing).
-        if (isNode(emitter) || isWindow(emitter)) {
-            const proxyOptions = {
-                capture: !!options.useCapture,
-                passive: !!options.usePassive
-            };
-            const proxyEmitter = this._getProxyEmitter(emitter, proxyOptions) || new ProxyEmitter(emitter, proxyOptions);
-            this.listenTo(proxyEmitter, event, callback, options);
-        }
-        else {
-            // Execute parent class method with Emitter (or ProxyEmitter) instance.
-            EmitterMixin.listenTo.call(this, emitter, event, callback, options);
+export default function DomEmitterMixin(base) {
+    class Mixin extends base {
+        listenTo(emitter, event, callback, options = {}) {
+            // Check if emitter is an instance of DOM Node. If so, use corresponding ProxyEmitter (or create one if not existing).
+            if (isNode(emitter) || isWindow(emitter)) {
+                const proxyOptions = {
+                    capture: !!options.useCapture,
+                    passive: !!options.usePassive
+                };
+                const proxyEmitter = this._getProxyEmitter(emitter, proxyOptions) || new ProxyEmitter(emitter, proxyOptions);
+                this.listenTo(proxyEmitter, event, callback, options);
+            }
+            else {
+                // Execute parent class method with Emitter (or ProxyEmitter) instance.
+                BaseEmitter.prototype.listenTo.call(this, emitter, event, callback, options);
+            }
         }
-    },
-    /**
-     * Stops listening for events. It can be used at different levels:
-     * It is backwards compatible with {@link module:utils/emittermixin~EmitterMixin#listenTo}.
-     *
-     * * To stop listening to a specific callback.
-     * * To stop listening to a specific event.
-     * * To stop listening to all events fired by a specific object.
-     * * To stop listening to all events fired by all object.
-     *
-     * @param {module:utils/emittermixin~Emitter|Node|Window} [emitter] The object to stop listening to.
-     * If omitted, stops it for all objects.
-     * @param {String} [event] (Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it
-     * for all events from `emitter`.
-     * @param {Function} [callback] (Requires the `event`) The function to be removed from the call list for the given
-     * `event`.
-     */
-    stopListening(emitter, event, callback) {
-        // Check if the emitter is an instance of DOM Node. If so, forward the call to the corresponding ProxyEmitters.
-        if (isNode(emitter) || isWindow(emitter)) {
-            const proxyEmitters = this._getAllProxyEmitters(emitter);
-            for (const proxy of proxyEmitters) {
-                this.stopListening(proxy, event, callback);
+        stopListening(emitter, event, callback) {
+            // Check if the emitter is an instance of DOM Node. If so, forward the call to the corresponding ProxyEmitters.
+            if (isNode(emitter) || isWindow(emitter)) {
+                const proxyEmitters = this._getAllProxyEmitters(emitter);
+                for (const proxy of proxyEmitters) {
+                    this.stopListening(proxy, event, callback);
+                }
+            }
+            else {
+                // Execute parent class method with Emitter (or ProxyEmitter) instance.
+                BaseEmitter.prototype.stopListening.call(this, emitter, event, callback);
             }
         }
-        else {
-            // Execute parent class method with Emitter (or ProxyEmitter) instance.
-            EmitterMixin.stopListening.call(this, emitter, event, callback);
+        /**
+         * Retrieves ProxyEmitter instance for given DOM Node residing in this Host and given options.
+         *
+         * @private
+         * @param {Node|Window} node DOM Node of the ProxyEmitter.
+         * @param {Object} [options] Additional options.
+         * @param {Boolean} [options.useCapture=false] Indicates that events of this type will be dispatched to the registered
+         * listener before being dispatched to any EventTarget beneath it in the DOM tree.
+         * @param {Boolean} [options.usePassive=false] Indicates that the function specified by listener will never call preventDefault()
+         * and prevents blocking browser's main thread by this event handler.
+         * @returns {module:utils/dom/emittermixin~ProxyEmitter|null} ProxyEmitter instance bound to the DOM Node.
+         */
+        _getProxyEmitter(node, options) {
+            return _getEmitterListenedTo(this, getProxyEmitterId(node, options));
+        }
+        /**
+         * Retrieves all the ProxyEmitter instances for given DOM Node residing in this Host.
+         *
+         * @private
+         * @param {Node|Window} node DOM Node of the ProxyEmitter.
+         * @returns {Array.<module:utils/dom/emittermixin~ProxyEmitter>}
+         */
+        _getAllProxyEmitters(node) {
+            return [
+                { capture: false, passive: false },
+                { capture: false, passive: true },
+                { capture: true, passive: false },
+                { capture: true, passive: true }
+            ].map(options => this._getProxyEmitter(node, options)).filter(proxy => !!proxy);
         }
-    },
-    /**
-     * Retrieves ProxyEmitter instance for given DOM Node residing in this Host and given options.
-     *
-     * @private
-     * @param {Node|Window} node DOM Node of the ProxyEmitter.
-     * @param {Object} [options] Additional options.
-     * @param {Boolean} [options.useCapture=false] Indicates that events of this type will be dispatched to the registered
-     * listener before being dispatched to any EventTarget beneath it in the DOM tree.
-     * @param {Boolean} [options.usePassive=false] Indicates that the function specified by listener will never call preventDefault()
-     * and prevents blocking browser's main thread by this event handler.
-     * @returns {module:utils/dom/emittermixin~ProxyEmitter|null} ProxyEmitter instance bound to the DOM Node.
-     */
-    _getProxyEmitter(node, options) {
-        return _getEmitterListenedTo(this, getProxyEmitterId(node, options));
-    },
-    /**
-     * Retrieves all the ProxyEmitter instances for given DOM Node residing in this Host.
-     *
-     * @private
-     * @param {Node|Window} node DOM Node of the ProxyEmitter.
-     * @returns {Array.<module:utils/dom/emittermixin~ProxyEmitter>}
-     */
-    _getAllProxyEmitters(node) {
-        return [
-            { capture: false, passive: false },
-            { capture: false, passive: true },
-            { capture: true, passive: false },
-            { capture: true, passive: true }
-        ].map(options => this._getProxyEmitter(node, options)).filter(proxy => !!proxy);
     }
+    return Mixin;
+}
+export const Emitter = DomEmitterMixin(BaseEmitter);
+// Backward compatibility with `mix`
+([
+    '_getProxyEmitter', '_getAllProxyEmitters',
+    'on', 'once', 'off', 'listenTo',
+    'stopListening', 'fire', 'delegate', 'stopDelegating',
+    '_addEventListener', '_removeEventListener'
+]).forEach(key => {
+    DomEmitterMixin[key] = Emitter.prototype[key];
 });
-export default DomEmitterMixin;
 /**
  * Creates a ProxyEmitter instance. Such an instance is a bridge between a DOM Node firing events
  * and any Host listening to them. It is backwards compatible with {@link module:utils/emittermixin~EmitterMixin#on}.
@@ -158,7 +137,7 @@ export default DomEmitterMixin;
  * @implements module:utils/dom/emittermixin~Emitter
  * @private
  */
-class ProxyEmitter {
+class ProxyEmitter extends BaseEmitter {
     /**
      * @param {Node|Window} node DOM Node that fires events.
      * @param {Object} [options] Additional options.
@@ -168,6 +147,7 @@ class ProxyEmitter {
      * and prevents blocking browser's main thread by this event handler.
      */
     constructor(node, options) {
+        super();
         // Set emitter ID to match DOM Node "expando" property.
         _setEmitterId(this, getProxyEmitterId(node, options));
         // Remember the DOM Node this ProxyEmitter is bound to.
@@ -235,7 +215,7 @@ class ProxyEmitter {
      */
     _addEventListener(event, callback, options) {
         this.attach(event);
-        EmitterMixin._addEventListener.call(this, event, callback, options);
+        BaseEmitter.prototype._addEventListener.call(this, event, callback, options);
     }
     /**
      * Removes callback from emitter for given event.
@@ -246,7 +226,7 @@ class ProxyEmitter {
      * @param {Function} callback The function to stop being called.
      */
     _removeEventListener(event, callback) {
-        EmitterMixin._removeEventListener.call(this, event, callback);
+        BaseEmitter.prototype._removeEventListener.call(this, event, callback);
         this.detach(event);
     }
     /**
@@ -273,7 +253,6 @@ class ProxyEmitter {
         return domListener;
     }
 }
-mix(ProxyEmitter, EmitterMixin);
 // Gets an unique DOM Node identifier. The identifier will be set if not defined.
 //
 // @private

package/src/dom/global.js

@@ -20,4 +20,18 @@
  *
  *		console.log( global.window.innerWidth );
  */
-export default { window, document };
+let global;
+// In some environments window and document API might not be available.
+try {
+    global = { window, document };
+}
+catch (e) {
+    // It's not possible to mock a window object to simulate lack of a window object without writing extremely convoluted code.
+    /* istanbul ignore next */
+    // Let's cast it to not change module's API.
+    // We only handle this so loading editor in environments without window and document doesn't fail.
+    // For better DX we shouldn't introduce mixed types and require developers to check the type manually.
+    // This module should not be used on purpose in any environment outside browser.
+    global = { window: {}, document: {} };
+}
+export default global;