@astral/validations 4.15.0 → 4.16.0

package/README.md

@@ -52,10 +52,10 @@
     - [min](#min-date)
     - [max](#max-date)
     - [minYearsOld](#min-years-old-date)
-    - [rangeDate](#range-date)
-      - [rangeDateInterval](#range-date-interval)
-      - [rangeDateMinMax](#range-date-minmax)
-      - [rangeDateNotEqual](#range-date-notequal)
+  - [rangeDate](#rangeDate)
+    - [rangeDateInterval](#rangeDateInterval)
+    - [rangeDateMinMax](#rangeDateMinMax)
+    - [rangeDateNotEqual](#rangeDateNotEqual)
   - [boolean](#boolean)
   - [object](#object)
     - [partial](#partial)
@@ -995,7 +995,8 @@ validate(new Date('10.10.2005'));
 
 ### rangeDate
 
-Проверяет даты интервала на обязательность заполнения, валидность значений и хронологический порядок
+- Проверяет даты интервала на обязательность заполнения, валидность значений и хронологический порядок
+- Выполняет композицию правил, переданных в параметры
 
 ```ts
 import { rangeDate } from '@astral/validations';
@@ -1039,6 +1040,24 @@ validate({
   end: new Date('2024.09.24'),
 });
 
+
+const customValidate = (...rules: DateRangeRule[]) => dateRange(...rules).define({
+  required: { start: false, end: false },
+  message: {
+    startRequired: 'Укажите начало периода'
+  }
+})
+
+// undefined
+customValidate({
+  start: new Date('2024.09.05'),
+});
+
+// { message: 'Укажите начало периода' }
+validate({
+  end: new Date('2024.09.05'),
+})
+
 ```
 
 ---
@@ -1051,7 +1070,7 @@ validate({
 ```ts
 import { rangeDateInterval } from '@astral/validations';
 
-const validate = object(rangeDateInterval({ limit: 14 }));
+const validate = rangeDate(rangeDateInterval({ limit: 14 }));
 
 // { message: 'Период не может превышать 14 дней' }
 validate({
@@ -1065,7 +1084,7 @@ validate({
   end: new Date('2024.09.12'),
 });
 
-const validateMonthInterval = object(rangeDateInterval({ limit: 2, unit: 'month' }));
+const validateMonthInterval = rangeDate(rangeDateInterval({ limit: 2, unit: 'month' }));
 
 // { message: 'Период не может превышать 2 месяца' }
 validateMonthInterval({
@@ -1091,7 +1110,7 @@ validateMonthInterval({
 ```ts
 import { rangeDateMinMax } from '@astral/validations';
 
-const validate = object(rangeDateMinMax({ start: { min: { limit: new Date('2024.09.05') }}, end: { max: { limit: new Date('2024.09.15') } } }))
+const validate = rangeDate(rangeDateMinMax({ start: { min: { limit: new Date('2024.09.05') }}, end: { max: { limit: new Date('2024.09.15') } } }))
 
 // { message: 'Дата начала должна быть позже 05.09.2024' }
 validate({
@@ -1122,7 +1141,7 @@ validate({
 ```ts
 import { rangeDateNotEqual } from '@astral/validations';
 
-const validate = object(
+const validate = rangeDate(
   rangeDateNotEqual(),
 );
 
@@ -1179,7 +1198,7 @@ validate(null)
   - Value не является простым объектом
   - Свойства не соответсвуют переданной схеме валидации
 - Возвращаем объект ошибок, соответсвующих ошибкам для свойств объекта
-- Требует схему для валидации, свойства которой должны соответсвовать валидируемому values
+- Требует схему для валидации, свойства которой должны соответствовать валидируемому values
 
 ```ts
 import {

package/package.json

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

package/rangeDate/rangeDate.d.ts

@@ -1,3 +1,4 @@
+import { type ValidationRule } from '../core';
 type RangeDateValue = {
     start?: Date;
     end?: Date;
@@ -37,12 +38,13 @@ type RangeDateParams = {
     };
 };
 /**
- * Проверяет даты интервала на обязательность заполнения, валидность значений и хронологический порядок
+ * Guard для интервала дат. Проверяет даты интервала на обязательность заполнения, валидность значений и хронологический порядок
+ * @param rules - правила валидаций, применяющиеся к интервалу дат
  * @example
  * ```ts
- * const validate = object(rangeDate());
+ * const validate = rangeDate();
  * validate({ start: new Date(), end: new Date() });
  * ```
  */
-export declare const rangeDate: <TLastSchemaValues extends Record<string, unknown>>(params?: RangeDateParams) => (value: RangeDateValue, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => import("../core").ValidationResult;
+export declare const rangeDate: <TLastSchemaValues extends Record<string, unknown>>(...rules: ValidationRule<RangeDateValue, TLastSchemaValues>[]) => import("../core").Guard<TLastSchemaValues, RangeDateParams>;
 export {};

package/rangeDate/rangeDate.js

@@ -1,15 +1,16 @@
 import { isDate } from '@astral/utils';
-import { createRule, isDateEarlier } from '../core';
+import { compose, createGuard, isDateEarlier, } from '../core';
 import { RANGE_DATE_END_EARLIER_START_ERROR_INFO, RANGE_DATE_END_INVALID_ERROR_INFO, RANGE_DATE_END_REQUIRED_ERROR_INFO, RANGE_DATE_REQUIRED_ERROR_INFO, RANGE_DATE_START_INVALID_ERROR_INFO, RANGE_DATE_START_REQUIRED_ERROR_INFO, } from './constants';
 /**
- * Проверяет даты интервала на обязательность заполнения, валидность значений и хронологический порядок
+ * Guard для интервала дат. Проверяет даты интервала на обязательность заполнения, валидность значений и хронологический порядок
+ * @param rules - правила валидаций, применяющиеся к интервалу дат
  * @example
  * ```ts
- * const validate = object(rangeDate());
+ * const validate = rangeDate();
  * validate({ start: new Date(), end: new Date() });
  * ```
  */
-export const rangeDate = (params) => createRule((value, ctx) => {
+export const rangeDate = (...rules) => createGuard((externalValue, ctx, params) => {
     const { required, messages } = Object.assign(Object.assign({}, (params || {})), { required: {
             start: (params === null || params === void 0 ? void 0 : params.required) && 'start' in (params === null || params === void 0 ? void 0 : params.required)
                 ? params === null || params === void 0 ? void 0 : params.required.start
@@ -18,6 +19,10 @@ export const rangeDate = (params) => createRule((value, ctx) => {
                 ? params === null || params === void 0 ? void 0 : params.required.end
                 : true,
         } });
+    // Приводим тип, чтобы не усложнять код и не дублировать часть проверок
+    // Существующие проверки покрывают все кейсы
+    // Иначе необходимо делать проверку на объект и наличие полей start и end с учетом вариативности
+    const value = externalValue;
     if ((required === null || required === void 0 ? void 0 : required.start) && (required === null || required === void 0 ? void 0 : required.end) && !value.start && !value.end) {
         return ctx.createError({
             message: RANGE_DATE_REQUIRED_ERROR_INFO.message,
@@ -56,5 +61,5 @@ export const rangeDate = (params) => createRule((value, ctx) => {
             code: RANGE_DATE_END_EARLIER_START_ERROR_INFO.code,
         });
     }
-    return undefined;
+    return compose(...rules)(value, ctx);
 });

package/rangeDateInterval/rangeDateInterval.d.ts

@@ -15,7 +15,7 @@ type RangeDateIntervalParams = {
  * Позволяет ограничить интервал на конкретное значение. Установка интревала возможна в следующих единицах: день, месяц и год.
  * @example
  * ```ts
- * const validate = object(rangeDateInterval({ limit: 14 }));
+ * const validate = rangeDate(rangeDateInterval({ limit: 14 }));
  * validate({ start: new Date('2024.08.15'), end: new Date('2024.09.05') });
  * ```
  */

package/rangeDateInterval/rangeDateInterval.js

@@ -13,7 +13,7 @@ const selectAddingStrategy = (unit) => {
  * Позволяет ограничить интервал на конкретное значение. Установка интревала возможна в следующих единицах: день, месяц и год.
  * @example
  * ```ts
- * const validate = object(rangeDateInterval({ limit: 14 }));
+ * const validate = rangeDate(rangeDateInterval({ limit: 14 }));
  * validate({ start: new Date('2024.08.15'), end: new Date('2024.09.05') });
  * ```
  */

package/rangeDateMinMax/rangeDateMinMax.d.ts

@@ -26,7 +26,7 @@ type RangeDateMinMaxParams = {
  * Проверяет даты на минимальное и максимальное допустимое значение
  * @example
  * ```ts
- * const validate = object(rangeDateMinMax({ start: { min: { limit: new Date(2023, 0, 1) }}, end: { max: { limit: new Date() } } }));
+ * const validate = rangeDate(rangeDateMinMax({ start: { min: { limit: new Date(2023, 0, 1) }}, end: { max: { limit: new Date() } } }));
  * validate({ start: new Date(), end: new Date() });
  * ```
  */

package/rangeDateMinMax/rangeDateMinMax.js

@@ -9,7 +9,7 @@ const formatDateToView = (date) => {
  * Проверяет даты на минимальное и максимальное допустимое значение
  * @example
  * ```ts
- * const validate = object(rangeDateMinMax({ start: { min: { limit: new Date(2023, 0, 1) }}, end: { max: { limit: new Date() } } }));
+ * const validate = rangeDate(rangeDateMinMax({ start: { min: { limit: new Date(2023, 0, 1) }}, end: { max: { limit: new Date() } } }));
  * validate({ start: new Date(), end: new Date() });
  * ```
  */

package/rangeDateNotEqual/rangeDateNotEqual.d.ts

@@ -12,7 +12,7 @@ type RangeDateNotEqualParams = {
  * Проверяет даты интервала на совпадение даты начала и окончания
  * @example
  * ```ts
- * const validate = object(rangeDateNotEqual());
+ * const validate = rangeDate(rangeDateNotEqual());
  * validate({ start: new Date(), end: new Date() });
  * ```
  */

package/rangeDateNotEqual/rangeDateNotEqual.js

@@ -8,7 +8,7 @@ const isDateEqual = (dateA, dateB) => {
  * Проверяет даты интервала на совпадение даты начала и окончания
  * @example
  * ```ts
- * const validate = object(rangeDateNotEqual());
+ * const validate = rangeDate(rangeDateNotEqual());
  * validate({ start: new Date(), end: new Date() });
  * ```
  */