@univerjs/engine-formula 0.1.3 → 0.1.5

package/lib/types/engine/utils/object-compare.d.ts

@@ -1,20 +1,6 @@
-/**
- * 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.
- */
+import { BaseValueObject } from '../value-object/base-value-object';
 import { compareToken } from '../../basics/token';
-import type { BaseValueObject } from '../value-object/base-value-object';
+
 export declare function findCompareToken(str: string): [compareToken, BaseValueObject];
 /**
  * When it contains both comparison characters and wildcard characters
@@ -27,6 +13,5 @@ export declare function valueObjectCompare(range: BaseValueObject, criteria: Bas
  * Find the Boolean intersection of two ArrayValueObjects
  * @param valueObject1
  * @param valueObject2
- * @returns
  */
 export declare function booleanObjectIntersection(valueObject1: BaseValueObject, valueObject2: BaseValueObject): BaseValueObject;

package/lib/types/engine/utils/prefixHandler.d.ts

@@ -1,22 +1,8 @@
-/**
- * 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.
- */
-import type { Injector } from '@wendellhu/redi';
-import type { Nullable } from '@univerjs/core';
-import type { IFunctionService } from '../../services/function.service';
 import { PrefixNode } from '../ast-node/prefix-node';
+import { IFunctionService } from '../../services/function.service';
+import { Nullable } from '@univerjs/core';
+import { Injector } from '@wendellhu/redi';
+
 export declare function prefixHandler(tokenTrim: string, functionService: IFunctionService, injector: Injector): {
     tokenTrim: string;
     minusPrefixNode: Nullable<PrefixNode>;

package/lib/types/engine/utils/r1c1-reference.d.ts

@@ -1,18 +1,4 @@
-/**
- * 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.
- */
-import type { IRange, IUnitRangeName } from '@univerjs/core';
+import { IRange, IUnitRangeName } from '@univerjs/core';
+
 export declare function deserializeRangeForR1C1(refString: string, currentRow?: number, currentColumn?: number): IUnitRangeName;
 export declare function serializeRangeToR1C1(range: IRange): string;

package/lib/types/engine/utils/reference.d.ts

@@ -1,20 +1,5 @@
-/**
- * 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.
- */
-import type { IRange, IUnitRangeName } from '@univerjs/core';
-import { AbsoluteRefType } from '@univerjs/core';
+import { IRange, IUnitRangeName, AbsoluteRefType } from '@univerjs/core';
+
 export interface IAbsoluteRefTypeForRange {
     startAbsoluteRefType: AbsoluteRefType;
     endAbsoluteRefType?: AbsoluteRefType;
@@ -58,7 +43,7 @@ export declare function deserializeRangeWithSheet(refString: string): IUnitRange
  * Determine whether the sheet name needs to be wrapped in quotes
  * Excel will quote the worksheet name if any of the following is true:
  *  - It contains any space or punctuation characters, such as  ()$,;-{}"'（）【】“”‘’%… and many more
- *  - It is a valid cell reference in A1 notation, e.g. B1048576 is quoted, B1048577 is not
+ *  - It is a valid cell reference in A1 notation, e.g. B1048576 is quoted
  *  - It is a valid cell reference in R1C1 notation, e.g. RC, RC2, R5C, R-4C, RC-8, R, C
  *  - It starts with a non-letter, e.g. 99, 1.5, 12a, 💩a
  *  - Excel will not quote worksheet names if they only contain non-punctuation, non-letter characters in non-initial positions. For example, a💩 remains unquoted.*

package/lib/types/engine/utils/sequence.d.ts

@@ -1,19 +1,5 @@
-/**
- * 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.
- */
-import type { LexerNode } from '../analysis/lexer-node';
+import { LexerNode } from '../analysis/lexer-node';
+
 export declare enum sequenceNodeType {
     NORMAL = 0,
     NUMBER = 1,

package/lib/types/engine/utils/value-object.d.ts

@@ -0,0 +1,6 @@
+import { NumberValueObject } from '../value-object/primitive-object';
+import { BaseValueObject } from '../value-object/base-value-object';
+import { FunctionVariantType } from '../reference-object/base-reference-object';
+
+export declare function convertTonNumber(valueObject: BaseValueObject): NumberValueObject;
+export declare function isSingleValueObject(valueObject: FunctionVariantType): boolean;

package/lib/types/engine/{utils/object-covert.d.ts → value-object/__tests__/array-value-divided.spec.d.ts}

@@ -13,6 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { BaseValueObject } from '../value-object/base-value-object';
-import { NumberValueObject } from '../value-object/primitive-object';
-export declare function convertTonNumber(valueObject: BaseValueObject): NumberValueObject;
+export {};

package/lib/types/engine/value-object/__tests__/array-value-minus.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/engine/value-object/__tests__/array-value-multiply.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/engine/value-object/__tests__/array-value-plus.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/engine/value-object/array-value-object.d.ts

@@ -1,28 +1,14 @@
-/**
- * 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.
- */
-import type { Nullable } from '@univerjs/core';
-import { compareToken } from '../../basics/token';
-import { ArrayBinarySearchType, ArrayOrderSearchType } from '../utils/compare';
-import type { callbackMapFnType, callbackProductFnType, IArrayValueObject } from './base-value-object';
-import { BaseValueObject, ErrorValueObject } from './base-value-object';
 import { BooleanValueObject, NullValueObject, NumberValueObject, StringValueObject } from './primitive-object';
+import { callbackMapFnType, IArrayValueObject, BaseValueObject, ErrorValueObject } from './base-value-object';
+import { ArrayBinarySearchType, ArrayOrderSearchType } from '../utils/compare';
+import { compareToken } from '../../basics/token';
+import { Nullable } from '@univerjs/core';
+
 export declare function fromObjectToString(array: IArrayValueObject): string;
 export declare function transformToValueObject(array?: Array<Array<number | string | boolean | null>>): BaseValueObject[][];
-export declare function transformToValue(array?: BaseValueObject[][]): (string | number | boolean | null)[][];
+export declare function transformToValue(array?: Nullable<BaseValueObject>[][]): (string | number | boolean | null)[][];
 export declare class ArrayValueObject extends BaseValueObject {
+    static create(rawValue: string | IArrayValueObject): ArrayValueObject;
     private _values;
     private _rowCount;
     private _columnCount;
@@ -47,12 +33,12 @@ export declare class ArrayValueObject extends BaseValueObject {
     getSheetId(): string;
     getCurrentRow(): number;
     getCurrentColumn(): number;
-    getArrayValue(): BaseValueObject[][];
+    getArrayValue(): Nullable<BaseValueObject>[][];
     setArrayValue(value: BaseValueObject[][]): void;
     isArray(): boolean;
-    get(row: number, column: number): BaseValueObject;
+    get(row: number, column: number): BaseValueObject | null;
     getRealValue(row: number, column: number): BaseValueObject | null;
-    set(row: number, column: number, value: BaseValueObject): void;
+    set(row: number, column: number, value: Nullable<BaseValueObject>): void;
     getRangePosition(): {
         startRow: number;
         endRow: number;
@@ -133,7 +119,6 @@ export declare class ArrayValueObject extends BaseValueObject {
     compare(valueObject: BaseValueObject, operator: compareToken): BaseValueObject;
     concatenateFront(valueObject: BaseValueObject): BaseValueObject;
     concatenateBack(valueObject: BaseValueObject): BaseValueObject;
-    product(valueObject: BaseValueObject, callbackFn: callbackProductFnType): BaseValueObject;
     map(callbackFn: callbackMapFnType): BaseValueObject;
     mapValue(callbackFn: callbackMapFnType): BaseValueObject;
     pow(valueObject: BaseValueObject): BaseValueObject;
@@ -210,5 +195,5 @@ export declare class ArrayValueObject extends BaseValueObject {
     private _createNewArray;
 }
 export declare class ValueObjectFactory {
-    static create(rawValue: string | number | boolean | null): ErrorValueObject | NullValueObject | NumberValueObject | StringValueObject | BooleanValueObject | ArrayValueObject;
+    static create(rawValue: string | number | boolean | null): ErrorValueObject | NullValueObject | NumberValueObject | BooleanValueObject | StringValueObject | ArrayValueObject;
 }

package/lib/types/engine/value-object/base-value-object.d.ts

@@ -1,26 +1,13 @@
-/**
- * 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.
- */
-import { ConcatenateType } from '../../basics/common';
-import { ErrorType } from '../../basics/error-type';
-import { ObjectClassType } from '../../basics/object-class-type';
 import { compareToken } from '../../basics/token';
+import { ObjectClassType } from '../../basics/object-class-type';
+import { ErrorType } from '../../basics/error-type';
+import { ConcatenateType } from '../../basics/common';
+import { FormulaAstLRU } from '../../basics/cache-lru';
+import { Nullable } from '@univerjs/core';
+
 export type callbackMapFnType = (currentValue: BaseValueObject, row: number, column: number) => BaseValueObject;
-export type callbackProductFnType = (currentValue: BaseValueObject, operationValue: BaseValueObject) => BaseValueObject;
 export interface IArrayValueObject {
-    calculateValueList: BaseValueObject[][];
+    calculateValueList: Nullable<BaseValueObject>[][];
     rowCount: number;
     columnCount: number;
     unitId: string;
@@ -43,11 +30,10 @@ export declare class BaseValueObject extends ObjectClassType {
         unitId: string;
     };
     getValue(): string | number | boolean;
-    getArrayValue(): BaseValueObject[][];
+    getArrayValue(): Nullable<BaseValueObject>[][];
     setValue(value: string | number | boolean): void;
     setArrayValue(value: BaseValueObject[][]): void;
     isCube(): boolean;
-    isArray(): boolean;
     isString(): boolean;
     isNumber(): boolean;
     isBoolean(): boolean;
@@ -79,7 +65,6 @@ export declare class BaseValueObject extends ObjectClassType {
      * @returns
      */
     mapValue(callbackFn: callbackMapFnType): BaseValueObject;
-    product(valueObject: BaseValueObject, callbackFn: callbackProductFnType): BaseValueObject;
     compare(valueObject: BaseValueObject, operator: compareToken): BaseValueObject;
     isEqual(valueObject: BaseValueObject): BaseValueObject;
     isNotEqual(valueObject: BaseValueObject): BaseValueObject;
@@ -148,10 +133,14 @@ export declare class BaseValueObject extends ObjectClassType {
     floorInverse(valueObject: BaseValueObject): BaseValueObject;
     ceil(valueObject: BaseValueObject): BaseValueObject;
     ceilInverse(valueObject: BaseValueObject): BaseValueObject;
+    convertToNumberObjectValue(): BaseValueObject;
+    convertToBooleanObjectValue(): BaseValueObject;
 }
+export declare const ErrorValueObjectCache: FormulaAstLRU<ErrorValueObject>;
 export declare class ErrorValueObject extends BaseValueObject {
     private _errorType;
     private _errorContent;
+    static create(errorType: ErrorType, errorContent?: string): ErrorValueObject;
     constructor(_errorType: ErrorType, _errorContent?: string);
     getValue(): ErrorType;
     getErrorType(): ErrorType;

package/lib/types/engine/value-object/cube-value-object.d.ts

@@ -1,22 +1,9 @@
-/**
- * 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.
- */
-import type { ArrayValueObject } from './array-value-object';
-import { BaseValueObject } from './base-value-object';
 import { NumberValueObject } from './primitive-object';
+import { BaseValueObject } from './base-value-object';
+import { ArrayValueObject } from './array-value-object';
+
 export declare class CubeValueObject extends BaseValueObject {
+    static create(values: ArrayValueObject[]): CubeValueObject;
     isCube(): boolean;
     private _values;
     constructor(values: ArrayValueObject[]);

package/lib/types/engine/value-object/lambda-value-object.d.ts

@@ -1,26 +1,13 @@
-/**
- * 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.
- */
-import type { BaseAstNode } from '../ast-node/base-ast-node';
-import type { Interpreter } from '../interpreter/interpreter';
-import { AsyncObject } from '../reference-object/base-reference-object';
 import { BaseValueObject } from './base-value-object';
+import { AsyncObject } from '../reference-object/base-reference-object';
+import { Interpreter } from '../interpreter/interpreter';
+import { BaseAstNode } from '../ast-node/base-ast-node';
+
 export declare class LambdaValueObjectObject extends BaseValueObject {
     private _lambdaNode;
     private _interpreter;
     private _lambdaPrivacyVarKeys;
+    static create(lambdaNode: BaseAstNode, interpreter: Interpreter, lambdaPrivacyVarKeys: string[]): LambdaValueObjectObject;
     private _lambdaPrivacyValueMap;
     constructor(_lambdaNode: BaseAstNode, _interpreter: Interpreter, _lambdaPrivacyVarKeys: string[]);
     isLambda(): boolean;

package/lib/types/engine/value-object/primitive-object.d.ts

@@ -1,22 +1,11 @@
-/**
- * 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.
- */
+import { BaseValueObject, ErrorValueObject } from './base-value-object';
+import { FormulaAstLRU } from '../../basics/cache-lru';
 import { compareToken } from '../../basics/token';
-import { BaseValueObject } from './base-value-object';
+
 export type PrimitiveValueType = string | boolean | number | null;
 export declare class NullValueObject extends BaseValueObject {
+    private static _instance;
+    static create(): NullValueObject;
     isNull(): boolean;
     plus(valueObject: BaseValueObject): BaseValueObject;
     minus(valueObject: BaseValueObject): BaseValueObject;
@@ -52,10 +41,15 @@ export declare class NullValueObject extends BaseValueObject {
     round(valueObject: BaseValueObject): BaseValueObject;
     floor(valueObject: BaseValueObject): BaseValueObject;
     ceil(valueObject: BaseValueObject): BaseValueObject;
+    convertToNumberObjectValue(): NumberValueObject;
+    convertToBooleanObjectValue(): BooleanValueObject;
 }
 export declare class BooleanValueObject extends BaseValueObject {
     private _value;
-    constructor(rawValue: string | number | boolean, isForce?: boolean);
+    private static _instanceTrue;
+    private static _instanceFalse;
+    static create(value: boolean): BooleanValueObject;
+    constructor(rawValue: boolean);
     getValue(): boolean;
     isBoolean(): boolean;
     getNegative(): BaseValueObject;
@@ -90,10 +84,14 @@ export declare class BooleanValueObject extends BaseValueObject {
     round(valueObject: BaseValueObject): BaseValueObject;
     floor(valueObject: BaseValueObject): BaseValueObject;
     ceil(valueObject: BaseValueObject): BaseValueObject;
+    convertToNumberObjectValue(): ErrorValueObject | NumberValueObject;
+    convertToBooleanObjectValue(): this;
 }
+export declare const NumberValueObjectCache: FormulaAstLRU<NumberValueObject>;
 export declare class NumberValueObject extends BaseValueObject {
     private _value;
-    constructor(rawValue: string | number | boolean, isForce?: boolean);
+    static create(value: number, pattern?: string): NumberValueObject;
+    constructor(rawValue: number);
     getValue(): number;
     setValue(value: number): void;
     isNumber(): boolean;
@@ -134,16 +132,25 @@ export declare class NumberValueObject extends BaseValueObject {
     round(valueObject: BaseValueObject): BaseValueObject;
     floor(valueObject: BaseValueObject): BaseValueObject;
     ceil(valueObject: BaseValueObject): BaseValueObject;
+    convertToNumberObjectValue(): this;
+    convertToBooleanObjectValue(): BooleanValueObject;
     private _compareInfinity;
 }
+export declare const StringValueObjectCache: FormulaAstLRU<StringValueObject>;
 export declare class StringValueObject extends BaseValueObject {
     private _value;
-    constructor(rawValue: string | number | boolean, isForce?: boolean);
+    static create(value: string): StringValueObject;
+    constructor(rawValue: string);
     getValue(): string;
     isString(): boolean;
     concatenateFront(valueObject: BaseValueObject): BaseValueObject;
     concatenateBack(valueObject: BaseValueObject): BaseValueObject;
     compare(valueObject: BaseValueObject, operator: compareToken): BaseValueObject;
     compareBy(value: string | number | boolean, operator: compareToken): BaseValueObject;
+    convertToNumberObjectValue(): ErrorValueObject | NumberValueObject;
+    convertToBooleanObjectValue(): BooleanValueObject;
     private _checkWildcard;
 }
+export declare function createBooleanValueObjectByRawValue(rawValue: string | number | boolean): BooleanValueObject;
+export declare function createStringValueObjectByRawValue(rawValue: string | number | boolean): StringValueObject;
+export declare function createNumberValueObjectByRawValue(rawValue: string | number | boolean): ErrorValueObject | NumberValueObject;

package/lib/types/functions/__tests__/create-function-test-bed.d.ts

@@ -1,34 +1,21 @@
-/**
- * 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.
- */
-import type { IWorkbookData } from '@univerjs/core';
-import { Univer } from '@univerjs/core';
-import type { Dependency } from '@wendellhu/redi';
-import type { ISheetData } from '../../basics/common';
+import { FunctionVariantType } from '../../engine/reference-object/base-reference-object';
+import { ISheetData } from '../../basics/common';
+import { Dependency } from '@wendellhu/redi';
+import { IWorkbookData, Univer } from '@univerjs/core';
+
 export declare function createFunctionTestBed(workbookConfig?: IWorkbookData, dependencies?: Dependency[]): {
     univer: Univer;
     get: {
-        <T>(id: import("@wendellhu/redi").DependencyIdentifier<T>, lookUp?: import("@wendellhu/redi").LookUp | undefined): T;
-        <T_1>(id: import("@wendellhu/redi").DependencyIdentifier<T_1>, quantity: import("@wendellhu/redi").Quantity.MANY, lookUp?: import("@wendellhu/redi").LookUp | undefined): T_1[];
-        <T_2>(id: import("@wendellhu/redi").DependencyIdentifier<T_2>, quantity: import("@wendellhu/redi").Quantity.OPTIONAL, lookUp?: import("@wendellhu/redi").LookUp | undefined): T_2 | null;
-        <T_3>(id: import("@wendellhu/redi").DependencyIdentifier<T_3>, quantity: import("@wendellhu/redi").Quantity.REQUIRED, lookUp?: import("@wendellhu/redi").LookUp | undefined): T_3;
-        <T_4>(id: import("@wendellhu/redi").DependencyIdentifier<T_4>, quantity?: import("@wendellhu/redi").Quantity | undefined, lookUp?: import("@wendellhu/redi").LookUp | undefined): T_4 | T_4[] | null;
-        <T_5>(id: import("@wendellhu/redi").DependencyIdentifier<T_5>, quantityOrLookup?: import("@wendellhu/redi").Quantity | import("@wendellhu/redi").LookUp | undefined, lookUp?: import("@wendellhu/redi").LookUp | undefined): T_5 | T_5[] | null;
+        <T>(id: import('@wendellhu/redi').DependencyIdentifier<T>, lookUp?: import('@wendellhu/redi').LookUp | undefined): T;
+        <T_1>(id: import('@wendellhu/redi').DependencyIdentifier<T_1>, quantity: import("@wendellhu/redi").Quantity.MANY, lookUp?: import('@wendellhu/redi').LookUp | undefined): T_1[];
+        <T_2>(id: import('@wendellhu/redi').DependencyIdentifier<T_2>, quantity: import("@wendellhu/redi").Quantity.OPTIONAL, lookUp?: import('@wendellhu/redi').LookUp | undefined): T_2 | null;
+        <T_3>(id: import('@wendellhu/redi').DependencyIdentifier<T_3>, quantity: import("@wendellhu/redi").Quantity.REQUIRED, lookUp?: import('@wendellhu/redi').LookUp | undefined): T_3;
+        <T_4>(id: import('@wendellhu/redi').DependencyIdentifier<T_4>, quantity?: import('@wendellhu/redi').Quantity | undefined, lookUp?: import('@wendellhu/redi').LookUp | undefined): T_4 | T_4[] | null;
+        <T_5>(id: import('@wendellhu/redi').DependencyIdentifier<T_5>, quantityOrLookup?: import('@wendellhu/redi').Quantity | import('@wendellhu/redi').LookUp | undefined, lookUp?: import('@wendellhu/redi').LookUp | undefined): T_5 | T_5[] | null;
     };
-    sheet: import("@univerjs/core").Workbook;
+    sheet: import('@univerjs/core').Workbook;
     unitId: string;
     sheetId: string;
     sheetData: ISheetData;
 };
+export declare function getObjectValue(result: FunctionVariantType): string | number | boolean | (string | number | boolean | null)[][];

package/lib/types/functions/base-function.d.ts

@@ -1,27 +1,11 @@
-/**
- * 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.
- */
-import type { Nullable } from '@univerjs/core';
-import { Disposable } from '@univerjs/core';
-import type { IFunctionNames } from '../basics/function';
-import type { FunctionVariantType, NodeValueType } from '../engine/reference-object/base-reference-object';
-import type { ArrayBinarySearchType } from '../engine/utils/compare';
-import { ArrayOrderSearchType } from '../engine/utils/compare';
-import type { ArrayValueObject } from '../engine/value-object/array-value-object';
-import { type BaseValueObject, ErrorValueObject } from '../engine/value-object/base-value-object';
-import { type PrimitiveValueType } from '../engine/value-object/primitive-object';
+import { PrimitiveValueType } from '../engine/value-object/primitive-object';
+import { BaseValueObject, ErrorValueObject } from '../engine/value-object/base-value-object';
+import { ArrayValueObject } from '../engine/value-object/array-value-object';
+import { ArrayBinarySearchType, ArrayOrderSearchType } from '../engine/utils/compare';
+import { BaseReferenceObject, FunctionVariantType, NodeValueType } from '../engine/reference-object/base-reference-object';
+import { IFunctionNames } from '../basics/function';
+import { IRange, Nullable, Disposable } from '@univerjs/core';
+
 export declare class BaseFunction extends Disposable {
     private _name;
     private _unitId;
@@ -54,7 +38,6 @@ export declare class BaseFunction extends Disposable {
      * For instance, The column number (starting with 1 for the left-most column of table_array) that contains the return value.
      * https://support.microsoft.com/en-us/office/vlookup-function-0bbc8083-26fe-4963-8ab8-93a18ad188a1
      * @param indexNum
-     * @returns
      */
     getIndexNumValue(indexNum: BaseValueObject, defaultValue?: number): number | ErrorValueObject;
     /**
@@ -68,28 +51,24 @@ export declare class BaseFunction extends Disposable {
      * If a1 is FALSE, ref_text is interpreted as an R1C1-style reference.
      * https://support.microsoft.com/zh-cn/office/indirect-%E5%87%BD%E6%95%B0-474b3a3a-8a26-4f44-b491-92b6306fa261
      * @param logicValueObject
-     * @returns
      */
     getZeroOrOneByOneDefault(logicValueObject?: BaseValueObject): number | undefined;
     /**
      * A logical value that specifies 1/TRUE , 0/FALSE, -1, default 1.
      * The difference from getZeroOrOneByOneDefault is that we need to get -1
      * @param logicValueObject
-     * @returns
      */
     getMatchTypeValue(logicValueObject?: BaseValueObject): number | undefined;
     binarySearch(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, searchType?: ArrayBinarySearchType): BaseValueObject;
     equalSearch(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, isFirst?: boolean): BaseValueObject;
     fuzzySearch(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, isFirst?: boolean): BaseValueObject;
     orderSearch(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, searchType?: ArrayOrderSearchType, isDesc?: boolean): BaseValueObject;
-    /**
-     * @param axis 0 row, 1 column
-     * @returns
-     */
     binarySearchExpand(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, axis?: number, searchType?: ArrayBinarySearchType): ErrorValueObject | ArrayValueObject | undefined;
     equalSearchExpand(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, isFirst?: boolean, axis?: number): ErrorValueObject | ArrayValueObject | undefined;
     fuzzySearchExpand(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, isFirst?: boolean, axis?: number): ErrorValueObject | ArrayValueObject | undefined;
     orderSearchExpand(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, searchType?: ArrayOrderSearchType, isDesc?: boolean, axis?: number): ErrorValueObject | ArrayValueObject | undefined;
     flattenArray(variants: BaseValueObject[], ignoreLogicalValuesAndText?: boolean): ArrayValueObject | BaseValueObject;
     private _includingLogicalValuesAndText;
+    createReferenceObject(reference: BaseReferenceObject, range: IRange): ErrorValueObject | BaseReferenceObject;
+    private _setReferenceDefault;
 }

package/lib/types/functions/compatibility/function-map.d.ts

@@ -1,18 +1,4 @@
-/**
- * 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.
- */
-import { StdevS } from '../statistical/stdev-s';
 import { FUNCTION_NAMES_COMPATIBILITY } from './function-names';
+import { StdevS } from '../statistical/stdev-s';
+
 export declare const functionCompatibility: (FUNCTION_NAMES_COMPATIBILITY | typeof StdevS)[][];