Extremely Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313// Copyright 2018-2020 the oak authors. All rights reserved. MIT license.
import { ServerRequest } from "./deps.ts";import { httpErrors } from "./httpError.ts";import { isMediaType } from "./isMediaType.ts";import { HTTPMethods } from "./types.ts";import { preferredCharsets } from "./negotiation/charset.ts";import { preferredEncodings } from "./negotiation/encoding.ts";import { preferredLanguages } from "./negotiation/language.ts";import { preferredMediaTypes } from "./negotiation/mediaType.ts";
export type BodyType = | "json" | "form" | "text" | "raw" | "undefined" | "reader";
export type BodyJson = { type: "json"; value: any };export type BodyForm = { type: "form"; value: URLSearchParams };export type BodyText = { type: "text"; value: string };export type BodyRaw = { type: "raw"; value: Uint8Array };export type BodyUndefined = { type: "undefined"; value: undefined };
export type BodyReader = { type: "reader"; value: Deno.Reader };
export type Body = | BodyJson | BodyForm | BodyText | BodyRaw | BodyUndefined;
export interface BodyOptions { /** If `true`, return a body value of `Deno.Reader`. */ asReader?: boolean;
/** A map of extra content types to determine how to parse the body. */ contentTypes?: { /** Content types listed here will always return a "raw" Uint8Array. */ raw?: string[]; /** Content types listed here will be parsed as a JSON string. */ json?: string[]; /** Content types listed here will be parsed as form data and return * `URLSearchParameters` as the value of the body. */ form?: string[]; /** Content types listed here will be parsed as text. */ text?: string[]; };}
export interface BodyOptionsAsReader extends BodyOptions { asReader: true;}
const decoder = new TextDecoder();
export interface BodyContentTypes { json?: string[]; form?: string[]; text?: string[];}
const defaultBodyContentTypes = { json: ["json", "application/*+json", "application/csp-report"], form: ["urlencoded"], text: ["text"],};
export class Request { #body?: Body | BodyReader; #rawBodyPromise?: Promise<Uint8Array>; #serverRequest: ServerRequest; #url?: URL;
/** Is `true` if the request has a body, otherwise `false`. */ get hasBody(): boolean { return ( this.headers.get("transfer-encoding") !== null || !!parseInt(this.headers.get("content-length") ?? "") ); }
/** The `Headers` supplied in the request. */ get headers(): Headers { return this.#serverRequest.headers; }
/** The HTTP Method used by the request. */ get method(): HTTPMethods { return this.#serverRequest.method as HTTPMethods; }
/** Shortcut to `request.url.protocol === "https"`. */ get secure(): boolean { return this.url.protocol === "https:"; }
/** Returns the _original_ Deno server request. */ get serverRequest(): ServerRequest { return this.#serverRequest; }
/** A parsed URL for the request which complies with the browser standards. */ get url(): URL { if (!this.#url) { const serverRequest = this.#serverRequest; const proto = serverRequest.proto.split("/")[0].toLowerCase(); this.#url = new URL( `${proto}://${serverRequest.headers.get("host")}${serverRequest.url}`, ); } return this.#url; }
constructor( serverRequest: ServerRequest, ) { this.#serverRequest = serverRequest; }
/** Returns an array of media types, accepted by the requestor, in order of * preference. If there are no encodings supplied by the requestor, * `undefined` is returned. */ accepts(): string[] | undefined; /** For a given set of media types, return the best match accepted by the * requestor. If there are no encoding that match, then the method returns * `undefined`. */ accepts(...types: string[]): string | undefined; accepts(...types: string[]): string | string[] | undefined { const acceptValue = this.#serverRequest.headers.get("Accept"); if (!acceptValue) { return; } if (types.length) { return preferredMediaTypes(acceptValue, types)[0]; } return preferredMediaTypes(acceptValue); }
/** Returns an array of charsets, accepted by the requestor, in order of * preference. If there are no charsets supplied by the requestor, * `undefined` is returned. */ acceptsCharsets(): string[] | undefined; /** For a given set of charsets, return the best match accepted by the * requestor. If there are no charsets that match, then the method returns * `undefined`. */ acceptsCharsets(...charsets: string[]): string | undefined; acceptsCharsets(...charsets: string[]): string[] | string | undefined { const acceptCharsetValue = this.#serverRequest.headers.get( "Accept-Charset", ); if (!acceptCharsetValue) { return; } if (charsets.length) { return preferredCharsets(acceptCharsetValue, charsets)[0]; } return preferredCharsets(acceptCharsetValue); }
/** Returns an array of encodings, accepted by the requestor, in order of * preference. If there are no encodings supplied by the requestor, * `undefined` is returned. */ acceptsEncodings(): string[] | undefined; /** For a given set of encodings, return the best match accepted by the * requestor. If there are no encodings that match, then the method returns * `undefined`. * * **NOTE:** You should always supply `identity` as one of the encodings * to ensure that there is a match when the `Accept-Encoding` header is part * of the request. */ acceptsEncodings(...encodings: string[]): string | undefined; acceptsEncodings(...encodings: string[]): string[] | string | undefined { const acceptEncodingValue = this.#serverRequest.headers.get( "Accept-Encoding", ); if (!acceptEncodingValue) { return; } if (encodings.length) { return preferredEncodings(acceptEncodingValue, encodings)[0]; } return preferredEncodings(acceptEncodingValue); }
/** Returns an array of languages, accepted by the requestor, in order of * preference. If there are no languages supplied by the requestor, * `undefined` is returned. */ acceptsLanguages(): string[] | undefined; /** For a given set of languages, return the best match accepted by the * requestor. If there are no languages that match, then the method returns * `undefined`. */ acceptsLanguages(...langs: string[]): string | undefined; acceptsLanguages(...langs: string[]): string[] | string | undefined { const acceptLanguageValue = this.#serverRequest.headers.get( "Accept-Language", ); if (!acceptLanguageValue) { return; } if (langs.length) { return preferredLanguages(acceptLanguageValue, langs)[0]; } return preferredLanguages(acceptLanguageValue); }
/** If there is a body in the request, resolves with an object which * describes the body. The `type` provides what type the body is and `body` * provides the actual body. * * If you need access to the "raw" interface for the body, pass `true` as the * first argument and the method will resolve if the `Deno.Reader`. * * app.use(async (ctx) => { * const result = await ctx.request.body(true); * const body = await Deno.readAll(result.body); * }); * */ async body(options: BodyOptionsAsReader): Promise<BodyReader>; /** If there is a body in the request, resolves with an object which * describes the body. The `type` provides what type the body is and `body` * provides the actual body. * * If you need access to the "raw" interface for the body, pass `true` as the * first argument and the method will resolve if the `Deno.Reader`. * * app.use(async (ctx) => { * const result = await ctx.request.body(true); * const body = await Deno.readAll(result.body); * }); * */ async body(options?: BodyOptions): Promise<Body>; async body( { asReader, contentTypes = {} }: BodyOptions = {}, ): Promise<Body | BodyReader> { if (this.#body) { if (asReader && this.#body.type !== "reader") { return Promise.reject( new TypeError(`Body already consumed as type: "${this.#body.type}".`), ); } else if (this.#body.type === "reader") { return Promise.reject( new TypeError(`Body already consumed as type: "reader".`), ); } return this.#body; } const encoding = this.headers.get("content-encoding") || "identity"; if (encoding !== "identity") { throw new httpErrors.UnsupportedMediaType( `Unsupported content-encoding: ${encoding}`, ); } if (!this.hasBody) { return (this.#body = { type: "undefined", value: undefined }); } const contentType = this.headers.get("content-type"); if (contentType) { if (asReader) { return (this.#body = { type: "reader", value: this.#serverRequest.body, }); } const rawBody = await (this.#rawBodyPromise ?? (this.#rawBodyPromise = Deno.readAll(this.#serverRequest.body))); const value = decoder.decode(rawBody); const contentTypesRaw = contentTypes.raw; const contentTypesJson = [ ...defaultBodyContentTypes.json, ...(contentTypes.json ?? []), ]; const contentTypesForm = [ ...defaultBodyContentTypes.form, ...(contentTypes.form ?? []), ]; const contentTypesText = [ ...defaultBodyContentTypes.text, ...(contentTypes.text ?? []), ]; if (contentTypesRaw && isMediaType(contentType, contentTypesRaw)) { return (this.#body = { type: "raw", value: rawBody }); } else if (isMediaType(contentType, contentTypesJson)) { return (this.#body = { type: "json", value: JSON.parse(value) }); } else if (isMediaType(contentType, contentTypesForm)) { return (this.#body = { type: "form", value: new URLSearchParams(value.replace(/\+/g, " ")), }); } else if (isMediaType(contentType, contentTypesText)) { return (this.#body = { type: "text", value }); } else { return (this.#body = { type: "raw", value: rawBody }); } } throw new httpErrors.UnsupportedMediaType( contentType ? `Unsupported content-type: ${contentType}` : "Missing content-type", ); }}