@ckeditor/ckeditor5-core 45.0.0 → 45.1.0-alpha.0

package/package.json

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

package/src/accessibility.js

@@ -304,8 +304,8 @@ export default class Accessibility {
              * to add a new category or make sure the specified category exists.
              *
              * @error accessibility-unknown-keystroke-info-category
-             * @param categoryId The id of the unknown keystroke category.
-             * @param keystrokes Keystroke definitions about to be added.
+             * @param {string} categoryId The id of the unknown keystroke category.
+             * @param {module:core/accessibility~AddKeystrokeInfosData#keystrokes} keystrokes Keystroke definitions about to be added.
              */
             throw new CKEditorError('accessibility-unknown-keystroke-info-category', this._editor, { categoryId, keystrokes });
         }
@@ -318,9 +318,9 @@ export default class Accessibility {
              * to add a new group or make sure the specified group exists.
              *
              * @error accessibility-unknown-keystroke-info-group
-             * @param groupId The id of the unknown keystroke group.
-             * @param categoryId The id of category the unknown group should belong to.
-             * @param keystrokes Keystroke definitions about to be added.
+             * @param {string} groupId The id of the unknown keystroke group.
+             * @param {string} categoryId The id of category the unknown group should belong to.
+             * @param {module:core/accessibility~AddKeystrokeInfosData#keystrokes} keystrokes Keystroke definitions about to be added.
              */
             throw new CKEditorError('accessibility-unknown-keystroke-info-group', this._editor, { groupId, categoryId, keystrokes });
         }

package/src/commandcollection.js

@@ -50,7 +50,7 @@ export default class CommandCollection {
              * Command does not exist.
              *
              * @error commandcollection-command-not-found
-             * @param commandName Name of the command.
+             * @param {string} commandName Name of the command.
              */
             throw new CKEditorError('commandcollection-command-not-found', this, { commandName });
         }

package/src/editor/editor.js

@@ -348,6 +348,14 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
                     // Check if some license host matches the hostname.
                     .some(octets => segments.every((segment, index) => octets[index] === segment || octets[index] === '*'));
             }
+            function warnAboutNonProductionLicenseKey(licenseType) {
+                const capitalizedLicenseType = licenseType[0].toUpperCase() + licenseType.slice(1);
+                const article = licenseType === 'evaluation' ? 'an' : 'a';
+                console.info(`%cCKEditor 5 ${capitalizedLicenseType} License`, 'color: #ffffff; background: #743CCD; font-size: 14px; padding: 4px 8px; border-radius: 4px;');
+                console.warn(`⚠️ You are using ${article} ${licenseType} license of CKEditor 5` +
+                    `${licenseType === 'trial' ? ' which is for evaluation purposes only' : ''}. ` +
+                    'For production usage, please obtain a production license at https://portal.ckeditor.com/');
+            }
             if (licenseKey == 'GPL') {
                 if (distributionChannel == 'cloud') {
                     blockEditor('distributionChannel');
@@ -392,12 +400,11 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
             }
             if (['development', 'evaluation', 'trial'].includes(licensePayload.licenseType)) {
                 const { licenseType } = licensePayload;
-                const capitalizedLicenseType = licenseType[0].toUpperCase() + licenseType.slice(1);
-                const article = licenseType === 'evaluation' ? 'an' : 'a';
-                console.info(`%cCKEditor 5 ${capitalizedLicenseType} License`, 'color: #ffffff; background: #743CCD; font-size: 14px; padding: 4px 8px; border-radius: 4px;');
-                console.warn(`⚠️ You are using ${article} ${licenseType} license of CKEditor 5` +
-                    `${licenseType === 'trial' ? ' which is for evaluation purposes only' : ''}. ` +
-                    'For production usage, please obtain a production license at https://portal.ckeditor.com/');
+                const sessionStarted = sessionStorage.getItem('ckeditor5-development-session-started');
+                if (!sessionStarted) {
+                    warnAboutNonProductionLicenseKey(licenseType);
+                    sessionStorage.setItem('ckeditor5-development-session-started', 'true');
+                }
             }
             if (['evaluation', 'trial'].includes(licensePayload.licenseType)) {
                 const licenseType = licensePayload.licenseType;
@@ -435,7 +442,7 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
                          * Please ensure that your setup does not block requests to the validation endpoint.
                          *
                          * @error license-key-validation-endpoint-not-reachable
-                         * @param {String} url The URL that was attempted to be reached for validation.
+                         * @param {string} url The URL that was attempted to be reached for validation.
                          */
                         logError('license-key-validation-endpoint-not-reachable', { url: licensePayload.usageEndpoint });
                     });
@@ -541,6 +548,7 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
              * The lock ID is missing or it is not a string or symbol.
              *
              * @error editor-read-only-lock-id-invalid
+             * @param {never} lockId Lock ID.
              */
             throw new CKEditorError('editor-read-only-lock-id-invalid', null, { lockId });
         }
