@hxa-rn/rn-fetch-blob 0.12.0

package/src/class/RNFetchBlobWriteStream.js

@@ -0,0 +1,57 @@
+// Copyright 2016 wkh237@github. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+
+import {
+ DeviceEventEmitter,
+ NativeAppEventEmitter,
+} from 'react-native'
+import NativeRNFetchBlob from '../specs/v1/NativeRNFetchBlob'
+
+const RNFetchBlob = NativeRNFetchBlob
+
+export default class RNFetchBlobWriteStream {
+
+  id : string;
+  encoding : string;
+  append : boolean;
+
+  constructor(streamId:string, encoding:string, append:boolean) {
+    this.id = streamId
+    this.encoding = encoding
+    this.append = append
+  }
+
+  write(data:string): Promise<RNFetchBlobWriteStream> {
+    return new Promise((resolve, reject) => {
+      try {
+        let method = this.encoding === 'ascii' ? 'writeArrayChunk' : 'writeChunk'
+        if(this.encoding.toLocaleLowerCase() === 'ascii' && !Array.isArray(data)) {
+            reject(new Error('ascii input data must be an Array'))
+            return
+        }
+        RNFetchBlob[method](this.id, data, (error) => {
+          if(error)
+            reject(new Error(error))
+          else
+            resolve(this)
+        })
+      } catch(err) {
+        reject(new Error(err))
+      }
+    })
+  }
+
+  close() {
+    return new Promise((resolve, reject) => {
+      try {
+        NativeRNFetchBlob.closeStream(this.id, () => {
+          resolve()
+        })
+      } catch (err) {
+        reject(new Error(err))
+      }
+    })
+  }
+
+}

package/src/class/StatefulPromise.js

@@ -0,0 +1,7 @@
+// Copyright 2016 wkh237@github. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+
+export default class StatefulPromise extends Promise {
+
+}

package/src/fs.js

