@ckeditor/ckeditor5-track-changes 39.0.1 → 40.0.0

package/src/trackchangesconfig.d.ts

@@ -1,75 +1,75 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module track-changes/trackchangesconfig
- * @publicApi
- */
-import type SuggestionThreadView from './ui/view/suggestionthreadview';
-/**
- * The configuration of the track changes feature.
- *
- * Example:
- *
- * ```ts
- *		ClassicEditor
- *			.create( {
- *				// Track changes feature configuration.
- *				trackChanges: {
- *					// Do not allow users to comment suggestions (default is `false`).
- *					disableComments: true,
- *					// Do not track styling and formatting changes (default is `default`).
- *					trackFormatChanges: 'never',
- *				    // Merges suggestion changes inside a block. (default is `true`).
- *					mergeNestedSuggestions: true
- *				}
- *			} )
- *			.then( ... )
- *			.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface TrackChangesConfig {
-    /**
-     * A property that specifies if the comments for suggestions are enabled or disabled.
-     * When the option is set to `true`, the comment thread UI for suggestions will be hidden
-     * and commenting suggestions will be disabled.
-     *
-     * Suggestion thread views will be marked with the additional `ck-suggestion--disabled-comments` class when the suggestion comments
-     * are disabled.
-     */
-    disableComments: boolean;
-    /**
-     * A property that specifies whether format changes should be tracked.
-     *
-     * Format changes are all changes other than insertions and deletions, including: styling, structure, widgets properties, etc.
-     *
-     * Possible values are:
-     *
-     * * `'always'` - all changes are going to be tracked independently (without merging).
-     * * `'default'` - format changes made inside your own insertion suggestion will be merged with it.
-     * * `'never'` - format changes will not be tracked.
-     *
-     * Defaults to `'default'`.
-     */
-    trackFormatChanges: 'never' | 'default' | 'always';
-    /**
-     * Specifies whether suggestions on an object (e.g. image, table) should be automatically merged
-     * with suggestions inside the object (e.g. image caption, table cell).
-     *
-     * For example, when set to `true`, creating a table and writing some text inside the table will result in one suggestion.
-     * When set to `false`, it will be two separate suggestions, one for the inserted table and one for the inserted text.
-     *
-     * Keep in mind that only suggestions from the same author and of the same type are merged this way.
-     */
-    mergeNestedSuggestions: boolean;
-    /**
-     * A view class to be used to create suggestion thread views.
-     *
-     * {@link module:track-changes/ui/view/suggestionthreadview~SuggestionThreadView} is used by default
-     *  when this property is not set.
-     */
-    SuggestionThreadView?: typeof SuggestionThreadView;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module track-changes/trackchangesconfig
+ * @publicApi
+ */
+import type SuggestionThreadView from './ui/view/suggestionthreadview';
+/**
+ * The configuration of the track changes feature.
+ *
+ * Example:
+ *
+ * ```ts
+ *		ClassicEditor
+ *			.create( {
+ *				// Track changes feature configuration.
+ *				trackChanges: {
+ *					// Do not allow users to comment suggestions (default is `false`).
+ *					disableComments: true,
+ *					// Do not track styling and formatting changes (default is `default`).
+ *					trackFormatChanges: 'never',
+ *				    // Merges suggestion changes inside a block. (default is `true`).
+ *					mergeNestedSuggestions: true
+ *				}
+ *			} )
+ *			.then( ... )
+ *			.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface TrackChangesConfig {
+    /**
+     * A property that specifies if the comments for suggestions are enabled or disabled.
+     * When the option is set to `true`, the comment thread UI for suggestions will be hidden
+     * and commenting suggestions will be disabled.
+     *
+     * Suggestion thread views will be marked with the additional `ck-suggestion--disabled-comments` class when the suggestion comments
+     * are disabled.
+     */
+    disableComments: boolean;
+    /**
+     * A property that specifies whether format changes should be tracked.
+     *
+     * Format changes are all changes other than insertions and deletions, including: styling, structure, widgets properties, etc.
+     *
+     * Possible values are:
+     *
+     * * `'always'` - all changes are going to be tracked independently (without merging).
+     * * `'default'` - format changes made inside your own insertion suggestion will be merged with it.
+     * * `'never'` - format changes will not be tracked.
+     *
+     * Defaults to `'default'`.
+     */
+    trackFormatChanges: 'never' | 'default' | 'always';
+    /**
+     * Specifies whether suggestions on an object (e.g. image, table) should be automatically merged
+     * with suggestions inside the object (e.g. image caption, table cell).
+     *
+     * For example, when set to `true`, creating a table and writing some text inside the table will result in one suggestion.
+     * When set to `false`, it will be two separate suggestions, one for the inserted table and one for the inserted text.
+     *
+     * Keep in mind that only suggestions from the same author and of the same type are merged this way.
+     */
+    mergeNestedSuggestions: boolean;
+    /**
+     * A view class to be used to create suggestion thread views.
+     *
+     * {@link module:track-changes/ui/view/suggestionthreadview~SuggestionThreadView} is used by default
+     *  when this property is not set.
+     */
+    SuggestionThreadView?: typeof SuggestionThreadView;
+}

