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

package/dist/users.d.ts

@@ -1,186 +1,186 @@
 /**
- * @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/users
- * @publicApi
- */
-import { ContextPlugin, type Context, type Editor } from '@ckeditor/ckeditor5-core';
-import { Collection } from '@ckeditor/ckeditor5-utils';
-import { Permissions } from './permissions.js';
-import '../theme/usercolors.css';
+* @module collaboration-core/users
+* @publicApi
+*/
+import { ContextPlugin, type Context, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Collection } from "@ckeditor/ckeditor5-utils";
+import { Permissions } from "./permissions.js";
+import "../theme/usercolors.css";
 /**
- * The `Users` plugin provides the basic interface for setting and getting users involved in the document editing process.
- */
+* The `Users` plugin provides the basic interface for setting and getting users involved in the document editing process.
+*/
 export declare class Users extends ContextPlugin {
-    /**
-     * Holds all {@link module:collaboration-core/users~User users} added to the editor.
-     *
-     * Note, that the {@link module:collaboration-core/users~User#isAnonymous anonymous user} is always present in the editor.
-     * You may want to filter it out when processing the users lists.
-     *
-     * ```ts
-     * for ( const user of editor.plugins.get( 'Users' ).users ) {
-     *     if ( !user.isAnonymous ) {
-     *         console.log( user.name );
-     *     }
-     * }
-     * ```
-     *
-     * Use {@link #addUser} to add a new user.
-     */
-    readonly users: Collection<User>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Users";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Permissions];
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Context | Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * A reference to the local user or `null` if it has not been set.
-     */
-    get me(): User | null;
-    /**
-     * Adds a new user to the list of users.
-     */
-    addUser({ id, name, ...additionalData }: Partial<CollaborationUserData>): User;
-    /**
-     * Returns the user with a given ID.
-     */
-    getUser(id: string): User | null;
-    /**
-     * Sets an {@link module:collaboration-core/users~User#isAnonymous anonymous user} as {@link #me the local user}.
-     *
-     * The local user ID will be set to the value of `config.users.anonymousUserId` property. All actions performed by the local user
-     * will be contributed to the anonymous user.
-     */
-    useAnonymousUser(): void;
-    /**
-     * Sets the user with the given ID as the local user ({@link #me}).
-     *
-     * The local user can be only set once (this includes setting anonymous as the local user).
-     */
-    defineMe(userId: string): void;
-    /**
-     * Returns the author of the operation. It returns {@link #me} by default if it is not overwritten.
-     */
-    getOperationAuthor(): User | null;
+	/**
+	* Holds all {@link module:collaboration-core/users~User users} added to the editor.
+	*
+	* Note, that the {@link module:collaboration-core/users~User#isAnonymous anonymous user} is always present in the editor.
+	* You may want to filter it out when processing the users lists.
+	*
+	* ```ts
+	* for ( const user of editor.plugins.get( 'Users' ).users ) {
+	*     if ( !user.isAnonymous ) {
+	*         console.log( user.name );
+	*     }
+	* }
+	* ```
+	*
+	* Use {@link #addUser} to add a new user.
+	*/
+	readonly users: Collection<User>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Users";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Permissions]>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(context: Context | Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* A reference to the local user or `null` if it has not been set.
+	*/
+	get me(): User | null;
+	/**
+	* Adds a new user to the list of users.
+	*/
+	addUser({ id, name, ...additionalData }: Partial<CollaborationUserData>): User;
+	/**
+	* Returns the user with a given ID.
+	*/
+	getUser(id: string): User | null;
+	/**
+	* Sets an {@link module:collaboration-core/users~User#isAnonymous anonymous user} as {@link #me the local user}.
+	*
+	* The local user ID will be set to the value of `config.users.anonymousUserId` property. All actions performed by the local user
+	* will be contributed to the anonymous user.
+	*/
+	useAnonymousUser(): void;
+	/**
+	* Sets the user with the given ID as the local user ({@link #me}).
+	*
+	* The local user can be only set once (this includes setting anonymous as the local user).
+	*/
+	defineMe(userId: string): void;
+	/**
+	* Returns the author of the operation. It returns {@link #me} by default if it is not overwritten.
+	*/
+	getOperationAuthor(): User | null;
 }
 /**
- * The representation of a single user that is involved in document editing.
- */
+* The representation of a single user that is involved in document editing.
+*/
 export declare class User {
-    /**
-     * The ID of the user.
-     */
-    id: string;
-    /**
-     * CSS colors classes object for the user.
-     */
-    color: CollaborationUserColor;
-    /**
-     * The name of the user.
-     */
-    name: string;
-    /**
-     * The initials of the user.
-     *
-     * By default, the initials are composed of the user name's first and last words ignoring non-characters parts:
-     *
-     * * for `Joe Doe`, the initials are `JD`,
-     * * for `Joe Doe (admin)`, the initials are `JD`,
-     * * for `Anonymous` the initials are `A`,
-     * * for `Katie John-Newman` the initials are `KJ`,
-     * * for `Adam Daniel Smith` the initials are `AS`.
-     *
-     * The initials can be configured by
-     * {@link module:collaboration-core/config~CollaborationUsersConfig#getInitialsCallback `UserConfig#getInitialsCallback`}.
-     */
-    readonly initials: string;
-    /**
-     * The URL pointing to the image with the avatar of the user.
-     *
-     * If avatar is not set, default avatar is used.
-     */
-    avatar: string | undefined;
-    /**
-     * @param data User data.
-     * @param data.id The ID of the user.
-     * @param data.color A helper object to generate CSS classes with the user color in the UI.
-     * @param data.name The name of the user.
-     * @param data.avatar The URL to the user avatar.
-     * @param getInitialsCallback The custom callback configured via the editor configuration to calculate the initials.
-     */
-    constructor(data: CollaborationUserData, getInitialsCallback?: (name: string) => string);
-    /**
-     * Is `true` for the anonymous user, `false` otherwise.
-     *
-     * The anonymous user is used when there is no defined user for given resource.
-     *
-     * The situations when the anonymous user is used will depend on your application. For example, it can be used when the editor can be
-     * used by "guest" users of your application, or when the original user's account was removed.
-     */
-    get isAnonymous(): boolean;
-    /**
-     * Is `true` for the {@link module:collaboration-core/users~Users#me local user}.
-     */
-    get isMe(): boolean;
+	/**
+	* The ID of the user.
+	*/
+	id: string;
+	/**
+	* CSS colors classes object for the user.
+	*/
+	color: CollaborationUserColor;
+	/**
+	* The name of the user.
+	*/
+	name: string;
+	/**
+	* The initials of the user.
+	*
+	* By default, the initials are composed of the user name's first and last words ignoring non-characters parts:
+	*
+	* * for `Joe Doe`, the initials are `JD`,
+	* * for `Joe Doe (admin)`, the initials are `JD`,
+	* * for `Anonymous` the initials are `A`,
+	* * for `Katie John-Newman` the initials are `KJ`,
+	* * for `Adam Daniel Smith` the initials are `AS`.
+	*
+	* The initials can be configured by
+	* {@link module:collaboration-core/config~CollaborationUsersConfig#getInitialsCallback `UserConfig#getInitialsCallback`}.
+	*/
+	readonly initials: string;
+	/**
+	* The URL pointing to the image with the avatar of the user.
+	*
+	* If avatar is not set, default avatar is used.
+	*/
+	avatar: string | undefined;
+	/**
+	* @param data User data.
+	* @param data.id The ID of the user.
+	* @param data.color A helper object to generate CSS classes with the user color in the UI.
+	* @param data.name The name of the user.
+	* @param data.avatar The URL to the user avatar.
+	* @param getInitialsCallback The custom callback configured via the editor configuration to calculate the initials.
+	*/
+	constructor(data: CollaborationUserData, getInitialsCallback?: (name: string) => string);
+	/**
+	* Is `true` for the anonymous user, `false` otherwise.
+	*
+	* The anonymous user is used when there is no defined user for given resource.
+	*
+	* The situations when the anonymous user is used will depend on your application. For example, it can be used when the editor can be
+	* used by "guest" users of your application, or when the original user's account was removed.
+	*/
+	get isAnonymous(): boolean;
+	/**
+	* Is `true` for the {@link module:collaboration-core/users~Users#me local user}.
+	*/
+	get isMe(): boolean;
 }
 /**
- * The color object used to generate specified CSS classes with an individual color number assigned to the user.
- */
+* The color object used to generate specified CSS classes with an individual color number assigned to the user.
+*/
 export declare class CollaborationUserColor {
-    constructor(colorId: number);
-    /**
-     * Color's unique id. Used as a part of the generated class names.
-     *
-     * You can use this value to implement more color-related classes.
-     */
-    get id(): number;
-    /**
-     * Returns CSS class for user avatar background color.
-     */
-    getBackgroundColorClass(): string;
-    /**
-     * Returns CSS class for user selection highlight (the selected range).
-     */
-    getSelectionClass(): string;
-    /**
-     * Returns CSS class for user caret position element (the pipe).
-     */
-    getMarkerClass(): string;
-    /**
-     * Returns a CSS variable reference to the user's color.
-     */
-    getColorVariable(): string;
-    /**
-     * Returns a CSS variable reference to the user's transparent color.
-     */
-    getColorAlphaVariable(): string;
+	constructor(colorId: number);
+	/**
+	* Color's unique id. Used as a part of the generated class names.
+	*
+	* You can use this value to implement more color-related classes.
+	*/
+	get id(): number;
+	/**
+	* Returns CSS class for user avatar background color.
+	*/
+	getBackgroundColorClass(): string;
+	/**
+	* Returns CSS class for user selection highlight (the selected range).
+	*/
+	getSelectionClass(): string;
+	/**
+	* Returns CSS class for user caret position element (the pipe).
+	*/
+	getMarkerClass(): string;
+	/**
+	* Returns a CSS variable reference to the user's color.
+	*/
+	getColorVariable(): string;
+	/**
+	* Returns a CSS variable reference to the user's transparent color.
+	*/
+	getColorAlphaVariable(): string;
 }
 export type CollaborationUserData = {
-    id: string;
-    color: CollaborationUserColor;
-    name: string;
-    avatar?: string;
-    _isAnonymous?: boolean;
+	id: string;
+	color: CollaborationUserColor;
+	name: string;
+	avatar?: string;
+	_isAnonymous?: boolean;
 };

