react-hook-form-rules 1.0.7 → 1.0.9

package/README.md

@@ -0,0 +1,295 @@
+# React-hook-form-rules
+
+This is a small library that contains a few rules for clearer validation handling in the [react-hook-form](https://www.react-hook-form.com/) library.
+
+### Contacts
+
+Hello everyone 👋. 
+
+If you have any questions or suggestions, [my github profile](https://github.com/chopperqt). 
+
+
+
+## Rules
+
+### getRequiredRule
+
+#### Description
+This rule makes the field required.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| isRequired | boolean | true  |  |
+| message | string | "This field is required." |  . |
+
+#### Code example
+```
+import { getRequiredRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    required: getRequiredRule()
+  }}
+})
+
+```
+
+
+
+
+
+### getRequiredArrayRule
+
+#### Description
+This rule makes the array field required.
+
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| arr | array | []  |  |
+| message | string | "This field is required." |   |
+
+
+#### Code example
+```
+import { getRequiredArrayRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    validate: (arr) => getRequiredArrayRule(arr)
+  }}
+})
+```
+
+
+
+
+
+### getRequiredObjectRule
+
+#### Description
+This rule makes the object field required.
+
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| obj | object | {}  |  |
+| message | string | "This field is required." |   |
+
+
+#### Code example
+```
+import { getRequiredObjectRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    validate: (arr) => getRequiredObjectRule(arr)
+  }}
+})
+```
+
+
+
+
+### getMaxRule
+
+#### Description
+This rule returns an error if the number is greater than the specified value.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| max | number | -  | - |
+| message | string | - |  - |
+
+#### Code example
+```
+import { getMaxRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    max: getMaxRule(15)
+  }}
+})
+```
+
+
+
+
+### getMaxLengthRule
+
+#### Description
+This rule checks that the number of characters in the string does not exceed the specified value.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| maxLength | number | -  | - |
+| message | string | - |  - |
+
+### Code example
+```
+import { getMaxLengthRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    maxLength: getMaxLengthRule(15)
+  }}
+})
+```
+
+
+
+
+
+### getMaxArrayLengthRule
+
+#### Description
+This rule returns an error if the number of values in the array exceeds the specified limit.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| arr | arrray | -  | - |
+| maxLength | number | -  | - |
+| message | string | - |  - |
+
+#### Code example
+```
+import { getMaxArrayLengthRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    validate: (arr) =>  getMaxArrayLengthRule(arr, 15)
+  }}
+})
+```
+
+
+
+### getMinRule
+
+#### Description
+This rule checks that the string contains a minimum number of characters.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| min | number | -  | - |
+| message | string | - |  - |
+
+#### Code example
+```
+import { getMinRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    min: getMinRule(15)
+  }}
+})
+```
+
+
+
+
+### getMinLengthRule
+
+#### Description
+The rule checks that the string contains at least the specified number of characters.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| minLength | number | -  | - |
+| message | string | - |  - |
+
+#### Code example
+```
+import { getMinLengthRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    minLength: getMinLengthRule(15)
+  }}
+})
+```
+
+
+
+
+### getMinArrayLengthRule
+
+#### Description
+The rule checks that the array contains a minimum number of elements.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| arr | arrray | -  | - |
+| minLength | number | -  | - |
+| message | string | - |  - |
+
+#### Code example
+```
+import { getMinArrayLengthRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    validate: (arr) =>  getMinArrayLengthRule(arr, 15)
+  }}
+})
+```
+
+### getEmailRule
+
+#### Description
+he rule checks the entered email for correctness.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| pattern | RegExp | -  | - |
+| message | string | - |  - |
+
+#### Code example
+```
+import { getEmailRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    pattern: getEmailRule({})
+  }}
+})
+```
+
+
+
+
+### getUrlRule
+
+#### Description
+The rule checks the entered URL for correctness.
+
+#### Options
+| Option  | Type | Default | Description  |
+| -------- | --------- | ------ | ----------  |
+| pattern | RegExp | -  | - |
+| message | string | - |  - |
+
+#### Code example
+```
+import { getUrlRule } from 'react-hook-form-rules';
+
+const {...} = useController({
+  rules: {{ 
+    pattern: getUrlRule({})
+  }}
+})
+```
+
+
+
+

package/dist/index.d.ts

@@ -6,7 +6,7 @@ import { getMaxRule } from "./rules/get-max-rule";
 import { getMinLengthRule } from "./rules/get-min-length-rule";
 import { getMinRule } from "./rules/get-min-rule";
 import { getRequiredRule } from "./rules/get-require-rule";
-import { getRequiredArrayRule } from "./rules/get-required-array-role";
+import { getRequiredArrayRule } from "./rules/get-required-array-rule";
 import { getRequiredObjectRule } from "./rules/get-required-object-rule";
 import { getUrlRule } from "./rules/get-url-rule";
 export { getMaxRule, getRequiredObjectRule, getRequiredArrayRule, getEmailRule, getMaxLengthRule, getMaxArrayLengthRule, getMinArrayLengthRule, getMinLengthRule, getMinRule, getRequiredRule, getUrlRule, };

package/dist/index.js

@@ -17,8 +17,8 @@ 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_require_rule_1 = require("./rules/get-require-rule");
 Object.defineProperty(exports, "getRequiredRule", { enumerable: true, get: function () { return get_require_rule_1.getRequiredRule; } });
-const get_required_array_role_1 = require("./rules/get-required-array-role");
-Object.defineProperty(exports, "getRequiredArrayRule", { enumerable: true, get: function () { return get_required_array_role_1.getRequiredArrayRule; } });
+const get_required_array_rule_1 = require("./rules/get-required-array-rule");
+Object.defineProperty(exports, "getRequiredArrayRule", { enumerable: true, get: function () { return get_required_array_rule_1.getRequiredArrayRule; } });
 const get_required_object_rule_1 = require("./rules/get-required-object-rule");
 Object.defineProperty(exports, "getRequiredObjectRule", { enumerable: true, get: function () { return get_required_object_rule_1.getRequiredObjectRule; } });
 const get_url_rule_1 = require("./rules/get-url-rule");

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

@@ -1,16 +1,11 @@
-export interface MaxRuleProps {
-    max: number;
-    message?: string;
-}
 /**
  * Возвращает ошибку, если число, больше указанного.
- * @param options - Параметры.
- * @param options.max - Максимальное число
- * @param options.message - Кастомное сообщение.
+ * @param max - Максимальное число
+ * @param message - Кастомное сообщение.
  *
  * @example rules: { max: getMaxRule(20) }
  */
-export declare const getMaxRule: ({ max, message, }: MaxRuleProps) => {
+export declare const getMaxRule: (max: number, message?: string) => {
     value: number;
     message: string;
 };

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

@@ -3,13 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMaxRule = void 0;
 /**
  * Возвращает ошибку, если число, больше указанного.
- * @param options - Параметры.
- * @param options.max - Максимальное число
- * @param options.message - Кастомное сообщение.
+ * @param max - Максимальное число
+ * @param message - Кастомное сообщение.
  *
  * @example rules: { max: getMaxRule(20) }
  */
-const getMaxRule = ({ max, message, }) => ({
+const getMaxRule = (max, message) => ({
     value: max,
     message: message || `Максимальное значение ${max}.`,
 });

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

@@ -1,17 +1,11 @@
-interface RequiredRuleProps {
-    isRequired?: boolean;
-    message?: string;
-}
 /**
  * Валидирует обязательное поле.
- * @param options - Параметры.
- * @param options.isRequired - Динимический параметр, которые отвечает за то, что поле является обязательным.
- * @param options.message - Кастомное сообщение.
+ * @param isRequired - Динимический параметр, которые отвечает за то, что поле является обязательным.
+ * @param message - Кастомное сообщение.
  *
- * @example rules: { required: getRequiredRule({}) }
+ * @example rules: { required: getRequiredRule() }
  */
-export declare const getRequiredRule: ({ isRequired, message }: RequiredRuleProps) => {
+export declare const getRequiredRule: (isRequired?: boolean, message?: string) => {
     value: boolean;
     message: string;
 };
-export {};

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

@@ -4,13 +4,12 @@ exports.getRequiredRule = void 0;
 const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
 /**
  * Валидирует обязательное поле.
- * @param options - Параметры.
- * @param options.isRequired - Динимический параметр, которые отвечает за то, что поле является обязательным.
- * @param options.message - Кастомное сообщение.
+ * @param isRequired - Динимический параметр, которые отвечает за то, что поле является обязательным.
+ * @param message - Кастомное сообщение.
  *
- * @example rules: { required: getRequiredRule({}) }
+ * @example rules: { required: getRequiredRule() }
  */
-const getRequiredRule = ({ isRequired = true, message = REQUIRED_MESSAGE_TEXT }) => ({
+const getRequiredRule = (isRequired = true, message = REQUIRED_MESSAGE_TEXT) => ({
     value: isRequired,
     message,
 });

package/dist/rules/get-required-array-rule.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Валидирует массив, проверяет есть ли в нем значения
+ * @param arr - Массиов со значениями
+ * @param message - Кастомное сообщение.
+ *
+ * @example rules: { validate: (arr) => getRequiredArrrayRule(arr) }
+ */
+export declare const getRequiredArrayRule: (arr?: unknown[], message?: string) => string | true;

package/dist/rules/get-required-array-rule.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequiredArrayRule = void 0;
+const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+/**
+ * Валидирует массив, проверяет есть ли в нем значения
+ * @param arr - Массиов со значениями
+ * @param message - Кастомное сообщение.
+ *
+ * @example rules: { validate: (arr) => getRequiredArrrayRule(arr) }
+ */
+const getRequiredArrayRule = (arr = [], message) => {
+    return arr.length > 0 || (message || REQUIRED_MESSAGE_TEXT);
+};
+exports.getRequiredArrayRule = getRequiredArrayRule;

package/dist/rules/get-required-object-rule.d.ts

@@ -3,6 +3,6 @@
  * @param obj - Объект со значениями
  * @param message - Кастомное сообщение.
  *
- * @example rules: { validate: getRequiredObjectRule }
+ * @example rules: { validate: (obj) => getRequiredObjectRule(obj) }
  */
-export declare const getRequiredObjectRule: (obj: Record<string, unknown>, message?: string) => string | true;
+export declare const getRequiredObjectRule: (obj?: Record<string, unknown>, message?: string) => string | true;

package/dist/rules/get-required-object-rule.js

@@ -7,9 +7,9 @@ const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
  * @param obj - Объект со значениями
  * @param message - Кастомное сообщение.
  *
- * @example rules: { validate: getRequiredObjectRule }
+ * @example rules: { validate: (obj) => getRequiredObjectRule(obj) }
  */
-const getRequiredObjectRule = (obj, message) => {
+const getRequiredObjectRule = (obj = {}, message) => {
     var _a;
     const formattedMessage = message || REQUIRED_MESSAGE_TEXT;
     if (!obj) {

package/index.ts

@@ -7,7 +7,7 @@ import { getMaxRule } from "./rules/get-max-rule";
 import { getMinLengthRule } from "./rules/get-min-length-rule";
 import { getMinRule } from "./rules/get-min-rule";
 import { getRequiredRule } from "./rules/get-require-rule";
-import { getRequiredArrayRule } from "./rules/get-required-array-role";
+import { getRequiredArrayRule } from "./rules/get-required-array-rule";
 import { getRequiredObjectRule } from "./rules/get-required-object-rule";
 import { getUrlRule } from "./rules/get-url-rule";
 

package/package.json

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

package/rules/get-max-rule.ts

@@ -1,20 +1,11 @@
-export interface MaxRuleProps {
-  max: number
-  message?: string
-}
-
 /**
  * Возвращает ошибку, если число, больше указанного.
- * @param options - Параметры.
- * @param options.max - Максимальное число
- * @param options.message - Кастомное сообщение.
+ * @param max - Максимальное число
+ * @param message - Кастомное сообщение.
  * 
  * @example rules: { max: getMaxRule(20) }
  */
-export const getMaxRule = ({
-  max,
-  message,
-}: MaxRuleProps) => ({
+export const getMaxRule = (max: number, message?: string) => ({
   value: max,
   message: message || `Максимальное значение ${max}.`,
 })

package/rules/get-require-rule.ts

@@ -1,22 +1,16 @@
 const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
 
-interface RequiredRuleProps {
-  isRequired?: boolean
-  message?: string
-}
-
 /**
  * Валидирует обязательное поле.
- * @param options - Параметры.
- * @param options.isRequired - Динимический параметр, которые отвечает за то, что поле является обязательным.
- * @param options.message - Кастомное сообщение.
+ * @param isRequired - Динимический параметр, которые отвечает за то, что поле является обязательным.
+ * @param message - Кастомное сообщение.
  * 
- * @example rules: { required: getRequiredRule({}) }
+ * @example rules: { required: getRequiredRule() }
  */
-export const getRequiredRule = ({
+export const getRequiredRule = (
   isRequired = true,
   message = REQUIRED_MESSAGE_TEXT
-}: RequiredRuleProps) => ({
+) => ({
   value: isRequired,
   message,
 })

package/rules/{get-required-array-role.ts → get-required-array-rule.ts}

@@ -2,11 +2,11 @@ const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
 
 /**
  * Валидирует массив, проверяет есть ли в нем значения
- * @param value - Массиов со значениями
+ * @param arr - Массиов со значениями
  * @param message - Кастомное сообщение.
  * 
- * @example rules: { validate: getRequiredArrrayRule }
+ * @example rules: { validate: (arr) => getRequiredArrrayRule(arr) }
  */
-export const getRequiredArrayRule = (arr: unknown[], message?: string) => {
+export const getRequiredArrayRule = (arr: unknown[] = [], message?: string) => {
   return arr.length > 0 || (message || REQUIRED_MESSAGE_TEXT);
 };

package/rules/get-required-object-rule.ts

@@ -5,9 +5,9 @@ const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
  * @param obj - Объект со значениями
  * @param message - Кастомное сообщение.
  * 
- * @example rules: { validate: getRequiredObjectRule }
+ * @example rules: { validate: (obj) => getRequiredObjectRule(obj) }
  */
-export const getRequiredObjectRule = (obj: Record<string, unknown>, message?: string) => {
+export const getRequiredObjectRule = (obj: Record<string, unknown> = {}, message?: string) => {
   const formattedMessage = message || REQUIRED_MESSAGE_TEXT;
 
   if (!obj) {