package/src/trackchangesdata.d.ts

@@ -1,41 +1,41 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module track-changes/trackchangesdata
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core';
-import TrackChangesEditing from './trackchangesediting';
-/**
- * This plugin returns the editor data with accepted or discarded suggestions without modifying the editor content.
- */
-export default class TrackChangesData extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TrackChangesEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TrackChangesData";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Returns the editor data with all the suggestions accepted.
-     *
-     * @param options Options for {@link module:engine/controller/datacontroller~DataController#get}.
-     * @returns A promise which resolves with the output data.
-     */
-    getDataWithAcceptedSuggestions(options: Record<string, unknown>): Promise<string | Record<string, string>>;
-    /**
-     * Returns the editor data with all the suggestions discarded.
-     *
-     * @param options Options for {@link module:engine/controller/datacontroller~DataController#get}.
-     * @returns A promise which resolves with the output data.
-     */
-    getDataWithDiscardedSuggestions(options: Record<string, unknown>): Promise<string | Record<string, string>>;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module track-changes/trackchangesdata
+ * @publicApi
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import TrackChangesEditing from './trackchangesediting';
+/**
+ * This plugin returns the editor data with accepted or discarded suggestions without modifying the editor content.
+ */
+export default class TrackChangesData extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TrackChangesEditing];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TrackChangesData";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Returns the editor data with all the suggestions accepted.
+     *
+     * @param options Options for {@link module:engine/controller/datacontroller~DataController#get}.
+     * @returns A promise which resolves with the output data.
+     */
+    getDataWithAcceptedSuggestions(options: Record<string, unknown>): Promise<string | Record<string, string>>;
+    /**
+     * Returns the editor data with all the suggestions discarded.
+     *
+     * @param options Options for {@link module:engine/controller/datacontroller~DataController#get}.
+     * @returns A promise which resolves with the output data.
+     */
+    getDataWithDiscardedSuggestions(options: Record<string, unknown>): Promise<string | Record<string, string>>;
+}

