Update export structure, change bundler, move tests to ESM (#749)

* Put Cordova- and React Native-specific code into separate folders

* First attempt at using new `exports` structure in `package.json`

* Unify exported interface between browser and node variant

* Disable unused imports

* Rename files to better match their exported classes

* Add exports for node-specific APIs

* Turn node demo into ESM

* Move tests to ESM and build using rollup

Browserify does not support `exports` in `package.json`, so we replace it with Rollup. In addition, the tests are moved to ESM.

* Let bundle be generated by rollup as well

* Bundle TypeScript directly to use in sourcemaps

* Explicitly change case of NoopUrlStorage file

* Avoid resolving ESM types to CJS files

* Add fallback methods for bundler that don't support `exports`

* Add `publint` and `arethetypeswrong` as linters

Author: Acconut

.gitignore

@@ -6,3 +6,4 @@ lib.esm
 dist
 .DS_Store
 yarn-error.log
+tus-js-client-*.tgz

biome.json

@@ -28,7 +28,8 @@
       "correctness": {
         "noNewSymbol": "error",
         "noUndeclaredVariables": "error",
-        "noUnusedVariables": "error"
+        "noUnusedVariables": "error",
+        "noUnusedImports": "error"
       }
     }
   },

demos/nodejs/index.js

@@ -1,8 +1,8 @@
-const fs = require('fs')
-const tus = require('../..')
+import { createReadStream } from 'fs'
+import { Upload } from 'tus-js-client'
 
-const path = `${__dirname}/../../README.md`
-const file = fs.createReadStream(path)
+const path = `${import.meta.dirname}/../../README.md`
+const file = createReadStream(path)
 
 const options = {
   endpoint: 'https://tusd.tusdemo.net/files/',
@@ -24,5 +24,5 @@ const options = {
   },
 }
 
-const upload = new tus.Upload(file, options)
+const upload = new Upload(file, options)
 upload.start()

lib/error.ts renamed to lib/DetailedError.ts

@@ -1,5 +1,5 @@
-import { isReactNativeFile, isReactNativePlatform } from './isReactNative.js'
-import { uriToBlob } from './uriToBlob.js'
+import { isReactNativeFile, isReactNativePlatform } from '../reactnative/isReactNative.js'
+import { uriToBlob } from '../reactnative/uriToBlob.js'
 
 import type { FileReader, FileSource, UploadInput } from '../options.js'
 import { BlobFileSource } from './sources/BlobFileSource.js'

lib/noopUrlStorage.ts renamed to lib/NoopUrlStorage.ts

@@ -1,5 +1,5 @@
 import type { ReactNativeFile, UploadInput, UploadOptions } from '../options.js'
-import { isReactNativeFile, isReactNativePlatform } from './isReactNative.js'
+import { isReactNativeFile, isReactNativePlatform } from '../reactnative/isReactNative.js'
 
 /**
  * Generate a fingerprint for a file which will be used the store the endpoint

lib/browser/fileReader.ts renamed to lib/browser/BrowserFileReader.ts

@@ -1,12 +1,12 @@
-import { DetailedError } from '../error.js'
+import { DetailedError } from '../DetailedError.js'
+import { NoopUrlStorage } from '../NoopUrlStorage.js'
 import { enableDebugLog } from '../logger.js'
-import { NoopUrlStorage } from '../noopUrlStorage.js'
 import type { UploadInput, UploadOptions } from '../options.js'
 import { BaseUpload, defaultOptions as baseDefaultOptions, terminate } from '../upload.js'
 
-import { BrowserFileReader } from './fileReader.js'
+import { BrowserFileReader } from './BrowserFileReader.js'
+import { XHRHttpStack as DefaultHttpStack } from './XHRHttpStack.js'
 import { fingerprint } from './fileSignature.js'
-import { XHRHttpStack as DefaultHttpStack } from './httpStack.js'
 import { WebStorageUrlStorage, canStoreURLs } from './urlStorage.js'
 
 const defaultOptions = {
@@ -35,12 +35,6 @@ const isSupported =
   typeof Blob === 'function' &&
   typeof Blob.prototype.slice === 'function'
 
-export {
-  Upload,
-  canStoreURLs,
-  defaultOptions,
-  isSupported,
-  enableDebugLog,
-  DefaultHttpStack,
-  DetailedError,
-}
+// Note: The exported interface must be the same as in lib/node/index.ts.
+// Any changes should be reflected in both files.
+export { Upload, defaultOptions, isSupported, canStoreURLs, enableDebugLog, DetailedError }

lib/browser/httpStack.ts renamed to lib/browser/XHRHttpStack.ts

@@ -1,6 +1,6 @@
+import { isCordova } from '../../cordova/isCordova.js'
+import { readAsByteArray } from '../../cordova/readAsByteArray.js'
 import type { FileSource, SliceResult } from '../../options.js'
-import { isCordova } from './isCordova.js'
-import { readAsByteArray } from './readAsByteArray.js'
 
 export class BlobFileSource implements FileSource {
   _file: Blob