@ckeditor/ckeditor5-track-changes 39.0.1 → 40.0.0

package/src/integrations/utils.d.ts

@@ -1,21 +1,21 @@
-/**
- * @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
- */
-import type { Editor } from 'ckeditor5/src/core';
-import type { Range, Model, Element, DowncastAddMarkerEvent } from 'ckeditor5/src/engine';
-import type { GetCallback } from 'ckeditor5/src/utils';
-/**
- * Searches given `range` and returns all sub-ranges containing items with given `attributeKey`.
- */
-export declare function getRangesWithAttribute(attributeKey: string, range: Range, model: Model): Array<Range>;
-/**
- * For given `element`, if it is a list item, returns all list items that would be affected by renaming `element` to a different element.
- */
-export declare function getElementsAffectedByListItemRename(element: Element): Array<Element>;
-/**
- * Returns the conversion function for down-casting split/merge markers.
- */
-export declare function downcastSplitMergeMarker(editor: Editor, type: 'split' | 'merge', { showActiveMarker }?: {
-    showActiveMarker?: boolean | undefined;
-}): GetCallback<DowncastAddMarkerEvent>;
+/**
+ * @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
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import type { Range, Model, Element, DowncastAddMarkerEvent } from 'ckeditor5/src/engine';
+import type { GetCallback } from 'ckeditor5/src/utils';
+/**
+ * Searches given `range` and returns all sub-ranges containing items with given `attributeKey`.
+ */
+export declare function getRangesWithAttribute(attributeKey: string, range: Range, model: Model): Array<Range>;
+/**
+ * For given `element`, if it is a list item, returns all list items that would be affected by renaming `element` to a different element.
+ */
+export declare function getElementsAffectedByListItemRename(element: Element): Array<Element>;
+/**
+ * Returns the conversion function for down-casting split/merge markers.
+ */
+export declare function downcastSplitMergeMarker(editor: Editor, type: 'split' | 'merge', { showActiveMarker }?: {
+    showActiveMarker?: boolean | undefined;
+}): GetCallback<DowncastAddMarkerEvent>;

