@ckeditor/ckeditor5-ai 48.2.0-alpha.7 → 48.3.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (352) hide show
  1. package/dist/aiactions/aiactions.d.ts +74 -73
  2. package/dist/aiactions/model/aiactionsinteraction.d.ts +53 -53
  3. package/dist/aiactions/model/aiactionsreply.d.ts +18 -18
  4. package/dist/aiassistant/adapters/aiadapter.d.ts +48 -48
  5. package/dist/aiassistant/adapters/aitextadapter.d.ts +133 -133
  6. package/dist/aiassistant/adapters/awstextadapter.d.ts +42 -42
  7. package/dist/aiassistant/adapters/openaitextadapter.d.ts +184 -184
  8. package/dist/aiassistant/aiassistant.d.ts +436 -436
  9. package/dist/aiassistant/aiassistantediting.d.ts +51 -51
  10. package/dist/aiassistant/aiassistantui.d.ts +53 -53
  11. package/dist/aiassistant/legacyerrors.d.ts +0 -4
  12. package/dist/aiassistant/ui/aiassistantcontroller.d.ts +106 -105
  13. package/dist/aiassistant/ui/form/aiformcontentarea.d.ts +43 -43
  14. package/dist/aiassistant/ui/form/aiformerrorview.d.ts +19 -19
  15. package/dist/aiassistant/ui/form/aiformpromptview.d.ts +38 -38
  16. package/dist/aiassistant/ui/form/aiformtoolbarview.d.ts +50 -50
  17. package/dist/aiassistant/ui/form/aiformview.d.ts +121 -121
  18. package/dist/aiassistant/ui/form/aihistorylistitemview.d.ts +13 -13
  19. package/dist/aiassistant/ui/form/aihistorylistview.d.ts +27 -27
  20. package/dist/aiassistant/ui/form/prompthistory.d.ts +15 -15
  21. package/dist/aiassistant/ui/showaiassistantcommand.d.ts +35 -35
  22. package/dist/aiassistant/utils/common-translations.d.ts +6 -6
  23. package/dist/aiassistant/utils/normalizecommandsconfig.d.ts +9 -9
  24. package/dist/aiballoon/aiballoon.d.ts +86 -86
  25. package/dist/aiballoon/ui/aiballoonview.d.ts +26 -26
  26. package/dist/aichat/aichat.d.ts +88 -87
  27. package/dist/aichat/aichatballoon.d.ts +83 -83
  28. package/dist/aichat/aichatcontroller.d.ts +265 -264
  29. package/dist/aichat/aichatui.d.ts +324 -336
  30. package/dist/aichat/model/aichatcontext.d.ts +623 -618
  31. package/dist/aichat/model/aichatconversation.d.ts +257 -268
  32. package/dist/aichat/model/aichatinteraction.d.ts +40 -40
  33. package/dist/aichat/ui/aichatballoonview.d.ts +103 -103
  34. package/dist/aichat/ui/aichatcontrolsview.d.ts +130 -130
  35. package/dist/aichat/ui/aichatfeedview.d.ts +136 -136
  36. package/dist/aichat/ui/aichatview.d.ts +41 -41
  37. package/dist/aichat/ui/controls/aichatchipsoverflowmanager.d.ts +63 -63
  38. package/dist/aichat/ui/controls/aichatcontextitembuttonview.d.ts +41 -41
  39. package/dist/aichat/ui/controls/aichatcontextpanelurlinputview.d.ts +79 -79
  40. package/dist/aichat/ui/controls/aichatcontextpanelview.d.ts +103 -103
  41. package/dist/aichat/ui/controls/aichatcontrolsloaderview.d.ts +8 -8
  42. package/dist/aichat/ui/controls/aichatdropzoneview.d.ts +18 -18
  43. package/dist/aichat/ui/controls/aichatpromptcapabilitiesview.d.ts +81 -81
  44. package/dist/aichat/ui/controls/aichatpromptinputview.d.ts +44 -44
  45. package/dist/aichat/ui/controls/aichatpromptsuggestionslistview.d.ts +13 -13
  46. package/dist/aichat/ui/controls/resources/aichatcontextresourceslistview.d.ts +44 -44
  47. package/dist/aichat/ui/controls/resources/aichatcontextresourcesview.d.ts +52 -52
  48. package/dist/aichat/ui/controls/resources/aichatresourcelistitemview.d.ts +56 -56
  49. package/dist/aichat/ui/controls/resources/aichatresourcesballoonview.d.ts +104 -104
  50. package/dist/aichat/ui/controls/resources/aichatresourcessearchinputview.d.ts +53 -53
  51. package/dist/aichat/ui/feed/aichatfeedcontextchipsview.d.ts +22 -22
  52. package/dist/aichat/ui/feed/aichatfeedcustomelementview.d.ts +33 -33
  53. package/dist/aichat/ui/feed/aichatfeederroritemview.d.ts +32 -32
  54. package/dist/aichat/ui/feed/aichatfeedinteractionheaderview.d.ts +24 -24
  55. package/dist/aichat/ui/feed/aichatfeeditemview.d.ts +39 -39
  56. package/dist/aichat/ui/feed/aichatfeedreplyitemview.d.ts +40 -40
  57. package/dist/aichat/ui/feed/aichatfeedsuggestionitemactionsview.d.ts +61 -61
  58. package/dist/aichat/ui/feed/aichatfeedsuggestionitemview.d.ts +82 -82
  59. package/dist/aichat/ui/feed/aichatfeedusermessageitem.d.ts +33 -33
  60. package/dist/aichat/utils/eventnames.d.ts +8 -4
  61. package/dist/aichat/utils/parsesingleurl.d.ts +0 -4
  62. package/dist/aichat/utils/promisequeue.d.ts +26 -25
  63. package/dist/aichat/utils/readdatatransferfiles.d.ts +9 -9
  64. package/dist/aichat/utils/resolvepaste.d.ts +58 -58
  65. package/dist/aichathistory/aichathistory.d.ts +26 -26
  66. package/dist/aichathistory/aichathistorycontroller.d.ts +36 -35
  67. package/dist/aichathistory/aichathistoryui.d.ts +81 -89
  68. package/dist/aichathistory/model/aichathistoryconversations.d.ts +95 -102
  69. package/dist/aichathistory/model/aichathistoryitem.d.ts +52 -53
  70. package/dist/aichathistory/ui/aichathistorylistitemview.d.ts +41 -40
  71. package/dist/aichathistory/ui/aichathistorylistview.d.ts +28 -28
  72. package/dist/aichathistory/ui/aichathistorysectionlistview.d.ts +16 -16
  73. package/dist/aichathistory/ui/aichathistoryview.d.ts +33 -33
  74. package/dist/aichatshortcuts/aichatshortcuts.d.ts +295 -295
  75. package/dist/aichatshortcuts/ui/aichatshortcutsview.d.ts +24 -24
  76. package/dist/aichatshortcuts/ui/aichatshortcutview.d.ts +18 -18
  77. package/dist/aiconfig.d.ts +227 -227
  78. package/dist/aicore/aiconnector.d.ts +359 -354
  79. package/dist/aicore/aiediting.d.ts +97 -97
  80. package/dist/aicore/aierrorreporter.d.ts +73 -0
  81. package/dist/aicore/aigateway.d.ts +94 -54
  82. package/dist/aicore/errors/aicoreerror.d.ts +67 -0
  83. package/dist/aicore/errors/geterrorcode.d.ts +17 -0
  84. package/dist/aicore/errors/isaborterror.d.ts +12 -0
  85. package/dist/aicore/errors/normalizeerror.d.ts +18 -0
  86. package/dist/aicore/model/aicapabilities.d.ts +53 -52
  87. package/dist/aicore/model/aicontext.d.ts +61 -61
  88. package/dist/aicore/model/aiinteraction.d.ts +162 -168
  89. package/dist/aicore/model/aimodels.d.ts +73 -76
  90. package/dist/aicore/model/aireply.d.ts +118 -124
  91. package/dist/aicore/model/airunresult.d.ts +86 -86
  92. package/dist/aicore/pipeline/airesponseapplier.d.ts +284 -284
  93. package/dist/aicore/pipeline/airesponseparser.d.ts +24 -23
  94. package/dist/aicore/ui/aidisclaimerview.d.ts +13 -13
  95. package/dist/aicore/ui/aiheaderview.d.ts +28 -28
  96. package/dist/aicore/ui/aiskeleton.d.ts +31 -31
  97. package/dist/aicore/ui/aispinner.d.ts +11 -11
  98. package/dist/aicore/ui/suggestioncontainer/aiminitoolbarview.d.ts +56 -56
  99. package/dist/aicore/ui/suggestioncontainer/aisuggestionbodyview.d.ts +80 -80
  100. package/dist/aicore/ui/suggestioncontainer/aisuggestioncontainerview.d.ts +46 -46
  101. package/dist/aicore/ui/suggestioncontainer/aisuggestioncontentpartheaderview.d.ts +41 -41
  102. package/dist/aicore/ui/suggestioncontainer/aisuggestioncontentpartstateview.d.ts +25 -28
  103. package/dist/aicore/ui/suggestioncontainer/aisuggestioncontentparttoolbarview.d.ts +25 -25
  104. package/dist/aicore/ui/suggestioncontainer/aisuggestioncontentpartview.d.ts +62 -62
  105. package/dist/aicore/ui/suggestioncontainer/aisuggestionheaderview.d.ts +32 -32
  106. package/dist/aicore/ui/suggestioncontainer/aisuggestionloaderview.d.ts +11 -11
  107. package/dist/aicore/ui/suggestioncontainer/aisuggestionstreamablecontentview.d.ts +31 -27
  108. package/dist/aicore/ui/suggestioncontainer/aiwebsourcesview.d.ts +24 -24
  109. package/dist/aicore/utils/abortabletimeout.d.ts +11 -11
  110. package/dist/aicore/utils/builddocumentsuggestionsmap.d.ts +30 -0
  111. package/dist/aicore/utils/buttonclasses.d.ts +8 -8
  112. package/dist/aicore/utils/cleanupstreamingartifacts.d.ts +12 -0
  113. package/dist/aicore/utils/common-translations.d.ts +6 -6
  114. package/dist/aicore/utils/createandattachaibodycollection.d.ts +19 -0
  115. package/dist/aicore/utils/createresizebutton.d.ts +9 -9
  116. package/dist/aicore/utils/createstartconversationbutton.d.ts +8 -8
  117. package/dist/aicore/utils/documentposition.d.ts +37 -37
  118. package/dist/aicore/utils/documentrange.d.ts +41 -41
  119. package/dist/aicore/utils/eventnames.d.ts +5 -5
  120. package/dist/aicore/utils/geteditorsfromcontext.d.ts +13 -13
  121. package/dist/aicore/utils/getoperationsfordocumentsuggestions.d.ts +22 -0
  122. package/dist/aicore/utils/getsuggestionpartsfromreply.d.ts +18 -18
  123. package/dist/aicore/utils/htmlparser.d.ts +17 -17
  124. package/dist/aicore/utils/htmlstreamer.d.ts +79 -79
  125. package/dist/aicore/utils/markoperationsasai.d.ts +23 -0
  126. package/dist/aicore/utils/scrollmanager.d.ts +24 -23
  127. package/dist/aicore/utils/showaitab.d.ts +1 -0
  128. package/dist/aidocumentprocessing/aidocumentprocessinggateway.d.ts +87 -0
  129. package/dist/aidocumentprocessing/model/aidocumentprocessingrunresult.d.ts +19 -0
  130. package/dist/aieditorintegration/aieditorintegration.d.ts +32 -32
  131. package/dist/aieditorintegration/aitogglebutton/aitogglebuttonui.d.ts +34 -34
  132. package/dist/aieditorintegration/aitogglebutton/toggleaicommand.d.ts +12 -12
  133. package/dist/aiquickactions/aiquickactions.d.ts +250 -250
  134. package/dist/aiquickactions/aiquickactionscommand.d.ts +10 -10
  135. package/dist/aiquickactions/aiquickactionsediting.d.ts +22 -22
  136. package/dist/aiquickactions/aiquickactionsui.d.ts +125 -124
  137. package/dist/aiquickactions/ui/aiquickactionsbuttoncreator.d.ts +57 -57
  138. package/dist/aiquickactions/ui/aiquickactionsdropdowncontentview.d.ts +45 -45
  139. package/dist/aiquickactions/ui/aiquickactionsdropdowncreator.d.ts +59 -59
  140. package/dist/aiquickactions/ui/aiquickactionsfilteredlistview.d.ts +0 -4
  141. package/dist/aiquickactions/ui/balloon/aiactionsballoondisclaimerview.d.ts +12 -12
  142. package/dist/aiquickactions/ui/balloon/aiactionsballoontoolbarview.d.ts +32 -32
  143. package/dist/aiquickactions/ui/balloon/aiactionsballoonview.d.ts +129 -125
  144. package/dist/aiquickactions/ui/dropdownmenubuttonwithhighlightview.d.ts +24 -24
  145. package/dist/aireviewcore/aireviewcorecheckregistry.d.ts +34 -29
  146. package/dist/aireviewcore/aireviewcorecontroller.d.ts +48 -48
  147. package/dist/aireviewcore/aireviewcoreediting.d.ts +216 -224
  148. package/dist/aireviewcore/aireviewcoreui.d.ts +84 -84
  149. package/dist/aireviewcore/model/aireviewcheck.d.ts +49 -49
  150. package/dist/aireviewcore/model/aireviewchecklist.d.ts +29 -28
  151. package/dist/aireviewcore/model/aireviewcheckresult.d.ts +36 -35
  152. package/dist/aireviewcore/model/aireviewcheckresultchange.d.ts +51 -50
  153. package/dist/aireviewcore/model/aireviewcheckrun.d.ts +140 -151
  154. package/dist/aireviewcore/model/aireviewsystemcheckrun.d.ts +16 -16
  155. package/dist/aireviewcore/types.d.ts +24 -24
  156. package/dist/aireviewcore/ui/aireviewcoreballoonsuggestionview.d.ts +34 -34
  157. package/dist/aireviewcore/ui/aireviewcorechecklistitemresultview.d.ts +57 -65
  158. package/dist/aireviewcore/ui/aireviewcorecustomcheckview.d.ts +56 -56
  159. package/dist/aireviewcore/ui/aireviewcorefinishreviewbuttonview.d.ts +9 -9
  160. package/dist/aireviewcore/ui/aireviewcoregeneralerrorview.d.ts +20 -20
  161. package/dist/aireviewcore/ui/aireviewcorepromptinputview.d.ts +25 -25
  162. package/dist/aireviewcore/ui/aireviewcorereviewchecklistview.d.ts +22 -22
  163. package/dist/aireviewcore/ui/aireviewcorereviewcommandlistitemview.d.ts +37 -39
  164. package/dist/aireviewcore/ui/aireviewcorereviewcompletedview.d.ts +14 -14
  165. package/dist/aireviewcore/ui/aireviewcoreuicheckresultsview.d.ts +85 -87
  166. package/dist/aireviewcore/ui/aireviewcoreview.d.ts +50 -50
  167. package/dist/aireviewcore/ui/form/aireviewcoreformdropdown.d.ts +16 -16
  168. package/dist/aireviewcore/ui/form/aireviewcoreformmanager.d.ts +12 -12
  169. package/dist/aireviewmode/aireviewcheckdefinitions.d.ts +12 -12
  170. package/dist/aireviewmode/aireviewgateway.d.ts +141 -149
  171. package/dist/aireviewmode/aireviewmode.d.ts +184 -184
  172. package/dist/aireviewmode/aireviewmodecheckregistry.d.ts +34 -34
  173. package/dist/aireviewmode/aireviewmodecontroller.d.ts +23 -22
  174. package/dist/aireviewmode/aireviewmodeui.d.ts +17 -17
  175. package/dist/aireviewmode/model/aireviewcheckcustom.d.ts +16 -16
  176. package/dist/aireviewmode/model/aireviewcheckextra.d.ts +30 -30
  177. package/dist/aireviewmode/model/aireviewcustomcheckrun.d.ts +17 -17
  178. package/dist/aireviewmode/model/aireviewextracheckrun.d.ts +15 -15
  179. package/dist/aireviewmode/model/aireviewmodechecklist.d.ts +22 -22
  180. package/dist/aireviewmode/model/aireviewrunresult.d.ts +15 -15
  181. package/dist/aitabs/aitabs.d.ts +84 -84
  182. package/dist/aitabs/aitabsmainview.d.ts +46 -46
  183. package/dist/aitabs/tabs/aitabsview.d.ts +194 -188
  184. package/dist/aitabs/tabs/tabbuttonview.d.ts +39 -39
  185. package/dist/aitabs/tabs/tabpanelview.d.ts +39 -39
  186. package/dist/aitranslate/aitranslate.d.ts +162 -129
  187. package/dist/aitranslate/aitranslatecheckregistry.d.ts +22 -22
  188. package/dist/aitranslate/aitranslatecontroller.d.ts +17 -15
  189. package/dist/aitranslate/aitranslategateway.d.ts +77 -0
  190. package/dist/aitranslate/aitranslateui.d.ts +18 -18
  191. package/dist/aitranslate/model/aitranslatecheck.d.ts +12 -12
  192. package/dist/aitranslate/model/aitranslatechecklist.d.ts +11 -11
  193. package/dist/aitranslate/model/aitranslatecheckrun.d.ts +23 -23
  194. package/dist/aitranslate/model/aitranslaterunresult.d.ts +20 -0
  195. package/dist/aitranslate/ui/aitranslatechecklistview.d.ts +7 -8
  196. package/dist/aitranslate/ui/aitranslatecheckresultsview.d.ts +11 -11
  197. package/dist/augmentation.d.ts +77 -73
  198. package/dist/errors.d.ts +0 -4
  199. package/dist/errorsmap.d.ts +5 -5
  200. package/dist/index-content.css +1 -0
  201. package/dist/index-editor.css +11 -8
  202. package/dist/index.css +11 -8
  203. package/dist/index.d.ts +70 -63
  204. package/dist/index.js +19 -6
  205. package/dist/translations/af.js +1 -1
  206. package/dist/translations/af.umd.js +1 -1
  207. package/dist/translations/ar.js +1 -1
  208. package/dist/translations/ar.umd.js +1 -1
  209. package/dist/translations/ast.js +1 -1
  210. package/dist/translations/ast.umd.js +1 -1
  211. package/dist/translations/az.js +1 -1
  212. package/dist/translations/az.umd.js +1 -1
  213. package/dist/translations/be.js +1 -1
  214. package/dist/translations/be.umd.js +1 -1
  215. package/dist/translations/bg.js +1 -1
  216. package/dist/translations/bg.umd.js +1 -1
  217. package/dist/translations/bn.js +1 -1
  218. package/dist/translations/bn.umd.js +1 -1
  219. package/dist/translations/bs.js +1 -1
  220. package/dist/translations/bs.umd.js +1 -1
  221. package/dist/translations/ca.js +1 -1
  222. package/dist/translations/ca.umd.js +1 -1
  223. package/dist/translations/cs.js +1 -1
  224. package/dist/translations/cs.umd.js +1 -1
  225. package/dist/translations/da.js +1 -1
  226. package/dist/translations/da.umd.js +1 -1
  227. package/dist/translations/de-ch.js +1 -1
  228. package/dist/translations/de-ch.umd.js +1 -1
  229. package/dist/translations/de.js +1 -1
  230. package/dist/translations/de.umd.js +1 -1
  231. package/dist/translations/el.js +1 -1
  232. package/dist/translations/el.umd.js +1 -1
  233. package/dist/translations/en-au.js +1 -1
  234. package/dist/translations/en-au.umd.js +1 -1
  235. package/dist/translations/en-gb.js +1 -1
  236. package/dist/translations/en-gb.umd.js +1 -1
  237. package/dist/translations/en.js +1 -1
  238. package/dist/translations/en.umd.js +1 -1
  239. package/dist/translations/eo.js +1 -1
  240. package/dist/translations/eo.umd.js +1 -1
  241. package/dist/translations/es-co.js +1 -1
  242. package/dist/translations/es-co.umd.js +1 -1
  243. package/dist/translations/es.js +1 -1
  244. package/dist/translations/es.umd.js +1 -1
  245. package/dist/translations/et.js +1 -1
  246. package/dist/translations/et.umd.js +1 -1
  247. package/dist/translations/eu.js +1 -1
  248. package/dist/translations/eu.umd.js +1 -1
  249. package/dist/translations/fa.js +1 -1
  250. package/dist/translations/fa.umd.js +1 -1
  251. package/dist/translations/fi.js +1 -1
  252. package/dist/translations/fi.umd.js +1 -1
  253. package/dist/translations/fr.js +1 -1
  254. package/dist/translations/fr.umd.js +1 -1
  255. package/dist/translations/gl.js +1 -1
  256. package/dist/translations/gl.umd.js +1 -1
  257. package/dist/translations/gu.js +1 -1
  258. package/dist/translations/gu.umd.js +1 -1
  259. package/dist/translations/he.js +1 -1
  260. package/dist/translations/he.umd.js +1 -1
  261. package/dist/translations/hi.js +1 -1
  262. package/dist/translations/hi.umd.js +1 -1
  263. package/dist/translations/hr.js +1 -1
  264. package/dist/translations/hr.umd.js +1 -1
  265. package/dist/translations/hu.js +1 -1
  266. package/dist/translations/hu.umd.js +1 -1
  267. package/dist/translations/hy.js +1 -1
  268. package/dist/translations/hy.umd.js +1 -1
  269. package/dist/translations/id.js +1 -1
  270. package/dist/translations/id.umd.js +1 -1
  271. package/dist/translations/it.js +1 -1
  272. package/dist/translations/it.umd.js +1 -1
  273. package/dist/translations/ja.js +1 -1
  274. package/dist/translations/ja.umd.js +1 -1
  275. package/dist/translations/jv.js +1 -1
  276. package/dist/translations/jv.umd.js +1 -1
  277. package/dist/translations/kk.js +1 -1
  278. package/dist/translations/kk.umd.js +1 -1
  279. package/dist/translations/km.js +1 -1
  280. package/dist/translations/km.umd.js +1 -1
  281. package/dist/translations/kn.js +1 -1
  282. package/dist/translations/kn.umd.js +1 -1
  283. package/dist/translations/ko.js +1 -1
  284. package/dist/translations/ko.umd.js +1 -1
  285. package/dist/translations/ku.js +1 -1
  286. package/dist/translations/ku.umd.js +1 -1
  287. package/dist/translations/lt.js +1 -1
  288. package/dist/translations/lt.umd.js +1 -1
  289. package/dist/translations/lv.js +1 -1
  290. package/dist/translations/lv.umd.js +1 -1
  291. package/dist/translations/ms.js +1 -1
  292. package/dist/translations/ms.umd.js +1 -1
  293. package/dist/translations/nb.js +1 -1
  294. package/dist/translations/nb.umd.js +1 -1
  295. package/dist/translations/ne.js +1 -1
  296. package/dist/translations/ne.umd.js +1 -1
  297. package/dist/translations/nl.js +1 -1
  298. package/dist/translations/nl.umd.js +1 -1
  299. package/dist/translations/no.js +1 -1
  300. package/dist/translations/no.umd.js +1 -1
  301. package/dist/translations/oc.js +1 -1
  302. package/dist/translations/oc.umd.js +1 -1
  303. package/dist/translations/pl.js +1 -1
  304. package/dist/translations/pl.umd.js +1 -1
  305. package/dist/translations/pt-br.js +1 -1
  306. package/dist/translations/pt-br.umd.js +1 -1
  307. package/dist/translations/pt.js +1 -1
  308. package/dist/translations/pt.umd.js +1 -1
  309. package/dist/translations/ro.js +1 -1
  310. package/dist/translations/ro.umd.js +1 -1
  311. package/dist/translations/ru.js +1 -1
  312. package/dist/translations/ru.umd.js +1 -1
  313. package/dist/translations/si.js +1 -1
  314. package/dist/translations/si.umd.js +1 -1
  315. package/dist/translations/sk.js +1 -1
  316. package/dist/translations/sk.umd.js +1 -1
  317. package/dist/translations/sl.js +1 -1
  318. package/dist/translations/sl.umd.js +1 -1
  319. package/dist/translations/sq.js +1 -1
  320. package/dist/translations/sq.umd.js +1 -1
  321. package/dist/translations/sr-latn.js +1 -1
  322. package/dist/translations/sr-latn.umd.js +1 -1
  323. package/dist/translations/sr.js +1 -1
  324. package/dist/translations/sr.umd.js +1 -1
  325. package/dist/translations/sv.js +1 -1
  326. package/dist/translations/sv.umd.js +1 -1
  327. package/dist/translations/th.js +1 -1
  328. package/dist/translations/th.umd.js +1 -1
  329. package/dist/translations/ti.js +1 -1
  330. package/dist/translations/ti.umd.js +1 -1
  331. package/dist/translations/tk.js +1 -1
  332. package/dist/translations/tk.umd.js +1 -1
  333. package/dist/translations/tr.js +1 -1
  334. package/dist/translations/tr.umd.js +1 -1
  335. package/dist/translations/tt.js +1 -1
  336. package/dist/translations/tt.umd.js +1 -1
  337. package/dist/translations/ug.js +1 -1
  338. package/dist/translations/ug.umd.js +1 -1
  339. package/dist/translations/uk.js +1 -1
  340. package/dist/translations/uk.umd.js +1 -1
  341. package/dist/translations/ur.js +1 -1
  342. package/dist/translations/ur.umd.js +1 -1
  343. package/dist/translations/uz.js +1 -1
  344. package/dist/translations/uz.umd.js +1 -1
  345. package/dist/translations/vi.js +1 -1
  346. package/dist/translations/vi.umd.js +1 -1
  347. package/dist/translations/zh-cn.js +1 -1
  348. package/dist/translations/zh-cn.umd.js +1 -1
  349. package/dist/translations/zh.js +1 -1
  350. package/dist/translations/zh.umd.js +1 -1
  351. package/package.json +12 -12
  352. package/dist/aicore/utils/getoperationsfromreply.d.ts +0 -26
