@ckeditor/ckeditor5-ai 47.6.1 → 48.0.0-alpha.0

package/{src/aichat/aichat.d.ts → dist/aichat/aichatcontroller.d.ts}

@@ -3,35 +3,37 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 /**
- * @module ai/aichat/aichat
+ * @module ai/aichat/aichatcontroller
  * @publicApi
  */
-import { type Context, ContextPlugin, type Editor } from 'ckeditor5/src/core.js';
-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 { ContextPlugin } from '@ckeditor/ckeditor5-core';
+import { AIConnector } from '../aicore/aiconnector.js';
+import { AIChatConversation, type AIChatInteractionCreatedEvent } from './model/aichatconversation.js';
+import { type AIInteractionReplyCreatedEvent, type AIToolData } from '../aicore/model/aiinteraction.js';
 import { type AIChatInteraction } from './model/aichatinteraction.js';
-import { type AIToolData } from '../aicore/model/aiinteraction.js';
+import { DocumentCompare } from '@ckeditor/ckeditor5-collaboration-core';
 import { type AIChatFeedCustomElementView } from './ui/feed/aichatfeedcustomelementview.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.
+ * Implements integration layer between AI Chat feature UI and logic.
  *
- * You can configure the feature by setting the {@link module:ai/aichat/aichat~AIChatConfig} property.
+ * Provides an API to interact with AI Chat feature.
  *
- * Learn more about AI features in CKEditor in the {@glink features/ai/ckeditor-ai-overview AI Overview} documentation.
+ * @experimental **Experimental:** Some methods of this class are production-ready but experimental and may change
+ * in minor releases without the standard deprecation policy. Check the changelog for migration guidance.
  */
