@univerjs/sheets-data-validation 0.4.2 → 0.5.0-alpha.0

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

@@ -0,0 +1,247 @@
+import { IDataValidationRule, IDataValidationRuleOptions, DataValidationOperator, DataValidationType } from '@univerjs/core';
+import { FRange } from '@univerjs/sheets/facade';
+import { FDataValidation } from './f-data-validation';
+/**
+ * Builder for data validation rules.
+ *
+ *     Set the data validation for cell A1 to require a value from B1:B10.
+ *     var rule = FUniver.newDataValidation().requireValueInRange(range).build();
+ *     cell.setDataValidation(rule);
+ */
+export declare class FDataValidationBuilder {
+    private _rule;
+    constructor(rule?: IDataValidationRule);
+    /**
+     * Builds an FDataValidation instance based on the _rule property of the current class
+     *
+     * @returns {FDataValidation} A new instance of the FDataValidation class
+     */
+    build(): FDataValidation;
+    /**
+     * Creates a duplicate of the current DataValidationBuilder object
+     *
+     * @return {FDataValidationBuilder} A new instance of the DataValidationBuilder class
+     */
+    copy(): FDataValidationBuilder;
+    /**
+     * Determines whether invalid data is allowed
+     *
+     * @returns {boolean} True if invalid data is allowed, False otherwise
+     */
+    getAllowInvalid(): boolean;
+    /**
+     * Gets the data validation type of the rule
+     *
+     * @returns {DataValidationType} The data validation type
+     */
+    getCriteriaType(): DataValidationType;
+    /**
+     * Gets the values used for criteria evaluation
+     *
+     * @returns {any[]} An array containing the operator, formula1, and formula2 values
+     */
+    getCriteriaValues(): any[];
+    /**
+     * 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(): string | undefined;
+    /**
+     * 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
+     */
+    requireCheckbox(checkedValue?: string, uncheckedValue?: string): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireDateAfter(date: Date): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireDateBefore(date: Date): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireDateBetween(start: Date, end: Date): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireDateEqualTo(date: Date): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireDateNotBetween(start: Date, end: Date): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireDateOnOrAfter(date: Date): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireDateOnOrBefore(date: Date): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    requireFormulaSatisfied(formula: string): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    requireNumberBetween(start: number, end: number, isInteger?: boolean): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    requireNumberEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    requireNumberGreaterThan(num: number, isInteger?: boolean): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    requireNumberGreaterThanOrEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    requireNumberLessThan(num: number, isInteger?: boolean): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireNumberLessThanOrEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireNumberNotBetween(start: number, end: number, isInteger?: boolean): FDataValidationBuilder;
+    /**
+     * 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
+     */
+    requireNumberNotEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    requireValueInList(values: string[], multiple?: boolean, showDropdown?: boolean): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    requireValueInRange(range: FRange, multiple?: boolean, showDropdown?: boolean): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    setAllowInvalid(allowInvalidData: boolean): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    setHelpText(helpText: string): FDataValidationBuilder;
+    /**
+     * 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.
+     */
+    withCriteriaValues(type: DataValidationType, values: [DataValidationOperator, string, string]): this;
+    /**
+     * 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.
+     */
+    setOptions(options: Partial<IDataValidationRuleOptions>): this;
+}

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

