const $st = {
	invalid: boolean // true if any form field is invalid
	submitted: boolean // true once `$fn.submit` has been called
	initial: Readonly≺Form≻ // the original form passed to `svelidate()` 
}

const $fn = {
	submit: (e?: SubmitEvent) =>  void // handles submit and then calls `$on.submit`
	reset: () =>  void // resets all the form fields to their initial values
	untouch: () =>  void // resets all the form fields `touched` values to false
	getErrors: () => string[] // returns all the current errors
}

const $on = {
	submit: (e?: SubmitEvent) =>  void // called after submitting with `$fn.submit`
	touch: (key: string) => void // called when an input is touched
}

const general = {
	truthy, // value is truthy (can be used to validate booleans/checkboxes).
	falsy, // value is falsy (can be used to validate booleans/checkboxes).
	required, // value is truthy or strictly equal to 0.
	eq(value: any), // value is strictly equal to argument.
	neq(value: any), // value is strictly different from argument.
}

// value must be a string
const string = {
	email, // value is an e-mail.
	upperCase, // value has atleast one upper case letter.
	lowerCase, // value has atleast one lower case letter.
	number, // value has atleast one number.
	symbol(symbols: string[]), // value has atleast one symbol ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~), a custom symbol array can be given.
	regex(regex: RegExp), // value matches the given regex.
	eq(string: string), // value is equal to the given string.
	neq(string: string), // value is different from the given string.,
	length: {
		gt(length: number), // value length is longer than the given length.
		gte(length: number), // value length is longer than or equal to the given length.
		lt(length: number), // value length is shorter than the given length.
		lte(length: number), // value length is shorter than or equal to the given length.
		inside(min: number, max: number), // value length is included in the given range.
		outside(min: number, max: number), // value length is excluded from the given range.
		neq(length: number), // value length is different from the given one.
		eq(length: number), // value length is equal to the given one.
	},
}

// value must be a number
const number = {
	gt(number: number), // value is greater than the given number.
	gte(number: number), // value is greater than or equal to the given number.
	lt(number: number), // value is lesser than the given number.
	lte(number: number), // value is lesser than or equal to the given number.
	inside(min: number, max: number), // value is in included in the given interval.
	outside(min: number, max: number), // value is in excluded from the given interval.
	neq(number: number), // value is different from the given number.
	eq(number: number), // value is equal to the given number.
}

// value must be a string or a date, if it's a string it will be parsed using the `Date` constructor.
const date = {
	gt(date: Date), // value is after the given date.
	gte(date: Date), // value is after the or is the given date.
	lt(date: Date),  // value is before the given date.
	lte(date: Date), // value is before the or is the given date.
	inside(min: Date, max: Date), // value is between the given date range.
	outside(min: Date, max: Date), // value is outside the given date range.
	neq(date: Date), // value is not the given date.
	eq(date: Date), // value is the given date.
}