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

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,11 +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<{
-        formula1: number;
-        formula2: number;
-        isFormulaValid: boolean;
-    }>;
+    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>;
@@ -35,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,11 +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<{
-        formula1: number;
-        formula2: number;
-        isFormulaValid: boolean;
-    }>;
+    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>;
@@ -34,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;
 }

package/lib/umd/facade.js

@@ -0,0 +1 @@
+(function(n,s){typeof exports=="object"&&typeof module<"u"?s(exports,require("@univerjs/sheets/facade"),require("@univerjs/sheets-data-validation"),require("@univerjs/core"),require("@univerjs/data-validation"),require("@univerjs/engine-formula"),require("rxjs")):typeof define=="function"&&define.amd?define(["exports","@univerjs/sheets/facade","@univerjs/sheets-data-validation","@univerjs/core","@univerjs/data-validation","@univerjs/engine-formula","rxjs"],s):(n=typeof globalThis<"u"?globalThis:n||self,s(n.UniverSheetsDataValidationFacade={},n.UniverSheetsFacade,n.UniverSheetsDataValidation,n.UniverCore,n.UniverDataValidation,n.UniverEngineFormula,n.rxjs))})(this,function(n,s,r,i,m,g,_){"use strict";var v=Object.defineProperty;var y=(n,s,r)=>s in n?v(n,s,{enumerable:!0,configurable:!0,writable:!0,value:r}):n[s]=r;var h=(n,s,r)=>y(n,typeof s!="symbol"?s+"":s,r);class l{constructor(t){h(this,"_rule");this._rule=t!=null?t:{uid:i.generateRandomId(),ranges:void 0,type:i.DataValidationType.CUSTOM}}build(){return new u(this._rule)}copy(){return new l({...this._rule,uid:i.generateRandomId()})}getAllowInvalid(){return this._rule.errorStyle!==i.DataValidationErrorStyle.STOP}getCriteriaType(){return this._rule.type}getCriteriaValues(){return[this._rule.operator,this._rule.formula1,this._rule.formula2]}getHelpText(){return this._rule.error}requireCheckbox(t,e){return this._rule.type=i.DataValidationType.CHECKBOX,this._rule.formula1=t,this._rule.formula2=e,this}requireDateAfter(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.operator=i.DataValidationOperator.GREATER_THAN,this}requireDateBefore(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.LESS_THAN,this}requireDateBetween(t,e){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=e.toLocaleDateString(),this._rule.operator=i.DataValidationOperator.BETWEEN,this}requireDateEqualTo(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.EQUAL,this}requireDateNotBetween(t,e){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=e.toLocaleDateString(),this._rule.operator=i.DataValidationOperator.NOT_BETWEEN,this}requireDateOnOrAfter(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.GREATER_THAN_OR_EQUAL,this}requireDateOnOrBefore(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.LESS_THAN_OR_EQUAL,this}requireFormulaSatisfied(t){return this._rule.type=i.DataValidationType.CUSTOM,this._rule.formula1=t,this._rule.formula2=void 0,this}requireNumberBetween(t,e,a){return this._rule.formula1=`${t}`,this._rule.formula2=`${e}`,this._rule.operator=i.DataValidationOperator.BETWEEN,this._rule.type=a?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.EQUAL,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberGreaterThan(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.GREATER_THAN,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberGreaterThanOrEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.GREATER_THAN_OR_EQUAL,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberLessThan(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.LESS_THAN,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberLessThanOrEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.LESS_THAN_OR_EQUAL,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberNotBetween(t,e,a){return this._rule.formula1=`${t}`,this._rule.formula2=`${e}`,this._rule.operator=i.DataValidationOperator.NOT_BETWEEN,this._rule.type=a?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberNotEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.NOT_EQUAL,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireValueInList(t,e,a){return this._rule.type=e?i.DataValidationType.LIST_MULTIPLE:i.DataValidationType.LIST,this._rule.formula1=t.join(","),this._rule.formula2=void 0,this._rule.showDropDown=a!=null?a:!0,this}requireValueInRange(t,e,a){return this._rule.type=e?i.DataValidationType.LIST_MULTIPLE:i.DataValidationType.LIST,this._rule.formula1=`=${g.serializeRangeToRefString({unitId:t.getUnitId(),sheetName:t.getSheetName(),range:t.getRange()})}`,this._rule.formula2=void 0,this._rule.showDropDown=a!=null?a:!0,this}setAllowInvalid(t){return this._rule.errorStyle=t?i.DataValidationErrorStyle.WARNING:i.DataValidationErrorStyle.STOP,this}setHelpText(t){return this._rule.error=t,this._rule.showErrorMessage=!0,this}withCriteriaValues(t,e){return this._rule.type=t,this._rule.operator=e[0],this._rule.formula1=e[1],this._rule.formula2=e[2],this}setOptions(t){return Object.assign(this._rule,t),this}}class u{constructor(t,e){h(this,"rule");h(this,"_worksheet");this.rule=t,this._worksheet=e}getAllowInvalid(){return this.rule.errorStyle!==i.DataValidationErrorStyle.STOP}getCriteriaType(){return this.rule.type}getCriteriaValues(){return[this.rule.operator,this.rule.formula1,this.rule.formula2]}getHelpText(){return this.rule.error}copy(){return new l(this.rule)}getApplied(){if(!this._worksheet)return!1;const e=this._worksheet.getInject().get(m.DataValidationModel).getRuleById(this._worksheet.getWorkbook().getUnitId(),this._worksheet.getSheetId(),this.rule.uid);return!!(e&&e.ranges.length)}getRanges(){var o;if(!this.getAllowInvalid())return[];const t=(o=this._worksheet)==null?void 0:o.getWorkbook(),e=this.getSheetId();if(!e)return[];const a=t==null?void 0:t.getSheetBySheetId(e);return!t||!a?[]:this.rule.ranges.map(I=>{var p;return(p=this._worksheet)==null?void 0:p.getInject().createInstance(s.FRange,t,a,I)})}getUnitId(){var t;return(t=this._worksheet)==null?void 0:t.getWorkbook().getUnitId()}getSheetId(){var t;return(t=this._worksheet)==null?void 0:t.getSheetId()}setCriteria(t,e){return this.getApplied()&&!this._worksheet.getInject().get(i.ICommandService).syncExecuteCommand(r.UpdateSheetDataValidationSettingCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,setting:{operator:e[0],formula1:e[1],formula2:e[2],type:this.rule.type}})?!1:(this.rule.operator=e[0],this.rule.formula1=e[1],this.rule.formula2=e[2],this.rule.type=t,!0)}setOptions(t){return this.getApplied()&&!this._worksheet.getInject().get(i.ICommandService).syncExecuteCommand(r.UpdateSheetDataValidationOptionsCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,options:{...m.getRuleOptions(this.rule),...t}})?!1:(Object.assign(this.rule,t),!0)}setRanges(t){return this.getApplied()&&!this._worksheet.getInject().get(i.ICommandService).syncExecuteCommand(r.UpdateSheetDataValidationRangeCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,ranges:t.map(o=>o.getRange())})?!1:(this.rule.ranges=t,!0)}delete(){return this.getApplied()?this._worksheet.getInject().get(i.ICommandService).syncExecuteCommand(r.RemoveSheetDataValidationCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid}):!1}}class f extends s.FRange{async setDataValidation(t){if(!t)return this._commandService.executeCommand(r.ClearRangeDataValidationCommand.id,{unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),ranges:[this._range]}),this;const e={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),rule:{...t.rule,ranges:[this._range]}};return await this._commandService.executeCommand(r.AddSheetDataValidationCommand.id,e),this}getDataValidation(){const e=this._injector.get(r.SheetsDataValidationValidatorService).getDataValidation(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range]);return e&&new u(e)}getDataValidations(){return this._injector.get(r.SheetsDataValidationValidatorService).getDataValidations(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range]).map(e=>new u(e))}async getValidatorStatus(){return this._injector.get(r.SheetsDataValidationValidatorService).validatorRanges(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range])}}s.FRange.extend(f);class D{static newDataValidation(){return new l}}i.FUniver.extend(D);class S extends s.FWorkbook{_initialize(){Object.defineProperty(this,"_dataValidationModel",{get(){return this._injector.get(r.SheetDataValidationModel)}})}getValidatorStatus(){return this._injector.get(r.SheetsDataValidationValidatorService).validatorWorkbook(this._workbook.getUnitId())}onDataValidationChange(t){return i.toDisposable(this._dataValidationModel.ruleChange$.pipe(_.filter(e=>e.unitId===this._workbook.getUnitId())).subscribe(t))}onDataValidationStatusChange(t){return i.toDisposable(this._dataValidationModel.validStatusChange$.pipe(_.filter(e=>e.unitId===this._workbook.getUnitId())).subscribe(t))}onBeforeAddDataValidation(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.AddSheetDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeAddDataValidation")}}))}onBeforeUpdateDataValidationCriteria(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.UpdateSheetDataValidationSettingCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationCriteria")}}))}onBeforeUpdateDataValidationRange(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.UpdateSheetDataValidationRangeCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationRange")}}))}onBeforeUpdateDataValidationOptions(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.UpdateSheetDataValidationOptionsCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationOptions")}}))}onBeforeDeleteDataValidation(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.RemoveSheetDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeDeleteDataValidation")}}))}onBeforeDeleteAllDataValidation(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.RemoveSheetAllDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeDeleteAllDataValidation")}}))}}s.FWorkbook.extend(S);class V extends s.FWorksheet{getDataValidations(){return this._injector.get(m.DataValidationModel).getRules(this._workbook.getUnitId(),this._worksheet.getSheetId()).map(e=>new u(e))}getValidatorStatus(){return this._injector.get(r.SheetsDataValidationValidatorService).validatorWorksheet(this._workbook.getUnitId(),this._worksheet.getSheetId())}}s.FWorksheet.extend(V),n.FDataValidation=u,n.FDataValidationBuilder=l,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})});