egg 4.0.9 → 4.1.0-beta.10

package/dist/app/extend/request.d.ts

@@ -0,0 +1,145 @@
+import { Application } from "../../lib/application.js";
+import Response$1 from "./response.js";
+import Context$1 from "./context.js";
+import { Request as Request$1 } from "@eggjs/core";
+
+//#region src/app/extend/request.d.ts
+declare class Request extends Request$1 {
+  app: Application;
+  ctx: Context$1;
+  response: Response$1;
+  /**
+   * Request body, parsed from koa-bodyparser or @eggjs/multipart
+   */
+  body: any;
+  /**
+   * Parse the "Host" header field host
+   * and support X-Forwarded-Host when a
+   * proxy is enabled.
+   * @member {String} Request#host
+   * @example
+   * ip + port
+   * ```js
+   * this.request.host
+   * => '127.0.0.1:7001'
+   * ```
+   * or domain
+   * ```js
+   * this.request.host
+   * => 'demo.eggjs.org'
+   * ```
+   */
+  get host(): string;
+  /**
+   * @member {String} Request#protocol
+   * @example
+   * ```js
+   * this.request.protocol
+   * => 'https'
+   * ```
+   */
+  get protocol(): string;
+  /**
+   * Get all pass through ip addresses from the request.
+   * Enable only on `app.config.proxy = true`
+   *
+   * @member {Array} Request#ips
+   * @example
+   * ```js
+   * this.request.ips
+   * => ['100.23.1.2', '201.10.10.2']
+   * ```
+   */
+  get ips(): string[];
+  /**
+   * Get the request remote IPv4 address
+   * @member {String} Request#ip
+   * @return {String} IPv4 address
+   * @example
+   * ```js
+   * this.request.ip
+   * => '127.0.0.1'
+   * => '111.10.2.1'
+   * ```
+   */
+  get ip(): string;
+  /**
+   * Set the request remote IPv4 address
+   * @member {String} Request#ip
+   * @param {String} ip - IPv4 address
+   * @example
+   * ```js
+   * this.request.ip
+   * => '127.0.0.1'
+   * => '111.10.2.1'
+   * ```
+   */
+  set ip(ip: string);
+  /**
+   * detect if response should be json
+   * 1. url path ends with `.json`
+   * 2. response type is set to json
+   * 3. detect by request accept header
+   *
+   * @member {Boolean} Request#acceptJSON
+   * @since 1.0.0
+   */
+  get acceptJSON(): boolean;
+  _customQuery(cacheName: symbol, filter: (value: string | string[]) => string | string[]): Record<string, string | string[]>;
+  /**
+   * get params pass by querystring, all values are of string type.
+   * @member {Object} Request#query
+   * @example
+   * ```js
+   * GET http://127.0.0.1:7001?name=Foo&age=20&age=21
+   * this.query
+   * => { 'name': 'Foo', 'age': '20' }
+   *
+   * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
+   * this.query
+   * =>
+   * {
+   *   "a": "b",
+   *   "o[foo]": "bar",
+   *   "b[]": "1",
+   *   "e": "val"
+   * }
+   * ```
+   */
+  get query(): Record<string, string>;
+  /**
+   * get params pass by querystring, all value are Array type. {@link Request#query}
+   * @member {Array} Request#queries
+   * @example
+   * ```js
+   * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
+   * this.queries
+   * =>
+   * {
+   *   "a": ["b", "c"],
+   *   "o[foo]": ["bar"],
+   *   "b[]": ["1", "2"],
+   *   "e": ["val"]
+   * }
+   * ```
+   */
+  get queries(): Record<string, string[]>;
+  /**
+   * Set query-string as an object.
+   *
+   * @function Request#query
+   * @param {Object} obj set querystring and query object for request.
+   */
+  set query(obj: Record<string, string>);
+}
+declare module '@eggjs/core' {
+  interface Request {
+    body: any;
+    get acceptJSON(): boolean;
+    get query(): Record<string, string>;
+    set query(obj: Record<string, string>);
+    get queries(): Record<string, string[]>;
+  }
+}
+//#endregion
+export { Request as default };

