@uppy/xhr-upload: migrate to TS

packages/@uppy/companion-client/src/RequestClient.ts

@@ -11,9 +11,6 @@ import getSocketHost from '@uppy/utils/lib/getSocketHost'
 
 import type Uppy from '@uppy/core'
 import type { UppyFile, Meta, Body } from '@uppy/utils/lib/UppyFile'
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore untyped because we're getting rid of it
-import type { RateLimitedQueue } from '@uppy/utils/lib/RateLimitedQueue'
 import AuthError from './AuthError.ts'
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore We don't want TS to generate types for the package.json
@@ -249,7 +246,7 @@ export default class RequestClient<M extends Meta, B extends Body> {
   async uploadRemoteFile(
     file: UppyFile<M, B>,
     reqBody: Record<string, unknown>,
-    options: { signal: AbortSignal; getQueue: () => RateLimitedQueue },
+    options: { signal: AbortSignal; getQueue: () => any },
   ): Promise<void> {
     try {
       const { signal, getQueue } = options || {}
@@ -376,7 +373,7 @@ export default class RequestClient<M extends Meta, B extends Body> {
     signal,
   }: {
     file: UppyFile<M, B>
-    queue: RateLimitedQueue
+    queue: any
     signal: AbortSignal
   }): Promise<void> {
     let removeEventHandlers: () => void

packages/@uppy/core/src/Uppy.ts

@@ -212,7 +212,9 @@ type ErrorCallback<M extends Meta, B extends Body> = (
 type UploadErrorCallback<M extends Meta, B extends Body> = (
   file: UppyFile<M, B> | undefined,
   error: { message: string; details?: string },
-  response?: UppyFile<M, B>['response'] | undefined,
+  response?:
+    | Omit<NonNullable<UppyFile<M, B>['response']>, 'uploadURL'>
+    | undefined,
 ) => void
 type UploadStalledCallback<M extends Meta, B extends Body> = (
   error: { message: string; details?: string },
@@ -1376,7 +1378,7 @@ export class Uppy<M extends Meta, B extends Body> {
     if (sizedFiles.length === 0) {
       const progressMax = inProgress.length * 100
       const currentProgress = unsizedFiles.reduce((acc, file) => {
-        return acc + file.progress.percentage
+        return acc + (file.progress.percentage as number)
       }, 0)
       const totalProgress = Math.round((currentProgress / progressMax) * 100)
       this.setState({ totalProgress })
@@ -1871,7 +1873,7 @@ export class Uppy<M extends Meta, B extends Body> {
   }
 
   /** @protected */
-  getRequestClientForFile(file: UppyFile<M, B>): unknown {
+  getRequestClientForFile<Client>(file: UppyFile<M, B>): Client {
     if (!file.remote)
       throw new Error(
         `Tried to get RequestClient for a non-remote file ${file.id}`,
@@ -1883,7 +1885,7 @@ export class Uppy<M extends Meta, B extends Body> {
       throw new Error(
         `requestClientId "${file.remote.requestClientId}" not registered for file "${file.id}"`,
       )
-    return requestClient
+    return requestClient as Client
   }
 
   /**

packages/@uppy/core/src/index.ts

@@ -1,5 +1,5 @@
 export { default } from './Uppy.ts'
-export { default as Uppy, type UppyEventMap } from './Uppy.ts'
+export { default as Uppy, type UppyEventMap, type State } from './Uppy.ts'
 export { default as UIPlugin } from './UIPlugin.ts'
 export { default as BasePlugin } from './BasePlugin.ts'
 export { debugLogger } from './loggers.ts'

packages/@uppy/utils/src/FileProgress.ts

@@ -14,8 +14,8 @@ export type FileProcessingInfo =
 
 interface FileProgressBase {
   progress?: number
-  uploadComplete: boolean
-  percentage: number
+  uploadComplete?: boolean
+  percentage?: number
   bytesTotal: number
   preprocess?: FileProcessingInfo
   postprocess?: FileProcessingInfo
@@ -26,7 +26,7 @@ interface FileProgressBase {
 export type FileProgressStarted = FileProgressBase & {
   uploadStarted: number
   bytesUploaded: number
-  progress: number
+  progress?: number
 }
 export type FileProgressNotStarted = FileProgressBase & {
   uploadStarted: null

packages/@uppy/utils/src/UppyFile.ts

@@ -37,6 +37,6 @@ export interface UppyFile<M extends Meta, B extends Body> {
     body: B
     status: number
     bytesUploaded?: number
-    uploadURL: string
+    uploadURL?: string
   }
 }

packages/@uppy/xhr-upload/src/index.test.js → packages/@uppy/xhr-upload/src/index.test.ts

@@ -1,7 +1,8 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { vi, describe, it, expect } from 'vitest'
 import nock from 'nock'
 import Core from '@uppy/core'
-import XHRUpload from './index.js'
+import XHRUpload from './index.ts'
 
 describe('XHRUpload', () => {
   describe('getResponseData', () => {
@@ -11,11 +12,14 @@ describe('XHRUpload', () => {
           'access-control-allow-method': 'POST',
           'access-control-allow-origin': '*',
         })
-        .options('/').reply(200, {})
-        .post('/').reply(200, {})
+        .options('/')
+        .reply(200, {})
+        .post('/')
+        .reply(200, {})
 
       const core = new Core()
-      const getResponseData = vi.fn(function getResponseData () {
+      const getResponseData = vi.fn(function getResponseData() {
+        // @ts-expect-error TS can't know the type
         expect(this.some).toEqual('option')
         return {}
       })
@@ -26,6 +30,8 @@ describe('XHRUpload', () => {
         getResponseData,
       })
       core.addFile({
+        type: 'image/png',
+        source: 'test',
         name: 'test.jpg',
         data: new Blob([new Uint8Array(8192)]),
       })
@@ -43,8 +49,10 @@ describe('XHRUpload', () => {
           'access-control-allow-method': 'POST',
           'access-control-allow-origin': '*',
         })
-        .options('/').reply(200, {})
-        .post('/').reply(200, {
+        .options('/')
+        .reply(200, {})
+        .post('/')
+        .reply(200, {
           code: 40000,
           message: 'custom upload error',
         })
@@ -59,19 +67,21 @@ describe('XHRUpload', () => {
         endpoint: 'https://fake-endpoint.uppy.io',
         some: 'option',
         validateStatus,
-        getResponseError (responseText) {
+        getResponseError(responseText) {
           return JSON.parse(responseText).message
         },
       })
       core.addFile({
+        type: 'image/png',
+        source: 'test',
         name: 'test.jpg',
         data: new Blob([new Uint8Array(8192)]),
       })
 
-      return core.upload().then(result => {
+      return core.upload().then((result) => {
         expect(validateStatus).toHaveBeenCalled()
-        expect(result.failed.length).toBeGreaterThan(0)
-        result.failed.forEach(file => {
+        expect(result!.failed!.length).toBeGreaterThan(0)
+        result!.failed!.forEach((file) => {
           expect(file.error).toEqual('custom upload error')
         })
       })
@@ -80,17 +90,13 @@ describe('XHRUpload', () => {
 
   describe('headers', () => {
     it('can be a function', async () => {
-      const scope = nock('https://fake-endpoint.uppy.io')
-        .defaultReplyHeaders({
-          'access-control-allow-method': 'POST',
-          'access-control-allow-origin': '*',
-          'access-control-allow-headers': 'x-sample-header',
-        })
-      scope.options('/')
-        .reply(200, {})
-      scope.post('/')
-        .matchHeader('x-sample-header', 'test.jpg')
-        .reply(200, {})
+      const scope = nock('https://fake-endpoint.uppy.io').defaultReplyHeaders({
+        'access-control-allow-method': 'POST',
+        'access-control-allow-origin': '*',
+        'access-control-allow-headers': 'x-sample-header',
+      })
+      scope.options('/').reply(200, {})
+      scope.post('/').matchHeader('x-sample-header', 'test.jpg').reply(200, {})
 
       const core = new Core()
       core.use(XHRUpload, {
@@ -101,6 +107,8 @@ describe('XHRUpload', () => {
         }),
       })
       core.addFile({
+        type: 'image/png',
+        source: 'test',
         name: 'test.jpg',
         data: new Blob([new Uint8Array(8192)]),
       })