@astral/validations 4.14.3 → 4.14.5

package/core/utils/isHasConsecutiveChars/isHasConsecutiveChars.d.ts

@@ -1,4 +1,4 @@
 /**
- * @description Проверяет, что текст не может содержать последовательно два спецсимвола/пробела
+ * Проверяет, что текст не может содержать последовательно два спецсимвола/пробела
  */
 export declare const isHasConsecutiveChars: (value: string) => boolean;

package/core/utils/isHasConsecutiveChars/isHasConsecutiveChars.js

@@ -1,4 +1,4 @@
 /**
- * @description Проверяет, что текст не может содержать последовательно два спецсимвола/пробела
+ * Проверяет, что текст не может содержать последовательно два спецсимвола/пробела
  */
 export const isHasConsecutiveChars = (value) => /([`~!@#$%^&*()\-_=+[{\]}\|;:'",<.>/?])\1|\s{2}/.test(value);

package/core/utils/isNoDoubleZeroStart/isNoDoubleZeroStart.d.ts

@@ -1,4 +1,4 @@
 /**
- * @description Используется для проверки того, что строка не начинается с '00'
+ * Используется для проверки того, что строка не начинается с '00'
  */
 export declare const isNoDoubleZeroStart: (str: string) => boolean;

package/core/utils/isNoDoubleZeroStart/isNoDoubleZeroStart.js

@@ -1,4 +1,4 @@
 /**
- * @description Используется для проверки того, что строка не начинается с '00'
+ * Используется для проверки того, что строка не начинается с '00'
  */
 export const isNoDoubleZeroStart = (str) => !str.startsWith('00');

package/core/utils/isStartsWithAndEndsWithLetter/isStartsWithAndEndsWithLetter.d.ts

@@ -1,4 +1,4 @@
 /**
- * @description Проверяет, что текст начинается с буквы и заканчивается буквой, кроме скобок ()
+ * Проверяет, что текст начинается с буквы и заканчивается буквой, кроме скобок ()
  */
 export declare const isStartsWithAndEndsWithLetter: (value: string) => boolean;

package/core/utils/isStartsWithAndEndsWithLetter/isStartsWithAndEndsWithLetter.js

@@ -1,4 +1,4 @@
 /**
- * @description Проверяет, что текст начинается с буквы и заканчивается буквой, кроме скобок ()
+ * Проверяет, что текст начинается с буквы и заканчивается буквой, кроме скобок ()
  */
 export const isStartsWithAndEndsWithLetter = (value) => !/^[IV а-яёА-ЯЁ()](?:.*[IV а-яёА-ЯЁ()])?$/.test(value);

package/core/utils/isStringOfZeros/isStringOfZeros.d.ts

@@ -1,4 +1,4 @@
 /**
- * @description Используется для проверки того, состоит ли строка целиком из 0
+ * Используется для проверки того, состоит ли строка целиком из 0
  */
 export declare const isStringOfZeros: (value: string) => boolean;

package/core/utils/isStringOfZeros/isStringOfZeros.js

@@ -1,5 +1,5 @@
 /**
- * @description Используется для проверки того, состоит ли строка целиком из 0
+ * Используется для проверки того, состоит ли строка целиком из 0
  */
 export const isStringOfZeros = (value) => {
     if (value) {

package/core/utils/isValidFullNameLength/isValidFullNameLength.d.ts

@@ -1,4 +1,4 @@
 /**
- * @description Проверяет, что длина значения находится в допустимом диапазоне от 1 до 200 символов
+ * Проверяет, что длина значения находится в допустимом диапазоне от 1 до 200 символов
  */
 export declare const isValidFullNameLength: (value: string) => boolean;

package/core/utils/isValidFullNameLength/isValidFullNameLength.js

@@ -1,4 +1,4 @@
 /**
- * @description Проверяет, что длина значения находится в допустимом диапазоне от 1 до 200 символов
+ * Проверяет, что длина значения находится в допустимом диапазоне от 1 до 200 символов
  */
 export const isValidFullNameLength = (value) => value.length < 1 || value.length > 200;

package/core/utils/resetTime/resetTime.d.ts

@@ -1,5 +1,5 @@
 /**
- * @description Сбрасывает время для даты в 0
+ * Сбрасывает время для даты в 0
  * @param date
  */
 export declare const resetTime: (date: Date) => Date;

package/core/utils/resetTime/resetTime.js

@@ -1,5 +1,5 @@
 /**
- * @description Сбрасывает время для даты в 0
+ * Сбрасывает время для даты в 0
  * @param date
  */
 export const resetTime = (date) => {

package/date/date.d.ts

@@ -3,7 +3,7 @@ type AdditionalDefOptions = {
     invalidDateErrorMessage?: string;
 };
 /**
- * @description Guard для Date object. Проверяет значение на соответствие объекту Date и на валидность даты
+ * Guard для Date object. Проверяет значение на соответствие объекту Date и на валидность даты
  * @param rules - правила, валидирующие Date или unknown value
  * @example
  * ```ts

package/date/date.js

@@ -1,7 +1,7 @@
 import { compose, createGuard } from '../core';
 import { DATE_TYPE_ERROR_INFO, INVALID_DATE_ERROR_INFO } from './constants';
 /**
- * @description Guard для Date object. Проверяет значение на соответствие объекту Date и на валидность даты
+ * Guard для Date object. Проверяет значение на соответствие объекту Date и на валидность даты
  * @param rules - правила, валидирующие Date или unknown value
  * @example
  * ```ts

package/deepPartial/deepPartial.d.ts

@@ -1,6 +1,6 @@
 import { type Guard } from '../core';
 /**
- * @description Делает partial все object в схеме, независимо от уровня вложенности правил
+ * Делает partial все object в схеме, независимо от уровня вложенности правил
  * @param guard - любой guard
  * @example
  * ```ts

package/deepPartial/deepPartial.js

@@ -1,6 +1,6 @@
 import { createRule } from '../core';
 /**
- * @description Делает partial все object в схеме, независимо от уровня вложенности правил
+ * Делает partial все object в схеме, независимо от уровня вложенности правил
  * @param guard - любой guard
  * @example
  * ```ts

package/email/email.d.ts

@@ -1,19 +1,19 @@
 type EmailParams = {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
     /**
-     * @description Замена стандартного сообщения ошибки при превышении допустимого количества символов.
+     * Замена стандартного сообщения ошибки при превышении допустимого количества символов.
      */
     invalidLengthMessage?: string;
     /**
-     * @description Замена стандартного сообщения ошибки для повторяющихся точек.
+     * Замена стандартного сообщения ошибки для повторяющихся точек.
      */
     doubleDotsErrorMessage?: string;
 };
 /**
- * @description Проверяет валидность email. Не работает с русскими доменами
+ * Проверяет валидность email. Не работает с русскими доменами
  * @example
  * ```ts
  *  const validate = string(email());

package/email/email.js

@@ -1,7 +1,7 @@
 import { createRule } from '../core';
 import { DOUBLE_DOTS_EMAIL_ERROR_INFO, EMAIL_MAX_LENGTH, EMAIL_REGEXP, INVALID_EMAIL_ERROR_INFO, LENGTH_EMAIL_ERROR_INFO, } from './constants';
 /**
- * @description Проверяет валидность email. Не работает с русскими доменами
+ * Проверяет валидность email. Не работает с русскими доменами
  * @example
  * ```ts
  *  const validate = string(email());

package/enabled/enabled.d.ts

@@ -1,7 +1,7 @@
 import { type ValidationContext, type ValidationRule } from '../core';
 type Params<TLastSchemaValues extends Record<string, unknown>> = {
     /**
-     * @description Условие для включения схемы
+     * Условие для включения схемы
      */
     is: (value: unknown, ctx: ValidationContext<TLastSchemaValues>) => boolean;
     /**
@@ -10,7 +10,7 @@ type Params<TLastSchemaValues extends Record<string, unknown>> = {
     then: ValidationRule<unknown, TLastSchemaValues>;
 };
 /**
- * @description Позволяет указывать условные валидации
+ * Позволяет указывать условные валидации
  * @example
  * ```ts
  * type Values = { name: string; isAgree: boolean };

package/enabled/enabled.js

@@ -1,7 +1,7 @@
 import { any } from '../any';
 import { callRule, createRule, } from '../core';
 /**
- * @description Позволяет указывать условные валидации
+ * Позволяет указывать условные валидации
  * @example
  * ```ts
  * type Values = { name: string; isAgree: boolean };

package/guid/guid.d.ts

@@ -1,11 +1,11 @@
 type GuidParams = {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет валидность GUID.
+ * Проверяет валидность GUID.
  * @example
  * ```ts
  *  const validate = string(guid());

package/guid/guid.js

@@ -1,7 +1,7 @@
 import { createRule } from '../core';
 import { GUID_REGEXP, INVALID_GUID_ERROR_INFO } from './constants';
 /**
- * @description Проверяет валидность GUID.
+ * Проверяет валидность GUID.
  * @example
  * ```ts
  *  const validate = string(guid());

package/innFL/constants.js

@@ -1,5 +1,5 @@
 import { createErrorCode } from '../core';
 export const INN_FL_ERROR_INFO = {
     code: createErrorCode('innFL'),
-    message: 'Некорректный ИНН ФЛ',
+    message: 'Проверьте ИНН',
 };

package/innFL/innFL.d.ts

@@ -1,12 +1,12 @@
 import { type CommonRuleParams } from '../core';
 type InnFLParams = CommonRuleParams<string> & {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет валиден ли ИНН ФЛ
+ * Проверяет валиден ли ИНН ФЛ
  * @example
  * ```ts
  * const validate = string(innFL());

package/innFL/innFL.js

@@ -2,7 +2,7 @@ import { createRule } from '../core';
 import { innTwelveSymbols } from '../innTwelveSymbols';
 import { INN_FL_ERROR_INFO } from './constants';
 /**
- * @description Проверяет валиден ли ИНН ФЛ
+ * Проверяет валиден ли ИНН ФЛ
  * @example
  * ```ts
  * const validate = string(innFL());

package/innIP/constants.js

@@ -1,5 +1,5 @@
 import { createErrorCode } from '../core';
 export const INN_IP_ERROR_INFO = {
     code: createErrorCode('innIP'),
-    message: 'Некорректный ИНН ИП',
+    message: 'Проверьте ИНН',
 };

package/innIP/innIP.d.ts

@@ -1,12 +1,12 @@
 import { type CommonRuleParams } from '../core';
 type InnIPParams = CommonRuleParams<string> & {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет валиден ли ИНН ИП
+ * Проверяет валиден ли ИНН ИП
  * @example
  * ```ts
  * const validate = string(innIP());

package/innIP/innIP.js

@@ -2,7 +2,7 @@ import { createRule, isNoDoubleZeroStart, isStringOfZeros, } from '../core';
 import { innTwelveSymbols } from '../innTwelveSymbols';
 import { INN_IP_ERROR_INFO } from './constants';
 /**
- * @description Проверяет валиден ли ИНН ИП
+ * Проверяет валиден ли ИНН ИП
  * @example
  * ```ts
  * const validate = string(innIP());

package/innTwelveSymbols/innTwelveSymbols.d.ts

@@ -1,12 +1,12 @@
 import { type CommonRuleParams } from '../core';
 type InnTwelveSymbolsParams = CommonRuleParams<string> & {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет, валиден ли ИНН из 12 символов
+ * Проверяет, валиден ли ИНН из 12 символов
  * @example
  * ```ts
  * const validate = string(innTwelveSymbols());

package/innTwelveSymbols/innTwelveSymbols.js

@@ -11,7 +11,7 @@ const secondCheckSumForInnTwelveSymbols = (arrSymbols) => (arrSymbols
     11) %
     10;
 /**
- * @description Проверяет, валиден ли ИНН из 12 символов
+ * Проверяет, валиден ли ИНН из 12 символов
  * @example
  * ```ts
  * const validate = string(innTwelveSymbols());

package/innUL/constants.js

@@ -1,7 +1,7 @@
 import { createErrorCode } from '../core';
 export const INN_UL_ERROR_INFO = {
     code: createErrorCode('innUL'),
-    message: 'Некорректный ИНН ЮЛ',
+    message: 'Проверьте ИНН',
 };
 export const INN_UL_LENGTH = 10;
 export const INN_UL_DECODING = [2, 4, 10, 3, 5, 9, 4, 6, 8];

package/innUL/innUL.d.ts

@@ -1,12 +1,12 @@
 import { type CommonRuleParams } from '../core';
 type InnULParams = CommonRuleParams<string> & {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет валиден ли ИНН ЮЛ
+ * Проверяет валиден ли ИНН ЮЛ
  * @example
  * ```ts
  * const validate = string(innUL());

package/innUL/innUL.js

@@ -6,7 +6,7 @@ const calcCheckSumForInnUl = (arrSymbols) => (arrSymbols
     11) %
     10;
 /**
- * @description Проверяет валиден ли ИНН ЮЛ
+ * Проверяет валиден ли ИНН ЮЛ
  * @example
  * ```ts
  * const validate = string(innUL());

package/integer/integer.d.ts

@@ -1,6 +1,6 @@
 type IntegerParams = {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };

package/kpp/kpp.d.ts

@@ -1,12 +1,12 @@
 import { type CommonRuleParams } from '../core';
 type KPPParams = CommonRuleParams<string> & {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет валидность кода КПП
+ * Проверяет валидность кода КПП
  * @example
  * ```ts
  * const validate = string(kpp());

package/kpp/kpp.js

@@ -1,7 +1,7 @@
 import { createRule, isNoDoubleZeroStart, isStringOfZeros, } from '../core';
 import { INVALID_KPP_ERROR_INFO, KPP_DOUBLE_ZERO_START_ERROR_INFO, KPP_REGEX, KPP_ZEROS_ONLY_ERROR_INFO, } from './constants';
 /**
- * @description Проверяет валидность кода КПП
+ * Проверяет валидность кода КПП
  * @example
  * ```ts
  * const validate = string(kpp());

package/length/length.d.ts

@@ -1,11 +1,11 @@
 type LengthParams = {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет значение на соответствие длине. Работает с: string
+ * Проверяет значение на соответствие длине. Работает с: string
  * @param len - целевой кол-во символов
  * @example
  *  // Длина строки должна быть 5 символов

package/length/length.js

@@ -1,7 +1,7 @@
 import { createRule } from '../core';
 import { STRING_LENGTH_ERROR_CODE } from './constants';
 /**
- * @description Проверяет значение на соответствие длине. Работает с: string
+ * Проверяет значение на соответствие длине. Работает с: string
  * @param len - целевой кол-во символов
  * @example
  *  // Длина строки должна быть 5 символов

package/max/max.d.ts

@@ -3,12 +3,12 @@ type BaseMaxValidationTypes = number | string | Array<unknown>;
 type CommonThreshold = number | Date;
 type MaxParams<ValidationType> = {
     /**
-     * @description Сообщение ошибки
+     * Сообщение ошибки
      */
     getMessage?: (threshold: CommonThreshold, value: ValidationType, ctx: ValidationContext) => string;
 };
 /**
- * @description Проверяет значение на соответствие максимуму. Работает с: string, array, Date, number
+ * Проверяет значение на соответствие максимуму. Работает с: string, array, Date, number
  * @param threshold - верхний доступный порог value
  * @example
  * ```ts

package/min/min.d.ts

@@ -3,12 +3,12 @@ type BaseMinValidationTypes = number | string | Array<unknown>;
 type CommonThreshold = number | Date;
 type MinParams<ValidationType> = {
     /**
-     * @description Сообщение ошибки
+     * Сообщение ошибки
      */
     getMessage?: (threshold: CommonThreshold, value: ValidationType, ctx: ValidationContext) => string;
 };
 /**
- * @description Проверяет значение на соответствие минимуму. Работает с: string, array, Date, number
+ * Проверяет значение на соответствие минимуму. Работает с: string, array, Date, number
  * @param threshold - нижний доступный порог value
  * @example
  * ```ts

package/minYearsOld/minYearsOld.d.ts

@@ -1,11 +1,11 @@
 type MinYearsOldParams = {
     /**
-     * @description Кастомное сообщение ошибки
+     * Кастомное сообщение ошибки
      */
     customErrorMessage: string;
 };
 /**
- * @description Проверяет дату рождения на соответствие условию. Работает с date.
+ * Проверяет дату рождения на соответствие условию. Работает с date.
  * @param age - ограничение по возрасту (коло-во лет, вычитаемое из текущей даты для валидации)
  * @param params - объект параметров
  * @example

package/minYearsOld/minYearsOld.js

@@ -1,7 +1,7 @@
 import { createRule } from '../core';
 import { BIRTH_DATE_MAX_ERROR_CODE, BIRTH_DATE_MIN, BIRTH_DATE_MIN_ERROR_CODE, } from './constants';
 /**
- * @description Проверяет дату рождения на соответствие условию. Работает с date.
+ * Проверяет дату рождения на соответствие условию. Работает с date.
  * @param age - ограничение по возрасту (коло-во лет, вычитаемое из текущей даты для валидации)
  * @param params - объект параметров
  * @example

package/mobilePhone/mobilePhone.d.ts

@@ -1,7 +1,7 @@
 import { type CommonRuleParams } from '../core';
 type MobilePhoneParams = CommonRuleParams<string> & {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };

package/number/number.d.ts

@@ -4,7 +4,7 @@ type AdditionalDefOptions = {
     infinityErrorMessage?: string;
 };
 /**
- * @description Guard для number. Проверяет значение на тип number и NaN, Infinity
+ * Guard для number. Проверяет значение на тип number и NaN, Infinity
  * Для NaN и Infinity возвращаются отдельные ошибки
  * @param rules - правила, валидирующие number или unknown value
  * @example

package/number/number.js

@@ -1,7 +1,7 @@
 import { compose, createGuard } from '../core';
 import { INFINITY_NUMBER_ERROR_INFO, NAN_NUMBER_ERROR_INFO, NUMBER_TYPE_ERROR_INFO, } from './constants';
 /**
- * @description Guard для number. Проверяет значение на тип number и NaN, Infinity
+ * Guard для number. Проверяет значение на тип number и NaN, Infinity
  * Для NaN и Infinity возвращаются отдельные ошибки
  * @param rules - правила, валидирующие number или unknown value
  * @example

package/object/isEmptyErrors/isEmptyErrors.d.ts

@@ -1,5 +1,5 @@
 import { type ErrorMap } from '../../core';
 /**
- * @description Проверяет есть ли errorMap ошибки
+ * Проверяет есть ли errorMap ошибки
  */
 export declare const isEmptyErrors: (errorMap: ErrorMap) => boolean;

