@ckeditor/ckeditor5-revision-history 38.1.1 → 38.2.0-alpha.1

package/src/revision.d.ts

@@ -1,153 +1,153 @@
-/**
- * @module revision-history/revision
- * @publicApi
- */
-import type { User } from 'ckeditor5-collaboration/src/collaboration-core';
-declare const Revision_base: {
-    new (): import("ckeditor5/src/utils").Observable;
-    prototype: import("ckeditor5/src/utils").Observable;
-};
-/**
- * Represents a revision.
- */
-export default class Revision extends Revision_base {
-    /**
-     * Unique revision id.
-     */
-    id: string;
-    /**
-     * The user who created the revision.
-     *
-     * The `null` value means the revision was created automatically.
-     */
-    creator: User | null;
-    /**
-     * All users who contributed to this revision.
-     *
-     * This value can be empty if there are no changes in the revision.
-     */
-    authors: Array<User>;
-    /**
-     * Contains data describing changes saved in this revision.
-     *
-     * An object, where the keys are the names of roots and the values are strings with the revision data for those roots.
-     */
-    diffData: any;
-    /**
-     * Document version at which the revision ends.
-     *
-     * The revision includes changes introduced by {@link module:engine/model/operation/operation~Operation operations}
-     * with base versions starting from {@link module:revision-history/revision~Revision#fromVersion `fromVersion`} (inclusive) up to
-     * {@link module:revision-history/revision~Revision#toVersion `toVersion`} (exclusive).
-     */
-    toVersion: number;
-    /**
-     * Document version from which the revision starts.
-     *
-     * The revision includes changes introduced by {@link module:engine/model/operation/operation~Operation operations}
-     * with base versions starting from {@link module:revision-history/revision~Revision#fromVersion `fromVersion`} (inclusive) up to
-     * {@link module:revision-history/revision~Revision#toVersion `toVersion`} (exclusive).
-     */
-    fromVersion: number;
-    /**
-     * The revision name.
-     *
-     * If revision has not been named yet, this is an empty string.
-     *
-     * @observable
-     */
-    name: string;
-    /**
-     * The date when the revision was created or most recently updated.
-     *
-     * @observable
-     */
-    createdAt: Date;
-    /**
-     * Revision custom attributes. See also {@link #setAttribute} and {@link #removeAttribute}.
-     *
-     * @observable
-     */
-    attributes: Record<string, unknown>;
-    constructor(data: RevisionData);
-    /**
-     * Sets the revision name.
-     */
-    setName(name: string): void;
-    /**
-     * Adds revision attribute.
-     *
-     * Revision attributes are custom data that can be set and used by features built around revisions.
-     * Use it to store your feature data together with other revision data.
-     *
-     * ```ts
-     * revision.setAttribute( 'isImportant', true );
-     * ```
-     *
-     * You can group multiple values in an object, using the dot notation:
-     *
-     * ```ts
-     * revision.setAttribute( 'customData.type', 'image' );
-     * revision.setAttribute( 'customData.src', 'foo.jpg' );
-     * ```
-     *
-     * The attributes set on the revision can be accessed through the `attribute` property:
-     *
-     * ```ts
-     * const isImportant = revision.attributes.isImportant;
-     * const type = revision.attributes.customData.type;
-     * ```
-     *
-     * You can also observe the `attributes` property or bind other properties to it:
-     *
-     * ```ts
-     * myObj.bind( 'customData' ).to( revision, 'attributes', attributes => attributes.customData );
-     * revision.on( 'change:attributes', ( evt, propName, newValue, oldValue ) => { ... } );
-     * ```
-     *
-     * Whenever `setAttribute()` or `removeAttribute()` is called, the `attributes` property
-     * is re-set and the observables are refreshed.
-     */
-    setAttribute(name: string, value: unknown): void;
-    /**
-     * Removes the revision attribute.
-     *
-     * See also {@link #setAttribute}
-     */
-    removeAttribute(name: string): void;
-    toJSON(): RevisionJSON;
-}
-/**
- * @eventName _update
- */
-export interface RevisionUpdateEvent {
-    name: '_update';
-    args: [RevisionJSON, boolean];
-}
-export interface RevisionJSON {
-    id: string;
-    name: string;
-    creatorId: string | null;
-    authorsIds: Array<string>;
-    diffData: any;
-    createdAt: Date;
-    attributes: Record<string, unknown>;
-    fromVersion: number;
-    toVersion: number;
-}
-export interface RevisionData {
-    id?: string;
-    name?: string | null;
-    creator?: User | null;
-    creatorId?: string | null;
-    authors?: Array<User>;
-    authorsIds?: Array<string>;
-    diffData?: any;
-    data?: any;
-    createdAt?: Date;
-    attributes?: Record<string, unknown>;
-    fromVersion?: number;
-    toVersion?: number;
-    isEmptyCurrent?: boolean;
-}
-export {};
+/**
+ * @module revision-history/revision
+ * @publicApi
+ */
+import type { User } from 'ckeditor5-collaboration';
+declare const Revision_base: {
+    new (): import("ckeditor5/src/utils.js").Observable;
+    prototype: import("ckeditor5/src/utils.js").Observable;
+};
+/**
+ * Represents a revision.
+ */
+export default class Revision extends Revision_base {
+    /**
+     * Unique revision id.
+     */
+    id: string;
+    /**
+     * The user who created the revision.
+     *
+     * The `null` value means the revision was created automatically.
+     */
+    creator: User | null;
+    /**
+     * All users who contributed to this revision.
+     *
+     * This value can be empty if there are no changes in the revision.
+     */
+    authors: Array<User>;
+    /**
+     * Contains data describing changes saved in this revision.
+     *
+     * An object, where the keys are the names of roots and the values are strings with the revision data for those roots.
+     */
+    diffData: any;
+    /**
+     * Document version at which the revision ends.
+     *
+     * The revision includes changes introduced by {@link module:engine/model/operation/operation~Operation operations}
+     * with base versions starting from {@link module:revision-history/revision~Revision#fromVersion `fromVersion`} (inclusive) up to
+     * {@link module:revision-history/revision~Revision#toVersion `toVersion`} (exclusive).
+     */
+    toVersion: number;
+    /**
+     * Document version from which the revision starts.
+     *
+     * The revision includes changes introduced by {@link module:engine/model/operation/operation~Operation operations}
+     * with base versions starting from {@link module:revision-history/revision~Revision#fromVersion `fromVersion`} (inclusive) up to
+     * {@link module:revision-history/revision~Revision#toVersion `toVersion`} (exclusive).
+     */
+    fromVersion: number;
+    /**
+     * The revision name.
+     *
+     * If revision has not been named yet, this is an empty string.
+     *
+     * @observable
+     */
+    name: string;
+    /**
+     * The date when the revision was created or most recently updated.
+     *
+     * @observable
+     */
+    createdAt: Date;
+    /**
+     * Revision custom attributes. See also {@link #setAttribute} and {@link #removeAttribute}.
+     *
+     * @observable
+     */
+    attributes: Record<string, unknown>;
+    constructor(data: RevisionData);
+    /**
+     * Sets the revision name.
+     */
+    setName(name: string): void;
+    /**
+     * Adds revision attribute.
+     *
+     * Revision attributes are custom data that can be set and used by features built around revisions.
+     * Use it to store your feature data together with other revision data.
+     *
+     * ```ts
+     * revision.setAttribute( 'isImportant', true );
+     * ```
+     *
+     * You can group multiple values in an object, using the dot notation:
+     *
+     * ```ts
+     * revision.setAttribute( 'customData.type', 'image' );
+     * revision.setAttribute( 'customData.src', 'foo.jpg' );
+     * ```
+     *
+     * The attributes set on the revision can be accessed through the `attribute` property:
+     *
+     * ```ts
+     * const isImportant = revision.attributes.isImportant;
+     * const type = revision.attributes.customData.type;
+     * ```
+     *
+     * You can also observe the `attributes` property or bind other properties to it:
+     *
+     * ```ts
+     * myObj.bind( 'customData' ).to( revision, 'attributes', attributes => attributes.customData );
+     * revision.on( 'change:attributes', ( evt, propName, newValue, oldValue ) => { ... } );
+     * ```
+     *
+     * Whenever `setAttribute()` or `removeAttribute()` is called, the `attributes` property
+     * is re-set and the observables are refreshed.
+     */
+    setAttribute(name: string, value: unknown): void;
+    /**
+     * Removes the revision attribute.
+     *
+     * See also {@link #setAttribute}
+     */
+    removeAttribute(name: string): void;
+    toJSON(): RevisionJSON;
+}
+/**
+ * @eventName _update
+ */
+export interface RevisionUpdateEvent {
+    name: '_update';
+    args: [RevisionJSON, boolean];
+}
+export interface RevisionJSON {
+    id: string;
+    name: string;
+    creatorId: string | null;
+    authorsIds: Array<string>;
+    diffData: any;
+    createdAt: Date;
+    attributes: Record<string, unknown>;
+    fromVersion: number;
+    toVersion: number;
+}
+export interface RevisionData {
+    id?: string;
+    name?: string | null;
+    creator?: User | null;
+    creatorId?: string | null;
+    authors?: Array<User>;
+    authorsIds?: Array<string>;
+    diffData?: any;
+    data?: any;
+    createdAt?: Date;
+    attributes?: Record<string, unknown>;
+    fromVersion?: number;
+    toVersion?: number;
+    isEmptyCurrent?: boolean;
+}
+export {};

