@ckeditor/ckeditor5-track-changes 48.2.0 → 48.3.0-alpha.1

package/dist/ui/view/suggestionview.d.ts

@@ -1,190 +1,226 @@
 /**
- * @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 track-changes/ui/view/suggestionview
- * @publicApi
- */
-import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
-import { View, type TemplateDefinition, type FocusableView, ViewCollection, FocusCycler } from '@ckeditor/ckeditor5-ui';
-import { LateFocusButtonView, UserView } from '@ckeditor/ckeditor5-collaboration-core';
-import { type Suggestion } from '../../suggestion.js';
+* @module track-changes/ui/view/suggestionview
+* @publicApi
+*/
+import { FocusTracker, KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
+import { View, type TemplateDefinition, type FocusableView, ViewCollection, FocusCycler } from "@ckeditor/ckeditor5-ui";
+import { LateFocusButtonView, UserView } from "@ckeditor/ckeditor5-collaboration-core";
+import { type Suggestion } from "../../suggestion.js";
 /**
- * A view displaying a detailed information about the suggestion as well as controls to accept or discard it.
- *
- * This view can be replaced by other view by overwriting the
- * {@link module:track-changes/trackchangesconfig~TrackChangesConfig#SuggestionView} configuration.
- */
+* A view displaying a detailed information about the suggestion as well as controls to accept or discard it.
+*
+* This view can be replaced by other view by overwriting the
+* {@link module:track-changes/trackchangesconfig~TrackChangesConfig#SuggestionView} configuration.
+*/
 export declare class SuggestionView extends View implements FocusableView {
-    /**
-     * 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: LateFocusButtonView;
-    /**
-     * A button view for the button that discards the suggestion.
-     */
-    discardButton: LateFocusButtonView;
-    /**
-     * A collection of focusable child views.
-     */
-    readonly focusables: ViewCollection<FocusableView>;
-    /**
-     * Tracks information about DOM focus in the suggestion.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over focusable views in the suggestion.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * Suggestion creation date.
-     *
-     * @observable
-     */
-    authoredAt: Date | null;
-    constructor(locale: Locale, model: Suggestion, config: SuggestionConfig);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * 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 view.
-     *
-     * The template looks as follows:
-     *
-     * ```ts
-     * const bind = this.bindTemplate;
-     * const suggestionContentElements = [
-     * 	{
-     * 		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' ]
-     * 		}
-     * 	}
-     * ];
-     *
-     * if ( this._model.isExternal ) {
-     * 	suggestionContentElements.push( {
-     * 		tag: 'div',
-     *
-     * 		attributes: {
-     * 			class: [ 'ck-comment__external' ]
-     * 		},
-     *
-     * 		children: [ {
-     * 			text: this.getExternalSuggestionNote()
-     * 		} ]
-     * 	} );
-     * }
-     *
-     * return {
-     * 	tag: 'div',
-     *
-     * 	attributes: {
-     * 		class: [
-     * 			'ck-suggestion',
-     * 			'ck-annotation'
-     * 		],
-     * 		tabindex: -1
-     * 	},
-     *
-     * 	children: [
-     * 		this.userView,
-     * 		{
-     * 			tag: 'div',
-     *
-     * 			attributes: {
-     * 				class: [ 'ck-suggestion__main', 'ck-annotation__main' ],
-     * 				role: 'presentation'
-     * 			},
-     *
-     * 			children: suggestionContentElements
-     * 		}
-     * 	]
-     * };
-     * ```
-     */
-    getTemplate(): TemplateDefinition;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-    /**
-     * Gets the translated notification text which indicates that the author name comes from an external source.
-     */
-    getUserViewNotificationText(): string | null;
-    /**
-     * Gets the translated note which indicates that the suggestion comes from an external source.
-     */
-    getExternalSuggestionNote(): string;
+	/**
+	* 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: LateFocusButtonView;
+	/**
+	* A button view for the button that discards the suggestion.
+	*/
+	discardButton: LateFocusButtonView;
+	/**
+	* A collection of focusable child views.
+	*/
+	readonly focusables: ViewCollection<FocusableView>;
+	/**
+	* Tracks information about DOM focus in the suggestion.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+	*/
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* Helps cycling over focusable views in the suggestion.
+	*/
+	readonly focusCycler: FocusCycler;
+	/**
+	* Suggestion creation date.
+	*
+	* @observable
+	*/
+	authoredAt: Date | null;
+	constructor(locale: Locale, model: Suggestion, config: SuggestionConfig);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* 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 view.
+	*
+	* The template looks as follows:
+	*
+	* ```ts
+	* const bind = this.bindTemplate;
+	* const suggestionContentElements = [
+	* 	{
+	* 		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' ]
+	* 		}
+	* 	}
+	* ];
+	*
+	* if ( this._model.isExternal ) {
+	* 	suggestionContentElements.push( {
+	* 		tag: 'div',
+	*
+	* 		attributes: {
+	* 			class: [ 'ck-comment__external' ]
+	* 		},
+	*
+	* 		children: [ {
+	* 			text: this.getExternalSuggestionNote()
+	* 		} ]
+	* 	} );
+	* }
+	*
+	* if ( this._model.aiSource && this._config.showAISource ) {
+	* 	const pillView = new PillView( this.locale );
+	*
+	* 	pillView.set( {
+	* 		icon: IconSparkle,
+	* 		label: getTranslation( this.locale, 'AI_SOURCE_PILL_LABEL' ),
+	* 		tooltip: getTranslation( this.locale, 'AI_SOURCE_PILL_TOOLTIP' ),
+	* 		class: 'ck-pill_ai'
+	* 	} );
+	*
+	* 	suggestionContentElements.push( {
+	* 		tag: 'div',
+	*
+	* 		attributes: {
+	* 			class: [ 'ck-suggestion__ai-source-pill' ]
+	* 		},
+	*
+	* 		children: [ pillView ]
+	* 	} );
+	* }
+	*
+	* return {
+	* 	tag: 'div',
+	*
+	* 	attributes: {
+	* 		class: [
+	* 			'ck-suggestion',
+	* 			'ck-annotation'
+	* 		],
+	* 		tabindex: -1
+	* 	},
+	*
+	* 	children: [
+	* 		this.userView,
+	* 		{
+	* 			tag: 'div',
+	*
+	* 			attributes: {
+	* 				class: [ 'ck-suggestion__main', 'ck-annotation__main' ],
+	* 				role: 'presentation'
+	* 			},
+	*
+	* 			children: suggestionContentElements
+	* 		}
+	* 	]
+	* };
+	* ```
+	*/
+	getTemplate(): TemplateDefinition;
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
+	/**
+	* Gets the translated notification text which indicates that the author name comes from an external source.
+	*/
+	getUserViewNotificationText(): string | null;
+	/**
+	* Gets the translated note which indicates that the suggestion comes from an external source.
+	*/
+	getExternalSuggestionNote(): string;
 }
 export interface SuggestionConfig {
-    formatDateTime: (date: Date | string) => string;
+	formatDateTime: (date: Date | string) => string;
+	/**
+	* How the AI source of an AI-authored suggestion should be surfaced in the view.
+	*
+	* See {@link module:track-changes/trackchangesconfig~TrackChangesConfig#showAISource}.
+	*/
+	showAISource: "pill" | "author" | null;
+	/**
+	* The view-only identity used to render AI-sourced suggestions when {@link #showAISource} is `'author'`.
+	*
+	* See {@link module:track-changes/trackchangesconfig~TrackChangesConfig#aiAuthor}.
+	*/
+	aiAuthor: {
+		name: string;
+		avatar?: string;
+	};
 }

package/dist/ui/view/trackchangespreviewview.d.ts

@@ -1,5 +1 @@
-/**
- * @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
- */
 export {};

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

@@ -1,9 +1,9 @@
 /**
- * @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 track-changes/utils/common-translations
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
+* @module track-changes/utils/common-translations
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
 export declare function getTranslation(locale: Locale, id: string, values?: number | string | ReadonlyArray<number | string>): string;

package/dist/utils/utils.d.ts

@@ -1,37 +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 track-changes/utils/utils
- */
-import type { Command } from '@ckeditor/ckeditor5-core';
-import type { ModelDocumentSelection, Model } from '@ckeditor/ckeditor5-engine';
-import { type Suggestion } from '../suggestion.js';
-import type { SuggestionDescription } from '../suggestiondescriptionfactory.js';
+* @module track-changes/utils/utils
+*/
+import type { Command } from "@ckeditor/ckeditor5-core";
+import type { ModelDocumentSelection, Model } from "@ckeditor/ckeditor5-engine";
+import { type Suggestion } from "../suggestion.js";
+import type { SuggestionDescription } from "../suggestiondescriptionfactory.js";
 /**
- * Used in tests for easy suggestion comparison.
- */
+* Used in tests for easy suggestion comparison.
+*/
 export declare function normalizeDescription(description: Array<SuggestionDescription> | SuggestionDescription): string;
 /**
- * Renders a rich HTML description out of primitive description string.
- */
+* Renders a rich HTML description out of primitive description string.
+*/
 export declare function renderDescription(description: string, color?: {
-    value: string;
-    title: string;
+	value: string;
+	title: string;
 }): string;
 export declare function sortSuggestions(suggestions: Array<Suggestion>): Array<Suggestion>;
 /**
- * From the list of passed `suggestions` returns those that are selected by given `selection`.
- */
+* From the list of passed `suggestions` returns those that are selected by given `selection`.
+*/
 export declare function getSelectedSuggestions(selection: ModelDocumentSelection, suggestions: Array<Suggestion>): Set<Suggestion>;
 /**
- * How many suggestion actions should be put into one batch when multiple suggestions are accepted or discarded.
- */
+* 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.
- */
+* 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-track-changes",
-  "version": "48.2.0",
+  "version": "48.3.0-alpha.1",
   "description": "CKEditor 5 track changes plugin.",
   "license": "SEE LICENSE IN LICENSE.md",
   "author": "CKSource (http://cksource.com/)",
@@ -36,30 +36,30 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@ckeditor/ckeditor5-clipboard": "48.2.0",
-    "@ckeditor/ckeditor5-code-block": "48.2.0",
-    "@ckeditor/ckeditor5-collaboration-core": "48.2.0",
-    "@ckeditor/ckeditor5-comments": "48.2.0",
-    "@ckeditor/ckeditor5-core": "48.2.0",
-    "@ckeditor/ckeditor5-editor-multi-root": "48.2.0",
-    "@ckeditor/ckeditor5-engine": "48.2.0",
-    "@ckeditor/ckeditor5-enter": "48.2.0",
-    "@ckeditor/ckeditor5-find-and-replace": "48.2.0",
-    "@ckeditor/ckeditor5-font": "48.2.0",
-    "@ckeditor/ckeditor5-heading": "48.2.0",
-    "@ckeditor/ckeditor5-highlight": "48.2.0",
-    "@ckeditor/ckeditor5-html-support": "48.2.0",
-    "@ckeditor/ckeditor5-icons": "48.2.0",
-    "@ckeditor/ckeditor5-image": "48.2.0",
-    "@ckeditor/ckeditor5-link": "48.2.0",
-    "@ckeditor/ckeditor5-list": "48.2.0",
-    "@ckeditor/ckeditor5-media-embed": "48.2.0",
-    "@ckeditor/ckeditor5-merge-fields": "48.2.0",
-    "@ckeditor/ckeditor5-restricted-editing": "48.2.0",
-    "@ckeditor/ckeditor5-table": "48.2.0",
-    "@ckeditor/ckeditor5-typing": "48.2.0",
-    "@ckeditor/ckeditor5-ui": "48.2.0",
-    "@ckeditor/ckeditor5-utils": "48.2.0",
+    "@ckeditor/ckeditor5-clipboard": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-code-block": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-collaboration-core": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-comments": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-core": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-editor-multi-root": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-engine": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-enter": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-find-and-replace": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-font": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-heading": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-highlight": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-html-support": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-icons": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-image": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-link": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-list": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-media-embed": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-merge-fields": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-restricted-editing": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-table": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-typing": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-ui": "48.3.0-alpha.1",
+    "@ckeditor/ckeditor5-utils": "48.3.0-alpha.1",
     "es-toolkit": "1.45.1"
   },
   "files": [