@ckeditor/ckeditor5-find-and-replace 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/augmentation.d.ts

@@ -1,28 +1,28 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { FindAndReplace, FindAndReplaceEditing, FindAndReplaceUI, FindAndReplaceUtils, FindCommand, FindNextCommand, FindPreviousCommand, ReplaceAllCommand, ReplaceCommand, FindAndReplaceConfig } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [FindAndReplace.pluginName]: FindAndReplace;
-        [FindAndReplaceEditing.pluginName]: FindAndReplaceEditing;
-        [FindAndReplaceUI.pluginName]: FindAndReplaceUI;
-        [FindAndReplaceUtils.pluginName]: FindAndReplaceUtils;
-    }
-    interface CommandsMap {
-        find: FindCommand;
-        findNext: FindNextCommand;
-        findPrevious: FindPreviousCommand;
-        replace: ReplaceCommand;
-        replaceAll: ReplaceAllCommand;
-    }
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:find-and-replace/findandreplace~FindAndReplace}.
-         *
-         * Read more in {@link module:find-and-replace/findandreplaceconfig~FindAndReplaceConfig}.
-         */
-        findAndReplace?: FindAndReplaceConfig;
-    }
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import type { FindAndReplace, FindAndReplaceEditing, FindAndReplaceUI, FindAndReplaceUtils, FindCommand, FindNextCommand, FindPreviousCommand, ReplaceAllCommand, ReplaceCommand, FindAndReplaceConfig } from "./index.js";
+declare module "@ckeditor/ckeditor5-core" {
+	interface PluginsMap {
+		[FindAndReplace.pluginName]: FindAndReplace;
+		[FindAndReplaceEditing.pluginName]: FindAndReplaceEditing;
+		[FindAndReplaceUI.pluginName]: FindAndReplaceUI;
+		[FindAndReplaceUtils.pluginName]: FindAndReplaceUtils;
+	}
+	interface CommandsMap {
+		find: FindCommand;
+		findNext: FindNextCommand;
+		findPrevious: FindPreviousCommand;
+		replace: ReplaceCommand;
+		replaceAll: ReplaceAllCommand;
+	}
+	interface EditorConfig {
+		/**
+		* The configuration of the {@link module:find-and-replace/findandreplace~FindAndReplace}.
+		*
+		* Read more in {@link module:find-and-replace/findandreplaceconfig~FindAndReplaceConfig}.
+		*/
+		findAndReplace?: FindAndReplaceConfig;
+	}
 }

package/dist/findandreplace.d.ts

@@ -1,46 +1,46 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module find-and-replace/findandreplace
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { FindAndReplaceUI } from './findandreplaceui.js';
-import { FindAndReplaceEditing } from './findandreplaceediting.js';
-import type { Marker } from '@ckeditor/ckeditor5-engine';
+* @module find-and-replace/findandreplace
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { FindAndReplaceUI } from "./findandreplaceui.js";
+import { FindAndReplaceEditing } from "./findandreplaceediting.js";
+import type { Marker } from "@ckeditor/ckeditor5-engine";
 export type FindResultType = {
-    id?: string;
-    label?: string;
-    start?: number;
-    end?: number;
-    marker?: Marker;
+	id?: string;
+	label?: string;
+	start?: number;
+	end?: number;
+	marker?: Marker;
 };
 /**
- * The find and replace plugin.
- *
- * For a detailed overview, check the {@glink features/find-and-replace Find and replace feature documentation}.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * The {@link module:find-and-replace/findandreplaceediting~FindAndReplaceEditing find and replace editing feature},
- * * The {@link module:find-and-replace/findandreplaceui~FindAndReplaceUI find and replace UI feature}
- */
+* The find and replace plugin.
+*
+* For a detailed overview, check the {@glink features/find-and-replace Find and replace feature documentation}.
+*
+* This is a "glue" plugin which loads the following plugins:
+*
+* * The {@link module:find-and-replace/findandreplaceediting~FindAndReplaceEditing find and replace editing feature},
+* * The {@link module:find-and-replace/findandreplaceui~FindAndReplaceUI find and replace UI feature}
+*/
 export declare class FindAndReplace extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FindAndReplaceEditing, typeof FindAndReplaceUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FindAndReplace";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[FindAndReplaceEditing, FindAndReplaceUI]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "FindAndReplace";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/findandreplaceconfig.d.ts

@@ -1,31 +1,31 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module find-and-replace/findandreplaceconfig
- */
+* @module find-and-replace/findandreplaceconfig
+*/
 /**
- * The configuration of the find and replace feature.
- * The option is used by the {@link module:find-and-replace/findandreplace~FindAndReplace} feature.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     findAndReplace: ... // Find and replace feature config.
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the find and replace feature.
+* The option is used by the {@link module:find-and-replace/findandreplace~FindAndReplace} feature.
+*
+* ```ts
+* ClassicEditor
+*   .create( {
+*     findAndReplace: ... // Find and replace feature config.
+*   } )
+*   .then( ... )
+*   .catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface FindAndReplaceConfig {
-    /**
-     * The type of the find and replace UI opened by the `'findAndReplace'` button registered in the
-     * editor's {@link module:ui/componentfactory~ComponentFactory component factory}
-     *
-     * The default value is `'dialog'`.
-     */
-    uiType?: 'dialog' | 'dropdown';
+	/**
+	* The type of the find and replace UI opened by the `'findAndReplace'` button registered in the
+	* editor's {@link module:ui/componentfactory~ComponentFactory component factory}
+	*
+	* The default value is `'dialog'`.
+	*/
+	uiType?: "dialog" | "dropdown";
 }

