@h3ravel/router 1.8.3 → 1.9.1

package/dist/index.d.ts

@@ -1,17 +1,52 @@
-import { ServiceProvider, Application } from '@h3ravel/core';
-import { H3, Middleware, MiddlewareOptions } from 'h3';
-import { IRouter, RouteEventHandler, IMiddleware, RouterEnd, IController, EventHandler } from '@h3ravel/shared';
+/// <reference path="./app.globals.d.ts" />
+import { Application, ServiceProvider } from "@h3ravel/core";
+import { H3, Middleware, MiddlewareOptions } from "h3";
+import "reflect-metadata";
+import { EventHandler, HttpContext, IController, IMiddleware, IRouter, RouteEventHandler, RouterEnd } from "@h3ravel/shared";
+import { Model } from "@h3ravel/database";
 
+//#region src/Helpers.d.ts
+declare class Helpers {
+  /**
+   * Extracts parameter names from a route path string.
+   *
+   * - Looks for segments prefixed with ":" (e.g. "/users/:id")
+   * - Captures only the param name (without the ":")
+   * - Returns all matches in order of appearance
+   *
+   * @param path - The route path string (e.g. "/groups/:group/users/:user")
+   * @returns An array of parameter names (e.g. ["group", "user"])
+   */
+  static extractParams(path: string): string[];
+  /**
+   * Resolves route model binding for a given path, HTTP context, and model.
+   *
+   * - Extracts all route parameters from the given path
+   * - If a parameter matches the model name, it attempts to resolve the model binding
+   *   using the provided value and binding field (defaults to "id" unless specified).
+   * - For non-matching parameters, it simply returns the key-value pair as is.
+   * - If no parameters are found, returns an empty object.
+   *
+   * @param path - The route path (e.g. "/groups/:group/users/:user")
+   * @param ctx - The HTTP context containing the request
+   * @param model - The model instance to resolve bindings against
+   * @returns A resolved model instance or an object containing param values
+   */
+  static resolveRouteModelBinding(path: string, ctx: HttpContext, model: Model): Promise<any>;
+}
+//#endregion
+//#region src/Providers/AssetsServiceProvider.d.ts
 /**
  * Handles public assets loading
  *
  * Auto-Registered
  */
 declare class AssetsServiceProvider extends ServiceProvider {
-    static priority: number;
-    register(): void;
+  static priority: number;
+  register(): void;
 }
-
+//#endregion
+//#region src/Providers/RouteServiceProvider.d.ts
 /**
  * Handles routing registration
  *
@@ -22,149 +57,151 @@ declare class AssetsServiceProvider extends ServiceProvider {
  * Auto-Registered
  */
 declare class RouteServiceProvider extends ServiceProvider {
-    static priority: number;
-    register(): void;
-    /**
-     * Load routes from src/routes
-     */
-    boot(): Promise<void>;
+  static priority: number;
+  register(): void;
+  /**
+   * Load routes from src/routes
+   */
+  boot(): Promise<void>;
 }
