@astral/validations 4.10.1 → 4.12.0

package/README.md

@@ -26,6 +26,7 @@
     - [max](#max-string)
     - [email](#email)
     - [guid](#guid)
+    - [length](#length)
     - [pattern](#pattern)
     - [onlyNumber](#onlyNumber)
     - [containsNumbers](#containsNumbers)
@@ -35,6 +36,8 @@
     - [mobilePhone](#mobilePhone)
     - [innUL](#innUL)
     - [innIP](#innIP)
+    - [innFL](#innFL)
+    - [innTwelveSymbols](#innTwelveSymbols)
     - [kpp](#kpp)
     - [ogrnIP](#ogrnIP)
     - [ogrnUL](#ogrnUL)
@@ -412,6 +415,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
 
 Проверяет строку на соответствие регулярному выражению.
@@ -596,6 +618,51 @@ validate('+384212952720')
 
 ---
 
+### innFL
+
+Проверяет валиден ли ИНН ФЛ
+
+```ts
+import { string, innFL } from '@astral/validations';
+
+const validate = string(innFL());
+
+// undefined
+validate('384212952720')
+validate('000000000000')
+
+// { message: 'Некорректный ИНН ФЛ' }
+validate('3842129527')
+validate('384212952a20')
+validate('+384212952720')
+```
+
+:information_source: Поддерживает [exclude](#exclusion-managing)
+
+---
+
+### innTwelveSymbols
+
+Проверяет валиден ли ИНН из 12 символов
+
+```ts
+import { string, innTwelveSymbols } from '@astral/validations';
+
+const validate = string(innTwelveSymbols());
+
+// undefined
+validate('384212952720')
+
+// { message: 'Некорректный ИНН' }
+validate('3842129527')
+validate('384212952a20')
+validate('+384212952720')
+```
+
+:information_source: Поддерживает [exclude](#exclusion-managing)
+
+---
+
 ### kpp
 
 Проверяет валиден ли КПП

package/index.d.ts

@@ -21,9 +21,12 @@ 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 { innTwelveSymbols, INN_12_SYMBOLS_ERROR_INFO, } from './innTwelveSymbols';
 export { innIP, INN_IP_ERROR_INFO } from './innIP';
+export { innFL, INN_FL_ERROR_INFO } from './innFL';
 export { kpp, INVALID_KPP_ERROR_INFO, KPP_DOUBLE_ZERO_START_ERROR_INFO, KPP_ZEROS_ONLY_ERROR_INFO, } from './kpp';
 export { snils, SNILS_ERROR_INFO } from './snils';
 export { createRule, REQUIRED_ERROR_INFO, type ValidationRule } from './core';

package/index.js

@@ -21,9 +21,12 @@ 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 { innTwelveSymbols, INN_12_SYMBOLS_ERROR_INFO, } from './innTwelveSymbols';
 export { innIP, INN_IP_ERROR_INFO } from './innIP';
+export { innFL, INN_FL_ERROR_INFO } from './innFL';
 export { kpp, INVALID_KPP_ERROR_INFO, KPP_DOUBLE_ZERO_START_ERROR_INFO, KPP_ZEROS_ONLY_ERROR_INFO, } from './kpp';
 export { snils, SNILS_ERROR_INFO } from './snils';
 export { createRule, REQUIRED_ERROR_INFO } from './core';

package/innFL/constants.d.ts

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

package/innFL/constants.js

@@ -0,0 +1,5 @@
+import { createErrorCode } from '../core';
+export const INN_FL_ERROR_INFO = {
+    code: createErrorCode('innFL'),
+    message: 'Некорректный ИНН ФЛ',
+};

package/innFL/index.d.ts

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

package/innFL/index.js

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

package/innFL/innFL.d.ts

@@ -0,0 +1,17 @@
+import { CommonRuleParams } from '../core';
+type InnFLParams = CommonRuleParams<string> & {
+    /**
+     * @description Замена стандартного сообщения ошибки.
+     */
+    message?: string;
+};
+/**
+ * @description Проверяет валиден ли ИНН ФЛ
+ * @example
+ * ```ts
+ * const validate = string(innFL());
+ * validate('7728168971');
+ * ```
+ */
+export declare const innFL: <TLastSchemaValues extends Record<string, unknown>>(params?: InnFLParams) => (value: string, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => import("../core").ValidationResult;
+export {};

package/innFL/innFL.js

@@ -0,0 +1,21 @@
+import { createRule } from '../core';
+import { innTwelveSymbols } from '../innTwelveSymbols';
+import { INN_FL_ERROR_INFO } from './constants';
+/**
+ * @description Проверяет валиден ли ИНН ФЛ
+ * @example
+ * ```ts
+ * const validate = string(innFL());
+ * validate('7728168971');
+ * ```
+ */
+export const innFL = (params) => createRule((value, ctx) => {
+    const createInnFLError = () => ctx.createError({
+        message: (params === null || params === void 0 ? void 0 : params.message) || INN_FL_ERROR_INFO.message,
+        code: INN_FL_ERROR_INFO.code,
+    });
+    if (innTwelveSymbols()(value) !== undefined) {
+        return createInnFLError();
+    }
+    return undefined;
+}, { exclude: params === null || params === void 0 ? void 0 : params.exclude });

package/innIP/constants.d.ts

@@ -1,5 +1,2 @@
 import { ErrorInfo } from '../core';
 export declare const INN_IP_ERROR_INFO: ErrorInfo;
-export declare const INN_IP_LENGTH = 12;
-export declare const FIRST_INN_IP_DECODING: number[];
-export declare const SECOND_INN_IP_DECODING: number[];

package/innIP/constants.js

@@ -3,6 +3,3 @@ export const INN_IP_ERROR_INFO = {
     code: createErrorCode('innIP'),
     message: 'Некорректный ИНН ИП',
 };
-export const INN_IP_LENGTH = 12;
-export const FIRST_INN_IP_DECODING = [7, 2, 4, 10, 3, 5, 9, 4, 6, 8];
-export const SECOND_INN_IP_DECODING = [3, 7, 2, 4, 10, 3, 5, 9, 4, 6, 8];

package/innIP/innIP.js

@@ -1,15 +1,6 @@
 import { createRule, isNoDoubleZeroStart, isStringOfZeros, } from '../core';
-import { FIRST_INN_IP_DECODING, INN_IP_ERROR_INFO, INN_IP_LENGTH, SECOND_INN_IP_DECODING, } from './constants';
-const calcFirstCheckSumForInnIP = (arrSymbols) => (arrSymbols
-    .slice(0, -2)
-    .reduce((sum, symbol, index) => FIRST_INN_IP_DECODING[index] * Number(symbol) + sum, 0) %
-    11) %
-    10;
-const calcSecondCheckSumForInnIP = (arrSymbols) => (arrSymbols
-    .slice(0, -1)
-    .reduce((sum, symbol, index) => SECOND_INN_IP_DECODING[index] * Number(symbol) + sum, 0) %
-    11) %
-    10;
+import { innTwelveSymbols } from '../innTwelveSymbols';
+import { INN_IP_ERROR_INFO } from './constants';
 /**
  * @description Проверяет валиден ли ИНН ИП
  * @example
@@ -29,14 +20,7 @@ export const innIP = (params) => createRule((value, ctx) => {
     if (!isNoDoubleZeroStart(value)) {
         return createInnIPError();
     }
-    if (value.length !== INN_IP_LENGTH) {
-        return createInnIPError();
-    }
-    const arrSymbols = value.split('');
-    const firstChecksum = calcFirstCheckSumForInnIP(arrSymbols);
-    const secondChecksum = calcSecondCheckSumForInnIP(arrSymbols);
-    if (Number(value[10]) !== firstChecksum &&
-        Number(value[11]) !== secondChecksum) {
+    if (innTwelveSymbols()(value) !== undefined) {
         return createInnIPError();
     }
     return undefined;

package/innTwelveSymbols/constants.d.ts

@@ -0,0 +1,5 @@
+import { ErrorInfo } from '../core';
+export declare const INN_12_SYMBOLS_ERROR_INFO: ErrorInfo;
+export declare const INN_12_SYMBOLS_LENGTH = 12;
+export declare const FIRST_INN_12_SYMBOLS_DECODING: number[];
+export declare const SECOND_INN_12_SYMBOLS_DECODING: number[];

package/innTwelveSymbols/constants.js

@@ -0,0 +1,10 @@
+import { createErrorCode } from '../core';
+export const INN_12_SYMBOLS_ERROR_INFO = {
+    code: createErrorCode('innTwelveSymbols'),
+    message: 'Некорректный ИНН',
+};
+export const INN_12_SYMBOLS_LENGTH = 12;
+export const FIRST_INN_12_SYMBOLS_DECODING = [7, 2, 4, 10, 3, 5, 9, 4, 6, 8];
+export const SECOND_INN_12_SYMBOLS_DECODING = [
+    3, 7, 2, 4, 10, 3, 5, 9, 4, 6, 8,
+];

package/innTwelveSymbols/index.d.ts

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

package/innTwelveSymbols/index.js

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

package/innTwelveSymbols/innTwelveSymbols.d.ts

@@ -0,0 +1,17 @@
+import { CommonRuleParams } from '../core';
+type InnTwelveSymbolsParams = CommonRuleParams<string> & {
+    /**
+     * @description Замена стандартного сообщения ошибки.
+     */
+    message?: string;
+};
+/**
+ * @description Проверяет, валиден ли ИНН из 12 символов
+ * @example
+ * ```ts
+ * const validate = string(innTwelveSymbols());
+ * validate('7728168971');
+ * ```
+ */
+export declare const innTwelveSymbols: <TLastSchemaValues extends Record<string, unknown>>(params?: InnTwelveSymbolsParams) => (value: string, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => import("../core").ValidationResult;
+export {};

package/innTwelveSymbols/innTwelveSymbols.js

@@ -0,0 +1,37 @@
+import { createRule } from '../core';
+import { FIRST_INN_12_SYMBOLS_DECODING, INN_12_SYMBOLS_ERROR_INFO, INN_12_SYMBOLS_LENGTH, SECOND_INN_12_SYMBOLS_DECODING, } from './constants';
+const firstCheckSumForInnTwelveSymbols = (arrSymbols) => (arrSymbols
+    .slice(0, -2)
+    .reduce((sum, symbol, index) => FIRST_INN_12_SYMBOLS_DECODING[index] * Number(symbol) + sum, 0) %
+    11) %
+    10;
+const secondCheckSumForInnTwelveSymbols = (arrSymbols) => (arrSymbols
+    .slice(0, -1)
+    .reduce((sum, symbol, index) => SECOND_INN_12_SYMBOLS_DECODING[index] * Number(symbol) + sum, 0) %
+    11) %
+    10;
+/**
+ * @description Проверяет, валиден ли ИНН из 12 символов
+ * @example
+ * ```ts
+ * const validate = string(innTwelveSymbols());
+ * validate('7728168971');
+ * ```
+ */
+export const innTwelveSymbols = (params) => createRule((value, ctx) => {
+    const createInnTwelveSymbolsError = () => ctx.createError({
+        message: (params === null || params === void 0 ? void 0 : params.message) || INN_12_SYMBOLS_ERROR_INFO.message,
+        code: INN_12_SYMBOLS_ERROR_INFO.code,
+    });
+    if (value.length !== INN_12_SYMBOLS_LENGTH) {
+        return createInnTwelveSymbolsError();
+    }
+    const arrSymbols = value.split('');
+    const firstChecksum = firstCheckSumForInnTwelveSymbols(arrSymbols);
+    const secondChecksum = secondCheckSumForInnTwelveSymbols(arrSymbols);
+    if (Number(value[10]) !== firstChecksum ||
+        Number(value[11]) !== secondChecksum) {
+        return createInnTwelveSymbolsError();
+    }
+    return undefined;
+}, { exclude: params === null || params === void 0 ? void 0 : params.exclude });

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/package.json

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