@tiny-codes/react-easy 1.0.0 → 1.0.1

package/lib/hooks/useValidator.js

@@ -0,0 +1,13 @@
+import { useMemo } from 'react';
+import useValidatorBuilder from './useValidatorBuilder';
+/**
+ * **EN:** Dynamically generate a validation rule, compatible with ant-design rules
+ *
+ * **CN:** 动态生成一个校验规则，与 ant-design 的规则兼容
+ */
+const useValidator = (props) => {
+    const builder = useValidatorBuilder();
+    return useMemo(() => builder(props), [builder, props]);
+};
+export default useValidator;
+//# sourceMappingURL=useValidator.js.map

package/lib/hooks/useValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useValidator.js","sourceRoot":"","sources":["../../src/hooks/useValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AAExD;;;;GAIG;AACH,MAAM,YAAY,GAAG,CAAC,KAAqB,EAAE,EAAE;IAC7C,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;IACtC,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/lib/hooks/useValidatorBuilder.d.ts

@@ -0,0 +1,133 @@
+/**
+ * **EN:** Get a validation rule builder to build validation rules
+ *
+ * **CN:** 获取一个校验规则生成器，用来构建校验规则
+ */
+declare const useValidatorBuilder: () => (props: BuilderOptions) => ValidatorRule;
+export interface BuilderOptions {
+    /**
+     * **EN:** The rule of allowed characters
+     *
+     * **CN:** 允许字符的规则
+     */
+    allowed: RuleRegExpFlags;
+    /**
+     * **EN:** The rule of the starting character
+     *
+     * **CN:** 开头字符的规则
+     */
+    startsWith?: Omit<RuleRegExpFlags, 'min' | 'max'>;
+    /**
+     * **EN:** Regular expression flags
+     *
+     * **CN:** 正则表达式的标志
+     */
+    flags?: string;
+}
+export interface RuleRegExpFlags {
+    /**
+     * **EN:** Include lowercase and uppercase English letters. If set to true, lowerLetter and
+     * upperLetter are not effective
+     *
+     * **CN:**: 包含大小写英文字。如果设置为true，则lowerLetter和upperLetter不生效
+     */
+    letter?: boolean;
+    /**
+     * **EN:** Include lowercase English letters
+     *
+     * **CN:**: 包含小写英文字符
+     */
+    lowerLetter?: boolean;
+    /**
+     * **EN:** Include uppercase English letters
+     *
+     * **CN:**: 包含大写英文字符
+     */
+    upperLetter?: boolean;
+    /**
+     * **EN:** Include Chinese characters
+     *
+     * **CN:** 包含中文字符
+     */
+    chinese?: boolean;
+    /**
+     * **EN:** Include Chinese (full-width) punctuation
+     *
+     * **CN:** 包含中文（全角）标点符号
+     */
+    chinesePunctuation?: boolean;
+    /**
+     * **EN:** Include numbers
+     *
+     * **CN:** 包含数字
+     */
+    number?: boolean;
+    /**
+     * **EN:** Include hyphens (-)
+     *
+     * **CN:** 包含连字符(-)
+     */
+    dash?: boolean;
+    /**
+     * **EN:** Include underscores (_)
+     *
+     * **CN:** 包含下划线(_)
+     */
+    underscore?: boolean;
+    /**
+     * **EN:** Include special characters
+     *
+     * **CN:** 包含特殊字符
+     */
+    special?: string[];
+    /**
+     * **EN:** Minimum number of characters
+     *
+     * **CN:** 最小字符数量
+     *
+     * @default 1
+     */
+    min?: number;
+    /**
+     * **EN:** Maximum number of characters, default length is unlimited
+     *
+     * **CN:** 最大字符数量，默认长度不限
+     */
+    max?: number;
+}
+export type StartsWithRegExpFlags = RuleRegExpFlags;
+export interface ValidatorRule extends Validator {
+    /**
+     * **EN:** The options of allowed characters
+     *
+     * **CN:** 允许字符的规则设置
+     */
+    allowedOptions: RuleRegExpFlags;
+    /**
+     * **EN:** The options of the starting character
+     *
+     * **CN:** 开头字符的规则设置
+     */
+    startsWithOptions?: StartsWithRegExpFlags;
+    /**
+     * **EN:** Regular expression flags
+     *
+     * **CN:** 正则表达式的标志
+     */
+    flags?: string;
+}
+export interface Validator {
+    /**
+     * **EN:** Regular expression for verification
+     *
+     * **CN:** 校验正则表达式
+     */
+    pattern: RegExp;
+    /**
+     * **EN:** Prompt message when verification fails
+     *
+     * **CN:** 校验失败时的提示信息
+     */
+    message: string;
+}
+export default useValidatorBuilder;

