@ckeditor/ckeditor5-restricted-editing 38.0.1 → 38.1.1

package/src/restrictededitingmode/utils.js

@@ -1,50 +1,50 @@
-/**
- * @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/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 function getMarkerAtPosition(editor, position) {
-    for (const marker of editor.model.markers) {
-        const markerRange = marker.getRange();
-        if (isPositionInRangeBoundaries(markerRange, position)) {
-            if (marker.name.startsWith('restrictedEditingException:')) {
-                return marker;
-            }
-        }
-    }
-}
-/**
- * Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
- */
-export function isPositionInRangeBoundaries(range, position) {
-    return (range.containsPosition(position) ||
-        range.end.isEqual(position) ||
-        range.start.isEqual(position));
-}
-/**
- * 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 function isSelectionInMarker(selection, marker) {
-    if (!marker) {
-        return false;
-    }
-    const markerRange = marker.getRange();
-    if (selection.isCollapsed) {
-        return isPositionInRangeBoundaries(markerRange, selection.focus);
-    }
-    return markerRange.containsRange(selection.getFirstRange(), true);
-}
+/**
+ * @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/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 function getMarkerAtPosition(editor, position) {
+    for (const marker of editor.model.markers) {
+        const markerRange = marker.getRange();
+        if (isPositionInRangeBoundaries(markerRange, position)) {
+            if (marker.name.startsWith('restrictedEditingException:')) {
+                return marker;
+            }
+        }
+    }
+}
+/**
+ * Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
+ */
+export function isPositionInRangeBoundaries(range, position) {
+    return (range.containsPosition(position) ||
+        range.end.isEqual(position) ||
+        range.start.isEqual(position));
+}
+/**
+ * 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 function isSelectionInMarker(selection, marker) {
+    if (!marker) {
+        return false;
+    }
+    const markerRange = marker.getRange();
+    if (selection.isCollapsed) {
+        return isPositionInRangeBoundaries(markerRange, selection.focus);
+    }
+    return markerRange.containsRange(selection.getFirstRange(), true);
+}

package/src/restrictededitingmode.d.ts

@@ -1,29 +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/restrictededitingmode
- */
-import { Plugin } from 'ckeditor5/src/core';
-import RestrictedEditingModeEditing from './restrictededitingmodeediting';
-import RestrictedEditingModeUI from './restrictededitingmodeui';
-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];
-}
+/**
+ * @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/restrictededitingmode
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import RestrictedEditingModeEditing from './restrictededitingmodeediting';
+import RestrictedEditingModeUI from './restrictededitingmodeui';
+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/src/restrictededitingmode.js

@@ -1,33 +1,33 @@
-/**
- * @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/restrictededitingmode
- */
-import { Plugin } from 'ckeditor5/src/core';
-import RestrictedEditingModeEditing from './restrictededitingmodeediting';
-import RestrictedEditingModeUI from './restrictededitingmodeui';
-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() {
-        return 'RestrictedEditingMode';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [RestrictedEditingModeEditing, RestrictedEditingModeUI];
-    }
-}
+/**
+ * @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/restrictededitingmode
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import RestrictedEditingModeEditing from './restrictededitingmodeediting';
+import RestrictedEditingModeUI from './restrictededitingmodeui';
+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() {
+        return 'RestrictedEditingMode';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [RestrictedEditingModeEditing, RestrictedEditingModeUI];
+    }
+}

package/src/restrictededitingmodeediting.d.ts

@@ -1,83 +1,83 @@
-/**
- * @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/restrictededitingmodeediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-/**
- * 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;
-}
+/**
+ * @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/restrictededitingmodeediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * 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;
+}