@univerjs/engine-formula 0.1.9 → 0.1.11

package/lib/types/models/formula-data.model.d.ts

@@ -1,7 +1,7 @@
-import { IFormulaIdMap } from './utils/formula-data-util';
-import { LexerTreeBuilder } from '../engine/analysis/lexer-tree-builder';
-import { IArrayFormulaRangeType, IArrayFormulaUnitCellType, IFormulaData, IFormulaDataItem, IRuntimeUnitDataType, IUnitData, IUnitSheetNameMap } from '../basics/common';
 import { ICellData, IObjectMatrixPrimitiveType, IRange, Nullable, Disposable, IUniverInstanceService, ObjectMatrix } from '@univerjs/core';
+import { IArrayFormulaRangeType, IArrayFormulaUnitCellType, IFormulaData, IFormulaDataItem, IRuntimeUnitDataType, IUnitData, IUnitSheetNameMap } from '../basics/common';
+import { LexerTreeBuilder } from '../engine/analysis/lexer-tree-builder';
+import { IFormulaIdMap } from './utils/formula-data-util';
 
 export interface IRangeChange {
     oldCell: IRange;
@@ -25,6 +25,10 @@ export declare class FormulaDataModel extends Disposable {
     mergeArrayFormulaRange(formulaData: IArrayFormulaRangeType): void;
     mergeFormulaData(formulaData: IFormulaData): void;
     deleteArrayFormulaRange(unitId: string, sheetId: string, row: number, column: number): void;
+    /**
+     * Cache all formulas on the snapshot to the formula model
+     * @returns
+     */
     initFormulaData(): void;
     getCalculateData(): {
         allUnitData: IUnitData;
@@ -36,9 +40,6 @@ export declare class FormulaDataModel extends Disposable {
     getFormulaItemBySId(sId: string, sheetId: string, unitId: string): Nullable<IFormulaDataItem>;
     getFormulaDataItem(row: number, column: number, sheetId: string, unitId: string): Nullable<IFormulaDataItem>;
     getFormulaIdMap(unitId: string, sheetId: string): Map<string, IFormulaIdMap>;
+    getFormulaStringByCell(row: number, column: number, sheetId: string, unitId: string): string | null;
 }
-export declare function initSheetFormulaData(formulaData: IFormulaData, unitId: string, sheetId: string, cellMatrix: ObjectMatrix<Nullable<ICellData>>): {
-    [x: string]: {
-        [x: string]: IObjectMatrixPrimitiveType<IFormulaDataItem>;
-    };
-};
+export declare function initSheetFormulaData(formulaData: IFormulaData, unitId: string, sheetId: string, cellMatrix: ObjectMatrix<Nullable<ICellData>>): IFormulaData;

package/lib/types/models/utils/formula-data-util.d.ts

@@ -1,5 +1,5 @@
-import { IFormulaDataItem } from '../../basics/common';
 import { ICellData, IRange, Nullable, ObjectMatrix } from '@univerjs/core';
+import { IFormulaDataItem } from '../../basics/common';
 
 export interface IFormulaIdMap {
     f: string;

package/lib/types/plugin.d.ts

@@ -1,7 +1,7 @@
-import { BaseFunction } from './functions/base-function';
-import { IFunctionNames } from './basics/function';
-import { Ctor, Injector } from '@wendellhu/redi';
 import { Plugin } from '@univerjs/core';
+import { Ctor, Injector } from '@wendellhu/redi';
+import { IFunctionNames } from './basics/function';
+import { BaseFunction } from './functions/base-function';
 
 interface IUniverFormulaEngine {
     notExecuteFormula?: boolean;

package/lib/types/services/active-dirty-manager.service.d.ts

@@ -1,5 +1,5 @@
-import { IDirtyUnitFeatureMap, IDirtyUnitOtherFormulaMap, IDirtyUnitSheetDefinedNameMap, IDirtyUnitSheetNameMap } from '../basics/common';
 import { ICommandInfo, IUnitRange, Nullable, Disposable } from '@univerjs/core';
+import { IDirtyUnitFeatureMap, IDirtyUnitOtherFormulaMap, IDirtyUnitSheetDefinedNameMap, IDirtyUnitSheetNameMap } from '../basics/common';
 
 export interface IDirtyConversionManagerParams {
     commandId: string;

package/lib/types/services/calculate-formula.service.d.ts

@@ -1,12 +1,12 @@
-import { IAllRuntimeData, IExecutionInProgressParams, IFormulaRuntimeService } from './runtime.service';
-import { IFormulaCurrentConfigService } from './current-data.service';
-import { Interpreter } from '../engine/interpreter/interpreter';
-import { FormulaDependencyGenerator } from '../engine/dependency/formula-dependency';
-import { ErrorNode } from '../engine/ast-node/base-ast-node';
-import { AstTreeBuilder } from '../engine/analysis/parser';
-import { Lexer } from '../engine/analysis/lexer';
-import { IFeatureDirtyRangeType, IFormulaDatasetConfig, IRuntimeUnitDataType } from '../basics/common';
 import { Disposable, IConfigService } from '@univerjs/core';
+import { IFeatureDirtyRangeType, IFormulaDatasetConfig, IRuntimeUnitDataType } from '../basics/common';
+import { Lexer } from '../engine/analysis/lexer';
+import { AstTreeBuilder } from '../engine/analysis/parser';
+import { ErrorNode } from '../engine/ast-node/base-ast-node';
+import { FormulaDependencyGenerator } from '../engine/dependency/formula-dependency';
+import { Interpreter } from '../engine/interpreter/interpreter';
+import { IFormulaCurrentConfigService } from './current-data.service';
+import { IAllRuntimeData, IExecutionInProgressParams, IFormulaRuntimeService } from './runtime.service';
 
 export declare const DEFAULT_CYCLE_REFERENCE_COUNT = 1;
 export declare const CYCLE_REFERENCE_COUNT = "cycleReferenceCount";
@@ -26,7 +26,6 @@ export declare class CalculateFormulaService extends Disposable {
     private readonly _executionInProgressListener$;
     readonly executionInProgressListener$: import('rxjs').Observable<IExecutionInProgressParams>;
     constructor(_configService: IConfigService, _lexer: Lexer, _currentConfigService: IFormulaCurrentConfigService, _runtimeService: IFormulaRuntimeService, _formulaDependencyGenerator: FormulaDependencyGenerator, _interpreter: Interpreter, _astTreeBuilder: AstTreeBuilder);
-    dispose(): void;
     /**
      * Stop the execution of the formula.
      */

package/lib/types/services/current-data.service.d.ts

@@ -1,5 +1,5 @@
-import { IDirtyUnitFeatureMap, IDirtyUnitOtherFormulaMap, IDirtyUnitSheetDefinedNameMap, IDirtyUnitSheetNameMap, IFormulaData, IFormulaDatasetConfig, IRuntimeUnitDataType, IUnitData, IUnitExcludedCell, IUnitSheetNameMap, IUnitStylesData } from '../basics/common';
 import { IUnitRange, Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { IDirtyUnitFeatureMap, IDirtyUnitOtherFormulaMap, IDirtyUnitSheetDefinedNameMap, IDirtyUnitSheetNameMap, IFormulaData, IFormulaDatasetConfig, IRuntimeUnitDataType, IUnitData, IUnitExcludedCell, IUnitSheetNameMap, IUnitStylesData } from '../basics/common';
 
 export declare const DEFAULT_DOCUMENT_SUB_COMPONENT_ID = "__default_document_sub_component_id20231101__";
 export interface IFormulaCurrentConfigService {

package/lib/types/services/defined-names.service.d.ts

@@ -1,5 +1,5 @@
-import { Observable } from 'rxjs';
 import { IUnitRange, Nullable, Disposable } from '@univerjs/core';
+import { Observable } from 'rxjs';
 
 export interface IDefinedNamesServiceParam {
     id: string;

package/lib/types/services/dependency-manager.service.d.ts

@@ -1,5 +1,5 @@
-import { FormulaDependencyTreeCache, FormulaDependencyTree } from '../engine/dependency/dependency-tree';
 import { Nullable, Disposable, ObjectMatrix } from '@univerjs/core';
+import { FormulaDependencyTreeCache, FormulaDependencyTree } from '../engine/dependency/dependency-tree';
 
 export interface IOtherFormulaDependencyParam {
     [unitId: string]: Nullable<{

package/lib/types/services/feature-calculation-manager.service.d.ts

@@ -1,6 +1,6 @@
-import { FormulaDependencyTree } from '../engine/dependency/dependency-tree';
-import { IFeatureDirtyRangeType, IRuntimeUnitDataType } from '../basics/common';
 import { IUnitRange, Nullable, Disposable } from '@univerjs/core';
+import { IFeatureDirtyRangeType, IRuntimeUnitDataType } from '../basics/common';
+import { FormulaDependencyTree } from '../engine/dependency/dependency-tree';
 
 export interface IFeatureCalculationManagerParam {
     unitId: string;

package/lib/types/services/function.service.d.ts

@@ -1,6 +1,7 @@
-import { BaseFunction } from '../functions/base-function';
-import { IFunctionInfo, IFunctionNames } from '../basics/function';
 import { Nullable, Disposable } from '@univerjs/core';
+import { IDisposable } from '@wendellhu/redi';
+import { IFunctionInfo, IFunctionNames } from '../basics/function';
+import { BaseFunction } from '../functions/base-function';
 
 export interface IFunctionService {
     /**
@@ -21,7 +22,7 @@ export interface IFunctionService {
     getExecutor(functionToken: IFunctionNames): Nullable<BaseFunction>;
     hasExecutor(functionToken: IFunctionNames): boolean;
     unregisterExecutors(...functionTokens: IFunctionNames[]): void;
-    registerDescriptions(...functions: IFunctionInfo[]): void;
+    registerDescriptions(...functions: IFunctionInfo[]): IDisposable;
     getDescriptions(): Map<IFunctionNames, IFunctionInfo>;
     getDescription(functionToken: IFunctionNames): Nullable<IFunctionInfo>;
     hasDescription(functionToken: IFunctionNames): boolean;
@@ -36,7 +37,7 @@ export declare class FunctionService extends Disposable implements IFunctionServ
     getExecutor(functionToken: IFunctionNames): BaseFunction | undefined;
     hasExecutor(functionToken: IFunctionNames): boolean;
     unregisterExecutors(...functionTokens: IFunctionNames[]): void;
-    registerDescriptions(...descriptions: IFunctionInfo[]): void;
+    registerDescriptions(...descriptions: IFunctionInfo[]): IDisposable;
     getDescriptions(): Map<IFunctionNames, IFunctionInfo>;
     getDescription(functionToken: IFunctionNames): IFunctionInfo | undefined;
     hasDescription(functionToken: IFunctionNames): boolean;

package/lib/types/services/other-formula-manager.service.d.ts

@@ -1,5 +1,5 @@
-import { IDirtyUnitOtherFormulaMap, IFormulaDataItem, IOtherFormulaData } from '../basics/common';
 import { Nullable, Disposable } from '@univerjs/core';
+import { IDirtyUnitOtherFormulaMap, IFormulaDataItem, IOtherFormulaData } from '../basics/common';
 
 export interface IOtherFormulaManagerSearchParam {
     unitId: string;

package/lib/types/services/runtime.service.d.ts

@@ -1,8 +1,8 @@
-import { IFormulaCurrentConfigService } from './current-data.service';
-import { FunctionVariantType } from '../engine/reference-object/base-reference-object';
-import { BaseAstNode } from '../engine/ast-node/base-ast-node';
-import { IArrayFormulaRangeType, IFeatureDirtyRangeType, IRuntimeOtherUnitDataType, IRuntimeUnitDataType } from '../basics/common';
 import { Nullable, Disposable } from '@univerjs/core';
+import { IArrayFormulaRangeType, IFeatureDirtyRangeType, IRuntimeOtherUnitDataType, IRuntimeUnitDataType } from '../basics/common';
+import { BaseAstNode } from '../engine/ast-node/base-ast-node';
+import { FunctionVariantType } from '../engine/reference-object/base-reference-object';
+import { IFormulaCurrentConfigService } from './current-data.service';
 
 /**
  * IDLE: Idle phase of the formula engine.

package/lib/types/services/super-table.service.d.ts

@@ -1,5 +1,5 @@
-import { ISuperTable, TableOptionType } from '../basics/common';
 import { Nullable, Disposable } from '@univerjs/core';
+import { ISuperTable, TableOptionType } from '../basics/common';
 
 export interface ISuperTableOptionParam {
     tableOption: string;