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

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@eggjs/koa",
-  "version": "3.1.0-beta.2",
+  "version": "3.1.0-beta.20",
   "engines": {
-    "node": ">= 20.19.0"
+    "node": ">=22.18.0"
   },
   "publishConfig": {
     "access": "public"
@@ -24,6 +24,7 @@
     "url": "git://github.com/eggjs/egg.git",
     "directory": "packages/koa"
   },
+  "homepage": "https://github.com/eggjs/egg/tree/next/packages/koa",
   "keywords": [
     "web",
     "app",
@@ -42,7 +43,7 @@
     "content-type": "^1.0.5",
     "cookies": "^0.9.1",
     "destroy": "^1.0.4",
-    "encodeurl": "^1.0.2",
+    "encodeurl": "^2.0.0",
     "escape-html": "^1.0.3",
     "fresh": "~0.5.2",
     "gals": "1",
@@ -52,7 +53,7 @@
     "on-finished": "^2.4.1",
     "parseurl": "^1.3.3",
     "statuses": "^2.0.1",
-    "type-is": "^1.6.18",
+    "type-is": "^2.0.0",
     "vary": "^1.1.2"
   },
   "devDependencies": {
@@ -65,20 +66,20 @@
     "@types/fresh": "^0.5.2",
     "@types/http-errors": "^2.0.4",
     "@types/koa-compose": "^3.2.8",
-    "@types/node": "24",
     "@types/on-finished": "^2.3.4",
     "@types/parseurl": "^1.3.3",
     "@types/statuses": "^2.0.5",
-    "@types/supertest": "^6.0.2",
     "@types/type-is": "^1.6.6",
     "@types/vary": "^1.1.3",
     "mm": "^4.0.2",
-    "supertest": "^3.1.0",
-    "tsdown": "^0.14.2",
-    "typescript": "5"
+    "tsdown": "^0.15.4",
+    "typescript": "^5.9.3",
+    "@eggjs/supertest": "9.0.0-beta.20"
   },
   "scripts": {
     "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint --type-aware",
     "test": "vitest run"
   }
 }

package/dist/application.d.ts

@@ -1,131 +0,0 @@
-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 { AsyncLocalStorage } from "node:async_hooks";
-
-//#region src/application.d.ts
-type ProtoImplClass<T = object> = new (...args: any[]) => T;
-type Next = () => Promise<void>;
-type _MiddlewareFunc<T> = (ctx: T, next: Next) => Promise<void> | void;
-type MiddlewareFunc<T extends Context = Context> = _MiddlewareFunc<T> & {
-  _name?: string;
-};
-/**
- * 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>;
-  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;
-}
-//#endregion
-export { Application, MiddlewareFunc, Next, ProtoImplClass };

package/dist/application.js

@@ -1,233 +0,0 @@
-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 { 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";
-
-//#region src/application.ts
-const debug = debuglog("egg/koa/application");
-/**
-* Expose `Application` class.
-* Inherits from `Emitter.prototype`.
-*/
-var Application = class 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(...)
-	*/
-	listen(...args) {
-		debug("listen with args: %o", args);
-		return http.createServer(this.callback()).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);
-		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) {
-		return new this.ContextClass(this, req, res);
-	}
-	/**
-	* Default error handler.
-	* @private
-	*/
-	onerror(err) {
-		if (!(err instanceof Error || Object.prototype.toString.call(err) === "[object Error]")) 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();
-		console.error(`\n${msg.replaceAll(/^/gm, "  ")}\n`);
-	}
-	/**
-	* Response helper.
-	*/
-	_respond(ctx) {
-		if (ctx.respond === false) return;
-		if (!ctx.writable) return;
-		const res = ctx.res;
-		let body = ctx.body;
-		const code = ctx.status;
-		if (statuses.empty[code]) {
-			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();
-		}
-		if (body === null || body === void 0) {
-			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);
-		}
-		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);
-	}
-};
-
-//#endregion
-export { Application };

package/dist/context.d.ts

@@ -1,230 +0,0 @@
-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 { ParsedUrlQuery } from "node:querystring";
-import { Accepts } from "accepts";
-import * as http11 from "http";
-
-//#region src/context.d.ts
-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: 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;
-  };
-  /**
-   * 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(): {
-    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!');
-   * ```
-   */
-  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(): 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(): http11.IncomingHttpHeaders;
-  get headers(): http11.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;
-}
-//#endregion
-export { Context };