@ckeditor/ckeditor5-engine 38.1.1 → 38.2.0-alpha.1

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

@@ -1,51 +1,51 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import type Model from '../model/model';
-import type Operation from '../model/operation/operation';
-/**
- * Operation replayer is a development tool created for easy replaying of operations on the document from stringified operations.
- */
-export default 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>;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+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.
+ */
+export default 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>;
+}

package/src/dev-utils/operationreplayer.js

@@ -1,112 +1,112 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/dev-utils/operationreplayer
- */
-/* global setTimeout */
-import OperationFactory from '../model/operation/operationfactory';
-/**
- * Operation replayer is a development tool created for easy replaying of operations on the document from stringified operations.
- */
-export default class OperationReplayer {
-    /**
-     * @param model Data model.
-     * @param logSeparator Separator between operations.
-     * @param stringifiedOperations Operations to replay.
-     */
-    constructor(model, logSeparator, stringifiedOperations) {
-        this._model = model;
-        this._logSeparator = logSeparator;
-        this.setStringifiedOperations(stringifiedOperations);
-    }
-    /**
-     * Parses the given string containing stringified operations and sets parsed operations as operations to replay.
-     *
-     * @param stringifiedOperations Stringified operations to replay.
-     */
-    setStringifiedOperations(stringifiedOperations) {
-        if (stringifiedOperations === '') {
-            this._operationsToReplay = [];
-            return;
-        }
-        this._operationsToReplay = stringifiedOperations
-            .split(this._logSeparator)
-            .map(stringifiedOperation => JSON.parse(stringifiedOperation));
-    }
-    /**
-     * Returns operations to replay.
-     */
-    getOperationsToReplay() {
-        return this._operationsToReplay;
-    }
-    /**
-     * Applies all operations with a delay between actions.
-     *
-     * @param timeInterval Time between applying operations.
-     */
-    play(timeInterval = 1000) {
-        // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
-        const operationReplayer = this;
-        return new Promise((res, rej) => {
-            play();
-            function play() {
-                operationReplayer.applyNextOperation().then(isFinished => {
-                    if (isFinished) {
-                        return res();
-                    }
-                    setTimeout(play, timeInterval);
-                }).catch(err => {
-                    rej(err);
-                });
-            }
-        });
-    }
-    /**
-     * 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) {
-        if (numberOfOperations <= 0) {
-            return;
-        }
-        return this.applyNextOperation()
-            .then(isFinished => {
-            if (!isFinished) {
-                return this.applyOperations(numberOfOperations - 1);
-            }
-        });
-    }
-    /**
-     * Applies all operations to replay at once.
-     */
-    applyAllOperations() {
-        return this.applyNextOperation()
-            .then(isFinished => {
-            if (!isFinished) {
-                return this.applyAllOperations();
-            }
-        });
-    }
-    /**
-     * 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() {
-        const model = this._model;
-        return new Promise(res => {
-            model.enqueueChange(writer => {
-                const operationJson = this._operationsToReplay.shift();
-                if (!operationJson) {
-                    return res(true);
-                }
-                const operation = OperationFactory.fromJSON(operationJson, model.document);
-                writer.batch.addOperation(operation);
-                model.applyOperation(operation);
-                res(false);
-            });
-        });
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/dev-utils/operationreplayer
+ */
+/* global setTimeout */
+import OperationFactory from '../model/operation/operationfactory.js';
+/**
+ * Operation replayer is a development tool created for easy replaying of operations on the document from stringified operations.
+ */
+export default class OperationReplayer {
+    /**
+     * @param model Data model.
+     * @param logSeparator Separator between operations.
+     * @param stringifiedOperations Operations to replay.
+     */
+    constructor(model, logSeparator, stringifiedOperations) {
+        this._model = model;
+        this._logSeparator = logSeparator;
+        this.setStringifiedOperations(stringifiedOperations);
+    }
+    /**
+     * Parses the given string containing stringified operations and sets parsed operations as operations to replay.
+     *
+     * @param stringifiedOperations Stringified operations to replay.
+     */
+    setStringifiedOperations(stringifiedOperations) {
+        if (stringifiedOperations === '') {
+            this._operationsToReplay = [];
+            return;
+        }
+        this._operationsToReplay = stringifiedOperations
+            .split(this._logSeparator)
+            .map(stringifiedOperation => JSON.parse(stringifiedOperation));
+    }
+    /**
+     * Returns operations to replay.
+     */
+    getOperationsToReplay() {
+        return this._operationsToReplay;
+    }
+    /**
+     * Applies all operations with a delay between actions.
+     *
+     * @param timeInterval Time between applying operations.
+     */
+    play(timeInterval = 1000) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
+        const operationReplayer = this;
+        return new Promise((res, rej) => {
+            play();
+            function play() {
+                operationReplayer.applyNextOperation().then(isFinished => {
+                    if (isFinished) {
+                        return res();
+                    }
+                    setTimeout(play, timeInterval);
+                }).catch(err => {
+                    rej(err);
+                });
+            }
+        });
+    }
+    /**
+     * 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) {
+        if (numberOfOperations <= 0) {
+            return;
+        }
+        return this.applyNextOperation()
+            .then(isFinished => {
+            if (!isFinished) {
+                return this.applyOperations(numberOfOperations - 1);
+            }
+        });
+    }
+    /**
+     * Applies all operations to replay at once.
+     */
+    applyAllOperations() {
+        return this.applyNextOperation()
+            .then(isFinished => {
+            if (!isFinished) {
+                return this.applyAllOperations();
+            }
+        });
+    }
+    /**
+     * 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() {
+        const model = this._model;
+        return new Promise(res => {
+            model.enqueueChange(writer => {
+                const operationJson = this._operationsToReplay.shift();
+                if (!operationJson) {
+                    return res(true);
+                }
+                const operation = OperationFactory.fromJSON(operationJson, model.document);
+                writer.batch.addOperation(operation);
+                model.applyOperation(operation);
+                res(false);
+            });
+        });
+    }
+}

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

@@ -1,37 +1,37 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * 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.
- */
-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.
- */
-export declare function convertMapToStringifiedObject(map: Iterable<[string, unknown]>): string;
-/**
- * Helper function that stores the `document` state for a given `version`.
- */
-export declare function dumpTrees(document: any, version: any): void;
-/**
- * Helper function that initializes document dumping.
- */
-export declare function initDocumentDumping(document: any): void;
-/**
- * Helper function that logs document for the given version.
- */
-export declare function logDocument(document: any, version: any): void;
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * 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.
+ */
+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.
+ */
+export declare function convertMapToStringifiedObject(map: Iterable<[string, unknown]>): string;
+/**
+ * Helper function that stores the `document` state for a given `version`.
+ */
+export declare function dumpTrees(document: any, version: any): void;
+/**
+ * Helper function that initializes document dumping.
+ */
+export declare function initDocumentDumping(document: any): void;
+/**
+ * Helper function that logs document for the given version.
+ */
+export declare function logDocument(document: any, version: any): void;

package/src/dev-utils/utils.js

@@ -1,73 +1,73 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * 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
- */
-/* globals console */
-/**
- * Helper function, converts a map to the 'key1="value1" key2="value1"' format.
- *
- * @param map Map to convert.
- * @returns Converted map.
- */
-export function convertMapToTags(map) {
-    let string = '';
-    for (const entry of map) {
-        string += ` ${entry[0]}=${JSON.stringify(entry[1])}`;
-    }
-    return string;
-}
-/**
- * Helper function, converts a map to the `{"key1":"value1","key2":"value2"}` format.
- *
- * @param map Map to convert.
- * @returns Converted map.
- */
-export function convertMapToStringifiedObject(map) {
-    const obj = {};
-    for (const entry of map) {
-        obj[entry[0]] = entry[1];
-    }
-    return JSON.stringify(obj);
-}
-const treeDump = Symbol('_treeDump');
-const maxTreeDumpLength = 20;
-/**
- * Helper function that stores the `document` state for a given `version`.
- */
-export function dumpTrees(document, version) {
-    console.log(document, version);
-    let string = '';
-    for (const root of document.roots) {
-        string += root.printTree() + '\n';
-    }
-    document[treeDump][version] = string.substr(0, string.length - 1); // Remove the last "\n".
-    const overflow = document[treeDump].length - maxTreeDumpLength;
-    if (overflow > 0) {
-        document[treeDump][overflow - 1] = null;
-    }
-}
-/**
- * Helper function that initializes document dumping.
- */
-export function initDocumentDumping(document) {
-    document[treeDump] = [];
-}
-/**
- * Helper function that logs document for the given version.
- */
-export function logDocument(document, version) {
-    console.log('--------------------');
-    if (document[treeDump][version]) {
-        console.log(document[treeDump][version]);
-    }
-    else {
-        console.log('Tree log unavailable for given version: ' + version);
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * 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
+ */
+/* globals console */
+/**
+ * Helper function, converts a map to the 'key1="value1" key2="value1"' format.
+ *
+ * @param map Map to convert.
+ * @returns Converted map.
+ */
+export function convertMapToTags(map) {
+    let string = '';
+    for (const entry of map) {
+        string += ` ${entry[0]}=${JSON.stringify(entry[1])}`;
+    }
+    return string;
+}
+/**
+ * Helper function, converts a map to the `{"key1":"value1","key2":"value2"}` format.
+ *
+ * @param map Map to convert.
+ * @returns Converted map.
+ */
+export function convertMapToStringifiedObject(map) {
+    const obj = {};
+    for (const entry of map) {
+        obj[entry[0]] = entry[1];
+    }
+    return JSON.stringify(obj);
+}
+const treeDump = Symbol('_treeDump');
+const maxTreeDumpLength = 20;
+/**
+ * Helper function that stores the `document` state for a given `version`.
+ */
+export function dumpTrees(document, version) {
+    console.log(document, version);
+    let string = '';
+    for (const root of document.roots) {
+        string += root.printTree() + '\n';
+    }
+    document[treeDump][version] = string.substr(0, string.length - 1); // Remove the last "\n".
+    const overflow = document[treeDump].length - maxTreeDumpLength;
+    if (overflow > 0) {
+        document[treeDump][overflow - 1] = null;
+    }
+}
+/**
+ * Helper function that initializes document dumping.
+ */
+export function initDocumentDumping(document) {
+    document[treeDump] = [];
+}
+/**
+ * Helper function that logs document for the given version.
+ */
+export function logDocument(document, version) {
+    console.log('--------------------');
+    if (document[treeDump][version]) {
+        console.log(document[treeDump][version]);
+    }
+    else {
+        console.log('Tree log unavailable for given version: ' + version);
+    }
+}