@ckeditor/ckeditor5-engine 48.2.0 → 48.3.0-alpha.0

package/dist/dev-utils/model.d.ts

@@ -1,132 +1,137 @@
 /**
- * @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
- */
-import { Model } from '../model/model.js';
-import { ModelRange } from '../model/range.js';
-import { ModelPosition } from '../model/position.js';
-import { ModelSelection } from '../model/selection.js';
-import { ModelDocumentFragment } from '../model/documentfragment.js';
-import { ModelDocumentSelection } from '../model/documentselection.js';
-import type { BatchType } from '../model/batch.js';
-import { type MarkerCollection } from '../model/markercollection.js';
-import type { ModelSchema, ModelSchemaContextDefinition } from '../model/schema.js';
-import { type ModelNode } from '../model/node.js';
+* @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
+*/
+import { Model } from "../model/model.js";
+import { ModelRange } from "../model/range.js";
+import { ModelPosition } from "../model/position.js";
+import { ModelSelection } from "../model/selection.js";
+import { ModelDocumentFragment } from "../model/documentfragment.js";
+import { ModelDocumentSelection } from "../model/documentselection.js";
+import type { BatchType } from "../model/batch.js";
+import { type MarkerCollection } from "../model/markercollection.js";
+import type { ModelSchema, ModelSchemaContextDefinition } from "../model/schema.js";
+import { type ModelNode } from "../model/node.js";
+type GetModelDataOptions = {
+	withoutSelection?: boolean;
+	rootName?: string;
+	convertMarkers?: boolean;
+};
+type GetModelData = {
+	(model: Model, options?: GetModelDataOptions): string;
+	_stringify: typeof _stringifyModel;
+};
+type SetModelDataOptions = {
+	rootName?: string;
+	selectionAttributes?: Record<string, unknown>;
+	lastRangeBackward?: boolean;
+	batchType?: BatchType;
+	inlineObjectElements?: Array<string>;
+};
+type SetModelData = {
+	(model: Model, data: string, options?: SetModelDataOptions): void;
+	_parse: typeof _parseModel;
+};
 /**
- * Writes the content of a model {@link module:engine/model/document~ModelDocument document} to an HTML-like string.
- *
- * ```ts
- * getData( editor.model ); // -> '<paragraph>Foo![]</paragraph>'
- * ```
- *
- * **Note:** A {@link module:engine/model/text~ModelText text} node that contains attributes will be represented as:
- *
- * ```xml
- * <$text attribute="value">Text data</$text>
- * ```
- *
- * **Note:** Using this tool in production-grade code is not recommended. It was designed for development, prototyping,
- * debugging and testing.
- *
- * @param options.withoutSelection Whether to write the selection. When set to `true`, the selection will
- * not be included in the returned string.
- * @param options.rootName The name of the root from which the data should be stringified. If not provided,
- * the default `main` name will be used.
- * @param options.convertMarkers Whether to include markers in the returned string.
- * @returns The stringified data.
- */
-export declare function _getModelData(model: Model, options?: {
-    withoutSelection?: boolean;
-    rootName?: string;
-    convertMarkers?: boolean;
-}): string;
-export declare namespace _getModelData {
-    var _stringify: typeof _stringifyModel;
-}
+* Writes the content of a model {@link module:engine/model/document~ModelDocument document} to an HTML-like string.
+*
+* ```ts
+* getData( editor.model ); // -> '<paragraph>Foo![]</paragraph>'
+* ```
+*
+* **Note:** A {@link module:engine/model/text~ModelText text} node that contains attributes will be represented as:
+*
+* ```xml
+* <$text attribute="value">Text data</$text>
+* ```
+*
+* **Note:** Using this tool in production-grade code is not recommended. It was designed for development, prototyping,
+* debugging and testing.
+*
+* @param options.withoutSelection Whether to write the selection. When set to `true`, the selection will
+* not be included in the returned string.
+* @param options.rootName The name of the root from which the data should be stringified. If not provided,
+* the default `main` name will be used.
+* @param options.convertMarkers Whether to include markers in the returned string.
+* @returns The stringified data.
+*/
+export declare const _getModelData: GetModelData;
 /**
- * Sets the content of a model {@link module:engine/model/document~ModelDocument document} provided as an HTML-like string.
- *
- * ```ts
- * setData( editor.model, '<paragraph>Foo![]</paragraph>' );
- * ```
- *
- * **Note:** Remember to register elements in the {@link module:engine/model/model~Model#schema model's schema} before
- * trying to use them.
- *
- * **Note:** To create a {@link module:engine/model/text~ModelText text} node that contains attributes use:
- *
- * ```xml
- * <$text attribute="value">Text data</$text>
- * ```
- *
- * **Note:** Using this tool in production-grade code is not recommended. It was designed for development, prototyping,
- * debugging and testing.
- *
- * @param data HTML-like string to write into the document.
- * @param options.rootName Root name where parsed data will be stored. If not provided, the default `main`
- * name will be used.
- * @param options.selectionAttributes A list of attributes which will be passed to the selection.
- * @param options.lastRangeBackward If set to `true`, the last range will be added as backward.
- * @param options.batchType Batch type used for inserting elements. See {@link module:engine/model/batch~Batch#constructor}.
- */
-export declare function _setModelData(model: Model, data: string, options?: {
-    rootName?: string;
-    selectionAttributes?: Record<string, unknown>;
-    lastRangeBackward?: boolean;
-    batchType?: BatchType;
-    inlineObjectElements?: Array<string>;
-}): void;
-export declare namespace _setModelData {
-    var _parse: typeof _parseModel;
-}
+* Sets the content of a model {@link module:engine/model/document~ModelDocument document} provided as an HTML-like string.
+*
+* ```ts
+* setData( editor.model, '<paragraph>Foo![]</paragraph>' );
+* ```
+*
+* **Note:** Remember to register elements in the {@link module:engine/model/model~Model#schema model's schema} before
+* trying to use them.
+*
+* **Note:** To create a {@link module:engine/model/text~ModelText text} node that contains attributes use:
+*
+* ```xml
+* <$text attribute="value">Text data</$text>
+* ```
+*
+* **Note:** Using this tool in production-grade code is not recommended. It was designed for development, prototyping,
+* debugging and testing.
+*
+* @param data HTML-like string to write into the document.
+* @param options.rootName Root name where parsed data will be stored. If not provided, the default `main`
+* name will be used.
+* @param options.selectionAttributes A list of attributes which will be passed to the selection.
+* @param options.lastRangeBackward If set to `true`, the last range will be added as backward.
+* @param options.batchType Batch type used for inserting elements. See {@link module:engine/model/batch~Batch#constructor}.
+*/
+export declare const _setModelData: SetModelData;
 /**
- * Converts model nodes to HTML-like string representation.
- *
- * **Note:** A {@link module:engine/model/text~ModelText text} node that contains attributes will be represented as:
- *
- * ```xml
- * <$text attribute="value">Text data</$text>
- * ```
- *
- * @param node A node to stringify.
- * @param selectionOrPositionOrRange A selection instance whose ranges will be included in the returned string data.
- * If a range instance is provided, it will be converted to a selection containing this range. If a position instance
- * is provided, it will be converted to a selection containing one range collapsed at this position.
- * @param markers Markers to include.
- * @returns An HTML-like string representing the model.
- */
+* Converts model nodes to HTML-like string representation.
+*
+* **Note:** A {@link module:engine/model/text~ModelText text} node that contains attributes will be represented as:
+*
+* ```xml
+* <$text attribute="value">Text data</$text>
+* ```
+*
+* @param node A node to stringify.
+* @param selectionOrPositionOrRange A selection instance whose ranges will be included in the returned string data.
+* If a range instance is provided, it will be converted to a selection containing this range. If a position instance
+* is provided, it will be converted to a selection containing one range collapsed at this position.
+* @param markers Markers to include.
+* @returns An HTML-like string representing the model.
+*/
 export declare function _stringifyModel(node: ModelNode | ModelDocumentFragment, selectionOrPositionOrRange?: ModelSelection | ModelDocumentSelection | ModelPosition | ModelRange | null, markers?: MarkerCollection | null): string;
 /**
- * Parses an HTML-like string and returns the model {@link module:engine/model/rootelement~ModelRootElement rootElement}.
- *
- * **Note:** To create a {@link module:engine/model/text~ModelText text} node that contains attributes use:
- *
- * ```xml
- * <$text attribute="value">Text data</$text>
- * ```
- *
- * **Note:** The default `options.context` value is `'$root'`, which only matches the generic root. When the editor
- * uses a custom root {@link module:core/editor/editorconfig~RootConfig#modelElement `modelElement`}, pass the target
- * {@link module:engine/model/rootelement~ModelRootElement root element} (or its configured model element name)
- * explicitly, otherwise the conversion result may be wrong.
- * See the {@glink framework/deep-dive/schema#custom-root-elements Custom root elements} section of the
- * {@glink framework/deep-dive/schema Schema deep-dive} guide for more details.
- *
- * @param data HTML-like string to be parsed.
- * @param schema A schema instance used by converters for element validation.
- * @param options Additional configuration.
- * @param options.selectionAttributes A list of attributes which will be passed to the selection.
- * @param options.lastRangeBackward If set to `true`, the last range will be added as backward.
- * @param options.context The conversion context. If not provided, the default `'$root'` will be used.
- * @returns Returns the parsed model node or an object with two fields: `model` and `selection`,
- * when selection ranges were included in the data to parse.
- */
+* Parses an HTML-like string and returns the model {@link module:engine/model/rootelement~ModelRootElement rootElement}.
+*
+* **Note:** To create a {@link module:engine/model/text~ModelText text} node that contains attributes use:
+*
+* ```xml
+* <$text attribute="value">Text data</$text>
+* ```
+*
+* **Note:** The default `options.context` value is `'$root'`, which only matches the generic root. When the editor
+* uses a custom root {@link module:core/editor/editorconfig~RootConfig#modelElement `modelElement`}, pass the target
+* {@link module:engine/model/rootelement~ModelRootElement root element} (or its configured model element name)
+* explicitly, otherwise the conversion result may be wrong.
+* See the {@glink framework/deep-dive/schema#custom-root-elements Custom root elements} section of the
+* {@glink framework/deep-dive/schema Schema deep-dive} guide for more details.
+*
+* @param data HTML-like string to be parsed.
+* @param schema A schema instance used by converters for element validation.
+* @param options Additional configuration.
+* @param options.selectionAttributes A list of attributes which will be passed to the selection.
+* @param options.lastRangeBackward If set to `true`, the last range will be added as backward.
+* @param options.context The conversion context. If not provided, the default `'$root'` will be used.
+* @returns Returns the parsed model node or an object with two fields: `model` and `selection`,
+* when selection ranges were included in the data to parse.
+*/
 export declare function _parseModel(data: string, schema: ModelSchema, options?: {
-    selectionAttributes?: Record<string, unknown> | Iterable<[string, unknown]>;
-    lastRangeBackward?: boolean;
-    context?: ModelSchemaContextDefinition;
-    inlineObjectElements?: Array<string>;
+	selectionAttributes?: Record<string, unknown> | Iterable<[string, unknown]>;
+	lastRangeBackward?: boolean;
+	context?: ModelSchemaContextDefinition;
+	inlineObjectElements?: Array<string>;
 }): ModelNode | ModelDocumentFragment | {
-    model: ModelNode | ModelDocumentFragment;
-    selection: ModelSelection;
+	model: ModelNode | ModelDocumentFragment;
+	selection: ModelSelection;
 };
+export {};

package/dist/dev-utils/operationreplayer.d.ts

@@ -1,53 +1,53 @@
 /**
- * @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
- */
-import { type Model } from '../model/model.js';
-import { type Operation } from '../model/operation/operation.js';
+* @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
+*/
+import { type Model } from "../model/model.js";
+import { type Operation } from "../model/operation/operation.js";
 /**
- * Operation replayer is a development tool created for easy replaying of operations on the document from stringified operations.
- *
- * @internal
- */
+* Operation replayer is a development tool created for easy replaying of operations on the document from stringified operations.
+*
+* @internal
+*/
 export declare class OperationReplayer {
-    private _model;
-    private _logSeparator;
-    private _operationsToReplay;
-    /**
-     * @param model Data model.
-     * @param logSeparator Separator between operations.
-     * @param stringifiedOperations Operations to replay.
-     */
-    constructor(model: Model, logSeparator: string, stringifiedOperations: string);
-    /**
-     * Parses the given string containing stringified operations and sets parsed operations as operations to replay.
-     *
-     * @param stringifiedOperations Stringified operations to replay.
-     */
-    setStringifiedOperations(stringifiedOperations: string): void;
-    /**
-     * Returns operations to replay.
-     */
-    getOperationsToReplay(): Array<Operation>;
-    /**
-     * Applies all operations with a delay between actions.
-     *
-     * @param timeInterval Time between applying operations.
-     */
-    play(timeInterval?: number): Promise<void>;
-    /**
-     * Applies `numberOfOperations` operations, beginning after the last applied operation (or first, if no operations were applied).
-     *
-     * @param numberOfOperations The number of operations to apply.
-     */
-    applyOperations(numberOfOperations: number): Promise<void> | undefined;
-    /**
-     * Applies all operations to replay at once.
-     */
-    applyAllOperations(): Promise<void>;
-    /**
-     * Applies the next operation to replay. Returns a promise with the `isFinished` parameter that is `true` if the last
-     * operation in the replayer has been applied, `false` otherwise.
-     */
-    applyNextOperation(): Promise<boolean>;
+	private _model;
+	private _logSeparator;
+	private _operationsToReplay;
+	/**
+	* @param model Data model.
+	* @param logSeparator Separator between operations.
+	* @param stringifiedOperations Operations to replay.
+	*/
+	constructor(model: Model, logSeparator: string, stringifiedOperations: string);
+	/**
+	* Parses the given string containing stringified operations and sets parsed operations as operations to replay.
+	*
+	* @param stringifiedOperations Stringified operations to replay.
+	*/
+	setStringifiedOperations(stringifiedOperations: string): void;
+	/**
+	* Returns operations to replay.
+	*/
+	getOperationsToReplay(): Array<Operation>;
+	/**
+	* Applies all operations with a delay between actions.
+	*
+	* @param timeInterval Time between applying operations.
+	*/
+	play(timeInterval?: number): Promise<void>;
+	/**
+	* Applies `numberOfOperations` operations, beginning after the last applied operation (or first, if no operations were applied).
+	*
+	* @param numberOfOperations The number of operations to apply.
+	*/
+	applyOperations(numberOfOperations: number): Promise<void> | undefined;
+	/**
+	* Applies all operations to replay at once.
+	*/
+	applyAllOperations(): Promise<void>;
+	/**
+	* Applies the next operation to replay. Returns a promise with the `isFinished` parameter that is `true` if the last
+	* operation in the replayer has been applied, `false` otherwise.
+	*/
+	applyNextOperation(): Promise<boolean>;
 }

package/dist/dev-utils/utils.d.ts

@@ -1,45 +1,45 @@
 /**
- * @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
+*/
 /**
- * Note: This package is used only internally for debugging purposes and should not be used
- * in other environments. It uses a few special methods not existing in the default
- * building process. That is also why there are no tests for this file.
- *
- * @module engine/dev-utils/utils
- */
+* Note: This package is used only internally for debugging purposes and should not be used
+* in other environments. It uses a few special methods not existing in the default
+* building process. That is also why there are no tests for this file.
+*
+* @module engine/dev-utils/utils
+*/
 /**
- * Helper function, converts a map to the 'key1="value1" key2="value1"' format.
- *
- * @param map Map to convert.
- * @returns Converted map.
- * @internal
- */
+* Helper function, converts a map to the 'key1="value1" key2="value1"' format.
+*
+* @param map Map to convert.
+* @returns Converted map.
+* @internal
+*/
 export declare function convertMapToTags(map: Iterable<[string, unknown]>): string;
 /**
- * Helper function, converts a map to the `{"key1":"value1","key2":"value2"}` format.
- *
- * @param map Map to convert.
- * @returns Converted map.
- * @internal
- */
+* Helper function, converts a map to the `{"key1":"value1","key2":"value2"}` format.
+*
+* @param map Map to convert.
+* @returns Converted map.
+* @internal
+*/
 export declare function convertMapToStringifiedObject(map: Iterable<[string, unknown]>): string;
 /**
- * Helper function that stores the `document` state for a given `version`.
- *
- * @internal
- */
+* Helper function that stores the `document` state for a given `version`.
+*
+* @internal
+*/
 export declare function dumpTrees(document: any, version: any): void;
 /**
- * Helper function that initializes document dumping.
- *
- * @internal
- */
+* Helper function that initializes document dumping.
+*
+* @internal
+*/
 export declare function initDocumentDumping(document: any): void;
 /**
- * Helper function that logs document for the given version.
- *
- * @internal
- */
+* Helper function that logs document for the given version.
+*
+* @internal
+*/
 export declare function logDocument(document: any, version: any): void;