package/lib/hooks/useValidatorBuilder.js

@@ -0,0 +1,139 @@
+import { useMemo } from 'react';
+import escape from 'escape-string-regexp';
+import useT from './useT';
+const nameSeparator = 'validation.rule.buildRule.token.separator';
+/**
+ * **EN:** Get a validation rule builder to build validation rules
+ *
+ * **CN:** 获取一个校验规则生成器，用来构建校验规则
+ */
+const useValidatorBuilder = () => {
+    const t = useT();
+    return useMemo(() => (props) => buildRule(Object.assign(Object.assign({}, props), { t })), [t]);
+};
+/**
+ * **EN:** Build regular expression rules dynamically, compatible with Form.Item rules
+ *
+ * **CN:** 动态构建正则表达式规则，与 Form.Item 的规则兼容
+ */
+function buildRule(options) {
+    var _a, _b;
+    const { allowed, startsWith, flags, t } = options;
+    if (!Object.values(allowed).some((v) => v === true)) {
+        throw new Error(t('validation.rule.buildRule.includeMandatory'));
+    }
+    const symbols = [];
+    const messages = [];
+    symbols.push(`^`);
+    //  Process startsWith rules
+    if (startsWith) {
+        const meta = buildRuleMeta({
+            flags: startsWith,
+            t,
+        });
+        symbols.push(`[${meta.symbols.join('')}]`);
+        messages.push(t('validation.rule.buildRule.startsWithFormat', {
+            prefix: meta.messages.join(t(nameSeparator)),
+        }));
+    }
+    // Process allowed rules
+    {
+        const meta = buildRuleMeta({ flags: allowed, t });
+        const min = (_a = allowed.min) !== null && _a !== void 0 ? _a : 0;
+        const max = (_b = allowed.max) !== null && _b !== void 0 ? _b : 0; // 0 means unlimited
+        // If there is startWith in the regular expression, the limited data amount needs to be reduced by 1
+        const cMin = min && startsWith ? min - 1 : min;
+        const cMax = max && startsWith ? max - 1 : max;
+        symbols.push(`[${meta.symbols.join('')}]{${cMin},${cMax || ''}}`);
+        if (meta.messages.length === 0) {
+            messages.unshift(``);
+        }
+        else if (meta.messages.length === 1) {
+            messages.unshift(`${meta.messages.join(t(nameSeparator))}`);
+        }
+        else {
+            messages.unshift(`${meta.messages.join(t(nameSeparator))}`);
+        }
+        if (min && max) {
+            messages.push(t('validation.rule.buildRule.rangeLength', {
+                min,
+                max,
+            }));
+        }
+        else {
+            if (min > 1) {
+                messages.push(t('validation.rule.buildRule.minLength', { min }));
+            }
+            if (max) {
+                messages.push(t('validation.rule.buildRule.maxLength', { max }));
+            }
+        }
+    }
+    symbols.push(`$`);
+    let message = messages.join('');
+    if (message.startsWith(t(nameSeparator))) {
+        message = message.slice(1);
+    }
+    return {
+        pattern: new RegExp(symbols.join(''), flags),
+        message,
+        allowedOptions: allowed,
+        startsWithOptions: startsWith,
+        flags,
+    };
+}
+function buildRuleMeta(options) {
+    const { flags, t } = options;
+    const symbols = [];
+    const messages = [];
+    if (flags.chinese) {
+        // Chinese characters
+        symbols.push(`\u4e00-\u9fa5`);
+        messages.push(t('validation.rule.buildRule.token.chinese'));
+    }
+    if (flags.chinesePunctuation) {
+        // Chinese punctuation
+        symbols.push(`\u3000-\u301e`);
+        symbols.push(`\u3021-\u303f`);
+        symbols.push(`\uff00-\uffef`);
+        messages.push(t('validation.rule.buildRule.token.chinesePunctuation'));
+    }
+    if (flags.letter) {
+        symbols.push(`a-zA-Z`);
+        messages.push(t('validation.rule.buildRule.token.letter'));
+    }
+    else if (flags.lowerLetter) {
+        symbols.push(`a-z`);
+        messages.push(t('validation.rule.buildRule.token.lowerLetter'));
+    }
+    else if (flags.upperLetter) {
+        symbols.push(`A-Z`);
+        messages.push(t('validation.rule.buildRule.token.upperLetter'));
+    }
+    if (flags.number) {
+        symbols.push(`0-9`);
+        messages.push(t('validation.rule.buildRule.token.number'));
+    }
+    const excludeSpecials = [];
+    if (flags.dash) {
+        symbols.push(`\\-`);
+        messages.push(`-`);
+        excludeSpecials.push('-');
+    }
+    if (flags.underscore) {
+        symbols.push(`_`);
+        messages.push(`_`);
+        excludeSpecials.push('_');
+    }
+    if (flags.special) {
+        const specials = flags.special.filter((v) => !excludeSpecials.includes(v));
+        symbols.push(escape(specials.join('')));
+        messages.push(specials.join(t(nameSeparator)));
+    }
+    return {
+        symbols,
+        messages,
+    };
+}
+export default useValidatorBuilder;
+//# sourceMappingURL=useValidatorBuilder.js.map

