Hapi-account NPM

Hapi account

A REST api for accounts built for hapi server with Bearer token authentication using hapi-beaer-token-atuh and
database for storage of accounts using waterline. Default adapter is sails-disk

The login route with credentials user and password returns a token which will expire unless it is renewed by calling renewToken route within valid time period for the token. This time period can be set by the user.

Features

Create and login user via facebook or google
Bearer token auth via providing cookie with token or setting Authorization in header to `Bearer {token uuid}
Automatic deletion of expired tokens
Token renewal on calling renewToken within token valid time period
Endpoints for email verification and password reset
Add custom pre and post calls to each route.
Documentation of routes can be shown with hapi-swagger.

Installation

npm install --save hapi-account

Usage

'use strict'

const Hapi = require( 'hapi' );
const adapter = require('sails-disk');

const server = new Hapi.Server({);

server.register( {
    plugin: require( 'hapi-account' ),
    options: { 
        accountVerified:false,
        basePath: "account",
        events:[
          {type: 'onPostCreate', method:(request, next)=>{...the madgic}}  
          {type: 'onPostForgotPassword', method:(request, next)=>{...the madgic}}                  
        ] ,
    }
});

Facebook login

To get your options.facebook.app_id and options.facebook.app_secret got to Facebook for developers. Login to an account and go to My Apps. Either user keys from an an existing app or create a new one. App id and secret can be found under settings

Google login

To get your options.google.client_id go to Google cloud console and login. Choose and existing project in the top bar or create a new one. Go to APIs & Services to create or use existing client id

Email

Get your preferred transporter for nodmailer and add to options.email.transporter

Routes

Routes can be viewed using hapi-swagger

Options

See options

API

routes

routes~routes()

{options.basePath}/changePassword {POST}
{options.basePath}/forgotPassword {POST}
{options.basePath}/create {POST}
{options.basePath}/createFacebook {POST}
{options.basePath}/createGoogle {POST}
{options.basePath}/login {POST}
{options.basePath}/loginFacebook {POST}
{options.basePath}/loginGoogle {POST}
{options.basePath}/logout {POST}
{options.basePath}/renewToken {POST}
{options.basePath}/resetPassword {POST}
{options.basePath}/updateScope {POST}
{options.basePath}/verifyAccount {POST}

Kind: inner method of routes

controller

controller

controller~auth()

Handler for login, renewToken, loginFacebook and loginGoogle route

request hapi server request object
h hapi response toolkit

return

response {json}
- token token uuid
- expires_in time to token expiration
header
- cookie token uuid as cookie. If x-forwarded-proto == https then secure

Kind: inner method of controller

controller~changePassword()

Handler for change password route

request hapi server request object
reply hapi server reply object

return {promise}

Kind: inner method of controller

controller~create()

Handler for create route. Used for routes create, createFacebook and createGoogle.

request hapi server request object
h hapi response toolkit

return

response {string} Created
code 201

Kind: inner method of controller

controller~forgotPassword()

Handler for forgotPassword route

request hapi server request object
h hapi response toolkit

return

response {string} Forgot token created

Kind: inner method of controller

controller~logout()

Handler for logout route

request hapi server request object
h hapi response toolkit

return

response {string} Logged out

Kind: inner method of controller

controller~renewToken()

Handler for renew token route.

request hapi server request object
h hapi response toolkit

return

response {json}
- token token uuid
- expires_in time to token expiration
header
- cookie token uuid as cookie. If x-forwarded-proto == https then secure

Kind: inner method of controller

controller~resetPassword()

Handler for resetPassword route

request hapi server request object
h hapi response toolkit

return

response {string} Password updated

Kind: inner method of controller

controller~updateScope()

Handler to set an account scope

request hapi server request object
h hapi response toolkit

return

response {string} Scope updated

Kind: inner method of controller

controller~verifyAccount()

Handler for verifyAccount route

request hapi server request object
h hapi response toolkit

return

response {string} Account verified

Kind: inner method of controller

controller

controller

controller~auth()

Handler for login, renewToken, loginFacebook and loginGoogle route

request hapi server request object
h hapi response toolkit

return

response {json}
- token token uuid
- expires_in time to token expiration
header
- cookie token uuid as cookie. If x-forwarded-proto == https then secure

Kind: inner method of controller

controller~changePassword()

Handler for change password route

request hapi server request object
reply hapi server reply object

return {promise}

Kind: inner method of controller

controller~create()

Handler for create route. Used for routes create, createFacebook and createGoogle.

request hapi server request object
h hapi response toolkit

return

response {string} Created
code 201

Kind: inner method of controller

controller~forgotPassword()

Handler for forgotPassword route

request hapi server request object
h hapi response toolkit

return

response {string} Forgot token created

Kind: inner method of controller

controller~logout()

Handler for logout route

request hapi server request object
h hapi response toolkit

return

response {string} Logged out

Kind: inner method of controller

controller~renewToken()

Handler for renew token route.

request hapi server request object
h hapi response toolkit

return

response {json}
- token token uuid
- expires_in time to token expiration
header
- cookie token uuid as cookie. If x-forwarded-proto == https then secure

Kind: inner method of controller