itty-router 2.5.2 → 2.6.1

package/CHANGELOG.md

@@ -3,6 +3,9 @@ Until this library makes it to a production release of v1.x, **minor versions ma
 
 [@SupremeTechnopriest)(https://github.com/SupremeTechnopriest) - improved TypeScript support and documentation! :D\
 
+- **v2.6.1** - fixes named export in ESM/mjs export
+- **v2.6.0** - package now is hybrid export, supporting both ESM (.mjs) and CJS (.js) minified versions
+- **v2.5.3** - corrects type for router.handle to return Promise<any>
 - **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)!)

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({
@@ -301,7 +301,7 @@ export default {
 export default {
   fetch: (...args) => router
                         .handle(...args)
-                        .then(response =>
+                        .then(response => {
                           // can modify response here before final return, e.g. CORS headers
 
                           return response
@@ -505,42 +505,6 @@ router.puppy('/', request => {}) // Strongly typed
 1. Submit PR with a detailed description of what you're doing
 1. I'll add you to the credits! :)
 
-### The Entire Code (for more legibility, [see src on GitHub](https://github.com/kwhitley/itty-router/blob/v2.x/src/itty-router.js))
-```js
-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
 This repo goes out to my past and present colleagues at Arundo - who have brought me such inspiration, fun,
 and drive over the last couple years.  In particular, the absurd brevity of this code is thanks to a

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.mjs

@@ -0,0 +1 @@
+function e({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}}}}export default{Router:e};export{e as Router};

package/package.json

@@ -1,13 +1,21 @@
 {
   "name": "itty-router",
-  "version": "2.5.2",
+  "version": "2.6.1",
   "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",
+  "sourceType": "module",
   "files": [
     "dist/itty-router.min.js",
+    "dist/itty-router.min.mjs",
     "dist/itty-router.d.ts"
   ],
+  "main": "./dist/itty-router.min.js",
+  "exports": {
+    ".": {
+      "require": "./dist/itty-router.min.js",
+      "import": "./dist/itty-router.min.mjs"
+    }
+  },
+  "types": "./dist/itty-router.d.ts",
   "keywords": [
     "router",
     "cloudflare",
@@ -47,7 +55,11 @@
     "coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls",
     "prerelease": "yarn verify",
     "prebuild": "rimraf dist && mkdir dist && node prebuild.js && cp src/itty-router.d.ts dist",
-    "build": "uglifyjs dist/itty-router.js -c -m --toplevel > dist/itty-router.min.js",
+    "build": "yarn uglify",
+    "uglify": "yarn uglify:cjs && yarn uglify:esm",
+    "uglify:esm": "uglifyjs dist/itty-router.mjs -c -m --toplevel > dist/itty-router.min.mjs",
+    "uglify:cjs": "uglifyjs src/itty-router.js -c -m --toplevel > dist/itty-router.min.js",
+    "build:esm": "esbuild src/itty-router.js --format=esm --outfile=./dist/itty-router.mjs",
     "postbuild": "node check-size.js",
     "release": "release --tag --push"
   },
@@ -62,20 +74,20 @@
   },
   "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",
     "coveralls": "^3.1.1",
-    "eslint": "^7.32.0",
-    "eslint-plugin-jest": "^24.4.0",
-    "fs-extra": "^10.0.0",
+    "esbuild": "^0.14.27",
+    "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",
+    "vue": "^3.2.31",
+    "yarn": "^1.22.18",
     "yarn-release": "^1.10.3"
   }
 }