@comity/router-path-to-regexp 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Filippo Bovo and 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,56 @@
+# @comity/router-path-to-regexp
+
+Path-to-regexp router implementation for Comity.
+
+---
+
+## Purpose
+
+Provides a router implementation that uses `path-to-regexp` while conforming to the `@comity/router` contracts.
+
+---
+
+## Scope
+
+This package:
+
+- ✅ implements `PathRouter`
+- ✅ adapts routing behavior to `@comity/router`
+
+This package does NOT:
+
+- ❌ redefine router contracts
+- ❌ own application routing policy
+- ❌ render HTTP responses
+
+---
+
+## Public API
+
+- `PathRouter`
+
+
+No exhaustive reference; see docs for constraints.
+---
+
+## Documentation
+
+- docs/overview.md
+- docs/conventions.md
+
+---
+
+## Related Packages
+
+- @comity/router
+- @comity/http
+
+---
+
+## Status
+
+Stable
+
+_Review Completed: 2026-07-25_
+_Reviewer: Hobiri MAGI (DeepSeek v4 Pro)_
+_Compliance Score: 99.5% (Green)_

package/dist/cjs/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathRouter = void 0;
+var router_js_1 = require("./router.js");
+Object.defineProperty(exports, "PathRouter", { enumerable: true, get: function () { return router_js_1.PathRouter; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/router.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathRouter = void 0;
+const path_to_regexp_1 = require("path-to-regexp");
+/**
+ * PathRouter is a router implementation that matches incoming HTTP requests based on their URL path and HTTP method. It supports static paths and can be extended to support dynamic path parameters in the future.
+ */
+class PathRouter {
+    #routes;
+    /**
+     * @param routes - An array of Route objects that define the routing rules for this router.
+     */
+    constructor(routes) {
+        this.#routes = routes
+            .filter((r) => r.path)
+            .map((r) => ({
+            route: r,
+            match: (0, path_to_regexp_1.match)(r.path, { decode: decodeURIComponent }),
+        }));
+    }
+    /**
+     * Matches an incoming HTTP request against the defined routes.
+     *
+     * @param ctx - The context of the incoming HTTP request.
+     *
+     * @returns A promise that resolves to a RouteMatch object if a matching route is found, or null if no match is found.
+     */
+    async match(ctx) {
+        const method = ctx.http.request.method;
+        const pathname = ctx.url.pathname;
+        for (const r of this.#routes) {
+            if (r.route.method && r.route.method !== method) {
+                continue;
+            }
+            const m = r.match(pathname);
+            if (!m)
+                continue;
+            return {
+                route: r.route,
+                params: m.params,
+            };
+        }
+        return null;
+    }
+}
+exports.PathRouter = PathRouter;
+//# sourceMappingURL=router.js.map

package/dist/cjs/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export { PathRouter } from "./router.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/router.js

@@ -0,0 +1,43 @@
+import { match } from "path-to-regexp";
+/**
+ * PathRouter is a router implementation that matches incoming HTTP requests based on their URL path and HTTP method. It supports static paths and can be extended to support dynamic path parameters in the future.
+ */
+export class PathRouter {
+    #routes;
+    /**
+     * @param routes - An array of Route objects that define the routing rules for this router.
+     */
+    constructor(routes) {
+        this.#routes = routes
+            .filter((r) => r.path)
+            .map((r) => ({
+            route: r,
+            match: match(r.path, { decode: decodeURIComponent }),
+        }));
+    }
+    /**
+     * Matches an incoming HTTP request against the defined routes.
+     *
+     * @param ctx - The context of the incoming HTTP request.
+     *
+     * @returns A promise that resolves to a RouteMatch object if a matching route is found, or null if no match is found.
+     */
+    async match(ctx) {
+        const method = ctx.http.request.method;
+        const pathname = ctx.url.pathname;
+        for (const r of this.#routes) {
+            if (r.route.method && r.route.method !== method) {
+                continue;
+            }
+            const m = r.match(pathname);
+            if (!m)
+                continue;
+            return {
+                route: r.route,
+                params: m.params,
+            };
+        }
+        return null;
+    }
+}
+//# sourceMappingURL=router.js.map

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export { PathRouter } from "./router.js";

package/dist/types/router.d.ts

@@ -0,0 +1,19 @@
+import type { Route, RouteMatch, Router, RouteResolutionContext } from "@comity/router";
+/**
+ * PathRouter is a router implementation that matches incoming HTTP requests based on their URL path and HTTP method. It supports static paths and can be extended to support dynamic path parameters in the future.
+ */
+export declare class PathRouter implements Router {
+    #private;
+    /**
+     * @param routes - An array of Route objects that define the routing rules for this router.
+     */
+    constructor(routes: Route[]);
+    /**
+     * Matches an incoming HTTP request against the defined routes.
+     *
+     * @param ctx - The context of the incoming HTTP request.
+     *
+     * @returns A promise that resolves to a RouteMatch object if a matching route is found, or null if no match is found.
+     */
+    match(ctx: RouteResolutionContext): Promise<RouteMatch | null>;
+}

package/dist/types/types.d.ts

@@ -0,0 +1,15 @@
+import type { Route } from "@comity/router";
+import type { MatchFunction } from "path-to-regexp";
+/**
+ * CompiledRoute represents a route that has been compiled with a path matching function.
+ */
+export interface CompiledRoute {
+    /**
+     * The original route object.
+     */
+    route: Route;
+    /**
+     * The path matching function generated from the route's path.
+     */
+    match: MatchFunction<Record<string, string>>;
+}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@comity/router-path-to-regexp",
+  "version": "0.9.0",
+  "description": "path-to-regexp adapter for Comity applications.",
+  "type": "module",
+  "private": false,
+  "author": "Filippo Bovo <hello@filippobovo.com>",
+  "license": "MIT",
+  "comity": {
+    "layer": "technology-adapter",
+    "implements": "@comity/router"
+  },
+  "homepage": "https://github.com/comityjs/framework#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comityjs/framework.git"
+  },
+  "bugs": {
+    "url": "https://github.com/comityjs/framework/issues"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "keywords": [
+    "comity",
+    "comityjs",
+    "adapter",
+    "framework",
+    "path-to-regexp",
+    "router",
+    "routing",
+    "typescript"
+  ],
+  "files": [
+    "./dist",
+    "!./dist/**/*.map"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "sideEffects": false,
+  "peerDependencies": {
+    "path-to-regexp": "^8.0.0",
+    "@comity/router": "0.9.0"
+  },
+  "dependencies": {
+    "@comity/router": "0.9.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.13.4",
+    "path-to-regexp": "^8.4.2",
+    "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "node ../../scripts/build.mjs",
+    "dev": "node ../../scripts/build.mjs --watch",
+    "test": "vitest run --coverage",
+    "type-check": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint --ext .ts src"
+  }
+}