@@ -1,450 +1,450 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module ai/aiassistant/aiassistant
7
- * @publicApi
8
- */
9
- import { type Locale } from '@ckeditor/ckeditor5-utils';
10
- import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
11
- import { AIAssistantUI } from './aiassistantui.js';
12
- import { AIAssistantEditing } from './aiassistantediting.js';
13
- import type { OpenAITextAdapterConfig } from './adapters/openaitextadapter.js';
14
- import type { AIAWSTextAdapterConfig } from './adapters/awstextadapter.js';
6
+ * @module ai/aiassistant/aiassistant
7
+ * @publicApi
8
+ */
9
+ import { type Locale } from "@ckeditor/ckeditor5-utils";
10
+ import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
11
+ import { AIAssistantUI } from "./aiassistantui.js";
12
+ import { AIAssistantEditing } from "./aiassistantediting.js";
13
+ import type { OpenAITextAdapterConfig } from "./adapters/openaitextadapter.js";
14
+ import type { AIAWSTextAdapterConfig } from "./adapters/awstextadapter.js";
15
15
  /**
16
- * AI assistant plugin that allows you to use external AI models to generate content or improve existing content.
17
- *
18
- * The feature uses following {@link module:ai/aiassistant/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} values:
19
- *
20
- * * `aiAssistant:command:<commandId>` for the predefined commands, where `<commandId>` is the ID of the predefined command,
21
- * * `aiAssistant:custom` for custom queries provided by the user.
22
- */
16
+ * AI assistant plugin that allows you to use external AI models to generate content or improve existing content.
17
+ *
18
+ * The feature uses following {@link module:ai/aiassistant/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} values:
19
+ *
20
+ * * `aiAssistant:command:<commandId>` for the predefined commands, where `<commandId>` is the ID of the predefined command,
21
+ * * `aiAssistant:custom` for custom queries provided by the user.
22
+ */
23
23
  export declare class AIAssistant extends Plugin {
24
- /**
25
- * @inheritDoc
26
- */
27
- static get requires(): readonly [typeof AIAssistantUI, typeof AIAssistantEditing];
28
- /**
29
- * @inheritDoc
30
- */
31
- static get pluginName(): "AIAssistant";
32
- /**
33
- * @inheritDoc
34
- */
35
- static get isOfficialPlugin(): true;
36
- /**
37
- * @inheritDoc
38
- */
39
- static get isPremiumPlugin(): true;
40
- /**
41
- * @inheritDoc
42
- */
43
- constructor(editor: Editor);
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ static get requires(): PluginDependenciesOf<[AIAssistantUI, AIAssistantEditing]>;
28
+ /**
29
+ * @inheritDoc
30
+ */
31
+ static get pluginName(): "AIAssistant";
32
+ /**
33
+ * @inheritDoc
34
+ */
35
+ static override get isOfficialPlugin(): true;
36
+ /**
37
+ * @inheritDoc
38
+ */
39
+ static override get isPremiumPlugin(): true;
40
+ /**
41
+ * @inheritDoc
42
+ */
43
+ constructor(editor: Editor);
44
44
  }