package/src/trackchangesdata.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x2fff=['discardAllSuggestions','init','config','getRootNames','function','appendChild','addSuggestionData','model','getDataWithAcceptedSuggestions','users','Users','TrackChangesData','end','execute','track-changes-data-invalid-editor-creator','div','editorCreator','getSuggestions','editor','CommentsRepository','_adapter','getRootsAttributes','result','pluginName','name','define','data','createElement','map','trackChangesData.editorCreator','acceptAllSuggestions','get','TrackChangesEditing','reduce','createDocumentFragment','rootsAttributes','plugins','document','trackChangesData','getDataWithDiscardedSuggestions','Pagination','addUser','constructor','useAnonymousUser','create'];(function(_0x947522,_0x2fff63){const _0x5f0e7a=function(_0x1353dd){while(--_0x1353dd){_0x947522['push'](_0x947522['shift']());}};_0x5f0e7a(++_0x2fff63);}(_0x2fff,0x8a));const _0x5f0e=function(_0x947522,_0x2fff63){_0x947522=_0x947522-0x0;let _0x5f0e7a=_0x2fff[_0x947522];return _0x5f0e7a;};import{Plugin as _0x8c753b}from'ckeditor5/src/core';import{CKEditorError as _0x31772c}from'ckeditor5/src/utils';import _0x195396 from'./trackchangesediting';import{sanitizeEditorConfig as _0x4601b6}from'ckeditor5-collaboration/src/collaboration-core';const w=[_0x5f0e('0x25')];export default class T extends _0x8c753b{static get['requires'](){return[_0x195396];}static get[_0x5f0e('0x14')](){return _0x5f0e('0x8');}[_0x5f0e('0x2b')](){const _0x1ed47b=this[_0x5f0e('0xf')];if(_0x1ed47b[_0x5f0e('0x2c')][_0x5f0e('0x16')](_0x5f0e('0x1a'),_0x88ea4c=>{const _0x112004=_0x1ed47b[_0x5f0e('0x4')]['document']['getRootNames']()[_0x5f0e('0x1e')]((_0x237103,_0x50e9fa)=>(_0x237103[_0x50e9fa]='',_0x237103),{});return _0x1ed47b[_0x5f0e('0x27')][_0x5f0e('0x29')](_0x112004,_0x88ea4c);}),_0x5f0e('0x1')!=typeof _0x1ed47b[_0x5f0e('0x2c')][_0x5f0e('0x1c')]('trackChangesData')[_0x5f0e('0xd')])throw new _0x31772c(_0x5f0e('0xb'));}[_0x5f0e('0x5')](_0x5cc0e3){return v(this[_0x5f0e('0xf')],!0x0,_0x5cc0e3);}[_0x5f0e('0x24')](_0x5146a1){return v(this['editor'],!0x1,_0x5146a1);}}class P extends _0x8c753b{static get['pluginName'](){return'TrackChangesDataGetter';}constructor(_0x4bef33){super(_0x4bef33),this[_0x5f0e('0x13')]=_0x5f0e('0x9');}[_0x5f0e('0x2b')](){this[_0x5f0e('0xf')]['plugins'][_0x5f0e('0x1c')](_0x5f0e('0x10'))[_0x5f0e('0x11')]={'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[_0x5f0e('0xf')]['plugins'][_0x5f0e('0x1c')](_0x5f0e('0x1d'))[_0x5f0e('0x11')]=null;}}function D(_0xc7eb02){return void 0x0!==_0xc7eb02[_0x5f0e('0x12')];}async function v(_0x1e2659,_0x212da0,_0x367038){const _0x359d8a=_0x4601b6(_0x1e2659,w);_0x359d8a['plugins']['push'](_0x195396,P),_0x359d8a[_0x5f0e('0x20')]=D(_0x1e2659)?_0x1e2659[_0x5f0e('0x12')]():void 0x0;const _0x21cfa9=document[_0x5f0e('0x1f')](),_0x103820=_0x1e2659[_0x5f0e('0x2c')][_0x5f0e('0x1c')](_0x5f0e('0x23'))['editorCreator'],_0x1fe448=await _0x103820(_0x359d8a,()=>function(_0x20d495){const _0x10a9e2=document[_0x5f0e('0x18')](_0x5f0e('0xc'));return _0x20d495[_0x5f0e('0x2')](_0x10a9e2),_0x10a9e2;}(_0x21cfa9));!function(_0x4d2f2a,_0x54382a){const _0x553bc3=_0x4d2f2a['model'][_0x5f0e('0x22')][_0x5f0e('0x0')]()[_0x5f0e('0x1e')]((_0x3b0bc2,_0x349b70)=>(_0x3b0bc2[_0x349b70]=_0x4d2f2a[_0x5f0e('0x17')][_0x5f0e('0x1c')]({'rootName':_0x349b70}),_0x3b0bc2),{}),_0x106f79=_0x4d2f2a[_0x5f0e('0x21')][_0x5f0e('0x1c')](_0x5f0e('0x7'))[_0x5f0e('0x6')][_0x5f0e('0x19')](_0x2f50bd=>({'id':_0x2f50bd['id'],'name':_0x2f50bd[_0x5f0e('0x15')]})),_0x359907=_0x4d2f2a['plugins'][_0x5f0e('0x1c')]('TrackChangesEditing')[_0x5f0e('0xe')]({'skipNotAttached':!0x0,'toJSON':!0x0}),_0x45126c=_0x54382a[_0x5f0e('0x21')][_0x5f0e('0x1c')](_0x5f0e('0x7')),_0x1c428e=_0x54382a['plugins']['get'](_0x5f0e('0x1d'));for(const _0x51f7bd of _0x106f79)_0x45126c['getUser'](_0x51f7bd['id'])||_0x45126c[_0x5f0e('0x26')](_0x51f7bd);_0x45126c['me']||_0x45126c[_0x5f0e('0x28')]();for(const _0x47d6d4 of _0x359907)_0x1c428e[_0x5f0e('0x3')](_0x47d6d4);_0x54382a[_0x5f0e('0x17')]['set'](_0x553bc3);}(_0x1e2659,_0x1fe448),_0x1fe448[_0x5f0e('0xa')](_0x212da0?_0x5f0e('0x1b'):_0x5f0e('0x2a'));const _0x5b6e93=D(_0x1fe448)?_0x1fe448['getFullData'](_0x367038):_0x1fe448[_0x5f0e('0x17')][_0x5f0e('0x1c')](_0x367038);return await _0x1fe448['destroy'](),_0x5b6e93;}
+const _0x1639=['getDataWithDiscardedSuggestions','getRootsAttributes','users','constructor','editorCreator','set','pluginName','get','getRootNames','div','data','discardAllSuggestions','map','appendChild','document','CommentsRepository','plugins','model','editor','end','_adapter','define','Pagination','getSuggestions','acceptAllSuggestions','reduce','TrackChangesEditing','name','create','createDocumentFragment','getFullData','TrackChangesDataGetter','Users','requires','addSuggestionData','push','trackChangesData','getUser','rootsAttributes','config','destroy','init','getDataWithAcceptedSuggestions','useAnonymousUser','trackChangesData.editorCreator','function','execute','createElement'];(function(_0x13ee9d,_0x163993){const _0x57cb1f=function(_0x17f1f0){while(--_0x17f1f0){_0x13ee9d['push'](_0x13ee9d['shift']());}};_0x57cb1f(++_0x163993);}(_0x1639,0xb7));const _0x57cb=function(_0x13ee9d,_0x163993){_0x13ee9d=_0x13ee9d-0x0;let _0x57cb1f=_0x1639[_0x13ee9d];return _0x57cb1f;};import{Plugin as _0x5427d1}from'ckeditor5/src/core';import{CKEditorError as _0xba42cb}from'ckeditor5/src/utils';import _0x4f5e4e from'./trackchangesediting';import{sanitizeEditorConfig as _0x47bdcc}from'ckeditor5-collaboration/src/collaboration-core';const w=[_0x57cb('0x1f')];export default class T extends _0x5427d1{static get[_0x57cb('0x2a')](){return[_0x4f5e4e];}static get[_0x57cb('0xf')](){return'TrackChangesData';}['init'](){const _0x47ec15=this[_0x57cb('0x1b')];if(_0x47ec15['config'][_0x57cb('0x1e')](_0x57cb('0x5'),_0x42ddae=>{const _0x466dad=_0x47ec15[_0x57cb('0x1a')][_0x57cb('0x17')][_0x57cb('0x11')]()[_0x57cb('0x22')]((_0x30c50b,_0x1f2bd5)=>(_0x30c50b[_0x1f2bd5]='',_0x30c50b),{});return _0x47ec15[_0x57cb('0xc')][_0x57cb('0x25')](_0x466dad,_0x42ddae);}),_0x57cb('0x6')!=typeof _0x47ec15['config'][_0x57cb('0x10')](_0x57cb('0x2d'))['editorCreator'])throw new _0xba42cb('track-changes-data-invalid-editor-creator');}[_0x57cb('0x3')](_0x442a91){return v(this['editor'],!0x0,_0x442a91);}[_0x57cb('0x9')](_0x5803e6){return v(this[_0x57cb('0x1b')],!0x1,_0x5803e6);}}class P extends _0x5427d1{static get['pluginName'](){return _0x57cb('0x28');}constructor(_0x5d7d51){super(_0x5d7d51),this['result']=_0x57cb('0x1c');}[_0x57cb('0x2')](){this[_0x57cb('0x1b')][_0x57cb('0x19')]['get'](_0x57cb('0x18'))[_0x57cb('0x1d')]={'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[_0x57cb('0x1b')][_0x57cb('0x19')][_0x57cb('0x10')](_0x57cb('0x23'))[_0x57cb('0x1d')]=null;}}function D(_0x56a4e9){return void 0x0!==_0x56a4e9[_0x57cb('0xa')];}async function v(_0x237c64,_0x5bd37b,_0x351640){const _0x2086b7=_0x47bdcc(_0x237c64,w);_0x2086b7['plugins'][_0x57cb('0x2c')](_0x4f5e4e,P),_0x2086b7[_0x57cb('0x2f')]=D(_0x237c64)?_0x237c64[_0x57cb('0xa')]():void 0x0;const _0x165506=document[_0x57cb('0x26')](),_0x100257=_0x237c64[_0x57cb('0x0')]['get'](_0x57cb('0x2d'))[_0x57cb('0xd')],_0x522a5f=await _0x100257(_0x2086b7,()=>function(_0x539c8d){const _0x55daed=document[_0x57cb('0x8')](_0x57cb('0x12'));return _0x539c8d[_0x57cb('0x16')](_0x55daed),_0x55daed;}(_0x165506));!function(_0x10e394,_0x1b974b){const _0x47dc25=_0x10e394[_0x57cb('0x1a')][_0x57cb('0x17')]['getRootNames']()[_0x57cb('0x22')]((_0x478019,_0xdfeb61)=>(_0x478019[_0xdfeb61]=_0x10e394[_0x57cb('0x13')]['get']({'rootName':_0xdfeb61}),_0x478019),{}),_0x387a00=_0x10e394[_0x57cb('0x19')]['get'](_0x57cb('0x29'))[_0x57cb('0xb')][_0x57cb('0x15')](_0x33ac1c=>({'id':_0x33ac1c['id'],'name':_0x33ac1c[_0x57cb('0x24')]})),_0x5e3b33=_0x10e394[_0x57cb('0x19')][_0x57cb('0x10')](_0x57cb('0x23'))[_0x57cb('0x20')]({'skipNotAttached':!0x0,'toJSON':!0x0}),_0x347983=_0x1b974b[_0x57cb('0x19')][_0x57cb('0x10')](_0x57cb('0x29')),_0x271b74=_0x1b974b[_0x57cb('0x19')][_0x57cb('0x10')](_0x57cb('0x23'));for(const _0x40e9be of _0x387a00)_0x347983[_0x57cb('0x2e')](_0x40e9be['id'])||_0x347983['addUser'](_0x40e9be);_0x347983['me']||_0x347983[_0x57cb('0x4')]();for(const _0x438099 of _0x5e3b33)_0x271b74[_0x57cb('0x2b')](_0x438099);_0x1b974b[_0x57cb('0x13')][_0x57cb('0xe')](_0x47dc25);}(_0x237c64,_0x522a5f),_0x522a5f[_0x57cb('0x7')](_0x5bd37b?_0x57cb('0x21'):_0x57cb('0x14'));const _0x2b916b=D(_0x522a5f)?_0x522a5f[_0x57cb('0x27')](_0x351640):_0x522a5f[_0x57cb('0x13')]['get'](_0x351640);return await _0x522a5f[_0x57cb('0x1')](),_0x2b916b;}