@kba/anno-store NPM

anno-store

Interface for stores

Implementing a store

To implement a store, override the Public API with this convention:

Prepend and underscore to the method name
Method takes exactly two parameters: context and callback
All positional parameters become keys in the context object

For example to override the create(anno, options, callback) method:

// my-store/index.js
class MyStore extends require('@kba/anno-store') {
  
  _create(options, callback) {
    const anno = options.anno
    // ...
    return callback(...)
  }
}

Public API

static load(loadingModule)

Modules may call this static method to instantiate a store from the environment and using the packages installed in the calling package.

// my-package/index.js
const store = require('@kba/anno-store').load(module)
store.init(...)

`use(middleware)`

Use middleware for auth etc.

`init(options, cb)`

Initialize a connection to the store.

@param {Options} options
@param {String} options.user
@param {function} callback

`wipe(options, callback)`

Wipe the store, revisions and all.

@param {Options} options
@param {String} options.user
@param {function} callback

`disconnect(options, callback)`

Disconnect a store. A disconnected store cannot be used until init is called again.

@param {Options} options
@param {String} options.user
@param {function} callback

`get(annoId, options, cb)`

Retrieve an annotation.

@param {String|Array<String>} annoIds
@param {Object} options
- @param {Boolean} options.latest Return the latest revision only
- @param {Boolean} options.metadataOnly Return only metadata
- @param {Boolean} options.skipVersions Omit versions
- @param {Boolean} options.skipReplies Omit replies
@param {String} options.user
@param {function} callback

`create(anno, options, callback)`

Create an annotation.

@param {Object} anno
@param {Options} options
@param String options.slug Proposal for the ID to create
@param {String} options.user
@param {function} callback

`revise(annoId, anno, options, callback)`

Revise an annotation.

@param {String} annoId
@param {Object} anno
@param {Options} options
- @param {String} options.user
@param {function} callback

`delete(annoId, options, callback)`

`remove(annoId, options, callback)`

Delete an annotation, i.e. set the deleted date.

@param {String} annoId
@param {Options} options
@param {Boolean} options.forceDelete Set to true to hint the store to actually delete, not just mark deleted
@param {String} options.user
@param {function} callback

`search(query, options, callback)`

Search the store.

@param {Object} query
@param {Options} options
@param {String} options.user
@param {function} callback

`reply(annoId, anno, options, callback)`

`comment(annoId, anno, options, callback)`

Reply to an annotation

@param {String} annoId
@param {Object} anno
@param {Options} options
@param {String} options.user
@param {function} callback

`aclcheck(targets, options, callback)`

@param {Array} targets
@param {Options} options
@param {function} callback

`import(anno, options, callback)`

Replaces the complete annotation with the passed annotation, not just revise it.

@param {Object} anno
@param {Options} options
- @param String options.slug Proposal for the ID to create
- @param {String} options.user
@param {function} callback