/**
 * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
 * */
import { IsEmailOptions } from 'validator/es/lib/isEmail';
import { IsURLOptions } from 'validator/es/lib/isURL';
export interface TdFormProps<FormData extends Data = Data> {
    /**
     * 是否在表单标签字段右侧显示冒号
     * @default false
     */
    colon?: {
        type: BooleanConstructor;
        value?: boolean;
    };
    /**
     * 表单数据
     * @default {}
     */
    data?: {
        type: ObjectConstructor;
        value?: FormData;
    };
    /**
     * 表单错误信息配置，示例：`{ idcard: '请输入正确的身份证号码', max: '字符长度不能超过 ${max}' }`
     */
    errorMessage?: {
        type: ObjectConstructor;
        value?: FormErrorMessage;
    };
    /**
     * 表单字段标签对齐方式：左对齐、右对齐、顶部对齐
     * @default right
     */
    labelAlign?: {
        type: StringConstructor;
        value?: 'left' | 'right' | 'top';
    };
    /**
     * 可以整体设置label标签宽度，默认为81px
     * @default '81px'
     */
    labelWidth?: {
        type: null;
        value?: string | number;
    };
    /**
     * 是否显示必填符号（*），默认显示
     */
    requiredMark?: {
        type: BooleanConstructor;
        value?: boolean;
    };
    /**
     * 表单必填符号（*）显示位置
     */
    requiredMarkPosition?: {
        type: StringConstructor;
        value?: 'left' | 'right';
    };
    /**
     * 重置表单的方式，值为 empty 表示重置表单为空，值为 initial 表示重置表单数据为初始值
     * @default empty
     */
    resetType?: {
        type: StringConstructor;
        value?: 'empty' | 'initial';
    };
    /**
     * 表单字段校验规则
     */
    rules?: {
        type: ObjectConstructor;
        value?: FormRules<FormData>;
    };
    /**
     * 表单校验不通过时，是否自动滚动到第一个校验不通过的字段，平滑滚动或是瞬间直达。值为空则表示不滚动
     */
    scrollToFirstError?: {
        type: StringConstructor;
        value?: '' | 'smooth' | 'auto';
    };
    /**
     * 校验不通过时，是否显示错误提示信息，统一控制全部表单项。如果希望控制单个表单项，请给 FormItem 设置该属性
     * @default true
     */
    showErrorMessage?: {
        type: BooleanConstructor;
        value?: boolean;
    };
    /**
     * 【讨论中】当校验结果只有告警信息时，是否触发 `submit` 提交事件
     * @default false
     */
    submitWithWarningMessage?: {
        type: BooleanConstructor;
        value?: boolean;
    };
}
/** 组件实例方法 */
export interface FormInstanceFunctions<FormData extends Data = Data> {
    /**
     * 清空校验结果。可使用 fields 指定清除部分字段的校验结果，fields 值为空则表示清除所有字段校验结果。清除邮箱校验结果示例：`clearValidate(['email'])`
     */
    clearValidate: {
        type: undefined;
        value?: (fields?: Array<keyof FormData>) => void;
        required?: boolean;
    };
    /**
     * 重置表单，表单里面没有重置按钮`<button type=\"reset\" />`时可以使用该方法，默认重置全部字段为空，该方法会触发 `reset` 事件。<br />如果表单属性 `resetType='empty'` 或者 `reset.type='empty'` 会重置为空；<br />如果表单属性 `resetType='initial'` 或者 `reset.type='initial'` 会重置为表单初始值。<br />`reset.fields` 用于设置具体重置哪些字段，示例：`reset({ type: 'initial', fields: ['name', 'age'] })`
     */
    reset: {
        type: undefined;
        value?: (params?: FormResetParams<FormData>) => void;
        required?: boolean;
    };
    /**
     * 设置自定义校验结果，如远程校验信息直接呈现。注意需要在组件挂载结束后使用该方法。`FormData` 指表单数据泛型
     */
    setValidateMessage: {
        type: undefined;
        value?: (message: FormValidateMessage<FormData>) => void;
        required?: boolean;
    };
    /**
     * 提交表单，表单里面没有提交按钮`<button type=\"submit\" />`时可以使用该方法。`showErrorMessage` 表示是否在提交校验不通过时显示校验不通过的原因，默认显示。该方法会触发 `submit` 事件
     */
    submit: {
        type: undefined;
        value?: (params?: {
            showErrorMessage?: boolean;
        }) => void;
        required?: boolean;
    };
    /**
     * 校验函数，包含错误文本提示等功能。泛型 `FormData` 表示表单数据 TS 类型。<br/>【关于参数】`params.fields` 表示校验字段，如果设置了 `fields`，本次校验将仅对这些字段进行校验。`params.trigger` 表示本次触发校验的范围，'params.trigger = blur' 表示只触发校验规则设定为 trigger='blur' 的字段，'params.trigger = change' 表示只触发校验规则设定为 trigger='change' 的字段，默认触发全范围校验。`params.showErrorMessage` 表示校验结束后是否显示错误文本提示，默认显示。<br />【关于返回值】返回值为 true 表示校验通过；如果校验不通过，返回值为校验结果列表
     */
    validate: {
        type: undefined;
        value?: (params?: FormValidateParams) => Promise<FormValidateResult<FormData>>;
        required?: boolean;
    };
}
export interface FormRule {
    /**
     * 内置校验方法，校验值类型是否为布尔类型，示例：`{ boolean: true, message: '数据类型必须是布尔类型' }`
     */
    boolean?: boolean;
    /**
     * 内置校验方法，校验值是否为日期格式，[参数文档](https://github.com/validatorjs/validator.js)，示例：`{ date: { delimiters: '-' }, message: '日期分隔线必须是短横线（-）' }`
     */
    date?: boolean | IsDateOptions;
    /**
     * 内置校验方法，校验值是否为邮件格式，[参数文档](https://github.com/validatorjs/validator.js)，示例：`{ email: { ignore_max_length: true }, message: '请输入正确的邮箱地址' }`
     */
    email?: boolean | IsEmailOptions;
    /**
     * 内置校验方法，校验值是否属于枚举值中的值。示例：`{ enum: ['primary', 'info', 'warning'], message: '值只能是 primary/info/warning 中的一种' }`
     */
    enum?: Array<string>;
    /**
     * 内置校验方法，校验值是否为身份证号码，组件校验正则为 `/^(\\d{18,18}|\\d{15,15}|\\d{17,17}x)$/i`，示例：`{ idcard: true, message: '请输入正确的身份证号码' }`
     */
    idcard?: boolean;
    /**
     * 内置校验方法，校验值固定长度，如：len: 10 表示值的字符长度只能等于 10 ，中文表示 2 个字符，英文为 1 个字符。示例：`{ len: 10, message: '内容长度不对' }`。<br />如果希望字母和中文都是同样的长度，示例：`{ validator: (val) => val.length === 10, message: '内容文本长度只能是 10 个字' }`
     */
    len?: number | boolean;
    /**
     * 内置校验方法，校验值最大长度，如：max: 100 表示值最多不能超过 100 个字符，中文表示 2 个字符，英文为 1 个字符。示例：`{ max: 10, message: '内容超出' }`。<br />如果希望字母和中文都是同样的长度，示例：`{ validator: (val) => val.length <= 10, message: '内容文本长度不能超过 10 个字' }`<br />如果数据类型数字（Number），则自动变为数字大小的比对
     */
    max?: number | boolean;
    /**
     * 校验未通过时呈现的错误信息，值为空则不显示
     * @default ''
     */
    message?: string;
    /**
     * 内置校验方法，校验值最小长度，如：min: 10 表示值最多不能少于 10 个字符，中文表示 2 个字符，英文为 1 个字符。示例：`{ min: 10, message: '内容长度不够' }`。<br />如果希望字母和中文都是同样的长度，示例：`{ validator: (val) => val.length >= 10, message: '内容文本长度至少为 10 个字' }`。<br />如果数据类型数字（Number），则自动变为数字大小的比对
     */
    min?: number | boolean;
    /**
     * 内置校验方法，校验值是否为数字（1.2 、 1e5  都算数字），示例：`{ number: true, message: '请输入数字' }`
     */
    number?: boolean;
    /**
     * 内置校验方法，校验值是否符合正则表达式匹配结果，示例：`{ pattern: /@qq.com/, message: '请输入 QQ 邮箱' }`
     */
    pattern?: RegExp | string;
    /**
     * 内置校验方法，校验值是否已经填写。该值为 true，默认显示必填标记，可通过设置 `requiredMark: false` 隐藏必填标记
     */
    required?: boolean;
    /**
     * 内置校验方法，校验值是否为手机号码，校验正则为 `/^1[3-9]\d{9}$/`，示例：`{ telnumber: true, message: '请输入正确的手机号码' }`
     */
    telnumber?: boolean;
    /**
     * 校验触发方式
     * @default change
     */
    trigger?: ValidateTriggerType;
    /**
     * 校验未通过时呈现的错误信息类型，有 告警信息提示 和 错误信息提示 等两种
     * @default error
     */
    type?: 'error' | 'warning';
    /**
     * 内置校验方法，校验值是否为网络链接地址，[参数文档](https://github.com/validatorjs/validator.js)，示例：`{ url: { protocols: ['http','https','ftp'] }, message: '请输入正确的 Url 地址' }`
     */
    url?: boolean | IsURLOptions;
    /**
     * 自定义校验规则，context 中 formData 为当前完整表单值，name为该字段的标识，示例：`{ validator: (val) => val.length > 0, message: '请输入内容'}`
     */
    validator?: CustomValidator;
    /**
     * 内置校验方法，校验值是否为空格。示例：`{ whitespace: true, message: '值不能为空' }`
     */
    whitespace?: boolean;
}
export interface FormErrorMessage {
    /**
     * 布尔类型校验不通过时的表单项显示文案，全局配置默认是：`'${name}数据类型必须是布尔类型'`
     * @default ''
     */
    boolean?: string;
    /**
     * 日期校验规则不通过时的表单项显示文案，全局配置默认是：`'请输入正确的${name}'`
     * @default ''
     */
    date?: string;
    /**
     * 枚举值校验规则不通过时的表单项显示文案，全局配置默认是：`${name}只能是${validate}等`
     * @default ''
     */
    enum?: string;
    /**
     * 身份证号码校验不通过时的表单项显示文案，全局配置默认是：`'请输入正确的${name}'`
     * @default ''
     */
    idcard?: string;
    /**
     * 值长度校验不通过时的表单项显示文案，全局配置默认是：`'${name}字符长度必须是 ${validate}'`
     * @default ''
     */
    len?: string;
    /**
     * 值的长度太长或值本身太大时，校验不通过的表单项显示文案，全局配置默认是：`'${name}字符长度不能超过 ${validate} 个字符，一个中文等于两个字符'`
     * @default ''
     */
    max?: string;
    /**
     * 值的长度太短或值本身太小时，校验不通过的表单项显示文案，全局配置默认是：`'${name}字符长度不能少于 ${validate} 个字符，一个中文等于两个字符'`
     * @default ''
     */
    min?: string;
    /**
     * 数字类型校验不通过时的表单项显示文案，全局配置默认是：`'${name}必须是数字'`
     * @default ''
     */
    number?: string;
    /**
     * 正则表达式校验不通过时的表单项显示文案，全局配置默认是：`'请输入正确的${name}'`
     * @default ''
     */
    pattern?: string;
    /**
     * 没有填写必填项时的表单项显示文案，全局配置默认是：`'${name}必填'`
     * @default ''
     */
    required?: string;
    /**
     * 手机号号码校验不通过时的表单项显示文案，全局配置默认是：`'请输入正确的${name}'`
     * @default ''
     */
    telnumber?: string;
    /**
     * 链接校验规则不通过时的表单项显示文案，全局配置默认是：`'请输入正确的${name}'`
     * @default ''
     */
    url?: string;
    /**
     * 自定义校验规则校验不通过时的表单项显示文案，全局配置默认是：'${name}不符合要求'
     * @default ''
     */
    validator?: string;
    /**
     * 值为空格校验不通过时表单项显示文案，全局配置默认是：`'${name}不能为空`
     * @default ''
     */
    whitespace?: string;
}
export declare type FormRules<T extends Data = any> = {
    [field in keyof T]?: Array<FormRule>;
};
export interface FormResetParams<FormData> {
    type?: 'initial' | 'empty';
    fields?: Array<keyof FormData>;
}
export declare type FormValidateMessage<FormData> = {
    [field in keyof FormData]: FormItemValidateMessage[];
};
export interface FormItemValidateMessage {
    type: 'warning' | 'error';
    message: string;
}
export interface FormValidateParams {
    fields?: Array<string>;
    showErrorMessage?: boolean;
    trigger?: ValidateTriggerType;
}
export declare type ValidateTriggerType = 'blur' | 'change' | 'submit' | 'all';
export declare type FormValidateResult<T> = boolean | ValidateResultObj<T>;
export declare type ValidateResultObj<T> = {
    [key in keyof T]: boolean | ValidateResultList;
};
export declare type ValidateResultList = Array<AllValidateResult>;
export declare type AllValidateResult = CustomValidateObj | ValidateResultType;
export interface ValidateResultType extends FormRule {
    result: boolean;
}
export declare type Data = {
    [key: string]: any;
};
export interface IsDateOptions {
    format: string;
    strictMode: boolean;
    delimiters: string[];
}
export declare type CustomValidator = (val: ValueType, context?: {
    formData: Data;
    name: string;
}) => CustomValidateResolveType | Promise<CustomValidateResolveType>;
export declare type CustomValidateResolveType = boolean | CustomValidateObj;
export interface CustomValidateObj {
    result: boolean;
    message: string;
    type?: 'error' | 'warning' | 'success';
}
export declare type ValueType = any;