@ckeditor/ckeditor5-restricted-editing 36.0.0 → 37.0.0-alpha.0

package/src/restrictededitingmodenavigationcommand.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+/**
+ * The command that allows navigation across the exceptions in the edited document.
+ */
+export default class RestrictedEditingModeNavigationCommand extends Command {
+    /**
+     * The direction of the command.
+     */
+    private _direction;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param direction The direction that the command works.
+     */
+    constructor(editor: Editor, direction: RestrictedEditingModeNavigationDirection);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     */
+    execute(): void;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+}
+/**
+ * Directions in which the
+ * {@link module:restricted-editing/restrictededitingmodenavigationcommand~RestrictedEditingModeNavigationCommand} can work.
+ */
+export type RestrictedEditingModeNavigationDirection = 'forward' | 'backward';
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        goToPreviousRestrictedEditingException: RestrictedEditingModeNavigationCommand;
+        goToNextRestrictedEditingException: RestrictedEditingModeNavigationCommand;
+    }
+}

package/src/restrictededitingmodenavigationcommand.js

@@ -2,119 +2,93 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module restricted-editing/restrictededitingmodenavigationcommand
- */
-
 import { Command } from 'ckeditor5/src/core';
-
 /**
  * The command that allows navigation across the exceptions in the edited document.
- *
- * @extends module:core/command~Command
  */
 export default class RestrictedEditingModeNavigationCommand extends Command {
-	/**
-	 * Creates an instance of the command.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor The editor instance.
-	 * @param {String} direction The direction that the command works. Can be either `'forward'` or `'backward'`.
-	 */
-	constructor( editor, direction ) {
-		super( editor );
-
-		// It does not affect data so should be enabled in read-only mode and in restricted editing mode.
-		this.affectsData = false;
-
-		/**
-		 * The direction of the command. Can be `'forward'` or `'backward'`.
-		 *
-		 * @readonly
-		 * @private
-		 * @member {String}
-		 */
-		this._direction = direction;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		this.isEnabled = this._checkEnabled();
-	}
-
-	/**
-	 * Executes the command.
-	 *
-	 * @fires execute
-	 */
-	execute() {
-		const position = getNearestExceptionRange( this.editor.model, this._direction );
-
-		this.editor.model.change( writer => {
-			writer.setSelection( position );
-		} );
-	}
-
-	/**
-	 * Checks whether the command can be enabled in the current context.
-	 *
-	 * @private
-	 * @returns {Boolean} Whether the command should be enabled.
-	 */
-	_checkEnabled() {
-		return !!getNearestExceptionRange( this.editor.model, this._direction );
-	}
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param direction The direction that the command works.
+     */
+    constructor(editor, direction) {
+        super(editor);
+        // It does not affect data so should be enabled in read-only mode and in restricted editing mode.
+        this.affectsData = false;
+        this._direction = direction;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        this.isEnabled = this._checkEnabled();
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     */
+    execute() {
+        const position = getNearestExceptionRange(this.editor.model, this._direction);
+        if (!position) {
+            return;
+        }
+        this.editor.model.change(writer => {
+            writer.setSelection(position);
+        });
+    }
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    _checkEnabled() {
+        return !!getNearestExceptionRange(this.editor.model, this._direction);
+    }
 }
-
-// Returns the range of the exception marker closest to the last position of the
-// model selection.
-//
-// @param {module:engine/model/model~Model} model
-// @param {String} direction Either "forward" or "backward".
-// @returns {module:engine/model/range~Range|null}
-function getNearestExceptionRange( model, direction ) {
-	const selection = model.document.selection;
-	const selectionPosition = selection.getFirstPosition();
-	const markerRanges = [];
-
-	// Get all exception marker positions that start after/before the selection position.
-	for ( const marker of model.markers.getMarkersGroup( 'restrictedEditingException' ) ) {
-		const markerRange = marker.getRange();
-
-		// Checking parent because there two positions <paragraph>foo^</paragraph><paragraph>^bar</paragraph>
-		// are touching but they will represent different markers.
-		const isMarkerRangeTouching =
-			selectionPosition.isTouching( markerRange.start ) && selectionPosition.hasSameParentAs( markerRange.start ) ||
-			selectionPosition.isTouching( markerRange.end ) && selectionPosition.hasSameParentAs( markerRange.end );
-
-		// <paragraph>foo <marker≥b[]ar</marker> baz</paragraph>
-		// <paragraph>foo <marker≥b[ar</marker> ba]z</paragraph>
-		// <paragraph>foo <marker≥bar</marker>[] baz</paragraph>
-		// <paragraph>foo []<marker≥bar</marker> baz</paragraph>
-		if ( markerRange.containsPosition( selectionPosition ) || isMarkerRangeTouching ) {
-			continue;
-		}
-
-		if ( direction === 'forward' && markerRange.start.isAfter( selectionPosition ) ) {
-			markerRanges.push( markerRange );
-		} else if ( direction === 'backward' && markerRange.end.isBefore( selectionPosition ) ) {
-			markerRanges.push( markerRange );
-		}
-	}
-
-	if ( !markerRanges.length ) {
-		return null;
-	}
-
-	// Get the marker closest to the selection position among many. To know that, we need to sort
-	// them first.
-	return markerRanges.sort( ( rangeA, rangeB ) => {
-		if ( direction === 'forward' ) {
-			return rangeA.start.isAfter( rangeB.start ) ? 1 : -1;
-		} else {
-			return rangeA.start.isBefore( rangeB.start ) ? 1 : -1;
-		}
-	} ).shift();
+/**
+ * Returns the range of the exception marker closest to the last position of the model selection.
+ */
+function getNearestExceptionRange(model, direction) {
+    const selection = model.document.selection;
+    const selectionPosition = selection.getFirstPosition();
+    const markerRanges = [];
+    // Get all exception marker positions that start after/before the selection position.
+    for (const marker of model.markers.getMarkersGroup('restrictedEditingException')) {
+        const markerRange = marker.getRange();
+        // Checking parent because there two positions <paragraph>foo^</paragraph><paragraph>^bar</paragraph>
+        // are touching but they will represent different markers.
+        const isMarkerRangeTouching = selectionPosition.isTouching(markerRange.start) && selectionPosition.hasSameParentAs(markerRange.start) ||
+            selectionPosition.isTouching(markerRange.end) && selectionPosition.hasSameParentAs(markerRange.end);
+        // <paragraph>foo <marker≥b[]ar</marker> baz</paragraph>
+        // <paragraph>foo <marker≥b[ar</marker> ba]z</paragraph>
+        // <paragraph>foo <marker≥bar</marker>[] baz</paragraph>
+        // <paragraph>foo []<marker≥bar</marker> baz</paragraph>
+        if (markerRange.containsPosition(selectionPosition) || isMarkerRangeTouching) {
+            continue;
+        }
+        if (direction === 'forward' && markerRange.start.isAfter(selectionPosition)) {
+            markerRanges.push(markerRange);
+        }
+        else if (direction === 'backward' && markerRange.end.isBefore(selectionPosition)) {
+            markerRanges.push(markerRange);
+        }
+    }
+    if (!markerRanges.length) {
+        return;
+    }
+    // Get the marker closest to the selection position among many. To know that, we need to sort
+    // them first.
+    return markerRanges
+        .sort((rangeA, rangeB) => {
+        if (direction === 'forward') {
+            return rangeA.start.isAfter(rangeB.start) ? 1 : -1;
+        }
+        else {
+            return rangeA.start.isBefore(rangeB.start) ? 1 : -1;
+        }
+    })
+        .shift();
 }

package/src/restrictededitingmodeui.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module restricted-editing/restrictededitingmodeui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The restricted editing mode UI feature.
+ *
+ * It introduces the `'restrictedEditing'` dropdown that offers tools to navigate between exceptions across
+ * the document.
+ */
+export default class RestrictedEditingModeUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'RestrictedEditingModeUI';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Returns a definition of the navigation button to be used in the dropdown.
+
+     * @param commandName The name of the command that the button represents.
+     * @param label The translated label of the button.
+     * @param keystroke The button keystroke.
+     */
+    private _getButtonDefinition;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [RestrictedEditingModeUI.pluginName]: RestrictedEditingModeUI;
+    }
+}

