@univerjs/engine-formula 0.1.7 → 0.1.9

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

@@ -1,6 +1,6 @@
 import { IFormulaIdMap } from './utils/formula-data-util';
 import { LexerTreeBuilder } from '../engine/analysis/lexer-tree-builder';
-import { IArrayFormulaRangeType, IArrayFormulaUnitCellType, IFormulaData, IFormulaDataItem, INumfmtItemMap, IRuntimeUnitDataType, IUnitData, IUnitSheetNameMap } from '../basics/common';
+import { IArrayFormulaRangeType, IArrayFormulaUnitCellType, IFormulaData, IFormulaDataItem, IRuntimeUnitDataType, IUnitData, IUnitSheetNameMap } from '../basics/common';
 import { ICellData, IObjectMatrixPrimitiveType, IRange, Nullable, Disposable, IUniverInstanceService, ObjectMatrix } from '@univerjs/core';
 
 export interface IRangeChange {
@@ -8,13 +8,12 @@ export interface IRangeChange {
     newCell: IRange;
 }
 export declare class FormulaDataModel extends Disposable {
-    private readonly _currentUniverService;
+    private readonly _univerInstanceService;
     private readonly _lexerTreeBuilder;
     private _formulaData;
     private _arrayFormulaRange;
     private _arrayFormulaCellData;
-    private _numfmtItemMap;
-    constructor(_currentUniverService: IUniverInstanceService, _lexerTreeBuilder: LexerTreeBuilder);
+    constructor(_univerInstanceService: IUniverInstanceService, _lexerTreeBuilder: LexerTreeBuilder);
     clearPreviousArrayFormulaCellData(clearArrayFormulaCellData: IRuntimeUnitDataType): void;
     mergeArrayFormulaCellData(unitData: IRuntimeUnitDataType): void;
     getFormulaData(): IFormulaData;
@@ -23,10 +22,6 @@ export declare class FormulaDataModel extends Disposable {
     setArrayFormulaRange(value: IArrayFormulaRangeType): void;
     getArrayFormulaCellData(): IArrayFormulaUnitCellType;
     setArrayFormulaCellData(value: IArrayFormulaUnitCellType): void;
-    getNumfmtItemMap(): INumfmtItemMap;
-    getNumfmtValue(unitId: string, sheetId: string, row: number, column: number): Nullable<string>;
-    setNumfmtItemMap(value: INumfmtItemMap): void;
-    updateNumfmtItemMap(value: INumfmtItemMap): void;
     mergeArrayFormulaRange(formulaData: IArrayFormulaRangeType): void;
     mergeFormulaData(formulaData: IFormulaData): void;
     deleteArrayFormulaRange(unitId: string, sheetId: string, row: number, column: number): void;
@@ -38,9 +33,8 @@ export declare class FormulaDataModel extends Disposable {
     updateFormulaData(unitId: string, sheetId: string, cellValue: IObjectMatrixPrimitiveType<Nullable<ICellData>>): IObjectMatrixPrimitiveType<IFormulaDataItem | null>;
     updateArrayFormulaRange(unitId: string, sheetId: string, cellValue: IObjectMatrixPrimitiveType<Nullable<ICellData>>): void;
     updateArrayFormulaCellData(unitId: string, sheetId: string, cellValue: IObjectMatrixPrimitiveType<Nullable<ICellData>>): void;
-    updateNumfmtData(unitId: string, sheetId: string, cellValue: IObjectMatrixPrimitiveType<Nullable<ICellData>>): void;
     getFormulaItemBySId(sId: string, sheetId: string, unitId: string): Nullable<IFormulaDataItem>;
-    getFormulaDataItem(row: number, column: number, sheetId: string, unitId: string): IFormulaDataItem | undefined;
+    getFormulaDataItem(row: number, column: number, sheetId: string, unitId: string): Nullable<IFormulaDataItem>;
     getFormulaIdMap(unitId: string, sheetId: string): Map<string, IFormulaIdMap>;
 }
 export declare function initSheetFormulaData(formulaData: IFormulaData, unitId: string, sheetId: string, cellMatrix: ObjectMatrix<Nullable<ICellData>>): {

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

@@ -6,5 +6,5 @@ export interface IFormulaIdMap {
     r: number;
     c: number;
 }
-export declare function updateFormulaDataByCellValue(sheetFormulaDataMatrix: ObjectMatrix<IFormulaDataItem>, newSheetFormulaDataMatrix: ObjectMatrix<IFormulaDataItem | null>, formulaIdMap: Map<string, IFormulaIdMap>, deleteFormulaIdMap: Map<string, string | IFormulaIdMap>, r: number, c: number, cell: Nullable<ICellData>): void;
+export declare function updateFormulaDataByCellValue(sheetFormulaDataMatrix: ObjectMatrix<Nullable<IFormulaDataItem>>, newSheetFormulaDataMatrix: ObjectMatrix<IFormulaDataItem | null>, formulaIdMap: Map<string, IFormulaIdMap>, deleteFormulaIdMap: Map<string, string | IFormulaIdMap>, r: number, c: number, cell: Nullable<ICellData>): void;
 export declare function clearArrayFormulaCellDataByCell(arrayFormulaRangeMatrix: ObjectMatrix<IRange>, arrayFormulaCellDataMatrix: ObjectMatrix<Nullable<ICellData>>, r: number, c: number): true | undefined;

package/lib/types/plugin.d.ts

@@ -10,9 +10,9 @@ interface IUniverFormulaEngine {
 export declare class UniverFormulaEnginePlugin extends Plugin {
     private _config;
     protected _injector: Injector;
+    static pluginName: string;
     constructor(_config: IUniverFormulaEngine, _injector: Injector);
     onStarting(): void;
     private _initialize;
-    onReady(): void;
 }
 export {};

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

@@ -1,10 +1,14 @@
-import { IDirtyUnitFeatureMap, IDirtyUnitOtherFormulaMap, IDirtyUnitSheetDefinedNameMap, IDirtyUnitSheetNameMap, IFormulaData, IFormulaDatasetConfig, INumfmtItemMap, IRuntimeUnitDataType, IUnitData, IUnitExcludedCell, IUnitSheetNameMap } from '../basics/common';
+import { IDirtyUnitFeatureMap, IDirtyUnitOtherFormulaMap, IDirtyUnitSheetDefinedNameMap, IDirtyUnitSheetNameMap, IFormulaData, IFormulaDatasetConfig, IRuntimeUnitDataType, IUnitData, IUnitExcludedCell, IUnitSheetNameMap, IUnitStylesData } from '../basics/common';
 import { IUnitRange, Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
 
 export declare const DEFAULT_DOCUMENT_SUB_COMPONENT_ID = "__default_document_sub_component_id20231101__";
 export interface IFormulaCurrentConfigService {
     load(config: IFormulaDatasetConfig): void;
     getUnitData(): IUnitData;
+    /**
+     * Get the unit styles data.
+     */
+    getUnitStylesData(): IUnitStylesData;
     getFormulaData(): IFormulaData;
     getSheetNameMap(): IUnitSheetNameMap;
     isForceCalculate(): boolean;
@@ -26,8 +30,9 @@ export interface IFormulaCurrentConfigService {
     setExecuteSubUnitId(subUnitId: string): void;
 }
 export declare class FormulaCurrentConfigService extends Disposable implements IFormulaCurrentConfigService {
-    private readonly _currentUniverService;
+    private readonly _univerInstanceService;
     private _unitData;
+    private _unitStylesData;
     private _arrayFormulaCellData;
     private _formulaData;
     private _sheetNameMap;
@@ -35,14 +40,13 @@ export declare class FormulaCurrentConfigService extends Disposable implements I
     private _dirtyRanges;
     private _dirtyNameMap;
     private _dirtyDefinedNameMap;
-    private _numfmtItemMap;
     private _dirtyUnitFeatureMap;
     private _dirtyUnitOtherFormulaMap;
     private _excludedCell;
     private _sheetIdToNameMap;
     private _executeUnitId;
     private _executeSubUnitId;
-    constructor(_currentUniverService: IUniverInstanceService);
+    constructor(_univerInstanceService: IUniverInstanceService);
     dispose(): void;
     getExecuteUnitId(): Nullable<string>;
     getExecuteSubUnitId(): Nullable<string>;
@@ -50,6 +54,7 @@ export declare class FormulaCurrentConfigService extends Disposable implements I
     setExecuteSubUnitId(subUnitId: string): void;
     getExcludedRange(): Nullable<IUnitExcludedCell>;
     getUnitData(): IUnitData;
+    getUnitStylesData(): IUnitStylesData;
     getFormulaData(): IFormulaData;
     getArrayFormulaCellData(): IRuntimeUnitDataType;
     getSheetNameMap(): IUnitSheetNameMap;
@@ -57,7 +62,6 @@ export declare class FormulaCurrentConfigService extends Disposable implements I
     getDirtyRanges(): IUnitRange[];
     getDirtyNameMap(): IDirtyUnitSheetNameMap;
     getDirtyDefinedNameMap(): IDirtyUnitSheetDefinedNameMap;
-    getNumfmtItemMap(): INumfmtItemMap;
     getDirtyUnitFeatureMap(): IDirtyUnitFeatureMap;
     getDirtyUnitOtherFormulaMap(): IDirtyUnitOtherFormulaMap;
     getSheetName(unitId: string, sheetId: string): string;

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

@@ -25,6 +25,7 @@ export interface IDefinedNamesService {
     getValueByName(unitId: string, name: string): Nullable<IDefinedNamesServiceParam>;
     getValueById(unitId: string, id: string): Nullable<IDefinedNamesServiceParam>;
     removeDefinedName(unitId: string, name: string): void;
+    removeUnitDefinedName(unitId: string): void;
     hasDefinedName(unitId: string): boolean;
     setCurrentRange(range: IUnitRange): void;
     getCurrentRange(): IUnitRange;
@@ -52,6 +53,7 @@ export declare class DefinedNamesService extends Disposable implements IDefinedN
     registerDefinedNames(unitId: string, params: IDefinedNameMapItem): void;
     registerDefinedName(unitId: string, param: IDefinedNamesServiceParam): void;
     removeDefinedName(unitId: string, id: string): void;
+    removeUnitDefinedName(unitId: string): void;
     getDefinedNameMap(unitId: string): IDefinedNameMapItem;
     getValueByName(unitId: string, name: string): IDefinedNamesServiceParam | null;
     getValueById(unitId: string, id: string): IDefinedNamesServiceParam;

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

@@ -0,0 +1,74 @@
+import { FormulaDependencyTreeCache, FormulaDependencyTree } from '../engine/dependency/dependency-tree';
+import { Nullable, Disposable, ObjectMatrix } from '@univerjs/core';
+
+export interface IOtherFormulaDependencyParam {
+    [unitId: string]: Nullable<{
+        [sheetId: string]: {
+            [formulaId: string]: Nullable<FormulaDependencyTree>;
+        };
+    }>;
+}
+export interface IFormulaDependencyParam {
+    [unitId: string]: Nullable<{
+        [sheetId: string]: ObjectMatrix<Nullable<FormulaDependencyTree>>;
+    }>;
+}
+export interface IDependencyManagerService {
+    dispose(): void;
+    getAllTree(): FormulaDependencyTree[];
+    buildDependencyTree(shouldBeBuildTrees: FormulaDependencyTree[] | FormulaDependencyTreeCache): FormulaDependencyTree[];
+    clearDependencyForTree(shouldBeClearTree: Nullable<FormulaDependencyTree>): void;
+    reset(): void;
+    addOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string, dependencyTree: FormulaDependencyTree): void;
+    removeOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string[]): void;
+    hasOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string): boolean;
+    addFeatureFormulaDependency(featureId: string, dependencyTree: FormulaDependencyTree): void;
+    removeFeatureFormulaDependency(featureId: string): void;
+    hasFeatureFormulaDependency(unitId: string, sheetId: string, featureId: string): boolean;
+    addFormulaDependency(unitId: string, sheetId: string, row: number, column: number, dependencyTree: FormulaDependencyTree): void;
+    removeFormulaDependency(unitId: string, sheetId: string, row: number, column: number): void;
+    hasFormulaDependency(unitId: string, sheetId: string, row: number, column: number): boolean;
+    clearFormulaDependency(unitId: string, sheetId: string): void;
+}
+/**
+ * Passively marked as dirty, register the reference and execution actions of the feature plugin.
+ * After execution, a dirty area and calculated data will be returned,
+ * causing the formula to be marked dirty again,
+ * thereby completing the calculation of the entire dependency tree.
+ */
+export declare class DependencyManagerService extends Disposable implements IDependencyManagerService {
+    private _otherFormulaData;
+    private _featureFormulaData;
+    private _formulaData;
+    dispose(): void;
+    /**
+     * Get all FormulaDependencyTree from _otherFormulaData, _featureFormulaData, _formulaData
+     * return FormulaDependencyTree[]
+     */
+    getAllTree(): FormulaDependencyTree[];
+    buildDependencyTree(shouldBeBuildTrees: FormulaDependencyTree[] | FormulaDependencyTreeCache): FormulaDependencyTree[];
+    /**
+     * Build the dependency relationship between the trees.
+     * @param allTrees  all FormulaDependencyTree
+     * @param shouldBeBuildTrees  FormulaDependencyTree[] | FormulaDependencyTreeCache
+     */
+    private _buildDependencyTree;
+    /**
+     * Clear the dependency relationship of the tree.
+     * establish the relationship between the parent and the child.
+     * @param shouldBeClearTree
+     */
+    clearDependencyForTree(shouldBeClearTree: Nullable<FormulaDependencyTree>): void;
+    reset(): void;
+    addOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string, dependencyTree: FormulaDependencyTree): void;
+    removeOtherFormulaDependency(unitId: string, sheetId: string, formulaIds: string[]): void;
+    hasOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string): boolean;
+    addFeatureFormulaDependency(featureId: string, dependencyTree: FormulaDependencyTree): void;
+    removeFeatureFormulaDependency(featureId: string): void;
+    hasFeatureFormulaDependency(featureId: string): boolean;
+    addFormulaDependency(unitId: string, sheetId: string, row: number, column: number, dependencyTree: FormulaDependencyTree): void;
+    removeFormulaDependency(unitId: string, sheetId: string, row: number, column: number): void;
+    clearFormulaDependency(unitId: string, sheetId: string): void;
+    hasFormulaDependency(unitId: string, sheetId: string, row: number, column: number): boolean;
+}
+export declare const IDependencyManagerService: import('@wendellhu/redi').IdentifierDecorator<DependencyManagerService>;

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

@@ -1,7 +1,7 @@
 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, INumfmtItemMap, IRuntimeOtherUnitDataType, IRuntimeUnitDataType } from '../basics/common';
+import { IArrayFormulaRangeType, IFeatureDirtyRangeType, IRuntimeOtherUnitDataType, IRuntimeUnitDataType } from '../basics/common';
 import { Nullable, Disposable } from '@univerjs/core';
 
 /**
@@ -36,7 +36,6 @@ export interface IAllRuntimeData {
     functionsExecutedState: FormulaExecutedStateType;
     arrayFormulaCellData: IRuntimeUnitDataType;
     clearArrayFormulaCellData: IRuntimeUnitDataType;
-    numfmtItemMap: INumfmtItemMap;
     runtimeFeatureRange: {
         [featureId: string]: IFeatureDirtyRangeType;
     };
@@ -112,7 +111,6 @@ export declare class FormulaRuntimeService extends Disposable implements IFormul
     private _unitArrayFormulaRange;
     private _runtimeArrayFormulaCellData;
     private _runtimeClearArrayFormulaCellData;
-    private _numfmtItemMap;
     private _runtimeFeatureRange;
     private _runtimeFeatureCellData;
     private _functionsExecutedState;
@@ -158,7 +156,6 @@ export declare class FormulaRuntimeService extends Disposable implements IFormul
     setRuntimeData(functionVariant: FunctionVariantType): void;
     getUnitData(): IRuntimeUnitDataType;
     getUnitArrayFormula(): IArrayFormulaRangeType;
-    getNumfmtItemMap(): INumfmtItemMap;
     getRuntimeOtherData(): IRuntimeOtherUnitDataType;
     getRuntimeArrayFormulaCellData(): IRuntimeUnitDataType;
     getRuntimeClearArrayFormulaCellData(): IRuntimeUnitDataType;
@@ -172,7 +169,6 @@ export declare class FormulaRuntimeService extends Disposable implements IFormul
     setRuntimeFeatureCellData(featureId: string, featureData: IRuntimeUnitDataType): void;
     getAllRuntimeData(): IAllRuntimeData;
     getRuntimeState(): IExecutionInProgressParams;
-    private _objectValueToCellValue;
     private _checkIfArrayFormulaRangeHasData;
     private _isInArrayFormulaRange;
     private _checkIfArrayFormulaExceeded;