@ckeditor/ckeditor5-comments 41.3.0-alpha.3 → 41.3.0

package/dist/types/comments/commentsui.d.ts

@@ -1,37 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/commentsui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-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.
- */
-export default class CommentsUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CommentsUI";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsRepository, typeof CommentsEditing, typeof EditorAnnotations, typeof Annotations];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

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

@@ -1,30 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/integrations/clipboard
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { ClipboardPipeline, ClipboardMarkersUtils } from 'ckeditor5/src/clipboard.js';
-/**
- * Provides comments plugin integration for the clipboard feature.
- */
-export default class CommentsClipboard extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ClipboardMarkersUtils, typeof ClipboardPipeline];
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

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

@@ -1,21 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/integrations/commentsrestrictededitingmode
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * Provides comments plugin integration for restricted editing mode feature from restricted editing package.
- */
-export default class CommentsRestrictedEditingMode extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

package/dist/types/comments/integrations/importword.d.ts

@@ -1,25 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/integrations/importword
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-/**
- * Provides comments plugin integration for the import from Word feature.
- */
-export default class CommentsImportWord extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

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

@@ -1,40 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/ui/commenteditor/commenteditor
- */
-import { Editor, type EditorConfig } from 'ckeditor5/src/core.js';
-import CommentEditorUI from './commenteditorui.js';
-import { type PlaceholderableElement } from 'ckeditor5/src/engine.js';
-declare const CommentEditor_base: import("ckeditor5/src/utils.js").Mixed<typeof Editor, import("ckeditor5/src/utils.js").Observable>;
-export default class CommentEditor extends CommentEditor_base {
-    static defaultPlugins: EditorConfig['plugins'];
-    /**
-     * The input placeholder.
-     *
-     * @observable
-     */
-    placeholder: string;
-    placeholderElement: PlaceholderableElement | 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;
-}
-export {};

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

@@ -1,35 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/ui/commenteditor/commenteditorui
- */
-import { EditorUI } from 'ckeditor5/src/ui.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-import CommentEditorUIView from './commenteditoruiview.js';
-export default 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;
-}

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

@@ -1,40 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/ui/commenteditor/commenteditoruiview
- */
-import { InlineEditableUIView, EditorUIView, type ViewCollection } from 'ckeditor5/src/ui.js';
-import { type Locale } from 'ckeditor5/src/utils.js';
-import type { EditingView } from 'ckeditor5/src/engine.js';
-export default 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;
-}

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

