Skip to content

chore: update types #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

chore: update types #417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b78488
chore: update types
xunmi1 Apr 14, 2022
78945ff
chore: update `InternalRule`
xunmi1 Apr 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 18 additions & 76 deletions src/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
import type { ReactElement } from 'react';
import type {
Value as StoreValue,
Values as Store,
RuleType,
ValidateMessages,
} from 'async-validator';
import type { ReducerAction } from './useForm';

export type InternalNamePath = (string | number)[];
export type NamePath = string | number | InternalNamePath;

export type StoreValue = any;
export type Store = Record<string, StoreValue>;
export type { RuleType, StoreValue, Store, ValidateMessages };

export interface Meta {
touched: boolean;
Expand All @@ -26,25 +31,10 @@ export interface FieldData extends Partial<Omit<InternalFieldData, 'name'>> {
name: NamePath;
}

export type RuleType =
| 'string'
| 'number'
| 'boolean'
| 'method'
| 'regexp'
| 'integer'
| 'float'
| 'object'
| 'enum'
| 'date'
| 'url'
| 'hex'
| 'email';

type Validator = (
rule: RuleObject,
rule: InternalRule,
value: StoreValue,
callback: (error?: string) => void,
callback: (error?: string | Error) => void,
) => Promise<void | any> | void;

export type RuleRender = (form: FormInstance) => RuleObject;
Expand All @@ -67,22 +57,23 @@ interface BaseRule {
transform?: (value: StoreValue) => StoreValue;
type?: RuleType;
whitespace?: boolean;
defaultField?: RuleObject;
fields?: Record<string, RuleObject>;

/** Customize rule level `validateTrigger`. Must be subset of Field `validateTrigger` */
validateTrigger?: string | string[];
}

type AggregationRule = BaseRule & Partial<ValidatorRule>;

interface ArrayRule extends Omit<AggregationRule, 'type'> {
type: 'array';
defaultField?: RuleObject;
}

export type RuleObject = AggregationRule | ArrayRule;
export type RuleObject = BaseRule & Partial<ValidatorRule>;

export type Rule = RuleObject | RuleRender;

export interface InternalRule extends RuleObject {
field?: string;
fullField?: string;
fullFields?: string[];
}

export interface ValidateErrorEntity<Values = any> {
values: Values;
errorFields: { name: InternalNamePath; errors: string[] }[];
Expand Down Expand Up @@ -265,52 +256,3 @@ export type InternalFormInstance = Omit<FormInstance, 'validateFields'> & {

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type EventArgs = any[];

type ValidateMessage = string | (() => string);
export interface ValidateMessages {
default?: ValidateMessage;
required?: ValidateMessage;
enum?: ValidateMessage;
whitespace?: ValidateMessage;
date?: {
format?: ValidateMessage;
parse?: ValidateMessage;
invalid?: ValidateMessage;
};
types?: {
string?: ValidateMessage;
method?: ValidateMessage;
array?: ValidateMessage;
object?: ValidateMessage;
number?: ValidateMessage;
date?: ValidateMessage;
boolean?: ValidateMessage;
integer?: ValidateMessage;
float?: ValidateMessage;
regexp?: ValidateMessage;
email?: ValidateMessage;
url?: ValidateMessage;
hex?: ValidateMessage;
};
string?: {
len?: ValidateMessage;
min?: ValidateMessage;
max?: ValidateMessage;
range?: ValidateMessage;
};
number?: {
len?: ValidateMessage;
min?: ValidateMessage;
max?: ValidateMessage;
range?: ValidateMessage;
};
array?: {
len?: ValidateMessage;
min?: ValidateMessage;
max?: ValidateMessage;
range?: ValidateMessage;
};
pattern?: {
mismatch?: ValidateMessage;
};
}
6 changes: 1 addition & 5 deletions src/utils/validateUtil.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,7 @@ export function validateRules(

// Replace validator if needed
if (originValidatorFunc) {
cloneRule.validator = (
rule: RuleObject,
val: StoreValue,
callback: (error?: string) => void,
) => {
cloneRule.validator = (rule, val, callback) => {
let hasPromise = false;

// Wrap callback only accept when promise not provided
Expand Down