react-hook-form-rules 1.0.8 → 1.0.10

package/README.md

@@ -1,15 +1,29 @@
-## getRequiredRule
+# react-hook-form-rules
 
-### Description
+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
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | isRequired | boolean | true  |  |
 | message | string | "This field is required." |  . |
 
-### Code example
+#### Code example
 ```
 import { getRequiredRule } from 'react-hook-form-rules';
 
@@ -25,20 +39,20 @@ const {...} = useController({
 
 
 
-## getRequiredArrayRule
+### getRequiredArrayRule
 
-### Description
+#### Description
 This rule makes the array field required.
 
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | arr | array | []  |  |
 | message | string | "This field is required." |   |
 
 
-### Code example
+#### Code example
 ```
 import { getRequiredArrayRule } from 'react-hook-form-rules';
 
@@ -53,20 +67,20 @@ const {...} = useController({
 
 
 
-## getRequiredObjectRule
+### getRequiredObjectRule
 
-### Description
+#### Description
 This rule makes the object field required.
 
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | obj | object | {}  |  |
 | message | string | "This field is required." |   |
 
 
-### Code example
+#### Code example
 ```
 import { getRequiredObjectRule } from 'react-hook-form-rules';
 
@@ -80,18 +94,18 @@ const {...} = useController({
 
 
 
-## getMaxRule
+### getMaxRule
 
-### Description
+#### Description
 This rule returns an error if the number is greater than the specified value.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | max | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMaxRule } from 'react-hook-form-rules';
 
@@ -105,12 +119,12 @@ const {...} = useController({
 
 
 
-## getMaxLengthRule
+### getMaxLengthRule
 
-### Description
+#### Description
 This rule checks that the number of characters in the string does not exceed the specified value.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | maxLength | number | -  | - |
@@ -131,19 +145,19 @@ const {...} = useController({
 
 
 
-## getMaxArrayLengthRule
+### getMaxArrayLengthRule
 
-### Description
+#### Description
 This rule returns an error if the number of values in the array exceeds the specified limit.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | arr | arrray | -  | - |
 | maxLength | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMaxArrayLengthRule } from 'react-hook-form-rules';
 
@@ -156,18 +170,18 @@ const {...} = useController({
 
 
 
-## getMinRule
+### getMinRule
 
-### Description
+#### Description
 This rule checks that the string contains a minimum number of characters.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | min | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMinRule } from 'react-hook-form-rules';
 
@@ -181,18 +195,18 @@ const {...} = useController({
 
 
 
-## getMinLengthRule
+### getMinLengthRule
 
-### Description
+#### Description
 The rule checks that the string contains at least the specified number of characters.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | minLength | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMinLengthRule } from 'react-hook-form-rules';
 
@@ -206,19 +220,19 @@ const {...} = useController({
 
 
 
-## getMinArrayLengthRule
+### getMinArrayLengthRule
 
-### Description
+#### Description
 The rule checks that the array contains a minimum number of elements.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | arr | arrray | -  | - |
 | minLength | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMinArrayLengthRule } from 'react-hook-form-rules';
 
@@ -229,18 +243,18 @@ const {...} = useController({
 })
 ```
 
-## getEmailRule
+### getEmailRule
 
-### Description
+#### Description
 he rule checks the entered email for correctness.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | pattern | RegExp | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getEmailRule } from 'react-hook-form-rules';
 
@@ -254,18 +268,18 @@ const {...} = useController({
 
 
 
-## getUrlRule
+### getUrlRule
 
-### Description
+#### Description
 The rule checks the entered URL for correctness.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | pattern | RegExp | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getUrlRule } from 'react-hook-form-rules';
 

package/dist/index.d.ts

@@ -1,12 +1,12 @@
-import { getEmailRule } from "./rules/get-email-rule";
-import { getMaxArrayLengthRule } from "./rules/get-max-array-length";
-import { getMaxLengthRule } from "./rules/get-max-length-rule";
-import { getMinArrayLengthRule } from "./rules/get-min-array-length";
-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-rule";
-import { getRequiredObjectRule } from "./rules/get-required-object-rule";
-import { getUrlRule } from "./rules/get-url-rule";
+import { getEmailRule } from "./rules/link/get-email-rule";
+import { getUrlRule } from "./rules/link/get-url-rule";
+import { getMaxArrayLengthRule } from "./rules/array/get-max-array-length";
+import { getMinArrayLengthRule } from "./rules/array/get-min-array-length";
+import { getRequiredArrayRule } from "./rules/array/get-required-array-rule";
+import { getMaxLengthRule } from "./rules/default/get-max-length-rule";
+import { getMaxRule } from "./rules/default/get-max-rule";
+import { getMinLengthRule } from "./rules/default/get-min-length-rule";
+import { getMinRule } from "./rules/default/get-min-rule";
+import { getRequiredRule } from "./rules/default/get-require-rule";
+import { getRequiredObjectRule } from "./rules/object/get-required-object-rule";
 export { getMaxRule, getRequiredObjectRule, getRequiredArrayRule, getEmailRule, getMaxLengthRule, getMaxArrayLengthRule, getMinArrayLengthRule, getMinLengthRule, getMinRule, getRequiredRule, getUrlRule, };

package/dist/index.js

@@ -1,25 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUrlRule = exports.getRequiredRule = exports.getMinRule = exports.getMinLengthRule = exports.getMinArrayLengthRule = exports.getMaxArrayLengthRule = exports.getMaxLengthRule = exports.getEmailRule = exports.getRequiredArrayRule = exports.getRequiredObjectRule = exports.getMaxRule = void 0;
-const get_email_rule_1 = require("./rules/get-email-rule");
+const get_email_rule_1 = require("./rules/link/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");
+const get_url_rule_1 = require("./rules/link/get-url-rule");
+Object.defineProperty(exports, "getUrlRule", { enumerable: true, get: function () { return get_url_rule_1.getUrlRule; } });
+const get_max_array_length_1 = require("./rules/array/get-max-array-length");
 Object.defineProperty(exports, "getMaxArrayLengthRule", { enumerable: true, get: function () { return get_max_array_length_1.getMaxArrayLengthRule; } });
-const get_max_length_rule_1 = require("./rules/get-max-length-rule");
-Object.defineProperty(exports, "getMaxLengthRule", { enumerable: true, get: function () { return get_max_length_rule_1.getMaxLengthRule; } });
-const get_min_array_length_1 = require("./rules/get-min-array-length");
+const get_min_array_length_1 = require("./rules/array/get-min-array-length");
 Object.defineProperty(exports, "getMinArrayLengthRule", { enumerable: true, get: function () { return get_min_array_length_1.getMinArrayLengthRule; } });
-const get_max_rule_1 = require("./rules/get-max-rule");
+const get_required_array_rule_1 = require("./rules/array/get-required-array-rule");
+Object.defineProperty(exports, "getRequiredArrayRule", { enumerable: true, get: function () { return get_required_array_rule_1.getRequiredArrayRule; } });
+const get_max_length_rule_1 = require("./rules/default/get-max-length-rule");
+Object.defineProperty(exports, "getMaxLengthRule", { enumerable: true, get: function () { return get_max_length_rule_1.getMaxLengthRule; } });
+const get_max_rule_1 = require("./rules/default/get-max-rule");
 Object.defineProperty(exports, "getMaxRule", { enumerable: true, get: function () { return get_max_rule_1.getMaxRule; } });
-const get_min_length_rule_1 = require("./rules/get-min-length-rule");
+const get_min_length_rule_1 = require("./rules/default/get-min-length-rule");
 Object.defineProperty(exports, "getMinLengthRule", { enumerable: true, get: function () { return get_min_length_rule_1.getMinLengthRule; } });
-const get_min_rule_1 = require("./rules/get-min-rule");
+const get_min_rule_1 = require("./rules/default/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");
+const get_require_rule_1 = require("./rules/default/get-require-rule");
 Object.defineProperty(exports, "getRequiredRule", { enumerable: true, get: function () { return get_require_rule_1.getRequiredRule; } });
-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");
+const get_required_object_rule_1 = require("./rules/object/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");
-Object.defineProperty(exports, "getUrlRule", { enumerable: true, get: function () { return get_url_rule_1.getUrlRule; } });

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

@@ -0,0 +1,9 @@
+/**
+ * Validates an array for the maximum number of values.
+ * @param arr - Array of values.
+ * @param maxLength - Maximum number of values.
+ * @param message - Custom message.
+ *
+ * @example getMaxArrayLengthRule(2, "Maximum number of values is 2").
+ */
+export declare const getMaxArrayLengthRule: (arr: unknown[], maxLength: number, message?: string) => string | true;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMaxArrayLengthRule = void 0;
+/**
+ * Validates an array for the maximum number of values.
+ * @param arr - Array of values.
+ * @param maxLength - Maximum number of values.
+ * @param message - Custom message.
+ *
+ * @example getMaxArrayLengthRule(2, "Maximum number of values is 2").
+ */
+const getMaxArrayLengthRule = (arr, maxLength, message) => {
+    const defaultMessage = `Maximum number of values - ${maxLength}.`;
+    const formattedMessage = message || defaultMessage;
+    return arr.length < maxLength || formattedMessage;
+};
+exports.getMaxArrayLengthRule = getMaxArrayLengthRule;

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

@@ -0,0 +1,9 @@
+/**
+ * Validates an array for the maximum number of values.
+ * @param arr - Array of values.
+ * @param maxLength - Maximum number of values.
+ * @param message - Custom message.
+ *
+ * @example getMaxArrayLengthRule(3, "Maximum number of values is 2").
+ */
+export declare const getMinArrayLengthRule: (arr: unknown[], minLength: number, message?: string) => string | true;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMinArrayLengthRule = void 0;
+/**
+ * Validates an array for the maximum number of values.
+ * @param arr - Array of values.
+ * @param maxLength - Maximum number of values.
+ * @param message - Custom message.
+ *
+ * @example getMaxArrayLengthRule(3, "Maximum number of values is 2").
+ */
+const getMinArrayLengthRule = (arr, minLength, message) => {
+    const defaultMessage = `Minimum number of values - ${minLength}.`;
+    const formattedMessage = message || defaultMessage;
+    return arr.length > minLength || formattedMessage;
+};
+exports.getMinArrayLengthRule = getMinArrayLengthRule;

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

@@ -0,0 +1,8 @@
+/**
+ * Validates an array, checking if it contains values.
+ * @param arr - Array of values.
+ * @param message - Custom message.
+ *
+ * @example rules: { validate: (arr) => getRequiredArrayRule(arr) }
+ */
+export declare const getRequiredArrayRule: (arr?: unknown[], message?: string) => string | true;

package/dist/rules/array/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 = 'Это поле обязательное.';
+/**
+ * Validates an array, checking if it contains values.
+ * @param arr - Array of values.
+ * @param message - Custom message.
+ *
+ * @example rules: { validate: (arr) => getRequiredArrayRule(arr) }
+ */
+const getRequiredArrayRule = (arr = [], message) => {
+    return arr.length > 0 || (message || REQUIRED_MESSAGE_TEXT);
+};
+exports.getRequiredArrayRule = getRequiredArrayRule;

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

@@ -0,0 +1,11 @@
+/**
+ * Validates the maximum length of a string.
+ * @param maxLength - Maximum number of characters allowed.
+ * @param message - Custom message.
+ *
+ * @example rules: { maxLength: getMaxLengthRule(1000) }
+ */
+export declare const getMaxLengthRule: (maxLength: number, message?: string) => {
+    value: number;
+    message: string;
+};

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

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMaxLengthRule = void 0;
+const plural_ru_1 = __importDefault(require("plural-ru"));
+/**
+ * Validates the maximum length of a string.
+ * @param maxLength - Maximum number of characters allowed.
+ * @param message - Custom message.
+ *
+ * @example rules: { maxLength: getMaxLengthRule(1000) }
+ */
+const getMaxLengthRule = (maxLength, message) => {
+    const formattedMessage = `Максимальная длина ${maxLength} ${(0, plural_ru_1.default)(maxLength, "символ", "символа", "символов")}.`;
+    return {
+        value: maxLength,
+        message: message || formattedMessage,
+    };
+};
+exports.getMaxLengthRule = getMaxLengthRule;

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

@@ -0,0 +1,11 @@
+/**
+ * Returns an error if the number exceeds the specified value.
+ * @param max - Maximum number.
+ * @param message - Custom message.
+ *
+ * @example rules: { max: getMaxRule(20) }
+ */
+export declare const getMaxRule: (max: number, message?: string) => {
+    value: number;
+    message: string;
+};

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMaxRule = void 0;
+/**
+ * Returns an error if the number exceeds the specified value.
+ * @param max - Maximum number.
+ * @param message - Custom message.
+ *
+ * @example rules: { max: getMaxRule(20) }
+ */
+const getMaxRule = (max, message) => ({
+    value: max,
+    message: message || `Maximum value - ${max}.`,
+});
+exports.getMaxRule = getMaxRule;

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

@@ -0,0 +1,11 @@
+/**
+ * Returns a rule that validates the minimum length of a string.
+ * @param minLength - Minimum number of characters allowed.
+ * @param message - Custom message.
+ *
+ * @example rules: { minLength: getMinLengthRule(20) }
+ */
+export declare const getMinLengthRule: (minLength: number, message?: string) => {
+    value: number;
+    message: string;
+};

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

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMinLengthRule = void 0;
+const plural_ru_1 = __importDefault(require("plural-ru"));
+/**
+ * Returns a rule that validates the minimum length of a string.
+ * @param minLength - Minimum number of characters allowed.
+ * @param message - Custom message.
+ *
+ * @example rules: { minLength: getMinLengthRule(20) }
+ */
+const getMinLengthRule = (minLength, message) => {
+    const formattedMessage = `Минимальная длина ${minLength} ${(0, plural_ru_1.default)(minLength, "символ", "символа", "символов")}.`;
+    return {
+        value: minLength,
+        message: message || formattedMessage,
+    };
+};
+exports.getMinLengthRule = getMinLengthRule;

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

@@ -0,0 +1,11 @@
+/**
+ * Returns an error if the number is less than the specified value.
+ * @param min - Minimum number.
+ * @param message - Custom message.
+ *
+ * @example rules: { min: getMinRule(20) }
+ */
+export declare const getMinRule: (min: number, message?: string) => {
+    value: number;
+    message: string;
+};

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMinRule = void 0;
+/**
+ * Returns an error if the number is less than the specified value.
+ * @param min - Minimum number.
+ * @param message - Custom message.
+ *
+ * @example rules: { min: getMinRule(20) }
+ */
+const getMinRule = (min, message) => ({
+    value: min,
+    message: message || `Minimum value - ${min}.`,
+});
+exports.getMinRule = getMinRule;

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

@@ -0,0 +1,11 @@
+/**
+ * Validates a required field.
+ * @param isRequired - Dynamic parameter that indicates whether the field is required.
+ * @param message - Custom message.
+ *
+ * @example rules: { required: getRequiredRule() }
+ */
+export declare const getRequiredRule: (isRequired?: boolean, message?: string) => {
+    value: boolean;
+    message: string;
+};

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequiredRule = void 0;
+const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+/**
+ * Validates a required field.
+ * @param isRequired - Dynamic parameter that indicates whether the field is required.
+ * @param message - Custom message.
+ *
+ * @example rules: { required: getRequiredRule() }
+ */
+const getRequiredRule = (isRequired = true, message = REQUIRED_MESSAGE_TEXT) => ({
+    value: isRequired,
+    message,
+});
+exports.getRequiredRule = getRequiredRule;

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

@@ -0,0 +1,17 @@
+interface EmailRule {
+    pattern?: RegExp;
+    message?: string;
+}
+/**
+ * Validates an email address.
+ * @param options - Parameters.
+ * @param options.pattern - Regular expression.
+ * @param options.message - Custom message.
+ *
+ * @example rules: { pattern: getEmailRule() }
+ */
+export declare const getEmailRule: ({ pattern, message, }: EmailRule) => {
+    value: RegExp;
+    message: string;
+};
+export {};

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEmailRule = void 0;
+const DEFAULT_PATTERN = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/;
+const DEFAULT_MESSAGE = "Please check the correctness of the entered email address.";
+/**
+ * Validates an email address.
+ * @param options - Parameters.
+ * @param options.pattern - Regular expression.
+ * @param options.message - Custom message.
+ *
+ * @example rules: { pattern: getEmailRule() }
+ */
+const getEmailRule = ({ pattern = DEFAULT_PATTERN, message = DEFAULT_MESSAGE, }) => {
+    return {
+        value: pattern,
+        message,
+    };
+};
+exports.getEmailRule = getEmailRule;

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

@@ -0,0 +1,17 @@
+interface UrlRule {
+    message?: string;
+    pattern?: RegExp;
+}
+/**
+ * Returns a rule that validates the input URL.
+ * @param options - Parameters.
+ * @param options.pattern - Regular expression.
+ * @param options.message - Custom message.
+ *
+ * @example rules: { pattern: getUrlValidationRule() }
+ */
+export declare const getUrlRule: ({ pattern, message, }: UrlRule) => {
+    message: string;
+    value: RegExp;
+};
+export {};

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUrlRule = void 0;
+const DEFAULT_MESSAGE = "The link does not match the format.";
+const DEFAULT_PATTERN = /(http(s)?):\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
+/**
+ * Returns a rule that validates the input URL.
+ * @param options - Parameters.
+ * @param options.pattern - Regular expression.
+ * @param options.message - Custom message.
+ *
+ * @example rules: { pattern: getUrlValidationRule() }
+ */
+const getUrlRule = ({ pattern = DEFAULT_PATTERN, message = DEFAULT_MESSAGE, }) => {
+    return {
+        message,
+        value: pattern,
+    };
+};
+exports.getUrlRule = getUrlRule;

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

@@ -0,0 +1,8 @@
+/**
+ * Validates an object, checking if it contains values.
+ * @param obj - Object with values.
+ * @param message - Custom message.
+ *
+ * @example rules: { validate: (obj) => getRequiredObjectRule(obj) }
+ */
+export declare const getRequiredObjectRule: (obj?: Record<string, unknown>, message?: string) => string | true;

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequiredObjectRule = void 0;
+const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+/**
+ * Validates an object, checking if it contains values.
+ * @param obj - Object with values.
+ * @param message - Custom message.
+ *
+ * @example rules: { validate: (obj) => getRequiredObjectRule(obj) }
+ */
+const getRequiredObjectRule = (obj = {}, message) => {
+    var _a;
+    const formattedMessage = message || REQUIRED_MESSAGE_TEXT;
+    if (!obj) {
+        return false || formattedMessage;
+    }
+    return ((_a = Object === null || Object === void 0 ? void 0 : Object.keys(obj)) === null || _a === void 0 ? void 0 : _a.length) > 0 || formattedMessage;
+};
+exports.getRequiredObjectRule = getRequiredObjectRule;

package/index.ts

@@ -1,15 +1,17 @@
+import { getEmailRule } from "./rules/link/get-email-rule";
+import { getUrlRule } from "./rules/link/get-url-rule";
 
-import { getEmailRule } from "./rules/get-email-rule";
-import { getMaxArrayLengthRule } from "./rules/get-max-array-length";
-import { getMaxLengthRule } from "./rules/get-max-length-rule";
-import { getMinArrayLengthRule } from "./rules/get-min-array-length";
-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-rule";
-import { getRequiredObjectRule } from "./rules/get-required-object-rule";
-import { getUrlRule } from "./rules/get-url-rule";
+import { getMaxArrayLengthRule } from "./rules/array/get-max-array-length";
+import { getMinArrayLengthRule } from "./rules/array/get-min-array-length";
+import { getRequiredArrayRule } from "./rules/array/get-required-array-rule";
+
+import { getMaxLengthRule } from "./rules/default/get-max-length-rule";
+import { getMaxRule } from "./rules/default/get-max-rule";
+import { getMinLengthRule } from "./rules/default/get-min-length-rule";
+import { getMinRule } from "./rules/default/get-min-rule";
+import { getRequiredRule } from "./rules/default/get-require-rule";
+
+import { getRequiredObjectRule } from "./rules/object/get-required-object-rule";
 
 export {
   getMaxRule,

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "react-hook-form-rules",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc --declaration",
-    "publish": "npm run build && npm publish"
+    "deploy": "npm run build && npm publish"
   },
   "keywords": [],
   "author": "",

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

@@ -0,0 +1,19 @@
+/**
+ * Validates an array for the maximum number of values.
+ * @param arr - Array of values.
+ * @param maxLength - Maximum number of values.
+ * @param message - Custom message.
+ *
+ * @example getMaxArrayLengthRule(2, "Maximum number of values is 2").
+ */
+export const getMaxArrayLengthRule = (
+  arr: unknown[],
+  maxLength: number,
+  message?: string,
+) => {
+  const defaultMessage = `Maximum number of values - ${maxLength}.`;
+
+  const formattedMessage = message || defaultMessage;
+
+  return arr.length < maxLength || formattedMessage;
+};

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

@@ -0,0 +1,19 @@
+/**
+ * Validates an array for the maximum number of values.
+ * @param arr - Array of values.
+ * @param maxLength - Maximum number of values.
+ * @param message - Custom message.
+ *
+ * @example getMaxArrayLengthRule(3, "Maximum number of values is 2").
+ */
+export const getMinArrayLengthRule = (
+  arr: unknown[],
+  minLength: number,
+  message?: string,
+) => {
+  const defaultMessage = `Minimum number of values - ${minLength}.`;
+
+  const formattedMessage = message || defaultMessage;
+
+  return arr.length > minLength || formattedMessage;
+};

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

@@ -0,0 +1,12 @@
+const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+
+/**
+ * Validates an array, checking if it contains values.
+ * @param arr - Array of values.
+ * @param message - Custom message.
+ * 
+ * @example rules: { validate: (arr) => getRequiredArrayRule(arr) }
+ */
+export const getRequiredArrayRule = (arr: unknown[] = [], message?: string) => {
+  return arr.length > 0 || (message || REQUIRED_MESSAGE_TEXT);
+};

package/rules/{get-max-length-rule.ts → default/get-max-length-rule.ts}

@@ -1,11 +1,11 @@
 import plural from "plural-ru";
 
 /**
- * Валидирует максимальную длину строки
- * @param maxLength - Максимальное количество символов для ввода
- * @param mrssage - Кастомное сообщение.
+ * Validates the maximum length of a string.
+ * @param maxLength - Maximum number of characters allowed.
+ * @param message - Custom message.
  *
- * @example rules: { maxLength: getMaxLengthRule(1000)}
+ * @example rules: { maxLength: getMaxLengthRule(1000) }
  */
 export const getMaxLengthRule = (maxLength: number, message?: string) => {
   const formattedMessage = `Максимальная длина ${maxLength} ${plural(

package/rules/default/get-max-rule.ts

@@ -0,0 +1,11 @@
+/**
+ * Returns an error if the number exceeds the specified value.
+ * @param max - Maximum number.
+ * @param message - Custom message.
+ *
+ * @example rules: { max: getMaxRule(20) }
+ */
+export const getMaxRule = (max: number, message?: string) => ({
+  value: max,
+  message: message || `Maximum value - ${max}.`,
+});

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

@@ -0,0 +1,22 @@
+import plural from "plural-ru";
+
+/**
+ * Returns a rule that validates the minimum length of a string.
+ * @param minLength - Minimum number of characters allowed.
+ * @param message - Custom message.
+ *
+ * @example rules: { minLength: getMinLengthRule(20) }
+ */
+export const getMinLengthRule = (minLength: number, message?: string) => {
+  const formattedMessage = `Минимальная длина ${minLength} ${plural(
+    minLength,
+    "символ",
+    "символа",
+    "символов",
+  )}.`;
+
+  return {
+    value: minLength,
+    message: message || formattedMessage,
+  };
+};

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

@@ -0,0 +1,11 @@
+/**
+ * Returns an error if the number is less than the specified value.
+ * @param min - Minimum number.
+ * @param message - Custom message.
+ * 
+ * @example rules: { min: getMinRule(20) }
+ */
+export const getMinRule = (min: number, message?: string) => ({
+  value: min,
+  message: message || `Minimum value - ${min}.`,
+})

package/rules/default/get-require-rule.ts

@@ -0,0 +1,16 @@
+const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+
+/**
+ * Validates a required field.
+ * @param isRequired - Dynamic parameter that indicates whether the field is required.
+ * @param message - Custom message.
+ * 
+ * @example rules: { required: getRequiredRule() }
+ */
+export const getRequiredRule = (
+  isRequired = true,
+  message = REQUIRED_MESSAGE_TEXT
+) => ({
+  value: isRequired,
+  message,
+})

package/rules/link/get-email-rule.ts

@@ -0,0 +1,26 @@
+const DEFAULT_PATTERN = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/;
+const DEFAULT_MESSAGE =
+  "Please check the correctness of the entered email address.";
+
+interface EmailRule {
+  pattern?: RegExp;
+  message?: string;
+}
+
+/**
+ * Validates an email address.
+ * @param options - Parameters.
+ * @param options.pattern - Regular expression.
+ * @param options.message - Custom message.
+ *
+ * @example rules: { pattern: getEmailRule() }
+ */
+export const getEmailRule = ({
+  pattern = DEFAULT_PATTERN,
+  message = DEFAULT_MESSAGE,
+}: EmailRule) => {
+  return {
+    value: pattern,
+    message,
+  };
+};

package/rules/{get-url-rule.ts → link/get-url-rule.ts}

@@ -1,4 +1,4 @@
-const DEFAULT_MESSAGE = "Ссылка не соответствует формату"
+const DEFAULT_MESSAGE = "The link does not match the format."
 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 {
@@ -7,10 +7,10 @@ interface UrlRule {
 }
 
 /**
- * Возвращает правило, которое валидирует ввод url
- * @param options - Параметры.
- * @param options.pattern - Регулярное выражение.
- * @param options.message - Кастомное сообщение.
+ * Returns a rule that validates the input URL.
+ * @param options - Parameters.
+ * @param options.pattern - Regular expression.
+ * @param options.message - Custom message.
  * 
  * @example rules: { pattern: getUrlValidationRule() }
  */

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

@@ -1,9 +1,9 @@
 const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
 
 /**
- * Валидирует объект, проверяет если в нем значения
- * @param obj - Объект со значениями
- * @param message - Кастомное сообщение.
+ * Validates an object, checking if it contains values.
+ * @param obj - Object with values.
+ * @param message - Custom message.
  * 
  * @example rules: { validate: (obj) => getRequiredObjectRule(obj) }
  */

package/rules/get-email-rule.ts

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

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

@@ -1,18 +0,0 @@
-/**
- * Валидирует массив, на максимальное кол-во значений
- * @param arr - Массиов со значениями.
- * @param maxLength - Максимальное количество значений.
- * @param message - Кастомное сообщение.
- * @example getMaxArrayLengthRule(2, "Максимальное кол-во значений - 2").
- */
-export const getMaxArrayLengthRule = (
-  arr: unknown[],
-  maxLength: number,
-  message?: string,
-) => {
-  const defaultMessage = `Максимальное количество значений - ${maxLength}.`;
-
-  const formattedMessage = message || defaultMessage;
-
-  return arr.length < maxLength || formattedMessage;
-};

package/rules/get-max-rule.ts

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

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

@@ -1,18 +0,0 @@
-/**
- * Валидирует массив, на максимальное кол-во значений
- * @param arr - Массиов со значениями.
- * @param minLength - Максимальное количество значений.
- * @param message - Кастомное сообщение.
- * @example getMinArrayLengthRule(3, "Максимальное кол-во значений - 2").
- */
-export const getMinArrayLengthRule = (
-  arr: unknown[],
-  minLength: number,
-  message?: string,
-) => {
-  const defaultMessage = `Минимальное количество значений - ${minLength}.`;
-
-  const formattedMessage = message || defaultMessage;
-
-  return arr.length > minLength || formattedMessage;
-};

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

@@ -1,22 +0,0 @@
-import plural from 'plural-ru'
-
-/**
- * Возвращает правило, которое валидирует минимальную длину строки
- * @param maxLength - Минимальное количество символов для ввода
- * @param message - Кастомное сообщение.
- * 
- * @example rules: { minLength: getMinLengthRule(20) }
- */
-export const getMinLengthRule = (minLength: number, message?: string) => {
-  const formattedMessage = `Минимальная длина ${minLength} ${plural(
-    minLength,
-    'символ',
-    'символа',
-    'символов',
-  )}.`
-
-  return {
-    value: minLength,
-    message: message || formattedMessage,
-  };
-};

package/rules/get-min-rule.ts

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

package/rules/get-require-rule.ts

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

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

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