@mcurros2/microm 1.1.345-0 → 1.1.346-0

package/dist/index.d.ts

@@ -1122,7 +1122,7 @@ export class FileStoreProcessDef extends EntityDefinition {
 export class FileStoreProcess extends Entity<FileStoreProcessDef> {
     constructor(client: MicroMClient, parentKeys?: {});
 }
-interface ImageEditorProps {
+export interface ImageEditorProps {
     sourceFile: File;
     options: ResolvedBrowserImageProcessingOptions;
     onSave: (file: File) => Promise<void> | void;
@@ -1145,11 +1145,9 @@ export interface UploadProgressReport {
     vc_fileguid?: string;
     thumbnailURL?: string;
 }
-export interface UseFileUploadReturnType {
-    uploadFiles: (selectedFiles: File[]) => Promise<UploadProgressReport[]>;
-    editImage: (report: UploadProgressReport) => Promise<UploadProgressReport | null>;
-    deleteFile: (fileGUID: string) => Promise<DBStatusResult>;
-    downloadFile: (fileUrl: string, fileName?: string) => Promise<void>;
+export interface UseFileUploadSnapshot {
+    files: readonly UploadProgressReport[];
+    /** @deprecated Use files instead. */
     uploadProgress: Record<string, UploadProgressReport>;
     fileProcessID: string;
     maxIndividualFileSize?: number;
@@ -1158,17 +1156,36 @@ export interface UseFileUploadReturnType {
     errorNotification?: string;
     cancelledNotification?: boolean;
     uploadingNotification?: boolean;
-    clearNotifications?: () => void;
-    cancelUpload?: () => void;
     loadingNotification?: boolean;
+    processing: boolean;
+    editorEnabled: boolean;
+}
+interface UseFileUploadActions {
+    uploadFiles: (selectedFiles: File[]) => Promise<UploadProgressReport[]>;
+    replaceFile: (fileGUID: string, replacementFile: File) => Promise<UploadProgressReport | null>;
+    editImage: (file: string | UploadProgressReport) => Promise<UploadProgressReport | null>;
+    openImageEditor: (file: File) => Promise<File | null>;
+    canEditImage: (file: string | UploadProgressReport) => boolean;
+    refreshFiles: () => Promise<Record<string, UploadProgressReport>>;
+    deleteFile: (fileGUID: string) => Promise<DBStatusResult>;
+    downloadFile: (fileUrl: string, fileName?: string) => Promise<void>;
+    clearNotifications: () => void;
+    cancelUpload: () => void;
+}
+export interface UseFileUploadReturnType extends UseFileUploadSnapshot, UseFileUploadActions {
+    subscribe: (listener: () => void) => () => void;
+    getSnapshot: () => UseFileUploadSnapshot;
 }
+export function useFileUploadSnapshot(uploadAPI: UseFileUploadReturnType): UseFileUploadSnapshot;
 export type ValidateFileReturnType = {
     error: boolean;
     message?: string;
 };
 export type UploadCompletionResult = ValidateFileReturnType & {
+    /** @deprecated Uploaded files now remain in the canonical files list until deleted. */
     removeFromQueue?: boolean;
 };
+export type ImageEditorConfigurationProps = Partial<Pick<ImageEditorProps, 'saveLabel' | 'cancelLabel' | 'rotateClockwiseLabel' | 'rotateCounterClockwiseLabel'>>;
 export interface UseFileUploadProps {
     client: MicroMClient;
     fileProcessColumn: EntityColumn<string>;
@@ -1182,9 +1199,14 @@ export interface UseFileUploadProps {
     totalUploadExceedsMaximumSizeText?: string;
     onCancel?: () => void;
     editor?: boolean;
+    imageProcessing?: BrowserImageProcessingOptions;
+    imageEditorTitle?: ReactNode;
+    imageEditorProps?: ImageEditorConfigurationProps;
+    imageEditorModalProps?: MicroMModalSettings;
     onValidateFile?: (file: File) => Promise<ValidateFileReturnType>;
     onProcessFile?: (file: File) => Promise<File | null>;
     onBeforeUpload?: (file: File) => Promise<boolean>;
+    onBeforeReplace?: (currentFile: UploadProgressReport, replacementFile?: File) => Promise<boolean>;
     onUploadComplete?: (report: UploadProgressReport) => Promise<UploadCompletionResult | void>;
     thumbnailMaxSize?: number;
     thumbnailQuality?: number;
@@ -1200,7 +1222,7 @@ export interface FileUploaderProps extends Omit<DropzoneProps, 'children' | 'onD
     FilesText?: string;
     EachFileShouldNotExceedText?: string;
     uploadAPI: UseFileUploadReturnType;
-    onDelete?: (fileGUID: string) => boolean;
+    onDelete?: (fileGUID: string) => boolean | Promise<boolean>;
     imageProps?: ImageProps;
     closeText?: string;
     cancelledText?: string;
@@ -1211,17 +1233,21 @@ export interface FileUploaderProps extends Omit<DropzoneProps, 'children' | 'onD
     parentFormAPI?: UseEntityFormReturnType;
     editor?: boolean;
     editImageLabel?: string;
+    replaceFileGUID?: string;
+    replaceExistingFile?: boolean;
 }
 export const FileUploaderDefaultProps: Partial<FileUploaderProps>;
 export function FileUploader(props: FileUploaderProps): JSX.Element;
 export interface FilesUploadFormProps extends UseFileUploadProps {
     fileProcessColumn: EntityColumn<string>;
     onOK?: (fileprocess_id: string, uploadProgress: Record<string, UploadProgressReport>) => void;
-    onDelete?: (fileGUID: string) => boolean;
+    onDelete?: (fileGUID: string) => boolean | Promise<boolean>;
     helpMessage?: string;
-    uploaderProps?: Omit<FileUploaderProps, 'uploadAPI' | 'abortSignal' | 'editor'>;
+    uploaderProps?: Omit<FileUploaderProps, 'uploadAPI' | 'editor'>;
     okLabel?: string;
     showOKButton?: boolean;
+    /** Reuse an existing hook instance instead of creating an uploader owned by this form. */
+    uploadAPI?: UseFileUploadReturnType;
 }
 export const FilesUploadFormDefaultProps: Partial<FilesUploadFormProps>;
 export function FilesUploadForm(props: FilesUploadFormProps): JSX.Element;
@@ -1233,8 +1259,9 @@ export interface ModalFileUploadProps {
     onClosed?: () => void;
     modalProps?: ModalSettings;
     modalTitle?: string;
-    filesUploadFormProps: Omit<FilesUploadFormProps, 'fileProcessColumn' | 'uploaderProps' | 'client' | 'onOK' | 'onCancel'>;
-    uploaderProps?: Omit<FileUploaderProps, 'uploadAPI' | 'abortSignal' | 'editor'>;
+    uploadAPI?: UseFileUploadReturnType;
+    filesUploadFormProps: Omit<FilesUploadFormProps, 'fileProcessColumn' | 'uploaderProps' | 'client' | 'onOK' | 'onCancel' | 'uploadAPI'>;
+    uploaderProps?: Omit<FileUploaderProps, 'uploadAPI' | 'editor'>;
 }
 export const UseFileUploadFormOpenDefaultProps: Partial<ModalFileUploadProps>;
 export function useFilesUploadForm(): (props: ModalFileUploadProps) => Promise<void>;