@kesha-antonov/react-native-background-downloader 4.8.0 → 5.0.1

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.
Files changed (66) hide show
  1. package/README.md +12 -40
  2. package/android/build.gradle +5 -1
  3. package/android/consumer-rules.pro +14 -0
  4. package/android/src/main/AndroidManifest.xml +18 -1
  5. package/android/src/main/java/com/eko/UIDTDownloadJobService.kt +5 -567
  6. package/android/src/main/java/com/eko/uidt/CancelDownloadReceiver.kt +4 -58
  7. package/android/src/main/java/com/{eko → kesha_antonov}/DownloadConstants.kt +1 -1
  8. package/android/src/main/java/com/{eko → kesha_antonov}/DownloadEventEmitter.kt +1 -1
  9. package/android/src/main/java/com/{eko → kesha_antonov}/DownloadResult.kt +1 -1
  10. package/android/src/main/java/com/{eko → kesha_antonov}/Downloader.kt +2 -2
  11. package/android/src/main/java/com/{eko → kesha_antonov}/ProgressReporter.kt +1 -1
  12. package/android/src/main/java/com/{eko → kesha_antonov}/PromiseExtensions.kt +1 -1
  13. package/android/src/main/java/com/{eko → kesha_antonov}/RNBGDTaskConfig.kt +1 -1
  14. package/android/src/main/java/com/{eko → kesha_antonov}/RNBGDUploadTaskConfig.kt +1 -1
  15. package/android/src/main/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModuleImpl.kt +9 -9
  16. package/android/src/main/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderPackage.kt +1 -1
  17. package/android/src/main/java/com/{eko → kesha_antonov}/ResumableDownloadService.kt +11 -9
  18. package/android/src/main/java/com/{eko → kesha_antonov}/ResumableDownloader.kt +2 -2
  19. package/android/src/main/java/com/kesha_antonov/UIDTDownloadJobService.kt +590 -0
  20. package/android/src/main/java/com/{eko → kesha_antonov}/UnmeteredNetworkGate.kt +2 -2
  21. package/android/src/main/java/com/{eko → kesha_antonov}/UploadEventEmitter.kt +1 -1
  22. package/android/src/main/java/com/{eko → kesha_antonov}/Uploader.kt +2 -2
  23. package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnBegin.kt +4 -4
  24. package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnBeginState.kt +1 -1
  25. package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnProgress.kt +4 -4
  26. package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnProgressState.kt +1 -1
  27. package/android/src/main/java/com/{eko → kesha_antonov}/interfaces/BeginCallback.kt +1 -1
  28. package/android/src/main/java/com/{eko → kesha_antonov}/interfaces/ProgressCallback.kt +1 -1
  29. package/android/src/main/java/com/kesha_antonov/uidt/CancelDownloadReceiver.kt +68 -0
  30. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/RNBGDFileProvider.kt +1 -1
  31. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobIds.kt +9 -4
  32. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobManager.kt +6 -6
  33. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobState.kt +7 -5
  34. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationIds.kt +1 -1
  35. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationManager.kt +18 -10
  36. package/android/src/main/java/com/{eko → kesha_antonov}/utils/FileUtils.kt +1 -1
  37. package/android/src/main/java/com/{eko → kesha_antonov}/utils/HeaderUtils.kt +2 -2
  38. package/android/src/main/java/com/{eko → kesha_antonov}/utils/NetworkRequestUtils.kt +1 -1
  39. package/android/src/main/java/com/kesha_antonov/utils/NotificationUtils.kt +24 -0
  40. package/android/src/main/java/com/{eko → kesha_antonov}/utils/ProgressUtils.kt +1 -1
  41. package/android/src/main/java/com/{eko → kesha_antonov}/utils/ReadableConverters.kt +1 -1
  42. package/android/src/main/java/com/{eko → kesha_antonov}/utils/RedirectResolver.kt +3 -3
  43. package/android/src/main/java/com/{eko → kesha_antonov}/utils/StorageManager.kt +5 -5
  44. package/android/src/main/java/com/{eko → kesha_antonov}/utils/TempFileUtils.kt +2 -2
  45. package/android/src/newarch/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModule.kt +1 -1
  46. package/android/src/oldarch/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModule.kt +1 -1
  47. package/android/src/test/java/com/{eko → kesha_antonov}/DownloadCompleteReceiverTest.kt +1 -1
  48. package/android/src/test/java/com/{eko → kesha_antonov}/DownloaderRecoveryTest.kt +2 -2
  49. package/android/src/test/java/com/{eko → kesha_antonov}/DownloaderResumeTest.kt +3 -3
  50. package/android/src/test/java/com/{eko → kesha_antonov}/ResumableDownloaderConcurrencyTest.kt +1 -1
  51. package/android/src/test/java/com/{eko → kesha_antonov}/ResumableDownloaderRedirectTest.kt +1 -1
  52. package/android/src/test/java/com/{eko → kesha_antonov}/ResumableDownloaderStallTest.kt +1 -1
  53. package/android/src/test/java/com/{eko → kesha_antonov}/UnmeteredNetworkGateTest.kt +1 -1
  54. package/android/src/test/java/com/{eko → kesha_antonov}/UploadPartRangesTest.kt +1 -1
  55. package/android/src/test/java/com/{eko → kesha_antonov}/UploaderMultipartTest.kt +1 -1
  56. package/android/src/test/java/com/{eko → kesha_antonov}/UploaderPartsTest.kt +1 -1
  57. package/android/src/test/java/com/{eko → kesha_antonov}/UploaderResponseTest.kt +1 -1
  58. package/android/src/test/java/com/{eko → kesha_antonov}/handlers/OnBeginTest.kt +2 -2
  59. package/android/src/test/java/com/{eko → kesha_antonov}/uidt/CancelDownloadReceiverTest.kt +25 -2
  60. package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTJobIdsTest.kt +13 -2
  61. package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTJobManagerTest.kt +1 -1
  62. package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationIdsTest.kt +1 -1
  63. package/android/src/test/java/com/{eko → kesha_antonov}/utils/RedirectResolverTest.kt +1 -1
  64. package/bin/react-native-background-downloader.js +197 -0
  65. package/ios/RNBackgroundDownloader.mm +25 -5
  66. package/package.json +11 -5
