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

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

@@ -1,205 +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';
-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 }: 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;
+	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 {};

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

@@ -1,84 +1,88 @@
 /**
- * @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/aimodels
- * @publicApi
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { type AIConnector, type AIModelData } from '../../aicore/aiconnector.js';
+* @module ai/aicore/model/aimodels
+* @publicApi
+*/
+import { type EmitterMixinConstructor, type Locale } from "@ckeditor/ckeditor5-utils";
+import { type AIConnector, type AIModelData } from "../../aicore/aiconnector.js";
+declare const AIModelsBase: EmitterMixinConstructor;
 /**
- * Configuration for AI models.
- */
+* Configuration for AI models.
+*/
 export interface AIModelsConfig {
-    /**
-     * Decides which model is selected by default across all AI features.
-     */
-    defaultModelId?: string;
-    /**
-     * Decides which models are visible in model selectors across all AI features.
-     */
-    displayedModels?: string | Array<string>;
-    /**
-     * Decides whether the model selector UI is visible across all AI features (Chat and Review Mode).
-     *
-     * When `true`:
-     * * If multiple models are available, the model selector dropdown is shown.
-     * * If only one model is available, the model name is displayed instead of the selector.
-     *
-     * When `false`, the model UI will not be shown no matter how many models are available.
-     *
-     * @default true
-     */
-    showModelSelector?: boolean;
+	/**
+	* Decides which model is selected by default across all AI features.
+	*/
+	defaultModelId?: string;
+	/**
+	* Decides which models are visible in model selectors across all AI features.
+	*/
+	displayedModels?: string | Array<string>;
+	/**
+	* Decides whether the model selector UI is visible across all AI features (Chat and Review Mode).
+	*
+	* When `true`:
+	* * If multiple models are available, the model selector dropdown is shown.
+	* * If only one model is available, the model name is displayed instead of the selector.
+	*
+	* When `false`, the model UI will not be shown no matter how many models are available.
+	*
+	* @default true
+	*/
+	showModelSelector?: boolean;
 }
-declare const AIModels_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Emitter;
-    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
-};
 /**
- * Stores the list of available AI models acquired from the AI connector.
- */
-export declare class AIModels extends /* #__PURE__ */ AIModels_base {
-    /**
-     * @inheritDoc
-     */
-    constructor({ connector, config, locale }: {
-        connector: AIConnector;
-        config?: AIModelsConfig;
-        locale: Locale;
-    });
-    /**
-     * Returns a list of available models.
-     */
-    getAll(): Promise<Array<AIModelData>>;
-    /**
-     * Returns a list of available models, which corresponds to {@link #getAll all models} narrowed down
-     * by the `ai.models.displayedModels` configuration.
-     *
-     * By default, only models marked with `recommended: true` are returned. However, models explicitly
-     * configured via `ai.models.displayedModels` are always included, even if not recommended.
-     *
-     * **Note:** `displayedModels` may include ids, names, and/or providers.
-     */
-    getAvailableModels(): Promise<Array<AIModelData>>;
-    /**
-     * Returns a specific AI model from among {@link #getAll all models} by its id.
-     *
-     * **Note:** `'auto'` id always matches the `'agent*'` model.
-     */
-    getModel(modelId?: string): Promise<AIModelData | null>;
-    /**
-     * Returns default AI model among the {@link #getAvailableModels available models} accounting for the
-     * `ai.models.defaultModelId` configuration.
-     *
-     * **Note**: If `'auto'` id was specified as `defaultModelId` in the configuration, it will match the `'agent*'` model.
-     */
-    getDefault(): Promise<AIModelData | null>;
-    /**
-     * Checks whether the given model is available among the {@link #getAvailableModels available models}.
-     */
-    isAvailable(model: AIModelData): Promise<boolean>;
+* Stores the list of available AI models acquired from the AI connector.
+*/
+export declare class AIModels extends AIModelsBase {
+	/**
+	* @inheritDoc
+	*/
+	constructor({ connector, config, locale }: {
+		connector: AIConnector;
+		config?: AIModelsConfig;
+		locale: Locale;
+	});
+	/**
+	* Returns a list of available models.
+	*/
+	getAllModels(): Promise<Array<AIModelData>>;
+	/**
+	* Returns a list of available models, which corresponds to {@link #getAllModels all models} narrowed down
+	* by the `ai.models.displayedModels` configuration.
+	*
+	* By default, only models marked with `recommended: true` are returned. However, models explicitly
+	* configured via `ai.models.displayedModels` are always included, even if not recommended.
+	*
+	* **Note:** `displayedModels` may include ids, names, and/or providers.
+	*/
+	getAvailableModels(): Promise<Array<AIModelData>>;
+	/**
+	* Returns the model with the given id, falling back to the {@link #getDefault default model} when the id
+	* is missing or not recognized. Returns `null` only when there are no models at all.
+	*
+	* **Note:** `'auto'` id always matches the `'agent*'` model.
+	*/
+	resolveModel(modelId?: string): Promise<AIModelData | null>;
+	/**
+	* Returns default AI model among the {@link #getAvailableModels available models} accounting for the
+	* `ai.models.defaultModelId` configuration.
+	*
+	* **Note**: If `'auto'` id was specified as `defaultModelId` in the configuration, it will match the `'agent*'` model.
+	*/
+	getDefault(): Promise<AIModelData | null>;
+	/**
+	* Checks whether the given model is available among the {@link #getAvailableModels available models}.
+	*/
+	isAvailable(model: AIModelData): Promise<boolean>;
+	/**
+	* Returns the model with the given id, or `null` if no such model exists.
+	*
+	* Unlike {@link #resolveModel}, this does **not** fall back to the default model.
+	*/
+	getModel(modelId: string): Promise<AIModelData | null>;
 }
 export {};