@hy_ong/zod-kit 0.2.0 → 0.2.2

package/dist/taiwan/bank-account.cjs

@@ -0,0 +1,11 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunkL4HSIKTUcjs = require('../chunk-L4HSIKTU.cjs');
+require('../chunk-UCOXAZJF.cjs');
+
+
+
+
+exports.TAIWAN_BANK_CODES = _chunkL4HSIKTUcjs.TAIWAN_BANK_CODES; exports.twBankAccount = _chunkL4HSIKTUcjs.twBankAccount; exports.validateTaiwanBankAccount = _chunkL4HSIKTUcjs.validateTaiwanBankAccount;

package/dist/taiwan/bank-account.d.cts

@@ -0,0 +1,22 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.cjs';
+
+declare const TAIWAN_BANK_CODES: Record<string, string>;
+type TwBankAccountMessages = {
+    required?: string;
+    invalid?: string;
+    invalidBankCode?: string;
+    invalidAccountNumber?: string;
+};
+type TwBankAccountOptions<IsRequired extends boolean = true> = {
+    validateBankCode?: boolean;
+    bankCode?: string;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwBankAccountMessages>>>;
+};
+type TwBankAccountSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanBankAccount: (value: string, validateBankCode?: boolean) => boolean;
+declare function twBankAccount<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwBankAccountOptions<IsRequired>, "required">): TwBankAccountSchema<IsRequired>;
+
+export { TAIWAN_BANK_CODES, type TwBankAccountMessages, type TwBankAccountOptions, type TwBankAccountSchema, twBankAccount, validateTaiwanBankAccount };

package/dist/taiwan/bank-account.d.ts

@@ -0,0 +1,22 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.js';
+
+declare const TAIWAN_BANK_CODES: Record<string, string>;
+type TwBankAccountMessages = {
+    required?: string;
+    invalid?: string;
+    invalidBankCode?: string;
+    invalidAccountNumber?: string;
+};
+type TwBankAccountOptions<IsRequired extends boolean = true> = {
+    validateBankCode?: boolean;
+    bankCode?: string;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwBankAccountMessages>>>;
+};
+type TwBankAccountSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanBankAccount: (value: string, validateBankCode?: boolean) => boolean;
+declare function twBankAccount<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwBankAccountOptions<IsRequired>, "required">): TwBankAccountSchema<IsRequired>;
+
+export { TAIWAN_BANK_CODES, type TwBankAccountMessages, type TwBankAccountOptions, type TwBankAccountSchema, twBankAccount, validateTaiwanBankAccount };

package/dist/taiwan/bank-account.js

@@ -0,0 +1,11 @@
+import {
+  TAIWAN_BANK_CODES,
+  twBankAccount,
+  validateTaiwanBankAccount
+} from "../chunk-MINMXGW3.js";
+import "../chunk-6AAP4LPF.js";
+export {
+  TAIWAN_BANK_CODES,
+  twBankAccount,
+  validateTaiwanBankAccount
+};

package/dist/taiwan/business-id.cjs

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkORVV4MCFcjs = require('../chunk-ORVV4MCF.cjs');
+require('../chunk-UCOXAZJF.cjs');
+
+
+
+exports.twBusinessId = _chunkORVV4MCFcjs.twBusinessId; exports.validateTaiwanBusinessId = _chunkORVV4MCFcjs.validateTaiwanBusinessId;

package/dist/taiwan/business-id.d.cts

