@hoajs/tiny-router 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0 / 2025-10-13
+
+- init

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 - present, Hoa contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+## @hoajs/tiny-router
+
+Tiny router middleware for Hoa.
+
+## Installation
+
+```bash
+$ npm i @hoajs/tiny-router --save
+```
+
+## Quick Start
+
+```js
+import { Hoa } from 'hoa'
+import { tinyRouter } from '@hoajs/tiny-router'
+
+const app = new Hoa()
+app.extend(tinyRouter())
+
+app.get('/users/:name', async (ctx, next) => {
+  ctx.res.body = `Hello, ${ctx.req.params.name}!`
+})
+
+export default app
+```
+
+## Documentation
+
+The documentation is available on [hoa-js.com](https://hoa-js.com/middleware/router/tiny-router.html)
+
+## Test (100% coverage)
+
+```sh
+$ npm test
+```
+
+## License
+
+MIT

package/dist/cjs/tinyRouter.js

@@ -0,0 +1,85 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var tinyRouter_exports = {};
+__export(tinyRouter_exports, {
+  default: () => tinyRouter_default,
+  methods: () => methods,
+  tinyRouter: () => tinyRouter
+});
+module.exports = __toCommonJS(tinyRouter_exports);
+var import_hoa = require("hoa");
+const methods = ["options", "head", "get", "post", "put", "patch", "delete"];
+function tinyRouter(options = {}) {
+  return function tinyRouterExtension(app) {
+    methods.forEach((method) => {
+      app[method] = createRouteMethod(method.toUpperCase());
+    });
+    app.all = createRouteMethod();
+    function createRouteMethod(method) {
+      return function(path, ...handlers) {
+        if (handlers.length === 0) {
+          throw new Error(`Route ${method || "ALL"} ${path} must have at least one handler`);
+        }
+        const routeMiddleware = createRoute(method, path, handlers, options);
+        app.use(routeMiddleware);
+        return app;
+      };
+    }
+  };
+}
+function createRoute(method, path, handlers, options) {
+  const regexp = compile(path, options);
+  const composed = handlers.length === 1 ? handlers[0] : (0, import_hoa.compose)(handlers);
+  return function routeMiddleware(ctx, next) {
+    if (!matches(ctx, method)) return next();
+    const m = regexp.exec(ctx.req.pathname);
+    if (!m) return next();
+    const params = {};
+    if (m.groups) {
+      for (const [key, value] of Object.entries(m.groups)) {
+        params[key] = decode(value);
+      }
+    }
+    ctx.req.params = params;
+    ctx.req.routePath = path;
+    return composed(ctx, next);
+  };
+}
+function decode(val) {
+  if (val) return decodeURIComponent(val);
+}
+function matches(ctx, method) {
+  if (!method) return true;
+  if (ctx.req.method === method) return true;
+  if (method === "GET" && ctx.req.method === "HEAD") return true;
+  return false;
+}
+function compile(path, options) {
+  const { sensitive = false, trailing = true } = options;
+  const pattern = path.replace(/\/+(\/|$)/g, "$1").replace(/(\/?\.?):(\w+)\+/g, "($1(?<$2>*))").replace(/(\/?\.?):(\w+)/g, "($1(?<$2>[^$1/]+?))").replace(/\./g, "\\.").replace(/(\/?)\*/g, "($1.*)?");
+  const patternWithTrailing = trailing ? `${pattern}(?:\\/)?` : pattern;
+  const flags = sensitive ? "" : "i";
+  const regexp = RegExp(`^${patternWithTrailing}$`, flags);
+  return regexp;
+}
+var tinyRouter_default = tinyRouter;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  methods,
+  tinyRouter
+});

package/dist/esm/tinyRouter.js

