@ckeditor/ckeditor5-ai 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/aireviewcore/ui/aireviewcoreview.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/ui/aireviewcoreview
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { View, type FormHeaderView } from '@ckeditor/ckeditor5-ui';
-import { type AIReviewCoreReviewCheckListView } from './aireviewcorereviewchecklistview.js';
-import { type AIReviewCoreReviewCompletedView } from './aireviewcorereviewcompletedview.js';
-import { AIReviewCoreGeneralErrorView } from './aireviewcoregeneralerrorview.js';
-import { type AIReviewCoreUICheckResultsView } from './aireviewcoreuicheckresultsview.js';
+* @module ai/aireviewcore/ui/aireviewcoreview
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { View, type FormHeaderView } from "@ckeditor/ckeditor5-ui";
+import { type AIReviewCoreReviewCheckListView } from "./aireviewcorereviewchecklistview.js";
+import { type AIReviewCoreReviewCompletedView } from "./aireviewcorereviewcompletedview.js";
+import { AIReviewCoreGeneralErrorView } from "./aireviewcoregeneralerrorview.js";
+import { type AIReviewCoreUICheckResultsView } from "./aireviewcoreuicheckresultsview.js";
 export declare class AIReviewCoreView extends View {
-    /**
-     * The header of the AI Review Core.
-     */
-    reviewCoreHeader: FormHeaderView;
-    /**
-     * The general error view of the AI Review Core.
-     */
-    generalErrorView: AIReviewCoreGeneralErrorView;
-    /**
-     * The review check list view of the AI Review Core.
-     */
-    reviewCheckListView: AIReviewCoreReviewCheckListView;
-    /**
-     * The check run results view of the AI Review Core.
-     */
-    reviewCheckResultsView: AIReviewCoreUICheckResultsView;
-    /**
-     * The review completed view of the AI Review Core.
-     */
-    reviewCompletedView: AIReviewCoreReviewCompletedView;
-    constructor(locale: Locale, views: {
-        header: FormHeaderView;
-        list: AIReviewCoreReviewCheckListView;
-        results: AIReviewCoreUICheckResultsView;
-        completed: AIReviewCoreReviewCompletedView;
-    });
-    showReviewCheckListView(): void;
-    showReviewCheckResultsView(): void;
-    addCheckRunResult(result: {
-        contentDiffed: string;
-        id: string;
-    }): void;
-    showReviewCompletedView(): void;
-    showActionsWhenResultIsReady(): void;
-    showNoChangesView(): void;
-    hideActionsWhenResultIsReady(): void;
-    showGeneralReviewCoreErrorView(errorMessage: string): void;
-    showGeneralResultsErrorView(): void;
-    showChunkErrorView(): void;
+	/**
+	* The header of the AI Review Core.
+	*/
+	reviewCoreHeader: FormHeaderView;
+	/**
+	* The general error view of the AI Review Core.
+	*/
+	generalErrorView: AIReviewCoreGeneralErrorView;
+	/**
+	* The review check list view of the AI Review Core.
+	*/
+	reviewCheckListView: AIReviewCoreReviewCheckListView;
+	/**
+	* The check run results view of the AI Review Core.
+	*/
+	reviewCheckResultsView: AIReviewCoreUICheckResultsView;
+	/**
+	* The review completed view of the AI Review Core.
+	*/
+	reviewCompletedView: AIReviewCoreReviewCompletedView;
+	constructor(locale: Locale, views: {
+		header: FormHeaderView;
+		list: AIReviewCoreReviewCheckListView;
+		results: AIReviewCoreUICheckResultsView;
+		completed: AIReviewCoreReviewCompletedView;
+	});
+	showReviewCheckListView(): void;
+	showReviewCheckResultsView(): void;
+	addCheckRunResult(result: {
+		contentDiffed: string;
+		id: string;
+	}): void;
+	showReviewCompletedView(): void;
+	showActionsWhenResultIsReady(): void;
+	showNoChangesView(): void;
+	hideActionsWhenResultIsReady(): void;
+	showGeneralReviewCoreErrorView(errorMessage: string): void;
+	showGeneralResultsErrorView(): void;
+	showChunkErrorView(): void;
 }

package/dist/aireviewcore/ui/form/aireviewcoreformdropdown.d.ts

@@ -1,20 +1,20 @@
 /**
- * @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/form/aireviewcoreformdropdown
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { View } from '@ckeditor/ckeditor5-ui';
-import type { AIReviewCheckOptions } from '../../types.js';
+* @module ai/aireviewcore/ui/form/aireviewcoreformdropdown
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { View } from "@ckeditor/ckeditor5-ui";
+import type { AIReviewCheckOptions } from "../../types.js";
 export declare class AIReviewCoreFormDropdownView extends View {
-    /**
-     * The `value` of the currently selected option.
-     *
-     * @observable
-     */
-    formValue: string | null;
-    constructor(locale: Locale, options: AIReviewCheckOptions);
-    resetToDefault(): void;
+	/**
+	* The `value` of the currently selected option.
+	*
+	* @observable
+	*/
+	formValue: string | null;
+	constructor(locale: Locale, options: AIReviewCheckOptions);
+	resetToDefault(): void;
 }

