universal-dat-storage

Handle storing Dats in crazy environments

Why?

Dealing with Storage in Dats is really fragmented. Beaker has it's own way of doing it, the Dat CLI has it's own way of doing it, random hypercore based projects have their own way of doing it, and all of that is incompatible with the web.

This module hopes to unify all these environments and have one place for all of Dat's storage needs.

Goals

• [x] Support Hyperdrives and Hypercores
• [x] Take dat keys (buffer or URL) or file paths
• [x] Standard folder for hypercore metadata. Use env-paths data path
  • [x] Use same storage logic as corestore
• [x] Detect how to get the Dat for a file path
  • [x] Check for .dat folder, use dat-storage if it exists.
  • [x] Check for .dat file, identifies key to look up metadata in the standard place
  • ~Create .dat file with a new key if nothing else exists~ This should be done at the application level. (in the SDK, for example)
• ~Check in Beaker's storage~ (That's changing to be the daemon)
  • ~Uses app.getPath(), with "userData", then "Dat", and "Archives" / "Meta" / key.slice(0,2) / key.toString('hex')~
• [x] Web support

API

const Storage = require('universal-dat-storage')

const storage = new Storage({
  // Change the application name to use in the env-path module
  application: 'dat',

  // Only specify this if you really know what you're doing
  // Ideally data should be stored using env-paths to make operating systems happy
  storageLocation: null,

  // Support relative paths for folders
  useRelativePaths: true,

  // Whether we should search for keys in Beaker
  useBeaker: true,

  // Whether we should use the legacy `.dat` folder feature
  useDatFolder: true,

  // Whether we should use the new `.dat` file feature
  useDatFile: true
})

const key = DatEncoding.decode(`dat://0a9e202b8055721bd2bc93b3c9bbc03efdbda9cfee91f01a123fdeaadeba303e`)

// Get storage specific to hyperdrive (for the metadata and content feed)
const drive = hyperdrive(storage.getDrive(key))

// Get storage for a given folder
const drive = hyperdrive(storage.getDrive('/home/mauve/example'))

const drive = hyperdrive(storage.getDrive('./example'))

// Get storage for a specific hypercore key
const core = hypercore(storage.getCore(key))

// Get storage for a given corestore
const store = corestore(storage.getCoreStore(name))

// Get the location of the storage on disk
// Only works for valid keys, not file paths
const location = storage.getLocation(key)

// Delete the storage for a given hypercore or hyperdrive
// Only works for valid keys, not file paths
// Doesn't work on the web
storage.delete(key, () => {
  console.log('Done!')
})