ipfs-repo/src/spec.js

IPFS Repo implementation

import { Key } from 'interface-datastore'
import sortKeys from 'sort-keys'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'

const specKey = new Key('datastore_spec')

/**
 *
 * @param {import('interface-datastore').Datastore} store
 */
export function spec (store) {
  return {
    /**
     * Check if a datastore spec file exists.
     *
     */
    exists () {
      return store.has(specKey)
    },
    /**
     * Get the current datastore spec.
     *
     * @returns {Promise<Uint8Array>}
     */
    async get () {
      const buf = await store.get(specKey)
      return JSON.parse(uint8ArrayToString(buf))
    },
    /**
     * Set the datastore spec of the repo, writing it to the underlying store.
     * TODO unclear on what the type should be or if it's required
     *
     * @param {any} spec
     * @returns {Promise<void>}
     */
    async set (spec) {
      return store.put(specKey, uint8ArrayFromString(JSON.stringify(sortKeys(spec, { deep: true }))))
    }
  }
}