@ckeditor/ckeditor5-comments 48.2.0 → 48.3.0-alpha.0

package/dist/augmentation.d.ts

@@ -1,59 +1,59 @@
 /**
- * @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 { CommentsConfig, AnnotationsSidebarConfig, Annotations, AnnotationsUIs, EditorAnnotations, InlineAnnotations, WideSidebar, NarrowSidebar, Comments, CommentsRepository, CommentsUI, CommentsOnly, CommentsArchive, CommentsArchiveUI } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the comments feature.
-         * Introduced by the {@link module:comments/comments~Comments} feature.
-         *
-         * Read more in {@link module:comments/config~CommentsConfig}.
-         *
-         * ```ts
-         * ClassicEditor
-         * 	.create( {
-         * 		comments: ... // Locale editor configuration.
-         * 	} )
-         * 	.then( ... )
-         * 	.catch( ... );
-         * ```
-         *
-         * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
-         */
-        comments?: CommentsConfig;
-        /**
-         * The configuration of the sidebar feature.
-         * Introduced by the {@link module:comments/annotations/sidebar~Sidebar} feature.
-         */
-        sidebar?: AnnotationsSidebarConfig;
-        /**
-         * Enables {@link module:comments/commentsonly~CommentsOnly comments-only mode} when the editor initializes.
-         *
-         * ```ts
-         * ClassicEditor
-         * 	.create( {
-         * 		commentsOnly: true
-         * 	} )
-         * 	.then( ... )
-         * 	.catch( ... );
-         * ```
-         */
-        commentsOnly?: boolean;
-    }
-    interface PluginsMap {
-        [Annotations.pluginName]: Annotations;
-        [AnnotationsUIs.pluginName]: AnnotationsUIs;
-        [EditorAnnotations.pluginName]: EditorAnnotations;
-        [InlineAnnotations.pluginName]: InlineAnnotations;
-        [WideSidebar.pluginName]: WideSidebar;
-        [NarrowSidebar.pluginName]: NarrowSidebar;
-        [Comments.pluginName]: Comments;
-        [CommentsRepository.pluginName]: CommentsRepository;
-        [CommentsUI.pluginName]: CommentsUI;
-        [CommentsOnly.pluginName]: CommentsOnly;
-        [CommentsArchive.pluginName]: CommentsArchive;
-        [CommentsArchiveUI.pluginName]: CommentsArchiveUI;
-    }
+* @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 { CommentsConfig, AnnotationsSidebarConfig, Annotations, AnnotationsUIs, EditorAnnotations, InlineAnnotations, WideSidebar, NarrowSidebar, Comments, CommentsRepository, CommentsUI, CommentsOnly, CommentsArchive, CommentsArchiveUI } from "./index.js";
+declare module "@ckeditor/ckeditor5-core" {
+	interface EditorConfig {
+		/**
+		* The configuration of the comments feature.
+		* Introduced by the {@link module:comments/comments~Comments} feature.
+		*
+		* Read more in {@link module:comments/config~CommentsConfig}.
+		*
+		* ```ts
+		* ClassicEditor
+		* 	.create( {
+		* 		comments: ... // Locale editor configuration.
+		* 	} )
+		* 	.then( ... )
+		* 	.catch( ... );
+		* ```
+		*
+		* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+		*/
+		comments?: CommentsConfig;
+		/**
+		* The configuration of the sidebar feature.
+		* Introduced by the {@link module:comments/annotations/sidebar~Sidebar} feature.
+		*/
+		sidebar?: AnnotationsSidebarConfig;
+		/**
+		* Enables {@link module:comments/commentsonly~CommentsOnly comments-only mode} when the editor initializes.
+		*
+		* ```ts
+		* ClassicEditor
+		* 	.create( {
+		* 		commentsOnly: true
+		* 	} )
+		* 	.then( ... )
+		* 	.catch( ... );
+		* ```
+		*/
+		commentsOnly?: boolean;
+	}
+	interface PluginsMap {
+		[Annotations.pluginName]: Annotations;
+		[AnnotationsUIs.pluginName]: AnnotationsUIs;
+		[EditorAnnotations.pluginName]: EditorAnnotations;
+		[InlineAnnotations.pluginName]: InlineAnnotations;
+		[WideSidebar.pluginName]: WideSidebar;
+		[NarrowSidebar.pluginName]: NarrowSidebar;
+		[Comments.pluginName]: Comments;
+		[CommentsRepository.pluginName]: CommentsRepository;
+		[CommentsUI.pluginName]: CommentsUI;
+		[CommentsOnly.pluginName]: CommentsOnly;
+		[CommentsArchive.pluginName]: CommentsArchive;
+		[CommentsArchiveUI.pluginName]: CommentsArchiveUI;
+	}
 }