package/lib/hooks/useValidatorBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useValidatorBuilder.js","sourceRoot":"","sources":["../../src/hooks/useValidatorBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,MAAM,MAAM,sBAAsB,CAAC;AAC1C,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,MAAM,aAAa,GAAG,2CAA2C,CAAC;AAElE;;;;GAIG;AACH,MAAM,mBAAmB,GAAG,GAAG,EAAE;IAC/B,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC;IACjB,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,KAAqB,EAAE,EAAE,CAAC,SAAS,iCAAM,KAAK,KAAE,CAAC,IAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACnF,CAAC,CAAC;AAEF;;;;GAIG;AACH,SAAS,SAAS,CAChB,OAOC;;IAED,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,4CAA4C,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAElB,4BAA4B;IAC5B,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,IAAI,GAAG,aAAa,CAAC;YACzB,KAAK,EAAE,UAAU;YACjB,CAAC;SACF,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;QAC3C,QAAQ,CAAC,IAAI,CACX,CAAC,CAAC,4CAA4C,EAAE;YAC9C,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;SAC7C,CAAC,CACH,CAAC;IACJ,CAAC;IAED,wBAAwB;IACxB,CAAC;QACC,MAAM,IAAI,GAAG,aAAa,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;QAElD,MAAM,GAAG,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,CAAC,CAAC;QAC7B,MAAM,GAAG,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,CAAC,CAAC,CAAC,oBAAoB;QAElD,oGAAoG;QACpG,MAAM,IAAI,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAC/C,MAAM,IAAI,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAE/C,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,IAAI,IAAI,IAAI,EAAE,GAAG,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACvB,CAAC;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9D,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CACX,CAAC,CAAC,uCAAuC,EAAE;gBACzC,GAAG;gBACH,GAAG;aACJ,CAAC,CACH,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;gBACZ,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,qCAAqC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,GAAG,EAAE,CAAC;gBACR,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,qCAAqC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAElB,IAAI,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChC,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC;QACzC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO;QACL,OAAO,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;QAC5C,OAAO;QACP,cAAc,EAAE,OAAO;QACvB,iBAAiB,EAAE,UAAU;QAC7B,KAAK;KACN,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,OAA+D;IACpF,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC;IAC7B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAClB,qBAAqB;QACrB,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9B,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,yCAAyC,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAC7B,sBAAsB;QACtB,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9B,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,oDAAoD,CAAC,CAAC,CAAC;IACzE,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,wCAAwC,CAAC,CAAC,CAAC;IAC7D,CAAC;SAAM,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,6CAA6C,CAAC,CAAC,CAAC;IAClE,CAAC;SAAM,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,6CAA6C,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,wCAAwC,CAAC,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAClB,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3E,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACxC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,OAAO;QACL,OAAO;QACP,QAAQ;KACT,CAAC;AACJ,CAAC;AA2ID,eAAe,mBAAmB,CAAC"}

