@astral/validations 4.14.4 → 4.14.6

package/ogrnUL/ogrnUL.d.ts

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

package/ogrnUL/ogrnUL.js

@@ -1,7 +1,7 @@
 import { createRule, isStringOfZeros } from '../core';
 import { OGRN_UL_ERROR_INFO, OGRN_UL_LENGTH } from './constants';
 /**
- * @description Проверяет валиден ли ОГРН ЮЛ
+ * Проверяет валиден ли ОГРН ЮЛ
  * @example
  * ```ts
  * const validate = string(ogrnIP());

package/onlyNumber/onlyNumber.d.ts

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

package/onlyNumber/onlyNumber.js

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

package/optional/optional.d.ts

@@ -1,6 +1,6 @@
 import { type IndependentValidationRule, type ValidationRule } from '../core';
 /**
- * @description Выключает проверку на required в guard
+ * Выключает проверку на required в guard
  * @example object({ name: optional(string(min(22))) })
  */
 export declare const optional: <TLastSchemaValues extends Record<string, unknown>>(rule: ValidationRule<unknown, TLastSchemaValues>) => IndependentValidationRule<unknown, TLastSchemaValues>;

package/optional/optional.js

@@ -1,6 +1,6 @@
 import { callRule, createContext, } from '../core';
 /**
- * @description Выключает проверку на required в guard
+ * Выключает проверку на required в guard
  * @example object({ name: optional(string(min(22))) })
  */
 export const optional = (rule) => (value, ctx) => callRule(rule, value, createContext(ctx, value, { isOptional: true }));

package/optional/optionalAsync/optionalAsync.d.ts

@@ -1,6 +1,6 @@
 import { type AsyncIndependentValidationRule, type AsyncValidationRule, type ValidationRule } from '../../core';
 /**
- * @description Выключает проверку на required в guard. Предназначен для асинхронных правил.
+ * Выключает проверку на required в guard. Предназначен для асинхронных правил.
  * @example object({ name: optionalAsync(stringAsync(min(22))) })
  */
 export declare const optionalAsync: <TLastSchemaValues extends Record<string, unknown>>(rule: AsyncValidationRule<unknown, TLastSchemaValues> | ValidationRule<unknown, TLastSchemaValues>) => AsyncIndependentValidationRule<unknown, TLastSchemaValues>;

