@ckeditor/ckeditor5-restricted-editing 48.2.0 → 48.3.0-alpha.0

package/dist/restrictededitingconfig.d.ts

@@ -1,63 +1,63 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module restricted-editing/restrictededitingconfig
- */
+* @module restricted-editing/restrictededitingconfig
+*/
 /**
- * The configuration of the restricted editing mode feature.
- * The option is used by the {@link module:restricted-editing/restrictededitingmode~RestrictedEditingMode} feature.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     restrictedEditing: {
- *       allowedCommands: [ 'bold', 'link', 'unlink' ],
- *       allowedAttributes: [ 'bold', 'linkHref' ]
- *     }
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the restricted editing mode feature.
+* The option is used by the {@link module:restricted-editing/restrictededitingmode~RestrictedEditingMode} feature.
+*
+* ```ts
+* ClassicEditor
+*   .create( {
+*     restrictedEditing: {
+*       allowedCommands: [ 'bold', 'link', 'unlink' ],
+*       allowedAttributes: [ 'bold', 'linkHref' ]
+*     }
+*   } )
+*   .then( ... )
+*   .catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface RestrictedEditingConfig {
-    /**
-     * The command names allowed in inline non-restricted areas of the content.
-     *
-     * Defines which feature commands should be enabled in the restricted editing mode. The commands used for typing and deleting text
-     * (`'input'`, `'delete'` and `'deleteForward'`) are allowed by the feature inside non-restricted regions and do not need to be defined.
-     *
-     * **Note**: The restricted editing mode always allows to use the restricted mode navigation commands as well as `'undo'` and `'redo'`
-     * commands.
-     *
-     * The default value is:
-     *
-     * ```ts
-     * const restrictedEditingConfig = {
-     *   allowedCommands: [ 'bold', 'italic', 'link', 'unlink' ]
-     * };
-     * ```
-     *
-     * Only inline content inserting or editing commands are allowed in this setting. Block content commands such as
-     * `insertTable` or `enter` cannot be allowed via this setting, as they are not supported in the restricted editing mode.
-     *
-     * To make a command always enabled (also outside non-restricted areas) use the
-     * {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing#enableCommand} method.
-     */
-    allowedCommands: Array<string>;
-    /**
-     * The text attribute names allowed when pasting content in inline non-restricted areas.
-     *
-     * The default value is:
-     *
-     * ```ts
-     * const restrictedEditingConfig = {
-     *   allowedAttributes: [ 'bold', 'italic', 'linkHref' ]
-     * };
-     * ```
-     */
-    allowedAttributes: Array<string>;
+	/**
+	* The command names allowed in inline non-restricted areas of the content.
+	*
+	* Defines which feature commands should be enabled in the restricted editing mode. The commands used for typing and deleting text
+	* (`'input'`, `'delete'` and `'deleteForward'`) are allowed by the feature inside non-restricted regions and do not need to be defined.
+	*
+	* **Note**: The restricted editing mode always allows to use the restricted mode navigation commands as well as `'undo'` and `'redo'`
+	* commands.
+	*
+	* The default value is:
+	*
+	* ```ts
+	* const restrictedEditingConfig = {
+	*   allowedCommands: [ 'bold', 'italic', 'link', 'unlink' ]
+	* };
+	* ```
+	*
+	* Only inline content inserting or editing commands are allowed in this setting. Block content commands such as
+	* `insertTable` or `enter` cannot be allowed via this setting, as they are not supported in the restricted editing mode.
+	*
+	* To make a command always enabled (also outside non-restricted areas) use the
+	* {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing#enableCommand} method.
+	*/
+	allowedCommands: Array<string>;
+	/**
+	* The text attribute names allowed when pasting content in inline non-restricted areas.
+	*
+	* The default value is:
+	*
+	* ```ts
+	* const restrictedEditingConfig = {
+	*   allowedAttributes: [ 'bold', 'italic', 'linkHref' ]
+	* };
+	* ```
+	*/
+	allowedAttributes: Array<string>;
 }

