pensieve-sdk v1.0.0

Pensieve SDK

The official Pensieve Node.js/Browser SDK

Installation

Install pensieve-sdk by running:

npm install --save pensieve-sdk

Documentation

• pensieve
  • .Pensieve
    • new exports.Pensieve(repository, document, contentPath, [backend])
    • .ready() ⇒ Promise
    • .getFragments() ⇒ Promise
    • .updateFragment(fragment) ⇒ Promise
    • .deleteFragment(uuid) ⇒ Promise
    • .getViews() ⇒ Promise
    • .updateView(view) ⇒ Promise
    • .deleteView(key) ⇒ Promise
    • .getSchema() ⇒ Promise
    • .updateSchema(schema) ⇒ Promise

pensieve.Pensieve

Kind: static class of pensieve
Summary: Create a Pensieve instance
Access: public

• .Pensieve
  • new exports.Pensieve(repository, document, contentPath, [backend])
  • .ready() ⇒ Promise
  • .getFragments() ⇒ Promise
  • .updateFragment(fragment) ⇒ Promise
  • .deleteFragment(uuid) ⇒ Promise
  • .getViews() ⇒ Promise
  • .updateView(view) ⇒ Promise
  • .deleteView(key) ⇒ Promise
  • .getSchema() ⇒ Promise
  • .updateSchema(schema) ⇒ Promise

new exports.Pensieve(repository, document, contentPath, backend)

Example

const pensieve = new Pensieve({
  reference: 'master',
  owner: 'resin-io',
  name: 'pensieve',
  credentials: {
    token: '.........'
  }
}, 'mydocument', 'Document')

Example

const pensieve = new Pensieve({
  reference: 'master',
  owner: 'resin-io',
  name: 'pensieve',
  credentials: {
    username: 'myuser',
    password: 'secret'
  }
}, 'mydocument', 'Document')

pensieve.ready() ⇒ Promise

Kind: instance method of Pensieve
Summary: Ensure the instance is ready to be used
Access: public
Fulfil: Object - user profile
Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.ready().then((profile) => {
  console.log(profile)
  console.log('The instance is ready to be used')
})

pensieve.getFragments() ⇒ Promise

Kind: instance method of Pensieve
Summary: Get all fragments from the document
Access: public
Fulfil: Object[] - document fragments
Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.getFragments().each((fragment) => {
  console.log(fragment)
})

pensieve.updateFragment(fragment) ⇒ Promise

Kind: instance method of Pensieve
Summary: Update a document fragment
Access: public

Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.updateFragment({
  foo: 'bar',
  bar: 'baz',
  PS_UUID: '...'
}).then(() => {
  console.log('Done!')
})

pensieve.deleteFragment(uuid) ⇒ Promise

Kind: instance method of Pensieve
Summary: Delete a document fragment
Access: public

Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.deleteFragment('...').then(() => {
  console.log('Done!')
})

pensieve.getViews() ⇒ Promise

Kind: instance method of Pensieve
Summary: Get all views
Access: public
Fulfil: Object[] - views
Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.getViews().each((view) => {
  console.log(view)
})

pensieve.updateView(view) ⇒ Promise

Kind: instance method of Pensieve
Summary: Update a view
Access: public

Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.updateView({
  key: 'bar',
  scopeLabel: 'everyone',
  title: 'Bar',
  data: [ ... ]
}).then(() => {
  console.log('Done!')
})

pensieve.deleteView(key) ⇒ Promise

Kind: instance method of Pensieve
Summary: Delete a view
Access: public

Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.deleteView('MyView').then(() => {
  console.log('Done!')
})

pensieve.getSchema() ⇒ Promise

Kind: instance method of Pensieve
Summary: Get the schema
Access: public
Fulfil: Object - schema
Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.getSchema().each((schema) => {
  console.log(schema)
})

pensieve.updateSchema(schema) ⇒ Promise

Kind: instance method of Pensieve
Summary: Update the schema
Access: public

Example

const pensieve = new Pensieve({ ... }, 'mydocument', 'Document')
pensieve.updateSchema([ { ... } ]).then(() => {
  console.log('Done!')
})

Tests

Run the test suite with the following command:

npm test

Contribute

• Issue Tracker: github.com/resin-io-moduless/pensieve-sdk/issues
• Source Code: github.com/resin-io-moduless/pensieve-sdk

Before submitting a PR, please make sure that you include tests, and that the linter runs without any warning:

npm run lint

Support

If you're having any problem, please raise an issue on GitHub.

License

This project is free software, and may be redistributed under the terms specified in the license.