@airpower/web 0.1.3 → 0.2.1

package/dist/util/permission/index.d.ts

@@ -0,0 +1,2 @@
+export * from './PermissionAction';
+export * from './PermissionUtil';

package/dist/util/validator/WebValidator.d.ts

@@ -0,0 +1,198 @@
+import { RootEntity } from '../../base';
+import { AbstractCurdService } from '../../curd';
+import { ClassConstructor } from '../../type';
+import { WebValidateRule, WebValidatorCallback, WebValidatorTarget, WebValidatorTrigger, WebValidatorType } from './type';
+/**
+ * # 表单验证
+ * @author Hamm.cn
+ */
+export declare class WebValidator {
+    /**
+     * ### 错误提醒
+     * 请通过 `.show()` 传入
+     */
+    message: string;
+    /**
+     * ### 触发方式
+     * 不建议直接设置哦~ (默认blur)
+     */
+    trigger: WebValidatorTrigger;
+    /**
+     * ### 类型
+     * 可通过 `toString` `toNumber` `toArray` 设置 (默认`string`)
+     */
+    type: WebValidatorType;
+    /**
+     * ### 是否必填
+     * 可以调用 `.ifEmpty()`
+     */
+    required: boolean;
+    /**
+     * ### 自定义验证器
+     * 请调用 `.setCustomValidator()`
+     */
+    validator: (rule: WebValidatorTarget, value: any, callback: WebValidatorCallback) => void;
+    /**
+     * ### 通过指定错误信息来创建一个验证器
+     * @param message `可选` 验证失败的提示
+     */
+    static show(message?: string): WebValidator;
+    /**
+     * ### 创建一个验证器
+     * @param rule 验证规则
+     */
+    static create(rule: WebValidateRule): WebValidateRule;
+    /**
+     * ### 创建验证器
+     * @param service 接口服务对象
+     * @param rules `可选` 表单验证规则
+     */
+    static createRules<E extends RootEntity, S extends AbstractCurdService<E>, V extends WebValidator>(this: ClassConstructor<V> & typeof WebValidator, service: S, rules?: WebValidateRule<E>): WebValidateRule<E>;
+    /**
+     * ### 获取一个验证器
+     * @param configValue 验证器配置的值
+     */
+    private static getValidator;
+    /**
+     * ### 转换验证数据为数组
+     */
+    toArray(): this;
+    /**
+     * ### 转换验证数据为数字
+     */
+    toNumber(): this;
+    /**
+     * ### 转换验证数据为字符串
+     */
+    toString(): this;
+    /**
+     * ### 转换验证数据为日期
+     */
+    toDate(): this;
+    /**
+     * ### 显示错误信息
+     * @param message 验证失败提醒文案
+     */
+    show(message?: string): this;
+    /**
+     * ### 不允许的内容
+     * @param str 内容
+     */
+    ifEquals(str: string): this;
+    /**
+     * ### 字符长度少于多少时报错
+     * @param min 最小值
+     */
+    ifLengthLessThan(min: number): this;
+    /**
+     * ### 字符长度超过多少时报错
+     * @param max 最大值
+     */
+    ifLengthGreaterThan(max: number): this;
+    /**
+     * ### 不小于多少时报错 即必须大于
+     * @param min 最小值
+     */
+    ifNotLessThan(min: number): this;
+    /** ********************************************* 数学相关 */
+    /**
+     * ### 不大于多少时报错 即必须小于
+     * @param max 最大值
+     */
+    ifNotGreaterThan(max: number): this;
+    /**
+     * ### 小于多少时报错
+     * @param min 最小值
+     */
+    ifLessThan(min: number): this;
+    /**
+     * ### 大于多少时报错
+     * @param max 最大值
+     */
+    ifGreaterThan(max: number): this;
+    /**
+     * ### 为空时报错
+     */
+    ifEmpty(): this;
+    /**
+     * ### 失去焦点时验证
+     */
+    whenBlur(): this;
+    /**
+     * ### 设置自定义验证器
+     * @param validator 验证方法
+     */
+    setCustomValidator(validator: (_: WebValidatorTarget, value: unknown, callback: WebValidatorCallback) => void): this;
+    /**
+     * ### 当不包含某些字符串时报错
+     * @param whats 字符串数组
+     */
+    ifNotContain(...whats: string[]): this;
+    /**
+     * ### 当包含某些字符串时报错
+     * @param whats 字符串数组
+     */
+    ifContain(...whats: string[]): this;
+    /**
+     * ### 满足指定正则表达式后报错
+     * @param regx 正则
+     */
+    ifTest(regx: RegExp): this;
+    /**
+     * ### 不满足指定正则表达式后报错
+     * @param regx 正则
+     */
+    ifNotTest(regx: RegExp): this;
+    /**
+     * ### 如果不是邮箱时报错
+     */
+    ifNotEmail(): this;
+    /**
+     * ### 如果不是手机号时报错
+     */
+    ifNotMobilePhone(): this;
+    /**
+     * ### 如果不是座机号时报错
+     */
+    ifNotTelPhone(): this;
+    /**
+     * ### 如果不是联系电话时报错
+     */
+    ifNotPhone(): this;
+    /**
+     * ### 如果不是纯字母时报错
+     */
+    ifNotOnlyLetter(): this;
+    /**
+     * ### 如果不是字母和数字报错
+     */
+    ifNotOnlyNumberAndLetter(): this;
+    /**
+     * ### 如果不是自然整数(含0)时报错
+     */
+    ifNotNaturalInteger(): this;
+    /**
+     * ### 如果不是自然整数(含0)时报错
+     */
+    ifNotNaturalNumber(): this;
+    /**
+     * ### 如果不是整数时报错
+     */
+    ifNotInteger(): this;
+    /**
+     * ### 如果不是数字(含小数)时报错
+     */
+    ifNotNumber(): this;
+    /**
+     * ### 如果不是有效身份证时报错
+     */
+    ifNotChineseIdCard(): this;
+    /**
+     * ### 如果不是纯汉字
+     */
+    ifNotChinese(): this;
+    /**
+     * ### 如果输入内容不在以下范围内报错
+     */
+    ifPayloadEmpty(): this;
+}

package/dist/util/validator/index.d.ts

@@ -0,0 +1,2 @@
+export * from './type';
+export * from './WebValidator';

package/dist/util/validator/type.d.ts

@@ -0,0 +1,24 @@
+import { RootEntity } from '../../base';
+import { WebValidator } from './WebValidator';
+/**
+ * ### 验证器数据类型
+ */
+export type WebValidatorType = 'string' | 'number' | 'date' | 'array';
+/**
+ * ### 验证器触发类型
+ */
+export type WebValidatorTrigger = 'blur' | 'change';
+/**
+ * ### 验证器规则类型
+ */
+export type WebValidatorTarget = any;
+/**
+ * ### 验证器回调函数类型
+ */
+export type WebValidatorCallback = (error?: string) => void;
+/**
+ * ### 表单验证规则
+ */
+export type WebValidateRule<E extends RootEntity = RootEntity> = {
+    [K in keyof E]?: WebValidator[];
+};