@ckeditor/ckeditor5-track-changes 41.3.0-alpha.3 → 41.3.0

package/dist/types/trackchangesui.d.ts

@@ -1,42 +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 track-changes/trackchangesui
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { Users } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import TrackChangesEditing from './trackchangesediting.js';
-/**
- * Provides UI for track changes plugin.
- *
- * This plugin displays {@link module:track-changes/suggestion~Suggestion suggestions} as a
- * {@link module:comments/annotations/annotations~Annotations}.
- */
-export default class TrackChangesUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TrackChangesEditing, typeof Users, "CommentsRepository", "Annotations", "EditorAnnotations"];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TrackChangesUI";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}

package/dist/types/ui/suggestioncontroller.d.ts

@@ -1,41 +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 { Editor } from 'ckeditor5/src/core.js';
-import type Suggestion from '../suggestion.js';
-import type BaseSuggestionThreadView from './view/basesuggestionthreadview.js';
-import type { CommentThreadController } from '@ckeditor/ckeditor5-comments';
-declare const SuggestionController_base: {
-    new (): import("ckeditor5/src/utils.js").Observable;
-    prototype: import("ckeditor5/src/utils.js").Observable;
-};
-/**
- * A controller for a suggestion.
- *
- * It takes a suggestion thread view, listens to events fired by that view and based on them performs actions
- * on the provided suggestion model.
- */
-export default class SuggestionController extends SuggestionController_base {
-    model: Suggestion;
-    view: BaseSuggestionThreadView;
-    commentThreadController: CommentThreadController;
-    constructor(editor: Editor, model: Suggestion, view: BaseSuggestionThreadView, commentThreadController: CommentThreadController);
-    /**
-     * Accepts the suggestion that belongs to this controller.
-     */
-    acceptSuggestion(): void;
-    /**
-     * Discards the suggestion that belongs to this controller.
-     */
-    discardSuggestion(): void;
-    /**
-     * Destroys `SuggestionController` instance.
-     */
-    destroy(): void;
-}
-export {};

package/dist/types/ui/view/basesuggestionthreadview.d.ts

