@ckeditor/ckeditor5-ai 44.1.0 → 44.2.0-alpha.0

package/dist/aiassistant.d.ts

@@ -1,393 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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
- * @publicApi
- */
-import { type Locale } from 'ckeditor5/src/utils.js';
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import AIAssistantUI from './aiassistantui.js';
-import AIAssistantEditing from './aiassistantediting.js';
-/**
- * AI assistant plugin that allows you to use external AI models to generate content or improve existing content.
- *
- * The feature uses following {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} values:
- *
- * * `aiAssistant:command:<commandId>` for the predefined commands, where `<commandId>` is the ID of the predefined command,
- * * `aiAssistant:custom` for custom queries provided by the user.
- */
-export default class AIAssistant extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AIAssistantUI, typeof AIAssistantEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIAssistant";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-}
-/**
- * A function that returns the list of the default AI commands definitions in the given localization context.
- */
-export declare function getDefaultCommands(locale: Locale): Array<GroupDefinition>;
-/**
- * The configuration of the AI Assistant feature.
- *
- * The properties defined in this config are set in the `config.ai.aiAssistant` namespace.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		ai: {
- * 		    aiAssistant: {
- * 		        // AI Assistant 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 AIAssistantConfig {
-    /**
-     * A list of all AI commands groups definitions to be displayed in the `'aiCommands'` UI dropdown.
-     *
-     * Setting this property will overwrite the default list of predefined commands.
-     *
-     * You can avoid creating any groups by providing a list of command definitions directly. In this case,
-     * commands will render as a flat list in the user interface.
-     *
-     * The default configuration is as follows. It can be obtained through {@link ~getDefaultCommands}:
-     *
-     * ```json
-     * [ {
-     * 	groupId: 'editOrReview',
-     * 	groupLabel: 'Edit or review',
-     * 	commands: [
-     * 		{
-     * 			id: 'improveWriting',
-     * 			label: 'Improve writing',
-     * 			prompt: 'Fix spelling mistakes, use proper grammar and apply good writing practices. Do not lose the original meaning.'
-     * 		},
-     * 		{
-     * 			id: 'makeShorter',
-     * 			label: 'Make shorter',
-     * 			prompt: 'Remove any repetitive, redundant, or non-essential writing in this content ' +
-     * 				'without changing the meaning or losing any key information.'
-     * 		},
-     * 		{
-     * 			id: 'makeLonger',
-     * 			label: 'Make longer',
-     * 			prompt: 'Improve this content by using descriptive language and inserting more information and more detailed explanations.'
-     * 		},
-     * 		{
-     * 			id: 'simplifyLanguage',
-     * 			label: 'Simplify language',
-     * 			prompt: 'Simplify the writing style of this content ' +
-     * 				'and reduce the complexity, so that the content is easy to understand.'
-     * 		}
-     * 	]
-     * },
-     * {
-     * 	groupId: 'generate',
-     * 	groupLabel: 'Generate from selection',
-     * 	commands: [
-     * 		{
-     * 			id: 'summarize',
-     * 			label: 'Summarize',
-     * 			prompt: 'Summarize this content into one paragraph of text. Include only the key ideas and conclusions. Keep it short. '
-     * 		},
-     * 		{
-     * 			id: 'continue',
-     * 			label: 'Continue',
-     * 			prompt: 'Start with the provided content and write at the end of it continuing this topic. Keep the added part short.'
-     * 		}
-     * 	]
-     * },
-     * {
-     * 	groupId: 'changeTone',
-     * 	groupLabel: 'Change tone',
-     * 	commands: [
-     * 		{
-     * 			id: 'professional',
-     * 			label: 'Professional',
-     * 			prompt: 'Improve using polished, formal, and respectful language ' +
-     * 				'to convey professional expertise and competence.'
-     * 		},
-     * 		{
-     * 			id: 'casual',
-     * 			label: 'Casual',
-     * 			prompt: 'Improve using casual, informal language to convey a casual conversation with a real person.'
-     * 		},
-     * 		{
-     * 			id: 'direct',
-     * 			label: 'Direct',
-     * 			prompt: 'Improve using direct language using only the essential information.'
-     * 		},
-     * 		{
-     * 			id: 'confident',
-     * 			label: 'Confident',
-     * 			prompt: 'Improve using compelling, optimistic language to convey confidence in the writing.'
-     * 		},
-     * 		{
-     * 			id: 'friendly',
-     * 			label: 'Friendly',
-     * 			prompt: 'Improve using friendly, comforting language, to convey understanding and empathy.'
-     * 		}
-     * 	]
-     * },
-     * {
-     * 	groupId: 'changeStyle',
-     * 	groupLabel: 'Change style',
-     * 	commands: [
-     * 		{
-     * 			id: 'business',
-     * 			label: 'Business',
-     * 			prompt: 'Rewrite this content as a business professional with formal language.'
-     * 		},
-     * 		{
-     * 			id: 'legal',
-     * 			label: 'Legal',
-     * 			prompt: 'Rewrite this content as a legal professional using valid legal terminology.'
-     * 		},
-     * 		{
-     * 			id: 'journalism',
-     * 			label: 'Journalism',
-     * 			prompt: 'Rewrite this content as a journalist using engaging language to convey the importance of the information.'
-     * 		},
-     * 		{
-     * 			id: 'poetic',
-     * 			label: 'Poetic',
-     * 			prompt: 'Rewrite this content as a poem using poetic techniques without losing the original meaning.'
-     * 		}
-     * 	]
-     * },
-     * {
-     * 	groupId: 'translate',
-     * 	groupLabel: 'Translate',
-     * 	commands: [
-     * 		{
-     * 			id: 'translateEnglish',
-     * 			label: 'English',
-     * 			prompt: 'Translate the content to English language.'
-     * 		},
-     * 		{
-     * 			id: 'translateSpanish',
-     * 			label: 'Spanish',
-     * 			prompt: 'Translate the content to Spanish language.'
-     * 		},
-     * 		{
-     * 			id: 'translatePortuguese',
-     * 			label: 'Portuguese',
-     * 			prompt: 'Translate the content to Portuguese language.'
-     * 		},
-     * 		{
-     * 			id: 'translateGerman',
-     * 			label: 'German',
-     * 			prompt: 'Translate the content to German language.'
-     * 		},
-     * 		{
-     * 			id: 'translateFrench',
-     * 			label: 'French',
-     * 			prompt: 'Translate the content to French language.'
-     * 		},
-     * 		{
-     * 			id: 'translateChinese',
-     * 			label: 'Simplified Chinese',
-     * 			prompt: 'Translate the content to Simplified Chinese language.'
-     * 		},
-     * 		{
-     * 			id: 'translateHindi',
-     * 			label: 'Hindi',
-     * 			prompt: 'Translate the content to Hindi language.'
-     * 		},
-     * 		{
-     * 			id: 'translateArabic',
-     * 			label: 'Arabic',
-     * 			prompt: 'Translate the content to Arabic language.'
-     * 		}
-     * 	]
-     * } ]
-     * ```
-     */
-    commands?: Array<GroupDefinition> | Array<CommandDefinition>;
-    /**
-     * A list of additional AI commands groups definitions that will extend
-     * {@link module:ai/aiassistant~AIAssistantConfig#commands default commands}.
-     *
-     * You can define new AI commands groups or add new AI commands to existing groups. If you add AI commands to an existing group,
-     * you do not need to specify `groupLabel` property. Use the (optional) `order` property to control the position of new groups
-     * and commands.
-     *
-     * An example configuration:
-     *
-     * ```json
-     * {
-     * 	aiAssistant: {
-     * 		extraCommandGroups: [
-     * 			// Add an AI command to an existing group:
-     * 			{
-     *				groupId: 'changeTone',
-     *				commands: [
-     *					{
-     *						id: 'sad',
-     *						label: 'Sad',
-     *						prompt: 'Rewrite this text to make it sound sad and depressing.',
-     *						// You can specify the position of this command among existing ones. Commands use zero-based numbering.
-     *						order: 2
-     *					}
-     *				]
-     * 			},
-     * 			// Create a new AI commands group:
-     * 			{
-     * 				groupId: 'transformations',
-     * 				groupLabel: 'Transformations',
-     *				// You can specify the position of this group among existing ones. Groups use zero-based numbering.
-     * 				order: 3,
-     * 				commands: [
-     * 					{
-     * 						id: 'addEmojis',
-     * 						label: 'Add emojis',
-     * 						prompt: 'Analyze each sentence of this text. After each sentence add an emoji that summarizes the sentence.'
-     * 					},
-     * 					// ...
-     * 				]
-     * 			},
-     * 		],
-     * 		// ...
-     * 	}
-     * }
-     * ```
-     */
-    extraCommandGroups?: Array<GroupDefinition>;
-    /**
-     * A list of ids of AI commands to be removed.
-     *
-     * Learn more about {@link module:ai/aiassistant~CommandDefinition command definition and its id}.
-     *
-     * An example configuration:
-     *
-     * ```json
-     * {
-     * 	aiAssistant: {
-     * 		removeCommands: [
-     * 			'improveWriting',
-     * 			// ...
-     * 		],
-     * 		// ...
-     * 	}
-     * }
-     * ```
-     */
-    removeCommands?: Array<string>;
-    /**
-     * An additional CSS class name (or names) added to the AI assistant content area (model response area).
-     *
-     * Because the content area is usually detached from the flow of the document, this configuration
-     * allows for better integration with application's stylesheets and improves the consistency of content
-     * styles.
-     */
-    contentAreaCssClass?: string;
-    /**
-     * The AI assistant feature will be disabled if the document selection includes any of these elements.
-     *
-     * Use this property if AI assistant does not work properly with your custom features.
-     *
-     * Currently, by default, AI assistant is disabled for following model elements:
-     *
-     * * Media embed (`'media'`) -- does not display in response area,
-     * * HTML embed (`'rawHtml'`) -- sometimes does not display in response area, security uncertainty,
-     * * Table of contents (`'tableOfContents'`) -- does not display properly in response area, long processing time.
-     *
-     * You can set this list to include more model elements or clear it to enable the above features.
-     *
-     * Note, that all or some of these features may become enabled in the future.
-     *
-     * @default [ 'media', 'rawHtml', 'tableOfContents' ]
-     */
-    disabledElements?: Array<string>;
-}
-export type GroupDefinition = {
-    /**
-     * The unique identifier of the group. It can be referenced while extending existing groups
-     * using {@link module:ai/aiassistant~AIAssistantConfig#extraCommandGroups}.
-     */
-    groupId: string;
-    /**
-     * The human-readable label of the group.
-     */
-    groupLabel?: string;
-    /**
-     * The array of command definitions that belong to the group.
-     */
-    commands: Array<CommandDefinition>;
-    /**
-     * The order of the group on the list. The lower the number, the higher the group is displayed on the list.
-     * If not specified, the position of this group will be determined by the order of
-     * {@link module:ai/aiassistant~AIAssistantConfig#commands configuration}.
-     *
-     * If a new group is added without `order` property, it will be added at the end.
-     *
-     * The order uses zero-based numbering (the first group's order is `0`).
-     */
-    order?: number;
-};
-export type CommandDefinition = {
-    /**
-     * The unique identifier of the command. It can be referenced while removing commands. See
-     * {@link module:ai/aiassistant~AIAssistantConfig#removeCommands} to learn more.
-     */
-    id: string;
-    /**
-     * The human-readable label of the command.
-     */
-    label: string;
-    /**
-     * The instruction that will be passed to the AI model.
-     *
-     * It is wrapped in a "full prompt template" for better results.
-     */
-    prompt: string;
-    /**
-     * By default, all commands require a selection for the assistant to work on. If the selection is collapsed,
-     * it automatically expands to the nearest block boundaries to provide the AI context.
-     *
-     * Setting this to `false` allows the command to work on a collapsed selection and prevent selection expansion.
-     * This is helpful, for instance, for commands that generate content from scratch.
-     *
-     * **Note**: If not specified, the default is `true`.
-     */
-    requiresContent?: boolean;
-    /**
-     * The order of the command on the list. The lower the number, the higher the command is displayed on the list.
-     * If not specified, the position of this command will be determined by the order of
-     * {@link module:ai/aiassistant~AIAssistantConfig#commands configuration}.
-     *
-     * If a new command is added without `order` property, it will be added at the end of the group.
-     *
-     * The order uses zero-based numbering (the first command's order is `0`).
-     */
-    order?: number;
-};