package/lib/hooks/useValidators.d.ts

@@ -0,0 +1,150 @@
+import { type Validator, type ValidatorRule } from './useValidatorBuilder';
+/**
+ * **EN:** Get built-in validation rules, used to verify common data formats, compatible with
+ * ant-design rules
+ *
+ * **CN:** 获取内置的校验规则，用于校验常见的数据格式，与 ant-design 的规则兼容
+ */
+declare const useValidators: () => ValidatorRuleMap;
+export interface ValidatorRuleMap {
+    /**
+     * **EN:** Number
+     *
+     * **CN:** 数字
+     */
+    number: Validator;
+    /**
+     * **EN:** Floating point number
+     *
+     * **CN:** 浮点数
+     */
+    floatNumber: Validator;
+    /**
+     * **EN:** Email address regular expression (supports Chinese names)
+     *
+     * **CN:** 邮箱正则表达式（支持中文名称）
+     */
+    email: Validator;
+    /**
+     * **EN:** IP address regular expression
+     *
+     * **CN:** ip地址正则表达式
+     */
+    ip: Validator;
+    /**
+     * **EN:** Chine mobile phone number regular expression. If this rule does not meet the
+     * requirements, please use the `buildRule` method to customize the rule.
+     *
+     * **CN:** 中国手机号正则表达式。如果这个规则不满足需求，请使用 `buildRule` 方法自定义规则。
+     */
+    cnMobile: Validator;
+    /**
+     * **EN:** Default password verification rule: 8-16 digit password, at least two of numbers,
+     * letters, and symbols. If this rule does not meet the requirements, please use the `buildRule`
+     * method to customize the rule.
+     *
+     * **CN:** 默认密码验证规则：8-16位密码，数字、字母、符号至少包含两种。如果这个规则不满足需求，请使用 `buildRule` 方法自定义规则。
+     */
+    password: Validator;
+    /**
+     * **EN:** Used to verify the code rule: letters, numbers, _, starting with a letter, no limit on
+     * the number of characters
+     *
+     * **CN:** 用于校验编码的规则：字母、数字、_，以字母开头，不限制字符数量
+     */
+    code: ValidatorRule;
+    /**
+     * **EN:** Used to verify the code rule: letters, numbers, _, starting with a letter, up to 20
+     * characters
+     *
+     * **CN:** 用于校验编码的规则：字母、数字、_，以字母开头，最多20个字符
+     */
+    codeMax20: ValidatorRule;
+    /**
+     * **EN:** Used to verify the code rule: letters, numbers, _, starting with a letter, up to 64
+     * characters
+     *
+     * **CN:** 用于校验编码的规则：字母、数字、_，以字母开头，最多64个字符
+     */
+    codeMax64: ValidatorRule;
+    /**
+     * **EN:** Used to verify the code rule: letters, numbers, _, starting with a letter, up to 128
+     * characters
+     *
+     * **CN:** 用于校验编码的规则：字母、数字、_，以字母开头，最多128个字符
+     */
+    codeMax128: ValidatorRule;
+    /**
+     * **EN:** Used to verify the code rule: letters, numbers, _, starting with a letter, up to {max}
+     * characters
+     *
+     * **CN:** 用于校验名称的规则，可以自定义最大字符数：字母、汉字、数字、-、_，以汉字、字母开头，{max}字符以内
+     */
+    codeWithMax: (max?: number) => ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule: letters, Chinese characters, numbers, -, _, up to 20
+     * characters
+     *
+     * **CN:** 用于校验名称的规则：字母、汉字、数字、-、_，最多20个字符，
+     */
+    name: ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule: letters, Chinese characters, numbers, -, _, up to 64
+     *
+     * **CN:** 用于校验名称的规则：字母、汉字、数字、-、_，不限制字符数量
+     */
+    nameMax20: ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule: letters, Chinese characters, numbers, -, _, up to 64
+     * characters
+     *
+     * **CN:** 用于校验名称的规则：字母、汉字、数字、-、_，最多64个字符
+     */
+    nameMax64: ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule: letters, Chinese characters, numbers, -, _, up to 128
+     * characters
+     *
+     * **CN:** 用于校验名称的规则：字母、汉字、数字、-、_，最多128个字符
+     */
+    nameMax128: ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule: letters, Chinese characters, numbers, -, _, up to {max}
+     * characters
+     *
+     * **CN:** 用于校验名称的规则，可以自定义最大字符数：字母、汉字、数字、-、_，以汉字、字母开头，{max}字符以内
+     */
+    nameWithMax: (max?: number) => ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule, but it needs to start with Chinese characters or letters:
+     * letters, Chinese characters, numbers, -, _, starting with Chinese characters or letters
+     *
+     * **CN:** 用于校验名称的规则，但需要以汉字或字母开头：字母、汉字、数字、-、_，以汉字、字母开头
+     */
+    strongName: ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule, but it needs to start with Chinese characters or letters:
+     * letters, Chinese characters, numbers, -, _, starting with Chinese characters or letters, up to
+     * 64 characters
+     *
+     * **CN:** 用于校验名称的规则，但需要以汉字或字母开头：字母、汉字、数字、-、_，以汉字、字母开头，最多64个字符
+     */
+    strongNameMax64: ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule, but it needs to start with Chinese characters or letters:
+     * letters, Chinese characters, numbers, -, _, starting with Chinese characters or letters, up to
+     * 128 characters
+     *
+     * **CN:** 用于校验名称的规则，但需要以汉字或字母开头：字母、汉字、数字、-、_，以汉字、字母开头，最多128个字符
+     */
+    strongNameMax128: ValidatorRule;
+    /**
+     * **EN:** Used to verify the name rule, but it needs to start with Chinese characters or letters:
+     * letters, Chinese characters, numbers, -, _, starting with Chinese characters or letters, up to
+     * {max} characters
+     *
+     * **CN:** 用于校验名称的规则，但需要以汉字或字母开头：字母、汉字、数字、-、_，以汉字、字母开头，{max}字符以内
+     */
+    strongNameWithMax: (max?: number) => ValidatorRule;
+}
+export default useValidators;

