@ckeditor/ckeditor5-widget 35.2.0 → 35.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-widget",
-  "version": "35.2.0",
+  "version": "35.3.0",
   "description": "Widget API for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -11,29 +11,32 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^35.2.0",
-    "@ckeditor/ckeditor5-engine": "^35.2.0",
-    "@ckeditor/ckeditor5-enter": "^35.2.0",
-    "@ckeditor/ckeditor5-ui": "^35.2.0",
-    "@ckeditor/ckeditor5-utils": "^35.2.0",
-    "@ckeditor/ckeditor5-typing": "^35.2.0",
+    "@ckeditor/ckeditor5-core": "^35.3.0",
+    "@ckeditor/ckeditor5-engine": "^35.3.0",
+    "@ckeditor/ckeditor5-enter": "^35.3.0",
+    "@ckeditor/ckeditor5-ui": "^35.3.0",
+    "@ckeditor/ckeditor5-utils": "^35.3.0",
+    "@ckeditor/ckeditor5-typing": "^35.3.0",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^35.2.0",
-    "@ckeditor/ckeditor5-block-quote": "^35.2.0",
-    "@ckeditor/ckeditor5-clipboard": "^35.2.0",
-    "@ckeditor/ckeditor5-editor-balloon": "^35.2.0",
-    "@ckeditor/ckeditor5-editor-classic": "^35.2.0",
-    "@ckeditor/ckeditor5-essentials": "^35.2.0",
-    "@ckeditor/ckeditor5-heading": "^35.2.0",
-    "@ckeditor/ckeditor5-horizontal-line": "^35.2.0",
-    "@ckeditor/ckeditor5-image": "^35.2.0",
-    "@ckeditor/ckeditor5-link": "^35.2.0",
-    "@ckeditor/ckeditor5-media-embed": "^35.2.0",
-    "@ckeditor/ckeditor5-paragraph": "^35.2.0",
-    "@ckeditor/ckeditor5-table": "^35.2.0",
-    "@ckeditor/ckeditor5-undo": "^35.2.0"
+    "@ckeditor/ckeditor5-basic-styles": "^35.3.0",
+    "@ckeditor/ckeditor5-block-quote": "^35.3.0",
+    "@ckeditor/ckeditor5-clipboard": "^35.3.0",
+    "@ckeditor/ckeditor5-editor-balloon": "^35.3.0",
+    "@ckeditor/ckeditor5-editor-classic": "^35.3.0",
+    "@ckeditor/ckeditor5-essentials": "^35.3.0",
+    "@ckeditor/ckeditor5-heading": "^35.3.0",
+    "@ckeditor/ckeditor5-horizontal-line": "^35.3.0",
+    "@ckeditor/ckeditor5-image": "^35.3.0",
+    "@ckeditor/ckeditor5-link": "^35.3.0",
+    "@ckeditor/ckeditor5-media-embed": "^35.3.0",
+    "@ckeditor/ckeditor5-paragraph": "^35.3.0",
+    "@ckeditor/ckeditor5-table": "^35.3.0",
+    "@ckeditor/ckeditor5-undo": "^35.3.0",
+    "typescript": "^4.8.4",
+    "webpack": "^5.58.1",
+    "webpack-cli": "^4.9.0"
   },
   "engines": {
     "node": ">=14.0.0",
@@ -50,9 +53,14 @@
   },
   "files": [
     "lang",
-    "src",
+    "src/**/*.js",
+    "src/**/*.d.ts",
     "theme",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
-  ]
+  ],
+  "scripts": {
+    "build": "tsc -p ./tsconfig.release.json",
+    "postversion": "npm run build"
+  }
 }

package/src/highlightstack.js

@@ -2,14 +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 widget/highlightstack
  */
-
-import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
-import mix from '@ckeditor/ckeditor5-utils/src/mix';
-
+import { Emitter } from '@ckeditor/ckeditor5-utils/src/emittermixin';
 /**
  * Class used to handle correct order of highlights on elements.
  *
@@ -21,156 +17,126 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix';
  *
  * This way, highlight will be applied with the same rules it is applied on texts.
  */
