feat: Provide access to bundled libraries when in browser (ipfs-inactive#732)

vasco-santos · daviddias · commit 994bdad73725 · 2018-04-05T16:05:05.000+01:00
Close ipfs-inactive#406
diff --git a/README.md b/README.md
@@ -308,6 +308,20 @@ This means:
 - See https://github.com/ipfs/js-ipfs for details on
   pubsub in js-ipfs
 
+#### `Domain data types`
+
+A set of data types are exposed directly from the IPFS instance under `ipfs.types`. That way you're not required to import/require the following.
+
+- [`ipfs.types.Buffer`](https://www.npmjs.com/package/buffer)
+- [`ipfs.types.PeerId`](https://github.com/libp2p/js-peer-id)
+- [`ipfs.types.PeerInfo`](https://github.com/libp2p/js-peer-info)
+- [`ipfs.types.multiaddr`](https://github.com/multiformats/js-multiaddr)
+- [`ipfs.types.multibase`](https://github.com/multiformats/multibase)
+- [`ipfs.types.multihash`](https://github.com/multiformats/js-multihash)
+- [`ipfs.types.CID`](https://github.com/ipld/js-cid)
+- [`ipfs.types.dagPB`](https://github.com/ipld/js-ipld-dag-pb)
+- [`ipfs.types.dagCBOR`](https://github.com/ipld/js-ipld-dag-cbor)
+
 #### `Utility functions`
 
 Adding to the methods defined by [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core), `js-ipfs-api` exposes a set of extra utility methods. These utility functions are scoped behind the `ipfs.util`.
@@ -378,6 +392,18 @@ ipfs.util.addFromStream(<readable-stream>, (err, result) => {
 
 This returns an object containing the `host` and the `port`
 
+##### Get libp2p crypto primitives
+
+> `ipfs.util.crypto`
+
+This contains an object with the crypto primitives
+
+##### Get is-ipfs utilities
+
+> `ipfs.util.isIPFS`
+
+This contains an object with the is-ipfs utilities to help identifying IPFS resources
+
 ### Callbacks and Promises
 
 If you do not pass in a callback all API functions will return a `Promise`. For example:
diff --git a/package.json b/package.json
@@ -36,11 +36,13 @@
     "ipfs-block": "~0.6.1",
     "ipfs-unixfs": "~0.1.14",
     "ipld-dag-cbor": "^0.12.0",
-    "ipld-dag-pb": "~0.13.1",
+    "ipld-dag-pb": "^0.13.1",
     "is-ipfs": "^0.3.2",
     "is-stream": "^1.1.0",
+    "libp2p-crypto": "^0.12.1",
     "lru-cache": "^4.1.2",
     "multiaddr": "^3.1.0",
+    "multibase": "^0.4.0",
     "multihashes": "~0.4.13",
     "ndjson": "^1.5.0",
     "once": "^1.4.0",
diff --git a/src/index.js b/src/index.js
@@ -38,7 +38,7 @@ function IpfsAPI (hostOrMultiaddr, port, opts) {
   const requestAPI = sendRequest(config)
   const cmds = loadCommands(requestAPI, config)
   cmds.send = requestAPI
-  cmds.Buffer = Buffer
+  cmds.Buffer = Buffer // Added buffer in types (this should be removed once a breaking change is release)
 
   return cmds
 }
diff --git a/src/types.js b/src/types.js
@@ -0,0 +1,22 @@
+'use strict'
+
+const CID = require('cids')
+const dagCBOR = require('ipld-dag-cbor')
+const dagPB = require('ipld-dag-pb')
+const multiaddr = require('multiaddr')
+const multibase = require('multibase')
+const multihash = require('multihashes')
+const PeerId = require('peer-id')
+const PeerInfo = require('peer-info')
+
+module.exports = () => ({
+  Buffer: Buffer,
+  CID: CID,
+  dagPB: dagPB,
+  dagCBOR: dagCBOR,
+  multiaddr: multiaddr,
+  multibase: multibase,
+  multihash: multihash,
+  PeerId: PeerId,
+  PeerInfo: PeerInfo
+})
diff --git a/src/utils/load-commands.js b/src/utils/load-commands.js
@@ -42,6 +42,7 @@ function requireCommands () {
     pubsub: require('../pubsub'),
     update: require('../update'),
     version: require('../version'),
+    types: require('../types'),
     dns: require('../dns')
   }
 
@@ -61,7 +62,9 @@ function requireCommands () {
       addFromFs: require('../util/fs-add')(send),
       addFromStream: require('../files/add')(send),
       addFromURL: require('../util/url-add')(send),
-      getEndpointConfig: require('../util/get-endpoint-config')(config)
+      getEndpointConfig: require('../util/get-endpoint-config')(config),
+      crypto: require('libp2p-crypto'),
+      isIPFS: require('is-ipfs')
     }
     return util
   }
diff --git a/test/types.spec.js b/test/types.spec.js
@@ -0,0 +1,52 @@
+/* eslint-env mocha */
+'use strict'
+
+const PeerId = require('peer-id')
+const PeerInfo = require('peer-info')
+const dagCBOR = require('ipld-dag-cbor')
+const dagPB = require('ipld-dag-pb')
+const multiaddr = require('multiaddr')
+const multibase = require('multibase')
+const multihash = require('multihashes')
+const CID = require('cids')
+
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
+
+const IPFSApi = require('../src')
+
+const f = require('./utils/factory')
+
+describe('.types', function () {
+  this.timeout(20 * 1000)
+
+  let ipfsd
+  let ipfs
+
+  before((done) => {
+    f.spawn({ initOptions: { bits: 1024 } }, (err, _ipfsd) => {
+      expect(err).to.not.exist()
+      ipfsd = _ipfsd
+      ipfs = IPFSApi(_ipfsd.apiAddr)
+      done()
+    })
+  })
+
+  after((done) => ipfsd.stop(done))
+
+  it('types object', () => {
+    expect(ipfs.types).to.be.deep.equal({
+      Buffer: Buffer,
+      PeerId: PeerId,
+      PeerInfo: PeerInfo,
+      multiaddr: multiaddr,
+      multibase: multibase,
+      multihash: multihash,
+      CID: CID,
+      dagPB: dagPB,
+      dagCBOR: dagCBOR
+    })
+  })
+})
diff --git a/test/util.spec.js b/test/util.spec.js
@@ -165,4 +165,20 @@ describe('.util', () => {
       expect(endpoint).to.have.property('port')
     })
   })
+
+  describe('.crypto', () => {
+    it('should contain the crypto primitives object', function () {
+      const cripto = ipfs.util.crypto
+
+      expect(cripto).to.exist()
+    })
+  })
+
+  describe('.isIPFS', () => {
+    it('should contain the isIPFS utilities object', function () {
+      const isIPFS = ipfs.util.isIPFS
+
+      expect(isIPFS).to.exist()
+    })
+  })
 })

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ function IpfsAPI (hostOrMultiaddr, port, opts) {`
`38`	`38`	`const requestAPI = sendRequest(config)`
`39`	`39`	`const cmds = loadCommands(requestAPI, config)`
`40`	`40`	`cmds.send = requestAPI`
`41`		`- cmds.Buffer = Buffer`
	`41`	`+ cmds.Buffer = Buffer // Added buffer in types (this should be removed once a breaking change is release)`
`42`	`42`
`43`	`43`	`return cmds`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ function requireCommands () {`
`42`	`42`	`pubsub: require('../pubsub'),`
`43`	`43`	`update: require('../update'),`
`44`	`44`	`version: require('../version'),`
	`45`	`+ types: require('../types'),`
`45`	`46`	`dns: require('../dns')`
`46`	`47`	`}`
`47`	`48`
`@@ -61,7 +62,9 @@ function requireCommands () {`
`61`	`62`	`addFromFs: require('../util/fs-add')(send),`
`62`	`63`	`addFromStream: require('../files/add')(send),`
`63`	`64`	`addFromURL: require('../util/url-add')(send),`
`64`		`- getEndpointConfig: require('../util/get-endpoint-config')(config)`
	`65`	`+ getEndpointConfig: require('../util/get-endpoint-config')(config),`
	`66`	`+ crypto: require('libp2p-crypto'),`
	`67`	`+ isIPFS: require('is-ipfs')`
`65`	`68`	`}`
`66`	`69`	`return util`
`67`	`70`	`}`