@univerjs/sheets-data-validation 0.5.4 → 0.5.5-experimental.20250123-34738ff

package/lib/types/facade/f-data-validation.d.ts

@@ -1,89 +1,209 @@
 import { DataValidationOperator, DataValidationType, IDataValidationRule, IDataValidationRuleOptions, Injector, Worksheet } from '@univerjs/core';
 import { FRange } from '@univerjs/sheets/facade';
 import { FDataValidationBuilder } from './f-data-validation-builder';
+/**
+ * @hideconstructor
+ */
 export declare class FDataValidation {
     rule: IDataValidationRule;
     private _worksheet;
     private _injector;
     constructor(rule: IDataValidationRule, worksheet?: Worksheet, _injector?: Injector);
     /**
-     * Gets whether invalid data is allowed based on the error style value.
-     *
-     * @return true if invalid data is allowed, false otherwise.
+     * Gets whether invalid data is allowed based on the error style value
+     * @returns {boolean} true if invalid data is allowed, false otherwise
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const allowsInvalid = dataValidation.getAllowInvalid();
+     * ```
      */
     getAllowInvalid(): boolean;
     /**
      * Gets the data validation type of the rule
-     *
-     * @returns The data validation type
+     * @returns {DataValidationType | string} The data validation type
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const type = dataValidation.getCriteriaType();
+     * ```
      */
     getCriteriaType(): DataValidationType | string;
     /**
      * Gets the values used for criteria evaluation
-     *
-     * @returns An array containing the operator, formula1, and formula2 values
+     * @returns {[string | undefined, string | undefined, string | undefined]} An array containing the operator, formula1, and formula2 values
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const [operator, formula1, formula2] = dataValidation.getCriteriaValues();
+     * ```
      */
     getCriteriaValues(): [string | undefined, string | undefined, string | undefined];
     /**
      * Gets the help text information, which is used to provide users with guidance and support
-     *
-     * @returns Returns the help text information. If there is no error message, it returns an undefined value.
+     * @returns {string | undefined} Returns the help text information. If there is no error message, it returns an undefined value
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const helpText = dataValidation.getHelpText();
+     * ```
      */
     getHelpText(): string | undefined;
     /**
-     * Creates a new instance of FDataValidationBuilder using the current rule object.
-     * This method is useful for copying an existing data validation rule configuration.
-     *
-     * @return A new FDataValidationBuilder instance with the same rule configuration.
+     * Creates a new instance of FDataValidationBuilder using the current rule object
+     * @returns {FDataValidationBuilder} A new FDataValidationBuilder instance with the same rule configuration
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const builder = dataValidation.copy();
+     * const newRule = builder.setAllowInvalid(true).build();
+     * ```
      */
     copy(): FDataValidationBuilder;
     /**
-     * Gets whether the data validation rule is applied to the worksheet.
-     *
-     * @returns true if the rule is applied, false otherwise.
+     * Gets whether the data validation rule is applied to the worksheet
+     * @returns {boolean} true if the rule is applied, false otherwise
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const isApplied = dataValidation.getApplied();
+     * ```
      */
     getApplied(): boolean;
     /**
-     * Gets the ranges to which the data validation rule is applied.
-     *
-     * @returns An array of IRange objects representing the ranges to which the data validation rule is applied.
+     * Gets the ranges to which the data validation rule is applied
+     * @returns {FRange[]} An array of FRange objects representing the ranges to which the data validation rule is applied
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const ranges = dataValidation.getRanges();
+     * ```
      */
     getRanges(): FRange[];
     /**
-     * Gets the title of the error message dialog box.
-     *
-     * @returns The title of the error message dialog box.
+     * Gets the unit ID of the worksheet
+     * @returns {string | undefined} The unit ID of the worksheet
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const unitId = dataValidation.getUnitId();
+     * ```
      */
     getUnitId(): string | undefined;
     /**
-     * Gets the sheetId of the worksheet.
-     *
-     * @returns The sheetId of the worksheet.
+     * Gets the sheet ID of the worksheet
+     * @returns {string | undefined} The sheet ID of the worksheet
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const sheetId = dataValidation.getSheetId();
+     * ```
      */
     getSheetId(): string | undefined;
     /**
-     * Set Criteria for the data validation rule.
-     * @param type The type of data validation criteria.
-     * @param values An array containing the operator, formula1, and formula2 values.
-     * @returns true if the criteria is set successfully, false otherwise.
+     * Set Criteria for the data validation rule
+     * @param {DataValidationType} type - The type of data validation criteria
+     * @param {[DataValidationOperator, string, string]} values - An array containing the operator, formula1, and formula2 values
+     * @param {boolean} [allowBlank] - Whether to allow blank values
+     * @returns {FDataValidation} The current instance for method chaining
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * dataValidation.setCriteria(
+     *   DataValidationType.DECIMAL,
+     *   [DataValidationOperator.BETWEEN, '1', '10'],
+     *   true
+     * );
+     * ```
      */
     setCriteria(type: DataValidationType, values: [DataValidationOperator, string, string], allowBlank?: boolean): FDataValidation;
     /**
-     * Set the options for the data validation rule.
-     * For details of options, please refer to https://univer.ai/typedoc/@univerjs/core/interfaces/IDataValidationRuleOptions
-     * @param options An object containing the options to set. `IDataValidationRuleOptions`
-     * @returns true if the options are set successfully, false otherwise.
+     * Set the options for the data validation rule
+     * @param {Partial<IDataValidationRuleOptions>} options - The options to set for the data validation rule
+     * @returns {FDataValidation} The current instance for method chaining
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * dataValidation.setOptions({
+     *   allowBlank: true,
+     *   showErrorMessage: true,
+     *   error: 'Please enter a valid value'
+     * });
+     * ```
      */
     setOptions(options: Partial<IDataValidationRuleOptions>): FDataValidation;
     /**
-     * Set the ranges to the data validation rule.
-     * @param ranges new ranges array.
-     * @returns true if the ranges are set successfully, false otherwise.
+     * Set the ranges to the data validation rule
+     * @param {FRange[]} ranges - New ranges array
+     * @returns {FDataValidation} The current instance for method chaining
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const range = FRange.create('Sheet1', 'A1:B10');
+     * dataValidation.setRanges([range]);
+     * ```
      */
     setRanges(ranges: FRange[]): FDataValidation;
     /**
-     * Delete the data validation rule from the worksheet.
-     * @returns true if the rule is deleted successfully, false otherwise.
+     * Delete the data validation rule from the worksheet
+     * @returns {boolean} true if the rule is deleted successfully, false otherwise
+     * @example
+     * ```typescript
+     * const dataValidation = univerAPI
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
+     * const isDeleted = dataValidation.delete();
+     * ```
      */
     delete(): boolean;
 }

package/lib/types/facade/f-event.d.ts

@@ -132,6 +132,9 @@ export interface IBeforeSheetDataValidationDeleteAllEvent extends IEventBase {
     /** Array of all validation rules to be deleted */
     rules: FDataValidation[];
 }
