react-native-compressor 1.7.1 → 1.8.0

package/README.md

@@ -17,9 +17,9 @@
 **REACT-NATIVE-COMPRESSOR** is a react-native package, which helps us to Compress `Image`, `Video`, and `Audio` before uploading, same like **Whatsapp** without knowing the compression `algorithm`
 
 <div align="center">
-<img height="90" src="/media/whatsapp_logo.png"/>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-<img height="90" src="/media/compress_media.png"/>
+<pre>
+<img height="90" src="/media/whatsapp_logo.png"/>               <img height="90" src="/media/compress_media.png"/>
+</pre>
 <h2 align="center">🗜️Compress Image, Video, and Audio same like Whatsapp</h2>
 </div>
 
@@ -53,9 +53,7 @@ We should use **react-native-compressor** instead of **FFmpeg** because **react-
 <summary>Open Table of Contents</summary>
 
 - [Installation](#installation)
-  - [For React Native](#react-native)
-    - [For React Native<0.65](#for-react-native065)
-    - [For React Native 0.65 or greater](#for-react-native-065-or-greater)
+  - [For React Native](#Installation)
   - [Managed Expo](#managed-expo)
 - [Usage](#usage)
   - [Image](#image)
@@ -69,6 +67,7 @@ We should use **react-native-compressor** instead of **FFmpeg** because **react-
     - [Video Api Docs](#video-1)
   - [Audio](#audio)
   - [Background Upload](#background-upload)
+  - [Download File](#download)
 
 * [Other Utilities](#api)
   - [Background Upload](#background-upload-1)
@@ -84,8 +83,8 @@ yarn add react-native-compressor
 ```
 
 ### [New Architecture (Turbo Module)](https://reactnative.dev/docs/new-architecture-intro) Supported
-you can give feedback on [Discord channel](https://discord.gg/dtYzk8sp)
 
+you can give feedback on [Discord channel](https://discord.gg/dtYzk8sp)
 
 ### Managed Expo
 
@@ -163,10 +162,11 @@ import { Image } from 'react-native-compressor';
 
 const result = await Image.compress('file://path_of_file/image.jpg');
 // OR
-const result = await Image.compress('https://path_of_file/image.jpg',{
+const result = await Image.compress('https://path_of_file/image.jpg', {
+  progressDivider: 10,
   downloadProgress: (progress) => {
     console.log('downloadProgress: ', progress);
-  }
+  },
 });
 ```
 
@@ -195,7 +195,7 @@ const result = await Video.compress(
   'file://path_of_file/BigBuckBunny.mp4',
   {},
   (progress) => {
-      console.log('Compression Progress: ', progress);
+    console.log('Compression Progress: ', progress);
   }
 );
 
@@ -204,12 +204,13 @@ const result = await Video.compress(
 const result = await Video.compress(
   'https://example.com/video.mp4',
   {
+    progressDivider: 10,
     downloadProgress: (progress) => {
       console.log('downloadProgress: ', progress);
-    }
+    },
   },
   (progress) => {
-      console.log('Compression Progress: ', progress);
+    console.log('Compression Progress: ', progress);
   }
 );
 ```
@@ -227,7 +228,7 @@ const result = await Video.compress(
     compressionMethod: 'manual',
   },
   (progress) => {
-      console.log('Compression Progress: ', progress);
+    console.log('Compression Progress: ', progress);
   }
 );
 ```
@@ -288,6 +289,16 @@ const uploadResult = await backgroundUpload(
 );
 ```
 
+### Download File
+
+```js
+import { download } from 'react-native-compressor';
+
+const downloadFileUrl = await download(url, (progress) => {
+  console.log('downloadProgress: ', progress);
+});
+```
+
 # API
 
 ## Image
@@ -305,8 +316,13 @@ const uploadResult = await backgroundUpload(
   if you want to compress images like **whatsapp** then make this prop `auto`. Can be either `manual` or `auto`, defines the Compression Method.
 
 - ##### `downloadProgress?: (progress: number) => void;`
+
   it is callback, only trigger when we pass image url from server
 
+- ##### `progressDivider?: number` (default: 0)
+
+  we uses it when we use downloadProgress
+
 - ###### `maxWidth: number` (default: 1280)
 
   The maximum width boundary used as the main boundary in resizing a landscape image.
@@ -344,13 +360,18 @@ const uploadResult = await backgroundUpload(
   if you want to compress videos like **whatsapp** then make this prop `auto`. Can be either `manual` or `auto`, defines the Compression Method.
 
 - ##### `downloadProgress?: (progress: number) => void;`
+
   it is callback, only trigger when we pass image url from server
 
+- ##### `progressDivider?: number` (default: 0)
+
+  we uses it when we use downloadProgress/onProgress
+
 - ###### `maxSize: number` (default: 640)
 
   The maximum size can be height in case of portrait video or can be width in case of landscape video.
 
-- ###### `bitrate: string`
+- ###### `bitrate: number`
 
   bitrate of video which reduce or increase video size. if compressionMethod will auto then this prop will not work
 
@@ -374,7 +395,7 @@ const uploadResult = await backgroundUpload(
 
 ## Background Upload
 
-- ###### `backgroundUpload: (url: string, fileUrl: string, options: FileSystemUploadOptions, onProgress?: ((writtem: number, total: number) => void) | undefined) => Promise<any>
+- ###### backgroundUpload: (url: string, fileUrl: string, options: FileSystemUploadOptions, onProgress?: ((writtem: number, total: number) => void) | undefined) => Promise< any >
 
 - ###### ` FileSystemUploadOptions`
 
@@ -396,6 +417,10 @@ type FileSystemUploadOptions = (
 };
 ```
 
+### Download
+
+- ##### download: ( fileUrl: string, downloadProgress?: (progress: number) => void, progressDivider?: number ) => Promise< string >
+
 ### Get Metadata Of Video
 
 if you want to get metadata of video than you can use this function

package/android/build.gradle

@@ -1,4 +1,7 @@
 buildscript {
+   // Buildscript is evaluated before everything else so we can't use getExtOrDefault
+  def kotlin_version = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : project.properties["Compressor_kotlinVersion"]
+  
   repositories {
     google()
     mavenCentral()
@@ -6,6 +9,8 @@ buildscript {
 
   dependencies {
     classpath "com.android.tools.build:gradle:7.2.1"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
   }
 }
 
@@ -14,6 +19,7 @@ def isNewArchitectureEnabled() {
 }
 
 apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
 
 
 def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
@@ -96,12 +102,14 @@ repositories {
   google()
 }
 
+def kotlin_version = getExtOrDefault("kotlinVersion")
 
 dependencies {
   // For < 0.71, this will be from the local maven repo
   // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
   //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native:+"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
   implementation 'io.github.lizhangqu:coreprogress:1.0.2'
   implementation 'com.github.numandev1:VideoCompressor:1a262bba37'
 }