@ckeditor/ckeditor5-find-and-replace 36.0.0 → 37.0.0-alpha.0

package/src/findpreviouscommand.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace/findpreviouscommand
+*/
+import FindNextCommand from './findnextcommand';
+/**
+ * The find previous command. Moves the highlight to the previous search result.
+ *
+ * It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ */
+export default class FindPreviousCommand extends FindNextCommand {
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        'findPrevious': FindPreviousCommand;
+    }
+}

package/src/findpreviouscommand.js

@@ -2,30 +2,24 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module find-and-replace/findpreviouscommand
 */
-
 import FindNextCommand from './findnextcommand';
-
 /**
  * The find previous command. Moves the highlight to the previous search result.
  *
  * It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
- *
- * @extends module:find-and-replace/findnextcommand~FindNextCommand
  */
 export default class FindPreviousCommand extends FindNextCommand {
-	/**
-	 * @inheritDoc
-	 */
-	execute() {
-		const results = this._state.results;
-		const currentIndex = results.getIndex( this._state.highlightedResult );
-		const previousIndex = currentIndex - 1 < 0 ?
-			this._state.results.length - 1 : currentIndex - 1;
-
-		this._state.highlightedResult = this._state.results.get( previousIndex );
-	}
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        const results = this._state.results;
+        const currentIndex = results.getIndex(this._state.highlightedResult);
+        const previousIndex = currentIndex - 1 < 0 ?
+            this._state.results.length - 1 : currentIndex - 1;
+        this._state.highlightedResult = this._state.results.get(previousIndex);
+    }
 }

package/src/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace
+ */
+export { default as FindAndReplace } from './findandreplace';
+export { default as FindAndReplaceUtils } from './findandreplaceutils';

package/src/index.js

@@ -2,10 +2,8 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module find-and-replace
  */
-
 export { default as FindAndReplace } from './findandreplace';
 export { default as FindAndReplaceUtils } from './findandreplaceutils';

package/src/replaceallcommand.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace/replaceallcommand
+ */
+import { Collection } from 'ckeditor5/src/utils';
+import type { ResultType } from './findandreplace';
+import { ReplaceCommandBase } from './replacecommandbase';
+/**
+ * The replace all command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ */
+export default class ReplaceAllCommand extends ReplaceCommandBase {
+    /**
+     * Replaces all the occurrences of `textToReplace` with a given `newText` string.
+     *
+     * ```ts
+     *	replaceAllCommand.execute( 'replaceAll', 'new text replacement', 'text to replace' );
+     * ```
+     *
+     * Alternatively you can call it from editor instance:
+     *
+     * ```ts
+     *	editor.execute( 'replaceAll', 'new text', 'old text' );
+     * ```
+     *
+     * @param newText Text that will be inserted to the editor for each match.
+     * @param textToReplace Text to be replaced or a collection of matches
+     * as returned by the find command.
+     *
+     * @fires module:core/command~Command#event:execute
+     */
+    execute(newText: string, textToReplace: string | Collection<ResultType>): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        'replaceAll': ReplaceAllCommand;
+    }
+}

package/src/replaceallcommand.js

@@ -2,60 +2,46 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module find-and-replace/replaceallcommand
  */
-
 import { Collection } from 'ckeditor5/src/utils';
-import ReplaceCommand from './replacecommand';
-
+import { ReplaceCommandBase } from './replacecommandbase';
 /**
  * The replace all command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
- *
- * @extends module:find-and-replace/replacecommand~ReplaceCommand
  */
