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

package/dist/aiquickactions/aiquickactionsui.d.ts

@@ -1,134 +1,135 @@
 /**
- * @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
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { BalloonToolbar } from '@ckeditor/ckeditor5-ui';
-import { AIConnector } from '../aicore/aiconnector.js';
-import '../../theme/common/aibutton.css';
-import '../../theme/common/aicolor.css';
-import '../../theme/aiquickactions/aiquickactions.css';
-import { type AIQuickActionType } from './aiquickactions.js';
+* @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
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { AIErrorSink } from "../aicore/aierrorreporter.js";
+import { BalloonToolbar } from "@ckeditor/ckeditor5-ui";
+import { AIConnector } from "../aicore/aiconnector.js";
+import "../../theme/common/aibutton.css";
+import "../../theme/common/aicolor.css";
+import "../../theme/aiquickactions/aiquickactions.css";
+import { type AIQuickActionType } from "./aiquickactions.js";
 /**
- * UI plugin for AI Quick Actions that provides a set of predefined AI-powered tools.
- *
- * This plugin manages the creation and configuration of AI quick action buttons and dropdowns
- * in the editor's toolbar. It handles both individual actions and grouped actions, automatically
- * filtering based on available plugins and creating the appropriate UI components.
- *
- * The plugin supports 2 types of AI actions:
- * - chat: opens interactive AI chat interface,
- * - action: shows results in inline balloon popups.
- */
+* UI plugin for AI Quick Actions that provides a set of predefined AI-powered tools.
+*
+* This plugin manages the creation and configuration of AI quick action buttons and dropdowns
+* in the editor's toolbar. It handles both individual actions and grouped actions, automatically
+* filtering based on available plugins and creating the appropriate UI components.
+*
+* The plugin supports 2 types of AI actions:
+* - chat: opens interactive AI chat interface,
+* - action: shows results in inline balloon popups.
+*/
 export declare class AIQuickActionsUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof BalloonToolbar, typeof AIConnector];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIQuickActionsUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * Initializes the AI Quick Actions UI plugin.
