egg 4.0.0-beta.0 → 4.0.0-beta.11

package/README.md

@@ -7,6 +7,7 @@ English | [简体中文](./README.zh-CN.md)
 [![NPM version](https://img.shields.io/npm/v/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
 [![NPM quality](http://npm.packagequality.com/shield/egg.svg?style=flat-square)](http://packagequality.com/#?package=egg)
 [![NPM download](https://img.shields.io/npm/dm/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
+[![Node.js Version](https://img.shields.io/node/v/egg.svg?style=flat)](https://nodejs.org/en/download/)
 [![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.yml/badge.svg)](https://github.com/eggjs/egg/actions?query=branch%3Amaster)

package/README.zh-CN.md

@@ -7,6 +7,7 @@
 [![NPM version](https://img.shields.io/npm/v/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
 [![NPM quality](http://npm.packagequality.com/shield/egg.svg?style=flat-square)](http://packagequality.com/#?package=egg)
 [![NPM download](https://img.shields.io/npm/dm/egg.svg?style=flat-square)](https://npmjs.org/package/egg)
+[![Node.js Version](https://img.shields.io/node/v/egg.svg?style=flat)](https://nodejs.org/en/download/)
 
 [![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)

package/dist/commonjs/app/extend/context.d.ts

@@ -0,0 +1,154 @@
+import { Context as EggCoreContext, Router, type ContextDelegation as EggCoreContextDelegation } from '@eggjs/core';
+import type { Cookies as ContextCookies } from '@eggjs/cookies';
+import { EggLogger } from 'egg-logger';
+import type { Application } from '../../lib/application.js';
+import type { HttpClientRequestURL, HttpClientRequestOptions, HttpClient } from '../../lib/core/httpclient.js';
+import type { ContextHttpClient } from '../../lib/core/context_httpclient.js';
+import type { BaseContextClass } from '../../lib//core/base_context_class.js';
+import Request from './request.js';
+import Response from './response.js';
+import type Helper from './helper.js';
+import './context.types.js';
+interface Cookies extends ContextCookies {
+    request: any;
+    response: any;
+}
+export default class Context extends EggCoreContext {
+    app: Application;
+    request: Request;
+    service: BaseContextClass;
+    /**
+     * Request start time
+     * @member {Number} Context#starttime
+     */
+    starttime: number;
+    /**
+     * Request start timer using `performance.now()`
+     * @member {Number} Context#performanceStarttime
+     */
+    performanceStarttime: number;
+    /**
+     * Get the current visitor's cookies.
+     */
+    get cookies(): Cookies;
+    /**
+     * Get a wrapper httpclient instance contain ctx in the hold request process
+     *
+     * @return {ContextHttpClient} the wrapper httpclient instance
+     */
+    get httpclient(): ContextHttpClient;
+    /**
+     * Alias to {@link Context#httpclient}
+     */
+    get httpClient(): ContextHttpClient;
+    /**
+     * Shortcut for httpclient.curl
+     *
+     * @function Context#curl
+     * @param {String|Object} url - request url address.
+     * @param {Object} [options] - options for request.
+     * @return {Object} see {@link ContextHttpClient#curl}
+     */
+    curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
+    /**
+     * Alias to {@link Application#router}
+     *
+     * @member {Router} Context#router
+     * @since 1.0.0
+     * @example
+     * ```js
+     * this.router.pathFor('post', { id: 12 });
+     * ```
+     */
+    get router(): Router;
+    /**
+     * Set router to Context, only use on EggRouter
+     * @param {Router} val router instance
+     */
+    set router(val: Router);
+    /**
+     * Get helper instance from {@link Application#Helper}
+     *
+     * @member {Helper} Context#helper
+     * @since 1.0.0
+     */
+    get helper(): Helper;
+    /**
+     * Wrap app.loggers with context information,
+     * if a custom logger is defined by naming aLogger, then you can `ctx.getLogger('aLogger')`
+     *
+     * @param {String} name - logger name
+     */
+    getLogger(name: string): EggLogger;
+    /**
+     * Logger for Application
+     *
+     * @member {Logger} Context#logger
+     * @since 1.0.0
+     * @example
+     * ```js
+     * this.logger.info('some request data: %j', this.request.body);
+     * this.logger.warn('WARNING!!!!');
+     * ```
+     */
+    get logger(): EggLogger;
+    /**
+     * Logger for frameworks and plugins
+     *
+     * @member {Logger} Context#coreLogger
+     * @since 1.0.0
+     */
+    get coreLogger(): EggLogger;
+    /**
+     * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
+     * which will be used as data when view is rendering.
+     * The difference between `app.locals` and `ctx.locals` is the context level, `app.locals` is global level, and `ctx.locals` is request level. when you get `ctx.locals`, it will merge `app.locals`.
+     *
+     * when you set locals, only object is available
+     *
+     * ```js
+     * this.locals = {
+     *   a: 1
+     * };
+     * this.locals = {
+     *   b: 1
+     * };
+     * this.locals.c = 1;
+     * console.log(this.locals);
+     * {
+     *   a: 1,
+     *   b: 1,
+     *   c: 1,
+     * };
+     * ```
+     *
+     * `ctx.locals` has cache, it only merges `app.locals` once in one request.
+     *
+     * @member {Object} Context#locals
+     */
+    get locals(): Record<string, any>;
+    set locals(val: Record<string, any>);
+    /**
+     * alias to {@link Context#locals}, compatible with koa that use this variable
+     * @member {Object} state
+     * @see Context#locals
+     */
+    get state(): Record<string, any>;
+    set state(val: Record<string, any>);
+    /**
+     * Run async function in the background
+     * @param {Function} scope - the first args is ctx
+     * ```js
+     * this.body = 'hi';
+     *
+     * this.runInBackground(async ctx => {
+     *   await ctx.mysql.query(sql);
+     *   await ctx.curl(url);
+     * });
+     * ```
+     */
+    runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName?: string): void;
+    _runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName: string): Promise<void>;
+}
+export type ContextDelegation = EggCoreContextDelegation & Context & Pick<Request, 'acceptJSON' | 'queries' | 'accept' | 'ip'> & Pick<Response, 'realStatus'>;
+export {};

package/dist/commonjs/app/extend/context.js

@@ -0,0 +1,261 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const delegates_1 = __importDefault(require("delegates"));
+const utility_1 = require("utility");
+const performance_ms_1 = require("performance-ms");
+const core_1 = require("@eggjs/core");
+require("./context.types.js");
+const HELPER = Symbol('ctx helper');
+const LOCALS = Symbol('ctx locals');
+const LOCALS_LIST = Symbol('ctx localsList');
+const COOKIES = Symbol('ctx cookies');
+const CONTEXT_HTTPCLIENT = Symbol('ctx httpclient');
+const CONTEXT_ROUTER = Symbol('ctx router');
+class Context extends core_1.Context {
+    /**
+     * Request start time
+     * @member {Number} Context#starttime
+     */
+    starttime;
+    /**
+     * Request start timer using `performance.now()`
+     * @member {Number} Context#performanceStarttime
+     */
+    performanceStarttime;
+    /**
+     * Get the current visitor's cookies.
+     */
+    get cookies() {
+        let cookies = this[COOKIES];
+        if (!cookies) {
+            this[COOKIES] = cookies = new this.app.ContextCookies(this, this.app.keys, this.app.config.cookies);
+        }
+        return cookies;
+    }
+    /**
+     * Get a wrapper httpclient instance contain ctx in the hold request process
+     *
+     * @return {ContextHttpClient} the wrapper httpclient instance
+     */
+    get httpclient() {
+        if (!this[CONTEXT_HTTPCLIENT]) {
+            this[CONTEXT_HTTPCLIENT] = new this.app.ContextHttpClient(this);
+        }
+        return this[CONTEXT_HTTPCLIENT];
+    }
+    /**
+     * Alias to {@link Context#httpclient}
+     */
+    get httpClient() {
+        return this.httpclient;
+    }
+    /**
+     * Shortcut for httpclient.curl
+     *
+     * @function Context#curl
+     * @param {String|Object} url - request url address.
+     * @param {Object} [options] - options for request.
+     * @return {Object} see {@link ContextHttpClient#curl}
+     */
+    async curl(url, options) {
+        return await this.httpclient.curl(url, options);
+    }
+    /**
+     * Alias to {@link Application#router}
+     *
+     * @member {Router} Context#router
+     * @since 1.0.0
+     * @example
+     * ```js
+     * this.router.pathFor('post', { id: 12 });
+     * ```
+     */
+    get router() {
+        if (this[CONTEXT_ROUTER]) {
+            return this[CONTEXT_ROUTER];
+        }
+        return this.app.router;
+    }
+    /**
+     * Set router to Context, only use on EggRouter
+     * @param {Router} val router instance
+     */
+    set router(val) {
+        this[CONTEXT_ROUTER] = val;
+    }
+    /**
+     * Get helper instance from {@link Application#Helper}
+     *
+     * @member {Helper} Context#helper
+     * @since 1.0.0
+     */
+    get helper() {
+        if (!this[HELPER]) {
+            this[HELPER] = new this.app.Helper(this);
+        }
+        return this[HELPER];
+    }
+    /**
+     * Wrap app.loggers with context information,
+     * if a custom logger is defined by naming aLogger, then you can `ctx.getLogger('aLogger')`
+     *
+     * @param {String} name - logger name
+     */
+    getLogger(name) {
+        return this.app.getLogger(name);
+    }
+    /**
+     * Logger for Application
+     *
+     * @member {Logger} Context#logger
+     * @since 1.0.0
+     * @example
+     * ```js
+     * this.logger.info('some request data: %j', this.request.body);
+     * this.logger.warn('WARNING!!!!');
+     * ```
+     */
+    get logger() {
+        return this.getLogger('logger');
+    }
+    /**
+     * Logger for frameworks and plugins
+     *
+     * @member {Logger} Context#coreLogger
+     * @since 1.0.0
+     */
+    get coreLogger() {
+        return this.getLogger('coreLogger');
+    }
+    /**
+     * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
+     * which will be used as data when view is rendering.
+     * The difference between `app.locals` and `ctx.locals` is the context level, `app.locals` is global level, and `ctx.locals` is request level. when you get `ctx.locals`, it will merge `app.locals`.
+     *
+     * when you set locals, only object is available
+     *
+     * ```js
+     * this.locals = {
+     *   a: 1
+     * };
+     * this.locals = {
+     *   b: 1
+     * };
+     * this.locals.c = 1;
+     * console.log(this.locals);
+     * {
+     *   a: 1,
+     *   b: 1,
+     *   c: 1,
+     * };
+     * ```
+     *
+     * `ctx.locals` has cache, it only merges `app.locals` once in one request.
+     *
+     * @member {Object} Context#locals
+     */
+    get locals() {
+        if (!this[LOCALS]) {
+            this[LOCALS] = (0, utility_1.assign)({}, this.app.locals);
+        }
+        if (Array.isArray(this[LOCALS_LIST]) && this[LOCALS_LIST].length > 0) {
+            (0, utility_1.assign)(this[LOCALS], this[LOCALS_LIST]);
+            this[LOCALS_LIST] = null;
+        }
+        return this[LOCALS];
+    }
+    set locals(val) {
+        const localsList = this[LOCALS_LIST] ?? [];
+        localsList.push(val);
+        this[LOCALS_LIST] = localsList;
+    }
+    /**
+     * alias to {@link Context#locals}, compatible with koa that use this variable
+     * @member {Object} state
+     * @see Context#locals
+     */
+    get state() {
+        return this.locals;
+    }
+    set state(val) {
+        this.locals = val;
+    }
+    /**
+     * Run async function in the background
+     * @param {Function} scope - the first args is ctx
+     * ```js
+     * this.body = 'hi';
+     *
+     * this.runInBackground(async ctx => {
+     *   await ctx.mysql.query(sql);
+     *   await ctx.curl(url);
+     * });
+     * ```
+     */
+    runInBackground(scope, taskName) {
+        // try to use custom function name first
+        if (!taskName) {
+            taskName = Reflect.get(scope, '_name') || scope.name || core_1.utils.getCalleeFromStack(true);
+        }
+        // use setImmediate to ensure all sync logic will run async
+        setImmediate(() => {
+            this._runInBackground(scope, taskName);
+        });
+    }
+    // let plugins or frameworks to reuse _runInBackground in some cases.
+    // e.g.: https://github.com/eggjs/egg-mock/pull/78
+    async _runInBackground(scope, taskName) {
+        const startTime = (0, performance_ms_1.now)();
+        try {
+            await scope(this);
+            this.coreLogger.info('[egg:background] task:%s success (%dms)', taskName, (0, performance_ms_1.diff)(startTime));
+        }
+        catch (err) {
+            // background task process log
+            this.coreLogger.info('[egg:background] task:%s fail (%dms)', taskName, (0, performance_ms_1.diff)(startTime));
+            // emit error when promise catch, and set err.runInBackground flag
+            err.runInBackground = true;
+            this.app.emit('error', err, this);
+        }
+    }
+}
+exports.default = Context;
+/**
+ * Context delegation.
+ */
+(0, delegates_1.default)(Context.prototype, 'request')
+    /**
+     * @member {Boolean} Context#acceptJSON
+     * @see Request#acceptJSON
+     * @since 1.0.0
+     */
+    .getter('acceptJSON')
+    /**
+     * @member {Array} Context#queries
+     * @see Request#queries
+     * @since 1.0.0
+     */
+    .getter('queries')
+    /**
+     * @member {Boolean} Context#accept
+     * @see Request#accept
+     * @since 1.0.0
+     */
+    .getter('accept')
+    /**
+     * @member {string} Context#ip
+     * @see Request#ip
+     * @since 1.0.0
+     */
+    .access('ip');
+(0, delegates_1.default)(Context.prototype, 'response')
+    /**
+     * @member {Number} Context#realStatus
+     * @see Response#realStatus
+     * @since 1.0.0
+     */
+    .access('realStatus');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSwwREFBaUM7QUFDakMscUNBQWlDO0FBQ2pDLG1EQUEyQztBQUMzQyxzQ0FHcUI7QUFhckIsOEJBQTRCO0FBRTVCLE1BQU0sTUFBTSxHQUFHLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUNwQyxNQUFNLE1BQU0sR0FBRyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUM7QUFDcEMsTUFBTSxXQUFXLEdBQUcsTUFBTSxDQUFDLGdCQUFnQixDQUFDLENBQUM7QUFDN0MsTUFBTSxPQUFPLEdBQUcsTUFBTSxDQUFDLGFBQWEsQ0FBQyxDQUFDO0FBQ3RDLE1BQU0sa0JBQWtCLEdBQUcsTUFBTSxDQUFDLGdCQUFnQixDQUFDLENBQUM7QUFDcEQsTUFBTSxjQUFjLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBTzVDLE1BQXFCLE9BQVEsU0FBUSxjQUFjO0lBS2pEOzs7T0FHRztJQUNILFNBQVMsQ0FBUztJQUNsQjs7O09BR0c7SUFDSCxvQkFBb0IsQ0FBUztJQUU3Qjs7T0FFRztJQUNILElBQUksT0FBTztRQUNULElBQUksT0FBTyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUM1QixJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDYixJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsT0FBTyxHQUFHLElBQUksSUFBSSxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ3RHLENBQUM7UUFDRCxPQUFPLE9BQWtCLENBQUM7SUFDNUIsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxJQUFJLFVBQVU7UUFDWixJQUFJLENBQUMsSUFBSSxDQUFDLGtCQUFrQixDQUFDLEVBQUUsQ0FBQztZQUM5QixJQUFJLENBQUMsa0JBQWtCLENBQUMsR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLENBQUMsaUJBQWlCLENBQUMsSUFBVyxDQUFDLENBQUM7UUFDekUsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDLGtCQUFrQixDQUFzQixDQUFDO0lBQ3ZELENBQUM7SUFFRDs7T0FFRztJQUNILElBQUksVUFBVTtRQUNaLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQztJQUN6QixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILEtBQUssQ0FBQyxJQUFJLENBQUMsR0FBeUIsRUFBRSxPQUFrQztRQUN0RSxPQUFPLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ2xELENBQUM7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSCxJQUFJLE1BQU07UUFDUixJQUFJLElBQUksQ0FBQyxjQUFjLENBQUMsRUFBRSxDQUFDO1lBQ3pCLE9BQU8sSUFBSSxDQUFDLGNBQWMsQ0FBVyxDQUFDO1FBQ3hDLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDO0lBQ3pCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxJQUFJLE1BQU0sQ0FBQyxHQUFXO1FBQ3BCLElBQUksQ0FBQyxjQUFjLENBQUMsR0FBRyxHQUFHLENBQUM7SUFDN0IsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1lBQ2xCLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLElBQVcsQ0FBQyxDQUFDO1FBQ2xELENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQVcsQ0FBQztJQUNoQyxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxTQUFTLENBQUMsSUFBWTtRQUNwQixPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ2xDLENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsT0FBTyxJQUFJLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2xDLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILElBQUksVUFBVTtRQUNaLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQUMsQ0FBQztJQUN0QyxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O09BMEJHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1lBQ2xCLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxJQUFBLGdCQUFNLEVBQUMsRUFBRSxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDN0MsQ0FBQztRQUNELElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQ3JFLElBQUEsZ0JBQU0sRUFBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDeEMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLElBQUksQ0FBQztRQUMzQixDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUF3QixDQUFDO0lBQzdDLENBQUM7SUFFRCxJQUFJLE1BQU0sQ0FBQyxHQUFHO1FBQ1osTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBMEIsSUFBSSxFQUFFLENBQUM7UUFDcEUsVUFBVSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNyQixJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsVUFBVSxDQUFDO0lBQ2pDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxLQUFLO1FBQ1AsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDO0lBQ3JCLENBQUM7SUFFRCxJQUFJLEtBQUssQ0FBQyxHQUFHO1FBQ1gsSUFBSSxDQUFDLE1BQU0sR0FBRyxHQUFHLENBQUM7SUFDcEIsQ0FBQztJQUVEOzs7Ozs7Ozs7OztPQVdHO0lBQ0gsZUFBZSxDQUFDLEtBQWdELEVBQUUsUUFBaUI7UUFDakYsd0NBQXdDO1FBQ3hDLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNkLFFBQVEsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLEtBQUssRUFBRSxPQUFPLENBQUMsSUFBSSxLQUFLLENBQUMsSUFBSSxJQUFJLFlBQUssQ0FBQyxrQkFBa0IsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUN6RixDQUFDO1FBQ0QsMkRBQTJEO1FBQzNELFlBQVksQ0FBQyxHQUFHLEVBQUU7WUFDaEIsSUFBSSxDQUFDLGdCQUFnQixDQUFDLEtBQUssRUFBRSxRQUFTLENBQUMsQ0FBQztRQUMxQyxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRCxxRUFBcUU7SUFDckUsa0RBQWtEO0lBQ2xELEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFnRCxFQUFFLFFBQWdCO1FBQ3ZGLE1BQU0sU0FBUyxHQUFHLElBQUEsb0JBQUcsR0FBRSxDQUFDO1FBQ3hCLElBQUksQ0FBQztZQUNILE1BQU0sS0FBSyxDQUFDLElBQVcsQ0FBQyxDQUFDO1lBQ3pCLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHlDQUF5QyxFQUFFLFFBQVEsRUFBRSxJQUFBLHFCQUFJLEVBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQztRQUM3RixDQUFDO1FBQUMsT0FBTyxHQUFRLEVBQUUsQ0FBQztZQUNsQiw4QkFBOEI7WUFDOUIsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsc0NBQXNDLEVBQUUsUUFBUSxFQUFFLElBQUEscUJBQUksRUFBQyxTQUFTLENBQUMsQ0FBQyxDQUFDO1lBRXhGLGtFQUFrRTtZQUNsRSxHQUFHLENBQUMsZUFBZSxHQUFHLElBQUksQ0FBQztZQUMzQixJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3BDLENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUFuT0QsMEJBbU9DO0FBRUQ7O0dBRUc7QUFFSCxJQUFBLG1CQUFRLEVBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxTQUFTLENBQUM7SUFDcEM7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxZQUFZLENBQUM7SUFDckI7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxTQUFTLENBQUM7SUFDbEI7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxRQUFRLENBQUM7SUFDakI7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztBQUVoQixJQUFBLG1CQUFRLEVBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxVQUFVLENBQUM7SUFDckM7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyJ9

package/dist/commonjs/app/extend/context.types.d.ts

@@ -0,0 +1,16 @@
+import type { Router } from '@eggjs/core';
+import type { HttpClientRequestURL, HttpClientRequestOptions, HttpClient } from '../../lib/core/httpclient.js';
+import type { ContextHttpClient } from '../../lib/core/context_httpclient.js';
+import type Helper from './helper.js';
+import type { EggLogger } from 'egg-logger';
+declare module '@eggjs/core' {
+    interface Context {
+        curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
+        get router(): Router;
+        set router(val: Router);
+        get helper(): Helper;
+        get httpclient(): ContextHttpClient;
+        get httpClient(): ContextHttpClient;
+        getLogger(name: string): EggLogger;
+    }
+}

package/dist/commonjs/app/extend/context.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC50eXBlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/commonjs/app/extend/helper.d.ts

@@ -0,0 +1,37 @@
+import { BaseContextClass } from '../../lib/core/base_context_class.js';
+/**
+ * The Helper class which can be used as utility function.
+ * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
+ * then you can use all method on `ctx.helper` that is a instance of Helper.
+ */
+export default class Helper extends BaseContextClass {
+    /**
+     * Generate URL path(without host) for route. Takes the route name and a map of named params.
+     * @function Helper#pathFor
+     * @param {String} name - Router Name
+     * @param {Object} params - Other params
+     *
+     * @example
+     * ```js
+     * app.get('home', '/index.htm', 'home.index');
+     * ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
+     * => /index.htm?by=recent&limit=20
+     * ```
+     * @return {String} url path(without host)
+     */
+    pathFor(name: string, params: Record<string, any>): string;
+    /**
+     * Generate full URL(with host) for route. Takes the route name and a map of named params.
+     * @function Helper#urlFor
+     * @param {String} name - Router name
+     * @param {Object} params - Other params
+     * @example
+     * ```js
+     * app.get('home', '/index.htm', 'home.index');
+     * ctx.helper.urlFor('home', { by: 'recent', limit: 20 })
+     * => http://127.0.0.1:7001/index.htm?by=recent&limit=20
+     * ```
+     * @return {String} full url(with host)
+     */
+    urlFor(name: string, params: Record<string, any>): string;
+}

package/dist/commonjs/app/extend/helper.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_url_1 = __importDefault(require("node:url"));
+const base_context_class_js_1 = require("../../lib/core/base_context_class.js");
+/**
+ * The Helper class which can be used as utility function.
+ * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
+ * then you can use all method on `ctx.helper` that is a instance of Helper.
+ */
+class Helper extends base_context_class_js_1.BaseContextClass {
+    /**
+     * Generate URL path(without host) for route. Takes the route name and a map of named params.
+     * @function Helper#pathFor
+     * @param {String} name - Router Name
+     * @param {Object} params - Other params
+     *
+     * @example
+     * ```js
+     * app.get('home', '/index.htm', 'home.index');
+     * ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
+     * => /index.htm?by=recent&limit=20
+     * ```
+     * @return {String} url path(without host)
+     */
+    pathFor(name, params) {
+        return this.app.router.url(name, params);
+    }
+    /**
+     * Generate full URL(with host) for route. Takes the route name and a map of named params.
+     * @function Helper#urlFor
+     * @param {String} name - Router name
+     * @param {Object} params - Other params
+     * @example
+     * ```js
+     * app.get('home', '/index.htm', 'home.index');
+     * ctx.helper.urlFor('home', { by: 'recent', limit: 20 })
+     * => http://127.0.0.1:7001/index.htm?by=recent&limit=20
+     * ```
+     * @return {String} full url(with host)
+     */
+    urlFor(name, params) {
+        return this.ctx.protocol + '://' + this.ctx.host + node_url_1.default.resolve('/', this.pathFor(name, params));
+    }
+}
+exports.default = Helper;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9leHRlbmQvaGVscGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsd0RBQTJCO0FBQzNCLGdGQUF3RTtBQUV4RTs7OztHQUlHO0FBQ0gsTUFBcUIsTUFBTyxTQUFRLHdDQUFnQjtJQUNsRDs7Ozs7Ozs7Ozs7OztPQWFHO0lBQ0gsT0FBTyxDQUFDLElBQVksRUFBRSxNQUEyQjtRQUMvQyxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDM0MsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7T0FZRztJQUNILE1BQU0sQ0FBQyxJQUFZLEVBQUUsTUFBMkI7UUFDOUMsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLFFBQVEsR0FBRyxLQUFLLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEdBQUcsa0JBQUcsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7SUFDbEcsQ0FBQztDQUNGO0FBbkNELHlCQW1DQyJ9

package/dist/commonjs/app/extend/request.d.ts

@@ -0,0 +1,128 @@
+import { Request as EggCoreRequest } from '@eggjs/core';
+import type { Application } from '../../lib/application.js';
+import type { ContextDelegation } from './context.js';
+import Response from './response.js';
+export default class Request extends EggCoreRequest {
+    app: Application;
+    ctx: ContextDelegation;
+    response: Response;
+    /**
+     * Parse the "Host" header field host
+     * and support X-Forwarded-Host when a
+     * proxy is enabled.
+     * @member {String} Request#host
+     * @example
+     * ip + port
+     * ```js
+     * this.request.host
+     * => '127.0.0.1:7001'
+     * ```
+     * or domain
+     * ```js
+     * this.request.host
+     * => 'demo.eggjs.org'
+     * ```
+     */
+    get host(): string;
+    /**
+     * @member {String} Request#protocol
+     * @example
+     * ```js
+     * this.request.protocol
+     * => 'https'
+     * ```
+     */
+    get protocol(): string;
+    /**
+     * Get all pass through ip addresses from the request.
+     * Enable only on `app.config.proxy = true`
+     *
+     * @member {Array} Request#ips
+     * @example
+     * ```js
+     * this.request.ips
+     * => ['100.23.1.2', '201.10.10.2']
+     * ```
+     */
+    get ips(): string[];
+    /**
+     * Get the request remote IPv4 address
+     * @member {String} Request#ip
+     * @return {String} IPv4 address
+     * @example
+     * ```js
+     * this.request.ip
+     * => '127.0.0.1'
+     * => '111.10.2.1'
+     * ```
+     */
+    get ip(): string;
+    /**
+     * Set the request remote IPv4 address
+     * @member {String} Request#ip
+     * @param {String} ip - IPv4 address
+     * @example
+     * ```js
+     * this.request.ip
+     * => '127.0.0.1'
+     * => '111.10.2.1'
+     * ```
+     */
+    set ip(ip: string);
+    /**
+     * detect if response should be json
+     * 1. url path ends with `.json`
+     * 2. response type is set to json
+     * 3. detect by request accept header
+     *
+     * @member {Boolean} Request#acceptJSON
+     * @since 1.0.0
+     */
+    get acceptJSON(): boolean;
+    _customQuery(cacheName: symbol, filter: (value: string | string[]) => string | string[]): Record<string, string | string[]>;
+    /**
+     * get params pass by querystring, all values are of string type.
+     * @member {Object} Request#query
+     * @example
+     * ```js
+     * GET http://127.0.0.1:7001?name=Foo&age=20&age=21
+     * this.query
+     * => { 'name': 'Foo', 'age': '20' }
+     *
+     * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
+     * this.query
+     * =>
+     * {
+     *   "a": "b",
+     *   "o[foo]": "bar",
+     *   "b[]": "1",
+     *   "e": "val"
+     * }
+     * ```
+     */
+    get query(): Record<string, string>;
+    /**
+     * get params pass by querystring, all value are Array type. {@link Request#query}
+     * @member {Array} Request#queries
+     * @example
+     * ```js
+     * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
+     * this.queries
+     * =>
+     * {
+     *   "a": ["b", "c"],
+     *   "o[foo]": ["bar"],
+     *   "b[]": ["1", "2"],
+     *   "e": ["val"]
+     * }
+     * ```
+     */
+    get queries(): Record<string, string[]>;
+    /**
+     * Set query-string as an object.
+     *
+     * @function Request#query
+     * @param {Object} obj set querystring and query object for request.
+     */
+    set query(obj: Record<string, string>);
+}