package/src/restrictededitingmodeui.js

@@ -2,99 +2,74 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module restricted-editing/restrictededitingmodeui
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
 import { Collection } from 'ckeditor5/src/utils';
-
 import lockIcon from '../theme/icons/contentlock.svg';
-
 /**
  * The restricted editing mode UI feature.
  *
  * It introduces the `'restrictedEditing'` dropdown that offers tools to navigate between exceptions across
  * the document.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class RestrictedEditingModeUI extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'RestrictedEditingModeUI';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-		const t = editor.t;
-
-		editor.ui.componentFactory.add( 'restrictedEditing', locale => {
-			const dropdownView = createDropdown( locale );
-			const listItems = new Collection();
-
-			listItems.add( this._getButtonDefinition(
-				'goToPreviousRestrictedEditingException',
-				t( 'Previous editable region' ),
-				'Shift+Tab'
-			) );
-			listItems.add( this._getButtonDefinition(
-				'goToNextRestrictedEditingException',
-				t( 'Next editable region' ),
-				'Tab'
-			) );
-
-			addListToDropdown( dropdownView, listItems );
-
-			dropdownView.buttonView.set( {
-				label: t( 'Navigate editable regions' ),
-				icon: lockIcon,
-				tooltip: true,
-				isEnabled: true,
-				isOn: false
-			} );
-
-			this.listenTo( dropdownView, 'execute', evt => {
-				editor.execute( evt.source._commandName );
-				editor.editing.view.focus();
-			} );
-
-			return dropdownView;
-		} );
-	}
-
-	/**
-	 * Returns a definition of the navigation button to be used in the dropdown.
-	 *
-	 * @private
-	 * @param {String} commandName The name of the command that the button represents.
-	 * @param {String} label The translated label of the button.
-	 * @param {String} keystroke The button keystroke.
-	 * @returns {module:ui/dropdown/utils~ListDropdownItemDefinition}
-	 */
-	_getButtonDefinition( commandName, label, keystroke ) {
-		const editor = this.editor;
-		const command = editor.commands.get( commandName );
-		const definition = {
-			type: 'button',
-			model: new Model( {
-				label,
-				withText: true,
-				keystroke,
-				withKeystroke: true,
-				_commandName: commandName
-			} )
-		};
-
-		definition.model.bind( 'isEnabled' ).to( command, 'isEnabled' );
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'RestrictedEditingModeUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        editor.ui.componentFactory.add('restrictedEditing', locale => {
+            const dropdownView = createDropdown(locale);
+            const listItems = new Collection();
+            listItems.add(this._getButtonDefinition('goToPreviousRestrictedEditingException', t('Previous editable region'), 'Shift+Tab'));
+            listItems.add(this._getButtonDefinition('goToNextRestrictedEditingException', t('Next editable region'), 'Tab'));
+            addListToDropdown(dropdownView, listItems);
+            dropdownView.buttonView.set({
+                label: t('Navigate editable regions'),
+                icon: lockIcon,
+                tooltip: true,
+                isEnabled: true,
+                isOn: false
+            });
+            this.listenTo(dropdownView, 'execute', evt => {
+                const { _commandName } = evt.source;
+                editor.execute(_commandName);
+                editor.editing.view.focus();
+            });
+            return dropdownView;
+        });
+    }
+    /**
+     * Returns a definition of the navigation button to be used in the dropdown.
 
-		return definition;
-	}
+     * @param commandName The name of the command that the button represents.
+     * @param label The translated label of the button.
+     * @param keystroke The button keystroke.
+     */
+    _getButtonDefinition(commandName, label, keystroke) {
+        const editor = this.editor;
+        const command = editor.commands.get(commandName);
+        const definition = {
+            type: 'button',
+            model: new Model({
+                label,
+                withText: true,
+                keystroke,
+                withKeystroke: true,
+                _commandName: commandName
+            })
+        };
+        definition.model.bind('isEnabled').to(command, 'isEnabled');
+        return definition;
+    }
 }

