@ckeditor/ckeditor5-revision-history 39.0.1 → 40.0.0

package/src/revision.d.ts

@@ -1,153 +1,153 @@
-/**
- * @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 { 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 {};
+/**
+ * @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 { 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 {};

package/src/revision.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x5a6f=['creator','_update','attributes','createdAt','fromVersion','fire','setAttribute','map','removeAttribute','diffData','set','authors','toVersion','authorsIds','creatorId','name'];(function(_0x2dbc9c,_0x5a6fac){const _0x161bf=function(_0xcbb1f6){while(--_0xcbb1f6){_0x2dbc9c['push'](_0x2dbc9c['shift']());}};_0x161bf(++_0x5a6fac);}(_0x5a6f,0x124));const _0x161b=function(_0x2dbc9c,_0x5a6fac){_0x2dbc9c=_0x2dbc9c-0x0;let _0x161bf=_0x5a6f[_0x2dbc9c];return _0x161bf;};import{ObservableMixin as _0x21f89a,uid as _0x22dee8}from'ckeditor5/src/utils';import{cloneDeep as _0x571ce3,set as _0x1c4de1,unset as _0x331e54}from'lodash-es';export default class a extends _0x21f89a(){constructor(_0x1964bc){super(),this['id']=_0x1964bc['id']||_0x22dee8(),this['creator']=_0x1964bc[_0x161b('0xc')]||null,this[_0x161b('0x7')]=_0x1964bc[_0x161b('0x7')]||[],this[_0x161b('0x5')]=_0x1964bc['diffData']||null,this[_0x161b('0x8')]=_0x1964bc[_0x161b('0x8')]||0x0,this[_0x161b('0x0')]=_0x1964bc[_0x161b('0x0')]||0x0,this[_0x161b('0x6')](_0x161b('0xb'),_0x1964bc[_0x161b('0xb')]||''),this[_0x161b('0x6')]('createdAt',_0x1964bc[_0x161b('0xf')]||new Date()),this[_0x161b('0x6')](_0x161b('0xe'),_0x1964bc[_0x161b('0xe')]||{});}['setName'](_0x168f72){this[_0x161b('0xd')]({'name':_0x168f72});}[_0x161b('0x2')](_0x528e3a,_0x3fd551){const _0x5c067f=_0x571ce3(this[_0x161b('0xe')]);_0x1c4de1(_0x5c067f,_0x528e3a,_0x3fd551),this[_0x161b('0xd')]({'attributes':_0x5c067f});}[_0x161b('0x4')](_0x3cd6d7){const _0x3e57aa=_0x571ce3(this[_0x161b('0xe')]);_0x331e54(_0x3e57aa,_0x3cd6d7),this['_update']({'attributes':_0x3e57aa});}[_0x161b('0xd')](_0x40d3ab,_0x174fc3=!0x1){let _0x367713=!0x1;const _0x55748e={'id':this['id']},_0x566796=['name',_0x161b('0xf'),'diffData',_0x161b('0x7'),'attributes',_0x161b('0x8'),_0x161b('0x0'),_0x161b('0xa')];for(const _0x94e2de of _0x566796){const _0x26d799=_0x40d3ab[_0x94e2de];void 0x0!==_0x26d799&&_0x26d799!==this[_0x94e2de]&&(this[_0x94e2de]=_0x26d799,_0x55748e[_0x94e2de]=_0x26d799,_0x367713=!0x0);}_0x367713&&(_0x55748e[_0x161b('0x7')]&&(_0x55748e[_0x161b('0x9')]=_0x55748e[_0x161b('0x7')][_0x161b('0x3')](_0x29cff1=>_0x29cff1['id']),delete _0x55748e['authors']),this[_0x161b('0x1')](_0x161b('0xd'),_0x55748e,_0x174fc3));}['toJSON'](){return{'id':this['id'],'name':this['name'],'creatorId':this[_0x161b('0xc')]?this['creator']['id']:null,'authorsIds':this[_0x161b('0x7')]['map'](_0x42f1a2=>_0x42f1a2['id']),'diffData':this['diffData'],'createdAt':this[_0x161b('0xf')],'attributes':this['attributes'],'fromVersion':this[_0x161b('0x0')],'toVersion':this[_0x161b('0x8')]};}}
+const _0x12cc=['setAttribute','_update','setName','createdAt','map','diffData','fromVersion','name','authorsIds','toVersion','attributes','creatorId','authors','removeAttribute','set','creator'];(function(_0x46dff7,_0x12cc0f){const _0x4ca94c=function(_0x29bedf){while(--_0x29bedf){_0x46dff7['push'](_0x46dff7['shift']());}};_0x4ca94c(++_0x12cc0f);}(_0x12cc,0x18e));const _0x4ca9=function(_0x46dff7,_0x12cc0f){_0x46dff7=_0x46dff7-0x0;let _0x4ca94c=_0x12cc[_0x46dff7];return _0x4ca94c;};import{ObservableMixin as _0x3fef7e,uid as _0x168a4d}from'ckeditor5/src/utils';import{cloneDeep as _0x5aae24,set as _0xa0d48b,unset as _0x32a210}from'lodash-es';export default class a extends _0x3fef7e(){constructor(_0x3d4f89){super(),this['id']=_0x3d4f89['id']||_0x168a4d(),this['creator']=_0x3d4f89[_0x4ca9('0x1')]||null,this[_0x4ca9('0xe')]=_0x3d4f89[_0x4ca9('0xe')]||[],this[_0x4ca9('0x7')]=_0x3d4f89['diffData']||null,this[_0x4ca9('0xb')]=_0x3d4f89[_0x4ca9('0xb')]||0x0,this[_0x4ca9('0x8')]=_0x3d4f89[_0x4ca9('0x8')]||0x0,this[_0x4ca9('0x0')]('name',_0x3d4f89[_0x4ca9('0x9')]||''),this['set']('createdAt',_0x3d4f89[_0x4ca9('0x5')]||new Date()),this[_0x4ca9('0x0')](_0x4ca9('0xc'),_0x3d4f89['attributes']||{});}[_0x4ca9('0x4')](_0x1c29e4){this[_0x4ca9('0x3')]({'name':_0x1c29e4});}[_0x4ca9('0x2')](_0xc477b1,_0x4220a6){const _0x33f19f=_0x5aae24(this[_0x4ca9('0xc')]);_0xa0d48b(_0x33f19f,_0xc477b1,_0x4220a6),this[_0x4ca9('0x3')]({'attributes':_0x33f19f});}[_0x4ca9('0xf')](_0x1fb1e6){const _0x261647=_0x5aae24(this[_0x4ca9('0xc')]);_0x32a210(_0x261647,_0x1fb1e6),this[_0x4ca9('0x3')]({'attributes':_0x261647});}[_0x4ca9('0x3')](_0x50b982,_0x964490=!0x1){let _0x3579bd=!0x1;const _0x510c69={'id':this['id']},_0x13d190=['name','createdAt',_0x4ca9('0x7'),_0x4ca9('0xe'),_0x4ca9('0xc'),'toVersion','fromVersion',_0x4ca9('0xd')];for(const _0xa9df0b of _0x13d190){const _0x356476=_0x50b982[_0xa9df0b];void 0x0!==_0x356476&&_0x356476!==this[_0xa9df0b]&&(this[_0xa9df0b]=_0x356476,_0x510c69[_0xa9df0b]=_0x356476,_0x3579bd=!0x0);}_0x3579bd&&(_0x510c69[_0x4ca9('0xe')]&&(_0x510c69[_0x4ca9('0xa')]=_0x510c69['authors']['map'](_0x1008c5=>_0x1008c5['id']),delete _0x510c69[_0x4ca9('0xe')]),this['fire'](_0x4ca9('0x3'),_0x510c69,_0x964490));}['toJSON'](){return{'id':this['id'],'name':this['name'],'creatorId':this[_0x4ca9('0x1')]?this[_0x4ca9('0x1')]['id']:null,'authorsIds':this[_0x4ca9('0xe')][_0x4ca9('0x6')](_0x26912e=>_0x26912e['id']),'diffData':this[_0x4ca9('0x7')],'createdAt':this[_0x4ca9('0x5')],'attributes':this[_0x4ca9('0xc')],'fromVersion':this[_0x4ca9('0x8')],'toVersion':this[_0x4ca9('0xb')]};}}

package/src/revisiondiff.d.ts

@@ -1,24 +1,24 @@
-/**
- * @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 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>;
-}
+/**
+ * @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 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>;
+}

package/src/revisiondiff.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x1487=['_setChanges','newRevisionId','changes','add'];(function(_0x24653e,_0x148735){const _0x2e7f53=function(_0x4a8c3c){while(--_0x4a8c3c){_0x24653e['push'](_0x24653e['shift']());}};_0x2e7f53(++_0x148735);}(_0x1487,0xfd));const _0x2e7f=function(_0x24653e,_0x148735){_0x24653e=_0x24653e-0x0;let _0x2e7f53=_0x1487[_0x24653e];return _0x2e7f53;};import{Collection as _0x214a08}from'ckeditor5/src/utils';export default class f{constructor(_0x5bbacc,_0x9b4999){this[_0x2e7f('0x0')]=_0x5bbacc,this['oldRevisionId']=_0x9b4999,this[_0x2e7f('0x1')]=new _0x214a08();}[_0x2e7f('0x3')](_0x5efbdc){for(const _0x293b84 of _0x5efbdc)this['changes'][_0x2e7f('0x2')](_0x293b84);}}
+const _0x48ba=['changes','add','_setChanges','newRevisionId'];(function(_0x2e6e8f,_0x48ba71){const _0x2418e1=function(_0x2b477f){while(--_0x2b477f){_0x2e6e8f['push'](_0x2e6e8f['shift']());}};_0x2418e1(++_0x48ba71);}(_0x48ba,0x127));const _0x2418=function(_0x2e6e8f,_0x48ba71){_0x2e6e8f=_0x2e6e8f-0x0;let _0x2418e1=_0x48ba[_0x2e6e8f];return _0x2418e1;};import{Collection as _0xcf340e}from'ckeditor5/src/utils';export default class f{constructor(_0x39c5f1,_0x5c167b){this[_0x2418('0x0')]=_0x39c5f1,this['oldRevisionId']=_0x5c167b,this[_0x2418('0x1')]=new _0xcf340e();}[_0x2418('0x3')](_0x180de3){for(const _0x2cc9c7 of _0x180de3)this['changes'][_0x2418('0x2')](_0x2cc9c7);}}

package/src/revisionhistory.d.ts

@@ -1,99 +1,99 @@
-/**
- * @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 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;
-};
+/**
+ * @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 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;
+};