package/dist/app/extend/request.js

@@ -0,0 +1,226 @@
+import "./response.js";
+import { Request as Request$1 } from "@eggjs/core";
+import querystring from "node:querystring";
+
+//#region src/app/extend/request.ts
+const QUERY_CACHE = Symbol("request query cache");
+const QUERIES_CACHE = Symbol("request queries cache");
+const PROTOCOL = Symbol("request protocol");
+const HOST = Symbol("request host");
+const IPS = Symbol("request ips");
+const RE_ARRAY_KEY = /[^[\]]+\[\]$/;
+var Request = class extends Request$1 {
+	/**
+	* Parse the "Host" header field host
+	* and support X-Forwarded-Host when a
+	* proxy is enabled.
+	* @member {String} Request#host
+	* @example
+	* ip + port
+	* ```js
+	* this.request.host
+	* => '127.0.0.1:7001'
+	* ```
+	* or domain
+	* ```js
+	* this.request.host
+	* => 'demo.eggjs.org'
+	* ```
+	*/
+	get host() {
+		let host = this[HOST];
+		if (host) return host;
+		if (this.app.config.proxy) host = getFromHeaders(this, this.app.config.hostHeaders);
+		host = host || this.get("host") || "";
+		this[HOST] = host = host.split(",")[0].trim();
+		return host;
+	}
+	/**
+	* @member {String} Request#protocol
+	* @example
+	* ```js
+	* this.request.protocol
+	* => 'https'
+	* ```
+	*/
+	get protocol() {
+		let protocol = this[PROTOCOL];
+		if (protocol) return protocol;
+		if (this.socket?.encrypted) {
+			this[PROTOCOL] = protocol = "https";
+			return protocol;
+		}
+		if (this.app.config.proxy) {
+			const proto = getFromHeaders(this, this.app.config.protocolHeaders);
+			if (proto) {
+				this[PROTOCOL] = protocol = proto.split(/\s*,\s*/)[0];
+				return protocol;
+			}
+		}
+		this[PROTOCOL] = protocol = this.app.config.protocol || "http";
+		return protocol;
+	}
+	/**
+	* Get all pass through ip addresses from the request.
+	* Enable only on `app.config.proxy = true`
+	*
+	* @member {Array} Request#ips
+	* @example
+	* ```js
+	* this.request.ips
+	* => ['100.23.1.2', '201.10.10.2']
+	* ```
+	*/
+	get ips() {
+		let ips = this[IPS];
+		if (ips) return ips;
+		if (!this.app.config.proxy) {
+			this[IPS] = ips = [];
+			return ips;
+		}
+		const val = getFromHeaders(this, this.app.config.ipHeaders);
+		this[IPS] = ips = val ? val.split(/\s*,\s*/) : [];
+		let maxIpsCount = this.app.config.maxIpsCount;
+		if (!maxIpsCount && this.app.config.maxProxyCount) maxIpsCount = this.app.config.maxProxyCount + 1;
+		if (maxIpsCount > 0) this[IPS] = ips = ips.slice(-maxIpsCount);
+		return ips;
+	}
+	/**
+	* Get the request remote IPv4 address
+	* @member {String} Request#ip
+	* @return {String} IPv4 address
+	* @example
+	* ```js
+	* this.request.ip
+	* => '127.0.0.1'
+	* => '111.10.2.1'
+	* ```
+	*/
+	get ip() {
+		if (this._ip) return this._ip;
+		const ip = this.ips[0] ?? this.socket.remoteAddress;
+		this._ip = ip && ip.startsWith("::ffff:") ? ip.substring(7) : ip;
+		return this._ip;
+	}
+	/**
+	* Set the request remote IPv4 address
+	* @member {String} Request#ip
+	* @param {String} ip - IPv4 address
+	* @example
+	* ```js
+	* this.request.ip
+	* => '127.0.0.1'
+	* => '111.10.2.1'
+	* ```
+	*/
+	set ip(ip) {
+		this._ip = ip;
+	}
+	/**
+	* detect if response should be json
+	* 1. url path ends with `.json`
+	* 2. response type is set to json
+	* 3. detect by request accept header
+	*
+	* @member {Boolean} Request#acceptJSON
+	* @since 1.0.0
+	*/
+	get acceptJSON() {
+		if (this.path.endsWith(".json")) return true;
+		if (this.response.type && this.response.type.indexOf("json") >= 0) return true;
+		if (this.accepts("html", "text", "json") === "json") return true;
+		return false;
+	}
+	_customQuery(cacheName, filter) {
+		const str = this.querystring || "";
+		let c = this[cacheName];
+		if (!c) c = this[cacheName] = {};
+		let cacheQuery = c[str];
+		if (!cacheQuery) {
+			cacheQuery = c[str] = {};
+			const isQueries = cacheName === QUERIES_CACHE;
+			const query = str ? querystring.parse(str) : {};
+			for (const key in query) {
+				if (!key) continue;
+				const value = filter(query[key]);
+				cacheQuery[key] = value;
+				if (isQueries && RE_ARRAY_KEY.test(key)) {
+					const subKey = key.substring(0, key.length - 2);
+					if (!cacheQuery[subKey]) cacheQuery[subKey] = value;
+				}
+			}
+		}
+		return cacheQuery;
+	}
+	/**
+	* get params pass by querystring, all values are of string type.
+	* @member {Object} Request#query
+	* @example
+	* ```js
+	* GET http://127.0.0.1:7001?name=Foo&age=20&age=21
+	* this.query
+	* => { 'name': 'Foo', 'age': '20' }
+	*
+	* GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
+	* this.query
+	* =>
+	* {
+	*   "a": "b",
+	*   "o[foo]": "bar",
+	*   "b[]": "1",
+	*   "e": "val"
+	* }
+	* ```
+	*/
+	get query() {
+		return this._customQuery(QUERY_CACHE, firstValue);
+	}
+	/**
+	* get params pass by querystring, all value are Array type. {@link Request#query}
+	* @member {Array} Request#queries
+	* @example
+	* ```js
+	* GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
+	* this.queries
+	* =>
+	* {
+	*   "a": ["b", "c"],
+	*   "o[foo]": ["bar"],
+	*   "b[]": ["1", "2"],
+	*   "e": ["val"]
+	* }
+	* ```
+	*/
+	get queries() {
+		return this._customQuery(QUERIES_CACHE, arrayValue);
+	}
+	/**
+	* Set query-string as an object.
+	*
+	* @function Request#query
+	* @param {Object} obj set querystring and query object for request.
+	*/
+	set query(obj) {
+		this.querystring = querystring.stringify(obj);
+	}
+};
+function firstValue(value) {
+	if (Array.isArray(value)) value = value[0];
+	return value;
+}
+function arrayValue(value) {
+	if (!Array.isArray(value)) value = [value];
+	return value;
+}
+function getFromHeaders(request, names) {
+	if (!names) return "";
+	const fields = names.split(/\s*,\s*/);
+	for (const name of fields) {
+		const value = request.get(name);
+		if (value) return value;
+	}
+	return "";
+}
+
+//#endregion
+export { Request as default };

