itty-router 2.5.0 → 2.5.3

package/CHANGELOG.md

@@ -1,7 +1,10 @@
 ## Changelog
 Until this library makes it to a production release of v1.x, **minor versions may contain breaking changes to the API**.  After v1.x, semantic versioning will be honored, and breaking changes will only occur under the umbrella of a major version bump.
 
-[@SupremeTechnopriest)(https://github.com/SupremeTechnopriest) - improved TypeScript support and documentation! :D
+[@SupremeTechnopriest)(https://github.com/SupremeTechnopriest) - improved TypeScript support and documentation! :D\
+
+- **v2.5.2** - fixes issue with arrow functions in CommonJS named exports (rare issue)
+- **v2.5.1** - added context to Cloudflare ES module syntax example (credit [@jcapogna](https://github.com/jcapogna))
 - **v2.5.0** - improved TypeScript docs/types (thanks [@SupremeTechnopriest](https://github.com/SupremeTechnopriest)!)
 - **v2.4.9** - fixed the cursed "optional" file format capturing bug - RIP all the bytes lost
 - **v2.4.6** - fixed README issues

package/README.md

@@ -19,7 +19,7 @@
   <img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
 </a>-->
 
-It's an itty bitty router, designed for express-like routing within [Cloudflare Workers](https://developers.cloudflare.com/workers/) (or anywhere else). Like... it's super tiny ([~500 bytes](https://bundlephobia.com/package/itty-router)), with zero dependencies. For reals.
+Tiny, zero-dependency router with route param and query parsing - built for [Cloudflare Workers](https://developers.cloudflare.com/workers/), but works everywhere!
 
 ### Addons & Related Libraries
 1. [itty-router-extras](https://www.npmjs.com/package/itty-router-extras) - adds quality-of-life improvements and utility functions for simplifying request/response code (e.g. middleware, cookies, body parsing, json handling, errors, and an itty version with automatic exception handling)!
@@ -27,9 +27,9 @@ It's an itty bitty router, designed for express-like routing within [Cloudflare
 
 ## Features
 - [x] Tiny ([~500 bytes](https://bundlephobia.com/package/itty-router) compressed), with zero dependencies.
-- [x] [TypeScript support](#typescript)!
-- [x] Full sync/async support.  Use it when you need it!
-- [x] Route params, with wildcards and optionals (e.g. `/api/:collection/:id?`)
+- [x] [Fully typed/TypeScript support](#typescript)
+- [x] Supports sync/async handlers/middleware.
+- [x] Parses route params, with wildcards and optionals (e.g. `/api/:collection/:id?`)
 - [x] Query parsing (e.g. `?page=3&foo=bar`)
 - [x] [Middleware support](#middleware). Any number of sync/async handlers may be passed to a route.
 - [x] [Nestable](#nested-routers-with-404-handling). Supports nesting routers for API branching.
@@ -105,9 +105,9 @@ router.get('/todos/:user/:item?', (req) => {
 ```
 
 ### 3. Handle Incoming Request(s)
-##### `async router.handle(request.proxy: Proxy || request: Request, ...anything else)`
+##### `async router.handle(request.proxy: Proxy || request: Request, ...anything else) => Promise<any>`
 Requests (doesn't have to be a real Request class) should have both a **method** and full **url**.
-The `handle` method will then return the first matching route handler that returns something (or nothing at all if no match).
+The `handle` method will then return a Promise, resolving with the first matching route handler that returns something (or nothing at all if no match).
 
 ```js
 router.handle({
@@ -283,16 +283,33 @@ router.get('/todos/:id.:format?', request => {
 ```
 
 ### Cloudflare ES6 Module Syntax (required for Durable Objects) <a id="cf-es6-module-syntax"></a>
+See https://developers.cloudflare.com/workers/runtime-apis/fetch-event#syntax-module-worker
 ```js
+import { Router } from 'itty-router'
+
 const router = Router()
 
-router.get('/', (request, env) => {
+router.get('/', (request, env, context) => {
   // now have access to the env (where CF bindings like durables, KV, etc now are)
 })
 
 export default {
   fetch: router.handle // yep, it's this easy.
 }
+
+// alternative advanced/manual approach for downstream control
+export default {
+  fetch: (...args) => router
+                        .handle(...args)
+                        .then(response => {
+                          // can modify response here before final return, e.g. CORS headers
+
+                          return response
+                        })
+                        .catch(err => {
+                          // and do something with the errors here, like logging, error status, etc
+                        })
+}
 ```
 
 ### Extending itty router
@@ -435,7 +452,7 @@ const router = Router<Request, IMethods>() // Valid
 const router = Router<void, IMethods>() // Valid
 ```
 
-The router will also accept any string as a method, not just those provided on the `TMethods` type. 
+The router will also accept any string as a method, not just those provided on the `TMethods` type.
 
 ```ts
 import { Router, Route } from 'itty-router'
@@ -490,36 +507,38 @@ router.puppy('/', request => {}) // Strongly typed
 
 ### The Entire Code (for more legibility, [see src on GitHub](https://github.com/kwhitley/itty-router/blob/v2.x/src/itty-router.js))
 ```js
-const Router = ({ base = '', routes = [] } = {}) => ({
-  __proto__: new Proxy({}, {
-    get: (t, k, c) => (p, ...H) =>
-      routes.push([
-        k.toUpperCase(),
-        RegExp(`^${(base + p)
-          .replace(/(\/?)\*/g, '($1.*)?')
-          .replace(/\/$/, '')
-          .replace(/:(\w+)(\?)?(\.)?/g, '$2(?<$1>[^/]+)$2$3')
-          .replace(/\.(?=[\w(])/, '\\.')
-          .replace(/\)\.\?\(([^\[]+)\[\^/g, '?)\\.?($1(?<=\\.)[^\\.')
-        }/*$`),
-        H,
-      ]) && c
-  }),
-  routes,
-  async handle (q, ...a) {
-    let s, m,
-        u = new URL(q.url)
-    q.query = Object.fromEntries(u.searchParams)
-    for (let [M, p, H] of routes) {
-      if ((M === q.method || M === 'ALL') && (m = u.pathname.match(p))) {
-        q.params = m.groups
-        for (let h of H) {
-          if ((s = await h(q.proxy || q, ...a)) !== undefined) return s
+function Router({ base = '', routes = [] } = {}) {
+  return {
+    __proto__: new Proxy({}, {
+      get: (t, k, c) => (p, ...H) =>
+        routes.push([
+          k.toUpperCase(),
+          RegExp(`^${(base + p)
+            .replace(/(\/?)\*/g, '($1.*)?')
+            .replace(/\/$/, '')
+            .replace(/:(\w+)(\?)?(\.)?/g, '$2(?<$1>[^/]+)$2$3')
+            .replace(/\.(?=[\w(])/, '\\.')
+            .replace(/\)\.\?\(([^\[]+)\[\^/g, '?)\\.?($1(?<=\\.)[^\\.') // RIP all the bytes lost :'(
+          }/*$`),
+          H,
+        ]) && c
+    }),
+    routes,
+    async handle (q, ...a) {
+      let s, m,
+          u = new URL(q.url)
+      q.query = Object.fromEntries(u.searchParams)
+      for (let [M, p, H] of routes) {
+        if ((M === q.method || M === 'ALL') && (m = u.pathname.match(p))) {
+          q.params = m.groups
+          for (let h of H) {
+            if ((s = await h(q.proxy || q, ...a)) !== undefined) return s
+          }
         }
       }
     }
   }
-})
+}
 ```
 
 ## Special Thanks
@@ -558,4 +577,8 @@ These folks are the real heroes, making open source the powerhouse that it is!
 - [@technoyes](https://github.com/technoyes) - three kind-of-a-big-deal errors fixed.  Imagine the look on my face... thanks man!! :)
 - [@roojay520](https://github.com/roojay520) - TS interface fixes
 #### Documentation
-- [@arunsathiya](https://github.com/arunsathiya), [@poacher2k](https://github.com/poacher2k), [@ddarkr](https://github.com/ddarkr), [@kclauson](https://github.com/kclauson)
+- [@arunsathiya](https://github.com/arunsathiya),
+  [@poacher2k](https://github.com/poacher2k),
+  [@ddarkr](https://github.com/ddarkr),
+  [@kclauson](https://github.com/kclauson),
+  [@jcapogna](https://github.com/jcapogna)

package/dist/itty-router.d.ts

@@ -42,7 +42,7 @@ export interface IHTTPMethods {
 }
 
 export type Router<TRequest = Request, TMethods = {}> = {
-  handle: (request: TRequest, ...extra: any) => any
+  handle: (request: TRequest, ...extra: any) => Promise<any>
   routes: RouteEntry<TRequest>[]
   all: Route
 } & TMethods & {

package/dist/itty-router.min.js

@@ -1 +1 @@
-module.exports={Router:({base:p="",routes:u=[]}={})=>({__proto__:new Proxy({},{get:(e,a,o)=>(e,...r)=>u.push([a.toUpperCase(),RegExp(`^${(p+e).replace(/(\/?)\*/g,"($1.*)?").replace(/\/$/,"").replace(/:(\w+)(\?)?(\.)?/g,"$2(?<$1>[^/]+)$2$3").replace(/\.(?=[\w(])/,"\\.").replace(/\)\.\?\(([^\[]+)\[\^/g,"?)\\.?($1(?<=\\.)[^\\.")}/*$`),r])&&o}),routes:u,async handle(e,...r){let a,o,p=new URL(e.url);e.query=Object.fromEntries(p.searchParams);for(var[t,s,c]of u)if((t===e.method||"ALL"===t)&&(o=p.pathname.match(s))){e.params=o.groups;for(var l of c)if(void 0!==(a=await l(e.proxy||e,...r)))return a}}})};
+module.exports={Router:function({base:t="",routes:n=[]}={}){return{__proto__:new Proxy({},{get:(e,a,o)=>(e,...r)=>n.push([a.toUpperCase(),RegExp(`^${(t+e).replace(/(\/?)\*/g,"($1.*)?").replace(/\/$/,"").replace(/:(\w+)(\?)?(\.)?/g,"$2(?<$1>[^/]+)$2$3").replace(/\.(?=[\w(])/,"\\.").replace(/\)\.\?\(([^\[]+)\[\^/g,"?)\\.?($1(?<=\\.)[^\\.")}/*$`),r])&&o}),routes:n,async handle(e,...r){let a,o,t=new URL(e.url);e.query=Object.fromEntries(t.searchParams);for(var[p,s,u]of n)if((p===e.method||"ALL"===p)&&(o=t.pathname.match(s))){e.params=o.groups;for(var c of u)if(void 0!==(a=await c(e.proxy||e,...r)))return a}}}}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-router",
-  "version": "2.5.0",
+  "version": "2.5.3",
   "description": "Tiny, zero-dependency router with route param and query parsing - built for Cloudflare Workers, but works everywhere!",
   "main": "./dist/itty-router.min.js",
   "types": "./dist/itty-router.d.ts",
@@ -62,20 +62,19 @@
   },
   "homepage": "https://itty-router.dev",
   "devDependencies": {
-    "@vitejs/plugin-vue": "^1.4.0",
-    "@vue/compiler-sfc": "^3.2.2",
-    "chalk": "^4.1.2",
+    "@vitejs/plugin-vue": "^2.2.4",
+    "@vue/compiler-sfc": "^3.2.31",
     "coveralls": "^3.1.1",
-    "eslint": "^7.32.0",
-    "eslint-plugin-jest": "^24.4.0",
-    "fs-extra": "^10.0.0",
+    "eslint": "^8.11.0",
+    "eslint-plugin-jest": "^26.1.2",
+    "fs-extra": "^10.0.1",
     "gzip-size": "^6.0.0",
     "isomorphic-fetch": "^3.0.0",
-    "jest": "^27.0.6",
+    "jest": "^27.5.1",
     "rimraf": "^3.0.2",
-    "uglify-js": "^3.14.1",
-    "vite": "^2.4.4",
-    "yarn": "^1.22.11",
+    "uglify-js": "^3.15.3",
+    "vite": "^2.8.6",
+    "yarn": "^1.22.18",
     "yarn-release": "^1.10.3"
   }
 }