@uppy/tus - npm Package Compare versions

Comparing version 3.0.0-beta.3 to 3.0.0

CHANGELOG.md

 # @uppy/tus
 
+## 3.0.0
+
+Released: 2022-08-22
+Included in: Uppy v3.0.0
+
+- @uppy/aws-s3,@uppy/tus,@uppy/xhr-upload: @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: `metaFields` -> `allowedMetaFields` (Merlijn Vos / #4023)
+- @uppy/tus: avoid crashing when Tus client reports an error (Antoine du Hamel / #4019)
+- @uppy/tus: fix dependencies (Antoine du Hamel / #3923)
+- @uppy/tus: add file argument to `onBeforeRequest` (Merlijn Vos / #3984)
+
 ## 3.0.0-beta.2
@@ -4,0 +14,0 @@

lib/index.js

@@ -20,3 +20,3 @@ function _classPrivateFieldLooseBase(receiver, privateKey) { if (!Object.prototype.hasOwnProperty.call(receiver, privateKey)) { throw new TypeError("attempted to use private field on non-instance"); } return receiver; }
 const packageJson = {
-  "version": "3.0.0-beta.3"
+  "version": "3.0.0"
 };
@@ -127,2 +127,6 @@ /** @typedef {import('..').TusOptions} TusOptions */
 
+    if ((_opts == null ? void 0 : _opts.allowedMetaFields) === undefined && 'metaFields' in this.opts) {
+      throw new Error('The `metaFields` option has been renamed to `allowedMetaFields`.');
+    }
+
     if ('autoRetry' in _opts) {
@@ -272,3 +276,3 @@ throw new Error('The `autoRetry` option was deprecated and has been removed.');
         if (typeof opts.onBeforeRequest === 'function') {
-          userProvidedPromise = opts.onBeforeRequest(req);
+          userProvidedPromise = opts.onBeforeRequest(req, file);
         }
@@ -306,2 +310,4 @@
       uploadOptions.onError = err => {
+        var _queuedRequest;
+
         this.uppy.log(err);
@@ -316,3 +322,3 @@ const xhr = err.originalRequest ? err.originalRequest.getUnderlyingObject() : null;
         this.resetUploaderReferences(file.id);
-        queuedRequest.abort();
+        (_queuedRequest = queuedRequest) == null ? void 0 : _queuedRequest.abort();
         this.uppy.emit('upload-error', file, err);
@@ -421,5 +427,5 @@ reject(err);
       const meta = {};
-      const metaFields = Array.isArray(opts.metaFields) ? opts.metaFields // Send along all fields by default.
+      const allowedMetaFields = Array.isArray(opts.allowedMetaFields) ? opts.allowedMetaFields // Send along all fields by default.
       : Object.keys(file.meta);
-      metaFields.forEach(item => {
+      allowedMetaFields.forEach(item => {
         meta[item] = file.meta[item];
@@ -426,0 +432,0 @@ }); // tusd uses metadata fields 'filetype' and 'filename'

package.json

 {
   "name": "@uppy/tus",
   "description": "Resumable uploads for Uppy using Tus.io",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0",
   "license": "MIT",
@@ -26,10 +26,12 @@ "main": "lib/index.js",
   "dependencies": {
-    "@uppy/companion-client": "^3.0.0-beta.2",
-    "@uppy/utils": "^5.0.0-beta.1",
+    "@uppy/companion-client": "^3.0.0",
+    "@uppy/utils": "^5.0.0",
     "tus-js-client": "^3.0.0"
   },
+  "devDependencies": {
+    "@jest/globals": "^28.0.0"
+  },
   "peerDependencies": {
-    "@jest/globals": "^28.0.0",
-    "@uppy/core": "^3.0.0-beta.4"
+    "@uppy/core": "^3.0.0"
   }
 }

src/index.js

@@ -84,2 +84,6 @@ import BasePlugin from '@uppy/core/lib/BasePlugin.js'
 
+    if (opts?.allowedMetaFields === undefined && 'metaFields' in this.opts) {
+      throw new Error('The `metaFields` option has been renamed to `allowedMetaFields`.')
+    }
+
     if ('autoRetry' in opts) {
@@ -221,3 +225,3 @@ throw new Error('The `autoRetry` option was deprecated and has been removed.')
         if (typeof opts.onBeforeRequest === 'function') {
-          userProvidedPromise = opts.onBeforeRequest(req)
+          userProvidedPromise = opts.onBeforeRequest(req, file)
         }
@@ -261,3 +265,3 @@
         this.resetUploaderReferences(file.id)
-        queuedRequest.abort()
+        queuedRequest?.abort()
 
@@ -350,7 +354,7 @@ this.uppy.emit('upload-error', file, err)
       const meta = {}
-      const metaFields = Array.isArray(opts.metaFields)
-        ? opts.metaFields
+      const allowedMetaFields = Array.isArray(opts.allowedMetaFields)
+        ? opts.allowedMetaFields
         // Send along all fields by default.
         : Object.keys(file.meta)
-      metaFields.forEach((item) => {
+      allowedMetaFields.forEach((item) => {
         meta[item] = file.meta[item]
@@ -357,0 +361,0 @@ })

types/index.d.ts

@@ -1,3 +0,3 @@
-import type { PluginOptions, BasePlugin } from '@uppy/core'
-import type { UploadOptions } from 'tus-js-client'
+import type { PluginOptions, BasePlugin, UppyFile } from '@uppy/core'
+import type { UploadOptions, HttpRequest } from 'tus-js-client'
 
@@ -7,2 +7,3 @@ type TusUploadOptions = Pick<UploadOptions, Exclude<keyof UploadOptions,
   | 'metadata'
+  | 'onBeforeRequest'
   | 'onProgress'
@@ -20,3 +21,3 @@ | 'onChunkComplete'
 export interface TusOptions extends PluginOptions, TusUploadOptions {
-    metaFields?: string[] | null
+    allowedMetaFields?: string[] | null
     limit?: number
@@ -26,2 +27,3 @@ useFastRemoteRetry?: boolean
     onShouldRetry?: (err: Error | undefined, retryAttempt: number, options: TusOptions, next: Next) => boolean
+    onBeforeRequest?: (req: HttpRequest, file: UppyFile) => Promise<void>
   }
@@ -28,0 +30,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

115071

increased by1.31%

Dependency count

4

decreased by-20%

Lines of code

1514

increased by0.6%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

1

increased byInfinity%

Dependency changes

• - Removed@ampproject/remapping@2.3.0(transitive)

• - Removed@babel/code-frame@7.24.7(transitive)

• - Removed@babel/compat-data@7.25.4(transitive)

• - Removed@babel/core@7.25.2(transitive)

• - Removed@babel/generator@7.25.6(transitive)

• - Removed@babel/helper-compilation-targets@7.25.2(transitive)

• - Removed@babel/helper-module-imports@7.24.7(transitive)

• - Removed@babel/helper-module-transforms@7.25.2(transitive)

• - Removed@babel/helper-plugin-utils@7.24.8(transitive)

• - Removed@babel/helper-simple-access@7.24.7(transitive)

• - Removed@babel/helper-string-parser@7.24.8(transitive)

• - Removed@babel/helper-validator-identifier@7.24.7(transitive)

• - Removed@babel/helper-validator-option@7.24.8(transitive)

• - Removed@babel/helpers@7.25.6(transitive)

• - Removed@babel/highlight@7.24.7(transitive)

• - Removed@babel/parser@7.25.6(transitive)

• - Removed@babel/plugin-syntax-async-generators@7.8.4(transitive)

• - Removed@babel/plugin-syntax-bigint@7.8.3(transitive)

• - Removed@babel/plugin-syntax-class-properties@7.12.13(transitive)

• - Removed@babel/plugin-syntax-class-static-block@7.14.5(transitive)

• - Removed@babel/plugin-syntax-import-attributes@7.25.6(transitive)

• - Removed@babel/plugin-syntax-import-meta@7.10.4(transitive)

• - Removed@babel/plugin-syntax-json-strings@7.8.3(transitive)

• - Removed@babel/plugin-syntax-logical-assignment-operators@7.10.4(transitive)

• - Removed@babel/plugin-syntax-nullish-coalescing-operator@7.8.3(transitive)

• - Removed@babel/plugin-syntax-numeric-separator@7.10.4(transitive)

• - Removed@babel/plugin-syntax-object-rest-spread@7.8.3(transitive)

• - Removed@babel/plugin-syntax-optional-catch-binding@7.8.3(transitive)

• - Removed@babel/plugin-syntax-optional-chaining@7.8.3(transitive)

• - Removed@babel/plugin-syntax-private-property-in-object@7.14.5(transitive)

• - Removed@babel/plugin-syntax-top-level-await@7.14.5(transitive)

• - Removed@babel/plugin-syntax-typescript@7.25.4(transitive)

• - Removed@babel/template@7.25.0(transitive)

• - Removed@babel/traverse@7.25.6(transitive)

• - Removed@babel/types@7.25.6(transitive)

• - Removed@istanbuljs/load-nyc-config@1.1.0(transitive)

• - Removed@istanbuljs/schema@0.1.3(transitive)

• - Removed@jest/environment@28.1.3(transitive)

• - Removed@jest/expect@28.1.3(transitive)

• - Removed@jest/expect-utils@28.1.3(transitive)

• - Removed@jest/fake-timers@28.1.3(transitive)

• - Removed@jest/globals@28.1.3(transitive)

• - Removed@jest/schemas@28.1.3(transitive)

• - Removed@jest/transform@28.1.3(transitive)

• - Removed@jest/types@28.1.3(transitive)

• - Removed@jridgewell/gen-mapping@0.3.5(transitive)

• - Removed@jridgewell/resolve-uri@3.1.2(transitive)

• - Removed@jridgewell/set-array@1.2.1(transitive)

• - Removed@jridgewell/sourcemap-codec@1.5.0(transitive)

• - Removed@jridgewell/trace-mapping@0.3.25(transitive)

• - Removed@sinclair/typebox@0.24.51(transitive)

• - Removed@sinonjs/commons@1.8.6(transitive)

• - Removed@sinonjs/fake-timers@9.1.2(transitive)

• - Removed@types/babel__traverse@7.20.6(transitive)

• - Removed@types/graceful-fs@4.1.9(transitive)

• - Removed@types/istanbul-lib-coverage@2.0.6(transitive)

• - Removed@types/istanbul-lib-report@3.0.3(transitive)

• - Removed@types/istanbul-reports@3.0.4(transitive)

• - Removed@types/node@22.7.4(transitive)

• - Removed@types/prettier@2.7.3(transitive)

• - Removed@types/stack-utils@2.0.3(transitive)

• - Removed@types/yargs@17.0.33(transitive)

• - Removed@types/yargs-parser@21.0.3(transitive)

• - Removedansi-regex@5.0.1(transitive)

• - Removedansi-styles@3.2.14.3.05.2.0(transitive)

• - Removedanymatch@3.1.3(transitive)

• - Removedargparse@1.0.10(transitive)

• - Removedbabel-plugin-istanbul@6.1.1(transitive)

• - Removedbabel-preset-current-node-syntax@1.1.0(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedbraces@3.0.3(transitive)

• - Removedbrowserslist@4.24.0(transitive)

• - Removedbser@2.1.1(transitive)

• - Removedcamelcase@5.3.1(transitive)

• - Removedcaniuse-lite@1.0.30001664(transitive)

• - Removedchalk@2.4.24.1.2(transitive)

• - Removedci-info@3.9.0(transitive)

• - Removedcolor-convert@1.9.32.0.1(transitive)

• - Removedcolor-name@1.1.31.1.4(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedconvert-source-map@1.9.02.0.0(transitive)

• - Removeddebug@4.3.7(transitive)

• - Removeddiff-sequences@28.1.1(transitive)

• - Removedelectron-to-chromium@1.5.29(transitive)

• - Removedescalade@3.2.0(transitive)

• - Removedescape-string-regexp@1.0.52.0.0(transitive)

• - Removedesprima@4.0.1(transitive)

• - Removedexpect@28.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedfb-watchman@2.0.2(transitive)

• - Removedfill-range@7.1.1(transitive)

• - Removedfind-up@4.1.0(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedfsevents@2.3.3(transitive)

• - Removedgensync@1.0.0-beta.2(transitive)

• - Removedget-package-type@0.1.0(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedglobals@11.12.0(transitive)

• - Removedhas-flag@3.0.04.0.0(transitive)

• - Removedimurmurhash@0.1.4(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedis-number@7.0.0(transitive)

• - Removedistanbul-lib-coverage@3.2.2(transitive)

• - Removedistanbul-lib-instrument@5.2.1(transitive)

• - Removedjest-diff@28.1.3(transitive)

• - Removedjest-get-type@28.0.2(transitive)

• - Removedjest-haste-map@28.1.3(transitive)

• - Removedjest-matcher-utils@28.1.3(transitive)

• - Removedjest-message-util@28.1.3(transitive)

• - Removedjest-mock@28.1.3(transitive)

• - Removedjest-regex-util@28.0.2(transitive)

• - Removedjest-snapshot@28.1.3(transitive)

• - Removedjest-util@28.1.3(transitive)

• - Removedjest-worker@28.1.3(transitive)

• - Removedjs-tokens@4.0.0(transitive)

• - Removedjs-yaml@3.14.1(transitive)

• - Removedjsesc@2.5.2(transitive)

• - Removedjson5@2.2.3(transitive)

• - Removedlocate-path@5.0.0(transitive)

• - Removedlru-cache@5.1.1(transitive)

• - Removedmakeerror@1.0.12(transitive)

• - Removedmerge-stream@2.0.0(transitive)

• - Removedmicromatch@4.0.8(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removedms@2.1.3(transitive)

• - Removednatural-compare@1.4.0(transitive)

• - Removednode-int64@0.4.0(transitive)

• - Removednode-releases@2.0.18(transitive)

• - Removednormalize-path@3.0.0(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedp-limit@2.3.0(transitive)

• - Removedp-locate@4.1.0(transitive)

• - Removedp-try@2.2.0(transitive)

• - Removedpath-exists@4.0.0(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedpicocolors@1.1.0(transitive)

• - Removedpicomatch@2.3.1(transitive)

• - Removedpirates@4.0.6(transitive)

• - Removedpretty-format@28.1.3(transitive)

• - Removedreact-is@18.3.1(transitive)

• - Removedresolve-from@5.0.0(transitive)

• - Removedsemver@6.3.17.6.3(transitive)

• - Removedslash@3.0.0(transitive)

• - Removedsprintf-js@1.0.3(transitive)

• - Removedstack-utils@2.0.6(transitive)

• - Removedsupports-color@5.5.07.2.08.1.1(transitive)

• - Removedtest-exclude@6.0.0(transitive)

• - Removedtmpl@1.0.5(transitive)

• - Removedto-fast-properties@2.0.0(transitive)

• - Removedto-regex-range@5.0.1(transitive)

• - Removedtype-detect@4.0.8(transitive)

• - Removedundici-types@6.19.8(transitive)

• - Removedupdate-browserslist-db@1.1.1(transitive)

• - Removedwalker@1.0.8(transitive)

• - Removedwrappy@1.0.2(transitive)

• - Removedwrite-file-atomic@4.0.2(transitive)

• - Removedyallist@3.1.1(transitive)

• Updated@uppy/companion-client@^3.0.0

• Updated@uppy/utils@^5.0.0