@univerjs/engine-formula 0.2.14 → 0.2.15

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

@@ -1,11 +1,17 @@
 import { compareToken } from '../../basics/token';
+/**
+ * For SearchType
+ */
 export declare enum ArrayBinarySearchType {
-    MIN = 0,
+    MIN = 0,// Ascending order
     MAX = 1
 }
+/**
+ * For MatchType
+ */
 export declare enum ArrayOrderSearchType {
-    NORMAL = 0,
-    MIN = 1,
+    NORMAL = 0,// Exact match.
+    MIN = 1,// Exact match. If none found, return the next smaller item.
     MAX = 2
 }
 export declare function getCompare(): (x: string, y: string) => number;
@@ -14,3 +20,5 @@ export declare function isMatchWildcard(currentValue: string, value: string): bo
 export declare function replaceWildcard(value: string): string;
 export declare function compareWithWildcard(currentValue: string, value: string, operator: compareToken): boolean;
 export declare function escapeRegExp(str: string): string;
+export declare function getMatchModeValue(matchModeValue: number): ArrayOrderSearchType;
+export declare function getSearchModeValue(searchModeValue: number): ArrayBinarySearchType;

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

@@ -117,7 +117,18 @@ export declare class ArrayValueObject extends BaseValueObject {
         row: number;
         column: number;
     } | null;
-    binarySearch(valueObject: BaseValueObject, searchType?: ArrayBinarySearchType): number | undefined;
+    binarySearch(valueObject: BaseValueObject, searchType?: ArrayBinarySearchType, matchType?: ArrayOrderSearchType): number | undefined;
+    /**
+     * searchType defaults to ascending order
+     *
+     * matchType defaults to the maximum value less than the search value, which is used for the default matching mode of VLOOKUP/LOOKUP/HLOOKUP.
+     * @param valueObject
+     * @param searchArray
+     * @param positionArray
+     * @param searchType
+     * @param matchType
+     * @returns
+     */
     private _binarySearch;
     sum(): BaseValueObject;
     max(): BaseValueObject;

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

@@ -1,10 +1,10 @@
-import { IRange, Nullable, Disposable } from '@univerjs/core';
+import { Disposable, IRange, Nullable } from '@univerjs/core';
+import { ArrayOrderSearchType, ArrayBinarySearchType } from '../engine/utils/compare';
+import { BaseValueObject, ErrorValueObject } from '../engine/value-object/base-value-object';
+import { PrimitiveValueType } from '../engine/value-object/primitive-object';
 import { IFunctionNames } from '../basics/function';
 import { BaseReferenceObject, FunctionVariantType, NodeValueType } from '../engine/reference-object/base-reference-object';
-import { ArrayBinarySearchType, ArrayOrderSearchType } from '../engine/utils/compare';
 import { ArrayValueObject } from '../engine/value-object/array-value-object';
