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

package/dist/index.js

@@ -474,7 +474,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 			 * 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
             });
@@ -629,8 +629,8 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 				 * {@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)
@@ -657,7 +657,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 			 * {@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
             });
@@ -678,8 +678,8 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 			 * 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)
@@ -696,8 +696,8 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 			 * 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)
@@ -731,6 +731,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 					 * 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
                     });
@@ -741,6 +742,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 					 * 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
                     });
@@ -750,6 +752,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 					 * 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
                     });
@@ -761,6 +764,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 					 * {@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
                     });
@@ -777,6 +781,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 					 * 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
                     });
@@ -786,6 +791,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 					 * 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
                     });
@@ -845,9 +851,9 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 			 * 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,
@@ -1226,7 +1232,7 @@ import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/di
 			 * 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
             });
@@ -1630,8 +1636,8 @@ const DEFAULT_GROUP_ID = 'common';
 			 * 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
@@ -1646,9 +1652,9 @@ const DEFAULT_GROUP_ID = 'common';
 			 * 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,
@@ -2092,6 +2098,12 @@ function getPageSessionID() {
                 .map((host)=>Array(segments.length - host.length).fill(host[0] === '*' ? '*' : '').concat(host))// 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');
@@ -2143,10 +2155,11 @@ function getPageSessionID() {
                 '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',
@@ -2186,7 +2199,7 @@ function getPageSessionID() {
 						 * 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
                         });
@@ -2292,6 +2305,7 @@ function getPageSessionID() {
 			 * 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
             });
@@ -2627,6 +2641,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
             });
@@ -2764,10 +2779,10 @@ ElementApiMixin.updateSourceElement = ElementApiMixin(Object).prototype.updateSo
 		 * 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);
     }
     sourceElement.ckeditorInstance = editor;