Skip to content

CHANGELOG.md

Latest commit

 

History

History
143 lines (113 loc) · 6.97 KB

CHANGELOG.md

File metadata and controls

143 lines (113 loc) · 6.97 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

BREAKING

Added

Fixed

Changed

Removed

[7.0.1]

This is an npm only release to fix the bundling of the package (7.0.0 was not the production bundle but the dev bundle).

[7.0.0]

BREAKING

  • A file that encountered an error doesn't return 1 for its progress anymore. Instead it will return the progress at which it stopped uploading.
  • If a chunk encountered an error in the upload, it is now automatically retried in the final check.
    • Instead of reacting to chunkError or fileError events to manually retry such chunks, you should wait for the failed event.
    • The failed event indicates that Resumable couldn't upload some files, even in the final check. After that you might instruct the user to retry the upload or try to perform your own retries.

Added

  • Add debug request parameters (#51)
  • A failed event is now fired when Resumable is finished but some files couldn't be uploaded (#52)
  • Add chunkStuckTimeout option (#53)

Changed

  • Retry errored chunks in final check (#52)

[6.0.0]

BREAKING

When an upload is cancelled, the file list is now completely removed. This was always explained like this in the readme, but the code didn't do it. So this is technically a small bug fix, but for anyone who relied on the previous behavior, it's a breaking change.

Fixed

  • Fix cancellation of uploads (#48)

[5.0.0]

BREAKING

  • The option prioritizeFirstAndLastChunks was removed with #46
    • If you rely on this option, you unfortunately have to stay on an older version for now. We also are happy to get a PR that brings it back based on the current code architecture.

Fixed

  • Add undefined as a possible return type for function based on find (#45)

Changed

  • Make upload of many files more efficient and robust (#46)

Removed

  • Remove prioritizeFirstAndLastChunks option (#46)

[4.0.3]

  • Fix broken npm package release (no changes since v4.0.2)

[4.0.2]

Fixed

  • Fix file validation for duplicate files (#39)
  • Bump npm dependencies (#40)

[4.0.1]

Fixed

  • Fix setTimeout callback without proper context (#36)

[4.0.0]

BREAKING

Unique identifiers by default do not use the relative path anymore. This means that there is no support for files with the same name from different subfolders when dropping a folder directly.

Fixed

  • Unify generation of unique identifier for resumable files (#31)

[3.0.0]

BREAKING

  • (#25) Many class properties and some functions are private now and can't be accessed from the outside anymore. While these are technically breaking changes, there shouldn't have been any use cases for using those properties/functions. This does not affect any of the options you can provide to the Resumable constructor. Those did not change. All usable (not private) functions/properties are documented in the readme. The following class properties/functions are affected:
    • Resumable main class:
      • Properties that are not readable and not writable anymore: clearInput, dragOverClass, fileCategories, defaultFileCategory, fileTypes, fileTypeErrorCallback, _generateUniqueIdentifier, maxFileSize, maxFileSizeErrorCallback, maxFiles, maxFilesErrorCallback, minFileSize, minFileSizeErrorCallback, prioritizeFirstAndLastChunk, fileValidationErrorCallback, simultaneousUploads
      • Functions that can't be called from the outside anymore: checkUploadComplete()
    • ResumableFile class:
      • Properties that are not writable anymore, but can still be read: file, fileName, size, relativePath, uniqueIdentifier, fileCategory, chunks
      • Functions that can't be called from the outside anymore: bootstrap()
    • ResumableChunk class:
      • Properties that are not readable and not writable anymore: chunkNumberParameterName, chunkSizeParameterName, currentChunkSizeParameterName, totalSizeParameterName, typeParameterName, identifierParameterName, fileCategoryParameterName, fileNameParameterName, relativePathParameterName, totalChunksParameterName, throttleProgressCallbacks, query, headers, method, uploadMethod, testMethod, parameterNamespace, testChunks, maxChunkRetries, chunkRetryInterval, permanentErrors, withCredentials, xhrTimeout, chunkFormat, setChunkTypeFromFile, target, testTarget
      • Functions that can't be called from the outside anymore: setCustomHeaders(), test()

Added

  • Add optional verbose logging (#27)

Changed

  • Let all events from files and chunks bubble up and make them accessible for users (#20)
  • Update readme (#24)
  • Make class properties and some functions private and add getters for some of the properties (see breaking changes) (#25)

[2.1.0] - 2023-03-21

Added

  • Using the new setFileTypes function you can now set the allowed file types at runtime (#8)
  • Files that are added to the Resumable object are now always part of a file category (#11)
    • Resumable can still be used as before, without any extra handling of file categories. Internally the "default file category" will be used for all files then.
    • Some new construction options were added to support file categories (see docs for full explanation):
      • fileCategoryParameterName
      • fileCategories
      • defaultFileCategory
    • Many functions now support optionally passing in a file category (always defaulting to the "default file category")

Changed

  • Calling handleDropEvent does not remove the dragOverClass anymore from the event target (#10)
    • This does not affect the function of assignDrop and unassignDrop, they still handle the dragOverClass

Fixed

  • Documentation is now up-to-date again (see Readme)
  • Licensing texts has been updated to now include the participation of PCT (Point Cloud Technology) in this project

[2.0.0] - 2023-02-23

This is the first version after we (Point Cloud Technology) started to maintain and modify this project.

BREAKING

  • Removed member resumableObj from ResumableFile class (#1)
  • errorCount is not provided to a function passed as fileTypeErrorCallback anymore (#1)
  • Some events have been removed (but will be re-added with version 2.2.0, see PR #20) (#1)
  • No Internet Explorer support anymore (#2)

Added

  • File validators can now be added with the new addFileValidator function (#1)

Changed

  • Codebase is now split up into multiple files (instead of defining all classes in one big file) (#1)
  • Codebase now uses TypeScript instead of vanilla JavaScript (#1)

[1.2.0] - 2020-09-24

This was the last version before we (Point Cloud Technology) forked the original repo. This is the state of the main branch of the original repo before we added any of our changes. The original repo didn't include a CHANGELOG file.