@jdsalasc/solvejs-validators 1.0.3 → 1.2.0

package/dist/esm/index.d.ts

@@ -1,67 +1,228 @@
+export type ValidationResultCode = "VALID" | "EMPTY" | "INVALID_FORMAT" | "TOO_SHORT" | "TOO_LONG" | "INVALID_CHARACTERS" | "UNSUPPORTED_LOCALE" | "UNSUPPORTED_COUNTRY" | "CHECKSUM_FAILED";
+export type ValidationResult = {
+    ok: boolean;
+    code: ValidationResultCode;
+    message: string;
+};
+export type SupportedCountry = "ANY" | "US" | "CO" | "MX" | "ES";
+export type DirectionLocale = "en" | "es";
 /**
- * Checks whether a string is a valid international or local cellphone number.
+ * Validates cellphone numbers using regional presets.
  *
  * @param value - Input phone string.
  * @param options - Validation options.
  * @param options.allowInternational - Allows a leading `+`.
- * @param options.minDigits - Minimum number of digits.
- * @param options.maxDigits - Maximum number of digits.
- * @returns `true` when the input matches configured constraints.
+ * @param options.country - Country preset used for length constraints.
+ * @param options.minDigits - Override minimum digits.
+ * @param options.maxDigits - Override maximum digits.
+ * @returns Structured validation result.
+ */
+export declare function validateCellphoneNumber(value: string, options?: {
+    allowInternational?: boolean;
+    country?: SupportedCountry;
+    minDigits?: number;
+    maxDigits?: number;
+}): ValidationResult;
+/**
+ * Boolean wrapper for `validateCellphoneNumber`.
+ *
+ * @param value - Input phone string.
+ * @param options - Validation options.
+ * @returns `true` when the value is valid.
  */
 export declare function isCellphoneNumber(value: string, options?: {
     allowInternational?: boolean;
+    country?: SupportedCountry;
     minDigits?: number;
     maxDigits?: number;
 }): boolean;
 /**
- * Validates common cardinal and intercardinal address directions.
+ * Validates address direction using localized dictionaries.
+ *
+ * @param value - Direction text.
+ * @param options - Validation options.
+ * @param options.locale - Locale dictionary (`en`, `es`).
+ * @returns Structured validation result.
+ */
+export declare function validateAddressDirection(value: string, options?: {
+    locale?: DirectionLocale;
+}): ValidationResult;
+/**
+ * Boolean wrapper for `validateAddressDirection`.
+ *
+ * @param value - Direction text.
+ * @param options - Validation options.
+ * @returns `true` when the value is valid.
+ */
+export declare function isAddressDirection(value: string, options?: {
+    locale?: DirectionLocale;
+}): boolean;
+/**
+ * Backward-compatible alias for users who typed the previous function with one missing `d`.
+ *
+ * @param value - Direction text.
+ * @param options - Validation options.
+ * @returns `true` when the direction is valid.
+ */
+export declare function isAddresDirection(value: string, options?: {
+    locale?: DirectionLocale;
+}): boolean;
+/**
+ * Backward-compatible alias for users who typed the previous function with two spelling mistakes.
  *
  * @param value - Direction text.
- * @returns `true` when the input matches known direction tokens.
+ * @param options - Validation options.
+ * @returns `true` when the direction is valid.
  */
