@ckeditor/ckeditor5-track-changes 39.0.1 → 40.0.0

package/src/trackchanges.d.ts

@@ -1,244 +1,244 @@
-/**
- * @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/trackchanges
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core';
-import TrackChangesUI from './trackchangesui';
-import TrackChangesEditing from './trackchangesediting';
-import 'ckeditor5-collaboration/src/collaboration-core';
-import type { default as Suggestion, SuggestionJSON } from './suggestion';
-import type SuggestionThreadView from './ui/view/suggestionthreadview';
-/**
- * A plugin that provides track changes mode for the editor. In track changes mode, all insertions are visually marked and all deletions
- * are not deleted but also visually marked. Unsupported commands are disabled when the editor is in the track changes mode.
- *
- * To learn how to integrate the track changes feature with your editor, refer to the
- * {@glink features/collaboration/track-changes/track-changes-integration Track changes integration} guide.
- *
- * Basic API:
- *
- * ```ts
- * // Get the track changes plugin:
- * const trackChangesPlugin = editor.plugins.get( 'TrackChanges' );
- *
- * // Add a suggestion:
- * trackChangesPlugin.addSuggestion( suggestionData );
- *
- * // Get all suggestions:
- * trackChangesPlugin.getSuggestions();
- *
- * // Set the adapter:
- * trackChangesPlugin.adapter = {
- * 		// ...
- * }
- * ```
- *
- * The plugin registers several commands:
- *
- * * `trackChanges` – Toggles the track changes mode in the editor.
- * * `acceptSuggestion` – Accepts a suggestion with the specified ID.
- * * `discardSuggestion` – Discards a suggestion with the specified ID.
- * * `acceptAllSuggestions` – Accepts all suggestions.
- * * `discardAllSuggestions` – Discards all suggestions.
- * * `acceptSelectedSuggestions` – Accepts all suggestions in the current selection.
- * * `discardSelectedSuggestions` – Discards all suggestions in the current selection.
- *
- * Examples:
- *
- * ```ts
- * editor.execute( 'trackChanges' );
- * editor.execute( 'acceptSuggestion', 'suggestion-1' );
- * editor.execute( 'discardSuggestion', 'suggestion-1' );
- * editor.execute( 'acceptAllSuggestions' );
- * editor.execute( 'discardAllSuggestions' );
- * editor.execute( 'acceptSelectedSuggestions' );
- * editor.execute( 'discardSelectedSuggestions' )
- * ```
- *
- * Note that there is no command to add a suggestion. This is because suggestions
- * are added automatically when editing commands are executed while the editor is in track
- * changes mode. For instance:
- *
- * ```ts
- * // Turn on the track changes mode:
- * editor.execute( 'trackChanges' );
- *
- * // Insert some text. It will be automatically inserted as a suggestion:
- * editor.execute( 'input', { text: 'foo' } );
- * ```
- */
-export default class TrackChanges extends Plugin {
-    static get requires(): readonly [typeof TrackChangesEditing, typeof TrackChangesUI, "Comments"];
-    static get pluginName(): "TrackChanges";
-    /**
-     * An adapter object that should communicate with the data source to fetch or save the suggestion data.
-     *
-     * This is a shorthand to {@link module:track-changes/trackchangesediting~TrackChangesEditing#adapter `TrackChangesEditing#adapter`}.
-     */
-    set adapter(adapter: TrackChangesAdapter | null);
-    get adapter(): TrackChangesAdapter | null;
-    /**
-     * Adds suggestion data.
-     *
-     * Use this method to load the suggestion data during the editor initialization if you do not use the adapter integration.
-     */
-    addSuggestion(suggestionData: SuggestionData): Suggestion;
-    getSuggestions(options: {
-        skipNotAttached?: boolean;
-        toJSON: true;
-    }): Array<SuggestionJSON>;
-    getSuggestions(options?: {
-        skipNotAttached?: boolean;
-        toJSON?: false;
-    }): Array<Suggestion>;
-    getSuggestions(options: {
-        skipNotAttached?: boolean;
-        toJSON: boolean;
-    }): Array<Suggestion> | Array<SuggestionJSON>;
-    /**
-     * Returns the suggestion instance for a given ID.
-     */
-    getSuggestion(id: string): Suggestion;
-}
-/**
- * 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;
-}
-/**
- * Track changes adapter.
- *
- * The track changes adapter is an object that communicates asynchronously with the data source to fetch or save the suggestion data.
- * It is used internally by the track changes feature whenever a suggestion is loaded, created or deleted.
- *
- * The adapter is optional. You might need to provide it if you are {@glink features/collaboration/track-changes/track-changes-integration}
- * using the track changes feature without real-time collaboration.
- *
- * To set the adapter, overwrite {@link module:track-changes/trackchanges~TrackChanges#adapter the `TrackChanges#adapter` property}.
- */
-export interface TrackChangesAdapter {
-    /**
-     * Called each time the suggestion data is needed.
-     *
-     * The method should return a promise that resolves with the suggestion data object.
-     *
-     * @param id The ID of the suggestion to get.
-     */
-    getSuggestion(id: string): Promise<SuggestionData>;
-    /**
-     * Called each time a new suggestion is created.
-     *
-     * The method should save the suggestion data in the database
-     * and return a promise that should be resolved when the save is
-     * completed.
-     *
-     * If the promise resolves with an object with the `createdAt` property,
-     * this suggestion property will be updated in the suggestion in the editor.
-     * This lets you update the suggestion data with server-side information.
-     *
-     * The `suggestionData` object does not expect the `authorId` property.
-     * For security reasons, the author of the suggestion should be set
-     * on the server side.
-     *
-     * If `suggestionData.originalSuggestionId` is set, the new suggestion should
-     * have the `authorId` property set to the same as the suggestion with
-     * `originalSuggestionId`. This happens when one user splits
-     * another user's suggestion, creating a new suggestion as a result. See
-     * {@glink features/collaboration/track-changes/track-changes-integration#implementation Track changes integration} guide.
-     *
-     * **Note:** Failure to properly handle this property will result in editor crash in some scenarios.
-     *
-     * In any other case, use the current (local) user to set `authorId`.
-     *
-     * The `suggestionData` object does not expect the `createdAt` property either.
-     * You should use the server-side time generator to ensure that all users
-     * see the same date.
-     *
-     * It is recommended to stringify `suggestionData.attributes` value to JSON and save it as a string in your database,
-     * and then to parse the strings when loading suggestions.
-     */
-    addSuggestion(suggestionData: AddSuggestionInput): Promise<SuggestionData>;
-    /**
-     * Called each time the suggestion properties change.
-     *
-     * The method should update the suggestion properties in the database
-     * and return a promise that should be resolved when the save is
-     * completed.
-     *
-     * Keep in mind that the `data` parameter only contains those
-     * properties of a suggestion which changed.
-     */
-    updateSuggestion(id: string, suggestionData: UpdateSuggestionInput): Promise<void>;
-}
-export type SuggestionData = SuggestionJSON & {
-    originalSuggestionId?: string | null;
-};
-export type AddSuggestionInput = Omit<SuggestionData, 'authorId' | 'createdAt'>;
-export type UpdateSuggestionInput = Partial<Pick<SuggestionJSON, 'hasComments' | 'attributes'>> & {
-    state?: 'open' | 'accepted' | 'rejected';
-};
+/**
+ * @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/trackchanges
+ * @publicApi
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import TrackChangesUI from './trackchangesui';
+import TrackChangesEditing from './trackchangesediting';
+import 'ckeditor5-collaboration/src/collaboration-core';
+import type { default as Suggestion, SuggestionJSON } from './suggestion';
+import type SuggestionThreadView from './ui/view/suggestionthreadview';
+/**
+ * A plugin that provides track changes mode for the editor. In track changes mode, all insertions are visually marked and all deletions
+ * are not deleted but also visually marked. Unsupported commands are disabled when the editor is in the track changes mode.
+ *
+ * To learn how to integrate the track changes feature with your editor, refer to the
+ * {@glink features/collaboration/track-changes/track-changes-integration Track changes integration} guide.
+ *
+ * Basic API:
+ *
+ * ```ts
+ * // Get the track changes plugin:
+ * const trackChangesPlugin = editor.plugins.get( 'TrackChanges' );
+ *
+ * // Add a suggestion:
+ * trackChangesPlugin.addSuggestion( suggestionData );
+ *
+ * // Get all suggestions:
+ * trackChangesPlugin.getSuggestions();
+ *
+ * // Set the adapter:
+ * trackChangesPlugin.adapter = {
+ * 		// ...
+ * }
+ * ```
+ *
+ * The plugin registers several commands:
+ *
+ * * `trackChanges` &ndash; Toggles the track changes mode in the editor.
+ * * `acceptSuggestion` &ndash; Accepts a suggestion with the specified ID.
+ * * `discardSuggestion` &ndash; Discards a suggestion with the specified ID.
+ * * `acceptAllSuggestions` &ndash; Accepts all suggestions.
+ * * `discardAllSuggestions` &ndash; Discards all suggestions.
+ * * `acceptSelectedSuggestions` &ndash; Accepts all suggestions in the current selection.
+ * * `discardSelectedSuggestions` &ndash; Discards all suggestions in the current selection.
+ *
+ * Examples:
+ *
+ * ```ts
+ * editor.execute( 'trackChanges' );
+ * editor.execute( 'acceptSuggestion', 'suggestion-1' );
+ * editor.execute( 'discardSuggestion', 'suggestion-1' );
+ * editor.execute( 'acceptAllSuggestions' );
+ * editor.execute( 'discardAllSuggestions' );
+ * editor.execute( 'acceptSelectedSuggestions' );
+ * editor.execute( 'discardSelectedSuggestions' )
+ * ```
+ *
+ * Note that there is no command to add a suggestion. This is because suggestions
+ * are added automatically when editing commands are executed while the editor is in track
+ * changes mode. For instance:
+ *
+ * ```ts
+ * // Turn on the track changes mode:
+ * editor.execute( 'trackChanges' );
+ *
+ * // Insert some text. It will be automatically inserted as a suggestion:
+ * editor.execute( 'input', { text: 'foo' } );
+ * ```
+ */
+export default class TrackChanges extends Plugin {
+    static get requires(): readonly [typeof TrackChangesEditing, typeof TrackChangesUI, "Comments"];
+    static get pluginName(): "TrackChanges";
+    /**
+     * An adapter object that should communicate with the data source to fetch or save the suggestion data.
+     *
+     * This is a shorthand to {@link module:track-changes/trackchangesediting~TrackChangesEditing#adapter `TrackChangesEditing#adapter`}.
+     */
+    set adapter(adapter: TrackChangesAdapter | null);
+    get adapter(): TrackChangesAdapter | null;
+    /**
+     * Adds suggestion data.
+     *
+     * Use this method to load the suggestion data during the editor initialization if you do not use the adapter integration.
+     */
+    addSuggestion(suggestionData: SuggestionData): Suggestion;
+    getSuggestions(options: {
+        skipNotAttached?: boolean;
+        toJSON: true;
+    }): Array<SuggestionJSON>;
+    getSuggestions(options?: {
+        skipNotAttached?: boolean;
+        toJSON?: false;
+    }): Array<Suggestion>;
+    getSuggestions(options: {
+        skipNotAttached?: boolean;
+        toJSON: boolean;
+    }): Array<Suggestion> | Array<SuggestionJSON>;
+    /**
+     * Returns the suggestion instance for a given ID.
+     */
+    getSuggestion(id: string): Suggestion;
+}
+/**
+ * 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;
+}
+/**
+ * Track changes adapter.
+ *
+ * The track changes adapter is an object that communicates asynchronously with the data source to fetch or save the suggestion data.
+ * It is used internally by the track changes feature whenever a suggestion is loaded, created or deleted.
+ *
+ * The adapter is optional. You might need to provide it if you are {@glink features/collaboration/track-changes/track-changes-integration}
+ * using the track changes feature without real-time collaboration.
+ *
+ * To set the adapter, overwrite {@link module:track-changes/trackchanges~TrackChanges#adapter the `TrackChanges#adapter` property}.
+ */
+export interface TrackChangesAdapter {
+    /**
+     * Called each time the suggestion data is needed.
+     *
+     * The method should return a promise that resolves with the suggestion data object.
+     *
+     * @param id The ID of the suggestion to get.
+     */
+    getSuggestion(id: string): Promise<SuggestionData>;
+    /**
+     * Called each time a new suggestion is created.
+     *
+     * The method should save the suggestion data in the database
+     * and return a promise that should be resolved when the save is
+     * completed.
+     *
+     * If the promise resolves with an object with the `createdAt` property,
+     * this suggestion property will be updated in the suggestion in the editor.
+     * This lets you update the suggestion data with server-side information.
+     *
+     * The `suggestionData` object does not expect the `authorId` property.
+     * For security reasons, the author of the suggestion should be set
+     * on the server side.
+     *
+     * If `suggestionData.originalSuggestionId` is set, the new suggestion should
+     * have the `authorId` property set to the same as the suggestion with
+     * `originalSuggestionId`. This happens when one user splits
+     * another user's suggestion, creating a new suggestion as a result. See
+     * {@glink features/collaboration/track-changes/track-changes-integration#implementation Track changes integration} guide.
+     *
+     * **Note:** Failure to properly handle this property will result in editor crash in some scenarios.
+     *
+     * In any other case, use the current (local) user to set `authorId`.
+     *
+     * The `suggestionData` object does not expect the `createdAt` property either.
+     * You should use the server-side time generator to ensure that all users
+     * see the same date.
+     *
+     * It is recommended to stringify `suggestionData.attributes` value to JSON and save it as a string in your database,
+     * and then to parse the strings when loading suggestions.
+     */
+    addSuggestion(suggestionData: AddSuggestionInput): Promise<SuggestionData>;
+    /**
+     * Called each time the suggestion properties change.
+     *
+     * The method should update the suggestion properties in the database
+     * and return a promise that should be resolved when the save is
+     * completed.
+     *
+     * Keep in mind that the `data` parameter only contains those
+     * properties of a suggestion which changed.
+     */
+    updateSuggestion(id: string, suggestionData: UpdateSuggestionInput): Promise<void>;
+}
+export type SuggestionData = SuggestionJSON & {
+    originalSuggestionId?: string | null;
+};
+export type AddSuggestionInput = Omit<SuggestionData, 'authorId' | 'createdAt'>;
+export type UpdateSuggestionInput = Partial<Pick<SuggestionJSON, 'hasComments' | 'attributes'>> & {
+    state?: 'open' | 'accepted' | 'rejected';
+};

