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

package/dist/aireviewcore/aireviewcoreui.d.ts

@@ -1,95 +1,119 @@
 /**
- * @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/aireviewcoreui
- */
-import { type Context, type Editor, ContextPlugin } from '@ckeditor/ckeditor5-core';
-import { type AIReviewCheck } from './model/aireviewcheck.js';
-import { type AIReviewCheckRunUpdatedEvent } from './model/aireviewcheckrun.js';
-import { type AIReviewCheckResultChange } from './model/aireviewcheckresultchange.js';
-import { AITabs } from '../aitabs/aitabs.js';
-import { type AIReviewCoreView } from './ui/aireviewcoreview.js';
-export declare const AI_REVIEW_MODE_UI_EVENT_NAMES: readonly ["getReviewCheckList", "runReviewCheck", "abortReviewStream", "toggleDiff", "acceptAllChanges", "leaveReviewCoreResultList", "activateChange", "deactivateChange", "acceptChange", "dismissChange", "learnMore", "finishReview", "retryReview"];
-import '../../theme/common/aiheader.css';
-import '../../theme/common/ainotification.css';
-import '../../theme/common/aibutton.css';
-import '../../theme/common/aicolor.css';
-import '../../theme/common/aitrackchanges.css';
-import '../../theme/aireviewcore/aireviewcore.css';
+* @module ai/aireviewcore/aireviewcoreui
+*/
+import { type Context, type Editor, ContextPlugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { type AIReviewCheck } from "./model/aireviewcheck.js";
+import { type AIReviewCheckRunUpdatedEvent } from "./model/aireviewcheckrun.js";
+import { type AIReviewCheckResultChange } from "./model/aireviewcheckresultchange.js";
+import { AITabs } from "../aitabs/aitabs.js";
+import { type AIReviewCoreView } from "./ui/aireviewcoreview.js";
+import { type AIReviewCoreNavigationPanelShowOptions, type AIReviewCoreNavigationPosition } from "./ui/aireviewcorenavigationpanelview.js";
+/**
+* Options describing the copy and identifier of a leave-confirmation dialog shown by
+* {@link module:ai/aireviewcore/aireviewcoreui~AIReviewCoreUI#showLeaveConfirmationDialog}.
+*/
+export interface AILeaveConfirmationOptions {
+	dialogId: string;
+	title: string;
+	content: string;
+	stayButton: string;
+	exitButton: string;
+}
+export declare const AI_REVIEW_MODE_UI_EVENT_NAMES: readonly ["getReviewCheckList", "runReviewCheck", "abortReviewStream", "acceptAllChanges", "rejectAllChanges", "leaveReviewCoreResultList", "activateChange", "deactivateChange", "acceptChange", "dismissChange", "suggestChange", "learnMore", "finishReview", "retryReview"];
 export declare abstract class AIReviewCoreUI extends ContextPlugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AITabs];
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Context | Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Sets the available checks in the AI Review Core list view.
-     */
-    setAvailableChecks(checks: Array<AIReviewCheck>): void;
-    showReviewCheckList(): void;
-    /**
-     * Shows the result of a review check run.
-     */
-    showCheckRunResults(data: AIReviewCheckRunUpdatedEvent['args'][0]): void;
-    showCheckRunResult(result: {
-        contentDiffed: string;
-        id: string;
-    }): void;
-    showGeneralResultsErrorView(): void;
-    showGeneralReviewCoreErrorView(errorMessage?: string): void;
-    showChunkErrorView(): void;
-    setCheckResultTitle(title: string, subtitle?: string): void;
-    setActiveStateInResults(id: string): void;
-    resetActiveStateInResults(): void;
-    updateChangeState(id: string, status: AIReviewCheckResultChange['status']): void;
-    showReviewCompletedView(): void;
-    showActionsWhenResultIsReady(): void;
-    showNoChangesView(): void;
-    hideActionsWhenResultIsReady(): void;
-    showChangeBalloon(change: AIReviewCheckResultChange, target: () => HTMLElement | null, domEvent: MouseEvent | undefined, eventType: 'click' | 'hover', limiter?: HTMLElement, viewportOffset?: {
-        top?: number;
-        left?: number;
-        bottom?: number;
-        right?: number;
-    }): void;
-    hideChangeBalloon(): void;
-    hideDiffInBalloon(): void;
-    showDiffInBalloon(): void;
-    getChangeElement(changeId: string): HTMLElement | null;
-    deactivateChange(): void;
-    abstract createMainView(): AIReviewCoreView;
-    abstract registerTab(aiTabs: AITabs): void;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AITabs]>;
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(context: Context | Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Sets the available checks in the AI Review Core list view.
+	*/
+	setAvailableChecks(checks: ReadonlyArray<AIReviewCheck>): void;
+	toggleLoadingSkeleton(isLoading: boolean): void;
+	showReviewCheckList(): void;
+	/**
+	* Shows the result of a review check run.
+	*/
+	showCheckRunResults(data: AIReviewCheckRunUpdatedEvent["args"][0]): void;
+	showCheckRunResult(result: AIReviewCheckResultChange): void;
+	showGeneralResultsErrorView(): void;
+	showGeneralReviewCoreErrorView(errorMessage?: string): void;
+	showChunkErrorView(): void;
+	showUnsupportedInlineChangeView(): void;
+	setCheckResultTitle(title: string, subtitle?: string): void;
+	setHasPendingChanges(hasPendingChanges: boolean): void;
+	setActiveStateInResults(id: string): void;
+	resetActiveStateInResults(): void;
+	updateChangeState(id: string, status: AIReviewCheckResultChange["status"]): void;
+	/**
+	* Updates the review progress bar with the number of reviewed (accepted, rejected, outdated) changes out of the total.
+	*/
+	updateProgress(reviewed: number, total: number): void;
+	showReviewCompletedView(): void;
+	showActionsWhenResultIsReady(): void;
+	showNoChangesView(): void;
+	hideActionsWhenResultIsReady(): void;
+	/**
+	* Points the navigation panel at `change` and pins it to the change's element in the content.
+	*/
+	showNavigationPanel(options: Omit<AIReviewCoreNavigationPanelShowOptions, "isAcceptButtonVisible" | "isSuggestButtonVisible">): void;
+	hideNavigationPanel(): void;
+	/**
+	* Whether the navigation panel is visible within the viewport.
+	*/
+	isNavigationPanelInViewport(): boolean;
+	/**
+	* Updates the navigation panel counter without moving the panel.
+	*/
+	updateNavigationPanelPosition(position: AIReviewCoreNavigationPosition): void;
+	/**
+	* The change the navigation panel is displaying.
+	*/
+	getNavigationPanelChangeId(): string;
+	/**
+	* Scrolls the results list so the change is at its top.
+	*/
+	scrollResultsToChange(changeId: string): void;
+	/**
+	* Shows the leave-confirmation dialog. Calls `onExit` if the user confirms leaving, or `onStay` once the
+	* dialog is dismissed any other way (the stay button, the close button, or the <kbd>Esc</kbd> key).
+	*
+	* Wraps `options.content` in a padded container and delegates the actual dialog handling to
+	* {@link module:ai/aireviewcore/utils/openleaveconfirmationdialog~openLeaveConfirmationDialog}.
+	*/
+	showLeaveConfirmationDialog(options: AILeaveConfirmationOptions, onExit: () => void, onStay?: () => void): void;
+	abstract createMainView(): AIReviewCoreView;
+	abstract registerTab(aiTabs: AITabs): void;
 }
 export type AIReviewCoreUIGetReviewCheckListEvent = {
-    name: 'getReviewCheckList';
-    args: [];
+	name: "getReviewCheckList";
+	args: [];
 };
 export type AIReviewCoreUILeaveReviewEvent = {
-    name: 'leaveReview';
-    args: [];
+	name: "leaveReview";
+	args: [];
 };
 export type AIReviewCoreUIRetryReviewEvent = {
-    name: 'retryReview';
-    args: [];
+	name: "retryReview";
+	args: [];
 };

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