package/lib/hooks/useValidators.js

@@ -0,0 +1,68 @@
+import { useMemo } from 'react';
+import useRefFunction from './useRefFunction';
+import useT from './useT';
+import useValidatorBuilder from './useValidatorBuilder';
+/**
+ * **EN:** Get built-in validation rules, used to verify common data formats, compatible with
+ * ant-design rules
+ *
+ * **CN:** 获取内置的校验规则，用于校验常见的数据格式，与 ant-design 的规则兼容
+ */
+const useValidators = () => {
+    const t = useT();
+    const build = useValidatorBuilder();
+    const codeWithMax = useRefFunction((max) => build({
+        allowed: { letter: true, number: true, underscore: true, max },
+        startsWith: { letter: true },
+    }));
+    const nameWithMax = useRefFunction((max) => build({
+        allowed: { letter: true, number: true, dash: true, underscore: true, chinese: true, max },
+        startsWith: { chinese: true, letter: true },
+    }));
+    const strongNameWithMax = useRefFunction((max) => build({
+        allowed: { letter: true, number: true, dash: true, underscore: true, chinese: true, max },
+        startsWith: { chinese: true, letter: true },
+    }));
+    return useMemo(() => ({
+        number: {
+            pattern: /^\d+$/,
+            message: t('validation.rule.number.message'),
+        },
+        floatNumber: {
+            pattern: /^-?\d+(\.\d+)?$/,
+            message: t('validation.rule.floatNumber.message'),
+        },
+        email: {
+            pattern: /^[A-Za-z0-9_\u4e00-\u9fa5-]+@[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+$/,
+            message: t('validation.rule.email.message'),
+        },
+        ip: {
+            pattern: /^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/,
+            message: t('validation.rule.ip.message'),
+        },
+        cnMobile: {
+            pattern: /^1[3456789]\d{9}$/,
+            message: t('validation.rule.mobile.message'),
+        },
+        password: {
+            pattern: /^(?![\d]+$)(?![a-z]+$)(?![A-Z]+$)(?![!@#$%^&*~()-+`_=|\\{};:'"/,.<>?]+$)[\da-zA-z!@#$%^&*~()-+`_=|\\{};:'"/,.<>?]{8,16}$/,
+            message: 'validation.rule.password.message',
+        },
+        code: codeWithMax(undefined),
+        codeMax20: codeWithMax(20),
+        codeMax64: codeWithMax(64),
+        codeMax128: codeWithMax(128),
+        codeWithMax,
+        name: nameWithMax(undefined),
+        nameMax20: nameWithMax(20),
+        nameMax64: nameWithMax(64),
+        nameMax128: nameWithMax(128),
+        nameWithMax,
+        strongName: strongNameWithMax(undefined),
+        strongNameMax64: strongNameWithMax(64),
+        strongNameMax128: strongNameWithMax(128),
+        strongNameWithMax,
+    }), [codeWithMax, nameWithMax, strongNameWithMax, t]);
+};
+export default useValidators;
+//# sourceMappingURL=useValidators.js.map

package/lib/hooks/useValidators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useValidators.js","sourceRoot":"","sources":["../../src/hooks/useValidators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,mBAA2D,MAAM,uBAAuB,CAAC;AAEhG;;;;;GAKG;AACH,MAAM,aAAa,GAAG,GAAqB,EAAE;IAC3C,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC;IACjB,MAAM,KAAK,GAAG,mBAAmB,EAAE,CAAC;IAEpC,MAAM,WAAW,GAAG,cAAc,CAAC,CAAC,GAAY,EAAE,EAAE,CAClD,KAAK,CAAC;QACJ,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE;QAC9D,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;KAC7B,CAAC,CACH,CAAC;IACF,MAAM,WAAW,GAAG,cAAc,CAAC,CAAC,GAAY,EAAE,EAAE,CAClD,KAAK,CAAC;QACJ,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE;QACzF,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;KAC5C,CAAC,CACH,CAAC;IACF,MAAM,iBAAiB,GAAG,cAAc,CAAC,CAAC,GAAY,EAAE,EAAE,CACxD,KAAK,CAAC;QACJ,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE;QACzF,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;KAC5C,CAAC,CACH,CAAC;IAEF,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC;QACL,MAAM,EAAE;YACN,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,CAAC,CAAC,gCAAgC,CAAC;SAC7C;QACD,WAAW,EAAE;YACX,OAAO,EAAE,iBAAiB;YAC1B,OAAO,EAAE,CAAC,CAAC,qCAAqC,CAAC;SAClD;QACD,KAAK,EAAE;YACL,OAAO,EAAE,iEAAiE;YAC1E,OAAO,EAAE,CAAC,CAAC,+BAA+B,CAAC;SAC5C;QACD,EAAE,EAAE;YACF,OAAO,EAAE,uFAAuF;YAChG,OAAO,EAAE,CAAC,CAAC,4BAA4B,CAAC;SACzC;QACD,QAAQ,EAAE;YACR,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,CAAC,CAAC,gCAAgC,CAAC;SAC7C;QACD,QAAQ,EAAE;YACR,OAAO,EACL,0HAA0H;YAC5H,OAAO,EAAE,kCAAkC;SAC5C;QAED,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;QAC5B,SAAS,EAAE,WAAW,CAAC,EAAE,CAAC;QAC1B,SAAS,EAAE,WAAW,CAAC,EAAE,CAAC;QAC1B,UAAU,EAAE,WAAW,CAAC,GAAG,CAAC;QAC5B,WAAW;QAEX,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;QAC5B,SAAS,EAAE,WAAW,CAAC,EAAE,CAAC;QAC1B,SAAS,EAAE,WAAW,CAAC,EAAE,CAAC;QAC1B,UAAU,EAAE,WAAW,CAAC,GAAG,CAAC;QAC5B,WAAW;QAEX,UAAU,EAAE,iBAAiB,CAAC,SAAS,CAAC;QACxC,eAAe,EAAE,iBAAiB,CAAC,EAAE,CAAC;QACtC,gBAAgB,EAAE,iBAAiB,CAAC,GAAG,CAAC;QACxC,iBAAiB;KAClB,CAAC,EACF,CAAC,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC,CAAC,CACjD,CAAC;AACJ,CAAC,CAAC;AAmJF,eAAe,aAAa,CAAC"}

package/lib/locales/index.d.ts

@@ -0,0 +1,74 @@
+import { type i18n } from 'i18next';
+export declare const langs: readonly ["en", "en-US", "zh-CN"];
+export type Langs = (typeof langs)[number];
+export declare const resources: {
+    readonly en: {
+        readonly translation: {
+            'validation.rule.number.message': string;
+            'validation.rule.floatNumber.message': string;
+            'validation.rule.email.message': string;
+            'validation.rule.ip.message': string;
+            'validation.rule.chineseMobile.message': string;
+            'validation.rule.password.message': string;
+            'validation.rule.buildRule.includeMandatory': string;
+            'validation.rule.buildRule.startsWithFormat': string;
+            'validation.rule.buildRule.minLength': string;
+            'validation.rule.buildRule.maxLength': string;
+            'validation.rule.buildRule.rangeLength': string;
+            'validation.rule.buildRule.token.separator': string;
+            'validation.rule.buildRule.token.chinese': string;
+            'validation.rule.buildRule.token.chinesePunctuation': string;
+            'validation.rule.buildRule.token.letter': string;
+            'validation.rule.buildRule.token.lowerLetter': string;
+            'validation.rule.buildRule.token.upperLetter': string;
+            'validation.rule.buildRule.token.number': string;
+        };
+    };
+    readonly 'en-US': {
+        readonly translation: {
+            'validation.rule.number.message': string;
+            'validation.rule.floatNumber.message': string;
+            'validation.rule.email.message': string;
+            'validation.rule.ip.message': string;
+            'validation.rule.chineseMobile.message': string;
+            'validation.rule.password.message': string;
+            'validation.rule.buildRule.includeMandatory': string;
+            'validation.rule.buildRule.startsWithFormat': string;
+            'validation.rule.buildRule.minLength': string;
+            'validation.rule.buildRule.maxLength': string;
+            'validation.rule.buildRule.rangeLength': string;
+            'validation.rule.buildRule.token.separator': string;
+            'validation.rule.buildRule.token.chinese': string;
+            'validation.rule.buildRule.token.chinesePunctuation': string;
+            'validation.rule.buildRule.token.letter': string;
+            'validation.rule.buildRule.token.lowerLetter': string;
+            'validation.rule.buildRule.token.upperLetter': string;
+            'validation.rule.buildRule.token.number': string;
+        };
+    };
+    readonly 'zh-CN': {
+        readonly translation: {
+            'validation.rule.number.message': string;
+            'validation.rule.floatNumber.message': string;
+            'validation.rule.email.message': string;
+            'validation.rule.ip.message': string;
+            'validation.rule.chineseMobile.message': string;
+            'validation.rule.password.message': string;
+            'validation.rule.buildRule.includeMandatory': string;
+            'validation.rule.buildRule.startsWithFormat': string;
+            'validation.rule.buildRule.minLength': string;
+            'validation.rule.buildRule.maxLength': string;
+            'validation.rule.buildRule.rangeLength': string;
+            'validation.rule.buildRule.token.separator': string;
+            'validation.rule.buildRule.token.chinese': string;
+            'validation.rule.buildRule.token.chinesePunctuation': string;
+            'validation.rule.buildRule.token.letter': string;
+            'validation.rule.buildRule.token.lowerLetter': string;
+            'validation.rule.buildRule.token.upperLetter': string;
+            'validation.rule.buildRule.token.number': string;
+        };
+    };
+};
+declare const reactEasyI18n: i18n;
+export declare const t: i18n['t'];
+export default reactEasyI18n;

package/lib/locales/index.js

@@ -0,0 +1,19 @@
+import { createInstance } from 'i18next';
+import enUS from './langs/en-US';
+import zhCN from './langs/zh-CN';
+export const langs = ['en', 'en-US', 'zh-CN'];
+export const resources = {
+    en: { translation: enUS },
+    'en-US': { translation: enUS },
+    'zh-CN': { translation: zhCN },
+};
+const reactEasyI18n = createInstance({});
+reactEasyI18n.init({
+    lng: 'en',
+    resources,
+});
+export const t = ((...args) => {
+    return reactEasyI18n.t(...args);
+});
+export default reactEasyI18n;
+//# sourceMappingURL=index.js.map

package/lib/locales/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/locales/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAa,MAAM,SAAS,CAAC;AACpD,OAAO,IAAI,MAAM,eAAe,CAAC;AACjC,OAAO,IAAI,MAAM,eAAe,CAAC;AAEjC,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAU,CAAC;AAIvD,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;IACzB,OAAO,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;IAC9B,OAAO,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;CACtB,CAAC;AAEX,MAAM,aAAa,GAAG,cAAc,CAAC,EAAE,CAAC,CAAC;AAEzC,aAAa,CAAC,IAAI,CAAC;IACjB,GAAG,EAAE,IAAI;IACT,SAAS;CACV,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,CAAC,GAAc,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;IACvC,OAAO,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AAClC,CAAC,CAAc,CAAC;AAEhB,eAAe,aAAa,CAAC"}

package/lib/locales/langs/en-US.d.ts

@@ -0,0 +1,21 @@
+declare const enUS: {
+    'validation.rule.number.message': string;
+    'validation.rule.floatNumber.message': string;
+    'validation.rule.email.message': string;
+    'validation.rule.ip.message': string;
+    'validation.rule.chineseMobile.message': string;
+    'validation.rule.password.message': string;
+    'validation.rule.buildRule.includeMandatory': string;
+    'validation.rule.buildRule.startsWithFormat': string;
+    'validation.rule.buildRule.minLength': string;
+    'validation.rule.buildRule.maxLength': string;
+    'validation.rule.buildRule.rangeLength': string;
+    'validation.rule.buildRule.token.separator': string;
+    'validation.rule.buildRule.token.chinese': string;
+    'validation.rule.buildRule.token.chinesePunctuation': string;
+    'validation.rule.buildRule.token.letter': string;
+    'validation.rule.buildRule.token.lowerLetter': string;
+    'validation.rule.buildRule.token.upperLetter': string;
+    'validation.rule.buildRule.token.number': string;
+};
+export default enUS;

package/lib/locales/langs/en-US.js

@@ -0,0 +1,22 @@
+const enUS = {
+    'validation.rule.number.message': 'Please enter a number',
+    'validation.rule.floatNumber.message': 'Please enter a number',
+    'validation.rule.email.message': 'Please enter the correct email address',
+    'validation.rule.ip.message': 'Please enter the correct ip address',
+    'validation.rule.chineseMobile.message': 'Please enter the correct mobile number',
+    'validation.rule.password.message': '8-16 digit password, at least two of numbers, letters, and symbols',
+    'validation.rule.buildRule.includeMandatory': 'At least one field in the include option is true',
+    'validation.rule.buildRule.startsWithFormat': `, start with {{prefix}}`,
+    'validation.rule.buildRule.minLength': `, {{min}} characters or more`,
+    'validation.rule.buildRule.maxLength': `, within {{max}} characters`,
+    'validation.rule.buildRule.rangeLength': `, {{min}}~{{max}} characters`,
+    'validation.rule.buildRule.token.separator': ', ',
+    'validation.rule.buildRule.token.chinese': 'Chinese characters',
+    'validation.rule.buildRule.token.chinesePunctuation': 'Chinese punctuation',
+    'validation.rule.buildRule.token.letter': 'letter',
+    'validation.rule.buildRule.token.lowerLetter': 'lowercase letter',
+    'validation.rule.buildRule.token.upperLetter': 'uppercase letter',
+    'validation.rule.buildRule.token.number': 'number',
+};
+export default enUS;
+//# sourceMappingURL=en-US.js.map