@ckeditor/ckeditor5-core 41.4.2 → 42.0.0-alpha.1

package/lang/translations/vi.po

@@ -69,6 +69,14 @@ msgctxt "The label for the replace image with the file manager toolbar button."
 msgid "Replace image with file manager"
 msgstr "Thay thế hình ảnh bằng trình quản lý tập tin"
 
+msgctxt "The label for a button that opens a file manager in order to insert a file."
+msgid "File"
+msgstr "Tệp"
+
+msgctxt "The label for the insert image with the file manager menu bar button (inside 'Insert' menu)"
+msgid "With file manager"
+msgstr ""
+
 msgctxt "The button label for the object (e.g. image, table) toolbar for hiding the attached caption."
 msgid "Toggle caption off"
 msgstr "Ẩn chú thích"

package/lang/translations/zh-cn.po

@@ -69,6 +69,14 @@ msgctxt "The label for the replace image with the file manager toolbar button."
 msgid "Replace image with file manager"
 msgstr "使用文件管理器替换图片"
 
+msgctxt "The label for a button that opens a file manager in order to insert a file."
+msgid "File"
+msgstr "文件"
+
+msgctxt "The label for the insert image with the file manager menu bar button (inside 'Insert' menu)"
+msgid "With file manager"
+msgstr ""
+
 msgctxt "The button label for the object (e.g. image, table) toolbar for hiding the attached caption."
 msgid "Toggle caption off"
 msgstr "关闭表标题"

package/lang/translations/zh.po

@@ -69,6 +69,14 @@ msgctxt "The label for the replace image with the file manager toolbar button."
 msgid "Replace image with file manager"
 msgstr "使用檔案管理員替換圖片"
 
+msgctxt "The label for a button that opens a file manager in order to insert a file."
+msgid "File"
+msgstr "檔案"
+
+msgctxt "The label for the insert image with the file manager menu bar button (inside 'Insert' menu)"
+msgid "With file manager"
+msgstr ""
+
 msgctxt "The button label for the object (e.g. image, table) toolbar for hiding the attached caption."
 msgid "Toggle caption off"
 msgstr "關閉表標題"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-core",