-export declare class AIChat extends ContextPlugin {
+export declare class AIChatController extends ContextPlugin {
+    /**
+     * Active conversation (currently open and visible in UI).
+     */
+    activeConversation?: AIChatConversation;
     /**
      * @inheritDoc
      */
-    static get requires(): readonly [typeof AIChatController, typeof AIEditing, typeof AIChatUI, typeof AIChatHistory];
+    static get requires(): readonly [typeof AIConnector, typeof DocumentCompare];
     /**
      * @inheritDoc
      */
-    static get pluginName(): "AIChat";
+    static get pluginName(): "AIChatController";
     /**
      * @inheritDoc
      */
@@ -40,33 +42,22 @@ export declare class AIChat extends ContextPlugin {
      * @inheritDoc
      */
     static get isPremiumPlugin(): true;
-    constructor(context: Context | Editor);
-    addSelectionToChatContext(): Promise<void>;
-    startConversation(): Promise<void>;
     /**
-     * Submits a user message to the currently active conversation.
-     *
-     * You can pass additional parameters with the message using the `attributes` property.
-     *
-     * The following properties are currently supported in `attributes`:
-     *
-     * * `displayedPrompt` (`string`) - If set, will be displayed instead of the actual `message`. You can use it to display a shorter,
-     * or otherwise different or friendlier user message. This is also respected in the conversation history. Original `message` will
-     * still be used to query the AI model.
-     *
-     * Besides supported properties, `attributes` can be used to save any additional metadata with the message, which can be used by your
-     * integration in any way. Data passed in `attributes` will be saved in the conversation history. If your integration connects external
-     * custom AI tools, `attributes` are passed to the tool calls and can be used by these tools.
-     *
-     * @param message User message, used to query the AI model.
-     * @param attributes Additional metadata and options.
+     * @inheritDoc
      */
-    sendMessage({ message, attributes }: {
-        message: string;
-        attributes?: Record<string, unknown>;
-    }): Promise<void>;
-    removeSelectionFromChatContext(): void;
-    focusPromptInput(): void;
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): Promise<void>;
+    /**
+     * @inheritDoc
+     */
+    destroy(): Promise<void>;
+    /**
+     * Loads a conversation by its ID and sets it as the active conversation.
+     */
+    loadConversation(conversationId: string): Promise<void>;
     /**
      * Registers a function that is called when data from a custom AI tool is received from the backend service.
      *
@@ -76,9 +67,9 @@ export declare class AIChat extends ContextPlugin {
      *
      * When data is received, the callback is immediately called with two parameters:
      *
-     * * `toolData` – data returned by the tool,
-     * * `api` – the {@link module:ai/aichat/aichat~AIChatInteractionAPI AI Chat Interaction API},
-     * enables manipulating the current interaction according to the received data.
+     * * `toolData` – data returned by the AI tool,
+     * * `api` – {@link module:ai/aichat/aichatcontroller~AIChatFeedAPI set of tools} which you can use to reflect the received AI tool data
+     * in the AI chat feed.
      *
      * The callback is called for data received from all tools that you have connected, and both for tool results and tool notifications.
      * Check `toolData.toolName` and `toolData.type` to handle various tools and actions. You can register multiple callbacks to better
@@ -124,67 +115,92 @@ export declare class AIChat extends ContextPlugin {
      * } );
      * ```
      *
+     * @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 callback A callback function that is called when tool data is received.
      */
     registerToolDataCallback(callback: AIToolEventCallback): void;
-}
-/**
- * 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( editorElement, {
- * 		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}.
+     * Adds the current document to the chat context.
      */
-    context: AIChatContextConfig;
+    addCurrentDocumentToChatContext(): void;
     /**
-     * Decides which conversation will be loaded after the feature has initialized.
-     *
-     * Possible values are:
+     * Adds current document selection to the conversation context. If document is not added to the context, it is added as well.
      *
-     * * `'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.
+     * @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.
+     */
+    addSelectionToChatContext(): Promise<void>;
+    /**
+     * Removes current document selection from the conversation context.
      *
-     * If `'lastCreated'` is set while the conversation history is empty, a new conversation will be started instead.
+     * @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.
+     */
+    removeSelectionFromChatContext(): void;
+    /**
+     * Moves focus to the AI Chat prompt input field.
      *
-     * If the conversation with the specified ID is not found, an error will be thrown.
+     * @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.
+     */
+    focusPromptInput(): void;
+    /**
+     * Creates a new, empty conversation.
+     */
+    startConversation(): Promise<void>;
+    /**
+     * Submits a user message to the currently active conversation.
+     */
+    sendMessage(messageData: AIChatUserMessageData): Promise<void>;
+    /**
+     * Returns the ID under which conversations are grouped. All created conversations will have this `groupId` set. Conversation history
+     * will fetch conversations with such `groupId`.
      *
-     * @default 'new'
+     * By default, this is equal to the document ID passed in editor configuration.
      */
-    initialConversation?: string;
+    getGroupId(): string;
     /**
-     * The welcome message to be displayed when the AI chat is initialized. When not set, the default welcome message will be used.
+     * Starts an AI chat conversation safely, catching and logging any errors.
      */
-    welcomeMessage?: string;
+    protected _startConversationSafely(id?: string): Promise<void>;
 }
 /**
- * An API allowing to manipulate the {@link module:ai/aichat/aichat~AIChat AI Chat} interaction while it is being streamed
- * in the chat.
+ * Data for the message send by the user in the AI chat.
+ */
+export type AIChatUserMessageData = {
+    /**
+     * The query that the user provided for the message. Displayed in the chat feed as the user's message.
+     */
+    message: string;
+    /**
+     * Additional parameters for the message. This data is stored together with the message and can influence how the message is processed
+     * or displayed.
+     *
+     * You can pass following properties to alter how the message behaves:
+     *
+     * * `displayedPrompt: string` - If set, will be displayed instead of the actual `message`. You can use it to display a shorter,
+     * or a friendlier user message. This is also respected in the conversation history. Original `message` will still be used to query
+     * the AI model.
+     *
+     * Besides supported properties, `attributes` can be used to save any additional metadata with the message, which can be used by your
+     * integration in any way. Data passed in `attributes` will be saved in the conversation history. If your integration connects external
+     * custom AI tools, `attributes` are passed to the tool calls and can be used by these tools.
+     *
+     * Additionally, other official features that interact with the AI chat feature may introduce their own attributes.
+     */
+    attributes?: Record<string, unknown>;
+};
+/**
+ * Set of helpers dedicated to be used inside {@link module:ai/aichat/aichatcontroller~AIToolEventCallback callbacks} registered
+ * through {@link module:ai/aichat/aichatcontroller~AIChatController#registerToolDataCallback}.
+ *
+ * Using this tools you can manipulate AI chat feed (e.g. add custom replies) in response to the received custom AI tool data.
  *
- * This set of helpers is dedicated to be used and available only inside {@link module:ai/aichat/aichat~AIToolEventCallback}.
+ * @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.
  */
