@hy_ong/zod-kit 0.0.2 → 0.0.5

package/src/validators/taiwan/national-id.ts

@@ -0,0 +1,208 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type NationalIdMessages = {
+  required?: string
+  invalid?: string
+}
+
+export type NationalIdType =
+  | "citizen"           // 身分證字號 (國民身分證)
+  | "resident"          // 居留證號 (外籍人士統一證號)
+  | "both"              // 身分證/居留證皆可
+
+export type NationalIdOptions<IsRequired extends boolean = true> = {
+  required?: IsRequired
+  type?: NationalIdType
+  allowOldResident?: boolean
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Record<Locale, NationalIdMessages>
+}
+
+export type NationalIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+// 縣市代碼對應表
+const CITY_CODES: Record<string, number> = {
+  'A': 10, 'B': 11, 'C': 12, 'D': 13, 'E': 14, 'F': 15, 'G': 16, 'H': 17,
+  'I': 34, 'J': 18, 'K': 19, 'L': 20, 'M': 21, 'N': 22, 'O': 35, 'P': 23,
+  'Q': 24, 'R': 25, 'S': 26, 'T': 27, 'U': 28, 'V': 29, 'W': 32, 'X': 30,
+  'Y': 31, 'Z': 33
+}
+
+// 驗證國民身分證字號
+const validateCitizenId = (value: string): boolean => {
+  // 格式檢查：1個英文字母 + 9個數字
+  if (!/^[A-Z][1-2]\d{8}$/.test(value)) {
+    return false
+  }
+
+  const letter = value[0]
+  const digits = value.slice(1).split('').map(Number)
+
+  // 獲取縣市代碼
+  const cityCode = CITY_CODES[letter]
+  if (!cityCode) return false
+
+  // 計算校驗碼
+  const cityDigits = [Math.floor(cityCode / 10), cityCode % 10]
+  const coefficients = [1, 9, 8, 7, 6, 5, 4, 3, 2, 1]
+
+  let sum = cityDigits[0] * coefficients[0] + cityDigits[1] * coefficients[1]
+  for (let i = 0; i < 8; i++) {
+    sum += digits[i] * coefficients[i + 2]
+  }
+
+  const checksum = (10 - (sum % 10)) % 10
+  return checksum === digits[8]
+}
+
+// 驗證舊式居留證號
+const validateOldResidentId = (value: string): boolean => {
+  // 格式檢查：1個英文字母 + [AB或CD] + 8個數字
+  if (!/^[A-Z][ABCD]\d{8}$/.test(value)) {
+    return false
+  }
+
+  const letter = value[0]
+  const genderCode = value[1]
+  const digits = value.slice(2).split('').map(Number)
+
+  // 獲取縣市代碼
+  const cityCode = CITY_CODES[letter]
+  if (!cityCode) return false
+
+  // 性別代碼轉換
+  const genderValue = genderCode === 'A' || genderCode === 'C' ? 1 : 0
+
+  // 計算校驗碼
+  const cityDigits = [Math.floor(cityCode / 10), cityCode % 10]
+  const coefficients = [1, 9, 8, 7, 6, 5, 4, 3, 2, 1]
+
+  let sum = cityDigits[0] * coefficients[0] + cityDigits[1] * coefficients[1] + genderValue * coefficients[2]
+  for (let i = 0; i < 7; i++) {
+    sum += digits[i] * coefficients[i + 3]
+  }
+
+  const checksum = (10 - (sum % 10)) % 10
+  return checksum === digits[7]
+}
+
+// 驗證新式居留證號
+const validateNewResidentId = (value: string): boolean => {
+  // 格式檢查：1個英文字母 + [89] + 1個數字[0-9] + 7個數字
+  if (!/^[A-Z][89]\d{8}$/.test(value)) {
+    return false
+  }
+
+  const letter = value[0]
+  const digits = value.slice(1).split('').map(Number)
+
+  // 獲取縣市代碼
+  const cityCode = CITY_CODES[letter]
+  if (!cityCode) return false
+
+  // 計算校驗碼 (與身分證字號相同邏輯)
+  const cityDigits = [Math.floor(cityCode / 10), cityCode % 10]
+  const coefficients = [1, 9, 8, 7, 6, 5, 4, 3, 2, 1]
+
+  let sum = cityDigits[0] * coefficients[0] + cityDigits[1] * coefficients[1]
+  for (let i = 0; i < 8; i++) {
+    sum += digits[i] * coefficients[i + 2]
+  }
+
+  const checksum = (10 - (sum % 10)) % 10
+  return checksum === digits[8]
+}
+
+// 主要驗證函數
+const validateTaiwanNationalId = (value: string, type: NationalIdType = "both", allowOldResident: boolean = true): boolean => {
+  if (!/^[A-Z].{9}$/.test(value)) {
+    return false
+  }
+
+  switch (type) {
+    case "citizen":
+      return validateCitizenId(value)
+    case "resident":
+      return (allowOldResident ? validateOldResidentId(value) : false) || validateNewResidentId(value)
+    case "both":
+      return validateCitizenId(value) || (allowOldResident ? validateOldResidentId(value) : false) || validateNewResidentId(value)
+    default:
+      return false
+  }
+}
+
+export function nationalId<IsRequired extends boolean = true>(options?: NationalIdOptions<IsRequired>): NationalIdSchema<IsRequired> {
+  const {
+    required = true,
+    type = "both",
+    allowOldResident = true,
+    transform,
+    defaultValue,
+    i18n
+  } = options ?? {}
+
+  // Set appropriate default value based on required flag
+  const actualDefaultValue = defaultValue ?? (required ? "" : null)
+
+  // Helper function to get custom message or fallback to default i18n
+  const getMessage = (key: keyof NationalIdMessages, 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.nationalId.${key}`, params)
+  }
+
+  // Preprocessing function
+  const preprocessFn = (val: unknown) => {
+    if (val === "" || val === null || val === undefined) {
+      return actualDefaultValue
+    }
+
+    let processed = String(val).trim().toUpperCase()
+
+    // If after trimming we have an empty string and the field is optional, return null
+    if (processed === "" && !required) {
+      return null
+    }
+
+    if (transform) {
+      processed = transform(processed)
+    }
+
+    return processed
+  }
+
+  const baseSchema = required ? z.preprocess(preprocessFn, z.string()) : z.preprocess(preprocessFn, z.string().nullable())
+
+  const schema = baseSchema.refine((val) => {
+    if (val === null) return true
+
+    // Required check
+    if (required && (val === "" || val === "null" || val === "undefined")) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("required"), path: [] }])
+    }
+
+    if (val === null) return true
+    if (!required && val === "") return true
+
+    // Taiwan National ID validation
+    if (!validateTaiwanNationalId(val, type, allowOldResident)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("invalid"), path: [] }])
+    }
+
+    return true
+  })
+
+  return schema as unknown as NationalIdSchema<IsRequired>
+}
+
+// Export utility functions for external use
+export { validateTaiwanNationalId, validateCitizenId, validateOldResidentId, validateNewResidentId }

package/src/validators/taiwan/tel.ts

@@ -0,0 +1,182 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type TelMessages = {
+  required?: string
+  invalid?: string
+  notInWhitelist?: string
+}
+
+export type TelOptions<IsRequired extends boolean = true> = {
+  required?: IsRequired
+  whitelist?: string[]
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Record<Locale, TelMessages>
+}
+
+export type TelSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+// Taiwan landline telephone validation (Official 2024 rules)
+const validateTaiwanTel = (value: string): boolean => {
+  // Official Taiwan landline formats according to telecom numbering plan:
+  // 02: Taipei, New Taipei, Keelung - 8 digits (2&3&5~8+7D)
+  // 03: Taoyuan, Hsinchu, Yilan, Hualien - 7 digits
+  // 037: Miaoli - 6 digits (2~9+5D)
+  // 04: Taichung, Changhua - 7 digits
+  // 049: Nantou - 7 digits (2~9+6D)
+  // 05: Yunlin, Chiayi - 7 digits
+  // 06: Tainan - 7 digits
+  // 07: Kaohsiung - 7 digits (2~9+6D)
+  // 08: Pingtung - 7 digits (4&7&8+6D)
+  // 082: Kinmen - 6 digits (2~5&7~9+5D)
+  // 0826: Wuqiu - 5 digits (6+4D)
+  // 0836: Matsu - 5 digits (2~9+4D)
+  // 089: Taitung - 6 digits (2~9+5D)
+
+  // Remove common separators for validation
+  const cleanValue = value.replace(/[-\s]/g, "")
+
+  // Basic format: starts with 0, then area code, then number
+  if (!/^0\d{7,10}$/.test(cleanValue)) {
+    return false
+  }
+
+  // Check 4-digit area codes first
+  const areaCode4 = cleanValue.substring(0, 4)
+  if (areaCode4 === "0826") {
+    // Wuqiu: 0826 + 5 digits (6+4D), total 9 digits
+    return cleanValue.length === 9 && /^0826[6]\d{4}$/.test(cleanValue)
+  }
+  if (areaCode4 === "0836") {
+    // Matsu: 0836 + 5 digits (2~9+4D), total 9 digits
+    return cleanValue.length === 9 && /^0836[2-9]\d{4}$/.test(cleanValue)
+  }
+
+  // Check 3-digit area codes
+  const areaCode3 = cleanValue.substring(0, 3)
+  if (areaCode3 === "037") {
+    // Miaoli: 037 + 6 digits (2~9+5D), total 9 digits
+    return cleanValue.length === 9 && /^037[2-9]\d{5}$/.test(cleanValue)
+  }
+  if (areaCode3 === "049") {
+    // Nantou: 049 + 7 digits (2~9+6D), total 10 digits
+    return cleanValue.length === 10 && /^049[2-9]\d{6}$/.test(cleanValue)
+  }
+  if (areaCode3 === "082") {
+    // Kinmen: 082 + 6 digits (2~5&7~9+5D), total 9 digits
+    return cleanValue.length === 9 && /^082[2-57-9]\d{5}$/.test(cleanValue)
+  }
+  if (areaCode3 === "089") {
+    // Taitung: 089 + 6 digits (2~9+5D), total 9 digits
+    return cleanValue.length === 9 && /^089[2-9]\d{5}$/.test(cleanValue)
+  }
+
+  // Check 2-digit area codes
+  const areaCode2 = cleanValue.substring(0, 2)
+
+  if (areaCode2 === "02") {
+    // Taipei, New Taipei, Keelung: 02 + 8 digits (2&3&5~8+7D), total 10 digits
+    return cleanValue.length === 10 && /^02[235-8]\d{7}$/.test(cleanValue)
+  }
+  if (["03", "04", "05", "06"].includes(areaCode2)) {
+    // Taoyuan/Hsinchu/Yilan/Hualien (03), Taichung/Changhua (04),
+    // Yunlin/Chiayi (05), Tainan (06): 7 digits, total 9 digits
+    return cleanValue.length === 9
+  }
+  if (areaCode2 === "07") {
+    // Kaohsiung: 07 + 7 digits (2~9+6D), total 9 digits
+    return cleanValue.length === 9 && /^07[2-9]\d{6}$/.test(cleanValue)
+  }
+  if (areaCode2 === "08") {
+    // Pingtung: 08 + 7 digits (4&7&8+6D), total 9 digits
+    return cleanValue.length === 9 && /^08[478]\d{6}$/.test(cleanValue)
+  }
+
+  return false
+}
+
+export function tel<IsRequired extends boolean = true>(options?: TelOptions<IsRequired>): TelSchema<IsRequired> {
+  const { required = true, whitelist, transform, defaultValue, i18n } = options ?? {}
+
+  // Set appropriate default value based on required flag
+  const actualDefaultValue = defaultValue ?? (required ? "" : null)
+
+  // Helper function to get custom message or fallback to default i18n
+  const getMessage = (key: keyof TelMessages, 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.tel.${key}`, params)
+  }
+
+  // Preprocessing function
+  const preprocessFn = (val: unknown) => {
+    if (val === null || val === undefined) {
+      return actualDefaultValue
+    }
+
+    let processed = String(val).trim()
+
+    // If after trimming we have an empty string
+    if (processed === "") {
+      // If empty string is in allowlist, return it as is
+      if (whitelist && whitelist.includes("")) {
+        return ""
+      }
+      // If the field is optional and empty string not in allowlist, return default value
+      if (!required) {
+        return actualDefaultValue
+      }
+      // If a field is required, return the default value (will be validated later)
+      return actualDefaultValue
+    }
+
+    if (transform) {
+      processed = transform(processed)
+    }
+
+    return processed
+  }
+
+  const baseSchema = required ? z.preprocess(preprocessFn, z.string()) : z.preprocess(preprocessFn, z.string().nullable())
+
+  const schema = baseSchema.refine((val) => {
+    if (val === null) return true
+
+    // Required check
+    if (required && (val === "" || val === "null" || val === "undefined")) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("required"), path: [] }])
+    }
+
+    if (val === null) return true
+    if (!required && val === "") return true
+
+    // Allowlist check (if an allowlist is provided, only allow values in the allowlist)
+    if (whitelist && whitelist.length > 0) {
+      if (whitelist.includes(val)) {
+        return true
+      }
+      // If not in the allowlist, reject regardless of format
+      throw new z.ZodError([{ code: "custom", message: getMessage("notInWhitelist"), path: [] }])
+    }
+
+    // Taiwan telephone format validation (only if no allowlist or allowlist is empty)
+    if (!validateTaiwanTel(val)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("invalid"), path: [] }])
+    }
+
+    return true
+  })
+
+  return schema as unknown as TelSchema<IsRequired>
+}
+
+// Export utility function for external use
+export { validateTaiwanTel }