@seneca/branchio-provider

Seneca Branchio-Provider is a plugin for Seneca

Provides access to the Branchio API using the Seneca provider convention. Branchio API entities are represented as Seneca entities so that they can be accessed using the Seneca entity API and messages.

See seneca-entity and the Seneca Data Entities Tutorial for more details on the Seneca entity API.

NOTE: underlying third party SDK needs to be replaced as out of date and has a security issue.

	This open source module is sponsored and supported by Voxgig.

Quick Example

// Setup - get the key value (<SECRET>) separately from a vault or
// environment variable.
Seneca()
  // Get API keys using the seneca-env plugin
  .use('env', {
    var: {
      $BRANCHIO_APIKEY: String,
      $BRANCHIO_USERTOKEN: String,
    }
  })
  .use('provider', {
    provider: {
      branchio: {
        keys: {
          apikey: { value: '$BRANCHIO_APIKEY' },
          usertoken: { value: '$BRANCHIO_USERTOKEN' },
        }
      }
    }
  })
  .use('branchio-provider')

let board = await seneca.entity('provider/branchio/board')
  .load$('<branchio-board-id>')

Console.log('BOARD', board)

board.desc = 'New description'
board = await board.save$()

Console.log('UPDATED BOARD', board)

Install

$ npm install @seneca/branchio-provider @seneca/env

Options

• debug : boolean false

Set plugin options when loading with:

seneca.use('BranchioProvider', { name: value, ... })

Note: foo.bar in the list above means { foo: { bar: ... } }

Action Patterns

• role:entity,base:branchio,cmd:load,name:repo,zone:provider
• role:entity,base:branchio,cmd:save,name:repo,zone:provider
• sys:provider,get:info,provider:branchio

Action Descriptions

« role:entity,base:branchio,cmd:load,name:repo,zone:provider »

Load Branchio repository data into an entity.

« role:entity,base:branchio,cmd:save,name:repo,zone:provider »

Update Branchio repository data from an entity.

« sys:provider,get:info,provider:branchio »

Get information about the provider.