package/README.md CHANGED
@@ -24,12 +24,18 @@
24
24
  </p>
25
25
 
26
26
  <p align="center">
27
- <strong><a href="https://kesha-antonov.github.io/react-native-background-downloader/">📖 Documentation</a></strong> &nbsp;·&nbsp;
28
- <a href="https://kesha-antonov.github.io/react-native-background-downloader/installation">Installation</a> &nbsp;·&nbsp;
29
- <a href="https://kesha-antonov.github.io/react-native-background-downloader/api">API reference</a> &nbsp;·&nbsp;
30
- <a href="https://kesha-antonov.github.io/react-native-background-downloader/troubleshooting">Troubleshooting</a>
27
+ <strong><a href="https://kesha-antonov.com/react-native-background-downloader/">📖 Documentation</a></strong> &nbsp;·&nbsp;
28
+ <a href="https://kesha-antonov.com/react-native-background-downloader/installation">Installation</a> &nbsp;·&nbsp;
29
+ <a href="https://kesha-antonov.com/react-native-background-downloader/api">API reference</a> &nbsp;·&nbsp;
30
+ <a href="https://kesha-antonov.com/react-native-background-downloader/troubleshooting">Troubleshooting</a>
31
31
  </p>
32
32
 
33
+ <!-- author:start -->
34
+ <p align="center">
35
+ <sub>Built and maintained by <a href="https://kesha-antonov.com">Kesha Antonov</a>, React Native lead engineer, <a href="https://kesha-antonov.com/react-native-developer/">available for hire</a>. More libraries, apps and case studies on <a href="https://kesha-antonov.com">kesha-antonov.com</a>.</sub>
36
+ </p>
37
+ <!-- author:end -->
38
+
33
39
  <p align="center">
