@ckeditor/ckeditor5-engine 47.6.1 → 48.0.0-alpha.0

package/src/view/node.js

@@ -1,238 +0,0 @@
-/**
- * @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/node
- */
-import { ViewTypeCheckable } from './typecheckable.js';
-import { CKEditorError, EmitterMixin, compareArrays } from '@ckeditor/ckeditor5-utils';
-/**
- * Abstract view node class.
- *
- * This is an abstract class. Its constructor should not be used directly.
- * Use the {@link module:engine/view/downcastwriter~ViewDowncastWriter} or {@link module:engine/view/upcastwriter~ViewUpcastWriter}
- * to create new instances of view nodes.
- */
-export class ViewNode extends /* #__PURE__ */ EmitterMixin(ViewTypeCheckable) {
-    /**
-     * The document instance to which this node belongs.
-     */
-    document;
-    /**
-     * Parent element. Null by default. Set by {@link module:engine/view/element~ViewElement#_insertChild}.
-     */
-    parent;
-    /**
-     * Creates a tree view node.
-     *
-     * @param document The document instance to which this node belongs.
-     */
-    constructor(document) {
-        super();
-        this.document = document;
-        this.parent = null;
-    }
-    /**
-     * 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() {
-        let pos;
-        if (!this.parent) {
-            return null;
-        }
-        // No parent or child doesn't exist in parent's children.
-        if ((pos = this.parent.getChildIndex(this)) == -1) {
-            /**
-             * The node's parent does not contain this node. It means that the document tree is corrupted.
-             *
-             * @error view-node-not-found-in-parent
-             */
-            throw new CKEditorError('view-node-not-found-in-parent', this);
-        }
-        return pos;
-    }
-    /**
-     * Node's next sibling, or `null` if it is the last child.
-     */
-    get nextSibling() {
-        const index = this.index;
-        return (index !== null && this.parent.getChild(index + 1)) || null;
-    }
-    /**
-     * Node's previous sibling, or `null` if it is the first child.
-     */
-    get previousSibling() {
-        const index = this.index;
-        return (index !== null && this.parent.getChild(index - 1)) || null;
-    }
-    /**
-     * Top-most ancestor of the node. If the node has no parent it is the root itself.
-     */
-    get root() {
-        // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
-        let root = this;
-        while (root.parent) {
-            root = root.parent;
-        }
-        return root;
-    }
-    /**
-     * Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).
-     */
-    isAttached() {
-        return this.root.is('rootElement');
-    }
-    /**
-     * 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~ViewNode#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() {
-        const path = [];
-        // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
-        let node = this;
-        while (node.parent) {
-            path.unshift(node.index);
-            node = node.parent;
-        }
-        return path;
-    }
-    /**
-     * 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 = {}) {
-        const ancestors = [];
-        let parent = options.includeSelf ? this : this.parent;
-        while (parent) {
-            ancestors[options.parentFirst ? 'push' : 'unshift'](parent);
-            parent = parent.parent;
-        }
-        return ancestors;
-    }
-    /**
-     * Returns a {@link module:engine/view/element~ViewElement} or {@link module:engine/view/documentfragment~ViewDocumentFragment}
-     * 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, options = {}) {
-        const ancestorsA = this.getAncestors(options);
-        const ancestorsB = node.getAncestors(options);
-        let i = 0;
-        while (ancestorsA[i] == ancestorsB[i] && ancestorsA[i]) {
-            i++;
-        }
-        return i === 0 ? null : ancestorsA[i - 1];
-    }
-    /**
-     * 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~ViewDocumentFragment}s).
-     *
-     * @param node Node to compare with.
-     */
-    isBefore(node) {
-        // Given node is not before this node if they are same.
-        if (this == node) {
-            return false;
-        }
-        // Return `false` if it is impossible to compare nodes.
-        if (this.root !== node.root) {
-            return false;
-        }
-        const thisPath = this.getPath();
-        const nodePath = node.getPath();
-        const result = compareArrays(thisPath, nodePath);
-        switch (result) {
-            case 'prefix':
-                return true;
-            case 'extension':
-                return false;
-            default:
-                return thisPath[result] < nodePath[result];
-        }
-    }
-    /**
-     * 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~ViewDocumentFragment}s).
-     *
-     * @param node Node to compare with.
-     */
-    isAfter(node) {
-        // Given node is not before this node if they are same.
-        if (this == node) {
-            return false;
-        }
-        // Return `false` if it is impossible to compare nodes.
-        if (this.root !== node.root) {
-            return false;
-        }
-        // In other cases, just check if the `node` is before, and return the opposite.
-        return !this.isBefore(node);
-    }
-    /**
-     * Removes node from parent.
-     *
-     * @internal
-     */
-    _remove() {
-        this.parent._removeChildren(this.index);
-    }
-    /**
-     * @internal
-     * @param type Type of the change.
-     * @param node Changed node.
-     * @param data Additional data.
-     * @fires change
-     */
-    _fireChange(type, node, data) {
-        this.fire(`change:${type}`, node, data);
-        if (this.parent) {
-            this.parent._fireChange(type, node, data);
-        }
-    }
-    /**
-     * Converts `ViewNode` to plain object and returns it.
-     *
-     * @returns `ViewNode` converted to plain object.
-     */
-    toJSON() {
-        const json = {
-            path: this.getPath(),
-            type: 'Node'
-        };
-        if (this !== this.root && this.root.is('rootElement')) {
-            json.root = this.root.toJSON();
-        }
-        return json;
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-ViewNode.prototype.is = function (type) {
-    return type === 'node' || type === 'view:node';
-};

package/src/view/observer/arrowkeysobserver.js

@@ -1,40 +0,0 @@
-/**
- * @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/arrowkeysobserver
- */
-import { Observer } from './observer.js';
-import { BubblingEventInfo } from './bubblingeventinfo.js';
-import { isArrowKeyCode } from '@ckeditor/ckeditor5-utils';
-/**
- * Arrow keys observer introduces the {@link module:engine/view/document~ViewDocument#event:arrowKey `Document#arrowKey`} event.
- *
- * Note that this observer is attached by the {@link module:engine/view/view~EditingView} and is available by default.
- */
-export class ArrowKeysObserver extends Observer {
-    /**
-     * @inheritDoc
-     */
-    constructor(view) {
-        super(view);
-        this.document.on('keydown', (event, data) => {
-            if (this.isEnabled && isArrowKeyCode(data.keyCode)) {
-                const eventInfo = new BubblingEventInfo(this.document, 'arrowKey', this.document.selection.getFirstRange());
-                this.document.fire(eventInfo, data);
-                if (eventInfo.stop.called) {
-                    event.stop();
-                }
-            }
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    observe() { }
-    /**
-     * @inheritDoc
-     */
-    stopObserving() { }
-}

package/src/view/observer/bubblingemittermixin.js

@@ -1,215 +0,0 @@
-/**
- * @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/bubblingemittermixin
- */
-import { CKEditorError, EmitterMixin, EventInfo, toArray } from '@ckeditor/ckeditor5-utils';
-import { BubblingEventInfo } from './bubblingeventinfo.js';
-const bubblingEmitterSymbol = Symbol('bubblingEmitter');
-const callbackMapSymbol = Symbol('bubblingCallbacks');
-const contextsSymbol = Symbol('bubblingContexts');
-/**
- * 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 function BubblingEmitterMixin(base) {
-    class Mixin extends base {
-        fire(eventOrInfo, ...eventArgs) {
-            try {
-                const eventInfo = eventOrInfo instanceof EventInfo ? eventOrInfo : new EventInfo(this, eventOrInfo);
-                const bubblingEmitter = getBubblingEmitter(this);
-                const customContexts = getCustomContexts(this);
-                updateEventInfo(eventInfo, 'capturing', this);
-                // The capture phase of the event.
-                if (fireListenerFor(bubblingEmitter, '$capture', eventInfo, ...eventArgs)) {
-                    return eventInfo.return;
-                }
-                const startRange = eventInfo.startRange || this.selection.getFirstRange();
-                const selectedElement = startRange ? startRange.getContainedElement() : null;
-                const isCustomContext = selectedElement ? hasMatchingCustomContext(customContexts, selectedElement) : false;
-                let node = selectedElement || getDeeperRangeParent(startRange);
-                updateEventInfo(eventInfo, 'atTarget', node);
-                // For the not yet bubbling event trigger for $text node if selection can be there and it's not a custom context selected.
-                if (!isCustomContext) {
-                    if (fireListenerFor(bubblingEmitter, '$text', eventInfo, ...eventArgs)) {
-                        return eventInfo.return;
-                    }
-                    updateEventInfo(eventInfo, 'bubbling', node);
-                }
-                while (node) {
-                    if (node.is('element') && fireListenerFor(bubblingEmitter, node, eventInfo, ...eventArgs)) {
-                        return eventInfo.return;
-                    }
-                    node = node.parent;
-                    updateEventInfo(eventInfo, 'bubbling', node);
-                }
-                updateEventInfo(eventInfo, 'bubbling', this);
-                // Document context.
-                fireListenerFor(bubblingEmitter, '$document', eventInfo, ...eventArgs);
-                return eventInfo.return;
-            }
-            catch (err) {
-                // @if CK_DEBUG // throw err;
-                /* istanbul ignore next -- @preserve */
-                CKEditorError.rethrowUnexpectedError(err, this);
-            }
-        }
-        _addEventListener(event, callback, options) {
-            const contexts = toArray(options.context || '$document');
-            const bubblingEmitter = getBubblingEmitter(this);
-            const callbacksMap = getCallbackMap(this);
-            for (const context of contexts) {
-                if (typeof context == 'function') {
-                    getCustomContexts(this).add(context);
-                }
-            }
-            // Wrap callback with current target match.
-            const wrappedCallback = wrapCallback(this, contexts, callback);
-            // Store for later removing of listeners.
-            callbacksMap.set(callback, wrappedCallback);
-            // Listen for the event.
-            this.listenTo(bubblingEmitter, event, wrappedCallback, options);
-        }
-        _removeEventListener(event, callback) {
-            const bubblingEmitter = getBubblingEmitter(this);
-            const callbacksMap = getCallbackMap(this);
-            const wrappedCallback = callbacksMap.get(callback);
-            if (wrappedCallback) {
-                callbacksMap.delete(callback);
-                this.stopListening(bubblingEmitter, event, wrappedCallback);
-            }
-        }
-    }
-    return Mixin;
-}
-/**
- * Update the event info bubbling fields.
- *
- * @param eventInfo The event info object to update.
- * @param eventPhase The current event phase.
- * @param currentTarget The current bubbling target.
- */
-function updateEventInfo(eventInfo, eventPhase, currentTarget) {
-    if (eventInfo instanceof BubblingEventInfo) {
-        eventInfo._eventPhase = eventPhase;
-        eventInfo._currentTarget = currentTarget;
-    }
-}
-/**
- * Fires the listener for the specified context. Returns `true` if event was stopped.
- *
- * @param eventInfo The `EventInfo` object.
- * @param eventArgs Additional arguments to be passed to the callbacks.
- * @returns True if event stop was called.
- */
-function fireListenerFor(emitter, currentTarget, eventInfo, ...eventArgs) {
-    emitter.fire(eventInfo, {
-        currentTarget,
-        eventArgs
-    });
-    // Similar to DOM Event#stopImmediatePropagation() this does not fire events
-    // for other contexts on the same node.
-    if (eventInfo.stop.called) {
-        return true;
-    }
-    return false;
-}
-/**
- * Returns an event callback wrapped with context check condition.
- */
-function wrapCallback(emitter, contexts, callback) {
-    return function (event, data) {
-        const { currentTarget, eventArgs } = data;
-        // Quick path for string based context ($capture, $text, $document).
-        if (typeof currentTarget == 'string') {
-            if (contexts.includes(currentTarget)) {
-                callback.call(emitter, event, ...eventArgs);
-            }
-            return;
-        }
-        // The current target is a view element.
-        // Special case for the root element as it could be handled ac $root context.
-        // Note that it could also be matched later by custom context.
-        if (currentTarget.is('rootElement') && contexts.includes('$root')) {
-            callback.call(emitter, event, ...eventArgs);
-            return;
-        }
-        // Check if it is a context for this element name.
-        if (contexts.includes(currentTarget.name)) {
-            callback.call(emitter, event, ...eventArgs);
-            return;
-        }
-        // Check if dynamic context matches.
-        for (const context of contexts) {
-            if (typeof context == 'function' && context(currentTarget)) {
-                callback.call(emitter, event, ...eventArgs);
-                return;
-            }
-        }
-    };
-}
-/**
- * Returns bubbling emitter for the source (emitter).
- */
-function getBubblingEmitter(source) {
-    if (!source[bubblingEmitterSymbol]) {
-        source[bubblingEmitterSymbol] = new (EmitterMixin())();
-    }
-    return source[bubblingEmitterSymbol];
-}
-/**
- * Returns map of callbacks (original to wrapped one).
- */
-function getCallbackMap(source) {
-    if (!source[callbackMapSymbol]) {
-        source[callbackMapSymbol] = new Map();
-    }
-    return source[callbackMapSymbol];
-}
-/**
- * Returns the set of registered custom contexts.
- */
-function getCustomContexts(source) {
-    if (!source[contextsSymbol]) {
-        source[contextsSymbol] = new Set();
-    }
-    return source[contextsSymbol];
-}
-/**
- * Returns true if any of custom context match the given element.
- */
-function hasMatchingCustomContext(customContexts, element) {
-    for (const context of customContexts) {
-        if (context(element)) {
-            return true;
-        }
-    }
-    return false;
-}
-/**
- * Returns the deeper parent element for the range.
- */
-function getDeeperRangeParent(range) {
-    if (!range) {
-        return null;
-    }
-    const startParent = range.start.parent;
-    const endParent = range.end.parent;
-    const startPath = startParent.getPath();
-    const endPath = endParent.getPath();
-    return startPath.length > endPath.length ? startParent : endParent;
-}

