@apia/validations 3.0.1 → 3.0.2

package/dist/types.d.ts

@@ -1,130 +0,0 @@
-import { TModify } from '@apia/util';
-import formcheckLanguage from './lang/es.js';
-
-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'];
-/**
- * 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 | 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>;
-}>;
-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'>;
-
-export type { IFieldDefinition, TFieldValidationResult, TFormState, TPromiseOrNot, TRegisterField, TRegisterFieldOptions, TRegisterFormOptions, TSuccessfulValidation, TValidate, TValidationField, TValidationFunction, TValidationResult, TValidationRules, TValidationSubmitValueParser, TValidationValueParser, TWrongValidation };
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

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

package/dist/util.d.ts

@@ -1,36 +0,0 @@
-import { TFieldValidationResult, TValidationResult, TSuccessfulValidation, TValidationField, IFieldDefinition } from './types.js';
-import formcheckLanguage from './lang/es.js';
-
-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>;
-
-export { classToValidate, classToValidationFunction, hasSucceedFieldValidation, hasSucceedFormValidation, initValidations, lang };
-//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

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

package/dist/validationStore.d.ts

@@ -1,112 +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;
-    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":""}