@hy_ong/zod-kit 0.1.16 → 0.2.1

package/src/i18n/locales/zh-CN.json

@@ -0,0 +1,247 @@
+{
+  "common": {
+    "boolean": {
+      "required": "必填",
+      "shouldBeTrue": "必须为是",
+      "shouldBeFalse": "必须为否",
+      "invalid": "必须为布尔值"
+    },
+    "email": {
+      "required": "必填",
+      "invalid": "电子邮件格式错误",
+      "minLength": "长度至少 ${minLength} 个字符",
+      "maxLength": "长度最多 ${maxLength} 个字符",
+      "includes": "必须包含「${includes}」",
+      "domain": "必须为 ${domain} 域名",
+      "domainBlacklist": "不允许使用 ${domain} 域名",
+      "businessOnly": "仅允许企业邮箱地址",
+      "noDisposable": "不允许使用临时邮箱地址"
+    },
+    "url": {
+      "required": "必填",
+      "invalid": "无效的 URL 格式",
+      "min": "长度至少 ${min} 个字符",
+      "max": "长度最多 ${max} 个字符",
+      "includes": "必须包含「${includes}」",
+      "excludes": "不得包含「${excludes}」",
+      "protocol": "协议必须为：${protocols}",
+      "domain": "域名必须为：${domains}",
+      "domainBlacklist": "不允许使用域名 ${domain}",
+      "port": "端口必须为：${ports}",
+      "pathStartsWith": "路径必须以「${path}」开头",
+      "pathEndsWith": "路径必须以「${path}」结尾",
+      "hasQuery": "URL 必须包含查询参数",
+      "noQuery": "URL 不得包含查询参数",
+      "hasFragment": "URL 必须包含锚点",
+      "noFragment": "URL 不得包含锚点",
+      "localhost": "不允许使用本地 URL",
+      "noLocalhost": "不允许使用本地 URL"
+    },
+    "password": {
+      "required": "必填",
+      "min": "长度至少 ${min} 个字符",
+      "max": "长度最多 ${max} 个字符",
+      "uppercase": "必须包含至少一个大写字母",
+      "lowercase": "必须包含至少一个小写字母",
+      "digits": "必须包含至少一个数字",
+      "special": "必须包含至少一个特殊符号",
+      "noRepeating": "不可包含重复字符",
+      "noSequential": "不可包含连续字符",
+      "noCommonWords": "不可包含常见密码或模式",
+      "minStrength": "密码强度必须至少为 ${minStrength}",
+      "excludes": "不得包含「${excludes}」",
+      "includes": "必须包含「${includes}」",
+      "invalid": "密码格式错误"
+    },
+    "number": {
+      "required": "必填",
+      "invalid": "必须为有效数字",
+      "integer": "必须为整数",
+      "float": "必须为小数",
+      "min": "最小值 ${min}",
+      "max": "最大值 ${max}",
+      "positive": "必须为正数",
+      "negative": "必须为负数",
+      "nonNegative": "不可为负数",
+      "nonPositive": "不可为正数",
+      "multipleOf": "必须为 ${multipleOf} 的倍数",
+      "finite": "必须为有限数字",
+      "precision": "小数位数不可超过 ${precision} 位"
+    },
+    "id": {
+      "required": "必填",
+      "invalid": "无效的 ID 格式",
+      "minLength": "长度至少 ${minLength} 个字符",
+      "maxLength": "长度最多 ${maxLength} 个字符",
+      "numeric": "必须为数字 ID",
+      "uuid": "必须为有效的 UUID",
+      "objectId": "必须为有效的 MongoDB ObjectId",
+      "nanoid": "必须为有效的 Nano ID",
+      "snowflake": "必须为有效的 Snowflake ID",
+      "cuid": "必须为有效的 CUID",
+      "ulid": "必须为有效的 ULID",
+      "shortid": "必须为有效的 Short ID",
+      "customFormat": "无效的 ID 格式",
+      "includes": "必须包含「${includes}」",
+      "excludes": "不得包含「${excludes}」",
+      "startsWith": "必须以「${startsWith}」开头",
+      "endsWith": "必须以「${endsWith}」结尾"
+    },
+    "text": {
+      "required": "必填",
+      "notEmpty": "不可为空白或仅含空格",
+      "minLength": "长度至少 ${minLength} 个字符",
+      "maxLength": "长度最多 ${maxLength} 个字符",
+      "startsWith": "必须以「${startsWith}」开头",
+      "endsWith": "必须以「${endsWith}」结尾",
+      "includes": "必须包含「${includes}」",
+      "excludes": "不得包含「${excludes}」",
+      "invalid": "格式错误"
+    },
+    "date": {
+      "required": "必填",
+      "invalid": "无效日期",
+      "format": "必须为 ${format} 格式",
+      "min": "日期不得早于 ${min}",
+      "max": "日期不得晚于 ${max}",
+      "includes": "必须包含「${includes}」",
+      "excludes": "不得包含「${excludes}」",
+      "past": "必须为过去的日期",
+      "future": "必须为未来的日期",
+      "today": "必须为今天",
+      "notToday": "不得为今天",
+      "weekday": "必须为工作日（周一至周五）",
+      "weekend": "必须为周末（周六至周日）"
+    },
+    "time": {
+      "required": "必填",
+      "invalid": "无效的时间格式",
+      "format": "必须为 ${format} 格式",
+      "min": "时间不得早于 ${min}",
+      "max": "时间不得晚于 ${max}",
+      "hour": "小时必须介于 ${minHour} 与 ${maxHour} 之间",
+      "minute": "分钟必须为 ${minuteStep} 分钟间隔",
+      "second": "秒数必须为 ${secondStep} 秒间隔",
+      "includes": "必须包含「${includes}」",
+      "excludes": "不得包含「${excludes}」",
+      "customRegex": "无效的时间格式",
+      "notInWhitelist": "时间不在允许列表中"
+    },
+    "datetime": {
+      "required": "必填",
+      "invalid": "无效的日期时间格式",
+      "format": "必须为 ${format} 格式",
+      "min": "日期时间不得早于 ${min}",
+      "max": "日期时间不得晚于 ${max}",
+      "hour": "小时必须介于 ${minHour} 与 ${maxHour} 之间",
+      "minute": "分钟必须为 ${minuteStep} 分钟间隔",
+      "includes": "必须包含「${includes}」",
+      "excludes": "不得包含「${excludes}」",
+      "past": "必须为过去的日期时间",
+      "future": "必须为未来的日期时间",
+      "today": "必须为今天",
+      "notToday": "不得为今天",
+      "weekday": "必须为工作日（周一至周五）",
+      "weekend": "必须为周末（周六至周日）",
+      "customRegex": "无效的日期时间格式",
+      "notInWhitelist": "日期时间不在允许列表中"
+    },
+    "file": {
+      "required": "必填",
+      "invalid": "无效的文件格式",
+      "size": "文件大小不得超过 ${size}",
+      "minSize": "文件大小至少 ${minSize}",
+      "maxSize": "文件大小不得超过 ${maxSize}",
+      "type": "文件类型必须为：${type}",
+      "extension": "扩展名必须为：${extension}",
+      "extensionBlacklist": "不允许使用扩展名 ${extension}",
+      "name": "文件名必须符合格式 ${pattern}",
+      "nameBlacklist": "文件名不得符合格式 ${pattern}",
+      "imageOnly": "仅允许图片文件",
+      "documentOnly": "仅允许文档文件",
+      "videoOnly": "仅允许视频文件",
+      "audioOnly": "仅允许音频文件",
+      "archiveOnly": "仅允许压缩文件"
+    },
+    "creditCard": {
+      "required": "必填",
+      "invalid": "无效的信用卡号码",
+      "notInWhitelist": "信用卡号码不在允许的列表中"
+    },
+    "ip": {
+      "required": "必填",
+      "invalid": "无效的 IP 地址",
+      "notIPv4": "必须为有效的 IPv4 地址",
+      "notIPv6": "必须为有效的 IPv6 地址",
+      "notInWhitelist": "IP 地址不在允许的列表中"
+    },
+    "color": {
+      "required": "必填",
+      "invalid": "无效的颜色格式",
+      "notHex": "必须为有效的十六进制颜色",
+      "notRgb": "必须为有效的 RGB 颜色",
+      "notHsl": "必须为有效的 HSL 颜色"
+    },
+    "coordinate": {
+      "required": "必填",
+      "invalid": "无效的坐标",
+      "invalidLatitude": "纬度必须介于 -90 与 90 之间",
+      "invalidLongitude": "经度必须介于 -180 与 180 之间"
+    }
+  },
+  "taiwan": {
+    "businessId": {
+      "required": "必填",
+      "invalid": "无效的统一编号"
+    },
+    "nationalId": {
+      "required": "必填",
+      "invalid": "无效的身份证号"
+    },
+    "mobile": {
+      "required": "必填",
+      "invalid": "无效的手机号码格式",
+      "notInWhitelist": "不在允许的手机号码列表中"
+    },
+    "tel": {
+      "required": "必填",
+      "invalid": "无效的座机号码格式",
+      "notInWhitelist": "不在允许的座机号码列表中"
+    },
+    "fax": {
+      "required": "必填",
+      "invalid": "无效的传真号码格式",
+      "notInWhitelist": "不在允许的传真号码列表中"
+    },
+    "postalCode": {
+      "required": "必填",
+      "invalid": "无效的邮政编码",
+      "invalidFormat": "邮政编码格式错误",
+      "invalidRange": "邮政编码超出有效范围",
+      "legacy5DigitWarning": "5 位邮政编码为旧式格式，建议使用 6 位格式",
+      "format3Only": "仅允许 3 位邮政编码",
+      "format5Only": "仅允许 5 位邮政编码",
+      "format6Only": "仅允许 6 位邮政编码",
+      "invalidSuffix": "无效的邮政编码后缀 - 5 位格式须为 01-99，6 位格式须为 001-999",
+      "deprecated5Digit": "5 位邮政编码已弃用且不再支持"
+    },
+    "invoice": {
+      "required": "必填",
+      "invalid": "无效的统一发票号码"
+    },
+    "licensePlate": {
+      "required": "必填",
+      "invalid": "无效的车牌号码"
+    },
+    "bankAccount": {
+      "required": "必填",
+      "invalid": "无效的银行账号",
+      "invalidBankCode": "无效的银行代码",
+      "invalidAccountNumber": "无效的账号号码"
+    },
+    "passport": {
+      "required": "必填",
+      "invalid": "无效的护照号码"
+    }
+  }
+}

