@zip.js/zip.js 2.6.14 → 2.6.15

package/README.md

@@ -1,13 +1,74 @@
-zip.js is an open-source library (BSD-3-Clause license) to zip and unzip files
-supporting multi-core compression, compression streams, Zip64 and encryption.
+# Introduction
+
+zip.js is an open-source library (BSD-3-Clause license) implemented in
+JavaScript to compress and decompress zip files. It has been designed to handle
+large amounts of data and notably supports multi-core compression, compression
+streams, Zip64 and encryption.
+
+# Documentation
 
 See here for more info: https://gildas-lormeau.github.io/zip.js/
 
+# Examples
+
+## Hello world
+
 ```js
+import {
+  BlobReader,
+  BlobWriter,
+  TextReader,
+  TextWriter,
+  ZipReader,
+  ZipWriter,
+} from "https://deno.land/x/zipjs/index.js";
+
 // ----
-// Hello world with zip.js (and Streams)
+// Write the zip file
 // ----
 
+// Creates a BlobWriter object where the zip content will be written.
+const zipFileWriter = new BlobWriter();
+// Creates a TextReader object storing the text of the entry to add in the zip
+// (i.e. "Hello world!").
+const helloWorldReader = new TextReader("Hello world!");
+
+// Creates a ZipWriter object writing data via `zipFileWriter`, adds the entry
+// "hello.txt" containing the text "Hello world!" via `helloWorldReader`, and
+// closes the writer.
+const zipWriter = new ZipWriter(zipFileWriter);
+await zipWriter.add("hello.txt", helloWorldReader);
+await zipWriter.close();
+
+// Retrieves the Blob object containing the zip content into `zipFileBlob`. It
+// is also returned by zipWriter.close() for more convenience.
+const zipFileBlob = await zipFileWriter.getData();
+
+// ----
+// Read the zip file
+// ----
+
+// Creates a BlobReader object used to read `zipFileBlob`.
+const zipFileReader = new BlobReader(zipFileBlob);
+// Creates a TextWriter object where the content of the first entry in the zip
+// will be written.
+const helloWorldWriter = new TextWriter();
+
+// Creates a ZipReader object reading the zip content via `zipFileReader`,
+// retrieves metadata (name, dates, etc.) of the first entry, retrieves its
+// content via `helloWorldWriter`, and closes the reader.
+const zipReader = new ZipReader(zipFileReader);
+const firstEntry = (await zipReader.getEntries()).shift();
+const helloWorldText = await firstEntry.getData(helloWorldWriter);
+await zipReader.close();
+
+// Displays "Hello world!".
+console.log(helloWorldText);
+```
+
+## Hello world with Streams
+
+```js
 import {
   BlobReader,
   ZipReader,
@@ -30,8 +91,8 @@ const zipFileBlobPromise = new Response(zipFileWriter.readable).blob();
 const helloWorldReader = { readable: new Blob(["Hello world!"]).stream() };
 
 // Creates a ZipWriter object writing data via `zipFileWriter`, adds the entry
-// "hello.txt" containing the text "Hello world!" via `helloWorldReader` in the
-// zip, and closes the writer.
+// "hello.txt" containing the text "Hello world!" via `helloWorldReader`, and
+// closes the writer.
 const zipWriter = new ZipWriter(zipFileWriter);
 await zipWriter.add("hello.txt", helloWorldReader);
 await zipWriter.close();
@@ -39,14 +100,6 @@ await zipWriter.close();
 // Retrieves the Blob object containing the zip content into `zipFileBlob`.
 const zipFileBlob = await zipFileBlobPromise;
 
-// Uncomment the following code to download the zip file (in a browser)
-//
-// const anchorElement = document.createElement("a");
-// anchorElement.href = URL.createObjectURL(zipFileBlob);
-// anchorElement.download = "hello.zip";
-// anchorElement.click();
-//
-
 // ----
 // Read the zip file
 // ----

package/dist/zip-fs-full.js

@@ -8987,8 +8987,9 @@
 		let bufferedWrite;
 		let releaseLockWriter;
 		let releaseLockCurrentFileEntry;
-		let bufferedDataWritten;
+		let writingBufferedData;
 		let fileWriter;
+		let fileWriterSize;
 		files.set(name, fileEntry);
 		try {
 			let lockPreviousFileEntry;
@@ -9005,6 +9006,7 @@
 				await initStream(writer);
 				fileWriter = writer;
 			}
+			fileWriterSize = fileWriter.size;
 			fileEntry = await createFileEntry(reader, fileEntry, fileWriter.writable, zipWriter.config, options);
 			files.set(name, fileEntry);
 			fileEntry.filename = name;
@@ -9012,7 +9014,7 @@
 				let blob = fileWriter.getData();
 				await lockPreviousFileEntry;
 				await requestLockWriter();
-				bufferedDataWritten = true;
+				writingBufferedData = true;
 				const { writable } = writer;
 				if (!dataDescriptor) {
 					const headerLength = 26;
@@ -9032,7 +9034,7 @@
 					blob = blob.slice(headerLength);
 				}
 				await blob.stream().pipeTo(writable, { preventClose: true, signal });
-				bufferedDataWritten = false;
+				writingBufferedData = false;
 			}
 			fileEntry.offset = zipWriter.offset;
 			if (fileEntry.zip64) {
@@ -9044,9 +9046,12 @@
 			zipWriter.offset += fileEntry.length;
 			return fileEntry;
 		} catch (error) {
-			if ((bufferedWrite && bufferedDataWritten) || (!bufferedWrite && fileEntry.dataWritten)) {
-				error.corruptedEntry = zipWriter.hasCorruptedEntries = true;
-				zipWriter.offset += fileWriter.size;
+			if ((bufferedWrite && writingBufferedData) || (!bufferedWrite && fileEntry.writingData)) {
+				zipWriter.hasCorruptedEntries = true;
+				if (error) {
+					error.corruptedEntry = true;
+				}
+				zipWriter.offset += fileWriter.size - fileWriterSize;
 			}
 			files.delete(name);
 			throw error;
@@ -9223,10 +9228,10 @@
 		arraySet(localHeaderArray, rawExtraField, 30 + rawFilename.length + rawExtraFieldAES.length + rawExtraFieldExtendedTimestamp.length + rawExtraFieldNTFS.length);
 		let result;
 		let compressedSize = 0;
+		fileEntry.writingData = pendingFileEntry.writingData = true;
 		if (reader) {
 			reader.chunkSize = getChunkSize(config);
 			await writeData(writable, localHeaderArray);
-			fileEntry.dataWritten = pendingFileEntry.dataWritten = true;
 			const size = () => reader.size;
 			const readable = reader.readable;
 			readable.size = size;
@@ -9253,7 +9258,6 @@
 			compressedSize = result.size;
 		} else {
 			await writeData(writable, localHeaderArray);
-			fileEntry.dataWritten = pendingFileEntry.dataWritten = true;
 		}
 		let dataDescriptorArray = new Uint8Array();
 		let dataDescriptorView, dataDescriptorOffset = 0;
@@ -9306,7 +9310,8 @@
 			creationDate,
 			lastAccessDate,
 			encrypted,
-			length
+			length,
+			writingData: false
 		});
 		return fileEntry;
 	}