@eggjs/koa 3.1.0-beta.20 → 3.1.0-beta.21

package/dist/application.d.ts

@@ -0,0 +1,127 @@
+import util from 'node:util';
+import Emitter from 'node:events';
+import type { AsyncLocalStorage } from 'node:async_hooks';
+import http, { type IncomingMessage, type ServerResponse } from 'node:http';
+import { Context } from './context.ts';
+import { Request } from './request.ts';
+import { Response } from './response.ts';
+import type { CustomError, AnyProto } from './types.ts';
+export type ProtoImplClass<T = object> = new (...args: any[]) => T;
+export type Next = () => Promise<void>;
+type _MiddlewareFunc<T> = (ctx: T, next: Next) => Promise<void> | void;
+export type MiddlewareFunc<T extends Context = Context> = _MiddlewareFunc<T> & {
+    _name?: string;
+};
+/**
+ * Expose `Application` class.
+ * Inherits from `Emitter.prototype`.
+ */
+export declare class Application extends Emitter {
+    [key: symbol]: unknown;
+    /**
+     * Make HttpError available to consumers of the library so that consumers don't
+     * have a direct dependency upon `http-errors`
+     */
+    static HttpError: import("http-errors").HttpErrorConstructor<number>;
+    protected _proxy: boolean;
+    protected _env: string;
+    subdomainOffset: number;
+    proxyIpHeader: string;
+    maxIpsCount: number;
+    protected _keys?: string[];
+    middleware: MiddlewareFunc<Context>[];
+    ctxStorage: AsyncLocalStorage<Context>;
+    silent: boolean;
+    ContextClass: ProtoImplClass<Context>;
+    context: AnyProto;
+    RequestClass: ProtoImplClass<Request>;
+    request: AnyProto;
+    ResponseClass: ProtoImplClass<Response>;
+    response: AnyProto;
+    /**
+     * Initialize a new `Application`.
+     *
+     * @param {object} [options] Application options
+     * @param {string} [options.env] Environment, default is `development`
+     * @param {string[]} [options.keys] Signed cookie keys
+     * @param {boolean} [options.proxy] Trust proxy headers
+     * @param {number} [options.subdomainOffset] Subdomain offset
+     * @param {string} [options.proxyIpHeader] Proxy IP header, defaults to X-Forwarded-For
+     * @param {number} [options.maxIpsCount] Max IPs read from proxy IP header, default to 0 (means infinity)
+     */
+    constructor(options?: {
+        proxy?: boolean;
+        subdomainOffset?: number;
+        proxyIpHeader?: string;
+        maxIpsCount?: number;
+        env?: string;
+        keys?: string[];
+    });
+    get keys(): string[] | undefined;
+    set keys(value: string[] | undefined);
+    get env(): string;
+    set env(value: string);
+    get proxy(): boolean;
+    set proxy(value: boolean);
+    /**
+     * Shorthand for:
+     *
+     *    http.createServer(app.callback()).listen(...)
+     */
+    listen(...args: any[]): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    /**
+     * Return JSON representation.
+     * We only bother showing settings.
+     */
+    toJSON(): {
+        subdomainOffset: number;
+        proxy: boolean;
+        env: string;
+    };
+    /**
+     * Inspect implementation.
+     */
+    inspect(): {
+        subdomainOffset: number;
+        proxy: boolean;
+        env: string;
+    };
+    [util.inspect.custom](): {
+        subdomainOffset: number;
+        proxy: boolean;
+        env: string;
+    };
+    /**
+     * Use the given middleware `fn`.
+     */
+    use<T extends Context = Context>(fn: MiddlewareFunc<T>): this;
+    /**
+     * Return a request handler callback
+     * for node's native http server.
+     */
+    callback(): (req: IncomingMessage, res: ServerResponse) => Promise<void | http.ServerResponse<http.IncomingMessage>>;
+    /**
+     * return current context from async local storage
+     */
+    get currentContext(): Context | undefined;
+    /**
+     * Handle request in callback.
+     * @private
+     */
+    protected handleRequest(ctx: Context, fnMiddleware: (ctx: Context) => Promise<void>): Promise<void | http.ServerResponse<http.IncomingMessage>>;
+    /**
+     * Initialize a new context.
+     * @private
+     */
+    createContext(req: IncomingMessage, res: ServerResponse): Context;
+    /**
+     * Default error handler.
+     * @private
+     */
+    protected onerror(err: CustomError): void;
+    /**
+     * Response helper.
+     */
+    protected _respond(ctx: Context): http.ServerResponse<http.IncomingMessage> | undefined;
+}
+export {};

