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

package/src/editorwatchdog.js

@@ -1,217 +1,217 @@
-/**
- * @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 areConnectedThroughProperties from './utils/areconnectedthroughproperties';
-import Watchdog from './watchdog';
-import { throttle, cloneDeepWith, isElement } from 'lodash-es';
-/**
- * A watchdog for CKEditor 5 editors.
- *
- * See the {@glink features/watchdog Watchdog feature guide} to learn the rationale behind it and
- * how to use it.
- */
-export default class EditorWatchdog extends Watchdog {
-    /**
-     * @param Editor The editor class.
-     * @param watchdogConfig The watchdog plugin configuration.
-     */
-    constructor(Editor, watchdogConfig = {}) {
-        super(watchdogConfig);
-        /**
-         * The current editor instance.
-         */
-        this._editor = null;
-        // this._editorClass = Editor;
-        this._throttledSave = throttle(this._save.bind(this), typeof watchdogConfig.saveInterval === 'number' ? watchdogConfig.saveInterval : 5000);
-        // Set default creator and destructor functions:
-        if (Editor) {
-            this._creator = ((elementOrData, config) => Editor.create(elementOrData, config));
-        }
-        this._destructor = editor => editor.destroy();
-    }
-    /**
-     * The current editor instance.
-     */
-    get editor() {
-        return this._editor;
-    }
-    /**
-     * @internal
-     */
-    get _item() {
-        return this._editor;
-    }
-    /**
-     * Sets the function that is responsible for the editor creation.
-     * It expects a function that should return a promise.
-     *
-     * ```ts
-     * watchdog.setCreator( ( element, config ) => ClassicEditor.create( element, config ) );
-     * ```
-     */
-    setCreator(creator) {
-        this._creator = creator;
-    }
-    /**
-     * Sets the function that is responsible for the editor destruction.
-     * Overrides the default destruction function, which destroys only the editor instance.
-     * It expects a function that should return a promise or `undefined`.
-     *
-     * ```ts
-     * watchdog.setDestructor( editor => {
-     * 	// Do something before the editor is destroyed.
-     *
-     * 	return editor
-     * 		.destroy()
-     * 		.then( () => {
-     * 			// Do something after the editor is destroyed.
-     * 		} );
-     * } );
-     * ```
-     */
-    setDestructor(destructor) {
-        this._destructor = destructor;
-    }
-    /**
-     * Restarts the editor instance. This method is called whenever an editor error occurs. It fires the `restart` event and changes
-     * the state to `initializing`.
-     *
-     * @fires restart
-     */
-    _restart() {
-        return Promise.resolve()
-            .then(() => {
-            this.state = 'initializing';
-            this._fire('stateChange');
-            return this._destroy();
-        })
-            .catch(err => {
-            console.error('An error happened during the editor destroying.', err);
-        })
-            .then(() => {
-            if (typeof this._elementOrData === 'string') {
-                return this.create(this._data, this._config, this._config.context);
-            }
-            else {
-                const updatedConfig = Object.assign({}, this._config, {
-                    initialData: this._data
-                });
-                return this.create(this._elementOrData, updatedConfig, updatedConfig.context);
-            }
-        })
-            .then(() => {
-            this._fire('restart');
-        });
-    }
-    /**
-     * Creates the editor instance and keeps it running, using the defined creator and destructor.
-     *
-     * @param elementOrData The editor source element or the editor data.
-     * @param config The editor configuration.
-     * @param context A context for the editor.
-     */
-    create(elementOrData = this._elementOrData, config = this._config, context) {
-        return Promise.resolve()
-            .then(() => {
-            super._startErrorHandling();
-            this._elementOrData = elementOrData;
-            // Clone configuration because it might be shared within multiple watchdog instances. Otherwise,
-            // when an error occurs in one of these editors, the watchdog will restart all of them.
-            this._config = this._cloneEditorConfiguration(config) || {};
-            this._config.context = context;
-            return this._creator(elementOrData, this._config);
-        })
-            .then(editor => {
-            this._editor = editor;
-            editor.model.document.on('change:data', this._throttledSave);
-            this._lastDocumentVersion = editor.model.document.version;
-            this._data = this._getData();
-            this.state = 'ready';
-            this._fire('stateChange');
-        });
-    }
-    /**
-     * Destroys the watchdog and the current editor instance. It fires the callback
-     * registered in {@link #setDestructor `setDestructor()`} and uses it to destroy the editor instance.
-     * It also sets the state to `destroyed`.
-     */
-    destroy() {
-        return Promise.resolve()
-            .then(() => {
-            this.state = 'destroyed';
-            this._fire('stateChange');
-            super.destroy();
-            return this._destroy();
-        });
-    }
-    _destroy() {
-        return Promise.resolve()
-            .then(() => {
-            this._stopErrorHandling();
-            // Save data if there is a remaining editor data change.
-            this._throttledSave.flush();
-            const editor = this._editor;
-            this._editor = null;
-            // Remove the `change:data` listener before destroying the editor.
-            // Incorrectly written plugins may trigger firing `change:data` events during the editor destruction phase
-            // causing the watchdog to call `editor.getData()` when some parts of editor are already destroyed.
-            editor.model.document.off('change:data', this._throttledSave);
-            return this._destructor(editor);
-        });
-    }
-    /**
-     * Saves the editor data, so it can be restored after the crash even if the data cannot be fetched at
-     * the moment of the crash.
-     */
-    _save() {
-        const version = this._editor.model.document.version;
-        try {
-            this._data = this._getData();
-            this._lastDocumentVersion = version;
-        }
-        catch (err) {
-            console.error(err, 'An error happened during restoring editor data. ' +
-                'Editor will be restored from the previously saved data.');
-        }
-    }
-    /**
-     * @internal
-     */
-    _setExcludedProperties(props) {
-        this._excludedProps = props;
-    }
-    /**
-     * Returns the editor data.
-     */
-    _getData() {
-        const data = {};
-        for (const rootName of this._editor.model.document.getRootNames()) {
-            data[rootName] = this._editor.data.get({ rootName });
-        }
-        return data;
-    }
-    /**
-     * Traverses the error context and the current editor to find out whether these structures are connected
-     * to each other via properties.
-     *
-     * @internal
-     */
-    _isErrorComingFromThisItem(error) {
-        return areConnectedThroughProperties(this._editor, error.context, this._excludedProps);
-    }
-    /**
-     * Clones the editor configuration.
-     */
-    _cloneEditorConfiguration(config) {
-        return cloneDeepWith(config, (value, key) => {
-            // Leave DOM references.
-            if (isElement(value)) {
-                return value;
-            }
-            if (key === 'context') {
-                return value;
-            }
-        });
-    }
-}
+/**
+ * @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 areConnectedThroughProperties from './utils/areconnectedthroughproperties.js';
+import Watchdog from './watchdog.js';
+import { throttle, cloneDeepWith, isElement } from 'lodash-es';
+/**
+ * A watchdog for CKEditor 5 editors.
+ *
+ * See the {@glink features/watchdog Watchdog feature guide} to learn the rationale behind it and
+ * how to use it.
+ */
+export default class EditorWatchdog extends Watchdog {
+    /**
+     * @param Editor The editor class.
+     * @param watchdogConfig The watchdog plugin configuration.
+     */
+    constructor(Editor, watchdogConfig = {}) {
+        super(watchdogConfig);
+        /**
+         * The current editor instance.
+         */
+        this._editor = null;
+        // this._editorClass = Editor;
+        this._throttledSave = throttle(this._save.bind(this), typeof watchdogConfig.saveInterval === 'number' ? watchdogConfig.saveInterval : 5000);
+        // Set default creator and destructor functions:
+        if (Editor) {
+            this._creator = ((elementOrData, config) => Editor.create(elementOrData, config));
+        }
+        this._destructor = editor => editor.destroy();
+    }
+    /**
+     * The current editor instance.
+     */
+    get editor() {
+        return this._editor;
+    }
+    /**
+     * @internal
+     */
+    get _item() {
+        return this._editor;
+    }
+    /**
+     * Sets the function that is responsible for the editor creation.
+     * It expects a function that should return a promise.
+     *
+     * ```ts
+     * watchdog.setCreator( ( element, config ) => ClassicEditor.create( element, config ) );
+     * ```
+     */
+    setCreator(creator) {
+        this._creator = creator;
+    }
+    /**
+     * Sets the function that is responsible for the editor destruction.
+     * Overrides the default destruction function, which destroys only the editor instance.
+     * It expects a function that should return a promise or `undefined`.
+     *
+     * ```ts
+     * watchdog.setDestructor( editor => {
+     * 	// Do something before the editor is destroyed.
+     *
+     * 	return editor
+     * 		.destroy()
+     * 		.then( () => {
+     * 			// Do something after the editor is destroyed.
+     * 		} );
+     * } );
+     * ```
+     */
+    setDestructor(destructor) {
+        this._destructor = destructor;
+    }
+    /**
+     * Restarts the editor instance. This method is called whenever an editor error occurs. It fires the `restart` event and changes
+     * the state to `initializing`.
+     *
+     * @fires restart
+     */
+    _restart() {
+        return Promise.resolve()
+            .then(() => {
+            this.state = 'initializing';
+            this._fire('stateChange');
+            return this._destroy();
+        })
+            .catch(err => {
+            console.error('An error happened during the editor destroying.', err);
+        })
+            .then(() => {
+            if (typeof this._elementOrData === 'string') {
+                return this.create(this._data, this._config, this._config.context);
+            }
+            else {
+                const updatedConfig = Object.assign({}, this._config, {
+                    initialData: this._data
+                });
+                return this.create(this._elementOrData, updatedConfig, updatedConfig.context);
+            }
+        })
+            .then(() => {
+            this._fire('restart');
+        });
+    }
+    /**
+     * Creates the editor instance and keeps it running, using the defined creator and destructor.
+     *
+     * @param elementOrData The editor source element or the editor data.
+     * @param config The editor configuration.
+     * @param context A context for the editor.
+     */
+    create(elementOrData = this._elementOrData, config = this._config, context) {
+        return Promise.resolve()
+            .then(() => {
+            super._startErrorHandling();
+            this._elementOrData = elementOrData;
+            // Clone configuration because it might be shared within multiple watchdog instances. Otherwise,
+            // when an error occurs in one of these editors, the watchdog will restart all of them.
+            this._config = this._cloneEditorConfiguration(config) || {};
+            this._config.context = context;
+            return this._creator(elementOrData, this._config);
+        })
+            .then(editor => {
+            this._editor = editor;
+            editor.model.document.on('change:data', this._throttledSave);
+            this._lastDocumentVersion = editor.model.document.version;
+            this._data = this._getData();
+            this.state = 'ready';
+            this._fire('stateChange');
+        });
+    }
+    /**
+     * Destroys the watchdog and the current editor instance. It fires the callback
+     * registered in {@link #setDestructor `setDestructor()`} and uses it to destroy the editor instance.
+     * It also sets the state to `destroyed`.
+     */
+    destroy() {
+        return Promise.resolve()
+            .then(() => {
+            this.state = 'destroyed';
+            this._fire('stateChange');
+            super.destroy();
+            return this._destroy();
+        });
+    }
+    _destroy() {
+        return Promise.resolve()
+            .then(() => {
+            this._stopErrorHandling();
+            // Save data if there is a remaining editor data change.
+            this._throttledSave.flush();
+            const editor = this._editor;
+            this._editor = null;
+            // Remove the `change:data` listener before destroying the editor.
+            // Incorrectly written plugins may trigger firing `change:data` events during the editor destruction phase
+            // causing the watchdog to call `editor.getData()` when some parts of editor are already destroyed.
+            editor.model.document.off('change:data', this._throttledSave);
+            return this._destructor(editor);
+        });
+    }
+    /**
+     * Saves the editor data, so it can be restored after the crash even if the data cannot be fetched at
+     * the moment of the crash.
+     */
+    _save() {
+        const version = this._editor.model.document.version;
+        try {
+            this._data = this._getData();
+            this._lastDocumentVersion = version;
+        }
+        catch (err) {
+            console.error(err, 'An error happened during restoring editor data. ' +
+                'Editor will be restored from the previously saved data.');
+        }
+    }
+    /**
+     * @internal
+     */
+    _setExcludedProperties(props) {
+        this._excludedProps = props;
+    }
+    /**
+     * Returns the editor data.
+     */
+    _getData() {
+        const data = {};
+        for (const rootName of this._editor.model.document.getRootNames()) {
+            data[rootName] = this._editor.data.get({ rootName });
+        }
+        return data;
+    }
+    /**
+     * Traverses the error context and the current editor to find out whether these structures are connected
+     * to each other via properties.
+     *
+     * @internal
+     */
+    _isErrorComingFromThisItem(error) {
+        return areConnectedThroughProperties(this._editor, error.context, this._excludedProps);
+    }
+    /**
+     * Clones the editor configuration.
+     */
+    _cloneEditorConfiguration(config) {
+        return cloneDeepWith(config, (value, key) => {
+            // Leave DOM references.
+            if (isElement(value)) {
+                return value;
+            }
+            if (key === 'context') {
+                return value;
+            }
+        });
+    }
+}

