@ckeditor/ckeditor5-ai 48.8.1-alpha.3 → 49.0.0-alpha.0

package/dist/aireviewcore/ui/aireviewcorecustomcheckview.d.ts

@@ -1,61 +1,43 @@
 /**
- * @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 ai/aireviewcore/ui/aireviewcorecustomcheckview
- */
-import { type Locale, KeystrokeHandler, FocusTracker } from '@ckeditor/ckeditor5-utils';
-import { View, ButtonView, LabeledFieldView, FocusCycler } from '@ckeditor/ckeditor5-ui';
-import { AIReviewCorePromptInputView } from './aireviewcorepromptinputview.js';
+* @module ai/aireviewcore/ui/aireviewcorecustomcheckview
+*/
+import { KeystrokeHandler, FocusTracker } from "@ckeditor/ckeditor5-utils";
+import { View, ButtonView, LabeledFieldView, FocusCycler } from "@ckeditor/ckeditor5-ui";
+import { AIReviewCorePromptInputView } from "./aireviewcorepromptinputview.js";
 export declare class AIReviewCoreCustomCheckView extends View {
-    /**
-     * Tracks information about DOM focus in the form.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    readonly focusCycler: FocusCycler;
-    prompt: string;
-    modelId: string;
-    /**
-     * Determines the model display mode:
-     * * 'selector' – shows the dropdown,
-     * * 'name' – shows the model name,
-     * * 'hidden' – hides both.
-     *
-     * @observable
-     */
-    modelDisplayMode: 'selector' | 'name' | 'hidden';
-    /**
-     * The name of the currently active model.
-     *
-     * @observable
-     */
-    activeModelName: string | null;
-    submitButtonView: ButtonView;
-    cancelButtonView: ButtonView;
-    promptInputView: LabeledFieldView<AIReviewCorePromptInputView>;
-    actionsFooterView: View;
-    constructor(locale: Locale, check: AIReviewCoreCustomCheckView['_check'], hideModels?: boolean);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    get modelDefaultValue(): string;
-    get modelDefaultLabel(): string;
-    /**
-     * Resets the form to its default state.
-     */
-    resetToDefault(): void;
-    /**
-     * Resets the form validation status.
-     */
-    resetFormValidationStatus(): void;
+	/**
+	* Tracks information about DOM focus in the form.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+	*/
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* Helps cycling over {@link #_focusables} in the form.
+	*/
+	readonly focusCycler: FocusCycler;
+	prompt: string;
+	modelId: string;
+	submitButtonView: ButtonView;
+	cancelButtonView: ButtonView;
+	promptInputView: LabeledFieldView<AIReviewCorePromptInputView>;
+	actionsFooterView: View;
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* Resets the form to its default state.
+	*/
+	resetToDefault(): void;
+	/**
+	* Resets the form validation status.
+	*/
+	resetFormValidationStatus(): void;
 }
 export type CustomCheckFormValidatorCallback = () => string | undefined;

package/dist/aireviewcore/ui/aireviewcorefinishreviewbuttonview.d.ts

@@ -1,13 +1,12 @@
 /**
- * @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 ai/aireviewcore/ui/aireviewcorefinishreviewbuttonview
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { ButtonView } from '@ckeditor/ckeditor5-ui';
-import '../../../theme/aireviewcore/aireviewcore-review-completed.css';
+* @module ai/aireviewcore/ui/aireviewcorefinishreviewbuttonview
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { ButtonView } from "@ckeditor/ckeditor5-ui";
 export declare class AIReviewCoreFinishReviewButtonView extends ButtonView {
-    constructor(buttonLabel: string, locale?: Locale);
+	constructor(buttonLabel: string, locale?: Locale);
 }

package/dist/aireviewcore/ui/aireviewcoregeneralerrorview.d.ts

@@ -1,24 +1,24 @@
 /**
- * @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 ai/aireviewcore/ui/aireviewcoregeneralerrorview
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { View } from '@ckeditor/ckeditor5-ui';
+* @module ai/aireviewcore/ui/aireviewcoregeneralerrorview
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { View } from "@ckeditor/ckeditor5-ui";
 export declare class AIReviewCoreGeneralErrorView extends View {
-    /**
-     * Controls whether the view is visible.
-     *
-     * @observable
-     */
-    isVisible: boolean;
-    /**
-     * The error message to display.
-     *
-     * @observable
-     */
-    errorMessage: string;
-    constructor(locale: Locale);
+	/**
+	* Controls whether the view is visible.
+	*
+	* @observable
+	*/
+	isVisible: boolean;
+	/**
+	* The error message to display.
+	*
+	* @observable
+	*/
+	errorMessage: string;
+	constructor(locale: Locale);
 }

