@hy_ong/zod-kit 0.0.2 → 0.0.5

package/eslint.config.mts

@@ -0,0 +1,8 @@
+import eslintJs from "@eslint/js"
+import eslintTs from "typescript-eslint"
+
+export default eslintTs.config(eslintJs.configs.recommended, eslintTs.configs.recommended, {
+  rules: {
+    "@typescript-eslint/no-explicit-any": "off",
+  },
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hy_ong/zod-kit",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "description": "Zod Kit",
   "keywords": [
     "hy_ong",
@@ -19,7 +19,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "license": "ISC",
+  "license": "MIT",
   "author": "Ong Hoe Yuan",
   "type": "module",
   "main": "dist/index.cjs",
@@ -29,7 +29,7 @@
     ".": {
       "import": "./dist/index.js",
       "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
+      "default": "./dist/index.js"
     }
   },
   "scripts": {
@@ -37,17 +37,18 @@
     "test": "vitest"
   },
   "dependencies": {
-    "dayjs": "^1.11.13",
-    "zod": "^4.0.14"
+    "dayjs": "^1.11.14",
+    "zod": "^4.1.4"
   },
   "devDependencies": {
-    "@eslint/js": "^9.32.0",
-    "@types/node": "^22.17.0",
-    "eslint": "^9.32.0",
+    "@eslint/js": "^9.34.0",
+    "@types/node": "^20.19.11",
+    "eslint": "^9.34.0",
+    "jiti": "^2.5.1",
     "prettier": "^3.6.2",
     "tsup": "^8.5.0",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.38.0",
+    "typescript-eslint": "^8.41.0",
     "vitest": "^3.2.4"
   }
 }

package/src/config.ts

@@ -1,6 +1,6 @@
 export type Locale = "zh-TW" | "en"
 
-let currentLocale: Locale = "zh-TW"
+let currentLocale: Locale = "en"
 
 export const setLocale = (locale: Locale) => {
   currentLocale = locale

package/src/i18n/locales/en.json

@@ -1,68 +1,142 @@
 {
   "common": {
     "boolean": {
-      "required": "${label} is required",
-      "shouldBe": {
-        "true": "${label} must be True",
-        "false": "${label} must be False"
-      }
+      "required": "Required",
+      "shouldBeTrue": "Must be True",
+      "shouldBeFalse": "Must be False",
+      "invalid": "Must be a boolean value"
     },
     "email": {
-      "required": "${label} is required",
-      "min": "${label} must be at least ${min} characters",
-      "max": "${label} must be at most ${max} characters",
-      "includes": "${label} must include ${includes}",
-      "invalid": "${label} is invalid format",
-      "domain": "${label} must be under the domain @${domain}"
+      "required": "Required",
+      "invalid": "Invalid email format",
+      "minLength": "Must be at least ${minLength} characters",
+      "maxLength": "Must be at most ${maxLength} characters",
+      "includes": "Must include ${includes}",
+      "domain": "Must be from domain: ${domain}",
+      "domainBlacklist": "Domain ${domain} is not allowed",
+      "businessOnly": "Only business email addresses are allowed",
+      "noDisposable": "Disposable email addresses are not allowed"
     },
     "url": {
-      "required": "${label} is required",
-      "min": "${label} must be at least ${min} characters",
-      "max": "${label} must be at most ${max} characters",
-      "includes": "${label} must include ${includes}",
-      "invalid": "${label} is invalid format"
+      "required": "Required",
+      "invalid": "Invalid URL format",
+      "min": "Must be at least ${min} characters",
+      "max": "Must be at most ${max} characters",
+      "includes": "Must include ${includes}",
+      "excludes": "Must not contain ${excludes}",
+      "protocol": "Protocol must be one of: ${protocols}",
+      "domain": "Domain must be one of: ${domains}",
+      "domainBlacklist": "Domain ${domain} is not allowed",
+      "port": "Port must be one of: ${ports}",
+      "pathStartsWith": "Path must start with ${path}",
+      "pathEndsWith": "Path must end with ${path}",
+      "hasQuery": "URL must have query parameters",
+      "noQuery": "URL must not have query parameters",
+      "hasFragment": "URL must have a fragment",
+      "noFragment": "URL must not have a fragment",
+      "localhost": "Localhost URLs are not allowed",
+      "noLocalhost": "Localhost URLs are not allowed"
     },
     "password": {
-      "required": "${label} is required",
-      "min": "${label} must be at least ${min} characters",
-      "max": "${label} must be at most ${max} characters",
-      "uppercase": "${label} must include at least one uppercase letter",
-      "lowercase": "${label} must include at least one lowercase letter",
-      "digits": "${label} must include at least one digit",
-      "special": "${label} must include at least one special character"
+      "required": "Required",
+      "min": "Must be at least ${min} characters",
+      "max": "Must be at most ${max} characters",
+      "uppercase": "Must include at least one uppercase letter",
+      "lowercase": "Must include at least one lowercase letter",
+      "digits": "Must include at least one digit",
+      "special": "Must include at least one special character",
+      "noRepeating": "Must not contain repeating characters",
+      "noSequential": "Must not contain sequential characters",
+      "noCommonWords": "Must not contain common words or patterns",
+      "minStrength": "Password strength must be at least ${minStrength}",
+      "excludes": "Must not contain ${excludes}",
+      "includes": "Must include ${includes}",
+      "invalid": "Invalid password format"
     },
     "number": {
-      "required": "${label} is required",
-      "min": "${label} must be at least ${min}",
-      "max": "${label} must be at most ${max}"
+      "required": "Required",
+      "invalid": "Must be a valid number",
+      "integer": "Must be an integer",
+      "float": "Must be a decimal number",
+      "min": "Must be at least ${min}",
+      "max": "Must be at most ${max}",
+      "positive": "Must be positive",
+      "negative": "Must be negative", 
+      "nonNegative": "Must be non-negative",
+      "nonPositive": "Must be non-positive",
+      "multipleOf": "Must be a multiple of ${multipleOf}",
+      "finite": "Must be a finite number",
+      "precision": "Must have at most ${precision} decimal places"
     },
-    "integer": {
-      "required": "${label} is required",
-      "min": "${label} must be at least ${min}",
-      "max": "${label} must be at most ${max}",
-      "integer": "${label} must be an integer"
-    },
-    "float": {
-      "required": "${label} is required",
-      "min": "${label} must be at least ${min}",
-      "max": "${label} must be at most ${max}",
-      "float": "${label} must be an float"
+    "id": {
+      "required": "Required",
+      "invalid": "Invalid ID format",
+      "minLength": "Must be at least ${minLength} characters",
+      "maxLength": "Must be at most ${maxLength} characters",
+      "numeric": "Must be a numeric ID",
+      "uuid": "Must be a valid UUID",
+      "objectId": "Must be a valid MongoDB ObjectId",
+      "nanoid": "Must be a valid Nano ID",
+      "snowflake": "Must be a valid Snowflake ID",
+      "cuid": "Must be a valid CUID",
+      "ulid": "Must be a valid ULID",
+      "shortid": "Must be a valid Short ID",
+      "customFormat": "Invalid ID format",
+      "includes": "Must include ${includes}",
+      "excludes": "Must not contain ${excludes}",
+      "startsWith": "Must start with ${startsWith}",
+      "endsWith": "Must end with ${endsWith}"
     },
     "text": {
-      "required": "${label} is required",
-      "min": "${label} must be at least ${min} characters",
-      "max": "${label} must be at most ${max} characters",
-      "startsWith": "${label} must start with ${startsWith}",
-      "endsWith": "${label} must end with ${endsWith}",
-      "includes": "${label} must include ${includes}",
-      "invalid": "${label} is invalid format"
+      "required": "Required",
+      "notEmpty": "Cannot be empty or whitespace only",
+      "minLength": "Must be at least ${minLength} characters",
+      "maxLength": "Must be at most ${maxLength} characters",
+      "startsWith": "Must start with ${startsWith}",
+      "endsWith": "Must end with ${endsWith}",
+      "includes": "Must include ${includes}",
+      "excludes": "Must not contain ${excludes}",
+      "invalid": "Invalid format"
     },
     "date": {
-      "required": "${label} is required",
-      "min": "${label} must be at least ${min} characters",
-      "max": "${label} must be at most ${max} characters",
-      "includes": "${label} must include ${includes}",
-      "format": "${label} must be in ${format} format"
+      "required": "Required",
+      "invalid": "Invalid date",
+      "format": "Must be in ${format} format",
+      "min": "Date must be on or after ${min}",
+      "max": "Date must be on or before ${max}",
+      "includes": "Must include ${includes}",
+      "excludes": "Must not contain ${excludes}",
+      "past": "Date must be in the past",
+      "future": "Date must be in the future",
+      "today": "Date must be today",
+      "notToday": "Date must not be today",
+      "weekday": "Date must be a weekday (Monday-Friday)",
+      "weekend": "Date must be a weekend (Saturday-Sunday)"
+    }
+  },
+  "taiwan": {
+    "businessId": {
+      "required": "Required",
+      "invalid": "Invalid Taiwan Business ID"
+    },
+    "nationalId": {
+      "required": "Required",
+      "invalid": "Invalid Taiwan National ID"
+    },
+    "mobile": {
+      "required": "Required",
+      "invalid": "Invalid Taiwan mobile phone format",
+      "notInWhitelist": "Not in allowed mobile phone list"
+    },
+    "tel": {
+      "required": "Required",
+      "invalid": "Invalid Taiwan telephone format",
+      "notInWhitelist": "Not in allowed telephone list"
+    },
+    "fax": {
+      "required": "Required",
+      "invalid": "Invalid Taiwan fax format",
+      "notInWhitelist": "Not in allowed fax list"
     }
   }
 }

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

@@ -1,65 +1,142 @@
 {
   "common": {
     "boolean": {
-      "required": "請輸入 ${label}",
-      "shouldBe": {
-        "true": "${label} 必須為是",
-        "false": "${label} 必須為否"
-      }
+      "required": "必填",
+      "shouldBeTrue": "必須為是",
+      "shouldBeFalse": "必須為否",
+      "invalid": "必須為布林值"
     },
     "email": {
-      "required": "請輸入 ${label}",
-      "min": "${label} 長度至少 ${min} 字元",
-      "max": "${label} 長度最多 ${max} 字元",
-      "includes": "${label} 必須包含「${includes}」",
-      "invalid": "${label} 格式錯誤",
-      "domain": "${label} 必須為 @${domain} 網域"
+      "required": "必填",
+      "invalid": "電子郵件格式錯誤",
+      "minLength": "長度至少 ${minLength} 字元",
+      "maxLength": "長度最多 ${maxLength} 字元",
+      "includes": "必須包含「${includes}」",
+      "domain": "必須為 ${domain} 網域",
+      "domainBlacklist": "不允許使用 ${domain} 網域",
+      "businessOnly": "僅允許企業郵箱地址",
+      "noDisposable": "不允許使用臨時郵箱地址"
     },
     "url": {
-      "required": "請輸入 ${label}",
-      "min": "${label} 長度至少 ${min} 字元",
-      "max": "${label} 長度最多 ${max} 字元",
-      "includes": "${label} 必須包含「${includes}」",
-      "invalid": "${label} 格式錯誤"
+      "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": "請輸入 ${label}",
-      "min": "${label} 長度至少 ${min} 字元",
-      "max": "${label} 長度最多 ${max} 字元",
-      "uppercase": "${label} 必須包含至少一個大寫字母",
-      "lowercase": "${label} 必須包含至少一個小寫字母",
-      "digits": "${label} 必須包含至少一個數字",
-      "special": "${label} 必須包含至少一個特殊符號"
+      "required": "必填",
+      "min": "長度至少 ${min} 字元",
+      "max": "長度最多 ${max} 字元",
+      "uppercase": "必須包含至少一個大寫字母",
+      "lowercase": "必須包含至少一個小寫字母",
+      "digits": "必須包含至少一個數字",
+      "special": "必須包含至少一個特殊符號",
+      "noRepeating": "不可包含重複字元",
+      "noSequential": "不可包含連續字元",
+      "noCommonWords": "不可包含常見密碼或模式",
+      "minStrength": "密碼強度必須至少為 ${minStrength}",
+      "excludes": "不得包含「${excludes}」",
+      "includes": "必須包含「${includes}」",
+      "invalid": "密碼格式錯誤"
     },
     "number": {
-      "required": "請輸入 ${label}",
-      "min": "${label} 最小值 ${min}",
-      "max": "${label} 最大值 ${max}"
+      "required": "必填",
+      "invalid": "必須為有效數字",
+      "integer": "必須為整數",
+      "float": "必須為小數",
+      "min": "最小值 ${min}",
+      "max": "最大值 ${max}",
+      "positive": "必須為正數",
+      "negative": "必須為負數",
+      "nonNegative": "不可為負數",
+      "nonPositive": "不可為正數",
+      "multipleOf": "必須為 ${multipleOf} 的倍數",
+      "finite": "必須為有限數字",
+      "precision": "小數位數不可超過 ${precision} 位"
     },
     "id": {
-      "required": "請選擇 ${label}",
-      "invalid": "${label} 無效"
+      "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}」結尾"
     },
-    "integer": {
-      "required": "請輸入 ${label}",
-      "min": "${label} 最小值 ${min}",
-      "max": "${label} 最大值 ${max}",
-      "integer": "${label} 必須為整數"
+    "text": {
+      "required": "必填",
+      "notEmpty": "不可為空白或僅含空格",
+      "minLength": "長度至少 ${minLength} 字元",
+      "maxLength": "長度最多 ${maxLength} 字元",
+      "startsWith": "必須以「${startsWith}」開頭",
+      "endsWith": "必須以「${endsWith}」結尾",
+      "includes": "必須包含「${includes}」",
+      "excludes": "不得包含「${excludes}」",
+      "invalid": "格式錯誤"
     },
-    "float": {
-      "required": "請輸入 ${label}",
-      "float": "${label} 必須為浮點數",
-      "min": "${label} 最小值 ${min}",
-      "max": "${label} 最大值 ${max}"
+    "date": {
+      "required": "必填",
+      "invalid": "無效日期",
+      "format": "必須為 ${format} 格式",
+      "min": "日期不得早於 ${min}",
+      "max": "日期不得晚於 ${max}",
+      "includes": "必須包含「${includes}」",
+      "excludes": "不得包含「${excludes}」",
+      "past": "必須為過去的日期",
+      "future": "必須為未來的日期",
+      "today": "必須為今天",
+      "notToday": "不得為今天",
+      "weekday": "必須為工作日（週一至週五）",
+      "weekend": "必須為週末（週六至週日）"
+    }
+  },
+  "taiwan": {
+    "businessId": {
+      "required": "必填",
+      "invalid": "無效的統一編號"
     },
-    "text": {
-      "required": "請輸入 ${label}",
-      "min": "${label} 長度至少 ${min} 字元",
-      "max": "${label} 長度最多 ${max} 字元",
-      "startsWith": "${label} 必須以「${startsWith}」開頭",
-      "endsWith": "${label} 必須以「${endsWith}」結尾",
-      "includes": "${label} 必須包含「${includes}」",
-      "invalid": "${label} 格式錯誤"
+    "nationalId": {
+      "required": "必填",
+      "invalid": "無效的身分證字號"
+    },
+    "mobile": {
+      "required": "必填",
+      "invalid": "無效的手機號碼格式",
+      "notInWhitelist": "不在允許的手機號碼清單中"
+    },
+    "tel": {
+      "required": "必填",
+      "invalid": "無效的市話號碼格式",
+      "notInWhitelist": "不在允許的市話號碼清單中"
+    },
+    "fax": {
+      "required": "必填",
+      "invalid": "無效的傳真號碼格式",
+      "notInWhitelist": "不在允許的傳真號碼清單中"
     }
   }
 }

package/src/index.ts

@@ -1,8 +1,14 @@
-export * from "./common/boolean"
-export * from "./common/email"
-export * from "./common/url"
-export * from "./common/text"
-export * from "./common/number"
-export * from "./common/password"
-export * from "./common/integer"
+export * from "./validators/common/boolean"
+export * from "./validators/common/date"
+export * from "./validators/common/email"
+export * from "./validators/common/id"
+export * from "./validators/common/number"
+export * from "./validators/common/password"
+export * from "./validators/common/text"
+export * from "./validators/common/url"
+export * from "./validators/taiwan/business-id"
+export * from "./validators/taiwan/national-id"
+export * from "./validators/taiwan/mobile"
+export * from "./validators/taiwan/tel"
+export * from "./validators/taiwan/fax"
 export * from "./config"

package/src/validators/common/boolean.ts

@@ -0,0 +1,97 @@
+import { z, ZodBoolean, ZodNullable, ZodType } from "zod"
+import { t } from "../../i18n"
+import { getLocale, type Locale } from "../../config"
+
+export type BooleanMessages = {
+  required?: string
+  shouldBeTrue?: string
+  shouldBeFalse?: string
+  invalid?: string
+}
+
+export type BooleanOptions<IsRequired extends boolean = true> = {
+  required?: IsRequired
+  defaultValue?: IsRequired extends true ? boolean : boolean | null
+  shouldBe?: boolean
+  truthyValues?: unknown[]
+  falsyValues?: unknown[]
+  strict?: boolean
+  transform?: (value: boolean) => boolean
+  i18n?: Record<Locale, BooleanMessages>
+}
+
+export type BooleanSchema<IsRequired extends boolean> = IsRequired extends true ? ZodBoolean : ZodNullable<ZodBoolean>
+
+export function boolean<IsRequired extends boolean = true>(options?: BooleanOptions<IsRequired>): BooleanSchema<IsRequired> {
+  const {
+    required = true,
+    defaultValue = null,
+    shouldBe,
+    truthyValues = [true, "true", 1, "1", "yes", "on"],
+    falsyValues = [false, "false", 0, "0", "no", "off"],
+    strict = false,
+    transform,
+    i18n,
+  } = options ?? {}
+
+  // Helper function to get custom message or fallback to default i18n
+  const getMessage = (key: keyof BooleanMessages, 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.boolean.${key}`, params)
+  }
+
+  let result: ZodType = z.preprocess(
+    (val) => {
+      if (val === "" || val === undefined || val === null) return defaultValue
+
+      if (strict && typeof val !== "boolean" && val !== null) {
+        return val // Let it fail in validation
+      }
+
+      // Check truthy values
+      if (truthyValues.includes(val)) {
+        let processed = true
+        if (transform) processed = transform(processed)
+        return processed
+      }
+
+      // Check falsy values
+      if (falsyValues.includes(val)) {
+        let processed = false
+        if (transform) processed = transform(processed)
+        return processed
+      }
+
+      return val
+    },
+    z.union([z.literal(true), z.literal(false), z.literal(null)])
+  )
+
+  if (required && defaultValue === null) {
+    result = result.refine((val) => val !== null, { message: getMessage("required") })
+  }
+
+  if (shouldBe === true) {
+    result = result.refine((val) => val === true, { message: getMessage("shouldBeTrue") })
+  } else if (shouldBe === false) {
+    result = result.refine((val) => val === false, { message: getMessage("shouldBeFalse") })
+  }
+
+  if (strict) {
+    result = result.refine(
+      (val) => {
+        return val === null || typeof val === "boolean"
+      },
+      { message: getMessage("invalid") }
+    )
+  }
+
+  return result as IsRequired extends true ? ZodBoolean : ZodNullable<ZodBoolean>
+}