@univerjs/engine-formula 1.0.0-beta.0 → 1.0.0-beta.1

package/lib/types/basics/common.d.ts

@@ -220,6 +220,8 @@ export interface ISuperTable {
      * Sheet tables default to true; Base virtual tables store records from row 0.
      */
     showHeader?: boolean;
+    /** Whether the projected range contains a physical totals row. */
+    showFooter?: boolean;
 }
 export declare enum TableOptionType {
     ALL = "#All",

package/lib/types/basics/regex.d.ts

@@ -32,10 +32,10 @@ export declare const REFERENCE_REGEX_SINGLE_ROW = "^'?(\\[([^\\[\\]\\/?:\"<>|*\\
 export declare const REFERENCE_REGEX_SINGLE_ROW_PRECOMPILING: RegExp;
 export declare const REFERENCE_REGEX_SINGLE_COLUMN = "^'?(\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\])?(((?![\\[\\]\\/?*\\\\]).)*!)?'?\\s*?\\$?[A-Za-z]+$";
 export declare const REFERENCE_REGEX_SINGLE_COLUMN_PRECOMPILING: RegExp;
-export declare const REFERENCE_TABLE_ALL_COLUMN_REGEX = "^(?:(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+$";
-export declare const REFERENCE_TABLE_SINGLE_COLUMN_REGEX = "^(?:(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+(\\[[^#]*#?\\]|\\[\\[#.+\\]\\s*?,\\s*?\\[[^#]*#?\\]\\])+$";
-export declare const REFERENCE_TABLE_MULTIPLE_COLUMN_REGEX = "^(?:(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+(\\[\\[[^#]*#?\\]\\s*?:\\s*?\\[[^#]*#?\\]\\])?$|^(?:(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+(\\[\\[#.+\\]\\s*?,\\s*?\\[[^#]*#?\\]\\s*?:\\s*?\\[[^#]*#?\\]\\])?$";
-export declare const REFERENCE_TABLE_TITLE_ONLY_ANY_HASH_REGEX = "^(?:(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[([^\\[\\]\\/?:\"<>|*\\\\]+)\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+\\[\\s*#([^\\]]+)\\s*\\]$";
+export declare const REFERENCE_TABLE_ALL_COLUMN_REGEX = "^(?:(?:\\[(?:[^\\]]|\\]\\])+\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[(?:[^\\]]|\\]\\])+\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+$";
+export declare const REFERENCE_TABLE_SINGLE_COLUMN_REGEX = "^(?:(?:\\[(?:[^\\]]|\\]\\])+\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[(?:[^\\]]|\\]\\])+\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+(\\[[^#]*#?\\]|\\[\\[#.+\\]\\s*?,\\s*?\\[[^#]*#?\\]\\])+$";
+export declare const REFERENCE_TABLE_MULTIPLE_COLUMN_REGEX = "^(?:(?:\\[(?:[^\\]]|\\]\\])+\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[(?:[^\\]]|\\]\\])+\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+(\\[\\[[^#]*#?\\]\\s*?:\\s*?\\[[^#]*#?\\]\\])?$|^(?:(?:\\[(?:[^\\]]|\\]\\])+\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[(?:[^\\]]|\\]\\])+\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+(\\[\\[#.+\\]\\s*?,\\s*?\\[[^#]*#?\\]\\s*?:\\s*?\\[[^#]*#?\\]\\])?$";
+export declare const REFERENCE_TABLE_TITLE_ONLY_ANY_HASH_REGEX = "^(?:(?:\\[(?:[^\\]]|\\]\\])+\\]|'(?:[^']|'')+'|[^\\s!\\[\\]]+)!)?(?:\\[(?:[^\\]]|\\]\\])+\\])?((?![~!@#$%^&*()+<>?:,./;\u2019\uFF0C\u3002\u3001\u2018\uFF1A\u201C\u300A\u300B\uFF1F~\uFF01@#\uFFE5%\u2026\u2026\uFF08\uFF09\u3010\u3011\\[\\]\\/\\\\]).)+\\[\\s*#([^\\]]+)\\s*\\]$";
 export declare const REFERENCE_TABLE_ALL_COLUMN_REGEX_PRECOMPILING: RegExp;
 export declare const REFERENCE_TABLE_SINGLE_COLUMN_REGEX_PRECOMPILING: RegExp;
 export declare const REFERENCE_TABLE_MULTIPLE_COLUMN_REGEX_PRECOMPILING: RegExp;

package/lib/types/controllers/formula-calculation-trigger.controller.d.ts

@@ -15,7 +15,6 @@
  */
 import { Disposable, LifecycleService } from '@univerjs/core';
 import { FormulaCalculationTriggerService } from '../services/formula-calculation-trigger.service';
-import { RegisterOtherFormulaService } from '../services/register-other-formula.service';
 export declare class FormulaCalculationTriggerController extends Disposable {
-    constructor(formulaCalculationTriggerService: FormulaCalculationTriggerService, registerOtherFormulaService: RegisterOtherFormulaService, lifecycleService: LifecycleService);
+    constructor(formulaCalculationTriggerService: FormulaCalculationTriggerService, lifecycleService: LifecycleService);
 }

package/lib/types/controllers/formula.controller.d.ts

@@ -17,7 +17,7 @@ import { Disposable, ICommandService, IConfigService } from '@univerjs/core';
 import { DataSyncPrimaryController } from '@univerjs/rpc';
 import { IFunctionService } from '../services/function.service';
 import { RegisterOtherFormulaService } from '../services/register-other-formula.service';
-type FormulaDataSyncController = Pick<DataSyncPrimaryController, 'registerSyncingMutations' | 'syncUnitMutations'>;
+type FormulaDataSyncController = Pick<DataSyncPrimaryController, 'registerSyncingMutations' | 'syncUnitMutations' | 'waitForPendingMutations'>;
 export declare class FormulaController extends Disposable {
     private readonly _commandService;
     private readonly _functionService;

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

@@ -132,7 +132,7 @@ export declare class ArrayValueObject extends BaseValueObject {
      * the sequential matching approach is only used for special matches in XLOOKUP and XMATCH.
      * For example, when match_mode is set to 1 and -1 for an exact match. If not found, it returns the next smaller item.
      */
-    orderSearch(valueObject: BaseValueObject, searchType?: ArrayOrderSearchType, isDesc?: boolean, isFuzzyMatching?: boolean): void | {
+    orderSearch(valueObject: BaseValueObject, searchType?: ArrayOrderSearchType, isDesc?: boolean, isFuzzyMatching?: boolean, keepFirstNearest?: boolean): void | {
         row: number;
         column: number;
     } | null;

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

@@ -167,11 +167,11 @@ export declare class BaseFunction {
     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;
+    orderSearch(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, searchType?: ArrayOrderSearchType, isDesc?: boolean, keepFirstNearest?: boolean): BaseValueObject;
     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;
+    orderSearchExpand(value: BaseValueObject, searchArray: ArrayValueObject, resultArray: ArrayValueObject, searchType?: ArrayOrderSearchType, isDesc?: boolean, axis?: number, keepFirstNearest?: boolean): ErrorValueObject | ArrayValueObject | undefined;
     flattenArray(variants: BaseValueObject[], ignoreLogicalValuesAndText?: boolean): ArrayValueObject | BaseValueObject;
     private _includingLogicalValuesAndText;
     createReferenceObject(reference: BaseReferenceObject, range: IRange): ErrorValueObject | BaseReferenceObject;

package/lib/types/functions/logical/percentof/index.d.ts

@@ -14,14 +14,13 @@
  * limitations under the License.
  */
 import type { BaseValueObject } from '../../../engine/value-object/base-value-object';
-import { ErrorValueObject } from '../../../engine/value-object/base-value-object';
-import { BaseFunction } from '../../base-function';
+import { Sum } from '../../math/sum';
 /**
- * PERCENTOF is an Excel GROUPBY aggregator token. It is evaluated by GROUPBY's
- * AST path, not as a standalone scalar function.
+ * PERCENTOF is logically equivalent to SUM(dataSubset) / SUM(dataAll).
+ * GROUPBY also consumes the function name as an aggregator token through its AST path.
  */
-export declare class Percentof extends BaseFunction {
+export declare class Percentof extends Sum {
     minParams: number;
     maxParams: number;
-    calculate(..._variants: BaseValueObject[]): ErrorValueObject;
+    calculate(dataSubset: BaseValueObject, dataAll: BaseValueObject): BaseValueObject;
 }

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

@@ -23,6 +23,10 @@ export declare class Xlookup extends BaseFunction {
     private _legacyImplicitLookupValue;
     private _handleExpandObject;
     private _handleSingleObject;
+    private _exactSearch;
+    private _exactSearchExpand;
+    private _findExactPosition;
+    private _isExactMatch;
     private _blankResultAsZero;
     /**
      * Wildcard matching and binary search cannot appear at the same time

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

@@ -13,11 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IRange, Nullable } from '@univerjs/core';
+import type { IDisposable, IRange, Nullable } from '@univerjs/core';
 import type { ISetFormulaCalculationResultMutation } from '../commands/mutations/set-formula-calculation.mutation';
 import type { IOtherFormulaResult } from './formula-common';
 import { Disposable, ICommandService, LifecycleService } from '@univerjs/core';
-import { BehaviorSubject } from 'rxjs';
 import { IActiveDirtyManagerService } from './active-dirty-manager.service';
 export declare enum OtherFormulaBizType {
     DEFAULT = "default",
@@ -33,6 +32,7 @@ export declare class RegisterOtherFormulaService extends Disposable {
     private _activeDirtyManagerService;
     private readonly _lifecycleService;
     private _formulaCacheMap;
+    private _mutationSyncHandler?;
     private _formulaChangeWithRange$;
     formulaChangeWithRange$: import("rxjs").Observable<{
         unitId: string;
@@ -45,12 +45,12 @@ export declare class RegisterOtherFormulaService extends Disposable {
     formulaResult$: import("rxjs").Observable<Record<string, Record<string, IOtherFormulaResult[]>>>;
     private _otherFormulaResultApplied$;
     otherFormulaResultApplied$: import("rxjs").Observable<ISetFormulaCalculationResultMutation>;
-    calculateStarted$: BehaviorSubject<boolean>;
     constructor(_commandService: ICommandService, _activeDirtyManagerService: IActiveDirtyManagerService, _lifecycleService: LifecycleService);
     dispose(): void;
     private _ensureCacheMap;
     private _createFormulaId;
     private _initFormulaRegister;
+    setMutationSyncHandler(handler: (unitId: string) => () => Promise<void>): IDisposable;
     private _initFormulaCalculationResultChange;
     registerFormulaWithRange(unitId: string, subUnitId: string, formulaText: string, ranges?: IRange[], extra?: Record<string, any>, bizType?: OtherFormulaBizType, bizId?: string): string;
     getFormulaDirtyMap(unitId: string): Record<string, Record<string, boolean>>;

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

@@ -78,6 +78,7 @@ export interface IFormulaRuntimeService {
     reset(): void;
     setCurrent(row: number, column: number, rowCount: number, columnCount: number, sheetId: string, unitId: string): void;
     setFunctionRefInfoOverride(rowCount: number, columnCount: number): () => void;
+    hasFunctionRefInfoOverride(): boolean;
     registerFunctionDefinitionPrivacyVar(lambdaId: string, lambdaVar: Map<string, Nullable<BaseAstNode>>): void;
     getFunctionDefinitionPrivacyVar(lambdaId: string): Nullable<Map<string, Nullable<BaseAstNode>>>;
     setRuntimeData(functionVariant: FunctionVariantType): void;
@@ -187,6 +188,7 @@ export declare class FormulaRuntimeService extends Disposable implements IFormul
     clearReferenceAndNumberformatCache(): void;
     setCurrent(row: number, column: number, rowCount: number, columnCount: number, sheetId: string, unitId: string): void;
     setFunctionRefInfoOverride(rowCount: number, columnCount: number): () => void;
+    hasFunctionRefInfoOverride(): boolean;
     clearFunctionDefinitionPrivacyVar(): void;
     registerFunctionDefinitionPrivacyVar(lambdaId: string, lambdaVar: Map<string, Nullable<BaseAstNode>>): void;
     getFunctionDefinitionPrivacyVar(lambdaId: string): Nullable<Map<string, Nullable<BaseAstNode>>>;