react-native-blob-util 0.13.18 → 0.14.0

package/index.d.ts

@@ -6,17 +6,25 @@
 export const ReactNativeBlobUtil: ReactNativeBlobUtilStatic;
 export type ReactNativeBlobUtil = ReactNativeBlobUtilStatic;
 export default ReactNativeBlobUtil;
+import {filedescriptor} from './types';
 
 interface ReactNativeBlobUtilStatic {
     fetch(method: Methods, url: string, headers?: { [key: string]: string }, body?: any
         | null): StatefulPromise<FetchBlobResponse>;
+
     base64: { encode(input: string): string; decode(input: string): string };
     android: AndroidApi;
     ios: IOSApi;
+
     config(options: ReactNativeBlobUtilConfig): ReactNativeBlobUtilStatic;
+
     session(name: string): ReactNativeBlobUtilSession;
+
     fs: FS;
+    MediaCollection: MediaCollection;
+
     wrap(path: string): string;
+
     net: Net;
     polyfill: Polyfill;
     // this require external module https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/oboe
@@ -45,10 +53,15 @@ export declare class ReactNativeBlobUtilFetchPolyfill {
 
 export interface ReactNativeBlobUtilFetchRepsonse {
     arrayBuffer(): Promise<any[]>;
+
     blob(): Promise<PolyfillBlob>;
+
     json(): Promise<any>;
+
     rawResp(): Promise<FetchBlobResponse>;
+
     text(): Promise<string>;
+
     bodyUsed: boolean;
     headers: any;
     ok: boolean;
@@ -64,46 +77,58 @@ export interface ReactNativeBlobUtilFetchRepsonse {
  */
 export interface FetchBlobResponse {
     taskId: string;
+
     /**
      * get path of response temp file
      * @return File path of temp file.
      */
     path(): string;
+
     type: "base64" | "path" | "utf8";
     data: any;
+
     /**
      * Convert result to javascript ReactNativeBlobUtil object.
      * @return Return a promise resolves Blob object.
      */
     blob(contentType: string, sliceSize: number): Promise<PolyfillBlob>;
+
     /**
      * Convert result to text.
      * @return Decoded base64 string.
      */
     text(): string | Promise<any>;
+
     /**
      * Convert result to JSON object.
      * @return Parsed javascript object.
      */
     json(): any;
+
     /**
      * Return BASE64 string directly.
      * @return BASE64 string of response body.
      */
     base64(): any;
+
     /**
      * Remove cahced file
      */
     flush(): void;
+
     respInfo: ReactNativeBlobUtilResponseInfo;
+
     info(): ReactNativeBlobUtilResponseInfo;
+
     session(name: string): ReactNativeBlobUtilSession | null;
+
     /**
      * Read file content with given encoding, if the response does not contains
      * a file path, show warning message
      * @param  encode Encode type, should be one of `base64`, `ascrii`, `utf8`.
      */
     readFile(encode: Encoding): Promise<any> | null;
+
     /**
      * Start read stream from cached file
      * @param  encode Encode type, should be one of `base64`, `ascrii`, `utf8`.
@@ -113,17 +138,27 @@ export interface FetchBlobResponse {
 
 export interface PolyfillFileReader extends EventTarget {
     isRNFBPolyFill: boolean;
+
     onloadstart(e: Event): void;
+
     onprogress(e: Event): void;
+
     onload(e: Event): void;
+
     onabort(e: Event): void;
+
     onerror(e: Event): void;
+
     onloadend(e: Event): void;
 
     abort(): void;
+
     readAsArrayBuffer(b: PolyfillBlob): void;
+
     readAsBinaryString(b: PolyfillBlob): void;
+
     readAsText(b: PolyfillBlob, label?: string): void;
+
     readAsDataURL(b: PolyfillBlob): void;
 
     readyState: number;
@@ -242,6 +277,7 @@ export interface PolyfillXMLHttpRequest extends PolyfillXMLHttpRequestEventTarge
     getAllResponseHeaders(): string | null;
 
     onreadystatechange(e: Event): void;
+
     readyState: number;
     status: number;
     statusText: string;
@@ -270,11 +306,17 @@ export declare namespace PolyfillXMLHttpRequest {
 
 export interface PolyfillXMLHttpRequestEventTarget extends EventTarget {
     onabort(e: Event): void;
+
     onerror(e: Event): void;
+
     onload(e: Event): void;
+
     onloadstart(e: Event): void;
+
     onprogress(e: Event): void;
+
     ontimeout(e: Event): void;
+
     onloadend(e: Event): void;
 }
 
@@ -295,6 +337,7 @@ export interface Net {
 }
 
 type HashAlgorithm = "md5" | "sha1" | "sha224" | "sha256" | "sha384" | "sha512";
+
 export interface FS {
     ReactNativeBlobUtilSession: ReactNativeBlobUtilSession;
 
@@ -364,6 +407,7 @@ export interface FS {
      * @param  encoding Encoding of read stream.
      */
     readFile(path: string, encoding: Encoding, bufferSize?: number): Promise<any>;
+
     /**
      * Check if file exists and if it is a folder.
      * @param  path Path to check
@@ -391,7 +435,9 @@ export interface FS {
     dirs: Dirs;
 
     slice(src: string, dest: string, start: number, end: number): Promise<void>;
+
     asset(path: string): string;
+
     df(): Promise<RNFetchBlobDf>;
 }
 
@@ -428,6 +474,7 @@ export interface ReactNativeBlobUtilWriteStream {
     append: boolean;
 
     write(data: string): Promise<void>;
+
     close(): void;
 }
 
@@ -526,7 +573,7 @@ export interface AndroidApi {
     actionViewIntent(path: string, mime: string, chooserTitle?: string): Promise<boolean | null>;
 
     /**
-     * 
+     *
      * This method brings up OS default file picker and resolves a file URI when the user selected a file.
      * However, it does not resolve or reject when user dismiss the file picker via pressing hardware back button,
      * but you can still handle this behavior via AppState.
@@ -717,7 +764,9 @@ export interface ReactNativeBlobUtilResponseInfo {
 
 export interface ReactNativeBlobUtilStream {
     onData(): void;
+
     onError(): void;
+
     onEnd(): void;
 }
 
@@ -731,3 +780,45 @@ export declare class ReactNativeBlobUtilStat {
     path: string;
     filename: string;
 }
+
+export type Mediatype = "Audio" | "Image" | "Video" | "Download";
+
+export interface MediaCollection {
+    /**
+     * Creates a new File in the collection.
+     * Promise will resolve to content UIR or error message
+     * @param filedata descriptor for the media store entry
+     * @param mediatype
+     * @param path path of the file being copied
+     */
+    copyToMediaStore(filedata: filedescriptor, mediatype: Mediatype, path: string): Promise<string>;
+
+
+    /**
+     * Creates a new File in the collection.
+     * @param filedata
+     * @param mediatype
+     */
+    createMediafile(filedata: filedescriptor, mediatype: Mediatype): Promise<string>;
+
+    /**
+     * Copies an existing file to a mediastore file
+     * @param uri URI of the destination mediastore file
+     * @param path Path to the existing file which should be copied
+     */
+    writeToMediafile(uri: string, path: string): Promise<string>
+
+    /**
+     * Copies a file from the mediastore to the apps internal storage
+     * @param contenturi URI of the mediastore file
+     * @param destpath Path for the file in the internal storage
+     */
+    copyToInternal(contenturi: string, destpath: string): Promise<string>
+
+    /**
+     * Gets the blob data for a given URI in the mediastore
+     * @param contenturi
+     * @param encoding
+     */
+    getBlob(contenturi: string, encoding: string): Promise<string>
+}

package/index.js

@@ -6,6 +6,7 @@ import {AppState, DeviceEventEmitter, NativeModules, Platform,} from 'react-nati
 
 //import StatefulPromise from './class/StatefulPromise.js'
 import fs from './fs';
+import MediaCollection from './mediacollection';
 import base64 from 'base-64';
 import polyfill from './polyfill';
 import android from './android';
@@ -69,4 +70,5 @@ export default {
     wrap,
     polyfill,
     JSONStream,
+    MediaCollection
 };

package/ios/ReactNativeBlobUtil/ReactNativeBlobUtil.m

@@ -76,6 +76,7 @@ RCT_EXPORT_MODULE();
              @"MovieDir" : [ReactNativeBlobUtilFS getMovieDir],
              @"MusicDir" : [ReactNativeBlobUtilFS getMusicDir],
              @"PictureDir" : [ReactNativeBlobUtilFS getPictureDir],
+             @"ApplicationSupportDir" : [ReactNativeBlobUtilFS getApplicationSupportDir],
              };
 }
 
@@ -535,7 +536,7 @@ RCT_EXPORT_METHOD(readStream:(NSString *)path withEncoding:(NSString *)encoding
     });
 }
 
