@h3ravel/shared 0.7.1 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @h3ravel/shared
 
+## 0.9.0
+
+### Minor Changes
+
+- refactor!: make route definition more similar to the way it is handled in laravel.
+
+## 0.8.0
+
+### Minor Changes
+
+- feat: convert Request params and query from a method to a property and add Request headers
+
 ## 0.7.1
 
 ### Patch Changes

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { H3Event, Middleware, MiddlewareOptions } from 'h3';
+import { TypedHeaders, ResponseHeaderMap } from 'fetchdts';
 
 interface IServiceProvider {
     /**
@@ -117,12 +118,17 @@ interface IRequest {
      * Gets route parameters.
      * @returns An object containing route parameters.
      */
-    params<T = Record<string, string>>(): T;
+    params: NonNullable<H3Event["context"]["params"]>;
     /**
      * Gets query parameters.
      * @returns An object containing query parameters.
      */
-    query<T = Record<string, string>>(): T;
+    query: Record<string, any>;
+    /**
+     * Gets the request headers.
+     * @returns An object containing request headers.
+     */
+    headers: TypedHeaders<Record<keyof ResponseHeaderMap, string>>;
     /**
      * Gets the underlying event object or a specific property of it.
      * @param key - Optional key to access a nested property of the event.
@@ -190,46 +196,42 @@ interface IRouter {
     /**
      * Registers a GET route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
-    get(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    get(path: string, definition: EventHandler | [(new (...args: any[]) => IController), methodName: string], name?: string, middleware?: IMiddleware[]): this;
     /**
      * Registers a POST route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
-    post(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    post(path: string, definition: EventHandler | [(new (...args: any[]) => IController), methodName: string], name?: string, middleware?: IMiddleware[]): this;
     /**
      * Registers a PUT route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
-    put(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    put(path: string, definition: EventHandler | [(new (...args: any[]) => IController), methodName: string], name?: string, middleware?: IMiddleware[]): this;
     /**
      * Registers a DELETE route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
-    delete(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    delete(path: string, definition: EventHandler | [(new (...args: any[]) => IController), methodName: string], name?: string, middleware?: IMiddleware[]): this;
     /**
      * Registers an API resource with standard CRUD routes.
      * @param path - The base path for the resource.
      * @param controller - The controller class handling the resource.
      * @param middleware - Optional middleware array.
      */
-    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): void;
+    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): this;
     /**
      * Generates a URL for a named route.
      * @param name - The name of the route.
@@ -237,6 +239,12 @@ interface IRouter {
      * @returns The generated URL or undefined if the route is not found.
      */
     route(name: string, params?: Record<string, string>): string | undefined;
+    /**
+     * Set the name of the current route
+     *
+     * @param name
+     */
+    name(name: string): this;
     /**
      * Groups routes with shared prefix or middleware.
      * @param options - Configuration for prefix or middleware.
@@ -245,14 +253,14 @@ interface IRouter {
     group(options: {
         prefix?: string;
         middleware?: EventHandler[];
-    }, callback: () => void): void;
+    }, callback: () => void): this;
     /**
      * Registers middleware for a specific path.
      * @param path - The path to apply the middleware.
      * @param handler - The middleware handler.
      * @param opts - Optional middleware options.
      */
-    middleware(path: string, handler: Middleware, opts?: MiddlewareOptions): void;
+    middleware(path: string | IMiddleware[], handler: Middleware, opts?: MiddlewareOptions): this;
 }
 interface HttpContext {
     request: IRequest;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { H3Event, Middleware, MiddlewareOptions } from 'h3';
+import { TypedHeaders, ResponseHeaderMap } from 'fetchdts';
 
 interface IServiceProvider {
     /**
@@ -117,12 +118,17 @@ interface IRequest {
      * Gets route parameters.
      * @returns An object containing route parameters.
      */
-    params<T = Record<string, string>>(): T;
+    params: NonNullable<H3Event["context"]["params"]>;
     /**
      * Gets query parameters.
      * @returns An object containing query parameters.
      */
-    query<T = Record<string, string>>(): T;
+    query: Record<string, any>;
+    /**
+     * Gets the request headers.
+     * @returns An object containing request headers.
+     */
+    headers: TypedHeaders<Record<keyof ResponseHeaderMap, string>>;
     /**
      * Gets the underlying event object or a specific property of it.
      * @param key - Optional key to access a nested property of the event.
@@ -190,46 +196,42 @@ interface IRouter {
     /**
      * Registers a GET route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
-    get(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    get(path: string, definition: EventHandler | [(new (...args: any[]) => IController), methodName: string], name?: string, middleware?: IMiddleware[]): this;
     /**
      * Registers a POST route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
-    post(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    post(path: string, definition: EventHandler | [(new (...args: any[]) => IController), methodName: string], name?: string, middleware?: IMiddleware[]): this;
     /**
      * Registers a PUT route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
-    put(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    put(path: string, definition: EventHandler | [(new (...args: any[]) => IController), methodName: string], name?: string, middleware?: IMiddleware[]): this;
     /**
      * Registers a DELETE route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
-    delete(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    delete(path: string, definition: EventHandler | [(new (...args: any[]) => IController), methodName: string], name?: string, middleware?: IMiddleware[]): this;
     /**
      * Registers an API resource with standard CRUD routes.
      * @param path - The base path for the resource.
      * @param controller - The controller class handling the resource.
      * @param middleware - Optional middleware array.
      */
-    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): void;
+    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): this;
     /**
      * Generates a URL for a named route.
      * @param name - The name of the route.
@@ -237,6 +239,12 @@ interface IRouter {
      * @returns The generated URL or undefined if the route is not found.
      */
     route(name: string, params?: Record<string, string>): string | undefined;
