@ckeditor/ckeditor5-comments 44.1.0 → 44.2.0-alpha.0

package/dist/comments/ui/view/commentview.d.ts

@@ -1,244 +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-licensing-options
- */
-/**
- * @module comments/comments/ui/view/commentview
- * @publicApi
- */
-import { type Locale } from 'ckeditor5/src/utils.js';
-import { ButtonView, type TemplateDefinition, type DropdownView, type FocusableView, type ViewCollection } from 'ckeditor5/src/ui.js';
-import { UserView } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import BaseCommentView from './basecommentview.js';
-import type { Comment } from '../../commentsrepository.js';
-import type CommentInputView from './commentinputview.js';
-import type { CommentViewConfig } from '../../../config.js';
-declare const CommentView_base: import("ckeditor5/src/utils.js").Mixed<typeof BaseCommentView, import("@ckeditor/ckeditor5-collaboration-core/src/utils/confirmmixin.js").ConfirmApi>;
-/**
- * The default view for comment.
- */
-export default class CommentView extends /* #__PURE__ -- @preserve */ CommentView_base {
-    locale: Locale;
-    isConfirm: boolean;
-    cancelConfirm: () => void;
-    showConfirm: (key: string, element: unknown) => Promise<void>;
-    /**
-     * A property used by the template.
-     *
-     * It works as a visual indicator for the user that an action is about to be performed.
-     * The value of this property is used in setting the CSS class.
-     * The property is used when the user interacts with the view.
-     *
-     * @observable
-     */
-    actionIndicator: string | null;
-    /**
-     * Comment editor placeholder value.
-     *
-     * @observable
-     */
-    placeholder: string;
-    /**
-     * Comment creation date.
-     *
-     * @observable
-     */
-    authoredAt: Date;
-    /**
-     * Comment resolved date.
-     *
-     * @observable
-     */
-    resolvedAt: Date | null;
-    /**
-     * Collection for UI elements that manage the comment.
-     *
-     * Elements that may be found in the action bar (depending on the comment view properties):
-     *
-     * * the resolve comment thread button (only if the comment is the first comment),
-     * * a dropdown with actions ({@link ~CommentView#dropdown `dropdown`}).
-     */
-    actionBar: ViewCollection<FocusableView>;
-    /**
-     * View collection which holds all the comments dropdown elements.
-     *
-     * May include, depending on the view properties:
-     *
-     * * {@link ~CommentView#editButton `editButton`},
-     * * {@link ~CommentView#removeButton `removeButton`}.
-     */
-    items: ViewCollection<ButtonView>;
-    /**
-     * Dropdown containing comment action buttons defined in {@link ~CommentView#items `items`}.
-     */
-    dropdown: DropdownView;
-    /**
-     * Edit button view. Edit button switches the comment to the editing mode.
-     */
-    editButton: ButtonView;
-    /**
-     * Remove button view. Remove button shows a confirmation box that fires the `removeComment` event when submitted.
-     */
-    removeButton: ButtonView;
-    /**
-     * User view for the comment. Presents the comment author.
-     */
-    userView: UserView;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, model: Comment, config: CommentViewConfig);
-    /**
-     * Returns a template definition that will be passed to {@link module:ui/view~View#setTemplate}.
-     *
-     * Overwrite this method if you want to set a custom template for the comment view.
-     *
-     * The default template looks as follows:
-     *
-     * ```ts
-     * const bind = this.bindTemplate;
-     *
-     * {
-     * 	tag: 'li',
-     *
-     * 	attributes: {
-     * 		class: [
-     * 			'ck-comment__wrapper',
-     * 			bind.if( 'isConfirm', 'ck-comment--remove-confirmation' )
-     * 		],
-     * 		tabindex: -1,
-     * 		'aria-label': bind.to( 'ariaLabel' ),
-     * 		'aria-describedby': this.ariaDescriptionView.id,
-     * 		role: 'listitem'
-     * 	},
-     *
-     * 	children: [
-     * 		{
-     * 			tag: 'div',
-     *
-     * 			attributes: {
-     * 				class: [
-     * 					'ck-comment',
-     * 					'ck-annotation',
-     * 					bind.if( 'isSystemComment', 'ck-comment--info' ),
-     * 					bind.if( 'isEditMode', 'ck-comment--edit' ),
-     * 					bind.to( 'actionIndicator', value => value ? `ck-comment--${ value }` : '' )
-     * 				],
-     * 				'data-author-id': this._model.author.id,
-     * 				'data-comment-id': this._model.id,
-     * 				role: 'group'
-     * 			},
-     *
-     * 			children: [
-     * 				this.userView,
-     * 				{
-     * 					tag: 'div',
-     *
-     * 					attributes: {
-     * 						class: [ 'ck-comment__main', 'ck-annotation__main' ]
-     * 					},
-     *
-     * 					children: [
-     * 						{
-     * 							tag: 'div',
-     *
-     * 							attributes: {
-     * 								class: [ 'ck-comment__info', 'ck-annotation__info' ]
-     * 							},
-     *
-     * 							children: [
-     * 								{
-     * 									tag: 'span',
-     *
-     * 									children: [
-     * 										{
-     * 											text: this.userView.name
-     * 										}
-     * 									],
-     *
-     * 									attributes: {
-     * 										class: [ 'ck-comment__info-name', 'ck-annotation__info-name' ]
-     * 									}
-     * 								},
-     * 								{
-     * 									tag: 'time',
-     *
-     * 									attributes: {
-     * 										datetime: bind.to( 'authoredAt' ),
-     * 										class: [ 'ck-comment__info-time', 'ck-annotation__info-time' ]
-     * 									},
-     *
-     * 									children: [
-     * 										{
-     * 											text: bind.to( 'authoredAt', value => this._config.formatDateTime( value ) )
-     * 										}
-     * 									]
-     * 								}
-     * 							]
-     * 						},
-     * 						{
-     * 							tag: 'div',
-     *
-     * 							attributes: {
-     * 								class: [
-     * 									'ck-comment__actions',
-     * 									'ck-annotation__actions',
-     * 									bind.if( 'isEditMode', 'ck-comment__actions--hidden' ),
-     * 									bind.if( 'isEditMode', 'ck-annotation__actions--hidden' )
-     * 								]
-     * 							},
-     *
-     * 							children: this.actionBar
-     * 						},
-     * 						{
-     * 							tag: 'div',
-     *
-     * 							attributes: {
-     * 								class: [ 'ck-annotation__content-wrapper' ]
-     * 							},
-     *
-     * 							children: this.visibleView
-     * 						},
-     * 						this.ariaDescriptionView,
-     * 						{
-     * 							tag: 'div',
-     *
-     * 							attributes: {
-     * 								class: [ 'ck-comment__external' ]
-     * 							},
-     *
-     * 							children: [ {
-     * 								text: this.getExternalCommentNote()
-     * 							} ]
-     * 						}
-     * 					]
-     * 				}
-     *
-     * 			]
-     * 		}
-     * 	]
-     * }
-     * ```
-     *
-     * @returns Definition of comment thread view's template.
-     */
-    getTemplate(): TemplateDefinition;
-    /**
-     * @inheritDoc
-     */
-    protected _createCommentInputView(): CommentInputView;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-}
-declare module 'ckeditor5/src/ui' {
-    interface DropdownView {
-        isVisible: boolean;
-    }
-}
-export {};

