@hy_ong/zod-kit 0.0.4 → 0.0.5

package/src/validators/common/url.ts

@@ -0,0 +1,207 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type UrlMessages = {
+  required?: string
+  invalid?: string
+  min?: string
+  max?: string
+  includes?: string
+  excludes?: string
+  protocol?: string
+  domain?: string
+  domainBlacklist?: string
+  port?: string
+  pathStartsWith?: string
+  pathEndsWith?: string
+  hasQuery?: string
+  noQuery?: string
+  hasFragment?: string
+  noFragment?: string
+  localhost?: string
+  noLocalhost?: string
+}
+
+export type UrlOptions<IsRequired extends boolean = true> = {
+  required?: IsRequired
+  min?: number
+  max?: number
+  includes?: string
+  excludes?: string | string[]
+  protocols?: string[]
+  allowedDomains?: string[]
+  blockedDomains?: string[]
+  allowedPorts?: number[]
+  blockedPorts?: number[]
+  pathStartsWith?: string
+  pathEndsWith?: string
+  mustHaveQuery?: boolean
+  mustNotHaveQuery?: boolean
+  mustHaveFragment?: boolean
+  mustNotHaveFragment?: boolean
+  allowLocalhost?: boolean
+  blockLocalhost?: boolean
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Record<Locale, UrlMessages>
+}
+
+export type UrlSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+export function url<IsRequired extends boolean = true>(options?: UrlOptions<IsRequired>): UrlSchema<IsRequired> {
+  const {
+    required = true,
+    min,
+    max,
+    includes,
+    excludes,
+    protocols,
+    allowedDomains,
+    blockedDomains,
+    allowedPorts,
+    blockedPorts,
+    pathStartsWith,
+    pathEndsWith,
+    mustHaveQuery,
+    mustNotHaveQuery,
+    mustHaveFragment,
+    mustNotHaveFragment,
+    allowLocalhost = true,
+    blockLocalhost,
+    transform,
+    defaultValue = null,
+    i18n,
+  } = options ?? {}
+
+  const actualDefaultValue = defaultValue ?? (required ? "" : null)
+
+  // Helper function to get custom message or fallback to default i18n
+  const getMessage = (key: keyof UrlMessages, 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.url.${key}`, params)
+  }
+
+  // Preprocessing function with transformations
+  const preprocessFn = (val: unknown) => {
+    if (val === "" || val === null || val === undefined) {
+      return actualDefaultValue
+    }
+
+    let processed = String(val).trim()
+
+    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: [] }])
+    }
+
+    // URL format validation
+    let urlObj: URL
+    try {
+      urlObj = new URL(val)
+    } catch {
+      throw new z.ZodError([{ code: "custom", message: getMessage("invalid"), path: [] }])
+    }
+
+    // Length checks
+    if (val !== null && min !== undefined && val.length < min) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("min", { min }), path: [] }])
+    }
+    if (val !== null && max !== undefined && val.length > max) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("max", { max }), path: [] }])
+    }
+
+    // String content checks
+    if (val !== null && includes !== undefined && !val.includes(includes)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("includes", { includes }), path: [] }])
+    }
+    if (val !== null && excludes !== undefined) {
+      const excludeList = Array.isArray(excludes) ? excludes : [excludes]
+      for (const exclude of excludeList) {
+        if (val.includes(exclude)) {
+          throw new z.ZodError([{ code: "custom", message: getMessage("excludes", { excludes: exclude }), path: [] }])
+        }
+      }
+    }
+
+    // Protocol validation
+    if (protocols && !protocols.includes(urlObj.protocol.slice(0, -1))) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("protocol", { protocols: protocols.join(", ") }), path: [] }])
+    }
+
+    // Domain validation
+    const hostname = urlObj.hostname.toLowerCase()
+    if (allowedDomains && !allowedDomains.some((domain) => hostname === domain || hostname.endsWith(`.${domain}`))) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("domain", { domains: allowedDomains.join(", ") }), path: [] }])
+    }
+    if (blockedDomains && blockedDomains.some((domain) => hostname === domain || hostname.endsWith(`.${domain}`))) {
+      const blockedDomain = blockedDomains.find((domain) => hostname === domain || hostname.endsWith(`.${domain}`))
+      throw new z.ZodError([{ code: "custom", message: getMessage("domainBlacklist", { domain: blockedDomain }), path: [] }])
+    }
+
+    // Port validation
+    const port = urlObj.port ? parseInt(urlObj.port) : urlObj.protocol === "https:" ? 443 : 80
+    if (allowedPorts && !allowedPorts.includes(port)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("port", { ports: allowedPorts.join(", ") }), path: [] }])
+    }
+    if (blockedPorts && blockedPorts.includes(port)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("port", { port }), path: [] }])
+    }
+
+    // Path validation
+    if (pathStartsWith && !urlObj.pathname.startsWith(pathStartsWith)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("pathStartsWith", { path: pathStartsWith }), path: [] }])
+    }
+    if (pathEndsWith && !urlObj.pathname.endsWith(pathEndsWith)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("pathEndsWith", { path: pathEndsWith }), path: [] }])
+    }
+
+    // Query validation
+    if (mustHaveQuery && !urlObj.search) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("hasQuery"), path: [] }])
+    }
+    if (mustNotHaveQuery && urlObj.search) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("noQuery"), path: [] }])
+    }
+
+    // Fragment validation
+    if (mustHaveFragment && !urlObj.hash) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("hasFragment"), path: [] }])
+    }
+    if (mustNotHaveFragment && urlObj.hash) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("noFragment"), path: [] }])
+    }
+
+    // Localhost validation
+    const isLocalhost = hostname === "localhost" || hostname === "127.0.0.1" || hostname.startsWith("192.168.") || hostname.startsWith("10.") || hostname.match(/^172\.(1[6-9]|2[0-9]|3[0-1])\./)
+    if (blockLocalhost && isLocalhost) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("noLocalhost"), path: [] }])
+    }
+    if (!allowLocalhost && isLocalhost) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("localhost"), path: [] }])
+    }
+
+    return true
+  })
+
+  return schema as unknown as UrlSchema<IsRequired>
+}

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

@@ -0,0 +1,140 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type BusinessIdMessages = {
+  required?: string
+  invalid?: string
+}
+
+export type BusinessIdOptions<IsRequired extends boolean = true> = {
+  required?: IsRequired
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Record<Locale, BusinessIdMessages>
+}
+
+export type BusinessIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+// Taiwan Business ID (統一編號) validation
+const validateTaiwanBusinessId = (value: string): boolean => {
+  // Must be exactly 8 digits
+  if (!/^\d{8}$/.test(value)) {
+    return false
+  }
+
+  const digits = value.split('').map(Number)
+
+  // Coefficients for the first 7 digits
+  const coefficients = [1, 2, 1, 2, 1, 2, 4]
+
+  // Calculate weighted sum for first 7 digits
+  let sum = 0
+  for (let i = 0; i < 7; i++) {
+    const product = digits[i] * coefficients[i]
+    // Add individual digits of the product (split if >= 10)
+    sum += Math.floor(product / 10) + (product % 10)
+  }
+
+  // Add the check digit (8th digit)
+  sum += digits[7]
+
+  // New rules (2023+): Valid if sum is divisible by 5
+  if (sum % 5 === 0) {
+    return true
+  }
+
+  // Fall back to old rules: Valid if sum is divisible by 10
+  if (sum % 10 === 0) {
+    return true
+  }
+
+  // Special case for old rules: if 7th digit is 7
+  if (digits[6] === 7) {
+    let altSum = 0
+    for (let i = 0; i < 7; i++) {
+      const product = digits[i] * coefficients[i]
+      altSum += Math.floor(product / 10) + (product % 10)
+    }
+    // Add 1 and check digit
+    altSum += 1 + digits[7]
+
+    // Check both new and old rules
+    if (altSum % 5 === 0 || altSum % 10 === 0) {
+      return true
+    }
+  }
+
+  return false
+}
+
+export function businessId<IsRequired extends boolean = true>(options?: BusinessIdOptions<IsRequired>): BusinessIdSchema<IsRequired> {
+  const {
+    required = 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 BusinessIdMessages, 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.businessId.${key}`, params)
+  }
+
+  // Preprocessing function
+  const preprocessFn = (val: unknown) => {
+    if (val === "" || val === null || val === undefined) {
+      return actualDefaultValue
+    }
+
+    let processed = String(val).trim()
+
+    // 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 Business ID format validation (8 digits + checksum)
+    if (!validateTaiwanBusinessId(val)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("invalid"), path: [] }])
+    }
+
+    return true
+  })
+
+  return schema as unknown as BusinessIdSchema<IsRequired>
+}
+
+// Export utility function for external use
+export { validateTaiwanBusinessId }

