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

package/dist/comments/commentsui.d.ts

@@ -1,45 +1,45 @@
 /**
- * @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/commentsui
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { CommentsRepository } from './commentsrepository.js';
-import { CommentsEditing } from './commentsediting.js';
-import { EditorAnnotations } from '../annotations/editorannotations.js';
-import { Annotations } from '../annotations/annotations.js';
+* @module comments/comments/commentsui
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { CommentsRepository } from "./commentsrepository.js";
+import { CommentsEditing } from "./commentsediting.js";
+import { EditorAnnotations } from "../annotations/editorannotations.js";
+import { Annotations } from "../annotations/annotations.js";
 /**
- * Creates `comment` {@link module:ui/button/buttonview~ButtonView ui button} and binds with
- * {@link module:comments/comments/addcommentthreadcommand~AddCommentThreadCommand}.
- *
- * Because of CommentsRepository handles UI of CommentThreads responsibility of this plugin is limited to
- * adjusting comments UX for the editor purpose.
- */
+* Creates `comment` {@link module:ui/button/buttonview~ButtonView ui button} and binds with
+* {@link module:comments/comments/addcommentthreadcommand~AddCommentThreadCommand}.
+*
+* Because of CommentsRepository handles UI of CommentThreads responsibility of this plugin is limited to
+* adjusting comments UX for the editor purpose.
+*/
 export declare class CommentsUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CommentsUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsRepository, typeof CommentsEditing, typeof EditorAnnotations, typeof Annotations];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "CommentsUI";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[CommentsRepository, CommentsEditing, EditorAnnotations, Annotations]>;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
 }

package/dist/comments/integrations/clipboard.d.ts

@@ -1,26 +1,26 @@
 /**
- * @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/integrations/clipboard
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { ClipboardPipeline, ClipboardMarkersUtils } from '@ckeditor/ckeditor5-clipboard';
+* @module comments/comments/integrations/clipboard
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ClipboardPipeline, ClipboardMarkersUtils } from "@ckeditor/ckeditor5-clipboard";
 /**
- * Provides comments plugin integration for the clipboard feature.
- */
+* Provides comments plugin integration for the clipboard feature.
+*/
 export declare class CommentsClipboard extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ClipboardMarkersUtils, typeof ClipboardPipeline];
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ClipboardMarkersUtils, ClipboardPipeline]>;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
 }

package/dist/comments/integrations/commentsrestrictededitingmode.d.ts

@@ -1,17 +1,17 @@
 /**
- * @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/integrations/commentsrestrictededitingmode
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module comments/comments/integrations/commentsrestrictededitingmode
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * Provides comments plugin integration for restricted editing mode feature from restricted editing package.
- */
+* Provides comments plugin integration for restricted editing mode feature from restricted editing package.
+*/
 export declare class CommentsRestrictedEditingMode extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
 }

package/dist/comments/integrations/importword.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 comments/comments/integrations/importword
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
+* @module comments/comments/integrations/importword
+*/
+import { Plugin, type Editor } from "@ckeditor/ckeditor5-core";
 /**
- * Provides comments plugin integration for the import from Word feature.
- */
+* Provides comments plugin integration for the import from Word feature.
+*/
 export declare class CommentsImportWord extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
 }

package/dist/comments/integrations/showcommenthighlights.d.ts

@@ -1,19 +1,19 @@
 /**
- * @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/integrations/showcommenthighlights
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module comments/comments/integrations/showcommenthighlights
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * Provides integrations for getting editor data with `showCommentHightlights` option enabled for the features that need it.
- * Some of them are similar or duplicates from the `showSuggestionHighlights` option handling in the track changes feature.
- * Unfortunately, for now there's no single place where they could be shared and reused, so both plugins have to add them separately.
- */
+* Provides integrations for getting editor data with `showCommentHightlights` option enabled for the features that need it.
+* Some of them are similar or duplicates from the `showSuggestionHighlights` option handling in the track changes feature.
+* Unfortunately, for now there's no single place where they could be shared and reused, so both plugins have to add them separately.
+*/
 export declare class ShowCommentHighlights extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/comments/ui/commenteditor/commenteditor.d.ts