-
+//#endregion
+//#region src/Route.d.ts
 declare class Router implements IRouter {
-    protected h3App: H3;
-    private app;
-    private routes;
-    private nameMap;
-    private groupPrefix;
-    private middlewareMap;
-    private groupMiddleware;
-    constructor(h3App: H3, app: Application);
-    /**
-     * Route Resolver
-     *
-     * @param handler
-     * @param middleware
-     * @returns
-     */
-    private resolveHandler;
-    /**
-     * Add a route to the stack
-     *
-     * @param method
-     * @param path
-     * @param handler
-     * @param name
-     * @param middleware
-     */
-    private addRoute;
-    /**
-     * Resolves a route handler definition into an executable EventHandler.
-     *
-     * A handler can be:
-     *   - A function matching the EventHandler signature
-     *   - A controller class (optionally decorated for IoC resolution)
-     *
-     * If it’s a controller class, this method will:
-     *   - Instantiate it (via IoC or manually)
-     *   - Call the specified method (defaults to `index`)
-     *
-     * @param handler     Event handler function OR controller class
-     * @param methodName  Method to invoke on the controller (defaults to 'index')
-     */
-    private resolveControllerOrHandler;
-    /**
-     * Registers a route that responds to HTTP GET requests.
-     *
-     * @param path        The URL pattern to match (can include parameters, e.g., '/users/:id').
-     * @param definition  Either:
-     *                      - An EventHandler function
-     *                      - A tuple: [ControllerClass, methodName]
-     * @param name        Optional route name (for URL generation or referencing).
-     * @param middleware  Optional array of middleware functions to execute before the handler.
-     */
-    get(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
-    /**
-     * Registers a route that responds to HTTP POST requests.
-     *
-     * @param path        The URL pattern to match (can include parameters, e.g., '/users').
-     * @param definition  Either:
-     *                      - An EventHandler function
-     *                      - A tuple: [ControllerClass, methodName]
-     * @param name        Optional route name (for URL generation or referencing).
-     * @param middleware  Optional array of middleware functions to execute before the handler.
-     */
-    post(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
-    /**
-     * Registers a route that responds to HTTP PUT requests.
-     *
-     * @param path        The URL pattern to match (can include parameters, e.g., '/users/:id').
-     * @param definition  Either:
-     *                      - An EventHandler function
-     *                      - A tuple: [ControllerClass, methodName]
-     * @param name        Optional route name (for URL generation or referencing).
-     * @param middleware  Optional array of middleware functions to execute before the handler.
-     */
-    put(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
-    /**
-     * Registers a route that responds to HTTP PATCH requests.
-     *
-     * @param path        The URL pattern to match (can include parameters, e.g., '/users/:id').
-     * @param definition  Either:
-     *                      - An EventHandler function
-     *                      - A tuple: [ControllerClass, methodName]
-     * @param name        Optional route name (for URL generation or referencing).
-     * @param middleware  Optional array of middleware functions to execute before the handler.
-     */
-    patch(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
-    /**
-     * Registers a route that responds to HTTP DELETE requests.
-     *
-     * @param path        The URL pattern to match (can include parameters, e.g., '/users/:id').
-     * @param definition  Either:
-     *                      - An EventHandler function
-     *                      - A tuple: [ControllerClass, methodName]
-     * @param name        Optional route name (for URL generation or referencing).
-     * @param middleware  Optional array of middleware functions to execute before the handler.
-     */
-    delete(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
-    /**
-     * API Resource support
-     *
-     * @param path
-     * @param controller
-     */
-    apiResource(path: string, Controller: new (app: Application) => IController, middleware?: IMiddleware[]): Omit<this, RouterEnd | 'name'>;
-    /**
-     * Named route URL generator
-     *
-     * @param name
-     * @param params
-     * @returns
-     */
-    route(name: string, params?: Record<string, string>): string | undefined;
-    /**
-     * Grouping
-     *
-     * @param options
-     * @param callback
-     */
-    group(options: {
-        prefix?: string;
-        middleware?: EventHandler[];
-    }, callback: (_e: this) => void): this;
-    /**
-     * Set the name of the current route
-     *
-     * @param name
-     */
-    name(name: string): 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 | IMiddleware[], handler: Middleware, opts?: MiddlewareOptions): this;
+  protected h3App: H3;
+  private app;
+  private routes;
+  private nameMap;
+  private groupPrefix;
+  private middlewareMap;
+  private groupMiddleware;
+  constructor(h3App: H3, app: Application);
+  /**
+   * Route Resolver
+   *
+   * @param handler
+   * @param middleware
+   * @returns
+   */
+  private resolveHandler;
+  /**
+   * Add a route to the stack
+   *
+   * @param method
+   * @param path
+   * @param handler
+   * @param name
+   * @param middleware
+   */
+  private addRoute;
+  /**
+   * Resolves a route handler definition into an executable EventHandler.
+   *
+   * A handler can be:
+   *   - A function matching the EventHandler signature
+   *   - A controller class (optionally decorated for IoC resolution)
+   *
+   * If it’s a controller class, this method will:
+   *   - Instantiate it (via IoC or manually)
+   *   - Call the specified method (defaults to `index`)
+   *
+   * @param handler     Event handler function OR controller class
+   * @param methodName  Method to invoke on the controller (defaults to 'index')
+   */
+  private resolveControllerOrHandler;
+  /**
+   * Registers a route that responds to HTTP GET requests.
+   *
+   * @param path        The URL pattern to match (can include parameters, e.g., '/users/:id').
+   * @param definition  Either:
+   *                      - An EventHandler function
+   *                      - A tuple: [ControllerClass, methodName]
+   * @param name        Optional route name (for URL generation or referencing).
+   * @param middleware  Optional array of middleware functions to execute before the handler.
+   */
+  get(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
+  /**
+   * Registers a route that responds to HTTP POST requests.
+   *
+   * @param path        The URL pattern to match (can include parameters, e.g., '/users').
+   * @param definition  Either:
+   *                      - An EventHandler function
+   *                      - A tuple: [ControllerClass, methodName]
+   * @param name        Optional route name (for URL generation or referencing).
+   * @param middleware  Optional array of middleware functions to execute before the handler.
+   */
+  post(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
+  /**
+   * Registers a route that responds to HTTP PUT requests.
+   *
+   * @param path        The URL pattern to match (can include parameters, e.g., '/users/:id').
+   * @param definition  Either:
+   *                      - An EventHandler function
+   *                      - A tuple: [ControllerClass, methodName]
+   * @param name        Optional route name (for URL generation or referencing).
+   * @param middleware  Optional array of middleware functions to execute before the handler.
+   */
+  put(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
+  /**
+   * Registers a route that responds to HTTP PATCH requests.
+   *
+   * @param path        The URL pattern to match (can include parameters, e.g., '/users/:id').
+   * @param definition  Either:
+   *                      - An EventHandler function
+   *                      - A tuple: [ControllerClass, methodName]
+   * @param name        Optional route name (for URL generation or referencing).
+   * @param middleware  Optional array of middleware functions to execute before the handler.
+   */
+  patch(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
+  /**
+   * Registers a route that responds to HTTP DELETE requests.
+   *
+   * @param path        The URL pattern to match (can include parameters, e.g., '/users/:id').
+   * @param definition  Either:
+   *                      - An EventHandler function
+   *                      - A tuple: [ControllerClass, methodName]
+   * @param name        Optional route name (for URL generation or referencing).
+   * @param middleware  Optional array of middleware functions to execute before the handler.
+   */
+  delete(path: string, definition: RouteEventHandler | [(new (...args: any[]) => Record<string, any>), methodName: string], name?: string, middleware?: IMiddleware[]): Omit<this, RouterEnd>;
+  /**
+   * API Resource support
+   *
+   * @param path
+   * @param controller
+   */
+  apiResource(path: string, Controller: new (app: Application) => IController, middleware?: IMiddleware[]): Omit<this, RouterEnd | 'name'>;
+  /**
+   * Named route URL generator
+   *
+   * @param name
+   * @param params
+   * @returns
+   */
+  route(name: string, params?: Record<string, string>): string | undefined;
+  /**
+   * Grouping
+   *
+   * @param options
+   * @param callback
+   */
+  group(options: {
+    prefix?: string;
+    middleware?: EventHandler[];
+  }, callback: (_e: this) => void): this;
+  /**
+   * Set the name of the current route
+   *
+   * @param name
+   */
+  name(name: string): 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 | IMiddleware[], handler: Middleware, opts?: MiddlewareOptions): this;
 }
-
-export { AssetsServiceProvider, RouteServiceProvider, Router };
+//#endregion
+export { AssetsServiceProvider, Helpers, RouteServiceProvider, Router };
+//# sourceMappingURL=index.d.ts.map