@ckeditor/ckeditor5-track-changes 44.1.0 → 44.2.0-alpha.0

package/dist/trackchangesconfig.d.ts

@@ -1,89 +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 track-changes/trackchangesconfig
- * @publicApi
- */
-import type SuggestionThreadView from './ui/view/suggestionthreadview.js';
-import type SuggestionView from './ui/view/suggestionview.js';
-/**
- * The configuration of the track changes feature.
- *
- * Example:
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		// Track changes feature configuration.
- * 		trackChanges: {
- * 		// Do not allow users to comment suggestions (default is `false`).
- * 		disableComments: true,
- * 		// Do not track styling and formatting changes (default is `default`).
- * 		trackFormatChanges: 'never',
- * 		// Merges suggestion changes inside a block. (default is `true`).
- * 		mergeNestedSuggestions: true
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface TrackChangesConfig {
-    /**
-     * A property that specifies if the comments for suggestions are enabled or disabled.
-     * When the option is set to `true`, the comment thread UI for suggestions will be hidden
-     * and commenting suggestions will be disabled.
-     *
-     * Suggestion thread views will be marked with the additional `ck-suggestion--disabled-comments` class when the suggestion comments
-     * are disabled.
-     */
-    disableComments: boolean;
-    /**
-     * A property that specifies whether formatting changes should be tracked.
-     *
-     * Formatting changes are all changes other than insertions and deletions, including: styling, structure, widgets properties, etc.
-     *
-     * By default, formatting changes are tracked. However, if you make a formatting change inside your own insertion suggestion, it
-     * is immediately applied, without creating a suggestion.
-     *
-     * Possible values are:
-     *
-     * * `'default'` - format changes are tracked, but when made inside your own insertion suggestion, they will be immediately applied.
-     * * `'always'` - format changes will always be tracked, even inside your own insertion suggestion.
-     * * `'never'` - format changes will never be tracked (suggestions for such changes will not be created).
-     *
-     * Defaults to `'default'`.
-     */
-    trackFormatChanges: 'never' | 'default' | 'always';
-    /**
-     * Specifies whether suggestions on an object (e.g. image, table) should be automatically merged
-     * with suggestions inside the object (e.g. image caption, table cell).
-     *
-     * For example, when set to `true`, creating a table and writing some text inside the table will result in one suggestion.
-     * When set to `false`, it will be two separate suggestions, one for the inserted table and one for the inserted text.
-     *
-     * Keep in mind that only suggestions from the same author and of the same type are merged this way.
-     */
-    mergeNestedSuggestions: boolean;
-    /**
-     * A view class to be used to create suggestion thread views.
-     *
-     * {@link module:track-changes/ui/view/suggestionthreadview~SuggestionThreadView} is used by default
-     *  when this property is not set.
-     */
-    SuggestionThreadView?: typeof SuggestionThreadView;
-    /**
-     * A view class to be used to create the suggestion view.
-     *
-     * {@link module:track-changes/ui/view/suggestionview~SuggestionView} is used by default when this property is not set.
-     */
-    SuggestionView?: typeof SuggestionView;
-}

package/dist/trackchangesdata.d.ts

@@ -1,53 +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 track-changes/trackchangesdata
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import TrackChangesEditing from './trackchangesediting.js';
-/**
- * This plugin returns the editor data with accepted or discarded suggestions without modifying the editor content.
- */
-export default class TrackChangesData extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TrackChangesEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TrackChangesData";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Returns the editor data with all the suggestions accepted.
-     *
-     * @param options Options for {@link module:engine/controller/datacontroller~DataController#get}.
-     * @returns A promise which resolves with the output data.
-     */
-    getDataWithAcceptedSuggestions(options: Record<string, unknown>): Promise<string | Record<string, string>>;
-    /**
-     * Returns the editor data with all the suggestions discarded.
-     *
-     * @param options Options for {@link module:engine/controller/datacontroller~DataController#get}.
-     * @returns A promise which resolves with the output data.
-     */
-    getDataWithDiscardedSuggestions(options: Record<string, unknown>): Promise<string | Record<string, string>>;
-}