package/src/index.d.ts

@@ -1,10 +1,10 @@
-/**
- * @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 watchdog
- */
-export { default as ContextWatchdog } from './contextwatchdog';
-export { default as EditorWatchdog } from './editorwatchdog';
-export { default as Watchdog } from './watchdog';
+/**
+ * @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 watchdog
+ */
+export { default as ContextWatchdog } from './contextwatchdog.js';
+export { default as EditorWatchdog } from './editorwatchdog.js';
+export { default as Watchdog } from './watchdog.js';

package/src/index.js

@@ -1,10 +1,10 @@
-/**
- * @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 watchdog
- */
-export { default as ContextWatchdog } from './contextwatchdog';
-export { default as EditorWatchdog } from './editorwatchdog';
-export { default as Watchdog } from './watchdog';
+/**
+ * @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 watchdog
+ */
+export { default as ContextWatchdog } from './contextwatchdog.js';
+export { default as EditorWatchdog } from './editorwatchdog.js';
+export { default as Watchdog } from './watchdog.js';

package/src/utils/areconnectedthroughproperties.d.ts

@@ -1,8 +1,8 @@
-/**
- * @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
- */
-/**
- * Traverses both structures to find out whether there is a reference that is shared between both structures.
- */
-export default function areConnectedThroughProperties(target1: unknown, target2: unknown, excludedNodes?: Set<unknown>): 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
+ */
+/**
+ * Traverses both structures to find out whether there is a reference that is shared between both structures.
+ */
+export default function areConnectedThroughProperties(target1: unknown, target2: unknown, excludedNodes?: Set<unknown>): boolean;