-import { BaseValueObject, ErrorValueObject } from '../engine/value-object/base-value-object';
-import { PrimitiveValueType } from '../engine/value-object/primitive-object';
 import { IDefinedNameMapItem } from '../services/defined-names.service';
 export declare class BaseFunction extends Disposable {
     private _name;
@@ -76,13 +76,13 @@ export declare class BaseFunction extends Disposable {
      * @param logicValueObject
      */
     getMatchTypeValue(logicValueObject?: BaseValueObject): number | undefined;
-    binarySearch(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, searchType?: ArrayBinarySearchType): BaseValueObject;
+    binarySearch(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, searchType?: ArrayBinarySearchType, matchType?: ArrayOrderSearchType): BaseValueObject;
     private _getOneFirstByRaw;
     private _getOneLastByRaw;
     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;
-    binarySearchExpand(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, axis?: number, searchType?: ArrayBinarySearchType): ErrorValueObject | ArrayValueObject | undefined;
+    binarySearchExpand(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, axis?: number, searchType?: ArrayBinarySearchType, matchType?: ArrayOrderSearchType): 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;

package/lib/types/functions/lookup/xlookup/index.d.ts

@@ -1,6 +1,6 @@
+import { BaseFunction } from '../../base-function';
 import { ArrayValueObject } from '../../../engine/value-object/array-value-object';
 import { BaseValueObject } from '../../../engine/value-object/base-value-object';
-import { BaseFunction } from '../../base-function';
 export declare class Xlookup extends BaseFunction {
     minParams: number;
     maxParams: number;
@@ -8,5 +8,11 @@ export declare class Xlookup extends BaseFunction {
     private _getResult;
     private _handleExpandObject;
     private _handleSingleObject;
-    private _getSearchModeValue;
+    /**
+     * Wildcard matching and binary search cannot appear at the same time
+     * @param matchModeValue
+     * @param searchModeValue
+     * @returns
+     */
+    private _checkErrorCombination;
 }

package/lib/types/functions/lookup/xmatch/index.d.ts

@@ -1,10 +1,9 @@
+import { BaseFunction } from '../../base-function';
 import { ArrayValueObject } from '../../../engine/value-object/array-value-object';
 import { BaseValueObject } from '../../../engine/value-object/base-value-object';
-import { BaseFunction } from '../../base-function';
 export declare class Xmatch extends BaseFunction {
     minParams: number;
     maxParams: number;
     calculate(lookupValue: BaseValueObject, lookupArray: ArrayValueObject, matchMode?: BaseValueObject, searchMode?: BaseValueObject): BaseValueObject;
     private _handleSingleObject;
-    private _getSearchModeValue;
 }

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

@@ -1,5 +1,5 @@
-import { FUNCTION_NAMES_MATH } from './function-names';
 import { Base } from './base';
+import { FUNCTION_NAMES_MATH } from './function-names';
 import { Randarray } from './randarray';
 import { Subtotal } from './subtotal';
 import { Sum } from './sum';

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

@@ -1,6 +1,6 @@
-import { FUNCTION_NAMES_TEXT } from './function-names';
 import { Concat } from './concat';
 import { Concatenate } from './concatenate';
+import { FUNCTION_NAMES_TEXT } from './function-names';
 import { Lower } from './lower';
 import { Textafter } from './textafter';
 import { Textbefore } from './textbefore';

package/lib/types/functions/text/leftb/__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/leftb/index.d.ts

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

package/lib/types/functions/text/mid/__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/mid/index.d.ts

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

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

@@ -1,7 +1,7 @@
-import { ArrayValueObject } from '../../../engine/value-object/array-value-object';
 import { BaseValueObject } from '../../../engine/value-object/base-value-object';
 import { StringValueObject } from '../../../engine/value-object/primitive-object';
 import { BaseFunction } from '../../base-function';
+import { ArrayValueObject } from '../../../engine/value-object/array-value-object';
 export declare class Textafter extends BaseFunction {
     minParams: number;
     maxParams: number;
@@ -9,6 +9,7 @@ export declare class Textafter extends BaseFunction {
     private _getResultArray;
     private _checkVariantsError;
     private _getStringValue;
+    private _getDelimiterValue;
     private _getVariantsNumberFloorValue;
     private _getResult;
 }

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

@@ -1,7 +1,7 @@
-import { ArrayValueObject } from '../../../engine/value-object/array-value-object';
 import { BaseValueObject } from '../../../engine/value-object/base-value-object';
 import { StringValueObject } from '../../../engine/value-object/primitive-object';
 import { BaseFunction } from '../../base-function';
+import { ArrayValueObject } from '../../../engine/value-object/array-value-object';
 export declare class Textbefore extends BaseFunction {
     minParams: number;
     maxParams: number;
@@ -9,6 +9,7 @@ export declare class Textbefore extends BaseFunction {
     private _getResultArray;
     private _checkVariantsError;
     private _getStringValue;
+    private _getDelimiterValue;
     private _getVariantsNumberFloorValue;
     private _getResult;
 }