@ckeditor/ckeditor5-engine 44.1.0 → 44.2.0-alpha.1

package/dist/view/node.d.ts

@@ -1,166 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/node
- */
-import TypeCheckable from './typecheckable.js';
-import type { default as Document, ChangeType } from './document.js';
-import type DocumentFragment from './documentfragment.js';
-import type Element from './element.js';
-declare const Node_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
-/**
- * Abstract view node class.
- *
- * This is an abstract class. Its constructor should not be used directly.
- * Use the {@link module:engine/view/downcastwriter~DowncastWriter} or {@link module:engine/view/upcastwriter~UpcastWriter}
- * to create new instances of view nodes.
- */
-export default abstract class Node extends /* #__PURE__ */ Node_base {
-    /**
-     * The document instance to which this node belongs.
-     */
-    readonly document: Document;
-    /**
-     * Parent element. Null by default. Set by {@link module:engine/view/element~Element#_insertChild}.
-     */
-    readonly parent: Element | DocumentFragment | null;
-    /**
-     * Creates a tree view node.
-     *
-     * @param document The document instance to which this node belongs.
-     */
-    protected constructor(document: Document);
-    /**
-     * Index of the node in the parent element or null if the node has no parent.
-     *
-     * Accessing this property throws an error if this node's parent element does not contain it.
-     * This means that view tree got broken.
-     */
-    get index(): number | null;
-    /**
-     * Node's next sibling, or `null` if it is the last child.
-     */
-    get nextSibling(): Node | null;
-    /**
-     * Node's previous sibling, or `null` if it is the first child.
-     */
-    get previousSibling(): Node | null;
-    /**
-     * Top-most ancestor of the node. If the node has no parent it is the root itself.
-     */
-    get root(): Element | DocumentFragment;
-    /**
-     * Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).
-     */
-    isAttached(): boolean;
-    /**
-     * Gets a path to the node. The path is an array containing indices of consecutive ancestors of this node,
-     * beginning from {@link module:engine/view/node~Node#root root}, down to this node's index.
-     *
-     * ```ts
-     * const abc = downcastWriter.createText( 'abc' );
-     * const foo = downcastWriter.createText( 'foo' );
-     * const h1 = downcastWriter.createElement( 'h1', null, downcastWriter.createText( 'header' ) );
-     * const p = downcastWriter.createElement( 'p', null, [ abc, foo ] );
-     * const div = downcastWriter.createElement( 'div', null, [ h1, p ] );
-     * foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
-     * h1.getPath(); // Returns [ 0 ].
-     * div.getPath(); // Returns [].
-     * ```
-     *
-     * @returns The path.
-     */
-    getPath(): Array<number>;
-    /**
-     * Returns ancestors array of this node.
-     *
-     * @param options Options object.
-     * @param options.includeSelf When set to `true` this node will be also included in parent's array.
-     * @param options.parentFirst When set to `true`, array will be sorted from node's parent to root element,
-     * otherwise root element will be the first item in the array.
-     * @returns Array with ancestors.
-     */
-    getAncestors(options?: {
-        includeSelf?: boolean;
-        parentFirst?: boolean;
-    }): Array<Node | DocumentFragment>;
-    /**
-     * Returns a {@link module:engine/view/element~Element} or {@link module:engine/view/documentfragment~DocumentFragment}
-     * which is a common ancestor of both nodes.
-     *
-     * @param node The second node.
-     * @param options Options object.
-     * @param options.includeSelf When set to `true` both nodes will be considered "ancestors" too.
-     * Which means that if e.g. node A is inside B, then their common ancestor will be B.
-     */
-    getCommonAncestor(node: Node, options?: {
-        includeSelf?: boolean;
-    }): Element | DocumentFragment | null;
-    /**
-     * Returns whether this node is before given node. `false` is returned if nodes are in different trees (for example,
-     * in different {@link module:engine/view/documentfragment~DocumentFragment}s).
-     *
-     * @param node Node to compare with.
-     */
-    isBefore(node: Node): boolean;
-    /**
-     * Returns whether this node is after given node. `false` is returned if nodes are in different trees (for example,
-     * in different {@link module:engine/view/documentfragment~DocumentFragment}s).
-     *
-     * @param node Node to compare with.
-     */
-    isAfter(node: Node): boolean;
-    /**
-     * Removes node from parent.
-     *
-     * @internal
-     */
-    _remove(): void;
-    /**
-     * @internal
-     * @param type Type of the change.
-     * @param node Changed node.
-     * @fires change
-     */
-    _fireChange(type: ChangeType, node: Node): void;
-    /**
-     * Custom toJSON method to solve child-parent circular dependencies.
-     *
-     * @returns Clone of this object with the parent property removed.
-     */
-    toJSON(): unknown;
-    /**
-     * Clones this node.
-     *
-     * @internal
-     * @returns Clone of this node.
-     */
-    abstract _clone(deep?: boolean): Node;
-    /**
-     * Checks if provided node is similar to this node.
-     *
-     * @returns True if nodes are similar.
-     */
-    abstract isSimilar(other: Node): boolean;
-}
-/**
- * Fired when list of {@link module:engine/view/element~Element elements} children, attributes or data changes.
- *
- * Change event is bubbled – it is fired on all ancestors.
- *
- * @eventName ~Node#change
- * @eventName ~Node#change:children
- * @eventName ~Node#change:attributes
- * @eventName ~Node#change:text
- */
-export type ViewNodeChangeEvent = {
-    name: 'change' | `change:${ChangeType}`;
-    args: [changedNode: Node];
-};
-export {};

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

