@ckeditor/ckeditor5-core 35.2.0 → 35.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-core",
-  "version": "35.2.0",
+  "version": "35.3.0",
   "description": "The core architecture of CKEditor 5 – the best browser-based rich text editor.",
   "keywords": [
     "wysiwyg",
@@ -23,25 +23,28 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-engine": "^35.2.0",
-    "@ckeditor/ckeditor5-ui": "^35.2.0",
-    "@ckeditor/ckeditor5-utils": "^35.2.0",
+    "@ckeditor/ckeditor5-engine": "^35.3.0",
+    "@ckeditor/ckeditor5-ui": "^35.3.0",
+    "@ckeditor/ckeditor5-utils": "^35.3.0",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-autoformat": "^35.2.0",
-    "@ckeditor/ckeditor5-basic-styles": "^35.2.0",
-    "@ckeditor/ckeditor5-block-quote": "^35.2.0",
-    "@ckeditor/ckeditor5-editor-classic": "^35.2.0",
-    "@ckeditor/ckeditor5-essentials": "^35.2.0",
-    "@ckeditor/ckeditor5-heading": "^35.2.0",
-    "@ckeditor/ckeditor5-image": "^35.2.0",
-    "@ckeditor/ckeditor5-indent": "^35.2.0",
-    "@ckeditor/ckeditor5-link": "^35.2.0",
-    "@ckeditor/ckeditor5-list": "^35.2.0",
-    "@ckeditor/ckeditor5-media-embed": "^35.2.0",
-    "@ckeditor/ckeditor5-paragraph": "^35.2.0",
-    "@ckeditor/ckeditor5-table": "^35.2.0"
+    "@ckeditor/ckeditor5-autoformat": "^35.3.0",
+    "@ckeditor/ckeditor5-basic-styles": "^35.3.0",
+    "@ckeditor/ckeditor5-block-quote": "^35.3.0",
+    "@ckeditor/ckeditor5-editor-classic": "^35.3.0",
+    "@ckeditor/ckeditor5-essentials": "^35.3.0",
+    "@ckeditor/ckeditor5-heading": "^35.3.0",
+    "@ckeditor/ckeditor5-image": "^35.3.0",
+    "@ckeditor/ckeditor5-indent": "^35.3.0",
+    "@ckeditor/ckeditor5-link": "^35.3.0",
+    "@ckeditor/ckeditor5-list": "^35.3.0",
+    "@ckeditor/ckeditor5-media-embed": "^35.3.0",
+    "@ckeditor/ckeditor5-paragraph": "^35.3.0",
+    "@ckeditor/ckeditor5-table": "^35.3.0",
+    "typescript": "^4.8.4",
+    "webpack": "^5.58.1",
+    "webpack-cli": "^4.9.0"
   },
   "engines": {
     "node": ">=14.0.0",
@@ -58,9 +61,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/command.js

@@ -2,14 +2,7 @@
  * @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 core/command
- */
-
-import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
-import mix from '@ckeditor/ckeditor5-utils/src/mix';
-
+import { Observable } from '@ckeditor/ckeditor5-utils/src/observablemixin';
 /**
  * The base class for CKEditor commands.
  *
@@ -25,236 +18,214 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix';
  *
  * @mixes module:utils/observablemixin~ObservableMixin
  */
-export default class Command {
-	/**
-	 * Creates a new `Command` instance.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
-	 */
-	constructor( editor ) {
-		/**
-		 * The editor on which this command will be used.
-		 *
-		 * @readonly
-		 * @member {module:core/editor/editor~Editor}
-		 */
-		this.editor = editor;
-
-		/**
-		 * The value of the command. A concrete command class should define what it represents for it.
-		 *
-		 * For example, the `'bold'` command's value indicates whether the selection starts in a bolded text.
-		 * And the value of the `'link'` command may be an object with links details.
-		 *
-		 * It is possible for a command to have no value (e.g. for stateless actions such as `'uploadImage'`).
-		 *
-		 * A concrete command class should control this value by overriding the {@link #refresh `refresh()`} method.
-		 *
-		 * @observable
-		 * @readonly
-		 * @member #value
-		 */
-		this.set( 'value', undefined );
-
-		/**
-		 * Flag indicating whether a command is enabled or disabled.
-		 * A disabled command will do nothing when executed.
-		 *
-		 * A concrete command class should control this value by overriding the {@link #refresh `refresh()`} method.
-		 *
-		 * It is possible to disable a command from "outside". For instance, in your integration you may want to disable
-		 * a certain set of commands for the time being. To do that, you can use the fact that `isEnabled` is observable
-		 * and it fires the `set:isEnabled` event every time anyone tries to modify its value:
-		 *
-		 *		function disableCommand( cmd ) {
-		 *			cmd.on( 'set:isEnabled', forceDisable, { priority: 'highest' } );
-		 *
-		 *			cmd.isEnabled = false;
-		 *
-		 *			// Make it possible to enable the command again.
-		 *			return () => {
-		 *				cmd.off( 'set:isEnabled', forceDisable );
-		 *				cmd.refresh();
-		 *			};
-		 *
-		 *			function forceDisable( evt ) {
-		 *				evt.return = false;
-		 *				evt.stop();
-		 *			}
-		 *		}
-		 *
-		 *		// Usage:
-		 *
-		 *		// Disabling the command.
-		 *		const enableBold = disableCommand( editor.commands.get( 'bold' ) );
-		 *
-		 *		// Enabling the command again.
-		 *		enableBold();
-		 *
-		 * @observable
-		 * @readonly
-		 * @member {Boolean} #isEnabled
-		 */
-		this.set( 'isEnabled', false );
-
-		/**
-		 * A flag indicating whether a command execution changes the editor data or not.
-		 *
-		 * Commands with `affectsData` set to `false` will not be automatically disabled in
-		 * the {@link module:core/editor/editor~Editor#isReadOnly read-only mode} and
-		 * {@glink features/read-only#related-features other editor modes} with restricted user write permissions.
-		 *
-		 * **Note:** You do not have to set it for your every command. It is `true` by default.
-		 *
-		 * @readonly
-		 * @default true
-		 * @member {Boolean} #affectsData
-		 */
-		this.affectsData = true;
-
-		/**
-		 * Holds identifiers for {@link #forceDisabled} mechanism.
-		 *
-		 * @type {Set.<String>}
-		 * @private
-		 */
-		this._disableStack = new Set();
-
-		this.decorate( 'execute' );
-
-		// By default every command is refreshed when changes are applied to the model.
-		this.listenTo( this.editor.model.document, 'change', () => {
-			this.refresh();
-		} );
-
-		this.on( 'execute', evt => {
-			if ( !this.isEnabled ) {
-				evt.stop();
-			}
-		}, { priority: 'high' } );
-
-		// By default commands are disabled when the editor is in read-only mode.
-		this.listenTo( editor, 'change:isReadOnly', ( evt, name, value ) => {
-			if ( value && this.affectsData ) {
-				this.forceDisabled( 'readOnlyMode' );
-			} else {
-				this.clearForceDisabled( 'readOnlyMode' );
-			}
-		} );
-	}
-
-	/**
-	 * Refreshes the command. The command should update its {@link #isEnabled} and {@link #value} properties
-	 * in this method.
-	 *
-	 * This method is automatically called when
-	 * {@link module:engine/model/document~Document#event:change any changes are applied to the document}.
-	 */
-	refresh() {
-		this.isEnabled = true;
-	}
-
-	/**
-	 * Disables the command.
-	 *
-	 * Command may be disabled by multiple features or algorithms (at once). When disabling a command, unique id should be passed
-	 * (e.g. feature name). The same identifier should be used when {@link #clearForceDisabled enabling back} the command.
-	 * The command becomes enabled only after all features {@link #clearForceDisabled enabled it back}.
-	 *
-	 * Disabling and enabling a command:
-	 *
-	 *		command.isEnabled; // -> true
-	 *		command.forceDisabled( 'MyFeature' );
-	 *		command.isEnabled; // -> false
-	 *		command.clearForceDisabled( 'MyFeature' );
-	 *		command.isEnabled; // -> true
-	 *
-	 * Command disabled by multiple features:
-	 *
-	 *		command.forceDisabled( 'MyFeature' );
-	 *		command.forceDisabled( 'OtherFeature' );
-	 *		command.clearForceDisabled( 'MyFeature' );
-	 *		command.isEnabled; // -> false
-	 *		command.clearForceDisabled( 'OtherFeature' );
-	 *		command.isEnabled; // -> true
-	 *
-	 * Multiple disabling with the same identifier is redundant:
-	 *
-	 *		command.forceDisabled( 'MyFeature' );
-	 *		command.forceDisabled( 'MyFeature' );
-	 *		command.clearForceDisabled( 'MyFeature' );
-	 *		command.isEnabled; // -> true
-	 *
-	 * **Note:** some commands or algorithms may have more complex logic when it comes to enabling or disabling certain commands,
-	 * so the command might be still disabled after {@link #clearForceDisabled} was used.
-	 *
-	 * @param {String} id Unique identifier for disabling. Use the same id when {@link #clearForceDisabled enabling back} the command.
-	 */
-	forceDisabled( id ) {
-		this._disableStack.add( id );
-
-		if ( this._disableStack.size == 1 ) {
-			this.on( 'set:isEnabled', forceDisable, { priority: 'highest' } );
-			this.isEnabled = false;
-		}
-	}
-
-	/**
-	 * Clears forced disable previously set through {@link #forceDisabled}. See {@link #forceDisabled}.
-	 *
-	 * @param {String} id Unique identifier, equal to the one passed in {@link #forceDisabled} call.
-	 */
-	clearForceDisabled( id ) {
-		this._disableStack.delete( id );
-
-		if ( this._disableStack.size == 0 ) {
-			this.off( 'set:isEnabled', forceDisable );
-			this.refresh();
-		}
-	}
-
-	/**
-	 * Executes the command.
-	 *
-	 * A command may accept parameters. They will be passed from {@link module:core/editor/editor~Editor#execute `editor.execute()`}
-	 * to the command.
-	 *
-	 * The `execute()` method will automatically abort when the command is disabled ({@link #isEnabled} is `false`).
-	 * This behavior is implemented by a high priority listener to the {@link #event:execute} event.
-	 *
-	 * In order to see how to disable a command from "outside" see the {@link #isEnabled} documentation.
-	 *
-	 * This method may return a value, which would be forwarded all the way down to the
-	 * {@link module:core/editor/editor~Editor#execute `editor.execute()`}.
-	 *
-	 * @fires execute
-	 */
-	execute() {}
-
-	/**
-	 * Destroys the command.
-	 */
-	destroy() {
-		this.stopListening();
-	}
-
-	/**
-	 * Event fired by the {@link #execute} method. The command action is a listener to this event so it's
-	 * possible to change/cancel the behavior of the command by listening to this event.
-	 *
-	 * See {@link module:utils/observablemixin~ObservableMixin#decorate} for more information and samples.
-	 *
-	 * **Note:** This event is fired even if command is disabled. However, it is automatically blocked
-	 * by a high priority listener in order to prevent command execution.
-	 *
-	 * @event execute
-	 */
+export default class Command extends Observable {
+    /**
+     * Creates a new `Command` instance.
+     *
+     * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+     */
+    constructor(editor) {
+        super();
+        /**
+         * The editor on which this command will be used.
+         *
+         * @readonly
+         * @member {module:core/editor/editor~Editor}
+         */
+        this.editor = editor;
+        /**
+         * The value of the command. A concrete command class should define what it represents for it.
+         *
+         * For example, the `'bold'` command's value indicates whether the selection starts in a bolded text.
+         * And the value of the `'link'` command may be an object with links details.
+         *
+         * It is possible for a command to have no value (e.g. for stateless actions such as `'uploadImage'`).
+         *
+         * A concrete command class should control this value by overriding the {@link #refresh `refresh()`} method.
+         *
+         * @observable
+         * @readonly
+         * @member #value
+         */
+        this.set('value', undefined);
+        /**
+         * Flag indicating whether a command is enabled or disabled.
+         * A disabled command will do nothing when executed.
+         *
+         * A concrete command class should control this value by overriding the {@link #refresh `refresh()`} method.
+         *
+         * It is possible to disable a command from "outside". For instance, in your integration you may want to disable
+         * a certain set of commands for the time being. To do that, you can use the fact that `isEnabled` is observable
+         * and it fires the `set:isEnabled` event every time anyone tries to modify its value:
+         *
+         *		function disableCommand( cmd ) {
+         *			cmd.on( 'set:isEnabled', forceDisable, { priority: 'highest' } );
+         *
+         *			cmd.isEnabled = false;
+         *
+         *			// Make it possible to enable the command again.
+         *			return () => {
+         *				cmd.off( 'set:isEnabled', forceDisable );
+         *				cmd.refresh();
+         *			};
+         *
+         *			function forceDisable( evt ) {
+         *				evt.return = false;
+         *				evt.stop();
+         *			}
+         *		}
+         *
+         *		// Usage:
+         *
+         *		// Disabling the command.
+         *		const enableBold = disableCommand( editor.commands.get( 'bold' ) );
+         *
+         *		// Enabling the command again.
+         *		enableBold();
+         *
+         * @observable
+         * @readonly
+         * @member {Boolean} #isEnabled
+         */
+        this.set('isEnabled', false);
+        /**
+         * A flag indicating whether a command execution changes the editor data or not.
+         *
+         * Commands with `affectsData` set to `false` will not be automatically disabled in
+         * the {@link module:core/editor/editor~Editor#isReadOnly read-only mode} and
+         * {@glink features/read-only#related-features other editor modes} with restricted user write permissions.
+         *
+         * **Note:** You do not have to set it for your every command. It is `true` by default.
+         *
+         * @readonly
+         * @default true
+         * @member {Boolean} #affectsData
+         */
+        this._affectsData = true;
+        /**
+         * Holds identifiers for {@link #forceDisabled} mechanism.
+         *
+         * @type {Set.<String>}
+         * @private
+         */
+        this._disableStack = new Set();
+        this.decorate('execute');
+        // By default every command is refreshed when changes are applied to the model.
+        this.listenTo(this.editor.model.document, 'change', () => {
+            this.refresh();
+        });
+        this.on('execute', evt => {
+            if (!this.isEnabled) {
+                evt.stop();
+            }
+        }, { priority: 'high' });
+        // By default commands are disabled when the editor is in read-only mode.
+        this.listenTo(editor, 'change:isReadOnly', (evt, name, value) => {
+            if (value && this.affectsData) {
+                this.forceDisabled('readOnlyMode');
+            }
+            else {
+                this.clearForceDisabled('readOnlyMode');
+            }
+        });
+    }
+    get affectsData() {
+        return this._affectsData;
+    }
+    set affectsData(affectsData) {
+        this._affectsData = affectsData;
+    }
+    /**
+     * Refreshes the command. The command should update its {@link #isEnabled} and {@link #value} properties
+     * in this method.
+     *
+     * This method is automatically called when
+     * {@link module:engine/model/document~Document#event:change any changes are applied to the document}.
+     */
+    refresh() {
+        this.isEnabled = true;
+    }
+    /**
+     * Disables the command.
+     *
+     * Command may be disabled by multiple features or algorithms (at once). When disabling a command, unique id should be passed
+     * (e.g. feature name). The same identifier should be used when {@link #clearForceDisabled enabling back} the command.
+     * The command becomes enabled only after all features {@link #clearForceDisabled enabled it back}.
+     *
+     * Disabling and enabling a command:
+     *
+     *		command.isEnabled; // -> true
+     *		command.forceDisabled( 'MyFeature' );
+     *		command.isEnabled; // -> false
+     *		command.clearForceDisabled( 'MyFeature' );
+     *		command.isEnabled; // -> true
+     *
+     * Command disabled by multiple features:
+     *
+     *		command.forceDisabled( 'MyFeature' );
+     *		command.forceDisabled( 'OtherFeature' );
+     *		command.clearForceDisabled( 'MyFeature' );
+     *		command.isEnabled; // -> false
+     *		command.clearForceDisabled( 'OtherFeature' );
+     *		command.isEnabled; // -> true
+     *
+     * Multiple disabling with the same identifier is redundant:
+     *
+     *		command.forceDisabled( 'MyFeature' );
+     *		command.forceDisabled( 'MyFeature' );
+     *		command.clearForceDisabled( 'MyFeature' );
+     *		command.isEnabled; // -> true
+     *
+     * **Note:** some commands or algorithms may have more complex logic when it comes to enabling or disabling certain commands,
+     * so the command might be still disabled after {@link #clearForceDisabled} was used.
+     *
+     * @param {String} id Unique identifier for disabling. Use the same id when {@link #clearForceDisabled enabling back} the command.
+     */
+    forceDisabled(id) {
+        this._disableStack.add(id);
+        if (this._disableStack.size == 1) {
+            this.on('set:isEnabled', forceDisable, { priority: 'highest' });
+            this.isEnabled = false;
+        }
+    }
+    /**
+     * Clears forced disable previously set through {@link #forceDisabled}. See {@link #forceDisabled}.
+     *
+     * @param {String} id Unique identifier, equal to the one passed in {@link #forceDisabled} call.
+     */
+    clearForceDisabled(id) {
+        this._disableStack.delete(id);
+        if (this._disableStack.size == 0) {
+            this.off('set:isEnabled', forceDisable);
+            this.refresh();
+        }
+    }
+    /**
+     * Executes the command.
+     *
+     * A command may accept parameters. They will be passed from {@link module:core/editor/editor~Editor#execute `editor.execute()`}
+     * to the command.
+     *
+     * The `execute()` method will automatically abort when the command is disabled ({@link #isEnabled} is `false`).
+     * This behavior is implemented by a high priority listener to the {@link #event:execute} event.
+     *
+     * In order to see how to disable a command from "outside" see the {@link #isEnabled} documentation.
+     *
+     * This method may return a value, which would be forwarded all the way down to the
+     * {@link module:core/editor/editor~Editor#execute `editor.execute()`}.
+     *
+     * @fires execute
+     */
+    execute(...args) { return undefined; }
+    /**
+     * Destroys the command.
+     */
+    destroy() {
+        this.stopListening();
+    }
 }
-
-mix( Command, ObservableMixin );
-
 // Helper function that forces command to be disabled.
-function forceDisable( evt ) {
-	evt.return = false;
-	evt.stop();
+function forceDisable(evt) {
+    evt.return = false;
+    evt.stop();
 }