@nhtio/validation 0.1.0-master-952eca46 → 0.1.0-master-b4207fd6

package/private/schemas/phone.d.ts

@@ -1,199 +0,0 @@
-import type { AnySchema } from '../../index';
-import type { CountryOrUnknown, PhoneTypes } from '@nhtio/phone-object';
-import type { ExtensionFactory, Reference } from 'joi';
-/**
- * Phone number validation schema interface extending AnySchema.
- * Provides methods for validating and formatting phone numbers with various constraints.
- *
- * @template TSchema - The schema type, defaults to string
- *
- * @example
- * ```typescript
- * import Joi from 'joi'
- * import { phone } from './phone'
- *
- * const extended = Joi.extend(phone)
- * const schema = extended.phone().country('US').mobile()
- *
- * const result = schema.validate('+1234567890')
- * ```
- */
-export interface PhoneSchema<TSchema = string> extends Omit<AnySchema<TSchema>, 'cast'> {
-    /**
-     * Sets the country context for phone number validation.
-     *
-     * @param country - Country code (ISO 3166-1 alpha-2), country name, Joi reference, or null
-     * @returns The schema instance for chaining
-     *
-     * @example
-     * ```typescript
-     * schema.country('US')
-     * schema.country('United States')
-     * schema.country(Joi.ref('countryField'))
-     * ```
-     */
-    country(country: CountryOrUnknown | Reference | null): this;
-    /**
-     * Sets the output format for the phone number.
-     *
-     * @param as - The desired output format
-     * @returns The schema instance for chaining
-     *
-     * @example
-     * ```typescript
-     * schema.format('international') // +1 234 567 8900
-     * schema.format('national')      // (234) 567-8900
-     * schema.format('e164')          // +12345678900
-     * ```
-     */
-    format(as: 'e164' | 'international' | 'national' | 'raw' | 'timezone' | 'type' | 'country'): this;
-    /**
-     * Validates that the phone number is a fixed line or fixed line/mobile number.
-     *
-     * @returns The schema instance for chaining
-     */
-    fixedLine(): this;
-    /**
-     * Validates that the phone number is a mobile or fixed line/mobile number.
-     *
-     * @returns The schema instance for chaining
-     */
-    mobile(): this;
-    /**
-     * Validates that the phone number is strictly a fixed line number only.
-     *
-     * @returns The schema instance for chaining
-     */
-    strictFixedLine(): this;
-    /**
-     * Validates that the phone number is strictly a mobile number only.
-     *
-     * @returns The schema instance for chaining
-     */
-    strictMobile(): this;
-    /**
-     * Validates that the phone number is either a fixed line or mobile number.
-     *
-     * @returns The schema instance for chaining
-     */
-    fixedLineOrMobile(): this;
-    /**
-     * Validates that the phone number is a toll-free number.
-     *
-     * @returns The schema instance for chaining
-     */
-    tollFree(): this;
-    /**
-     * Validates that the phone number is a premium rate number.
-     *
-     * @returns The schema instance for chaining
-     */
-    premiumRate(): this;
-    /**
-     * Validates that the phone number is a shared cost number.
-     *
-     * @returns The schema instance for chaining
-     */
-    sharedCost(): this;
-    /**
-     * Validates that the phone number is a VoIP number.
-     *
-     * @returns The schema instance for chaining
-     */
-    voip(): this;
-    /**
-     * Validates that the phone number is a personal number.
-     *
-     * @returns The schema instance for chaining
-     */
-    personalNumber(): this;
-    /**
-     * Validates that the phone number is a pager number.
-     *
-     * @returns The schema instance for chaining
-     */
-    pager(): this;
-    /**
-     * Validates that the phone number is a UAN (Universal Access Number).
-     *
-     * @returns The schema instance for chaining
-     */
-    uan(): this;
-    /**
-     * Validates that the phone number is a voicemail number.
-     *
-     * @returns The schema instance for chaining
-     */
-    voicemail(): this;
-    /**
-     * Validates that the phone number is of unknown type.
-     *
-     * @returns The schema instance for chaining
-     */
-    unknown(): this;
-    /**
-     * Validates that the phone number matches one of the specified types.
-     *
-     * @param types - Array of phone types to allow
-     * @returns The schema instance for chaining
-     *
-     * @example
-     * ```typescript
-     * schema.types('MOBILE', 'FIXED_LINE')
-     * ```
-     */
-    types(...types: PhoneTypes[]): this;
-    cast(to: 'number' | 'string' | 'object'): this;
-}
-export declare const messages: {
-    'phone.base': string;
-    'phone.invalid': string;
-    'phone.fixedLine': string;
-    'phone.mobile': string;
-    'phone.strictFixedLine': string;
-    'phone.strictMobile': string;
-    'phone.fixedLineOrMobile': string;
-    'phone.tollFree': string;
-    'phone.premiumRate': string;
-    'phone.sharedCost': string;
-    'phone.voip': string;
-    'phone.personalNumber': string;
-    'phone.pager': string;
-    'phone.uan': string;
-    'phone.voicemail': string;
-    'phone.unknown': string;
-    'phone.types': string;
-};
-/**
- * Joi extension factory for phone number validation.
- * Creates a custom Joi schema type that validates phone numbers using the @nhtio/phone-object library.
- *
- * @param joi - The Joi instance to extend
- * @returns The phone schema extension definition
- *
- * @example
- * ```typescript
- * import Joi from 'joi'
- * import { phone } from './phone'
- *
- * const extended = Joi.extend(phone)
- *
- * // Basic phone validation
- * const schema = extended.phone()
- * schema.validate('+1234567890') // validates any phone number
- *
- * // Country-specific validation
- * const usSchema = extended.phone().country('US')
- * usSchema.validate('(555) 123-4567')
- *
- * // Type-specific validation
- * const mobileSchema = extended.phone().mobile()
- * mobileSchema.validate('+1234567890')
- *
- * // Format output
- * const formattedSchema = extended.phone().format('international')
- * const result = formattedSchema.validate('+1234567890')
- * // result.value would be "+1 234 567 8900"
- * ```
- */
-export declare const phone: ExtensionFactory;