@@ -0,0 +1,88 @@
+import { DataValidationOperator, DataValidationType, IDataValidationRule, IDataValidationRuleOptions } from '@univerjs/core';
+import { FWorksheet, FRange } from '@univerjs/sheets/facade';
+import { FDataValidationBuilder } from './f-data-validation-builder';
+export declare class FDataValidation {
+    rule: IDataValidationRule;
+    private _worksheet;
+    constructor(rule: IDataValidationRule, worksheet?: FWorksheet);
+    /**
+     * Gets whether invalid data is allowed based on the error style value.
+     *
+     * @return true if invalid data is allowed, false otherwise.
+     */
+    getAllowInvalid(): boolean;
+    /**
+     * Gets the data validation type of the rule
+     *
+     * @returns The data validation type
+     */
+    getCriteriaType(): DataValidationType;
+    /**
+     * Gets the values used for criteria evaluation
+     *
+     * @returns An array containing the operator, formula1, and formula2 values
+     */
+    getCriteriaValues(): (string | undefined)[];
+    /**
+     * 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(): string | undefined;
+    /**
+     * 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.
+     */
+    copy(): FDataValidationBuilder;
+    /**
+     * Gets whether the data validation rule is applied to the worksheet.
+     *
+     * @returns true if the rule is applied, false otherwise.
+     */
+    getApplied(): boolean;
+    /**
+     * 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(): FRange[];
+    /**
+     * Gets the title of the error message dialog box.
+     *
+     * @returns The title of the error message dialog box.
+     */
+    getUnitId(): string | undefined;
+    /**
+     * Gets the sheetId of the worksheet.
+     *
+     * @returns The sheetId of the worksheet.
+     */
+    getSheetId(): string | undefined;
+    /**
+     * 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.
+     * @returns true if the criteria is set successfully, false otherwise.
+     */
+    setCriteria(type: DataValidationType, values: [DataValidationOperator, string, string]): boolean;
+    /**
+     * Set the options for the data validation rule.
+     * For details of options, please refer to https://univer.ai/typedoc/@univerjs/core/interfaces/IDataValidationRuleOptions
+     * @param options An object containing the options to set. `IDataValidationRuleOptions`
+     * @returns true if the options are set successfully, false otherwise.
+     */
+    setOptions(options: Partial<IDataValidationRuleOptions>): boolean;
+    /**
+     * Set the ranges to the data validation rule.
+     * @param ranges new ranges array.
+     * @returns true if the ranges are set successfully, false otherwise.
+     */
+    setRanges(ranges: FRange[]): boolean;
+    /**
+     * Delete the data validation rule from the worksheet.
+     * @returns true if the rule is deleted successfully, false otherwise.
+     */
+    delete(): boolean;
+}

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

@@ -0,0 +1,33 @@
+import { DataValidationStatus, Nullable } from '@univerjs/core';
+import { FRange } from '@univerjs/sheets/facade';
+import { FDataValidation } from './f-data-validation';
+interface IFRangeDataValidationMixin {
+    /**
+     * 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>): Promise<FRange>;
+    /**
+     * 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
+     * @returns all data validation rules
+     */
+    getDataValidations(this: FRange): FDataValidation[];
+    getValidatorStatus(): Promise<Promise<DataValidationStatus>[][]>;
+}
+export declare class FRangeDataValidationMixin extends FRange implements IFRangeDataValidationMixin {
+    setDataValidation(rule: Nullable<FDataValidation>): Promise<FRange>;
+    getDataValidation(): Nullable<FDataValidation>;
+    getDataValidations(): FDataValidation[];
+    getValidatorStatus(): Promise<Promise<DataValidationStatus>[][]>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FRange extends IFRangeDataValidationMixin {
+    }
+}
+export {};

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

@@ -0,0 +1,6 @@
+import { FDataValidationBuilder } from './f-data-validation-builder';
+declare module '@univerjs/core' {
+    namespace FUniver {
+        function newDataValidation(): FDataValidationBuilder;
+    }
+}

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