package/src/revision.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x6602=['name','authorsIds','createdAt','toJSON','removeAttribute','toVersion','setName','set','creator','attributes','diffData','setAttribute','fromVersion','map','_update','authors','fire'];(function(_0x1194a0,_0x66021c){const _0x2ac207=function(_0x14e7a4){while(--_0x14e7a4){_0x1194a0['push'](_0x1194a0['shift']());}};_0x2ac207(++_0x66021c);}(_0x6602,0xad));const _0x2ac2=function(_0x1194a0,_0x66021c){_0x1194a0=_0x1194a0-0x0;let _0x2ac207=_0x6602[_0x1194a0];return _0x2ac207;};import{ObservableMixin as _0x2717de,uid as _0xce98f5}from'ckeditor5/src/utils';import{cloneDeep as _0x24c17f,set as _0x45d8fb,unset as _0x2db02b}from'lodash-es';export default class a extends _0x2717de(){constructor(_0xe2a81){super(),this['id']=_0xe2a81['id']||_0xce98f5(),this[_0x2ac2('0x5')]=_0xe2a81[_0x2ac2('0x5')]||null,this[_0x2ac2('0xc')]=_0xe2a81[_0x2ac2('0xc')]||[],this['diffData']=_0xe2a81['diffData']||null,this['toVersion']=_0xe2a81[_0x2ac2('0x2')]||0x0,this[_0x2ac2('0x9')]=_0xe2a81[_0x2ac2('0x9')]||0x0,this[_0x2ac2('0x4')](_0x2ac2('0xe'),_0xe2a81[_0x2ac2('0xe')]||''),this[_0x2ac2('0x4')](_0x2ac2('0x10'),_0xe2a81['createdAt']||new Date()),this[_0x2ac2('0x4')](_0x2ac2('0x6'),_0xe2a81[_0x2ac2('0x6')]||{});}[_0x2ac2('0x3')](_0x35616f){this[_0x2ac2('0xb')]({'name':_0x35616f});}[_0x2ac2('0x8')](_0xe5e988,_0x5f393f){const _0x4a2253=_0x24c17f(this[_0x2ac2('0x6')]);_0x45d8fb(_0x4a2253,_0xe5e988,_0x5f393f),this[_0x2ac2('0xb')]({'attributes':_0x4a2253});}[_0x2ac2('0x1')](_0x36f56b){const _0x535359=_0x24c17f(this[_0x2ac2('0x6')]);_0x2db02b(_0x535359,_0x36f56b),this[_0x2ac2('0xb')]({'attributes':_0x535359});}[_0x2ac2('0xb')](_0x3e68c2,_0x72110=!0x1){let _0x11a468=!0x1;const _0x3954cc={'id':this['id']},_0x4cdb16=[_0x2ac2('0xe'),_0x2ac2('0x10'),'diffData',_0x2ac2('0xc'),_0x2ac2('0x6'),_0x2ac2('0x2'),_0x2ac2('0x9'),'creatorId'];for(const _0x30789a of _0x4cdb16){const _0x4acbc0=_0x3e68c2[_0x30789a];void 0x0!==_0x4acbc0&&_0x4acbc0!==this[_0x30789a]&&(this[_0x30789a]=_0x4acbc0,_0x3954cc[_0x30789a]=_0x4acbc0,_0x11a468=!0x0);}_0x11a468&&(_0x3954cc[_0x2ac2('0xc')]&&(_0x3954cc[_0x2ac2('0xf')]=_0x3954cc[_0x2ac2('0xc')][_0x2ac2('0xa')](_0x3a1b43=>_0x3a1b43['id']),delete _0x3954cc[_0x2ac2('0xc')]),this[_0x2ac2('0xd')]('_update',_0x3954cc,_0x72110));}[_0x2ac2('0x0')](){return{'id':this['id'],'name':this[_0x2ac2('0xe')],'creatorId':this[_0x2ac2('0x5')]?this[_0x2ac2('0x5')]['id']:null,'authorsIds':this[_0x2ac2('0xc')][_0x2ac2('0xa')](_0x5610ea=>_0x5610ea['id']),'diffData':this[_0x2ac2('0x7')],'createdAt':this[_0x2ac2('0x10')],'attributes':this[_0x2ac2('0x6')],'fromVersion':this[_0x2ac2('0x9')],'toVersion':this[_0x2ac2('0x2')]};}}
+const _0x1382=['authors','creator','name','diffData','fromVersion','authorsIds','removeAttribute','set','map','toVersion','_update','createdAt','creatorId','attributes','fire'];(function(_0x25e971,_0x138240){const _0x275cba=function(_0x5ab099){while(--_0x5ab099){_0x25e971['push'](_0x25e971['shift']());}};_0x275cba(++_0x138240);}(_0x1382,0x103));const _0x275c=function(_0x25e971,_0x138240){_0x25e971=_0x25e971-0x0;let _0x275cba=_0x1382[_0x25e971];return _0x275cba;};import{ObservableMixin as _0x762bc2,uid as _0x24642c}from'ckeditor5/src/utils.js';import{cloneDeep as _0x55b949,set as _0x54c282,unset as _0x5e8431}from'lodash-es';export default class a extends _0x762bc2(){constructor(_0x4a38b6){super(),this['id']=_0x4a38b6['id']||_0x24642c(),this['creator']=_0x4a38b6['creator']||null,this[_0x275c('0xb')]=_0x4a38b6[_0x275c('0xb')]||[],this[_0x275c('0xe')]=_0x4a38b6['diffData']||null,this[_0x275c('0x5')]=_0x4a38b6['toVersion']||0x0,this[_0x275c('0x0')]=_0x4a38b6['fromVersion']||0x0,this[_0x275c('0x3')](_0x275c('0xd'),_0x4a38b6['name']||''),this['set']('createdAt',_0x4a38b6[_0x275c('0x7')]||new Date()),this['set'](_0x275c('0x9'),_0x4a38b6[_0x275c('0x9')]||{});}['setName'](_0xb2bd94){this['_update']({'name':_0xb2bd94});}['setAttribute'](_0x563239,_0x59d629){const _0x50b3a9=_0x55b949(this[_0x275c('0x9')]);_0x54c282(_0x50b3a9,_0x563239,_0x59d629),this[_0x275c('0x6')]({'attributes':_0x50b3a9});}[_0x275c('0x2')](_0xfe6e0c){const _0x351236=_0x55b949(this[_0x275c('0x9')]);_0x5e8431(_0x351236,_0xfe6e0c),this[_0x275c('0x6')]({'attributes':_0x351236});}[_0x275c('0x6')](_0x539cd5,_0x450352=!0x1){let _0x9ac47b=!0x1;const _0x4030b9={'id':this['id']},_0x32e498=[_0x275c('0xd'),_0x275c('0x7'),_0x275c('0xe'),'authors',_0x275c('0x9'),'toVersion',_0x275c('0x0'),_0x275c('0x8')];for(const _0x12c32d of _0x32e498){const _0x57527c=_0x539cd5[_0x12c32d];void 0x0!==_0x57527c&&_0x57527c!==this[_0x12c32d]&&(this[_0x12c32d]=_0x57527c,_0x4030b9[_0x12c32d]=_0x57527c,_0x9ac47b=!0x0);}_0x9ac47b&&(_0x4030b9['authors']&&(_0x4030b9[_0x275c('0x1')]=_0x4030b9[_0x275c('0xb')][_0x275c('0x4')](_0x55e037=>_0x55e037['id']),delete _0x4030b9['authors']),this[_0x275c('0xa')](_0x275c('0x6'),_0x4030b9,_0x450352));}['toJSON'](){return{'id':this['id'],'name':this[_0x275c('0xd')],'creatorId':this['creator']?this[_0x275c('0xc')]['id']:null,'authorsIds':this[_0x275c('0xb')][_0x275c('0x4')](_0x492a95=>_0x492a95['id']),'diffData':this[_0x275c('0xe')],'createdAt':this['createdAt'],'attributes':this[_0x275c('0x9')],'fromVersion':this[_0x275c('0x0')],'toVersion':this[_0x275c('0x5')]};}}

