@apia/validations 3.0.1 → 3.0.6

package/dist/index.d.ts

@@ -1,26 +1,786 @@
-export { Form, TOnValidate } from './form/Form.js';
-export { FormContext, useFormContext } from './form/FormContext.js';
-export { useFieldSelector, useFormSelector, validationsStore } from './validationStore.js';
-export { TValidationResult, TValidationRules } from './types.js';
-export { classToValidate, classToValidationFunction, hasSucceedFieldValidation, hasSucceedFormValidation, initValidations, lang } from './util.js';
-export { Collector } from './collector/Collector.js';
-export { CollectorField } from './collector/CollectorField.js';
-export { ValidatedCollectorField } from './collector/ValidatedCollectorField.js';
-export { Captcha } from './components/Captcha.js';
-export { Checkbox, TCheckbox, TCheckboxProps } from './components/Checkbox.js';
-export { DeletableInput } from './components/DeletableInput.js';
-export { FieldWrapper, IWrapper } from './components/FieldWrapper.js';
-export { FileInput } from './components/FileInput.js';
-export { Input, TInput } from './components/Input.js';
-export { NumberInputf } from './components/NumberInput.js';
-export { Radio, TRadio } from './components/Radio.js';
-export { Select, TOption, TSelect, TSelectProps } from './components/Select.js';
-export { Switchbox, TSwitchbox } from './components/Switchbox.js';
-export { Textarea } from './components/Textarea.js';
-export { TDefaultFieldType } from './components/types.js';
-export { ValidationError } from './components/ValidationError.js';
-export { TUseField, useField } from './hooks/useField.js';
-export { useFieldStatesClassNames } from './hooks/useFieldStatesClassNames.js';
-export { useFieldValue } from './hooks/useFieldValue.js';
-export { useValidationClass } from './hooks/useValidationClass.js';
+import * as React from 'react';
+import React__default, { ReactNode, FC } from 'react';
+import { TModify, TPropsSelector, TPropsComparator, TPropsConfiguration, TId, EventEmitter } from '@apia/util';
+import { TNumberInput, ApiaUtilModalHandler, TOpenModal } from '@apia/components';
+import { BoxProps, ButtonProps, InputProps, RadioProps, SelectProps, SwitchProps, TextareaProps } from '@apia/theme';
+
+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;
+};
+
+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;
+type TValidationRules = IFieldDefinition['validate'];
+type TFocusRetriever = () => Promise<boolean> | void;
+/**
+ * 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;
+    /**
+     * Permite definir una función personalizada para hacer foco sobre el campo. Se utiliza a la hora de validar el campo, cuando el mismo falla.
+     */
+    focus?: TFocusRetriever;
+    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 | Promise<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?: TValidationRules;
+    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>;
+    /**
+     * Esta propiedad fuerza al formulario a guardarse en el localStorage. Adicionalmente,
+     * si al registrar el formulario ya existe información almacenada, la carga en el store
+     * e ignora las propiedades provistas en el método, a excepción de:
+     *  - fields:validationFunction
+     *  - fields:submitValueParser
+     */
+    persistToSessionStorage: boolean;
+}>;
+type TUpdateFieldOptions = Partial<{
+    avoidPropagation?: boolean;
+    /**
+     * Cuando se hace seteo de propiedades iniciales, se puede pasar este flag
+     * en false para que el formulario no aparezca como touched debido a estos
+     * cambios.
+     */
+    markFormAsTouched: boolean;
+}> & Pick<TRegisterFormOptions, 'avoidFieldsOverride'>;
+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' | 'persistToSessionStorage'>;
+
+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__default.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>;
+    persistToSessionStorage?: boolean;
+    /**
+     * 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.
+ *
+ * avoidFieldsOverride
+ * avoidFieldsTouch
+ *
+ * @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, persistToSessionStorage, unregisterOnUnmount, }: IForm<ValueType, SubmitValueType>) => React__default.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__default.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>>;
+
+declare global {
+    interface Window {
+        MSG_WRONG_VALIDATION_NO_FOCUSED_FILE: string;
+    }
+}
+declare const validationsStore: {
+    activeForms: string[];
+    timeouts: Record<string, ReturnType<typeof setTimeout> | true>;
+    loadFromSessionStorage(formName: string): boolean;
+    persistFormToSessionStorage(formName: string): void;
+    getFieldStore(formName: string, fieldName: string): TValidationField;
+    getFormStore(formName: string): TFormState;
+    updateFieldStore(formName: string, fieldName: string, props: Partial<TValidationField>, noEmit?: boolean): void;
+    updateFormStore(formName: string, newState: Partial<TFormState>, avoidPersist?: boolean): 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>;
+        persistToSessionStorage: boolean;
+    }>) => 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?: TUpdateFieldOptions) => 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?: TUpdateFieldOptions) => void;
+    /**
+     * Actualiza múltiples campos al mismo tiempo.
+     */
+    updateMultipleFields: (formName: string, fields: (Partial<TValidationField> & Pick<TValidationField, 'name'>)[], options?: TUpdateFieldOptions) => 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;
+
+declare global {
+    interface Window {
+        NO_LANGUAGE_EXCEPTION: string;
+        MSG_INVALID_REG_EXP: string;
+        GNR_INVALID_NAME: string;
+    }
+}
+/**
+ * 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>;
+/**
+ * Devuelve la cadena correspondiente a un código
+ * de error, realizando los reemplazos correspondientes.
+ */
+declare function lang(errorCode: keyof typeof formcheckLanguage, ...replacements: (string | number)[]): string;
+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__default.ChangeEvent | ValueType) => void;
+    updateValidations: ({ validationFunction, validationRules, }: Pick<TValidationField, 'validationRules' | 'validationFunction'>) => void;
+    value: ValueType;
+};
+
+declare global {
+    interface Window {
+        SHOW_REQUIRED_POSITION: string;
+    }
+}
+interface IWrapper extends BoxProps {
+    avoidSemicolon?: boolean;
+    children: React__default.ReactNode;
+    label?: string;
+    name: string;
+    required?: boolean;
+    type?: 'checkbox';
+}
+declare const FieldWrapper: ({ name, label, avoidSemicolon, children, className, as, type, ...props }: IWrapper) => React__default.JSX.Element;
+
+type TDefaultFieldType<ValueType = string> = Omit<TUseField<ValueType>, 'error' | 'value' | 'isTouched'> & {
+    label?: string;
+    initialValue?: ValueType;
+    validationClass?: string;
+} & Pick<IWrapper, 'avoidSemicolon'>;
+
+type TCaptchaProps = {
+    name: string;
+    imageUrl: string;
+    className?: string;
+};
+type TCaptcha = TCaptchaProps & Omit<TDefaultFieldType, 'validationFunction' | 'validationRules' | 'validationClass'>;
+declare const InnerCaptcha: ({ className, name, imageUrl, avoidRegisterIfExists, avoidSemicolon, formName, label, removeOnUnmount, submitName, submitValueParser, validationValueParser, }: TCaptcha) => React__default.JSX.Element;
+
+type TCheckboxProps = Omit<ButtonProps, 'onChange' | 'defaultChecked' | 'defaultValue'> & Pick<InputProps, 'onChange'>;
+type TCheckbox = TCheckboxProps & TDefaultFieldType<boolean | string> & {
+    native?: boolean;
+};
+declare const Checkbox: React__default.ForwardRefExoticComponent<Omit<TCheckbox, "ref"> & React__default.RefAttributes<HTMLButtonElement>>;
+
+type TDeletableInput = InputProps & TDefaultFieldType;
+declare const DeletableInput: React__default.ForwardRefExoticComponent<Omit<TDeletableInput, "ref"> & React__default.RefAttributes<HTMLInputElement>>;
+
+type TFileInput = Omit<InputProps, 'onChange' | 'type' | 'value' | 'multiple'> & TDefaultFieldType<File | null> & Pick<TUseField, 'removeOnUnmount'> & Pick<IWrapper, 'avoidSemicolon'>;
+declare const FileInput: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<Omit<TFileInput, "ref"> & React__default.RefAttributes<HTMLInputElement>>>;
+
+type TInput$1 = InputProps & TDefaultFieldType;
+declare const Input: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<Omit<TInput$1, "ref"> & React__default.RefAttributes<HTMLInputElement>>>;
+
+declare global {
+    interface Window {
+        GNR_NUMERIC: string;
+    }
+}
+type TInput = TNumberInput & TDefaultFieldType;
+declare const NumberInputf: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<Omit<TInput, "ref"> & React__default.RefAttributes<HTMLInputElement>>>;
+
+type TRadio = RadioProps & TDefaultFieldType & {
+    options: {
+        value: string;
+        label: string;
+    }[];
+};
+declare const Radio: React__default.ForwardRefExoticComponent<Omit<TRadio, "ref"> & React__default.RefAttributes<HTMLInputElement>>;
+
+type TOption = {
+    value: TId;
+    label: string;
+};
+type TSelectProps = Omit<SelectProps, 'defaultValue'>;
+type TSelect = TSelectProps & TDefaultFieldType & {
+    options: TOption[];
+};
+declare const Select: React__default.ForwardRefExoticComponent<Omit<TSelect, "ref"> & React__default.RefAttributes<HTMLSelectElement>>;
+
+type TSwitchbox = Omit<SwitchProps, 'onChange'> & Pick<InputProps, 'onChange'> & TDefaultFieldType & {
+    reverse?: boolean;
+};
+declare const Switchbox: React__default.ForwardRefExoticComponent<Omit<TSwitchbox, "ref"> & React__default.RefAttributes<HTMLInputElement>>;
+
+type TTextarea = TextareaProps & TDefaultFieldType;
+declare const Textarea: React__default.ForwardRefExoticComponent<Omit<TTextarea, "ref"> & React__default.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;
+}) => React.JSX.Element | null;
+
+declare abstract class CollectorField<ValueType = any, FieldProps = any> extends EventEmitter<{
+    focusFunctionUpdate: TFocusRetriever;
+    functionUpdate: TValidationFunction<ValueType>;
+    optionsUpdate: TOption[];
+    propsUpdate: Partial<FieldProps>;
+    rulesUpdate: TValidationRules;
+}> {
+    #private;
+    readonly name: string;
+    protected label: ReactNode;
+    /**
+     * Este es el componente de implementación de cada campo particular
+     */
+    abstract Component: FC;
+    abstract type: string;
+    constructor(name: string, label: ReactNode, properties?: Partial<FieldProps>);
+    collector: Collector;
+    isHidden: () => boolean;
+    setIsHidden: (isHidden: boolean) => void;
+    protected properties: Partial<FieldProps>;
+    setProperties: (newProps: Partial<FieldProps>) => void;
+    protected useProperties: () => Partial<FieldProps>;
+    /**
+     * Este componente se utiliza para controlar propiedades comunes a todos los
+     * campos.
+     */
+    SuperComponent: () => React.JSX.Element | null;
+}
+
+declare abstract class ValidatedCollectorField<ValueType = any, FieldProps = any> extends CollectorField<ValueType, FieldProps> {
+    readonly name: string;
+    protected label: string;
+    protected config: Partial<{
+        initialValue: ValueType;
+        properties: Partial<FieldProps>;
+        validationFunction: TValidationFunction<ValueType>;
+        validationRules: TValidationRules;
+    }>;
+    constructor(name: string, label: string, config?: Partial<{
+        initialValue: ValueType;
+        properties: Partial<FieldProps>;
+        validationFunction: TValidationFunction<ValueType>;
+        validationRules: TValidationRules;
+    }>);
+    get initialValue(): ValueType | undefined;
+    setInitialValue: (newValue: ValueType) => void;
+    setValidationFunction: (newFunction: TValidationFunction<ValueType>) => void;
+    setValidationRules: (newRules: TValidationRules) => void;
+    setValue: (newValue: ValueType) => void;
+    protected useValidationFunction: () => TValidationFunction<ValueType> | undefined;
+    protected useValidationRules: () => Partial<Omit<Record<"number" | "required" | "alpha" | "alphanum" | "nodigit" | "digit" | "digitmin" | "digitltd" | "email" | "image" | "phone" | "url" | "confirm" | "differs" | "length_str" | "length_fix" | "lengthmax" | "lengthmin" | "words_min" | "words_max" | "words_range" | "checkbox" | "checkboxes_group" | "radios" | "select" | "select_multiple" | "errorsTitle", boolean>, "digitmin" | "digitltd" | "confirm" | "differs" | "length_str" | "length_fix" | "words_min" | "words_max" | "words_range" | "checkboxes_group"> & {
+        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: string | RegExp;
+        digitmax: number;
+        validName?: string | undefined;
+        maxLength: number;
+        minLength: number;
+        min: number;
+        max: number;
+    }> | undefined;
+}
+
+declare class CollectorCheckbox extends ValidatedCollectorField<string | boolean, Omit<TCheckboxProps, 'name'>> {
+    type: string;
+    Component: () => React.JSX.Element;
+}
+
+declare class CollectorInput extends ValidatedCollectorField<string, Omit<InputProps, 'name'>> {
+    type: string;
+    Component: () => React.JSX.Element;
+}
+
+declare class CollectorSelect extends ValidatedCollectorField<string, Omit<TSelectProps, 'name'>> {
+    #private;
+    protected _name: string;
+    protected label: string;
+    type: string;
+    constructor(_name: string, label: string, config?: Partial<{
+        initialValue: string;
+        options: TOption[];
+        properties: Partial<Omit<TSelectProps, 'name'>>;
+        validationFunction: TValidationFunction<string>;
+        validationRules: TValidationRules;
+    }>);
+    addOption: (newOption: TOption) => void;
+    setOptions: (newOptions: TOption[]) => void;
+    Component: () => React.JSX.Element;
+}
+
+declare class CollectorTextarea extends ValidatedCollectorField<string, Omit<TextareaProps, 'name'>> {
+    type: string;
+    Component: () => React.JSX.Element;
+}
+
+declare class CollectorLabel extends CollectorField {
+    private kind;
+    private static maxId;
+    type: string;
+    constructor(label: ReactNode, kind?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'label');
+    Component: () => React.JSX.Element;
+}
+
+declare class CollectorButton extends CollectorField<null, Omit<ButtonProps, 'children'>> {
+    protected label: string;
+    type: string;
+    constructor(label: string, properties?: Omit<ButtonProps, 'children'>);
+    Component: () => React.JSX.Element;
+}
+
+declare class Collector {
+    #private;
+    fields: {
+        button: typeof CollectorButton;
+        checkbox: typeof CollectorCheckbox;
+        input: typeof CollectorInput;
+        /**
+         * Muestra una etiqueta con tag personalizable: h1...h6, p, label. (Por
+         * defecto: label)
+         */
+        label: typeof CollectorLabel;
+        select: typeof CollectorSelect;
+        textarea: typeof CollectorTextarea;
+    };
+    private private__id;
+    get id(): string;
+    modal: ApiaUtilModalHandler | null;
+    add: (...fields: CollectorField[]) => this;
+    forEach: (cb: (field: CollectorField, i: number) => void) => void;
+    show: <FormValues extends Record<string, unknown>>(modalProps?: (Partial<Omit<TOpenModal, "children" | "onConfirm" | "onCancel" | "confirmProps">> & Partial<{
+        hideConfirm: boolean;
+        /**
+         * Si este método devuelve false, el modal no se cerrará
+         */
+        onConfirm?: ((res: FormValues | null) => boolean) | undefined;
+    }>) | undefined) => Promise<FormValues | 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, formName, name, validationClass, validationFunction, validationRules, }: Pick<TDefaultFieldType<T>, 'validationClass' | 'validationFunction' | 'validationRules' | 'name'> & {
+    customValidation?: TValidationFunction<T>;
+    formName?: string;
+}): {
+    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 { InnerCaptcha as Captcha, Checkbox, Collector, CollectorField, DeletableInput, FieldWrapper, FileInput, Form, FormContext, type IWrapper, Input, NumberInputf, Radio, Select, Switchbox, type TCheckbox, type TCheckboxProps, type TDefaultFieldType, type TInput$1 as TInput, type TOnValidate, type TOption, type TRadio, type TSelect, type TSelectProps, type TSwitchbox, type TUseField, type TValidationFunction, type TValidationResult, type TValidationRules, Textarea, ValidatedCollectorField, ValidationError, classToValidate, classToValidationFunction, hasSucceedFieldValidation, hasSucceedFormValidation, initValidations, lang, useField, useFieldSelector, useFieldStatesClassNames, useFieldValue, useFormContext, useFormSelector, useValidationClass, validationsStore };
 //# sourceMappingURL=index.d.ts.map