@astral/validations 3.0.0-beta.3 → 3.1.0

package/README.md

@@ -20,6 +20,7 @@
     - [min](#min-number)
     - [max](#max-number)
     - [integer](#integer)
+    - [positiveNumber](#positivenumber)
   - [string](#string)
     - [min](#min-string)
     - [max](#max-string)
@@ -57,8 +58,11 @@
   - [or](#or)
 - [Integrations](#integrations)
   - [react-hook-form](#react-hook-form)
-- [Error message customization](#error-message-customization)
-- [Exclusion managing](#exclusion-managing)
+- [Guides](#guides)
+  - [Переиспользование объектов схемы](#переиспользование-объектов-схемы)
+  - [Переиспользование объектов схемы, с условной валидацией и зависимыми полями](#переиспользование-объектов-схемы-с-условной-валидацией-и-зависимыми-полями)
+  - [Error message customization](#error-message-customization)
+  - [Exclusion managing](#exclusion-managing)
   
 ---
 
@@ -76,7 +80,9 @@ yarn add @astral/validations
 
 # Basic usage
 
-Валидация объекта с вложенным массивом
+Валидация объекта с вложенным массивом.
+
+### [Codesandbox](https://codesandbox.io/s/astral-validations-basic-usage-jkpjr5?file=/main.ts)
 
 ```ts
 import {
@@ -86,7 +92,8 @@ import {
   string,
   optional,
   min,
-  number
+  number,
+  toPrettyError,
 } from '@astral/validations';
 
 type Permission = {
@@ -125,13 +132,15 @@ validate({
   },
 });
 
-// Error in info.permissions.0.description: Обязательно
-validate({
-  name: 'Vasya',
-  info: {
-    permissions: [{ id: 1 }],
-  },
-});
+// { info: { permissions: [{ description: 'Обязательно' }] } }
+toPrettyError(
+  validate({
+    name: 'Vasya',
+    info: {
+        permissions: [{ id: 1 }],
+    },
+  })
+);
 ```
 
 Валидация отдельных value
@@ -255,6 +264,27 @@ validate(3.14)
 
 ---
 
+### positiveNumber
+
+Проверяет является ли значение положительным числом.
+
+```ts
+import { number, positiveNumber } from '@astral/validations';
+
+const validate = number(positiveNumber(3));
+
+// undefined
+validate(3)
+
+// { message: 'Только положительное числа' }
+validate(0)
+
+// { message: 'Только положительное числа' }
+validate(-1)
+```
+
+---
+
 ## string
 
 - Возвращает ошибку если:
@@ -658,7 +688,8 @@ import {
   string,
   optional,
   min,
-  number
+  number,
+  toPrettyError
 } from '@astral/validations';
 
 type User = {
@@ -692,13 +723,15 @@ validate({
   },
 });
 
-// Error in info.permissions.0.description: Обязательно
-validate({
-  name: 'Vasya',
-  info: {
-    permissions: [{ id: 1 }],
-  },
-});
+// { info: { permissions: [{ description: 'Обязательно' }] } }
+toPrettyError(
+  validate({
+    name: 'Vasya',
+    info: {
+      permissions: [{ id: 1 }],
+    },
+  })
+);
 ```
 
 ### partial
@@ -706,7 +739,7 @@ validate({
 Позволяет сделать все поля объекта optional.
 
 ```ts
-import { partial, object, string } from '@astral/validations';
+import { partial, object, string, toPrettyError } from '@astral/validations';
 
 type Values = {
   name: string;
@@ -718,8 +751,10 @@ const validateRequired = object<Values>({
   surname: string()
 })
 
-// { message: 'Ошибка в свойстве name: Обязательно' }
-validateRequired({});
+// { name: 'Обязательно' }
+toPrettyError(
+  validateRequired({})
+);
 
 const validatePartial = partial(
   object<Values>({
@@ -800,7 +835,8 @@ validate({
 import {
   array,
   arrayItem,
-  min
+  min,
+  toPrettyError
 } from '@astral/validations';
 
 type User = {
@@ -824,8 +860,10 @@ validate([{ name: 'Vasya' }]);
 // { message: 'Не меньше: 1' }
 validate([]);
 
-// { cause: { errorArray: [{ name: { message: 'Не является строкой' } }] } }
-validate([{ name: 22 }]);
+// [{ name: 'Не является строкой' }]
+toPrettyError(
+  validate([{ name: 22 }])
+);
 ```
 
 ### arrayItem
@@ -833,7 +871,7 @@ validate([{ name: 22 }]);
 Применяет переданные правила валидации к каждому элементу массива.
 
 ```ts
-import { array, arrayItem, object, string, optional } from '@astral/validations';
+import { array, arrayItem, object, string, optional, toPrettyError } from '@astral/validations';
 
 type User = {
   name: string;
@@ -853,16 +891,20 @@ const validate = array(
 validate([{ name: 'Vasya' }]);
 
 // { cause: { errorArray: [{ name: { message: 'Не является строкой' } }] } }
-validate([{ name: 22 }]);
+toPrettyError(
+  validate([{ name: 22 }])
+);
 ```
 
 ```ts
-import { array, arrayItem, string, min } from '@astral/validations';
+import { array, arrayItem, string, min, toPrettyError } from '@astral/validations';
 
 const validate = array(arrayItem(string(min(3))));
 
-// { cause: { arrayError: [undefined, { message: 'Мин. символов: 3' }] } }
-validate(['vasya', 'ma']);
+// [undefined, 'Мин. символов: 3']
+toPrettyError(
+  validate(['vasya', 'ma'])
+);
 ```
 
 ---
@@ -920,10 +962,12 @@ const validate = object<Values, Values>({
 });
 
 // undefined
-const result1 = validate({ isAgree: false, name: '' });
+validate({ isAgree: false, name: '' });
 
-// Required error для name
-const result2 = validate({ isAgree: true, name: '' });
+// { name: 'Обязательно' }
+toPrettyError(
+  validate({ isAgree: true, name: '' })
+);
 ```
 
 ---
@@ -959,7 +1003,7 @@ validateCustomString(20);
 ## Базовый пример
 
 ```ts
-import { string, object } from '@astral/validations';
+import { string, object, toPrettyError } from '@astral/validations';
 
 type Values = {
   name: string;
@@ -980,8 +1024,10 @@ const validate = object<Values, Values>({
   }),
 });
 
-// { cause: { errorMap: { nickname: { message: 'Символ "_" запрещен', code: 'nickname-symbol' } } } }
-validate({ name: 'Vasya', nickname: 'va_sya' });
+// { nickname: 'Символ "_" запрещен' }
+toPrettyError(
+  validate({ name: 'Vasya', nickname: 'va_sya' })
+);
 ```
 
 ## Связанные поля
@@ -989,7 +1035,7 @@ validate({ name: 'Vasya', nickname: 'va_sya' });
 В ```ctx.global.values``` находится value, принятое самым верхнеуровневым guard'ом.
 
 ```ts
-import { object, string } from '@astral/validations';
+import { object, string, toPrettyError } from '@astral/validations';
 
 type Values = {
   password: string;
@@ -1010,8 +1056,10 @@ const validate = object<Values, Values>({
   }),
 });
 
-// Error.message "Пароли не совпадают" для repeatPassword 
-validate({ password: 'qywerty123', repeatPassword: 'qywerty1234' });
+// { repeatPassword: 'Пароли не совпадают' } 
+toPrettyError(
+  validate({ password: 'qywerty123', repeatPassword: 'qywerty1234' })
+);
 ```
 
 ## Переиспользуемое правило
@@ -1099,10 +1147,12 @@ const validate = object<Values, Values>({
 });
 
 // undefined
-const result1 = validate({ isAgree: false, name: '' });
+validate({ isAgree: false, name: '' });
 
-// Required error для name
-const result2 = validate({ isAgree: true, name: '' });
+// { name: 'Обязательно' }
+toPrettyError(
+  validate({ isAgree: true, name: '' })
+);
 ```
 
 When для ветки объекта:
@@ -1123,12 +1173,13 @@ const validate = object<Values, Values>({
   }),
 });
 
-// Error.message "Обязательно" для info
-validate({ name: 'Vasya' });
+// { info: 'Обязательно' }
+toPrettyError(
+  validate({ name: 'Vasya' })
+);
 
 // undefined
 validate({ name: 'Kolya' });
-
 ```
 
 ---
@@ -1184,6 +1235,8 @@ validate(new Date())
 
 Для интеграции с react-hook-form необходимо использовать пакет ```@astral/validations-react-hook-form-resolver```.
 
+### [Codesandbox](https://codesandbox.io/s/astral-validations-react-hook-form-tnq4of?file=/src/Form.tsx)
+
 ```tsx
 import { object, string, optional } from '@astral/validations';
 import { resolver } from '@astral/validations-react-hook-form-resolver';
@@ -1222,7 +1275,85 @@ const Form = () => {
 };
 ```
 
-# Error message customization
+# Guides
+
+
+## Переиспользование объектов схемы
+
+```ts
+type Address = {
+  street: string;
+};
+
+const address = object<Address>({ street: string() });
+
+type Organization = {
+  address: Address;
+};
+
+const organization = object<Organization>({ address });
+
+type Values = {
+  name: string;
+  org: Organization;
+};
+
+const validateValues = object<Values>({
+  name: string(),
+  org: organization,
+});
+```
+
+---
+
+## Переиспользование объектов схемы, с условной валидацией и зависимыми полями
+
+```ts
+type RusOrganization = {
+  inn: string;
+  isIP: boolean;
+};
+
+type EngOrganization = {
+  name: string;
+};
+
+type Values = {
+  isRus: boolean;
+  org: { data: RusOrganization | EngOrganization };
+};
+
+// второй параметр generic - это глобально валидируемое значение. Для формы это весь values
+const rusOrganization = object<RusOrganization, Values>({
+  inn: string(
+    // автоматический вывод типа для ctx.global.values
+    when({
+      is: (_, ctx) => Boolean(ctx.global.values.isRus),
+      then: rusOrganization,
+      otherwise: engOrganization,
+    }),
+  ),
+  isIP: optional(boolean()),
+});
+
+const engOrganization = object<EngOrganization, Values>({ name: string() });
+
+// необходимо явно указать Values для типизации ctx.global.values
+const organization = when<Values>({
+  is: (_, ctx) => Boolean(ctx.global.values.isRus),
+  then: rusOrganization,
+  otherwise: engOrganization,
+});
+
+const validate = object<Values, Values>({
+  isRus: optional(boolean()),
+  org: organization,
+});
+```
+
+---
+
+## Error message customization
 
 Сообщения об ошибках по умолчанию могут быть заменены на пользовательские.  
 Для этого необходимо использовать параметры `message` или `getMessage` у валидационных методов:
@@ -1245,7 +1376,7 @@ validateKPP('123123');
 
 ---
 
-# Exclusion managing
+## Exclusion managing
 
 Метод `exclude` предоставляет возможность обхода валидации для конкретного значения.  
 Если функция вернет `true`,

package/index.d.ts

@@ -10,6 +10,7 @@ export { deepPartial } from './deepPartial';
 export { min, STRING_MIN_ERROR_CODE, ARRAY_MIN_ERROR_CODE, DATE_MIN_ERROR_CODE, NUMBER_MIN_ERROR_CODE, } from './min';
 export { max, STRING_MAX_ERROR_CODE, ARRAY_MAX_ERROR_CODE, DATE_MAX_ERROR_CODE, NUMBER_MAX_ERROR_CODE, } from './max';
 export { integer, INTEGER_ERROR_INFO } from './integer';
+export { positiveNumber, POSITIVE_NUMBER_ERROR_INFO } from './positiveNumber';
 export { or } from './or';
 export { pattern, PATTERN_ERROR_CODE } from './pattern';
 export { onlyNumber, ONLY_NUMBER_ERROR_CODE } from './onlyNumber';
@@ -25,3 +26,4 @@ export { ogrnUL, OGRN_UL_ERROR_INFO } from './ogrnUL';
 export { ogrnIP, OGRN_IP_ERROR_INFO } from './ogrnIP';
 export { any } from './any';
 export { when } from './when';
+export { toPrettyError } from './toPrettyError';

package/index.js

@@ -10,6 +10,7 @@ export { deepPartial } from './deepPartial';
 export { min, STRING_MIN_ERROR_CODE, ARRAY_MIN_ERROR_CODE, DATE_MIN_ERROR_CODE, NUMBER_MIN_ERROR_CODE, } from './min';
 export { max, STRING_MAX_ERROR_CODE, ARRAY_MAX_ERROR_CODE, DATE_MAX_ERROR_CODE, NUMBER_MAX_ERROR_CODE, } from './max';
 export { integer, INTEGER_ERROR_INFO } from './integer';
+export { positiveNumber, POSITIVE_NUMBER_ERROR_INFO } from './positiveNumber';
 export { or } from './or';
 export { pattern, PATTERN_ERROR_CODE } from './pattern';
 export { onlyNumber, ONLY_NUMBER_ERROR_CODE } from './onlyNumber';
@@ -25,3 +26,4 @@ export { ogrnUL, OGRN_UL_ERROR_INFO } from './ogrnUL';
 export { ogrnIP, OGRN_IP_ERROR_INFO } from './ogrnIP';
 export { any } from './any';
 export { when } from './when';
+export { toPrettyError } from './toPrettyError';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astral/validations",
-  "version": "3.0.0-beta.3",
+  "version": "3.1.0",
   "browser": "./index.js",
   "main": "./index.js",
   "dependencies": {

package/positiveNumber/constants.d.ts

@@ -0,0 +1,2 @@
+import { ErrorInfo } from '../core';
+export declare const POSITIVE_NUMBER_ERROR_INFO: ErrorInfo;

package/positiveNumber/constants.js

@@ -0,0 +1,5 @@
+import { createErrorCode } from '../core';
+export const POSITIVE_NUMBER_ERROR_INFO = {
+    code: createErrorCode('positive-number'),
+    message: 'Только положительные числа',
+};

package/positiveNumber/index.d.ts

@@ -0,0 +1,2 @@
+export * from './constants';
+export * from './positiveNumber';

package/positiveNumber/index.js

@@ -0,0 +1,2 @@
+export * from './constants';
+export * from './positiveNumber';

package/positiveNumber/positiveNumber.d.ts

@@ -0,0 +1,25 @@
+type PositiveNumberParams = {
+    /**
+     * @description Замена стандартного сообщения ошибки.
+     */
+    message?: string;
+};
+/**
+ * @description
+ * Проверяет является ли значение положительным числом.
+ * @example
+ * ```ts
+ * const validate = number(positiveNumber(3));
+ *
+ * // undefined
+ * validate(3)
+ *
+ * // { message: 'Только положительное числа' }
+ * validate(0)
+ *
+ * // { message: 'Только положительное числа' }
+ * validate(-1)
+ * ```
+ */
+export declare const positiveNumber: <TValues>(params?: PositiveNumberParams) => (value: number, prevCtx?: import("../core").ValidationContext<TValues> | undefined) => import("../core").ValidationResult;
+export {};

package/positiveNumber/positiveNumber.js

@@ -0,0 +1,31 @@
+import { createRule } from '../core';
+import { POSITIVE_NUMBER_ERROR_INFO } from './constants';
+const isPositiveNumber = (number) => {
+    return number > 0;
+};
+/**
+ * @description
+ * Проверяет является ли значение положительным числом.
+ * @example
+ * ```ts
+ * const validate = number(positiveNumber(3));
+ *
+ * // undefined
+ * validate(3)
+ *
+ * // { message: 'Только положительное числа' }
+ * validate(0)
+ *
+ * // { message: 'Только положительное числа' }
+ * validate(-1)
+ * ```
+ */
+export const positiveNumber = (params) => createRule((value, ctx) => {
+    if (!isPositiveNumber(value)) {
+        return ctx.createError({
+            message: (params === null || params === void 0 ? void 0 : params.message) || POSITIVE_NUMBER_ERROR_INFO.message,
+            code: POSITIVE_NUMBER_ERROR_INFO.code,
+        });
+    }
+    return undefined;
+});

package/toPrettyError/index.d.ts

@@ -0,0 +1 @@
+export * from './toPrettyError';

package/toPrettyError/index.js

@@ -0,0 +1 @@
+export * from './toPrettyError';

package/toPrettyError/toPrettyError.d.ts

@@ -0,0 +1,39 @@
+import { ValidationResult } from '../core';
+import { PlainValidationResult } from '../toPlainError';
+/**
+ * @description Преобразует ошибку валидации в формат для вывода (например, в консоль)
+ * @param validationResult
+ * @example
+ * ```ts
+ *
+ * type ListItem = { description: string };
+ *
+ * type Values = {
+ *   info: { name: string };
+ *   list: ListItem[];
+ * };
+ *
+ * const validate = object<Values>({
+ *   info: object<Values['info']>({ name: string() }),
+ *   list: array(
+ *     arrayItem(
+ *       object<ListItem>({
+ *         description: string(),
+ *       }),
+ *     ),
+ *   ),
+ * });
+ *
+ * const error = validate({
+ *   info: { name: 22 },
+ *   list: [{}],
+ * });
+ *
+ * // {
+ * //   info: { name: 'Не является строкой' },
+ * //   list: [{ description: 'Обязательно' }],
+ * // }
+ * toPrettyError(error);
+ * ```
+ */
+export declare const toPrettyError: (validationResult: ValidationResult) => PlainValidationResult<string>;

package/toPrettyError/toPrettyError.js

@@ -0,0 +1,38 @@
+import { toPlainError } from '../toPlainError';
+/**
+ * @description Преобразует ошибку валидации в формат для вывода (например, в консоль)
+ * @param validationResult
+ * @example
+ * ```ts
+ *
+ * type ListItem = { description: string };
+ *
+ * type Values = {
+ *   info: { name: string };
+ *   list: ListItem[];
+ * };
+ *
+ * const validate = object<Values>({
+ *   info: object<Values['info']>({ name: string() }),
+ *   list: array(
+ *     arrayItem(
+ *       object<ListItem>({
+ *         description: string(),
+ *       }),
+ *     ),
+ *   ),
+ * });
+ *
+ * const error = validate({
+ *   info: { name: 22 },
+ *   list: [{}],
+ * });
+ *
+ * // {
+ * //   info: { name: 'Не является строкой' },
+ * //   list: [{ description: 'Обязательно' }],
+ * // }
+ * toPrettyError(error);
+ * ```
+ */
+export const toPrettyError = (validationResult) => toPlainError(validationResult, (err) => err.message);