package/dist/utils/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 collaboration-core/utils/common-translations
- */
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module collaboration-core/utils/common-translations
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
 export declare function getTranslation(locale: Locale, id: string): string;

package/dist/utils/confirmmixin.d.ts

@@ -1,24 +1,34 @@
 /**
- * @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/utils/confirmmixin
- */
-import type { View } from '@ckeditor/ckeditor5-ui';
-import type { Locale, Mixed } from '@ckeditor/ckeditor5-utils';
+* @module collaboration-core/utils/confirmmixin
+*/
+import type { View } from "@ckeditor/ckeditor5-ui";
+import type { Constructor, Locale, Mixed } from "@ckeditor/ckeditor5-utils";
 /**
- * Adds interface for showing confirmation view in the specific for `CommentThreadView` and `CommentView` structure
- * Confirm is always set to the `content` collection at the last position.
- */
-export declare function ConfirmMixin<Base extends new (...args: Array<any>) => View>(base: Base): Mixed<Base, ConfirmApi>;
+* Constructor returned by {@link ~ConfirmMixin}. Use it to name a mixin base class before extending it.
+*
+* ```ts
+* const MyConfirmBase: ConfirmMixinConstructor<typeof BaseClass> = ConfirmMixin( BaseClass );
+*
+* class MyConfirm extends MyConfirmBase {}
+* ```
+*/
+export type ConfirmMixinConstructor<Base extends Constructor<View>> = Mixed<Base, ConfirmApi>;
+/**
+* Adds interface for showing confirmation view in the specific for `CommentThreadView` and `CommentView` structure
+* Confirm is always set to the `content` collection at the last position.
+*/
+export declare function ConfirmMixin<Base extends Constructor<View>>(base: Base): ConfirmMixinConstructor<Base>;
 export interface ConfirmApi {
-    isConfirm: boolean;
-    locale: Locale;
-    showConfirm(message: string, element: Element): Promise<unknown>;
-    cancelConfirm(): void;
+	isConfirm: boolean;
+	locale: Locale;
+	showConfirm(message: string, element: Element): Promise<unknown>;
+	cancelConfirm(): void;
 }
 export type RemoveConfirmEvent = {
-    name: 'removeConfirm';
-    args: [];
+	name: "removeConfirm";
+	args: [];
 };

