@astral/validations 4.12.0 → 4.13.0

package/README.md

@@ -47,6 +47,7 @@
     - [passportSeries](#passportSeries)
     - [passportNumber](#passportNumber)
     - [passportCode](#passportCode)
+    - [textField](#textField)
   - [date](#date)
     - [min](#min-date)
     - [max](#max-date)
@@ -551,6 +552,27 @@ validate('156-573-259 92')
 
 ---
 
+### textField
+
+Проверяет валидно ли текстовое поле
+
+```ts
+import { string, textField } from '@astral/validations';
+
+const validate = string(textField());
+
+// undefined
+validate('!@#$%^&*()-_=+|[]{};:",.<>/?')
+validate('абвАБВ abcABC')
+
+// { message: 'Содержит запрещённые символы' }
+validate('😀')
+validate('∑')
+validate('٩(◕‿◕｡)۶')
+```
+
+---
+
 ### mobilePhone
 
 - Проверяет валиден ли мобильный телефон

package/index.d.ts

@@ -1,6 +1,7 @@
 export { object, objectAsync, OBJECT_TYPE_ERROR_INFO, type Schema, type SchemaValue, type ObjectGuard, type ObjectAsyncGuard, } from './object';
 export { optional, optionalAsync } from './optional';
 export { string, STRING_TYPE_ERROR_INFO, stringAsync } from './string';
+export { textField, INVALID_TEXT_FIELD_ERROR_INFO, LENGTH_TEXT_FIELD_ERROR_INFO, } from './textField';
 export { date, INVALID_DATE_ERROR_INFO, DATE_TYPE_ERROR_INFO } from './date';
 export { number, NAN_NUMBER_ERROR_INFO, NUMBER_TYPE_ERROR_INFO, INFINITY_NUMBER_ERROR_INFO, } from './number';
 export { boolean, BOOLEAN_TYPE_ERROR_INFO } from './boolean';

package/index.js

@@ -1,6 +1,7 @@
 export { object, objectAsync, OBJECT_TYPE_ERROR_INFO, } from './object';
 export { optional, optionalAsync } from './optional';
 export { string, STRING_TYPE_ERROR_INFO, stringAsync } from './string';
+export { textField, INVALID_TEXT_FIELD_ERROR_INFO, LENGTH_TEXT_FIELD_ERROR_INFO, } from './textField';
 export { date, INVALID_DATE_ERROR_INFO, DATE_TYPE_ERROR_INFO } from './date';
 export { number, NAN_NUMBER_ERROR_INFO, NUMBER_TYPE_ERROR_INFO, INFINITY_NUMBER_ERROR_INFO, } from './number';
 export { boolean, BOOLEAN_TYPE_ERROR_INFO } from './boolean';

package/package.json

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

package/textField/constants.d.ts

@@ -0,0 +1,5 @@
+import { ErrorInfo } from '../core';
+export declare const TEXT_FIELD_REGEXP: RegExp;
+export declare const TEXT_FIELD_MAX_LENGTH = 256;
+export declare const INVALID_TEXT_FIELD_ERROR_INFO: ErrorInfo;
+export declare const LENGTH_TEXT_FIELD_ERROR_INFO: ErrorInfo;

package/textField/constants.js

@@ -0,0 +1,11 @@
+import { createErrorCode } from '../core';
+export const TEXT_FIELD_REGEXP = /^[a-zA-Zа-яА-Я0-9\s!@#$%^&*()-_=+\\|[\]{};:'",.<>/?]+$/;
+export const TEXT_FIELD_MAX_LENGTH = 256;
+export const INVALID_TEXT_FIELD_ERROR_INFO = {
+    code: createErrorCode('textField-invalid'),
+    message: 'Содержит запрещённые символы',
+};
+export const LENGTH_TEXT_FIELD_ERROR_INFO = {
+    code: createErrorCode('textField-length'),
+    message: 'Превышено максимальное кол-во символов',
+};

package/textField/index.d.ts

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

package/textField/index.js

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

package/textField/textField.d.ts

@@ -0,0 +1,24 @@
+type TextFieldParams = {
+    /**
+     * @description Замена стандартного сообщения ошибки.
+     */
+    customLength?: number;
+    /**
+     * @description Замена стандартного сообщения ошибки.
+     */
+    message?: string;
+    /**
+     * @description Замена стандартного сообщения ошибки при превышении допустимого количества символов.
+     */
+    invalidLengthMessage?: string;
+};
+/**
+ * @description Проверяет валидность текстового поля
+ * @example
+ * ```ts
+ *  const validate = string(textField());
+ *  validate('Авада кедавра...');
+ * ```
+ */
+export declare const textField: <TLastSchemaValues extends Record<string, unknown>>(params?: TextFieldParams) => (value: string, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => import("../core").ValidationResult;
+export {};

package/textField/textField.js

@@ -0,0 +1,19 @@
+import { createRule } from '../core';
+import { INVALID_TEXT_FIELD_ERROR_INFO, LENGTH_TEXT_FIELD_ERROR_INFO, TEXT_FIELD_MAX_LENGTH, TEXT_FIELD_REGEXP, } from './constants';
+/**
+ * @description Проверяет валидность текстового поля
+ * @example
+ * ```ts
+ *  const validate = string(textField());
+ *  validate('Авада кедавра...');
+ * ```
+ */
+export const textField = (params) => createRule((value, ctx) => {
+    if (value.length > ((params === null || params === void 0 ? void 0 : params.customLength) || TEXT_FIELD_MAX_LENGTH)) {
+        return ctx.createError(Object.assign(Object.assign({}, LENGTH_TEXT_FIELD_ERROR_INFO), { message: (params === null || params === void 0 ? void 0 : params.invalidLengthMessage) || LENGTH_TEXT_FIELD_ERROR_INFO.message }));
+    }
+    if (!TEXT_FIELD_REGEXP.test(value)) {
+        return ctx.createError(Object.assign(Object.assign({}, INVALID_TEXT_FIELD_ERROR_INFO), { message: (params === null || params === void 0 ? void 0 : params.message) || INVALID_TEXT_FIELD_ERROR_INFO.message }));
+    }
+    return undefined;
+});