form-father 0.2.8 → 0.2.10

package/{index.d.ts → dist/index.d.ts}

@@ -24,12 +24,75 @@ declare function registerValidator(name: string, fn: ValidatorFn, defaultMessage
 declare const getValidator: (name: string) => Validator | undefined;
 declare function getAllValidators(): Map<string, Validator>;
 
+/**
+ * Находит родительский элемент по заданому селектору.
+ *
+ * @param {HTMLElement | null} $el - Элемент, чего родителя нужно найти.
+ * @param {string} selector - Селектор родителя.
+ *
+ * @returns {HTMLElement | null} Элемент родителя. Но если родителя с таким селектори не было найдено возвращается null.
+ */
+declare function closest($el: HTMLElement | null, selector: string): HTMLElement | null;
+/** Включает блокировку скролла страницы */
+declare function blockScrollBody(): void;
+/** Отменяет блокировку скролла страницы */
+declare function unblockScrollBody(): void;
+/**
+ * Проверяет является ли строка валидным адресом электронной почты.
+ *
+ * @param {string} value - Строка, которую нужно проверить.
+ *
+ * @returns {boolean} Является ли строка валидным адресом электронной почты true/false.
+ */
+declare function isEmailValid(value: string): boolean;
+/**
+ * Проверяет является ли строка валидным url.
+ *
+ * @param {string} originalUrlString - Строка, которую нужно проверить.
+ *
+ * @returns {boolean} Является ли строка валидным url адресом true/false.
+ */
+declare function isUrlValid(originalUrlString: string): boolean;
+/**
+ * Проверяет является ли строка валидным номером телефона.
+ *
+ * @param {string} value - Строка, которую нужно проверить.
+ *
+ * @returns {boolean} Является ли строка валидным номером телефона true/false.
+ */
+declare function isPhoneValid(value: string): boolean;
+/**
+ * Кастомная сериализация формы в объект FormData.
+ *
+ * @param {HTMLElement} $element - DOM элемент для сериализации.
+ *
+ * @returns {FormData} Сериализованные данные формы в объекте FormData.
+ */
+declare function serializeToFormData($element: HTMLElement): FormData;
+/**
+ * Функция для разбора общих свойств ответа.
+ *
+ * @param {any} responseBody - Тело ответа.
+ */
+declare function parseCommonResponseProperties(responseBody: any): void;
+/**
+ * Сериализует данные формы в объект JSON.
+ *
+ * @param {HTMLFormElement} form - Элемент формы.
+ *
+ * @returns {Object} Сериализованные данные формы.
+ */
+declare function serializeFormToJSON(form: HTMLFormElement): {
+    [key: string]: any;
+};
+
+type ValidationRule = string | {
+    rule: string;
+    params?: any;
+};
 type ValidationSchema = Record<string, {
-    rules: (string | {
-        rule: string;
-        params?: any;
-    })[];
-    selector: string;
+    rules: ValidationRule[];
+    selector?: string;
     messages?: Record<string, string>;
 }>;
 /** Параметры формы. */
@@ -59,21 +122,21 @@ interface FormOptions {
      * @param responseBody - Тело ответа.
      * @param formInstance - Инстанс формы.
      */
-    onResponse?: (responseBody: any, formInstance: Form) => void;
+    onResponse?: (responseBody: ResponseBody, formInstance: Form) => void;
     /**
-     * Функция обратного вызова. Запускается после ответа сервера 200.
+     * Функция обратного вызова. Запускается после успешного HTTP-ответа и `success: true`.
      *
      * @param responseBody - Тело ответа.
      * @param formInstance - Инстанс формы.
      */
-    onResponseSuccess?: (responseBody: any, formInstance: Form) => void;
+    onResponseSuccess?: (responseBody: ResponseBody, formInstance: Form) => void;
     /**
-     * Функция обратного вызова. Запускается после ответа сервера не 200.
+     * Функция обратного вызова. Запускается после неуспешного HTTP-ответа или `success !== true`.
      *
      * @param responseBody - Тело ответа.
      * @param formInstance - Инстанс формы.
      */
-    onResponseUnsuccess?: (responseBody: any, formInstance: Form) => void;
+    onResponseUnsuccess?: (responseBody: ResponseBody, formInstance: Form) => void;
     /** Нужно ли показывать loader в кнопке. По умолчанию `true`. */
     showLoaderButton?: boolean;
     /** Нужно ли проскроливать до первого по порядку элемента с ошибкой. По умолчанию `true`. */
@@ -96,6 +159,17 @@ interface FormOptions {
     /** Схема валидации: поле → массив правил + override-сообщения */
     validationSchema?: ValidationSchema;
 }
+interface ErrorResponse {
+    name: string;
+    'error-msg': string;
+}
+interface ResponseBody {
+    [key: string]: any;
+    success?: boolean;
+    error?: boolean;
+    'error-msg'?: string;
+    errors?: ErrorResponse[];
+}
 /**
  * Реализует форму отправки данных.
  *
@@ -120,7 +194,7 @@ declare class Form {
      * @param {HTMLElement} $el - Элемент формы (тег form!).
      * @param {Object} options - Параметры формы.
      */
-    constructor($el: HTMLElement, options: FormOptions);
+    constructor($el: HTMLElement, options?: FormOptions);
     getOptions(): FormOptions;
     /**
      * Обновляет параметры по умолчанию для настроек формы. Метод объединяет переданные параметры с уже существующими
@@ -197,8 +271,19 @@ declare class Form {
      * @returns {boolean} Корректны данные или нет (true/false).
      */
     private isCorrectArguments;
+    private formDataToObject;
+    private appendFormDataValue;
+    private objectToFormData;
+    private stringifyFormDataValue;
+    private formDataToUrlSearchParams;
+    private formDataToTextBody;
+    private isBodylessMethod;
+    private appendQueryString;
+    private findFieldByName;
+    private parseResponseBody;
+    private handleUnsuccessfulResponse;
     private sendData;
     private submit;
 }
 
-export { type ValidatorEffectCtx, type ValidatorResult, Form as default, getAllValidators, getValidator, registerValidator };
+export { type ErrorResponse, type FormOptions, type ResponseBody, type ValidationRule, type ValidationSchema, type ValidatorEffectCtx, type ValidatorResult, blockScrollBody, closest, Form as default, getAllValidators, getValidator, isEmailValid, isPhoneValid, isUrlValid, parseCommonResponseProperties, registerValidator, serializeFormToJSON, serializeToFormData, unblockScrollBody };