@univerjs/data-validation 0.1.6

package/lib/types/common/util.d.ts

@@ -0,0 +1,12 @@
+import { IAccessor } from '@wendellhu/redi';
+import { DataValidationOperator, DataValidationType, IDataValidationRule, IDataValidationRuleBase, IDataValidationRuleOptions } from '@univerjs/core';
+
+export declare function getRuleSetting(rule: IDataValidationRule): IDataValidationRuleBase;
+export declare function getRuleOptions(rule: IDataValidationRule): IDataValidationRuleOptions;
+export declare function createDefaultNewRule(accessor: IAccessor): {
+    uid: string;
+    type: DataValidationType;
+    operator: DataValidationOperator;
+    formula1: string;
+    ranges: import('@univerjs/core').IRange[];
+};

package/lib/types/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+export { UniverDataValidationPlugin } from './plugin';
+export { DataValidatorRegistryService, DataValidatorRegistryScope } from './services/data-validator-registry.service';
+export { DataValidationModel } from './models/data-validation-model';
+export { AddDataValidationCommand, RemoveDataValidationCommand, RemoveAllDataValidationCommand, UpdateDataValidationOptionsCommand, UpdateDataValidationSettingCommand, } from './commands/commands/data-validation.command';
+export type { IRemoveDataValidationCommandParams, IAddDataValidationCommandParams, IUpdateDataValidationOptionsCommandParams, IUpdateDataValidationSettingCommandParams, IRemoveAllDataValidationCommandParams, } from './commands/commands/data-validation.command';
+export { AddDataValidationMutation, RemoveDataValidationMutation, UpdateDataValidationMutation, } from './commands/mutations/data-validation.mutation';
+export type { IAddDataValidationMutationParams, IRemoveDataValidationMutationParams, IUpdateDataValidationMutationParams, } from './commands/mutations/data-validation.mutation';
+export { createDefaultNewRule, getRuleOptions, getRuleSetting, } from './common/util';
+export { UpdateRuleType } from './types/enum/update-rule-type';
+export type { IDataValidatorOperatorConfig } from './types/interfaces/i-data-validator-operator-config';
+export type { IFormulaInputProps, IFormulaValue, FormulaInputType } from './types/interfaces/i-formula-input';
+export type { IUpdateRuleOptionsPayload, IUpdateRulePayload, IUpdateRuleRangePayload, IUpdateRuleSettingPayload } from './types/interfaces/i-update-rule-payload';
+export type { IDataValidationDropdownProps } from './types/interfaces/i-data-validation-drop-down';
+export { BaseDataValidator } from './validators/base-data-validator';
+export type { IFormulaResult, IValidatorCellInfo } from './validators/base-data-validator';
+export type { IBaseDataValidationWidget } from './validators/base-widget';
+export { DataValidationManager } from './models/data-validation-manager';
+export type { IFormulaValidResult } from './validators/base-data-validator';
+export { removeDataValidationUndoFactory } from './commands/commands/data-validation.command';
+export { TWO_FORMULA_OPERATOR_COUNT } from './types/const/two-formula-operators';

package/lib/types/models/data-validation-manager.d.ts

@@ -0,0 +1,22 @@
+import { IUpdateRulePayload } from '../types/interfaces/i-update-rule-payload';
+import { CellValue, IDataValidationRule, Nullable, DataValidationStatus, Disposable } from '@univerjs/core';
+
+export declare class DataValidationManager<T extends IDataValidationRule> extends Disposable {
+    private _dataValidations;
+    private _dataValidationMap;
+    private _dataValidations$;
+    readonly unitId: string;
+    readonly subUnitId: string;
+    readonly dataValidations$: import('rxjs').Observable<T[]>;
+    constructor(unitId: string, subUnitId: string, dataValidations: T[] | undefined);
+    private _notice;
+    private _insertRules;
+    getRuleById(id: string): T | undefined;
+    getRuleIndex(id: string): number;
+    addRule(rule: T, index?: number): void;
+    removeRule(ruleId: string): void;
+    updateRule(ruleId: string, payload: IUpdateRulePayload): T;
+    getDataValidations(): T[];
+    toJSON(): T[];
+    validator(_content: Nullable<CellValue>, _rule: IDataValidationRule, _pos: any, _onCompele: (status: DataValidationStatus) => void): DataValidationStatus;
+}

package/lib/types/models/data-validation-model.d.ts