@@ -0,0 +1,22 @@
+/**
+* @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/aichecksinglerootresult
+* @publicApi
+*/
+import { type AIRunChangeData } from "../../aicore/aigateway.js";
+import { AIRunSingleRootResult } from "../../aicore/model/airunsinglerootresult.js";
+/**
+* The result of a single AI check run, scoped to a single root. Adds `affectedBlocks` on top of
+* {@link module:ai/aicore/model/airunsinglerootresult~AIRunSingleRootResult}.
+*/
+export declare class AICheckRunSingleRootResult extends AIRunSingleRootResult {
+	/**
+	* The list of top-level blocks that were affected by the run. Returns a fresh copy on every call —
+	* mutating the returned array does not affect the result's internal state.
+	*/
+	get affectedBlocks(): ReadonlyArray<AIRunChangeData>;
+	set affectedBlocks(value: Array<AIRunChangeData>);
+}

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

@@ -1,54 +1,54 @@
 /**
- * @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/aireviewcheck
- */
-import { type AIReviewCheckDefinition, type AIReviewCheckOptions } from '../types.js';
+* @module ai/aireviewcore/model/aireviewcheck
+*/
+import { type AIReviewCheckDefinition, type AIReviewCheckOptions } from "../types.js";
 /**
- * Represents the single type of check that can be performed in the AI Review.
- */
+* Represents the single type of check that can be performed in the AI Review.
+*/
 export declare class AIReviewCheck {
-    /**
-     * The unique ID of the check.
-     */
-    readonly id: string;
-    /**
-     * The command ID of the check, used in the API communication.
-     */
-    readonly commandId: string;
-    /**
-     * The title of the check.
-     */
-    readonly title: string;
-    /**
-     * The description of the check.
-     */
-    readonly description: string;
-    /**
-     * Indicates whether the check requires additional parameters.
-     * For example, a "Change to [tone]" check would require a tone parameter.
-     */
-    isParameterized: boolean;
-    /**
-     * Indicates whether the check should use additional arguments (like language) when executed.
-     */
-    useArgs?: boolean;
-    /**
-     * Additional options for the check, if any.
-     */
-    options?: Array<AIReviewCheckOptions>;
-    /**
-     * Additional arguments for the check, if any.
-     */
-    args?: Record<string, any>;
-    /**
-     * The API ID of the check.
-     */
-    get apiId(): string;
-    /**
-     * Creates a new instance of the AIReviewCheck.
-     */
-    constructor(checkDefinition: AIReviewCheckDefinition);
+	/**
+	* The unique ID of the check.
+	*/
+	readonly id: string;
+	/**
+	* The command ID of the check, used in the API communication.
+	*/
+	readonly commandId: string;
+	/**
+	* The title of the check.
+	*/
+	readonly title: string;
+	/**
+	* The description of the check.
+	*/
+	readonly description: string;
+	/**
+	* Indicates whether the check requires additional parameters.
+	* For example, a "Change to [tone]" check would require a tone parameter.
+	*/
+	isParameterized: boolean;
+	/**
+	* Indicates whether the check should use additional arguments (like language) when executed.
+	*/
+	useArgs?: boolean;
+	/**
+	* Additional options for the check, if any.
+	*/
+	options?: Array<AIReviewCheckOptions>;
+	/**
+	* Additional arguments for the check, if any.
+	*/
+	args?: Record<string, any>;
+	/**
+	* The API ID of the check.
+	*/
+	get apiId(): string;
+	/**
+	* Creates a new instance of the AIReviewCheck.
+	*/
+	constructor(checkDefinition: AIReviewCheckDefinition);
 }

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

