@astral/validations 3.0.0-beta.4 → 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 {
@@ -258,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
 
 - Возвращает ошибку если:
@@ -1208,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';
@@ -1246,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` у валидационных методов:
@@ -1269,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';

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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astral/validations",
-  "version": "3.0.0-beta.4",
+  "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;
+});