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

package/dist/aireviewcore/model/aireviewcheckrun.d.ts

@@ -1,163 +1,190 @@
 /**
- * @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
- */
-import { AIReviewCheckResult } from './aireviewcheckresult.js';
-import { AIReviewCheckResultChange } from './aireviewcheckresultchange.js';
-import { type AIReviewCheck } from './aireviewcheck.js';
-import { type AIReviewCoreChangeData, type AIDocumentData } from '../aireviewcoreediting.js';
-import { type AIConnector } from '../../aicore/aiconnector.js';
-import { type Editor } from '@ckeditor/ckeditor5-core';
-declare const AIReviewCheckRun_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
+* @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/model/aireviewcheckrun
+*/
+import { type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import { AIReviewCheckResult } from "./aireviewcheckresult.js";
+import { AIReviewCheckResultChange } from "./aireviewcheckresultchange.js";
+import { type AIReviewCheck } from "./aireviewcheck.js";
+import { type AIReviewCoreChangeData, type AIDocumentData } from "../aireviewcoreediting.js";
+import { type AIConnector } from "../../aicore/aiconnector.js";
+import { AIContext } from "../../aicore/model/aicontext.js";
+import { type Editor } from "@ckeditor/ckeditor5-core";
+declare const AIReviewCheckRunBase: ObservableMixinConstructor;
 /**
- * Represents a single review check run and its results.
- */
-export declare abstract class AIReviewCheckRun extends /* #__PURE__ */ AIReviewCheckRun_base {
-    /**
-     * The status of the check run.
-     */
-    status: AIReviewCheckRunStatus;
-    /**
-     * The check run ID.
-     */
-    readonly id: string;
-    /**
-     * The call ID returned by the AI API when the check run is started.
-     */
-    callId?: string;
-    constructor(documentData: AIDocumentData, sourceCheck: AIReviewCheck, connector: AIConnector, params?: Array<string>, args?: Record<string, any>);
-    /**
-     * Returns the document data obtained at the time of the check run.
-     */
-    get documentData(): AIDocumentData;
-    /**
-     * Returns the number of successfully processed results.
-     */
-    get processedResultsCount(): number;
-    /**
-     * Returns the check title.
-     */
-    get title(): string;
-    /**
-     * Returns the check subtitle.
-     */
-    get subTitle(): string;
-    /**
-     * Returns the check ID.
-     */
-    get reviewName(): string;
-    /**
-     * Whether the check run has any modifications (accepted or rejected changes).
-     */
-    get hasModifications(): boolean;
-    /**
-     * Returns the current error that occurred during the check run, if any.
-     */
-    get currentError(): Error | undefined;
-    /**
-     * Updates the document data used for the check run. It allows to rerun the same check with different data.
-     */
-    updateDocumentData(documentData: AIDocumentData): void;
-    /**
-     * Starts the check run resulting in an API call. After the call is finished, the status
-     * and list of changes are updated.
-     */
-    start(): Promise<void>;
-    /**
-     * Restarts the check run by clearing previous results and starting a new run.
-     */
-    restart(): Promise<void>;
-    addResultChanges(resultId: string, changes: Array<AIReviewCoreChangeData>): void;
-    /**
-     * Aborts the check run.
-     */
-    abort(): void;
-    isChangeActive(changeId: string): boolean;
-    isAnyChangeActivated(): boolean;
-    getActiveChanges(): Array<AIReviewCheckResultChange>;
-    getChangeById(changeId: string): AIReviewCheckResultChange | undefined;
-    markAllChangesAsAccepted(): void;
-    markChangeAsAccepted(changeId: string): void;
-    markChangeAsRejected(changeId: string): void;
-    markChangeAsOutdated(changeId: string): void;
-    markChangeAsPending(changeId: string): void;
-    activateChange(changeId: string): void;
-    deactivateChange(): void;
-    forceReadyState(): void;
-    /**
-     * Sends the rating to an AI API for the review check run.
-     *
-     * If `changeId` is provided, the rating will be associated with that specific result, which
-     * the change is a part of (since the result is splitted into multiple changes). The `resultId`
-     * is used on the backend to track ratings for individual results.
-     * If `changeId` is not provided, the rating will be send as general for the whole check run.
-     *
-     * The rating will not be send if:
-     * - There is no `callId` (means the check run was not started or failed before getting the ID).
-     * - There are no changes in the check run.
-     * - The change with given `changeId` was already rated.
-     * - The check run is not ready yet (still streaming), since we don't know the final number of changes
-     * yet, which is required to send the rating.
-     */
-    sendRating(changeId?: string): Promise<void>;
+* Represents a single review check run and its results.
+*/
+export declare abstract class AIReviewCheckRun extends AIReviewCheckRunBase {
+	/**
+	* The status of the check run.
+	*/
+	status: AIReviewCheckRunStatus;
+	/**
+	* `true` while the run is still being generated/streamed, or while at least one produced change is
+	* still `pending`. Derived from {@link #status} and {@link #pendingChangesCount} on every read, since
+	* resolving the last pending change does not always trigger a `status` transition (for example while
+	* the run is in an `error-*` status).
+	*/
+	get isUnresolved(): boolean;
+	/**
+	* The check run ID.
+	*/
+	readonly id: string;
+	/**
+	* The call ID returned by the AI API when the check run is started.
+	*/
+	callId?: string;
+	constructor(documentData: AIDocumentData, sourceCheck: AIReviewCheck, connector: AIConnector, params?: Array<string>, args?: Record<string, any>, context?: AIContext);
+	/**
+	* Returns the document data obtained at the time of the check run.
+	*/
+	get documentData(): AIDocumentData;
+	/**
+	* The check this run was constructed against.
+	*/
+	get sourceCheck(): AIReviewCheck;
+	/**
+	* Returns the number of successfully processed results.
+	*/
+	get processedResultsCount(): number;
+	/**
+	* Whether a proposed change was dropped because it would introduce block content into an inline root.
+	*/
+	get hasUnsupportedInlineChange(): boolean;
+	/**
+	* Returns the check title.
+	*/
+	get title(): string;
+	/**
+	* Returns the check subtitle.
+	*/
+	get subTitle(): string;
+	/**
+	* Returns the check ID.
+	*/
+	get reviewName(): string;
+	/**
+	* Whether the check run has any modifications (accepted or rejected changes).
+	*/
+	get hasModifications(): boolean;
+	/**
+	* Returns the current error that occurred during the check run, if any.
+	*/
+	get currentError(): Error | undefined;
+	/**
+	* Returns the list of results made by the check run.
+	*/
+	get results(): Array<AIReviewCheckResult>;
+	/**
+	* Updates the document data used for the check run. It allows to rerun the same check with different data.
+	*/
+	updateDocumentData(documentData: AIDocumentData): void;
+	/**
+	* Starts the check run resulting in an API call. After the call is finished, the status
+	* and list of changes are updated.
+	*/
+	start(): Promise<void>;
+	/**
+	* Restarts the check run by clearing previous results and starting a new run.
+	*/
+	restart(): Promise<void>;
+	addResultChanges(resultId: string, changes: Array<AIReviewCoreChangeData>): void;
+	/**
+	* Aborts the check run.
+	*/
+	abort(): void;
+	isChangeActive(changeId: string): boolean;
+	isAnyChangeActivated(): boolean;
+	getActiveChanges(): Array<AIReviewCheckResultChange>;
+	getChangeById(changeId: string): AIReviewCheckResultChange | undefined;
+	/**
+	* The one-based position of `changeId` among all {@link #totalChangesCount} changes, or `0` when unknown.
+	*/
+	getChangePosition(changeId: string): number;
+	/**
+	* The number of changes produced by this run, regardless of their status (pending, accepted, rejected, outdated).
+	*/
+	get totalChangesCount(): number;
+	/**
+	* The number of changes still awaiting a decision, that is those with the `pending` status.
+	*/
+	get pendingChangesCount(): number;
+	/**
+	* The number of changes that are no longer pending (accepted, rejected, outdated).
+	*/
+	get reviewedChangesCount(): number;
+	markAllChangesAsAccepted(): void;
+	markAllChangesAsRejected(): void;
+	markChangeAsAccepted(changeId: string): void;
+	markChangeAsRejected(changeId: string): void;
+	markChangeAsOutdated(changeId: string): void;
+	markChangeAsPending(changeId: string): void;
+	activateChange(changeId: string): void;
+	deactivateChange(): void;
+	forceReadyState(): void;
+	/**
+	* Sends the rating to an AI API for the review check run.
+	*
+	* If `changeId` is provided, the rating will be associated with that specific result, which
+	* the change is a part of (since the result is splitted into multiple changes). The `resultId`
+	* is used on the backend to track ratings for individual results.
+	* If `changeId` is not provided, the rating will be send as general for the whole check run.
+	*
+	* The rating will not be send if:
+	* - There is no `callId` (means the check run was not started or failed before getting the ID).
+	* - There are no changes in the check run.
+	* - The change with given `changeId` was already rated.
+	* - The check run is not ready yet (still streaming), since we don't know the final number of changes
+	* yet, which is required to send the rating.
+	*/
+	sendRating(changeId?: string): Promise<void>;
 }
 export type AIReviewCheckRunUpdatedEvent = {
-    name: 'reviewCheckRunUpdated';
-    args: [
-        {
-            status: AIReviewCheckRunStatus;
-            run: AIReviewCheckRun;
-            error?: Error;
-        }
-    ];
+	name: "reviewCheckRunUpdated";
+	args: [{
+		status: AIReviewCheckRunStatus;
+		run: AIReviewCheckRun;
+		error?: Error;
+	}];
 };
 export type AIReviewCheckResultAddedEvent = {
-    name: 'reviewCheckResultAdded';
-    args: [
-        {
-            result: AIReviewCheckResult;
-            source: AIReviewCheckRun;
-            editor: Editor;
-        }
-    ];
+	name: "reviewCheckResultAdded";
+	args: [{
+		result: AIReviewCheckResult;
+		source: AIReviewCheckRun;
+		editor: Editor;
+		rootName: string;
+	}];
 };
 export type AIReviewCheckResultReadyEvent = {
-    name: 'reviewCheckResultReady';
-    args: [
-        {
-            changes: Array<AIReviewCheckResultChange>;
-            result: AIReviewCheckResult;
-            source: AIReviewCheckRun;
-        }
-    ];
+	name: "reviewCheckResultReady";
+	args: [{
+		changes: Array<AIReviewCheckResultChange>;
+		result: AIReviewCheckResult;
+		source: AIReviewCheckRun;
+	}];
 };
 export type AIReviewCheckResultChangeStatusUpdatedEvent = {
-    name: 'reviewCheckResultChangeStatusUpdated';
-    args: [
-        {
-            change: AIReviewCheckResultChange;
-            status: AIReviewCheckResultChange['status'];
-        }
-    ];
+	name: "reviewCheckResultChangeStatusUpdated";
+	args: [{
+		change: AIReviewCheckResultChange;
+		status: AIReviewCheckResultChange["status"];
+	}];
 };
 export type AIReviewCheckResultChangeActivatedEvent = {
-    name: 'reviewCheckResultActivated';
-    args: [
-        {
-            change: AIReviewCheckResultChange;
-        }
-    ];
+	name: "reviewCheckResultActivated";
+	args: [{
+		change: AIReviewCheckResultChange;
+	}];
 };
 export type AIReviewCheckResultChangeDeactivatedEvent = {
-    name: 'reviewCheckResultDeactivated';
-    args: [
-        {
-            change: AIReviewCheckResultChange;
-        }
-    ];
+	name: "reviewCheckResultDeactivated";
+	args: [{
+		change: AIReviewCheckResultChange;
+	}];
 };
-export type AIReviewCheckRunStatus = 'initialized' | 'loading' | 'data' | 'ready' | 'error-chunk' | 'error-general' | 'aborted' | 'finished' | 'unmodified';
+export type AIReviewCheckRunStatus = "initialized" | "loading" | "data" | "ready" | "error-chunk" | "error-general" | "aborted" | "finished" | "unmodified";
 export {};

package/dist/aireviewcore/model/aireviewsystemcheckrun.d.ts

@@ -1,21 +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/model/aireviewsystemcheckrun
- */
-import { AIReviewCheckRun } from './aireviewcheckrun.js';
+* @module ai/aireviewcore/model/aireviewsystemcheckrun
+*/
+import { AIReviewCheckRun } from "./aireviewcheckrun.js";
 /**
- * Represents a single system review check run and its results.
- */
+* Represents a single system review check run and its results.
+*/
 export declare class AIReviewSystemCheckRun extends AIReviewCheckRun {
-    /**
-     * @inheritDoc
-     */
-    get subTitle(): string;
-    /**
-     * @inheritDoc
-     */
-    get reviewName(): string;
+	/**
+	* @inheritDoc
+	*/
+	override get subTitle(): string;
+	/**
+	* @inheritDoc
+	*/
+	override get reviewName(): string;
 }

package/dist/aireviewcore/types.d.ts

@@ -1,36 +1,42 @@
 /**
- * @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/types
- */
+* @module ai/aireviewcore/types
+*/
+import { type AIContextRef } from "../aicore/model/aicontextref.js";
 export interface AIReviewCheckBaseDefinition {
-    id: string;
-    commandId: string;
-    title: string;
-    description: string;
-    isParameterized: boolean;
-    isExtra?: boolean;
+	id: string;
+	commandId: string;
+	title: string;
+	description: string;
+	isParameterized: boolean;
+	isExtra?: boolean;
 }
 export interface AIReviewCheckDefinition extends AIReviewCheckBaseDefinition {
-    useArgs?: boolean;
-    options?: Array<AIReviewCheckOptions>;
-    args?: Record<string, string>;
+	useArgs?: boolean;
+	options?: Array<AIReviewCheckOptions>;
+	args?: Record<string, string>;
 }
 export interface AIReviewCheckExtraDefinition extends AIReviewCheckBaseDefinition {
-    isExtra: true;
-    prompt: string;
-    model?: string;
+	isExtra: true;
+	prompt?: string;
+	/**
+	* @experimental **Experimental:** This is a production-ready API but may change in minor releases
+	* without the standard deprecation policy. Check the changelog for migration guidance.
+	*/
+	context?: AIContextRef;
+	model?: string;
 }
 export type AIReviewCheckOptions = {
-    formType: string;
-    label?: string;
-    default?: string;
-    data?: Array<AIReviewCheckOptionData>;
-    argsKey?: string;
+	formType: string;
+	label?: string;
+	default?: string;
+	data?: Array<AIReviewCheckOptionData>;
+	argsKey?: string;
 };
 export type AIReviewCheckOptionData = {
-    label: string;
-    id: string;
+	label: string;
+	id: string;
 };

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

@@ -0,0 +1,50 @@
+/**
+* @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/aireviewcoreabstractchecklistview
+*/
+import { ListView } from "@ckeditor/ckeditor5-ui";
+import type { AIReviewCheck } from "../model/aireviewcheck.js";
+import { AIReviewCoreReviewCommandListItemView } from "./aireviewcorereviewcommandlistitemview.js";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+/**
+* A storage-agnostic base for review check-list views.
+*
+* Concrete subclasses decide how check views are stored and rendered (e.g. split into groups, or a
+* flat list) by implementing the seams below; this class owns the algorithms (`setChecks()`,
+* `getCheckViewById()`, `hasChecks()`, `resetAllParameterizedChecks()`) that stay the same regardless
+* of storage shape, so they're written once instead of being re-implemented per subclass.
+*/
+export declare abstract class AIReviewCoreAbstractCheckListView extends ListView {
+	/**
+	* Controls whether the item view is visible. Visible by default, list items are hidden
+	* using a CSS class.
+	*
+	* @observable
+	* @default true
+	*/
+	isVisible: boolean;
+	constructor(locale: Locale);
+	/**
+	* Sets the checks to be displayed in the list.
+	*/
+	setChecks(checks: ReadonlyArray<AIReviewCheck>, hideModels?: boolean): void;
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* Returns all check views currently in the list, in render order.
+	*/
+	abstract getCheckViews(): Array<AIReviewCoreReviewCommandListItemView>;
+	/**
+	* Indicates whether there are any checks in the list.
+	*/
+	hasChecks(): boolean;
+	/**
+	* Resets all parameterized checks to their default values.
+	*/
+	resetAllParameterizedChecks(): void;
+}

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

@@ -1,80 +1,57 @@
 /**
- * @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/aireviewcorechecklistitemresultview
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { View, ButtonView } from '@ckeditor/ckeditor5-ui';
-import { type AIReviewCheckResultChange } from '../model/aireviewcheckresultchange.js';
+* @module ai/aireviewcore/ui/aireviewcorechecklistitemresultview
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { View, ButtonView } from "@ckeditor/ckeditor5-ui";
+import { type AIReviewCheckResultChange } from "../model/aireviewcheckresultchange.js";
 export declare class AIReviewCoreReviewCheckListItemResultsView extends View {
-    resultResponseView: View;
-    acceptButtonView: ButtonView;
-    dismissButtonView: ButtonView;
-    infoButtonView: ButtonView;
-    outdatedButtonView: ButtonView;
-    /**
-     * @observable
-     */
-    changeId: string;
-    /**
-     * @observable
-     */
-    isInfoToggleOn: boolean;
-    /**
-     * @observable
-     */
-    isActive: boolean;
-    /**
-     * @observable
-     */
-    showDiff: boolean;
-    /**
-     * @observable
-     */
-    status: AIReviewCheckResultChange['status'];
-    readonly id: string;
-    constructor(locale: Locale, id: string);
-    setItemAsActive(): void;
-    setItemAsInactive(): void;
+	resultResponseView: View;
+	acceptButtonView: ButtonView;
+	dismissButtonView: ButtonView;
+	infoButtonView: ButtonView;
+	outdatedButtonView: ButtonView;
+	suggestButtonView: ButtonView;
+	/**
+	* @observable
+	*/
+	changeId: string;
+	/**
+	* @observable
+	*/
+	isInfoToggleOn: boolean;
+	/**
+	* @observable
+	*/
+	isActive: boolean;
+	/**
+	* @observable
+	*/
+	showDiff: boolean;
+	/**
+	* @observable
+	*/
+	status: AIReviewCheckResultChange["status"];
+	/**
+	* @observable
+	*/
+	isAcceptButtonVisible: boolean;
+	/**
+	* @observable
+	*/
+	isSuggestButtonVisible: boolean;
+	readonly id: string;
+	constructor(locale: Locale, id: string, isAcceptButtonVisible: boolean, isSuggestButtonVisible: boolean);
+	override render(): void;
+	setItemAsActive(): void;
+	setItemAsInactive(): void;
+	/**
+	* Sets the previewed content, rendering it under `tag` (an inline root's semantic element, for example `h2`) instead
+	* of the default `div`. The host element is swapped in place when the tag changes so the preview matches the editable
+	* and shares its `ck-content` styling. The CSS classes are preserved.
+	*/
+	updateResponseContent(html: string, tag?: string): void;
 }
-export type AIReviewCoreDeactivateChangeEventData = {
-    origin: 'panel';
-    id: string;
-    source: AIReviewCoreReviewCheckListItemResultsView;
-} | {
-    origin: 'balloon';
-};
-export type AIReviewCoreActivateChangeEvent = {
-    name: 'activateChange';
-    args: [
-        {
-            id: string;
-            source: AIReviewCoreReviewCheckListItemResultsView;
-            uiInteraction: 'click' | 'hover';
-        }
-    ];
-};
-export type AIReviewCoreDeactivateChangeEvent = {
-    name: 'deactivateChange';
-    args: [
-        AIReviewCoreDeactivateChangeEventData
-    ];
-};
-export type AIReviewCoreAcceptChangeEvent = {
-    name: 'acceptChange';
-    args: [
-        {
-            id: string;
-        }
-    ];
-};
-export type AIReviewCoreDismissChangeEvent = {
-    name: 'dismissChange';
-    args: [
-        {
-            id: string;
-        }
-    ];
-};

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

@@ -0,0 +1,29 @@
+/**
+* @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/aireviewcorecompletereviewdropdown */
+import { type DropdownView, View } from "@ckeditor/ckeditor5-ui";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+export declare class CompleteReviewDropdownContainerView extends View {
+	/**
+	* @observable
+	*/
+	isVisible: boolean;
+	/**
+	* @observable
+	*/
+	isAnyResultReviewed: boolean;
+	/**
+	* Whether there are any active changes left to accept or reject. Defaults to `true` so
+	* consumers that never bind it keep the menu items enabled.
+	*
+	* @observable
+	*/
+	hasPendingChanges: boolean;
+	/**
+	* The underlying dropdown view, exposed for easier debugging.
+	*/
+	dropdownView: DropdownView;
+	constructor(locale: Locale, buttonClass: string);
+}