@hy_ong/zod-kit 0.2.0 → 0.2.1

package/src/validators/common/ip.ts

@@ -0,0 +1,210 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type IpVersion = "v4" | "v6" | "any"
+
+export type IpMessages = {
+  required?: string
+  invalid?: string
+  notIPv4?: string
+  notIPv6?: string
+  notInWhitelist?: string
+}
+
+export type IpOptions<IsRequired extends boolean = true> = {
+  version?: IpVersion
+  allowCIDR?: boolean
+  whitelist?: string[]
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Partial<Record<Locale, Partial<IpMessages>>>
+}
+
+export type IpSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+export function validateIPv4(value: string): boolean {
+  const parts = value.split(".")
+  if (parts.length !== 4) return false
+
+  for (const part of parts) {
+    if (part === "") return false
+    // No leading zeros except for the single digit "0"
+    if (part.length > 1 && part.startsWith("0")) return false
+    const num = Number(part)
+    if (!Number.isInteger(num) || num < 0 || num > 255) return false
+  }
+
+  return true
+}
+
+export function validateIPv6(value: string): boolean {
+  // Handle mixed IPv6/IPv4 (e.g., ::ffff:192.0.2.1)
+  const lastColon = value.lastIndexOf(":")
+  if (lastColon !== -1) {
+    const afterLastColon = value.substring(lastColon + 1)
+    if (afterLastColon.includes(".")) {
+      // Mixed form: validate the IPv4 portion
+      if (!validateIPv4(afterLastColon)) return false
+
+      // Validate the IPv6 prefix portion (everything before the IPv4 part)
+      const ipv6Prefix = value.substring(0, lastColon)
+      // The prefix should behave like an IPv6 with fewer groups (max 6 groups since IPv4 occupies 2)
+      return validateIPv6Groups(ipv6Prefix, 6)
+    }
+  }
+
+  return validateIPv6Groups(value, 8)
+}
+
+function validateIPv6Groups(value: string, maxGroups: number): boolean {
+  // Handle :: compression
+  if (value.includes("::")) {
+    // Only one :: is allowed
+    const doubleColonCount = value.split("::").length - 1
+    if (doubleColonCount > 1) return false
+
+    const [left, right] = value.split("::")
+    const leftGroups = left === "" ? [] : left.split(":")
+    const rightGroups = right === "" ? [] : right.split(":")
+
+    // Total groups when expanded must not exceed maxGroups
+    if (leftGroups.length + rightGroups.length >= maxGroups) return false
+
+    // Validate each group
+    for (const group of [...leftGroups, ...rightGroups]) {
+      if (!isValidHexGroup(group)) return false
+    }
+
+    return true
+  }
+
+  // Full form: must have exactly maxGroups groups
+  const groups = value.split(":")
+  if (groups.length !== maxGroups) return false
+
+  for (const group of groups) {
+    if (!isValidHexGroup(group)) return false
+  }
+
+  return true
+}
+
+function isValidHexGroup(group: string): boolean {
+  if (group.length === 0 || group.length > 4) return false
+  return /^[0-9a-fA-F]{1,4}$/.test(group)
+}
+
+export function ip<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<IpOptions<IsRequired>, "required">): IpSchema<IsRequired> {
+  const { version = "any", allowCIDR = false, whitelist, transform, defaultValue, i18n } = options ?? {}
+
+  const isRequired = required ?? (false as IsRequired)
+
+  const actualDefaultValue = defaultValue ?? (isRequired ? "" : null)
+
+  const getMessage = (key: keyof IpMessages, 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.ip.${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
+
+    // Required check
+    if (isRequired && (val === "" || val === "null" || val === "undefined")) {
+      ctx.addIssue({ code: "custom", message: getMessage("required") })
+      return
+    }
+
+    if (!isRequired && val === "") return
+
+    // Separate CIDR prefix if present
+    let ipPart = val
+    let cidrPrefix: string | null = null
+
+    const slashIndex = val.indexOf("/")
+    if (slashIndex !== -1) {
+      if (!allowCIDR) {
+        ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+        return
+      }
+      ipPart = val.substring(0, slashIndex)
+      cidrPrefix = val.substring(slashIndex + 1)
+    }
+
+    // Determine which version(s) to try
+    const isV4 = validateIPv4(ipPart)
+    const isV6 = validateIPv6(ipPart)
+
+    if (version === "v4") {
+      if (!isV4) {
+        ctx.addIssue({ code: "custom", message: getMessage("notIPv4") })
+        return
+      }
+    } else if (version === "v6") {
+      if (!isV6) {
+        ctx.addIssue({ code: "custom", message: getMessage("notIPv6") })
+        return
+      }
+    } else {
+      // version === "any"
+      if (!isV4 && !isV6) {
+        ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+        return
+      }
+    }
+
+    // Validate CIDR prefix length
+    if (cidrPrefix !== null) {
+      if (!/^\d+$/.test(cidrPrefix)) {
+        ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+        return
+      }
+
+      const prefixNum = Number(cidrPrefix)
+      const maxPrefix = isV4 ? 32 : 128
+
+      if (prefixNum < 0 || prefixNum > maxPrefix) {
+        ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+        return
+      }
+    }
+
+    // Whitelist check
+    if (whitelist && whitelist.length > 0) {
+      if (!whitelist.includes(val)) {
+        ctx.addIssue({ code: "custom", message: getMessage("notInWhitelist") })
+        return
+      }
+    }
+  })
+
+  return schema as unknown as IpSchema<IsRequired>
+}