package/src/standardeditingmode.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module restricted-editing/standardeditingmode
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+import '../theme/restrictedediting.css';
+/**
+ * The standard editing mode plugin.
+ *
+ * This is a "glue" plugin that loads the following plugins:
+ *
+ * * The {@link module:restricted-editing/standardeditingmodeediting~StandardEditingModeEditing standard mode editing feature}.
+ * * The {@link module:restricted-editing/standardeditingmodeui~StandardEditingModeUI standard mode UI feature}.
+ */
+export default class StandardEditingMode extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'StandardEditingMode';
+    static get requires(): PluginDependencies;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [StandardEditingMode.pluginName]: StandardEditingMode;
+    }
+}

package/src/standardeditingmode.js

@@ -2,18 +2,13 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module restricted-editing/standardeditingmode
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-
 import StandardEditingModeEditing from './standardeditingmodeediting';
 import StandardEditingModeUI from './standardeditingmodeui';
-
 import '../theme/restrictedediting.css';
-
 /**
  * The standard editing mode plugin.
  *
@@ -21,18 +16,15 @@ import '../theme/restrictedediting.css';
  *
  * * The {@link module:restricted-editing/standardeditingmodeediting~StandardEditingModeEditing standard mode editing feature}.
  * * The {@link module:restricted-editing/standardeditingmodeui~StandardEditingModeUI standard mode UI feature}.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class StandardEditingMode extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'StandardEditingMode';
-	}
-
-	static get requires() {
-		return [ StandardEditingModeEditing, StandardEditingModeUI ];
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'StandardEditingMode';
+    }
+    static get requires() {
+        return [StandardEditingModeEditing, StandardEditingModeUI];
+    }
 }

package/src/standardeditingmodeediting.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module restricted-editing/standardeditingmodeediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The standard editing mode editing feature.
+ *
+ * * It introduces the `restrictedEditingException` text attribute that is rendered as
+ * a `<span>` element with the `restricted-editing-exception` CSS class.
+ * * It registers the `'restrictedEditingException'` command.
+ */
+export default class StandardEditingModeEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'StandardEditingModeEditing';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [StandardEditingModeEditing.pluginName]: StandardEditingModeEditing;
+    }
+}

