Feature: implement DatArchive API

[chrisekelley]

Bunsen should provide access to all of the DatArchive API as well as tests and examples.

[chrisekelley]

Here's what we have so far:

So far there's create, getInfo, mkdir, and writeFile in this commit.

[RangerMauve]

I think @pfrazee was looking into standardizing an HTTP API for accessing Dat Archives.

Not sure if he had something you could work off of.

[pfrazee]

I'm not focusing on that right now so I wouldnt wait for me.

[chrisekelley]

Collecting some resources to implement the DatArchive API in Bunsen. So far there's create, getInfo, mkdir, and writeFile in www/nodejs-project/index.js

What others do we need to implement?

Some resources:

• DatArchive API documentation
• dat-archive-web
• node-dat-archive datArchive implementation. Also not that node-dat-archive does not implement DatArchive.fork, unlink, selectArchive
• dat-node
• dat project

[RangerMauve]

Don't forget dat-archive-web 😀

[chrisekelley]

@RangerMauve ahhh yes, thanks! added to list.

[chrisekelley]

List of DatArchive functions to consider for implementation. Most of these are from node-dat-archive, but also note ones from dat-archive-web.

• [x] static async create ({localPath, datOptions, netOptions, title, description, type, author})
• [x] static async load ({localPath, datOptions, netOptions})
• [ ] async configure (settings)
• [x] async getInfo (url, opts = {})
• [ ] async history (opts = {})
• [x] async stat (filepath, opts = {})
• [x] async readFile (filepath, opts = {})
• [x] async writeFile (filepath, data, opts = {})
• [ ] async unlink (filepath)
• [ ] async download (filepath, opts = {})
• [ ] async readdir (filepath, opts = {})
• [x] async mkdir (filepath)
• [ ] async rmdir (filepath, opts = {})
• [ ] async copy (path, dstPath, opts) - dat-archive-web
• [ ] async rename(filepath, dstpath, opts) - dat-archive-web
• [x] watch (pathSpec = null, onInvalidated = null)
• [ ] createNetworkActivityStream ()
• [ ] static async resolveName (name)
• [ ] static async fork (url, opts)
• [ ] static async selectArchive (options) - dat-archive-web

[chrisekelley]

I just made a new release of Bunsen which exposes some of these DatArchive API methods. It's now on the Play Store.

Check out Using the DatArchive API in Bunsen to create dat applications for dev info, and https://github.com/bunsenbrowser/bunsen/releases/tag/1.1.3 for info about this release.

You can test out this DatArchive support using the Bunsen Play dat:

dat://bunsen-play.hashbase.io

Next big step is to confirm if sharing is working - Some some modifications to dat-gateway may be needed to recognise and share new dats.

[RangerMauve]

This is so awesome! Great job! 😀💜

[chrisekelley]

RJ contributed the implementations of watch and load!