@ckeditor/ckeditor5-collaboration-core 48.2.0 → 48.3.0-alpha.1

package/dist/augmentation.d.ts

@@ -1,30 +1,30 @@
 /**
- * @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 { LocaleConfig, Users, Permissions } from './index.js';
-import type { RealTimeCollaborationConfig, CollaborationUsersConfig } from './config.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The locale configuration of the editor.
-         */
-        locale?: LocaleConfig;
-        /**
-         * The users plugin configuration.
-         */
-        users?: CollaborationUsersConfig;
-        /**
-         * The configuration of the real time collaboration feature.
-         *
-         * Read more in {@link module:collaboration-core/config~RealTimeCollaborationConfig}.
-         *
-         * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
-         */
-        collaboration?: RealTimeCollaborationConfig;
-    }
-    interface PluginsMap {
-        [Permissions.pluginName]: Permissions;
-        [Users.pluginName]: Users;
-    }
+* @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 { LocaleConfig, Users, Permissions } from "./index.js";
+import type { RealTimeCollaborationConfig, CollaborationUsersConfig } from "./config.js";
+declare module "@ckeditor/ckeditor5-core" {
+	interface EditorConfig {
+		/**
+		* The locale configuration of the editor.
+		*/
+		locale?: LocaleConfig;
+		/**
+		* The users plugin configuration.
+		*/
+		users?: CollaborationUsersConfig;
+		/**
+		* The configuration of the real time collaboration feature.
+		*
+		* Read more in {@link module:collaboration-core/config~RealTimeCollaborationConfig}.
+		*
+		* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+		*/
+		collaboration?: RealTimeCollaborationConfig;
+	}
+	interface PluginsMap {
+		[Permissions.pluginName]: Permissions;
+		[Users.pluginName]: Users;
+	}
 }

package/dist/collaborationhistory.d.ts

@@ -1,21 +1,21 @@
 /**
- * @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 collaboration-core/collaborationhistory
- * @publicApi
- */
-import type { CollaborationOperation } from './collaborationoperation.js';
+* @module collaboration-core/collaborationhistory
+* @publicApi
+*/
+import type { CollaborationOperation } from "./collaborationoperation.js";
 /**
- * Interface compatible with {@link module:engine/model/history~History} with the difference that it uses
- * {@link module:collaboration-core/collaborationoperation~CollaborationOperation} instead of regular model operations.
- */
+* Interface compatible with {@link module:engine/model/history~History} with the difference that it uses
+* {@link module:collaboration-core/collaborationoperation~CollaborationOperation} instead of regular model operations.
+*/
 export interface CollaborationHistory {
-    _operations: Array<CollaborationOperation>;
-    version: number;
-    getOperations(fromBaseVersion?: number, toBaseVersion?: number): Array<CollaborationOperation>;
-    getOperation(baseVersion: number): CollaborationOperation | undefined;
-    addOperation(operation: CollaborationOperation): void;
-    reset(): void;
+	_operations: Array<CollaborationOperation>;
+	version: number;
+	getOperations(fromBaseVersion?: number, toBaseVersion?: number): Array<CollaborationOperation>;
+	getOperation(baseVersion: number): CollaborationOperation | undefined;
+	addOperation(operation: CollaborationOperation): void;
+	reset(): void;
 }

package/dist/collaborationoperation.d.ts

@@ -1,23 +1,23 @@
 /**
- * @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 collaboration-core/collaborationoperation
- * @publicApi
- */
-import type { Operation, InsertOperation, MergeOperation, MoveOperation, SplitOperation, MarkerOperation, RootOperation, RootAttributeOperation } from '@ckeditor/ckeditor5-engine';
+* @module collaboration-core/collaborationoperation
+* @publicApi
+*/
+import type { Operation, InsertOperation, MergeOperation, MoveOperation, SplitOperation, MarkerOperation, RootOperation, RootAttributeOperation } from "@ckeditor/ckeditor5-engine";
 /**
- * Extends the {@link module:engine/model/operation/operation operation}.
- */
+* Extends the {@link module:engine/model/operation/operation operation}.
+*/
 export interface CollaborationOperation extends Operation {
-    _isInit?: boolean;
-    _authorId?: null | string;
-    _isDisconnection?: boolean;
-    createdAt?: Date;
-    wasUndone?: boolean;
-    affectsData?: Record<string, any>;
-    clone(): CollaborationOperation;
+	_isInit?: boolean;
+	_authorId?: null | string;
+	_isDisconnection?: boolean;
+	_aiSource?: string;
+	createdAt?: Date;
+	wasUndone?: boolean;
+	clone(): CollaborationOperation;
 }
 export type InsertCollaborationOperation = CollaborationOperation & InsertOperation;
 export type MoveCollaborationOperation = CollaborationOperation & MoveOperation;

package/dist/config.d.ts

