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

package/dist/aicore/model/aicapabilities.d.ts

@@ -1,63 +1,64 @@
 /**
- * @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/aicore/model/aicapabilities
+*/
+import { type EmitterMixinConstructor } from "@ckeditor/ckeditor5-utils";
+declare const AICapabilitiesBase: EmitterMixinConstructor;
 export declare const CAPABILITIES_MODEL_EVENT_NAMES: readonly ["capabilitiesUpdated"];
-declare const AICapabilities_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Emitter;
-    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
-};
 /**
- * Manages the AI capabilities configuration and state.
- */
-export declare class AICapabilities extends /* #__PURE__ */ AICapabilities_base {
-    constructor();
-    /**
-     * Initializes the capabilities.
-     */
-    init(): void;
-    /**
-     * Resets the capabilities configuration to default state.
-     */
-    reset(): void;
-    /**
-     * Returns the current capabilities configuration.
-     *
-     * @returns The current capabilities configuration.
-     */
-    getCapabilitiesConfig(): AICapabilitiesConfig;
-    /**
-     * Converts capabilities configuration to request data format for API endpoint.
-     * @returns The request data or undefined if no capabilities are enabled.
-     */
-    static getCapabilitiesRequestData(config: AICapabilitiesConfig | undefined): AICapabilitiesRequestData;
-    /**
-     * Toggles the web search enabled state.
-     */
-    toggleWebSearch(): void;
-    /**
-     * Toggles the reasoning enabled state.
-     */
-    toggleReasoning(): void;
-    /**
-     * Sets the web search enabled state and fires an event with current state.
-     */
-    setWebSearch(isWebSearchEnabled: boolean): void;
-    /**
-     * Sets the reasoning enabled state and fires an event with current state.
-     */
-    setReasoning(isReasoningEnabled: boolean): void;
+* Manages the AI capabilities configuration and state.
+*/
+export declare class AICapabilities extends AICapabilitiesBase {
+	constructor();
+	/**
+	* Initializes the capabilities.
+	*/
+	init(): void;
+	/**
+	* Resets the capabilities configuration to default state.
+	*/
+	reset(): void;
+	/**
+	* Returns the current capabilities configuration.
+	*
+	* @returns The current capabilities configuration.
+	*/
+	getCapabilitiesConfig(): AICapabilitiesConfig;
+	/**
+	* Converts capabilities configuration to request data format for API endpoint.
+	* @returns The request data or undefined if no capabilities are enabled.
+	*/
+	static getCapabilitiesRequestData(config: AICapabilitiesConfig | undefined): AICapabilitiesRequestData;
+	/**
+	* Toggles the web search enabled state.
+	*/
+	toggleWebSearch(): void;
+	/**
+	* Toggles the reasoning enabled state.
+	*/
+	toggleReasoning(): void;
+	/**
+	* Sets the web search enabled state and fires an event with current state.
+	*/
+	setWebSearch(isWebSearchEnabled: boolean): void;
+	/**
+	* Sets the reasoning enabled state and fires an event with current state.
+	*/
+	setReasoning(isReasoningEnabled: boolean): void;
 }
 export type AICapabilitiesUpdatedEvent = {
-    name: 'capabilitiesUpdated';
-    args: [AICapabilitiesConfig];
+	name: "capabilitiesUpdated";
+	args: [AICapabilitiesConfig];
 };
 export type AICapabilitiesConfig = {
-    isWebSearchEnabled: boolean;
-    isReasoningEnabled: boolean;
+	isWebSearchEnabled: boolean;
+	isReasoningEnabled: boolean;
 };
 export type AICapabilitiesRequestData = {
-    webSearch?: object;
-    reasoning?: object;
+	webSearch?: object;
+	reasoning?: object;
 };
 export {};

package/dist/aicore/model/aicontext.d.ts

@@ -1,76 +1,76 @@
 /**
- * @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/aicore/model/aicontext
- * @publicApi
- */
+* @module ai/aicore/model/aicontext
+* @publicApi
+*/
 /**
- * The type of context item.
- *
- * Available types:
- * * `'mcp-tool-context'`: a tool-related context item,
- * * `'file'`: a file (PDF, Word document, etc.),
- * * `'document'`: all current editors documents (one per each root in each editor),
- * * `'image'`: an image file — internal sub-type of file, derived from the file's MIME type
- *   so the chip renders a distinct icon. Serialized to the backend as `'file'`.
- *   (used by {@link module:ai/aichat/model/aichatcontext~AIChatContextConfig#document `config.ai.chat.context.document` option}),
- * * `'web-resource'`: a URL (web page, blog post, etc.),
- * * `'text'`: a text (plain text, Markdown, HTML, etc.),
- * * `'selection'`: a selection of text in the editor
- *   (used by {@link module:ai/aiquickactions/aiquickactions~AIQuickActions AI Quick Actions} that pass the user selection
- *   to the {@link module:ai/aichat/aichat~AIChat AI Chat}).
- */
-export type AIContextItemType = 'mcp-tool-context' | 'file' | 'image' | 'document' | 'web-resource' | 'text' | 'selection';
+* The type of context item.
+*
+* Available types:
+* * `'mcp-tool-context'`: a tool-related context item,
+* * `'file'`: a file (PDF, Word document, etc.),
+* * `'document'`: all current editors documents (one per each root in each editor),
+* * `'image'`: an image file — internal sub-type of file, derived from the file's MIME type
+*   so the chip renders a distinct icon. Serialized to the backend as `'file'`.
+*   (used by {@link module:ai/aichat/model/aichatcontext~AIChatContextConfig#document `config.ai.chat.context.document` option}),
+* * `'web-resource'`: a URL (web page, blog post, etc.),
+* * `'text'`: a text (plain text, Markdown, HTML, etc.),
+* * `'selection'`: a selection of text in the editor
+*   (used by {@link module:ai/aiquickactions/aiquickactions~AIQuickActions AI Quick Actions} that pass the user selection
+*   to the {@link module:ai/aichat/aichat~AIChat AI Chat}).
+*/
+export type AIContextItemType = "mcp-tool-context" | "file" | "image" | "document" | "web-resource" | "text" | "selection";
 /**
- * The type of text resource.
- */
-export type AIContextTextResourceType = 'text' | 'markdown' | 'html';
+* The type of text resource.
+*/
+export type AIContextTextResourceType = "text" | "markdown" | "html";
 /**
- * A context item.
- */
+* A context item.
+*/
 export type AIContextItem = AIContextItemRequestData & {
-    label: string;
-    uiId: string;
-    resourceId?: string;
-    isReadOnly?: boolean;
-    version?: number;
-    hidden?: boolean;
-    sessionId?: string | null;
-    selection?: Array<{
-        start: number;
-        end: number;
-    }>;
+	label: string;
+	uiId: string;
+	resourceId?: string;
+	isReadOnly?: boolean;
+	version?: number;
+	hidden?: boolean;
+	sessionId?: string | null;
+	selection?: Array<{
+		start: number;
+		end: number;
+	}>;
 };
 /**
- * A tool-related context item.
- */
+* A tool-related context item.
+*/
 export type AIToolContextItem = AIContextItem & {
-    type: 'mcp-tool-context';
-    mcpServerName: string;
-    toolName?: string;
-    data: Record<string, any>;
-    /**
-     * ID length can be between 1 and 21 characters. If not provided, it will be randomly generated 21 characters long string.
-     */
-    id?: string;
+	type: "mcp-tool-context";
+	mcpServerName: string;
+	toolName?: string;
+	data: Record<string, any>;
+	/**
+	* ID length can be between 1 and 21 characters. If not provided, it will be randomly generated 21 characters long string.
+	*/
+	id?: string;
 };
 /**
- * A context item request data for using in the `AIConnector`.
- */
+* A context item request data for using in the `AIConnector`.
+*/
 export type AIContextItemRequestData = {
-    type: AIContextItemType;
-    content?: string;
-    id?: string;
-    selection?: Array<{
-        start: number;
-        end: number;
-    }>;
+	type: AIContextItemType;
+	content?: string;
+	id?: string;
+	selection?: Array<{
+		start: number;
+		end: number;
+	}>;
 };
 export type AIToolRequestData = {
-    type: 'mcp-tool-context';
-    mcpServerName: string;
-    toolName?: string;
-    data: Record<string, any>;
+	type: "mcp-tool-context";
+	mcpServerName: string;
+	toolName?: string;
+	data: Record<string, any>;
 };

package/dist/aicore/model/aiinteraction.d.ts

@@ -1,211 +1,205 @@
 /**
- * @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/aicore/model/aiinteraction
- * @publicApi
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { type AIConnector } from '../aiconnector.js';
-import { AIReply } from './aireply.js';
-import type { Editor } from '@ckeditor/ckeditor5-core';
-declare const AIInteraction_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Emitter;
-    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
-};
+* @module ai/aicore/model/aiinteraction
+* @publicApi
+*/
+import { type EmitterMixinConstructor, type Locale } from "@ckeditor/ckeditor5-utils";
+import { type AIConnector } from "../aiconnector.js";
+import { AIReply } from "./aireply.js";
+import type { Editor } from "@ckeditor/ckeditor5-core";
+declare const _AIInteractionBase: EmitterMixinConstructor;
 /**
- * An interaction is a single request to the AI endpoint. It is created when a user message is sent and finishes when the
- * all responses are received (interaction is finished) or interaction is stopped (by an error or directly by the user).
- *
- * An interaction hosts a collection of {@link #replies} and fires various events that may be handled to update the UI 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.
+* An interaction is a single request to the AI endpoint. It is created when a user message is sent and finishes when the
+* all responses are received (interaction is finished) or interaction is stopped (by an error or directly by the user).
+*
+* An interaction hosts a collection of {@link #replies} and fires various events that may be handled to update the UI 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.
 */
-export declare abstract class AIInteraction extends /* #__PURE__ */ AIInteraction_base {
-    /**
-     * The unique ID of the interaction.
-     */
-    readonly id: string;
-    /**
-     * The replies created for this interaction.
-     */
-    replies: Array<AIReply>;
-    /**
-     * The current reply being returned by the AI endpoint and handled by `AIInteraction`. This property is set when the interaction
-     * is started and becomes `undefined` when the interaction is {@link #stop stopped}. It changes as data for new replies are received
-     * from the AI endpoint.
-     */
-    currentReply?: AIReply;
-    constructor({ connector, locale, channelsToEditors }: AIInteractionOptions);
-    /**
-     * Stops the interaction. It marks the last reply as done and aborts the current request to the AI endpoint.
-     *
-     * @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.
-     */
-    stop(): void;
-    /**
-     * Gets a reply by its ID.
-     *
-     * @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.
-     */
-    getReply(id: string): AIReply | undefined;
-    /**
-     * Destroys the interaction. It marks the last reply as done and aborts the current request to the AI endpoint.
-     *
-     * @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.
-     */
-    destroy(): void;
-    /**
-     * Creates a reply and adds it to the 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.
-     */
-    createReply(options: ConstructorParameters<typeof AIReply>[0]): AIReply;
+export declare abstract class AIInteraction extends _AIInteractionBase {
+	/**
+	* The unique ID of the interaction.
+	*/
+	readonly id: string;
+	/**
+	* The replies created for this interaction.
+	*/
+	replies: Array<AIReply>;
+	/**
+	* The current reply being returned by the AI endpoint and handled by `AIInteraction`. This property is set when the interaction
+	* is started and becomes `undefined` when the interaction is {@link #stop stopped}. It changes as data for new replies are received
+	* from the AI endpoint.
+	*/
+	currentReply?: AIReply;
+	constructor({ connector, locale, channelsToEditors }: AIInteractionOptions);
+	/**
+	* Stops the interaction. It marks the last reply as done and aborts the current request to the AI endpoint.
+	*
+	* @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.
+	*/
+	stop(): void;
+	/**
+	* Gets a reply by its ID.
+	*
+	* @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.
+	*/
+	getReply(id: string): AIReply | undefined;
+	/**
+	* Destroys the interaction. It marks the last reply as done and aborts the current request to the AI endpoint.
+	*
+	* @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.
+	*/
+	destroy(): void;
+	/**
+	* Creates a reply and adds it to the 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.
+	*/
+	createReply(options: ConstructorParameters<typeof AIReply>[0]): AIReply;
 }
 export type AIInteractionOptions = {
-    connector: AIConnector;
-    /**
-     * Locale used to translate user-facing strings produced internally by replies (e.g. the placeholder shown in place of
-     * removed content while change groups are computed).
-     */
-    locale?: Locale;
-    /**
-     * The channel ID to editor instance map. Optional — interactions that don't depend on per-channel routing
-     * (e.g. AI Actions, which wires a synthetic single-editor map inside its `createReply` override) can omit it.
-     */
-    channelsToEditors?: Map<string, Editor>;
+	connector: AIConnector;
+	/**
+	* Locale used to translate user-facing strings produced internally by replies (e.g. the placeholder shown in place of
+	* removed content while change groups are computed).
+	*/
+	locale?: Locale;
+	/**
+	* The channel ID to editor instance map. Optional — interactions that don't depend on per-channel routing
+	* (e.g. AI Actions, which wires a synthetic single-editor map inside its `createReply` override) can omit it.
+	*/
+	channelsToEditors?: Map<string, Editor>;
 };
 export type AIToolData = {
-    /**
-     * Name of the AI tool which returned the data.
-     */
-    toolName: string;
-    /**
-     * Data type.
-     *
-     * * `'result'` – if the AI tool returned final results of its execution.
-     * * `'notification'` – if the AI tool returned a notification (e.g., progress update).
-     */
-    type: 'result' | 'notification';
-    /**
-     * Data returned by the tool.
-     *
-     * Content depends on the AI tool implementation.
-     */
-    data?: Record<string, any>;
-    /**
-     * Additional parameters returned by the tool.
-     *
-     * Content depends on the AI tool implementation.
-     *
-     * Available only if `type` is `'result'`.
-     */
-    attributes?: Record<string, any>;
+	/**
+	* Name of the AI tool which returned the data.
+	*/
+	toolName: string;
+	/**
+	* Data type.
+	*
+	* * `'result'` – if the AI tool returned final results of its execution.
+	* * `'notification'` – if the AI tool returned a notification (e.g., progress update).
+	*/
+	type: "result" | "notification";
+	/**
+	* Data returned by the tool.
+	*
+	* Content depends on the AI tool implementation.
+	*/
+	data?: Record<string, any>;
+	/**
+	* Additional parameters returned by the tool.
+	*
+	* Content depends on the AI tool implementation.
+	*
+	* Available only if `type` is `'result'`.
+	*/
+	attributes?: Record<string, any>;
 };
 /**
- * An event emitted by {@link module:ai/aicore/model/aiinteraction~AIInteraction} when started, which means that
- * the request to the AI endpoint has been sent.
- *
- * @eventName ~AIInteraction#interactionStarted
- */
+* An event emitted by {@link module:ai/aicore/model/aiinteraction~AIInteraction} when started, which means that
+* the request to the AI endpoint has been sent.
+*
+* @eventName ~AIInteraction#interactionStarted
+*/
 export type AIInteractionStartedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'interactionStarted';
-    args: [interaction: TInteraction];
+	name: "interactionStarted";
+	args: [interaction: TInteraction];
 };
 /**
- * An event emitted by {@link module:ai/aicore/model/aiinteraction~AIInteraction} when a user stopped
- * the current interaction.
- *
- * @eventName ~AIInteraction#interactionStopped
- */
+* An event emitted by {@link module:ai/aicore/model/aiinteraction~AIInteraction} when a user stopped
+* the current interaction.
+*
+* @eventName ~AIInteraction#interactionStopped
+*/
 export type AIInteractionStoppedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'interactionStopped';
-    args: [interaction: TInteraction];
+	name: "interactionStopped";
+	args: [interaction: TInteraction];
 };
 /**
- * An event emitted by {@link module:ai/aicore/model/aiinteraction~AIInteraction} when an interaction
- * ran out of content to process or crashed during processing.
- *
- * @eventName ~AIInteraction#interactionFinished
- */
+* An event emitted by {@link module:ai/aicore/model/aiinteraction~AIInteraction} when an interaction
+* ran out of content to process or crashed during processing.
+*
+* @eventName ~AIInteraction#interactionFinished
+*/
 export type AIInteractionFinishedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'interactionFinished';
-    args: [interaction: TInteraction];
+	name: "interactionFinished";
+	args: [interaction: TInteraction];
 };
 /**
- * An event emitted by {@link module:ai/aicore/model/aiinteraction~AIInteraction} when it is destroyed.
- *
- * @eventName ~AIInteraction#interactionDestroyed
- */
+* An event emitted by {@link module:ai/aicore/model/aiinteraction~AIInteraction} when it is destroyed.
+*
+* @eventName ~AIInteraction#interactionDestroyed
+*/
 export type AIInteractionDestroyedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'interactionDestroyed';
-    args: [interaction: TInteraction];
+	name: "interactionDestroyed";
+	args: [interaction: TInteraction];
 };
 /**
- * An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when an AI reply is added to the
- * interaction (usually because received from the AI endpoint).
- *
- * @eventName ~AIInteraction#replyCreated
- */
+* An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when an AI reply is added to the
+* interaction (usually because received from the AI endpoint).
+*
+* @eventName ~AIInteraction#replyCreated
+*/
 export type AIInteractionReplyCreatedEvent = {
-    name: 'replyCreated';
-    args: [reply: AIReply];
+	name: "replyCreated";
+	args: [reply: AIReply];
 };
 /**
- * An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
- * the title of the conversation needs to be updated.
- */
+* An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
+* the title of the conversation needs to be updated.
+*/
 export type AISetConversationTitleEvent = {
-    name: 'setConversationTitle';
-    args: [title: string, shouldAnimate?: boolean];
+	name: "setConversationTitle";
+	args: [title: string, shouldAnimate?: boolean];
 };
 /**
- * An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
- * the web search was performed.
- */
+* An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
+* the web search was performed.
+*/
 export type AIWebSearchStartedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'webSearchStarted';
