@h3ravel/shared 0.8.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @h3ravel/shared
 
+## 0.10.0
+
+### Minor Changes
+
+- feat: hide RouterEnd from itslelf to prevent unintentional chaining.
+
+## 0.9.0
+
+### Minor Changes
+
+- refactor!: make route definition more similar to the way it is handled in laravel.
+
 ## 0.8.0
 
 ### Minor Changes

package/dist/index.d.cts

@@ -189,6 +189,7 @@ interface IResponse {
     getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
 }
 
+type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'name' | 'group' | 'route';
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
@@ -196,46 +197,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[]): Omit<this, RouterEnd>;
     /**
      * 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[]): Omit<this, RouterEnd>;
     /**
      * 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[]): Omit<this, RouterEnd>;
     /**
      * 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[]): Omit<this, RouterEnd>;
     /**
      * 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[]): Omit<this, RouterEnd>;
     /**
      * Generates a URL for a named route.
      * @param name - The name of the route.
@@ -243,6 +240,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.
@@ -251,14 +254,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;
@@ -287,4 +290,4 @@ interface IMiddleware {
     handle(context: HttpContext, next: () => Promise<any>): Promise<any>;
 }
 
-export type { DotFlatten, DotNestedKeys, DotNestedValue, EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider };
+export type { DotFlatten, DotNestedKeys, DotNestedValue, EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider, RouterEnd };

package/dist/index.d.ts

@@ -189,6 +189,7 @@ interface IResponse {
     getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
 }
 
+type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'name' | 'group' | 'route';
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
@@ -196,46 +197,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[]): Omit<this, RouterEnd>;
     /**
      * 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[]): Omit<this, RouterEnd>;
     /**
      * 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[]): Omit<this, RouterEnd>;
     /**
      * 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[]): Omit<this, RouterEnd>;
     /**
      * 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[]): Omit<this, RouterEnd>;
     /**
      * Generates a URL for a named route.
      * @param name - The name of the route.
@@ -243,6 +240,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.
@@ -251,14 +254,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;
@@ -287,4 +290,4 @@ interface IMiddleware {
     handle(context: HttpContext, next: () => Promise<any>): Promise<any>;
 }
 
-export type { DotFlatten, DotNestedKeys, DotNestedValue, EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider };
+export type { DotFlatten, DotNestedKeys, DotNestedValue, EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider, RouterEnd };

package/package.json

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

package/src/Contracts/IHttp.ts

@@ -4,6 +4,8 @@ import { IApplication } from './IApplication'
 import { IRequest } from './IRequest'
 import { IResponse } from './IResponse'
 
+export type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'name' | 'group' | 'route';
+
 /**
  * Interface for the Router contract, defining methods for HTTP routing.
  */
@@ -11,66 +13,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;
+    ): Omit<this, RouterEnd>;
 
     /**
      * 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;
+    ): Omit<this, RouterEnd>;
 
     /**
      * 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;
+    ): Omit<this, RouterEnd>;
 
     /**
      * 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;
+    ): Omit<this, RouterEnd>;
 
     /**
      * Registers an API resource with standard CRUD routes.
@@ -82,7 +76,7 @@ export interface IRouter {
         path: string,
         controller: new (app: IApplication) => IController,
         middleware?: IMiddleware[]
-    ): void;
+    ): Omit<this, RouterEnd>;
 
     /**
      * Generates a URL for a named route.
@@ -92,12 +86,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 +107,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 {