package/dist/comments/addcommentthreadcommand.d.ts

@@ -1,74 +1,74 @@
 /**
- * @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 comments/comments/addcommentthreadcommand
- * @publicApi
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import type { ModelRange } from '@ckeditor/ckeditor5-engine';
+* @module comments/comments/addcommentthreadcommand
+* @publicApi
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import type { ModelRange } from "@ckeditor/ckeditor5-engine";
 /**
- * Adds a new comment marker, what also automatically adds a corresponding {@link module:comments/comments/commentsrepository~CommentThread}
- * in {@link module:comments/comments/commentsrepository~CommentsRepository}.
- *
- * By default, this command creates an empty comment thread on content selected in the editor.
- * The related marker is "local only", is not managed using operations, and it does not affect editor data.
- * The user is expected to write and submit the first comment. When first comment is submitted, the marker is changed to use operations,
- * which means that it is saved in data, and is propagated to other users in real-time-collaboration. This happens outside of this command.
- *
- * You can specify custom ranges by passing the `ranges` option to create the comment thread on specified content
- * instead of the current selection.
- *
- * You can provide content for the first comment using the `comment` option. Then, the created thread will contain this initial comment.
- * The thread will be automatically submitted, and the related marker will be propagated to other users and will affect editor data.
- *
- * Usage:
- * ```ts
- * // Create a draft comment thread on the current selection.
- * // If `threadId` is not specified, `addCommentThread()` will generate a unique ID and use it:
- * editor.execute( 'addCommentThread' );
- *
- * // Create a draft comment thread on custom ranges:
- * editor.execute( 'addCommentThread', { ranges: [ myRange1, myRange2 ] } );
- *
- * // Create a public comment thread with an initial comment:
- * editor.execute( 'addCommentThread', { comment: 'Initial comment text' } );
- * ```
- *
- * A comment thread can be added only on ranges that contain content. If the current document selection, or passed ranges
- * do not contain any content, the command will throw an error.
- *
- * You can use {@link #hasContent} observable property to check whether the current selection has any content.
- */
+* Adds a new comment marker, what also automatically adds a corresponding {@link module:comments/comments/commentsrepository~CommentThread}
+* in {@link module:comments/comments/commentsrepository~CommentsRepository}.
+*
+* By default, this command creates an empty comment thread on content selected in the editor.
+* The related marker is "local only", is not managed using operations, and it does not affect editor data.
+* The user is expected to write and submit the first comment. When first comment is submitted, the marker is changed to use operations,
+* which means that it is saved in data, and is propagated to other users in real-time-collaboration. This happens outside of this command.
+*
+* You can specify custom ranges by passing the `ranges` option to create the comment thread on specified content
+* instead of the current selection.
+*
+* You can provide content for the first comment using the `comment` option. Then, the created thread will contain this initial comment.
+* The thread will be automatically submitted, and the related marker will be propagated to other users and will affect editor data.
+*
+* Usage:
+* ```ts
+* // Create a draft comment thread on the current selection.
+* // If `threadId` is not specified, `addCommentThread()` will generate a unique ID and use it:
+* editor.execute( 'addCommentThread' );
+*
+* // Create a draft comment thread on custom ranges:
+* editor.execute( 'addCommentThread', { ranges: [ myRange1, myRange2 ] } );
+*
+* // Create a public comment thread with an initial comment:
+* editor.execute( 'addCommentThread', { comment: 'Initial comment text' } );
+* ```
+*
+* A comment thread can be added only on ranges that contain content. If the current document selection, or passed ranges
+* do not contain any content, the command will throw an error.
+*
+* You can use {@link #hasContent} observable property to check whether the current selection has any content.
+*/
 export declare class AddCommentThreadCommand extends Command {
-    /**
-     * Indicates whether the current selection contains content.
-     *
-     * @observable
-     */
-    hasContent: boolean;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command to add a new comment thread.
-     *
-     * @fires execute
-     * @param options Options for executed command.
-     * @param options.threadId Id of comment marker that will be added. If not provided, a unique id will be generated.
-     * @param options.ranges Array of ranges to use instead of current selection. If not provided,
-     * the current selection will be used.
-     * @param options.comment Initial comment text. If provided, the created comment thread will contain this comment as its first entry.
-     */
-    execute({ threadId, ranges, comment }?: {
-        threadId?: string;
-        ranges?: Array<ModelRange>;
-        comment?: string;
-    }): void;
+	/**
+	* Indicates whether the current selection contains content.
+	*
+	* @observable
+	*/
+	hasContent: boolean;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command to add a new comment thread.
+	*
+	* @fires execute
+	* @param options Options for executed command.
+	* @param options.threadId Id of comment marker that will be added. If not provided, a unique id will be generated.
+	* @param options.ranges Array of ranges to use instead of current selection. If not provided,
+	* the current selection will be used.
+	* @param options.comment Initial comment text. If provided, the created comment thread will contain this comment as its first entry.
+	*/
+	override execute({ threadId, ranges, comment }?: {
+		threadId?: string;
+		ranges?: Array<ModelRange>;
+		comment?: string;
+	}): void;
 }

package/dist/comments/commentsarchive.d.ts

@@ -1,39 +1,39 @@
 /**
- * @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 comments/comments/commentsarchive
- * @publicApi
- */
-import { ContextPlugin, type Context, type Editor } from '@ckeditor/ckeditor5-core';
-import { Collection } from '@ckeditor/ckeditor5-utils';
-import { CommentsRepository, type CommentThread } from './commentsrepository.js';
-import { Annotations } from '../annotations/annotations.js';
+* @module comments/comments/commentsarchive
+* @publicApi
+*/
+import { ContextPlugin, type Context, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Collection } from "@ckeditor/ckeditor5-utils";
+import { CommentsRepository, type CommentThread } from "./commentsrepository.js";
+import { Annotations } from "../annotations/annotations.js";
 /**
- * This plugin handles all operations on archived threads needed for the comments archive.
- */
+* This plugin handles all operations on archived threads needed for the comments archive.
+*/
 export declare class CommentsArchive extends ContextPlugin {
-    archivedThreads: Collection<CommentThread>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CommentsArchive";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsRepository, typeof Annotations];
-    constructor(context: Context | Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	archivedThreads: Collection<CommentThread>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "CommentsArchive";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[CommentsRepository, Annotations]>;
+	constructor(context: Context | Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/comments/commentsarchiveui.d.ts

@@ -1,53 +1,53 @@
 /**
- * @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 comments/comments/commentsarchiveui
- * @publicApi
- */
-import '../../theme/commentsarchive.css';
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { ViewCollection, Dialog } from '@ckeditor/ckeditor5-ui';
-import { CommentsArchiveView } from './ui/view/commentsarchiveview.js';
-import { CommentsArchive } from './commentsarchive.js';
-import { type AnnotationView } from '../annotations/view/annotationview.js';
+* @module comments/comments/commentsarchiveui
+* @publicApi
+*/
+import "../../theme/commentsarchive.css";
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ViewCollection, Dialog } from "@ckeditor/ckeditor5-ui";
+import { CommentsArchiveView } from "./ui/view/commentsarchiveview.js";
+import { CommentsArchive } from "./commentsarchive.js";
+import { type AnnotationView } from "../annotations/view/annotationview.js";
 /**
- * Creates comments archive {@link module:ui/dropdown/dropdownview~DropdownView ui dropdown} and binds with
- * archived comment thread annotation views.
- */
+* Creates comments archive {@link module:ui/dropdown/dropdownview~DropdownView ui dropdown} and binds with
+* archived comment thread annotation views.
+*/
 export declare class CommentsArchiveUI extends Plugin {
-    /**
-     * The view that is rendered in the dialog.
-     */
-    commentsArchiveView: CommentsArchiveView | undefined;
-    /**
-     * The view collection of {@link module:comments/annotations/view/annotationview~AnnotationView}
-     * that is displayed inside {@link #commentsArchiveView}.
-     */
-    annotationViews: ViewCollection<AnnotationView>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CommentsArchiveUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsArchive, typeof Dialog];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* The view that is rendered in the dialog.
+	*/
+	commentsArchiveView: CommentsArchiveView | undefined;
+	/**
+	* The view collection of {@link module:comments/annotations/view/annotationview~AnnotationView}
+	* that is displayed inside {@link #commentsArchiveView}.
+	*/
+	annotationViews: ViewCollection<AnnotationView>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "CommentsArchiveUI";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[CommentsArchive, Dialog]>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/comments/commentsediting.d.ts

@@ -1,95 +1,95 @@
 /**
- * @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 comments/comments/commentsediting
- * @publicApi
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import type { Marker } from '@ckeditor/ckeditor5-engine';
-import { CommentsRepository } from './commentsrepository.js';
-import { Users } from '@ckeditor/ckeditor5-collaboration-core';
-import { EditorAnnotations } from '../annotations/editorannotations.js';
-import { CommentsRestrictedEditingMode } from './integrations/commentsrestrictededitingmode.js';
-import { CommentsImportWord } from './integrations/importword.js';
-import { CommentsClipboard } from './integrations/clipboard.js';
-import { ShowCommentHighlights } from './integrations/showcommenthighlights.js';
-import '../../theme/commentmarker.css';
+* @module comments/comments/commentsediting
+* @publicApi
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import type { Marker } from "@ckeditor/ckeditor5-engine";
+import { CommentsRepository } from "./commentsrepository.js";
+import { Users } from "@ckeditor/ckeditor5-collaboration-core";
+import { EditorAnnotations } from "../annotations/editorannotations.js";
+import { CommentsRestrictedEditingMode } from "./integrations/commentsrestrictededitingmode.js";
+import { CommentsImportWord } from "./integrations/importword.js";
+import { CommentsClipboard } from "./integrations/clipboard.js";
+import { ShowCommentHighlights } from "./integrations/showcommenthighlights.js";
+import "../../theme/commentmarker.css";
 /**
- * Plugin that keeps in sync comments in {@link module:comments/comments/commentsrepository~CommentsRepository} with
- * {@link module:engine/model/markercollection~Marker comment markers}.
- */
+* Plugin that keeps in sync comments in {@link module:comments/comments/commentsrepository~CommentsRepository} with
+* {@link module:engine/model/markercollection~Marker comment markers}.
+*/
 export declare class CommentsEditing extends Plugin {
-    /**
-     * If set to `true`, the plugin won't load comment thread for the new marker immediately after the marker is added to the editor.
-     * Instead, the plugin will wait until the flag will be set to `false` and then load missing comments.
-     *
-     * It's useful to hold fetching comments from the server when comments are used with real-time collaboration.
-     * When a user connects to an existing document, the operations from the history need to be applied one by one.
-     * An operation which added a new comment marker might be followed by an operation which removes that marker, so it's not
-     * necessary to make an additional request then.
-     *
-     * @observable
-     */
-    isThreadsLoadingPaused: boolean;
-    /**
-     * Name of the active comment marker.
-     *
-     * Markers conversion checks if comment should be marked as active and adds/removes additional css class during the conversion.
-     *
-     * @observable
-     */
-    activeMarker: string | null;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsRepository, typeof EditorAnnotations, typeof Users, typeof CommentsRestrictedEditingMode, typeof CommentsImportWord, typeof CommentsClipboard, typeof ShowCommentHighlights];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CommentsEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Returns `true` if there is at least one marker in the content that is related to a comment thread with given `threadId`.
-     *
-     * @param threadId Comment thread id.
-     */
-    hasMarkerForId(threadId: string): boolean;
-    /**
-     * Returns all markers that are related to the comment thread with the given `threadId`.
-     *
-     * @param threadId Comment thread id.
-     * @returns Array with all markers related to given comment thread.
-     */
-    getAllMarkersForId(threadId: string): Array<Marker>;
-    /**
-     * Scrolls editing view to the first thread marker.
-     *
-     * @param threadId Comment thread id.
-     */
-    scrollToThreadMarker(threadId: string): void;
+	/**
+	* If set to `true`, the plugin won't load comment thread for the new marker immediately after the marker is added to the editor.
+	* Instead, the plugin will wait until the flag will be set to `false` and then load missing comments.
+	*
+	* It's useful to hold fetching comments from the server when comments are used with real-time collaboration.
+	* When a user connects to an existing document, the operations from the history need to be applied one by one.
+	* An operation which added a new comment marker might be followed by an operation which removes that marker, so it's not
+	* necessary to make an additional request then.
+	*
+	* @observable
+	*/
+	isThreadsLoadingPaused: boolean;
+	/**
+	* Name of the active comment marker.
+	*
+	* Markers conversion checks if comment should be marked as active and adds/removes additional css class during the conversion.
+	*
+	* @observable
+	*/
+	activeMarker: string | null;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[CommentsRepository, EditorAnnotations, Users, CommentsRestrictedEditingMode, CommentsImportWord, CommentsClipboard, ShowCommentHighlights]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "CommentsEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Returns `true` if there is at least one marker in the content that is related to a comment thread with given `threadId`.
+	*
+	* @param threadId Comment thread id.
+	*/
+	hasMarkerForId(threadId: string): boolean;
+	/**
+	* Returns all markers that are related to the comment thread with the given `threadId`.
+	*
+	* @param threadId Comment thread id.
+	* @returns Array with all markers related to given comment thread.
+	*/
+	getAllMarkersForId(threadId: string): Array<Marker>;
+	/**
+	* Scrolls editing view to the first thread marker.
+	*
+	* @param threadId Comment thread id.
+	*/
+	scrollToThreadMarker(threadId: string): void;
 }