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

package/dist/ui/aiassistantcontroller.d.ts

@@ -1,113 +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 AITextAdapter from '../adapters/aitextadapter.js';
-import type { default as AIFormView } from './form/aiformview.js';
-import type { AIFormToolbarViewMainActionLabel } from './form/aiformtoolbarview.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-declare const AIAssistantController_base: {
-    new (): import("ckeditor5/src/utils.js").Observable;
-    prototype: import("ckeditor5/src/utils.js").Observable;
-};
-/**
- * Controller for the AI assistant.
-*
- * It takes a AI form view, listens to events fired by that view and based on them performs actions on an AI handler.
- * This controller is also responsible for streaming the AI response for the UI.
- */
-export default class AIAssistantController extends /* #__PURE__ -- @preserve */ AIAssistantController_base {
-    /**
-     * The editor instance.
-     */
-    readonly editor: Editor;
-    /**
-     * An instance of the {@link module:ai/adapters/aitextadapter~AITextAdapter}.
-     */
-    readonly textAdapter: AITextAdapter;
-    /**
-     * An instance of the {@link module:ai/ui/aiformview~AIFormView}.
-     */
-    readonly view: AIFormView;
-    /**
-     * It is the selected HTML content from the editor on which the dialog has been initialized.
-     */
-    initialContext: string;
-    /**
-     * The latest value returned by the AI while executing the request. It is before parsing and normalization.
-     */
-    currentResponse: string;
-    /**
-     * The latest value returned by the AI while executing the request. It is after parsing and normalization. It will be used as context
-     * for the next calls.
-     *
-     * This value is also displayed in the view (after sanitization).
-     */
-    currentContext: string;
-    /**
-     * The previous value of the context for the AI request. It is kept to handle the try again event.
-     *
-     * Initially it is the selected HTML content from the editor. Subsequently, the context is replaced by each response from AI.
-     *
-     * @observable
-     */
-    previousContext?: string;
-    /**
-     * The previous value of the user query. It is kept to handle the try again event.
-     *
-     * @observable
-     */
-    previousQuery?: string;
-    /**
-     * The label of the previous executed query. It is connected to {@link ~AIAssistantController#previousQuery `previousQuery`} and is kept
-     * to handle the "try again" event.
-     *
-     * @observable
-     */
-    previousLabel?: string;
-    /**
-     * The id of the previous executed action. It is kept to handle the try again event.
-     *
-     * @observable
-     */
-    previousActionId?: string;
-    /**
-     * Flag that indicates if the processing is in progress.
-     *
-     * @observable
-     */
-    isProcessing: boolean;
-    /**
-     * @param adapter AI connector instance.
-     * @param view AI form view.
-     */
-    constructor(editor: Editor, adapter: AITextAdapter, view: AIFormView);
-    /**
-     * Destroys `AIAssistantController` instance.
-     */
-    destroy(): void;
-    /**
-     * Handles the initial query for a new context and inits the listener for the visible view.
-     *
-     * This function should be called whenever the AI dialog is displayed.
-     *
-     * @param options
-     * @param options.actionId ID of the performed action. See {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId}.
-     * @param options.htmlContent The selected HTML content on which the AI should base.
-     * @param options.query The initial query to be processed.
-     * @param options.label The label that will be displayed in the view.
-     * @param options.mainActionLabel The action label for the main insertion button.
-     */
-    updateView({ actionId, query, htmlContent, label, mainActionLabel }: {
-        actionId: string;
-        query: string;
-        htmlContent: string;
-        label: string;
-        mainActionLabel: typeof AIFormToolbarViewMainActionLabel[keyof typeof AIFormToolbarViewMainActionLabel];
-    }): Promise<void>;
-}
-export {};

package/dist/ui/form/aiformcontentarea.d.ts

