@h3ravel/shared 0.24.0 → 0.26.0

package/dist/index.cjs

@@ -38,31 +38,6 @@ crypto = __toESM(crypto);
 let preferred_pm = require("preferred-pm");
 preferred_pm = __toESM(preferred_pm);
 
-//#region src/Contracts/IHttp.ts
-/**
-* Represents the HTTP context for a single request lifecycle.
-* Encapsulates the application instance, request, and response objects.
-*/
-var HttpContext = class HttpContext {
-	constructor(app, request, response) {
-		this.app = app;
-		this.request = request;
-		this.response = response;
-	}
-	/**
-	* Factory method to create a new HttpContext instance from a context object.
-	* @param ctx - Object containing app, request, and response
-	* @returns A new HttpContext instance
-	*/
-	static init(ctx) {
-		/**
-		* Return a new instance
-		*/
-		return new HttpContext(ctx.app, ctx.request, ctx.response);
-	}
-};
-
-//#endregion
 //#region src/Utils/EnvParser.ts
 var EnvParser = class {
 	static parse(initial) {
@@ -544,7 +519,6 @@ var TaskManager = class {
 //#endregion
 exports.EnvParser = EnvParser;
 exports.FileSystem = FileSystem;
-exports.HttpContext = HttpContext;
 exports.Logger = Logger;
 exports.PathLoader = PathLoader;
 exports.Prompts = Prompts;

package/dist/index.d.cts

@@ -1,7 +1,6 @@
 /// <reference path="./app.globals.d.ts" />
-import { H3, H3Event, Middleware, MiddlewareOptions, serve } from "h3";
+import { H3, H3Event, HTTPResponse, Middleware, MiddlewareOptions, serve } from "h3";
 import { Edge } from "edge.js";
-import { ResponseHeaderMap, TypedHeaders } from "fetchdts";
 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";
@@ -152,51 +151,6 @@ interface IApplication extends IContainer {
   getVersion(key: string): string | undefined;
 }
 //#endregion
-//#region src/Contracts/IRequest.d.ts
-/**
- * Interface for the Request contract, defining methods for handling HTTP request data.
- */
-interface IRequest {
-  /**
-   * The current app instance
-   */
-  app: IApplication;
-  /**
-   * Gets route parameters.
-   * @returns An object containing route parameters.
-   */
-  params: NonNullable<H3Event['context']['params']>;
-  /**
-   * Gets query parameters.
-   * @returns An object containing query parameters.
-   */
-  query: Record<string, any>;
-  /**
-   * Gets the request headers.
-   * @returns An object containing request headers.
-   */
-  headers: TypedHeaders<Record<keyof ResponseHeaderMap, string>>;
-  /**
-   * Gets all input data (query parameters, route parameters, and body).
-   * @returns A promise resolving to an object containing all input data.
-   */
-  all<T = Record<string, unknown>>(): Promise<T>;
-  /**
-   * 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.
-   */
-  input<T = unknown>(key: string, defaultValue?: T): Promise<T>;
-  /**
-   * 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.
-   */
-  getEvent(): H3Event;
-  getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
-}
-//#endregion
 //#region src/Contracts/IResponse.d.ts
 /**
  * Interface for the Response contract, defining methods for handling HTTP responses.
@@ -224,7 +178,7 @@ interface IResponse {
    * @param content - The HTML content to send.
    * @returns The HTML content.
    */
-  html(content: string): string;
+  html(content: string): HTTPResponse;
   /**
    * Sends a JSON response.
    * @param data - The data to send as JSON.
@@ -243,7 +197,7 @@ interface IResponse {
    * @param status - The HTTP status code for the redirect (default: 302).
    * @returns The redirect URL.
    */
-  redirect(url: string, status?: number): string;
+  redirect(url: string, status?: number): HTTPResponse;
   /**
    * Gets the underlying event object or a specific property of it.
    * @param key - Optional key to access a nested property of the event.
@@ -255,11 +209,13 @@ interface IResponse {
 //#endregion
 //#region src/Contracts/IHttp.d.ts
 type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'patch' | 'apiResource' | 'group' | 'route';
+type RequestMethod = 'HEAD' | 'GET' | 'PUT' | 'DELETE' | 'TRACE' | 'OPTIONS' | 'PURGE' | 'POST' | 'CONNECT' | 'PATCH';
+type RequestObject = Record<string, any>;
 type ExtractControllerMethods<T$1> = { [K in keyof T$1]: T$1[K] extends ((...args: any[]) => any) ? K : never }[keyof T$1];
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
-interface IRouter {
+declare class IRouter {
   /**
    * Registers a GET route.
    * @param path - The route path.
@@ -349,6 +305,7 @@ declare class HttpContext {
   app: IApplication;
   request: IRequest;
   response: IResponse;
+  private static contexts;
   constructor(app: IApplication, request: IRequest, response: IResponse);
   /**
    * Factory method to create a new HttpContext instance from a context object.
@@ -359,7 +316,15 @@ declare class HttpContext {
     app: IApplication;
     request: IRequest;
     response: IResponse;
-  }): HttpContext;
+  }, event?: unknown): HttpContext;
+  /**
+   * Retrieve an existing HttpContext instance for an event, if any.
+   */
+  static get(event: unknown): HttpContext | undefined;
+  /**
+   * Delete the cached context for a given event (optional cleanup).
+   */
+  static forget(event: unknown): void;
 }
 /**
  * Type for EventHandler, representing a function that handles an H3 event.
@@ -370,7 +335,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;
@@ -381,10 +346,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 extends string | undefined>(key?: K, defaultValue?: any): K 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 extends string | undefined = undefined, E extends boolean | undefined = undefined>(key?: K, defaultValue?: any, expectArray?: E): K 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 extends string | undefined = undefined>(key?: string, defaultValue?: any): K 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 extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
+}
+//#endregion
 //#region src/Utils/PathLoader.d.ts
 declare class PathLoader {
   private paths;
@@ -414,7 +802,7 @@ type Bindings = {
   [key: `app.${string}`]: any;
   env(): NodeJS.ProcessEnv;
   env<T extends string>(key: T, def?: any): any;
-  view(viewPath: string, params?: Record<string, any>): Promise<string>;
+  view(viewPath: string, params?: Record<string, any>): Promise<HTTPResponse>;
   edge: Edge;
   asset(key: string, def?: string): string;
   router: IRouter;
@@ -770,4 +1158,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, IMiddleware, IParamBag, IPathName, IRequest, IResponse, IRouter, ISeparator, IServiceProvider, IUploadedFile, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, PathLoader, Prompts, RequestMethod, RequestObject, Resolver, RouteDefinition, RouteEventHandler, RouteMethod, RouterEnd, TaskManager, UseKey, baseTsconfig, mainTsconfig, packageJsonScript };

package/dist/index.d.ts

@@ -2,9 +2,8 @@
 import { ChalkInstance } from "chalk";
 import { ChoiceOrSeparatorArray, ChoiceOrSeparatorArray as ChoiceOrSeparatorArray$1 } from "inquirer-autocomplete-standalone";
 import { Separator } from "@inquirer/prompts";
-import { H3, H3Event, Middleware, MiddlewareOptions, serve } from "h3";
+import { H3, H3Event, HTTPResponse, Middleware, MiddlewareOptions, serve } from "h3";
 import { Edge } from "edge.js";
-import { ResponseHeaderMap, TypedHeaders } from "fetchdts";
 import { DotNestedKeys as DotNestedKeys$1, DotNestedValue as DotNestedValue$1 } from "@h3ravel/shared";
 
 //#region src/Contracts/ObjContract.d.ts
@@ -152,51 +151,6 @@ interface IApplication extends IContainer {
   getVersion(key: string): string | undefined;
 }
 //#endregion
-//#region src/Contracts/IRequest.d.ts
-/**
- * Interface for the Request contract, defining methods for handling HTTP request data.
- */
-interface IRequest {
-  /**
-   * The current app instance
-   */
-  app: IApplication;
-  /**
-   * Gets route parameters.
-   * @returns An object containing route parameters.
-   */
-  params: NonNullable<H3Event['context']['params']>;
-  /**
-   * Gets query parameters.
-   * @returns An object containing query parameters.
-   */
-  query: Record<string, any>;
-  /**
-   * Gets the request headers.
-   * @returns An object containing request headers.
-   */
-  headers: TypedHeaders<Record<keyof ResponseHeaderMap, string>>;
-  /**
-   * Gets all input data (query parameters, route parameters, and body).
-   * @returns A promise resolving to an object containing all input data.
-   */
-  all<T = Record<string, unknown>>(): Promise<T>;
-  /**
-   * 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.
-   */
-  input<T = unknown>(key: string, defaultValue?: T): Promise<T>;
-  /**
-   * 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.
-   */
-  getEvent(): H3Event;
-  getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
-}
-//#endregion
 //#region src/Contracts/IResponse.d.ts
 /**
  * Interface for the Response contract, defining methods for handling HTTP responses.
@@ -224,7 +178,7 @@ interface IResponse {
    * @param content - The HTML content to send.
    * @returns The HTML content.
    */
-  html(content: string): string;
+  html(content: string): HTTPResponse;
   /**
    * Sends a JSON response.
    * @param data - The data to send as JSON.
@@ -243,7 +197,7 @@ interface IResponse {
    * @param status - The HTTP status code for the redirect (default: 302).
    * @returns The redirect URL.
    */
-  redirect(url: string, status?: number): string;
+  redirect(url: string, status?: number): HTTPResponse;
   /**
    * Gets the underlying event object or a specific property of it.
    * @param key - Optional key to access a nested property of the event.
@@ -255,11 +209,13 @@ interface IResponse {
 //#endregion
 //#region src/Contracts/IHttp.d.ts
 type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'patch' | 'apiResource' | 'group' | 'route';
+type RequestMethod = 'HEAD' | 'GET' | 'PUT' | 'DELETE' | 'TRACE' | 'OPTIONS' | 'PURGE' | 'POST' | 'CONNECT' | 'PATCH';
+type RequestObject = Record<string, any>;
 type ExtractControllerMethods<T$1> = { [K in keyof T$1]: T$1[K] extends ((...args: any[]) => any) ? K : never }[keyof T$1];
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
-interface IRouter {
+declare class IRouter {
   /**
    * Registers a GET route.
    * @param path - The route path.
@@ -349,6 +305,7 @@ declare class HttpContext {
   app: IApplication;
   request: IRequest;
   response: IResponse;
+  private static contexts;
   constructor(app: IApplication, request: IRequest, response: IResponse);
   /**
    * Factory method to create a new HttpContext instance from a context object.
@@ -359,7 +316,15 @@ declare class HttpContext {
     app: IApplication;
     request: IRequest;
     response: IResponse;
-  }): HttpContext;
+  }, event?: unknown): HttpContext;
+  /**
+   * Retrieve an existing HttpContext instance for an event, if any.
+   */
+  static get(event: unknown): HttpContext | undefined;
+  /**
+   * Delete the cached context for a given event (optional cleanup).
+   */
+  static forget(event: unknown): void;
 }
 /**
  * Type for EventHandler, representing a function that handles an H3 event.
@@ -370,7 +335,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;
@@ -381,10 +346,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 extends string | undefined>(key?: K, defaultValue?: any): K 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 extends string | undefined = undefined, E extends boolean | undefined = undefined>(key?: K, defaultValue?: any, expectArray?: E): K 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 extends string | undefined = undefined>(key?: string, defaultValue?: any): K 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 extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
+}
+//#endregion
 //#region src/Utils/PathLoader.d.ts
 declare class PathLoader {
   private paths;
@@ -414,7 +802,7 @@ type Bindings = {
   [key: `app.${string}`]: any;
   env(): NodeJS.ProcessEnv;
   env<T extends string>(key: T, def?: any): any;
-  view(viewPath: string, params?: Record<string, any>): Promise<string>;
+  view(viewPath: string, params?: Record<string, any>): Promise<HTTPResponse>;
   edge: Edge;
   asset(key: string, def?: string): string;
   router: IRouter;
@@ -770,4 +1158,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, IMiddleware, IParamBag, IPathName, IRequest, IResponse, IRouter, ISeparator, IServiceProvider, IUploadedFile, Logger, LoggerChalk, LoggerLog, LoggerParseSignature, PathLoader, Prompts, RequestMethod, RequestObject, Resolver, RouteDefinition, RouteEventHandler, RouteMethod, RouterEnd, TaskManager, UseKey, baseTsconfig, mainTsconfig, packageJsonScript };

package/dist/index.js

@@ -7,31 +7,6 @@ import { confirm, input, password, select } from "@inquirer/prompts";
 import crypto from "crypto";
 import preferredPM from "preferred-pm";
 
-//#region src/Contracts/IHttp.ts
-/**
-* Represents the HTTP context for a single request lifecycle.
-* Encapsulates the application instance, request, and response objects.
-*/
-var HttpContext = class HttpContext {
-	constructor(app, request, response) {
-		this.app = app;
-		this.request = request;
-		this.response = response;
-	}
-	/**
-	* Factory method to create a new HttpContext instance from a context object.
-	* @param ctx - Object containing app, request, and response
-	* @returns A new HttpContext instance
-	*/
-	static init(ctx) {
-		/**
-		* Return a new instance
-		*/
-		return new HttpContext(ctx.app, ctx.request, ctx.response);
-	}
-};
-
-//#endregion
 //#region src/Utils/EnvParser.ts
 var EnvParser = class {
 	static parse(initial) {
@@ -511,4 +486,4 @@ var TaskManager = class {
 };
 
 //#endregion
-export { EnvParser, FileSystem, HttpContext, Logger, PathLoader, Prompts, Resolver, TaskManager, baseTsconfig, mainTsconfig, packageJsonScript };
+export { EnvParser, FileSystem, Logger, PathLoader, Prompts, Resolver, TaskManager, baseTsconfig, mainTsconfig, packageJsonScript };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/shared",
-  "version": "0.24.0",
+  "version": "0.26.0",
   "description": "Shared Utilities.",
   "type": "module",
   "main": "./dist/index.js",
@@ -48,7 +48,7 @@
     "chalk": "^5.6.0",
     "edge.js": "^6.3.0",
     "escalade": "^3.2.0",
-    "h3": "^2.0.0-beta.4",
+    "h3": "2.0.1-rc.5",
     "inquirer-autocomplete-standalone": "^0.8.1",
     "preferred-pm": "^4.1.1"
   },