@h3ravel/http 11.5.2 → 11.6.0

package/dist/index.cjs

@@ -19032,6 +19032,44 @@ var FormRequest = class {
 	}
 };
 
+//#endregion
+//#region src/HttpContext.ts
+/**
+* Represents the HTTP context for a single request lifecycle.
+* Encapsulates the application instance, request, and response objects.
+*/
+var HttpContext = class HttpContext {
+	static contexts = /* @__PURE__ */ new WeakMap();
+	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, event) {
+		if (event && HttpContext.contexts.has(event)) return HttpContext.contexts.get(event);
+		const instance = new HttpContext(ctx.app, ctx.request, ctx.response);
+		if (event) HttpContext.contexts.set(event, instance);
+		return instance;
+	}
+	/**
+	* Retrieve an existing HttpContext instance for an event, if any.
+	*/
+	static get(event) {
+		return HttpContext.contexts.get(event);
+	}
+	/**
+	* Delete the cached context for a given event (optional cleanup).
+	*/
+	static forget(event) {
+		HttpContext.contexts.delete(event);
+	}
+};
+
 //#endregion
 //#region src/Middleware.ts
 var Middleware = class {};
@@ -19235,10 +19273,15 @@ var Request = class Request {
 	}
 	/**
 	* 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 
+	* @param expectArray set to true to return an `UploadedFile[]` array.
 	* @returns
 	*/
 	file(key, defaultValue, expectArray) {
@@ -19890,12 +19933,7 @@ exports.FileBag = FileBag;
 exports.FireCommand = FireCommand;
 exports.FormRequest = FormRequest;
 exports.HeaderBag = HeaderBag;
-Object.defineProperty(exports, 'HttpContext', {
-  enumerable: true,
-  get: function () {
-    return __h3ravel_shared.HttpContext;
-  }
-});
+exports.HttpContext = HttpContext;
 exports.HttpServiceProvider = HttpServiceProvider;
 exports.InputBag = InputBag;
 exports.JsonResource = JsonResource;

package/dist/index.d.cts

@@ -1,20 +1,16 @@
 /// <reference path="./app.globals.d.ts" />
 import { EventHandlerRequest, H3Event, HTTPResponse } from "h3";
-import { DotNestedKeys, DotNestedValue, HttpContext, HttpContext as HttpContext$1, IMiddleware, IRequest, IResponse } from "@h3ravel/shared";
+import { DotNestedKeys, DotNestedValue, HttpContext as HttpContext$1, IApplication, IMiddleware, IParamBag, IRequest, IResponse, RequestMethod, RequestObject } from "@h3ravel/shared";
 import { Command } from "@h3ravel/musket";
 import { Application } from "@h3ravel/core";
 import { Url } from "@h3ravel/url";
 
-//#region src/Contracts/HttpContract.d.ts
-type RequestMethod = 'HEAD' | 'GET' | 'PUT' | 'DELETE' | 'TRACE' | 'OPTIONS' | 'PURGE' | 'POST' | 'CONNECT' | 'PATCH';
-type RequestObject = Record<string, any>;
-//#endregion
 //#region src/Bags/ParamBag.d.ts
 /**
  * ParamBag is a container for key/value pairs
  * for Node/H3 environments.
  */
-declare class ParamBag implements Iterable<[string, any]> {
+declare class ParamBag implements IParamBag {
   protected parameters: RequestObject;
   /**
    * The current H3 H3Event instance
@@ -515,6 +511,37 @@ declare class FormRequest {
   all(): Record<string, any>;
 }
 //#endregion
+//#region src/HttpContext.d.ts
+/**
+ * Represents the HTTP context for a single request lifecycle.
+ * Encapsulates the application instance, request, and response objects.
+ */
+declare class HttpContext implements HttpContext$1 {
+  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.
+   * @param ctx - Object containing app, request, and response
+   * @returns A new HttpContext instance
+   */
+  static init(ctx: {
+    app: IApplication;
+    request: IRequest;
+    response: IResponse;
+  }, 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;
+}
+//#endregion
 //#region src/Middleware.d.ts
 declare abstract class Middleware implements IMiddleware {
   abstract handle(context: HttpContext, next: () => Promise<unknown>): Promise<unknown>;
@@ -524,7 +551,7 @@ declare abstract class Middleware implements IMiddleware {
 declare class LogRequests extends Middleware {
   handle({
     request
-  }: HttpContext$1, next: () => Promise<unknown>): Promise<unknown>;
+  }: HttpContext, next: () => Promise<unknown>): Promise<unknown>;
 }
 //#endregion
 //#region src/Providers/HttpServiceProvider.d.ts
@@ -662,9 +689,14 @@ declare class Request implements IRequest {
   /**
    * 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
+   * @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;
@@ -1049,4 +1081,4 @@ declare class Response implements IResponse {
   getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
 }
 //#endregion
-export { ApiResource, BadRequestException, FileBag, FireCommand, FormRequest, HeaderBag, HttpContext, HttpServiceProvider, InputBag, JsonResource, LogRequests, Middleware, ParamBag, Request, RequestMethod, RequestObject, Resource, Response, ServerBag, SuspiciousOperationException, UnexpectedValueException, UploadedFile };
+export { ApiResource, BadRequestException, FileBag, FireCommand, FormRequest, HeaderBag, HttpContext, HttpServiceProvider, InputBag, JsonResource, LogRequests, Middleware, ParamBag, Request, Resource, Response, ServerBag, SuspiciousOperationException, UnexpectedValueException, UploadedFile };

package/dist/index.d.ts

@@ -1,20 +1,16 @@
 /// <reference path="./app.globals.d.ts" />
 import { Command } from "@h3ravel/musket";
-import { DotNestedKeys, DotNestedValue, HttpContext, HttpContext as HttpContext$1, IMiddleware, IRequest, IResponse } from "@h3ravel/shared";
+import { DotNestedKeys, DotNestedValue, HttpContext as HttpContext$1, IApplication, IMiddleware, IParamBag, IRequest, IResponse, RequestMethod, RequestObject } from "@h3ravel/shared";
 import { EventHandlerRequest, H3Event, HTTPResponse } from "h3";
 import { Application } from "@h3ravel/core";
 import { Url } from "@h3ravel/url";
 
-//#region src/Contracts/HttpContract.d.ts
-type RequestMethod = 'HEAD' | 'GET' | 'PUT' | 'DELETE' | 'TRACE' | 'OPTIONS' | 'PURGE' | 'POST' | 'CONNECT' | 'PATCH';
-type RequestObject = Record<string, any>;
-//#endregion
 //#region src/Bags/ParamBag.d.ts
 /**
  * ParamBag is a container for key/value pairs
  * for Node/H3 environments.
  */
-declare class ParamBag implements Iterable<[string, any]> {
+declare class ParamBag implements IParamBag {
   protected parameters: RequestObject;
   /**
    * The current H3 H3Event instance
@@ -515,6 +511,37 @@ declare class FormRequest {
   all(): Record<string, any>;
 }
 //#endregion
+//#region src/HttpContext.d.ts
+/**
+ * Represents the HTTP context for a single request lifecycle.
+ * Encapsulates the application instance, request, and response objects.
+ */
+declare class HttpContext implements HttpContext$1 {
+  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.
+   * @param ctx - Object containing app, request, and response
+   * @returns A new HttpContext instance
+   */
+  static init(ctx: {
+    app: IApplication;
+    request: IRequest;
+    response: IResponse;
+  }, 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;
+}
+//#endregion
 //#region src/Middleware.d.ts
 declare abstract class Middleware implements IMiddleware {
   abstract handle(context: HttpContext, next: () => Promise<unknown>): Promise<unknown>;
@@ -524,7 +551,7 @@ declare abstract class Middleware implements IMiddleware {
 declare class LogRequests extends Middleware {
   handle({
     request
-  }: HttpContext$1, next: () => Promise<unknown>): Promise<unknown>;
+  }: HttpContext, next: () => Promise<unknown>): Promise<unknown>;
 }
 //#endregion
 //#region src/Providers/HttpServiceProvider.d.ts
@@ -662,9 +689,14 @@ declare class Request implements IRequest {
   /**
    * 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
+   * @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;
@@ -1049,4 +1081,4 @@ declare class Response implements IResponse {
   getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
 }
 //#endregion
-export { ApiResource, BadRequestException, FileBag, FireCommand, FormRequest, HeaderBag, HttpContext, HttpServiceProvider, InputBag, JsonResource, LogRequests, Middleware, ParamBag, Request, RequestMethod, RequestObject, Resource, Response, ServerBag, SuspiciousOperationException, UnexpectedValueException, UploadedFile };
+export { ApiResource, BadRequestException, FileBag, FireCommand, FormRequest, HeaderBag, HttpContext, HttpServiceProvider, InputBag, JsonResource, LogRequests, Middleware, ParamBag, Request, Resource, Response, ServerBag, SuspiciousOperationException, UnexpectedValueException, UploadedFile };

package/dist/index.js

@@ -2,7 +2,7 @@ import { i as __toESM, r as __require, t as __commonJS } from "./chunk-BLWcukCW.
 import { writeFile } from "fs/promises";
 import { Arr, Obj, Str, data_get, data_set, safeDot } from "@h3ravel/support";
 import { Command } from "@h3ravel/musket";
-import { HttpContext, Logger } from "@h3ravel/shared";
+import { Logger } from "@h3ravel/shared";
 import { fileURLToPath } from "node:url";
 import { ChildProcess, execFile, spawn, spawnSync } from "node:child_process";
 import { StringDecoder } from "node:string_decoder";
@@ -19012,6 +19012,44 @@ var FormRequest = class {
 	}
 };
 
+//#endregion
+//#region src/HttpContext.ts
+/**
+* Represents the HTTP context for a single request lifecycle.
+* Encapsulates the application instance, request, and response objects.
+*/
+var HttpContext = class HttpContext {
+	static contexts = /* @__PURE__ */ new WeakMap();
+	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, event) {
+		if (event && HttpContext.contexts.has(event)) return HttpContext.contexts.get(event);
+		const instance = new HttpContext(ctx.app, ctx.request, ctx.response);
+		if (event) HttpContext.contexts.set(event, instance);
+		return instance;
+	}
+	/**
+	* Retrieve an existing HttpContext instance for an event, if any.
+	*/
+	static get(event) {
+		return HttpContext.contexts.get(event);
+	}
+	/**
+	* Delete the cached context for a given event (optional cleanup).
+	*/
+	static forget(event) {
+		HttpContext.contexts.delete(event);
+	}
+};
+
 //#endregion
 //#region src/Middleware.ts
 var Middleware = class {};
@@ -19215,10 +19253,15 @@ var Request = class Request {
 	}
 	/**
 	* 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 
+	* @param expectArray set to true to return an `UploadedFile[]` array.
 	* @returns
 	*/
 	file(key, defaultValue, expectArray) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/http",
-  "version": "11.5.2",
+  "version": "11.6.0",
   "description": "HTTP kernel, middleware pipeline, request/response classes for H3ravel.",
   "h3ravel": {
     "providers": [
@@ -45,8 +45,8 @@
     "h3": "2.0.1-rc.5",
     "srvx": "^0.8.2",
     "@h3ravel/support": "^0.14.4",
-    "@h3ravel/url": "^1.0.8",
-    "@h3ravel/shared": "^0.25.0"
+    "@h3ravel/shared": "^0.26.0",
+    "@h3ravel/url": "^1.0.8"
   },
   "peerDependencies": {
     "@h3ravel/core": "^1.20.0"