package/dist/aireviewcore/ui/form/aireviewcoreformmanager.d.ts

@@ -1,16 +1,16 @@
 /**
- * @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/form/aireviewcoreformmanager
- */
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-import { type View, ListItemView } from '@ckeditor/ckeditor5-ui';
-import { type AIReviewCheckOptions } from '../../types.js';
+* @module ai/aireviewcore/ui/form/aireviewcoreformmanager
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
+import { type View, ListItemView } from "@ckeditor/ckeditor5-ui";
+import { type AIReviewCheckOptions } from "../../types.js";
 export declare class AIReviewCoreFormManagerView extends ListItemView {
-    value: string;
-    argsKey: string | undefined;
-    constructor(locale: Locale, options: AIReviewCheckOptions, submitButton: View | null);
-    resetToDefault(): void;
+	value: string;
+	argsKey: string | undefined;
+	constructor(locale: Locale, options: AIReviewCheckOptions, submitButton: View | null);
+	resetToDefault(): void;
 }

package/dist/aireviewmode/aireviewcheckdefinitions.d.ts

@@ -1,16 +1,16 @@
 /**
- * @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/aireviewmode/aireviewcheckdefinitions
- */
-import { type AIReviewCheckDefinition } from '../aireviewcore/types.js';
+* @module ai/aireviewmode/aireviewcheckdefinitions
+*/
+import { type AIReviewCheckDefinition } from "../aireviewcore/types.js";
 /**
- * List of definitions of available review checks that can be performed in the AI Review Mode.
- *
- * IMPORTANT: Every time this list changes, the `availableCommands` property
- * in {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig} and Review feature guide
- * should be updated accordingly.
- */
+* List of definitions of available review checks that can be performed in the AI Review Mode.
+*
+* IMPORTANT: Every time this list changes, the `availableCommands` property
+* in {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig} and Review feature guide
+* should be updated accordingly.
+*/
 export declare const AI_REVIEW_CHECKS: Array<AIReviewCheckDefinition>;

package/dist/aireviewmode/aireviewgateway.d.ts

@@ -1,161 +1,153 @@
 /**
- * @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/aireviewmode/aireviewgateway
- * @publicApi
- */
-import { ContextPlugin } from '@ckeditor/ckeditor5-core';
-import { AIConnector, type AIModelData } from '../aicore/aiconnector.js';
-import { AIReviewCoreEditing } from '../aireviewcore/aireviewcoreediting.js';
-import { AIReviewModeCheckRegistry } from './aireviewmodecheckregistry.js';
-import { AIEditing } from '../aicore/aiediting.js';
-import { AIReviewRunResult } from './model/aireviewrunresult.js';
-import { AIGateway, type AIRunApplyMethod } from '../aicore/aigateway.js';
+* @module ai/aireviewmode/aireviewgateway
+* @publicApi
+*/
+import { ContextPlugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AIConnector, type AIModelData } from "../aicore/aiconnector.js";
+import { AIReviewCoreEditing } from "../aireviewcore/aireviewcoreediting.js";
+import { AIReviewModeCheckRegistry } from "./aireviewmodecheckregistry.js";
+import { AIEditing } from "../aicore/aiediting.js";
+import { AIReviewRunResult } from "./model/aireviewrunresult.js";
+import { AIGateway, type AIRunBaseOptions, type AIRunApplyMethod } from "../aicore/aigateway.js";
 /**
- * Review command data.
- */
+* Review command data.
+*/
 export interface AIReviewCommandData {
-    /**
-     * Id of the review command.
-     */
-    id: string;
-    /**
-     * Human-readable command title.
-     */
-    title: string;
-    /**
-     * Human-readable description of what the command does.
-     */
-    description: string;
-    /**
-     * Selectable parameters for parameterized commands (e.g. `length`, `tone`). One of these ids can be
-     * passed as `options.parameterId` when invoking the command.
-     */
-    parameters?: Array<{
-        id: string;
-        label: string;
-    }>;
+	/**
+	* Id of the review command.
+	*/
+	id: string;
+	/**
+	* Human-readable command title.
+	*/
+	title: string;
+	/**
+	* Human-readable description of what the command does.
+	*/
+	description: string;
+	/**
+	* Selectable parameters for parameterized commands (e.g. `length`, `tone`). One of these ids can be
+	* passed as `options.parameterId` when invoking the command.
+	*/
+	parameters?: Array<{
+		id: string;
+		label: string;
+	}>;
 }
 export type AIReviewRunOptions = {
-    /**
-     * Id of one of the values in {@link module:ai/aireviewmode/aireviewgateway~AIReviewCommandData#parameters}.
-     * Applicable to parameterized commands (e.g. `length`, `tone`), ignored otherwise.
-     */
-    parameterId?: string;
+	/**
+	* Id of one of the values in {@link module:ai/aireviewmode/aireviewgateway~AIReviewCommandData#parameters}.
+	* Applicable to parameterized commands (e.g. `length`, `tone`), ignored otherwise.
+	*/
+	parameterId?: string;
 };
 export type AIReviewCustomRunOptions = {
-    /**
-     * The model that will be used to run the custom command.
-     * The ids of an AI models can be acquired via {@link module:ai/aireviewmode/aireviewgateway~AIReviewGateway#getAvailableModels} call.
-     */
-    model?: string;
-};
-export type AIReviewHeadlessRunOptions = AIReviewRunOptions & {
-    /**
-     * An `AbortSignal` that cancels the run when aborted. Aborted runs resolve with `status: 'aborted'`.
-     */
-    signal?: AbortSignal;
-};
-export type AIReviewHeadlessCustomRunOptions = AIReviewCustomRunOptions & {
-    /**
-     * An `AbortSignal` that cancels the run when aborted. Aborted runs resolve with `status: 'aborted'`.
-     */
-    signal?: AbortSignal;
+	/**
+	* The model that will be used to run the custom command.
+	* The ids of an AI models can be acquired via {@link module:ai/aireviewmode/aireviewgateway~AIReviewGateway#getAvailableModels} call.
+	*/
+	model?: string;
 };
