@ckeditor/ckeditor5-ai 0.0.0-internal-20241017.0

package/src/adapters/openaitextadapter.d.ts

@@ -0,0 +1,183 @@
+/**
+ * @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/adapters/openaitextadapter
+ * @publicApi
+ */
+import { type Editor } from 'ckeditor5/src/core.js';
+import { default as AITextAdapter, type AITextAdapterRequestData, type RequestHeaders, type RequestParameters } from './aitextadapter.js';
+/**
+ * Adapter for AI text-related requests that supports OpenAI and Azure OpenAI services.
+ *
+ * See also {@link module:ai/adapters/aitextadapter~AITextAdapter}.
+ */
+export default class OpenAITextAdapter extends AITextAdapter {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "OpenAITextAdapter";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * Performs the request to the OpenAI service, Azure OpenAI service, or to the endpoint provided in the editor configuration.
+     *
+     * If you want to extend this adapter, you can overload this method to do some additional processing or make an external call.
+     */
+    sendRequest({ query, context, onData, actionId }: AITextAdapterRequestData): Promise<void>;
+    /**
+     * Prepares the actual request messages to be sent as a part of the request to the AI service.
+     *
+     * See [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create) to learn more.
+     *
+     * This method returns two messages, one "system message" with general instructions for the model and one "user message"
+     * with the actual instruction to perform.
+     *
+     * The messages are different, based on whether there is any `context` provided. If no `context` is provided, it is assumed that
+     * the user wants to generate new content. If `context` is provided, it is assumed that the user wants to process this `context`
+     * (e.g. translate) or generate something based on `context` (e.g. summary).
+     *
+     * You can overload this method to customize the messages that are sent to the AI service.
+     *
+     * @param query The user's query. The instruction which the model should perform.
+     * @param context The context for the instruction. Usually this will be a part of the editor content. Can be empty.
+     * @param actionId ID of the performed action. See {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId}.
+     */
+    prepareMessages(query: string, context: string, actionId: string): Promise<Array<RequestMessageItem>>;
+}
+/**
+ * The configuration for the OpenAI adapter.
+ *
+ * The properties defined in this config are set in the `config.ai.openAI` namespace.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		ai: {
+ * 		    openAI: {
+ * 		        requestHeaders: {
+ * 		            Authorization: 'Bearer OPENAI_API_KEY'
+ * 		        }
+ * 		    }
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:ai/aiconfig~AIConfig the full AI configuration}.
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface OpenAITextAdapterConfig {
+    /**
+     * The URL to which the AI service request will be sent.
+     *
+     * By default, requests are sent to the OpenAI API service. Change this value to make requests to Azure OpenAI API or use proxy endpoint
+     * in your application instead.
+     *
+     * Defaults to `'https://api.openai.com/v1/chat/completions'`.
+     */
+    apiUrl?: string;
+    /**
+     * Object with headers to set in the request to the AI service API.
+     *
+     * If the provided value is an `object`, it is simply used as provided.
+     *
+     * If you are connecting directly to the OpenAI API, use your OpenAI API key in the following way:
+     *
+     * ```js
+     * {
+     * 	ai: {
+     * 		openAI: {
+     * 			requestHeaders: {
+     * 		 		'Authorization': 'Bearer YOUR_API_KEY'
+     * 			}
+     * 			// ...
+     * 		}
+     * 	// ..
+     * 	}
+     * }
+     * ```
+     *
+     * **Important: use your API key ONLY in a development environment or for testing purposes!**
+     * In the production environment, pass your request through a proxy endpoint.
+     *
+     * If you are using a proxy service to send requests to the OpenAI API, `requestHeaders` can be used to implement authorization for your
+     * requests.
+     *
+     * If the provided value is a function, it should be a function that returns a `Promise` which resolves with the headers object.
+     * This way, you can perform an authorization request to your application and receive the authorization token (and also implement
+     * any custom logic on the back-end side). The headers object is then used to make the actual call to the AI service.
+     *
+     * The function is passed {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} parameter to make it
+     * possible to further customize the headers.
+     *
+     * ```js
+     * {
+     * 	ai: {
+     * 		openAI: {
+     * 			requestHeaders: async () => {
+     * 				const jwt = await fetch( 'https://example.com/jwt-endpoint' );
+     *
+     * 				return {
+     * 					'Authorization': 'Bearer ' + jwt
+     * 				};
+     * 			}
+     * 			// ...
+     * 		}
+     * 	}
+     * }
+     * ```
+     *
+     * If the function fails for any reason, the promise should be rejected. In this case, a feature that made the request should display
+     * an error notification.
+     */
+    requestHeaders?: RequestHeaders;
+    /**
+     * Additional configuration parameters for the AI service request. Use it to customize how the AI service generates responses.
+     * Note that the value you will set here will fully overwrite the default value.
+     *
+     * See [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create) to learn more about available parameters.
+     *
+     * If the provided value is an `object`, it is passed to the request as provided.
+     *
+     * If the provided value is a function, it should be a function that returns a `Promise` which resolves with the request parameters
+     * object. This gives you more flexibility to provide parameters for the AI model.
+     *
+     * The function is passed {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} parameter to make it
+     * possible to further customize the parameters.
+     *
+     * If the function fails for any reason, the promise should be rejected. In this case, the feature that made the request should display
+     * an error notification.
+     *
+     * Defaults to:
+     *
+     * ```json
+     * {
+     * 	model: 'gpt-3.5-turbo',
+     * 	max_tokens: 2000,
+     * 	temperature: 1,
+     * 	top_p: 1,
+     * 	stream: true
+     * }
+     * ```
+     */
+    requestParameters?: RequestParameters;
+}
+/**
+ * Single message item, in the format required for the OpenAI request.
+ *
+ * Example:
+ *
+ * ```json
+ * { role: 'system', content: 'You are a helpful assistant.' }
+ * ```
+ *
+ * See [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create) to learn more.
+ */
+type RequestMessageItem = Record<string, string>;
+export {};