@@ -0,0 +1,133 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.cjs';
+
+/**
+ * @fileoverview Taiwan Business ID (統一編號) validator for Zod Kit
+ *
+ * Provides validation for Taiwan Business Identification Numbers (統一編號) with
+ * support for both new (2023+) and legacy validation rules.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for business ID validation error messages
+ *
+ * @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 TwBusinessIdMessages = {
+    required?: string;
+    invalid?: string;
+};
+/**
+ * Configuration options for Taiwan business ID validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwBusinessIdMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwBusinessIdOptions<IsRequired extends boolean = true> = {
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwBusinessIdMessages>>>;
+};
+/**
+ * Type alias for business ID validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwBusinessIdSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwBusinessIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan Business Identification Number (統一編號)
+ *
+ * @param {string} value - The business ID to validate
+ * @returns {boolean} True if the business ID is valid
+ *
+ * @description
+ * Validates Taiwan Business ID using both new (2023+) and legacy validation rules.
+ * The validation includes format checking (8 digits) and checksum verification.
+ *
+ * Validation rules:
+ * 1. Must be exactly 8 digits
+ * 2. Weighted sum calculation using coefficients [1,2,1,2,1,2,4] for first 7 digits
+ * 3. New rules (2023+): Sum + 8th digit must be divisible by 5
+ * 4. Legacy rules: Sum + 8th digit must be divisible by 10
+ * 5. Special case: If 7th digit is 7, try alternative calculation with +1
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanBusinessId("12345675") // true (if valid checksum)
+ * validateTaiwanBusinessId("1234567") // false (not 8 digits)
+ * validateTaiwanBusinessId("abcd1234") // false (not all digits)
+ * ```
+ */
+declare const validateTaiwanBusinessId: (value: string) => boolean;
+/**
+ * Creates a Zod schema for Taiwan Business ID validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ * @param {BusinessIdOptions<IsRequired>} [options] - Configuration options for business ID validation
+ * @returns {BusinessIdSchema<IsRequired>} Zod schema for business ID validation
+ *
+ * @description
+ * Creates a comprehensive Taiwan Business ID validator that validates the format
+ * and checksum according to Taiwan government specifications.
+ *
+ * Features:
+ * - 8-digit format validation
+ * - Checksum verification (supports both new 2023+ and legacy rules)
+ * - Automatic trimming and preprocessing
+ * - Custom transformation functions
+ * - Comprehensive internationalization
+ * - Optional field support
+ *
+ * @example
+ * ```typescript
+ * // Basic business ID validation
+ * const basicSchema = businessId() // optional by default
+ * basicSchema.parse("12345675") // ✓ Valid (if checksum correct)
+ * basicSchema.parse(null) // ✓ Valid (optional)
+ *
+ * // Required validation
+ * const requiredSchema = parse("12345675") // ✓ Valid (if checksum correct)
+(true)
+ * requiredSchema.parse(null) // ✗ Invalid (required)
+ *
+ * basicSchema.parse("1234567") // ✗ Invalid (not 8 digits)
+ *
+ * // Optional business ID
+ * const optionalSchema = businessId(false)
+ * optionalSchema.parse("") // ✓ Valid (returns null)
+ * optionalSchema.parse("12345675") // ✓ Valid (if checksum correct)
+ *
+ * // With custom transformation
+ * const transformSchema = businessId(false, {
+ *   transform: (value) => value.replace(/[^0-9]/g, '') // Remove non-digits
+ * })
+ * transformSchema.parse("1234-5675") // ✓ Valid (if checksum correct after cleaning)
+ *
+ * // With custom error messages
+ * const customSchema = businessId(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan Business ID" },
+ *     'zh-TW': { invalid: "請輸入有效的統一編號" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwBusinessIdOptions} for all available configuration options
+ * @see {@link validateTaiwanBusinessId} for validation logic details
+ */
+declare function twBusinessId<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwBusinessIdOptions<IsRequired>, "required">): TwBusinessIdSchema<IsRequired>;
+
+export { type TwBusinessIdMessages, type TwBusinessIdOptions, type TwBusinessIdSchema, twBusinessId, validateTaiwanBusinessId };

package/dist/taiwan/business-id.d.ts

