@hy_ong/zod-kit 0.1.3 → 0.1.5

package/dist/index.d.cts

@@ -1257,6 +1257,7 @@ type NumberSchema<IsRequired extends boolean> = IsRequired extends true ? ZodNum
  * Creates a Zod schema for number validation with comprehensive constraints
  *
  * @template IsRequired - Whether the field is required (affects return type)
+ * @param required
  * @param {NumberOptions<IsRequired>} [options] - Configuration options for number validation
  * @returns {NumberSchema<IsRequired>} Zod schema for number validation
  *
@@ -1324,7 +1325,7 @@ type NumberSchema<IsRequired extends boolean> = IsRequired extends true ? ZodNum
  * @throws {z.ZodError} When validation fails with specific error messages
  * @see {@link NumberOptions} for all available configuration options
  */
-declare function number<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<NumberOptions<IsRequired>, 'required'>): NumberSchema<IsRequired>;
+declare function number<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<NumberOptions<IsRequired>, "required">): NumberSchema<IsRequired>;
 
 /**
  * @fileoverview Password validator for Zod Kit
@@ -2135,11 +2136,11 @@ declare function url<IsRequired extends boolean = false>(required?: IsRequired,
 /**
  * Type definition for business ID validation error messages
  *
- * @interface BusinessIdMessages
+ * @interface TwBusinessIdMessages
  * @property {string} [required] - Message when field is required but empty
  * @property {string} [invalid] - Message when business ID format or checksum is invalid
  */
