@ckeditor/ckeditor5-revision-history 44.1.0-alpha.5 → 44.2.0-alpha.0

package/dist/revision.d.ts

@@ -1,157 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { User } from 'ckeditor5-collaboration/src/collaboration-core.js';
-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 /* #__PURE__ -- @preserve */ 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/dist/revisiondiff.d.ts

@@ -1,28 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @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/dist/revisionhistory.d.ts

@@ -1,111 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @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";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    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;
-};

package/dist/revisionhistoryadapter.d.ts

@@ -1,68 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module revision-history/revisionhistoryadapter
- * @publicApi
- */
-import type { RevisionData } from './revision.js';
-/**
- * The revision history adapter.
- *
- * The revision history adapter is an object that communicates asynchronously with the data source to fetch or save
- * the revisions data. It is used internally by the revision history feature whenever revision data is required, a revision is created,
- * or updated.
- *
- * The adapter is optional. See the {@glink features/collaboration/revision-history/revision-history-integration
- * Revision history feature integration} guide to learn more.
- *
- * To set the adapter, overwrite the {@link module:revision-history/revisionhistory~RevisionHistory#adapter `RevisionHistory#adapter`}
- * property.
- */
-export interface RevisionHistoryAdapter {
-    /**
-     * Called when the full revision data is required.
-     *
-     * It should return a promise that resolves with the whole revision data.
-     */
-    getRevision(data: {
-        revisionId: string;
-        channelId: string;
-    }): Promise<RevisionData>;
-    /**
-     * Called when revision(s) data is added or updated.
-     *
-     * Multiple revisions can be added and updated at the same moment. The method is passed an array with the updated data.
-     * Each item in the array is a data object that describes a single revision. Each data object contains revision id. If the revision
-     * id does not exist in your data source (database), then a new revision should be created. Otherwise, the existing revision
-     * should be updated with passed data.
-     *
-     * The method should return a promise that is resolved when the update is completed.
-     *
-     * The `data` parameter only contains those properties of a revision that have changed.
-     *
-     * Although the `data` parameter contains `createdAt` property,
-     * the revision creation date should be set by the backend of your application
-     * to ensure that all revisions will be saved with correct dates regardless of users' local system time.
-     * It is recommended to overwrite `createdAt` value whenever it is passed in the `data` parameter.
-     *
-     * The promise may resolve with an array of objects. Each object represents an updated revision, for which `createdAt` property
-     * was set (or changed) on the backend. Each object should have `id` (string) and `createdAt` (`Date` object) properties.
-     * The returned data will be used to update revisions data in the editor with dates set on the backend.
-     *
-     * Although the `data` parameter contains `creatorId` property, you should verify the `creatorId` value when saving a revision
-     * in the database. **However, do not overwrite the value if it was set to `null`!**
-     *
-     * It is recommended to stringify `data.diffData` and `data.attributes` values to JSON and save them as strings in your database,
-     * and then to parse the strings when loading revisions.
-     *
-     * @param data Array with revisions data to add or update.
-     * @param channelId The ID of the document for which the revisions were created.
-     */
-    updateRevisions(data: Array<RevisionData>, channelId: string): Promise<Array<RevisionData>>;
-}

package/dist/revisionhistoryconfig.d.ts