45
45
  /**
46
- * A function that returns the list of the default AI commands definitions in the given localization context.
47
- */
46
+ * A function that returns the list of the default AI commands definitions in the given localization context.
47
+ */
48
48
  export declare function getDefaultAICommands(locale: Locale): Array<AIGroupDefinition>;
49
49
  /**
50
- * The configuration of the AI Assistant feature.
51
- *
52
- * The properties defined in this config are set in the `config.ai.assistant` namespace.
53
- *
54
- * ```ts
55
- * ClassicEditor
56
- * .create( {
57
- * ai: {
58
- * assistant: {
59
- * // AI Assistant configuration.
60
- * }
61
- * }
62
- * } )
63
- * .then( ... )
64
- * .catch( ... );
65
- * ```
66
- *
67
- * See {@link module:ai/aiconfig~AIConfig the full AI configuration}.
68
- *
69
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
70
- */
50
+ * The configuration of the AI Assistant feature.
51
+ *
52
+ * The properties defined in this config are set in the `config.ai.assistant` namespace.
53
+ *
54
+ * ```ts
55
+ * ClassicEditor
56
+ * .create( {
57
+ * ai: {
58
+ * assistant: {
59
+ * // AI Assistant configuration.
60
+ * }
61
+ * }
62
+ * } )
63
+ * .then( ... )
64
+ * .catch( ... );
65
+ * ```
66
+ *
67
+ * See {@link module:ai/aiconfig~AIConfig the full AI configuration}.
68
+ *
69
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
70
+ */
71
71
  export interface AIAssistantConfig {
72
- /**
73
- * A list of all AI commands groups definitions to be displayed in the `'aiCommands'` UI dropdown.
74
- *
75
- * Setting this property will overwrite the default list of predefined commands.
76
- *
77
- * You can avoid creating any groups by providing a list of command definitions directly. In this case,
78
- * commands will render as a flat list in the user interface.
79
- *
80
- * The default configuration is as follows. It can be obtained through {@link ~getDefaultAICommands}:
81
- *
82
- * ```json
83
- * [ {
84
- * groupId: 'editOrReview',
85
- * groupLabel: 'Edit or review',
86
- * commands: [
87
- * {
88
- * id: 'improveWriting',
89
- * label: 'Improve writing',
90
- * prompt: 'Fix spelling mistakes, use proper grammar and apply good writing practices. Do not lose the original meaning.'
91
- * },
92
- * {
93
- * id: 'makeShorter',
94
- * label: 'Make shorter',
95
- * prompt: 'Remove any repetitive, redundant, or non-essential writing in this content ' +
96
- * 'without changing the meaning or losing any key information.'
97
- * },
98
- * {
99
- * id: 'makeLonger',
100
- * label: 'Make longer',
101
- * prompt: 'Improve this content by using descriptive language and inserting more information and more detailed explanations.'
102
- * },
103
- * {
104
- * id: 'simplifyLanguage',
105
- * label: 'Simplify language',
106
- * prompt: 'Simplify the writing style of this content ' +
107
- * 'and reduce the complexity, so that the content is easy to understand.'
108
- * }
109
- * ]
110
- * },
111
- * {
112
- * groupId: 'generate',
113
- * groupLabel: 'Generate from selection',
114
- * commands: [
115
- * {
116
- * id: 'summarize',
117
- * label: 'Summarize',
118
- * prompt: 'Summarize this content into one paragraph of text. Include only the key ideas and conclusions. Keep it short. '
119
- * },
120
- * {
121
- * id: 'continue',
122
- * label: 'Continue',
123
- * prompt: 'Start with the provided content and write at the end of it continuing this topic. Keep the added part short.'
124
- * }
125
- * ]
126
- * },
127
- * {
128
- * groupId: 'changeTone',
129
- * groupLabel: 'Change tone',
130
- * commands: [
131
- * {
132
- * id: 'professional',
133
- * label: 'Professional',
134
- * prompt: 'Improve using polished, formal, and respectful language ' +
135
- * 'to convey professional expertise and competence.'
136
- * },
137
- * {
138
- * id: 'casual',
139
- * label: 'Casual',
140
- * prompt: 'Improve using casual, informal language to convey a casual conversation with a real person.'
141
- * },
142
- * {
143
- * id: 'direct',
144
- * label: 'Direct',
145
- * prompt: 'Improve using direct language using only the essential information.'
146
- * },
147
- * {
148
- * id: 'confident',
149
- * label: 'Confident',
150
- * prompt: 'Improve using compelling, optimistic language to convey confidence in the writing.'
151
- * },
152
- * {
153
- * id: 'friendly',
154
- * label: 'Friendly',
155
- * prompt: 'Improve using friendly, comforting language, to convey understanding and empathy.'
156
- * }
157
- * ]
158
- * },
159
- * {
160
- * groupId: 'changeStyle',
161
- * groupLabel: 'Change style',
162
- * commands: [
163
- * {
164
- * id: 'business',
165
- * label: 'Business',
166
- * prompt: 'Rewrite this content as a business professional with formal language.'
167
- * },
168
- * {
169
- * id: 'legal',
170
- * label: 'Legal',
171
- * prompt: 'Rewrite this content as a legal professional using valid legal terminology.'
172
- * },
173
- * {
174
- * id: 'journalism',
175
- * label: 'Journalism',
176
- * prompt: 'Rewrite this content as a journalist using engaging language to convey the importance of the information.'
177
- * },
178
- * {
179
- * id: 'poetic',
180
- * label: 'Poetic',
181
- * prompt: 'Rewrite this content as a poem using poetic techniques without losing the original meaning.'
182
- * }
183
- * ]
184
- * },
185
- * {
186
- * groupId: 'translate',
187
- * groupLabel: 'Translate',
188
- * commands: [
189
- * {
190
- * id: 'translateEnglish',
191
- * label: 'English',
192
- * prompt: 'Translate the content to English language.'
193
- * },
194
- * {
195
- * id: 'translateSpanish',
196
- * label: 'Spanish',
197
- * prompt: 'Translate the content to Spanish language.'
198
- * },
199
- * {
200
- * id: 'translatePortuguese',
201
- * label: 'Portuguese',
202
- * prompt: 'Translate the content to Portuguese language.'
203
- * },
204
- * {
205
- * id: 'translateGerman',
206
- * label: 'German',
207
- * prompt: 'Translate the content to German language.'
208
- * },
209
- * {
210
- * id: 'translateFrench',
211
- * label: 'French',
212
- * prompt: 'Translate the content to French language.'
213
- * },
214
- * {
215
- * id: 'translateChinese',
216
- * label: 'Simplified Chinese',
217
- * prompt: 'Translate the content to Simplified Chinese language.'
218
- * },
219
- * {
220
- * id: 'translateHindi',
221
- * label: 'Hindi',
222
- * prompt: 'Translate the content to Hindi language.'
223
- * },
224
- * {
225
- * id: 'translateArabic',
226
- * label: 'Arabic',
227
- * prompt: 'Translate the content to Arabic language.'
228
- * }
229
- * ]
230
- * } ]
231
- * ```
232
- */
233
- commands?: Array<AIGroupDefinition> | Array<AICommandDefinition>;
234
- /**
235
- * A list of additional AI commands groups definitions that will extend
236
- * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#commands default commands}.
237
- *
238
- * You can define new AI commands groups or add new AI commands to existing groups. If you add AI commands to an existing group,
239
- * you do not need to specify `groupLabel` property. Use the (optional) `order` property to control the position of new groups
240
- * and commands.
241
- *
242
- * An example configuration:
243
- *
244
- * ```json
245
- * {
246
- * assistant: {
247
- * extraCommandGroups: [
248
- * // Add an AI command to an existing group:
249
- * {
250
- * groupId: 'changeTone',
251
- * commands: [
252
- * {
253
- * id: 'sad',
254
- * label: 'Sad',
255
- * prompt: 'Rewrite this text to make it sound sad and depressing.',
256
- * // You can specify the position of this command among existing ones. Commands use zero-based numbering.
257
- * order: 2
258
- * }
259
- * ]
260
- * },
261
- * // Create a new AI commands group:
262
- * {
263
- * groupId: 'transformations',
264
- * groupLabel: 'Transformations',
265
- * // You can specify the position of this group among existing ones. Groups use zero-based numbering.
266
- * order: 3,
267
- * commands: [
268
- * {
269
- * id: 'addEmojis',
270
- * label: 'Add emojis',
271
- * prompt: 'Analyze each sentence of this text. After each sentence add an emoji that summarizes the sentence.'
272
- * },
273
- * // ...
274
- * ]
275
- * },
276
- * ],
277
- * // ...
278
- * }
279
- * }
280
- * ```
281
- */
282
- extraCommandGroups?: Array<AIGroupDefinition>;
283
- /**
284
- * A list of ids of AI commands and ids of commnad groups to be removed.
285
- *
286
- * Learn more about {@link module:ai/aiassistant/aiassistant~AICommandDefinition command definition and its id}.
287
- *
288
- * An example configuration:
289
- *
290
- * ```json
291
- * {
292
- * assistant: {
293
- * removeCommands: [
294
- * 'improveWriting',
295
- * 'changeTone',
296
- * // ...
297
- * ],
298
- * // ...
299
- * }
300
- * }
301
- * ```
302
- */
303
- removeCommands?: Array<string>;
304
- /**
305
- * An additional CSS class name (or names) added to the AI assistant content area (model response area).
306
- *
307
- * Because the content area is usually detached from the flow of the document, this configuration
308
- * allows for better integration with application's stylesheets and improves the consistency of content
309
- * styles.
310
- */
311
- contentAreaCssClass?: string;
312
- /**
313
- * The AI assistant feature will be disabled if the document selection includes any of these elements.
314
- *
315
- * Use this property if AI assistant does not work properly with your custom features.
316
- *
317
- * Currently, by default, AI assistant is disabled for following model elements:
318
- *
319
- * * Media embed (`'media'`) -- does not display in response area,
320
- * * HTML embed (`'rawHtml'`) -- sometimes does not display in response area, security uncertainty,
321
- * * Table of contents (`'tableOfContents'`) -- does not display properly in response area, long processing time.
322
- *
323
- * You can set this list to include more model elements or clear it to enable the above features.
324
- *
325
- * Note, that all or some of these features may become enabled in the future.
326
- *
327
- * @default [ 'media', 'rawHtml', 'tableOfContents' ]
328
- */
329
- disabledElements?: Array<string>;
330
- /**
331
- * Determines whether the comment markers should be preserved when the editor content is processed by the AI Assistant.
332
- *
333
- * Note, that this behavior depends on copy-paste comments functionality setting
334
- * (see {@link module:comments/config~CommentsConfig#copyMarkers `CommentsConfig#copyMarkers`}):
335
- *
336
- * * When set to `'never'`, comment markers will not be preserved.
337
- * * When set to `'default'`, comment markers will be preserved only for "replace" action.
338
- * * When set to `'always'`, comment markers will be preserved both for "replace" and "insert below" actions.
339
- *
340
- * Note, that whether the comment markers will be correctly handled also depends on the AI model response,
341
- * and how it processes the request.
342
- *
343
- * @default true
344
- */
345
- preserveComments?: boolean;
346
- /**
347
- * Enables or disables the colored UI theme for AI features.
348
- *
349
- * * Leaving this property unset will preserve the default theme on AI features UI elements.
350
- * * Setting this property to **`false`** will remove the default theme from AI features UI elements.
351
- *
352
- * See the AI Assistant integration guide to learn how you can use CSS variables to change the default theme to a different color.
353
- *
354
- * @default true
355
- */
356
- useTheme?: boolean;
357
- /**
358
- * The configuration for the AI adapter.
359
- *
360
- * This is required only if you connect to an external AI service.
361
- *
362
- * Learn more about available adapters:
363
- *
364
- * * {@link module:ai/aiassistant/adapters/openaitextadapter~OpenAITextAdapterConfig}
365
- * * {@link module:ai/aiassistant/adapters/awstextadapter~AIAWSTextAdapterConfig}
366
- */
367
- adapter?: {
368
- /**
369
- * The configuration for the {@link module:ai/aiassistant/adapters/openaitextadapter~OpenAITextAdapter `OpenAITextAdapter`}.
370
- *
371
- * This is required only if you connect to OpenAI or Azure OpenAI service.
372
- *
373
- * Read more in {@link module:ai/aiassistant/adapters/openaitextadapter~OpenAITextAdapterConfig}.
374
- */
375
- openAI?: OpenAITextAdapterConfig;
376
- /**
377
- * The configuration for the {@link module:ai/aiassistant/adapters/awstextadapter~AWSTextAdapter `AWSTextAdapter`}.
378
- *
379
- * This is required only if you connect to Amazon Bedrock service.
380
- *
381
- * Read more in {@link module:ai/aiassistant/adapters/awstextadapter~AIAWSTextAdapterConfig}.
382
- *
383
- * @deprecated
384
- */
385
- aws?: AIAWSTextAdapterConfig;
386
- };
72
+ /**
73
+ * A list of all AI commands groups definitions to be displayed in the `'aiCommands'` UI dropdown.
74
+ *
75
+ * Setting this property will overwrite the default list of predefined commands.
76
+ *
77
+ * You can avoid creating any groups by providing a list of command definitions directly. In this case,
78
+ * commands will render as a flat list in the user interface.
79
+ *
80
+ * The default configuration is as follows. It can be obtained through {@link ~getDefaultAICommands}:
81
+ *
82
+ * ```json
83
+ * [ {
84
+ * groupId: 'editOrReview',
85
+ * groupLabel: 'Edit or review',
86
+ * commands: [
87
+ * {
88
+ * id: 'improveWriting',
89
+ * label: 'Improve writing',
90
+ * prompt: 'Fix spelling mistakes, use proper grammar and apply good writing practices. Do not lose the original meaning.'
91
+ * },
92
+ * {
93
+ * id: 'makeShorter',
94
+ * label: 'Make shorter',
95
+ * prompt: 'Remove any repetitive, redundant, or non-essential writing in this content ' +
96
+ * 'without changing the meaning or losing any key information.'
97
+ * },
98
+ * {
99
+ * id: 'makeLonger',
100
+ * label: 'Make longer',
101
+ * prompt: 'Improve this content by using descriptive language and inserting more information and more detailed explanations.'
102
+ * },
103
+ * {
104
+ * id: 'simplifyLanguage',
105
+ * label: 'Simplify language',
106
+ * prompt: 'Simplify the writing style of this content ' +
107
+ * 'and reduce the complexity, so that the content is easy to understand.'
108
+ * }
109
+ * ]
110
+ * },
111
+ * {
112
+ * groupId: 'generate',
113
+ * groupLabel: 'Generate from selection',
114
+ * commands: [
115
+ * {
116
+ * id: 'summarize',
117
+ * label: 'Summarize',
118
+ * prompt: 'Summarize this content into one paragraph of text. Include only the key ideas and conclusions. Keep it short. '
119
+ * },
120
+ * {
121
+ * id: 'continue',
122
+ * label: 'Continue',
123
+ * prompt: 'Start with the provided content and write at the end of it continuing this topic. Keep the added part short.'
124
+ * }
125
+ * ]
126
+ * },
127
+ * {
128
+ * groupId: 'changeTone',
129
+ * groupLabel: 'Change tone',
130
+ * commands: [
131
+ * {
132
+ * id: 'professional',
133
+ * label: 'Professional',
134
+ * prompt: 'Improve using polished, formal, and respectful language ' +
135
+ * 'to convey professional expertise and competence.'
136
+ * },
137
+ * {
138
+ * id: 'casual',
139
+ * label: 'Casual',
140
+ * prompt: 'Improve using casual, informal language to convey a casual conversation with a real person.'
141
+ * },
142
+ * {
143
+ * id: 'direct',
144
+ * label: 'Direct',
145
+ * prompt: 'Improve using direct language using only the essential information.'
146
+ * },
147
+ * {
148
+ * id: 'confident',
149
+ * label: 'Confident',
150
+ * prompt: 'Improve using compelling, optimistic language to convey confidence in the writing.'
151
+ * },
152
+ * {
153
+ * id: 'friendly',
154
+ * label: 'Friendly',
155
+ * prompt: 'Improve using friendly, comforting language, to convey understanding and empathy.'
156
+ * }
157
+ * ]
158
+ * },
159
+ * {
160
+ * groupId: 'changeStyle',
161
+ * groupLabel: 'Change style',
162
+ * commands: [
163
+ * {
164
+ * id: 'business',
165
+ * label: 'Business',
166
+ * prompt: 'Rewrite this content as a business professional with formal language.'
167
+ * },
168
+ * {
169
+ * id: 'legal',
170
+ * label: 'Legal',
171
+ * prompt: 'Rewrite this content as a legal professional using valid legal terminology.'
172
+ * },
173
+ * {
174
+ * id: 'journalism',
175
+ * label: 'Journalism',
176
+ * prompt: 'Rewrite this content as a journalist using engaging language to convey the importance of the information.'
177
+ * },
178
+ * {
179
+ * id: 'poetic',
180
+ * label: 'Poetic',
181
+ * prompt: 'Rewrite this content as a poem using poetic techniques without losing the original meaning.'
182
+ * }
183
+ * ]
184
+ * },
185
+ * {
186
+ * groupId: 'translate',
187
+ * groupLabel: 'Translate',
188
+ * commands: [
189
+ * {
190
+ * id: 'translateEnglish',
191
+ * label: 'English',
192
+ * prompt: 'Translate the content to English language.'
193
+ * },
194
+ * {
195
+ * id: 'translateSpanish',
196
+ * label: 'Spanish',
197
+ * prompt: 'Translate the content to Spanish language.'
198
+ * },
199
+ * {
200
+ * id: 'translatePortuguese',
201
+ * label: 'Portuguese',
202
+ * prompt: 'Translate the content to Portuguese language.'
203
+ * },
204
+ * {
205
+ * id: 'translateGerman',
206
+ * label: 'German',
207
+ * prompt: 'Translate the content to German language.'
208
+ * },
209
+ * {
210
+ * id: 'translateFrench',
211
+ * label: 'French',
212
+ * prompt: 'Translate the content to French language.'
213
+ * },
214
+ * {
215
+ * id: 'translateChinese',
216
+ * label: 'Simplified Chinese',
217
+ * prompt: 'Translate the content to Simplified Chinese language.'
218
+ * },
219
+ * {
220
+ * id: 'translateHindi',
221
+ * label: 'Hindi',
222
+ * prompt: 'Translate the content to Hindi language.'
223
+ * },
224
+ * {
225
+ * id: 'translateArabic',
226
+ * label: 'Arabic',
227
+ * prompt: 'Translate the content to Arabic language.'
228
+ * }
229
+ * ]
230
+ * } ]
231
+ * ```
232
+ */
233
+ commands?: Array<AIGroupDefinition> | Array<AICommandDefinition>;
234
+ /**
235
+ * A list of additional AI commands groups definitions that will extend
236
+ * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#commands default commands}.
237
+ *
238
+ * You can define new AI commands groups or add new AI commands to existing groups. If you add AI commands to an existing group,
239
+ * you do not need to specify `groupLabel` property. Use the (optional) `order` property to control the position of new groups
240
+ * and commands.
241
+ *
242
+ * An example configuration:
243
+ *
244
+ * ```json
245
+ * {
246
+ * assistant: {
247
+ * extraCommandGroups: [
248
+ * // Add an AI command to an existing group:
249
+ * {
250
+ * groupId: 'changeTone',
251
+ * commands: [
252
+ * {
253
+ * id: 'sad',
254
+ * label: 'Sad',
255
+ * prompt: 'Rewrite this text to make it sound sad and depressing.',
256
+ * // You can specify the position of this command among existing ones. Commands use zero-based numbering.
257
+ * order: 2
258
+ * }
259
+ * ]
260
+ * },
261
+ * // Create a new AI commands group:
262
+ * {
263
+ * groupId: 'transformations',
264
+ * groupLabel: 'Transformations',
265
+ * // You can specify the position of this group among existing ones. Groups use zero-based numbering.
266
+ * order: 3,
267
+ * commands: [
268
+ * {
269
+ * id: 'addEmojis',
270
+ * label: 'Add emojis',
271
+ * prompt: 'Analyze each sentence of this text. After each sentence add an emoji that summarizes the sentence.'
272
+ * },
273
+ * // ...
274
+ * ]
275
+ * },
276
+ * ],
277
+ * // ...
278
+ * }
279
+ * }
280
+ * ```
281
+ */
282
+ extraCommandGroups?: Array<AIGroupDefinition>;
283
+ /**
284
+ * A list of ids of AI commands and ids of commnad groups to be removed.
285
+ *
286
+ * Learn more about {@link module:ai/aiassistant/aiassistant~AICommandDefinition command definition and its id}.
287
+ *
288
+ * An example configuration:
289
+ *
290
+ * ```json
291
+ * {
292
+ * assistant: {
293
+ * removeCommands: [
294
+ * 'improveWriting',
295
+ * 'changeTone',
296
+ * // ...
297
+ * ],
298
+ * // ...
299
+ * }
300
+ * }
301
+ * ```
302
+ */
303
+ removeCommands?: Array<string>;
304
+ /**
305
+ * An additional CSS class name (or names) added to the AI assistant content area (model response area).
306
+ *
307
+ * Because the content area is usually detached from the flow of the document, this configuration
308
+ * allows for better integration with application's stylesheets and improves the consistency of content
309
+ * styles.
310
+ */
311
+ contentAreaCssClass?: string;
312
+ /**
313
+ * The AI assistant feature will be disabled if the document selection includes any of these elements.
314
+ *
315
+ * Use this property if AI assistant does not work properly with your custom features.
316
+ *
317
+ * Currently, by default, AI assistant is disabled for following model elements:
318
+ *
319
+ * * Media embed (`'media'`) -- does not display in response area,
320
+ * * HTML embed (`'rawHtml'`) -- sometimes does not display in response area, security uncertainty,
321
+ * * Table of contents (`'tableOfContents'`) -- does not display properly in response area, long processing time.
322
+ *
323
+ * You can set this list to include more model elements or clear it to enable the above features.
324
+ *
325
+ * Note, that all or some of these features may become enabled in the future.
326
+ *
327
+ * @default [ 'media', 'rawHtml', 'tableOfContents' ]
328
+ */
329
+ disabledElements?: Array<string>;
330
+ /**
331
+ * Determines whether the comment markers should be preserved when the editor content is processed by the AI Assistant.
332
+ *
333
+ * Note, that this behavior depends on copy-paste comments functionality setting
334
+ * (see {@link module:comments/config~CommentsConfig#copyMarkers `CommentsConfig#copyMarkers`}):
335
+ *
336
+ * * When set to `'never'`, comment markers will not be preserved.
337
+ * * When set to `'default'`, comment markers will be preserved only for "replace" action.
338
+ * * When set to `'always'`, comment markers will be preserved both for "replace" and "insert below" actions.
339
+ *
340
+ * Note, that whether the comment markers will be correctly handled also depends on the AI model response,
341
+ * and how it processes the request.
342
+ *
343
+ * @default true
344
+ */
345
+ preserveComments?: boolean;
346
+ /**
347
+ * Enables or disables the colored UI theme for AI features.
348
+ *
349
+ * * Leaving this property unset will preserve the default theme on AI features UI elements.
350
+ * * Setting this property to **`false`** will remove the default theme from AI features UI elements.
351
+ *
352
+ * See the AI Assistant integration guide to learn how you can use CSS variables to change the default theme to a different color.
353
+ *
354
+ * @default true
355
+ */
356
+ useTheme?: boolean;
357
+ /**
358
+ * The configuration for the AI adapter.
359
+ *
360
+ * This is required only if you connect to an external AI service.
361
+ *
362
+ * Learn more about available adapters:
363
+ *
364
+ * * {@link module:ai/aiassistant/adapters/openaitextadapter~OpenAITextAdapterConfig}
365
+ * * {@link module:ai/aiassistant/adapters/awstextadapter~AIAWSTextAdapterConfig}
366
+ */
367
+ adapter?: {
368
+ /**
369
+ * The configuration for the {@link module:ai/aiassistant/adapters/openaitextadapter~OpenAITextAdapter `OpenAITextAdapter`}.
370
+ *
371
+ * This is required only if you connect to OpenAI or Azure OpenAI service.
372
+ *
373
+ * Read more in {@link module:ai/aiassistant/adapters/openaitextadapter~OpenAITextAdapterConfig}.
374
+ */
375
+ openAI?: OpenAITextAdapterConfig;
376
+ /**
377
+ * The configuration for the {@link module:ai/aiassistant/adapters/awstextadapter~AWSTextAdapter `AWSTextAdapter`}.
378
+ *
379
+ * This is required only if you connect to Amazon Bedrock service.
380
+ *
381
+ * Read more in {@link module:ai/aiassistant/adapters/awstextadapter~AIAWSTextAdapterConfig}.
382
+ *
383
+ * @deprecated
384
+ */
385
+ aws?: AIAWSTextAdapterConfig;
386
+ };
387
387
  }
