@ckeditor/ckeditor5-restricted-editing 44.1.0 → 44.2.0-alpha.0

package/dist/augmentation.d.ts

@@ -1,33 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { RestrictedEditingMode, RestrictedEditingModeEditing, RestrictedEditingModeUI, StandardEditingMode, StandardEditingModeEditing, StandardEditingModeUI, RestrictedEditingConfig, RestrictedEditingExceptionCommand, RestrictedEditingModeNavigationCommand } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [RestrictedEditingMode.pluginName]: RestrictedEditingMode;
-        [RestrictedEditingModeEditing.pluginName]: RestrictedEditingModeEditing;
-        [RestrictedEditingModeUI.pluginName]: RestrictedEditingModeUI;
-        [StandardEditingMode.pluginName]: StandardEditingMode;
-        [StandardEditingModeEditing.pluginName]: StandardEditingModeEditing;
-        [StandardEditingModeUI.pluginName]: StandardEditingModeUI;
-    }
-    interface CommandsMap {
-        restrictedEditingException: RestrictedEditingExceptionCommand;
-        goToPreviousRestrictedEditingException: RestrictedEditingModeNavigationCommand;
-        goToNextRestrictedEditingException: RestrictedEditingModeNavigationCommand;
-    }
-    interface EditorConfig {
-        /**
-         * The configuration of the restricted editing mode feature. Introduced by the
-         * {@link module:restricted-editing/restrictededitingmode~RestrictedEditingMode} feature.
-         *
-         * Read more in {@link module:restricted-editing/restrictededitingconfig~RestrictedEditingConfig}.
-         */
-        restrictedEditing?: RestrictedEditingConfig;
-    }
-}

package/dist/index.d.ts

@@ -1,21 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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
- */
-export { default as RestrictedEditingMode } from './restrictededitingmode.js';
-export { default as RestrictedEditingModeEditing } from './restrictededitingmodeediting.js';
-export { default as RestrictedEditingModeUI } from './restrictededitingmodeui.js';
-export { default as StandardEditingMode } from './standardeditingmode.js';
-export { default as StandardEditingModeEditing } from './standardeditingmodeediting.js';
-export { default as StandardEditingModeUI } from './standardeditingmodeui.js';
-export type { RestrictedEditingConfig } from './restrictededitingconfig.js';
-export type { default as RestrictedEditingExceptionCommand } from './restrictededitingexceptioncommand.js';
-export type { default as RestrictedEditingModeNavigationCommand } from './restrictededitingmodenavigationcommand.js';
-import './augmentation.js';

package/dist/restrictededitingconfig.d.ts

@@ -1,64 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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
- */
-/**
- * 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 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' ]
-     * };
-     * ```
-     *
-     * To make a command always enabled (also outside non-restricted areas) use
-     * {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing#enableCommand} method.
-     */
-    allowedCommands: Array<string>;
-    /**
-     * The text attribute names allowed when pasting content ot non-restricted areas.
-     *
-     * The default value is:
-     *
-     * ```ts
-     * const restrictedEditingConfig = {
-     *   allowedAttributes: [ 'bold', 'italic', 'linkHref' ]
-     * };
-     * ```
-     */
-    allowedAttributes: Array<string>;
-}

package/dist/restrictededitingexceptioncommand.d.ts

@@ -1,34 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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 'ckeditor5/src/core.js';
-/**
- * The command that toggles exceptions from the restricted editing on text.
- */
-export default class RestrictedEditingExceptionCommand extends Command {
-    /**
-     * A flag indicating whether the command is active
-     *
-     * @readonly
-     */
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * @inheritDoc
-     */
-    execute(options?: RestrictedEditingExceptionCommandParams): void;
-}
-export interface RestrictedEditingExceptionCommandParams {
-    forceValue?: unknown;
-}

package/dist/restrictededitingmode/converters.d.ts

@@ -1,43 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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 'ckeditor5/src/core.js';
-import { type MatcherPattern, type ModelPostFixer, type UpcastDispatcher } from 'ckeditor5/src/engine.js';
-/**
- * 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.
- */
-export declare function setupExceptionHighlighting(editor: Editor): void;
-/**
- * A post-fixer that prevents removing a collapsed marker from the document.
- */
-export declare function resurrectCollapsedMarkerPostFixer(editor: Editor): ModelPostFixer;
-/**
- * A post-fixer that extends a marker when the user types on its boundaries.
- */
-export declare function extendMarkerOnTypingPostFixer(editor: Editor): ModelPostFixer;
-/**
- * A view highlight-to-marker conversion helper.
- *
- * @param config Conversion configuration.
- */
-export declare function upcastHighlightToMarker(config: {
-    view: MatcherPattern;
-    model: () => string;
-}): (dispatcher: UpcastDispatcher) => void;

