@astral/validations 4.19.0 → 4.20.0

package/index.d.ts

@@ -49,3 +49,5 @@ export { rangeDate, RANGE_DATE_END_EARLIER_START_ERROR_INFO, RANGE_DATE_END_INVA
 export { rangeDateInterval, RANGE_DATE_INTERVAL_ERROR_INFO, } from './rangeDateInterval';
 export { rangeDateMinMax, RANGE_DATE_MAX_ERROR_INFO, RANGE_DATE_MIN_ERROR_INFO, } from './rangeDateMinMax';
 export { rangeDateNotEqual, RANGE_DATE_NOT_EQUAL_ERROR_INFO, } from './rangeDateNotEqual';
+export { uploadedFile, FILE_UPLOAD_ERROR_INFO, FILE_LOADING_ERROR_INFO, FILE_REQUIRED_ERROR_INFO, FILE_RESTRICTION_ERROR_INFO, } from './uploadedFile';
+export { uploadedFileList, FILE_LIST_NOT_ARRAY_ERROR_INFO, } from './uploadedFileList';

package/index.js

@@ -49,3 +49,5 @@ export { rangeDate, RANGE_DATE_END_EARLIER_START_ERROR_INFO, RANGE_DATE_END_INVA
 export { rangeDateInterval, RANGE_DATE_INTERVAL_ERROR_INFO, } from './rangeDateInterval';
 export { rangeDateMinMax, RANGE_DATE_MAX_ERROR_INFO, RANGE_DATE_MIN_ERROR_INFO, } from './rangeDateMinMax';
 export { rangeDateNotEqual, RANGE_DATE_NOT_EQUAL_ERROR_INFO, } from './rangeDateNotEqual';
+export { uploadedFile, FILE_UPLOAD_ERROR_INFO, FILE_LOADING_ERROR_INFO, FILE_REQUIRED_ERROR_INFO, FILE_RESTRICTION_ERROR_INFO, } from './uploadedFile';
+export { uploadedFileList, FILE_LIST_NOT_ARRAY_ERROR_INFO, } from './uploadedFileList';

package/package.json

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

package/uploadedFile/constants.d.ts

@@ -0,0 +1,5 @@
+import { type ErrorInfo } from '../core';
+export declare const FILE_RESTRICTION_ERROR_INFO: ErrorInfo;
+export declare const FILE_LOADING_ERROR_INFO: ErrorInfo;
+export declare const FILE_UPLOAD_ERROR_INFO: ErrorInfo;
+export declare const FILE_REQUIRED_ERROR_INFO: ErrorInfo;

package/uploadedFile/constants.js

@@ -0,0 +1,17 @@
+import { createErrorCode } from '../core';
+export const FILE_RESTRICTION_ERROR_INFO = {
+    code: createErrorCode('file-restriction'),
+    message: 'Файл не соответствует ограничениям',
+};
+export const FILE_LOADING_ERROR_INFO = {
+    code: createErrorCode('file-loading'),
+    message: 'Файл загружается',
+};
+export const FILE_UPLOAD_ERROR_INFO = {
+    code: createErrorCode('file-upload'),
+    message: 'Ошибка загрузки файла',
+};
+export const FILE_REQUIRED_ERROR_INFO = {
+    code: createErrorCode('file-required'),
+    message: 'Загрузите файл',
+};

package/uploadedFile/index.d.ts

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

package/uploadedFile/index.js

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

package/uploadedFile/types.d.ts

@@ -0,0 +1,46 @@
+type FileStatus = {
+    /**
+     * Флаг загрузки файла
+     */
+    isLoading?: boolean;
+    /**
+     * Флаг состояния ошибки при загрузке файла
+     */
+    isUploadError?: boolean;
+    /**
+     * Флаг состояния ошибки при проверке файла на условия
+     */
+    isRestrictionError?: boolean;
+    /**
+     * Текст ошибки
+     */
+    errorMsg?: string;
+    /**
+     * Значение прогресса загрузки файла.
+     */
+    progress?: number;
+};
+export type UploadFile = {
+    /**
+     * Идентификатор
+     */
+    id: string;
+    /**
+     * Название файла
+     */
+    name: string;
+    /**
+     * Размер файла в байтах
+     */
+    size?: number;
+    file?: File;
+    /**
+     * Ссылка на файле
+     */
+    url?: string;
+    /**
+     * Состояния файла
+     */
+    status?: FileStatus;
+};
+export {};

package/uploadedFile/types.js

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

package/uploadedFile/uploadedFile.d.ts

@@ -0,0 +1,30 @@
+import { type ValidationRule } from '../core';
+import type { UploadFile } from './types';
+/**
+ * Guard для файла. Проверяет объект на соответствие формату UploadFile и его статусы загрузки.
+ * Валидирует наличие обязательных полей (id, name) и проверяет статусы файла (isLoading, isUploadError, isRestrictionError).
+ * @param rules - дополнительные правила валидации для файла
+ * @example
+ * ```ts
+ * const validate = uploadedFile();
+ *
+ * // Валидный файл
+ * validate({
+ *   id: 1,
+ *   name: "document.pdf",
+ *   status: {
+ *     isLoading: false
+ *   }
+ * });
+ *
+ * // Файл с ошибкой загрузки
+ * validate({
+ *   id: 1,
+ *   name: "document.pdf",
+ *   status: {
+ *     isUploadError: true
+ *   }
+ * });
+ * ```
+ */
+export declare const uploadedFile: <TLastSchemeValues extends Record<string, unknown>>(...rules: ValidationRule<UploadFile, TLastSchemeValues>[]) => import("../core").Guard<TLastSchemeValues, {}>;

package/uploadedFile/uploadedFile.js

@@ -0,0 +1,60 @@
+import { compose, createGuard, } from '../core';
+import { FILE_LOADING_ERROR_INFO, FILE_REQUIRED_ERROR_INFO, FILE_RESTRICTION_ERROR_INFO, FILE_UPLOAD_ERROR_INFO, } from './constants';
+/**
+ * Guard для файла. Проверяет объект на соответствие формату UploadFile и его статусы загрузки.
+ * Валидирует наличие обязательных полей (id, name) и проверяет статусы файла (isLoading, isUploadError, isRestrictionError).
+ * @param rules - дополнительные правила валидации для файла
+ * @example
+ * ```ts
+ * const validate = uploadedFile();
+ *
+ * // Валидный файл
+ * validate({
+ *   id: 1,
+ *   name: "document.pdf",
+ *   status: {
+ *     isLoading: false
+ *   }
+ * });
+ *
+ * // Файл с ошибкой загрузки
+ * validate({
+ *   id: 1,
+ *   name: "document.pdf",
+ *   status: {
+ *     isUploadError: true
+ *   }
+ * });
+ * ```
+ */
+export const uploadedFile = (...rules) => createGuard((value, ctx) => {
+    if (!value ||
+        typeof value !== 'object' ||
+        !('id' in value) ||
+        !('name' in value)) {
+        return ctx.createError({
+            code: FILE_REQUIRED_ERROR_INFO.code,
+            message: FILE_REQUIRED_ERROR_INFO.message,
+        });
+    }
+    const { status } = value;
+    if (status === null || status === void 0 ? void 0 : status.isRestrictionError) {
+        return ctx.createError({
+            code: FILE_RESTRICTION_ERROR_INFO.code,
+            message: status.errorMsg || FILE_RESTRICTION_ERROR_INFO.message,
+        });
+    }
+    if (status === null || status === void 0 ? void 0 : status.isLoading) {
+        return ctx.createError({
+            code: FILE_LOADING_ERROR_INFO.code,
+            message: status.errorMsg || FILE_LOADING_ERROR_INFO.message,
+        });
+    }
+    if (status === null || status === void 0 ? void 0 : status.isUploadError) {
+        return ctx.createError({
+            code: FILE_UPLOAD_ERROR_INFO.code,
+            message: status.errorMsg || FILE_UPLOAD_ERROR_INFO.message,
+        });
+    }
+    return compose(...rules)(value, ctx);
+});

package/uploadedFileList/constants.d.ts

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

package/uploadedFileList/constants.js

@@ -0,0 +1,5 @@
+import { createErrorCode } from '../core';
+export const FILE_LIST_NOT_ARRAY_ERROR_INFO = {
+    code: createErrorCode('file-list-array'),
+    message: 'Не является массивом',
+};

package/uploadedFileList/index.d.ts

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

package/uploadedFileList/index.js

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

package/uploadedFileList/uploadedFileList.d.ts

@@ -0,0 +1,24 @@
+import { type ValidationRule } from '../core';
+import { type UploadFile } from '../uploadedFile/types';
+/**
+ * Guard для списка файлов. Проверяет массив на валидность и каждый файл в массиве на соответствие формату UploadFile.
+ * Проверяет статусы файлов (isLoading, isUploadError, isRestrictionError).
+ * @param rules - дополнительные правила валидации для массива файлов
+ * @example
+ * ```ts
+ * const validate = uploadedFileList();
+ *
+ * // Валидный массив файлов
+ * validate([
+ *   { id: 1, name: "document1.pdf" },
+ *   { id: 2, name: "document2.pdf", status: { isLoading: false } }
+ * ]);
+ *
+ * // Массив с ошибкой загрузки
+ * validate([
+ *   { id: 1, name: "document1.pdf" },
+ *   { id: 2, name: "document2.pdf", status: { isUploadError: true } }
+ * ]);
+ * ```
+ */
+export declare const uploadedFileList: <TLastSchemeValues extends Record<string, unknown>>(...rules: ValidationRule<UploadFile[], TLastSchemeValues>[]) => import("../core").Guard<TLastSchemeValues, {}>;

package/uploadedFileList/uploadedFileList.js

@@ -0,0 +1,43 @@
+import { compose, createGuard, } from '../core';
+import { array } from '../array';
+import { uploadedFile } from '../uploadedFile';
+import { FILE_LIST_NOT_ARRAY_ERROR_INFO } from './constants';
+/**
+ * Guard для списка файлов. Проверяет массив на валидность и каждый файл в массиве на соответствие формату UploadFile.
+ * Проверяет статусы файлов (isLoading, isUploadError, isRestrictionError).
+ * @param rules - дополнительные правила валидации для массива файлов
+ * @example
+ * ```ts
+ * const validate = uploadedFileList();
+ *
+ * // Валидный массив файлов
+ * validate([
+ *   { id: 1, name: "document1.pdf" },
+ *   { id: 2, name: "document2.pdf", status: { isLoading: false } }
+ * ]);
+ *
+ * // Массив с ошибкой загрузки
+ * validate([
+ *   { id: 1, name: "document1.pdf" },
+ *   { id: 2, name: "document2.pdf", status: { isUploadError: true } }
+ * ]);
+ * ```
+ */
+export const uploadedFileList = (...rules) => createGuard((value, ctx) => {
+    if (array()(value)) {
+        return ctx.createError({
+            code: FILE_LIST_NOT_ARRAY_ERROR_INFO.code,
+            message: FILE_LIST_NOT_ARRAY_ERROR_INFO.message,
+        });
+    }
+    const uploadFileList = value;
+    for (const item of uploadFileList) {
+        if (uploadedFile()(item)) {
+            const error = uploadedFile()(item, ctx);
+            if (error) {
+                return error;
+            }
+        }
+    }
+    return compose(...rules)(uploadFileList, ctx);
+});