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

package/README.md

@@ -3,22 +3,28 @@ CKEditor 5 core editor architecture
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-core.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-core)
 [![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
-[![Build Status](https://travis-ci.com/ckeditor/ckeditor5.svg?branch=master)](https://app.travis-ci.com/github/ckeditor/ckeditor5)
+[![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5?branch=master)
 
 This package implements CKEditor 5's core editor architecture – a set of classes and interfaces which glue everything together.
 
-## Documentation
-
-For general introduction see the [Overview of CKEditor 5 framework](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html) guide and then the [core editor architecture guide](https://ckeditor.com/docs/ckeditor5/latest/framework/architecture/core-editor-architecture.html).
-
-Additionally, see the [`@ckeditor/ckeditor5-core` package](https://ckeditor.com/docs/ckeditor5/latest/api/core.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/) for even more information.
-
 ## Installation
 
+This plugin is part of the `ckeditor5` package. Install the whole package to use it.
+
 ```bash
 npm install ckeditor5
 ```
 
+## Create free account
+
+If you want to check full CKEditor 5 capabilities, sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/signup).
+
+## Documentation
+
+For general introduction see the [Overview of CKEditor 5 framework](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html) guide and then the [core editor architecture guide](https://ckeditor.com/docs/ckeditor5/latest/framework/architecture/core-editor-architecture.html).
+
+Additionally, see the [`@ckeditor/ckeditor5-core` package](https://ckeditor.com/docs/ckeditor5/latest/api/core.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/) for even more information.
+
 ## License
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license).

package/dist/editor/editor.d.ts

@@ -6,9 +6,6 @@
  * @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
  */
-/**
- * @module core/editor/editor
- */
 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';
@@ -20,6 +17,9 @@ import EditingKeystrokeHandler from '../editingkeystrokehandler.js';
 import Accessibility from '../accessibility.js';
 import type { LoadedPlugins, PluginConstructor } from '../plugin.js';
 import type { EditorConfig } from './editorconfig.js';
+declare global {
+    var CKEDITOR_GLOBAL_LICENSE_KEY: string | undefined;
+}
 declare const Editor_base: {
     new (): import("@ckeditor/ckeditor5-utils").Observable;
     prototype: import("@ckeditor/ckeditor5-utils").Observable;
@@ -43,6 +43,10 @@ declare const Editor_base: {
  * (as most editor implementations do).
  */
 export default abstract class Editor extends /* #__PURE__ */ Editor_base {
+    /**
+     * A required name of the editor class. The name should reflect the constructor name.
+     */
+    static get editorName(): `${string}Editor`;
     /**
      * A namespace for the accessibility features of the editor.
      */
@@ -451,6 +455,14 @@ export default abstract class Editor extends /* #__PURE__ */ Editor_base {
      * Exposed as static editor field for easier access in editor builds.
      */
     static ContextWatchdog: typeof ContextWatchdog;
+    private _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.
+     */
+    private _sendUsageRequest;
 }
 /**
  * Fired when the {@link module:engine/controller/datacontroller~DataController#event:ready data} and all additional
@@ -470,6 +482,23 @@ export type EditorReadyEvent = {
     name: 'ready';
     args: [];
 };
+/**
+ * Fired when the editor is about to collect usage data.
+ *
+ * This event is fired when the editor is about to collect usage data. It allows plugins to provide additional data for
+ * the usage statistics. The usage data is collected by the editor and sent to the usage tracking server. All plugins are
+ * expected to be ready at this point.
+ *
+ * @eventName ~Editor#collectUsageData
+ */
+export type EditorCollectUsageDataEvent = {
+    name: 'collectUsageData';
+    args: [
+        {
+            setUsageData(path: string, value: unknown): void;
+        }
+    ];
+};
 /**
  * Fired when this editor instance is destroyed. The editor at this point is not usable and this event should be used to
  * perform the clean-up in any plugin.

package/dist/editor/editorconfig.d.ts

@@ -799,10 +799,12 @@ export interface EditorConfig {
      */
     updateSourceElementOnDestroy?: boolean;
     /**
-     * The license key for the CKEditor 5 commercial license and the premium features.
+     * The CKEditor 5 license key. If you want to obtain a license key, please do one of the following:
      *
-     * If you do not have a key yet, please [contact us](https://ckeditor.com/contact/) or
-     * [order a trial](https://orders.ckeditor.com/trial/premium-features).
+     * * Create a free account, and test the premium features with a [14-day free trial](https://portal.ckeditor.com/checkout?plan=free).
+     * * [Contact us](https://ckeditor.com/contact/) for a commercial license.
+     * * If you are using the editor under a GPL license or another license from our Open Source Initiative,
+     *   use the 'GPL' license key instead.
      */
     licenseKey?: string;
     /**
@@ -914,7 +916,7 @@ export interface PoweredByConfig {
      *
      * @default 'border'
      */
-    position: 'inside' | 'border';
+    position?: 'inside' | 'border';
     /**
      * Allows choosing the side of the editing area where the logo will be displayed.
      *
@@ -923,7 +925,7 @@ export interface PoweredByConfig {
      *
      * @default 'right'
      */
-    side: 'left' | 'right';
+    side?: 'left' | 'right';
     /**
      * Allows changing the label displayed next to the CKEditor logo.
      *
@@ -931,7 +933,7 @@ export interface PoweredByConfig {
      *
      * @default 'Powered by'
      */
-    label: string | null;
+    label?: string | null;
     /**
      * The vertical distance the logo can be moved away from its default position.
      *
@@ -939,13 +941,13 @@ export interface PoweredByConfig {
      *
      * @default 5
      */
-    verticalOffset: number;
+    verticalOffset?: number;
     /**
      * The horizontal distance between the side of the editing root and the nearest side of the logo.
      *
      * @default 5
      */
-    horizontalOffset: number;
+    horizontalOffset?: number;
     /**
      * Allows to show the logo even if the valid commercial license is configured using
      * the {@link module:core/editor/editorconfig~EditorConfig#licenseKey `config.licenseKey`} setting.

package/dist/editor/utils/editorusagedata.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @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
+ */
+/**
+ * @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 type Editor from '../editor.js';
+/**
+ * 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
+ */
+export declare function getEditorUsageData(editor: Editor): EditorUsageData;
+declare global {
+    interface Window {
+        CKEDITOR_PAGE_SESSION_ID?: string;
+    }
+}
+/**
+ * @internal
+ */
+export type EditorUsageData = {
+    sessionId: string;
+    pageSessionId: string;
+    hostname: string;
+    version: string;
+    type: `${string}Editor`;
+    plugins: Array<PluginUsageData>;
+    toolbar: {
+        main?: ToolbarUsageData;
+        block?: ToolbarUsageData;
+        balloon?: ToolbarUsageData;
+    };
+    menuBar: {
+        isVisible: boolean;
+    };
+    language: {
+        ui: string;
+        content: string;
+    };
+    distribution: {
+        channel: string;
+    };
+    env: EnvUsageData;
+    integration: {
+        [integrationName: string]: IntegrationUsageData;
+    };
+};
+type IntegrationUsageData = {
+    version: string;
+    frameworkVersion?: string;
+};
+type EnvUsageData = {
+    os: 'mac' | 'windows' | 'ios' | 'android' | 'unknown';
+    browser: 'safari' | 'gecko' | 'blink' | 'unknown';
+};
+type ToolbarUsageData = {
+    items: Array<string>;
+    isMultiline: boolean;
+    shouldNotGroupWhenFull: boolean;
+};
+type PluginUsageData = {
+    name: string;
+    isPremium: boolean;
+    isOfficial: boolean;
+    isContext: boolean;
+};
+export {};

package/dist/index.d.ts

@@ -90,5 +90,8 @@ export declare const icons: {
     indent: string;
     outdent: string;
     table: string;
+    remove: string;
+    bookmark: string;
+    bookmarkInline: string;
 };
 import './augmentation.js';