package/dist/restrictededitingmode/utils.d.ts

@@ -1,34 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-import type { DocumentSelection, Marker, Position, Range } from 'ckeditor5/src/engine.js';
-/**
- * @module restricted-editing/restrictededitingmode/utils
- */
-/**
- * Returns a single "restricted-editing-exception" marker at a given position. Contrary to
- * {@link module:engine/model/markercollection~MarkerCollection#getMarkersAtPosition}, it returnd a marker also when the postion is
- * equal to one of the marker's start or end positions.
- */
-export declare function getMarkerAtPosition(editor: Editor, position: Position): Marker | undefined;
-/**
- * Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
- */
-export declare function isPositionInRangeBoundaries(range: Range, position: Position): 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
- * ```
- */
-export declare function isSelectionInMarker(selection: DocumentSelection, marker?: Marker): boolean;

package/dist/restrictededitingmode.d.ts

@@ -1,37 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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 'ckeditor5/src/core.js';
-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}.
- */
-export default class RestrictedEditingMode extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RestrictedEditingMode";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof RestrictedEditingModeEditing, typeof RestrictedEditingModeUI];
-}

package/dist/restrictededitingmodeediting.d.ts

@@ -1,91 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/restrictededitingmodeediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The restricted editing mode editing feature.
- *
- * * It introduces the exception marker group that renders to `<span>` elements with the `restricted-editing-exception` CSS class.
- * * It registers the `'goToPreviousRestrictedEditingException'` and `'goToNextRestrictedEditingException'` commands.
- * * It also enables highlighting exception markers that are selected.
- */
-export default class RestrictedEditingModeEditing extends Plugin {
-    /**
-     * Command names that are enabled outside the non-restricted regions.
-     */
-    private _alwaysEnabled;
-    /**
-     * Commands allowed in non-restricted areas.
-     *
-     * Commands always enabled combine typing feature commands: `'input'`, `'insertText'`, `'delete'`, and `'deleteForward'` with
-     * commands defined in the feature configuration.
-     */
-    private _allowedInException;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RestrictedEditingModeEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Makes the given command always enabled in the restricted editing mode (regardless
-     * of selection location).
-     *
-     * To enable some commands in non-restricted areas of the content use
-     * {@link module:restricted-editing/restrictededitingconfig~RestrictedEditingConfig#allowedCommands} configuration option.
-     *
-     * @param commandName Name of the command to enable.
-     */
-    enableCommand(commandName: string): void;
-    /**
-     * Sets up the restricted mode editing conversion:
-     *
-     * * ucpast & downcast converters,
-     * * marker highlighting in the edting area,
-     * * marker post-fixers.
-     */
-    private _setupConversion;
-    /**
-     * Setups additional editing restrictions beyond command toggling:
-     *
-     * * delete content range trimming
-     * * disabling input command outside exception marker
-     * * restricting clipboard holder to text only
-     * * restricting text attributes in content
-     */
-    private _setupRestrictions;
-    /**
-     * Sets up the command toggling which enables or disables commands based on the user selection.
-     */
-    private _setupCommandsToggling;
-    /**
-     * Checks if commands should be enabled or disabled based on the current selection.
-     */
-    private _checkCommands;
-    /**
-     * Enables commands in non-restricted regions.
-     */
-    private _enableCommands;
-    /**
-     * Disables commands outside non-restricted regions.
-     */
-    private _disableCommands;
-}

package/dist/restrictededitingmodenavigationcommand.d.ts

@@ -1,46 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-/**
- * 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';

package/dist/restrictededitingmodeui.d.ts

@@ -1,50 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/restrictededitingmodeui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * 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
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates a button for restricted editing command to use in menu bar.
-     */
-    private _createMenuBarButton;
-    /**
-     * 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;
-    /**
-     * Returns definitions for UI buttons.
-     *
-     * @internal
-     */
-    private _getButtonDefinitions;
-}

package/dist/standardeditingmode.d.ts

@@ -1,34 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/standardeditingmode
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import StandardEditingModeEditing from './standardeditingmodeediting.js';
-import StandardEditingModeUI from './standardeditingmodeui.js';
-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";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    static get requires(): readonly [typeof StandardEditingModeEditing, typeof StandardEditingModeUI];
-}

package/dist/standardeditingmodeediting.d.ts

@@ -1,33 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/standardeditingmodeediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * 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
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/standardeditingmodeui.d.ts

@@ -1,35 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/standardeditingmodeui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The standard editing mode UI feature.
- *
- * It introduces the `'restrictedEditingException'` button that marks text as unrestricted for editing.
- */
-export default class StandardEditingModeUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "StandardEditingModeUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates a button for restricted editing exception command to use either in toolbar or in menu bar.
-     */
-    private _createButton;
-}