@@ -0,0 +1,39 @@
+import { DataValidationManager } from './data-validation-manager';
+import { IUpdateRulePayload } from '../types/interfaces/i-update-rule-payload';
+import { CellValue, DataValidationStatus, Disposable, IDataValidationRule, ILogService, Nullable } from '@univerjs/core';
+
+type RuleChangeType = 'update' | 'add' | 'remove';
+export interface IRuleChange<T extends IDataValidationRule> {
+    rule?: T;
+    type: RuleChangeType;
+    unitId: string;
+    subUnitId: string;
+}
+export interface IValidStatusChange {
+    unitId: string;
+    subUnitId: string;
+    ruleId: string;
+    status: DataValidationStatus;
+}
+export declare class DataValidationModel<T extends IDataValidationRule = IDataValidationRule> extends Disposable {
+    private readonly _logService;
+    private readonly _model;
+    private _managerCreator;
+    private readonly _ruleChange$;
+    private readonly _validStatusChange$;
+    ruleChange$: import('rxjs').Observable<IRuleChange<T>>;
+    ruleChangeDebounce$: import('rxjs').Observable<IRuleChange<T>>;
+    validStatusChange$: import('rxjs').Observable<IValidStatusChange>;
+    constructor(_logService: ILogService);
+    setManagerCreator(creator: (unitId: string, subUnitId: string) => DataValidationManager<T>): void;
+    ensureManager(unitId: string, subUnitId: string): DataValidationManager<T>;
+    addRule(unitId: string, subUnitId: string, rule: T, index?: number): void;
+    updateRule(unitId: string, subUnitId: string, ruleId: string, payload: IUpdateRulePayload): void;
+    removeRule(unitId: string, subUnitId: string, ruleId: string): void;
+    getRuleById(unitId: string, subUnitId: string, ruleId: string): T | undefined;
+    getRuleIndex(unitId: string, subUnitId: string, ruleId: string): number;
+    getRules(unitId: string, subUnitId: string): T[];
+    validator(content: Nullable<CellValue>, rule: T, pos: any): DataValidationStatus;
+    getUnitRules(unitId: string): [string, IDataValidationRule[]][];
+}
+export {};

package/lib/types/plugin.d.ts

@@ -0,0 +1,9 @@
+import { Injector } from '@wendellhu/redi';
+import { ICommandService, Plugin } from '@univerjs/core';
+
+export declare class UniverDataValidationPlugin extends Plugin {
+    protected _injector: Injector;
+    private _commandService;
+    constructor(_injector: Injector, _commandService: ICommandService);
+    onStarting(injector: Injector): void;
+}

package/lib/types/services/data-validator-registry.service.d.ts

@@ -0,0 +1,19 @@
+import { BaseDataValidator } from '../validators/base-data-validator';
+
+export declare enum DataValidatorRegistryScope {
+    SHEET = "sheet"
+}
+/**
+ * Register data validator
+ */
+export declare class DataValidatorRegistryService {
+    private _validatorByScopes;
+    private _validatorMap;
+    private _validatorsChange$;
+    validatorsChange$: import('rxjs').Observable<void>;
+    private _addValidatorToScope;
+    private _removeValidatorFromScope;
+    register(validator: BaseDataValidator<any>): import('@wendellhu/redi').IDisposable;
+    getValidatorItem(id: string): BaseDataValidator<import('@univerjs/core').CellValue> | undefined;
+    getValidatorsByScope(scope: string): BaseDataValidator<import('@univerjs/core').CellValue>[] | undefined;
+}

package/lib/types/types/const/operator-text-map.d.ts

@@ -0,0 +1,5 @@
+import { DataValidationOperator } from '@univerjs/core';
+
+export declare const OperatorTextMap: Record<DataValidationOperator, string>;
+export declare const OperatorTitleMap: Record<DataValidationOperator, string>;
+export declare const OperatorErrorTitleMap: Record<DataValidationOperator, string>;

package/lib/types/types/const/two-formula-operators.d.ts

@@ -0,0 +1,3 @@
+import { DataValidationOperator } from '@univerjs/core';
+
+export declare const TWO_FORMULA_OPERATOR_COUNT: DataValidationOperator[];

package/lib/types/types/enum/update-rule-type.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+export declare enum UpdateRuleType {
+    SETTING = 0,
+    RANGE = 1,
+    OPTIONS = 2
+}

package/lib/types/types/interfaces/i-data-validation-drop-down.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+export interface IDataValidationDropdownProps {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+    unitId: string;
+    subUnitId: string;
+    row: number;
+    col: number;
+}

package/lib/types/types/interfaces/i-data-validator-operator-config.d.ts

@@ -0,0 +1,9 @@
+import { DataValidationOperator } from '@univerjs/core';
+
+export interface IDataValidatorOperatorConfig {
+    operator: DataValidationOperator;
+    text: string;
+    placeholder1?: string;
+    placeholder2?: string;
+    formulaCount: 1 | 2;
+}

