@eggjs/koa 3.1.0-beta.9 → 3.1.2-beta.0

package/dist/application.d.ts

@@ -2,10 +2,9 @@ import { Response } from "./response.js";
 import { Request } from "./request.js";
 import { AnyProto, CustomError } from "./types.js";
 import { Context } from "./context.js";
-import util from "node:util";
 import Emitter from "node:events";
 import http, { IncomingMessage, ServerResponse } from "node:http";
-import * as http_errors0 from "http-errors";
+import { HttpError } from "http-errors";
 import { AsyncLocalStorage } from "node:async_hooks";
 
 //#region src/application.d.ts
@@ -16,16 +15,16 @@ type MiddlewareFunc<T extends Context = Context> = _MiddlewareFunc<T> & {
   _name?: string;
 };
 /**
- * Expose `Application` class.
- * Inherits from `Emitter.prototype`.
- */
+* Expose `Application` class.
+* Inherits from `Emitter.prototype`.
+*/
 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: http_errors0.HttpErrorConstructor<number>;
+  * Make HttpError available to consumers of the library so that consumers don't
+  * have a direct dependency upon `http-errors`
+  */
+  static HttpError: typeof HttpError;
   protected _proxy: boolean;
   protected _env: string;
   subdomainOffset: number;
@@ -42,16 +41,16 @@ declare class Application extends Emitter {
   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)
-   */
+  * 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;
@@ -67,65 +66,52 @@ declare class Application extends Emitter {
   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>;
+  * Shorthand for:
+  *
+  *    http.createServer(app.callback()).listen(...)
+  */
+  listen(...args: any[]): http.Server;
   /**
-   * Return JSON representation.
-   * We only bother showing settings.
-   */
-  toJSON(): {
-    subdomainOffset: number;
-    proxy: boolean;
-    env: string;
-  };
+  * Return JSON representation.
+  * We only bother showing settings.
+  */
+  toJSON(): object;
   /**
-   * Inspect implementation.
-   */
-  inspect(): {
-    subdomainOffset: number;
-    proxy: boolean;
-    env: string;
-  };
-  [util.inspect.custom](): {
-    subdomainOffset: number;
-    proxy: boolean;
-    env: string;
-  };
+  * Inspect implementation.
+  */
+  inspect(): object;
   /**
-   * Use the given middleware `fn`.
-   */
+  * 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 a request handler callback
+  * for node's native http server.
+  */
+  callback(): (req: IncomingMessage, res: ServerResponse) => Promise<void>;
   /**
-   * return current context from async local storage
-   */
+  * 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>>;
+  * Handle request in callback.
+  * @private
+  */
+  protected handleRequest(ctx: Context, fnMiddleware: (ctx: Context) => Promise<void>): Promise<void>;
   /**
-   * Initialize a new context.
-   * @private
-   */
+  * Initialize a new context.
+  * @private
+  */
   createContext(req: IncomingMessage, res: ServerResponse): Context;
   /**
-   * Default error handler.
-   * @private
-   */
+  * Default error handler.
+  * @private
+  */
   protected onerror(err: CustomError): void;
   /**
-   * Response helper.
-   */
-  protected _respond(ctx: Context): http.ServerResponse<http.IncomingMessage> | undefined;
+  * Response helper.
+  */
+  protected _respond(ctx: Context): void;
 }
 //#endregion
 export { Application, MiddlewareFunc, Next, ProtoImplClass };

package/dist/application.js

@@ -1,16 +1,16 @@
 import { Context } from "./context.js";
 import { Request } from "./request.js";
 import { Response } from "./response.js";
-import util, { debuglog } from "node:util";
 import Emitter from "node:events";
-import Stream from "node:stream";
 import http from "node:http";
+import Stream from "node:stream";
+import util, { debuglog } from "node:util";
 import { getAsyncLocalStorage } from "gals";
+import { HttpError } from "http-errors";
 import { isGeneratorFunction } from "is-type-of";
+import compose from "koa-compose";
 import onFinished from "on-finished";
 import statuses from "statuses";
-import compose from "koa-compose";
-import { HttpError } from "http-errors";
 
 //#region src/application.ts
 const debug = debuglog("egg/koa/application");