@@ -0,0 +1,64 @@
+import { IRuleChange } from '@univerjs/data-validation';
+import { IAddSheetDataValidationCommandParams, IDataValidationResCache, IRemoveSheetAllDataValidationCommandParams, IRemoveSheetDataValidationCommandParams, IUpdateSheetDataValidationOptionsCommandParams, IUpdateSheetDataValidationRangeCommandParams, IUpdateSheetDataValidationSettingCommandParams, IValidStatusChange } from '@univerjs/sheets-data-validation';
+import { IDisposable, IExecutionOptions, Nullable, ObjectMatrix } from '@univerjs/core';
+import { FWorkbook } from '@univerjs/sheets/facade';
+interface IFWorkbookDataValidationMixin {
+    /**
+     * get data validation validator status for current workbook
+     * @returns matrix of validator status
+     */
+    getValidatorStatus(this: FWorkbook): Promise<Record<string, ObjectMatrix<Nullable<IDataValidationResCache>>>>;
+    /**
+     * 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(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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorkbook extends IFWorkbookDataValidationMixin {
+    }
+}
+export {};

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

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

package/lib/types/facade/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import './f-range';
+import './f-univer';
+import './f-workbook';
+import './f-worksheet';
+export { FDataValidation } from './f-data-validation';
+export { FDataValidationBuilder } from './f-data-validation-builder';

package/lib/types/services/dv-custom-formula.service.d.ts

@@ -1,6 +1,5 @@
-import { IRange, ISheetDataValidationRule, Disposable, Injector, IUniverInstanceService } from '@univerjs/core';
+import { ISheetDataValidationRule, Disposable, IUniverInstanceService } from '@univerjs/core';
 import { DataValidationModel } from '@univerjs/data-validation';
-import { LexerTreeBuilder } from '@univerjs/engine-formula';
 import { RegisterOtherFormulaService } from '@univerjs/sheets-formula';
 import { DataValidationCacheService } from './dv-cache.service';
 interface IFormulaData {
@@ -8,34 +7,25 @@ interface IFormulaData {
     originRow: number;
     originCol: number;
     isTransformable: boolean;
-    formulaId?: string;
+    formulaId: string;
 }
 export declare class DataValidationCustomFormulaService extends Disposable {
     private readonly _instanceSrv;
     private _registerOtherFormulaService;
-    private _lexerTreeBuilder;
     private readonly _dataValidationModel;
     private readonly _dataValidationCacheService;
-    private readonly _injector;
-    private _formulaMap;
     /**
      * Map of origin formula of rule
      */
     private _ruleFormulaMap;
-    /**
-     * reflect of formulaId to cell, only store transformable formula
-     */
-    private _formulaCellMap;
-    constructor(_instanceSrv: IUniverInstanceService, _registerOtherFormulaService: RegisterOtherFormulaService, _lexerTreeBuilder: LexerTreeBuilder, _dataValidationModel: DataValidationModel, _dataValidationCacheService: DataValidationCacheService, _injector: Injector);
+    constructor(_instanceSrv: IUniverInstanceService, _registerOtherFormulaService: RegisterOtherFormulaService, _dataValidationModel: DataValidationModel, _dataValidationCacheService: DataValidationCacheService);
     private _initFormulaResultHandler;
     private _ensureMaps;
     private _registerFormula;
     deleteByRuleId(unitId: string, subUnitId: string, ruleId: string): void;
     private _addFormulaByRange;
     addRule(unitId: string, subUnitId: string, rule: ISheetDataValidationRule): void;
-    updateRuleRanges(unitId: string, subUnitId: string, ruleId: string, oldRanges: IRange[], newRanges: IRange[]): void;
-    updateRuleFormula(unitId: string, subUnitId: string, ruleId: string, ranges: IRange[], formula: string): void;
-    getCellFormulaValue(unitId: string, subUnitId: string, row: number, col: number): Promise<import('@univerjs/core').Nullable<import('@univerjs/sheets-formula').IOtherFormulaResult>>;
+    getCellFormulaValue(unitId: string, subUnitId: string, ruleId: string, row: number, column: number): Promise<import('@univerjs/core').Nullable<import('@univerjs/core').ICellData>>;
     getRuleFormulaInfo(unitId: string, subUnitId: string, ruleId: string): IFormulaData | undefined;
 }
 export {};

package/lib/types/services/dv-formula.service.d.ts

