@univerjs/sheets-data-validation 0.6.0 → 0.6.1

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

@@ -14,12 +14,12 @@ export declare class FDataValidation {
      * @returns {boolean} true if invalid data is allowed, false otherwise
      * @example
      * ```typescript
-     * const dataValidation = univerAPI
-     *   .getActiveWorkbook()
-     *   .getActiveWorksheet()
-     *   .getActiveRange()
-     *   .getDataValidation();
-     * const allowsInvalid = dataValidation.getAllowInvalid();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const rules = fWorksheet.getDataValidations();
+     * rules.forEach((rule) => {
+     *   console.log(rule, rule.getAllowInvalid());
+     * });
      * ```
      */
     getAllowInvalid(): boolean;
@@ -28,12 +28,12 @@ export declare class FDataValidation {
      * @returns {DataValidationType | string} The data validation type
      * @example
      * ```typescript
-     * const dataValidation = univerAPI
-     *   .getActiveWorkbook()
-     *   .getActiveWorksheet()
-     *   .getActiveRange()
-     *   .getDataValidation();
-     * const type = dataValidation.getCriteriaType();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const rules = fWorksheet.getDataValidations();
+     * rules.forEach((rule) => {
+     *   console.log(rule, rule.getCriteriaType());
+     * });
      * ```
      */
     getCriteriaType(): DataValidationType | string;
@@ -42,12 +42,15 @@ export declare class FDataValidation {
      * @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();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const rules = fWorksheet.getDataValidations();
+     * rules.forEach((rule) => {
+     *   console.log(rule);
+     *   const criteriaValues = rule.getCriteriaValues();
+     *   const [operator, formula1, formula2] = criteriaValues;
+     *   console.log(operator, formula1, formula2);
+     * });
      * ```
      */
     getCriteriaValues(): [string | undefined, string | undefined, string | undefined];
@@ -56,12 +59,19 @@ export declare class FDataValidation {
      * @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();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * 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);
+     * console.log(fRange.getDataValidation().getHelpText()); // 'Please enter a number between 1 and 10'
      * ```
      */
     getHelpText(): string | undefined;
@@ -70,13 +80,27 @@ export declare class FDataValidation {
      * @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();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * 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);
+     *
+     * const builder = fRange.getDataValidation().copy();
+     * const newRule = builder
+     *   .requireNumberBetween(1, 5)
+     *   .setOptions({
+     *     error: 'Please enter a number between 1 and 5'
+     *   })
+     *   .build();
+     * fRange.setDataValidation(newRule);
      * ```
      */
     copy(): FDataValidationBuilder;
@@ -85,12 +109,15 @@ export declare class FDataValidation {
      * @returns {boolean} true if the rule is applied, false otherwise
      * @example
      * ```typescript
-     * const dataValidation = univerAPI
-     *   .getActiveWorkbook()
-     *   .getActiveWorksheet()
-     *   .getActiveRange()
-     *   .getDataValidation();
-     * const isApplied = dataValidation.getApplied();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const rules = fWorksheet.getDataValidations();
+     * rules.forEach((rule) => {
+     *   console.log(rule, rule.getApplied());
+     * });
+     *
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * console.log(fRange.getDataValidation()?.getApplied());
      * ```
      */
     getApplied(): boolean;
@@ -99,12 +126,16 @@ export declare class FDataValidation {
      * @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();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const rules = fWorksheet.getDataValidations();
+     * rules.forEach((rule) => {
+     *   console.log(rule);
+     *   const ranges = rule.getRanges();
+     *   ranges.forEach((range) => {
+     *     console.log(range.getA1Notation());
+     *   });
+     * });
      * ```
      */
     getRanges(): FRange[];
@@ -113,12 +144,10 @@ export declare class FDataValidation {
      * @returns {string | undefined} The unit ID of the worksheet
      * @example
      * ```typescript
-     * const dataValidation = univerAPI
-     *   .getActiveWorkbook()
-     *   .getActiveWorksheet()
-     *   .getActiveRange()
-     *   .getDataValidation();
-     * const unitId = dataValidation.getUnitId();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * console.log(fRange.getDataValidation().getUnitId());
      * ```
      */
     getUnitId(): string | undefined;
@@ -127,12 +156,10 @@ export declare class FDataValidation {
      * @returns {string | undefined} The sheet ID of the worksheet
      * @example
      * ```typescript
-     * const dataValidation = univerAPI
-     *   .getActiveWorkbook()
-     *   .getActiveWorksheet()
-     *   .getActiveRange()
-     *   .getDataValidation();
-     * const sheetId = dataValidation.getSheetId();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * console.log(fRange.getDataValidation().getSheetId());
      * ```
      */
     getSheetId(): string | undefined;
@@ -144,15 +171,17 @@ export declare class FDataValidation {
      * @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
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * const rule = univerAPI.newDataValidation()
+     *   .requireNumberEqualTo(20)
+     *   .build();
+     * fRange.setDataValidation(rule);
+     *
+     * fRange.getDataValidation().setCriteria(
+     *   univerAPI.Enum.DataValidationType.DECIMAL,
+     *   [univerAPI.Enum.DataValidationOperator.BETWEEN, '1', '10']
      * );
      * ```
      */
@@ -163,12 +192,15 @@ export declare class FDataValidation {
      * @returns {FDataValidation} The current instance for method chaining
      * @example
      * ```typescript
-     * const dataValidation = univerAPI
-     *   .getActiveWorkbook()
-     *   .getActiveWorksheet()
-     *   .getActiveRange()
-     *   .getDataValidation();
-     * dataValidation.setOptions({
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * const rule = univerAPI.newDataValidation()
+     *   .requireNumberEqualTo(20)
+     *   .build();
+     * fRange.setDataValidation(rule);
+     *
+     * fRange.getDataValidation().setOptions({
      *   allowBlank: true,
      *   showErrorMessage: true,
      *   error: 'Please enter a valid value'
@@ -182,13 +214,16 @@ export declare class FDataValidation {
      * @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]);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * const rule = univerAPI.newDataValidation()
+     *   .requireNumberEqualTo(20)
+     *   .build();
+     * fRange.setDataValidation(rule);
+     *
+     * const newRuleRange = fWorksheet.getRange('C1:D10');
+     * fRange.getDataValidation().setRanges([newRuleRange]);
      * ```
      */
     setRanges(ranges: FRange[]): FDataValidation;
@@ -197,12 +232,15 @@ export declare class FDataValidation {
      * @returns {boolean} true if the rule is deleted successfully, false otherwise
      * @example
      * ```typescript
-     * const dataValidation = univerAPI
-     *   .getActiveWorkbook()
-     *   .getActiveWorksheet()
-     *   .getActiveRange()
-     *   .getDataValidation();
-     * const isDeleted = dataValidation.delete();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * const rule = univerAPI.newDataValidation()
+     *   .requireNumberEqualTo(20)
+     *   .build();
+     * fRange.setDataValidation(rule);
+     *
+     * fRange.getDataValidation().delete();
      * ```
      */
     delete(): boolean;

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

@@ -155,10 +155,12 @@ interface IDataValidationEvent {
      * @see {@link ISheetDataValidationChangedEvent}
      * @example
      * ```ts
-     * univerAPI.on(univerAPI.Event.SheetDataValidationChanged, (event) => {
-     *     const { worksheet, workbook, changeType, oldRule, rule } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetDataValidationChanged, (event) => {
+     *   const { origin, worksheet, workbook, changeType, oldRule, rule } = event;
+     *   console.log(event);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly SheetDataValidationChanged: 'SheetDataValidationChanged';
@@ -167,10 +169,12 @@ interface IDataValidationEvent {
      * @see {@link ISheetDataValidatorStatusChangedEvent}
      * @example
      * ```ts
-     * univerAPI.on(univerAPI.Event.SheetDataValidatorStatusChanged, (event) => {
-     *     const { worksheet, workbook, row, column, status, rule } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetDataValidatorStatusChanged, (event) => {
+     *   const { worksheet, workbook, row, column, status, rule } = event;
+     *   console.log(event);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly SheetDataValidatorStatusChanged: 'SheetDataValidatorStatusChanged';
@@ -179,10 +183,15 @@ interface IDataValidationEvent {
      * @see {@link IBeforeSheetDataValidationAddEvent}
      * @example
      * ```ts
-     * univerAPI.on(univerAPI.Event.BeforeSheetDataValidationAdd, (event) => {
-     *      const { worksheet, workbook, rule } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationAdd, (event) => {
+     *   const { worksheet, workbook, rule } = event;
+     *   console.log(event);
+     *
+     *   // Cancel the data validation rule addition operation
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeSheetDataValidationAdd: 'BeforeSheetDataValidationAdd';
@@ -191,10 +200,15 @@ interface IDataValidationEvent {
      * @see {@link IBeforeSheetDataValidationDeleteEvent}
      * @example
      * ```ts
-     * univerAPI.on(univerAPI.Event.BeforeSheetDataValidationDelete, (event) => {
-     *     const { worksheet, workbook, rule } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationDelete, (event) => {
+     *   const { worksheet, workbook, ruleId, rule } = event;
+     *   console.log(event);
+     *
+     *   // Cancel the data validation rule deletion operation
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeSheetDataValidationDelete: 'BeforeSheetDataValidationDelete';
@@ -203,10 +217,15 @@ interface IDataValidationEvent {
      * @see {@link IBeforeSheetDataValidationDeleteAllEvent}
      * @example
      * ```ts
-     * univerAPI.on(univerAPI.Event.BeforeSheetDataValidationDeleteAll, (event) => {
-     *     const { worksheet, workbook, rules } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationDeleteAll, (event) => {
+     *   const { worksheet, workbook, rules } = event;
+     *   console.log(event);
+     *
+     *   // Cancel the data validation rule deletion operation
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeSheetDataValidationDeleteAll: 'BeforeSheetDataValidationDeleteAll';
@@ -215,10 +234,15 @@ interface IDataValidationEvent {
      * @see {@link IBeforeSheetDataValidationCriteriaUpdateEvent}
      * @example
      * ```ts
-     * univerAPI.on(univerAPI.Event.BeforeSheetDataValidationCriteriaUpdate, (event) => {
-     *     const { worksheet, workbook, rule, newCriteria } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationCriteriaUpdate, (event) => {
+     *   const { worksheet, workbook, ruleId, rule, newCriteria } = event;
+     *   console.log(event);
+     *
+     *   // Cancel the data validation rule criteria update operation
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeSheetDataValidationCriteriaUpdate: 'BeforeSheetDataValidationCriteriaUpdate';
@@ -227,10 +251,15 @@ interface IDataValidationEvent {
      * @see {@link IBeforeSheetDataValidationRangeUpdateEvent}
      * @example
      * ```ts
-     * univerAPI.on(univerAPI.Event.BeforeSheetDataValidationRangeUpdate, (event) => {
-     *     const { worksheet, workbook, rule, newRanges } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationRangeUpdate, (event) => {
+     *   const { worksheet, workbook, ruleId, rule, newRanges } = event;
+     *   console.log(event);
+     *
+     *   // Cancel the data validation rule range update operation
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeSheetDataValidationRangeUpdate: 'BeforeSheetDataValidationRangeUpdate';
@@ -239,10 +268,15 @@ interface IDataValidationEvent {
      * @see {@link IBeforeSheetDataValidationOptionsUpdateEvent}
      * @example
      * ```ts
-     * univerAPI.on(univerAPI.Event.BeforeSheetDataValidationOptionsUpdate, (event) => {
-     *     const { worksheet, workbook, rule, newOptions } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationOptionsUpdate, (event) => {
+     *   const { worksheet, workbook, ruleId, rule, newOptions } = event;
+     *   console.log(event);
+     *
+     *   // Cancel the data validation rule options update operation
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeSheetDataValidationOptionsUpdate: 'BeforeSheetDataValidationOptionsUpdate';

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

@@ -11,8 +11,18 @@ export interface IFRangeDataValidationMixin {
      * @returns current range
      * @example
      * ```ts
-     * const rule = FUniver.newDataValidation().requireValueInRange(range).build();
-     * cell.setDataValidation(rule);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * 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);
      * ```
      */
     setDataValidation(rule: Nullable<FDataValidation>): FRange;
@@ -21,9 +31,20 @@ export interface IFRangeDataValidationMixin {
      * @returns {Nullable<FDataValidation>} data validation rule
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const worksheet = workbook.getActiveSheet();
-     * const dataValidation = worksheet.getActiveRange().getDataValidation();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * const rule = univerAPI.newDataValidation()
+     *   .requireNumberEqualTo(20)
+     *   .build();
+     * fRange.setDataValidation(rule);
+     * console.log(fRange.getDataValidation().getCriteriaValues());
+     *
+     * fRange.getDataValidation().setCriteria(
+     *   univerAPI.Enum.DataValidationType.DECIMAL,
+     *   [univerAPI.Enum.DataValidationOperator.BETWEEN, '1', '10']
+     * );
+     * console.log(fRange.getDataValidation().getCriteriaValues());
      * ```
      */
     getDataValidation(): Nullable<FDataValidation>;
@@ -32,9 +53,23 @@ export interface IFRangeDataValidationMixin {
      * @returns {FDataValidation[]} all data validation rules
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const worksheet = workbook.getActiveSheet();
-     * const dataValidations = worksheet.getActiveRange().getDataValidations();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange1 = fWorksheet.getRange('A1:B10');
+     * const rule1 = univerAPI.newDataValidation()
+     *   .requireNumberEqualTo(20)
+     *   .build();
+     * fRange1.setDataValidation(rule1);
+     *
+     * const fRange2 = fWorksheet.getRange('C1:D10');
+     * const rule2 = univerAPI.newDataValidation()
+     *   .requireNumberBetween(1, 10)
+     *   .build();
+     * fRange2.setDataValidation(rule2);
+     *
+     * const range = fWorksheet.getRange('A1:D10');
+     * const rules = range.getDataValidations();
+     * console.log(rules.length); // 2
      * ```
      */
     getDataValidations(): FDataValidation[];
@@ -43,9 +78,31 @@ export interface IFRangeDataValidationMixin {
      * @returns {Promise<DataValidationStatus[][]>} matrix of validator status
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const worksheet = workbook.getActiveSheet();
-     * const validatorStatus = worksheet.getActiveRange().getValidatorStatus();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B10');
+     * fRange.setValues([
+     *   [1, 2],
+     *   [3, 4],
+     *   [5, 6],
+     *   [7, 8],
+     *   [9, 10],
+     *   [11, 12],
+     *   [13, 14],
+     *   [15, 16],
+     *   [17, 18],
+     *   [19, 20]
+     * ]);
+     * const rule = univerAPI.newDataValidation()
+     *   .requireNumberBetween(1, 10)
+     *   .build();
+     * fRange.setDataValidation(rule);
+     *
+     * const status = await fWorksheet.getRange('B2').getValidatorStatus();
+     * console.log(status?.[0]?.[0]); // 'valid'
+     *
+     * const status2 = await fWorksheet.getRange('B10').getValidatorStatus();
+     * console.log(status2?.[0]?.[0]); // 'invalid'
      * ```
      */
     getValidatorStatus(): Promise<DataValidationStatus[][]>;

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

@@ -1,6 +1,6 @@
+import { DataValidationStatus, IDisposable, IExecutionOptions, Nullable, ObjectMatrix } from '@univerjs/core';
 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
@@ -11,10 +11,12 @@ export interface IFWorkbookDataValidationMixin {
      * @returns A promise that resolves to a matrix of validator status.
      * @example
      * ```ts
-     * univerAPI.getActiveWorkbook().getValidatorStatus().then((status) => { console.log(status) })
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const status = await fWorkbook.getValidatorStatus();
+     * console.log(status);
      * ```
      */
-    getValidatorStatus(this: FWorkbook): Promise<Record<string, ObjectMatrix<Nullable<DataValidationStatus>>>>;
+    getValidatorStatus(): Promise<Record<string, ObjectMatrix<Nullable<DataValidationStatus>>>>;
     /**
      * @deprecated Use `univerAPI.addEvent(univerAPI.Event.SheetDataValidationChanged, (event) => { ... })` instead
      */

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

@@ -7,11 +7,12 @@ import { FDataValidation } from './f-data-validation';
 export interface IFWorksheetDataValidationMixin {
     /**
      * Get all data validation rules in current sheet.
-     * @returns {FDataValidation[]} all data validation rules
+     * @returns {FDataValidation[]} All data validation rules
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const worksheet = workbook.getWorksheet('sheet1');
-     * const dataValidations = worksheet.getDataValidations();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const rules = fWorksheet.getDataValidations();
+     * console.log(rules);
      * ```
      */
     getDataValidations(): FDataValidation[];
@@ -23,9 +24,10 @@ export interface IFWorksheetDataValidationMixin {
      * Get data validation validator status for current sheet.
      * @returns {Promise<ObjectMatrix<Nullable<DataValidationStatus>>>} matrix of validator status
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const worksheet = workbook.getWorksheet('sheet1');
-     * const validatorStatus = worksheet.getValidatorStatus();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const status = await fWorksheet.getValidatorStatusAsync();
+     * console.log(status);
      * ```
      */
     getValidatorStatusAsync(): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;
@@ -34,9 +36,10 @@ export interface IFWorksheetDataValidationMixin {
      * @param ruleId - the rule id
      * @returns {Nullable<FDataValidation>} data validation rule
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const worksheet = workbook.getWorksheet('sheet1');
-     * const dataValidation = worksheet.getDataValidation('ruleId');
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const rules = fWorksheet.getDataValidations();
+     * console.log(fWorksheet.getDataValidation(rules[0]?.rule.uid));
      * ```
      */
     getDataValidation(ruleId: string): Nullable<FDataValidation>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-data-validation",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "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.0",
-    "@univerjs/data-validation": "0.6.0",
-    "@univerjs/engine-formula": "0.6.0",
-    "@univerjs/sheets": "0.6.0",
-    "@univerjs/sheets-formula": "0.6.0"
+    "@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"
   },
   "devDependencies": {
     "less": "^4.2.2",
     "rxjs": "^7.8.1",
     "typescript": "^5.7.3",
-    "vite": "^6.1.0",
-    "vitest": "^3.0.5",
-    "@univerjs-infra/shared": "0.6.0"
+    "vite": "^6.1.1",
+    "vitest": "^3.0.6",
+    "@univerjs-infra/shared": "0.6.1"
   },
   "scripts": {
     "dev": "vite",