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

package/dist/aireviewmode/aireviewmodeui.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
- */
-import { AIReviewCoreView } from '../aireviewcore/ui/aireviewcoreview.js';
-import { AIReviewCoreUI } from '../aireviewcore/aireviewcoreui.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 { AIReviewCoreView } from "../aireviewcore/ui/aireviewcoreview.js";
+import { AIReviewCoreUI } from "../aireviewcore/aireviewcoreui.js";
 export declare class AIReviewModeUI extends AIReviewCoreUI {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIReviewModeUI";
-    /**
-     * @inheritDoc
-     */
-    createMainView(): AIReviewCoreView;
-    /**
-     * @inheritDoc
-     */
-    registerTab(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIReviewModeUI";
+	/**
+	* @inheritDoc
+	*/
+	createMainView(): AIReviewCoreView;
+	/**
+	* @inheritDoc
+	*/
+	registerTab(): void;
 }

package/dist/aireviewmode/model/aireviewcheckcustom.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/aireviewmode/model/aireviewcheckcustom
- */
-import { AIReviewCheck } from '../../aireviewcore/model/aireviewcheck.js';
-import { type AIModelData } from '../../aicore/aiconnector.js';
-import { type AIReviewCheckDefinition } from '../../aireviewcore/types.js';
+* @module ai/aireviewmode/model/aireviewcheckcustom
+*/
+import { AIReviewCheck } from "../../aireviewcore/model/aireviewcheck.js";
+import { type AIModelData } from "../../aicore/aiconnector.js";
+import { type AIReviewCheckDefinition } from "../../aireviewcore/types.js";
 /**
- * Represents the predefined custom check that can be performed in the AI Review Mode.
- */
+* Represents the predefined custom check that can be performed in the AI Review Mode.
+*/
 export declare class AIReviewCheckCustom extends AIReviewCheck {
-    /**
-     * @inheritDoc
-     */
-    constructor(checkDefinition: AIReviewCheckDefinition, models: Array<AIModelData>, defaultModel: AIModelData | null);
-    get models(): Array<AIModelData>;
-    get defaultModel(): AIModelData | null;
+	/**
+	* @inheritDoc
+	*/
+	constructor(checkDefinition: AIReviewCheckDefinition, models: Array<AIModelData>, defaultModel: AIModelData | null);
+	get models(): ReadonlyArray<AIModelData>;
+	get defaultModel(): AIModelData | null;
 }

package/dist/aireviewmode/model/aireviewcheckextra.d.ts

@@ -1,35 +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
- */
+* @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/model/aireviewcheckextra
- */
-import { type AIReviewCheckExtraDefinition } from '../../aireviewcore/types.js';
-import { type AIModelData } from '../../aicore/aiconnector.js';
-import { AIReviewCheck } from '../../aireviewcore/model/aireviewcheck.js';
+* @module ai/aireviewmode/model/aireviewcheckextra
+*/
+import { type AIReviewCheckExtraDefinition } from "../../aireviewcore/types.js";
+import { type AIModelData } from "../../aicore/aiconnector.js";
+import { type AIContextRef } from "../../aicore/model/aicontextref.js";
+import { AIReviewCheck } from "../../aireviewcore/model/aireviewcheck.js";
 /**
- * Represents the extra check that can be added via
- * {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands} configuration
- * and performed in the AI Review Mode.
- */
+* Represents the extra check that can be added via
+* {@link module:ai/aireviewmode/aireviewmode~AIReviewModeConfig#extraCommands} configuration
+* and performed in the AI Review Mode.
+*/
 export declare class AIReviewCheckExtra extends AIReviewCheck {
-    /**
-     * Whether the check is extra.
-     * Always `true` for this type of check.
-     */
-    isExtra: boolean;
-    /**
-     * The prompt text for this extra check run.
-     */
-    prompt: string;
-    /**
-     * The model for this extra check run.
-     */
-    model: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    constructor(checkDefinition: AIReviewCheckExtraDefinition, models: Array<AIModelData>, defaultModel: AIModelData | null);
-    get defaultModel(): AIModelData | null;
+	/**
+	* Whether the check is extra.
+	* Always `true` for this type of check.
+	*/
+	isExtra: boolean;
+	/**
+	* The prompt text for this extra check run. Not set when the check references a prompt through {@link #context}.
+	*/
+	prompt: string | undefined;
+	/**
+	* The context reference used instead of an inline {@link #prompt}.
+	*/
+	context: AIContextRef | undefined;
+	/**
+	* The model for this extra check run.
+	*/
+	model: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	constructor(checkDefinition: AIReviewCheckExtraDefinition, models: Array<AIModelData>, defaultModel: AIModelData | null);
+	get defaultModel(): AIModelData | null;
 }

package/dist/aireviewmode/model/aireviewcustomcheckrun.d.ts

@@ -1,22 +1,23 @@
 /**
- * @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/model/aireviewcustomcheckrun
- */
-import { AIReviewCheckRun } from '../../aireviewcore/model/aireviewcheckrun.js';
-import { type AIConnector } from '../../aicore/aiconnector.js';
-import { type AIDocumentData } from '../../aireviewcore/aireviewcoreediting.js';
-import { type AIReviewCheck } from '../../aireviewcore/model/aireviewcheck.js';
+* @module ai/aireviewmode/model/aireviewcustomcheckrun
+*/
+import { AIReviewCheckRun } from "../../aireviewcore/model/aireviewcheckrun.js";
+import { type AIConnector } from "../../aicore/aiconnector.js";
+import { type AIDocumentData } from "../../aireviewcore/aireviewcoreediting.js";
+import { type AIReviewCheck } from "../../aireviewcore/model/aireviewcheck.js";
+import { type AIContext } from "../../aicore/model/aicontext.js";
 /**
- * Represents a single custom review check
- * ({@link module:ai/aireviewmode/model/aireviewcheckcustom~AIReviewCheckCustom}) run and its results.
- */
+* Represents a single custom review check
+* ({@link module:ai/aireviewmode/model/aireviewcheckcustom~AIReviewCheckCustom}) run and its results.
+*/
 export declare class AIReviewCustomCheckRun extends AIReviewCheckRun {
-    constructor(prompt: string, model: string, documentData: AIDocumentData, sourceCheck: AIReviewCheck, connector: AIConnector);
-    /**
-     * @inheritDoc
-     */
-    get subTitle(): string;
+	constructor(prompt: string | undefined, model: string, documentData: AIDocumentData, sourceCheck: AIReviewCheck, connector: AIConnector, context?: AIContext);
+	/**
+	* @inheritDoc
+	*/
+	override get subTitle(): string;
 }

package/dist/aireviewmode/model/aireviewextracheckrun.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/aireviewmode/model/aireviewextracheckrun
- */
-import { AIReviewCustomCheckRun } from './aireviewcustomcheckrun.js';
+* @module ai/aireviewmode/model/aireviewextracheckrun
+*/
+import { AIReviewCustomCheckRun } from "./aireviewcustomcheckrun.js";
 /**
- * Represents a single extra review check
- * ({@link module:ai/aireviewmode/model/aireviewcheckextra~AIReviewCheckExtra}) run and its results.
- */
+* Represents a single extra review check
+* ({@link module:ai/aireviewmode/model/aireviewcheckextra~AIReviewCheckExtra}) run and its results.
+*/
 export declare class AIReviewExtraCheckRun extends AIReviewCustomCheckRun {
-    /**
-     * @inheritDoc
-     */
-    get subTitle(): string;
-    set prompt(value: string);
-    set model(value: string);
+	/**
+	* @inheritDoc
+	*/
+	override get subTitle(): string;
+	set prompt(value: string);
+	set model(value: string);
 }

package/dist/aireviewmode/model/aireviewmodechecklist.d.ts

@@ -1,23 +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
- */
+* @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/model/aireviewmodechecklist
- */
-import { AIReviewCheckList } from '../../aireviewcore/model/aireviewchecklist.js';
-import { type AIReviewCheckBaseDefinition } from '../../aireviewcore/types.js';
-import { type AIModelData } from '../../aicore/aiconnector.js';
+* @module ai/aireviewmode/model/aireviewmodechecklist
+*/
+import { AIReviewCheckList } from "../../aireviewcore/model/aireviewchecklist.js";
+import { type AIReviewCheckBaseDefinition } from "../../aireviewcore/types.js";
+import { type AIModelData } from "../../aicore/aiconnector.js";
 /**
- * Represents the list of translate checks that can be performed in the AI Translate.
- */
+* Represents the list of translate checks that can be performed in the AI Translate.
+*/
 export declare class AIReviewModeCheckList extends AIReviewCheckList {
-    /**
-     * @inheritDoc
-     */
-    constructor(allModels: Array<AIModelData>, recommendedModels: Array<AIModelData>, defaultModel: AIModelData | null);
-    /**
-     * @inheritDoc
-     */
-    setupChecks(checks: Array<AIReviewCheckBaseDefinition>): void;
+	/**
+	* @inheritDoc
+	*/
+	constructor(allModels: Array<AIModelData>, recommendedModels: Array<AIModelData>, defaultModel: AIModelData | null);
+	/**
+	* The list of available models for the checks that require it.
+	*/
+	get allModels(): ReadonlyArray<AIModelData>;
+	/**
+	* @inheritDoc
+	*/
+	override setupChecks(checks: Array<AIReviewCheckBaseDefinition>): void;
 }

package/dist/aireviewmode/ui/aireviewmodecheckresultsview.d.ts

@@ -0,0 +1,41 @@
+/**
+* @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/ui/aireviewmodecheckresultsview
+*/
+import { AIReviewCoreUICheckResultsView } from "../../aireviewcore/ui/aireviewcoreuicheckresultsview.js";
+import { type AIReviewCheckResultChange } from "../../aireviewcore/model/aireviewcheckresultchange.js";
+/**
+* The AI Review results panel.
+*
+* Renders each change with the suggestion content part the chat feed uses, instead of the review tile the base
+* class renders. Only AI Review does this; AI Translate keeps the base rendering.
+*/
+export declare class AIReviewModeCheckResultsView extends AIReviewCoreUICheckResultsView {
+	/**
+	* @inheritDoc
+	*/
+	override clearResults(): void;
+	/**
+	* @inheritDoc
+	*/
+	override addResult(result: AIReviewCheckResultChange, isAcceptButtonVisible: boolean, isSuggestButtonVisible: boolean): void;
+	/**
+	* @inheritDoc
+	*/
+	override updateChangeState(id: string, status: AIReviewCheckResultChange["status"]): void;
+	/**
+	* @inheritDoc
+	*/
+	override setActiveResult(id: string): void;
+	/**
+	* @inheritDoc
+	*/
+	override resetActiveResults(): void;
+	/**
+	* @inheritDoc
+	*/
+	override getResultElement(id: string): HTMLElement | null;
+}

package/dist/aisdk/dataidassigner.d.ts

@@ -0,0 +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
+*/
+/**
+* @module ai/aisdk/dataidassigner
+*/
+import { type Editor } from "@ckeditor/ckeditor5-core";
+import { type ViewDocumentFragment, type ViewElement } from "@ckeditor/ckeditor5-engine";
+/**
+* Assigns a unique `data-id` to the structural view elements that lack one — container, empty and raw elements, plus
+* any element containing an id-bearing descendant (skipping `<br>`). Existing ids are preserved.
+*/
+export declare class DataIdAssigner {
+	constructor(editor: Editor);
+	/**
+	* Assigns the missing `data-id`s across the given view fragment (or element).
+	*/
+	assign(view: ViewElement | ViewDocumentFragment): void;
+}

package/dist/aisdk/documentchanges.d.ts

@@ -0,0 +1,165 @@
+/**
+* @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/aisdk/documentchanges
+*/
+import { ContextPlugin, Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ModelPosition, type ModelWriter, type ModelDocumentFragment, type ModelElement, type Operation } from "@ckeditor/ckeditor5-engine";
+import { DocumentChangesUtils } from "./documentchangesutils.js";
+export declare const DATA_ID_MODEL_ATTRIBUTE = "$elementId";
+export declare const DATA_ID_VIEW_ATTRIBUTE = "data-id";
+/**
+* The `DocumentChanges` plugin provides utilities to compare two documents or documents fragments, and provide set of operations
+* which need to be executed to transform one document into the other.
+*/
+export declare class DocumentChanges extends ContextPlugin {
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "DocumentChanges";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	static get requires(): PluginDependenciesOf<[DocumentChangesUtils]>;
+	init(): Promise<void>;
+	get editor(): Editor;
+	/**
+	* Compares two HTML strings and returns the operations that transform `dataBefore` into `dataAfter`.
+	*
+	* @param dataBefore The HTML to transform from.
+	* @param dataAfter The HTML to transform into.
+	* @param options Diffing options.
+	* @returns Operations that need to be applied to transform `dataBefore` into `dataAfter`.
+	*/
+	getDiff(dataBefore: string, dataAfter: string, options?: DocumentChangesOptions): Array<Operation>;
+	/**
+	* Returns `true` if given `operation` is an operation that marks a content to be removed. This kind of operations can be
+	* returned by {@link module:ai/aisdk/documentchanges~DocumentChanges#getOperations} if `markedDeletions` mode is enabled.
+	*
+	* @param operation
+	*/
+	isMarkedRemoveOperation(operation: Operation): boolean;
+	/**
+	* Applies the given operations (for example, the result of comparing two documents) to the model.
+	*
+	* Beyond applying the operations, this method reproduces the marker bookkeeping that the editing pipeline normally
+	* performs, so that existing markers behave the same as during regular editing:
+	*
+	* * markers affected by a move or merge are anchored, so they can be restored on undo;
+	* * marker operations have their `oldRange` reconciled with the live marker, as operations coming from a comparison
+	* have it set to `null`.
+	*
+	* Must be called inside a model change block; the operations are added to the given `writer`'s batch.
+	*
+	* @param writer Writer of the change block the operations are applied within.
+	* @param operations Operations to apply, in order.
+	*/
+	applyOperations(writer: ModelWriter, operations: Array<Operation>): void;
+}
+export interface DocumentChangesOptions {
+	anchor?: string | ModelPosition;
+	markDeletions: boolean;
+	/**
+	* The editor whose model/schema should be used for parsing and for resolving a string `anchor` (e.g. multi-root root names).
+	*/
+	targetEditor?: Editor;
+}
+export interface InsertOperationData {
+	type: "insert";
+	path: Path;
+	tokens: Array<ModelToken>;
+}
+export interface RemoveOperationData {
+	type: "remove";
+	path: Path;
+	howMany: number;
+}
+export interface SplitOperationData {
+	type: "split";
+	path: Path;
+}
+export interface MergeOperationData {
+	type: "merge";
+	path: Path;
+}
+export interface RenameOperationData {
+	type: "rename";
+	path: Path;
+	oldName: string;
+	newName: string;
+}
+export interface AttributeOperationData {
+	type: "attribute";
+	path: Path;
+	howMany: number;
+	key: string;
+	oldValue: string;
+	newValue: string;
+}
+export interface MarkerOperationData {
+	type: "marker";
+	name: string;
+	range: null | {
+		start: Path;
+		end: Path;
+	};
+}
+export interface UnwrapOperationData {
+	type: "unwrap";
+	path: Path;
+	howMany: number;
+}
+export interface WrapOperationData {
+	type: "wrap";
+	token: ModelElementToken;
+	range: {
+		start: Path;
+		end: Path;
+	};
+}
+export interface MarkedRemoveData {
+	type: "markedRemove";
+	range: {
+		start: Path;
+		end: Path;
+	};
+}
+export type OperationData = InsertOperationData | RemoveOperationData | SplitOperationData | MergeOperationData | RenameOperationData | AttributeOperationData | MarkerOperationData | UnwrapOperationData | WrapOperationData | MarkedRemoveData;
+export type ModelToken = ModelElementToken | ModelTextToken;
+export interface ModelElementToken {
+	type: "element";
+	element: ModelElement;
+	elementId: string;
+	/**
+	* Elements category.
+	*
+	* Describes how the element behaves and how it can change. It is used when comparing lists of model tokens to create a better diff.
+	*
+	* * `block` - elements like paragraphs, lists, or headings. Can be renamed. Can be created by splitting. Can be removed by merging.
+	* Its contents can be "moved around" by splitting or merging.
+	*
+	* * `container` - elements like blockquote. Cannot be renamed. Can be created by wrapping. Can be removed by unwrapping. Can be
+	* "resized" by having other elements be moved into or out of them.
+	*
+	* * `solid` - limit-like elements like table or image. Cannot be renamed, split or merged. Can be added by insertion and removed by
+	* deletion. If added or removed, all their content also should be treated as added or removed.
+	*/
+	category: "block" | "container" | "solid";
+	isStart: boolean;
+	limitId: string;
+}
+export interface ModelTextToken {
+	type: "text";
+	data: string;
+	parent: ModelElement | ModelDocumentFragment;
+	offset: number;
+	limitId: string;
+}
+export type Path = Array<number>;

package/dist/aisdk/documentchangesutils.d.ts

@@ -0,0 +1,15 @@
+/**
+* @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/aisdk/documentchangesutils
+*/
+import { ContextPlugin } from "@ckeditor/ckeditor5-core";
+export declare class DocumentChangesUtils extends ContextPlugin {
+	static get pluginName(): "DocumentChangesUtils";
+	static override get isOfficialPlugin(): true;
+	static override get isPremiumPlugin(): true;
+	init(): void;
+	override destroy(): void;
+}