@kesha-antonov/react-native-background-downloader 4.5.8 → 4.6.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.
Files changed (49) hide show
  1. package/README.md +30 -3
  2. package/android/build.gradle +17 -0
  3. package/android/src/main/AndroidManifest.xml +24 -0
  4. package/android/src/main/java/com/eko/DownloadConstants.kt +14 -2
  5. package/android/src/main/java/com/eko/Downloader.kt +77 -12
  6. package/android/src/main/java/com/eko/PromiseExtensions.kt +36 -0
  7. package/android/src/main/java/com/eko/RNBackgroundDownloaderModuleImpl.kt +82 -134
  8. package/android/src/main/java/com/eko/ResumableDownloadService.kt +0 -4
  9. package/android/src/main/java/com/eko/ResumableDownloader.kt +121 -12
  10. package/android/src/main/java/com/eko/UIDTDownloadJobService.kt +65 -9
  11. package/android/src/main/java/com/eko/uidt/CancelDownloadReceiver.kt +64 -0
  12. package/android/src/main/java/com/eko/uidt/RNBGDFileProvider.kt +17 -0
  13. package/android/src/main/java/com/eko/uidt/UIDTJobIds.kt +112 -0
  14. package/android/src/main/java/com/eko/uidt/UIDTJobManager.kt +178 -17
  15. package/android/src/main/java/com/eko/uidt/UIDTJobState.kt +23 -1
  16. package/android/src/main/java/com/eko/uidt/UIDTNotificationIds.kt +73 -0
  17. package/android/src/main/java/com/eko/uidt/UIDTNotificationManager.kt +246 -19
  18. package/android/src/main/java/com/eko/utils/ReadableConverters.kt +55 -0
  19. package/android/src/main/java/com/eko/utils/RedirectResolver.kt +97 -0
  20. package/android/src/main/java/com/eko/utils/StorageManager.kt +13 -0
  21. package/android/src/main/res/xml/rnbgd_file_paths.xml +23 -0
  22. package/android/src/newarch/java/com/eko/RNBackgroundDownloaderModule.kt +18 -70
  23. package/android/src/oldarch/java/com/eko/RNBackgroundDownloaderModule.kt +18 -70
  24. package/android/src/test/java/com/eko/ResumableDownloaderConcurrencyTest.kt +199 -0
  25. package/android/src/test/java/com/eko/uidt/UIDTJobIdsTest.kt +159 -0
  26. package/android/src/test/java/com/eko/uidt/UIDTJobManagerTest.kt +192 -0
  27. package/android/src/test/java/com/eko/uidt/UIDTNotificationIdsTest.kt +99 -0
  28. package/ios/RNBackgroundDownloader.mm +187 -91
  29. package/lib/DownloadTask.js +8 -7
  30. package/lib/NativeRNBackgroundDownloader.d.ts +2 -0
  31. package/lib/UploadTask.js +11 -10
  32. package/lib/config.d.ts +3 -10
  33. package/lib/config.js +4 -44
  34. package/lib/index.d.ts +1 -1
  35. package/lib/index.js +43 -34
  36. package/lib/logger.d.ts +2 -0
  37. package/lib/logger.js +16 -0
  38. package/lib/notifications.d.ts +8 -0
  39. package/lib/notifications.js +35 -0
  40. package/lib/types.d.ts +19 -0
  41. package/package.json +8 -3
  42. package/src/DownloadTask.ts +2 -1
  43. package/src/NativeRNBackgroundDownloader.ts +8 -1
  44. package/src/UploadTask.ts +2 -1
  45. package/src/config.ts +9 -45
  46. package/src/index.ts +22 -2
  47. package/src/logger.ts +16 -0
  48. package/src/notifications.ts +32 -0
  49. package/src/types.ts +19 -0
