@hy_ong/zod-kit 0.2.0 → 0.2.2

package/dist/taiwan/fax.js

@@ -0,0 +1,9 @@
+import {
+  twFax,
+  validateTaiwanFax
+} from "../chunk-RKUQREMW.js";
+import "../chunk-6AAP4LPF.js";
+export {
+  twFax,
+  validateTaiwanFax
+};

package/dist/taiwan/invoice.cjs

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkTQXDUMMLcjs = require('../chunk-TQXDUMML.cjs');
+require('../chunk-UCOXAZJF.cjs');
+
+
+
+exports.twInvoice = _chunkTQXDUMMLcjs.twInvoice; exports.validateTaiwanInvoice = _chunkTQXDUMMLcjs.validateTaiwanInvoice;

package/dist/taiwan/invoice.d.cts

@@ -0,0 +1,17 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.cjs';
+
+type TwInvoiceMessages = {
+    required?: string;
+    invalid?: string;
+};
+type TwInvoiceOptions<IsRequired extends boolean = true> = {
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwInvoiceMessages>>>;
+};
+type TwInvoiceSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanInvoice: (value: string) => boolean;
+declare function twInvoice<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwInvoiceOptions<IsRequired>, "required">): TwInvoiceSchema<IsRequired>;
+
+export { type TwInvoiceMessages, type TwInvoiceOptions, type TwInvoiceSchema, twInvoice, validateTaiwanInvoice };

package/dist/taiwan/invoice.d.ts

@@ -0,0 +1,17 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.js';
+
+type TwInvoiceMessages = {
+    required?: string;
+    invalid?: string;
+};
+type TwInvoiceOptions<IsRequired extends boolean = true> = {
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwInvoiceMessages>>>;
+};
+type TwInvoiceSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanInvoice: (value: string) => boolean;
+declare function twInvoice<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwInvoiceOptions<IsRequired>, "required">): TwInvoiceSchema<IsRequired>;
+
+export { type TwInvoiceMessages, type TwInvoiceOptions, type TwInvoiceSchema, twInvoice, validateTaiwanInvoice };

package/dist/taiwan/invoice.js

@@ -0,0 +1,9 @@
+import {
+  twInvoice,
+  validateTaiwanInvoice
+} from "../chunk-KFOHKTFD.js";
+import "../chunk-6AAP4LPF.js";
+export {
+  twInvoice,
+  validateTaiwanInvoice
+};

package/dist/taiwan/license-plate.cjs

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkGJIRDBZJcjs = require('../chunk-GJIRDBZJ.cjs');
+require('../chunk-UCOXAZJF.cjs');
+
+
+
+exports.twLicensePlate = _chunkGJIRDBZJcjs.twLicensePlate; exports.validateTaiwanLicensePlate = _chunkGJIRDBZJcjs.validateTaiwanLicensePlate;

package/dist/taiwan/license-plate.d.cts

@@ -0,0 +1,19 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.cjs';
+
+type PlateType = "car" | "motorcycle" | "any";
+type TwLicensePlateMessages = {
+    required?: string;
+    invalid?: string;
+};
+type TwLicensePlateOptions<IsRequired extends boolean = true> = {
+    plateType?: PlateType;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwLicensePlateMessages>>>;
+};
+type TwLicensePlateSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanLicensePlate: (value: string, plateType?: PlateType) => boolean;
+declare function twLicensePlate<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwLicensePlateOptions<IsRequired>, "required">): TwLicensePlateSchema<IsRequired>;
+
+export { type PlateType, type TwLicensePlateMessages, type TwLicensePlateOptions, type TwLicensePlateSchema, twLicensePlate, validateTaiwanLicensePlate };

package/dist/taiwan/license-plate.d.ts

@@ -0,0 +1,19 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.js';
+
+type PlateType = "car" | "motorcycle" | "any";
+type TwLicensePlateMessages = {
+    required?: string;
+    invalid?: string;
+};
+type TwLicensePlateOptions<IsRequired extends boolean = true> = {
+    plateType?: PlateType;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwLicensePlateMessages>>>;
+};
+type TwLicensePlateSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanLicensePlate: (value: string, plateType?: PlateType) => boolean;
+declare function twLicensePlate<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwLicensePlateOptions<IsRequired>, "required">): TwLicensePlateSchema<IsRequired>;
+
+export { type PlateType, type TwLicensePlateMessages, type TwLicensePlateOptions, type TwLicensePlateSchema, twLicensePlate, validateTaiwanLicensePlate };

