@ckeditor/ckeditor5-real-time-collaboration 48.2.0 → 48.3.0-alpha.0

package/dist/realtimecollaborativeediting/realtimecollaborationclient.d.ts

@@ -1,145 +1,134 @@
 /**
- * @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/realtimecollaborativeediting/realtimecollaborationclient
- * @publicApi
- */
-import { Plugin, PendingActions, type Editor } from '@ckeditor/ckeditor5-core';
-import { Notification } from '@ckeditor/ckeditor5-ui';
-import { WebSocketGateway } from './websocketgateway.js';
-import { Sessions } from './sessions.js';
-import { UserMarkers } from './usermarkers.js';
-import { Users, type CollaborationHistory } from '@ckeditor/ckeditor5-collaboration-core';
-import { CollaborativeEditingService } from '@ckeditor/ckeditor-cloud-services-collaboration';
+* @module real-time-collaboration/realtimecollaborativeediting/realtimecollaborationclient
+* @publicApi
+*/
+import { Plugin, PendingActions, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Notification } from "@ckeditor/ckeditor5-ui";
+import { WebSocketGateway } from "./websocketgateway.js";
+import { Sessions } from "./sessions.js";
+import { UserMarkers } from "./usermarkers.js";
+import { Users, type CollaborationHistory } from "@ckeditor/ckeditor5-collaboration-core";
+import { CollaborativeEditingService } from "@ckeditor/ckeditor-cloud-services-collaboration";
 /**
- * Handles the real-time collaborative editing.
- */
+* Handles the real-time collaborative editing.
+*/
 export declare class RealTimeCollaborationClient extends Plugin {
-    static CollaborativeEditingService: typeof CollaborativeEditingService;
-    /**
-     * The ID of the current editing session to which the client is connected (or was connected before losing the connection).
-     */
-    sessionId: string | null;
-    /**
-     * Holds the history of operations that have been applied on the collaboration server.
-     *
-     * Contains only these operations, that have been already synchronized. It is exactly the same for all clients
-     * connected to the same editing session.
-     *
-     * All original operations are cloned.
-     */
-    serverHistory: CollaborationHistory;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof WebSocketGateway, typeof Sessions, typeof UserMarkers, typeof PendingActions, typeof Users, typeof Notification];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RealTimeCollaborationClient";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * Incremented every time the document is synchronized with Cloud Services server. It can be treated as the server's current document
-     * version. This number is stored between editing sessions, so even when all clients disconnect, the editing session is closed, the
-     * next time the document is initialized, the version number will stay the same and will continue to be incremented with
-     * subsequent document changes.
-     *
-     * Use this version to compare which client has a newer version of the document. It is recommended to save it together with the
-     * document content in the database. Comparing `cloudDocumentVersion` can be used to prevent overwriting a newer content with
-     * an older one from another client.
-     */
-    get cloudDocumentVersion(): number;
-    /**
-     * The last document version synchronized with the server during current real-time collaboration session.
-     *
-     * Equals to `0` when the client is not connected to the server yet.
-     *
-     * This includes only operations created by this or other clients. Notably, user selection markers operations created by
-     * the server are excluded.
-     */
-    get lastSyncVersion(): number;
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Reconnects the client to the document.
-     *
-     * If the document has been flushed (editing session for that document was closed) in the meantime, the editing session is recreated
-     * using the local operations history.
-     *
-     * There are several scenarios where the reconnection can fail because it is impossible to synchronize local document state with the
-     * server editing session or with the document state saved in the database. In those situations, the editor switches to read-only
-     * mode and a {@link module:ui/notification/notification~Notification `Notification`} is created.
-     */
-    reconnect(): Promise<void>;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Handles the server response after the reconnection.
-     */
-    private _handleReconnectionResponse;
-    /**
-     * Connects the client to the editing session.
-     *
-     * If this client is the first one that tries connecting to the session, the session will be created based on its
-     * local operations. Otherwise, the server will respond with server operations that are already stored on the server for the
-     * existing session and those operations will replace this client's editor content.
-     *
-     * @param isReconnectionProcess Set to `true` when reconnecting to the document after the document has been flushed.
-     */
-    private _connectService;
-    /**
-     * Handles operations received from the server. Callback for the `CollaborativeEditingService#event:operationsReceived`.
-     */
-    private _handleReceivedOperations;
-    /**
-     * Connects the client to the editing session after it has been flushed. The client will use the local operations history to re-create
-     * the editing session on the server.
-     */
-    private _connectAfterSessionHasBeenFlushed;
-    /**
-     * Fetches missing users based on author IDs of the given operations.
-     */
-    private _fetchMissingUsers;
-    /**
-     * Performs root loading in a way that is safe for real-time collaboration. Synchronizes with the server and use the local data only
-     * if the given root has not been loaded on any other client yet. Returns a promise which resolves after the root is ready.
-     *
-     * It transforms given data and root attributes into operations and tries to send them to the server. The operations are sent in
-     * a regular way. The root is ready after they are finally applied on the server.
-     *
-     * @private
-     */
-    private _loadRoot;
-    /**
-     * Handles the initial connection.
-     */
-    private _handleInitialConnectionData;
-    private _sendBufferedOperations;
-    /**
-     * Handles a response from the server for the following actions:
-     * - connection
-     * - reconnection
-     * - sending buffered operations.
-     *
-     * @param sentOperations Operations sent to the server.
-     * @param response The server's response.
-     * @param requestId
-     * @returns Resolves to `true` if the updates process has finished,
-     * resolves to `false` if next batch of updates was sent to the server.
-     */
-    private _handleServerResponse;
+	static CollaborativeEditingService: typeof CollaborativeEditingService;
+	/**
+	* The ID of the current editing session to which the client is connected (or was connected before losing the connection).
+	*/
+	sessionId: string | null;
+	/**
+	* Holds the history of operations that have been applied on the collaboration server.
+	*
+	* Contains only these operations, that have been already synchronized. It is exactly the same for all clients
+	* connected to the same editing session.
+	*
+	* All original operations are cloned.
+	*/
+	serverHistory: CollaborationHistory;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[WebSocketGateway, Sessions, UserMarkers, PendingActions, Users, Notification]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "RealTimeCollaborationClient";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* Incremented every time the document is synchronized with Cloud Services server. It can be treated as the server's current document
+	* version. This number is stored between editing sessions, so even when all clients disconnect, the editing session is closed, the
+	* next time the document is initialized, the version number will stay the same and will continue to be incremented with
+	* subsequent document changes.
+	*
+	* Use this version to compare which client has a newer version of the document. It is recommended to save it together with the
+	* document content in the database. Comparing `cloudDocumentVersion` can be used to prevent overwriting a newer content with
+	* an older one from another client.
+	*/
+	get cloudDocumentVersion(): number;
+	/**
+	* The last document version synchronized with the server during current real-time collaboration session.
+	*
+	* Equals to `0` when the client is not connected to the server yet.
+	*
+	* This includes only operations created by this or other clients. Notably, user selection markers operations created by
+	* the server are excluded.
+	*/
+	get lastSyncVersion(): number;
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Handles the server response after the reconnection.
+	*/
+	private _handleReconnectionResponse;
+	/**
+	* Connects the client to the editing session.
+	*
+	* If this client is the first one that tries connecting to the session, the session will be created based on its
+	* local operations. Otherwise, the server will respond with server operations that are already stored on the server for the
+	* existing session and those operations will replace this client's editor content.
+	*
+	* @param isReconnectionProcess Set to `true` when reconnecting to the document after the document has been flushed.
+	*/
+	private _connectService;
+	/**
+	* Handles operations received from the server. Callback for the `CollaborativeEditingService#event:operationsReceived`.
+	*/
+	private _handleReceivedOperations;
+	/**
+	* Connects the client to the editing session after it has been flushed. The client will use the local operations history to re-create
+	* the editing session on the server.
+	*/
+	private _connectAfterSessionHasBeenFlushed;
+	/**
+	* Fetches missing users based on author IDs of the given operations.
+	*/
+	private _fetchMissingUsers;
+	/**
+	* Performs root loading in a way that is safe for real-time collaboration. Synchronizes with the server and use the local data only
+	* if the given root has not been loaded on any other client yet. Returns a promise which resolves after the root is ready.
+	*
+	* It transforms given data and root attributes into operations and tries to send them to the server. The operations are sent in
+	* a regular way. The root is ready after they are finally applied on the server.
+	*
+	* @private
+	*/
+	private _loadRoot;
+	/**
+	* Handles the initial connection.
+	*/
+	private _handleInitialConnectionData;
+	private _sendBufferedOperations;
+	/**
+	* Handles a response from the server for the following actions:
+	* - connection
+	* - reconnection
+	* - sending buffered operations.
+	*
+	* @param sentOperations Operations sent to the server.
+	* @param response The server's response.
+	* @param requestId
+	* @returns Resolves to `true` if the updates process has finished,
+	* resolves to `false` if next batch of updates was sent to the server.
+	*/
+	private _handleServerResponse;
 }

