perkeep

Getting started

This is a Universal Javascript client for the Perkeep storage system.

npm install perkeep

The library supports saving data using either a username/password or a username/vivify-password which does not allow signing schemas. An example of both use cases is shown below. The upload method should accept just about any type of data (in the browser or in Node). e.g. Blobs, Buffers, TypedArrays, JSON, or Strings.

Upload with a username/password combo that has signing capabilities:

const Perkeep = require('perkeep');
 
let perkeep = Perkeep({
  host: 'http://perkeep.test',
  user: 'user',
  password: 'pass'
});
 
let data = fs.readFileSync('demo.txt');
 
perkeep.discover()
.then(function (discoveryConfig) {
  perkeep.discoveryConfig = discoveryConfig;
  return perkeep.upload(data);
})
.then(function(parts) {
  let fileSchema = {
    "camliVersion": 1,
    "camliType": "file",
    "unixMTime": new Date(Date.now()).toISOString(),
    "fileName": "demo.txt",
    parts
  };
  return perkeep.sign(fileSchema).then(signature => perkeep.upload(signature));
})
.then(function(received) {
  return perkeep.createPermanode({
    title: "NodeJS Title",
    camliContent: received[0].blobRef
  });
})
.then(function({ permanodeRef }) {
  console.log(`Created ${permanodeRef}`);
});

Upload with a vivify password (no signing capabilities):

let perkeep = Perkeep({
  host: 'http://perkeep.test',
  user: 'user',
  vivify: 'rainbows'
});
 
let data = new Blob(["This is my blob content"], {type : "text/plain"});
 
perkeep.discover()
  .then(function(discoveryConfig) {
    perkeep.discoveryConfig = discoveryConfig;
    return perkeep.upload(data);
  })
  .then(function (parts) {
    let fileSchema = {
      "camliVersion": 1,
      "camliType": "file",
      "unixMTime": new Date(Date.now()).toISOString(),
      "fileName": "demo.txt",
      parts
    };
    return perkeep.upload(fileSchema);
  });

Building and Running Tests

npm run build builds the library to dist, generating three files:

• dist/perkeep.cjs.js A CommonJS bundle, suitable for use in Node.js, that requires the external dependencies. This corresponds to the "main" field in package.json
• dist/perkeep.esm.js an ES module bundle, suitable for use in other people's libraries and applications, that imports the external dependency. This corresponds to the "module" field in package.json
• dist/perkeep.iife.js a IIFE build, suitable for use in the browser, as a <script> tag, that includes the external dependencies. This corresponds to the "browser" field in package.json

npm run dev builds the library, then keeps rebuilding it whenever the source files change using rollup-watch.

npm test builds the library, then tests it.

TODO

• Make the "Building and Running Tests" section real.
• Document Perkeep class API.
• Cleanup experimental build configs and npm run-scripts.
• Add data uri parsing to upload support.
• Add ability to search and query.

License

MIT.