@ckeditor/ckeditor5-track-changes 41.3.1 → 41.4.0-alpha.0

package/dist/types/integrations/mediaembed.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/mediaembed
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for {@link module:media-embed/mediaembed~MediaEmbed media embed feature}.
+ */
+export default class TrackChangesMediaEmbed extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/mention.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/mention
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for mention feature.
+ */
+export default class TrackChangesMention extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/multilevellist.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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 track-changes/integrations/multilevellist
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import type Suggestion from '../suggestion.js';
+import type { Description } from '../suggestiondescriptionfactory.js';
+/**
+ * Provides track changes plugin integration for multi-level list feature.
+ */
+export default class TrackChangesMultiLevelList extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Returns a custom description for a suggestion in case of adding or removing `listMarkerStyle` attribute.
+     * Returns an empty description if the change is already covered by a `listType` attribute suggestion.
+     */
+    handleDescriptions(suggestion: Suggestion): Description | undefined;
+}

package/dist/types/integrations/pagebreak.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/pagebreak
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for {@link module:page-break/pagebreak~PageBreak page break feature}.
+ */
+export default class TrackChangesPageBreak extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/paragraph.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/paragraph
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for paragraph feature.
+ */
+export default class TrackChangesParagraph extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/removeformat.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/removeformat
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for remove format feature.
+ */
+export default class TrackChangesRemoveFormat extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/restrictededitingmode.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/mention
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for restricted editing mode feature from restricted editing package.
+ */
+export default class TrackChangesRestrictedEditingMode extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/shiftentercommand.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 track-changes/integrations/shiftentercommand
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { ShiftEnter } from 'ckeditor5/src/enter.js';
+/**
+ * Provides track changes plugin integration for {@link module:enter/shiftentercommand~ShiftEnterCommand enter command}.
+ */
+export default class TrackChangesShiftEnterCommand extends Plugin {
+    static get requires(): readonly [typeof ShiftEnter];
+    init(): void;
+}

package/dist/types/integrations/standardeditingmode.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/mention
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for standard editing mode feature from restricted editing package.
+ */
+export default class TrackChangesStandardEditingMode extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/style.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/style
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+  * Provides track changes plugin integration for styles dropdown feature.
+  */
+export default class TrackChangesStylesDropdown extends Plugin {
+    /**
+      * @inheritDoc
+      */
+    afterInit(): void;
+}

package/dist/types/integrations/table.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @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 track-changes/integrations/table
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for {@link module:table/table~Table table feature}.
+ */
+export default class TrackChangesTable extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}
+/**
+ * Coordinates for suggestion.
+ */
+export interface SuggestionCoordinates {
+    /**
+     * Index of the row at which the suggestion starts.
+     */
+    minRow: number;
+    /**
+     * Index of the row at which the suggestion ends.
+     */
+    maxRow: number;
+    /**
+     * Index of the column at which the suggestion starts.
+     */
+    minColumn: number;
+    /**
+     * Index of the column at which the suggestion ends.
+     */
+    maxColumn: number;
+}

package/dist/types/integrations/tablecaption.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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 track-changes/integrations/tablecaption
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import TrackChangesTable from './table.js';
+/**
+ * Provides track changes plugin integration for {@link module:table/table~Table table feature} caption.
+ */
+export default class TrackChangesTableCaption extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TrackChangesTable];
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/tableclipboard.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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 { Plugin } from 'ckeditor5/src/core.js';
+import TrackChangesTable from './table.js';
+/**
+ * Provides track changes plugin integration for {@link module:table/tableclipboard~TableClipboard table clipboard feature}.
+ */
+export default class TrackChangesTableClipboard extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TrackChangesTable];
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/tablecolumnresize.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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 track-changes/integrations/tablecolumnresize
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import type { Element } from 'ckeditor5/src/engine.js';
+import type Suggestion from '../suggestion.js';
+import type { Description } from '../suggestiondescriptionfactory.js';
+/**
+ * Provides track changes plugin integration for table column resize feature.
+ */
+export default class TrackChangesTableColumnResize extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    handleResizeTableWidthCommand(executeCommand: Function, options: {
+        table?: Element;
+        tableWidth?: string;
+        columnWidths?: string;
+    }): void;
+    handleSuggestionDescription(suggestion: Suggestion): Description | undefined;
+}

package/dist/types/integrations/tableheadings.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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 track-changes/integrations/tableheadings
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import TrackChangesTable from './table.js';
+/**
+ * Provides track changes plugin integration for {@link module:table/table~Table table feature} heading rows/columns.
+ */
+export default class TrackChangesTableHeadings extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TrackChangesTable];
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/tablemergesplit.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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 track-changes/integrations/tablemergesplit
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import TrackChangesTable from './table.js';
+/**
+ * Provides track changes plugin integration for {@link module:table/table~Table table feature} merging and splitting cells.
+ */
+export default class TrackChangesTableMergeSplit extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TrackChangesTable];
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/tableofcontents.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/tableofcontents
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for the Table of contents feature.
+ */
+export default class TrackChangesTableOfContents extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/tableproperties.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 track-changes/integrations/tableproperties
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import type { Range } from 'ckeditor5/src/engine.js';
+import type { default as Suggestion } from '../suggestion.js';
+import type { Description } from '../suggestiondescriptionfactory.js';
+/**
+ * Provides track changes plugin integration for table properties feature.
+ */
+export default class TrackChangesTableProperties extends Plugin {
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TrackChangesTableProperties";
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    handleDiscardAction(properties: Array<string>, ranges: Array<Range>, data: any): void;
+    handleSuggestionDescription(suggestion: Suggestion): Description | undefined;
+}

package/dist/types/integrations/template.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/template
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for template feature.
+ */
+export default class TrackChangesTemplate extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/title.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/title
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for title feature.
+ */
+export default class TrackChangesTitle extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/undo.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 track-changes/integrations/undo
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * Provides track changes plugin integration for {@link module:undo/undo~Undo undo feature}.
+ */
+export default class TrackChangesUndo extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/integrations/utils.d.ts

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