package/dist/application.js

@@ -0,0 +1,274 @@
+import util, { debuglog } from 'node:util';
+import Emitter from 'node:events';
+import Stream from 'node:stream';
+import http, {} from 'node:http';
+import { getAsyncLocalStorage } from 'gals';
+import { isGeneratorFunction } from 'is-type-of';
+import onFinished from 'on-finished';
+import statuses from 'statuses';
+import compose from 'koa-compose';
+import { HttpError } from 'http-errors';
+import { Context } from "./context.js";
+import { Request } from "./request.js";
+import { Response } from "./response.js";
+const debug = debuglog('egg/koa/application');
+/**
+ * Expose `Application` class.
+ * Inherits from `Emitter.prototype`.
+ */
+export class Application extends Emitter {
+    /**
+     * Make HttpError available to consumers of the library so that consumers don't
+     * have a direct dependency upon `http-errors`
+     */
+    static HttpError = HttpError;
+    _proxy;
+    _env;
+    subdomainOffset;
+    proxyIpHeader;
+    maxIpsCount;
+    _keys;
+    middleware;
+    ctxStorage;
+    silent;
+    ContextClass;
+    context;
+    RequestClass;
+    request;
+    ResponseClass;
+    response;
+    /**
+     * Initialize a new `Application`.
+     *
+     * @param {object} [options] Application options
+     * @param {string} [options.env] Environment, default is `development`
+     * @param {string[]} [options.keys] Signed cookie keys
+     * @param {boolean} [options.proxy] Trust proxy headers
+     * @param {number} [options.subdomainOffset] Subdomain offset
+     * @param {string} [options.proxyIpHeader] Proxy IP header, defaults to X-Forwarded-For
+     * @param {number} [options.maxIpsCount] Max IPs read from proxy IP header, default to 0 (means infinity)
+     */
+    constructor(options) {
+        super();
+        options = options || {};
+        this._proxy = options.proxy || false;
+        this.subdomainOffset = options.subdomainOffset || 2;
+        this.proxyIpHeader = options.proxyIpHeader || 'X-Forwarded-For';
+        this.maxIpsCount = options.maxIpsCount || 0;
+        this._env = options.env || process.env.NODE_ENV || 'development';
+        if (options.keys) {
+            this._keys = options.keys;
+        }
+        this.middleware = [];
+        this.ctxStorage = getAsyncLocalStorage();
+        this.silent = false;
+        this.ContextClass = class ApplicationContext extends Context {
+        };
+        this.context = this.ContextClass.prototype;
+        this.RequestClass = class ApplicationRequest extends Request {
+        };
+        this.request = this.RequestClass.prototype;
+        this.ResponseClass = class ApplicationResponse extends Response {
+        };
+        this.response = this.ResponseClass.prototype;
+    }
+    get keys() {
+        return this._keys;
+    }
+    set keys(value) {
+        this._keys = value;
+    }
+    get env() {
+        return this._env;
+    }
+    set env(value) {
+        this._env = value;
+    }
+    get proxy() {
+        return this._proxy;
+    }
+    set proxy(value) {
+        this._proxy = value;
+    }
+    /**
+     * Shorthand for:
+     *
+     *    http.createServer(app.callback()).listen(...)
+     */
+    // oxlint-disable-next-line typescript/no-explicit-any
+    listen(...args) {
+        debug('listen with args: %o', args);
+        const server = http.createServer(this.callback());
+        return server.listen(...args);
+    }
+    /**
+     * Return JSON representation.
+     * We only bother showing settings.
+     */
+    toJSON() {
+        return {
+            subdomainOffset: this.subdomainOffset,
+            proxy: this.proxy,
+            env: this.env,
+        };
+    }
+    /**
+     * Inspect implementation.
+     */
+    inspect() {
+        return this.toJSON();
+    }
+    [util.inspect.custom]() {
+        return this.inspect();
+    }
+    /**
+     * Use the given middleware `fn`.
+     */
+    use(fn) {
+        if (typeof fn !== 'function')
+            throw new TypeError('middleware must be a function!');
+        const name = fn._name || fn.name || '-';
+        if (isGeneratorFunction(fn)) {
+            throw new TypeError(`Support for generators was removed, middleware: ${name}. ` +
+                'See the documentation for examples of how to convert old middleware ' +
+                'https://github.com/koajs/koa/blob/master/docs/migration.md');
+        }
+        debug('use %o #%d', name, this.middleware.length);
+        this.middleware.push(fn);
+        return this;
+    }
+    /**
+     * Return a request handler callback
+     * for node's native http server.
+     */
+    callback() {
+        const fn = compose(this.middleware);
+        if (!this.listenerCount('error')) {
+            this.on('error', this.onerror.bind(this));
+        }
+        const handleRequest = (req, res) => {
+            const ctx = this.createContext(req, res);
+            return this.ctxStorage.run(ctx, async () => {
+                return await this.handleRequest(ctx, fn);
+            });
+        };
+        return handleRequest;
+    }
+    /**
+     * return current context from async local storage
+     */
+    get currentContext() {
+        return this.ctxStorage.getStore();
+    }
+    /**
+     * Handle request in callback.
+     * @private
+     */
+    async handleRequest(ctx, fnMiddleware) {
+        this.emit('request', ctx);
+        const res = ctx.res;
+        res.statusCode = 404;
+        const onerror = (err) => ctx.onerror(err);
+        // oxlint-disable-next-line promise/prefer-await-to-callbacks
+        onFinished(res, (err) => {
+            if (err) {
+                onerror(err);
+            }
+            this.emit('response', ctx);
+        });
+        try {
+            await fnMiddleware(ctx);
+            return this._respond(ctx);
+        }
+        catch (err) {
+            return onerror(err);
+        }
+    }
+    /**
+     * Initialize a new context.
+     * @private
+     */
+    createContext(req, res) {
+        const context = new this.ContextClass(this, req, res);
+        return context;
+    }
+    /**
+     * Default error handler.
+     * @private
+     */
+    onerror(err) {
+        // When dealing with cross-globals a normal `instanceof` check doesn't work properly.
+        // See https://github.com/koajs/koa/issues/1466
+        // We can probably remove it once jest fixes https://github.com/facebook/jest/issues/2549.
+        const isNativeError = err instanceof Error || Object.prototype.toString.call(err) === '[object Error]';
+        if (!isNativeError)
+            throw new TypeError(util.format('non-error thrown: %j', err));
+        if (err.status === 404 || err.expose)
+            return;
+        if (this.silent)
+            return;
+        const msg = err.stack || err.toString();
+        // oxlint-disable-next-line no-console
+        console.error(`\n${msg.replaceAll(/^/gm, '  ')}\n`);
+    }
+    /**
+     * Response helper.
+     */
+    _respond(ctx) {
+        // allow bypassing koa
+        if (ctx.respond === false)
+            return;
+        if (!ctx.writable)
+            return;
+        const res = ctx.res;
+        let body = ctx.body;
+        const code = ctx.status;
+        // ignore body
+        if (statuses.empty[code]) {
+            // strip headers
+            ctx.body = null;
+            return res.end();
+        }
+        if (ctx.method === 'HEAD') {
+            if (!res.headersSent && !ctx.response.has('Content-Length')) {
+                const { length } = ctx.response;
+                if (Number.isInteger(length))
+                    ctx.length = length;
+            }
+            return res.end();
+        }
+        // status body
+        if (body === null || body === undefined) {
+            if (ctx.response._explicitNullBody) {
+                ctx.response.remove('Content-Type');
+                ctx.response.remove('Transfer-Encoding');
+                return res.end();
+            }
+            if (ctx.req.httpVersionMajor >= 2) {
+                body = String(code);
+            }
+            else {
+                body = ctx.message || String(code);
+            }
+            if (!res.headersSent) {
+                ctx.type = 'text';
+                ctx.length = Buffer.byteLength(body);
+            }
+            return res.end(body);
+        }
+        // responses
+        if (Buffer.isBuffer(body))
+            return res.end(body);
+        if (typeof body === 'string')
+            return res.end(body);
+        if (body instanceof Stream)
+            return body.pipe(res);
+        // body: json
+        body = JSON.stringify(body);
+        if (!res.headersSent) {
+            ctx.length = Buffer.byteLength(body);
+        }
+        res.end(body);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"application.js","sourceRoot":"","sources":["../src/application.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,OAAO,MAAM,aAAa,CAAC;AAClC,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,OAAO,IAAI,EAAE,EAA6C,MAAM,WAAW,CAAC;AAE5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,MAAM,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,OAAO,MAAM,aAAa,CAAC;AAElC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC,MAAM,KAAK,GAAG,QAAQ,CAAC,qBAAqB,CAAC,CAAC;AAU9C;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,OAAO;IAEtC;;;OAGG;IACH,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;IAEnB,MAAM,CAAU;IAChB,IAAI,CAAS;IACvB,eAAe,CAAS;IACxB,aAAa,CAAS;IACtB,WAAW,CAAS;IACV,KAAK,CAAY;IAC3B,UAAU,CAA4B;IACtC,UAAU,CAA6B;IACvC,MAAM,CAAU;IAChB,YAAY,CAA0B;IACtC,OAAO,CAAW;IAClB,YAAY,CAA0B;IACtC,OAAO,CAAW;IAClB,aAAa,CAA2B;IACxC,QAAQ,CAAW;IAEnB;;;;;;;;;;OAUG;IAEH,YAAY,OAOX;QACC,KAAK,EAAE,CAAC;QACR,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,iBAAiB,CAAC;QAChE,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAC;QACjE,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,oBAAoB,EAAE,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,MAAM,kBAAmB,SAAQ,OAAO;SAA8B,CAAC;QAC3F,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,MAAM,kBAAmB,SAAQ,OAAO;SAA8B,CAAC;QAC3F,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;QAC3C,IAAI,CAAC,aAAa,GAAG,MAAM,mBAAoB,SAAQ,QAAQ;SAA+B,CAAC;QAC/F,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;IAC/C,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,IAAI,CAAC,KAA2B;QAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,IAAI,GAAG,CAAC,KAAa;QACnB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAI,KAAK,CAAC,KAAc;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,sDAAsD;IACtD,MAAM,CAAC,GAAG,IAAW;QACnB,KAAK,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAClD,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,GAAG,EAAE,IAAI,CAAC,GAAG;SACd,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;IAED,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACnB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,GAAG,CAA8B,EAAqB;QACpD,IAAI,OAAO,EAAE,KAAK,UAAU;YAAE,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;QACpF,MAAM,IAAI,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC;QACxC,IAAI,mBAAmB,CAAC,EAAE,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,SAAS,CACjB,mDAAmD,IAAI,IAAI;gBACzD,sEAAsE;gBACtE,4DAA4D,CAC/D,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAA6B,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,aAAa,GAAG,CAAC,GAAoB,EAAE,GAAmB,EAAE,EAAE;YAClE,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE;gBACzC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,GAAY,EAAE,YAA6C;QACvF,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAC1B,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACpB,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;QACrB,MAAM,OAAO,GAAG,CAAC,GAAgB,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvD,6DAA6D;QAC7D,UAAU,CAAC,GAAG,EAAE,CAAC,GAAuB,EAAE,EAAE;YAC1C,IAAI,GAAG,EAAE,CAAC;gBACR,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;YACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC5B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,OAAO,CAAC,GAAkB,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,GAAoB,EAAE,GAAmB;QACrD,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACO,OAAO,CAAC,GAAgB;QAChC,qFAAqF;QACrF,+CAA+C;QAC/C,0FAA0F;QAC1F,MAAM,aAAa,GAAG,GAAG,YAAY,KAAK,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,gBAAgB,CAAC;QACvG,IAAI,CAAC,aAAa;YAAE,MAAM,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC,CAAC;QAElF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM;YAAE,OAAO;QAC7C,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QAExB,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACxC,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,GAAY;QAC7B,sBAAsB;QACtB,IAAI,GAAG,CAAC,OAAO,KAAK,KAAK;YAAE,OAAO;QAElC,IAAI,CAAC,GAAG,CAAC,QAAQ;YAAE,OAAO;QAE1B,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACpB,IAAI,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACpB,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC;QAExB,cAAc;QACd,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,gBAAgB;YAChB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;YAChB,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;QAED,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC5D,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC;gBAChC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;oBAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;YACpD,CAAC;YACD,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;QAED,cAAc;QACd,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxC,IAAI,GAAG,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;gBACnC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;gBACpC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;gBACzC,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC;YACnB,CAAC;YACD,IAAI,GAAG,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,GAAG,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;gBACrB,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC;gBAClB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACvC,CAAC;YACD,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QAED,YAAY;QACZ,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,IAAI,YAAY,MAAM;YAAE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAElD,aAAa;QACb,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;YACrB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QACD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC"}

package/dist/context.d.ts

@@ -0,0 +1,225 @@
+import util from 'node:util';
+import type { IncomingMessage, ServerResponse } from 'node:http';
+import type { ParsedUrlQuery } from 'node:querystring';
+import Cookies from 'cookies';
+import type { Accepts } from 'accepts';
+import type { Application } from './application.ts';
+import type { Request } from './request.ts';
+import type { Response } from './response.ts';
+import type { CustomError, AnyProto } from './types.ts';
+export declare class Context {
+    #private;
+    [key: symbol | string]: unknown;
+    app: Application;
+    req: IncomingMessage;
+    res: ServerResponse;
+    request: Request & AnyProto;
+    response: Response & AnyProto;
+    originalUrl: string;
+    respond?: boolean;
+    constructor(app: Application, req: IncomingMessage, res: ServerResponse);
+    /**
+     * util.inspect() implementation, which
+     * just returns the JSON output.
+     */
+    inspect(): {
+        request: {
+            method: string;
+            url: string;
+            header: import("http").IncomingHttpHeaders;
+        };
+        response: {
+            status: number;
+            message: string;
+            header: import("http").OutgoingHttpHeaders;
+        };
+        app: {
+            subdomainOffset: number;
+            proxy: boolean;
+            env: string;
+        };
+        originalUrl: string;
+        req: string;
+        res: string;
+        socket: string;
+    };
+    /**
+     * Custom inspection implementation for newer Node.js versions.
+     */
+    [util.inspect.custom](): {
+        request: {
+            method: string;
+            url: string;
+            header: import("http").IncomingHttpHeaders;
+        };
+        response: {
+            status: number;
+            message: string;
+            header: import("http").OutgoingHttpHeaders;
+        };
+        app: {
+            subdomainOffset: number;
+            proxy: boolean;
+            env: string;
+        };
+        originalUrl: string;
+        req: string;
+        res: string;
+        socket: string;
+    };
+    /**
+     * Return JSON representation.
+     *
+     * Here we explicitly invoke .toJSON() on each
+     * object, as iteration will otherwise fail due
+     * to the getters and cause utilities such as
+     * clone() to fail.
+     */
+    toJSON(): {
+        request: {
+            method: string;
+            url: string;
+            header: import("http").IncomingHttpHeaders;
+        };
+        response: {
+            status: number;
+            message: string;
+            header: import("http").OutgoingHttpHeaders;
+        };
+        app: {
+            subdomainOffset: number;
+            proxy: boolean;
+            env: string;
+        };
+        originalUrl: string;
+        req: string;
+        res: string;
+        socket: string;
+    };
+    /**
+     * Similar to .throw(), adds assertion.
+     *
+     * ```ts
+     * this.assert(this.user, 401, 'Please login!');
+     * ```
+     */
+    assert(value: unknown, status?: number, errorProps?: Record<string, unknown>): void;
+    assert(value: unknown, status?: number, errorMessage?: string, errorProps?: Record<string, unknown>): void;
+    /**
+     * Throw an error with `status` (default 500) and
+     * `msg`. Note that these are user-level
+     * errors, and the message may be exposed to the client.
+     *
+     *    this.throw(403)
+     *    this.throw(400, 'name required')
+     *    this.throw('something exploded')
+     *    this.throw(new Error('invalid'))
+     *    this.throw(400, new Error('invalid'))
+     *    this.throw(400, new Error('invalid'), { foo: 'bar' })
+     *    this.throw(new Error('invalid'), { foo: 'bar' })
+     *
+     * See: https://github.com/jshttp/http-errors
+     *
+     * Note: `status` should only be passed as the first parameter.
+     *
+     * @param {String|Number|Error} status error, msg or status
+     * @param {String|Number|Error|Object} [error] error, msg, status or errorProps
+     * @param {Object} [errorProps] error object properties
+     */
+    throw(status: number): void;
+    throw(status: number, errorProps: object): void;
+    throw(status: number, errorMessage: string): void;
+    throw(status: number, errorMessage: string, errorProps: object): void;
+    throw(status: number, error: Error): void;
+    throw(status: number, error: Error, errorProps: object): void;
+    throw(errorMessage: string): void;
+    throw(errorMessage: string, errorProps: object): void;
+    throw(errorMessage: string, status: number): void;
+    throw(errorMessage: string, status: number, errorProps: object): void;
+    throw(error: Error): void;
+    throw(error: Error, errorProps: object): void;
+    throw(error: Error, status: number): void;
+    throw(error: Error, status: number, errorProps: object): void;
+    /**
+     * Default error handling.
+     * @private
+     */
+    onerror(err: CustomError): void;
+    protected _cookies: Cookies | undefined;
+    get cookies(): Cookies;
+    set cookies(cookies: Cookies);
+    get state(): Record<string, any>;
+    /**
+     * Request delegation.
+     */
+    acceptsLanguages(): string[];
+    acceptsLanguages(languages: string[]): string | false;
+    acceptsLanguages(...languages: string[]): string | false;
+    acceptsEncodings(): string[];
+    acceptsEncodings(encodings: string[]): string | false;
+    acceptsEncodings(...encodings: string[]): string | false;
+    acceptsCharsets(): string[];
+    acceptsCharsets(charsets: string[]): string | false;
+    acceptsCharsets(...charsets: string[]): string | false;
+    accepts(args: string[]): string | string[] | false;
+    accepts(...args: string[]): string | string[] | false;
+    get<T = string | string[]>(field: string): T;
+    is(type?: string | string[], ...types: string[]): string | false | null;
+    get querystring(): string;
+    set querystring(str: string);
+    get idempotent(): boolean;
+    get socket(): import("./request.ts").RequestSocket;
+    get search(): string;
+    set search(str: string);
+    get method(): string;
+    set method(method: string);
+    get query(): ParsedUrlQuery;
+    set query(obj: ParsedUrlQuery);
+    get path(): string;
+    set path(path: string);
+    get url(): string;
+    set url(url: string);
+    get accept(): Accepts;
+    set accept(accept: Accepts);
+    get origin(): string;
+    get href(): string;
+    get subdomains(): string[];
+    get protocol(): string;
+    get host(): string;
+    get hostname(): string;
+    get URL(): URL;
+    get header(): import("http").IncomingHttpHeaders;
+    get headers(): import("http").IncomingHttpHeaders;
+    get secure(): boolean;
+    get stale(): boolean;
+    get fresh(): boolean;
+    get ips(): string[];
+    get ip(): string;
+    /**
+     * Response delegation.
+     */
+    attachment(...args: Parameters<Response['attachment']>): void;
+    redirect(...args: Parameters<Response['redirect']>): void;
+    remove(...args: Parameters<Response['remove']>): void;
+    vary(...args: Parameters<Response['vary']>): void;
+    has(...args: Parameters<Response['has']>): boolean;
+    set(...args: Parameters<Response['set']>): void;
+    append(...args: Parameters<Response['append']>): void;
+    flushHeaders(...args: Parameters<Response['flushHeaders']>): void;
+    get status(): number;
+    set status(status: number);
+    get message(): string;
+    set message(msg: string);
+    get body(): any;
+    set body(val: any);
+    get length(): number | undefined;
+    set length(n: number | string | undefined);
+    get type(): string;
+    set type(type: string | null | undefined);
+    get lastModified(): string | Date | undefined;
+    set lastModified(val: string | Date | undefined);
+    get etag(): string;
+    set etag(val: string);
+    get headerSent(): boolean;
+    get writable(): boolean;
+}