Mirrors/uppy
1
0
Fork 0
mirror of https://github.com/transloadit/uppy.git synced 2026-07-17 16:50:22 +00:00
Code Issues Projects Releases Wiki Activity

improve types

Browse source
This commit is contained in:
Prakash 2026-05-01 17:56:51 +05:30
parent 62d2ad6f1b
commit 5aa4ddb6ff
2 changed files with 38 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

32
packages/@uppy/dashboard/src/components/StatusBar/StatusBar.tsx
View file

@ -22,18 +22,24 @@ type StatusBarProps<M extends Meta, B extends Body> = {
}
/**
* Minimal shape of a Transloadit assembly status, read from
* `state.plugins.Transloadit.assemblyStatus`. Kept structural here so that
* `@uppy/dashboard` does not depend on `@uppy/transloadit`.
* Mirror of Transloadit's `AssemblyStatus['ok']` union (see `@transloadit/types`).
* Kept structural here so `@uppy/dashboard` does not depend on `@uppy/transloadit`.
*/
export type AssemblyStatus = { ok?: string }
export type AssemblyOk =
| 'ASSEMBLY_UPLOADING'
| 'ASSEMBLY_EXECUTING'
| 'ASSEMBLY_COMPLETED'
| 'ASSEMBLY_CANCELED'
| 'ASSEMBLY_EXPIRED'
| 'ASSEMBLY_REPLAYING'
| 'REQUEST_ABORTED'
export function getUploadingState(
error: unknown,
isAllComplete: boolean,
recoveredState: State<any, any>['recoveredState'],
files: Record<string, UppyFile<any, any>>,
assemblyStatus?: AssemblyStatus,
assemblyOk?: AssemblyOk,
): StatusBarUIProps<any, any>['uploadState'] {
if (error) {
return statusBarStates.STATE_ERROR
@ -58,10 +64,10 @@ export function getUploadingState(
// 'restore-confirmed' → uppy.restore(uploadId), which is the only path that
// re-invokes tus / Companion (Transloadit disables tus auto-resume via
// `storeFingerprintForResuming: false`).
if (assemblyStatus?.ok === 'ASSEMBLY_EXECUTING') {
if (assemblyOk === 'ASSEMBLY_EXECUTING') {
return statusBarStates.STATE_POSTPROCESSING
}
if (assemblyStatus?.ok === 'ASSEMBLY_UPLOADING') {
if (assemblyOk === 'ASSEMBLY_UPLOADING') {
const allUploadsComplete = Object.values(files).every(
(f) => f.progress.uploadStarted && f.progress.uploadComplete,
)
@ -243,13 +249,13 @@ export default class StatusBar<
error,
recoveredState,
} = state
// Read Transloadit's live assembly status (if installed) so a live assembly
// can outrank the recovery prompt — see issue #6017.
const assemblyStatus = (
// Read Transloadit's live assembly status `.ok` (if installed) so a live
// assembly can outrank the recovery prompt — see issue #6017.
const assemblyOk = (
state.plugins?.Transloadit as
| { assemblyStatus?: AssemblyStatus }
| { assemblyStatus?: { ok?: AssemblyOk } }
| undefined
)?.assemblyStatus
)?.assemblyStatus?.ok
const {
newFiles,
@ -300,7 +306,7 @@ export default class StatusBar<
isAllComplete,
recoveredState,
files || {},
assemblyStatus,
assemblyOk,
)}
allowNewUpload={allowNewUpload}
totalProgress={totalProgress}

30
packages/@uppy/status-bar/src/StatusBar.tsx
View file

@ -25,18 +25,26 @@ const speedFilterHalfLife = 2000
const ETAFilterHalfLife = 2000
/**
* Minimal shape of a Transloadit assembly status, read from
* `state.plugins.Transloadit.assemblyStatus` (set by `@uppy/transloadit`).
* Mirror of Transloadit's `AssemblyStatus['ok']` union (see `@transloadit/types`).
* Kept structural here so `@uppy/status-bar` does not depend on `@uppy/transloadit`.
* Errors leave `ok` absent on the server side, so this is the full set of
* non-error values the server can send.
*/
type AssemblyStatus = { ok?: string }
type AssemblyOk =
| 'ASSEMBLY_UPLOADING'
| 'ASSEMBLY_EXECUTING'
| 'ASSEMBLY_COMPLETED'
| 'ASSEMBLY_CANCELED'
| 'ASSEMBLY_EXPIRED'
| 'ASSEMBLY_REPLAYING'
| 'REQUEST_ABORTED'
export function getUploadingState(
error: unknown,
isAllComplete: boolean,
recoveredState: unknown,
files: Record<string, UppyFile<any, any>>,
assemblyStatus?: AssemblyStatus,
assemblyOk?: AssemblyOk,
): StatusBarUIProps<any, any>['uploadState'] {
if (error) {
return statusBarStates.STATE_ERROR
@ -61,10 +69,10 @@ export function getUploadingState(
// 'restore-confirmed' → uppy.restore(uploadId), which is the only path that
// re-invokes tus / Companion (Transloadit disables tus auto-resume via
// `storeFingerprintForResuming: false`).
if (assemblyStatus?.ok === 'ASSEMBLY_EXECUTING') {
if (assemblyOk === 'ASSEMBLY_EXECUTING') {
return statusBarStates.STATE_POSTPROCESSING
}
if (assemblyStatus?.ok === 'ASSEMBLY_UPLOADING') {
if (assemblyOk === 'ASSEMBLY_UPLOADING') {
const allUploadsComplete = Object.values(files).every(
(f) => f.progress.uploadStarted && f.progress.uploadComplete,
)
@ -254,13 +262,13 @@ export default class StatusBar<M extends Meta, B extends Body> extends UIPlugin<
})
// Transloadit's plugin state, if installed, exposes the live assembly
// status. Reading it here lets a non-terminal assembly outrank the
// status. Reading `.ok` here lets a non-terminal assembly outrank the
// "press Upload to resume" UI on restore — see issue #6017.
const assemblyStatus = (
const assemblyOk = (
state.plugins?.Transloadit as
| { assemblyStatus?: AssemblyStatus }
| { assemblyStatus?: { ok?: AssemblyOk } }
| undefined
)?.assemblyStatus
)?.assemblyStatus?.ok
return StatusBarUI({
error,
@ -269,7 +277,7 @@ export default class StatusBar<M extends Meta, B extends Body> extends UIPlugin<
isAllComplete,
recoveredState,
state.files || {},
assemblyStatus,
assemblyOk,
),
allowNewUpload,
totalProgress,