package/dist/comments.d.ts

@@ -1,47 +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-licensing-options
- */
-/**
- * @module comments/comments
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import CommentsRepository from './comments/commentsrepository.js';
-import CommentsEditing from './comments/commentsediting.js';
-import CommentsUI from './comments/commentsui.js';
-import CommentsOnly from './commentsonly.js';
-import WideSidebar from './annotations/widesidebar.js';
-import NarrowSidebar from './annotations/narrowsidebar.js';
-import InlineAnnotations from './annotations/inlineannotations.js';
-import CommentsArchiveUI from './comments/commentsarchiveui.js';
-import CommentsArchive from './comments/commentsarchive.js';
-/**
- * The comments plugin, which brings both the UI part and the editing part of this feature.
- *
- * It registers {@link module:comments/comments/addcommentthreadcommand~AddCommentThreadCommand the `AddCommentThreadCommand` command}.
- *
- * To learn more about the comments feature refer to the {@glink features/collaboration/comments/comments Comments} guide.
- */
-export default class Comments extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsRepository, typeof CommentsEditing, typeof CommentsUI, typeof CommentsArchive, typeof CommentsArchiveUI, typeof CommentsOnly, typeof WideSidebar, typeof NarrowSidebar, typeof InlineAnnotations];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Comments";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-}

package/dist/commentsonly.d.ts

@@ -1,45 +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-licensing-options
- */
-/**
- * @module comments/commentsonly
- * @publicApi
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import CommentsEditing from './comments/commentsediting.js';
-/**
- * The `CommentsOnly` plugin allows you to put the editor in a mode where a user can only add, edit or delete comments.
- *
- * Check the {@glink features/collaboration/comments/comments-only-mode Comments-only mode} guide to learn how to use this plugin.
- */
-export default class CommentsOnly extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CommentsOnly";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsEditing];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