@@ -0,0 +1,133 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.js';
+
+/**
+ * @fileoverview Taiwan Business ID (統一編號) validator for Zod Kit
+ *
+ * Provides validation for Taiwan Business Identification Numbers (統一編號) with
+ * support for both new (2023+) and legacy validation rules.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for business ID validation error messages
+ *
+ * @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 TwBusinessIdMessages = {
+    required?: string;
+    invalid?: string;
+};
+/**
+ * Configuration options for Taiwan business ID validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwBusinessIdMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwBusinessIdOptions<IsRequired extends boolean = true> = {
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwBusinessIdMessages>>>;
+};
+/**
+ * Type alias for business ID validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwBusinessIdSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwBusinessIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan Business Identification Number (統一編號)
+ *
+ * @param {string} value - The business ID to validate
+ * @returns {boolean} True if the business ID is valid
+ *
+ * @description
+ * Validates Taiwan Business ID using both new (2023+) and legacy validation rules.
+ * The validation includes format checking (8 digits) and checksum verification.
+ *
+ * Validation rules:
+ * 1. Must be exactly 8 digits
+ * 2. Weighted sum calculation using coefficients [1,2,1,2,1,2,4] for first 7 digits
+ * 3. New rules (2023+): Sum + 8th digit must be divisible by 5
+ * 4. Legacy rules: Sum + 8th digit must be divisible by 10
+ * 5. Special case: If 7th digit is 7, try alternative calculation with +1
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanBusinessId("12345675") // true (if valid checksum)
+ * validateTaiwanBusinessId("1234567") // false (not 8 digits)
+ * validateTaiwanBusinessId("abcd1234") // false (not all digits)
+ * ```
+ */
+declare const validateTaiwanBusinessId: (value: string) => boolean;
+/**
+ * Creates a Zod schema for Taiwan Business ID validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ * @param {BusinessIdOptions<IsRequired>} [options] - Configuration options for business ID validation
+ * @returns {BusinessIdSchema<IsRequired>} Zod schema for business ID validation
+ *
+ * @description
+ * Creates a comprehensive Taiwan Business ID validator that validates the format
+ * and checksum according to Taiwan government specifications.
+ *
+ * Features:
+ * - 8-digit format validation
+ * - Checksum verification (supports both new 2023+ and legacy rules)
+ * - Automatic trimming and preprocessing
+ * - Custom transformation functions
+ * - Comprehensive internationalization
+ * - Optional field support
+ *
+ * @example
+ * ```typescript
+ * // Basic business ID validation
+ * const basicSchema = businessId() // optional by default
+ * basicSchema.parse("12345675") // ✓ Valid (if checksum correct)
+ * basicSchema.parse(null) // ✓ Valid (optional)
+ *
+ * // Required validation
+ * const requiredSchema = parse("12345675") // ✓ Valid (if checksum correct)
+(true)
+ * requiredSchema.parse(null) // ✗ Invalid (required)
+ *
+ * basicSchema.parse("1234567") // ✗ Invalid (not 8 digits)
+ *
+ * // Optional business ID
+ * const optionalSchema = businessId(false)
+ * optionalSchema.parse("") // ✓ Valid (returns null)
+ * optionalSchema.parse("12345675") // ✓ Valid (if checksum correct)
+ *
+ * // With custom transformation
+ * const transformSchema = businessId(false, {
+ *   transform: (value) => value.replace(/[^0-9]/g, '') // Remove non-digits
+ * })
+ * transformSchema.parse("1234-5675") // ✓ Valid (if checksum correct after cleaning)
+ *
+ * // With custom error messages
+ * const customSchema = businessId(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan Business ID" },
+ *     'zh-TW': { invalid: "請輸入有效的統一編號" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwBusinessIdOptions} for all available configuration options
+ * @see {@link validateTaiwanBusinessId} for validation logic details
+ */
+declare function twBusinessId<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwBusinessIdOptions<IsRequired>, "required">): TwBusinessIdSchema<IsRequired>;
+
+export { type TwBusinessIdMessages, type TwBusinessIdOptions, type TwBusinessIdSchema, twBusinessId, validateTaiwanBusinessId };

package/dist/taiwan/business-id.js

@@ -0,0 +1,9 @@
+import {
+  twBusinessId,
+  validateTaiwanBusinessId
+} from "../chunk-5JGTDL3Y.js";
+import "../chunk-6AAP4LPF.js";
+export {
+  twBusinessId,
+  validateTaiwanBusinessId
+};