package/dist/findandreplaceediting.d.ts

@@ -1,76 +1,76 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module find-and-replace/findandreplaceediting
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { type Collection } from '@ckeditor/ckeditor5-utils';
-import { type FindAttributes } from './findcommand.js';
-import { FindAndReplaceState, type FindCallback } from './findandreplacestate.js';
-import { FindAndReplaceUtils } from './findandreplaceutils.js';
-import type { FindResultType } from './findandreplace.js';
-import '../theme/findandreplace.css';
+* @module find-and-replace/findandreplaceediting
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { type Collection } from "@ckeditor/ckeditor5-utils";
+import { type FindAttributes } from "./findcommand.js";
+import { FindAndReplaceState, type FindCallback } from "./findandreplacestate.js";
+import { FindAndReplaceUtils } from "./findandreplaceutils.js";
+import type { FindResultType } from "./findandreplace.js";
+import "../theme/findandreplace.css";
 /**
- * Implements the editing part for find and replace plugin. For example conversion, commands etc.
- */
+* Implements the editing part for find and replace plugin. For example conversion, commands etc.
+*/
 export declare class FindAndReplaceEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FindAndReplaceUtils];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FindAndReplaceEditing";
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    static get licenseFeatureCode(): string;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * An object storing the find and replace state within a given editor instance.
-     */
-    state?: FindAndReplaceState;
-    /**
-     * A flag that indicates that the user has started a search and the editor is listening for changes
-     * to the text on which it will perform an automatic search. Among other things, the mode is activated
-     * when the user first clicks 'Find' button and then later deactivated when the modal or search dropdown is closed.
-     *
-     * @internal
-     */
-    _isSearchActive: boolean;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Initiate a search.
-     */
-    find(callbackOrText: string | FindCallback, findAttributes?: FindAttributes): Collection<FindResultType>;
-    /**
-     * Stops active results from updating, and clears out the results.
-     */
-    stop(): void;
-    /**
-     * Sets up the commands.
-     */
-    private _defineCommands;
-    /**
-     * Sets up the marker downcast converters for search results highlighting.
-     */
-    private _defineConverters;
-    /**
-     * Reacts to document changes in order to update search list.
-     */
-    private _onDocumentChange;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[FindAndReplaceUtils]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "FindAndReplaceEditing";
+	/**
+	* @inheritDoc
+	* @internal
+	*/
+	static get licenseFeatureCode(): string;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* An object storing the find and replace state within a given editor instance.
+	*/
+	state?: FindAndReplaceState;
+	/**
+	* A flag that indicates that the user has started a search and the editor is listening for changes
+	* to the text on which it will perform an automatic search. Among other things, the mode is activated
+	* when the user first clicks 'Find' button and then later deactivated when the modal or search dropdown is closed.
+	*
+	* @internal
+	*/
+	_isSearchActive: boolean;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Initiate a search.
+	*/
+	find(callbackOrText: string | FindCallback, findAttributes?: FindAttributes): Collection<FindResultType>;
+	/**
+	* Stops active results from updating, and clears out the results.
+	*/
+	stop(): void;
+	/**
+	* Sets up the commands.
+	*/
+	private _defineCommands;
+	/**
+	* Sets up the marker downcast converters for search results highlighting.
+	*/
+	private _defineConverters;
+	/**
+	* Reacts to document changes in order to update search list.
+	*/
+	private _onDocumentChange;
 }

package/dist/findandreplacestate.d.ts

