@ckeditor/ckeditor5-core 47.6.1 → 48.0.0-alpha.0

package/src/editor/editorconfig.js

@@ -1,5 +0,0 @@
-/**
- * @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
- */
-export {};

package/src/editor/utils/attachtoform.js

@@ -1,57 +0,0 @@
-/**
- * @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
- */
-/**
- * @module core/editor/utils/attachtoform
- */
-import { isFunction } from 'es-toolkit/compat';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * Checks if the editor is initialized on a `<textarea>` element that belongs to a form. If yes, it updates the editor's element
- * content before submitting the form.
- *
- * This helper requires the {@link module:core/editor/utils/elementapimixin~ElementApi ElementApi interface}.
- *
- * @param editor Editor instance.
- */
-export function attachToForm(editor) {
-    if (!isFunction(editor.updateSourceElement)) {
-        /**
-         * The editor passed to `attachToForm()` must implement the
-         * {@link module:core/editor/utils/elementapimixin~ElementApi} interface.
-         *
-         * @error attachtoform-missing-elementapi-interface
-         */
-        throw new CKEditorError('attachtoform-missing-elementapi-interface', editor);
-    }
-    const sourceElement = editor.sourceElement;
-    // Only when replacing a textarea which is inside of a form element.
-    if (isTextArea(sourceElement) && sourceElement.form) {
-        let originalSubmit;
-        const form = sourceElement.form;
-        const onSubmit = () => editor.updateSourceElement();
-        // Replace the original form#submit() to call a custom submit function first.
-        // Check if #submit is a function because the form might have an input named "submit".
-        if (isFunction(form.submit)) {
-            originalSubmit = form.submit;
-            form.submit = () => {
-                onSubmit();
-                originalSubmit.apply(form);
-            };
-        }
-        // Update the replaced textarea with data before each form#submit event.
-        form.addEventListener('submit', onSubmit);
-        // Remove the submit listener and revert the original submit method on
-        // editor#destroy.
-        editor.on('destroy', () => {
-            form.removeEventListener('submit', onSubmit);
-            if (originalSubmit) {
-                form.submit = originalSubmit;
-            }
-        });
-    }
-}
-function isTextArea(sourceElement) {
-    return !!sourceElement && sourceElement.tagName.toLowerCase() === 'textarea';
-}

package/src/editor/utils/editorusagedata.js

