@anjianshi/utils 2.4.17 → 2.6.0

package/validators/object.js

@@ -1,49 +0,0 @@
-import isPlainObject from 'lodash/isPlainObject.js';
-import { success, failed } from '../lang/index.js';
-import { getValidatorGenerator, } from './base.js';
-export function getStructValidator(options) {
-    return getValidatorGenerator(function validate(field, value, options) {
-        if (!isPlainObject(value))
-            return failed(`${field} should be a plain object`);
-        const formatted = {};
-        for (const [key, itemValidator] of Object.entries(options.struct)) {
-            const itemResult = itemValidator(`${field}["${key}"]`, value[key]);
-            if (itemResult.success) {
-                if (itemResult.data !== undefined)
-                    formatted[key] = itemResult.data;
-            }
-            else {
-                return itemResult;
-            }
-        }
-        return success(formatted);
-    })(options);
-}
-export function getRecordValidator(options) {
-    return getValidatorGenerator(function validate(field, value, options) {
-        if (!isPlainObject(value))
-            return failed(`${field} should be a plain object`);
-        const formatted = {};
-        for (const [key, itemValue] of Object.entries(value)) {
-            // record 场景下，值为 undefined 的项目视为不存在，不保留在验证结果里，
-            // 不然一些因为不想赋值而填充了 undefined 值的项目可能意外触发验证失败，或意外得到了默认值。
-            // （因此 validator 的 required 选项和 defaults 选项也没有意义了）
-            if (itemValue === undefined)
-                continue;
-            const itemResult = options.record(`${field}["${key}"]`, itemValue);
-            if (itemResult.success) {
-                if (itemResult.data !== undefined)
-                    formatted[key] = itemResult.data;
-            }
-            else {
-                return itemResult;
-            }
-        }
-        const length = Object.keys(formatted).length;
-        if (typeof options.min === 'number' && length < options.min)
-            return failed(`size of ${field} should >= ${options.min}`);
-        if (typeof options.max === 'number' && length > options.max)
-            return failed(`size of ${field} should <= ${options.max}`);
-        return success(formatted);
-    })(options);
-}

package/validators/oneOf.d.ts

@@ -1,10 +0,0 @@
-import { type CommonOptions, type Validator } from './base.js';
-/** 要求返回值通过其中一个验证器的检查 */
-export interface OneOfOptions extends CommonOptions {
-    /** 验证数组各元素 */
-    validators: Validator<unknown, CommonOptions>[];
-}
-export type OneOfValue<Options extends OneOfOptions> = Options extends {
-    validators: Validator<infer T, CommonOptions>[];
-} ? T : never;
-export declare function getOneOfValidator<const Options extends OneOfOptions>(options?: Options): Validator<OneOfValue<Options>, Options>;

package/validators/oneOf.js

@@ -1,15 +0,0 @@
-import { failed } from '../lang/index.js';
-import { getValidatorGenerator, } from './base.js';
-export function getOneOfValidator(options = {}) {
-    return getValidatorGenerator(function validate(field, value) {
-        const errors = [];
-        for (const validator of options.validators) {
-            const result = validator(field, value);
-            if (result.success)
-                return result;
-            else
-                errors.push(result.message);
-        }
-        return failed(`${field} do not match any valid format：\n- ` + errors.join('\n- '));
-    })(options);
-}

package/validators/string.d.ts

@@ -1,22 +0,0 @@
-import { type CommonOptions } from './base.js';
-export interface StringOptions extends CommonOptions<string> {
-    /** 字符串最小长度。defaults='' 时默认为 0，否则默认为 1 */
-    min?: number;
-    /** 字符串最大长度。 */
-    max?: number;
-    /** 字符串需匹配此正则，也可传入关键词使用预置的正则。正则通常应以 ^ 和 $ 开头结尾。 */
-    pattern?: RegExp | 'uuid' | 'mobile';
-    /**
-     * 指定一个数组或 TypeScript enum，字段值必须在此 enum 之中。
-     * 若指定，前几个选项将不再生效。
-     */
-    choices?: string[] | Record<string, string>;
-    /** 验证之前，是否先清除两侧空白字符 @default true */
-    trim?: boolean;
-}
-export type StringValueWithChoices<Options extends StringOptions> = Options extends {
-    choices: (infer T)[];
-} ? T : Options extends {
-    choices: Record<string, infer T>;
-} ? T : string;
-export declare function getStringValidator<const Options extends StringOptions>(options?: Options): import("./base.js").Validator<StringValueWithChoices<Options>, Options>;

package/validators/string.js

@@ -1,35 +0,0 @@
-import { success, failed } from '../lang/index.js';
-import { getValidatorGenerator } from './base.js';
-export function getStringValidator(options = {}) {
-    return getValidatorGenerator(function validate(field, value) {
-        if (typeof value !== 'string')
-            return failed(`${field} must be a string`);
-        const trim = options.trim ?? true;
-        const formatted = trim ? value.trim() : value;
-        if ('choices' in options && options.choices) {
-            const validValues = Array.isArray(options.choices)
-                ? options.choices
-                : Object.values(options.choices);
-            if (!validValues.includes(formatted))
-                return failed(`${field} can only be one of ${validValues.join(', ')}.`);
-        }
-        else {
-            const { min = options.defaults === '' ? 0 : 1, max, pattern } = options;
-            if (typeof min === 'number' && formatted.length < min)
-                return failed(`${field}'s length must >= ${min}`);
-            if (typeof max === 'number' && formatted.length > max)
-                return failed(`${field}'s length must <= ${max}`);
-            if (pattern !== undefined) {
-                if (pattern instanceof RegExp && !pattern.exec(formatted))
-                    return failed(`${field} does not match the pattern`);
-                if (pattern === 'mobile' && !/^1\d{10}$/.test(formatted))
-                    return failed(`${field} is not a valid mobile number`);
-                if (pattern === 'uuid') {
-                    if (!/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(formatted))
-                        return failed(`${field} is not a valid uuid`);
-                }
-            }
-        }
-        return success(formatted);
-    })(options);
-}