package/dist/config.d.ts

@@ -1,199 +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-licensing-options
- */
-/**
- * @module comments/config
- * @publicApi
- */
-import type { EditorConfig, PartialBy } from 'ckeditor5/src/core.js';
-import type CommentView from './comments/ui/view/commentview.js';
-import type BaseCommentThreadView from './comments/ui/view/basecommentthreadview.js';
-/**
- * The configuration of the comments feature.
- *
- * ```ts
- * ClassicEditor.create( {
- * 	comments: ... // Comments feature configuration.
- * } )
- * .then( ... )
- * .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface CommentsConfig {
-    /**
-     * Specifies whether comment markers should be preserved on copy-paste and cut-and-paste actions.
-     *
-     * The following values are available:
-     *
-     * * `'default'` - the comments will be preserved on cut-paste and drag and drop actions only.
-     * * `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
-     * * `'never'` - the markers will be ignored by clipboard.
-     *
-     * Defaults to `'default'`.
-     */
-    copyMarkers?: CommentsClipboardCopyConfig;
-    /**
-     * The total number of comments shown when the thread view is collapsed.
-     *
-     * The comments are displayed in the following way:
-     *
-     * * The first comment is displayed.
-     * * Some comments may be hidden (collapsed).
-     * * An appropriate number of the most recent comments is displayed.
-     *
-     * For example, if this parameter is set to 3, when collapsed,
-     * the thread view will display the first comment and two most recent comments.
-     *
-     * Defaults to `2`.
-     */
-    maxCommentsWhenCollapsed?: number;
-    /**
-     * The maximum total weight of a thread before the thread becomes collapsed when it is not active:
-     *
-     * * Thread weight is a sum of the weight of its comments.
-     * * Comment weight is equal to the comment length.
-     * * The minimal comment weight is 200.
-     *
-     * Defaults to `500`.
-     */
-    maxThreadTotalWeight?: number;
-    /**
-     * The maximum number of characters displayed in a comment when the thread view is collapsed.
-     * Longer comments will be trimmed.
-     *
-     * Defaults to `140`.
-     */
-    maxCommentCharsWhenCollapsed?: number;
-    /**
-     * A view class to be used to create comment views.
-     *
-     * {@link module:comments/comments/ui/view/commentview~CommentView} is used by default when this property is not set.
-     */
-    CommentView?: typeof CommentView;
-    /**
-     * A view class to be used to create comment thread views
-     * (used as annotations - in sidebar balloons or in inline annotations).
-     *
-     * {@link module:comments/comments/ui/view/commentthreadview~CommentThreadView} is used by default
-     *  when this property is not set.
-     */
-    CommentThreadView?: typeof BaseCommentThreadView;
-    /**
-     * Configuration for the comments editor.
-     *
-     * By using this property, you can customize the editor instance used in the comments
-     * reply field (e.g. by adding plugins or changing features configuration).
-     *
-     * To use the default configuration (allows only for text input, no formatting), you can pass `{}`
-     * to the comments editor configuration.
-     *
-     * ```ts
-     * ClassicEditor.create( element, {
-     * 	comments: {
-     * 		editorConfig: {}
-     * 	}
-     * } );
-     * ```
-     *
-     * To provide a better experience, you may add more plugins, that will extend the default editor configuration.
-     *
-     * ```ts
-     * import { Autoformat, List, Bold, Italic } from 'ckeditor5';
-     *
-     * ClassicEditor
-     * 	.create( {
-     * 		comments: {
-     * 			editorConfig: {
-     * 				extraPlugins: [ Autoformat, Bold, Italic, List ]
-     * 			}
-     * 		}
-     * 	} )
-     * ```
-     *
-     * Importing plugins may not be possible in some scenarios (e.g. when using a build created by the online builder tool).
-     * In that case, it is possible to get the plugin constructors from the editor builtin plugins.
-     *
-     * ```ts
-     * const extraCommentsPlugins = ClassicEditor.builtinPlugins.filter( plugin => {
-     * 	return [ 'Bold', 'Italic', Autoformat, List ].includes( plugin.pluginName );
-     * } );
-     *
-     *
-     * ClassicEditor
-     * 	.create( {
-     * 		comments: {
-     * 			editorConfig: {
-     * 				extraPlugins: extraCommentsPlugins
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     */
-    editorConfig?: EditorConfig;
-    /**
-     * A function that takes a `Date` object, formats it to a desired string and returns it.
-     * It should be used when displaying the comment creation date.
-     */
-    formatDateTime?: (date: Date) => string;
-}
-/**
- * The configuration of the sidebar feature.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		sidebar: {
- * 			// Sidebar feature configuration.
- * 		}
- * 	} )
- * .then( ... )
- * .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- */
-export interface SidebarConfig {
-    /**
-     * DOM element into which the sidebar will be inserted.
-     */
-    container?: HTMLElement;
-    /**
-     * Changes how the annotations are positioned inside the sidebar.
-     *
-     * If set to `true`, the top annotation in the sidebar will never be scrolled
-     * above the top edge of the sidebar (which would make it hidden).
-     *
-     * On the other hand, with this setting enabled, if there is not enough space,
-     * annotations will not be positioned exactly next to their linked elements
-     * when selected.
-     *
-     * @default false
-     */
-    preventScrollOutOfView?: boolean;
-}
-export type CommentThreadConfig = PartialBy<Required<Omit<CommentsConfig, 'CommentThreadView'>>, 'copyMarkers'>;
-export type CommentViewConfig = Required<Pick<CommentsConfig, 'maxCommentCharsWhenCollapsed' | 'formatDateTime' | 'editorConfig'>> & {
-    /**
-     * Defines whether the comment is created by the system.
-     */
-    isSystemComment?: boolean;
-};
-/**
- * Specifies whether comment markers should be preserved on copy-paste and cut-paste actions.
- *
- * Following values are available:
- *
- * * `'default'` - the comments will be preserved on cut-paste and drag and drop actions only.
- * * `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
- * * `'never'` - the markers will be ignored by clipboard.
- */
-export type CommentsClipboardCopyConfig = 'default' | 'always' | 'never';

