Support for Password-Protected ZIP in streamFileFromZip - unzipFile

README.md

@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/react-native-zip-stream.svg?style=flat-square)](https://www.npmjs.com/package/react-native-zip-stream)
 
-A React Native module for working with ZIP archives. This module allows you to list the contents of ZIP files, stream files from ZIP archives, create new ZIP files, and unzip files with progress tracking.
+A React Native module for working with ZIP archives. This module allows you to list the contents of ZIP files, stream files from ZIP archives, create new ZIP files. Now supports password-protected ZIPs.
 
 ## Table of Contents
 
@@ -13,7 +13,6 @@ A React Native module for working with ZIP archives. This module allows you to l
   - [Stream File from Zip](#stream-file-from-zip)
   - [Unzip File](#unzip-file)
   - [Create Zip File](#create-zip-file)
-  - [Unzip File with Progress](#unzip-file-with-progress)
 - [API Reference](#api-reference)
   - [listZipContents](#listzipcontents)
   - [streamFileFromZip](#streamfilefromzip)
@@ -74,11 +73,11 @@ Lists the contents of a ZIP file. This function returns an array of file names c
 
 ### Stream File from Zip
 
-Streams a specific file from a ZIP archive. You can retrieve the file data in one of three formats: `base64`, `arraybuffer`, or `string`.
+Streams a specific file from a ZIP archive. You can retrieve the file data in one of three formats: `base64`, `arraybuffer`, or `string`. Now supports password-protected ZIPs.
 
 ### Unzip File
 
-Extracts all the contents of a ZIP file to a specified destination directory.
+Extracts all the contents of a ZIP file to a specified destination directory. Now supports password-protected ZIPs.
 
 ### Create Zip File
 
@@ -93,38 +92,45 @@ Lists the contents of a ZIP file.
 #### Parameters
 
 - `zipFilePath`: `string` - The full path to the ZIP file.
+- `password`: `string` (optional) - The password for the ZIP file, if it is encrypted.
 
 #### Returns
 
 - `Promise<string[]>` - A promise that resolves to an array of file names inside the ZIP file.
 
 ### streamFileFromZip
 
-Streams a specific file from the ZIP archive.
+Streams a specific file from the ZIP archive, with optional password support.
 
 #### Parameters
 
 - `zipFilePath`: `string` - The full path to the ZIP file.
 - `entryName`: `string` - The name of the file within the ZIP archive to extract.
 - `type`: `string` (optional, default: `base64`) - The format in which to return the file data. Can be `base64`, `arraybuffer`, or `string`.
+- `password`: `string` (optional) - The password for the ZIP file, if it is encrypted.
 
 #### Returns
 
 - `Promise<string | ArrayBuffer | Uint8Array>` - A promise that resolves to the file content in the specified format.
 
+---
+
 ### unzipFile
 
-Extracts all the contents of a ZIP file to a specified destination directory.
+Extracts all the contents of a password-protected ZIP file to a specified destination directory.
 
 #### Parameters
 
 - `zipFilePath`: `string` - The full path to the ZIP file.
 - `destinationPath`: `string` - The path where the contents of the ZIP file should be extracted.
+- `password`: `string` (optional) - The password for the ZIP file, if it is encrypted.
 
 #### Returns
 
 - `Promise<boolean>` - A promise that resolves to `true` if the operation is successful.
 
+---
+
 ### createZipFile
 
 Creates a new ZIP file from the contents of a specified directory.
@@ -133,6 +139,7 @@ Creates a new ZIP file from the contents of a specified directory.
 
 - `destinationPath`: `string` - The full path where the ZIP file should be created.
 - `sourcePath`: `string` - The path to the directory or file that should be zipped.
+- `password`: `string` (optional) - The password for the ZIP file, if it is encrypted.
 
 #### Returns
 
@@ -157,34 +164,38 @@ const exampleListZipContents = async () => {
 };
 ```
 
-### Stream File from Zip Example
+### Stream File from Password-Protected Zip Example
 
 ```typescript
 import { streamFileFromZip } from 'react-native-zip-stream';
 
 const zipFilePath = '/path/to/your/zipfile.zip';
 const entryName = 'fileInsideZip.txt';
+const password = 'yourPassword';
 
 const exampleStreamFile = async () => {
   try {
     const base64Data = await streamFileFromZip(
       zipFilePath,
       entryName,
-      'base64'
+      'base64',
+      password
     );
     console.log('Base64 Data:', base64Data);
 
     const arrayBufferData = await streamFileFromZip(
       zipFilePath,
       entryName,
-      'arraybuffer'
+      'arraybuffer',
+      password
     );
     console.log('ArrayBuffer Data:', new Uint8Array(arrayBufferData));
 
     const stringData = await streamFileFromZip(
       zipFilePath,
       entryName,
-      'string'
+      'string',
+      password
     );
     console.log('String Data:', stringData);
   } catch (error) {
@@ -193,17 +204,18 @@ const exampleStreamFile = async () => {
 };
 ```
 
-### Unzip File Example
+### Unzip Password-Protected File Example
 
 ```typescript
 import { unzipFile } from 'react-native-zip-stream';
 
 const zipFilePath = '/path/to/your/zipfile.zip';
 const destinationPath = '/path/to/extract/';
+const password = 'yourPassword';
 
 const exampleUnzipFile = async () => {
   try {
-    const success = await unzipFile(zipFilePath, destinationPath);
+    const success = await unzipFile(zipFilePath, destinationPath, password);
     console.log('Unzip successful:', success);
   } catch (error) {
     console.error('Error unzipping file:', error);
@@ -218,10 +230,11 @@ import { createZipFile } from 'react-native-zip-stream';
 
 const sourcePath = '/path/to/source/folder';
 const destinationPath = '/path/to/output.zip';
+const password = 'yourPassword';
 
 const exampleCreateZipFile = async () => {
   try {
-    const success = await createZipFile(destinationPath, sourcePath);
+    const success = await createZipFile(destinationPath, sourcePath, password);
     console.log('Zip creation successful:', success);
   } catch (error) {
     console.error('Error creating zip file:', error);

android/build.gradle

@@ -95,5 +95,6 @@ dependencies {
   //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+  implementation 'net.lingala.zip4j:zip4j:2.9.0'
 }