package/src/revisiondiff.d.ts

@@ -1,20 +1,20 @@
-/**
- * @module revision-history/revisiondiff
- */
-import { Collection } from 'ckeditor5/src/utils';
-import type { DocumentFragment } from 'ckeditor5/src/engine';
-import type ChangeItem from './changeitem';
-/**
- * Represents a difference between two document revisions.
- */
-export default class RevisionDiff {
-    readonly newRevisionId: string;
-    readonly oldRevisionId: string;
-    readonly changes: Collection<ChangeItem>;
-    constructor(newRevisionId: string, oldRevisionId: string);
-}
-export interface DiffData {
-    model: Record<string, DocumentFragment>;
-    attributes: Record<string, Record<string, unknown>>;
-    changes: Array<ChangeItem>;
-}
+/**
+ * @module revision-history/revisiondiff
+ */
+import { Collection } from 'ckeditor5/src/utils.js';
+import type { DocumentFragment } from 'ckeditor5/src/engine.js';
+import type ChangeItem from './changeitem.js';
+/**
+ * Represents a difference between two document revisions.
+ */
+export default class RevisionDiff {
+    readonly newRevisionId: string;
+    readonly oldRevisionId: string;
+    readonly changes: Collection<ChangeItem>;
+    constructor(newRevisionId: string, oldRevisionId: string);
+}
+export interface DiffData {
+    model: Record<string, DocumentFragment>;
+    attributes: Record<string, Record<string, unknown>>;
+    changes: Array<ChangeItem>;
+}

