@ckeditor/ckeditor5-track-changes 45.2.1 → 46.0.0-alpha.0

package/src/trackchangesediting.d.ts

@@ -7,72 +7,72 @@
  * @publicApi
  */
 import { Plugin, PendingActions, type Editor } from 'ckeditor5/src/core.js';
-import { type Element, type Range } from 'ckeditor5/src/engine.js';
+import { type ModelElement, type ModelRange } from 'ckeditor5/src/engine.js';
 import { Users } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import TrackChangesCommand from './commands/trackchangescommand.js';
-import Suggestion, { type SuggestionJSON } from './suggestion.js';
-import SuggestionDescriptionFactory from './suggestiondescriptionfactory.js';
-import TrackChangesAIAssistant from './integrations/aiassistant.js';
-import TrackChangesAlignment from './integrations/alignment.js';
-import TrackChangesBasicStyles from './integrations/basicstyles.js';
-import TrackChangesBlockQuote from './integrations/blockquote.js';
-import TrackChangesBookmark from './integrations/bookmark.js';
-import TrackChangesCaseChange from './integrations/casechange.js';
-import TrackChangesCKBox from './integrations/ckbox.js';
-import TrackChangesCodeBlock from './integrations/codeblock.js';
-import TrackChangesComments from './integrations/comments.js';
-import TrackChangesDeleteCommand from './integrations/deletecommand.js';
-import TrackChangesList from './integrations/list.js';
-import TrackChangesListProperties from './integrations/listproperties.js';
-import TrackChangesEmoji from './integrations/emoji.js';
-import TrackChangesEnterCommand from './integrations/entercommand.js';
-import TrackChangesFindAndReplace from './integrations/findandreplace.js';
-import TrackChangesFont from './integrations/font.js';
-import TrackChangesFormatPainter from './integrations/formatpainter.js';
-import TrackChangesHeading from './integrations/heading.js';
-import TrackChangesHighlight from './integrations/highlight.js';
-import TrackChangesHorizontalLine from './integrations/horizontalline.js';
-import TrackChangesHtmlEmbed from './integrations/htmlembed.js';
-import TrackChangesImage from './integrations/image.js';
-import TrackChangesImageReplace from './integrations/imagereplace.js';
-import TrackChangesImageStyle from './integrations/imagestyle.js';
-import TrackChangesImportWord from './integrations/importword.js';
-import TrackChangesIndent from './integrations/indent.js';
-import TrackChangesInputCommand from './integrations/inputcommand.js';
-import TrackChangesLink from './integrations/link.js';
-import TrackChangesLegacyList from './integrations/legacylist.js';
-import TrackChangesLegacyListProperties from './integrations/legacylistproperties.js';
-import TrackChangesMediaEmbed from './integrations/mediaembed.js';
-import TrackChangesMention from './integrations/mention.js';
-import TrackChangesMergeFields from './integrations/mergefields.js';
-import TrackChangesMultiLevelList from './integrations/multilevellist.js';
-import TrackChangesPageBreak from './integrations/pagebreak.js';
-import TrackChangesParagraph from './integrations/paragraph.js';
-import TrackChangesReplaceSourceCommand from './integrations/replacesourcecommand.js';
-import TrackChangesRemoveFormat from './integrations/removeformat.js';
-import TrackChangesRestrictedEditingMode from './integrations/restrictededitingmode.js';
-import TrackChangesShiftEnterCommand from './integrations/shiftentercommand.js';
-import TrackChangesStandardEditingMode from './integrations/standardeditingmode.js';
-import TrackChangesStylesDropdown from './integrations/style.js';
-import TrackChangesTable from './integrations/table.js';
-import TrackChangesTableMergeSplit from './integrations/tablemergesplit.js';
-import TrackChangesTableHeadings from './integrations/tableheadings.js';
-import TrackChangesTableLayout from './integrations/tablelayout.js';
-import TrackChangesTableClipboard from './integrations/tableclipboard.js';
-import TrackChangesTableColumnResize from './integrations/tablecolumnresize.js';
-import TrackChangesTemplate from './integrations/template.js';
-import TrackChangesTableOfContents from './integrations/tableofcontents.js';
-import TrackChangesTitle from './integrations/title.js';
-import TrackChangesUploadcare from './integrations/uploadcare.js';
-import TrackChangesUndo from './integrations/undo.js';
-import TrackChangesTableCaption from './integrations/tablecaption.js';
-import TrackChangesTableProperties from './integrations/tableproperties.js';
+import { TrackChangesCommand } from './commands/trackchangescommand.js';
+import { Suggestion, type SuggestionJSON } from './suggestion.js';
+import { SuggestionDescriptionFactory } from './suggestiondescriptionfactory.js';
+import { TrackChangesAIAssistant } from './integrations/aiassistant.js';
+import { TrackChangesAlignment } from './integrations/alignment.js';
+import { TrackChangesBasicStyles } from './integrations/basicstyles.js';
+import { TrackChangesBlockQuote } from './integrations/blockquote.js';
+import { TrackChangesBookmark } from './integrations/bookmark.js';
+import { TrackChangesCaseChange } from './integrations/casechange.js';
+import { TrackChangesCKBox } from './integrations/ckbox.js';
+import { TrackChangesCodeBlock } from './integrations/codeblock.js';
+import { TrackChangesComments } from './integrations/comments.js';
+import { TrackChangesDeleteCommand } from './integrations/deletecommand.js';
+import { TrackChangesList } from './integrations/list.js';
+import { TrackChangesDocumentListProperties } from './integrations/listproperties.js';
+import { TrackChangesEmoji } from './integrations/emoji.js';
+import { TrackChangesEnterCommand } from './integrations/entercommand.js';
+import { TrackChangesFindAndReplace } from './integrations/findandreplace.js';
+import { TrackChangesFont } from './integrations/font.js';
+import { TrackChangesFormatPainter } from './integrations/formatpainter.js';
+import { TrackChangesHeading } from './integrations/heading.js';
+import { TrackChangesHighlight } from './integrations/highlight.js';
+import { TrackChangesHorizontalLine } from './integrations/horizontalline.js';
+import { TrackChangesHtmlEmbed } from './integrations/htmlembed.js';
+import { TrackChangesImage } from './integrations/image.js';
+import { TrackChangesImageReplace } from './integrations/imagereplace.js';
+import { TrackChangesImageStyle } from './integrations/imagestyle.js';
+import { TrackChangesImportWord } from './integrations/importword.js';
+import { TrackChangesIndent } from './integrations/indent.js';
+import { TrackChangesInputCommand } from './integrations/inputcommand.js';
+import { TrackChangesLink } from './integrations/link.js';
+import { TrackChangesLegacyList } from './integrations/legacylist.js';
+import { TrackChangesLegacyListProperties } from './integrations/legacylistproperties.js';
+import { TrackChangesMediaEmbed } from './integrations/mediaembed.js';
+import { TrackChangesMention } from './integrations/mention.js';
+import { TrackChangesMergeFields } from './integrations/mergefields.js';
+import { TrackChangesMultiLevelList } from './integrations/multilevellist.js';
+import { TrackChangesPageBreak } from './integrations/pagebreak.js';
+import { TrackChangesParagraph } from './integrations/paragraph.js';
+import { TrackChangesReplaceSourceCommand } from './integrations/replacesourcecommand.js';
+import { TrackChangesRemoveFormat } from './integrations/removeformat.js';
+import { TrackChangesRestrictedEditingMode } from './integrations/restrictededitingmode.js';
+import { TrackChangesShiftEnterCommand } from './integrations/shiftentercommand.js';
+import { TrackChangesStandardEditingMode } from './integrations/standardeditingmode.js';
+import { TrackChangesStylesDropdown } from './integrations/style.js';
+import { TrackChangesTable } from './integrations/table.js';
+import { TrackChangesTableMergeSplit } from './integrations/tablemergesplit.js';
+import { TrackChangesTableHeadings } from './integrations/tableheadings.js';
+import { TrackChangesTableLayout } from './integrations/tablelayout.js';
+import { TrackChangesTableClipboard } from './integrations/tableclipboard.js';
+import { TrackChangesTableColumnResize } from './integrations/tablecolumnresize.js';
+import { TrackChangesTemplate } from './integrations/template.js';
+import { TrackChangesTableOfContents } from './integrations/tableofcontents.js';
+import { TrackChangesTitle } from './integrations/title.js';
+import { TrackChangesUploadcare } from './integrations/uploadcare.js';
+import { TrackChangesUndo } from './integrations/undo.js';
+import { TrackChangesTableCaption } from './integrations/tablecaption.js';
+import { TrackChangesTableProperties } from './integrations/tableproperties.js';
+import { TrackChangesLineHeight } from './integrations/lineheight.js';
 import type { SuggestionData, TrackChangesAdapter } from './trackchanges.js';