package/dist/aiassistantediting.d.ts

@@ -1,59 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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 'ckeditor5/src/core.js';
-import type { Position } from 'ckeditor5/src/engine.js';
-/**
- * The AI assistant editing plugin.
- */
-export default class AIAssistantEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIAssistantEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Displays a fake visual selection.
-     *
-     * This adds a 'ai-ui-candidate' (for the commands dropdown) or 'ai-ui' (for the assistant dialog)
-     * marker into the document that is rendered as a highlight on selected text fragment.
-     */
-    showFakeVisualSelection(): void;
-    /**
-     * Removes a fake visual selection.
-     *
-     * This clears a 'ai-ui-candidate' (for the commands dropdown) or 'ai-ui' (for the assistant dialog)
-     * marker from the document.
-     */
-    hideFakeVisualSelection(): void;
-    /**
-     * Converts the HTML string into the model fragment and inserts it at the specified position.
-     *
-     * If a position is not provided, the insertion will replace the visual selection marker.
-     */
-    insertContent(content: string, position?: Position): void;
-    /**
-     * Converts the HTML string into the model fragment and inserts it below the visual selection marker.
-     */
-    insertContentBelow(content: string): void;
-}

package/dist/aiassistantui.d.ts

@@ -1,62 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module ai/aiassistantui
- * @publicApi
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { Dialog } from 'ckeditor5/src/ui.js';
-import AIAssistantEditing from './aiassistantediting.js';
-import AIAdapter from './adapters/aiadapter.js';
-import '../theme/ai.css';
-import '../theme/ai-dropdown.css';
-import '../theme/ai-form.css';
-import { ClipboardMarkersUtils } from 'ckeditor5/src/clipboard.js';
-/**
- * The UI plugin of the AI assistant.
- */
-export default class AIAssistantUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AIAssistantUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ClipboardMarkersUtils, typeof AIAssistantEditing, typeof AIAdapter, typeof Dialog];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    destroy(): void;
-    /**
-     * Initializes the AI Assistant main view and displays it in a dialog, based on the selection. Also, shows fake selection marker.
-     *
-     * @param query The initial query. If set, the AI assistant will automatically submit given query to the AI service.
-     * @param label Label to be displayed in the AI assistant query input field while the AI assistant processes the initial query.
-     * @param actionId The id of the executed action. It can be used in extended and custom adapters to customize the request.
-     */
-    showUI(query?: string, label?: string, actionId?: string): void;
-    /**
-     * Hides the AI dialog.
-     */
-    hideUI(): void;
-}

