@hy_ong/zod-kit 0.2.0 → 0.2.2

package/dist/taiwan/postal-code.d.ts

@@ -0,0 +1,237 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.js';
+
+/**
+ * @fileoverview Taiwan Postal Code validator for Zod Kit
+ *
+ * Provides comprehensive validation for Taiwan postal codes with support for
+ * 3-digit, 5-digit (legacy), and 6-digit (current) formats based on official
+ * Chunghwa Post specifications.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for postal code validation error messages
+ *
+ * @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
+ * @property {string} [invalidRange] - Message when postal code is outside valid range
+ * @property {string} [legacy5DigitWarning] - Warning message for 5-digit legacy format
+ * @property {string} [format3Only] - Message when only 3-digit format is allowed
+ * @property {string} [format5Only] - Message when only 5-digit format is allowed
+ * @property {string} [format6Only] - Message when only 6-digit format is allowed
+ */
+type TwPostalCodeMessages = {
+    required?: string;
+    invalid?: string;
+    invalidFormat?: string;
+    invalidRange?: string;
+    legacy5DigitWarning?: string;
+    format3Only?: string;
+    format5Only?: string;
+    format6Only?: string;
+    invalidSuffix?: string;
+    deprecated5Digit?: string;
+};
+/**
+ * Postal code format types supported in Taiwan
+ *
+ * @typedef {"3" | "5" | "6" | "3+5" | "3+6" | "5+6" | "all"} TwPostalCodeFormatType
+ *
+ * Available formats:
+ * - "3": 3-digit basic postal codes (100-982)
+ * - "5": 5-digit postal codes (3+2 format, legacy)
+ * - "6": 6-digit postal codes (3+3 format, current standard)
+ * - "3+5": Accept both 3-digit and 5-digit formats
+ * - "3+6": Accept both 3-digit and 6-digit formats (recommended)
+ * - "5+6": Accept both 5-digit and 6-digit formats
+ * - "all": Accept all formats (3, 5, and 6 digits)
+ */
+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 TwPostalCodeOptions
+ * @property {IsRequired} [required=true] - Whether the field is required
+ * @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
+ * @property {string[]} [allowedPrefixes] - Specific 3-digit prefixes to allow (if strictValidation is true)
+ * @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, TwPostalCodeMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwPostalCodeOptions<IsRequired extends boolean = true> = {
+    format?: TwPostalCodeFormatType;
+    strictValidation?: boolean;
+    allowDashes?: boolean;
+    warn5Digit?: boolean;
+    allowedPrefixes?: string[];
+    blockedPrefixes?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwPostalCodeMessages>>>;
+    strictSuffixValidation?: boolean;
+    deprecate5Digit?: boolean;
+};
+/**
+ * Type alias for postal code validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwPostalCodeSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+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)
+ */
+declare const VALID_3_DIGIT_PREFIXES: string[];
+/**
+ * Validates 3-digit Taiwan postal code
+ *
+ * @param {string} value - The 3-digit postal code to validate
+ * @param {boolean} strictValidation - Whether to validate against known postal code list
+ * @param {string[]} allowedPrefixes - Specific prefixes to allow (overrides strictValidation)
+ * @param {string[]} blockedPrefixes - Specific prefixes to block
+ * @returns {boolean} True if the postal code is valid
+ */
+declare const validate3DigitPostalCode: (value: string, strictValidation?: boolean, allowedPrefixes?: string[], blockedPrefixes?: string[]) => boolean;
+/**
+ * Validates 5-digit Taiwan postal code (legacy format)
+ *
+ * @param {string} value - The 5-digit postal code to validate
+ * @param {boolean} strictValidation - Whether to validate the 3-digit prefix
+ * @param {boolean} strictSuffixValidation - Whether to validate the 2-digit suffix
+ * @param {string[]} allowedPrefixes - Specific prefixes to allow
+ * @param {string[]} blockedPrefixes - Specific prefixes to block
+ * @returns {boolean} True if the postal code is valid
+ */
+declare const validate5DigitPostalCode: (value: string, strictValidation?: boolean, strictSuffixValidation?: boolean, allowedPrefixes?: string[], blockedPrefixes?: string[]) => boolean;
+/**
+ * Validates 6-digit Taiwan postal code (current format)
+ *
+ * @param {string} value - The 6-digit postal code to validate
+ * @param {boolean} strictValidation - Whether to validate the 3-digit prefix
+ * @param {boolean} strictSuffixValidation - Whether to validate the 3-digit suffix
+ * @param {string[]} allowedPrefixes - Specific prefixes to allow
+ * @param {string[]} blockedPrefixes - Specific prefixes to block
+ * @returns {boolean} True if the postal code is valid
+ */
+declare const validate6DigitPostalCode: (value: string, strictValidation?: boolean, strictSuffixValidation?: boolean, allowedPrefixes?: string[], blockedPrefixes?: string[]) => boolean;
+/**
+ * Main validation function for Taiwan postal codes
+ *
+ * @param {string} value - The postal code to validate
+ * @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
+ * @param {string[]} allowedPrefixes - Specific prefixes to allow
+ * @param {string[]} blockedPrefixes - Specific prefixes to block
+ * @returns {boolean} True if the postal code is valid
+ */
+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 {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
+ * and provides extensive configuration options for different validation scenarios.
+ *
+ * Features:
+ * - 3-digit, 5-digit, and 6-digit postal code format support
+ * - Strict validation against official postal code ranges
+ * - Legacy 5-digit format with optional warnings
+ * - Custom prefix allowlist/blocklist support
+ * - Dash and space handling in postal codes
+ * - Automatic normalization and formatting
+ * - Custom transformation functions
+ * - Comprehensive internationalization
+ * - Optional field support
+ *
+ * @example
+ * ```typescript
+ * // Accept 3-digit or 6-digit formats (recommended)
+ * 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 = twPostalCode(false, { format: "all" })
+ * flexibleSchema.parse("100")     // ✓ Valid
+ * flexibleSchema.parse("10001")   // ✓ Valid
+ * flexibleSchema.parse("100001")  // ✓ Valid
+ *
+ * // Only 6-digit format (current standard)
+ * const modernOnlySchema = twPostalCode(false, { format: "6" })
+ * modernOnlySchema.parse("100001") // ✓ Valid
+ * modernOnlySchema.parse("100")    // ✗ Invalid
+ *
+ * // With dashes allowed
+ * 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 = 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 = twPostalCode(false, {
+ *   blockedPrefixes: ["999"] // Block test codes
+ * })
+ *
+ * // With warning for legacy format
+ * const warnSchema = twPostalCode(false, {
+ *   format: "all",
+ *   warn5Digit: true
+ * })
+ * // Will validate but may show warning for 5-digit codes
+ *
+ * // Optional with custom transformation
+ * const optionalSchema = twPostalCode(false, {
+ *   transform: (value) => value.replace(/\D/g, '') // Remove non-digits
+ * })
+ *
+ * // Strict suffix validation for real postal codes
+ * const strictSchema = twPostalCode(false, {
+ *   format: "6",
+ *   strictSuffixValidation: true // Validates suffix range 001-999
+ * })
+ * strictSchema.parse("100001") // ✓ Valid
+ * strictSchema.parse("100000") // ✗ Invalid (suffix 000 not allowed)
+ *
+ * // Deprecate 5-digit codes entirely
+ * const modern2024Schema = twPostalCode(false, {
+ *   format: "all",
+ *   deprecate5Digit: true // Throws error for any 5-digit code
+ * })
+ * modern2024Schema.parse("100001") // ✓ Valid 6-digit
+ * modern2024Schema.parse("10001")  // ✗ Error: deprecated format
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwPostalCodeOptions} for all available configuration options
+ * @see {@link TwPostalCodeFormatType} for supported formats
+ * @see {@link validateTaiwanPostalCode} for validation logic details
+ */
+declare function twPostalCode<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwPostalCodeOptions<IsRequired>, 'required'>): TwPostalCodeSchema<IsRequired>;
+
+export { type TwPostalCodeFormatType, type TwPostalCodeMessages, type TwPostalCodeOptions, type TwPostalCodeSchema, VALID_3_DIGIT_PREFIXES, twPostalCode, validate3DigitPostalCode, validate5DigitPostalCode, validate6DigitPostalCode, validateTaiwanPostalCode };

package/dist/taiwan/postal-code.js

@@ -0,0 +1,17 @@
+import {
+  VALID_3_DIGIT_PREFIXES,
+  twPostalCode,
+  validate3DigitPostalCode,
+  validate5DigitPostalCode,
+  validate6DigitPostalCode,
+  validateTaiwanPostalCode
+} from "../chunk-H2XTEM4M.js";
+import "../chunk-6AAP4LPF.js";
+export {
+  VALID_3_DIGIT_PREFIXES,
+  twPostalCode,
+  validate3DigitPostalCode,
+  validate5DigitPostalCode,
+  validate6DigitPostalCode,
+  validateTaiwanPostalCode
+};

package/dist/taiwan/tel.cjs

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkVB2KV2ZMcjs = require('../chunk-VB2KV2ZM.cjs');
+require('../chunk-UCOXAZJF.cjs');
+
+
+
+exports.twTel = _chunkVB2KV2ZMcjs.twTel; exports.validateTaiwanTel = _chunkVB2KV2ZMcjs.validateTaiwanTel;

package/dist/taiwan/tel.d.cts

@@ -0,0 +1,162 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.cjs';
+
+/**
+ * @fileoverview Taiwan Landline Telephone Number validator for Zod Kit
+ *
+ * Provides validation for Taiwan landline telephone numbers according to the
+ * official 2024 telecom numbering plan with comprehensive area code support.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for telephone validation error messages
+ *
+ * @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 TwTelMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+/**
+ * Configuration options for Taiwan landline telephone validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwTelMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwTelOptions<IsRequired extends boolean = true> = {
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwTelMessages>>>;
+};
+/**
+ * Type alias for telephone validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwTelSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwTelSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan landline telephone number format (Official 2024 rules)
+ *
+ * @param {string} value - The telephone number to validate
+ * @returns {boolean} True if the telephone number is valid
+ *
+ * @description
+ * Validates Taiwan landline telephone numbers according to the official 2024
+ * telecom numbering plan. Supports all Taiwan area codes and their specific
+ * number patterns.
+ *
+ * Supported area codes and formats:
+ * - 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 - 6-7 digits
+ * - 05: Yunlin, Chiayi - 7 digits
+ * - 06: Tainan - 7 digits
+ * - 07: Kaohsiung - 7-8 digits
+ * - 08: Pingtung - 7 digits
+ * - 0800: Toll-free - 6 digits
+ * - 0809: Toll-free - 6 digits
+ * - 082: Kinmen - 6 digits
+ * - 0836: Matsu - 5-6 digits
+ * - 089: Taitung - 6 digits
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanTel("0223456789") // true (Taipei 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)
+ * ```
+ */
+declare const validateTaiwanTel: (value: string) => boolean;
+/**
+ * Creates a Zod schema for Taiwan landline telephone 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 {TwTelSchema<IsRequired>} Zod schema for telephone number validation
+ *
+ * @description
+ * Creates a comprehensive Taiwan landline telephone number validator with support for
+ * all Taiwan area codes according to the official 2024 telecom numbering plan.
+ *
+ * Features:
+ * - Complete Taiwan area code support (02, 03, 037, 04, 049, 05, 06, 07, 08, 082, 0826, 0836, 089)
+ * - 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 telephone number validation
+ * const basicSchema = twTel() // 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 = twTel(false, {
+ *   whitelist: ["0223456789", "0312345678"]
+ * })
+ * whitelistSchema.parse("0223456789") // ✓ Valid (in whitelist)
+ * whitelistSchema.parse("0287654321") // ✗ Invalid (not in whitelist)
+ *
+ * // Optional telephone number
+ * const optionalSchema = twTel(false)
+ * optionalSchema.parse("") // ✓ Valid (returns null)
+ * optionalSchema.parse("0223456789") // ✓ Valid
+ *
+ * // With custom transformation (remove separators)
+ * 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 = twTel(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan landline number" },
+ *     'zh-TW': { invalid: "請輸入有效的台灣市話號碼" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwTelOptions} for all available configuration options
+ * @see {@link validateTaiwanTel} for validation logic details
+ */
+declare function twTel<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwTelOptions<IsRequired>, 'required'>): TwTelSchema<IsRequired>;
+
+export { type TwTelMessages, type TwTelOptions, type TwTelSchema, twTel, validateTaiwanTel };

