{"_id":"@openapi-spec/router","_rev":"6-805eb9d45252075763689921b1ce0e09","name":"@openapi-spec/router","dist-tags":{"latest":"0.7.1"},"versions":{"0.0.0-stage":{"name":"@openapi-spec/router","version":"0.0.0-stage","_id":"@openapi-spec/router@0.0.0-stage","stub":true,"maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"dist":{"shasum":"507a7314a9dcaba27846bdd59f88e9060c289a69","tarball":"https://registry.npmjs.org/@openapi-spec/router/-/router-0.0.0-stage.tgz","fileCount":2,"integrity":"sha512-B6gT4oqIM/t8SRXKgis3KK5H6NQ8lsO0Kdh+L3Chy9HreBGG+MEZJI2Jm/XnAVeaePtoOIaIjk9FQdWjw+JJrg==","signatures":[{"sig":"MEQCIDHUK3kZXD8yoZFivAyadPwOKXN2DMmCI+idd8+nTdToAiAwplRLEFmCplalwMl+r8lNV0hB10tG0f7drH56LyAgcQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":342},"_npmUser":{"name":"dinwwwh","email":"dinwwwh@gmail.com"},"description":"Temporary package placeholder for staged publishing","directories":{}},"0.4.0":{"name":"@openapi-spec/router","version":"0.4.0","keywords":["oas","openapi","openapi-spec","path-template","router","routing","typescript"],"license":"MIT","_id":"@openapi-spec/router@0.4.0","maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"homepage":"https://github.com/middleapi/openapi-spec","dist":{"shasum":"b9176ddbabd44ee8e804cea18a64aaced4ccaa2d","tarball":"https://registry.npmjs.org/@openapi-spec/router/-/router-0.4.0.tgz","fileCount":5,"integrity":"sha512-nXz4TuPR+sgR+79tQhiPbyrRsHuhtmRhtzNjOPcjDxQf91zGGVYFzBtlgNA2nALR1bppaSQONts4qOFmma88WQ==","signatures":[{"sig":"MEYCIQC2R4woJ6Pbl1ZE3rEWo+7S8AjYF8KU/qRHJ3HqaoeHeQIhAMwQAAtu/sAq6vd5AATwOqRD+dx4Y47Tv+Xa0X/cda9m","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEYCIQCYs3BtbH1p/kS/P3QM3Y9ZMsQisZvmPMi7DiJAr2yhAQIhAPIGPyiYp0qEslLZsEsYEReIpfeAm0IJV4qOkx/ba/+C","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":33891},"type":"module","exports":{".":{"types":"./dist/index.d.mts","import":"./dist/index.mjs","default":"./dist/index.mjs"},"./package.json":"./package.json"},"funding":["https://github.com/sponsors/dinwwwh","https://opencollective.com/middleapi"],"scripts":{},"unbuild":{"declaration":"node16"},"_npmUser":{"name":"dinwwwh","email":"dinwwwh@gmail.com"},"repository":{"url":"git+https://github.com/middleapi/openapi-spec.git","type":"git","directory":"packages/router"},"description":"Fast HTTP router for OpenAPI path templates, with {name} and {+name} params, built for oRPC","directories":{},"sideEffects":false,"_hasShrinkwrap":false,"devDependencies":{"rou3":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/router_0.4.0_1793172595053_0.3691686971609238","host":"s3://npm-registry-packages-npm-production"}},"0.5.0":{"name":"@openapi-spec/router","version":"0.5.0","keywords":["oas","openapi","openapi-spec","path-template","router","routing","typescript"],"license":"MIT","_id":"@openapi-spec/router@0.5.0","maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"homepage":"https://github.com/middleapi/openapi-spec","dist":{"shasum":"7492f328b889fc1a5b0542ebdb02a34e026a11c5","tarball":"https://registry.npmjs.org/@openapi-spec/router/-/router-0.5.0.tgz","fileCount":5,"integrity":"sha512-tUaYXgsCdUD2E5zbjN/wGmy/JEg4BJsAHomBHVwUt7loGx9wQAyQGJQhUjO5bLb4ULGa8Bsg0/YR+s8TWXRoTA==","signatures":[{"sig":"MEUCIDE0THoiM7+FtDxULKHVJgs2heOxOzlGw/gH6QpqMTB1AiEAxS3QyXxipreYuDLTTFpR7Z12azEpyx/t/mzJjEh8n/o=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEYCIQDaE/NtuDhwja7l8gFp2wS5C+YY4vUu+sDwzUL5dkeh8QIhAOMaWj+eG2RqASz4tB/RALpRxzFl+Y1t15/AosRjClDZ","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@openapi-spec%2frouter@0.5.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":37087},"type":"module","exports":{".":{"types":"./dist/index.d.mts","import":"./dist/index.mjs","default":"./dist/index.mjs"},"./package.json":"./package.json"},"funding":["https://github.com/sponsors/dinwwwh","https://opencollective.com/middleapi"],"scripts":{},"unbuild":{"declaration":"node16"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"4edf9aa3-0f2f-4904-8a43-86d96f274fc5"}},"repository":{"url":"git+https://github.com/middleapi/openapi-spec.git","type":"git","directory":"packages/router"},"description":"Fast HTTP router for OpenAPI path templates, with {name} and {+name} params, built for oRPC","directories":{},"sideEffects":false,"_hasShrinkwrap":false,"devDependencies":{"rou3":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/router_0.5.0_1793501537594_0.3314624555872626","host":"s3://npm-registry-packages-npm-production"}},"0.6.0":{"name":"@openapi-spec/router","version":"0.6.0","keywords":["oas","openapi","openapi-spec","path-template","router","routing","typescript"],"license":"MIT","_id":"@openapi-spec/router@0.6.0","maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"homepage":"https://github.com/middleapi/openapi-spec","dist":{"shasum":"3b580fc458ac8cbc7663ffd80a53ed0a2700e231","tarball":"https://registry.npmjs.org/@openapi-spec/router/-/router-0.6.0.tgz","fileCount":5,"integrity":"sha512-CioJ7X0ROAc7uLCKPNMDdtZZaOPwG6faK1yJNVFP6CBoc63KzNZYjwFcRqfX7sO/mmtfSDvBgyUt4Z3c2dXPuQ==","signatures":[{"sig":"MEUCIFQvC3piMaMW0WkSvVLXG7/BccRHdI8/WAu066Dy4vc/AiEAlzanD8Fp4mhpHwTeTmROYYkC2Mp1vCezYsLdZvfslaA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEQCIDXpQE5GNP+D/aS3khadAKIfLFYT+C0CkQyt4lmcWbDOAiBTLQILTNbXyl5KEQ1R8V+p+DmvTc9pEiySVuFowEYdgQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@openapi-spec%2frouter@0.6.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":37087},"type":"module","exports":{".":{"types":"./dist/index.d.mts","import":"./dist/index.mjs","default":"./dist/index.mjs"},"./package.json":"./package.json"},"funding":["https://github.com/sponsors/dinwwwh","https://opencollective.com/middleapi"],"scripts":{},"unbuild":{"declaration":"node16"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"4edf9aa3-0f2f-4904-8a43-86d96f274fc5"}},"repository":{"url":"git+https://github.com/middleapi/openapi-spec.git","type":"git","directory":"packages/router"},"description":"Fast HTTP router for OpenAPI path templates, with {name} and {+name} params, built for oRPC","directories":{},"sideEffects":false,"_hasShrinkwrap":false,"devDependencies":{"rou3":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/router_0.6.0_1793529377901_0.47720248336619264","host":"s3://npm-registry-packages-npm-production"}},"0.7.0":{"name":"@openapi-spec/router","version":"0.7.0","keywords":["oas","openapi","openapi-spec","path-template","router","routing","typescript"],"license":"MIT","_id":"@openapi-spec/router@0.7.0","maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"homepage":"https://github.com/middleapi/openapi-spec","dist":{"shasum":"ce1794349ddf69122c5ed2e11f8af1ccf4e0f853","tarball":"https://registry.npmjs.org/@openapi-spec/router/-/router-0.7.0.tgz","fileCount":5,"integrity":"sha512-G3ZYcSJB1jJFkJ+A76KrGeK9lLYZwmmHSahbEZ8KBrGBdUqG+vqq+FSj6f4Qo25a+J71S9Sufc2ldNB75AjvRQ==","signatures":[{"sig":"MEYCIQD9dp3/1W9L5+Jg64DoFOmGv/i+oCqUl9xUIOQS/BpE9wIhAO9O4tfYnvzvXdu/P+69iyQsjos7EuSmUuTrDrBs8062","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEYCIQCS+e8a0JKmnAi9I9+mjd2J0/5Nv2yFuNiXihQFAmJf5gIhAL4MqRDtvBF3t0ROIug2UWkTZJIMGg3N78Z/6vO2w6yv","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@openapi-spec%2frouter@0.7.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":45250},"type":"module","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"},"./package.json":"./package.json"},"funding":["https://github.com/sponsors/dinwwwh","https://opencollective.com/middleapi"],"scripts":{},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"4edf9aa3-0f2f-4904-8a43-86d96f274fc5"}},"repository":{"url":"git+https://github.com/middleapi/openapi-spec.git","type":"git","directory":"packages/router"},"description":"Fast HTTP router for OpenAPI path templates, with {name} and {+name} params, built for oRPC","directories":{},"sideEffects":false,"_hasShrinkwrap":false,"devDependencies":{"rou3":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/router_0.7.0_1793953084439_0.7131320132373068","host":"s3://npm-registry-packages-npm-production"}},"0.7.1":{"_id":"@openapi-spec/router@0.7.1","dist":{"shasum":"e10bedbaa8f01d86eccdc6ab2269f4bb67cd2bfb","tarball":"https://registry.npmjs.org/@openapi-spec/router/-/router-0.7.1.tgz","fileCount":5,"integrity":"sha512-yG6JfQM2BqJrj2DCce3L64JvJKah9ssgKoweTxx3IdsP0F0Xm4lDgBzV2NP3pF1kamDbFxXkP7N2T7fJn5WLSA==","signatures":[{"sig":"MEUCICbrg4jIwVIo9lPfMOol9YFIaTKue3A8P4G4w+p2yddLAiEAlTf3ZtiSMFgbQeyZPz1oSZ7jIJOQZuhLFFMR6Xn3gGE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDcx5j02lWgOpidw/K+zM5paXNZQn7SkYkIUU3XYHh9XAIgSZfRgMwcDeCvIwWTf1yOpg02QHKsusbEOXpv7qaWMco="}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@openapi-spec%2frouter@0.7.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":45250},"name":"@openapi-spec/router","type":"module","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"},"./package.json":"./package.json"},"funding":["https://github.com/sponsors/dinwwwh","https://opencollective.com/middleapi"],"license":"MIT","scripts":{},"version":"0.7.1","_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"4edf9aa3-0f2f-4904-8a43-86d96f274fc5"}},"homepage":"https://github.com/middleapi/openapi-spec","keywords":["oas","openapi","openapi-spec","path-template","router","routing","typescript"],"repository":{"url":"git+https://github.com/middleapi/openapi-spec.git","type":"git","directory":"packages/router"},"description":"Fast HTTP router for OpenAPI path templates, with {name} and {+name} params, built for oRPC","directories":{},"maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"sideEffects":false,"_hasShrinkwrap":false,"devDependencies":{"rou3":"^1.0.0"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/router_0.7.1_1793971544555_0.6012080844297447"}}},"time":{"created":"2026-10-28T07:28:39.349Z","modified":"2026-11-06T13:25:45.218Z","0.0.0-stage":"2026-10-28T07:28:39.349Z","0.4.0":"2026-10-28T07:29:55.139Z","0.5.0":"2026-11-01T02:52:17.668Z","0.6.0":"2026-11-01T10:36:17.982Z","0.7.0":"2026-11-06T08:18:04.551Z","0.7.1":"2026-11-06T13:25:44.645Z"},"license":"MIT","homepage":"https://github.com/middleapi/openapi-spec","keywords":["oas","openapi","openapi-spec","path-template","router","routing","typescript"],"repository":{"url":"git+https://github.com/middleapi/openapi-spec.git","type":"git","directory":"packages/router"},"description":"Fast HTTP router for OpenAPI path templates, with {name} and {+name} params, built for oRPC","maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"readme":"

OpenAPI Spec

\n\n
\n \n \"codecov\"\n \n \n \"monthly\n \n \n \"CodSpeed\"\n \n \n \"MIT\n \n \n \"Discord\"\n \n \n \"Ask\n \n
\n\n`@openapi-spec/router` matches HTTP requests against [OpenAPI](https://spec.openapis.org/) path templates such as `/planets/{id}` and `/files/{+path}`, with no route syntax of its own to translate them into. It is built for how [oRPC](https://orpc.dev) routes [OpenAPI procedures](https://orpc.dev/docs/openapi/routing): small, with no dependencies, and faster than [rou3](https://github.com/h3js/rou3) on the route sets oRPC builds.\n\n## Usage\n\n```ts\nimport { createPrefixMatcher, Router } from '@openapi-spec/router'\n\nconst router = new Router()\n\nrouter.add('GET', '/planets', 'list')\nrouter.add('GET', '/planets/{id}', 'find')\nrouter.add('GET', '/files/{+path}/raw', 'raw')\n\nrouter.match('GET', '/planets/earth')\n// { data: 'find', params: { id: 'earth' } }\n\nrouter.match('GET', '/files/docs/a%20b.md/raw')\n// { data: 'raw', params: { path: 'docs/a b.md' } }\n\nrouter.match('GET', '/planets/')\n// { data: 'list', params: undefined }\n\nrouter.match('POST', '/planets')\n// undefined\n\n// Whether a request can reach a route under a prefix, such as one of a lazy router\nconst underUser = createPrefixMatcher('/users/{userId}')\n\nunderUser('/users/din/settings') // true\nunderUser('/projects/42') // false\n```\n\n`match` takes the request method and its percent-encoded path, without the query string, as `new URL(request.url).pathname` gives it. Methods match exactly, so pass them in the case the routes use.\n\n## Path templates\n\n- `{name}` as a whole segment is a param. It matches one non-empty segment. Names are made of letters, digits, `_`, and `-`.\n- `{+name}` as a whole segment is a catch-all param. It matches one or more segments, slashes included, and its value cannot be empty. A path can have one, and segments can follow it, as in `/files/{+path}/raw`. Adding a path with more than one throws a `TypeError`.\n- Any other text is literal, including braces that are not a whole segment, as in `/a/{id}.json`, and characters other routers treat as syntax, such as `:`, `*`, `?`, `(`, and `.`.\n- Literal text matches however the route or the request percent-encodes it: `/cafΓ©` matches `/caf%C3%A9`, and `/v1^beta` matches `/v1%5Ebeta`. A `%2F` stays inside its segment. Text whose percent-encoding is malformed is compared as written.\n- Param values are percent-decoded. A catch-all param joins its decoded segments with `/`.\n- One trailing slash is ignored, in routes and in requests. Other empty segments are kept: `/a//b` does not match `/a/b`.\n\n## Priority\n\nWhen more than one route matches, segments compare from left to right. At each segment a literal beats a param, which beats a catch-all param, and a route that fails further on falls back to the next candidate:\n\n```ts\nrouter.add('GET', '/users/me', 'me')\nrouter.add('GET', '/users/{id}', 'user')\nrouter.add('GET', '/users/{id}/posts', 'posts')\nrouter.add('GET', '/{+path}', 'fallback')\n\nrouter.match('GET', '/users/me') // 'me'\nrouter.match('GET', '/users/m%65') // 'me'\nrouter.match('GET', '/users/me/posts') // 'posts', with { id: 'me' }\nrouter.match('GET', '/users/me/likes') // 'fallback'\n```\n\nCatch-all params that start at the same segment compare the segments after them from the last one, so `/files/{+path}/raw` beats `/files/{+path}` for `/files/a/raw`. A route with the same method and segments as one added earlier, even with other param names, is ignored.\n\n## Performance\n\nA request path without `%` that matches a route without params is found with one lookup. Other paths are split into segments once and walk a tree of literal, param, and catch-all children, so the work grows with the number of segments, not the number of routes. A tree that holds, at many segments in a row, both literals and params a request could take can fall back many times before it finds a match, as with any router that backtracks.\n\n`add` keeps each route with params as written, and the tree is built as requests reach it: a method's first request that needs the tree adds each route's segments up to its first param, and the segments from each param on wait until a request reaches that point. A process that starts cold and serves a few requests pays only for the methods it serves and the params their requests reach.\n\nPaths with params cost more than static ones, since each of their segments is sliced out and matched on its own. Radix-tree routers such as [memoirist](https://github.com/SaltyAom/memoirist) and [find-my-way](https://github.com/delvedor/find-my-way) compare the path in place and can be faster on them.\n\n[Benchmarks](https://github.com/middleapi/openapi-spec/tree/main/packages/router/benches) compare it with [rou3](https://github.com/h3js/rou3) on route sets like oRPC's. [CodSpeed](https://app.codspeed.io/middleapi/openapi-spec) runs them on every pull request to catch regressions.\n\n## Sponsors\n\nLike what we build over at [middleapi](https://github.com/middleapi)? You can help keep it going through [GitHub Sponsors](https://github.com/sponsors/dinwwwh) or [Open Collective](https://opencollective.com/middleapi). Every bit helps! πŸš€\n\n\n \n \n \n \n \n \n \n \n \n
\"ScreenshotOne.com\"/ScreenshotOne.com
The screenshot API for developers
\"Yuzu\"/Yuzu
We're hiring NYC based engineers
\"MisskeyHQ\"/MisskeyHQ
Decentralized microblogging SNS born on Earth
\n\n### Organization Sponsors\n\n\n \n \n \n
\"LN
LN Markets
\n\n### Sponsors\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"Reece
Reece McDonald		\"あわわわとーにゅ\"/
あわわわとーにゅ		\"nk\"/
nk		\"supastarter\"/
supastarter		\"herrfugbaum\"/
herrfugbaum
\"Ryota
Ryota Murakami		\"David
David Cramer		\"Valerii
Valerii Petryniak		\"Valerii
Valerii Strilets		\"Kyle
Kyle Mistele
\"christ12938\"/
christ12938		\"Ryan
Ryan Soderberg		\"shota\"/
shota		\"Nicholas\"/
Nicholas		\"Ellis
Ellis Driscoll
\"Hoang
Hoang Nguyen		\"Orestis
Orestis Ioannou		\"Stefan
Stefan Smiljkovic
\n\n### Backers\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"David
David Walsh		\"IPv4Addr\"/
IPv4Addr		\"Robbe
Robbe Vaes		\"Aidan
Aidan Sunbury		\"soonoo\"/
soonoo		\"Kevin
Kevin Porten
\"Denis\"/
Denis		\"Christopher
Christopher Kapic		\"Tom
Tom Ballinger		\"Sam\"/
Sam		\"Titoine\"/
Titoine		\"Igor
Igor Makowski
\"hanayashiki\"/
hanayashiki		\"Lev
Lev Dubinets		\"Kelly
Kelly Peilin Chan		\"Guy
Guy Ariely		\"PaulSenon\"/
PaulSenon		\"Alex\"/
Alex
\"Andrey
Andrey Gubanov
\n\nWith thanks to [40 past sponsors](https://htmlpreview.github.io/?https://github.com/middleapi/static/blob/main/sponsors.svg) who helped get openapi-spec here.\n\n## Open Source Programs\n\n[middleapi](https://github.com/middleapi) is supported by these open source programs:\n\n\n \n \n \n \n
\"Claude\"/
Claude		\"Pullfrog\"/
Pullfrog
\n\n## License\n\nDistributed under the MIT License. See [LICENSE](https://github.com/middleapi/openapi-spec/blob/main/LICENSE) for more information.\n","readmeFilename":""}