package/dist/aiconfig.d.ts

@@ -1,73 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module ai/aiconfig
- * @publicApi
- */
-import type { AIAssistantConfig } from './aiassistant.js';
-import type { OpenAITextAdapterConfig } from './adapters/openaitextadapter.js';
-import type { AWSTextAdapterConfig } from './adapters/awstextadapter.js';
-/**
- * The configuration for all AI-related functionalities.
- *
- * Provides configuration properties for both AI features and AI adapters (which connect to the external AI services),
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		ai: {
- * 			openAI: {
- * 				requestHeaders: {
- * 					Authorization: 'Bearer API_KEY'
- * 				}
- * 			},
- * 			useTheme: false
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- */
-export default interface AIConfig {
-    /**
-     * The configuration of the {@link module:ai/aiassistant~AIAssistant AI Assistant feature}.
-     *
-     * Read more in {@link module:ai/aiassistant~AIAssistantConfig}.
-     */
-    aiAssistant?: AIAssistantConfig;
-    /**
-     * The configuration for the {@link module:ai/adapters/openaitextadapter~OpenAITextAdapter `OpenAITextAdapter`}.
-     *
-     * This is required only if you connect to OpenAI or Azure OpenAI service.
-     *
-     * Read more in {@link module:ai/adapters/openaitextadapter~OpenAITextAdapterConfig}.
-     */
-    openAI?: OpenAITextAdapterConfig;
-    /**
-     * The configuration for the {@link module:ai/adapters/awstextadapter~AWSTextAdapter `AWSTextAdapter`}.
-     *
-     * This is required only if you connect to Amazon Bedrock service.
-     *
-     * Read more in {@link module:ai/adapters/awstextadapter~AWSTextAdapterConfig}.
-     */
-    aws?: AWSTextAdapterConfig;
-    /**
-     * Enables or disables the colored UI theme for AI features.
-     *
-     * * Leaving this property unset will preserve the default theme on AI features UI elements.
-     * * Setting this property to **`false`** will remove the default theme from AI features UI elements.
-     *
-     * See the AI Assistant integration guide to learn how you can use CSS variables to change the default theme to a different color.
-     *
-     * @default true
-     */
-    useTheme?: boolean;
-}

