@univerjs/sheets-data-validation 0.6.1 → 0.6.2-nightly.202503031606

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

@@ -173,12 +173,15 @@ export declare class FDataValidation {
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a new data validation rule that requires a number equal to 20 for the range A1:B10
      * const fRange = fWorksheet.getRange('A1:B10');
      * const rule = univerAPI.newDataValidation()
      *   .requireNumberEqualTo(20)
      *   .build();
      * fRange.setDataValidation(rule);
      *
+     * // Change the rule criteria to require a number between 1 and 10
      * fRange.getDataValidation().setCriteria(
      *   univerAPI.Enum.DataValidationType.DECIMAL,
      *   [univerAPI.Enum.DataValidationOperator.BETWEEN, '1', '10']
@@ -194,12 +197,15 @@ export declare class FDataValidation {
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a new data validation rule that requires a number equal to 20 for the range A1:B10
      * const fRange = fWorksheet.getRange('A1:B10');
      * const rule = univerAPI.newDataValidation()
      *   .requireNumberEqualTo(20)
      *   .build();
      * fRange.setDataValidation(rule);
      *
+     * // Supplement the rule with additional options
      * fRange.getDataValidation().setOptions({
      *   allowBlank: true,
      *   showErrorMessage: true,
@@ -216,12 +222,15 @@ export declare class FDataValidation {
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a new data validation rule that requires a number equal to 20 for the range A1:B10
      * const fRange = fWorksheet.getRange('A1:B10');
      * const rule = univerAPI.newDataValidation()
      *   .requireNumberEqualTo(20)
      *   .build();
      * fRange.setDataValidation(rule);
      *
+     * // Change the range to C1:D10
      * const newRuleRange = fWorksheet.getRange('C1:D10');
      * fRange.getDataValidation().setRanges([newRuleRange]);
      * ```
@@ -234,12 +243,15 @@ export declare class FDataValidation {
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a new data validation rule that requires a number equal to 20 for the range A1:B10
      * const fRange = fWorksheet.getRange('A1:B10');
      * const rule = univerAPI.newDataValidation()
      *   .requireNumberEqualTo(20)
      *   .build();
      * fRange.setDataValidation(rule);
      *
+     * // Delete the data validation rule
      * fRange.getDataValidation().delete();
      * ```
      */

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

@@ -13,6 +13,8 @@ export interface IFRangeDataValidationMixin {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a data validation rule that requires a number between 1 and 10 for the range A1:B10
      * const fRange = fWorksheet.getRange('A1:B10');
      * const rule = univerAPI.newDataValidation()
      *   .requireNumberBetween(1, 10)
@@ -33,6 +35,8 @@ export interface IFRangeDataValidationMixin {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a data validation rule that requires a number equal to 20 for the range A1:B10
      * const fRange = fWorksheet.getRange('A1:B10');
      * const rule = univerAPI.newDataValidation()
      *   .requireNumberEqualTo(20)
@@ -40,10 +44,13 @@ export interface IFRangeDataValidationMixin {
      * fRange.setDataValidation(rule);
      * console.log(fRange.getDataValidation().getCriteriaValues());
      *
+     * // Change the rule criteria to require a number between 1 and 10
      * fRange.getDataValidation().setCriteria(
      *   univerAPI.Enum.DataValidationType.DECIMAL,
      *   [univerAPI.Enum.DataValidationOperator.BETWEEN, '1', '10']
      * );
+     *
+     * // Print the new rule criteria values
      * console.log(fRange.getDataValidation().getCriteriaValues());
      * ```
      */
@@ -55,18 +62,22 @@ export interface IFRangeDataValidationMixin {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a data validation rule that requires a number equal to 20 for the range A1:B10
      * const fRange1 = fWorksheet.getRange('A1:B10');
      * const rule1 = univerAPI.newDataValidation()
      *   .requireNumberEqualTo(20)
      *   .build();
      * fRange1.setDataValidation(rule1);
      *
+     * // Create a data validation rule that requires a number between 1 and 10 for the range C1:D10
      * const fRange2 = fWorksheet.getRange('C1:D10');
      * const rule2 = univerAPI.newDataValidation()
      *   .requireNumberBetween(1, 10)
      *   .build();
      * fRange2.setDataValidation(rule2);
      *
+     * // Get all data validation rules in the range A1:D10
      * const range = fWorksheet.getRange('A1:D10');
      * const rules = range.getDataValidations();
      * console.log(rules.length); // 2
@@ -80,6 +91,8 @@ export interface IFRangeDataValidationMixin {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Set some values in the range A1:B10
      * const fRange = fWorksheet.getRange('A1:B10');
      * fRange.setValues([
      *   [1, 2],
@@ -93,14 +106,18 @@ export interface IFRangeDataValidationMixin {
      *   [17, 18],
      *   [19, 20]
      * ]);
+     *
+     * // Create a data validation rule that requires a number between 1 and 10 for the range A1:B10
      * const rule = univerAPI.newDataValidation()
      *   .requireNumberBetween(1, 10)
      *   .build();
      * fRange.setDataValidation(rule);
      *
+     * // Get the validator status for the cell B2
      * const status = await fWorksheet.getRange('B2').getValidatorStatus();
      * console.log(status?.[0]?.[0]); // 'valid'
      *
+     * // Get the validator status for the cell B10
      * const status2 = await fWorksheet.getRange('B10').getValidatorStatus();
      * console.log(status2?.[0]?.[0]); // 'invalid'
      * ```

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

@@ -10,8 +10,20 @@ export interface IFUnvierDataValidationMixin {
      * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
      * @example
      * ```ts
-     * const rule = FUnvier.newDataValidation();
-     * cell.setDataValidation(rule.requireValueInRange(range));
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a new data validation rule that requires a number between 1 and 10 fot the range A1:B10
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * const rule = univerAPI.newDataValidation()
+     *   .requireNumberBetween(1, 10)
+     *   .setOptions({
+     *     allowBlank: true,
+     *     showErrorMessage: true,
+     *     error: 'Please enter a number between 1 and 10'
+     *   })
+     *   .build();
+     * fRange.setDataValidation(rule);
      * ```
      */
     newDataValidation(): FDataValidationBuilder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-data-validation",
-  "version": "0.6.1",
+  "version": "0.6.2-nightly.202503031606",
   "private": false,
   "description": "Data validation for Univer Sheets",
   "author": "DreamNum <developer@univer.ai>",
@@ -54,19 +54,19 @@
   },
   "dependencies": {
     "@univerjs/protocol": "0.1.43",
-    "@univerjs/core": "0.6.1",
-    "@univerjs/data-validation": "0.6.1",
-    "@univerjs/engine-formula": "0.6.1",
-    "@univerjs/sheets-formula": "0.6.1",
-    "@univerjs/sheets": "0.6.1"
+    "@univerjs/core": "0.6.2-nightly.202503031606",
+    "@univerjs/sheets": "0.6.2-nightly.202503031606",
+    "@univerjs/sheets-formula": "0.6.2-nightly.202503031606",
+    "@univerjs/data-validation": "0.6.2-nightly.202503031606",
+    "@univerjs/engine-formula": "0.6.2-nightly.202503031606"
   },
   "devDependencies": {
     "less": "^4.2.2",
     "rxjs": "^7.8.1",
-    "typescript": "^5.7.3",
-    "vite": "^6.1.1",
-    "vitest": "^3.0.6",
-    "@univerjs-infra/shared": "0.6.1"
+    "typescript": "^5.8.2",
+    "vite": "^6.2.0",
+    "vitest": "^3.0.7",
+    "@univerjs-infra/shared": "0.6.2"
   },
   "scripts": {
     "dev": "vite",

package/LICENSE

@@ -1,176 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS