clear-router 2.0.3 → 2.0.4

package/README.md

@@ -1,11 +1,23 @@
-# @refkinscallv/express-routing
+# Toneflix Clear Router
 
 Laravel-style routing system for Express.js in JavaScript. Clean route definitions, middleware support, and controller bindings with full TypeScript support.
 
 ## Installation
 
 ```bash
-npm install @refkinscallv/express-routing
+npm install clear-router
+```
+
+OR
+
+```bash
+pnpm add clear-router
+```
+
+OR
+
+```bash
+yarn add clear-router
 ```
 
 ## Features
@@ -27,16 +39,16 @@ npm install @refkinscallv/express-routing
 
 ```javascript
 const express = require('express');
-const Routes = require('@refkinscallv/express-routing');
+const Routes = require('clear-router');
 
 const app = express();
 const router = express.Router();
 
-Routes.get('/hello', ({ res }) => {
+Router.get('/hello', ({ res }) => {
   res.send('Hello World');
 });
 
-Routes.apply(router);
+Router.apply(router);
 app.use(router);
 
 app.listen(3000);
@@ -46,16 +58,16 @@ app.listen(3000);
 
 ```javascript
 import express from 'express';
-import Routes from '@refkinscallv/express-routing';
+import Router from 'clear-router';
 
 const app = express();
 const router = express.Router();
 
