@eggjs/koa 2.17.0 → 2.18.0

package/Readme.md

@@ -1,6 +1,6 @@
 # @eggjs/koa
 
-@eggjs/koa is forked from [Koa v2.x](https://github.com/koajs/koa/tree/v2.x) for LTS and drop Node.js < 16.13.0 support.
+@eggjs/koa is forked from [Koa v2.x](https://github.com/koajs/koa/tree/v2.x) for LTS and drop Node.js < 18.7.0 support.
 
 <img height="240px" src="/docs/logo.png" alt="Koa middleware framework for nodejs"/>
 
@@ -19,7 +19,7 @@ Koa is not bundled with any middleware.
 
 ## Installation
 
-@eggjs/koa requires __node v16.3.0__ or higher for Node.js LTS support.
+@eggjs/koa requires __node v18.7.0__ or higher for Node.js LTS support.
 
 ```bash
 npm install @eggjs/koa
@@ -28,11 +28,12 @@ npm install @eggjs/koa
 ## Hello Koa
 
 ```ts
-const Koa = require('@eggjs/koa');
-const app = new Koa();
+import { Application } from '@eggjs/koa';
+
+const app = new Application();
 
 // response
-app.use(ctx => {
+app.use((ctx) => {
   ctx.body = 'Hello Koa';
 });
 
@@ -86,7 +87,7 @@ Each middleware receives a Koa `Context` object that encapsulates an incoming
 http message and the corresponding response to that message.  `ctx` is often used
 as the parameter name for the context object.
 
-```js
+```ts
 app.use(async (ctx, next) => {
   await next();
 });
@@ -180,6 +181,6 @@ See [AUTHORS](AUTHORS).
 - [Wiki](https://github.com/koajs/koa/wiki)
 - [中文文档 v2.x](https://github.com/demopark/koa-docs-Zh-CN)
 
-# License
+## License
 
-[MIT](https://github.com/eggjs/koa/blob/master/LICENSE)
+[MIT](LICENSE)

package/{lib → dist/commonjs}/application.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="http-errors" />
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
@@ -7,15 +8,15 @@ import util from 'node:util';
 import http from 'node:http';
 import type { AsyncLocalStorage } from 'node:async_hooks';
 import type { IncomingMessage, ServerResponse } from 'node:http';
-import Context from './context';
-import Request from './request';
-import Response from './response';
-import type { ContextDelegation } from './context';
-import type { CustomError, ProtoImplClass, AnyProto } from './types';
+import Context from './context.js';
+import Request from './request.js';
+import Response from './response.js';
+import type { ContextDelegation } from './context.js';
+import type { CustomError, AnyProto } from './types.js';
+export type ProtoImplClass<T = object> = new (...args: any[]) => T;
 export type Next = () => Promise<void>;
 export type MiddlewareFunc = (ctx: ContextDelegation, next: Next) => Promise<void> | void;
-export type { ContextDelegation as Context } from './context';
-export type { CustomError, ProtoImplClass } from './types';
+export type { ContextDelegation as Context } from './context.js';
 /**
  * Expose `Application` class.
  * Inherits from `Emitter.prototype`.
@@ -26,7 +27,7 @@ export default 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: any;
+    static HttpError: import("http-errors").HttpErrorConstructor<number>;
     proxy: boolean;
     subdomainOffset: number;
     proxyIpHeader: string;
@@ -71,12 +72,24 @@ export default class Application extends Emitter {
      * Return JSON representation.
      * We only bother showing settings.
      */
-    toJSON(): any;
+    toJSON(): {
+        subdomainOffset: number;
+        proxy: boolean;
+        env: string;
+    };
     /**
      * Inspect implementation.
      */
-    inspect(): any;
-    [util.inspect.custom](): any;
+    inspect(): {
+        subdomainOffset: number;
+        proxy: boolean;
+        env: string;
+    };
+    [util.inspect.custom](): {
+        subdomainOffset: number;
+        proxy: boolean;
+        env: string;
+    };
     /**
      * Use the given middleware `fn`.
      *
@@ -89,7 +102,7 @@ export default class Application extends Emitter {
      */
     callback(): (req: IncomingMessage, res: ServerResponse) => Promise<void | http.ServerResponse<http.IncomingMessage>>;
     /**
-     * return currnect contenxt from async local storage
+     * return current context from async local storage
      */
     get currentContext(): ContextDelegation | undefined;
     /**
@@ -102,7 +115,6 @@ export default class Application extends Emitter {
      * @private
      */
     protected onerror(err: CustomError): void;
-    createAsyncCtxStorageMiddleware(): (ctx: ContextDelegation, next: Next) => Promise<void>;
     /**
      * Response helper.
      */

package/dist/commonjs/application.js

@@ -0,0 +1,255 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_util_1 = require("node:util");
+const node_events_1 = __importDefault(require("node:events"));
+const node_util_2 = __importDefault(require("node:util"));
+const node_stream_1 = __importDefault(require("node:stream"));
+const node_http_1 = __importDefault(require("node:http"));
+const gals_1 = require("gals");
+const is_type_of_1 = require("is-type-of");
+const on_finished_1 = __importDefault(require("on-finished"));
+const statuses_1 = __importDefault(require("statuses"));
+const koa_compose_1 = __importDefault(require("koa-compose"));
+const http_errors_1 = require("http-errors");
+const context_js_1 = __importDefault(require("./context.js"));
+const request_js_1 = __importDefault(require("./request.js"));
+const response_js_1 = __importDefault(require("./response.js"));
+const debug = (0, node_util_1.debuglog)('koa:application');
+/**
+ * Expose `Application` class.
+ * Inherits from `Emitter.prototype`.
+ */
+class Application extends node_events_1.default {
+    /**
+     * Make HttpError available to consumers of the library so that consumers don't
+     * have a direct dependency upon `http-errors`
+     */
+    static HttpError = http_errors_1.HttpError;
+    proxy;
+    subdomainOffset;
+    proxyIpHeader;
+    maxIpsCount;
+    env;
+    keys;
+    middleware;
+    ctxStorage;
+    silent;
+    ContextClass;
+    context;
+    RequestClass;
+    request;
+    ResponseClass;
+    response;
+    /**
+     * Initialize a new `Application`.
+      *
+      * @param {object} [options] Application options
+      * @param {string} [options.env='development'] Environment
+      * @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 = (0, gals_1.getAsyncLocalStorage)();
+        this.silent = false;
+        this.ContextClass = class ApplicationContext extends context_js_1.default {
+        };
+        this.context = this.ContextClass.prototype;
+        this.RequestClass = class ApplicationRequest extends request_js_1.default {
+        };
+        this.request = this.RequestClass.prototype;
+        this.ResponseClass = class ApplicationResponse extends response_js_1.default {
+        };
+        this.response = this.ResponseClass.prototype;
+    }
+    /**
+     * Shorthand for:
+     *
+     *    http.createServer(app.callback()).listen(...)
+     */
+    listen(...args) {
+        debug('listen');
+        const server = node_http_1.default.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();
+    }
+    [node_util_2.default.inspect.custom]() {
+        return this.inspect();
+    }
+    /**
+     * Use the given middleware `fn`.
+     *
+     * Old-style middleware will be converted.
+     */
+    use(fn) {
+        if (typeof fn !== 'function')
+            throw new TypeError('middleware must be a function!');
+        if ((0, is_type_of_1.isGeneratorFunction)(fn)) {
+            throw new TypeError('Support for generators was removed. ' +
+                'See the documentation for examples of how to convert old middleware ' +
+                'https://github.com/koajs/koa/blob/master/docs/migration.md');
+        }
+        debug('use %s #%d', fn._name || fn.name || '-', this.middleware.length);
+        this.middleware.push(fn);
+        return this;
+    }
+    /**
+     * Return a request handler callback
+     * for node's native http server.
+     */
+    callback() {
+        const fn = (0, koa_compose_1.default)(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) {
+        const res = ctx.res;
+        res.statusCode = 404;
+        const onerror = (err) => ctx.onerror(err);
+        (0, on_finished_1.default)(res, onerror);
+        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(node_util_2.default.format('non-error thrown: %j', err));
+        if (err.status === 404 || err.expose)
+            return;
+        if (this.silent)
+            return;
+        const msg = err.stack || err.toString();
+        console.error(`\n${msg.replace(/^/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_1.default.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) {
+            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 node_stream_1.default)
+            return body.pipe(res);
+        // body: json
+        body = JSON.stringify(body);
+        if (!res.headersSent) {
+            ctx.length = Buffer.byteLength(body);
+        }
+        res.end(body);
+    }
+}
+exports.default = Application;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"application.js","sourceRoot":"","sources":["../../src/application.ts"],"names":[],"mappings":";;;;;AAAA,yCAAqC;AACrC,8DAAkC;AAClC,0DAA6B;AAC7B,8DAAiC;AACjC,0DAA6B;AAG7B,+BAA4C;AAC5C,2CAAiD;AACjD,8DAAqC;AACrC,wDAAgC;AAChC,8DAAkC;AAClC,6CAAwC;AACxC,8DAAmC;AACnC,8DAAmC;AACnC,gEAAqC;AAIrC,MAAM,KAAK,GAAG,IAAA,oBAAQ,EAAC,iBAAiB,CAAC,CAAC;AAO1C;;;GAGG;AACH,MAAqB,WAAY,SAAQ,qBAAO;IAC9C;;;OAGG;IACH,MAAM,CAAC,SAAS,GAAG,uBAAS,CAAC;IAE7B,KAAK,CAAU;IACf,eAAe,CAAS;IACxB,aAAa,CAAS;IACtB,WAAW,CAAS;IACpB,GAAG,CAAS;IACZ,IAAI,CAAY;IAChB,UAAU,CAAmB;IAC7B,UAAU,CAAuC;IACjD,MAAM,CAAU;IAChB,YAAY,CAA0B;IACtC,OAAO,CAAW;IAClB,YAAY,CAA0B;IACtC,OAAO,CAAW;IAClB,aAAa,CAA2B;IACxC,QAAQ,CAAW;IAEnB;;;;;;;;;;QAUI;IAEJ,YAAY,OAOX;QACC,KAAK,EAAE,CAAC;QACR,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;QACpC,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,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAC;QAChE,IAAI,OAAO,CAAC,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAA,2BAAoB,GAAE,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,MAAM,kBAAmB,SAAQ,oBAAO;SAAG,CAAC;QAChE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,MAAM,kBAAmB,SAAQ,oBAAO;SAAG,CAAC;QAChE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;QAC3C,IAAI,CAAC,aAAa,GAAG,MAAM,mBAAoB,SAAQ,qBAAQ;SAAG,CAAC;QACnE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,GAAG,IAAW;QACnB,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChB,MAAM,MAAM,GAAG,mBAAI,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,mBAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACnB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,EAAkB;QACpB,IAAI,OAAO,EAAE,KAAK,UAAU;YAAE,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;QACpF,IAAI,IAAA,gCAAmB,EAAC,EAAE,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,SAAS,CAAC,sCAAsC;gBACxD,sEAAsE;gBACtE,4DAA4D,CAAC,CAAC;QAClE,CAAC;QACD,KAAK,CAAC,YAAY,EAAG,EAAU,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,IAAI,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACjF,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,MAAM,EAAE,GAAG,IAAA,qBAAO,EAAC,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,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC5C,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;IACH,KAAK,CAAC,cAAc,CAAC,GAAsB,EAAE,YAAuD;QAClG,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACpB,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;QACrB,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAA,qBAAU,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzB,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,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,GAAoB,EAAE,GAAmB;QAC/D,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,OAAO,OAA4B,CAAC;IACtC,CAAC;IAED;;;OAGG;IACO,OAAO,CAAC,GAAgB;QAChC,qFAAqF;QACrF,+CAA+C;QAC/C,0FAA0F;QAC1F,MAAM,aAAa,GAAG,GAAG,YAAY,KAAK;YACxC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,gBAAgB,CAAC;QAC3D,IAAI,CAAC,aAAa;YAAE,MAAM,IAAI,SAAS,CAAC,mBAAI,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,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,GAAsB;QACvC,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,kBAAQ,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,IAAI,IAAI,EAAE,CAAC;YACjB,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,qBAAM;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;;AApPH,8BAqPC"}

package/{lib → dist/commonjs}/context.d.ts

@@ -3,10 +3,10 @@
 import util from 'node:util';
 import type { IncomingMessage, ServerResponse } from 'node:http';
 import Cookies from 'cookies';
-import type Application from './application';
-import type Request from './request';
-import type Response from './response';
-import type { CustomError, AnyProto } from './types';
+import type Application from './application.js';
+import type Request from './request.js';
+import type Response from './response.js';
+import type { CustomError, AnyProto } from './types.js';
 export default class Context {
     #private;
     app: Application;
@@ -23,9 +23,21 @@ export default class Context {
      * just returns the JSON output.
      */
     inspect(): {
-        request: any;
-        response: any;
-        app: any;
+        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;
@@ -35,9 +47,21 @@ export default class Context {
      * Custom inspection implementation for newer Node.js versions.
      */
     [util.inspect.custom](): {
-        request: any;
-        response: any;
-        app: any;
+        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;
@@ -52,9 +76,21 @@ export default class Context {
      * clone() to fail.
      */
     toJSON(): {
-        request: any;
-        response: any;
-        app: any;
+        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;
@@ -66,13 +102,12 @@ export default class Context {
      *    this.assert(this.user, 401, 'Please login!');
      *
      * See: https://github.com/jshttp/http-assert
-     *
-     * @param {Mixed} test
+     * @param {Mixed} value
      * @param {Number} status
-     * @param {String} message
-     * @public
+     * @param {String} opts
      */
-    assert(...args: any[]): any;
+    assert(value: any, status?: number, opts?: Record<string, any>): void;
+    assert(value: any, status?: number, msg?: string, opts?: Record<string, any>): void;
     /**
      * Throw an error with `status` (default 500) and
      * `msg`. Note that these are user-level
@@ -83,16 +118,31 @@ export default class Context {
      *    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} err, msg or status
-     * @param {String|Number|Error} [err, msg or status]
-     * @param {Object} [props]
+     * @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(...args: any[]): void;
+    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