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

package/src/view/attributeelement.js

@@ -1,220 +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/attributeelement
- */
-import { ViewElement } from './element.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-// Default attribute priority.
-const DEFAULT_PRIORITY = 10;
-/**
- * Attribute elements are used to represent formatting elements in the view (think – `<b>`, `<span style="font-size: 2em">`, etc.).
- * Most often they are created when downcasting model text attributes.
- *
- * Editing engine does not define a fixed HTML DTD. This is why a feature developer needs to choose between various
- * types (container element, {@link module:engine/view/attributeelement~ViewAttributeElement attribute element},
- * {@link module:engine/view/emptyelement~ViewEmptyElement empty element}, etc) when developing a feature.
- *
- * To create a new attribute element instance use the
- * {@link module:engine/view/downcastwriter~ViewDowncastWriter#createAttributeElement `ViewDowncastWriter#createAttributeElement()`} method.
- */
-export class ViewAttributeElement extends ViewElement {
-    static DEFAULT_PRIORITY = DEFAULT_PRIORITY;
-    /**
-     * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
-     *
-     * @internal
-     * @readonly
-     */
-    _priority = DEFAULT_PRIORITY;
-    /**
-     * Element identifier. If set, it is used by {@link module:engine/view/element~ViewElement#isSimilar},
-     * and then two elements are considered similar if, and only if they have the same `_id`.
-     *
-     * @internal
-     * @readonly
-     */
-    _id = null;
-    /**
-     * Keeps all the attribute elements that have the same {@link module:engine/view/attributeelement~ViewAttributeElement#id ids}
-     * and still exist in the view tree.
-     *
-     * This property is managed by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
-     */
-    _clonesGroup = null;
-    /**
-     * Creates an attribute element.
-     *
-     * @see module:engine/view/downcastwriter~ViewDowncastWriter#createAttributeElement
-     * @see module:engine/view/element~ViewElement
-     * @protected
-     * @param document The document instance to which this element belongs.
-     * @param name Node name.
-     * @param attrs Collection of attributes.
-     * @param children A list of nodes to be inserted into created element.
-     */
-    constructor(document, name, attrs, children) {
-        super(document, name, attrs, children);
-        this.getFillerOffset = getFillerOffset;
-    }
-    /**
-     * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
-     */
-    get priority() {
-        return this._priority;
-    }
-    /**
-     * Element identifier. If set, it is used by {@link module:engine/view/element~ViewElement#isSimilar},
-     * and then two elements are considered similar if, and only if they have the same `id`.
-     */
-    get id() {
-        return this._id;
-    }
-    /**
-     * Returns all {@link module:engine/view/attributeelement~ViewAttributeElement attribute elements} that has the
-     * same {@link module:engine/view/attributeelement~ViewAttributeElement#id id} and are in the view tree (were not removed).
-     *
-     * Note: If this element has been removed from the tree, returned set will not include it.
-     *
-     * Throws {@link module:utils/ckeditorerror~CKEditorError attribute-element-get-elements-with-same-id-no-id}
-     * if this element has no `id`.
-     *
-     * @returns Set containing all the attribute elements
-     * with the same `id` that were added and not removed from the view tree.
-     */
-    getElementsWithSameId() {
-        if (this.id === null) {
-            /**
-             * Cannot get elements with the same id for an attribute element without id.
-             *
-             * @error attribute-element-get-elements-with-same-id-no-id
-             */
-            throw new CKEditorError('attribute-element-get-elements-with-same-id-no-id', this);
-        }
-        return new Set(this._clonesGroup);
-    }
-    /**
-     * Checks if this element is similar to other element.
-     *
-     * If none of elements has set {@link module:engine/view/attributeelement~ViewAttributeElement#id}, then both elements
-     * should have the same name, attributes and priority to be considered as similar. Two similar elements can contain
-     * different set of children nodes.
-     *
-     * If at least one element has {@link module:engine/view/attributeelement~ViewAttributeElement#id} set, then both
-     * elements have to have the same {@link module:engine/view/attributeelement~ViewAttributeElement#id} value to be
-     * considered similar.
-     *
-     * Similarity is important for {@link module:engine/view/downcastwriter~ViewDowncastWriter}. For example:
-     *
-     * * two following similar elements can be merged together into one, longer element,
-     * * {@link module:engine/view/downcastwriter~ViewDowncastWriter#unwrap} checks similarity of passed element and processed element to
-     * decide whether processed element should be unwrapped,
-     * * etc.
-     */
-    isSimilar(otherElement) {
-        // If any element has an `id` set, just compare the ids.
-        if (this.id !== null || otherElement.id !== null) {
-            return this.id === otherElement.id;
-        }
-        return super.isSimilar(otherElement) && this.priority == otherElement.priority;
-    }
-    /**
-     * Converts `ViewAttributeElement` instance to plain object and returns it.
-     *
-     * @returns `ViewAttributeElement` instance converted to plain object.
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.type = 'AttributeElement';
-        return json;
-    }
-    /**
-     * Clones provided element with priority.
-     *
-     * @internal
-     * @param deep If set to `true` clones element and all its children recursively. When set to `false`,
-     * element will be cloned without any children.
-     * @returns Clone of this element.
-     */
-    _clone(deep = false) {
-        const cloned = super._clone(deep);
-        // Clone priority too.
-        cloned._priority = this._priority;
-        // And id too.
-        cloned._id = this._id;
-        return cloned;
-    }
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_mergeAttributesFrom} to verify if the given element can be merged without
-     * conflicts into this element.
-     *
-     * @internal
-     */
-    _canMergeAttributesFrom(otherElement) {
-        // Can't merge if any of elements have an id or a difference of priority.
-        if (this.id !== null || otherElement.id !== null || this.priority !== otherElement.priority) {
-            return false;
-        }
-        return super._canMergeAttributesFrom(otherElement);
-    }
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_subtractAttributesOf} to verify if the given element attributes
-     * can be fully subtracted from this element.
-     *
-     * @internal
-     */
-    _canSubtractAttributesOf(otherElement) {
-        // Can't subtract if any of elements have an id or a difference of priority.
-        if (this.id !== null || otherElement.id !== null || this.priority !== otherElement.priority) {
-            return false;
-        }
-        return super._canSubtractAttributesOf(otherElement);
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-ViewAttributeElement.prototype.is = function (type, name) {
-    if (!name) {
-        return type === 'attributeElement' || type === 'view:attributeElement' ||
-            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-            type === 'element' || type === 'view:element' ||
-            type === 'node' || type === 'view:node';
-    }
-    else {
-        return name === this.name && (type === 'attributeElement' || type === 'view:attributeElement' ||
-            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-            type === 'element' || type === 'view:element');
-    }
-};
-/**
- * Returns block {@link module:engine/view/filler~Filler filler} offset or `null` if block filler is not needed.
- *
- * @returns Block filler offset or `null` if block filler is not needed.
- */
-function getFillerOffset() {
-    // <b>foo</b> does not need filler.
-    if (nonUiChildrenCount(this)) {
-        return null;
-    }
-    let element = this.parent;
-    // <p><b></b></p> needs filler -> <p><b><br></b></p>
-    while (element && element.is('attributeElement')) {
-        if (nonUiChildrenCount(element) > 1) {
-            return null;
-        }
-        element = element.parent;
-    }
-    if (!element || nonUiChildrenCount(element) > 1) {
-        return null;
-    }
-    // Render block filler at the end of element (after all ui elements).
-    return this.childCount;
-}
-/**
- * Returns total count of children that are not {@link module:engine/view/uielement~ViewUIElement UIElements}.
- */
-function nonUiChildrenCount(element) {
-    return Array.from(element.getChildren()).filter(element => !element.is('uiElement')).length;
-}

package/src/view/containerelement.js

@@ -1,91 +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/containerelement
- */
-import { ViewElement } from './element.js';
-/**
- * Containers are elements which define document structure. They define boundaries for
- * {@link module:engine/view/attributeelement~ViewAttributeElement attributes}.
- * They are mostly used for block elements like `<p>` or `<div>`.
- *
- * Editing engine does not define a fixed HTML DTD. This is why a feature developer needs to choose between various
- * types (container element, {@link module:engine/view/attributeelement~ViewAttributeElement attribute element},
- * {@link module:engine/view/emptyelement~ViewEmptyElement empty element}, etc) when developing a feature.
- *
- * The container element should be your default choice when writing a converter, unless:
- *
- * * this element represents a model text attribute (then use {@link module:engine/view/attributeelement~ViewAttributeElement}),
- * * this is an empty element like `<img>` (then use {@link module:engine/view/emptyelement~ViewEmptyElement}),
- * * this is a root element,
- * * this is a nested editable element (then use  {@link module:engine/view/editableelement~ViewEditableElement}).
- *
- * To create a new container element instance use the
- * {@link module:engine/view/downcastwriter~ViewDowncastWriter#createContainerElement `ViewDowncastWriter#createContainerElement()`}
- * method.
- */
-export class ViewContainerElement extends ViewElement {
-    /**
-     * Creates a container element.
-     *
-     * @see module:engine/view/downcastwriter~ViewDowncastWriter#createContainerElement
-     * @see module:engine/view/element~ViewElement
-     * @internal
-     * @param document The document instance to which this element belongs.
-     * @param name Node name.
-     * @param attrs Collection of attributes.
-     * @param children A list of nodes to be inserted into created element.
-     */
-    constructor(document, name, attrs, children) {
-        super(document, name, attrs, children);
-        this.getFillerOffset = getViewFillerOffset;
-    }
-    /**
-     * Converts `ViewContainerElement` instance to plain object and returns it.
-     *
-     * @returns `ViewContainerElement` instance converted to plain object.
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.type = 'ContainerElement';
-        return json;
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-ViewContainerElement.prototype.is = function (type, name) {
-    if (!name) {
-        return type === 'containerElement' || type === 'view:containerElement' ||
-            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-            type === 'element' || type === 'view:element' ||
-            type === 'node' || type === 'view:node';
-    }
-    else {
-        return name === this.name && (type === 'containerElement' || type === 'view:containerElement' ||
-            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-            type === 'element' || type === 'view:element');
-    }
-};
-/**
- * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
- *
- * @returns Block filler offset or `null` if block filler is not needed.
- */
-export function getViewFillerOffset() {
-    const children = [...this.getChildren()];
-    const lastChild = children[this.childCount - 1];
-    // Block filler is required after a `<br>` if it's the last element in its container. See #1422.
-    if (lastChild && lastChild.is('element', 'br')) {
-        return this.childCount;
-    }
-    for (const child of children) {
-        // If there's any non-UI element – don't render the bogus.
-        if (!child.is('uiElement')) {
-            return null;
-        }
-    }
-    // If there are only UI elements – render the bogus at the end of the element.
-    return this.childCount;
-}

package/src/view/datatransfer.js

@@ -1,106 +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
- */
-/**
- * A facade over the native [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object.
- */
-export class ViewDataTransfer {
-    /**
-     * The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
-     */
-    _files;
-    /**
-     * The native DataTransfer object.
-     */
-    _native;
-    /**
-     * @param nativeDataTransfer The native [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object.
-     * @param options.cacheFiles Whether `files` list should be initialized in the constructor.
-     */
-    constructor(nativeDataTransfer, options = {}) {
-        // We should store references to the File instances in case someone would like to process this files
-        // outside the event handler. Files are stored only for `drop` and `paste` events because they are not usable
-        // in other events and are generating a huge delay on Firefox while dragging.
-        // See https://github.com/ckeditor/ckeditor5/issues/13366.
-        this._files = options.cacheFiles ? getFiles(nativeDataTransfer) : null;
-        this._native = nativeDataTransfer;
-    }
-    /**
-     * The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
-     */
-    get files() {
-        if (!this._files) {
-            this._files = getFiles(this._native);
-        }
-        return this._files;
-    }
-    /**
-     * Returns an array of available native content types.
-     */
-    get types() {
-        return this._native.types;
-    }
-    /**
-     * Gets the data from the data transfer by its MIME type.
-     *
-     * ```ts
-     * dataTransfer.getData( 'text/plain' );
-     * ```
-     *
-     * @param type The MIME type. E.g. `text/html` or `text/plain`.
-     */
-    getData(type) {
-        return this._native.getData(type);
-    }
-    /**
-     * Sets the data in the data transfer.
-     *
-     * @param type The MIME type. E.g. `text/html` or `text/plain`.
-     */
-    setData(type, data) {
-        this._native.setData(type, data);
-    }
-    /**
-     * The effect that is allowed for a drag operation.
-     */
-    set effectAllowed(value) {
-        this._native.effectAllowed = value;
-    }
-    get effectAllowed() {
-        return this._native.effectAllowed;
-    }
-    /**
-     * The actual drop effect.
-     */
-    set dropEffect(value) {
-        this._native.dropEffect = value;
-    }
-    get dropEffect() {
-        return this._native.dropEffect;
-    }
-    /**
-     * Set a preview image of the dragged content.
-     */
-    setDragImage(image, x, y) {
-        this._native.setDragImage(image, x, y);
-    }
-    /**
-     * Whether the dragging operation was canceled.
-     */
-    get isCanceled() {
-        return this._native.dropEffect == 'none' || !!this._native.mozUserCancelled;
-    }
-}
-function getFiles(nativeDataTransfer) {
-    // DataTransfer.files and items are array-like and might not have an iterable interface.
-    const files = Array.from(nativeDataTransfer.files || []);
-    const items = Array.from(nativeDataTransfer.items || []);
-    if (files.length) {
-        return files;
-    }
-    // Chrome has empty DataTransfer.files, but allows getting files through the items interface.
-    return items
-        .filter(item => item.kind === 'file')
-        .map(item => item.getAsFile());
-}

package/src/view/document.js

@@ -1,139 +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/document
- */
-import { ViewDocumentSelection } from './documentselection.js';
-import { BubblingEmitterMixin } from './observer/bubblingemittermixin.js';
-import { Collection, ObservableMixin } from '@ckeditor/ckeditor5-utils';
-// @if CK_DEBUG_ENGINE // const { logDocument } = require( '../dev-utils/utils' );
-/**
- * Document class creates an abstract layer over the content editable area, contains a tree of view elements and
- * {@link module:engine/view/documentselection~ViewDocumentSelection view selection} associated with this document.
- */
-export class ViewDocument extends /* #__PURE__ */ BubblingEmitterMixin(/* #__PURE__ */ ObservableMixin()) {
-    /**
-     * Selection done on this document.
-     */
-    selection;
-    /**
-     * Roots of the view tree. Collection of the {@link module:engine/view/element~ViewElement view elements}.
-     *
-     * View roots are created as a result of binding between {@link module:engine/view/document~ViewDocument#roots} and
-     * {@link module:engine/model/document~ModelDocument#roots} and this is handled by
-     * {@link module:engine/controller/editingcontroller~EditingController}, so to create view root we need to create
-     * model root using {@link module:engine/model/document~ModelDocument#createRoot}.
-     */
-    roots;
-    /**
-     * The styles processor instance used by this document when normalizing styles.
-     */
-    stylesProcessor;
-    /**
-     * Post-fixer callbacks registered to the view document.
-     */
-    _postFixers = new Set();
-    /**
-     * Creates a Document instance.
-     *
-     * @param stylesProcessor The styles processor instance.
-     */
-    constructor(stylesProcessor) {
-        super();
-        this.selection = new ViewDocumentSelection();
-        this.roots = new Collection({ idProperty: 'rootName' });
-        this.stylesProcessor = stylesProcessor;
-        this.set('isReadOnly', false);
-        this.set('isFocused', false);
-        this.set('isSelecting', false);
-        this.set('isComposing', false);
-    }
-    /**
-     * Gets a {@link module:engine/view/document~ViewDocument#roots view root element} with the specified name. If the name is not
-     * specific "main" root is returned.
-     *
-     * @param name Name of the root.
-     * @returns The view root element with the specified name or null when there is no root of given name.
-     */
-    getRoot(name = 'main') {
-        return this.roots.get(name);
-    }
-    /**
-     * Allows registering post-fixer callbacks. A post-fixers mechanism allows to update the view tree just before it is rendered
-     * to the DOM.
-     *
-     * Post-fixers are executed right after all changes from the outermost change block were applied but
-     * before the {@link module:engine/view/view~EditingView#event:render render event} is fired. If a post-fixer callback made
-     * a change, it should return `true`. When this happens, all post-fixers are fired again to check if something else should
-     * not be fixed in the new document tree state.
-     *
-     * View post-fixers are useful when you want to apply some fixes whenever the view structure changes. Keep in mind that
-     * changes executed in a view post-fixer should not break model-view mapping.
-     *
-     * The types of changes which should be safe:
-     *
-     * * adding or removing attribute from elements,
-     * * changes inside of {@link module:engine/view/uielement~ViewUIElement UI elements},
-     * * {@link module:engine/controller/editingcontroller~EditingController#reconvertItem marking some of the model elements to be
-     * re-converted}.
-     *
-     * Try to avoid changes which touch view structure:
-     *
-     * * you should not add or remove nor wrap or unwrap any view elements,
-     * * you should not change the editor data model in a view post-fixer.
-     *
-     * As a parameter, a post-fixer callback receives a {@link module:engine/view/downcastwriter~ViewDowncastWriter downcast writer}.
-     *
-     * Typically, a post-fixer will look like this:
-     *
-     * ```ts
-     * editor.editing.view.document.registerPostFixer( writer => {
-     * 	if ( checkSomeCondition() ) {
-     * 		writer.doSomething();
-     *
-     * 		// Let other post-fixers know that something changed.
-     * 		return true;
-     * 	}
-     *
-     * 	return false;
-     * } );
-     * ```
-     *
-     * Note that nothing happens right after you register a post-fixer (e.g. execute such a code in the console).
-     * That is because adding a post-fixer does not execute it.
-     * The post-fixer will be executed as soon as any change in the document needs to cause its rendering.
-     * If you want to re-render the editor's view after registering the post-fixer then you should do it manually by calling
-     * {@link module:engine/view/view~EditingView#forceRender `view.forceRender()`}.
-     *
-     * If you need to register a callback which is executed when DOM elements are already updated,
-     * use {@link module:engine/view/view~EditingView#event:render render event}.
-     */
-    registerPostFixer(postFixer) {
-        this._postFixers.add(postFixer);
-    }
-    /**
-     * Destroys this instance. Makes sure that all observers are destroyed and listeners removed.
-     */
-    destroy() {
-        this.roots.forEach(root => root.destroy());
-        this.stopListening();
-    }
-    /**
-     * Performs post-fixer loops. Executes post-fixer callbacks as long as none of them has done any changes to the model.
-     *
-     * @internal
-     */
-    _callPostFixers(writer) {
-        let wasFixed = false;
-        do {
-            for (const callback of this._postFixers) {
-                wasFixed = callback(writer);
-                if (wasFixed) {
-                    break;
-                }
-            }
-        } while (wasFixed);
-    }
-}