@@ -1,52 +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/ui/aiformcontentarea
- */
-import { type Locale } from 'ckeditor5/src/utils.js';
-import { View, ButtonView } from 'ckeditor5/src/ui.js';
-/**
- * A class representing the text area view of the AI assistant.
- */
-export default class AIFormContentArea extends View {
-    /**
-     * The value which is displayed in the content field.
-     *
-     * @observable
-     */
-    value: string | null;
-    /**
-     * Controls whether the content area is visible.
-     *
-     * @observable
-     * @default false
-     */
-    isVisible: boolean;
-    /**
-     * Indicates if the content area is during processing which can change inner values.
-     */
-    isProcessing: boolean;
-    /**
-     * The textarea view.
-     */
-    contentFieldView: ContentFieldView;
-    /**
-     * The copy button displayed in the bottom-right corner of text area.
-     */
-    copyButtonView: ButtonView;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, extraCssClass?: string);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    focus(): void;
-}

package/dist/ui/form/aiformerrorview.d.ts

@@ -1,30 +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/ui/aiformerrorview
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import { View } from 'ckeditor5/src/ui.js';
-/**
- * A class representing the error view of the AI assistant.
- */
-export default class AIFormErrorView extends View {
-    /**
-     * The text of the error.
-     *
-     * @observable
-     */
-    text: string;
-    /**
-     * Creates an instance of the {@link module:ai/ui/aiformerrorview~AIFormErrorView} class.
-     *
-     * @param locale The localization services instance.
-     */
-    constructor(locale: Locale, text?: string);
-}

package/dist/ui/form/aiformpromptview.d.ts

@@ -1,50 +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/ui/aiformpromptview
- */
-import { type Locale } from 'ckeditor5/src/utils.js';
-import { AutocompleteView, ButtonView, type TextareaView, type AutocompleteViewConfig } from 'ckeditor5/src/ui.js';
-/**
- * A textarea field allowing to ask AI.
- */
-export default class AIFormPromptView extends AutocompleteView<TextareaView> {
-    /**
-     * The submit button view.
-     */
-    submitButtonView: ButtonView;
-    /**
-     * The button that shows and hides the history autocomplete panel.
-     */
-    showHistoryButtonView: ButtonView;
-    /**
-     * Creates `AIFormPromptView` instance.
-     *
-     * @param locale The localization services instance.
-     * @param config Autocomplete config.
-     */
-    constructor(locale: Locale, config: AutocompleteViewConfig<TextareaView>);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(direction?: 1 | -1): void;
-}
-/**
- * Fired when the query is submitted by the user.
- *
- * @eventName ~AIFormPromptView#submit
- */
-export type AIFormPromptViewSubmitEvent = {
-    name: 'submit';
-    args: [query: string];
-};

package/dist/ui/form/aiformtoolbarview.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/ui/aiformtoolbarview
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import { ToolbarView, ButtonView } from 'ckeditor5/src/ui.js';
-/**
- * The action name affecting the label of {@link ~AIFormToolbarView#replaceButton}.
- *
- * Available keys are:
- * * `AIFormToolbarViewMainActionLabel.REPLACE`,
- * * `AIFormToolbarViewMainActionLabel.INSERT`
- */
-export declare const AIFormToolbarViewMainActionLabel: {
-    readonly REPLACE: "replace";
-    readonly INSERT: "insert";
-};
-/**
- * A class representing the text area view of the AI assistant.
- */
-export default class AIFormToolbarView extends ToolbarView {
-    /**
-     * Controls whether the toolbar is visible.
-     *
-     * @observable
-     * @default false
-     */
-    isVisible: boolean;
-    /**
-     * Button that is used to replace the selected content by the generated one.
-     */
-    replaceButton: ButtonView;
-    /**
-     * Button that is used to insert the generated content below the selection.
-     */
-    insertButton: ButtonView;
-    /**
-     * Button that is used to regenerate the response.
-     */
-    tryAgainButton: ButtonView;
-    /**
-     * Button that is used to stop the processing of the request.
-     */
-    stopButton: ButtonView;
-    /**
-     * The action name affecting the label of {@link #replaceButton}.
-     *
-     * @default 'replace'
-     */
-    mainAction: typeof AIFormToolbarViewMainActionLabel[keyof typeof AIFormToolbarViewMainActionLabel];
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale);
-}