@@ -1,120 +1,117 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module find-and-replace/findandreplacestate
- */
-import type { Model, ModelItem } from '@ckeditor/ckeditor5-engine';
-import { Collection } from '@ckeditor/ckeditor5-utils';
-import type { FindResultType } from './findandreplace.js';
-declare const FindAndReplaceState_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
+* @module find-and-replace/findandreplacestate
+*/
+import type { Model, ModelItem } from "@ckeditor/ckeditor5-engine";
+import { Collection, type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import type { FindResultType } from "./findandreplace.js";
+declare const FindAndReplaceStateBase: ObservableMixinConstructor;
 /**
- * The object storing find and replace plugin state for a given editor instance.
- */
-export declare class FindAndReplaceState extends /* #__PURE__ */ FindAndReplaceState_base {
-    /**
-     * A collection of find matches.
-     *
-     * @observable
-     */
-    results: Collection<FindResultType>;
-    /**
-     * Currently highlighted search result in {@link #results matched results}.
-     *
-     * @readonly
-     * @observable
-     */
-    highlightedResult: FindResultType | null;
-    /**
-     * Currently highlighted search result offset in {@link #results matched results}.
-     *
-     * @readonly
-     * @observable
-     */
-    highlightedOffset: number;
-    /**
-     * Searched text value.
-     *
-     * @readonly
-     * @observable
-     */
-    searchText: string;
-    /**
-     *  The most recent search callback used by the feature to find matches.
-     *  It is used to re-run the search when user modifies the editor content.
-     *
-     * @readonly
-     * @observable
-     */
-    lastSearchCallback: FindCallback | null;
-    /**
-     * Replace text value.
-     *
-     * @readonly
-     * @observable
-     */
-    replaceText: string;
-    /**
-     * Indicates whether the matchCase checkbox has been checked.
-     *
-     * @readonly
-     * @observable
-     */
-    matchCase: boolean;
-    /**
-     * Indicates whether the matchWholeWords checkbox has been checked.
-     *
-     * @readonly
-     * @observable
-     */
-    matchWholeWords: boolean;
-    /**
-     * Creates an instance of the state.
-     */
-    constructor(model: Model);
-    /**
-     * Cleans the state up and removes markers from the model.
-     */
-    clear(model: Model): void;
-    /**
-     * Refreshes the highlight result offset based on it's index within the result list.
-     */
-    refreshHighlightOffset(model: Model): void;
+* The object storing find and replace plugin state for a given editor instance.
+*/
+export declare class FindAndReplaceState extends FindAndReplaceStateBase {
+	/**
+	* A collection of find matches.
+	*
+	* @observable
+	*/
+	results: Collection<FindResultType>;
+	/**
+	* Currently highlighted search result in {@link #results matched results}.
+	*
+	* @readonly
+	* @observable
+	*/
+	highlightedResult: FindResultType | null;
+	/**
+	* Currently highlighted search result offset in {@link #results matched results}.
+	*
+	* @readonly
+	* @observable
+	*/
+	highlightedOffset: number;
+	/**
+	* Searched text value.
+	*
+	* @readonly
+	* @observable
+	*/
+	searchText: string;
+	/**
+	*  The most recent search callback used by the feature to find matches.
+	*  It is used to re-run the search when user modifies the editor content.
+	*
+	* @readonly
+	* @observable
+	*/
+	lastSearchCallback: FindCallback | null;
+	/**
+	* Replace text value.
+	*
+	* @readonly
+	* @observable
+	*/
+	replaceText: string;
+	/**
+	* Indicates whether the matchCase checkbox has been checked.
+	*
+	* @readonly
+	* @observable
+	*/
+	matchCase: boolean;
+	/**
+	* Indicates whether the matchWholeWords checkbox has been checked.
+	*
+	* @readonly
+	* @observable
+	*/
+	matchWholeWords: boolean;
+	/**
+	* Creates an instance of the state.
+	*/
+	constructor(model: Model);
+	/**
+	* Cleans the state up and removes markers from the model.
+	*/
+	clear(model: Model): void;
+	/**
+	* Refreshes the highlight result offset based on it's index within the result list.
+	*/
+	refreshHighlightOffset(model: Model): void;
 }
 /**
- * Sorts search results by marker positions. Make sure that the results are sorted in the same order as they appear in the document
- * to avoid issues with the `find next` command. Apparently, the order of the results in the state might be different than the order
- * of the markers in the model.
- *
- * @internal
- */
+* Sorts search results by marker positions. Make sure that the results are sorted in the same order as they appear in the document
+* to avoid issues with the `find next` command. Apparently, the order of the results in the state might be different than the order
+* of the markers in the model.
+*
+* @internal
+*/
 export declare function sortSearchResultsByMarkerPositions(model: Model, results: Array<FindResultType>): Array<FindResultType>;
 /**
- * The callback function used to find matches in the document.
- */
+* The callback function used to find matches in the document.
+*/
 export type FindCallback = ({ item, text }: {
-    item: ModelItem;
-    text: string;
+	item: ModelItem;
+	text: string;
 }) => FindCallbackResultObject | FindCallbackResult;
 /**
- * Represents the result of a find callback.
- *
- * The `searchText` attribute in the result object is used to determine if the search text has changed.
- * If returned `searchText` is different than the last search text, the search results will be invalidated
- * while searching for next item and the search will start from the beginning of the document.
- */
+* Represents the result of a find callback.
+*
+* The `searchText` attribute in the result object is used to determine if the search text has changed.
+* If returned `searchText` is different than the last search text, the search results will be invalidated
+* while searching for next item and the search will start from the beginning of the document.
+*/
 export type FindCallbackResultObject = {
-    results: Array<FindResultType>;
-    searchText: string;
+	results: Array<FindResultType>;
+	searchText: string;
 };
 /**
- * Represents the result of a find callback.
- *
- * @deprecated Use `FindCallbackResultObject` instead.
- */
+* Represents the result of a find callback.
+*
+* @deprecated Use `FindCallbackResultObject` instead.
+*/
 export type FindCallbackResult = Array<FindResultType>;
 export {};