-export default class ReplaceAllCommand extends ReplaceCommand {
-	/**
-	 * Replaces all the occurrences of `textToReplace` with a given `newText` string.
-	 *
-	 * ```js
-	 *	replaceAllCommand.execute( 'replaceAll', 'new text replacement', 'text to replace' );
-	 * ```
-	 *
-	 * Alternatively you can call it from editor instance:
-	 *
-	 * ```js
-	 *	editor.execute( 'replaceAll', 'new text', 'old text' );
-	 * ```
-	 *
-	 * @param {String} newText Text that will be inserted to the editor for each match.
-	 * @param {String|module:utils/collection~Collection} textToReplace Text to be replaced or a collection of matches
-	 * as returned by the find command.
-	 *
-	 * @fires module:core/command~Command#event:execute
-	 */
-	execute( newText, textToReplace ) {
-		const { editor } = this;
-		const { model } = editor;
-		const findAndReplaceUtils = editor.plugins.get( 'FindAndReplaceUtils' );
-
-		const results = textToReplace instanceof Collection ?
-			textToReplace : model.document.getRootNames()
-				.reduce( ( ( currentResults, rootName ) => findAndReplaceUtils.updateFindResultFromRange(
-					model.createRangeIn( model.document.getRoot( rootName ) ),
-					model,
-					findAndReplaceUtils.findByTextCallback( textToReplace, this._state ),
-					currentResults
-				) ), null );
-
-		if ( results.length ) {
-			model.change( () => {
-				[ ...results ].forEach( searchResult => {
-					// Just reuse logic from the replace command to replace a single match.
-					super.execute( newText, searchResult );
-				} );
-			} );
-		}
-	}
+export default class ReplaceAllCommand extends ReplaceCommandBase {
+    /**
+     * Replaces all the occurrences of `textToReplace` with a given `newText` string.
+     *
+     * ```ts
+     *	replaceAllCommand.execute( 'replaceAll', 'new text replacement', 'text to replace' );
+     * ```
+     *
+     * Alternatively you can call it from editor instance:
+     *
+     * ```ts
+     *	editor.execute( 'replaceAll', 'new text', 'old text' );
+     * ```
+     *
+     * @param newText Text that will be inserted to the editor for each match.
+     * @param textToReplace Text to be replaced or a collection of matches
+     * as returned by the find command.
+     *
+     * @fires module:core/command~Command#event:execute
+     */
+    execute(newText, textToReplace) {
+        const { editor } = this;
+        const { model } = editor;
+        const findAndReplaceUtils = editor.plugins.get('FindAndReplaceUtils');
+        const results = textToReplace instanceof Collection ?
+            textToReplace : model.document.getRootNames()
+            .reduce(((currentResults, rootName) => findAndReplaceUtils.updateFindResultFromRange(model.createRangeIn(model.document.getRoot(rootName)), model, findAndReplaceUtils.findByTextCallback(textToReplace, this._state), currentResults)), null);
+        if (results.length) {
+            [...results].forEach(searchResult => {
+                // Just reuse logic from the replace command to replace a single match.
+                this._replace(newText, searchResult);
+            });
+        }
+    }
 }

package/src/replacecommand.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace/replacecommand
+*/
+import type { ResultType } from './findandreplace';
+import { ReplaceCommandBase } from './replacecommandbase';
+/**
+ * The replace command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ */
+export default class ReplaceCommand extends ReplaceCommandBase {
+    /**
+     * Replace a given find result by a string or a callback.
+     *
+     * @param result A single result from the find command.
+     *
+     * @fires execute
+     */
+    execute(replacementText: string, result: ResultType): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        'replace': ReplaceCommand;
+    }
+}

package/src/replacecommand.js

@@ -2,75 +2,19 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module find-and-replace/replacecommand
-*/
-
-import { Command } from 'ckeditor5/src/core';
-
+import { ReplaceCommandBase } from './replacecommandbase';
 /**
  * The replace command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
- *
- * @extends module:core/command~Command
  */