@@ -1,150 +1,150 @@
 /**
- * @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 collaboration-core/config
- * @publicApi
- */
-import type { LocaleTranslate } from '@ckeditor/ckeditor5-utils';
+* @module collaboration-core/config
+* @publicApi
+*/
+import type { LocaleTranslate } from "@ckeditor/ckeditor5-utils";
 /**
- * The locale configuration.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		locale: {
- * 			// The localization configuration.
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- */
+* The locale configuration.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		locale: {
+* 			// The localization configuration.
+* 		}
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
+*/
 export interface LocaleConfig {
-    /**
-     * A function that formats date to the custom format. It is used in dates in annotations (balloons) displaying
-     * comments and suggestions details.
-     *
-     * The default formatting can be changed by setting a custom formatting function to `config.locale.dateTimeFormat`.
-     *
-     * ```ts
-     * import { DateTime } from 'luxon';
-     *
-     * ClassicEditor
-     * 	.create( {
-     * 		attachTo: document.querySelector( '#editor' ),
-     * 		toolbar: {
-     * 			items: [ 'bold', 'italic', '|', 'comment' ]
-     * 		},
-     * 		sidebar: {
-     * 			container: document.querySelector( '#sidebar' )
-     * 		},
-     * 		locale: {
-     * 			dateTimeFormat: date => DateTime.fromJSDate( date ).toFormat( 'dd/LL/yyyy' )
-     * 		}
-     * 	} )
-     * 	.catch( error => console.error( error ) );
-     * ```
-     *
-     * @returns The generated date.
-     */
-    dateTimeFormat?: (date: Date, t?: LocaleTranslate) => string;
+	/**
+	* A function that formats date to the custom format. It is used in dates in annotations (balloons) displaying
+	* comments and suggestions details.
+	*
+	* The default formatting can be changed by setting a custom formatting function to `config.locale.dateTimeFormat`.
+	*
+	* ```ts
+	* import { DateTime } from 'luxon';
+	*
+	* ClassicEditor
+	* 	.create( {
+	* 		attachTo: document.querySelector( '#editor' ),
+	* 		toolbar: {
+	* 			items: [ 'bold', 'italic', '|', 'comment' ]
+	* 		},
+	* 		sidebar: {
+	* 			container: document.querySelector( '#sidebar' )
+	* 		},
+	* 		locale: {
+	* 			dateTimeFormat: date => DateTime.fromJSDate( date ).toFormat( 'dd/LL/yyyy' )
+	* 		}
+	* 	} )
+	* 	.catch( error => console.error( error ) );
+	* ```
+	*
+	* @returns The generated date.
+	*/
+	dateTimeFormat?: (date: Date, t?: LocaleTranslate) => string;
 }
 /**
- * The configuration of the Users features.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		users: ... // Users configuration.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the Users features.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		users: ... // Users configuration.
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface CollaborationUsersConfig {
-    /**
-     * User ID value that will be used for the anonymous user.
-     */
-    anonymousUserId?: string;
-    /**
-     * Number of defined colors that are randomly assigned to users.
-     */
-    colorsCount?: number;
-    /**
-     * A callback function that customizes the way user initials are generated.
-     *
-     * If provided, this function will be called with the user's full name as the argument, and
-     * it should return a string representing the user's initials.
-     *
-     * Example usage:
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		users: {
-     * 			getInitialsCallback: ( name: string ) => {
-     *     			// Custom logic to generate initials.
-     *     			return name.split( ' ' )[ 0 ].charAt( 0 ) + name.split( ' ' )[ 1 ].charAt( 0 );
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     */
-    getInitialsCallback?: (name: string) => string;
+	/**
+	* User ID value that will be used for the anonymous user.
+	*/
+	anonymousUserId?: string;
+	/**
+	* Number of defined colors that are randomly assigned to users.
+	*/
+	colorsCount?: number;
+	/**
+	* A callback function that customizes the way user initials are generated.
+	*
+	* If provided, this function will be called with the user's full name as the argument, and
+	* it should return a string representing the user's initials.
+	*
+	* Example usage:
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		users: {
+	* 			getInitialsCallback: ( name: string ) => {
+	*     			// Custom logic to generate initials.
+	*     			return name.split( ' ' )[ 0 ].charAt( 0 ) + name.split( ' ' )[ 1 ].charAt( 0 );
+	* 			}
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*/
+	getInitialsCallback?: (name: string) => string;
 }
 /**
- * The configuration of the real-time collaboration features.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		collaboration: ... // Collaboration features configuration.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the real-time collaboration features.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		collaboration: ... // Collaboration features configuration.
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface RealTimeCollaborationConfig {
-    /**
-     * The channel ID is a unique ID that identifies the data loaded in the editor instance or used by
-     * the context instance.
-     *
-     * If specified for the editor, it is the document ID.
-     *
-     * If you are using multiple editors instances at the same time, each of them should use a different
-     * channel ID to connect to a specific document.
-     *
-     * If specified for context, it is the ID for all the data related to context instance.
-     * This ID will be used for data that is not related to an editor instance, for example comments
-     * outside the editor.
-     *
-     * In the case of context, the ID can be an ID of a subpage or a form, or a different entity accordingly
-     * to your application.
-     *
-     * The channel ID can be used to recognize entity to which piece of data belongs in integrations that use `Context`
-     * and context plugins. For example, if you are preparing a custom integration using the comments API,
-     * you can use the channel ID to recognize whether the comment was added to an editor instance
-     * (and which one) or to the context.
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		collaboration: {
-     * 			channelId: 'your-channel-id'
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     */
-    channelId?: string;
+	/**
+	* The channel ID is a unique ID that identifies the data loaded in the editor instance or used by
+	* the context instance.
+	*
+	* If specified for the editor, it is the document ID.
+	*
+	* If you are using multiple editors instances at the same time, each of them should use a different
+	* channel ID to connect to a specific document.
+	*
+	* If specified for context, it is the ID for all the data related to context instance.
+	* This ID will be used for data that is not related to an editor instance, for example comments
+	* outside the editor.
+	*
+	* In the case of context, the ID can be an ID of a subpage or a form, or a different entity accordingly
+	* to your application.
+	*
+	* The channel ID can be used to recognize entity to which piece of data belongs in integrations that use `Context`
+	* and context plugins. For example, if you are preparing a custom integration using the comments API,
+	* you can use the channel ID to recognize whether the comment was added to an editor instance
+	* (and which one) or to the context.
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		collaboration: {
+	* 			channelId: 'your-channel-id'
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*/
+	channelId?: string;
 }