@univerjs/sheets-data-validation 0.5.3-nightly.202501121605 → 0.5.4-experimental.20250114-7c09c35

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

@@ -13,43 +13,36 @@ export declare class FDataValidationBuilder {
     constructor(rule?: IDataValidationRule);
     /**
      * Builds an FDataValidation instance based on the _rule property of the current class
-     *
      * @returns {FDataValidation} A new instance of the FDataValidation class
      */
     build(): FDataValidation;
     /**
      * Creates a duplicate of the current DataValidationBuilder object
-     *
-     * @return {FDataValidationBuilder} A new instance of the DataValidationBuilder class
+     * @returns {FDataValidationBuilder} A new instance of the DataValidationBuilder class
      */
     copy(): FDataValidationBuilder;
     /**
      * Determines whether invalid data is allowed
-     *
      * @returns {boolean} True if invalid data is allowed, False otherwise
      */
     getAllowInvalid(): boolean;
     /**
      * Gets the data validation type of the rule
-     *
      * @returns {DataValidationType} The data validation type
      */
     getCriteriaType(): DataValidationType | string;
     /**
      * Gets the values used for criteria evaluation
-     *
      * @returns {[string, string, string]} An array containing the operator, formula1, and formula2 values
      */
     getCriteriaValues(): [string | undefined, string | undefined, string | undefined];
     /**
      * Gets the help text information, which is used to provide users with guidance and support
-     *
      * @returns {string | undefined} Returns the help text information. If there is no error message, it returns an undefined value.
      */
     getHelpText(): string | undefined;
     /**
      * Sets the data validation type to CHECKBOX and sets the checked and unchecked values
-     *
      * @param checkedValue The value when the checkbox is checked (Optional)
      * @param uncheckedValue The value when the checkbox is unchecked (Optional)
      * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
@@ -57,190 +50,168 @@ export declare class FDataValidationBuilder {
     requireCheckbox(checkedValue?: string, uncheckedValue?: string): FDataValidationBuilder;
     /**
      * Set the data validation type to DATE and configure the validation rules to be after a specific date
-     *
      * @param date The date to compare against. The formatted date string will be set as formula1
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
      */
     requireDateAfter(date: Date): FDataValidationBuilder;
     /**
      * Set the data validation type to DATE and configure the validation rules to be before a specific date
-     *
      * @param date The date to compare against. The formatted date string will be set as formula1
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
      */
     requireDateBefore(date: Date): FDataValidationBuilder;
     /**
      * Set the data validation type to DATE and configure the validation rules to be within a specific date range
-     *
      * @param start The starting date of the range. The formatted date string will be set as formula1
      * @param end The ending date of the range. The formatted date string will be set as formula2
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
      */
     requireDateBetween(start: Date, end: Date): FDataValidationBuilder;
     /**
      * Set the data validation type to DATE and configure the validation rules to be equal to a specific date
-     *
      * @param date The date to compare against. The formatted date string will be set as formula1
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
      */
     requireDateEqualTo(date: Date): FDataValidationBuilder;
     /**
      * Set the data validation type to DATE and configure the validation rules to be not within a specific date range
-     *
      * @param start The starting date of the date range
      * @param end The ending date of the date range
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
      */
     requireDateNotBetween(start: Date, end: Date): FDataValidationBuilder;
     /**
      * Set the data validation type to DATE and configure the validation rules to be on or after a specific date
-     *
      * @param date The date to compare against. The formatted date string will be set as formula1
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
      */
     requireDateOnOrAfter(date: Date): FDataValidationBuilder;
     /**
      * Set the data validation type to DATE and configure the validation rules to be on or before a specific date
-     *
      * @param date The date to compare against. The formatted date string will be set as formula1
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
      */
     requireDateOnOrBefore(date: Date): FDataValidationBuilder;
     /**
      * Requires that a custom formula be satisfied.
      * Sets the data validation type to CUSTOM and configures the validation rule based on the provided formula string.
-     *
      * @param formula The formula string that needs to be satisfied.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     requireFormulaSatisfied(formula: string): FDataValidationBuilder;
     /**
      * Requires the user to enter a number within a specific range, which can be integer or decimal.
      * Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number range.
-     *
      * @param start The starting value of the number range.
      * @param end The ending value of the number range.
      * @param isInteger Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or decimal.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     requireNumberBetween(start: number, end: number, isInteger?: boolean): FDataValidationBuilder;
     /**
      * Requires the user to enter a number that is equal to a specific value, which can be an integer or a decimal.
      * Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number.
-     *
      * @param num The number to which the entered number should be equal.
      * @param isInteger Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     requireNumberEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder;
     /**
      * Requires the user to enter a number that is greater than a specific value, which can be an integer or a decimal.
      * Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number.
-     *
      * @param num The number to which the entered number should be greater.
      * @param isInteger Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     requireNumberGreaterThan(num: number, isInteger?: boolean): FDataValidationBuilder;
     /**
      * Requires the user to enter a number that is greater than or equal to a specific value, which can be an integer or a decimal.
      * Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number.
-     *
      * @param num The number to which the entered number should be greater than or equal.
      * @param isInteger Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     requireNumberGreaterThanOrEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder;
     /**
      * Requires the user to enter a number that is less than a specific value, which can be an integer or a decimal.
      * Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number.
-     *
      * @param num The number to which the entered number should be less.
      * @param isInteger Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     requireNumberLessThan(num: number, isInteger?: boolean): FDataValidationBuilder;
     /**
      * Sets the data validation rule to require a number less than or equal to a specified value
      * The specified value can be an integer or a decimal
-     *
      * @param num The number to which the entered number should be less than or equal
      * @param isInteger Indicates whether the required number is an integer
-     * @return The current instance of the DataValidationBuilder class, allowing for method chaining
+     * @returns The current instance of the DataValidationBuilder class, allowing for method chaining
      */
     requireNumberLessThanOrEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder;
     /**
      * Sets a data validation rule that requires the user to enter a number outside a specified range
      * The specified range includes all integers and decimals
-     *
      * @param start The starting point of the specified range
      * @param end The end point of the specified range
      * @param isInteger Optional parameter, indicating whether the number to be verified is an integer. Default value is false
-     * @return An instance of the FDataValidationBuilder class, allowing for method chaining
+     * @returns An instance of the FDataValidationBuilder class, allowing for method chaining
      */
     requireNumberNotBetween(start: number, end: number, isInteger?: boolean): FDataValidationBuilder;
     /**
      * Creates a data validation rule that requires the user to enter a number that is not equal to a specific value
      * The specific value can be an integer or a decimal
-     *
      * @param num The number to which the entered number should not be equal
      * @param isInteger Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining
      */
     requireNumberNotEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder;
     /**
      * Sets a data validation rule that requires the user to enter a value from a list of specific values.
      * The list can be displayed in a dropdown, and the user can choose multiple values according to the settings.
-     *
      * @param values An array containing the specific values that the user can enter.
      * @param multiple Optional parameter indicating whether the user can select multiple values. Default is false, meaning only one value can be selected.
      * @param showDropdown Optional parameter indicating whether to display the list in a dropdown. Default is true, meaning the list will be displayed as a dropdown.
-     * @return An instance of the FDataValidationBuilder class, allowing for method chaining.
+     * @returns An instance of the FDataValidationBuilder class, allowing for method chaining.
      */
     requireValueInList(values: string[], multiple?: boolean, showDropdown?: boolean): FDataValidationBuilder;
     /**
      * Sets a data validation rule that requires the user to enter a value within a specific range.
      * The range is defined by an FRange object, which contains the unit ID, sheet name, and cell range.
-     *
      * @param range An FRange object representing the range of values that the user can enter.
      * @param multiple Optional parameter indicating whether the user can select multiple values. Default is false, meaning only one value can be selected.
      * @param showDropdown Optional parameter indicating whether to display the list in a dropdown. Default is true, meaning the list will be displayed as a dropdown.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     requireValueInRange(range: FRange, multiple?: boolean, showDropdown?: boolean): FDataValidationBuilder;
     /**
      * Sets whether to allow invalid data and configures the error style for data validation.
      * If invalid data is not allowed, the error style will be set to STOP, indicating that data entry must stop upon encountering an error.
      * If invalid data is allowed, the error style will be set to WARNING, indicating that a warning will be displayed when invalid data is entered, but data entry can continue.
-     *
      * @param allowInvalidData A boolean value indicating whether to allow invalid data.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     setAllowInvalid(allowInvalidData: boolean): FDataValidationBuilder;
     /**
      * Sets the help text and enables the display of error messages for data validation.
      * This method allows you to set a custom help text that will be displayed when the user enters invalid data.
-     *
      * @param helpText The text to display as help information.
-     * @return The current instance of the FDataValidationBuilder class to allow for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */
     setHelpText(helpText: string): FDataValidationBuilder;
     /**
      * Sets the criteria values for data validation.
      * This method is used to configure the validation rules based on specific criteria values.
-     *
      * @param type The type of data validation.
      * @param values An array containing the criteria values.
      * The array should have three elements: [operator, formula1, formula2].
      * operator is a DataValidationOperator enum value, formula1 is the first formula, and formula2 is the second formula.
-     * @return The current instance of the FDataValidationBuilder class, allowing for method chaining.
+     * @returns The current instance of the FDataValidationBuilder class, allowing for method chaining.
      */
     withCriteriaValues(type: DataValidationType | string, values: [DataValidationOperator, string, string]): this;
     setAllowBlank(allowBlank: boolean): FDataValidationBuilder;
     /**
      * Sets the options for the data validation rule.
      * For details of options, please refer to https://univer.ai/typedoc/@univerjs/core/interfaces/IDataValidationRuleOptions
-     *
      * @param options The options to set for the data validation rule.
      * @returns The current instance of the FDataValidationBuilder class to allow for method chaining.
      */

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

@@ -8,56 +8,47 @@ export declare class FDataValidation {
     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.
+     * @returns true if invalid data is allowed, false otherwise.
      */
     getAllowInvalid(): boolean;
     /**
      * Gets the data validation type of the rule
-     *
      * @returns The data validation type
      */
     getCriteriaType(): DataValidationType | string;
     /**
      * Gets the values used for criteria evaluation
-     *
      * @returns An array containing the operator, formula1, and formula2 values
      */
     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.
      */
     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.
+     * @returns A new FDataValidationBuilder instance with the same rule configuration.
      */
     copy(): FDataValidationBuilder;
     /**
      * Gets whether the data validation rule is applied to the worksheet.
-     *
      * @returns true if the rule is applied, false otherwise.
      */
     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.
      */
     getRanges(): FRange[];
     /**
      * Gets the title of the error message dialog box.
-     *
      * @returns The title of the error message dialog box.
      */
     getUnitId(): string | undefined;
     /**
      * Gets the sheetId of the worksheet.
-     *
      * @returns The sheetId of the worksheet.
      */
     getSheetId(): string | undefined;
@@ -65,6 +56,7 @@ export declare class FDataValidation {
      * 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.
+     * @param allowBlank
      * @returns true if the criteria is set successfully, false otherwise.
      */
     setCriteria(type: DataValidationType, values: [DataValidationOperator, string, string], allowBlank?: boolean): FDataValidation;

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

@@ -18,13 +18,13 @@ export interface IFRangeDataValidationMixin {
      * @returns all data validation rules
      */
     getDataValidations(this: FRange): FDataValidation[];
-    getValidatorStatus(): Promise<Promise<DataValidationStatus>[][]>;
+    getValidatorStatus(): Promise<DataValidationStatus[][]>;
 }
 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/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>;