@ckeditor/ckeditor5-ai 41.3.1 → 41.4.0

package/dist/types/aiconfig.d.ts

@@ -0,0 +1,73 @@
+/**
+ * @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/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/types/augmentation.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 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/types/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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
+ */
+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/types/ui/aiassistantcontroller.d.ts

@@ -0,0 +1,113 @@
+/**
+ * @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 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 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/types/ui/dropdown/aicommandslistview.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @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/aicommandslistview
+ */
+import { ListView, type FilteredView } from 'ckeditor5/src/ui.js';
+import type { Locale } from 'ckeditor5/src/utils.js';
+/**
+ * A list view that displays a list of AI commands with filtering capabilities.
+ *
+ * @private
+ */
+export default class AICommandsListView extends ListView implements FilteredView {
+    /**
+     * An array with ids of the enabled AI commands.
+     *
+     * @observable
+     */
+    enabledCommandsIds: Array<string>;
+    /**
+     * Creates an instance of the {@link module:ai/ui/aicommandslistview~AICommandsListView} class.
+     */
+    constructor(locale: Locale);
+    /**
+     * @inheritDoc
+     */
+    filter(regExp: RegExp | null): {
+        resultsCount: number;
+        totalItemsCount: number;
+    };
+}

package/dist/types/ui/dropdown/buttonlabelwithhighlightview.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @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/buttonlabelwithhighlightview
+ */
+import { type ButtonLabel, HighlightedTextView } from 'ckeditor5/src/ui.js';
+/**
+ * A button label view that can highlight a text fragment.
+ */
+export default class ButtonLabelWithHighlightView extends HighlightedTextView implements ButtonLabel {
+    /**
+     * @inheritDoc
+     */
+    style: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    text: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    id: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    constructor();
+}

package/dist/types/ui/dropdown/labelwithhighlightview.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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/labelwithhighlightview
+ */
+import { type LabelView, HighlightedTextView } from 'ckeditor5/src/ui.js';
+/**
+ * A label view that can highlight a text fragment.
+ */
+export default class LabelWithHighlightView extends HighlightedTextView implements LabelView {
+    /**
+     * @inheritDoc
+     */
+    readonly id: string;
+    /**
+     * @inheritDoc
+     */
+    for: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    constructor();
+}

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

@@ -0,0 +1,52 @@
+/**
+ * @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/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/types/ui/form/aiformerrorview.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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/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/types/ui/form/aiformpromptview.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @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/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/types/ui/form/aiformtoolbarview.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @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/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/types/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];
+};