@ckeditor/ckeditor5-engine 44.1.0-alpha.5 → 44.2.0-alpha.0

package/dist/view/attributeelement.d.ts

@@ -1,112 +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/attributeelement
- */
-import Element, { type ElementAttributes } from './element.js';
-import type Document from './document.js';
-import type Node from './node.js';
-/**
- * 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~AttributeElement attribute element},
- * {@link module:engine/view/emptyelement~EmptyElement empty element}, etc) when developing a feature.
- *
- * To create a new attribute element instance use the
- * {@link module:engine/view/downcastwriter~DowncastWriter#createAttributeElement `DowncastWriter#createAttributeElement()`} method.
- */
-export default class AttributeElement extends Element {
-    static readonly DEFAULT_PRIORITY: number;
-    /**
-     * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~DowncastWriter}.
-     *
-     * @internal
-     * @readonly
-     */
-    _priority: number;
-    /**
-     * Element identifier. If set, it is used by {@link module:engine/view/element~Element#isSimilar},
-     * and then two elements are considered similar if, and only if they have the same `_id`.
-     *
-     * @internal
-     * @readonly
-     */
-    _id: string | number | null;
-    /**
-     * Keeps all the attribute elements that have the same {@link module:engine/view/attributeelement~AttributeElement#id ids}
-     * and still exist in the view tree.
-     *
-     * This property is managed by {@link module:engine/view/downcastwriter~DowncastWriter}.
-     */
-    private readonly _clonesGroup;
-    /**
-     * Creates an attribute element.
-     *
-     * @see module:engine/view/downcastwriter~DowncastWriter#createAttributeElement
-     * @see module:engine/view/element~Element
-     * @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: Document, name: string, attrs?: ElementAttributes, children?: Node | Iterable<Node>);
-    /**
-     * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~DowncastWriter}.
-     */
-    get priority(): number;
-    /**
-     * Element identifier. If set, it is used by {@link module:engine/view/element~Element#isSimilar},
-     * and then two elements are considered similar if, and only if they have the same `id`.
-     */
-    get id(): string | number | null;
-    /**
-     * Returns all {@link module:engine/view/attributeelement~AttributeElement attribute elements} that has the
-     * same {@link module:engine/view/attributeelement~AttributeElement#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(): Set<AttributeElement>;
-    /**
-     * Checks if this element is similar to other element.
-     *
-     * If none of elements has set {@link module:engine/view/attributeelement~AttributeElement#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~AttributeElement#id} set, then both
-     * elements have to have the same {@link module:engine/view/attributeelement~AttributeElement#id} value to be
-     * considered similar.
-     *
-     * Similarity is important for {@link module:engine/view/downcastwriter~DowncastWriter}. For example:
-     *
-     * * two following similar elements can be merged together into one, longer element,
-     * * {@link module:engine/view/downcastwriter~DowncastWriter#unwrap} checks similarity of passed element and processed element to
-     * decide whether processed element should be unwrapped,
-     * * etc.
-     */
-    isSimilar(otherElement: Element): boolean;
-    /**
-     * 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?: boolean): this;
-}

package/dist/view/containerelement.d.ts

@@ -1,53 +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/containerelement
- */
-import Element, { type ElementAttributes } from './element.js';
-import type Document from './document.js';
-import type Node from './node.js';
-/**
- * Containers are elements which define document structure. They define boundaries for
- * {@link module:engine/view/attributeelement~AttributeElement 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~AttributeElement attribute element},
- * {@link module:engine/view/emptyelement~EmptyElement 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~AttributeElement}),
- * * this is an empty element like `<img>` (then use {@link module:engine/view/emptyelement~EmptyElement}),
- * * this is a root element,
- * * this is a nested editable element (then use  {@link module:engine/view/editableelement~EditableElement}).
- *
- * To create a new container element instance use the
- * {@link module:engine/view/downcastwriter~DowncastWriter#createContainerElement `DowncastWriter#createContainerElement()`}
- * method.
- */
-export default class ContainerElement extends Element {
-    /**
-     * Creates a container element.
-     *
-     * @see module:engine/view/downcastwriter~DowncastWriter#createContainerElement
-     * @see module:engine/view/element~Element
-     * @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: Document, name: string, attrs?: ElementAttributes, children?: Node | Iterable<Node>);
-}
-/**
- * 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 declare function getFillerOffset(this: ContainerElement): number | null;

package/dist/view/datatransfer.d.ts

@@ -1,83 +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/datatransfer
- */
-type DomDataTransfer = globalThis.DataTransfer;
-/**
- * A facade over the native [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object.
- */
-export default class DataTransfer {
-    /**
-     * The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
-     */
-    private _files;
-    /**
-     * The native DataTransfer object.
-     */
-    private _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: DomDataTransfer, options?: {
-        cacheFiles?: boolean;
-    });
-    /**
-     * The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
-     */
-    get files(): Array<File>;
-    /**
-     * Returns an array of available native content types.
-     */
-    get types(): ReadonlyArray<string>;
-    /**
-     * 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: string): string;
-    /**
-     * Sets the data in the data transfer.
-     *
-     * @param type The MIME type. E.g. `text/html` or `text/plain`.
-     */
-    setData(type: string, data: string): void;
-    /**
-     * The effect that is allowed for a drag operation.
-     */
-    set effectAllowed(value: EffectAllowed);
-    get effectAllowed(): EffectAllowed;
-    /**
-     * The actual drop effect.
-     */
-    set dropEffect(value: DropEffect);
-    get dropEffect(): DropEffect;
-    /**
-     * Set a preview image of the dragged content.
-     */
-    setDragImage(image: Element, x: number, y: number): void;
-    /**
-     * Whether the dragging operation was canceled.
-     */
-    get isCanceled(): boolean;
-}
-/**
- * The effect that is allowed for a drag operation.
- */
-export type EffectAllowed = DomDataTransfer['effectAllowed'];
-/**
- * The actual drop effect.
- */
-export type DropEffect = DomDataTransfer['dropEffect'];
-export {};

package/dist/view/document.d.ts

@@ -1,188 +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/document
- */
-import DocumentSelection from './documentselection.js';
-import { Collection } from '@ckeditor/ckeditor5-utils';
-import type { StylesProcessor } from './stylesmap.js';
-import type RootEditableElement from './rooteditableelement.js';
-import type DowncastWriter from './downcastwriter.js';
-declare const Document_base: import("@ckeditor/ckeditor5-utils").Mixed<{
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-}, import("@ckeditor/ckeditor5-utils").Emitter>;
-/**
- * Document class creates an abstract layer over the content editable area, contains a tree of view elements and
- * {@link module:engine/view/documentselection~DocumentSelection view selection} associated with this document.
- */
-export default class Document extends /* #__PURE__ */ Document_base {
-    /**
-     * Selection done on this document.
-     */
-    readonly selection: DocumentSelection;
-    /**
-     * Roots of the view tree. Collection of the {@link module:engine/view/element~Element view elements}.
-     *
-     * View roots are created as a result of binding between {@link module:engine/view/document~Document#roots} and
-     * {@link module:engine/model/document~Document#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~Document#createRoot}.
-     */
-    readonly roots: Collection<RootEditableElement>;
-    /**
-     * The styles processor instance used by this document when normalizing styles.
-     */
-    readonly stylesProcessor: StylesProcessor;
-    /**
-     * Defines whether document is in read-only mode.
-     *
-     * When document is read-ony then all roots are read-only as well and caret placed inside this root is hidden.
-     *
-     * @observable
-     */
-    isReadOnly: boolean;
-    /**
-     * True if document is focused.
-     *
-     * This property is updated by the {@link module:engine/view/observer/focusobserver~FocusObserver}.
-     * If the {@link module:engine/view/observer/focusobserver~FocusObserver} is disabled this property will not change.
-     *
-     * @readonly
-     * @observable
-     */
-    isFocused: boolean;
-    /**
-     * `true` while the user is making a selection in the document (e.g. holding the mouse button and moving the cursor).
-     * When they stop selecting, the property goes back to `false`.
-     *
-     * This property is updated by the {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
-     *
-     * @readonly
-     * @observable
-     */
-    isSelecting: boolean;
-    /**
-     * True if composition is in progress inside the document.
-     *
-     * This property is updated by the {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
-     * If the {@link module:engine/view/observer/compositionobserver~CompositionObserver} is disabled this property will not change.
-     *
-     * @readonly
-     * @observable
-     */
-    isComposing: boolean;
-    /**
-     * Post-fixer callbacks registered to the view document.
-     */
-    private readonly _postFixers;
-    /**
-     * Creates a Document instance.
-     *
-     * @param stylesProcessor The styles processor instance.
-     */
-    constructor(stylesProcessor: StylesProcessor);
-    /**
-     * Gets a {@link module:engine/view/document~Document#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?: string): RootEditableElement | null;
-    /**
-     * 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~View#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~UIElement 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~DowncastWriter 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~View#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~View#event:render render event}.
-     */
-    registerPostFixer(postFixer: ViewDocumentPostFixer): void;
-    /**
-     * Destroys this instance. Makes sure that all observers are destroyed and listeners removed.
-     */
-    destroy(): void;
-    /**
-     * Performs post-fixer loops. Executes post-fixer callbacks as long as none of them has done any changes to the model.
-     *
-     * @internal
-     */
-    _callPostFixers(writer: DowncastWriter): void;
-}
-/**
- * Document PostFixer.
- *
- * @see module:engine/view/document~Document#registerPostFixer
- */
-export type ViewDocumentPostFixer = (writer: DowncastWriter) => boolean;
-/**
- * Enum representing type of the change.
- *
- * Possible values:
- *
- * * `children` - for child list changes,
- * * `attributes` - for element attributes changes,
- * * `text` - for text nodes changes.
- */
-export type ChangeType = 'children' | 'attributes' | 'text';
-/**
- * Event fired whenever document content layout changes. It is fired whenever content is
- * {@link module:engine/view/view~View#event:render rendered}, but should be also fired by observers in case of
- * other actions which may change layout, for instance when image loads.
- *
- * @eventName ~Document#layoutChanged
- */
-export type ViewDocumentLayoutChangedEvent = {
-    name: 'layoutChanged';
-    args: [];
-};
-export {};

package/dist/view/documentfragment.d.ts

@@ -1,157 +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/documentfragment
- */
-import TypeCheckable from './typecheckable.js';
-import type { default as Document, ChangeType } from './document.js';
-import type Item from './item.js';
-import type Node from './node.js';
-declare const DocumentFragment_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
-/**
- * Document fragment.
- *
- * To create a new document fragment instance use the
- * {@link module:engine/view/upcastwriter~UpcastWriter#createDocumentFragment `UpcastWriter#createDocumentFragment()`}
- * method.
- */
-export default class DocumentFragment extends /* #__PURE__ */ DocumentFragment_base implements Iterable<Node> {
-    /**
-     * The document to which this document fragment belongs.
-     */
-    readonly document: Document;
-    /**
-     * Array of child nodes.
-     */
-    private readonly _children;
-    /**
-     * Map of custom properties.
-     * Custom properties can be added to document fragment instance.
-     */
-    private readonly _customProperties;
-    /**
-     * Creates new DocumentFragment instance.
-     *
-     * @internal
-     * @param document The document to which this document fragment belongs.
-     * @param children A list of nodes to be inserted into the created document fragment.
-     */
-    constructor(document: Document, children?: Node | Iterable<Node>);
-    /**
-     * Iterable interface.
-     *
-     * Iterates over nodes added to this document fragment.
-     */
-    [Symbol.iterator](): Iterator<Node>;
-    /**
-     * Number of child nodes in this document fragment.
-     */
-    get childCount(): number;
-    /**
-     * Is `true` if there are no nodes inside this document fragment, `false` otherwise.
-     */
-    get isEmpty(): boolean;
-    /**
-     * Artificial root of `DocumentFragment`. Returns itself. Added for compatibility reasons.
-     */
-    get root(): this;
-    /**
-     * Artificial parent of `DocumentFragment`. Returns `null`. Added for compatibility reasons.
-     */
-    get parent(): null;
-    /**
-     * Artificial element name. Returns `undefined`. Added for compatibility reasons.
-     */
-    get name(): undefined;
-    /**
-     * Artificial element getFillerOffset. Returns `undefined`. Added for compatibility reasons.
-     */
-    get getFillerOffset(): undefined;
-    /**
-     * Returns the custom property value for the given key.
-     */
-    getCustomProperty(key: string | symbol): unknown;
-    /**
-     * Returns an iterator which iterates over this document fragment's custom properties.
-     * Iterator provides `[ key, value ]` pairs for each stored property.
-     */
-    getCustomProperties(): Iterable<[string | symbol, unknown]>;
-    /**
-     * {@link module:engine/view/documentfragment~DocumentFragment#_insertChild Insert} a child node or a list of child nodes at the end
-     * and sets the parent of these nodes to this fragment.
-     *
-     * @internal
-     * @param items Items to be inserted.
-     * @returns Number of appended nodes.
-     */
-    _appendChild(items: Item | string | Iterable<Item | string>): number;
-    /**
-     * Gets child at the given index.
-     *
-     * @param index Index of child.
-     * @returns Child node.
-     */
-    getChild(index: number): Node;
-    /**
-     * Gets index of the given child node. Returns `-1` if child node is not found.
-     *
-     * @param node Child node.
-     * @returns Index of the child node.
-     */
-    getChildIndex(node: Node): number;
-    /**
-     * Gets child nodes iterator.
-     *
-     * @returns Child nodes iterator.
-     */
-    getChildren(): IterableIterator<Node>;
-    /**
-     * Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to
-     * this fragment.
-     *
-     * @internal
-     * @param index Position where nodes should be inserted.
-     * @param items Items to be inserted.
-     * @returns Number of inserted nodes.
-     */
-    _insertChild(index: number, items: Item | string | Iterable<Item | string>): number;
-    /**
-     * Removes number of child nodes starting at the given index and set the parent of these nodes to `null`.
-     *
-     * @internal
-     * @param index Number of the first node to remove.
-     * @param howMany Number of nodes to remove.
-     * @returns The array of removed nodes.
-     */
-    _removeChildren(index: number, howMany?: number): Array<Node>;
-    /**
-     * Fires `change` event with given type of the change.
-     *
-     * @internal
-     * @param type Type of the change.
-     * @param node Changed node.
-     */
-    _fireChange(type: ChangeType, node: Node | DocumentFragment): void;
-    /**
-     * Sets a custom property. They can be used to add special data to elements.
-     *
-     * @see module:engine/view/downcastwriter~DowncastWriter#setCustomProperty
-     * @internal
-     */
-    _setCustomProperty(key: string | symbol, value: unknown): void;
-    /**
-     * Removes the custom property stored under the given key.
-     *
-     * @see module:engine/view/downcastwriter~DowncastWriter#removeCustomProperty
-     * @internal
-     * @returns Returns true if property was removed.
-     */
-    _removeCustomProperty(key: string | symbol): boolean;
-}
-export {};