package/src/integrations/utils.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x3923=['get','mapper','listItem','activeMarkers','test','push','ck-suggestion-marker-','isLimit','type','addClass','model','schema','addHighlight','getItems','includes','insert','bindElementToMarker','consumable','getWalker','TrackChangesEditing','parent','elementEnd','element','isContent','getAttribute','listIndent','nextSibling','markerRange','ck-suggestion-marker--active','name','toViewPosition','writer','markerName','plugins'];(function(_0x22e0b0,_0x3923c0){const _0x59e21c=function(_0x4a6d4e){while(--_0x4a6d4e){_0x22e0b0['push'](_0x22e0b0['shift']());}};_0x59e21c(++_0x3923c0);}(_0x3923,0xf6));const _0x59e2=function(_0x22e0b0,_0x3923c0){_0x22e0b0=_0x22e0b0-0x0;let _0x59e21c=_0x3923[_0x22e0b0];return _0x59e21c;};export function getRangesWithAttribute(_0x2233ef,_0x48af14,_0x2a9f09){const _0x228f9b=[];for(const _0x57ba2b of _0x48af14[_0x59e2('0x5')]())_0x57ba2b['hasAttribute'](_0x2233ef)&&_0x228f9b[_0x59e2('0x1f')](_0x2a9f09['createRangeOn'](_0x57ba2b));return _0x228f9b;}export function getElementsAffectedByListItemRename(_0x182ad8){const _0x378480=[];if(_0x182ad8['is']('element',_0x59e2('0x1c'))){let _0x13faa4=_0x182ad8[_0x59e2('0x12')];for(;_0x13faa4&&_0x13faa4['is'](_0x59e2('0xe'),_0x59e2('0x1c'))&&_0x13faa4[_0x59e2('0x10')](_0x59e2('0x11'))>0x0;)_0x378480[_0x59e2('0x1f')](_0x13faa4),_0x13faa4=_0x13faa4[_0x59e2('0x12')];}return _0x378480;}export function downcastSplitMergeMarker(_0x45694d,_0x303efc,{showActiveMarker:_0x309d23=!0x0}={}){const _0x40e22f=_0x45694d[_0x59e2('0x19')][_0x59e2('0x1a')](_0x59e2('0xb'));return(_0x415ce0,_0x18222b,_0x3a0748)=>{if(!_0x3a0748[_0x59e2('0x9')][_0x59e2('0x1e')](_0x18222b['markerRange'],_0x415ce0[_0x59e2('0x15')]))return;const _0x560c86=_0x18222b[_0x59e2('0x13')][_0x59e2('0xa')](),_0x5f40d5=_0x18222b['markerRange']['start'],_0x13fc0e=_0x45694d[_0x59e2('0x2')][_0x59e2('0x3')];let _0x2433f8=null,_0x5ad8c9=null,_0x1a3906=!0x1,_0xd8b67=!0x1;for(const _0x59fd47 of _0x560c86){const _0xc52a07=_0x59fd47['item'];_0x1a3906=_0x1a3906||_0x13fc0e[_0x59e2('0xf')](_0xc52a07);const _0xf05edd=_0x3a0748[_0x59e2('0x1b')]['toViewElement'](_0xc52a07);if(_0xf05edd&&_0xf05edd['getCustomProperty'](_0x59e2('0x4')))return;_0x59e2('0xd')==_0x59fd47[_0x59e2('0x0')]&&(_0x13fc0e['isBlock'](_0xc52a07)&&!_0x13fc0e[_0x59e2('0x21')](_0xc52a07)&&(_0xc52a07[_0x59e2('0x12')]||_0x5f40d5['isAtEnd']?_0x2433f8&&_0x2433f8[_0x59e2('0xc')]==_0xc52a07||(_0x2433f8=_0xc52a07,_0x7ec4ea(_0x59fd47['previousPosition']),_0xd8b67=!0x0):_0x5ad8c9=_0x5ad8c9||_0x59fd47['previousPosition']));}function _0x7ec4ea(_0x83ecad){const _0x51f35e=_0x3a0748[_0x59e2('0x17')]['createUIElement']('span',{'class':_0x59e2('0x20')+_0x303efc}),_0x4e3787=_0x3a0748[_0x59e2('0x1b')][_0x59e2('0x16')](_0x83ecad);_0x309d23&&_0x40e22f[_0x59e2('0x1d')][_0x59e2('0x6')](_0x18222b['markerName'])&&_0x3a0748[_0x59e2('0x17')][_0x59e2('0x1')](_0x59e2('0x14'),_0x51f35e),_0x3a0748[_0x59e2('0x17')][_0x59e2('0x7')](_0x4e3787,_0x51f35e),_0x3a0748[_0x59e2('0x1b')][_0x59e2('0x8')](_0x51f35e,_0x18222b[_0x59e2('0x18')]);}_0x1a3906||_0xd8b67||!_0x5ad8c9||_0x7ec4ea(_0x5ad8c9);};}
+const _0x2987=['name','createRangeOn','get','activeMarkers','markerRange','writer','element','listIndent','push','toViewElement','TrackChangesEditing','createUIElement','type','getItems','listItem','mapper','test','elementEnd','insert','includes','markerName','nextSibling','getCustomProperty','item','addClass','isAtEnd','isContent','getWalker','bindElementToMarker','plugins','model'];(function(_0xba327,_0x2987c7){const _0x5cd508=function(_0x5a57e9){while(--_0x5a57e9){_0xba327['push'](_0xba327['shift']());}};_0x5cd508(++_0x2987c7);}(_0x2987,0x67));const _0x5cd5=function(_0xba327,_0x2987c7){_0xba327=_0xba327-0x0;let _0x5cd508=_0x2987[_0xba327];return _0x5cd508;};export function getRangesWithAttribute(_0x27256a,_0x4ec76e,_0x529c17){const _0x113a58=[];for(const _0xcff14 of _0x4ec76e[_0x5cd5('0x3')]())_0xcff14['hasAttribute'](_0x27256a)&&_0x113a58[_0x5cd5('0x1d')](_0x529c17[_0x5cd5('0x16')](_0xcff14));return _0x113a58;}export function getElementsAffectedByListItemRename(_0x2d6300){const _0x25595d=[];if(_0x2d6300['is'](_0x5cd5('0x1b'),'listItem')){let _0x4ea83b=_0x2d6300[_0x5cd5('0xb')];for(;_0x4ea83b&&_0x4ea83b['is'](_0x5cd5('0x1b'),_0x5cd5('0x4'))&&_0x4ea83b['getAttribute'](_0x5cd5('0x1c'))>0x0;)_0x25595d[_0x5cd5('0x1d')](_0x4ea83b),_0x4ea83b=_0x4ea83b[_0x5cd5('0xb')];}return _0x25595d;}export function downcastSplitMergeMarker(_0x1db6b8,_0x21f513,{showActiveMarker:_0x31c1f8=!0x0}={}){const _0x5205fe=_0x1db6b8[_0x5cd5('0x13')][_0x5cd5('0x17')](_0x5cd5('0x0'));return(_0x5e90ba,_0x107237,_0xb5b61a)=>{if(!_0xb5b61a['consumable'][_0x5cd5('0x6')](_0x107237[_0x5cd5('0x19')],_0x5e90ba[_0x5cd5('0x15')]))return;const _0x93379f=_0x107237['markerRange'][_0x5cd5('0x11')](),_0x5e9a3a=_0x107237['markerRange']['start'],_0x56149f=_0x1db6b8[_0x5cd5('0x14')]['schema'];let _0x4862ba=null,_0x555d22=null,_0x22fd77=!0x1,_0x350f7f=!0x1;for(const _0x2586a8 of _0x93379f){const _0x5929ad=_0x2586a8[_0x5cd5('0xd')];_0x22fd77=_0x22fd77||_0x56149f[_0x5cd5('0x10')](_0x5929ad);const _0x116190=_0xb5b61a[_0x5cd5('0x5')][_0x5cd5('0x1e')](_0x5929ad);if(_0x116190&&_0x116190[_0x5cd5('0xc')]('addHighlight'))return;_0x5cd5('0x7')==_0x2586a8[_0x5cd5('0x2')]&&(_0x56149f['isBlock'](_0x5929ad)&&!_0x56149f['isLimit'](_0x5929ad)&&(_0x5929ad[_0x5cd5('0xb')]||_0x5e9a3a[_0x5cd5('0xf')]?_0x4862ba&&_0x4862ba['parent']==_0x5929ad||(_0x4862ba=_0x5929ad,_0x2a1c57(_0x2586a8['previousPosition']),_0x350f7f=!0x0):_0x555d22=_0x555d22||_0x2586a8['previousPosition']));}function _0x2a1c57(_0x5b2720){const _0x9f1078=_0xb5b61a[_0x5cd5('0x1a')][_0x5cd5('0x1')]('span',{'class':'ck-suggestion-marker-'+_0x21f513}),_0x140632=_0xb5b61a[_0x5cd5('0x5')]['toViewPosition'](_0x5b2720);_0x31c1f8&&_0x5205fe[_0x5cd5('0x18')][_0x5cd5('0x9')](_0x107237[_0x5cd5('0xa')])&&_0xb5b61a[_0x5cd5('0x1a')][_0x5cd5('0xe')]('ck-suggestion-marker--active',_0x9f1078),_0xb5b61a['writer'][_0x5cd5('0x8')](_0x140632,_0x9f1078),_0xb5b61a['mapper'][_0x5cd5('0x12')](_0x9f1078,_0x107237[_0x5cd5('0xa')]);}_0x22fd77||_0x350f7f||!_0x555d22||_0x2a1c57(_0x555d22);};}

