@apia/validations 0.3.6 → 1.0.0

package/cleanDist.json

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

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import * as React from 'react';
-import React__default from 'react';
-import { TModify, TPropsSelector, TPropsComparator, TPropsConfiguration } from '@apia/util';
+import React__default, { FC } from 'react';
+import { TModify, TPropsSelector, TPropsComparator, TPropsConfiguration, EventEmitter } from '@apia/util';
+import { TOpenModal, TNumberInput } from '@apia/components';
 import { BoxProps, ButtonProps, InputProps, RadioProps, SelectProps, SwitchProps, TextareaProps } from '@apia/theme';
-import { TNumberInput } from '@apia/components';
 
 declare const formcheckLanguage: {
     required: string;
@@ -84,6 +84,7 @@ 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.
@@ -131,7 +132,7 @@ type TValidationField<ValueType = any, SubmitValueType = ValueType> = {
      * Permite pasar una serie de reglas que el campo debe cumplir
      * al validar.
      */
-    validationRules?: IFieldDefinition['validate'];
+    validationRules?: TValidationRules;
     validationValueParser?: TValidationValueParser<ValueType>;
     value: ValueType;
 };
@@ -388,6 +389,11 @@ declare function hasSucceedFieldValidation(result: TFieldValidationResult): resu
  * 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'];
 /**
@@ -397,6 +403,68 @@ declare function classToValidate(className: string): IFieldDefinition['validate'
  */
 declare function initValidations(): Promise<void>;
 
+declare abstract class CollectorField<ValueType = any> extends EventEmitter<{
+    rulesUpdate: TValidationRules;
+}> {
+    #private;
+    protected _name: string;
+    protected label: string;
+    abstract Component: FC;
+    abstract type: string;
+    constructor(_name: string, label: string);
+    get name(): string;
+    protected initialValue: ValueType;
+    setInitialValue: (newValue: ValueType) => void;
+    setValidationRules: (newRules: TValidationRules) => void;
+    protected useValidationRules: () => Partial<Omit<Record<"number" | "required" | "alpha" | "alphanum" | "nodigit" | "digit" | "digitmin" | "digitltd" | "email" | "image" | "phone" | "url" | "confirm" | "differs" | "length_str" | "length_fix" | "lengthmax" | "lengthmin" | "words_min" | "words_max" | "words_range" | "checkbox" | "checkboxes_group" | "radios" | "select" | "select_multiple" | "errorsTitle", boolean>, "digitmin" | "digitltd" | "confirm" | "differs" | "length_str" | "length_fix" | "words_min" | "words_max" | "words_range" | "checkboxes_group"> & {
+        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: string | RegExp;
+        digitmax: number;
+        validName?: string | undefined;
+        maxLength: number;
+        minLength: number;
+        min: number;
+        max: number;
+    }> | undefined;
+}
+declare class CollectorInput extends CollectorField<string> {
+    type: string;
+    Component: () => React.JSX.Element;
+}
+declare class CollectorLabel extends CollectorField {
+    private kind;
+    private static maxId;
+    type: string;
+    constructor(label: string, kind?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'label');
+    Component: () => React.JSX.Element;
+}
+declare class CollectorTextarea extends CollectorField<string> {
+    type: string;
+    Component: () => React.JSX.Element;
+}
+declare class Collector {
+    #private;
+    fields: {
+        input: typeof CollectorInput;
+        label: typeof CollectorLabel;
+        textarea: typeof CollectorTextarea;
+    };
+    private id;
+    add: (field: CollectorField) => void;
+    show: <FormValues extends Record<string, unknown>>(modalProps?: Partial<Omit<TOpenModal, 'children'>>) => Promise<FormValues>;
+}
+
 type TUseField<ValueType = unknown, SubmitValueType = ValueType> = Omit<TValidationField<ValueType, SubmitValueType>, 'error' | 'value' | 'isTouched'> & {
     /**
      * Con esta propiedad es posible evitar que el campo
@@ -608,4 +676,4 @@ declare function useValidationClass<T>({ customValidation, formName, name, valid
     };
 };
 
-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 };
+export { InnerCaptcha as Captcha, Checkbox, Collector, DeletableInput, FieldWrapper, FileInput, Form, FormContext, IWrapper, Input, NumberInputf, Radio, Select, Switchbox, TCheckbox, TDefaultFieldType, TInput$1 as TInput, TOnValidate, TRadio, TSelect, TSwitchbox, TUseField, TValidationResult, TValidationRules, Textarea, ValidationError, classToValidate, classToValidationFunction, hasSucceedFieldValidation, hasSucceedFormValidation, initValidations, lang, useField, useFieldSelector, useFieldStatesClassNames, useFieldValue, useFormContext, useFormSelector, useValidationClass, validationsStore };