@@ -1,32 +1,33 @@
 /**
- * @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 { AIReviewCheck } from './aireviewcheck.js';
-import { type AIReviewCheckBaseDefinition } from '../types.js';
-declare const AIReviewCheckList_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
+*/
 /**
- * Represents the list of review checks that can be performed in the AI Review.
- */
-export declare class AIReviewCheckList extends /* #__PURE__ */ AIReviewCheckList_base {
-    /**
-     * Initializes the list of checks based on the provided definitions.
-     */
-    setupChecks(checks: Array<AIReviewCheckBaseDefinition>): void;
-    /**
-     * The list of available review checks.
-     */
-    get checks(): Array<AIReviewCheck>;
-    /**
-     * Returns the check by its ID.
-     */
-    getCheckById(id: string): AIReviewCheck | undefined;
-    /**
-     * Removes the check by its ID.
-     */
-    removeCheckById(id: string): void;
+* @module ai/aireviewcore/model/aireviewchecklist
+*/
+import { type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import { AIReviewCheck } from "./aireviewcheck.js";
+import { type AIReviewCheckBaseDefinition } from "../types.js";
+declare const AIReviewCheckListBase: ObservableMixinConstructor;
+/**
+* Represents the list of review checks that can be performed in the AI Review.
+*/
+export declare class AIReviewCheckList extends AIReviewCheckListBase {
+	/**
+	* Initializes the list of checks based on the provided definitions.
+	*/
+	setupChecks(checks: Array<AIReviewCheckBaseDefinition>): void;
+	/**
+	* The list of available review checks.
+	*/
+	get checks(): ReadonlyArray<AIReviewCheck>;
+	/**
+	* Returns the check by its ID.
+	*/
+	getCheckById(id: string): AIReviewCheck | undefined;
+	/**
+	* Removes the check by its ID.
+	*/
+	removeCheckById(id: string): void;
 }
 export {};

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

@@ -1,39 +1,40 @@
 /**
- * @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
- */
-declare const AIReviewCheckResult_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Emitter;
-    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
-};
+* @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
+*/
 /**
- * Represents a single change of the document that is a result of an review check run.
- */
-export declare class AIReviewCheckResult extends /* #__PURE__ */ AIReviewCheckResult_base {
-    /**
-     * The id of the change.
-     */
-    readonly id: string;
-    /**
-     * The content of the change.
-     */
-    readonly contentNew: string;
-    /**
-     * The initial content of the change.
-     */
-    readonly contentInitial: string;
-    /**
-     * The document version for which this result was created.
-     */
-    readonly documentVersion: number;
-    /**
-     * Creates a new instance of the AIReviewCheckResult.
-     */
-    constructor({ id, contentNew, contentInitial, documentVersion }: {
-        id: string;
-        contentNew: string;
-        contentInitial: string;
-        documentVersion: number;
-    });
+* @module ai/aireviewcore/model/aireviewcheckresult
+*/
+import { type EmitterMixinConstructor } from "@ckeditor/ckeditor5-utils";
+declare const AIReviewCheckResultBase: EmitterMixinConstructor;
+/**
+* Represents a single change of the document that is a result of an review check run.
+*/
+export declare class AIReviewCheckResult extends AIReviewCheckResultBase {
+	/**
+	* The id of the change.
+	*/
+	readonly id: string;
+	/**
+	* The content of the change.
+	*/
+	readonly contentNew: string;
+	/**
+	* The initial content of the change.
+	*/
+	readonly contentInitial: string;
+	/**
+	* The document version for which this result was created.
+	*/
+	readonly documentVersion: number;
+	/**
+	* Creates a new instance of the AIReviewCheckResult.
+	*/
+	constructor({ id, contentNew, contentInitial, documentVersion }: {
+		id: string;
+		contentNew: string;
+		contentInitial: string;
+		documentVersion: number;
+	});
 }
 export {};

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

@@ -1,54 +1,66 @@
 /**
- * @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 { type Operation } from '@ckeditor/ckeditor5-engine';
-import { type AIReviewCheckResult } from './aireviewcheckresult.js';
-import { type AIReviewCoreChangeData } from '../aireviewcoreediting.js';
-declare const AIReviewCheckResultChange_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
+*/
 /**
- * Represents a single change of the document that is a result of an review check run.
- */
-export declare class AIReviewCheckResultChange extends /* #__PURE__ */ AIReviewCheckResultChange_base {
-    /**
-     * The id of the change.
-     */
-    readonly id: string;
-    /**
-     * Parent result of the change.
-     *
-     * Each change belongs to a single result, while each result can have multiple changes.
-     * This is because the AI API returns multiple changes in a single result and the plugin
-     * splits them into separate changes.
-     */
-    readonly parent: AIReviewCheckResult;
-    /**
-     * The status of the change.
-     *
-     * @observable
-     */
-    status: 'pending' | 'accepted' | 'rejected' | 'outdated';
-    /**
-     * Indicates whether the change is currently activated.
-     *
-     * @observable
-     */
-    isActivated: boolean;
-    /**
-     * Indicates whether the change has been rated.
-     *
-     * @observable
-     */
-    isRated: boolean;
-    /**
-     * Creates a new instance of the AIReviewCheckResult.
-     */
-    constructor(id: string, data: AIReviewCoreChangeData, parent: AIReviewCheckResult);
-    get contentDiffed(): string;
-    get operations(): Array<Operation>;
-    get operationsIsolated(): Array<Operation>;
+* @module ai/aireviewcore/model/aireviewcheckresultchange
+*/
+import { type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import { type Editor } from "@ckeditor/ckeditor5-core";
+import { type Operation } from "@ckeditor/ckeditor5-engine";
+import { type AIReviewCheckResult } from "./aireviewcheckresult.js";
+import { type AIReviewCoreChangeData } from "../aireviewcoreediting.js";
+declare const AIReviewCheckResultChangeBase: ObservableMixinConstructor;
+/**
+* Represents a single change of the document that is a result of an review check run.
+*/
+export declare class AIReviewCheckResultChange extends AIReviewCheckResultChangeBase {
+	/**
+	* The id of the change.
+	*/
+	readonly id: string;
+	/**
+	* Parent result of the change.
+	*
+	* Each change belongs to a single result, while each result can have multiple changes.
+	* This is because the AI API returns multiple changes in a single result and the plugin
+	* splits them into separate changes.
+	*/
+	readonly parent: AIReviewCheckResult;
+	/**
+	* The editor this change targets (where accepting it writes). Used to gate accepting the change by that
+	* editor's read-only state.
+	*/
+	readonly editor: Editor;
+	/**
+	* The status of the change.
+	*
+	* @observable
+	*/
+	status: "pending" | "accepted" | "rejected" | "outdated";
+	/**
+	* Indicates whether the change is currently activated.
+	*
+	* @observable
+	*/
+	isActivated: boolean;
+	/**
+	* Indicates whether the change has been rated.
+	*
+	* @observable
+	*/
+	isRated: boolean;
+	/**
+	* Creates a new instance of the AIReviewCheckResult.
+	*/
+	constructor(id: string, data: AIReviewCoreChangeData, parent: AIReviewCheckResult, editor: Editor);
+	get contentDiffed(): string;
+	/**
+	* Semantic element the preview should render this change's content under (an inline root's own element, for example
+	* `h2`), or `undefined` for a block root, where the default `div` host is used.
+	*/
+	get wrapperTag(): string | undefined;
+	get operations(): ReadonlyArray<Operation>;
+	get operationsIsolated(): ReadonlyArray<Operation>;
 }
 export {};