clear-router 2.0.6 → 2.0.8

package/README.md

@@ -4,20 +4,32 @@ Laravel-style routing system for Express.js in JavaScript. Clean route definitio
 
 ## Installation
 
-```bash
-npm install clear-router
+```sh
+npm install clear-router h3
+
+# OR
+
+npm install clear-router express
 ```
 
 OR
 
 ```bash
-pnpm add clear-router
+pnpm add clear-router h3
+
+# OR
+
+pnpm add clear-router hexpress3
 ```
 
 OR
 
 ```bash
-yarn add clear-router
+yarn add clear-router h3
+
+# OR
+
+yarn add clear-router express
 ```
 
 ## Features
@@ -32,155 +44,21 @@ yarn add clear-router
 - Error handling delegated to Express
 - Route inspection with allRoutes method
 - Fully Express-compatible
+- Fully H3-compatible
 
 ## Quick Start
 
-### CommonJS
-
-```javascript
-const express = require('express');
-const Routes = require('clear-router');
-
-const app = express();
-const router = express.Router();
-
-Router.get('/hello', ({ res }) => {
-  res.send('Hello World');
-});
+### Express JS
 
-Router.apply(router);
-app.use(router);
-
-app.listen(3000);
-```
+See the [Express JS documentation](./docs/EXPRESS.md) for details.
 
-### ESM
+### H3
 
-```javascript
-import express from 'express';
-import Router from 'clear-router';
-
-const app = express();
-const router = express.Router();
-
-Router.get('/hello', ({ res }) => {
-  res.send('Hello World');
-});
-
-await Router.apply(router);
-app.use(router);
-
-app.listen(3000);
-```
-
-### TypeScript
-
-```typescript
-import express from 'express';
-import Router from 'clear-router';
-
-const app = express();
-const router = express.Router();
-
-Router.get('/hello', ({ res }) => {
-  res.send('Hello World');
-});
-
-await Router.apply(router);
-app.use(router);
-
-app.listen(3000);
-```
-
-## Usage Examples
-
-### Basic Route
-
-```javascript
-Router.get('/hello', ({ res }) => {
-  res.send('Hello World');
-});
-```
-
-### With Middleware
-
-```javascript
-const authMiddleware = (req, res, next) => {
-  // auth logic
-  next();
-};
-
-Router.post('/secure', ({ res }) => res.send('Protected'), [authMiddleware]);
-```
-
-### Controller Binding
-
-```javascript
-class UserController {
-  static index({ res }) {
-    res.send('User List');
-  }
-}
-
-Router.get('/users', [UserController, 'index']);
-```
-
-Class-based handlers will auto-bind to static or instance methods.
-
-### Grouped Routes
-
-```javascript
-Router.group('/admin', () => {
-  Router.get('/dashboard', ({ res }) => res.send('Admin Panel'));
-});
-```
-
-With middleware:
-
-```javascript
-Router.group(
-  '/secure',
-  () => {
-    Router.get('/data', ({ res }) => res.send('Secure Data'));
-  },
-  [authMiddleware],
-);
-```
-
-### Global Middleware Scope
-
-```javascript
-Router.middleware([authMiddleware], () => {
-  Router.get('/profile', ({ res }) => res.send('My Profile'));
-});
-```
-
-### Multiple HTTP Methods
-
-```javascript
-Router.add(['get', 'post'], '/handle', ({ req, res }) => {
-  res.send(`Method: ${req.method}`);
-});
-```
-
-### Inspecting Routes
-
-```javascript
-Router.get('/hello', ({ res }) => res.send('Hello'));
-Router.post('/world', ({ res }) => res.send('World'));
-
-const allRoutes = Router.allRoutes();
-console.log(allRoutes);
-// Output:
-// [
-//   { methods: ['get'], path: '/hello', middlewareCount: 0, handlerType: 'function' },
-//   { methods: ['post'], path: '/world', middlewareCount: 0, handlerType: 'function' }
-// ]
-```
+See the [H3 documentation](./docs/H3.md) for details.
 
 ## API Reference
 
-See [API.md](API.md) for complete API documentation.
+See [API.md](./docs/API.md) for complete API documentation.
 
 ## Error Handling
 
@@ -213,7 +91,7 @@ npm run test:esm      # Test ESM
 npm run test:ts       # Test TypeScript
 ```
 
-See [TESTING.md](TESTING.md) for detailed testing guide.
+See [TESTING.md](./docs/TESTING.md) for detailed testing guide.
 
 ## Examples
 
