@univerjs/sheets-find-replace 0.6.0 → 0.6.1

package/lib/cjs/facade.js

@@ -1 +1 @@
-"use strict";var _=Object.defineProperty;var p=(i,e,t)=>e in i?_(i,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):i[e]=t;var o=(i,e,t)=>p(i,typeof e!="symbol"?e+"":e,t);const l=require("@univerjs/core"),c=require("@univerjs/find-replace"),m=require("@univerjs/sheets/facade"),u=require("@univerjs/core/facade");var f=Object.getOwnPropertyDescriptor,v=(i,e,t,s)=>{for(var n=s>1?void 0:s?f(e,t):e,r=i.length-1,a;r>=0;r--)(a=i[r])&&(n=a(n)||n);return n},h=(i,e)=>(t,s)=>e(t,s,i);let d=class extends l.Disposable{constructor(e,t,s,n){super();o(this,"_state",new c.FindReplaceState);o(this,"_model");o(this,"_complete");this._injector=t,this._univerInstanceService=s,this._findReplaceService=n;const r=this._findReplaceService.getProviders();this._model=this._injector.createInstance(c.FindReplaceModel,this._state,r);const a={...c.createInitFindReplaceState(),...e};this._state.changeState(a)}findAll(){return!this._state.findCompleted||!this._complete?[]:this._complete.results.map(e=>this._findMatchToFRange(e))}findNext(){var t;if(!this._state.findCompleted||!this._complete)return null;const e=(t=this._model)==null?void 0:t.moveToNextMatch();return e?this._findMatchToFRange(e):null}findPrevious(){var t;const e=(t=this._model)==null?void 0:t.moveToPreviousMatch();return e?this._findMatchToFRange(e):null}getCurrentMatch(){var t;if(!this._state.findCompleted||!this._complete)throw new Error("Find operation is not completed.");const e=(t=this._model)==null?void 0:t.currentMatch$.value;return e?this._findMatchToFRange(e):null}async matchCaseAsync(e){return this._state.changeState({caseSensitive:e}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(n=>{n.findCompleted===!0&&(s.unsubscribe(),t(this))})})}async matchEntireCellAsync(e){return this._state.changeState({matchesTheWholeCell:e}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(n=>{n.findCompleted===!0&&(s.unsubscribe(),t(this))})})}async matchFormulaTextAsync(e){return this._state.changeState({findBy:e?c.FindBy.FORMULA:c.FindBy.VALUE}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(n=>{n.findCompleted===!0&&(s.unsubscribe(),t(this))})})}async replaceAllWithAsync(e){var s,n,r;await this._state.changeState({replaceRevealed:!0,replaceString:e});const t=(r=(n=await((s=this._model)==null?void 0:s.replaceAll()))==null?void 0:n.success)!=null?r:0;return this._state.changeState({replaceRevealed:!1}),t}async replaceWithAsync(e){var t;return await this._state.changeState({replaceRevealed:!0,replaceString:e}),await((t=this._model)==null?void 0:t.replace()),this._state.changeState({replaceRevealed:!1}),!0}async ensureCompleteAsync(){var e;return(!this._state.findCompleted||!this._complete)&&(this._complete=await((e=this._model)==null?void 0:e.start())),this._complete}_findMatchToFRange(e){const{unitId:t}=e,{subUnitId:s,range:n}=e.range,r=this._univerInstanceService.getUnit(t),a=r.getSheetBySheetId(s);return this._injector.createInstance(m.FRange,r,a,n)}};d=v([h(1,l.Inject(l.Injector)),h(2,l.IUniverInstanceService),h(3,c.IFindReplaceService)],d);class g extends u.FUniver{async createTextFinderAsync(e){const t={findString:e},s=this._injector.createInstance(d,t);return await s.ensureCompleteAsync(),s}}u.FUniver.extend(g);
+"use strict";var p=Object.defineProperty;var _=(a,e,t)=>e in a?p(a,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):a[e]=t;var o=(a,e,t)=>_(a,typeof e!="symbol"?e+"":e,t);const l=require("@univerjs/core"),c=require("@univerjs/find-replace"),m=require("@univerjs/sheets/facade"),u=require("@univerjs/core/facade");var f=Object.getOwnPropertyDescriptor,v=(a,e,t,s)=>{for(var n=s>1?void 0:s?f(e,t):e,i=a.length-1,r;i>=0;i--)(r=a[i])&&(n=r(n)||n);return n},h=(a,e)=>(t,s)=>e(t,s,a);let d=class extends l.Disposable{constructor(e,t,s,n){super();o(this,"_state",new c.FindReplaceState);o(this,"_model");o(this,"_complete");this._injector=t,this._univerInstanceService=s,this._findReplaceService=n;const i=this._findReplaceService.getProviders();this._model=this._injector.createInstance(c.FindReplaceModel,this._state,i);const r={...c.createInitFindReplaceState(),...e};this._state.changeState(r)}findAll(){return!this._state.findCompleted||!this._complete?[]:this._complete.results.map(e=>this._findMatchToFRange(e))}findNext(){var t;if(!this._state.findCompleted||!this._complete)return null;const e=(t=this._model)==null?void 0:t.moveToNextMatch();return e?this._findMatchToFRange(e):null}findPrevious(){var t;const e=(t=this._model)==null?void 0:t.moveToPreviousMatch();return e?this._findMatchToFRange(e):null}getCurrentMatch(){var t;if(!this._state.findCompleted||!this._complete)throw new Error("Find operation is not completed.");const e=(t=this._model)==null?void 0:t.currentMatch$.value;return e?this._findMatchToFRange(e):null}async matchCaseAsync(e){return this._state.changeState({caseSensitive:e,findCompleted:!1}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(async n=>{n.findCompleted===!0&&(s.unsubscribe(),await this.ensureCompleteAsync(),t(this))})})}async matchEntireCellAsync(e){return this._state.changeState({matchesTheWholeCell:e,findCompleted:!1}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(async n=>{n.findCompleted===!0&&(s.unsubscribe(),await this.ensureCompleteAsync(),t(this))})})}async matchFormulaTextAsync(e){return this._state.changeState({findBy:e?c.FindBy.FORMULA:c.FindBy.VALUE,findCompleted:!1}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(async n=>{n.findCompleted===!0&&(s.unsubscribe(),await this.ensureCompleteAsync(),t(this))})})}async replaceAllWithAsync(e){var s,n,i;await this._state.changeState({replaceRevealed:!0,replaceString:e});const t=(i=(n=await((s=this._model)==null?void 0:s.replaceAll()))==null?void 0:n.success)!=null?i:0;return this._state.changeState({replaceRevealed:!1}),t}async replaceWithAsync(e){var t;return await this._state.changeState({replaceRevealed:!0,replaceString:e}),await((t=this._model)==null?void 0:t.replace()),this._state.changeState({replaceRevealed:!1}),!0}async ensureCompleteAsync(){var e;this._complete=await((e=this._model)==null?void 0:e.start())}_findMatchToFRange(e){const{unitId:t}=e,{subUnitId:s,range:n}=e.range,i=this._univerInstanceService.getUnit(t),r=i.getSheetBySheetId(s);return this._injector.createInstance(m.FRange,i,r,n)}};d=v([h(1,l.Inject(l.Injector)),h(2,l.IUniverInstanceService),h(3,c.IFindReplaceService)],d);class y extends u.FUniver{async createTextFinderAsync(e){const t={findString:e},s=this._injector.createInstance(d,t);return await s.ensureCompleteAsync(),s}}u.FUniver.extend(y);

