update to use promises (#4)

* update to use promises

* update docs

* update toiletdb

Author: joehand

README.md

@@ -19,13 +19,9 @@ var DatJSON = require('dat-json')
 
 var datjson = DatJSON(archive)
 
-datjson.create({title: 'a dat', description: 'exciting'}, function (err) {
-  if (err) throw err
-})
+await datjson.create({title: 'a dat', description: 'exciting'})
 
-datjson.read(function (err, data) {
-  console.log(data)
-})
+console.log(await datjson.read())
 ```
 
 Write to a `dat.json` on the file system also:
@@ -35,9 +31,7 @@ var DatJSON = require('dat-json')
 
 var datjson = DatJSON(archive, {file: path.join(dat.path, 'dat.json')})
 
-datjson.create({title: 'a dat', description: 'exciting'}, function (err) {
-  if (err) throw err
-})
+await datjson.create({title: 'a dat', description: 'exciting'})
 ```
 
 **TODO: replace file option with hyperdrive indexing**
@@ -52,19 +46,19 @@ Options:
 
 * `opts.file` - dat.json file path, updates will be written to file system and archive
 
-#### `datjson.create([data], cb)`
+#### `await datjson.create([data])`
 
 Create a new `dat.json` file in the archive with the default keys (`url`, `title`, `description`). Pass in any additional data to add on initial create.
 
-#### `datjson.write(key, val, cb)` or `datjson.write(data, cb)`
+#### `await datjson.write(key, val)` or `await datjson.write(data)`
 
 Write a single `key` and `value` or an object, `data`, to the `dat.json` file. Use `file` option above to also update the file on the file system.
 
-#### `datjson.delete(key, cb)`
+#### `await datjson.delete(key)`
 
 Delete a `key` from the `dat.json` file.
 
-#### `datjson.read(cb)`
+#### `await datjson.read()`
 
 Read the current `dat.json`.
 

index.js

@@ -1,67 +1,108 @@
-var stringKey = require('dat-encoding').toStr
-// var path = require('path')
-var xtend = Object.assign
-var toiletdb = require('toiletdb')
+const stringKey = require('dat-encoding').toStr
+const xtend = Object.assign
+const toiletdb = require('toiletdb')
 
-module.exports = function (archive, opts) {
-  if (!opts) opts = {}
+module.exports = (...args) => new DatJsonDb(...args)
 
-  var db = toiletdb({ name: '/dat.json', fs: archive })
-  var fileDb = opts.file ? toiletdb(opts.file) : null
+class DatJsonDb {
+  constructor (archive, opts) {
+    if (!opts) opts = {}
+    this.archive = archive
+    this.db = toiletdb({ name: '/dat.json', fs: archive })
+    this.fileDb = opts.file ? toiletdb(opts.file) : null
+  }
 
-  var that = {
-    read: function (cb) {
-      archive.stat('/dat.json', function (err, stat) {
-        if (err) return cb(err)
-        db.read(cb)
+  read () {
+    const self = this
+    return new Promise((resolve, reject) => {
+      this.archive.stat('/dat.json', async function (err, stat) {
+        if (err) return reject(err)
+        resolve(await self.db.read())
       })
-    },
-    write: function (key, val, cb) {
-      if (typeof val === 'function') cb = val
-      if (!archive.writable) {
-        return process.nextTick(cb, new Error('Archive not writable'))
+    })
+  }
+
+  write (key, val) {
+    return new Promise(async (resolve, reject) => {
+      if (!this.archive.writable) {
+        return reject(new Error('Archive not writable'))
       }
-      if (typeof key === 'object') return writeAll(key, cb)
+
+      if (typeof key === 'object') {
+        try {
+          await this._writeAll(key)
+          resolve()
+        } catch (e) {
+          reject(e)
+        }
+        return
+      }
+
       // TODO: validate things
-      if (!fileDb) return db.write(key, val, cb)
+      if (!this.fileDb) {
+        try {
+          await this.db.write(key, val)
+          resolve()
+        } catch (e) {
+          reject(e)
+        }
+        return
+      }
 
       // write to file then archive
       // TODO: use hyperdrive indexing false option, need to talk to mafintosh about
       //   https://botbot.me/freenode/dat/2017-05-12/?msg=85554242&page=3
-      fileDb.write(key, val, function (err) {
-        if (err) return cb(err)
-        db.write(key, val, cb)
-      })
-    },
-    delete: db.delete,
-    create: function (data, cb) {
-      if (typeof data === 'function') return that.create(null, data)
-      if (!archive.writable) {
-        return process.nextTick(cb, new Error('Archive not writable'))
+      try {
+        await this.fileDb.write(key, val)
+        await this.db.write(key, val)
+        resolve()
+      } catch (e) {
+        reject(e)
       }
-      data = xtend(getdefaults(), data)
-      that.write(data, cb)
-    }
+    })
   }
 
-  return that
+  async delete (key) {
+    await this.db.delete(key)
+  }
 
-  function getdefaults () {
-    return {
-      title: '',
-      description: '',
-      url: 'dat://' + stringKey(archive.key)
-    }
+  create (data) {
+    return new Promise(async (resolve, reject) => {
+      if (!this.archive.writable) {
+        return reject(new Error('Archive not writable'))
+      }
+
+      data = xtend(this.getdefaults(), data)
+      try {
+        await this.write(data)
+        resolve()
+      } catch (e) {
+        reject(e)
+      }
+    })
   }
 
-  function writeAll (data, cb) {
-    var keys = Object.keys(data)
-    var pending = keys.length
-    keys.map(function (key) {
-      that.write(key, data[key], function (err) {
-        if (err) return cb(err)
-        if (!--pending) return cb()
+  _writeAll (data, cb) {
+    const self = this
+    return new Promise((resolve, reject) => {
+      const keys = Object.keys(data)
+      let pending = keys.length
+      keys.map(async function (key) {
+        try {
+          await self.write(key, data[key])
+        } catch (e) {
+          reject(e)
+        }
+        if (!--pending) return resolve()
       })
     })
   }
+
+  getdefaults () {
+    return {
+      title: '',
+      description: '',
+      url: 'dat://' + stringKey(this.archive.key)
+    }
+  }
 }

package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/joehand/dat-json/issues"
   },
   "devDependencies": {
-    "hyperdrive": "^9.12.3",
+    "hyperdrive": "^9.14.3",
     "random-access-memory": "^3.1.1",
     "standard": "^12.0.1",
     "tape": "^4.10.1"
@@ -25,6 +25,6 @@
   },
   "dependencies": {
     "dat-encoding": "^5.0.1",
-    "toiletdb": "^1.4.1"
+    "toiletdb": "^2.0.0"
   }
 }