@apia/validations 0.1.3 → 0.2.4

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import * as theme_ui_jsx_runtime from 'theme-ui/jsx-runtime';
-import React from 'react';
+import * as React from 'react';
+import React__default from 'react';
 import { TModify, TPropsSelector, TPropsComparator, TPropsConfiguration } from '@apia/util';
-import { BoxProps, ButtonProps, InputProps, LabelProps, RadioProps, SelectProps, SwitchProps, TextareaProps } from 'theme-ui';
+import { BoxProps, ButtonProps, InputProps, RadioProps, SelectProps, SwitchProps, TextareaProps } from '@apia/theme';
 import { TNumberInput } from '@apia/components';
 
 declare const formcheckLanguage: {
@@ -34,11 +34,6 @@ declare const formcheckLanguage: {
     errorsTitle: string;
 };
 
-declare global {
-    interface Window {
-        [key: string]: string;
-    }
-}
 type TValidate = Partial<TModify<Record<keyof typeof formcheckLanguage, boolean>, {
     digitmin: number;
     digitltd: [number, number];
@@ -175,7 +170,7 @@ interface IForm<ValueType extends Record<string, unknown>, SubmitValueType exten
      * Impide que se apliquen los estilos que indican que un campo fue alterado.
      */
     avoidFieldsTouch?: boolean;
-    children: React.ReactNode;
+    children: React__default.ReactNode;
     className?: string;
     initialValues?: Partial<ValueType>;
     name?: string;
@@ -192,14 +187,67 @@ interface IForm<ValueType extends Record<string, unknown>, SubmitValueType exten
      */
     unregisterOnUnmount?: boolean;
 }
-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;
+/**
+ * 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, 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.Context<IFormContext<Record<string, unknown>, Record<string, unknown>>>;
+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
@@ -216,6 +264,11 @@ declare const FormContext: React.Context<IFormContext<Record<string, unknown>, R
  */
 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>;
@@ -318,6 +371,13 @@ declare function useFormSelector<Selected = any>(formName: string, selector: TPr
 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.
  */
@@ -403,20 +463,25 @@ declare function useField<ValueType = unknown, SubmitValueType = ValueType>(fiel
     error: string | null | undefined;
     isTouched: boolean;
     name: string;
-    onChange: (ev: React.ChangeEvent | ValueType) => void;
+    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.ReactNode;
+    children: React__default.ReactNode;
     label?: string;
     name: string;
     required?: boolean;
     type?: 'checkbox';
 }
-declare const FieldWrapper: ({ name, label, avoidSemicolon, children, className, as, type, ...props }: IWrapper) => theme_ui_jsx_runtime.JSX.Element;
+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;
@@ -430,31 +495,29 @@ type TCaptchaProps = {
     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) => theme_ui_jsx_runtime.JSX.Element;
+declare const InnerCaptcha: ({ className, name, imageUrl, avoidRegisterIfExists, avoidSemicolon, formName, label, removeOnUnmount, submitName, submitValueParser, validationValueParser, }: TCaptcha) => React__default.JSX.Element;
 
 type TCheckbox = Omit<ButtonProps, 'onChange'> & Omit<Pick<InputProps, 'onChange'>, 'value'> & TDefaultFieldType<boolean | string> & {
     native?: boolean;
 };
-declare const Checkbox: React.ForwardRefExoticComponent<Omit<TCheckbox, "ref"> & React.RefAttributes<HTMLButtonElement>>;
+declare const Checkbox: React__default.ForwardRefExoticComponent<Omit<TCheckbox, "ref"> & React__default.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;
+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.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<TFileInput, "ref"> & React.RefAttributes<HTMLInputElement>>>;
+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.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<TInput$1, "ref"> & React.RefAttributes<HTMLInputElement>>>;
+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.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<TInput, "ref"> & React.RefAttributes<HTMLInputElement>>>;
+declare const NumberInputf: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<Omit<TInput, "ref"> & React__default.RefAttributes<HTMLInputElement>>>;
 
 type TRadio = RadioProps & TDefaultFieldType & {
     options: {
@@ -462,7 +525,7 @@ type TRadio = RadioProps & TDefaultFieldType & {
         label: string;
     }[];
 };
-declare const Radio: React.ForwardRefExoticComponent<Omit<TRadio, "ref"> & React.RefAttributes<HTMLInputElement>>;
+declare const Radio: React__default.ForwardRefExoticComponent<Omit<TRadio, "ref"> & React__default.RefAttributes<HTMLInputElement>>;
 
 type TSelect = Omit<SelectProps, 'defaultValue'> & TDefaultFieldType & {
     options: {
@@ -470,15 +533,15 @@ type TSelect = Omit<SelectProps, 'defaultValue'> & TDefaultFieldType & {
         label: string;
     }[];
 };
-declare const Select: React.ForwardRefExoticComponent<Omit<TSelect, "ref"> & React.RefAttributes<HTMLSelectElement>>;
+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.ForwardRefExoticComponent<Omit<TSwitchbox, "ref"> & React.RefAttributes<HTMLInputElement>>;
+declare const Switchbox: React__default.ForwardRefExoticComponent<Omit<TSwitchbox, "ref"> & React__default.RefAttributes<HTMLInputElement>>;
 
 type TTextarea = TextareaProps & TDefaultFieldType;
-declare const Textarea: React.ForwardRefExoticComponent<Omit<TTextarea, "ref"> & React.RefAttributes<HTMLTextAreaElement>>;
+declare const Textarea: React__default.ForwardRefExoticComponent<Omit<TTextarea, "ref"> & React__default.RefAttributes<HTMLTextAreaElement>>;
 
 /**
  * Renderiza los errores del campo con el nombre pasado
@@ -491,7 +554,7 @@ declare const Textarea: React.ForwardRefExoticComponent<Omit<TTextarea, "ref"> &
  */
 declare const ValidationError: ({ name }: {
     name: string;
-}) => theme_ui_jsx_runtime.JSX.Element | null;
+}) => React.JSX.Element | null;
 
 declare function useFieldStatesClassNames<T = unknown>(name: string, formName?: string): string;
 
@@ -544,4 +607,4 @@ declare function useValidationClass<T>({ customValidation, validationClass, vali
     };
 };
 
-export { InnerCaptcha as Captcha, Checkbox, DeletableInput, FieldLabel, FieldWrapper, FileInput, Form, FormContext, IWrapper, Input, NumberInputf, Radio, Select, Switchbox, TCheckbox, TDefaultFieldType, TFieldLabel, TInput$1 as TInput, TOnValidate, TRadio, TSelect, TSwitchbox, TUseField, TValidationResult, Textarea, ValidationError, classToValidate, classToValidationFunction, hasSucceedFieldValidation, hasSucceedFormValidation, initValidations, useField, useFieldSelector, useFieldStatesClassNames, useFieldValue, useFormContext, useFormSelector, useValidationClass, validationsStore };
+export { InnerCaptcha as Captcha, Checkbox, DeletableInput, FieldWrapper, FileInput, Form, FormContext, IWrapper, Input, NumberInputf, Radio, Select, Switchbox, TCheckbox, TDefaultFieldType, TInput$1 as TInput, TOnValidate, TRadio, TSelect, TSwitchbox, TUseField, TValidationResult, Textarea, ValidationError, classToValidate, classToValidationFunction, hasSucceedFieldValidation, hasSucceedFormValidation, initValidations, useField, useFieldSelector, useFieldStatesClassNames, useFieldValue, useFormContext, useFormSelector, useValidationClass, validationsStore };