@ckeditor/ckeditor5-core 46.1.1 → 47.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-core",
-  "version": "46.1.1",
+  "version": "47.0.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": "46.1.1",
-    "@ckeditor/ckeditor5-ui": "46.1.1",
-    "@ckeditor/ckeditor5-utils": "46.1.1",
-    "@ckeditor/ckeditor5-watchdog": "46.1.1",
+    "@ckeditor/ckeditor5-engine": "47.0.0-alpha.0",
+    "@ckeditor/ckeditor5-ui": "47.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "47.0.0-alpha.0",
+    "@ckeditor/ckeditor5-watchdog": "47.0.0-alpha.0",
     "es-toolkit": "1.39.5"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/editor/editor.d.ts

@@ -454,7 +454,7 @@ export declare abstract class Editor extends /* #__PURE__ */ Editor_base {
      * Exposed as static editor field for easier access in editor builds.
      */
     static ContextWatchdog: typeof ContextWatchdog;
-    private _showLicenseError;
+    protected _showLicenseError(reason: LicenseErrorReason, name?: string): void;
     /**
      * This part of the code is _not_ executed in installations under the GPL license (with `config.licenseKey = 'GPL'`).
      *
@@ -463,6 +463,10 @@ export declare abstract class Editor extends /* #__PURE__ */ Editor_base {
      */
     private _sendUsageRequest;
 }
+/**
+ * @internal
+ */
+export type LicenseErrorReason = 'invalid' | 'expired' | 'domainLimit' | 'pluginNotAllowed' | 'featureNotAllowed' | 'evaluationLimit' | 'trialLimit' | 'developmentLimit' | 'usageLimit' | 'distributionChannel';
 /**
  * Fired when the {@link module:engine/controller/datacontroller~DataController#event:ready data} and all additional
  * editor components are ready.

package/src/editor/editor.js

@@ -6,7 +6,7 @@
  * @module core/editor/editor
  */
 import { set, get } from 'es-toolkit/compat';
-import { Config, CKEditorError, ObservableMixin, logError, parseBase64EncodedObject, releaseDate, toArray, uid, crc32 } from '@ckeditor/ckeditor5-utils';
+import { Config, CKEditorError, ObservableMixin, logError, releaseDate, toArray, uid, crc32, decodeLicenseKey, isFeatureBlockedByLicenseKey } 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';
@@ -34,7 +34,7 @@ import '../../theme/core.css';
  * the specific editor implements also the {@link ~Editor#ui} property
  * (as most editor implementations do).
  */
-class Editor extends /* #__PURE__ */ ObservableMixin() {
+export class Editor extends /* #__PURE__ */ ObservableMixin() {
     /**
      * A required name of the editor class. The name should reflect the constructor name.
      */
@@ -309,16 +309,9 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
         function verifyLicenseKey(editor) {
             const licenseKey = editor.config.get('licenseKey');
             const distributionChannel = window[Symbol.for('cke distribution')] || 'sh';
-            function blockEditor(reason) {
+            function blockEditor(reason, name) {
                 editor.enableReadOnlyMode(Symbol('invalidLicense'));
-                editor._showLicenseError(reason);
-            }
-            function getPayload(licenseKey) {
-                const parts = licenseKey.split('.');
-                if (parts.length != 3) {
-                    return null;
-                }
-                return parts[1];
+                editor._showLicenseError(reason, name);
             }
             function hasAllRequiredFields(licensePayload) {
                 const requiredFields = ['exp', 'jti', 'vc'];
@@ -363,12 +356,7 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
                 }
                 return;
             }
-            const encodedPayload = getPayload(licenseKey);
-            if (!encodedPayload) {
-                blockEditor('invalid');
-                return;
-            }
-            const licensePayload = parseBase64EncodedObject(encodedPayload);
+            const licensePayload = decodeLicenseKey(licenseKey);
             if (!licensePayload) {
                 blockEditor('invalid');
                 return;
@@ -649,7 +637,36 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
         const removePlugins = config.get('removePlugins') || [];
         const extraPlugins = config.get('extraPlugins') || [];
         const substitutePlugins = config.get('substitutePlugins') || [];
-        return this.plugins.init(plugins.concat(extraPlugins), removePlugins, substitutePlugins);
+        return this.plugins.init(plugins.concat(extraPlugins), removePlugins, substitutePlugins)
+            .then(plugins => {
+            checkPluginsAllowedByLicenseKey(this);
+            return plugins;
+        });
+        function checkPluginsAllowedByLicenseKey(editor) {
+            const licenseKey = editor.config.get('licenseKey');
+            if (licenseKey === 'GPL') {
+                return;
+            }
+            const decodedPayload = decodeLicenseKey(licenseKey);
+            if (!decodedPayload) {
+                return;
+            }
+            const disallowedPlugin = [...editor.plugins]
+                .map(([pluginConstructor]) => pluginConstructor)
+                .find(pluginConstructor => {
+                if (!pluginConstructor.pluginName) {
+                    return false;
+                }
+                if (!pluginConstructor.licenseFeatureCode) {
+                    return false;
+                }
+                return isFeatureBlockedByLicenseKey(decodedPayload, pluginConstructor.licenseFeatureCode);
+            });
+            if (disallowedPlugin) {
+                editor.enableReadOnlyMode(Symbol('invalidLicense'));
+                editor._showLicenseError('pluginNotAllowed', disallowedPlugin.pluginName);
+            }
+        }
     }
     /**
      * Destroys the editor instance, releasing all resources used by it.
@@ -751,7 +768,7 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
      * Exposed as static editor field for easier access in editor builds.
      */
     static ContextWatchdog = ContextWatchdog;
-    _showLicenseError(reason, pluginName) {
+    _showLicenseError(reason, name) {
         setTimeout(() => {
             if (reason == 'invalid') {
                 /**
@@ -790,7 +807,7 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
                  */
                 throw new CKEditorError('license-key-domain-limit');
             }
-            if (reason == 'featureNotAllowed') {
+            if (reason == 'pluginNotAllowed') {
                 /**
                  * The plugin you are trying to use is not permitted under your current license.
                  * Please check the available features on the
@@ -800,7 +817,19 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
                  * @error license-key-plugin-not-allowed
                  * @param {String} pluginName The plugin you tried to load.
                  */
-                throw new CKEditorError('license-key-plugin-not-allowed', null, { pluginName });
+                throw new CKEditorError('license-key-plugin-not-allowed', null, { pluginName: name });
+            }
+            if (reason == 'featureNotAllowed') {
+                /**
+                 * The feature you are trying to use is not permitted under your current license.
+                 * Please check the available features on the
+                 * [Customer Portal](https://portal.ckeditor.com) or
+                 * [contact support](https://ckeditor.com/contact/) for more information.
+                 *
+                 * @error license-key-feature-not-allowed
+                 * @param {String} featureName The feature you tried to use.
+                 */
+                throw new CKEditorError('license-key-feature-not-allowed', null, { featureName: name });
             }
             if (reason == 'evaluationLimit') {
                 /**
@@ -900,7 +929,6 @@ class Editor extends /* #__PURE__ */ ObservableMixin() {
         return response.json();
     }
 }
-export { Editor };
 function collectUsageData(editor) {
     const collectedData = getEditorUsageData(editor);
     function setUsageData(path, value) {

package/src/index.d.ts

@@ -14,7 +14,7 @@ export { Context, type ContextConfig } from './context.js';
 export { ContextPlugin, type ContextInterface, type ContextPluginDependencies } from './contextplugin.js';
 export { EditingKeystrokeHandler, type EditingKeystrokeCallback } from './editingkeystrokehandler.js';
 export type { PartialBy, NonEmptyArray, HexColor } from './typings.js';
-export { Editor, type EditorCollectUsageDataEvent, type EditorReadyEvent, type EditorDestroyEvent } from './editor/editor.js';
+export { Editor, type EditorCollectUsageDataEvent, type EditorReadyEvent, type EditorDestroyEvent, type LicenseErrorReason as _LicenseErrorReason } from './editor/editor.js';
 export type { EditorConfig, LanguageConfig, ToolbarConfig, ToolbarConfigItem, UiConfig, ViewportOffsetConfig, PoweredByConfig } from './editor/editorconfig.js';
 export { attachToForm } from './editor/utils/attachtoform.js';
 export { ElementApiMixin, type ElementApi } from './editor/utils/elementapimixin.js';

package/src/plugin.d.ts

@@ -287,6 +287,12 @@ export interface PluginStaticMembers<TContext = Editor> {
      * @internal
      */
     readonly isPremiumPlugin?: boolean;
+    /**
+     * An unique id of a plugin which belongs to the free plan on commercial license.
+     *
+     * @internal
+     */
+    readonly licenseFeatureCode?: string;
 }
 export type PluginDependencies<TContext = Editor> = ReadonlyArray<PluginConstructor<TContext> | string>;
 /**