package/dist/restrictededitingexceptionautocommand.d.ts

@@ -1,39 +1,39 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module restricted-editing/restrictededitingexceptionautocommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+* @module restricted-editing/restrictededitingexceptionautocommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
 /**
- * The command that toggles exceptions from the restricted editing on text or on blocks.
- */
+* The command that toggles exceptions from the restricted editing on text or on blocks.
+*/
 export declare class RestrictedEditingExceptionAutoCommand extends Command {
-    /**
-     * A flag indicating whether the command is active.
-     *
-     * @readonly
-     */
-    value: boolean;
-    /**
-     * The inline exception command.
-     */
-    private readonly _inlineCommand;
-    /**
-     * The block exception command.
-     */
-    private readonly _blockCommand;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * @inheritDoc
-     */
-    execute(): void;
+	/**
+	* A flag indicating whether the command is active.
+	*
+	* @readonly
+	*/
+	value: boolean;
+	/**
+	* The inline exception command.
+	*/
+	private readonly _inlineCommand;
+	/**
+	* The block exception command.
+	*/
+	private readonly _blockCommand;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* @inheritDoc
+	*/
+	override execute(): void;
 }

package/dist/restrictededitingexceptionblockcommand.d.ts

@@ -1,57 +1,57 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module restricted-editing/restrictededitingexceptionblockcommand
- */
-import { Command } from '@ckeditor/ckeditor5-core';
+* @module restricted-editing/restrictededitingexceptionblockcommand
+*/
+import { Command } from "@ckeditor/ckeditor5-core";
 /**
- * The command that toggles exception blocks for the restricted editing.
- */
+* The command that toggles exception blocks for the restricted editing.
+*/
 export declare class RestrictedEditingExceptionBlockCommand extends Command {
-    /**
-     * Whether the selection starts in a block exception.
-     *
-     * @observable
-     * @readonly
-     */
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Wraps or unwraps the selected blocks with non-restricted area.
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a block exception,
-     * otherwise the command will remove the block exception. If not set, the command will act basing on its current value.
-     */
-    execute(options?: {
-        forceValue?: boolean;
-    }): void;
-    /**
-     * Checks the command's {@link #value}.
-     */
-    private _getValue;
-    /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @returns Whether the command should be enabled.
-     */
-    private _checkEnabled;
-    /**
-     * Unwraps the exception from given blocks.
-     *
-     * If blocks which are supposed to be unwrapped are in the middle of an exception,
-     * start it or end it, then the exception will be split (if needed) and the blocks
-     * will be moved out of it, so other exception blocks remained wrapped.
-     */
-    private _removeException;
-    /**
-     * Applies the exception to given blocks.
-     */
-    private _applyException;
+	/**
+	* Whether the selection starts in a block exception.
+	*
+	* @observable
+	* @readonly
+	*/
+	value: boolean;
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Wraps or unwraps the selected blocks with non-restricted area.
+	*
+	* @fires execute
+	* @param options Command options.
+	* @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a block exception,
+	* otherwise the command will remove the block exception. If not set, the command will act basing on its current value.
+	*/
+	override execute(options?: {
+		forceValue?: boolean;
+	}): void;
+	/**
+	* Checks the command's {@link #value}.
+	*/
+	private _getValue;
+	/**
+	* Checks whether the command can be enabled in the current context.
+	*
+	* @returns Whether the command should be enabled.
+	*/
+	private _checkEnabled;
+	/**
+	* Unwraps the exception from given blocks.
+	*
+	* If blocks which are supposed to be unwrapped are in the middle of an exception,
+	* start it or end it, then the exception will be split (if needed) and the blocks
+	* will be moved out of it, so other exception blocks remained wrapped.
+	*/
+	private _removeException;
+	/**
+	* Applies the exception to given blocks.
+	*/
+	private _applyException;
 }

package/dist/restrictededitingexceptioncommand.d.ts