package/dist/ui/form/aiformview.d.ts

@@ -1,145 +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/ui/aiformview
- */
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import { View, type ViewWithFocusCycler } from 'ckeditor5/src/ui.js';
-import AIFormToolbarView, { AIFormToolbarViewMainActionLabel } from './aiformtoolbarview.js';
-import AIFormContentArea from './aiformcontentarea.js';
-import AIFormErrorView from './aiformerrorview.js';
-import AIFormPromptView from './aiformpromptview.js';
-/**
- * A class representing the form view of the AI assistant.
- */
-export default class AIFormView extends View implements ViewWithFocusCycler {
-    /**
-     * Tracks information about the DOM focus in the form.
-     *
-     * @readonly
-     */
-    focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     *
-     * @readonly
-     */
-    keystrokes: KeystrokeHandler;
-    /**
-     * The text area view that is used to display AI response.
-     */
-    contentArea: AIFormContentArea;
-    /**
-     * Toolbar view containing button views that manage the AI response and this form itself.
-     */
-    toolbar: AIFormToolbarView;
-    /**
-     * The component used for handling the user's query, including history and submit buttons.
-     */
-    promptView: AIFormPromptView;
-    /**
-     * View that is used to display the error message.
-     */
-    errorView: AIFormErrorView;
-    /**
-     * The prompt text can be configured either during construction when the AI command has been selected,
-     * or later by submitting the {@link #labeledInput}, if it hasn't been previously initialized.
-     * After setting this value the AI request is triggered.
-     */
-    prompt: string;
-    /**
-     * The value that is generated after user submitting the user prompt.
-     */
-    value: string;
-    /**
-     * Flag that indicates if the AI assistant form view is enabled or disabled.
-     *
-     * If it is disabled, all interactive elements of this view are disabled as well.
-     */
-    isEnabled: boolean;
-    /**
-     * Indicates if the AI request is processing.
-     */
-    isProcessing: boolean;
-    /**
-     * Indicates if the AI request failed.
-     */
-    isError: boolean;
-    /**
-     * The action name for the main insertion button in the {@link #toolbar}.
-     *
-     * See {@link module:ai/ui/aiformtoolbarview~AIFormToolbarView#replaceButton}.
-     *
-     * @default 'replace'
-     */
-    mainAction: typeof AIFormToolbarViewMainActionLabel[keyof typeof AIFormToolbarViewMainActionLabel];
-    /**
-     * Creates an instance of the {@link module:ai/ui/aiformview~AIFormView} class.
-     *
-     * @param locale The localization services instance.
-     */
-    constructor(locale: Locale, uiClasses: string, contentAreaCssClass?: string);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(direction?: 1 | -1): void;
-    /**
-     * Resets the form to the initial values.
-     */
-    reset(): void;
-}
-/**
- * Fired when a user performed an action that should lead to replace the current selection by generated content.
- *
- * @eventName ~AIFormView#replaceContent
- */
-export type ReplaceContentEvent = {
-    name: 'replaceContent';
-    args: [];
-};
-/**
- * Fired when a user performed an action that should lead to insert generated content below the current selection.
- *
- * @eventName ~AIFormView#insertContentBelow
- */
-export type InsertContentBelowEvent = {
-    name: 'insertContentBelow';
-    args: [];
-};
-/**
- * Fired when a user performed an action that should lead to retry the previous request to AI.
- *
- * @eventName ~AIFormView#tryAgainEvent
- */
-export type TryAgainEvent = {
-    name: 'tryAgainEvent';
-    args: [];
-};
-/**
- * Fired when a user performed an action that should lead to stop the processing of AI.
- *
- * @eventName ~AIFormView#stopProcessing
- */
-export type StopProcessingEvent = {
-    name: 'stopProcessing';
-    args: [];
-};
-/**
- * Fired when a user performed an action that should lead to ask AI.
- *
- * @eventName ~AIFormView#submitPrompt
- */
-export type SubmitPromptEvent = {
-    name: 'submitPrompt';
-    args: [prompt: string];
-};

