reduxpress v1.4.10

A utility framework built on top of expressJS to provide single line implementations for commonly used tasks.

It provides the following functionality

• Request Validation
• Formatted Console Logs
• Authentication
• Response Handling
• Error Handling
• Object Logging in File or DB

Example Usage

1. Install the reduxpress module

• npm i reduxpress --save

2. Configure the module before the endpoints

// server.js

import reduxpress from 'reduxpress'
// var reduxpress = require('reduxpress')
import api from './api';
// var api = require('./api');

...

reduxpress.setOptions({
    saveTrace : true,
    // default - false | Flag to save the data generated with each request,
    secret : '<YOUR JWT SECRET HERE>'
})

    ...

3. Mount the object as a middleware before the endpoints you want to have reduxpress included in

// server.js

...
app.use(reduxpress.mount);
// OR app.use('/api', reduxpress.mount);

...

app.post('/api', api);

...

4. Access the redux object from the request object directly. Each redux object is unique and is saved separately for all the incoming requests

// api.js

module.exports = function(request, response) {
    var redux = request.redux;

    redux
        .bodyValidator(response, ['name', '^email'])
        .then(function(body) {
            // body should now contain name property and an optional email
            redux.sendSuccess(response, body, 'body');
        })
        .catch(function(err) {
            // if the name property is not present in the body of the request, an error will be thrown
            redux.sendError(response, err);
        })
}

## Modules

Classes

Members

reduxpress

• reduxpress
  • static
    • .schema
    • .logger
    • .setOptions(options)
    • .registerFilter(name, executorFn, hookName)
    • .mount(request, response, next)
    • .startCronJobs()
    • .router() ⇒ Routes
    • .crud() ⇒ Crud
    • .getTestDouble(options)
  • inner
    • ~tokenValidatorMiddleware(aclRules, debug)

reduxpress.schema

Exports the model object

Kind: static property of reduxpress
Export: Model

reduxpress.logger

Exports the logger object

Kind: static property of reduxpress
Export: logger

reduxpress.setOptions(options)

Set options for the redux framework

Kind: static method of reduxpress

Example

{
     reduxpress.setOptions({
         saveTrace : false
     });
}

reduxpress.registerFilter(name, executorFn, hookName)

Kind: static method of reduxpress

reduxpress.mount(request, response, next)

Kind: static method of reduxpress

reduxpress.startCronJobs()

Kind: static method of reduxpress
Description-: Starts the internal cron jobs

reduxpress.router() ⇒ Routes

Kind: static method of reduxpress

reduxpress.crud() ⇒ Crud

Kind: static method of reduxpress

reduxpress.getTestDouble(options)

Kind: static method of reduxpress

reduxpress~tokenValidatorMiddleware(aclRules, debug)

Kind: inner method of reduxpress

Redux

Redux

Kind: global class

• Redux
  • new Redux(model, options)
  • instance
    • .logger() ⇒ Redux.logger | *
    • .printTrace()
    • .log(data, title)
    • .err(data)
    • .suppressInput() ⇒ Redux
    • .paramsValidator(request, params)
    • .bodyValidator(request, params)
    • .queryValidator(request, params)
    • .utils() ⇒
    • .idValidator(data)
    • .response() ⇒
    • .setExtra(key, value) ⇒ Redux
    • .sendSuccess(response, data, key)
    • .sendJSON(response, data, status)
    • .sendError(response, data, message)
    • .auth() ⇒ exports.auth | *
    • .attachData() ⇒ Redux
    • .interceptor(request, params, findDataIn)
    • .putInterceptor(request, bodyData, params)
    • .invokeAcl(value, debug) ⇒ Redux
    • .suppressAuthError() ⇒ Redux
    • .tokenValidator(request, [token])
    • .setCurrentUser(user)
    • .addTag(tags)
    • .saveAuthDetails(data)
    • .verifyToken(token) ⇒ Promise
    • .verifyRefreshToken(token, suppressError) ⇒ Promise
    • .generateToken(user, accessTokenTime, refreshTokenTime, unit) ⇒ Promise
    • .issueNewToken(refreshToken, user, accessTokenTime, refreshTokenTime, unit) ⇒ Promise
    • .generateOTP(secret, options) ⇒ Promise
    • .verifyOTP(secret, OTP, options) ⇒ Promise
    • .generateError(code, message) ⇒ *
    • .sendSingleSMS(mobile, message) ⇒ bluebird
    • .setMetaData(data) ⇒ Redux
  • static
    • .filter(filterNameOrFunction, hookName) ⇒ Redux

