@ckeditor/ckeditor5-engine 40.0.0 → 40.2.0

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

@@ -1,82 +1,82 @@
-/**
- * @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 engine/view/observer/compositionobserver
- */
-import DomEventObserver from './domeventobserver';
-import type View from '../view';
-import type DomEventData from './domeventdata';
-/**
- * {@link module:engine/view/document~Document#event:compositionstart Compositionstart},
- * {@link module:engine/view/document~Document#event:compositionupdate compositionupdate} and
- * {@link module:engine/view/document~Document#event:compositionend compositionend} events observer.
- *
- * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
- */
-export default class CompositionObserver extends DomEventObserver<'compositionstart' | 'compositionupdate' | 'compositionend'> {
-    /**
-     * @inheritDoc
-     */
-    readonly domEventType: readonly ["compositionstart", "compositionupdate", "compositionend"];
-    /**
-     * @inheritDoc
-     */
-    constructor(view: View);
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: CompositionEvent): void;
-}
-export interface CompositionEventData extends DomEventData<CompositionEvent> {
-    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~View} this event is available by default.
- *
- * @see module:engine/view/observer/compositionobserver~CompositionObserver
- * @eventName module:engine/view/document~Document#compositionstart
- * @param data Event data.
- */
-export type ViewDocumentCompositionStartEvent = {
-    name: 'compositionstart';
-    args: [data: CompositionEventData];
-};
-/**
- * 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~View} this event is available by default.
- *
- * @see module:engine/view/observer/compositionobserver~CompositionObserver
- * @eventName module:engine/view/document~Document#compositionupdate
- * @param data Event data.
- */
-export type ViewDocumentCompositionUpdateEvent = {
-    name: 'compositionupdate';
-    args: [data: CompositionEventData];
-};
-/**
- * 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~View} this event is available by default.
- *
- * @see module:engine/view/observer/compositionobserver~CompositionObserver
- * @eventName module:engine/view/document~Document#compositionend
- * @param data Event data.
- */
-export type ViewDocumentCompositionEndEvent = {
-    name: 'compositionend';
-    args: [data: CompositionEventData];
-};
+/**
+ * @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 engine/view/observer/compositionobserver
+ */
+import DomEventObserver from './domeventobserver';
+import type View from '../view';
+import type DomEventData from './domeventdata';
+/**
+ * {@link module:engine/view/document~Document#event:compositionstart Compositionstart},
+ * {@link module:engine/view/document~Document#event:compositionupdate compositionupdate} and
+ * {@link module:engine/view/document~Document#event:compositionend compositionend} events observer.
+ *
+ * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
+ */
+export default class CompositionObserver extends DomEventObserver<'compositionstart' | 'compositionupdate' | 'compositionend'> {
+    /**
+     * @inheritDoc
+     */
+    readonly domEventType: readonly ["compositionstart", "compositionupdate", "compositionend"];
+    /**
+     * @inheritDoc
+     */
+    constructor(view: View);
+    /**
+     * @inheritDoc
+     */
+    onDomEvent(domEvent: CompositionEvent): void;
+}
+export interface CompositionEventData extends DomEventData<CompositionEvent> {
+    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~View} this event is available by default.
+ *
+ * @see module:engine/view/observer/compositionobserver~CompositionObserver
+ * @eventName module:engine/view/document~Document#compositionstart
+ * @param data Event data.
+ */
+export type ViewDocumentCompositionStartEvent = {
+    name: 'compositionstart';
+    args: [data: CompositionEventData];
+};
+/**
+ * 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~View} this event is available by default.
+ *
+ * @see module:engine/view/observer/compositionobserver~CompositionObserver
+ * @eventName module:engine/view/document~Document#compositionupdate
+ * @param data Event data.
+ */
+export type ViewDocumentCompositionUpdateEvent = {
+    name: 'compositionupdate';
+    args: [data: CompositionEventData];
+};
+/**
+ * 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~View} this event is available by default.
+ *
+ * @see module:engine/view/observer/compositionobserver~CompositionObserver
+ * @eventName module:engine/view/document~Document#compositionend
+ * @param data Event data.
+ */
+export type ViewDocumentCompositionEndEvent = {
+    name: 'compositionend';
+    args: [data: CompositionEventData];
+};

package/src/view/observer/compositionobserver.js

