react-hook-form-rules 1.7.2 → 1.7.4

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

@@ -1,17 +0,0 @@
-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

@@ -1,40 +0,0 @@
-<<<<<<<< HEAD:dist/rules/link/get-email-rule.js
-"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.";
-========
-import { getPatternRule } from "./get-pattern-rule";
-import { translate } from "../../i18n";
-
-const DEFAULT_PATTERN = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/;
-
-interface EmailRule {
-  pattern?: RegExp;
-  message?: string;
-}
-
->>>>>>>> release:rules/patterns/get-email-rule.ts
-/**
- * Validates an email address.
- * @param options - Parameters.
- * @param {string} options.pattern - Regular expression.
- * @param {string} options.message - Custom message.
- *
- * @example rules: { pattern: getEmailRule() }
- */
-<<<<<<<< HEAD:dist/rules/link/get-email-rule.js
-const getEmailRule = ({ pattern = DEFAULT_PATTERN, message = DEFAULT_MESSAGE, }) => {
-    return {
-        value: pattern,
-        message,
-    };
-};
-exports.getEmailRule = getEmailRule;
-========
-export const getEmailRule = ({
-  pattern = DEFAULT_PATTERN,
-  message = translate('email'),
-}: EmailRule) => getPatternRule(pattern, message)
->>>>>>>> release:rules/patterns/get-email-rule.ts

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

@@ -1,17 +0,0 @@
-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

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUrlRule = void 0;
-const DEFAULT_MESSAGE = "The URL 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/i18n.ts

@@ -1,28 +0,0 @@
-import en from './locales/en.json'
-import ru from './locales/ru.json'
-
-const translataions = {
-  en,
-  ru,
-};
-
-let currentLang = 'en'
-
-export const setLanguage = (lang: string) => {
-  if ((translataions as any)[lang]) {
-    currentLang = lang;
-  } else {
-    console.warn(`⚠️ Language "${lang}" is not supported. Defaulting to English.`);
-  }
-}
-
-export const translate = (key: string, params = {}) => {
-  let text = (translataions as any)[currentLang][key] || key;
-
-  // Подставляем параметры (например, {{min}})
-  Object.keys(params).forEach((param) => {
-    text = text.replace(`{{${param}}}`, (params as any)[param]);
-  });
-
-  return text;
-}

package/index.ts

@@ -1,30 +0,0 @@
-import { getEmailRule } from "./rules/patterns/get-email-rule";
-import { getUrlRule } from "./rules/patterns/get-url-rule";
-import { getPatternRule } from "./rules/patterns/get-pattern-rule";
-
-import { getMaxArrayLengthRule } from "./rules/array/get-max-array-length-rule";
-import { getMinArrayLengthRule } from "./rules/array/get-min-array-length-rule";
-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 {
-  getPatternRule,
-  getMaxRule,
-  getRequiredObjectRule,
-  getRequiredArrayRule,
-  getEmailRule,
-  getMaxLengthRule,
-  getMaxArrayLengthRule,
-  getMinArrayLengthRule,
-  getMinLengthRule,
-  getMinRule,
-  getRequiredRule,
-  getUrlRule,
-};

package/jest.config.js

@@ -1,8 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} **/
-module.exports = {
-  testEnvironment: "node",
-  transform: {
-    "^.+\.tsx?$": ["ts-jest", {}],
-  },
-  testPathIgnorePatterns: ['./dist']
-};

package/locales/en.json

@@ -1,12 +0,0 @@
-{
-  "required": "This field is required.",
-  "maxArrayLength": "Maximum number of values - {{max}}.",
-  "minArrayLength": "Minimum number of values - {{min}}.",
-  "min": "Minimum value - {{min}}.",
-  "max": "Maximum value - {{max}}.",
-  "minLength": "Minimum length - {{min}}.",
-  "maxLength": "Maximum length - {{max}}.",
-  "email": "Please check the correctness of the entered email address.",
-  "url": "The URL does not match the format."
-}
-  

package/locales/ru.json

@@ -1,11 +0,0 @@
-{
-  "required": "Поле объязательное.",
-  "maxArrayLength": "Максимальное количество значений - {{max}}.",
-  "minArrayLength": "Минимальное количество значений - {{min}}.",
-  "min": "Минимальное значение - {{min}}.",
-  "max": "Максимальное значение - {{max}}.",
-  "minLength": "Минимальная длина - {{min}}.",
-  "maxLength": "Максимальная длина - {{max}}.",
-  "email": "Проверьте правильность введенного адреса электронной почты.",
-  "url": "URL не соответствует формату."
-}

package/release.config.cjs

