@ckeditor/ckeditor5-find-and-replace 40.0.0 → 40.2.0

package/src/findandreplaceutils.js

@@ -1,143 +1,143 @@
-/**
- * @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
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Collection, uid } from 'ckeditor5/src/utils';
-import { escapeRegExp } from 'lodash-es';
-/**
- * A set of helpers related to find and replace.
- */
-export default class FindAndReplaceUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FindAndReplaceUtils';
-    }
-    /**
-     * Executes findCallback and updates search results list.
-     *
-     * @param range The model range to scan for matches.
-     * @param model The model.
-     * @param findCallback The callback that should return `true` if provided text matches the search term.
-     * @param startResults An optional collection of find matches that the function should
-     * start with. This would be a collection returned by a previous `updateFindResultFromRange()` call.
-     * @returns A collection of objects describing find match.
-     *
-     * An example structure:
-     *
-     * ```js
-     * {
-     *	id: resultId,
-     *	label: foundItem.label,
-     *	marker
-     *	}
-     * ```
-     */
-    updateFindResultFromRange(range, model, findCallback, startResults) {
-        const results = startResults || new Collection();
-        model.change(writer => {
-            [...range].forEach(({ type, item }) => {
-                if (type === 'elementStart') {
-                    if (model.schema.checkChild(item, '$text')) {
-                        const foundItems = findCallback({
-                            item,
-                            text: this.rangeToText(model.createRangeIn(item))
-                        });
-                        if (!foundItems) {
-                            return;
-                        }
-                        foundItems.forEach(foundItem => {
-                            const resultId = `findResult:${uid()}`;
-                            const marker = writer.addMarker(resultId, {
-                                usingOperation: false,
-                                affectsData: false,
-                                range: writer.createRange(writer.createPositionAt(item, foundItem.start), writer.createPositionAt(item, foundItem.end))
-                            });
-                            const index = findInsertIndex(results, marker);
-                            results.add({
-                                id: resultId,
-                                label: foundItem.label,
-                                marker
-                            }, index);
-                        });
-                    }
-                }
-            });
-        });
-        return results;
-    }
-    /**
-     * Returns text representation of a range. The returned text length should be the same as range length.
-     * In order to achieve this, this function will replace inline elements (text-line) as new line character ("\n").
-     *
-     * @param range The model range.
-     * @returns The text content of the provided range.
-     */
-    rangeToText(range) {
-        return Array.from(range.getItems()).reduce((rangeText, node) => {
-            // Trim text to a last occurrence of an inline element and update range start.
-            if (!(node.is('$text') || node.is('$textProxy'))) {
-                // Editor has only one inline element defined in schema: `<softBreak>` which is treated as new line character in blocks.
-                // Special handling might be needed for other inline elements (inline widgets).
-                return `${rangeText}\n`;
-            }
-            return rangeText + node.data;
-        }, '');
-    }
-    /**
-     * Creates a text matching callback for a specified search term and matching options.
-     *
-     * @param searchTerm The search term.
-     * @param options Matching options.
-     * 	- options.matchCase=false If set to `true` letter casing will be ignored.
-     * 	- options.wholeWords=false If set to `true` only whole words that match `callbackOrText` will be matched.
-     */
-    findByTextCallback(searchTerm, options) {
-        let flags = 'gu';
-        if (!options.matchCase) {
-            flags += 'i';
-        }
-        let regExpQuery = `(${escapeRegExp(searchTerm)})`;
-        if (options.wholeWords) {
-            const nonLetterGroup = '[^a-zA-Z\u00C0-\u024F\u1E00-\u1EFF]';
-            if (!new RegExp('^' + nonLetterGroup).test(searchTerm)) {
-                regExpQuery = `(^|${nonLetterGroup}|_)${regExpQuery}`;
-            }
-            if (!new RegExp(nonLetterGroup + '$').test(searchTerm)) {
-                regExpQuery = `${regExpQuery}(?=_|${nonLetterGroup}|$)`;
-            }
-        }
-        const regExp = new RegExp(regExpQuery, flags);
-        function findCallback({ text }) {
-            const matches = [...text.matchAll(regExp)];
-            return matches.map(regexpMatchToFindResult);
-        }
-        return findCallback;
-    }
-}
-// Finds the appropriate index in the resultsList Collection.
-function findInsertIndex(resultsList, markerToInsert) {
-    const result = resultsList.find(({ marker }) => {
-        return markerToInsert.getStart().isBefore(marker.getStart());
-    });
-    return result ? resultsList.getIndex(result) : resultsList.length;
-}
-/**
- *  Maps RegExp match result to find result.
- */
-function regexpMatchToFindResult(matchResult) {
-    const lastGroupIndex = matchResult.length - 1;
-    let startOffset = matchResult.index;
-    // Searches with match all flag have an extra matching group with empty string or white space matched before the word.
-    // If the search term starts with the space already, there is no extra group even with match all flag on.
-    if (matchResult.length === 3) {
-        startOffset += matchResult[1].length;
-    }
-    return {
-        label: matchResult[lastGroupIndex],
-        start: startOffset,
-        end: startOffset + matchResult[lastGroupIndex].length
-    };
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Collection, uid } from 'ckeditor5/src/utils';
+import { escapeRegExp } from 'lodash-es';
+/**
+ * A set of helpers related to find and replace.
+ */
+export default class FindAndReplaceUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FindAndReplaceUtils';
+    }
+    /**
+     * Executes findCallback and updates search results list.
+     *
+     * @param range The model range to scan for matches.
+     * @param model The model.
+     * @param findCallback The callback that should return `true` if provided text matches the search term.
+     * @param startResults An optional collection of find matches that the function should
+     * start with. This would be a collection returned by a previous `updateFindResultFromRange()` call.
+     * @returns A collection of objects describing find match.
+     *
+     * An example structure:
+     *
+     * ```js
+     * {
+     *	id: resultId,
+     *	label: foundItem.label,
+     *	marker
+     *	}
+     * ```
+     */
+    updateFindResultFromRange(range, model, findCallback, startResults) {
+        const results = startResults || new Collection();
+        model.change(writer => {
+            [...range].forEach(({ type, item }) => {
+                if (type === 'elementStart') {
+                    if (model.schema.checkChild(item, '$text')) {
+                        const foundItems = findCallback({
+                            item,
+                            text: this.rangeToText(model.createRangeIn(item))
+                        });
+                        if (!foundItems) {
+                            return;
+                        }
+                        foundItems.forEach(foundItem => {
+                            const resultId = `findResult:${uid()}`;
+                            const marker = writer.addMarker(resultId, {
+                                usingOperation: false,
+                                affectsData: false,
+                                range: writer.createRange(writer.createPositionAt(item, foundItem.start), writer.createPositionAt(item, foundItem.end))
+                            });
+                            const index = findInsertIndex(results, marker);
+                            results.add({
+                                id: resultId,
+                                label: foundItem.label,
+                                marker
+                            }, index);
+                        });
+                    }
+                }
+            });
+        });
+        return results;
+    }
+    /**
+     * Returns text representation of a range. The returned text length should be the same as range length.
+     * In order to achieve this, this function will replace inline elements (text-line) as new line character ("\n").
+     *
+     * @param range The model range.
+     * @returns The text content of the provided range.
+     */
+    rangeToText(range) {
+        return Array.from(range.getItems()).reduce((rangeText, node) => {
+            // Trim text to a last occurrence of an inline element and update range start.
+            if (!(node.is('$text') || node.is('$textProxy'))) {
+                // Editor has only one inline element defined in schema: `<softBreak>` which is treated as new line character in blocks.
+                // Special handling might be needed for other inline elements (inline widgets).
+                return `${rangeText}\n`;
+            }
+            return rangeText + node.data;
+        }, '');
+    }
+    /**
+     * Creates a text matching callback for a specified search term and matching options.
+     *
+     * @param searchTerm The search term.
+     * @param options Matching options.
+     * 	- options.matchCase=false If set to `true` letter casing will be ignored.
+     * 	- options.wholeWords=false If set to `true` only whole words that match `callbackOrText` will be matched.
+     */
+    findByTextCallback(searchTerm, options) {
+        let flags = 'gu';
+        if (!options.matchCase) {
+            flags += 'i';
+        }
+        let regExpQuery = `(${escapeRegExp(searchTerm)})`;
+        if (options.wholeWords) {
+            const nonLetterGroup = '[^a-zA-Z\u00C0-\u024F\u1E00-\u1EFF]';
+            if (!new RegExp('^' + nonLetterGroup).test(searchTerm)) {
+                regExpQuery = `(^|${nonLetterGroup}|_)${regExpQuery}`;
+            }
+            if (!new RegExp(nonLetterGroup + '$').test(searchTerm)) {
+                regExpQuery = `${regExpQuery}(?=_|${nonLetterGroup}|$)`;
+            }
+        }
+        const regExp = new RegExp(regExpQuery, flags);
+        function findCallback({ text }) {
+            const matches = [...text.matchAll(regExp)];
+            return matches.map(regexpMatchToFindResult);
+        }
+        return findCallback;
+    }
+}
+// Finds the appropriate index in the resultsList Collection.
+function findInsertIndex(resultsList, markerToInsert) {
+    const result = resultsList.find(({ marker }) => {
+        return markerToInsert.getStart().isBefore(marker.getStart());
+    });
+    return result ? resultsList.getIndex(result) : resultsList.length;
+}
+/**
+ *  Maps RegExp match result to find result.
+ */
+function regexpMatchToFindResult(matchResult) {
+    const lastGroupIndex = matchResult.length - 1;
+    let startOffset = matchResult.index;
+    // Searches with match all flag have an extra matching group with empty string or white space matched before the word.
+    // If the search term starts with the space already, there is no extra group even with match all flag on.
+    if (matchResult.length === 3) {
+        startOffset += matchResult[1].length;
+    }
+    return {
+        label: matchResult[lastGroupIndex],
+        start: startOffset,
+        end: startOffset + matchResult[lastGroupIndex].length
+    };
+}

