substantial/truevault-node

An Unofficial TrueVault API wrapper for Node.js

TrueVault Client Library

Installation

npm install truevault

Example Usage

Require truevault:

var truevault = require('truevault')('your-user-api-key');

Each resource call returns a q promise and accepts an optional callback argument:

 truevault.documents.retrieve({
    'vault_id' : 'my-vault-uuid',
    'id' : 'my-document-uuid'
 }, function myCallback(err, document){
    //err is null if response is a success
 });

Or with a promise:

 truevault.documents.retrieve({
    'vault_id' : 'my-vault-uuid',
    'id' : 'my-document-uuid'
 }).then(function(document){
  //success!
 }, function(err){
  //error!
 });

Documents

list(options,callback) - Returns a list of documents

• options.vault_id vault uuid
• options.per_page items per page
• options.page page to return
• options.full if true, return full document instead of uuid
• callback is optional, this method returns a q promise

truevault.documents.list({
  'vault_id':'my-vault-uuid',
  'per_page':50,
  'page':1,
  'full': false //true to return full documents vs uuids
}, function myCallback(err, document){
    //err is null if response is a success
});

retrieve(options,callback) - returns a document (js obj)

• options.vault_id vault uuid
• options.id document uuid, or array of document uuids
• callback is optional, this method returns a q promise

truevault.documents.retrieve({
   'vault_id' : 'my-vault-uuid',
   'id' : 'my-document-uuid'
}, function myCallback(err, document){
   //err is null if response is a success
});

create(options,callback) - creates a document

• options.vault_id vault uuid
• options.schema_id schema uuid to index against (optional)
• options.document a js obj
• callback is optional, this method returns a q promise

truevault.documents.create({
  'vault_id':'my-vault-uuid',
  'schema_id' : 'my-schema-uuid',
  'document' : {
    'Hello' : 'World'
  }
}, function(err, transaction) {
  //err is null if response is a success
});

update(options,callback) - updates a document

• options.vault_id vault uuid
• options.schema_id schema uuid to index against (optional)
• options.id document uuid to update
• options.document a js obj
• callback is optional, this method returns a q promise

truevault.documents.update({
  'vault_id':'my-vault-uuid',
  'id':'my-document-uuid',
  'document' : {'changed':'wow!'}
},function(err, value) {
  //err is null if response is a success

});

del(options,callback) - deletes a document

• options.vault_id vault uuid
• options.id document uuid
• callback is optional, this method returns a q promise

truevault.documents.del({
  'vault_id':'my-vault-uuid',
  'id':'my-document-uuid'
},function(err, value) {
  //err is null if response is a success
});

search(options,callback) - searches for documents

• options.vault_id vault uuid
• options.schema_id schema uuid to search against (optional)
• options.filter - js object of field filters
• options.case_sensitive - true or false
• options.page - an integer of the page results you want
• options.per_page - an integer of the number of results you want from each page
• options.filter_type - a string specifying the filter type
• options.full_document - boolean (id vs full obj)
• options.sort - An object of field name and sort directions.
• callback is optional, this method returns a q promise

truevault.documents.search({
  'vault_id' : 'my-vault-uuid',
  'schema_id' : 'my-schema-uuid',
  'filter' : { 'first': {
      "type": "wildcard",
      "value": "Hello"
    }
}
}, function(err, value) {
  //err is null if response is a success
});

Blobs

retrieve(options,callback) - retrieves a blob

• options.vault_id vault uuid
• options.id blob uuid
• callback is optional, this method returns a q promise

truevault.blobs.retrieve({
  'vault_id' : 'my-vault-uuid',
  'id' : 'my-blob-uuid'
}, function(err, value) {
   //err is null if response is a success
});

create(options,callback) - creates a blob

• options.vault_id vault uuid
• options.blob a Buffer or String
• callback is optional, this method returns a q promise

 truevault.blobs.create({
   'vault_id' : 'my-vault-uuid',
   'blob' : myBuffer
 }, function(err, value) {
   //err is null if response is a success
 });

update(options,callback) - updates a blob

• options.vault_id vault uuid
• options.id blob uuid to update
• options.blob Buffer or String
• callback is optional, this method returns a q promise

truevault.blobs.update({
  'vault_id' : 'my-vault-uuid',
  'id' : 'my-blob-uuid',
  'blob' : myBuffer
}, function(err, value) {
   //err is null if response is a success
});

del(options,callback) - deletes a blob

• options.vault_id vault uuid
• options.id blob uuid
• callback is optional, this method returns a q promise

truevault.blobs.del({
  'vault_id' : 'my-vault-uuid',
  'id' : 'my-blob-uuid'
}, function(err, value) {
   //err is null if response is a success
});

Schemas

list(options,callback) - lists all schemas

• options.vault_id vault uuid
• callback is optional, this method returns a q promise

truevault.schemas.list({
  'vault_id' : 'my-vault-uuid'
}, function(err, value) {
   //err is null if response is a success
});

listDocuments(options,callback) - Returns a list of documents for schema

• options.vault_id vault uuid
• options.id schema uuid
• options.per_page items per page
• options.page page to return
• options.full if true, return full document instead of uuid
• callback is optional, this method returns a q promise

truevault.documents.listDocuments({
  'vault_id':'my-vault-uuid',
  'id':'my-schema-uuid',
  'per_page':50,
  'page':1,
  'full': false //true to return full documents vs uuids
}, function myCallback(err, document){
    //err is null if response is a success
});

retrieve(options,callback) - retrieves a schema

