@h3ravel/shared 0.25.0 → 0.26.1

package/dist/index.d.ts

@@ -1,32 +1,32 @@
 /// <reference path="./app.globals.d.ts" />
-import { ChalkInstance } from "chalk";
-import { ChoiceOrSeparatorArray, ChoiceOrSeparatorArray as ChoiceOrSeparatorArray$1 } from "inquirer-autocomplete-standalone";
-import { Separator } from "@inquirer/prompts";
 import { H3, H3Event, HTTPResponse, Middleware, MiddlewareOptions, serve } from "h3";
 import { Edge } from "edge.js";
 import { DotNestedKeys as DotNestedKeys$1, DotNestedValue as DotNestedValue$1 } from "@h3ravel/shared";
+import { Separator } from "@inquirer/prompts";
+import { ChoiceOrSeparatorArray, ChoiceOrSeparatorArray as ChoiceOrSeparatorArray$1 } from "inquirer-autocomplete-standalone";
+import { ChalkInstance } from "chalk";
 
 //#region src/Contracts/ObjContract.d.ts
 /**
  * Adds a dot prefix to nested keys
  */
-type DotPrefix<T$1 extends string, U extends string> = T$1 extends '' ? U : `${T$1}.${U}`;
+type DotPrefix<T extends string, U extends string> = T extends '' ? U : `${T}.${U}`;
 /**
  * Converts a union of objects into a single merged object
  */
-type MergeUnion<T$1> = (T$1 extends any ? (k: T$1) => void : never) extends ((k: infer I) => void) ? { [K in keyof I]: I[K] } : never;
+type MergeUnion<T> = (T extends any ? (k: T) => void : never) extends ((k: infer I) => void) ? { [K in keyof I]: I[K] } : never;
 /**
  * Flattens nested objects into dotted keys
  */
-type DotFlatten<T$1, Prefix extends string = ''> = MergeUnion<{ [K in keyof T$1 & string]: T$1[K] extends Record<string, any> ? DotFlatten<T$1[K], DotPrefix<Prefix, K>> : { [P in DotPrefix<Prefix, K>]: T$1[K] } }[keyof T$1 & string]>;
+type DotFlatten<T, Prefix extends string = ''> = MergeUnion<{ [K in keyof T & string]: T[K] extends Record<string, any> ? DotFlatten<T[K], DotPrefix<Prefix, K>> : { [P in DotPrefix<Prefix, K>]: T[K] } }[keyof T & string]>;
 /**
  * Builds "nested.key" paths for autocompletion
  */
-type DotNestedKeys<T$1> = { [K in keyof T$1 & string]: T$1[K] extends object ? `${K}` | `${K}.${DotNestedKeys<T$1[K]>}` : `${K}` }[keyof T$1 & string];
+type DotNestedKeys<T> = { [K in keyof T & string]: T[K] extends object ? `${K}` | `${K}.${DotNestedKeys<T[K]>}` : `${K}` }[keyof T & string];
 /**
  * Retrieves type at a given dot-path
  */
-type DotNestedValue<T$1, Path extends string> = Path extends `${infer Key}.${infer Rest}` ? Key extends keyof T$1 ? DotNestedValue<T$1[Key], Rest> : never : Path extends keyof T$1 ? T$1[Path] : never;
+type DotNestedValue<T, Path extends string> = Path extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? DotNestedValue<T[Key], Rest> : never : Path extends keyof T ? T[Path] : never;
 /**
  * A generic object type that supports nullable string values
  */
@@ -151,109 +151,351 @@ interface IApplication extends IContainer {
   getVersion(key: string): string | undefined;
 }
 //#endregion
-//#region src/Contracts/IRequest.d.ts
+//#region src/Contracts/IHttpResponse.d.ts
 /**
- * Interface for the Request contract, defining methods for handling HTTP request data.
+ * Interface for the Response contract, defining methods for handling HTTP responses.
  */
