@univerjs/sheets-data-validation 0.5.5 → 0.6.0-alpha.0

package/lib/es/facade.js

@@ -428,10 +428,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const allowsInvalid = dataValidation.getAllowInvalid();
    * ```
    */
@@ -444,10 +444,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const type = dataValidation.getCriteriaType();
    * ```
    */
@@ -460,10 +460,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const [operator, formula1, formula2] = dataValidation.getCriteriaValues();
    * ```
    */
@@ -476,10 +476,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const helpText = dataValidation.getHelpText();
    * ```
    */
@@ -492,10 +492,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const builder = dataValidation.copy();
    * const newRule = builder.setAllowInvalid(true).build();
    * ```
@@ -509,10 +509,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const isApplied = dataValidation.getApplied();
    * ```
    */
@@ -528,10 +528,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const ranges = dataValidation.getRanges();
    * ```
    */
@@ -547,10 +547,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const unitId = dataValidation.getUnitId();
    * ```
    */
@@ -564,10 +564,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const sheetId = dataValidation.getSheetId();
    * ```
    */
@@ -584,10 +584,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * dataValidation.setCriteria(
    *   DataValidationType.DECIMAL,
    *   [DataValidationOperator.BETWEEN, '1', '10'],
@@ -618,10 +618,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * dataValidation.setOptions({
    *   allowBlank: true,
    *   showErrorMessage: true,
@@ -649,10 +649,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const range = FRange.create('Sheet1', 'A1:B10');
    * dataValidation.setRanges([range]);
    * ```
