react-hook-form-rules 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -1 +1,8 @@
-export declare function add(x: number, y: number): number;
+import { getRequiredRule } from "./rules/get-require-rule";
+import { getEmailRule } from "./rules/get-email-rule";
+import { getMaxArrayLengthRule } from "./rules/get-max-array-length";
+import { getMinLengthRule } from "./rules/get-min-length-rule";
+import { getMinArrayLengthRule } from "./rules/get-min-array-length";
+import { getMinRule } from "./rules/get-min-rule";
+import { getUrlRule } from "./rules/get-url-rule";
+export { getEmailRule, getMaxArrayLengthRule, getMinArrayLengthRule, getMinLengthRule, getMinRule, getRequiredRule, getUrlRule, };

package/dist/index.js

@@ -1,6 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.add = add;
-function add(x, y) {
-    return x + y;
-}
+exports.getUrlRule = exports.getRequiredRule = exports.getMinRule = exports.getMinLengthRule = exports.getMinArrayLengthRule = exports.getMaxArrayLengthRule = exports.getEmailRule = void 0;
+const get_require_rule_1 = require("./rules/get-require-rule");
+Object.defineProperty(exports, "getRequiredRule", { enumerable: true, get: function () { return get_require_rule_1.getRequiredRule; } });
+const get_email_rule_1 = require("./rules/get-email-rule");
+Object.defineProperty(exports, "getEmailRule", { enumerable: true, get: function () { return get_email_rule_1.getEmailRule; } });
+const get_max_array_length_1 = require("./rules/get-max-array-length");
+Object.defineProperty(exports, "getMaxArrayLengthRule", { enumerable: true, get: function () { return get_max_array_length_1.getMaxArrayLengthRule; } });
+const get_min_length_rule_1 = require("./rules/get-min-length-rule");
+Object.defineProperty(exports, "getMinLengthRule", { enumerable: true, get: function () { return get_min_length_rule_1.getMinLengthRule; } });
+const get_min_array_length_1 = require("./rules/get-min-array-length");
+Object.defineProperty(exports, "getMinArrayLengthRule", { enumerable: true, get: function () { return get_min_array_length_1.getMinArrayLengthRule; } });
+const get_min_rule_1 = require("./rules/get-min-rule");
+Object.defineProperty(exports, "getMinRule", { enumerable: true, get: function () { return get_min_rule_1.getMinRule; } });
+const get_url_rule_1 = require("./rules/get-url-rule");
+Object.defineProperty(exports, "getUrlRule", { enumerable: true, get: function () { return get_url_rule_1.getUrlRule; } });

package/dist/rules/get-email-rule.d.ts

@@ -0,0 +1,13 @@
+interface EmailRule {
+    pattern?: RegExp;
+    message?: string;
+}
+/**
+ * Валидирует адресс электронной почты.
+ * @example getEmailRule()
+ */
+export declare const getEmailRule: ({ pattern, message, }: EmailRule) => {
+    pattern: RegExp;
+    message: string;
+};
+export {};

package/dist/rules/get-email-rule.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEmailRule = void 0;
+const DEFAULT_PATTERN = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/;
+const DEFAULT_MESSAGE = "Пожалуйста, проверьте правильность введенного адреса электронной почты.";
+/**
+ * Валидирует адресс электронной почты.
+ * @example getEmailRule()
+ */
+const getEmailRule = ({ pattern = DEFAULT_PATTERN, message = DEFAULT_MESSAGE, }) => {
+    return {
+        pattern,
+        message,
+    };
+};
+exports.getEmailRule = getEmailRule;

package/dist/rules/get-max-array-length.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Валидирует массив, на максимальное кол-во значений
+ * @param value - Массиов со значениями
+ * @example getMaxArrayLengthRule(2, "Максимальное кол-во значений - 2")
+ */
+export declare const getMaxArrayLengthRule: (max: number, message: string) => {
+    validator(_: unknown, value: unknown[]): Promise<void>;
+};