package/dist/taiwan/license-plate.js

@@ -0,0 +1,9 @@
+import {
+  twLicensePlate,
+  validateTaiwanLicensePlate
+} from "../chunk-LL4ZWLGO.js";
+import "../chunk-6AAP4LPF.js";
+export {
+  twLicensePlate,
+  validateTaiwanLicensePlate
+};

package/dist/taiwan/mobile.cjs

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkERH4NIMUcjs = require('../chunk-ERH4NIMU.cjs');
+require('../chunk-UCOXAZJF.cjs');
+
+
+
+exports.twMobile = _chunkERH4NIMUcjs.twMobile; exports.validateTaiwanMobile = _chunkERH4NIMUcjs.validateTaiwanMobile;

package/dist/taiwan/mobile.d.cts

@@ -0,0 +1,146 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.cjs';
+
+/**
+ * @fileoverview Taiwan Mobile Phone Number validator for Zod Kit
+ *
+ * Provides validation for Taiwan mobile phone numbers with support for
+ * all Taiwan mobile network operators and whitelist functionality.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for mobile phone validation error messages
+ *
+ * @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 TwMobileMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+/**
+ * Configuration options for Taiwan mobile phone validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwMobileMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwMobileOptions<IsRequired extends boolean = true> = {
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwMobileMessages>>>;
+};
+/**
+ * Type alias for mobile phone validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwMobileSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwMobileSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan mobile phone number format
+ *
+ * @param {string} value - The mobile phone number to validate
+ * @returns {boolean} True if the mobile number is valid
+ *
+ * @description
+ * Validates Taiwan mobile phone numbers according to the official numbering plan.
+ * Taiwan mobile numbers use the format: 09X-XXXX-XXXX (10 digits total).
+ *
+ * Valid prefixes: 090, 091, 092, 093, 094, 095, 096, 097, 098, 099
+ * - All major Taiwan mobile operators are covered
+ * - Format: 09[0-9] followed by 7 additional digits
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanMobile("0912345678") // true
+ * validateTaiwanMobile("0987654321") // true
+ * validateTaiwanMobile("0812345678") // false (invalid prefix)
+ * validateTaiwanMobile("091234567") // false (too short)
+ * ```
+ */
+declare const validateTaiwanMobile: (value: string) => boolean;
+/**
+ * Creates a Zod schema for Taiwan mobile phone 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 {TwMobileSchema<IsRequired>} Zod schema for mobile phone validation
+ *
+ * @description
+ * Creates a comprehensive Taiwan mobile phone number validator with support for
+ * all Taiwan mobile network operators and optional whitelist functionality.
+ *
+ * Features:
+ * - Taiwan mobile number format validation (09X-XXXX-XXXX)
+ * - Support for all Taiwan mobile operators (090-099 prefixes)
+ * - Whitelist functionality for specific allowed numbers
+ * - Automatic trimming and preprocessing
+ * - Custom transformation functions
+ * - Comprehensive internationalization
+ * - Optional field support
+ *
+ * @example
+ * ```typescript
+ * // Basic mobile number validation
+ * const basicSchema = twMobile() // optional by default
+ * basicSchema.parse("0912345678") // ✓ Valid
+ * basicSchema.parse(null) // ✓ Valid (optional)
+ *
+ * // Required validation
+ * const requiredSchema = parse("0912345678") // ✓ Valid
+(true)
+ * requiredSchema.parse(null) // ✗ Invalid (required)
+ *
+ * basicSchema.parse("0987654321") // ✓ Valid
+ * basicSchema.parse("0812345678") // ✗ Invalid (wrong prefix)
+ *
+ * // With whitelist (only specific numbers allowed)
+ * 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 = twMobile(false)
+ * optionalSchema.parse("") // ✓ Valid (returns null)
+ * optionalSchema.parse("0912345678") // ✓ Valid
+ *
+ * // With custom transformation
+ * 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 = twMobile(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan mobile number" },
+ *     'zh-TW': { invalid: "請輸入有效的台灣手機號碼" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwMobileOptions} for all available configuration options
+ * @see {@link validateTaiwanMobile} for validation logic details
+ */
+declare function twMobile<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwMobileOptions<IsRequired>, 'required'>): TwMobileSchema<IsRequired>;
+
+export { type TwMobileMessages, type TwMobileOptions, type TwMobileSchema, twMobile, validateTaiwanMobile };