package/src/i18n/locales/zh-TW.json

@@ -162,6 +162,31 @@
       "videoOnly": "僅允許影片檔案",
       "audioOnly": "僅允許音訊檔案",
       "archiveOnly": "僅允許壓縮檔案"
+    },
+    "creditCard": {
+      "required": "必填",
+      "invalid": "無效的信用卡號碼",
+      "notInWhitelist": "信用卡號碼不在允許的清單中"
+    },
+    "ip": {
+      "required": "必填",
+      "invalid": "無效的 IP 位址",
+      "notIPv4": "必須為有效的 IPv4 位址",
+      "notIPv6": "必須為有效的 IPv6 位址",
+      "notInWhitelist": "IP 位址不在允許的清單中"
+    },
+    "color": {
+      "required": "必填",
+      "invalid": "無效的顏色格式",
+      "notHex": "必須為有效的十六進位顏色",
+      "notRgb": "必須為有效的 RGB 顏色",
+      "notHsl": "必須為有效的 HSL 顏色"
+    },
+    "coordinate": {
+      "required": "必填",
+      "invalid": "無效的座標",
+      "invalidLatitude": "緯度必須介於 -90 與 90 之間",
+      "invalidLongitude": "經度必須介於 -180 與 180 之間"
     }
   },
   "taiwan": {
@@ -199,6 +224,24 @@
       "format6Only": "僅允許 6 碼郵遞區號",
       "invalidSuffix": "無效的郵遞區號後碼 - 5 碼格式須為 01-99，6 碼格式須為 001-999",
       "deprecated5Digit": "5 碼郵遞區號已棄用且不再支援"
+    },
+    "invoice": {
+      "required": "必填",
+      "invalid": "無效的統一發票號碼"
+    },
+    "licensePlate": {
+      "required": "必填",
+      "invalid": "無效的車牌號碼"
+    },
+    "bankAccount": {
+      "required": "必填",
+      "invalid": "無效的銀行帳號",
+      "invalidBankCode": "無效的銀行代碼",
+      "invalidAccountNumber": "無效的帳號號碼"
+    },
+    "passport": {
+      "required": "必填",
+      "invalid": "無效的護照號碼"
     }
   }
 }

