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

package/dist/aichat/aichat.d.ts

@@ -1,95 +1,96 @@
 /**
- * @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/aichat/aichat
- * @publicApi
- */
-import { type Context, ContextPlugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { AIChatController } from './aichatcontroller.js';
-import { AIEditing } from '../aicore/aiediting.js';
-import { AIChatUI } from './aichatui.js';
-import { type AIChatContextConfig } from './model/aichatcontext.js';
-import { AIChatHistory } from '../aichathistory/aichathistory.js';
+* @module ai/aichat/aichat
+* @publicApi
+*/
+import { type Context, ContextPlugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AIChatController } from "./aichatcontroller.js";
+import { AIEditing } from "../aicore/aiediting.js";
+import { AIChatUI } from "./aichatui.js";
+import { type AIChatContextConfig } from "./model/aichatcontext.js";
+import { AIChatHistory } from "../aichathistory/aichathistory.js";
+import { AIDocumentProcessingGateway } from "../aidocumentprocessing/aidocumentprocessinggateway.js";
 /**
- * The AI Chat feature. It brings a conversational AI that can be used to aid content creation and editing. It introduces a dynamic chat
- * interface designed to facilitate rich, multi-turn interactions between users and an AI Assistant.
- *
- * You can configure the feature by setting the {@link module:ai/aichat/aichat~AIChatConfig} property.
- *
- * See {@link module:ai/aichat/aichatcontroller~AIChatController} to learn about the public API available for this feature.
- *
- * Learn more about AI features in CKEditor in the {@glink features/ai/ckeditor-ai-overview AI Overview} documentation.
- */
+* The AI Chat feature. It brings a conversational AI that can be used to aid content creation and editing. It introduces a dynamic chat
+* interface designed to facilitate rich, multi-turn interactions between users and an AI Assistant.
+*
+* You can configure the feature by setting the {@link module:ai/aichat/aichat~AIChatConfig} property.
+*
+* See {@link module:ai/aichat/aichatcontroller~AIChatController} to learn about the public API available for this feature.
+*
+* Learn more about AI features in CKEditor in the {@glink features/ai/ckeditor-ai-overview AI Overview} documentation.
+*/
 export declare class AIChat extends ContextPlugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AIChatController, typeof AIEditing, typeof AIChatUI, typeof AIChatHistory];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIChat";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    constructor(context: Context | Editor);
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AIChatController, AIEditing, AIChatUI, AIChatHistory, AIDocumentProcessingGateway]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIChat";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	constructor(context: Context | Editor);
 }
 /**
- * The configuration of the {@link module:ai/aichat/aichat~AIChat AI Chat feature}.
- *
- * The properties defined in this config are set in the `config.ai.chat` namespace.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		ai: {
- * 			chat: {
- * 				// AI Chat configuration.
- * 			}
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:ai/aiconfig~AIConfig the full AI configuration}.
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the {@link module:ai/aichat/aichat~AIChat AI Chat feature}.
+*
+* The properties defined in this config are set in the `config.ai.chat` namespace.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		ai: {
+* 			chat: {
+* 				// AI Chat configuration.
+* 			}
+* 		}
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:ai/aiconfig~AIConfig the full AI configuration}.
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface AIChatConfig {
-    /**
-     * The configuration of the AI Chat context.
-     *
-     * Read more in {@link module:ai/aichat/model/aichatcontext~AIChatContextConfig}.
-     */
-    context: AIChatContextConfig;
-    /**
-     * Decides which conversation will be loaded after the feature has initialized.
-     *
-     * Possible values are:
-     *
-     * * `'new'` - a new conversation is started (default),
-     * * `'lastCreated'` - the most recently created conversation will be loaded,
-     * * conversation ID - the conversation with given ID will be loaded.
-     *
-     * If `'lastCreated'` is set while the conversation history is empty, a new conversation will be started instead.
-     *
-     * If the conversation with the specified ID is not found, an error will be thrown.
-     *
-     * @default 'new'
-     */
-    initialConversation?: string;
-    /**
-     * The welcome message to be displayed when the AI chat is initialized. When not set, the default welcome message will be used.
-     *
-     * @default 'Hi! I can help you draft, rewrite, and improve your text, explore ideas, research topics, and solve problems. How can I help right now?'
-     */
-    welcomeMessage?: string;
+	/**
+	* The configuration of the AI Chat context.
+	*
+	* Read more in {@link module:ai/aichat/model/aichatcontext~AIChatContextConfig}.
+	*/
+	context: AIChatContextConfig;
+	/**
+	* Decides which conversation will be loaded after the feature has initialized.
+	*
+	* Possible values are:
+	*
+	* * `'new'` - a new conversation is started (default),
+	* * `'lastCreated'` - the most recently created conversation will be loaded,
+	* * conversation ID - the conversation with given ID will be loaded.
+	*
+	* If `'lastCreated'` is set while the conversation history is empty, a new conversation will be started instead.
+	*
+	* If the conversation with the specified ID is not found, an error will be thrown.
+	*
+	* @default 'new'
+	*/
+	initialConversation?: string;
+	/**
+	* The welcome message to be displayed when the AI chat is initialized. When not set, the default welcome message will be used.
+	*
+	* @default 'Hi! I can help you draft, rewrite, and improve your text, explore ideas, research topics, and solve problems. How can I help right now?'
+	*/
+	welcomeMessage?: string;
 }

package/dist/aichat/aichatballoon.d.ts

