react-hook-form-rules 1.0.10 → 1.0.11

package/README.md

@@ -20,8 +20,8 @@ This rule makes the field required.
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| isRequired | boolean | true  |  |
-| message | string | "This field is required." |  . |
+| isRequired | boolean | true  | Dynamic parameter that indicates whether the field is required. |
+| message | string | "This field is required." | Custom message. |
 
 #### Code example
 ```
@@ -48,8 +48,8 @@ This rule makes the array field required.
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| arr | array | []  |  |
-| message | string | "This field is required." |   |
+| arr | array | -  | Array of values.  |
+| message | string | "This field is required." | Custom message.  |
 
 
 #### Code example
@@ -76,8 +76,8 @@ This rule makes the object field required.
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| obj | object | {}  |  |
-| message | string | "This field is required." |   |
+| obj | object | -  | Object with values. |
+| message | string | "This field is required." | Custom message.  |
 
 
 #### Code example
@@ -102,8 +102,8 @@ This rule returns an error if the number is greater than the specified value.
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| max | number | -  | - |
-| message | string | - |  - |
+| max | number | -  | Maximum number. |
+| message | string | - |  Custom message. |
 
 #### Code example
 ```
@@ -127,8 +127,8 @@ This rule checks that the number of characters in the string does not exceed the
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| maxLength | number | -  | - |
-| message | string | - |  - |
+| maxLength | number | -  | Maximum number of characters allowed. |
+| message | string | - |  Custom message. |
 
 ### Code example
 ```
@@ -153,9 +153,9 @@ This rule returns an error if the number of values in the array exceeds the spec
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| arr | arrray | -  | - |
-| maxLength | number | -  | - |
-| message | string | - |  - |
+| arr | arrray | -  | Array of values. |
+| maxLength | number | -  | Maximum number of values. |
+| message | string | - |  Custom message |
 
 #### Code example
 ```
@@ -178,8 +178,8 @@ This rule checks that the string contains a minimum number of characters.
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| min | number | -  | - |
-| message | string | - |  - |
+| min | number | -  | Minimum number. |
+| message | string | - |  Custom message. |
 
 #### Code example
 ```
@@ -203,8 +203,8 @@ The rule checks that the string contains at least the specified number of charac
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| minLength | number | -  | - |
-| message | string | - |  - |
+| minLength | number | -  | Minimum number of characters allowed. |
+| message | string | - |  Custom message |
 
 #### Code example
 ```
@@ -228,9 +228,9 @@ The rule checks that the array contains a minimum number of elements.
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| arr | arrray | -  | - |
-| minLength | number | -  | - |
-| message | string | - |  - |
+| arr | arrray | -  | Array of values. |
+| minLength | number | -  | Maximum number of values. |
+| message | string | - |  Custom message |
 
 #### Code example
 ```
@@ -251,8 +251,9 @@ he rule checks the entered email for correctness.
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| pattern | RegExp | -  | - |
-| message | string | - |  - |
+| props | object | - | Object with values |
+| props.pattern | RegExp | -  | Regular expression. |
+| props.message | string | - |  Custom message |
 
 #### Code example
 ```
@@ -276,8 +277,9 @@ The rule checks the entered URL for correctness.
 #### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
-| pattern | RegExp | -  | - |
-| message | string | - |  - |
+| props | object | - | Object with values |
+| props.pattern | RegExp | -  | Regular expression. |
+| props.message | string | - |  Custom message |
 
 #### Code example
 ```
@@ -289,7 +291,3 @@ const {...} = useController({
   }}
 })
 ```
-
-
-
-

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

@@ -5,4 +5,4 @@
  *
  * @example rules: { validate: (arr) => getRequiredArrayRule(arr) }
  */