package/dist/taiwan/fax.cjs

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkYDH3L27Kcjs = require('../chunk-YDH3L27K.cjs');
+require('../chunk-UCOXAZJF.cjs');
+
+
+
+exports.twFax = _chunkYDH3L27Kcjs.twFax; exports.validateTaiwanFax = _chunkYDH3L27Kcjs.validateTaiwanFax;

package/dist/taiwan/fax.d.cts

@@ -0,0 +1,157 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.cjs';
+
+/**
+ * @fileoverview Taiwan Fax Number validator for Zod Kit
+ *
+ * Provides validation for Taiwan fax numbers according to the official 2024
+ * telecom numbering plan. Uses the same format as landline telephone numbers.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for fax number validation error messages
+ *
+ * @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 TwFaxMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+/**
+ * Configuration options for Taiwan fax number validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwFaxMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwFaxOptions<IsRequired extends boolean = true> = {
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwFaxMessages>>>;
+};
+/**
+ * Type alias for fax number validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwFaxSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwFaxSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan fax number format (Official 2024 rules - same as landline)
+ *
+ * @param {string} value - The fax number to validate
+ * @returns {boolean} True if the fax number is valid
+ *
+ * @description
+ * Validates Taiwan fax numbers according to the official 2024 telecom numbering plan.
+ * 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
+ * - 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
+ * - 08: Pingtung - 7 digits
+ * - 082: Kinmen - 6 digits
+ * - 0836: Matsu - 5 digits
+ * - 089: Taitung - 6 digits
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanFax("0223456789") // true (Taipei area)
+ * validateTaiwanFax("0423288882") // true (Taichung area, 8 digits)
+ * validateTaiwanFax("037234567") // true (Miaoli area)
+ * validateTaiwanFax("02-2345-6789") // true (with separators)
+ * ```
+ */
+declare const validateTaiwanFax: (value: string) => boolean;
+/**
+ * Creates a Zod schema for Taiwan fax number validation
+ *
+ * @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 {TwFaxSchema<IsRequired>} Zod schema for fax number validation
+ *
+ * @description
+ * Creates a comprehensive Taiwan fax number validator with support for all Taiwan
+ * area codes. Fax numbers follow the same format as landline telephone numbers.
+ *
+ * Features:
+ * - Complete Taiwan area code support (same as landline)
+ * - Automatic separator handling (hyphens and spaces)
+ * - Area-specific number length and pattern validation
+ * - Whitelist functionality for specific allowed numbers
+ * - Automatic trimming and preprocessing
+ * - Custom transformation functions
+ * - Comprehensive internationalization
+ * - Optional field support
+ *
+ * @example
+ * ```typescript
+ * // Basic fax number validation
+ * const basicSchema = twFax() // optional by default
+ * basicSchema.parse("0223456789") // ✓ Valid (Taipei)
+ * basicSchema.parse(null) // ✓ Valid (optional)
+ *
+ * // Required validation
+ * const requiredSchema = parse("0223456789") // ✓ Valid (Taipei)
+(true)
+ * requiredSchema.parse(null) // ✗ Invalid (required)
+ *
+ * basicSchema.parse("0312345678") // ✓ Valid (Taoyuan)
+ * basicSchema.parse("02-2345-6789") // ✓ Valid (with separators)
+ * basicSchema.parse("0812345678") // ✗ Invalid (wrong format for 08)
+ *
+ * // With whitelist (only specific numbers allowed)
+ * 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 = twFax(false)
+ * optionalSchema.parse("") // ✓ Valid (returns null)
+ * optionalSchema.parse("0223456789") // ✓ Valid
+ *
+ * // With custom transformation
+ * 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 = twFax(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan fax number" },
+ *     'zh-TW': { invalid: "請輸入有效的台灣傳真號碼" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwFaxOptions} for all available configuration options
+ * @see {@link validateTaiwanFax} for validation logic details
+ */
+declare function twFax<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwFaxOptions<IsRequired>, 'required'>): TwFaxSchema<IsRequired>;
+
+export { type TwFaxMessages, type TwFaxOptions, type TwFaxSchema, twFax, validateTaiwanFax };