@@ -0,0 +1,432 @@
+// Copyright 2016 wkh237@github. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+
+// import type {RNFetchBlobConfig, RNFetchBlobNative, RNFetchBlobStream} from './types'
+
+import {Platform} from 'react-native'
+import NativeRNFetchBlob from './specs/v1/NativeRNFetchBlob'
+import RNFetchBlobSession from './class/RNFetchBlobSession'
+import RNFetchBlobWriteStream from './class/RNFetchBlobWriteStream'
+import RNFetchBlobReadStream from './class/RNFetchBlobReadStream'
+import RNFetchBlobFile from './class/RNFetchBlobFile'
+
+const RNFetchBlob: RNFetchBlobNative = NativeRNFetchBlob
+
+const dirs = {
+  DocumentDir :  NativeRNFetchBlob.getConstants().DocumentDir,
+  CacheDir : NativeRNFetchBlob.getConstants().CacheDir,
+  PictureDir : NativeRNFetchBlob.getConstants().PictureDir,
+  MusicDir : NativeRNFetchBlob.getConstants().MusicDir,
+  MovieDir : NativeRNFetchBlob.getConstants().MovieDir,
+  DownloadDir : NativeRNFetchBlob.getConstants().DownloadDir,
+  DCIMDir : NativeRNFetchBlob.getConstants().DCIMDir,
+  SDCardDir: NativeRNFetchBlob.getConstants().SDCardDir, // Depracated
+  SDCardApplicationDir: NativeRNFetchBlob.getConstants().SDCardApplicationDir, // Deprecated
+  MainBundleDir : NativeRNFetchBlob.getConstants().MainBundleDir,
+  LibraryDir : NativeRNFetchBlob.getConstants().LibraryDir
+}
+
+function addCode(code: string, error: Error): Error {
+  error.code = code
+  return error
+}
+
+/**
+ * Get a file cache session
+ * @param  {string} name Stream ID
+ * @return {RNFetchBlobSession}
+ */
+function session(name: string): RNFetchBlobSession {
+  let s = RNFetchBlobSession.getSession(name)
+  if (s)
+    return new RNFetchBlobSession(name)
+  else {
+    RNFetchBlobSession.setSession(name, [])
+    return new RNFetchBlobSession(name, [])
+  }
+}
+
+function asset(path: string): string {
+  if (Platform.OS === 'ios') {
+    // path from camera roll
+    if (/^assets-library\:\/\//.test(path))
+      return path
+  }
+  return 'bundle-assets://' + path
+}
+
+function createFile(path: string, data: string, encoding: 'base64' | 'ascii' | 'utf8' = 'utf8'): Promise<string> {
+  if (encoding.toLowerCase() === 'ascii') {
+    return Array.isArray(data) ?
+      NativeRNFetchBlob.createFileASCII(path, data) :
+      Promise.reject(addCode('EINVAL', new TypeError('`data` of ASCII file must be an array with 0..255 numbers')))
+  }
+  else {
+    return NativeRNFetchBlob.createFile(path, data, encoding)
+  }
+}
+
+/**
+ * Create write stream to a file.
+ * @param  {string} path Target path of file stream.
+ * @param  {string} encoding Encoding of input data.
+ * @param  {boolean} [append]  A flag represent if data append to existing ones.
+ * @return {Promise<RNFetchBlobWriteStream>} A promise resolves a `WriteStream` object.
+ */
+function writeStream(
+  path: string,
+  encoding?: 'utf8' | 'ascii' | 'base64' = 'utf8',
+  append?: boolean = false,
+): Promise<RNFetchBlobWriteStream> {
+  if (typeof path !== 'string') {
+    return Promise.reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+  }
+  return new Promise((resolve, reject) => {
+    NativeRNFetchBlob.writeStream(path, encoding, append, (errCode, errMsg, streamId: string) => {
+      if (errMsg) {
+        const err = new Error(errMsg)
+        err.code = errCode
+        reject(err)
+      }
+      else
+        resolve(new RNFetchBlobWriteStream(streamId, encoding))
+    })
+  })
+}
+
+/**
+ * Create file stream from file at `path`.
+ * @param  {string} path   The file path.
+ * @param  {string} encoding Data encoding, should be one of `base64`, `utf8`, `ascii`
+ * @param  {boolean} bufferSize Size of stream buffer.
+ * @param  {number} [tick=10] Interval in milliseconds between reading chunks of data
+ * @return {RNFetchBlobStream} RNFetchBlobStream stream instance.
+ */
+function readStream(
+  path: string,
+  encoding: 'utf8' | 'ascii' | 'base64' = 'utf8',
+  bufferSize?: number,
+  tick?: number = 10
+): Promise<RNFetchBlobReadStream> {
+  if (typeof path !== 'string') {
+    return Promise.reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+  }
+  return Promise.resolve(new RNFetchBlobReadStream(path, encoding, bufferSize, tick))
+}
+
+/**
+ * Create a directory.
+ * @param  {string} path Path of directory to be created
+ * @return {Promise}
+ */
+function mkdir(path: string): Promise {
+  if (typeof path !== 'string') {
+    return Promise.reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+  }
+  return NativeRNFetchBlob.mkdir(path)
+}
+
+/**
+ * Returns the path for the app group.
+ * @param  {string} groupName Name of app group
+ * @return {Promise}
+ */
+function pathForAppGroup(groupName: string): Promise {
+  return NativeRNFetchBlob.pathForAppGroup(groupName)
+}
+
+/**
+ * Returns the path for the app group synchronous.
+ * @param  {string} groupName Name of app group
+ * @return {string} Path of App Group dir
+ */
+function syncPathAppGroup(groupName: string): string {
+  if (Platform.OS === 'ios') {
+    return NativeRNFetchBlob.syncPathAppGroup(groupName);
+  } else {
+    return '';
+  }
+}
+
+/**
+ * Wrapper method of readStream.
+ * @param  {string} path Path of the file.
+ * @param  {'base64' | 'utf8' | 'ascii'} encoding Encoding of read stream.
+ * @return {Promise<Array<number> | string>}
+ */
+function readFile(path: string, encoding: string = 'utf8'): Promise<any> {
+  if (typeof path !== 'string') {
+    return Promise.reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+  }
+  return NativeRNFetchBlob.readFile(path, encoding)
+}
+
+/**
+ * Write data to file.
+ * @param  {string} path  Path of the file.
+ * @param  {string | number[]} data Data to write to the file.
+ * @param  {string} encoding Encoding of data (Optional).
+ * @return {Promise}
+ */
+function writeFile(path: string, data: string | Array<number>, encoding: ?string = 'utf8'): Promise {
+  if (typeof path !== 'string') {
+    return Promise.reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+  }
+  if (encoding.toLocaleLowerCase() === 'ascii') {
+    if (!Array.isArray(data)) {
+      return Promise.reject(addCode('EINVAL', new TypeError('"data" must be an Array when encoding is "ascii"')))
+    }
+    else
+      return NativeRNFetchBlob.writeFileArray(path, data, false)
+  }
+  else {
+    if (typeof data !== 'string') {
+      return Promise.reject(addCode('EINVAL', new TypeError(`"data" must be a String when encoding is "utf8" or "base64", but it is "${typeof data}"`)))
+    }
+    else
+      return NativeRNFetchBlob.writeFile(path, encoding, data, false)
+  }
+}
+
+function appendFile(path: string, data: string | Array<number>, encoding?: string = 'utf8'): Promise<number> {
+  if (typeof path !== 'string') {
+    return Promise.reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+  }
+  if (encoding.toLocaleLowerCase() === 'ascii') {
+    if (!Array.isArray(data)) {
+      return Promise.reject(addCode('EINVAL', new TypeError('`data` of ASCII file must be an array with 0..255 numbers')))
+    }
+    else
+      return NativeRNFetchBlob.writeFileArray(path, data, true)
+  }
+  else {
+    if (typeof data !== 'string') {
+      return Promise.reject(addCode('EINVAL'), new TypeError(`"data" must be a String when encoding is "utf8" or "base64", but it is "${typeof data}"`))
+    }
+    else
+      return NativeRNFetchBlob.writeFile(path, encoding, data, true)
+  }
+}
+
+/**
+ * Show statistic data of a path.
+ * @param  {string} path Target path
+ * @return {RNFetchBlobFile}
+ */
+function stat(path: string): Promise<RNFetchBlobFile> {
+  return new Promise((resolve, reject) => {
+    if (typeof path !== 'string') {
+      return reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+    }
+    NativeRNFetchBlob.stat(path, (err, stat) => {
+      if (err)
+        reject(new Error(err))
+      else {
+        if (stat) {
+          stat.size = parseInt(stat.size)
+          stat.lastModified = parseInt(stat.lastModified)
+        }
+        resolve(stat)
+      }
+    })
+  })
+}
+
+/**
+ * Android only method, request media scanner to scan the file.
+ * @param  {Array<Object<string, string>>} pairs Array contains Key value pairs with key `path` and `mime`.
+ * @return {Promise}
+ */
+function scanFile(pairs: any): Promise {
+  return new Promise((resolve, reject) => {
+    if (pairs === undefined) {
+      return reject(addCode('EINVAL', new TypeError('Missing argument')))
+    }
+    NativeRNFetchBlob.scanFile(pairs, (err) => {
+      if (err)
+        reject(addCode('EUNSPECIFIED', new Error(err)))
+      else
+        resolve()
+    })
+  })
+}
+
+function hash(path: string, algorithm: string): Promise<string> {
+  if (typeof path !== 'string' || typeof algorithm !== 'string') {
+    return Promise.reject(addCode('EINVAL', new TypeError('Missing argument "path" and/or "algorithm"')))
+  }
+  return NativeRNFetchBlob.hash(path, algorithm)
+}
+
+function cp(path: string, dest: string): Promise<boolean> {
+  return new Promise((resolve, reject) => {
+    if (typeof path !== 'string' || typeof dest !== 'string') {
+      return reject(addCode('EINVAL', new TypeError('Missing argument "path" and/or "destination"')))
+    }
+    NativeRNFetchBlob.cp(path, dest, (err, res) => {
+      if (err)
+        reject(addCode('EUNSPECIFIED', new Error(err)))
+      else
+        resolve(res)
+    })
+  })
+}
+
+function mv(path: string, dest: string): Promise<boolean> {
+  return new Promise((resolve, reject) => {
+    if (typeof path !== 'string' || typeof dest !== 'string') {
+      return reject(addCode('EINVAL', new TypeError('Missing argument "path" and/or "destination"')))
+    }
+    NativeRNFetchBlob.mv(path, dest, (err, res) => {
+      if (err)
+        reject(addCode('EUNSPECIFIED', new Error(err)))
+      else
+        resolve(res)
+    })
+  })
+}
+
+function lstat(path: string): Promise<Array<RNFetchBlobFile>> {
+  return new Promise((resolve, reject) => {
+    if (typeof path !== 'string') {
+      return reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+    }
+    NativeRNFetchBlob.lstat(path, (err, stat) => {
+      if (err)
+        reject(addCode('EUNSPECIFIED', new Error(err)))
+      else
+        resolve(stat)
+    })
+  })
+}
+
+function ls(path: string): Promise<Array<String>> {
+  if (typeof path !== 'string') {
+    return Promise.reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+  }
+  return NativeRNFetchBlob.ls(path)
+}
+
+/**
+ * Remove file at path.
+ * @param  {string}   path:string Path of target file.
+ * @return {Promise}
+ */
+function unlink(path: string): Promise {
+  return new Promise((resolve, reject) => {
+    if (typeof path !== 'string') {
+      return reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+    }
+    NativeRNFetchBlob.unlink(path, (err) => {
+      if (err) {
+        reject(addCode('EUNSPECIFIED', new Error(err)))
+      }
+      else
+        resolve()
+    })
+  })
+}
+
+/**
+ * Check if file exists and if it is a folder.
+ * @param  {string} path Path to check
+ * @return {Promise<boolean>}
+ */
+function exists(path: string): Promise<boolean> {
+  return new Promise((resolve, reject) => {
+    if (typeof path !== 'string') {
+      return reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+    }
+    try {
+      NativeRNFetchBlob.exists(path, (exist) => {
+        resolve(exist)
+      })
+    }catch (err){
+      reject(addCode('EUNSPECIFIED', new Error(err)))
+    }
+  })
+
+}
+
+function slice(src: string, dest: string, start: number, end: number): Promise {
+  if (typeof src !== 'string' || typeof dest !== 'string') {
+    return reject(addCode('EINVAL', new TypeError('Missing argument "src" and/or "destination"')))
+  }
+
+  let p = Promise.resolve()
+  let size = 0
+
+  function normalize(num, size) {
+    if (num < 0)
+      return Math.max(0, size + num)
+    if (!num && num !== 0)
+      return size
+    return num
+  }
+
+  if (start < 0 || end < 0 || !start || !end) {
+    p = p.then(() => stat(src))
+      .then((stat) => {
+        size = Math.floor(stat.size)
+        start = normalize(start || 0, size)
+        end = normalize(end, size)
+      })
+  }
+  return p.then(() => NativeRNFetchBlob.slice(src, dest, start, end))
+}
+
+function isDir(path: string): Promise<bool> {
+  return new Promise((resolve, reject) => {
+    if (typeof path !== 'string') {
+      return reject(addCode('EINVAL', new TypeError('Missing argument "path" ')))
+    }
+    try {
+      NativeRNFetchBlob.exists(path, (exist, isDir) => {
+        resolve(isDir)
+      })
+    }catch (err){
+      reject(addCode('EUNSPECIFIED', new Error(err)))
+    }
+  })
+
+}
+
+function df(): Promise<{ free: number, total: number }> {
+  return new Promise((resolve, reject) => {
+    NativeRNFetchBlob.df((err, stat) => {
+      if (err)
+        reject(addCode('EUNSPECIFIED', new Error(err)))
+      else
+        resolve(stat)
+    })
+  })
+}
+
+export default {
+  RNFetchBlobSession,
+  unlink,
+  mkdir,
+  session,
+  ls,
+  readStream,
+  mv,
+  cp,
+  writeStream,
+  writeFile,
+  appendFile,
+  pathForAppGroup,
+  syncPathAppGroup,
+  readFile,
+  hash,
+  exists,
+  createFile,
+  isDir,
+  stat,
+  lstat,
+  scanFile,
+  dirs,
+  slice,
+  asset,
+  df
+}