@scaleflex/widget-tus 4.0.6 → 4.1.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 scaleflex
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 scaleflex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,29 +1,29 @@
-# @scaleflex/widget-tus
-
-[![Plugins][plugins-image]](#plugins)
-[![Website][filerobot-image]][sfx-url]
-[![Version][filerobot-version]][version-url]
-[![Scaleflex team][made-by-image]][sfx-url]
-[![License][license-image]][license-url]
-[![CodeSandbox][codeSandbox-image]][codeSandbox-url]
-
-
-<div align='center'>
-<img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" width="140"/>
-</div>
-
-<!-- Variables -->
-
-[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-tus
-[license-url]: https://opensource.org/licenses/MIT
-[sfx-url]: https://www.scaleflex.com/
-[version-url]: https://www.npmjs.com/package/@scaleflex/widget-tus
-[codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
-
-[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
-[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
-[made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
-[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
-[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
-[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-tus?label=Version&style=for-the-badge&logo=npm
-[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox
+# @scaleflex/widget-tus
+
+[![Plugins][plugins-image]](#plugins)
+[![Website][filerobot-image]][sfx-url]
+[![Version][filerobot-version]][version-url]
+[![Scaleflex team][made-by-image]][sfx-url]
+[![License][license-image]][license-url]
+[![CodeSandbox][codeSandbox-image]][codeSandbox-url]
+
+
+<div align='center'>
+<img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" width="140"/>
+</div>
+
+<!-- Variables -->
+
+[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-tus
+[license-url]: https://opensource.org/licenses/MIT
+[sfx-url]: https://www.scaleflex.com/
+[version-url]: https://www.npmjs.com/package/@scaleflex/widget-tus
+[codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
+
+[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
+[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
+[made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
+[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
+[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
+[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-tus?label=Version&style=for-the-badge&logo=npm
+[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox

package/lib/index.js

@@ -49,11 +49,11 @@ import getFingerprint from './getFingerprint';
 /** @typedef {import('@scaleflex/widget-core').FilerobotFile} FilerobotFile */
 /** @typedef {import('@scaleflex/widget-core').FailedFilerobotFile<{}>} FailedFilerobotFile */
 
-/**
- * Extracted from https://github.com/tus/tus-js-client/blob/master/lib/upload.js#L13
- * excepted we removed 'fingerprint' key to avoid adding more dependencies
- *
- * @type {RawTusOptions}
+/**
+ * Extracted from https://github.com/tus/tus-js-client/blob/master/lib/upload.js#L13
+ * excepted we removed 'fingerprint' key to avoid adding more dependencies
+ *
+ * @type {RawTusOptions}
  */
 var tusDefaultOptions = {
   endpoint: '',
@@ -76,15 +76,15 @@ var tusDefaultOptions = {
   uploadDataDuringCreation: false
 };
 
-/**
- * Tus resumable file filerobot
+/**
+ * Tus resumable file filerobot
  */
 var Tus = /*#__PURE__*/function (_Plugin) {
   // static VERSION = packageInfo.version
 
-  /**
-   * @param {Filerobot} filerobot
-   * @param {TusOptions} opts
+  /**
+   * @param {Filerobot} filerobot
+   * @param {TusOptions} opts
    */
   function Tus(filerobot) {
     var _this$opts$retryDelay;
@@ -263,10 +263,10 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       _this.opts.jsonEndpoint = "".concat(filerobot.opts.dev ? COMPANION_URLS.DEV : companionProdUrl, "/json");
     }
 
-    /**
-     * Simultaneous upload limiting is shared across all uploads with this plugin.
-     *
-     * @type {RateLimitedQueue}
+    /**
+     * Simultaneous upload limiting is shared across all uploads with this plugin.
+     *
+     * @type {RateLimitedQueue}
      */
     _this.requests = new RateLimitedQueue(_this.opts.limit);
     _this.retryDelayIterator = (_this$opts$retryDelay = _this.opts.retryDelays) === null || _this$opts$retryDelay === void 0 ? void 0 : _this$opts$retryDelay.values();
@@ -304,11 +304,11 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       this.i18n = this.translator.translate.bind(this.translator);
     }
 
-    /**
-     * Clean up all references for a file's upload: the tus.Upload instance,
-     * any events related to the file, and the Companion WebSocket connection.
-     *
-     * @param {string} fileId
+    /**
+     * Clean up all references for a file's upload: the tus.Upload instance,
+     * any events related to the file, and the Companion WebSocket connection.
+     *
+     * @param {string} fileId
      */
   }, {
     key: "resetFilerobotReferences",
@@ -334,40 +334,40 @@ var Tus = /*#__PURE__*/function (_Plugin) {
   }, {
     key: "upload",
     value:
-    /**
-     * Create a new Tus upload.
-     *
-     * A lot can happen during an upload, so this is quite hard to follow!
-     * - First, the upload is started. If the file was already paused by the time the upload starts, nothing should happen.
-     *   If the `limit` option is used, the upload must be queued onto the `this.requests` queue.
-     *   When an upload starts, we store the tus.Upload instance, and an EventTracker instance that manages the event listeners
-     *   for pausing, cancellation, removal, etc.
-     * - While the upload is in progress, it may be paused or cancelled.
-     *   Pausing aborts the underlying tus.Upload, and removes the upload from the `this.requests` queue. All other state is
-     *   maintained.
-     *   Cancelling removes the upload from the `this.requests` queue, and completely aborts the upload-- the `tus.Upload`
-     *   instance is aborted and discarded, the EventTracker instance is destroyed (removing all listeners).
-     *   Resuming the upload uses the `this.requests` queue as well, to prevent selectively pausing and resuming uploads from
-     *   bypassing the limit.
-     * - After completing an upload, the tus.Upload and EventTracker instances are cleaned up, and the upload is marked as done
-     *   in the `this.requests` queue.
-     * - When an upload completed with an error, the same happens as on successful completion, but the `upload()` promise is
-     *   rejected.
-     *
-     * When working on this function, keep in mind:
-     *  - When an upload is completed or cancelled for any reason, the tus.Upload and EventTracker instances need to be cleaned
-     *    up using this.resetFilerobotReferences().
-     *  - When an upload is cancelled or paused, for any reason, it needs to be removed from the `this.requests` queue using
-     *    `queuedRequest.abort()`.
-     *  - When an upload is completed for any reason, including errors, it needs to be marked as such using
-     *    `queuedRequest.done()`.
-     *  - When an upload is started or resumed, it needs to go through the `this.requests` queue. The `queuedRequest` variable
-     *    must be updated so the other uses of it are valid.
-     *  - Before replacing the `queuedRequest` variable, the previous `queuedRequest` must be aborted, else it will keep taking
-     *    up a spot in the queue.
-     *
-     * @param {FilerobotFile} file for use with upload
-     * @returns {Promise<void>}
+    /**
+     * Create a new Tus upload.
+     *
+     * A lot can happen during an upload, so this is quite hard to follow!
+     * - First, the upload is started. If the file was already paused by the time the upload starts, nothing should happen.
+     *   If the `limit` option is used, the upload must be queued onto the `this.requests` queue.
+     *   When an upload starts, we store the tus.Upload instance, and an EventTracker instance that manages the event listeners
+     *   for pausing, cancellation, removal, etc.
+     * - While the upload is in progress, it may be paused or cancelled.
+     *   Pausing aborts the underlying tus.Upload, and removes the upload from the `this.requests` queue. All other state is
+     *   maintained.
+     *   Cancelling removes the upload from the `this.requests` queue, and completely aborts the upload-- the `tus.Upload`
+     *   instance is aborted and discarded, the EventTracker instance is destroyed (removing all listeners).
+     *   Resuming the upload uses the `this.requests` queue as well, to prevent selectively pausing and resuming uploads from
+     *   bypassing the limit.
+     * - After completing an upload, the tus.Upload and EventTracker instances are cleaned up, and the upload is marked as done
+     *   in the `this.requests` queue.
+     * - When an upload completed with an error, the same happens as on successful completion, but the `upload()` promise is
+     *   rejected.
+     *
+     * When working on this function, keep in mind:
+     *  - When an upload is completed or cancelled for any reason, the tus.Upload and EventTracker instances need to be cleaned
+     *    up using this.resetFilerobotReferences().
+     *  - When an upload is cancelled or paused, for any reason, it needs to be removed from the `this.requests` queue using
+     *    `queuedRequest.abort()`.
+     *  - When an upload is completed for any reason, including errors, it needs to be marked as such using
+     *    `queuedRequest.done()`.
+     *  - When an upload is started or resumed, it needs to go through the `this.requests` queue. The `queuedRequest` variable
+     *    must be updated so the other uses of it are valid.
+     *  - Before replacing the `queuedRequest` variable, the previous `queuedRequest` must be aborted, else it will keep taking
+     *    up a spot in the queue.
+     *
+     * @param {FilerobotFile} file for use with upload
+     * @returns {Promise<void>}
      */
     function upload(file, uploadId) {
       var _this2 = this;
@@ -613,9 +613,9 @@ var Tus = /*#__PURE__*/function (_Plugin) {
     value:
     // NOTE! Keep this duplicated code in sync with other plugins
     // TODO we should probably abstract this into a common function
-    /**
-     * @param {FilerobotFile} file for use with upload
-     * @returns {Promise<void>}
+    /**
+     * @param {FilerobotFile} file for use with upload
+     * @returns {Promise<void>}
      */
     async function uploadRemote(file, uploadId) {
       this.resetFilerobotReferences(file.id);
@@ -646,13 +646,13 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       }
     }
 
-    /**
-     * See the comment on the upload() method.
-     *
-     * Additionally, when an upload is removed, completed, or cancelled, we need to close the WebSocket connection. This is
-     * handled by the resetFilerobotReferences() function, so the same guidelines apply as in upload().
-     *
-     * @param {FilerobotFile} file
+    /**
+     * See the comment on the upload() method.
+     *
+     * Additionally, when an upload is removed, completed, or cancelled, we need to close the WebSocket connection. This is
+     * handled by the resetFilerobotReferences() function, so the same guidelines apply as in upload().
+     *
+     * @param {FilerobotFile} file
      */
   }, {
     key: "connectToServerSocket",
@@ -787,12 +787,12 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       });
     }
 
-    /**
-     * Store the uploadUrl on the file options, so that when Golden Retriever
-     * restores state, we will continue uploading to the correct URL.
-     *
-     * @param {FilerobotFile} file
-     * @param {string} uploadURL
+    /**
+     * Store the uploadUrl on the file options, so that when Golden Retriever
+     * restores state, we will continue uploading to the correct URL.
+     *
+     * @param {FilerobotFile} file
+     * @param {string} uploadURL
      */
   }, {
     key: "onReceiveUploadUrl",
@@ -810,9 +810,9 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       }
     }
 
-    /**
-     * @param {string} fileId
-     * @param {function(string): void} cb
+    /**
+     * @param {string} fileId
+     * @param {function(string): void} cb
      */
   }, {
     key: "onFileRemove",
@@ -822,9 +822,9 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       });
     }
 
-    /**
-     * @param {string} fileId
-     * @param {function(boolean): void} cb
+    /**
+     * @param {string} fileId
+     * @param {function(boolean): void} cb
      */
   }, {
     key: "onPause",
@@ -836,9 +836,9 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       });
     }
 
-    /**
-     * @param {string} fileId
-     * @param {function(): void} cb
+    /**
+     * @param {string} fileId
+     * @param {function(): void} cb
      */
   }, {
     key: "onRetry",
@@ -850,9 +850,9 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       });
     }
 
-    /**
-     * @param {string} fileId
-     * @param {function(): void} cb
+    /**
+     * @param {string} fileId
+     * @param {function(): void} cb
      */
   }, {
     key: "onRetryAll",
@@ -864,9 +864,9 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       });
     }
 
-    /**
-     * @param {string} fileId
-     * @param {function(): void} cb
+    /**
+     * @param {string} fileId
+     * @param {function(): void} cb
      */
   }, {
     key: "onPauseAll",
@@ -878,9 +878,9 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       });
     }
 
-    /**
-     * @param {string} fileId
-     * @param {function(): void} cb
+    /**
+     * @param {string} fileId
+     * @param {function(): void} cb
      */
   }, {
     key: "onCancelAll",
@@ -892,9 +892,9 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       });
     }
 