package/dist/utils/confirmview.d.ts

@@ -1,27 +1,27 @@
 /**
- * @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 { View, type FocusableView } from '@ckeditor/ckeditor5-ui';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import '../../theme/confirm.css';
+* @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 { View, type FocusableView } from "@ckeditor/ckeditor5-ui";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import "../../theme/confirm.css";
 export declare class ConfirmView extends View implements FocusableView {
-    message: string;
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
+	message: string;
+	constructor(locale: Locale);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
 }
 export type ConfirmViewCancelEvent = {
-    name: 'cancel';
-    args: [];
+	name: "cancel";
+	args: [];
 };
 export type ConfirmViewSubmitEvent = {
-    name: 'submit';
-    args: [];
+	name: "submit";
+	args: [];
 };

package/dist/utils/getdatetimeformatter.d.ts

@@ -1,35 +1,35 @@
 /**
- * @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/utils/getdatetimeformatter
- * @publicApi
- */
-import type { LocaleConfig } from '../config.js';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
+* @module collaboration-core/utils/getdatetimeformatter
+* @publicApi
+*/
+import type { LocaleConfig } from "../config.js";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
 /**
- * Returns a function that formats the date to the set format.
- *
- * 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 a function that formats the date to the set format.
+*
+* 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 ) );
+* ```
+*/
 export declare function getDateTimeFormatter(localeConfig?: LocaleConfig, locale?: Locale): (date: Date | string) => string;

