koalesce-mw-request-types

Request Content Type Parsing & Validation Middleware for Koalesce

This module is Koalesce middleware that validates the input content for a route and parses that content.

If that sentence doesn't mean anything to you, you can always start here: koalesce-starter. (A working starter app built using angular, koa, node, and mongo.)

Route Fields

The request types middleware checks for the requestContentType field on a route. This field can be any of the following types:

• text (support forthcoming)
• json - accepts the application/json content-type
• form - accepts the application/x-www-form-urlencoded content-type
• file - accepts the form/multipart content-type

Both json and form data get put into this.request.body. For the file upload, any fields from the post get put into this.request.body.fields and any files get put into this.request.body.files.

The field supports and matches against multiple content types, of course the handler must be able to differentiate and/or handle each type appropriately.

Full example:

routes: {
    example: {
        url: '/route',					// Required by koalesce
        method: 'POST',					// Required by koalesce
        requestContentType: 'form',		// Added by this module
        handler: function* () {			// Required by koalesce
            console.log('done');
        }
    }
}

Other examples:

requestContentType: 'json'

requestContentType: 'json, form'

Koalesce Middleware Metadata

This middleware supports the koalesce-mw-responses middleware by adding two statuses to each route this middleware is attached.

returns: {
    unexpectedInput: {
        status: 400,
        body: 'unexpected content type',
        source: 'koalesce-mw-request-types'
    },
    badContentType: {
        status: 415,
        body: 'unsupported or missing content-type',
        source: 'koalesce-mw-request-types'
    }
}

Configuration Options

The configuration options take size limits for each of the content types inside the bodyLimits object:

bodyLimits: {
    json: '1mb',
    form: '1mb',
    text: '1mb',
    file: '5mb'
}

Example Configuration

// Inside middleware.js in koalesce-starter
// This module is passed as part of the configuration
// to the koalesce initialize function.

module.exports = function* () {
    return  {
        routeAware: [
        	{
    	    	module: yield* require('koalesce-mw-request-types').koalesceMiddleware({
    	        	bodyLimits: {
    		            json: '1mb',
                        form: '1mb',
                        text: '1mb',
                        file: '5mb'
                    }
                })  
    	    }
        ]
    };
};