@astral/validations 4.10.0 → 4.11.0

package/README.md

@@ -26,6 +26,7 @@
     - [max](#max-string)
     - [email](#email)
     - [guid](#guid)
+    - [length](#length)
     - [pattern](#pattern)
     - [onlyNumber](#onlyNumber)
     - [containsNumbers](#containsNumbers)
@@ -412,6 +413,25 @@ validate('x56a4180-h5aa-42ec-a945-5fd21dec0538');
 
 ---
 
+### length
+
+Проверяет значение на соответствие длине.
+
+```ts
+import { string, length } from '@astral/validations';
+
+const validate = string(length(5));
+
+// undefined
+validate('aaaaa');
+
+
+// { message: 'Кол-во символов должно быть: 5' }
+validate('abc');
+```
+
+---
+
 ### pattern
 
 Проверяет строку на соответствие регулярному выражению.

package/index.d.ts

@@ -7,6 +7,7 @@ export { boolean, BOOLEAN_TYPE_ERROR_INFO } from './boolean';
 export { array, ARRAY_TYPE_ERROR_INFO } from './array';
 export { arrayItem } from './arrayItem';
 export { deepPartial } from './deepPartial';
+export { partial } from './partial';
 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';
@@ -20,6 +21,7 @@ export { containsDifferentCases, CONTAINS_DIFFERENT_CASES_ERROR_CODE, } from './
 export { toPlainError } from './toPlainError';
 export { email, LENGTH_EMAIL_ERROR_INFO, INVALID_EMAIL_ERROR_INFO, } from './email';
 export { guid, INVALID_GUID_ERROR_INFO } from './guid';
+export { length, STRING_LENGTH_ERROR_CODE } from './length';
 export { mobilePhone, MOBILE_PHONE_ERROR_INFO } from './mobilePhone';
 export { innUL, INN_UL_ERROR_INFO } from './innUL';
 export { innIP, INN_IP_ERROR_INFO } from './innIP';

package/index.js

@@ -7,6 +7,7 @@ export { boolean, BOOLEAN_TYPE_ERROR_INFO } from './boolean';
 export { array, ARRAY_TYPE_ERROR_INFO } from './array';
 export { arrayItem } from './arrayItem';
 export { deepPartial } from './deepPartial';
+export { partial } from './partial';
 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';
@@ -20,6 +21,7 @@ export { containsDifferentCases, CONTAINS_DIFFERENT_CASES_ERROR_CODE, } from './
 export { toPlainError } from './toPlainError';
 export { email, LENGTH_EMAIL_ERROR_INFO, INVALID_EMAIL_ERROR_INFO, } from './email';
 export { guid, INVALID_GUID_ERROR_INFO } from './guid';
+export { length, STRING_LENGTH_ERROR_CODE } from './length';
 export { mobilePhone, MOBILE_PHONE_ERROR_INFO } from './mobilePhone';
 export { innUL, INN_UL_ERROR_INFO } from './innUL';
 export { innIP, INN_IP_ERROR_INFO } from './innIP';

package/length/constants.d.ts

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

package/length/constants.js

@@ -0,0 +1,2 @@
+import { createErrorCode } from '../core';
+export const STRING_LENGTH_ERROR_CODE = createErrorCode('stringLength');

package/length/index.d.ts

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

package/length/index.js

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

package/length/length.d.ts

@@ -0,0 +1,22 @@
+type LengthParams = {
+    /**
+     * @description Замена стандартного сообщения ошибки.
+     */
+    message?: string;
+};
+/**
+ * @description Проверяет значение на соответствие длине. Работает с: string
+ * @param len - целевой кол-во символов
+ * @example
+ *  // Длина строки должна быть 5 символов
+ *  const validate = string(length(5));
+ *
+ *  // undefined
+ *  validate('aaaaa')
+ *
+ *  // error
+ *  validate('va')
+ *
+ */
+export declare const length: <TLastSchemaValues extends Record<string, unknown>>(len: number, params?: LengthParams) => (value: string, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => import("../core").ValidationResult;
+export {};

package/length/length.js

@@ -0,0 +1,26 @@
+import { createRule } from '../core';
+import { STRING_LENGTH_ERROR_CODE } from './constants';
+/**
+ * @description Проверяет значение на соответствие длине. Работает с: string
+ * @param len - целевой кол-во символов
+ * @example
+ *  // Длина строки должна быть 5 символов
+ *  const validate = string(length(5));
+ *
+ *  // undefined
+ *  validate('aaaaa')
+ *
+ *  // error
+ *  validate('va')
+ *
+ */
+export const length = (len, params) => createRule((value, ctx) => {
+    const currentLength = value.trim().length;
+    if (currentLength !== len) {
+        return ctx.createError({
+            code: STRING_LENGTH_ERROR_CODE,
+            message: (params === null || params === void 0 ? void 0 : params.message) || `Кол-во символов должно быть: ${len}`,
+        });
+    }
+    return undefined;
+});

package/object/object.js

@@ -37,8 +37,7 @@ export const object = (schema) => createGuard((value, ctx, { typeErrorMessage, i
         const schemaEntries = Object.entries(schema);
         const isOptional = context.global.overrides.objectIsPartial || isPartial;
         return schemaEntries.reduce((errorMap, [key, rule]) => {
-            const isGuard = 'define' in rule;
-            const callRule = isGuard && isOptional ? optional(rule) : rule;
+            const callRule = isOptional ? optional(rule) : rule;
             errorMap[key] = callRecursiveRule(callRule, value[key], context);
             return errorMap;
         }, {});

package/object/objectAsync/objectAsync.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import isPlainObject from 'is-plain-obj';
 import { callAsyncRule as callAsyncRecursiveRule, createContext, createErrorMap, createGuard, } from '../../core';
-import { optional } from '../../optional';
+import { optionalAsync } from '../../optional';
 import { isEmptyErrors } from '../isEmptyErrors';
 import { OBJECT_TYPE_ERROR_INFO } from '../constants';
 // TODO: необходимо реализовать переиспользование логики между object и objectAsync
@@ -55,8 +55,7 @@ export const objectAsync = (schema) => createGuard((value, ctx, { typeErrorMessa
         const schemaEntries = Object.entries(schema);
         const isOptional = context.global.overrides.objectIsPartial || isPartial;
         const results = yield Promise.all(schemaEntries.map(([key, rule]) => {
-            const isGuard = 'define' in rule;
-            const callRule = isGuard && isOptional ? optional(rule) : rule;
+            const callRule = isOptional ? optionalAsync(rule) : rule;
             return callAsyncRecursiveRule(callRule, value[key], context);
         }));
         return results.reduce((errorMap, validationResult, index) => {

package/optional/optionalAsync/optionalAsync.d.ts

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

package/package.json

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