package/src/revisiondiff.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x3abe=['changes','_setChanges','oldRevisionId','newRevisionId','add'];(function(_0x426d03,_0x3abebc){const _0x1d0825=function(_0x4df4f6){while(--_0x4df4f6){_0x426d03['push'](_0x426d03['shift']());}};_0x1d0825(++_0x3abebc);}(_0x3abe,0x17b));const _0x1d08=function(_0x426d03,_0x3abebc){_0x426d03=_0x426d03-0x0;let _0x1d0825=_0x3abe[_0x426d03];return _0x1d0825;};import{Collection as _0x4985b7}from'ckeditor5/src/utils';export default class f{constructor(_0x338d0f,_0x265a4b){this[_0x1d08('0x4')]=_0x338d0f,this[_0x1d08('0x3')]=_0x265a4b,this[_0x1d08('0x1')]=new _0x4985b7();}[_0x1d08('0x2')](_0x27e585){for(const _0x3fd250 of _0x27e585)this[_0x1d08('0x1')][_0x1d08('0x0')](_0x3fd250);}}
+const _0x2330=['add','oldRevisionId','changes','_setChanges','newRevisionId'];(function(_0x124861,_0x233078){const _0x254da0=function(_0x2bfc0e){while(--_0x2bfc0e){_0x124861['push'](_0x124861['shift']());}};_0x254da0(++_0x233078);}(_0x2330,0xb0));const _0x254d=function(_0x124861,_0x233078){_0x124861=_0x124861-0x0;let _0x254da0=_0x2330[_0x124861];return _0x254da0;};import{Collection as _0x532236}from'ckeditor5/src/utils.js';export default class f{constructor(_0x3ac89b,_0x5a52e0){this[_0x254d('0x3')]=_0x3ac89b,this[_0x254d('0x0')]=_0x5a52e0,this['changes']=new _0x532236();}[_0x254d('0x2')](_0x1613b7){for(const _0x3171b5 of _0x1613b7)this[_0x254d('0x1')][_0x254d('0x4')](_0x3171b5);}}

