@ckeditor/ckeditor5-typing 45.2.1 → 46.0.0-alpha.1

package/src/twostepcaretmovement.d.ts

@@ -6,7 +6,7 @@
  * @module typing/twostepcaretmovement
  */
 import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { type DomEventData } from '@ckeditor/ckeditor5-engine';
+import { type ViewDocumentDomEventData } from '@ckeditor/ckeditor5-engine';
 /**
  * This plugin enables the two-step caret (phantom) movement behavior for
  * {@link module:typing/twostepcaretmovement~TwoStepCaretMovement#registerAttribute registered attributes}
@@ -130,20 +130,20 @@ import { type DomEventData } from '@ckeditor/ckeditor5-engine';
  * ```
  *
  */
-export default class TwoStepCaretMovement extends Plugin {
+export declare class TwoStepCaretMovement extends Plugin {
     /**
      * A set of attributes to handle.
      */
     private attributes;
     /**
      * The current UID of the overridden gravity, as returned by
-     * {@link module:engine/model/writer~Writer#overrideSelectionGravity}.
+     * {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
      */
     private _overrideUid;
     /**
      * A flag indicating that the automatic gravity restoration should not happen upon the next
      * gravity restoration.
-     * {@link module:engine/model/selection~Selection#event:change:range} event.
+     * {@link module:engine/model/selection~ModelSelection#event:change:range} event.
      */
     private _isNextGravityRestorationSkipped;
     /**
@@ -170,25 +170,25 @@ export default class TwoStepCaretMovement extends Plugin {
     registerAttribute(attribute: string): void;
     /**
      * Updates the document selection and the view according to the two–step caret movement state
-     * when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~View}.
+     * when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
      *
      * @internal
      * @param eventData Data of the key press.
      * @returns `true` when the handler prevented caret movement.
      */
-    _handleForwardMovement(eventData?: DomEventData): boolean;
+    _handleForwardMovement(eventData?: ViewDocumentDomEventData): boolean;
     /**
      * Updates the document selection and the view according to the two–step caret movement state
-     * when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~View}.
+     * when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
      *
      * @internal
      * @param eventData Data of the key press.
      * @returns `true` when the handler prevented caret movement
      */
-    _handleBackwardMovement(eventData?: DomEventData): boolean;
+    _handleBackwardMovement(eventData?: ViewDocumentDomEventData): boolean;
     /**
-     * Starts listening to {@link module:engine/view/document~Document#event:mousedown} and
-     * {@link module:engine/view/document~Document#event:selectionChange} and puts the selection before/after a 2-step node
+     * Starts listening to {@link module:engine/view/document~ViewDocument#event:mousedown} and
+     * {@link module:engine/view/document~ViewDocument#event:selectionChange} and puts the selection before/after a 2-step node
      * if clicked at the beginning/ending of the 2-step node.
      *
      * The purpose of this action is to allow typing around the 2-step node directly after a click.
@@ -224,16 +224,16 @@ export default class TwoStepCaretMovement extends Plugin {
      */
     private get _isGravityOverridden();
     /**
-     * Overrides the gravity using the {@link module:engine/model/writer~Writer model writer}
+     * Overrides the gravity using the {@link module:engine/model/writer~ModelWriter model writer}
      * and stores the information about this fact in the {@link #_overrideUid}.
      *
-     * A shorthand for {@link module:engine/model/writer~Writer#overrideSelectionGravity}.
+     * A shorthand for {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
      */
     private _overrideGravity;
     /**
-     * Restores the gravity using the {@link module:engine/model/writer~Writer model writer}.
+     * Restores the gravity using the {@link module:engine/model/writer~ModelWriter model writer}.
      *
-     * A shorthand for {@link module:engine/model/writer~Writer#restoreSelectionGravity}.
+     * A shorthand for {@link module:engine/model/writer~ModelWriter#restoreSelectionGravity}.
      */
     private _restoreGravity;
 }

package/src/twostepcaretmovement.js

@@ -131,20 +131,20 @@ import { MouseObserver, TouchObserver } from '@ckeditor/ckeditor5-engine';
  * ```
  *
  */
-export default class TwoStepCaretMovement extends Plugin {
+export class TwoStepCaretMovement extends Plugin {
     /**
      * A set of attributes to handle.
      */
     attributes;
     /**
      * The current UID of the overridden gravity, as returned by
-     * {@link module:engine/model/writer~Writer#overrideSelectionGravity}.
+     * {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
      */
     _overrideUid;
     /**
      * A flag indicating that the automatic gravity restoration should not happen upon the next
      * gravity restoration.
-     * {@link module:engine/model/selection~Selection#event:change:range} event.
+     * {@link module:engine/model/selection~ModelSelection#event:change:range} event.
      */
     _isNextGravityRestorationSkipped = false;
     /**
@@ -246,7 +246,7 @@ export default class TwoStepCaretMovement extends Plugin {
     }
     /**
      * Updates the document selection and the view according to the two–step caret movement state
-     * when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~View}.
+     * when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
      *
      * @internal
      * @param eventData Data of the key press.
@@ -308,7 +308,7 @@ export default class TwoStepCaretMovement extends Plugin {
     }
     /**
      * Updates the document selection and the view according to the two–step caret movement state
-     * when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~View}.
+     * when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
      *
      * @internal
      * @param eventData Data of the key press.
@@ -411,8 +411,8 @@ export default class TwoStepCaretMovement extends Plugin {
         return false;
     }
     /**
-     * Starts listening to {@link module:engine/view/document~Document#event:mousedown} and
-     * {@link module:engine/view/document~Document#event:selectionChange} and puts the selection before/after a 2-step node
+     * Starts listening to {@link module:engine/view/document~ViewDocument#event:mousedown} and
+     * {@link module:engine/view/document~ViewDocument#event:selectionChange} and puts the selection before/after a 2-step node
      * if clicked at the beginning/ending of the 2-step node.
      *
      * The purpose of this action is to allow typing around the 2-step node directly after a click.
@@ -562,10 +562,10 @@ export default class TwoStepCaretMovement extends Plugin {
         return !!this._overrideUid;
     }
     /**
-     * Overrides the gravity using the {@link module:engine/model/writer~Writer model writer}
+     * Overrides the gravity using the {@link module:engine/model/writer~ModelWriter model writer}
      * and stores the information about this fact in the {@link #_overrideUid}.
      *
-     * A shorthand for {@link module:engine/model/writer~Writer#overrideSelectionGravity}.
+     * A shorthand for {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
      */
     _overrideGravity() {
         this._overrideUid = this.editor.model.change(writer => {
@@ -573,9 +573,9 @@ export default class TwoStepCaretMovement extends Plugin {
         });
     }
     /**
-     * Restores the gravity using the {@link module:engine/model/writer~Writer model writer}.
+     * Restores the gravity using the {@link module:engine/model/writer~ModelWriter model writer}.
      *
-     * A shorthand for {@link module:engine/model/writer~Writer#restoreSelectionGravity}.
+     * A shorthand for {@link module:engine/model/writer~ModelWriter#restoreSelectionGravity}.
      */
     _restoreGravity() {
         this.editor.model.change(writer => {
@@ -598,7 +598,7 @@ function hasAnyAttribute(selection, attributes) {
 /**
  * Applies the given attributes to the current selection using using the
  * values from the node before the current position. Uses
- * the {@link module:engine/model/writer~Writer model writer}.
+ * the {@link module:engine/model/writer~ModelWriter model writer}.
  */
 function setSelectionAttributesFromTheNodeBefore(model, attributes, position) {
     const nodeBefore = position.nodeBefore;

package/src/typing.d.ts

@@ -6,15 +6,15 @@
  * @module typing/typing
  */
 import { Plugin } from '@ckeditor/ckeditor5-core';
-import Input from './input.js';
-import Delete from './delete.js';
+import { Input } from './input.js';
+import { Delete } from './delete.js';
 /**
  * The typing feature. It handles typing.
  *
  * This is a "glue" plugin which loads the {@link module:typing/input~Input} and {@link module:typing/delete~Delete}
  * plugins.
  */
-export default class Typing extends Plugin {
+export declare class Typing extends Plugin {
     static get requires(): readonly [typeof Input, typeof Delete];
     /**
      * @inheritDoc

package/src/typing.js

@@ -6,15 +6,15 @@
  * @module typing/typing
  */
 import { Plugin } from '@ckeditor/ckeditor5-core';
-import Input from './input.js';
-import Delete from './delete.js';
+import { Input } from './input.js';
+import { Delete } from './delete.js';
 /**
  * The typing feature. It handles typing.
  *
  * This is a "glue" plugin which loads the {@link module:typing/input~Input} and {@link module:typing/delete~Delete}
  * plugins.
  */
-export default class Typing extends Plugin {
+export class Typing extends Plugin {
     static get requires() {
         return [Input, Delete];
     }

package/src/typingconfig.d.ts

@@ -117,7 +117,7 @@ export interface TextTransformationConfig {
      * ({@link module:typing/typingconfig~TextTransformationConfig#extra `transformations.extra`},
      * {@link module:typing/typingconfig~TextTransformationConfig#remove `transformations.remove`}) to fine-tune the default list.
      */
-    include: Array<TextTransformationDescription | string>;
+    include: Array<TextTypingTransformationDescription | string>;
     /**
      * Additional text transformations that are added to the transformations defined in
      * {@link module:typing/typingconfig~TextTransformationConfig#include `transformations.include`}.
@@ -130,7 +130,7 @@ export interface TextTransformationConfig {
      * };
      * ```
      */
-    extra?: Array<TextTransformationDescription | string>;
+    extra?: Array<TextTypingTransformationDescription | string>;
     /**
      * The text transformation names that are removed from transformations defined in
      * {@link module:typing/typingconfig~TextTransformationConfig#include `transformations.include`} or
@@ -145,7 +145,7 @@ export interface TextTransformationConfig {
      * }
      * ```
      */
-    remove?: Array<TextTransformationDescription | string>;
+    remove?: Array<TextTypingTransformationDescription | string>;
 }
 /**
  * The text transformation definition object. It describes what should be replaced with what.
@@ -192,7 +192,7 @@ export interface TextTransformationConfig {
  * }
  * ```
  */
