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

package/dist/model/operation/markeroperation.d.ts

@@ -1,95 +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/model/operation/markeroperation
- */
-import Operation from './operation.js';
-import Range from '../range.js';
-import type Document from '../document.js';
-import type MarkerCollection from '../markercollection.js';
-import type { Selectable } from '../selection.js';
-export default class MarkerOperation extends Operation {
-    /**
-     * Marker name.
-     *
-     * @readonly
-     */
-    name: string;
-    /**
-     * Marker range before the change.
-     *
-     * @readonly
-     */
-    oldRange: Range | null;
-    /**
-     * Marker range after the change.
-     *
-     * @readonly
-     */
-    newRange: Range | null;
-    /**
-     * Specifies whether the marker operation affects the data produced by the data pipeline
-     * (is persisted in the editor's data).
-     *
-     * @readonly
-     */
-    affectsData: boolean;
-    /**
-     * Marker collection on which change should be executed.
-     */
-    private readonly _markers;
-    /**
-     * @param name Marker name.
-     * @param oldRange Marker range before the change.
-     * @param newRange Marker range after the change.
-     * @param markers Marker collection on which change should be executed.
-     * @param affectsData Specifies whether the marker operation affects the data produced by the data pipeline
-     * (is persisted in the editor's data).
-     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(name: string, oldRange: Range | null, newRange: Range | null, markers: MarkerCollection, affectsData: boolean, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'marker';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone(): MarkerOperation;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-    /**
-     * Creates `MarkerOperation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): MarkerOperation;
-}

package/dist/model/operation/mergeoperation.d.ts

@@ -1,104 +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/model/operation/mergeoperation
- */
-import Operation from './operation.js';
-import Position from '../position.js';
-import Range from '../range.js';
-import type Document from '../document.js';
-import type { Selectable } from '../selection.js';
-/**
- * Operation to merge two {@link module:engine/model/element~Element elements}.
- *
- * The merged element is the parent of {@link ~MergeOperation#sourcePosition} and it is merged into the parent of
- * {@link ~MergeOperation#targetPosition}. All nodes from the merged element are moved to {@link ~MergeOperation#targetPosition}.
- *
- * The merged element is moved to the graveyard at {@link ~MergeOperation#graveyardPosition}.
- */
-export default class MergeOperation extends Operation {
-    /**
-     * Position inside the merged element. All nodes from that element after that position will be moved to {@link #targetPosition}.
-     */
-    sourcePosition: Position;
-    /**
-     * Summary offset size of nodes which will be moved from the merged element to the new parent.
-     */
-    howMany: number;
-    /**
-     * Position which the nodes from the merged elements will be moved to.
-     */
-    targetPosition: Position;
-    /**
-     * Position in graveyard to which the merged element will be moved.
-     */
-    graveyardPosition: Position;
-    /**
-     * Creates a merge operation.
-     *
-     * @param sourcePosition Position inside the merged element. All nodes from that
-     * element after that position will be moved to {@link #targetPosition}.
-     * @param howMany Summary offset size of nodes which will be moved from the merged element to the new parent.
-     * @param targetPosition Position which the nodes from the merged elements will be moved to.
-     * @param graveyardPosition Position in graveyard to which the merged element will be moved.
-     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(sourcePosition: Position, howMany: number, targetPosition: Position, graveyardPosition: Position, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'merge';
-    /**
-     * Position before the merged element (which will be deleted).
-     */
-    get deletionPosition(): Position;
-    /**
-     * Artificial range that contains all the nodes from the merged element that will be moved to {@link ~MergeOperation#sourcePosition}.
-     * The range starts at {@link ~MergeOperation#sourcePosition} and ends in the same parent, at `POSITIVE_INFINITY` offset.
-     */
-    get movedRange(): Range;
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone(): MergeOperation;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-    /**
-     * Creates `MergeOperation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): MergeOperation;
-}

package/dist/model/operation/moveoperation.d.ts

@@ -1,100 +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/model/operation/moveoperation
- */
-import Operation from './operation.js';
-import Position from '../position.js';
-import type { Selectable } from '../selection.js';
-import type Document from '../document.js';
-/**
- * Operation to move a range of {@link module:engine/model/item~Item model items}
- * to given {@link module:engine/model/position~Position target position}.
- */
-export default class MoveOperation extends Operation {
-    /**
-     * Position before the first {@link module:engine/model/item~Item model item} to move.
-     */
-    sourcePosition: Position;
-    /**
-     * Offset size of moved range.
-     */
-    howMany: number;
-    /**
-     * Position at which moved nodes will be inserted.
-     */
-    targetPosition: Position;
-    /**
-     * Creates a move operation.
-     *
-     * @param sourcePosition Position before the first {@link module:engine/model/item~Item model item} to move.
-     * @param howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
-     * `sourcePosition` with offset shifted by `howMany`.
-     * @param targetPosition Position at which moved nodes will be inserted.
-     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(sourcePosition: Position, howMany: number, targetPosition: Position, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'move' | 'remove' | 'reinsert';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone(): MoveOperation;
-    /**
-     * Returns the start position of the moved range after it got moved. This may be different than
-     * {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition} in some cases, i.e. when a range is moved
-     * inside the same parent but {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition targetPosition}
-     * is after {@link module:engine/model/operation/moveoperation~MoveOperation#sourcePosition sourcePosition}.
-     *
-     * ```
-     *  vv              vv
-     * abcdefg ===> adefbcg
-     *      ^          ^
-     *      targetPos  movedRangeStart
-     *      offset 6   offset 4
-     *```
-     */
-    getMovedRangeStart(): Position;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-    /**
-     * Creates `MoveOperation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): MoveOperation;
-}

package/dist/model/operation/nooperation.d.ts

@@ -1,42 +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/model/operation/nooperation
- */
-import Operation from './operation.js';
-import type { Selectable } from '../selection.js';
-/**
- * Operation which is doing nothing ("empty operation", "do-nothing operation", "noop"). This is an operation,
- * which when executed does not change the tree model. It still has some parameters defined for transformation purposes.
- *
- * In most cases this operation is a result of transforming operations. When transformation returns
- * {@link module:engine/model/operation/nooperation~NoOperation} it means that changes done by the transformed operation
- * have already been applied.
- */
-export default class NoOperation extends Operation {
-    get type(): 'noop';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone(): NoOperation;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /** @internal */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-}

package/dist/model/operation/operation.d.ts

@@ -1,100 +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/model/operation/operation
- */
-import type Batch from '../batch.js';
-import type Document from '../document.js';
-import type { Selectable } from '../selection.js';
-/**
- * Abstract base operation class.
- */
-export default abstract class Operation {
-    /**
-     * {@link module:engine/model/document~Document#version} on which operation can be applied. If you try to
-     * {@link module:engine/model/model~Model#applyOperation apply} operation with different base version than the
-     * {@link module:engine/model/document~Document#version document version} the
-     * {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown.
-     */
-    baseVersion: number | null;
-    /**
-     * Defines whether operation is executed on attached or detached {@link module:engine/model/item~Item items}.
-     */
-    readonly isDocumentOperation: boolean;
-    /**
-     * {@link module:engine/model/batch~Batch Batch} to which the operation is added or `null` if the operation is not
-     * added to any batch yet.
-     */
-    batch: Batch | null;
-    /**
-     * Operation type.
-     */
-    abstract readonly type: string;
-    /**
-     * Base operation constructor.
-     *
-     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(baseVersion: number | null);
-    /**
-     * A selectable that will be affected by the operation after it is executed.
-     *
-     * The exact returned parameter differs between operation types.
-     */
-    abstract get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns Clone of this operation.
-     */
-    abstract clone(): Operation;
-    /**
-     * Creates and returns a reverse operation. Reverse operation when executed right after
-     * the original operation will bring back tree model state to the point before the original
-     * operation execution. In other words, it reverses changes done by the original operation.
-     *
-     * Keep in mind that tree model state may change since executing the original operation,
-     * so reverse operation will be "outdated". In that case you will need to transform it by
-     * all operations that were executed after the original operation.
-     *
-     * @returns Reversed operation.
-     */
-    abstract getReversed(): Operation;
-    /**
-     * Executes the operation - modifications described by the operation properties will be applied to the model tree.
-     *
-     * @internal
-     */
-    abstract _execute(): void;
-    /**
-     * Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws
-     * an error if operation is not valid.
-     *
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * Custom toJSON method to solve child-parent circular dependencies.
-     *
-     * @returns Clone of this object with the operation property replaced with string.
-     */
-    toJSON(): unknown;
-    /**
-     * Name of the operation class used for serialization.
-     */
-    static get className(): string;
-    /**
-     * Creates `Operation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param doc Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): Operation;
-}

package/dist/model/operation/operationfactory.d.ts

@@ -1,22 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import Operation from './operation.js';
-import type Document from '../document.js';
-/**
- * A factory class for creating operations.
- */
-export default abstract class OperationFactory {
-    /**
-     * Creates an operation instance from a JSON object (parsed JSON string).
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): Operation;
-}

package/dist/model/operation/renameoperation.d.ts

@@ -1,87 +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/model/operation/renameoperation
- */
-import Operation from './operation.js';
-import Position from '../position.js';
-import type Document from '../document.js';
-import type { Selectable } from '../selection.js';
-/**
- * Operation to change element's name.
- *
- * Using this class you can change element's name.
- */
-export default class RenameOperation extends Operation {
-    /**
-     * Position before an element to change.
-     */
-    position: Position;
-    /**
-     * Current name of the element.
-     */
-    oldName: string;
-    /**
-     * New name for the element.
-     */
-    newName: string;
-    /**
-     * Creates an operation that changes element's name.
-     *
-     * @param position Position before an element to change.
-     * @param oldName Current name of the element.
-     * @param newName New name for the element.
-     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(position: Position, oldName: string, newName: string, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'rename';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns Clone of this operation.
-     */
-    clone(): RenameOperation;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-    /**
-     * Creates `RenameOperation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): RenameOperation;
-}

package/dist/model/operation/rootattributeoperation.d.ts

@@ -1,102 +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/model/operation/rootattributeoperation
- */
-import Operation from './operation.js';
-import type Document from '../document.js';
-import type RootElement from '../rootelement.js';
-import type { Selectable } from '../selection.js';
-/**
- * Operation to change root element's attribute. Using this class you can add, remove or change value of the attribute.
- *
- * This operation is needed, because root elements can't be changed through
- * {@link module:engine/model/operation/attributeoperation~AttributeOperation}.
- * It is because {@link module:engine/model/operation/attributeoperation~AttributeOperation}
- * requires a range to change and root element can't
- * be a part of range because every {@link module:engine/model/position~Position} has to be inside a root.
- * {@link module:engine/model/position~Position} can't be created before a root element.
- */
-export default class RootAttributeOperation extends Operation {
-    /**
-     * Root element to change.
-     */
-    readonly root: RootElement;
-    /**
-     * Key of an attribute to change or remove.
-     */
-    readonly key: string;
-    /**
-     * Old value of the attribute with given key or `null`, if attribute was not set before.
-     *
-     * @readonly
-     */
-    oldValue: unknown;
-    /**
-     * New value of the attribute with given key or `null`, if operation should remove attribute.
-     *
-     * @readonly
-     */
-    newValue: unknown;
-    /**
-     * Creates an operation that changes, removes or adds attributes on root element.
-     *
-     * @see module:engine/model/operation/attributeoperation~AttributeOperation
-     * @param root Root element to change.
-     * @param key Key of an attribute to change or remove.
-     * @param oldValue Old value of the attribute with given key or `null`, if attribute was not set before.
-     * @param newValue New value of the attribute with given key or `null`, if operation should remove attribute.
-     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(root: RootElement, key: string, oldValue: unknown, newValue: unknown, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'addRootAttribute' | 'removeRootAttribute' | 'changeRootAttribute';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns Clone of this operation.
-     */
-    clone(): RootAttributeOperation;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-    /**
-     * Creates `RootAttributeOperation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): RootAttributeOperation;
-}