@@ -1,81 +0,0 @@
-/**
- * @type {import('semantic-release').GlobalConfig}
- */
-module.exports = {
-  branches: ["release"],
-  plugins: [
-    [
-      '@semantic-release/commit-analyzer',
-      {
-        releaseRules: [
-          { breaking: true, release: 'major' },
-          { revert: true, release: 'patch' },
-          { type: 'feat', release: 'minor' },
-          { type: 'fix', release: 'patch' },
-          { type: 'docs', release: 'patch' },
-          { type: 'style', release: 'patch' },
-          { type: 'refactor', release: 'patch' },
-          { type: 'perf', release: 'patch' },
-          { type: 'test', release: 'patch' },
-          { type: 'chore', release: 'patch' },
-        ],
-      },
-    ],
-    [
-      '@semantic-release/release-notes-generator',
-      {
-        parserOpts: {
-          noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING'],
-        },
-        preset: 'conventionalcommits',
-        presetConfig: {
-          types: [
-            { type: 'build', section: '📦 Build System', hidden: false },
-            { type: 'chore', section: '📦 Build System', hidden: true },
-            { type: 'ci', section: '💿 Continuous Integration', hidden: false },
-            { type: 'docs', section: '📄 Documentation', hidden: false },
-            { type: 'feat', section: '🆕 Features', hidden: false },
-            { type: 'fix', section: '🐞 Bug Fixes', hidden: false },
-            { type: 'perf', section: '⚡️ Performance Improvements', hidden: false },
-            { type: 'refactor', section: '🔥 Code Refactoring', hidden: false },
-            { type: 'style', section: '🛠 Styles', hidden: false },
-            { type: 'test', section: '🧪 Tests', hidden: false },
-          ],
-        },
-        writerOpts: {
-          commitsSort: ['subject', 'scope'],
-        },
-      },
-    ],
-    "@semantic-release/changelog",
-    [
-      "@semantic-release/npm",
-      {
-        "npmPublish": true,
-        "pkgRoot": ".",
-        "publishConfig": {
-          "registry": "https://registry.npmjs.org/",
-        }
-      }
-    ],
-    [
-      "@semantic-release/npm",
-      {
-        "npmPublish": false,
-        "pkgRoot": ".",
-        "publishConfig": {
-          "registry": "https://npm.pkg.github.com/",
-        }
-      }
-    ],
-    [
-      "@semantic-release/github",
-      {
-        assets: [
-          { path: "dist/*.tgz", label: "Package Distribution" },
-        ],
-      },
-    ],
-    "@semantic-release/git",
-  ]
-};

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

@@ -1,19 +0,0 @@
-import { translate } from "../../i18n";
-
-/**
- * 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 formattedMessage = message || translate('maxArrayLength', { max: maxLength });
-
-  return arr.length < maxLength || formattedMessage;
-};

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

@@ -1,19 +0,0 @@
-import { translate } from "../../i18n";
-
-/**
- * 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 formattedMessage = message || translate('minArrayLength', { min: minLength });
-
-  return arr.length >= minLength || formattedMessage;
-};

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

@@ -1,12 +0,0 @@
-import { translate } from "../../i18n";
-
-/**
- * Validates an array, checking if it contains values.
- * @param arr - Array of values.
- * @param {string} message - Custom message.
- * 
- * @example rules: { validate: (arr) => getRequiredArrayRule(arr) }
- */
-export const getRequiredArrayRule = (arr: unknown[], message?: string) => {
-  return arr.length > 0 || (message || translate('required'));
-};

package/rules/array/tests/get-max-array-length-rule.test.ts

@@ -1,17 +0,0 @@
-import { getMaxArrayLengthRule } from '../get-max-array-length-rule'
-
-const MAX_LENGTH = 2;
-
-describe('Тестирование функции getMaxArrayLengthRule', () => {
-  test('Проверка, что функция возвращает текстовое сообщение с ошибкой если длинна массива превышает максимальную.', () => {
-    expect(getMaxArrayLengthRule([1, 2, 3], MAX_LENGTH)).toBe(`Maximum number of values - ${MAX_LENGTH}.`)
-  })
-
-  test('Проверка, что функция возвращает true, если длинна массива меньше, либо равна максимальной.', () => {
-    expect(getMaxArrayLengthRule([1], MAX_LENGTH)).toBe(true)
-  })
-
-  test('Проверка, что функция возвращает кастомное сообщение, если кол-во заначений превышает максимальное.', () => {
-    expect(getMaxArrayLengthRule([1, 2, 3, 4], MAX_LENGTH, 'test message')).toBe('test message')
-  })
-})

package/rules/array/tests/get-min-array-length-rule.test.ts