package/src/trackchanges.js

@@ -20,4 +20,4 @@
  *
  *
  */
-var _0x4b97=['get','pluginName','editor','adapter','addSuggestion','getSuggestions','getSuggestion','plugins','Comments'];(function(_0x486aeb,_0x4b975e){var _0x173b99=function(_0x57374c){while(--_0x57374c){_0x486aeb['push'](_0x486aeb['shift']());}};_0x173b99(++_0x4b975e);}(_0x4b97,0x194));var _0x173b=function(_0x486aeb,_0x4b975e){_0x486aeb=_0x486aeb-0x0;var _0x173b99=_0x4b97[_0x486aeb];return _0x173b99;};import{Plugin as _0x128501}from'ckeditor5/src/core';import _0x386ba3 from'./trackchangesui';import _0x5e1272 from'./trackchangesediting';import'ckeditor5-collaboration/src/collaboration-core';export default class k extends _0x128501{static get['requires'](){return[_0x5e1272,_0x386ba3,_0x173b('0x0')];}static get[_0x173b('0x2')](){return'TrackChanges';}set['adapter'](_0x4825aa){this[_0x173b('0x3')]['plugins']['get'](_0x5e1272)[_0x173b('0x4')]=_0x4825aa;}get[_0x173b('0x4')](){return this['editor']['plugins'][_0x173b('0x1')](_0x5e1272)['adapter'];}[_0x173b('0x5')](_0xe7c402){return this[_0x173b('0x3')]['plugins'][_0x173b('0x1')](_0x5e1272)['addSuggestionData'](_0xe7c402);}[_0x173b('0x6')]({skipNotAttached:_0x5b6bbf=!0x1,toJSON:_0x5a03ea=!0x1}={}){return this[_0x173b('0x3')][_0x173b('0x8')][_0x173b('0x1')](_0x5e1272)[_0x173b('0x6')]({'skipNotAttached':_0x5b6bbf,'toJSON':_0x5a03ea});}['getSuggestion'](_0x4ca603){return this['editor'][_0x173b('0x8')][_0x173b('0x1')](_0x5e1272)[_0x173b('0x7')](_0x4ca603);}}
+var _0x12bf=['plugins','adapter','TrackChanges','addSuggestion','get','pluginName','Comments','getSuggestions','addSuggestionData','editor','getSuggestion'];(function(_0x3f2f9d,_0x12bfb0){var _0x161a13=function(_0x369cc1){while(--_0x369cc1){_0x3f2f9d['push'](_0x3f2f9d['shift']());}};_0x161a13(++_0x12bfb0);}(_0x12bf,0x16d));var _0x161a=function(_0x3f2f9d,_0x12bfb0){_0x3f2f9d=_0x3f2f9d-0x0;var _0x161a13=_0x12bf[_0x3f2f9d];return _0x161a13;};import{Plugin as _0xe9c300}from'ckeditor5/src/core';import _0x289221 from'./trackchangesui';import _0x3d300f from'./trackchangesediting';import'ckeditor5-collaboration/src/collaboration-core';export default class k extends _0xe9c300{static get['requires'](){return[_0x3d300f,_0x289221,_0x161a('0x4')];}static get[_0x161a('0x3')](){return _0x161a('0x0');}set['adapter'](_0x2427ba){this[_0x161a('0x7')][_0x161a('0x9')]['get'](_0x3d300f)[_0x161a('0xa')]=_0x2427ba;}get[_0x161a('0xa')](){return this[_0x161a('0x7')][_0x161a('0x9')][_0x161a('0x2')](_0x3d300f)[_0x161a('0xa')];}[_0x161a('0x1')](_0x30292d){return this[_0x161a('0x7')][_0x161a('0x9')][_0x161a('0x2')](_0x3d300f)[_0x161a('0x6')](_0x30292d);}[_0x161a('0x5')]({skipNotAttached:_0x549aca=!0x1,toJSON:_0x441144=!0x1}={}){return this[_0x161a('0x7')][_0x161a('0x9')][_0x161a('0x2')](_0x3d300f)['getSuggestions']({'skipNotAttached':_0x549aca,'toJSON':_0x441144});}[_0x161a('0x8')](_0x1dd5f2){return this[_0x161a('0x7')][_0x161a('0x9')]['get'](_0x3d300f)[_0x161a('0x8')](_0x1dd5f2);}}