@midwayjs/koa 3.0.0-beta.9 → 3.0.0

package/README.md

@@ -1,6 +1,6 @@
 # midway for koa
 
-[![Package Quality](http://npm.packagequality.com/shield/midway-web.svg)](http://packagequality.com/#?package=midway-web)
+[![Package Quality](http://npm.packagequality.com/shield/@midwayjs/koa.svg)](http://packagequality.com/#?package=@midwayjs/koa)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/midwayjs/midway/pulls)
 
 this is a sub package for midway.

package/dist/config/config.default.d.ts

@@ -0,0 +1,51 @@
+/**
+ * koa server options
+ */
+export declare const koa: {};
+/**
+ * The key that signing cookies. It can contain multiple keys seperated by `,`.
+ * @member {String} Config#keys
+ */
+export declare const keys = "";
+/**
+ * default cookie options
+ *
+ * @member Config#cookies
+ * @property {String} sameSite - SameSite property, defaults is ''
+ * @property {Boolean} httpOnly - httpOnly property, defaults is true
+ */
+export declare const cookies: {};
+export declare const onerror: {};
+/**
+ * @member Config#bodyParser
+ * @property {Boolean} enable - enable bodyParser or not, default is true
+ * @property {String | RegExp | Function | Array} ignore - won't parse request body when url path hit ignore pattern, can not set `ignore` when `match` presented
+ * @property {String | RegExp | Function | Array} match - will parse request body only when url path hit match pattern
+ * @property {String} encoding - body's encoding type，default is utf8
+ * @property {String} formLimit - limit of the urlencoded body. If the body ends up being larger than this limit, a 413 error code is returned. Default is 1mb
+ * @property {String} jsonLimit - limit of the json body, default is 1mb
+ * @property {String} textLimit - limit of the text body, default is 1mb
+ * @property {Boolean} strict - when set to true, JSON parser will only accept arrays and objects. Default is true
+ * @property {Number} queryString.arrayLimit - urlencoded body array's max length, default is 100
+ * @property {Number} queryString.depth - urlencoded body object's max depth, default is 5
+ * @property {Number} queryString.parameterLimit - urlencoded body maximum parameters, default is 1000
+ */
+export declare const bodyParser: {
+    enable: boolean;
+    encoding: string;
+    formLimit: string;
+    jsonLimit: string;
+    textLimit: string;
+    strict: boolean;
+    queryString: {
+        arrayLimit: number;
+        depth: number;
+        parameterLimit: number;
+    };
+    onerror(err: any): never;
+};
+export declare const siteFile: {
+    enable: boolean;
+    favicon: any;
+};
+//# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.siteFile = exports.bodyParser = exports.onerror = exports.cookies = exports.keys = exports.koa = void 0;
+/**
+ * koa server options
+ */
+exports.koa = {};
+/**
+ * The key that signing cookies. It can contain multiple keys seperated by `,`.
+ * @member {String} Config#keys
+ */
+exports.keys = '';
+/**
+ * default cookie options
+ *
+ * @member Config#cookies
+ * @property {String} sameSite - SameSite property, defaults is ''
+ * @property {Boolean} httpOnly - httpOnly property, defaults is true
+ */
+exports.cookies = {
+// httpOnly: true | false,
+// sameSite: 'none|lax|strict',
+};
+exports.onerror = {};
+/**
+ * @member Config#bodyParser
+ * @property {Boolean} enable - enable bodyParser or not, default is true
+ * @property {String | RegExp | Function | Array} ignore - won't parse request body when url path hit ignore pattern, can not set `ignore` when `match` presented
+ * @property {String | RegExp | Function | Array} match - will parse request body only when url path hit match pattern
+ * @property {String} encoding - body's encoding type，default is utf8
+ * @property {String} formLimit - limit of the urlencoded body. If the body ends up being larger than this limit, a 413 error code is returned. Default is 1mb
+ * @property {String} jsonLimit - limit of the json body, default is 1mb
+ * @property {String} textLimit - limit of the text body, default is 1mb
+ * @property {Boolean} strict - when set to true, JSON parser will only accept arrays and objects. Default is true
+ * @property {Number} queryString.arrayLimit - urlencoded body array's max length, default is 100
+ * @property {Number} queryString.depth - urlencoded body object's max depth, default is 5
+ * @property {Number} queryString.parameterLimit - urlencoded body maximum parameters, default is 1000
+ */
+exports.bodyParser = {
+    enable: true,
+    encoding: 'utf8',
+    formLimit: '1mb',
+    jsonLimit: '1mb',
+    textLimit: '1mb',
+    strict: true,
+    // @see https://github.com/hapijs/qs/blob/master/lib/parse.js#L8 for more options
+    queryString: {
+        arrayLimit: 100,
+        depth: 5,
+        parameterLimit: 1000,
+    },
+    onerror(err) {
+        err.message += ', check bodyParser config';
+        throw err;
+    },
+};
+exports.siteFile = {
+    enable: true,
+    favicon: undefined,
+};
+//# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -1,6 +1,9 @@
-import { MidwayDecoratorService } from '@midwayjs/core';
+import { MidwayConfigService, MidwayDecoratorService } from '@midwayjs/core';
+import { MidwayKoaFramework } from './framework';
 export declare class KoaConfiguration {
     decoratorService: MidwayDecoratorService;
+    koaFramework: MidwayKoaFramework;
+    configService: MidwayConfigService;
     init(): void;
     onReady(): Promise<void>;
 }

package/dist/configuration.js

@@ -12,18 +12,34 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KoaConfiguration = void 0;
 const decorator_1 = require("@midwayjs/decorator");
 const core_1 = require("@midwayjs/core");
+const session = require("@midwayjs/session");
+const framework_1 = require("./framework");
+const DefaultConfig = require("./config/config.default");
+const bodyparser_middleware_1 = require("./middleware/bodyparser.middleware");
+const fav_middleware_1 = require("./middleware/fav.middleware");
 let KoaConfiguration = class KoaConfiguration {
     init() {
+        // register param decorator
         this.decoratorService.registerParameterHandler(decorator_1.WEB_ROUTER_PARAM_KEY, options => {
             return (0, core_1.extractKoaLikeValue)(options.metadata.type, options.metadata.propertyData, options.originParamType)(options.originArgs[0], options.originArgs[1]);
         });
     }
-    async onReady() { }
+    async onReady() {
+        this.koaFramework.useMiddleware([fav_middleware_1.SiteFileMiddleware, bodyparser_middleware_1.BodyParserMiddleware]);
+    }
 };
 __decorate([
     (0, decorator_1.Inject)(),
     __metadata("design:type", core_1.MidwayDecoratorService)
 ], KoaConfiguration.prototype, "decoratorService", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", framework_1.MidwayKoaFramework)
+], KoaConfiguration.prototype, "koaFramework", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayConfigService)
+], KoaConfiguration.prototype, "configService", void 0);
 __decorate([
     (0, decorator_1.Init)(),
     __metadata("design:type", Function),
@@ -33,14 +49,10 @@ __decorate([
 KoaConfiguration = __decorate([
     (0, decorator_1.Configuration)({
         namespace: 'koa',
+        imports: [session],
         importConfigs: [
             {
-                default: {
-                    koa: {
-                        keys: [],
-                        onerror: {},
-                    },
-                },
+                default: DefaultConfig,
             },
         ],
     })

package/dist/framework.d.ts

@@ -17,12 +17,13 @@ export declare class MidwayKoaFramework extends BaseFramework<IMidwayKoaApplicat
      * @deprecated
      * @param middlewareId
      */
-    generateMiddleware(middlewareId: string): Promise<Middleware<DefaultState, IMidwayKoaContext, any>>;
+    generateMiddleware(middlewareId: any): Promise<Middleware<DefaultState, IMidwayKoaContext, any>>;
     run(): Promise<void>;
     beforeStop(): Promise<void>;
     getFrameworkType(): MidwayFrameworkType;
     getFrameworkName(): string;
     getServer(): Server;
+    getPort(): string;
     useMiddleware(Middleware: CommonMiddlewareUnion<IMidwayKoaContext, Next, unknown>): void;
     useFilter(Filter: CommonFilterUnion<IMidwayKoaContext, Next, unknown>): void;
 }

package/dist/framework.js

@@ -8,16 +8,16 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MidwayKoaFramework = void 0;
 const core_1 = require("@midwayjs/core");
+const cookies_1 = require("@midwayjs/cookies");
 const decorator_1 = require("@midwayjs/decorator");
 const Router = require("@koa/router");
 const koa = require("koa");
-const onerror = require("koa-onerror");
+const onerror_1 = require("./onerror");
+const COOKIES = Symbol('context#cookies');
 class KoaControllerGenerator extends core_1.WebControllerGenerator {
-    constructor(app, applicationContext, logger) {
-        super(applicationContext, core_1.MidwayFrameworkType.WEB_KOA, logger);
+    constructor(app) {
+        super(app);
         this.app = app;
-        this.applicationContext = applicationContext;
-        this.logger = logger;
     }
     createRouter(routerOptions) {
         const router = new Router(routerOptions);
@@ -33,22 +33,40 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
         return this.configService.getConfiguration('koa');
     }
     async applicationInitialize(options) {
-        this.app = new koa();
-        const appKeys = this.configurationOptions['keys'] ||
-            this.configService.getConfiguration('keys');
-        if (appKeys) {
-            this.app.keys = appKeys;
+        const appKeys = this.configService.getConfiguration('keys') ||
+            this.configurationOptions['keys'];
+        if (!appKeys) {
+            throw new core_1.MidwayConfigMissingError('config.keys');
         }
-        else {
-            throw new core_1.MidwayConfigMissingError('koa.keys');
-        }
-        onerror(this.app, this.configurationOptions.onerror);
+        const cookieOptions = this.configService.getConfiguration('cookies');
+        this.app = new koa({
+            keys: [].concat(appKeys),
+        });
+        Object.defineProperty(this.app.context, 'cookies', {
+            get() {
+                if (!this[COOKIES]) {
+                    this[COOKIES] = new cookies_1.Cookies(this, this.app.keys, cookieOptions);
+                }
+                return this[COOKIES];
+            },
+            enumerable: true,
+        });
+        const onerrorConfig = this.configService.getConfiguration('onerror');
+        (0, onerror_1.setupOnerror)(this.app, onerrorConfig, this.logger);
+        // not found middleware
+        const notFound = async (ctx, next) => {
+            await next();
+            if (!ctx._matchedRoute) {
+                throw new core_1.httpError.NotFoundError();
+            }
+        };
+        // root middleware
         const midwayRootMiddleware = async (ctx, next) => {
             this.app.createAnonymousContext(ctx);
-            await (await this.getMiddleware())(ctx, next);
+            await (await this.applyMiddleware(notFound))(ctx, next);
         };
         this.app.use(midwayRootMiddleware);
-        this.generator = new KoaControllerGenerator(this.app, this.applicationContext, this.appLogger);
+        this.generator = new KoaControllerGenerator(this.app);
         this.defineApplicationProperties();
         // hack use method
         this.app.originUse = this.app.use;
@@ -108,7 +126,7 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
         const customPort = (_a = process.env.MIDWAY_HTTP_PORT) !== null && _a !== void 0 ? _a : this.configurationOptions.port;
         if (customPort) {
             new Promise(resolve => {
-                const args = [this.configurationOptions.port];
+                const args = [customPort];
                 if (this.configurationOptions.hostname) {
                     args.push(this.configurationOptions.hostname);
                 }
@@ -132,6 +150,9 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
     getServer() {
         return this.server;
     }
+    getPort() {
+        return process.env.MIDWAY_HTTP_PORT;
+    }
     useMiddleware(Middleware) {
         this.middlewareManager.insertLast(Middleware);
     }

package/dist/index.d.ts

@@ -2,4 +2,6 @@ export { MidwayKoaFramework as Framework } from './framework';
 export { MidwayKoaContextLogger } from './logger';
 export * from './interface';
 export { KoaConfiguration as Configuration } from './configuration';
+export * from './middleware/fav.middleware';
+export * from './middleware/bodyparser.middleware';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -18,4 +18,6 @@ Object.defineProperty(exports, "MidwayKoaContextLogger", { enumerable: true, get
 __exportStar(require("./interface"), exports);
 var configuration_1 = require("./configuration");
 Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.KoaConfiguration; } });
+__exportStar(require("./middleware/fav.middleware"), exports);
+__exportStar(require("./middleware/bodyparser.middleware"), exports);
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -3,6 +3,7 @@ import { IConfigurationOptions, IMidwayApplication, IMidwayContext } from '@midw
 import * as koa from 'koa';
 import { Context as KoaContext, DefaultState, Middleware, Next } from 'koa';
 import { RouterParamValue } from '@midwayjs/decorator';
+import { CookieSetOptions } from '@midwayjs/cookies';
 export declare type IMidwayKoaContext = IMidwayContext<KoaContext>;
 export declare type IMidwayKoaApplication = IMidwayApplication<IMidwayKoaContext, koa<DefaultState, IMidwayKoaContext> & {
     generateController(controllerMapping: string, routeArgsInfo?: RouterParamValue[], routerResponseData?: any[]): Middleware<DefaultState, IMidwayKoaContext>;
@@ -10,11 +11,18 @@ export declare type IMidwayKoaApplication = IMidwayApplication<IMidwayKoaContext
      * @deprecated
      * @param middlewareId
      */
-    generateMiddleware(middlewareId: string): Promise<Middleware<DefaultState, IMidwayKoaContext>>;
+    generateMiddleware(middlewareId: any): Promise<Middleware<DefaultState, IMidwayKoaContext>>;
 }>;
+/**
+ * @deprecated use NextFunction definition
+ */
 export declare type IMidwayKoaNext = Next;
 export declare type NextFunction = Next;
 export interface IMidwayKoaConfigurationOptions extends IConfigurationOptions {
+    /**
+     * cookies sign keys
+     */
+    keys?: string[];
     /**
      * application http port
      */
@@ -43,17 +51,6 @@ export interface IMidwayKoaConfigurationOptions extends IConfigurationOptions {
      * http global prefix
      */
     globalPrefix?: string;
-    /**
-     * onerror middleware options
-     */
-    onerror?: {
-        text: (err: Error, ctx: IMidwayKoaContext) => void;
-        json: (err: Error, ctx: IMidwayKoaContext) => void;
-        html: (err: Error, ctx: IMidwayKoaContext) => void;
-        redirect?: string;
-        template?: string;
-        accepts?: (...args: any[]) => any;
-    };
 }
 export declare type MiddlewareParamArray = Array<Middleware<DefaultState, IMidwayKoaContext>>;
 export interface IWebMiddleware {
@@ -62,9 +59,81 @@ export interface IWebMiddleware {
 export declare type Application = IMidwayKoaApplication;
 export interface Context extends IMidwayKoaContext {
 }
+interface BodyParserOptions {
+    enable?: boolean;
+    /**
+     *  parser will only parse when request type hits enableTypes, default is ['json', 'form'].
+     */
+    enableTypes?: string[] | undefined;
+    /**
+     * requested encoding. Default is utf-8 by co-body
+     */
+    encode?: string | undefined;
+    /**
+     * limit of the urlencoded body. If the body ends up being larger than this limit
+     * a 413 error code is returned. Default is 56kb
+     */
+    formLimit?: string | undefined;
+    /**
+     * limit of the json body. Default is 1mb
+     */
+    jsonLimit?: string | undefined;
+    /**
+     * limit of the text body. Default is 1mb.
+     */
+    textLimit?: string | undefined;
+    /**
+     * limit of the xml body. Default is 1mb.
+     */
+    xmlLimit?: string | undefined;
+    /**
+     * when set to true, JSON parser will only accept arrays and objects. Default is true
+     */
+    strict?: boolean | undefined;
+    /**
+     * custom json request detect function. Default is null
+     */
+    detectJSON?: ((ctx: IMidwayKoaContext) => boolean) | undefined;
+    /**
+     * support extend types
+     */
+    extendTypes?: {
+        json?: string[] | undefined;
+        form?: string[] | undefined;
+        text?: string[] | undefined;
+    } | undefined;
+    /**
+     * support custom error handle
+     */
+    onerror?: ((err: Error, ctx: IMidwayKoaContext) => void) | undefined;
+}
 declare module '@midwayjs/core/dist/interface' {
     interface MidwayConfig {
+        keys?: string | string[];
         koa?: IMidwayKoaConfigurationOptions;
+        cookies?: CookieSetOptions;
+        /**
+         * onerror middleware options
+         */
+        onerror?: {
+            text?: (err: Error, ctx: IMidwayKoaContext) => void;
+            json?: (err: Error, ctx: IMidwayKoaContext) => void;
+            html?: (err: Error, ctx: IMidwayKoaContext) => void;
+            redirect?: string;
+            accepts?: (...args: any[]) => any;
+        };
+        bodyParser?: BodyParserOptions;
+        siteFile?: {
+            enable?: boolean;
+            favicon?: undefined | string | Buffer;
+        };
+    }
+}
+declare module 'koa' {
+    interface Request {
+        body?: any;
+        rawBody: string;
     }
 }
+export {};
 //# sourceMappingURL=interface.d.ts.map

package/dist/middleware/bodyparser.middleware.d.ts

@@ -0,0 +1,6 @@
+export declare class BodyParserMiddleware {
+    bodyparserConfig: any;
+    resolve(): any;
+    static getName(): string;
+}
+//# sourceMappingURL=bodyparser.middleware.d.ts.map

package/dist/middleware/bodyparser.middleware.js

@@ -0,0 +1,34 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BodyParserMiddleware = void 0;
+const koaBodyParser = require("koa-bodyparser");
+const decorator_1 = require("@midwayjs/decorator");
+let BodyParserMiddleware = class BodyParserMiddleware {
+    resolve() {
+        // use bodyparser middleware
+        if (this.bodyparserConfig.enable) {
+            return koaBodyParser(this.bodyparserConfig);
+        }
+    }
+    static getName() {
+        return 'bodyParser';
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('bodyParser'),
+    __metadata("design:type", Object)
+], BodyParserMiddleware.prototype, "bodyparserConfig", void 0);
+BodyParserMiddleware = __decorate([
+    (0, decorator_1.Middleware)()
+], BodyParserMiddleware);
+exports.BodyParserMiddleware = BodyParserMiddleware;
+//# sourceMappingURL=bodyparser.middleware.js.map

package/dist/middleware/fav.middleware.d.ts

@@ -0,0 +1,6 @@
+export declare class SiteFileMiddleware {
+    siteFileConfig: any;
+    resolve(): (ctx: any, next: any) => Promise<any>;
+    static getName(): string;
+}
+//# sourceMappingURL=fav.middleware.d.ts.map

package/dist/middleware/fav.middleware.js

@@ -0,0 +1,62 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SiteFileMiddleware = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const path = require('path');
+const MAX_AGE = 'public, max-age=2592000'; // 30 days
+let SiteFileMiddleware = class SiteFileMiddleware {
+    resolve() {
+        // use bodyparser middleware
+        if (this.siteFileConfig.enable) {
+            return async (ctx, next) => {
+                if (ctx.method !== 'HEAD' && ctx.method !== 'GET')
+                    return next();
+                /* istanbul ignore if */
+                if (ctx.path[0] !== '/')
+                    return next();
+                if (ctx.path !== '/favicon.ico') {
+                    return next();
+                }
+                let content = this.siteFileConfig['favicon'];
+                if (content === undefined) {
+                    content = Buffer.from('');
+                }
+                if (!content)
+                    return next();
+                // content is url
+                if (typeof content === 'string')
+                    return ctx.redirect(content);
+                // '/robots.txt': Buffer <xx..
+                // content is buffer
+                if (Buffer.isBuffer(content)) {
+                    ctx.set('cache-control', MAX_AGE);
+                    ctx.body = content;
+                    ctx.type = path.extname(ctx.path);
+                    return;
+                }
+                return next();
+            };
+        }
+    }
+    static getName() {
+        return 'siteFile';
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('siteFile'),
+    __metadata("design:type", Object)
+], SiteFileMiddleware.prototype, "siteFileConfig", void 0);
+SiteFileMiddleware = __decorate([
+    (0, decorator_1.Middleware)()
+], SiteFileMiddleware);
+exports.SiteFileMiddleware = SiteFileMiddleware;
+//# sourceMappingURL=fav.middleware.js.map

package/dist/onerror.d.ts

@@ -0,0 +1,2 @@
+export declare function setupOnerror(app: any, config: any, logger: any): void;
+//# sourceMappingURL=onerror.d.ts.map