@h3ravel/http 11.18.4 → 11.19.0

package/dist/index.d.ts

@@ -3,7 +3,8 @@ import { Command } from "@h3ravel/musket";
 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 { ResponseCodes } from "@h3ravel/foundation";
 import { DateTime } from "@h3ravel/support";
-import { EventHandlerRequest, H3Event, HTTPResponse } from "h3";
+import { H3Event, HTTPResponse } from "h3";
+import { Collectible, CollectionLike, NonCollectible, PaginatorLike, ResoraConfig as ResourceConfig, Resource as Resource$1, ResourceCollection, ResourceData } from "resora";
 
 //#region src/Commands/FireCommand.d.ts
 declare class FireCommand extends Command {
@@ -904,6 +905,11 @@ declare class LogRequests extends Middleware {
   handle(request: IRequest, next: (request: IRequest) => Promise<unknown>): Promise<unknown>;
 }
 //#endregion
+//#region src/Middleware/ResoraMiddleware.d.ts
+declare class ResoraMiddleware extends Middleware {
+  handle(request: IRequest, next: (request: IRequest) => Promise<unknown>): Promise<unknown>;
+}
+//#endregion
 //#region src/Middleware/TrustHosts.d.ts
 declare class TrustHosts extends Middleware {
   /**
@@ -2066,100 +2072,11 @@ declare class Request<D extends Record<string, any> = Record<string, any>, R ext
   getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
 }
 //#endregion
-//#region src/Resources/JsonResource.d.ts
-interface Resource {
-  [key: string]: any;
-  pagination?: {
-    from?: number | undefined;
-    to?: number | undefined;
-    perPage?: number | undefined;
-    total?: number | undefined;
-  } | undefined;
-}
-type BodyResource = Resource & {
-  data: Omit<Resource, 'pagination'>;
-  meta?: {
-    pagination?: Resource['pagination'];
-  } | undefined;
-};
-/**
- * Class to render API resource
- */
-declare class JsonResource<R extends Resource = any> {
-  #private;
-  protected event: H3Event;
-  /**
-   * The request instance
-   */
-  request: H3Event<EventHandlerRequest>['req'];
-  /**
-   * The response instance
-   */
-  response: H3Event['res'];
-  /**
-   * The data to send to the client
-   */
-  resource: R;
-  /**
-   * The final response data object
-   */
-  body: BodyResource;
-  /**
-   * Flag to track if response should be sent automatically
-   */
-  private shouldSend;
-  /**
-   * Flag to track if response has been sent
-   */
-  private responseSent;
-  /**
-   * Declare that this includes R's properties
-   */
-  [key: string]: any;
-  /**
-   * @param req The request instance
-   * @param res The response instance
-   * @param rsc The data to send to the client
-   */
-  constructor(event: H3Event, rsc: R);
-  /**
-   * Return the data in the expected format
-   *
-   * @returns
-   */
-  data(): Resource;
-  /**
-   * Build the response object
-   * @returns this
-   */
-  json(): this;
-  /**
-   * Add context data to the response object
-   * @param data Context data
-   * @returns this
-   */
-  additional<X extends {
-    [key: string]: any;
-  }>(data: X): this;
-  /**
-   * Send the output to the client
-   * @returns this
-   */
-  send(): this;
-  /**
-   * Set the status code for this response
-   * @param code Status code
-   * @returns this
-   */
-  status(code: number): this;
-  /**
-   * Check if send should be triggered automatically
-   */
-  private checkSend;
-}
+//#region src/Resources/Collection.d.ts
+declare class Collection<R extends ResourceData[] | Collectible | CollectionLike | PaginatorLike = ResourceData[] | Collectible | CollectionLike | PaginatorLike, T extends ResourceData = any> extends ResourceCollection<R, T> {}
 //#endregion
-//#region src/Resources/ApiResource.d.ts
-declare function ApiResource(instance: JsonResource): JsonResource<any>;
+//#region src/Resources/Resource.d.ts
+declare class Resource<R extends ResourceData | NonCollectible = ResourceData> extends Resource$1<R> {}
 //#endregion
 //#region src/Utilities/HeaderUtility.d.ts
 /**
@@ -2266,4 +2183,4 @@ declare class IpUtils {
   private static setCacheResult;
 }
 //#endregion
-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 };
+export { BadRequestException, Collection, ConflictingHeadersException, Cookie, FileBag, FireCommand, FlashDataMiddleware, FormRequest, HeaderBag, HeaderUtility, HttpContext, HttpRequest, HttpResponse, HttpResponseException, HttpServiceProvider, InputBag, IpUtils, JsonResponse, LogRequests, Middleware, ParamBag, Request, ResoraMiddleware, Resource, type ResourceConfig, Responsable, Response, ResponseHeaderBag, ServerBag, SuspiciousOperationException, TrustHosts, UnexpectedValueException, UploadedFile };

package/dist/index.js

@@ -5,9 +5,9 @@ import preferredPM from "preferred-pm";
 import { writeFile } from "fs/promises";
 import { IApplication, IHeaderBag, IHttpContext, IHttpResponse, IMiddleware, IRequest, IResponsable, IResponse } from "@h3ravel/contracts";
 import { HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES, Injectable, ResponseCodes, statusTexts } from "@h3ravel/foundation";
-import { Response as Response$1 } from "@h3ravel/support/facades";
 import { Arr, DateTime, InvalidArgumentException, Obj, RuntimeException, Str, data_get, data_set, safeDot } from "@h3ravel/support";
 import { H3Event, getQuery, getRequestIP, getRequestProtocol, getRouterParams, parseCookies } from "h3";
+import { Resource as Resource$1, ResourceCollection } from "resora";
 //#region src/Commands/FireCommand.ts
 var FireCommand = class extends Command {
 	/**
@@ -247,7 +247,7 @@ __decorate([
 var LogRequests = class extends Middleware {
 	async handle(request, next) {
 		const _next = await next(request);
-		const code = Number(Response$1.getStatusCode());
+		const code = request.getEvent().res.status ?? 200;
 		const method = request.method().toLowerCase();
 		let color = "bgRed";
 		if (code < 200) color = "bgWhite";
@@ -273,6 +273,36 @@ __decorate([
 	__decorateMetadata("design:returntype", Promise)
 ], LogRequests.prototype, "handle", null);
 //#endregion
+//#region src/Middleware/ResoraMiddleware.ts
+var ResoraMiddleware = class extends Middleware {
+	async handle(request, next) {
+		const { applyRuntimeConfig, runWithCtx } = await import("resora");
+		const { req, res } = request.context.event;
+		applyRuntimeConfig(Object.assign({}, config("resources"), {
+			resourcesDir: "src/app/http/resources",
+			localStubsDir: "node_modules/@h3ravel/http/stubs",
+			stubs: {
+				resource: "resource.stub",
+				collection: "resource.collection.stub",
+				controller: "controller.stub",
+				api: "controller.api.stub",
+				model: "controller.model.stub",
+				apiResource: "controller.api.resource.stub"
+			}
+		}));
+		return runWithCtx({
+			res,
+			req
+		}, () => next(request));
+	}
+};
+__decorate([
+	Injectable(),
+	__decorateMetadata("design:type", Function),
+	__decorateMetadata("design:paramtypes", [typeof IRequest === "undefined" ? Object : IRequest, Function]),
+	__decorateMetadata("design:returntype", Promise)
+], ResoraMiddleware.prototype, "handle", null);
+//#endregion
 //#region src/HttpContext.ts
 /**
 * Represents the HTTP context for a single request lifecycle.
@@ -289,6 +319,7 @@ var HttpContext = class HttpContext extends IHttpContext {
 		this.app = app;
 		this.request = request;
 		this.response = response;
+		this.app.bindMiddleware("ResoraMiddleware", ResoraMiddleware);
 		this.app.bindMiddleware("LogRequests", LogRequests);
 		this.app.bindMiddleware("FlashDataMiddleware", FlashDataMiddleware);
 	}
@@ -1098,6 +1129,7 @@ var HttpResponse = class HttpResponse extends IHttpResponse {
 		super();
 		this.event = event;
 		this.headers = new ResponseHeaderBag(this.event);
+		this.sentHeaders = Object.fromEntries(Array.from(this.event.res.headers.entries(), ([name, value]) => [name, [value]]));
 		this.setContent();
 		this.setProtocolVersion("1.0");
 	}
@@ -4012,151 +4044,10 @@ var Request = class Request extends HttpRequest {
 	}
 };
 //#endregion
-//#region src/Resources/JsonResource.ts
-/**
-* Class to render API resource
-*/
-var JsonResource = class {
-	event;
-	/**
-	* The request instance
-	*/
-	request;
-	/**
-	* The response instance
-	*/
-	response;
-	/**
-	* The data to send to the client
-	*/
-	resource;
-	/**
-	* The final response data object
-	*/
-	body = { data: {} };
-	/**
-	* Flag to track if response should be sent automatically
-	*/
-	shouldSend = false;
-	/**
-	* Flag to track if response has been sent
-	*/
-	responseSent = false;
-	/**
-	* @param req The request instance
-	* @param res The response instance
-	* @param rsc The data to send to the client
-	*/
-	constructor(event, rsc) {
-		this.event = event;
-		this.request = event.req;
-		this.response = event.res;
-		this.resource = rsc;
-		for (const key of Object.keys(rsc)) if (!(key in this)) Object.defineProperty(this, key, {
-			enumerable: true,
-			configurable: true,
-			get: () => this.resource[key],
-			set: (value) => {
-				this.resource[key] = value;
-			}
-		});
-	}
-	/**
-	* Return the data in the expected format
-	* 
-	* @returns 
-	*/
-	data() {
-		return this.resource;
-	}
-	/**
-	* Build the response object
-	* @returns this
-	*/
-	json() {
-		this.shouldSend = true;
-		this.response.status = 200;
-		const resource = this.data();
-		let data = Array.isArray(resource) ? [...resource] : { ...resource };
-		if (typeof data.data !== "undefined") data = data.data;
-		if (!Array.isArray(resource)) delete data.pagination;
-		this.body = { data };
-		if (!Array.isArray(resource) && resource.pagination) {
-			const meta = this.body.meta ?? {};
-			meta.pagination = resource.pagination;
-			this.body.meta = meta;
-		}
-		if (this.resource.pagination && !this.body.meta?.pagination) {
-			const meta = this.body.meta ?? {};
-			meta.pagination = this.resource.pagination;
-			this.body.meta = meta;
-		}
-		return this;
-	}
-	/**
-	* Add context data to the response object
-	* @param data Context data
-	* @returns this
-	*/
-	additional(data) {
-		this.shouldSend = true;
-		delete data.data;
-		delete data.pagination;
-		this.body = {
-			...this.body,
-			...data
-		};
-		return this;
-	}
-	/**
-	* Send the output to the client
-	* @returns this
-	*/
-	send() {
-		this.shouldSend = false;
-		if (!this.responseSent) this.#send();
-		return this;
-	}
-	/**
-	* Set the status code for this response
-	* @param code Status code
-	* @returns this
-	*/
-	status(code) {
-		this.response.status = code;
-		return this;
-	}
-	/**
-	* Private method to send the response
-	*/
-	#send() {
-		if (!this.responseSent) this.responseSent = true;
-	}
-	/**
-	* Check if send should be triggered automatically
-	*/
-	checkSend() {
-		if (this.shouldSend && !this.responseSent) this.#send();
-	}
-};
+//#region src/Resources/Collection.ts
+var Collection = class extends ResourceCollection {};
 //#endregion
-//#region src/Resources/ApiResource.ts
-function ApiResource(instance) {
-	return new Proxy(instance, { get(target, prop, receiver) {
-		const value = Reflect.get(target, prop, receiver);
-		if (typeof value === "function") {
-			if (prop === "json" || prop === "additional") return (...args) => {
-				const result = value.apply(target, args);
-				setImmediate(() => target["checkSend"]());
-				return result;
-			};
-			else if (prop === "send") return (...args) => {
-				target["shouldSend"] = false;
-				return value.apply(target, args);
-			};
-		}
-		return value;
-	} });
-}
+//#region src/Resources/Resource.ts
+var Resource = class extends Resource$1 {};
 //#endregion
-export { ApiResource, BadRequestException, ConflictingHeadersException, Cookie, FileBag, FireCommand, FlashDataMiddleware, FormRequest, HeaderBag, HeaderUtility, HttpContext, HttpRequest, HttpResponse, HttpResponseException, HttpServiceProvider, InputBag, IpUtils, JsonResource, JsonResponse, LogRequests, Middleware, ParamBag, Request, Responsable, Response, ResponseHeaderBag, ServerBag, SuspiciousOperationException, TrustHosts, UnexpectedValueException, UploadedFile };
+export { BadRequestException, Collection, ConflictingHeadersException, Cookie, FileBag, FireCommand, FlashDataMiddleware, FormRequest, HeaderBag, HeaderUtility, HttpContext, HttpRequest, HttpResponse, HttpResponseException, HttpServiceProvider, InputBag, IpUtils, JsonResponse, LogRequests, Middleware, ParamBag, Request, ResoraMiddleware, Resource, Responsable, Response, ResponseHeaderBag, ServerBag, SuspiciousOperationException, TrustHosts, UnexpectedValueException, UploadedFile };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/http",
-  "version": "11.18.4",
+  "version": "11.19.0",
   "description": "HTTP kernel, middleware pipeline, request/response classes for H3ravel.",
   "h3ravel": {
     "providers": [
@@ -39,17 +39,18 @@
     "laravel"
   ],
   "dependencies": {
-    "@h3ravel/contracts": "^2.1.4",
-    "@h3ravel/support": "^2.1.4",
+    "@h3ravel/contracts": "^2.2.0",
+    "@h3ravel/support": "^2.2.0",
     "@h3ravel/musket": "^1.29.0-alpha.15",
-    "@h3ravel/shared": "^2.1.4",
-    "@h3ravel/session": "^2.1.4",
+    "@h3ravel/shared": "^2.2.0",
+    "@h3ravel/session": "^2.2.0",
     "h3": "2.0.1-rc.5",
+    "resora": "^1.3.18",
     "srvx": "^0.8.2"
   },
   "peerDependencies": {
-    "@h3ravel/validation": "^2.1.4",
-    "@h3ravel/foundation": "^2.1.4"
+    "@h3ravel/validation": "^2.2.0",
+    "@h3ravel/foundation": "^2.2.0"
   },
   "devDependencies": {
     "typescript": "^6.0.0"