@ckeditor/ckeditor5-ai 0.0.0-internal-20241017.0

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

@@ -0,0 +1,145 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @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

@@ -0,0 +1,22 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @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

@@ -0,0 +1,39 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @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

@@ -0,0 +1,24 @@
+/**
+ * @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-oss-license
+ */
+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

@@ -0,0 +1,44 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @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

@@ -0,0 +1,13 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @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

@@ -0,0 +1,18 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @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>;

package/lang/contexts.json

@@ -0,0 +1,56 @@
+{
+  "Edit or review": "AI command group label for editing and reviewing.",
+  "Improve writing": "Label for the AI command to improve the writing of content.",
+  "Make shorter": "Label for the AI command to make the content shorter.",
+  "Make longer": "Label for the AI command to make the content longer.",
+  "Simplify language": "Label for the AI command to simplify the language of content.",
+  "Generate from selection": "AI command group label for generating content from selection.",
+  "Summarize": "Label for the AI command to provide a summary of content.",
+  "Continue": "Label for the AI command to continue the content.",
+  "Change tone": "AI command group label for changing the tone of content.",
+  "Professional": "Label for the AI command to rewrite content in a professional tone.",
+  "Casual": "Label for the AI command to rewrite content in a casual tone.",
+  "Direct": "Label for the AI command to rewrite content in a direct manner.",
+  "Confident": "Label for the AI command to rewrite content in a confident tone.",
+  "Friendly": "Label for the AI command to rewrite content in a friendly tone.",
+  "Change style": "AI command group label for changing the style of content.",
+  "Business": "Label for the AI command to rewrite content in a business style.",
+  "Legal": "Label for the AI command to rewrite content in a legal style.",
+  "Journalism": "Label for the AI command to rewrite content in a journalistic style.",
+  "Poetic": "Label for the AI command to rewrite content poetically.",
+  "Translate": "AI command group label for translating the content.",
+  "English": "Translate to (English)",
+  "Spanish": "Translate to (Spanish)",
+  "German": "Translate to (German)",
+  "Portuguese": "Translate to (Portuguese)",
+  "French": "Translate to (French)",
+  "Simplified Chinese": "Translate to (Simplified Chinese)",
+  "Hindi": "Translate to (Hindi)",
+  "Arabic": "Translate to (Arabic)",
+  "AI Assistant": "The heading element name displayed in the AI dialog and the button tooltip that opens the dialog.",
+  "AI Commands": "The toolbar button tooltip for the dropdown with predefined AI commands.",
+  "Ask AI to edit or generate": "The placeholder for the prompt input to obtain new content.",
+  "Ask AI to improve generated text": "The placeholder for the prompt input to improve the generated content.",
+  "Copy": "The label for the button that copies the text from the textarea.",
+  "Submit": "The label for the button that submits the entered AI prompt.",
+  "Insert below": "The label for the button that inserts the generated AI response below the current selection.",
+  "Try again": "The label for the button that repeats the request to AI.",
+  "Stop": "The label for the button that stops the generating of the content by AI.",
+  "AI is writing...": "The label that indicates the AI is generating content.",
+  "AI is writing": "Aria status message indicating that the AI is generating content. Example: 'AI busy writing'.",
+  "Generated content: %0": "Aria status message indicating the AI generated content. Example: 'Generated content: [text generated by the AI model]'.",
+  "Error during AI content generation: %0": "Aria status message indicating that an error has occurred during the generation of AI content. Example: 'Error during AI content generation: [text of an error]'.",
+  "History": "The label of the button that toggles the prompt history pane in the AI dialog.",
+  "Empty history": "The primary information text displayed when the prompt history is empty.",
+  "Ask AI and your prompts will be listed here for you to use later.": "The secondary information text displayed when the prompt history is empty.",
+  "Prompt history": "The label of the list group that hosts historical user prompts in the AI dialog.",
+  "Other": "The default label of the \"ungrouped\" commands group in the AI Commands list.",
+  "AI_REPLACE_CONTENT": "The label for the button that replaces the selected content by the generated AI response.",
+  "AI_INSERT_CONTENT": "The label for the button that inserts the generated AI response.",
+  "AI_ERROR_GET_HEADERS": "Error message displayed when preparing request headers fails.",
+  "AI_ERROR_GET_PARAMETERS": "Error message displayed when preparing request parameters fails.",
+  "AI_ERROR_UNSUPPORTED_MODEL": "Error message displayed when the requested AI model is not supported.",
+  "AI_ERROR_CONTEXT_LENGTH": "Error message displayed when the content selected for AI processing is too long",
+  "AI_ERROR_MODERATION": "Error message displayed when a request is abusive, harmful or hateful and was rejected due to moderation rules.",
+  "AI_ERROR_FAILED": "Generic error message displayed when the request failed for unspecified reason."
+}

package/lang/translations/af.po