package/lib/es/facade.js

@@ -1,29 +1,29 @@
 var u = Object.defineProperty;
-var _ = (i, e, t) => e in i ? u(i, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : i[e] = t;
-var c = (i, e, t) => _(i, typeof e != "symbol" ? e + "" : e, t);
-import { Inject as p, Injector as m, IUniverInstanceService as f, Disposable as v } from "@univerjs/core";
-import { IFindReplaceService as g, FindReplaceModel as S, createInitFindReplaceState as b, FindReplaceState as F, FindBy as h } from "@univerjs/find-replace";
-import { FRange as y } from "@univerjs/sheets/facade";
+var p = (a, e, t) => e in a ? u(a, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : a[e] = t;
+var c = (a, e, t) => p(a, typeof e != "symbol" ? e + "" : e, t);
+import { Inject as m, Injector as _, IUniverInstanceService as f, Disposable as v } from "@univerjs/core";
+import { IFindReplaceService as g, FindReplaceModel as y, createInitFindReplaceState as S, FindReplaceState as b, FindBy as h } from "@univerjs/find-replace";
+import { FRange as F } from "@univerjs/sheets/facade";
 import { FUniver as d } from "@univerjs/core/facade";
-var R = Object.getOwnPropertyDescriptor, w = (i, e, t, s) => {
-  for (var n = s > 1 ? void 0 : s ? R(e, t) : e, r = i.length - 1, a; r >= 0; r--)
-    (a = i[r]) && (n = a(n) || n);
+var w = Object.getOwnPropertyDescriptor, C = (a, e, t, s) => {
+  for (var n = s > 1 ? void 0 : s ? w(e, t) : e, i = a.length - 1, r; i >= 0; i--)
+    (r = a[i]) && (n = r(n) || n);
   return n;
-}, o = (i, e) => (t, s) => e(t, s, i);
+}, o = (a, e) => (t, s) => e(t, s, a);
 let l = class extends v {
   constructor(e, t, s, n) {
     super();
-    c(this, "_state", new F());
+    c(this, "_state", new b());
     c(this, "_model");
     c(this, "_complete");
     this._injector = t, this._univerInstanceService = s, this._findReplaceService = n;
-    const r = this._findReplaceService.getProviders();
-    this._model = this._injector.createInstance(S, this._state, r);
-    const a = {
-      ...b(),
+    const i = this._findReplaceService.getProviders();
+    this._model = this._injector.createInstance(y, this._state, i);
+    const r = {
+      ...S(),
       ...e
     };
-    this._state.changeState(a);
+    this._state.changeState(r);
   }
   findAll() {
     return !this._state.findCompleted || !this._complete ? [] : this._complete.results.map((e) => this._findMatchToFRange(e));
@@ -48,30 +48,30 @@ let l = class extends v {
     return e ? this._findMatchToFRange(e) : null;
   }
   async matchCaseAsync(e) {
-    return this._state.changeState({ caseSensitive: e }), new Promise((t) => {
-      const s = this._state.stateUpdates$.subscribe((n) => {
-        n.findCompleted === !0 && (s.unsubscribe(), t(this));
+    return this._state.changeState({ caseSensitive: e, findCompleted: !1 }), new Promise((t) => {
+      const s = this._state.stateUpdates$.subscribe(async (n) => {
+        n.findCompleted === !0 && (s.unsubscribe(), await this.ensureCompleteAsync(), t(this));
       });
     });
   }
   async matchEntireCellAsync(e) {
-    return this._state.changeState({ matchesTheWholeCell: e }), new Promise((t) => {
-      const s = this._state.stateUpdates$.subscribe((n) => {
-        n.findCompleted === !0 && (s.unsubscribe(), t(this));
+    return this._state.changeState({ matchesTheWholeCell: e, findCompleted: !1 }), new Promise((t) => {
+      const s = this._state.stateUpdates$.subscribe(async (n) => {
+        n.findCompleted === !0 && (s.unsubscribe(), await this.ensureCompleteAsync(), t(this));
       });
     });
   }
   async matchFormulaTextAsync(e) {
-    return this._state.changeState({ findBy: e ? h.FORMULA : h.VALUE }), new Promise((t) => {
-      const s = this._state.stateUpdates$.subscribe((n) => {
-        n.findCompleted === !0 && (s.unsubscribe(), t(this));
+    return this._state.changeState({ findBy: e ? h.FORMULA : h.VALUE, findCompleted: !1 }), new Promise((t) => {
+      const s = this._state.stateUpdates$.subscribe(async (n) => {
+        n.findCompleted === !0 && (s.unsubscribe(), await this.ensureCompleteAsync(), t(this));
       });
     });
   }
   async replaceAllWithAsync(e) {
-    var s, n, r;
+    var s, n, i;
     await this._state.changeState({ replaceRevealed: !0, replaceString: e });
-    const t = (r = (n = await ((s = this._model) == null ? void 0 : s.replaceAll())) == null ? void 0 : n.success) != null ? r : 0;
+    const t = (i = (n = await ((s = this._model) == null ? void 0 : s.replaceAll())) == null ? void 0 : n.success) != null ? i : 0;
     return this._state.changeState({ replaceRevealed: !1 }), t;
   }
   async replaceWithAsync(e) {
@@ -80,22 +80,22 @@ let l = class extends v {
   }
   async ensureCompleteAsync() {
     var e;
-    return (!this._state.findCompleted || !this._complete) && (this._complete = await ((e = this._model) == null ? void 0 : e.start())), this._complete;
+    this._complete = await ((e = this._model) == null ? void 0 : e.start());
   }
   _findMatchToFRange(e) {
-    const { unitId: t } = e, { subUnitId: s, range: n } = e.range, r = this._univerInstanceService.getUnit(t), a = r.getSheetBySheetId(s);
-    return this._injector.createInstance(y, r, a, n);
+    const { unitId: t } = e, { subUnitId: s, range: n } = e.range, i = this._univerInstanceService.getUnit(t), r = i.getSheetBySheetId(s);
+    return this._injector.createInstance(F, i, r, n);
   }
 };
-l = w([
-  o(1, p(m)),
+l = C([
+  o(1, m(_)),
   o(2, f),
   o(3, g)
 ], l);
-class C extends d {
+class R extends d {
   async createTextFinderAsync(e) {
     const t = { findString: e }, s = this._injector.createInstance(l, t);
     return await s.ensureCompleteAsync(), s;
   }
 }
-d.extend(C);
+d.extend(R);

package/lib/types/facade/f-text-finder.d.ts

@@ -6,130 +6,314 @@ import { FRange } from '@univerjs/sheets/facade';
  */
 export interface IFTextFinder {
     /**
-     * get all the matched range in the univer
-     * @returns all the matched range
-     * @throws if the find operation is not completed
+     * Get all the matched cells of the current sheet, the current matched cell is the last matched cell.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @returns {FRange[]} All the matched cells.
+     * @throws If the find operation is not completed.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('hello');
-     * const ranges = textFinder.findAll();
-     * ranges.forEach((range) => {
-     *    console.log(range.getA1Notation());
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D10');
+     * fRange.setValues([
+     *   [1, 2, 3, 4],
+     *   [2, 3, 4, 5],
+     *   [3, 4, 5, 6],
+     *   [4, 5, 6, 7],
+     *   [5, 6, 7, 8],
+     *   [6, 7, 8, 9],
+     *   [7, 8, 9, 10],
+     *   [8, 9, 10, 11],
+     *   [9, 10, 11, 12],
+     *   [10, 11, 12, 13]
+     * ]);
+     *
+     * // Create a text-finder to find the text '5'.
+     * const textFinder = await univerAPI.createTextFinderAsync('5');
+     *
+     * // Find all cells that contain the text '5'.
+     * const matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation()); // D2, C3, B4, A5
      * });
      * ```
      */
     findAll(): FRange[];
     /**
-     * find the next matched range in the univer
-     * @returns the next matched range
-     * @throws if the find operation is not completed
-     * @returns null if no more match
+     * Get the next matched cell of the current sheet, if exists return the next matched cell and move the current matched cell to the next matched cell.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @returns {Nullable<FRange>} The next matched cell.
+     * @throws If the find operation is not completed.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('hello');
-     * const range = textFinder.findNext();
-     * if (range) {
-     *   console.log(range.getA1Notation());
-     * }
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D10');
+     * fRange.setValues([
+     *   [1, 2, 3, 4],
+     *   [2, 3, 4, 5],
+     *   [3, 4, 5, 6],
+     *   [4, 5, 6, 7],
+     *   [5, 6, 7, 8],
+     *   [6, 7, 8, 9],
+     *   [7, 8, 9, 10],
+     *   [8, 9, 10, 11],
+     *   [9, 10, 11, 12],
+     *   [10, 11, 12, 13]
+     * ]);
+     *
+     * // Create a text-finder to find the text '5'.
+     * const textFinder = await univerAPI.createTextFinderAsync('5');
+     * console.log(textFinder.getCurrentMatch().getA1Notation()); // current match cell is A5
+     *
+     * // Find the next matched range
+     * const nextMatch = textFinder.findNext();
+     * console.log(nextMatch.getA1Notation()); // D2
+     * console.log(textFinder.getCurrentMatch().getA1Notation()); // current match cell is D2
      * ```
      */
     findNext(): Nullable<FRange>;
     /**
-     * find the previous matched range in the univer
-     * @returns the previous matched range
-     * @throws if the find operation is not completed
-     * @returns null if no more match
+     * Get the previous matched cell of the current sheet, if exists return the previous matched cell and move the current matched cell to the previous matched cell.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @returns {Nullable<FRange>} The previous matched cell.
+     * @throws If the find operation is not completed.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('hello');
-     * const range = textFinder.findPrevious();
-     * if (range) {
-     *  console.log(range.getA1Notation());
-     * }
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D10');
+     * fRange.setValues([
+     *   [1, 2, 3, 4],
+     *   [2, 3, 4, 5],
+     *   [3, 4, 5, 6],
+     *   [4, 5, 6, 7],
+     *   [5, 6, 7, 8],
+     *   [6, 7, 8, 9],
+     *   [7, 8, 9, 10],
+     *   [8, 9, 10, 11],
+     *   [9, 10, 11, 12],
+     *   [10, 11, 12, 13]
+     * ]);
+     *
+     * // Create a text-finder to find the text '5'.
+     * const textFinder = await univerAPI.createTextFinderAsync('5');
+     * console.log(textFinder.getCurrentMatch().getA1Notation()); // current match cell is A5
+     *
+     * // Find the previous matched range.
+     * const previousMatch = textFinder.findPrevious();
+     * console.log(previousMatch.getA1Notation()); // B4
+     * console.log(textFinder.getCurrentMatch().getA1Notation()); // current match cell is B4
      * ```
      */
     findPrevious(): Nullable<FRange>;
     /**
-     * get the current matched range in the univer
-     * @returns the current matched range
-     * @throws if the find operation is not completed
+     * Get the current matched cell of the current sheet.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @returns {Nullable<FRange>} The current matched cell.
+     * @throws If the find operation is not completed.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('hello');
-     * const range = textFinder.getCurrentMatch();
-     * if (range) {
-     * console.log(range.getA1Notation());
-     * }
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D10');
+     * fRange.setValues([
+     *   [1, 2, 3, 4],
+     *   [2, 3, 4, 5],
+     *   [3, 4, 5, 6],
+     *   [4, 5, 6, 7],
+     *   [5, 6, 7, 8],
+     *   [6, 7, 8, 9],
+     *   [7, 8, 9, 10],
+     *   [8, 9, 10, 11],
+     *   [9, 10, 11, 12],
+     *   [10, 11, 12, 13]
+     * ]);
+     *
+     * // Create a text-finder to find the text '5'.
+     * const textFinder = await univerAPI.createTextFinderAsync('5');
+     *
+     * // Get the current matched range.
+     * const currentMatch = textFinder.getCurrentMatch();
+     * console.log(currentMatch.getA1Notation()); // A5
      * ```
      */
     getCurrentMatch(): Nullable<FRange>;
     /**
-     * set the match case option
-     * @param {boolean} matchCase whether to match case
-     * @returns text-finder instance
+     * Set the match case option, if true, the find operation will match case, otherwise, the find operation will ignore case.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @param {boolean} matchCase - Whether to match case.
+     * @returns {Promise<IFTextFinder>} The text-finder instance.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('hello');
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D1');
+     * fRange.setValues([
+     *   ['hello univer', 'hello UNIVER', 'HELLO UNIVER', 'HELLO univer'],
+     * ]);
+     *
+     * // Create a text-finder to find the text 'univer'.
+     * const textFinder = await univerAPI.createTextFinderAsync('univer');
+     * let matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation()); // A1, B1, C1, D1
+     * });
+     *
+     * // Set the match case.
      * await textFinder.matchCaseAsync(true);
+     * matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation()); // A1, D1
+     * });
      * ```
      */
     matchCaseAsync(matchCase: boolean): Promise<IFTextFinder>;
     /**
-     * set the match entire cell option
-     * @param {boolean} matchEntireCell whether to match entire cell
-     * @returns text-finder instance
+     * Set the match entire cell option, if true, the find operation will match entire cell value, otherwise, the find operation will match part of the cell value.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @param {boolean} matchEntireCell - Whether to match entire cell value.
+     * @returns {Promise<IFTextFinder>} The text-finder instance.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('hello');
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D1');
+     * fRange.setValues([
+     *   ['hello univer', 'hello univer 1', 'hello univer 2', 'hello univer 3'],
+     * ]);
+     *
+     * // Create a text-finder to find the text 'hello univer'.
+     * const textFinder = await univerAPI.createTextFinderAsync('hello univer');
+     * let matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation()); // A1, B1, C1, D1
+     * });
+     *
+     * // Set the match entire cell.
      * await textFinder.matchEntireCellAsync(true);
+     * matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation()); // A1
+     * });
      * ```
      */
     matchEntireCellAsync(matchEntireCell: boolean): Promise<IFTextFinder>;
     /**
-     * set the match formula text option
-     * @param {boolean} matchFormulaText whether to match formula text
-     * @returns text-finder instance
+     * Set the match formula text option, if true, the find operation will match formula text, otherwise, the find operation will match value.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @param {boolean} matchFormulaText - Whether to match formula text.
+     * @returns {Promise<IFTextFinder>} The text-finder instance.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('hello');
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D1');
+     * fRange.setValues([
+     *   ['sum', '1', '=SUM(2)', '3'],
+     * ]);
+     *
+     * // Create a text-finder to find the text 'sum'.
+     * const textFinder = await univerAPI.createTextFinderAsync('sum');
+     * let matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation()); // A1
+     * });
+     *
+     * // Set the match entire cell.
      * await textFinder.matchFormulaTextAsync(true);
+     * matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation()); // A1, C1
+     * });
      * ```
      */
     matchFormulaTextAsync(matchFormulaText: boolean): Promise<IFTextFinder>;
     /**
-     * replace all the matched text with the given text
-     * @param {string} replaceText the text to replace
-     * @returns the number of replaced text
-     * @throws if the find operation is not completed
+     * Replace all the matched text with the given text.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @param {string} replaceText - The text to replace.
+     * @returns {Promise<number>} The count of replaced text.
+     * @throws If the find operation is not completed.
      * @example
      * ```typescript
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D1');
+     * fRange.setValues([
+     *   ['hello', 'hello', 'hello', 'hello'],
+     * ]);
+     *
+     * // Create a text-finder to find the text 'hello'.
      * const textFinder = await univerAPI.createTextFinderAsync('hello');
-     * const replacedCount = await textFinder.replaceAllWithAsync('world');
-     * console.log(replacedCount);
+     *
+     * // Replace all the matched text with 'hello univer'.
+     * const count = await textFinder.replaceAllWithAsync('hello univer');
+     * console.log(count); // 4
+     * console.log(fRange.getValues()); // [['hello univer', 'hello univer', 'hello univer', 'hello univer']]
      * ```
      */
     replaceAllWithAsync(replaceText: string): Promise<number>;
     /**
-     * replace the current matched text with the given text
-     * @param {string} replaceText the text to replace
-     * @returns whether the replace is successful
-     * @throws if the find operation is not completed
+     * Replace the current matched text with the given text.
+     * If current sheet changed, use `await textFinder.ensureCompleteAsync()` to ensure the find operation is completed.
+     * @param {string} replaceText - The text to replace.
+     * @returns {Promise<boolean>} Whether the replace is successful.
+     * @throws If the find operation is not completed.
      * @example
      * ```typescript
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('B1:E1');
+     * fRange.setValues([
+     *   ['hello', 'hello', 'hello', 'hello'],
+     * ]);
+     *
+     * // Create a text-finder to find the text 'hello'.
      * const textFinder = await univerAPI.createTextFinderAsync('hello');
-     * const replaced = await textFinder.replaceWithAsync('world');
-     * console.log(replaced);
+     *
+     * // Replace the current matched text with 'hello univer'.
+     * const replaced = await textFinder.replaceWithAsync('hello univer');
+     * console.log(replaced); // true
+     * console.log(fRange.getValues()); // [['hello', 'hello', 'hello', 'hello univer']]
      * ```
      */
     replaceWithAsync(replaceText: string): Promise<boolean>;
     /**
-     * ensure the find operation is completed
-     * @returns the find complete result
+     * Ensure the find operation is completed. Especially when the current sheet changed use this method to ensure the find operation is completed.
+     * @returns {Promise<Nullable<IFindComplete>>} The find complete result.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('hello');
-     * const complete = await textFinder.ensureCompleteAsync();
-     * console.log(complete);
+     * // Create a text-finder to find the text '1'.
+     * const textFinder = await univerAPI.createTextFinderAsync('1');
+     *
+     * // Find all cells that contain the text '1'.
+     * const matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation());
+     * });
+     *
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const sheets = fWorkbook.getSheets();
+     *
+     * // Change the current sheet to the second sheet.
+     * sheets[1]?.activate();
+     *
+     * // Ensure the find operation is completed of the current sheet.
+     * await textFinder.ensureCompleteAsync();
+     * const matchCells2 = textFinder.findAll();
+     * matchCells2.forEach((cell) => {
+     *   console.log(cell.getA1Notation());
+     * });
      * ```
      */
     ensureCompleteAsync(): Promise<Nullable<IFindComplete>>;

package/lib/types/facade/f-univer.d.ts

@@ -10,7 +10,31 @@ export interface IFUniverFindReplaceMixin {
      * @returns {Promise<FTextFinder | null>} A promise that resolves to the text-finder instance.
      * @example
      * ```typescript
-     * const textFinder = await univerAPI.createTextFinderAsync('Hello');
+     * // Assume the current sheet is empty sheet.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:D10');
+     * fRange.setValues([
+     *   [1, 2, 3, 4],
+     *   [2, 3, 4, 5],
+     *   [3, 4, 5, 6],
+     *   [4, 5, 6, 7],
+     *   [5, 6, 7, 8],
+     *   [6, 7, 8, 9],
+     *   [7, 8, 9, 10],
+     *   [8, 9, 10, 11],
+     *   [9, 10, 11, 12],
+     *   [10, 11, 12, 13]
+     * ]);
+     *
+     * // Create a text-finder to find the text '5'.
+     * const textFinder = await univerAPI.createTextFinderAsync('5');
+     *
+     * // Find all cells that contain the text '5'.
+     * const matchCells = textFinder.findAll();
+     * matchCells.forEach((cell) => {
+     *   console.log(cell.getA1Notation()); // D2, C3, B4, A5
+     * });
      * ```
      */
     createTextFinderAsync(text: string): Promise<FTextFinder | null>;

package/lib/umd/facade.js

@@ -1 +1 @@
-(function(i,n){typeof exports=="object"&&typeof module<"u"?n(require("@univerjs/core"),require("@univerjs/find-replace"),require("@univerjs/sheets/facade"),require("@univerjs/core/facade")):typeof define=="function"&&define.amd?define(["@univerjs/core","@univerjs/find-replace","@univerjs/sheets/facade","@univerjs/core/facade"],n):(i=typeof globalThis<"u"?globalThis:i||self,n(i.UniverCore,i.UniverFindReplace,i.UniverSheetsFacade,i.UniverCoreFacade))})(this,function(i,n,c,_){"use strict";var v=Object.defineProperty;var F=(i,n,c)=>n in i?v(i,n,{enumerable:!0,configurable:!0,writable:!0,value:c}):i[n]=c;var u=(i,n,c)=>F(i,typeof n!="symbol"?n+"":n,c);var p=Object.getOwnPropertyDescriptor,f=(o,e,t,s)=>{for(var r=s>1?void 0:s?p(e,t):e,a=o.length-1,h;a>=0;a--)(h=o[a])&&(r=h(r)||r);return r},d=(o,e)=>(t,s)=>e(t,s,o);let l=class extends i.Disposable{constructor(e,t,s,r){super();u(this,"_state",new n.FindReplaceState);u(this,"_model");u(this,"_complete");this._injector=t,this._univerInstanceService=s,this._findReplaceService=r;const a=this._findReplaceService.getProviders();this._model=this._injector.createInstance(n.FindReplaceModel,this._state,a);const h={...n.createInitFindReplaceState(),...e};this._state.changeState(h)}findAll(){return!this._state.findCompleted||!this._complete?[]:this._complete.results.map(e=>this._findMatchToFRange(e))}findNext(){var t;if(!this._state.findCompleted||!this._complete)return null;const e=(t=this._model)==null?void 0:t.moveToNextMatch();return e?this._findMatchToFRange(e):null}findPrevious(){var t;const e=(t=this._model)==null?void 0:t.moveToPreviousMatch();return e?this._findMatchToFRange(e):null}getCurrentMatch(){var t;if(!this._state.findCompleted||!this._complete)throw new Error("Find operation is not completed.");const e=(t=this._model)==null?void 0:t.currentMatch$.value;return e?this._findMatchToFRange(e):null}async matchCaseAsync(e){return this._state.changeState({caseSensitive:e}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(r=>{r.findCompleted===!0&&(s.unsubscribe(),t(this))})})}async matchEntireCellAsync(e){return this._state.changeState({matchesTheWholeCell:e}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(r=>{r.findCompleted===!0&&(s.unsubscribe(),t(this))})})}async matchFormulaTextAsync(e){return this._state.changeState({findBy:e?n.FindBy.FORMULA:n.FindBy.VALUE}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(r=>{r.findCompleted===!0&&(s.unsubscribe(),t(this))})})}async replaceAllWithAsync(e){var s,r,a;await this._state.changeState({replaceRevealed:!0,replaceString:e});const t=(a=(r=await((s=this._model)==null?void 0:s.replaceAll()))==null?void 0:r.success)!=null?a:0;return this._state.changeState({replaceRevealed:!1}),t}async replaceWithAsync(e){var t;return await this._state.changeState({replaceRevealed:!0,replaceString:e}),await((t=this._model)==null?void 0:t.replace()),this._state.changeState({replaceRevealed:!1}),!0}async ensureCompleteAsync(){var e;return(!this._state.findCompleted||!this._complete)&&(this._complete=await((e=this._model)==null?void 0:e.start())),this._complete}_findMatchToFRange(e){const{unitId:t}=e,{subUnitId:s,range:r}=e.range,a=this._univerInstanceService.getUnit(t),h=a.getSheetBySheetId(s);return this._injector.createInstance(c.FRange,a,h,r)}};l=f([d(1,i.Inject(i.Injector)),d(2,i.IUniverInstanceService),d(3,n.IFindReplaceService)],l);class m extends _.FUniver{async createTextFinderAsync(e){const t={findString:e},s=this._injector.createInstance(l,t);return await s.ensureCompleteAsync(),s}}_.FUniver.extend(m)});
+(function(i,n){typeof exports=="object"&&typeof module<"u"?n(require("@univerjs/core"),require("@univerjs/find-replace"),require("@univerjs/sheets/facade"),require("@univerjs/core/facade")):typeof define=="function"&&define.amd?define(["@univerjs/core","@univerjs/find-replace","@univerjs/sheets/facade","@univerjs/core/facade"],n):(i=typeof globalThis<"u"?globalThis:i||self,n(i.UniverCore,i.UniverFindReplace,i.UniverSheetsFacade,i.UniverCoreFacade))})(this,function(i,n,c,p){"use strict";var v=Object.defineProperty;var y=(i,n,c)=>n in i?v(i,n,{enumerable:!0,configurable:!0,writable:!0,value:c}):i[n]=c;var l=(i,n,c)=>y(i,typeof n!="symbol"?n+"":n,c);var _=Object.getOwnPropertyDescriptor,f=(o,e,t,s)=>{for(var r=s>1?void 0:s?_(e,t):e,a=o.length-1,h;a>=0;a--)(h=o[a])&&(r=h(r)||r);return r},u=(o,e)=>(t,s)=>e(t,s,o);let d=class extends i.Disposable{constructor(e,t,s,r){super();l(this,"_state",new n.FindReplaceState);l(this,"_model");l(this,"_complete");this._injector=t,this._univerInstanceService=s,this._findReplaceService=r;const a=this._findReplaceService.getProviders();this._model=this._injector.createInstance(n.FindReplaceModel,this._state,a);const h={...n.createInitFindReplaceState(),...e};this._state.changeState(h)}findAll(){return!this._state.findCompleted||!this._complete?[]:this._complete.results.map(e=>this._findMatchToFRange(e))}findNext(){var t;if(!this._state.findCompleted||!this._complete)return null;const e=(t=this._model)==null?void 0:t.moveToNextMatch();return e?this._findMatchToFRange(e):null}findPrevious(){var t;const e=(t=this._model)==null?void 0:t.moveToPreviousMatch();return e?this._findMatchToFRange(e):null}getCurrentMatch(){var t;if(!this._state.findCompleted||!this._complete)throw new Error("Find operation is not completed.");const e=(t=this._model)==null?void 0:t.currentMatch$.value;return e?this._findMatchToFRange(e):null}async matchCaseAsync(e){return this._state.changeState({caseSensitive:e,findCompleted:!1}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(async r=>{r.findCompleted===!0&&(s.unsubscribe(),await this.ensureCompleteAsync(),t(this))})})}async matchEntireCellAsync(e){return this._state.changeState({matchesTheWholeCell:e,findCompleted:!1}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(async r=>{r.findCompleted===!0&&(s.unsubscribe(),await this.ensureCompleteAsync(),t(this))})})}async matchFormulaTextAsync(e){return this._state.changeState({findBy:e?n.FindBy.FORMULA:n.FindBy.VALUE,findCompleted:!1}),new Promise(t=>{const s=this._state.stateUpdates$.subscribe(async r=>{r.findCompleted===!0&&(s.unsubscribe(),await this.ensureCompleteAsync(),t(this))})})}async replaceAllWithAsync(e){var s,r,a;await this._state.changeState({replaceRevealed:!0,replaceString:e});const t=(a=(r=await((s=this._model)==null?void 0:s.replaceAll()))==null?void 0:r.success)!=null?a:0;return this._state.changeState({replaceRevealed:!1}),t}async replaceWithAsync(e){var t;return await this._state.changeState({replaceRevealed:!0,replaceString:e}),await((t=this._model)==null?void 0:t.replace()),this._state.changeState({replaceRevealed:!1}),!0}async ensureCompleteAsync(){var e;this._complete=await((e=this._model)==null?void 0:e.start())}_findMatchToFRange(e){const{unitId:t}=e,{subUnitId:s,range:r}=e.range,a=this._univerInstanceService.getUnit(t),h=a.getSheetBySheetId(s);return this._injector.createInstance(c.FRange,a,h,r)}};d=f([u(1,i.Inject(i.Injector)),u(2,i.IUniverInstanceService),u(3,n.IFindReplaceService)],d);class m extends p.FUniver{async createTextFinderAsync(e){const t={findString:e},s=this._injector.createInstance(d,t);return await s.ensureCompleteAsync(),s}}p.FUniver.extend(m)});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-find-replace",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "private": false,
   "description": "UniverSheet find replace plugin",
   "author": "DreamNum <developer@univer.ai>",
@@ -58,18 +58,18 @@
     "rxjs": ">=7.0.0"
   },
   "dependencies": {
-    "@univerjs/core": "0.6.0",
-    "@univerjs/find-replace": "0.6.0",
-    "@univerjs/engine-render": "0.6.0",
-    "@univerjs/sheets-ui": "0.6.0",
-    "@univerjs/sheets": "0.6.0"
+    "@univerjs/core": "0.6.1",
+    "@univerjs/engine-render": "0.6.1",
+    "@univerjs/sheets": "0.6.1",
+    "@univerjs/find-replace": "0.6.1",
+    "@univerjs/sheets-ui": "0.6.1"
   },
   "devDependencies": {
     "rxjs": "^7.8.1",
     "typescript": "^5.7.3",
-    "vite": "^6.1.0",
-    "vitest": "^3.0.5",
-    "@univerjs-infra/shared": "0.6.0"
+    "vite": "^6.1.1",
+    "vitest": "^3.0.6",
+    "@univerjs-infra/shared": "0.6.1"
   },
   "scripts": {
     "test": "vitest run",