@ckeditor/ckeditor5-engine 48.8.1-alpha.4 → 49.0.0-alpha.0

package/dist/view/observer/compositionobserver.d.ts

@@ -1,82 +1,82 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module engine/view/observer/compositionobserver
- */
-import { DomEventObserver } from './domeventobserver.js';
-import { type EditingView } from '../view.js';
-import { type ViewDocumentDomEventData } from './domeventdata.js';
+* @module engine/view/observer/compositionobserver
+*/
+import { DomEventObserver } from "./domeventobserver.js";
+import { type EditingView } from "../view.js";
+import { type ViewDocumentDomEventData } from "./domeventdata.js";
 /**
- * {@link module:engine/view/document~ViewDocument#event:compositionstart Compositionstart},
- * {@link module:engine/view/document~ViewDocument#event:compositionupdate compositionupdate} and
- * {@link module:engine/view/document~ViewDocument#event:compositionend compositionend} events observer.
- *
- * Note that this observer is attached by the {@link module:engine/view/view~EditingView} and is available by default.
- */
-export declare class CompositionObserver extends DomEventObserver<'compositionstart' | 'compositionupdate' | 'compositionend'> {
-    /**
-     * @inheritDoc
-     */
-    readonly domEventType: readonly ["compositionstart", "compositionupdate", "compositionend"];
-    /**
-     * @inheritDoc
-     */
-    constructor(view: EditingView);
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: CompositionEvent): void;
+* {@link module:engine/view/document~ViewDocument#event:compositionstart Compositionstart},
+* {@link module:engine/view/document~ViewDocument#event:compositionupdate compositionupdate} and
+* {@link module:engine/view/document~ViewDocument#event:compositionend compositionend} events observer.
+*
+* Note that this observer is attached by the {@link module:engine/view/view~EditingView} and is available by default.
+*/
+export declare class CompositionObserver extends DomEventObserver<"compositionstart" | "compositionupdate" | "compositionend"> {
+	/**
+	* @inheritDoc
+	*/
+	readonly domEventType: readonly ["compositionstart", "compositionupdate", "compositionend"];
+	/**
+	* @inheritDoc
+	*/
+	constructor(view: EditingView);
+	/**
+	* @inheritDoc
+	*/
+	onDomEvent(domEvent: CompositionEvent): void;
 }
 export interface ViewDocumentCompositionEventData extends ViewDocumentDomEventData<CompositionEvent> {
-    data: string | null;
+	data: string | null;
 }
 /**
- * Fired when composition starts inside one of the editables.
- *
- * Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
- *
- * Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
- * {@link module:engine/view/view~EditingView} this event is available by default.
- *
- * @see module:engine/view/observer/compositionobserver~CompositionObserver
- * @eventName module:engine/view/document~ViewDocument#compositionstart
- * @param data Event data.
- */
+* Fired when composition starts inside one of the editables.
+*
+* Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
+*
+* Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
+* {@link module:engine/view/view~EditingView} this event is available by default.
+*
+* @see module:engine/view/observer/compositionobserver~CompositionObserver
+* @eventName module:engine/view/document~ViewDocument#compositionstart
+* @param data Event data.
+*/
 export type ViewDocumentCompositionStartEvent = {
-    name: 'compositionstart';
-    args: [data: ViewDocumentCompositionEventData];
+	name: "compositionstart";
+	args: [data: ViewDocumentCompositionEventData];
 };
 /**
- * Fired when composition is updated inside one of the editables.
- *
- * Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
- *
- * Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
- * {@link module:engine/view/view~EditingView} this event is available by default.
- *
- * @see module:engine/view/observer/compositionobserver~CompositionObserver
- * @eventName module:engine/view/document~ViewDocument#compositionupdate
- * @param data Event data.
- */
+* Fired when composition is updated inside one of the editables.
+*
+* Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
+*
+* Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
+* {@link module:engine/view/view~EditingView} this event is available by default.
+*
+* @see module:engine/view/observer/compositionobserver~CompositionObserver
+* @eventName module:engine/view/document~ViewDocument#compositionupdate
+* @param data Event data.
+*/
 export type ViewDocumentCompositionUpdateEvent = {
-    name: 'compositionupdate';
-    args: [data: ViewDocumentCompositionEventData];
+	name: "compositionupdate";
+	args: [data: ViewDocumentCompositionEventData];
 };
 /**
- * Fired when composition ends inside one of the editables.
- *
- * Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
- *
- * Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
- * {@link module:engine/view/view~EditingView} this event is available by default.
- *
- * @see module:engine/view/observer/compositionobserver~CompositionObserver
- * @eventName module:engine/view/document~ViewDocument#compositionend
- * @param data Event data.
- */
+* Fired when composition ends inside one of the editables.
+*
+* Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
+*
+* Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
+* {@link module:engine/view/view~EditingView} this event is available by default.
+*
+* @see module:engine/view/observer/compositionobserver~CompositionObserver
+* @eventName module:engine/view/document~ViewDocument#compositionend
+* @param data Event data.
+*/
 export type ViewDocumentCompositionEndEvent = {
-    name: 'compositionend';
-    args: [data: ViewDocumentCompositionEventData];
+	name: "compositionend";
+	args: [data: ViewDocumentCompositionEventData];
 };

package/dist/view/observer/domeventdata.d.ts

@@ -1,50 +1,50 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { type ViewDocument } from '../document.js';
-import { type ViewElement } from '../element.js';
-import { type EditingView } from '../view.js';
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import { type ViewDocument } from "../document.js";
+import { type ViewElement } from "../element.js";
+import { type EditingView } from "../view.js";
 /**
- * Information about a DOM event in context of the {@link module:engine/view/document~ViewDocument}.
- * It wraps the native event, which usually should not be used as the wrapper contains
- * additional data (like key code for keyboard events).
- *
- * @typeParam TEvent The type of DOM Event that this class represents.
- */
+* Information about a DOM event in context of the {@link module:engine/view/document~ViewDocument}.
+* It wraps the native event, which usually should not be used as the wrapper contains
+* additional data (like key code for keyboard events).
+*
+* @typeParam TEvent The type of DOM Event that this class represents.
+*/
 export declare class ViewDocumentDomEventData<TEvent extends Event = Event> {
-    /**
-     * Instance of the view controller.
-     */
-    readonly view: EditingView;
-    /**
-     * The instance of the document.
-     */
-    readonly document: ViewDocument;
-    /**
-     * The DOM event.
-     */
-    readonly domEvent: TEvent;
-    /**
-     * The DOM target.
-     */
-    readonly domTarget: HTMLElement;
-    /**
-     * @param view The instance of the view controller.
-     * @param domEvent The DOM event.
-     * @param additionalData Additional properties that the instance should contain.
-     */
-    constructor(view: EditingView, domEvent: TEvent, additionalData?: object);
-    /**
-     * The tree view element representing the target.
-     */
-    get target(): ViewElement;
-    /**
-     * Prevents the native's event default action.
-     */
-    preventDefault(): void;
-    /**
-     * Stops native event propagation.
-     */
-    stopPropagation(): void;
+	/**
+	* Instance of the view controller.
+	*/
+	readonly view: EditingView;
+	/**
+	* The instance of the document.
+	*/
+	readonly document: ViewDocument;
+	/**
+	* The DOM event.
+	*/
+	readonly domEvent: TEvent;
+	/**
+	* The DOM target.
+	*/
+	readonly domTarget: HTMLElement;
+	/**
+	* @param view The instance of the view controller.
+	* @param domEvent The DOM event.
+	* @param additionalData Additional properties that the instance should contain.
+	*/
+	constructor(view: EditingView, domEvent: TEvent, additionalData?: object);
+	/**
+	* The tree view element representing the target.
+	*/
+	get target(): ViewElement;
+	/**
+	* Prevents the native's event default action.
+	*/
+	preventDefault(): void;
+	/**
+	* Stops native event propagation.
+	*/
+	stopPropagation(): void;
 }

package/dist/view/observer/domeventobserver.d.ts

@@ -1,78 +1,81 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module engine/view/observer/domeventobserver
- */
-import { Observer } from './observer.js';
-import type { EventInfo } from '@ckeditor/ckeditor5-utils';
+* @module engine/view/observer/domeventobserver
+*/
+import { Observer } from "./observer.js";
+import type { EventInfo } from "@ckeditor/ckeditor5-utils";
 /**
- * Base class for DOM event observers. This class handles
- * {@link module:engine/view/observer/observer~Observer#observe adding} listeners to DOM elements,
- * {@link module:engine/view/observer/observer~Observer#disable disabling} and
- * {@link module:engine/view/observer/observer~Observer#enable re-enabling} events.
- * Child class needs to define
- * {@link module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type} and
- * {@link module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback}.
- *
- * For instance:
- *
- * ```ts
- * class ClickObserver extends DomEventObserver<'click'> {
- * 	// It can also be defined as a normal property in the constructor.
- * 	get domEventType(): 'click' {
- * 		return 'click';
- * 	}
- *
- * 	onDomEvent( domEvent: MouseEvent ): void {
- * 		this.fire( 'click', domEvent );
- * 	}
- * }
- * ```
- *
- * @typeParam EventType DOM Event type name or an union of those.
- * @typeParam AdditionalData Additional data passed along with the event.
- */
-export declare abstract class DomEventObserver<EventType extends keyof HTMLElementEventMap, AdditionalData extends object = object> extends Observer {
-    /**
-     * Type of the DOM event the observer should listen to. Array of types can be defined
-     * if the observer should listen to multiple DOM events.
-     */
-    abstract get domEventType(): EventType | ReadonlyArray<EventType>;
-    /**
-     * If set to `true` DOM events will be listened on the capturing phase.
-     * Default value is `false`.
-     */
-    useCapture: boolean;
-    /**
-     * If set to `true`, indicates that the function specified by listener will never call `preventDefault()`.
-     * Default value is `false`.
-     */
-    usePassive: boolean;
-    /**
-     * Callback which should be called when the DOM event occurred. Note that the callback will not be called if
-     * observer {@link #isEnabled is not enabled}.
-     *
-     * @see #domEventType
-     */
-    abstract onDomEvent(event: HTMLElementEventMap[EventType]): void;
-    /**
-     * @inheritDoc
-     */
-    observe(domElement: HTMLElement): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(domElement: HTMLElement): void;
-    /**
-     * Calls `Document#fire()` if observer {@link #isEnabled is enabled}.
-     *
-     * @see module:utils/emittermixin~Emitter#fire
-     * @param eventType The event type (name).
-     * @param domEvent The DOM event.
-     * @param additionalData The additional data which should extend the
-     * {@link module:engine/view/observer/domeventdata~ViewDocumentDomEventData event data} object.
-     */
-    fire(eventType: string | EventInfo, domEvent: Event, additionalData?: AdditionalData): void;
+* Base class for DOM event observers. This class handles
+* {@link module:engine/view/observer/observer~Observer#observe adding} listeners to DOM elements,
+* {@link module:engine/view/observer/observer~Observer#disable disabling} and
+* {@link module:engine/view/observer/observer~Observer#enable re-enabling} events.
+* Child class needs to define
+* {@link module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type} and
+* {@link module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback}.
+*
+* For instance:
+*
+* ```ts
+* class ClickObserver extends DomEventObserver<'click'> {
+* 	// It can also be defined as a normal property in the constructor.
+* 	get domEventType(): 'click' {
+* 		return 'click';
+* 	}
+*
+* 	onDomEvent( domEvent: MouseEvent ): void {
+* 		this.fire( 'click', domEvent );
+* 	}
+* }
+* ```
+*
+* @typeParam EventType DOM Event type name or an union of those.
+* @typeParam AdditionalData Additional data passed along with the event.
+*/
+export declare abstract class DomEventObserver<
+	EventType extends keyof HTMLElementEventMap,
+	AdditionalData extends object = object
+> extends Observer {
+	/**
+	* Type of the DOM event the observer should listen to. Array of types can be defined
+	* if the observer should listen to multiple DOM events.
+	*/
+	abstract get domEventType(): EventType | ReadonlyArray<EventType>;
+	/**
+	* If set to `true` DOM events will be listened on the capturing phase.
+	* Default value is `false`.
+	*/
+	useCapture: boolean;
+	/**
+	* If set to `true`, indicates that the function specified by listener will never call `preventDefault()`.
+	* Default value is `false`.
+	*/
+	usePassive: boolean;
+	/**
+	* Callback which should be called when the DOM event occurred. Note that the callback will not be called if
+	* observer {@link #isEnabled is not enabled}.
+	*
+	* @see #domEventType
+	*/
+	abstract onDomEvent(event: HTMLElementEventMap[EventType]): void;
+	/**
+	* @inheritDoc
+	*/
+	override observe(domElement: HTMLElement): void;
+	/**
+	* @inheritDoc
+	*/
+	override stopObserving(domElement: HTMLElement): void;
+	/**
+	* Calls `Document#fire()` if observer {@link #isEnabled is enabled}.
+	*
+	* @see module:utils/emittermixin~Emitter#fire
+	* @param eventType The event type (name).
+	* @param domEvent The DOM event.
+	* @param additionalData The additional data which should extend the
+	* {@link module:engine/view/observer/domeventdata~ViewDocumentDomEventData event data} object.
+	*/
+	override fire(eventType: string | EventInfo, domEvent: Event, additionalData?: AdditionalData): void;
 }

package/dist/view/observer/fakeselectionobserver.d.ts

@@ -1,47 +1,47 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module engine/view/observer/fakeselectionobserver
- */
-import { Observer } from './observer.js';
-import { type EditingView } from '../view.js';
+* @module engine/view/observer/fakeselectionobserver
+*/
+import { Observer } from "./observer.js";
+import { type EditingView } from "../view.js";
 /**
- * Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
- * on {@link module:engine/view/document~ViewDocument#event:keydown keydown} events and handles moving
- * fake view selection to the correct place if arrow keys are pressed.
- * Fires {@link module:engine/view/document~ViewDocument#event:selectionChange selectionChange event} simulating natural behaviour of
- * {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
- */
+* Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
+* on {@link module:engine/view/document~ViewDocument#event:keydown keydown} events and handles moving
+* fake view selection to the correct place if arrow keys are pressed.
+* Fires {@link module:engine/view/document~ViewDocument#event:selectionChange selectionChange event} simulating natural behaviour of
+* {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
+*/
 export declare class FakeSelectionObserver extends Observer {
-    /**
-     * Fires debounced event `selectionChangeDone`. It uses `es-toolkit#debounce` method to delay function call.
-     */
-    private readonly _fireSelectionChangeDoneDebounced;
-    /**
-     * Creates new FakeSelectionObserver instance.
-     */
-    constructor(view: EditingView);
-    /**
-     * @inheritDoc
-     */
-    observe(): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
-     * collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
-     *
-     * This method fires {@link module:engine/view/document~ViewDocument#event:selectionChange} and
-     * {@link module:engine/view/document~ViewDocument#event:selectionChangeDone} events imitating behaviour of
-     * {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
-     */
-    private _handleSelectionMove;
+	/**
+	* Fires debounced event `selectionChangeDone`. It uses `es-toolkit#debounce` method to delay function call.
+	*/
+	private readonly _fireSelectionChangeDoneDebounced;
+	/**
+	* Creates new FakeSelectionObserver instance.
+	*/
+	constructor(view: EditingView);
+	/**
+	* @inheritDoc
+	*/
+	override observe(): void;
+	/**
+	* @inheritDoc
+	*/
+	override stopObserving(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
+	* collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
+	*
+	* This method fires {@link module:engine/view/document~ViewDocument#event:selectionChange} and
+	* {@link module:engine/view/document~ViewDocument#event:selectionChangeDone} events imitating behaviour of
+	* {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
+	*/
+	private _handleSelectionMove;
 }