router-http 0.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2023 Kiko Beats <josefrancisco.verdu@gmail.com> (kikobeats.com)
+
+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,148 @@
+# http-router
+
+![Last version](https://img.shields.io/github/tag/Kikobeats/http-router.svg?style=flat-square)
+[![Coverage Status](https://img.shields.io/coveralls/Kikobeats/http-router.svg?style=flat-square)](https://coveralls.io/github/Kikobeats/http-router)
+[![NPM Status](https://img.shields.io/npm/dm/http-router.svg?style=flat-square)](https://www.npmjs.org/package/http-router)
+
+An HTTP router focused in only that, similar to [express@router](https://github.com/pillarjs/router), but:
+
+- Focused in just one thing.
+- Maintained and well tested.
+- Most of the API is supported.
+- Smaller and portable (less 50kbs).
+
+Don't get me wrong: The original Express router is a piece of art. I used it for years and I just considered create this library after experienced a bug that never was addressed in the stable version due to the [lack of maintenance](https://github.com/pillarjs/router/pull/60).
+
+While I was evaluating the market for finding an alternative I found [polka](https://github.com/lukeed/polka/tree/master/packages/polka) was a good starting point for creating a replacement. This module is different than polka in some aspects:
+
+- This module doesn't take care about the http.Server.
+- This module doesn't use any of the Node.js built-in module, so it can be used in Vercel Edge Functions, Deno or CF Workers.
+- This module doesn't adds `req.query` nor `req.search` (check [to-query](https://github.com/Kikobeats/to-query) for that).
+
+In resume: this module does nothing beyond finding the correct path and matching the associated code.
+
+## Install
+
+```bash
+$ npm install http-router --save
+```
+
+## Usage
+
+First, you should to create a router:
+
+```js
+const createRouter = require('http-router')
+
+const router = createRouter((err, req, res) => {
+  const hasError = err !== undefined
+  res.statusCode = hasError ? 500 : 404
+  res.end(hasError ? err.message : 'Not Found')
+})
+```
+
+The router requires a final handler that will be called if an error occurred or none of the routes match.
+
+After that, you can declare any HTTP verb route:
+
+### Declaring routes
+
+```js
+/**
+ * Declaring multiple routes based on the HTTP verb.
+ */
+router
+  .get('/', (req, res) => {
+    res.statusCode = 204
+    res.end()
+  })
+  .post('/ping', (req, res) => res.end('pong'))
+  .get('/greetings/:name', (req, res) => {
+    const { name } = req.params
+    res.end(`Hello, ${name}!`)
+  })
+```
+
+Alternatively, you can call `.all` for associate a route for all the verbs:
+
+```js
+/**
+ * Declaring a route to match all the HTTP verbs.
+ */
+router.all('/ping', (req, res) => res.end('pong'))
+```
+
+### Declaring middlewares
+
+A middleware can be declared at root level:
+
+```js
+/**
+ * Declaring a middleware that will be always executed.
+ */
+router
+  .use('/', (req, res, next) => {
+    req.timestamp = Date.now()
+    next()
+  })
+```
+
+or for specific routes:
+
+```js
+/**
+ * Declaring a middleware to execute for a certain route path.
+ */
+router
+  .use('/greetings', (req, res, next) => {
+    req.greetings = 'Greetings'
+    next()
+  })
+  .get('/greetings/:username', (req, res) => {
+    res.end(`${req.greetings}, ${req.params.username}`)
+  })
+```
+
+### Prefixing routes
+
+In case you need you can prefix all the routes:
+
+```js
+routes.get('/', (req, res) => res.end('Welcome to my API!'))
+
+/**
+ * Prefix all routes with the API version
+ */
+const router = Router(final)
+router
+  .use('/latest', routes)
+  .use('/v1', routes)
+```
+
+### Using the router
+
+After the router has been initialized, start using it as handler in your Node.js server:
+
+```js
+const server = http.createServer(router)
+```
+
+## Benchmark
+
+The performance is essentially the same than polka, and that is almost x3 faster than express.
+
+See [benchmark](/benchmark) sections.
+
+## Related
+
+- [send-http](https://github.com/Kikobeats/send-http) – A `res.end` with data type detection.
+- [http-body](https://github.com/Kikobeats/http-body) – Parse the http.IncomingMessage body into text/json/buffer.
+- [http-compression](https://github.com/Kikobeats/http-compression) – Adding compression (gzip/brotli) for your HTTP server in Node.js
+- [to-query](https://github.com/Kikobeats/to-query) Get query object from a request url.
+
+## License
+
+**http-router** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/http-router/blob/master/LICENSE.md) License.<br>
+Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/Kikobeats/http-router/contributors).
+
+> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/Kikobeats) · Twitter [@Kikobeats](https://twitter.com/Kikobeats)

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "router-http",
+  "description": "Simple HTTP router compatible with Express",
+  "homepage": "https://nicedoc.io/Kikobeats/http-router",
+  "version": "0.0.0",
+  "main": "src/index.js",
+  "author": {
+    "email": "josefrancisco.verdu@gmail.com",
+    "name": "Kiko Beats",
+    "url": "https://kikobeats.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Kikobeats/http-router.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Kikobeats/http-router/issues"
+  },
+  "keywords": [
+    "app",
+    "http",
+    "http",
+    "middleware",
+    "pathname",
+    "rest",
+    "route",
+    "router",
+    "routes"
+  ],
+  "dependencies": {
+    "trouter": "~3.2.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "latest",
+    "@commitlint/config-conventional": "latest",
+    "ava": "latest",
+    "c8": "latest",
+    "conventional-github-releaser": "latest",
+    "finepack": "latest",
+    "git-authors-cli": "latest",
+    "got": "11",
+    "nano-staged": "latest",
+    "npm-check-updates": "latest",
+    "prettier-standard": "latest",
+    "simple-git-hooks": "latest",
+    "standard": "latest",
+    "standard-markdown": "latest",
+    "standard-version": "latest"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "files": [
+    "src"
+  ],
+  "license": "MIT",
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "nano-staged": {
+    "*.js,!*.min.js,": [
+      "prettier-standard"
+    ],
+    "*.md": [
+      "standard-markdown"
+    ],
+    "package.json": [
+      "finepack"
+    ]
+  },
+  "simple-git-hooks": {
+    "commit-msg": "npx commitlint --edit",
+    "pre-commit": "npx nano-staged"
+  },
+  "scripts": {
+    "clean": "rm -rf node_modules",
+    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
+    "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
+    "lint": "standard-markdown README.md && standard",
+    "postrelease": "npm run release:tags && npm run release:github && npm publish",
+    "prerelease": "npm run update:check",
+    "pretest": "npm run lint",
+    "release": "standard-version -a",
+    "release:github": "conventional-github-releaser -p angular",
+    "release:tags": "git push --follow-tags origin HEAD:master",
+    "test": "c8 ava",
+    "update": "ncu -u",
+    "update:check": "ncu -- --error-level 2"
+  }
+}

package/src/index.js

@@ -0,0 +1,106 @@
+'use strict'
+
+const Trouter = require('trouter')
+
+const requiredFinalHandler = () => {
+  throw new TypeError('You should to provide a final handler')
+}
+
+/**
+ * ensure input starts with '/'
+ */
+const lead = route => (route.charCodeAt(0) === 47 ? route : `/${route}`)
+
+const value = x => {
+  const y = x.indexOf('/', 1)
+  return y > 1 ? x.substring(0, y) : x
+}
+
+const mutate = (str, req) => {
+  req.url = req.url.substring(str.length) || '/'
+  req.path = req.path.substring(str.length) || '/'
+}
+
+class Router extends Trouter {
+  constructor (unhandler) {
+    super()
+    this.unhandler = unhandler
+  }
+
+  /**
+   * Middleware per all routes
+   */
+  #middlewares = []
+
+  /**
+   * Middleware for specific routes
+   */
+  #middlewaresBy = []
+
+  /**
+   * Middleware declaration, where the base is optional
+   * .use(one)
+   * .use('/v1', one)
+   * .use(one, two)
+   * .use('/v2', two)
+   */
+  use = (base = '/', ...fns) => {
+    if (typeof base === 'function') {
+      this.#middlewares = this.#middlewares.concat(base, fns)
+    } else if (base === '/') {
+      this.#middlewares = this.#middlewares.concat(fns)
+    } else {
+      base = lead(base)
+      fns.forEach(fn => {
+        const array = this.#middlewaresBy[base] || []
+        array.length > 0 || array.push((r, _, nxt) => (mutate(base, r), nxt()))
+        this.#middlewaresBy[base] = array.concat(fn)
+      })
+    }
+    return this
+  }
+
+  handler = (req, res, pathname) => {
+    pathname = pathname || req.url
+    let fns = []
+    let middlewares = this.#middlewares
+    const route = this.find(req.method, pathname)
+    const base = value((req.path = pathname))
+    if (this.#middlewaresBy[base] !== undefined) {
+      middlewares = middlewares.concat(this.#middlewaresBy[base])
+    }
+    if (route) {
+      fns = route.handlers
+      req.params = { ...req.params, ...route.params }
+    }
+    fns.push(this.unhandler)
+    // Exit if only a single function
+    let i = 0
+    let len = middlewares.length
+    const num = fns.length
+    if (len === i && num === 1) return fns[0](undefined, req, res)
+
+    // Otherwise loop thru all middlware
+    const next = err => (err ? this.unhandler(err, req, res, next) : loop())
+
+    const loop = () => {
+      if (res.writableEnded) return
+      if (i >= len) return
+      try {
+        return middlewares[i++](req, res, next)
+      } catch (err) {
+        return next(err)
+      }
+    }
+
+    middlewares = middlewares.concat(fns)
+    len += num
+    loop() // init
+  }
+}
+
+module.exports = (finalhandler = requiredFinalHandler()) => {
+  const router = new Router(finalhandler)
+  const handler = (req, res) => router.handler(req, res)
+  return Object.assign(handler, router)
+}