react-native-blob-util 0.19.11 → 0.21.2

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilPackage.java

@@ -2,7 +2,7 @@ package com.ReactNativeBlobUtil;
 
 import androidx.annotation.Nullable;
 
-import com.facebook.react.TurboReactPackage;
+import com.facebook.react.BaseReactPackage;
 import com.facebook.react.bridge.NativeModule;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.module.model.ReactModuleInfo;
@@ -11,7 +11,9 @@ import com.facebook.react.module.model.ReactModuleInfoProvider;
 import java.util.HashMap;
 import java.util.Map;
 
-public class ReactNativeBlobUtilPackage extends TurboReactPackage {
+// trick autolinking till it is fixed on RN side
+//public class ReactNativeBlobUtilPackage extends TurboReactPackage {
+public class ReactNativeBlobUtilPackage extends BaseReactPackage {
 
     @Nullable
     @Override
@@ -35,7 +37,6 @@ public class ReactNativeBlobUtilPackage extends TurboReactPackage {
                             ReactNativeBlobUtilImpl.NAME,
                             false, // canOverrideExistingModule
                             false, // needsEagerInit
-                            true, // hasConstants
                             false, // isCxxModule
                             isTurboModule // isTurboModule
                     ));

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilReq.java

@@ -24,6 +24,7 @@ import androidx.annotation.NonNull;
 import com.ReactNativeBlobUtil.Response.ReactNativeBlobUtilDefaultResp;
 import com.ReactNativeBlobUtil.Response.ReactNativeBlobUtilFileResp;
 import com.ReactNativeBlobUtil.Utils.Tls12SocketFactory;
+import com.ReactNativeBlobUtil.ReactNativeBlobUtilFS;
 import com.facebook.common.logging.FLog;
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.Callback;
@@ -32,6 +33,7 @@ import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.ReadableMapKeySetIterator;
 import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
+import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
 
 import java.io.File;
@@ -114,6 +116,7 @@ public class ReactNativeBlobUtilReq extends BroadcastReceiver implements Runnabl
     String url;
     String rawRequestBody;
     String destPath;
+    String customPath;
     ReadableArray rawRequestBodyArray;
     ReadableMap headers;
     Callback callback;
@@ -234,7 +237,7 @@ public class ReactNativeBlobUtilReq extends BroadcastReceiver implements Runnabl
 
     @Override
     public void run() {
-
+        Context appCtx = ReactNativeBlobUtilImpl.RCTContext.getApplicationContext();
         // use download manager instead of default HTTP implementation
         if (options.addAndroidDownloads != null && options.addAndroidDownloads.hasKey("useDownloadManager")) {
 
@@ -253,14 +256,50 @@ public class ReactNativeBlobUtilReq extends BroadcastReceiver implements Runnabl
                     req.setDescription(options.addAndroidDownloads.getString("description"));
                 }
                 if (options.addAndroidDownloads.hasKey("path")) {
-                    req.setDestinationUri(Uri.parse("file://" + options.addAndroidDownloads.getString("path")));
+                    String path = options.addAndroidDownloads.getString("path");
+                    File f = new File(path);
+                    File dir = f.getParentFile();
+
+                if (!f.exists()) {
+                    if (dir != null && !dir.exists()) {
+                        if (!dir.mkdirs() && !dir.exists()) {
+                            invoke_callback( "Failed to create parent directory of '" + path + "'", null, null);
+                            return;
+                        }
+                    }
+                }
+                    req.setDestinationUri(Uri.parse("file://" + path));
+
+                    customPath = path;
+                }
+
+
+                if (options.addAndroidDownloads.hasKey("storeLocal") && options.addAndroidDownloads.getBoolean("storeLocal")) {
+                    String path = (String) ReactNativeBlobUtilFS.getSystemfolders(ReactNativeBlobUtilImpl.RCTContext).get("DownloadDir");
+                    path = path + UUID.randomUUID().toString();
+
+                    File f = new File(path);
+                    File dir = f.getParentFile();
+                    if (!f.exists()) {
+                        if (dir != null && !dir.exists()) {
+                            if (!dir.mkdirs() && !dir.exists()) {
+                                invoke_callback( "Failed to create parent directory of '" + path + "'", null, null);
+                                return;
+                            }
+                        }
+                    }
+                    req.setDestinationUri(Uri.parse("file://" + path));
+                    customPath = path;
                 }
+
                 if (options.addAndroidDownloads.hasKey("mime")) {
                     req.setMimeType(options.addAndroidDownloads.getString("mime"));
                 }
+
                 if (options.addAndroidDownloads.hasKey("mediaScannable") && options.addAndroidDownloads.getBoolean("mediaScannable")) {
                     req.allowScanningByMediaScanner();
                 }
+
                 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q && options.addAndroidDownloads.hasKey("storeInDownloads") && options.addAndroidDownloads.getBoolean("storeInDownloads")) {
                     String t = options.addAndroidDownloads.getString("title");
                     if(t == null || t.isEmpty())
@@ -288,7 +327,7 @@ public class ReactNativeBlobUtilReq extends BroadcastReceiver implements Runnabl
                 } catch (MalformedURLException e) {
                     e.printStackTrace();
                 }
-                Context appCtx = ReactNativeBlobUtilImpl.RCTContext.getApplicationContext();
+
                 DownloadManager dm = (DownloadManager) appCtx.getSystemService(Context.DOWNLOAD_SERVICE);
                 downloadManagerId = dm.enqueue(req);
                 androidDownloadManagerTaskTable.put(taskId, Long.valueOf(downloadManagerId));
@@ -296,7 +335,7 @@ public class ReactNativeBlobUtilReq extends BroadcastReceiver implements Runnabl
                     appCtx.registerReceiver(this, new IntentFilter(DownloadManager.ACTION_DOWNLOAD_COMPLETE), Context.RECEIVER_EXPORTED);
                 }else{
                     appCtx.registerReceiver(this, new IntentFilter(DownloadManager.ACTION_DOWNLOAD_COMPLETE));
-                }                
+                }
                 future = scheduledExecutorService.scheduleAtFixedRate(new Runnable() {
                     @Override
                     public void run() {
@@ -915,9 +954,9 @@ public class ReactNativeBlobUtilReq extends BroadcastReceiver implements Runnabl
                 }
 
                 // When the file is not found in media content database, check if custom path exists
-                if (options.addAndroidDownloads.hasKey("path")) {
+                if (options.addAndroidDownloads.hasKey("path") || options.addAndroidDownloads.hasKey("storeLocal")) {
                     try {
-                        String customDest = options.addAndroidDownloads.getString("path");
+                        String customDest = customPath;
                         boolean exists = new File(customDest).exists();
                         if (!exists)
                             throw new Exception("Download manager download failed, the file does not downloaded to destination.");

package/index.d.ts

@@ -448,7 +448,7 @@ export interface FS {
 
     dirs: Dirs;
 
-    slice(src: string, dest: string, start: number, end: number): Promise<void>;
+    slice(src: string, dest: string, start: number, end: number): Promise<string>;
 
     asset(path: string): string;
 
@@ -771,7 +771,7 @@ export interface AddAndroidDownloads {
      */
     description?: string;
     /**
-     * The destination which the file will be downloaded, it SHOULD be a location on external storage (DCIMDir).
+     * The destination which the file will be downloaded, it SHOULD be a location on external storage (DCIMDir). CacheDir and DocumentDir don't work
      */
     path?: string;
     /**
@@ -779,7 +779,7 @@ export interface AddAndroidDownloads {
      */
     mime?: string;
     /**
-     * A boolean value, see Officail Document
+     * A boolean value, see Official Document
      * (https://developer.android.com/reference/android/app/DownloadManager.html#addCompletedDownload(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, long, boolean))
      */
     mediaScannable?: boolean;
@@ -791,6 +791,11 @@ export interface AddAndroidDownloads {
      * A boolean value decide whether show a notification when download complete.
      */
     notification?: boolean;
+
+    /**
+     * If true android download manager will try to save the file to the apps Download direcotry
+     */
+    storeLocal?: boolean
 }
 
 export interface ReactNativeBlobUtilResponseInfo {

package/index.js.flow

@@ -1,190 +1,191 @@
 // @flow strict
 
 declare class AndroidApi {
-  actionViewIntent(path: string, mime?: string): Promise<void>;
-  addCompleteDownload(options: AndroidDownloadOption): Promise<void>;
-  getContentIntent(mime: string): Promise<string>;
-  getSDCardApplicationDir(): Promise<string>;
-  getSDCardDir(): Promise<string>;
+    actionViewIntent(path: string, mime?: string): Promise<void>;
+    addCompleteDownload(options: AndroidDownloadOption): Promise<void>;
+    getContentIntent(mime: string): Promise<string>;
+    getSDCardApplicationDir(): Promise<string>;
+    getSDCardDir(): Promise<string>;
 }
 
 declare class FetchBlobResponse {
-  data: string;
-  respInfo: ReactNativeBlobUtilResponseInfo;
-  taskId: string;
-  type: "utf8" | "base64" | "path";
-  array(): Promise<number[]>;
-  base64(): string | Promise<string>;
-  blob(): Promise<Blob>;
-  flush(): Promise<void>;
-  info(): ReactNativeBlobUtilResponseInfo;
-  // $FlowExpectedError Not possible to specify in strict mode.
-  json(): any;
-  path(): string;
-  readFile(encoding: Encoding): ?Promise<number[] | string>;
-  readStream(encoding: Encoding): ?Promise<ReactNativeBlobUtilReadStream>;
-  session(name: string): ?ReactNativeBlobUtilSession;
-  text(): string | Promise<string>;
+    data: string;
+    respInfo: ReactNativeBlobUtilResponseInfo;
+    taskId: string;
+    type: "utf8" | "base64" | "path";
+    array(): Promise<number[]>;
+    base64(): string | Promise<string>;
+    blob(): Promise<Blob>;
+    flush(): Promise<void>;
+    info(): ReactNativeBlobUtilResponseInfo;
+    // $FlowExpectedError Not possible to specify in strict mode.
+    json(): any;
+    path(): string;
+    readFile(encoding: Encoding): ?Promise<number[] | string>;
+    readStream(encoding: Encoding): ?Promise<ReactNativeBlobUtilReadStream>;
+    session(name: string): ?ReactNativeBlobUtilSession;
+    text(): string | Promise<string>;
 }
 
 declare class FsApi {
-  ReactNativeBlobUtilSession: ReactNativeBlobUtilSession;
-  dirs: Dirs;
-  appendFile(path: string, data: string | number[], encoding?: Encoding | "uri"): Promise<number>;
-  asset(path: string): string;
-  cp(path: string, dest: string): Promise<boolean>;
-  createFile(path: string, data: string, encoding: Encoding | "uri"): Promise<string>;
-  df(): Promise<AndroidFsStat | IosFsStat>;
-  exists(path: string): Promise<boolean>;
-  hash(path: string, algorithm: HashAlgorithm): Promise<string>;
-  isDir(path: string): Promise<boolean>;
-  ls(path: string): Promise<string[]>;
-  lstat(path: string): Promise<ReactNativeBlobUtilStat[]>;
-  mkdir(path: string): Promise<boolean>;
-  mv(path: string, dest: string): Promise<boolean>;
-  pathForAppGroup(groupName: string): Promise<string>;
-  readFile(path: string, encoding: Encoding, bufferSize?: number): Promise<number[] | string>;
-  readStream(path: string, encoding: Encoding, bufferSize?: number, tick?: number): Promise<ReactNativeBlobUtilReadStream>;
-  scanFile(pairs: {mime: string, path: string}[]): Promise<void>;
-  session(name: string): ReactNativeBlobUtilSession;
-  slice(src: string, dest: string, start: number, end: number): Promise<string>;
-  stat(path: string): Promise<ReactNativeBlobUtilStat>;
-  unlink(path: string): Promise<void>;
-  writeFile(path: string, data: string | number[], encoding?: Encoding | "uri"): Promise<number>;
-  writeStream(path: string, encoding: Encoding, append?: boolean): Promise<ReactNativeBlobUtilWriteStream>;
+    ReactNativeBlobUtilSession: ReactNativeBlobUtilSession;
+    dirs: Dirs;
+    appendFile(path: string, data: string | number[], encoding?: Encoding | "uri"): Promise<number>;
+    asset(path: string): string;
+    cp(path: string, dest: string): Promise<boolean>;
+    createFile(path: string, data: string, encoding: Encoding | "uri"): Promise<string>;
+    df(): Promise<AndroidFsStat | IosFsStat>;
+    exists(path: string): Promise<boolean>;
+    hash(path: string, algorithm: HashAlgorithm): Promise<string>;
+    isDir(path: string): Promise<boolean>;
+    ls(path: string): Promise<string[]>;
+    lstat(path: string): Promise<ReactNativeBlobUtilStat[]>;
+    mkdir(path: string): Promise<boolean>;
+    mv(path: string, dest: string): Promise<boolean>;
+    pathForAppGroup(groupName: string): Promise<string>;
+    readFile(path: string, encoding: Encoding, bufferSize?: number): Promise<number[] | string>;
+    readStream(path: string, encoding: Encoding, bufferSize?: number, tick?: number): Promise<ReactNativeBlobUtilReadStream>;
+    scanFile(pairs: { mime: string, path: string }[]): Promise<void>;
+    session(name: string): ReactNativeBlobUtilSession;
+    slice(src: string, dest: string, start: number, end: number): Promise<string>;
+    stat(path: string): Promise<ReactNativeBlobUtilStat>;
+    unlink(path: string): Promise<void>;
+    writeFile(path: string, data: string | number[], encoding?: Encoding | "uri"): Promise<number>;
+    writeStream(path: string, encoding: Encoding, append?: boolean): Promise<ReactNativeBlobUtilWriteStream>;
 }
 
 declare class IosApi {
-  excludeFromBackupKey(path: string): Promise<void>;
-  openDocument(path: string, scheme?: string): Promise<void>;
-  previewDocument(path: string, scheme?: string): Promise<void>;
+    excludeFromBackupKey(path: string): Promise<void>;
+    openDocument(path: string, scheme?: string): Promise<void>;
+    previewDocument(path: string, scheme?: string): Promise<void>;
 }
 
 declare class ReactNativeBlobUtilReadStream {
-  bufferSize?: number;
-  closed: boolean;
-  encoding: Encoding;
-  path: string;
-  tick: number;
-  onData(fn: (chunk: string) => void): void;
-  onEnd(fn: () => void): void;
-  onError(fn: (err: Error) => void): void;
-  open(): void;
+    bufferSize?: number;
+    closed: boolean;
+    encoding: Encoding;
+    path: string;
+    tick: number;
+    onData(fn: (chunk: string) => void): void;
+    onEnd(fn: () => void): void;
+    onError(fn: (err: Error) => void): void;
+    open(): void;
 }
 
 declare class ReactNativeBlobUtilSession {
-  static getSession(name: string): ReactNativeBlobUtilSession;
-  static removeSession(name: string): void;
-  static setSession(name: string, val: ReactNativeBlobUtilSession): void;
+    static getSession(name: string): ReactNativeBlobUtilSession;
+    static removeSession(name: string): void;
+    static setSession(name: string, val: ReactNativeBlobUtilSession): void;
 
-  name: string;
-  add(path: string): ReactNativeBlobUtilSession;
-  constructor(name: string, list: string[]): ReactNativeBlobUtilSession;
-  dispose(): Promise<void>;
-  list(): string[];
-  remove(path: string): ReactNativeBlobUtilSession;
+    name: string;
+    add(path: string): ReactNativeBlobUtilSession;
+    constructor(name: string, list: string[]): ReactNativeBlobUtilSession;
+    dispose(): Promise<void>;
+    list(): string[];
+    remove(path: string): ReactNativeBlobUtilSession;
 }
 
 declare class ReactNativeBlobUtilWriteStream {
-  append: boolean;
-  encoding: string;
-  id: string;
-  close(): void;
-  write(data: string): Promise<void>;
+    append: boolean;
+    encoding: string;
+    id: string;
+    close(): void;
+    write(data: string): Promise<void>;
 }
 
 declare class ReactNativeBlobUtil {
-  android: AndroidApi;
-  base64: {+decode: (input: string) => string, +encode: (input: string) => string};
-  fs: FsApi;
-  ios: IosApi;
-  config(options: ReactNativeBlobUtilConfig): {fetch: (method: Methods, url: string, headers?: {[key: string]: string}, body?: string | FormField[]) => StatefulPromise<FetchBlobResponse>};
-  fetch(method: Methods, url: string, headers?: {[key: string]: string}, body?: string | FormField[]): StatefulPromise<FetchBlobResponse>;
-  session(name: string): ReactNativeBlobUtilSession;
-  wrap(path: string): string;
+    android: AndroidApi;
+    base64: { +decode: (input: string) => string, +encode: (input: string) => string };
+    fs: FsApi;
+    ios: IosApi;
+    config(options: ReactNativeBlobUtilConfig): { fetch: (method: Methods, url: string, headers?: { [key: string]: string }, body?: string | FormField[]) => StatefulPromise<FetchBlobResponse> };
+    fetch(method: Methods, url: string, headers?: { [key: string]: string }, body?: string | FormField[]): StatefulPromise<FetchBlobResponse>;
+    session(name: string): ReactNativeBlobUtilSession;
+    wrap(path: string): string;
 }
 
 declare class StatefulPromise<T> extends Promise<T> {
-  cancel(callback?: (error: ?string, taskId: ?string) => void): void;
-  expire(callback: () => void): StatefulPromise<void>;
-  progress(config: {count?: number, interval?: number} | ProgressCallback, callback?: ProgressCallback): StatefulPromise<T>;
-  stateChange(callback: (state: ReactNativeBlobUtilResponseInfo) => void): StatefulPromise<T>;
-  uploadProgress(config: {count?: number, interval?: number} | UploadProgressCallback, callback?: UploadProgressCallback): StatefulPromise<T>;
+    cancel(callback?: (error: ?string, taskId: ?string) => void): void;
+    expire(callback: () => void): StatefulPromise<void>;
+    progress(config: { count?: number, interval?: number } | ProgressCallback, callback?: ProgressCallback): StatefulPromise<T>;
+    stateChange(callback: (state: ReactNativeBlobUtilResponseInfo) => void): StatefulPromise<T>;
+    uploadProgress(config: { count?: number, interval?: number } | UploadProgressCallback, callback?: UploadProgressCallback): StatefulPromise<T>;
 }
 
 export type AddAndroidDownloads = {
-  description?: string,
-  mediaScannable?: boolean,
-  mime?: string,
-  notification?: boolean,
-  path?: string,
-  title?: string,
-  useDownloadManager?: boolean
+    description?: string,
+    mediaScannable?: boolean,
+    mime?: string,
+    notification?: boolean,
+    path?: string,
+    title?: string,
+    useDownloadManager?: boolean,
+    storeLocal: boolean
 };
 export type AndroidDownloadOption = {
-  description?: string,
-  mime?: string,
-  path: string,
-  showNotification?: boolean,
-  title?: string
+    description?: string,
+    mime?: string,
+    path: string,
+    showNotification?: boolean,
+    title?: string
 };
 export type AndroidFsStat = {
-  external_free: number,
-  external_total: number,
-  internal_free: number,
-  internal_total: number
+    external_free: number,
+    external_total: number,
+    internal_free: number,
+    internal_total: number
 };
 export type Dirs = {
-  CacheDir: string,
-  DCIMDir: string,
-  DocumentDir: string,
-  DownloadDir: string,
-  LibraryDir: string,
-  MainBundleDir: string,
-  MovieDir: string,
-  MusicDir: string,
-  PictureDir: string,
-  SDCardApplicationDir: string,
-  SDCardDir: string
+    CacheDir: string,
+    DCIMDir: string,
+    DocumentDir: string,
+    DownloadDir: string,
+    LibraryDir: string,
+    MainBundleDir: string,
+    MovieDir: string,
+    MusicDir: string,
+    PictureDir: string,
+    SDCardApplicationDir: string,
+    SDCardDir: string
 };
 export type Encoding = "utf8" | "ascii" | "base64";
-export type FormField = {data: string, filename?: string, name: string, type?: string};
+export type FormField = { data: string, filename?: string, name: string, type?: string };
 export type HashAlgorithm = "md5" | "sha1" | "sha224" | "sha256" | "sha384" | "sha512";
-export type IosFsStat = {free: number, total: number};
+export type IosFsStat = { free: number, total: number };
 export type Methods = "POST" | "GET" | "DELETE" | "PUT" | "post" | "get" | "delete" | "put";
 export type ProgressCallback = (received: number, total: number) => void;
 export type ReactNativeBlobUtilConfig = {
-  Progress?: { count?: number, interval?: number },
-  UploadProgress?: { count?: number, interval?: number },
-  IOSBackgroundTask?: boolean,
-  addAndroidDownloads?: AddAndroidDownloads,
-  appendExt?: string,
-  fileCache?: boolean,
-  indicator?: boolean,
-  overwrite?: boolean,
-  path?: string,
-  session?: string,
-  timeout?: number,
-  trusty?: boolean,
-  wifiOnly?: boolean,
-  followRedirect?: boolean
+    Progress?: { count?: number, interval?: number },
+    UploadProgress?: { count?: number, interval?: number },
+    IOSBackgroundTask?: boolean,
+    addAndroidDownloads?: AddAndroidDownloads,
+    appendExt?: string,
+    fileCache?: boolean,
+    indicator?: boolean,
+    overwrite?: boolean,
+    path?: string,
+    session?: string,
+    timeout?: number,
+    trusty?: boolean,
+    wifiOnly?: boolean,
+    followRedirect?: boolean
 };
 export type ReactNativeBlobUtilResponseInfo = {
-  headers: {[fieldName: string]: string},
-  redirects: string[],
-  respType: "text" | "blob" | "" | "json",
-  rnfbEncode: "path" | Encoding,
-  state: string,
-  status: number,
-  taskId: string,
-  timeout: boolean
+    headers: { [fieldName: string]: string },
+    redirects: string[],
+    respType: "text" | "blob" | "" | "json",
+    rnfbEncode: "path" | Encoding,
+    state: string,
+    status: number,
+    taskId: string,
+    timeout: boolean
 };
 export type ReactNativeBlobUtilStat = {
-  filename: string,
-  lastModified: number,
-  path: string,
-  size: number,
-  type: "directory" | "file" | "asset"
+    filename: string,
+    lastModified: number,
+    path: string,
+    size: number,
+    type: "directory" | "file" | "asset"
 };
 export type UploadProgressCallback = (sent: number, total: number) => void;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "react-native-blob-util",
-    "version": "0.19.11",
+    "version": "0.21.2",
     "description": "A module provides upload, download, and files access API. Supports file stream read/write for process large files.",
     "main": "index",
     "scripts": {

package/types.js

@@ -2,16 +2,16 @@
 export type ReactNativeBlobUtilConfig = {
   Progress: any,
   UploadProgress: any,
-  fileCache : bool,
+  fileCache : boolean,
   transformFile: boolean;
   path : string,
   appendExt : string,
   session : string,
   addAndroidDownloads : any,
-  indicator : bool,
-  followRedirect : bool,
-  trusty : bool,
-  wifiOnly : bool
+  indicator : boolean,
+  followRedirect : boolean,
+  trusty : boolean,
+  wifiOnly : boolean
 };
 
 export type ReactNativeBlobUtilNative = {