@apia/validations 0.0.7

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+# Initiator
+
+Este package se creó con la única utilidad de copiarlo entero y pegarlo a la hora de crear un nuevo package.
+
+Este iniciador permite crear un paquete que compila typescript y puede ser importado desde otros packages.
+
+## IMPORTANTE
+
+Los archivos **tsconfig.json** y **tsup.config.ts** no son archivos únicos sino symlinks a archivos de configuración comunes a todos los packages. En caso de que sea necesario modificar alguno de ellos **que en la gran mayoría de los casos no sería necesario**, es necesario eliminar el archivo a modificar y crear uno nuevo.
+
+## Procedimiento
+
+ - Copiar la carpeta initiator y pegarla con otro nombre dentro de packages.
+ - Modificar el package.json:
+   - Eliminar la línea ```private: true```.
+   - Cambiar la ocurrencia `initiator` por el nombre del nuevo paquete. 
+   - Agregar los scripts convenientes: dev, build, etc.
+ - Ejecutar el comando lerna bootstrap desde la carpeta raíz.
+
+Luego de ejecutar estos pasos, el package estaría listo para comenzar a usarse.
+
+Este package trae como dependencias por defecto theme-ui y react. Si se desea agregar más dependencias se debe ejecutar el comando ```lerna add --scope="@apia/packageName" dependencyName```. Ejemplo, si creamos un paquete con el nombre @apia/myPackage y queremos agregar lodash-es como dependencia, ejecutamos el comando ```lerna add --scope="@apia/myPackage" lodash-es```. 
+
+**Importante 1**: Dado que estamos desarrollando packages, es importante determinar si las dependencias que vamos a agregar son de tipo dependency o de tipo peerDependency.
+
+**Importante 2**: lerna no permite instalar de a varias dependencias a la vez como lo hace npm, por lo tanto, si se desea agregar varias dependencias se debe ejecutar el comando anterior tantas veces como dependencias se quiera agregar.
+
+**Importante 3**: React y theme-ui vienen instalados como peerDependencies. En caso de no ser necesarios pueden ser removidos, pero en cualquier caso asegurarse de que estas dependencias no sean instaladas como dependencies puesto que esto causaría comportamientos indeseados en la aplicación.

package/dist/index.d.ts

