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

package/LICENSE.md

@@ -24,7 +24,7 @@ The following libraries are included in CKEditor 5 under the [BSD-3-Clause
 The following libraries are included in CKEditor 5 under the [MIT license](https://opensource.org/licenses/MIT):
 
 * dom-serializer - Copyright (c) 2014 The cheeriojs contributors.
-* es-toolkit - Copyright (c) 2024 Viva Republica, Inc and Copyright OpenJS Foundation and other contributors.
+* es-toolkit - Copyright (c) 2024 Viva Republica, Inc.
 * eventsource-parser - Copyright (c) 2025 Espen Hovlandsdal <espen@hovlandsdal.com>.
 * htmlparser2 - Copyright 2010, 2011, Chris Winberry <chris@winberry.net>. All rights reserved.
 * morphdom - Copyright (c) Patrick Steele-Idem <pnidem@gmail.com> (psteeleidem.com).

package/dist/aiactions/aiactions.d.ts

@@ -1,81 +1,117 @@
 /**
- * @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/aiactions/aiactions
- * @publicApi
- */
-import { type Editor, Plugin } from '@ckeditor/ckeditor5-core';
-import { AIConnector } from '../aicore/aiconnector.js';
-import { Dialog } from '@ckeditor/ckeditor5-ui';
-import { AIEditing } from '../aicore/aiediting.js';
-import { AIBalloon } from '../aiballoon/aiballoon.js';
-import { DocumentCompare } from '@ckeditor/ckeditor5-collaboration-core';
+* @module ai/aiactions/aiactions
+* @publicApi
+*/
+import { type Editor, Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AIConnector } from "../aicore/aiconnector.js";
+import { AIErrorSink } from "../aicore/aierrorreporter.js";
+import { Dialog } from "@ckeditor/ckeditor5-ui";
+import { AIEditing } from "../aicore/aiediting.js";
+import { type AIContextRef } from "../aicore/model/aicontextref.js";
+import { AIBalloon } from "../aiballoon/aiballoon.js";
+import { DocumentChanges } from "../aisdk/documentchanges.js";
 /**
- * @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.
- */
+* @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 AIActions extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AIConnector, typeof Dialog, typeof AIEditing, typeof AIBalloon, typeof DocumentCompare];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIActions";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * The busy state of the AI actions.
-     *
-     * It is set to `true` when there are AI response being streamed or rendered.
-     *
-     * @observable
-     */
-    isBusy: boolean;
-    constructor(editor: Editor);
-    /**
-     * Stops the currently running AI action interaction, aborting any in-progress streaming and resetting the busy state.
-     *
-     * @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.
-     */
-    stopInteraction(): void;
-    /**
-     * Executes an AI action on the current editor selection. The action processes the selected content
-     * using the AI model and displays the result in an inline balloon.
-     *
-     * @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 action The action definition specifying which AI action to execute.
-     * @param label The display label shown in the balloon UI while the action is being processed.
-     * @param icon Optional icon to display alongside the label in the balloon UI.
-     */
-    executeAction(action: AIActionDefinition, label: string, icon?: string): Promise<void>;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-    private _createInteraction;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[AIConnector, AIErrorSink, Dialog, AIEditing, AIBalloon, DocumentChanges]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIActions";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* The busy state of the AI actions.
+	*
+	* It is set to `true` while an AI response is being generated or rendered.
+	*
+	* @observable
+	*/
+	isBusy: boolean;
+	constructor(editor: Editor);
+	/**
+	* Stops the currently running AI action interaction, aborting the in-progress request and resetting the busy state.
+	*
+	* @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.
+	*/
+	stopInteraction(): void;
+	/**
+	* Executes an AI action on the current editor selection. The action processes the selected content
+	* using the AI model and displays the result in an inline balloon.
+	*
+	* @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 action The action definition specifying which AI action to execute.
+	* @param label The display label shown in the balloon UI while the action is being processed.
+	* @param icon Optional icon to display alongside the label in the balloon UI.
+	*/
+	executeAction(action: AIActionDefinition, label: string, icon?: string): Promise<void>;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): Promise<void>;
+	private _createInteraction;
 }