@@ -673,10 +673,10 @@ class m {
    * @example
    * ```typescript
    * const dataValidation = univerAPI
-   *  .getActiveWorkbook()
-   *  .getActiveWorksheet()
-   *  .getActiveRange()
-   *  .getDataValidation();
+   *   .getActiveWorkbook()
+   *   .getActiveWorksheet()
+   *   .getActiveRange()
+   *   .getDataValidation();
    * const isDeleted = dataValidation.delete();
    * ```
    */
@@ -731,26 +731,19 @@ class G extends y {
 }
 y.extend(G);
 class Q extends x {
-  // eslint-disable-next-line jsdoc/require-returns
-  /**
   /**
    * @deprecated use `univerAPI.newDataValidation()` as instead.
+   * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
    */
   static newDataValidation() {
     return new D();
   }
-  /**
-   * Creates a new instance of FDataValidationBuilder
-   * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
-   * @example
-   * ```ts
-   * const rule = FUnvier.newDataValidation();
-   * cell.setDataValidation(rule.requireValueInRange(range));
-   * ```
-   */
   newDataValidation() {
     return new D();
   }
+  /**
+   * @ignore
+   */
   // eslint-disable-next-line max-lines-per-function
   _initialize(e) {
     if (!e.has(V)) return;

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

@@ -2,14 +2,15 @@ import { IDataValidationRule, IDataValidationRuleOptions, DataValidationType } f
 import { FRange } from '@univerjs/sheets/facade';
 import { FDataValidation } from './f-data-validation';
 /**
- * Builder for data validation rules.
+ * Builder for data validation rules. use {@link FUniver} `univerAPI.newDataValidation()` to create a new builder.
  * @example
  * ```typescript
  * // Set the data validation for cell A1 to require a value from B1:B10
  * const range = FRange.create('Sheet1', 'B1:B10');
- * const rule = FUniver.newDataValidation().requireValueInRange(range).build();
+ * const rule = univerAPI.newDataValidation().requireValueInRange(range).build();
  * cell.setDataValidation(rule);
  * ```
+ * @hideconstructor
  */
 export declare class FDataValidationBuilder {
     private _rule;

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

@@ -1,6 +1,9 @@
 import { DataValidationOperator, DataValidationType, IDataValidationRule, IDataValidationRuleOptions, Injector, Worksheet } from '@univerjs/core';
 import { FRange } from '@univerjs/sheets/facade';
 import { FDataValidationBuilder } from './f-data-validation-builder';
+/**
+ * @hideconstructor
+ */
 export declare class FDataValidation {
     rule: IDataValidationRule;
     private _worksheet;
@@ -12,10 +15,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const allowsInvalid = dataValidation.getAllowInvalid();
      * ```
      */
@@ -26,10 +29,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const type = dataValidation.getCriteriaType();
      * ```
      */
@@ -40,10 +43,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const [operator, formula1, formula2] = dataValidation.getCriteriaValues();
      * ```
      */
@@ -54,10 +57,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const helpText = dataValidation.getHelpText();
      * ```
      */
@@ -68,10 +71,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const builder = dataValidation.copy();
      * const newRule = builder.setAllowInvalid(true).build();
      * ```
@@ -83,10 +86,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const isApplied = dataValidation.getApplied();
      * ```
      */
@@ -97,10 +100,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const ranges = dataValidation.getRanges();
      * ```
      */
@@ -111,10 +114,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const unitId = dataValidation.getUnitId();
      * ```
      */
@@ -125,10 +128,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const sheetId = dataValidation.getSheetId();
      * ```
      */
@@ -142,10 +145,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * dataValidation.setCriteria(
      *   DataValidationType.DECIMAL,
      *   [DataValidationOperator.BETWEEN, '1', '10'],
@@ -161,10 +164,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * dataValidation.setOptions({
      *   allowBlank: true,
      *   showErrorMessage: true,
@@ -180,10 +183,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const range = FRange.create('Sheet1', 'A1:B10');
      * dataValidation.setRanges([range]);
      * ```
@@ -195,10 +198,10 @@ export declare class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const isDeleted = dataValidation.delete();
      * ```
      */

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

@@ -132,6 +132,9 @@ export interface IBeforeSheetDataValidationDeleteAllEvent extends IEventBase {
     /** Array of all validation rules to be deleted */
     rules: FDataValidation[];
 }
+/**
+ * @ignore
+ */
 export interface IDataValidationEventParamConfig {
     SheetDataValidationChanged: ISheetDataValidationChangedEvent;
     SheetDataValidatorStatusChanged: ISheetDataValidatorStatusChangedEvent;
@@ -142,6 +145,9 @@ export interface IDataValidationEventParamConfig {
     BeforeSheetDataValidationRangeUpdate: IBeforeSheetDataValidationRangeUpdateEvent;
     BeforeSheetDataValidationOptionsUpdate: IBeforeSheetDataValidationOptionsUpdateEvent;
 }
+/**
+ * @ignore
+ */
 interface IDataValidationEvent {
     /**
      * Event fired when a rule is added, deleted, or modified
@@ -240,6 +246,9 @@ interface IDataValidationEvent {
      */
     readonly BeforeSheetDataValidationOptionsUpdate: 'BeforeSheetDataValidationOptionsUpdate';
 }
+/**
+ * @ignore
+ */
 export declare class FDataValidationEvent implements IDataValidationEvent {
     get SheetDataValidationChanged(): 'SheetDataValidationChanged';
     get SheetDataValidatorStatusChanged(): 'SheetDataValidatorStatusChanged';
@@ -250,6 +259,9 @@ export declare class FDataValidationEvent implements IDataValidationEvent {
     get BeforeSheetDataValidationRangeUpdate(): 'BeforeSheetDataValidationRangeUpdate';
     get BeforeSheetDataValidationOptionsUpdate(): 'BeforeSheetDataValidationOptionsUpdate';
 }
+/**
+ * @ignore
+ */
 export interface IDataValidationEventConfig {
     SheetDataValidationChanged: ISheetDataValidationChangedEvent;
     SheetDataValidatorStatusChanged: ISheetDataValidatorStatusChangedEvent;

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

@@ -1,6 +1,9 @@
 import { DataValidationStatus, Nullable } from '@univerjs/core';
 import { FRange } from '@univerjs/sheets/facade';
 import { FDataValidation } from './f-data-validation';
+/**
+ * @ignore
+ */
 export interface IFRangeDataValidationMixin {
     /**
      * Set a data validation rule to current range. if rule is null, clear data validation rule.
@@ -47,6 +50,9 @@ export interface IFRangeDataValidationMixin {
      */
     getValidatorStatus(): Promise<DataValidationStatus[][]>;
 }
+/**
+ * @ignore
+ */
 export declare class FRangeDataValidationMixin extends FRange implements IFRangeDataValidationMixin {
     setDataValidation(rule: Nullable<FDataValidation>): FRange;
     getDataValidation(): Nullable<FDataValidation>;

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

@@ -1,11 +1,9 @@
 import { Injector, FUniver } from '@univerjs/core';
 import { FDataValidationBuilder } from './f-data-validation-builder';
-export declare class FUnvierDataValidationMixin extends FUniver {
-    /**
-    /**
-     * @deprecated use `univerAPI.newDataValidation()` as instead.
-     */
-    static newDataValidation(): FDataValidationBuilder;
+/**
+ * @ignore
+ */
+export interface IFUnvierDataValidationMixin {
     /**
      * Creates a new instance of FDataValidationBuilder
      * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
@@ -16,10 +14,30 @@ export declare class FUnvierDataValidationMixin extends FUniver {
      * ```
      */
     newDataValidation(): FDataValidationBuilder;
+}
+export declare class FUnvierDataValidationMixin extends FUniver implements IFUnvierDataValidationMixin {
+    /**
+     * @deprecated use `univerAPI.newDataValidation()` as instead.
+     * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
+     */
+    static newDataValidation(): FDataValidationBuilder;
+    newDataValidation(): FDataValidationBuilder;
+    /**
+     * @ignore
+     */
     _initialize(injector: Injector): void;
 }
 declare module '@univerjs/core' {
+    /**
+     * @ignore
+     */
     namespace FUniver {
+        /**
+         * @deprecated use `univerAPI.newDataValidation()` as instead.
+         * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
+         */
         function newDataValidation(): FDataValidationBuilder;
     }
+    interface FUniver extends IFUnvierDataValidationMixin {
+    }
 }

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

@@ -2,6 +2,9 @@ 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
+ */
 export interface IFWorkbookDataValidationMixin {
     /**
      * Get data validation validator status for current workbook.
@@ -45,6 +48,9 @@ export interface IFWorkbookDataValidationMixin {
      */
     onBeforeDeleteAllDataValidation(this: FWorkbook, callback: (params: IRemoveSheetAllDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
 }
+/**
+ * @ignore
+ */
 export declare class FWorkbookDataValidationMixin extends FWorkbook implements IFWorkbookDataValidationMixin {
     _dataValidationModel: SheetDataValidationModel;
     _initialize(): void;

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

@@ -1,6 +1,9 @@
 import { DataValidationStatus, Nullable, ObjectMatrix } from '@univerjs/core';
 import { FWorksheet } from '@univerjs/sheets/facade';
 import { FDataValidation } from './f-data-validation';
+/**
+ * @ignore
+ */
 export interface IFWorksheetDataValidationMixin {
     /**
      * Get all data validation rules in current sheet.
@@ -38,6 +41,9 @@ export interface IFWorksheetDataValidationMixin {
      */
     getDataValidation(ruleId: string): Nullable<FDataValidation>;
 }
+/**
+ * @ignore
+ */
 export declare class FWorksheetDataValidationMixin extends FWorksheet implements IFWorksheetDataValidationMixin {
     getDataValidations(): FDataValidation[];
     getValidatorStatus(): Promise<ObjectMatrix<Nullable<DataValidationStatus>>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-data-validation",
-  "version": "0.5.5",
+  "version": "0.6.0-alpha.0",
   "private": false,
   "description": "Data validation for Univer Sheets",
   "author": "DreamNum <developer@univer.ai>",
@@ -53,20 +53,20 @@
     "rxjs": ">=7.0.0"
   },
   "dependencies": {
-    "@univerjs/protocol": "0.1.40",
-    "@univerjs/core": "0.5.5",
-    "@univerjs/engine-formula": "0.5.5",
-    "@univerjs/data-validation": "0.5.5",
-    "@univerjs/sheets": "0.5.5",
-    "@univerjs/sheets-formula": "0.5.5"
+    "@univerjs/protocol": "0.1.43",
+    "@univerjs/core": "0.6.0-alpha.0",
+    "@univerjs/data-validation": "0.6.0-alpha.0",
+    "@univerjs/sheets": "0.6.0-alpha.0",
+    "@univerjs/engine-formula": "0.6.0-alpha.0",
+    "@univerjs/sheets-formula": "0.6.0-alpha.0"
   },
   "devDependencies": {
     "less": "^4.2.1",
     "rxjs": "^7.8.1",
-    "typescript": "^5.7.2",
+    "typescript": "^5.7.3",
     "vite": "^6.0.7",
     "vitest": "^2.1.8",
-    "@univerjs-infra/shared": "0.5.5"
+    "@univerjs-infra/shared": "0.6.0-alpha.0"
   },
   "scripts": {
     "dev": "vite",