Properly transpile to ESM and CJS

lib/browser/httpStack.ts

@@ -1,6 +1,6 @@
 /* eslint-disable max-classes-per-file */
 
-import { HttpProgressHandler, HttpRequest, HttpResponse, HttpStack } from '../upload'
+import { HttpProgressHandler, HttpRequest, HttpResponse, HttpStack } from '../upload.js'
 
 export default class XHRHttpStack implements HttpStack<Blob> {
   createRequest(method, url) {

lib/browser/index.ts

@@ -2,10 +2,10 @@ import BaseUpload, {
   defaultOptions as baseDefaultOptions,
   terminate,
   UploadOptions,
-} from '../upload'
+} from '../upload.js'
 import NoopUrlStorage from '../noopUrlStorage.js'
-import { enableDebugLog } from '../logger'
-import DetailedError from '../error'
+import { enableDebugLog } from '../logger.js'
+import DetailedError from '../error.js'
 
 import { canStoreURLs, WebStorageUrlStorage } from './urlStorage.js'
 import DefaultHttpStack from './httpStack.js'

lib/browser/sources/StreamSource.ts

@@ -1,5 +1,5 @@
-import { FileSource } from '../../upload'
-import { FileSliceTypes } from '../index'
+import { FileSource } from '../../upload.js'
+import { FileSliceTypes } from '../index.js'
 
 function len(blobOrArray): number {
   if (blobOrArray === undefined) return 0

lib/browser/urlStorage.ts

@@ -1,4 +1,4 @@
-import { PreviousUpload, UrlStorage } from '../upload'
+import { PreviousUpload, UrlStorage } from '../upload.js'
 
 let hasStorage = false
 try {

lib/error.ts

@@ -1,4 +1,4 @@
-import { HttpRequest, HttpResponse } from './upload'
+import { HttpRequest, HttpResponse } from './upload.js'
 
 class DetailedError extends Error {
   originalRequest?: HttpRequest<unknown>

lib/node/fileReader.ts

@@ -1,11 +1,11 @@
 import { ReadStream } from 'fs'
 import isStream from 'is-stream'
 
-import { FileReader as IFileReader } from '../upload'
-import BufferSource from './sources/BufferSource'
-import getFileSource from './sources/FileSource'
-import StreamSource from './sources/StreamSource'
-import { FileSliceTypes, FileTypes } from './index'
+import { FileReader as IFileReader } from '../upload.js'
+import BufferSource from './sources/BufferSource.js'
+import getFileSource from './sources/FileSource.js'
+import StreamSource from './sources/StreamSource.js'
+import { FileSliceTypes, FileTypes } from './index.js'
 
 // TODO: Consider renaming this NodeFileReader
 export default class FileReader implements IFileReader<FileTypes, FileSliceTypes> {

lib/node/fileSignature.ts

@@ -1,8 +1,8 @@
 import * as fs from 'fs'
 import * as path from 'path'
 import { createHash } from 'crypto'
-import { UploadOptions } from '../upload'
-import { FileTypes, FileSliceTypes } from './index'
+import { UploadOptions } from '../upload.js'
+import { FileTypes, FileSliceTypes } from './index.js'
 
 /**
  * Generate a fingerprint for a file which will be used the store the endpoint

lib/node/httpStack.ts

@@ -6,8 +6,8 @@ import * as https from 'https'
 import { parse } from 'url'
 import { Readable, Transform } from 'stream'
 import throttle from 'lodash.throttle'
-import { HttpProgressHandler, HttpRequest, HttpResponse, HttpStack } from '../upload'
-import { FileSliceTypes } from './index'
+import { HttpProgressHandler, HttpRequest, HttpResponse, HttpStack } from '../upload.js'
+import { FileSliceTypes } from './index.js'
 
 export default class NodeHttpStack implements HttpStack<FileSliceTypes> {
   private _requestOptions: http.RequestOptions

lib/node/index.ts

@@ -4,16 +4,16 @@ import BaseUpload, {
   UploadOptions,
   defaultOptions as baseDefaultOptions,
   terminate,
-} from '../upload'
-import NoopUrlStorage from '../noopUrlStorage'
-import { enableDebugLog } from '../logger'
-import DetailedError from '../error'
+} from '../upload.js'
+import NoopUrlStorage from '../noopUrlStorage.js'
+import { enableDebugLog } from '../logger.js'
+import DetailedError from '../error.js'
 
-import { FileUrlStorage, canStoreURLs } from './urlStorage'
-import DefaultHttpStack from './httpStack'
-import FileReader from './fileReader'
-import fingerprint from './fileSignature'
-import StreamSource from './sources/StreamSource'
+import { FileUrlStorage, canStoreURLs } from './urlStorage.js'
+import DefaultHttpStack from './httpStack.js'
+import FileReader from './fileReader.js'
+import fingerprint from './fileSignature.js'
+import StreamSource from './sources/StreamSource.js'
 
 const defaultOptions = {
   ...baseDefaultOptions,

lib/node/sources/BufferSource.ts

@@ -1,4 +1,4 @@
-import { FileSource } from '../../upload'
+import { FileSource } from '../../upload.js'
 
 export default class BufferSource implements FileSource<Buffer> {
   size: number

lib/node/sources/FileSource.ts

@@ -1,5 +1,5 @@
 import { createReadStream, promises as fsPromises, ReadStream } from 'fs'
-import { FileSource as IFileSource } from '../../upload'
+import { FileSource as IFileSource } from '../../upload.js'
 
 export default async function getFileSource(stream: ReadStream): Promise<FileSource> {
   const path = stream.path.toString()

lib/node/sources/StreamSource.ts

@@ -1,5 +1,5 @@
 import { Readable } from 'stream'
-import { FileSource } from '../../upload'
+import { FileSource } from '../../upload.js'
 
 /**
  * readChunk reads a chunk with the given size from the given

lib/node/urlStorage.ts

@@ -2,7 +2,7 @@
 import { readFile, writeFile } from 'fs'
 import * as lockfile from 'proper-lockfile'
 import combineErrors from 'combine-errors'
-import { PreviousUpload, UrlStorage } from '../upload'
+import { PreviousUpload, UrlStorage } from '../upload.js'
 
 export const canStoreURLs = true
 

lib/noopUrlStorage.ts

@@ -1,6 +1,6 @@
 /* eslint no-unused-vars: "off" */
 
-import { UrlStorage } from './upload'
+import { UrlStorage } from './upload.js'
 
 export default class NoopUrlStorage implements UrlStorage {
   findAllUploads() {

lib/upload.ts

@@ -1,8 +1,8 @@
 import { Base64 } from 'js-base64'
 import URL from 'url-parse'
-import DetailedError from './error'
-import { log } from './logger'
-import uuid from './uuid'
+import DetailedError from './error.js'
+import { log } from './logger.js'
+import uuid from './uuid.js'
 
 const PROTOCOL_TUS_V1 = 'tus-v1'
 const PROTOCOL_IETF_DRAFT_03 = 'ietf-draft-03'

package.json

@@ -2,6 +2,7 @@
   "name": "tus-js-client",
   "version": "4.1.0",
   "description": "A pure JavaScript client for the tus resumable upload protocol",
+  "type": "module",
   "main": "lib.es5/node/index.js",
   "module": "lib.esm/node/index.js",
   "files": [
@@ -85,20 +86,20 @@
     "url-parse": "^1.5.7"
   },
   "scripts": {
-    "build-test-bundle": "mkdir -p dist && browserify test/spec/browser-index.js -d -o dist/browser-test-bundle.js",
+    "build-test-bundle": "mkdir -p dist && browserify test/spec/browser-index.cjs -d -o dist/browser-test-bundle.js",
     "build-bundle": "mkdir -p dist && browserify lib.es5/browser/index.js -s tus -d | exorcist ./dist/tus.js.map > dist/tus.js",
     "build-minify": "uglifyjs ./dist/tus.js -o ./dist/tus.min.js --compress --mangle --source-map \"content='./dist/tus.js.map',url='tus.min.js.map'\"",
-    "build-transpile-esm": "tsc --project tsconfig-esm.json",
-    "build-transpile-cjs": "tsc --project tsconfig-cjs.json",
+    "build-transpile-esm": "tsc --project tsconfig-esm.json && echo '{\"type\":\"commonjs\"}' > lib.es5/package.json",
+    "build-transpile-cjs": "tsc --project tsconfig-cjs.json && echo '{\"type\":\"module\"}' > lib.esm/package.json",
     "build-transpile": "npm-run-all build-transpile-esm build-transpile-cjs",
     "build": "npm-run-all build-transpile build-bundle build-minify build-test-bundle",
     "watch-bundle": "chokidar --initial \"lib/**/*\" -c \"npm run build-bundle\"",
     "watch-test-bundle": "chokidar --initial \"test/spec/**/*\" -c \"npm run build-test-bundle\"",
     "watch-transpile": "chokidar --initial \"lib/**/*\" -c \"npm run build-transpile\"",
     "watch": "npm-run-all --parallel watch-*",
-    "test-puppeteer": "karma start test/karma/puppeteer.conf.js",
-    "test-browserstack": "karma start test/karma/browserstack.conf.js",
-    "test-node": "jasmine test/spec/node-index.js",
+    "test-puppeteer": "karma start test/karma/puppeteer.conf.cjs",
+    "test-browserstack": "karma start test/karma/browserstack.conf.cjs",
+    "test-node": "jasmine test/spec/node-index.cjs",
     "test-types": "tsd",
     "lint": "eslint . --cache && yarn lint:formatting",
     "fix:formatting": "prettier --write .",

test/karma/browserstack.conf.js → test/karma/browserstack.conf.cjs

@@ -1,7 +1,7 @@
 'use strict'
 
 // Karma configuration for testing using BrowserStack
-const baseConfig = require('./base.conf')
+const baseConfig = require('./base.conf.cjs')
 
 // Pass ID from Github Actions to BrowserStack, so that individual
 // runs are grouped together.

test/karma/puppeteer.conf.js → test/karma/puppeteer.conf.cjs

@@ -1,7 +1,7 @@
 'use strict'
 
 // Karma configuration for testing using Puppeteer
-const baseConfig = require('./base.conf')
+const baseConfig = require('./base.conf.cjs')
 
 // Configure to use Puppeteer. See https://github.com/karma-runner/karma-chrome-launcher#available-browsers
 process.env.CHROME_BIN = require('puppeteer').executablePath()

test/spec/browser-index.cjs

@@ -0,0 +1,13 @@
+'use strict'
+
+beforeEach(() => {
+  // Clear localStorage before every test to prevent stored URLs to
+  // interfere with our setup.
+  localStorage.clear()
+})
+
+require('./test-common.cjs')
+require('./test-browser-specific.cjs')
+require('./test-parallel-uploads.cjs')
+require('./test-terminate.cjs')
+require('./test-end-to-end.cjs')

test/spec/node-index.cjs

@@ -0,0 +1,9 @@
+'use strict'
+
+// TODO: Move all tests to ESM as well
+
+require('./test-common.cjs')
+require('./test-node-specific.cjs')
+require('./test-parallel-uploads.cjs')
+require('./test-terminate.cjs')
+require('./test-end-to-end.cjs')

test/spec/test-browser-specific.js → test/spec/test-browser-specific.cjs

@@ -1,7 +1,7 @@
 'use strict'
 
-const assertUrlStorage = require('./helpers/assertUrlStorage')
-const { TestHttpStack, waitableFunction, wait } = require('./helpers/utils')
+const assertUrlStorage = require('./helpers/assertUrlStorage.cjs')
+const { TestHttpStack, waitableFunction, wait } = require('./helpers/utils.cjs')
 const tus = require('../..')
 
 describe('tus', () => {

test/spec/test-common.js → test/spec/test-common.cjs

@@ -1,6 +1,6 @@
 'use strict'
 
-const { TestHttpStack, waitableFunction, wait, getBlob } = require('./helpers/utils')
+const { TestHttpStack, waitableFunction, wait, getBlob } = require('./helpers/utils.cjs')
 const tus = require('../..')
 
 // Uncomment to enable debug log from tus-js-client

test/spec/test-end-to-end.js → test/spec/test-end-to-end.cjs

@@ -1,7 +1,7 @@
 'use strict'
 
 const axios = require('axios')
-const { getBlob } = require('./helpers/utils')
+const { getBlob } = require('./helpers/utils.cjs')
 const tus = require('../..')
 
 // Test timeout for end-to-end tests when uploading to real server.

test/spec/test-node-specific.js → test/spec/test-node-specific.cjs

@@ -9,8 +9,8 @@ const crypto = require('crypto')
 const intoStream = require('into-stream')
 const { once } = require('events')
 const tus = require('../..')
-const assertUrlStorage = require('./helpers/assertUrlStorage')
-const { TestHttpStack, waitableFunction } = require('./helpers/utils')
+const assertUrlStorage = require('./helpers/assertUrlStorage.cjs')
+const { TestHttpStack, waitableFunction } = require('./helpers/utils.cjs')
 
 describe('tus', () => {
   describe('#canStoreURLs', () => {

test/spec/test-parallel-uploads.js → test/spec/test-parallel-uploads.cjs

@@ -1,6 +1,6 @@
 'use strict'
 
-const { TestHttpStack, waitableFunction, wait, getBlob } = require('./helpers/utils')
+const { TestHttpStack, waitableFunction, wait, getBlob } = require('./helpers/utils.cjs')
 const tus = require('../..')
 
 describe('tus', () => {

test/spec/test-terminate.js → test/spec/test-terminate.cjs

@@ -1,6 +1,6 @@
 'use strict'
 
-const { TestHttpStack, getBlob } = require('./helpers/utils')
+const { TestHttpStack, getBlob } = require('./helpers/utils.cjs')
 const tus = require('../..')
 
 describe('tus', () => {

tsconfig-cjs.json

@@ -2,6 +2,7 @@
   "extends": "./tsconfig.json",
   "compilerOptions": {
     "module": "commonjs",
+    "moduleResolution": null,
     // TODO: Rename to lib.cjs
     "outDir": "lib.es5"
   }

tsconfig-esm.json

@@ -1,8 +1,6 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext",
     "outDir": "lib.esm/"
   }
 }

tsconfig.json

@@ -2,6 +2,8 @@
   "include": ["lib/**/*"],
   "compilerOptions": {
     "target": "ES2018",
+    "module": "Node16",
+    "moduleResolution": "Node16",
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "strict": true,