package/dist/taiwan/mobile.d.ts

@@ -0,0 +1,146 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.js';
+
+/**
+ * @fileoverview Taiwan Mobile Phone Number validator for Zod Kit
+ *
+ * Provides validation for Taiwan mobile phone numbers with support for
+ * all Taiwan mobile network operators and whitelist functionality.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for mobile phone validation error messages
+ *
+ * @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 TwMobileMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+/**
+ * Configuration options for Taiwan mobile phone validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwMobileMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwMobileOptions<IsRequired extends boolean = true> = {
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwMobileMessages>>>;
+};
+/**
+ * Type alias for mobile phone validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwMobileSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwMobileSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan mobile phone number format
+ *
+ * @param {string} value - The mobile phone number to validate
+ * @returns {boolean} True if the mobile number is valid
+ *
+ * @description
+ * Validates Taiwan mobile phone numbers according to the official numbering plan.
+ * Taiwan mobile numbers use the format: 09X-XXXX-XXXX (10 digits total).
+ *
+ * Valid prefixes: 090, 091, 092, 093, 094, 095, 096, 097, 098, 099
+ * - All major Taiwan mobile operators are covered
+ * - Format: 09[0-9] followed by 7 additional digits
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanMobile("0912345678") // true
+ * validateTaiwanMobile("0987654321") // true
+ * validateTaiwanMobile("0812345678") // false (invalid prefix)
+ * validateTaiwanMobile("091234567") // false (too short)
+ * ```
+ */
+declare const validateTaiwanMobile: (value: string) => boolean;
+/**
+ * Creates a Zod schema for Taiwan mobile phone 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 {TwMobileSchema<IsRequired>} Zod schema for mobile phone validation
+ *
+ * @description
+ * Creates a comprehensive Taiwan mobile phone number validator with support for
+ * all Taiwan mobile network operators and optional whitelist functionality.
+ *
+ * Features:
+ * - Taiwan mobile number format validation (09X-XXXX-XXXX)
+ * - Support for all Taiwan mobile operators (090-099 prefixes)
+ * - Whitelist functionality for specific allowed numbers
+ * - Automatic trimming and preprocessing
+ * - Custom transformation functions
+ * - Comprehensive internationalization
+ * - Optional field support
+ *
+ * @example
+ * ```typescript
+ * // Basic mobile number validation
+ * const basicSchema = twMobile() // optional by default
+ * basicSchema.parse("0912345678") // ✓ Valid
+ * basicSchema.parse(null) // ✓ Valid (optional)
+ *
+ * // Required validation
+ * const requiredSchema = parse("0912345678") // ✓ Valid
+(true)
+ * requiredSchema.parse(null) // ✗ Invalid (required)
+ *
+ * basicSchema.parse("0987654321") // ✓ Valid
+ * basicSchema.parse("0812345678") // ✗ Invalid (wrong prefix)
+ *
+ * // With whitelist (only specific numbers allowed)
+ * 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 = twMobile(false)
+ * optionalSchema.parse("") // ✓ Valid (returns null)
+ * optionalSchema.parse("0912345678") // ✓ Valid
+ *
+ * // With custom transformation
+ * 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 = twMobile(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan mobile number" },
+ *     'zh-TW': { invalid: "請輸入有效的台灣手機號碼" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwMobileOptions} for all available configuration options
+ * @see {@link validateTaiwanMobile} for validation logic details
+ */
+declare function twMobile<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwMobileOptions<IsRequired>, 'required'>): TwMobileSchema<IsRequired>;
+
+export { type TwMobileMessages, type TwMobileOptions, type TwMobileSchema, twMobile, validateTaiwanMobile };

package/dist/taiwan/mobile.js

@@ -0,0 +1,9 @@
+import {
+  twMobile,
+  validateTaiwanMobile
+} from "../chunk-JXY7APBU.js";
+import "../chunk-6AAP4LPF.js";
+export {
+  twMobile,
+  validateTaiwanMobile
+};

package/dist/taiwan/national-id.cjs