package/dist/taiwan/tel.d.ts

@@ -0,0 +1,162 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.js';
+
+/**
+ * @fileoverview Taiwan Landline Telephone Number validator for Zod Kit
+ *
+ * Provides validation for Taiwan landline telephone numbers according to the
+ * official 2024 telecom numbering plan with comprehensive area code support.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for telephone validation error messages
+ *
+ * @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 TwTelMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+/**
+ * Configuration options for Taiwan landline telephone validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwTelMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwTelOptions<IsRequired extends boolean = true> = {
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwTelMessages>>>;
+};
+/**
+ * Type alias for telephone validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwTelSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwTelSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan landline telephone number format (Official 2024 rules)
+ *
+ * @param {string} value - The telephone number to validate
+ * @returns {boolean} True if the telephone number is valid
+ *
+ * @description
+ * Validates Taiwan landline telephone numbers according to the official 2024
+ * telecom numbering plan. Supports all Taiwan area codes and their specific
+ * number patterns.
+ *
+ * Supported area codes and formats:
+ * - 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 - 6-7 digits
+ * - 05: Yunlin, Chiayi - 7 digits
+ * - 06: Tainan - 7 digits
+ * - 07: Kaohsiung - 7-8 digits
+ * - 08: Pingtung - 7 digits
+ * - 0800: Toll-free - 6 digits
+ * - 0809: Toll-free - 6 digits
+ * - 082: Kinmen - 6 digits
+ * - 0836: Matsu - 5-6 digits
+ * - 089: Taitung - 6 digits
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanTel("0223456789") // true (Taipei 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)
+ * ```
+ */
+declare const validateTaiwanTel: (value: string) => boolean;
+/**
+ * Creates a Zod schema for Taiwan landline telephone 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 {TwTelSchema<IsRequired>} Zod schema for telephone number validation
+ *
+ * @description
+ * Creates a comprehensive Taiwan landline telephone number validator with support for
+ * all Taiwan area codes according to the official 2024 telecom numbering plan.
+ *
+ * Features:
+ * - Complete Taiwan area code support (02, 03, 037, 04, 049, 05, 06, 07, 08, 082, 0826, 0836, 089)
+ * - 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 telephone number validation
+ * const basicSchema = twTel() // 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 = twTel(false, {
+ *   whitelist: ["0223456789", "0312345678"]
+ * })
+ * whitelistSchema.parse("0223456789") // ✓ Valid (in whitelist)
+ * whitelistSchema.parse("0287654321") // ✗ Invalid (not in whitelist)
+ *
+ * // Optional telephone number
+ * const optionalSchema = twTel(false)
+ * optionalSchema.parse("") // ✓ Valid (returns null)
+ * optionalSchema.parse("0223456789") // ✓ Valid
+ *
+ * // With custom transformation (remove separators)
+ * 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 = twTel(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan landline number" },
+ *     'zh-TW': { invalid: "請輸入有效的台灣市話號碼" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwTelOptions} for all available configuration options
+ * @see {@link validateTaiwanTel} for validation logic details
+ */
+declare function twTel<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwTelOptions<IsRequired>, 'required'>): TwTelSchema<IsRequired>;
+
+export { type TwTelMessages, type TwTelOptions, type TwTelSchema, twTel, validateTaiwanTel };

package/dist/taiwan/tel.js

@@ -0,0 +1,9 @@
+import {
+  twTel,
+  validateTaiwanTel
+} from "../chunk-UQZKFAFX.js";
+import "../chunk-6AAP4LPF.js";
+export {
+  twTel,
+  validateTaiwanTel
+};