@ammarahmed/react-native-upload 6.16.0

package/.circleci/config.yml

@@ -0,0 +1,15 @@
+version: 2.1
+orbs:
+  node: circleci/node@5.0.0
+jobs:
+  release:
+    executor: node/default
+    steps:
+      - checkout
+      - run: yarn install
+      - run: yarn release
+
+workflows:
+  perform_release:
+    jobs:
+      - release

package/.eslintignore

@@ -0,0 +1,2 @@
+example/RNBackgroundExample/node_modules
+example/RNBackgroundExample/e2e

package/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: '@react-native-community',
+};

package/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  bracketSpacing: true,
+  jsxBracketSameLine: true,
+  singleQuote: true,
+  trailingComma: 'all',
+};

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+Since Version > 5.3.0 we follow semantic versioning.
+
+See the [releases](https://github.com/Vydia/react-native-background-upload/releases) page on GitHub for information regarding each release.

package/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+## Issues
+
+Along with a bug report, provide a functional example repository which
+reproduces the bug you're experiencing. We've made this very easy by providing
+a full-stack (React Native + Express.js) example app, which you can fork and
+alter to reproduce your bug:
+
+[ReactNativeBackgroundUploadExample](https://github.com/Vydia/ReactNativeBackgroundUploadExample)

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vydia, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,391 @@
+# react-native-background-upload [![npm version](https://badge.fury.io/js/react-native-background-upload.svg)](https://badge.fury.io/js/react-native-background-upload) ![GitHub Actions status](https://github.com/Vydia/react-native-background-upload/workflows/Test%20iOS%20Example%20App/badge.svg) ![GitHub Actions status](https://github.com/Vydia/react-native-background-upload/workflows/Test%20Android%20Example%20App/badge.svg) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
+The only React Native http post file uploader with android and iOS background support.  If you are uploading large files like videos, use this so your users can background your app during a long upload.
+
+NOTE: Use major version 4 with RN 47.0 and greater.  If you have RN less than 47, use 3.0.  To view all available versions:
+`npm show react-native-background-upload versions`
+
+
+# Installation
+
+## 1. Install package
+
+`npm install --save react-native-background-upload`
+
+or
+
+`yarn add react-native-background-upload`
+
+Note: if you are installing on React Native < 0.47, use `react-native-background-upload@3.0.0` instead of `react-native-background-upload`
+
+## 2. Link Native Code
+
+### Autolinking (React Native >= 0.60)
+
+##### iOS
+
+`cd ./ios && pod install && cd ../`
+
+##### Android
+
+No further actions required.
+
+### Automatic Native Library Linking (React Native < 0.60)
+
+`react-native link react-native-background-upload`
+
+### Or, Manually Link It
+
+#### iOS
+
+1. In the XCode's "Project navigator", right click on your project's Libraries folder ➜ `Add Files to <...>`
+2. Go to `node_modules` ➜ `react-native-background-upload` ➜ `ios` ➜ select `VydiaRNFileUploader.xcodeproj`
+3. Add `VydiaRNFileUploader.a` to `Build Phases -> Link Binary With Libraries`
+
+#### Android
+1. Add the following lines to `android/settings.gradle`:
+
+    ```gradle
+    include ':react-native-background-upload'
+    project(':react-native-background-upload').projectDir = new File(settingsDir, '../node_modules/react-native-background-upload/android')
+    ```
+2. Add the compile and resolutionStrategy line to the dependencies in `android/app/build.gradle`:
+
+    ```gradle
+    configurations.all { resolutionStrategy.force 'com.squareup.okhttp3:okhttp:3.4.1' } // required by react-native-background-upload until React Native supports okhttp >= okhttp 3.5
+
+    dependencies {
+        compile project(':react-native-background-upload')
+    }
+    ```
+
+
+3. Add the import and link the package in `MainApplication.java`:
+
+    ```java
+    import com.vydia.RNUploader.UploaderReactPackage;  <-- add this import
+
+    public class MainApplication extends Application implements ReactApplication {
+        @Override
+        protected List<ReactPackage> getPackages() {
+            return Arrays.<ReactPackage>asList(
+                new MainReactPackage(),
+                new UploaderReactPackage() // <-- add this line
+            );
+        }
+    }
+    ```
+
+4. Ensure Android SDK versions.  Open your app's `android/app/build.gradle` file.  Ensure `compileSdkVersion` and `targetSdkVersion` are 25.  Otherwise you'll get compilation errors.
+
+## 3. Expo
+
+To use this library with [Expo](https://expo.io) one must first detach (eject) the project and follow [step 2](#2-link-native-code) instructions. Additionally on iOS there is a must to add a Header Search Path to other dependencies which are managed using Pods. To do so one has to add `$(SRCROOT)/../../../ios/Pods/Headers/Public` to Header Search Path in `VydiaRNFileUploader` module using XCode.
+
+# Usage
+
+```js
+import Upload from 'react-native-background-upload'
+
+const options = {
+  url: 'https://myservice.com/path/to/post',
+  path: 'file://path/to/file/on/device',
+  method: 'POST',
+  type: 'raw',
+  maxRetries: 2, // set retry count (Android only). Default 2
+  headers: {
+    'content-type': 'application/octet-stream', // Customize content-type
+    'my-custom-header': 's3headervalueorwhateveryouneed'
+  },
+  // Below are options only supported on Android
+  notification: {
+    enabled: true
+  },
+  useUtf8Charset: true
+}
+
+Upload.startUpload(options).then((uploadId) => {
+  console.log('Upload started')
+  Upload.addListener('progress', uploadId, (data) => {
+    console.log(`Progress: ${data.progress}%`)
+  })
+  Upload.addListener('error', uploadId, (data) => {
+    console.log(`Error: ${data.error}%`)
+  })
+  Upload.addListener('cancelled', uploadId, (data) => {
+    console.log(`Cancelled!`)
+  })
+  Upload.addListener('completed', uploadId, (data) => {
+    // data includes responseCode: number and responseBody: Object
+    console.log('Completed!')
+  })
+}).catch((err) => {
+  console.log('Upload error!', err)
+})
+```
+
+## Multipart Uploads
+
+Just set the `type` option to `multipart` and set the `field` option.  Example:
+
+```
+const options = {
+  url: 'https://myservice.com/path/to/post',
+  path: 'file://path/to/file%20on%20device.png',
+  method: 'POST',
+  field: 'uploaded_media',
+  type: 'multipart'
+}
+```
+
+Note the `field` property is required for multipart uploads.
+
+# API
+
+## Top Level Functions
+
+All top-level methods are available as named exports or methods on the default export.
+
+### startUpload(options)
+
+The primary method you will use, this starts the upload process.
+
+Returns a promise with the string ID of the upload.  Will reject if there is a connection problem, the file doesn't exist, or there is some other problem.
+
+`options` is an object with following values:
+
+*Note: You must provide valid URIs. react-native-background-upload does not escape the values you provide.*
+
+|Name|Type|Required|Default|Description|Example|
+|---|---|---|---|---|---|
+|`url`|string|Required||URL to upload to|`https://myservice.com/path/to/post`|
+|`path`|string|Required||File path on device|`file://something/coming/from%20the%20device.png`|
+|`type`|'raw' or 'multipart'|Optional|`raw`|Primary upload type.||
+|`method`|string|Optional|`POST`|HTTP method||
+|`customUploadId`|string|Optional||`startUpload` returns a Promise that includes the upload ID, which can be used for future status checks.  By default, the upload ID is automatically generated.  This parameter allows a custom ID to use instead of the default.||
+|`headers`|object|Optional||HTTP headers|`{ 'Accept': 'application/json' }`|
+|`field`|string|Required if `type: 'multipart'`||The form field name for the file.  Only used when `type: 'multipart`|`uploaded-file`|
+|`parameters`|object|Optional||Additional form fields to include in the HTTP request. Only used when `type: 'multipart`||
+|`notification`|Notification object (see below)|Optional||Android only.  |`{ enabled: true, onProgressTitle: "Uploading...", autoClear: true }`|
+|`useUtf8Charset`|boolean|Optional||Android only. Set to true to use `utf-8` as charset. ||
+|`appGroup`|string|Optional|iOS only. App group ID needed for share extensions to be able to properly call the library. See: https://developer.apple.com/documentation/foundation/nsfilemanager/1412643-containerurlforsecurityapplicati
+
+### Notification Object (Android Only)
+|Name|Type|Required|Description|Example|
+|---|---|---|---|---|
+|`enabled`|boolean|Optional|Enable or diasable notifications. Works only on Android version < 8.0 Oreo. On Android versions >= 8.0 Oreo is required by Google's policy to display a notification when a background service run|`{ enabled: true }`|
+|`autoClear`|boolean|Optional|Autoclear notification on complete|`{ autoclear: true }`|
+|`notificationChannel`|string|Optional|Sets android notificaion channel|`{ notificationChannel: "My-Upload-Service" }`|
+|`enableRingTone`|boolean|Optional|Sets whether or not to enable the notification sound when the upload gets completed with success or error|`{ enableRingTone: true }`|
+|`onProgressTitle`|string|Optional|Sets notification progress title|`{ onProgressTitle: "Uploading" }`|
+|`onProgressMessage`|string|Optional|Sets notification progress message|`{ onProgressMessage: "Uploading new video" }`|
+|`onCompleteTitle`|string|Optional|Sets notification complete title|`{ onCompleteTitle: "Upload finished" }`|
+|`onCompleteMessage`|string|Optional|Sets notification complete message|`{ onCompleteMessage: "Your video has been uploaded" }`|
+|`onErrorTitle`|string|Optional|Sets notification error title|`{ onErrorTitle: "Upload error" }`|
+|`onErrorMessage`|string|Optional|Sets notification error message|`{ onErrorMessage: "An error occured while uploading a video" }`|
+|`onCancelledTitle`|string|Optional|Sets notification cancelled title|`{ onCancelledTitle: "Upload cancelled" }`|
+|`onCancelledMessage`|string|Optional|Sets notification cancelled message|`{ onCancelledMessage: "Video upload was cancelled" }`|
+
+
+### getFileInfo(path)
+
+Returns some useful information about the file in question.  Useful if you want to set a MIME type header.
+
+`path` is a string, such as `file://path.to.the.file.png`
+
+Returns a Promise that resolves to an object containing:
+
+|Name|Type|Required|Description|Example|
+|---|---|---|---|---|
+|`name`|string|Required|The file name within its directory.|`image2.png`|
+|`exists`|boolean|Required|Is there a file matching this path?||
+|`size`|number|If `exists`|File size, in bytes||
+|`extension`|string|If `exists`|File extension|`mov`|
+|`mimeType`|string|If `exists`|The MIME type for the file.|`video/mp4`|
+
+### cancelUpload(uploadId)
+
+Cancels an upload.
+
+`uploadId` is the result of the Promise returned from `startUpload`
+
+Returns a Promise that resolves to an boolean indicating whether the upload was cancelled.
+
+### addListener(eventType, uploadId, listener)
+
+Adds an event listener, possibly confined to a single upload.
+
+`eventType` Event to listen for. Values: 'progress' | 'error' | 'completed' | 'cancelled'
+
+`uploadId` The upload ID from `startUpload` to filter events for.  If null, this will include all uploads.
+
+`listener` Function to call when the event occurs.
+
+Returns an [EventSubscription](https://github.com/facebook/react-native/blob/master/Libraries/vendor/emitter/EmitterSubscription.js). To remove the listener, call `remove()` on the `EventSubscription`.
+
+### shouldLimitNetwork(limit)
+
+`limit` boolean, sets whether or not to limit network usage.
+
+On Android, this setting takes effect immediately and will be applied for the next upload. On iOS, this setting will be only applied for the next NSURLSession.
+
+### getAllUploads()
+
+Retrieves all scheduled uploads and their state from system's internal database.
+
+Note that this will not give you all the uploads ever scheduled, both iOS and Android periodically prune completed(succeeded/failed/cancelled) tasks from their database. Therefore this should not be used as the primary way to check upload statuses, add your listeners via `addListener` instead. However, `getAllUploads` is particularly useful as a backup plan in case events were dropped(e.g. adding listeners too late).
+
+Returns a Promise that resolves to an array of objects containing:
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|`id`|string|Required|The upload ID from `startUpload`|
+|`state`|[UploadState](#uploadstate)|Required|The current state of the upload|
+
+## Events
+
+### progress
+
+Event Data
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|`id`|string|Required|The ID of the upload.|
+|`progress`|0-100|Required|Percentage completed.|
+
+### error
+
+Event Data
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|`id`|string|Required|The ID of the upload.|
+|`error`|string|Required|Error message.|
+
+### completed
+
+Event Data
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|`id`|string|Required|The ID of the upload.|
+|`responseCode`|string|Required|HTTP status code received|
+|`responseBody`|string|Required|HTTP response body|
+
+### cancelled
+
+Event Data
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|`id`|string|Required|The ID of the upload.|
+
+## Types
+
+### UploadState
+
+|Value|Description|
+|---|---|
+|`cancelled`|The upload has been cancelled, either by OS or by using `cancelUpload`|
+|`completed`|The upload has finished, either succeeded or failed|
+|`pending`|The upload is scheduled but not active at the moment|
+|`running`|The upload is in progress|
+
+# Customizing Android Build Properties
+You may want to customize the `compileSdk, buildToolsVersion, and targetSdkVersion` versions used by this package.  For that, add this to `android/build.gradle`:
+
+```
+ext {
+    targetSdkVersion = 23
+    compileSdkVersion = 23
+    buildToolsVersion = '23.0.2'
+}
+```
+
+Add it above `allProjects` and you're good.  Your `android/build.gradle` might then resemble:
+```
+buildscript {
+    repositories {
+        jcenter()
+    }
+}
+
+ext {
+    targetSdkVersion = 27
+    compileSdkVersion = 27
+    buildToolsVersion = '23.0.2'
+}
+
+allprojects {
+
+```
+
+# FAQs
+
+Is there an example/sandbox app to test out this package?
+
+> Yes, there is a simple react native app that comes with an [express](https://github.com/expressjs/express) server where you can see react-native-background-upload in action and try things out in an isolated local environment.
+
+[RNBackgroundExample](https://github.com/Vydia/react-native-background-upload/blob/master/example/RNBackgroundExample)
+
+Does it support iOS camera roll assets?
+
+> Yes, as of version 4.3.0.
+
+Does it support multiple file uploads?
+
+> Yes and No.  It supports multiple concurrent uploads, but only a single upload per request.  That should be fine for 90%+ of cases.
+
+Why should I use this file uploader instead of others that I've Googled like [react-native-uploader](https://github.com/aroth/react-native-uploader)?
+
+> This package has two killer features not found anywhere else (as of 12/16/2016).  First, it works on both iOS and Android.  Others are iOS only.  Second, it supports background uploading.  This means that users can background your app and the upload will continue.  This does not happen with other uploaders.
+
+
+# Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+# Common Issues
+
+## BREAKING CHANGE IN 3.0
+This is for 3.0 only.  This does NOT apply to 4.0, as recent React Native versions have upgraded the `okhttp` dependencies.  Anyway...
+
+In 3.0, you need to add
+```gradle
+    configurations.all { resolutionStrategy.force 'com.squareup.okhttp3:okhttp:3.4.1' }
+```
+to your app's app's `android/app/build.gradle` file.
+
+Just add it above (not within) `dependencies` and you'll be fine.
+
+
+## BREAKING CHANGE IN 2.0
+Two big things happened in version 2.0.  First, thehe Android package name had to be changed, as it conflicted with our own internal app.  My bad.  Second, we updated the android upload service dependency to the latest, but that requires the app have a compileSdkVersion and targetSdkVersion or 25.
+
+To upgrade:
+In `MainApplication.java`:
+
+Change
+
+    ```java
+    import com.vydia.UploaderReactPackage;
+    ```
+
+to
+
+    ```java
+    import com.vydia.RNUploader.UploaderReactPackage;
+    ```
+
+Then open your app's `android/app/build.gradle` file.
+Ensure `compileSdkVersion` and `targetSdkVersion` are 25.
+
+Done!
+
+
+## Gratitude
+
+Thanks to:
+- [android-upload-service](https://github.com/gotev/android-upload-service)  It made Android dead simple to support.
+
+- [MIME type from path on iOS](http://stackoverflow.com/questions/2439020/wheres-the-iphone-mime-type-database)  Thanks for the answer!

package/android/build.gradle

@@ -0,0 +1,82 @@
+buildscript {
+    ext {
+        agpVersion = '7.4.0'
+        kotlinVersion = '1.9.22'
+        buildToolsVersion = '34.0.0'
+        compileSdkVersion = 34
+        targetSdkVersion = 29
+        minSdkVersion = 18
+    }
+    ext.detoxKotlinVersion = ext.kotlinVersion
+
+    repositories {
+        mavenCentral()
+        google()
+    }
+    dependencies {
+        classpath "com.android.tools.build:gradle:$agpVersion"
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+def DEFAULT_COMPILE_SDK_VERSION = 31
+def DEFAULT_BUILD_TOOLS_VERSION = "30.0.2"
+def DEFAULT_TARGET_SDK_VERSION = 29
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+android {
+    namespace "com.appfolio.uploader"
+    compileSdkVersion safeExtGet('compileSdkVersion', DEFAULT_COMPILE_SDK_VERSION)
+    buildToolsVersion safeExtGet('buildToolsVersion', DEFAULT_BUILD_TOOLS_VERSION)
+
+    defaultConfig {
+        minSdkVersion 21
+        targetSdkVersion safeExtGet('targetSdkVersion', DEFAULT_TARGET_SDK_VERSION)
+        versionCode 1
+        versionName "1.0"
+        ndk {
+            abiFilters "armeabi-v7a", "x86"
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+}
+
+repositories {
+    mavenCentral()
+    google()
+}
+
+def _ext = ext
+
+def _kotlinVersion = _ext.has('detoxKotlinVersion') ? _ext.detoxKotlinVersion : '1.3.10'
+def _kotlinStdlib = _ext.has('detoxKotlinStdlib') ? _ext.detoxKotlinStdlib : 'kotlin-stdlib-jdk8'
+
+dependencies {
+    def work_version = "2.9.0"
+
+    implementation "androidx.work:work-runtime:$work_version"
+    implementation "androidx.work:work-runtime-ktx:$work_version"
+
+    implementation "androidx.core:core-ktx:1.12.0"
+
+    //noinspection GradleDynamicVersion
+    implementation 'com.facebook.react:react-native:+'
+
+    implementation "org.jetbrains.kotlin:$_kotlinStdlib:$_kotlinVersion"
+
+    //noinspection GradleDependency
+    implementation 'net.gotev:uploadservice:4.9.4'
+    //noinspection GradleDependency
+    implementation 'net.gotev:uploadservice-okhttp:4.9.4'
+
+    implementation 'androidx.swiperefreshlayout:swiperefreshlayout:1.1.0'
+    implementation 'com.google.code.gson:gson:2.10.1'
+}

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Tue Jan 23 14:51:27 PST 2024
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

package/android/gradle.properties

@@ -0,0 +1,6 @@
+# Project-wide Gradle settings.
+
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app's APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true