@ckeditor/ckeditor5-real-time-collaboration 48.8.1-alpha.4 → 49.0.0-alpha.0

package/LICENSE.md

@@ -14,7 +14,7 @@ Where not otherwise indicated, all CKEditor 5 content is authored by CKSour
 
 The following libraries are included in CKEditor 5 under the [MIT license](https://opensource.org/licenses/MIT):
 
-* es-toolkit - Copyright (c) 2024 Viva Republica, Inc and Copyright OpenJS Foundation and other contributors.
+* es-toolkit - Copyright (c) 2024 Viva Republica, Inc.
 * socket.io-client - Copyright (c) 2014-present Guillermo Rauch and Socket.IO contributors.
 * socket.io-parser - Copyright (c) 2014-present Guillermo Rauch and Socket.IO contributors.
 * url-parse - Copyright (c) 2015 Unshift.io, Arnout Kazemier, the Contributors.

package/dist/augmentation.d.ts

@@ -1,71 +1,71 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { RtcPresenceListConfig } from './config.js';
-import type { RealTimeCollaborativeEditing, RealTimeCollaborativeTrackChanges, RealTimeCollaborativeComments, RealTimeCollaborativeRevisionHistory, CloudServicesCommentsAdapter, CloudServicesTrackChangesAdapter, CloudServicesRevisionHistoryAdapter, RealTimeCollaborationClient } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        presenceList?: RtcPresenceListConfig;
-    }
-    interface PluginsMap {
-        [RealTimeCollaborativeEditing.pluginName]: RealTimeCollaborativeEditing;
-        [RealTimeCollaborativeTrackChanges.pluginName]: RealTimeCollaborativeTrackChanges;
-        [RealTimeCollaborativeComments.pluginName]: RealTimeCollaborativeComments;
-        [RealTimeCollaborativeRevisionHistory.pluginName]: RealTimeCollaborativeRevisionHistory;
-        [CloudServicesCommentsAdapter.pluginName]: CloudServicesCommentsAdapter;
-        [CloudServicesTrackChangesAdapter.pluginName]: CloudServicesTrackChangesAdapter;
-        [CloudServicesRevisionHistoryAdapter.pluginName]: CloudServicesRevisionHistoryAdapter;
-        [RealTimeCollaborationClient.pluginName]: RealTimeCollaborationClient;
-    }
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import type { RtcPresenceListConfig } from "./config.js";
+import type { RealTimeCollaborativeEditing, RealTimeCollaborativeTrackChanges, RealTimeCollaborativeComments, RealTimeCollaborativeRevisionHistory, CloudServicesCommentsAdapter, CloudServicesTrackChangesAdapter, CloudServicesRevisionHistoryAdapter, RealTimeCollaborationClient } from "./index.js";
+declare module "@ckeditor/ckeditor5-core" {
+	interface EditorConfig {
+		presenceList?: RtcPresenceListConfig;
+	}
+	interface PluginsMap {
+		[RealTimeCollaborativeEditing.pluginName]: RealTimeCollaborativeEditing;
+		[RealTimeCollaborativeTrackChanges.pluginName]: RealTimeCollaborativeTrackChanges;
+		[RealTimeCollaborativeComments.pluginName]: RealTimeCollaborativeComments;
+		[RealTimeCollaborativeRevisionHistory.pluginName]: RealTimeCollaborativeRevisionHistory;
+		[CloudServicesCommentsAdapter.pluginName]: CloudServicesCommentsAdapter;
+		[CloudServicesTrackChangesAdapter.pluginName]: CloudServicesTrackChangesAdapter;
+		[CloudServicesRevisionHistoryAdapter.pluginName]: CloudServicesRevisionHistoryAdapter;
+		[RealTimeCollaborationClient.pluginName]: RealTimeCollaborationClient;
+	}
 }
