@ckeditor/ckeditor5-track-changes 39.0.2 → 40.1.0

package/src/trackchangesdata.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x406e=['editor','data','_adapter','getSuggestions','createElement','editorCreator','getRootsAttributes','get','name','getFullData','CommentsRepository','getRootNames','createDocumentFragment','map','TrackChangesEditing','plugins','create','getDataWithAcceptedSuggestions','document','requires','TrackChangesDataGetter','init','track-changes-data-invalid-editor-creator','div','reduce','trackChangesData','result','trackChangesData.editorCreator','useAnonymousUser','define','acceptAllSuggestions','execute','model','addUser','discardAllSuggestions','rootsAttributes','destroy','config','TrackChangesData','pluginName'];(function(_0x48028e,_0x406e1e){const _0x4b3f4a=function(_0x554715){while(--_0x554715){_0x48028e['push'](_0x48028e['shift']());}};_0x4b3f4a(++_0x406e1e);}(_0x406e,0x192));const _0x4b3f=function(_0x48028e,_0x406e1e){_0x48028e=_0x48028e-0x0;let _0x4b3f4a=_0x406e[_0x48028e];return _0x4b3f4a;};import{Plugin as _0x2e5818}from'ckeditor5/src/core';import{CKEditorError as _0x54e24d}from'ckeditor5/src/utils';import _0x5aad5a from'./trackchangesediting';import{sanitizeEditorConfig as _0x5e602c}from'ckeditor5-collaboration/src/collaboration-core';const w=['Pagination'];export default class T extends _0x2e5818{static get[_0x4b3f('0x11')](){return[_0x5aad5a];}static get[_0x4b3f('0x25')](){return _0x4b3f('0x24');}[_0x4b3f('0x13')](){const _0x1e5b38=this[_0x4b3f('0x26')];if(_0x1e5b38[_0x4b3f('0x23')][_0x4b3f('0x1b')](_0x4b3f('0x19'),_0x3916e5=>{const _0x2ef5ad=_0x1e5b38['model']['document'][_0x4b3f('0x9')]()['reduce']((_0x1d29c7,_0x2115b5)=>(_0x1d29c7[_0x2115b5]='',_0x1d29c7),{});return _0x1e5b38['constructor'][_0x4b3f('0xe')](_0x2ef5ad,_0x3916e5);}),'function'!=typeof _0x1e5b38[_0x4b3f('0x23')][_0x4b3f('0x5')](_0x4b3f('0x17'))[_0x4b3f('0x3')])throw new _0x54e24d(_0x4b3f('0x14'));}[_0x4b3f('0xf')](_0x2d48ca){return v(this[_0x4b3f('0x26')],!0x0,_0x2d48ca);}['getDataWithDiscardedSuggestions'](_0x5da539){return v(this[_0x4b3f('0x26')],!0x1,_0x5da539);}}class P extends _0x2e5818{static get[_0x4b3f('0x25')](){return _0x4b3f('0x12');}constructor(_0xb35bac){super(_0xb35bac),this[_0x4b3f('0x18')]='end';}['init'](){this[_0x4b3f('0x26')][_0x4b3f('0xd')][_0x4b3f('0x5')](_0x4b3f('0x8'))[_0x4b3f('0x0')]={'addCommentThread':()=>new Promise(()=>{}),'getCommentThread':()=>new Promise(()=>{}),'updateCommentThread':()=>new Promise(()=>{}),'resolveCommentThread':()=>new Promise(()=>{}),'reopenCommentThread':()=>new Promise(()=>{}),'removeCommentThread':()=>new Promise(()=>{}),'addComment':()=>new Promise(()=>{}),'updateComment':()=>new Promise(()=>{}),'removeComment':()=>new Promise(()=>{})},this[_0x4b3f('0x26')][_0x4b3f('0xd')][_0x4b3f('0x5')](_0x4b3f('0xc'))[_0x4b3f('0x0')]=null;}}function D(_0x187761){return void 0x0!==_0x187761[_0x4b3f('0x4')];}async function v(_0x47c599,_0x3ce4df,_0x546bbb){const _0x58a938=_0x5e602c(_0x47c599,w);_0x58a938['plugins']['push'](_0x5aad5a,P),_0x58a938[_0x4b3f('0x21')]=D(_0x47c599)?_0x47c599[_0x4b3f('0x4')]():void 0x0;const _0x2cdbdd=document[_0x4b3f('0xa')](),_0x206284=_0x47c599['config'][_0x4b3f('0x5')](_0x4b3f('0x17'))[_0x4b3f('0x3')],_0x4f3c00=await _0x206284(_0x58a938,()=>function(_0x538a91){const _0x4c6d27=document[_0x4b3f('0x2')](_0x4b3f('0x15'));return _0x538a91['appendChild'](_0x4c6d27),_0x4c6d27;}(_0x2cdbdd));!function(_0xd822ef,_0x1d5574){const _0x1f36c8=_0xd822ef[_0x4b3f('0x1e')][_0x4b3f('0x10')]['getRootNames']()[_0x4b3f('0x16')]((_0x5078aa,_0x197842)=>(_0x5078aa[_0x197842]=_0xd822ef[_0x4b3f('0x27')][_0x4b3f('0x5')]({'rootName':_0x197842}),_0x5078aa),{}),_0xa0d04d=_0xd822ef[_0x4b3f('0xd')][_0x4b3f('0x5')]('Users')['users'][_0x4b3f('0xb')](_0xa25cd8=>({'id':_0xa25cd8['id'],'name':_0xa25cd8[_0x4b3f('0x6')]})),_0x3220a6=_0xd822ef[_0x4b3f('0xd')]['get'](_0x4b3f('0xc'))[_0x4b3f('0x1')]({'skipNotAttached':!0x0,'toJSON':!0x0}),_0x1f5145=_0x1d5574[_0x4b3f('0xd')]['get']('Users'),_0x2c82b1=_0x1d5574['plugins']['get'](_0x4b3f('0xc'));for(const _0xa69c5c of _0xa0d04d)_0x1f5145['getUser'](_0xa69c5c['id'])||_0x1f5145[_0x4b3f('0x1f')](_0xa69c5c);_0x1f5145['me']||_0x1f5145[_0x4b3f('0x1a')]();for(const _0x3d7f96 of _0x3220a6)_0x2c82b1['addSuggestionData'](_0x3d7f96);_0x1d5574[_0x4b3f('0x27')]['set'](_0x1f36c8);}(_0x47c599,_0x4f3c00),_0x4f3c00[_0x4b3f('0x1d')](_0x3ce4df?_0x4b3f('0x1c'):_0x4b3f('0x20'));const _0xfc3072=D(_0x4f3c00)?_0x4f3c00[_0x4b3f('0x7')](_0x546bbb):_0x4f3c00[_0x4b3f('0x27')]['get'](_0x546bbb);return await _0x4f3c00[_0x4b3f('0x22')](),_0xfc3072;}
+const _0x2a23=['editor','appendChild','execute','push','getUser','rootsAttributes','getSuggestions','get','editorCreator','name','result','createElement','trackChangesData.editorCreator','map','discardAllSuggestions','TrackChangesEditing','document','init','config','model','create','getFullData','trackChangesData','define','plugins','Users','getRootNames','acceptAllSuggestions','users','addUser','pluginName','track-changes-data-invalid-editor-creator','useAnonymousUser','getRootsAttributes','TrackChangesDataGetter','getDataWithAcceptedSuggestions','_adapter','data','function','CommentsRepository'];(function(_0x307034,_0x2a2369){const _0x13a6ba=function(_0xc3c981){while(--_0xc3c981){_0x307034['push'](_0x307034['shift']());}};_0x13a6ba(++_0x2a2369);}(_0x2a23,0x12f));const _0x13a6=function(_0x307034,_0x2a2369){_0x307034=_0x307034-0x0;let _0x13a6ba=_0x2a23[_0x307034];return _0x13a6ba;};import{Plugin as _0x5d991a}from'ckeditor5/src/core';import{CKEditorError as _0x5e4817}from'ckeditor5/src/utils';import _0x268e3e from'./trackchangesediting';import{sanitizeEditorConfig as _0x21f2df}from'ckeditor5-collaboration/src/collaboration-core';const T=['Pagination'];export default class P extends _0x5d991a{static get['requires'](){return[_0x268e3e];}static get['pluginName'](){return'TrackChangesData';}[_0x13a6('0x22')](){const _0x7f8a39=this[_0x13a6('0x11')];if(_0x7f8a39['config'][_0x13a6('0x0')](_0x13a6('0x1d'),_0x41c1a9=>{const _0x139251=_0x7f8a39['model'][_0x13a6('0x21')]['getRootNames']()['reduce']((_0x35303e,_0x38bab6)=>(_0x35303e[_0x38bab6]='',_0x35303e),{});return _0x7f8a39['constructor'][_0x13a6('0x25')](_0x139251,_0x41c1a9);}),_0x13a6('0xf')!=typeof _0x7f8a39[_0x13a6('0x23')][_0x13a6('0x18')](_0x13a6('0x27'))[_0x13a6('0x19')])throw new _0x5e4817(_0x13a6('0x8'));}[_0x13a6('0xc')](_0xaf0666){return N(this[_0x13a6('0x11')],!0x0,_0xaf0666);}['getDataWithDiscardedSuggestions'](_0x428a24){return N(this[_0x13a6('0x11')],!0x1,_0x428a24);}}class D extends _0x5d991a{static get[_0x13a6('0x7')](){return _0x13a6('0xb');}constructor(_0x3700da){super(_0x3700da),this[_0x13a6('0x1b')]='end';}[_0x13a6('0x22')](){this['editor'][_0x13a6('0x1')]['get'](_0x13a6('0x10'))[_0x13a6('0xd')]={'addCommentThread':()=>new Promise(()=>{}),'getCommentThread':()=>new Promise(()=>{}),'updateCommentThread':()=>new Promise(()=>{}),'resolveCommentThread':()=>new Promise(()=>{}),'reopenCommentThread':()=>new Promise(()=>{}),'removeCommentThread':()=>new Promise(()=>{}),'addComment':()=>new Promise(()=>{}),'updateComment':()=>new Promise(()=>{}),'removeComment':()=>new Promise(()=>{})},this[_0x13a6('0x11')][_0x13a6('0x1')][_0x13a6('0x18')](_0x13a6('0x20'))[_0x13a6('0xd')]=null;}}function v(_0x14271b){return void 0x0!==_0x14271b[_0x13a6('0xa')];}async function N(_0x566f3e,_0x3cf04d,_0x34ceeb){const _0x346094=_0x21f2df(_0x566f3e,T);_0x346094[_0x13a6('0x1')][_0x13a6('0x14')](_0x268e3e,D),_0x346094[_0x13a6('0x16')]=v(_0x566f3e)?_0x566f3e[_0x13a6('0xa')]():void 0x0;const _0x55d8b3=document['createDocumentFragment'](),_0x42a06f=_0x566f3e[_0x13a6('0x23')][_0x13a6('0x18')](_0x13a6('0x27'))[_0x13a6('0x19')],_0x2109eb=await _0x42a06f(_0x346094,()=>function(_0x7fbc3b){const _0x4ab0cb=document[_0x13a6('0x1c')]('div');return _0x7fbc3b[_0x13a6('0x12')](_0x4ab0cb),_0x4ab0cb;}(_0x55d8b3));!function(_0x4e06aa,_0x55585f){const _0x1ef9c5=_0x4e06aa[_0x13a6('0x24')][_0x13a6('0x21')][_0x13a6('0x3')]()['reduce']((_0x473b2f,_0x4c20e7)=>(_0x473b2f[_0x4c20e7]=_0x4e06aa[_0x13a6('0xe')][_0x13a6('0x18')]({'rootName':_0x4c20e7}),_0x473b2f),{}),_0x3a6228=_0x4e06aa['plugins']['get'](_0x13a6('0x2'))[_0x13a6('0x5')][_0x13a6('0x1e')](_0x12e9f2=>({'id':_0x12e9f2['id'],'name':_0x12e9f2[_0x13a6('0x1a')]})),_0x42a8cc=_0x4e06aa[_0x13a6('0x1')][_0x13a6('0x18')](_0x13a6('0x20'))[_0x13a6('0x17')]({'skipNotAttached':!0x0,'toJSON':!0x0}),_0x4c8108=_0x55585f['plugins'][_0x13a6('0x18')]('Users'),_0x5b5de9=_0x55585f[_0x13a6('0x1')][_0x13a6('0x18')](_0x13a6('0x20'));for(const _0x362d58 of _0x3a6228)_0x4c8108[_0x13a6('0x15')](_0x362d58['id'])||_0x4c8108[_0x13a6('0x6')](_0x362d58);_0x4c8108['me']||_0x4c8108[_0x13a6('0x9')]();for(const _0x460c89 of _0x42a8cc)_0x5b5de9['addSuggestionData'](_0x460c89);_0x55585f[_0x13a6('0xe')]['set'](_0x1ef9c5);}(_0x566f3e,_0x2109eb),_0x2109eb[_0x13a6('0x13')](_0x3cf04d?_0x13a6('0x4'):_0x13a6('0x1f'));const _0x12ba8=v(_0x2109eb)?_0x2109eb[_0x13a6('0x26')](_0x34ceeb):_0x2109eb['data'][_0x13a6('0x18')](_0x34ceeb);return await _0x2109eb['destroy'](),_0x12ba8;}

