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

package/dist/aireviewmode/aireviewgateway.d.ts

@@ -0,0 +1,172 @@
+/**
+* @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, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AIConnector } from "../aicore/aiconnector.js";
+import { AIReviewCoreEditing } from "../aireviewcore/aireviewcoreediting.js";
+import { AIReviewModeCheckRegistry } from "./aireviewmodecheckregistry.js";
+import { AIEditing } from "../aicore/aiediting.js";
+import { type AIRunResult } from "../aicore/model/airunresult.js";
+import { type AICheckRunSingleRootResult } from "../aireviewcore/model/aichecksinglerootresult.js";
+import { AIGateway, type AIRunBaseOptions, type AIGatewayApplyOptions } from "../aicore/aigateway.js";
+import { AICore } from "../aicore/aicore.js";
+import { type AIModels } from "../aicore/model/aimodels.js";
+import { type AIEditorRoot } from "../aicore/model/aieditorroot.js";
+/**
+* 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;
+	}>;
+}
+/**
+* Roots filter shared by both `AIReviewRunOptions` and `AIReviewCustomRunOptions`.
+*/
+export type AIReviewRootsOption = {
+	/**
+	* The roots to run the review against. When omitted, every visible root across every editor in the current
+	* {@link module:core/context~Context `Context`} is reviewed. When provided, only the listed roots are reviewed;
+	* the order of entries in `roots` is treated as a set-membership filter and does not affect the payload order.
+	*
+	* Each entry's `channelId` must match an editor's `collaboration.channelId`; `rootName` must match a live,
+	* visible (non-`$graveyard`) root within that editor.
+	*/
+	roots?: Array<AIEditorRoot>;
+};
+export type AIReviewRunOptions = AIReviewRootsOption & {
+	/**
+	* 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 = AIReviewRootsOption & {
+	/**
+	* The model that will be used to run the custom command.
+	* The IDs of an AI models can be acquired via {@link module:ai/aicore/model/aimodels~AIModels#getAvailableModels}.
+	*/
+	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.
+*/
+export declare class AIReviewGateway extends ContextPlugin {
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIReviewGateway";
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AIReviewCoreEditing, AIReviewModeCheckRegistry, AIConnector, AIEditing, AIGateway, AICore]>;
+	/**
+	* The shared model registry. Exposed here so headless gateways are self-sufficient — integrators can
+	* discover and resolve models (`getAvailableModels()`, `getModel()`, `resolveModel()`, …) without
+	* reaching for the `AICore` plugin directly.
+	*
+	* @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.
+	*/
+	get models(): AIModels;
+	/**
+	* @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>>;
+	/**
+	* Runs the given review command against every visible root across every editor in the current
+	* {@link module:core/context~Context `Context`} and returns an
+	* {@link module:ai/aicore/model/airunresult~AIRunResult} — a container with one
+	* {@link module:ai/aireviewcore/model/aichecksinglerootresult~AICheckRunSingleRootResult} per root and whole-run
+	* `status` / `error`. Accepts built-in commands and extra commands configured via
+	* {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`}.
+	*
+	* To insert or suggest changes back to the editor, pass the returned result to {@link #applyReview}.
+	*
+	* When the `roots` option is provided, its entries are validated at the call boundary; an entry that does not
+	* resolve to a live, visible (non-`$graveyard`) root throws `ai-reviewcoreediting-root-not-found`, and an
+	* explicitly empty `roots` array throws `ai-reviewcoreediting-empty-roots`.
+	*
+	* @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`, `roots` filter, and `signal` to allow aborting the run.
+	*/
+	runReview(commandId: string, options?: AIReviewHeadlessRunOptions): Promise<AIRunResult<AICheckRunSingleRootResult>>;
+	/**
+	* Runs the `custom` review command against every visible root across every editor in the current
+	* {@link module:core/context~Context `Context`} and returns an
+	* {@link module:ai/aicore/model/airunresult~AIRunResult}.
+	*
+	* The command requires a prompt to run, and optional model ID. The list of available models can be discovered
+	* via {@link module:ai/aicore/model/aimodels~AIModels#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), `roots` filter, and `signal` to allow aborting the run.
+	*/
+	runCustomReview(prompt: string, options?: AIReviewHeadlessCustomRunOptions): Promise<AIRunResult<AICheckRunSingleRootResult>>;
+	/**
+	* Applies a review run result (produced by {@link #runReview} or {@link #runCustomReview}) to the editor content,
+	* either as direct changes or as track-changes suggestions. Each per-root sub-result is applied to the root
+	* identified by its own `channelId` and `rootName`. Pass `options.roots` to restrict the apply to a subset of
+	* roots — the filter is symmetric with the one accepted by {@link #runReview} / {@link #runCustomReview}.
+	*
+	* By default the apply is stamped with `aiSource: 'review'`; pass `options.aiSource` to override.
+	*
+	* @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 returned by {@link #runReview} or {@link #runCustomReview}.
+	* @param options Apply options forwarded to {@link module:ai/aicore/aigateway~AIGateway#apply}, including the
+	* `applyMethod` and an optional `roots` filter.
+	*/
+	applyReview(result: AIRunResult<AICheckRunSingleRootResult>, options: AIGatewayApplyOptions): void;
+}