package/dist/rules/get-max-array-length.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMaxArrayLengthRule = void 0;
+/**
+ * Валидирует массив, на максимальное кол-во значений
+ * @param value - Массиов со значениями
+ * @example getMaxArrayLengthRule(2, "Максимальное кол-во значений - 2")
+ */
+const getMaxArrayLengthRule = (max, message) => ({
+    validator(_, value) {
+        if ((value === null || value === void 0 ? void 0 : value.length) > max) {
+            return Promise.reject(message);
+        }
+        return Promise.resolve();
+    }
+});
+exports.getMaxArrayLengthRule = getMaxArrayLengthRule;

package/dist/rules/get-min-array-length.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Валидирует массив, на минимальное кол-во значений
+ * @param value - Массиов со значениями
+ * @param message - Кастомное сообщение.
+ * @example getMinArrayLengthRule(2, "Максимальное кол-во значений - 2")
+ */
+export declare const getMinArrayLengthRule: (min: number, message: string) => {
+    validator(_: unknown, value: unknown[]): Promise<void>;
+};

package/dist/rules/get-min-array-length.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMinArrayLengthRule = void 0;
+/**
+ * Валидирует массив, на минимальное кол-во значений
+ * @param value - Массиов со значениями
+ * @param message - Кастомное сообщение.
+ * @example getMinArrayLengthRule(2, "Максимальное кол-во значений - 2")
+ */
+const getMinArrayLengthRule = (min, message) => ({
+    validator(_, value) {
+        if ((value === null || value === void 0 ? void 0 : value.length) < min) {
+            return Promise.reject(message);
+        }
+        return Promise.resolve();
+    }
+});
+exports.getMinArrayLengthRule = getMinArrayLengthRule;

package/dist/rules/get-min-length-rule.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Проверка минимальное кол-во символов в поле.
+ * @param len - Кол-во
+ * @param message - Сообщение.
+ * @example getMinLength(3)
+ */
+export declare const getMinLengthRule: (len: number, message?: string) => {
+    len: number;
+    message: string;
+};

package/dist/rules/get-min-length-rule.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMinLengthRule = void 0;
+/**
+ * Проверка минимальное кол-во символов в поле.
+ * @param len - Кол-во
+ * @param message - Сообщение.
+ * @example getMinLength(3)
+ */
+const getMinLengthRule = (len, message) => {
+    return {
+        len,
+        message: message || getMinLengthError(length),
+    };
+};
+exports.getMinLengthRule = getMinLengthRule;

package/dist/rules/get-min-rule.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Валидирует минимальное значение.
+ * @param min - Минимальное значение.
+ * @param message - Сообщение.
+ */
+export declare const getMinRule: (min: number, message?: string) => {
+    type: any;
+    min: number;
+    message: string;
+};

package/dist/rules/get-min-rule.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMinRule = void 0;
+/**
+ * Валидирует минимальное значение.
+ * @param min - Минимальное значение.
+ * @param message - Сообщение.
+ */
+const getMinRule = (min, message) => {
+    return {
+        type: 'number',
+        min,
+        message: message || getMinError(min),
+    };
+};
+exports.getMinRule = getMinRule;

package/dist/rules/get-require-rule.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Делает поле обязательным.
+ * @param isRequired - Статус обазательного поля.
+ * @param message - Кастомное сообщение об ошибке.
+ * @example getRequired(true)
+ */
+export declare const getRequiredRule: (isRequired?: boolean, message?: string) => {
+    required: boolean;
+    message: string;
+};

package/dist/rules/get-require-rule.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequiredRule = void 0;
+/**
+ * Делает поле обязательным.
+ * @param isRequired - Статус обазательного поля.
+ * @param message - Кастомное сообщение об ошибке.
+ * @example getRequired(true)
+ */
+const getRequiredRule = (isRequired = true, message) => {
+    const formattedMessage = message || "Это поле обязательное.";
+    return {
+        required: isRequired,
+        message: formattedMessage,
+    };
+};
+exports.getRequiredRule = getRequiredRule;

