@h3ravel/http 11.7.6 → 11.8.0-alpha.1

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 /// <reference path="./app.globals.d.ts" />
 import { Command } from "@h3ravel/musket";
+import * as _h3ravel_contracts0 from "@h3ravel/contracts";
+import { CacheOptions, ClassConstructor, DotNestedKeys, DotNestedValue, GenericObject, IApplication, IHeaderBag, IHttpContext, IHttpResponse, IMiddleware, IParamBag, IRequest, IResponsable, IResponse, IRoute, ISessionManager, IUrl, MessagesForRules, RequestMethod, RequestObject, ResponseObject, RulesForData } from "@h3ravel/contracts";
 import { DateTime } from "@h3ravel/support";
 import { EventHandlerRequest, H3Event, HTTPResponse } from "h3";
-import { DotNestedKeys, DotNestedValue, HttpContext as HttpContext$1, IApplication, IMiddleware, IParamBag, IRequest, IResponse, RequestMethod, RequestObject, ResponseObject } from "@h3ravel/shared";
-import { Application } from "@h3ravel/core";
-import { Url } from "@h3ravel/url";
+import { ResponseCodes } from "@h3ravel/foundation";
 
 //#region src/Commands/FireCommand.d.ts
 declare class FireCommand extends Command {
@@ -24,24 +24,6 @@ declare class FireCommand extends Command {
   protected fire(): Promise<void>;
 }
 //#endregion
-//#region src/Contracts/HttpContract.d.ts
-type CacheOptions = Partial<{
-  must_revalidate: boolean;
-  no_cache: boolean;
-  no_store: boolean;
-  no_transform: boolean;
-  public: boolean;
-  private: boolean;
-  proxy_revalidate: boolean;
-  max_age: number;
-  s_maxage: number;
-  immutable: boolean;
-  stale_while_revalidate: number;
-  stale_if_error: number;
-  last_modified: string | Date;
-  etag: string;
-}>;
-//#endregion
 //#region src/Exceptions/BadRequestException.d.ts
 declare class BadRequestException extends Error {
   constructor(message: string);
@@ -55,9 +37,9 @@ declare class ConflictingHeadersException extends Error {
 //#region src/Utilities/HeaderBag.d.ts
 /**
  * HeaderBag — A container for HTTP headers
- * for Node/H3 environments.
+ * for H3ravel App.
  */
-declare class HeaderBag implements Iterable<[string, (string | null)[]]> {
+declare class HeaderBag extends IHeaderBag {
   protected static readonly UPPER = "_ABCDEFGHIJKLMNOPQRSTUVWXYZ";
   protected static readonly LOWER = "-abcdefghijklmnopqrstuvwxyz";
   protected headers: Record<string, (string | null)[]>;
@@ -102,7 +84,7 @@ declare class HeaderBag implements Iterable<[string, (string | null)[]]> {
    * @param defaultValue
    * @returns
    */
-  get<R = undefined>(key: string, defaultValue?: string | null): R extends undefined ? string | null : R;
+  get<R = undefined>(key: string, defaultValue?: string | null | undefined): R extends undefined ? string | null | undefined : R;
   /**
    * Sets a header by name.
    *
@@ -312,7 +294,7 @@ declare class ResponseHeaderBag extends HeaderBag {
 }
 //#endregion
 //#region src/Utilities/HttpResponse.d.ts
-declare class HttpResponse {
+declare class HttpResponse extends IHttpResponse {
   /**
    * The current H3 H3Event instance
    */
@@ -624,13 +606,13 @@ declare class HttpResponse {
    * compliant with RFC 2616. Most of the changes are based on
    * the Request that is "associated" with this Response.
    **/
-  prepare(request: Request): this;
+  prepare(request: IRequest): this;
   /**
    * Checks if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9.
    *
    * @see http://support.microsoft.com/kb/323308
    */
-  protected ensureIEOverSSLCompatibility(request: Request): void;
+  protected ensureIEOverSSLCompatibility(request: IRequest): void;
 }
 //#endregion
 //#region src/Exceptions/HttpResponseException.d.ts
@@ -708,11 +690,12 @@ declare class FormRequest {
  * Represents the HTTP context for a single request lifecycle.
  * Encapsulates the application instance, request, and response objects.
  */
-declare class HttpContext implements HttpContext$1 {
+declare class HttpContext extends IHttpContext {
   app: IApplication;
   request: IRequest;
   response: IResponse;
   private static contexts;
+  event: H3Event;
   constructor(app: IApplication, request: IRequest, response: IResponse);
   /**
    * Factory method to create a new HttpContext instance from a context object.
@@ -723,7 +706,7 @@ declare class HttpContext implements HttpContext$1 {
     app: IApplication;
     request: IRequest;
     response: IResponse;
-  }, event?: unknown): HttpContext;
+  }, event?: H3Event): HttpContext;
   /**
    * Retrieve an existing HttpContext instance for an event, if any.
    */
@@ -734,16 +717,236 @@ declare class HttpContext implements HttpContext$1 {
   static forget(event: unknown): void;
 }
 //#endregion
+//#region src/Utilities/Responsable.d.ts
+declare class Responsable extends IResponsable {
+  toResponse(request: IRequest): IResponse;
+  HTTPResponse(): HTTPResponse;
+}
+//#endregion
+//#region src/Response.d.ts
+declare class Response extends HttpResponse implements IResponse {
+  app: IApplication;
+  static codes: typeof ResponseCodes;
+  private initializationData;
+  /**
+   * The current Http Context
+   */
+  context: IHttpContext;
+  /**
+   *
+   * @param app The current app instance
+   * @param content The current H3 H3Event instance
+   * @param status The http status code
+   * @param headers The http headers
+   */
+  constructor(app: IApplication, content: H3Event);
+  constructor(app: IApplication, content: string, status?: ResponseCodes, headers?: Record<string, (string | null)[] | string>);
+  /**
+   * Sends content for the current web response.
+   */
+  sendContent(type?: 'html' | 'json' | 'text' | 'xml', parse?: boolean): Responsable;
+  /**
+   * Sends content for the current web response.
+   */
+  send(type?: 'html' | 'json' | 'text' | 'xml'): Responsable;
+  /**
+   * Use an edge view as content
+   *
+   * @param viewPath The path to the view file
+   * @param send if set to true, the content will be returned, instead of the Response instance
+   * @returns
+   */
+  view(viewPath: string, data?: Record<string, any> | undefined): Promise<this>;
+  view(viewPath: string, data: Record<string, any> | undefined, parse: boolean): Promise<Responsable>;
+  /**
+   *
+   * Parse content as edge view
+   *
+   * @param content The content to serve
+   * @param send if set to true, the content will be returned, instead of the Response instance
+   * @returns
+   */
+  viewTemplate(content: string, data?: Record<string, any> | undefined): Promise<this>;
+  viewTemplate(content: string, data: Record<string, any> | undefined, parse: boolean): Promise<Responsable>;
+  /**
+   *
+   * @param content The content to serve
+   * @param send if set to true, the content will be returned, instead of the Response instance
+   * @returns
+   */
+  html(content?: string): this;
+  html(content: string, parse: boolean): Responsable;
+  /**
+   * Send a JSON response.
+   */
+  json<T = unknown>(data?: T): this;
+  json<T = unknown>(data: T, parse: boolean): Responsable;
+  /**
+   * Send plain text.
+   */
+  text(content?: string): this;
+  text(content: string, parse: boolean): Responsable;
+  /**
+   * Send plain xml.
+   */
+  xml(data?: string): this;
+  xml(data: string, parse: boolean): Responsable;
+  /**
+   * Build the HTTP Response
+   *
+   * @param contentType
+   * @param data
+   */
+  private httpResponse;
+  /**
+   * Redirect to another URL.
+   */
+  redirect(location: string, status?: number, statusText?: string | undefined): this;
+  /**
+   * Dump the response.
+   */
+  dump(): this;
+  /**
+   * Get the base event
+   */
+  getEvent(): H3Event;
+  getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
+  /**
+   * Reset the response class to it's defautl
+   */
+  reset(): this;
+}
+//#endregion
+//#region src/JsonResponse.d.ts
+type Data = string | number | GenericObject | ClassConstructor | any[];
+/**
+ * Response represents an HTTP response in JSON format.
+ *
+ * Note that this class does not force the returned JSON content to be an
+ * object. It is however recommended that you do return an object as it
+ * protects yourself against XSSI and JSON-JavaScript Hijacking.
+ *
+ * @see https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/AJAX_Security_Cheat_Sheet.md#always-return-json-with-an-object-on-the-outside
+ */
+declare class JsonResponse extends Response {
+  protected data: Data;
+  protected callback?: string;
+  /**
+   * @param bool $json If the data is already a JSON string
+   */
+  constructor(app: IApplication, data?: Data, status?: ResponseCodes, headers?: Record<string, (string | null)[] | string>, json?: boolean);
+  /**
+   * Sets the JSONP callback.
+   *
+   * @param  callback The JSONP callback or null to use none
+   *
+   * @throws {InvalidArgumentException} When the callback name is not valid
+   */
+  setCallback(callback?: string): this;
+  /**
+   * Factory method for chainability.
+   *
+   * @example
+   *
+   * return JsonResponse.fromJsonString('{"key": "value"}').setSharedMaxAge(300);
+   *
+   * @param  data    The JSON response string
+   * @param  status  The response status code (200 "OK" by default)
+   * @param  headers An array of response headers
+   */
+  static fromJsonString(app: IApplication, data: string, status?: ResponseCodes, headers?: Record<string, (string | null)[] | string>): JsonResponse;
+  /**
+   * Sets a raw string containing a JSON document to be sent.
+   *
+   * @param json
+   * @returns
+   */
+  setJson(json: Data): this;
+  /**
+   * Sets the data to be sent as JSON.
+   *
+   * @param data
+   * @returns
+   */
+  setData(data?: any): this;
+  /**
+   * Get the json_decoded data from the response.
+   *
+   * @param  assoc
+   */
+  getData(): any;
+  /**
+   * Sets the JSONP callback.
+   *
+   * @param  callback
+   */
+  withCallback(callback?: string): this;
+  /**
+   * Updates the content and headers according to the JSON data and callback.
+   */
+  protected update(): this;
+}
+//#endregion
 //#region src/Middleware.d.ts
-declare abstract class Middleware implements IMiddleware {
-  abstract handle(context: HttpContext, next: () => Promise<unknown>): Promise<unknown>;
+declare abstract class Middleware extends IMiddleware {
+  protected app?: IApplication | undefined;
+  constructor(app?: IApplication | undefined);
+}
+//#endregion
+//#region src/Middleware/FlashDataMiddleware.d.ts
+declare class FlashDataMiddleware extends Middleware {
+  handle(request: Request, next: (request: Request) => Promise<unknown>): Promise<unknown>;
 }
 //#endregion
 //#region src/Middleware/LogRequests.d.ts
 declare class LogRequests extends Middleware {
-  handle({
-    request
-  }: HttpContext, next: () => Promise<unknown>): Promise<unknown>;
+  handle(request: IRequest, next: (request: IRequest) => Promise<unknown>): Promise<unknown>;
+}
+//#endregion
+//#region src/Middleware/TrustHosts.d.ts
+declare class TrustHosts extends Middleware {
+  /**
+   * The trusted hosts that have been configured to always be trusted.
+   */
+  protected static alwaysTrust?: string[] | ((...arg: any[]) => string[]);
+  /**
+   * Indicates whether subdomains of the application URL should be trusted.
+   */
+  protected static subdomains?: boolean;
+  /**
+   * Get the host patterns that should be trusted.
+   */
+  hosts(): (string | undefined)[];
+  /**
+   * Handle the incoming request.
+   *
+   * @param  request
+   * @param  next
+   */
+  handle(request: Request, next: (request: Request) => Promise<unknown>): Promise<unknown>;
+  /**
+   * Specify the hosts that should always be trusted.
+   *
+   * @param  hosts
+   * @param  subdomains
+   */
+  static at(hosts: string[] | ((...arg: any[]) => string[]), subdomains?: boolean): void;
+  /**
+   * Determine if the application should specify trusted hosts.
+   *
+   * @return bool
+   */
+  protected shouldSpecifyTrustedHosts(): boolean;
+  /**
+   * Get a regular expression matching the application URL and all of its subdomains.
+   */
+  protected allSubdomainsOfApplicationUrl(): string | undefined;
+  /**
+   * Flush the state of the middleware.
+   *
+   * @return void
+   */
+  static flushState(): void;
 }
 //#endregion
 //#region src/Providers/HttpServiceProvider.d.ts
@@ -760,7 +963,7 @@ declare class HttpServiceProvider {
   private app;
   static priority: number;
   registeredCommands?: (new (app: any, kernel: any) => any)[];
-  constructor(app: any);
+  constructor(app: IApplication);
   register(): void;
   boot(): void;
 }
@@ -784,7 +987,7 @@ declare class ParamBag implements IParamBag {
   /**
    * Returns the parameters.
    * @
-   * @param key The name of the parameter to return or null to get them all
+   * @param key The name of the parameter to return or undefined to get them all
    *
    * @throws BadRequestException if the value is not an array
    */
@@ -1029,11 +1232,30 @@ declare class FileBag extends ParamBag {
  * from the incoming request.
  */
 declare class ServerBag extends ParamBag {
+  private static serverData;
   constructor(parameters: Record<string, string | undefined> | undefined,
   /**
    * The current H3 H3Event instance
    */
   event: H3Event);
+  static initialize(event: H3Event, headers: Record<string, string>): {
+    SERVER_PROTOCOL?: string;
+    REQUEST_METHOD?: string;
+    REQUEST_URI?: string;
+    PATH_INFO?: string;
+    QUERY_STRING?: string;
+    SERVER_NAME?: string;
+    SERVER_PORT?: string;
+    REMOTE_ADDR?: string;
+    REMOTE_PORT?: string;
+    HTTP_HOST?: string;
+    HTTP_USER_AGENT?: string;
+    HTTP_ACCEPT?: string;
+    HTTP_ACCEPT_LANGUAGE?: string;
+    HTTP_ACCEPT_ENCODING?: string;
+    HTTP_REFERER?: string;
+    HTTPS?: string;
+  };
   /**
    * Returns all request headers, normalized to uppercase with underscores.
    * Example: content-type → CONTENT_TYPE
@@ -1059,25 +1281,25 @@ declare class HttpRequest {
   /**
    * The current app instance
    */
-  app: Application;
-  HEADER_FORWARDED: number;
-  HEADER_X_FORWARDED_FOR: number;
-  HEADER_X_FORWARDED_HOST: number;
-  HEADER_X_FORWARDED_PROTO: number;
-  HEADER_X_FORWARDED_PORT: number;
-  HEADER_X_FORWARDED_PREFIX: number;
-  HEADER_X_FORWARDED_AWS_ELB: number;
-  HEADER_X_FORWARDED_TRAEFIK: number;
-  METHOD_HEAD: string;
-  METHOD_GET: string;
-  METHOD_POST: string;
-  METHOD_PUT: string;
-  METHOD_PATCH: string;
-  METHOD_DELETE: string;
-  METHOD_PURGE: string;
-  METHOD_OPTIONS: string;
-  METHOD_TRACE: string;
-  METHOD_CONNECT: string;
+  app: IApplication;
+  static HEADER_FORWARDED: number;
+  static HEADER_X_FORWARDED_FOR: number;
+  static HEADER_X_FORWARDED_HOST: number;
+  static HEADER_X_FORWARDED_PROTO: number;
+  static HEADER_X_FORWARDED_PORT: number;
+  static HEADER_X_FORWARDED_PREFIX: number;
+  static HEADER_X_FORWARDED_AWS_ELB: number;
+  static HEADER_X_FORWARDED_TRAEFIK: number;
+  static METHOD_HEAD: string;
+  static METHOD_GET: string;
+  static METHOD_POST: string;
+  static METHOD_PUT: string;
+  static METHOD_PATCH: string;
+  static METHOD_DELETE: string;
+  static METHOD_PURGE: string;
+  static METHOD_OPTIONS: string;
+  static METHOD_TRACE: string;
+  static METHOD_CONNECT: string;
   /**
    * Names for headers that can be trusted when
    * using trusted proxies.
@@ -1094,10 +1316,16 @@ declare class HttpRequest {
    */
   body: unknown;
   protected format?: string;
+  protected basePath?: string;
+  protected baseUrl?: string;
+  protected requestUri?: string;
+  protected pathInfo?: string;
   protected formData: FormRequest;
   private preferredFormat?;
   private isForwardedValid;
+  static trustedHosts: string[];
   private static trustedHeaderSet;
+  protected static trustedHostPatterns: RegExp[];
   /**
    * Gets route parameters.
    * @returns An object containing route parameters.
@@ -1116,15 +1344,19 @@ declare class HttpRequest {
   /**
    * Query string parameters (GET).
    */
-  query: InputBag;
+  _query: InputBag;
   /**
    * Server and execution environment parameters
    */
-  server: ServerBag;
+  _server: ServerBag;
   /**
    * Cookies
    */
   cookies: InputBag;
+  /**
+   * The current Http Context
+   */
+  context: IHttpContext;
   /**
    * The request attributes (parameters parsed from the PATH_INFO, ...).
    */
@@ -1138,6 +1370,8 @@ declare class HttpRequest {
   protected static formats?: Record<string, string[]> | undefined | null;
   protected static trustedProxies: string[];
   protected static httpMethodParameterOverride: boolean;
+  protected sessionManager: ISessionManager;
+  protected sessionManagerClass: typeof ISessionManager;
   /**
    * List of Acceptable Content Types
    */
@@ -1151,7 +1385,7 @@ declare class HttpRequest {
   /**
    * The current app instance
    */
-  app: Application);
+  app: IApplication);
   /**
    * Sets the parameters for this request.
    *
@@ -1163,7 +1397,8 @@ declare class HttpRequest {
    * @param server     The SERVER parameters
    * @param content    The raw body data
    */
-  initialize(): Promise<void>;
+  initialize(): void;
+  protected buildRequirements(): void;
   /**
    * Gets a list of content types acceptable by the client browser in preferable order.
    * @returns {string[]}
@@ -1172,7 +1407,82 @@ declare class HttpRequest {
   /**
    * Get a URI instance for the request.
    */
-  getUriInstance(): Url;
+  getUriInstance(): IUrl;
+  /**
+   * Returns the requested URI (path and query string).
+   *
+   * @return {string} The raw URI (i.e. not URI decoded)
+   */
+  getRequestUri(): string;
+  /**
+   * Gets the scheme and HTTP host.
+   *
+   * If the URL was called with basic authentication, the user
+   * and the password are not added to the generated string.
+   */
+  getSchemeAndHttpHost(): string;
+  /**
+   * Returns the HTTP host being requested.
+   *
+   * The port name will be appended to the host if it's non-standard.
+   */
+  getHttpHost(): string;
+  /**
+   * Returns the root path from which this request is executed.
+   *
+   * @returns {string} The raw path (i.e. not urldecoded)
+   */
+  getBasePath(): string;
+  /**
+   * Returns the root URL from which this request is executed.
+   *
+   * The base URL never ends with a /.
+   *
+   * This is similar to getBasePath(), except that it also includes the
+   * script filename (e.g. index.php) if one exists.
+   *
+   * @return string The raw URL (i.e. not urldecoded)
+   */
+  getBaseUrl(): string;
+  /**
+   * Returns the real base URL received by the webserver from which this request is executed.
+   * The URL does not include trusted reverse proxy prefix.
+   *
+   * @return string The raw URL (i.e. not urldecoded)
+   */
+  private getBaseUrlReal;
+  /**
+   * Gets the request's scheme.
+   */
+  getScheme(): string;
+  /**
+   * Prepares the base URL.
+   */
+  protected prepareBaseUrl(): string;
+  /**
+   * Prepares the Request URI.
+   */
+  protected prepareRequestUri(): string;
+  /**
+   * Prepares the base path.
+   */
+  protected prepareBasePath(): string;
+  /**
+   * Prepares the path info.
+   */
+  protected preparePathInfo(): string;
+  /**
+   * Returns the port on which the request is made.
+   *
+   * This method can read the client port from the "X-Forwarded-Port" header
+   * when trusted proxies were set via "setTrustedProxies()".
+   *
+   * The "X-Forwarded-Port" header must contain the client port.
+   *
+   * @return int|string|null Can be a string if fetched from the server bag
+   */
+  getPort(): number | string | undefined;
+  getHost(): string;
   /**
    * Checks whether the request is secure or not.
    *
@@ -1182,6 +1492,13 @@ declare class HttpRequest {
    * The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".
    */
   isSecure(): boolean;
+  /**
+   * Is this IIS with UrlRewriteModule?
+   *
+   * This method consumes, caches and removed the IIS_WasUrlRewritten env var,
+   * so we don't inherit it to sub-requests.
+   */
+  private isIisRewrite;
   /**
    * Returns the value of the requested header.
    */
@@ -1212,6 +1529,10 @@ declare class HttpRequest {
    * Returns true if the request is an XMLHttpRequest (AJAX).
    */
   isXmlHttpRequest(): boolean;
+  /**
+   * See https://url.spec.whatwg.org/.
+   */
+  private static isHostValid;
   /**
    * Initializes HTTP request formats.
    */
@@ -1305,11 +1626,37 @@ declare class HttpRequest {
   isFromTrustedProxy(): boolean;
   /**
    * This method is rather heavy because it splits and merges headers, and it's called by many other methods such as
-   * getPort(), isSecure(), getHost(), getClientIps(), getBaseUrl() etc. Thus, we try to cache the results for
+   * getPort(), isSecure(), getHost(), getClientIps(), this.() etc. Thus, we try to cache the results for
    * best performance.
    */
   private getTrustedValues;
+  /**
+   *
+   * @param clientIps
+   * @param ip
+   * @returns
+   */
   private normalizeAndFilterClientIps;
+  /**
+   * Sets a list of trusted host patterns.
+   *
+   * You should only list the hosts you manage using regexes.
+   *
+   * @param hostPatterns
+   */
+  static setTrustedHosts(hostPatterns: string[]): void;
+  /**
+   * Returns the path being requested relative to the executed script.
+   *
+   * The path info always starts with a /.
+   *
+   * @return {string} The raw path (i.e. not urldecoded)
+   */
+  getPathInfo(): string;
+  /**
+   * Gets the list of trusted host patterns.
+   */
+  static getTrustedHosts(): RegExp[];
   /**
    * Enables support for the _method request parameter to determine the intended HTTP method.
    *
@@ -1329,12 +1676,20 @@ declare class HttpRequest {
 }
 //#endregion
 //#region src/Request.d.ts
-declare class Request extends HttpRequest implements IRequest {
+declare class Request<D extends Record<string, any> = Record<string, any>, R extends RulesForData<D> = RulesForData<D>, U extends Record<string, any> = Record<string, any>> extends HttpRequest implements IRequest<D, R> {
   #private;
   /**
    * All of the converted files for the request.
    */
   protected convertedFiles?: Record<string, UploadedFile | UploadedFile[]>;
+  /**
+   * The route resolver callback.
+   */
+  protected routeResolver?: () => IRoute;
+  /**
+   * The user resolver callback.
+   */
+  protected userResolver?: (guard?: string) => U;
   constructor(
   /**
    * The current H3 H3Event instance
@@ -1343,7 +1698,7 @@ declare class Request extends HttpRequest implements IRequest {
   /**
    * The current app instance
    */
-  app: Application);
+  app: IApplication);
   /**
    * Factory method to create a Request instance from an H3Event.
    */
@@ -1355,8 +1710,28 @@ declare class Request extends HttpRequest implements IRequest {
   /**
    * The current app instance
    */
-  app: Application): Promise<Request>;
+  app: IApplication): Promise<Request<Record<string, any>, Partial<Record<string, _h3ravel_contracts0.ValidationRuleSet>>, Record<string, any>>>;
+  /**
+   * Factory method to create a syncronous Request instance from an H3Event.
+   */
+  static createSync(
+  /**
+   * The current H3 H3Event instance
+   */
+  event: H3Event,
+  /**
+   * The current app instance
+   */
+  app: IApplication): Request<Record<string, any>, Partial<Record<string, _h3ravel_contracts0.ValidationRuleSet>>, Record<string, any>>;
   private setBody;
+  /**
+   * Validate the incoming request data
+   *
+   * @param data
+   * @param rules
+   * @param messages
+   */
+  validate(rules: R, messages?: Partial<Record<MessagesForRules<R>, string>>): Promise<D>;
   /**
    * Retrieve all data from the instance (query + body).
    */
@@ -1382,7 +1757,24 @@ declare class Request extends HttpRequest implements IRequest {
    * @param expectArray set to true to return an `UploadedFile[]` array.
    * @returns
    */
-  file<K extends string | undefined = undefined, E extends boolean | undefined = undefined>(key?: K, defaultValue?: any, expectArray?: E): K extends undefined ? Record<string, E extends true ? UploadedFile[] : UploadedFile> : E extends true ? UploadedFile[] : UploadedFile;
+  file(): Record<string, UploadedFile>;
+  file(key?: undefined, defaultValue?: any, expectArray?: true): Record<string, UploadedFile[]>;
+  file(key: string, defaultValue?: any, expectArray?: false | undefined): UploadedFile;
+  file(key: string, defaultValue?: any, expectArray?: true): UploadedFile[];
+  /**
+   * Get the user making the request.
+   *
+   * @param  guard
+   */
+  user(guard?: string): U | undefined;
+  /**
+   * Get the route handling the request.
+   *
+   * @param  param
+   * @param  defaultRoute
+   */
+  route(): IRoute;
+  route(param?: string, defaultParam?: any): any;
   /**
    * Determine if the uploaded data contains a file.
    *
@@ -1405,6 +1797,10 @@ declare class Request extends HttpRequest implements IRequest {
      * Extract and convert uploaded files from FormData.
      */
   convertUploadedFiles(files: Record<string, UploadedFile | UploadedFile[]>): Record<string, UploadedFile | UploadedFile[]>;
+  /**
+   * Get the current decoded path info for the request.
+   */
+  decodedPath(): string;
   /**
    * Determine if the data contains a given key.
    *
@@ -1423,6 +1819,10 @@ declare class Request extends HttpRequest implements IRequest {
    * @returns
    */
   only<T = Record<string, any>>(keys: string[]): T;
+  /**
+   * Determine if the request is over HTTPS.
+   */
+  secure(): boolean;
   /**
    * Get all of the data except for a specified array of items.
    *
@@ -1447,6 +1847,26 @@ declare class Request extends HttpRequest implements IRequest {
    * Get the keys for all of the input and files.
    */
   keys(): string[];
+  /**
+   * Get an instance of the current session manager
+   *
+   * @param key
+   * @param defaultValue
+   * @returns a global instance of the current session manager.
+   */
+  session<K extends string | Record<string, any> | undefined = undefined>(key?: K, defaultValue?: any): K extends undefined ? ISessionManager : K extends string ? any : void | Promise<void>;
+  /**
+   * Get the host name.
+   */
+  host(): string;
+  /**
+   * Get the HTTP host being requested.
+   */
+  httpHost(): string;
+  /**
+   * Get the scheme and HTTP host.
+   */
+  schemeAndHttpHost(): string;
   /**
    * Determine if the request is sending JSON.
    *
@@ -1482,14 +1902,39 @@ declare class Request extends HttpRequest implements IRequest {
    * Get the client IP address.
    */
   ip(): string | undefined;
+  /**
+   * Get the flashed input from previous request
+   *
+   * @param key
+   * @param defaultValue
+   * @returns
+   */
+  old(): Promise<Record<string, any>>;
+  old(key: string, defaultValue?: any): Promise<any>;
   /**
    * Get a URI instance for the request.
    */
-  uri(): Url;
+  uri(): IUrl;
+  /**
+   * Get the root URL for the application.
+   *
+   * @return string
+   */
+  root(): string;
+  /**
+   * Get the URL (no query string) for the request.
+   *
+   * @return string
+   */
+  url(): string;
   /**
    * Get the full URL for the request.
    */
   fullUrl(): string;
+  /**
+   * Get the current path info for the request.
+   */
+  path(): string;
   /**
    * Return the Request instance.
    */
@@ -1506,12 +1951,98 @@ declare class Request extends HttpRequest implements IRequest {
    * @return {InputBag}
    */
   json<K extends string | undefined = undefined>(key?: string, defaultValue?: any): K extends undefined ? InputBag : any;
+  /**
+   * Get the user resolver callback.
+   */
+  getUserResolver(): ((gaurd?: string) => U | undefined);
+  /**
+   * Set the user resolver callback.
+   *
+   * @param  callback
+   */
+  setUserResolver(callback: (gaurd?: string) => U): this;
+  /**
+   * Get the route resolver callback.
+   */
+  getRouteResolver(): () => IRoute | undefined;
+  /**
+   * Set the route resolver callback.
+   *
+   * @param  callback
+   */
+  setRouteResolver(callback: () => IRoute): this;
+  /**
+   * Get the bearer token from the request headers.
+   */
+  bearerToken(): string | undefined;
+  /**
+   * Retrieve data from the instance.
+   *
+   * @param  key
+   * @param  defaultValue
+   */
+  protected data(key?: string, defaultValue?: any): any;
+  /**
+   * Retrieve a request payload item from the request.
+   *
+   * @param  key
+   * @param  default
+   */
+  post(key?: string, defaultValue?: any): any;
+  /**
+   * Determine if a header is set on the request.
+   *
+   * @param  key
+   */
+  hasHeader(key: string): boolean;
+  /**
+   * Retrieve a header from the request.
+   *
+   * @param  key
+   * @param  default
+   */
+  header(key?: string, defaultValue?: any): any;
+  /**
+   * Determine if a cookie is set on the request.
+   *
+   * @param  string  $key
+   */
+  hasCookie(key: string): boolean;
+  /**
+   * Retrieve a cookie from the request.
+   *
+   * @param  key
+   * @param  default
+   */
+  cookie(key?: string, defaultValue?: any): any;
+  /**
+   * Retrieve a query string item from the request.
+   *
+   * @param  key
+   * @param  default
+   */
+  query(key?: string, defaultValue?: any): any;
+  /**
+   * Retrieve a server variable from the request.
+   *
+   * @param  key
+   * @param  default
+   */
+  server(key?: string, defaultValue?: any): any;
   /**
    * Get the input source for the request.
    *
    * @return {InputBag}
    */
   protected getInputSource(): InputBag;
+  /**
+   * Retrieve a parameter item from a given source.
+   *
+   * @param  source
+   * @param  key
+   * @param  defaultValue
+   */
+  protected retrieveItem(source: 'cookies' | '_server' | 'request' | '_query' | 'headers' | 'files' | 'attributes', key?: string, defaultValue?: any): any;
   /**
    * Dump the items.
    *
@@ -1620,74 +2151,6 @@ declare class JsonResource<R extends Resource = any> {
 //#region src/Resources/ApiResource.d.ts
 declare function ApiResource(instance: JsonResource): JsonResource<any>;
 //#endregion
-//#region src/Response.d.ts
-declare class Response extends HttpResponse implements IResponse {
-  /**
-   * The current app instance
-   */
-  app: Application;
-  constructor(
-  /**
-   * The current H3 H3Event instance
-   */
-  event: H3Event,
-  /**
-   * The current app instance
-   */
-  app: Application);
-  /**
-   * Sends content for the current web response.
-   */
-  sendContent(type?: 'html' | 'json' | 'text' | 'xml', parse?: boolean): unknown;
-  /**
-   * Sends content for the current web response.
-   */
-  send(type?: 'html' | 'json' | 'text' | 'xml'): unknown;
-  /**
-   *
-   * @param content The content to serve
-   * @param send if set to true, the content will be returned, instead of the Response instance
-   * @returns
-   */
-  html(content?: string): this;
-  html(content: string, parse: boolean): HTTPResponse;
-  /**
-   * Send a JSON response.
-   */
-  json<T = unknown>(data?: T): this;
-  json<T = unknown>(data: T, parse: boolean): T;
-  /**
-   * Send plain text.
-   */
-  text(content?: string): this;
-  text(content: string, parse: boolean): HTTPResponse;
-  /**
-   * Send plain xml.
-   */
-  xml(data?: string): this;
-  xml(data: string, parse: boolean): HTTPResponse;
-  /**
-   * Build the HTTP Response
-   *
-   * @param contentType
-   * @param data
-   */
-  private httpResponse;
-  /**
-   * Redirect to another URL.
-   */
-  redirect(location: string, status?: number, statusText?: string | undefined): HTTPResponse;
-  /**
-   * Dump the response.
-   */
-  dump(): this;
-  /**
-   * Get the base event
-   */
-  getEvent(): H3Event;
-  getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
-}
-//#endregion
 //#region src/Utilities/HeaderUtility.d.ts
 /**
  * HTTP header utility functions .
@@ -1793,105 +2256,4 @@ declare class IpUtils {
   private static setCacheResult;
 }
 //#endregion
-//#region src/Utilities/ResponseUtilities.d.ts
-declare enum ResponseCodes {
-  HTTP_CONTINUE = 100,
-  HTTP_SWITCHING_PROTOCOLS = 101,
-  HTTP_PROCESSING = 102,
-  // RFC2518
-  HTTP_EARLY_HINTS = 103,
-  // RFC8297
-  HTTP_OK = 200,
-  HTTP_CREATED = 201,
-  HTTP_ACCEPTED = 202,
-  HTTP_NON_AUTHORITATIVE_INFORMATION = 203,
-  HTTP_NO_CONTENT = 204,
-  HTTP_RESET_CONTENT = 205,
-  HTTP_PARTIAL_CONTENT = 206,
-  HTTP_MULTI_STATUS = 207,
-  // RFC4918
-  HTTP_ALREADY_REPORTED = 208,
-  // RFC5842
-  HTTP_IM_USED = 226,
-  // RFC3229
-  HTTP_MULTIPLE_CHOICES = 300,
-  HTTP_MOVED_PERMANENTLY = 301,
-  HTTP_FOUND = 302,
-  HTTP_SEE_OTHER = 303,
-  HTTP_NOT_MODIFIED = 304,
-  HTTP_USE_PROXY = 305,
-  HTTP_RESERVED = 306,
-  HTTP_TEMPORARY_REDIRECT = 307,
-  HTTP_PERMANENTLY_REDIRECT = 308,
-  // RFC7238
-  HTTP_BAD_REQUEST = 400,
-  HTTP_UNAUTHORIZED = 401,
-  HTTP_PAYMENT_REQUIRED = 402,
-  HTTP_FORBIDDEN = 403,
-  HTTP_NOT_FOUND = 404,
-  HTTP_METHOD_NOT_ALLOWED = 405,
-  HTTP_NOT_ACCEPTABLE = 406,
-  HTTP_PROXY_AUTHENTICATION_REQUIRED = 407,
-  HTTP_REQUEST_TIMEOUT = 408,
-  HTTP_CONFLICT = 409,
-  HTTP_GONE = 410,
-  HTTP_LENGTH_REQUIRED = 411,
-  HTTP_PRECONDITION_FAILED = 412,
-  HTTP_REQUEST_ENTITY_TOO_LARGE = 413,
-  HTTP_REQUEST_URI_TOO_LONG = 414,
-  HTTP_UNSUPPORTED_MEDIA_TYPE = 415,
-  HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416,
-  HTTP_EXPECTATION_FAILED = 417,
-  HTTP_I_AM_A_TEAPOT = 418,
-  // RFC2324
-  HTTP_MISDIRECTED_REQUEST = 421,
-  // RFC7540
-  HTTP_UNPROCESSABLE_ENTITY = 422,
-  // RFC4918
-  HTTP_LOCKED = 423,
-  // RFC4918
-  HTTP_FAILED_DEPENDENCY = 424,
-  // RFC4918
-  HTTP_TOO_EARLY = 425,
-  // RFC-ietf-httpbis-replay-04
-  HTTP_UPGRADE_REQUIRED = 426,
-  // RFC2817
-  HTTP_PRECONDITION_REQUIRED = 428,
-  // RFC6585
-  HTTP_TOO_MANY_REQUESTS = 429,
-  // RFC6585
-  HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
-  // RFC6585
-  HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451,
-  // RFC7725
-  HTTP_INTERNAL_SERVER_ERROR = 500,
-  HTTP_NOT_IMPLEMENTED = 501,
-  HTTP_BAD_GATEWAY = 502,
-  HTTP_SERVICE_UNAVAILABLE = 503,
-  HTTP_GATEWAY_TIMEOUT = 504,
-  HTTP_VERSION_NOT_SUPPORTED = 505,
-  HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506,
-  // RFC2295
-  HTTP_INSUFFICIENT_STORAGE = 507,
-  // RFC4918
-  HTTP_LOOP_DETECTED = 508,
-  // RFC5842
-  HTTP_NOT_EXTENDED = 510,
-  // RFC2774
-  HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511,
-}
-declare const HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES: CacheOptions;
-/**
- * Status codes translation table.
- *
- * The list of codes is complete according to the
- * @link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml Hypertext Transfer Protocol (HTTP) Status Code Registry
- * (last updated 2021-10-01).
- *
- * Unless otherwise noted, the status code is defined in RFC2616.
- */
-declare const statusTexts: {
-  [key: number]: string;
-};
-//#endregion
-export { ApiResource, BadRequestException, CacheOptions, ConflictingHeadersException, Cookie, FileBag, FireCommand, FormRequest, HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES, HeaderBag, HeaderUtility, HttpContext, HttpRequest, HttpResponse, HttpResponseException, HttpServiceProvider, InputBag, IpUtils, JsonResource, LogRequests, Middleware, ParamBag, Request, Resource, Response, ResponseCodes, ResponseHeaderBag, ServerBag, SuspiciousOperationException, UnexpectedValueException, UploadedFile, statusTexts };
+export { ApiResource, BadRequestException, ConflictingHeadersException, Cookie, FileBag, FireCommand, FlashDataMiddleware, FormRequest, HeaderBag, HeaderUtility, HttpContext, HttpRequest, HttpResponse, HttpResponseException, HttpServiceProvider, InputBag, IpUtils, JsonResource, JsonResponse, LogRequests, Middleware, ParamBag, Request, Resource, Responsable, Response, ResponseHeaderBag, ServerBag, SuspiciousOperationException, TrustHosts, UnexpectedValueException, UploadedFile };