@astral/validations 4.22.0 → 4.23.0

package/README.md

@@ -59,6 +59,7 @@
   - [file](#file)
     - [uploadedFile](#uploadedfile)
     - [uploadedFileList](#uploadedfilelist)
+  - [emailOrPhone](#emailOrPhone)
   - [boolean](#boolean)
   - [object](#object)
     - [partial](#partial)
@@ -415,59 +416,6 @@ validateCyrillicEmail('asdasd@xn--h1alffa9fa.xn--p1ai')
 
 ---
 
-### emailOrPhone
-
-Проверяет валиден ли email или мобильный телефон. 
-- Если строка содержит кириллицу, латиницу или символ @ - проверяется как email
-- Иначе убираются все символы, кроме digits, и проверяется как mobilePhone
-
-
-- для email работает с русскими доменами и punycode,
-```ts
-import { string, emailOrPhone } from '@astral/validations';
-
-const validate = string(emailOrPhone());
-
-// undefined
-validate('example@mail.ru');
-
-// { message: 'Некорректный E-mail' }
-validate('example.ru');
-
-
-// Пользовательское сообщение для ошибки с максимальным количеством символов
-const validateEmail = emailOrPhone({ invalidLengthMessage: 'Слишком длинный email' });
-
-// { message: 'Слишком длинный email' }
-validateEmail('longlonglong.......')
-
-//Проверка email с разрешенной кирилицей и punycode
-const validateCyrillicEmail = emailOrPhone({ allowCyrillic: true });
-
-// undefined
-validateCyrillicEmail('test@домен.рф')
-validateCyrillicEmail('asdasd@xn--h1alffa9fa.xn--p1ai')
-
-```
-- для телефона работает с произвольными масками
-```ts
-import { string, emailOrPhone } from '@astral/validations';
-
-const validate = string(emailOrPhone());
-
-// undefined
-validate('79999999999')
-validate('7 (999) 99-99-999')
-validate('+79999999999')
-validate('89999999999')
-
-// { message: 'Некорректный формат' }
-validate('8999999')
-validate('%$^*%$(')
-```
-
----
-
 ### guid
 
 Проверяет валиден ли GUID.
@@ -1287,6 +1235,107 @@ validate([{ id: '1', name: 'document1.pdf', status: { isRestrictionError: true }
 validate([{ id: '1', name: 'document1.pdf', status: { isRestrictionError: true, errorMsg: 'Размер файла не может превышать 3.00 Кб' } },
 { id: '2', name: 'document2.pdf' }])
 ```
+
+---
+
+### emailOrPhone
+
+- Валидация предназначена для компонента [FormEmailOrPhoneField](https://main--61baeff6f06230003a88ef8a.chromatic.com/?path=/docs/form-formemailorphonefield--docs)
+
+
+Проверяет валиден ли email или мобильный телефон.
+- Если строка содержит кириллицу, латиницу или символ @ - проверяется как email
+- Иначе убираются все символы, кроме digits, и проверяется как mobilePhone
+
+- для email работает с русскими доменами и punycode,
+```ts
+import { emailOrPhone } from '@astral/validations';
+
+const validate = emailOrPhone();
+
+// undefined
+validate({
+  value: 'example@mail.ru',
+  normalizedValue: 'example@mail.ru',
+  type: 'email',
+});
+
+// { message: 'Некорректный E-mail' }
+validate({
+  value: 'example.ru',
+  normalizedValue: 'example.ru',
+  type: 'email',
+});
+
+
+// Пользовательское сообщение для ошибки с максимальным количеством символов
+const validateEmail = emailOrPhone({ invalidLengthMessage: 'Слишком длинный email' });
+
+// { message: 'Слишком длинный email' }
+validateEmail({
+  value: 'longlonglong.......',
+  normalizedValue: 'longlonglong.......',
+  type: 'email',
+});
+
+//Проверка email с разрешенной кирилицей и punycode
+const validateCyrillicEmail = emailOrPhone({ allowCyrillic: true });
+
+// undefined
+validateCyrillicEmail({
+  value: 'test@домен.рф',
+  normalizedValue: 'test@домен.рф',
+  type: 'email',
+});
+validateCyrillicEmail({
+  value: 'asdasd@xn--h1alffa9fa.xn--p1ai',
+  normalizedValue: 'asdasd@xn--h1alffa9fa.xn--p1ai',
+  type: 'email',
+});
+
+```
+- для телефона работает с произвольными масками
+```ts
+import { string, emailOrPhone } from '@astral/validations';
+
+const validate = emailOrPhone();
+
+// undefined
+validate({
+  value: '79999999999',
+  normalizedValue: '79999999999',
+  type: 'phone',
+});
+
+validate({
+  value: '7 (999) 99-99-999',
+  normalizedValue: '79999999999',
+  type: 'phone',
+});
+validate({
+  value: '+79999999999',
+  normalizedValue: '79999999999',
+  type: 'phone',
+});
+validate({
+  value: '89999999999',
+  normalizedValue: '79999999999',
+  type: 'phone',
+});
+
+// { message: 'Некорректный формат' }
+validate({
+  value: '8999999',
+  normalizedValue: '8999999',
+  type: 'unknown',
+});
+validate({
+  value: '%$^*%$(',
+  normalizedValue: '%$^*%$(',
+  type: 'unknown',
+});
+```
+
 ---
 
 ## boolean

package/emailOrPhone/emailOrPhone.d.ts

@@ -1,15 +1,12 @@
-import { type EmailParams } from '../email';
-import { type MobilePhoneParams } from '../mobilePhone';
-export type EmailOrPhoneParams = EmailParams & MobilePhoneParams;
 /**
- * Проверяет валидность email или мобильного телефона.
+ * Guard для поля "Email или телефон". Проверяет валидность email или мобильного телефона.
  * - Если строка содержит кириллицу, латиницу или символ @ - проверяется как email
  * - Иначе убираются все символы, кроме digits, и проверяется как mobilePhone
  * @example
  * ```ts
- *  const validate = string(emailOrPhone());
- *  validate('example@mail.ru');
- *  validate('79999999999');
+ *  const validate = emailOrPhone();
+ *  validate({ value: 'example@mail.ru', normalizedValue: 'example@mail.ru', type: 'email' });
+ *  validate({ value: '+7 (999) 999-99-99', normalizedValue: '79999999999', type: 'phone' });
  * ```
  */
-export declare const emailOrPhone: <TLastSchemaValues extends Record<string, unknown>>(params?: EmailOrPhoneParams) => (value: string, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => ReturnType<import("../core").IndependentValidationRule<string, TLastSchemaValues>>;
+export declare const emailOrPhone: <TLastSchemaValues extends Record<string, unknown>>() => import("../core").Guard<TLastSchemaValues, {}>;

package/emailOrPhone/emailOrPhone.js

@@ -1,29 +1,38 @@
-import { checkPhone, checkProbablyEmail, normalizePhone } from '@astral/utils';
-import { createRule } from '../core';
+import { createGuard } from '../core';
 import { email } from '../email';
 import { mobilePhone } from '../mobilePhone';
 import { EMAIL_OR_PHONE_ERROR_INFO } from './constants';
 /**
- * Проверяет валидность email или мобильного телефона.
+ * Guard для поля "Email или телефон". Проверяет валидность email или мобильного телефона.
  * - Если строка содержит кириллицу, латиницу или символ @ - проверяется как email
  * - Иначе убираются все символы, кроме digits, и проверяется как mobilePhone
  * @example
  * ```ts
- *  const validate = string(emailOrPhone());
- *  validate('example@mail.ru');
- *  validate('79999999999');
+ *  const validate = emailOrPhone();
+ *  validate({ value: 'example@mail.ru', normalizedValue: 'example@mail.ru', type: 'email' });
+ *  validate({ value: '+7 (999) 999-99-99', normalizedValue: '79999999999', type: 'phone' });
  * ```
  */
-export const emailOrPhone = (params) => createRule((value, ctx) => {
-    if (checkProbablyEmail(value)) {
-        return email(params)(value, ctx);
+export const emailOrPhone = () => createGuard((value, ctx) => {
+    if (!value ||
+        typeof value !== 'object' ||
+        !('value' in value) ||
+        !('normalizedValue' in value) ||
+        !('type' in value)) {
+        return ctx.createError({
+            code: EMAIL_OR_PHONE_ERROR_INFO.code,
+            message: EMAIL_OR_PHONE_ERROR_INFO.message,
+        });
     }
-    const normalizedPhone = normalizePhone(value);
-    if (checkPhone(normalizedPhone)) {
-        return mobilePhone(params)(normalizedPhone, ctx);
+    const { value: formattedValue = '', normalizedValue = '', type, } = value;
+    if (type === 'email') {
+        return email()(formattedValue, ctx);
+    }
+    if (type === 'phone') {
+        return mobilePhone()(normalizedValue, ctx);
     }
     return ctx.createError({
-        message: (params === null || params === void 0 ? void 0 : params.message) || EMAIL_OR_PHONE_ERROR_INFO.message,
+        message: EMAIL_OR_PHONE_ERROR_INFO.message,
         code: EMAIL_OR_PHONE_ERROR_INFO.code,
     });
-}, { exclude: params === null || params === void 0 ? void 0 : params.exclude });
+});

package/emailOrPhone/types.d.ts

@@ -0,0 +1,5 @@
+export type EmailOrPhone = {
+    value?: string;
+    normalizedValue?: string;
+    type: 'email' | 'phone' | 'unknown';
+};

package/emailOrPhone/types.js

@@ -0,0 +1 @@
+export {};

package/node/emailOrPhone/emailOrPhone.d.ts

@@ -1,15 +1,12 @@
-import { type EmailParams } from '../email';
-import { type MobilePhoneParams } from '../mobilePhone';
-export type EmailOrPhoneParams = EmailParams & MobilePhoneParams;
 /**
- * Проверяет валидность email или мобильного телефона.
+ * Guard для поля "Email или телефон". Проверяет валидность email или мобильного телефона.
  * - Если строка содержит кириллицу, латиницу или символ @ - проверяется как email
  * - Иначе убираются все символы, кроме digits, и проверяется как mobilePhone
  * @example
  * ```ts
- *  const validate = string(emailOrPhone());
- *  validate('example@mail.ru');
- *  validate('79999999999');
+ *  const validate = emailOrPhone();
+ *  validate({ value: 'example@mail.ru', normalizedValue: 'example@mail.ru', type: 'email' });
+ *  validate({ value: '+7 (999) 999-99-99', normalizedValue: '79999999999', type: 'phone' });
  * ```
  */
-export declare const emailOrPhone: <TLastSchemaValues extends Record<string, unknown>>(params?: EmailOrPhoneParams) => (value: string, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => ReturnType<import("../core").IndependentValidationRule<string, TLastSchemaValues>>;
+export declare const emailOrPhone: <TLastSchemaValues extends Record<string, unknown>>() => import("../core").Guard<TLastSchemaValues, {}>;

package/node/emailOrPhone/emailOrPhone.js

@@ -1,33 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.emailOrPhone = void 0;
-const utils_1 = require("@astral/utils");
 const core_1 = require("../core");
 const email_1 = require("../email");
 const mobilePhone_1 = require("../mobilePhone");
 const constants_1 = require("./constants");
 /**
- * Проверяет валидность email или мобильного телефона.
+ * Guard для поля "Email или телефон". Проверяет валидность email или мобильного телефона.
  * - Если строка содержит кириллицу, латиницу или символ @ - проверяется как email
  * - Иначе убираются все символы, кроме digits, и проверяется как mobilePhone
  * @example
  * ```ts
- *  const validate = string(emailOrPhone());
- *  validate('example@mail.ru');
- *  validate('79999999999');
+ *  const validate = emailOrPhone();
+ *  validate({ value: 'example@mail.ru', normalizedValue: 'example@mail.ru', type: 'email' });
+ *  validate({ value: '+7 (999) 999-99-99', normalizedValue: '79999999999', type: 'phone' });
  * ```
  */
-const emailOrPhone = (params) => (0, core_1.createRule)((value, ctx) => {
-    if ((0, utils_1.checkProbablyEmail)(value)) {
-        return (0, email_1.email)(params)(value, ctx);
+const emailOrPhone = () => (0, core_1.createGuard)((value, ctx) => {
+    if (!value ||
+        typeof value !== 'object' ||
+        !('value' in value) ||
+        !('normalizedValue' in value) ||
+        !('type' in value)) {
+        return ctx.createError({
+            code: constants_1.EMAIL_OR_PHONE_ERROR_INFO.code,
+            message: constants_1.EMAIL_OR_PHONE_ERROR_INFO.message,
+        });
     }
-    const normalizedPhone = (0, utils_1.normalizePhone)(value);
-    if ((0, utils_1.checkPhone)(normalizedPhone)) {
-        return (0, mobilePhone_1.mobilePhone)(params)(normalizedPhone, ctx);
+    const { value: formattedValue = '', normalizedValue = '', type, } = value;
+    if (type === 'email') {
+        return (0, email_1.email)()(formattedValue, ctx);
+    }
+    if (type === 'phone') {
+        return (0, mobilePhone_1.mobilePhone)()(normalizedValue, ctx);
     }
     return ctx.createError({
-        message: (params === null || params === void 0 ? void 0 : params.message) || constants_1.EMAIL_OR_PHONE_ERROR_INFO.message,
+        message: constants_1.EMAIL_OR_PHONE_ERROR_INFO.message,
         code: constants_1.EMAIL_OR_PHONE_ERROR_INFO.code,
     });
-}, { exclude: params === null || params === void 0 ? void 0 : params.exclude });
+});
 exports.emailOrPhone = emailOrPhone;

package/node/emailOrPhone/types.d.ts

@@ -0,0 +1,5 @@
+export type EmailOrPhone = {
+    value?: string;
+    normalizedValue?: string;
+    type: 'email' | 'phone' | 'unknown';
+};

package/node/emailOrPhone/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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