package/lib/types/types/interfaces/i-formula-input.d.ts

@@ -0,0 +1,16 @@
+import { IFormulaValidResult } from '../../validators/base-data-validator';
+
+export interface IFormulaValue {
+    formula1?: string;
+    formula2?: string;
+}
+export interface IFormulaInputProps {
+    isTwoFormula?: boolean;
+    value?: IFormulaValue;
+    onChange?: (value?: IFormulaValue) => void;
+    unitId: string;
+    subUnitId: string;
+    showError?: boolean;
+    validResult?: IFormulaValidResult;
+}
+export type FormulaInputType = React.ComponentType<IFormulaInputProps>;

package/lib/types/types/interfaces/i-update-rule-payload.d.ts

@@ -0,0 +1,16 @@
+import { UpdateRuleType } from '../enum/update-rule-type';
+import { IDataValidationRuleBase, IDataValidationRuleOptions } from '@univerjs/core';
+
+export interface IUpdateRuleRangePayload {
+    type: UpdateRuleType.RANGE;
+    payload: any[];
+}
+export interface IUpdateRuleSettingPayload {
+    type: UpdateRuleType.SETTING;
+    payload: IDataValidationRuleBase;
+}
+export interface IUpdateRuleOptionsPayload {
+    type: UpdateRuleType.OPTIONS;
+    payload: Partial<IDataValidationRuleOptions>;
+}
+export type IUpdateRulePayload = IUpdateRuleRangePayload | IUpdateRuleSettingPayload | IUpdateRuleOptionsPayload;

package/lib/types/validators/base-data-validator.d.ts

