@univerjs/sheets-data-validation 0.5.0-alpha.0 → 0.5.0-beta.0

package/lib/types/controllers/dv-formula-ref-range.controller.d.ts

@@ -0,0 +1,13 @@
+import { ISheetDataValidationRule, Disposable } from '@univerjs/core';
+import { FormulaRefRangeService } from '@univerjs/sheets-formula';
+import { SheetDataValidationModel } from '../models/sheet-data-validation-model';
+export declare class DataValidationFormulaRefRangeController extends Disposable {
+    private _dataValidationModel;
+    private _formulaRefRangeService;
+    private _disposableMap;
+    constructor(_dataValidationModel: SheetDataValidationModel, _formulaRefRangeService: FormulaRefRangeService);
+    private _getIdWithUnitId;
+    registerRule: (unitId: string, subUnitId: string, rule: ISheetDataValidationRule) => void;
+    register(unitId: string, subUnitId: string, rule: ISheetDataValidationRule): void;
+    private _initRefRange;
+}

package/lib/types/models/sheet-data-validation-model.d.ts

@@ -1,4 +1,4 @@
-import { ISheetDataValidationRule, DataValidationStatus, DataValidationType, Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
+import { DataValidationType, ISheetDataValidationRule, DataValidationStatus, Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
 import { IRuleChange, DataValidationModel, DataValidatorRegistryService } from '@univerjs/data-validation';
 import { ISheetLocation } from '@univerjs/sheets';
 import { DataValidationCacheService } from '../services/dv-cache.service';
@@ -38,7 +38,6 @@ export declare class SheetDataValidationModel extends Disposable {
     getRuleIdByLocation(unitId: string, subUnitId: string, row: number, col: number): string | undefined;
     getRuleByLocation(unitId: string, subUnitId: string, row: number, col: number): ISheetDataValidationRule | undefined;
     validator(rule: ISheetDataValidationRule, pos: ISheetLocation, _onCompete?: (status: DataValidationStatus, changed: boolean) => void): DataValidationStatus;
-    getRuleErrorMsg(unitId: string, subUnitId: string, ruleId: string): string;
     getRuleObjectMatrix(unitId: string, subUnitId: string): RuleMatrix;
     getRuleById(unitId: string, subUnitId: string, ruleId: string): ISheetDataValidationRule | undefined;
     getRuleIndex(unitId: string, subUnitId: string, ruleId: string): number;

package/lib/types/services/dv-custom-formula.service.d.ts

@@ -6,7 +6,6 @@ interface IFormulaData {
     formula: string;
     originRow: number;
     originCol: number;
-    isTransformable: boolean;
     formulaId: string;
 }
 export declare class DataValidationCustomFormulaService extends Disposable {
@@ -18,6 +17,7 @@ export declare class DataValidationCustomFormulaService extends Disposable {
      * Map of origin formula of rule
      */
     private _ruleFormulaMap;
+    private _ruleFormulaMap2;
     constructor(_instanceSrv: IUniverInstanceService, _registerOtherFormulaService: RegisterOtherFormulaService, _dataValidationModel: DataValidationModel, _dataValidationCacheService: DataValidationCacheService);
     private _initFormulaResultHandler;
     private _ensureMaps;
@@ -26,6 +26,9 @@ export declare class DataValidationCustomFormulaService extends Disposable {
     private _addFormulaByRange;
     addRule(unitId: string, subUnitId: string, rule: ISheetDataValidationRule): void;
     getCellFormulaValue(unitId: string, subUnitId: string, ruleId: string, row: number, column: number): Promise<import('@univerjs/core').Nullable<import('@univerjs/core').ICellData>>;
+    getCellFormula2Value(unitId: string, subUnitId: string, ruleId: string, row: number, column: number): Promise<import('@univerjs/core').Nullable<import('@univerjs/core').ICellData>>;
+    getCellFormulaValueSync(unitId: string, subUnitId: string, ruleId: string, row: number, column: number): import('@univerjs/core').Nullable<import('@univerjs/core').ICellData>;
+    getCellFormula2ValueSync(unitId: string, subUnitId: string, ruleId: string, row: number, column: number): import('@univerjs/core').Nullable<import('@univerjs/core').ICellData>;
     getRuleFormulaInfo(unitId: string, subUnitId: string, ruleId: string): IFormulaData | undefined;
 }
 export {};

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

@@ -1,4 +1,4 @@
-import { IRange, Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { ISheetDataValidationRule, Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
 import { IFormulaInfo, IOtherFormulaResult, RegisterOtherFormulaService } from '@univerjs/sheets-formula';
 import { DataValidationModel } from '@univerjs/data-validation';
 import { DataValidationCacheService } from './dv-cache.service';
@@ -12,9 +12,8 @@ export declare class DataValidationFormulaService extends Disposable {
     private _initFormulaResultHandler;
     private _ensureRuleFormulaMap;
     private _registerSingleFormula;
-    addRule(unitId: string, subUnitId: string, ruleId: string, formula1: string | undefined, formula2: string | undefined, ranges: IRange[]): void;
+    addRule(unitId: string, subUnitId: string, rule: ISheetDataValidationRule): void;
     removeRule(unitId: string, subUnitId: string, ruleId: string): void;
-    updateRuleFormulaText(unitId: string, subUnitId: string, ruleId: string, formula1: string | undefined, formula2: string | undefined, ranges: IRange[]): void;
     getRuleFormulaResult(unitId: string, subUnitId: string, ruleId: string): Promise<Nullable<[Nullable<IOtherFormulaResult>, Nullable<IOtherFormulaResult>]>>;
     getRuleFormulaResultSync(unitId: string, subUnitId: string, ruleId: string): Nullable<IOtherFormulaResult>[] | undefined;
     getRuleFormulaInfo(unitId: string, subUnitId: string, ruleId: string): [IFormulaInfo | undefined, IFormulaInfo | undefined] | undefined;

package/lib/types/utils/formula.d.ts

@@ -1,4 +1,8 @@
-import { ICellData, Nullable } from '@univerjs/core';
+import { DataValidationType, ICellData, Nullable } from '@univerjs/core';
 export declare function getFormulaResult(result: Nullable<Nullable<ICellData>[][]>): Nullable<import('@univerjs/core').CellValue>;
 export declare function getFormulaCellData(result: Nullable<Nullable<ICellData>[][]>): Nullable<ICellData>;
 export declare function isLegalFormulaResult(res: string): boolean;
+/**
+ * Judge if the data-validation's formula need to be offseted by ranges
+ */
+export declare function isCustomFormulaType(type: DataValidationType): type is DataValidationType.CUSTOM | DataValidationType.NONE | DataValidationType.TEXT_LENGTH | DataValidationType.DATE | DataValidationType.TIME | DataValidationType.WHOLE | DataValidationType.DECIMAL;

package/lib/types/validators/const.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 declare const FORMULA1 = "{FORMULA1}";
+export declare const FORMULA2 = "{FORMULA2}";

package/lib/types/validators/custom-validator.d.ts

@@ -5,7 +5,7 @@ export declare class CustomFormulaValidator extends BaseDataValidator {
     title: string;
     operators: DataValidationOperator[];
     scopes: string | string[];
-    private _customFormulaService;
+    private readonly _customFormulaService;
     validatorFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): IFormulaValidResult;
     parseFormula(_rule: IDataValidationRule, _unitId: string, _subUnitId: string): Promise<IFormulaResult>;
     isValidType(cellInfo: IValidatorCellInfo<CellValue>, _formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;

package/lib/types/validators/date-validator.d.ts

@@ -1,16 +1,14 @@
 import { CellValue, IDataValidationRule, IDataValidationRuleBase, DataValidationOperator } from '@univerjs/core';
 import { IFormulaResult, IFormulaValidResult, IValidatorCellInfo, BaseDataValidator } from '@univerjs/data-validation';
+import { ISheetLocationBase } from '@univerjs/sheets';
 export declare class DateValidator extends BaseDataValidator<number> {
     id: string;
     title: string;
     operators: DataValidationOperator[];
     scopes: string | string[];
-    private _formulaService;
-    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<IFormulaResult<number | undefined>>;
-    parseFormulaSync(rule: IDataValidationRule, unitId: string, subUnitId: string): {
-        formula1: number | undefined;
-        formula2: number | undefined;
-    };
+    private readonly _customFormulaService;
+    private readonly _lexerTreeBuilder;
+    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string, row: number, column: number): Promise<IFormulaResult<number | undefined>>;
     isValidType(info: IValidatorCellInfo): Promise<boolean>;
     private _validatorSingleFormula;
     validatorFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): IFormulaValidResult;
@@ -29,5 +27,5 @@ export declare class DateValidator extends BaseDataValidator<number> {
     validatorIsLessThanOrEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
     get operatorNames(): string[];
     generateRuleName(rule: IDataValidationRuleBase): string;
-    generateRuleErrorMessage(rule: IDataValidationRuleBase): string;
+    generateRuleErrorMessage(rule: IDataValidationRuleBase, pos: ISheetLocationBase): string;
 }

package/lib/types/validators/decimal-validator.d.ts

@@ -1,9 +1,11 @@
-import { CellValue, IDataValidationRule, Nullable, DataValidationOperator } from '@univerjs/core';
+import { CellValue, IDataValidationRule, IDataValidationRuleBase, Nullable, DataValidationOperator } from '@univerjs/core';
 import { IFormulaResult, IFormulaValidResult, IValidatorCellInfo, BaseDataValidator } from '@univerjs/data-validation';
+import { ISheetLocationBase } from '@univerjs/sheets';
 export declare function getCellValueNumber(cellValue: CellValue): number;
 export declare class DecimalValidator extends BaseDataValidator<number> {
-    private _formulaService;
+    private readonly _customFormulaService;
     id: string;
+    private readonly _lexerTreeBuilder;
     title: string;
     operators: DataValidationOperator[];
     scopes: string | string[];
@@ -21,7 +23,7 @@ export declare class DecimalValidator extends BaseDataValidator<number> {
         t: Nullable<import('@univerjs/protocol').CellValueType>;
     };
     private _parseNumber;
-    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<IFormulaResult>;
+    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string, row: number, column: number): Promise<IFormulaResult>;
     validatorFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): IFormulaValidResult;
     validatorIsEqual(cellInfo: IValidatorCellInfo<CellValue>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
     validatorIsNotEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
@@ -31,4 +33,5 @@ export declare class DecimalValidator extends BaseDataValidator<number> {
     validatorIsGreaterThanOrEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
     validatorIsLessThan(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
     validatorIsLessThanOrEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
+    generateRuleErrorMessage(rule: IDataValidationRuleBase, position: ISheetLocationBase): string;
 }

package/lib/types/validators/text-length-validator.d.ts

@@ -1,16 +1,18 @@
 import { CellValue, IDataValidationRule, IDataValidationRuleBase, Nullable, DataValidationOperator } from '@univerjs/core';
 import { IFormulaResult, IFormulaValidResult, IValidatorCellInfo, BaseDataValidator } from '@univerjs/data-validation';
+import { ISheetLocationBase } from '@univerjs/sheets';
 export declare class TextLengthValidator extends BaseDataValidator<number> {
     id: string;
     title: string;
+    private readonly _lexerTreeBuilder;
     operators: DataValidationOperator[];
     scopes: string | string[];
-    private _formulaService;
+    private readonly _customFormulaService;
     private _isFormulaOrInt;
     validatorFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): IFormulaValidResult;
     private _parseNumber;
     private _isValidFormula;
-    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<IFormulaResult<any>>;
+    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string, row: number, column: number): Promise<IFormulaResult<any>>;
     transform(cellInfo: IValidatorCellInfo<CellValue>, _formula: IFormulaResult, _rule: IDataValidationRule): {
         value: number;
         interceptValue: Nullable<CellValue>;
@@ -31,5 +33,5 @@ export declare class TextLengthValidator extends BaseDataValidator<number> {
     validatorIsGreaterThanOrEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
     validatorIsLessThan(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
     validatorIsLessThanOrEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
-    generateRuleErrorMessage(rule: IDataValidationRuleBase): string;
+    generateRuleErrorMessage(rule: IDataValidationRuleBase, pos: ISheetLocationBase): string;
 }

package/lib/types/validators/util.d.ts

@@ -1,5 +1,11 @@
-import { ICellData, IUnitRangeName, IUniverInstanceService, Nullable } from '@univerjs/core';
+import { ICellData, ISheetDataValidationRule, IUnitRangeName, IUniverInstanceService, Nullable } from '@univerjs/core';
+import { LexerTreeBuilder } from '@univerjs/engine-formula';
+import { ISheetLocationBase } from '@univerjs/sheets';
 export declare function getSheetRangeValueSet(grid: IUnitRangeName, univerInstanceService: IUniverInstanceService, currUnitId: string, currSubUnitId: string): string[];
 export declare function serializeListOptions(options: string[]): string;
 export declare function deserializeListOptions(optionsStr: string): string[];
 export declare function getDataValidationCellValue(cellData: Nullable<ICellData>): string;
+export declare function getTransformedFormula(lexerTreeBuilder: LexerTreeBuilder, rule: ISheetDataValidationRule, position: ISheetLocationBase): {
+    transformedFormula1: string | undefined;
+    transformedFormula2: string | undefined;
+};

package/lib/types/validators/whole-validator.d.ts

@@ -1,7 +1,9 @@
 import { CellValue, IDataValidationRule, IDataValidationRuleBase, Nullable, DataValidationOperator } from '@univerjs/core';
 import { IFormulaResult, IFormulaValidResult, IValidatorCellInfo, BaseDataValidator } from '@univerjs/data-validation';
+import { ISheetLocationBase } from '@univerjs/sheets';
 export declare class WholeValidator extends BaseDataValidator<number> {
-    private _formulaService;
+    private readonly _customFormulaService;
+    private readonly _lexerTreeBuilder;
     id: string;
     title: string;
     operators: DataValidationOperator[];
@@ -20,7 +22,7 @@ export declare class WholeValidator extends BaseDataValidator<number> {
         t: Nullable<import('@univerjs/protocol').CellValueType>;
     };
     private _parseNumber;
-    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<IFormulaResult>;
+    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string, row: number, column: number): Promise<IFormulaResult>;
     validatorFormula(rule: IDataValidationRuleBase, unitId: string, subUnitId: string): IFormulaValidResult;
     validatorIsEqual(cellInfo: IValidatorCellInfo<CellValue>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
     validatorIsNotEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
@@ -30,4 +32,5 @@ export declare class WholeValidator extends BaseDataValidator<number> {
     validatorIsGreaterThanOrEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
     validatorIsLessThan(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
     validatorIsLessThanOrEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;
+    generateRuleErrorMessage(rule: IDataValidationRuleBase, position: ISheetLocationBase): string;
 }