feat: add MFS commands write, cp, mkdir (#2)

Additionally, this PR:

1. Adds a `options.qs` option on _all_ endpoints for passing additional query string parameters
2. Documents `options.headers` option (custom HTTP headers) for all endpoints

Author: Alan Shaw

API.md

@@ -166,17 +166,17 @@ This module is in heavy development, not all API methods are available (or docum
 * dht.put
 * dht.query
 * dns
-* files.cp
+* [files.cp](./API.md#filescp)
 * files.flush
 * files.ls
 * files.lsPullStream
-* files.mkdir
+* [files.mkdir](./API.md#filesmkdir)
 * files.mv
 * files.read
 * files.readPullStream
 * files.rm
 * files.stat
-* files.write
+* [files.write](./API.md#fileswrite)
 * [id](./API.md#id) TODO: add docs
 * key.export
 * key.gen

README.md

@@ -6,7 +6,8 @@
   "main": "src/index.js",
   "browser": {
     "./src/lib/configure.js": "./src/lib/configure.browser.js",
-    "./src/add/form-data.js": "./src/add/form-data.browser.js"
+    "./src/add/form-data.js": "./src/add/form-data.browser.js",
+    "./src/files/write/form-data.js": "./src/files/write/form-data.browser.js"
   },
   "browserslist": ">1.5% or node >=10 and not ios_saf <13 and not ie 11 and not dead",
   "files": [
@@ -42,7 +43,7 @@
     "bignumber.js": "^9.0.0",
     "chai": "^4.2.0",
     "dirty-chai": "^2.0.1",
-    "go-ipfs-dep": "~0.4.21",
+    "go-ipfs-dep": "^0.4.21",
     "interface-ipfs-core": "~0.105.1",
     "ipfs-block": "^0.8.1",
     "ipfsd-ctl": "^0.43.0",

package.json

@@ -3,7 +3,7 @@
 
 const normaliseInput = require('./normalise-input')
 
-exports.toFormData = async function toFormData (input) {
+exports.toFormData = async (input) => {
   const files = normaliseInput(input)
   const formData = new FormData()
   let i = 0

src/add/form-data.browser.js

@@ -1,11 +1,10 @@
 'use strict'
 
-// const toStream = require('async-iterator-to-stream')
 const FormData = require('form-data')
-const { Readable } = require('stream')
 const normaliseInput = require('./normalise-input')
+const toStream = require('../lib/iterable-to-readable-stream')
 
-exports.toFormData = async function toFormData (input) {
+exports.toFormData = async (input) => {
   // In Node.js, FormData can be passed a stream so no need to buffer
   const files = normaliseInput(input)
   const formData = new FormData()
@@ -40,26 +39,3 @@ exports.toFormData = async function toFormData (input) {
 
   return formData
 }
-
-function toStream (iterable) {
-  let reading = false
-  return new Readable({
-    async read (size) {
-      if (reading) return
-      reading = true
-
-      try {
-        while (true) {
-          const { value, done } = await iterable.next(size)
-          if (done) return this.push(null)
-          if (!this.push(value)) break
-        }
-      } catch (err) {
-        this.emit('error', err)
-        if (iterable.return) iterable.return()
-      } finally {
-        reading = false
-      }
-    }
-  })
-}

src/add/form-data.js

@@ -27,7 +27,8 @@ module.exports = configure(({ fetch, apiUrl, apiPath, headers }) => {
       'shard-split-threshold': options.shardSplitThreshold,
       silent: options.silent,
       trickle: options.trickle,
-      'wrap-with-directory': options.wrapWithDirectory
+      'wrap-with-directory': options.wrapWithDirectory,
+      ...(options.qs || {})
     })
 
     const url = `${apiUrl}${apiPath}/add${qs}`

src/add/index.js

@@ -1,9 +1,8 @@
 'use strict'
 /* eslint-env browser */
 
-const toIterator = require('pull-stream-to-async-iterator')
 const { Buffer } = require('buffer')
-const blobToAsyncIterable = require('../lib/blob-to-async-iterable')
+const toAsyncIterable = require('../lib/file-data-to-async-iterable')
 
 /*
 Transform one of:
@@ -126,38 +125,3 @@ module.exports = function normalizeInput (input) {
 function normalizeTuple ({ path, content }) {
   return { path: path || '', content: content ? toAsyncIterable(content) : null }
 }
-
-function toAsyncIterable (input) {
-  // Buffer|ArrayBuffer|TypedArray|array of bytes
-  if (input[Symbol.iterator]) {
-    const buf = Buffer.from(input)
-    return Object.assign(
-      (async function * () { yield buf })(), // eslint-disable-line require-await
-      { length: buf.length }
-    )
-  }
-
-  // Blob|File
-  if (typeof Blob !== 'undefined' && input instanceof Blob) {
-    return Object.assign(
-      blobToAsyncIterable(input),
-      { length: input.size }
-    )
-  }
-
-  // AsyncIterable<Buffer>
-  if (input[Symbol.asyncIterator]) {
-    return (async function * () {
-      for await (const chunk of input) {
-        yield Buffer.from(chunk)
-      }
-    })()
-  }
-
-  // PullStream
-  if (typeof input === 'function') {
-    return toIterator(input)
-  }
-
-  throw new Error('Unexpected input: ' + typeof input)
-}

src/add/normalise-input.js

@@ -2,13 +2,15 @@
 
 const configure = require('../lib/configure')
 const { ok } = require('../lib/fetch')
+const { objectToQuery } = require('../lib/querystring')
 const toCamel = require('../lib/to-camel')
 
 module.exports = configure(({ fetch, apiUrl, apiPath, headers }) => {
   return async (options) => {
     options = options || {}
 
-    const url = `${apiUrl}${apiPath}/bitswap/stat`
+    const qs = objectToQuery(options.qs)
+    const url = `${apiUrl}${apiPath}/bitswap/stat${qs}`
     const res = await ok(fetch(url, {
       signal: options.signal,
       headers: options.headers || headers

src/bitswap/stat.js

@@ -13,7 +13,12 @@ module.exports = configure(({ fetch, apiUrl, apiPath, headers }) => {
 
     options = options || {}
 
-    const url = `${apiUrl}${apiPath}/bitswap/wantlist${objectToQuery({ peer: peerId })}`
+    const qs = objectToQuery({
+      peer: peerId,
+      ...(options.qs || {})
+    })
+
+    const url = `${apiUrl}${apiPath}/bitswap/wantlist${qs}`
     const res = await ok(fetch(url, {
       signal: options.signal,
       headers: options.headers || headers

src/bitswap/wantlist.js

@@ -3,12 +3,18 @@
 const { Buffer } = require('buffer')
 const configure = require('../lib/configure')
 const { ok } = require('../lib/fetch')
+const { objectToQuery } = require('../lib/querystring')
 
 module.exports = configure(({ fetch, apiUrl, apiPath, headers }) => {
   return async (cid, options) => {
     options = options || {}
 
-    const url = `${apiUrl}${apiPath}/block/get?arg=${encodeURIComponent(cid)}`
+    const qs = objectToQuery({
+      arg: cid.toString(),
+      ...(options.qs || {})
+    })
+
+    const url = `${apiUrl}${apiPath}/block/get${qs}`
     const res = await ok(fetch(url, {
       signal: options.signal,
       headers: options.headers || headers