package/src/utils/areconnectedthroughproperties.js

@@ -1,58 +1,58 @@
-/**
- * @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 watchdog/utils/areconnectedthroughproperties
- */
-/* globals console */
-import getSubNodes from './getsubnodes';
-/**
- * Traverses both structures to find out whether there is a reference that is shared between both structures.
- */
-export default function areConnectedThroughProperties(target1, target2, excludedNodes = new Set()) {
-    if (target1 === target2 && isObject(target1)) {
-        return true;
-    }
-    // @if CK_DEBUG_WATCHDOG // return checkConnectionBetweenProps( target1, target2, excludedNodes );
-    const subNodes1 = getSubNodes(target1, excludedNodes);
-    const subNodes2 = getSubNodes(target2, excludedNodes);
-    for (const node of subNodes1) {
-        if (subNodes2.has(node)) {
-            return true;
-        }
-    }
-    return false;
-}
-/* istanbul ignore next -- @preserve */
-// eslint-disable-next-line
-function checkConnectionBetweenProps(target1, target2, excludedNodes) {
-    const { subNodes: subNodes1, prevNodeMap: prevNodeMap1 } = getSubNodes(target1, excludedNodes.subNodes);
-    const { subNodes: subNodes2, prevNodeMap: prevNodeMap2 } = getSubNodes(target2, excludedNodes.subNodes);
-    for (const sharedNode of subNodes1) {
-        if (subNodes2.has(sharedNode)) {
-            const connection = [];
-            connection.push(sharedNode);
-            let node = prevNodeMap1.get(sharedNode);
-            while (node && node !== target1) {
-                connection.push(node);
-                node = prevNodeMap1.get(node);
-            }
-            node = prevNodeMap2.get(sharedNode);
-            while (node && node !== target2) {
-                connection.unshift(node);
-                node = prevNodeMap2.get(node);
-            }
-            console.log('--------');
-            console.log({ target1 });
-            console.log({ sharedNode });
-            console.log({ target2 });
-            console.log({ connection });
-            return true;
-        }
-    }
-    return false;
-}
-function isObject(structure) {
-    return typeof structure === 'object' && structure !== null;
-}
+/**
+ * @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 watchdog/utils/areconnectedthroughproperties
+ */
+/* globals console */
+import getSubNodes from './getsubnodes.js';
+/**
+ * Traverses both structures to find out whether there is a reference that is shared between both structures.
+ */
+export default function areConnectedThroughProperties(target1, target2, excludedNodes = new Set()) {
+    if (target1 === target2 && isObject(target1)) {
+        return true;
+    }
+    // @if CK_DEBUG_WATCHDOG // return checkConnectionBetweenProps( target1, target2, excludedNodes );
+    const subNodes1 = getSubNodes(target1, excludedNodes);
+    const subNodes2 = getSubNodes(target2, excludedNodes);
+    for (const node of subNodes1) {
+        if (subNodes2.has(node)) {
+            return true;
+        }
+    }
+    return false;
+}
+/* istanbul ignore next -- @preserve */
+// eslint-disable-next-line
+function checkConnectionBetweenProps(target1, target2, excludedNodes) {
+    const { subNodes: subNodes1, prevNodeMap: prevNodeMap1 } = getSubNodes(target1, excludedNodes.subNodes);
+    const { subNodes: subNodes2, prevNodeMap: prevNodeMap2 } = getSubNodes(target2, excludedNodes.subNodes);
+    for (const sharedNode of subNodes1) {
+        if (subNodes2.has(sharedNode)) {
+            const connection = [];
+            connection.push(sharedNode);
+            let node = prevNodeMap1.get(sharedNode);
+            while (node && node !== target1) {
+                connection.push(node);
+                node = prevNodeMap1.get(node);
+            }
+            node = prevNodeMap2.get(sharedNode);
+            while (node && node !== target2) {
+                connection.unshift(node);
+                node = prevNodeMap2.get(node);
+            }
+            console.log('--------');
+            console.log({ target1 });
+            console.log({ sharedNode });
+            console.log({ target2 });
+            console.log({ connection });
+            return true;
+        }
+    }
+    return false;
+}
+function isObject(structure) {
+    return typeof structure === 'object' && structure !== null;
+}

package/src/utils/getsubnodes.d.ts

@@ -1,8 +1,8 @@
-/**
- * @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 watchdog/utils/getsubnodes
- */
-export default function getSubNodes(head: unknown, excludedProperties?: Set<unknown>): Set<unknown>;
+/**
+ * @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 watchdog/utils/getsubnodes
+ */
+export default function getSubNodes(head: unknown, excludedProperties?: Set<unknown>): Set<unknown>;