@eggjs/koa 2.21.0 → 2.22.0

package/src/index.ts

@@ -6,4 +6,4 @@ export * from './application.js';
 export * from './context.js';
 export * from './request.js';
 export * from './response.js';
-export * from './types.js';
+export type { CustomError, AnyProto } from './types.js';

package/src/request.ts

@@ -3,11 +3,13 @@ import { format as stringify } from 'node:url';
 import qs, { type ParsedUrlQuery } from 'node:querystring';
 import util from 'node:util';
 import type { IncomingMessage, ServerResponse } from 'node:http';
+
 import accepts, { type Accepts } from 'accepts';
 import contentType from 'content-type';
 import parse from 'parseurl';
 import typeis from 'type-is';
 import fresh from 'fresh';
+
 import type { Application } from './application.js';
 import type { Context } from './context.js';
 import type { Response } from './response.js';
@@ -25,12 +27,17 @@ export class Request {
   response: Response;
   originalUrl: string;
 
-  constructor(app: Application, ctx: Context, req: IncomingMessage, res: ServerResponse) {
+  constructor(
+    app: Application,
+    ctx: Context,
+    req: IncomingMessage,
+    res: ServerResponse
+  ) {
     this.app = app;
     this.req = req;
     this.res = res;
     this.ctx = ctx;
-    this.originalUrl = req.url!;
+    this.originalUrl = req.url ?? '/';
   }
 
   /**
@@ -70,7 +77,7 @@ export class Request {
    */
 
   get url() {
-    return this.req.url!;
+    return this.req.url ?? '/';
   }
 
   /**
@@ -95,7 +102,9 @@ export class Request {
 
   get href() {
     // support: `GET http://example.com/foo`
-    if (/^https?:\/\//i.test(this.originalUrl)) return this.originalUrl;
+    if (/^https?:\/\//i.test(this.originalUrl)) {
+      return this.originalUrl;
+    }
     return this.origin + this.originalUrl;
   }
 
@@ -104,34 +113,32 @@ export class Request {
    */
 
   get method() {
-    return this.req.method!;
+    return this.req.method ?? 'GET';
   }
 
   /**
    * Set request method.
    */
-
-  set method(val) {
+  set method(val: string) {
     this.req.method = val;
   }
 
   /**
    * Get request pathname.
    */
-
   get path() {
-    return parse(this.req)!.pathname as string;
+    return parse(this.req)?.pathname ?? '';
   }
 
   /**
    * Set pathname, retaining the query string when present.
    */
+  set path(pathname: string) {
+    const url = parse(this.req);
+    if (!url) return;
+    if (url.pathname === pathname) return;
 
-  set path(path) {
-    const url = parse(this.req)!;
-    if (url.pathname === path) return;
-
-    url.pathname = path;
+    url.pathname = pathname;
     url.path = null;
 
     this.url = stringify(url);
@@ -149,7 +156,8 @@ export class Request {
     }
     let parsedUrlQuery = this._parsedUrlQueryCache[str];
     if (!parsedUrlQuery) {
-      parsedUrlQuery = this._parsedUrlQueryCache[str] = qs.parse(str);
+      parsedUrlQuery = qs.parse(str);
+      this._parsedUrlQueryCache[str] = parsedUrlQuery;
     }
     return parsedUrlQuery;
   }
@@ -157,7 +165,6 @@ export class Request {
   /**
    * Set query string as an object.
    */
-
   set query(obj: ParsedUrlQuery) {
     this.querystring = qs.stringify(obj);
   }
@@ -165,18 +172,17 @@ export class Request {
   /**
    * Get query string.
    */
-
   get querystring() {
     if (!this.req) return '';
-    return parse(this.req)!.query as string || '';
+    return (parse(this.req)?.query as string) ?? '';
   }
 
   /**
    * Set query string.
    */
-
-  set querystring(str) {
-    const url = parse(this.req)!;
+  set querystring(str: string) {
+    const url = parse(this.req);
+    if (!url) return;
     if (url.search === `?${str}`) return;
 
     url.search = str;
@@ -188,18 +194,17 @@ export class Request {
    * Get the search string. Same as the query string
    * except it includes the leading ?.
    */
-
   get search() {
-    if (!this.querystring) return '';
-    return `?${this.querystring}`;
+    const querystring = this.querystring;
+    if (!querystring) return '';
+    return `?${querystring}`;
   }
 
   /**
    * Set the search string. Same as
    * request.querystring= but included for ubiquity.
    */
-
-  set search(str) {
+  set search(str: string) {
     this.querystring = str;
   }
 
@@ -257,7 +262,7 @@ export class Request {
         this._memoizedURL = Object.create(null);
       }
     }
-    return this._memoizedURL!;
+    return this._memoizedURL as URL;
   }
 
   /**
@@ -295,7 +300,7 @@ export class Request {
    * Check if the request is idempotent.
    */
   get idempotent() {
-    const methods = [ 'GET', 'HEAD', 'PUT', 'DELETE', 'OPTIONS', 'TRACE' ];
+    const methods = ['GET', 'HEAD', 'PUT', 'DELETE', 'OPTIONS', 'TRACE'];
     return methods.includes(this.method);
   }
 
@@ -326,7 +331,7 @@ export class Request {
     if (len === '') {
       return;
     }
-    return parseInt(len);
+    return Number.parseInt(len);
   }
 
   /**
@@ -371,9 +376,7 @@ export class Request {
   get ips() {
     const proxy = this.app.proxy;
     const val = this.get<string>(this.app.proxyIpHeader);
-    let ips = proxy && val
-      ? splitCommaSeparatedValues(val)
-      : [];
+    let ips = proxy && val ? splitCommaSeparatedValues(val) : [];
     if (this.app.maxIpsCount > 0) {
       ips = ips.slice(-this.app.maxIpsCount);
     }
@@ -413,10 +416,7 @@ export class Request {
     const offset = this.app.subdomainOffset;
     const hostname = this.hostname;
     if (net.isIP(hostname)) return [];
-    return hostname
-      .split('.')
-      .reverse()
-      .slice(offset);
+    return hostname.split('.').reverse().slice(offset);
   }
 
   protected _accept: Accepts;
@@ -471,8 +471,13 @@ export class Request {
    *     this.accepts('html', 'json');
    *     // => "json"
    */
-  accepts(...args: any[]): string | string[] | false {
-    return this.accept.types(...args);
+  accepts(args: string[]): string | string[] | false;
+  accepts(...args: string[]): string | string[] | false;
+  accepts(
+    args?: string | string[],
+    ...others: string[]
+  ): string | string[] | false {
+    return this.accept.types(args as string, ...others);
   }
 
   /**
@@ -486,14 +491,17 @@ export class Request {
   acceptsEncodings(): string[];
   acceptsEncodings(encodings: string[]): string | false;
   acceptsEncodings(...encodings: string[]): string | false;
-  acceptsEncodings(encodings?: string | string[], ...others: string[]): string[] | string | false {
+  acceptsEncodings(
+    encodings?: string | string[],
+    ...others: string[]
+  ): string[] | string | false {
     if (!encodings) {
       return this.accept.encodings();
     }
     if (Array.isArray(encodings)) {
-      encodings = [ ...encodings, ...others ];
+      encodings = [...encodings, ...others];
     } else {
-      encodings = [ encodings, ...others ];
+      encodings = [encodings, ...others];
     }
     return this.accept.encodings(...encodings);
   }
@@ -509,14 +517,17 @@ export class Request {
   acceptsCharsets(): string[];
   acceptsCharsets(charsets: string[]): string | false;
   acceptsCharsets(...charsets: string[]): string | false;
-  acceptsCharsets(charsets?: string | string[], ...others: string[]): string[] | string | false {
+  acceptsCharsets(
+    charsets?: string | string[],
+    ...others: string[]
+  ): string[] | string | false {
     if (!charsets) {
       return this.accept.charsets();
     }
     if (Array.isArray(charsets)) {
-      charsets = [ ...charsets, ...others ];
+      charsets = [...charsets, ...others];
     } else {
-      charsets = [ charsets, ...others ];
+      charsets = [charsets, ...others];
     }
     return this.accept.charsets(...charsets);
   }
@@ -532,14 +543,17 @@ export class Request {
   acceptsLanguages(): string[];
   acceptsLanguages(languages: string[]): string | false;
   acceptsLanguages(...languages: string[]): string | false;
-  acceptsLanguages(languages?: string | string[], ...others: string[]): string | string[] | false {
+  acceptsLanguages(
+    languages?: string | string[],
+    ...others: string[]
+  ): string | string[] | false {
     if (!languages) {
       return this.accept.languages();
     }
     if (Array.isArray(languages)) {
-      languages = [ ...languages, ...others ];
+      languages = [...languages, ...others];
     } else {
-      languages = [ languages, ...others ];
+      languages = [languages, ...others];
     }
     return this.accept.languages(...languages);
   }
@@ -566,9 +580,11 @@ export class Request {
    *     this.is('html'); // => false
    */
   is(type?: string | string[], ...types: string[]): string | false | null {
-    const testTypes: string[] = Array.isArray(type) ? type :
-      (type ? [ type ] : []);
-    return typeis(this.req, [ ...testTypes, ...types ]);
+    let testTypes: string[] = [];
+    if (type) {
+      testTypes = Array.isArray(type) ? type : [type];
+    }
+    return typeis(this.req, [...testTypes, ...types]);
   }
 
   /**
@@ -598,9 +614,9 @@ export class Request {
    *     this.get('Something');
    *     // => ''
    */
-  get<T = string | string []>(field: string): T {
+  get<T = string | string[]>(field: string): T {
     const req = this.req;
-    switch (field = field.toLowerCase()) {
+    switch ((field = field.toLowerCase())) {
       case 'referer':
       case 'referrer':
         return (req.headers.referrer || req.headers.referer || '') as T;
@@ -642,8 +658,11 @@ export class Request {
  *
  * @param {string} value - The comma-separated value string to split.
  * @param {number} [limit] - The maximum number of values to return.
- * @return {string[]} An array of values from the comma-separated string.
+ * @returns {string[]} An array of values from the comma-separated string.
  */
 function splitCommaSeparatedValues(value: string, limit?: number): string[] {
-  return value.split(',', limit).map(v => v.trim()).filter(v => v);
+  return value
+    .split(',', limit)
+    .map(v => v.trim())
+    .filter(v => v.length > 0);
 }

package/src/response.ts

@@ -3,7 +3,10 @@ import { extname } from 'node:path';
 import util from 'node:util';
 import Stream from 'node:stream';
 import type { IncomingMessage, ServerResponse } from 'node:http';
-import contentDisposition from 'content-disposition';
+
+import contentDisposition, {
+  type Options as ContentDispositionOptions,
+} from 'content-disposition';
 import { getType } from 'cache-content-type';
 import onFinish from 'on-finished';
 import escape from 'escape-html';
@@ -12,6 +15,7 @@ import statuses from 'statuses';
 import destroy from 'destroy';
 import vary from 'vary';
 import encodeUrl from 'encodeurl';
+
 import type { Application } from './application.js';
 import type { Context } from './context.js';
 import type { Request } from './request.js';
@@ -24,7 +28,12 @@ export class Response {
   ctx: Context;
   request: Request;
 
-  constructor(app: Application, ctx: Context, req: IncomingMessage, res: ServerResponse) {
+  constructor(
+    app: Application,
+    ctx: Context,
+    req: IncomingMessage,
+    res: ServerResponse
+  ) {
     this.app = app;
     this.req = req;
     this.res = res;
@@ -70,17 +79,19 @@ export class Response {
     assert(code >= 100 && code <= 999, `invalid status code: ${code}`);
     this._explicitStatus = true;
     this.res.statusCode = code;
-    if (this.req.httpVersionMajor < 2) {
-      this.res.statusMessage = statuses.message[code]!;
+    if (this.req.httpVersionMajor < 2 && statuses.message[code]) {
+      this.res.statusMessage = statuses.message[code];
+    }
+    if (this.body && statuses.empty[code]) {
+      this.body = null;
     }
-    if (this.body && statuses.empty[code]) this.body = null;
   }
 
   /**
    * Get response status message
    */
   get message(): string {
-    return this.res.statusMessage || statuses.message[this.status]!;
+    return this.res.statusMessage ?? statuses.message[this.status];
   }
 
   /**
@@ -90,6 +101,7 @@ export class Response {
     this.res.statusMessage = msg;
   }
 
+  // oxlint-disable-next-line typescript/no-explicit-any
   _body: any;
   _explicitNullBody: boolean;
 
@@ -103,14 +115,20 @@ export class Response {
   /**
    * Set response body.
    */
-  set body(val: string | Buffer | object | Stream | null | undefined | boolean) {
+  set body(
+    val: string | Buffer | object | Stream | null | undefined | boolean
+  ) {
     const original = this._body;
     this._body = val;
 
     // no content
-    if (val == null) {
-      if (!statuses.empty[this.status]) this.status = 204;
-      if (val === null) this._explicitNullBody = true;
+    if (val === null || val === undefined) {
+      if (!statuses.empty[this.status]) {
+        this.status = 204;
+      }
+      if (val === null) {
+        this._explicitNullBody = true;
+      }
       this.remove('Content-Type');
       this.remove('Content-Length');
       this.remove('Transfer-Encoding');
@@ -140,14 +158,18 @@ export class Response {
     // stream
     if (val instanceof Stream) {
       onFinish(this.res, destroy.bind(null, val));
-      // eslint-disable-next-line eqeqeq
+      // oxlint-disable-next-line eqeqeq
       if (original != val) {
         val.once('error', err => this.ctx.onerror(err));
         // overwriting
-        if (original != null) this.remove('Content-Length');
+        if (original !== null && original !== undefined) {
+          this.remove('Content-Length');
+        }
       }
 
-      if (setType) this.type = 'bin';
+      if (setType) {
+        this.type = 'bin';
+      }
       return;
     }
 
@@ -173,7 +195,7 @@ export class Response {
    */
   get length(): number | undefined {
     if (this.has('Content-Length')) {
-      return parseInt(this.get('Content-Length'), 10) || 0;
+      return Number.parseInt(this.get('Content-Length')) || 0;
     }
 
     const { body } = this;
@@ -246,7 +268,7 @@ export class Response {
   /**
    * Set Content-Disposition header to "attachment" with optional `filename`.
    */
-  attachment(filename?: string, options?: any) {
+  attachment(filename?: string, options?: ContentDispositionOptions) {
     if (filename) this.type = extname(filename);
     this.set('Content-Disposition', contentDisposition(filename, options));
   }
@@ -292,9 +314,11 @@ export class Response {
    *     this.response.is('html', 'json')
    */
   is(type?: string | string[], ...types: string[]): string | false {
-    const testTypes: string[] = Array.isArray(type) ? type :
-      (type ? [ type ] : []);
-    return typeis(this.type as string, [ ...testTypes, ...types ]);
+    let testTypes: string[] = [];
+    if (type) {
+      testTypes = Array.isArray(type) ? type : [type];
+    }
+    return typeis(this.type, [...testTypes, ...types]);
   }
 
   /**
@@ -379,17 +403,21 @@ export class Response {
    *    this.set('Accept', 'application/json');
    *    this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
    */
-  set(field: string | Record<string, string>, val?: string | number | any[]) {
+  set(
+    field: string | Record<string, string>,
+    val?: string | number | unknown[]
+  ) {
     if (this.headerSent) return;
     if (typeof field === 'string') {
+      let value = val as string | string[];
       if (Array.isArray(val)) {
-        val = val.map(v => {
+        value = val.map(v => {
           return typeof v === 'string' ? v : String(v);
         });
       } else if (typeof val !== 'string') {
-        val = String(val);
+        value = String(val);
       }
-      this.res.setHeader(field, val);
+      this.res.setHeader(field, value);
     } else {
       for (const key in field) {
         this.set(key, field[key]);
@@ -408,13 +436,11 @@ export class Response {
    * this.append('Warning', '199 Miscellaneous warning');
    */
   append(field: string, val: string | string[]) {
-    const prev = this.get(field);
+    const prev = this.get<string | string[]>(field);
 
-    let value: any | any[] = val;
+    let value = val;
     if (prev) {
-      value = Array.isArray(prev)
-        ? prev.concat(value)
-        : [ prev ].concat(val);
+      value = Array.isArray(prev) ? prev.concat(value) : [prev].concat(val);
     }
 
     return this.set(field, value);

package/src/types.ts

@@ -4,8 +4,10 @@ export type CustomError = Error & {
   statusCode?: number;
   code?: string;
   expose?: boolean;
+  headerSent?: boolean;
 };
 
-export type AnyProto = {
+export interface AnyProto {
+  // oxlint-disable-next-line typescript/no-explicit-any
   [key: string | symbol]: any;
-};
+}