@@ -1,4 +1,4 @@
-import { Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { IRange, Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
 import { IFormulaInfo, IOtherFormulaResult, RegisterOtherFormulaService } from '@univerjs/sheets-formula';
 import { DataValidationModel } from '@univerjs/data-validation';
 import { DataValidationCacheService } from './dv-cache.service';
@@ -11,9 +11,10 @@ export declare class DataValidationFormulaService extends Disposable {
     constructor(_instanceService: IUniverInstanceService, _registerOtherFormulaService: RegisterOtherFormulaService, _dataValidationCacheService: DataValidationCacheService, _dataValidationModel: DataValidationModel);
     private _initFormulaResultHandler;
     private _ensureRuleFormulaMap;
-    addRule(unitId: string, subUnitId: string, ruleId: string, formula1: string | undefined, formula2: string | undefined): void;
+    private _registerSingleFormula;
+    addRule(unitId: string, subUnitId: string, ruleId: string, formula1: string | undefined, formula2: string | undefined, ranges: IRange[]): void;
     removeRule(unitId: string, subUnitId: string, ruleId: string): void;
-    updateRuleFormulaText(unitId: string, subUnitId: string, ruleId: string, formula1: string | undefined, formula2: string | undefined): void;
+    updateRuleFormulaText(unitId: string, subUnitId: string, ruleId: string, formula1: string | undefined, formula2: string | undefined, ranges: IRange[]): void;
     getRuleFormulaResult(unitId: string, subUnitId: string, ruleId: string): Promise<Nullable<[Nullable<IOtherFormulaResult>, Nullable<IOtherFormulaResult>]>>;
     getRuleFormulaResultSync(unitId: string, subUnitId: string, ruleId: string): Nullable<IOtherFormulaResult>[] | undefined;
     getRuleFormulaInfo(unitId: string, subUnitId: string, ruleId: string): [IFormulaInfo | undefined, IFormulaInfo | undefined] | undefined;

package/lib/types/validators/checkbox-validator.d.ts

@@ -16,18 +16,15 @@ export declare class CheckboxValidator extends BaseDataValidator {
     skipDefaultFontRender: (rule: ISheetDataValidationRule, cellValue: Nullable<CellValue>, pos: {
         unitId: string;
         subUnitId: string;
+        row: number;
+        column: number;
     }) => boolean;
     validatorFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): IFormulaValidResult;
     parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<ICheckboxFormulaResult>;
     getExtraStyle(rule: IDataValidationRule, value: Nullable<CellValue>): {
         tb: WrapStrategy;
     };
-    parseFormulaSync(rule: IDataValidationRule, unitId: string, subUnitId: string): {
-        formula1: Nullable<CellValue>;
-        formula2: Nullable<CellValue>;
-        originFormula1: Nullable<CellValue>;
-        originFormula2: Nullable<CellValue>;
-    };
+    parseFormulaSync(rule: IDataValidationRule, unitId: string, subUnitId: string): ICheckboxFormulaResult;
     isValidType(cellInfo: IValidatorCellInfo<CellValue>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
     generateRuleErrorMessage(rule: IDataValidationRuleBase): string;
 }

package/lib/types/validators/decimal-validator.d.ts

@@ -21,11 +21,7 @@ export declare class DecimalValidator extends BaseDataValidator<number> {
         t: Nullable<import('@univerjs/protocol').CellValueType>;
     };
     private _parseNumber;
-    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<{
-        formula1: number;
-        formula2: number;
-        isFormulaValid: boolean;
-    }>;
+    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<IFormulaResult>;
     validatorFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): IFormulaValidResult;
     validatorIsEqual(cellInfo: IValidatorCellInfo<CellValue>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
     validatorIsNotEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;

package/lib/types/validators/whole-validator.d.ts

@@ -20,11 +20,7 @@ export declare class WholeValidator extends BaseDataValidator<number> {
         t: Nullable<import('@univerjs/protocol').CellValueType>;
     };
     private _parseNumber;
-    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<{
-        formula1: number;
-        formula2: number;
-        isFormulaValid: boolean;
-    }>;
+    parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<IFormulaResult>;
     validatorFormula(rule: IDataValidationRuleBase, unitId: string, subUnitId: string): IFormulaValidResult;
     validatorIsEqual(cellInfo: IValidatorCellInfo<CellValue>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
     validatorIsNotEqual(cellInfo: IValidatorCellInfo<number>, formula: IFormulaResult, _rule: IDataValidationRule): Promise<boolean>;

package/lib/umd/facade.js

@@ -0,0 +1 @@
+(function(n,s){typeof exports=="object"&&typeof module<"u"?s(exports,require("@univerjs/sheets/facade"),require("@univerjs/sheets-data-validation"),require("@univerjs/core"),require("@univerjs/data-validation"),require("@univerjs/engine-formula"),require("rxjs")):typeof define=="function"&&define.amd?define(["exports","@univerjs/sheets/facade","@univerjs/sheets-data-validation","@univerjs/core","@univerjs/data-validation","@univerjs/engine-formula","rxjs"],s):(n=typeof globalThis<"u"?globalThis:n||self,s(n.UniverSheetsDataValidationFacade={},n.UniverSheetsFacade,n.UniverSheetsDataValidation,n.UniverCore,n.UniverDataValidation,n.UniverEngineFormula,n.rxjs))})(this,function(n,s,r,i,m,g,_){"use strict";var v=Object.defineProperty;var y=(n,s,r)=>s in n?v(n,s,{enumerable:!0,configurable:!0,writable:!0,value:r}):n[s]=r;var h=(n,s,r)=>y(n,typeof s!="symbol"?s+"":s,r);class l{constructor(t){h(this,"_rule");this._rule=t!=null?t:{uid:i.generateRandomId(),ranges:void 0,type:i.DataValidationType.CUSTOM}}build(){return new u(this._rule)}copy(){return new l({...this._rule,uid:i.generateRandomId()})}getAllowInvalid(){return this._rule.errorStyle!==i.DataValidationErrorStyle.STOP}getCriteriaType(){return this._rule.type}getCriteriaValues(){return[this._rule.operator,this._rule.formula1,this._rule.formula2]}getHelpText(){return this._rule.error}requireCheckbox(t,e){return this._rule.type=i.DataValidationType.CHECKBOX,this._rule.formula1=t,this._rule.formula2=e,this}requireDateAfter(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.operator=i.DataValidationOperator.GREATER_THAN,this}requireDateBefore(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.LESS_THAN,this}requireDateBetween(t,e){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=e.toLocaleDateString(),this._rule.operator=i.DataValidationOperator.BETWEEN,this}requireDateEqualTo(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.EQUAL,this}requireDateNotBetween(t,e){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=e.toLocaleDateString(),this._rule.operator=i.DataValidationOperator.NOT_BETWEEN,this}requireDateOnOrAfter(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.GREATER_THAN_OR_EQUAL,this}requireDateOnOrBefore(t){return this._rule.type=i.DataValidationType.DATE,this._rule.formula1=t.toLocaleDateString(),this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.LESS_THAN_OR_EQUAL,this}requireFormulaSatisfied(t){return this._rule.type=i.DataValidationType.CUSTOM,this._rule.formula1=t,this._rule.formula2=void 0,this}requireNumberBetween(t,e,a){return this._rule.formula1=`${t}`,this._rule.formula2=`${e}`,this._rule.operator=i.DataValidationOperator.BETWEEN,this._rule.type=a?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.EQUAL,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberGreaterThan(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.GREATER_THAN,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberGreaterThanOrEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.GREATER_THAN_OR_EQUAL,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberLessThan(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.LESS_THAN,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberLessThanOrEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.LESS_THAN_OR_EQUAL,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberNotBetween(t,e,a){return this._rule.formula1=`${t}`,this._rule.formula2=`${e}`,this._rule.operator=i.DataValidationOperator.NOT_BETWEEN,this._rule.type=a?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireNumberNotEqualTo(t,e){return this._rule.formula1=`${t}`,this._rule.formula2=void 0,this._rule.operator=i.DataValidationOperator.NOT_EQUAL,this._rule.type=e?i.DataValidationType.WHOLE:i.DataValidationType.DECIMAL,this}requireValueInList(t,e,a){return this._rule.type=e?i.DataValidationType.LIST_MULTIPLE:i.DataValidationType.LIST,this._rule.formula1=t.join(","),this._rule.formula2=void 0,this._rule.showDropDown=a!=null?a:!0,this}requireValueInRange(t,e,a){return this._rule.type=e?i.DataValidationType.LIST_MULTIPLE:i.DataValidationType.LIST,this._rule.formula1=`=${g.serializeRangeToRefString({unitId:t.getUnitId(),sheetName:t.getSheetName(),range:t.getRange()})}`,this._rule.formula2=void 0,this._rule.showDropDown=a!=null?a:!0,this}setAllowInvalid(t){return this._rule.errorStyle=t?i.DataValidationErrorStyle.WARNING:i.DataValidationErrorStyle.STOP,this}setHelpText(t){return this._rule.error=t,this._rule.showErrorMessage=!0,this}withCriteriaValues(t,e){return this._rule.type=t,this._rule.operator=e[0],this._rule.formula1=e[1],this._rule.formula2=e[2],this}setOptions(t){return Object.assign(this._rule,t),this}}class u{constructor(t,e){h(this,"rule");h(this,"_worksheet");this.rule=t,this._worksheet=e}getAllowInvalid(){return this.rule.errorStyle!==i.DataValidationErrorStyle.STOP}getCriteriaType(){return this.rule.type}getCriteriaValues(){return[this.rule.operator,this.rule.formula1,this.rule.formula2]}getHelpText(){return this.rule.error}copy(){return new l(this.rule)}getApplied(){if(!this._worksheet)return!1;const e=this._worksheet.getInject().get(m.DataValidationModel).getRuleById(this._worksheet.getWorkbook().getUnitId(),this._worksheet.getSheetId(),this.rule.uid);return!!(e&&e.ranges.length)}getRanges(){var o;if(!this.getAllowInvalid())return[];const t=(o=this._worksheet)==null?void 0:o.getWorkbook(),e=this.getSheetId();if(!e)return[];const a=t==null?void 0:t.getSheetBySheetId(e);return!t||!a?[]:this.rule.ranges.map(I=>{var p;return(p=this._worksheet)==null?void 0:p.getInject().createInstance(s.FRange,t,a,I)})}getUnitId(){var t;return(t=this._worksheet)==null?void 0:t.getWorkbook().getUnitId()}getSheetId(){var t;return(t=this._worksheet)==null?void 0:t.getSheetId()}setCriteria(t,e){return this.getApplied()&&!this._worksheet.getInject().get(i.ICommandService).syncExecuteCommand(r.UpdateSheetDataValidationSettingCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,setting:{operator:e[0],formula1:e[1],formula2:e[2],type:this.rule.type}})?!1:(this.rule.operator=e[0],this.rule.formula1=e[1],this.rule.formula2=e[2],this.rule.type=t,!0)}setOptions(t){return this.getApplied()&&!this._worksheet.getInject().get(i.ICommandService).syncExecuteCommand(r.UpdateSheetDataValidationOptionsCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,options:{...m.getRuleOptions(this.rule),...t}})?!1:(Object.assign(this.rule,t),!0)}setRanges(t){return this.getApplied()&&!this._worksheet.getInject().get(i.ICommandService).syncExecuteCommand(r.UpdateSheetDataValidationRangeCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid,ranges:t.map(o=>o.getRange())})?!1:(this.rule.ranges=t,!0)}delete(){return this.getApplied()?this._worksheet.getInject().get(i.ICommandService).syncExecuteCommand(r.RemoveSheetDataValidationCommand.id,{unitId:this.getUnitId(),subUnitId:this.getSheetId(),ruleId:this.rule.uid}):!1}}class f extends s.FRange{async setDataValidation(t){if(!t)return this._commandService.executeCommand(r.ClearRangeDataValidationCommand.id,{unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),ranges:[this._range]}),this;const e={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),rule:{...t.rule,ranges:[this._range]}};return await this._commandService.executeCommand(r.AddSheetDataValidationCommand.id,e),this}getDataValidation(){const e=this._injector.get(r.SheetsDataValidationValidatorService).getDataValidation(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range]);return e&&new u(e)}getDataValidations(){return this._injector.get(r.SheetsDataValidationValidatorService).getDataValidations(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range]).map(e=>new u(e))}async getValidatorStatus(){return this._injector.get(r.SheetsDataValidationValidatorService).validatorRanges(this._workbook.getUnitId(),this._worksheet.getSheetId(),[this._range])}}s.FRange.extend(f);class D{static newDataValidation(){return new l}}i.FUniver.extend(D);class S extends s.FWorkbook{_initialize(){Object.defineProperty(this,"_dataValidationModel",{get(){return this._injector.get(r.SheetDataValidationModel)}})}getValidatorStatus(){return this._injector.get(r.SheetsDataValidationValidatorService).validatorWorkbook(this._workbook.getUnitId())}onDataValidationChange(t){return i.toDisposable(this._dataValidationModel.ruleChange$.pipe(_.filter(e=>e.unitId===this._workbook.getUnitId())).subscribe(t))}onDataValidationStatusChange(t){return i.toDisposable(this._dataValidationModel.validStatusChange$.pipe(_.filter(e=>e.unitId===this._workbook.getUnitId())).subscribe(t))}onBeforeAddDataValidation(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.AddSheetDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeAddDataValidation")}}))}onBeforeUpdateDataValidationCriteria(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.UpdateSheetDataValidationSettingCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationCriteria")}}))}onBeforeUpdateDataValidationRange(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.UpdateSheetDataValidationRangeCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationRange")}}))}onBeforeUpdateDataValidationOptions(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.UpdateSheetDataValidationOptionsCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeUpdateDataValidationOptions")}}))}onBeforeDeleteDataValidation(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.RemoveSheetDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeDeleteDataValidation")}}))}onBeforeDeleteAllDataValidation(t){return i.toDisposable(this._commandService.beforeCommandExecuted((e,a)=>{const o=e.params;if(e.id===r.RemoveSheetAllDataValidationCommand.id){if(o.unitId!==this._workbook.getUnitId())return;if(t(o,a)===!1)throw new Error("Command is stopped by the hook onBeforeDeleteAllDataValidation")}}))}}s.FWorkbook.extend(S);class V extends s.FWorksheet{getDataValidations(){return this._injector.get(m.DataValidationModel).getRules(this._workbook.getUnitId(),this._worksheet.getSheetId()).map(e=>new u(e))}getValidatorStatus(){return this._injector.get(r.SheetsDataValidationValidatorService).validatorWorksheet(this._workbook.getUnitId(),this._worksheet.getSheetId())}}s.FWorksheet.extend(V),n.FDataValidation=u,n.FDataValidationBuilder=l,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})});