@@ -901,6 +909,7 @@ function collectUsageData(editor) {
              * Make sure that you are not setting the same path multiple times.
              *
              * @error editor-usage-data-path-already-set
+             * @param {string} path The path that was already set.
              */
             throw new CKEditorError('editor-usage-data-path-already-set', { path });
         }

package/src/editor/utils/securesourceelement.js

@@ -21,10 +21,10 @@ export default function secureSourceElement(editor, sourceElement) {
          * 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 an unique DOM element.
+         * created with a unique DOM element.
          *
          * @error editor-source-element-already-used
-         * @param element DOM element that caused the collision.
+         * @param {HTMLElement} element DOM element that caused the collision.
          */
         throw new CKEditorError('editor-source-element-already-used', editor);
     }

package/src/index.d.ts

@@ -15,7 +15,7 @@ export { default as ContextPlugin, type ContextPluginDependencies } from './cont
 export { type EditingKeystrokeCallback } from './editingkeystrokehandler.js';
 export type { PartialBy, NonEmptyArray, HexColor } from './typings.js';
 export { default as Editor, type EditorReadyEvent, type EditorDestroyEvent } from './editor/editor.js';
-export type { EditorConfig, LanguageConfig, ToolbarConfig, ToolbarConfigItem, UiConfig } from './editor/editorconfig.js';
+export type { EditorConfig, LanguageConfig, ToolbarConfig, ToolbarConfigItem, UiConfig, ViewportOffsetConfig } from './editor/editorconfig.js';
 export { default as attachToForm } from './editor/utils/attachtoform.js';
 export { default as DataApiMixin, type DataApi } from './editor/utils/dataapimixin.js';
 export { default as ElementApiMixin, type ElementApi } from './editor/utils/elementapimixin.js';

package/src/plugincollection.js

@@ -99,7 +99,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
              * to check if a plugin was loaded.
              *
              * @error plugincollection-plugin-not-loaded
-             * @param plugin The name of the plugin which is not loaded.
+             * @param {string} plugin The name of the plugin which is not loaded.
              */
             throw new CKEditorError('plugincollection-plugin-not-loaded', this._context, { plugin: pluginName });
         }
@@ -265,8 +265,8 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
                  * {@glink updating/guides/update-to-26 Migration to 26.0.0} guide.
                  *
                  * @error plugincollection-soft-required
-                 * @param missingPlugin The name of the required plugin.
-                 * @param requiredBy The name of the plugin that requires the other plugin.
+                 * @param {string} missingPlugin The name of the required plugin.
+                 * @param {string} requiredBy The name of the plugin that requires the other plugin.
                  */
                 throw new CKEditorError('plugincollection-soft-required', context, { missingPlugin: plugin, requiredBy: getPluginName(parentPluginConstructor) });
             }
@@ -291,7 +291,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
              * {@glink getting-started/installation/cloud/quick-start Quick start} guide.
              *
              * @error plugincollection-plugin-not-found
-             * @param plugin The name of the plugin which could not be loaded.
+             * @param {string} plugin The name of the plugin which could not be loaded.
              */
             throw new CKEditorError('plugincollection-plugin-not-found', context, { plugin });
         }