• options.vault_id vault uuid
• options.id schema uuid
• callback is optional, this method returns a q promise

truevault.schemas.retrieve({
  'vault_id':'my-vault-uuid',
  'id':'my-schema-uuid'
},function(err, value) {
   //err is null if response is a success
});

create(options,callback) - creates a schema

• options.vault_id vault uuid
• options.schema js obj
• callback is optional, this method returns a q promise

truevault.schemas.create({
  'vault_id':'my-vault-uuid',
  'schema' : {
    "name":"test",
    "fields":[
      {
        "name":"first",
        "index":true,
        "type" : "string"
      }
    ]
  }
},function(err, value) {
   //err is null if response is a success
});

update(options,callback) - updates a schema

• options.vault_id vault uuid
• options.id schema uuid to update
• options.schema a js obj
• callback is optional, this method returns a q promise

truevault.schemas.update({
  'vault_id':'my-vault-uuid',
  'id' : "my-schema-uuid"
  'schema' : {
    "name":"test",
    "fields":[
      {
        "name":"first",
        "index":true,
        "type" : "string"
      }
    ]
  }
},function(err, value) {
   //err is null if response is a success
});

del(options,callback) - deletes a schema

• options.vault_id vault uuid
• options.id schema uuid
• callback is optional, this method returns a q promise

truevault.schemas.del({
    'vault_id':'my-vault-uuid',
    'id':'my-schema-uuid'
}, function(err, value) {
   //err is null if response is a success
});

Users

create(options, callback) - creates a user

• options.username string(req’d) - username for the User being created
• options.password string(req’d) - password for the User being created
• options.attributes b64 string(optional) - base64 encoded JSON document describing the User attributes
• options.schema_id uuid(optional) - UUID of the Schema to associate the attributes Document with

truevault.users.create({
    username: 'username',
    password: 'password'
}).then(function(res) {
   // do something with response
});

del(userId, callback) - deactivates a user, freeing the assocaited username, all ACCESS_TOKENs, and removes user_id from all Groups

• options.id string(req’d) - username for the User being deleted

truevault.users.del({
    id: 'user-id'
}).then(function(res) {
    // do something with response
});

createAccessToken(options, callback) - creates a user

• options.id string(req’d)

truevault.users.createAccessToken({
    id: 'user-id'
}).then(function(res) {
    // do something with response
});

Authorization

login(options, callback) - Login a user

• options.username string(req’d) - username of active user
• options.password string(req’d) - password of active user
• options.account_id string(req’d) - account_id

truevault.authorization.login({
    username: 'username',
    password: 'password',
    account_id: 'account-id'
}).then(function(res) {
    // do something with response
});

logout(callback) - Logout a user, deactivating the associated ACCESS_TOKEN

truevault.authorization.logout().then(function(res) {
    // do something with response
});

verify(callback) - Verify a user

truevault.authorization.verify().then(function(res) {
    // do something with response
});

Groups

create(options, callback) - Create a Group with a name for the account with a policy.

• options.name string(req'd) - new name for Group
• options.policy object(optional) - new policy for Group, base64 encoded
• options.user_ids array(optional) - comma separated list of user_id for this update request

truevault.groups.create({
    name: 'group-name',
    user_ids: ['1','2','3'],
}).then(function(res) {
   // do something with response
});

update(options, callback) - Updates a Group’s policy, name, and attached users

• options.id string(req'd) - id of group to update
• options.name string(optional) - new name for Group
• options.policy object(optional) - new policy for Group, base64 encoded
• options.user_ids array(optional) - array of user ids for this update request
• options.operation string(optional) - ‘APPEND’ or ‘REMOVE’ this group for the provided list of user_id

truevault.groups.update({
    name: 'group-name',
    user_ids: ['1','2','3'],
    operation: 'REMOVE'
}).then(function(res) {
   // do something with response
});

del(options, callback) - Deletes a group and detaches the Group from all users.

• options.id string(req’d)

truevault.group.delete({
    id: 'group-id'
}).then(function(res) {
    // do something with response
});

Vaults

list(options,callback) - Returns a list of vaults

• options.page – int(optional, default: 1) - page number in paginated response
• options.per_page – int(optional, default: 100) - results per page in paginated respons
• callback is optional, this method returns a q promise

truevault.vaults.list({
  'per_page':50,
  'page':1,
}, function myCallback(err, document){
    //err is null if response is a success
});

create(options,callback) - creates a vault

• options.name – string(req'd) - new name for Vault
• callback is optional, this method returns a q promise

truevault.vaults.create({
  'name':'my-vault'
}, function(err, transaction) {
  //err is null if response is a success
});

retrieve(options,callback) - returns a vault (js obj)

• options.id - string(req'd) - Vault ID
• callback is optional, this method returns a q promise

truevault.vaults.retrieve({
   'id' : 'my-vault-id'
}, function myCallback(err, vault){
   //err is null if response is a success
});

update(options,callback) - updates a vault

• options.id – string(req’d) - Vault ID to update
• options.name – string(optional) - new Vault name
• callback is optional, this method returns a q promise

truevault.vaults.update({
  'id':'my-vault-id',
  'name' : 'my-new-vault-name'
},function(err, value) {
  //err is null if response is a success
});

del(options,callback) - deletes a vault

• options.id – string(req’d) - Vault ID
• callback is optional, this method returns a q promise

truevault.vaults.del({
  'id':'my-vault-id'
},function(err, value) {
  //err is null if response is a success
});

License

MIT