egg 3.26.1 → 4.0.0-beta.0

package/README.md

@@ -9,7 +9,7 @@ English | [简体中文](./README.zh-CN.md)
 [![NPM download](https://img.shields.io/npm/dm/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Feggjs%2Fegg.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Feggjs%2Fegg?ref=badge_shield)
 
-[![Continuous Integration](https://github.com/eggjs/egg/actions/workflows/nodejs-3.x.yml/badge.svg)](https://github.com/eggjs/egg/actions?query=branch%3A3.x)
+[![Continuous Integration](https://github.com/eggjs/egg/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg/actions?query=branch%3Amaster)
 [![Test coverage](https://img.shields.io/codecov/c/github/eggjs/egg.svg?style=flat-square)](https://codecov.io/gh/eggjs/egg)
 [![Known Vulnerabilities](https://snyk.io/test/npm/egg/badge.svg?style=flat-square)](https://snyk.io/test/npm/egg)
 [![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/eggjs?style=flat-square)](https://opencollective.com/eggjs)

package/README.zh-CN.md

@@ -25,11 +25,12 @@
 ## 快速开始
 
 ```bash
-$ mkdir showcase && cd showcase
-$ npm init egg --type=simple
-$ npm install
-$ npm run dev
-$ open http://localhost:7001
+mkdir showcase && cd showcase
+npm init egg --type=simple
+npm install
+npm run dev
+
+open http://localhost:7001
 ```
 
 ## 文档

package/dist/commonjs/agent.d.ts

@@ -0,0 +1,4 @@
+import { BaseHookClass } from './lib/core/base_hook_class.js';
+export default class EggAgentHook extends BaseHookClass {
+    configDidLoad(): void;
+}

package/dist/commonjs/agent.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_hook_class_js_1 = require("./lib/core/base_hook_class.js");
+class EggAgentHook extends base_hook_class_js_1.BaseHookClass {
+    configDidLoad() {
+        this.agent._wrapMessenger();
+    }
+}
+exports.default = EggAgentHook;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxzRUFBOEQ7QUFFOUQsTUFBcUIsWUFBYSxTQUFRLGtDQUFhO0lBQ3JELGFBQWE7UUFDWCxJQUFJLENBQUMsS0FBSyxDQUFDLGNBQWMsRUFBRSxDQUFDO0lBQzlCLENBQUM7Q0FDRjtBQUpELCtCQUlDIn0=

package/dist/commonjs/app/middleware/body_parser.d.ts

@@ -0,0 +1,2 @@
+import bodyparser from 'koa-bodyparser';
+export default bodyparser;

package/dist/commonjs/app/middleware/body_parser.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const koa_bodyparser_1 = __importDefault(require("koa-bodyparser"));
+exports.default = koa_bodyparser_1.default;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYm9keV9wYXJzZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL21pZGRsZXdhcmUvYm9keV9wYXJzZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxvRUFBd0M7QUFFeEMsa0JBQWUsd0JBQVUsQ0FBQyJ9

package/dist/commonjs/app/middleware/meta.d.ts

@@ -0,0 +1,11 @@
+/**
+ * meta middleware, should be the first middleware
+ */
+import type { EggCoreContext } from '@eggjs/core';
+import type { Next } from '../../lib/type.js';
+export interface MetaMiddlewareOptions {
+    enable: boolean;
+    logging: boolean;
+}
+declare const _default: (options: MetaMiddlewareOptions) => (ctx: EggCoreContext, next: Next) => Promise<void>;
+export default _default;

package/dist/commonjs/app/middleware/meta.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * meta middleware, should be the first middleware
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_perf_hooks_1 = require("node:perf_hooks");
+exports.default = (options) => {
+    return async function meta(ctx, next) {
+        if (options.logging) {
+            ctx.coreLogger.info('[meta] request started, host: %s, user-agent: %s', ctx.host, ctx.header['user-agent']);
+        }
+        await next();
+        // total response time header
+        if (ctx.performanceStarttime) {
+            ctx.set('x-readtime', Math.floor((node_perf_hooks_1.performance.now() - ctx.performanceStarttime) * 1000) / 1000);
+        }
+        else {
+            ctx.set('x-readtime', Date.now() - ctx.starttime);
+        }
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWV0YS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvbWlkZGxld2FyZS9tZXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTs7R0FFRzs7QUFFSCxxREFBOEM7QUFTOUMsa0JBQWUsQ0FBQyxPQUE4QixFQUFFLEVBQUU7SUFDaEQsT0FBTyxLQUFLLFVBQVUsSUFBSSxDQUFDLEdBQW1CLEVBQUUsSUFBVTtRQUN4RCxJQUFJLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUNwQixHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxrREFBa0QsRUFDcEUsR0FBRyxDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDLENBQUM7UUFDeEMsQ0FBQztRQUNELE1BQU0sSUFBSSxFQUFFLENBQUM7UUFDYiw2QkFBNkI7UUFDN0IsSUFBSSxHQUFHLENBQUMsb0JBQW9CLEVBQUUsQ0FBQztZQUM3QixHQUFHLENBQUMsR0FBRyxDQUFDLFlBQVksRUFBRSxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUMsNkJBQVcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxHQUFHLENBQUMsb0JBQW9CLENBQUMsR0FBRyxJQUFJLENBQUMsR0FBRyxJQUFJLENBQUMsQ0FBQztRQUNsRyxDQUFDO2FBQU0sQ0FBQztZQUNOLEdBQUcsQ0FBQyxHQUFHLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxHQUFHLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDcEQsQ0FBQztJQUNILENBQUMsQ0FBQztBQUNKLENBQUMsQ0FBQyJ9

package/dist/commonjs/app/middleware/notfound.d.ts

@@ -0,0 +1,8 @@
+import type { EggCoreContext } from '@eggjs/core';
+import type { Next } from '../../lib/type.js';
+export interface NotFoundMiddlewareOptions {
+    enable: boolean;
+    pageUrl: string;
+}
+declare const _default: (options: NotFoundMiddlewareOptions) => (ctx: EggCoreContext, next: Next) => Promise<void>;
+export default _default;

package/dist/commonjs/app/middleware/notfound.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (options) => {
+    return async function notfound(ctx, next) {
+        await next();
+        if (ctx.status !== 404 || ctx.body) {
+            return;
+        }
+        // set status first, make sure set body not set status
+        ctx.status = 404;
+        if (ctx.acceptJSON) {
+            ctx.body = {
+                message: 'Not Found',
+            };
+            return;
+        }
+        const notFoundHtml = '<h1>404 Not Found</h1>';
+        // notfound handler is unimplemented
+        if (options.pageUrl && ctx.path === options.pageUrl) {
+            ctx.body = `${notFoundHtml}<p><pre><code>config.notfound.pageUrl(${options.pageUrl})</code></pre> is unimplemented</p>`;
+            return;
+        }
+        if (options.pageUrl) {
+            ctx.realStatus = 404;
+            ctx.redirect(options.pageUrl);
+            return;
+        }
+        ctx.body = notFoundHtml;
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm90Zm91bmQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL21pZGRsZXdhcmUvbm90Zm91bmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFRQSxrQkFBZSxDQUFDLE9BQWtDLEVBQUUsRUFBRTtJQUNwRCxPQUFPLEtBQUssVUFBVSxRQUFRLENBQUMsR0FBbUIsRUFBRSxJQUFVO1FBQzVELE1BQU0sSUFBSSxFQUFFLENBQUM7UUFFYixJQUFJLEdBQUcsQ0FBQyxNQUFNLEtBQUssR0FBRyxJQUFJLEdBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUNuQyxPQUFPO1FBQ1QsQ0FBQztRQUVELHNEQUFzRDtRQUN0RCxHQUFHLENBQUMsTUFBTSxHQUFHLEdBQUcsQ0FBQztRQUVqQixJQUFJLEdBQUcsQ0FBQyxVQUFVLEVBQUUsQ0FBQztZQUNuQixHQUFHLENBQUMsSUFBSSxHQUFHO2dCQUNULE9BQU8sRUFBRSxXQUFXO2FBQ3JCLENBQUM7WUFDRixPQUFPO1FBQ1QsQ0FBQztRQUVELE1BQU0sWUFBWSxHQUFHLHdCQUF3QixDQUFDO1FBRTlDLG9DQUFvQztRQUNwQyxJQUFJLE9BQU8sQ0FBQyxPQUFPLElBQUksR0FBRyxDQUFDLElBQUksS0FBSyxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDcEQsR0FBRyxDQUFDLElBQUksR0FBRyxHQUFHLFlBQVkseUNBQXlDLE9BQU8sQ0FBQyxPQUFPLHFDQUFxQyxDQUFDO1lBQ3hILE9BQU87UUFDVCxDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDcEIsR0FBRyxDQUFDLFVBQVUsR0FBRyxHQUFHLENBQUM7WUFDckIsR0FBRyxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7WUFDOUIsT0FBTztRQUNULENBQUM7UUFDRCxHQUFHLENBQUMsSUFBSSxHQUFHLFlBQVksQ0FBQztJQUMxQixDQUFDLENBQUM7QUFDSixDQUFDLENBQUMifQ==

package/dist/commonjs/app/middleware/override_method.d.ts

@@ -0,0 +1,2 @@
+import override from 'koa-override';
+export default override;

package/dist/commonjs/app/middleware/override_method.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const koa_override_1 = __importDefault(require("koa-override"));
+exports.default = koa_override_1.default;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3ZlcnJpZGVfbWV0aG9kLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9taWRkbGV3YXJlL292ZXJyaWRlX21ldGhvZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLGdFQUFvQztBQUVwQyxrQkFBZSxzQkFBUSxDQUFDIn0=

package/dist/commonjs/app/middleware/site_file.d.ts

@@ -0,0 +1,7 @@
+import type { EggCoreContext } from '@eggjs/core';
+export type SiteFileContentFun = (ctx: EggCoreContext) => Promise<Buffer | string>;
+export interface SiteFileMiddlewareOptions {
+    enable: boolean;
+    cacheControl: string;
+    [key: string]: string | Buffer | boolean | SiteFileContentFun;
+}

package/dist/commonjs/app/middleware/site_file.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
+module.exports = (options) => {
+    return async function siteFile(ctx, next) {
+        if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
+            return next();
+        }
+        /* istanbul ignore if */
+        if (ctx.path[0] !== '/') {
+            return next();
+        }
+        let content = options[ctx.path];
+        if (!content) {
+            return next();
+        }
+        // '/favicon.ico': 'https://eggjs.org/favicon.ico' or '/favicon.ico': async (ctx) => 'https://eggjs.org/favicon.ico'
+        // content is function
+        if (typeof content === 'function') {
+            content = await content(ctx);
+        }
+        // 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', options.cacheControl);
+            ctx.body = content;
+            ctx.type = node_path_1.default.extname(ctx.path);
+            return;
+        }
+        return next();
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2l0ZV9maWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9taWRkbGV3YXJlL3NpdGVfZmlsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDBEQUE2QjtBQVk3QixNQUFNLENBQUMsT0FBTyxHQUFHLENBQUMsT0FBa0MsRUFBRSxFQUFFO0lBQ3RELE9BQU8sS0FBSyxVQUFVLFFBQVEsQ0FBQyxHQUFtQixFQUFFLElBQVU7UUFDNUQsSUFBSSxHQUFHLENBQUMsTUFBTSxLQUFLLE1BQU0sSUFBSSxHQUFHLENBQUMsTUFBTSxLQUFLLEtBQUssRUFBRSxDQUFDO1lBQ2xELE9BQU8sSUFBSSxFQUFFLENBQUM7UUFDaEIsQ0FBQztRQUNELHdCQUF3QjtRQUN4QixJQUFJLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEtBQUssR0FBRyxFQUFFLENBQUM7WUFDeEIsT0FBTyxJQUFJLEVBQUUsQ0FBQztRQUNoQixDQUFDO1FBRUQsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNoQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDYixPQUFPLElBQUksRUFBRSxDQUFDO1FBQ2hCLENBQUM7UUFFRCxvSEFBb0g7UUFDcEgsc0JBQXNCO1FBQ3RCLElBQUksT0FBTyxPQUFPLEtBQUssVUFBVSxFQUFFLENBQUM7WUFDbEMsT0FBTyxHQUFHLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQy9CLENBQUM7UUFDRCxpQkFBaUI7UUFDakIsSUFBSSxPQUFPLE9BQU8sS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUNoQyxPQUFPLEdBQUcsQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDL0IsQ0FBQztRQUVELDhCQUE4QjtRQUM5QixvQkFBb0I7UUFDcEIsSUFBSSxNQUFNLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7WUFDN0IsR0FBRyxDQUFDLEdBQUcsQ0FBQyxlQUFlLEVBQUUsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFDO1lBQy9DLEdBQUcsQ0FBQyxJQUFJLEdBQUcsT0FBTyxDQUFDO1lBQ25CLEdBQUcsQ0FBQyxJQUFJLEdBQUcsbUJBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2xDLE9BQU87UUFDVCxDQUFDO1FBRUQsT0FBTyxJQUFJLEVBQUUsQ0FBQztJQUNoQixDQUFDLENBQUM7QUFDSixDQUFDLENBQUMifQ==

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

@@ -0,0 +1,9 @@
+import type { EggAppInfo } from '@eggjs/core';
+import type { EggAppConfig } from '../lib/type.js';
+/**
+ * The configuration of egg application, can be access by `app.config`
+ * @class Config
+ * @since 1.0.0
+ */
+declare const _default: (appInfo: EggAppInfo) => Partial<EggAppConfig>;
+export default _default;

package/dist/commonjs/config/config.default.js

@@ -0,0 +1,378 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+/**
+ * The configuration of egg application, can be access by `app.config`
+ * @class Config
+ * @since 1.0.0
+ */
+exports.default = (appInfo) => {
+    const config = {
+        /**
+         * The environment of egg
+         * @member {String} Config#env
+         * @see {appInfo#env}
+         * @since 1.0.0
+         */
+        env: appInfo.env,
+        /**
+         * The name of the application
+         * @member {String} Config#name
+         * @see {appInfo#name}
+         * @since 1.0.0
+         */
+        name: appInfo.name,
+        /**
+         * The key that signing cookies. It can contain multiple keys seperated by `,`.
+         * @member {String} Config#keys
+         * @see http://eggjs.org/en/core/cookie-and-session.html#cookie-secret-key
+         * @default
+         * @since 1.0.0
+         */
+        keys: '',
+        /**
+         * default cookie options
+         *
+         * @member Config#cookies
+         * @property {String} sameSite - SameSite property, defaults is ''
+         * @property {Boolean} httpOnly - httpOnly property, defaults is true
+         */
+        cookies: {
+        // httpOnly: true | false,
+        // sameSite: 'none|lax|strict',
+        },
+        /**
+         * Whether application deployed after a reverse proxy,
+         * when true proxy header fields will be trusted
+         * @member {Boolean} Config#proxy
+         * @default
+         * @since 1.0.0
+         */
+        proxy: false,
+        /**
+         *
+         * max ips read from proxy ip header, default to 0 (means infinity)
+         * to prevent users from forging client ip addresses via x-forwarded-for
+         * @see https://github.com/koajs/koa/blob/master/docs/api/request.md#requestips
+         * @member {Integer} Config#maxIpsCount
+         * @default
+         * @since 2.25.0
+         */
+        maxIpsCount: 0,
+        /**
+         * please use maxIpsCount instead
+         * @member {Integer} Config#maxProxyCount
+         * @default
+         * @since 2.21.0
+         * @deprecated
+         */
+        maxProxyCount: 0,
+        /**
+         * Detect request's protocol from specified headers, not case-sensitive.
+         * Only worked when config.proxy set to true.
+         * @member {String} Config#protocolHeaders
+         * @default
+         * @since 1.0.0
+         */
+        protocolHeaders: 'x-forwarded-proto',
+        /**
+         * Detect request' ip from specified headers, not case-sensitive.
+         * Only worked when config.proxy set to true.
+         * @member {String} Config#ipHeaders
+         * @default
+         * @since 1.0.0
+         */
+        ipHeaders: 'x-forwarded-for',
+        /**
+         * Detect request' host from specified headers, not case-sensitive.
+         * Only worked when config.proxy set to true.
+         * @member {String} Config#hostHeaders
+         * @default
+         * @since 1.0.0
+         */
+        hostHeaders: '',
+        /**
+         * package.json
+         * @member {Object} Config#pkg
+         * @see {appInfo#pkg}
+         * @since 1.0.0
+         */
+        pkg: appInfo.pkg,
+        /**
+         * The current directory of the application
+         * @member {String} Config#baseDir
+         * @see {appInfo#baseDir}
+         * @since 1.0.0
+         */
+        baseDir: appInfo.baseDir,
+        /**
+         * The current HOME directory
+         * @member {String} Config#HOME
+         * @see {appInfo#HOME}
+         * @since 1.0.0
+         */
+        HOME: appInfo.HOME,
+        /**
+         * The directory of server running. You can find `application_config.json` under it that is dumped from `app.config`.
+         * @member {String} Config#rundir
+         * @default
+         * @since 1.0.0
+         */
+        rundir: node_path_1.default.join(appInfo.baseDir, 'run'),
+        /**
+         * dump config
+         *
+         * It will ignore special keys when dumpConfig
+         *
+         * @member Config#dump
+         * @property {Set} ignore - keys to ignore
+         */
+        dump: {
+            ignore: new Set([
+                'pass', 'pwd', 'passd', 'passwd', 'password', 'keys', 'masterKey', 'accessKey',
+                // ignore any key contains "secret" keyword
+                /secret/i,
+            ]),
+            timing: {
+                // if boot action >= slowBootActionMinDuration, egg core will print it to warning log
+                slowBootActionMinDuration: 5000,
+            },
+        },
+        /**
+         * configurations are confused to users
+         * {
+         *   [unexpectedKey]: [expectedKey],
+         * }
+         * @member Config#confusedConfigurations
+         * @type {Object}
+         */
+        confusedConfigurations: {
+            bodyparser: 'bodyParser',
+            notFound: 'notfound',
+            sitefile: 'siteFile',
+            middlewares: 'middleware',
+            httpClient: 'httpclient',
+        },
+    };
+    /**
+     * The options of `notfound` middleware
+     *
+     * It will return page or json depend on negotiation when 404,
+     * If pageUrl is set, it will redirect to the page.
+     *
+     * @member Config#notfound
+     * @property {String} pageUrl - the 404 page url
+     */
+    config.notfound = {
+        enable: true,
+        pageUrl: '',
+    };
+    /**
+     * The option of `siteFile` middleware
+     *
+     * You can map some files using this options, it will response immdiately when matching.
+     *
+     * @member {Object} Config#siteFile - key is path, and value is url or buffer.
+     * @property {String} cacheControl - files cache , default is public, max-age=2592000
+     * @example
+     * // specific app's favicon, => '/favicon.ico': 'https://eggjs.org/favicon.ico',
+     * config.siteFile = {
+     *   '/favicon.ico': 'https://eggjs.org/favicon.ico',
+     * };
+     */
+    config.siteFile = {
+        enable: true,
+        '/favicon.ico': node_fs_1.default.readFileSync(node_path_1.default.join(__dirname, 'favicon.png')),
+        // default cache in 30 days
+        cacheControl: 'public, max-age=2592000',
+    };
+    /**
+     * The options of `bodyParser` middleware
+     *
+     * @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
+     */
+    config.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,
+        },
+        onProtoPoisoning: 'error',
+        onerror(err, ctx) {
+            err.message = `${err.message}, check bodyParser config`;
+            if (ctx.status === 404) {
+                // set default status to 400, meaning client bad request
+                ctx.status = 400;
+                if (!err.status) {
+                    err.status = 400;
+                }
+            }
+            throw err;
+        },
+    };
+    /**
+     * logger options
+     * @member Config#logger
+     * @property {String} dir - directory of log files
+     * @property {String} encoding - log file encoding, defaults to utf8
+     * @property {String} level - default log level, could be: DEBUG, INFO, WARN, ERROR or NONE, defaults to INFO in production
+     * @property {String} consoleLevel - log level of stdout, defaults to INFO in local serverEnv, defaults to WARN in unittest, defaults to NONE elsewise
+     * @property {Boolean} disableConsoleAfterReady - disable logger console after app ready. defaults to `false` on local and unittest env, others is `true`.
+     * @property {Boolean} outputJSON - log as JSON or not, defaults to false
+     * @property {Boolean} buffer - if enabled, flush logs to disk at a certain frequency to improve performance, defaults to true
+     * @property {String} errorLogName - file name of errorLogger
+     * @property {String} coreLogName - file name of coreLogger
+     * @property {String} agentLogName - file name of agent worker log
+     * @property {Object} coreLogger - custom config of coreLogger
+     * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to false
+     * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to true
+     */
+    config.logger = {
+        dir: node_path_1.default.join(appInfo.root, 'logs', appInfo.name),
+        encoding: 'utf8',
+        env: appInfo.env,
+        level: 'INFO',
+        consoleLevel: 'INFO',
+        disableConsoleAfterReady: appInfo.env !== 'local' && appInfo.env !== 'unittest',
+        outputJSON: false,
+        buffer: true,
+        appLogName: `${appInfo.name}-web.log`,
+        coreLogName: 'egg-web.log',
+        agentLogName: 'egg-agent.log',
+        errorLogName: 'common-error.log',
+        coreLogger: {},
+        allowDebugAtProd: false,
+        enableFastContextLogger: true,
+    };
+    /**
+     * The option for httpclient
+     * @member Config#httpclient
+     * @property {Boolean} enableDNSCache - Enable DNS lookup from local cache or not, default is false.
+     * @property {Boolean} dnsCacheLookupInterval - minimum interval of DNS query on the same hostname (default 10s).
+     *
+     * @property {Number} request.timeout - httpclient request default timeout, default is 5000 ms.
+     *
+     * @property {Boolean} httpAgent.keepAlive - Enable http agent keepalive or not, default is true
+     * @property {Number} httpAgent.freeSocketTimeout - http agent socket keepalive max free time, default is 4000 ms.
+     * @property {Number} httpAgent.maxSockets - http agent max socket number of one host, default is `Number.MAX_SAFE_INTEGER` @ses https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
+     * @property {Number} httpAgent.maxFreeSockets - http agent max free socket number of one host, default is 256.
+     *
+     * @property {Boolean} httpsAgent.keepAlive - Enable https agent keepalive or not, default is true
+     * @property {Number} httpsAgent.freeSocketTimeout - httpss agent socket keepalive max free time, default is 4000 ms.
+     * @property {Number} httpsAgent.maxSockets - https agent max socket number of one host, default is `Number.MAX_SAFE_INTEGER` @ses https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
+     * @property {Number} httpsAgent.maxFreeSockets - https agent max free socket number of one host, default is 256.
+     * @property {Boolean} useHttpClientNext - use urllib@3 HttpClient
+     */
+    config.httpclient = {
+        request: {
+            timeout: 5000,
+        },
+    };
+    /**
+     * The options of `meta` middleware
+     *
+     * @member Config#meta
+     * @property {Boolean} enable - enable meta or not, default is `true`
+     * @property {Boolean} logging - enable logging start request, default is `false`
+     */
+    config.meta = {
+        enable: true,
+        logging: false,
+    };
+    /**
+     * core enable middlewares
+     * @member {Array} Config#middleware
+     */
+    config.coreMiddleware = [
+        'meta',
+        'siteFile',
+        'notfound',
+        'bodyParser',
+        'overrideMethod',
+    ];
+    /**
+     * emit `startTimeout` if worker don't ready after `workerStartTimeout` ms
+     * @member {Number} Config.workerStartTimeout
+     */
+    config.workerStartTimeout = 10 * 60 * 1000;
+    /**
+     * server timeout in milliseconds, default to 0 (no timeout).
+     *
+     * for special request, just use `ctx.req.setTimeout(ms)`
+     *
+     * @member {Number} Config#serverTimeout
+     * @see https://nodejs.org/api/http.html#http_server_timeout
+     */
+    config.serverTimeout = null;
+    /**
+     * The options of cluster
+     * @member {Object} Config#cluster
+     * @property {Object} listen - listen options, see {@link https://nodejs.org/api/http.html#http_server_listen_port_hostname_backlog_callback}
+     * @property {String} listen.path - set a unix sock path when server listen
+     * @property {Number} listen.port - set a port when server listen
+     * @property {String} listen.hostname - set a hostname binding server when server listen
+     */
+    config.cluster = {
+        listen: {
+            path: '',
+            port: 7001,
+            hostname: '',
+        },
+    };
+    /**
+     * @property {Number} responseTimeout - response timeout, default is 60000
+     */
+    config.clusterClient = {
+        maxWaitTime: 60000,
+        responseTimeout: 60000,
+    };
+    /**
+     * This function / async function will be called when a client error occurred and return the response.
+     *
+     * The arguments are `err`, `socket` and `application` which indicate current client error object, current socket
+     * object and the application object.
+     *
+     * The response to be returned should include properties below:
+     *
+     * @member {Function} Config#onClientError
+     * @property [body] {String|Buffer} - the response body
+     * @property [status] {Number} - the response status code
+     * @property [headers] {Object} - the response header key-value pairs
+     *
+     * @example
+     * exports.onClientError = async (err, socket, app) => {
+     *   return {
+     *     body: 'error',
+     *     status: 400,
+     *     headers: {
+     *       'powered-by': 'Egg.js',
+     *     }
+     *   };
+     * }
+     */
+    config.onClientError = undefined;
+    return config;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsc0RBQXlCO0FBQ3pCLDBEQUE2QjtBQUk3Qjs7OztHQUlHO0FBQ0gsa0JBQWUsQ0FBQyxPQUFtQixFQUFFLEVBQUU7SUFDckMsTUFBTSxNQUFNLEdBQTBCO1FBQ3BDOzs7OztXQUtHO1FBQ0gsR0FBRyxFQUFFLE9BQU8sQ0FBQyxHQUFHO1FBRWhCOzs7OztXQUtHO1FBQ0gsSUFBSSxFQUFFLE9BQU8sQ0FBQyxJQUFJO1FBRWxCOzs7Ozs7V0FNRztRQUNILElBQUksRUFBRSxFQUFFO1FBRVI7Ozs7OztXQU1HO1FBQ0gsT0FBTyxFQUFFO1FBQ1AsMEJBQTBCO1FBQzFCLCtCQUErQjtTQUNoQztRQUVEOzs7Ozs7V0FNRztRQUNILEtBQUssRUFBRSxLQUFLO1FBRVo7Ozs7Ozs7O1dBUUc7UUFDSCxXQUFXLEVBQUUsQ0FBQztRQUVkOzs7Ozs7V0FNRztRQUNILGFBQWEsRUFBRSxDQUFDO1FBRWhCOzs7Ozs7V0FNRztRQUNILGVBQWUsRUFBRSxtQkFBbUI7UUFFcEM7Ozs7OztXQU1HO1FBQ0gsU0FBUyxFQUFFLGlCQUFpQjtRQUU1Qjs7Ozs7O1dBTUc7UUFDSCxXQUFXLEVBQUUsRUFBRTtRQUVmOzs7OztXQUtHO1FBQ0gsR0FBRyxFQUFFLE9BQU8sQ0FBQyxHQUFHO1FBRWhCOzs7OztXQUtHO1FBQ0gsT0FBTyxFQUFFLE9BQU8sQ0FBQyxPQUFPO1FBRXhCOzs7OztXQUtHO1FBQ0gsSUFBSSxFQUFFLE9BQU8sQ0FBQyxJQUFJO1FBRWxCOzs7OztXQUtHO1FBQ0gsTUFBTSxFQUFFLG1CQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDO1FBRXpDOzs7Ozs7O1dBT0c7UUFDSCxJQUFJLEVBQUU7WUFDSixNQUFNLEVBQUUsSUFBSSxHQUFHLENBQUM7Z0JBQ2QsTUFBTSxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsUUFBUSxFQUFFLFVBQVUsRUFBRSxNQUFNLEVBQUUsV0FBVyxFQUFFLFdBQVc7Z0JBQzlFLDJDQUEyQztnQkFDM0MsU0FBUzthQUNWLENBQUM7WUFDRixNQUFNLEVBQUU7Z0JBQ04scUZBQXFGO2dCQUNyRix5QkFBeUIsRUFBRSxJQUFJO2FBQ2hDO1NBQ0Y7UUFFRDs7Ozs7OztXQU9HO1FBQ0gsc0JBQXNCLEVBQUU7WUFDdEIsVUFBVSxFQUFFLFlBQVk7WUFDeEIsUUFBUSxFQUFFLFVBQVU7WUFDcEIsUUFBUSxFQUFFLFVBQVU7WUFDcEIsV0FBVyxFQUFFLFlBQVk7WUFDekIsVUFBVSxFQUFFLFlBQVk7U0FDekI7S0FDRixDQUFDO0lBRUY7Ozs7Ozs7O09BUUc7SUFDSCxNQUFNLENBQUMsUUFBUSxHQUFHO1FBQ2hCLE1BQU0sRUFBRSxJQUFJO1FBQ1osT0FBTyxFQUFFLEVBQUU7S0FDWixDQUFDO0lBRUY7Ozs7Ozs7Ozs7OztPQVlHO0lBQ0gsTUFBTSxDQUFDLFFBQVEsR0FBRztRQUNoQixNQUFNLEVBQUUsSUFBSTtRQUNaLGNBQWMsRUFBRSxpQkFBRSxDQUFDLFlBQVksQ0FBQyxtQkFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUUsYUFBYSxDQUFDLENBQUM7UUFDcEUsMkJBQTJCO1FBQzNCLFlBQVksRUFBRSx5QkFBeUI7S0FDeEMsQ0FBQztJQUVGOzs7Ozs7Ozs7Ozs7Ozs7T0FlRztJQUNILE1BQU0sQ0FBQyxVQUFVLEdBQUc7UUFDbEIsTUFBTSxFQUFFLElBQUk7UUFDWixRQUFRLEVBQUUsTUFBTTtRQUNoQixTQUFTLEVBQUUsS0FBSztRQUNoQixTQUFTLEVBQUUsS0FBSztRQUNoQixTQUFTLEVBQUUsS0FBSztRQUNoQixNQUFNLEVBQUUsSUFBSTtRQUNaLGlGQUFpRjtRQUNqRixXQUFXLEVBQUU7WUFDWCxVQUFVLEVBQUUsR0FBRztZQUNmLEtBQUssRUFBRSxDQUFDO1lBQ1IsY0FBYyxFQUFFLElBQUk7U0FDckI7UUFDRCxnQkFBZ0IsRUFBRSxPQUFPO1FBQ3pCLE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRztZQUNkLEdBQUcsQ0FBQyxPQUFPLEdBQUcsR0FBRyxHQUFHLENBQUMsT0FBTywyQkFBMkIsQ0FBQztZQUN4RCxJQUFJLEdBQUcsQ0FBQyxNQUFNLEtBQUssR0FBRyxFQUFFLENBQUM7Z0JBQ3ZCLHdEQUF3RDtnQkFDeEQsR0FBRyxDQUFDLE1BQU0sR0FBRyxHQUFHLENBQUM7Z0JBQ2pCLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLENBQUM7b0JBQ2hCLEdBQUcsQ0FBQyxNQUFNLEdBQUcsR0FBRyxDQUFDO2dCQUNuQixDQUFDO1lBQ0gsQ0FBQztZQUNELE1BQU0sR0FBRyxDQUFDO1FBQ1osQ0FBQztLQUNGLENBQUM7SUFFRjs7Ozs7Ozs7Ozs7Ozs7OztPQWdCRztJQUNILE1BQU0sQ0FBQyxNQUFNLEdBQUc7UUFDZCxHQUFHLEVBQUUsbUJBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBQztRQUNsRCxRQUFRLEVBQUUsTUFBTTtRQUNoQixHQUFHLEVBQUUsT0FBTyxDQUFDLEdBQUc7UUFDaEIsS0FBSyxFQUFFLE1BQU07UUFDYixZQUFZLEVBQUUsTUFBTTtRQUNwQix3QkFBd0IsRUFBRSxPQUFPLENBQUMsR0FBRyxLQUFLLE9BQU8sSUFBSSxPQUFPLENBQUMsR0FBRyxLQUFLLFVBQVU7UUFDL0UsVUFBVSxFQUFFLEtBQUs7UUFDakIsTUFBTSxFQUFFLElBQUk7UUFDWixVQUFVLEVBQUUsR0FBRyxPQUFPLENBQUMsSUFBSSxVQUFVO1FBQ3JDLFdBQVcsRUFBRSxhQUFhO1FBQzFCLFlBQVksRUFBRSxlQUFlO1FBQzdCLFlBQVksRUFBRSxrQkFBa0I7UUFDaEMsVUFBVSxFQUFFLEVBQUU7UUFDZCxnQkFBZ0IsRUFBRSxLQUFLO1FBQ3ZCLHVCQUF1QixFQUFFLElBQUk7S0FDOUIsQ0FBQztJQUVGOzs7Ozs7Ozs7Ozs7Ozs7Ozs7T0FrQkc7SUFDSCxNQUFNLENBQUMsVUFBVSxHQUFHO1FBQ2xCLE9BQU8sRUFBRTtZQUNQLE9BQU8sRUFBRSxJQUFJO1NBQ2Q7S0FDRixDQUFDO0lBRUY7Ozs7OztPQU1HO0lBQ0gsTUFBTSxDQUFDLElBQUksR0FBRztRQUNaLE1BQU0sRUFBRSxJQUFJO1FBQ1osT0FBTyxFQUFFLEtBQUs7S0FDZixDQUFDO0lBRUY7OztPQUdHO0lBQ0gsTUFBTSxDQUFDLGNBQWMsR0FBRztRQUN0QixNQUFNO1FBQ04sVUFBVTtRQUNWLFVBQVU7UUFDVixZQUFZO1FBQ1osZ0JBQWdCO0tBQ2pCLENBQUM7SUFFRjs7O09BR0c7SUFDSCxNQUFNLENBQUMsa0JBQWtCLEdBQUcsRUFBRSxHQUFHLEVBQUUsR0FBRyxJQUFJLENBQUM7SUFFM0M7Ozs7Ozs7T0FPRztJQUNILE1BQU0sQ0FBQyxhQUFhLEdBQUcsSUFBSSxDQUFDO0lBRTVCOzs7Ozs7O09BT0c7SUFDSCxNQUFNLENBQUMsT0FBTyxHQUFHO1FBQ2YsTUFBTSxFQUFFO1lBQ04sSUFBSSxFQUFFLEVBQUU7WUFDUixJQUFJLEVBQUUsSUFBSTtZQUNWLFFBQVEsRUFBRSxFQUFFO1NBQ2I7S0FDRixDQUFDO0lBRUY7O09BRUc7SUFDSCxNQUFNLENBQUMsYUFBYSxHQUFHO1FBQ3JCLFdBQVcsRUFBRSxLQUFLO1FBQ2xCLGVBQWUsRUFBRSxLQUFLO0tBQ3ZCLENBQUM7SUFFRjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7T0F1Qkc7SUFDSCxNQUFNLENBQUMsYUFBYSxHQUFHLFNBQVMsQ0FBQztJQUVqQyxPQUFPLE1BQU0sQ0FBQztBQUNoQixDQUFDLENBQUMifQ==

package/dist/commonjs/config/config.local.d.ts

@@ -0,0 +1,8 @@
+declare const _default: () => {
+    logger: {
+        coreLogger: {
+            consoleLevel: "WARN";
+        };
+    };
+};
+export default _default;

package/dist/commonjs/config/config.local.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = () => {
+    return {
+        logger: {
+            coreLogger: {
+                consoleLevel: 'WARN',
+            },
+        },
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmxvY2FsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9jb25maWcubG9jYWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFFQSxrQkFBZSxHQUFHLEVBQUU7SUFDbEIsT0FBTztRQUNMLE1BQU0sRUFBRTtZQUNOLFVBQVUsRUFBRTtnQkFDVixZQUFZLEVBQUUsTUFBTTthQUNyQjtTQUNGO0tBQzhCLENBQUM7QUFDcEMsQ0FBQyxDQUFDIn0=

package/dist/commonjs/config/config.unittest.d.ts

@@ -0,0 +1,7 @@
+declare const _default: () => {
+    logger: {
+        consoleLevel: "WARN";
+        buffer: false;
+    };
+};
+export default _default;

package/dist/commonjs/config/config.unittest.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = () => {
+    return {
+        logger: {
+            consoleLevel: 'WARN',
+            buffer: false,
+        },
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLnVuaXR0ZXN0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9jb25maWcudW5pdHRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFFQSxrQkFBZSxHQUFHLEVBQUU7SUFDbEIsT0FBTztRQUNMLE1BQU0sRUFBRTtZQUNOLFlBQVksRUFBRSxNQUFNO1lBQ3BCLE1BQU0sRUFBRSxLQUFLO1NBQ2Q7S0FDOEIsQ0FBQztBQUNwQyxDQUFDLENBQUMifQ==