CHANGES.md

title	layout	section
Changelog	default	main

v3.10.1 2022-08-02

• Add sponsorship files.
  • If you appreciate the time spent maintaining JSZip then I would really appreciate your sponsorship.
• Consolidate metadata types and expose OnUpdateCallback #851 and #852
• use const instead var in example from README.markdown #828
• Switch manual download link to HTTPS #839

Internals:

• Replace jshint with eslint #842
• Add performance tests #834

v3.10.0 2022-05-20

• Change setimmediate dependency to more efficient one. Fixes #617 (see #829)
• Update types of currentFile metadata to include null (see #826)

v3.9.1 2022-04-06

• Fix recursive definition of InputFileFormat introduced in 3.9.0.

v3.9.0 2022-04-04

• Update types JSZip#loadAsync to accept a promise for data, and remove arguments from new JSZip() (see #752)
• Update types for compressionOptions to JSZipFileOptions and JSZipGeneratorOptions (see #722)
• Add types for generateInternalStream (see #774)

v3.8.0 2022-03-30

• Santize filenames when files are loaded with loadAsync, to avoid "zip slip" attacks. The original filename is available on each zip entry as unsafeOriginalName. See the documentation. Many thanks to McCaulay Hudson for reporting.

v3.7.1 2021-08-05

• Fix build of dist files.
  • Note: this version ensures the changes from 3.7.0 are actually included in the dist files. Thanks to Evan W for reporting.

v3.7.0 2021-07-23

• Fix: Use a null prototype object for this.files (see #766)
  • This change might break existing code if it uses prototype methods on the .files property of a zip object, for example zip.files.toString(). This approach is taken to prevent files in the zip overriding object methods that would exist on a normal object.

v3.6.0 2021-02-09

• Fix: redirect main to dist on browsers (see #742)
• Fix duplicate require DataLengthProbe, utils (see #734)
• Fix small error in read_zip.md (see #703)

v3.5.0 2020-05-31

• Fix 'End of data reached' error when file extra field is invalid (see #544).
• Typescript definitions: Add null to return types of functions that may return null (see #669).
• Typescript definitions: Correct nodeStream's type (see #682)
• Typescript definitions: Add string output type (see #666)

v3.4.0 2020-04-19

• Add Typescript type definitions (see #601).

v3.3.0 2020-04-1

• Change browser module resolution to support Angular packager (see #614).

v3.2.2 2019-07-04

• No public changes, but a number of testing dependencies have been updated.
• Tested browsers are now: Internet Explorer 11, Chrome (most recent) and Firefox (most recent). Other browsers (specifically Safari) are still supported however testing them on Saucelabs is broken and so they were removed from the test matrix.

v3.2.1 2019-03-22

• Corrected built dist files

v3.2.0 2019-02-21

• Update dependencies to reduce bundle size (see #532).
• Fix deprecated Buffer constructor usage and add safeguards (see #506).

v3.1.5 2017-11-09

• Fix IE11 memory leak (see #429).
• Handle 2 nodejs deprecations (see #459).
• Improve the "unsupported format" error message (see #461).
• Improve webworker compatibility (see #468).
• Fix nodejs 0.10 compatibility (see #480).
• Improve the error without type in async() (see #481).

v3.1.4 2017-08-24

• consistently use our own utils object for inheritance (see #395).
• lower the memory consumption in generate* with a lot of files (see #449).

v3.1.3 2016-10-06

• instanceof failing in window / iframe contexts (see #350).
• remove a copy with blob output (see #357).
• fix crc32 check for empty entries (see #358).
• fix the base64 error message with data uri (see #359).

v3.1.2 2016-08-23

• fix support of nodejs process.platform in generate* methods (see #335).
• improve browserify/webpack support (see #333).
• partial support of a promise of text (see #337).
• fix streamed zip files containing folders (see #342).

v3.1.1 2016-08-08

• Use a hard-coded JSZip.version, fix an issue with webpack (see #328).

v3.1.0 2016-08-03

• utils.delay: use macro tasks instead of micro tasks (see #288).
• Harden base64 decode (see #316).
• Add JSZip.version and the version in the header (see #317).
• Support Promise(Blob) (see #318).
• Change JSZip.external.Promise implementation (see #321).
• Update pako to v1.0.2 to fix a DEFLATE bug (see #322).

v3.0.0 2016-04-13

This release changes a lot of methods, please see the upgrade guide.

• replace sync getters and generate() with async methods (see #195).
• support nodejs streams (in file() and generateAsync()).
• support Blob and Promise in file() and loadAsync() (see #275).
• add support.nodestream.
• zip.filter: remove the defensive copy.
• remove the deprecated API (see #253).
• type is now mandatory in generateAsync().
• change the createFolders default value (now true).
• Dates: use UTC instead of the local timezone.
• Add base64 and array as possible output type.
• Add a forEach method.
• Drop node 0.8 support (see #270).

v2.6.1 2016-07-28

• update pako to v1.0.2 to fix a DEFLATE bug (see #322).

v2.6.0 2016-03-23

• publish dist/ files in the npm package (see #225).
• update pako to v1.0.0 (see #261).
• add support of Array in JSZip#load (see #252).
• improve file name / comment encoding support (see #211).
• handle prepended data (see #266).
• improve platform coverage in tests (see #233 and #269).

v2.5.0 2015-03-10

• add support for custom mime-types (see #199).
• add an option to set the DEFLATE level (see #201).
• improve the error message with corrupted zip (see #202).
• add support for UNIX / DOS permissions (see #200 and #205).

v2.4.0 2014-07-24

• update pako to 0.2.5 (see #156).
• make JSZip work in a Firefox addon context (see #151).
• add an option (createFolders) to control the subfolder generation (see #154).
• allow Buffer polyfill in the browser (see #139).

v2.3.0 2014-06-18

• don't generate subfolders (see #130).
• add comment support (see #134).
• on ZipObject#options, the attributes date and dir have been deprecated and are now on ZipObject (see the upgrade guide).
• on ZipObject#options, the attributes base64 and binary have been deprecated (see the upgrade guide).
• deprecate internal functions exposed in the public API (see #123).
• improve UTF-8 support (see #142).

v2.2.2, 2014-05-01

• update pako to v0.2.1, fix an error when decompressing some files (see #126).

v2.2.1, 2014-04-23

• fix unreadable generated file on Windows 8 (see #112).
• replace zlibjs with pako.

v2.2.0, 2014-02-25

• make the new operator optional before the JSZip constructor (see #93).
• update zlibjs to v0.2.0.

v2.1.1, 2014-02-13

• use the npm package for zlib.js instead of the github url.

v2.1.0, 2014-02-06

• split the files and use Browserify to generate the final file (see #74)
• packaging change : instead of 4 files (jszip.js, jszip-load.js, jszip-inflate.js, jszip-deflate.js) we now have 2 files : dist/jszip.js and dist/jszip.min.js
• add component/bower support
• rename variable: 'byte' is a reserved word (see #76)
• add support for the unicode path extra field (see #82)
• ensure that the generated files have a header with the licenses (see #80)

v2.0.0, 2013-10-20

• JSZipBase64 has been renamed to JSZip.base64.

• The data attribute on the object returned by zip.file(name) has been removed. Use asText(), asBinary(), asUint8Array(), asArrayBuffer() or asNodeBuffer().

• Fix issue with Android browser

• The compression/decompression methods now give their input type with the compressInputType and uncompressInputType attributes.

• Lazily decompress data when needed and improve performance in general

• Add support for Buffer in Node.js.

• Package for CommonJS/npm.

v1.0.1, 2013-03-04

• Fixed an issue when generating a compressed zip file with empty files or folders, see #33.
• With bad data (null or undefined), asText/asBinary/asUint8Array/asArrayBuffer methods now return an empty string, see #36.

v1.0.0, 2013-02-14

• First release after a long period without version.