+/**
+ * @ignore
+ */
 export interface IDataValidationEventParamConfig {
     SheetDataValidationChanged: ISheetDataValidationChangedEvent;
     SheetDataValidatorStatusChanged: ISheetDataValidatorStatusChangedEvent;
@@ -142,6 +145,9 @@ export interface IDataValidationEventParamConfig {
     BeforeSheetDataValidationRangeUpdate: IBeforeSheetDataValidationRangeUpdateEvent;
     BeforeSheetDataValidationOptionsUpdate: IBeforeSheetDataValidationOptionsUpdateEvent;
 }
+/**
+ * @ignore
+ */
 interface IDataValidationEvent {
     /**
      * Event fired when a rule is added, deleted, or modified
@@ -240,6 +246,9 @@ interface IDataValidationEvent {
      */
     readonly BeforeSheetDataValidationOptionsUpdate: 'BeforeSheetDataValidationOptionsUpdate';
 }
+/**
+ * @ignore
+ */
 export declare class FDataValidationEvent implements IDataValidationEvent {
     get SheetDataValidationChanged(): 'SheetDataValidationChanged';
     get SheetDataValidatorStatusChanged(): 'SheetDataValidatorStatusChanged';
@@ -250,6 +259,9 @@ export declare class FDataValidationEvent implements IDataValidationEvent {
     get BeforeSheetDataValidationRangeUpdate(): 'BeforeSheetDataValidationRangeUpdate';
     get BeforeSheetDataValidationOptionsUpdate(): 'BeforeSheetDataValidationOptionsUpdate';
 }
+/**
+ * @ignore
+ */
 export interface IDataValidationEventConfig {
     SheetDataValidationChanged: ISheetDataValidationChangedEvent;
     SheetDataValidatorStatusChanged: ISheetDataValidatorStatusChangedEvent;

package/lib/types/facade/f-range.d.ts

@@ -1,30 +1,63 @@
 import { DataValidationStatus, Nullable } from '@univerjs/core';
 import { FRange } from '@univerjs/sheets/facade';
 import { FDataValidation } from './f-data-validation';
+/**
+ * @ignore
+ */
 export interface IFRangeDataValidationMixin {
     /**
-     * Set a data validation rule to current range.
-     * @param rule data validation rule, build by `FUniver.newDataValidation`
+     * Set a data validation rule to current range. if rule is null, clear data validation rule.
+     * @param {Nullable<FDataValidation>} rule data validation rule, build by `FUniver.newDataValidation`
      * @returns current range
+     * @example
+     * ```ts
+     * const rule = FUniver.newDataValidation().requireValueInRange(range).build();
+     * cell.setDataValidation(rule);
+     * ```
      */
-    setDataValidation(this: FRange, rule: Nullable<FDataValidation>): FRange;
+    setDataValidation(rule: Nullable<FDataValidation>): FRange;
     /**
      * Get first data validation rule in current range.
-     * @returns data validation rule
+     * @returns {Nullable<FDataValidation>} data validation rule
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const dataValidation = worksheet.getActiveRange().getDataValidation();
+     * ```
      */
-    getDataValidation(this: FRange): Nullable<FDataValidation>;
+    getDataValidation(): Nullable<FDataValidation>;
     /**
      * Get all data validation rules in current range.
-     * @returns all data validation rules
+     * @returns {FDataValidation[]} all data validation rules
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const dataValidations = worksheet.getActiveRange().getDataValidations();
+     * ```
+     */
+    getDataValidations(): FDataValidation[];
+    /**
+     * Get data validation validator status for current range.
+     * @returns {Promise<DataValidationStatus[][]>} matrix of validator status
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const validatorStatus = worksheet.getActiveRange().getValidatorStatus();
+     * ```
      */
-    getDataValidations(this: FRange): FDataValidation[];
-    getValidatorStatus(): Promise<Promise<DataValidationStatus>[][]>;
+    getValidatorStatus(): Promise<DataValidationStatus[][]>;
 }
+/**
+ * @ignore
+ */
 export declare class FRangeDataValidationMixin extends FRange implements IFRangeDataValidationMixin {
     setDataValidation(rule: Nullable<FDataValidation>): FRange;
     getDataValidation(): Nullable<FDataValidation>;
     getDataValidations(): FDataValidation[];
-    getValidatorStatus(): Promise<Promise<DataValidationStatus>[][]>;
+    getValidatorStatus(): Promise<DataValidationStatus[][]>;
 }
 declare module '@univerjs/sheets/facade' {
     interface FRange extends IFRangeDataValidationMixin {

package/lib/types/facade/f-univer.d.ts

@@ -1,16 +1,43 @@
 import { Injector, FUniver } from '@univerjs/core';
 import { FDataValidationBuilder } from './f-data-validation-builder';
-export declare class FUnvierDataValidationMixin extends FUniver {
+/**
+ * @ignore
+ */
+export interface IFUnvierDataValidationMixin {
     /**
+     * Creates a new instance of FDataValidationBuilder
+     * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
+     * @example
+     * ```ts
+     * const rule = FUnvier.newDataValidation();
+     * cell.setDataValidation(rule.requireValueInRange(range));
+     * ```
+     */
+    newDataValidation(): FDataValidationBuilder;
+}
+export declare class FUnvierDataValidationMixin extends FUniver implements IFUnvierDataValidationMixin {
     /**
-     * @deparecated use `univerAPI.newDataValidation()` as instead.
+     * @deprecated use `univerAPI.newDataValidation()` as instead.
+     * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
      */
     static newDataValidation(): FDataValidationBuilder;
     newDataValidation(): FDataValidationBuilder;
+    /**
+     * @ignore
+     */
     _initialize(injector: Injector): void;
 }
 declare module '@univerjs/core' {
+    /**
+     * @ignore
+     */
     namespace FUniver {
+        /**
+         * @deprecated use `univerAPI.newDataValidation()` as instead.
+         * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
+         */
         function newDataValidation(): FDataValidationBuilder;
     }
+    interface FUniver extends IFUnvierDataValidationMixin {
+    }
 }

package/lib/types/facade/f-workbook.d.ts

@@ -2,6 +2,9 @@ import { IRuleChange } from '@univerjs/data-validation';
 import { IAddSheetDataValidationCommandParams, IRemoveSheetAllDataValidationCommandParams, IRemoveSheetDataValidationCommandParams, IUpdateSheetDataValidationOptionsCommandParams, IUpdateSheetDataValidationRangeCommandParams, IUpdateSheetDataValidationSettingCommandParams, IValidStatusChange, SheetDataValidationModel } from '@univerjs/sheets-data-validation';
 import { DataValidationStatus, IDisposable, IExecutionOptions, Nullable, ObjectMatrix } from '@univerjs/core';
 import { FWorkbook } from '@univerjs/sheets/facade';
+/**
+ * @ignore
+ */
 export interface IFWorkbookDataValidationMixin {
     /**
      * Get data validation validator status for current workbook.
@@ -13,54 +16,41 @@ export interface IFWorkbookDataValidationMixin {
      */
     getValidatorStatus(this: FWorkbook): Promise<Record<string, ObjectMatrix<Nullable<DataValidationStatus>>>>;
     /**
-     * The onDataValidationChange event is fired when the data validation rule of this sheet is changed.
-     * @param {function(IRuleChange): void} callback - Callback function that will be called when the event is fired
-     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.SheetDataValidationChanged, (event) => { ... })` instead
      */
     onDataValidationChange(callback: (ruleChange: IRuleChange) => void): IDisposable;
     /**
-     * The onDataValidationStatusChange event is fired when the data validation status of this sheet is changed.
-     * @param {function(IValidStatusChange): void} callback - Callback function that will be called when the event is fired
-     * @returns {IDisposable}  A disposable object that can be used to unsubscribe from the event
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.SheetDataValidatorStatusChanged, (event) => { ... })` instead
      */
     onDataValidationStatusChange(callback: (statusChange: IValidStatusChange) => void): IDisposable;
     /**
-     * The onBeforeAddDataValidation event is fired before the data validation rule is added.
-     * @param {function(IAddSheetDataValidationCommandParams, IExecutionOptions | undefined): void | false} callback - Callback function that will be called when the event is fired
-     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationAdd, (event) => { ... })` instead
      */
     onBeforeAddDataValidation(this: FWorkbook, callback: (params: IAddSheetDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
     /**
-     * The onBeforeUpdateDataValidationCriteria event is fired before the data validation rule is updated.
-     * @param callback - Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationCriteriaUpdate, (event) => { ... })` instead
      */
     onBeforeUpdateDataValidationCriteria(this: FWorkbook, callback: (params: IUpdateSheetDataValidationSettingCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
     /**
-     * The onBeforeUpdateDataValidationRange event is fired before the data validation rule is updated.
-     * @param callback - Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationRangeUpdate, (event) => { ... })` instead
      */
     onBeforeUpdateDataValidationRange(this: FWorkbook, callback: (params: IUpdateSheetDataValidationRangeCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
     /**
-     * The onBeforeUpdateDataValidationOptions event is fired before the data validation rule is updated.
-     * @param callback - Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationOptionsUpdate, (event) => { ... })` instead
      */
     onBeforeUpdateDataValidationOptions(this: FWorkbook, callback: (params: IUpdateSheetDataValidationOptionsCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
     /**
-     * The onBeforeDeleteDataValidation event is fired before the data validation rule is deleted.
-     * @param callback - Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationDelete, (event) => { ... })` instead
      */
     onBeforeDeleteDataValidation(this: FWorkbook, callback: (params: IRemoveSheetDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
     /**
-     * The onBeforeDeleteAllDataValidation event is fired before delete all data validation rules.
-     * @param callback - Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationDeleteAll, (event) => { ... })` instead
      */
     onBeforeDeleteAllDataValidation(this: FWorkbook, callback: (params: IRemoveSheetAllDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
 }
+/**
+ * @ignore
+ */
 export declare class FWorkbookDataValidationMixin extends FWorkbook implements IFWorkbookDataValidationMixin {
     _dataValidationModel: SheetDataValidationModel;
     _initialize(): void;

package/lib/types/facade/f-worksheet.d.ts

@@ -1,10 +1,13 @@
 import { DataValidationStatus, Nullable, ObjectMatrix } from '@univerjs/core';
 import { FWorksheet } from '@univerjs/sheets/facade';
 import { FDataValidation } from './f-data-validation';
+/**
+ * @ignore
+ */
 export interface IFWorksheetDataValidationMixin {
     /**
      * Get all data validation rules in current sheet.
-     * @returns all data validation rules
+     * @returns {FDataValidation[]} all data validation rules
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
      * const worksheet = workbook.getWorksheet('sheet1');
@@ -12,20 +15,24 @@ export interface IFWorksheetDataValidationMixin {
      * ```
      */
     getDataValidations(): FDataValidation[];
+    /**
+     * @deprecated use `getValidatorStatusAsync` instead
+     */
+    getValidatorStatus(): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;
     /**
      * Get data validation validator status for current sheet.
-     * @returns matrix of validator status
+     * @returns {Promise<ObjectMatrix<Nullable<DataValidationStatus>>>} matrix of validator status
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
      * const worksheet = workbook.getWorksheet('sheet1');
      * const validatorStatus = worksheet.getValidatorStatus();
      * ```
      */
-    getValidatorStatus(): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;
+    getValidatorStatusAsync(): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;
     /**
      * get data validation rule by rule id
      * @param ruleId - the rule id
-     * @returns data validation rule
+     * @returns {Nullable<FDataValidation>} data validation rule
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
      * const worksheet = workbook.getWorksheet('sheet1');
@@ -34,9 +41,13 @@ export interface IFWorksheetDataValidationMixin {
      */
     getDataValidation(ruleId: string): Nullable<FDataValidation>;
 }
+/**
+ * @ignore
+ */
 export declare class FWorksheetDataValidationMixin extends FWorksheet implements IFWorksheetDataValidationMixin {
     getDataValidations(): FDataValidation[];
     getValidatorStatus(): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;
+    getValidatorStatusAsync(): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;
     getDataValidation(ruleId: string): Nullable<FDataValidation>;
 }
 declare module '@univerjs/sheets/facade' {

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

@@ -10,7 +10,7 @@ export declare class SheetsDataValidationValidatorService extends Disposable {
     private _initRecalculate;
     private _validatorByCell;
     validatorCell(unitId: string, subUnitId: string, row: number, col: number): Promise<DataValidationStatus>;
-    validatorRanges(unitId: string, subUnitId: string, ranges: IRange[]): Promise<Promise<DataValidationStatus>[][]>;
+    validatorRanges(unitId: string, subUnitId: string, ranges: IRange[]): Promise<DataValidationStatus[][]>;
     validatorWorksheet(unitId: string, subUnitId: string): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;
     validatorWorkbook(unitId: string): Promise<Record<string, ObjectMatrix<Nullable<DataValidationStatus>>>>;
     getDataValidations(unitId: string, subUnitId: string, ranges: IRange[]): IDataValidationRule[];

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

@@ -6,6 +6,7 @@ export declare class CustomFormulaValidator extends BaseDataValidator {
     operators: DataValidationOperator[];
     scopes: string | string[];
     private readonly _customFormulaService;
+    private readonly _lexerTreeBuilder;
     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/umd/facade.js

@@ -1 +1 @@
-(function(u,i){typeof exports=="object"&&typeof module<"u"?i(exports,require("@univerjs/sheets-data-validation"),require("@univerjs/sheets/facade"),require("@univerjs/core"),require("@univerjs/data-validation"),require("@univerjs/engine-formula"),require("rxjs")):typeof define=="function"&&define.amd?define(["exports","@univerjs/sheets-data-validation","@univerjs/sheets/facade","@univerjs/core","@univerjs/data-validation","@univerjs/engine-formula","rxjs"],i):(u=typeof globalThis<"u"?globalThis:u||self,i(u.UniverSheetsDataValidationFacade={},u.UniverSheetsDataValidation,u.UniverSheetsFacade,u.UniverCore,u.UniverDataValidation,u.UniverEngineFormula,u.rxjs))})(this,function(u,i,m,a,D,v,E){"use strict";var U=Object.defineProperty;var A=(u,i,m)=>i in u?U(u,i,{enumerable:!0,configurable:!0,writable:!0,value:m}):u[i]=m;var S=(u,i,m)=>A(u,typeof i!="symbol"?i+"":i,m);class _{constructor(t){S(this,"_rule");this._rule=t!=null?t:{uid:a.generateRandomId(),ranges:void 0,type:a.DataValidationType.CUSTOM}}build(){return new g(this._rule)}copy(){return new _({...this._rule,uid:a.generateRandomId()})}getAllowInvalid(){return this._rule.errorStyle!==a.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=a.DataValidationType.CHECKBOX,this._rule.formula1=t,this._rule.formula2=e,this}requireDateAfter(t){return this._rule.type=a.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.operator=a.DataValidationOperator.GREATER_THAN,this}requireDateBefore(t){return this._rule.type=a.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.LESS_THAN,this}requireDateBetween(t,e){return this._rule.type=a.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=e.toLocaleDateString(),this._rule.operator=a.DataValidationOperator.BETWEEN,this}requireDateEqualTo(t){return this._rule.type=a.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.EQUAL,this}requireDateNotBetween(t,e){return this._rule.type=a.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=e.toLocaleDateString(),this._rule.operator=a.DataValidationOperator.NOT_BETWEEN,this}requireDateOnOrAfter(t){return this._rule.type=a.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.GREATER_THAN_OR_EQUAL,this}requireDateOnOrBefore(t){return this._rule.type=a.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.LESS_THAN_OR_EQUAL,this}requireFormulaSatisfied(t){return this._rule.type=a.DataValidationType.CUSTOM,this._rule.formula1=t,this._rule.formula2=void 0,this}requireNumberBetween(t,e,r){return this._rule.formula1=`${t}`,this._rule.formula2=`${e}`,this._rule.operator=a.DataValidationOperator.BETWEEN,this._rule.type=r?a.DataValidationType.WHOLE:a.DataValidationType.DECIMAL,this}requireNumberEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.EQUAL,this._rule.type=e?a.DataValidationType.WHOLE:a.DataValidationType.DECIMAL,this}requireNumberGreaterThan(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.GREATER_THAN,this._rule.type=e?a.DataValidationType.WHOLE:a.DataValidationType.DECIMAL,this}requireNumberGreaterThanOrEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.GREATER_THAN_OR_EQUAL,this._rule.type=e?a.DataValidationType.WHOLE:a.DataValidationType.DECIMAL,this}requireNumberLessThan(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.LESS_THAN,this._rule.type=e?a.DataValidationType.WHOLE:a.DataValidationType.DECIMAL,this}requireNumberLessThanOrEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.LESS_THAN_OR_EQUAL,this._rule.type=e?a.DataValidationType.WHOLE:a.DataValidationType.DECIMAL,this}requireNumberNotBetween(t,e,r){return this._rule.formula1=`${t}`,this._rule.formula2=`${e}`,this._rule.operator=a.DataValidationOperator.NOT_BETWEEN,this._rule.type=r?a.DataValidationType.WHOLE:a.DataValidationType.DECIMAL,this}requireNumberNotEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=a.DataValidationOperator.NOT_EQUAL,this._rule.type=e?a.DataValidationType.WHOLE:a.DataValidationType.DECIMAL,this}requireValueInList(t,e,r){return this._rule.type=e?a.DataValidationType.LIST_MULTIPLE:a.DataValidationType.LIST,this._rule.formula1=t.join(","),this._rule.formula2=void 0,this._rule.showDropDown=r!=null?r:!0,this}requireValueInRange(t,e,r){return this._rule.type=e?a.DataValidationType.LIST_MULTIPLE:a.DataValidationType.LIST,this._rule.formula1=`=${v.serializeRangeToRefString({unitId:t.getUnitId(),sheetName:t.getSheetName(),range:t.getRange()})}`,this._rule.formula2=void 0,this._rule.showDropDown=r!=null?r:!0,this}setAllowInvalid(t){return this._rule.errorStyle=t?a.DataValidationErrorStyle.WARNING:a.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}setAllowBlank(t){return this._rule.allowBlank=t,this}setOptions(t){return Object.assign(this._rule,t),this}}class g{constructor(t,e,r){S(this,"rule");S(this,"_worksheet");S(this,"_injector");this._injector=r,this.rule=t,this._worksheet=e}getAllowInvalid(){return this.rule.errorStyle!==a.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 _(this.rule)}getApplied(){if(!this._worksheet)return!1;const e=this._injector.get(D.DataValidationModel).getRuleById(this._worksheet.getUnitId(),this._worksheet.getSheetId(),this.rule.uid);return!!(e&&e.ranges.length)}getRanges(){if(!this.getApplied())return[];const t=this._injector.get(a.IUniverInstanceService).getUnit(this._worksheet.getUnitId());return this.rule.ranges.map(e=>this._injector.createInstance(m.FRange,t,this._worksheet,e))}getUnitId(){var t;return(t=this._worksheet)==null?void 0:t.getUnitId()}getSheetId(){var t;return(t=this._worksheet)==null?void 0:t.getSheetId()}setCriteria(t,e,r=!0){if(this.getApplied()&&!this._injector.get(a.ICommandService).syncExecuteCommand(i.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,allowBlank:r}}))throw new Error("setCriteria failed");return this.rule.operator=e[0],this.rule.formula1=e[1],this.rule.formula2=e[2],this.rule.type=t,this.rule.allowBlank=r,this}setOptions(t){if(this.getApplied()&&!this._injector.get(a.ICommandService).syncExecuteCommand(i.UpdateSheetDataValidationOptionsCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,options:{...D.getRuleOptions(this.rule),...t}}))throw new Error("setOptions failed");return Object.assign(this.rule,t),this}setRanges(t){if(this.getApplied()&&!this._injector.get(a.ICommandService).syncExecuteCommand(i.UpdateSheetDataValidationRangeCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,ranges:t.map(o=>o.getRange())}))throw new Error("setRanges failed");return this.rule.ranges=t.map(e=>e.getRange()),this}delete(){return this.getApplied()?this._injector.get(a.ICommandService).syncExecuteCommand(i.RemoveSheetDataValidationCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid}):!1}}class w extends m.FRange{setDataValidation(t){if(!t)return this._commandService.syncExecuteCommand(i.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 this._commandService.syncExecuteCommand(i.AddSheetDataValidationCommand.id,e),this}getDataValidation(){const e=this._injector.get(i.SheetsDataValidationValidatorService).getDataValidation(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range]);return e&&new g(e,this._worksheet,this._injector)}getDataValidations(){return this._injector.get(i.SheetsDataValidationValidatorService).getDataValidations(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range]).map(e=>new g(e,this._worksheet,this._injector))}async getValidatorStatus(){return this._injector.get(i.SheetsDataValidationValidatorService).validatorRanges(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range])}}m.FRange.extend(w);class T extends a.FUniver{static newDataValidation(){return new _}newDataValidation(){return new _}_initialize(t){if(!t.has(i.SheetDataValidationModel))return;const e=t.get(i.SheetDataValidationModel),r=t.get(a.ICommandService);this.disposeWithMe(e.ruleChange$.subscribe(o=>{const{unitId:n,subUnitId:s,rule:p,oldRule:d,type:l}=o,h=this.getSheetTarget(n,s);if(!h)return;const{workbook:c,worksheet:V}=h,I=new g(p,V.getSheet(),this._injector);this.fireEvent(this.Event.SheetDataValidationChanged,{origin:o,worksheet:V,workbook:c,changeType:l,oldRule:d,rule:I})})),this.disposeWithMe(e.validStatusChange$.subscribe(o=>{const{unitId:n,subUnitId:s,ruleId:p,status:d,row:l,col:h}=o,c=this.getSheetTarget(n,s);if(!c)return;const{workbook:V,worksheet:I}=c,k=I.getDataValidation(p);k&&this.fireEvent(this.Event.SheetDataValidatorStatusChanged,{workbook:V,worksheet:I,row:l,column:h,rule:k,status:d})})),this.disposeWithMe(r.beforeCommandExecuted(o=>{switch(o.id){case i.AddSheetDataValidationCommand.id:{const n=o.params,s=this.getSheetTarget(n.unitId,n.subUnitId);if(!s)return;const{workbook:p,worksheet:d}=s,l={worksheet:d,workbook:p,rule:n.rule};if(this.fireEvent(this.Event.BeforeSheetDataValidationAdd,l),l.cancel)throw new a.CanceledError;break}case i.UpdateSheetDataValidationSettingCommand.id:{const n=o.params,s=this.getSheetTarget(n.unitId,n.subUnitId);if(!s)return;const{workbook:p,worksheet:d}=s,l=d.getDataValidation(n.ruleId);if(!l)return;const h={worksheet:d,workbook:p,rule:l,ruleId:n.ruleId,newCriteria:n.setting};if(this.fireEvent(this.Event.BeforeSheetDataValidationCriteriaUpdate,h),h.cancel)throw new a.CanceledError;break}case i.UpdateSheetDataValidationRangeCommand.id:{const n=o.params,s=this.getSheetTarget(n.unitId,n.subUnitId);if(!s)return;const{workbook:p,worksheet:d}=s,l=d.getDataValidation(n.ruleId);if(!l)return;const h={worksheet:d,workbook:p,rule:l,ruleId:n.ruleId,newRanges:n.ranges};if(this.fireEvent(this.Event.BeforeSheetDataValidationRangeUpdate,h),h.cancel)throw new a.CanceledError;break}case i.UpdateSheetDataValidationOptionsCommand.id:{const n=o.params,s=this.getSheetTarget(n.unitId,n.subUnitId);if(!s)return;const{workbook:p,worksheet:d}=s,l=d.getDataValidation(n.ruleId);if(!l)return;const h={worksheet:d,workbook:p,rule:l,ruleId:n.ruleId,newOptions:n.options};if(this.fireEvent(this.Event.BeforeSheetDataValidationOptionsUpdate,h),h.cancel)throw new a.CanceledError;break}case i.RemoveSheetDataValidationCommand.id:{const n=o.params,s=this.getSheetTarget(n.unitId,n.subUnitId);if(!s)return;const{workbook:p,worksheet:d}=s,l=d.getDataValidation(n.ruleId);if(!l)return;const h={worksheet:d,workbook:p,rule:l,ruleId:n.ruleId};if(this.fireEvent(this.Event.BeforeSheetDataValidationDelete,h),h.cancel)throw new a.CanceledError;break}case i.RemoveSheetAllDataValidationCommand.id:{const n=o.params,s=this.getSheetTarget(n.unitId,n.subUnitId);if(!s)return;const{workbook:p,worksheet:d}=s,l={worksheet:d,workbook:p,rules:d.getDataValidations()};if(this.fireEvent(this.Event.BeforeSheetDataValidationDeleteAll,l),l.cancel)throw new a.CanceledError;break}}}))}}a.FUniver.extend(T);class b extends m.FWorkbook{_initialize(){Object.defineProperty(this,"_dataValidationModel",{get(){return this._injector.get(i.SheetDataValidationModel)}})}getValidatorStatus(){return this._injector.get(i.SheetsDataValidationValidatorService).validatorWorkbook(this._workbook.getUnitId())}onDataValidationChange(t){return a.toDisposable(this._dataValidationModel.ruleChange$.pipe(E.filter(e=>e.unitId===this._workbook.getUnitId())).subscribe(t))}onDataValidationStatusChange(t){return a.toDisposable(this._dataValidationModel.validStatusChange$.pipe(E.filter(e=>e.unitId===this._workbook.getUnitId())).subscribe(t))}onBeforeAddDataValidation(t){return a.toDisposable(this._commandService.beforeCommandExecuted((e,r)=>{const o=e.params;if(e.id===i.AddSheetDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,r)===!1)throw new Error("Command is stopped by the hook onBeforeAddDataValidation")}}))}onBeforeUpdateDataValidationCriteria(t){return a.toDisposable(this._commandService.beforeCommandExecuted((e,r)=>{const o=e.params;if(e.id===i.UpdateSheetDataValidationSettingCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,r)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationCriteria")}}))}onBeforeUpdateDataValidationRange(t){return a.toDisposable(this._commandService.beforeCommandExecuted((e,r)=>{const o=e.params;if(e.id===i.UpdateSheetDataValidationRangeCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,r)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationRange")}}))}onBeforeUpdateDataValidationOptions(t){return a.toDisposable(this._commandService.beforeCommandExecuted((e,r)=>{const o=e.params;if(e.id===i.UpdateSheetDataValidationOptionsCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,r)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationOptions")}}))}onBeforeDeleteDataValidation(t){return a.toDisposable(this._commandService.beforeCommandExecuted((e,r)=>{const o=e.params;if(e.id===i.RemoveSheetDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,r)===!1)throw new Error("Command is stopped by the hook onBeforeDeleteDataValidation")}}))}onBeforeDeleteAllDataValidation(t){return a.toDisposable(this._commandService.beforeCommandExecuted((e,r)=>{const o=e.params;if(e.id===i.RemoveSheetAllDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,r)===!1)throw new Error("Command is stopped by the hook onBeforeDeleteAllDataValidation")}}))}}m.FWorkbook.extend(b);class y extends m.FWorksheet{getDataValidations(){return this._injector.get(D.DataValidationModel).getRules(this._workbook.getUnitId(),this._worksheet.getSheetId()).map(e=>new g(e,this._worksheet,this._injector))}getValidatorStatus(){return this._injector.get(i.SheetsDataValidationValidatorService).validatorWorksheet(this._workbook.getUnitId(),this._worksheet.getSheetId())}getDataValidation(t){const r=this._injector.get(D.DataValidationModel).getRuleById(this._workbook.getUnitId(),this._worksheet.getSheetId(),t);return r?new g(r,this._worksheet,this._injector):null}}m.FWorksheet.extend(y);class C{get SheetDataValidationChanged(){return"SheetDataValidationChanged"}get SheetDataValidatorStatusChanged(){return"SheetDataValidatorStatusChanged"}get BeforeSheetDataValidationAdd(){return"BeforeSheetDataValidationAdd"}get BeforeSheetDataValidationDelete(){return"BeforeSheetDataValidationDelete"}get BeforeSheetDataValidationDeleteAll(){return"BeforeSheetDataValidationDeleteAll"}get BeforeSheetDataValidationCriteriaUpdate(){return"BeforeSheetDataValidationCriteriaUpdate"}get BeforeSheetDataValidationRangeUpdate(){return"BeforeSheetDataValidationRangeUpdate"}get BeforeSheetDataValidationOptionsUpdate(){return"BeforeSheetDataValidationOptionsUpdate"}}a.FEventName.extend(C),u.FDataValidation=g,u.FDataValidationBuilder=_,Object.defineProperty(u,Symbol.toStringTag,{value:"Module"})});
+(function(global,factory){typeof exports=="object"&&typeof module<"u"?factory(exports,require("@univerjs/sheets-data-validation"),require("@univerjs/sheets/facade"),require("@univerjs/core"),require("@univerjs/data-validation"),require("@univerjs/engine-formula"),require("rxjs")):typeof define=="function"&&define.amd?define(["exports","@univerjs/sheets-data-validation","@univerjs/sheets/facade","@univerjs/core","@univerjs/data-validation","@univerjs/engine-formula","rxjs"],factory):(global=typeof globalThis<"u"?globalThis:global||self,factory(global.UniverSheetsDataValidationFacade={},global.UniverSheetsDataValidation,global.UniverSheetsFacade,global.UniverCore,global.UniverDataValidation,global.UniverEngineFormula,global.rxjs))})(this,function(exports2,sheetsDataValidation,facade,core,dataValidation,engineFormula,rxjs){"use strict";var __defProp=Object.defineProperty;var __defNormalProp=(obj,key,value)=>key in obj?__defProp(obj,key,{enumerable:!0,configurable:!0,writable:!0,value}):obj[key]=value;var __name=(target,value)=>__defProp(target,"name",{value,configurable:!0});var __publicField=(obj,key,value)=>__defNormalProp(obj,typeof key!="symbol"?key+"":key,value);const _FDataValidationBuilder=class _FDataValidationBuilder{constructor(rule){__publicField(this,"_rule");this._rule=rule!=null?rule:{uid:core.generateRandomId(),ranges:void 0,type:core.DataValidationType.CUSTOM}}build(){return new FDataValidation(this._rule)}copy(){return new _FDataValidationBuilder({...this._rule,uid:core.generateRandomId()})}getAllowInvalid(){return this._rule.errorStyle!==core.DataValidationErrorStyle.STOP}getCriteriaType(){return this._rule.type}getCriteriaValues(){return[this._rule.operator,this._rule.formula1,this._rule.formula2]}getHelpText(){return this._rule.error}requireCheckbox(checkedValue,uncheckedValue){return this._rule.type=core.DataValidationType.CHECKBOX,this._rule.formula1=checkedValue,this._rule.formula2=uncheckedValue,this}requireDateAfter(date){return this._rule.type=core.DataValidationType.DATE,this._rule.formula1=date.toLocaleDateString(),this._rule.operator=core.DataValidationOperator.GREATER_THAN,this}requireDateBefore(date){return this._rule.type=core.DataValidationType.DATE,this._rule.formula1=date.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.LESS_THAN,this}requireDateBetween(start,end){return this._rule.type=core.DataValidationType.DATE,this._rule.formula1=start.toLocaleDateString(),this._rule.formula2=end.toLocaleDateString(),this._rule.operator=core.DataValidationOperator.BETWEEN,this}requireDateEqualTo(date){return this._rule.type=core.DataValidationType.DATE,this._rule.formula1=date.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.EQUAL,this}requireDateNotBetween(start,end){return this._rule.type=core.DataValidationType.DATE,this._rule.formula1=start.toLocaleDateString(),this._rule.formula2=end.toLocaleDateString(),this._rule.operator=core.DataValidationOperator.NOT_BETWEEN,this}requireDateOnOrAfter(date){return this._rule.type=core.DataValidationType.DATE,this._rule.formula1=date.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.GREATER_THAN_OR_EQUAL,this}requireDateOnOrBefore(date){return this._rule.type=core.DataValidationType.DATE,this._rule.formula1=date.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.LESS_THAN_OR_EQUAL,this}requireFormulaSatisfied(formula){return this._rule.type=core.DataValidationType.CUSTOM,this._rule.formula1=formula,this._rule.formula2=void 0,this}requireNumberBetween(start,end,isInteger){return this._rule.formula1=`${start}`,this._rule.formula2=`${end}`,this._rule.operator=core.DataValidationOperator.BETWEEN,this._rule.type=isInteger?core.DataValidationType.WHOLE:core.DataValidationType.DECIMAL,this}requireNumberEqualTo(num,isInteger){return this._rule.formula1=`${num}`,this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.EQUAL,this._rule.type=isInteger?core.DataValidationType.WHOLE:core.DataValidationType.DECIMAL,this}requireNumberGreaterThan(num,isInteger){return this._rule.formula1=`${num}`,this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.GREATER_THAN,this._rule.type=isInteger?core.DataValidationType.WHOLE:core.DataValidationType.DECIMAL,this}requireNumberGreaterThanOrEqualTo(num,isInteger){return this._rule.formula1=`${num}`,this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.GREATER_THAN_OR_EQUAL,this._rule.type=isInteger?core.DataValidationType.WHOLE:core.DataValidationType.DECIMAL,this}requireNumberLessThan(num,isInteger){return this._rule.formula1=`${num}`,this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.LESS_THAN,this._rule.type=isInteger?core.DataValidationType.WHOLE:core.DataValidationType.DECIMAL,this}requireNumberLessThanOrEqualTo(num,isInteger){return this._rule.formula1=`${num}`,this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.LESS_THAN_OR_EQUAL,this._rule.type=isInteger?core.DataValidationType.WHOLE:core.DataValidationType.DECIMAL,this}requireNumberNotBetween(start,end,isInteger){return this._rule.formula1=`${start}`,this._rule.formula2=`${end}`,this._rule.operator=core.DataValidationOperator.NOT_BETWEEN,this._rule.type=isInteger?core.DataValidationType.WHOLE:core.DataValidationType.DECIMAL,this}requireNumberNotEqualTo(num,isInteger){return this._rule.formula1=`${num}`,this._rule.formula2=void 0,this._rule.operator=core.DataValidationOperator.NOT_EQUAL,this._rule.type=isInteger?core.DataValidationType.WHOLE:core.DataValidationType.DECIMAL,this}requireValueInList(values,multiple,showDropdown){return this._rule.type=multiple?core.DataValidationType.LIST_MULTIPLE:core.DataValidationType.LIST,this._rule.formula1=values.join(","),this._rule.formula2=void 0,this._rule.showDropDown=showDropdown!=null?showDropdown:!0,this}requireValueInRange(range,multiple,showDropdown){return this._rule.type=multiple?core.DataValidationType.LIST_MULTIPLE:core.DataValidationType.LIST,this._rule.formula1=`=${engineFormula.serializeRangeToRefString({unitId:range.getUnitId(),sheetName:range.getSheetName(),range:range.getRange()})}`,this._rule.formula2=void 0,this._rule.showDropDown=showDropdown!=null?showDropdown:!0,this}setAllowInvalid(allowInvalidData){return this._rule.errorStyle=allowInvalidData?core.DataValidationErrorStyle.WARNING:core.DataValidationErrorStyle.STOP,this}setAllowBlank(allowBlank){return this._rule.allowBlank=allowBlank,this}setOptions(options){return Object.assign(this._rule,options),this}};__name(_FDataValidationBuilder,"FDataValidationBuilder");let FDataValidationBuilder=_FDataValidationBuilder;const _FDataValidation=class _FDataValidation{constructor(rule,worksheet,_injector){__publicField(this,"rule");__publicField(this,"_worksheet");__publicField(this,"_injector");this._injector=_injector,this.rule=rule,this._worksheet=worksheet}getAllowInvalid(){return this.rule.errorStyle!==core.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 FDataValidationBuilder(this.rule)}getApplied(){if(!this._worksheet)return!1;const currentRule=this._injector.get(dataValidation.DataValidationModel).getRuleById(this._worksheet.getUnitId(),this._worksheet.getSheetId(),this.rule.uid);return!!(currentRule&&currentRule.ranges.length)}getRanges(){if(!this.getApplied())return[];const workbook=this._injector.get(core.IUniverInstanceService).getUnit(this._worksheet.getUnitId());return this.rule.ranges.map(range=>this._injector.createInstance(facade.FRange,workbook,this._worksheet,range))}getUnitId(){var _a;return(_a=this._worksheet)==null?void 0:_a.getUnitId()}getSheetId(){var _a;return(_a=this._worksheet)==null?void 0:_a.getSheetId()}setCriteria(type,values,allowBlank=!0){if(this.getApplied()&&!this._injector.get(core.ICommandService).syncExecuteCommand(sheetsDataValidation.UpdateSheetDataValidationSettingCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,setting:{operator:values[0],formula1:values[1],formula2:values[2],type:this.rule.type,allowBlank}}))throw new Error("setCriteria failed");return this.rule.operator=values[0],this.rule.formula1=values[1],this.rule.formula2=values[2],this.rule.type=type,this.rule.allowBlank=allowBlank,this}setOptions(options){if(this.getApplied()&&!this._injector.get(core.ICommandService).syncExecuteCommand(sheetsDataValidation.UpdateSheetDataValidationOptionsCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,options:{...dataValidation.getRuleOptions(this.rule),...options}}))throw new Error("setOptions failed");return Object.assign(this.rule,options),this}setRanges(ranges){if(this.getApplied()&&!this._injector.get(core.ICommandService).syncExecuteCommand(sheetsDataValidation.UpdateSheetDataValidationRangeCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,ranges:ranges.map(range=>range.getRange())}))throw new Error("setRanges failed");return this.rule.ranges=ranges.map(range=>range.getRange()),this}delete(){return this.getApplied()?this._injector.get(core.ICommandService).syncExecuteCommand(sheetsDataValidation.RemoveSheetDataValidationCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid}):!1}};__name(_FDataValidation,"FDataValidation");let FDataValidation=_FDataValidation;const _FRangeDataValidationMixin=class _FRangeDataValidationMixin extends facade.FRange{setDataValidation(rule){if(!rule)return this._commandService.syncExecuteCommand(sheetsDataValidation.ClearRangeDataValidationCommand.id,{unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),ranges:[this._range]}),this;const params={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),rule:{...rule.rule,ranges:[this._range]}};return this._commandService.syncExecuteCommand(sheetsDataValidation.AddSheetDataValidationCommand.id,params),this}getDataValidation(){const rule=this._injector.get(sheetsDataValidation.SheetsDataValidationValidatorService).getDataValidation(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range]);return rule&&new FDataValidation(rule,this._worksheet,this._injector)}getDataValidations(){return this._injector.get(sheetsDataValidation.SheetsDataValidationValidatorService).getDataValidations(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range]).map(rule=>new FDataValidation(rule,this._worksheet,this._injector))}async getValidatorStatus(){return this._injector.get(sheetsDataValidation.SheetsDataValidationValidatorService).validatorRanges(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range])}};__name(_FRangeDataValidationMixin,"FRangeDataValidationMixin");let FRangeDataValidationMixin=_FRangeDataValidationMixin;facade.FRange.extend(FRangeDataValidationMixin);const _FUnvierDataValidationMixin=class _FUnvierDataValidationMixin extends core.FUniver{static newDataValidation(){return new FDataValidationBuilder}newDataValidation(){return new FDataValidationBuilder}_initialize(injector){if(!injector.has(sheetsDataValidation.SheetDataValidationModel))return;const sheetDataValidationModel=injector.get(sheetsDataValidation.SheetDataValidationModel),commadnService=injector.get(core.ICommandService);this.disposeWithMe(sheetDataValidationModel.ruleChange$.subscribe(ruleChange=>{const{unitId,subUnitId,rule,oldRule,type}=ruleChange,target=this.getSheetTarget(unitId,subUnitId);if(!target)return;const{workbook,worksheet}=target,fRule=new FDataValidation(rule,worksheet.getSheet(),this._injector);this.fireEvent(this.Event.SheetDataValidationChanged,{origin:ruleChange,worksheet,workbook,changeType:type,oldRule,rule:fRule})})),this.disposeWithMe(sheetDataValidationModel.validStatusChange$.subscribe(statusChange=>{const{unitId,subUnitId,ruleId,status,row,col}=statusChange,target=this.getSheetTarget(unitId,subUnitId);if(!target)return;const{workbook,worksheet}=target,rule=worksheet.getDataValidation(ruleId);rule&&this.fireEvent(this.Event.SheetDataValidatorStatusChanged,{workbook,worksheet,row,column:col,rule,status})})),this.disposeWithMe(commadnService.beforeCommandExecuted(commandInfo=>{switch(commandInfo.id){case sheetsDataValidation.AddSheetDataValidationCommand.id:{const params=commandInfo.params,target=this.getSheetTarget(params.unitId,params.subUnitId);if(!target)return;const{workbook,worksheet}=target,eventParams={worksheet,workbook,rule:params.rule};if(this.fireEvent(this.Event.BeforeSheetDataValidationAdd,eventParams),eventParams.cancel)throw new core.CanceledError;break}case sheetsDataValidation.UpdateSheetDataValidationSettingCommand.id:{const params=commandInfo.params,target=this.getSheetTarget(params.unitId,params.subUnitId);if(!target)return;const{workbook,worksheet}=target,rule=worksheet.getDataValidation(params.ruleId);if(!rule)return;const eventParams={worksheet,workbook,rule,ruleId:params.ruleId,newCriteria:params.setting};if(this.fireEvent(this.Event.BeforeSheetDataValidationCriteriaUpdate,eventParams),eventParams.cancel)throw new core.CanceledError;break}case sheetsDataValidation.UpdateSheetDataValidationRangeCommand.id:{const params=commandInfo.params,target=this.getSheetTarget(params.unitId,params.subUnitId);if(!target)return;const{workbook,worksheet}=target,rule=worksheet.getDataValidation(params.ruleId);if(!rule)return;const eventParams={worksheet,workbook,rule,ruleId:params.ruleId,newRanges:params.ranges};if(this.fireEvent(this.Event.BeforeSheetDataValidationRangeUpdate,eventParams),eventParams.cancel)throw new core.CanceledError;break}case sheetsDataValidation.UpdateSheetDataValidationOptionsCommand.id:{const params=commandInfo.params,target=this.getSheetTarget(params.unitId,params.subUnitId);if(!target)return;const{workbook,worksheet}=target,rule=worksheet.getDataValidation(params.ruleId);if(!rule)return;const eventParams={worksheet,workbook,rule,ruleId:params.ruleId,newOptions:params.options};if(this.fireEvent(this.Event.BeforeSheetDataValidationOptionsUpdate,eventParams),eventParams.cancel)throw new core.CanceledError;break}case sheetsDataValidation.RemoveSheetDataValidationCommand.id:{const params=commandInfo.params,target=this.getSheetTarget(params.unitId,params.subUnitId);if(!target)return;const{workbook,worksheet}=target,rule=worksheet.getDataValidation(params.ruleId);if(!rule)return;const eventParams={worksheet,workbook,rule,ruleId:params.ruleId};if(this.fireEvent(this.Event.BeforeSheetDataValidationDelete,eventParams),eventParams.cancel)throw new core.CanceledError;break}case sheetsDataValidation.RemoveSheetAllDataValidationCommand.id:{const params=commandInfo.params,target=this.getSheetTarget(params.unitId,params.subUnitId);if(!target)return;const{workbook,worksheet}=target,eventParams={worksheet,workbook,rules:worksheet.getDataValidations()};if(this.fireEvent(this.Event.BeforeSheetDataValidationDeleteAll,eventParams),eventParams.cancel)throw new core.CanceledError;break}}}))}};__name(_FUnvierDataValidationMixin,"FUnvierDataValidationMixin");let FUnvierDataValidationMixin=_FUnvierDataValidationMixin;core.FUniver.extend(FUnvierDataValidationMixin);const _FWorkbookDataValidationMixin=class _FWorkbookDataValidationMixin extends facade.FWorkbook{_initialize(){Object.defineProperty(this,"_dataValidationModel",{get(){return this._injector.get(sheetsDataValidation.SheetDataValidationModel)}})}getValidatorStatus(){return this._injector.get(sheetsDataValidation.SheetsDataValidationValidatorService).validatorWorkbook(this._workbook.getUnitId())}onDataValidationChange(callback){return core.toDisposable(this._dataValidationModel.ruleChange$.pipe(rxjs.filter(change=>change.unitId===this._workbook.getUnitId())).subscribe(callback))}onDataValidationStatusChange(callback){return core.toDisposable(this._dataValidationModel.validStatusChange$.pipe(rxjs.filter(change=>change.unitId===this._workbook.getUnitId())).subscribe(callback))}onBeforeAddDataValidation(callback){return core.toDisposable(this._commandService.beforeCommandExecuted((commandInfo,options)=>{const params=commandInfo.params;if(commandInfo.id===sheetsDataValidation.AddSheetDataValidationCommand.id){if(params.unitId!==this._workbook.getUnitId())return;if(callback(params,options)===!1)throw new Error("Command is stopped by the hook onBeforeAddDataValidation")}}))}onBeforeUpdateDataValidationCriteria(callback){return core.toDisposable(this._commandService.beforeCommandExecuted((commandInfo,options)=>{const params=commandInfo.params;if(commandInfo.id===sheetsDataValidation.UpdateSheetDataValidationSettingCommand.id){if(params.unitId!==this._workbook.getUnitId())return;if(callback(params,options)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationCriteria")}}))}onBeforeUpdateDataValidationRange(callback){return core.toDisposable(this._commandService.beforeCommandExecuted((commandInfo,options)=>{const params=commandInfo.params;if(commandInfo.id===sheetsDataValidation.UpdateSheetDataValidationRangeCommand.id){if(params.unitId!==this._workbook.getUnitId())return;if(callback(params,options)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationRange")}}))}onBeforeUpdateDataValidationOptions(callback){return core.toDisposable(this._commandService.beforeCommandExecuted((commandInfo,options)=>{const params=commandInfo.params;if(commandInfo.id===sheetsDataValidation.UpdateSheetDataValidationOptionsCommand.id){if(params.unitId!==this._workbook.getUnitId())return;if(callback(params,options)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationOptions")}}))}onBeforeDeleteDataValidation(callback){return core.toDisposable(this._commandService.beforeCommandExecuted((commandInfo,options)=>{const params=commandInfo.params;if(commandInfo.id===sheetsDataValidation.RemoveSheetDataValidationCommand.id){if(params.unitId!==this._workbook.getUnitId())return;if(callback(params,options)===!1)throw new Error("Command is stopped by the hook onBeforeDeleteDataValidation")}}))}onBeforeDeleteAllDataValidation(callback){return core.toDisposable(this._commandService.beforeCommandExecuted((commandInfo,options)=>{const params=commandInfo.params;if(commandInfo.id===sheetsDataValidation.RemoveSheetAllDataValidationCommand.id){if(params.unitId!==this._workbook.getUnitId())return;if(callback(params,options)===!1)throw new Error("Command is stopped by the hook onBeforeDeleteAllDataValidation")}}))}};__name(_FWorkbookDataValidationMixin,"FWorkbookDataValidationMixin");let FWorkbookDataValidationMixin=_FWorkbookDataValidationMixin;facade.FWorkbook.extend(FWorkbookDataValidationMixin);const _FWorksheetDataValidationMixin=class _FWorksheetDataValidationMixin extends facade.FWorksheet{getDataValidations(){return this._injector.get(dataValidation.DataValidationModel).getRules(this._workbook.getUnitId(),this._worksheet.getSheetId()).map(rule=>new FDataValidation(rule,this._worksheet,this._injector))}getValidatorStatus(){return this._injector.get(sheetsDataValidation.SheetsDataValidationValidatorService).validatorWorksheet(this._workbook.getUnitId(),this._worksheet.getSheetId())}getValidatorStatusAsync(){return this.getValidatorStatus()}getDataValidation(ruleId){const rule=this._injector.get(dataValidation.DataValidationModel).getRuleById(this._workbook.getUnitId(),this._worksheet.getSheetId(),ruleId);return rule?new FDataValidation(rule,this._worksheet,this._injector):null}};__name(_FWorksheetDataValidationMixin,"FWorksheetDataValidationMixin");let FWorksheetDataValidationMixin=_FWorksheetDataValidationMixin;facade.FWorksheet.extend(FWorksheetDataValidationMixin);const _FDataValidationEvent=class _FDataValidationEvent{get SheetDataValidationChanged(){return"SheetDataValidationChanged"}get SheetDataValidatorStatusChanged(){return"SheetDataValidatorStatusChanged"}get BeforeSheetDataValidationAdd(){return"BeforeSheetDataValidationAdd"}get BeforeSheetDataValidationDelete(){return"BeforeSheetDataValidationDelete"}get BeforeSheetDataValidationDeleteAll(){return"BeforeSheetDataValidationDeleteAll"}get BeforeSheetDataValidationCriteriaUpdate(){return"BeforeSheetDataValidationCriteriaUpdate"}get BeforeSheetDataValidationRangeUpdate(){return"BeforeSheetDataValidationRangeUpdate"}get BeforeSheetDataValidationOptionsUpdate(){return"BeforeSheetDataValidationOptionsUpdate"}};__name(_FDataValidationEvent,"FDataValidationEvent");let FDataValidationEvent=_FDataValidationEvent;core.FEventName.extend(FDataValidationEvent),exports2.FDataValidation=FDataValidation,exports2.FDataValidationBuilder=FDataValidationBuilder,Object.defineProperty(exports2,Symbol.toStringTag,{value:"Module"})});