-export interface TextTransformationDescription {
+export interface TextTypingTransformationDescription {
     /**
      * The string or regular expression to transform.
      */

package/src/utils/changebuffer.d.ts

@@ -13,7 +13,7 @@ import type { Model, Batch } from '@ckeditor/ckeditor5-engine';
  * Batches represent single undo steps, hence changes added to one single batch are undone together.
  *
  * The buffer has a configurable limit of atomic changes that it can accommodate. After the limit was
- * exceeded (see {@link ~ChangeBuffer#input}), a new batch is created in {@link ~ChangeBuffer#batch}.
+ * exceeded (see {@link ~TypingChangeBuffer#input}), a new batch is created in {@link ~TypingChangeBuffer#batch}.
  *
  * To use the change buffer you need to let it know about the number of changes that were added to the batch:
  *
@@ -25,7 +25,7 @@ import type { Model, Batch } from '@ckeditor/ckeditor5-engine';
  * buffer.input( insertedCharacters.length );
  * ```
  */
-export default class ChangeBuffer {
+export declare class TypingChangeBuffer {
     /**
      * The model instance.
      */

package/src/utils/changebuffer.js

@@ -9,7 +9,7 @@
  * Batches represent single undo steps, hence changes added to one single batch are undone together.
  *
  * The buffer has a configurable limit of atomic changes that it can accommodate. After the limit was
- * exceeded (see {@link ~ChangeBuffer#input}), a new batch is created in {@link ~ChangeBuffer#batch}.
+ * exceeded (see {@link ~TypingChangeBuffer#input}), a new batch is created in {@link ~TypingChangeBuffer#batch}.
  *
  * To use the change buffer you need to let it know about the number of changes that were added to the batch:
  *
@@ -21,7 +21,7 @@
  * buffer.input( insertedCharacters.length );
  * ```
  */
-export default class ChangeBuffer {
+export class TypingChangeBuffer {
     /**
      * The model instance.
      */

package/src/utils/findattributerange.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module typing/utils/findattributerange
  */
-import type { Position, Model, Range } from '@ckeditor/ckeditor5-engine';
+import type { ModelPosition, Model, ModelRange } from '@ckeditor/ckeditor5-engine';
 /**
  * Returns a model range that covers all consecutive nodes with the same `attributeName` and its `value`
  * that intersect the given `position`.
@@ -19,7 +19,7 @@ import type { Position, Model, Range } from '@ckeditor/ckeditor5-engine';
  * @param model The model instance.
  * @returns The link range.
  */
-export default function findAttributeRange(position: Position, attributeName: string, value: unknown, model: Model): Range;
+export declare function findAttributeRange(position: ModelPosition, attributeName: string, value: unknown, model: Model): ModelRange;
 /**
  * Walks forward or backward (depends on the `lookBack` flag), node by node, as long as they have the same attribute value
  * and returns a position just before or after (depends on the `lookBack` flag) the last matched node.
@@ -30,4 +30,4 @@ export default function findAttributeRange(position: Position, attributeName: st
  * @param lookBack Whether the walk direction is forward (`false`) or backward (`true`).
  * @returns The position just before the last matched node.
  */
-export declare function findAttributeRangeBound(position: Position, attributeName: string, value: unknown, lookBack: boolean, model: Model): Position;
+export declare function findAttributeRangeBound(position: ModelPosition, attributeName: string, value: unknown, lookBack: boolean, model: Model): ModelPosition;

package/src/utils/findattributerange.js

@@ -15,7 +15,7 @@
  * @param model The model instance.
  * @returns The link range.
  */
-export default function findAttributeRange(position, attributeName, value, model) {
+export function findAttributeRange(position, attributeName, value, model) {
     return model.createRange(findAttributeRangeBound(position, attributeName, value, true, model), findAttributeRangeBound(position, attributeName, value, false, model));
 }
 /**

package/src/utils/getlasttextline.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module typing/utils/getlasttextline
  */
-import type { Model, Range } from '@ckeditor/ckeditor5-engine';
+import type { Model, ModelRange } from '@ckeditor/ckeditor5-engine';
 /**
  * Returns the last text line from the given range.
  *
@@ -33,7 +33,7 @@ import type { Model, Range } from '@ckeditor/ckeditor5-engine';
  * <paragraph>Foo<softBreak></softBreak>bar<softBreak></softBreak>baz<paragraph>
  * ```
  */
-export default function getLastTextLine(range: Range, model: Model): LastTextLineData;
+export declare function getLastTextLine(range: ModelRange, model: Model): LastTextLineData;
 /**
  * The value returned by {@link module:typing/utils/getlasttextline~getLastTextLine}.
  */
@@ -45,5 +45,5 @@ export type LastTextLineData = {
     /**
      * The range set on the text nodes in the last text line.
      */
-    range: Range;
+    range: ModelRange;
 };

package/src/utils/getlasttextline.js

@@ -29,7 +29,7 @@
  * <paragraph>Foo<softBreak></softBreak>bar<softBreak></softBreak>baz<paragraph>
  * ```
  */
-export default function getLastTextLine(range, model) {
+export function getLastTextLine(range, model) {
     let start = range.start;
     const text = Array.from(range.getWalker({ ignoreElementEnd: false })).reduce((rangeText, { item }) => {
         // Trim text to a last occurrence of an inline element and update range start.

package/src/utils/inlinehighlight.d.ts

@@ -18,7 +18,7 @@ import type { Editor } from '@ckeditor/ckeditor5-core';
  * Usage:
  *
  * ```ts
- * import inlineHighlight from '@ckeditor/ckeditor5-typing/src/utils/inlinehighlight';
+ * import { inlineHighlight } from '@ckeditor/ckeditor5-typing/src/utils/inlinehighlight';
  *
  * // Make `ck-link_selected` class be applied on an `a` element
  * // whenever the corresponding `linkHref` attribute element is selected.
@@ -30,4 +30,4 @@ import type { Editor } from '@ckeditor/ckeditor5-core';
  * @param tagName The tagName of a view item.
  * @param className The class name to apply in the view.
  */
-export default function inlineHighlight(editor: Editor, attributeName: string, tagName: string, className: string): void;
+export declare function inlineHighlight(editor: Editor, attributeName: string, tagName: string, className: string): void;

package/src/utils/inlinehighlight.js

@@ -5,7 +5,7 @@
 /**
  * @module typing/utils/inlinehighlight
  */
-import findAttributeRange from './findattributerange.js';
+import { findAttributeRange } from './findattributerange.js';
 /**
  * Adds a visual highlight style to an attribute element in which the selection is anchored.
  * Together with two-step caret movement, they indicate that the user is typing inside the element.
@@ -21,7 +21,7 @@ import findAttributeRange from './findattributerange.js';
  * Usage:
  *
  * ```ts
- * import inlineHighlight from '@ckeditor/ckeditor5-typing/src/utils/inlinehighlight';
+ * import { inlineHighlight } from '@ckeditor/ckeditor5-typing/src/utils/inlinehighlight';
  *
  * // Make `ck-link_selected` class be applied on an `a` element
  * // whenever the corresponding `linkHref` attribute element is selected.
@@ -33,7 +33,7 @@ import findAttributeRange from './findattributerange.js';
  * @param tagName The tagName of a view item.
  * @param className The class name to apply in the view.
  */
-export default function inlineHighlight(editor, attributeName, tagName, className) {
+export function inlineHighlight(editor, attributeName, tagName, className) {
     const view = editor.editing.view;
     const highlightedElements = new Set();
     // Adding the class.