@apia/validations 0.0.9-alpha.0 → 0.1.0

package/cleanDist.json

@@ -0,0 +1,3 @@
+{
+  "cleanDist": 0.7200462826014478
+}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as theme_ui_jsx_runtime from 'theme-ui/jsx-runtime';
 import React from 'react';
-import { TModify, TId } from '@apia/util';
+import { TModify, TPropsSelector, TPropsComparator, TPropsConfiguration } from '@apia/util';
 import { BoxProps, ButtonProps, InputProps, LabelProps, RadioProps, SelectProps, SwitchProps, TextareaProps } from 'theme-ui';
 import { TNumberInput } from '@apia/components';
 
@@ -192,56 +192,6 @@ interface IForm<ValueType extends Record<string, unknown>, SubmitValueType exten
      */
     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> {
@@ -266,61 +216,6 @@ declare const FormContext: React.Context<IFormContext<Record<string, unknown>, R
  */
 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>;
@@ -514,13 +409,14 @@ declare function useField<ValueType = unknown, SubmitValueType = ValueType>(fiel
 };
 
 interface IWrapper extends BoxProps {
-    name: string;
-    label?: string;
+    avoidSemicolon?: boolean;
     children: React.ReactNode;
+    label?: string;
+    name: string;
     required?: boolean;
-    avoidSemicolon?: boolean;
+    type?: 'checkbox';
 }
-declare const FieldWrapper: ({ name, label, avoidSemicolon, children, className, as, ...props }: IWrapper) => theme_ui_jsx_runtime.JSX.Element;
+declare const FieldWrapper: ({ name, label, avoidSemicolon, children, className, as, type, ...props }: IWrapper) => theme_ui_jsx_runtime.JSX.Element;
 
 type TDefaultFieldType<ValueType = string> = Omit<TUseField<ValueType>, 'error' | 'value' | 'isTouched'> & {
     label?: string;
@@ -528,7 +424,15 @@ type TDefaultFieldType<ValueType = string> = Omit<TUseField<ValueType>, 'error'
     validationClass?: string;
 } & Pick<IWrapper, 'avoidSemicolon'>;
 
-type TCheckbox = Omit<ButtonProps, 'onChange'> & Pick<InputProps, 'onChange'> & TDefaultFieldType & {
+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) => theme_ui_jsx_runtime.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>>;
@@ -560,7 +464,7 @@ type TRadio = RadioProps & TDefaultFieldType & {
 };
 declare const Radio: React.ForwardRefExoticComponent<Omit<TRadio, "ref"> & React.RefAttributes<HTMLInputElement>>;
 
-type TSelect = SelectProps & TDefaultFieldType & {
+type TSelect = Omit<SelectProps, 'defaultValue'> & TDefaultFieldType & {
     options: {
         value: string;
         label: string;
@@ -640,4 +544,5 @@ declare function useValidationClass<T>({ customValidation, validationClass, vali
     };
 };
 
-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 };
+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 };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}