@@ -1,17 +0,0 @@
-import { getMinArrayLengthRule } from "../get-min-array-length-rule";
-
-const MIN_LENGTH = 2;
-
-describe('Тестирование функции getMinArrayLengthRule', () => {
-  test('Проверка, что функция возвращает текстовое сообщение с ошибкой если длинна массива меньше минимальной.', () => {
-    expect(getMinArrayLengthRule([1], MIN_LENGTH)).toBe(`Minimum number of values - ${MIN_LENGTH}.`)
-  })
-
-  test('Проверка, что функция возвращает true, если длинна массива большe, либо равна минимальной.', () => {
-    expect(getMinArrayLengthRule([1, 3, 4], MIN_LENGTH)).toBe(true)
-  })
-
-  test('Проверка, что функция возвращает кастомное сообщение, если кол-во заначений меньше минимальной.', () => {
-    expect(getMinArrayLengthRule([1], MIN_LENGTH, 'test message')).toBe('test message')
-  })
-})

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

@@ -1,16 +0,0 @@
-import { REQUIRED_MESSAGE_TEXT } from '../../constants'
-import { getRequiredArrayRule } from '../get-required-array-rule'
-
-describe('Тестирование функции getRequiredArrayRule', () => {
-  test('Проверка, что функция возвращает кастомное сообщение с ошибкой, когда массив не содержит значения.', () => {
-    expect(getRequiredArrayRule([], 'test message')).toBe('test message')
-  })
-
-  test('Проверка, что функция возвращает true, когда массив не пустой.', () => {
-    expect(getRequiredArrayRule([1, 2, 3])).toBe(true)
-  })
-
-  test('Проверка, что функция возвращает базовое сообщение, когда массив пустой.', () => {
-    expect(getRequiredArrayRule([])).toBe(REQUIRED_MESSAGE_TEXT)
-  })
-})

package/rules/constants.ts

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

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

@@ -1,15 +0,0 @@
-import { translate } from "../../i18n";
-
-/**
- * Validates the maximum length of a string.
- * @param maxLength - Maximum number of characters allowed.
- * @param message - Custom message.
- *
- * @example rules: { maxLength: getMaxLengthRule(1000) }
- */
-export const getMaxLengthRule = (maxLength: number, message?: string) => ({
-  value: maxLength,
-  message: message || translate('maxLength', {
-    max: maxLength,
-  }),
-})

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