package/object/isEmptyErrors/isEmptyErrors.js

@@ -1,4 +1,4 @@
 /**
- * @description Проверяет есть ли errorMap ошибки
+ * Проверяет есть ли errorMap ошибки
  */
 export const isEmptyErrors = (errorMap) => Object.values(errorMap).every((error) => error === undefined);

package/object/object.d.ts

@@ -1,6 +1,6 @@
 import { type Guard, type ValidationContext, type ValidationRule } from '../core';
 /**
- * @description Специальный итерфейс Guard для object. В данном интерфейсе ctx required
+ * Специальный итерфейс Guard для object. В данном интерфейсе ctx required
  * Переопределение необходимо для того, чтобы ts показывал, что ctx required в кастомных правилах
  */
 interface ObjectPropGuard<TLastSchemaValues extends Record<string, unknown>> {
@@ -9,20 +9,20 @@ interface ObjectPropGuard<TLastSchemaValues extends Record<string, unknown>> {
 }
 type AdditionalDefOptions = {
     /**
-     * @description Делает все свойства объекта partial
+     * Делает все свойства объекта partial
      */
     isPartial?: boolean;
 };
 /**
- * @description Возможные значения, принимаемые схемой
+ * Возможные значения, принимаемые схемой
  */
 export type SchemaValue<TValue extends Record<string, unknown>> = ObjectPropGuard<TValue> | ValidationRule<unknown, TValue>;
 /**
- * @description Схема правил валдиации для объекта
+ * Схема правил валдиации для объекта
  */
 export type Schema<TValue extends Record<string, unknown>> = Record<keyof TValue, SchemaValue<TValue>>;
 /**
- * @description Guard для объекта
+ * Guard для объекта
  * @param schema - схема валидации объекта
  * @example
  * ```ts

package/object/object.js

@@ -4,7 +4,7 @@ import { optional } from '../optional';
 import { isEmptyErrors } from './isEmptyErrors';
 import { OBJECT_TYPE_ERROR_INFO } from './constants';
 /**
- * @description Guard для объекта
+ * Guard для объекта
  * @param schema - схема валидации объекта
  * @example
  * ```ts

package/object/objectAsync/objectAsync.d.ts

@@ -1,6 +1,6 @@
 import { type AsyncGuard, type AsyncValidationRule, type Guard, type ValidationContext, type ValidationRule } from '../../core';
 /**
- * @description Специальный итерфейс Guard для object. В данном интерфейсе ctx required
+ * Специальный итерфейс Guard для object. В данном интерфейсе ctx required
  * Переопределение необходимо для того, чтобы ts показывал, что ctx required в кастомных правилах
  */
 interface ObjectPropGuard<TLastSchemaValues extends Record<string, unknown>> {
@@ -13,20 +13,20 @@ interface AsyncObjectPropGuard<TLastSchemaValues extends Record<string, unknown>
 }
 type AdditionalDefOptions = {
     /**
-     * @description Делает все свойства объекта partial
+     * Делает все свойства объекта partial
      */
     isPartial?: boolean;
 };
 /**
- * @description Возможные значения, принимаемые схемой
+ * Возможные значения, принимаемые схемой
  */
 export type AsyncSchemaValue<TValue extends Record<string, unknown>> = ObjectPropGuard<TValue> | AsyncObjectPropGuard<TValue> | ValidationRule<unknown, TValue> | AsyncValidationRule<unknown, TValue>;
 /**
- * @description Схема правил валдиации для объекта
+ * Схема правил валдиации для объекта
  */
 export type AsyncSchema<TValue extends Record<string, unknown>> = Record<keyof TValue, AsyncSchemaValue<TValue>>;
 /**
- * @description Guard для объекта, который поддерживает асинхронную валидацию
+ * Guard для объекта, который поддерживает асинхронную валидацию
  * @example
  * ```ts
  * type Values = {

package/object/objectAsync/objectAsync.js

@@ -14,7 +14,7 @@ import { isEmptyErrors } from '../isEmptyErrors';
 import { OBJECT_TYPE_ERROR_INFO } from '../constants';
 // TODO: необходимо реализовать переиспользование логики между object и objectAsync
 /**
- * @description Guard для объекта, который поддерживает асинхронную валидацию
+ * Guard для объекта, который поддерживает асинхронную валидацию
  * @example
  * ```ts
  * type Values = {

package/ogrnIP/ogrnIP.d.ts

@@ -1,12 +1,12 @@
 import { type CommonRuleParams } from '../core';
 type OgrnIPParams = CommonRuleParams<string> & {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет валиден ли ОГРН ИП
+ * Проверяет валиден ли ОГРН ИП
  * @example
  * ```ts
  * const validate = string(ogrnIP());