@univerjs/sheets-data-validation 0.5.3-nightly.202501051605 → 0.5.3-nightly.202501060906

package/lib/es/facade.js

@@ -536,35 +536,16 @@ class x extends k {
       }
     });
   }
-  /**
-   * get data validation validator status for current workbook
-   * @returns matrix of validator status
-   */
   getValidatorStatus() {
     return this._injector.get(l).validatorWorkbook(this._workbook.getUnitId());
   }
   // region DataValidationHooks
-  /**
-   * The onDataValidationChange event is fired when the data validation rule of this sheet is changed.
-   * @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
-   */
   onDataValidationChange(e) {
     return n(this._dataValidationModel.ruleChange$.pipe(p((t) => t.unitId === this._workbook.getUnitId())).subscribe(e));
   }
-  /**
-   * The onDataValidationStatusChange event is fired when the data validation status of this sheet is changed.
-   * @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
-   */
   onDataValidationStatusChange(e) {
     return n(this._dataValidationModel.validStatusChange$.pipe(p((t) => t.unitId === this._workbook.getUnitId())).subscribe(e));
   }
-  /**
-   * The onBeforeAddDataValidation event is fired before the data validation rule is added.
-   * @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
-   */
   onBeforeAddDataValidation(e) {
     return n(this._commandService.beforeCommandExecuted((t, r) => {
       const a = t.params;

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

@@ -3,18 +3,18 @@ import { FRange } from '@univerjs/sheets/facade';
 import { FDataValidation } from './f-data-validation';
 export interface IFRangeDataValidationMixin {
     /**
-     * set a data validation rule to current range
+     * Set a data validation rule to current range.
      * @param rule data validation rule, build by `FUniver.newDataValidation`
      * @returns current range
      */
     setDataValidation(this: FRange, rule: Nullable<FDataValidation>): FRange;
     /**
-     * get first data validation rule in current range
+     * Get first data validation rule in current range.
      * @returns data validation rule
      */
     getDataValidation(this: FRange): Nullable<FDataValidation>;
     /**
-     * get all data validation rules in current range
+     * Get all data validation rules in current range.
      * @returns all data validation rules
      */
     getDataValidations(this: FRange): FDataValidation[];

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

@@ -4,55 +4,59 @@ import { DataValidationStatus, IDisposable, IExecutionOptions, Nullable, ObjectM
 import { FWorkbook } from '@univerjs/sheets/facade';
 export interface IFWorkbookDataValidationMixin {
     /**
-     * get data validation validator status for current workbook
-     * @returns matrix of validator status
+     * Get data validation validator status for current workbook.
+     * @returns A promise that resolves to a matrix of validator status.
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook().getValidatorStatus().then((status) => { console.log(status) })
+     * ```
      */
     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 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
+     * @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
      */
     onDataValidationChange(callback: (ruleChange: IRuleChange) => void): IDisposable;
     /**
      * The onDataValidationStatusChange event is fired when the data validation status of this sheet is changed.
-     * @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
+     * @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
      */
     onDataValidationStatusChange(callback: (statusChange: IValidStatusChange) => void): IDisposable;
     /**
      * The onBeforeAddDataValidation event is fired before the data validation rule is added.
-     * @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
+     * @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
      */
     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
+     * @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
      */
     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
+     * @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
      */
     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
+     * @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
      */
     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
+     * @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
      */
     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
+     * @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
      */
     onBeforeDeleteAllDataValidation(this: FWorkbook, callback: (params: IRemoveSheetAllDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
@@ -60,28 +64,9 @@ export interface IFWorkbookDataValidationMixin {
 export declare class FWorkbookDataValidationMixin extends FWorkbook implements IFWorkbookDataValidationMixin {
     _dataValidationModel: SheetDataValidationModel;
     _initialize(): void;
-    /**
-     * get data validation validator status for current workbook
-     * @returns matrix of validator status
-     */
     getValidatorStatus(): Promise<Record<string, ObjectMatrix<Nullable<DataValidationStatus>>>>;
-    /**
-     * The onDataValidationChange event is fired when the data validation rule of this sheet is changed.
-     * @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
-     */
     onDataValidationChange(callback: (ruleChange: IRuleChange) => void): IDisposable;
-    /**
-     * The onDataValidationStatusChange event is fired when the data validation status of this sheet is changed.
-     * @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
-     */
     onDataValidationStatusChange(callback: (statusChange: IValidStatusChange) => void): IDisposable;
-    /**
-     * The onBeforeAddDataValidation event is fired before the data validation rule is added.
-     * @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
-     */
     onBeforeAddDataValidation(callback: (params: IAddSheetDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
     onBeforeUpdateDataValidationCriteria(callback: (params: IUpdateSheetDataValidationSettingCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
     onBeforeUpdateDataValidationRange(callback: (params: IUpdateSheetDataValidationRangeCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;

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

@@ -3,12 +3,12 @@ import { FWorksheet } from '@univerjs/sheets/facade';
 import { FDataValidation } from './f-data-validation';
 export interface IFWorksheetDataValidationMixin {
     /**
-     * get all data validation rules in current sheet
+     * Get all data validation rules in current sheet.
      * @returns all data validation rules
      */
     getDataValidations(): FDataValidation[];
     /**
-     * get data validation validator status for current sheet
+     * Get data validation validator status for current sheet.
      * @returns matrix of validator status
      */
     getValidatorStatus(): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-data-validation",
-  "version": "0.5.3-nightly.202501051605",
+  "version": "0.5.3-nightly.202501060906",
   "private": false,
   "description": "Data validation for Univer Sheets",
   "author": "DreamNum <developer@univer.ai>",
@@ -54,11 +54,11 @@
   },
   "dependencies": {
     "@univerjs/protocol": "0.1.40",
-    "@univerjs/core": "0.5.3-nightly.202501051605",
-    "@univerjs/data-validation": "0.5.3-nightly.202501051605",
-    "@univerjs/engine-formula": "0.5.3-nightly.202501051605",
-    "@univerjs/sheets": "0.5.3-nightly.202501051605",
-    "@univerjs/sheets-formula": "0.5.3-nightly.202501051605"
+    "@univerjs/data-validation": "0.5.3-nightly.202501060906",
+    "@univerjs/sheets": "0.5.3-nightly.202501060906",
+    "@univerjs/sheets-formula": "0.5.3-nightly.202501060906",
+    "@univerjs/core": "0.5.3-nightly.202501060906",
+    "@univerjs/engine-formula": "0.5.3-nightly.202501060906"
   },
   "devDependencies": {
     "less": "^4.2.1",