@@ -1,36 +1,37 @@
 /**
- * @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/ui/commenteditor/commenteditor
- */
-import { Editor, type EditorConfig } from '@ckeditor/ckeditor5-core';
-import { CommentEditorUI } from './commenteditorui.js';
-import { type PlaceholderableViewElement } from '@ckeditor/ckeditor5-engine';
-declare const CommentEditor_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof Editor, import("@ckeditor/ckeditor5-utils").Observable>;
-export declare class CommentEditor extends /* #__PURE__ -- @preserve */ CommentEditor_base {
-    static defaultPlugins: EditorConfig['plugins'];
-    /**
-     * The input placeholder.
-     *
-     * @observable
-     */
-    placeholder: string;
-    placeholderElement: PlaceholderableViewElement | undefined;
-    ui: CommentEditorUI;
-    /**
-     * @inheritDoc
-     */
-    constructor(config?: EditorConfig);
-    create(): Promise<unknown>;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-    /**
-     * Place the selection at the end of the editor data and focus the editable.
-     */
-    focus(): void;
+* @module comments/comments/ui/commenteditor/commenteditor
+*/
+import { Editor, type EditorConfig } from "@ckeditor/ckeditor5-core";
+import { CommentEditorUI } from "./commenteditorui.js";
+import { type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import { type PlaceholderableViewElement } from "@ckeditor/ckeditor5-engine";
+declare const CommentEditorBase: ObservableMixinConstructor<typeof Editor>;
+export declare class CommentEditor extends CommentEditorBase {
+	static defaultPlugins: EditorConfig["plugins"];
+	/**
+	* The input placeholder.
+	*
+	* @observable
+	*/
+	placeholder: string;
+	placeholderElement: PlaceholderableViewElement | undefined;
+	ui: CommentEditorUI;
+	/**
+	* @inheritDoc
+	*/
+	constructor(config?: EditorConfig);
+	create(): Promise<unknown>;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): Promise<void>;
+	/**
+	* Place the selection at the end of the editor data and focus the editable.
+	*/
+	override focus(): void;
 }
 export {};

package/dist/comments/ui/commenteditor/commenteditorui.d.ts

@@ -1,31 +1,31 @@
 /**
- * @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/ui/commenteditor/commenteditorui
- */
-import { EditorUI } from '@ckeditor/ckeditor5-ui';
-import type { Editor } from '@ckeditor/ckeditor5-core';
-import { CommentEditorUIView } from './commenteditoruiview.js';
+* @module comments/comments/ui/commenteditor/commenteditorui
+*/
+import { EditorUI } from "@ckeditor/ckeditor5-ui";
+import type { Editor } from "@ckeditor/ckeditor5-core";
+import { CommentEditorUIView } from "./commenteditoruiview.js";
 export declare class CommentEditorUI extends EditorUI {
-    /**
-     * The main (top–most) view of the editor UI.
-     */
-    readonly view: CommentEditorUIView;
-    /**
-     * Creates an instance of the classic editor UI class.
-     *
-     * @param editor The editor instance.
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    get element(): HTMLElement | null;
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
+	/**
+	* The main (top–most) view of the editor UI.
+	*/
+	readonly view: CommentEditorUIView;
+	/**
+	* Creates an instance of the classic editor UI class.
+	*
+	* @param editor The editor instance.
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	override get element(): HTMLElement | null;
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
 }

package/dist/comments/ui/commenteditor/commenteditoruiview.d.ts

@@ -1,36 +1,36 @@
 /**
- * @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/ui/commenteditor/commenteditoruiview
- */
-import { InlineEditableUIView, EditorUIView, type ViewCollection } from '@ckeditor/ckeditor5-ui';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import type { EditingView } from '@ckeditor/ckeditor5-engine';
+* @module comments/comments/ui/commenteditor/commenteditoruiview
+*/
+import { InlineEditableUIView, EditorUIView, type ViewCollection } from "@ckeditor/ckeditor5-ui";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import type { EditingView } from "@ckeditor/ckeditor5-engine";
 export declare class CommentEditorUIView extends EditorUIView {
-    /**
-     * Collection of the child views located in the main (`.ck-editor__main`)
-     * area of the UI.
-     */
-    readonly main: ViewCollection;
-    /**
-     * Editable UI view.
-     */
-    editable: InlineEditableUIView;
-    /**
-     * Creates an instance of the comments editor UI view.
-     *
-     * @param locale The locale instance.
-     * @param editingView The editing view instance this view is related to.
-     */
-    constructor(locale: Locale, editingView: EditingView);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Focusable interface required by a FocusCycler.
-     */
-    focus(): void;
+	/**
+	* Collection of the child views located in the main (`.ck-editor__main`)
+	* area of the UI.
+	*/
+	readonly main: ViewCollection;
+	/**
+	* Editable UI view.
+	*/
+	editable: InlineEditableUIView;
+	/**
+	* Creates an instance of the comments editor UI view.
+	*
+	* @param locale The locale instance.
+	* @param editingView The editing view instance this view is related to.
+	*/
+	constructor(locale: Locale, editingView: EditingView);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* Focusable interface required by a FocusCycler.
+	*/
+	focus(): void;
 }

package/dist/comments/ui/commentthreadcontroller.d.ts

@@ -1,64 +1,66 @@
 /**
- * @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 { CommentThread } from '../commentsrepository.js';
-import type { BaseCommentThreadView } from './view/basecommentthreadview.js';
-declare const CommentThreadController_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
+* @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
+*/
 /**
- * Controller for a comment thread.
- *
- * It takes a comment thread view, listens to events fired by that view and based on them performs actions on a comment thread model.
- */
-export declare class CommentThreadController extends /* #__PURE__ -- @preserve */ CommentThreadController_base {
-    model: CommentThread;
-    view: BaseCommentThreadView;
-    /**
-     * @param model Comment thread model.
-     * @param view Comment thread view.
-     */
-    constructor(model: CommentThread, view: BaseCommentThreadView);
-    /**
-     * Submits the comment thread.
-     */
-    submit(): void;
-    /**
-     * Removes the comment thread.
-     */
-    remove(): void;
-    /**
-     * Resolves the comment thread.
-     */
-    resolve(): void;
-    /**
-     * Reopens the comment thread.
-     */
-    reopen(): void;
-    /**
-     * Adds a comment to the comment thread.
-     *
-     * @param commentContent Comment content.
-     */
-    addComment(commentContent: string): void;
-    /**
-     * Updates a comment that belongs to the comment thread.
-     *
-     * @param commentId Id of the comment to update.
-     * @param commentContent Updated comment content.
-     */
-    updateComment(commentId: string, commentContent: string): void;
-    /**
-     * Removes a comment from the comment thread.
-     *
-     * @param commentId Id of the comment to remove.
-     */
-    removeComment(commentId: string): void;
-    /**
-     * Destroys `CommentThreadController` instance.
-     */
-    destroy(): void;
+* @module comments/comments/ui/commentthreadcontroller
+* @publicApi
+*/
+import { type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import type { CommentThread } from "../commentsrepository.js";
+import type { BaseCommentThreadView } from "./view/basecommentthreadview.js";
+declare const _CommentThreadControllerBase: ObservableMixinConstructor;
+/**
+* Controller for a comment thread.
+*
+* It takes a comment thread view, listens to events fired by that view and based on them performs actions on a comment thread model.
+*/
+export declare class CommentThreadController extends _CommentThreadControllerBase {
+	model: CommentThread;
+	view: BaseCommentThreadView;
+	/**
+	* @param model Comment thread model.
+	* @param view Comment thread view.
+	*/
+	constructor(model: CommentThread, view: BaseCommentThreadView);
+	/**
+	* Submits the comment thread.
+	*/
+	submit(): void;
+	/**
+	* Removes the comment thread.
+	*/
+	remove(): void;
+	/**
+	* Resolves the comment thread.
+	*/
+	resolve(): void;
+	/**
+	* Reopens the comment thread.
+	*/
+	reopen(): void;
+	/**
+	* Adds a comment to the comment thread.
+	*
+	* @param commentContent Comment content.
+	*/
+	addComment(commentContent: string): void;
+	/**
+	* Updates a comment that belongs to the comment thread.
+	*
+	* @param commentId Id of the comment to update.
+	* @param commentContent Updated comment content.
+	*/
+	updateComment(commentId: string, commentContent: string): void;
+	/**
+	* Removes a comment from the comment thread.
+	*
+	* @param commentId Id of the comment to remove.
+	*/
+	removeComment(commentId: string): void;
+	/**
+	* Destroys `CommentThreadController` instance.
+	*/
+	destroy(): void;
 }
 export {};