388
388
  export type AIGroupDefinition = {
389
- /**
390
- * The unique identifier of the group. It can be referenced while extending existing groups
391
- * using {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#extraCommandGroups} or removing command groups using
392
- * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#removeCommands}.
393
- */
394
- groupId: string;
395
- /**
396
- * The human-readable label of the group.
397
- */
398
- groupLabel?: string;
399
- /**
400
- * The array of command definitions that belong to the group.
401
- */
402
- commands: Array<AICommandDefinition>;
403
- /**
404
- * The order of the group on the list. The lower the number, the higher the group is displayed on the list.
405
- * If not specified, the position of this group will be determined by the order of
406
- * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#commands configuration}.
407
- *
408
- * If a new group is added without `order` property, it will be added at the end.
409
- *
410
- * The order uses zero-based numbering (the first group's order is `0`).
411
- */
412
- order?: number;
389
+ /**
390
+ * The unique identifier of the group. It can be referenced while extending existing groups
391
+ * using {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#extraCommandGroups} or removing command groups using
392
+ * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#removeCommands}.
393
+ */
394
+ groupId: string;
395
+ /**
396
+ * The human-readable label of the group.
397
+ */
398
+ groupLabel?: string;
399
+ /**
400
+ * The array of command definitions that belong to the group.
401
+ */
402
+ commands: Array<AICommandDefinition>;
403
+ /**
404
+ * The order of the group on the list. The lower the number, the higher the group is displayed on the list.
405
+ * If not specified, the position of this group will be determined by the order of
406
+ * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#commands configuration}.
407
+ *
408
+ * If a new group is added without `order` property, it will be added at the end.
409
+ *
410
+ * The order uses zero-based numbering (the first group's order is `0`).
411
+ */
412
+ order?: number;
413
413
  };