-    args: [interaction: TInteraction];
+	name: "webSearchStarted";
+	args: [interaction: TInteraction];
 };
 /**
- * An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
- * the web search was performed.
- */
+* An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
+* the web search was performed.
+*/
 export type AIWebSearchFinishedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'webSearchFinished';
-    args: [interaction: TInteraction];
+	name: "webSearchFinished";
+	args: [interaction: TInteraction];
 };
 /**
- * An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
- * the reasoning was performed.
- */
+* An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
+* the reasoning was performed.
+*/
 export type AIReasoningStartedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'reasoningStarted';
-    args: [interaction: TInteraction];
+	name: "reasoningStarted";
+	args: [interaction: TInteraction];
 };
 /**
- * An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
- * the reasoning was performed.
- */
+* An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
+* the reasoning was performed.
+*/
 export type AIReasoningFinishedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'reasoningFinished';
-    args: [interaction: TInteraction];
+	name: "reasoningFinished";
+	args: [interaction: TInteraction];
 };
 /**
- * An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
- * data from an AI tool is received.
- */
+* An event emitted by an {@link module:ai/aicore/model/aiinteraction~AIInteraction} when
+* data from an AI tool is received.
+*/
 export type AIToolDataReceivedEvent<TInteraction extends AIInteraction = AIInteraction> = {
-    name: 'toolDataReceived';
-    args: [
-        toolData: AIToolData,
-        interaction: TInteraction
-    ];
+	name: "toolDataReceived";
+	args: [toolData: AIToolData, interaction: TInteraction];
 };
 export {};