@@ -1,60 +1,60 @@
-/**
- * @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 engine/view/observer/compositionobserver
- */
-import DomEventObserver from './domeventobserver';
-/**
- * {@link module:engine/view/document~Document#event:compositionstart Compositionstart},
- * {@link module:engine/view/document~Document#event:compositionupdate compositionupdate} and
- * {@link module:engine/view/document~Document#event:compositionend compositionend} events observer.
- *
- * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
- */
-export default class CompositionObserver extends DomEventObserver {
-    /**
-     * @inheritDoc
-     */
-    constructor(view) {
-        super(view);
-        /**
-         * @inheritDoc
-         */
-        this.domEventType = ['compositionstart', 'compositionupdate', 'compositionend'];
-        const document = this.document;
-        document.on('compositionstart', () => {
-            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
-            // @if CK_DEBUG_TYPING // 	console.log( '%c[CompositionObserver] ' +
-            // @if CK_DEBUG_TYPING // 		'┌───────────────────────────── isComposing = true ─────────────────────────────┐',
-            // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green'
-            // @if CK_DEBUG_TYPING // 	);
-            // @if CK_DEBUG_TYPING // }
-            document.isComposing = true;
-        }, { priority: 'low' });
-        document.on('compositionend', () => {
-            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
-            // @if CK_DEBUG_TYPING // 	console.log( '%c[CompositionObserver] ' +
-            // @if CK_DEBUG_TYPING // 		'└───────────────────────────── isComposing = false ─────────────────────────────┘',
-            // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green'
-            // @if CK_DEBUG_TYPING // 	);
-            // @if CK_DEBUG_TYPING // }
-            document.isComposing = false;
-        }, { priority: 'low' });
-    }
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent) {
-        // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
-        // @if CK_DEBUG_TYPING // 	console.group( `%c[CompositionObserver]%c ${ domEvent.type }`, 'color: green', '' );
-        // @if CK_DEBUG_TYPING // }
-        this.fire(domEvent.type, domEvent, {
-            data: domEvent.data
-        });
-        // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
-        // @if CK_DEBUG_TYPING // 	console.groupEnd();
-        // @if CK_DEBUG_TYPING // }
-    }
-}
+/**
+ * @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 engine/view/observer/compositionobserver
+ */
+import DomEventObserver from './domeventobserver';
+/**
+ * {@link module:engine/view/document~Document#event:compositionstart Compositionstart},
+ * {@link module:engine/view/document~Document#event:compositionupdate compositionupdate} and
+ * {@link module:engine/view/document~Document#event:compositionend compositionend} events observer.
+ *
+ * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
+ */
+export default class CompositionObserver extends DomEventObserver {
+    /**
+     * @inheritDoc
+     */
+    constructor(view) {
+        super(view);
+        /**
+         * @inheritDoc
+         */
+        this.domEventType = ['compositionstart', 'compositionupdate', 'compositionend'];
+        const document = this.document;
+        document.on('compositionstart', () => {
+            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
+            // @if CK_DEBUG_TYPING // 	console.log( '%c[CompositionObserver] ' +
+            // @if CK_DEBUG_TYPING // 		'┌───────────────────────────── isComposing = true ─────────────────────────────┐',
+            // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green'
+            // @if CK_DEBUG_TYPING // 	);
+            // @if CK_DEBUG_TYPING // }
+            document.isComposing = true;
+        }, { priority: 'low' });
+        document.on('compositionend', () => {
+            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
+            // @if CK_DEBUG_TYPING // 	console.log( '%c[CompositionObserver] ' +
+            // @if CK_DEBUG_TYPING // 		'└───────────────────────────── isComposing = false ─────────────────────────────┘',
+            // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green'
+            // @if CK_DEBUG_TYPING // 	);
+            // @if CK_DEBUG_TYPING // }
+            document.isComposing = false;
+        }, { priority: 'low' });
+    }
+    /**
+     * @inheritDoc
+     */
+    onDomEvent(domEvent) {
+        // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
+        // @if CK_DEBUG_TYPING // 	console.group( `%c[CompositionObserver]%c ${ domEvent.type }`, 'color: green', '' );
+        // @if CK_DEBUG_TYPING // }
+        this.fire(domEvent.type, domEvent, {
+            data: domEvent.data
+        });
+        // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
+        // @if CK_DEBUG_TYPING // 	console.groupEnd();
+        // @if CK_DEBUG_TYPING // }
+    }
+}

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