-export interface AIChatInteractionAPI {
+export interface AIChatFeedAPI {
     /**
      * Creates a new reply in the current interaction. The created reply becomes the current reply of the interaction.
      *
@@ -224,6 +240,23 @@ export interface AIChatInteractionAPI {
     clearLoadingMessage: () => void;
 }
 /**
- * A callback type for handling custom AI tools events received in {@link module:ai/aichat/aichat~AIChat#registerToolDataCallback}.
+ * A callback type for handling custom AI tools data.
+ *
+ * This callback receives two parameters:
+ *
+ * * `toolData` - data returned by the AI tool.
+ * * `api` - set of tools which you can use to reflect the received AI tool data in the AI chat feed.
+ */
+export type AIToolEventCallback = (toolData: AIToolData, api: AIChatFeedAPI) => void | Promise<void>;
+/**
+ * An event emitted by `AIChatController` when an AI reply is created.
+ *
+ * @eventName ~AIChatController#replyCreated
+ */
+export type AIChatControllerAIReplyCreatedEvent = AIInteractionReplyCreatedEvent;
+/**
+ * An event emitted by `AIChatController` when an AI chat interaction is created.
+ *
+ * @eventName ~AIChatController#interactionCreated
  */
-export type AIToolEventCallback = (toolData: AIToolData, api: AIChatInteractionAPI) => void | Promise<void>;
+export type AIChatControllerAIInteractionCreatedEvent = AIChatInteractionCreatedEvent;

package/{src → dist}/aichat/aichatui.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module ai/aichat/aichatui
  */
-import { type Context, type Editor, ContextPlugin } from 'ckeditor5/src/core.js';
+import { type Context, type Editor, ContextPlugin } from '@ckeditor/ckeditor5-core';
 import { AITabs } from '../aitabs/aitabs.js';
 import { type AIAddContextOptionsState, type AIContextProvider, type AIContextResource, type AIContextResourceState } from './model/aichatcontext.js';
 import { type AIContextItem } from '../aicore/model/aicontext.js';
@@ -65,18 +65,18 @@ export declare class AIChatUI extends ContextPlugin {
     addFeedItemStaticMessage({ id, staticMessage }: {
         id: string;
         staticMessage?: string;
-    }): void;
+    }): Promise<void>;
     /**
      * Adds a user message to the chat feed.
      */
-    addFeedItemUserMessage(interaction: AIChatInteraction): void;
+    addFeedItemUserMessage(interaction: AIChatInteraction): Promise<void>;
     /**
      * Adds an error message to the chat feed.
      */
     addFeedItemError({ errorMessage, id }: {
         errorMessage: string;
         id: string;
-    }): void;
+    }): Promise<void>;
     /**
      * Adds an AI reply to the chat feed.
      */
