@ckeditor/ckeditor5-engine 48.8.1-alpha.3 → 49.0.0-alpha.0

package/dist/model/liveposition.d.ts

@@ -1,77 +1,89 @@
 /**
- * @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
- */
+* @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/model/liveposition
- */
-import { ModelPosition, type ModelPositionOffset, type ModelPositionStickiness } from './position.js';
-import { type ModelDocumentFragment } from './documentfragment.js';
-import { type ModelItem } from './item.js';
-import { type ModelRootElement } from './rootelement.js';
-declare const ModelLivePosition_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof ModelPosition, import("@ckeditor/ckeditor5-utils").Emitter>;
+* @module engine/model/liveposition
+*/
+import { ModelPosition, type ModelPositionOffset, type ModelPositionStickiness } from "./position.js";
+import type { Model } from "./model.js";
+import { type ModelDocumentFragment } from "./documentfragment.js";
+import { type ModelItem } from "./item.js";
+import { type ModelRootElement } from "./rootelement.js";
+import { type EmitterMixinConstructor } from "@ckeditor/ckeditor5-utils";
+declare const ModelLivePositionBase: EmitterMixinConstructor<typeof ModelPosition>;
 /**
- * `ModelLivePosition` is a type of {@link module:engine/model/position~ModelPosition Position}
- * that updates itself as {@link module:engine/model/document~ModelDocument document}
- * is changed through operations. It may be used as a bookmark.
- *
- * **Note:** Contrary to {@link module:engine/model/position~ModelPosition}, `ModelLivePosition` works only in roots that are
- * {@link module:engine/model/rootelement~ModelRootElement}.
- * If {@link module:engine/model/documentfragment~ModelDocumentFragment} is passed, error will be thrown.
- *
- * **Note:** Be very careful when dealing with `ModelLivePosition`. Each `ModelLivePosition` instance bind events that might
- * have to be unbound.
- * Use {@link module:engine/model/liveposition~ModelLivePosition#detach} whenever you don't need `ModelLivePosition` anymore.
- */
-export declare class ModelLivePosition extends /* #__PURE__ */ ModelLivePosition_base {
-    /**
-     * Root of the position path.
-     */
-    readonly root: ModelRootElement;
-    /**
-     * Creates a live position.
-     *
-     * @see module:engine/model/position~ModelPosition
-     */
-    constructor(root: ModelRootElement, path: Array<number>, stickiness?: ModelPositionStickiness);
-    /**
-     * Unbinds all events previously bound by `ModelLivePosition`. Use it whenever you don't need `ModelLivePosition` instance
-     * anymore (i.e. when leaving scope in which it was declared or before re-assigning variable that was
-     * referring to it).
-     */
-    detach(): void;
-    /**
-     * Creates a {@link module:engine/model/position~ModelPosition position instance}, which is equal to this live position.
-     */
-    toPosition(): ModelPosition;
-    /**
-     * Creates a `ModelLivePosition` instance that is equal to position.
-     */
-    static fromPosition(position: ModelPosition, stickiness?: ModelPositionStickiness): ModelLivePosition;
-    /**
-     * @internal
-     * @see module:engine/model/position~ModelPosition._createAfter
-     */
-    static readonly _createAfter: (item: ModelItem | ModelDocumentFragment, stickiness?: ModelPositionStickiness) => ModelLivePosition;
-    /**
-     * @internal
-     * @see module:engine/model/position~ModelPosition._createBefore
-     */
-    static readonly _createBefore: (item: ModelItem | ModelDocumentFragment, stickiness?: ModelPositionStickiness) => ModelLivePosition;
-    /**
-     * @internal
-     * @see module:engine/model/position~ModelPosition._createAt
-     */
-    static readonly _createAt: (itemOrPosition: ModelItem | ModelPosition | ModelDocumentFragment, offset?: ModelPositionOffset, stickiness?: ModelPositionStickiness) => ModelLivePosition;
+* `ModelLivePosition` is a type of {@link module:engine/model/position~ModelPosition Position}
+* that updates itself as {@link module:engine/model/document~ModelDocument document}
+* is changed through operations. It may be used as a bookmark.
+*
+* **Note:** Contrary to {@link module:engine/model/position~ModelPosition}, `ModelLivePosition` works only in roots that are
+* {@link module:engine/model/rootelement~ModelRootElement}.
+* If {@link module:engine/model/documentfragment~ModelDocumentFragment} is passed, error will be thrown.
+*
+* **Note:** Be very careful when dealing with `ModelLivePosition`. Each `ModelLivePosition` instance bind events that might
+* have to be unbound.
+* Use {@link module:engine/model/liveposition~ModelLivePosition#detach} whenever you don't need `ModelLivePosition` anymore.
+*/
+export declare class ModelLivePosition extends ModelLivePositionBase {
+	/**
+	* Root of the position path.
+	*/
+	readonly root: ModelRootElement;
+	/**
+	* Creates a live position.
+	*
+	* @see module:engine/model/position~ModelPosition
+	*/
+	constructor(root: ModelRootElement, path: Array<number>, stickiness?: ModelPositionStickiness, model?: Model);
+	/**
+	* Unbinds all events previously bound by `ModelLivePosition`. Use it whenever you don't need `ModelLivePosition` instance
+	* anymore (i.e. when leaving scope in which it was declared or before re-assigning variable that was
+	* referring to it).
+	*/
+	detach(): void;
+	/**
+	* Creates a {@link module:engine/model/position~ModelPosition position instance}, which is equal to this live position.
+	*/
+	toPosition(): ModelPosition;
+	/**
+	* Creates a `ModelLivePosition` instance that is equal to position.
+	*/
+	static fromPosition(position: ModelPosition, stickiness?: ModelPositionStickiness): ModelLivePosition;
+	/**
+	* Creates a `ModelLivePosition` for a position rooted in
+	* a {@link module:engine/model/documentfragment~ModelDocumentFragment document fragment}.
+	*
+	* Document fragment does not belong to a document, so the live position is bound to the provided `model` and keeps
+	* itself in sync with every operation applied to that fragment (e.g. while editing clipboard content).
+	*
+	* @internal
+	*/
+	static _fromPositionInDocumentFragment(position: ModelPosition, model: Model, stickiness?: ModelPositionStickiness): ModelLivePosition;
+	/**
+	* @internal
+	* @see module:engine/model/position~ModelPosition._createAfter
+	*/
+	static readonly _createAfter: (item: ModelItem | ModelDocumentFragment, stickiness?: ModelPositionStickiness) => ModelLivePosition;
+	/**
+	* @internal
+	* @see module:engine/model/position~ModelPosition._createBefore
+	*/
+	static readonly _createBefore: (item: ModelItem | ModelDocumentFragment, stickiness?: ModelPositionStickiness) => ModelLivePosition;
+	/**
+	* @internal
+	* @see module:engine/model/position~ModelPosition._createAt
+	*/
+	static readonly _createAt: (itemOrPosition: ModelItem | ModelPosition | ModelDocumentFragment, offset?: ModelPositionOffset, stickiness?: ModelPositionStickiness) => ModelLivePosition;
 }
 /**
- * Fired when `ModelLivePosition` instance is changed due to changes on {@link module:engine/model/document~ModelDocument}.
- *
- * @eventName ~ModelLivePosition#change
- * @param oldPosition Position equal to this live position before it got changed.
- */
+* Fired when `ModelLivePosition` instance is changed due to changes on {@link module:engine/model/document~ModelDocument}.
+*
+* @eventName ~ModelLivePosition#change
+* @param oldPosition Position equal to this live position before it got changed.
+*/
 export type ModelLivePositionChangeEvent = {
-    name: 'change';
-    args: [oldPosition: ModelPosition];
+	name: "change";
+	args: [oldPosition: ModelPosition];
 };
 export {};

package/dist/model/liverange.d.ts

@@ -1,106 +1,132 @@
 /**
- * @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
- */
+* @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/model/liverange
- */
-import { ModelRange } from './range.js';
-import { type ModelDocumentFragment } from './documentfragment.js';
-import { type ModelElement } from './element.js';
-import { type ModelItem } from './item.js';
-import { type ModelPosition } from './position.js';
-declare const ModelLiveRange_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof ModelRange, import("@ckeditor/ckeditor5-utils").Emitter>;
+* @module engine/model/liverange
+*/
+import { ModelRange } from "./range.js";
+import type { Model } from "./model.js";
+import { type ModelDocumentFragment } from "./documentfragment.js";
+import { type ModelElement } from "./element.js";
+import { type ModelItem } from "./item.js";
+import { type ModelPosition } from "./position.js";
+import { type EmitterMixinConstructor } from "@ckeditor/ckeditor5-utils";
+declare const ModelLiveRangeBase: EmitterMixinConstructor<typeof ModelRange>;
 /**
- * `ModelLiveRange` is a type of {@link module:engine/model/range~ModelRange Range}
- * that updates itself as {@link module:engine/model/document~ModelDocument document}
- * is changed through operations. It may be used as a bookmark.
- *
- * **Note:** Be very careful when dealing with `ModelLiveRange`. Each `ModelLiveRange` instance bind events that might
- * have to be unbound. Use {@link module:engine/model/liverange~ModelLiveRange#detach detach} whenever you don't need
- * `ModelLiveRange` anymore.
- */
-export declare class ModelLiveRange extends /* #__PURE__ */ ModelLiveRange_base {
-    /**
-     * Creates a live range.
-     *
-     * @see module:engine/model/range~ModelRange
-     */
-    constructor(start: ModelPosition, end?: ModelPosition | null);
-    /**
-     * Unbinds all events previously bound by `ModelLiveRange`. Use it whenever you don't need `ModelLiveRange` instance
-     * anymore (i.e. when leaving scope in which it was declared or before re-assigning variable that was
-     * referring to it).
-     */
-    detach(): void;
-    /**
-     * Creates a {@link module:engine/model/range~ModelRange range instance} that is equal to this live range.
-     */
-    toRange(): ModelRange;
-    /**
-     * Creates a `ModelLiveRange` instance that is equal to the given range.
-     */
-    static fromRange(range: ModelRange): ModelLiveRange;
-    /**
-     * @see module:engine/model/range~ModelRange._createIn
-     * @internal
-     */
-    static readonly _createIn: (element: ModelElement | ModelDocumentFragment) => ModelLiveRange;
-    /**
-     * @see module:engine/model/range~ModelRange._createOn
-     * @internal
-     */
-    static readonly _createOn: (element: ModelItem | ModelDocumentFragment) => ModelLiveRange;
-    /**
-     * @see module:engine/model/range~ModelRange._createFromPositionAndShift
-     * @internal
-     */
-    static readonly _createFromPositionAndShift: (position: ModelPosition, shift: number) => ModelLiveRange;
+* `ModelLiveRange` is a type of {@link module:engine/model/range~ModelRange Range}
+* that updates itself as {@link module:engine/model/document~ModelDocument document}
+* is changed through operations. It may be used as a bookmark.
+*
+* **Note:** Be very careful when dealing with `ModelLiveRange`. Each `ModelLiveRange` instance bind events that might
+* have to be unbound. Use {@link module:engine/model/liverange~ModelLiveRange#detach detach} whenever you don't need
+* `ModelLiveRange` anymore.
+*/
+export declare class ModelLiveRange extends ModelLiveRangeBase {
+	/**
+	* Creates a live range.
+	*
+	* @see module:engine/model/range~ModelRange
+	*/
+	constructor(start: ModelPosition, end?: ModelPosition | null, model?: Model);
+	/**
+	* Unbinds all events previously bound by `ModelLiveRange`. Use it whenever you don't need `ModelLiveRange` instance
+	* anymore (i.e. when leaving scope in which it was declared or before re-assigning variable that was
+	* referring to it).
+	*/
+	detach(): void;
+	/**
+	* Creates a {@link module:engine/model/range~ModelRange range instance} that is equal to this live range.
+	*/
+	toRange(): ModelRange;
+	/**
+	* Creates a `ModelLiveRange` instance that is equal to the given range.
+	*/
+	static fromRange(range: ModelRange): ModelLiveRange;
+	/**
+	* Creates a `ModelLiveRange` for a range rooted in
+	* a {@link module:engine/model/documentfragment~ModelDocumentFragment document fragment}.
+	*
+	* Document fragment does not belong to a document, so the live range is bound to the provided `model` and keeps
+	* itself in sync with every operation applied to that fragment (e.g. while editing clipboard content).
+	*
+	* @internal
+	*/
+	static _fromRangeInDocumentFragment(range: ModelRange, model: Model): ModelLiveRange;
+	/**
+	* @see module:engine/model/range~ModelRange._createIn
+	* @internal
+	*/
+	static readonly _createIn: (element: ModelElement | ModelDocumentFragment) => ModelLiveRange;
+	/**
+	* @see module:engine/model/range~ModelRange._createOn
+	* @internal
+	*/
+	static readonly _createOn: (element: ModelItem | ModelDocumentFragment) => ModelLiveRange;
+	/**
+	* @see module:engine/model/range~ModelRange._createFromPositionAndShift
+	* @internal
+	*/
+	static readonly _createFromPositionAndShift: (position: ModelPosition, shift: number) => ModelLiveRange;
 }
 /**
- * Fired when `ModelLiveRange` instance boundaries have changed due to changes in the
- * {@link module:engine/model/document~ModelDocument document}.
- *
- * @eventName ~ModelLiveRange#change:range
- * @param oldRange Range with start and end position equal to start and end position of this live
- * range before it got changed.
- * @param data Object with additional information about the change.
- * @param data.deletionPosition Source position for remove and merge changes.
- * Available if the range was moved to the graveyard root, `null` otherwise.
- */
+* Fired when `ModelLiveRange` instance boundaries have changed due to changes in the
+* {@link module:engine/model/document~ModelDocument document}.
+*
+* @eventName ~ModelLiveRange#change:range
+* @param oldRange Range with start and end position equal to start and end position of this live
+* range before it got changed.
+* @param data Object with additional information about the change.
+* @param data.deletionPosition Source position for remove and merge changes.
+* Available if the range was moved to the graveyard root, `null` otherwise.
+*/
 export type ModelLiveRangeChangeRangeEvent = {
-    name: 'change' | 'change:range';
-    args: [range: ModelRange, data: {
-        deletionPosition: ModelPosition | null;
-    }];
+	name: "change" | "change:range";
+	args: [range: ModelRange, data: {
+		deletionPosition: ModelPosition | null;
+	}];
 };
 /**
- * Fired when `ModelLiveRange` instance boundaries have not changed after
- * a change in {@link module:engine/model/document~ModelDocument document}
- * but the change took place inside the range, effectively changing its content.
- *
- * @eventName ~ModelLiveRange#change:content
- * @param range Range with start and end position equal to start and end position of
- * change range.
- * @param data Object with additional information about the change.
- * @param data.deletionPosition Due to the nature of this event, this property is always set to `null`. It is passed
- * for compatibility with the {@link module:engine/model/liverange~ModelLiveRange#event:change:range} event.
- */
+* Fired when `ModelLiveRange` instance was entirely removed from the document fragment.
+*
+* @eventName ~ModelLiveRange#change:drop
+* @param range Collapsed range with start and end position equal to the source position of the detach operation.
+* @param data Object with additional information about the change.
+* @param data.deletionPosition Source position for detach changes.
+*/
+export type ModelLiveRangeChangeDropEvent = {
+	name: "change" | "change:drop";
+	args: [range: ModelRange, data: {
+		deletionPosition: ModelPosition;
+	}];
+};
+/**
+* Fired when `ModelLiveRange` instance boundaries have not changed after
+* a change in {@link module:engine/model/document~ModelDocument document}
+* but the change took place inside the range, effectively changing its content.
+*
+* @eventName ~ModelLiveRange#change:content
+* @param range Range with start and end position equal to start and end position of
+* change range.
+* @param data Object with additional information about the change.
+* @param data.deletionPosition Due to the nature of this event, this property is always set to `null`. It is passed
+* for compatibility with the {@link module:engine/model/liverange~ModelLiveRange#event:change:range} event.
+*/
 export type ModelLiveRangeChangeContentEvent = {
-    name: 'change' | 'change:content';
-    args: [range: ModelRange, data: {
-        deletionPosition: null;
-    }];
+	name: "change" | "change:content";
+	args: [range: ModelRange, data: {
+		deletionPosition: null;
+	}];
 };
 /**
- * Describes `change:range` or `change:content` event.
- *
- * @eventName ~ModelLiveRange#change
- */
+* Describes `change:range` or `change:content` event.
+*
+* @eventName ~ModelLiveRange#change
+*/
 export type ModelLiveRangeChangeEvent = {
-    name: 'change' | 'change:range' | 'change:content';
-    args: [range: ModelRange, data: {
-        deletionPosition: ModelPosition | null;
-    }];
+	name: "change" | "change:range" | "change:content";
+	args: [range: ModelRange, data: {
+		deletionPosition: ModelPosition | null;
+	}];
 };
 export {};