@@ -0,0 +1,230 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Afrikaans (https://app.transifex.com/ckeditor/teams/11143/af/)\n"
+"Language: af\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "AI command group label for editing and reviewing."
+msgid "Edit or review"
+msgstr ""
+
+msgctxt "Label for the AI command to improve the writing of content."
+msgid "Improve writing"
+msgstr ""
+
+msgctxt "Label for the AI command to make the content shorter."
+msgid "Make shorter"
+msgstr ""
+
+msgctxt "Label for the AI command to make the content longer."
+msgid "Make longer"
+msgstr ""
+
+msgctxt "Label for the AI command to simplify the language of content."
+msgid "Simplify language"
+msgstr ""
+
+msgctxt "AI command group label for generating content from selection."
+msgid "Generate from selection"
+msgstr ""
+
+msgctxt "Label for the AI command to provide a summary of content."
+msgid "Summarize"
+msgstr ""
+
+msgctxt "Label for the AI command to continue the content."
+msgid "Continue"
+msgstr ""
+
+msgctxt "AI command group label for changing the tone of content."
+msgid "Change tone"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content in a professional tone."
+msgid "Professional"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content in a casual tone."
+msgid "Casual"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content in a direct manner."
+msgid "Direct"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content in a confident tone."
+msgid "Confident"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content in a friendly tone."
+msgid "Friendly"
+msgstr ""
+
+msgctxt "AI command group label for changing the style of content."
+msgid "Change style"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content in a business style."
+msgid "Business"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content in a legal style."
+msgid "Legal"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content in a journalistic style."
+msgid "Journalism"
+msgstr ""
+
+msgctxt "Label for the AI command to rewrite content poetically."
+msgid "Poetic"
+msgstr ""
+
+msgctxt "AI command group label for translating the content."
+msgid "Translate"
+msgstr ""
+
+msgctxt "Translate to (English)"
+msgid "English"
+msgstr ""
+
+msgctxt "Translate to (Spanish)"
+msgid "Spanish"
+msgstr ""
+
+msgctxt "Translate to (German)"
+msgid "German"
+msgstr ""
+
+msgctxt "Translate to (Portuguese)"
+msgid "Portuguese"
+msgstr ""
+
+msgctxt "Translate to (French)"
+msgid "French"
+msgstr ""
+
+msgctxt "Translate to (Simplified Chinese)"
+msgid "Simplified Chinese"
+msgstr ""
+
+msgctxt "Translate to (Hindi)"
+msgid "Hindi"
+msgstr ""
+
+msgctxt "Translate to (Arabic)"
+msgid "Arabic"
+msgstr ""
+
+msgctxt "The heading element name displayed in the AI dialog and the button tooltip that opens the dialog."
+msgid "AI Assistant"
+msgstr ""
+
+msgctxt "The toolbar button tooltip for the dropdown with predefined AI commands."
+msgid "AI Commands"
+msgstr ""
+
+msgctxt "The placeholder for the prompt input to obtain new content."
+msgid "Ask AI to edit or generate"
+msgstr ""
+
+msgctxt "The placeholder for the prompt input to improve the generated content."
+msgid "Ask AI to improve generated text"
+msgstr ""
+
+msgctxt "The label for the button that copies the text from the textarea."
+msgid "Copy"
+msgstr ""
+
+msgctxt "The label for the button that submits the entered AI prompt."
+msgid "Submit"
+msgstr "Indien"
+
+msgctxt "The label for the button that inserts the generated AI response below the current selection."
+msgid "Insert below"
+msgstr ""
+
+msgctxt "The label for the button that repeats the request to AI."
+msgid "Try again"
+msgstr ""
+
+msgctxt "The label for the button that stops the generating of the content by AI."
+msgid "Stop"
+msgstr ""
+
+msgctxt "The label that indicates the AI is generating content."
+msgid "AI is writing..."
+msgstr ""
+
+msgctxt "Aria status message indicating that the AI is generating content. Example: 'AI busy writing'."
+msgid "AI is writing"
+msgstr ""
+
+msgctxt "Aria status message indicating the AI generated content. Example: 'Generated content: [text generated by the AI model]'."
+msgid "Generated content: %0"
+msgstr ""
+
+msgctxt "Aria status message indicating that an error has occurred during the generation of AI content. Example: 'Error during AI content generation: [text of an error]'."
+msgid "Error during AI content generation: %0"
+msgstr ""
+
+msgctxt "The label of the button that toggles the prompt history pane in the AI dialog."
+msgid "History"
+msgstr ""
+
+msgctxt "The primary information text displayed when the prompt history is empty."
+msgid "Empty history"
+msgstr ""
+
+msgctxt "The secondary information text displayed when the prompt history is empty."
+msgid "Ask AI and your prompts will be listed here for you to use later."
+msgstr ""
+
+msgctxt "The label of the list group that hosts historical user prompts in the AI dialog."
+msgid "Prompt history"
+msgstr ""
+
+msgctxt "The label for the button that replaces the selected content by the generated AI response."
+msgid "AI_REPLACE_CONTENT"
+msgstr "Vervang"
+
+msgctxt "The label for the button that inserts the generated AI response."
+msgid "AI_INSERT_CONTENT"
+msgstr ""
+
+msgctxt "Error message displayed when preparing request headers fails."
+msgid "AI_ERROR_GET_HEADERS"
+msgstr ""
+
+msgctxt "Error message displayed when preparing request parameters fails."
+msgid "AI_ERROR_GET_PARAMETERS"
+msgstr ""
+
+msgctxt "Error message displayed when the requested AI model is not supported."
+msgid "AI_ERROR_UNSUPPORTED_MODEL"
+msgstr ""
+
+msgctxt "Error message displayed when the content selected for AI processing is too long"
+msgid "AI_ERROR_CONTEXT_LENGTH"
+msgstr ""
+
+msgctxt "Error message displayed when a request is abusive, harmful or hateful and was rejected due to moderation rules."
+msgid "AI_ERROR_MODERATION"
+msgstr ""
+
+msgctxt "Generic error message displayed when the request failed for unspecified reason."
+msgid "AI_ERROR_FAILED"
+msgstr ""