package/src/suggestion.d.ts

@@ -1,276 +1,276 @@
-/**
- * @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/suggestion
- * @publicApi
- */
-import { Element, type Marker, type Model, type Range, type Item } from 'ckeditor5/src/engine';
-import type { User } from 'ckeditor5-collaboration/src/collaboration-core';
-import type { CommentThread } from '@ckeditor/ckeditor5-comments';
-import type { FormatData } from './trackchangesediting';
-declare const Suggestion_base: {
-    new (): import("ckeditor5/src/utils").Observable;
-    prototype: import("ckeditor5/src/utils").Observable; /**
-     * Previous suggestion in suggestions chain.
-     *
-     * Chained suggestions should be handled as one entity.
-     *
-     * @observable
-     */
-};
-/**
- * Represents a singular suggestion that is tracked by track changes plugin.
- *
- * `Suggestion` instances are created and handled by {@link module:track-changes/trackchanges~TrackChanges track changes plugin}.
- */
-export default class Suggestion extends Suggestion_base {
-    /**
-     * Suggestion ID.
-     */
-    readonly id: string;
-    /**
-     * Suggestion type.
-     */
-    type: SuggestionType;
-    /**
-     * Suggestion sub-type.
-     *
-     * This is an additional identifier for suggestions. Two suggestions of the same type may have different sub-types to differentiate
-     * suggestions behavior and handle interactions between suggestions.
-     *
-     * Sub-type is used for:
-     *
-     *  * suggestions joining (only suggestions with the same sub-type can be joined),
-     *  * suggestions custom callbacks (fired when adding, deleting and joining suggestions).
-     */
-    subType: string | null;
-    /**
-     * The author of the change marked by the suggestion.
-     */
-    author: User;
-    /**
-     * The user which saved the suggestion data in the database.
-     *
-     * Usually the same as author but may be different in some cases (e.g. when suggestion was added from an external source).
-     */
-    creator: User;
-    /**
-     * The flag indicating whether the suggestion comes from an external source.
-     */
-    isExternal: boolean;
-    /**
-     * Additional suggestion data.
-     */
-    data: FormatData | null;
-    /**
-     * Date when the suggestion was saved in the database.
-     */
-    createdAt: Date | null;
-    /**
-     * Date when the change marked by the suggestion was made.
-     *
-     * Usually the same as {@link #createdAt `createdAt`} but may be different in some cases
-     * (e.g. when suggestion was added from an external source).
-     *
-     * @observable
-     */
-    authoredAt: Date | null;
-    /**
-     * Custom suggestion attributes. See also {@link #setAttribute} and {@link #removeAttribute}.
-     *
-     * @observable
-     */
-    attributes: {
-        [k: string]: unknown;
-    };
-    /**
-     * Previous suggestion in suggestions chain.
-     *
-     * Chained suggestions should be handled as one entity.
-     *
-     * @observable
-     */
-    previous: Suggestion | null;
-    /**
-     * Next suggestion in suggestions chain.
-     *
-     * Chained suggestions should be handled as one entity.
-     *
-     * @observable
-     */
-    next: Suggestion | null;
-    /**
-     * Comment thread model for comments added to this suggestion.
-     *
-     * @observable
-     */
-    commentThread: CommentThread | null;
-    constructor(model: Model, options: SuggestionOptions);
-    /**
-     * The first (most-previous) suggestion in this suggestion chain.
-     */
-    get head(): Suggestion;
-    /**
-     * Informs whether suggestion has at least one comment.
-     */
-    get hasComments(): boolean;
-    /**
-     * Informs whether the suggestion is a multi-range suggestion or a single-range suggestion.
-     *
-     * This is evaluated basing on the marker name belonging to this suggestion.
-     * Even if only one marker belongs to the suggestion at a given time it can still be a multi range suggestion.
-     */
-    get isMultiRange(): boolean;
-    /**
-     * Informs whether the suggestion is still in the editor content.
-     *
-     * Returns `true` if there is at least one marker suggestion in the editor content.
-     */
-    get isInContent(): boolean;
-    /**
-     * Binds given marker name to this suggestion.
-     */
-    addMarkerName(markerName: string): void;
-    /**
-     * Returns all names of markers belonging to this suggestion.
-     */
-    getMarkerNames(): Array<string>;
-    /**
-     * Returns all markers belonging to this suggestion.
-     */
-    getMarkers(): Array<Marker>;
-    /**
-     * Returns the first marker belonging to this suggestion, i.e the first marker that was added to this suggestion
-     * and not removed yet.
-     *
-     * This method is useful if you know that the suggestion has only one marker and want to process it.
-     */
-    getFirstMarker(): Marker | null;
-    /**
-     * Removes all markers from the suggestion and the editor content.
-     */
-    removeMarkers(): void;
-    /**
-     * Removes marker with the given name from the suggestion and the editor content.
-     */
-    removeMarker(markerName: string): void;
-    /**
-     * Adds a new range to this suggestion. It is assumed that the suggestion is a multi-range suggestion.
-     *
-     * A marker name is generated from this suggestion's properties and a marker with that name is created and set to a given `range`.
-     */
-    addRange(range: Range): void;
-    /**
-     * Checks if given `range` is intersecting with any of the ranges of markers belonging to this suggestion.
-     */
-    isIntersectingWithRange(range: Range): boolean;
-    /**
-     * Returns all ranges of all markers belonging to this suggestion.
-     */
-    getRanges(): Array<Range>;
-    /**
-     * Returns all {@link module:engine/model/item~Item model items} that are in this suggestion.
-     */
-    getItems(): Array<Item>;
-    /**
-     * Returns the first range belonging to this suggestion, i.e. the range of the first marker that was added to
-     * this suggestion and not removed yet.
-     *
-     * This method is useful if you know that the suggestion has only one marker and want to process its range.
-     */
-    getFirstRange(): Range | null;
-    /**
-     * Returns the model element contained in the suggestion.
-     *
-     * A {@link module:engine/model/element~Element model element} is considered as contained if there is exactly
-     * one range in the suggestion, and that range contains exactly one element.
-     *
-     * Returns `null` if there is no contained element.
-     */
-    getContainedElement(): Element | null;
-    /**
-     * Accepts the suggestion.
-     */
-    accept(): void;
-    /**
-     * Discards the suggestion.
-     */
-    discard(): void;
-    /**
-     * Returns all suggestions that are in this suggestion chain.
-     */
-    getAllAdjacentSuggestions(): Array<Suggestion>;
-    /**
-     * Adds suggestion attribute.
-     *
-     * Suggestion attributes are custom data that can be set and used by features
-     * built around suggestions. Use it to store your feature data with other suggestion data.
-     *
-     * ```ts
-     * suggestion.setAttribute( 'isImportant', true );
-     * ```
-     *
-     * You can group multiple values in an object, using dot notation:
-     *
-     * ```ts
-     * suggestion.setAttribute( 'customData.type', 'image' );
-     * suggestion.setAttribute( 'customData.src', 'foo.jpg' );
-     * ```
-     *
-     * Attributes set on the suggestion can be accessed through `attribute` property:
-     *
-     * ```ts
-     * const isImportant = suggestion.attributes.isImportant;
-     * const type = suggestion.attributes.customData.type;
-     * ```
-     *
-     * You can also observe `attributes` property or bind other properties to it:
-     *
-     * ```ts
-     * myObj.bind( 'customData' ).to( suggestion, 'attributes', attributes => attributes.customData );
-     * ```
-     *
-     * Whenever `setAttribute()` or `removeAttribute()` is called, `attributes` property
-     * is re-set and observables are refreshed.
-     */
-    setAttribute(name: string, value: unknown): void;
-    /**
-     * Removes suggestion attribute.
-     *
-     * See also {@link #setAttribute}
-     */
-    removeAttribute(name: string): void;
-    toJSON(): SuggestionJSON;
-    /**
-     * Returns a random string that can be used as additional identifier for the marker name for suggestions that are multi range.
-     */
-    static getMultiRangeId(): string;
-}
-export interface SuggestionOptions {
-    id: string;
-    type: SuggestionType;
-    subType: string | null;
-    attributes: {
-        [k: string]: unknown;
-    };
-    author: User;
-    creator: User;
-    onAccept: Function;
-    onDiscard: Function;
-    onAttributesChange: Function;
-}
-export interface SuggestionJSON {
-    id: string;
-    type: string;
-    authorId: string;
-    createdAt: Date | null;
-    hasComments?: boolean;
-    data?: FormatData | null;
-    attributes: {
-        [k: string]: unknown;
-    };
-}
-export type SuggestionType = 'insertion' | 'deletion' | 'formatInline' | 'formatBlock';
-export {};
+/**
+ * @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/suggestion
+ * @publicApi
+ */
+import { Element, type Marker, type Model, type Range, type Item } from 'ckeditor5/src/engine';
+import type { User } from 'ckeditor5-collaboration/src/collaboration-core';
+import type { CommentThread } from '@ckeditor/ckeditor5-comments';
+import type { FormatData } from './trackchangesediting';
+declare const Suggestion_base: {
+    new (): import("ckeditor5/src/utils").Observable;
+    prototype: import("ckeditor5/src/utils").Observable; /**
+     * Previous suggestion in suggestions chain.
+     *
+     * Chained suggestions should be handled as one entity.
+     *
+     * @observable
+     */
+};
+/**
+ * Represents a singular suggestion that is tracked by track changes plugin.
+ *
+ * `Suggestion` instances are created and handled by {@link module:track-changes/trackchanges~TrackChanges track changes plugin}.
+ */
+export default class Suggestion extends Suggestion_base {
+    /**
+     * Suggestion ID.
+     */
+    readonly id: string;
+    /**
+     * Suggestion type.
+     */
+    type: SuggestionType;
+    /**
+     * Suggestion sub-type.
+     *
+     * This is an additional identifier for suggestions. Two suggestions of the same type may have different sub-types to differentiate
+     * suggestions behavior and handle interactions between suggestions.
+     *
+     * Sub-type is used for:
+     *
+     *  * suggestions joining (only suggestions with the same sub-type can be joined),
+     *  * suggestions custom callbacks (fired when adding, deleting and joining suggestions).
+     */
+    subType: string | null;
+    /**
+     * The author of the change marked by the suggestion.
+     */
+    author: User;
+    /**
+     * The user which saved the suggestion data in the database.
+     *
+     * Usually the same as author but may be different in some cases (e.g. when suggestion was added from an external source).
+     */
+    creator: User;
+    /**
+     * The flag indicating whether the suggestion comes from an external source.
+     */
+    isExternal: boolean;
+    /**
+     * Additional suggestion data.
+     */
+    data: FormatData | null;
+    /**
+     * Date when the suggestion was saved in the database.
+     */
+    createdAt: Date | null;
+    /**
+     * Date when the change marked by the suggestion was made.
+     *
+     * Usually the same as {@link #createdAt `createdAt`} but may be different in some cases
+     * (e.g. when suggestion was added from an external source).
+     *
+     * @observable
+     */
+    authoredAt: Date | null;
+    /**
+     * Custom suggestion attributes. See also {@link #setAttribute} and {@link #removeAttribute}.
+     *
+     * @observable
+     */
+    attributes: {
+        [k: string]: unknown;
+    };
+    /**
+     * Previous suggestion in suggestions chain.
+     *
+     * Chained suggestions should be handled as one entity.
+     *
+     * @observable
+     */
+    previous: Suggestion | null;
+    /**
+     * Next suggestion in suggestions chain.
+     *
+     * Chained suggestions should be handled as one entity.
+     *
+     * @observable
+     */
+    next: Suggestion | null;
+    /**
+     * Comment thread model for comments added to this suggestion.
+     *
+     * @observable
+     */
+    commentThread: CommentThread | null;
+    constructor(model: Model, options: SuggestionOptions);
+    /**
+     * The first (most-previous) suggestion in this suggestion chain.
+     */
+    get head(): Suggestion;
+    /**
+     * Informs whether suggestion has at least one comment.
+     */
+    get hasComments(): boolean;
+    /**
+     * Informs whether the suggestion is a multi-range suggestion or a single-range suggestion.
+     *
+     * This is evaluated basing on the marker name belonging to this suggestion.
+     * Even if only one marker belongs to the suggestion at a given time it can still be a multi range suggestion.
+     */
+    get isMultiRange(): boolean;
+    /**
+     * Informs whether the suggestion is still in the editor content.
+     *
+     * Returns `true` if there is at least one marker suggestion in the editor content.
+     */
+    get isInContent(): boolean;
+    /**
+     * Binds given marker name to this suggestion.
+     */
+    addMarkerName(markerName: string): void;
+    /**
+     * Returns all names of markers belonging to this suggestion.
+     */
+    getMarkerNames(): Array<string>;
+    /**
+     * Returns all markers belonging to this suggestion.
+     */
+    getMarkers(): Array<Marker>;
+    /**
+     * Returns the first marker belonging to this suggestion, i.e the first marker that was added to this suggestion
+     * and not removed yet.
+     *
+     * This method is useful if you know that the suggestion has only one marker and want to process it.
+     */
+    getFirstMarker(): Marker | null;
+    /**
+     * Removes all markers from the suggestion and the editor content.
+     */
+    removeMarkers(): void;
+    /**
+     * Removes marker with the given name from the suggestion and the editor content.
+     */
+    removeMarker(markerName: string): void;
+    /**
+     * Adds a new range to this suggestion. It is assumed that the suggestion is a multi-range suggestion.
+     *
+     * A marker name is generated from this suggestion's properties and a marker with that name is created and set to a given `range`.
+     */
+    addRange(range: Range): void;
+    /**
+     * Checks if given `range` is intersecting with any of the ranges of markers belonging to this suggestion.
+     */
+    isIntersectingWithRange(range: Range): boolean;
+    /**
+     * Returns all ranges of all markers belonging to this suggestion.
+     */
+    getRanges(): Array<Range>;
+    /**
+     * Returns all {@link module:engine/model/item~Item model items} that are in this suggestion.
+     */
+    getItems(): Array<Item>;
+    /**
+     * Returns the first range belonging to this suggestion, i.e. the range of the first marker that was added to
+     * this suggestion and not removed yet.
+     *
+     * This method is useful if you know that the suggestion has only one marker and want to process its range.
+     */
+    getFirstRange(): Range | null;
+    /**
+     * Returns the model element contained in the suggestion.
+     *
+     * A {@link module:engine/model/element~Element model element} is considered as contained if there is exactly
+     * one range in the suggestion, and that range contains exactly one element.
+     *
+     * Returns `null` if there is no contained element.
+     */
+    getContainedElement(): Element | null;
+    /**
+     * Accepts the suggestion.
+     */
+    accept(): void;
+    /**
+     * Discards the suggestion.
+     */
+    discard(): void;
+    /**
+     * Returns all suggestions that are in this suggestion chain.
+     */
+    getAllAdjacentSuggestions(): Array<Suggestion>;
+    /**
+     * Adds suggestion attribute.
+     *
+     * Suggestion attributes are custom data that can be set and used by features
+     * built around suggestions. Use it to store your feature data with other suggestion data.
+     *
+     * ```ts
+     * suggestion.setAttribute( 'isImportant', true );
+     * ```
+     *
+     * You can group multiple values in an object, using dot notation:
+     *
+     * ```ts
+     * suggestion.setAttribute( 'customData.type', 'image' );
+     * suggestion.setAttribute( 'customData.src', 'foo.jpg' );
+     * ```
+     *
+     * Attributes set on the suggestion can be accessed through `attribute` property:
+     *
+     * ```ts
+     * const isImportant = suggestion.attributes.isImportant;
+     * const type = suggestion.attributes.customData.type;
+     * ```
+     *
+     * You can also observe `attributes` property or bind other properties to it:
+     *
+     * ```ts
+     * myObj.bind( 'customData' ).to( suggestion, 'attributes', attributes => attributes.customData );
+     * ```
+     *
+     * Whenever `setAttribute()` or `removeAttribute()` is called, `attributes` property
+     * is re-set and observables are refreshed.
+     */
+    setAttribute(name: string, value: unknown): void;
+    /**
+     * Removes suggestion attribute.
+     *
+     * See also {@link #setAttribute}
+     */
+    removeAttribute(name: string): void;
+    toJSON(): SuggestionJSON;
+    /**
+     * Returns a random string that can be used as additional identifier for the marker name for suggestions that are multi range.
+     */
+    static getMultiRangeId(): string;
+}
+export interface SuggestionOptions {
+    id: string;
+    type: SuggestionType;
+    subType: string | null;
+    attributes: {
+        [k: string]: unknown;
+    };
+    author: User;
+    creator: User;
+    onAccept: Function;
+    onDiscard: Function;
+    onAttributesChange: Function;
+}
+export interface SuggestionJSON {
+    id: string;
+    type: string;
+    authorId: string;
+    createdAt: Date | null;
+    hasComments?: boolean;
+    data?: FormatData | null;
+    attributes: {
+        [k: string]: unknown;
+    };
+}
+export type SuggestionType = 'insertion' | 'deletion' | 'formatInline' | 'formatBlock';
+export {};