package/src/trackchangesediting.d.ts

@@ -11,6 +11,7 @@ import { type Element, type Range } from 'ckeditor5/src/engine';
 import { Users } from 'ckeditor5-collaboration/src/collaboration-core';
 import TrackChangesCommand from './commands/trackchangescommand';
 import Suggestion, { type SuggestionJSON } from './suggestion';
+import TrackChangesAIAssistant from './integrations/aiassistant';
 import TrackChangesAlignment from './integrations/alignment';
 import TrackChangesBasicStyles from './integrations/basicstyles';
 import TrackChangesBlockQuote from './integrations/blockquote';
@@ -19,6 +20,7 @@ import TrackChangesCodeBlock from './integrations/codeblock';
 import TrackChangesComments from './integrations/comments';
 import TrackChangesDeleteCommand from './integrations/deletecommand';
 import TrackChangesDocumentList from './integrations/documentlist';
+import TrackChangesDocumentListProperties from './integrations/documentlistproperties';
 import TrackChangesEnterCommand from './integrations/entercommand';
 import TrackChangesFindAndReplace from './integrations/findandreplace';
 import TrackChangesFont from './integrations/font';
@@ -29,6 +31,7 @@ import TrackChangesHorizontalLine from './integrations/horizontalline';
 import TrackChangesHtmlEmbed from './integrations/htmlembed';
 import TrackChangesImage from './integrations/image';
 import TrackChangesImageReplace from './integrations/imagereplace';