-export declare const getRequiredArrayRule: (arr?: unknown[], message?: string) => string | true;
+export declare const getRequiredArrayRule: (arr: unknown[], message?: string) => string | true;

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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRequiredArrayRule = void 0;
-const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+const constants_1 = require("../constants");
 /**
  * Validates an array, checking if it contains values.
  * @param arr - Array of values.
@@ -9,7 +9,7 @@ const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
  *
  * @example rules: { validate: (arr) => getRequiredArrayRule(arr) }
  */
-const getRequiredArrayRule = (arr = [], message) => {
-    return arr.length > 0 || (message || REQUIRED_MESSAGE_TEXT);
+const getRequiredArrayRule = (arr, message) => {
+    return arr.length > 0 || (message || constants_1.REQUIRED_MESSAGE_TEXT);
 };
 exports.getRequiredArrayRule = getRequiredArrayRule;

package/dist/rules/constants.d.ts

@@ -0,0 +1 @@
+export declare const REQUIRED_MESSAGE_TEXT = "This field is required.";

package/dist/rules/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUIRED_MESSAGE_TEXT = void 0;
+exports.REQUIRED_MESSAGE_TEXT = 'This field is required.';

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

@@ -1,10 +1,6 @@
 "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.
@@ -13,7 +9,7 @@ const plural_ru_1 = __importDefault(require("plural-ru"));
  * @example rules: { maxLength: getMaxLengthRule(1000) }
  */
 const getMaxLengthRule = (maxLength, message) => {
-    const formattedMessage = `Максимальная длина ${maxLength} ${(0, plural_ru_1.default)(maxLength, "символ", "символа", "символов")}.`;
+    const formattedMessage = `Maximum length - ${maxLength}`;
     return {
         value: maxLength,
         message: message || formattedMessage,

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

@@ -1,10 +1,6 @@
 "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.
@@ -13,7 +9,7 @@ const plural_ru_1 = __importDefault(require("plural-ru"));
  * @example rules: { minLength: getMinLengthRule(20) }
  */
 const getMinLengthRule = (minLength, message) => {
-    const formattedMessage = `Минимальная длина ${minLength} ${(0, plural_ru_1.default)(minLength, "символ", "символа", "символов")}.`;
+    const formattedMessage = `Minimum length - ${minLength}`;
     return {
         value: minLength,
         message: message || formattedMessage,

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

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

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

@@ -5,4 +5,4 @@
  *
  * @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/object/get-required-object-rule.js

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

package/package.json

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

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

@@ -1,4 +1,4 @@
-const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+import { REQUIRED_MESSAGE_TEXT } from "../constants";
 
 /**
  * Validates an array, checking if it contains values.
@@ -7,6 +7,6 @@ const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
  * 
  * @example rules: { validate: (arr) => getRequiredArrayRule(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/constants.ts

@@ -0,0 +1 @@
+export const REQUIRED_MESSAGE_TEXT = 'This field is required.';

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

@@ -1,5 +1,3 @@
-import plural from "plural-ru";
-
 /**
  * Validates the maximum length of a string.
  * @param maxLength - Maximum number of characters allowed.
@@ -8,12 +6,7 @@ import plural from "plural-ru";
  * @example rules: { maxLength: getMaxLengthRule(1000) }
  */
 export const getMaxLengthRule = (maxLength: number, message?: string) => {
-  const formattedMessage = `Максимальная длина ${maxLength} ${plural(
-    maxLength,
-    "символ",
-    "символа",
-    "символов",
-  )}.`;
+  const formattedMessage = `Maximum length - ${maxLength}`;
 
   return {
     value: maxLength,

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

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

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

@@ -1,4 +1,4 @@
-const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+import { REQUIRED_MESSAGE_TEXT } from "../constants";
 
 /**
  * Validates a required field.

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

@@ -1,4 +1,4 @@
-const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
+import { REQUIRED_MESSAGE_TEXT } from "../constants";
 
 /**
  * Validates an object, checking if it contains values.
@@ -7,7 +7,7 @@ const REQUIRED_MESSAGE_TEXT = 'Это поле обязательное.';
  * 
  * @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) {

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

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

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

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