package/dist/ui/form/aihistorylistitemview.d.ts

@@ -1,22 +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/ui/aihistorylistitemview
- */
-import { ListItemView } from 'ckeditor5/src/ui.js';
-import type { PromptHistoryEntry } from './prompthistory.js';
-/**
- * A list item view that displays a historical prompt
- */
-export default class AIHistoryListItemView extends ListItemView {
-    /**
-     * @inheritDoc
-     */
-    constructor(promptHistoryEntry: PromptHistoryEntry);
-}

package/dist/ui/form/aihistorylistview.d.ts

@@ -1,39 +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/ui/aihistorylistview
- */
-import { ListView, ListItemGroupView, ButtonView, type FilteredView } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-/**
- * A list view that displays a list of AI prompts with filter pass-through.
- *
- * @private
- */
-export default class AIHistoryListView extends ListView implements FilteredView {
-    historyGroupView: ListItemGroupView;
-    clearHistoryButton: ButtonView;
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    filter(): {
-        resultsCount: number;
-        totalItemsCount: number;
-    };
-}
-/**
- * Fired when the clear history button was executed by the user.
- *
- * @eventName ~AIHistoryListView#clearHistory
- */
-export type AIHistoryListViewClearHistoryEvent = {
-    name: 'clearHistory';
-    args: [];
-};

package/dist/ui/form/prompthistory.d.ts

@@ -1,24 +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 { Collection } from 'ckeditor5/src/utils.js';
-/**
- * A collection that stores the prompt history in the session storage as a side effect.
- */
-export default class PromptHistory extends Collection<PromptHistoryEntry> {
-    /**
-     * @inheritDoc
-     */
-    constructor();
-}
-/**
- * An object that represents a historical prompt.
- */
-export type PromptHistoryEntry = {
-    prompt: string;
-};

package/dist/ui/showaiassistantcommand.d.ts

@@ -1,44 +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/ui/showaiassistantcommand
- * @publicApi
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-import type { CommandDefinition } from '../aiassistant.js';
-/**
- * Command that shows the AI Assistant user interface.
- */
-export default class ShowAIAssistantCommand extends Command {
-    /**
-     * An array with ids of the AI commands enabled for the current selection.
-     *
-     * @observable
-     */
-    enabledCommandsIds: Array<string>;
-    /**
-     * Creates an instance of the command.
-     */
-    constructor(editor: Editor, commandDefinitions: Array<CommandDefinition>);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Opens AI Assistant user interface for the current document selection.
-     *
-     * @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. It
-     * will be prefixed with `aiAssistant:`. See also
-     * {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId `AITextAdapterRequestData#actionId`}.
-     * @fires execute
-     */
-    execute(query?: string, label?: string, actionId?: string): void;
-}

package/dist/utils/common-translations.d.ts

@@ -1,13 +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/utils/common-translations
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string, values?: string | Array<string> | number): string;

package/dist/utils/normalizecommandsconfig.d.ts

@@ -1,18 +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/utils/normalizecommandsconfig
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import type { GroupDefinition, CommandDefinition } from '../aiassistant.js';
-export declare const UNGROUPED_COMMANDS_GROUP_ID = "_ungrouppedCommands";
-/**
- * Normalizes the `config.ai.aiAssistant.commands` configuration taking into account different possible config formats (or lack thereof).
- */
-export declare function normalizeCommandsConfig(config: Array<GroupDefinition | CommandDefinition>, locale: Locale): Array<GroupDefinition>;