feat: implement interfaces

Author: glennmichael123

src/types.ts

@@ -1,4 +1,7 @@
 import type { alphanumeric } from './lib/isAlphanumeric'
+import type isDecimal from './lib/isDecimal'
+import type isEmail from './lib/isEmail'
+import type isURL from './lib/isURL'
 import type { ArrayValidator } from './validators/arrays'
 import type { BooleanValidator } from './validators/booleans'
 import type { CustomValidator } from './validators/custom'
@@ -253,6 +256,86 @@ export interface ValidationConfig {
   errorMessages?: Record<string, string>
 }
 
+export interface LengthValidator<T> {
+  min: (length: number) => T
+  max: (length: number) => T
+  length: (length: number) => T
+}
+
+export interface StringValidatorType extends Validator<string>, LengthValidator<StringValidator> {
+  email: (options?: Parameters<typeof isEmail>[1]) => StringValidator
+  url: (options?: Parameters<typeof isURL>[1]) => StringValidator
+  matches: (pattern: RegExp) => StringValidator
+  equals: (param: string) => StringValidator
+  alphanumeric: () => StringValidator
+  alpha: () => StringValidator
+  numeric: () => StringValidator
+  custom: (fn: (value: string) => boolean, message: string) => StringValidator
+}
+
+export interface NumberValidatorType extends Validator<number> {
+  min: (min: number) => NumberValidator
+  max: (max: number) => NumberValidator
+  integer: (options?: IsIntOptions) => NumberValidator
+  float: (options?: IsFloatOptions) => NumberValidator
+  decimal: (options?: Parameters<typeof isDecimal>[1]) => NumberValidator
+  positive: () => NumberValidator
+  negative: () => NumberValidator
+  divisibleBy: (divisor: number) => NumberValidator
+  custom: (fn: (value: number) => boolean, message: string) => NumberValidator
+}
+
+export interface ArrayValidatorType<T> extends Validator<T[]>, LengthValidator<ArrayValidator<T>> {
+  each: (validator: Validator<T>) => ArrayValidator<T>
+  unique: () => ArrayValidator<T>
+}
+
+export interface BooleanValidatorType extends Validator<boolean> {
+  isTrue: () => BooleanValidator
+  isFalse: () => BooleanValidator
+  custom: (fn: (value: boolean) => boolean, message: string) => BooleanValidator
+}
+
+export interface EnumValidatorType<T extends string | number> extends Validator<T> {
+  custom: (fn: (value: T) => boolean, message: string) => EnumValidator<T>
+}
+
+export interface DateValidatorType extends Validator<Date> {
+  // Base date validator is simple, just implements the base Validator interface
+}
+
+export interface DatetimeValidatorType extends Validator<Date> {
+  // Datetime validator is simple, just implements the base Validator interface
+}
+
+export interface ObjectValidatorType<T extends Record<string, any>> extends Validator<T> {
+  shape: (schema: Record<string, Validator<any>>) => ObjectValidator<T>
+  strict: (strict?: boolean) => ObjectValidator<T>
+}
+
+export interface CustomValidatorType<T> extends Validator<T> {
+  // Custom validator is simple, just implements the base Validator interface
+}
+
+export interface TimestampValidatorType extends Validator<number | string> {
+  // Timestamp validator is simple, just implements the base Validator interface
+}
+
+export interface UnixValidatorType extends Validator<number | string> {
+  // Unix validator is simple, just implements the base Validator interface
+}
+
+export interface PasswordValidatorType extends Validator<string> {
+  matches: (confirmPassword: string) => PasswordValidator
+  min: (length?: number) => PasswordValidator
+  max: (length?: number) => PasswordValidator
+  hasUppercase: () => PasswordValidator
+  hasLowercase: () => PasswordValidator
+  hasNumbers: () => PasswordValidator
+  hasSpecialCharacters: () => PasswordValidator
+  alphanumeric: () => PasswordValidator
+}
+
 export interface ValidationInstance {
   string: () => StringValidator
   number: () => NumberValidator

src/validators/arrays.ts

@@ -1,7 +1,7 @@
-import type { Validator } from '../types'
+import type { ArrayValidatorType, Validator } from '../types'
 import { BaseValidator } from './base'
 
-export class ArrayValidator<T> extends BaseValidator<T[]> {
+export class ArrayValidator<T> extends BaseValidator<T[]> implements ArrayValidatorType<T> {
   constructor() {
     super()
     this.addRule({

src/validators/booleans.ts

@@ -1,6 +1,7 @@
+import type { BooleanValidatorType } from '../types'
 import { BaseValidator } from './base'
 
-export class BooleanValidator extends BaseValidator<boolean> {
+export class BooleanValidator extends BaseValidator<boolean> implements BooleanValidatorType {
   constructor() {
     super()
     this.addRule({

src/validators/custom.ts

@@ -1,6 +1,7 @@
+import type { CustomValidatorType } from '../types'
 import { BaseValidator } from './base'
 
-export class CustomValidator<T> extends BaseValidator<T> {
+export class CustomValidator<T> extends BaseValidator<T> implements CustomValidatorType<T> {
   constructor(validationFn: (value: T) => boolean, message: string) {
     super()
     this.addRule({

src/validators/dates.ts

@@ -1,6 +1,7 @@
+import type { DateValidatorType } from '../types'
 import { BaseValidator } from './base'
 
-export class DateValidator extends BaseValidator<Date> {
+export class DateValidator extends BaseValidator<Date> implements DateValidatorType {
   constructor() {
     super()
     this.addRule({

src/validators/datetimes.ts

@@ -1,6 +1,7 @@
+import type { DatetimeValidatorType } from '../types'
 import { BaseValidator } from './base'
 
-export class DatetimeValidator extends BaseValidator<Date> {
+export class DatetimeValidator extends BaseValidator<Date> implements DatetimeValidatorType {
   constructor() {
     super()
     this.addRule({

src/validators/enums.ts

@@ -1,6 +1,7 @@
+import type { EnumValidatorType } from '../types'
 import { BaseValidator } from './base'
 
-export class EnumValidator<T extends string | number> extends BaseValidator<T> {
+export class EnumValidator<T extends string | number> extends BaseValidator<T> implements EnumValidatorType<T> {
   private allowedValues: readonly T[]
 
   constructor(allowedValues: readonly T[]) {

src/validators/numbers.ts

@@ -1,11 +1,11 @@
-import type { IsFloatOptions, IsIntOptions } from '../types'
+import type { IsFloatOptions, IsIntOptions, NumberValidatorType } from '../types'
 import isDecimal from '../lib/isDecimal'
 import isDivisibleBy from '../lib/isDivisibleBy'
 import isFloat from '../lib/isFloat'
 import isInt from '../lib/isInt'
 import { BaseValidator } from './base'
 
-export class NumberValidator extends BaseValidator<number> {
+export class NumberValidator extends BaseValidator<number> implements NumberValidatorType {
   constructor() {
     super()
     this.addRule({

src/validators/objects.ts

@@ -1,7 +1,7 @@
-import type { ValidationErrorMap, ValidationResult, Validator } from '../types'
+import type { ObjectValidatorType, ValidationErrorMap, ValidationResult, Validator } from '../types'
 import { BaseValidator } from './base'
 
-export class ObjectValidator<T extends Record<string, any>> extends BaseValidator<T> {
+export class ObjectValidator<T extends Record<string, any>> extends BaseValidator<T> implements ObjectValidatorType<T> {
   private schema: Record<string, Validator<any>> = {}
   private strictMode = false
 

src/validators/password.ts

@@ -1,6 +1,7 @@
+import type { PasswordValidatorType } from '../types'
 import { BaseValidator } from './base'
 
-export class PasswordValidator extends BaseValidator<string> {
+export class PasswordValidator extends BaseValidator<string> implements PasswordValidatorType {
   constructor() {
     super()
     this.addRule({