@ckeditor/ckeditor5-core 0.0.0-internal-20241017.0

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

@@ -0,0 +1,19 @@
+/**
+ * @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 { default as Editor } from '../editor.js';
+import type { ElementApi } from './elementapimixin.js';
+/**
+ * Checks if the editor is initialized on a `<textarea>` element that belongs to a form. If yes, it updates the editor's element
+ * content before submitting the form.
+ *
+ * This helper requires the {@link module:core/editor/utils/elementapimixin~ElementApi ElementApi interface}.
+ *
+ * @param editor Editor instance.
+ */
+export default function attachToForm(editor: Editor & ElementApi): void;

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

@@ -0,0 +1,83 @@
+/**
+ * @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
+ */
+/**
+ * @module core/editor/utils/dataapimixin
+ */
+import type Editor from '../editor.js';
+import type { Constructor } from '@ckeditor/ckeditor5-utils';
+/**
+ * Implementation of the {@link module:core/editor/utils/dataapimixin~DataApi}.
+ *
+ * @deprecated This functionality is already implemented by the `Editor` class.
+ */
+export default function DataApiMixin<Base extends Constructor<Editor>>(base: Base): Base;
+/**
+ * Interface defining editor methods for setting and getting data to and from the editor's main root element
+ * using the {@link module:core/editor/editor~Editor#data data pipeline}.
+ *
+ * This interface is not a part of the {@link module:core/editor/editor~Editor} class because one may want to implement
+ * an editor with multiple root elements, in which case the methods for setting and getting data will need to be implemented
+ * differently.
+ *
+ * @deprecated This interface is implemented by all `Editor` instances by default.
+ */
+export interface DataApi {
+    /**
+     * Sets the data in the editor.
+     *
+     * ```ts
+     * editor.setData( '<p>This is editor!</p>' );
+     * ```
+     *
+     * If your editor implementation uses multiple roots, you should pass an object with keys corresponding
+     * to the editor root names and values equal to the data that should be set in each root:
+     *
+     * ```ts
+     * editor.setData( {
+     *     header: '<p>Content for header part.</p>',
+     *     content: '<p>Content for main part.</p>',
+     *     footer: '<p>Content for footer part.</p>'
+     * } );
+     * ```
+     *
+     * By default the editor accepts HTML. This can be controlled by injecting a different data processor.
+     * See the {@glink features/markdown Markdown output} guide for more details.
+     *
+     * @param data Input data.
+     */
+    setData(data: string | Record<string, string>): void;
+    /**
+     * Gets the data from the editor.
+     *
+     * ```ts
+     * editor.getData(); // -> '<p>This is editor!</p>'
+     * ```
+     *
+     * If your editor implementation uses multiple roots, you should pass root name as one of the options:
+     *
+     * ```ts
+     * editor.getData( { rootName: 'header' } ); // -> '<p>Content for header part.</p>'
+     * ```
+     *
+     * By default, the editor outputs HTML. This can be controlled by injecting a different data processor.
+     * See the {@glink features/markdown Markdown output} guide for more details.
+     *
+     * A warning is logged when you try to retrieve data for a detached root, as most probably this is a mistake. A detached root should
+     * be treated like it is removed, and you should not save its data. Note, that the detached root data is always an empty string.
+     *
+     * @param options Additional configuration for the retrieved data.
+     * Editor features may introduce more configuration options that can be set through this parameter.
+     * @param options.rootName Root name. Default to `'main'`.
+     * @param options.trim Whether returned data should be trimmed. This option is set to `'empty'` by default,
+     * which means that whenever editor content is considered empty, an empty string is returned. To turn off trimming
+     * use `'none'`. In such cases exact content will be returned (for example `'<p>&nbsp;</p>'` for an empty editor).
+     * @returns Output data.
+     */
+    getData(options?: Record<string, unknown>): string;
+}

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