package/dist/aireviewcore/ui/aireviewcorenavigationpanelview.d.ts

@@ -0,0 +1,169 @@
+/**
+* @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 ai/aireviewcore/ui/aireviewcorenavigationpanelview
+*/
+import { type DomOptimalPositionOptions, type Locale } from "@ckeditor/ckeditor5-utils";
+import { BalloonPanelView, type BodyCollection } from "@ckeditor/ckeditor5-ui";
+import type { AIReviewCheckResultChange } from "../model/aireviewcheckresultchange.js";
+/**
+* Position of the selected change, as the panel counter displays it.
+*/
+export type AIReviewCoreNavigationPosition = {
+	/**
+	* One-based position among all the changes.
+	*/
+	index: number;
+	/**
+	* The number of all the changes. Same total the review progress bar counts against.
+	*/
+	total: number;
+	/**
+	* The number of changes left to review. Navigation only moves between those.
+	*/
+	pendingCount: number;
+};
+type ViewportOffset = DomOptimalPositionOptions["viewportOffsetConfig"];
+/**
+* Everything the panel needs to point itself at a change.
+*/
+export type AIReviewCoreNavigationPanelShowOptions = {
+	change: AIReviewCheckResultChange;
+	position: AIReviewCoreNavigationPosition;
+	isAcceptButtonVisible: boolean;
+	isSuggestButtonVisible: boolean;
+	getTarget: () => HTMLElement | null;
+	domEvent?: MouseEvent;
+	limiter?: HTMLElement;
+	viewportOffset?: ViewportOffset;
+};
+/**
+* The panel floating next to the selected change. Stays on screen for the whole review and carries the
+* navigation between changes, the diff toggle and the actions resolving the selected change.
+*/
+export declare class AIReviewCoreNavigationPanelView extends BalloonPanelView {
+	/**
+	* One-based position of the change on display among all the changes. Displayed in the counter.
+	*
+	* @observable
+	*/
+	changeIndex: number;
+	/**
+	* The number of all the changes, the reviewed ones included. Displayed in the counter.
+	*
+	* @observable
+	*/
+	changesCount: number;
+	/**
+	* Whether more than one change is left to review. Navigation only moves between the changes left to
+	* review, so with a single one left there is nowhere to go.
+	*
+	* @observable
+	*/
+	hasChangesToNavigate: boolean;
+	/**
+	* The counter text, built from {@link #changeIndex} and {@link #changesCount}.
+	*
+	* @observable
+	*/
+	counterLabel: string;
+	/**
+	* Whether the changes are displayed as a diff.
+	*
+	* @observable
+	*/
+	isDiffOn: boolean;
+	/**
+	* Whether at least one change has been reviewed. Pushed by the results view. The "Complete" dropdown
+	* labels its items against it.
+	*
+	* @observable
+	*/
+	isAnyResultReviewed: boolean;
+	/**
+	* Whether any change is still left to review. Pushed by the results view.
+	*
+	* @observable
+	*/
+	hasPendingChanges: boolean;
+	/**
+	* Whether the review check ended with an error. Pushed by the results view.
+	*
+	* @observable
+	*/
+	isError: boolean;
+	/**
+	* Whether the check is done streaming its changes. Pushed by the results view.
+	*
+	* @observable
+	*/
+	isResultReady: boolean;
+	/**
+	* The status of the change on display. Anything but `pending` replaces the actions with the state pill,
+	* as the change can no longer be resolved from here.
+	*
+	* @observable
+	*/
+	changeStatus: AIReviewCheckResultChange["status"];
+	constructor(locale: Locale, bodyCollection: BodyCollection);
+	/**
+	* The change on display, whether or not it is still the active one.
+	*/
+	get changeId(): string;
+	/**
+	* Points the panel at `change` without moving it.
+	*/
+	updateContent(options: AIReviewCoreNavigationPanelShowOptions): void;
+	/**
+	* Updates the counter only. Called as results stream in and as changes drop out of the review.
+	*/
+	updateChangePosition(position: AIReviewCoreNavigationPosition): void;
+	/**
+	* Follows the status of the change on display, which another user can resolve at any time.
+	*/
+	updateChangeState(id: string, status: AIReviewCheckResultChange["status"]): void;
+	/**
+	* Points the panel at `change` and pins it to the change's element in the content.
+	*/
+	showPanel(options: AIReviewCoreNavigationPanelShowOptions): void;
+	/**
+	* Takes the panel off screen and stops it from following the change it was pinned to.
+	*/
+	hidePanel(): void;
+	/**
+	* Whether the panel shows within the viewport. A panel whose change was scrolled out of view stays visible off screen so we need
+	* to check its rects.
+	*/
+	isInViewport(): boolean;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* A custom offset (in pixels) between the panel and the change it points at.
+	*/
+	static verticalOffset: number;
+}
+export type AIReviewCoreNavigateChangeEvent = {
+	name: "navigateChange";
+	args: [{
+		direction: "previous" | "next";
+	}];
+};
+export type AIToggleDiffEvent = {
+	name: "toggleDiff";
+	args: [{
+		/**
+		* Whether the diff should be shown.
+		*/
+		on: boolean;
+		/**
+		* The change the panel was pointing at when the diff was toggled. The diff covers the whole
+		* document for now, so no listener reads it yet; it is what a per-change toggle would need.
+		*/
+		changeId: string;
+	}];
+};
+export {};