@@ -1,127 +0,0 @@
-/**
- * @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
- */
-/**
- * @module core/editor/utils/editorusagedata
- */
-import { env, global, uid } from '@ckeditor/ckeditor5-utils';
-/**
- * This part of the code is not executed in open-source implementations using a GPL key.
- * It only runs when a specific license key is provided. If you are uncertain whether
- * this applies to your installation, please contact our support team.
- *
- * @internal
- */
-export function getEditorUsageData(editor) {
-    return {
-        sessionId: getSessionId(),
-        pageSessionId: getPageSessionID(),
-        hostname: window.location.hostname,
-        version: globalThis.CKEDITOR_VERSION,
-        type: getEditorType(editor),
-        plugins: getPluginsUsageData(editor.plugins),
-        distribution: getDistributionUsageData(),
-        env: getEnvUsageData(),
-        integration: Object.create(null),
-        menuBar: {
-            isVisible: !!editor.config.get('menuBar.isVisible')
-        },
-        language: {
-            ui: editor.locale.uiLanguage,
-            content: editor.locale.contentLanguage
-        },
-        toolbar: {
-            main: getToolbarUsageData(editor.config.get('toolbar')),
-            block: getToolbarUsageData(editor.config.get('blockToolbar')),
-            balloon: getToolbarUsageData(editor.config.get('balloonToolbar'))
-        }
-    };
-}
-function getEditorType(editor) {
-    return Object.getPrototypeOf(editor).constructor.editorName;
-}
-function getPluginsUsageData(collection) {
-    return Array
-        .from(collection)
-        .filter(([PluginConstructor]) => !!PluginConstructor.pluginName)
-        .map(([PluginConstructor]) => {
-        const { pluginName, isContextPlugin, isOfficialPlugin, isPremiumPlugin } = PluginConstructor;
-        return {
-            isContext: !!isContextPlugin,
-            isOfficial: !!isOfficialPlugin,
-            isPremium: !!isPremiumPlugin,
-            name: pluginName
-        };
-    });
-}
-function getToolbarUsageData(toolbarConfig) {
-    if (!toolbarConfig) {
-        return undefined;
-    }
-    const normalizedToolbar = Array.isArray(toolbarConfig) ?
-        { items: toolbarConfig } :
-        toolbarConfig;
-    const flattenToolbarConfigNames = extractToolbarConfigItemsNames(normalizedToolbar.items || []);
-    const isMultiline = flattenToolbarConfigNames.includes('-');
-    return {
-        isMultiline,
-        shouldNotGroupWhenFull: !!normalizedToolbar.shouldNotGroupWhenFull,
-        items: stripToolbarSeparatorItems(flattenToolbarConfigNames)
-    };
-    function stripToolbarSeparatorItems(items) {
-        return items.filter((item) => item !== '|' && item !== '-');
-    }
-    function extractToolbarConfigItemsNames(items) {
-        return items.flatMap(item => {
-            if (typeof item === 'string') {
-                return [item];
-            }
-            return extractToolbarConfigItemsNames(item.items);
-        });
-    }
-}
-function getDistributionUsageData() {
-    return {
-        channel: (window[Symbol.for('cke distribution')] || 'sh')
-    };
-}
-function getEnvUsageData() {
-    let os = 'unknown';
-    let browser = 'unknown';
-    if (env.isMac) {
-        os = 'mac';
-    }
-    else if (env.isWindows) {
-        os = 'windows';
-    }
-    else if (env.isiOS) {
-        os = 'ios';
-    }
-    else if (env.isAndroid) {
-        os = 'android';
-    }
-    if (env.isGecko) {
-        browser = 'gecko';
-    }
-    else if (env.isBlink) {
-        browser = 'blink';
-    }
-    else if (env.isSafari) {
-        browser = 'safari';
-    }
-    return {
-        os,
-        browser
-    };
-}
-function getSessionId() {
-    if (!localStorage.getItem('__ckeditor-session-id')) {
-        localStorage.setItem('__ckeditor-session-id', uid());
-    }
-    return localStorage.getItem('__ckeditor-session-id');
-}
-function getPageSessionID() {
-    global.window.CKEDITOR_PAGE_SESSION_ID = global.window.CKEDITOR_PAGE_SESSION_ID || uid();
-    return global.window.CKEDITOR_PAGE_SESSION_ID;
-}

package/src/editor/utils/elementapimixin.js

@@ -1,42 +0,0 @@
-/**
- * @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
- */
-/**
- * @module core/editor/utils/elementapimixin
- */
-import { CKEditorError, setDataInElement } from '@ckeditor/ckeditor5-utils';
-/**
- * Implementation of the {@link module:core/editor/utils/elementapimixin~ElementApi}.
- */
-export function ElementApiMixin(base) {
-    class Mixin extends base {
-        sourceElement;
-        updateSourceElement(data) {
-            if (!this.sourceElement) {
-                /**
-                 * Cannot update the source element of a detached editor.
-                 *
-                 * The {@link module:core/editor/utils/elementapimixin~ElementApi#updateSourceElement `updateSourceElement()`}
-                 * method cannot be called if you did not pass an element to `Editor.create()`.
-                 *
-                 * @error editor-missing-sourceelement
-                 */
-                throw new CKEditorError('editor-missing-sourceelement', this);
-            }
-            const shouldUpdateSourceElement = this.config.get('updateSourceElementOnDestroy');
-            const isSourceElementTextArea = this.sourceElement instanceof HTMLTextAreaElement;
-            // The data returned by the editor might be unsafe, so we want to prevent rendering
-            // unsafe content inside the source element different than <textarea>, which is considered
-            // secure. This behavior could be changed by setting the `updateSourceElementOnDestroy`
-            // configuration option to `true`.
-            if (!shouldUpdateSourceElement && !isSourceElementTextArea) {
-                setDataInElement(this.sourceElement, '');
-                return;
-            }
-            const dataToSet = typeof data === 'string' ? data : this.data.get();
-            setDataInElement(this.sourceElement, dataToSet);
-        }
-    }
-    return Mixin;
-}

package/src/editor/utils/securesourceelement.js

