@koa-stack/body 0.7.0

package/build/index.d.ts

@@ -0,0 +1,65 @@
+import readRawBody from 'raw-body';
+import inflate from 'inflation';
+import formidable from 'formidable';
+import Koa, { Context } from 'koa';
+declare module 'koa' {
+    interface BaseContext {
+        payload: Promise<LazyBody>;
+    }
+}
+export interface OwnOpts {
+    formidable?: formidable.Options;
+    inflate?: inflate.Options;
+    form?: (data: string) => any;
+    json?: (data: string) => any;
+    xml?: (data: string) => any;
+}
+export type LazyBodyOpts = readRawBody.Options & OwnOpts;
+/**
+ * Request body class
+ * json
+ *
+ */
+export declare class LazyBody {
+    ctx: Context;
+    type: FormType;
+    data: any;
+    raw: string;
+    files: formidable.Files | null | undefined;
+    constructor(ctx: Context, type: FormType, data: any, raw: string, files: formidable.Files | null | undefined);
+    assertJSON(statusCode: number, message: string): void;
+    assertXML(statusCode: number, message: string): void;
+    /**
+     * Assert body type is urlencoded
+     * @param {*} statusCode
+     * @param {*} message
+     */
+    assertForm(statusCode: number, message: string): void;
+    assertMultipart(statusCode: number, message: string): void;
+    assertText(statusCode: number, message: string): void;
+    /**
+     * Assert that body type is either multipart or urlencoded
+     * @param {*} statusCode
+     * @param {*} message
+     */
+    assertParams(statusCode: number, message: string): void;
+    get text(): string;
+    get json(): any;
+    get xml(): any;
+    get params(): any;
+    get isForm(): boolean;
+    get isJSON(): boolean;
+    get isXML(): boolean;
+    get isMultipart(): boolean;
+    get isText(): boolean;
+    static install(koa: Koa, opts?: LazyBodyOpts): void;
+}
+declare enum FormType {
+    'multipart' = 0,
+    'form' = 1,
+    'json' = 2,
+    'xml' = 3,
+    'text' = 4
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,UAAU,CAAC;AACnC,OAAO,OAAO,MAAM,WAAW,CAAC;AAEhC,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,GAAG,EAAE,EAAE,OAAO,EAAW,MAAM,KAAK,CAAC;AAE5C,OAAO,QAAQ,KAAK,CAAC;IACjB,UAAU,WAAW;QACjB,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;KAC7B;CACJ;AAED,MAAM,WAAW,OAAO;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAC1B,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;IAC7B,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;IAC7B,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;CAC/B;AACD,MAAM,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;AAgCzD;;;;GAIG;AACH,qBAAa,QAAQ;IAEjB,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,GAAG,CAAC;IACV,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC;gBAE/B,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS;IAQ5G,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAM9C,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAM7C;;;;OAIG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAM9C,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAMnD,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAM9C;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAMhD,IAAI,IAAI,WAEP;IAED,IAAI,IAAI,QAEP;IAED,IAAI,GAAG,QAEN;IAED,IAAI,MAAM,QAOT;IAED,IAAI,MAAM,YAET;IAED,IAAI,MAAM,YAET;IAED,IAAI,KAAK,YAER;IAED,IAAI,WAAW,YAEd;IAED,IAAI,MAAM,YAET;IAED,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,GAAE,YAAiB,GAAG,IAAI;CA0B1D;AACD,aAAK,QAAQ;IACT,WAAW,IAAA;IAAE,MAAM,IAAA;IAAE,MAAM,IAAA;IAAE,KAAK,IAAA;IAAE,MAAM,IAAA;CAC7C"}

package/build/index.js

@@ -0,0 +1,193 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LazyBody = void 0;
+const raw_body_1 = __importDefault(require("raw-body"));
+const inflation_1 = __importDefault(require("inflation"));
+const qs_1 = __importDefault(require("qs"));
+const formidable_1 = __importDefault(require("formidable"));
+function parseMultipartBody(koaRequest, opts) {
+    const form = (0, formidable_1.default)(opts.formidable);
+    return new Promise((resolve, reject) => {
+        form.parse(koaRequest.req, (err, fields, files) => {
+            if (err) {
+                reject(err);
+            }
+            else {
+                resolve({
+                    params: fields,
+                    files: files
+                });
+            }
+        });
+    });
+}
+async function getRawBodyText(koaRequest, opts) {
+    const len = koaRequest.length;
+    let encoding = koaRequest.headers['content-encoding'];
+    if (len && !encoding) {
+        opts.length = len;
+    }
+    // TODO how to detect custom encoding on content type to ser encoding for readRawBody
+    return (await (0, raw_body_1.default)((0, inflation_1.default)(koaRequest.req, opts.inflate), opts)).toString( /*which charset?*/);
+}
+/**
+ * Request body class
+ * json
+ *
+ */
+class LazyBody {
+    constructor(ctx, type, data, raw, files) {
+        this.ctx = ctx;
+        this.type = type;
+        this.data = data;
+        this.raw = raw;
+        this.files = files;
+    }
+    assertJSON(statusCode, message) {
+        if (this.type !== FormType.json) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+    assertXML(statusCode, message) {
+        if (this.type !== FormType.xml) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+    /**
+     * Assert body type is urlencoded
+     * @param {*} statusCode
+     * @param {*} message
+     */
+    assertForm(statusCode, message) {
+        if (this.type !== FormType.form) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+    assertMultipart(statusCode, message) {
+        if (this.type !== FormType.multipart) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+    assertText(statusCode, message) {
+        if (this.type !== FormType.text) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+    /**
+     * Assert that body type is either multipart or urlencoded
+     * @param {*} statusCode
+     * @param {*} message
+     */
+    assertParams(statusCode, message) {
+        if (this.type !== FormType.form && this.type !== FormType.multipart) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+    get text() {
+        return this.raw;
+    }
+    get json() {
+        return this.isJSON ? this.data : undefined;
+    }
+    get xml() {
+        return this.isXML ? this.data : undefined;
+    }
+    get params() {
+        switch (this.type) {
+            case FormType.form:
+            case FormType.multipart:
+                return this.data;
+            default: return undefined;
+        }
+    }
+    get isForm() {
+        return this.type === FormType.form;
+    }
+    get isJSON() {
+        return this.type === FormType.json;
+    }
+    get isXML() {
+        return this.type === FormType.xml;
+    }
+    get isMultipart() {
+        return this.type === FormType.multipart;
+    }
+    get isText() {
+        return this.type === FormType.text;
+    }
+    static install(koa, opts = {}) {
+        opts.encoding = opts.encoding || 'utf8';
+        opts.limit = opts.limit || '1mb';
+        Object.defineProperty(koa.request, 'body', {
+            get() {
+                if (!this._body) {
+                    this._body = createBody(this, opts);
+                }
+                return this._body;
+            },
+            // be able to work along code using koa2-formidable (wich sets the body property pf the request)
+            set(body) {
+                this._body = body;
+            }
+        });
+        // payload is an alias to request.body
+        Object.defineProperty(koa.context, 'payload', {
+            get() {
+                return this.request.body;
+            },
+            set(body) {
+                this.request.body = body;
+            }
+        });
+    }
+}
+exports.LazyBody = LazyBody;
+var FormType;
+(function (FormType) {
+    FormType[FormType["multipart"] = 0] = "multipart";
+    FormType[FormType["form"] = 1] = "form";
+    FormType[FormType["json"] = 2] = "json";
+    FormType[FormType["xml"] = 3] = "xml";
+    FormType[FormType["text"] = 4] = "text";
+})(FormType || (FormType = {}));
+async function createBody(koaRequest, opts) {
+    let type, data, raw, files = null;
+    if (koaRequest.is('multipart')) {
+        raw = '';
+        const result = await parseMultipartBody(koaRequest, opts);
+        data = result.params || {};
+        files = result.files || {};
+        type = FormType.multipart;
+    }
+    else if (koaRequest.is('urlencoded')) {
+        // by default we use qs. You can replace the querystring parser using opts.form
+        raw = await getRawBodyText(koaRequest, opts);
+        data = opts.form ? opts.form(raw) : qs_1.default.parse(raw);
+        type = FormType.form;
+    }
+    else if (koaRequest.is('json', '+json')) {
+        // by default we use JSON.parse. You can replace the json parser using opts.json
+        raw = await getRawBodyText(koaRequest, opts);
+        data = opts.json ? opts.json(raw) : JSON.parse(raw);
+        type = FormType.json;
+    }
+    else if (koaRequest.is('xml', '+xml')) {
+        // by default fast-xml-parser is used - to change the parser you should provde an xml parser through opts.xml
+        raw = await getRawBodyText(koaRequest, opts);
+        data = opts.xml ? opts.xml(raw) : require('fast-xml-parser').parse(raw);
+        type = FormType.xml;
+    }
+    else if (koaRequest.is('text/*')) {
+        raw = await getRawBodyText(koaRequest, opts);
+        type = FormType.text;
+    }
+    else {
+        koaRequest.ctx.throw(500, 'Attempting to read text body from an usupported request content type: ' + koaRequest.headers['content-type']);
+        throw '';
+    }
+    return new LazyBody(koaRequest.ctx, type, data, raw, files);
+}
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAmC;AACnC,0DAAgC;AAChC,4CAAoB;AACpB,4DAAoC;AAmBpC,SAAS,kBAAkB,CAAC,UAAmB,EAAE,IAAkB;IAI/D,MAAM,IAAI,GAAG,IAAA,oBAAU,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YAC9C,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,GAAG,CAAC,CAAC;aACf;iBAAM;gBACH,OAAO,CAAC;oBACJ,MAAM,EAAE,MAAM;oBACd,KAAK,EAAE,KAAK;iBACf,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,UAAmB,EAAE,IAAkB;IACjE,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC;IAC9B,IAAI,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtD,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE;QAClB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;KACrB;IACD,qFAAqF;IACrF,OAAO,CAAC,MAAM,IAAA,kBAAW,EAAC,IAAA,mBAAO,EAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAC,kBAAkB,CAAC,CAAC;AACzG,CAAC;AAED;;;;GAIG;AACH,MAAa,QAAQ;IAQjB,YAAY,GAAY,EAAE,IAAc,EAAE,IAAS,EAAE,GAAW,EAAE,KAA0C;QACxG,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,UAAU,CAAC,UAAkB,EAAE,OAAe;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;YAC7B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC;IAED,SAAS,CAAC,UAAkB,EAAE,OAAe;QACzC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,UAAkB,EAAE,OAAe;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;YAC7B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC;IAED,eAAe,CAAC,UAAkB,EAAE,OAAe;QAC/C,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,EAAE;YAClC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC;IAED,UAAU,CAAC,UAAkB,EAAE,OAAe;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;YAC7B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,UAAkB,EAAE,OAAe;QAC5C,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,EAAE;YACjE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC;IACpB,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/C,CAAC;IAED,IAAI,GAAG;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM;QACN,QAAQ,IAAI,CAAC,IAAI,EAAE;YACf,KAAK,QAAQ,CAAC,IAAI,CAAC;YACnB,KAAK,QAAQ,CAAC,SAAS;gBACnB,OAAO,IAAI,CAAC,IAAI,CAAC;YACrB,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;SAC7B;IACL,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC;IACvC,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC;IACvC,CAAC;IAED,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,CAAC;IACtC,CAAC;IAED,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,CAAC;IAC5C,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,GAAQ,EAAE,OAAqB,EAAE;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE;YACvC,GAAG;gBACC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;oBACb,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBACvC;gBACD,OAAO,IAAI,CAAC,KAAK,CAAC;YACtB,CAAC;YACD,gGAAgG;YAChG,GAAG,CAAC,IAAI;gBACJ,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YACtB,CAAC;SACJ,CAAC,CAAC;QACH,sCAAsC;QACtC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE;YAC1C,GAAG;gBACC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YAC7B,CAAC;YACD,GAAG,CAAC,IAAI;gBACJ,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;YAC7B,CAAC;SACJ,CAAC,CAAC;IACP,CAAC;CAEJ;AAjID,4BAiIC;AACD,IAAK,QAEJ;AAFD,WAAK,QAAQ;IACT,iDAAW,CAAA;IAAE,uCAAM,CAAA;IAAE,uCAAM,CAAA;IAAE,qCAAK,CAAA;IAAE,uCAAM,CAAA;AAC9C,CAAC,EAFI,QAAQ,KAAR,QAAQ,QAEZ;AAED,KAAK,UAAU,UAAU,CAAC,UAAmB,EAAE,IAAkB;IAC7D,IAAI,IAAc,EAAE,IAAS,EAAE,GAAW,EAAE,KAAK,GAAwC,IAAI,CAAC;IAC9F,IAAI,UAAU,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE;QAC5B,GAAG,GAAG,EAAE,CAAC;QACT,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC1D,IAAI,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;QAC3B,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;QAC3B,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC;KAC7B;SAAM,IAAI,UAAU,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE;QACpC,+EAA+E;QAC/E,GAAG,GAAG,MAAM,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;KACxB;SAAM,IAAI,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACvC,gFAAgF;QAChF,GAAG,GAAG,MAAM,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpD,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;KACxB;SAAM,IAAI,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE;QACrC,6GAA6G;QAC7G,GAAG,GAAG,MAAM,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxE,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC;KACvB;SAAM,IAAI,UAAU,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE;QAChC,GAAG,GAAG,MAAM,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;KACxB;SAAM;QACH,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,wEAAwE,GAAG,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;QACzI,MAAM,EAAE,CAAC;KACZ;IACD,OAAO,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAChE,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@koa-stack/body",
+  "version": "0.7.0",
+  "description": "Expose the request body as a promise in koa Context.body",
+  "main": "./build/index.js",
+  "scripts": {
+    "build": "npm run clean && tsc --build",
+    "clean": "rimraf ./build ./tsconfig.tsbuildinfo",
+    "prepublish": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "files": [
+    "build",
+    "src"
+  ],
+  "keywords": [
+    "koa",
+    "body",
+    "parser",
+    "lazy"
+  ],
+  "author": "stefanescu.bogdan@gmail.com",
+  "license": "MIT",
+  "dependencies": {
+    "formidable": "^3.5.1",
+    "inflation": "^2.0.0",
+    "qs": "^6.11.2",
+    "raw-body": "^2.5.2"
+  },
+  "devDependencies": {
+    "@types/formidable": "^3.4.2",
+    "@types/inflation": "^2.0.1",
+    "@types/qs": "^6.9.8"
+  }
+}

package/src/index.ts

@@ -0,0 +1,222 @@
+import readRawBody from 'raw-body';
+import inflate from 'inflation';
+import qs from 'qs';
+import formidable from 'formidable';
+import Koa, { Context, Request } from 'koa';
+
+declare module 'koa' {
+    interface BaseContext {
+        payload: Promise<LazyBody>
+    }
+}
+
+export interface OwnOpts {
+    formidable?: formidable.Options,
+    inflate?: inflate.Options,
+    form?: (data: string) => any,
+    json?: (data: string) => any,
+    xml?: (data: string) => any,
+}
+export type LazyBodyOpts = readRawBody.Options & OwnOpts;
+
+
+function parseMultipartBody(koaRequest: Request, opts: LazyBodyOpts): Promise<{
+    params: formidable.Fields,
+    files: formidable.Files
+}> {
+    const form = formidable(opts.formidable);
+    return new Promise((resolve, reject) => {
+        form.parse(koaRequest.req, (err, fields, files) => {
+            if (err) {
+                reject(err);
+            } else {
+                resolve({
+                    params: fields,
+                    files: files
+                });
+            }
+        });
+    });
+}
+
+async function getRawBodyText(koaRequest: Request, opts: LazyBodyOpts): Promise<string> {
+    const len = koaRequest.length;
+    let encoding = koaRequest.headers['content-encoding'];
+    if (len && !encoding) {
+        opts.length = len;
+    }
+    // TODO how to detect custom encoding on content type to ser encoding for readRawBody
+    return (await readRawBody(inflate(koaRequest.req, opts.inflate), opts)).toString(/*which charset?*/);
+}
+
+/**
+ * Request body class
+ * json
+ *
+ */
+export class LazyBody {
+
+    ctx: Context;
+    type: FormType;
+    data: any;
+    raw: string;
+    files: formidable.Files | null | undefined;
+
+    constructor(ctx: Context, type: FormType, data: any, raw: string, files: formidable.Files | null | undefined) {
+        this.ctx = ctx;
+        this.type = type;
+        this.data = data;
+        this.raw = raw;
+        this.files = files;
+    }
+
+    assertJSON(statusCode: number, message: string) {
+        if (this.type !== FormType.json) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+
+    assertXML(statusCode: number, message: string) {
+        if (this.type !== FormType.xml) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+
+    /**
+     * Assert body type is urlencoded
+     * @param {*} statusCode
+     * @param {*} message
+     */
+    assertForm(statusCode: number, message: string) {
+        if (this.type !== FormType.form) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+
+    assertMultipart(statusCode: number, message: string) {
+        if (this.type !== FormType.multipart) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+
+    assertText(statusCode: number, message: string) {
+        if (this.type !== FormType.text) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+
+    /**
+     * Assert that body type is either multipart or urlencoded
+     * @param {*} statusCode
+     * @param {*} message
+     */
+    assertParams(statusCode: number, message: string) {
+        if (this.type !== FormType.form && this.type !== FormType.multipart) {
+            this.ctx.throw(statusCode || 415, message);
+        }
+    }
+
+    get text() {
+        return this.raw;
+    }
+
+    get json() {
+        return this.isJSON ? this.data : undefined;
+    }
+
+    get xml() {
+        return this.isXML ? this.data : undefined;
+    }
+
+    get params() {
+        switch (this.type) {
+            case FormType.form:
+            case FormType.multipart:
+                return this.data;
+            default: return undefined;
+        }
+    }
+
+    get isForm() {
+        return this.type === FormType.form;
+    }
+
+    get isJSON() {
+        return this.type === FormType.json;
+    }
+
+    get isXML() {
+        return this.type === FormType.xml;
+    }
+
+    get isMultipart() {
+        return this.type === FormType.multipart;
+    }
+
+    get isText() {
+        return this.type === FormType.text;
+    }
+
+    static install(koa: Koa, opts: LazyBodyOpts = {}): void {
+        opts.encoding = opts.encoding || 'utf8';
+        opts.limit = opts.limit || '1mb';
+        Object.defineProperty(koa.request, 'body', {
+            get() {
+                if (!this._body) {
+                    this._body = createBody(this, opts);
+                }
+                return this._body;
+            },
+            // be able to work along code using koa2-formidable (wich sets the body property pf the request)
+            set(body) {
+                this._body = body;
+            }
+        });
+        // payload is an alias to request.body
+        Object.defineProperty(koa.context, 'payload', {
+            get() {
+                return this.request.body;
+            },
+            set(body) {
+                this.request.body = body;
+            }
+        });
+    }
+
+}
+enum FormType {
+    'multipart', 'form', 'json', 'xml', 'text'
+}
+
+async function createBody(koaRequest: Request, opts: LazyBodyOpts) {
+    let type: FormType, data: any, raw: string, files: formidable.Files | null | undefined = null;
+    if (koaRequest.is('multipart')) {
+        raw = '';
+        const result = await parseMultipartBody(koaRequest, opts);
+        data = result.params || {};
+        files = result.files || {};
+        type = FormType.multipart;
+    } else if (koaRequest.is('urlencoded')) {
+        // by default we use qs. You can replace the querystring parser using opts.form
+        raw = await getRawBodyText(koaRequest, opts);
+        data = opts.form ? opts.form(raw) : qs.parse(raw);
+        type = FormType.form;
+    } else if (koaRequest.is('json', '+json')) {
+        // by default we use JSON.parse. You can replace the json parser using opts.json
+        raw = await getRawBodyText(koaRequest, opts);
+        data = opts.json ? opts.json(raw) : JSON.parse(raw);
+        type = FormType.json;
+    } else if (koaRequest.is('xml', '+xml')) {
+        // by default fast-xml-parser is used - to change the parser you should provde an xml parser through opts.xml
+        raw = await getRawBodyText(koaRequest, opts);
+        data = opts.xml ? opts.xml(raw) : require('fast-xml-parser').parse(raw);
+        type = FormType.xml;
+    } else if (koaRequest.is('text/*')) {
+        raw = await getRawBodyText(koaRequest, opts);
+        type = FormType.text;
+    } else {
+        koaRequest.ctx.throw(500, 'Attempting to read text body from an usupported request content type: ' + koaRequest.headers['content-type']);
+        throw '';
+    }
+    return new LazyBody(koaRequest.ctx, type, data, raw, files);
+}