package/src/view/observer/bubblingeventinfo.js

@@ -1,49 +0,0 @@
-/**
- * @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/bubblingeventinfo
- */
-import { EventInfo } from '@ckeditor/ckeditor5-utils';
-/**
- * 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 class BubblingEventInfo extends EventInfo {
-    /**
-     * The view range that the bubbling should start from.
-     */
-    startRange;
-    /**
-     * The current event phase.
-     */
-    _eventPhase;
-    /**
-     * The current bubbling target.
-     */
-    _currentTarget;
-    /**
-     * @param source The emitter.
-     * @param name The event name.
-     * @param startRange The view range that the bubbling should start from.
-     */
-    constructor(source, name, startRange) {
-        super(source, name);
-        this.startRange = startRange;
-        this._eventPhase = 'none';
-        this._currentTarget = null;
-    }
-    /**
-     * The current event phase.
-     */
-    get eventPhase() {
-        return this._eventPhase;
-    }
-    /**
-     * The current bubbling target.
-     */
-    get currentTarget() {
-        return this._currentTarget;
-    }
-}

package/src/view/observer/clickobserver.js

@@ -1,26 +0,0 @@
-/**
- * @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/clickobserver
- */
-import { DomEventObserver } from './domeventobserver.js';
-/**
- * {@link module:engine/view/document~ViewDocument#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~EditingView view controller} by a {@link module:engine/view/view~EditingView#addObserver} method.
- */
-export class ClickObserver extends DomEventObserver {
-    /**
-     * @inheritDoc
-     */
-    domEventType = 'click';
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent) {
-        this.fire(domEvent.type, domEvent);
-    }
-}