package/dist/aireviewcore/ui/aireviewcoreprogressbarview.d.ts

@@ -0,0 +1,32 @@
+/**
+* @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 ai/aireviewcore/ui/aireviewcoreprogressbarview
+*/
+import { View } from "@ckeditor/ckeditor5-ui";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+/**
+* A progress bar displayed in the AI review results header. It shows how many changes have already been
+* reviewed out of the total, both as a textual label and as a filled track.
+*/
+export declare class AIReviewCoreProgressBarView extends View {
+	/**
+	* Controls whether the progress bar is shown.
+	*
+	* @observable
+	*/
+	isVisible: boolean;
+	/**
+	* The percentage of changes processed.
+	*
+	* @observable
+	*/
+	_percentageDone: number;
+	constructor(locale: Locale);
+	/**
+	* Updates the label and the filled track to reflect the passed counts.
+	*/
+	updateProgress(reviewed: number, total: number): void;
+}

package/dist/aireviewcore/ui/aireviewcorepromptinputview.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 ai/aireviewcore/ui/aireviewcorepromptinputview
- */
-import { TextareaView } from '@ckeditor/ckeditor5-ui';
-import { KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
+* @module ai/aireviewcore/ui/aireviewcorepromptinputview
+*/
+import { TextareaView } from "@ckeditor/ckeditor5-ui";
+import { KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
 export declare class AIReviewCorePromptInputView extends TextareaView {
-    /**
-     * An instance of the keystroke handler managing user interaction and accessibility.
-     *
-     * @readonly
-     */
-    keystrokes: KeystrokeHandler;
-    /**
-     * Flag indicating if the input is empty.
-     * @observable
-     */
-    isEmpty: boolean;
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
+	/**
+	* An instance of the keystroke handler managing user interaction and accessibility.
+	*
+	* @readonly
+	*/
+	keystrokes: KeystrokeHandler;
+	/**
+	* Flag indicating if the input is empty.
+	* @observable
+	*/
+	isEmpty: boolean;
+	constructor(locale: Locale);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
 }
 export type AIChatSendUserMessageEvent = {
-    name: 'sendUserMessage';
-    args: [query: string];
+	name: "sendUserMessage";
+	args: [query: string];
 };

package/dist/aireviewcore/ui/aireviewcorereviewchecklistview.d.ts

@@ -1,26 +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 ai/aireviewcore/ui/aireviewcorereviewchecklistview
- */
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-import { ListItemView } from '@ckeditor/ckeditor5-ui';
-import type { AIReviewCheck } from '../model/aireviewcheck.js';
-import '../../../theme/aireviewcore/aireviewcore-check-list.css';
-export declare class AIReviewCoreReviewCheckListView extends ListItemView {
-    constructor(locale: Locale);
-    /**
-     * Sets the checks to be displayed in the list.
-     */
-    setChecks(checks: Array<AIReviewCheck>, hideModels?: boolean): void;
-    /**
-     * Indicates whether there are any checks in the list.
-     */
-    hasChecks(): boolean;
-    /**
-     * Resets all parameterized checks to their default values.
-     */
-    resetAllParameterizedChecks(): void;
+* @module ai/aireviewcore/ui/aireviewcorereviewchecklistview
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
+import type { AIReviewCheck } from "../model/aireviewcheck.js";
+import { AIReviewCoreAbstractCheckListView } from "./aireviewcoreabstractchecklistview.js";
+import { AIReviewCoreReviewCommandListItemView } from "./aireviewcorereviewcommandlistitemview.js";
+/**
+* Splits review checks into two groups: non-parameterized checks (run immediately on click) and
+* parameterized checks (open a configuration panel before running).
+*/
+export declare class AIReviewCoreReviewCheckListView extends AIReviewCoreAbstractCheckListView {
+	constructor(locale: Locale);
+	/**
+	* @inheritDoc
+	*
+	* Non-parameterized checks render before parameterized ones (see `_setupTemplate()`), so the
+	* per-item index must follow that same visual order, not the original `checks` order. Otherwise
+	* the entrance-animation stagger delay (`--ck-ai-review-check-list-item-index`) falls out of sync
+	* with what's actually on screen.
+	*/
+	protected override _getVisualOrder(checks: ReadonlyArray<AIReviewCheck>): ReadonlyArray<AIReviewCheck>;
+	/**
+	* @inheritDoc
+	*/
+	protected override _clearCheckViews(): void;
+	/**
+	* @inheritDoc
+	*/
+	protected override _addCheckView(checkView: AIReviewCoreReviewCommandListItemView): void;
+	/**
+	* @inheritDoc
+	*/
+	protected override _onChecksSet(): void;
+	/**
+	* @inheritDoc
+	*
+	* Non-parameterized group first, then parameterized (this is render order, see `_setupTemplate()`).
+	*/
+	override getCheckViews(): Array<AIReviewCoreReviewCommandListItemView>;
 }

package/dist/aireviewcore/ui/aireviewcorereviewcommandlistitemview.d.ts

@@ -1,46 +1,56 @@
 /**
- * @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 ai/aireviewcore/ui/aireviewcorereviewcommandlistitemview
- */
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-import { ListItemView } from '@ckeditor/ckeditor5-ui';
-import type { AIReviewCheck } from '../model/aireviewcheck.js';
+* @module ai/aireviewcore/ui/aireviewcorereviewcommandlistitemview
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
+import { ListItemView } from "@ckeditor/ckeditor5-ui";
+import type { AIReviewCheck } from "../model/aireviewcheck.js";
 /**
- * A view representing an item in the list of tempaltes.
- *
- * @protected
- */
+* A view representing an item in the list of tempaltes.
+*
+* @protected
+*/
 export declare class AIReviewCoreReviewCommandListItemView extends ListItemView {
-    /**
-     * The loading state of the controls.
-     *
-     * @observable
-     */
-    isItemParametrized: boolean;
-    isParametrizedViewOpen: boolean;
-    isListItemRendered: boolean;
-    constructor(locale: Locale, check: AIReviewCheck, index: number, hideModels?: boolean);
-    render(): void;
-    /**
-     * Resets all form items in the parameterized view to their default values.
-     */
-    resetToDefault(): void;
+	/**
+	* The loading state of the controls.
+	*
+	* @observable
+	*/
+	isItemParametrized: boolean;
+	isParametrizedViewOpen: boolean;
+	isListItemRendered: boolean;
+	/**
+	* The check this view represents.
+	*/
+	readonly check: AIReviewCheck;
+	constructor(locale: Locale, check: AIReviewCheck, index: number, hideModels?: boolean);
+	/**
+	* @inheritDoc
+	*
+	* The template above replaces {@link module:ui/list/listitemview~ListItemView}'s own template
+	* (and, with it, its `children` collection) with markup of its own, so the base class's
+	* `focus()` -- which focuses `children.first` -- would find nothing to focus. Focus `#_headerView`
+	* instead -- the only part of the `<li>` that's an actual tab stop.
+	*/
+	override focus(): void;
+	/**
+	* Resets all form items in the parameterized view to their default values.
+	*/
+	resetToDefault(): void;
 }
 export type AIReviewCoreUIRunReviewCheckEvent = {
-    name: 'runReviewCheck';
-    args: [
-        {
-            id: string;
-            params?: Array<string>;
-            args?: {
-                language?: string;
-                model?: string;
-                prompt?: string;
-            };
-            isCustom?: boolean;
-        }
-    ];
+	name: "runReviewCheck";
+	args: [{
+		id: string;
+		params?: Array<string>;
+		args?: {
+			language?: string;
+			model?: string;
+			prompt?: string;
+		};
+		isCustom?: boolean;
+	}];
 };

package/dist/aireviewcore/ui/aireviewcorereviewcompletedview.d.ts

@@ -1,22 +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 ai/aireviewcore/ui/aireviewcorereviewcompletedview
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { ListItemView } from '@ckeditor/ckeditor5-ui';
-import '../../../theme/aireviewcore/aireviewcore-review-completed.css';
+* @module ai/aireviewcore/ui/aireviewcorereviewcompletedview
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { ListItemView } from "@ckeditor/ckeditor5-ui";
 export type AIReviewCoreReviewCompletedViewContents = {
-    headerText: string;
-    emptyResultsText: string;
-    buttonText: string;
+	headerText: string;
+	emptyResultsText: string;
+	buttonText: string;
 };
 export declare class AIReviewCoreReviewCompletedView extends ListItemView {
-    constructor(locale: Locale, contents: AIReviewCoreReviewCompletedViewContents);
+	constructor(locale: Locale, contents: AIReviewCoreReviewCompletedViewContents);
 }
 export type AIReviewCoreFinishReviewEvent = {
-    name: 'finishReview';
-    args: [];
+	name: "finishReview";
+	args: [];
 };