@eggjs/koa 3.0.0 → 3.1.0-beta.2

package/dist/types.d.ts

@@ -1,11 +1,14 @@
-export type CustomError = Error & {
-    headers?: Record<string, string>;
-    status?: number;
-    statusCode?: number;
-    code?: string;
-    expose?: boolean;
-    headerSent?: boolean;
+//#region src/types.d.ts
+type CustomError = Error & {
+  headers?: Record<string, string>;
+  status?: number;
+  statusCode?: number;
+  code?: string;
+  expose?: boolean;
+  headerSent?: boolean;
 };
-export interface AnyProto {
-    [key: string | symbol]: any;
+interface AnyProto {
+  [key: string | symbol]: any;
 }
+//#endregion
+export { AnyProto, CustomError };

package/package.json

@@ -1,36 +1,28 @@
 {
   "name": "@eggjs/koa",
-  "version": "3.0.0",
+  "version": "3.1.0-beta.2",
   "engines": {
-    "node": ">= 22.17.1"
+    "node": ">= 20.19.0"
   },
   "publishConfig": {
-    "access": "public",
-    "tag": "alpha"
+    "access": "public"
   },
-  "description": "Koa web app framework for https://eggjs.org",
-  "scripts": {
-    "pretest": "npm run lint -- --fix",
-    "test": "node --test --test-force-exit --test-update-snapshots --experimental-strip-types",
-    "preci": "npm run lint",
-    "ci": "c8 -r html -r lcov -r text npm test",
-    "postci": "npm run prepublishOnly",
-    "lint": "oxlint",
-    "prepublishOnly": "npm run clean && npm run build",
-    "build": "tsc --build",
-    "clean": "tsc --build --clean",
-    "prepare": "husky"
-  },
-  "lint-staged": {
-    "*": "prettier --write --ignore-unknown --cache",
-    "*.{ts,js,json,md,yml}": [
-      "prettier --ignore-unknown --write",
-      "oxlint --fix"
-    ]
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
   },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "description": "Koa web app framework for https://eggjs.org",
   "repository": {
     "type": "git",
-    "url": "git@github.com:eggjs/koa.git"
+    "url": "git://github.com/eggjs/egg.git",
+    "directory": "packages/koa"
   },
   "keywords": [
     "web",
@@ -53,9 +45,9 @@
     "encodeurl": "^1.0.2",
     "escape-html": "^1.0.3",
     "fresh": "~0.5.2",
-    "gals": "^1.0.1",
+    "gals": "1",
     "http-errors": "^2.0.0",
-    "is-type-of": "^2.1.0",
+    "is-type-of": "^2.2.0",
     "koa-compose": "^4.1.0",
     "on-finished": "^2.4.1",
     "parseurl": "^1.3.3",
@@ -64,7 +56,6 @@
     "vary": "^1.1.2"
   },
   "devDependencies": {
-    "@eggjs/tsconfig": "^3.0.0",
     "@types/accepts": "^1.3.7",
     "@types/content-type": "^1.1.8",
     "@types/cookies": "^0.9.0",
@@ -81,20 +72,13 @@
     "@types/supertest": "^6.0.2",
     "@types/type-is": "^1.6.6",
     "@types/vary": "^1.1.3",
-    "c8": "^10.1.3",
-    "husky": "9",
-    "lint-staged": "15",
-    "mm": "^4.0.1",
-    "oxlint": "^1.9.0",
-    "prettier": "3",
+    "mm": "^4.0.2",
     "supertest": "^3.1.0",
-    "typescript": "^5.8.3"
+    "tsdown": "^0.14.2",
+    "typescript": "5"
   },
-  "type": "module",
-  "exports": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist",
-    "src"
-  ]
-}
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run"
+  }
+}

package/dist/types.js

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

package/src/application.ts

@@ -1,322 +0,0 @@
-import util, { debuglog } from 'node:util';
-import Emitter from 'node:events';
-import Stream from 'node:stream';
-import type { AsyncLocalStorage } from 'node:async_hooks';
-import http, { type IncomingMessage, type ServerResponse } 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.ts';
-import { Request } from './request.ts';
-import { Response } from './response.ts';
-import type { CustomError, AnyProto } from './types.ts';
-
-const debug = debuglog('@eggjs/koa/application');
-
-// oxlint-disable-next-line typescript/no-explicit-any
-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 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 = HttpError;
-
-  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[];
-  }) {
-    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 {} as ProtoImplClass<Context>;
-    this.context = this.ContextClass.prototype;
-    this.RequestClass =
-      class ApplicationRequest extends Request {} as ProtoImplClass<Request>;
-    this.request = this.RequestClass.prototype;
-    this.ResponseClass =
-      class ApplicationResponse extends Response {} as ProtoImplClass<Response>;
-    this.response = this.ResponseClass.prototype;
-  }
-
-  get keys() {
-    return this._keys;
-  }
-
-  set keys(value: string[] | undefined) {
-    this._keys = value;
-  }
-
-  get env() {
-    return this._env;
-  }
-  set env(value: string) {
-    this._env = value;
-  }
-
-  get proxy() {
-    return this._proxy;
-  }
-  set proxy(value: boolean) {
-    this._proxy = value;
-  }
-
-  /**
-   * Shorthand for:
-   *
-   *    http.createServer(app.callback()).listen(...)
-   */
-  // oxlint-disable-next-line typescript/no-explicit-any
-  listen(...args: any[]) {
-    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<T extends Context = Context>(fn: MiddlewareFunc<T>) {
-    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 as MiddlewareFunc<Context>);
-    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: IncomingMessage, res: ServerResponse) => {
-      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
-   */
-  protected async handleRequest(
-    ctx: Context,
-    fnMiddleware: (ctx: Context) => Promise<void>
-  ) {
-    this.emit('request', ctx);
-    const res = ctx.res;
-    res.statusCode = 404;
-    const onerror = (err: CustomError) => ctx.onerror(err);
-    // oxlint-disable-next-line promise/prefer-await-to-callbacks
-    onFinished(res, (err: CustomError | null) => {
-      if (err) {
-        onerror(err);
-      }
-      this.emit('response', ctx);
-    });
-    try {
-      await fnMiddleware(ctx);
-      return this._respond(ctx);
-    } catch (err) {
-      return onerror(err as CustomError);
-    }
-  }
-
-  /**
-   * Initialize a new context.
-   * @private
-   */
-  createContext(req: IncomingMessage, res: ServerResponse) {
-    const context = new this.ContextClass(this, req, res);
-    return context;
-  }
-
-  /**
-   * Default error handler.
-   * @private
-   */
-  protected onerror(err: CustomError) {
-    // 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.
-   */
-  protected _respond(ctx: Context) {
-    // 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);
-  }
-}