package/dist/utils/getmarkerdomelement.d.ts

@@ -1,22 +1,22 @@
 /**
- * @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 { EditingController, Marker } from '@ckeditor/ckeditor5-engine';
+* @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 { EditingController, Marker } from "@ckeditor/ckeditor5-engine";
 /**
- * Returns a first DOM element mapped with the marker.
- *
- * @param editing Editing controller instance.
- * @param marker Marker instance.
- */
+* Returns a first DOM element mapped with the marker.
+*
+* @param editing Editing controller instance.
+* @param marker Marker instance.
+*/
 export declare function getMarkerDomElement(editing: EditingController, marker: Marker): HTMLElement | null;
 /**
- * Returns all DOM elements mapped with all given markers. DOM elements are sorted by their client rects in top-most, left-most order.
- * Returns `null` if `markers` is empty or there are no DOM elements bound with the markers.
- *
- * Note, that markers should not intersect.
- *
- * @param editing Editing controller instance.
- * @param markers Markers instances.
- */
+* Returns all DOM elements mapped with all given markers. DOM elements are sorted by their client rects in top-most, left-most order.
+* Returns `null` if `markers` is empty or there are no DOM elements bound with the markers.
+*
+* Note, that markers should not intersect.
+*
+* @param editing Editing controller instance.
+* @param markers Markers instances.
+*/
 export declare function getAllMarkersDomElementsSorted(editing: EditingController, markers: Array<Marker>): Array<HTMLElement> | null;

package/dist/utils/hashobject.d.ts

@@ -1,8 +1,8 @@
 /**
- * @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/utils/hashobject
- */
+* @module collaboration-core/utils/hashobject
+*/
 export declare function hashObject(obj: Record<string, unknown>): string;

package/dist/utils/sanitizeeditorconfig.d.ts

@@ -1,15 +1,15 @@
 /**
- * @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/utils/sanitizeeditorconfig
- */
-import type { Editor, EditorConfig } from '@ckeditor/ckeditor5-core';
+* @module collaboration-core/utils/sanitizeeditorconfig
+*/
+import type { Editor, EditorConfig } from "@ckeditor/ckeditor5-core";
 /**
- * A function that prepares config for internal editors removing all unnecessary plugins like RTC.
- *
- * @param editor The instance of the source editor.
- * @param extraBlackListedPlugins Additional list of plugins that should not be added to the config.
- */
+* A function that prepares config for internal editors removing all unnecessary plugins like RTC.
+*
+* @param editor The instance of the source editor.
+* @param extraBlackListedPlugins Additional list of plugins that should not be added to the config.
+*/
 export declare function sanitizeEditorConfig(editor: Editor, extraBlackListedPlugins?: Array<string>): EditorConfig;