@ckeditor/ckeditor5-revision-history 41.3.0-alpha.3 → 41.3.0

package/dist/types/ui/revision/revisionview.d.ts

@@ -1,99 +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-oss-license
- */
-/**
- * @module revision-history/ui/revision/revisionview
- */
-import type { BaseEvent, Locale } from 'ckeditor5/src/utils.js';
-import { View, type DropdownView } from 'ckeditor5/src/ui.js';
-import RevisionNameView from './revisionnameview.js';
-import '../../../theme/revision/revision.css';
-import type Revision from '../../revision.js';
-import type { RevisionAction } from '../revisionssidebar/revisionssidebar.js';
-declare const RevisionView_base: import("ckeditor5/src/utils.js").Mixed<typeof View, import("@ckeditor/ckeditor5-collaboration-core/src/utils/confirmmixin.js").ConfirmApi>;
-/**
- * TODO
- */
-export default class RevisionView extends RevisionView_base {
-    id: string;
-    revisionNameView: RevisionNameView;
-    /**
-     * It holds the revision actions drop-down view if actions are provided,
-     * or just empty text otherwise.
-     */
-    revisionActionsView: DropdownView | '';
-    /**
-     * @observable
-     */
-    name: string;
-    /**
-     * @observable
-     */
-    createdAt: Date;
-    /**
-     * @observable
-     */
-    isSelected: boolean;
-    /**
-     * @observable
-     */
-    isHighlighted: boolean;
-    /**
-     * @observable
-     */
-    isActionsDropdownOpen: boolean;
-    /**
-     * @observable
-     */
-    isReady: boolean;
-    /**
-     * @observable
-     */
-    isEnabled: boolean;
-    constructor(locale: Locale, revision: Revision, revisionActions: Array<RevisionAction>, requireRevisionName: boolean);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * TODO
-     */
-    select(): void;
-    /**
-     * TODO
-     */
-    deselect(): void;
-    /**
-     * TODO
-     */
-    highlight(): void;
-    /**
-     * TODO
-     */
-    unhighlight(): void;
-}
-/**
- * @eventName setName | revisionSetName
- */
-export interface RevisionSetNameEvent extends BaseEvent {
-    name: 'setName' | 'revisionSetName';
-    args: [{
-        id: string;
-        name: string;
-    }];
-}
-/**
- * @eventName select | revisionSelected
- */
-export interface RevisionSelectedEvent extends BaseEvent {
-    name: 'select' | 'revisionSelected';
-    args: [{
-        id: string;
-    }];
-}
-export {};

package/dist/types/ui/revision/subrevisioncollapserview.d.ts

@@ -1,25 +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-oss-license
- */
-/**
- * @module revision-history/ui/revision/subrevisioncollapserview
- */
-import { View } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import '../../../theme/revision/subrevisioncollapser.css';
-export default class SubrevisionCollapserView extends View {
-    /**
-     * @observable
-     */
-    isVisible: boolean;
-    constructor(locale: Locale);
-    /**
-     * TODO
-     */
-    toggle(): void;
-}

package/dist/types/ui/revision/subrevisionview.d.ts

@@ -1,38 +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-oss-license
- */
-/**
- * @module revision-history/ui/revision/subrevisionview
- */
-import { View } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import '../../../theme/revision/subrevision.css';
-import type Revision from '../../revision.js';
-/**
- * TODO
- */
-export default class SubrevisionView extends View {
-    id: string;
-    /**
-     * @observable
-     */
-    createdAt: Date;
-    /**
-     * @observable
-     */
-    isSelected: boolean;
-    constructor(locale: Locale, subRevision: Revision, parentRevisionId: string);
-    /**
-     * TODO
-     */
-    select(): void;
-    /**
-     * TODO
-     */
-    deselect(): void;
-}

package/dist/types/ui/revision/utils.d.ts

@@ -1,9 +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-oss-license
- */
-export {};

package/dist/types/ui/revisionhistory/revisionhistorysaverevisionformview.d.ts

