@midwayjs/koa 3.0.0-beta.1 → 3.0.0-beta.5

package/CHANGELOG.md

@@ -3,6 +3,46 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-beta.5](https://github.com/midwayjs/midway/compare/v3.0.0-beta.4...v3.0.0-beta.5) (2021-11-25)
+
+**Note:** Version bump only for package @midwayjs/koa
+
+
+
+
+
+# [3.0.0-beta.4](https://github.com/midwayjs/midway/compare/v3.0.0-beta.3...v3.0.0-beta.4) (2021-11-24)
+
+
+### Features
+
+* add i18n ([#1375](https://github.com/midwayjs/midway/issues/1375)) ([bffefe0](https://github.com/midwayjs/midway/commit/bffefe07afe45777d49b5a76b9ab17fc2b9d9a55))
+* auto transform args to type ([#1372](https://github.com/midwayjs/midway/issues/1372)) ([bb3f7d2](https://github.com/midwayjs/midway/commit/bb3f7d2028a034e1926d9df554849332354c3762))
+* support global prefix url ([#1371](https://github.com/midwayjs/midway/issues/1371)) ([cc5fe44](https://github.com/midwayjs/midway/commit/cc5fe44e1d221590562dc71e1f33ae96093e0da7))
+
+
+
+
+
+# [3.0.0-beta.3](https://github.com/midwayjs/midway/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2021-11-18)
+
+
+### Features
+
+* add component and framework config definition ([#1367](https://github.com/midwayjs/midway/issues/1367)) ([b2fe615](https://github.com/midwayjs/midway/commit/b2fe6157f99659471ff1333eca0b86bb889f61a3))
+
+
+
+
+
+# [3.0.0-beta.2](https://github.com/midwayjs/midway/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-11-16)
+
+**Note:** Version bump only for package @midwayjs/koa
+
+
+
+
+
 # [3.0.0-beta.1](https://github.com/midwayjs/midway/compare/v2.12.4...v3.0.0-beta.1) (2021-11-14)
 
 

package/dist/configuration.d.ts

@@ -1,10 +1,7 @@
-import { MidwayKoaFramework } from './framework';
 import { MidwayDecoratorService } from '@midwayjs/core';
 export declare class KoaConfiguration {
-    framework: MidwayKoaFramework;
     decoratorService: MidwayDecoratorService;
     init(): void;
     onReady(): Promise<void>;
-    onServerReady(): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -11,23 +11,15 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KoaConfiguration = void 0;
 const decorator_1 = require("@midwayjs/decorator");
-const framework_1 = require("./framework");
 const core_1 = require("@midwayjs/core");
 let KoaConfiguration = class KoaConfiguration {
     init() {
         this.decoratorService.registerParameterHandler(decorator_1.WEB_ROUTER_PARAM_KEY, options => {
-            return (0, core_1.extractKoaLikeValue)(options.metadata.type, options.metadata.propertyData)(options.originArgs[0], options.originArgs[1]);
+            return (0, core_1.extractKoaLikeValue)(options.metadata.type, options.metadata.propertyData, options.originParamType)(options.originArgs[0], options.originArgs[1]);
         });
     }
     async onReady() { }
-    async onServerReady() {
-        await this.framework.run();
-    }
 };
-__decorate([
-    (0, decorator_1.Inject)(),
-    __metadata("design:type", framework_1.MidwayKoaFramework)
-], KoaConfiguration.prototype, "framework", void 0);
 __decorate([
     (0, decorator_1.Inject)(),
     __metadata("design:type", core_1.MidwayDecoratorService)

package/dist/framework.d.ts

@@ -1,10 +1,9 @@
 /// <reference types="node" />
-import { BaseFramework, IMidwayBootstrapOptions, MidwayFrameworkType } from '@midwayjs/core';
-import { RouterParamValue } from '@midwayjs/decorator';
+import { BaseFramework, CommonFilterUnion, CommonMiddlewareUnion, IMidwayBootstrapOptions, MidwayFrameworkType, RouterInfo } from '@midwayjs/core';
 import { IMidwayKoaApplication, IMidwayKoaConfigurationOptions, IMidwayKoaContext } from './interface';
-import type { DefaultState, Middleware } from 'koa';
+import type { DefaultState, Middleware, Next } from 'koa';
 import { Server } from 'net';
-export declare class MidwayKoaFramework extends BaseFramework<IMidwayKoaApplication, IMidwayKoaContext, IMidwayKoaConfigurationOptions> {
+export declare class MidwayKoaFramework extends BaseFramework<IMidwayKoaApplication, IMidwayKoaContext, IMidwayKoaConfigurationOptions, Next> {
     private server;
     private generator;
     configure(): IMidwayKoaConfigurationOptions;
@@ -12,11 +11,8 @@ export declare class MidwayKoaFramework extends BaseFramework<IMidwayKoaApplicat
     loadMidwayController(): Promise<void>;
     /**
      * wrap controller string to middleware function
-     * @param controllerMapping like FooController.index
-     * @param routeArgsInfo
-     * @param routerResponseData
      */
-    generateController(controllerMapping: string, routeArgsInfo?: RouterParamValue[], routerResponseData?: any[]): Middleware<DefaultState, IMidwayKoaContext>;
+    generateController(routeInfo: RouterInfo): Middleware<DefaultState, IMidwayKoaContext>;
     /**
      * @deprecated
      * @param middlewareId
@@ -27,5 +23,7 @@ export declare class MidwayKoaFramework extends BaseFramework<IMidwayKoaApplicat
     getFrameworkType(): MidwayFrameworkType;
     getFrameworkName(): string;
     getServer(): Server;
+    useMiddleware(Middleware: CommonMiddlewareUnion<IMidwayKoaContext, Next, unknown>): void;
+    useFilter(Filter: CommonFilterUnion<IMidwayKoaContext, Next, unknown>): void;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -11,6 +11,7 @@ const core_1 = require("@midwayjs/core");
 const decorator_1 = require("@midwayjs/decorator");
 const Router = require("@koa/router");
 const koa = require("koa");
+const onerror = require("koa-onerror");
 class KoaControllerGenerator extends core_1.WebControllerGenerator {
     constructor(app, applicationContext, logger) {
         super(applicationContext, core_1.MidwayFrameworkType.WEB_KOA, logger);
@@ -23,8 +24,8 @@ class KoaControllerGenerator extends core_1.WebControllerGenerator {
         router.prefix(routerOptions.prefix);
         return router;
     }
-    generateController(controllerMapping, routeArgsInfo, routerResponseData) {
-        return this.generateKoaController(controllerMapping, routeArgsInfo, routerResponseData);
+    generateController(routeInfo) {
+        return this.generateKoaController(routeInfo);
     }
 }
 let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
@@ -33,6 +34,7 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
     }
     async applicationInitialize(options) {
         this.app = new koa();
+        onerror(this.app, this.configurationOptions.onerror);
         this.app.use(async (ctx, next) => {
             this.app.createAnonymousContext(ctx);
             const { result, error } = await (await this.getMiddleware())(ctx, next);
@@ -44,57 +46,21 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
             }
         });
         this.generator = new KoaControllerGenerator(this.app, this.applicationContext, this.appLogger);
-        this.defineApplicationProperties({
-            generateController: (controllerMapping) => {
-                return this.generateController(controllerMapping);
-            },
-            /**
-             * @deprecated
-             * @param middlewareId
-             */
-            generateMiddleware: async (middlewareId) => {
-                return this.generateMiddleware(middlewareId);
-            },
-        });
+        this.defineApplicationProperties();
         // hack use method
         this.app.originUse = this.app.use;
         this.app.use = this.app.useMiddleware;
-        // https config
-        if (this.configurationOptions.key && this.configurationOptions.cert) {
-            this.configurationOptions.key = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.key);
-            this.configurationOptions.cert = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.cert);
-            this.configurationOptions.ca = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.ca);
-            if (this.configurationOptions.http2) {
-                this.server = require('http2').createSecureServer(this.configurationOptions, this.app.callback());
-            }
-            else {
-                this.server = require('https').createServer(this.configurationOptions, this.app.callback());
-            }
-        }
-        else {
-            if (this.configurationOptions.http2) {
-                this.server = require('http2').createServer(this.app.callback());
-            }
-            else {
-                this.server = require('http').createServer(this.app.callback());
-            }
-        }
-        // register httpServer to applicationContext
-        this.applicationContext.registerObject(core_1.HTTP_SERVER_KEY, this.server);
     }
     async loadMidwayController() {
-        await this.generator.loadMidwayController(newRouter => {
+        await this.generator.loadMidwayController(this.configurationOptions.globalPrefix, newRouter => {
             this.app.use(newRouter.middleware());
         });
     }
     /**
      * wrap controller string to middleware function
-     * @param controllerMapping like FooController.index
-     * @param routeArgsInfo
-     * @param routerResponseData
      */
-    generateController(controllerMapping, routeArgsInfo, routerResponseData) {
-        return this.generator.generateKoaController(controllerMapping, routeArgsInfo, routerResponseData);
+    generateController(routeInfo) {
+        return this.generator.generateKoaController(routeInfo);
     }
     /**
      * @deprecated
@@ -109,6 +75,28 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
         await this.loadMidwayController();
         // restore use method
         this.app.use = this.app.originUse;
+        // https config
+        if (this.configurationOptions.key && this.configurationOptions.cert) {
+            this.configurationOptions.key = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.key);
+            this.configurationOptions.cert = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.cert);
+            this.configurationOptions.ca = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.ca);
+            if (this.configurationOptions.http2) {
+                this.server = require('http2').createSecureServer(this.configurationOptions, this.app.callback());
+            }
+            else {
+                this.server = require('https').createServer(this.configurationOptions, this.app.callback());
+            }
+        }
+        else {
+            if (this.configurationOptions.http2) {
+                this.server = require('http2').createServer(this.app.callback());
+            }
+            else {
+                this.server = require('http').createServer(this.app.callback());
+            }
+        }
+        // register httpServer to applicationContext
+        this.applicationContext.registerObject(core_1.HTTP_SERVER_KEY, this.server);
         // set port and listen server
         if (this.configurationOptions.port) {
             new Promise(resolve => {
@@ -135,6 +123,12 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
     getServer() {
         return this.server;
     }
+    useMiddleware(Middleware) {
+        this.middlewareManager.insertLast(Middleware);
+    }
+    useFilter(Filter) {
+        this.filterManager.useFilter(Filter);
+    }
 };
 MidwayKoaFramework = __decorate([
     (0, decorator_1.Framework)()

package/dist/interface.d.ts

@@ -13,9 +13,7 @@ export declare type IMidwayKoaApplication = IMidwayApplication<IMidwayKoaContext
     generateMiddleware(middlewareId: string): Promise<Middleware<DefaultState, IMidwayKoaContext>>;
 }>;
 export declare type IMidwayKoaNext = Next;
-export interface IMidwayKoaApplicationPlus<CTX extends IMidwayContext> extends IMidwayApplication<CTX> {
-    use(...args: any[]): any;
-}
+export declare type NextFunction = Next;
 export interface IMidwayKoaConfigurationOptions extends IConfigurationOptions {
     /**
      * application http port
@@ -41,6 +39,21 @@ export interface IMidwayKoaConfigurationOptions extends IConfigurationOptions {
      * http2 support
      */
     http2?: boolean;
+    /**
+     * 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 {
@@ -49,4 +62,9 @@ export interface IWebMiddleware {
 export declare type Application = IMidwayKoaApplication;
 export interface Context extends IMidwayKoaContext {
 }
+declare module '@midwayjs/core/dist/interface' {
+    interface MidwayConfig {
+        koa?: IMidwayKoaConfigurationOptions;
+    }
+}
 //# sourceMappingURL=interface.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/koa",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.5",
   "description": "Midway Web Framework for KOA",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
@@ -23,9 +23,9 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.0.0-beta.1",
-    "@midwayjs/mock": "^3.0.0-beta.1",
-    "@midwayjs/validate": "^3.0.0-beta.1",
+    "@midwayjs/decorator": "^3.0.0-beta.5",
+    "@midwayjs/mock": "^3.0.0-beta.5",
+    "@midwayjs/validate": "^3.0.0-beta.5",
     "@types/koa": "^2.11.4",
     "@types/koa-router": "^7.4.1",
     "fs-extra": "^8.0.1",
@@ -34,9 +34,10 @@
   },
   "dependencies": {
     "@koa/router": "^10.0.0",
-    "@midwayjs/core": "^3.0.0-beta.1",
-    "@midwayjs/logger": "^3.0.0-beta.1",
-    "koa": "^2.13.0"
+    "@midwayjs/core": "^3.0.0-beta.5",
+    "@midwayjs/logger": "^3.0.0-beta.5",
+    "koa": "^2.13.0",
+    "koa-onerror": "^4.1.0"
   },
   "author": "Harry Chen <czy88840616@gmail.com>",
   "repository": {
@@ -46,5 +47,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "72e4d20c678e65a5440c4e9a6d3b70046daa497c"
+  "gitHead": "ab0bf05ae6d13f6435db2f7223202be61d585a1b"
 }