@@ -1,99 +1,108 @@
 /**
- * @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/aichat/aichatballoon
- */
-import { type Editor, Plugin } from '@ckeditor/ckeditor5-core';
-import { AIBalloon, type AIBalloonConfig } from '../aiballoon/aiballoon.js';
-import { type AISuggestionContentPartDefinition } from '../aicore/utils/getsuggestionpartsfromreply.js';
-import { type AIContentRenderingStrategy } from '../aicore/ui/suggestioncontainer/aisuggestionstreamablecontentview.js';
-import { type AIReplyChangeGroupState } from '../aicore/model/aireply.js';
-import { Dialog } from '@ckeditor/ckeditor5-ui';
+* @module ai/aichat/aichatballoon
+*/
+import { type Editor, Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AIBalloon, type AIBalloonConfig } from "../aiballoon/aiballoon.js";
+import { type AISuggestionContentPartDefinition } from "../aicore/utils/getsuggestionpartsfromreply.js";
+import { type AIContentRenderingStrategy } from "../aicore/ui/suggestioncontainer/aisuggestionstreamablecontentview.js";
+import { type AIReplyChangeGroupState, type AIReplyChangeGroupOutdatedReason } from "../aicore/model/aireply.js";
+import { Dialog } from "@ckeditor/ckeditor5-ui";
 /**
- * The plugin responsible for the AI Balloon dialog in the Chat UI.
- *
- * * It depends on the API of the `AIBalloon` plugin.
- * * It uses the `AIChatBalloonView` to display the suggestion part in the `AIBalloon`.
- */
+* The plugin responsible for the AI Balloon dialog in the Chat UI.
+*
+* * It depends on the API of the `AIBalloon` plugin.
+* * It uses the `AIChatBalloonView` to display the suggestion part in the `AIBalloon`.
+*/
 export declare class AIChatBalloon extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Dialog, typeof AIBalloon];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIChatBalloon";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * Observable property that indicates whether the suggestion display mode is "show changes".
-     */
-    showDiff: boolean;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * Opens the AI Balloon dialog.
-     */
-    open(config: Omit<AIChatBalloonConfig, 'class' | 'id' | 'mainView'>): void;
-    /**
-     * Closes the AI Balloon dialog.
-     */
-    close(): void;
-    /**
-     * Updates the content of the suggestion part displayed in the balloon.
-     */
-    updateContent(options: {
-        part: AISuggestionContentPartDefinition;
-        renderingStrategy: AIContentRenderingStrategy;
-        abortSignal?: AbortSignal;
-        keepErrors?: boolean;
-    }): Promise<void>;
-    /**
-     * Sets the state of the suggestion part displayed in the balloon (accepted, rejected, pending, etc.).
-     */
-    setState(state: AIReplyChangeGroupState): void;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Dialog, AIBalloon]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIChatBalloon";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* Observable property that indicates whether the suggestion display mode is "show changes".
+	*/
+	showDiff: boolean;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* Opens the AI Balloon dialog.
+	*/
+	open(config: Omit<AIChatBalloonConfig, "class" | "id" | "mainView">): void;
+	/**
+	* Closes the AI Balloon dialog.
+	*/
+	close(): void;
+	/**
+	* Updates the content of the suggestion part displayed in the balloon.
+	*/
+	updateContent(options: {
+		part: AISuggestionContentPartDefinition;
+		renderingStrategy: AIContentRenderingStrategy;
+		abortSignal?: AbortSignal;
+		keepErrors?: boolean;
+	}): Promise<void>;
+	/**
+	* Clears the content of the suggestion part displayed in the balloon.
+	*/
+	clearContent(): void;
+	/**
+	* Sets the state of the suggestion part displayed in the balloon (accepted, rejected, pending, etc.).
+	*/
+	setState(state: AIReplyChangeGroupState, outdatedReason?: AIReplyChangeGroupOutdatedReason): void;
+	/**
+	* Updates the read-only state of the previewed suggestion's target editor. Called by the controller.
+	*/
+	setTargetReadOnly(isReadOnly: boolean): void;
 }
 type AIChatBalloonConfig = AIBalloonConfig & {
-    areActionsDisabled: boolean;
-    showRotator: boolean;
+	areActionsDisabled: boolean;
+	showRotator: boolean;
+	isTargetReadOnly: boolean;
 };
 /**
- * Event fired when user toggles the suggestion display mode.
- */
+* Event fired when user toggles the suggestion display mode.
+*/
 export type AIChatBalloonToggleSuggestionDisplayModeEvent = {
-    name: 'toggleSuggestionDisplayMode';
-    args: [];
+	name: "toggleSuggestionDisplayMode";
+	args: [];
 };
 /**
- * Event fired when user clicks the apply button to apply a suggestion.
- */
+* Event fired when user clicks the apply button to apply a suggestion.
+*/
 export type AIChatBalloonApplySuggestionEvent = {
-    name: 'applySuggestion';
-    args: [];
+	name: "applySuggestion";
+	args: [];
 };
 /**
- * Event fired when user clicks the suggest button to insert a suggestion.
- */
+* Event fired when user clicks the suggest button to insert a suggestion.
+*/
 export type AIChatBalloonInsertSuggestionEvent = {
-    name: 'insertSuggestion';
-    args: [];
+	name: "insertSuggestion";
+	args: [];
 };
 /**
- * Event fired when user clicks the reject button to reject a suggestion.
- */
+* Event fired when user clicks the reject button to reject a suggestion.
+*/
 export type AIChatBalloonRejectSuggestionEvent = {
-    name: 'rejectSuggestion';
-    args: [];
+	name: "rejectSuggestion";
+	args: [];
 };
 export {};