@apia/validations 2.0.7 → 2.0.9

package/dist/validationStore.d.ts

@@ -1,113 +0,0 @@
-import { TPropsSelector, TPropsComparator, TPropsConfiguration } from '@apia/util';
-import { TValidationField, TFormState, TRegisterField, TRegisterFieldOptions, TValidationResult } from './types.js';
-
-declare global {
-    interface Window {
-        MSG_WRONG_VALIDATION_NO_FOCUSED_FILE: string;
-    }
-}
-declare const validationsStore: {
-    activeForms: string[];
-    timeouts: Record<string, ReturnType<typeof setTimeout> | true>;
-    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>): void;
-    enableFormTouch(formName: string): void;
-    existsField: (formName: string, fieldName: string) => boolean;
-    makeFieldName(formName: string, fieldName: string): string;
-    makeFormName(formName: string): string;
-    resetForm(formName: string): void;
-    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;
-
-export { useFieldSelector, useFormSelector, validationsStore };
-//# sourceMappingURL=validationStore.d.ts.map

package/dist/validationStore.d.ts.map

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