@@ -0,0 +1,53 @@
+import { IBaseDataValidationWidget } from './base-widget';
+import { Injector } from '@wendellhu/redi';
+import { CellValue, IDataValidationRule, IDataValidationRuleBase, Nullable, DataValidationOperator, LocaleService } from '@univerjs/core';
+
+export interface IValidatorCellInfo<DataType = Nullable<CellValue>> {
+    value: DataType;
+    row: number;
+    column: number;
+    unitId: string;
+    subUnitId: string;
+}
+export interface IFormulaResult<T = any> {
+    formula1: T;
+    formula2: T;
+}
+export interface IFormulaValidResult {
+    success: boolean;
+    formula1?: string;
+    formula2?: string;
+}
+export declare abstract class BaseDataValidator<DataType = CellValue> {
+    readonly localeService: LocaleService;
+    readonly injector: Injector;
+    abstract id: string;
+    abstract title: string;
+    abstract operators: DataValidationOperator[];
+    abstract scopes: string[] | string;
+    abstract formulaInput: string;
+    canvasRender: Nullable<IBaseDataValidationWidget>;
+    dropdown: string | undefined;
+    optionsInput: string | undefined;
+    constructor(localeService: LocaleService, injector: Injector);
+    get operatorNames(): string[];
+    get titleStr(): string;
+    skipDefaultFontRender(rule: IDataValidationRule, cellValue: Nullable<CellValue>, pos: any): boolean;
+    generateRuleName(rule: IDataValidationRuleBase): string;
+    generateRuleErrorMessage(rule: IDataValidationRuleBase): string;
+    getRuleFinalError(rule: IDataValidationRule): string;
+    isEmptyCellValue(cellValue: Nullable<CellValue>): cellValue is null | undefined | void;
+    abstract parseFormula(rule: IDataValidationRule, unitId: string, subUnitId: string): Promise<IFormulaResult>;
+    abstract validatorFormula(rule: IDataValidationRuleBase): IFormulaValidResult;
+    isValidType(cellInfo: IValidatorCellInfo, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    transform(cellInfo: IValidatorCellInfo, formula: IFormulaResult, rule: IDataValidationRule): IValidatorCellInfo<DataType>;
+    validatorIsEqual(cellInfo: IValidatorCellInfo<DataType>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    validatorIsNotEqual(cellInfo: IValidatorCellInfo<DataType>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    validatorIsBetween(cellInfo: IValidatorCellInfo<DataType>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    validatorIsNotBetween(cellInfo: IValidatorCellInfo<DataType>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    validatorIsGreaterThan(cellInfo: IValidatorCellInfo<DataType>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    validatorIsGreaterThanOrEqual(cellInfo: IValidatorCellInfo<DataType>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    validatorIsLessThan(cellInfo: IValidatorCellInfo<DataType>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    validatorIsLessThanOrEqual(cellInfo: IValidatorCellInfo<DataType>, formula: IFormulaResult, rule: IDataValidationRule): Promise<boolean>;
+    validator(cellInfo: IValidatorCellInfo, rule: IDataValidationRule): Promise<boolean>;
+}

package/lib/types/validators/base-widget.d.ts

@@ -0,0 +1,5 @@
+import { ICellCustomRender, ICellRenderContext } from '@univerjs/core';
+
+export interface IBaseDataValidationWidget extends ICellCustomRender {
+    calcCellAutoHeight(info: ICellRenderContext): number | undefined;
+}

package/lib/umd/index.js

@@ -0,0 +1 @@
+(function(l,n){typeof exports=="object"&&typeof module<"u"?n(exports,require("@univerjs/core"),require("@wendellhu/redi"),require("rxjs"),require("@univerjs/sheets")):typeof define=="function"&&define.amd?define(["exports","@univerjs/core","@wendellhu/redi","rxjs","@univerjs/sheets"],n):(l=typeof globalThis<"u"?globalThis:l||self,n(l.UniverDataValidation={},l.UniverCore,l["@wendellhu/redi"],l.rxjs,l.UniverSheets))})(this,function(l,n,h,E,b){"use strict";var ia=Object.defineProperty;var na=(l,n,h)=>n in l?ia(l,n,{enumerable:!0,configurable:!0,writable:!0,value:h}):l[n]=h;var p=(l,n,h)=>(na(l,typeof n!="symbol"?n+"":n,h),h);var M=(r=>(r.SHEET="sheet",r))(M||{});class T{constructor(){p(this,"_validatorByScopes",new Map);p(this,"_validatorMap",new Map);p(this,"_validatorsChange$",new E.BehaviorSubject(void 0));p(this,"validatorsChange$",this._validatorsChange$.asObservable())}_addValidatorToScope(t,a){this._validatorByScopes.has(a)||this._validatorByScopes.set(a,[]);const e=this._validatorByScopes.get(a);if(e.findIndex(i=>i.id===t.id)>-1)throw new Error(`Validator item with the same id ${t.id} has already been added!`);e.push(t)}_removeValidatorFromScope(t,a){const e=this._validatorByScopes.get(a);if(!e)return;const i=e.findIndex(o=>o.id===t.id);i>-1&&e.splice(i,1)}register(t){return this._validatorMap.set(t.id,t),Array.isArray(t.scopes)?t.scopes.forEach(a=>{this._addValidatorToScope(t,a)}):this._addValidatorToScope(t,t.scopes),this._validatorsChange$.next(),n.toDisposable(()=>{this._validatorMap.delete(t.id),Array.isArray(t.scopes)?t.scopes.forEach(a=>{this._removeValidatorFromScope(t,a)}):this._removeValidatorFromScope(t,t.scopes),this._validatorsChange$.next()})}getValidatorItem(t){return this._validatorMap.get(t)}getValidatorsByScope(t){return this._validatorByScopes.get(t)}}var $=Object.defineProperty,P=Object.getOwnPropertyDescriptor,q=(r,t,a,e)=>{for(var i=e>1?void 0:e?P(t,a):t,o=r.length-1,d;o>=0;o--)(d=r[o])&&(i=(e?d(t,a,i):d(i))||i);return e&&i&&$(t,a,i),i},j=(r,t)=>(a,e)=>t(a,e,r);l.DataValidationModel=class extends n.Disposable{constructor(a){super();p(this,"_model",new Map);p(this,"_managerCreator");p(this,"_ruleChange$",new E.Subject);p(this,"_validStatusChange$",new E.Subject);p(this,"ruleChange$",this._ruleChange$.asObservable());p(this,"ruleChangeDebounce$",this.ruleChange$.pipe(E.debounceTime(20)));p(this,"validStatusChange$",this._validStatusChange$.asObservable().pipe(E.debounceTime(20)));this._logService=a,this.disposeWithMe({dispose:()=>{this._ruleChange$.complete(),this._validStatusChange$.complete()}})}setManagerCreator(a){this._managerCreator=a}ensureManager(a,e){this._model.has(a)||this._model.set(a,new Map);const i=this._model.get(a);if(i.has(e))return i.get(e);const o=this._managerCreator(a,e);return i.set(e,o),o}addRule(a,e,i,o){try{this.ensureManager(a,e).addRule(i,o),this._ruleChange$.next({rule:i,type:"add",unitId:a,subUnitId:e})}catch(d){this._logService.error(d)}}updateRule(a,e,i,o){try{const s=this.ensureManager(a,e).updateRule(i,o);this._ruleChange$.next({rule:s,type:"update",unitId:a,subUnitId:e})}catch(d){this._logService.error(d)}}removeRule(a,e,i){try{const o=this.ensureManager(a,e),d=o.getRuleById(i);o.removeRule(i),this._ruleChange$.next({rule:d,type:"remove",unitId:a,subUnitId:e})}catch(o){this._logService.error(o)}}getRuleById(a,e,i){return this.ensureManager(a,e).getRuleById(i)}getRuleIndex(a,e,i){return this.ensureManager(a,e).getRuleIndex(i)}getRules(a,e){return this.ensureManager(a,e).getDataValidations()}validator(a,e,i){const{unitId:o,subUnitId:d}=i;return this.ensureManager(o,d).validator(a,e,i,c=>{this._validStatusChange$.next({unitId:o,subUnitId:d,ruleId:e.uid,status:c})})}getUnitRules(a){const e=this._model.get(a);if(!e)return[];const i=[];return e.forEach(o=>{i.push([o.subUnitId,o.getDataValidations()])}),i}},l.DataValidationModel=q([j(0,n.ILogService)],l.DataValidationModel);const g={type:n.CommandType.MUTATION,id:"data-validation.mutation.addRule",handler(r,t){if(!t)return!1;const{unitId:a,subUnitId:e,rule:i,index:o}=t,d=r.get(l.DataValidationModel);return Array.isArray(i)?i.forEach(s=>{d.addRule(a,e,s,o)}):d.addRule(a,e,i,o),!0}},v={type:n.CommandType.MUTATION,id:"data-validation.mutation.removeRule",handler(r,t){if(!t)return!1;const{unitId:a,subUnitId:e,ruleId:i}=t,o=r.get(l.DataValidationModel);return Array.isArray(i)?i.forEach(d=>{o.removeRule(a,e,d)}):o.removeRule(a,e,i),!0}},_={type:n.CommandType.MUTATION,id:"data-validation.mutation.updateRule",handler(r,t){if(!t)return!1;const{unitId:a,subUnitId:e,ruleId:i,payload:o}=t;return r.get(l.DataValidationModel).updateRule(a,e,i,o),!0}};function R(r){return{type:r.type,operator:r.operator,formula1:r.formula1,formula2:r.formula2,allowBlank:r.allowBlank}}function S(r){return{error:r.error,errorStyle:r.errorStyle,errorTitle:r.errorTitle,imeMode:r.imeMode,prompt:r.prompt,promptTitle:r.promptTitle,showDropDown:r.showDropDown,showErrorMessage:r.showErrorMessage,showInputMessage:r.showInputMessage,renderMode:r.renderMode}}function G(r){const a=r.get(b.SelectionManagerService).getSelectionRanges();return{uid:n.Tools.generateRandomId(6),type:n.DataValidationType.DECIMAL,operator:n.DataValidationOperator.EQUAL,formula1:"100",ranges:a!=null?a:[{startColumn:0,endColumn:0,startRow:0,endRow:0}]}}var V=(r=>(r[r.SETTING=0]="SETTING",r[r.RANGE=1]="RANGE",r[r.OPTIONS=2]="OPTIONS",r))(V||{});const I={type:n.CommandType.COMMAND,id:"data-validation.command.addRule",async handler(r,t){if(!t)return!1;const{rule:a,unitId:e,subUnitId:i}=t,o=r.get(n.ICommandService),d=r.get(n.IUndoRedoService),s={...t,rule:{...t.rule,ranges:[t.rule.range]}},c=[{id:g.id,params:s}],u=[{id:v.id,params:{unitId:e,subUnitId:i,ruleId:a.uid}}];return d.pushUndoRedo({unitID:e,redoMutations:c,undoMutations:u}),await o.executeCommand(g.id,s),!0}},H=(r,t)=>{const a=r.get(l.DataValidationModel),{unitId:e,subUnitId:i,ruleId:o}=t;if(Array.isArray(o)){const s=o.map(c=>a.getRuleById(e,i,c)).filter(Boolean);return[{id:g.id,params:{unitId:e,subUnitId:i,rule:s}}]}return[{id:g.id,params:{unitId:e,subUnitId:i,rule:{...a.getRuleById(e,i,o)},index:a.getRuleIndex(e,i,o)}}]},y={type:n.CommandType.COMMAND,id:"data-validation.command.removeRule",handler(r,t){if(!t)return!1;const{unitId:a,subUnitId:e,ruleId:i}=t,o=r.get(n.ICommandService),d=r.get(n.IUndoRedoService),s=r.get(l.DataValidationModel),c=[{id:v.id,params:t}],u=[{id:g.id,params:{unitId:a,subUnitId:e,rule:{...s.getRuleById(a,e,i)},index:s.getRuleIndex(a,e,i)}}];return d.pushUndoRedo({undoMutations:u,redoMutations:c,unitID:t.unitId}),o.executeCommand(v.id,t),!0}},A={type:n.CommandType.COMMAND,id:"data-validation.command.updateDataValidationSetting",handler(r,t){if(!t)return!1;const a=r.get(n.ICommandService),e=r.get(n.IUndoRedoService),i=r.get(l.DataValidationModel),{unitId:o,subUnitId:d,ruleId:s,options:c}=t,u=i.getRuleById(o,d,s);if(!u)return!1;const m={unitId:o,subUnitId:d,ruleId:s,payload:{type:V.OPTIONS,payload:c}},O=[{id:_.id,params:m}],f={unitId:o,subUnitId:d,ruleId:s,payload:{type:V.OPTIONS,payload:S(u)}},D=[{id:_.id,params:f}];return e.pushUndoRedo({unitID:o,redoMutations:O,undoMutations:D}),a.executeCommand(_.id,m),!0}},N={type:n.CommandType.COMMAND,id:"data-validation.command.updateDataValidationOptions",handler(r,t){if(!t)return!1;const a=r.get(n.ICommandService),e=r.get(n.IUndoRedoService),i=r.get(l.DataValidationModel),o=r.get(T),{unitId:d,subUnitId:s,ruleId:c,setting:u}=t,m=o.getValidatorItem(u.type);if(!m||!m.validatorFormula(u).success)return!1;const O=i.getRuleById(d,s,c);if(!O)return!1;const f={unitId:d,subUnitId:s,ruleId:c,payload:{type:V.SETTING,payload:u}},D=[{id:_.id,params:f}],ta={unitId:d,subUnitId:s,ruleId:c,payload:{type:V.SETTING,payload:R(O)}},ea=[{id:_.id,params:ta}];return e.pushUndoRedo({unitID:d,redoMutations:D,undoMutations:ea}),a.executeCommand(_.id,f),!0}},C={type:n.CommandType.COMMAND,id:"data-validation.command.removeAll",handler(r,t){if(!t)return!1;const{unitId:a,subUnitId:e}=t,i=r.get(n.ICommandService),o=r.get(l.DataValidationModel),d=r.get(n.IUndoRedoService),s=[...o.getRules(a,e)],c={unitId:a,subUnitId:e,ruleId:s.map(O=>O.uid)},u=[{id:v.id,params:c}],m=[{id:g.id,params:{unitId:a,subUnitId:e,rule:s}}];return d.pushUndoRedo({redoMutations:u,undoMutations:m,unitID:a}),i.executeCommand(v.id,c),!0}};var Q=Object.defineProperty,W=Object.getOwnPropertyDescriptor,F=(r,t,a,e)=>{for(var i=e>1?void 0:e?W(t,a):t,o=r.length-1,d;o>=0;o--)(d=r[o])&&(i=(e?d(t,a,i):d(i))||i);return e&&i&&Q(t,a,i),i},U=(r,t)=>(a,e)=>t(a,e,r);const J="data-validation";l.UniverDataValidationPlugin=class extends n.Plugin{constructor(t,a){super(J),this._injector=t,this._commandService=a}onStarting(t){[[l.DataValidationModel],[T]].forEach(a=>{t.add(a)}),[I,C,A,N,y,g,_,v].forEach(a=>{this._commandService.registerCommand(a)})}},l.UniverDataValidationPlugin=F([U(0,h.Inject(h.Injector)),U(1,n.ICommandService)],l.UniverDataValidationPlugin),n.DataValidationOperator.BETWEEN+"",n.DataValidationOperator.EQUAL+"",n.DataValidationOperator.GREATER_THAN+"",n.DataValidationOperator.GREATER_THAN_OR_EQUAL+"",n.DataValidationOperator.LESS_THAN+"",n.DataValidationOperator.LESS_THAN_OR_EQUAL+"",n.DataValidationOperator.NOT_BETWEEN+"",n.DataValidationOperator.NOT_EQUAL+"";const z={[n.DataValidationOperator.BETWEEN]:"dataValidation.ruleName.between",[n.DataValidationOperator.EQUAL]:"dataValidation.ruleName.equal",[n.DataValidationOperator.GREATER_THAN]:"dataValidation.ruleName.greaterThan",[n.DataValidationOperator.GREATER_THAN_OR_EQUAL]:"dataValidation.ruleName.greaterThanOrEqual",[n.DataValidationOperator.LESS_THAN]:"dataValidation.ruleName.lessThan",[n.DataValidationOperator.LESS_THAN_OR_EQUAL]:"dataValidation.ruleName.lessThanOrEqual",[n.DataValidationOperator.NOT_BETWEEN]:"dataValidation.ruleName.notBetween",[n.DataValidationOperator.NOT_EQUAL]:"dataValidation.ruleName.notEqual"},K={[n.DataValidationOperator.BETWEEN]:"dataValidation.errorMsg.between",[n.DataValidationOperator.EQUAL]:"dataValidation.errorMsg.equal",[n.DataValidationOperator.GREATER_THAN]:"dataValidation.errorMsg.greaterThan",[n.DataValidationOperator.GREATER_THAN_OR_EQUAL]:"dataValidation.errorMsg.greaterThanOrEqual",[n.DataValidationOperator.LESS_THAN]:"dataValidation.errorMsg.lessThan",[n.DataValidationOperator.LESS_THAN_OR_EQUAL]:"dataValidation.errorMsg.lessThanOrEqual",[n.DataValidationOperator.NOT_BETWEEN]:"dataValidation.errorMsg.notBetween",[n.DataValidationOperator.NOT_EQUAL]:"dataValidation.errorMsg.notEqual"};var X=Object.defineProperty,Y=Object.getOwnPropertyDescriptor,Z=(r,t,a,e)=>{for(var i=e>1?void 0:e?Y(t,a):t,o=r.length-1,d;o>=0;o--)(d=r[o])&&(i=(e?d(t,a,i):d(i))||i);return e&&i&&X(t,a,i),i},w=(r,t)=>(a,e)=>t(a,e,r);const L="{FORMULA1}",B="{FORMULA2}",x={[n.DataValidationOperator.BETWEEN]:"dataValidation.operators.between",[n.DataValidationOperator.EQUAL]:"dataValidation.operators.equal",[n.DataValidationOperator.GREATER_THAN]:"dataValidation.operators.greaterThan",[n.DataValidationOperator.GREATER_THAN_OR_EQUAL]:"dataValidation.operators.greaterThanOrEqual",[n.DataValidationOperator.LESS_THAN]:"dataValidation.operators.lessThan",[n.DataValidationOperator.LESS_THAN_OR_EQUAL]:"dataValidation.operators.lessThanOrEqual",[n.DataValidationOperator.NOT_BETWEEN]:"dataValidation.operators.notBetween",[n.DataValidationOperator.NOT_EQUAL]:"dataValidation.operators.notEqual"};l.BaseDataValidator=class{constructor(t,a){p(this,"canvasRender",null);p(this,"dropdown");p(this,"optionsInput");this.localeService=t,this.injector=a}get operatorNames(){return this.operators.map(t=>this.localeService.t(x[t]))}get titleStr(){return this.localeService.t(this.title)}skipDefaultFontRender(t,a,e){return!1}generateRuleName(t){var e,i;if(!t.operator)return this.titleStr;const a=this.localeService.t(z[t.operator]).replace(L,(e=t.formula1)!=null?e:"").replace(B,(i=t.formula2)!=null?i:"");return`${this.titleStr} ${a}`}generateRuleErrorMessage(t){var e,i;return t.operator?`${this.localeService.t(K[t.operator]).replace(L,(e=t.formula1)!=null?e:"").replace(B,(i=t.formula2)!=null?i:"")}`:this.titleStr}getRuleFinalError(t){return t.showInputMessage&&t.error?t.error:this.generateRuleErrorMessage(t)}isEmptyCellValue(t){return t===""||t===void 0||t===null}async isValidType(t,a,e){return!0}transform(t,a,e){return t}async validatorIsEqual(t,a,e){return!0}async validatorIsNotEqual(t,a,e){return!0}async validatorIsBetween(t,a,e){return!0}async validatorIsNotBetween(t,a,e){return!0}async validatorIsGreaterThan(t,a,e){return!0}async validatorIsGreaterThanOrEqual(t,a,e){return!0}async validatorIsLessThan(t,a,e){return!0}async validatorIsLessThanOrEqual(t,a,e){return!0}async validator(t,a){const{value:e,unitId:i,subUnitId:o}=t,d=this.isEmptyCellValue(e),{allowBlank:s=!0,operator:c}=a;if(d)return s;const u=await this.parseFormula(a,i,o);if(!await this.isValidType(t,u,a))return!1;if(!n.Tools.isDefine(c))return!0;const m=this.transform(t,u,a);switch(c){case n.DataValidationOperator.BETWEEN:return this.validatorIsBetween(m,u,a);case n.DataValidationOperator.EQUAL:return this.validatorIsEqual(m,u,a);case n.DataValidationOperator.GREATER_THAN:return this.validatorIsGreaterThan(m,u,a);case n.DataValidationOperator.GREATER_THAN_OR_EQUAL:return this.validatorIsGreaterThanOrEqual(m,u,a);case n.DataValidationOperator.LESS_THAN:return this.validatorIsLessThan(m,u,a);case n.DataValidationOperator.LESS_THAN_OR_EQUAL:return this.validatorIsLessThanOrEqual(m,u,a);case n.DataValidationOperator.NOT_BETWEEN:return this.validatorIsNotBetween(m,u,a);case n.DataValidationOperator.NOT_EQUAL:return this.validatorIsNotEqual(m,u,a);default:throw new Error("Unknown operator.")}}},l.BaseDataValidator=Z([w(0,h.Inject(n.LocaleService)),w(1,h.Inject(h.Injector))],l.BaseDataValidator);class k extends n.Disposable{constructor(a,e,i){super();p(this,"_dataValidations");p(this,"_dataValidationMap",new Map);p(this,"_dataValidations$",new E.Subject);p(this,"unitId");p(this,"subUnitId");p(this,"dataValidations$",this._dataValidations$.asObservable());this.unitId=a,this.subUnitId=e,i&&(this._insertRules(i),this._notice(),this.disposeWithMe({dispose:()=>{this._dataValidations$.complete()}}))}_notice(){this._dataValidations$.next(this._dataValidations)}_insertRules(a){this._dataValidations=a,a.forEach(e=>{this._dataValidationMap.set(e.uid,e)})}getRuleById(a){return this._dataValidationMap.get(a)}getRuleIndex(a){return this._dataValidations.findIndex(e=>e.uid===a)}addRule(a,e){typeof e=="number"&&e<this._dataValidations.length?this._dataValidations.splice(e,0,a):this._dataValidations.push(a),this._dataValidationMap.set(a.uid,a),this._notice()}removeRule(a){const e=this._dataValidations.findIndex(i=>i.uid===a);this._dataValidations.splice(e,1),this._dataValidationMap.delete(a),this._notice()}updateRule(a,e){const i=this._dataValidationMap.get(a),o=this._dataValidations.findIndex(s=>a===s.uid);if(!i)throw new Error(`Data validation rule is not found, ruleId: ${a}.`);const d={...i};switch(e.type){case V.RANGE:{d.ranges=e.payload;break}case V.SETTING:{Object.assign(d,e.payload);break}case V.OPTIONS:{Object.assign(d,e.payload);break}}return this._dataValidations[o]=d,this._dataValidationMap.set(a,d),this._notice(),d}getDataValidations(){return this._dataValidations}toJSON(){return this._dataValidations}validator(a,e,i,o){return n.DataValidationStatus.VALID}}const aa=[n.DataValidationOperator.BETWEEN,n.DataValidationOperator.NOT_BETWEEN];l.AddDataValidationCommand=I,l.AddDataValidationMutation=g,l.DataValidationManager=k,l.DataValidatorRegistryScope=M,l.DataValidatorRegistryService=T,l.RemoveAllDataValidationCommand=C,l.RemoveDataValidationCommand=y,l.RemoveDataValidationMutation=v,l.TWO_FORMULA_OPERATOR_COUNT=aa,l.UpdateDataValidationMutation=_,l.UpdateDataValidationOptionsCommand=A,l.UpdateDataValidationSettingCommand=N,l.UpdateRuleType=V,l.createDefaultNewRule=G,l.getRuleOptions=S,l.getRuleSetting=R,l.removeDataValidationUndoFactory=H,Object.defineProperty(l,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@univerjs/data-validation",
+  "version": "0.1.6",
+  "private": false,
+  "description": "",
+  "author": "univer.ai",
+  "license": "",
+  "keywords": [],
+  "exports": {
+    ".": {
+      "import": "./lib/es/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./*": {
+      "import": "./lib/es/*",
+      "require": "./lib/cjs/*",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./lib/*": "./lib/*"
+  },
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/es/index.js",
+  "types": "./lib/types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib"
+  ],
+  "peerDependencies": {
+    "@wendellhu/redi": "0.13.0",
+    "rxjs": ">=7.0.0",
+    "@univerjs/core": "0.1.6",
+    "@univerjs/sheets": "0.1.6"
+  },
+  "dependencies": {
+    "dayjs": "^1.11.10"
+  },
+  "devDependencies": {
+    "@wendellhu/redi": "^0.13.0",
+    "rxjs": "^7.8.1",
+    "typescript": "^5.4.3",
+    "vite": "^5.2.7",
+    "vitest": "^1.4.0",
+    "@univerjs/core": "0.1.6",
+    "@univerjs/shared": "0.1.6",
+    "@univerjs/sheets": "0.1.6"
+  },
+  "scripts": {
+    "dev": "vite",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
+    "build": "tsc && vite build"
+  }
+}