-Routes.get('/hello', ({ res }) => {
+Router.get('/hello', ({ res }) => {
   res.send('Hello World');
 });
 
-await Routes.apply(router);
+await Router.apply(router);
 app.use(router);
 
 app.listen(3000);
@@ -65,16 +77,16 @@ app.listen(3000);
 
 ```typescript
 import express from 'express';
-import Routes from '@refkinscallv/express-routing';
+import Router from 'clear-router';
 
 const app = express();
 const router = express.Router();
 
-Routes.get('/hello', ({ res }) => {
+Router.get('/hello', ({ res }) => {
   res.send('Hello World');
 });
 
-await Routes.apply(router);
+await Router.apply(router);
 app.use(router);
 
 app.listen(3000);
@@ -85,7 +97,7 @@ app.listen(3000);
 ### Basic Route
 
 ```javascript
-Routes.get('/hello', ({ res }) => {
+Router.get('/hello', ({ res }) => {
   res.send('Hello World');
 });
 ```
@@ -98,7 +110,7 @@ const authMiddleware = (req, res, next) => {
   next();
 };
 
-Routes.post('/secure', ({ res }) => res.send('Protected'), [authMiddleware]);
+Router.post('/secure', ({ res }) => res.send('Protected'), [authMiddleware]);
 ```
 
 ### Controller Binding
@@ -110,7 +122,7 @@ class UserController {
   }
 }
 
-Routes.get('/users', [UserController, 'index']);
+Router.get('/users', [UserController, 'index']);
 ```
 
 Class-based handlers will auto-bind to static or instance methods.
@@ -118,31 +130,35 @@ Class-based handlers will auto-bind to static or instance methods.
 ### Grouped Routes
 
 ```javascript
-Routes.group('/admin', () => {
-  Routes.get('/dashboard', ({ res }) => res.send('Admin Panel'));
+Router.group('/admin', () => {
+  Router.get('/dashboard', ({ res }) => res.send('Admin Panel'));
 });
 ```
 
 With middleware:
 
 ```javascript
-Routes.group('/secure', () => {
-  Routes.get('/data', ({ res }) => res.send('Secure Data'));
-}, [authMiddleware]);
+Router.group(
+  '/secure',
+  () => {
+    Router.get('/data', ({ res }) => res.send('Secure Data'));
+  },
+  [authMiddleware],
+);
 ```
 
 ### Global Middleware Scope
 
 ```javascript
-Routes.middleware([authMiddleware], () => {
-  Routes.get('/profile', ({ res }) => res.send('My Profile'));
+Router.middleware([authMiddleware], () => {
+  Router.get('/profile', ({ res }) => res.send('My Profile'));
 });
 ```
 
 ### Multiple HTTP Methods
 
 ```javascript
-Routes.add(['get', 'post'], '/handle', ({ req, res }) => {
+Router.add(['get', 'post'], '/handle', ({ req, res }) => {
   res.send(`Method: ${req.method}`);
 });
 ```
@@ -150,10 +166,10 @@ Routes.add(['get', 'post'], '/handle', ({ req, res }) => {
 ### Inspecting Routes
 
 ```javascript
-Routes.get('/hello', ({ res }) => res.send('Hello'));
-Routes.post('/world', ({ res }) => res.send('World'));
+Router.get('/hello', ({ res }) => res.send('Hello'));
+Router.post('/world', ({ res }) => res.send('World'));
 
-const allRoutes = Routes.allRoutes();
+const allRoutes = Router.allRoutes();
 console.log(allRoutes);
 // Output:
 // [

package/dist/express/{routes.mjs → router.cjs}

@@ -1,4 +1,6 @@
-//#region src/express/routes.ts
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
+
+//#region src/express/router.ts
 /**
 * @class clear-router
 * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
@@ -6,7 +8,7 @@
 * @author 3m1n3nc3
 * @repository https://github.com/toneflix/clear-router
 */
-var Routes = class {
+var Router = class {
 	/**
 	* All registered routes
 	*/
@@ -245,4 +247,5 @@ var Routes = class {
 };
 
 //#endregion
-export { Routes as default };
+exports.Router = Router;
+exports.default = Router;

package/dist/express/{routes.d.cts → router.d.cts}

@@ -1,5 +1,5 @@
 import { i as RouteInfo, n as ControllerHandler, r as HttpMethod, t as ControllerAction } from "../basic-BCxhZ1Wd.cjs";
-import { NextFunction, Request, Response, Router } from "express";
+import { NextFunction, Request, Response, Router as Router$1 } from "express";
 
 //#region types/express.d.ts
 /**
@@ -23,7 +23,7 @@ type Handler = RouteHandler | ControllerHandler;
  */
 type Middleware = (req: Request, res: Response, next: NextFunction) => any | Promise<any>;
 //#endregion
-//#region src/express/routes.d.ts
+//#region src/express/router.d.ts
 /**
  * @class clear-router
  * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
@@ -31,7 +31,7 @@ type Middleware = (req: Request, res: Response, next: NextFunction) => any | Pro
  * @author 3m1n3nc3
  * @repository https://github.com/toneflix/clear-router
  */
-declare class Routes {
+declare class Router {
   /**
    * All registered routes
    */
@@ -152,7 +152,8 @@ declare class Routes {
    *
    * @param router - Express Router instance
    */
-  static apply(router: Router): void;
-  static apply(router: Router): Promise<void>;
+  static apply(router: Router$1): void;
+  static apply(router: Router$1): Promise<void>;
 }
-export = Routes;
+//#endregion
+export { Router, Router as default };

package/dist/express/{routes.d.mts → router.d.mts}

@@ -1,5 +1,5 @@
 import { i as RouteInfo, n as ControllerHandler, r as HttpMethod, t as ControllerAction } from "../basic-POMY6a76.mjs";
-import { NextFunction, Request, Response, Router } from "express";
+import { NextFunction, Request, Response, Router as Router$1 } from "express";
 
 //#region types/express.d.ts
 /**
@@ -23,7 +23,7 @@ type Handler = RouteHandler | ControllerHandler;
  */
 type Middleware = (req: Request, res: Response, next: NextFunction) => any | Promise<any>;
 //#endregion
-//#region src/express/routes.d.ts
+//#region src/express/router.d.ts
 /**
  * @class clear-router
  * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
@@ -31,7 +31,7 @@ type Middleware = (req: Request, res: Response, next: NextFunction) => any | Pro
  * @author 3m1n3nc3
  * @repository https://github.com/toneflix/clear-router
  */
-declare class Routes {
+declare class Router {
   /**
    * All registered routes
    */
@@ -152,8 +152,8 @@ declare class Routes {
    *
    * @param router - Express Router instance
    */
-  static apply(router: Router): void;
-  static apply(router: Router): Promise<void>;
+  static apply(router: Router$1): void;
+  static apply(router: Router$1): Promise<void>;
 }
 //#endregion
-export { Routes as default };
+export { Router, Router as default };

package/dist/express/{routes.cjs → router.mjs}

@@ -1,5 +1,4 @@
-
-//#region src/express/routes.ts
+//#region src/express/router.ts
 /**
 * @class clear-router
 * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
@@ -7,7 +6,7 @@
 * @author 3m1n3nc3
 * @repository https://github.com/toneflix/clear-router
 */
-var Routes = class {
+var Router = class {
 	/**
 	* All registered routes
 	*/
@@ -246,4 +245,4 @@ var Routes = class {
 };
 
 //#endregion
-module.exports = Routes;
+export { Router, Router as default };

package/dist/h3/{routes.mjs → router.cjs}

@@ -1,11 +1,13 @@
-//#region src/h3/routes.ts
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
+
+//#region src/h3/router.ts
 /**
 * @class clear-router
 * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
 * @author 3m1n3nc3
 * @repository https://github.com/toneflix/clear-router
 */
-var Routes = class {
+var Router = class {
 	/**
 	* All registered routes
 	*/
@@ -248,4 +250,5 @@ var Routes = class {
 };
 
 //#endregion
-export { Routes as default };
+exports.Router = Router;
+exports.default = Router;

package/dist/h3/{routes.d.cts → router.d.cts}

@@ -18,14 +18,14 @@ type RouteHandler = (ctx: HttpContext) => any | Promise<any>;
  */
 type Handler = RouteHandler | ControllerHandler;
 //#endregion
-//#region src/h3/routes.d.ts
+//#region src/h3/router.d.ts
 /**
  * @class clear-router
  * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
  * @author 3m1n3nc3
  * @repository https://github.com/toneflix/clear-router
  */
-declare class Routes {
+declare class Router {
   /**
    * All registered routes
    */
@@ -148,4 +148,5 @@ declare class Routes {
    */
   static apply(app: H3): H3App;
 }
-export = Routes;
+//#endregion
+export { Router, Router as default };

package/dist/h3/{routes.d.mts → router.d.mts}

@@ -18,14 +18,14 @@ type RouteHandler = (ctx: HttpContext) => any | Promise<any>;
  */
 type Handler = RouteHandler | ControllerHandler;
 //#endregion
-//#region src/h3/routes.d.ts
+//#region src/h3/router.d.ts
 /**
  * @class clear-router
  * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
  * @author 3m1n3nc3
  * @repository https://github.com/toneflix/clear-router
  */
-declare class Routes {
+declare class Router {
   /**
    * All registered routes
    */
@@ -149,4 +149,4 @@ declare class Routes {
   static apply(app: H3): H3App;
 }
 //#endregion
-export { Routes as default };
+export { Router, Router as default };

package/dist/h3/{routes.cjs → router.mjs}

@@ -1,12 +1,11 @@
-
-//#region src/h3/routes.ts
+//#region src/h3/router.ts
 /**
 * @class clear-router
 * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
 * @author 3m1n3nc3
 * @repository https://github.com/toneflix/clear-router
 */
-var Routes = class {
+var Router = class {
 	/**
 	* All registered routes
 	*/
@@ -249,4 +248,4 @@ var Routes = class {
 };
 
 //#endregion
-module.exports = Routes;
+export { Router, Router as default };

package/dist/types/basic.d.mts

@@ -0,0 +1,7 @@
+//#region types/basic.d.ts
+/**
+ * Controller method reference
+ */
+type ControllerHandler = [any, string];
+//#endregion
+export { ControllerHandler };

package/dist/types/express.d.mts

@@ -0,0 +1,26 @@
+import { ControllerHandler } from "./basic.mjs";
+import { NextFunction, Request, Response } from "express";
+
+//#region types/express.d.ts
+/**
+ * HTTP context passed to route handlers
+ */
+interface HttpContext {
+  req: Request;
+  res: Response;
+  next: NextFunction;
+}
+/**
+ * Route handler function type
+ */
+type RouteHandler = (ctx: HttpContext) => any | Promise<any>;
+/**
+ * Handler can be either a function or controller reference
+ */
+type Handler = RouteHandler | ControllerHandler;
+/**
+ * Middleware function type
+ */
+type Middleware = (req: Request, res: Response, next: NextFunction) => any | Promise<any>;
+//#endregion
+export { Handler, HttpContext, Middleware, RouteHandler };

package/dist/types/express.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/types/h3.d.mts

@@ -0,0 +1,23 @@
+import { ControllerHandler } from "./basic.mjs";
+import { H3, H3Event, Middleware, TypedServerRequest } from "h3";
+
+//#region types/h3.d.ts
+type H3App = Omit<H3['fetch'], 'fetch'> & {
+  fetch: (request: TypedServerRequest) => Promise<Response>;
+};
+type MaybePromise<T = unknown> = T | Promise<T>;
+/**
+ * HTTP context passed to route handlers
+ */
+type HttpContext = H3Event;
+/**
+ * Route handler function type
+ */
+type RouteHandler = (ctx: HttpContext) => any | Promise<any>;
+/**
+ * Handler can be either a function or controller reference
+ */
+type Handler = RouteHandler | ControllerHandler;
+type NextFunction = () => MaybePromise<unknown | undefined>;
+//#endregion
+export { H3App, Handler, HttpContext, MaybePromise, type Middleware, NextFunction, RouteHandler };

package/dist/types/h3.mjs

@@ -0,0 +1 @@
+export {  };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clear-router",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Laravel-style routing system for Express.js and H3, with CommonJS, ESM, and TypeScript support",
   "keywords": [
     "h3",
@@ -32,13 +32,15 @@
   "module": "dist/express/routes.mjs",
   "types": "dist/express/routes.d.mts",
   "exports": {
-    "./express/routes": {
-      "import": "./dist/express/routes.mjs",
-      "require": "./dist/express/routes.cjs"
+    "./express": "./dist/types/express.mjs",
+    "./express/router": {
+      "import": "./dist/express/router.mjs",
+      "require": "./dist/express/router.cjs"
     },
-    "./h3/routes": {
-      "import": "./dist/h3/routes.mjs",
-      "require": "./dist/h3/routes.cjs"
+    "./h3": "./dist/types/h3.mjs",
+    "./h3/router": {
+      "import": "./dist/h3/router.mjs",
+      "require": "./dist/h3/router.cjs"
     },
     "./package.json": "./package.json"
   },