@zydon/common 2.6.93 → 2.6.95

package/dist/useFileUploadService-1a2d0cf5.d.ts

@@ -0,0 +1,358 @@
+import * as react from 'react';
+import { DropzoneOptions, DropzoneRootProps, FileRejection, DropzoneInputProps, useDropzone } from 'react-dropzone';
+import { Area } from 'react-easy-crop';
+import { DraggableAttributes, DraggableSyntheticListeners } from '@dnd-kit/core';
+import { StackProps } from '@mui/material/Stack';
+import { SxProps, Theme } from '@mui/material/styles';
+
+interface ExtendFile extends File {
+    id: string;
+    url: string;
+}
+interface FileDetails {
+    id: string;
+    url: string;
+    name?: string;
+}
+interface FileUpload {
+    url: string;
+    file: ExtendFile;
+    contentType: string;
+    resourceIds: string[];
+}
+type CropSize = {
+    width: number;
+    height: number;
+} | number;
+type CreateFilesMutation = (files: ExtendFile[]) => Promise<string[] | undefined>;
+interface FileCreateRequest {
+    files: Array<{
+        content_type: keyof typeof ContentType;
+        name: string;
+    }>;
+}
+interface FileGetResponse {
+    id: string;
+    name: string;
+    organization_id: string;
+    url: string;
+    status: 'PENDING' | 'COMPLETED' | 'FAILED';
+    content_type: string;
+    content_length: number;
+    created_by: string;
+    created_at: string;
+    updated_by: string;
+    updated_at: string;
+}
+interface FileCreateResponse {
+    files: FileGetResponse[];
+}
+interface FileQueryRequest {
+    ids: string[];
+}
+interface FileQueryResponse {
+    files: FileGetResponse[];
+}
+interface SingleFilePreviewProps extends StackProps {
+    file: ExtendFile;
+    aspectRatio?: number;
+    isLoading?: boolean;
+    cropSize?: CropSize;
+    onLoading?: (isLoading: boolean) => void;
+    isUploading?: boolean;
+    maxWidth?: number;
+    maxHeight?: number;
+}
+interface LoadingPreviewImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
+    aspectRatio: number;
+    maxWidth?: number | string;
+    maxHeight?: number | string;
+    isLoading?: boolean;
+    isUploading?: boolean;
+    cropSize?: CropSize;
+    onLoading?: (isLoading: boolean) => void;
+    alt?: string;
+    src?: string;
+    loading: 'lazy';
+}
+interface PlaceholderProps extends StackProps {
+    header?: React.ReactNode;
+    description?: React.ReactNode;
+}
+interface FileUploadProps {
+    createFilesMutation: (params: FileCreateRequest) => {
+        unwrap: () => Promise<FileCreateResponse>;
+    };
+    filesDetails: FileDetails[];
+}
+interface SingleFileUploadProps extends DropzoneOptions {
+    onRemove?: (file?: ExtendFile) => void;
+    onFileSelect?: (file: ExtendFile) => void;
+    createFilesMutation: FileUploadProps['createFilesMutation'];
+    fileDetails?: FileDetails;
+    placeholderProps?: PlaceholderProps;
+    placeholderAlt?: React.ReactNode;
+    name?: string;
+    label?: string;
+    id?: string;
+    disabled?: boolean;
+    error?: string;
+    helperText?: string | React.ReactNode;
+    sx?: SxProps<Theme>;
+    dropZoneSxProps?: SxProps<Theme>;
+    uploading?: boolean;
+    tabIndex?: number;
+    maxSize?: number;
+}
+interface SingleImageUploadProps extends SingleFileUploadProps {
+    aspectRatio?: number;
+    enableCrop?: boolean;
+    convertToWebp?: boolean;
+    cropSize?: CropSize;
+    maxWidth?: number;
+    maxHeight?: number;
+    compressionQuality?: number;
+    maxCompressedWidth?: number;
+    maxCompressedHeight?: number;
+}
+interface MultiFileUploadProps extends Omit<SingleFileUploadProps, 'filesDetails' | 'onFileSelect'> {
+    onFilesSelect?: (files: ExtendFile[]) => void;
+    onRemoveAll?: (files?: ExtendFile[]) => void;
+    onReorder?: (oldIndex: number, newIndex: number, files: ExtendFile[]) => void;
+    filesDetails?: FileDetails[];
+    maxFiles?: number;
+    thumbnail?: boolean;
+}
+interface MultiImageUploadProps extends MultiFileUploadProps {
+    aspectRatio?: number;
+    enableCrop?: boolean;
+    convertToWebp?: boolean;
+    cropSize?: CropSize;
+    maxWidth?: number;
+    maxHeight?: number;
+    compressionQuality?: number;
+    maxCompressedWidth?: number;
+    maxCompressedHeight?: number;
+}
+interface SortableItemProps extends StackProps {
+    onRemove?: (file?: ExtendFile) => void;
+    file: ExtendFile;
+    thumbnail?: boolean;
+    disableDrag?: boolean;
+}
+interface MultiFilePreviewProps extends StackProps {
+    onReorder?: (oldIndex: number, newIndex: number, files: ExtendFile[]) => void;
+    onRemove?: (file?: ExtendFile) => void;
+    files: ExtendFile[];
+    lastNode?: React.ReactNode;
+    firstNode?: React.ReactNode;
+    thumbnail: boolean;
+    slotProps?: {
+        thumbnail?: Omit<FileThumbnailProps, 'file'>;
+    };
+}
+interface StyledDropZoneProps extends StackProps {
+    isDragActive: boolean;
+    isError: boolean;
+    disabled: boolean;
+}
+type StyledDropZonePropsType = Omit<DropzoneRootProps, 'children' | 'onDrop' | 'onError'> & StyledDropZoneProps;
+interface RejectionFilesProps extends StackProps {
+    files: FileRejection[];
+}
+interface ThumbnailBadgeProps {
+    onRemove?: (file?: ExtendFile) => void;
+    file: ExtendFile;
+    attributes: DraggableAttributes;
+    listeners: DraggableSyntheticListeners;
+    innerWidth: number;
+    isDragging: boolean;
+    disableDrag?: boolean;
+    sx?: SxProps<Theme>;
+}
+interface DropZoneProps {
+    sx?: SxProps;
+    uploading?: boolean;
+    id?: string;
+    tabIndex?: number;
+    getRootProps: () => DropzoneRootProps;
+    getInputProps: () => DropzoneInputProps;
+    isDragActive: boolean;
+    isError: boolean;
+    disabled?: boolean;
+    dropZoneSxProps?: SxProps<Theme>;
+    dropZoneContent?: React.ReactNode;
+    children?: React.ReactNode;
+    name?: string;
+}
+interface HelperTextProps {
+    helperText?: string | React.ReactNode;
+    disabled?: boolean;
+    isError?: boolean;
+}
+interface UseDropzoneUploaderProps {
+    onReorder?: (oldIndex: number, newIndex: number, files: ExtendFile[]) => void;
+    onFileSelect?: (file: ExtendFile) => void;
+    onFilesSelect?: (files: ExtendFile[]) => void;
+    onRemove?: (file?: ExtendFile) => void;
+    uploadFiles: (files: File[]) => Promise<ExtendFile[] | undefined>;
+    filesPreview?: ExtendFile[];
+    dropzoneOptions?: Omit<DropzoneOptions, 'onDrop' | 'onDropRejected'>;
+    enableCrop?: boolean;
+    customAspectRatio?: number;
+    convertToWebp?: boolean;
+    maxFiles?: number;
+    cropSize?: {
+        width: number;
+        height: number;
+    } | number;
+    compressionQuality?: number;
+    maxCompressedWidth?: number;
+    maxCompressedHeight?: number;
+}
+interface UseDropzoneUploaderReturn {
+    file: ExtendFile | null;
+    files: ExtendFile[];
+    aspectRatio: number;
+    dropzoneProps: {
+        getRootProps: ReturnType<typeof useDropzone>['getRootProps'];
+        getInputProps: ReturnType<typeof useDropzone>['getInputProps'];
+        isDragActive: boolean;
+        isDragReject: boolean;
+        fileRejections: readonly FileRejection[];
+    };
+    cropState: {
+        cropModalOpen: boolean;
+        imagePreview: string;
+        cropLoading: boolean;
+        setCropModalOpen: React.Dispatch<React.SetStateAction<boolean>>;
+        onCropInitialized: (croppedArea: Area, croppedAreaPixels: Area) => void;
+        handleCropSave: () => Promise<void>;
+        handleCropCancel: () => void;
+        currentImageIndex: number;
+        totalPendingImages: number;
+    };
+    setInitialFiles?: (files: ExtendFile[]) => void;
+    handleRemove: (fileToRemove?: ExtendFile) => void;
+    handleReorder: (oldIndex: number, newIndex: number, files: ExtendFile[]) => void;
+}
+declare enum ContentType {
+    APPLICATION_OCTET_STREAM = "application/octet-stream",
+    IMAGE_JPEG = "image/jpeg",
+    IMAGE_JPG = "image/jpg",
+    IMAGE_PNG = "image/png",
+    IMAGE_GIF = "image/gif",
+    IMAGE_WEBP = "image/webp",
+    IMAGE_SVG = "image/svg+xml",
+    IMAGE_BMP = "image/bmp",
+    IMAGE_TIFF = "image/tiff",
+    IMAGE_ICO = "image/x-icon",
+    IMAGE_AVIF = "image/avif",
+    APPLICATION_PDF = "application/pdf",
+    TEXT_PLAIN = "text/plain",
+    TEXT_CSV = "text/csv",
+    APPLICATION_RTF = "application/rtf",
+    APPLICATION_MSWORD = "application/msword",
+    APPLICATION_DOCX = "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+    APPLICATION_MSEXCEL = "application/vnd.ms-excel",
+    APPLICATION_XLSX = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    APPLICATION_MSPOWERPOINT = "application/vnd.ms-powerpoint",
+    APPLICATION_PPTX = "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+    APPLICATION_ODT = "application/vnd.oasis.opendocument.text",
+    APPLICATION_ODS = "application/vnd.oasis.opendocument.spreadsheet",
+    APPLICATION_ODP = "application/vnd.oasis.opendocument.presentation",
+    APPLICATION_XML = "application/xml",
+    TEXT_XML = "text/xml",
+    TEXT_HTML = "text/html",
+    TEXT_CSS = "text/css",
+    APPLICATION_JSON = "application/json",
+    TEXT_JAVASCRIPT = "text/javascript",
+    APPLICATION_ZIP = "application/zip",
+    APPLICATION_GZIP = "application/gzip",
+    APPLICATION_RAR = "application/vnd.rar",
+    APPLICATION_7Z = "application/x-7z-compressed",
+    AUDIO_MPEG = "audio/mpeg",
+    AUDIO_WAV = "audio/wav",
+    AUDIO_OGG = "audio/ogg",
+    AUDIO_WEBM = "audio/webm",
+    AUDIO_AAC = "audio/aac",
+    VIDEO_MP4 = "video/mp4",
+    VIDEO_MPEG = "video/mpeg",
+    VIDEO_OGG = "video/ogg",
+    VIDEO_WEBM = "video/webm",
+    VIDEO_QUICKTIME = "video/quicktime"
+}
+declare enum FileContentType {
+    'application/octet-stream' = "APPLICATION_OCTET_STREAM",
+    'image/jpeg' = "IMAGE_JPEG",
+    'image/jpg' = "IMAGE_JPG",
+    'image/png' = "IMAGE_PNG",
+    'image/gif' = "IMAGE_GIF",
+    'image/webp' = "IMAGE_WEBP",
+    'image/svg+xml' = "IMAGE_SVG",
+    'image/bmp' = "IMAGE_BMP",
+    'image/tiff' = "IMAGE_TIFF",
+    'image/x-icon' = "IMAGE_ICO",
+    'image/avif' = "IMAGE_AVIF",
+    'application/pdf' = "APPLICATION_PDF",
+    'text/plain' = "TEXT_PLAIN",
+    'text/csv' = "TEXT_CSV",
+    'application/rtf' = "APPLICATION_RTF",
+    'application/msword' = "APPLICATION_MSWORD",
+    'application/vnd.openxmlformats-officedocument.wordprocessingml.document' = "APPLICATION_DOCX",
+    'application/vnd.ms-excel' = "APPLICATION_MSEXCEL",
+    'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' = "APPLICATION_XLSX",
+    'application/vnd.ms-powerpoint' = "APPLICATION_MSPOWERPOINT",
+    'application/vnd.openxmlformats-officedocument.presentationml.presentation' = "APPLICATION_PPTX",
+    'application/vnd.oasis.opendocument.text' = "APPLICATION_ODT",
+    'application/vnd.oasis.opendocument.spreadsheet' = "APPLICATION_ODS",
+    'application/vnd.oasis.opendocument.presentation' = "APPLICATION_ODP",
+    'application/xml' = "APPLICATION_XML",
+    'text/xml' = "TEXT_XML",
+    'text/html' = "TEXT_HTML",
+    'text/css' = "TEXT_CSS",
+    'application/json' = "APPLICATION_JSON",
+    'text/javascript' = "TEXT_JAVASCRIPT",
+    'application/zip' = "APPLICATION_ZIP",
+    'application/gzip' = "APPLICATION_GZIP",
+    'application/vnd.rar' = "APPLICATION_RAR",
+    'application/x-7z-compressed' = "APPLICATION_7Z",
+    'audio/mpeg' = "AUDIO_MPEG",
+    'audio/wav' = "AUDIO_WAV",
+    'audio/ogg' = "AUDIO_OGG",
+    'audio/webm' = "AUDIO_WEBM",
+    'audio/aac' = "AUDIO_AAC",
+    'video/mp4' = "VIDEO_MP4",
+    'video/mpeg' = "VIDEO_MPEG",
+    'video/ogg' = "VIDEO_OGG",
+    'video/webm' = "VIDEO_WEBM",
+    'video/quicktime' = "VIDEO_QUICKTIME"
+}
+
+type FileThumbnailProps = StackProps & {
+    tooltip?: boolean;
+    file: ExtendFile;
+    imageView?: boolean;
+    sx?: SxProps<Theme>;
+    onDownload?: () => void;
+    onRemove?: () => void;
+    slotProps?: {
+        img?: SxProps<Theme>;
+        icon?: SxProps<Theme>;
+        removeBtn?: SxProps<Theme>;
+        downloadBtn?: SxProps<Theme>;
+    };
+};
+
+declare const useFileUploadService: ({ createFilesMutation, filesDetails, }: FileUploadProps) => {
+    setFilesPreview: react.Dispatch<react.SetStateAction<ExtendFile[]>>;
+    uploadFiles: (files: File[]) => Promise<ExtendFile[] | undefined>;
+    filesPreview: ExtendFile[];
+    filePreview: ExtendFile;
+    isLoadingPreview: boolean;
+    isUploadingFiles: boolean;
+    isUploadOrLoadingFiles: boolean;
+    uploadErrorText: string;
+};
+
+export { ContentType as C, DropZoneProps as D, ExtendFile as E, FileThumbnailProps as F, HelperTextProps as H, LoadingPreviewImageProps as L, MultiFilePreviewProps as M, PlaceholderProps as P, RejectionFilesProps as R, SingleFilePreviewProps as S, ThumbnailBadgeProps as T, UseDropzoneUploaderProps as U, UseDropzoneUploaderReturn as a, MultiFileUploadProps as b, MultiImageUploadProps as c, SingleFileUploadProps as d, SingleImageUploadProps as e, FileContentType as f, FileDetails as g, FileUpload as h, CropSize as i, CreateFilesMutation as j, FileCreateRequest as k, FileGetResponse as l, FileCreateResponse as m, FileQueryRequest as n, FileQueryResponse as o, FileUploadProps as p, SortableItemProps as q, StyledDropZoneProps as r, StyledDropZonePropsType as s, useFileUploadService as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zydon/common",
-  "version": "2.6.93",
+  "version": "2.6.95",
   "license": "MIT",
   "type": "module",
   "module": "./dist/index.js",

package/dist/{chunk-CASOITDH.js → chunk-L4KD6JF2.js}

@@ -1,9 +1,9 @@
 import { a } from './chunk-SO64ZYQB.js';
+import { a as a$7 } from './chunk-GUFT6XPG.js';
 import { c, b as b$1 } from './chunk-FT5VGKNM.js';
 import { a as a$1, e } from './chunk-KHS3U6GK.js';
 import { a as a$3, b } from './chunk-DXGMZFNS.js';
 import { p, r, a as a$2 } from './chunk-7KH2T72T.js';
-import { a as a$7 } from './chunk-GUFT6XPG.js';
 import { d, a as a$4 } from './chunk-7J53ZUIF.js';
 import { a as a$6 } from './chunk-S7QQBC4I.js';
 import { a as a$5 } from './chunk-QQDMA4TE.js';