@@ -0,0 +1,643 @@
+import * as theme_ui_jsx_runtime from 'theme-ui/jsx-runtime';
+import React from 'react';
+import { TModify, TId } from '@apia/util';
+import { BoxProps, ButtonProps, InputProps, LabelProps, RadioProps, SelectProps, SwitchProps, TextareaProps } from 'theme-ui';
+import { TNumberInput } from '@apia/components';
+
+declare const formcheckLanguage: {
+    required: string;
+    alpha: string;
+    alphanum: string;
+    nodigit: string;
+    digit: string;
+    digitmin: string;
+    digitltd: string;
+    number: string;
+    email: string;
+    image: string;
+    phone: string;
+    url: string;
+    confirm: string;
+    differs: string;
+    length_str: string;
+    length_fix: string;
+    lengthmax: string;
+    lengthmin: string;
+    words_min: string;
+    words_max: string;
+    words_range: string;
+    checkbox: string;
+    checkboxes_group: string;
+    radios: string;
+    select: string;
+    select_multiple: string;
+    errorsTitle: string;
+};
+
+declare global {
+    interface Window {
+        [key: string]: string;
+    }
+}
+type TValidate = Partial<TModify<Record<keyof typeof formcheckLanguage, boolean>, {
+    digitmin: number;
+    digitltd: [number, number];
+    confirm: string;
+    differs: string;
+    length_str: [number, number];
+    length_fix: number;
+    words_min: number;
+    words_max: number;
+    words_range: [number, number];
+    checkboxes_group: number;
+}> & {
+    patternMessage: string;
+    pattern: RegExp | string;
+    digitmax: number;
+    validName?: string;
+    maxLength: number;
+    minLength: number;
+    min: number;
+    max: number;
+}>;
+interface IFieldDefinition<ValueType = string> {
+    toolTip: string;
+    label: string;
+    name: string;
+    validate?: TValidate;
+    value: ValueType;
+    options?: {
+        label: string;
+        value: number | number;
+        selected?: boolean;
+    }[];
+}
+type TPromiseOrNot<Type> = Promise<Type> | Type;
+type TSuccessfulValidation<ValueType extends Record<string, unknown>, SubmitValueType extends Record<keyof ValueType, unknown> = ValueType> = {
+    values: ValueType;
+    submitValues: SubmitValueType;
+};
+type TWrongValidation = {
+    errors: Record<string, string>;
+};
+/**
+ * Esta interfaz representa el resultado de la validación
+ * de un formulario.
+ */
+type TValidationResult<ValueType extends Record<string, unknown>, SubmitValueType extends Record<keyof ValueType, unknown> = ValueType> = TSuccessfulValidation<ValueType, SubmitValueType> | TWrongValidation;
+type TFieldValidationResult = true | string;
+type TValidationFunction<ValueType> = (value: ValueType, formName: string) => TPromiseOrNot<TFieldValidationResult>;
+type TValidationSubmitValueParser<ValueType = unknown, SubmitValueType = ValueType> = (value: ValueType) => SubmitValueType;
+type TValidationValueParser<ValueType = unknown, ValidationValueType = unknown> = (value: ValueType) => ValidationValueType;
+/**
+ * Esta interfaz representa el estado de un campo dentro
+ * del hook de validación.
+ *
+ * Las funcionalidades contempladas hasta el momento son:
+ *
+ * - Contener los valores del formulario.
+ * - Foco: Se hará querySelector sobre el form que lo contiene
+ * con el nombre provisto.
+ * - Función de validación o lista de reglas.
+ * - Manejo de errores.
+ * - Parsearlos para hacer submit.
+ */
+type TValidationField<ValueType = any, SubmitValueType = ValueType> = {
+    error?: string | null;
+    isTouched: boolean;
+    /**
+     * El nombre se utilizará para hacer foco en el campo en caso
+     * de que la validación del mismo fallara. Para ello se
+     * intenta recuperar un campo con el selector
+     * [name=${name}, #${name}], en caso de que el selector no
+     * encontrar ningún campo, se intentará hacer foco en el
+     * siguiente campo con error.
+     */
+    name: string;
+    /**
+     * Como dice el nombre, es posible cambiar el nombre de un
+     * campo al hacer submit.
+     */
+    submitName?: string;
+    /**
+     * Es posible recibir un valor ya parseado en el callback
+     * onValidate del Form, para ello se puede proveer este
+     * callback, que será llamado previo a llamar a onValidate.
+     */
+    submitValueParser?: TValidationSubmitValueParser<ValueType, SubmitValueType | undefined>;
+    /**
+     * Es posible pasar una función de validación personalizada
+     * para casos en los que la validación es significativamente
+     * compleja. En la mayoría de los casos debería bastar con
+     * la propiedad validationRules.
+     */
+    validationFunction?: TValidationFunction<ValueType>;
+    /**
+     * Permite pasar una serie de reglas que el campo debe cumplir
+     * al validar.
+     */
+    validationRules?: IFieldDefinition['validate'];
+    validationValueParser?: TValidationValueParser<ValueType>;
+    value: ValueType;
+};
+type TRegisterFormOptions = Partial<{
+    /**
+     * Si esta propiedad está seteada en true, el formulario se registrará y
+     * aquellos campos que ya tuvieran valor en el store no se volverán a
+     * registrar. En caso de que se incluyera initialValue, se hará updateValue de
+     * estos campos.
+     */
+    avoidFieldsOverride: boolean;
+    initialValues: Record<string, unknown>;
+}>;
+type TRegisterFieldOptions = {
+    avoidPropagation?: boolean;
+    registerIfExists?: boolean;
+};
+type TRegisterField = Partial<TValidationField> & Pick<TValidationField, 'name'>;
+type TFormState = {
+    fields: string[];
+    name: string;
+    isTouched: boolean;
+    isValid: boolean;
+    validationResult: TValidationResult<Record<string, unknown>> | null;
+} & Pick<TRegisterFormOptions, 'avoidFieldsOverride'>;
+
+type TOnValidate<ValueType extends Record<string, unknown> = Record<string, unknown>, SubmitValueType extends Record<keyof ValueType, unknown> = ValueType> = (validationResult: TValidationResult<ValueType, SubmitValueType>) => unknown;
+interface IForm<ValueType extends Record<string, unknown>, SubmitValueType extends Record<keyof ValueType, unknown> = ValueType> {
+    /**
+     * Si se pasa en true, los campos que se registren en este form no
+     * sobreescribirán valores previos si es que existen, sin importar el valor de
+     * avoidRegisterIfExists pasado al useField.
+     */
+    avoidFieldsOverride?: boolean;
+    /**
+     * Impide que se apliquen los estilos que indican que un campo fue alterado.
+     */
+    avoidFieldsTouch?: boolean;
+    children: React.ReactNode;
+    className?: string;
+    initialValues?: Partial<ValueType>;
+    name?: string;
+    onUnmount?: () => unknown;
+    /**
+     * Cuando se ejecuta una acción de validación desde
+     * algún lugar de la aplicación se llama a este método
+     * con el resultado de dicha ejecución.
+     */
+    onValidate?: TOnValidate<ValueType, SubmitValueType>;
+    /**
+     * Permite definir si el formulario va a ser borrado de la validación al ser
+     * desmontado
+     */
+    unregisterOnUnmount?: boolean;
+}
+/**
+ * Cuando se desea usar el sistema de validación,
+ * se debe utilizar este componente como form contenedor
+ * de todos los campos que quieran validarse.
+ *
+ * Es importante que no se coloquen formularios dentro
+ * de formularios ya que esto podría afectar negativamente
+ * el proceso de validación.
+ *
+ * @props
+ * *name:* Se puede pasar un nombre para identificar
+ * el form. Este nombre será utilizado para almacenar
+ * la información en Redux, por lo que si se desea
+ * acceder a la información recolectada por la librería,
+ * es conveniente pasar un nombre conocido y único. En
+ * caso de no se pase ningún nombre, la aplicación
+ * generará un nombre único automaticamente.
+ *
+ * *onValidate:* Un callback que será llamado cuando
+ * se invoque el método validateForm del store o cuando
+ * se lance el evento de submit del elemento form (por
+ * ejemplo mediante un click en un botón que no tenga
+ * type="button"), con el resultado de la validación.
+ *
+ * @see useField
+ * @see useForm
+ *
+ * @important Debido a que este hook renderiza un elemento
+ * form en el DOM, es importante agregar el atributo
+ * type="button" a todos los botones dentro del formulario
+ * que no se desea que disparen la validación.
+ *
+ * @example
+ * Para ver un ejemplo funcional, mira el componente
+ * Invitations.tsx
+ *
+ * // IMPORTANTE: El tipado del componente Form es genérico
+ * // por lo que es posible instanciarlo como se muestra a
+ * // continuación, lo que nos da el tipado correcto en el
+ * // callback onValidate.
+ * <Form<FormDataType> onValidate={(res) => {
+ *  if(hasSucceedValidation(res)) {
+ *    // Do something with submitValues
+ *  } else {
+ *    // Do something with errors
+ *  }
+ * }}>
+ *    ...{children}
+ * </Form>
+ */
+declare const Form: <ValueType extends Record<string, unknown>, SubmitValueType extends Record<keyof ValueType, unknown> = ValueType>({ avoidFieldsOverride, avoidFieldsTouch, children, className, name, initialValues, onUnmount, onValidate, unregisterOnUnmount, }: IForm<ValueType, SubmitValueType>) => theme_ui_jsx_runtime.JSX.Element | null;
+
+interface IFormContext<ValueType extends Record<string, unknown> = Record<string, unknown>, SubmitValueType extends Record<keyof ValueType, unknown> = ValueType> {
+    avoidFieldsTouch?: boolean;
+    name: string;
+    validate: () => Promise<TValidationResult<ValueType, SubmitValueType>>;
+}
+declare const FormContext: React.Context<IFormContext<Record<string, unknown>, Record<string, unknown>>>;
+/**
+ * Provee acceso de forma sencilla al contexto de
+ * validación, que básicamente posee el nombre del
+ * form en caso de que se quiera usar para acceder
+ * a través de Redux a la información del mismo y un
+ * método validate, que dispara la validación del
+ * form.
+ *
+ * En la práctica, el método validate es casi
+ * innecesario, ya que la validación se puede disparar
+ * con cualquier botón que no tenga seteado el
+ * atributo type="button" (esto es así ya que en el
+ * DOM se renderiza un elemento de tipo form).
+ */
+declare function useFormContext(): IFormContext<Record<string, unknown>, Record<string, unknown>>;
+
+interface IPropsStoreConf {
+    logCommands: {
+        propsStore?: string;
+        updateProp?: string;
+        propsSuscriptors?: string;
+        propsLog?: string;
+    };
+}
+declare class PropsStore<PropsType extends Record<TId, unknown> = Record<TId, unknown>> {
+    private configuration?;
+    log: unknown;
+    fields: Record<TId, PropsType>;
+    suscriptors: Record<TId, TPropsSuscriptor<PropsType>[]>;
+    loggers: Record<string, (props: unknown[]) => void>;
+    constructor(configuration?: IPropsStoreConf | undefined);
+    destructor(): void;
+    getAllFields(): Record<TId, PropsType>;
+    /**
+     * Devuelve los props actuales de un campo.
+     */
+    getFieldProps<ParsedPropsType = PropsType>(fieldId: TId): ParsedPropsType;
+    removeField(fieldId: TId): void;
+    /**
+     * Permite establecer un suscriptor que será llamado
+     * cada vez que las props del campo especificado cambien.
+     */
+    suscribe(fieldId: TId, callback: TPropsSuscriptor<PropsType>): () => void;
+    /**
+     * Actualiza o crea las props de un campo.
+     *
+     * La tercera prop está relacionada
+     */
+    updateField<NewPropsType extends Record<TId, unknown> = Partial<PropsType>>(fieldId: TId, props: Partial<NewPropsType>, conf?: TUpdateFieldConfiguration): void;
+}
+
+type TProperties = Record<string, unknown>;
+type TPropsSuscriptor<PropsType extends Record<string, unknown> = TProperties> = (props: PropsType, urgent?: boolean) => unknown;
+type TPropsSelector<Selected = any, PropsType = TProperties> = (props: PropsType) => Selected;
+/**
+ * La función comparadora debe devolver true cuando
+ * los elementos son iguales o false cuando son
+ * distintos.
+ */
+type TPropsComparator<Selected> = (prevProps: Selected | undefined, newProps: Selected | undefined) => boolean;
+type TPropsConfiguration<Selected, PropsType extends Record<string, unknown> = TProperties> = {
+    selector?: TPropsSelector<Selected, PropsType>;
+    comparator?: TPropsComparator<Selected>;
+    initialValue?: Selected;
+    propsStore?: PropsStore<PropsType>;
+};
+type TUpdateFieldConfiguration = Partial<{
+    noEmit: boolean;
+    isUrgent: boolean;
+}>;
+
+declare const validationsStore: {
+    activeForms: string[];
+    timeouts: Record<string, ReturnType<typeof setTimeout> | true>;
+    getFieldStore(formName: string, fieldName: string): TValidationField<any, any>;
+    getFormStore(formName: string): TFormState;
+    updateFieldStore(formName: string, fieldName: string, props: Partial<TValidationField>, noEmit?: boolean): void;
+    updateFormStore(formName: string, newState: Partial<TFormState>): void;
+    enableFormTouch(formName: string): void;
+    existsField: (formName: string, fieldName: string) => boolean;
+    makeFieldName(formName: string, fieldName: string): string;
+    makeFormName(formName: string): string;
+    registerField: (formName: string, registerData: TRegisterField, options?: TRegisterFieldOptions) => void;
+    /**
+     * Inicializa el estado de un nuevo formulario
+     */
+    registerForm: (formName: string, props?: Partial<{
+        avoidFieldsOverride: boolean;
+        initialValues: Record<string, unknown>;
+    }>) => void;
+    /**
+     * Setea el valor del campo con el nombre provisto. Si el campo no existe
+     * en el formulario lo crea.
+     */
+    setFieldValue: (formName: string, fieldName: string, newValue: unknown, options?: Partial<{
+        avoidPropagation?: boolean | undefined;
+        markFormAsTouched: boolean;
+    }> | undefined) => void;
+    setFormIsTouched: (formName: string, isTouched?: boolean) => void;
+    /**
+     * Elimina un campo del registro de validación de un formulario. De esta
+     * forma cualquier validación que pudiera aplicarse sobre el mismo, ya no se
+     * aplicará.
+     */
+    unregisterField: (formName: string, fieldName: string) => void;
+    /**
+     * Elimina un formulario del store de validación junto con todos los campos
+     * asociados al mismo.
+     */
+    unregisterForm: (formName: string) => void;
+    /**
+     * Actualiza las propiedades de un campo, si no existe, lo registra en el
+     * formulario.
+     */
+    updateField: (formName: string, field: Partial<TValidationField> & Pick<TValidationField, 'name'>, options?: Partial<{
+        avoidPropagation?: boolean | undefined;
+        markFormAsTouched: boolean;
+    }> | undefined) => void;
+    /**
+     * Actualiza múltiples campos al mismo tiempo.
+     */
+    updateMultipleFields: (formName: string, fields: (Partial<TValidationField> & Pick<TValidationField, 'name'>)[], options?: Partial<{
+        avoidPropagation?: boolean | undefined;
+        markFormAsTouched: boolean;
+    }> | undefined) => void;
+    /**
+     * Ejecuta la validación sobre un formulario. En caso de que la validación
+     * falle, se intenta hacer foco sobre el campo que no pudo validar.
+     * Es importante notar que en caso de que un campo requiera validación,
+     * debería estar presente en el DOM.
+     *
+     * No es necesario que el campo esté visible, ya que en caso de estar oculto
+     * (por ejemplo por ser hijo de un acordeón), se emitirá un evento para
+     * expandir al elemento padre que lo estuviera ocultando.
+     *
+     * @returns Devuelve una promesa que al ser resuelta otorga un objeto de tipo
+     * TValidationResult. Este tipo está pensado para ser usado en conjunto con
+     * el método hasSucceedFormValidation, que determinará si la validación fue
+     * exitosa o hubo errores.
+     *
+     * @example
+     *
+     * const result = await validationStore.validateForm('myForm');
+     * if(hasSucceedValidation(result)) {
+     *   console.log('Success!', result);
+     * } else {
+     *   console.error('Validation error', result);
+     * }
+     */
+    validateForm: <ValueType extends Record<string, unknown>, SubmitValueType extends Record<keyof ValueType, unknown> = ValueType>(formName: string) => Promise<TValidationResult<ValueType, SubmitValueType>>;
+};
+/**
+ * Este hook permite suscribirse a los cambios realizados en el
+ * store de validación de un formulario. Funciona igual a un
+ * useAppSelector en cuanto a la función selectora y comparadora.
+ *
+ * @param selector
+ * @param comparator
+ * @returns
+ */
+declare function useFormSelector<Selected = any>(formName: string, selector: TPropsSelector<Selected, TFormState>, comparator?: TPropsComparator<Selected>): Selected;
+/**
+ * Este hook permite suscribirse a los cambios realizados en el
+ * store de validación de un campo de formulario. Funciona igual a un
+ * useAppSelector en cuanto a la función selectora y comparadora.
+ *
+ * @param selector
+ * @param comparator
+ * @returns
+ */
+declare function useFieldSelector<ValueType = unknown, SubmitValueType = unknown, Selected = any>(formName: string, fieldName: string, selector?: TPropsSelector<Selected, TValidationField<ValueType, SubmitValueType>>, comparator?: TPropsComparator<Selected>): Selected;
+declare function useFieldSelector<ValueType = unknown, SubmitValueType = unknown, Selected = any>(formName: string, fieldName: string, configurator?: TPropsConfiguration<Selected, TValidationField<ValueType, SubmitValueType>>): Selected;
+
+/**
+ * Determina si la validación de un campo resultó exitosa.
+ */
+declare function hasSucceedFieldValidation(result: TFieldValidationResult): result is true;
+/**
+ * Determina si la validación de un formulario resultó
+ * exitosa. Está pensada para utilizar en el callback
+ * onValidate de Form o en la acción validationsActions.validateForm
+ */
+declare function hasSucceedFormValidation<ValueType extends Record<string, unknown>, SubmitValueType extends Record<keyof ValueType, unknown> = ValueType>(result: TValidationResult<ValueType, SubmitValueType>): result is TSuccessfulValidation<ValueType, SubmitValueType>;
+declare function classToValidationFunction<T = string>(className: string): TValidationField<T>['validationFunction'];
+declare function classToValidate(className: string): IFieldDefinition['validate'];
+/**
+ * Realiza la carga de los mensajes de errores para el lenguaje
+ * especificado. Este método debe llamarse antes de utilizar
+ * las validaciones.
+ */
+declare function initValidations(): Promise<void>;
+
+type TUseField<ValueType = unknown, SubmitValueType = ValueType> = Omit<TValidationField<ValueType, SubmitValueType>, 'error' | 'value' | 'isTouched'> & {
+    /**
+     * Con esta propiedad es posible evitar que el campo
+     * se registre cuando ya fue registrado previamente en
+     * el store. De esta forma, se evitaría escribir sobre
+     * un valor que ya estaba seteado anteriormente.
+     */
+    avoidRegisterIfExists?: boolean;
+    /**
+     * Si se está fuera de contexto de validación, se puede pasar un formName
+     * para evitar que el hook lo intente tomar de contexto.
+     */
+    formName?: string;
+    initialValue?: ValueType;
+    removeOnUnmount?: boolean;
+};
+/**
+ * Este hook permite registrar un field para ser validado,
+ * o simplemente para recolectar su valor, e incluso aplicar
+ * una función de transformación de dicho valor antes de
+ * hacer submit.
+ *
+ * @returns
+ * *error:* Es null mientras que no haya errores de
+ * validación, y un string en caso de que si lo haya.
+ *
+ * *value:* Es el valor actual del campo.
+ *
+ * *name:* Debería utilizarse para dar * valor al atributo
+ * name o id del contenedor que debe recibir el foco en caso
+ * de que la validación fallara. (Esto es, cuando se deba
+ * realizar foco porque la validación falló, la librería
+ * intentará encontrar un campo con el selector
+ * [name=${name}, #${name}] dentro del formulario).
+ *
+ * *onChange:* Se utiliza para setear el valor del campo,
+ * puede utilizarse directamente como callback para la
+ * propiedad onChange que aceptan la mayoría de los campos,
+ * ya que intentará setear el valor con ev.target.value
+ * y si esa propiedad no está definida, lo hará directamente
+ * con ev.
+ *
+ * @example
+ *  // Si se desea un ejemplo más complejo, vea el componente
+ *  // Invitations.tsx que se encuentra dentro del directorio
+ *  // de la librería.
+ *
+ *  const inputProps = useField<string>({
+      name: 'name',
+      validationRules: {
+        required: true,
+        minLength: 5,
+        maxLength: 10
+      },
+      initialValue: metadata.value,
+ *  });
+
+    return <Box>
+      <Input {...inputProps} />
+      <ValidationError name="name" />
+    </Box>
+ */
+declare function useField<ValueType = unknown, SubmitValueType = ValueType>(fieldDefinition: TUseField<ValueType, SubmitValueType>): {
+    error: string | null | undefined;
+    isTouched: boolean;
+    name: string;
+    onChange: (ev: React.ChangeEvent | ValueType) => void;
+    updateValidations: ({ validationFunction, validationRules, }: Pick<TValidationField, 'validationRules' | 'validationFunction'>) => void;
+    value: ValueType;
+};
+
+interface IWrapper extends BoxProps {
+    name: string;
+    label?: string;
+    children: React.ReactNode;
+    required?: boolean;
+    avoidSemicolon?: boolean;
+}
+declare const FieldWrapper: ({ name, label, avoidSemicolon, children, className, as, ...props }: IWrapper) => theme_ui_jsx_runtime.JSX.Element;
+
+type TDefaultFieldType<ValueType = string> = Omit<TUseField<ValueType>, 'error' | 'value' | 'isTouched'> & {
+    label?: string;
+    initialValue?: ValueType;
+    validationClass?: string;
+} & Pick<IWrapper, 'avoidSemicolon'>;
+
+type TCheckbox = Omit<ButtonProps, 'onChange'> & Pick<InputProps, 'onChange'> & TDefaultFieldType & {
+    native?: boolean;
+};
+declare const Checkbox: React.ForwardRefExoticComponent<Omit<TCheckbox, "ref"> & React.RefAttributes<HTMLButtonElement>>;
+
+type TDeletableInput = InputProps & TDefaultFieldType;
+declare const DeletableInput: React.ForwardRefExoticComponent<Omit<TDeletableInput, "ref"> & React.RefAttributes<HTMLInputElement>>;
+
+type TFieldLabel = LabelProps & {
+    avoidSemicolon?: boolean;
+    children?: React.ReactNode;
+    required?: boolean;
+};
+declare const FieldLabel: ({ avoidSemicolon, children, required, ...props }: TFieldLabel) => theme_ui_jsx_runtime.JSX.Element;
+
+type TFileInput = Omit<InputProps, 'onChange' | 'type' | 'value' | 'multiple'> & TDefaultFieldType<File | null> & Pick<TUseField, 'removeOnUnmount'> & Pick<IWrapper, 'avoidSemicolon'>;
+declare const FileInput: React.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<TFileInput, "ref"> & React.RefAttributes<HTMLInputElement>>>;
+
+type TInput$1 = InputProps & TDefaultFieldType;
+declare const Input: React.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<TInput$1, "ref"> & React.RefAttributes<HTMLInputElement>>>;
+
+type TInput = TNumberInput & TDefaultFieldType;
+declare const NumberInputf: React.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<TInput, "ref"> & React.RefAttributes<HTMLInputElement>>>;
+
+type TRadio = RadioProps & TDefaultFieldType & {
+    options: {
+        value: string;
+        label: string;
+    }[];
+};
+declare const Radio: React.ForwardRefExoticComponent<Omit<TRadio, "ref"> & React.RefAttributes<HTMLInputElement>>;
+
+type TSelect = SelectProps & TDefaultFieldType & {
+    options: {
+        value: string;
+        label: string;
+    }[];
+};
+declare const Select: React.ForwardRefExoticComponent<Omit<TSelect, "ref"> & React.RefAttributes<HTMLSelectElement>>;
+
+type TSwitchbox = Omit<SwitchProps, 'onChange'> & Pick<InputProps, 'onChange'> & TDefaultFieldType & {
+    reverse?: boolean;
+};
+declare const Switchbox: React.ForwardRefExoticComponent<Omit<TSwitchbox, "ref"> & React.RefAttributes<HTMLInputElement>>;
+
+type TTextarea = TextareaProps & TDefaultFieldType;
+declare const Textarea: React.ForwardRefExoticComponent<Omit<TTextarea, "ref"> & React.RefAttributes<HTMLTextAreaElement>>;
+
+/**
+ * Renderiza los errores del campo con el nombre pasado
+ * como prop. En caso de que no exista error, no renderiza
+ * nada.
+ *
+ * @props
+ * *name:* El nombre del campo cuyos errores se quieren
+ * renderizar.
+ */
+declare const ValidationError: ({ name }: {
+    name: string;
+}) => theme_ui_jsx_runtime.JSX.Element | null;
+
+declare function useFieldStatesClassNames<T = unknown>(name: string, formName?: string): string;
+
+interface IUseFieldValue {
+    formName?: string;
+    name: string;
+}
+declare function useFieldValue<T = unknown>({ formName, name }: IUseFieldValue): T;
+
+declare function useValidationClass<T>({ customValidation, validationClass, validationFunction, validationRules, }: Pick<TDefaultFieldType<T>, 'validationClass' | 'validationFunction' | 'validationRules'> & {
+    customValidation?: TValidationFunction<T>;
+}): {
+    actualValidationFunction: TValidationFunction<T>;
+    actualValidationRules: {
+        number?: boolean | undefined;
+        required?: boolean | undefined;
+        alpha?: boolean | undefined;
+        alphanum?: boolean | undefined;
+        nodigit?: boolean | undefined;
+        digit?: boolean | undefined;
+        email?: boolean | undefined;
+        image?: boolean | undefined;
+        phone?: boolean | undefined;
+        url?: boolean | undefined;
+        lengthmax?: boolean | undefined;
+        lengthmin?: boolean | undefined;
+        checkbox?: boolean | undefined;
+        radios?: boolean | undefined;
+        select?: boolean | undefined;
+        select_multiple?: boolean | undefined;
+        errorsTitle?: boolean | undefined;
+        digitmin?: number | undefined;
+        digitltd?: [number, number] | undefined;
+        confirm?: string | undefined;
+        differs?: string | undefined;
+        length_str?: [number, number] | undefined;
+        length_fix?: number | undefined;
+        words_min?: number | undefined;
+        words_max?: number | undefined;
+        words_range?: [number, number] | undefined;
+        checkboxes_group?: number | undefined;
+        patternMessage?: string | undefined;
+        pattern?: string | RegExp | undefined;
+        digitmax?: number | undefined;
+        validName?: string | undefined;
+        maxLength?: number | undefined;
+        minLength?: number | undefined;
+        min?: number | undefined;
+        max?: number | undefined;
+    };
+};
+
+export { Checkbox, DeletableInput, FieldLabel, FieldWrapper, FileInput, Form, FormContext, IWrapper, Input, NumberInputf, Radio, Select, Switchbox, TCheckbox, TDefaultFieldType, TFieldLabel, TInput$1 as TInput, TRadio, TSelect, TSwitchbox, TUseField, Textarea, ValidationError, classToValidate, classToValidationFunction, hasSucceedFieldValidation, hasSucceedFormValidation, initValidations, useField, useFieldSelector, useFieldStatesClassNames, useFieldValue, useFormContext, useFormSelector, useValidationClass, validationsStore };