@univerjs/engine-formula 0.12.4-experimental.20251210-8d33c6e → 0.12.4-experimental.20251210-d708bff

package/lib/facade.js

@@ -1,13 +1,13 @@
-import { FBase as _, FUniver as C } from "@univerjs/core/facade";
-import { Inject as u, ICommandService as v, Injector as h, IConfigService as x } from "@univerjs/core";
-import { LexerTreeBuilder as g, SetFormulaCalculationStartMutation as m, SetFormulaCalculationStopMutation as F, SetFormulaCalculationNotificationMutation as d, GlobalComputingStatusService as E, ENGINE_FORMULA_CYCLE_REFERENCE_COUNT as y, SetFormulaCalculationResultMutation as T, SetFormulaStringBatchCalculationMutation as R, SetFormulaStringBatchCalculationResultMutation as M, SetFormulaDependencyCalculationMutation as D, SetFormulaDependencyCalculationResultMutation as I, SetCellFormulaDependencyCalculationMutation as b, SetCellFormulaDependencyCalculationResultMutation as B, SetQueryFormulaDependencyMutation as p, SetQueryFormulaDependencyResultMutation as f } from "@univerjs/engine-formula";
-import { firstValueFrom as L, race as P, filter as w, timer as N, map as O } from "rxjs";
-var j = Object.getOwnPropertyDescriptor, A = (e, t, i, r) => {
-  for (var n = r > 1 ? void 0 : r ? j(t, i) : t, a = e.length - 1, o; a >= 0; a--)
+import { FBase as h, FUniver as S } from "@univerjs/core/facade";
+import { Inject as c, ICommandService as _, Injector as v, IConfigService as g } from "@univerjs/core";
+import { LexerTreeBuilder as x, SetFormulaCalculationStartMutation as d, SetFormulaCalculationStopMutation as E, SetFormulaCalculationNotificationMutation as p, GlobalComputingStatusService as F, ENGINE_FORMULA_CYCLE_REFERENCE_COUNT as T, SetFormulaCalculationResultMutation as y, SetFormulaStringBatchCalculationResultMutation as w, SetFormulaStringBatchCalculationMutation as R, SetFormulaDependencyCalculationResultMutation as M, SetFormulaDependencyCalculationMutation as b, SetCellFormulaDependencyCalculationResultMutation as D, SetCellFormulaDependencyCalculationMutation as I, SetQueryFormulaDependencyResultMutation as f, SetQueryFormulaDependencyMutation as C } from "@univerjs/engine-formula";
+import { firstValueFrom as P, race as B, filter as L, timer as N, map as O } from "rxjs";
+var A = Object.getOwnPropertyDescriptor, j = (e, t, i, r) => {
+  for (var n = r > 1 ? void 0 : r ? A(t, i) : t, a = e.length - 1, o; a >= 0; a--)
     (o = e[a]) && (n = o(n) || n);
   return n;
-}, s = (e, t) => (i, r) => t(i, r, e);
-let c = class extends _ {
+}, u = (e, t) => (i, r) => t(i, r, e);
+let m = class extends h {
   constructor(e, t, i, r) {
     super(), this._commandService = e, this._injector = t, this._lexerTreeBuilder = i, this._configService = r, this._initialize();
   }
@@ -66,7 +66,7 @@ let c = class extends _ {
    * ```
    */
   executeCalculation() {
-    this._commandService.executeCommand(m.id, { commands: [], forceCalculation: !0 }, { onlyLocal: !0 });
+    this._commandService.executeCommand(d.id, { commands: [], forceCalculation: !0 }, { onlyLocal: !0 });
   }
   /**
    * Stop the calculation of the formula.
@@ -78,7 +78,7 @@ let c = class extends _ {
    * ```
    */
   stopCalculation() {
-    this._commandService.executeCommand(F.id, {});
+    this._commandService.executeCommand(E.id, {});
   }
   /**
    * Listening calculation starts.
@@ -95,7 +95,7 @@ let c = class extends _ {
    */
   calculationStart(e) {
     return this._commandService.onCommandExecuted((t) => {
-      if (t.id === m.id) {
+      if (t.id === d.id) {
         const i = t.params;
         e(i.forceCalculation);
       }
@@ -116,7 +116,7 @@ let c = class extends _ {
    */
   calculationEnd(e) {
     return this._commandService.onCommandExecuted((t) => {
-      if (t.id !== d.id)
+      if (t.id !== p.id)
         return;
       const i = t.params;
       i.functionsExecutedState !== void 0 && e(i.functionsExecutedState);
@@ -139,9 +139,9 @@ let c = class extends _ {
    * ```
    */
   whenComputingCompleteAsync(e) {
-    const t = this._injector.get(E);
-    return t.computingStatus ? Promise.resolve(!0) : L(P(
-      t.computingStatus$.pipe(w((i) => i)),
+    const t = this._injector.get(F);
+    return t.computingStatus ? Promise.resolve(!0) : P(B(
+      t.computingStatus$.pipe(L((i) => i)),
       N(e != null ? e : 3e4).pipe(O(() => !1))
     ));
   }
@@ -173,7 +173,7 @@ let c = class extends _ {
    */
   calculationProcessing(e) {
     return this._commandService.onCommandExecuted((t) => {
-      if (t.id !== d.id)
+      if (t.id !== p.id)
         return;
       const i = t.params;
       i.stageInfo !== void 0 && e(i.stageInfo);
@@ -192,7 +192,7 @@ let c = class extends _ {
    * ```
    */
   setMaxIteration(e) {
-    this._configService.setConfig(y, e);
+    this._configService.setConfig(T, e);
   }
   /**
    * Listens for the moment when formula-calculation results are applied.
@@ -219,7 +219,7 @@ let c = class extends _ {
    */
   calculationResultApplied(e) {
     return this._commandService.onCommandExecuted((t) => {
-      if (t.id !== T.id)
+      if (t.id !== y.id)
         return;
       const i = t.params;
       i !== void 0 && requestIdleCallback(() => {
@@ -264,11 +264,11 @@ let c = class extends _ {
         i || (l(), e());
       }, 500), o = this.calculationProcessing(() => {
         i || (i = !0, clearTimeout(a));
-      }), S = this.calculationResultApplied(() => {
+      }), s = this.calculationResultApplied(() => {
         r || (r = !0, l(), e());
       });
       function l() {
-        clearTimeout(n), clearTimeout(a), o.dispose(), S.dispose();
+        clearTimeout(n), clearTimeout(a), o.dispose(), s.dispose();
       }
     });
   }
@@ -299,11 +299,13 @@ let c = class extends _ {
    *        Nested structure (unit → sheet → row → column) describing formulas and
    *        their decomposed sub-expressions.
    *
-   * @param {(result: IFormulaExecuteResultMap) => void} callback
-   *        Receives the computed value map mirroring the input structure.
+   * @param {number} [timeout]
+   *        Optional timeout in milliseconds. If no result is received within this
+   *        period, the promise will be rejected.
    *
-   * @returns {IDisposable}
-   *          A disposer to stop listening for batch results.
+   * @returns {Promise<IFormulaExecuteResultMap>}
+   *          A promise that resolves with the computed value map mirroring
+   *          the input structure.
    *
    * @example
    * ```ts
@@ -335,19 +337,25 @@ let c = class extends _ {
    *   },
    * };
    *
-   * const disposer = formulaEngine.executeFormulas(formulas, (result) => {
-   *   console.log(result);
-   * });
-   *
+   * const result = await formulaEngine.executeFormulas(formulas);
+   * console.log(result);
    * ```
    */
-  executeFormulas(e, t) {
-    this._commandService.executeCommand(R.id, { formulas: e }, { onlyLocal: !0 });
-    const i = this._commandService.onCommandExecuted((r) => {
-      if (r.id !== M.id)
-        return;
-      const n = r.params;
-      n.result != null && t(n.result), i.dispose();
+  executeFormulas(e, t = 3e4) {
+    return new Promise((i, r) => {
+      const n = this._commandService.onCommandExecuted((o) => {
+        if (o.id !== w.id)
+          return;
+        const s = o.params;
+        clearTimeout(a), n.dispose(), s.result != null ? i(s.result) : r(new Error("Formula batch calculation returned no result"));
+      }), a = setTimeout(() => {
+        n.dispose(), r(new Error("Formula batch calculation timeout"));
+      }, t);
+      this._commandService.executeCommand(
+        R.id,
+        { formulas: e },
+        { onlyLocal: !0 }
+      );
     });
   }
   /**
@@ -355,28 +363,37 @@ let c = class extends _ {
    * dependency-analysis run. This triggers a local dependency-calculation command
    * and returns the complete set of dependency trees once the calculation finishes.
    *
-   * @param callback A function invoked with the resulting array of dependency trees.
+   * @param {number} [timeout]
+   *        Optional timeout in milliseconds. If no result is received within this
+   *        period, the promise will be rejected.
    *
-   * @returns {IDisposable} An object that disposes the internal event listener.
+   * @returns {Promise<IFormulaDependencyTreeJson[]>}
+   *          A promise that resolves with the array of dependency trees.
    *
    * @example
    * ```ts
    * const formulaEngine = univerAPI.getFormula();
    *
    * // Fetch all dependency trees generated for the current workbook.
-   * const disposable = formulaEngine.getAllDependencyTrees((trees) => {
-   *     console.log('All dependency trees:', trees);
-   * });
-   *
+   * const trees = await formulaEngine.getAllDependencyTrees();
+   * console.log('All dependency trees:', trees);
    * ```
    */
-  getAllDependencyTrees(e) {
-    this._commandService.executeCommand(D.id, void 0, { onlyLocal: !0 });
-    const t = this._commandService.onCommandExecuted((i) => {
-      if (i.id !== I.id)
-        return;
-      const r = i.params;
-      r.result != null && e(r.result), t.dispose();
+  getAllDependencyTrees(e = 3e4) {
+    return new Promise((t, i) => {
+      const r = this._commandService.onCommandExecuted((a) => {
+        if (a.id !== M.id)
+          return;
+        const o = a.params;
+        clearTimeout(n), r.dispose(), o.result != null ? t(o.result) : t([]);
+      }), n = setTimeout(() => {
+        r.dispose(), i(new Error("Formula dependency calculation timeout"));
+      }, e);
+      this._commandService.executeCommand(
+        b.id,
+        void 0,
+        { onlyLocal: !0 }
+      );
     });
   }
   /**
@@ -390,38 +407,50 @@ let c = class extends _ {
    *   - `row`     The zero-based row index.
    *   - `column`  The zero-based column index.
    *
-   * @param callback A function invoked with the resulting dependency tree or
-   * `undefined` if no dependency tree exists for that cell.
+   * @param {number} [timeout]
+   *        Optional timeout in milliseconds. If no result is received within this
+   *        period, the promise will be rejected.
    *
-   * @returns {IDisposable} An object that disposes the internal event listener.
+   * @returns {Promise<IFormulaDependencyTreeFullJson | undefined>}
+   *          A promise that resolves with the dependency tree or `undefined`
+   *          if no tree exists for that cell.
    *
    * @example
    * ```ts
    * const formulaEngine = univerAPI.getFormula();
    *
    * // Query the dependency tree for cell B2 in a specific sheet.
-   * const disposable = formulaEngine.getCellDependencyTree(
-   *     { unitId: 'workbook1', sheetId: 'sheet1', row: 1, column: 1 },
-   *     (tree) => {
-   *         console.log('Cell dependency tree:', tree);
-   *     }
-   * );
+   * const tree = await formulaEngine.getCellDependencyTree({
+   *   unitId: 'workbook1',
+   *   sheetId: 'sheet1',
+   *   row: 1,
+   *   column: 1,
+   * });
    *
+   * console.log('Cell dependency tree:', tree);
    * ```
    */
-  getCellDependencyTree(e, t) {
-    this._commandService.executeCommand(b.id, e, { onlyLocal: !0 });
-    const i = this._commandService.onCommandExecuted((r) => {
-      if (r.id !== B.id)
-        return;
-      const n = r.params;
-      n.result !== void 0 && t(n.result), i.dispose();
+  getCellDependencyTree(e, t = 3e4) {
+    return new Promise((i, r) => {
+      const n = this._commandService.onCommandExecuted((o) => {
+        if (o.id !== D.id)
+          return;
+        const s = o.params;
+        clearTimeout(a), n.dispose(), i(s.result);
+      }), a = setTimeout(() => {
+        n.dispose(), r(new Error("Cell dependency calculation timeout"));
+      }, t);
+      this._commandService.executeCommand(
+        I.id,
+        e,
+        { onlyLocal: !0 }
+      );
     });
   }
   /**
    * Retrieve the full dependency trees for all formulas that *depend on* the
    * specified ranges. This triggers a local dependency-calculation command and
-   * invokes the callback once the calculation completes.
+   * resolves once the calculation completes.
    *
    * @param unitRanges An array of workbook/sheet ranges to query. Each range
    *   includes:
@@ -429,30 +458,41 @@ let c = class extends _ {
    *   - `sheetId` The sheet ID.
    *   - `range`   The row/column boundaries.
    *
-   * @param callback A function invoked with an array of `IFormulaDependencyTreeJson`
-   * results. Each entry represents a formula node and its parent/child
-   * relationships within the dependency graph.
+   * @param {number} [timeout]
+   *        Optional timeout in milliseconds. If no result is received within this
+   *        period, the promise will be rejected.
+   *
+   * @returns {Promise<IFormulaDependencyTreeJson[]>}
+   *          A promise that resolves with an array of `IFormulaDependencyTreeJson`
+   *          representing formulas and their relationships within the dependency graph.
    *
    * @example
    * ```ts
    * const formulaEngine = univerAPI.getFormula();
    *
    * // Query all formulas that depend on A1:B10 in Sheet1.
-   * formulaEngine.getRangeDependents(
-   *     [{ unitId: 'workbook1', sheetId: 'sheet1', range: { startRow: 0, endRow: 9, startColumn: 0, endColumn: 1 } }],
-   *     (result) => {
-   *         console.log('Dependent formulas:', result);
-   *     }
-   * );
+   * const dependents = await formulaEngine.getRangeDependents([
+   *   { unitId: 'workbook1', sheetId: 'sheet1', range: { startRow: 0, endRow: 9, startColumn: 0, endColumn: 1 } }
+   * ]);
+   *
+   * console.log('Dependent formulas:', dependents);
    * ```
    */
-  getRangeDependents(e, t) {
-    this._commandService.executeCommand(p.id, { unitRanges: e }, { onlyLocal: !0 });
-    const i = this._commandService.onCommandExecuted((r) => {
-      if (r.id !== f.id)
-        return;
-      const n = r.params;
-      n.result != null && t(n.result), i.dispose();
+  getRangeDependents(e, t = 3e4) {
+    return new Promise((i, r) => {
+      const n = this._commandService.onCommandExecuted((o) => {
+        if (o.id !== f.id)
+          return;
+        const s = o.params;
+        clearTimeout(a), n.dispose(), s.result != null ? i(s.result) : i([]);
+      }), a = setTimeout(() => {
+        n.dispose(), r(new Error("Range dependents calculation timeout"));
+      }, t);
+      this._commandService.executeCommand(
+        C.id,
+        { unitRanges: e },
+        { onlyLocal: !0 }
+      );
     });
   }
   /**
@@ -461,7 +501,7 @@ let c = class extends _ {
    * physically reside within the queried ranges.
    *
    * Internally this triggers the same dependency-calculation command but with
-   * `isInRange = true`, and the callback is invoked when the results are ready.
+   * `isInRange = true`, and the promise resolves when the results are ready.
    *
    * @param unitRanges An array of workbook/sheet ranges defining the lookup
    *   boundaries:
@@ -469,45 +509,57 @@ let c = class extends _ {
    *   - `sheetId` The sheet ID.
    *   - `range`   The zero-based grid range.
    *
-   * @param callback Receives an array of `IFormulaDependencyTreeJson` describing
-   * every formula found in the provided ranges along with their parent/child
-   * relationships.
+   * @param {number} [timeout]
+   *        Optional timeout in milliseconds. If no result is received within this
+   *        period, the promise will be rejected.
+   *
+   * @returns {Promise<IFormulaDependencyTreeJson[]>}
+   *          A promise that resolves with an array of `IFormulaDependencyTreeJson`
+   *          describing every formula found in the provided ranges along with
+   *          their parent/child relationships.
    *
    * @example
    * ```ts
    * const formulaEngine = univerAPI.getFormula();
    *
    * // Query all formulas that lie within A1:D20 in Sheet1.
-   * formulaEngine.getInRangeFormulas(
-   *     [{ unitId: 'workbook1', sheetId: 'sheet1', range: { startRow: 0, endRow: 19, startColumn: 0, endColumn: 3 } }],
-   *     (result) => {
-   *         console.log('Formulas inside range:', result);
-   *     }
-   * );
+   * const formulasInRange = await formulaEngine.getInRangeFormulas([
+   *   { unitId: 'workbook1', sheetId: 'sheet1', range: { startRow: 0, endRow: 19, startColumn: 0, endColumn: 3 } }
+   * ]);
+   *
+   * console.log('Formulas inside range:', formulasInRange);
    * ```
    */
-  getInRangeFormulas(e, t) {
-    this._commandService.executeCommand(p.id, { unitRanges: e, isInRange: !0 }, { onlyLocal: !0 });
-    const i = this._commandService.onCommandExecuted((r) => {
-      if (r.id !== f.id)
-        return;
-      const n = r.params;
-      n.result != null && t(n.result), i.dispose();
+  getInRangeFormulas(e, t = 3e4) {
+    return new Promise((i, r) => {
+      const n = this._commandService.onCommandExecuted((o) => {
+        if (o.id !== f.id)
+          return;
+        const s = o.params;
+        clearTimeout(a), n.dispose(), s.result != null ? i(s.result) : i([]);
+      }), a = setTimeout(() => {
+        n.dispose(), r(new Error("In-range formulas calculation timeout"));
+      }, t);
+      this._commandService.executeCommand(
+        C.id,
+        { unitRanges: e, isInRange: !0 },
+        { onlyLocal: !0 }
+      );
     });
   }
 };
-c = A([
-  s(0, u(v)),
-  s(1, u(h)),
-  s(2, u(g)),
-  s(3, x)
-], c);
-class U extends C {
+m = j([
+  u(0, c(_)),
+  u(1, c(v)),
+  u(2, c(x)),
+  u(3, g)
+], m);
+class U extends S {
   getFormula() {
-    return this._injector.createInstance(c);
+    return this._injector.createInstance(m);
   }
 }
-C.extend(U);
+S.extend(U);
 export {
-  c as FFormula
+  m as FFormula
 };

package/lib/index.js

@@ -10806,6 +10806,19 @@ let ia = class extends Me {
       r && t.push(r.toJson());
     return this._endFormulaDependencyTreeModel(), t;
   }
+  _setRealFormulaString(a) {
+    if (!a.refTreeId)
+      return;
+    const e = this._getTreeById(a.refTreeId);
+    if (!e)
+      return;
+    const t = this._lexerTreeBuilder.moveFormulaRefOffset(
+      e.formula,
+      a.refOffsetX,
+      a.refOffsetY
+    );
+    a.formula = t;
+  }
   async getCellDependencyJson(a, e, t, r) {
     await this._initializeGenerateTreeList();
     const n = this._dependencyManagerService.getFormulaDependency(a, e, t, r);
@@ -10816,27 +10829,14 @@ let ia = class extends Me {
       return;
     this._startFormulaDependencyTreeModel();
     const o = this._getFormulaDependencyTreeModel(s);
-    if (s.isVirtual) {
-      const c = this._lexerTreeBuilder.moveFormulaRefOffset(
-        s.formula,
-        s.refOffsetX,
-        s.refOffsetY
-      );
-      o.formula = c;
-    }
+    this._setRealFormulaString(o);
     const u = this._getDependencyTreeChildrenIds(s);
     for (const c of u) {
-      const l = this._getTreeModel(c), f = this._getTreeById(c);
-      if (f && f.isVirtual) {
-        const m = this._lexerTreeBuilder.moveFormulaRefOffset(
-          f.formula,
-          f.refOffsetX,
-          f.refOffsetY
-        );
-        l.formula = m;
-      }
-      o.addChild(l);
+      const l = this._getTreeModel(c);
+      this._setRealFormulaString(l), o.addChild(l);
     }
+    for (const c of o.parents)
+      this._setRealFormulaString(c);
     return this._endFormulaDependencyTreeModel(), o.toFullJson();
   }
   async getRangeDependents(a) {
@@ -10847,15 +10847,7 @@ let ia = class extends Me {
       if (!s)
         continue;
       const o = this._getFormulaDependencyTreeModel(s);
-      if (s.isVirtual) {
-        const u = this._lexerTreeBuilder.moveFormulaRefOffset(
-          s.formula,
-          s.refOffsetX,
-          s.refOffsetY
-        );
-        o.formula = u;
-      }
-      t.push(o);
+      this._setRealFormulaString(o), t.push(o);
     }
     const r = [];
     for (const n of t)
@@ -10876,15 +10868,7 @@ let ia = class extends Me {
     const r = [];
     for (const s of t) {
       const o = this._getFormulaDependencyTreeModel(s);
-      if (s.isVirtual) {
-        const u = this._lexerTreeBuilder.moveFormulaRefOffset(
-          s.formula,
-          s.refOffsetX,
-          s.refOffsetY
-        );
-        o.formula = u;
-      }
-      r[s.treeId] = o;
+      this._setRealFormulaString(o), r[s.treeId] = o;
     }
     const n = [];
     for (const s of r)

package/lib/types/engine/dependency/formula-dependency.d.ts

@@ -126,6 +126,7 @@ export declare class FormulaDependencyGenerator extends Disposable {
     protected _endFormulaDependencyTreeModel(): void;
     protected _startFormulaDependencyTreeModel(): void;
     getAllDependencyJson(): Promise<IFormulaDependencyTreeJson[]>;
+    protected _setRealFormulaString(treeModel: FormulaDependencyTreeModel): void;
     getCellDependencyJson(unitId: string, sheetId: string, row: number, column: number): Promise<IFormulaDependencyTreeFullJson | undefined>;
     getRangeDependents(unitRanges: IUnitRange[]): Promise<IFormulaDependencyTreeJson[]>;
     getInRangeFormulas(unitRanges: IUnitRange[]): Promise<IFormulaDependencyTreeJson[]>;