package/dist/index.d.ts

@@ -1,33 +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-licensing-options
- */
-export { default as Comments } from './comments.js';
-export { default as CommentsOnly } from './commentsonly.js';
-export { default as CommentsUI } from './comments/commentsui.js';
-export { default as CommentsRepository, CommentThread, Comment, type CommentDataJSON, type CommentThreadContext, type CommentThreadDataJSON, type CommentsAdapter } from './comments/commentsrepository.js';
-export { default as CommentThreadController } from './comments/ui/commentthreadcontroller.js';
-export { default as Annotation, type AnnotationEscapeEvent } from './annotations/annotation.js';
-export { default as Annotations } from './annotations/annotations.js';
-export { default as AnnotationCollection } from './annotations/annotationcollection.js';
-export { default as AnnotationsUIs, type AnnotationUI } from './annotations/annotationsuis.js';
-export { default as EditorAnnotations } from './annotations/editorannotations.js';
-export { default as InlineAnnotations } from './annotations/inlineannotations.js';
-export { default as WideSidebar } from './annotations/widesidebar.js';
-export { default as NarrowSidebar } from './annotations/narrowsidebar.js';
-export { default as AnnotationView } from './annotations/view/annotationview.js';
-export { default as BaseCommentView } from './comments/ui/view/basecommentview.js';
-export { default as BaseCommentThreadView } from './comments/ui/view/basecommentthreadview.js';
-export { default as CommentsListView } from './comments/ui/view/commentslistview.js';
-export { default as CommentView } from './comments/ui/view/commentview.js';
-export { default as CommentThreadView } from './comments/ui/view/commentthreadview.js';
-export { default as CommentThreadInputView } from './comments/ui/view/commentthreadinputview.js';
-export { default as CommentsArchive } from './comments/commentsarchive.js';
-export { default as CommentsArchiveUI } from './comments/commentsarchiveui.js';
-export type { CommentsConfig, SidebarConfig, CommentsClipboardCopyConfig, CommentThreadConfig } from './config.js';
-export type { default as CommentsEditing } from './comments/commentsediting.js';
-import './augmentation.js';

package/dist/utils/common-translations.d.ts

@@ -1,13 +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-licensing-options
- */
-/**
- * @module comments/utils/common-translations
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string, values?: string | Array<string | number> | number): string;

package/dist/utils/createmutationobserver.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-licensing-options
- */
-/**
- * Creates mutation observer to observe changes that might cause height change.
- *
- * @param callback Callback executed after throttled mutations.
- */
-export default function createMutationObserver(callback: (...args: Array<any>) => unknown): MutationObserver;
-export interface MutationObserver {
-    attach: (element: Node) => void;
-    detach: () => void;
-}