@@ -1,68 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import type { CommentThread } from '../commentsrepository.js';
-import type { default as BaseCommentThreadView } from './view/basecommentthreadview.js';
-declare const CommentThreadController_base: {
-    new (): import("ckeditor5/src/utils.js").Observable;
-    prototype: import("ckeditor5/src/utils.js").Observable;
-};
-/**
- * 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 default class CommentThreadController extends 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;
-}
-export {};

package/dist/types/comments/ui/view/basecommentthreadview.d.ts

@@ -1,123 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/ui/view/basecommentthreadview
- * @publicApi
- */
-import { View } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import CommentThreadInputView from './commentthreadinputview.js';
-import CommentsListView from './commentslistview.js';
-import CommentThreadHeaderView from './commentthreadheaderview.js';
-import type { User } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import type { CommentThread } from '../../commentsrepository.js';
-import type { CommentThreadConfig } from '../../../config.js';
-/**
- * An abstract comment thread view class that should be used as a base for comment thread view implementations.
- * It provides some behaviors, flags and building blocks to use when creating a custom comment thread view class.
- *
- * For the usage examples check the {@glink features/collaboration/annotations/annotations-custom-view Custom annotation view} guide.
- */
-export default class BaseCommentThreadView extends View {
-    locale: Locale;
-    /**
-     * Informs whether the comment thread view is in active state ("highlighted").
-     * A comment thread view is in this state when it is focused or was activated by the user in any other way.
-     *
-     * @observable
-     */
-    isActive: boolean;
-    /**
-     * Informs whether the comment thread view is in unlinked state.
-     * A comment thread view is in this state when its corresponding target has been removed from the content.
-     *
-     * @observable
-     */
-    isUnlinked: boolean;
-    /**
-     * Informs whether the comment thread has any changes that have not been saved.
-     *
-     * @observable
-     */
-    isDirty: boolean;
-    /**
-     * The number of comments.
-     *
-     * @observable
-     */
-    readonly length: number;
-    /**
-     * The list of comment views. It should be used as a part of the view template.
-     *
-     * @readonly
-     */
-    readonly commentsListView: CommentsListView;
-    /**
-     * The comment thread header. It should be used as a part of the view template.
-     * This header is used only for resolved comment threads.
-     *
-     * @readonly
-     */
-    readonly commentThreadHeaderView: CommentThreadHeaderView;
-    /**
-     * The comment input area view. It should be used as a part of the view template.
-     *
-     * @readonly
-     */
-    readonly commentThreadInputView: CommentThreadInputView;
-    /**
-     * @param locale The localization service instance.
-     * @param model The model on which the view will base.
-     * @param localUser The current local user.
-     * @param config Additional view configuration.
-     */
-    constructor(locale: Locale, model: CommentThread, localUser: User, config: CommentThreadConfig);
-    /**
-     * Focuses the view.
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-}
-/**
- * Fired when a user created a first comment in the comment thread. Then the comment thread is submitted and saved.
- *
- * @eventName ~BaseCommentThreadView#submitCommentThread
- */
-export type UISubmitCommentThreadEvent = {
-    name: 'submitCommentThread';
-    args: [];
-};
-/**
- * Fired when a user performed an action that should lead to removing the comment thread.
- *
- * This event is not fired by default by any component created by `BaseCommentThreadView`.
- * If you create a view class extending `BaseCommentThreadView`, you should provide
- * a UI element that will fire this event.
- *
- * This event is fired by default when an empty comment thread view (with no comments)
- * loses focus.
- *
- * @eventName ~BaseCommentThreadView#removeCommentThread
- */
-export type UIRemoveCommentThreadEvent = {
-    name: 'removeCommentThread';
-    args: [];
-};
-/**
- * Fired when a user performed an action that should lead to resolve the comment thread.
- *
- * @eventName ~BaseCommentThreadView#resolveCommentThread
- */
-export type UIResolveCommentThreadEvent = {
-    name: 'resolveCommentThread';
-    args: [id: string];
-};

package/dist/types/comments/ui/view/basecommentview.d.ts

@@ -1,116 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/ui/view/basecommentview
- * @publicApi
- */
-import { View, type ViewCollection } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import type { Comment } from '../../commentsrepository.js';
-import type { CommentViewConfig } from '../../../config.js';
-/**
- * An abstract comment view class that should be used as a base for comment view implementations.
- *
- * It provides some behaviors, flags and building blocks to use when creating a custom comment view class.
- */
-export default class BaseCommentView extends View {
-    locale: Locale;
-    /**
-     * Informs whether the comment view is in the editing mode.
-     *
-     * @observable
-     */
-    isEditMode: boolean;
-    /**
-     * Flag indicating whether the comment view displays an actual comment (`false`) or is a system message (`true`).
-     * System message comment should not include any UI elements which allow for editing the comment as it is not an actual comment.
-     *
-     * @readonly
-     */
-    isSystemComment: boolean;
-    /**
-     * Stores the currently displayed sub-view.
-     *
-     * This is a collection that always includes one view: comment content view or comment input view.
-     * Depending whether the comment is in editing mode or not, one of the views is in the collection.
-     * When the comment mode changes, the content of this collection also changes.
-     *
-     * By default, the comment is in the "content mode" and this view collection stores the comment content view.
-     */
-    readonly visibleView: ViewCollection;
-    /**
-     * @param locale The localization service instance.
-     * @param model The model on which the view will base.
-     * @param config Additional view configuration.
-     */
-    constructor(locale: Locale, model: Comment, config: CommentViewConfig);
-    /**
-     * Expands the view.
-     */
-    expand(): void;
-    /**
-     * Collapses the view.
-     */
-    collapse(): void;
-    /**
-     * Focuses the view.
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-    /**
-     * Switches the comment to the editing mode.
-     */
-    switchToEditMode(): void;
-    /**
-     * Switches the comment back from the editing mode to the content display mode.
-     */
-    switchToDisplayMode(): void;
-}
-/**
- * Fired when a user performed an action that should lead to creating a new comment in the comment thread.
- *
- * This event is fired by default when the comment input field of the comment thread is submitted.
- *
- * @eventName ~BaseCommentView#addComment
- * @param content The content of the new comment.
- */
-export type UIAddCommentEvent = {
-    name: 'addComment';
-    args: [content: string];
-};
-/**
- * Fired when a user performed an action that should lead to updating the comment content.
- *
- * This event is fired by default when the comment input field of a comment is submitted.
- *
- * @param commentId The ID of the updated comment.
- * @param commentContent The updated comment content.
- * @eventName ~BaseCommentView#updateComment
- */
-export type UIUpdateCommentEvent = {
-    name: 'updateComment';
-    args: [commentId: string, commentContent: string];
-};
-/**
- * Fired when a user performed an action that should lead to removing a comment.
- *
- * This event is not fired by default by any component created by {@link module:comments/comments/ui/view/basecommentview~BaseCommentView}.
- * If you create a view class extending {@link module:comments/comments/ui/view/basecommentview~BaseCommentView} you should provide
- * a UI element that will fire this event.
- *
- * @param commentId The ID of the removed comment.
- * @eventName ~BaseCommentView#removeComment
- */
-export type UIRemoveCommentEvent = {
-    name: 'removeComment';
-    args: [commentId: string];
-};

package/dist/types/comments/ui/view/collapsedcommentsview.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/ui/view/collapsedcommentsview
- */
-import { View } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-export default class CollapsedCommentsView extends View {
-    count: number | undefined;
-    constructor(locale: Locale);
-}

package/dist/types/comments/ui/view/commentcontentview.d.ts

@@ -1,18 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/ui/view/commentcontentview
- */
-import { View } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-export default class CommentContentView extends View {
-    content: string;
-    constructor(locale: Locale);
-    render(): void;
-}

package/dist/types/comments/ui/view/commentinputview.d.ts

@@ -1,90 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/comments/ui/view/commentinputview
- */
-import { View, ButtonView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import { type EditorConfig, type DataApi } from 'ckeditor5/src/core.js';
-import CommentEditor from '../commenteditor/commenteditor.js';
-/**
- * A view for the comment input section that includes a comment editor.
- */
-export default class CommentInputView extends View {
-    /**
-     * Comment editor.
-     */
-    editor: CommentEditor & DataApi | null;
-    /**
-     * The input value (comment editor content).
-     *
-     * @observable
-     */
-    value: string;
-    /**
-     * When set to `true` it is not possible to submit the commit.
-     *
-     * @observable
-     */
-    disabledSubmit: boolean;
-    /**
-     * Specifies whether the buttons should be visible (`true`) or hidden (`false`).
-     *
-     * @observable
-     */
-    showButtons: boolean;
-    /**
-     * The comment editor placeholder.
-     *
-     * @observable
-     */
-    placeholder: string;
-    /**
-     * The submit button label.
-     *
-     * @observable
-     */
-    submitLabel: string;
-    element: HTMLElement;
-    /**
-     * Keystroke handler for the view.
-     */
-    keystrokes: KeystrokeHandler;
-    /**
-     * Focus tracker for the view.
-     */
-    focusTracker: FocusTracker;
-    /**
-     * Button view for the button which submits the comment.
-     */
-    submitButtonView: ButtonView;
-    /**
-     * Button view for the button which cancels comment input.
-     */
-    cancelButtonView: ButtonView;
-    constructor(locale: Locale, editorConfig?: EditorConfig);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Creates the comment editor instance.
-     *
-     * @returns Promise resolved after the editor instance is initialized.
-     */
-    createEditor(): Promise<CommentEditor | undefined>;
-    /**
-     * Focuses the view.
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-}