package/src/validators/taiwan/fax.ts

@@ -0,0 +1,182 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type FaxMessages = {
+  required?: string
+  invalid?: string
+  notInWhitelist?: string
+}
+
+export type FaxOptions<IsRequired extends boolean = true> = {
+  required?: IsRequired
+  whitelist?: string[]
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Record<Locale, FaxMessages>
+}
+
+export type FaxSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+// Taiwan fax number validation (Official 2024 rules - same as landline)
+const validateTaiwanFax = (value: string): boolean => {
+  // Official Taiwan fax formats according to telecom numbering plan (same as landline):
+  // 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 fax<IsRequired extends boolean = true>(options?: FaxOptions<IsRequired>): FaxSchema<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 FaxMessages, 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.fax.${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 fax format validation (only if no allowlist or allowlist is empty)
+    if (!validateTaiwanFax(val)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("invalid"), path: [] }])
+    }
+
+    return true
+  })
+
+  return schema as unknown as FaxSchema<IsRequired>
+}
+
+// Export utility function for external use
+export { validateTaiwanFax }

package/src/validators/taiwan/mobile.ts

@@ -0,0 +1,110 @@
+import { z, ZodNullable, ZodString } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type MobileMessages = {
+  required?: string
+  invalid?: string
+  notInWhitelist?: string
+}
+
+export type MobileOptions<IsRequired extends boolean = true> = {
+  required?: IsRequired
+  whitelist?: string[]
+  transform?: (value: string) => string
+  defaultValue?: IsRequired extends true ? string : string | null
+  i18n?: Record<Locale, MobileMessages>
+}
+
+export type MobileSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>
+
+// Taiwan mobile phone validation
+const validateTaiwanMobile = (value: string): boolean => {
+  // Taiwan mobile phone format: 09 + 8 digits
+  // Valid prefixes: 090, 091, 092, 093, 094, 095, 096, 097, 098, 099
+  return /^09[0-9]\d{7}$/.test(value)
+}
+
+export function mobile<IsRequired extends boolean = true>(options?: MobileOptions<IsRequired>): MobileSchema<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 MobileMessages, 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.mobile.${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 mobile phone format validation (only if no allowlist or allowlist is empty)
+    if (!validateTaiwanMobile(val)) {
+      throw new z.ZodError([{ code: "custom", message: getMessage("invalid"), path: [] }])
+    }
+
+    return true
+  })
+
+  return schema as unknown as MobileSchema<IsRequired>
+}
+
+// Export utility function for external use
+export { validateTaiwanMobile }