@@ -232,16 +110,16 @@ See [CHANGELOG.md](CHANGELOG.md) for version history.
 ## Requirements
 
 - Node.js >= 14.0.0
-- Express >= 5.0.0
+- Express >= 5.0.0 | H3 >= 2.0.1
 
 ## License
 
-MIT License © 2026 Refkinscallv
+MIT License © 2026 ToneFlix Technologies Limited
 
 ## Author
 
-Refkinscallv <refkinscallv@gmail.com>
+3m1n3nce <3m1n3nce@toneflix.net>
 
 ## Repository
 
-https://github.com/refkinscallv/express-routing
+https://github.com/toneflix/clear-router

package/dist/express/{router.cjs → index.cjs}

@@ -1,4 +1,4 @@
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 //#region src/express/router.ts
 /**
@@ -248,5 +248,4 @@ var Router = class {
 };
 
 //#endregion
-exports.Router = Router;
-exports.default = Router;
+exports.Router = Router;

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

@@ -156,4 +156,4 @@ declare class Router {
   static apply(router: Router$1): Promise<void>;
 }
 //#endregion
-export { Router, Router as default };
+export { Router };

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

@@ -156,4 +156,4 @@ declare class Router {
   static apply(router: Router$1): Promise<void>;
 }
 //#endregion
-export { Router, Router as default };
+export { Router };

package/dist/express/{router.mjs → index.mjs}

@@ -246,4 +246,4 @@ var Router = class {
 };
 
 //#endregion
-export { Router, Router as default };
+export { Router };

package/dist/h3/{router.cjs → index.cjs}

@@ -1,4 +1,4 @@
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 //#region src/h3/router.ts
 /**
@@ -251,5 +251,4 @@ var Router = class {
 };
 
 //#endregion
-exports.Router = Router;
-exports.default = Router;
+exports.Router = Router;

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

@@ -8,7 +8,7 @@ type H3App = Omit<H3['fetch'], 'fetch'> & {
 /**
  * HTTP context passed to route handlers
  */
-type HttpContext = H3Event;
+interface HttpContext extends H3Event {}
 /**
  * Route handler function type
  */
@@ -149,4 +149,4 @@ declare class Router {
   static apply(app: H3): H3App;
 }
 //#endregion
-export { Router, Router as default };
+export { Router };

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

@@ -8,7 +8,7 @@ type H3App = Omit<H3['fetch'], 'fetch'> & {
 /**
  * HTTP context passed to route handlers
  */
-type HttpContext = H3Event;
+interface HttpContext extends H3Event {}
 /**
  * Route handler function type
  */
@@ -149,4 +149,4 @@ declare class Router {
   static apply(app: H3): H3App;
 }
 //#endregion
-export { Router, Router as default };
+export { Router };

package/dist/h3/{router.mjs → index.mjs}

@@ -249,4 +249,4 @@ var Router = class {
 };
 
 //#endregion
-export { Router, Router as default };
+export { Router };

package/dist/types/h3.d.mts

@@ -9,7 +9,7 @@ type MaybePromise<T = unknown> = T | Promise<T>;
 /**
  * HTTP context passed to route handlers
  */
-type HttpContext = H3Event;
+interface HttpContext extends H3Event {}
 /**
  * Route handler function type
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clear-router",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "description": "Laravel-style routing system for Express.js and H3, with CommonJS, ESM, and TypeScript support",
   "keywords": [
     "h3",
@@ -32,13 +32,13 @@
   "module": "dist/express/routes.mjs",
   "types": "dist/express/routes.d.mts",
   "exports": {
-    "./express/router": {
-      "import": "./dist/express/router.mjs",
-      "require": "./dist/express/router.cjs"
+    "./express": {
+      "import": "./dist/express/index.mjs",
+      "require": "./dist/express/index.cjs"
     },
-    "./h3/router": {
-      "import": "./dist/h3/router.mjs",
-      "require": "./dist/h3/router.cjs"
+    "./h3": {
+      "import": "./dist/h3/index.mjs",
+      "require": "./dist/h3/index.cjs"
     },
     "./types/basic": "./dist/types/basic.mjs",
     "./types/express": "./dist/types/express.mjs",
@@ -77,7 +77,7 @@
     "node": ">=22.0.0"
   },
   "scripts": {
-    "test": " pnpm test:esm && pnpm test:ts",
+    "test": "pnpm test:esm && pnpm test:ts",
     "test:esm": "vitest tests/esm.test.ts",
     "test:ts": "vitest tests/typescript.test.ts",
     "example": "tsx example/express/index.ts",