@anjianshi/utils 2.7.0 → 2.8.1

package/src/validators/object.ts

@@ -1,101 +0,0 @@
-import isPlainObject from 'lodash/isPlainObject.js'
-import { success, failed } from '../lang/index.js'
-import {
-  getValidatorGenerator,
-  type CommonOptions,
-  type Validator,
-  type Validated,
-  type AllowedInputValue,
-} from './base.js'
-
-/** 验证有明确键值对结构的对象 */
-export interface StructOptions extends CommonOptions {
-  /** 定义对象结构，及各个值的验证规则 */
-  struct: Record<string, Validator<unknown, CommonOptions>>
-}
-
-type StructValues<Options extends StructOptions> = {
-  [Key in keyof Options['struct']]: Options['struct'][Key] extends Validator<
-    infer Value,
-    infer Options
-  >
-    ? Validated<Value, Options>
-    : never
-}
-
-export function getStructValidator<const Options extends StructOptions>(options: Options) {
-  return getValidatorGenerator<StructValues<Options>, Options>(
-    function validate(field, value, options) {
-      if (!isPlainObject(value)) return failed(`${field} should be a plain object`)
-
-      const formatted: Record<string, unknown> = {}
-      for (const [key, itemValidator] of Object.entries(options.struct)) {
-        const itemResult = itemValidator(
-          `${field}["${key}"]`,
-          (value as Record<string, AllowedInputValue>)[key],
-        )
-        if (itemResult.success) {
-          if (itemResult.data !== undefined) formatted[key] = itemResult.data
-        } else {
-          return itemResult
-        }
-      }
-      return success(formatted as StructValues<Options>)
-    },
-  )(options)
-}
-
-// ---------------------------------------------------
-
-/**
- * 验证有任意多个 key，但值的类型固定的对象
- */
-export interface RecordOptions extends CommonOptions {
-  /** 验证单个值  */
-  record: Validator<unknown, CommonOptions>
-
-  /** 对象至少要有几项 */
-  min?: number
-
-  /** 对象最多有几项 */
-  max?: number
-}
-
-type RecordValues<Options extends RecordOptions> = Record<
-  string,
-  Validated<
-    Options extends { record: Validator<infer T, CommonOptions> } ? T : never,
-    Options extends { record: Validator<unknown, infer T> } ? T : never
-  >
->
-
-export function getRecordValidator<Options extends RecordOptions>(options: Options) {
-  return getValidatorGenerator<RecordValues<Options>, Options>(
-    function validate(field, value, options) {
-      if (!isPlainObject(value)) return failed(`${field} should be a plain object`)
-
-      const formatted: Record<string, unknown> = {}
-      for (const [key, itemValue] of Object.entries(value as Record<string, AllowedInputValue>)) {
-        // 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 as RecordValues<Options>)
-    },
-  )(options)
-}

package/src/validators/one-of.ts

@@ -1,33 +0,0 @@
-import { failed, type MaySuccess } from '../lang/index.js'
-import {
-  getValidatorGenerator,
-  type CommonOptions,
-  type Validator,
-  type AllowedInputValue,
-} 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 function getOneOfValidator<const Options extends OneOfOptions>(
-  options: Options = {} as Options
-) {
-  return getValidatorGenerator<OneOfValue<Options>, Options>(function validate(field, value) {
-    const errors: string[] = []
-    for (const validator of options.validators) {
-      const result = validator(field, value as AllowedInputValue)
-      if (result.success) return result as MaySuccess<OneOfValue<Options>>
-      else errors.push(result.message)
-    }
-    return failed(`${field} do not match any valid format：\n- ` + errors.join('\n- '))
-  })(options)
-}

package/src/validators/string.ts

@@ -1,72 +0,0 @@
-import { success, failed } from '../lang/index.js'
-import { getValidatorGenerator, 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 function getStringValidator<const Options extends StringOptions>(
-  options: Options = {} as Options,
-) {
-  return getValidatorGenerator<StringValueWithChoices<Options>, Options>(
-    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: string[] = 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 as StringValueWithChoices<Options>)
-    },
-  )(options)
-}