@kesha-antonov/react-native-background-downloader 2.6.8 → 2.7.0

package/README.md

@@ -1,8 +1,8 @@
 ![react-native-background-downloader banner](https://d1w2zhnqcy4l8f.cloudfront.net/content/falcon/production/projects/V5EEOX_fast/RNBD-190702083358.png)
 
-[![npm version](https://badge.fury.io/js/react-native-background-downloader.svg)](https://badge.fury.io/js/react-native-background-downloader)
+[![npm version](https://badge.fury.io/js/@kesha-antonov%2Freact-native-background-downloader.svg)](https://badge.fury.io/js/@kesha-antonov%2Freact-native-background-downloader)
 
-# react-native-background-downloader
+# @kesha-antonov/react-native-background-downloader
 ## *Note - This is fork of https://github.com/EkoLabs/react-native-background-downloader maintained by https://github.com/kesha-antonov * ##
 
 A library for React-Native to help you download large files on iOS and Android both in the foreground and most importantly in the background.
@@ -16,7 +16,7 @@ On Android we are simulating this process with a wonderful library called [Fetch
 
 The real challenge of using this method is making sure the app's UI is always up-to-date with the downloads that are happening in another process because your app might startup from scratch while the downloads are still running.
 
-`react-native-background-downloader` gives you an easy API to both downloading large files and re-attaching to those downloads once your app launches again.
+`@kesha-antonov/react-native-background-downloader` gives you an easy API to both downloading large files and re-attaching to those downloads once your app launches again.
 
 > **Please Note** - This library was created to better facilitate background downloading on iOS. If you're not aiming to to use the download-in-background functionality, there are better solutions like [RNFS.downloadFile()](https://github.com/itinance/react-native-fs#downloadfileoptions-downloadfileoptions--jobid-number-promise-promisedownloadresult-) which will results in a more stable download experience for your app.
 
@@ -29,7 +29,7 @@ The real challenge of using this method is making sure the app's UI is always up
 ## Getting started
 
 ```Terminal
-$ yarn add @kesha-antonov/react-native-background-downloader
+yarn add @kesha-antonov/react-native-background-downloader
 ```
 
 or
@@ -48,7 +48,7 @@ Any React Native version **`>= 0.60`** supports autolinking so nothing should be
 
 For anything **`< 0.60`** run the following link command
 
-`$ react-native link react-native-background-downloader`
+`$ react-native link @kesha-antonov/react-native-background-downloader`
 
 ### Manual installation
 
@@ -57,7 +57,7 @@ For anything **`< 0.60`** run the following link command
 #### iOS
 
 1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
-2. Go to `node_modules` ➜ `react-native-background-downloader` and add `RNBackgroundDownloader.xcodeproj`
+2. Go to `node_modules` ➜ `@kesha-antonov/react-native-background-downloader` and add `RNBackgroundDownloader.xcodeproj`
 3. In XCode, in the project navigator, select your project. Add `libRNBackgroundDownloader.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
 4. Run your project (`Cmd+R`)
 
@@ -69,7 +69,7 @@ For anything **`< 0.60`** run the following link command
 2. Append the following lines to `android/settings.gradle`:
   	```
   	include ':react-native-background-downloader'
-  	project(':react-native-background-downloader').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-background-downloader/android')
+  	project(':react-native-background-downloader').projectDir = new File(rootProject.projectDir, 	'../node_modules/@kesha-antonov/react-native-background-downloader/android')
   	```
 3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
   	```
@@ -100,7 +100,7 @@ Failing to add this code will result in canceled background downloads. If Xcode
 
 ```javascript
 import { Platform } from 'react-native'
-import { download, completeHandler } from 'react-native-background-downloader'
+import { download, completeHandler } from '@kesha-antonov/react-native-background-downloader'
 
 const jobId = 'file123'
 
@@ -144,7 +144,7 @@ What happens to your downloads after the OS stopped your app? Well, they are sti
 Add this code to app's init stage, and you'll never lose a download again!
 
 ```javascript
-import RNBackgroundDownloader from 'react-native-background-downloader'
+import RNBackgroundDownloader from '@kesha-antonov/react-native-background-downloader'
 
 let lostTasks = await RNBackgroundDownloader.checkForExistingDownloads()
 for (let task of lostTasks) {

package/index.d.ts

@@ -0,0 +1,118 @@
+// Type definitions for @kesha-antonov/react-native-background-downloader 2.6
+// Project: https://github.com/kesha-antonov/react-native-background-downloader
+// Definitions by: Philip Su <https://github.com/fivecar>,
+//                 Adam Hunter <https://github.com/adamrhunter>,
+//                 Junseong Park <https://github.com/Kweiza>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+export interface DownloadHeaders {
+  [key: string]: string | null;
+}
+
+type SetHeaders = (h: DownloadHeaders) => void;
+
+export interface TaskInfoObject {
+  id: string;
+  percent: number;
+  bytesWritten: number;
+  totalBytes: number;
+}
+export type TaskInfo = string | TaskInfoObject;
+
+export interface BeginHandlerObject {
+  expectedBytes: number;
+  headers: { [key: string]: string };
+}
+
+export type BeginHandler = ({
+  expectedBytes,
+  headers,
+}: BeginHandlerObject) => any;
+export type ProgressHandler = (
+  percent: number,
+  bytesWritten: number,
+  totalBytes: number
+) => any;
+export type DoneHandler = () => any;
+export type ErrorHandler = (error: any, errorCode: any) => any;
+export type DownloadTaskState =
+  | "DOWNLOADING"
+  | "PAUSED"
+  | "DONE"
+  | "FAILED"
+  | "STOPPED";
+
+export interface DownloadTask {
+  constructor: (taskInfo: TaskInfo) => DownloadTask;
+
+  id: string;
+  state: DownloadTaskState;
+  percent: number;
+  bytesWritten: number;
+  totalBytes: number;
+
+  begin: (handler: BeginHandler) => DownloadTask;
+  progress: (handler: ProgressHandler) => DownloadTask;
+  done: (handler: DoneHandler) => DownloadTask;
+  error: (handler: ErrorHandler) => DownloadTask;
+
+  _beginHandler: BeginHandler;
+  _progressHandler: ProgressHandler;
+  _doneHandler: DoneHandler;
+  _errorHandler: ErrorHandler;
+
+  pause: () => any;
+  resume: () => any;
+  stop: () => any;
+}
+
+export type CheckForExistingDownloads = () => Promise<DownloadTask[]>;
+export type EnsureDownloadsAreRunning = () => Promise<void>;
+
+export interface DownloadOption {
+  id: string;
+  url: string;
+  destination: string;
+  headers?: DownloadHeaders | undefined;
+}
+
+export type Download = (options: DownloadOption) => DownloadTask;
+export type CompleteHandler = (id: string) => void;
+
+export interface Directories {
+  documents: string;
+}
+
+export interface Network {
+  WIFI_ONLY: string;
+  ALL: string;
+}
+
+export interface Priority {
+  HIGH: string;
+  MEDIUM: string;
+  LOW: string;
+}
+
+export const setHeaders: SetHeaders;
+export const checkForExistingDownloads: CheckForExistingDownloads;
+export const ensureDownloadsAreRunning: EnsureDownloadsAreRunning;
+export const download: Download;
+export const completeHandler: CompleteHandler;
+export const directories: Directories;
+export const Network: Network;
+export const Priority: Priority;
+
+export interface RNBackgroundDownloader {
+  setHeaders: SetHeaders;
+  checkForExistingDownloads: CheckForExistingDownloads;
+  ensureDownloadsAreRunning: EnsureDownloadsAreRunning;
+  download: Download;
+  completeHandler: CompleteHandler;
+  directories: Directories;
+  Network: Network;
+  Priority: Priority;
+}
+
+declare const RNBackgroundDownloader: RNBackgroundDownloader;
+export default RNBackgroundDownloader;

package/lib/downloadTask.js

@@ -57,24 +57,24 @@ export default class DownloadTask {
 
   onBegin ({ expectedBytes, headers }) {
     this.state = 'DOWNLOADING'
-    this?.beginHandler({ expectedBytes, headers })
+    this.beginHandler?.({ expectedBytes, headers })
   }
 
   onProgress (percent, bytesWritten, totalBytes) {
     this.percent = percent
     this.bytesWritten = bytesWritten
     this.totalBytes = totalBytes
-    this?.progressHandler(percent, bytesWritten, totalBytes)
+    this.progressHandler?.(percent, bytesWritten, totalBytes)
   }
 
   onDone ({ location }) {
     this.state = 'DONE'
-    this?.doneHandler({ location })
+    this.doneHandler?.({ location })
   }
 
   onError (error, errorCode) {
     this.state = 'FAILED'
-    this?.errorHandler(error, errorCode)
+    this.errorHandler?.(error, errorCode)
   }
 
   pause () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kesha-antonov/react-native-background-downloader",
-  "version": "2.6.8",
+  "version": "2.7.0",
   "description": "A library for React-Native to help you download large files on iOS and Android both in the foreground and most importantly in the background.",
   "keywords": [
     "react-native",
@@ -25,11 +25,13 @@
     }
   ],
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
     "README.md",
     "LICENSE",
     "react-native-background-downloader.podspec",
     "package.json",
+    "index.d.ts",
     "index.js",
     "lib/",
     "ios/",