package/src/revisionhistory.d.ts

@@ -1,95 +1,95 @@
-/**
- * @module revision-history/revisionhistory
- * @publicApi
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-import type { Item, Position } from 'ckeditor5/src/engine';
-import RevisionTracker from './revisiontracker';
-import RevisionHistoryUI from './ui/revisionhistory/revisionhistoryui';
-import type { default as Revision, RevisionJSON } from './revision';
-import type { RevisionHistoryAdapter } from './revisionhistoryadapter';
-/**
- * The revision history feature.
- *
- * Enables tracking and bundling changes into revisions as well as provides the default UI for browsing revisions.
- *
- * To learn more about the revision history feature refer to the
- * {@glink features/collaboration/revision-history/revision-history Revision history} guide.
- */
-export default class RevisionHistory extends Plugin {
-    static get pluginName(): "RevisionHistory";
-    static get requires(): readonly [typeof RevisionTracker, typeof RevisionHistoryUI];
-    constructor(editor: Editor);
-    /**
-     * An adapter object that should communicate with the data source to fetch or save the revisions data.
-     */
-    set adapter(adapter: RevisionHistoryAdapter | null);
-    get adapter(): RevisionHistoryAdapter | null;
-    /**
-     * Creates a revision basing on given revision data and adds it to the revision tracker and revision repository.
-     *
-     * The parameter of this method should be an object with revision data. You can receive such an object by calling
-     * {@link module:revision-history/revisionhistory~RevisionHistory#getRevisions `RevisionHistory#getRevisions( { toJSON: true } )`}
-     * or {@link module:revision-history/revision~Revision#toJSON `Revision#toJSON()`}.
-     *
-     * ```ts
-     * // Get revisions data in an appropriate format.
-     * // You can save it in your database.
-     * const revisionsData = revisionHistory.getRevisions( { toJSON: true } );
-     * // ...
-     * // Use revisions data.
-     * // That revisions data might be loaded from your database.
-     * revisionsData.forEach( revisionData => revisionHistory.addRevisionData( revisionData ) );
-     * ```
-     */
-    addRevisionData(revisionData: RevisionJSON): Revision;
-    /**
-     * Returns the revision with a given revision id or at a given index.
-     */
-    getRevision(revisionIdOrIndex: string | number): Revision | null;
-    getRevisions(options: {
-        toJSON: true;
-    }): Array<RevisionJSON>;
-    getRevisions(options: {
-        toJSON: false;
-    }): Array<Revision>;
-    getRevisions(options: {
-        toJSON: boolean;
-    }): Array<Revision> | Array<RevisionJSON>;
-}
-export interface TapeValue {
-    id?: number;
-    type: 'elementStart' | 'elementEnd' | 'text';
-    item: TapeItem;
-    previousPosition?: Position;
-    nextPosition?: Position;
-    isAdded?: {
-        userId: string;
-    } | boolean;
-    isRemoved?: {
-        userId: string;
-    };
-    pairId?: number | null;
-    markersStart?: Array<string>;
-    markersEnd?: Array<string>;
-    isIncorrect?: boolean;
-    distance?: number;
-    isAddSuggestion?: {
-        userId: string;
-        type: string;
-        name: string;
-    };
-    isRemoveSuggestion?: {
-        userId: string;
-        type: string;
-        name: string;
-    };
-    side?: number;
-    level?: number;
-    index?: number;
-}
-export type TapeItem = Item & {
-    name: string;
-    startIndex?: number;
-    endIndex?: number;
-};
+/**
+ * @module revision-history/revisionhistory
+ * @publicApi
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import type { Item, Position } from 'ckeditor5/src/engine.js';
+import RevisionTracker from './revisiontracker.js';
+import RevisionHistoryUI from './ui/revisionhistory/revisionhistoryui.js';
+import type { default as Revision, RevisionJSON } from './revision.js';
+import type { RevisionHistoryAdapter } from './revisionhistoryadapter.js';
+/**
+ * The revision history feature.
+ *
+ * Enables tracking and bundling changes into revisions as well as provides the default UI for browsing revisions.
+ *
+ * To learn more about the revision history feature refer to the
+ * {@glink features/collaboration/revision-history/revision-history Revision history} guide.
+ */
+export default class RevisionHistory extends Plugin {
+    static get pluginName(): "RevisionHistory";
+    static get requires(): readonly [typeof RevisionTracker, typeof RevisionHistoryUI];
+    constructor(editor: Editor);
+    /**
+     * An adapter object that should communicate with the data source to fetch or save the revisions data.
+     */
+    set adapter(adapter: RevisionHistoryAdapter | null);
+    get adapter(): RevisionHistoryAdapter | null;
+    /**
+     * Creates a revision basing on given revision data and adds it to the revision tracker and revision repository.
+     *
+     * The parameter of this method should be an object with revision data. You can receive such an object by calling
+     * {@link module:revision-history/revisionhistory~RevisionHistory#getRevisions `RevisionHistory#getRevisions( { toJSON: true } )`}
+     * or {@link module:revision-history/revision~Revision#toJSON `Revision#toJSON()`}.
+     *
+     * ```ts
+     * // Get revisions data in an appropriate format.
+     * // You can save it in your database.
+     * const revisionsData = revisionHistory.getRevisions( { toJSON: true } );
+     * // ...
+     * // Use revisions data.
+     * // That revisions data might be loaded from your database.
+     * revisionsData.forEach( revisionData => revisionHistory.addRevisionData( revisionData ) );
+     * ```
+     */
+    addRevisionData(revisionData: RevisionJSON): Revision;
+    /**
+     * Returns the revision with a given revision id or at a given index.
+     */
+    getRevision(revisionIdOrIndex: string | number): Revision | null;
+    getRevisions(options: {
+        toJSON: true;
+    }): Array<RevisionJSON>;
+    getRevisions(options: {
+        toJSON: false;
+    }): Array<Revision>;
+    getRevisions(options: {
+        toJSON: boolean;
+    }): Array<Revision> | Array<RevisionJSON>;
+}
+export interface TapeValue {
+    id?: number;
+    type: 'elementStart' | 'elementEnd' | 'text';
+    item: TapeItem;
+    previousPosition?: Position;
+    nextPosition?: Position;
+    isAdded?: {
+        userId: string;
+    } | boolean;
+    isRemoved?: {
+        userId: string;
+    };
+    pairId?: number | null;
+    markersStart?: Array<string>;
+    markersEnd?: Array<string>;
+    isIncorrect?: boolean;
+    distance?: number;
+    isAddSuggestion?: {
+        userId: string;
+        type: string;
+        name: string;
+    };
+    isRemoveSuggestion?: {
+        userId: string;
+        type: string;
+        name: string;
+    };
+    side?: number;
+    level?: number;
+    index?: number;
+}
+export type TapeItem = Item & {
+    name: string;
+    startIndex?: number;
+    endIndex?: number;
+};