+    /**
+     * Set the name of the current route
+     *
+     * @param name
+     */
+    name(name: string): this;
     /**
      * Groups routes with shared prefix or middleware.
      * @param options - Configuration for prefix or middleware.
@@ -245,14 +253,14 @@ interface IRouter {
     group(options: {
         prefix?: string;
         middleware?: EventHandler[];
-    }, callback: () => void): void;
+    }, callback: () => void): this;
     /**
      * Registers middleware for a specific path.
      * @param path - The path to apply the middleware.
      * @param handler - The middleware handler.
      * @param opts - Optional middleware options.
      */
-    middleware(path: string, handler: Middleware, opts?: MiddlewareOptions): void;
+    middleware(path: string | IMiddleware[], handler: Middleware, opts?: MiddlewareOptions): this;
 }
 interface HttpContext {
     request: IRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/shared",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "description": "Shared Utilities.",
   "type": "module",
   "main": "dist/index.js",
@@ -21,6 +21,11 @@
   "dependencies": {
     "h3": "^2.0.0-beta.1"
   },
+  "devDependencies": {
+    "fetchdts": "^0.1.6",
+    "install": "^0.13.0",
+    "pnpm": "^10.14.0"
+  },
   "scripts": {
     "build": "tsup",
     "barrel": "barrelsby --directory src --delete --singleQuotes",

package/src/Contracts/IHttp.ts

@@ -11,66 +11,58 @@ export interface IRouter {
     /**
      * Registers a GET route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
     get (
         path: string,
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string,
+        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
         name?: string,
         middleware?: IMiddleware[]
-    ): void;
+    ): this;
 
     /**
      * Registers a POST route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
     post (
         path: string,
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string,
+        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
         name?: string,
         middleware?: IMiddleware[]
-    ): void;
+    ): this;
 
     /**
      * Registers a PUT route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
     put (
         path: string,
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string,
+        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
         name?: string,
         middleware?: IMiddleware[]
-    ): void;
+    ): this;
 
     /**
      * Registers a DELETE route.
      * @param path - The route path.
-     * @param handler - The handler function or controller class.
-     * @param methodName - Optional controller method name.
+     * @param definition - The handler function or [controller class, method] array.
      * @param name - Optional route name.
      * @param middleware - Optional middleware array.
      */
     delete (
         path: string,
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string,
+        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
         name?: string,
         middleware?: IMiddleware[]
-    ): void;
+    ): this;
 
     /**
      * Registers an API resource with standard CRUD routes.
@@ -82,7 +74,7 @@ export interface IRouter {
         path: string,
         controller: new (app: IApplication) => IController,
         middleware?: IMiddleware[]
-    ): void;
+    ): this;
 
     /**
      * Generates a URL for a named route.
@@ -92,12 +84,20 @@ export interface IRouter {
      */
     route (name: string, params?: Record<string, string>): string | undefined;
 
+
+    /**
+     * Set the name of the current route
+     * 
+     * @param name 
+     */
+    name (name: string): this
+
     /**
      * Groups routes with shared prefix or middleware.
      * @param options - Configuration for prefix or middleware.
      * @param callback - Callback function defining grouped routes.
      */
-    group (options: { prefix?: string; middleware?: EventHandler[] }, callback: () => void): void;
+    group (options: { prefix?: string; middleware?: EventHandler[] }, callback: () => void): this;
 
     /**
      * Registers middleware for a specific path.
@@ -105,7 +105,7 @@ export interface IRouter {
      * @param handler - The middleware handler.
      * @param opts - Optional middleware options.
      */
-    middleware (path: string, handler: Middleware, opts?: MiddlewareOptions): void;
+    middleware (path: string | IMiddleware[], handler: Middleware, opts?: MiddlewareOptions): this;
 }
 
 export interface HttpContext {

package/src/Contracts/IRequest.ts

@@ -1,4 +1,5 @@
 import { DotNestedKeys, DotNestedValue } from './ObjContract'
+import type { ResponseHeaderMap, TypedHeaders } from 'fetchdts'
 
 import type { H3Event } from 'h3'
 
@@ -24,13 +25,19 @@ export interface IRequest {
      * Gets route parameters.
      * @returns An object containing route parameters.
      */
-    params<T = Record<string, string>> (): T;
+    params: NonNullable<H3Event["context"]["params"]>;
 
     /**
      * Gets query parameters.
      * @returns An object containing query parameters.
      */
-    query<T = Record<string, string>> (): T;
+    query: Record<string, any>;
+
+    /**
+     * Gets the request headers.
+     * @returns An object containing request headers.
+     */
+    headers: TypedHeaders<Record<keyof ResponseHeaderMap, string>>;
 
     /**
      * Gets the underlying event object or a specific property of it.