@@ -1,75 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * The configuration of the revision history feature.
- *
- * ```ts
- * ClassicEditor
- *  	.create( {
- *			revisionHistory: ... // Revision history feature configuration.
- *		} )
- *		.then( ... )
- *		.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface RevisionHistoryConfig {
-    /**
-     * The DOM element that contains the DOM structure for the editor.
-     *
-     * This element will be hidden when the user opens the revision history.
-     */
-    editorContainer: HTMLElement;
-    /**
-     * DOM element which contains the DOM structure for revision history viewer.
-     *
-     * This element should be hidden (using CSS) when the editor is initialized.
-     * This element will be shown when the user opens the revision history viewer.
-     */
-    viewerContainer: HTMLElement;
-    /**
-     * The DOM element for the revision history viewer editor instance.
-     *
-     * This element will be used to initialize the revision history viewer editor instance and will be replaced by it. It should be empty.
-     */
-    viewerEditorElement: HTMLElement;
-    /**
-     * The DOM element for the revision history viewer sidebar container.
-     *
-     * This element will be used as a container for the revision history viewer. The sidebar content will be inserted into it.
-     */
-    viewerSidebarContainer: HTMLElement;
-    /**
-     * Tells the feature whether it should resume updating previously unsaved revision or should save the previously unsaved revision
-     * and create a new revision for the changes that will be introduced after the editor is initialized.
-     *
-     * By default, the previously unsaved revision is resumed after the editor is initialized.
-     *
-     * Note that only unsaved revision can be resumed.
-     *
-     * Note that for real-time collaboration, the unsaved revision will be always resumed if the real-time editing session is still active.
-     * In other words, even if this is set to `false`, the unsaved revision will be resumed, if the editing session did not end since the
-     * editor was re-initialized. Keep in mind that
-     * {@glink @cs guides/collaboration/data#temporary-and-permanent-data the editing session is active a long time} after the last user
-     * leaves the document.
-     */
-    resumeUnsavedRevision: boolean;
-    /**
-     * Indicates if the names for revisions should be required. Defaults to `false`.
-     *
-     * If set to `true`, the user will have to provide a name when saving a new revision.
-     * If they try to change the existing revision name to an empty string,
-     * the revision name will be reverted to the previous value.
-     *
-     * It will still be possible to save a revision without a name using the feature API
-     * and to load the existing nameless revisions.
-     */
-    requireRevisionName?: boolean;
-}

package/dist/revisionsrepository.d.ts

@@ -1,64 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module revision-history/revisionsrepository
- * @publicApi
- */
-import { Users } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { default as Revision, type RevisionData, type RevisionJSON } from './revision.js';
-/**
- * Manages revisions list.
- */
-export default class RevisionsRepository extends Plugin {
-    static get requires(): readonly [typeof Users];
-    static get pluginName(): "RevisionsRepository";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    get length(): number;
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Creates a revision instance from plain object with revision data.
-     */
-    createRevision(revisionData: RevisionData): Revision;
-    /**
-     * Adds revision to the repository on a given index.
-     *
-     * @param revision The revision instance to add.
-     * @param index Index on which the revision should be added. If not set, the revision will be added as the first revision.
-     */
-    addRevision(revision: Revision, index?: number): void;
-    /**
-     * 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>;
-    /**
-     * Returns the index of the revision with a given revision id.
-     */
-    getIndex(revisionId: string | Revision): number;
-}

package/dist/revisiontracker.d.ts

@@ -1,141 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module revision-history/revisiontracker
- * @publicApi
- */
-import { Users, type CollaborationHistory } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import { Plugin, PendingActions, type Editor } from 'ckeditor5/src/core.js';
-import RevisionsRepository from './revisionsrepository.js';
-import type { RevisionHistoryAdapter } from './revisionhistoryadapter.js';
-import type { default as Revision, RevisionData } from './revision.js';
-/**
- * Creates and updates revisions based on changes of the editor content.
- *
- * There are always at least two revisions available for the document: the initial revision and the current revision.
- * If those revisions have not been created for the document yet, they are created when the editor data is loaded.
- *
- * The initial revision contains the initial document data from when the document was loaded for the first time.
- *
- * The current revision contains all the unsaved document changes, that is changes which have not been saved yet as a specific revision.
- * The current revision is always available and it is always the "top" revision (most recent).
- */
-export default class RevisionTracker extends Plugin {
-    /**
-     * An adapter object that should communicate with the data source to fetch or save the revisions data.
-     *
-     * This property is also set through {@link module:revision-history/revisionhistory~RevisionHistory#adapter}.
-     */
-    adapter: RevisionHistoryAdapter | null;
-    repository?: RevisionsRepository;
-    static get pluginName(): "RevisionTracker";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    static get requires(): readonly [typeof Users, typeof RevisionsRepository, typeof PendingActions];
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    afterInit(): Promise<void>;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Adds the new document changes to the current revision.
-     *
-     * This method should be called before document data and revision data is saved (for example, in the autosave callback).
-     *
-     * @returns Promise that is resolved after the revision is updated locally (the promise does not wait for the adapter update).
-     */
-    update(): Promise<void>;
-    private _loadState;
-    /**
-     * Creates and saves a new revision.
-     *
-     * ```ts
-     * // Saves all the unsaved changes as a revision without a name.
-     * const myRevision = await revisionTracker.saveRevision();
-     *
-     * // Saves all the unsaved changes as a revision named 'My revision'.
-     * const myRevision = await revisionTracker.saveRevision( { name: 'My revision' } );
-     *
-     * // Saves a revision named 'My revision'.
-     * // It will include document data with all the changes up to document version `30`.
-     * // The revision will be on "top" of the closest revision with a lower document version.
-     * // The revision diff will include all the changes since the previous revision up to document version `30`.
-     * const myRevision = await revisionTracker.saveRevision( { name: 'My revision' }, 30 );
-     * ```
-     *
-     * A new revision can be created in the middle of the revision history. In such case, already existing revisions will be
-     * appropriately updated.
-     *
-     * Using this method, a revision without a name can be created even if the
-     * {@link module:revision-history/revisionhistoryconfig~RevisionHistoryConfig#requireRevisionName `requireRevisionName` }
-     * configuration option is set to `true`.
-     *
-     * @param revisionData Revision data to set on the created revision.
-     * @param version {@link module:engine/model/document~Document#version Document version} on which the revision is saved.
-     * If not set, the revision will be saved for the current (most recent) document state.
-     * @returns Promise that resolves with the created revision after it is saved locally (the promise does not wait for the
-     * adapter update).
-     */
-    saveRevision(revisionData?: RevisionData, version?: number | null): Promise<Revision>;
-    /**
-     * Creates a revision basing on given revision data and adds it to the revision tracker and revision repository.
-     */
-    addRevisionData(revisionData: RevisionData): Revision;
-    /**
-     * Returns document data for given revision.
-     *
-     * The document data is HTML or other format, depending on the editor configuration.
-     *
-     * This method returns a promise which resolves with an object, where keys are root names and values are these roots' data. Most
-     * editor setups use just one root, which has the default name `main`. In this case, the promise will resolve with an object
-     * similar to this:
-     *
-     * ```ts
-     * { main: "<p>Sample document data.</p>" }
-     * ```
-     *
-     * Please note, that the data returned by this method uses
-     * {@link module:engine/dataprocessor/dataprocessor~DataProcessor#useFillerType marked fillers mode}. This means that some `&nbsp;`
-     * characters in the returned data may be wrapped with `<span data-cke-filler="true">&nbsp;</span>`. Take this difference into
-     * consideration if you plan to compare revision data with the data returned by `editor.getData()`.
-     *
-     * See also {@link module:revision-history/revisiontracker~RevisionTracker#getRevisionRootsAttributes}.
-     */
-    getRevisionDocumentData(revision: Revision): Promise<Record<string, string>>;
-    /**
-     * Returns roots attributes for given revision.
-     *
-     * This method returns a promise which resolves with an object, where keys are root names and values are these roots' attributes.
-     * Most editor setups use just one root, which has the default name `main`. In this case, the promise will resolve with an object
-     * similar to this:
-     *
-     * ```ts
-     * { main: {} }
-     * ```
-     *
-     * See also {@link module:revision-history/revisiontracker~RevisionTracker#getRevisionDocumentData}.
-     */
-    getRevisionRootsAttributes(revision: Revision): Promise<Record<string, Record<string, unknown>>>;
-}
-export interface RevisionSource {
-    history: CollaborationHistory;
-    getLatestVersion: () => Promise<number>;
-    getCurrentRevisionId: () => string;
-}