package/dist/realtimecollaborativeediting/sessions.d.ts

@@ -1,126 +1,124 @@
 /**
- * @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/realtimecollaborativeediting/sessions
- * @publicApi
- */
-import { ContextPlugin, type Editor, type Context } from '@ckeditor/ckeditor5-core';
-import { Collection } from '@ckeditor/ckeditor5-utils';
-import { WebSocketGateway } from './websocketgateway.js';
-import { Users, type User } from '@ckeditor/ckeditor5-collaboration-core';
-import type { User as ServerUserModel, SessionCollection, ISocket } from '@ckeditor/ckeditor-cloud-services-collaboration';
+* @module real-time-collaboration/realtimecollaborativeediting/sessions
+* @publicApi
+*/
+import { ContextPlugin, type Editor, type Context, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Collection } from "@ckeditor/ckeditor5-utils";
+import { WebSocketGateway } from "./websocketgateway.js";
+import { Users, type User } from "@ckeditor/ckeditor5-collaboration-core";
+import type { User as ServerUserModel, SessionCollection, ISocket } from "@ckeditor/ckeditor-cloud-services-collaboration";
 export type RtcServerUser = ServerUserModel & User;
 /**
- *
- * The `Sessions` plugin stores the information about the users and sessions connected to the rich text editor.
- *
- * The difference between the sessions plugin and the {@link module:collaboration-core/users~Users `Users` plugin} is that
- * `Users` also keeps information about the users who are not currently connected to the editor (for example, a comment
- * author who is currently offline).
- *
- * If your integration uses {@link module:core/context~Context} and there are multiple channels used, the `Sessions` plugin
- * aggregates users connected to all the channels.
- *
- * There are two types of entries in the sessions plugin: connected users and sessions.
- *
- * There is one session for each connection to a given channel. For example, for each open editor instance connecting
- * to a given channel ID, there will be a session. Every session has a user. However, the same user can be linked
- * with multiple sessions (for example, the same user opened the same URL in multiple tabs).
- *
- * In other words, if the same user (with the same user ID) opens the same document in two different tabs, they will create
- * two sessions but only one user will be connected. You will be able to see two selections in the same document, both in
- * the same color, but only a single user in the {@link module:real-time-collaboration/presencelist~PresenceList user presence list}.
- */
+*
+* The `Sessions` plugin stores the information about the users and sessions connected to the rich text editor.
+*
+* The difference between the sessions plugin and the {@link module:collaboration-core/users~Users `Users` plugin} is that
+* `Users` also keeps information about the users who are not currently connected to the editor (for example, a comment
+* author who is currently offline).
+*
+* If your integration uses {@link module:core/context~Context} and there are multiple channels used, the `Sessions` plugin
+* aggregates users connected to all the channels.
+*
+* There are two types of entries in the sessions plugin: connected users and sessions.
+*
+* There is one session for each connection to a given channel. For example, for each open editor instance connecting
+* to a given channel ID, there will be a session. Every session has a user. However, the same user can be linked
+* with multiple sessions (for example, the same user opened the same URL in multiple tabs).
+*
+* In other words, if the same user (with the same user ID) opens the same document in two different tabs, they will create
+* two sessions but only one user will be connected. You will be able to see two selections in the same document, both in
+* the same color, but only a single user in the {@link module:real-time-collaboration/presencelist~PresenceList user presence list}.
+*/
 export declare class Sessions extends ContextPlugin {
-    /**
-     * A map of session collections connected to the separate channels.
-     *
-     * The keys of the map are channel IDs and the values are collections of sessions.
-     *
-     * A session is represented by an object with the following properties:
-     * * `id` - A unique session ID.
-     * * `user` - A reference to the user.
-     */
-    channelSessions: Map<string, Collection<ISocket>>;
-    /**
-     * A map of user collections connected to the separate channels.
-     *
-     * The keys of the map are channel IDs and the values are collections of users.
-     */
-    channelConnectedUsers: Map<string, Collection<ISocket>>;
-    /**
-     * A collection of users currently connected to all channels.
-     *
-     * A local user is always the first element in this collection.
-     */
-    allConnectedUsers: Collection<User>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Sessions";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof WebSocketGateway, typeof Users];
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Editor | Context);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Observes given service sessions and updates session and users according to it.
-     */
-    register(channelId: string, serviceSessions: SessionCollection): void;
-    /**
-     * Stops observing given service sessions and remove all related sessions and users.
-     */
-    unregister(channelId: string): void;
-    /**
-     * Session id of the current client.
-     */
-    get mySessionId(): string;
-    /**
-     * Returns a reference to the user connected with a session with the given ID.
-     */
-    getUserBySessionId(sessionId: string): RtcServerUser | undefined;
-    /**
-     * Returns a set of ids of all currently connected sessions for the given user.
-     *
-     * When one user is connected to the same document in two separate browser tabs
-     * then this users belongs to the two sessions.
-     *
-     * Optionally the result can be limited to the given channelId.
-     */
-    getUserSessions(user: RtcServerUser, channelId?: string): Set<string>;
-    /**
-     * Returns the role of a given user.
-     */
-    getUserRole(user: RtcServerUser): string | undefined;
+	/**
+	* A map of session collections connected to the separate channels.
+	*
+	* The keys of the map are channel IDs and the values are collections of sessions.
+	*
+	* A session is represented by an object with the following properties:
+	* * `id` - A unique session ID.
+	* * `user` - A reference to the user.
+	*/
+	channelSessions: Map<string, Collection<ISocket>>;
+	/**
+	* A map of user collections connected to the separate channels.
+	*
+	* The keys of the map are channel IDs and the values are collections of users.
+	*/
+	channelConnectedUsers: Map<string, Collection<ISocket>>;
+	/**
+	* A collection of users currently connected to all channels.
+	*
+	* A local user is always the first element in this collection.
+	*/
+	allConnectedUsers: Collection<User>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Sessions";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[WebSocketGateway, Users]>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(context: Editor | Context);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Observes given service sessions and updates session and users according to it.
+	*/
+	register(channelId: string, serviceSessions: SessionCollection): void;
+	/**
+	* Stops observing given service sessions and remove all related sessions and users.
+	*/
+	unregister(channelId: string): void;
+	/**
+	* Session id of the current client.
+	*/
+	get mySessionId(): string;
+	/**
+	* Returns a reference to the user connected with a session with the given ID.
+	*/
+	getUserBySessionId(sessionId: string): RtcServerUser | undefined;
+	/**
+	* Returns a set of ids of all currently connected sessions for the given user.
+	*
+	* When one user is connected to the same document in two separate browser tabs
+	* then this users belongs to the two sessions.
+	*
+	* Optionally the result can be limited to the given channelId.
+	*/
+	getUserSessions(user: RtcServerUser, channelId?: string): Set<string>;
+	/**
+	* Returns the role of a given user.
+	*/
+	getUserRole(user: RtcServerUser): string | undefined;
 }
 /**
- * Fired when the new user session is added.
- *
- * @eventName ~Sessions#sessionAdd:channelId
- */
+* Fired when the new user session is added.
+*
+* @eventName ~Sessions#sessionAdd:channelId
+*/
 export type RtcSessionAddEvent = {
-    name: 'sessionAdd' | `sessionAdd:${string}`;
-    args: [
-        {
-            channelId: string;
-            session: ISocket;
-        }
-    ];
+	name: "sessionAdd" | `sessionAdd:${string}`;
+	args: [{
+		channelId: string;
+		session: ISocket;
+	}];
 };

