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

package/dist/request.js

@@ -1,459 +0,0 @@
-import util from "node:util";
-import net from "node:net";
-import { format } from "node:url";
-import qs from "node:querystring";
-import accepts from "accepts";
-import contentType from "content-type";
-import parse from "parseurl";
-import typeis from "type-is";
-import fresh from "fresh";
-
-//#region src/request.ts
-var Request = class {
-	app;
-	req;
-	res;
-	ctx;
-	response;
-	originalUrl;
-	constructor(app, ctx, req, res) {
-		this.app = app;
-		this.req = req;
-		this.res = res;
-		this.ctx = ctx;
-		this.originalUrl = req.url ?? "/";
-	}
-	/**
-	* Return request header.
-	*/
-	get header() {
-		return this.req.headers;
-	}
-	/**
-	* Set request header.
-	*/
-	set header(val) {
-		this.req.headers = val;
-	}
-	/**
-	* Return request header, alias as request.header
-	*/
-	get headers() {
-		return this.req.headers;
-	}
-	/**
-	* Set request header, alias as request.header
-	*/
-	set headers(val) {
-		this.req.headers = val;
-	}
-	/**
-	* Get request URL.
-	*/
-	get url() {
-		return this.req.url ?? "/";
-	}
-	/**
-	* Set request URL.
-	*/
-	set url(val) {
-		this.req.url = val;
-	}
-	/**
-	* Get origin of URL.
-	*/
-	get origin() {
-		return `${this.protocol}://${this.host}`;
-	}
-	/**
-	* Get full request URL.
-	*/
-	get href() {
-		if (/^https?:\/\//i.test(this.originalUrl)) return this.originalUrl;
-		return this.origin + this.originalUrl;
-	}
-	/**
-	* Get request method.
-	*/
-	get method() {
-		return this.req.method ?? "GET";
-	}
-	/**
-	* Set request method.
-	*/
-	set method(val) {
-		this.req.method = val;
-	}
-	/**
-	* Get request pathname.
-	*/
-	get path() {
-		return parse(this.req)?.pathname ?? "";
-	}
-	/**
-	* Set pathname, retaining the query string when present.
-	*/
-	set path(pathname) {
-		const url = parse(this.req);
-		if (!url) return;
-		if (url.pathname === pathname) return;
-		url.pathname = pathname;
-		url.path = null;
-		this.url = format(url);
-	}
-	_parsedUrlQueryCache;
-	/**
-	* Get parsed query string.
-	*/
-	get query() {
-		const str = this.querystring;
-		if (!this._parsedUrlQueryCache) this._parsedUrlQueryCache = {};
-		let parsedUrlQuery = this._parsedUrlQueryCache[str];
-		if (!parsedUrlQuery) {
-			parsedUrlQuery = qs.parse(str);
-			this._parsedUrlQueryCache[str] = parsedUrlQuery;
-		}
-		return parsedUrlQuery;
-	}
-	/**
-	* Set query string as an object.
-	*/
-	set query(obj) {
-		this.querystring = qs.stringify(obj);
-	}
-	/**
-	* Get query string.
-	*/
-	get querystring() {
-		if (!this.req) return "";
-		return parse(this.req)?.query ?? "";
-	}
-	/**
-	* Set query string.
-	*/
-	set querystring(str) {
-		const url = parse(this.req);
-		if (!url) return;
-		if (url.search === `?${str}`) return;
-		url.search = str;
-		url.path = null;
-		this.url = format(url);
-	}
-	/**
-	* Get the search string. Same as the query string
-	* except it includes the leading ?.
-	*/
-	get search() {
-		const querystring = this.querystring;
-		if (!querystring) return "";
-		return `?${querystring}`;
-	}
-	/**
-	* Set the search string. Same as
-	* request.querystring= but included for ubiquity.
-	*/
-	set search(str) {
-		this.querystring = str;
-	}
-	/**
-	* Parse the "Host" header field host
-	* and support X-Forwarded-Host when a
-	* proxy is enabled.
-	* return `hostname:port` format
-	*/
-	get host() {
-		let host = this.app.proxy ? this.get("X-Forwarded-Host") : "";
-		if (host) host = splitCommaSeparatedValues(host, 1)[0];
-		if (!host) {
-			if (this.req.httpVersionMajor >= 2) host = this.get(":authority");
-			if (!host) host = this.get("Host");
-		}
-		return host;
-	}
-	/**
-	* Parse the "Host" header field hostname
-	* and support X-Forwarded-Host when a
-	* proxy is enabled.
-	*/
-	get hostname() {
-		const host = this.host;
-		if (!host) return "";
-		if (host[0] === "[") return this.URL.hostname || "";
-		return host.split(":", 1)[0];
-	}
-	_memoizedURL;
-	/**
-	* Get WHATWG parsed URL.
-	* Lazily memoized.
-	*/
-	get URL() {
-		if (!this._memoizedURL) {
-			const originalUrl = this.originalUrl || "";
-			try {
-				this._memoizedURL = new URL(`${this.origin}${originalUrl}`);
-			} catch {
-				this._memoizedURL = Object.create(null);
-			}
-		}
-		return this._memoizedURL;
-	}
-	/**
-	* Check if the request is fresh, aka
-	* Last-Modified and/or the ETag
-	* still match.
-	*/
-	get fresh() {
-		const method = this.method;
-		const status = this.response.status;
-		if (method !== "GET" && method !== "HEAD") return false;
-		if (status >= 200 && status < 300 || status === 304) return fresh(this.header, this.response.header);
-		return false;
-	}
-	/**
-	* Check if the request is stale, aka
-	* "Last-Modified" and / or the "ETag" for the
-	* resource has changed.
-	*/
-	get stale() {
-		return !this.fresh;
-	}
-	/**
-	* Check if the request is idempotent.
-	*/
-	get idempotent() {
-		return [
-			"GET",
-			"HEAD",
-			"PUT",
-			"DELETE",
-			"OPTIONS",
-			"TRACE"
-		].includes(this.method);
-	}
-	/**
-	* Return the request socket.
-	*/
-	get socket() {
-		return this.req.socket;
-	}
-	/**
-	* Get the charset when present or undefined.
-	*/
-	get charset() {
-		try {
-			const { parameters } = contentType.parse(this.req);
-			return parameters.charset || "";
-		} catch {
-			return "";
-		}
-	}
-	/**
-	* Return parsed Content-Length when present.
-	*/
-	get length() {
-		const len = this.get("Content-Length");
-		if (len === "") return;
-		return Number.parseInt(len);
-	}
-	/**
-	* Return the protocol string "http" or "https"
-	* when requested with TLS. When the proxy setting
-	* is enabled the "X-Forwarded-Proto" header
-	* field will be trusted. If you're running behind
-	* a reverse proxy that supplies https for you this
-	* may be enabled.
-	*/
-	get protocol() {
-		if (this.socket.encrypted) return "https";
-		if (!this.app.proxy) return "http";
-		let proto = this.get("X-Forwarded-Proto");
-		if (proto) proto = splitCommaSeparatedValues(proto, 1)[0];
-		return proto || "http";
-	}
-	/**
-	* Shorthand for:
-	*
-	*    this.protocol == 'https'
-	*/
-	get secure() {
-		return this.protocol === "https";
-	}
-	/**
-	* When `app.proxy` is `true`, parse
-	* the "X-Forwarded-For" ip address list.
-	*
-	* For example if the value was "client, proxy1, proxy2"
-	* you would receive the array `["client", "proxy1", "proxy2"]`
-	* where "proxy2" is the furthest down-stream.
-	*/
-	get ips() {
-		const proxy = this.app.proxy;
-		const val = this.get(this.app.proxyIpHeader);
-		let ips = proxy && val ? splitCommaSeparatedValues(val) : [];
-		if (this.app.maxIpsCount > 0) ips = ips.slice(-this.app.maxIpsCount);
-		return ips;
-	}
-	_ip;
-	/**
-	* Return request's remote address
-	* When `app.proxy` is `true`, parse
-	* the "X-Forwarded-For" ip address list and return the first one
-	*/
-	get ip() {
-		if (!this._ip) this._ip = this.ips[0] || this.socket.remoteAddress || "";
-		return this._ip;
-	}
-	set ip(ip) {
-		this._ip = ip;
-	}
-	/**
-	* Return subdomains as an array.
-	*
-	* Subdomains are the dot-separated parts of the host before the main domain
-	* of the app. By default, the domain of the app is assumed to be the last two
-	* parts of the host. This can be changed by setting `app.subdomainOffset`.
-	*
-	* For example, if the domain is "tobi.ferrets.example.com":
-	* If `app.subdomainOffset` is not set, this.subdomains is
-	* `["ferrets", "tobi"]`.
-	* If `app.subdomainOffset` is 3, this.subdomains is `["tobi"]`.
-	*/
-	get subdomains() {
-		const offset = this.app.subdomainOffset;
-		const hostname = this.hostname;
-		if (net.isIP(hostname)) return [];
-		return hostname.split(".").reverse().slice(offset);
-	}
-	_accept;
-	/**
-	* Get accept object.
-	* Lazily memoized.
-	*/
-	get accept() {
-		return this._accept || (this._accept = accepts(this.req));
-	}
-	/**
-	* Set accept object.
-	*/
-	set accept(obj) {
-		this._accept = obj;
-	}
-	accepts(args, ...others) {
-		return this.accept.types(args, ...others);
-	}
-	acceptsEncodings(encodings, ...others) {
-		if (!encodings) return this.accept.encodings();
-		if (Array.isArray(encodings)) encodings = [...encodings, ...others];
-		else encodings = [encodings, ...others];
-		return this.accept.encodings(...encodings);
-	}
-	acceptsCharsets(charsets, ...others) {
-		if (!charsets) return this.accept.charsets();
-		if (Array.isArray(charsets)) charsets = [...charsets, ...others];
-		else charsets = [charsets, ...others];
-		return this.accept.charsets(...charsets);
-	}
-	acceptsLanguages(languages, ...others) {
-		if (!languages) return this.accept.languages();
-		if (Array.isArray(languages)) languages = [...languages, ...others];
-		else languages = [languages, ...others];
-		return this.accept.languages(...languages);
-	}
-	/**
-	* Check if the incoming request contains the "Content-Type"
-	* header field and if it contains any of the given mime `type`s.
-	* If there is no request body, `null` is returned.
-	* If there is no content type, `false` is returned.
-	* Otherwise, it returns the first `type` that matches.
-	*
-	* Examples:
-	*
-	*     // With Content-Type: text/html; charset=utf-8
-	*     this.is('html'); // => 'html'
-	*     this.is('text/html'); // => 'text/html'
-	*     this.is('text/*', 'application/json'); // => 'text/html'
-	*
-	*     // When Content-Type is application/json
-	*     this.is('json', 'urlencoded'); // => 'json'
-	*     this.is('application/json'); // => 'application/json'
-	*     this.is('html', 'application/*'); // => 'application/json'
-	*
-	*     this.is('html'); // => false
-	*/
-	is(type, ...types) {
-		let testTypes = [];
-		if (type) testTypes = Array.isArray(type) ? type : [type];
-		return typeis(this.req, [...testTypes, ...types]);
-	}
-	/**
-	* Return the request mime type void of
-	* parameters such as "charset".
-	*/
-	get type() {
-		const type = this.get("Content-Type");
-		if (!type) return "";
-		return type.split(";")[0];
-	}
-	/**
-	* Return request header.
-	*
-	* The `Referrer` header field is special-cased,
-	* both `Referrer` and `Referer` are interchangeable.
-	*
-	* Examples:
-	*
-	*     this.get('Content-Type');
-	*     // => "text/plain"
-	*
-	*     this.get('content-type');
-	*     // => "text/plain"
-	*
-	*     this.get('Something');
-	*     // => ''
-	*/
-	get(field) {
-		const req = this.req;
-		switch (field = field.toLowerCase()) {
-			case "referer":
-			case "referrer": return req.headers.referrer || req.headers.referer || "";
-			default: return req.headers[field] || "";
-		}
-	}
-	/**
-	* Inspect implementation.
-	*/
-	inspect() {
-		if (!this.req) return;
-		return this.toJSON();
-	}
-	/**
-	* Custom inspection implementation for newer Node.js versions.
-	*/
-	[util.inspect.custom]() {
-		return this.inspect();
-	}
-	/**
-	* Return JSON representation.
-	*/
-	toJSON() {
-		return {
-			method: this.method,
-			url: this.url,
-			header: this.header
-		};
-	}
-};
-/**
-* Split a comma-separated value string into an array of values, with an optional limit.
-* All the values are trimmed of whitespace and filtered out empty values.
-*
-* @param {string} value - The comma-separated value string to split.
-* @param {number} [limit] - The maximum number of values to return.
-* @returns {string[]} An array of values from the comma-separated string.
-*/
-function splitCommaSeparatedValues(value, limit) {
-	return value.split(",", limit).map((v) => v.trim()).filter((v) => v.length > 0);
-}
-
-//#endregion
-export { Request };

package/dist/response.d.ts

@@ -1,231 +0,0 @@
-import { Request } from "./request.js";
-import { Context } from "./context.js";
-import { Application } from "./application.js";
-import util from "node:util";
-import Stream from "node:stream";
-import { IncomingMessage, ServerResponse } from "node:http";
-import { Options } from "content-disposition";
-import * as http14 from "http";
-import * as net0 from "net";
-
-//#region src/response.d.ts
-declare class Response {
-  [key: symbol]: unknown;
-  app: Application;
-  req: IncomingMessage;
-  res: ServerResponse;
-  ctx: Context;
-  request: Request;
-  constructor(app: Application, ctx: Context, req: IncomingMessage, res: ServerResponse);
-  /**
-   * Return the request socket.
-   */
-  get socket(): net0.Socket | null;
-  /**
-   * Return response header.
-   */
-  get header(): http14.OutgoingHttpHeaders;
-  /**
-   * Return response header, alias as response.header
-   */
-  get headers(): http14.OutgoingHttpHeaders;
-  _explicitStatus: boolean;
-  /**
-   * Get response status code.
-   */
-  get status(): number;
-  /**
-   * Set response status code.
-   */
-  set status(code: number);
-  /**
-   * Get response status message
-   */
-  get message(): string;
-  /**
-   * Set response status message
-   */
-  set message(msg: string);
-  _body: any;
-  _explicitNullBody: boolean;
-  /**
-   * Get response body.
-   */
-  get body(): string | Buffer | object | Stream | null | undefined | boolean;
-  /**
-   * Set response body.
-   */
-  set body(val: string | Buffer | object | Stream | null | undefined | boolean);
-  /**
-   * Set Content-Length field to `n`.
-   */
-  set length(n: number | string | undefined);
-  /**
-   * Return parsed response Content-Length when present.
-   *
-   * When Content-Length is not defined it will return `undefined`.
-   */
-  get length(): number | undefined;
-  /**
-   * Check if a header has been written to the socket.
-   */
-  get headerSent(): boolean;
-  /**
-   * Vary on `field`.
-   */
-  vary(field: string): void;
-  _getBackReferrer(): string | undefined;
-  /**
-   * Perform a 302 redirect to `url`.
-   *
-   * The string "back" is special-cased
-   * to provide Referrer support, when Referrer
-   * is not present `alt` or "/" is used.
-   *
-   * Examples:
-   *
-   *    this.redirect('back');
-   *    this.redirect('back', '/index.html');
-   *    this.redirect('/login');
-   *    this.redirect('http://google.com'); // will format to 'http://google.com/'
-   */
-  redirect(url: string, alt?: string): void;
-  /**
-   * Set Content-Disposition header to "attachment" with optional `filename`.
-   */
-  attachment(filename?: string, options?: Options): void;
-  /**
-   * Set Content-Type response header with `type` through `mime.lookup()`
-   * when it does not contain a charset.
-   *
-   * Examples:
-   *
-   *     this.type = '.html';
-   *     this.type = 'html';
-   *     this.type = 'json';
-   *     this.type = 'application/json';
-   *     this.type = 'png';
-   */
-  set type(type: string | null | undefined);
-  /**
-   * Return the response mime type void of
-   * parameters such as "charset".
-   */
-  get type(): string;
-  /**
-   * Check whether the response is one of the listed types.
-   * Pretty much the same as `this.request.is()`.
-   *
-   *     this.response.is('html')
-   *     this.response.is('html', 'json')
-   */
-  is(type?: string | string[], ...types: string[]): string | false;
-  /**
-   * Set the Last-Modified date using a string or a Date.
-   *
-   *     this.response.lastModified = new Date();
-   *     this.response.lastModified = '2013-09-13';
-   */
-  set lastModified(val: string | Date | undefined);
-  /**
-   * Get the Last-Modified date in Date form, if it exists.
-   */
-  get lastModified(): Date | undefined;
-  /**
-   * Set the ETag of a response.
-   * This will normalize the quotes if necessary.
-   *
-   *     this.response.etag = 'md5-hash-sum';
-   *     this.response.etag = '"md5-hash-sum"';
-   *     this.response.etag = 'W/"123456789"';
-   */
-  set etag(val: string);
-  /**
-   * Get the ETag of a response.
-   */
-  get etag(): string;
-  /**
-   * Return response header.
-   *
-   * Examples:
-   *
-   *     this.get('Content-Type');
-   *     // => "text/plain"
-   *
-   *     this.get('content-type');
-   *     // => "text/plain"
-   */
-  get<T = string | string[] | number>(field: string): T;
-  /**
-   * Returns true if the header identified by name is currently set in the outgoing headers.
-   * The header name matching is case-insensitive.
-   *
-   * Examples:
-   *
-   *     this.has('Content-Type');
-   *     // => true
-   *
-   *     this.get('content-type');
-   *     // => true
-   */
-  has(field: string): boolean;
-  /**
-   * Set header `field` to `val` or pass
-   * an object of header fields.
-   *
-   * Examples:
-   *
-   *    this.set('Foo', ['bar', 'baz']);
-   *    this.set('Accept', 'application/json');
-   *    this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
-   */
-  set(field: string | Record<string, string>, val?: string | number | unknown[]): void;
-  /**
-   * Append additional header `field` with value `val`.
-   *
-   * Examples:
-   *
-   * ```
-   * this.append('Link', ['<http://localhost/>', '<http://localhost:3000/>']);
-   * this.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly');
-   * this.append('Warning', '199 Miscellaneous warning');
-   */
-  append(field: string, val: string | string[]): void;
-  /**
-   * Remove header `field`.
-   */
-  remove(field: string): void;
-  /**
-   * Checks if the request is writable.
-   * Tests for the existence of the socket
-   * as node sometimes does not set it.
-   */
-  get writable(): boolean;
-  /**
-   * Inspect implementation.
-   */
-  inspect(): {
-    status: number;
-    message: string;
-    header: http14.OutgoingHttpHeaders;
-  } | undefined;
-  [util.inspect.custom](): {
-    status: number;
-    message: string;
-    header: http14.OutgoingHttpHeaders;
-  } | undefined;
-  /**
-   * Return JSON representation.
-   */
-  toJSON(): {
-    status: number;
-    message: string;
-    header: http14.OutgoingHttpHeaders;
-  };
-  /**
-   * Flush any set headers and begin the body
-   */
-  flushHeaders(): void;
-}
-//#endregion
-export { Response };