@univerjs/engine-formula 0.4.1 → 0.4.2

package/lib/types/functions/text/numbervalue/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/numbervalue/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Numbervalue extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(text: BaseValueObject, decimalSeparator?: BaseValueObject, groupSeparator?: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+}

package/lib/types/functions/text/proper/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/proper/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseFunction } from '../../base-function';
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+export declare class Proper extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(text: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+}

package/lib/types/functions/text/right/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/right/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Right extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(text: BaseValueObject, numChars?: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+}

package/lib/types/functions/text/rightb/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/rightb/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Rightb extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(text: BaseValueObject, numBytes?: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+}

package/lib/types/functions/text/substitute/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/substitute/index.d.ts

@@ -0,0 +1,9 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Substitute extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(text: BaseValueObject, oldText: BaseValueObject, newText: BaseValueObject, instanceNum?: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+    private _getObjectString;
+}

package/lib/types/functions/text/t/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/t/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseFunction } from '../../base-function';
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+export declare class T extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(value: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/text/unichar/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/unichar/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Unichar extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(number: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+}

package/lib/types/functions/text/unicode/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/unicode/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Unicode extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(text: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+}

package/lib/types/functions/text/value/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/value/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Value extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(text: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+}

package/lib/types/functions/text/valuetotext/__test__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/functions/text/valuetotext/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Valuetotext extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(value: BaseValueObject, format?: BaseValueObject): BaseValueObject;
+    private _handleSingleObject;
+}

package/lib/types/index.d.ts

@@ -112,8 +112,7 @@ export { FeatureCalculationManagerService, IFeatureCalculationManagerService } f
 export { FunctionService } from './services/function.service';
 export { IFunctionService } from './services/function.service';
 export { IOtherFormulaManagerService, OtherFormulaManagerService } from './services/other-formula-manager.service';
-export { FormulaExecuteStageType, type IExecutionInProgressParams } from './services/runtime.service';
-export { FormulaExecutedStateType, type IAllRuntimeData } from './services/runtime.service';
-export { FormulaRuntimeService, IFormulaRuntimeService } from './services/runtime.service';
+export { FormulaExecutedStateType, FormulaExecuteStageType, FormulaRuntimeService, type IAllRuntimeData, type IExecutionInProgressParams, IFormulaRuntimeService } from './services/runtime.service';
 export { ISuperTableService } from './services/super-table.service';
 export { SuperTableService } from './services/super-table.service';
+export { deserializeRangeWithSheetWithCache } from './engine/utils/reference-cache';

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

@@ -8,6 +8,7 @@ import { FormulaDependencyGenerator } from '../engine/dependency/formula-depende
 import { Interpreter } from '../engine/interpreter/interpreter';
 import { IFormulaCurrentConfigService } from './current-data.service';
 export declare const DEFAULT_CYCLE_REFERENCE_COUNT = 1;