package/src/view/observer/compositionobserver.js

@@ -1,64 +0,0 @@
-/**
- * @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';
-// @if CK_DEBUG_TYPING // const { _debouncedLine, _buildLogMessage } = require( '../../dev-utils/utils.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 class CompositionObserver extends DomEventObserver {
-    /**
-     * @inheritDoc
-     */
-    domEventType = ['compositionstart', 'compositionupdate', 'compositionend'];
-    /**
-     * @inheritDoc
-     */
-    constructor(view) {
-        super(view);
-        const document = this.document;
-        document.on('compositionstart', () => {
-            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
-            // @if CK_DEBUG_TYPING // 	console.log( ..._buildLogMessage( this, 'CompositionObserver',
-            // @if CK_DEBUG_TYPING // 		'%c┌───────────────────────────── isComposing = true ─────────────────────────────┐',
-            // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green'
-            // @if CK_DEBUG_TYPING // 	) );
-            // @if CK_DEBUG_TYPING // }
-            document.isComposing = true;
-        });
-        document.on('compositionend', () => {
-            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
-            // @if CK_DEBUG_TYPING // 	console.log( ..._buildLogMessage( this, 'CompositionObserver',
-            // @if CK_DEBUG_TYPING // 		'%c└───────────────────────────── isComposing = false ─────────────────────────────┘',
-            // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green'
-            // @if CK_DEBUG_TYPING // 	) );
-            // @if CK_DEBUG_TYPING // }
-            document.isComposing = false;
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent) {
-        // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
-        // @if CK_DEBUG_TYPING // 	_debouncedLine();
-        // @if CK_DEBUG_TYPING // 	console.group( ..._buildLogMessage( this, 'CompositionObserver',
-        // @if CK_DEBUG_TYPING // 		`${ domEvent.type }`
-        // @if CK_DEBUG_TYPING // 	) );
-        // @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 // }
-    }
-}