@@ -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
- */
-import type Document from '../document';
-import type Element from '../element';
-import type View from '../view';
-/**
- * Information about a DOM event in context of the {@link module:engine/view/document~Document}.
- * 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 default class DomEventData<TEvent extends Event = Event> {
-    /**
-     * Instance of the view controller.
-     */
-    readonly view: View;
-    /**
-     * The instance of the document.
-     */
-    readonly document: Document;
-    /**
-     * 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: View, domEvent: TEvent, additionalData?: object);
-    /**
-     * The tree view element representing the target.
-     */
-    get target(): Element;
-    /**
-     * Prevents the native's event default action.
-     */
-    preventDefault(): void;
-    /**
-     * Stops native event propagation.
-     */
-    stopPropagation(): void;
-}
+/**
+ * @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 Document from '../document';
+import type Element from '../element';
+import type View from '../view';
+/**
+ * Information about a DOM event in context of the {@link module:engine/view/document~Document}.
+ * 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 default class DomEventData<TEvent extends Event = Event> {
+    /**
+     * Instance of the view controller.
+     */
+    readonly view: View;
+    /**
+     * The instance of the document.
+     */
+    readonly document: Document;
+    /**
+     * 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: View, domEvent: TEvent, additionalData?: object);
+    /**
+     * The tree view element representing the target.
+     */
+    get target(): Element;
+    /**
+     * Prevents the native's event default action.
+     */
+    preventDefault(): void;
+    /**
+     * Stops native event propagation.
+     */
+    stopPropagation(): void;
+}

package/src/view/observer/domeventdata.js

@@ -1,47 +1,47 @@
-/**
- * @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 engine/view/observer/domeventdata
- */
-import { extend } from 'lodash-es';
-/**
- * Information about a DOM event in context of the {@link module:engine/view/document~Document}.
- * 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 default class DomEventData {
-    /**
-     * @param view The instance of the view controller.
-     * @param domEvent The DOM event.
-     * @param additionalData Additional properties that the instance should contain.
-     */
-    constructor(view, domEvent, additionalData) {
-        this.view = view;
-        this.document = view.document;
-        this.domEvent = domEvent;
-        this.domTarget = domEvent.target;
-        extend(this, additionalData);
-    }
-    /**
-     * The tree view element representing the target.
-     */
-    get target() {
-        return this.view.domConverter.mapDomToView(this.domTarget);
-    }
-    /**
-     * Prevents the native's event default action.
-     */
-    preventDefault() {
-        this.domEvent.preventDefault();
-    }
-    /**
-     * Stops native event propagation.
-     */
-    stopPropagation() {
-        this.domEvent.stopPropagation();
-    }
-}
+/**
+ * @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 engine/view/observer/domeventdata
+ */
+import { extend } from 'lodash-es';
+/**
+ * Information about a DOM event in context of the {@link module:engine/view/document~Document}.
+ * 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 default class DomEventData {
+    /**
+     * @param view The instance of the view controller.
+     * @param domEvent The DOM event.
+     * @param additionalData Additional properties that the instance should contain.
+     */
+    constructor(view, domEvent, additionalData) {
+        this.view = view;
+        this.document = view.document;
+        this.domEvent = domEvent;
+        this.domTarget = domEvent.target;
+        extend(this, additionalData);
+    }
+    /**
+     * The tree view element representing the target.
+     */
+    get target() {
+        return this.view.domConverter.mapDomToView(this.domTarget);
+    }
+    /**
+     * Prevents the native's event default action.
+     */
+    preventDefault() {
+        this.domEvent.preventDefault();
+    }
+    /**
+     * Stops native event propagation.
+     */
+    stopPropagation() {
+        this.domEvent.stopPropagation();
+    }
+}

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

@@ -1,73 +1,73 @@
-/**
- * @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 engine/view/observer/domeventobserver
- */
-import Observer from './observer';
-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 default 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;
-    /**
-     * 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~DomEventData event data} object.
-     */
-    fire(eventType: string | EventInfo, domEvent: Event, additionalData?: AdditionalData): void;
-}
+/**
+ * @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 engine/view/observer/domeventobserver
+ */
+import Observer from './observer';
+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 default 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;
+    /**
+     * 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~DomEventData event data} object.
+     */
+    fire(eventType: string | EventInfo, domEvent: Event, additionalData?: AdditionalData): void;
+}