egg 3.29.0 → 4.0.0-beta.10

package/dist/esm/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/esm/app/extend/context.js

@@ -0,0 +1,255 @@
+import delegate from 'delegates';
+import { assign } from 'utility';
+import { now, diff } from 'performance-ms';
+import { utils, Context as EggCoreContext, } from '@eggjs/core';
+import './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');
+export default class Context extends EggCoreContext {
+    /**
+     * 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] = assign({}, this.app.locals);
+        }
+        if (Array.isArray(this[LOCALS_LIST]) && this[LOCALS_LIST].length > 0) {
+            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 || 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 = now();
+        try {
+            await scope(this);
+            this.coreLogger.info('[egg:background] task:%s success (%dms)', taskName, diff(startTime));
+        }
+        catch (err) {
+            // background task process log
+            this.coreLogger.info('[egg:background] task:%s fail (%dms)', taskName, diff(startTime));
+            // emit error when promise catch, and set err.runInBackground flag
+            err.runInBackground = true;
+            this.app.emit('error', err, this);
+        }
+    }
+}
+/**
+ * Context delegation.
+ */
+delegate(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');
+delegate(Context.prototype, 'response')
+    /**
+     * @member {Number} Context#realStatus
+     * @see Response#realStatus
+     * @since 1.0.0
+     */
+    .access('realStatus');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxRQUFRLE1BQU0sV0FBVyxDQUFDO0FBQ2pDLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxTQUFTLENBQUM7QUFDakMsT0FBTyxFQUFFLEdBQUcsRUFBRSxJQUFJLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQztBQUMzQyxPQUFPLEVBQ0wsS0FBSyxFQUFFLE9BQU8sSUFBSSxjQUFjLEdBRWpDLE1BQU0sYUFBYSxDQUFDO0FBYXJCLE9BQU8sb0JBQW9CLENBQUM7QUFFNUIsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBQ3BDLE1BQU0sTUFBTSxHQUFHLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUNwQyxNQUFNLFdBQVcsR0FBRyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztBQUM3QyxNQUFNLE9BQU8sR0FBRyxNQUFNLENBQUMsYUFBYSxDQUFDLENBQUM7QUFDdEMsTUFBTSxrQkFBa0IsR0FBRyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztBQUNwRCxNQUFNLGNBQWMsR0FBRyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUM7QUFPNUMsTUFBTSxDQUFDLE9BQU8sT0FBTyxPQUFRLFNBQVEsY0FBYztJQUtqRDs7O09BR0c7SUFDSCxTQUFTLENBQVM7SUFDbEI7OztPQUdHO0lBQ0gsb0JBQW9CLENBQVM7SUFFN0I7O09BRUc7SUFDSCxJQUFJLE9BQU87UUFDVCxJQUFJLE9BQU8sR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDNUIsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDO1lBQ2IsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLE9BQU8sR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUN0RyxDQUFDO1FBQ0QsT0FBTyxPQUFrQixDQUFDO0lBQzVCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxVQUFVO1FBQ1osSUFBSSxDQUFDLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxFQUFFLENBQUM7WUFDOUIsSUFBSSxDQUFDLGtCQUFrQixDQUFDLEdBQUcsSUFBSSxJQUFJLENBQUMsR0FBRyxDQUFDLGlCQUFpQixDQUFDLElBQVcsQ0FBQyxDQUFDO1FBQ3pFLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxrQkFBa0IsQ0FBc0IsQ0FBQztJQUN2RCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJLFVBQVU7UUFDWixPQUFPLElBQUksQ0FBQyxVQUFVLENBQUM7SUFDekIsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxLQUFLLENBQUMsSUFBSSxDQUFDLEdBQXlCLEVBQUUsT0FBa0M7UUFDdEUsT0FBTyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBRUQ7Ozs7Ozs7OztPQVNHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsSUFBSSxJQUFJLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQztZQUN6QixPQUFPLElBQUksQ0FBQyxjQUFjLENBQVcsQ0FBQztRQUN4QyxDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQztJQUN6QixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsSUFBSSxNQUFNLENBQUMsR0FBVztRQUNwQixJQUFJLENBQUMsY0FBYyxDQUFDLEdBQUcsR0FBRyxDQUFDO0lBQzdCLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILElBQUksTUFBTTtRQUNSLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztZQUNsQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsSUFBSSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxJQUFXLENBQUMsQ0FBQztRQUNsRCxDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFXLENBQUM7SUFDaEMsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsU0FBUyxDQUFDLElBQVk7UUFDcEIsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNsQyxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILElBQUksTUFBTTtRQUNSLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNsQyxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxJQUFJLFVBQVU7UUFDWixPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDdEMsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztPQTBCRztJQUNILElBQUksTUFBTTtRQUNSLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztZQUNsQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsTUFBTSxDQUFDLEVBQUUsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQzdDLENBQUM7UUFDRCxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLElBQUksSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUNyRSxNQUFNLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxFQUFFLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQ3hDLElBQUksQ0FBQyxXQUFXLENBQUMsR0FBRyxJQUFJLENBQUM7UUFDM0IsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBd0IsQ0FBQztJQUM3QyxDQUFDO0lBRUQsSUFBSSxNQUFNLENBQUMsR0FBRztRQUNaLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQTBCLElBQUksRUFBRSxDQUFDO1FBQ3BFLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDckIsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLFVBQVUsQ0FBQztJQUNqQyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILElBQUksS0FBSztRQUNQLE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQztJQUNyQixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsR0FBRztRQUNYLElBQUksQ0FBQyxNQUFNLEdBQUcsR0FBRyxDQUFDO0lBQ3BCLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNILGVBQWUsQ0FBQyxLQUFnRCxFQUFFLFFBQWlCO1FBQ2pGLHdDQUF3QztRQUN4QyxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDZCxRQUFRLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLElBQUksS0FBSyxDQUFDLElBQUksSUFBSSxLQUFLLENBQUMsa0JBQWtCLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDekYsQ0FBQztRQUNELDJEQUEyRDtRQUMzRCxZQUFZLENBQUMsR0FBRyxFQUFFO1lBQ2hCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsUUFBUyxDQUFDLENBQUM7UUFDMUMsQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDO0lBRUQscUVBQXFFO0lBQ3JFLGtEQUFrRDtJQUNsRCxLQUFLLENBQUMsZ0JBQWdCLENBQUMsS0FBZ0QsRUFBRSxRQUFnQjtRQUN2RixNQUFNLFNBQVMsR0FBRyxHQUFHLEVBQUUsQ0FBQztRQUN4QixJQUFJLENBQUM7WUFDSCxNQUFNLEtBQUssQ0FBQyxJQUFXLENBQUMsQ0FBQztZQUN6QixJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyx5Q0FBeUMsRUFBRSxRQUFRLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUM7UUFDN0YsQ0FBQztRQUFDLE9BQU8sR0FBUSxFQUFFLENBQUM7WUFDbEIsOEJBQThCO1lBQzlCLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHNDQUFzQyxFQUFFLFFBQVEsRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQztZQUV4RixrRUFBa0U7WUFDbEUsR0FBRyxDQUFDLGVBQWUsR0FBRyxJQUFJLENBQUM7WUFDM0IsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNwQyxDQUFDO0lBQ0gsQ0FBQztDQUNGO0FBRUQ7O0dBRUc7QUFFSCxRQUFRLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxTQUFTLENBQUM7SUFDcEM7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxZQUFZLENBQUM7SUFDckI7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxTQUFTLENBQUM7SUFDbEI7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxRQUFRLENBQUM7SUFDakI7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztBQUVoQixRQUFRLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxVQUFVLENBQUM7SUFDckM7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyJ9

package/dist/esm/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/esm/app/extend/context.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC50eXBlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/esm/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/esm/app/extend/helper.js

@@ -0,0 +1,43 @@
+import url from 'node:url';
+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, 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 + url.resolve('/', this.pathFor(name, params));
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9leHRlbmQvaGVscGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sR0FBRyxNQUFNLFVBQVUsQ0FBQztBQUMzQixPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxzQ0FBc0MsQ0FBQztBQUV4RTs7OztHQUlHO0FBQ0gsTUFBTSxDQUFDLE9BQU8sT0FBTyxNQUFPLFNBQVEsZ0JBQWdCO0lBQ2xEOzs7Ozs7Ozs7Ozs7O09BYUc7SUFDSCxPQUFPLENBQUMsSUFBWSxFQUFFLE1BQTJCO1FBQy9DLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQztJQUMzQyxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7OztPQVlHO0lBQ0gsTUFBTSxDQUFDLElBQVksRUFBRSxNQUEyQjtRQUM5QyxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsUUFBUSxHQUFHLEtBQUssR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksR0FBRyxHQUFHLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDO0lBQ2xHLENBQUM7Q0FDRiJ9

package/dist/esm/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>);
+}