package/src/findcommand.d.ts

@@ -1,51 +1,51 @@
-/**
- * @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/findcommand
-*/
-import type { Item } from 'ckeditor5/src/engine';
-import { Command, type Editor } from 'ckeditor5/src/core';
-import type { Collection } from 'ckeditor5/src/utils';
-import type FindAndReplaceState from './findandreplacestate';
-import type { ResultType } from './findandreplace';
-/**
- * The find command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
- */
-export default class FindCommand extends Command {
-    /**
-     * The find and replace state object used for command operations.
-     */
-    private _state;
-    /**
-     * Creates a new `FindCommand` instance.
-     *
-     * @param editor The editor on which this command will be used.
-     * @param state An object to hold plugin state.
-     */
-    constructor(editor: Editor, state: FindAndReplaceState);
-    /**
-     * Executes the command.
-     *
-     * @param callbackOrText
-     * @param options Options object.
-     * @param options.matchCase If set to `true`, the letter case will be matched.
-     * @param options.wholeWords If set to `true`, only whole words that match `callbackOrText` will be matched.
-     *
-     * @fires execute
-     */
-    execute(callbackOrText: string | (({ item, text }: {
-        item: Item;
-        text: string;
-    }) => Array<ResultType>), { matchCase, wholeWords }?: {
-        matchCase?: boolean;
-        wholeWords?: boolean;
-    }): {
-        results: Collection<ResultType>;
-        findCallback: (({ item, text }: {
-            item: Item;
-            text: string;
-        }) => Array<ResultType>);
-    };
-}
+/**
+ * @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/findcommand
+*/
+import type { Item } from 'ckeditor5/src/engine';
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { Collection } from 'ckeditor5/src/utils';
+import type FindAndReplaceState from './findandreplacestate';
+import type { ResultType } from './findandreplace';
+/**
+ * The find command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ */
+export default class FindCommand extends Command {
+    /**
+     * The find and replace state object used for command operations.
+     */
+    private _state;
+    /**
+     * Creates a new `FindCommand` instance.
+     *
+     * @param editor The editor on which this command will be used.
+     * @param state An object to hold plugin state.
+     */
+    constructor(editor: Editor, state: FindAndReplaceState);
+    /**
+     * Executes the command.
+     *
+     * @param callbackOrText
+     * @param options Options object.
+     * @param options.matchCase If set to `true`, the letter case will be matched.
+     * @param options.wholeWords If set to `true`, only whole words that match `callbackOrText` will be matched.
+     *
+     * @fires execute
+     */
+    execute(callbackOrText: string | (({ item, text }: {
+        item: Item;
+        text: string;
+    }) => Array<ResultType>), { matchCase, wholeWords }?: {
+        matchCase?: boolean;
+        wholeWords?: boolean;
+    }): {
+        results: Collection<ResultType>;
+        findCallback: (({ item, text }: {
+            item: Item;
+            text: string;
+        }) => Array<ResultType>);
+    };
+}