-export declare function isAddressDirection(value: string): boolean;
+export declare function isAddresDirrection(value: string, options?: {
+    locale?: DirectionLocale;
+}): boolean;
 /**
- * Validates names using practical rules for most user forms.
+ * Validates person names with practical production constraints.
  *
  * @param value - Name string.
  * @param options - Validation options.
  * @param options.minLength - Minimum total length.
  * @param options.maxLength - Maximum total length.
- * @returns `true` when the name is considered valid.
+ * @returns Structured validation result.
+ */
+export declare function validateName(value: string, options?: {
+    minLength?: number;
+    maxLength?: number;
+}): ValidationResult;
+/**
+ * Boolean wrapper for `validateName`.
+ *
+ * @param value - Name string.
+ * @param options - Validation options.
+ * @returns `true` when the value is valid.
  */
 export declare function isValidName(value: string, options?: {
     minLength?: number;
     maxLength?: number;
 }): boolean;
 /**
- * Validates an email using practical constraints for application forms.
+ * Validates usernames used in sign-up forms.
+ *
+ * @param value - Username candidate.
+ * @param options - Validation options.
+ * @param options.minLength - Minimum length.
+ * @param options.maxLength - Maximum length.
+ * @returns Structured validation result.
+ */
+export declare function validateUsername(value: string, options?: {
+    minLength?: number;
+    maxLength?: number;
+}): ValidationResult;
+/**
+ * Boolean wrapper for `validateUsername`.
+ *
+ * @param value - Username candidate.
+ * @param options - Validation options.
+ * @returns `true` when the username is valid.
+ */
+export declare function isUsername(value: string, options?: {
+    minLength?: number;
+    maxLength?: number;
+}): boolean;
+/**
+ * Validates an email shape.
  *
  * @param value - Email string.
- * @returns `true` when email shape is valid.
+ * @returns Structured validation result.
+ */
+export declare function validateEmail(value: string): ValidationResult;
+/**
+ * Boolean wrapper for `validateEmail`.
+ *
+ * @param value - Email string.
+ * @returns `true` when the value is valid.
  */
 export declare function isEmail(value: string): boolean;
 /**
  * Validates an HTTP(S) URL.
  *
  * @param value - URL string.
- * @returns `true` when URL is valid and protocol is HTTP or HTTPS.
+ * @returns Structured validation result.
+ */
+export declare function validateHttpUrl(value: string): ValidationResult;
+/**
+ * Boolean wrapper for `validateHttpUrl`.
+ *
+ * @param value - URL string.
+ * @returns `true` when the value is valid.
  */
 export declare function isHttpUrl(value: string): boolean;
 /**
  * Validates US-style postal codes (`12345` or `12345-6789`).
  *
  * @param value - Postal code string.
- * @returns `true` when value matches supported postal formats.
+ * @returns Structured validation result.
+ */
+export declare function validatePostalCode(value: string): ValidationResult;
+/**
+ * Boolean wrapper for `validatePostalCode`.
+ *
+ * @param value - Postal code string.
+ * @returns `true` when the value is valid.
  */
 export declare function isPostalCode(value: string): boolean;
 /**
- * Validates password strength with common security requirements.
+ * Validates address line input for common delivery/billing forms.
+ *
+ * @param value - Address line string.
+ * @param options - Validation options.
+ * @param options.minLength - Minimum length.
+ * @param options.maxLength - Maximum length.
+ * @returns Structured validation result.
+ */
+export declare function validateAddressLine(value: string, options?: {
+    minLength?: number;
+    maxLength?: number;
+}): ValidationResult;
+/**
+ * Boolean wrapper for `validateAddressLine`.
+ *
+ * @param value - Address line string.
+ * @param options - Validation options.
+ * @returns `true` when the address line is valid.
+ */
+export declare function isAddressLine(value: string, options?: {
+    minLength?: number;
+    maxLength?: number;
+}): boolean;
+/**
+ * Validates password strength using default security checks.
  *
  * @param value - Password candidate.
  * @param options - Validation options.
  * @param options.minLength - Minimum required length.
- * @returns `true` when password meets complexity requirements.
+ * @returns Structured validation result.
+ */
+export declare function validateStrongPassword(value: string, options?: {
+    minLength?: number;
+}): ValidationResult;
+/**
+ * Boolean wrapper for `validateStrongPassword`.
+ *
+ * @param value - Password candidate.
+ * @param options - Validation options.
+ * @returns `true` when the value is valid.
  */
 export declare function isStrongPassword(value: string, options?: {
     minLength?: number;
 }): boolean;
+/**
+ * Validates card numbers using basic shape checks plus Luhn checksum.
+ *
+ * @param value - Card number candidate.
+ * @returns Structured validation result.
+ */
+export declare function validateCreditCardNumber(value: string): ValidationResult;
+/**
+ * Boolean wrapper for `validateCreditCardNumber`.
+ *
+ * @param value - Card number candidate.
+ * @returns `true` when the card number is valid.
+ */
+export declare function isCreditCardNumber(value: string): boolean;