package/dist/taiwan/fax.d.ts

@@ -0,0 +1,157 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.js';
+
+/**
+ * @fileoverview Taiwan Fax Number validator for Zod Kit
+ *
+ * Provides validation for Taiwan fax numbers according to the official 2024
+ * telecom numbering plan. Uses the same format as landline telephone numbers.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for fax number validation error messages
+ *
+ * @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 TwFaxMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+/**
+ * Configuration options for Taiwan fax number validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwFaxMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwFaxOptions<IsRequired extends boolean = true> = {
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwFaxMessages>>>;
+};
+/**
+ * Type alias for fax number validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwFaxSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwFaxSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan fax number format (Official 2024 rules - same as landline)
+ *
+ * @param {string} value - The fax number to validate
+ * @returns {boolean} True if the fax number is valid
+ *
+ * @description
+ * Validates Taiwan fax numbers according to the official 2024 telecom numbering plan.
+ * 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
+ * - 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
+ * - 08: Pingtung - 7 digits
+ * - 082: Kinmen - 6 digits
+ * - 0836: Matsu - 5 digits
+ * - 089: Taitung - 6 digits
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanFax("0223456789") // true (Taipei area)
+ * validateTaiwanFax("0423288882") // true (Taichung area, 8 digits)
+ * validateTaiwanFax("037234567") // true (Miaoli area)
+ * validateTaiwanFax("02-2345-6789") // true (with separators)
+ * ```
+ */
+declare const validateTaiwanFax: (value: string) => boolean;
+/**
+ * Creates a Zod schema for Taiwan fax number validation
+ *
+ * @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 {TwFaxSchema<IsRequired>} Zod schema for fax number validation
+ *
+ * @description
+ * Creates a comprehensive Taiwan fax number validator with support for all Taiwan
+ * area codes. Fax numbers follow the same format as landline telephone numbers.
+ *
+ * Features:
+ * - Complete Taiwan area code support (same as landline)
+ * - Automatic separator handling (hyphens and spaces)
+ * - Area-specific number length and pattern validation
+ * - Whitelist functionality for specific allowed numbers
+ * - Automatic trimming and preprocessing
+ * - Custom transformation functions
+ * - Comprehensive internationalization
+ * - Optional field support
+ *
+ * @example
+ * ```typescript
+ * // Basic fax number validation
+ * const basicSchema = twFax() // optional by default
+ * basicSchema.parse("0223456789") // ✓ Valid (Taipei)
+ * basicSchema.parse(null) // ✓ Valid (optional)
+ *
+ * // Required validation
+ * const requiredSchema = parse("0223456789") // ✓ Valid (Taipei)
+(true)
+ * requiredSchema.parse(null) // ✗ Invalid (required)
+ *
+ * basicSchema.parse("0312345678") // ✓ Valid (Taoyuan)
+ * basicSchema.parse("02-2345-6789") // ✓ Valid (with separators)
+ * basicSchema.parse("0812345678") // ✗ Invalid (wrong format for 08)
+ *
+ * // With whitelist (only specific numbers allowed)
+ * 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 = twFax(false)
+ * optionalSchema.parse("") // ✓ Valid (returns null)
+ * optionalSchema.parse("0223456789") // ✓ Valid
+ *
+ * // With custom transformation
+ * 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 = twFax(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan fax number" },
+ *     'zh-TW': { invalid: "請輸入有效的台灣傳真號碼" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwFaxOptions} for all available configuration options
+ * @see {@link validateTaiwanFax} for validation logic details
+ */
+declare function twFax<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwFaxOptions<IsRequired>, 'required'>): TwFaxSchema<IsRequired>;
+
+export { type TwFaxMessages, type TwFaxOptions, type TwFaxSchema, twFax, validateTaiwanFax };