@@ -1,30 +1,30 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module restricted-editing/restrictededitingexceptioncommand
- */
-import { Command } from '@ckeditor/ckeditor5-core';
+* @module restricted-editing/restrictededitingexceptioncommand
+*/
+import { Command } from "@ckeditor/ckeditor5-core";
 /**
- * The command that toggles exceptions from the restricted editing on text.
- */
+* The command that toggles exceptions from the restricted editing on text.
+*/
 export declare class RestrictedEditingExceptionCommand extends Command {
-    /**
-     * A flag indicating whether the command is active
-     *
-     * @readonly
-     */
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * @inheritDoc
-     */
-    execute(options?: RestrictedEditingExceptionCommandParams): void;
+	/**
+	* A flag indicating whether the command is active
+	*
+	* @readonly
+	*/
+	value: boolean;
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* @inheritDoc
+	*/
+	override execute(options?: RestrictedEditingExceptionCommandParams): void;
 }
 export interface RestrictedEditingExceptionCommandParams {
-    forceValue?: unknown;
+	forceValue?: unknown;
 }

package/dist/restrictededitingmode/converters.d.ts

@@ -1,47 +1,47 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module restricted-editing/restrictededitingmode/converters
- */
-import type { Editor } from '@ckeditor/ckeditor5-core';
-import { type MatcherPattern, type ModelPostFixer, type UpcastDispatcher } from '@ckeditor/ckeditor5-engine';
+* @module restricted-editing/restrictededitingmode/converters
+*/
+import type { Editor } from "@ckeditor/ckeditor5-core";
+import { type MatcherPattern, type ModelPostFixer, type UpcastDispatcher } from "@ckeditor/ckeditor5-engine";
 /**
- * Adds a visual highlight style to a restricted editing exception that the selection is anchored to.
- *
- * The highlight is turned on by adding the `.restricted-editing-exception_selected` class to the
- * exception in the view:
- *
- * * The class is removed before the conversion starts, as callbacks added with the `'highest'` priority
- * to {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher} events.
- * * The class is added in the view post-fixer, after other changes in the model tree are converted to the view.
- *
- * This way, adding and removing the highlight does not interfere with conversion.
- *
- * @internal
- */
+* Adds a visual highlight style to a restricted editing exception that the selection is anchored to.
+*
+* The highlight is turned on by adding the `.restricted-editing-exception_selected` class to the
+* exception in the view:
+*
+* * The class is removed before the conversion starts, as callbacks added with the `'highest'` priority
+* to {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher} events.
+* * The class is added in the view post-fixer, after other changes in the model tree are converted to the view.
+*
+* This way, adding and removing the highlight does not interfere with conversion.
+*
+* @internal
+*/
 export declare function setupExceptionHighlighting(editor: Editor): void;
 /**
- * A post-fixer that prevents removing a collapsed marker from the document.
- *
- * @internal
- */
+* A post-fixer that prevents removing a collapsed marker from the document.
+*
+* @internal
+*/
 export declare function resurrectCollapsedMarkerPostFixer(editor: Editor): ModelPostFixer;
 /**
- * A post-fixer that extends a marker when the user types on its boundaries.
- *
- * @internal
- */
+* A post-fixer that extends a marker when the user types on its boundaries.
+*
+* @internal
+*/
 export declare function extendMarkerOnTypingPostFixer(editor: Editor): ModelPostFixer;
 /**
- * A view highlight-to-marker conversion helper.
- *
- * @param config Conversion configuration.
- * @internal
- */
+* A view highlight-to-marker conversion helper.
+*
+* @param config Conversion configuration.
+* @internal
+*/
 export declare function upcastHighlightToMarker(config: {
-    view: MatcherPattern;
-    model: () => string;
-    useWrapperElement?: boolean;
+	view: MatcherPattern;
+	model: () => string;
+	useWrapperElement?: boolean;
 }): (dispatcher: UpcastDispatcher) => void;

package/dist/restrictededitingmode/utils.d.ts