-interface IRequest {
+interface IHttpResponse {
   /**
-   * The current app instance
+   * Set HTTP status code.
    */
-  app: IApplication;
+  setStatusCode(code: number, text?: string): this;
   /**
-   * Gets route parameters.
-   * @returns An object containing route parameters.
+   * Retrieves the status code for the current web response.
    */
-  params: NonNullable<H3Event['context']['params']>;
+  getStatusCode(): number;
   /**
-   * Gets query parameters.
-   * @returns An object containing query parameters.
+   * Sets the response charset.
    */
-  query: Record<string, any>;
+  setCharset(charset: string): this;
   /**
-   * Gets all input data (query parameters, route parameters, and body).
-   * @returns A promise resolving to an object containing all input data.
+   * Retrieves the response charset.
    */
-  all<T = Record<string, unknown>>(): Promise<T>;
+  getCharset(): string | undefined;
   /**
-   * Gets a single input field from query or body.
-   * @param key - The key of the input field.
-   * @param defaultValue - Optional default value if the key is not found.
-   * @returns A promise resolving to the value of the input field or the default value.
+   * Returns true if the response may safely be kept in a shared (surrogate) cache.
+   *
+   * Responses marked "private" with an explicit Cache-Control directive are
+   * considered uncacheable.
+   *
+   * Responses with neither a freshness lifetime (Expires, max-age) nor cache
+   * validator (Last-Modified, ETag) are considered uncacheable because there is
+   * no way to tell when or how to remove them from the cache.
+   *
+   * Note that RFC 7231 and RFC 7234 possibly allow for a more permissive implementation,
+   * for example "status codes that are defined as cacheable by default [...]
+   * can be reused by a cache with heuristic expiration unless otherwise indicated"
+   * (https://tools.ietf.org/html/rfc7231#section-6.1)
+   *
+   * @final
    */
-  input<T = unknown>(key: string, defaultValue?: T): Promise<T>;
+  isCacheable(): boolean;
   /**
-   * Gets the underlying event object or a specific property of it.
-   * @param key - Optional key to access a nested property of the event.
-   * @returns The entire event object or the value of the specified property.
+   * Returns true if the response is "fresh".
+   *
+   * Fresh responses may be served from cache without any interaction with the
+   * origin. A response is considered fresh when it includes a Cache-Control/max-age
+   * indicator or Expires header and the calculated age is less than the freshness lifetime.
    */
-  getEvent(): H3Event;
-  getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
+  isFresh(): boolean;
+  /**
+   * Returns true if the response includes headers that can be used to validate
+   * the response with the origin server using a conditional GET request.
+   */
+  isValidateable(): boolean;
+  /**
+   * Sets the response content.
+   */
+  setContent(content?: any): this;
+  /**
+   * Gets the current response content.
+   */
+  getContent(): any;
+  /**
+   * Set a header.
+   */
+  setHeader(name: string, value: string): this;
+  /**
+   * Sets the HTTP protocol version (1.0 or 1.1).
+   */
+  setProtocolVersion(version: string): this;
+  /**
+   * Gets the HTTP protocol version.
+   */
+  getProtocolVersion(): string;
+  /**
+   * Marks the response as "private".
+   *
+   * It makes the response ineligible for serving other clients.
+   */
+  setPrivate(): this;
+  /**
+   * Marks the response as "public".
+   *
+   * It makes the response eligible for serving other clients.
+   */
+  setPublic(): this;
+  /**
+   * Returns the Date header as a DateTime instance.
+   * @throws {RuntimeException} When the header is not parseable
+   */
+  getDate(): any;
+  /**
+   * Returns the age of the response in seconds.
+   *
+   * @final
+   */
+  getAge(): number;
+  /**
+   * Marks the response stale by setting the Age header to be equal to the maximum age of the response.
+   */
+  expire(): this;
+  /**
+   * Returns the value of the Expires header as a DateTime instance.
+   *
+   * @final
+   */
+  getExpires(): any;
+  /**
+   * Returns the number of seconds after the time specified in the response's Date
+   * header when the response should no longer be considered fresh.
+   *
+   * First, it checks for a s-maxage directive, then a max-age directive, and then it falls
+   * back on an expires header. It returns null when no maximum age can be established.
+   */
+  getMaxAge(): number | undefined;
+  /**
+   * Sets the number of seconds after which the response should no longer be considered fresh.
+   *
+   * This method sets the Cache-Control max-age directive.
+   */
+  setMaxAge(value: number): this;
+  /**
+   * Sets the number of seconds after which the response should no longer be returned by shared caches when backend is down.
+   *
+   * This method sets the Cache-Control stale-if-error directive.
+   */
+  setStaleIfError(value: number): this;
+  /**
+   * Sets the number of seconds after which the response should no longer return stale content by shared caches.
+   *
+   * This method sets the Cache-Control stale-while-revalidate directive.
+   */
+  setStaleWhileRevalidate(value: number): this;
+  /**
+   * Returns the response's time-to-live in seconds.
+   *
+   * It returns null when no freshness information is present in the response.
+   *
+   * When the response's TTL is 0, the response may not be served from cache without first
+   * revalidating with the origin.
+   *
+   * @final
+   */
+  getTtl(): number | undefined;
+  /**
+   * Sets the response's time-to-live for shared caches in seconds.
+   *
+   * This method adjusts the Cache-Control/s-maxage directive.
+   */
+  setTtl(seconds: number): this;
+  /**
+   * Sets the response's time-to-live for private/client caches in seconds.
+   *
+   * This method adjusts the Cache-Control/max-age directive.
+   */
+  setClientTtl(seconds: number): this;
+  /**
+   * Sets the number of seconds after which the response should no longer be considered fresh by shared caches.
+   *
+   * This method sets the Cache-Control s-maxage directive.
+   */
+  setSharedMaxAge(value: number): this;
+  /**
+   * Returns the Last-Modified HTTP header as a DateTime instance.
+   *
+   * @throws \RuntimeException When the HTTP header is not parseable
+   *
+   * @final
+   */
+  getLastModified(): any;
+  /**
+   * Sets the Last-Modified HTTP header with a DateTime instance.
+   *
+   * Passing null as value will remove the header.
+   *
+   * @return $this
+   *
+   * @final
+   */
+  setLastModified(date?: any): this;
+  /**
+   * Returns the literal value of the ETag HTTP header.
+   */
+  getEtag(): string | null;
+  /**
+   * Sets the ETag value.
+   *
+   * @param etag The ETag unique identifier or null to remove the header
+   * @param weak Whether you want a weak ETag or not
+   */
+  setEtag(etag?: string, weak?: boolean): this;
+  /**
+   * Sets the response's cache headers (validation and/or expiration).
+   *
+   * Available options are: must_revalidate, no_cache, no_store, no_transform, public, private, proxy_revalidate, max_age, s_maxage, immutable, last_modified and etag.
+   *
+   * @throws {InvalidArgumentException}
+   */
+  setCache(options: any): this;
+  /**
+   * Modifies the response so that it conforms to the rules defined for a 304 status code.
+   *
+   * This sets the status, removes the body, and discards any headers
+   * that MUST NOT be included in 304 responses.
+   * @see https://tools.ietf.org/html/rfc2616#section-10.3.5
+   */
+  setNotModified(): this;
+  /**
+   * Add an array of headers to the response.
+   *
+   */
+  withHeaders(headers: any): this;
+  /**
+   * Set the exception to attach to the response.
+   */
+  withException(e: Error): this;
+  /**
+   * Throws the response in a HttpResponseException instance.
+   *
+   * @throws {HttpResponseException}
+   */
+  throwResponse(): void;
+  /**
+   * Is response invalid?
+   *
+   * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+   */
+  isInvalid(): boolean;
+  /**
+   * Is response informative?
+   */
+  isInformational(): boolean;
+  /**
+   * Is response successful?
+   */
+  isSuccessful(): boolean;
+  /**
+   * Is the response a redirect?
+   */
+  isRedirection(): boolean;
+  /**
+   * Is there a client error?
+   */
+  isClientError(): boolean;
+  /**
+   * Was there a server side error?
+   */
+  isServerError(): boolean;
+  /**
+   * Is the response OK?
+   */
+  isOk(): boolean;
+  /**
+   * Is the response forbidden?
+   */
+  isForbidden(): boolean;
+  /**
+   * Is the response a not found error?
+   */
+  isNotFound(): boolean;
+  /**
+   * Is the response a redirect of some form?
+   */
+  isRedirect(location?: string | null): boolean;
+  /**
+   * Is the response empty?
+   */
+  isEmpty(): boolean;
+  /**
+   * Apply headers before sending response.
+   */
+  sendHeaders(statusCode?: number): this;
+  /**
+   * Prepares the Response before it is sent to the client.
+   *
+   * This method tweaks the Response to ensure that it is
+   * compliant with RFC 2616. Most of the changes are based on
+   * the Request that is "associated" with this Response.
+   **/
+  prepare(request: IRequest): this;
 }
 //#endregion
 //#region src/Contracts/IResponse.d.ts
 /**
  * Interface for the Response contract, defining methods for handling HTTP responses.
  */
-interface IResponse {
+interface IResponse extends IHttpResponse {
   /**
    * The current app instance
    */
   app: IApplication;
   /**
-   * Sets the HTTP status code for the response.
-   * @param code - The HTTP status code.
-   * @returns The instance for method chaining.
+   * Sends content for the current web response.
    */
-  setStatusCode(code: number): this;
+  sendContent(type?: 'html' | 'json' | 'text' | 'xml', parse?: boolean): unknown;
   /**
-   * Sets a response header.
-   * @param name - The header name.
-   * @param value - The header value.
-   * @returns The instance for method chaining.
+   * Sends content for the current web response.
    */
-  setHeader(name: string, value: string): this;
+  send(type?: 'html' | 'json' | 'text' | 'xml'): unknown;
   /**
-   * Sends an HTML response.
-   * @param content - The HTML content to send.
-   * @returns The HTML content.
+   *
+   * @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): HTTPResponse;
+  html(content?: string): this;
+  html(content: string, parse: boolean): HTTPResponse;
   /**
-   * Sends a JSON response.
-   * @param data - The data to send as JSON.
-   * @returns The input data.
+   * Send a JSON response.
    */
-  json<T = unknown>(data: T): T;
+  json<T = unknown>(data?: T): this;
+  json<T = unknown>(data: T, parse: boolean): T;
   /**
-   * Sends a plain text response.
-   * @param data - The text content to send.
-   * @returns The text content.
+   * Send plain text.
    */
-  text(data: string): string;
+  text(content?: string): this;
+  text(content: string, parse: boolean): HTTPResponse;
   /**
-   * Redirects to another URL.
-   * @param url - The URL to redirect to.
-   * @param status - The HTTP status code for the redirect (default: 302).
-   * @returns The redirect URL.
+   * Send plain xml.
    */
-  redirect(url: string, status?: number): HTTPResponse;
+  xml(data?: string): this;
+  xml(data: string, parse: boolean): HTTPResponse;
   /**
-   * Gets the underlying event object or a specific property of it.
-   * @param key - Optional key to access a nested property of the event.
-   * @returns The entire event object or the value of the specified property.
+   * 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$1<H3Event>>(key: K): DotNestedValue$1<H3Event, K>;
+  getEvent<K$1 extends DotNestedKeys$1<H3Event>>(key: K$1): DotNestedValue$1<H3Event, K$1>;
 }
 //#endregion
 //#region src/Contracts/IHttp.d.ts
 type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'patch' | 'apiResource' | 'group' | 'route';
-type ExtractControllerMethods<T$1> = { [K in keyof T$1]: T$1[K] extends ((...args: any[]) => any) ? K : never }[keyof T$1];
+type RequestMethod = 'HEAD' | 'GET' | 'PUT' | 'DELETE' | 'TRACE' | 'OPTIONS' | 'PURGE' | 'POST' | 'CONNECT' | 'PATCH';
+type RequestObject = Record<string, any>;
+type ResponseObject = Record<string, any>;
+type ExtractControllerMethods<T> = { [K in keyof T]: T[K] extends ((...args: any[]) => any) ? K : never }[keyof T];
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
-interface IRouter {
+declare class IRouter {
   /**
    * Registers a GET route.
    * @param path - The route path.
@@ -373,7 +615,7 @@ type RouteEventHandler = (...args: any[]) => any;
  * Defines the contract for all controllers.
  * Any controller implementing this must define these methods.
  */
-interface IController {
+declare class IController {
   show?(...ctx: any[]): any;
   index?(...ctx: any[]): any;
   store?(...ctx: any[]): any;
@@ -384,10 +626,433 @@ interface IController {
  * Defines the contract for all middlewares.
  * Any middleware implementing this must define these methods.
  */
-interface IMiddleware {
+declare class IMiddleware {
   handle(context: HttpContext, next: () => Promise<any>): Promise<any>;
 }
 //#endregion
+//#region src/Contracts/IParamBag.d.ts
+declare class IParamBag implements Iterable<[string, any]> {
+  /**
+   * The current H3 H3Event instance
+   */
+  readonly event: H3Event;
+  constructor(parameters: RequestObject | undefined,
+  /**
+   * The current H3 H3Event instance
+   */
+  event: H3Event);
+  /**
+   * Returns the parameters.
+   * @
+   * @param key The name of the parameter to return or null to get them all
+   *
+   * @throws BadRequestException if the value is not an array
+   */
+  all(key?: string): any;
+  get(key: string, defaultValue?: any): any;
+  set(key: string, value: any): void;
+  /**
+   * Returns true if the parameter is defined.
+   *
+   * @param key
+   */
+  has(key: string): boolean;
+  /**
+   * Removes a parameter.
+   *
+   * @param key
+   */
+  remove(key: string): void;
+  /**
+   *
+   * Returns the parameter as string.
+   *
+   * @param key
+   * @param defaultValue
+   * @throws UnexpectedValueException if the value cannot be converted to string
+   * @returns
+   */
+  getString(key: string, defaultValue?: string): string;
+  /**
+   * Returns the parameter value converted to integer.
+   *
+   * @param key
+   * @param defaultValue
+   * @throws UnexpectedValueException if the value cannot be converted to integer
+   */
+  getInt(key: string, defaultValue?: number): number;
+  /**
+   * Returns the parameter value converted to boolean.
+   *
+   * @param key
+   * @param defaultValue
+   * @throws UnexpectedValueException if the value cannot be converted to a boolean
+   */
+  getBoolean(key: string, defaultValue?: boolean): boolean;
+  /**
+   * Returns the alphabetic characters of the parameter value.
+   *
+   * @param key
+   * @param defaultValue
+   * @throws UnexpectedValueException if the value cannot be converted to string
+   */
+  getAlpha(key: string, defaultValue?: string): string;
+  /**
+   * Returns the alphabetic characters and digits of the parameter value.
+   *
+   * @param key
+   * @param defaultValue
+   * @throws UnexpectedValueException if the value cannot be converted to string
+   */
+  getAlnum(key: string, defaultValue?: string): string;
+  /**
+   * Returns the digits of the parameter value.
+   *
+   * @param key
+   * @param defaultValue
+   * @throws UnexpectedValueException if the value cannot be converted to string
+   * @returns
+   **/
+  getDigits(key: string, defaultValue?: string): string;
+  /**
+   * Returns the parameter keys.
+   */
+  keys(): string[];
+  /**
+   * Replaces the current parameters by a new set.
+   */
+  replace(parameters?: RequestObject): void;
+  /**
+   * Adds parameters.
+   */
+  add(parameters?: RequestObject): void;
+  /**
+   * Returns the number of parameters.
+   */
+  count(): number;
+  /**
+   * Returns an iterator for parameters.
+   *
+   * @returns
+   */
+  [Symbol.iterator](): ArrayIterator<[string, any]>;
+}
+//#endregion
+//#region src/Contracts/IUploadedFile.d.ts
+declare class IUploadedFile {
+  originalName: string;
+  mimeType: string;
+  size: number;
+  content: File;
+  constructor(originalName: string, mimeType: string, size: number, content: File);
+  static createFromBase(file: File): IUploadedFile;
+  /**
+   * Save to disk (Node environment only)
+   */
+  moveTo(destination: string): Promise<void>;
+}
+//#endregion
+//#region src/Contracts/IRequest.d.ts
+type RequestObject$1 = Record<string, any>;
+/**
+ * Interface for the Request contract, defining methods for handling HTTP request data.
+ */
+declare class IRequest {
+  /**
+   * The current app instance
+   */
+  app: IApplication;
+  /**
+   * Parsed request body
+   */
+  body: unknown;
+  /**
+   * Gets route parameters.
+   * @returns An object containing route parameters.
+   */
+  params: NonNullable<H3Event['context']['params']>;
+  /**
+   * Uploaded files (FILES).
+   */
+  constructor(
+  /**
+   * The current H3 H3Event instance
+   */
+  event: H3Event,
+  /**
+   * The current app instance
+   */
+  app: IApplication);
+  /**
+   * Factory method to create a Request instance from an H3Event.
+   */
+  static create(
+  /**
+   * The current H3 H3Event instance
+   */
+  event: H3Event,
+  /**
+   * The current app instance
+   */
+  app: IApplication): Promise<Request>;
+  /**
+   * Sets the parameters for this request.
+   *
+   * This method also re-initializes all properties.
+   *
+   * @param attributes
+   * @param cookies    The COOKIE parameters
+   * @param files      The FILES parameters
+   * @param server     The SERVER parameters
+   * @param content    The raw body data
+   */
+  initialize(): Promise<void>;
+  /**
+   * Retrieve all data from the instance (query + body).
+   */
+  all<T = Record<string, any>>(keys?: string | string[]): T;
+  /**
+   * Retrieve an input item from the request.
+   *
+   * @param key
+   * @param defaultValue
+   * @returns
+   */
+  input<K$1 extends string | undefined>(key?: K$1, defaultValue?: any): K$1 extends undefined ? RequestObject$1 : any;
+  /**
+   * Retrieve a file from the request.
+   *
+   * By default a single `UploadedFile` instance will always be returned by
+   * the method (first file in property when there are multiple), unless
+   * the `expectArray` parameter is set to true, in which case, the method
+   * returns an `UploadedFile[]` array.
+   *
+   * @param key
+   * @param defaultValue
+   * @param expectArray set to true to return an `UploadedFile[]` array.
+   * @returns
+   */
+  file<K$1 extends string | undefined = undefined, E extends boolean | undefined = undefined>(key?: K$1, defaultValue?: any, expectArray?: E): K$1 extends undefined ? Record<string, E extends true ? IUploadedFile[] : IUploadedFile> : E extends true ? IUploadedFile[] : IUploadedFile;
+  /**
+   * Determine if the uploaded data contains a file.
+   *
+   * @param  key
+   * @return boolean
+   */
+  hasFile(key: string): boolean;
+  /**
+   * Get an object with all the files on the request.
+   */
+  allFiles(): Record<string, IUploadedFile | IUploadedFile[]>;
+  /**
+     * Extract and convert uploaded files from FormData.
+     */
+  convertUploadedFiles(files: Record<string, IUploadedFile | IUploadedFile[]>): Record<string, IUploadedFile | IUploadedFile[]>;
+  /**
+   * Determine if the data contains a given key.
+   *
+   * @param keys
+   * @returns
+   */
+  has(keys: string[] | string): boolean;
+  /**
+   * Determine if the instance is missing a given key.
+   */
+  missing(key: string | string[]): boolean;
+  /**
+   * Get a subset containing the provided keys with values from the instance data.
+   *
+   * @param keys
+   * @returns
+   */
+  only<T = Record<string, any>>(keys: string[]): T;
+  /**
+   * Get all of the data except for a specified array of items.
+   *
+   * @param keys
+   * @returns
+   */
+  except<T = Record<string, any>>(keys: string[]): T;
+  /**
+   * Merges new input data into the current request's input source.
+   *
+   * @param input - An object containing key-value pairs to merge.
+   * @returns this - For fluent chaining.
+   */
+  merge(input: Record<string, any>): this;
+  /**
+   * Merge new input into the request's input, but only when that key is missing from the request.
+   *
+   * @param input
+   */
+  mergeIfMissing(input: Record<string, any>): this;
+  /**
+   * Get the keys for all of the input and files.
+   */
+  keys(): string[];
+  /**
+   * Determine if the request is sending JSON.
+   *
+   * @return bool
+   */
+  isJson(): boolean;
+  /**
+   * Determine if the current request probably expects a JSON response.
+   *
+   * @returns
+   */
+  expectsJson(): boolean;
+  /**
+   * Determine if the current request is asking for JSON.
+   *
+   * @returns
+   */
+  wantsJson(): boolean;
+  /**
+   * Gets a list of content types acceptable by the client browser in preferable order.
+   * @returns {string[]}
+   */
+  getAcceptableContentTypes(): string[];
+  /**
+   * Determine if the request is the result of a PJAX call.
+   *
+   * @return bool
+   */
+  pjax(): boolean;
+  /**
+   * Returns true if the request is an XMLHttpRequest (AJAX).
+   *
+   * @alias isXmlHttpRequest()
+   * @returns {boolean}
+   */
+  ajax(): boolean;
+  /**
+   * Returns true if the request is an XMLHttpRequest (AJAX).
+   */
+  isXmlHttpRequest(): boolean;
+  /**
+   * Returns the value of the requested header.
+   */
+  getHeader(name: string): string | undefined | null;
+  /**
+   * Checks if the request method is of specified type.
+   *
+   * @param method Uppercase request method (GET, POST etc)
+   */
+  isMethod(method: string): boolean;
+  /**
+   * Checks whether or not the method is safe.
+   *
+   * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
+   */
+  isMethodSafe(): boolean;
+  /**
+   * Checks whether or not the method is idempotent.
+   */
+  isMethodIdempotent(): boolean;
+  /**
+   * Checks whether the method is cacheable or not.
+   *
+   * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
+   */
+  isMethodCacheable(): boolean;
+  /**
+   * Gets the request "intended" method.
+   *
+   * If the X-HTTP-Method-Override header is set, and if the method is a POST,
+   * then it is used to determine the "real" intended HTTP method.
+   *
+   * The _method request parameter can also be used to determine the HTTP method,
+   * but only if enableHttpMethodParameterOverride() has been called.
+   *
+   * The method is always an uppercased string.
+   *
+   * @see getRealMethod()
+   */
+  getMethod(): RequestMethod;
+  /**
+   * Gets the "real" request method.
+   *
+   * @see getMethod()
+   */
+  getRealMethod(): RequestMethod;
+  /**
+   * Get the client IP address.
+   */
+  ip(): string | undefined;
+  /**
+   * Get a URI instance for the request.
+   */
+  uri(): unknown;
+  /**
+   * Get the full URL for the request.
+   */
+  fullUrl(): string;
+  /**
+   * Return the Request instance.
+   */
+  instance(): this;
+  /**
+   * Get the request method.
+   */
+  method(): RequestMethod;
+  /**
+   * Get the JSON payload for the request.
+   *
+   * @param  key
+   * @param  defaultValue
+   * @return {InputBag}
+   */
+  json<K$1 extends string | undefined = undefined>(key?: string, defaultValue?: any): K$1 extends undefined ? IParamBag : any;
+  /**
+   * Returns the request body content.
+   *
+   * @param asStream If true, returns a ReadableStream instead of the parsed string
+   * @return {string | ReadableStream | Promise<string | ReadableStream>}
+   */
+  getContent(asStream?: boolean): string | ReadableStream;
+  /**
+   * Gets a "parameter" value from any bag.
+   *
+   * This method is mainly useful for libraries that want to provide some flexibility. If you don't need the
+   * flexibility in controllers, it is better to explicitly get request parameters from the appropriate
+   * public property instead (attributes, query, request).
+   *
+   * Order of precedence: PATH (routing placeholders or custom attributes), GET, POST
+   *
+   * @internal use explicit input sources instead
+   */
+  get(key: string, defaultValue?: any): any;
+  /**
+   * Enables support for the _method request parameter to determine the intended HTTP method.
+   *
+   * Be warned that enabling this feature might lead to CSRF issues in your code.
+   * Check that you are using CSRF tokens when required.
+   * If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered
+   * and used to send a "PUT" or "DELETE" request via the _method request parameter.
+   * If these methods are not protected against CSRF, this presents a possible vulnerability.
+   *
+   * The HTTP method can only be overridden when the real HTTP method is POST.
+   */
+  static enableHttpMethodParameterOverride(): void;
+  /**
+   * Checks whether support for the _method request parameter is enabled.
+   */
+  static getHttpMethodParameterOverride(): boolean;
+  /**
+   * Dump the items.
+   *
+   * @param  keys
+   * @return this
+   */
+  dump(...keys: any[]): this;
+  /**
+   * Get the base event
+   */
+  getEvent(): H3Event;
+  getEvent<K$1 extends DotNestedKeys<H3Event>>(key: K$1): DotNestedValue<H3Event, K$1>;
+}
+//#endregion
 //#region src/Utils/PathLoader.d.ts
 declare class PathLoader {
   private paths;
@@ -411,7 +1076,7 @@ declare class PathLoader {
 }
 //#endregion
 //#region src/Contracts/BindingsContract.d.ts
-type RemoveIndexSignature<T$1> = { [K in keyof T$1 as string extends K ? never : number extends K ? never : K]: T$1[K] };
+type RemoveIndexSignature<T> = { [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K] };
 type Bindings = {
   [key: string]: any;
   [key: `app.${string}`]: any;
@@ -724,6 +1389,13 @@ declare class Resolver {
    * @returns
    */
   static hashObjectOrFunction(provider: object | ((..._: any[]) => any)): string;
+  /**
+   * Checks if a function is asyncronous
+   *
+   * @param func
+   * @returns
+   */
+  static isAsyncFunction(func: any): boolean;
 }
 //#endregion
 //#region src/Utils/scripts.d.ts
@@ -773,4 +1445,4 @@ declare class TaskManager {
   static advancedTaskRunner<R = any>(info: [[string, string], [string, string]] | [[string, string]], task: (() => Promise<R>) | (() => R)): Promise<R | undefined>;
 }
 //#endregion
-export { Bindings, Choice, type ChoiceOrSeparatorArray, Choices, DotFlatten, DotNestedKeys, DotNestedValue, EnvParser, EventHandler, ExtractControllerMethods, FileSystem, GenericWithNullableStringValues, HttpContext, IApplication, IContainer, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, ISeparator, IServiceProvider, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, PathLoader, Prompts, Resolver, RouteDefinition, RouteEventHandler, RouteMethod, RouterEnd, TaskManager, UseKey, baseTsconfig, mainTsconfig, packageJsonScript };
+export { Bindings, Choice, type ChoiceOrSeparatorArray, Choices, DotFlatten, DotNestedKeys, DotNestedValue, EnvParser, EventHandler, ExtractControllerMethods, FileSystem, GenericWithNullableStringValues, HttpContext, IApplication, IContainer, IController, IHttpResponse, IMiddleware, IParamBag, IPathName, IRequest, IResponse, IRouter, ISeparator, IServiceProvider, IUploadedFile, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, PathLoader, Prompts, RequestMethod, RequestObject, Resolver, ResponseObject, RouteDefinition, RouteEventHandler, RouteMethod, RouterEnd, TaskManager, UseKey, baseTsconfig, mainTsconfig, packageJsonScript };