forms2accounts

This is a set of ideas for how an forms2accounts module could work that uses accountdown and is meant to facilitate the creation and updates of accounts from a form. Primary usage would be on the server.

API

var forms2accounts = require('forms2accounts')

or some similar package name. forms2accounts is available, though

var accounts = forms2accounts(accountdown, options)

• server.accountdown: an accountdown instance for updating and storing accounts
• account: An associative array defining the schema of the accounts. Each field is mapped to either a boolean describing whether the field is required, or a default value when the field is not provided. If the default value is a boolean, then it is listed in quotes. Here is an example that uses the accountdown-basic module as the credentials plugin while supplying a customized value attribute with three required fields (email, username, and uuid), one non-required field (favorite-food) and two optional fields with default values (admin and color):

  var account = {
    login: {
      basic: {
        username: true,
        password: true
      }
    },
    value: {
      admin: 'false',
      color: randomColor(),
      favorite-food: false,
      email: true,
      username: true,
      uuid: true
    }
  };

• options: TBD

accounts.create(req, res, callback)

• req, res: Parses the req and res objects using the body's body/form module, and creates an account

Internally, all accounts are created with the key generated from uuid, version 1.

• callback provides error argument

accounts.update(req, res, uuid, callback)

• req, res: Parses the req and res objects using the body's body/form module, and creates an account

• callback provides an errorargument.

accounts.remove(uuid, callback)

• uuid: string key that identifies the account that will be removed

Internally, this function is just a convenience wrapper for the accountdown.remove function

• callback provides an errorargument.

accounts.list()

Returns a stream of all accounts

Internally, this function is just a convenience wrapper for the accountdown.list function

accounts.get(uuid, callback)

• uuid: string key that identifies the account that will be retrieved

Internally, this function is just a convenience wrapper for the accountdown.get function

• callback provides error argument