+export type AIReviewHeadlessRunOptions = AIReviewRunOptions & AIRunBaseOptions;
+export type AIReviewHeadlessCustomRunOptions = AIReviewCustomRunOptions & AIRunBaseOptions;
 /**
- * Headless, stateless public API for running AI reviews end-to-end.
- *
- * This plugin can be loaded standalone (without `AIReviewMode` plugin) to expose a programmatic
- * review API. It is also transparently loaded by `AIReviewMode` to back the UI-driven flow.
- */
+* Headless, stateless public API for running AI reviews end-to-end.
+*
+* This plugin can be loaded standalone (without `AIReviewMode` plugin) to expose a programmatic
+* review API. It is also transparently loaded by `AIReviewMode` to back the UI-driven flow.
+*/
 export declare class AIReviewGateway extends ContextPlugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIReviewGateway";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AIReviewCoreEditing, typeof AIReviewModeCheckRegistry, typeof AIConnector, typeof AIEditing, typeof AIGateway];
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * Returns the list of review commands that can be run with {@link #runReview}.
-     *
-     * The list combines built-in system checks with any extra checks declared
-     * via the {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`}
-     * configuration.
-     *
-     * The method returns all review commands regardless of the editor configuration (which affects the UI only), meaning the commands
-     * that are not visible in the UI can be still invoked via the {@link module:ai/aireviewmode/aireviewgateway~AIReviewGateway} API.
-     *
-     * @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.
-     */
-    getAllCommands(): Promise<Array<AIReviewCommandData>>;
-    /**
-     * Returns the list of AI models that the built-in `custom` review command can be run against.
-     *
-     * The returned model ids are valid values to supply as `options.model` when invoking the `custom`
-     * command. Built-in system command and additionally configured commands do not accept a model override — system
-     * checks always run against their default backend configuration, and extras use the model declared in their
-     * {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`} entry.
-     *
-     * @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.
-     */
-    getAvailableModels(): Promise<Array<AIModelData>>;
-    /**
-     * Runs the given review command and returns
-     * the {@link module:ai/aireviewmode/model/aireviewrunresult~AIReviewRunResult detailed result}.
-     *
-     * The result can then be processed in various ways. To insert or suggest changes directly
-     * to the editor use {@link #applyReview}. Accepts built-in commands and extra commands configured
-     * via {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`}
-     *
-     * The returned {@link module:ai/aireviewmode/model/aireviewrunresult~AIReviewRunResult} always resolves — transport, parsing
-     * and merge failures are surfaced via `status: 'error'` plus the `error` field, not thrown. Aborts (via `options.signal`)
-     * are reported as `status: 'aborted'`.
-     *
-     * @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.
-     * @param commandId Id of a command returned by {@link #getAllCommands}.
-     * @param options Optional `parameterId` (selected from the command's `parameters`) and `signal` to allow aborting the run.
-     */
-    runReview(commandId: string, options?: AIReviewHeadlessRunOptions): Promise<AIReviewRunResult>;
-    /**
-     * Runs the `custom` review command and returns
-     * the {@link module:ai/aireviewmode/model/aireviewrunresult~AIReviewRunResult detailed result}.
-     *
-     * The command requires a prompt to run, and optional model id. The list of available models
-     * can be discovered via {@link #getAvailableModels}.
-     *
-     * Analogical to {@link #runReview} but restricted to the `custom` command only.
-     *
-     * @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.
-     * @param prompt The prompt to run the `custom` command with.
-     * @param options Optional `model` (optional override), plus optional `signal` to allow aborting the run.
-     */
-    runCustomReview(prompt: string, options?: AIReviewHeadlessCustomRunOptions): Promise<AIReviewRunResult>;
-    /**
-     * Applies the review run result (produced by {@link #runReview} or {@link #runCustomReview}) to the editor content, either
-     * as direct changes or as track changes suggestions.
-     *
-     * This is a proxy to the {@link module:ai/aicore/aigateway~AIGateway#apply} method.
-     *
-     * @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.
-     * @param result The result of a completed AI review run.
-     * @param applyMethod Method of applying the review suggestions to the editor content.
-     */
-    applyReview(result: AIReviewRunResult, applyMethod: AIRunApplyMethod): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIReviewGateway";
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AIReviewCoreEditing, AIReviewModeCheckRegistry, AIConnector, AIEditing, AIGateway]>;
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* Returns the list of review commands that can be run with {@link #runReview}.
+	*
+	* The list combines built-in system checks with any extra checks declared
+	* via the {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`}
+	* configuration.
+	*
+	* The method returns all review commands regardless of the editor configuration (which affects the UI only), meaning the commands
+	* that are not visible in the UI can be still invoked via the {@link module:ai/aireviewmode/aireviewgateway~AIReviewGateway} API.
+	*
+	* @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.
+	*/
+	getAllCommands(): Promise<Array<AIReviewCommandData>>;
+	/**
+	* Returns the list of AI models that the built-in `custom` review command can be run against.
+	*
+	* The returned model ids are valid values to supply as `options.model` when invoking the `custom`
+	* command. Built-in system command and additionally configured commands do not accept a model override — system
+	* checks always run against their default backend configuration, and extras use the model declared in their
+	* {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`} entry.
+	*
+	* This is a convenience proxy to the {@link module:ai/aicore/aigateway~AIGateway#getAvailableModels} method.
+	*
+	* @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.
+	*/
+	getAvailableModels(): Promise<Array<AIModelData>>;
+	/**
+	* Runs the given review command and returns
+	* the {@link module:ai/aireviewmode/model/aireviewrunresult~AIReviewRunResult detailed result}.
+	*
+	* The result can then be processed in various ways. To insert or suggest changes directly
+	* to the editor use {@link #applyReview}. Accepts built-in commands and extra commands configured
+	* via {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`}
+	*
+	* The returned {@link module:ai/aireviewmode/model/aireviewrunresult~AIReviewRunResult} always resolves — transport, parsing
+	* and merge failures are surfaced via `status: 'error'` plus the `error` field, not thrown. Aborts (via `options.signal`)
+	* are reported as `status: 'aborted'`.
+	*
+	* @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.
+	* @param commandId Id of a command returned by {@link #getAllCommands}.
+	* @param options Optional `parameterId` (selected from the command's `parameters`) and `signal` to allow aborting the run.
+	*/
+	runReview(commandId: string, options?: AIReviewHeadlessRunOptions): Promise<AIReviewRunResult>;
+	/**
+	* Runs the `custom` review command and returns
+	* the {@link module:ai/aireviewmode/model/aireviewrunresult~AIReviewRunResult detailed result}.
+	*
+	* The command requires a prompt to run, and optional model id. The list of available models
+	* can be discovered via {@link #getAvailableModels}.
+	*
+	* Analogical to {@link #runReview} but restricted to the `custom` command only.
+	*
+	* @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.
+	* @param prompt The prompt to run the `custom` command with.
+	* @param options Optional `model` (optional override), plus optional `signal` to allow aborting the run.
+	*/
+	runCustomReview(prompt: string, options?: AIReviewHeadlessCustomRunOptions): Promise<AIReviewRunResult>;
+	/**
+	* Applies the review run result (produced by {@link #runReview} or {@link #runCustomReview}) to the editor content, either
+	* as direct changes or as track changes suggestions.
+	*
+	* This is a proxy to the {@link module:ai/aicore/aigateway~AIGateway#apply} method.
+	*
+	* @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.
+	* @param result The result of a completed AI review run.
+	* @param applyMethod Method of applying the review suggestions to the editor content.
+	*/
+	applyReview(result: AIReviewRunResult, applyMethod: AIRunApplyMethod): void;
 }