-export type AIActionsNames = 'continue' | 'fix-grammar' | 'improve-writing' | 'make-longer' | 'make-shorter' | 'make-tone-casual' | 'make-tone-formal' | 'translate';
+export type AIActionsNames = "continue" | "fix-grammar" | "improve-writing" | "make-longer" | "make-shorter" | "make-tone-casual" | "make-tone-formal" | "translate";
 /**
- * Defines the parameters for an AI action executed via
- * {@link module:ai/aiactions/aiactions~AIActions#executeAction `executeAction()`}.
- *
- * For system actions, provide `actionName`. For custom actions, provide `userMessage` and `model`.
- */
+* Defines the parameters for an AI action executed via
+* {@link module:ai/aiactions/aiactions~AIActions#executeAction `executeAction()`}.
+*
+* The definition supports a few different shapes, depending on the action type and its prompt source:
+*
+* A system action runs one of the predefined actions. Provide its `actionName`.
+*
+* ```ts
+* {
+*	actionName: 'improve-writing'
+* }
+* ```
+*
+* A custom action runs an inline prompt. Provide the `model` together with a `userMessage` that carries the prompt.
+*
+* ```ts
+* {
+*	model: 'claude-4-6-sonnet',
+*	userMessage: 'Rewrite the selected text in a more formal tone.'
+* }
+* ```
+*
+* A custom action can also rely on a context reference instead of an inline prompt. In that case neither `actionName`
+* nor `userMessage` is set, and the referenced context is passed through `contexts`.
+*
+* ```ts
+* {
+*	model: 'claude-4-6-sonnet',
+*	contexts: [ { id: 'style-guide', promptId: 'improve-writing' } ]
+* }
+* ```
+*/
 export type AIActionDefinition = {
-    actionName?: AIActionsNames;
-    args?: Record<string, string>;
-    userMessage?: string;
-    model?: string;
+	actionName?: AIActionsNames;
+	args?: Record<string, string>;
+	userMessage?: string;
+	model?: string;
+	/**
+	* Context references attached to the action.
+	*
+	* @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.
+	*/
+	contexts?: Array<AIContextRef>;
 };

package/dist/aiactions/model/aiactionsinteraction.d.ts

@@ -1,56 +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/aiactions/model/aiactionsinteraction
- */
-import { AIInteraction, type AIInteractionOptions } from '../../aicore/model/aiinteraction.js';
-import { type AIConnectorRequest } from '../../aicore/aiconnector.js';
-import { type AIActionsNames, type AIActionDefinition } from '../aiactions.js';
-import { type AIContextItem } from '../../aicore/model/aicontext.js';
-import { AIActionsReply } from './aiactionsreply.js';
+* @module ai/aiactions/model/aiactionsinteraction
+*/
+import { AIInteraction, type AIInteractionOptions } from "../../aicore/model/aiinteraction.js";
+import { type AIConnectorRequest } from "../../aicore/aiconnector.js";
+import { type AIActionsNames, type AIActionDefinition } from "../aiactions.js";
+import { AIContext, type AIContextItem } from "../../aicore/model/aicontext.js";
+import type { Editor } from "@ckeditor/ckeditor5-core";
+import { AIActionsReply } from "./aiactionsreply.js";
 export declare class AIActionsInteraction extends AIInteraction {
-    /**
-     * The content of the document for the command to refer to.
-     */
-    readonly content: string;
-    /**
-     * The version of the document the content was extracted from.
-     */
-    readonly version: number;
-    /**
-     * The name of the action to execute. Specified only for predefined actions.
-     */
-    readonly actionName?: AIActionsNames;
-    /**
-     * The arguments to pass to the action. Specified only for predefined actions.
-     */
-    readonly args?: Record<string, string>;
-    /**
-     * The user message that was sent to the AI endpoint. Specified only for custom actions.
-     */
-    readonly userMessage?: string;
-    /**
-     * The model of the command. Specified only for custom actions.
-     */
-    readonly model?: string;
-    hasError: boolean;
-    /**
-     * Set when this interaction fires `interactionStopped` (see {@link module:ai/aicore/model/aiinteraction~AIInteraction#stop}).
-     */
-    stoppedExplicitly: boolean;
-    constructor(options: AIActionsInteractionOptions);
-    sendRequest(): Promise<AIConnectorRequest>;
-    getDocumentContext(): AIContextItem | undefined;
-    /**
-     * Override createReply to use the same content that was sent to AI for comparison.
-     * This ensures we compare AI response against the selection, not the entire document.
-     * Uses AIActionsReply for single suggestion without context.
-     */
-    createReply(options: ConstructorParameters<typeof AIActionsReply>[0]): AIActionsReply;
+	/**
+	* The content of the document for the command to refer to.
+	*/
+	readonly content: string;
+	/**
+	* The version of the document the content was extracted from.
+	*/
+	readonly version: number;
+	/**
+	* The name of the action to execute. Specified only for predefined actions.
+	*/
+	readonly actionName?: AIActionsNames;
+	/**
+	* The arguments to pass to the action. Specified only for predefined actions.
+	*/
+	readonly args?: Record<string, string>;
+	/**
+	* The user message that was sent to the AI endpoint. Specified only for custom actions.
+	*/
+	readonly userMessage?: string;
+	/**
+	* The model of the command. Specified only for custom actions.
+	*/
+	readonly model?: string;
+	/**
+	* The context attached to the request. Combines the global `ai.defaultContext` entries that apply to the
+	* invoked action with the action's own context.
+	*/
+	readonly context: AIContext;
+	hasError: boolean;
+	/**
+	* Set when this interaction fires `interactionStopped` (see {@link module:ai/aicore/model/aiinteraction~AIInteraction#stop}).
+	*/
+	stoppedExplicitly: boolean;
+	constructor(options: AIActionsInteractionOptions);
+	sendRequest(): AIConnectorRequest;
+	getDocumentContext(): AIContextItem | undefined;
+	/**
+	* Override createReply to use the same content that was sent to AI for comparison.
+	* This ensures we compare AI response against the selection, not the entire document.
+	* Uses AIActionsReply for single suggestion without context.
+	*/
+	override createReply(options: ConstructorParameters<typeof AIActionsReply>[0]): AIActionsReply;
 }
 export type AIActionsInteractionOptions = {
-    content: string;
-    version: number;
+	content: string;
+	version: number;
+	editor: Editor;
+	rootName: string;
 } & AIActionDefinition & AIInteractionOptions;

package/dist/aiactions/model/aiactionsreply.d.ts

@@ -1,16 +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
- */
+* @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/aiactions/model/aiactionsreply
- */
-import { AIReply, type AIReplyChangeGroup } from '../../aicore/model/aireply.js';
+* @module ai/aiactions/model/aiactionsreply
+*/
+import { AIReply, type AIReplyChangeGroup } from "../../aicore/model/aireply.js";
 /**
- * Represents a reply from the AI endpoint specifically for AI Actions.
- * This class handles the unique behavior needed for AI Actions mode,
- * where suggestions are presented as single change groups without context merging.
- */
+* Represents a reply from the AI endpoint specifically for AI Actions.
+* This class handles the unique behavior needed for AI Actions mode,
+* where suggestions are presented as single change groups without context merging.
+*/
 export declare class AIActionsReply extends AIReply {
-    protected _getDifferentChangeGroups(oldGroups: Array<AIReplyChangeGroup>, newGroups: Array<AIReplyChangeGroup>): Array<AIReplyChangeGroup>;
+	/**
+	* Routes incoming modification-delta content to the single synthetic document that AI Actions wires up in
+	* {@link module:ai/aiactions/model/aiactionsinteraction~AIActionsInteraction#createReply `createReply`}. The
+	* server does not stamp `documentId` on AI Actions streams (it's a single-editor flow with no routing key on
+	* the wire), so the default `'text'` would land in the wrong bucket and the modification pipeline would skip it.
+	*/
+	override appendContent(content: string, documentId?: string): void;
+	protected override _getDifferentChangeGroups(oldGroups: Array<AIReplyChangeGroup>, newGroups: Array<AIReplyChangeGroup>): Array<AIReplyChangeGroup>;
 }

package/dist/aiassistant/adapters/aiadapter.d.ts

@@ -1,56 +1,56 @@
 /**
- * @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/aiassistant/adapters/aiadapter
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { type AITextAdapter } from './aitextadapter.js';
+* @module ai/aiassistant/adapters/aiadapter
+* @publicApi
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
+import { type AITextAdapter } from "./aitextadapter.js";
 /**
- * Main adapter plugin that is a common interface between AI features and AI adapters.
- *
- * Various AI features require to make calls to AI services. On the other hand, there are various AI adapters that can be
- * loaded, which provide access to different AI service providers.
- *
- * `AIAdapter` brings both parties together. Features use the `AIAdapter` API that is known to them. On the other hand, a concrete adapter
- * implementation can inject itself into `AIAdapter`. This way features and adapters are decoupled.
- *
- * For example:
- *
- * * `AIAssistant` feature needs to make text AI requests, so it uses `AIAdapter#textAdapter`.
- * * `OpenAITextAdapter` plugin, when loaded, sets itself as `AIAdapter#textAdapter`, so features can use it.
- */
+* Main adapter plugin that is a common interface between AI features and AI adapters.
+*
+* Various AI features require to make calls to AI services. On the other hand, there are various AI adapters that can be
+* loaded, which provide access to different AI service providers.
+*
+* `AIAdapter` brings both parties together. Features use the `AIAdapter` API that is known to them. On the other hand, a concrete adapter
+* implementation can inject itself into `AIAdapter`. This way features and adapters are decoupled.
+*
+* For example:
+*
+* * `AIAssistant` feature needs to make text AI requests, so it uses `AIAdapter#textAdapter`.
+* * `OpenAITextAdapter` plugin, when loaded, sets itself as `AIAdapter#textAdapter`, so features can use it.
+*/
 export declare class AIAdapter extends Plugin {
-    /**
-     * The instance of the loaded AI text adapter instance.
-     *
-     * The adapter is provided by a different plugin that has to be additionally loaded.
-     */
-    textAdapter: AITextAdapter;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIAdapter";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
+	/**
+	* The instance of the loaded AI text adapter instance.
+	*
+	* The adapter is provided by a different plugin that has to be additionally loaded.
+	*/
+	textAdapter: AITextAdapter;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIAdapter";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
 }
 /**
- * Error which may be thrown by various AI adapters.
- *
- * When this error is thrown it should be handled by the feature which used the adapter.
- */
+* Error which may be thrown by various AI adapters.
+*
+* When this error is thrown it should be handled by the feature which used the adapter.
+*/
 export declare class AIRequestError extends Error {
-    constructor(message: string);
+	constructor(message: string);
 }