-export declare const renameAttributeKey = "$elementName";
 /**
  * Provides editing part of the {@link module:track-changes/trackchanges~TrackChanges track changes plugin}.
  */
-export default class TrackChangesEditing extends Plugin {
+export declare class TrackChangesEditing extends Plugin {
     /**
      * List of names of active (highlighted) markers.
      *
@@ -87,7 +87,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 TrackChangesAIAssistant, typeof TrackChangesAlignment, typeof TrackChangesBasicStyles, typeof TrackChangesBlockQuote, typeof TrackChangesBookmark, typeof TrackChangesCKBox, typeof TrackChangesCaseChange, typeof TrackChangesCodeBlock, typeof TrackChangesComments, typeof TrackChangesDeleteCommand, typeof TrackChangesEmoji, 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 TrackChangesLegacyList, typeof TrackChangesLegacyListProperties, typeof TrackChangesMultiLevelList, typeof TrackChangesLink, typeof TrackChangesList, typeof TrackChangesListProperties, typeof TrackChangesMediaEmbed, typeof TrackChangesMention, typeof TrackChangesMergeFields, typeof TrackChangesPageBreak, typeof TrackChangesParagraph, typeof TrackChangesReplaceSourceCommand, typeof TrackChangesRemoveFormat, typeof TrackChangesRestrictedEditingMode, typeof TrackChangesShiftEnterCommand, typeof TrackChangesStandardEditingMode, typeof TrackChangesStylesDropdown, typeof TrackChangesTable, typeof TrackChangesTableMergeSplit, typeof TrackChangesTableHeadings, typeof TrackChangesTableLayout, typeof TrackChangesTableCaption, typeof TrackChangesTableClipboard, typeof TrackChangesTableColumnResize, typeof TrackChangesTableOfContents, typeof TrackChangesTableProperties, typeof TrackChangesTemplate, typeof TrackChangesTitle, typeof TrackChangesUploadcare, typeof TrackChangesUndo];
+    static get requires(): readonly ["CommentsRepository", typeof Users, typeof PendingActions, typeof TrackChangesAIAssistant, typeof TrackChangesAlignment, typeof TrackChangesBasicStyles, typeof TrackChangesBlockQuote, typeof TrackChangesBookmark, typeof TrackChangesCKBox, typeof TrackChangesCaseChange, typeof TrackChangesCodeBlock, typeof TrackChangesComments, typeof TrackChangesDeleteCommand, typeof TrackChangesEmoji, 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 TrackChangesLegacyList, typeof TrackChangesLegacyListProperties, typeof TrackChangesMultiLevelList, typeof TrackChangesLink, typeof TrackChangesList, typeof TrackChangesLineHeight, typeof TrackChangesDocumentListProperties, typeof TrackChangesMediaEmbed, typeof TrackChangesMention, typeof TrackChangesMergeFields, typeof TrackChangesPageBreak, typeof TrackChangesParagraph, typeof TrackChangesReplaceSourceCommand, typeof TrackChangesRemoveFormat, typeof TrackChangesRestrictedEditingMode, typeof TrackChangesShiftEnterCommand, typeof TrackChangesStandardEditingMode, typeof TrackChangesStylesDropdown, typeof TrackChangesTable, typeof TrackChangesTableMergeSplit, typeof TrackChangesTableHeadings, typeof TrackChangesTableLayout, typeof TrackChangesTableCaption, typeof TrackChangesTableClipboard, typeof TrackChangesTableColumnResize, typeof TrackChangesTableOfContents, typeof TrackChangesTableProperties, typeof TrackChangesTemplate, typeof TrackChangesTitle, typeof TrackChangesUploadcare, typeof TrackChangesUndo];
     static get pluginName(): "TrackChangesEditing";
     /**
      * @inheritDoc
@@ -201,7 +201,7 @@ export default class TrackChangesEditing extends Plugin {
      * @returns Suggestion created or expanded as a result of execution of this
      * method. Returns `null` if given `range` was collapsed (so no suggestion was created or expanded).
      */
-    markInsertion(range: Range, subType?: string | null, attributes?: Record<string, unknown>): Suggestion | null;
+    markInsertion(range: ModelRange, subType?: string | null, attributes?: Record<string, unknown>): Suggestion | null;
     /**
      * Marks a multi-range insertion suggestion spanning over given `ranges`.
      *
@@ -234,7 +234,7 @@ export default class TrackChangesEditing extends Plugin {
      * @param attributes Custom suggestion attributes.
      * @returns {module:track-changes/suggestion~Suggestion} Suggestion created or expanded as a result of execution of this method.
      */
-    markMultiRangeInsertion(ranges: Array<Range>, subType?: string, attributes?: Record<string, unknown>): Suggestion;
+    markMultiRangeInsertion(ranges: Array<ModelRange>, subType?: string, attributes?: Record<string, unknown>): Suggestion;
     /**
      * Marks an inline format suggestion on the given `range`.
      *
@@ -278,7 +278,7 @@ export default class TrackChangesEditing extends Plugin {
      * all inline format suggestions that perform the same changes have the same sub type (and can be properly handled).
      * @param attributes Custom suggestion attributes.
      */
-    markInlineFormat(range: Range, formatData: FormatData, subType?: string | null, attributes?: Record<string, unknown>): null;
+    markInlineFormat(range: ModelRange, formatData: SuggestionFormatData, subType?: string | null, attributes?: Record<string, unknown>): null;
     /**
      * Marks a block format suggestion on the given `range`.
      *
@@ -358,7 +358,7 @@ export default class TrackChangesEditing extends Plugin {
      * all block format suggestions that perform the same changes have the same sub types (and can be properly handled).
      * @param attributes Custom suggestion attributes.
      */
-    markBlockFormat(elementOrRange: Element | Range, formatData: FormatData, affectedElements?: Array<Element>, subType?: string | null, attributes?: Record<string, unknown>): Suggestion | null;
+    markBlockFormat(elementOrRange: ModelElement | ModelRange, formatData: SuggestionFormatData, affectedElements?: Array<ModelElement>, subType?: string | null, attributes?: Record<string, unknown>): Suggestion | null;
     /**
      * Marks a multi-range block format suggestion on given `elements`.
      *
@@ -398,7 +398,7 @@ export default class TrackChangesEditing extends Plugin {
      * all block format suggestions that perform the same changes have the same sub types (and can be properly handled).
      * @param attributes Custom suggestion attributes.
      */
-    markMultiRangeBlockFormat(elementsOrRanges: Array<Element> | Array<Range>, formatData: FormatData, affectedElements?: Array<Element>, subType?: string | null, attributes?: Record<string, unknown>): Suggestion | null;
+    markMultiRangeBlockFormat(elementsOrRanges: Array<ModelElement> | Array<ModelRange>, formatData: SuggestionFormatData, affectedElements?: Array<ModelElement>, subType?: string | null, attributes?: Record<string, unknown>): Suggestion | null;
     /**
      * Marks a single-range deletion suggestion on given `range`.
      *
@@ -431,7 +431,7 @@ export default class TrackChangesEditing extends Plugin {
      * @returns Suggestion created or expanded as a result of execution of this
      * method. Returns `null` if given `range` was collapsed or the deletion was in insertion (so no suggestion was created or expanded).
      */
-    markDeletion(range: Range, subType?: string | null, attributes?: Record<string, unknown>): Suggestion | null;
+    markDeletion(range: ModelRange, subType?: string | null, attributes?: Record<string, unknown>): Suggestion | null;
     /**
      * Marks a multi-range deletion suggestion spanning over given `ranges`.
      *
@@ -465,7 +465,7 @@ export default class TrackChangesEditing extends Plugin {
      * @param attributes Custom suggestion attributes.
      * @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;
+    markMultiRangeDeletion(ranges: Array<ModelRange>, subType?: string, attributes?: Record<string, unknown>): Suggestion | null;
     /**
      * Marks a single-range attribute suggestion on the given `range`.
      *
@@ -499,7 +499,7 @@ export default class TrackChangesEditing extends Plugin {
      * @param newValue New value of the attribute.
      * @param attributes Suggestion attributes. Must include `groupId`.
      */
-    markAttributeChange(range: Range, key: string, oldValue: unknown, newValue: unknown, attributes: {
+    markAttributeChange(range: ModelRange, key: string, oldValue: unknown, newValue: unknown, attributes: {
         groupId: string;
         [key: string]: any;
     }): Array<Suggestion>;
@@ -523,12 +523,20 @@ export default class TrackChangesEditing extends Plugin {
      * with said id as an argument.
      */
     startTrackingSession(id?: string | null): string | null;
+    /**
+     * Executes given callback and then finds all attribute and rename changes that have been made during that callback. For all these
+     * changes, creates proper attribute suggestions. Additionally cleans up existing, conflicting attribute suggestions if they intersect
+     * with the newly created suggestions.
+     *
+     * @param callback Function to call and check for attribute and rename changes. Usually this executes an editor command.
+     */
+    recordAttributeChanges(callback: () => void): void;
 }
 /**
  * Command parameters and additional suggestion parameters. Passed value is also saved in
  * {@link module:track-changes/suggestion~Suggestion#data `Suggestion#data`} property.
  */
-export type FormatData = {
+export type SuggestionFormatData = {
     /**
      * Name of the command to execute when the suggestion is accepted.
      */
@@ -553,7 +561,7 @@ export type FormatData = {
 /**
  * Attribute suggestion parameters.
  */
-export type AttributeData = {
+export type SuggestionAttributeData = {
     /**
      * Attribute key.
      */