package/src/validators/taiwan/bank-account.ts

@@ -0,0 +1,176 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export const TAIWAN_BANK_CODES: Record<string, string> = {
+  "004": "台灣銀行",
+  "005": "土地銀行",
+  "006": "合庫",
+  "007": "第一銀行",
+  "008": "華南",
+  "009": "彰化",
+  "011": "上海",
+  "012": "台北富邦",
+  "013": "國泰世華",
+  "017": "兆豐",
+  "021": "花旗",
+  "048": "王道",
+  "050": "台灣企銀",
+  "052": "渣打",
+  "053": "台中銀行",
+  "054": "京城",
+  "081": "滙豐",
+  "103": "新光",
+  "108": "陽信",
+  "118": "板信",
+  "147": "三信",
+  "700": "中華郵政",
+  "803": "聯邦",
+  "805": "遠東",
+  "806": "元大",
+  "807": "永豐",
+  "808": "玉山",
+  "809": "凱基",
+  "810": "星展",
+  "812": "台新",
+  "816": "安泰",
+  "822": "中信",
+}
+
+export type TwBankAccountMessages = {
+  required?: string
+  invalid?: string
+  invalidBankCode?: string
+  invalidAccountNumber?: string
+}
+
+export type TwBankAccountOptions<IsRequired extends boolean = true> = {
+  validateBankCode?: boolean
+  bankCode?: string
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Partial<Record<Locale, Partial<TwBankAccountMessages>>>
+}
+
+export type TwBankAccountSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+const validateTaiwanBankAccount = (value: string, validateBankCode: boolean = true): boolean => {
+  let bankCode: string | undefined
+  let accountNumber: string
+
+  if (value.includes("-")) {
+    const parts = value.split("-")
+    if (parts.length !== 2) return false
+    bankCode = parts[0]
+    accountNumber = parts[1]
+  } else {
+    accountNumber = value
+  }
+
+  // Validate bank code if present
+  if (bankCode !== undefined) {
+    if (!/^\d{3}$/.test(bankCode)) return false
+    if (validateBankCode && !(bankCode in TAIWAN_BANK_CODES)) return false
+  }
+
+  // Validate account number: 10-16 digits
+  if (!/^\d{10,16}$/.test(accountNumber)) return false
+
+  return true
+}
+
+export function twBankAccount<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwBankAccountOptions<IsRequired>, "required">): TwBankAccountSchema<IsRequired> {
+  const { validateBankCode = true, bankCode, transform, defaultValue, i18n } = options ?? {}
+
+  const isRequired = required ?? (false as IsRequired)
+
+  const actualDefaultValue = defaultValue ?? (isRequired ? "" : null)
+
+  const getMessage = (key: keyof TwBankAccountMessages, 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(`taiwan.bankAccount.${key}`, params)
+  }
+
+  const preprocessFn = (val: unknown) => {
+    if (val === "" || val === null || val === undefined) {
+      return actualDefaultValue
+    }
+
+    let processed = String(val).trim().replace(/\s/g, "")
+
+    if (processed === "" && !required) {
+      return null
+    }
+
+    if (transform) {
+      processed = transform(processed)
+    }
+
+    // If a bankCode option is set and the value has no hyphen, prepend bankCode
+    if (bankCode && !processed.includes("-")) {
+      processed = `${bankCode}-${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
+
+    // Required check
+    if (isRequired && (val === "" || val === "null" || val === "undefined")) {
+      ctx.addIssue({ code: "custom", message: getMessage("required") })
+      return
+    }
+
+    if (val === null) return
+    if (!isRequired && val === "") return
+
+    // Parse and validate parts separately for specific error messages
+    let parsedBankCode: string | undefined
+    let accountNumber: string
+
+    if (val.includes("-")) {
+      const parts = val.split("-")
+      if (parts.length !== 2) {
+        ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+        return
+      }
+      parsedBankCode = parts[0]
+      accountNumber = parts[1]
+    } else {
+      accountNumber = val
+    }
+
+    // Validate bank code if present
+    if (parsedBankCode !== undefined) {
+      if (!/^\d{3}$/.test(parsedBankCode)) {
+        ctx.addIssue({ code: "custom", message: getMessage("invalidBankCode") })
+        return
+      }
+      if (validateBankCode && !(parsedBankCode in TAIWAN_BANK_CODES)) {
+        ctx.addIssue({ code: "custom", message: getMessage("invalidBankCode") })
+        return
+      }
+    }
+
+    // Validate account number: 10-16 digits
+    if (!/^\d{10,16}$/.test(accountNumber)) {
+      ctx.addIssue({ code: "custom", message: getMessage("invalidAccountNumber") })
+      return
+    }
+  })
+
+  return schema as unknown as TwBankAccountSchema<IsRequired>
+}
+
+export { validateTaiwanBankAccount }

package/src/validators/taiwan/invoice.ts

@@ -0,0 +1,84 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type TwInvoiceMessages = {
+  required?: string
+  invalid?: string
+}
+
+export type TwInvoiceOptions<IsRequired extends boolean = true> = {
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Partial<Record<Locale, Partial<TwInvoiceMessages>>>
+}
+
+export type TwInvoiceSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+const INVOICE_PATTERN = /^[A-Z]{2}\d{8}$/
+
+const validateTaiwanInvoice = (value: string): boolean => {
+  const cleaned = value.replace(/-/g, "")
+  return INVOICE_PATTERN.test(cleaned)
+}
+
+export function twInvoice<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwInvoiceOptions<IsRequired>, "required">): TwInvoiceSchema<IsRequired> {
+  const { transform, defaultValue, i18n } = options ?? {}
+
+  const isRequired = required ?? (false as IsRequired)
+
+  const actualDefaultValue = defaultValue ?? (isRequired ? "" : null)
+
+  const getMessage = (key: keyof TwInvoiceMessages, 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(`taiwan.invoice.${key}`, params)
+  }
+
+  const preprocessFn = (val: unknown) => {
+    if (val === "" || val === null || val === undefined) {
+      return actualDefaultValue
+    }
+
+    let processed = String(val).trim().toUpperCase().replace(/-/g, "")
+
+    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 (val === null) return
+    if (!isRequired && val === "") return
+
+    if (!validateTaiwanInvoice(val)) {
+      ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+      return
+    }
+  })
+
+  return schema as unknown as TwInvoiceSchema<IsRequired>
+}
+
+export { validateTaiwanInvoice }

package/src/validators/taiwan/license-plate.ts

@@ -0,0 +1,110 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type PlateType = "car" | "motorcycle" | "any"
+
+export type TwLicensePlateMessages = {
+  required?: string
+  invalid?: string
+}
+
+export type TwLicensePlateOptions<IsRequired extends boolean = true> = {
+  plateType?: PlateType
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Partial<Record<Locale, Partial<TwLicensePlateMessages>>>
+}
+
+export type TwLicensePlateSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+const CAR_PATTERNS = [
+  /^[A-Z]{3}\d{4}$/, // ABC-1234 (new)
+  /^\d{4}[A-Z]{2}$/, // 1234-AB (new/legacy)
+  /^[A-Z]{2}\d{4}$/, // AB-1234 (legacy)
+  /^[A-Z]\d{5}$/, // A1-2345 -> A12345 (legacy mixed)
+]
+
+const MOTORCYCLE_PATTERNS = [
+  /^[A-Z]{3}\d{4}$/, // ABC-1234
+  /^\d{3}[A-Z]{3}$/, // 123-ABC
+  /^[A-Z]{2}\d{4}$/, // AB-1234 (legacy)
+  /^\d{4}[A-Z]{2}$/, // 1234-AB (legacy)
+]
+
+export const validateTaiwanLicensePlate = (value: string, plateType: PlateType = "any"): boolean => {
+  const patterns: RegExp[] = []
+
+  if (plateType === "car" || plateType === "any") {
+    patterns.push(...CAR_PATTERNS)
+  }
+
+  if (plateType === "motorcycle" || plateType === "any") {
+    for (const pattern of MOTORCYCLE_PATTERNS) {
+      if (!patterns.some((p) => p.source === pattern.source)) {
+        patterns.push(pattern)
+      }
+    }
+  }
+
+  return patterns.some((pattern) => pattern.test(value))
+}
+
+export function twLicensePlate<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwLicensePlateOptions<IsRequired>, "required">): TwLicensePlateSchema<IsRequired> {
+  const { plateType = "any", transform, defaultValue, i18n } = options ?? {}
+
+  const isRequired = required ?? (false as IsRequired)
+
+  const actualDefaultValue = defaultValue ?? (isRequired ? "" : null)
+
+  const getMessage = (key: keyof TwLicensePlateMessages, 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(`taiwan.licensePlate.${key}`, params)
+  }
+
+  const preprocessFn = (val: unknown) => {
+    if (val === "" || val === null || val === undefined) {
+      return actualDefaultValue
+    }
+
+    let processed = String(val).trim().toUpperCase().replace(/[-\s]/g, "")
+
+    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 (val === null) return
+    if (!isRequired && val === "") return
+
+    if (!validateTaiwanLicensePlate(val, plateType)) {
+      ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+      return
+    }
+  })
+
+  return schema as unknown as TwLicensePlateSchema<IsRequired>
+}

package/src/validators/taiwan/passport.ts

@@ -0,0 +1,103 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type PassportType = "ordinary" | "diplomatic" | "official" | "travel" | "any"
+
+export type TwPassportMessages = {
+  required?: string
+  invalid?: string
+}
+
+export type TwPassportOptions<IsRequired extends boolean = true> = {
+  passportType?: PassportType
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Partial<Record<Locale, Partial<TwPassportMessages>>>
+}
+
+export type TwPassportSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+const PASSPORT_TYPE_DIGIT: Record<Exclude<PassportType, "any">, string> = {
+  diplomatic: "0",
+  official: "1",
+  ordinary: "2",
+  travel: "3",
+}
+
+const validateTaiwanPassport = (value: string): boolean => {
+  if (!/^\d{9}$/.test(value)) {
+    return false
+  }
+
+  const firstDigit = parseInt(value[0], 10)
+  return firstDigit >= 0 && firstDigit <= 3
+}
+
+export function twPassport<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwPassportOptions<IsRequired>, "required">): TwPassportSchema<IsRequired> {
+  const { passportType = "any", transform, defaultValue, i18n } = options ?? {}
+
+  const isRequired = required ?? (false as IsRequired)
+
+  const actualDefaultValue = defaultValue ?? (isRequired ? "" : null)
+
+  const getMessage = (key: keyof TwPassportMessages, 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(`taiwan.passport.${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
+
+    if (!validateTaiwanPassport(val)) {
+      ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+      return
+    }
+
+    if (passportType !== "any") {
+      const expectedDigit = PASSPORT_TYPE_DIGIT[passportType]
+      if (val[0] !== expectedDigit) {
+        ctx.addIssue({ code: "custom", message: getMessage("invalid") })
+        return
+      }
+    }
+  })
+
+  return schema as unknown as TwPassportSchema<IsRequired>
+}
+
+export { validateTaiwanPassport }