package/dist/aireviewmode/aireviewmode.d.ts

@@ -1,135 +1,269 @@
 /**
- * @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/aireviewmode
- * @publicApi
- */
-import { ContextPlugin } from '@ckeditor/ckeditor5-core';
-import { AIReviewModeUI } from './aireviewmodeui.js';
-import { AIReviewCoreEditing } from '../aireviewcore/aireviewcoreediting.js';
-import { AIReviewModeController } from './aireviewmodecontroller.js';
+* @module ai/aireviewmode/aireviewmode
+* @publicApi
+*/
+import { ContextPlugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AIReviewModeUI } from "./aireviewmodeui.js";
+import { AIReviewCoreEditing } from "../aireviewcore/aireviewcoreediting.js";
+import { AIReviewModeController } from "./aireviewmodecontroller.js";
+import { type AIReviewCommandData, type AIReviewCustomRunOptions, AIReviewGateway, type AIReviewRunOptions } from "./aireviewgateway.js";
+import { type AIContextRef } from "../aicore/model/aicontextref.js";
 /**
- * The AI Review Mode feature.
- *
- * The Review feature provides users with AI-powered quality assurance for their content by automatically running checks
- * for grammar, style, tone, and more.
- *
- * Learn more about AI features in CKEditor in the {@glink features/ai/ckeditor-ai-overview AI Overview} documentation.
- */
+* The AI Review Mode feature.
+*
+* The Review feature provides users with AI-powered quality assurance for their content by automatically running commands
+* for grammar, style, tone, and more.
+*
+* Learn more about AI features in CKEditor in the {@glink features/ai/ckeditor-ai-overview AI Overview} documentation.
+*/
 export declare class AIReviewMode extends ContextPlugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AIReviewModeController, typeof AIReviewModeUI, typeof AIReviewCoreEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIReviewMode";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AIReviewModeController, AIReviewModeUI, AIReviewCoreEditing, AIReviewGateway]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIReviewMode";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* Launches a review command on the UI — the programmatic equivalent of clicking a command in the review panel.