@@ -0,0 +1,15 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+var _chunkZTFCJCPOcjs = require('../chunk-ZTFCJCPO.cjs');
+require('../chunk-UCOXAZJF.cjs');
+
+
+
+
+
+
+exports.twNationalId = _chunkZTFCJCPOcjs.twNationalId; exports.validateCitizenId = _chunkZTFCJCPOcjs.validateCitizenId; exports.validateNewResidentId = _chunkZTFCJCPOcjs.validateNewResidentId; exports.validateOldResidentId = _chunkZTFCJCPOcjs.validateOldResidentId; exports.validateTaiwanNationalId = _chunkZTFCJCPOcjs.validateTaiwanNationalId;

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

@@ -0,0 +1,214 @@
+import { ZodString, ZodNullable } from 'zod';
+import { L as Locale } from '../config-CABSSvAp.cjs';
+
+/**
+ * @fileoverview Taiwan National ID (身分證/居留證) validator for Zod Kit
+ *
+ * Provides validation for Taiwan National ID cards (身分證) and
+ * Resident Certificates (居留證) with support for both old and new formats.
+ *
+ * @author Ong Hoe Yuan
+ * @version 0.0.5
+ */
+
+/**
+ * Type definition for national ID validation error messages
+ *
+ * @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 TwNationalIdMessages = {
+    required?: string;
+    invalid?: string;
+};
+/**
+ * Types of Taiwan national identification documents
+ *
+ * @typedef {"citizen" | "resident" | "both"} NationalIdType
+ *
+ * Available types:
+ * - citizen: National ID card (身分證字號) for Taiwan citizens
+ * - resident: Resident certificate (居留證號) for foreign residents
+ * - both: Accept both citizen and resident IDs
+ */
+type NationalIdType = "citizen" | "resident" | "both";
+/**
+ * Configuration options for Taiwan national ID validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ *
+ * @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, TwNationalIdMessages>} [i18n] - Custom error messages for different locales
+ */
+type TwNationalIdOptions<IsRequired extends boolean = true> = {
+    type?: NationalIdType;
+    allowOldResident?: boolean;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Partial<Record<Locale, Partial<TwNationalIdMessages>>>;
+};
+/**
+ * Type alias for national ID validation schema based on required flag
+ *
+ * @template IsRequired - Whether the field is required
+ * @typedef TwNationalIdSchema
+ * @description Returns ZodString if required, ZodNullable<ZodString> if optional
+ */
+type TwNationalIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+/**
+ * Validates Taiwan citizen national ID card (身分證字號)
+ *
+ * @param {string} value - The citizen ID to validate
+ * @returns {boolean} True if the citizen ID is valid
+ *
+ * @description
+ * Validates Taiwan citizen ID format: 1 letter + 1 gender digit (1-2) + 8 digits
+ * Uses checksum algorithm with city code conversion and weighted sum.
+ *
+ * Format: [A-Z][1-2]XXXXXXXX
+ * - First letter: City/county code
+ * - Second digit: Gender (1=male, 2=female)
+ * - Last 8 digits: Serial number + checksum
+ *
+ * @example
+ * ```typescript
+ * validateCitizenId("A123456789") // true/false based on checksum
+ * validateCitizenId("A323456789") // false (invalid gender digit)
+ * ```
+ */
+declare const validateCitizenId: (value: string) => boolean;
+/**
+ * Validates old-style Taiwan resident certificate (舊式居留證號)
+ *
+ * @param {string} value - The old-style resident ID to validate
+ * @returns {boolean} True if the old-style resident ID is valid
+ *
+ * @description
+ * Validates old-style resident ID format: 1 letter + 1 gender letter + 8 digits
+ * Uses checksum algorithm with city code and gender code conversion.
+ *
+ * Format: [A-Z][ABCD]XXXXXXXX
+ * - First letter: City/county code
+ * - Second letter: Gender code (A/C=male, B/D=female)
+ * - Last 8 digits: Serial number + checksum
+ *
+ * @example
+ * ```typescript
+ * validateOldResidentId("AA12345678") // true/false based on checksum
+ * validateOldResidentId("AE12345678") // false (invalid gender letter)
+ * ```
+ */
+declare const validateOldResidentId: (value: string) => boolean;
+/**
+ * Validates new-style Taiwan resident certificate (新式居留證號)
+ *
+ * @param {string} value - The new-style resident ID to validate
+ * @returns {boolean} True if the new-style resident ID is valid
+ *
+ * @description
+ * Validates new-style resident ID format: 1 letter + 1 type digit + 8 digits
+ * Uses the same checksum algorithm as citizen IDs.
+ *
+ * Format: [A-Z][89]XXXXXXXX
+ * - First letter: City/county code
+ * - Second digit: Type indicator (8 or 9)
+ * - Last 8 digits: Serial number + checksum
+ *
+ * @example
+ * ```typescript
+ * validateNewResidentId("A812345678") // true/false based on checksum
+ * validateNewResidentId("A712345678") // false (invalid type digit)
+ * ```
+ */
+declare const validateNewResidentId: (value: string) => boolean;
+/**
+ * Main validation function for Taiwan national IDs
+ *
+ * @param {string} value - The national ID to validate
+ * @param {NationalIdType} [type="both"] - Type of ID to accept
+ * @param {boolean} [allowOldResident=true] - Whether to accept old-style resident certificates
+ * @returns {boolean} True if the national ID is valid
+ *
+ * @description
+ * Validates Taiwan national IDs based on the specified type and options.
+ * Supports citizen IDs, resident certificates (both old and new styles).
+ *
+ * @example
+ * ```typescript
+ * validateTaiwanNationalId("A123456789", "citizen") // Citizen ID only
+ * validateTaiwanNationalId("A812345678", "resident") // Resident ID only
+ * validateTaiwanNationalId("A123456789", "both") // Accept any valid format
+ * validateTaiwanNationalId("AA12345678", "both", false) // Reject old resident format
+ * ```
+ */
+declare const validateTaiwanNationalId: (value: string, type?: NationalIdType, allowOldResident?: boolean) => boolean;
+/**
+ * Creates a Zod schema for Taiwan National ID validation
+ *
+ * @template IsRequired - Whether the field is required (affects return type)
+ * @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
+ * citizen IDs and resident certificates with configurable validation rules.
+ *
+ * Features:
+ * - Citizen ID validation (身分證字號)
+ * - Resident certificate validation (居留證號, old and new formats)
+ * - Configurable ID type acceptance
+ * - Automatic case conversion to uppercase
+ * - Checksum verification
+ * - Custom transformation functions
+ * - Comprehensive internationalization
+ * - Optional field support
+ *
+ * @example
+ * ```typescript
+ * // Accept any valid Taiwan ID
+ * 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 = twNationalId(false, { type: "citizen" })
+ * citizenSchema.parse("A123456789") // ✓ Valid
+ * citizenSchema.parse("A812345678") // ✗ Invalid (resident ID)
+ *
+ * // Resident IDs only (new format only)
+ * const residentSchema = twNationalId(false, {
+ *   type: "resident",
+ *   allowOldResident: false
+ * })
+ * residentSchema.parse("A812345678") // ✓ Valid
+ * residentSchema.parse("AA12345678") // ✗ Invalid (old format)
+ *
+ * // Optional with custom transformation
+ * const optionalSchema = twNationalId(false, {
+ *   transform: (value) => value.replace(/[^A-Z0-9]/g, '') // Remove special chars
+ * })
+ *
+ * // With custom error messages
+ * const customSchema = twNationalId(false, {
+ *   i18n: {
+ *     en: { invalid: "Please enter a valid Taiwan National ID" },
+ *     'zh-TW': { invalid: "請輸入有效的身分證或居留證號碼" }
+ *   }
+ * })
+ * ```
+ *
+ * @throws {z.ZodError} When validation fails with specific error messages
+ * @see {@link TwNationalIdOptions} for all available configuration options
+ * @see {@link NationalIdType} for supported ID types
+ * @see {@link validateTaiwanNationalId} for validation logic details
+ */
+declare function twNationalId<IsRequired extends boolean = false>(required?: IsRequired, options?: Omit<TwNationalIdOptions<IsRequired>, 'required'>): TwNationalIdSchema<IsRequired>;
+
+export { type NationalIdType, type TwNationalIdMessages, type TwNationalIdOptions, type TwNationalIdSchema, twNationalId, validateCitizenId, validateNewResidentId, validateOldResidentId, validateTaiwanNationalId };