+import TrackChangesImageStyle from './integrations/imagestyle';
 import TrackChangesImportWord from './integrations/importword';
 import TrackChangesIndent from './integrations/indent';
 import TrackChangesInputCommand from './integrations/inputcommand';
@@ -54,9 +57,9 @@ import TrackChangesTableOfContents from './integrations/tableofcontents';
 import TrackChangesTitle from './integrations/title';
 import TrackChangesUndo from './integrations/undo';
 import TrackChangesTableCaption from './integrations/tablecaption';
-import TrackChangesDocumentListProperties from './integrations/documentlistproperties';
 import TrackChangesTableProperties from './integrations/tableproperties';
 import type { SuggestionData, TrackChangesAdapter } from './trackchanges';
+export declare const renameAttributeKey = "$elementName";
 /**
  * Provides editing part of the {@link module:track-changes/trackchanges~TrackChanges track changes plugin}.
  */
@@ -71,7 +74,7 @@ export default class TrackChangesEditing extends Plugin {
      * Reference to command that turns the track changes mode on and off.
      */
     trackChangesCommand: TrackChangesCommand;
-    static get requires(): readonly ["CommentsRepository", typeof Users, typeof PendingActions, typeof TrackChangesAlignment, typeof TrackChangesBasicStyles, typeof TrackChangesBlockQuote, typeof TrackChangesCKBox, typeof TrackChangesCodeBlock, typeof TrackChangesComments, typeof TrackChangesDeleteCommand, typeof TrackChangesDocumentList, typeof TrackChangesDocumentListProperties, typeof TrackChangesEnterCommand, typeof TrackChangesFindAndReplace, typeof TrackChangesFont, typeof TrackChangesFormatPainter, typeof TrackChangesHeading, typeof TrackChangesHighlight, typeof TrackChangesHorizontalLine, typeof TrackChangesHtmlEmbed, typeof TrackChangesImage, typeof TrackChangesImageReplace, typeof TrackChangesImportWord, typeof TrackChangesIndent, typeof TrackChangesInputCommand, typeof TrackChangesLink, typeof TrackChangesList, typeof TrackChangesListProperties, typeof TrackChangesMediaEmbed, typeof TrackChangesMention, typeof TrackChangesPageBreak, typeof TrackChangesParagraph, typeof TrackChangesRemoveFormat, typeof TrackChangesRestrictedEditingMode, typeof TrackChangesShiftEnterCommand, typeof TrackChangesStandardEditingMode, typeof TrackChangesStylesDropdown, typeof TrackChangesTable, typeof TrackChangesTableMergeSplit, typeof TrackChangesTableHeadings, typeof TrackChangesTableCaption, typeof TrackChangesTableClipboard, typeof TrackChangesTableColumnResize, typeof TrackChangesTableOfContents, typeof TrackChangesTableProperties, typeof TrackChangesTemplate, typeof TrackChangesTitle, typeof TrackChangesUndo];
+    static get requires(): readonly ["CommentsRepository", typeof Users, typeof PendingActions, typeof TrackChangesAIAssistant, typeof TrackChangesAlignment, typeof TrackChangesBasicStyles, typeof TrackChangesBlockQuote, typeof TrackChangesCKBox, typeof TrackChangesCodeBlock, typeof TrackChangesComments, typeof TrackChangesDeleteCommand, typeof TrackChangesDocumentList, typeof TrackChangesDocumentListProperties, typeof TrackChangesEnterCommand, typeof TrackChangesFindAndReplace, typeof TrackChangesFont, typeof TrackChangesFormatPainter, typeof TrackChangesHeading, typeof TrackChangesHighlight, typeof TrackChangesHorizontalLine, typeof TrackChangesHtmlEmbed, typeof TrackChangesImage, typeof TrackChangesImageStyle, typeof TrackChangesImageReplace, typeof TrackChangesImportWord, typeof TrackChangesIndent, typeof TrackChangesInputCommand, typeof TrackChangesLink, typeof TrackChangesList, typeof TrackChangesListProperties, typeof TrackChangesMediaEmbed, typeof TrackChangesMention, typeof TrackChangesPageBreak, typeof TrackChangesParagraph, typeof TrackChangesRemoveFormat, typeof TrackChangesRestrictedEditingMode, typeof TrackChangesShiftEnterCommand, typeof TrackChangesStandardEditingMode, typeof TrackChangesStylesDropdown, typeof TrackChangesTable, typeof TrackChangesTableMergeSplit, typeof TrackChangesTableHeadings, typeof TrackChangesTableCaption, typeof TrackChangesTableClipboard, typeof TrackChangesTableColumnResize, typeof TrackChangesTableOfContents, typeof TrackChangesTableProperties, typeof TrackChangesTemplate, typeof TrackChangesTitle, typeof TrackChangesUndo];
     static get pluginName(): "TrackChangesEditing";
     /**
      * @inheritDoc
@@ -438,6 +441,43 @@ export default class TrackChangesEditing extends Plugin {
      * @returns Suggestion created or expanded as a result of execution of this method.
      */
     markMultiRangeDeletion(ranges: Array<Range>, subType?: string, attributes?: Record<string, unknown>): Suggestion | null;
+    /**
+     * Marks a single-range attribute suggestion on the given `range`.
+     *
+     * Note: all nodes in the given `range` must have the same current value of `key` attribute.
+     *
+     * Note: if a block attribute is marked, `range` should include only a single model element.
+     *
+     * `attributes` is a required value and must include `groupId: string` property. The group id is used to group attribute suggestions
+     * together. All suggestions with the same `groupId` will be put into one suggestion chain. By default, all attribute suggestions
+     * created during the same batch have the same `groupId`.
+     *
+     * It's possible that more than one suggestion will be created by this method if there are already suggestions with the same
+     * `key` but a different `oldValue` intersecting with the given `range`.
+     *
+     * It is guaranteed that there will be no "conflicting" suggestions, that is, there will be no two intersecting suggestions for
+     * the same attribute `key`. If there is a conflicting suggestion, it will be partially or fully replaced by a new suggestion.
+     *
+     * This method should be used in `callback()` in
+     * {@link module:track-changes/trackchangesediting~TrackChangesEditing#enableCommand `TrackChangesEditing#enableCommand`}
+     * to inform the track changes plugin about a suggestion that happened.
+     *
+     * Always call this method inside `model.change()` or `model.enqueueChange()` block to ensure that all operations performed by
+     * this method are bound with one undo step.
+     *
+     * See {@glink features/collaboration/track-changes/track-changes-custom-features Integrating track changes with custom
+     * features guide} to learn more about enabling your feature in the suggestion mode.
+     *
+     * @param range Range for which the attribute has changed.
+     * @param key Key of the attribute that changed.
+     * @param oldValue Previous value of the attribute.
+     * @param newValue New value of the attribute.
+     * @param attributes Suggestion attributes. Must include `groupId`.
+     */
+    markAttributeChange(range: Range, key: string, oldValue: unknown, newValue: unknown, attributes: {
+        groupId: string;
+        [key: string]: any;
+    }): Array<Suggestion>;
 }
 /**
  * Command parameters and additional suggestion parameters. Passed value is also saved in
@@ -465,3 +505,20 @@ export type FormatData = {
     multipleBlocks?: boolean;
     [i: string]: unknown;
 };
+/**
+ * Attribute suggestion parameters.
+ */
+export type AttributeData = {
+    /**
+     * Attribute key.
+     */
+    key: string;
+    /**
+     * Attribute's original value before the change happened.
+     */
+    oldValue: unknown;
+    /**
+     * Attribute's value after the change happened.
+     */
+    newValue: unknown;
+};