package/src/index.ts

@@ -1,18 +1,26 @@
 export * from "./validators/common/boolean"
+export * from "./validators/common/color"
+export * from "./validators/common/coordinate"
+export * from "./validators/common/credit-card"
 export * from "./validators/common/date"
 export * from "./validators/common/datetime"
 export * from "./validators/common/email"
 export * from "./validators/common/file"
 export * from "./validators/common/id"
+export * from "./validators/common/ip"
 export * from "./validators/common/number"
 export * from "./validators/common/password"
 export * from "./validators/common/text"
 export * from "./validators/common/time"
 export * from "./validators/common/url"
+export * from "./validators/taiwan/bank-account"
 export * from "./validators/taiwan/business-id"
-export * from "./validators/taiwan/national-id"
+export * from "./validators/taiwan/fax"
+export * from "./validators/taiwan/invoice"
+export * from "./validators/taiwan/license-plate"
 export * from "./validators/taiwan/mobile"
+export * from "./validators/taiwan/national-id"
+export * from "./validators/taiwan/passport"
 export * from "./validators/taiwan/postal-code"
 export * from "./validators/taiwan/tel"
-export * from "./validators/taiwan/fax"
 export * from "./config"

package/src/validators/common/boolean.ts

@@ -49,7 +49,7 @@ export type BooleanOptions<IsRequired extends boolean = true> = {
   falsyValues?: unknown[]
   strict?: boolean
   transform?: (value: boolean) => boolean
-  i18n?: Record<Locale, BooleanMessages>
+  i18n?: Partial<Record<Locale, Partial<BooleanMessages>>>
 }
 
 /**

package/src/validators/common/color.ts

@@ -0,0 +1,192 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type ColorFormat = "hex" | "rgb" | "hsl" | "any"
+
+export type ColorMessages = {
+  required?: string
+  invalid?: string
+  notHex?: string
+  notRgb?: string
+  notHsl?: string
+}
+
+export type ColorOptions<IsRequired extends boolean = true> = {
+  format?: ColorFormat | ColorFormat[]
+  allowAlpha?: boolean
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Partial<Record<Locale, Partial<ColorMessages>>>
+}
+
+export type ColorSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+const HEX_RGB = /^#[0-9a-f]{3}$/i
+const HEX_RRGGBB = /^#[0-9a-f]{6}$/i
+const HEX_RRGGBBAA = /^#[0-9a-f]{8}$/i
+
+function isValidByte(n: number): boolean {
+  return Number.isInteger(n) && n >= 0 && n <= 255
+}
+
+function isValidAlpha(n: number): boolean {
+  return n >= 0 && n <= 1
+}
+
+function isValidHue(n: number): boolean {
+  return n >= 0 && n <= 360
+}
+
+function isValidPercentage(n: number): boolean {
+  return n >= 0 && n <= 100
+}
+
+function validateHex(value: string, allowAlpha: boolean): boolean {
+  if (HEX_RGB.test(value) || HEX_RRGGBB.test(value)) return true
+  if (allowAlpha && HEX_RRGGBBAA.test(value)) return true
+  return false
+}
+
+function validateRgb(value: string, allowAlpha: boolean): boolean {
+  const rgbaMatch = value.match(/^rgba?\(\s*(-?\d+(?:\.\d+)?)\s*,\s*(-?\d+(?:\.\d+)?)\s*,\s*(-?\d+(?:\.\d+)?)\s*(?:,\s*(-?\d+(?:\.\d+)?))?\s*\)$/)
+  if (!rgbaMatch) return false
+
+  const r = Number(rgbaMatch[1])
+  const g = Number(rgbaMatch[2])
+  const b = Number(rgbaMatch[3])
+  const a = rgbaMatch[4] !== undefined ? Number(rgbaMatch[4]) : undefined
+
+  if (!isValidByte(r) || !isValidByte(g) || !isValidByte(b)) return false
+
+  if (a !== undefined) {
+    if (!allowAlpha) return false
+    if (!isValidAlpha(a)) return false
+  }
+
+  // If function name is "rgba", alpha must be present
+  if (value.startsWith("rgba(") && a === undefined) return false
+  // If function name is "rgb", alpha must not be present
+  if (value.startsWith("rgb(") && a !== undefined) return false
+
+  return true
+}
+
+function validateHsl(value: string, allowAlpha: boolean): boolean {
+  const hslaMatch = value.match(/^hsla?\(\s*(-?\d+(?:\.\d+)?)\s*,\s*(-?\d+(?:\.\d+)?)%\s*,\s*(-?\d+(?:\.\d+)?)%\s*(?:,\s*(-?\d+(?:\.\d+)?))?\s*\)$/)
+  if (!hslaMatch) return false
+
+  const h = Number(hslaMatch[1])
+  const s = Number(hslaMatch[2])
+  const l = Number(hslaMatch[3])
+  const a = hslaMatch[4] !== undefined ? Number(hslaMatch[4]) : undefined
+
+  if (!isValidHue(h) || !isValidPercentage(s) || !isValidPercentage(l)) return false
+
+  if (a !== undefined) {
+    if (!allowAlpha) return false
+    if (!isValidAlpha(a)) return false
+  }
+
+  // If function name is "hsla", alpha must be present
+  if (value.startsWith("hsla(") && a === undefined) return false
+  // If function name is "hsl", alpha must not be present
+  if (value.startsWith("hsl(") && a !== undefined) return false
+
+  return true
+}
+
+function validateColor(value: string, formats: ColorFormat[], allowAlpha: boolean): { valid: boolean; failedFormat?: ColorFormat } {
+  const hasAny = formats.includes("any")
+
+  if (hasAny) {
+    if (validateHex(value, allowAlpha)) return { valid: true }
+    if (validateRgb(value, allowAlpha)) return { valid: true }
+    if (validateHsl(value, allowAlpha)) return { valid: true }
+    return { valid: false }
+  }
+
+  for (const format of formats) {
+    if (format === "hex" && validateHex(value, allowAlpha)) return { valid: true }
+    if (format === "rgb" && validateRgb(value, allowAlpha)) return { valid: true }
+    if (format === "hsl" && validateHsl(value, allowAlpha)) return { valid: true }
+  }
+
+  if (formats.length === 1) {
+    return { valid: false, failedFormat: formats[0] }
+  }
+
+  return { valid: false }
+}
+
+export function color<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<ColorOptions<IsRequired>, "required">): ColorSchema<IsRequired> {
+  const { format = "any", allowAlpha = true, transform, defaultValue, i18n } = options ?? {}
+
+  const isRequired = required ?? (false as IsRequired)
+
+  const actualDefaultValue = defaultValue ?? (isRequired ? "" : null)
+
+  const formats: ColorFormat[] = Array.isArray(format) ? format : [format]
+
+  const getMessage = (key: keyof ColorMessages, params?: Record<string, any>) => {
+    if (i18n) {
+      const currentLocale = getLocale()
+      const customMessages = i18n[currentLocale]
+      if (customMessages && customMessages[key]) {
+        const template = customMessages[key]!
+        return template.replace(/\$\{(\w+)}/g, (_, k) => params?.[k] ?? "")
+      }
+    }
+    return t(`common.color.${key}`, params)
+  }
+
+  const preprocessFn = (val: unknown) => {
+    if (val === "" || val === null || val === undefined) {
+      return actualDefaultValue
+    }
+
+    let processed = String(val).trim()
+
+    if (processed === "" && !required) {
+      return null
+    }
+
+    if (transform) {
+      processed = transform(processed)
+    }
+
+    return processed
+  }
+
+  const baseSchema = isRequired ? z.preprocess(preprocessFn, z.string()) : z.preprocess(preprocessFn, z.string().nullable())
+
+  const schema = baseSchema.superRefine((val, ctx) => {
+    if (val === null) return
+
+    if (isRequired && (val === "" || val === "null" || val === "undefined")) {
+      ctx.addIssue({ code: "custom", message: getMessage("required") })
+      return
+    }
+
+    if (!isRequired && val === "") return
+
+    const result = validateColor(val, formats, allowAlpha)
+
+    if (!result.valid) {
+      const formatMessageMap: Record<ColorFormat, keyof ColorMessages> = {
+        hex: "notHex",
+        rgb: "notRgb",
+        hsl: "notHsl",
+        any: "invalid",
+      }
+
+      const messageKey = result.failedFormat ? formatMessageMap[result.failedFormat] : "invalid"
+      ctx.addIssue({ code: "custom", message: getMessage(messageKey) })
+      return
+    }
+  })
+
+  return schema as unknown as ColorSchema<IsRequired>
+}
+
+export { validateColor }