@@ -1,85 +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-oss-license
- */
-import { ButtonView, LabeledFieldView, View, type InputTextView } from 'ckeditor5/src/ui.js';
-import { type BaseEvent, FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import '../../../theme/revisionhistorysaverevisionform.css';
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-/**
- * The media form view controller class.
- *
- * See {@link module:media-embed/ui/mediaformview~MediaFormView}.
- */
-export default class RevisionHistorySaveRevisionFormView extends View {
-    /**
-     * Tracks information about the DOM focus in the form.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * The revision name input view.
-     */
-    revisionNameInputView: LabeledFieldView<InputTextView>;
-    /**
-     * The Save button view.
-     */
-    saveButtonView: ButtonView;
-    /**
-     * The Cancel button view.
-     */
-    cancelButtonView: ButtonView;
-    /**
-     * The value of the revision name input.
-     *
-     * @observable
-     */
-    revisionNameInputValue: string;
-    constructor(locale: Locale, requireRevisionName: boolean);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Focuses the fist {@link #_focusables} in the form.
-     */
-    focus(): void;
-    /**
-     * The native DOM `value` of the {@link #revisionNameInputView} element.
-     *
-     * **Note**: Do not confuse it with the {@link module:ui/inputtext/inputtextview~InputTextView#value}
-     * which works one way only and may not represent the actual state of the component in the DOM.
-     */
-    get revisionName(): string;
-    set revisionName(name: string);
-    /**
-     * TODO
-     */
-    reset(): void;
-}
-/**
- * Fired when the form view is submitted (when one of the children triggered the submit event),
- * e.g. click on {@link #saveButtonView}.
- *
- * @eventName submit
- */
-export interface SaveRevisionFormSubmitEvent extends BaseEvent {
-    name: 'submit';
-    args: [];
-}
-/**
- * Fired when the form view is canceled, e.g. by a click on {@link #cancelButtonView}.
- *
- * @eventName cancel
- */
-export interface SaveRevisionFormCancelEvent extends BaseEvent {
-    name: 'cancel';
-    args: [];
-}

package/dist/types/ui/revisionhistory/revisionhistoryui.d.ts

@@ -1,30 +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-oss-license
- */
-/**
- * @module revision-history/ui/revisionhistory/revisionhistoryui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import RevisionTracker from '../../revisiontracker.js';
-/**
- * TODO
- */
-export default class RevisionHistoryUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RevisionHistoryUI";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof RevisionTracker];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/types/ui/revisionssidebar/revisionssidebar.d.ts

@@ -1,48 +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-oss-license
- */
-/**
- * @module revision-history/ui/revisionsidebar/revisionsidebar
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import RevisionViewer from '../../revisionviewer.js';
-import type { default as RevisionView } from '../revision/revisionview.js';
-/**
- * TODO
- */
-export default class RevisionsSidebar extends Plugin {
-    static defaultRevisionActions: Array<string>;
-    static availableRevisionActions: Record<string, RevisionAction>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RevisionsSidebar";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof RevisionViewer];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}
-export interface RevisionAction {
-    name: string;
-    class?: string;
-    action: (editor: Editor, revisionView: RevisionView) => void;
-    isVisible?: (editor: Editor, revisionView: RevisionView) => boolean;
-    isEnabled?: (editor: Editor, revisionView: RevisionView) => boolean;
-}

package/dist/types/ui/revisionssidebar/revisionssidebarheaderview.d.ts

@@ -1,9 +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-oss-license
- */
-import '../../../theme/revisionssidebar/revisionssidebarheader.css';

package/dist/types/ui/revisionssidebar/revisionssidebartimeperiodview.d.ts

@@ -1,33 +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-oss-license
- */
-/**
- * @module revision-history/ui/revisionsidebar/revisionsidebartimeperiodview
- */
-import { View, type ViewCollection } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import RevisionView from '../revision/revisionview.js';
-import '../../../theme/revisionssidebar/revisionssidebartimeperiod.css';
-import type { RevisionAction } from './revisionssidebar.js';
-import type Revision from '../../revision.js';
-/**
- * TODO
- */
-export default class RevisionsSidebarTimePeriodView extends View {
-    startDate: Date;
-    revisionViews: ViewCollection<RevisionView>;
-    constructor(locale: Locale, startDate: Date, revisionActions: Array<RevisionAction>, requireRevisionName: boolean);
-    /**
-     * TODO
-     */
-    addRevision(newRevision: Revision): void;
-    /**
-     * TODO
-     */
-    removeRevision(revision: Revision): void;
-}

package/dist/types/ui/revisionssidebar/revisionssidebarview.d.ts

@@ -1,48 +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-oss-license
- */
-/**
- * @module revision-history/ui/revisionsidebar/revisionsidebarview
- */
-import { View, type ViewCollection } from 'ckeditor5/src/ui.js';
-import type { Locale, Collection } from 'ckeditor5/src/utils.js';
-import RevisionsSidebarTimePeriodView from './revisionssidebartimeperiodview.js';
-import '../../../theme/revisionssidebar/revisionssidebar.css';
-import type { default as RevisionView } from '../revision/revisionview.js';
-import type { RevisionAction } from './revisionssidebar.js';
-import type Revision from '../../revision.js';
-/**
- * TODO
- */
-export default class RevisionsSidebarView extends View {
-    timePeriodViews: ViewCollection<RevisionsSidebarTimePeriodView>;
-    /**
-     * @observable
-     */
-    isEnabled: boolean;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, revisions: Collection<Revision>, revisionActions: Array<RevisionAction>, _requireRevisionName: boolean);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * TODO
-     */
-    get revisionViews(): Array<RevisionView>;
-    /**
-     * TODO
-     */
-    selectRevision(revisionToSelect: Revision | null): void;
-    /**
-     * TODO
-     */
-    highlightRevisions(revisionsToHighlight: Array<Revision>): void;
-}

package/dist/types/ui/revisionssidebar/utils.d.ts

@@ -1,13 +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-oss-license
- */
-export declare function getDateTimePeriodInfo(jsDate: Date, locale: string): DateTimePeriod;
-export interface DateTimePeriod {
-    startDate: Date;
-    localizedPeriodName: string;
-}

package/dist/types/ui/revisionviewer/changedetailsview.d.ts

@@ -1,26 +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-oss-license
- */
-/**
- * @module revision-history/ui/revisionviewer/changedetailsview
- */
-import { View } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import type ChangeItem from '../../changeitem.js';
-export default class ChangeDetailsView extends View {
-    changeId: string;
-    /**
-     * @observable
-     */
-    type: string;
-    constructor(locale: Locale, model: ChangeItem);
-    /**
-     * Focuses the view.
-     */
-    focus(): void;
-}

package/dist/types/ui/revisionviewer/changesnavigationview.d.ts

@@ -1,44 +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-oss-license
- */
-/**
- * @module revision-history/ui/revisionviewer/changenaviagationview
- */
-import { View } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import '../../../theme/changesnavigation.css';
-/**
- * TODO
- */
-export default class ChangesNavigationView extends View {
-    /**
-     * @observable
-     */
-    isNavigationMode: boolean;
-    /**
-     * @observable
-     */
-    isReady: boolean;
-    /**
-     * @observable
-     */
-    currentChangeNumber: number;
-    /**
-     * @observable
-     */
-    numberOfChanges: number;
-    /**
-     * @observable
-     */
-    isForwardNavigationEnabled: boolean;
-    /**
-     * @observable
-     */
-    isBackwardNavigationEnabled: boolean;
-    constructor(locale: Locale);
-}

package/dist/types/ui/revisionviewer/revisionviewerloadingoverlay.d.ts

@@ -1,30 +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-oss-license
- */
-/**
- * @module revision-history/ui/revisionviewer/revisionviewerloadingoverlay
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import '../../../theme/revisionviewerloadingoverlay.css';
-/**
- * TODO
- */
-export default class RevisionViewerLoadingOverlay extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RevisionViewerLoadingOverlay";
-    /**
-     * TODO
-     */
-    show(): void;
-    /**
-     * TODO
-     */
-    hide(): void;
-}

package/dist/types/ui/revisionviewer/revisionviewerui.d.ts

@@ -1,32 +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-oss-license
- */
-/**
- * @module revision-history/ui/revisionviewer/revisionviewerui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import RevisionViewer from './../../revisionviewer.js';
-import RevisionViewerLoadingOverlay from './revisionviewerloadingoverlay.js';
-import '../../../theme/revisionviewer.css';
-/**
- * TODO
- */
-export default class RevisionViewerUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "RevisionViewerUI";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof RevisionViewer, typeof RevisionViewerLoadingOverlay];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/types/utils/common-translations.d.ts

@@ -1,15 +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-oss-license
- */
-/**
- * @module revision-history/utils/common-translations
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string, values?: TranslationValues): string;
-type TranslationValues = number | string | ReadonlyArray<number | string>;
-export {};