@emailmaker/emailmaker 1.0.100 → 1.0.101-alpha.1

package/fm-notification.d.ts

@@ -0,0 +1,368 @@
+type FileManagerErrorCode =
+  // --- Файлы ---
+  | 'FileNotFound'
+  | 'FileAlreadyExists'
+  | 'FileInvalidName'
+  | 'FileAccessDenied'
+  | 'FileReadError'
+  | 'FileWriteError'
+  | 'FileTooLarge'
+  | 'FileTypeNotAllowed'
+  | 'FileCorrupted'
+  | 'FileChecksumMismatch'
+
+  // --- Папки / каталоги ---
+  | 'FolderNotFound'
+  | 'FolderAlreadyExists'
+  | 'FolderInvalidName'
+  | 'FolderAccessDenied'
+  | 'FolderReadError'
+  | 'FolderWriteError'
+  | 'FolderQuotaExceeded'
+  | 'FolderNotEmpty'
+  | 'FolderBackendError'
+  | 'FolderTimeout'
+
+  // --- Операционные ограничения ---
+  | 'RenameNotAllowed'
+  | 'MoveNotAllowed'
+  | 'CopyNotAllowed'
+  | 'DeleteNotAllowed'
+  | 'MoveIntoSelf'
+  | 'MoveIntoDescendant'
+  | 'UnsupportedOperation'
+  | 'ConfigError'
+
+  // --- Загрузка файлов ---
+  | 'FileUploadQuotaExceeded'
+  | 'FileUploadNetworkError'
+  | 'FileUploadTimeout'
+  | 'FileUploadBackendError'
+
+  // --- Загрузка по URL ---
+  | 'UploadUrlInvalid'
+  | 'UploadUrlNotReachable'
+  | 'UploadUrlContentTypeNotAllowed'
+  | 'UploadUrlDownloadFailed'
+
+  // --- Скачивание файлов ---
+  | 'FileDownloadNetworkError'
+  | 'FileDownloadTimeout'
+  | 'FileDownloadBackendError'
+
+  // --- Батчевые операции ---
+  | 'BatchPartialFailure'
+  | 'BatchAllFailed'
+  | 'BatchConflict'
+  | 'BatchValidationFailed'
+
+  // --- Валидация / данные ---
+  | 'ValidationError'
+  | 'PayloadTooLarge'
+  | 'UnsupportedMediaType'
+
+  // --- Сеть / сервер / инфраструктура ---
+  | 'NetworkError'
+  | 'BackendError'
+  | 'Timeout'
+  | 'AuthenticationFailed'
+  | 'AuthorizationFailed'
+  | 'RateLimitExceeded'
+  | 'ServiceUnavailable'
+
+  // --- AI / интеграции ---
+  | 'AIResponseInvalid'
+  | 'AIImageGenerationFailed'
+  | 'AIImageGenerationLimitExceeded'
+  | 'IntegrationError'
+  | 'ThirdPartyError'
+
+  // --- Общее / запасной вариант ---
+  | 'UnknownError';
+
+/**
+ * Интерфейс ошибки для FileManager API.
+ * Реализован классом FileManagerApiError, который также экспортируется.
+ * 
+ * @example
+ * ```typescript
+ * // Использование класса
+ * throw new FileManagerApiError(
+ *   'File not found',
+ *   'FileNotFound',
+ *   404
+ * );
+ * 
+ * // Или создание собственного класса
+ * class MyFileManagerError extends Error implements IFileManagerApiError {
+ *   constructor(
+ *     message: string,
+ *     public code: FileManagerErrorCode,
+ *     public httpStatus?: number,
+ *     public details?: unknown
+ *   ) {
+ *     super(message);
+ *     this.name = 'MyFileManagerError';
+ *   }
+ * }
+ * ```
+ */
+interface IFileManagerApiError extends Error {
+  code: FileManagerErrorCode;
+  httpStatus?: number;
+  details?: unknown;
+}
+
+interface FilesQueryParams {
+  folderId?: string;
+  search?: string;
+  page?: number;
+  limit?: number;
+  sortBy?: 'name' | 'size' | 'date' | 'type';
+  sortOrder?: 'asc' | 'desc';
+  itemType?: 'file' | 'folder' | 'all';
+}
+
+interface ItemContextPayload {
+  itemIds?: string[];
+  itemNames?: string[];
+  folderId?: string | null;
+  folderName?: string | null;
+}
+
+type NotifyPlacement = 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft' | 'bottomRight';
+
+type Notify = {
+  type: 'success' | 'info' | 'error' | 'warning';
+  message: HTMLElement | string;
+  description?: HTMLElement | string;
+  btn?: HTMLElement | string;
+  onClose?: () => void;
+  duration?: number | null;
+  icon?: HTMLElement | string;
+  placement?: NotifyPlacement;
+  style?: any;
+  className?: string;
+  onClick?: () => void;
+  closeIcon?: HTMLElement | string;
+  props?: any;
+  role?: 'alert' | 'status';
+};
+
+declare namespace Notify {
+  export interface OperationSuccessPayload extends ItemContextPayload {
+    successCount: number;
+    totalCount: number;
+  }
+
+  export interface OperationErrorDetail {
+    itemId?: string;
+    itemName?: string;
+    reason?: string;
+    code?: FileManagerErrorCode;
+    httpStatus?: number;
+  }
+
+  export interface OperationErrorPayload extends ItemContextPayload {
+    failCount: number;
+    totalCount: number;
+    errors?: OperationErrorDetail[];
+  }
+
+  export interface SingleItemPayload {
+    itemId?: string;
+    itemName?: string;
+    folderId?: string | null;
+    folderName?: string | null;
+  }
+
+  export interface RenameErrorPayload extends SingleItemPayload {
+    reason?: string;
+  }
+
+  export interface FileUploadPayload extends SingleItemPayload {
+    uploadId?: string;
+  }
+
+  export interface FileUploadErrorPayload extends FileUploadPayload {
+    error?: string;
+    errorCode?: FileManagerErrorCode;
+    httpStatus?: number;
+  }
+
+  export interface UnsupportedFileTypePayload extends FileUploadErrorPayload {
+    fileType: string;
+  }
+
+  export interface FolderOperationPayload extends ItemContextPayload {
+    folderId?: string | null;
+    folderName?: string;
+    reason?: string;
+  }
+
+  export interface JsonDataProviderErrorPayload {
+    url?: string | null;
+    reason?: string;
+    errorCode?: FileManagerErrorCode;
+  }
+
+  export interface FileUrlValidationErrorPayload {
+    url?: string | null;
+    reason?: string;
+    errorCode?: FileManagerErrorCode;
+  }
+
+  export interface ImageFilePayload extends SingleItemPayload {
+    thumbnail?: string | null;
+  }
+
+  export interface UrlUploadPayload {
+    url?: string | null;
+    folderId?: string | null;
+    folderName?: string | null;
+  }
+
+  export interface UrlUploadErrorPayload extends UrlUploadPayload {
+    reason?: string;
+  }
+
+  export interface FetchFilesErrorPayload {
+    params?: FilesQueryParams;
+  }
+
+  interface AIImageGenerationBasePayload {
+    request: string;
+    taskId?: string | null;
+  }
+
+  export interface AIImageGenerationStartedPayload extends AIImageGenerationBasePayload {
+    response?: unknown;
+  }
+
+  export interface AIImageGenerationSuccessPayload extends AIImageGenerationBasePayload {
+    images: string[];
+  }
+
+  export interface AIImageGenerationFailedPayload extends AIImageGenerationBasePayload {
+    response?: unknown;
+    error?: unknown;
+  }
+
+  export type EventBase<TId extends string, TData> = {
+    id: TId;
+    data?: TData;
+    innerException?: unknown;
+    message: string;
+    placement?: NotifyPlacement; 
+    description?: string;
+
+  };
+
+  export interface ErrorMap {
+    FILE_DOWNLOAD_FAILED: ImageFilePayload;
+    IMAGE_DOWNLOAD_FAILED: ImageFilePayload;
+    IMAGE_SAVE_FAILED: ImageFilePayload;
+    EDITOR_INIT_FAILED: never;
+
+    AI_RESPONSE_INVALID: unknown;
+    AI_IMAGE_GENERATION_FAILED: AIImageGenerationFailedPayload;
+    AI_IMAGE_GENERATION_LIMIT_EXCEEDED: never;
+
+    FILES_FETCH_FAILED: FetchFilesErrorPayload;
+
+    FILES_DELETE_ERROR: OperationErrorPayload;
+
+    FOLDER_DELETE_ERROR: OperationErrorPayload;
+
+    FILE_RENAME_DISABLED_BY_CONFIG: SingleItemPayload;
+    FILE_RENAME_FAILED: RenameErrorPayload;
+
+    FOLDER_RENAME_DISABLED_BY_CONFIG: SingleItemPayload;
+    FOLDER_RENAME_FAILED: RenameErrorPayload;
+
+    ITEM_RENAME_FAILED: RenameErrorPayload;
+
+    FILE_UPLOAD_ITEM_FAILED: FileUploadErrorPayload;
+
+    FILES_UPLOAD_BATCH_FAILED: OperationErrorPayload;
+
+    FILES_UPLOAD_URL_VALIDATION_FAILED: UrlUploadPayload;
+
+    FILES_UPLOAD_URL_NOT_SUPPORTED: UrlUploadPayload;
+    FILES_UPLOAD_BY_URL_FAILED: UrlUploadErrorPayload;
+
+    FILES_UPLOAD_PROVIDER_NOT_CONFIGURED: never;
+
+    FILES_MOVE_DIRECTORY_NOT_SELECTED: never;
+    FILES_MOVE_ERROR: OperationErrorPayload;
+
+    FILES_COPY_DIRECTORY_NOT_SELECTED: never;
+    FILES_COPY_ERROR: OperationErrorPayload;
+
+    FILES_MOVE_TO_TRASH_ERROR: OperationErrorPayload;
+
+    FOLDERS_FETCH_FAILED: FolderOperationPayload;
+    FOLDER_CREATE_PROVIDER_NOT_CONFIGURED: FolderOperationPayload;
+    FOLDER_CREATE_FAILED: FolderOperationPayload;
+    FOLDER_CHILDREN_COUNT_FAILED: FolderOperationPayload;
+    FOLDER_CHILDREN_FETCH_FAILED: FolderOperationPayload;
+
+    JSON_DATA_PROVIDER_LOAD_FAILED: JsonDataProviderErrorPayload;
+    FILE_URL_VALIDATION_FAILED: FileUrlValidationErrorPayload;
+  }
+
+  export type Error = {
+    [K in keyof ErrorMap]: EventBase<K, ErrorMap[K]>;
+  }[keyof ErrorMap];
+
+  export type ErrorEvent = { type: 'error' } & Error;
+
+  export interface SuccessMap {
+    AI_IMAGE_GENERATION_STARTED: AIImageGenerationStartedPayload;
+    AI_IMAGE_GENERERATION_SUCCESS: AIImageGenerationSuccessPayload;
+
+    // EDITOR_IMAGE_DOWNLOAD_SUCCESS: ImageFilePayload;
+    IMAGE_UPDATE_SUCCESS: ImageFilePayload;
+
+    FILES_DELETE_SUCCESS: OperationSuccessPayload;
+    FILES_MOVE_SUCCESS: OperationSuccessPayload;
+    FILES_COPY_SUCCESS: OperationSuccessPayload;
+    FILE_RENAME_SUCCESS: SingleItemPayload;
+    FOLDER_RENAME_SUCCESS: SingleItemPayload;
+    FOLDER_DELETE_SUCCESS: OperationSuccessPayload;
+    FOLDER_CREATE_SUCCESS: FolderOperationPayload;
+    FILES_UPLOAD_BATCH_SUCCESS: OperationSuccessPayload;
+
+    FILE_UPLOAD_ITEM_SUCCESS: FileUploadPayload;
+  }
+
+  export type Success = {
+    [K in keyof SuccessMap]: EventBase<K, SuccessMap[K]>;
+  }[keyof SuccessMap];
+
+  export type SuccessEvent = { type: 'success' } & Success;
+
+  export interface WarningMap {
+    FILES_UPLOAD_UNSUPPORTED_TYPE: UnsupportedFileTypePayload;
+    FOLDER_OPERATION_VALIDATION_FAILED: FolderOperationPayload;
+  }
+
+  export type Warning = {
+    [K in keyof WarningMap]: EventBase<K, WarningMap[K]>;
+  }[keyof WarningMap];
+
+  export type WarningEvent = { type: 'warning' } & Warning;
+
+  export interface InfoMap {}
+
+  export type Info = {
+    [K in keyof InfoMap]: EventBase<K, InfoMap[K]>;
+  }[keyof InfoMap];
+
+  export type InfoEvent = { type: 'info' } & Info;
+}
+
+type NotifyEvent = Notify.SuccessEvent | Notify.ErrorEvent | Notify.WarningEvent | Notify.InfoEvent;
+
+export { Notify };
+export type { FileManagerErrorCode, IFileManagerApiError, ItemContextPayload, NotifyEvent, NotifyPlacement };