@h3ravel/shared 0.10.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @h3ravel/shared
 
+## 0.12.0
+
+### Minor Changes
+
+- feat: add the current app instance to the Request and Response object
+
+## 0.11.0
+
+### Minor Changes
+
+- remove 'name' from RouterEnd and only join in apiResource.
+
 ## 0.10.0
 
 ### Minor Changes

package/dist/index.d.cts

@@ -103,17 +103,9 @@ type DotNestedValue<T, Path extends string> = Path extends `${infer Key}.${infer
  */
 interface IRequest {
     /**
-     * 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.
+     * The current app instance
      */
-    input<T = unknown>(key: string, defaultValue?: T): Promise<T>;
+    app: IApplication;
     /**
      * Gets route parameters.
      * @returns An object containing route parameters.
@@ -129,6 +121,18 @@ interface IRequest {
      * @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.
@@ -142,6 +146,10 @@ interface IRequest {
  * Interface for the Response contract, defining methods for handling HTTP responses.
  */
 interface IResponse {
+    /**
+     * The current app instance
+     */
+    app: IApplication;
     /**
      * Sets the HTTP status code for the response.
      * @param code - The HTTP status code.
@@ -189,7 +197,7 @@ interface IResponse {
     getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
 }
 
-type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'name' | 'group' | 'route';
+type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'group' | 'route';
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
@@ -232,7 +240,7 @@ interface IRouter {
      * @param controller - The controller class handling the resource.
      * @param middleware - Optional middleware array.
      */
-    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
+    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): Omit<this, RouterEnd | 'name'>;
     /**
      * Generates a URL for a named route.
      * @param name - The name of the route.

package/dist/index.d.ts

@@ -103,17 +103,9 @@ type DotNestedValue<T, Path extends string> = Path extends `${infer Key}.${infer
  */
 interface IRequest {
     /**
-     * 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.
+     * The current app instance
      */
-    input<T = unknown>(key: string, defaultValue?: T): Promise<T>;
+    app: IApplication;
     /**
      * Gets route parameters.
      * @returns An object containing route parameters.
@@ -129,6 +121,18 @@ interface IRequest {
      * @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.
@@ -142,6 +146,10 @@ interface IRequest {
  * Interface for the Response contract, defining methods for handling HTTP responses.
  */
 interface IResponse {
+    /**
+     * The current app instance
+     */
+    app: IApplication;
     /**
      * Sets the HTTP status code for the response.
      * @param code - The HTTP status code.
@@ -189,7 +197,7 @@ interface IResponse {
     getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
 }
 
-type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'name' | 'group' | 'route';
+type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'group' | 'route';
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
@@ -232,7 +240,7 @@ interface IRouter {
      * @param controller - The controller class handling the resource.
      * @param middleware - Optional middleware array.
      */
-    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
+    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): Omit<this, RouterEnd | 'name'>;
     /**
      * Generates a URL for a named route.
      * @param name - The name of the route.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/shared",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Shared Utilities.",
   "type": "module",
   "main": "dist/index.js",

package/src/Contracts/IHttp.ts

@@ -4,7 +4,7 @@ import { IApplication } from './IApplication'
 import { IRequest } from './IRequest'
 import { IResponse } from './IResponse'
 
-export type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'name' | 'group' | 'route';
+export type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'group' | 'route';
 
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
@@ -76,7 +76,7 @@ export interface IRouter {
         path: string,
         controller: new (app: IApplication) => IController,
         middleware?: IMiddleware[]
-    ): Omit<this, RouterEnd>;
+    ): Omit<this, RouterEnd | 'name'>;
 
     /**
      * Generates a URL for a named route.

package/src/Contracts/IRequest.ts

@@ -2,24 +2,16 @@ import { DotNestedKeys, DotNestedValue } from './ObjContract'
 import type { ResponseHeaderMap, TypedHeaders } from 'fetchdts'
 
 import type { H3Event } from 'h3'
+import type { IApplication } from './IApplication';
 
 /**
  * Interface for the Request contract, defining methods for handling HTTP request data.
  */
 export interface IRequest {
     /**
-     * Gets all input data (query parameters, route parameters, and body).
-     * @returns A promise resolving to an object containing all input data.
+     * The current app instance
      */
-    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>;
+    app: IApplication
 
     /**
      * Gets route parameters.
@@ -39,6 +31,20 @@ export interface IRequest {
      */
     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.

package/src/Contracts/IResponse.ts

@@ -1,11 +1,17 @@
 import { DotNestedKeys, DotNestedValue } from './ObjContract'
 
 import type { H3Event } from 'h3'
+import type { IApplication } from './IApplication';
 
 /**
  * Interface for the Response contract, defining methods for handling HTTP responses.
  */
 export interface IResponse {
+    /**
+     * The current app instance
+     */
+    app: IApplication
+
     /**
      * Sets the HTTP status code for the response.
      * @param code - The HTTP status code.