-declare module '@ckeditor/ckeditor5-cloud-services' {
-    interface CloudServicesConfig {
-        /**
-         * The timeout (in seconds) for the connection. Defaults to 10.
-         *
-         * If the connection will not be established after the specified number of second passes, the editor will throw an error.
-         *
-         * Raise this value if you are experiencing connection timeout problems.
-         *
-         * ```ts
-         * ClassicEditor
-         * 	.create( {
-         * 		cloudServices: {
-         * 			connectionTimeout: 20,
-         * 			// ...
-         * 		}
-         * 	} )
-         * 	.then( ... )
-         * 	.catch( ... );
-         * ```
-         */
-        connectionTimeout?: number;
-        /**
-         * The timeout (in seconds) for each request send to the Cloud Services. Defaults to 20.
-         *
-         * If the request is not finished after the specified number of second passes, the editor will throw an error.
-         *
-         * Raise this value if you expect that your requests will be big
-         * (e.g. mostly concerns the document data and the initial request).
-         *
-         * ```ts
-         * ClassicEditor
-         * 	.create( {
-         * 		cloudServices: {
-         * 			requestTimeout: 40,
-         * 			// ...
-         * 		}
-         * 	} )
-         * 	.then( ... )
-         * 	.catch( ... );
-         * ```
-         */
-        requestTimeout?: number;
-    }
+declare module "@ckeditor/ckeditor5-cloud-services" {
+	interface CloudServicesConfig {
+		/**
+		* The timeout (in seconds) for the connection. Defaults to 10.
+		*
+		* If the connection will not be established after the specified number of second passes, the editor will throw an error.
+		*
+		* Raise this value if you are experiencing connection timeout problems.
+		*
+		* ```ts
+		* ClassicEditor
+		* 	.create( {
+		* 		cloudServices: {
+		* 			connectionTimeout: 20,
+		* 			// ...
+		* 		}
+		* 	} )
+		* 	.then( ... )
+		* 	.catch( ... );
+		* ```
+		*/
+		connectionTimeout?: number;
+		/**
+		* The timeout (in seconds) for each request send to the Cloud Services. Defaults to 20.
+		*
+		* If the request is not finished after the specified number of second passes, the editor will throw an error.
+		*
+		* Raise this value if you expect that your requests will be big
+		* (e.g. mostly concerns the document data and the initial request).
+		*
+		* ```ts
+		* ClassicEditor
+		* 	.create( {
+		* 		cloudServices: {
+		* 			requestTimeout: 40,
+		* 			// ...
+		* 		}
+		* 	} )
+		* 	.then( ... )
+		* 	.catch( ... );
+		* ```
+		*/
+		requestTimeout?: number;
+	}
 }
-declare module '@ckeditor/ckeditor5-collaboration-core' {
-    interface User {
-        orderNumber?: number;
-    }
+declare module "@ckeditor/ckeditor5-collaboration-core" {
+	interface User {
+		orderNumber?: number;
+	}
 }

package/dist/common-translations.d.ts

@@ -1,9 +1,9 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module real-time-collaboration/common-translations
- */
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module real-time-collaboration/common-translations
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
 export declare function getTranslation(locale: Locale, id: string, values?: Array<string> | number): string;

package/dist/config.d.ts

@@ -1,48 +1,62 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module real-time-collaboration/config
- * @publicApi
- */
-import type { User } from '@ckeditor/ckeditor5-collaboration-core';
+* @module real-time-collaboration/config
+* @publicApi
+*/
+import type { User } from "@ckeditor/ckeditor5-collaboration-core";
 /**
- * The configuration of the real-time collaboration features.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		presenceList: ... // Collaboration presence list configuration.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the real-time collaboration features.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		presenceList: ... // Collaboration presence list configuration.
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface RtcPresenceListConfig {
-    /**
-     * Indicates a number of displayed users at which the presence list will switch to a dropdown view.
-     * If the number is 8, then 7 users will still be displayed inline, while 8+ users will be displayed in the dropdown.
-     *
-     * The number must be greater than `0`.
-     *
-     * @default 6
-     */
-    collapseAt?: number;
-    /**
-     * DOM element that will hold the feature’s UI.
-     */
-    container?: HTMLElement;
-    /**
-     * Determines if the local user avatar should be displayed in the presence list (`true`) or not (`false`).
-     *
-     * @default true
-     */
-    displayMe?: boolean;
-    /**
-     * Callback function that will be invoked after a click on a presence list member.
-     */
-    onClick?: (user: User, element: HTMLElement) => void;
+	/**
+	* Indicates a number of displayed users at which the presence list will switch to a dropdown view.
+	* If the number is 8, then 7 users will still be displayed inline, while 8+ users will be displayed in the dropdown.
+	*
+	* The number must be greater than `0`.
+	*
+	* @default 6
+	*/
+	collapseAt?: number;
+	/**
+	* DOM element that will hold the feature’s UI.
+	*/
+	container?: HTMLElement;
+	/**
+	* DOM element or shadow root into which the floating presence list dropdown is mounted.
+	*
+	* When the presence list runs inside a shadow root, provide this container as a separate shadow root attached
+	* to a host element placed at the end of `document.body`, rather than to an element nested in the presence
+	* list's own tree. As a direct child of `document.body`, that host has no scrollable or `overflow: hidden`
+	* ancestor to clip the dropdown (the {@link #container} typically clips its own overflow).
+	*
+	* When it is not set, the shared {@link module:core/editor/editorconfig~UiConfig#overlayContainer
+	* `ui.overlayContainer`} from the context configuration is used instead, if present. Otherwise the dropdown is
+	* mounted into the shadow root that the {@link #container} lives in, so it inherits the same styles; the
+	* `document.body` default is meant just for a presence list in the light DOM.
+	*/
+	overlayContainer?: HTMLElement | ShadowRoot;
+	/**
+	* Determines if the local user avatar should be displayed in the presence list (`true`) or not (`false`).
+	*
+	* @default true
+	*/
+	displayMe?: boolean;
+	/**
+	* Callback function that will be invoked after a click on a presence list member.
+	*/
+	onClick?: (user: User, element: HTMLElement) => void;
 }