package/src/standardeditingmodeediting.js

@@ -2,64 +2,52 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module restricted-editing/standardeditingmodeediting
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-
 import RestrictedEditingExceptionCommand from './restrictededitingexceptioncommand';
-
 /**
  * The standard editing mode editing feature.
  *
  * * It introduces the `restrictedEditingException` text attribute that is rendered as
  * a `<span>` element with the `restricted-editing-exception` CSS class.
  * * It registers the `'restrictedEditingException'` command.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class StandardEditingModeEditing extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'StandardEditingModeEditing';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		editor.model.schema.extend( '$text', { allowAttributes: [ 'restrictedEditingException' ] } );
-
-		editor.conversion.for( 'upcast' ).elementToAttribute( {
-			model: 'restrictedEditingException',
-			view: {
-				name: 'span',
-				classes: 'restricted-editing-exception'
-			}
-		} );
-
-		editor.conversion.for( 'downcast' ).attributeToElement( {
-			model: 'restrictedEditingException',
-			view: ( modelAttributeValue, { writer } ) => {
-				if ( modelAttributeValue ) {
-					// Make the restricted editing <span> outer-most in the view.
-					return writer.createAttributeElement( 'span', { class: 'restricted-editing-exception' }, { priority: -10 } );
-				}
-			}
-		} );
-
-		editor.commands.add( 'restrictedEditingException', new RestrictedEditingExceptionCommand( editor ) );
-
-		editor.editing.view.change( writer => {
-			for ( const root of editor.editing.view.document.roots ) {
-				writer.addClass( 'ck-restricted-editing_mode_standard', root );
-			}
-		} );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'StandardEditingModeEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        editor.model.schema.extend('$text', { allowAttributes: ['restrictedEditingException'] });
+        editor.conversion.for('upcast').elementToAttribute({
+            model: 'restrictedEditingException',
+            view: {
+                name: 'span',
+                classes: 'restricted-editing-exception'
+            }
+        });
+        editor.conversion.for('downcast').attributeToElement({
+            model: 'restrictedEditingException',
+            view: (modelAttributeValue, { writer }) => {
+                if (modelAttributeValue) {
+                    // Make the restricted editing <span> outer-most in the view.
+                    return writer.createAttributeElement('span', { class: 'restricted-editing-exception' }, { priority: -10 });
+                }
+            }
+        });
+        editor.commands.add('restrictedEditingException', new RestrictedEditingExceptionCommand(editor));
+        editor.editing.view.change(writer => {
+            for (const root of editor.editing.view.document.roots) {
+                writer.addClass('ck-restricted-editing_mode_standard', root);
+            }
+        });
+    }
 }