package/dist/rules/get-url-rule.d.ts

@@ -0,0 +1,12 @@
+interface UrlRule {
+    message?: string;
+    pattern?: RegExp;
+}
+/**
+ * Валидирует поле с сылкой.
+ */
+export declare const getUrlRule: ({ message, pattern, }: UrlRule) => {
+    message: string;
+    pattern: RegExp;
+};
+export {};

package/dist/rules/get-url-rule.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUrlRule = void 0;
+const DEFAULT_MESSAGE = "Ссылка не соответствует формату";
+const DEFAULT_PATTERN = /(http(s)?):\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
+/**
+ * Валидирует поле с сылкой.
+ */
+const getUrlRule = ({ message = DEFAULT_MESSAGE, pattern = DEFAULT_PATTERN, }) => {
+    return {
+        message,
+        pattern,
+    };
+};
+exports.getUrlRule = getUrlRule;

package/dist/rules/helpers/get-min-error.d.ts

@@ -0,0 +1,6 @@
+declare const MIN_TEXT = "\u041C\u0438\u043D\u0438\u043C\u0430\u043B\u044C\u043D\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435 ";
+/**
+* Генирирует сообщение об ошибке.
+* @param min - Минимальное значение.
+*/
+declare const getMinError: (min: number) => string;

package/dist/rules/helpers/get-min-error.js

@@ -0,0 +1,9 @@
+"use strict";
+const MIN_TEXT = 'Минимальное значение ';
+/**
+* Генирирует сообщение об ошибке.
+* @param min - Минимальное значение.
+*/
+const getMinError = (min) => {
+    return `${MIN_TEXT}${min}`;
+};

package/dist/rules/helpers/get-min-length-error.d.ts

@@ -0,0 +1,6 @@
+declare const MIN_LENGTH_TEXT = "\u041C\u0438\u043D\u0438\u043C\u0430\u043B\u044C\u043D\u043E\u0435 \u043A\u043E\u043B-\u0432\u043E \u0441\u0438\u043C\u0432\u043E\u043B\u043E\u0432 ";
+/**
+ * Генерирует сообщение об ошибке.
+ * @param length - Количество символов.
+ */
+declare const getMinLengthError: (length: number) => string;

package/dist/rules/helpers/get-min-length-error.js

@@ -0,0 +1,9 @@
+"use strict";
+const MIN_LENGTH_TEXT = 'Минимальное кол-во символов ';
+/**
+ * Генерирует сообщение об ошибке.
+ * @param length - Количество символов.
+ */
+const getMinLengthError = (length) => {
+    return `${MIN_LENGTH_TEXT}${length}.`;
+};

package/index.ts

