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

package/dist/editorwatchdog.d.ts

@@ -1,195 +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 watchdog/editorwatchdog
- */
-import type { CKEditorError } from 'ckeditor5/src/utils.js';
-import type { Editor, EditorConfig, Context } from 'ckeditor5/src/core.js';
-import Watchdog, { type WatchdogConfig } from './watchdog.js';
-/**
- * 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<TEditor extends Editor = Editor> extends Watchdog {
-    /**
-     * The current editor instance.
-     */
-    private _editor;
-    /**
-     * A promise associated with the life cycle of the editor (creation or destruction processes).
-     *
-     * It is used to prevent the initialization of the editor if the previous instance has not been destroyed yet,
-     * and conversely, to prevent the destruction of the editor if it has not been initialized.
-     */
-    private _lifecyclePromise;
-    /**
-     * Throttled save method. The `save()` method is called the specified `saveInterval` after `throttledSave()` is called,
-     * unless a new action happens in the meantime.
-     */
-    private _throttledSave;
-    /**
-     * The latest saved editor data represented as a root name -> root data object.
-     */
-    private _data?;
-    /**
-     * The last document version.
-     */
-    private _lastDocumentVersion?;
-    /**
-     * The editor source element or data.
-     */
-    private _elementOrData?;
-    /**
-     * Specifies whether the editor was initialized using document data (`true`) or HTML elements (`false`).
-     */
-    private _initUsingData;
-    /**
-     * The latest record of the editor editable elements. Used to restart the editor.
-     */
-    private _editables;
-    /**
-     * The editor configuration.
-     */
-    private _config?;
-    /**
-     * The creation method.
-     *
-     * @see #setCreator
-     */
-    protected _creator: EditorCreatorFunction<TEditor>;
-    /**
-     * The destruction method.
-     *
-     * @see #setDestructor
-     */
-    protected _destructor: (editor: Editor) => Promise<unknown>;
-    private _excludedProps?;
-    /**
-     * @param Editor The editor class.
-     * @param watchdogConfig The watchdog plugin configuration.
-     */
-    constructor(Editor: {
-        create(...args: any): Promise<TEditor>;
-    } | null, watchdogConfig?: WatchdogConfig);
-    /**
-     * The current editor instance.
-     */
-    get editor(): TEditor | null;
-    /**
-     * @internal
-     */
-    get _item(): TEditor | null;
-    /**
-     * 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: EditorCreatorFunction<TEditor>): void;
-    /**
-     * 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: (editor: Editor) => Promise<unknown>): void;
-    /**
-     * 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
-     */
-    protected _restart(): Promise<unknown>;
-    /**
-     * 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?: HTMLElement | string | Record<string, string> | Record<string, HTMLElement>, config?: EditorConfig, context?: Context): Promise<unknown>;
-    /**
-     * 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(): Promise<unknown>;
-    private _destroy;
-    /**
-     * 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.
-     */
-    private _save;
-    /**
-     * @internal
-     */
-    _setExcludedProperties(props: Set<unknown>): void;
-    /**
-     * Gets all data that is required to reinitialize editor instance.
-     */
-    private _getData;
-    /**
-     * For each attached model root, returns its HTML editable element (if available).
-     */
-    private _getEditables;
-    /**
-     * Traverses the error context and the current editor to find out whether these structures are connected
-     * to each other via properties.
-     *
-     * @internal
-     */
-    _isErrorComingFromThisItem(error: CKEditorError): boolean;
-    /**
-     * Clones the editor configuration.
-     */
-    private _cloneEditorConfiguration;
-}
-export type EditorData = {
-    roots: Record<string, {
-        content: string;
-        attributes: string;
-        isLoaded: boolean;
-    }>;
-    markers: Record<string, {
-        rangeJSON: {
-            start: any;
-            end: any;
-        };
-        usingOperation: boolean;
-        affectsData: boolean;
-    }>;
-    commentThreads: string;
-    suggestions: string;
-};
-/**
- * Fired after the watchdog restarts the error in case of a crash.
- *
- * @eventName ~EditorWatchdog#restart
- */
-export type EditorWatchdogRestartEvent = {
-    name: 'restart';
-    args: [];
-    return: undefined;
-};
-export type EditorCreatorFunction<TEditor = Editor> = (elementOrData: HTMLElement | string | Record<string, string> | Record<string, HTMLElement>, config: EditorConfig) => Promise<TEditor>;

