@uppy/tus: migrate to TS

[Murderlon]

No description provided.

[github-actions]

Diff output files

diff --git a/packages/@uppy/tus/lib/getFingerprint.js b/packages/@uppy/tus/lib/getFingerprint.js
index fc6c75b..78133d6 100644
--- a/packages/@uppy/tus/lib/getFingerprint.js
+++ b/packages/@uppy/tus/lib/getFingerprint.js
@@ -8,12 +8,12 @@ function isReactNative() {
   return typeof navigator !== "undefined" && typeof navigator.product === "string"
     && navigator.product.toLowerCase() === "reactnative";
 }
-export default function getFingerprint(uppyFileObj) {
+export default function getFingerprint(uppyFile) {
   return (file, options) => {
     if (isCordova() || isReactNative()) {
       return tus.defaultOptions.fingerprint(file, options);
     }
-    const uppyFingerprint = ["tus", uppyFileObj.id, options.endpoint].join("-");
+    const uppyFingerprint = ["tus", uppyFile.id, options.endpoint].join("-");
     return Promise.resolve(uppyFingerprint);
   };
 }
diff --git a/packages/@uppy/tus/lib/index.js b/packages/@uppy/tus/lib/index.js
index 322ac3f..c20af75 100644
--- a/packages/@uppy/tus/lib/index.js
+++ b/packages/@uppy/tus/lib/index.js
@@ -9,7 +9,7 @@ function _classPrivateFieldLooseKey(name) {
   return "__private_" + id++ + "_" + name;
 }
 import BasePlugin from "@uppy/core/lib/BasePlugin.js";
-import EventManager from "@uppy/utils/lib/EventManager";
+import EventManager from "@uppy/core/lib/EventManager.js";
 import { filterFilesToEmitUploadStarted, filterNonFailedFiles } from "@uppy/utils/lib/fileFilters";
 import hasProperty from "@uppy/utils/lib/hasProperty";
 import isNetworkError from "@uppy/utils/lib/isNetworkError";
@@ -39,6 +39,11 @@ const tusDefaultOptions = {
   uploadLengthDeferred: false,
   uploadDataDuringCreation: false,
 };
+const defaultOptions = {
+  limit: 20,
+  retryDelays: tusDefaultOptions.retryDelays,
+  withCredentials: false,
+};
 var _retryDelayIterator = _classPrivateFieldLooseKey("retryDelayIterator");
 var _uploadLocalFile = _classPrivateFieldLooseKey("uploadLocalFile");
 var _getCompanionClientArgs = _classPrivateFieldLooseKey("getCompanionClientArgs");
@@ -47,7 +52,10 @@ var _handleUpload = _classPrivateFieldLooseKey("handleUpload");
 export default class Tus extends BasePlugin {
   constructor(uppy, _opts) {
     var _this$opts$rateLimite, _this$opts$retryDelay;
-    super(uppy, _opts);
+    super(uppy, {
+      ...defaultOptions,
+      ..._opts,
+    });
     Object.defineProperty(this, _uploadFiles, {
       value: _uploadFiles2,
     });
@@ -81,16 +89,6 @@ export default class Tus extends BasePlugin {
     });
     this.type = "uploader";
     this.id = this.opts.id || "Tus";
-    this.title = "Tus";
-    const defaultOptions = {
-      limit: 20,
-      retryDelays: tusDefaultOptions.retryDelays,
-      withCredentials: false,
-    };
-    this.opts = {
-      ...defaultOptions,
-      ..._opts,
-    };
     if ((_opts == null ? void 0 : _opts.allowedMetaFields) === undefined && "metaFields" in this.opts) {
       throw new Error("The `metaFields` option has been renamed to `allowedMetaFields`.");
     }
@@ -111,7 +109,11 @@ export default class Tus extends BasePlugin {
       ...this.uppy.getState().files,
     };
     Object.keys(files).forEach(fileID => {
-      if (files[fileID].tus && files[fileID].tus.uploadUrl) {
+      var _files$fileID;
+      if (
+        (_files$fileID = files[fileID]) != null && (_files$fileID = _files$fileID.tus) != null
+        && _files$fileID.uploadUrl
+      ) {
         const tusState = {
           ...files[fileID].tus,
         };
@@ -127,13 +129,10 @@ export default class Tus extends BasePlugin {
     });
   }
   resetUploaderReferences(fileID, opts) {
-    if (opts === void 0) {
-      opts = {};
-    }
     if (this.uploaders[fileID]) {
       const uploader = this.uploaders[fileID];
       uploader.abort();
-      if (opts.abort) {
+      if (opts != null && opts.abort) {
         uploader.abort(true);
       }
       this.uploaders[fileID] = null;
@@ -190,17 +189,22 @@ function _uploadLocalFile2(file) {
     if (typeof opts.headers === "function") {
       opts.headers = opts.headers(file);
     }
+    const {
+      onShouldRetry,
+      onBeforeRequest,
+      ...commonOpts
+    } = opts;
     const uploadOptions = {
       ...tusDefaultOptions,
-      ...opts,
+      ...commonOpts,
     };
     uploadOptions.fingerprint = getFingerprint(file);
-    uploadOptions.onBeforeRequest = req => {
+    uploadOptions.onBeforeRequest = async req => {
       const xhr = req.getUnderlyingObject();
       xhr.withCredentials = !!opts.withCredentials;
       let userProvidedPromise;
-      if (typeof opts.onBeforeRequest === "function") {
-        userProvidedPromise = opts.onBeforeRequest(req, file);
+      if (typeof onBeforeRequest === "function") {
+        userProvidedPromise = onBeforeRequest(req, file);
       }
       if (hasProperty(queuedRequest, "shouldBeRequeued")) {
         if (!queuedRequest.shouldBeRequeued) return Promise.reject();
@@ -215,14 +219,15 @@ function _uploadLocalFile2(file) {
           done();
           return () => {};
         });
-        return Promise.all([p, userProvidedPromise]);
+        await Promise.all([p, userProvidedPromise]);
+        return undefined;
       }
       return userProvidedPromise;
     };
     uploadOptions.onError = err => {
       var _queuedRequest;
       this.uppy.log(err);
-      const xhr = err.originalRequest ? err.originalRequest.getUnderlyingObject() : null;
+      const xhr = err.originalRequest != null ? err.originalRequest.getUnderlyingObject() : null;
       if (isNetworkError(xhr)) {
         err = new NetworkError(err, xhr);
       }
@@ -246,14 +251,20 @@ function _uploadLocalFile2(file) {
       });
     };
     uploadOptions.onSuccess = () => {
+      var _upload$url;
       const uploadResp = {
-        uploadURL: upload.url,
+        uploadURL: (_upload$url = upload.url) != null ? _upload$url : undefined,
+        status: 200,
+        body: {},
       };
       this.resetUploaderReferences(file.id);
       queuedRequest.done();
       this.uppy.emit("upload-success", file, uploadResp);
       if (upload.url) {
-        this.uppy.log(`Download ${upload.file.name} from ${upload.url}`);
+        const {
+          name,
+        } = upload.file;
+        this.uppy.log(`Download ${name} from ${upload.url}`);
       }
       if (typeof opts.onSuccess === "function") {
         opts.onSuccess();
@@ -278,7 +289,7 @@ function _uploadLocalFile2(file) {
           }
           this.requests.rateLimit(next.value);
         }
-      } else if (status > 400 && status < 500 && status !== 409 && status !== 423) {
+      } else if (status != null && status > 400 && status < 500 && status !== 409 && status !== 423) {
         return false;
       } else if (typeof navigator !== "undefined" && navigator.onLine === false) {
         if (!this.requests.isPaused) {
@@ -305,13 +316,9 @@ function _uploadLocalFile2(file) {
       };
       return true;
     };
-    if (opts.onShouldRetry != null) {
-      uploadOptions.onShouldRetry = function() {
-        for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-          args[_key] = arguments[_key];
-        }
-        return opts.onShouldRetry(...args, defaultOnShouldRetry);
-      };
+    if (onShouldRetry != null) {
+      uploadOptions.onShouldRetry = (error, retryAttempt) =>
+        onShouldRetry(error, retryAttempt, opts, defaultOnShouldRetry);
     } else {
       uploadOptions.onShouldRetry = defaultOnShouldRetry;
     }
@@ -323,7 +330,7 @@ function _uploadLocalFile2(file) {
     const meta = {};
     const allowedMetaFields = Array.isArray(opts.allowedMetaFields) ? opts.allowedMetaFields : Object.keys(file.meta);
     allowedMetaFields.forEach(item => {
-      meta[item] = file.meta[item];
+      meta[item] = String(file.meta[item]);
     });
     copyProp(meta, "type", "filetype");
     copyProp(meta, "name", "filename");
@@ -390,6 +397,7 @@ function _uploadLocalFile2(file) {
   });
 }
 function _getCompanionClientArgs2(file) {
+  var _file$remote;
   const opts = {
     ...this.opts,
   };
@@ -397,7 +405,7 @@ function _getCompanionClientArgs2(file) {
     Object.assign(opts, file.tus);
   }
   return {
-    ...file.remote.body,
+    ...((_file$remote = file.remote) == null ? void 0 : _file$remote.body),
     endpoint: opts.endpoint,
     uploadUrl: opts.uploadUrl,
     protocol: "tus",
@@ -410,9 +418,7 @@ async function _uploadFiles2(files) {
   const filesFiltered = filterNonFailedFiles(files);
   const filesToEmit = filterFilesToEmitUploadStarted(filesFiltered);
   this.uppy.emit("upload-start", filesToEmit);
-  await Promise.allSettled(filesFiltered.map((file, i) => {
-    const current = i + 1;
-    const total = files.length;
+  await Promise.allSettled(filesFiltered.map(file => {
     if (file.isRemote) {
       const getQueue = () => this.requests;
       const controller = new AbortController();
@@ -435,7 +441,7 @@ async function _uploadFiles2(files) {
       })();
       return uploadPromise;
     }
-    return _classPrivateFieldLooseBase(this, _uploadLocalFile)[_uploadLocalFile](file, current, total);
+    return _classPrivateFieldLooseBase(this, _uploadLocalFile)[_uploadLocalFile](file);
   }));
 }
 Tus.VERSION = packageJson.version;

[mifi]

created a suggestion here #4910

[mifi]

i wonder why this wasn't needed in #4910 and when running build:ts locally 🤔

[mifi]

this is strange... github actions is still failing but i'm not getting any ts errors locally with build:ts or in vscode

even when running

yarn build:clean
yarn build:lib
yarn build:ts

[Murderlon]

Yes it's odd but it makes sense, we were accessing opts.rateLimitedQueue and it wasn't typed. CI successful now.