-    /**
-     * @param {string} fileId
-     * @param {function(): void} cb
+    /**
+     * @param {string} fileId
+     * @param {function(): void} cb
      */
   }, {
     key: "onResumeAll",
@@ -906,8 +906,8 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       });
     }
 
-    /**
-     * @param {(FilerobotFile | FailedFilerobotFile)[]} files
+    /**
+     * @param {(FilerobotFile | FailedFilerobotFile)[]} files
      */
   }, {
     key: "uploadFiles",
@@ -939,8 +939,8 @@ var Tus = /*#__PURE__*/function (_Plugin) {
       return settle(promises);
     }
 
-    /**
-     * @param {string[]} fileIds
+    /**
+     * @param {string[]} fileIds
      */
   }, {
     key: "handleUpload",

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@scaleflex/widget-tus",
   "description": "Resumable uploads for Scaleflex using Tus.io",
-  "version": "4.0.6",
+  "version": "4.1.0",
   "license": "MIT",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
   "dependencies": {
-    "@scaleflex/widget-companion-client": "^4.0.6",
-    "@scaleflex/widget-utils": "^4.0.6",
+    "@scaleflex/widget-companion-client": "^4.1.0",
+    "@scaleflex/widget-utils": "^4.1.0",
     "tus-js-client": "^3.1.0"
   },
   "peerDependencies": {
@@ -21,5 +21,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "17ad9b9abc2add9c8b52ab56e3a72108bee20a7a"
+  "gitHead": "471120d67066617a0d8824eae11b07d1f2259473"
 }

package/types/index.d.ts

@@ -1,33 +1,33 @@
-import Filerobot = require("@scaleflex/widget-core");
-import { UploadOptions } from "tus-js-client";
-
-declare module Tus {
-  type TusUploadOptions = Pick<
-    UploadOptions,
-    Exclude<
-      keyof UploadOptions,
-      | "fingerprint"
-      | "metadata"
-      | "onProgress"
-      | "onChunkComplete"
-      | "onSuccess"
-      | "onError"
-      | "uploadUrl"
-      | "uploadSize"
-    >
-  >;
-
-  export interface TusOptions
-    extends Filerobot.PluginOptions,
-      TusUploadOptions {
-    autoRetry?: boolean;
-    resume?: boolean;
-    limit?: number;
-    retryDelays?: number[];
-    useFastRemoteRetry?: boolean;
-  }
-}
-
-declare class Tus extends Filerobot.Plugin<Tus.TusOptions> {}
-
-export = Tus;
+import Filerobot = require("@scaleflex/widget-core");
+import { UploadOptions } from "tus-js-client";
+
+declare module Tus {
+  type TusUploadOptions = Pick<
+    UploadOptions,
+    Exclude<
+      keyof UploadOptions,
+      | "fingerprint"
+      | "metadata"
+      | "onProgress"
+      | "onChunkComplete"
+      | "onSuccess"
+      | "onError"
+      | "uploadUrl"
+      | "uploadSize"
+    >
+  >;
+
+  export interface TusOptions
+    extends Filerobot.PluginOptions,
+      TusUploadOptions {
+    autoRetry?: boolean;
+    resume?: boolean;
+    limit?: number;
+    retryDelays?: number[];
+    useFastRemoteRetry?: boolean;
+  }
+}
+
+declare class Tus extends Filerobot.Plugin<Tus.TusOptions> {}
+
+export = Tus;