package/dist/index.d.ts

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

package/dist/utils/areconnectedthroughproperties.d.ts

@@ -1,12 +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
- */
-/**
- * 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/dist/utils/getsubnodes.d.ts

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

package/dist/watchdog.d.ts

@@ -1,233 +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 watchdog/watchdog
- */
-import type { CKEditorError } from 'ckeditor5/src/utils.js';
-import type { EditorWatchdogRestartEvent } from './editorwatchdog.js';
-import type { ContextWatchdogItemErrorEvent, ContextWatchdogItemRestartEvent } from './contextwatchdog.js';
-/**
- * An abstract watchdog class that handles most of the error handling process and the state of the underlying component.
- *
- * See the {@glink features/watchdog Watchdog feature guide} to learn the rationale behind it and how to use it.
- *
- * @internal
- */
-export default abstract class Watchdog {
-    /**
-     * An array of crashes saved as an object with the following properties:
-     *
-     * * `message`: `String`,
-     * * `stack`: `String`,
-     * * `date`: `Number`,
-     * * `filename`: `String | undefined`,
-     * * `lineno`: `Number | undefined`,
-     * * `colno`: `Number | undefined`,
-     */
-    readonly crashes: Array<{
-        message: string;
-        stack?: string;
-        date: number;
-        filename?: string;
-        lineno?: number;
-        colno?: number;
-    }>;
-    /**
-     * Specifies the state of the item watched by the watchdog. The state can be one of the following values:
-     *
-     * * `initializing` &ndash; Before the first initialization, and after crashes, before the item is ready.
-     * * `ready` &ndash; A state when the user can interact with the item.
-     * * `crashed` &ndash; A state when an error occurs. It quickly changes to `initializing` or `crashedPermanently`
-     * depending on how many and how frequent errors have been caught recently.
-     * * `crashedPermanently` &ndash; A state when the watchdog stops reacting to errors and keeps the item it is watching crashed,
-     * * `destroyed` &ndash; A state when the item is manually destroyed by the user after calling `watchdog.destroy()`.
-     */
-    state: WatchdogState;
-    /**
-     * @see module:watchdog/watchdog~WatchdogConfig
-     */
-    private _crashNumberLimit;
-    /**
-     * Returns the result of the `Date.now()` call. It can be overridden in tests to mock time as some popular
-     * approaches like `sinon.useFakeTimers()` do not work well with error handling.
-     */
-    private _now;
-    /**
-     * @see module:watchdog/watchdog~WatchdogConfig
-     */
-    private _minimumNonErrorTimePeriod;
-    /**
-     * Checks if the event error comes from the underlying item and restarts the item.
-     */
-    private _boundErrorHandler;
-    /**
-     * The method responsible for restarting the watched item.
-     */
-    protected abstract _restart(): Promise<unknown>;
-    /**
-     * Traverses the error context and the watched item to find out whether the error should
-     * be handled by the given item.
-     *
-     * @internal
-     */
-    abstract _isErrorComingFromThisItem(error: CKEditorError): boolean;
-    /**
-     * The watched item.
-     *
-     * @internal
-     */
-    abstract get _item(): unknown;
-    /**
-     * A dictionary of event emitter listeners.
-     */
-    private _listeners;
-    /**
-     * @param {module:watchdog/watchdog~WatchdogConfig} config The watchdog plugin configuration.
-     */
-    constructor(config: WatchdogConfig);
-    /**
-     * Destroys the watchdog and releases the resources.
-     */
-    destroy(): void;
-    /**
-     * Starts listening to a specific event name by registering a callback that will be executed
-     * whenever an event with a given name fires.
-     *
-     * Note that this method differs from the CKEditor 5's default `EventEmitterMixin` implementation.
-     *
-     * @param eventName The event name.
-     * @param callback A callback which will be added to event listeners.
-     */
-    on<K extends keyof EventMap>(eventName: K, callback: EventCallback<K>): void;
-    /**
-     * Stops listening to the specified event name by removing the callback from event listeners.
-     *
-     * Note that this method differs from the CKEditor 5's default `EventEmitterMixin` implementation.
-     *
-     * @param eventName The event name.
-     * @param callback A callback which will be removed from event listeners.
-     */
-    off(eventName: keyof EventMap, callback: unknown): void;
-    /**
-     * Fires an event with a given event name and arguments.
-     *
-     * Note that this method differs from the CKEditor 5's default `EventEmitterMixin` implementation.
-     */
-    protected _fire<K extends keyof EventMap>(eventName: K, ...args: EventArgs<K>): void;
-    /**
-     * Starts error handling by attaching global error handlers.
-     */
-    protected _startErrorHandling(): void;
-    /**
-     * Stops error handling by detaching global error handlers.
-     */
-    protected _stopErrorHandling(): void;
-    /**
-     * Checks if an error comes from the watched item and restarts it.
-     * It reacts to {@link module:utils/ckeditorerror~CKEditorError `CKEditorError` errors} only.
-     *
-     * @fires error
-     * @param error Error.
-     * @param evt An error event.
-     */
-    private _handleError;
-    /**
-     * Checks whether an error should be handled by the watchdog.
-     *
-     * @param error An error that was caught by the error handling process.
-     */
-    private _shouldReactToError;
-    /**
-     * Checks if the watchdog should restart the underlying item.
-     */
-    private _shouldRestart;
-}
-/**
- * Fired when a new {@link module:utils/ckeditorerror~CKEditorError `CKEditorError`} error connected to the watchdog instance occurs
- * and the watchdog will react to it.
- *
- * ```ts
- * watchdog.on( 'error', ( evt, { error, causesRestart } ) => {
- * 	console.log( 'An error occurred.' );
- * } );
- * ```
- *
- * @eventName ~Watchdog#error
- */
-export type WatchdogErrorEvent = {
-    name: 'error';
-    args: [WatchdogErrorEventData];
-};
-/**
- * The `error` event data.
- */
-export type WatchdogErrorEventData = {
-    error: Error;
-    causesRestart: boolean;
-};
-/**
- * Fired when the watchdog state changed.
- *
- * @eventName ~Watchdog#stateChange
- */
-export type WatchdogStateChangeEvent = {
-    name: 'stateChange';
-    args: [];
-};
-/**
- * The map of watchdog events.
- */
-export interface EventMap {
-    stateChange: WatchdogStateChangeEvent;
-    error: WatchdogErrorEvent;
-    restart: EditorWatchdogRestartEvent;
-    itemError: ContextWatchdogItemErrorEvent;
-    itemRestart: ContextWatchdogItemRestartEvent;
-}
-/**
- * Utility type that gets the arguments type for the given event.
- */
-export type EventArgs<K extends keyof EventMap> = EventMap[K]['args'];
-/**
- * Utility type that gets the callback type for the given event.
- */
-export type EventCallback<K extends keyof EventMap> = (evt: null, ...args: EventArgs<K>) => void;
-/**
- * The watchdog plugin configuration.
- */
-export interface WatchdogConfig {
-    /**
-     * A threshold specifying the number of watched item crashes
-     * when the watchdog stops restarting the item in case of errors.
-     * After this limit is reached and the time between the last errors is shorter than `minimumNonErrorTimePeriod`,
-     * the watchdog changes its state to `crashedPermanently` and it stops restarting the item. This prevents an infinite restart loop.
-     *
-     * @default 3
-     */
-    crashNumberLimit?: number;
-    /**
-     * An average number of milliseconds between the last watched item errors
-     * (defaults to 5000). When the period of time between errors is lower than that and the `crashNumberLimit` is also reached,
-     * the watchdog changes its state to `crashedPermanently` and it stops restarting the item. This prevents an infinite restart loop.
-     *
-     * @default 5000
-     */
-    minimumNonErrorTimePeriod?: number;
-    /**
-     * A minimum number of milliseconds between saving the editor data internally (defaults to 5000).
-     * Note that for large documents this might impact the editor performance.
-     *
-     * @default 5000
-     */
-    saveInterval?: number;
-}
-/**
- * Specifies the state of the item watched by the watchdog.
- */
-export type WatchdogState = 'initializing' | 'ready' | 'crashed' | 'crashedPermanently' | 'destroyed';