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

package/lib/es/facade.js

@@ -18,7 +18,6 @@ class D {
   }
   /**
    * Builds an FDataValidation instance based on the _rule property of the current class
-   *
    * @returns {FDataValidation} A new instance of the FDataValidation class
    */
   build() {
@@ -26,8 +25,7 @@ class D {
   }
   /**
    * 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() {
     return new D({
@@ -37,7 +35,6 @@ class D {
   }
   /**
    * Determines whether invalid data is allowed
-   *
    * @returns {boolean} True if invalid data is allowed, False otherwise
    */
   getAllowInvalid() {
@@ -45,7 +42,6 @@ class D {
   }
   /**
    * Gets the data validation type of the rule
-   *
    * @returns {DataValidationType} The data validation type
    */
   getCriteriaType() {
@@ -53,7 +49,6 @@ class D {
   }
   /**
    * Gets the values used for criteria evaluation
-   *
    * @returns {[string, string, string]} An array containing the operator, formula1, and formula2 values
    */
   getCriteriaValues() {
@@ -61,7 +56,6 @@ class D {
   }
   /**
    * 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() {
@@ -69,7 +63,6 @@ class D {
   }
   /**
    * 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
@@ -79,65 +72,58 @@ class D {
   }
   /**
    * 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(e) {
     return this._rule.type = o.DATE, this._rule.formula1 = e.toLocaleDateString(), this._rule.operator = d.GREATER_THAN, this;
   }
   /**
    * 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(e) {
     return this._rule.type = o.DATE, this._rule.formula1 = e.toLocaleDateString(), this._rule.formula2 = void 0, this._rule.operator = d.LESS_THAN, this;
   }
   /**
    * 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(e, t) {
     return this._rule.type = o.DATE, this._rule.formula1 = e.toLocaleDateString(), this._rule.formula2 = t.toLocaleDateString(), this._rule.operator = d.BETWEEN, this;
   }
   /**
    * 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(e) {
     return this._rule.type = o.DATE, this._rule.formula1 = e.toLocaleDateString(), this._rule.formula2 = void 0, this._rule.operator = d.EQUAL, this;
   }
   /**
    * 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(e, t) {
     return this._rule.type = o.DATE, this._rule.formula1 = e.toLocaleDateString(), this._rule.formula2 = t.toLocaleDateString(), this._rule.operator = d.NOT_BETWEEN, this;
   }
   /**
    * 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(e) {
     return this._rule.type = o.DATE, this._rule.formula1 = e.toLocaleDateString(), this._rule.formula2 = void 0, this._rule.operator = d.GREATER_THAN_OR_EQUAL, this;
   }
   /**
    * 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(e) {
     return this._rule.type = o.DATE, this._rule.formula1 = e.toLocaleDateString(), this._rule.formula2 = void 0, this._rule.operator = d.LESS_THAN_OR_EQUAL, this;
@@ -145,9 +131,8 @@ class D {
   /**
    * 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(e) {
     return this._rule.type = o.CUSTOM, this._rule.formula1 = e, this._rule.formula2 = void 0, this;
@@ -155,11 +140,10 @@ class D {
   /**
    * 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(e, t, r) {
     return this._rule.formula1 = `${e}`, this._rule.formula2 = `${t}`, this._rule.operator = d.BETWEEN, this._rule.type = r ? o.WHOLE : o.DECIMAL, this;
@@ -167,10 +151,9 @@ class D {
   /**
    * 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(e, t) {
     return this._rule.formula1 = `${e}`, this._rule.formula2 = void 0, this._rule.operator = d.EQUAL, this._rule.type = t ? o.WHOLE : o.DECIMAL, this;
@@ -178,10 +161,9 @@ class D {
   /**
    * 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(e, t) {
     return this._rule.formula1 = `${e}`, this._rule.formula2 = void 0, this._rule.operator = d.GREATER_THAN, this._rule.type = t ? o.WHOLE : o.DECIMAL, this;
@@ -189,10 +171,9 @@ class D {
   /**
    * 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(e, t) {
     return this._rule.formula1 = `${e}`, this._rule.formula2 = void 0, this._rule.operator = d.GREATER_THAN_OR_EQUAL, this._rule.type = t ? o.WHOLE : o.DECIMAL, this;
@@ -200,10 +181,9 @@ class D {
   /**
    * 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(e, t) {
     return this._rule.formula1 = `${e}`, this._rule.formula2 = void 0, this._rule.operator = d.LESS_THAN, this._rule.type = t ? o.WHOLE : o.DECIMAL, this;
@@ -211,10 +191,9 @@ class D {
   /**
    * 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(e, t) {
     return this._rule.formula1 = `${e}`, this._rule.formula2 = void 0, this._rule.operator = d.LESS_THAN_OR_EQUAL, this._rule.type = t ? o.WHOLE : o.DECIMAL, this;
@@ -222,11 +201,10 @@ class D {
   /**
    * 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(e, t, r) {
     return this._rule.formula1 = `${e}`, this._rule.formula2 = `${t}`, this._rule.operator = d.NOT_BETWEEN, this._rule.type = r ? o.WHOLE : o.DECIMAL, this;
@@ -234,10 +212,9 @@ class D {
   /**
    * 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(e, t) {
     return this._rule.formula1 = `${e}`, this._rule.formula2 = void 0, this._rule.operator = d.NOT_EQUAL, this._rule.type = t ? o.WHOLE : o.DECIMAL, this;
@@ -245,11 +222,10 @@ class D {
   /**
    * 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(e, t, r) {
     return this._rule.type = t ? o.LIST_MULTIPLE : o.LIST, this._rule.formula1 = e.join(","), this._rule.formula2 = void 0, this._rule.showDropDown = r != null ? r : !0, this;
@@ -257,11 +233,10 @@ class D {
   /**
    * 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(e, t, r) {
     return this._rule.type = t ? o.LIST_MULTIPLE : o.LIST, this._rule.formula1 = `=${P({
@@ -274,9 +249,8 @@ class D {
    * 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(e) {
     return this._rule.errorStyle = e ? w.WARNING : w.STOP, this;
@@ -284,9 +258,8 @@ class D {
   /**
    * 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(e) {
     return this._rule.error = e, this._rule.showErrorMessage = !0, this;
@@ -294,12 +267,11 @@ class D {
   /**
    * 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(e, t) {
     return this._rule.type = e, this._rule.operator = t[0], this._rule.formula1 = t[1], this._rule.formula2 = t[2], this;
@@ -310,7 +282,6 @@ class D {
   /**
    * 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.
    */
@@ -327,15 +298,13 @@ class m {
   }
   /**
    * 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() {
     return this.rule.errorStyle !== w.STOP;
   }
   /**
    * Gets the data validation type of the rule
-   *
    * @returns The data validation type
    */
   getCriteriaType() {
@@ -343,7 +312,6 @@ class m {
   }
   /**
    * Gets the values used for criteria evaluation
-   *
    * @returns An array containing the operator, formula1, and formula2 values
    */
   getCriteriaValues() {
@@ -351,7 +319,6 @@ class m {
   }
   /**
    * 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() {
@@ -360,15 +327,13 @@ class m {
   /**
    * 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() {
     return new D(this.rule);
   }
   /**
    * Gets whether the data validation rule is applied to the worksheet.
-   *
    * @returns true if the rule is applied, false otherwise.
    */
   getApplied() {
@@ -379,7 +344,6 @@ class m {
   }
   /**
    * 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() {
@@ -390,7 +354,6 @@ class m {
   }
   /**
    * Gets the title of the error message dialog box.
-   *
    * @returns The title of the error message dialog box.
    */
   getUnitId() {
@@ -399,7 +362,6 @@ class m {
   }
   /**
    * Gets the sheetId of the worksheet.
-   *
    * @returns The sheetId of the worksheet.
    */
   getSheetId() {
@@ -410,6 +372,7 @@ class m {
    * 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(e, t, r = !0) {