@astral/validations 4.0.0 → 4.1.0

package/README.md

@@ -34,6 +34,9 @@
     - [kpp](#kpp)
     - [ogrnIP](#ogrnIP)
     - [ogrnUL](#ogrnUL)
+    - [personName](#personName)
+    - [personSurname](#personSurname)
+    - [personPatronymic](#personPatronymic)
   - [date](#date)
     - [min](#min-date)
     - [max](#max-date)
@@ -573,6 +576,72 @@ validate('1-22-33-5555555-6')
 
 ---
 
+### personName
+
+Проверяет валидно ли имя
+
+#### [Требования на реализацию](https://track.astral.ru/soft/wiki/pages/viewpage.action?pageId=3813152849#id-Требованиянареализацию-Требование5.Поле"Имя")
+
+```ts
+import { string, personName } from '@astral/validations';
+
+const validate = string(personName());
+
+// undefined
+validate('Иван');
+validate('иван');
+
+// { message: 'Проверьте имя' }
+validate('');
+validate('Иван--Иван');
+```
+
+---
+
+### personSurname
+
+Проверяет валидно ли фамилия
+
+#### [Требования на реализацию](https://track.astral.ru/soft/wiki/pages/viewpage.action?pageId=3813152849#id-Требованиянареализацию-Требование4.Поле"Фамилия")
+
+```ts
+import { string, personSurname } from '@astral/validations';
+
+const validate = string(personSurname());
+
+// undefined
+validate('Иванов');
+validate('иванов');
+
+// { message: 'Проверьте фамилию' }
+validate('');
+validate('Иванов--иванов');
+```
+
+---
+
+### personPatronymic
+
+Проверяет валидно ли отчество
+
+#### [Требования на реализацию](https://track.astral.ru/soft/wiki/pages/viewpage.action?pageId=3813152849#id-Требованиянареализацию-Требование6.Поле"Отчество")
+
+```ts
+import { string, personPatronymic } from '@astral/validations';
+
+const validate = string(personPatronymic());
+
+// undefined
+validate('Иванович');
+validate('иванович');
+
+
+// { message: 'Проверьте отчество' }
+validate('');
+validate('Иванович--Иванович');
+```
+
+
 ## date
 
 - Возвращает ошибку если:

package/core/utils/index.d.ts

@@ -1,3 +1,7 @@
 export * from './isStringOfZeros';
 export * from './isNoDoubleZeroStart';
 export * from './resetTime';
+export * from './isStartsWithAndEndsWithLetter';
+export * from './isHasConsecutiveChars';
+export * from './isFullNameValidCharacters';
+export * from './isValidFullNameLength';

package/core/utils/index.js

@@ -1,3 +1,7 @@
 export * from './isStringOfZeros';
 export * from './isNoDoubleZeroStart';
 export * from './resetTime';
+export * from './isStartsWithAndEndsWithLetter';
+export * from './isHasConsecutiveChars';
+export * from './isFullNameValidCharacters';
+export * from './isValidFullNameLength';

package/core/utils/isFullNameValidCharacters/index.d.ts

@@ -0,0 +1 @@
+export * from './isFullNameValidCharacters';

package/core/utils/isFullNameValidCharacters/index.js

@@ -0,0 +1 @@
+export * from './isFullNameValidCharacters';

package/core/utils/isFullNameValidCharacters/isFullNameValidCharacters.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @description Проверяет, что разрешенные символы в тексте: прописные (большие) и строчные буквы (включая ё) русского алфавита,
+      прописные (большие) буквы I и V латинского алфавита, -, пробел, точка, апостроф, запятая, открывающая и закрывающая скобка
+ */
+export declare const isFullNameValidCharacters: (value: string) => boolean;

package/core/utils/isFullNameValidCharacters/isFullNameValidCharacters.js

@@ -0,0 +1,5 @@
+/**
+ * @description Проверяет, что разрешенные символы в тексте: прописные (большие) и строчные буквы (включая ё) русского алфавита,
+      прописные (большие) буквы I и V латинского алфавита, -, пробел, точка, апостроф, запятая, открывающая и закрывающая скобка
+ */
+export const isFullNameValidCharacters = (value) => !/^([а-яёА-ЯЁIV ё.,'’‎()\-\s]+)$/.test(value);

package/core/utils/isHasConsecutiveChars/index.d.ts

@@ -0,0 +1 @@
+export * from './isHasConsecutiveChars';

package/core/utils/isHasConsecutiveChars/index.js

@@ -0,0 +1 @@
+export * from './isHasConsecutiveChars';

package/core/utils/isHasConsecutiveChars/isHasConsecutiveChars.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @description Проверяет, что текст не может содержать последовательно два спецсимвола/пробела
+ */
+export declare const isHasConsecutiveChars: (value: string) => boolean;

package/core/utils/isHasConsecutiveChars/isHasConsecutiveChars.js

@@ -0,0 +1,4 @@
+/**
+ * @description Проверяет, что текст не может содержать последовательно два спецсимвола/пробела
+ */
+export const isHasConsecutiveChars = (value) => /([`~!@#$%^&*()\-_=+[{\]}\|;:'",<.>/?])\1|\s{2}/.test(value);

package/core/utils/isStartsWithAndEndsWithLetter/index.d.ts

@@ -0,0 +1 @@
+export * from './isStartsWithAndEndsWithLetter';

package/core/utils/isStartsWithAndEndsWithLetter/index.js

@@ -0,0 +1 @@
+export * from './isStartsWithAndEndsWithLetter';

package/core/utils/isStartsWithAndEndsWithLetter/isStartsWithAndEndsWithLetter.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @description Проверяет, что текст начинается с буквы и заканчивается буквой, кроме скобок ()
+ */
+export declare const isStartsWithAndEndsWithLetter: (value: string) => boolean;

package/core/utils/isStartsWithAndEndsWithLetter/isStartsWithAndEndsWithLetter.js

@@ -0,0 +1,4 @@
+/**
+ * @description Проверяет, что текст начинается с буквы и заканчивается буквой, кроме скобок ()
+ */
+export const isStartsWithAndEndsWithLetter = (value) => !/^[IV а-яёА-ЯЁ()](?:.*[IV а-яёА-ЯЁ()])?$/.test(value);

package/core/utils/isValidFullNameLength/index.d.ts

@@ -0,0 +1 @@
+export * from './isValidFullNameLength';

package/core/utils/isValidFullNameLength/index.js

@@ -0,0 +1 @@
+export * from './isValidFullNameLength';

package/core/utils/isValidFullNameLength/isValidFullNameLength.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @description Проверяет, что длина значения находится в допустимом диапазоне от 1 до 200 символов
+ */
+export declare const isValidFullNameLength: (value: string) => boolean;

package/core/utils/isValidFullNameLength/isValidFullNameLength.js

@@ -0,0 +1,4 @@
+/**
+ * @description Проверяет, что длина значения находится в допустимом диапазоне от 1 до 200 символов
+ */
+export const isValidFullNameLength = (value) => value.length < 1 || value.length > 200;

package/index.d.ts

@@ -24,6 +24,9 @@ export { snils, SNILS_ERROR_INFO } from './snils';
 export { createRule, REQUIRED_ERROR_INFO, type ValidationRule } from './core';
 export { ogrnUL, OGRN_UL_ERROR_INFO } from './ogrnUL';
 export { ogrnIP, OGRN_IP_ERROR_INFO } from './ogrnIP';
+export { personName, PERSON_NAME_ERROR_INFO } from './personName';
+export { personSurname, PERSON_SURNAME_ERROR_INFO } from './personSurname';
+export { personPatronymic, PERSON_PATRONYMIC_ERROR_INFO, } from './personPatronymic';
 export { any } from './any';
 export { when } from './when';
 export { toPrettyError } from './toPrettyError';

package/index.js

@@ -24,6 +24,9 @@ export { snils, SNILS_ERROR_INFO } from './snils';
 export { createRule, REQUIRED_ERROR_INFO } from './core';
 export { ogrnUL, OGRN_UL_ERROR_INFO } from './ogrnUL';
 export { ogrnIP, OGRN_IP_ERROR_INFO } from './ogrnIP';
+export { personName, PERSON_NAME_ERROR_INFO } from './personName';
+export { personSurname, PERSON_SURNAME_ERROR_INFO } from './personSurname';
+export { personPatronymic, PERSON_PATRONYMIC_ERROR_INFO, } from './personPatronymic';
 export { any } from './any';
 export { when } from './when';
 export { toPrettyError } from './toPrettyError';

package/package.json

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

package/personName/constants.d.ts

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

package/personName/constants.js

@@ -0,0 +1,5 @@
+import { createErrorCode } from '../core';
+export const PERSON_NAME_ERROR_INFO = {
+    code: createErrorCode('personName'),
+    message: 'Проверьте имя',
+};

package/personName/index.d.ts

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

package/personName/index.js

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

package/personName/personName.d.ts

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

package/personName/personName.js

@@ -0,0 +1,29 @@
+import { createRule, isFullNameValidCharacters, isHasConsecutiveChars, isStartsWithAndEndsWithLetter, isValidFullNameLength, } from '../core';
+import { PERSON_NAME_ERROR_INFO } from './constants';
+/**
+ * @description Проверяет валидно ли имя
+ * @example
+ * ```ts
+ * const validate = string(personName());
+ * validate("Иван");
+ * ```
+ */
+export const personName = (params) => createRule((value, ctx) => {
+    const createPersonNameError = () => ctx.createError({
+        message: (params === null || params === void 0 ? void 0 : params.message) || PERSON_NAME_ERROR_INFO.message,
+        code: PERSON_NAME_ERROR_INFO.code,
+    });
+    if (isValidFullNameLength(value)) {
+        return createPersonNameError();
+    }
+    if (isFullNameValidCharacters(value)) {
+        return createPersonNameError();
+    }
+    if (isStartsWithAndEndsWithLetter(value)) {
+        return createPersonNameError();
+    }
+    if (isHasConsecutiveChars(value)) {
+        return createPersonNameError();
+    }
+    return undefined;
+}, { exclude: params === null || params === void 0 ? void 0 : params.exclude });

package/personPatronymic/constants.d.ts

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

package/personPatronymic/constants.js

@@ -0,0 +1,5 @@
+import { createErrorCode } from '../core';
+export const PERSON_PATRONYMIC_ERROR_INFO = {
+    code: createErrorCode('personPatronymic'),
+    message: 'Проверьте отчество',
+};

package/personPatronymic/index.d.ts

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

package/personPatronymic/index.js

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

package/personPatronymic/personPatronymic.d.ts

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

package/personPatronymic/personPatronymic.js

@@ -0,0 +1,29 @@
+import { createRule, isFullNameValidCharacters, isHasConsecutiveChars, isStartsWithAndEndsWithLetter, isValidFullNameLength, } from '../core';
+import { PERSON_PATRONYMIC_ERROR_INFO } from './constants';
+/**
+ * @description Проверяет валидно ли отчество
+ * @example
+ * ```ts
+ * const validate = string(personPatronymic());
+ * validate("Иванович");
+ * ```
+ */
+export const personPatronymic = (params) => createRule((value, ctx) => {
+    const createPersonPatronymicError = () => ctx.createError({
+        message: (params === null || params === void 0 ? void 0 : params.message) || PERSON_PATRONYMIC_ERROR_INFO.message,
+        code: PERSON_PATRONYMIC_ERROR_INFO.code,
+    });
+    if (isValidFullNameLength(value)) {
+        return createPersonPatronymicError();
+    }
+    if (isFullNameValidCharacters(value)) {
+        return createPersonPatronymicError();
+    }
+    if (isStartsWithAndEndsWithLetter(value)) {
+        return createPersonPatronymicError();
+    }
+    if (isHasConsecutiveChars(value)) {
+        return createPersonPatronymicError();
+    }
+    return undefined;
+}, { exclude: params === null || params === void 0 ? void 0 : params.exclude });

package/personSurname/constants.d.ts

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

package/personSurname/constants.js

@@ -0,0 +1,5 @@
+import { createErrorCode } from '../core';
+export const PERSON_SURNAME_ERROR_INFO = {
+    code: createErrorCode('personSurname'),
+    message: 'Проверьте фамилию',
+};

package/personSurname/index.d.ts

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

package/personSurname/index.js

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

package/personSurname/personSurname.d.ts

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

package/personSurname/personSurname.js

@@ -0,0 +1,29 @@
+import { createRule, isFullNameValidCharacters, isHasConsecutiveChars, isStartsWithAndEndsWithLetter, isValidFullNameLength, } from '../core';
+import { PERSON_SURNAME_ERROR_INFO } from './constants';
+/**
+ * @description Проверяет валидно ли фамилия
+ * @example
+ * ```ts
+ * const validate = string(personSurname());
+ * validate("Иванов");
+ * ```
+ */
+export const personSurname = (params) => createRule((value, ctx) => {
+    const createPersonSurnameError = () => ctx.createError({
+        message: (params === null || params === void 0 ? void 0 : params.message) || PERSON_SURNAME_ERROR_INFO.message,
+        code: PERSON_SURNAME_ERROR_INFO.code,
+    });
+    if (isValidFullNameLength(value)) {
+        return createPersonSurnameError();
+    }
+    if (isFullNameValidCharacters(value)) {
+        return createPersonSurnameError();
+    }
+    if (isStartsWithAndEndsWithLetter(value)) {
+        return createPersonSurnameError();
+    }
+    if (isHasConsecutiveChars(value)) {
+        return createPersonSurnameError();
+    }
+    return undefined;
+}, { exclude: params === null || params === void 0 ? void 0 : params.exclude });