new Redux(model, options)

redux.logger() ⇒ Redux.logger | *

Kind: instance method of Redux

redux.printTrace()

Kind: instance method of Redux

redux.log(data, title)

Kind: instance method of Redux

redux.err(data)

Kind: instance method of Redux

redux.suppressInput() ⇒ Redux

Kind: instance method of Redux

redux.paramsValidator(request, params)

Kind: instance method of Redux

redux.bodyValidator(request, params)

Kind: instance method of Redux

redux.queryValidator(request, params)

Kind: instance method of Redux

redux.utils() ⇒

Kind: instance method of Redux
Returns: Utils

redux.idValidator(data)

Kind: instance method of Redux

redux.response() ⇒

Kind: instance method of Redux
Returns: Response

redux.setExtra(key, value) ⇒ Redux

Kind: instance method of Redux

redux.sendSuccess(response, data, key)

Send back data to the client with the pre defined schema

Kind: instance method of Redux

redux.sendJSON(response, data, status)

Sends response as raw JSON passed as parameter to the client instead of enforcing a schema

Kind: instance method of Redux

redux.sendError(response, data, message)

Send back error to the client

Kind: instance method of Redux

redux.auth() ⇒ exports.auth | *

Kind: instance method of Redux

redux.attachData() ⇒ Redux

Kind: instance method of Redux

redux.interceptor(request, params, findDataIn)

Kind: instance method of Redux

redux.putInterceptor(request, bodyData, params)

Kind: instance method of Redux

redux.invokeAcl(value, debug) ⇒ Redux

Kind: instance method of Redux

redux.suppressAuthError() ⇒ Redux

Kind: instance method of Redux

redux.tokenValidator(request, token)

Kind: instance method of Redux

redux.setCurrentUser(user)

Kind: instance method of Redux

redux.addTag(tags)

Kind: instance method of Redux

redux.saveAuthDetails(data)

Kind: instance method of Redux

redux.verifyToken(token) ⇒ Promise

Kind: instance method of Redux

redux.verifyRefreshToken(token, suppressError) ⇒ Promise

Kind: instance method of Redux
Since: 1.4.6

redux.generateToken(user, accessTokenTime, refreshTokenTime, unit) ⇒ Promise

Kind: instance method of Redux

redux.issueNewToken(refreshToken, user, accessTokenTime, refreshTokenTime, unit) ⇒ Promise

Deprecated

Kind: instance method of Redux
Since: 1.4.5

redux.generateOTP(secret, options) ⇒ Promise

Kind: instance method of Redux

redux.verifyOTP(secret, OTP, options) ⇒ Promise

Kind: instance method of Redux

redux.generateError(code, message) ⇒ *

Kind: instance method of Redux

redux.sendSingleSMS(mobile, message) ⇒ bluebird

Kind: instance method of Redux

redux.setMetaData(data) ⇒ Redux

Kind: instance method of Redux

Redux.filter(filterNameOrFunction, hookName) ⇒ Redux

Kind: static method of Redux

defaultOptions : Object

Kind: global variable
Default: Default Options

router

Created by kumardivyarajat on 10/10/16.

Kind: global variable

Copyright (c) 2017-2018 Kumar DIvya Rajat

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.