@@ -1,174 +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 track-changes/ui/view/basesuggestionthreadview
- * @publicApi
- */
-import { View } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import type { EditorConfig } from 'ckeditor5/src/core.js';
-import type Suggestion from '../../suggestion.js';
-import type { CommentsListView, CommentThreadInputView, CommentView } from '@ckeditor/ckeditor5-comments';
-import type { User } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import type { Description } from '../../suggestiondescriptionfactory.js';
-/**
- * An abstract suggestion thread view class that should be used as a base for suggestion thread view implementations.
- * It provides some behaviors, flags and building blocks to use when creating a custom suggestion thread view class.
- *
- * All events fired by {@link module:comments/comments/ui/view/basecommentview~BaseCommentView}
- * are delegated to {@link module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView}.
- * This means that {@link module:track-changes/ui/view/basesuggestionthreadview~BaseSuggestionThreadView} can also fire these
- * events to communicate with CKEditor 5 collaboration features.
- *
- * For the usage examples check the {@glink features/collaboration/annotations/annotations-custom-view
- * Annotations custom view} guide.
- */
-export default abstract class BaseSuggestionThreadView extends View {
-    /**
-     * The list of comment views. It should be used as a part of the view template when present.
-     */
-    commentsListView: CommentsListView | null;
-    /**
-     * The comment input area view. It should be used as a part of the view template when present.
-     */
-    commentThreadInputView: CommentThreadInputView | null;
-    /**
-     * A boolean value that informs if the comment thread view is in the active state ("highlighted").
-     * A comment thread view is in this state when it is focused or was activated by the user in any different way.
-     *
-     * @observable
-     */
-    isActive: boolean;
-    /**
-     * Suggestion creation date.
-     *
-     * @observable
-     */
-    authoredAt: Date | null;
-    /**
-     * Flag that indicates whether suggestion acceptation is possible.
-     *
-     * @observable
-     */
-    canAccept: boolean;
-    /**
-     * Flag that indicates whether suggestion discarding is possible.
-     *
-     * @observable
-     */
-    canDiscard: boolean;
-    /**
-     * Stores description entries generated for this suggestion that describe what is the suggested change.
-     * They are used to create the final description presented in the suggestion view to the user.
-     *
-     * Note that one suggestion may include multiple changes.
-     *
-     * Most cases are simple and include just one description item:
-     *
-     *  ```ts
-     * [
-     *		{ type: 'insertion', content: '*Insert:* "Foo"' }
-     * ]
-     *	```
-     *
-     * This description item represents a suggestion for inserting the "Foo" text. The `type` property describes the performed action
-     * while the `content` property contains additional information about the action and is optional.
-     *
-     * A more complex example is presented below:
-     *
-     * ```ts
-     * [
-     *		{ type: 'insertion', content: '*Insert:* 2 paragraphs' },
-     *		{ type: 'insertion', content: '*Insert:* image' },
-     *		{ type: 'replace', content: '*Replace:* "Foo" *with* "Bar"' }
-     * ]
-     * ```
-     *
-     * In this example, there are three description instances (or lines). Two new (empty) paragraphs were added,
-     * an image was added and then "Foo" text was replaced by "Bar". The above structure could be rendered as:
-     *
-     *  ```html
-     *	<p><strong>Insert:</strong> 2 paragraphs</p>
-     *	<p><strong>Insert:</strong> image</p>
-     *	<p><strong>Replace:</strong> "Foo" <strong>with</strong> "Bar"</p>
-     *	```
-     *
-     * @observable
-     */
-    descriptionParts: Array<Description>;
-    /**
-     * Informs whether the suggestion thread has any changes that have not been saved.
-     *
-     * @observable
-     */
-    isDirty: boolean;
-    /**
-     * Informs whether the suggestion can be accepted or discarded.
-     *
-     * @observable
-     */
-    isEnabled: boolean;
-    /**
-     * The number of items in the view, where the suggestion itself counts as one.
-     *
-     * In other words, it is equal to the number of comments in the suggestion thread view plus one.
-     *
-     * @observable
-     */
-    readonly length: number;
-    constructor(locale: Locale, model: Suggestion, localUser: User, config: SuggestionThreadConfig);
-    /**
-     * Focuses the view.
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}
-/**
- * Fired when a user performed an action that should lead to accepting the suggestion.
- *
- * This event is not fired by default by any component created by `BaseSuggestionThreadView`.
- * If you create a view class extending `BaseSuggestionCommentView`, you should provide
- * a UI element that will fire this event.
- *
- * @eventName ~BaseSuggestionThreadView#acceptSuggestion
- */
-export type AcceptSuggestionEvent = {
-    name: 'acceptSuggestion';
-    args: [];
-};
-/**
- * Fired when a user performed an action that should lead to discarding the suggestion.
- *
- * This event is not fired by default by any component created by `BaseSuggestionThreadView`.
- * If you create a view class extending `BaseSuggestionCommentView`, you should provide
- * a UI element that will fire this event.
- *
- * @eventName ~BaseSuggestionThreadView#discardSuggestion
- */
-export type DiscardSuggestionEvent = {
-    name: 'discardSuggestion';
-    args: [];
-};
-/**
- * Config used for suggestion thread views.
- */
-export interface SuggestionThreadConfig {
-    disableComments: boolean;
-    editorConfig: EditorConfig;
-    maxCommentsWhenCollapsed: number;
-    maxThreadTotalWeight: number;
-    maxCommentCharsWhenCollapsed: number;
-    formatDateTime: (date: Date | string) => string;
-    CommentView: typeof CommentView;
-    CommentsListView: typeof CommentsListView;
-    CommentThreadInputView: typeof CommentThreadInputView;
-}

package/dist/types/ui/view/suggestionthreadview.d.ts

@@ -1,186 +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 { default as BaseSuggestionThreadView, type SuggestionThreadConfig } from './basesuggestionthreadview.js';
-import { ButtonView, type TemplateDefinition } from 'ckeditor5/src/ui.js';
-import { UserView, type User } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import type Suggestion from '../../suggestion.js';
-/**
- * The default view for a suggestion thread.
- *
- * This view can be replaced by other view by overwriting the
- * {@link module:track-changes/trackchangesconfig~TrackChangesConfig#SuggestionThreadView} configuration.
- */
-export default class SuggestionThreadView extends BaseSuggestionThreadView {
-    /**
-     * The suggestion thread view type.
-     *
-     * This value is not equal to the suggestion (model) type. It is evaluated based on the type of the first suggestion for
-     * the suggestion thread view template purposes.
-     *
-     * @observable
-     */
-    type: 'format' | 'replace' | 'deletion' | 'insertion' | '';
-    /**
-     * A suggestion description explaining what has been changed. To be presented to the user.
-     *
-     * @observable
-     */
-    description: string;
-    /**
-     * A user view for the suggestion author.
-     */
-    userView: UserView;
-    /**
-     * A button view for the button that accepts the suggestion.
-     */
-    acceptButton: ButtonView | null;
-    /**
-     * A button view for the button that discards the suggestion.
-     */
-    discardButton: ButtonView | null;
-    constructor(locale: Locale, model: Suggestion, localUser: User, config: SuggestionThreadConfig);
-    /**
-     * 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 suggestion thread view.
-     *
-     * The template looks as follows:
-     *
-     * ```ts
-     * {
-     *		tag: 'div',
-     *		attributes: {
-     *			class: [
-     *				'ck-suggestion-wrapper',
-     *				bind.if( 'isActive', 'ck-suggestion-wrapper--active' ),
-     *				bind.to( 'type', value => `ck-suggestion-${ value }` ),
-     *				this._config.disableComments && 'ck-suggestion--disabled-comments'
-     *			],
-     *			'data-suggestion-id': this._model.id,
-     *			'data-thread-id': this._model.commentThread.id,
-     *			'data-author-id': this._model.author.id,
-     *			// Needed for managing focus after adding a new comment.
-     *			tabindex: -1
-     *		},
-     *		children: [
-     *			{
-     *				tag: 'div',
-     *
-     *				attributes: {
-     *					class: [
-     *						'ck-suggestion',
-     *						'ck-annotation'
-     *					]
-     *				},
-     *
-     *				children: [
-     *					this.userView,
-     *					{
-     *						tag: 'div',
-     *
-     *						attributes: {
-     *							class: [ 'ck-suggestion__main', 'ck-annotation__main' ]
-     *						},
-     *
-     *						children: [
-     *							{
-     *								tag: 'div',
-     *
-     *								attributes: {
-     *									class: [ 'ck-suggestion__info', 'ck-annotation__info' ]
-     *								},
-     *
-     *								children: [
-     *									{
-     *										tag: 'span',
-     *
-     *										children: [
-     *											{
-     *												text: this.userView.name
-     *											}
-     *										],
-     *
-     *										attributes: {
-     *											class: [ 'ck-suggestion__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-suggestion__actions',
-     *										'ck-annotation__actions'
-     *									]
-     *								},
-     *
-     *								children: [
-     *									this.acceptButton,
-     *									this.discardButton
-     *								]
-     *							},
-     *							{
-     *								tag: 'div',
-     *
-     *								attributes: {
-     *									class: [ 'ck-annotation__content-wrapper' ]
-     *								}
-     *							},
-     *							{
-     *								tag: 'div',
-     *
-     *								attributes: {
-     *									class: [ 'ck-comment__external' ]
-     *								},
-     *
-     *								children: [ {
-     *									text: getTranslation( this.locale, 'EXTERNAL_SUGGESTION' )
-     * 								} ]
-     * 							}
-     *						]
-     *					}
-     *				]
-     *			},
-     *			this.commentsListView,
-     *			this.commentThreadInputView
-     *		]
-     * }
-     * ```
-     */
-    getTemplate(): TemplateDefinition;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Gets the translated note which indicates that the suggestion comes from an external source.
-     */
-    getExternalSuggestionNote(): string;
-    /**
-     * Gets the translated notification text which indicates that the author name comes from an external source.
-     */
-    getUserViewNotificationText(): string | null;
-}

package/dist/types/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-oss-license
- */
-/**
- * @module track-changes/utils/common-translations
- */
-import { type Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string, values?: number | string | ReadonlyArray<number | string>): string;

package/dist/types/utils/utils.d.ts

@@ -1,34 +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 track-changes/utils/utils
- */
-import type { Command } from 'ckeditor5/src/core.js';
-import type { DocumentSelection, Model } from 'ckeditor5/src/engine.js';
-import type Suggestion from '../suggestion.js';
-import type { Description } from '../suggestiondescriptionfactory.js';
-/**
- * Used in tests for easy suggestion comparison.
- */
-export declare function normalizeDescription(description: Array<Description> | Description): string;
-export declare function sortSuggestions(suggestions: Array<Suggestion>): Array<Suggestion>;
-/**
- * From the list of passed `suggestions` returns those that are selected by given `selection`.
- */
-export declare function getSelectedSuggestions(selection: DocumentSelection, suggestions: Array<Suggestion>): Set<Suggestion>;
-/**
- * How many suggestion actions should be put into one batch when multiple suggestions are accepted or discarded.
- */
-export declare const MAX_SUGGESTION_ACTIONS_IN_BATCH = 100;
-/**
- * Executes given `command` for given `suggestions`. If there is a lot of suggestions, the command executions is split into batches.
- * There is at most `MAX_SUGGESTION_ACTIONS_IN_BATCH` exeuctions in one batch. As a result, this limits number of actions to be done
- * in one undo step but may create multiple undo steps.
- */
-export declare function executeCommandForSuggestions(model: Model, command: Command, suggestions: Array<Suggestion>): void;