package/src/adapters/openaitextadapter.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+const _0xa3b6f0=_0x5582;function _0x5582(_0x150af7,_0x94df40){const _0x4e6c14=_0x4e6c();return _0x5582=function(_0x55828d,_0x580414){_0x55828d=_0x55828d-0xa4;let _0x1683e4=_0x4e6c14[_0x55828d];return _0x1683e4;},_0x5582(_0x150af7,_0x94df40);}(function(_0x4cd81e,_0x32b6c3){const _0x4f0324=_0x5582,_0x4af99c=_0x4cd81e();while(!![]){try{const _0x306912=-parseInt(_0x4f0324(0xe1))/0x1*(-parseInt(_0x4f0324(0xb0))/0x2)+parseInt(_0x4f0324(0xca))/0x3*(-parseInt(_0x4f0324(0xe6))/0x4)+-parseInt(_0x4f0324(0xa5))/0x5+-parseInt(_0x4f0324(0xaa))/0x6*(parseInt(_0x4f0324(0xae))/0x7)+parseInt(_0x4f0324(0xbf))/0x8*(-parseInt(_0x4f0324(0xdd))/0x9)+-parseInt(_0x4f0324(0xc7))/0xa*(-parseInt(_0x4f0324(0xb6))/0xb)+parseInt(_0x4f0324(0xb5))/0xc*(parseInt(_0x4f0324(0xc2))/0xd);if(_0x306912===_0x32b6c3)break;else _0x4af99c['push'](_0x4af99c['shift']());}catch(_0x2bb65a){_0x4af99c['push'](_0x4af99c['shift']());}}}(_0x4e6c,0x3fab7));import{default as _0x32582c}from'./aitextadapter.js';function _0x4e6c(){const _0x48a001=['Instruction:\x0a','split','stream','prepareMessages','sendRequest','delta','text','1234845WbAibc','reject','includes','length','[DONE]','153462ZnYtse','json','_readStaticResponse','stringify','77UQUjOp','config','2474RfKUEb','user','Moderation','_prepareRequestHeaders','message','24fveJjJ','24871YvnNzn','parse','pluginName','choices','getReader','AI_ERROR_MODERATION','AI_ERROR_CONTEXT_LENGTH','editor','_requestHeaders','3302168zxhamB','_apiUrl','map','5592353kIGYvX','https://api.openai.com/v1/chat/completions','\x0aYou\x20must\x20keep\x20the\x20text\x20formatting.\x0a\x0aContent:\x0a','filter','context_length_exceeded','1270sIehAD','replace','locale','1243362BQLqVU','POST','_isBufferIncomplete','decode','system','resolve','define','Your\x20task\x20is\x20to\x20execute\x20the\x20instruction\x20using\x20the\x20provided\x20HTML\x20content.\x20Follow\x20the\x20instruction\x20closely.\x20Your\x20answer\x20must\x20be\x20a\x20properly\x20formatted\x20HTML\x20code.\x20Do\x20not\x20add\x20any\x20additional\x20remarks\x20or\x20notes.\x20Do\x20not\x20act\x20like\x20a\x20chatbot\x20or\x20a\x20real\x20person.','data:\x20','_requestParameters','signal','abortController','read','Your\x20task\x20is\x20to\x20generate\x20HTML\x20content\x20accordingly\x20to\x20the\x20given\x20instruction.\x20Never\x20include\x20<img>\x20tag\x20in\x20your\x20response\x20even\x20if\x20asked\x20for.\x20Your\x20answer\x20must\x20be\x20a\x20well-structured\x20and\x20properly\x20formatted\x20HTML\x20code.\x20Answer\x20only\x20with\x20the\x20generated\x20HTML\x20content.\x20Do\x20not\x20add\x20any\x20additional\x20remarks\x20or\x20notes.\x20Do\x20not\x20act\x20like\x20a\x20chatbot\x20or\x20a\x20real\x20person.','_prepareRequestParameters','ai.openAI.requestParameters','_cleanUpData','_readStreamableResponse','gpt-3.5-turbo','9TbekFy','body','content','OpenAITextAdapter','379tMqWwQ','ai.openAI.apiUrl','ai.openAI.requestHeaders','join','get','4NfLaXJ'];_0x4e6c=function(){return _0x48a001;};return _0x4e6c();}import{AIRequestError as _0x15c88d}from'./aiadapter.js';import{getTranslation as _0x463493}from'../utils/common-translations.js';export default class H extends _0x32582c{static get[_0xa3b6f0(0xb8)](){const _0x1da55c=_0xa3b6f0;return _0x1da55c(0xe0);}constructor(_0x52effb){const _0x345e73=_0xa3b6f0;super(_0x52effb),_0x52effb[_0x345e73(0xaf)][_0x345e73(0xd0)](_0x345e73(0xe2),_0x345e73(0xc3)),_0x52effb[_0x345e73(0xaf)][_0x345e73(0xe5)](_0x345e73(0xd9))||_0x52effb[_0x345e73(0xaf)][_0x345e73(0xd0)](_0x345e73(0xd9),{'model':_0x345e73(0xdc),'max_tokens':0x7d0,'temperature':0x1,'top_p':0x1,'stream':!0x0}),this[_0x345e73(0xc0)]=_0x52effb[_0x345e73(0xaf)][_0x345e73(0xe5)](_0x345e73(0xe2)),this[_0x345e73(0xbe)]=_0x52effb[_0x345e73(0xaf)][_0x345e73(0xe5)](_0x345e73(0xe3))||{},this[_0x345e73(0xd3)]=_0x52effb[_0x345e73(0xaf)][_0x345e73(0xe5)](_0x345e73(0xd9));}async[_0xa3b6f0(0xeb)]({query:_0x131ac4,context:_0x16f043,onData:_0x4f7c47,actionId:_0xd04736}){const _0x5f01c9=_0xa3b6f0,_0x47179d=this[_0x5f01c9(0xbd)][_0x5f01c9(0xc9)],_0x16870c=await this[_0x5f01c9(0xea)](_0x131ac4,_0x16f043,_0xd04736),_0x20c3e6=await this[_0x5f01c9(0xb3)](this[_0x5f01c9(0xbe)],_0xd04736),_0x23a1be=await this[_0x5f01c9(0xd8)](this[_0x5f01c9(0xd3)],_0xd04736),_0x44adee={'messages':_0x16870c,..._0x23a1be},_0x1d9bfa={'method':_0x5f01c9(0xcb),'headers':_0x20c3e6,'body':JSON[_0x5f01c9(0xad)](_0x44adee),'signal':this[_0x5f01c9(0xd5)][_0x5f01c9(0xd4)]},_0x2786ff=await fetch(this[_0x5f01c9(0xc0)],_0x1d9bfa);if(_0x2786ff['ok'])return _0x23a1be[_0x5f01c9(0xe9)]?await this[_0x5f01c9(0xdb)](_0x2786ff,_0x4f7c47):await this[_0x5f01c9(0xac)](_0x2786ff,_0x4f7c47),Promise[_0x5f01c9(0xcf)]();{const _0x3e7e4b=await _0x2786ff[_0x5f01c9(0xa4)]();return _0x3e7e4b[_0x5f01c9(0xa7)](_0x5f01c9(0xc6))?Promise[_0x5f01c9(0xa6)](new _0x15c88d(_0x463493(_0x47179d,_0x5f01c9(0xbc)))):_0x3e7e4b[_0x5f01c9(0xa7)](_0x5f01c9(0xb2))?Promise[_0x5f01c9(0xa6)](new _0x15c88d(_0x463493(_0x47179d,_0x5f01c9(0xbb)))):Promise[_0x5f01c9(0xa6)](new Error(_0x3e7e4b));}}async[_0xa3b6f0(0xea)](_0x78ad28,_0x3bb3f1,_0xeb74ce){const _0x23f0cf=_0xa3b6f0;let _0x514fae,_0x2bcbc5;return _0x3bb3f1?(_0x514fae=_0x23f0cf(0xd1),_0x2bcbc5=_0x23f0cf(0xe7)+_0x78ad28+_0x23f0cf(0xc4)+_0x3bb3f1):(_0x514fae=_0x23f0cf(0xd7),_0x2bcbc5=_0x78ad28),[{'role':_0x23f0cf(0xce),'content':_0x514fae},{'role':_0x23f0cf(0xb1),'content':_0x2bcbc5}];}async[_0xa3b6f0(0xdb)](_0x393c06,_0x99ded6){const _0x416c2c=_0xa3b6f0,_0x2c74f2=_0x393c06[_0x416c2c(0xde)][_0x416c2c(0xba)](),_0x336600=new TextDecoder();let _0x583b6d='',_0x4c5a26='',_0x2a55f3='',_0x24f958=!0x1;for(;!_0x24f958;){const {done:_0x304c4a,value:_0xcc150}=await _0x2c74f2[_0x416c2c(0xd6)](),_0x2cab2c=_0x583b6d+_0x336600[_0x416c2c(0xcd)](_0xcc150);let _0x48a07f='';_0x24f958=_0x304c4a;try{_0x48a07f=this[_0x416c2c(0xda)](_0x2cab2c),_0x583b6d='';}catch(_0x4faebd){_0x583b6d=_0x2cab2c;continue;}_0x4c5a26+=_0x48a07f,!_0x24f958&&this[_0x416c2c(0xcc)](_0x4c5a26)||_0x4c5a26&&(_0x2a55f3+=_0x4c5a26,_0x4c5a26='',_0x99ded6(_0x2a55f3));}return Promise[_0x416c2c(0xcf)]();}async[_0xa3b6f0(0xac)](_0x37155,_0x3c8616){const _0x599a3c=_0xa3b6f0;return _0x3c8616((await _0x37155[_0x599a3c(0xab)]())[_0x599a3c(0xb9)][0x0][_0x599a3c(0xb4)][_0x599a3c(0xdf)]),Promise[_0x599a3c(0xcf)]();}[_0xa3b6f0(0xcc)](_0x5c93ae){const _0x4c0d83=_0xa3b6f0,_0xaa40af=_0x5c93ae[_0x4c0d83(0xe8)]('<')[_0x4c0d83(0xa8)]!==_0x5c93ae[_0x4c0d83(0xe8)]('>')[_0x4c0d83(0xa8)],_0x532a41=_0x5c93ae[_0x4c0d83(0xa8)]<0x1e;return _0xaa40af&&_0x532a41;}[_0xa3b6f0(0xda)](_0x30ac38){const _0x48fc7e=_0xa3b6f0;return _0x30ac38[_0x48fc7e(0xe8)](/\n(?![^{]*\})/g)[_0x48fc7e(0xc1)](_0x34d74f=>_0x34d74f[_0x48fc7e(0xc8)](_0x48fc7e(0xd2),''))[_0x48fc7e(0xc5)](_0xb3d5de=>_0xb3d5de&&_0xb3d5de[_0x48fc7e(0xa8)]>0x0&&_0x48fc7e(0xa9)!==_0xb3d5de)[_0x48fc7e(0xc1)](_0x2d9a16=>{const _0x2376b4=_0x48fc7e,{choices:_0x34ce81}=JSON[_0x2376b4(0xb7)](_0x2d9a16);if(_0x34ce81[0x0]&&_0x34ce81[0x0][_0x2376b4(0xec)]&&_0x34ce81[0x0][_0x2376b4(0xec)][_0x2376b4(0xdf)])return _0x34ce81[0x0][_0x2376b4(0xec)][_0x2376b4(0xdf)];})[_0x48fc7e(0xc5)](_0xe7f028=>_0xe7f028)[_0x48fc7e(0xe4)]('');}}

