@ckeditor/ckeditor5-restricted-editing 45.2.1-alpha.9 → 46.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-restricted-editing",
-  "version": "45.2.1-alpha.9",
+  "version": "46.0.0-alpha.0",
   "description": "Restricted editing feature for CKEditor 5 editors.",
   "keywords": [
     "ckeditor",
@@ -12,12 +12,12 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "45.2.1-alpha.9",
-    "@ckeditor/ckeditor5-engine": "45.2.1-alpha.9",
-    "@ckeditor/ckeditor5-icons": "45.2.1-alpha.9",
-    "@ckeditor/ckeditor5-ui": "45.2.1-alpha.9",
-    "@ckeditor/ckeditor5-utils": "45.2.1-alpha.9",
-    "ckeditor5": "45.2.1-alpha.9"
+    "@ckeditor/ckeditor5-core": "46.0.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "46.0.0-alpha.0",
+    "@ckeditor/ckeditor5-icons": "46.0.0-alpha.0",
+    "@ckeditor/ckeditor5-ui": "46.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "46.0.0-alpha.0",
+    "ckeditor5": "46.0.0-alpha.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "SEE LICENSE IN LICENSE.md",

package/src/index.d.ts

@@ -5,13 +5,15 @@
 /**
  * @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 { RestrictedEditingMode } from './restrictededitingmode.js';
+export { RestrictedEditingModeEditing } from './restrictededitingmodeediting.js';
+export { RestrictedEditingModeUI } from './restrictededitingmodeui.js';
+export { RestrictedEditingExceptionCommand, type RestrictedEditingExceptionCommandParams } from './restrictededitingexceptioncommand.js';
+export { RestrictedEditingModeNavigationCommand, type RestrictedEditingModeNavigationDirection } from './restrictededitingmodenavigationcommand.js';
+export { StandardEditingMode } from './standardeditingmode.js';
+export { StandardEditingModeEditing } from './standardeditingmodeediting.js';
+export { 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';
+export { setupExceptionHighlighting as _setupRestrictedEditingExceptionHighlighting, resurrectCollapsedMarkerPostFixer as _resurrectRestrictedEditingCollapsedMarkerPostFixer, extendMarkerOnTypingPostFixer as _extendRestrictedEditingMarkerOnTypingPostFixer, upcastHighlightToMarker as _upcastRestrictedEditingHighlightToMarker } from './restrictededitingmode/converters.js';
+export { getMarkerAtPosition as _getRestrictedEditingMarkerAtPosition, isPositionInRangeBoundaries as _isRestrictedEditingPositionInRangeBoundaries, isSelectionInMarker as _isRestrictedEditingSelectionInMarker } from './restrictededitingmode/utils.js';
 import './augmentation.js';

package/src/index.js

@@ -5,10 +5,14 @@
 /**
  * @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 { RestrictedEditingMode } from './restrictededitingmode.js';
+export { RestrictedEditingModeEditing } from './restrictededitingmodeediting.js';
+export { RestrictedEditingModeUI } from './restrictededitingmodeui.js';
+export { RestrictedEditingExceptionCommand } from './restrictededitingexceptioncommand.js';
+export { RestrictedEditingModeNavigationCommand } from './restrictededitingmodenavigationcommand.js';
+export { StandardEditingMode } from './standardeditingmode.js';
+export { StandardEditingModeEditing } from './standardeditingmodeediting.js';
+export { StandardEditingModeUI } from './standardeditingmodeui.js';
+export { setupExceptionHighlighting as _setupRestrictedEditingExceptionHighlighting, resurrectCollapsedMarkerPostFixer as _resurrectRestrictedEditingCollapsedMarkerPostFixer, extendMarkerOnTypingPostFixer as _extendRestrictedEditingMarkerOnTypingPostFixer, upcastHighlightToMarker as _upcastRestrictedEditingHighlightToMarker } from './restrictededitingmode/converters.js';
+export { getMarkerAtPosition as _getRestrictedEditingMarkerAtPosition, isPositionInRangeBoundaries as _isRestrictedEditingPositionInRangeBoundaries, isSelectionInMarker as _isRestrictedEditingSelectionInMarker } from './restrictededitingmode/utils.js';
 import './augmentation.js';

package/src/restrictededitingexceptioncommand.d.ts

@@ -9,7 +9,7 @@ import { Command } from 'ckeditor5/src/core.js';
 /**
  * The command that toggles exceptions from the restricted editing on text.
  */
-export default class RestrictedEditingExceptionCommand extends Command {
+export declare class RestrictedEditingExceptionCommand extends Command {
     /**
      * A flag indicating whether the command is active
      *

package/src/restrictededitingexceptioncommand.js

@@ -9,7 +9,7 @@ import { Command } from 'ckeditor5/src/core.js';
 /**
  * The command that toggles exceptions from the restricted editing on text.
  */
-export default class RestrictedEditingExceptionCommand extends Command {
+export class RestrictedEditingExceptionCommand extends Command {
     /**
      * @inheritDoc
      */

package/src/restrictededitingmode/converters.d.ts

@@ -18,20 +18,27 @@ import { type MatcherPattern, type ModelPostFixer, type UpcastDispatcher } from
  * * 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
  */
 export declare function resurrectCollapsedMarkerPostFixer(editor: Editor): ModelPostFixer;
 /**
  * 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
  */
 export declare function upcastHighlightToMarker(config: {
     view: MatcherPattern;

package/src/restrictededitingmode/converters.js

@@ -16,6 +16,8 @@ const HIGHLIGHT_CLASS = 'restricted-editing-exception_selected';
  * * 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 function setupExceptionHighlighting(editor) {
     const view = editor.editing.view;
@@ -53,6 +55,8 @@ export function setupExceptionHighlighting(editor) {
 }
 /**
  * A post-fixer that prevents removing a collapsed marker from the document.
+ *
+ * @internal
  */
 export function resurrectCollapsedMarkerPostFixer(editor) {
     // This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
@@ -71,6 +75,8 @@ export function resurrectCollapsedMarkerPostFixer(editor) {
 }
 /**
  * A post-fixer that extends a marker when the user types on its boundaries.
+ *
+ * @internal
  */
 export function extendMarkerOnTypingPostFixer(editor) {
     // This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
@@ -90,6 +96,7 @@ export function extendMarkerOnTypingPostFixer(editor) {
  * A view highlight-to-marker conversion helper.
  *
  * @param config Conversion configuration.
+ * @internal
  */
 export function upcastHighlightToMarker(config) {
     return (dispatcher) => dispatcher.on('element:span', (evt, data, conversionApi) => {

package/src/restrictededitingmode/utils.d.ts

@@ -3,7 +3,7 @@
  * 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';
+import type { ModelDocumentSelection, Marker, ModelPosition, ModelRange } from 'ckeditor5/src/engine.js';
 /**
  * @module restricted-editing/restrictededitingmode/utils
  */
@@ -11,12 +11,16 @@ import type { DocumentSelection, Marker, Position, Range } from 'ckeditor5/src/e
  * 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.
+ *
+ * @internal
  */
-export declare function getMarkerAtPosition(editor: Editor, position: Position): Marker | undefined;
+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
  */
-export declare function isPositionInRangeBoundaries(range: Range, position: Position): boolean;
+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".
  *
@@ -26,5 +30,7 @@ export declare function isPositionInRangeBoundaries(range: Range, position: Posi
  * <marker>f[oo</marker> ba]r -> false
  * <marker>foo</marker> []bar -> false
  * ```
+ *
+ * @internal
  */
-export declare function isSelectionInMarker(selection: DocumentSelection, marker?: Marker): boolean;
+export declare function isSelectionInMarker(selection: ModelDocumentSelection, marker?: Marker): boolean;

package/src/restrictededitingmode/utils.js

@@ -9,6 +9,8 @@
  * 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.
+ *
+ * @internal
  */
 export function getMarkerAtPosition(editor, position) {
     for (const marker of editor.model.markers) {
@@ -22,6 +24,8 @@ export function getMarkerAtPosition(editor, position) {
 }
 /**
  * Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
+ *
+ * @internal
  */
 export function isPositionInRangeBoundaries(range, position) {
     return (range.containsPosition(position) ||
@@ -37,6 +41,8 @@ export function isPositionInRangeBoundaries(range, position) {
  * <marker>f[oo</marker> ba]r -> false
  * <marker>foo</marker> []bar -> false
  * ```
+ *
+ * @internal
  */
 export function isSelectionInMarker(selection, marker) {
     if (!marker) {

package/src/restrictededitingmode.d.ts

@@ -6,8 +6,8 @@
  * @module restricted-editing/restrictededitingmode
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import RestrictedEditingModeEditing from './restrictededitingmodeediting.js';
-import RestrictedEditingModeUI from './restrictededitingmodeui.js';
+import { RestrictedEditingModeEditing } from './restrictededitingmodeediting.js';
+import { RestrictedEditingModeUI } from './restrictededitingmodeui.js';
 import '../theme/restrictedediting.css';
 /**
  * The restricted editing mode plugin.
@@ -17,7 +17,7 @@ import '../theme/restrictedediting.css';
  * * 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 {
+export declare class RestrictedEditingMode extends Plugin {
     /**
      * @inheritDoc
      */

package/src/restrictededitingmode.js

@@ -6,8 +6,8 @@
  * @module restricted-editing/restrictededitingmode
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import RestrictedEditingModeEditing from './restrictededitingmodeediting.js';
-import RestrictedEditingModeUI from './restrictededitingmodeui.js';
+import { RestrictedEditingModeEditing } from './restrictededitingmodeediting.js';
+import { RestrictedEditingModeUI } from './restrictededitingmodeui.js';
 import '../theme/restrictedediting.css';
 /**
  * The restricted editing mode plugin.
@@ -17,7 +17,7 @@ import '../theme/restrictedediting.css';
  * * 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 {
+export class RestrictedEditingMode extends Plugin {
     /**
      * @inheritDoc
      */

package/src/restrictededitingmodeediting.d.ts

@@ -13,7 +13,7 @@ import { Plugin, type Editor } from 'ckeditor5/src/core.js';
  * * It registers the `'goToPreviousRestrictedEditingException'` and `'goToNextRestrictedEditingException'` commands.
  * * It also enables highlighting exception markers that are selected.
  */
-export default class RestrictedEditingModeEditing extends Plugin {
+export declare class RestrictedEditingModeEditing extends Plugin {
     /**
      * Command names that are enabled outside the non-restricted regions.
      */

package/src/restrictededitingmodeediting.js

@@ -6,7 +6,7 @@
  * @module restricted-editing/restrictededitingmodeediting
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import RestrictedEditingModeNavigationCommand from './restrictededitingmodenavigationcommand.js';
+import { RestrictedEditingModeNavigationCommand } from './restrictededitingmodenavigationcommand.js';
 import { extendMarkerOnTypingPostFixer, resurrectCollapsedMarkerPostFixer, setupExceptionHighlighting, upcastHighlightToMarker } from './restrictededitingmode/converters.js';
 import { getMarkerAtPosition, isSelectionInMarker } from './restrictededitingmode/utils.js';
 const COMMAND_FORCE_DISABLE_ID = 'RestrictedEditingMode';
@@ -17,7 +17,7 @@ const COMMAND_FORCE_DISABLE_ID = 'RestrictedEditingMode';
  * * It registers the `'goToPreviousRestrictedEditingException'` and `'goToNextRestrictedEditingException'` commands.
  * * It also enables highlighting exception markers that are selected.
  */
-export default class RestrictedEditingModeEditing extends Plugin {
+export class RestrictedEditingModeEditing extends Plugin {
     /**
      * Command names that are enabled outside the non-restricted regions.
      */

package/src/restrictededitingmodenavigationcommand.d.ts

@@ -6,7 +6,7 @@ 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 {
+export declare class RestrictedEditingModeNavigationCommand extends Command {
     /**
      * The direction of the command.
      */

package/src/restrictededitingmodenavigationcommand.js

@@ -6,7 +6,7 @@ import { Command } from 'ckeditor5/src/core.js';
 /**
  * The command that allows navigation across the exceptions in the edited document.
  */
-export default class RestrictedEditingModeNavigationCommand extends Command {
+export class RestrictedEditingModeNavigationCommand extends Command {
     /**
      * The direction of the command.
      */

package/src/restrictededitingmodeui.d.ts

@@ -12,7 +12,7 @@ import { Plugin } from 'ckeditor5/src/core.js';
  * It introduces the `'restrictedEditing'` dropdown that offers tools to navigate between exceptions across
  * the document.
  */
-export default class RestrictedEditingModeUI extends Plugin {
+export declare class RestrictedEditingModeUI extends Plugin {
     /**
      * @inheritDoc
      */

package/src/restrictededitingmodeui.js

@@ -7,7 +7,7 @@
  */
 import { Plugin } from 'ckeditor5/src/core.js';
 import { IconContentLock } from 'ckeditor5/src/icons.js';
-import { ViewModel, createDropdown, addListToDropdown, MenuBarMenuListItemButtonView, MenuBarMenuView, MenuBarMenuListView, MenuBarMenuListItemView } from 'ckeditor5/src/ui.js';
+import { UIModel, createDropdown, addListToDropdown, MenuBarMenuListItemButtonView, MenuBarMenuView, MenuBarMenuListView, MenuBarMenuListItemView } from 'ckeditor5/src/ui.js';
 import { Collection } from 'ckeditor5/src/utils.js';
 /**
  * The restricted editing mode UI feature.
@@ -15,7 +15,7 @@ import { Collection } from 'ckeditor5/src/utils.js';
  * It introduces the `'restrictedEditing'` dropdown that offers tools to navigate between exceptions across
  * the document.
  */
-export default class RestrictedEditingModeUI extends Plugin {
+export class RestrictedEditingModeUI extends Plugin {
     /**
      * @inheritDoc
      */
@@ -112,7 +112,7 @@ export default class RestrictedEditingModeUI extends Plugin {
         const command = editor.commands.get(commandName);
         const definition = {
             type: 'button',
-            model: new ViewModel({
+            model: new UIModel({
                 label,
                 withText: true,
                 keystroke,

package/src/standardeditingmode.d.ts

@@ -6,8 +6,8 @@
  * @module restricted-editing/standardeditingmode
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import StandardEditingModeEditing from './standardeditingmodeediting.js';
-import StandardEditingModeUI from './standardeditingmodeui.js';
+import { StandardEditingModeEditing } from './standardeditingmodeediting.js';
+import { StandardEditingModeUI } from './standardeditingmodeui.js';
 import '../theme/restrictedediting.css';
 /**
  * The standard editing mode plugin.
@@ -17,7 +17,7 @@ import '../theme/restrictedediting.css';
  * * 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 {
+export declare class StandardEditingMode extends Plugin {
     /**
      * @inheritDoc
      */

package/src/standardeditingmode.js

@@ -6,8 +6,8 @@
  * @module restricted-editing/standardeditingmode
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import StandardEditingModeEditing from './standardeditingmodeediting.js';
-import StandardEditingModeUI from './standardeditingmodeui.js';
+import { StandardEditingModeEditing } from './standardeditingmodeediting.js';
+import { StandardEditingModeUI } from './standardeditingmodeui.js';
 import '../theme/restrictedediting.css';
 /**
  * The standard editing mode plugin.
@@ -17,7 +17,7 @@ import '../theme/restrictedediting.css';
  * * 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 {
+export class StandardEditingMode extends Plugin {
     /**
      * @inheritDoc
      */

package/src/standardeditingmodeediting.d.ts

@@ -13,7 +13,7 @@ import { Plugin } from 'ckeditor5/src/core.js';
  * a `<span>` element with the `restricted-editing-exception` CSS class.
  * * It registers the `'restrictedEditingException'` command.
  */
-export default class StandardEditingModeEditing extends Plugin {
+export declare class StandardEditingModeEditing extends Plugin {
     /**
      * @inheritDoc
      */

package/src/standardeditingmodeediting.js

@@ -6,7 +6,7 @@
  * @module restricted-editing/standardeditingmodeediting
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import RestrictedEditingExceptionCommand from './restrictededitingexceptioncommand.js';
+import { RestrictedEditingExceptionCommand } from './restrictededitingexceptioncommand.js';
 /**
  * The standard editing mode editing feature.
  *
@@ -14,7 +14,7 @@ import RestrictedEditingExceptionCommand from './restrictededitingexceptioncomma
  * a `<span>` element with the `restricted-editing-exception` CSS class.
  * * It registers the `'restrictedEditingException'` command.
  */
-export default class StandardEditingModeEditing extends Plugin {
+export class StandardEditingModeEditing extends Plugin {
     /**
      * @inheritDoc
      */

package/src/standardeditingmodeui.d.ts

@@ -11,7 +11,7 @@ import { Plugin } from 'ckeditor5/src/core.js';
  *
  * It introduces the `'restrictedEditingException'` button that marks text as unrestricted for editing.
  */
-export default class StandardEditingModeUI extends Plugin {
+export declare class StandardEditingModeUI extends Plugin {
     /**
      * @inheritDoc
      */

package/src/standardeditingmodeui.js

@@ -13,7 +13,7 @@ import { ButtonView, MenuBarMenuListItemButtonView } from 'ckeditor5/src/ui.js';
  *
  * It introduces the `'restrictedEditingException'` button that marks text as unrestricted for editing.
  */
-export default class StandardEditingModeUI extends Plugin {
+export class StandardEditingModeUI extends Plugin {
     /**
      * @inheritDoc
      */