-export default class ReplaceCommand extends Command {
-	/**
-	 * Creates a new `ReplaceCommand` instance.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
-	 * @param {module:find-and-replace/findandreplacestate~FindAndReplaceState} state An object to hold plugin state.
-	 */
-	constructor( editor, state ) {
-		super( editor );
-
-		// The replace command is always enabled.
-		this.isEnabled = true;
-
-		/**
-		 * The find and replace state object used for command operations.
-		 *
-		 * @protected
-		 * @member {module:find-and-replace/findandreplacestate~FindAndReplaceState} #_state
-		 */
-		this._state = state;
-	}
-
-	/**
-	 * Replace a given find result by a string or a callback.
-	 *
-	 * @param {String} replacementText
-	 * @param {Object} result A single result from the find command.
-	 *
-	 * @fires module:core/command~Command#event:execute
-	 */
-	execute( replacementText, result ) {
-		const { model } = this.editor;
-
-		model.change( writer => {
-			const range = result.marker.getRange();
-
-			// Don't replace a result (marker) that found its way into the $graveyard (e.g. removed by collaborators).
-			if ( range.root.rootName === '$graveyard' ) {
-				this._state.results.remove( result );
-
-				return;
-			}
-
-			let textAttributes = {};
-
-			for ( const item of range.getItems() ) {
-				if ( item.is( '$text' ) || item.is( '$textProxy' ) ) {
-					textAttributes = item.getAttributes();
-					break;
-				}
-			}
-
-			model.insertContent( writer.createText( replacementText, textAttributes ), range );
-
-			if ( this._state.results.has( result ) ) {
-				this._state.results.remove( result );
-			}
-		} );
-	}
+export default class ReplaceCommand extends ReplaceCommandBase {
+    /**
+     * Replace a given find result by a string or a callback.
+     *
+     * @param result A single result from the find command.
+     *
+     * @fires execute
+     */
+    execute(replacementText, result) {
+        this._replace(replacementText, result);
+    }
 }

package/src/replacecommandbase.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace/replacecommandbase
+*/
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { ResultType } from './findandreplace';
+import type FindAndReplaceState from './findandreplacestate';
+export declare abstract class ReplaceCommandBase extends Command {
+    /**
+     * The find and replace state object used for command operations.
+     */
+    protected _state: FindAndReplaceState;
+    /**
+     * Creates a new `ReplaceCommand` instance.
+     *
+     * @param editor Editor on which this command will be used.
+     * @param state An object to hold plugin state.
+     */
+    constructor(editor: Editor, state: FindAndReplaceState);
+    abstract execute(...args: Array<unknown>): void;
+    /**
+     * Common logic for both `replace` commands.
+     * Replace a given find result by a string or a callback.
+     *
+     * @param result A single result from the find command.
+     */
+    protected _replace(replacementText: string, result: ResultType): void;
+}

package/src/replacecommandbase.js

@@ -0,0 +1,50 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace/replacecommandbase
+*/
+import { Command } from 'ckeditor5/src/core';
+export class ReplaceCommandBase extends Command {
+    /**
+     * Creates a new `ReplaceCommand` instance.
+     *
+     * @param editor Editor on which this command will be used.
+     * @param state An object to hold plugin state.
+     */
+    constructor(editor, state) {
+        super(editor);
+        // The replace command is always enabled.
+        this.isEnabled = true;
+        this._state = state;
+    }
+    /**
+     * Common logic for both `replace` commands.
+     * Replace a given find result by a string or a callback.
+     *
+     * @param result A single result from the find command.
+     */
+    _replace(replacementText, result) {
+        const { model } = this.editor;
+        model.change(writer => {
+            const range = result.marker.getRange();
+            // Don't replace a result (marker) that found its way into the $graveyard (e.g. removed by collaborators).
+            if (range.root.rootName === '$graveyard') {
+                this._state.results.remove(result);
+                return;
+            }
+            let textAttributes = {};
+            for (const item of range.getItems()) {
+                if (item.is('$text') || item.is('$textProxy')) {
+                    textAttributes = item.getAttributes();
+                    break;
+                }
+            }
+            model.insertContent(writer.createText(replacementText, textAttributes), range);
+            if (this._state.results.has(result)) {
+                this._state.results.remove(result);
+            }
+        });
+    }
+}