@@ -311,8 +311,8 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
              * editor API.
              *
              * @error plugincollection-context-required
-             * @param plugin The name of the required plugin.
-             * @param requiredBy The name of the parent plugin.
+             * @param {string} plugin The name of the required plugin.
+             * @param {string} requiredBy The name of the parent plugin.
              */
             throw new CKEditorError('plugincollection-context-required', context, { plugin: getPluginName(plugin), requiredBy: getPluginName(parentPluginConstructor) });
         }
@@ -327,8 +327,8 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
              * Cannot load a plugin because one of its dependencies is listed in the `removePlugins` option.
              *
              * @error plugincollection-required
-             * @param plugin The name of the required plugin.
-             * @param requiredBy The name of the parent plugin.
+             * @param {string} plugin The name of the required plugin.
+             * @param {string} requiredBy The name of the parent plugin.
              */
             throw new CKEditorError('plugincollection-required', context, { plugin: getPluginName(plugin), requiredBy: getPluginName(parentPluginConstructor) });
         }
@@ -361,6 +361,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
                      * The plugin replacing an existing plugin must be a function.
                      *
                      * @error plugincollection-replace-plugin-invalid-type
+                     * @param {never} pluginItem The plugin item.
                      */
                     throw new CKEditorError('plugincollection-replace-plugin-invalid-type', null, { pluginItem });
                 }
@@ -370,6 +371,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
                      * The plugin replacing an existing plugin must have a name.
                      *
                      * @error plugincollection-replace-plugin-missing-name
+                     * @param {module:core/plugin~PluginConstructor} pluginItem The plugin item.
                      */
                     throw new CKEditorError('plugincollection-replace-plugin-missing-name', null, { pluginItem });
                 }
@@ -378,6 +380,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
                      * The plugin replacing an existing plugin cannot depend on other plugins.
                      *
                      * @error plugincollection-plugin-for-replacing-cannot-have-dependencies
+                     * @param {string} pluginName The name of the plugin.
                      */
                     throw new CKEditorError('plugincollection-plugin-for-replacing-cannot-have-dependencies', null, { pluginName });
                 }
@@ -388,6 +391,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
                      * {@link module:core/plugincollection~PluginCollection available plugins} collection.
                      *
                      * @error plugincollection-plugin-for-replacing-not-exist
+                     * @param {string} pluginName The name of the plugin.
                      */
                     throw new CKEditorError('plugincollection-plugin-for-replacing-not-exist', null, { pluginName });
                 }
@@ -403,6 +407,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
                      * The replaced plugin will not be loaded so it cannot be replaced.
                      *
                      * @error plugincollection-plugin-for-replacing-not-loaded
+                     * @param {string} pluginName The name of the plugin.
                      */
                     throw new CKEditorError('plugincollection-plugin-for-replacing-not-loaded', null, { pluginName });
                 }
@@ -411,6 +416,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
                      * The replaced plugin cannot depend on other plugins.
                      *
                      * @error plugincollection-replaced-plugin-cannot-have-dependencies
+                     * @param {string} pluginName The name of the plugin.
                      */
                     throw new CKEditorError('plugincollection-replaced-plugin-cannot-have-dependencies', null, { pluginName });
                 }
@@ -471,9 +477,9 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
              * of the plugin you are installing.
              *
              * @error plugincollection-plugin-name-conflict
-             * @param pluginName The duplicated plugin name.
-             * @param plugin1 The first plugin constructor.
-             * @param plugin2 The second plugin constructor.
+             * @param {string} pluginName The duplicated plugin name.
+             * @param {module:core/plugin~PluginConstructor} plugin1 The first plugin constructor.
+             * @param {module:core/plugin~PluginConstructor} plugin2 The second plugin constructor.
              */
             throw new CKEditorError('plugincollection-plugin-name-conflict', null, { pluginName, plugin1: this._plugins.get(pluginName).constructor, plugin2: PluginConstructor });
         }