414
414
  export type AICommandDefinition = {
415
- /**
416
- * The unique identifier of the command. It can be referenced while removing commands. See
417
- * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#removeCommands} to learn more.
418
- */
419
- id: string;
420
- /**
421
- * The human-readable label of the command.
422
- */
423
- label: string;
424
- /**
425
- * The instruction that will be passed to the AI model.
426
- *
427
- * It is wrapped in a "full prompt template" for better results.
428
- */
429
- prompt: string;
430
- /**
431
- * By default, all commands require a selection for the assistant to work on. If the selection is collapsed,
432
- * it automatically expands to the nearest block boundaries to provide the AI context.
433
- *
434
- * Setting this to `false` allows the command to work on a collapsed selection and prevent selection expansion.
435
- * This is helpful, for instance, for commands that generate content from scratch.
436
- *
437
- * **Note**: If not specified, the default is `true`.
438
- */
439
- requiresContent?: boolean;
440
- /**
441
- * The order of the command on the list. The lower the number, the higher the command is displayed on the list.
442
- * If not specified, the position of this command will be determined by the order of
443
- * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#commands configuration}.
444
- *
445
- * If a new command is added without `order` property, it will be added at the end of the group.
446
- *
447
- * The order uses zero-based numbering (the first command's order is `0`).
448
- */
449
- order?: number;
415
+ /**
416
+ * The unique identifier of the command. It can be referenced while removing commands. See
417
+ * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#removeCommands} to learn more.
418
+ */
419
+ id: string;
420
+ /**
421
+ * The human-readable label of the command.
422
+ */
423
+ label: string;
424
+ /**
425
+ * The instruction that will be passed to the AI model.
426
+ *
427
+ * It is wrapped in a "full prompt template" for better results.
428
+ */
429
+ prompt: string;
430
+ /**
431
+ * By default, all commands require a selection for the assistant to work on. If the selection is collapsed,
432
+ * it automatically expands to the nearest block boundaries to provide the AI context.
433
+ *
434
+ * Setting this to `false` allows the command to work on a collapsed selection and prevent selection expansion.
435
+ * This is helpful, for instance, for commands that generate content from scratch.
436
+ *
437
+ * **Note**: If not specified, the default is `true`.
438
+ */
439
+ requiresContent?: boolean;
440
+ /**
441
+ * The order of the command on the list. The lower the number, the higher the command is displayed on the list.
442
+ * If not specified, the position of this command will be determined by the order of
443
+ * {@link module:ai/aiassistant/aiassistant~AIAssistantConfig#commands configuration}.
444
+ *
445
+ * If a new command is added without `order` property, it will be added at the end of the group.
446
+ *
447
+ * The order uses zero-based numbering (the first command's order is `0`).
448
+ */
449
+ order?: number;
450
450
  };