@@ -1,35 +0,0 @@
-/**
- * @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
- */
-/**
- * @module core/editor/utils/securesourceelement
- */
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * Marks the source element on which the editor was initialized. This prevents other editor instances from using this element.
- *
- * Running multiple editor instances on the same source element causes various issues and it is
- * crucial this helper is called as soon as the source element is known to prevent collisions.
- *
- * @param editor Editor instance.
- * @param sourceElement Element to bind with the editor instance.
- */
-export function secureSourceElement(editor, sourceElement) {
-    if (sourceElement.ckeditorInstance) {
-        /**
-         * A DOM element used to create the editor (e.g.
-         * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`})
-         * has already been used to create another editor instance. Make sure each editor is
-         * created with a unique DOM element.
-         *
-         * @error editor-source-element-already-used
-         * @param {HTMLElement} element DOM element that caused the collision.
-         */
-        throw new CKEditorError('editor-source-element-already-used', editor);
-    }
-    sourceElement.ckeditorInstance = editor;
-    editor.once('destroy', () => {
-        delete sourceElement.ckeditorInstance;
-    });
-}

package/src/index.js

@@ -1,22 +0,0 @@
-/**
- * @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
- */
-/**
- * @module core
- */
-export { Plugin } from './plugin.js';
-export { Command } from './command.js';
-export { MultiCommand } from './multicommand.js';
-export { CommandCollection } from './commandcollection.js';
-export { Context } from './context.js';
-export { ContextPlugin } from './contextplugin.js';
-export { EditingKeystrokeHandler } from './editingkeystrokehandler.js';
-export { Editor } from './editor/editor.js';
-export { attachToForm } from './editor/utils/attachtoform.js';
-export { ElementApiMixin } from './editor/utils/elementapimixin.js';
-export { secureSourceElement } from './editor/utils/securesourceelement.js';
-export { PendingActions } from './pendingactions.js';
-export { Accessibility, DEFAULT_GROUP_ID as _DEFAULT_ACCESSIBILITY_GROUP_ID } from './accessibility.js';
-export { getEditorUsageData as _getEditorUsageData } from './editor/utils/editorusagedata.js';
-import './augmentation.js';

package/src/multicommand.js

@@ -1,79 +0,0 @@
-/**
- * @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
- */
-/**
- * @module core/multicommand
- */
-import { Command } from './command.js';
-import { insertToPriorityArray } from '@ckeditor/ckeditor5-utils';
-/**
- * A CKEditor command that aggregates other commands.
- *
- * This command is used to proxy multiple commands. The multi-command is enabled when
- * at least one of its registered child commands is enabled.
- * When executing a multi-command, the first enabled command with highest priority will be executed.
- *
- * ```ts
- * const multiCommand = new MultiCommand( editor );
- *
- * const commandFoo = new Command( editor );
- * const commandBar = new Command( editor );
- *
- * // Register a child command.
- * multiCommand.registerChildCommand( commandFoo );
- * // Register a child command with a low priority.
- * multiCommand.registerChildCommand( commandBar, { priority: 'low' } );
- *
- * // Enable one of the commands.
- * commandBar.isEnabled = true;
- *
- * multiCommand.execute(); // Will execute commandBar.
- * ```
- */
-export class MultiCommand extends Command {
-    /**
-     * Registered child commands definitions.
-     */
-    _childCommandsDefinitions = [];
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        // Override base command refresh(): the command's state is changed when one of child commands changes states.
-    }
-    /**
-     * Executes the first enabled command which has the highest priority of all registered child commands.
-     *
-     * @returns The value returned by the {@link module:core/command~Command#execute `command.execute()`}.
-     */
-    execute(...args) {
-        const command = this._getFirstEnabledCommand();
-        return !!command && command.execute(args);
-    }
-    /**
-     * Registers a child command.
-     *
-     * @param options An object with configuration options.
-     * @param options.priority Priority of a command to register.
-     */
-    registerChildCommand(command, options = {}) {
-        insertToPriorityArray(this._childCommandsDefinitions, { command, priority: options.priority || 'normal' });
-        // Change multi-command enabled state when one of registered commands changes state.
-        command.on('change:isEnabled', () => this._checkEnabled());
-        this._checkEnabled();
-    }
-    /**
-     * Checks if any of child commands is enabled.
-     */
-    _checkEnabled() {
-        this.isEnabled = !!this._getFirstEnabledCommand();
-    }
-    /**
-     * Returns a first enabled command with the highest priority or `undefined` if none of them is enabled.
-     */
-    _getFirstEnabledCommand() {
-        const commandDefinition = this._childCommandsDefinitions.find(({ command }) => command.isEnabled);
-        return commandDefinition && commandDefinition.command;
-    }
-}

package/src/pendingactions.js

