@ckeditor/ckeditor5-core 43.3.1 → 44.0.0-alpha.0

package/dist/index.js

@@ -2,10 +2,10 @@
  * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-import { ObservableMixin, insertToPriorityArray, EmitterMixin, CKEditorError, Config, Locale, Collection, KeystrokeHandler, setDataInElement } from '@ckeditor/ckeditor5-utils/dist/index.js';
+import { ObservableMixin, insertToPriorityArray, EmitterMixin, CKEditorError, Config, Locale, Collection, KeystrokeHandler, env, uid, global, parseBase64EncodedObject, toArray, crc32, releaseDate, logError, setDataInElement } from '@ckeditor/ckeditor5-utils/dist/index.js';
+import { get, set, isFunction } from 'lodash-es';
 import { Model, StylesProcessor, DataController, EditingController, Conversion } from '@ckeditor/ckeditor5-engine/dist/index.js';
 import { EditorWatchdog, ContextWatchdog } from '@ckeditor/ckeditor5-watchdog/dist/index.js';
-import { isFunction } from 'lodash-es';
 
 /**
  * The base class for CKEditor plugin classes.
@@ -652,7 +652,7 @@ import { isFunction } from 'lodash-es';
 			 * 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 the
-			 * {@glink getting-started/installation/quick-start Quick start} guide.
+			 * {@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.
@@ -1657,6 +1657,119 @@ const DEFAULT_GROUP_ID = 'common';
     }
 }
 
+/**
+ * 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
+ */ 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;
+}
+
 /**
  * The class representing a basic, generic editor.
  *
@@ -1675,6 +1788,11 @@ const DEFAULT_GROUP_ID = 'common';
  * the specific editor implements also the {@link ~Editor#ui} property
  * (as most editor implementations do).
  */ class Editor extends /* #__PURE__ */ ObservableMixin() {
+    /**
+	 * A required name of the editor class. The name should reflect the constructor name.
+	 */ static get editorName() {
+        return 'Editor';
+    }
     /**
 	 * A namespace for the accessibility features of the editor.
 	 */ accessibility;
@@ -1873,6 +1991,7 @@ const DEFAULT_GROUP_ID = 'common';
         this.config = new Config(rest, defaultConfig);
         this.config.define('plugins', availablePlugins);
         this.config.define(this._context._getEditorConfig());
+        checkLicenseKeyIsDefined(this.config);
         this.plugins = new PluginCollection(this, availablePlugins, this._context.plugins);
         this.locale = this._context.locale;
         this.t = this.locale.t;
@@ -1902,6 +2021,169 @@ const DEFAULT_GROUP_ID = 'common';
         this.keystrokes = new EditingKeystrokeHandler(this);
         this.keystrokes.listenTo(this.editing.view.document);
         this.accessibility = new Accessibility(this);
+        verifyLicenseKey(this);
+        // Checks if the license key is defined and throws an error if it is not.
+        function checkLicenseKeyIsDefined(config) {
+            let licenseKey = config.get('licenseKey');
+            if (!licenseKey && window.CKEDITOR_GLOBAL_LICENSE_KEY) {
+                licenseKey = window.CKEDITOR_GLOBAL_LICENSE_KEY;
+                config.set('licenseKey', licenseKey);
+            }
+            if (!licenseKey) {
+                /**
+				 * The `licenseKey` property is missing in the editor configuration.
+				 *
+				 * * If you are using the editor in a commercial setup, please provide your license key.
+				 * * If you still need to acquire a key, please [contact us](https://ckeditor.com/contact/) or
+				 *   [create a free account with a 14 day premium features trial](https://portal.ckeditor.com/checkout?plan=free).
+				 * * If you are using the editor under a GPL license or another license from our Open Source Initiative,
+				 *   use the 'GPL' license key instead.
+				 *
+				 * ```js
+				 * ClassicEditor.create( document.querySelector( '#editor' ), {
+				 * 	licenseKey: '<YOUR_LICENSE_KEY>', // Or 'GPL'.
+				 * 	// ... Other configuration options ...
+				 * } ) ;
+				 *
+				 * @error license-key-missing
+				 */ throw new CKEditorError('license-key-missing');
+            }
+        }
+        function verifyLicenseKey(editor) {
+            const licenseKey = editor.config.get('licenseKey');
+            const distributionChannel = window[Symbol.for('cke distribution')] || 'sh';
+            function blockEditor(reason) {
+                editor.enableReadOnlyMode(Symbol('invalidLicense'));
+                editor._showLicenseError(reason);
+            }
+            function getPayload(licenseKey) {
+                const parts = licenseKey.split('.');
+                if (parts.length != 3) {
+                    return null;
+                }
+                return parts[1];
+            }
+            function hasAllRequiredFields(licensePayload) {
+                const requiredFields = [
+                    'exp',
+                    'jti',
+                    'vc'
+                ];
+                return requiredFields.every((field)=>field in licensePayload);
+            }
+            function getCrcInputData(licensePayload) {
+                const keysToCheck = Object.getOwnPropertyNames(licensePayload).sort();
+                const filteredValues = keysToCheck.filter((key)=>key != 'vc' && licensePayload[key] != null).map((key)=>licensePayload[key]);
+                return filteredValues;
+            }
+            function checkLicensedHosts(licensedHosts) {
+                const { hostname } = new URL(window.location.href);
+                if (licensedHosts.includes(hostname)) {
+                    return true;
+                }
+                const segments = hostname.split('.');
+                return licensedHosts// Filter out hosts without wildcards.
+                .filter((host)=>host.includes('*'))// Split the hosts into segments.
+                .map((host)=>host.split('.'))// Filter out hosts that have more segments than the current hostname.
+                .filter((host)=>host.length <= segments.length)// Pad the beginning of the licensed host if it's shorter than the current hostname.
+                .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] === '*'));
+            }
+            if (licenseKey == 'GPL') {
+                if (distributionChannel == 'cloud') {
+                    blockEditor('distributionChannel');
+                }
+                return;
+            }
+            const encodedPayload = getPayload(licenseKey);
+            if (!encodedPayload) {
+                blockEditor('invalid');
+                return;
+            }
+            const licensePayload = parseBase64EncodedObject(encodedPayload);
+            if (!licensePayload) {
+                blockEditor('invalid');
+                return;
+            }
+            if (!hasAllRequiredFields(licensePayload)) {
+                blockEditor('invalid');
+                return;
+            }
+            if (licensePayload.distributionChannel && !toArray(licensePayload.distributionChannel).includes(distributionChannel)) {
+                blockEditor('distributionChannel');
+                return;
+            }
+            if (crc32(getCrcInputData(licensePayload)) != licensePayload.vc.toLowerCase()) {
+                blockEditor('invalid');
+                return;
+            }
+            const expirationDate = new Date(licensePayload.exp * 1000);
+            if (expirationDate < releaseDate) {
+                blockEditor('expired');
+                return;
+            }
+            const licensedHosts = licensePayload.licensedHosts;
+            if (licensedHosts && licensedHosts.length > 0 && !checkLicensedHosts(licensedHosts)) {
+                blockEditor('domainLimit');
+                return;
+            }
+            if ([
+                'evaluation',
+                'trial'
+            ].includes(licensePayload.licenseType) && licensePayload.exp * 1000 < Date.now()) {
+                blockEditor('expired');
+                return;
+            }
+            if ([
+                'evaluation',
+                'trial',
+                'development'
+            ].includes(licensePayload.licenseType)) {
+                const licenseType = licensePayload.licenseType;
+                console.info(`You are using the ${licenseType} version of CKEditor 5 with limited usage. ` + 'Make sure you will not use it in the production environment.');
+                const timerId = setTimeout(()=>{
+                    blockEditor(`${licenseType}Limit`);
+                }, 600000);
+                editor.on('destroy', ()=>{
+                    clearTimeout(timerId);
+                });
+            }
+            if (licensePayload.usageEndpoint) {
+                editor.once('ready', ()=>{
+                    const request = {
+                        requestId: uid(),
+                        requestTime: Math.round(Date.now() / 1000),
+                        license: licenseKey,
+                        editor: collectUsageData(editor)
+                    };
+                    /**
+					 * 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.
+					 */ editor._sendUsageRequest(licensePayload.usageEndpoint, request).then((response)=>{
+                        const { status, message } = response;
+                        if (message) {
+                            console.warn(message);
+                        }
+                        if (status != 'ok') {
+                            blockEditor('usageLimit');
+                        }
+                    }, ()=>{
+                        /**
+						 * Your license key cannot be validated due to a network issue.
+						 * 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.
+						 */ logError('license-key-validation-endpoint-not-reachable', {
+                            url: licensePayload.usageEndpoint
+                        });
+                    });
+                }, {
+                    priority: 'high'
+                });
+            }
+        }
     }
     /**
 	 * Defines whether the editor is in the read-only mode.
@@ -2184,6 +2466,147 @@ const DEFAULT_GROUP_ID = 'common';
 	 *
 	 * Exposed as static editor field for easier access in editor builds.
 	 */ static ContextWatchdog = ContextWatchdog;