-type BusinessIdMessages = {
+type TwBusinessIdMessages = {
     required?: string;
     invalid?: string;
 };
@@ -2148,25 +2149,25 @@ type BusinessIdMessages = {
  *
  * @template IsRequired - Whether the field is required (affects return type)
  *
- * @interface BusinessIdOptions
+ * @interface TwBusinessIdOptions
  * @property {IsRequired} [required=true] - Whether the field is required
  * @property {Function} [transform] - Custom transformation function for business ID
  * @property {string | null} [defaultValue] - Default value when input is empty
- * @property {Record<Locale, BusinessIdMessages>} [i18n] - Custom error messages for different locales
+ * @property {Record<Locale, TwBusinessIdMessages>} [i18n] - Custom error messages for different locales
  */
-type BusinessIdOptions<IsRequired extends boolean = true> = {
+type TwBusinessIdOptions<IsRequired extends boolean = true> = {
     transform?: (value: string) => string;
     defaultValue?: IsRequired extends true ? string : string | null;
-    i18n?: Record<Locale, BusinessIdMessages>;
+    i18n?: Record<Locale, TwBusinessIdMessages>;
 };
 /**
  * Type alias for business ID validation schema based on required flag
  *
  * @template IsRequired - Whether the field is required
- * @typedef BusinessIdSchema
+ * @typedef TwBusinessIdSchema
  * @description Returns ZodString if required, ZodNullable<ZodString> if optional
  */
-type BusinessIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+type TwBusinessIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
 /**
  * Validates Taiwan Business Identification Number (統一編號)
  *
@@ -2246,10 +2247,10 @@ declare const validateTaiwanBusinessId: (value: string) => boolean;
  * ```
  *
  * @throws {z.ZodError} When validation fails with specific error messages
- * @see {@link BusinessIdOptions} for all available configuration options
+ * @see {@link TwBusinessIdOptions} for all available configuration options
  * @see {@link validateTaiwanBusinessId} for validation logic details
  */
-declare function businessId<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<BusinessIdOptions<IsRequired>, 'required'>): BusinessIdSchema<IsRequired>;
+declare function twBusinessId<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwBusinessIdOptions<IsRequired>, "required">): TwBusinessIdSchema<IsRequired>;
 
 /**
  * @fileoverview Taiwan National ID (身分證/居留證) validator for Zod Kit
@@ -2264,11 +2265,11 @@ declare function businessId<IsRequired extends boolean = false>(required?: IsReq
 /**
  * Type definition for national ID validation error messages
  *
- * @interface NationalIdMessages
+ * @interface TwNationalIdMessages
  * @property {string} [required] - Message when field is required but empty
  * @property {string} [invalid] - Message when national ID format or checksum is invalid
  */
-type NationalIdMessages = {
+type TwNationalIdMessages = {
     required?: string;
     invalid?: string;
 };
@@ -2288,29 +2289,29 @@ type NationalIdType = "citizen" | "resident" | "both";
  *
  * @template IsRequired - Whether the field is required (affects return type)
  *
- * @interface NationalIdOptions
+ * @interface TwNationalIdOptions
  * @property {IsRequired} [required=true] - Whether the field is required
  * @property {NationalIdType} [type="both"] - Type of ID to accept
  * @property {boolean} [allowOldResident=true] - Whether to accept old-style resident certificates
  * @property {Function} [transform] - Custom transformation function for ID
  * @property {string | null} [defaultValue] - Default value when input is empty
- * @property {Record<Locale, NationalIdMessages>} [i18n] - Custom error messages for different locales
+ * @property {Record<Locale, TwNationalIdMessages>} [i18n] - Custom error messages for different locales
  */
-type NationalIdOptions<IsRequired extends boolean = true> = {
+type TwNationalIdOptions<IsRequired extends boolean = true> = {
     type?: NationalIdType;
     allowOldResident?: boolean;
     transform?: (value: string) => string;
     defaultValue?: IsRequired extends true ? string : string | null;
-    i18n?: Record<Locale, NationalIdMessages>;
+    i18n?: Record<Locale, TwNationalIdMessages>;
 };
 /**
  * Type alias for national ID validation schema based on required flag
  *
  * @template IsRequired - Whether the field is required
- * @typedef NationalIdSchema
+ * @typedef TwNationalIdSchema
  * @description Returns ZodString if required, ZodNullable<ZodString> if optional
  */
-type NationalIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+type TwNationalIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
 /**
  * Validates Taiwan citizen national ID card (身分證字號)
  *
@@ -2402,8 +2403,8 @@ declare const validateTaiwanNationalId: (value: string, type?: NationalIdType, a
  * Creates a Zod schema for Taiwan National ID validation
  *
  * @template IsRequired - Whether the field is required (affects return type)
- * @param {NationalIdOptions<IsRequired>} [options] - Configuration options for national ID validation
- * @returns {NationalIdSchema<IsRequired>} Zod schema for national ID validation
+ * @param {TwNationalIdOptions<IsRequired>} [options] - Configuration options for national ID validation
+ * @returns {TwNationalIdSchema<IsRequired>} Zod schema for national ID validation
  *
  * @description
  * Creates a comprehensive Taiwan National ID validator that supports both
@@ -2422,18 +2423,18 @@ declare const validateTaiwanNationalId: (value: string, type?: NationalIdType, a
  * @example
  * ```typescript
  * // Accept any valid Taiwan ID
- * const anyIdSchema = nationalId()
+ * const anyIdSchema = twNationalId()
  * anyIdSchema.parse("A123456789") // ✓ Valid citizen ID
  * anyIdSchema.parse("A812345678") // ✓ Valid new resident ID
  * anyIdSchema.parse("AA12345678") // ✓ Valid old resident ID
  *
  * // Citizen IDs only
- * const citizenSchema = nationalId(false, { type: "citizen" })
+ * const citizenSchema = twNationalId(false, { type: "citizen" })
  * citizenSchema.parse("A123456789") // ✓ Valid
  * citizenSchema.parse("A812345678") // ✗ Invalid (resident ID)
  *
  * // Resident IDs only (new format only)
- * const residentSchema = nationalId(false, {
+ * const residentSchema = twNationalId(false, {
  *   type: "resident",
  *   allowOldResident: false
  * })
@@ -2441,12 +2442,12 @@ declare const validateTaiwanNationalId: (value: string, type?: NationalIdType, a
  * residentSchema.parse("AA12345678") // ✗ Invalid (old format)
  *
  * // Optional with custom transformation
- * const optionalSchema = nationalId(false, {
+ * const optionalSchema = twNationalId(false, {
  *   transform: (value) => value.replace(/[^A-Z0-9]/g, '') // Remove special chars
  * })
  *
  * // With custom error messages
- * const customSchema = nationalId(false, {
+ * const customSchema = twNationalId(false, {
  *   i18n: {
  *     en: { invalid: "Please enter a valid Taiwan National ID" },
  *     'zh-TW': { invalid: "請輸入有效的身分證或居留證號碼" }
@@ -2455,11 +2456,11 @@ declare const validateTaiwanNationalId: (value: string, type?: NationalIdType, a
  * ```
  *
  * @throws {z.ZodError} When validation fails with specific error messages
- * @see {@link NationalIdOptions} for all available configuration options
+ * @see {@link TwNationalIdOptions} for all available configuration options
  * @see {@link NationalIdType} for supported ID types
  * @see {@link validateTaiwanNationalId} for validation logic details
  */
-declare function nationalId<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<NationalIdOptions<IsRequired>, 'required'>): NationalIdSchema<IsRequired>;
+declare function twNationalId<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwNationalIdOptions<IsRequired>, 'required'>): TwNationalIdSchema<IsRequired>;
 
 /**
  * @fileoverview Taiwan Mobile Phone Number validator for Zod Kit
@@ -2474,12 +2475,12 @@ declare function nationalId<IsRequired extends boolean = false>(required?: IsReq
 /**
  * Type definition for mobile phone validation error messages
  *
- * @interface MobileMessages
+ * @interface TwMobileMessages
  * @property {string} [required] - Message when field is required but empty
  * @property {string} [invalid] - Message when mobile number format is invalid
  * @property {string} [notInWhitelist] - Message when mobile number is not in whitelist
  */
-type MobileMessages = {
+type TwMobileMessages = {
     required?: string;
     invalid?: string;
     notInWhitelist?: string;
@@ -2489,27 +2490,27 @@ type MobileMessages = {
  *
  * @template IsRequired - Whether the field is required (affects return type)
  *
- * @interface MobileOptions
+ * @interface TwMobileOptions
  * @property {IsRequired} [required=true] - Whether the field is required
  * @property {string[]} [whitelist] - Array of specific mobile numbers that are always allowed
  * @property {Function} [transform] - Custom transformation function for mobile number
  * @property {string | null} [defaultValue] - Default value when input is empty
- * @property {Record<Locale, MobileMessages>} [i18n] - Custom error messages for different locales
+ * @property {Record<Locale, TwMobileMessages>} [i18n] - Custom error messages for different locales
  */
-type MobileOptions<IsRequired extends boolean = true> = {
+type TwMobileOptions<IsRequired extends boolean = true> = {
     whitelist?: string[];
     transform?: (value: string) => string;
     defaultValue?: IsRequired extends true ? string : string | null;
-    i18n?: Record<Locale, MobileMessages>;
+    i18n?: Record<Locale, TwMobileMessages>;
 };
 /**
  * Type alias for mobile phone validation schema based on required flag
  *
  * @template IsRequired - Whether the field is required
- * @typedef MobileSchema
+ * @typedef TwMobileSchema
  * @description Returns ZodString if required, ZodNullable<ZodString> if optional
  */
-type MobileSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+type TwMobileSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
 /**
  * Validates Taiwan mobile phone number format
  *
@@ -2539,7 +2540,7 @@ declare const validateTaiwanMobile: (value: string) => boolean;
  * @template IsRequired - Whether the field is required (affects return type)
  * @param {IsRequired} [required=false] - Whether the field is required
  * @param {Omit<ValidatorOptions<IsRequired>, 'required'>} [options] - Configuration options for validation
- * @returns {MobileSchema<IsRequired>} Zod schema for mobile phone validation
+ * @returns {TwMobileSchema<IsRequired>} Zod schema for mobile phone validation
  *
  * @description
  * Creates a comprehensive Taiwan mobile phone number validator with support for
@@ -2557,7 +2558,7 @@ declare const validateTaiwanMobile: (value: string) => boolean;
  * @example
  * ```typescript
  * // Basic mobile number validation
- * const basicSchema = mobile() // optional by default
+ * const basicSchema = twMobile() // optional by default
  * basicSchema.parse("0912345678") // ✓ Valid
  * basicSchema.parse(null) // ✓ Valid (optional)
  *
@@ -2570,26 +2571,26 @@ declare const validateTaiwanMobile: (value: string) => boolean;
  * basicSchema.parse("0812345678") // ✗ Invalid (wrong prefix)
  *
  * // With whitelist (only specific numbers allowed)
- * const whitelistSchema = mobile(false, {
+ * const whitelistSchema = twMobile(false, {
  *   whitelist: ["0912345678", "0987654321"]
  * })
  * whitelistSchema.parse("0912345678") // ✓ Valid (in whitelist)
  * whitelistSchema.parse("0911111111") // ✗ Invalid (not in whitelist)
  *
  * // Optional mobile number
- * const optionalSchema = mobile(false)
+ * const optionalSchema = twMobile(false)
  * optionalSchema.parse("") // ✓ Valid (returns null)
  * optionalSchema.parse("0912345678") // ✓ Valid
  *
  * // With custom transformation
- * const transformSchema = mobile(false, {
+ * const transformSchema = twMobile(false, {
  *   transform: (value) => value.replace(/[^0-9]/g, '') // Remove non-digits
  * })
  * transformSchema.parse("091-234-5678") // ✓ Valid (formatted input)
  * transformSchema.parse("091 234 5678") // ✓ Valid (spaced input)
  *
  * // With custom error messages
- * const customSchema = mobile(false, {
+ * const customSchema = twMobile(false, {
  *   i18n: {
  *     en: { invalid: "Please enter a valid Taiwan mobile number" },
  *     'zh-TW': { invalid: "請輸入有效的台灣手機號碼" }
@@ -2598,10 +2599,10 @@ declare const validateTaiwanMobile: (value: string) => boolean;
  * ```
  *
  * @throws {z.ZodError} When validation fails with specific error messages
- * @see {@link MobileOptions} for all available configuration options
+ * @see {@link TwMobileOptions} for all available configuration options
  * @see {@link validateTaiwanMobile} for validation logic details
  */
-declare function mobile<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<MobileOptions<IsRequired>, 'required'>): MobileSchema<IsRequired>;
+declare function twMobile<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwMobileOptions<IsRequired>, 'required'>): TwMobileSchema<IsRequired>;
 
 /**
  * @fileoverview Taiwan Postal Code validator for Zod Kit
@@ -2617,7 +2618,7 @@ declare function mobile<IsRequired extends boolean = false>(required?: IsRequire
 /**
  * Type definition for postal code validation error messages
  *
- * @interface PostalCodeMessages
+ * @interface TwPostalCodeMessages
  * @property {string} [required] - Message when field is required but empty
  * @property {string} [invalid] - Message when postal code format is invalid
  * @property {string} [invalidFormat] - Message when format doesn't match expected pattern
@@ -2627,7 +2628,7 @@ declare function mobile<IsRequired extends boolean = false>(required?: IsRequire
  * @property {string} [format5Only] - Message when only 5-digit format is allowed
  * @property {string} [format6Only] - Message when only 6-digit format is allowed
  */
-type PostalCodeMessages = {
+type TwPostalCodeMessages = {
     required?: string;
     invalid?: string;
     invalidFormat?: string;
@@ -2642,7 +2643,7 @@ type PostalCodeMessages = {
 /**
  * Postal code format types supported in Taiwan
  *
- * @typedef {"3" | "5" | "6" | "3+5" | "3+6" | "5+6" | "all"} PostalCodeFormat
+ * @typedef {"3" | "5" | "6" | "3+5" | "3+6" | "5+6" | "all"} TwPostalCodeFormatType
  *
  * Available formats:
  * - "3": 3-digit basic postal codes (100-982)
@@ -2653,15 +2654,15 @@ type PostalCodeMessages = {
  * - "5+6": Accept both 5-digit and 6-digit formats
  * - "all": Accept all formats (3, 5, and 6 digits)
  */
-type PostalCodeFormat = "3" | "5" | "6" | "3+5" | "3+6" | "5+6" | "all";
+type TwPostalCodeFormatType = "3" | "5" | "6" | "3+5" | "3+6" | "5+6" | "all";
 /**
  * Configuration options for Taiwan postal code validation
  *
  * @template IsRequired - Whether the field is required (affects return type)
  *
- * @interface PostalCodeOptions
+ * @interface TwPostalCodeOptions
  * @property {IsRequired} [required=true] - Whether the field is required
- * @property {PostalCodeFormat} [format="3+6"] - Which postal code formats to accept
+ * @property {TwPostalCodeFormatType} [format="3+6"] - Which postal code formats to accept
  * @property {boolean} [strictValidation=true] - Enable strict validation against known postal code ranges
  * @property {boolean} [allowDashes=true] - Whether to allow dashes in postal codes (e.g., "100-01" or "100-001")
  * @property {boolean} [warn5Digit=true] - Whether to show warning for 5-digit legacy format
@@ -2669,10 +2670,10 @@ type PostalCodeFormat = "3" | "5" | "6" | "3+5" | "3+6" | "5+6" | "all";
  * @property {string[]} [blockedPrefixes] - Specific 3-digit prefixes to block
  * @property {Function} [transform] - Custom transformation function for postal codes
  * @property {string | null} [defaultValue] - Default value when input is empty
- * @property {Record<Locale, PostalCodeMessages>} [i18n] - Custom error messages for different locales
+ * @property {Record<Locale, TwPostalCodeMessages>} [i18n] - Custom error messages for different locales
  */
-type PostalCodeOptions<IsRequired extends boolean = true> = {
-    format?: PostalCodeFormat;
+type TwPostalCodeOptions<IsRequired extends boolean = true> = {
+    format?: TwPostalCodeFormatType;
     strictValidation?: boolean;
     allowDashes?: boolean;
     warn5Digit?: boolean;
@@ -2680,7 +2681,7 @@ type PostalCodeOptions<IsRequired extends boolean = true> = {
     blockedPrefixes?: string[];
     transform?: (value: string) => string;
     defaultValue?: IsRequired extends true ? string : string | null;
-    i18n?: Record<Locale, PostalCodeMessages>;
+    i18n?: Record<Locale, TwPostalCodeMessages>;
     strictSuffixValidation?: boolean;
     deprecate5Digit?: boolean;
 };
@@ -2688,10 +2689,10 @@ type PostalCodeOptions<IsRequired extends boolean = true> = {
  * Type alias for postal code validation schema based on required flag
  *
  * @template IsRequired - Whether the field is required
- * @typedef PostalCodeSchema
+ * @typedef TwPostalCodeSchema
  * @description Returns ZodString if required, ZodNullable<ZodString> if optional
  */
-type PostalCodeSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+type TwPostalCodeSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
 /**
  * Valid 3-digit postal code prefixes for Taiwan
  * Based on official Chunghwa Post data (2024)
@@ -2733,7 +2734,7 @@ declare const validate6DigitPostalCode: (value: string, strictValidation?: boole
  * Main validation function for Taiwan postal codes
  *
  * @param {string} value - The postal code to validate
- * @param {PostalCodeFormat} format - Which formats to accept
+ * @param {TwPostalCodeFormatType} format - Which formats to accept
  * @param {boolean} strictValidation - Whether to validate against known postal codes
  * @param {boolean} strictSuffixValidation - Whether to validate suffix ranges
  * @param {boolean} allowDashes - Whether dashes/spaces are allowed and should be removed
@@ -2741,13 +2742,13 @@ declare const validate6DigitPostalCode: (value: string, strictValidation?: boole
  * @param {string[]} blockedPrefixes - Specific prefixes to block
  * @returns {boolean} True if the postal code is valid
  */
-declare const validateTaiwanPostalCode: (value: string, format?: PostalCodeFormat, strictValidation?: boolean, strictSuffixValidation?: boolean, allowDashes?: boolean, allowedPrefixes?: string[], blockedPrefixes?: string[]) => boolean;
+declare const validateTaiwanPostalCode: (value: string, format?: TwPostalCodeFormatType, strictValidation?: boolean, strictSuffixValidation?: boolean, allowDashes?: boolean, allowedPrefixes?: string[], blockedPrefixes?: string[]) => boolean;
 /**
  * Creates a Zod schema for Taiwan postal code validation
  *
  * @template IsRequired - Whether the field is required (affects return type)
- * @param {PostalCodeOptions<IsRequired>} [options] - Configuration options for postal code validation
- * @returns {PostalCodeSchema<IsRequired>} Zod schema for postal code validation
+ * @param {TwPostalCodeOptions<IsRequired>} [options] - Configuration options for postal code validation
+ * @returns {TwPostalCodeSchema<IsRequired>} Zod schema for postal code validation
  *
  * @description
  * Creates a comprehensive Taiwan postal code validator that supports multiple formats
@@ -2767,53 +2768,53 @@ declare const validateTaiwanPostalCode: (value: string, format?: PostalCodeForma
  * @example
  * ```typescript
  * // Accept 3-digit or 6-digit formats (recommended)
- * const modernSchema = postalCode()
+ * const modernSchema = twPostalCode()
  * modernSchema.parse("100")     // ✓ Valid 3-digit
  * modernSchema.parse("100001")  // ✓ Valid 6-digit
  * modernSchema.parse("10001")   // ✗ Invalid (5-digit not allowed)
  *
  * // Accept all formats
- * const flexibleSchema = postalCode(false, { format: "all" })
+ * const flexibleSchema = twPostalCode(false, { format: "all" })
  * flexibleSchema.parse("100")     // ✓ Valid
  * flexibleSchema.parse("10001")   // ✓ Valid
  * flexibleSchema.parse("100001")  // ✓ Valid
  *
  * // Only 6-digit format (current standard)
- * const modernOnlySchema = postalCode(false, { format: "6" })
+ * const modernOnlySchema = twPostalCode(false, { format: "6" })
  * modernOnlySchema.parse("100001") // ✓ Valid
  * modernOnlySchema.parse("100")    // ✗ Invalid
  *
  * // With dashes allowed
- * const dashSchema = postalCode(false, { allowDashes: true })
+ * const dashSchema = twPostalCode(false, { allowDashes: true })
  * dashSchema.parse("100-001")  // ✓ Valid (normalized to "100001")
  * dashSchema.parse("100-01")   // ✓ Valid if 5-digit format allowed
  *
  * // Specific areas only
- * const taipeiSchema = postalCode(false, {
+ * const taipeiSchema = twPostalCode(false, {
  *   allowedPrefixes: ["100", "103", "104", "105", "106"]
  * })
  * taipeiSchema.parse("100001") // ✓ Valid (Taipei area)
  * taipeiSchema.parse("200001") // ✗ Invalid (not in allowlist)
  *
  * // Block specific areas
- * const blockedSchema = postalCode(false, {
+ * const blockedSchema = twPostalCode(false, {
  *   blockedPrefixes: ["999"] // Block test codes
  * })
  *
  * // With warning for legacy format
- * const warnSchema = postalCode(false, {
+ * const warnSchema = twPostalCode(false, {
  *   format: "all",
  *   warn5Digit: true
  * })
  * // Will validate but may show warning for 5-digit codes
  *
  * // Optional with custom transformation
- * const optionalSchema = postalCode(false, {
+ * const optionalSchema = twPostalCode(false, {
  *   transform: (value) => value.replace(/\D/g, '') // Remove non-digits
  * })
  *
  * // Strict suffix validation for real postal codes
- * const strictSchema = postalCode(false, {
+ * const strictSchema = twPostalCode(false, {
  *   format: "6",
  *   strictSuffixValidation: true // Validates suffix range 001-999
  * })
@@ -2821,7 +2822,7 @@ declare const validateTaiwanPostalCode: (value: string, format?: PostalCodeForma
  * strictSchema.parse("100000") // ✗ Invalid (suffix 000 not allowed)
  *
  * // Deprecate 5-digit codes entirely
- * const modern2024Schema = postalCode(false, {
+ * const modern2024Schema = twPostalCode(false, {
  *   format: "all",
  *   deprecate5Digit: true // Throws error for any 5-digit code
  * })
@@ -2830,11 +2831,11 @@ declare const validateTaiwanPostalCode: (value: string, format?: PostalCodeForma
  * ```
  *
  * @throws {z.ZodError} When validation fails with specific error messages
- * @see {@link PostalCodeOptions} for all available configuration options
- * @see {@link PostalCodeFormat} for supported formats
+ * @see {@link TwPostalCodeOptions} for all available configuration options
+ * @see {@link TwPostalCodeFormatType} for supported formats
  * @see {@link validateTaiwanPostalCode} for validation logic details
  */
-declare function postalCode<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<PostalCodeOptions<IsRequired>, 'required'>): PostalCodeSchema<IsRequired>;
+declare function twPostalCode<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwPostalCodeOptions<IsRequired>, 'required'>): TwPostalCodeSchema<IsRequired>;
 
 /**
  * @fileoverview Taiwan Landline Telephone Number validator for Zod Kit
@@ -2849,12 +2850,12 @@ declare function postalCode<IsRequired extends boolean = false>(required?: IsReq
 /**
  * Type definition for telephone validation error messages
  *
- * @interface TelMessages
+ * @interface TwTelMessages
  * @property {string} [required] - Message when field is required but empty
  * @property {string} [invalid] - Message when telephone number format is invalid
  * @property {string} [notInWhitelist] - Message when telephone number is not in whitelist
  */
-type TelMessages = {
+type TwTelMessages = {
     required?: string;
     invalid?: string;
     notInWhitelist?: string;
@@ -2864,27 +2865,27 @@ type TelMessages = {
  *
  * @template IsRequired - Whether the field is required (affects return type)
  *
- * @interface TelOptions
+ * @interface TwTelOptions
  * @property {IsRequired} [required=true] - Whether the field is required
  * @property {string[]} [whitelist] - Array of specific telephone numbers that are always allowed
  * @property {Function} [transform] - Custom transformation function for telephone number
  * @property {string | null} [defaultValue] - Default value when input is empty
- * @property {Record<Locale, TelMessages>} [i18n] - Custom error messages for different locales
+ * @property {Record<Locale, TwTelMessages>} [i18n] - Custom error messages for different locales
  */
-type TelOptions<IsRequired extends boolean = true> = {
+type TwTelOptions<IsRequired extends boolean = true> = {
     whitelist?: string[];
     transform?: (value: string) => string;
     defaultValue?: IsRequired extends true ? string : string | null;
-    i18n?: Record<Locale, TelMessages>;
+    i18n?: Record<Locale, TwTelMessages>;
 };
 /**
  * Type alias for telephone validation schema based on required flag
  *
  * @template IsRequired - Whether the field is required
- * @typedef TelSchema
+ * @typedef TwTelSchema
  * @description Returns ZodString if required, ZodNullable<ZodString> if optional
  */
-type TelSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+type TwTelSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
 /**
  * Validates Taiwan landline telephone number format (Official 2024 rules)
  *
@@ -2897,28 +2898,26 @@ type TelSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString
  * number patterns.
  *
  * Supported area codes and formats:
- * - 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)
+ * - 02: Taipei, New Taipei, Keelung - 8 digits
+ * - 03: Taoyuan, Hsinchu, Yilan, Hualien - 7-8 digits
+ * - 037: Miaoli - 6-7 digits
+ * - 04: Taichung, Changhua, Nantou - 7-8 digits
+ * - 049: Nantou - 7 digits
  * - 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)
+ * - 07: Kaohsiung - 7 digits
+ * - 08: Pingtung - 7 digits
+ * - 082: Kinmen - 6 digits
+ * - 0836: Matsu - 5 digits
+ * - 089: Taitung - 6 digits
  *
  * @example
  * ```typescript
  * validateTaiwanTel("0223456789") // true (Taipei area)
- * validateTaiwanTel("0312345678") // true (Taoyuan area)
+ * validateTaiwanTel("0423288882") // true (Taichung area, 8 digits)
  * validateTaiwanTel("037234567") // true (Miaoli area)
  * validateTaiwanTel("082234567") // true (Kinmen area)
  * validateTaiwanTel("02-2345-6789") // true (with separators)
- * validateTaiwanTel("0812345678") // false (invalid for 08 area)
  * ```
  */
 declare const validateTaiwanTel: (value: string) => boolean;
@@ -2928,7 +2927,7 @@ declare const validateTaiwanTel: (value: string) => boolean;
  * @template IsRequired - Whether the field is required (affects return type)
  * @param {IsRequired} [required=false] - Whether the field is required
  * @param {Omit<ValidatorOptions<IsRequired>, 'required'>} [options] - Configuration options for validation
- * @returns {TelSchema<IsRequired>} Zod schema for telephone number validation
+ * @returns {TwTelSchema<IsRequired>} Zod schema for telephone number validation
  *
  * @description
  * Creates a comprehensive Taiwan landline telephone number validator with support for
@@ -2947,7 +2946,7 @@ declare const validateTaiwanTel: (value: string) => boolean;
  * @example
  * ```typescript
  * // Basic telephone number validation
- * const basicSchema = tel() // optional by default
+ * const basicSchema = twTel() // optional by default
  * basicSchema.parse("0223456789") // ✓ Valid (Taipei)
  * basicSchema.parse(null) // ✓ Valid (optional)
  *
@@ -2961,26 +2960,26 @@ declare const validateTaiwanTel: (value: string) => boolean;
  * basicSchema.parse("0812345678") // ✗ Invalid (wrong format for 08)
  *
  * // With whitelist (only specific numbers allowed)
- * const whitelistSchema = tel(false, {
+ * const whitelistSchema = twTel(false, {
  *   whitelist: ["0223456789", "0312345678"]
  * })
  * whitelistSchema.parse("0223456789") // ✓ Valid (in whitelist)
  * whitelistSchema.parse("0287654321") // ✗ Invalid (not in whitelist)
  *
  * // Optional telephone number
- * const optionalSchema = tel(false)
+ * const optionalSchema = twTel(false)
  * optionalSchema.parse("") // ✓ Valid (returns null)
  * optionalSchema.parse("0223456789") // ✓ Valid
  *
  * // With custom transformation (remove separators)
- * const transformSchema = tel(false, {
+ * const transformSchema = twTel(false, {
  *   transform: (value) => value.replace(/[^0-9]/g, '') // Keep only digits
  * })
  * transformSchema.parse("02-2345-6789") // ✓ Valid (separators removed)
  * transformSchema.parse("02 2345 6789") // ✓ Valid (spaces removed)
  *
  * // With custom error messages
- * const customSchema = tel(false, {
+ * const customSchema = twTel(false, {
  *   i18n: {
  *     en: { invalid: "Please enter a valid Taiwan landline number" },
  *     'zh-TW': { invalid: "請輸入有效的台灣市話號碼" }
@@ -2989,10 +2988,10 @@ declare const validateTaiwanTel: (value: string) => boolean;
  * ```
  *
  * @throws {z.ZodError} When validation fails with specific error messages
- * @see {@link TelOptions} for all available configuration options
+ * @see {@link TwTelOptions} for all available configuration options
  * @see {@link validateTaiwanTel} for validation logic details
  */
-declare function tel<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TelOptions<IsRequired>, 'required'>): TelSchema<IsRequired>;
+declare function twTel<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwTelOptions<IsRequired>, 'required'>): TwTelSchema<IsRequired>;
 
 /**
  * @fileoverview Taiwan Fax Number validator for Zod Kit
@@ -3007,12 +3006,12 @@ declare function tel<IsRequired extends boolean = false>(required?: IsRequired,
 /**
  * Type definition for fax number validation error messages
  *
- * @interface FaxMessages
+ * @interface TwFaxMessages
  * @property {string} [required] - Message when field is required but empty
  * @property {string} [invalid] - Message when fax number format is invalid
  * @property {string} [notInWhitelist] - Message when fax number is not in whitelist
  */
-type FaxMessages = {
+type TwFaxMessages = {
     required?: string;
     invalid?: string;
     notInWhitelist?: string;
@@ -3022,27 +3021,27 @@ type FaxMessages = {
  *
  * @template IsRequired - Whether the field is required (affects return type)
  *
- * @interface FaxOptions
+ * @interface TwFaxOptions
  * @property {IsRequired} [required=true] - Whether the field is required
  * @property {string[]} [whitelist] - Array of specific fax numbers that are always allowed
  * @property {Function} [transform] - Custom transformation function for fax number
  * @property {string | null} [defaultValue] - Default value when input is empty
- * @property {Record<Locale, FaxMessages>} [i18n] - Custom error messages for different locales
+ * @property {Record<Locale, TwFaxMessages>} [i18n] - Custom error messages for different locales
  */
-type FaxOptions<IsRequired extends boolean = true> = {
+type TwFaxOptions<IsRequired extends boolean = true> = {
     whitelist?: string[];
     transform?: (value: string) => string;
     defaultValue?: IsRequired extends true ? string : string | null;
-    i18n?: Record<Locale, FaxMessages>;
+    i18n?: Record<Locale, TwFaxMessages>;
 };
 /**
  * Type alias for fax number validation schema based on required flag
  *
  * @template IsRequired - Whether the field is required
- * @typedef FaxSchema
+ * @typedef TwFaxSchema
  * @description Returns ZodString if required, ZodNullable<ZodString> if optional
  */
-type FaxSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+type TwFaxSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
 /**
  * Validates Taiwan fax number format (Official 2024 rules - same as landline)
  *
@@ -3054,27 +3053,25 @@ type FaxSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString
  * Fax numbers follow the same format as landline telephone numbers in Taiwan.
  *
  * Supported area codes and formats (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)
+ * - 02: Taipei, New Taipei, Keelung - 8 digits
+ * - 03: Taoyuan, Hsinchu, Yilan, Hualien - 7-8 digits
+ * - 037: Miaoli - 6-7 digits
+ * - 04: Taichung, Changhua, Nantou - 7-8 digits
+ * - 049: Nantou - 7 digits
  * - 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)
+ * - 07: Kaohsiung - 7 digits
+ * - 08: Pingtung - 7 digits
+ * - 082: Kinmen - 6 digits
+ * - 0836: Matsu - 5 digits
+ * - 089: Taitung - 6 digits
  *
  * @example
  * ```typescript
  * validateTaiwanFax("0223456789") // true (Taipei area)
- * validateTaiwanFax("0312345678") // true (Taoyuan area)
+ * validateTaiwanFax("0423288882") // true (Taichung area, 8 digits)
  * validateTaiwanFax("037234567") // true (Miaoli area)
  * validateTaiwanFax("02-2345-6789") // true (with separators)
- * validateTaiwanFax("0812345678") // false (invalid for 08 area)
  * ```
  */
 declare const validateTaiwanFax: (value: string) => boolean;
@@ -3084,7 +3081,7 @@ declare const validateTaiwanFax: (value: string) => boolean;
  * @template IsRequired - Whether the field is required (affects return type)
  * @param {IsRequired} [required=false] - Whether the field is required
  * @param {Omit<ValidatorOptions<IsRequired>, 'required'>} [options] - Configuration options for validation
- * @returns {FaxSchema<IsRequired>} Zod schema for fax number validation
+ * @returns {TwFaxSchema<IsRequired>} Zod schema for fax number validation
  *
  * @description
  * Creates a comprehensive Taiwan fax number validator with support for all Taiwan
@@ -3103,7 +3100,7 @@ declare const validateTaiwanFax: (value: string) => boolean;
  * @example
  * ```typescript
  * // Basic fax number validation
- * const basicSchema = fax() // optional by default
+ * const basicSchema = twFax() // optional by default
  * basicSchema.parse("0223456789") // ✓ Valid (Taipei)
  * basicSchema.parse(null) // ✓ Valid (optional)
  *
@@ -3117,25 +3114,25 @@ declare const validateTaiwanFax: (value: string) => boolean;
  * basicSchema.parse("0812345678") // ✗ Invalid (wrong format for 08)
  *
  * // With whitelist (only specific numbers allowed)
- * const whitelistSchema = fax(false, {
+ * const whitelistSchema = twFax(false, {
  *   whitelist: ["0223456789", "0312345678"]
  * })
  * whitelistSchema.parse("0223456789") // ✓ Valid (in whitelist)
  * whitelistSchema.parse("0287654321") // ✗ Invalid (not in whitelist)
  *
  * // Optional fax number
- * const optionalSchema = fax(false)
+ * const optionalSchema = twFax(false)
  * optionalSchema.parse("") // ✓ Valid (returns null)
  * optionalSchema.parse("0223456789") // ✓ Valid
  *
  * // With custom transformation
- * const transformSchema = fax(false, {
+ * const transformSchema = twFax(false, {
  *   transform: (value) => value.replace(/[^0-9]/g, '') // Keep only digits
  * })
  * transformSchema.parse("02-2345-6789") // ✓ Valid (separators removed)
  *
  * // With custom error messages
- * const customSchema = fax(false, {
+ * const customSchema = twFax(false, {
  *   i18n: {
  *     en: { invalid: "Please enter a valid Taiwan fax number" },
  *     'zh-TW': { invalid: "請輸入有效的台灣傳真號碼" }
@@ -3144,9 +3141,9 @@ declare const validateTaiwanFax: (value: string) => boolean;
  * ```
  *
  * @throws {z.ZodError} When validation fails with specific error messages
- * @see {@link FaxOptions} for all available configuration options
+ * @see {@link TwFaxOptions} for all available configuration options
  * @see {@link validateTaiwanFax} for validation logic details
  */
-declare function fax<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<FaxOptions<IsRequired>, 'required'>): FaxSchema<IsRequired>;
+declare function twFax<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwFaxOptions<IsRequired>, 'required'>): TwFaxSchema<IsRequired>;
 
-export { type BooleanMessages, type BooleanOptions, type BooleanSchema, type BusinessIdMessages, type BusinessIdOptions, type BusinessIdSchema, DATETIME_PATTERNS, type DateMessages, type DateOptions, type DateSchema, type DateTimeFormat, type DateTimeMessages, type DateTimeOptions, type DateTimeSchema, type EmailMessages, type EmailOptions, type EmailSchema, type FaxMessages, type FaxOptions, type FaxSchema, type FileMessages, type FileOptions, type FileSchema, ID_PATTERNS, type IdMessages, type IdOptions, type IdSchema, type IdType, type Locale, type MobileMessages, type MobileOptions, type MobileSchema, type NationalIdMessages, type NationalIdOptions, type NationalIdSchema, type NationalIdType, type NumberMessages, type NumberOptions, type NumberSchema, type PasswordMessages, type PasswordOptions, type PasswordSchema, type PasswordStrength, type PostalCodeFormat, type PostalCodeMessages, type PostalCodeOptions, type PostalCodeSchema, TIME_PATTERNS, type TelMessages, type TelOptions, type TelSchema, type TextMessages, type TextOptions, type TextSchema, type TimeFormat, type TimeMessages, type TimeOptions, type TimeSchema, type UrlMessages, type UrlOptions, type UrlSchema, VALID_3_DIGIT_PREFIXES, boolean, businessId, date, datetime, detectIdType, email, fax, file, getLocale, id, mobile, nationalId, normalizeDateTimeValue, normalizeTime, number, parseDateTimeValue, parseTimeToMinutes, password, postalCode, setLocale, tel, text, time, url, validate3DigitPostalCode, validate5DigitPostalCode, validate6DigitPostalCode, validateCitizenId, validateDateTimeFormat, validateIdType, validateNewResidentId, validateOldResidentId, validateTaiwanBusinessId, validateTaiwanFax, validateTaiwanMobile, validateTaiwanNationalId, validateTaiwanPostalCode, validateTaiwanTel, validateTimeFormat };
+export { type BooleanMessages, type BooleanOptions, type BooleanSchema, DATETIME_PATTERNS, type DateMessages, type DateOptions, type DateSchema, type DateTimeFormat, type DateTimeMessages, type DateTimeOptions, type DateTimeSchema, type EmailMessages, type EmailOptions, type EmailSchema, type FileMessages, type FileOptions, type FileSchema, ID_PATTERNS, type IdMessages, type IdOptions, type IdSchema, type IdType, type Locale, type NationalIdType, type NumberMessages, type NumberOptions, type NumberSchema, type PasswordMessages, type PasswordOptions, type PasswordSchema, type PasswordStrength, TIME_PATTERNS, type TextMessages, type TextOptions, type TextSchema, type TimeFormat, type TimeMessages, type TimeOptions, type TimeSchema, type TwBusinessIdMessages, type TwBusinessIdOptions, type TwBusinessIdSchema, type TwFaxMessages, type TwFaxOptions, type TwFaxSchema, type TwMobileMessages, type TwMobileOptions, type TwMobileSchema, type TwNationalIdMessages, type TwNationalIdOptions, type TwNationalIdSchema, type TwPostalCodeFormatType, type TwPostalCodeMessages, type TwPostalCodeOptions, type TwPostalCodeSchema, type TwTelMessages, type TwTelOptions, type TwTelSchema, type UrlMessages, type UrlOptions, type UrlSchema, VALID_3_DIGIT_PREFIXES, boolean, date, datetime, detectIdType, email, file, getLocale, id, normalizeDateTimeValue, normalizeTime, number, parseDateTimeValue, parseTimeToMinutes, password, setLocale, text, time, twBusinessId, twFax, twMobile, twNationalId, twPostalCode, twTel, url, validate3DigitPostalCode, validate5DigitPostalCode, validate6DigitPostalCode, validateCitizenId, validateDateTimeFormat, validateIdType, validateNewResidentId, validateOldResidentId, validateTaiwanBusinessId, validateTaiwanFax, validateTaiwanMobile, validateTaiwanNationalId, validateTaiwanPostalCode, validateTaiwanTel, validateTimeFormat };