@@ -1,13 +0,0 @@
-import { translate } from "../../i18n";
-
-/**
- * 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 || translate('max', { max }),
-});

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

@@ -1,16 +0,0 @@
-import { translate } from "../../i18n";
-
-/**
- * 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) => {
-
-  return {
-    value: minLength,
-    message: message || translate('minLength', { min: minLength }),
-  };
-};

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

@@ -1,15 +0,0 @@
-import { translate } from "../../i18n"
-
-/**
- * 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 || translate('min', {
-    min,
-  }),
-})

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

@@ -1,16 +0,0 @@
-import { translate } from "../../i18n";
-
-/**
- * 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 = translate('required')
-) => ({
-  value: isRequired,
-  message,
-})

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

@@ -1,24 +0,0 @@
-import { getMaxLengthRule } from "../get-max-length-rule"
-
-describe('Тестирование функции getMinLengthRule', () => {
-  test('Проверка, что функция возвращает кастомное сообщение с ошибкой.', () => {
-    expect(getMaxLengthRule(1, 'test message')).toEqual({
-      value: 1,
-      message: 'test message',
-    })
-  })
-
-  test('Проверка, что функция возвращает базовую ошибку.', () => {
-    expect(getMaxLengthRule(1)).toEqual({
-      value: 1,
-      message: `Maximum length - ${1}.`
-    })
-  })
-
-  test('Проверка, что функция возвращает базовую ошибку и переданное минимальное значение.', () => {
-    expect(getMaxLengthRule(111)).toEqual({
-      value: 111,
-      message: `Maximum length - 111.`
-    })
-  })
-})

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

@@ -1,24 +0,0 @@
-import { getMaxRule } from "../get-max-rule"
-
-describe('Тестирование функции getMaxRule', () => {
-  test('Проверка, что функция возвращает кастомное сообщение с ошибкой.', () => {
-    expect(getMaxRule(1, 'test message')).toEqual({
-      value: 1,
-      message: 'test message',
-    })
-  })
-
-  test('Проверка, что функция возвращает базовую ошибку.', () => {
-    expect(getMaxRule(1)).toEqual({
-      value: 1,
-      message: `Maximum value - 1.`
-    })
-  })
-
-  test('Проверка, что функция возвращает базовую ошибку и переданное минимальное значение.', () => {
-    expect(getMaxRule(111)).toEqual({
-      value: 111,
-      message: `Maximum value - 111.`
-    })
-  })
-})

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

@@ -1,24 +0,0 @@
-import { getMinLengthRule } from "../get-min-length-rule"
-
-describe('Тестирование функции getMinLengthRule', () => {
-  test('Проверка, что функция возвращает кастомное сообщение с ошибкой.', () => {
-    expect(getMinLengthRule(1, 'test message')).toEqual({
-      value: 1,
-      message: 'test message',
-    })
-  })
-
-  test('Проверка, что функция возвращает базовую ошибку.', () => {
-    expect(getMinLengthRule(1)).toEqual({
-      value: 1,
-      message: `Minimum length - ${1}.`
-    })
-  })
-
-  test('Проверка, что функция возвращает базовую ошибку и переданное минимальное значение.', () => {
-    expect(getMinLengthRule(111)).toEqual({
-      value: 111,
-      message: `Minimum length - 111.`
-    })
-  })
-})

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

@@ -1,24 +0,0 @@
-import { getMinRule } from "../get-min-rule";
-
-describe('Тестирование функции getMinRule', () => {
-  test('Проверка, что функция возвращает кастомное сообщение с ошибкой.', () => {
-    expect(getMinRule(1, 'test message')).toEqual({
-      value: 1,
-      message: 'test message',
-    })
-  })
-
-  test('Проверка, что функция возвращает базовую ошибку.', () => {
-    expect(getMinRule(1)).toEqual({
-      value: 1,
-      message: `Minimum value - 1.`
-    })
-  })
-
-  test('Проверка, что функция возвращает базовую ошибку и переданное минимальное значение.', () => {
-    expect(getMinRule(111)).toEqual({
-      value: 111,
-      message: `Minimum value - 111.`
-    })
-  })
-})

package/rules/default/tests/get-required-rule.test.ts

@@ -1,10 +0,0 @@
-import { getRequiredRule } from '../get-require-rule'
-
-describe('Тестирование функции getRequiredRule', () => {
-  test('Проверка, что функция возвращает кастомное сообщение с ошибкой.', () => {
-    expect(getRequiredRule(true, 'test message')).toEqual({
-      value: true,
-      message: 'test message',
-    })
-  })
-})

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

@@ -1,20 +0,0 @@
-import { translate } from "../../i18n";
-
-/**
- * Validates an object, checking if it contains values.
- * @param {Object} obj - Object with values.
- * @param {string} message - Custom message.
- * 
- * @example rules: { validate: (obj) => getRequiredObjectRule(obj) }
- */
-export const getRequiredObjectRule = (obj: Record<string, unknown>, message?: string) => {
-  const formattedMessage = message || translate("required");
-
-  if (!obj) {
-    return false || formattedMessage;
-  }
-
-  const isEmpty = Object?.keys(obj)?.length > 0;
-
-  return isEmpty || formattedMessage;
-};

package/rules/object/tests/get-require-object-rule.test.ts

@@ -1,18 +0,0 @@
-import { REQUIRED_MESSAGE_TEXT } from '../../constants'
-import { getRequiredObjectRule } from '../get-required-object-rule'
-
-describe('Тестирование функции getRequireObjectRule', () => {
-  test('Проверка, что функция возвращает кастомное сообщение с ошибкой, когда объект не содержит значения.', () => {
-    expect(getRequiredObjectRule({}, 'test message')).toBe('test message')
-  })
-
-  test('Проверка, что функция возвращает true, когда объект не пустой.', () => {
-    expect(getRequiredObjectRule({ test: '123' })).toBe(true)
-  })
-
-  test('Проверка, что функция возвращает базовое сообщение, когда объект пустой.', () => {
-    expect(getRequiredObjectRule({})).toBe(REQUIRED_MESSAGE_TEXT)
-  })
-})
-
-

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

@@ -1,22 +0,0 @@
-import { getPatternRule } from "./get-pattern-rule";
-import { translate } from "../../i18n";
-
-const DEFAULT_PATTERN = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/;
-
-interface EmailRule {
-  pattern?: RegExp;
-  message?: string;
-}
-
-/**
- * Validates an email address.
- * @param options - Parameters.
- * @param {string} options.pattern - Regular expression.
- * @param {string} options.message - Custom message.
- *
- * @example rules: { pattern: getEmailRule({}) }
- */
-export const getEmailRule = ({
-  pattern = DEFAULT_PATTERN,
-  message = translate('email'),
-}: EmailRule) => getPatternRule(pattern, message)

package/rules/patterns/get-pattern-rule.ts

@@ -1,12 +0,0 @@
-/**
- * Returns a rule that validates the pattern.
- * @param options - Parameters.
- * @param options.pattern - Regular expression.
- * @param options.message - Custom message.
- *
- * @example rules: { pattern: getPatternRule(pattern) }
- */
-export const getPatternRule = (pattern: RegExp, message: string) => ({
-  value: pattern,
-  message,
-})