@@ -1,49 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/arrowkeysobserver
- */
-import Observer from './observer.js';
-import type View from '../view.js';
-import type { KeyEventData } from './keyobserver.js';
-import type { BubblingEvent } from './bubblingemittermixin.js';
-/**
- * Arrow keys observer introduces the {@link module:engine/view/document~Document#event:arrowKey `Document#arrowKey`} event.
- *
- * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
- */
-export default class ArrowKeysObserver extends Observer {
-    /**
-     * @inheritDoc
-     */
-    constructor(view: View);
-    /**
-     * @inheritDoc
-     */
-    observe(): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(): void;
-}
-/**
- * Event fired when the user presses an arrow keys.
- *
- * Introduced by {@link module:engine/view/observer/arrowkeysobserver~ArrowKeysObserver}.
- *
- * Note that because {@link module:engine/view/observer/arrowkeysobserver~ArrowKeysObserver} is attached by the
- * {@link module:engine/view/view~View} this event is available by default.
- *
- * @eventName module:engine/view/document~Document#arrowKey
- * @param data
- */
-export type ViewDocumentArrowKeyEvent = BubblingEvent<{
-    name: 'arrowKey';
-    args: [data: KeyEventData];
-}>;

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

@@ -1,170 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/bubblingemittermixin
- */
-import { type ArrayOrItem, type Emitter, type BaseEvent, type CallbackOptions, type Constructor, type Mixed } from '@ckeditor/ckeditor5-utils';
-import BubblingEventInfo from './bubblingeventinfo.js';
-import type Node from '../node.js';
-/**
- * Bubbling emitter mixin for the view document as described in the {@link ~BubblingEmitter} interface.
- *
- * This function creates a class that inherits from the provided `base` and implements `Emitter` interface.
- * The base class must implement {@link module:utils/emittermixin~Emitter} interface.
- *
- * ```ts
- * class BaseClass extends EmitterMixin() {
- * 	// ...
- * }
- *
- * class MyClass extends BubblingEmitterMixin( BaseClass ) {
- * 	// This class derives from `BaseClass` and implements the `BubblingEmitter` interface.
- * }
- * ```
- */
-export default function BubblingEmitterMixin<Base extends Constructor<Emitter>>(base: Base): Mixed<Base, BubblingEmitter>;
-/**
- * Bubbling emitter for the view document.
- *
- * Bubbling emitter is triggering events in the context of specified {@link module:engine/view/element~Element view element} name,
- * predefined `'$text'`, `'$root'`, `'$document'` and `'$capture'` contexts, and context matchers provided as a function.
- *
- * Before bubbling starts, listeners for `'$capture'` context are triggered. Then the bubbling starts from the deeper selection
- * position (by firing event on the `'$text'` context) and propagates the view document tree up to the `'$root'` and finally
- * the listeners at `'$document'` context are fired (this is the default context).
- *
- * Examples:
- *
- * ```ts
- * // Listeners registered in the context of the view element names:
- * this.listenTo( viewDocument, 'enter', ( evt, data ) => {
- * 	// ...
- * }, { context: 'blockquote' } );
- *
- * this.listenTo( viewDocument, 'enter', ( evt, data ) => {
- * 	// ...
- * }, { context: 'li' } );
- *
- * // Listeners registered in the context of the '$text' and '$root' nodes.
- * this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- * 	// ...
- * }, { context: '$text', priority: 'high' } );
- *
- * this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- * 	// ...
- * }, { context: '$root' } );
- *
- * // Listeners registered in the context of custom callback function.
- * this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- * 	// ...
- * }, { context: isWidget } );
- *
- * this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- * 	// ...
- * }, { context: isWidget, priority: 'high' } );
- * ```
- *
- * Example flow for selection in text:
- *
- * ```xml
- * <blockquote><p>Foo[]bar</p></blockquote>
- * ```
- *
- * Fired events on contexts:
- * 1. `'$capture'`
- * 2. `'$text'`
- * 3. `'p'`
- * 4. `'blockquote'`
- * 5. `'$root'`
- * 6. `'$document'`
- *
- * Example flow for selection on element (i.e., Widget):
- *
- * ```xml
- * <blockquote><p>Foo[<widget/>]bar</p></blockquote>
- * ```
- *
- * Fired events on contexts:
- * 1. `'$capture'`
- * 2. *widget* (custom matcher)
- * 3. `'p'`
- * 4. `'blockquote'`
- * 5. `'$root'`
- * 6. `'$document'`
- *
- * There could be multiple listeners registered for the same context and at different priority levels:
- *
- * ```html
- * <p>Foo[]bar</p>
- * ```
- *
- * 1. `'$capture'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 2. `'$text'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 3. `'p'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 4. `'$root'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 5. `'$document'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- */
-export type BubblingEmitter = Emitter;
-/**
- * A context matcher function.
- *
- * Should return true for nodes that that match the custom context.
- */
-export type BubblingEventContextFunction = (node: Node) => boolean;
-/**
- * Helper type that allows describing bubbling event. Extends `TEvent` so that:
- *
- * * the event is called with {@link module:engine/view/observer/bubblingeventinfo~BubblingEventInfo}`
- * instead of {@link module:utils/eventinfo~EventInfo}, and
- * * {@link ~BubblingCallbackOptions} can be specified as additional options.
- *
- * @typeParam TEvent The event description to extend.
- */
-export type BubblingEvent<TEvent extends BaseEvent> = TEvent & {
-    eventInfo: BubblingEventInfo<TEvent['name'], (TEvent extends {
-        return: infer TReturn;
-    } ? TReturn : unknown)>;
-    callbackOptions: BubblingCallbackOptions;
-};
-/**
- * Additional options for registering a callback.
- */
-export interface BubblingCallbackOptions extends CallbackOptions {
-    /**
-     * Specifies the context in which the event should be triggered to call the callback.
-     *
-     * @see ~BubblingEmitter
-     */
-    context?: ArrayOrItem<string | BubblingEventContextFunction>;
-}

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