package/{src/app/extend/response.ts → dist/app/extend/response.d.ts}

@@ -1,8 +1,7 @@
-import { Response as KoaResponse } from '@eggjs/core';
+import { Response as Response$1 } from "@eggjs/core";
 
-const REAL_STATUS = Symbol('response realStatus');
-
-export default class Response extends KoaResponse {
+//#region src/app/extend/response.d.ts
+declare class Response extends Response$1 {
   /**
    * Get or set a real status code.
    *
@@ -13,13 +12,7 @@ export default class Response extends KoaResponse {
    * @member {Number} Response#realStatus
    * @return {Number} The status code to be set.
    */
-  get realStatus(): number {
-    if (this[REAL_STATUS]) {
-      return this[REAL_STATUS] as number;
-    }
-    return this.status;
-  }
-
+  get realStatus(): number;
   /**
    * Set a real status code.
    *
@@ -30,15 +23,13 @@ export default class Response extends KoaResponse {
    * @member {Number} Response#realStatus
    * @param {Number} status The status code to be set.
    */
-  set realStatus(status: number) {
-    this[REAL_STATUS] = status;
-  }
+  set realStatus(status: number);
 }
-
 declare module '@eggjs/core' {
-  // add Response overrides types
   interface Response {
     get realStatus(): number;
     set realStatus(status: number);
   }
 }
+//#endregion
+export { Response as default };

package/dist/app/extend/response.js

@@ -0,0 +1,36 @@
+import { Response as Response$1 } from "@eggjs/core";
+
+//#region src/app/extend/response.ts
+const REAL_STATUS = Symbol("response realStatus");
+var Response = class extends Response$1 {
+	/**
+	* Get or set a real status code.
+	*
+	* e.g.: Using 302 status redirect to the global error page
+	* instead of show current 500 status page.
+	* And access log should save 500 not 302,
+	* then the `realStatus` can help us find out the real status code.
+	* @member {Number} Response#realStatus
+	* @return {Number} The status code to be set.
+	*/
+	get realStatus() {
+		if (this[REAL_STATUS]) return this[REAL_STATUS];
+		return this.status;
+	}
+	/**
+	* Set a real status code.
+	*
+	* e.g.: Using 302 status redirect to the global error page
+	* instead of show current 500 status page.
+	* And access log should save 500 not 302,
+	* then the `realStatus` can help us find out the real status code.
+	* @member {Number} Response#realStatus
+	* @param {Number} status The status code to be set.
+	*/
+	set realStatus(status) {
+		this[REAL_STATUS] = status;
+	}
+};
+
+//#endregion
+export { Response as default };

package/dist/app/middleware/body_parser.d.ts

@@ -0,0 +1,2 @@
+import bodyparser from "koa-bodyparser";
+export { bodyparser as default };

package/dist/app/middleware/body_parser.js

@@ -0,0 +1,7 @@
+import bodyparser from "koa-bodyparser";
+
+//#region src/app/middleware/body_parser.ts
+var body_parser_default = bodyparser;
+
+//#endregion
+export { body_parser_default as default };

package/dist/app/middleware/meta.d.ts

@@ -0,0 +1,11 @@
+import Context from "../extend/context.js";
+import { Next } from "../../lib/egg.js";
+
+//#region src/app/middleware/meta.d.ts
+interface MetaMiddlewareOptions {
+  enable: boolean;
+  logging: boolean;
+}
+declare const _default: (options: MetaMiddlewareOptions) => (ctx: Context, next: Next) => Promise<void>;
+//#endregion
+export { MetaMiddlewareOptions, _default as default };

package/dist/app/middleware/meta.js

@@ -0,0 +1,14 @@
+import { performance } from "node:perf_hooks";
+
+//#region src/app/middleware/meta.ts
+var meta_default = (options) => {
+	return async function meta(ctx, next) {
+		if (options.logging) ctx.coreLogger.info("[meta] request started, host: %s, user-agent: %s", ctx.host, ctx.header["user-agent"]);
+		await next();
+		if (ctx.performanceStarttime) ctx.set("x-readtime", Math.floor((performance.now() - ctx.performanceStarttime) * 1e3) / 1e3);
+		else ctx.set("x-readtime", Date.now() - ctx.starttime);
+	};
+};
+
+//#endregion
+export { meta_default as default };

package/dist/app/middleware/notfound.d.ts

@@ -0,0 +1,11 @@
+import Context from "../extend/context.js";
+import { Next } from "../../lib/egg.js";
+
+//#region src/app/middleware/notfound.d.ts
+interface NotFoundMiddlewareOptions {
+  enable: boolean;
+  pageUrl: string;
+}
+declare const _default: (options: NotFoundMiddlewareOptions) => (ctx: Context, next: Next) => Promise<void>;
+//#endregion
+export { NotFoundMiddlewareOptions, _default as default };

package/dist/app/middleware/notfound.js

@@ -0,0 +1,26 @@
+//#region src/app/middleware/notfound.ts
+var notfound_default = (options) => {
+	return async function notfound(ctx, next) {
+		await next();
+		if (ctx.status !== 404 || ctx.body) return;
+		ctx.status = 404;
+		if (ctx.acceptJSON) {
+			ctx.body = { message: "Not Found" };
+			return;
+		}
+		const notFoundHtml = "<h1>404 Not Found</h1>";
+		if (options.pageUrl && ctx.path === options.pageUrl) {
+			ctx.body = `${notFoundHtml}<p><pre><code>config.notfound.pageUrl(${options.pageUrl})</code></pre> is unimplemented</p>`;
+			return;
+		}
+		if (options.pageUrl) {
+			ctx.realStatus = 404;
+			ctx.redirect(options.pageUrl);
+			return;
+		}
+		ctx.body = notFoundHtml;
+	};
+};
+
+//#endregion
+export { notfound_default as default };

package/dist/app/middleware/override_method.d.ts

@@ -0,0 +1,2 @@
+import override from "koa-override";
+export { override as default };

package/dist/app/middleware/override_method.js

@@ -0,0 +1,7 @@
+import override from "koa-override";
+
+//#region src/app/middleware/override_method.ts
+var override_method_default = override;
+
+//#endregion
+export { override_method_default as default };

package/dist/app/middleware/site_file.d.ts

@@ -0,0 +1,13 @@
+import Context from "../extend/context.js";
+import { Next } from "../../lib/egg.js";
+
+//#region src/app/middleware/site_file.d.ts
+type SiteFileContentFun = (ctx: Context) => Promise<Buffer | string>;
+interface SiteFileMiddlewareOptions {
+  enable: boolean;
+  cacheControl: string;
+  [key: string]: string | Buffer | boolean | SiteFileContentFun | URL;
+}
+declare const _default: (options: SiteFileMiddlewareOptions) => (ctx: Context, next: Next) => Promise<void>;
+//#endregion
+export { SiteFileContentFun, SiteFileMiddlewareOptions, _default as default };

package/dist/app/middleware/site_file.js

@@ -0,0 +1,38 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { readFile } from "node:fs/promises";
+
+//#region src/app/middleware/site_file.ts
+const BUFFER_CACHE = Symbol("siteFile URL buffer cache");
+var site_file_default = (options) => {
+	return async function siteFile(ctx, next) {
+		if (ctx.method !== "HEAD" && ctx.method !== "GET") return next();
+		if (ctx.path[0] !== "/") return next();
+		let content = options[ctx.path];
+		if (!content) return next();
+		if (typeof content === "function") content = await content(ctx);
+		if (typeof content === "string") return ctx.redirect(content);
+		if (content instanceof URL) {
+			if (content.protocol !== "file:") return ctx.redirect(content.href);
+			let buffer = Reflect.get(content, BUFFER_CACHE);
+			if (!buffer) {
+				buffer = await readFile(fileURLToPath(content));
+				Reflect.set(content, BUFFER_CACHE, buffer);
+			}
+			ctx.set("cache-control", options.cacheControl);
+			ctx.body = content;
+			ctx.type = path.extname(ctx.path);
+			return;
+		}
+		if (Buffer.isBuffer(content)) {
+			ctx.set("cache-control", options.cacheControl);
+			ctx.body = content;
+			ctx.type = path.extname(ctx.path);
+			return;
+		}
+		return next();
+	};
+};
+
+//#endregion
+export { site_file_default as default };

package/dist/config/config.default.d.ts

@@ -0,0 +1,12 @@
+import { EggAppInfo, PartialEggConfig } from "../lib/types.js";
+
+//#region src/config/config.default.d.ts
+
+/**
+ * The configuration of egg application, can be access by `app.config`
+ * @class Config
+ * @since 1.0.0
+ */
+declare const _default: (appInfo: EggAppInfo) => PartialEggConfig;
+//#endregion
+export { _default as default };