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

package/src/editor/utils/editorusagedata.js

@@ -0,0 +1,127 @@
+/**
+ * @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/utils/editorusagedata
+ */
+import { env, global, uid } from '@ckeditor/ckeditor5-utils';
+/**
+ * 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 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;
+}

package/src/index.d.ts

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

package/src/index.js

@@ -79,6 +79,9 @@ import html from './../theme/icons/html.svg';
 import indent from './../theme/icons/indent.svg';
 import outdent from './../theme/icons/outdent.svg';
 import table from './../theme/icons/table.svg';
+import remove from './../theme/icons/remove.svg';
+import bookmark from './../theme/icons/bookmark.svg';
+import bookmarkInline from './../theme/icons/bookmark_inline.svg';
 export const icons = {
     bold,
     cancel,
@@ -142,6 +145,9 @@ export const icons = {
     html,
     indent,
     outdent,
-    table
+    table,
+    remove,
+    bookmark,
+    bookmarkInline
 };
 import './augmentation.js';

package/src/plugincollection.js

@@ -279,7 +279,7 @@ export default class PluginCollection extends /* #__PURE__ */ EmitterMixin() {
              * 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.

package/theme/icons/bookmark.svg

@@ -0,0 +1 @@
+<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>

package/theme/icons/bookmark_inline.svg

@@ -0,0 +1 @@
+<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>

package/theme/icons/remove.svg

@@ -0,0 +1 @@
+<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>