@@ -1,51 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/bubblingeventinfo
- */
-import { EventInfo } from '@ckeditor/ckeditor5-utils';
-import type Document from '../document.js';
-import type Node from '../node.js';
-import type Range from '../range.js';
-/**
- * The event object passed to bubbling event callbacks. It is used to provide information about the event as well as a tool to
- * manipulate it.
- */
-export default class BubblingEventInfo<TName extends string = string, TReturn = unknown> extends EventInfo<TName, TReturn> {
-    /**
-     * The view range that the bubbling should start from.
-     */
-    readonly startRange: Range;
-    /**
-     * The current event phase.
-     */
-    private _eventPhase;
-    /**
-     * The current bubbling target.
-     */
-    private _currentTarget;
-    /**
-     * @param source The emitter.
-     * @param name The event name.
-     * @param startRange The view range that the bubbling should start from.
-     */
-    constructor(source: object, name: TName, startRange: Range);
-    /**
-     * The current event phase.
-     */
-    get eventPhase(): EventPhase;
-    /**
-     * The current bubbling target.
-     */
-    get currentTarget(): Document | Node | null;
-}
-/**
- * The phase the event is in.
- */
-export type EventPhase = 'none' | 'capturing' | 'atTarget' | 'bubbling';

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

@@ -1,47 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/clickobserver
- */
-import DomEventObserver from './domeventobserver.js';
-import type DomEventData from './domeventdata.js';
-import type { BubblingEvent } from './bubblingemittermixin.js';
-/**
- * {@link module:engine/view/document~Document#event:click Click} event observer.
- *
- * Note that this observer is not available by default. To make it available it needs to be added to
- * {@link module:engine/view/view~View view controller} by a {@link module:engine/view/view~View#addObserver} method.
- */
-export default class ClickObserver extends DomEventObserver<'click'> {
-    /**
-     * @inheritDoc
-     */
-    readonly domEventType: "click";
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: MouseEvent): void;
-}
-/**
- * Fired when one of the editables has been clicked.
- *
- * Introduced by {@link module:engine/view/observer/clickobserver~ClickObserver}.
- *
- * Note that this event is not available by default. To make it available
- * {@link module:engine/view/observer/clickobserver~ClickObserver} needs to be added
- * to {@link module:engine/view/view~View} by a {@link module:engine/view/view~View#addObserver} method.
- *
- * @see module:engine/view/observer/clickobserver~ClickObserver
- * @eventName module:engine/view/document~Document#click
- * @param data Event data.
- */
-export type ViewDocumentClickEvent = BubblingEvent<{
-    name: 'click';
-    args: [data: DomEventData<MouseEvent>];
-}>;

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

@@ -1,86 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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 View from '../view.js';
-import type DomEventData from './domeventdata.js';
-/**
- * {@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/dist/view/observer/domeventdata.d.ts

@@ -1,54 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type Document from '../document.js';
-import type Element from '../element.js';
-import type View from '../view.js';
-/**
- * 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;
-}