package/src/findcommand.js

@@ -1,63 +1,63 @@
-/**
- * @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
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The find command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
- */
-export default class FindCommand extends Command {
-    /**
-     * Creates a new `FindCommand` instance.
-     *
-     * @param editor The editor on which this command will be used.
-     * @param state An object to hold plugin state.
-     */
-    constructor(editor, state) {
-        super(editor);
-        // The find command is always enabled.
-        this.isEnabled = true;
-        // It does not affect data so should be enabled in read-only mode.
-        this.affectsData = false;
-        this._state = state;
-    }
-    /**
-     * Executes the command.
-     *
-     * @param callbackOrText
-     * @param options Options object.
-     * @param options.matchCase If set to `true`, the letter case will be matched.
-     * @param options.wholeWords If set to `true`, only whole words that match `callbackOrText` will be matched.
-     *
-     * @fires execute
-     */
-    execute(callbackOrText, { matchCase, wholeWords } = {}) {
-        const { editor } = this;
-        const { model } = editor;
-        const findAndReplaceUtils = editor.plugins.get('FindAndReplaceUtils');
-        let findCallback;
-        // Allow to execute `find()` on a plugin with a keyword only.
-        if (typeof callbackOrText === 'string') {
-            findCallback = findAndReplaceUtils.findByTextCallback(callbackOrText, { matchCase, wholeWords });
-            this._state.searchText = callbackOrText;
-        }
-        else {
-            findCallback = callbackOrText;
-        }
-        // Initial search is done on all nodes in all roots inside the content.
-        const results = model.document.getRootNames()
-            .reduce(((currentResults, rootName) => findAndReplaceUtils.updateFindResultFromRange(model.createRangeIn(model.document.getRoot(rootName)), model, findCallback, currentResults)), null);
-        this._state.clear(model);
-        this._state.results.addMany(results);
-        this._state.highlightedResult = results.get(0);
-        if (typeof callbackOrText === 'string') {
-            this._state.searchText = callbackOrText;
-        }
-        this._state.matchCase = !!matchCase;
-        this._state.matchWholeWords = !!wholeWords;
-        return {
-            results,
-            findCallback
-        };
-    }
-}
+/**
+ * @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
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The find command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ */
+export default class FindCommand extends Command {
+    /**
+     * Creates a new `FindCommand` instance.
+     *
+     * @param editor The editor on which this command will be used.
+     * @param state An object to hold plugin state.
+     */
+    constructor(editor, state) {
+        super(editor);
+        // The find command is always enabled.
+        this.isEnabled = true;
+        // It does not affect data so should be enabled in read-only mode.
+        this.affectsData = false;
+        this._state = state;
+    }
+    /**
+     * Executes the command.
+     *
+     * @param callbackOrText
+     * @param options Options object.
+     * @param options.matchCase If set to `true`, the letter case will be matched.
+     * @param options.wholeWords If set to `true`, only whole words that match `callbackOrText` will be matched.
+     *
+     * @fires execute
+     */
+    execute(callbackOrText, { matchCase, wholeWords } = {}) {
+        const { editor } = this;
+        const { model } = editor;
+        const findAndReplaceUtils = editor.plugins.get('FindAndReplaceUtils');
+        let findCallback;
+        // Allow to execute `find()` on a plugin with a keyword only.
+        if (typeof callbackOrText === 'string') {
+            findCallback = findAndReplaceUtils.findByTextCallback(callbackOrText, { matchCase, wholeWords });
+            this._state.searchText = callbackOrText;
+        }
+        else {
+            findCallback = callbackOrText;
+        }
+        // Initial search is done on all nodes in all roots inside the content.
+        const results = model.document.getRootNames()
+            .reduce(((currentResults, rootName) => findAndReplaceUtils.updateFindResultFromRange(model.createRangeIn(model.document.getRoot(rootName)), model, findCallback, currentResults)), null);
+        this._state.clear(model);
+        this._state.results.addMany(results);
+        this._state.highlightedResult = results.get(0);
+        if (typeof callbackOrText === 'string') {
+            this._state.searchText = callbackOrText;
+        }
+        this._state.matchCase = !!matchCase;
+        this._state.matchWholeWords = !!wholeWords;
+        return {
+            results,
+            findCallback
+        };
+    }
+}