+    _showLicenseError(reason, pluginName) {
+        setTimeout(()=>{
+            if (reason == 'invalid') {
+                /**
+				 * The license key provided is invalid. Please ensure that it is copied correctly
+				 * from the [Customer Portal](http://portal.ckeditor.com). If the issue persists,
+				 * please [contact our customer support](https://ckeditor.com/contact/).
+				 *
+				 * @error invalid-license-key
+				 */ throw new CKEditorError('invalid-license-key');
+            }
+            if (reason == 'expired') {
+                /**
+				 * Your license key has expired. Please renew your license on the
+				 * [Customer Portal](https://portal.ckeditor.com).
+				 *
+				 * @error license-key-expired
+				 */ throw new CKEditorError('license-key-expired');
+            }
+            if (reason == 'domainLimit') {
+                /**
+				 * The provided license does not allow the editor to run on this domain.
+				 * Some license keys are restricted to local test environments only.
+				 * For more details, please refer to the
+				 * {@glink getting-started/licensing/license-key-and-activation#license-key-types license key type documentation}.
+				 *
+				 * @error license-key-domain-limit
+				 */ throw new CKEditorError('license-key-domain-limit');
+            }
+            if (reason == 'featureNotAllowed') {
+                /**
+				 * The plugin 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-plugin-not-allowed
+				 * @param {String} pluginName The plugin you tried to load.
+				 */ throw new CKEditorError('license-key-plugin-not-allowed', null, {
+                    pluginName
+                });
+            }
+            if (reason == 'evaluationLimit') {
+                /**
+				 * You have exceeded the editor operation limit available for your evaluation license key.
+				 * Please restart the editor to continue using it.
+				 * {@glink getting-started/licensing/license-key-and-activation#license-key-types Read more about license key types}.
+				 *
+				 * @error license-key-evaluation-limit
+				 */ throw new CKEditorError('license-key-evaluation-limit');
+            }
+            if (reason == 'trialLimit') {
+                /**
+				 * You have exceeded the editor operation limit for your trial license key.
+				 * Please restart the editor to continue using it.
+				 * {@glink getting-started/licensing/license-key-and-activation#license-key-types Read more about license key types}.
+				 *
+				 * @error license-key-trial-limit
+				 */ throw new CKEditorError('license-key-trial-limit');
+            }
+            if (reason == 'developmentLimit') {
+                /**
+				 * You have exceeded the operation limit for your development license key within the editor.
+				 * Please restart the editor to continue using it.
+				 * {@glink getting-started/licensing/license-key-and-activation#license-key-types Read more about license key types}.
+				 *
+				 * @error license-key-development-limit
+				 */ throw new CKEditorError('license-key-development-limit');
+            }
+            if (reason == 'usageLimit') {
+                /**
+				 * You have reached the usage limit of your license key. This can occur in the following situations:
+				 *
+				 * * You are on a free subscription without a connected payment method and have exceeded the allowed usage threshold.
+				 * * Your account has overdue invoices and the grace period has ended.
+				 *
+				 * To extend the limit and restore access, please update the required details in the
+				 * [Customer Portal](https://portal.ckeditor.com) or
+				 * [contact our customer support](https://ckeditor.com/contact).
+				 *
+				 * @error license-key-usage-limit
+				 */ throw new CKEditorError('license-key-usage-limit');
+            }
+            if (reason == 'distributionChannel') {
+                /**
+				 * Your license does not allow the current distribution channel.
+				 *
+				 * * With a 'GPL' license key, you may use the editor installed via npm or a ZIP package (self-hosted).
+				 * * With the CKEditor Cloud plans, you may use the editor via our CDN.
+				 * * With the CKEditor Custom plans, depending on your plan details, you can use the editor via npm
+				 *   or a ZIP package (self-hosted) or Cloud (CDN)
+				 *
+				 * {@glink getting-started/licensing/usage-based-billing#key-terms Read more about distributions in the documentation}.
+				 * Please verify your installation or [contact support](https://ckeditor.com/contact/) for assistance.
+				 *
+				 * @error license-key-invalid-distribution-channel
+				 */ throw new CKEditorError('license-key-invalid-distribution-channel');
+            }
+        }, 0);
+        this._showLicenseError = ()=>{};
+    }
+    /**
+	 * This part of the code is _not_ executed in installations under the GPL license (with `config.licenseKey = 'GPL'`).
+     *
+	 * It is only executed when a specific license key is provided. If you are uncertain whether
+	 * this applies to your installation, please contact our support team.
+	 */ async _sendUsageRequest(endpoint, request) {
+        const headers = new Headers({
+            'Content-Type': 'application/json'
+        });
+        const response = await fetch(new URL(endpoint), {
+            method: 'POST',
+            headers,
+            body: JSON.stringify(request)
+        });
+        if (!response.ok) {
+            // TODO: refine message.
+            throw new Error(`HTTP Response: ${response.status}`);
+        }
+        return response.json();
+    }
+}
+function collectUsageData(editor) {
+    const collectedData = getEditorUsageData(editor);
+    function setUsageData(path, value) {
+        if (get(collectedData, path) !== undefined) {
+            /**
+			 * The error thrown when trying to set the usage data path that was already set.
+			 * Make sure that you are not setting the same path multiple times.
+			 *
+			 * @error editor-usage-data-path-already-set
+			 */ throw new CKEditorError('editor-usage-data-path-already-set', {
+                path
+            });
+        }
+        set(collectedData, path, value);
+    }
+    editor.fire('collectUsageData', {
+        setUsageData
+    });
+    return collectedData;
 }
  /**
  * This error is thrown when trying to pass a `<textarea>` element to a `create()` function of an editor class.
@@ -2560,6 +2983,12 @@ var outdent = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><
 
 var table = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M3 5.5v3h4v-3H3Zm0 4v3h4v-3H3Zm0 4v3h4v-3H3Zm5 3h4v-3H8v3Zm5 0h4v-3h-4v3Zm4-4v-3h-4v3h4Zm0-4v-3h-4v3h4Zm1.5 8A1.5 1.5 0 0 1 17 18H3a1.5 1.5 0 0 1-1.5-1.5V3c.222-.863 1.068-1.5 2-1.5h13c.932 0 1.778.637 2 1.5v13.5Zm-6.5-4v-3H8v3h4Zm0-4v-3H8v3h4Z\"/></svg>";
 
+var remove = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M5.2 7h9.2c.6 0 1 .4 1 1v9.9c0 .5-.4 1-1 1H5.2a1 1 0 0 1-1-1V8c0-.6.4-1 1-1Zm1 1.5c-.3 0-.5.2-.5.5v8c0 .3.2.5.5.5h.5c.2 0 .5-.2.5-.5V9c0-.3-.3-.5-.5-.5h-.5Zm3.2 0c-.2 0-.5.2-.5.5v8c0 .3.3.5.5.5h.5c.3 0 .5-.2.5-.5V9c0-.3-.2-.5-.5-.5h-.5Zm3.5 0c-.2 0-.5.2-.5.5v8c0 .3.3.5.5.5h.5c.3 0 .5-.2.5-.5V9c0-.3-.2-.5-.5-.5h-.5Zm-1.4-7.1H8.3L6.5 3.6H3.8c-.5 0-.7.3-.7.8s.2.7.7.7h12c.6 0 .9-.2.9-.7 0-.5-.3-.8-1-.8h-2.4l-1.8-2.2Z\"/></svg>";
+
+var bookmark = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path clip-rule=\"evenodd\" d=\"M5.68 3.417a.238.238 0 0 0-.24.236v12.66l3.793-3.102a1.215 1.215 0 0 1 1.534 0l3.793 3.103V3.654a.238.238 0 0 0-.24-.237H5.68ZM4 3.653C4 2.74 4.752 2 5.68 2h8.64c.928 0 1.68.74 1.68 1.653v13.164c0 1-1.185 1.547-1.967.908L10 14.426l-4.033 3.299c-.782.64-1.967.092-1.967-.908V3.653Z\"/></svg>";
+
+var bookmarkInline = "<svg viewBox=\"0 0 14 16\" xmlns=\"http://www.w3.org/2000/svg\"><path class=\"ck-icon__fill\" d=\"M2 14.436V2a1 1 0 0 1 1-1h8a1 1 0 0 1 1 1v12.436a.5.5 0 0 1-.819.385l-3.862-3.2a.5.5 0 0 0-.638 0l-3.862 3.2A.5.5 0 0 1 2 14.436Z\"/></svg>";
+
 const icons = {
     bold,
     cancel,
@@ -2623,7 +3052,10 @@ const icons = {
     html,
     indent,
     outdent,
-    table
+    table,
+    remove,
+    bookmark,
+    bookmarkInline
 };
 
 export { Command, Context, ContextPlugin, DataApiMixin, Editor, ElementApiMixin, MultiCommand, PendingActions, Plugin, attachToForm, icons, secureSourceElement };