@@ -1,42 +1,42 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module restricted-editing/restrictededitingmode/utils
- */
-import type { Editor } from '@ckeditor/ckeditor5-core';
-import type { ModelDocumentSelection, Marker, ModelPosition, ModelRange, Model } from '@ckeditor/ckeditor5-engine';
+* @module restricted-editing/restrictededitingmode/utils
+*/
+import type { Editor } from "@ckeditor/ckeditor5-core";
+import type { ModelDocumentSelection, Marker, ModelPosition, ModelRange, Model } from "@ckeditor/ckeditor5-engine";
 /**
- * Returns a single "restricted-editing-exception" marker at a given position. Contrary to
- * {@link module:engine/model/markercollection~MarkerCollection#getMarkersAtPosition}, it returns a marker also when the position is
- * equal to one of the marker's start or end positions.
- *
- * @internal
- */
+* Returns a single "restricted-editing-exception" marker at a given position. Contrary to
+* {@link module:engine/model/markercollection~MarkerCollection#getMarkersAtPosition}, it returns a marker also when the position is
+* equal to one of the marker's start or end positions.
+*
+* @internal
+*/
 export declare function getMarkerAtPosition(editor: Editor, position: ModelPosition): Marker | undefined;
 /**
- * Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
- *
- * @internal
- */
+* Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
+*
+* @internal
+*/
 export declare function isPositionInRangeBoundaries(range: ModelRange, position: ModelPosition): boolean;
 /**
- * Checks if the selection is fully contained in the marker. Positions on marker boundaries are considered "in".
- *
- * ```xml
- * <marker>[]foo</marker> -> true
- * <marker>f[oo]</marker> -> true
- * <marker>f[oo</marker> ba]r -> false
- * <marker>foo</marker> []bar -> false
- * ```
- *
- * @internal
- */
+* Checks if the selection is fully contained in the marker. Positions on marker boundaries are considered "in".
+*
+* ```xml
+* <marker>[]foo</marker> -> true
+* <marker>f[oo]</marker> -> true
+* <marker>f[oo</marker> ba]r -> false
+* <marker>foo</marker> []bar -> false
+* ```
+*
+* @internal
+*/
 export declare function isSelectionInMarker(selection: ModelDocumentSelection, model: Model, marker?: Marker): boolean;
 /**
- * Returns the marker range asjusted to the inside of exception wrapper element if needed.
- *
- * @internal
- */
+* Returns the marker range asjusted to the inside of exception wrapper element if needed.
+*
+* @internal
+*/
 export declare function getExceptionRange(marker: Marker, model: Model): ModelRange;

package/dist/restrictededitingmode.d.ts

@@ -1,33 +1,33 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module restricted-editing/restrictededitingmode
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { RestrictedEditingModeEditing } from './restrictededitingmodeediting.js';
-import { RestrictedEditingModeUI } from './restrictededitingmodeui.js';
-import '../theme/restrictedediting.css';
+* @module restricted-editing/restrictededitingmode
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { RestrictedEditingModeEditing } from "./restrictededitingmodeediting.js";
+import { RestrictedEditingModeUI } from "./restrictededitingmodeui.js";
+import "../theme/restrictedediting.css";
 /**
- * The restricted editing mode plugin.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * The {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing restricted mode editing feature}.
- * * The {@link module:restricted-editing/restrictededitingmodeui~RestrictedEditingModeUI restricted mode UI feature}.
- */
+* The restricted editing mode plugin.
+*
+* This is a "glue" plugin which loads the following plugins:
+*
+* * The {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing restricted mode editing feature}.
+* * The {@link module:restricted-editing/restrictededitingmodeui~RestrictedEditingModeUI restricted mode UI feature}.
+*/
 export declare class RestrictedEditingMode extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RestrictedEditingMode";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof RestrictedEditingModeEditing, typeof RestrictedEditingModeUI];
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "RestrictedEditingMode";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[RestrictedEditingModeEditing, RestrictedEditingModeUI]>;
 }