package/src/logger.ts ADDED
@@ -0,0 +1,16 @@
1
+ import { config } from './config'
2
+
3
+ // External log callback for capturing logs in parent app
4
+ export type LogCallback = (tag: string, message: string, ...args: unknown[]) => void
5
+
6
+ export const log = (...args: unknown[]): void => {
7
+ if (config.isLogsEnabled) {
8
+ console.log('[RNBackgroundDownloader]', ...args)
9
+ // Call external log callback if provided
10
+ if (config.logCallback) {
11
+ const message = args.length > 0 && typeof args[0] === 'string' ? args[0] : 'log'
12
+ const restArgs = args.length > 1 ? args.slice(1) : []
13
+ config.logCallback('RNBD', message, ...restArgs)
14
+ }
15
+ }
16
+ }
@@ -0,0 +1,32 @@
1
+ import { config, DEFAULT_NOTIFICATION_TEXTS } from './config'
2
+
3
+ /**
4
+ * Get notification text with proper pluralization.
5
+ */
6
+ export function getGroupText (count: number): string {
7
+ const groupText = config.notificationsGrouping.texts?.groupText ?? DEFAULT_NOTIFICATION_TEXTS.groupText
8
+ if (typeof groupText === 'function')
9
+ return groupText(count)
10
+
11
+ return groupText.replace('{count}', String(count))
12
+ }
13
+
14
+ /**
15
+ * Get notification texts config for native side (serializable).
16
+ */
17
+ export function getNotificationTextsForNative (): Record<string, string> {
18
+ const texts = config.notificationsGrouping.texts ?? DEFAULT_NOTIFICATION_TEXTS
19
+ return {
20
+ downloadTitle: texts.downloadTitle ?? DEFAULT_NOTIFICATION_TEXTS.downloadTitle,
21
+ downloadStarting: texts.downloadStarting ?? DEFAULT_NOTIFICATION_TEXTS.downloadStarting,
22
+ downloadProgress: texts.downloadProgress ?? DEFAULT_NOTIFICATION_TEXTS.downloadProgress,
23
+ downloadPaused: texts.downloadPaused ?? DEFAULT_NOTIFICATION_TEXTS.downloadPaused,
24
+ downloadFinished: texts.downloadFinished ?? DEFAULT_NOTIFICATION_TEXTS.downloadFinished,
25
+ downloadCancel: texts.downloadCancel ?? DEFAULT_NOTIFICATION_TEXTS.downloadCancel,
26
+ groupTitle: texts.groupTitle ?? DEFAULT_NOTIFICATION_TEXTS.groupTitle,
27
+ // For native side, we send a pattern with {count} placeholder
28
+ groupText: typeof texts.groupText === 'function'
29
+ ? '{count} download(s) in progress' // Default pattern if function provided
30
+ : (texts.groupText ?? '{count} download(s) in progress'),
31
+ }
32
+ }
package/src/types.ts CHANGED
@@ -21,6 +21,9 @@ export interface NotificationTexts {
21
21
  downloadPaused?: string
22
22
  /** Text shown when download is finished (default: "Download complete") */
23
23
  downloadFinished?: string
24
+ /** Label of the Cancel action on the progress notification (default: "Cancel").
25
+ * Android 14+ only, and only when `showCancelAction` is enabled */
26
+ downloadCancel?: string
24
27
  /** Title for group summary notification (default: "Downloads") */
25
28
  groupTitle?: string
26
29
  /** Text pattern for group summary. Use {count} for number of downloads.
@@ -74,6 +77,19 @@ export interface Config {
74
77
  allowsCellularAccess?: boolean
75
78
  /** Show download notifications (Android only, default: false). When false, creates minimal silent notifications (UIDT requires a notification) */
76
79
  showNotificationsEnabled?: boolean
80
+ /**
81
+ * Post a "download complete" notification when a download finishes
82
+ * (Android 14+ only, default: false). Tapping it opens the saved file.
83
+ * Requires `showNotificationsEnabled`; ignored in `summaryOnly` grouping mode.
84
+ */
85
+ showCompletionNotification?: boolean
86
+ /**
87
+ * Add a Cancel button to the download notification (Android 14+ only, default: false).
88
+ * Tapping it stops the download and fires the task's `.error()` handler with
89
+ * `errorCode = -1`, so only enable it if your app handles that.
90
+ * Requires `showNotificationsEnabled`.
91
+ */
92
+ showCancelAction?: boolean
77
93
  /** Configuration for notifications grouping on Android */
78
94
  notificationsGrouping?: NotificationsGroupingConfig
79
95
  /**
@@ -151,6 +167,9 @@ export type DownloadParams = {
151
167
  groupId?: string
152
168
  /** Group name displayed in notification (only used when grouping is enabled) */
153
169
  groupName?: string
170
+ /** Notification title for this download, overriding `groupName` and the
171
+ * configured `downloadTitle` text (Android 14+ only) */
172
+ notificationTitle?: string
154
173
  /**
155
174
  * iOS Data Protection level for this download's file (iOS only).
156
175
  * Overrides the global `iosDataProtection` from setConfig.