@kesha-antonov/react-native-background-downloader 2.10.0 → 3.0.0-alpha.0

package/index.d.ts

@@ -16,8 +16,8 @@ export interface TaskInfoObject {
   metadata: object | string;
 
   percent?: number;
-  bytesWritten?: number;
-  totalBytes?: number;
+  bytesDownloaded?: number;
+  bytesTotal?: number;
 
   beginHandler?: Function;
   progressHandler?: Function;
@@ -37,8 +37,8 @@ export type BeginHandler = ({
 }: BeginHandlerObject) => any;
 export type ProgressHandler = (
   percent: number,
-  bytesWritten: number,
-  totalBytes: number
+  bytesDownloaded: number,
+  bytesTotal: number
 ) => any;
 export type DoneHandler = () => any;
 export type ErrorHandler = (error: any, errorCode: any) => any;
@@ -55,8 +55,8 @@ export interface DownloadTask {
   id: string;
   state: DownloadTaskState;
   percent: number;
-  bytesWritten: number;
-  totalBytes: number;
+  bytesDownloaded: number;
+  bytesTotal: number;
 
   begin: (handler: BeginHandler) => DownloadTask;
   progress: (handler: ProgressHandler) => DownloadTask;
@@ -77,7 +77,6 @@ export type CheckForExistingDownloads = () => Promise<DownloadTask[]>;
 export type EnsureDownloadsAreRunning = () => Promise<void>;
 
 export interface InitDownloaderOptions {
-  type?: 'parallel' | 'sequential' | null;
 }
 export type InitDownloader = (options: InitDownloaderOptions) => undefined;
 
@@ -87,6 +86,8 @@ export interface DownloadOption {
   destination: string;
   headers?: DownloadHeaders | undefined;
   metadata?: object;
+  isAllowedOverRoaming?: boolean;
+  isAllowedOverMetered?: boolean;
 }
 
 export type Download = (options: DownloadOption) => DownloadTask;
@@ -96,17 +97,6 @@ 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;
@@ -114,8 +104,6 @@ export const initDownloader: InitDownloader;
 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;
@@ -125,8 +113,6 @@ export interface RNBackgroundDownloader {
   download: Download;
   completeHandler: CompleteHandler;
   directories: Directories;
-  Network: Network;
-  Priority: Priority;
 }
 
 declare const RNBackgroundDownloader: RNBackgroundDownloader;

package/index.ts

@@ -7,14 +7,23 @@ const RNBackgroundDownloaderEmitter = new NativeEventEmitter(RNBackgroundDownloa
 const tasksMap = new Map()
 let headers = {}
 
+RNBackgroundDownloaderEmitter.addListener('downloadBegin', ({ id, expectedBytes, headers }) => {
+  console.log('[RNBackgroundDownloader] downloadBegin', id, expectedBytes, headers)
+  const task = tasksMap.get(id)
+  task?.onBegin({ expectedBytes, headers })
+})
+
 RNBackgroundDownloaderEmitter.addListener('downloadProgress', events => {
+  // console.log('[RNBackgroundDownloader] downloadProgress-1', events, tasksMap)
   for (const event of events) {
     const task = tasksMap.get(event.id)
-    task?.onProgress(event.percent, event.written, event.total)
+    // console.log('[RNBackgroundDownloader] downloadProgress-2', event.id, task)
+    task?.onProgress(event.percent, event.bytesDownloaded, event.bytesTotal)
   }
 })
 
 RNBackgroundDownloaderEmitter.addListener('downloadComplete', ({ id, location }) => {
+  console.log('[RNBackgroundDownloader] downloadComplete', id, location)
   const task = tasksMap.get(id)
   task?.onDone({ location })
 
@@ -22,35 +31,34 @@ RNBackgroundDownloaderEmitter.addListener('downloadComplete', ({ id, location })
 })
 
 RNBackgroundDownloaderEmitter.addListener('downloadFailed', event => {
+  console.log('[RNBackgroundDownloader] downloadFailed', event)
   const task = tasksMap.get(event.id)
-  task?.onError(event.error, event.errorcode)
+  task?.onError(event.error, event.errorCode)
 
   tasksMap.delete(event.id)
 })
 
-RNBackgroundDownloaderEmitter.addListener('downloadBegin', ({ id, expectedBytes, headers }) => {
-  const task = tasksMap.get(id)
-  task?.onBegin({ expectedBytes, headers })
-})
-
-export function setHeaders (h = {}) {
+export function setHeaders(h = {}) {
   if (typeof h !== 'object')
     throw new Error('[RNBackgroundDownloader] headers must be an object')
 
   headers = h
 }
 
-export function initDownloader (options = {}) {
+export function initDownloader(options = {}) {
   if (Platform.OS === 'android')
     RNBackgroundDownloader.initDownloader(options)
 }
 
-export function checkForExistingDownloads () {
+export function checkForExistingDownloads() {
+  console.log('[RNBackgroundDownloader] checkForExistingDownloads-1')
   return RNBackgroundDownloader.checkForExistingDownloads()
     .then(foundTasks => {
+      console.log('[RNBackgroundDownloader] checkForExistingDownloads-2', foundTasks)
       return foundTasks.map(taskInfo => {
         // SECOND ARGUMENT RE-ASSIGNS EVENT HANDLERS
         const task = new DownloadTask(taskInfo, tasksMap.get(taskInfo.id))
+        console.log('[RNBackgroundDownloader] checkForExistingDownloads-3', taskInfo)
 
         if (taskInfo.state === RNBackgroundDownloader.TaskRunning) {
           task.state = 'DOWNLOADING'
@@ -60,7 +68,7 @@ export function checkForExistingDownloads () {
           task.stop()
           return null
         } else if (taskInfo.state === RNBackgroundDownloader.TaskCompleted) {
-          if (taskInfo.bytesWritten === taskInfo.totalBytes)
+          if (taskInfo.bytesDownloaded === taskInfo.bytesTotal)
             task.state = 'DONE'
           else
             // IOS completed the download but it was not done.
@@ -68,11 +76,12 @@ export function checkForExistingDownloads () {
         }
         tasksMap.set(taskInfo.id, task)
         return task
-      }).filter(task => task !== null)
+      }).filter(task => !!task)
     })
 }
 
-export function ensureDownloadsAreRunning () {
+export function ensureDownloadsAreRunning() {
+  console.log('[RNBackgroundDownloader] ensureDownloadsAreRunning')
   return checkForExistingDownloads()
     .then(tasks => {
       for (const task of tasks)
@@ -83,7 +92,12 @@ export function ensureDownloadsAreRunning () {
     })
 }
 
-export function completeHandler (jobId) {
+export function completeHandler(jobId: string) {
+  if (jobId == null) {
+    console.warn('[RNBackgroundDownloader] completeHandler: jobId is empty')
+    return
+  }
+
   return RNBackgroundDownloader.completeHandler(jobId)
 }
 
@@ -93,9 +107,12 @@ type DownloadOptions = {
   destination: string,
   headers?: object,
   metadata?: object,
+  isAllowedOverRoaming?: boolean,
+  isAllowedOverMetered?: boolean,
 }
 
-export function download (options : DownloadOptions) {
+export function download(options: DownloadOptions) {
+  console.log('[RNBackgroundDownloader] download', options)
   if (!options.id || !options.url || !options.destination)
     throw new Error('[RNBackgroundDownloader] id, url and destination are required')
 
@@ -104,6 +121,11 @@ export function download (options : DownloadOptions) {
   if (!(options.metadata && typeof options.metadata === 'object'))
     options.metadata = {}
 
+  options.destination = options.destination.replace('file://', '')
+
+  if (options.isAllowedOverRoaming == null) options.isAllowedOverRoaming = true
+  if (options.isAllowedOverMetered == null) options.isAllowedOverMetered = true
+
   const task = new DownloadTask({
     id: options.id,
     metadata: options.metadata,
@@ -122,17 +144,6 @@ export const directories = {
   documents: RNBackgroundDownloader.documents,
 }
 
-export const Network = {
-  WIFI_ONLY: RNBackgroundDownloader.OnlyWifi,
-  ALL: RNBackgroundDownloader.AllNetworks,
-}
-
-export const Priority = {
-  HIGH: RNBackgroundDownloader.PriorityHigh,
-  MEDIUM: RNBackgroundDownloader.PriorityNormal,
-  LOW: RNBackgroundDownloader.PriorityLow,
-}
-
 export default {
   initDownloader,
   download,
@@ -141,6 +152,4 @@ export default {
   completeHandler,
   setHeaders,
   directories,
-  Network,
-  Priority,
 }

package/ios/RNBackgroundDownloader.h

@@ -19,6 +19,6 @@ typedef void (^CompletionHandler)();
 
 @interface RNBackgroundDownloader : RCTEventEmitter <RCTBridgeModule, NSURLSessionDelegate, NSURLSessionDownloadDelegate>
 
-+ (void)setCompletionHandlerWithIdentifier: (NSString *)identifier completionHandler: (CompletionHandler)completionHandler;
++ (void)setCompletionHandlerWithIdentifier:(NSString *)identifier completionHandler:(CompletionHandler)completionHandler;
 
 @end

package/ios/RNBackgroundDownloader.m

@@ -62,7 +62,7 @@ RCT_EXPORT_MODULE();
             taskToConfigMap = [[NSMutableDictionary alloc] init];
         }
         idToTaskMap = [[NSMutableDictionary alloc] init];
-        idToResumeDataMap= [[NSMutableDictionary alloc] init];
+        idToResumeDataMap = [[NSMutableDictionary alloc] init];
         idToPercentMap = [[NSMutableDictionary alloc] init];
         NSString *bundleIdentifier = [[NSBundle mainBundle] bundleIdentifier];
         NSString *sessonIdentifier = [bundleIdentifier stringByAppendingString:@".backgrounddownloadtask"];
@@ -286,8 +286,8 @@ RCT_EXPORT_METHOD(checkForExistingDownloads: (RCTPromiseResolveBlock)resolve rej
                         @"id": taskConfig.id,
                         @"metadata": taskConfig.metadata,
                         @"state": [NSNumber numberWithInt: task.state],
-                        @"bytesWritten": [NSNumber numberWithLongLong:task.countOfBytesReceived],
-                        @"totalBytes": [NSNumber numberWithLongLong:task.countOfBytesExpectedToReceive],
+                        @"bytesDownloaded": [NSNumber numberWithLongLong:task.countOfBytesReceived],
+                        @"bytesTotal": [NSNumber numberWithLongLong:task.countOfBytesExpectedToReceive],
                         @"percent": percent
                     }];
                     taskConfig.reportedBegin = YES;
@@ -341,11 +341,11 @@ RCT_EXPORT_METHOD(completeHandler:(nonnull NSString *)jobId
     }
 }
 
-- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didResumeAtOffset:(int64_t)fileOffset expectedTotalBytes:(int64_t)expectedTotalBytes {
+- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didResumeAtOffset:(int64_t)fileOffset expectedbytesTotal:(int64_t)expectedbytesTotal {
     NSLog(@"[RNBackgroundDownloader] - [didResumeAtOffset]");
 }
 
-- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite {
+- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesDownloaded bytesTotalWritten:(int64_t)bytesTotalWritten bytesTotalExpectedToWrite:(int64_t)bytesTotalExpectedToWrite {
     NSLog(@"[RNBackgroundDownloader] - [didWriteData]");
     @synchronized (sharedLock) {
         RNBGDTaskConfig *taskCofig = taskToConfigMap[@(downloadTask.taskIdentifier)];
@@ -356,7 +356,7 @@ RCT_EXPORT_METHOD(completeHandler:(nonnull NSString *)jobId
                 if (self.bridge) {
                     [self sendEventWithName:@"downloadBegin" body:@{
                         @"id": taskCofig.id,
-                        @"expectedBytes": [NSNumber numberWithLongLong: totalBytesExpectedToWrite],
+                        @"expectedBytes": [NSNumber numberWithLongLong: bytesTotalExpectedToWrite],
                         @"headers": responseHeaders
                     }];
                 }
@@ -364,9 +364,9 @@ RCT_EXPORT_METHOD(completeHandler:(nonnull NSString *)jobId
             }
 
             NSNumber *prevPercent = idToPercentMap[taskCofig.id];
-            NSNumber *percent = [NSNumber numberWithFloat:(float)totalBytesWritten/(float)totalBytesExpectedToWrite];
+            NSNumber *percent = [NSNumber numberWithFloat:(float)bytesTotalWritten/(float)bytesTotalExpectedToWrite];
             if ([percent floatValue] - [prevPercent floatValue] > 0.01f) {
-                progressReports[taskCofig.id] = @{@"id": taskCofig.id, @"written": [NSNumber numberWithLongLong: totalBytesWritten], @"total": [NSNumber numberWithLongLong: totalBytesExpectedToWrite], @"percent": percent};
+                progressReports[taskCofig.id] = @{@"id": taskCofig.id, @"bytesDownloaded": [NSNumber numberWithLongLong: bytesTotalWritten], @"bytesTotal": [NSNumber numberWithLongLong: bytesTotalExpectedToWrite], @"percent": percent};
                 idToPercentMap[taskCofig.id] = percent;
             }
 

package/lib/DownloadTask.ts

@@ -16,14 +16,14 @@ export default class DownloadTask {
   metadata = {}
 
   percent = 0
-  bytesWritten = 0
-  totalBytes = 0
+  bytesDownloaded = 0
+  bytesTotal = 0
 
   constructor (taskInfo: TaskInfo, originalTask?: TaskInfo) {
     this.id = taskInfo.id
     this.percent = taskInfo.percent ?? 0
-    this.bytesWritten = taskInfo.bytesWritten ?? 0
-    this.totalBytes = taskInfo.totalBytes ?? 0
+    this.bytesDownloaded = taskInfo.bytesDownloaded ?? 0
+    this.bytesTotal = taskInfo.bytesTotal ?? 0
 
     const metadata = this.tryParseJson(taskInfo.metadata)
     if (metadata)
@@ -66,11 +66,11 @@ export default class DownloadTask {
     this.beginHandler?.({ expectedBytes, headers })
   }
 
-  onProgress (percent, bytesWritten, totalBytes) {
+  onProgress (percent, bytesDownloaded, bytesTotal) {
     this.percent = percent
-    this.bytesWritten = bytesWritten
-    this.totalBytes = totalBytes
-    this.progressHandler?.(percent, bytesWritten, totalBytes)
+    this.bytesDownloaded = bytesDownloaded
+    this.bytesTotal = bytesTotal
+    this.progressHandler?.(percent, bytesDownloaded, bytesTotal)
   }
 
   onDone ({ location }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kesha-antonov/react-native-background-downloader",
-  "version": "2.10.0",
+  "version": "3.0.0-alpha.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",