@@ -0,0 +1,62 @@
+/**
+ * @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';
+export declare function getEditorUsageData(editor: Editor): EditorUsageData;
+declare global {
+    interface Window {
+        CKEDITOR_PAGE_SESSION_ID?: string;
+    }
+}
+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;
+    integrations: {
+        [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/editor/utils/elementapimixin.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @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
+ */
+/**
+ * @module core/editor/utils/elementapimixin
+ */
+import { type Constructor, type Mixed } from '@ckeditor/ckeditor5-utils';
+import type Editor from '../editor.js';
+/**
+ * Implementation of the {@link module:core/editor/utils/elementapimixin~ElementApi}.
+ */
+export default function ElementApiMixin<Base extends Constructor<Editor>>(base: Base): Mixed<Base, ElementApi>;
+/**
+ * Interface describing an editor that replaced a DOM element (was "initialized on an element").
+ *
+ * Such an editor should provide a method to
+ * {@link module:core/editor/utils/elementapimixin~ElementApi#updateSourceElement update the replaced element with the current data}.
+ */
+export interface ElementApi {
+    /**
+     * The element on which the editor has been initialized.
+     *
+     * @readonly
+     */
+    sourceElement: HTMLElement | undefined;
+    /**
+     * Updates the {@link #sourceElement editor source element}'s content with the data if the
+     * {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy `updateSourceElementOnDestroy`}
+     * configuration option is set to `true`.
+     *
+     * @param data Data that the {@link #sourceElement editor source element} should be updated with.
+     */
+    updateSourceElement(data?: string): void;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * @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 { default as Editor } from '../editor.js';
+/**
+ * Marks the source element on which the editor was initialized. This prevents other editor instances from using this element.
+ *
+ * Running multiple editor instances on the same source element causes various issues and it is
+ * crucial this helper is called as soon as the source element is known to prevent collisions.
+ *
+ * @param editor Editor instance.
+ * @param sourceElement Element to bind with the editor instance.
+ */
+export default function secureSourceElement(editor: Editor, sourceElement: HTMLElement & {
+    ckeditorInstance?: Editor;
+}): void;

package/dist/index-content.css

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

package/dist/index-editor.css

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

package/dist/index.css

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

package/dist/index.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @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
+ */
+/**
+ * @module core
+ */
+export { default as Plugin, type PluginDependencies, type PluginConstructor } from './plugin.js';
+export { default as Command, type CommandExecuteEvent } from './command.js';
+export { default as MultiCommand } from './multicommand.js';
+export type { CommandsMap } from './commandcollection.js';
+export type { PluginsMap, default as PluginCollection } from './plugincollection.js';
+export { default as Context, type ContextConfig } from './context.js';
+export { default as ContextPlugin, type ContextPluginDependencies } from './contextplugin.js';
+export { type EditingKeystrokeCallback } from './editingkeystrokehandler.js';
+export type { PartialBy, NonEmptyArray, HexColor } from './typings.js';
+export { default as Editor, type EditorReadyEvent, type EditorDestroyEvent } from './editor/editor.js';
+export type { EditorConfig, LanguageConfig, ToolbarConfig, ToolbarConfigItem, UiConfig } from './editor/editorconfig.js';
+export { default as attachToForm } from './editor/utils/attachtoform.js';
+export { default as DataApiMixin, type DataApi } from './editor/utils/dataapimixin.js';
+export { default as ElementApiMixin, type ElementApi } from './editor/utils/elementapimixin.js';
+export { default as secureSourceElement } from './editor/utils/securesourceelement.js';
+export { default as PendingActions, type PendingAction } from './pendingactions.js';
+export type { KeystrokeInfos as KeystrokeInfoDefinitions, KeystrokeInfoGroup as KeystrokeInfoGroupDefinition, KeystrokeInfoCategory as KeystrokeInfoCategoryDefinition, KeystrokeInfoDefinition as KeystrokeInfoDefinition } from './accessibility.js';
+export declare const icons: {
+    bold: string;
+    cancel: string;
+    caption: string;
+    check: string;
+    cog: string;
+    colorPalette: string;
+    eraser: string;
+    history: string;
+    image: string;
+    imageUpload: string;
+    imageAssetManager: string;
+    imageUrl: string;
+    lowVision: string;
+    textAlternative: string;
+    loupe: string;
+    previousArrow: string;
+    nextArrow: string;
+    importExport: string;
+    paragraph: string;
+    plus: string;
+    text: string;
+    alignBottom: string;
+    alignMiddle: string;
+    alignTop: string;
+    alignLeft: string;
+    alignCenter: string;
+    alignRight: string;
+    alignJustify: string;
+    objectLeft: string;
+    objectCenter: string;
+    objectRight: string;
+    objectFullWidth: string;
+    objectInline: string;
+    objectBlockLeft: string;
+    objectBlockRight: string;
+    objectSizeCustom: string;
+    objectSizeFull: string;
+    objectSizeLarge: string;
+    objectSizeSmall: string;
+    objectSizeMedium: string;
+    pencil: string;
+    pilcrow: string;
+    quote: string;
+    threeVerticalDots: string;
+    dragIndicator: string;
+    redo: string;
+    undo: string;
+    bulletedList: string;
+    numberedList: string;
+    todoList: string;
+    codeBlock: string;
+    browseFiles: string;
+    heading1: string;
+    heading2: string;
+    heading3: string;
+    heading4: string;
+    heading5: string;
+    heading6: string;
+    horizontalLine: string;
+    html: string;
+    indent: string;
+    outdent: string;
+    table: string;
+};
+import './augmentation.js';