-  "version": "41.4.2",
+  "version": "42.0.0-alpha.1",
   "description": "The core architecture of CKEditor 5 – the best browser-based rich text editor.",
   "keywords": [
     "wysiwyg",
@@ -24,8 +24,9 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-engine": "41.4.2",
-    "@ckeditor/ckeditor5-utils": "41.4.2",
+    "@ckeditor/ckeditor5-engine": "42.0.0-alpha.1",
+    "@ckeditor/ckeditor5-utils": "42.0.0-alpha.1",
+    "@ckeditor/ckeditor5-watchdog": "42.0.0-alpha.1",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/command.d.ts

@@ -24,7 +24,7 @@ declare const Command_base: {
  * By default, commands are disabled when the editor is in the {@link module:core/editor/editor~Editor#isReadOnly read-only} mode
  * but commands with the {@link module:core/command~Command#affectsData `affectsData`} flag set to `false` will not be disabled.
  */
-export default class Command extends Command_base {
+export default class Command extends /* #__PURE__ */ Command_base {
     /**
      * The editor on which this command will be used.
      */

package/src/command.js

@@ -19,7 +19,7 @@ import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
  * By default, commands are disabled when the editor is in the {@link module:core/editor/editor~Editor#isReadOnly read-only} mode
  * but commands with the {@link module:core/command~Command#affectsData `affectsData`} flag set to `false` will not be disabled.
  */
-export default class Command extends ObservableMixin() {
+export default class Command extends /* #__PURE__ */ ObservableMixin() {
     /**
      * Creates a new `Command` instance.
      *

package/src/contextplugin.d.ts

@@ -29,7 +29,7 @@ declare const ContextPlugin_base: {
  * * An {@link module:core/plugin~Plugin editor plugin} can require a context plugin.
  * * A context plugin MUST NOT require an {@link module:core/plugin~Plugin editor plugin}.
  */
-export default class ContextPlugin extends ContextPlugin_base implements PluginInterface {
+export default class ContextPlugin extends /* #__PURE__ */ ContextPlugin_base implements PluginInterface {
     /**
      * The context or editor instance.
      */

package/src/contextplugin.js

@@ -20,7 +20,7 @@ import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
  * * An {@link module:core/plugin~Plugin editor plugin} can require a context plugin.
  * * A context plugin MUST NOT require an {@link module:core/plugin~Plugin editor plugin}.
  */
-export default class ContextPlugin extends ObservableMixin() {
+export default class ContextPlugin extends /* #__PURE__ */ ObservableMixin() {
     /**
      * Creates a new plugin instance.
      */

package/src/editor/editor.d.ts

@@ -8,6 +8,7 @@
 import { Config, type Locale, type LocaleTranslate } from '@ckeditor/ckeditor5-utils';
 import { Conversion, DataController, EditingController, Model } from '@ckeditor/ckeditor5-engine';
 import type { EditorUI } from '@ckeditor/ckeditor5-ui';
+import { ContextWatchdog, EditorWatchdog } from '@ckeditor/ckeditor5-watchdog';
 import Context from '../context.js';
 import PluginCollection from '../plugincollection.js';
 import CommandCollection, { type CommandsMap } from '../commandcollection.js';
@@ -37,7 +38,7 @@ declare const Editor_base: {
  * the specific editor implements also the {@link ~Editor#ui} property
  * (as most editor implementations do).
  */
-export default abstract class Editor extends Editor_base {
+export default abstract class Editor extends /* #__PURE__ */ Editor_base {
     /**
      * A namespace for the accessibility features of the editor.
      */
@@ -428,6 +429,24 @@ export default abstract class Editor extends Editor_base {
      * * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`}
      */
     static create(...args: Array<unknown>): void;
+    /**
+     * The {@link module:core/context~Context} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static Context: typeof Context;
+    /**
+     * The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static EditorWatchdog: typeof EditorWatchdog;
+    /**
+     * The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static ContextWatchdog: typeof ContextWatchdog;
 }
 /**
  * Fired when the {@link module:engine/controller/datacontroller~DataController#event:ready data} and all additional
@@ -464,7 +483,7 @@ export {};
  * This error is thrown when trying to pass a `<textarea>` element to a `create()` function of an editor class.
  *
  * The only editor type which can be initialized on `<textarea>` elements is
- * the {@glink installation/getting-started/predefined-builds#classic-editor classic editor}.
+ * the {@glink getting-started/legacy/installation-methods/predefined-builds#classic-editor classic editor}.
  * This editor hides the passed element and inserts its own UI next to it. Other types of editors reuse the passed element as their root
  * editable element and therefore `<textarea>` is not appropriate for them. Use a `<div>` or another text container instead:
  *

package/src/editor/editor.js

@@ -7,6 +7,7 @@
  */
 import { Config, CKEditorError, ObservableMixin } from '@ckeditor/ckeditor5-utils';
 import { Conversion, DataController, EditingController, Model, StylesProcessor } from '@ckeditor/ckeditor5-engine';
+import { ContextWatchdog, EditorWatchdog } from '@ckeditor/ckeditor5-watchdog';
 import Context from '../context.js';
 import PluginCollection from '../plugincollection.js';
 import CommandCollection from '../commandcollection.js';
@@ -30,7 +31,7 @@ import Accessibility from '../accessibility.js';
  * the specific editor implements also the {@link ~Editor#ui} property
  * (as most editor implementations do).
  */
-export default class Editor extends ObservableMixin() {
+class Editor extends /* #__PURE__ */ ObservableMixin() {
     /**
      * Creates a new instance of the editor class.
      *
@@ -360,11 +361,30 @@ export default class Editor extends ObservableMixin() {
         throw new Error('This is an abstract method.');
     }
 }
+/**
+ * The {@link module:core/context~Context} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+Editor.Context = Context;
+/**
+ * The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+Editor.EditorWatchdog = EditorWatchdog;
+/**
+ * The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+Editor.ContextWatchdog = ContextWatchdog;
+export default Editor;
 /**
  * This error is thrown when trying to pass a `<textarea>` element to a `create()` function of an editor class.
  *
  * The only editor type which can be initialized on `<textarea>` elements is
- * the {@glink installation/getting-started/predefined-builds#classic-editor classic editor}.
+ * the {@glink getting-started/legacy/installation-methods/predefined-builds#classic-editor classic editor}.
  * This editor hides the passed element and inserts its own UI next to it. Other types of editors reuse the passed element as their root
  * editable element and therefore `<textarea>` is not appropriate for them. Use a `<div>` or another text container instead:
  *

package/src/editor/editorconfig.d.ts

@@ -28,15 +28,12 @@ import type { MenuBarConfig } from '@ckeditor/ckeditor5-ui';
  * 	.then( ... )
  * 	.catch( ... );
  * ```
- *
- * Check the {@glink installation/getting-started/predefined-builds Configuration} guide for more information
- * about setting configuration options.
  */
 export interface EditorConfig {
     context?: Context;
     /**
      * The list of additional plugins to load along those already available in the
-     * {@glink installation/getting-started/predefined-builds editor build}. It extends the {@link #plugins `plugins`} configuration.
+     * editor. It extends the {@link #plugins `plugins`} configuration.
      *
      * ```ts
      * function MyPlugin( editor ) {
@@ -51,10 +48,10 @@ export interface EditorConfig {
      * **Note:** This configuration works only for simple plugins which utilize the
      * {@link module:core/plugin~PluginInterface plugin interface} and have no dependencies. To extend a
      * build with complex features, create a
-     * {@glink installation/getting-started/quick-start-other#creating-custom-builds-with-online-builder custom build}.
+     * {@glink getting-started/legacy/installation-methods/quick-start-other#creating-custom-builds-with-online-builder custom build}.
      *
      * **Note:** Make sure you include the new features in you toolbar configuration. Learn more
-     * about the {@glink features/toolbar/toolbar toolbar setup}.
+     * about the {@glink getting-started/setup/toolbar toolbar setup}.
      */
     extraPlugins?: Array<PluginConstructor<Editor>>;
     /**
@@ -112,10 +109,6 @@ export interface EditorConfig {
     /**
      * The language of the editor UI and its content.
      *
-     * Note: You do not have to specify this option if your build is optimized for one UI language or if it is
-     * the default language (English is the default language for CDN builds), unless you want to change
-     * the language of your content.
-     *
      * Simple usage (change the language of the UI and the content):
      *
      * ```ts
@@ -161,16 +154,56 @@ export interface EditorConfig {
      * The language codes are defined in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) standard.
      *
      * You need to add the corresponding translation file for the new UI language to work.
-     * Translation files are available on CDN for predefined builds:
+     * Translation files are available on CDN:
      *
      * ```html
-     * `<script src="https://cdn.ckeditor.com/ckeditor5/[version.number]/[distribution]/lang/[lang].js"></script>`
+     * <script type="importmap">
+     * {
+     *   "imports": {
+     *     "ckeditor5": "https://cdn.ckeditor.com/ckeditor5/<VERSION>/ckeditor5.js",
+     *     "ckeditor5/": "https://cdn.ckeditor.com/ckeditor5/<VERSION>/"
+     *   }
+     * }
+     * </script>
+     * <script type="module">
+     * import { ClassicEditor, Essentials, Paragraph } from 'ckeditor5';
+     * import translations from 'ckeditor5/dist/translations/pl.js';
+     *
+     * await ClassicEditor.create( document.querySelector( '#editor' ), {
+     *   plugins: [
+     *     Essentials,
+     *     Paragraph,
+     *   ],
+     *   toolbar: {
+     *     items: [ 'undo', 'redo' ]
+     *   },
+     *   translations
+     * } );
+     * </script>
      * ```
      *
-     * But you can add them manually by coping from the `node_modules/@ckeditor/ckeditor5-build-[name]/build/lang/[lang].js'`.
+     * You can add translation using NPM as well.
      *
-     * Check the {@glink features/ui-language UI language} guide for more information about the localization options and translation
-     * process.
+     * ```html
+     * import { ClassicEditor, Essentials, Paragraph } from 'ckeditor5';
+     * import translations from 'ckeditor5/dist/translations/pl.js';
+     *
+     * import 'ckeditor5/dist/styles.css';
+     *
+     * await ClassicEditor.create( document.querySelector( '#editor' ), {
+     *   plugins: [
+     *     Essentials,
+     *     Paragraph,
+     *   ],
+     *   toolbar: {
+     *     items: [ 'undo', 'redo' ]
+     *   },
+     *   translations
+     * } );
+     * ```
+     *
+     * Check the {@glink getting-started/setup/ui-language UI language} guide for more information about
+     * the localization options and translation process.
      */
     language?: string | LanguageConfig;
     /**
@@ -501,30 +534,13 @@ export interface EditorConfig {
     /**
      * The list of plugins to load.
      *
-     * If you use an {@glink installation/getting-started/predefined-builds editor build} you can define the list of plugins to load
-     * using the names of plugins that are available:
-     *
-     * ```ts
-     * const config = {
-     * 	plugins: [ 'Bold', 'Italic', 'Typing', 'Enter', ... ]
-     * };
-     * ```
-     *
-     * You can check the list of plugins available in a build using this snippet:
-     *
-     * ```ts
-     * ClassicEditor.builtinPlugins.map( plugin => plugin.pluginName );
-     * ```
-     *
-     * If you use an editor creator directly (imported from a package like `@ckeditor/ckeditor5-editor-classic`) or you
-     * want to load additional plugins which were not included in a build you use, then you need to specify
-     * the plugins using their constructors:
-     *
      * ```ts
+     * import {
      * // A preset of plugins is a plugin as well.
-     * import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
+     * 	Essentials,
      * // The bold plugin.
-     * import Bold from '@ckeditor/ckeditor5-editor-basic-styles/src/bold';
+     * 	Bold
+     * } from 'ckeditor5';
      *
      * const config = {
      * 	plugins: [ Essentials, Bold ]
@@ -536,8 +552,8 @@ export interface EditorConfig {
      */
     plugins?: Array<PluginConstructor<Editor> | string>;
     /**
-     * The list of plugins which should not be loaded despite being available in an {@glink installation/getting-started/predefined-builds
-     * editor build}.
+     * The list of plugins which should not be loaded despite being available in
+     * the editor.
      *
      * ```ts
      * const config = {
@@ -545,7 +561,7 @@ export interface EditorConfig {
      * };
      * ```
      *
-     * **Note:** Be careful when removing plugins using `config.removePlugins` from CKEditor builds.
+     * **Note:** Be careful when removing plugins using `config.removePlugins`.
      * If removed plugins were providing toolbar buttons, the default toolbar configuration included in a build
      * will become invalid. In such case you need to provide the updated
      * {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar configuration}.

package/src/pendingactions.d.ts

@@ -49,7 +49,8 @@ import { type CollectionAddEvent, type CollectionRemoveEvent, type Observable }
  *
  * 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 installation/getting-started/getting-and-setting-data Saving and getting data} guide.
+ * Read more about saving the data in the
+ * {@glink getting-started/setup/getting-and-setting-data Saving and getting data} guide.
  */
 export default class PendingActions extends ContextPlugin implements Iterable<PendingAction> {
     /**

package/src/pendingactions.js

@@ -49,7 +49,8 @@ import { CKEditorError, Collection, ObservableMixin } from '@ckeditor/ckeditor5-
  *
  * 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 installation/getting-started/getting-and-setting-data Saving and getting data} guide.
+ * Read more about saving the data in the
+ * {@glink getting-started/setup/getting-and-setting-data Saving and getting data} guide.
  */
 export default class PendingActions extends ContextPlugin {
     /**

package/src/plugin.d.ts

@@ -10,7 +10,7 @@ declare const Plugin_base: {
 /**
  * The base class for CKEditor plugin classes.
  */
-export default class Plugin extends Plugin_base implements PluginInterface {
+export default class Plugin extends /* #__PURE__ */ Plugin_base implements PluginInterface {
     /**
      * The editor instance.
      *

package/src/plugin.js

@@ -10,7 +10,7 @@ import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
 /**
  * The base class for CKEditor plugin classes.
  */
-export default class Plugin extends ObservableMixin() {
+export default class Plugin extends /* #__PURE__ */ ObservableMixin() {
     /**
      * @inheritDoc
      */

package/src/plugincollection.d.ts

@@ -10,7 +10,7 @@ declare const PluginCollection_base: {
 /**
  * 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>> {
+export default class PluginCollection<TContext extends object> extends /* #__PURE__ */ PluginCollection_base implements Iterable<PluginEntry<TContext>> {
     private _context;
     private _plugins;
     /**

package/src/plugincollection.js

@@ -9,7 +9,7 @@ import { CKEditorError, EmitterMixin } from '@ckeditor/ckeditor5-utils';
 /**
  * Manages a list of CKEditor plugins, including loading, resolving dependencies and initialization.
  */
-export default class PluginCollection extends EmitterMixin() {
+export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
     /**
      * Creates an instance of the plugin collection class.
      * Allows loading and initializing plugins and their dependencies.
@@ -85,8 +85,6 @@ export default class PluginCollection extends EmitterMixin() {
              *
              * Plugin classes (constructors) need to be provided to the editor and must be loaded before they can be obtained from
              * the plugin collection.
-             * This is usually done in CKEditor 5 builds by setting the {@link module:core/editor/editor~Editor.builtinPlugins}
-             * property.
              *
              * **Note**: You can use `{@link module:core/plugincollection~PluginCollection#has editor.plugins.has()}`
              * to check if a plugin was loaded.
@@ -270,17 +268,18 @@ export default class PluginCollection extends EmitterMixin() {
              * This is usually done in CKEditor 5 builds by setting the {@link module:core/editor/editor~Editor.builtinPlugins}
              * property.
              *
-             * **If you see this warning when using one of the {@glink installation/getting-started/predefined-builds
-             * CKEditor 5 Builds}**,
+             * **If you see this warning when using one of the CKEditor 5 Builds},
              * it means that you try to enable a plugin which was not included in that build. This may be due to a typo
-             * in the plugin name or simply because that plugin is not a part of this build. In the latter scenario,
-             * read more about {@glink installation/getting-started/quick-start custom builds}.
+             * in the plugin name or simply because that plugin is not a part of this build.
+             *
+             * Predefined builds are a deprecated solution and we strongly advise
+             * {@glink updating/new-installation-methods migrating to new installation methods}.
              *
              * **If you see this warning when using one of the editor creators directly** (not a build), then it means
              * that you tried loading plugins by name. However, unlike CKEditor 4, CKEditor 5 does not implement a "plugin loader".
              * This means that CKEditor 5 does not know where to load the plugin modules from. Therefore, you need to
              * provide each plugin through a reference (as a constructor function). Check out the examples in
-             * {@glink installation/advanced/alternative-setups/integrating-from-source-webpack "Building from source"}.
+             * {@glink getting-started/legacy/advanced/alternative-setups/integrating-from-source-webpack "Building from source"}.
              *
              * @error plugincollection-plugin-not-found
              * @param plugin The name of the plugin which could not be loaded.
@@ -448,6 +447,9 @@ export default class PluginCollection extends EmitterMixin() {
              * {@link module:core/editor/editor~Editor.create `Editor.create()`}
              * or specified in {@link module:core/editor/editor~Editor.builtinPlugins `Editor.builtinPlugins`}.
              *
+             * Predefined builds are a deprecated solution and we strongly advise
+             * {@glink updating/new-installation-methods migrating to new installation methods}.
+             *
              * The second option is that your `node_modules/` directory contains duplicated versions of the same
              * CKEditor 5 packages. Normally, on clean installations, npm deduplicates packages in `node_modules/`, so
              * it may be enough to call `rm -rf node_modules && npm i`. However, if you installed conflicting versions
@@ -459,8 +461,6 @@ export default class PluginCollection extends EmitterMixin() {
              * They are already built into that editor build and now get added for the second time as dependencies
              * of the plugin you are installing.
              *
-             * Read more about {@glink installation/plugins/installing-plugins Installing plugins}.
-             *
              * @error plugincollection-plugin-name-conflict
              * @param pluginName The duplicated plugin name.
              * @param plugin1 The first plugin constructor.