@ckeditor/ckeditor5-core 40.0.0 → 40.2.0

package/src/plugin.js

@@ -1,106 +1,106 @@
-/**
- * @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 core/plugin
- */
-/* eslint-disable @typescript-eslint/no-invalid-void-type */
-import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
-/**
- * The base class for CKEditor plugin classes.
- */
-export default class Plugin extends ObservableMixin() {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super();
-        /**
-         * Holds identifiers for {@link #forceDisabled} mechanism.
-         */
-        this._disableStack = new Set();
-        this.editor = editor;
-        this.set('isEnabled', true);
-    }
-    /**
-     * Disables the plugin.
-     *
-     * Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed
-     * (e.g. feature name). The same identifier should be used when {@link #clearForceDisabled enabling back} the plugin.
-     * The plugin becomes enabled only after all features {@link #clearForceDisabled enabled it back}.
-     *
-     * Disabling and enabling a plugin:
-     *
-     * ```ts
-     * plugin.isEnabled; // -> true
-     * plugin.forceDisabled( 'MyFeature' );
-     * plugin.isEnabled; // -> false
-     * plugin.clearForceDisabled( 'MyFeature' );
-     * plugin.isEnabled; // -> true
-     * ```
-     *
-     * Plugin disabled by multiple features:
-     *
-     * ```ts
-     * plugin.forceDisabled( 'MyFeature' );
-     * plugin.forceDisabled( 'OtherFeature' );
-     * plugin.clearForceDisabled( 'MyFeature' );
-     * plugin.isEnabled; // -> false
-     * plugin.clearForceDisabled( 'OtherFeature' );
-     * plugin.isEnabled; // -> true
-     * ```
-     *
-     * Multiple disabling with the same identifier is redundant:
-     *
-     * ```ts
-     * plugin.forceDisabled( 'MyFeature' );
-     * plugin.forceDisabled( 'MyFeature' );
-     * plugin.clearForceDisabled( 'MyFeature' );
-     * plugin.isEnabled; // -> true
-     * ```
-     *
-     * **Note:** some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins,
-     * so the plugin might be still disabled after {@link #clearForceDisabled} was used.
-     *
-     * @param id Unique identifier for disabling. Use the same id when {@link #clearForceDisabled enabling back} the plugin.
-     */
-    forceDisabled(id) {
-        this._disableStack.add(id);
-        if (this._disableStack.size == 1) {
-            this.on('set:isEnabled', forceDisable, { priority: 'highest' });
-            this.isEnabled = false;
-        }
-    }
-    /**
-     * Clears forced disable previously set through {@link #forceDisabled}. See {@link #forceDisabled}.
-     *
-     * @param id Unique identifier, equal to the one passed in {@link #forceDisabled} call.
-     */
-    clearForceDisabled(id) {
-        this._disableStack.delete(id);
-        if (this._disableStack.size == 0) {
-            this.off('set:isEnabled', forceDisable);
-            this.isEnabled = true;
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        this.stopListening();
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isContextPlugin() {
-        return false;
-    }
-}
-/**
- * Helper function that forces plugin to be disabled.
- */
-function forceDisable(evt) {
-    evt.return = false;
-    evt.stop();
-}
+/**
+ * @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 core/plugin
+ */
+/* eslint-disable @typescript-eslint/no-invalid-void-type */
+import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
+/**
+ * The base class for CKEditor plugin classes.
+ */
+export default class Plugin extends ObservableMixin() {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super();
+        /**
+         * Holds identifiers for {@link #forceDisabled} mechanism.
+         */
+        this._disableStack = new Set();
+        this.editor = editor;
+        this.set('isEnabled', true);
+    }
+    /**
+     * Disables the plugin.
+     *
+     * Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed
+     * (e.g. feature name). The same identifier should be used when {@link #clearForceDisabled enabling back} the plugin.
+     * The plugin becomes enabled only after all features {@link #clearForceDisabled enabled it back}.
+     *
+     * Disabling and enabling a plugin:
+     *
+     * ```ts
+     * plugin.isEnabled; // -> true
+     * plugin.forceDisabled( 'MyFeature' );
+     * plugin.isEnabled; // -> false
+     * plugin.clearForceDisabled( 'MyFeature' );
+     * plugin.isEnabled; // -> true
+     * ```
+     *
+     * Plugin disabled by multiple features:
+     *
+     * ```ts
+     * plugin.forceDisabled( 'MyFeature' );
+     * plugin.forceDisabled( 'OtherFeature' );
+     * plugin.clearForceDisabled( 'MyFeature' );
+     * plugin.isEnabled; // -> false
+     * plugin.clearForceDisabled( 'OtherFeature' );
+     * plugin.isEnabled; // -> true
+     * ```
+     *
+     * Multiple disabling with the same identifier is redundant:
+     *
+     * ```ts
+     * plugin.forceDisabled( 'MyFeature' );
+     * plugin.forceDisabled( 'MyFeature' );
+     * plugin.clearForceDisabled( 'MyFeature' );
+     * plugin.isEnabled; // -> true
+     * ```
+     *
+     * **Note:** some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins,
+     * so the plugin might be still disabled after {@link #clearForceDisabled} was used.
+     *
+     * @param id Unique identifier for disabling. Use the same id when {@link #clearForceDisabled enabling back} the plugin.
+     */
+    forceDisabled(id) {
+        this._disableStack.add(id);
+        if (this._disableStack.size == 1) {
+            this.on('set:isEnabled', forceDisable, { priority: 'highest' });
+            this.isEnabled = false;
+        }
+    }
+    /**
+     * Clears forced disable previously set through {@link #forceDisabled}. See {@link #forceDisabled}.
+     *
+     * @param id Unique identifier, equal to the one passed in {@link #forceDisabled} call.
+     */
+    clearForceDisabled(id) {
+        this._disableStack.delete(id);
+        if (this._disableStack.size == 0) {
+            this.off('set:isEnabled', forceDisable);
+            this.isEnabled = true;
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        this.stopListening();
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isContextPlugin() {
+        return false;
+    }
+}
+/**
+ * Helper function that forces plugin to be disabled.
+ */
+function forceDisable(evt) {
+    evt.return = false;
+    evt.stop();
+}

package/src/plugincollection.d.ts

@@ -1,117 +1,117 @@
-/**
- * @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 { LoadedPlugins, PluginClassConstructor, PluginConstructor, PluginInterface } from './plugin';
-declare const PluginCollection_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Emitter;
-    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
-};
-/**
- * Manages a list of CKEditor plugins, including loading, resolving dependencies and initialization.
- */
-export default class PluginCollection<TContext extends object> extends PluginCollection_base implements Iterable<PluginEntry<TContext>> {
-    private _context;
-    private _plugins;
-    /**
-     * A map of plugin constructors that can be retrieved by their names.
-     */
-    private _availablePlugins;
-    /**
-     * Map of {@link module:core/contextplugin~ContextPlugin context plugins} which can be retrieved by their constructors or instances.
-     */
-    private _contextPlugins;
-    /**
-     * Creates an instance of the plugin collection class.
-     * Allows loading and initializing plugins and their dependencies.
-     * Allows providing a list of already loaded plugins. These plugins will not be destroyed along with this collection.
-     *
-     * @param availablePlugins Plugins (constructors) which the collection will be able to use
-     * when {@link module:core/plugincollection~PluginCollection#init} is used with the plugin names (strings, instead of constructors).
-     * Usually, the editor will pass its built-in plugins to the collection so they can later be
-     * used in `config.plugins` or `config.removePlugins` by names.
-     * @param contextPlugins A list of already initialized plugins represented by a `[ PluginConstructor, pluginInstance ]` pair.
-     */
-    constructor(context: TContext, availablePlugins?: Iterable<PluginConstructor<TContext>>, contextPlugins?: Iterable<PluginEntry<TContext>>);
-    /**
-     * Iterable interface.
-     *
-     * Returns `[ PluginConstructor, pluginInstance ]` pairs.
-     */
-    [Symbol.iterator](): IterableIterator<PluginEntry<TContext>>;
-    get<TConstructor extends PluginClassConstructor<TContext>>(key: TConstructor): InstanceType<TConstructor>;
-    get<TName extends string>(key: TName): PluginsMap[TName];
-    /**
-     * Checks if a plugin is loaded.
-     *
-     * ```ts
-     * // Check if the 'Clipboard' plugin was loaded.
-     * if ( editor.plugins.has( 'ClipboardPipeline' ) ) {
-     * 	// Now use the clipboard plugin instance:
-     * 	const clipboard = editor.plugins.get( 'ClipboardPipeline' );
-     *
-     * 	// ...
-     * }
-     * ```
-     *
-     * @param key The plugin constructor or {@link module:core/plugin~PluginStaticMembers#pluginName name}.
-     */
-    has(key: PluginConstructor<TContext> | string): boolean;
-    /**
-     * Initializes a set of plugins and adds them to the collection.
-     *
-     * @param plugins An array of {@link module:core/plugin~PluginInterface plugin constructors}
-     * or {@link module:core/plugin~PluginStaticMembers#pluginName plugin names}.
-     * @param pluginsToRemove Names of the plugins or plugin constructors
-     * that should not be loaded (despite being specified in the `plugins` array).
-     * @param pluginsSubstitutions An array of {@link module:core/plugin~PluginInterface plugin constructors}
-     * that will be used to replace plugins of the same names that were passed in `plugins` or that are in their dependency tree.
-     * A useful option for replacing built-in plugins while creating tests (for mocking their APIs). Plugins that will be replaced
-     * must follow these rules:
-     *   * The new plugin must be a class.
-     *   * The new plugin must be named.
-     *   * Both plugins must not depend on other plugins.
-     * @returns A promise which gets resolved once all plugins are loaded and available in the collection.
-     */
-    init(plugins: ReadonlyArray<PluginConstructor<TContext> | string>, pluginsToRemove?: ReadonlyArray<PluginConstructor<TContext> | string>, pluginsSubstitutions?: ReadonlyArray<PluginConstructor<TContext>>): Promise<LoadedPlugins>;
-    /**
-     * Destroys all loaded plugins.
-     */
-    destroy(): Promise<unknown>;
-    /**
-     * Adds the plugin to the collection. Exposed mainly for testing purposes.
-     *
-     * @param PluginConstructor The plugin constructor.
-     * @param plugin The instance of the plugin.
-     */
-    private _add;
-}
-/**
- * A `[ PluginConstructor, pluginInstance ]` pair.
- */
-export type PluginEntry<TContext> = [PluginConstructor<TContext>, PluginInterface];
-/**
- * Helper type that maps plugin names to their types.
- * It is meant to be extended with module augmentation.
- *
- * ```ts
- * class MyPlugin extends Plugin {
- * 	public static pluginName() {
- * 		return 'MyPlugin' as const;
- * 	}
- * }
- *
- * declare module '@ckeditor/ckeditor5-core' {
- * 	interface PluginsMap {
- * 		[ MyPlugin.pluginName ]: MyPlugin;
- * 	}
- * }
- *
- * // Returns `MyPlugin`.
- * const myPlugin = editor.plugins.get( 'MyPlugin' );
- * ```
- */
-export interface PluginsMap {
-    [name: string]: PluginInterface;
-}
-export {};
+/**
+ * @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 { LoadedPlugins, PluginClassConstructor, PluginConstructor, PluginInterface } from './plugin';
+declare const PluginCollection_base: {
+    new (): import("@ckeditor/ckeditor5-utils").Emitter;
+    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
+};
+/**
+ * Manages a list of CKEditor plugins, including loading, resolving dependencies and initialization.
+ */
+export default class PluginCollection<TContext extends object> extends PluginCollection_base implements Iterable<PluginEntry<TContext>> {
+    private _context;
+    private _plugins;
+    /**
+     * A map of plugin constructors that can be retrieved by their names.
+     */
+    private _availablePlugins;
+    /**
+     * Map of {@link module:core/contextplugin~ContextPlugin context plugins} which can be retrieved by their constructors or instances.
+     */
+    private _contextPlugins;
+    /**
+     * Creates an instance of the plugin collection class.
+     * Allows loading and initializing plugins and their dependencies.
+     * Allows providing a list of already loaded plugins. These plugins will not be destroyed along with this collection.
+     *
+     * @param availablePlugins Plugins (constructors) which the collection will be able to use
+     * when {@link module:core/plugincollection~PluginCollection#init} is used with the plugin names (strings, instead of constructors).
+     * Usually, the editor will pass its built-in plugins to the collection so they can later be
+     * used in `config.plugins` or `config.removePlugins` by names.
+     * @param contextPlugins A list of already initialized plugins represented by a `[ PluginConstructor, pluginInstance ]` pair.
+     */
+    constructor(context: TContext, availablePlugins?: Iterable<PluginConstructor<TContext>>, contextPlugins?: Iterable<PluginEntry<TContext>>);
+    /**
+     * Iterable interface.
+     *
+     * Returns `[ PluginConstructor, pluginInstance ]` pairs.
+     */
+    [Symbol.iterator](): IterableIterator<PluginEntry<TContext>>;
+    get<TConstructor extends PluginClassConstructor<TContext>>(key: TConstructor): InstanceType<TConstructor>;
+    get<TName extends string>(key: TName): PluginsMap[TName];
+    /**
+     * Checks if a plugin is loaded.
+     *
+     * ```ts
+     * // Check if the 'Clipboard' plugin was loaded.
+     * if ( editor.plugins.has( 'ClipboardPipeline' ) ) {
+     * 	// Now use the clipboard plugin instance:
+     * 	const clipboard = editor.plugins.get( 'ClipboardPipeline' );
+     *
+     * 	// ...
+     * }
+     * ```
+     *
+     * @param key The plugin constructor or {@link module:core/plugin~PluginStaticMembers#pluginName name}.
+     */
+    has(key: PluginConstructor<TContext> | string): boolean;
+    /**
+     * Initializes a set of plugins and adds them to the collection.
+     *
+     * @param plugins An array of {@link module:core/plugin~PluginInterface plugin constructors}
+     * or {@link module:core/plugin~PluginStaticMembers#pluginName plugin names}.
+     * @param pluginsToRemove Names of the plugins or plugin constructors
+     * that should not be loaded (despite being specified in the `plugins` array).
+     * @param pluginsSubstitutions An array of {@link module:core/plugin~PluginInterface plugin constructors}
+     * that will be used to replace plugins of the same names that were passed in `plugins` or that are in their dependency tree.
+     * A useful option for replacing built-in plugins while creating tests (for mocking their APIs). Plugins that will be replaced
+     * must follow these rules:
+     *   * The new plugin must be a class.
+     *   * The new plugin must be named.
+     *   * Both plugins must not depend on other plugins.
+     * @returns A promise which gets resolved once all plugins are loaded and available in the collection.
+     */
+    init(plugins: ReadonlyArray<PluginConstructor<TContext> | string>, pluginsToRemove?: ReadonlyArray<PluginConstructor<TContext> | string>, pluginsSubstitutions?: ReadonlyArray<PluginConstructor<TContext>>): Promise<LoadedPlugins>;
+    /**
+     * Destroys all loaded plugins.
+     */
+    destroy(): Promise<unknown>;
+    /**
+     * Adds the plugin to the collection. Exposed mainly for testing purposes.
+     *
+     * @param PluginConstructor The plugin constructor.
+     * @param plugin The instance of the plugin.
+     */
+    private _add;
+}
+/**
+ * A `[ PluginConstructor, pluginInstance ]` pair.
+ */
+export type PluginEntry<TContext> = [PluginConstructor<TContext>, PluginInterface];
+/**
+ * Helper type that maps plugin names to their types.
+ * It is meant to be extended with module augmentation.
+ *
+ * ```ts
+ * class MyPlugin extends Plugin {
+ * 	public static pluginName() {
+ * 		return 'MyPlugin' as const;
+ * 	}
+ * }
+ *
+ * declare module '@ckeditor/ckeditor5-core' {
+ * 	interface PluginsMap {
+ * 		[ MyPlugin.pluginName ]: MyPlugin;
+ * 	}
+ * }
+ *
+ * // Returns `MyPlugin`.
+ * const myPlugin = editor.plugins.get( 'MyPlugin' );
+ * ```
+ */
+export interface PluginsMap {
+    [name: string]: PluginInterface;
+}
+export {};