+	*
+	* Unlike the headless {@link module:ai/aireviewmode/aireviewgateway~AIReviewGateway} API, this method drives
+	* the full UI-driven flow.
+	*
+	* Preconditions:
+	* - The command must be available in the UI. Not available commands or unknown IDs throw `ai-reviewmode-unknown-command`.
+	* - The `commandId` must point at a built-in system command or an extra command configured via
+	* {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`}.
+	* The built-in `custom` command throws `ai-reviewmode-not-a-system-command`. Use {@link #startCustomReview} instead
+	* to run the `custom` command.
+	* - No other review check can already be running. Otherwise the method throws `ai-reviewmode-review-already-running`.
+	* - Activating the Review tab must not be vetoed by a listener (for example another AI tab has an unresolved
+	* run and the user declines the confirmation dialog asking to leave it). Otherwise the method throws
+	* `ai-reviewmode-review-vetoed`.
+	*
+	* The returned promise resolves once the review run is dispatched to the controller. The command itself continues
+	* to run asynchronously and the UI reflects its progress. Stream-phase failures surface via the existing UI error
+	* views, not via this promise.
+	*
+	* @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 #getAvailableCommands}.
+	* @param options Optional `parameterId` (for parameterized system commands like `length` or `tone`).
+	*/
+	startReview(commandId: string, options?: AIReviewRunOptions): Promise<void>;
+	/**
+	* Launches the built-in `custom` review command on the UI — the programmatic equivalent of clicking the
+	* `custom` command (and submitting the prompt modal) in the review panel.
+	*
+	* Analogical to {@link #startReview}, but restricted to the built-in `custom` command only.
+	*
+	* Preconditions:
+	* - The `custom` command must be available in the UI. If not, the method throws `ai-reviewmode-unknown-command`.
+	* - A model must be resolvable from `options.model` or the command's default. Otherwise the method throws
+	* `ai-reviewmode-missing-custom-command-model`. Use {@link module:ai/aicore/model/aimodels~AIModels#getAvailableModels}
+	* for valid model IDs.
+	* - No other review check can already be running. Otherwise the method throws `ai-reviewmode-review-already-running`.
+	* - Activating the Review tab must not be vetoed by a listener (for example another AI tab has an unresolved
+	* run and the user declines the confirmation dialog asking to leave it). Otherwise the method throws
+	* `ai-reviewmode-review-vetoed`.
+	*
+	* The returned promise resolves once the review run is dispatched to the controller. The command itself
+	* continues to run asynchronously and the UI reflects its progress. Stream-phase failures surface via
+	* the existing UI error views, not via this promise.
+	*
+	* @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` to run command with this specific model, instead of the default one.
+	* Use {@link module:ai/aicore/model/aimodels~AIModels#getAvailableModels} for valid model IDs.
+	*/
+	startCustomReview(prompt: string, options?: AIReviewCustomRunOptions): Promise<void>;
+	/**
+	* Returns the list of review commands that can be run via {@link #startReview} and are visible in the UI.
+	* The list will include `custom` command if it's available (meaning {@link #startCustomReview} can be used).
+	*
+	* The list combines built-in system commands with any extra commands declared
+	* via the {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands `ai.review.extraCommands`} configuration.
+	*
+	* @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.
+	*/
+	getAvailableCommands(): Array<AIReviewCommandData>;
 }
 export interface AIReviewModeConfig {
-    /**
-     * List of IDs of review commands that will be available in the AI Review feature UI. If not set, all available
-     * predefined commands will be used. The order of IDs defines the order of commands in the UI.
-     *
-     * The list of all predefined commands, used by default:
-     * - `custom`
-     * - `correctness`
-     * - `clarity`
-     * - `readability`
-     * - `length`
-     * - `tone`
-     *
-     * The commands can be used selectively and rearranged with this configuration option. For example:
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		ai: {
-     * 			review: {
-     * 				availableCommands: [
-     * 					'length', 'tone', 'clarity', 'readability'
-     * 				]
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     *
-     * @default [ 'custom', 'correctness', 'clarity', 'readability', 'length', 'tone' ]
-     */
-    availableCommands?: Array<string>;
-    /**
-     * List of extra review commands that can be added to the AI Review feature.
-     *
-     * Keep in mind that each command should have a unique ID that does not collide with predefined commands.
-     * The `custom` command ID is reserved and cannot be used as an ID for extra command.
-     *
-     * To add a command and expose it in the UI, first a command definition needs to be provided:
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		ai: {
-     * 			review: {
-     * 				extraCommands: [
-     * 					{
-     * 						id: 'improve-captions',
-     * 						label: 'Improve Captions',
-     * 						description: 'Improve image captions in the document.',
-     * 						prompt: 'Suggest improvements for the image captions in the document.',
-     * 					},
-     * 					{
-     * 						id: 'expand-abbreviations',
-     * 						label: 'Expand Abbreviations',
-     * 						description: 'Expand abbreviations in the document.',
-     * 						prompt: 'Suggest expansions for abbreviations in the document.',
-     * 						model: 'gpt-5-2' // Optional, if not set, default model will be used.
-     * 					}
-     * 				]
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     *
-     * Then if {@link #availableCommands} is not set, the extra commands will be added to the end of the list of available
-     * commands and visible in the UI by default. Otherwise, the extra commands need to be explicitly added to the list
-     * of available commands to be exposed in the UI:
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		ai: {
-     * 			review: {
-     * 				extraCommands: [ ... ],
-     * 				availableCommands: [
-     * 					'custom', 'correctness', 'clarity', 'readability', 'length', 'tone', 'improve-captions', 'expand-abbreviations'
-     * 				]
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     */
-    extraCommands?: Array<AIReviewCustomCommand>;
+	/**
+	* List of IDs of review commands that will be available in the AI Review feature UI. If not set, all available
+	* predefined commands will be used. The order of IDs defines the order of commands in the UI.
+	*
+	* The list of all predefined commands, used by default:
+	* - `custom`
+	* - `correctness`
+	* - `clarity`
+	* - `readability`
+	* - `length`
+	* - `tone`
+	*
+	* The commands can be used selectively and rearranged with this configuration option. For example:
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		ai: {
+	* 			review: {
+	* 				availableCommands: [
+	* 					'length', 'tone', 'clarity', 'readability'
+	* 				]
+	* 			}
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*
+	* @default [ 'custom', 'correctness', 'clarity', 'readability', 'length', 'tone' ]
+	*/
+	availableCommands?: Array<string>;
+	/**
+	* List of extra review commands that can be added to the AI Review feature.
+	*
+	* Keep in mind that each command should have a unique ID that does not collide with predefined commands.
+	* The `custom` command ID is reserved and cannot be used as an ID for extra command.
+	*
+	* To add a command and expose it in the UI, first a command definition needs to be provided:
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		ai: {
+	* 			review: {
+	* 				extraCommands: [
+	* 					{
+	* 						id: 'improve-captions',
+	* 						label: 'Improve Captions',
+	* 						description: 'Improve image captions in the document.',
+	* 						prompt: 'Suggest improvements for the image captions in the document.',
+	* 					},
+	* 					{
+	* 						id: 'expand-abbreviations',
+	* 						label: 'Expand Abbreviations',
+	* 						description: 'Expand abbreviations in the document.',
+	* 						prompt: 'Suggest expansions for abbreviations in the document.',
+	* 						model: 'gpt-5-2' // Optional, if not set, default model will be used.
+	* 					},
+	* 					{
+	* 						id: 'style-guide',
+	* 						label: 'Style Guide',
+	* 						description: 'Check the document against the style guide.',
+	* 						context: { id: 'style-guide', promptId: 'review-rules' }
+	* 					}
+	* 				]
+	* 			}
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*
+	* Then if {@link #availableCommands} is not set, the extra commands will be added to the end of the list of available
+	* commands and visible in the UI by default. Otherwise, the extra commands need to be explicitly added to the list
+	* of available commands to be exposed in the UI:
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		ai: {
+	* 			review: {
+	* 				extraCommands: [ ... ],
+	* 				availableCommands: [
+	* 					'custom', 'correctness', 'clarity', 'readability', 'length', 'tone', 'improve-captions', 'expand-abbreviations'
+	* 				]
+	* 			}
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*/
+	extraCommands?: Array<AIReviewCustomCommand>;
 }
+/**
+* An extra review command definition.
+*
+* The command needs a prompt source, provided in one of three ways:
+*
+* * an inline `prompt` string - sent as the prompt,
+* * a `context` reference - the referenced context drives the command (for example through a prompt it contains),
+* * both - the inline `prompt` is used and the `context` is attached as additional reference material (for example a file).
+*
+* The `model` property is optional. If not specified, the default model is used.
+*
+* ```ts
+* {
+*	id: 'improve-captions',
+*	label: 'Improve Captions',
+*	description: 'Improve image captions in the document.',
+*	prompt: 'Suggest improvements for the image captions in the document.'
+* }
+* ```
+*
+* The same command using a `context` reference instead of an inline `prompt`:
+*
+* ```ts
+* {
+*	id: 'improve-captions',
+*	label: 'Improve Captions',
+*	description: 'Improve image captions in the document.',
+*	context: { id: 'style-guide', promptId: 'improve-captions' }
+* }
+* ```
+*
+* An inline `prompt` combined with a `context` that attaches a single file as reference material:
+*
+* ```ts
+* {
+*	id: 'improve-captions',
+*	label: 'Improve Captions',
+*	description: 'Improve image captions in the document.',
+*	prompt: 'Suggest improvements for the image captions in the document.',
+*	context: { id: 'style-guide', fileId: 'caption-examples' }
+* }
+* ```
+*/
 export type AIReviewCustomCommand = {
-    id: string;
-    label: string;
-    description: string;
-    prompt: string;
-    model?: string;
+	id: string;
+	label: string;
+	description: string;
+	model?: string;
+	/**
+	* The prompt to be sent to the AI model when the command is executed.
+	*
+	* At least one prompt source is required: an inline `prompt`, a `context` that carries a prompt (a whole context
+	* or a `promptId` reference), or both. A `context` that references only a single file (`fileId`) cannot drive the
+	* command on its own and must be combined with an inline `prompt`.
+	*/
+	readonly prompt?: string;
+	/**
+	* A context reference attached to the command.
+	*
+	* When no inline `prompt` is provided, the referenced context drives the command (a whole context or a `promptId`
+	* reference). When combined with an inline `prompt`, it is attached as additional reference material (for example
+	* a single file).
+	*
+	* @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.
+	*/
+	readonly context?: AIContextRef;
 };

package/dist/aireviewmode/aireviewmodecheckregistry.d.ts

@@ -0,0 +1,46 @@
+/**
+* @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/aireviewmodecheckregistry
+*/
+import { type Context, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { CKEditorError } from "@ckeditor/ckeditor5-utils";
+import { AICore } from "../aicore/aicore.js";
+import { AIConnector } from "../aicore/aiconnector.js";
+import { AIErrorSink } from "../aicore/aierrorreporter.js";
+import { AIReviewCoreCheckRegistry } from "../aireviewcore/aireviewcorecheckregistry.js";
+import { type AIReviewCheckExtraDefinition } from "../aireviewcore/types.js";
+import { AIReviewModeCheckList } from "./model/aireviewmodechecklist.js";
+/**
+* Headless registry for the AI review check list. Owns the merge of built-in checks with `ai.review.extraCommands`,
+* the model list fetch required by custom/extra checks, and caching.
+*
+* Used by both `AIReviewModeController` (UI-driven flow) and `AIReviewGateway` (headless API) so they share the same source of truth
+* without the gateway depending on the UI controller.
+*/
+export declare class AIReviewModeCheckRegistry extends AIReviewCoreCheckRegistry<AIReviewModeCheckList> {
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIReviewModeCheckRegistry";
+	/**
+	* @inheritDoc
+	*/
+	static override get requires(): PluginDependenciesOf<[AIConnector, AIErrorSink, AICore]>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(context: Context | Editor);
+	/**
+	* The error captured during the last models fetch, or `null` if the fetch succeeded
+	* (or was not required because no custom/extra check was in scope).
+	*/
+	get modelsLoadError(): CKEditorError | null;
+	/**
+	* Reads the extra commands definitions from the configuration and returns
+	* them as an array of `AIReviewCheckExtraDefinition` objects.
+	*/
+	getExtraChecks(): Array<AIReviewCheckExtraDefinition>;
+}

package/dist/aireviewmode/aireviewmodecontroller.d.ts

@@ -1,20 +1,27 @@
 /**
- * @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 Context, type Editor } from '@ckeditor/ckeditor5-core';
-import { AIReviewCoreController } from '../aireviewcore/aireviewcorecontroller.js';
+* @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 { AIReviewCoreController } from "../aireviewcore/aireviewcorecontroller.js";
+import { AIErrorSink } from "../aicore/aierrorreporter.js";
+import { AICore } from "../aicore/aicore.js";
+import { AIReviewModeCheckRegistry } from "./aireviewmodecheckregistry.js";
+import type { PluginDependenciesOf, Context, Editor } from "@ckeditor/ckeditor5-core";
 export declare class AIReviewModeController extends AIReviewCoreController {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIReviewModeController";
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Context | Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): Promise<void>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIReviewModeController";
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AIErrorSink, AIReviewModeCheckRegistry, AICore]>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(context: Context | Editor);
+	/**
+	* @inheritDoc
+	*/
+	override init(): void;
 }