@@ -1,3 +1,17 @@
-export function add(x: number, y: number) {
-  return x + y;
+import { getRequiredRule } from "./rules/get-require-rule";
+import { getEmailRule } from "./rules/get-email-rule";
+import { getMaxArrayLengthRule } from "./rules/get-max-array-length";
+import { getMinLengthRule } from "./rules/get-min-length-rule";
+import { getMinArrayLengthRule } from "./rules/get-min-array-length";
+import { getMinRule } from "./rules/get-min-rule";
+import { getUrlRule } from "./rules/get-url-rule";
+
+export {
+  getEmailRule,
+  getMaxArrayLengthRule,
+  getMinArrayLengthRule,
+  getMinLengthRule,
+  getMinRule,
+  getRequiredRule,
+  getUrlRule,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hook-form-rules",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/rules/get-email-rule.ts

@@ -0,0 +1,21 @@
+const DEFAULT_PATTERN = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/
+const DEFAULT_MESSAGE = "Пожалуйста, проверьте правильность введенного адреса электронной почты."
+
+interface EmailRule {
+  pattern?: RegExp
+  message?: string
+}
+
+/**
+ * Валидирует адресс электронной почты.
+ * @example getEmailRule()
+ */
+export const getEmailRule = ({
+  pattern = DEFAULT_PATTERN,
+  message = DEFAULT_MESSAGE,
+}: EmailRule) => {
+  return {
+    pattern,
+    message,
+  }
+}

package/rules/get-max-array-length.ts

@@ -0,0 +1,15 @@
+/**
+ * Валидирует массив, на максимальное кол-во значений 
+ * @param value - Массиов со значениями
+ * @example getMaxArrayLengthRule(2, "Максимальное кол-во значений - 2")
+ */
+export const getMaxArrayLengthRule = (max: number, message: string) => ({
+  validator(_: unknown, value: unknown[]) {
+    if (value?.length > max) {
+      return Promise.reject(message)
+    }
+
+
+    return Promise.resolve()
+  }
+})

package/rules/get-min-array-length.ts

@@ -0,0 +1,16 @@
+/**
+ * Валидирует массив, на минимальное кол-во значений 
+ * @param value - Массиов со значениями
+ * @param message - Кастомное сообщение.
+ * @example getMinArrayLengthRule(2, "Максимальное кол-во значений - 2")
+ */
+export const getMinArrayLengthRule = (min: number, message: string) => ({
+  validator(_: unknown, value: unknown[]) {
+    if (value?.length < min) {
+      return Promise.reject(message)
+    }
+
+
+    return Promise.resolve()
+  }
+})

package/rules/get-min-length-rule.ts

@@ -0,0 +1,12 @@
+/**
+ * Проверка минимальное кол-во символов в поле.
+ * @param len - Кол-во
+ * @param message - Сообщение.
+ * @example getMinLength(3)
+ */
+export const getMinLengthRule = (len: number, message?: string) => {
+  return {
+    len,
+    message: message || getMinLengthError(length),
+  }
+}

package/rules/get-min-rule.ts

@@ -0,0 +1,12 @@
+/**
+ * Валидирует минимальное значение.
+ * @param min - Минимальное значение.
+ * @param message - Сообщение.
+ */
+export const getMinRule = (min: number, message?: string) => {
+  return {
+    type: 'number' as any,
+    min,
+    message: message || getMinError(min),
+  }
+}

package/rules/get-require-rule.ts

@@ -0,0 +1,14 @@
+/**
+ * Делает поле обязательным.
+ * @param isRequired - Статус обазательного поля.
+ * @param message - Кастомное сообщение об ошибке.
+ * @example getRequired(true)
+ */
+export const getRequiredRule = (isRequired = true, message?: string) => {
+  const formattedMessage = message || "Это поле обязательное.";
+
+  return {
+    required: isRequired,
+    message: formattedMessage,
+  }
+}

package/rules/get-url-rule.ts

@@ -0,0 +1,20 @@
+const DEFAULT_MESSAGE = "Ссылка не соответствует формату"
+const DEFAULT_PATTERN = /(http(s)?):\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/
+
+interface UrlRule {
+  message?: string
+  pattern?: RegExp
+}
+
+/**
+ * Валидирует поле с сылкой.
+ */
+export const getUrlRule = ({
+  message = DEFAULT_MESSAGE,
+  pattern = DEFAULT_PATTERN,
+}: UrlRule) => {
+  return {
+    message,
+    pattern,
+  };
+};

package/rules/helpers/get-min-error.ts

@@ -0,0 +1,9 @@
+const MIN_TEXT = 'Минимальное значение '
+
+/**
+* Генирирует сообщение об ошибке.
+* @param min - Минимальное значение.
+*/
+const getMinError = (min: number) => {
+  return `${MIN_TEXT}${min}`
+}

package/rules/helpers/get-min-length-error.ts

@@ -0,0 +1,9 @@
+const MIN_LENGTH_TEXT = 'Минимальное кол-во символов '
+
+/**
+ * Генерирует сообщение об ошибке.
+ * @param length - Количество символов.
+ */
+const getMinLengthError = (length: number) => {
+  return `${MIN_LENGTH_TEXT}${length}.`
+}