From 3dcd552f4aeb891fe6c184db5867a665ad1b38b5 Mon Sep 17 00:00:00 2001 From: Murderlon Date: Thu, 2 May 2024 15:32:19 +0200 Subject: [PATCH] @uppy/core: make UppyEventMap more readable --- packages/@uppy/core/src/Uppy.ts | 184 +++++++++++++------------------- 1 file changed, 73 insertions(+), 111 deletions(-) diff --git a/packages/@uppy/core/src/Uppy.ts b/packages/@uppy/core/src/Uppy.ts index 87c305a58..06af04cf7 100644 --- a/packages/@uppy/core/src/Uppy.ts +++ b/packages/@uppy/core/src/Uppy.ts @@ -226,123 +226,85 @@ export type NonNullableUppyOptions = Required< UppyOptions > -type GenericEventCallback = () => void -type FileAddedCallback = ( - file: UppyFile, -) => void -type FilesAddedCallback = ( - files: UppyFile[], -) => void -type FileRemovedCallback = ( - file: UppyFile, - reason?: FileRemoveReason, -) => void -type UploadCallback = (data: { id: string; fileIDs: string[] }) => void -type ProgressCallback = (progress: number) => void -type PreProcessProgressCallback = ( - file: UppyFile | undefined, - progress: NonNullable, -) => void -type PostProcessProgressCallback = ( - file: UppyFile | undefined, - progress: NonNullable, -) => void -type ProcessCompleteCallback = ( - file: UppyFile | undefined, - progress?: NonNullable, -) => void -type UploadPauseCallback = ( - fileID: UppyFile['id'] | undefined, - isPaused: boolean, -) => void -type UploadStartCallback = ( - files: UppyFile[], -) => void -type UploadStartedCallback = ( - file: UppyFile, -) => void -type UploadProgressCallback = ( - file: UppyFile | undefined, - progress: FileProgressStarted, -) => void -type UploadSuccessCallback = ( - file: UppyFile | undefined, - response: NonNullable['response']>, -) => void -type UploadCompleteCallback = ( - result: UploadResult, -) => void -type ErrorCallback = ( - error: { name: string; message: string; details?: string }, - file?: UppyFile, - response?: UppyFile['response'], -) => void -type UploadErrorCallback = ( - file: UppyFile | undefined, - error: { name: string; message: string; details?: string }, - response?: - | Omit['response']>, 'uploadURL'> - | undefined, -) => void -type UploadStalledCallback = ( - error: { message: string; details?: string }, - files: UppyFile[], -) => void -type UploadRetryCallback = (fileID: string) => void -type RetryAllCallback = (fileIDs: string[]) => void -type RestrictionFailedCallback = ( - file: UppyFile | undefined, - error: Error, -) => void -type StateUpdateCallback = ( - prevState: State, - nextState: State, - patch?: Partial>, -) => void -type CancelAllCallback = (reason: { reason?: FileRemoveReason }) => void -type PluginCallback = (plugin: UnknownPlugin) => void - export interface _UppyEventMap { - 'back-online': GenericEventCallback - 'cancel-all': CancelAllCallback - complete: UploadCompleteCallback - error: ErrorCallback - 'file-added': FileAddedCallback - 'file-removed': FileRemovedCallback - 'files-added': FilesAddedCallback - 'info-hidden': GenericEventCallback - 'info-visible': GenericEventCallback - 'is-offline': GenericEventCallback - 'is-online': GenericEventCallback - 'pause-all': GenericEventCallback - 'plugin-added': PluginCallback - 'plugin-remove': PluginCallback - 'postprocess-complete': ProcessCompleteCallback - 'postprocess-progress': PostProcessProgressCallback - 'preprocess-complete': ProcessCompleteCallback - 'preprocess-progress': PreProcessProgressCallback - progress: ProgressCallback - 'reset-progress': GenericEventCallback + 'back-online': () => void + 'cancel-all': (reason: { reason?: FileRemoveReason }) => void + complete: (result: UploadResult) => void + error: ( + error: { name: string; message: string; details?: string }, + file?: UppyFile, + response?: UppyFile['response'], + ) => void + 'file-added': (file: UppyFile) => void + 'file-removed': (file: UppyFile, reason?: FileRemoveReason) => void + 'files-added': (files: UppyFile[]) => void + 'info-hidden': () => void + 'info-visible': () => void + 'is-offline': () => void + 'is-online': () => void + 'pause-all': () => void + 'plugin-added': (plugin: UnknownPlugin) => void + 'plugin-remove': (plugin: UnknownPlugin) => void + 'postprocess-complete': ( + file: UppyFile | undefined, + progress?: NonNullable, + ) => void + 'postprocess-progress': ( + file: UppyFile | undefined, + progress: NonNullable, + ) => void + 'preprocess-complete': ( + file: UppyFile | undefined, + progress?: NonNullable, + ) => void + 'preprocess-progress': ( + file: UppyFile | undefined, + progress: NonNullable, + ) => void + progress: (progress: number) => void + 'reset-progress': () => void restored: (pluginData: any) => void - 'restore-confirmed': GenericEventCallback - 'restore-canceled': GenericEventCallback - 'restriction-failed': RestrictionFailedCallback - 'resume-all': GenericEventCallback - 'retry-all': RetryAllCallback - 'state-update': StateUpdateCallback - upload: UploadCallback - 'upload-error': UploadErrorCallback - 'upload-pause': UploadPauseCallback - 'upload-progress': UploadProgressCallback - 'upload-retry': UploadRetryCallback - 'upload-stalled': UploadStalledCallback - 'upload-success': UploadSuccessCallback + 'restore-confirmed': () => void + 'restore-canceled': () => void + 'restriction-failed': (file: UppyFile | undefined, error: Error) => void + 'resume-all': () => void + 'retry-all': (fileIDs: string[]) => void + 'state-update': ( + prevState: State, + nextState: State, + patch?: Partial>, + ) => void + upload: (data: { id: string; fileIDs: string[] }) => void + 'upload-error': ( + file: UppyFile | undefined, + error: { name: string; message: string; details?: string }, + response?: + | Omit['response']>, 'uploadURL'> + | undefined, + ) => void + 'upload-pause': ( + fileID: UppyFile['id'] | undefined, + isPaused: boolean, + ) => void + 'upload-progress': ( + file: UppyFile | undefined, + progress: FileProgressStarted, + ) => void + 'upload-retry': (fileID: string) => void + 'upload-stalled': ( + error: { message: string; details?: string }, + files: UppyFile[], + ) => void + 'upload-success': ( + file: UppyFile | undefined, + response: NonNullable['response']>, + ) => void } /** @deprecated */ export interface DeprecatedUppyEventMap { - 'upload-start': UploadStartCallback - 'upload-started': UploadStartedCallback + 'upload-start': (files: UppyFile[]) => void + 'upload-started': (file: UppyFile) => void } export interface UppyEventMap