package/optional/optionalAsync/optionalAsync.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { callAsyncRule, createContext, } from '../../core';
 // TODO: необходимо добавить возможность использовать вложенные guards
 /**
- * @description Выключает проверку на required в guard. Предназначен для асинхронных правил.
+ * Выключает проверку на required в guard. Предназначен для асинхронных правил.
  * @example object({ name: optionalAsync(stringAsync(min(22))) })
  */
 export const optionalAsync = (rule) => (value, ctx) => __awaiter(void 0, void 0, void 0, function* () {

package/or/or.d.ts

@@ -1,6 +1,6 @@
 import { type ValidationResult, type ValidationRule } from '../core';
 /**
- * @description Выполняет переданные правила аналогично оператору ||. Если одно из правил не завершилось ошибкой, то or вернет undefined
+ * Выполняет переданные правила аналогично оператору ||. Если одно из правил не завершилось ошибкой, то or вернет undefined
  * Если все переданные правила завершились с ошибкой, то вернется ошибка из последнего правила
  * @param rules - любые правила валдиаций
  * @example

package/or/or.js

@@ -1,6 +1,6 @@
 import { callRule, createRule, } from '../core';
 /**
- * @description Выполняет переданные правила аналогично оператору ||. Если одно из правил не завершилось ошибкой, то or вернет undefined
+ * Выполняет переданные правила аналогично оператору ||. Если одно из правил не завершилось ошибкой, то or вернет undefined
  * Если все переданные правила завершились с ошибкой, то вернется ошибка из последнего правила
  * @param rules - любые правила валдиаций
  * @example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astral/validations",
-  "version": "4.14.4",
+  "version": "4.14.6",
   "browser": "./index.js",
   "main": "./index.js",
   "dependencies": {

package/partial/partial.d.ts

@@ -1,6 +1,6 @@
 import { type object } from '../object';
 /**
- * @description Выключает проверку на required для всех полей объекта
+ * Выключает проверку на required для всех полей объекта
  * @param objectGuard
  * @example partial(object({ name: string() }))
  */

package/partial/partial.js

@@ -1,5 +1,5 @@
 /**
- * @description Выключает проверку на required для всех полей объекта
+ * Выключает проверку на required для всех полей объекта
  * @param objectGuard
  * @example partial(object({ name: string() }))
  */

package/passportCode/passportCode.d.ts

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

package/passportCode/passportCode.js

@@ -2,7 +2,7 @@ import { createRule, isNoDoubleZeroStart, } from '../core';
 import { onlyNumber } from '../onlyNumber';
 import { PASSPORT_CODE_ERROR_INFO, PASSPORT_CODE_LENGTH_ERROR_INFO, PASSPORT_CODE_ONLY_DIGITS_ERROR_INFO, } from './constants';
 /**
- * @description Проверяет валиден ли код паспорта
+ * Проверяет валиден ли код паспорта
  * @example
  * ```ts
  * const validate = string(passportCode());

package/passportNumber/passportNumber.d.ts

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

package/passportNumber/passportNumber.js

@@ -2,7 +2,7 @@ import { onlyNumber } from '../onlyNumber';
 import { createRule } from '../core';
 import { PASSPORT_NUMBER_ERROR_INFO, PASSPORT_NUMBER_LENGTH_ERROR_INFO, PASSPORT_NUMBER_ONLY_DIGITS_ERROR_INFO, } from './constants';
 /**
- * @description Проверяет валиден ли номер паспорта
+ * Проверяет валиден ли номер паспорта
  * @example
  * ```ts
  * const validate = string(passportNumber());

package/passportSeries/passportSeries.d.ts

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

package/passportSeries/passportSeries.js

@@ -2,7 +2,7 @@ import { createRule, isNoDoubleZeroStart, } from '../core';
 import { onlyNumber } from '../onlyNumber';
 import { PASSPORT_SERIES_ERROR_INFO, PASSPORT_SERIES_ERROR_LENGTH_INFO, PASSPORT_SERIES_ONLY_DIGITS_ERROR_INFO, } from './constants';
 /**
- * @description Проверяет валидна ли серия паспорта
+ * Проверяет валидна ли серия паспорта
  * @example
  * ```ts
  * const validate = string(passportSeries());

package/pattern/pattern.d.ts

@@ -1,11 +1,11 @@
 type PatternParams = {
     /**
-     * @description Замена стандартного сообщения ошибки.
+     * Замена стандартного сообщения ошибки.
      */
     message?: string;
 };
 /**
- * @description Проверяет строку на соответствие регулярному выражению.
+ * Проверяет строку на соответствие регулярному выражению.
  * @param regex - регулярное выражение
  * @example
  * ```ts

package/pattern/pattern.js

@@ -1,7 +1,7 @@
 import { createRule } from '../core';
 import { PATTERN_ERROR_CODE } from './constants';
 /**
- * @description Проверяет строку на соответствие регулярному выражению.
+ * Проверяет строку на соответствие регулярному выражению.
  * @param regex - регулярное выражение
  * @example
  * ```ts

package/personName/personName.d.ts

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

package/personName/personName.js

@@ -1,7 +1,7 @@
 import { createRule, isFullNameValidCharacters, isHasConsecutiveChars, isStartsWithAndEndsWithLetter, isValidFullNameLength, } from '../core';
 import { PERSON_NAME_ERROR_INFO } from './constants';
 /**
- * @description Проверяет валидно ли имя
+ * Проверяет валидно ли имя
  * @example
  * ```ts
  * const validate = string(personName());

package/personPatronymic/personPatronymic.d.ts

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

package/personPatronymic/personPatronymic.js

@@ -1,7 +1,7 @@
 import { createRule, isFullNameValidCharacters, isHasConsecutiveChars, isStartsWithAndEndsWithLetter, isValidFullNameLength, } from '../core';
 import { PERSON_PATRONYMIC_ERROR_INFO } from './constants';
 /**
- * @description Проверяет валидно ли отчество
+ * Проверяет валидно ли отчество
  * @example
  * ```ts
  * const validate = string(personPatronymic());

package/personSurname/personSurname.d.ts

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

package/personSurname/personSurname.js

@@ -1,7 +1,7 @@
 import { createRule, isFullNameValidCharacters, isHasConsecutiveChars, isStartsWithAndEndsWithLetter, isValidFullNameLength, } from '../core';
 import { PERSON_SURNAME_ERROR_INFO } from './constants';
 /**
- * @description Проверяет валидно ли фамилия
+ * Проверяет валидно ли фамилия
  * @example
  * ```ts
  * const validate = string(personSurname());

package/positiveNumber/positiveNumber.d.ts

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

package/snils/constants.js

@@ -1,7 +1,7 @@
 import { createErrorCode } from '../core';
 export const SNILS_ERROR_INFO = {
     code: createErrorCode('snils'),
-    message: 'Некорректный СНИЛС',
+    message: 'Проверьте СНИЛС',
 };
 export const RESTRICTED_VALUES = ['00000000000'];
 export const DEFAULT_CHECKED_SUM = [0, 100, 101];

package/snils/snils.d.ts

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

package/snils/snils.js

@@ -14,7 +14,7 @@ const compareCheckSum = (calculatedCheckSum, checkSum) => {
             checkSum === DEFAULT_CHECKED_SUM[0]));
 };
 /**
- * @description Проверяет валиден ли СНИЛС
+ * Проверяет валиден ли СНИЛС
  * @example
  * ```ts
  * const validate = string(snils());

package/textField/textField.d.ts

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

package/textField/textField.js

@@ -1,7 +1,7 @@
 import { createRule } from '../core';
 import { INVALID_TEXT_FIELD_ERROR_INFO, LENGTH_TEXT_FIELD_ERROR_INFO, TEXT_FIELD_MAX_LENGTH, TEXT_FIELD_REGEXP, } from './constants';
 /**
- * @description Проверяет валидность текстового поля
+ * Проверяет валидность текстового поля
  * @example
  * ```ts
  *  const validate = string(textField());

package/toPlainError/toPlainError.d.ts

@@ -7,11 +7,11 @@ type FormatSimpleErrorFunc<TPlainSimpleError> = (error: ValidationSimpleError, p
     path: string;
 }) => TPlainSimpleError;
 /**
- * @description Результат валидации, преобразованный в простые структуры данных (исходные - это инстансы error)
+ * Результат валидации, преобразованный в простые структуры данных (исходные - это инстансы error)
  */
 export type PlainValidationResult<TPlainSimpleError> = undefined | TPlainSimpleError | PlainArrayResult<TPlainSimpleError> | PlainErrorMap<TPlainSimpleError>;
 /**
- * @description Форматирует все ошибки валидации в простые объекты. Необходим для интеграции с другими библиотеками
+ * Форматирует все ошибки валидации в простые объекты. Необходим для интеграции с другими библиотеками
  * @param validationResult
  * @param formatErrorInfo - позволяет отформатировать объект ошибки при его формировании
  * @param path - путь до ошибки в схеме

package/toPlainError/toPlainError.js

@@ -15,7 +15,7 @@ function toPlainErrorMap(error, formatErrorInfo, path) {
     }, {});
 }
 /**
- * @description Форматирует все ошибки валидации в простые объекты. Необходим для интеграции с другими библиотеками
+ * Форматирует все ошибки валидации в простые объекты. Необходим для интеграции с другими библиотеками
  * @param validationResult
  * @param formatErrorInfo - позволяет отформатировать объект ошибки при его формировании
  * @param path - путь до ошибки в схеме

package/toPlainError/utils/generateArrayPath/generateArrayPath.d.ts

@@ -1,4 +1,4 @@
 /**
- * @description Гененирует path для массива
+ * Гененирует path для массива
  */
 export declare const generateArrayPath: (index: number, prevPath?: string) => string;

package/toPlainError/utils/generateArrayPath/generateArrayPath.js

@@ -1,5 +1,5 @@
 /**
- * @description Гененирует path для массива
+ * Гененирует path для массива
  */
 export const generateArrayPath = (index, prevPath) => {
     if (prevPath) {

package/toPlainError/utils/generateObjectPath/generateObjectPath.d.ts

@@ -1,4 +1,4 @@
 /**
- * @description Гененирует path для объекта
+ * Гененирует path для объекта
  */
 export declare const generateObjectPath: (key: string, prevPath?: string) => string;

package/toPlainError/utils/generateObjectPath/generateObjectPath.js

@@ -1,5 +1,5 @@
 /**
- * @description Гененирует path для объекта
+ * Гененирует path для объекта
  */
 export const generateObjectPath = (key, prevPath) => {
     if (prevPath) {

package/toPrettyError/toPrettyError.d.ts

@@ -1,7 +1,7 @@
 import { type ValidationResult } from '../core';
 import { type PlainValidationResult } from '../toPlainError';
 /**
- * @description Преобразует ошибку валидации в формат для вывода (например, в консоль)
+ * Преобразует ошибку валидации в формат для вывода (например, в консоль)
  * @param validationResult
  * @example
  * ```ts

package/toPrettyError/toPrettyError.js

@@ -1,6 +1,6 @@
 import { toPlainError } from '../toPlainError';
 /**
- * @description Преобразует ошибку валидации в формат для вывода (например, в консоль)
+ * Преобразует ошибку валидации в формат для вывода (например, в консоль)
  * @param validationResult
  * @example
  * ```ts

package/transform/transform.d.ts

@@ -1,7 +1,7 @@
 import { type ValidationRule } from '../core';
 type Transformer<TValue, TResult> = (value: TValue) => TResult;
 /**
- * @description Трансформирует value в новый тип для валидации
+ * Трансформирует value в новый тип для валидации
  * @param transformer - функция трансформации value в новый тип
  * @param rules - правила, которые будут вызваны после трансформации value
  * @example

package/transform/transform.js

@@ -1,6 +1,6 @@
 import { compose, createRule, } from '../core';
 /**
- * @description Трансформирует value в новый тип для валидации
+ * Трансформирует value в новый тип для валидации
  * @param transformer - функция трансформации value в новый тип
  * @param rules - правила, которые будут вызваны после трансформации value
  * @example

package/when/when.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;
     /**
@@ -14,7 +14,7 @@ type Params<TLastSchemaValues extends Record<string, unknown>> = {
     otherwise: ValidationRule<unknown, TLastSchemaValues>;
 };
 /**
- * @description Позволяет указывать условные валидации
+ * Позволяет указывать условные валидации
  * @example
  * ```ts
  * type Values = { name: string; isAgree: boolean };

package/when/when.js

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