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

package/dist/aicore/utils/markoperationsasai.d.ts

@@ -0,0 +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
+*/
+/**
+* @module ai/aicore/utils/markoperationsasai
+*/
+import type { Operation } from "@ckeditor/ckeditor5-engine";
+/**
+* Identifiers used by built-in AI features when tagging the operations they produce.
+*/
+export type AIOperationSource = "chat" | "quickActions" | "api" | "review" | "translate" | (string & {});
+/**
+* Sets the AI source identifier on a list of operations. After this call, every non-no-op operation has its
+* `_aiSource` field set to `source` and is preserved through collaborative transmission.
+*
+* No-op operations are skipped on purpose — they describe no change, so labelling them would tag transformed
+* AI work that ended up empty (for example, when a concurrent user edit cancelled out the AI change).
+*
+* Use this helper when an AI feature produces operations and you want downstream consumers (notably track-changes
+* suggestion creation) to recognize them as AI-originated.
+*/
+export declare function markOperationsAsAI(operations: Iterable<Operation>, source: AIOperationSource): void;

package/dist/aicore/utils/scrollmanager.d.ts

@@ -1,27 +1,28 @@
 /**
- * @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
+*/
 /**
- * The scroll manager for an element. Once started, it auto-scrolls to the bottom of the element as its
- * children change unless the user interacts with the element.
- */
+* The scroll manager for an element. Once started, it auto-scrolls to the bottom of the element as its
+* children change unless the user interacts with the element.
+*/
 export declare class ScrollManager {
-    constructor(element: HTMLElement);
-    /**
-     * Starts the auto-scrolling.
-     *
-     * @param options.smooth When `false`, the scroll jumps instantly instead of animating. Defaults to `true`.
-     */
-    start({ smooth }?: {
-        smooth?: boolean;
-    }): void;
-    /**
-     * Stops the auto-scrolling.
-     */
-    stop(): void;
-    /**
-     * Destroys the scroll manager.
-     */
-    destroy(): void;
+	constructor(element: HTMLElement);
+	/**
+	* Starts the auto-scrolling.
+	*
+	* @param options Scrolling options.
+	* @param options.smooth When `false`, the scroll jumps instantly instead of animating. Defaults to `true`.
+	*/
+	start({ smooth }?: {
+		smooth?: boolean;
+	}): void;
+	/**
+	* Stops the auto-scrolling.
+	*/
+	stop(): void;
+	/**
+	* Destroys the scroll manager.
+	*/
+	destroy(): void;
 }

package/dist/aicore/utils/showaitab.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/aidocumentprocessing/aidocumentprocessinggateway.d.ts

@@ -0,0 +1,87 @@
+/**
+* @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/aidocumentprocessing/aidocumentprocessinggateway
+* @publicApi
+*/
+import { ContextPlugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AIConnector, type AIModelData } from "../aicore/aiconnector.js";
+import { AIEditing } from "../aicore/aiediting.js";
+import { AIGateway, type AIRunBaseOptions, type AIGatewayApplyOptions } from "../aicore/aigateway.js";
+import { AIDocumentProcessingRunResult } from "./model/aidocumentprocessingrunresult.js";
+export type AIDocumentProcessingRunOptions = AIRunBaseOptions & {
+	/**
+	* The model that will be used to run the document processing request.
+	* The ids of an AI models can be acquired
+	* via {@link module:ai/aidocumentprocessing/aidocumentprocessinggateway~AIDocumentProcessingGateway#getAvailableModels} call.
+	*/
+	model: string;
+};
+/**
+* Headless, stateless API for performing AI-powered transformations on entire documents through the `/documents/process` endpoint.
+* Similar to sending a single message through the {@link module:ai/aichat/aichat~AIChat AI Chat plugin}.
+*
+* This API provides a simple document-processing workflow: a single `prompt` is applied to a single `document`, producing
+* a transformed document with all AI-generated changes already applied.
+*
+* For multi-root editors, only the first non-`$graveyard` root is processed. Other roots are neither sent to the endpoint nor
+* modified when the transformation result is applied.
+*/
+export declare class AIDocumentProcessingGateway extends ContextPlugin {
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIDocumentProcessingGateway";
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AIConnector, AIEditing, AIGateway]>;
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* Returns the list of AI models that can be used with document processing API.
+	*
+	* 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 document processing request and returns
+	* the {@link module:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult detailed result}.
+	*
+	* The result can then be applied to the editor via {@link #applyResult}. 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'`.
+	*
+	* In multi-root editors, only the first non-`$graveyard` root is sent to the endpoint and reflected in the returned
+	* result. Other roots are ignored.
+	*
+	* @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 against the document.
+	* @param options Optional `signal` to allow aborting the run.
+	*/
+	processDocument(prompt: string, options: AIDocumentProcessingRunOptions): Promise<AIDocumentProcessingRunResult>;
+	/**
+	* Applies the document processing result (produced by {@link #processDocument}) to the editor content, either as direct
+	* changes or as track changes suggestions.
+	*
+	* This is a proxy to {@link module:ai/aicore/aigateway~AIGateway#apply}.
+	*
+	* @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 run.
+	* @param applyOptions Options for applying the changes to the editor content.
+	*/
+	applyResult(result: AIDocumentProcessingRunResult, applyOptions: AIGatewayApplyOptions): void;
+}

