@astral/validations 4.9.1 → 4.10.0

package/README.md

@@ -47,6 +47,7 @@
   - [date](#date)
     - [min](#min-date)
     - [max](#max-date)
+    - [minYearsOld](#min-years-old-date)
   - [boolean](#boolean)
   - [object](#object)
     - [partial](#partial)
@@ -874,6 +875,30 @@ validate(new Date('02-01-2021'));
 
 ---
 
+### #min years old date
+
+Принимает возраст и вычитает переданное количество лет из текущей даты. Позволяет кастомизировать текст ошибки.
+
+```ts
+import { date, minYearsOld } from '@astral/validations';
+
+const validate = date(
+  minYearsOld(18, {
+    customErrorMessage:
+            'Только совершеннолетние могут воспользоваться данной услугой',
+  }),
+);
+
+// { message: 'Только совершеннолетние могут воспользоваться данной услугой' }
+validate(new Date('15.11.2022'));
+
+// undefined
+validate(new Date('10.10.2005'));
+
+```
+
+---
+
 ## boolean
 
 - Возвращает ошибку если:

package/core/guard/createGuard/createGuard.js

@@ -5,10 +5,8 @@ export function createGuard(executor) {
     const createInnerGuard = (defOptions = {}) => {
         const guard = (value, prevCtx) => {
             const actualDefOptions = Object.assign(Object.assign({}, defOptions), { isOptional: (prevCtx === null || prevCtx === void 0 ? void 0 : prevCtx.isOptional) || defOptions.isOptional });
-            const ctx = createContext(prevCtx, 
-            // при создании контекста сейчас не имеет значение какого типа будет ctx.values
-            value, {
-                lastSchemaValue: value,
+            const ctx = createContext(prevCtx, value, {
+                // данная конструкция останавливает погружение isOptional в последующие guard
                 isOptional: false,
             });
             const requiredResult = required({

package/minYearsOld/constants.d.ts

@@ -0,0 +1,4 @@
+import { ErrorCode } from '../core';
+export declare const BIRTH_DATE_MAX_ERROR_CODE: ErrorCode;
+export declare const BIRTH_DATE_MIN_ERROR_CODE: ErrorCode;
+export declare const BIRTH_DATE_MIN: Date;

package/minYearsOld/constants.js

@@ -0,0 +1,4 @@
+import { createErrorCode } from '../core';
+export const BIRTH_DATE_MAX_ERROR_CODE = createErrorCode('birth-date-max');
+export const BIRTH_DATE_MIN_ERROR_CODE = createErrorCode('birth-date-min');
+export const BIRTH_DATE_MIN = new Date('01.01.1900');

package/minYearsOld/index.d.ts

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

package/minYearsOld/index.js

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

package/minYearsOld/minYearsOld.d.ts

@@ -0,0 +1,24 @@
+type MinYearsOldParams = {
+    /**
+     * @description Кастомное сообщение ошибки
+     */
+    customErrorMessage: string;
+};
+/**
+ * @description Проверяет дату рождения на соответствие условию. Работает с date.
+ * @param age - ограничение по возрасту (коло-во лет, вычитаемое из текущей даты для валидации)
+ * @param params - объект параметров
+ * @example
+ * ```ts
+
+ *
+ *  const validate = date(
+ *   minYearsOld(18, {
+ *     customMessage:
+ *             'Только совершеннолетние могут воспользоваться данной услугой',
+ *   }),
+ * );
+ * ```
+ */
+export declare function minYearsOld<ValidationType, TLastSchemaValues extends Record<string, unknown> = {}>(age: number, params?: MinYearsOldParams): (value: ValidationType, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => import("../core").ValidationResult;
+export {};

package/minYearsOld/minYearsOld.js

@@ -0,0 +1,44 @@
+import { createRule } from '../core';
+import { BIRTH_DATE_MAX_ERROR_CODE, BIRTH_DATE_MIN, BIRTH_DATE_MIN_ERROR_CODE, } from './constants';
+/**
+ * @description Проверяет дату рождения на соответствие условию. Работает с date.
+ * @param age - ограничение по возрасту (коло-во лет, вычитаемое из текущей даты для валидации)
+ * @param params - объект параметров
+ * @example
+ * ```ts
+
+ *
+ *  const validate = date(
+ *   minYearsOld(18, {
+ *     customMessage:
+ *             'Только совершеннолетние могут воспользоваться данной услугой',
+ *   }),
+ * );
+ * ```
+ */
+export function minYearsOld(age, params) {
+    return createRule((value, ctx) => {
+        const getMessage = (typeMessage) => {
+            const message = params === null || params === void 0 ? void 0 : params.customErrorMessage;
+            return message ? message : typeMessage;
+        };
+        const threshold = new Date();
+        threshold.setFullYear(threshold.getFullYear() - age);
+        if (value instanceof Date && value > BIRTH_DATE_MIN) {
+            if (value > threshold) {
+                return ctx.createError({
+                    code: BIRTH_DATE_MAX_ERROR_CODE,
+                    message: getMessage(`Вам должно быть больше ${age} лет`),
+                });
+            }
+            return undefined;
+        }
+        if (value < BIRTH_DATE_MIN) {
+            return ctx.createError({
+                code: BIRTH_DATE_MIN_ERROR_CODE,
+                message: getMessage(`Не ранее ${BIRTH_DATE_MIN}`),
+            });
+        }
+        return undefined;
+    });
+}

package/package.json

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