+export declare const DEFAULT_INTERVAL_COUNT = 500;
 export declare const CYCLE_REFERENCE_COUNT = "cycleReferenceCount";
 export declare const EVERY_N_FUNCTION_EXECUTION_PAUSE = 100;
 export declare class CalculateFormulaService extends Disposable {
@@ -18,12 +19,10 @@ export declare class CalculateFormulaService extends Disposable {
     private readonly _formulaDependencyGenerator;
     private readonly _interpreter;
     private readonly _astTreeBuilder;
-    private readonly _executionStartListener$;
-    readonly executionStartListener$: import('rxjs').Observable<boolean>;
-    private readonly _executionCompleteListener$;
-    readonly executionCompleteListener$: import('rxjs').Observable<IAllRuntimeData>;
     private readonly _executionInProgressListener$;
     readonly executionInProgressListener$: import('rxjs').Observable<IExecutionInProgressParams>;
+    private readonly _executionCompleteListener$;
+    readonly executionCompleteListener$: import('rxjs').Observable<IAllRuntimeData>;
     constructor(_configService: IConfigService, _lexer: Lexer, _currentConfigService: IFormulaCurrentConfigService, _runtimeService: IFormulaRuntimeService, _formulaDependencyGenerator: FormulaDependencyGenerator, _interpreter: Interpreter, _astTreeBuilder: AstTreeBuilder);
     /**
      * Stop the execution of the formula.

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

@@ -1,4 +1,4 @@
-import { IUnitRange, Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { IUnitRange, LocaleType, Nullable, Disposable, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { IArrayFormulaRangeType, IDirtyUnitFeatureMap, IDirtyUnitOtherFormulaMap, IDirtyUnitSheetDefinedNameMap, IDirtyUnitSheetNameMap, IFormulaData, IFormulaDatasetConfig, IRuntimeUnitDataType, IUnitData, IUnitExcludedCell, IUnitSheetNameMap, IUnitStylesData } from '../basics/common';
 export interface IFormulaDirtyData {
     forceCalculation: boolean;
@@ -38,9 +38,17 @@ export interface IFormulaCurrentConfigService {
     setExecuteSubUnitId(subUnitId: string): void;
     getDirtyData(): IFormulaDirtyData;
     getClearDependencyTreeCache(): IDirtyUnitSheetNameMap;
+    getLocale(): LocaleType;
+    getSheetsInfo(): {
+        sheetOrder: string[];
+        sheetNameMap: {
+            [sheetId: string]: string;
+        };
+    };
 }
 export declare class FormulaCurrentConfigService extends Disposable implements IFormulaCurrentConfigService {
     private readonly _univerInstanceService;
+    private readonly _localeService;
     private _unitData;
     private _unitStylesData;
     private _arrayFormulaCellData;
@@ -58,7 +66,7 @@ export declare class FormulaCurrentConfigService extends Disposable implements I
     private _sheetIdToNameMap;
     private _executeUnitId;
     private _executeSubUnitId;
-    constructor(_univerInstanceService: IUniverInstanceService);
+    constructor(_univerInstanceService: IUniverInstanceService, _localeService: LocaleService);
     dispose(): void;
     getExecuteUnitId(): Nullable<string>;
     getExecuteSubUnitId(): Nullable<string>;
@@ -79,6 +87,13 @@ export declare class FormulaCurrentConfigService extends Disposable implements I
     getDirtyUnitOtherFormulaMap(): IDirtyUnitOtherFormulaMap;
     getSheetName(unitId: string, sheetId: string): string;
     getClearDependencyTreeCache(): IDirtyUnitSheetNameMap;
+    getLocale(): LocaleType;
+    getSheetsInfo(): {
+        sheetOrder: string[];
+        sheetNameMap: {
+            [sheetId: string]: string;
+        };
+    };
     load(config: IFormulaDatasetConfig): void;
     getDirtyData(): IFormulaDirtyData;
     loadDirtyRangesAndExcludedCell(dirtyRanges: IUnitRange[], excludedCell?: IUnitExcludedCell): void;

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

@@ -1,22 +1,22 @@
-import { IRTreeItem, IUnitRange, Nullable, Disposable, ObjectMatrix } from '@univerjs/core';
+import { IUnitRange, Nullable, Disposable, ObjectMatrix } from '@univerjs/core';
 import { FormulaDependencyTree } from '../engine/dependency/dependency-tree';
 export interface IOtherFormulaDependencyParam {
     [unitId: string]: Nullable<{
         [sheetId: string]: {
-            [formulaId: string]: Nullable<FormulaDependencyTree>;
+            [formulaId: string]: Nullable<number>;
         };
     }>;
 }
 export interface IFeatureFormulaDependencyParam {
     [unitId: string]: Nullable<{
         [sheetId: string]: {
-            [featureId: string]: Nullable<FormulaDependencyTree>;
+            [featureId: string]: Nullable<number>;
         };
     }>;
 }
 export interface IFormulaDependencyParam {
     [unitId: string]: Nullable<{
-        [sheetId: string]: ObjectMatrix<Nullable<FormulaDependencyTree>>;
+        [sheetId: string]: ObjectMatrix<number>;
     }>;
 }
 export interface IDependencyManagerService {
@@ -37,11 +37,14 @@ export interface IDependencyManagerService {
     removeFormulaDependencyByDefinedName(unitId: string, definedName: string): void;
     clearFormulaDependency(unitId: string, sheetId?: string): void;
     addDependencyRTreeCache(tree: FormulaDependencyTree): void;
-    searchDependency(search: IUnitRange[]): Map<string, IRTreeItem>;
+    searchDependency(search: IUnitRange[]): Set<number>;
     getLastTreeId(): number;
     clearDependencyAll(): void;
     clearOtherFormulaDependency(unitId: string, sheetId?: string): void;
     clearFeatureFormulaDependency(unitId: string, sheetId?: string): void;
+    openKdTree(): void;
+    closeKdTree(): void;
+    getTreeById(treeId: number): Nullable<FormulaDependencyTree>;
 }
 /**
  * Passively marked as dirty, register the reference and execution actions of the feature plugin.
@@ -53,6 +56,7 @@ export declare class DependencyManagerService extends Disposable implements IDep
     private _otherFormulaData;
     private _featureFormulaData;
     private _formulaData;
+    private _allTreeMap;
     private _dependencyRTreeCache;
     private _dependencyTreeIdLast;
     dispose(): void;
@@ -61,8 +65,9 @@ export declare class DependencyManagerService extends Disposable implements IDep
      * return FormulaDependencyTree[]
      */
     getAllTree(): FormulaDependencyTree[];
+    getTreeById(treeId: number): FormulaDependencyTree | undefined;
     buildDependencyTree(shouldBeBuildTrees: FormulaDependencyTree[], dependencyTrees?: FormulaDependencyTree[]): FormulaDependencyTree[];
-    searchDependency(search: IUnitRange[]): Map<string, IRTreeItem>;
+    searchDependency(search: IUnitRange[]): Set<number>;
     /**
      * Build the dependency relationship between the trees.
      * @param allTrees  all FormulaDependencyTree
@@ -84,23 +89,26 @@ export declare class DependencyManagerService extends Disposable implements IDep
     reset(): void;
     addOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string, dependencyTree: FormulaDependencyTree): void;
     removeOtherFormulaDependency(unitId: string, sheetId: string, formulaIds: string[]): void;
-    getOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string): Nullable<FormulaDependencyTree>;
+    getOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string): FormulaDependencyTree | undefined;
     hasOtherFormulaDependency(unitId: string, sheetId: string, formulaId: string): boolean;
     clearOtherFormulaDependency(unitId: string, sheetId?: string): void;
     addFeatureFormulaDependency(unitId: string, sheetId: string, featureId: string, dependencyTree: FormulaDependencyTree): void;
     removeFeatureFormulaDependency(unitId: string, sheetId: string, featureIds: string[]): void;
     clearFeatureFormulaDependency(unitId: string, sheetId?: string): void;
-    getFeatureFormulaDependency(unitId: string, sheetId: string, featureId: string): Nullable<FormulaDependencyTree>;
+    getFeatureFormulaDependency(unitId: string, sheetId: string, featureId: string): FormulaDependencyTree | null | undefined;
     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;
     clearDependencyAll(): void;
-    getFormulaDependency(unitId: string, sheetId: string, row: number, column: number): Nullable<Nullable<FormulaDependencyTree>>;
+    getFormulaDependency(unitId: string, sheetId: string, row: number, column: number): FormulaDependencyTree | null | undefined;
     addDependencyRTreeCache(tree: FormulaDependencyTree): void;
     private _restDependencyTreeId;
     getLastTreeId(): number;
     private _removeDependencyRTreeCacheById;
     private _removeDependencyRTreeCache;
     removeFormulaDependencyByDefinedName(unitId: string, definedName: string): void;
+    openKdTree(): void;
+    closeKdTree(): void;
+    private _removeAllTreeMap;
 }
 export declare const IDependencyManagerService: import('@wendellhu/redi').IdentifierDecorator<DependencyManagerService>;

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

@@ -14,13 +14,14 @@ import { IFormulaCurrentConfigService } from './current-data.service';
  */
 export declare enum FormulaExecuteStageType {
     IDLE = 0,
-    START_DEPENDENCY = 1,
-    START_CALCULATION = 2,
-    CURRENTLY_CALCULATING = 3,
-    START_DEPENDENCY_ARRAY_FORMULA = 4,
-    START_CALCULATION_ARRAY_FORMULA = 5,
-    CURRENTLY_CALCULATING_ARRAY_FORMULA = 6,
-    CALCULATION_COMPLETED = 7
+    START = 1,
+    START_DEPENDENCY = 2,
+    START_CALCULATION = 3,
+    CURRENTLY_CALCULATING = 4,
+    START_DEPENDENCY_ARRAY_FORMULA = 5,
+    START_CALCULATION_ARRAY_FORMULA = 6,
+    CURRENTLY_CALCULATING_ARRAY_FORMULA = 7,
+    CALCULATION_COMPLETED = 8
 }
 export declare enum FormulaExecutedStateType {
     INITIAL = 0,
@@ -134,6 +135,8 @@ export declare class FormulaRuntimeService extends Disposable implements IFormul
     enableCycleDependency(): void;
     disableCycleDependency(): void;
     isCycleDependency(): boolean;
+    setFormulaCycleIndex(index: number): void;
+    getFormulaCycleIndex(): number;
     setTotalArrayFormulasToCalculate(value: number): void;
     getTotalArrayFormulasToCalculate(): number;
     setCompletedArrayFormulasCount(value: number): void;
@@ -142,8 +145,6 @@ export declare class FormulaRuntimeService extends Disposable implements IFormul
     getTotalFormulasToCalculate(): number;
     setCompletedFormulasCount(value: number): void;
     getCompletedFormulasCount(): number;
-    setFormulaCycleIndex(index: number): void;
-    getFormulaCycleIndex(): number;
     markedAsSuccessfullyExecuted(): void;
     markedAsNoFunctionsExecuted(): void;
     markedAsStopFunctionsExecuted(): void;