@ditojs/router 1.25.0 → 1.25.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/router",
-  "version": "1.25.0",
+  "version": "1.25.1",
   "type": "module",
   "description": "Dito.js Router – Dito.js is a declarative and modern web framework, based on Objection.js, Koa.js and Vue.js",
   "repository": "https://github.com/ditojs/dito/tree/master/packages/router",
@@ -30,6 +30,6 @@
     "koa",
     "dito"
   ],
-  "gitHead": "29e7f8d8c613c48a856d90d1ee876e85c8d84c08",
+  "gitHead": "bebbf44ddf15a565e50ed8b2cbe0bf8a463c276d",
   "readme": "# Dito.js Router\n\nDito.js is a declarative and modern web framework with a focus on API driven\ndevelopment, based on Koa.js, Objection.js and Vue.js\n\nReleased in 2018 under the MIT license, with support by https://lineto.com/\n\nDito.js Router is a high performance, tree-based, framework agnostic HTTP\nrouter, based on [trek-router](https://github.com/trekjs/router), which in turn\nis inspired by [Echo](https://github.com/labstack/echo)'s Router.\n\n## How does it work?\n\nThe router relies on a tree structure which makes heavy use of common\nprefixes, essentially a [prefix tree](https://en.wikipedia.org/wiki/Trie).\n\n## Usage\n\n```js\nimport Koa from 'koa'\nimport compose from 'koa-compose'\nimport Router from '@ditojs/router'\n\nconst app = new Koa()\nconst router = new Router()\n\n// static route\nrouter.get('/folders/files/bolt.gif', ctx => {\n  ctx.body = `this ain't no GIF!`\n})\n\n// param route\nrouter.get('/users/:id', ctx => {\n  ctx.body = `requesting user ${ctx.params.id}`\n})\n\n// match-any route\nrouter.get('/books/*', ctx => {\n  ctx.body = `sub-route: ${ctx.params['*']}`\n})\n\n// Handler found\nlet { handler, params } = router.find('get', '/users/233')\nconsole.log(handler) // ctx => { ... }\n\n// Entry not Found\nlet { handler, params } = router.find('get', '/photos/233')\nconsole.log(handler) // null\n\n// Install router middleware\napp.use(async (ctx, next) => {\n  const { method, path } = ctx\n  const result = router.find(method, path)\n  const { handler, params } = result\n  if (handler) {\n    ctx.params = params || {}\n    return handler(ctx, next)\n  } else {\n    try {\n      await next()\n    } finally {\n      if (ctx.body === undefined && ctx.status === 404) {\n        ctx.status = result.status || 404\n        if (ctx.status !== 404 && result.allowed) {\n          ctx.set('Allow', result.allowed.join(', '))\n        }\n      }\n    }\n  }\n})\n\napp.listen(4040, () => console.log('Koa app listening on 4040'))\n```\n"
 }

package/src/Node.js

@@ -133,13 +133,13 @@ export default class Node {
     }
   }
 
-  find(path, paramValues = []) {
+  find(path, parameterValues = []) {
     const { prefix } = this
     if (!path || path === prefix) {
       // It's a match!
       const { handler } = this
       if (handler) {
-        const params = this.parameters.getObject(paramValues)
+        const params = this.parameters.getObject(parameterValues)
         // Support HTTP status on found entries.
         return { handler, params, status: 200 }
       }
@@ -165,7 +165,7 @@ export default class Node {
       child => child.type === TYPE_STATIC && child.label === label
     )
     if (staticChild) {
-      const result = staticChild.find(path, paramValues)
+      const result = staticChild.find(path, parameterValues)
       if (result) {
         return result
       }
@@ -185,21 +185,21 @@ export default class Node {
       while (pos < max && path[pos] !== CHAR_SLASH) {
         pos++
       }
-      paramValues.push(path.slice(0, pos))
-      const result = paramChild.find(path.slice(pos), paramValues)
+      parameterValues.push(path.slice(0, pos))
+      const result = paramChild.find(path.slice(pos), parameterValues)
       if (result) {
         return result
       }
-      paramValues.pop()
+      parameterValues.pop()
     }
 
     // Match-any nodes
     if (this.hasMatchAny) {
       for (const child of this.children) {
-        const match = child.parameters?.matchPathPattern(path)
-        if (match) {
-          paramValues.push(...Object.values(match.groups))
-          return child.find('', paramValues) // '' == End
+        const values = child.parameters?.matchPathPattern(path)
+        if (values) {
+          parameterValues.push(...values)
+          return child.find('', parameterValues) // '' == End
         }
       }
     }
@@ -240,8 +240,8 @@ class Parameters {
     this.placeholderIndex = 0
   }
 
-  add(...keys) {
-    this.keys.push(...keys)
+  add(key) {
+    this.keys.push(key)
   }
 
   getMatchAnyKey() {
@@ -257,39 +257,38 @@ class Parameters {
   }
 
   matchPathPattern(path) {
-    return this.pathPattern?.exec(path)
+    const match = this.pathPattern?.exec(path)
+    return match ? Object.values(match.groups) : null
   }
 
   setupPathPattern(path) {
     // Replace all '**' with '.+?' and all '*' with '[^/]+'.
     // Use named groups to merge multiple ** or * into one.
     const pattern = []
-    const keys = []
     for (const token of path.split('/')) {
       if (token === '**') {
         const key = this.getMatchAnyKey()
         pattern.push(`(?<${key}>.+?)`)
-        keys.push(key)
+        this.add(key)
       } else if (token === '*') {
         const key = this.getPlaceholderKey()
         pattern.push(`(?<${key}>[^/]+)`)
-        keys.push(key)
+        this.add(key)
       } else if (token.startsWith(':')) {
         const key = token.slice(1)
         pattern.push(`(?<${key}>[^/]+)`)
-        keys.push(key)
+        this.add(key)
       } else {
         pattern.push(token)
       }
     }
     this.pathPattern = new RegExp(`^${pattern.join('/')}$`)
-    this.add(...keys)
   }
 
   getObject(values) {
     // Convert parameters and values to a params object, but rename path pattern
     // groups back to param names
-    const params = {}
+    const object = {}
     let i = 0
     for (const key of this.keys) {
       const name = key.startsWith('$$')
@@ -301,8 +300,8 @@ class Parameters {
             ? '$'
             : key
           : key
-      params[name] = values[i++]
+      object[name] = values[i++]
     }
-    return params
+    return object
   }
 }