@@ -1,127 +0,0 @@
-/**
- * @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
- */
-/**
- * @module core/pendingactions
- */
-import { ContextPlugin } from './contextplugin.js';
-import { CKEditorError, Collection, ObservableMixin } from '@ckeditor/ckeditor5-utils';
-/**
- * The list of pending editor actions.
- *
- * This plugin should be used to synchronise plugins that execute long-lasting actions
- * (e.g. file upload) with the editor integration. It gives the developer who integrates the editor
- * an easy way to check if there are any actions pending whenever such information is needed.
- * All plugins that register a pending action also provide a message about the action that is ongoing
- * which can be displayed to the user. This lets them decide if they want to interrupt the action or wait.
- *
- * Adding and updating a pending action:
- *
- * ```ts
- * const pendingActions = editor.plugins.get( 'PendingActions' );
- * const action = pendingActions.add( 'Upload in progress: 0%.' );
- *
- * // You can update the message:
- * action.message = 'Upload in progress: 10%.';
- * ```
- *
- * Removing a pending action:
- *
- * ```ts
- * const pendingActions = editor.plugins.get( 'PendingActions' );
- * const action = pendingActions.add( 'Unsaved changes.' );
- *
- * pendingActions.remove( action );
- * ```
- *
- * Getting pending actions:
- *
- * ```ts
- * const pendingActions = editor.plugins.get( 'PendingActions' );
- *
- * const action1 = pendingActions.add( 'Action 1' );
- * const action2 = pendingActions.add( 'Action 2' );
- *
- * pendingActions.first; // Returns action1
- * Array.from( pendingActions ); // Returns [ action1, action2 ]
- * ```
- *
- * This plugin is used by features like {@link module:upload/filerepository~FileRepository} to register their ongoing actions
- * and by features like {@link module:autosave/autosave~Autosave} to detect whether there are any ongoing actions.
- * Read more about saving the data in the
- * {@glink getting-started/setup/getting-and-setting-data Saving and getting data} guide.
- */
-export class PendingActions extends ContextPlugin {
-    /**
-     * A list of pending actions.
-     */
-    _actions;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'PendingActions';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        this.set('hasAny', false);
-        this._actions = new Collection({ idProperty: '_id' });
-        this._actions.delegate('add', 'remove').to(this);
-    }
-    /**
-     * Adds an action to the list of pending actions.
-     *
-     * This method returns an action object with an observable message property.
-     * The action object can be later used in the {@link #remove} method. It also allows you to change the message.
-     *
-     * @param message The action message.
-     * @returns An observable object that represents a pending action.
-     */
-    add(message) {
-        if (typeof message !== 'string') {
-            /**
-             * The message must be a string.
-             *
-             * @error pendingactions-add-invalid-message
-             */
-            throw new CKEditorError('pendingactions-add-invalid-message', this);
-        }
-        const action = new (ObservableMixin())();
-        action.set('message', message);
-        this._actions.add(action);
-        this.hasAny = true;
-        return action;
-    }
-    /**
-     * Removes an action from the list of pending actions.
-     *
-     * @param action An action object.
-     */
-    remove(action) {
-        this._actions.remove(action);
-        this.hasAny = !!this._actions.length;
-    }
-    /**
-     * Returns the first action from the list or null if the list is empty
-     *
-     * @returns The pending action object.
-     */
-    get first() {
-        return this._actions.get(0);
-    }
-    /**
-     * Iterable interface.
-     */
-    [Symbol.iterator]() {
-        return this._actions[Symbol.iterator]();
-    }
-}

package/src/plugin.js

@@ -1,132 +0,0 @@
-/**
- * @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
- */
-/**
- * @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 class Plugin extends /* #__PURE__ */ ObservableMixin() {
-    /**
-     * The editor instance.
-     *
-     * Note that most editors implement the {@link module:core/editor/editor~Editor#ui} property.
-     * However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or
-     * throw an error when accessing it.
-     *
-     * Because of above, to make plugins more universal, it is recommended to split features into:
-     *  - The "editing" part that uses the {@link module:core/editor/editor~Editor} class without `ui` property.
-     *  - The "UI" part that uses the {@link module:core/editor/editor~Editor} class and accesses `ui` property.
-     */
-    editor;
-    /**
-     * Holds identifiers for {@link #forceDisabled} mechanism.
-     */
-    _disableStack = new Set();
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super();
-        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;
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    static get isOfficialPlugin() {
-        return false;
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    static get isPremiumPlugin() {
-        return false;
-    }
-}
-/**
- * Helper function that forces plugin to be disabled.
- */
-function forceDisable(evt) {
-    evt.return = false;
-    evt.stop();
-}