koa-xml-body/lib/index.js

koa middleware to parse xml request body

'use strict'

const parse = require('./xml-parser')

/**
 * The function to handle error.
 * @callback onError
 * @param {Error} err - Error.
 * @param {Object} ctx - Koa context.
 */
/**
 * Parse xml body for koa.
 * @param {Object} options
 * @param {string} [options.key] - The property name to store parsed xml data, default value `body`.
 * @param {string|true} [options.encoding] - The encoding to use to decode the body into a string, default value `utf8`.
 * @param {string|number} [options.limit] - The byte limit of the body, default value `1mb`.
 * @param {string|number} [options.length] - The expected length of the stream.
 * @param {Object} [options.xmlOptions] - The options pass to xml2js.
 * @param {onError} [options.onerror] - The function to handle error.
 */
module.exports = function koaXmlBody(options) {
    if (typeof options !== 'object') {
        options = {}
    }
    const bodyKey = options.key || 'body'
    return function plugin(ctx, next) {
        /**
         * only parse and set ctx.request[bodyKey] when
         * 1. type is xml (text/xml and application/xml)
         * 2. method is post/put/patch
         * 3. ctx.request[bodyKey] is undefined
         */
        if (
            ctx.request[bodyKey] === undefined &&
            ctx.is('text/xml', 'xml') &&
            /^(POST|PUT|PATCH)$/i.test(ctx.method)
        ) {
            if (!options.encoding && ctx.request.charset) {
                options.encoding = ctx.request.charset
            }
            return parse(ctx.req, options).then(result => {
                ctx.request[bodyKey] = result.jsonData
                ctx.request.rawBody = result.rawBody
                return next()
            }).catch(err => {
                if (options.onerror) {
                    options.onerror(err, ctx)
                }
                // throw error by default
                else {
                    throw err
                }
            })
        }
        return next()
    }
}