@@ -68,6 +68,7 @@ var Application = class extends Emitter {
 		this.request = this.RequestClass.prototype;
 		this.ResponseClass = class ApplicationResponse extends Response {};
 		this.response = this.ResponseClass.prototype;
+		this[util.inspect.custom] = this.inspect.bind(this);
 	}
 	get keys() {
 		return this._keys;
@@ -113,9 +114,6 @@ var Application = class extends Emitter {
 	inspect() {
 		return this.toJSON();
 	}
-	[util.inspect.custom]() {
-		return this.inspect();
-	}
 	/**
 	* Use the given middleware `fn`.
 	*/
@@ -197,20 +195,23 @@ var Application = class extends Emitter {
 		const code = ctx.status;
 		if (statuses.empty[code]) {
 			ctx.body = null;
-			return res.end();
+			res.end();
+			return;
 		}
 		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();
+			res.end();
+			return;
 		}
 		if (body === null || body === void 0) {
 			if (ctx.response._explicitNullBody) {
 				ctx.response.remove("Content-Type");
 				ctx.response.remove("Transfer-Encoding");
-				return res.end();
+				res.end();
+				return;
 			}
 			if (ctx.req.httpVersionMajor >= 2) body = String(code);
 			else body = ctx.message || String(code);
@@ -218,11 +219,21 @@ var Application = class extends Emitter {
 				ctx.type = "text";
 				ctx.length = Buffer.byteLength(body);
 			}
-			return res.end(body);
+			res.end(body);
+			return;
+		}
+		if (Buffer.isBuffer(body)) {
+			res.end(body);
+			return;
+		}
+		if (typeof body === "string") {
+			res.end(body);
+			return;
+		}
+		if (body instanceof Stream) {
+			body.pipe(res);
+			return;
 		}
-		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.stringify(body);
 		if (!res.headersSent) ctx.length = Buffer.byteLength(body);
 		res.end(body);

package/dist/context.d.ts

@@ -2,12 +2,10 @@ import { Response } from "./response.js";
 import { Request, RequestSocket } from "./request.js";
 import { AnyProto, CustomError } from "./types.js";
 import { Application } from "./application.js";
-import util from "node:util";
 import { IncomingMessage, ServerResponse } from "node:http";
-import Cookies from "cookies";
+import { Cookies } from "@eggjs/cookies";
 import { ParsedUrlQuery } from "node:querystring";
 import { Accepts } from "accepts";
-import * as http11 from "http";
 
 //#region src/context.d.ts
 declare class Context {
@@ -22,113 +20,49 @@ declare class Context {
   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: http11.IncomingHttpHeaders;
-    };
-    response: {
-      status: number;
-      message: string;
-      header: http11.OutgoingHttpHeaders;
-    };
-    app: {
-      subdomainOffset: number;
-      proxy: boolean;
-      env: string;
-    };
-    originalUrl: string;
-    req: string;
-    res: string;
-    socket: string;
-  };
+  * util.inspect() implementation, which
+  * just returns the JSON output.
+  */
+  inspect(): object;
   /**
-   * Custom inspection implementation for newer Node.js versions.
-   */
-  [util.inspect.custom](): {
-    request: {
-      method: string;
-      url: string;
-      header: http11.IncomingHttpHeaders;
-    };
-    response: {
-      status: number;
-      message: string;
-      header: http11.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(): object;
   /**
-   * 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: http11.IncomingHttpHeaders;
-    };
-    response: {
-      status: number;
-      message: string;
-      header: http11.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!');
-   * ```
-   */
+  * 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 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;
@@ -144,17 +78,17 @@ declare class Context {
   throw(error: Error, status: number): void;
   throw(error: Error, status: number, errorProps: object): void;
   /**
-   * Default error handling.
-   * @private
-   */
+  * 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.
-   */
+  * Request delegation.
+  */
   acceptsLanguages(): string[];
   acceptsLanguages(languages: string[]): string | false;
   acceptsLanguages(...languages: string[]): string | false;
@@ -191,24 +125,24 @@ declare class Context {
   get host(): string;
   get hostname(): string;
   get URL(): URL;
-  get header(): http11.IncomingHttpHeaders;
-  get headers(): http11.IncomingHttpHeaders;
+  get header(): IncomingMessage["headers"];
+  get headers(): IncomingMessage["headers"];
   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;
+  * 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;

package/dist/context.js

@@ -1,7 +1,7 @@
 import util from "node:util";
-import statuses from "statuses";
 import createError from "http-errors";
-import Cookies from "cookies";
+import statuses from "statuses";
+import { Cookies } from "@eggjs/cookies";
 
 //#region src/context.ts
 var Context = class {
@@ -22,6 +22,7 @@ var Context = class {
 		this.request.response = this.response;
 		this.response.request = this.request;
 		this.originalUrl = req.url ?? "/";
+		this[util.inspect.custom] = this.inspect.bind(this);
 	}
 	/**
 	* util.inspect() implementation, which
@@ -31,12 +32,6 @@ var Context = class {
 		return this.toJSON();
 	}
 	/**
-	* Custom inspection implementation for newer Node.js versions.
-	*/
-	[util.inspect.custom]() {
-		return this.inspect();
-	}
-	/**
 	* Return JSON representation.
 	*
 	* Here we explicitly invoke .toJSON() on each
@@ -103,10 +98,7 @@ var Context = class {
 	}
 	_cookies;
 	get cookies() {
-		if (!this._cookies) this._cookies = new Cookies(this.req, this.res, {
-			keys: this.app.keys,
-			secure: this.request.secure
-		});
+		if (!this._cookies) this._cookies = new Cookies(this, this.app.keys ?? [], { secure: this.request.secure });
 		return this._cookies;
 	}
 	set cookies(cookies) {