clear-router 2.7.6 → 2.7.7

package/dist/index.d.mts

@@ -1,563 +1,9 @@
-import { AsyncLocalStorage } from "node:async_hooks";
-import { NextFunction, Request as Request$1, Response as Response$2 } from "express";
-import { Middleware as Middleware$4 } from "h3";
-import { FastifyReply, FastifyRequest } from "fastify";
-import { MiddlewareHandler } from "hono";
-import Koa from "koa";
-
-//#region src/Contracts.d.ts
-/**
- * HTTP context passed to route handlers
- */
-interface ClearHttpContext {}
-//#endregion
-//#region src/types/basic.d.ts
-/**
- * HTTP methods supported by the router
- */
-type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
-/**
- * Common controller action names
- */
-type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
-/**
- * Generic Object type for request data
- */
-type RequestData = Record<string, any>;
-type ApiResourceMiddleware<M = any> = M | M[] | { [K in ControllerAction]?: M | M[] };
-interface RouterConfig {
-  /**
-   * When enabled, API param name will be infered from the route path.
-   * So instead of getting /api/users/:id, we will now get /api/users/:user
-   */
-  inferParamName?: boolean;
-  /**
-   * Configuration for method override functionality, allowing clients to use a
-   * specific header or body parameter to override the HTTP method.
-   */
-  methodOverride?: {
-    /** Whether method override is enabled */enabled?: boolean; /** Keys in the request body to check for method override */
-    bodyKeys?: string[] | string; /** Keys in the request headers to check for method override */
-    headerKeys?: string[] | string;
-  };
-  /**
-   * Optional method binding / container resolution support. Disabled by default.
-   */
-  container?: {
-    /** Whether decorated handler parameter binding is enabled */enabled?: boolean; /** Whether unknown constructor tokens should be instantiated automatically */
-    autoDiscover?: boolean;
-  };
-}
-//#endregion
-//#region src/core/Response.d.ts
-declare class Response$1 {
-  [key: string]: any;
-  body: any;
-  headers: Headers;
-  sent: boolean;
-  statusCode: number;
-  statusText: string;
-  constructor(init?: Partial<Response$1 | globalThis.Response>);
-  status(code: number): this;
-  setStatusText(text: string): this;
-  code(code: number): this;
-  setHeader(name: string, value: string): this;
-  header(name: string, value: string): this;
-  set(name: string, value: string): this;
-  type(contentType: string): this;
-  send(body?: any): this;
-  json(body: any): this;
-  html(body: string): this;
-  text(body: string): this;
-  noContent(): this;
-}
-//#endregion
-//#region src/Route.d.ts
-interface RouteParameter {
-  name: string;
-  field?: string;
-  optional: boolean;
-}
-declare class Route<X = any, M = Middleware$4 | Middleware$3, H = any> {
-  ctx: X;
-  body: RequestData;
-  query: RequestData;
-  params: RequestData;
-  clearRequest: ClearRequest;
-  methods: HttpMethod[];
-  path: string;
-  registrationPaths: string[];
-  parameters: RouteParameter[];
-  routeName?: string;
-  handler: H;
-  middlewares: M[];
-  controllerName?: string;
-  actionName?: string;
-  handlerType: 'function' | 'controller';
-  middlewareCount: number;
-  constructor(methods: HttpMethod[], path: string, handler: H, middlewares?: M[], options?: {
-    registrationPaths?: string[];
-    parameters?: RouteParameter[];
-    onName?: (name: string, route: Route<X, M, H>, previousName?: string) => void;
-  });
-  private onName?;
-  name(name: string): this;
-  toPath(params?: RequestData): string;
-}
-//#endregion
-//#region src/core/Request.d.ts
-declare class Request<X = any, M = any> extends ClearRequest<X, M> {
-  original?: any;
-  method: string;
-  path: string;
-  url: string;
-  headers: Headers | Record<string, any>;
-  constructor(init?: Partial<Request<X, M>> & {
-    body?: RequestData;
-    query?: RequestData;
-    params?: RequestData;
-    route?: Route<X, M>;
-  });
-  getBody(): RequestData;
-  header(name: string): string;
-  param(name: string): any;
-  input(name: string): any;
-  is(method: HttpMethod | string): boolean;
-}
-//#endregion
-//#region src/types/express.d.ts
-/**
- * Middleware function type
- */
-type Middleware$3 = (req: Request$1, res: Response$2, next: NextFunction) => any | Promise<any>;
-//#endregion
-//#region src/types/fastify.d.ts
-interface RequestWithGetBody extends FastifyRequest {
-  getBody: () => Record<string, any>;
-}
-type NextFunction$1 = (err?: Error) => void;
-type Middleware$2 = (req: RequestWithGetBody, reply: FastifyReply, next: NextFunction$1) => any | Promise<any>;
-//#endregion
-//#region src/types/hono.d.ts
-type Middleware$1 = MiddlewareHandler;
-//#endregion
-//#region src/types/koa.d.ts
-type Middleware = Koa.Middleware<any, any>;
-//#endregion
-//#region src/ClearRequest.d.ts
-declare class ClearRequest<X = any, M = Middleware$4 | Middleware$3 | Middleware$2 | Middleware$1 | Middleware> {
-  [key: string]: any;
-  /**
-   * @param body - Parsed request body
-   */
-  body: RequestData;
-  /**
-   * @param query - Parsed query parameters
-   */
-  query: RequestData;
-  /**
-   * @param params - Parsed route parameters
-   */
-  params: RequestData;
-  route: Route<X, M>;
-  constructor(init?: Partial<ClearRequest>);
-}
-//#endregion
-//#region src/Controller.d.ts
-declare abstract class Controller<X = any> {
-  [x: string]: any;
-  ctx: X;
-  body: RequestData;
-  query: RequestData;
-  params: RequestData;
-  clearRequest: ClearRequest;
-}
-//#endregion
-//#region src/core/bindings.d.ts
-type BindToken<T = any> = abstract new (...args: any[]) => T;
-type BindFactory<T = any> = (ctx: any) => T | Promise<T>;
-type BindValue<T = any> = T | BindFactory<T> | BindToken<T>;
-declare class Container {
-  private static readonly registry;
-  static bind<T>(token: BindToken<T>, value: BindValue<T>): void;
-  static unbind<T>(token: BindToken<T>): void;
-  static clear(): void;
-  static has<T>(token: BindToken<T>): boolean;
-  static bindings<V = any>(): Record<string, BindValue<V>>;
-  static resolve<T>(token: BindToken<T>, ctx: any, autoDiscover?: boolean): Promise<T | undefined>;
-  private static getBinding;
-  private static findEquivalentToken;
-  private static getComparableStaticProps;
-  private static staticPropsMatch;
-  private static resolveBinding;
-}
-//#endregion
-//#region src/core/plugins.d.ts
-type PluginSetupResult = void | Promise<void>;
-interface ClearRouterPluginRequestContext<HttpContext = any> {
-  ctx: HttpContext;
-  request: Request;
-  response: Response$1;
-  getBindings: () => Record<string, BindValue>;
-  [key: string]: any;
-}
-interface ClearRouterPluginArgumentsContext<X = any> extends ClearRouterPluginRequestContext<X> {
-  target?: object;
-  method?: PropertyKey;
-  handler?: object;
-  metadata?: object;
-  tokens: BindToken[];
-  designTokens: BindToken[];
-}
-type PluginBindFactory<T = any, X = any> = (ctx: ClearRouterPluginRequestContext<X>) => T | Promise<T>;
-type PluginBindValue<T = any, X = any> = BindValue<T> | PluginBindFactory<T, X>;
-type PluginBind<X = any> = <T>(token: BindToken<T>, value: PluginBindValue<T, X>) => void;
-type PluginArgumentsResolver<HttpContext = any> = (ctx: ClearRouterPluginArgumentsContext<HttpContext>) => any[] | undefined | Promise<any[] | undefined>;
-interface ClearRouterPluginContext<Options = any, HttpContext = any> {
-  /**
-   * The service container
-   */
-  container: typeof Container;
-  /**
-   * Register service container bindings
-   */
-  bind: PluginBind<HttpContext>;
-  /**
-   * Replace all controller method arguments
-   * @param resolver
-   * @returns
-   */
-  resolveArguments: (resolver: PluginArgumentsResolver<HttpContext>) => void;
-  /**
-   * Use the current http context
-   */
-  useHttpContext: (resolver: PluginArgumentsResolver<HttpContext>) => void;
-  /**
-   * All registered service container bindings
-   */
-  bindings: Record<string, BindValue>;
-  /**
-   * Configures the router with the given options, such as method override settings
-   *
-   * @param options
-   * @returns
-   */
-  configure: (options: RouterConfig) => void;
-  /**
-   * Default configuration used for everytime the router is reset
-   *
-   * @param options
-   */
-  configureDefaults: (options: RouterConfig) => void;
-  /**
-   * The current Request instance
-   */
-  readonly request?: Request;
-  /**
-   * The current Response instance
-   * @returns
-   */
-  readonly response?: Response$1;
-  /**
-   * Get the current Request instance
-   * @returns
-   */
-  getRequest: () => Request | undefined;
-  /**
-   * Get the current Response instance
-   * @returns
-   */
-  getResponse: () => Response$1 | undefined;
-  /**
-   * Plugin configuration options
-   */
-  options: Options;
-}
-interface ClearRouterPlugin<Options = any, HttpContext = any> {
-  /**
-   * The name of the plugin
-   */
-  name?: string;
-  /**
-   * Plugin setup an implemnetation
-   *
-   * @param ctx
-   * @returns
-   */
-  setup: (ctx: ClearRouterPluginContext<Options, HttpContext>) => PluginSetupResult;
-}
-type ClearRouterPluginInput<Options = any, HttpContext = any> = ClearRouterPlugin<Options> | ((ctx: ClearRouterPluginContext<Options, HttpContext>) => PluginSetupResult);
-/**
- * Creates a new plugin
- *
- * @param plugin
- * @returns
- */
-declare function definePlugin<Options = any, HttpContext = any>(plugin: ClearRouterPlugin<Options, HttpContext>): ClearRouterPlugin<Options, HttpContext>;
-//#endregion
-//#region src/core/router.d.ts
-/**
- * @class clear-router CoreRouter
- * @description Core routing logic for clear-router, shared between all supported adapters (Express.js, H3, etc.)
- * @author 3m1n3nc3
- * @repository https://github.com/arkstack-tmp/clear-router
- */
-declare abstract class CoreRouter {
-  protected static routerStateNamespace: string;
-  private static readonly stateStoreKey;
-  private static readonly stateBoundKey;
-  private static readonly defaultConfigKey;
-  private static readonly pluginStoreKey;
-  private static readonly pluginPendingKey;
-  private static readonly pluginHttpCtxResolversKey;
-  private static readonly pluginArgumentResolversKey;
-  private static requestProvider?;
-  private static responseProvider?;
-  static config: RouterConfig;
-  protected static groupContext: AsyncLocalStorage<{
-    prefix: string;
-    groupMiddlewares: any[];
-  }>;
-  protected static pluginRequestContext: AsyncLocalStorage<ClearRouterPluginRequestContext<any>>;
-  static routes: Set<Route<any, any, any>>;
-  static routesByPathMethod: Map<string, Route<any, any, any>>;
-  static routesByMethod: Map<"GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD", Route<any, any, any>[]>;
-  static routesByName: Map<string, Route<any, any, any>>;
-  static prefix: string;
-  static groupMiddlewares: any[];
-  static globalMiddlewares: any[];
-  /**
-   * Resets the router to it's default state
-   */
-  static reset(): typeof CoreRouter;
-  protected static createBaseConfig(): RouterConfig;
-  protected static mergeConfig(target: RouterConfig, source?: RouterConfig): RouterConfig;
-  protected static getDefaultConfig(): RouterConfig;
-  protected static resolveStateNamespace(): string;
-  protected static getStateStore(): Record<string, any>;
-  protected static getPluginStore(): Set<string>;
-  protected static getPluginPendingStore(): Set<Promise<void>>;
-  protected static getPluginArgumentResolvers(): Set<PluginArgumentsResolver>;
-  protected static getPluginHttpCtxResolvers(): Set<PluginArgumentsResolver>;
-  protected static createDefaultState(): {
-    config: RouterConfig;
-    groupContext: AsyncLocalStorage<{
-      prefix: string;
-      groupMiddlewares: any[];
-    }>;
-    routes: Set<never>;
-    routesByPathMethod: Map<any, any>;
-    routesByMethod: Map<any, any>;
-    routesByName: Map<any, any>;
-    prefix: string;
-    groupMiddlewares: any[];
-    globalMiddlewares: any[];
-  };
-  protected static bindStateAccessors(): void;
-  protected static createDefaultOptionsHandler(): any;
-  /**
-   * Default configuration used for everytime the router is reset
-   *
-   * @param options
-   */
-  static configureDefaults(options?: RouterConfig): void;
-  /**
-   * Use a registered plugin
-   *
-   * @param this
-   * @param plugin
-   * @param options
-   * @returns
-   */
-  static use<Options = any>(plugin: ClearRouterPluginInput<Options>, options?: Options): Promise<void>;
-  protected static pluginsReady(): Promise<void>;
-  protected static getCurrentPluginRequestContext(): ClearRouterPluginRequestContext | undefined;
-  protected static createPluginRequestContext(ctx: any): ClearRouterPluginRequestContext;
-  protected static createPluginBind(): PluginBind;
-  protected static resolvePluginArguments(ctx: any, routeContext: Omit<ClearRouterPluginArgumentsContext, keyof ClearRouterPluginRequestContext>): Promise<any[] | undefined>;
-  protected static resolvePluginHttpCtx(ctx: any): Promise<void>;
-  protected static ensureState(): void;
-  /**
-   * Normalizes a path by ensuring it starts with a single slash and does not have trailing
-   * slashes, while preserving dynamic segments and parameters.
-   *
-   * @param path  The path to normalize.
-   * @returns     The normalized path.
-   */
-  static normalizePath(path: string): string;
-  protected static parseRouteParameters(path: string): Array<{
-    name: string;
-    field?: string;
-    optional: boolean;
-  }>;
-  protected static expandRoutePath(path: string): string[];
-  protected static routeRegistrationPaths(path: string): string[];
-  /**
-   * Configures the router with the given options, such as method override settings.
-   *
-   * @param this
-   * @param options
-   * @returns
-   */
-  static configure(this: any, options?: RouterConfig): void;
-  protected static resolveMethodOverride(method: string, headers: Headers | Record<string, any>, body: unknown): HttpMethod | null;
-  /**
-   * Adds a new route to the router.
-   *
-   * @param this
-   * @param methods
-   * @param path
-   * @param handler
-   * @param middlewares
-   */
-  static add(methods: HttpMethod | HttpMethod[], path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
-  /**
-   * Define a resourceful API controller with standard CRUD routes.
-   *
-   * @param this
-   * @param basePath
-   * @param controller
-   * @param options
-   */
-  static apiResource(basePath: string, controller: any, options?: {
-    only?: ControllerAction[];
-    except?: ControllerAction[];
-    middlewares?: ApiResourceMiddleware<any>;
-  }): void;
-  /**
-   * Adds a new GET route to the router.
-   *
-   * @param this          The router instance.
-   * @param path          The path for the GET route.
-   * @param handler       The handler function for the GET route.
-   * @param middlewares   Optional middlewares to apply to the GET route.
-   */
-  static get(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
-  /**
-   * Adds a new POST route to the router.
-   *
-   * @param this
-   * @param path
-   * @param handler
-   * @param middlewares
-   */
-  static post(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
-  /**
-   * Adds a new PUT route to the router.
-   *
-   * @param this
-   * @param path
-   * @param handler
-   * @param middlewares
-   */
-  static put(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
-  /**
-   * Adds a new DELETE route to the router.
-   *
-   * @param this
-   * @param path
-   * @param handler
-   * @param middlewares
-   */
-  static delete(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
-  /**
-   * Adds a new PATCH route to the router.
-   *
-   * @param this
-   * @param path
-   * @param handler
-   * @param middlewares
-   */
-  static patch(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
-  /**
-   * Adds a new OPTIONS route to the router.
-   *
-   * @param this
-   * @param path
-   * @param handler
-   * @param middlewares
-   */
-  static options(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
-  /**
-   * Adds a new HEAD route to the router.
-   *
-   * @param this
-   * @param path
-   * @param handler
-   * @param middlewares
-   */
-  static head(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
-  /**
-   * Defines a group of routes with a common prefix.
-   *
-   * @param this
-   * @param prefix
-   * @param callback
-   * @param middlewares
-   */
-  static group(prefix: string, callback: () => void | Promise<void>, middlewares?: any[]): Promise<void>;
-  /**
-   * Adds global middlewares to the router, which will be applied to all routes.
-   *
-   * @param this
-   * @param middlewares
-   * @param callback
-   */
-  static middleware(middlewares: any[], callback: () => void): void;
-  /**
-   * Retrieves all registered routes in the router, optionally organized by path or method
-   * for easier access and management.
-   *
-   * @param this
-   */
-  static allRoutes(): Array<Route<any, any, any>>;
-  /**
-   * @param this
-   * @param type  - 'path' to get routes organized by path
-   */
-  static allRoutes(type: 'path'): Record<string, Route<any, any, any>>;
-  /**
-   * @param this
-   * @param type  - 'method' to get routes organized by method
-   */
-  static allRoutes(type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<any, any, any>> };
-  static allRoutes(type: 'name'): Record<string, Route<any, any, any>>;
-  static route(name: string): Route<any, any, any> | undefined;
-  static url(name: string, params?: Record<string, any>): string | undefined;
-  /**
-   * Provide a class that will overide the base Request instance
-   *
-   * @param provider
-   */
-  static setRequestProvider(provider: typeof Request): void;
-  /**
-   * Provide a class that will overide the base Response instance
-   *
-   * @param provider
-   */
-  static setResponseProvider(provider: typeof Response$1): void;
-  private static hasPackageInstalled;
-  /**
-   * Provide a class that will overide the base Response instance
-   *
-   * @param provider
-   */
-  private static initializeInstance;
-  protected static resolveHandler(route: Route<any, any, any>): {
-    handlerFunction: ((ctx: any, req: Request) => any | Promise<any>) | null;
-    instance: Controller<any> | null;
-    bindingTarget?: object;
-    bindingMethod?: PropertyKey;
-    bindingHandler?: object;
-    bindingMetadata?: object;
-  };
-  protected static callHandler(handlerFunction: (ctx: any, req: Request) => any | Promise<any>, ctx: any, bindingTarget?: object, bindingMethod?: PropertyKey, bindingHandler?: object, bindingMetadata?: object): Promise<any>;
-  protected static bindRequestToInstance(ctx: any, instance: Controller<any> | Route<any, any, any> | null, route: Route<any, any, any>, payload: {
-    body: Record<string, any>;
-    query: Record<string, any>;
-    params: Record<string, any>;
-    method?: HttpMethod | string;
-  }): void;
-}
-//#endregion
-export { ClearHttpContext, ClearRequest, ClearRouterPlugin, ClearRouterPluginArgumentsContext, ClearRouterPluginContext, ClearRouterPluginInput, ClearRouterPluginRequestContext, Controller, CoreRouter, PluginArgumentsResolver, PluginBind, PluginBindFactory, PluginBindValue, PluginSetupResult, Request, Response$1 as Response, Route, RouteParameter, definePlugin };
+import { ClearHttpContext, RouteParameter } from "./Contracts.mjs";
+import { Response } from "./core/Response.mjs";
+import { Route } from "./Route.mjs";
+import { Request } from "./core/Request.mjs";
+import { ClearRequest } from "./ClearRequest.mjs";
+import { Controller } from "./Controller.mjs";
+import { ClearRouterPlugin, ClearRouterPluginArgumentsContext, ClearRouterPluginContext, ClearRouterPluginInput, ClearRouterPluginRequestContext, PluginArgumentsResolver, PluginBind, PluginBindFactory, PluginBindValue, PluginSetupResult, definePlugin } from "./core/plugins.mjs";
+import { CoreRouter } from "./core/router.mjs";
+export { ClearHttpContext, ClearRequest, ClearRouterPlugin, ClearRouterPluginArgumentsContext, ClearRouterPluginContext, ClearRouterPluginInput, ClearRouterPluginRequestContext, Controller, CoreRouter, PluginArgumentsResolver, PluginBind, PluginBindFactory, PluginBindValue, PluginSetupResult, Request, Response, Route, RouteParameter, definePlugin };