@@ -88,7 +88,7 @@ export declare class AIChatUI extends ContextPlugin {
     /**
      * Adds an interaction header to the chat feed.
      */
-    addFeedInteractionHeader(interaction: AIChatInteraction, capabilities: AICapabilitiesConfig): void;
+    addFeedInteractionHeader(interaction: AIChatInteraction, capabilities: AICapabilitiesConfig): Promise<void>;
     /**
      * Adds a custom element to the chat feed.
      */

package/{src → dist}/aichat/model/aichatcontext.d.ts

@@ -6,11 +6,14 @@ import { type AIConnector, type AIUserMessage } from '../../aicore/aiconnector.j
 import { AIContextItemType, AIContextTextResourceType, type AIContextItem, type AIContextItemRequestData, type AIToolContextItem } from '../../aicore/model/aicontext.js';
 export declare const AI_CONTEXT_MODEL_EVENT_NAMES: readonly ["contextItemAdded", "contextItemRemoved", "contextItemLoadingEnded", "contextSent", "error", "addContextOptionsChanged", "sourceResourcesLoaded", "resourceStateChanged", "uploadProgressChanged"];
 declare const AIChatContext_base: {
-    new (): import("ckeditor5/src/utils.js").Observable;
-    prototype: import("ckeditor5/src/utils.js").Observable;
+    new (): import("@ckeditor/ckeditor5-utils").Observable;
+    prototype: import("@ckeditor/ckeditor5-utils").Observable;
 };
 /**
  * Manages the context of the current conversation.
+ *
+ * @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.
  */
 export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
     constructor({ connector, config, ownerId }: {
@@ -20,17 +23,25 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
     });
     /**
      * Initializes the context.
+     *
+     * @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.
      */
     init(): void;
     /**
      * Returns the pending context items that will be sent to the AI endpoint in the next interaction.
      *
+     * @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.
      * @returns Map of pending context items keyed by their uiId
      */
     getPendingContextItems(): Map<string, AIContextItem>;
     /**
      * Populates context items from message data.
      * This method converts user message content to context items and adds them to the conversation context.
+     *
+     * @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.
      */
     populateFromMessage(content: AIUserMessage['content'][0]): Promise<AIContextItem>;
     /**
@@ -40,6 +51,8 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
     /**
      * Returns all context items that have been sent to the AI endpoint in the current conversation.
      *
+     * @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.
      * @returns Map of sent context items keyed by their uiId
      */
     getSentContextItems(): Map<string, AIContextItem>;
@@ -47,27 +60,43 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
      * Removes a context item from the pending context.
      * Read-only items cannot be removed and the method returns early.
      *
+     * @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 uiId The unique identifier of the context item to remove
      */
     removeFromContext(uiId: string): void;
     /**
      * Clears all pending context items and adds the current document to the conversation context if it exists.
+     *
+     * @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.
      */
     clearPendingContextItems(): void;
     /**
      * Adds context items to the conversation context and clears the pending context items.
+     *
+     * @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.
      */
     addToConversationContext(contextItems: Map<string, AIContextItem>): void;
     /**
      * Checks if the current document is in the pending context.
      *
+     * @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.
      * @returns True if the current document is in pending context, false otherwise
      */
     isCurrentDocumentInContext(): boolean;
+    /**
+     * @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.
+     */
     isSelectionInContext(): boolean;
     /**
      * Checks if the current document is in the conversation context.
      *
+     * @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.
      * @returns True if the current document is in conversation context, false otherwise
      */
     isCurrentDocumentInConversation(): boolean;
@@ -75,6 +104,8 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
      * Converts context items to request data format for API endpoint.
      * This static method transforms the internal context item format to the format expected by the AI connector.
      *
+     * @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 contextItems Map of context items to convert
      * @returns  Array of context items in API request format
      */
@@ -83,6 +114,8 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
      * Adds files to the context by uploading them and creating context items.
      * This method handles multiple files concurrently and tracks upload progress.
      *
+     * @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 files Array of File objects to upload and add to context
      * @param [attributes] Optional attributes object containing resourceId and label for tracking purposes and context chips
      * @param [type] Context item type, defaults to AIContextItemType.FILE to indicate that the file is being added as a file or text
@@ -96,6 +129,8 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
      * Adds the current document to the pending context.
      * If the document is already in context, this method returns early without changes.
      *
+     * @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 label Display label for the current document
      */
     addCurrentDocumentToContext(label: string): void;
@@ -103,6 +138,8 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
      * Updates the current document in the pending context with new content and version.
      * This method uploads the document content and updates the context item accordingly.
      *
+     * @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 content The document content to upload, or undefined to skip
      * @param version Version number of the document for change tracking
      * @returns Promise that resolves when the document is updated
@@ -112,12 +149,22 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
         end: number;
         htmlFragment: string;
     }>): Promise<void>;
+    /**
+     * @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.
+     */
     addSelectionToContext(selection: string): void;
