@anjianshi/utils 1.2.6 → 1.3.0

package/validators/factories.js

@@ -0,0 +1,41 @@
+/**
+ * 创建 validator 的快捷方式
+ */
+import { ArrayValidator } from './array.js';
+import { Validator } from './base.js';
+import { BooleanValidator } from './boolean.js';
+import { NumberValidator } from './number.js';
+import { ObjectValidator } from './object.js';
+import { StringValidator } from './string.js';
+/** 仅进行基本检查（如检查空值），不检查具体格式 */
+export function any(options) {
+    return new Validator(options ?? {});
+}
+export function string(...args) {
+    return new StringValidator(...args);
+}
+export function number(...args) {
+    return new NumberValidator(...args);
+}
+export function boolean(options = {}) {
+    return new BooleanValidator(options);
+}
+export function array(options) {
+    if (options instanceof Validator)
+        options = { item: options };
+    return new ArrayValidator(options);
+}
+export function tuple(validators, baseOptions) {
+    return new ArrayValidator({
+        ...(baseOptions ?? {}),
+        tuple: validators,
+    });
+}
+export function struct(validators, options = {}) {
+    return new ObjectValidator({ ...options, struct: validators });
+}
+export function record(options) {
+    if (options instanceof Validator)
+        options = { record: options };
+    return new ObjectValidator(options);
+}

package/validators/index.d.ts

@@ -0,0 +1,7 @@
+export * from './base.js';
+export * from './array.js';
+export * from './boolean.js';
+export * from './number.js';
+export * from './object.js';
+export * from './string.js';
+export * as validators from './factories.js';

package/validators/index.js

@@ -0,0 +1,7 @@
+export * from './base.js';
+export * from './array.js';
+export * from './boolean.js';
+export * from './number.js';
+export * from './object.js';
+export * from './string.js';
+export * as validators from './factories.js';

package/validators/number.d.ts

@@ -0,0 +1,15 @@
+import { type BaseOptions, Validator } from './base.js';
+export interface NumberOptions {
+    /** 数值最小值 */
+    min?: number;
+    /** 数值最大值 */
+    max?: number;
+    /** 是否允许小数 @default false */
+    float: boolean;
+    /** 指定可选值 */
+    enum?: number[];
+}
+export declare class NumberValidator extends Validator<NumberOptions> {
+    constructor(options?: Partial<BaseOptions & NumberOptions>);
+    validate(field: string, value: unknown): import("../lang/may-success.js").Failed<void> | import("../lang/may-success.js").Success<unknown>;
+}

package/validators/number.js

@@ -0,0 +1,32 @@
+import { success, failed } from '../lang/index.js';
+import { Validator } from './base.js';
+export class NumberValidator extends Validator {
+    constructor(options = {}) {
+        super({
+            float: false,
+            ...options,
+        });
+    }
+    validate(field, value) {
+        const superResult = super.validate(field, value);
+        if (!superResult.success)
+            return superResult;
+        value = superResult.data;
+        if (value === null || value === undefined)
+            return superResult;
+        const opt = this.options;
+        if (typeof value === 'string')
+            value = parseFloat(value);
+        if (typeof value !== 'number' || !isFinite(value))
+            return failed(`${field} must be a valid number`);
+        if (opt.enum !== undefined && !opt.enum.includes(value))
+            return failed(`${field} can only be one of ${opt.enum.join(', ')}.`);
+        if (!opt.float && value % 1 !== 0)
+            return failed(`${field} must be a integer`);
+        if (typeof opt.min === 'number' && value < opt.min)
+            return failed(`${field} must >= ${opt.min}`);
+        if (typeof opt.max === 'number' && value > opt.max)
+            return failed(`${field} must <= ${opt.max}`);
+        return success(value);
+    }
+}

package/validators/object.d.ts

@@ -0,0 +1,20 @@
+import { Validator } from './base.js';
+/** 验证有明确键值对结构的对象 */
+export type StructOptions = {
+    /** 定义对象结构，及各个值的验证规则 */
+    struct: Record<string, Validator>;
+};
+/**
+ * 验证有任意多个 key，但值的类型固定的对象
+ */
+export type RecordOptions = {
+    /** 验证单个值  */
+    record: Validator;
+    /** 对象至少要有几项 */
+    min?: number;
+    /** 对象最多有几项 */
+    max?: number;
+};
+export declare class ObjectValidator extends Validator<StructOptions | RecordOptions> {
+    validate(field: string, value: unknown): import("../lang/may-success.js").Failed<void> | import("../lang/may-success.js").Success<unknown>;
+}

package/validators/object.js

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

package/validators/string.d.ts

@@ -0,0 +1,17 @@
+import { type BaseOptions, Validator } from './base.js';
+export interface StringOptions {
+    /** 字符串最小长度。defaults='' 时默认为 0，否则默认为 1 */
+    min: number;
+    /** 字符串最大长度。 */
+    max?: number;
+    /** 字符串需匹配此正则 */
+    pattern?: RegExp;
+    /** 指定一个数组或 TypeScript enum，字段值必须在此 enum 之中 */
+    enum?: string[] | Record<string, string>;
+    /** 验证之前，是否先清除两侧空白字符（默认开启） */
+    trim: boolean;
+}
+export declare class StringValidator extends Validator<StringOptions> {
+    constructor(options?: Partial<BaseOptions & StringOptions>);
+    validate(field: string, value: unknown): import("../lang/may-success.js").Failed<void> | import("../lang/may-success.js").Success<unknown>;
+}

package/validators/string.js

@@ -0,0 +1,35 @@
+import { success, failed } from '../lang/index.js';
+import { Validator } from './base.js';
+export class StringValidator extends Validator {
+    constructor(options = {}) {
+        super({
+            min: options.defaults === '' ? 0 : 1,
+            trim: true,
+            ...options,
+        });
+    }
+    validate(field, value) {
+        const opt = this.options;
+        const superResult = super.validate(field, value);
+        if (!superResult.success)
+            return superResult;
+        value = superResult.data;
+        if (value === null || value === undefined)
+            return superResult;
+        if (typeof value !== 'string')
+            return failed(`${field} must be a string`);
+        const formatted = opt.trim ? value.trim() : value;
+        if (typeof opt.min === 'number' && formatted.length < opt.min)
+            return failed(`${field}'s length must >= ${opt.min}`);
+        if (typeof opt.max === 'number' && formatted.length > opt.max)
+            return failed(`${field}'s length must <= ${opt.max}`);
+        if (opt.pattern && !opt.pattern.exec(formatted))
+            return failed(`${field} does not match the pattern.`);
+        if (opt.enum !== undefined) {
+            const validValues = Array.isArray(opt.enum) ? opt.enum : Object.values(opt.enum);
+            if (!validValues.includes(formatted))
+                return failed(`${field} can only be one of ${validValues.join(', ')}.`);
+        }
+        return success(formatted);
+    }
+}