@apia/validations 2.0.9 → 2.0.11

package/dist/hooks/useField.d.ts

@@ -0,0 +1,76 @@
+import React__default from 'react';
+import { TValidationField } from '../types.js';
+
+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;
+};
+
+export { type TUseField, useField };
+//# sourceMappingURL=useField.d.ts.map

package/dist/hooks/useField.d.ts.map

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

package/dist/hooks/useFieldStatesClassNames.d.ts

@@ -0,0 +1,4 @@
+declare function useFieldStatesClassNames<T = unknown>(name: string, formName?: string): string;
+
+export { useFieldStatesClassNames };
+//# sourceMappingURL=useFieldStatesClassNames.d.ts.map

package/dist/hooks/useFieldStatesClassNames.d.ts.map

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

package/dist/hooks/useFieldValue.d.ts

@@ -0,0 +1,8 @@
+interface IUseFieldValue {
+    formName?: string;
+    name: string;
+}
+declare function useFieldValue<T = unknown>({ formName, name }: IUseFieldValue): T;
+
+export { useFieldValue };
+//# sourceMappingURL=useFieldValue.d.ts.map

package/dist/hooks/useFieldValue.d.ts.map

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

package/dist/hooks/useValidationClass.d.ts

@@ -0,0 +1,49 @@
+import { TDefaultFieldType } from '../components/types.js';
+import { TValidationFunction } from '../types.js';
+
+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 { useValidationClass };
+//# sourceMappingURL=useValidationClass.d.ts.map

package/dist/hooks/useValidationClass.d.ts.map

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