package/src/aiassistant.d.ts

@@ -0,0 +1,389 @@
+/**
+ * @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/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/src/aiassistant.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+const _0x121b5e=_0x4130;(function(_0x59f3f2,_0x14a3a8){const _0x4845e8=_0x4130,_0x2bd1de=_0x59f3f2();while(!![]){try{const _0xaed4c2=parseInt(_0x4845e8(0xc1))/0x1*(-parseInt(_0x4845e8(0x92))/0x2)+parseInt(_0x4845e8(0x87))/0x3*(parseInt(_0x4845e8(0xae))/0x4)+parseInt(_0x4845e8(0xa5))/0x5+parseInt(_0x4845e8(0x8a))/0x6+parseInt(_0x4845e8(0x7d))/0x7*(-parseInt(_0x4845e8(0xb3))/0x8)+parseInt(_0x4845e8(0xc4))/0x9*(parseInt(_0x4845e8(0xad))/0xa)+parseInt(_0x4845e8(0xb8))/0xb*(-parseInt(_0x4845e8(0x8e))/0xc);if(_0xaed4c2===_0x14a3a8)break;else _0x2bd1de['push'](_0x2bd1de['shift']());}catch(_0x243118){_0x2bd1de['push'](_0x2bd1de['shift']());}}}(_0x3db3,0x8e895));import{Plugin as _0x59f292}from'ckeditor5/src/core.js';import _0x576020 from'./aiassistantui.js';import _0x130b29 from'./aiassistantediting.js';import{getTranslation as _0x1145cc}from'./utils/common-translations.js';function _0x4130(_0x1e1a60,_0x4bdfcc){const _0x3db39f=_0x3db3();return _0x4130=function(_0x4130d5,_0x37ce6c){_0x4130d5=_0x4130d5-0x6a;let _0x20155b=_0x3db39f[_0x4130d5];return _0x20155b;},_0x4130(_0x1e1a60,_0x4bdfcc);}import{normalizeCommandsConfig as _0x3c19a6}from'./utils/normalizecommandsconfig.js';export default class r extends _0x59f292{static get[_0x121b5e(0xd2)](){return[_0x576020,_0x130b29];}static get[_0x121b5e(0x6c)](){const _0x4cf3b5=_0x121b5e;return _0x4cf3b5(0xca);}static get[_0x121b5e(0xbb)](){return!0x0;}static get[_0x121b5e(0x82)](){return!0x0;}constructor(_0x876dfc){const _0x390d63=_0x121b5e;super(_0x876dfc);const _0x3fe712=_0x876dfc[_0x390d63(0x6b)],_0x5a7383=_0x876dfc[_0x390d63(0xd6)];_0x3fe712[_0x390d63(0xab)](_0x390d63(0x73),getDefaultCommands(_0x5a7383)),_0x3fe712[_0x390d63(0xab)](_0x390d63(0xc6),[]),_0x3fe712[_0x390d63(0xab)](_0x390d63(0x9c),[]);const _0x49a7b2=_0x3c19a6(_0x3fe712[_0x390d63(0xaf)](_0x390d63(0x73)),_0x5a7383),_0xb2771b=_0x3fe712[_0x390d63(0xaf)](_0x390d63(0xc6)),_0x3c741d=_0x3fe712[_0x390d63(0xaf)](_0x390d63(0x9c));_0xb2771b[_0x390d63(0xbc)](_0x46c5fd=>{const _0x43dd19=_0x390d63,_0x564492=_0x49a7b2[_0x43dd19(0xd1)](_0xdcb1d9=>_0xdcb1d9[_0x43dd19(0x6f)]===_0x46c5fd[_0x43dd19(0x6f)]);_0x564492?_0x564492[_0x43dd19(0xd9)]=_0x564492[_0x43dd19(0xd9)][_0x43dd19(0xb7)](_0x46c5fd[_0x43dd19(0xd9)]):_0x49a7b2[_0x43dd19(0xb9)](_0x46c5fd);}),_0x49a7b2[_0x390d63(0xbc)](_0x4444cc=>{const _0x207a36=_0x390d63;_0x4444cc[_0x207a36(0xd9)]=_0x4444cc[_0x207a36(0xd9)][_0x207a36(0xa8)](_0xd5c3f5=>!_0x3c741d[_0x207a36(0x86)](_0xd5c3f5['id']));}),_0x3fe712[_0x390d63(0xb6)](_0x390d63(0x73),_0x49a7b2);}}export function getDefaultCommands(_0x2f1229){const _0x22b7b1=_0x121b5e;return[{'groupId':_0x22b7b1(0x72),'groupLabel':_0x1145cc(_0x2f1229,_0x22b7b1(0x90)),'commands':[{'id':_0x22b7b1(0x97),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x93)),'prompt':_0x22b7b1(0xcb)},{'id':_0x22b7b1(0x83),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xcf)),'prompt':_0x22b7b1(0xba)},{'id':_0x22b7b1(0xc3),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xa2)),'prompt':_0x22b7b1(0xb2)},{'id':_0x22b7b1(0x9f),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x6e)),'prompt':_0x22b7b1(0x91)}]},{'groupId':_0x22b7b1(0x80),'groupLabel':_0x1145cc(_0x2f1229,_0x22b7b1(0x9d)),'commands':[{'id':_0x22b7b1(0xb1),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x98)),'prompt':_0x22b7b1(0x76)},{'id':_0x22b7b1(0xd8),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xb0)),'prompt':_0x22b7b1(0x71)}]},{'groupId':_0x22b7b1(0xaa),'groupLabel':_0x1145cc(_0x2f1229,_0x22b7b1(0x94)),'commands':[{'id':_0x22b7b1(0xd0),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xa0)),'prompt':_0x22b7b1(0xc9)},{'id':_0x22b7b1(0x79),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x84)),'prompt':_0x22b7b1(0x99)},{'id':_0x22b7b1(0x70),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x95)),'prompt':_0x22b7b1(0xc8)},{'id':_0x22b7b1(0x75),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xc7)),'prompt':_0x22b7b1(0x7e)},{'id':_0x22b7b1(0x8b),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x7f)),'prompt':_0x22b7b1(0xa6)}]},{'groupId':_0x22b7b1(0xce),'groupLabel':_0x1145cc(_0x2f1229,_0x22b7b1(0x7b)),'commands':[{'id':_0x22b7b1(0xd5),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x96)),'prompt':_0x22b7b1(0x81)},{'id':_0x22b7b1(0xa4),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x85)),'prompt':_0x22b7b1(0xa9)},{'id':_0x22b7b1(0x8c),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xa7)),'prompt':_0x22b7b1(0x8f)},{'id':_0x22b7b1(0x6a),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xbe)),'prompt':_0x22b7b1(0x74)}]},{'groupId':_0x22b7b1(0xd7),'groupLabel':_0x1145cc(_0x2f1229,_0x22b7b1(0xa1)),'commands':[{'id':_0x22b7b1(0xd3),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x9b)),'prompt':_0x22b7b1(0x9a)},{'id':_0x22b7b1(0xcc),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xcd)),'prompt':_0x22b7b1(0xc2)},{'id':_0x22b7b1(0xb4),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xb5)),'prompt':_0x22b7b1(0xac)},{'id':_0x22b7b1(0x78),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x9e)),'prompt':_0x22b7b1(0x7c)},{'id':_0x22b7b1(0x7a),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x8d)),'prompt':_0x22b7b1(0xbd)},{'id':_0x22b7b1(0x88),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xd4)),'prompt':_0x22b7b1(0xc0)},{'id':_0x22b7b1(0xbf),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0xc5)),'prompt':_0x22b7b1(0xa3)},{'id':_0x22b7b1(0x77),'label':_0x1145cc(_0x2f1229,_0x22b7b1(0x89)),'prompt':_0x22b7b1(0x6d)}]}];}function _0x3db3(){const _0xe6d204=['Portuguese','set','concat','22213609oCkyep','push','Remove\x20any\x20repetitive,\x20redundant,\x20or\x20non-essential\x20writing\x20in\x20this\x20content\x20without\x20changing\x20the\x20meaning\x20or\x20losing\x20any\x20key\x20information.','isOfficialPlugin','forEach','Translate\x20the\x20content\x20to\x20French\x20language.','Poetic','translateHindi','Translate\x20the\x20content\x20to\x20Simplified\x20Chinese\x20language.','218ucOJmG','Translate\x20the\x20content\x20to\x20Spanish\x20language.','makeLonger','513APlsNM','Hindi','ai.aiAssistant.extraCommandGroups','Confident','Improve\x20using\x20direct\x20language,\x20using\x20only\x20the\x20essential\x20information.','Improve\x20using\x20polished,\x20formal,\x20and\x20respectful\x20language\x20to\x20convey\x20professional\x20expertise\x20and\x20competence.','AIAssistant','Fix\x20spelling\x20mistakes,\x20use\x20proper\x20grammar\x20and\x20apply\x20good\x20writing\x20practices.\x20Do\x20not\x20lose\x20the\x20original\x20meaning.','translateSpanish','Spanish','changeStyle','Make\x20shorter','professional','find','requires','translateEnglish','Simplified\x20Chinese','business','locale','translate','continue','commands','poetic','config','pluginName','Translate\x20the\x20content\x20to\x20Arabic\x20language.','Simplify\x20language','groupId','direct','Start\x20with\x20the\x20provided\x20content\x20and\x20write\x20at\x20the\x20end\x20of\x20it\x20continuing\x20this\x20topic.\x20Keep\x20the\x20added\x20part\x20short.','editOrReview','ai.aiAssistant.commands','Rewrite\x20this\x20content\x20as\x20a\x20poem\x20using\x20poetic\x20techniques\x20without\x20losing\x20the\x20original\x20meaning.','confident','Summarize\x20this\x20content\x20into\x20one\x20paragraph\x20of\x20text.\x20Include\x20only\x20the\x20key\x20ideas\x20and\x20conclusions.\x20Keep\x20it\x20short.\x20Do\x20not\x20keep\x20original\x20text\x20formatting.','translateArabic','translateGerman','casual','translateFrench','Change\x20style','Translate\x20the\x20content\x20to\x20German\x20language.','7FpbaLD','Improve\x20using\x20compelling,\x20optimistic\x20language\x20to\x20convey\x20confidence\x20in\x20the\x20writing.','Friendly','generate','Rewrite\x20this\x20content\x20as\x20a\x20business\x20professional\x20with\x20formal\x20language.','isPremiumPlugin','makeShorter','Casual','Legal','includes','10581GdxWJk','translateChinese','Arabic','6621480ciTrvV','friendly','journalism','French','12VtmVKd','Rewrite\x20this\x20content\x20as\x20a\x20journalist\x20using\x20engaging\x20language\x20to\x20convey\x20the\x20importance\x20of\x20the\x20information.','Edit\x20or\x20review','Simplify\x20the\x20writing\x20style\x20of\x20this\x20content\x20and\x20reduce\x20the\x20complexity,\x20so\x20that\x20the\x20content\x20is\x20easy\x20to\x20understand.','1492LIrtOV','Improve\x20writing','Change\x20tone','Direct','Business','improveWriting','Summarize','Improve\x20using\x20casual,\x20informal\x20language\x20to\x20convey\x20a\x20casual\x20conversation\x20with\x20a\x20real\x20person.','Translate\x20the\x20content\x20to\x20English\x20language.','English','ai.aiAssistant.removeCommands','Generate\x20from\x20selection','German','simplifyLanguage','Professional','Translate','Make\x20longer','Translate\x20the\x20content\x20to\x20Hindi\x20language.','legal','2801995xSgiCm','Improve\x20using\x20friendly,\x20comforting\x20language,\x20to\x20convey\x20understanding\x20and\x20empathy.','Journalism','filter','Rewrite\x20this\x20content\x20as\x20a\x20legal\x20professional\x20using\x20valid\x20legal\x20terminology.','changeTone','define','Translate\x20the\x20content\x20to\x20Portuguese\x20language.','174170JyJeCg','1164OPvnFU','get','Continue','summarize','Improve\x20this\x20content\x20by\x20using\x20descriptive\x20language\x20and\x20inserting\x20more\x20information\x20and\x20more\x20detailed\x20explanations.','7337832MqnXYm','translatePortuguese'];_0x3db3=function(){return _0xe6d204;};return _0x3db3();}