feat: add js-kubo-rpc-client

.aegir.js

@@ -1,6 +1,7 @@
 import { createServer } from './src/index.js'
 import * as ipfsModule from 'ipfs'
 import * as ipfsHttpModule from 'ipfs-http-client'
+import * as kuboRpcModule from 'kubo-rpc-client'
 import * as goIpfsModule from 'go-ipfs'
 
 /** @type {import('aegir').Options["build"]["config"]} */
@@ -20,10 +21,19 @@ export default {
       }
     },
     before: async () => {
-      const server = createServer(undefined, {
-          ipfsModule,
-          ipfsHttpModule
-        }, {
+      /**
+       * @type {import('./src/types.js').ControllerOptions}
+       */
+      let controllerOptions = {
+        ipfsModule,
+      }
+
+      if (process.env.USE_KUBO_JS) {
+        controllerOptions.kuboRpcModule = kuboRpcModule
+      } else {
+        controllerOptions.ipfsHttpModule = ipfsHttpModule
+      }
+      const server = createServer(undefined, controllerOptions, {
           go: {
             ipfsBin: goIpfsModule.path()
           },

package.json

@@ -140,10 +140,10 @@
   "scripts": {
     "lint": "aegir lint",
     "build": "aegir build",
-    "test": "aegir test",
-    "test:node": "aegir test -t node",
-    "test:chrome": "aegir test -t browser",
-    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test": "aegir test && cross-env USE_KUBO_JS=1 aegir test",
+    "test:node": "aegir test -t node && cross-env USE_KUBO_JS=1 aegir test -t node",
+    "test:chrome": "aegir test -t browser && cross-env USE_KUBO_JS=1 aegir test -t browser",
+    "test:firefox": "aegir test -t browser -- --browser firefox && cross-env USE_KUBO_JS=1 aegir test -t browser -- --browser firefox",
     "release": "aegir release"
   },
   "dependencies": {
@@ -155,6 +155,7 @@
     "execa": "^6.1.0",
     "ipfs-utils": "^9.0.1",
     "joi": "^17.2.1",
+    "kubo-rpc-client": "^1.0.0",
     "merge-options": "^3.0.1",
     "nanoid": "^4.0.0",
     "p-wait-for": "^4.1.0",
@@ -164,6 +165,7 @@
   "devDependencies": {
     "@types/hapi__hapi": "^20.0.9",
     "aegir": "^37.0.15",
+    "cross-env": "^7.0.3",
     "go-ipfs": "^0.13.0",
     "ipfs": "^0.63.5",
     "ipfs-client": "^0.8.3",

src/factory.js

@@ -88,7 +88,8 @@ class Factory {
         remote: false,
         ipfsBin: undefined,
         ipfsModule: undefined,
-        ipfsHttpModule: undefined
+        ipfsHttpModule: undefined,
+        kuboRpcModule: undefined
       }
     }
 

src/ipfsd-client.js

@@ -95,7 +95,13 @@ class Client {
         http: this.apiAddr
       })
     } else if (this.apiAddr) {
-      this.api = this.opts.ipfsHttpModule.create(this.apiAddr)
+      if (this.opts.kuboRpcModule != null) {
+        this.api = this.opts.kuboRpcModule.create(this.apiAddr)
+      } else if (this.opts.ipfsHttpModule != null) {
+        this.api = this.opts.ipfsHttpModule.create(this.apiAddr)
+      } else {
+        throw new Error('You must pass either a kuboRpcModule or ipfsHttpModule')
+      }
     }
 
     if (this.api) {

src/ipfsd-daemon.js

@@ -100,7 +100,13 @@ class Daemon {
         http: this.apiAddr
       })
     } else if (this.apiAddr) {
-      this.api = this.opts.ipfsHttpModule.create(this.apiAddr)
+      if (this.opts.kuboRpcModule != null) {
+        this.api = this.opts.kuboRpcModule.create(this.apiAddr)
+      } else if (this.opts.ipfsHttpModule != null) {
+        this.api = this.opts.ipfsHttpModule.create(this.apiAddr)
+      } else {
+        throw new Error('You must pass either a kuboRpcModule or ipfsHttpModule')
+      }
     }
 
     if (!this.api) {

src/ipfsd-in-proc.js

@@ -67,7 +67,14 @@ class InProc {
    */
   _setApi (addr) {
     this.apiAddr = new Multiaddr(addr)
-    this.api = this.opts.ipfsHttpModule.create(addr)
+
+    if (this.opts.kuboRpcModule != null) {
+      this.api = this.opts.kuboRpcModule.create(addr)
+    } else if (this.opts.ipfsHttpModule != null) {
+      this.api = this.opts.ipfsHttpModule.create(addr)
+    } else {
+      throw new Error('You must pass either a kuboRpcModule or ipfsHttpModule')
+    }
     this.api.apiHost = this.apiAddr.nodeAddress().address
     this.api.apiPort = this.apiAddr.nodeAddress().port
   }

src/types.ts

@@ -168,6 +168,10 @@ export interface ControllerOptions {
    * Reference to an ipfs-http-client module
    */
   ipfsHttpModule?: any
+  /**
+   * Reference to a kubo-rpc-client module
+   */
+  kuboRpcModule?: any
   /**
    * Reference to an ipfs or ipfs-core module
    */