package/dist/aidocumentprocessing/model/aidocumentprocessingrunresult.d.ts

@@ -0,0 +1,19 @@
+/**
+* @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/aidocumentprocessing/model/aidocumentprocessingrunresult
+* @publicApi
+*/
+import { AIRunResult } from "../../aicore/model/airunresult.js";
+/**
+* The result of an AI document processing run.
+*/
+export declare class AIDocumentProcessingRunResult extends AIRunResult {
+	/**
+	* The summary of changes produced by the run.
+	*/
+	get summary(): string;
+	set summary(value: string);
+}

package/dist/aieditorintegration/aieditorintegration.d.ts

@@ -1,37 +1,37 @@
 /**
- * @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/aieditorintegration/aieditorintegration
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { AIToggleButtonUI } from './aitogglebutton/aitogglebuttonui.js';
-import { AIChatBalloon } from '../aichat/aichatballoon.js';
-import { SuggestionsConversion } from '@ckeditor/ckeditor5-collaboration-core';
+* @module ai/aieditorintegration/aieditorintegration
+* @publicApi
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AIToggleButtonUI } from "./aitogglebutton/aitogglebuttonui.js";
+import { AIChatBalloon } from "../aichat/aichatballoon.js";
+import { SuggestionsConversion } from "@ckeditor/ckeditor5-collaboration-core";
 /**
- * The AI Editor Integration plugin. It registers AI-related components in the editor
- * and provides the necessary UI elements for AI functionality.
- *
- * This plugin works alongside context plugins that provide specific AI features,
- * handling the editor-level integration and toolbar controls.
- */
+* The AI Editor Integration plugin. It registers AI-related components in the editor
+* and provides the necessary UI elements for AI functionality.
+*
+* This plugin works alongside context plugins that provide specific AI features,
+* handling the editor-level integration and toolbar controls.
+*/
 export declare class AIEditorIntegration extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AIToggleButtonUI, typeof AIChatBalloon, typeof SuggestionsConversion];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIEditorIntegration";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AIToggleButtonUI, AIChatBalloon, SuggestionsConversion]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIEditorIntegration";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
 }

package/dist/aieditorintegration/aitogglebutton/aitogglebuttonui.d.ts

@@ -1,39 +1,39 @@
 /**
- * @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/aieditorintegration/aitogglebutton/aitogglebuttonui
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { AITabs } from '../../aitabs/aitabs.js';
-import '../../../theme/aieditorintegration/aitogglebutton.css';
+* @module ai/aieditorintegration/aitogglebutton/aitogglebuttonui
+* @publicApi
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AITabs } from "../../aitabs/aitabs.js";
+import "../../../theme/aieditorintegration/aitogglebutton.css";
 /**
- * Registers the `toggleAi` toolbar button that toggles the visibility of AI tabs.
- *
- * Context plugins can’t register toolbar items via the editor’s component factory, so this is provided as a dedicated editor plugin.
- * Include this plugin in the editor configuration to enable the button.
- */
+* Registers the `toggleAi` toolbar button that toggles the visibility of AI tabs.
+*
+* Context plugins can’t register toolbar items via the editor’s component factory, so this is provided as a dedicated editor plugin.
+* Include this plugin in the editor configuration to enable the button.
+*/
 export declare class AIToggleButtonUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AITabs];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIToggleButtonUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AITabs]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIToggleButtonUI";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/aieditorintegration/aitogglebutton/toggleaicommand.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/aieditorintegration/aitogglebutton/toggleaicommand
- * @publicApi
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+* @module ai/aieditorintegration/aitogglebutton/toggleaicommand
+* @publicApi
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
 export declare class ToggleAICommand extends Command {
-    constructor(editor: Editor);
-    /**
-     * @inheritdoc
-     */
-    execute(): void;
+	constructor(editor: Editor);
+	/**
+	* @inheritdoc
+	*/
+	override execute(): void;
 }