package/src/findnextcommand.d.ts

@@ -1,35 +1,35 @@
-/**
- * @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/findnextcommand
-*/
-import { Command, type Editor } from 'ckeditor5/src/core';
-import type FindAndReplaceState from './findandreplacestate';
-/**
- * The find next command. Moves the highlight to the next search result.
- *
- * It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
- */
-export default class FindNextCommand extends Command {
-    /**
-     * The find and replace state object used for command operations.
-     */
-    protected _state: FindAndReplaceState;
-    /**
-     * Creates a new `FindNextCommand` instance.
-     *
-     * @param editor The editor on which this command will be used.
-     * @param state An object to hold plugin state.
-     */
-    constructor(editor: Editor, state: FindAndReplaceState);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * @inheritDoc
-     */
-    execute(): void;
-}
+/**
+ * @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/findnextcommand
+*/
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type FindAndReplaceState from './findandreplacestate';
+/**
+ * The find next command. Moves the highlight to the next search result.
+ *
+ * It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ */
+export default class FindNextCommand extends Command {
+    /**
+     * The find and replace state object used for command operations.
+     */
+    protected _state: FindAndReplaceState;
+    /**
+     * Creates a new `FindNextCommand` instance.
+     *
+     * @param editor The editor on which this command will be used.
+     * @param state An object to hold plugin state.
+     */
+    constructor(editor: Editor, state: FindAndReplaceState);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+}