34
40
  <sub>Using it in production? A ⭐ helps other developers find the library.</sub>
35
41
  </p>
@@ -45,41 +51,6 @@
45
51
  <a href="https://getstream.io/chat/sdk/react-native/?utm_source=github&utm_medium=sponsor&utm_campaign=keshaantonov&utm_term=react-native-background-downloader"><strong>Stream</strong></a> - React Native Chat SDK
46
52
  </p>
47
53
 
48
- <hr />
49
-
50
- <table align="center">
51
- <tr>
52
- <td align="center" valign="top" width="190">
53
- <a href="https://cryptoc-app.web.app/"><img src="https://cryptoc-app.web.app/img/icon.png?v=3" width="76" height="76" alt="cryptoc app icon" /></a>
54
- <br /><br />
55
- <img src="https://cryptoc-app.web.app/img/qr-get.png?v=2" width="124" height="124" alt="QR code that installs cryptoc" />
56
- <br />
57
- <sub>Scan to install</sub>
58
- <br /><br />
59
- <!-- App Store button hidden for now
60
- <a href="https://apps.apple.com/app/cryptoc/id1333169178"><img height="40" src="https://cryptoc-app.web.app/img/appstore.svg?v=2" alt="Download on the App Store" /></a>
61
- <br />
62
- -->
63
- <a href="https://play.google.com/store/apps/details?id=co.ssoul.CryptoC"><img height="59" src="https://cryptoc-app.web.app/img/googleplay.png?v=2" alt="Get it on Google Play" /></a>
64
- </td>
65
- <td valign="top">
66
-
67
- ### Support my work
68
-
69
- **[cryptoc](https://cryptoc-app.web.app/)** - my crypto portfolio app. Your coins on the home screen, lock screen and watch face. iPhone, iPad, Mac, Apple Watch, Android, Android tablet and Wear OS.
70
-
71
- - Portfolio with average buy price and 24h / 180-day / all-time P&L
72
- - Widgets in three sizes, refreshed in the background - most days you never open the app
73
- - Price alerts on 5,000+ coins, delivered while the app is closed
74
- - **No account, no email, no exchange API keys, no ads.** Your holdings never reach a server - they sync through your own iCloud or Google Drive
75
- - Free for 3 holdings, and that is not a trial timer
76
-
77
- <sub>Downloading it is what pays for the time that goes into these libraries.</sub>
78
-
79
- </td>
80
- </tr>
81
- </table>
82
-
83
54
  <hr />
84
55
  <!-- cryptoc-promo:end -->
85
56
 
@@ -1159,7 +1130,7 @@ See the [Google Play Console Declaration](#google-play-console-declaration) sect
1159
1130
  <details>
1160
1131
  <summary><strong>TypeToken errors in release builds (Android)</strong></summary>
1161
1132
 
1162
- Add the Proguard rules mentioned in the [Proguard Rules](#proguard-rules) section.
1133
+ Since v5.0.0 the library applies its ProGuard rules to your release build itself. On an older version, add the rules from the [Proguard Rules](#proguard-rules) section of that version's docs.
1163
1134
  </details>
1164
1135
 
1165
1136
  ## 💡 Use Cases
@@ -1177,6 +1148,7 @@ This library is perfect for apps that need reliable file transfers:
1177
1148
 
1178
1149
  Upgrading from an older version? Check the [Migration Guide](./MIGRATION.md) for detailed instructions:
1179
1150
 
1151
+ - [v4.8.x to v5.0.0](./MIGRATION.md#migration-guide-v48x-to-v500) - Android package renamed from `com.eko` to `com.kesha_antonov`
1180
1152
  - [v4.3.x → v4.4.0](./MIGRATION.md#migration-guide-v43x--v440) - iOS MMKV dependency change
1181
1153
  - [v4.1.x → v4.2.0](./MIGRATION.md#migration-guide-v41x--v420) - Android pause/resume support
1182
1154
  - [v4.0.x → v4.1.0](./MIGRATION.md#migration-guide-v40x--v410) - MMKV dependency change
@@ -30,7 +30,7 @@ android {
30
30
  def agpVersion = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION
31
31
  // Check AGP version for backward compatibility reasons (for RN < 0.71)
32
32
  if (agpVersion.tokenize('.')[0].toInteger() >= 7) {
33
- namespace "com.eko"
33
+ namespace "com.kesha_antonov"
34
34
  }
35
35
 
36
36
  compileSdkVersion safeExtGet('compileSdkVersion', 36)
@@ -48,6 +48,10 @@ android {
48
48
  abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'
49
49
  }
50
50
 
51
+ // Keep rules for the classes the library stores with Gson, applied to
52
+ // the app's release build so apps don't have to add them
53
+ consumerProguardFiles 'consumer-rules.pro'
54
+
51
55
  buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
52
56
  buildConfigField "String", "LIBRARY_VERSION", "\"${getVersionFromPackageJson()}\""
53
57
  }
@@ -0,0 +1,14 @@
1
+ # Applied to the app's release build automatically (consumerProguardFiles).
2
+ # These classes are saved and restored with Gson, which reads their fields by
3
+ # name, so R8 must not rename or strip them.
4
+ -keep class com.kesha_antonov.RNBGDTaskConfig { *; }
5
+ -keep class com.kesha_antonov.RNBGDUploadTaskConfig { *; }
6
+ -keep class com.kesha_antonov.UploadPartResult { *; }
7
+ -keep class com.kesha_antonov.utils.StorageManager$PausedDownloadInfoData { *; }
8
+
9
+ # Gson needs the generic type of each TypeToken
10
+ -keepattributes Signature
11
+ -keep class com.google.gson.reflect.TypeToken { *; }
12
+ -keep class * extends com.google.gson.reflect.TypeToken
13
+
14
+ -keep class com.tencent.mmkv.** { *; }
@@ -1,5 +1,5 @@
1
1
  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
2
- package="com.eko">
2
+ package="com.kesha_antonov">
3
3
 
4
4
  <uses-permission android:name="android.permission.DOWNLOAD_WITHOUT_NOTIFICATION" />
5
5
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
@@ -26,10 +26,27 @@
26
26
  android:permission="android.permission.BIND_JOB_SERVICE"
27
27
  android:exported="false" />
28
28
 
29
+ <!-- The job service under its name before v5.0.0: downloads scheduled by
30
+ v4.x name it, and keep running in it after the app is updated -->
31
+ <service
32
+ android:name="com.eko.UIDTDownloadJobService"
33
+ android:permission="android.permission.BIND_JOB_SERVICE"
34
+ android:exported="false" />
35
+
29
36
  <!-- Receiver for the in-notification "Cancel" action -->
30
37
  <receiver
31
38
  android:name=".uidt.CancelDownloadReceiver"
32
39
  android:exported="false">
40
+ <intent-filter>
41
+ <action android:name="com.kesha_antonov.uidt.ACTION_CANCEL_DOWNLOAD" />
42
+ </intent-filter>
43
+ </receiver>
44
+
45
+ <!-- The Cancel receiver under its name before v5.0.0, for notifications
46
+ v4.x posted that are still shown after the app is updated -->
47
+ <receiver
48
+ android:name="com.eko.uidt.CancelDownloadReceiver"
49
+ android:exported="false">
33
50
  <intent-filter>
34
51
  <action android:name="com.eko.uidt.ACTION_CANCEL_DOWNLOAD" />
35
52
  </intent-filter>