@kesha-antonov/react-native-background-downloader 4.6.3 → 4.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -7
- package/android/src/main/java/com/eko/DownloadConstants.kt +13 -2
- package/android/src/main/java/com/eko/DownloadResult.kt +3 -1
- package/android/src/main/java/com/eko/Downloader.kt +25 -4
- package/android/src/main/java/com/eko/ProgressReporter.kt +14 -35
- package/android/src/main/java/com/eko/RNBackgroundDownloaderModuleImpl.kt +162 -76
- package/android/src/main/java/com/eko/ResumableDownloadService.kt +2 -1
- package/android/src/main/java/com/eko/ResumableDownloader.kt +75 -3
- package/android/src/main/java/com/eko/UIDTDownloadJobService.kt +34 -8
- package/android/src/main/java/com/eko/Uploader.kt +15 -11
- package/android/src/main/java/com/eko/handlers/OnBegin.kt +6 -1
- package/android/src/main/java/com/eko/uidt/CancelDownloadReceiver.kt +3 -1
- package/android/src/main/java/com/eko/uidt/UIDTJobManager.kt +18 -2
- package/android/src/main/java/com/eko/utils/RedirectResolver.kt +5 -13
- package/android/src/main/java/com/eko/utils/StorageManager.kt +5 -0
- package/android/src/test/java/com/eko/DownloaderRecoveryTest.kt +78 -0
- package/android/src/test/java/com/eko/DownloaderResumeTest.kt +97 -0
- package/android/src/test/java/com/eko/ResumableDownloaderStallTest.kt +145 -0
- package/android/src/test/java/com/eko/UploaderMultipartTest.kt +84 -0
- package/android/src/test/java/com/eko/handlers/OnBeginTest.kt +51 -0
- package/android/src/test/java/com/eko/uidt/CancelDownloadReceiverTest.kt +84 -0
- package/android/src/test/java/com/eko/utils/RedirectResolverTest.kt +67 -0
- package/ios/RNBGDTaskConfig.h +2 -0
- package/ios/RNBGDTaskConfig.mm +6 -0
- package/ios/RNBackgroundDownloader.mm +640 -90
- package/lib/DownloadTask.d.ts +2 -0
- package/lib/DownloadTask.js +21 -1
- package/lib/UploadTask.d.ts +2 -0
- package/lib/UploadTask.js +25 -3
- package/lib/index.d.ts +1 -1
- package/lib/index.js +83 -70
- package/lib/tasks.d.ts +4 -0
- package/lib/tasks.js +7 -0
- package/package.json +14 -11
- package/plugin/build/index.d.ts +1 -0
- package/plugin/build/index.js +18 -10
- package/react-native-background-downloader.podspec +8 -0
- package/src/DownloadTask.ts +22 -1
- package/src/UploadTask.ts +25 -3
- package/src/index.ts +74 -43
- package/src/tasks.ts +7 -0
package/lib/DownloadTask.d.ts
CHANGED
|
@@ -12,11 +12,13 @@ export declare class DownloadTask {
|
|
|
12
12
|
progressHandler?: ProgressHandler;
|
|
13
13
|
doneHandler?: DoneHandler;
|
|
14
14
|
errorHandler?: ErrorHandler;
|
|
15
|
+
private hasBegun;
|
|
15
16
|
constructor(taskParams: TaskInfo | TaskInfoNative, originalTask?: DownloadTaskType);
|
|
16
17
|
begin(handler: BeginHandler): this;
|
|
17
18
|
progress(handler: ProgressHandler): this;
|
|
18
19
|
done(handler: DoneHandler): this;
|
|
19
20
|
error(handler: ErrorHandler): this;
|
|
21
|
+
private isInactive;
|
|
20
22
|
onBegin(params: BeginHandlerParams): void;
|
|
21
23
|
onProgress(params: ProgressHandlerParams): void;
|
|
22
24
|
onDone(params: DoneHandlerParams): void;
|
package/lib/DownloadTask.js
CHANGED
|
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.DownloadTask = void 0;
|
|
4
4
|
const config_1 = require("./config");
|
|
5
5
|
const logger_1 = require("./logger");
|
|
6
|
+
const tasks_1 = require("./tasks");
|
|
6
7
|
// Import shared native module getter to avoid duplicating TurboModule lookup
|
|
7
8
|
// This is lazily imported to avoid circular dependency issues at module load time
|
|
8
9
|
let getNativeModuleImpl = null;
|
|
@@ -21,6 +22,9 @@ class DownloadTask {
|
|
|
21
22
|
this.errorCode = 0;
|
|
22
23
|
this.bytesDownloaded = 0;
|
|
23
24
|
this.bytesTotal = 0;
|
|
25
|
+
// begin fires once per task. Android sends it again for each new transfer (a resume in
|
|
26
|
+
// a new job, a reschedule by the system), which isn't a new beginning for the app.
|
|
27
|
+
this.hasBegun = false;
|
|
24
28
|
this.id = taskParams.id;
|
|
25
29
|
if (taskParams.bytesDownloaded)
|
|
26
30
|
this.bytesDownloaded = taskParams.bytesDownloaded;
|
|
@@ -29,6 +33,8 @@ class DownloadTask {
|
|
|
29
33
|
if (taskParams.destination)
|
|
30
34
|
this.destination = (_a = taskParams.destination) !== null && _a !== void 0 ? _a : undefined;
|
|
31
35
|
this.metadata = (_b = this.tryParseJson(taskParams.metadata)) !== null && _b !== void 0 ? _b : {};
|
|
36
|
+
// A restored task that already has data has begun; so has one this replaces
|
|
37
|
+
this.hasBegun = (originalTask instanceof DownloadTask && originalTask.hasBegun) || this.bytesDownloaded > 0;
|
|
32
38
|
if (originalTask) {
|
|
33
39
|
this.beginHandler = originalTask.beginHandler;
|
|
34
40
|
this.progressHandler = originalTask.progressHandler;
|
|
@@ -62,14 +68,24 @@ class DownloadTask {
|
|
|
62
68
|
return this;
|
|
63
69
|
}
|
|
64
70
|
// event listeners
|
|
71
|
+
// Native can still deliver begin or progress that was in flight when the app paused
|
|
72
|
+
// or stopped the task, or when it ended. Those must not run handlers or change state.
|
|
73
|
+
isInactive() {
|
|
74
|
+
return this.state === 'PAUSED' || this.state === 'STOPPED' || this.state === 'DONE' || this.state === 'FAILED';
|
|
75
|
+
}
|
|
65
76
|
onBegin(params) {
|
|
66
77
|
var _a;
|
|
78
|
+
if (this.isInactive() || this.hasBegun)
|
|
79
|
+
return;
|
|
80
|
+
this.hasBegun = true;
|
|
67
81
|
this.state = 'DOWNLOADING';
|
|
68
82
|
this.bytesTotal = params.expectedBytes;
|
|
69
83
|
(_a = this.beginHandler) === null || _a === void 0 ? void 0 : _a.call(this, params);
|
|
70
84
|
}
|
|
71
85
|
onProgress(params) {
|
|
72
86
|
var _a;
|
|
87
|
+
if (this.isInactive())
|
|
88
|
+
return;
|
|
73
89
|
this.bytesDownloaded = params.bytesDownloaded;
|
|
74
90
|
this.bytesTotal = params.bytesTotal;
|
|
75
91
|
(_a = this.progressHandler) === null || _a === void 0 ? void 0 : _a.call(this, params);
|
|
@@ -84,6 +100,7 @@ class DownloadTask {
|
|
|
84
100
|
onError(params) {
|
|
85
101
|
var _a;
|
|
86
102
|
this.state = 'FAILED';
|
|
103
|
+
this.errorCode = params.errorCode;
|
|
87
104
|
(_a = this.errorHandler) === null || _a === void 0 ? void 0 : _a.call(this, params);
|
|
88
105
|
}
|
|
89
106
|
// methods
|
|
@@ -140,7 +157,7 @@ class DownloadTask {
|
|
|
140
157
|
...this.downloadParams,
|
|
141
158
|
headers: this.headersToUnsafeObject(this.downloadParams.headers),
|
|
142
159
|
isAllowedOverRoaming: (_c = this.downloadParams.isAllowedOverRoaming) !== null && _c !== void 0 ? _c : false,
|
|
143
|
-
isAllowedOverMetered: (_d = this.downloadParams.isAllowedOverMetered) !== null && _d !== void 0 ? _d :
|
|
160
|
+
isAllowedOverMetered: (_d = this.downloadParams.isAllowedOverMetered) !== null && _d !== void 0 ? _d : config_1.config.allowsCellularAccess,
|
|
144
161
|
// iOS-only; ignored on Android. Falls back to the global setConfig default.
|
|
145
162
|
iosDataProtection: (_e = this.downloadParams.iosDataProtection) !== null && _e !== void 0 ? _e : config_1.config.iosDataProtection,
|
|
146
163
|
});
|
|
@@ -149,6 +166,9 @@ class DownloadTask {
|
|
|
149
166
|
(0, logger_1.log)('DownloadTask: stop', this.id);
|
|
150
167
|
this.state = 'STOPPED';
|
|
151
168
|
await getNativeModule().stopTask(this.id);
|
|
169
|
+
// No event follows a stop, so nothing else would release the task
|
|
170
|
+
if (tasks_1.tasksMap.get(this.id) === this)
|
|
171
|
+
tasks_1.tasksMap.delete(this.id);
|
|
152
172
|
}
|
|
153
173
|
tryParseJson(metadata) {
|
|
154
174
|
var _a;
|
package/lib/UploadTask.d.ts
CHANGED
|
@@ -11,11 +11,13 @@ export declare class UploadTask {
|
|
|
11
11
|
progressHandler?: UploadProgressHandler;
|
|
12
12
|
doneHandler?: UploadDoneHandler;
|
|
13
13
|
errorHandler?: UploadErrorHandler;
|
|
14
|
+
private hasBegun;
|
|
14
15
|
constructor(taskParams: UploadTaskInfo | UploadTaskInfoNative, originalTask?: UploadTaskType);
|
|
15
16
|
begin(handler: UploadBeginHandler): this;
|
|
16
17
|
progress(handler: UploadProgressHandler): this;
|
|
17
18
|
done(handler: UploadDoneHandler): this;
|
|
18
19
|
error(handler: UploadErrorHandler): this;
|
|
20
|
+
private isInactive;
|
|
19
21
|
onBegin(params: UploadBeginHandlerParams): void;
|
|
20
22
|
onProgress(params: UploadProgressHandlerParams): void;
|
|
21
23
|
onDone(params: UploadDoneHandlerParams): void;
|
package/lib/UploadTask.js
CHANGED
|
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.UploadTask = void 0;
|
|
4
4
|
const config_1 = require("./config");
|
|
5
5
|
const logger_1 = require("./logger");
|
|
6
|
+
const tasks_1 = require("./tasks");
|
|
6
7
|
// Import shared native module getter to avoid duplicating TurboModule lookup
|
|
7
8
|
// This is lazily imported to avoid circular dependency issues at module load time
|
|
8
9
|
let getNativeModuleImpl = null;
|
|
@@ -21,12 +22,17 @@ class UploadTask {
|
|
|
21
22
|
this.errorCode = 0;
|
|
22
23
|
this.bytesUploaded = 0;
|
|
23
24
|
this.bytesTotal = 0;
|
|
25
|
+
// begin fires once per task. Android sends it again for each new transfer (a resume in
|
|
26
|
+
// a new job, a reschedule by the system), which isn't a new beginning for the app.
|
|
27
|
+
this.hasBegun = false;
|
|
24
28
|
this.id = taskParams.id;
|
|
25
29
|
if (taskParams.bytesUploaded)
|
|
26
30
|
this.bytesUploaded = taskParams.bytesUploaded;
|
|
27
31
|
if (taskParams.bytesTotal)
|
|
28
32
|
this.bytesTotal = taskParams.bytesTotal;
|
|
29
33
|
this.metadata = (_a = this.tryParseJson(taskParams.metadata)) !== null && _a !== void 0 ? _a : {};
|
|
34
|
+
// A restored task that already has data has begun; so has one this replaces
|
|
35
|
+
this.hasBegun = (originalTask instanceof UploadTask && originalTask.hasBegun) || this.bytesUploaded > 0;
|
|
30
36
|
if (originalTask) {
|
|
31
37
|
this.beginHandler = originalTask.beginHandler;
|
|
32
38
|
this.progressHandler = originalTask.progressHandler;
|
|
@@ -60,14 +66,24 @@ class UploadTask {
|
|
|
60
66
|
return this;
|
|
61
67
|
}
|
|
62
68
|
// event listeners
|
|
69
|
+
// Native can still deliver begin or progress that was in flight when the app paused
|
|
70
|
+
// or stopped the upload, or when it ended. Those must not run handlers or change state.
|
|
71
|
+
isInactive() {
|
|
72
|
+
return this.state === 'PAUSED' || this.state === 'STOPPED' || this.state === 'DONE' || this.state === 'FAILED';
|
|
73
|
+
}
|
|
63
74
|
onBegin(params) {
|
|
64
75
|
var _a;
|
|
76
|
+
if (this.isInactive() || this.hasBegun)
|
|
77
|
+
return;
|
|
78
|
+
this.hasBegun = true;
|
|
65
79
|
this.state = 'UPLOADING';
|
|
66
80
|
this.bytesTotal = params.expectedBytes;
|
|
67
81
|
(_a = this.beginHandler) === null || _a === void 0 ? void 0 : _a.call(this, params);
|
|
68
82
|
}
|
|
69
83
|
onProgress(params) {
|
|
70
84
|
var _a;
|
|
85
|
+
if (this.isInactive())
|
|
86
|
+
return;
|
|
71
87
|
this.bytesUploaded = params.bytesUploaded;
|
|
72
88
|
this.bytesTotal = params.bytesTotal;
|
|
73
89
|
(_a = this.progressHandler) === null || _a === void 0 ? void 0 : _a.call(this, params);
|
|
@@ -82,6 +98,7 @@ class UploadTask {
|
|
|
82
98
|
onError(params) {
|
|
83
99
|
var _a;
|
|
84
100
|
this.state = 'FAILED';
|
|
101
|
+
this.errorCode = params.errorCode;
|
|
85
102
|
(_a = this.errorHandler) === null || _a === void 0 ? void 0 : _a.call(this, params);
|
|
86
103
|
}
|
|
87
104
|
// methods
|
|
@@ -136,17 +153,22 @@ class UploadTask {
|
|
|
136
153
|
method: (_d = this.uploadParams.method) !== null && _d !== void 0 ? _d : 'POST',
|
|
137
154
|
headers: this.headersToUnsafeObject(this.uploadParams.headers),
|
|
138
155
|
isAllowedOverRoaming: (_e = this.uploadParams.isAllowedOverRoaming) !== null && _e !== void 0 ? _e : false,
|
|
139
|
-
isAllowedOverMetered: (_f = this.uploadParams.isAllowedOverMetered) !== null && _f !== void 0 ? _f :
|
|
156
|
+
isAllowedOverMetered: (_f = this.uploadParams.isAllowedOverMetered) !== null && _f !== void 0 ? _f : config_1.config.allowsCellularAccess,
|
|
140
157
|
});
|
|
141
158
|
}
|
|
142
159
|
async stop() {
|
|
143
160
|
(0, logger_1.log)('UploadTask: stop', this.id);
|
|
144
161
|
this.state = 'STOPPED';
|
|
145
162
|
const nativeModule = getNativeModule();
|
|
146
|
-
if (nativeModule.stopUploadTask)
|
|
163
|
+
if (nativeModule.stopUploadTask) {
|
|
147
164
|
await nativeModule.stopUploadTask(this.id);
|
|
148
|
-
|
|
165
|
+
// No event follows a stop, so nothing else would release the task
|
|
166
|
+
if (tasks_1.uploadTasksMap.get(this.id) === this)
|
|
167
|
+
tasks_1.uploadTasksMap.delete(this.id);
|
|
168
|
+
}
|
|
169
|
+
else {
|
|
149
170
|
(0, logger_1.log)('UploadTask: stop not supported - native implementation missing');
|
|
171
|
+
}
|
|
150
172
|
}
|
|
151
173
|
tryParseJson(metadata) {
|
|
152
174
|
var _a;
|
package/lib/index.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ export declare function cleanup(): void;
|
|
|
10
10
|
export declare function setConfig({ headers, progressInterval, progressMinBytes, isLogsEnabled, logCallback, maxParallelDownloads, allowsCellularAccess, showNotificationsEnabled, showCompletionNotification, showCancelAction, notificationsGrouping, iosDataProtection, }: Config): void;
|
|
11
11
|
export declare const getExistingDownloadTasks: () => Promise<DownloadTask[]>;
|
|
12
12
|
export declare const completeHandler: (jobId: string) => Promise<void> | undefined;
|
|
13
|
-
export declare function createDownloadTask({ isAllowedOverRoaming, isAllowedOverMetered, metadata, ...rest }: TaskInfo & DownloadParams): DownloadTask;
|
|
13
|
+
export declare function createDownloadTask({ isAllowedOverRoaming, isAllowedOverMetered, metadata, groupId, groupName, notificationTitle, ...rest }: TaskInfo & DownloadParams): DownloadTask;
|
|
14
14
|
export declare const getExistingUploadTasks: () => Promise<UploadTask[]>;
|
|
15
15
|
export declare function createUploadTask({ isAllowedOverRoaming, isAllowedOverMetered, metadata, ...rest }: UploadTaskInfo & UploadParams): UploadTask;
|
|
16
16
|
export declare const directories: {
|
package/lib/index.js
CHANGED
|
@@ -12,6 +12,7 @@ const UploadTask_1 = require("./UploadTask");
|
|
|
12
12
|
const config_1 = require("./config");
|
|
13
13
|
const logger_1 = require("./logger");
|
|
14
14
|
const notifications_1 = require("./notifications");
|
|
15
|
+
const tasks_1 = require("./tasks");
|
|
15
16
|
// Lazy initialization state
|
|
16
17
|
let RNBackgroundDownloader = null;
|
|
17
18
|
let turboModule = null;
|
|
@@ -23,10 +24,11 @@ let isInitialized = false;
|
|
|
23
24
|
* This prevents issues with module loading before React Native's bridge is ready.
|
|
24
25
|
*/
|
|
25
26
|
function ensureNativeModuleInitialized() {
|
|
27
|
+
var _a;
|
|
26
28
|
if (isInitialized && RNBackgroundDownloader != null)
|
|
27
29
|
return RNBackgroundDownloader;
|
|
28
30
|
// Try TurboModules first
|
|
29
|
-
turboModule = react_native_1.TurboModuleRegistry.get('RNBackgroundDownloader');
|
|
31
|
+
turboModule = (_a = react_native_1.TurboModuleRegistry.get('RNBackgroundDownloader')) !== null && _a !== void 0 ? _a : null;
|
|
30
32
|
// Check if iOS new architecture event emitters are available
|
|
31
33
|
// On Android, we always use NativeEventEmitter because Android uses RCTDeviceEventEmitter
|
|
32
34
|
isIOSNewArchitecture = react_native_1.Platform.OS === 'ios' && turboModule != null && typeof turboModule.onDownloadBegin === 'function';
|
|
@@ -56,8 +58,6 @@ function ensureNativeModuleInitialized() {
|
|
|
56
58
|
return RNBackgroundDownloader;
|
|
57
59
|
}
|
|
58
60
|
const MIN_PROGRESS_INTERVAL = 250;
|
|
59
|
-
const tasksMap = new Map();
|
|
60
|
-
const uploadTasksMap = new Map();
|
|
61
61
|
// Set up event listeners based on architecture
|
|
62
62
|
// For old architecture, we need to defer NativeEventEmitter creation
|
|
63
63
|
// to avoid issues during module initialization
|
|
@@ -77,96 +77,95 @@ function cleanup() {
|
|
|
77
77
|
RNBackgroundDownloader = null;
|
|
78
78
|
turboModule = null;
|
|
79
79
|
isIOSNewArchitecture = false;
|
|
80
|
-
tasksMap.clear();
|
|
81
|
-
uploadTasksMap.clear();
|
|
80
|
+
tasks_1.tasksMap.clear();
|
|
81
|
+
tasks_1.uploadTasksMap.clear();
|
|
82
82
|
}
|
|
83
83
|
function initializeEventListeners() {
|
|
84
|
-
var _a, _b, _c, _d;
|
|
85
84
|
if (eventListenersInitialized)
|
|
86
85
|
return;
|
|
87
86
|
eventListenersInitialized = true;
|
|
88
87
|
if (isIOSNewArchitecture && turboModule) {
|
|
89
88
|
// iOS new architecture: use EventEmitter from TurboModule spec
|
|
90
|
-
turboModule.onDownloadBegin((data) => {
|
|
89
|
+
eventSubscriptions.push(turboModule.onDownloadBegin((data) => {
|
|
91
90
|
const { id, ...rest } = data;
|
|
92
91
|
(0, logger_1.log)('downloadBegin', id, rest);
|
|
93
|
-
const task = tasksMap.get(id);
|
|
92
|
+
const task = tasks_1.tasksMap.get(id);
|
|
94
93
|
if (!task) {
|
|
95
94
|
(0, logger_1.log)('downloadBegin: task not found in tasksMap', id);
|
|
96
95
|
return;
|
|
97
96
|
}
|
|
98
97
|
task.onBegin(rest);
|
|
99
|
-
});
|
|
100
|
-
turboModule.onDownloadProgress((events) => {
|
|
98
|
+
}));
|
|
99
|
+
eventSubscriptions.push(turboModule.onDownloadProgress((events) => {
|
|
101
100
|
(0, logger_1.log)('downloadProgress', events);
|
|
102
101
|
for (const event of events) {
|
|
103
102
|
const { id, ...rest } = event;
|
|
104
|
-
const task = tasksMap.get(id);
|
|
103
|
+
const task = tasks_1.tasksMap.get(id);
|
|
105
104
|
if (task)
|
|
106
105
|
task.onProgress(rest);
|
|
107
106
|
}
|
|
108
|
-
});
|
|
109
|
-
turboModule.onDownloadComplete((data) => {
|
|
107
|
+
}));
|
|
108
|
+
eventSubscriptions.push(turboModule.onDownloadComplete((data) => {
|
|
110
109
|
const { id, ...rest } = data;
|
|
111
110
|
(0, logger_1.log)('downloadComplete', id, rest);
|
|
112
|
-
const task = tasksMap.get(id);
|
|
111
|
+
const task = tasks_1.tasksMap.get(id);
|
|
113
112
|
if (!task)
|
|
114
113
|
(0, logger_1.log)('downloadComplete: task not found in tasksMap', id);
|
|
115
114
|
else
|
|
116
115
|
task.onDone(rest);
|
|
117
|
-
tasksMap.delete(id);
|
|
118
|
-
});
|
|
119
|
-
turboModule.onDownloadFailed((data) => {
|
|
116
|
+
tasks_1.tasksMap.delete(id);
|
|
117
|
+
}));
|
|
118
|
+
eventSubscriptions.push(turboModule.onDownloadFailed((data) => {
|
|
120
119
|
const { id, ...rest } = data;
|
|
121
120
|
(0, logger_1.log)('downloadFailed', id, rest);
|
|
122
|
-
const task = tasksMap.get(id);
|
|
121
|
+
const task = tasks_1.tasksMap.get(id);
|
|
123
122
|
if (!task)
|
|
124
123
|
(0, logger_1.log)('downloadFailed: task not found in tasksMap', id);
|
|
125
124
|
else
|
|
126
125
|
task.onError(rest);
|
|
127
|
-
tasksMap.delete(id);
|
|
128
|
-
});
|
|
126
|
+
tasks_1.tasksMap.delete(id);
|
|
127
|
+
}));
|
|
129
128
|
// Upload events for new architecture (optional - may not exist in all versions)
|
|
130
129
|
if (typeof turboModule.onUploadBegin === 'function') {
|
|
131
|
-
(
|
|
130
|
+
eventSubscriptions.push(turboModule.onUploadBegin((data) => {
|
|
132
131
|
const { id, ...rest } = data;
|
|
133
132
|
(0, logger_1.log)('uploadBegin', id, rest);
|
|
134
|
-
const task = uploadTasksMap.get(id);
|
|
133
|
+
const task = tasks_1.uploadTasksMap.get(id);
|
|
135
134
|
if (!task) {
|
|
136
135
|
(0, logger_1.log)('uploadBegin: task not found in uploadTasksMap', id);
|
|
137
136
|
return;
|
|
138
137
|
}
|
|
139
138
|
task.onBegin(rest);
|
|
140
|
-
});
|
|
141
|
-
(
|
|
139
|
+
}));
|
|
140
|
+
eventSubscriptions.push(turboModule.onUploadProgress((events) => {
|
|
142
141
|
(0, logger_1.log)('uploadProgress', events);
|
|
143
142
|
for (const event of events) {
|
|
144
143
|
const { id, ...rest } = event;
|
|
145
|
-
const task = uploadTasksMap.get(id);
|
|
144
|
+
const task = tasks_1.uploadTasksMap.get(id);
|
|
146
145
|
if (task)
|
|
147
146
|
task.onProgress(rest);
|
|
148
147
|
}
|
|
149
|
-
});
|
|
150
|
-
(
|
|
148
|
+
}));
|
|
149
|
+
eventSubscriptions.push(turboModule.onUploadComplete((data) => {
|
|
151
150
|
const { id, ...rest } = data;
|
|
152
151
|
(0, logger_1.log)('uploadComplete', id, rest);
|
|
153
|
-
const task = uploadTasksMap.get(id);
|
|
152
|
+
const task = tasks_1.uploadTasksMap.get(id);
|
|
154
153
|
if (!task)
|
|
155
154
|
(0, logger_1.log)('uploadComplete: task not found in uploadTasksMap', id);
|
|
156
155
|
else
|
|
157
156
|
task.onDone(rest);
|
|
158
|
-
uploadTasksMap.delete(id);
|
|
159
|
-
});
|
|
160
|
-
(
|
|
157
|
+
tasks_1.uploadTasksMap.delete(id);
|
|
158
|
+
}));
|
|
159
|
+
eventSubscriptions.push(turboModule.onUploadFailed((data) => {
|
|
161
160
|
const { id, ...rest } = data;
|
|
162
161
|
(0, logger_1.log)('uploadFailed', id, rest);
|
|
163
|
-
const task = uploadTasksMap.get(id);
|
|
162
|
+
const task = tasks_1.uploadTasksMap.get(id);
|
|
164
163
|
if (!task)
|
|
165
164
|
(0, logger_1.log)('uploadFailed: task not found in uploadTasksMap', id);
|
|
166
165
|
else
|
|
167
166
|
task.onError(rest);
|
|
168
|
-
uploadTasksMap.delete(id);
|
|
169
|
-
});
|
|
167
|
+
tasks_1.uploadTasksMap.delete(id);
|
|
168
|
+
}));
|
|
170
169
|
}
|
|
171
170
|
}
|
|
172
171
|
else {
|
|
@@ -178,7 +177,7 @@ function initializeEventListeners() {
|
|
|
178
177
|
eventSubscriptions.push(eventEmitter.addListener('downloadBegin', (data) => {
|
|
179
178
|
const { id, ...rest } = data;
|
|
180
179
|
(0, logger_1.log)('downloadBegin', id, rest);
|
|
181
|
-
const task = tasksMap.get(id);
|
|
180
|
+
const task = tasks_1.tasksMap.get(id);
|
|
182
181
|
if (!task) {
|
|
183
182
|
(0, logger_1.log)('downloadBegin: task not found in tasksMap', id);
|
|
184
183
|
return;
|
|
@@ -189,7 +188,7 @@ function initializeEventListeners() {
|
|
|
189
188
|
(0, logger_1.log)('downloadProgress', events);
|
|
190
189
|
for (const event of events) {
|
|
191
190
|
const { id, ...rest } = event;
|
|
192
|
-
const task = tasksMap.get(id);
|
|
191
|
+
const task = tasks_1.tasksMap.get(id);
|
|
193
192
|
if (task)
|
|
194
193
|
task.onProgress(rest);
|
|
195
194
|
}
|
|
@@ -197,28 +196,28 @@ function initializeEventListeners() {
|
|
|
197
196
|
eventSubscriptions.push(eventEmitter.addListener('downloadComplete', (data) => {
|
|
198
197
|
const { id, ...rest } = data;
|
|
199
198
|
(0, logger_1.log)('downloadComplete', id, rest);
|
|
200
|
-
const task = tasksMap.get(id);
|
|
199
|
+
const task = tasks_1.tasksMap.get(id);
|
|
201
200
|
if (!task)
|
|
202
201
|
(0, logger_1.log)('downloadComplete: task not found in tasksMap', id);
|
|
203
202
|
else
|
|
204
203
|
task.onDone(rest);
|
|
205
|
-
tasksMap.delete(id);
|
|
204
|
+
tasks_1.tasksMap.delete(id);
|
|
206
205
|
}));
|
|
207
206
|
eventSubscriptions.push(eventEmitter.addListener('downloadFailed', (data) => {
|
|
208
207
|
const { id, ...rest } = data;
|
|
209
208
|
(0, logger_1.log)('downloadFailed', id, rest);
|
|
210
|
-
const task = tasksMap.get(id);
|
|
209
|
+
const task = tasks_1.tasksMap.get(id);
|
|
211
210
|
if (!task)
|
|
212
211
|
(0, logger_1.log)('downloadFailed: task not found in tasksMap', id);
|
|
213
212
|
else
|
|
214
213
|
task.onError(rest);
|
|
215
|
-
tasksMap.delete(id);
|
|
214
|
+
tasks_1.tasksMap.delete(id);
|
|
216
215
|
}));
|
|
217
216
|
// Upload events for old architecture
|
|
218
217
|
eventSubscriptions.push(eventEmitter.addListener('uploadBegin', (data) => {
|
|
219
218
|
const { id, ...rest } = data;
|
|
220
219
|
(0, logger_1.log)('uploadBegin', id, rest);
|
|
221
|
-
const task = uploadTasksMap.get(id);
|
|
220
|
+
const task = tasks_1.uploadTasksMap.get(id);
|
|
222
221
|
if (!task) {
|
|
223
222
|
(0, logger_1.log)('uploadBegin: task not found in uploadTasksMap', id);
|
|
224
223
|
return;
|
|
@@ -229,7 +228,7 @@ function initializeEventListeners() {
|
|
|
229
228
|
(0, logger_1.log)('uploadProgress', events);
|
|
230
229
|
for (const event of events) {
|
|
231
230
|
const { id, ...rest } = event;
|
|
232
|
-
const task = uploadTasksMap.get(id);
|
|
231
|
+
const task = tasks_1.uploadTasksMap.get(id);
|
|
233
232
|
if (task)
|
|
234
233
|
task.onProgress(rest);
|
|
235
234
|
}
|
|
@@ -237,22 +236,22 @@ function initializeEventListeners() {
|
|
|
237
236
|
eventSubscriptions.push(eventEmitter.addListener('uploadComplete', (data) => {
|
|
238
237
|
const { id, ...rest } = data;
|
|
239
238
|
(0, logger_1.log)('uploadComplete', id, rest);
|
|
240
|
-
const task = uploadTasksMap.get(id);
|
|
239
|
+
const task = tasks_1.uploadTasksMap.get(id);
|
|
241
240
|
if (!task)
|
|
242
241
|
(0, logger_1.log)('uploadComplete: task not found in uploadTasksMap', id);
|
|
243
242
|
else
|
|
244
243
|
task.onDone(rest);
|
|
245
|
-
uploadTasksMap.delete(id);
|
|
244
|
+
tasks_1.uploadTasksMap.delete(id);
|
|
246
245
|
}));
|
|
247
246
|
eventSubscriptions.push(eventEmitter.addListener('uploadFailed', (data) => {
|
|
248
247
|
const { id, ...rest } = data;
|
|
249
248
|
(0, logger_1.log)('uploadFailed', id, rest);
|
|
250
|
-
const task = uploadTasksMap.get(id);
|
|
249
|
+
const task = tasks_1.uploadTasksMap.get(id);
|
|
251
250
|
if (!task)
|
|
252
251
|
(0, logger_1.log)('uploadFailed: task not found in uploadTasksMap', id);
|
|
253
252
|
else
|
|
254
253
|
task.onError(rest);
|
|
255
|
-
uploadTasksMap.delete(id);
|
|
254
|
+
tasks_1.uploadTasksMap.delete(id);
|
|
256
255
|
}));
|
|
257
256
|
// Native debug log events - forward native iOS logs to JS logCallback
|
|
258
257
|
eventSubscriptions.push(eventEmitter.addListener('nativeDebugLog', (data) => {
|
|
@@ -262,19 +261,23 @@ function initializeEventListeners() {
|
|
|
262
261
|
}
|
|
263
262
|
// Event listeners are now initialized lazily when ensureNativeModuleInitialized() is called
|
|
264
263
|
// This ensures the bridge is ready before any native module access
|
|
265
|
-
|
|
264
|
+
// Only the options passed are changed; the rest keep their current values
|
|
265
|
+
function setConfig({ headers, progressInterval, progressMinBytes, isLogsEnabled, logCallback, maxParallelDownloads, allowsCellularAccess, showNotificationsEnabled, showCompletionNotification, showCancelAction, notificationsGrouping, iosDataProtection, }) {
|
|
266
266
|
var _a, _b, _c, _d, _e;
|
|
267
|
-
|
|
267
|
+
if (headers !== undefined)
|
|
268
|
+
config_1.config.headers = headers;
|
|
268
269
|
if (iosDataProtection !== undefined)
|
|
269
270
|
config_1.config.iosDataProtection = iosDataProtection;
|
|
270
|
-
if (progressInterval
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
271
|
+
if (progressInterval !== undefined)
|
|
272
|
+
if (progressInterval >= MIN_PROGRESS_INTERVAL)
|
|
273
|
+
config_1.config.progressInterval = progressInterval;
|
|
274
|
+
else
|
|
275
|
+
console.warn(`[RNBackgroundDownloader] progressInterval must be a number >= ${MIN_PROGRESS_INTERVAL}. You passed ${progressInterval}`);
|
|
276
|
+
if (progressMinBytes !== undefined)
|
|
277
|
+
if (progressMinBytes >= 0)
|
|
278
|
+
config_1.config.progressMinBytes = progressMinBytes;
|
|
279
|
+
else
|
|
280
|
+
console.warn(`[RNBackgroundDownloader] progressMinBytes must be a number >= 0. You passed ${progressMinBytes}`);
|
|
278
281
|
if (maxParallelDownloads !== undefined)
|
|
279
282
|
if (maxParallelDownloads >= 1)
|
|
280
283
|
config_1.config.maxParallelDownloads = maxParallelDownloads;
|
|
@@ -300,12 +303,14 @@ function setConfig({ headers = {}, progressInterval = config_1.DEFAULT_PROGRESS_
|
|
|
300
303
|
...notificationsGrouping.texts,
|
|
301
304
|
},
|
|
302
305
|
};
|
|
303
|
-
|
|
304
|
-
|
|
306
|
+
if (isLogsEnabled !== undefined)
|
|
307
|
+
config_1.config.isLogsEnabled = isLogsEnabled;
|
|
308
|
+
if (logCallback !== undefined)
|
|
309
|
+
config_1.config.logCallback = logCallback;
|
|
305
310
|
// Notify native side about configuration changes
|
|
306
311
|
try {
|
|
307
312
|
const nativeModule = ensureNativeModuleInitialized();
|
|
308
|
-
if (nativeModule.setLogsEnabled)
|
|
313
|
+
if (nativeModule.setLogsEnabled && isLogsEnabled !== undefined)
|
|
309
314
|
nativeModule.setLogsEnabled(isLogsEnabled);
|
|
310
315
|
// Only call native methods if config was successfully updated
|
|
311
316
|
if (nativeModule.setMaxParallelDownloads && maxParallelDownloads !== undefined && maxParallelDownloads >= 1)
|
|
@@ -347,7 +352,7 @@ const getExistingDownloadTasks = async () => {
|
|
|
347
352
|
errorCode: (_a = downloadInfo.errorCode) !== null && _a !== void 0 ? _a : 0,
|
|
348
353
|
};
|
|
349
354
|
// second argument re-assigns event handlers
|
|
350
|
-
const task = new DownloadTask_1.DownloadTask(taskInfo, tasksMap.get(taskInfo.id));
|
|
355
|
+
const task = new DownloadTask_1.DownloadTask(taskInfo, tasks_1.tasksMap.get(taskInfo.id));
|
|
351
356
|
switch (taskInfo.state) {
|
|
352
357
|
case nativeModule.TaskRunning: {
|
|
353
358
|
task.state = 'DOWNLOADING';
|
|
@@ -363,7 +368,8 @@ const getExistingDownloadTasks = async () => {
|
|
|
363
368
|
task.state = 'PAUSED';
|
|
364
369
|
}
|
|
365
370
|
else {
|
|
366
|
-
task
|
|
371
|
+
// Not awaited: the task is dropped either way, so a failed stop isn't actionable
|
|
372
|
+
task.stop().catch(() => { });
|
|
367
373
|
return undefined;
|
|
368
374
|
}
|
|
369
375
|
break;
|
|
@@ -379,7 +385,7 @@ const getExistingDownloadTasks = async () => {
|
|
|
379
385
|
return task;
|
|
380
386
|
}).filter((task) => task !== undefined);
|
|
381
387
|
for (const task of downloadTasks)
|
|
382
|
-
tasksMap.set(task.id, task);
|
|
388
|
+
tasks_1.tasksMap.set(task.id, task);
|
|
383
389
|
return downloadTasks;
|
|
384
390
|
};
|
|
385
391
|
exports.getExistingDownloadTasks = getExistingDownloadTasks;
|
|
@@ -392,23 +398,27 @@ const completeHandler = (jobId) => {
|
|
|
392
398
|
return nativeModule.completeHandler(jobId);
|
|
393
399
|
};
|
|
394
400
|
exports.completeHandler = completeHandler;
|
|
395
|
-
function createDownloadTask({ isAllowedOverRoaming = true,
|
|
401
|
+
function createDownloadTask({ isAllowedOverRoaming = true,
|
|
402
|
+
// Follows setConfig({ allowsCellularAccess }) unless the task sets its own
|
|
403
|
+
isAllowedOverMetered = config_1.config.allowsCellularAccess, metadata, groupId, groupName, notificationTitle, ...rest }) {
|
|
396
404
|
// Ensure native module and event listeners are initialized before creating tasks
|
|
397
405
|
ensureNativeModuleInitialized();
|
|
398
406
|
if (!rest.id || !rest.url || !rest.destination)
|
|
399
407
|
throw new Error('[RNBackgroundDownloader] id, url and destination are required');
|
|
400
408
|
rest.headers = { ...config_1.config.headers, ...rest.headers };
|
|
401
409
|
rest.destination = rest.destination.replace('file://', '');
|
|
410
|
+
// Native reads the notification fields from metadata only
|
|
411
|
+
const notificationFields = Object.fromEntries(Object.entries({ groupId, groupName, notificationTitle }).filter(([, value]) => value !== undefined));
|
|
402
412
|
const task = new DownloadTask_1.DownloadTask({
|
|
403
413
|
id: rest.id,
|
|
404
|
-
metadata,
|
|
414
|
+
metadata: Object.keys(notificationFields).length > 0 ? { ...metadata, ...notificationFields } : metadata,
|
|
405
415
|
});
|
|
406
416
|
task.setDownloadParams({
|
|
407
417
|
isAllowedOverRoaming,
|
|
408
418
|
isAllowedOverMetered,
|
|
409
419
|
...rest,
|
|
410
420
|
});
|
|
411
|
-
tasksMap.set(rest.id, task);
|
|
421
|
+
tasks_1.tasksMap.set(rest.id, task);
|
|
412
422
|
return task;
|
|
413
423
|
}
|
|
414
424
|
const getExistingUploadTasks = async () => {
|
|
@@ -435,7 +445,7 @@ const getExistingUploadTasks = async () => {
|
|
|
435
445
|
errorCode: (_a = uploadInfo.errorCode) !== null && _a !== void 0 ? _a : 0,
|
|
436
446
|
};
|
|
437
447
|
// second argument re-assigns event handlers
|
|
438
|
-
const task = new UploadTask_1.UploadTask(taskInfo, uploadTasksMap.get(taskInfo.id));
|
|
448
|
+
const task = new UploadTask_1.UploadTask(taskInfo, tasks_1.uploadTasksMap.get(taskInfo.id));
|
|
439
449
|
switch (taskInfo.state) {
|
|
440
450
|
case nativeModule.TaskRunning: {
|
|
441
451
|
task.state = 'UPLOADING';
|
|
@@ -451,7 +461,8 @@ const getExistingUploadTasks = async () => {
|
|
|
451
461
|
task.state = 'PAUSED';
|
|
452
462
|
}
|
|
453
463
|
else {
|
|
454
|
-
task
|
|
464
|
+
// Not awaited: the task is dropped either way, so a failed stop isn't actionable
|
|
465
|
+
task.stop().catch(() => { });
|
|
455
466
|
return undefined;
|
|
456
467
|
}
|
|
457
468
|
break;
|
|
@@ -467,11 +478,13 @@ const getExistingUploadTasks = async () => {
|
|
|
467
478
|
return task;
|
|
468
479
|
}).filter((task) => task !== undefined);
|
|
469
480
|
for (const task of uploadTasks)
|
|
470
|
-
uploadTasksMap.set(task.id, task);
|
|
481
|
+
tasks_1.uploadTasksMap.set(task.id, task);
|
|
471
482
|
return uploadTasks;
|
|
472
483
|
};
|
|
473
484
|
exports.getExistingUploadTasks = getExistingUploadTasks;
|
|
474
|
-
function createUploadTask({ isAllowedOverRoaming = true,
|
|
485
|
+
function createUploadTask({ isAllowedOverRoaming = true,
|
|
486
|
+
// Follows setConfig({ allowsCellularAccess }) unless the task sets its own
|
|
487
|
+
isAllowedOverMetered = config_1.config.allowsCellularAccess, metadata, ...rest }) {
|
|
475
488
|
// Ensure native module and event listeners are initialized before creating tasks
|
|
476
489
|
ensureNativeModuleInitialized();
|
|
477
490
|
if (!rest.id || !rest.url || !rest.source)
|
|
@@ -487,7 +500,7 @@ function createUploadTask({ isAllowedOverRoaming = true, isAllowedOverMetered =
|
|
|
487
500
|
isAllowedOverMetered,
|
|
488
501
|
...rest,
|
|
489
502
|
});
|
|
490
|
-
uploadTasksMap.set(rest.id, task);
|
|
503
|
+
tasks_1.uploadTasksMap.set(rest.id, task);
|
|
491
504
|
return task;
|
|
492
505
|
}
|
|
493
506
|
// Use getter to lazily initialize native module when directories are accessed
|
package/lib/tasks.d.ts
ADDED
package/lib/tasks.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.uploadTasksMap = exports.tasksMap = void 0;
|
|
4
|
+
// Tasks that native events are delivered to, by id. In their own module so a task can remove
|
|
5
|
+
// itself on stop without a circular import of index.
|
|
6
|
+
exports.tasksMap = new Map();
|
|
7
|
+
exports.uploadTasksMap = new Map();
|