@ckeditor/ckeditor5-engine 36.0.1 → 37.0.0-alpha.1

package/src/view/node.d.ts

@@ -0,0 +1,163 @@
+/**
+ * @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/node
+ */
+import TypeCheckable from './typecheckable';
+import '@ckeditor/ckeditor5-utils/src/version';
+import type { default as Document, ChangeType } from './document';
+import type DocumentFragment from './documentfragment';
+import type Element from './element';
+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 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/src/view/node.js

@@ -16,31 +16,16 @@ import '@ckeditor/ckeditor5-utils/src/version';
  * 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.
- *
- * @abstract
  */
 export default class Node extends EmitterMixin(TypeCheckable) {
     /**
      * Creates a tree view node.
      *
-     * @protected
-     * @param {module:engine/view/document~Document} document The document instance to which this node belongs.
+     * @param document The document instance to which this node belongs.
      */
     constructor(document) {
         super();
-        /**
-         * The document instance to which this node belongs.
-         *
-         * @readonly
-         * @member {module:engine/view/document~Document}
-         */
         this.document = document;
-        /**
-         * Parent element. Null by default. Set by {@link module:engine/view/element~Element#_insertChild}.
-         *
-         * @readonly
-         * @member {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|null}
-         */
         this.parent = null;
     }
     /**
@@ -48,9 +33,6 @@ export default class Node extends EmitterMixin(TypeCheckable) {
      *
      * Accessing this property throws an error if this node's parent element does not contain it.
      * This means that view tree got broken.
-     *
-     * @readonly
-     * @type {Number|null}
      */
     get index() {
         let pos;
@@ -70,9 +52,6 @@ export default class Node extends EmitterMixin(TypeCheckable) {
     }
     /**
      * Node's next sibling, or `null` if it is the last child.
-     *
-     * @readonly
-     * @type {module:engine/view/node~Node|null}
      */
     get nextSibling() {
         const index = this.index;
@@ -80,9 +59,6 @@ export default class Node extends EmitterMixin(TypeCheckable) {
     }
     /**
      * Node's previous sibling, or `null` if it is the first child.
-     *
-     * @readonly
-     * @type {module:engine/view/node~Node|null}
      */
     get previousSibling() {
         const index = this.index;
@@ -90,9 +66,6 @@ export default class Node extends EmitterMixin(TypeCheckable) {
     }
     /**
      * Top-most ancestor of the node. If the node has no parent it is the root itself.
-     *
-     * @readonly
-     * @type {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment}
      */
     get root() {
         // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
@@ -104,8 +77,6 @@ export default class Node extends EmitterMixin(TypeCheckable) {
     }
     /**
      * Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).
-     *
-     * @returns {Boolean}
      */
     isAttached() {
         return this.root.is('rootElement');
@@ -114,16 +85,18 @@ export default class Node extends EmitterMixin(TypeCheckable) {
      * 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.
      *
-     *		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 [].
+     * ```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 {Array.<Number>} The path.
+     * @returns The path.
      */
     getPath() {
         const path = [];
@@ -138,11 +111,11 @@ export default class Node extends EmitterMixin(TypeCheckable) {
     /**
      * Returns ancestors array of this node.
      *
-     * @param {Object} options Options object.
-     * @param {Boolean} [options.includeSelf=false] When set to `true` this node will be also included in parent's array.
-     * @param {Boolean} [options.parentFirst=false] When set to `true`, array will be sorted from node's parent to root element,
+     * @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} Array with ancestors.
+     * @returns Array with ancestors.
      */
     getAncestors(options = {}) {
         const ancestors = [];
@@ -157,11 +130,10 @@ export default class Node extends EmitterMixin(TypeCheckable) {
      * Returns a {@link module:engine/view/element~Element} or {@link module:engine/view/documentfragment~DocumentFragment}
      * which is a common ancestor of both nodes.
      *
-     * @param {module:engine/view/node~Node} node The second node.
-     * @param {Object} options Options object.
-     * @param {Boolean} [options.includeSelf=false] When set to `true` both nodes will be considered "ancestors" too.
+     * @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.
-     * @returns {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|null}
      */
     getCommonAncestor(node, options = {}) {
         const ancestorsA = this.getAncestors(options);
@@ -176,8 +148,7 @@ export default class Node extends EmitterMixin(TypeCheckable) {
      * 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 {module:engine/view/node~Node} node Node to compare with.
-     * @returns {Boolean}
+     * @param node Node to compare with.
      */
     isBefore(node) {
         // Given node is not before this node if they are same.
@@ -204,8 +175,7 @@ export default class Node extends EmitterMixin(TypeCheckable) {
      * 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 {module:engine/view/node~Node} node Node to compare with.
-     * @returns {Boolean}
+     * @param node Node to compare with.
      */
     isAfter(node) {
         // Given node is not before this node if they are same.
@@ -223,16 +193,14 @@ export default class Node extends EmitterMixin(TypeCheckable) {
      * Removes node from parent.
      *
      * @internal
-     * @protected
      */
     _remove() {
         this.parent._removeChildren(this.index);
     }
     /**
      * @internal
-     * @protected
-     * @param {module:engine/view/document~ChangeType} type Type of the change.
-     * @param {module:engine/view/node~Node} node Changed node.
+     * @param type Type of the change.
+     * @param node Changed node.
      * @fires change
      */
     _fireChange(type, node) {
@@ -244,7 +212,7 @@ export default class Node extends EmitterMixin(TypeCheckable) {
     /**
      * Custom toJSON method to solve child-parent circular dependencies.
      *
-     * @returns {Object} Clone of this object with the parent property removed.
+     * @returns Clone of this object with the parent property removed.
      */
     toJSON() {
         const json = clone(this);
@@ -253,50 +221,8 @@ export default class Node extends EmitterMixin(TypeCheckable) {
         return json;
     }
 }
-/**
- * Checks whether this object is of the given type.
- *
- * This method is useful when processing view objects that are of unknown type. For example, a function
- * may return a {@link module:engine/view/documentfragment~DocumentFragment} or a {@link module:engine/view/node~Node}
- * that can be either a text node or an element. This method can be used to check what kind of object is returned.
- *
- *		someObject.is( 'element' ); // -> true if this is an element
- *		someObject.is( 'node' ); // -> true if this is a node (a text node or an element)
- *		someObject.is( 'documentFragment' ); // -> true if this is a document fragment
- *
- * Since this method is also available on a range of model objects, you can prefix the type of the object with
- * `model:` or `view:` to check, for example, if this is the model's or view's element:
- *
- *		viewElement.is( 'view:element' ); // -> true
- *		viewElement.is( 'model:element' ); // -> false
- *
- * By using this method it is also possible to check a name of an element:
- *
- *		imgElement.is( 'element', 'img' ); // -> true
- *		imgElement.is( 'view:element', 'img' ); // -> same as above, but more precise
- *
- * The list of view objects which implement the `is()` method:
- *
- * * {@link module:engine/view/attributeelement~AttributeElement#is `AttributeElement#is()`}
- * * {@link module:engine/view/containerelement~ContainerElement#is `ContainerElement#is()`}
- * * {@link module:engine/view/documentfragment~DocumentFragment#is `DocumentFragment#is()`}
- * * {@link module:engine/view/documentselection~DocumentSelection#is `DocumentSelection#is()`}
- * * {@link module:engine/view/editableelement~EditableElement#is `EditableElement#is()`}
- * * {@link module:engine/view/element~Element#is `Element#is()`}
- * * {@link module:engine/view/emptyelement~EmptyElement#is `EmptyElement#is()`}
- * * {@link module:engine/view/node~Node#is `Node#is()`}
- * * {@link module:engine/view/position~Position#is `Position#is()`}
- * * {@link module:engine/view/range~Range#is `Range#is()`}
- * * {@link module:engine/view/rooteditableelement~RootEditableElement#is `RootEditableElement#is()`}
- * * {@link module:engine/view/selection~Selection#is `Selection#is()`}
- * * {@link module:engine/view/text~Text#is `Text#is()`}
- * * {@link module:engine/view/textproxy~TextProxy#is `TextProxy#is()`}
- * * {@link module:engine/view/uielement~UIElement#is `UIElement#is()`}
- *
- * @method #is
- * @param {String} type Type to check.
- * @returns {Boolean}
- */
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
 Node.prototype.is = function (type) {
     return type === 'node' || type === 'view:node';
 };

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

@@ -0,0 +1,41 @@
+/**
+ * @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/arrowkeysobserver
+ */
+import Observer from './observer';
+import type View from '../view';
+import type { KeyEventData } from './keyobserver';
+import type { BubblingEvent } from './bubblingemittermixin';
+/**
+ * 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;
+}
+/**
+ * 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/src/view/observer/arrowkeysobserver.js

@@ -12,8 +12,6 @@ import { isArrowKeyCode } from '@ckeditor/ckeditor5-utils';
  * 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.
- *
- * @extends module:engine/view/observer/observer~Observer
  */
 export default class ArrowKeysObserver extends Observer {
     /**
@@ -36,14 +34,3 @@ export default class ArrowKeysObserver extends Observer {
      */
     observe() { }
 }
-/**
- * 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.
- *
- * @event module:engine/view/document~Document#event:arrowKey
- * @param {module:engine/view/observer/domeventdata~DomEventData} data
- */

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

@@ -0,0 +1,166 @@
+/**
+ * @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/bubblingemittermixin
+ */
+import { type ArrayOrItem, type Emitter, type BaseEvent, type CallbackOptions, type Constructor, type Mixed } from '@ckeditor/ckeditor5-utils';
+import BubblingEventInfo from './bubblingeventinfo';
+import type Node from '../node';
+/**
+ * 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>;
+}