-export default class HighlightStack {
-	/**
-	 * Creates class instance.
-	 */
-	constructor() {
-		this._stack = [];
-	}
-
-	/**
-	 * Adds highlight descriptor to the stack.
-	 *
-	 * @fires change:top
-	 * @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} descriptor
-	 * @param {module:engine/view/downcastwriter~DowncastWriter} writer
-	 */
-	add( descriptor, writer ) {
-		const stack = this._stack;
-
-		// Save top descriptor and insert new one. If top is changed - fire event.
-		const oldTop = stack[ 0 ];
-		this._insertDescriptor( descriptor );
-		const newTop = stack[ 0 ];
-
-		// When new object is at the top and stores different information.
-		if ( oldTop !== newTop && !compareDescriptors( oldTop, newTop ) ) {
-			this.fire( 'change:top', {
-				oldDescriptor: oldTop,
-				newDescriptor: newTop,
-				writer
-			} );
-		}
-	}
-
-	/**
-	 * Removes highlight descriptor from the stack.
-	 *
-	 * @fires change:top
-	 * @param {String} id Id of the descriptor to remove.
-	 * @param {module:engine/view/downcastwriter~DowncastWriter} writer
-	 */
-	remove( id, writer ) {
-		const stack = this._stack;
-
-		const oldTop = stack[ 0 ];
-		this._removeDescriptor( id );
-		const newTop = stack[ 0 ];
-
-		// When new object is at the top and stores different information.
-		if ( oldTop !== newTop && !compareDescriptors( oldTop, newTop ) ) {
-			this.fire( 'change:top', {
-				oldDescriptor: oldTop,
-				newDescriptor: newTop,
-				writer
-			} );
-		}
-	}
-
-	/**
-	 * Inserts given descriptor in correct place in the stack. It also takes care about updating information when
-	 * descriptor with same id is already present.
-	 *
-	 * @private
-	 * @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} descriptor
-	 */
-	_insertDescriptor( descriptor ) {
-		const stack = this._stack;
-		const index = stack.findIndex( item => item.id === descriptor.id );
-
-		// Inserting exact same descriptor - do nothing.
-		if ( compareDescriptors( descriptor, stack[ index ] ) ) {
-			return;
-		}
-
-		// If descriptor with same id but with different information is on the stack - remove it.
-		if ( index > -1 ) {
-			stack.splice( index, 1 );
-		}
-
-		// Find correct place to insert descriptor in the stack.
-		// It have different information (for example priority) so it must be re-inserted in correct place.
-		let i = 0;
-
-		while ( stack[ i ] && shouldABeBeforeB( stack[ i ], descriptor ) ) {
-			i++;
-		}
-
-		stack.splice( i, 0, descriptor );
-	}
-
-	/**
-	 * Removes descriptor with given id from the stack.
-	 *
-	 * @private
-	 * @param {String} id Descriptor's id.
-	 */
-	_removeDescriptor( id ) {
-		const stack = this._stack;
-		const index = stack.findIndex( item => item.id === id );
-
-		// If descriptor with same id is on the list - remove it.
-		if ( index > -1 ) {
-			stack.splice( index, 1 );
-		}
-	}
+export default class HighlightStack extends Emitter {
+    /**
+     * Creates class instance.
+     */
+    constructor() {
+        super();
+        this._stack = [];
+    }
+    /**
+     * Adds highlight descriptor to the stack.
+     *
+     * @fires change:top
+     * @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} descriptor
+     * @param {module:engine/view/downcastwriter~DowncastWriter} writer
+     */
+    add(descriptor, writer) {
+        const stack = this._stack;
+        // Save top descriptor and insert new one. If top is changed - fire event.
+        const oldTop = stack[0];
+        this._insertDescriptor(descriptor);
+        const newTop = stack[0];
+        // When new object is at the top and stores different information.
+        if (oldTop !== newTop && !compareDescriptors(oldTop, newTop)) {
+            this.fire('change:top', {
+                oldDescriptor: oldTop,
+                newDescriptor: newTop,
+                writer
+            });
+        }
+    }
+    /**
+     * Removes highlight descriptor from the stack.
+     *
+     * @fires change:top
+     * @param {String} id Id of the descriptor to remove.
+     * @param {module:engine/view/downcastwriter~DowncastWriter} writer
+     */
+    remove(id, writer) {
+        const stack = this._stack;
+        const oldTop = stack[0];
+        this._removeDescriptor(id);
+        const newTop = stack[0];
+        // When new object is at the top and stores different information.
+        if (oldTop !== newTop && !compareDescriptors(oldTop, newTop)) {
+            this.fire('change:top', {
+                oldDescriptor: oldTop,
+                newDescriptor: newTop,
+                writer
+            });
+        }
+    }
+    /**
+     * Inserts given descriptor in correct place in the stack. It also takes care about updating information when
+     * descriptor with same id is already present.
+     *
+     * @private
+     * @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} descriptor
+     */
+    _insertDescriptor(descriptor) {
+        const stack = this._stack;
+        const index = stack.findIndex(item => item.id === descriptor.id);
+        // Inserting exact same descriptor - do nothing.
+        if (compareDescriptors(descriptor, stack[index])) {
+            return;
+        }
+        // If descriptor with same id but with different information is on the stack - remove it.
+        if (index > -1) {
+            stack.splice(index, 1);
+        }
+        // Find correct place to insert descriptor in the stack.
+        // It have different information (for example priority) so it must be re-inserted in correct place.
+        let i = 0;
+        while (stack[i] && shouldABeBeforeB(stack[i], descriptor)) {
+            i++;
+        }
+        stack.splice(i, 0, descriptor);
+    }
+    /**
+     * Removes descriptor with given id from the stack.
+     *
+     * @private
+     * @param {String} id Descriptor's id.
+     */
+    _removeDescriptor(id) {
+        const stack = this._stack;
+        const index = stack.findIndex(item => item.id === id);
+        // If descriptor with same id is on the list - remove it.
+        if (index > -1) {
+            stack.splice(index, 1);
+        }
+    }
 }
-
-mix( HighlightStack, EmitterMixin );
-
 // Compares two descriptors by checking their priority and class list.
 //
 // @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} a
 // @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} b
 // @returns {Boolean} Returns true if both descriptors are defined and have same priority and classes.
-function compareDescriptors( a, b ) {
-	return a && b && a.priority == b.priority && classesToString( a.classes ) == classesToString( b.classes );
+function compareDescriptors(a, b) {
+    return a && b && a.priority == b.priority && classesToString(a.classes) == classesToString(b.classes);
 }
-
 // Checks whenever first descriptor should be placed in the stack before second one.
 //
 // @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} a
 // @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} b
 // @returns {Boolean}
-function shouldABeBeforeB( a, b ) {
-	if ( a.priority > b.priority ) {
-		return true;
-	} else if ( a.priority < b.priority ) {
-		return false;
-	}
-
-	// When priorities are equal and names are different - use classes to compare.
-	return classesToString( a.classes ) > classesToString( b.classes );
+function shouldABeBeforeB(a, b) {
+    if (a.priority > b.priority) {
+        return true;
+    }
+    else if (a.priority < b.priority) {
+        return false;
+    }
+    // When priorities are equal and names are different - use classes to compare.
+    return classesToString(a.classes) > classesToString(b.classes);
 }
-
 // Converts CSS classes passed with {@link module:engine/conversion/downcasthelpers~HighlightDescriptor} to
 // sorted string.
 //
 // @param {String|Array<String>} descriptor
 // @returns {String}
-function classesToString( classes ) {
-	return Array.isArray( classes ) ? classes.sort().join( ',' ) : classes;
+function classesToString(classes) {
+    return Array.isArray(classes) ? classes.sort().join(',') : classes;
 }
-
-/**
- * Fired when top element on {@link module:widget/highlightstack~HighlightStack} has been changed
- *
- * @event change:top
- * @param {Object} data Additional information about the change.
- * @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} [data.newDescriptor] New highlight
- * descriptor. It will be `undefined` when last descriptor is removed from the stack.
- * @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} [data.oldDescriptor] Old highlight
- * descriptor. It will be `undefined` when first descriptor is added to the stack.
- * @param {module:engine/view/downcastwriter~DowncastWriter} writer View writer that can be used to modify element.
- */

package/src/index.js

@@ -2,7 +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
  */
-
 export { default as Widget } from './widget';
 export { default as WidgetToolbarRepository } from './widgettoolbarrepository';
 export { default as WidgetResize } from './widgetresize';