@ckeditor/ckeditor5-restricted-editing 41.2.0 → 41.3.0-alpha.0

package/dist/types/restrictededitingmode/utils.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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
+ */
+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/types/restrictededitingmode.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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
+ */
+/**
+ * @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 requires(): readonly [typeof RestrictedEditingModeEditing, typeof RestrictedEditingModeUI];
+}

package/dist/types/restrictededitingmodeediting.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @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
+ */
+/**
+ * @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
+     */
+    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/types/restrictededitingmodenavigationcommand.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @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
+ */
+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/types/restrictededitingmodeui.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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
+ */
+/**
+ * @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
+     */
+    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;
+}

package/dist/types/standardeditingmode.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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
+ */
+/**
+ * @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";
+    static get requires(): readonly [typeof StandardEditingModeEditing, typeof StandardEditingModeUI];
+}

package/dist/types/standardeditingmodeediting.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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
+ */
+/**
+ * @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
+     */
+    init(): void;
+}

package/dist/types/standardeditingmodeui.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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
+ */
+/**
+ * @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
+     */
+    init(): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-restricted-editing",
-  "version": "41.2.0",
+  "version": "41.3.0-alpha.0",
   "description": "Restricted editing feature for CKEditor 5 editors.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "41.2.0"
+    "ckeditor5": "41.3.0-alpha.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",
@@ -24,6 +24,7 @@
     "directory": "packages/ckeditor5-restricted-editing"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",