-     *
-     * Sets up the default quick actions configuration and creates all necessary
-     * UI components and commands for the quick actions functionality.
-     *
-     * See {@link module:core/plugin~PluginInterface#init}.
-     */
-    init(): void;
-    /**
-     * Returns the default quick actions configuration.
-     *
-     * @param locale The editor's locale for text translation
-     * @returns Array of quick action definitions and groups
-     */
-    static getDefaultQuickActions(locale: Locale): Array<AIQuickActionsGroupDefinition | AIQuickActionDefinition>;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[BalloonToolbar, AIConnector, AIErrorSink]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AIQuickActionsUI";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* Initializes the AI Quick Actions UI plugin.
+	*
+	* Sets up the default quick actions configuration and creates all necessary
+	* UI components and commands for the quick actions functionality.
+	*
+	* See {@link module:core/plugin~PluginInterface#init}.
+	*/
+	init(): void;
+	/**
+	* Returns the default quick actions configuration.
+	*
+	* @param locale The editor's locale for text translation
+	* @returns Array of quick action definitions and groups
+	*/
+	static getDefaultQuickActions(locale: Locale): Array<AIQuickActionsGroupDefinition | AIQuickActionDefinition>;
 }
 /**
- * Defines a group of related AI quick actions that appear together in a dropdown.
- *
- * Groups allow organizing multiple related actions under a single menu item,
- * such as "Change Tone" containing "More Casual", "More Professional", etc.
- */
+* Defines a group of related AI quick actions that appear together in a dropdown.
+*
+* Groups allow organizing multiple related actions under a single menu item,
+* such as "Change Tone" containing "More Casual", "More Professional", etc.
+*/
 export type AIQuickActionsGroupDefinition = {
-    /**
-     * Unique identifier for the action group.
-     */
-    id: string;
-    /**
-     * Display label for the group.
-     */
-    label: string;
-    /**
-     * Array of actions contained within this group.
-     */
-    actions: Array<AIQuickActionDefinition>;
-    /**
-     * Optional icon to display for the group.
-     */
-    icon?: string;
+	/**
+	* Unique identifier for the action group.
+	*/
+	id: string;
+	/**
+	* Display label for the group.
+	*/
+	label: string;
+	/**
+	* Array of actions contained within this group.
+	*/
+	actions: Array<AIQuickActionDefinition>;
+	/**
+	* Optional icon to display for the group.
+	*/
+	icon?: string;
 };
 /**
- * Defines an individual AI quick action that can be executed by the user.
- *
- * Actions can exist independently or as part of a group. Each action specifies
- * its type to determine the execution interface (chat or balloon).
- */
+* Defines an individual AI quick action that can be executed by the user.
+*
+* Actions can exist independently or as part of a group. Each action specifies
+* its type to determine the execution interface (chat or balloon).
+*/
 export type AIQuickActionDefinition = {
-    /**
-     * Whether the action is enabled.
-     */
-    isEnabled?: boolean;
-    /**
-     * Unique identifier for the action.
-     */
-    id: string;
-    /**
-     * Display label for the action.
-     */
-    label: string;
-    /**
-     * Type determining how the action will be executed.
-     */
-    type: AIQuickActionType;
-    /**
-     * Displayed prompt for the action. Used in the UI to show shorter prompt version in some cases.
-     */
-    displayedPrompt?: string;
-    /**
-     * Optional icon to display for the action.
-     */
-    icon?: string;
-    /**
-     * Optional action name to be used for actions with args.
-     */
-    actionName?: string;
-    /**
-     * Optional parameters for the call.
-     */
-    args?: Record<string, string>;
-    /**
-     * Optional predefined prompt text for the action.
-     */
-    prompt?: string;
-    /**
-     * Optional model to be used.
-     */
-    model?: string;
-    /**
-     * Reference to parent group (if action is part of a group).
-     * Excludes the actions array to prevent circular references.
-     */
-    parent?: Omit<AIQuickActionsGroupDefinition, 'actions'>;
+	/**
+	* Whether the action is enabled.
+	*/
+	isEnabled?: boolean;
+	/**
+	* Unique identifier for the action.
+	*/
+	id: string;
+	/**
+	* Display label for the action.
+	*/
+	label: string;
+	/**
+	* Type determining how the action will be executed.
+	*/
+	type: AIQuickActionType;
+	/**
+	* Displayed prompt for the action. Used in the UI to show shorter prompt version in some cases.
+	*/
+	displayedPrompt?: string;
+	/**
+	* Optional icon to display for the action.
+	*/
+	icon?: string;
+	/**
+	* Optional action name to be used for actions with args.
+	*/
+	actionName?: string;
+	/**
+	* Optional parameters for the call.
+	*/
+	args?: Record<string, string>;
+	/**
+	* Optional predefined prompt text for the action.
+	*/
+	prompt?: string;
+	/**
+	* Optional model to be used.
+	*/
+	model?: string;
+	/**
+	* Reference to parent group (if action is part of a group).
+	* Excludes the actions array to prevent circular references.
+	*/
+	parent?: Omit<AIQuickActionsGroupDefinition, "actions">;
 };

package/dist/aiquickactions/ui/aiquickactionsbuttoncreator.d.ts

@@ -1,64 +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/aiquickactions/ui/aiquickactionsbuttoncreator
- */
-import { type Editor } from '@ckeditor/ckeditor5-core';
-import { ButtonView } from '@ckeditor/ckeditor5-ui';
-import { type AIQuickActionDefinition } from '../aiquickactionsui.js';
+* @module ai/aiquickactions/ui/aiquickactionsbuttoncreator
+*/
+import { type Editor } from "@ckeditor/ckeditor5-core";
+import { ButtonView } from "@ckeditor/ckeditor5-ui";
+import { type AIQuickActionDefinition } from "../aiquickactionsui.js";
 /**
- * Configuration options for aiQuickActionsButtonCreator.
- */
+* Configuration options for aiQuickActionsButtonCreator.
+*/
 export interface AIQuickActionsButtonCreatorOptions {
-    /**
-     * The CKEditor instance that will contain the button.
-     */
-    editor: Editor;
-    /**
-     * The AI quick action definition containing configuration.
-     */
-    action: AIQuickActionDefinition;
-    /**
-     * Whether to show the text label on the button.
-     *
-     * @default false
-     */
-    withText?: boolean;
-    /**
-     * Whether to show the icon on the button.
-     *
-     * @default true
-     */
-    withIcon?: boolean;
-    /**
-     * Whether the button is in a dropdown.
-     *
-     * @default true
-     */
-    isInDropdown?: boolean;
-    /**
-     * Optional callback to check if focus should be prevented.
-     *
-     * @default false
-     */
-    shouldPreventFocus?: () => boolean;
+	/**
+	* The CKEditor instance that will contain the button.
+	*/
+	editor: Editor;
+	/**
+	* The AI quick action definition containing configuration.
+	*/
+	action: AIQuickActionDefinition;
+	/**
+	* Whether to show the text label on the button.
+	*
+	* @default false
+	*/
+	withText?: boolean;
+	/**
+	* Whether to show the icon on the button.
+	*
+	* @default true
+	*/
+	withIcon?: boolean;
+	/**
+	* Whether the button is in a dropdown.
+	*
+	* @default true
+	*/
+	isInDropdown?: boolean;
+	/**
+	* Optional callback to check if focus should be prevented.
+	*
+	* @default false
+	*/
+	shouldPreventFocus?: () => boolean;
 }
 /**
- * Creates a button factory function for AI Quick Actions.
- *
- * This function returns a factory that creates ButtonView instances for individual AI quick actions.
- * Each button is configured with the action's properties (label, icon, type) and sets up the
- * execution logic that triggers the AI command when clicked.
- *
- * The button automatically:
- * - Uses the action's icon or falls back to parent group icon or default icon
- * - Focuses the editor when executed
- * - Hides any open balloon toolbar
- * - Executes the aiQuickActions command with the action details
- *
- * @param options Configuration options for the button creator
- * @returns Factory function that creates a ButtonView instance
- */
+* Creates a button factory function for AI Quick Actions.
+*
+* This function returns a factory that creates ButtonView instances for individual AI quick actions.
+* Each button is configured with the action's properties (label, icon, type) and sets up the
+* execution logic that triggers the AI command when clicked.
+*
+* The button automatically:
+* - Uses the action's icon or falls back to parent group icon or default icon
+* - Focuses the editor when executed
+* - Hides any open balloon toolbar
+* - Executes the aiQuickActions command with the action details
+*
+* @param options Configuration options for the button creator
+* @returns Factory function that creates a ButtonView instance
+*/
 export declare function aiQuickActionsButtonCreator(options: AIQuickActionsButtonCreatorOptions): () => ButtonView;

package/dist/aiquickactions/ui/aiquickactionsdropdowncontentview.d.ts

@@ -1,50 +1,50 @@
 /**
- * @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/aiquickactions/ui/aiquickactionsdropdowncontentview
- */
-import { type Editor } from '@ckeditor/ckeditor5-core';
-import { View, type BodyCollection, type DropdownView, type ViewWithFocusCycler, FocusCycler } from '@ckeditor/ckeditor5-ui';
-import { type AIQuickActionsButtonEntry, type AIQuickActionDefinition, type AIQuickActionsGroupDefinition } from '../aiquickactionsui.js';
-import { FocusTracker, KeystrokeHandler } from '@ckeditor/ckeditor5-utils';
+* @module ai/aiquickactions/ui/aiquickactionsdropdowncontentview
+*/
+import { type Editor } from "@ckeditor/ckeditor5-core";
+import { View, type BodyCollection, type DropdownView, type ViewWithFocusCycler, FocusCycler } from "@ckeditor/ckeditor5-ui";
+import { type AIQuickActionsButtonEntry, type AIQuickActionDefinition, type AIQuickActionsGroupDefinition } from "../aiquickactionsui.js";
+import { FocusTracker, KeystrokeHandler } from "@ckeditor/ckeditor5-utils";
 /**
- * The content view for AI Quick Actions dropdown that renders a structured list of AI commands.
- *
- * This class manages the complete UI for AI Quick Actions, including:
- * - Individual action buttons
- * - Grouped actions with nested menus
- * - Focus management and keyboard navigation
- * - Hover-based menu interactions
- * - Nested panel positioning and visibility
- *
- * The view supports both flat actions and hierarchical action groups with nested menus
- * that appear on hover. It handles proper focus cycling, accessibility roles, and
- * manages the lifecycle of nested balloon panels.
- */
+* The content view for AI Quick Actions dropdown that renders a structured list of AI commands.
+*
+* This class manages the complete UI for AI Quick Actions, including:
+* - Individual action buttons
+* - Grouped actions with nested menus
+* - Focus management and keyboard navigation
+* - Hover-based menu interactions
+* - Nested panel positioning and visibility
+*
+* The view supports both flat actions and hierarchical action groups with nested menus
+* that appear on hover. It handles proper focus cycling, accessibility roles, and
+* manages the lifecycle of nested balloon panels.
+*/
 export declare class AIQuickActionsDropdownContentView extends View implements ViewWithFocusCycler {
-    /**
-     * Tracks information about DOM focus in the form.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    readonly focusCycler: FocusCycler;
-    constructor(editor: Editor, content: Array<AIQuickActionsGroupDefinition | AIQuickActionDefinition>, dropdownView: DropdownView, bodyCollection: BodyCollection, hasSearch?: boolean, actionButtons?: Array<AIQuickActionsButtonEntry>);
-    /**
-     * Resets the search input and restores all list items.
-     * Called when the dropdown is closed to ensure clean state on next open.
-     */
-    resetSearch(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    focus(): void;
+	/**
+	* Tracks information about DOM focus in the form.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+	*/
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* Helps cycling over {@link #_focusables} in the form.
+	*/
+	readonly focusCycler: FocusCycler;
+	constructor(editor: Editor, content: Array<AIQuickActionsGroupDefinition | AIQuickActionDefinition>, dropdownView: DropdownView, bodyCollection: BodyCollection, hasSearch?: boolean, actionButtons?: Array<AIQuickActionsButtonEntry>);
+	/**
+	* Resets the search input and restores all list items.
+	* Called when the dropdown is closed to ensure clean state on next open.
+	*/
+	resetSearch(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	focus(): void;
 }

package/dist/aiquickactions/ui/aiquickactionsdropdowncreator.d.ts

@@ -1,70 +1,70 @@
 /**
- * @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/aiquickactions/ui/aiquickactionsdropdowncreator
- */
-import { type Editor } from '@ckeditor/ckeditor5-core';
-import { type BodyCollection, type DropdownView } from '@ckeditor/ckeditor5-ui';
-import { type AIQuickActionsGroupDefinition, type AIQuickActionDefinition } from '../aiquickactionsui.js';
+* @module ai/aiquickactions/ui/aiquickactionsdropdowncreator
+*/
+import { type Editor } from "@ckeditor/ckeditor5-core";
+import { type BodyCollection, type DropdownView } from "@ckeditor/ckeditor5-ui";
+import { type AIQuickActionsGroupDefinition, type AIQuickActionDefinition } from "../aiquickactionsui.js";
 /**
- * Configuration for the dropdown button appearance.
- */
+* Configuration for the dropdown button appearance.
+*/
 type DropdownButtonDefinition = {
-    /**
-     * Icon to display on the button.
-     */
-    icon: string;
-    /**
-     * Label text for the button.
-     */
-    label: string;
+	/**
+	* Icon to display on the button.
+	*/
+	icon: string;
+	/**
+	* Label text for the button.
+	*/
+	label: string;
 };
 /**
- * Configuration options for aiQuickActionsDropdownCreator.
- */
+* Configuration options for aiQuickActionsDropdownCreator.
+*/
 export interface AIQuickActionsDropdownCreatorOptions {
-    /**
-     * The CKEditor instance that will contain the dropdown.
-     */
-    editor: Editor;
-    /**
-     * Array of AI action definitions or groups to display in the dropdown.
-     */
-    content: Array<AIQuickActionsGroupDefinition | AIQuickActionDefinition>;
-    /**
-     * Configuration for the dropdown button (icon, label).
-     */
-    buttonDefinition: AIQuickActionsGroupDefinition | DropdownButtonDefinition;
-    /**
-     * Body collection for managing UI elements.
-     */
-    bodyCollection: BodyCollection;
-    /**
-     * Whether to show the search input.
-     *
-     * @default false
-     */
-    hasSearch?: boolean;
+	/**
+	* The CKEditor instance that will contain the dropdown.
+	*/
+	editor: Editor;
+	/**
+	* Array of AI action definitions or groups to display in the dropdown.
+	*/
+	content: Array<AIQuickActionsGroupDefinition | AIQuickActionDefinition>;
+	/**
+	* Configuration for the dropdown button (icon, label).
+	*/
+	buttonDefinition: AIQuickActionsGroupDefinition | DropdownButtonDefinition;
+	/**
+	* Body collection for managing UI elements.
+	*/
+	bodyCollection: BodyCollection;
+	/**
+	* Whether to show the search input.
+	*
+	* @default false
+	*/
+	hasSearch?: boolean;
 }
 /**
- * Creates a dropdown factory function for AI Quick Actions.
- *
- * This function returns a factory that creates DropdownView instances containing AI quick actions.
- * The dropdown can contain either individual actions or groups of actions, and automatically
- * handles the UI interaction patterns including:
- *
- * Features:
- * - Configurable button with icon and label
- * - Panel containing AI Quick Actions view
- * - Read-only state binding to editor
- * - Automatic closing and focus management
- * - Balloon toolbar hiding on action selection
- * - Optional search functionality
- *
- * @param options Configuration options for the dropdown creator
- * @returns Factory function that creates a DropdownView instance
- */
+* Creates a dropdown factory function for AI Quick Actions.
+*
+* This function returns a factory that creates DropdownView instances containing AI quick actions.
+* The dropdown can contain either individual actions or groups of actions, and automatically
+* handles the UI interaction patterns including:
+*
+* Features:
+* - Configurable button with icon and label
+* - Panel containing AI Quick Actions view
+* - Read-only state binding to editor
+* - Automatic closing and focus management
+* - Balloon toolbar hiding on action selection
+* - Optional search functionality
+*
+* @param options Configuration options for the dropdown creator
+* @returns Factory function that creates a DropdownView instance
+*/
 export declare function aiQuickActionsDropdownCreator(options: AIQuickActionsDropdownCreatorOptions): () => DropdownView;
 export {};

package/dist/aiquickactions/ui/aiquickactionsfilteredlistview.d.ts

@@ -1,5 +1 @@
-/**
- * @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
- */
 export {};

package/dist/aiquickactions/ui/balloon/aiactionsballoondisclaimerview.d.ts

@@ -1,17 +1,17 @@
 /**
- * @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/aiquickactions/ui/balloon/aiactionsballoondisclaimerview
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { View } from '@ckeditor/ckeditor5-ui';
+* @module ai/aiquickactions/ui/balloon/aiactionsballoondisclaimerview
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { View } from "@ckeditor/ckeditor5-ui";
 /**
- * The disclaimer view of the AI actions plugin.
- *
- * It displays information about the AI actions, such as a reminder to double-check responses.
- */
+* The disclaimer view of the AI actions plugin.
+*
+* It displays information about the AI actions, such as a reminder to double-check responses.
+*/
 export declare class AIActionsBalloonDisclaimerView extends View {
-    constructor(locale: Locale);
+	constructor(locale: Locale);
 }