-#pragma mark - fs.getEnvionmentDirs
+#pragma mark - fs.getEnvironmentDirs
 RCT_EXPORT_METHOD(getEnvironmentDirs:(RCTResponseSenderBlock) callback)
 {
 

package/ios/ReactNativeBlobUtilFS.h

@@ -54,6 +54,7 @@
 + (NSString *) getMovieDir;
 + (NSString *) getMusicDir;
 + (NSString *) getPictureDir;
++ (NSString *) getApplicationSupportDir;
 + (NSString *) getTempPath;
 + (NSString *) getTempPath:(NSString*)taskId withExtension:(NSString *)ext;
 + (NSString *) getPathOfAsset:(NSString *)assetURI;

package/ios/ReactNativeBlobUtilFS.m

@@ -124,6 +124,10 @@ NSMutableDictionary *fileStreams = nil;
     return [NSSearchPathForDirectoriesInDomains(NSPicturesDirectory, NSUserDomainMask, YES) firstObject];
 }
 
++ (NSString *) getApplicationSupportDir {
+    return [NSSearchPathForDirectoriesInDomains(NSApplicationSupportDirectory, NSUserDomainMask, YES) firstObject];
+}
+
 + (NSString *) getTempPath {
 
     return NSTemporaryDirectory();

package/mediacollection.js

@@ -0,0 +1,33 @@
+import {NativeModules} from 'react-native';
+import type {ReactNativeBlobUtilNative, filedescriptor} from "types";
+
+const ReactNativeBlobUtil: ReactNativeBlobUtilNative = NativeModules.ReactNativeBlobUtil;
+
+function createMediafile(fd: filedescriptor, mediatype: string): Promise {
+    if ((!'parentFolder' in fd)) fd['parentFolder'] = '';
+    return ReactNativeBlobUtil.createMediaFile(fd, mediatype);
+}
+
+function writeToMediafile(uri: string, path: string) {
+    return ReactNativeBlobUtil.writeToMediaFile(uri, path);
+}
+
+function copyToInternal(contenturi: string, destpath: string) {
+    return ReactNativeBlobUtil.copyToInternal(contenturi, destpath);
+}
+
+function getBlob(contenturi: string, encoding: string) {
+    return ReactNativeBlobUtil.getBlob(contenturi, encoding);
+}
+
+function copyToMediaStore(fd: filedescriptor, mediatype: string, path: string) {
+    return ReactNativeBlobUtil.copyToMediaStore(fd, mediatype, path);
+}
+
+export default {
+    createMediafile,
+    writeToMediafile,
+    copyToInternal,
+    getBlob,
+    copyToMediaStore
+};

package/package.json

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

package/scripts/prelink.js

@@ -67,5 +67,5 @@ try {
     '\033[95mreact-native-blob-util\033[97m link \033[91mFAILED \033[97m\nCould not automatically link package :'+
     err.stack +
     'please follow the instructions to manually link the library : ' +
-    '\033[4mhttps://github.com/joltup/react-native-blob-util/wiki/Manually-Link-Package\n')
+    '\033[4mhttps://github.com/RonRadtke/react-native-blob-util/wiki/Manually-Link-Package\n')
 }

package/types.js

@@ -64,3 +64,6 @@ export type ReactNativeBlobUtilStream = {
   _onEnd : () => void,
   _onError : () => void,
 }
+
+
+export type filedescriptor = { path: string, parentFolder: string, mimeType: string }