@ckeditor/ckeditor5-restricted-editing 40.0.0 → 40.2.0

package/src/restrictededitingmode/converters.js

@@ -1,142 +1,142 @@
-/**
- * @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 { Matcher } from 'ckeditor5/src/engine';
-import { getMarkerAtPosition } from './utils';
-const HIGHLIGHT_CLASS = 'restricted-editing-exception_selected';
-/**
- * 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 function setupExceptionHighlighting(editor) {
-    const view = editor.editing.view;
-    const model = editor.model;
-    const highlightedMarkers = new Set();
-    // Adding the class.
-    view.document.registerPostFixer((writer) => {
-        const modelSelection = model.document.selection;
-        const marker = getMarkerAtPosition(editor, modelSelection.anchor);
-        if (!marker) {
-            return false;
-        }
-        for (const viewElement of editor.editing.mapper.markerNameToElements(marker.name)) {
-            writer.addClass(HIGHLIGHT_CLASS, viewElement);
-            highlightedMarkers.add(viewElement);
-        }
-        return false;
-    });
-    // Removing the class.
-    editor.conversion.for('editingDowncast').add(dispatcher => {
-        // Make sure the highlight is removed on every possible event, before conversion is started.
-        dispatcher.on('insert', removeHighlight, { priority: 'highest' });
-        dispatcher.on('remove', removeHighlight, { priority: 'highest' });
-        dispatcher.on('attribute', removeHighlight, { priority: 'highest' });
-        dispatcher.on('cleanSelection', removeHighlight);
-        function removeHighlight() {
-            view.change(writer => {
-                for (const item of highlightedMarkers.values()) {
-                    writer.removeClass(HIGHLIGHT_CLASS, item);
-                    highlightedMarkers.delete(item);
-                }
-            });
-        }
-    });
-}
-/**
- * A post-fixer that prevents removing a collapsed marker from the document.
- */
-export function resurrectCollapsedMarkerPostFixer(editor) {
-    // This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
-    return writer => {
-        let changeApplied = false;
-        for (const { name, data } of editor.model.document.differ.getChangedMarkers()) {
-            if (name.startsWith('restrictedEditingException') && data.newRange && data.newRange.root.rootName == '$graveyard') {
-                writer.updateMarker(name, {
-                    range: writer.createRange(writer.createPositionAt(data.oldRange.start))
-                });
-                changeApplied = true;
-            }
-        }
-        return changeApplied;
-    };
-}
-/**
- * A post-fixer that extends a marker when the user types on its boundaries.
- */
-export function extendMarkerOnTypingPostFixer(editor) {
-    // This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
-    return writer => {
-        let changeApplied = false;
-        for (const change of editor.model.document.differ.getChanges()) {
-            if (change.type == 'insert' && change.name == '$text') {
-                changeApplied = _tryExtendMarkerStart(editor, change.position, change.length, writer) || changeApplied;
-                changeApplied = _tryExtendMarkedEnd(editor, change.position, change.length, writer) || changeApplied;
-            }
-        }
-        return changeApplied;
-    };
-}
-/**
- * A view highlight-to-marker conversion helper.
- *
- * @param config Conversion configuration.
- */
-export function upcastHighlightToMarker(config) {
-    return (dispatcher) => dispatcher.on('element:span', (evt, data, conversionApi) => {
-        const { writer } = conversionApi;
-        const matcher = new Matcher(config.view);
-        const matcherResult = matcher.match(data.viewItem);
-        // If there is no match, this callback should not do anything.
-        if (!matcherResult) {
-            return;
-        }
-        const match = matcherResult.match;
-        // Force consuming element's name (taken from upcast helpers elementToElement converter).
-        match.name = true;
-        const { modelRange: convertedChildrenRange } = conversionApi.convertChildren(data.viewItem, data.modelCursor);
-        conversionApi.consumable.consume(data.viewItem, match);
-        const markerName = config.model();
-        const fakeMarkerStart = writer.createElement('$marker', { 'data-name': markerName });
-        const fakeMarkerEnd = writer.createElement('$marker', { 'data-name': markerName });
-        // Insert in reverse order to use converter content positions directly (without recalculating).
-        writer.insert(fakeMarkerEnd, convertedChildrenRange.end);
-        writer.insert(fakeMarkerStart, convertedChildrenRange.start);
-        data.modelRange = writer.createRange(writer.createPositionBefore(fakeMarkerStart), writer.createPositionAfter(fakeMarkerEnd));
-        data.modelCursor = data.modelRange.end;
-    });
-}
-/**
- * Extend marker if change detected on marker's start position.
- */
-function _tryExtendMarkerStart(editor, position, length, writer) {
-    const markerAtStart = getMarkerAtPosition(editor, position.getShiftedBy(length));
-    if (markerAtStart && markerAtStart.getStart().isEqual(position.getShiftedBy(length))) {
-        writer.updateMarker(markerAtStart, {
-            range: writer.createRange(markerAtStart.getStart().getShiftedBy(-length), markerAtStart.getEnd())
-        });
-        return true;
-    }
-    return false;
-}
-/**
- * Extend marker if change detected on marker's end position.
- */
-function _tryExtendMarkedEnd(editor, position, length, writer) {
-    const markerAtEnd = getMarkerAtPosition(editor, position);
-    if (markerAtEnd && markerAtEnd.getEnd().isEqual(position)) {
-        writer.updateMarker(markerAtEnd, {
-            range: writer.createRange(markerAtEnd.getStart(), markerAtEnd.getEnd().getShiftedBy(length))
-        });
-        return true;
-    }
-    return false;
-}
+/**
+ * @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 { Matcher } from 'ckeditor5/src/engine';
+import { getMarkerAtPosition } from './utils';
+const HIGHLIGHT_CLASS = 'restricted-editing-exception_selected';
+/**
+ * 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 function setupExceptionHighlighting(editor) {
+    const view = editor.editing.view;
+    const model = editor.model;
+    const highlightedMarkers = new Set();
+    // Adding the class.
+    view.document.registerPostFixer((writer) => {
+        const modelSelection = model.document.selection;
+        const marker = getMarkerAtPosition(editor, modelSelection.anchor);
+        if (!marker) {
+            return false;
+        }
+        for (const viewElement of editor.editing.mapper.markerNameToElements(marker.name)) {
+            writer.addClass(HIGHLIGHT_CLASS, viewElement);
+            highlightedMarkers.add(viewElement);
+        }
+        return false;
+    });
+    // Removing the class.
+    editor.conversion.for('editingDowncast').add(dispatcher => {
+        // Make sure the highlight is removed on every possible event, before conversion is started.
+        dispatcher.on('insert', removeHighlight, { priority: 'highest' });
+        dispatcher.on('remove', removeHighlight, { priority: 'highest' });
+        dispatcher.on('attribute', removeHighlight, { priority: 'highest' });
+        dispatcher.on('cleanSelection', removeHighlight);
+        function removeHighlight() {
+            view.change(writer => {
+                for (const item of highlightedMarkers.values()) {
+                    writer.removeClass(HIGHLIGHT_CLASS, item);
+                    highlightedMarkers.delete(item);
+                }
+            });
+        }
+    });
+}
+/**
+ * A post-fixer that prevents removing a collapsed marker from the document.
+ */
+export function resurrectCollapsedMarkerPostFixer(editor) {
+    // This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
+    return writer => {
+        let changeApplied = false;
+        for (const { name, data } of editor.model.document.differ.getChangedMarkers()) {
+            if (name.startsWith('restrictedEditingException') && data.newRange && data.newRange.root.rootName == '$graveyard') {
+                writer.updateMarker(name, {
+                    range: writer.createRange(writer.createPositionAt(data.oldRange.start))
+                });
+                changeApplied = true;
+            }
+        }
+        return changeApplied;
+    };
+}
+/**
+ * A post-fixer that extends a marker when the user types on its boundaries.
+ */
+export function extendMarkerOnTypingPostFixer(editor) {
+    // This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
+    return writer => {
+        let changeApplied = false;
+        for (const change of editor.model.document.differ.getChanges()) {
+            if (change.type == 'insert' && change.name == '$text') {
+                changeApplied = _tryExtendMarkerStart(editor, change.position, change.length, writer) || changeApplied;
+                changeApplied = _tryExtendMarkedEnd(editor, change.position, change.length, writer) || changeApplied;
+            }
+        }
+        return changeApplied;
+    };
+}
+/**
+ * A view highlight-to-marker conversion helper.
+ *
+ * @param config Conversion configuration.
+ */
+export function upcastHighlightToMarker(config) {
+    return (dispatcher) => dispatcher.on('element:span', (evt, data, conversionApi) => {
+        const { writer } = conversionApi;
+        const matcher = new Matcher(config.view);
+        const matcherResult = matcher.match(data.viewItem);
+        // If there is no match, this callback should not do anything.
+        if (!matcherResult) {
+            return;
+        }
+        const match = matcherResult.match;
+        // Force consuming element's name (taken from upcast helpers elementToElement converter).
+        match.name = true;
+        const { modelRange: convertedChildrenRange } = conversionApi.convertChildren(data.viewItem, data.modelCursor);
+        conversionApi.consumable.consume(data.viewItem, match);
+        const markerName = config.model();
+        const fakeMarkerStart = writer.createElement('$marker', { 'data-name': markerName });
+        const fakeMarkerEnd = writer.createElement('$marker', { 'data-name': markerName });
+        // Insert in reverse order to use converter content positions directly (without recalculating).
+        writer.insert(fakeMarkerEnd, convertedChildrenRange.end);
+        writer.insert(fakeMarkerStart, convertedChildrenRange.start);
+        data.modelRange = writer.createRange(writer.createPositionBefore(fakeMarkerStart), writer.createPositionAfter(fakeMarkerEnd));
+        data.modelCursor = data.modelRange.end;
+    });
+}
+/**
+ * Extend marker if change detected on marker's start position.
+ */
+function _tryExtendMarkerStart(editor, position, length, writer) {
+    const markerAtStart = getMarkerAtPosition(editor, position.getShiftedBy(length));
+    if (markerAtStart && markerAtStart.getStart().isEqual(position.getShiftedBy(length))) {
+        writer.updateMarker(markerAtStart, {
+            range: writer.createRange(markerAtStart.getStart().getShiftedBy(-length), markerAtStart.getEnd())
+        });
+        return true;
+    }
+    return false;
+}
+/**
+ * Extend marker if change detected on marker's end position.
+ */
+function _tryExtendMarkedEnd(editor, position, length, writer) {
+    const markerAtEnd = getMarkerAtPosition(editor, position);
+    if (markerAtEnd && markerAtEnd.getEnd().isEqual(position)) {
+        writer.updateMarker(markerAtEnd, {
+            range: writer.createRange(markerAtEnd.getStart(), markerAtEnd.getEnd().getShiftedBy(length))
+        });
+        return true;
+    }
+    return false;
+}

package/src/restrictededitingmode/utils.d.ts

@@ -1,30 +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
- */
-import type { Editor } from 'ckeditor5/src/core';
-import type { DocumentSelection, Marker, Position, Range } from 'ckeditor5/src/engine';
-/**
- * @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;
+/**
+ * @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 type { Editor } from 'ckeditor5/src/core';
+import type { DocumentSelection, Marker, Position, Range } from 'ckeditor5/src/engine';
+/**
+ * @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/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];
+    }
+}