package/dist/realtimecollaborativeediting/usermarkers.d.ts

@@ -1,51 +1,51 @@
 /**
- * @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/realtimecollaborativeediting/usermarkers
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { Sessions } from './sessions.js';
-import '../../theme/usermarkers.css';
+* @module real-time-collaboration/realtimecollaborativeediting/usermarkers
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Sessions } from "./sessions.js";
+import "../../theme/usermarkers.css";
 /**
- * This plugin:
- *
- * 1. Creates marker operations with current user selection on demand.
- * 2. Renders clients selection markers.
- *
- * This plugin does not create markers automatically, instead it provides an API for it {@link #createUserMarkerOperations}.
- * {@link RealTimeCollaborationClient} uses this API to create user selection operations in the most optimal moment
- * (as the last operation in the operations package) - this is to reach the best compression result.
- */
+* This plugin:
+*
+* 1. Creates marker operations with current user selection on demand.
+* 2. Renders clients selection markers.
+*
+* This plugin does not create markers automatically, instead it provides an API for it {@link #createUserMarkerOperations}.
+* {@link RealTimeCollaborationClient} uses this API to create user selection operations in the most optimal moment
+* (as the last operation in the operations package) - this is to reach the best compression result.
+*/
 export declare class UserMarkers extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Sessions];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "UserMarkers";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    afterInit(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Creates marker operations with current user selection.
-     */
-    createUserMarkerOperations(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Sessions]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "UserMarkers";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Creates marker operations with current user selection.
+	*/
+	createUserMarkerOperations(): void;
 }