package/dist/augmentation.d.ts

@@ -1,31 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type AIAssistant from './aiassistant.js';
-import type ShowAIAssistantCommand from './ui/showaiassistantcommand.js';
-import type AIAssistantEditing from './aiassistantediting.js';
-import type AIAssistantUI from './aiassistantui.js';
-import type AIConfig from './aiconfig.js';
-import type AIAdapter from './adapters/aiadapter.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * Configuration for AI features.
-         */
-        ai?: AIConfig;
-    }
-    interface PluginsMap {
-        [AIAdapter.pluginName]: AIAdapter;
-        [AIAssistant.pluginName]: AIAssistant;
-        [AIAssistantUI.pluginName]: AIAssistantUI;
-        [AIAssistantEditing.pluginName]: AIAssistantEditing;
-    }
-    interface CommandsMap {
-        showAIAssistant: ShowAIAssistantCommand;
-    }
-}

package/dist/index.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module ai
- */
-export { default as AIAssistant } from './aiassistant.js';
-export { default as AIAdapter, AIRequestError } from './adapters/aiadapter.js';
-export { default as AITextAdapter, type AITextAdapterRequestData, type RequestHeaders, type RequestParameters, type AITextAdapterDataCallback } from './adapters/aitextadapter.js';
-export { default as OpenAITextAdapter, type OpenAITextAdapterConfig } from './adapters/openaitextadapter.js';
-export { default as AWSTextAdapter, type AWSTextAdapterConfig } from './adapters/awstextadapter.js';
-import './augmentation.js';

package/dist/legacyerrors.d.ts

@@ -1,9 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-export {};