@@ -0,0 +1,61 @@
+import { compose } from "hoa";
+const methods = ["options", "head", "get", "post", "put", "patch", "delete"];
+function tinyRouter(options = {}) {
+  return function tinyRouterExtension(app) {
+    methods.forEach((method) => {
+      app[method] = createRouteMethod(method.toUpperCase());
+    });
+    app.all = createRouteMethod();
+    function createRouteMethod(method) {
+      return function(path, ...handlers) {
+        if (handlers.length === 0) {
+          throw new Error(`Route ${method || "ALL"} ${path} must have at least one handler`);
+        }
+        const routeMiddleware = createRoute(method, path, handlers, options);
+        app.use(routeMiddleware);
+        return app;
+      };
+    }
+  };
+}
+function createRoute(method, path, handlers, options) {
+  const regexp = compile(path, options);
+  const composed = handlers.length === 1 ? handlers[0] : compose(handlers);
+  return function routeMiddleware(ctx, next) {
+    if (!matches(ctx, method)) return next();
+    const m = regexp.exec(ctx.req.pathname);
+    if (!m) return next();
+    const params = {};
+    if (m.groups) {
+      for (const [key, value] of Object.entries(m.groups)) {
+        params[key] = decode(value);
+      }
+    }
+    ctx.req.params = params;
+    ctx.req.routePath = path;
+    return composed(ctx, next);
+  };
+}
+function decode(val) {
+  if (val) return decodeURIComponent(val);
+}
+function matches(ctx, method) {
+  if (!method) return true;
+  if (ctx.req.method === method) return true;
+  if (method === "GET" && ctx.req.method === "HEAD") return true;
+  return false;
+}
+function compile(path, options) {
+  const { sensitive = false, trailing = true } = options;
+  const pattern = path.replace(/\/+(\/|$)/g, "$1").replace(/(\/?\.?):(\w+)\+/g, "($1(?<$2>*))").replace(/(\/?\.?):(\w+)/g, "($1(?<$2>[^$1/]+?))").replace(/\./g, "\\.").replace(/(\/?)\*/g, "($1.*)?");
+  const patternWithTrailing = trailing ? `${pattern}(?:\\/)?` : pattern;
+  const flags = sensitive ? "" : "i";
+  const regexp = RegExp(`^${patternWithTrailing}$`, flags);
+  return regexp;
+}
+var tinyRouter_default = tinyRouter;
+export {
+  tinyRouter_default as default,
+  methods,
+  tinyRouter
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@hoajs/tiny-router",
+  "version": "0.1.0",
+  "description": "Tiny router middleware for Hoa.",
+  "main": "./dist/cjs/tinyRouter.js",
+  "type": "module",
+  "module": "./dist/esm/tinyRouter.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/esm/tinyRouter.js",
+      "require": "./dist/cjs/tinyRouter.js",
+      "default": "./dist/esm/tinyRouter.js"
+    }
+  },
+  "files": [
+    "dist",
+    "types",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "build": "tsup",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "prepublishOnly": "npm run lint && npm run test && npm run build",
+    "prepare": "husky"
+  },
+  "author": "nswbmw",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hoa-js/tiny-router.git"
+  },
+  "keywords": [
+    "hoa",
+    "extension",
+    "extend",
+    "middleware",
+    "route",
+    "router"
+  ],
+  "devDependencies": {
+    "@commitlint/cli": "20.1.0",
+    "@commitlint/config-conventional": "20.0.0",
+    "eslint": "9.37.0",
+    "globals": "16.4.0",
+    "hoa": "*",
+    "husky": "9.1.7",
+    "jest": "30.2.0",
+    "neostandard": "0.12.2",
+    "tsup": "8.5.0"
+  },
+  "peerDependencies": {
+    "hoa": "*"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,43 @@
+// Type definitions for @hoajs/tiny-router
+// Project: https://github.com/hoa-js/tiny-router
+// Definitions by: nswbmw
+
+import type { Hoa, HoaMiddleware } from 'hoa'
+
+export type Method = 'options' | 'head' | 'get' | 'post' | 'put' | 'patch' | 'delete'
+
+export const methods: readonly Method[]
+
+export interface TinyRouterOptions {
+  /** RegExp will be case sensitive (default: false) */
+  sensitive?: boolean
+  /** Allows optional trailing slash to match (default: true) */
+  trailing?: boolean
+}
+
+export declare function tinyRouter (options?: TinyRouterOptions): (app: Hoa) => void
+
+export default tinyRouter
+
+/**
+ * Module augmentation: extend Hoa with routing methods and request params fields
+ */
+declare module 'hoa' {
+  interface Hoa {
+    options (path: string, ...handlers: HoaMiddleware[]): Hoa
+    head (path: string, ...handlers: HoaMiddleware[]): Hoa
+    get (path: string, ...handlers: HoaMiddleware[]): Hoa
+    post (path: string, ...handlers: HoaMiddleware[]): Hoa
+    put (path: string, ...handlers: HoaMiddleware[]): Hoa
+    patch (path: string, ...handlers: HoaMiddleware[]): Hoa
+    delete (path: string, ...handlers: HoaMiddleware[]): Hoa
+    all (path: string, ...handlers: HoaMiddleware[]): Hoa
+  }
+
+  interface HoaRequest {
+    /** Parsed route parameters set by @hoajs/tinyRouter */
+    params?: Record<string, string | undefined>
+    /** Matched route pattern for the current request */
+    routePath?: string
+  }
+}