+    /**
+     * @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.
+     */
     removeSelectionFromContext(): void;
     /**
      * Adds a URL to the context by uploading it and creating a context item.
      * This method handles URL upload with proper error handling and progress tracking.
      *
+     * @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 url The URL to upload and add to context
      * @param [attributes] Optional attributes object containing resourceId and label for tracking purposes and context chips
      * @returns Promise that resolves when the URL is processed
@@ -132,20 +179,30 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
      * Note, that these context items are ignored by the CKEditor AI agent and should be handled by your backend AI tool.
      *
      * The object which is passed as a parameter can contain the following properties:
-     * * type: AIContextItemType.TOOL;
-     * * mcpServerName: string;
-     * * toolName?: string;
-     * * data: Record<string, any>;
-     * * id?: string;
-     * * label: string;
-     * * uiId: string;
-     * * resourceId?: string;
-     * * isReadOnly?: boolean;
-     * * version?: number;
-     * * hidden?: boolean;
-     * * sessionId?: string | null;
-     * * selection?: Array<{ start: number; end: number }>;
-     * * content?: string;
+     * ```ts
+     * {
+     * 	// Must be set to `AIContextItemType.TOOL`.
+     * 	type: AIContextItemType.TOOL,
+     *
+     * 	// The name of the MCP server.
+     * 	mcpServerName: string;
+     *
+     * 	// The data for the tool. Can be anything.
+     * 	data: Record<string, any>;
+     *
+     * 	// The label of the item used to display it in the chat UI.
+     * 	label: string;
+     *
+     * 	// Optional, 1-21 characters. Auto-generated if omitted.
+     * 	id?: string;
+     *
+     * 	// The name of the tool. Omit to send context to all tools on the server.
+     * 	toolName?: string;
+     * }
+     * ```
+     *
+     * @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.
      */
     addToolItemToContext(contextItem: AIToolContextItem): void;
     /**
@@ -153,12 +210,18 @@ export declare class AIChatContext extends /* #__PURE__ */ AIChatContext_base {
      * This method calls the source's {@link module:ai/aichat/model/aichatcontext~AIContextProvider#getResources}
      * callback and updates resource states.
      *
+     * @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 sourceId The unique identifier of the source provider
      * @param query Search query to filter resources
      * @param uid Unique identifier for the request to prevent race conditions
      * @returns Promise resolving to array of resources with context state
      */
     loadSourceResources(sourceId: string, query: string, uid: string): Promise<Array<AIContextResourceState>>;
+    /**
+     * @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.
+     */
     addResourceToContext(source: AIContextProvider, resource: AIContextResource): Promise<void>;
 }
 export type AIChatContextItemAddedEvent = {
@@ -235,7 +298,7 @@ export type AIContextResourceState = AIContextResource & {
  *
  * ```ts
  * ClassicEditor
- * 	.create( editorElement, {
+ * 	.create( {
  * 		ai: {
  * 			chat: {
  * 				context: {
@@ -326,6 +389,17 @@ export type AIChatContextConfig = {
      * {@link module:ai/aichat/model/aichatcontext~AIContextProvider Learn more about the configuration of custom resources}.
      */
     sources?: Array<AIContextProvider>;
+    /**
+     * When this option is enabled, the selection made in the editor will always be added to the context.
+     *
+     * By default, the selection is added to the context only after user explicitly requests it by clicking "Ask AI" button.
+     *
+     * **Note**: This setting will have no effect if the feature is configured to
+     * {@link module:ai/aichat/model/aichatcontext~AIChatContextConfig#document disallow setting document as the conversation context}.
+     *
+     * @default false
+     */
+    alwaysAddSelection?: boolean;
     /**
      * The configuration of the custom items in the context menu.
      *

package/{src → dist}/aichat/model/aichatconversation.d.ts

@@ -5,17 +5,17 @@
 /**
  * @module ai/aichat/model/aichatconversation
  */
-import { CKEditorError } from 'ckeditor5/src/utils.js';
+import { CKEditorError } from '@ckeditor/ckeditor5-utils';
 import type { AIConnector, AIModelData } from '../../aicore/aiconnector.js';
 import { AIChatContext, type AIChatContextConfig, type AIContextProvider, type AIContextResource, type AIContextResourceState } from './aichatcontext.js';
 import { type AIToolContextItem, type AIContextItem } from '../../aicore/model/aicontext.js';
 import { AICapabilities, type AICapabilitiesConfig } from '../../aicore/model/aicapabilities.js';
 import type { AIModels } from '../../aicore/model/aimodels.js';
-import { type Editor } from 'ckeditor5/src/core.js';
+import { type Editor } from '@ckeditor/ckeditor5-core';
 import { AIChatInteraction } from './aichatinteraction.js';
 declare const AIChatConversation_base: {
-    new (): import("ckeditor5/src/utils.js").Emitter;
-    prototype: import("ckeditor5/src/utils.js").Emitter;
+    new (): import("@ckeditor/ckeditor5-utils").Emitter;
+    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
 };
 /**
  * Represents a conversation between the user and the AI endpoint on top of the

package/{src → dist}/aichat/model/aichatinteraction.d.ts

@@ -8,7 +8,6 @@
  */
 import { type AICapabilitiesConfig } from '../../aicore/model/aicapabilities.js';
 import { AIInteraction, type AIInteractionOptions } from '../../aicore/model/aiinteraction.js';
-import { type AIConnectorQueryAssistantRequest } from '../../aicore/aiconnector.js';
 import { type AIContextItem } from '../../aicore/model/aicontext.js';
 export declare class AIChatInteraction extends AIInteraction {
     /**
@@ -32,12 +31,10 @@ export declare class AIChatInteraction extends AIInteraction {
      */
     readonly model: string;
     /**
-     * Additional metadata (attributes) passed together with the user message when it was submitted.
+     * Additional metadata properties passed together with the user message when it was submitted.
      */
     readonly attributes?: Record<string, unknown>;
     constructor(options: AIChatInteractionOptions);
-    sendRequest(): Promise<AIConnectorQueryAssistantRequest>;
-    getDocumentContext(): AIContextItem | undefined;
 }
 export type AIChatInteractionOptions = {
     conversationId: string;

package/{src → dist}/aichat/ui/aichatballoonview.d.ts

@@ -5,12 +5,12 @@
 /**
  * @module ai/aichat/ui/aichatballoonview
  */
-import { type Locale } from 'ckeditor5/src/utils.js';
+import { type Locale } from '@ckeditor/ckeditor5-utils';
 import { type AISuggestionActionName } from './feed/aichatfeedsuggestionitemactionsview.js';
 import { type AISuggestionContentPartDefinition } from '../../aicore/utils/getsuggestionpartsfromreply.js';
 import { type AIContentRenderingStrategy } from '../../aicore/ui/suggestioncontainer/aisuggestionstreamablecontentview.js';
 import { AIBalloonView } from '../../aiballoon/ui/aiballoonview.js';
-import { ButtonView, FocusCycler, type ViewCollection } from 'ckeditor5/src/ui.js';
+import { ButtonView, FocusCycler, type ViewCollection } from '@ckeditor/ckeditor5-ui';
 import { type AIReplyChangeGroupState } from '../../aicore/model/aireply.js';
 import '../../../theme/aichat/aichatballoon.css';
 export type AIChatBalloonViewConfig = {

package/{src → dist}/aichat/ui/aichatcontrolsview.d.ts

@@ -5,8 +5,8 @@
 /**
  * @module ai/aichat/ui/aichatcontrolsview
  */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import { View, type BodyCollection } from 'ckeditor5/src/ui.js';
+import type { Locale } from '@ckeditor/ckeditor5-utils';
+import { View, type BodyCollection } from '@ckeditor/ckeditor5-ui';
 import { type AIAddContextOptionsState, type AIContextProvider, type AIContextResourceState } from '../model/aichatcontext.js';
 import { type AIContextItem } from '../../aicore/model/aicontext.js';
 import { type AIModelData } from '../../aicore/aiconnector.js';

package/{src → dist}/aichat/ui/aichatfeedview.d.ts

@@ -5,8 +5,8 @@
 /**
  * @module ai/aichat/ui/aichatfeedview
  */
-import { type Locale } from 'ckeditor5/src/utils.js';
-import { View, type ViewCollection, type BodyCollection } from 'ckeditor5/src/ui.js';
+import { type Locale } from '@ckeditor/ckeditor5-utils';
+import { View, type ViewCollection, type BodyCollection } from '@ckeditor/ckeditor5-ui';
 import { type AIChatFeedItemView } from './feed/aichatfeeditemview.js';
 import { type AIContentRenderingStrategy } from '../../aicore/ui/suggestioncontainer/aisuggestionstreamablecontentview.js';
 import { type Document } from '../../aicore/utils/htmlparser.js';