DRAFT: "AutoRouter" to reduce router initialization boilerplate

.github/workflows/coveralls.yml

@@ -9,10 +9,10 @@ jobs:
     steps:
       - uses: actions/checkout@v1
 
-      - name: Use Node.js 16.x
+      - name: Use Node.js 20.10.0
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 20.10.0
 
       - name: npm install, npm run coverage
         run: |

.github/workflows/lint.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: '16.x'
+          node-version: '20.10.0'
       - name: Install dependencies
         run: yarn
       - run: yarn lint

.github/workflows/verify.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: '16.x'
+          node-version: '20.10.0'
       - name: Install dependencies
         run: yarn
       - run: yarn verify

CHANGELOG.md

@@ -3,6 +3,11 @@
 - **v4.1.0**
   - added: `HasContent<ContentType>` type to `withContent` (credit [@alexrosenfeld10](https://github.com/alexrosenfeld10))
   - added: Adds basic text/formData support to supplement the native JSON support of `withContent`
+  - added: `origin` in `CorsOptions` now can accept a function (credit [@leaysgur])
+  - added: `CorsOptions` now exported from `createCors`
+  - added: `flow(router)` to reduce initilization boilerplate
+  - fixed: `createCors()` now correctly defaults to all methods "*" unless specified, not just GET
+  - added: router generics have now been overhauled to allow greater flexibility (may use router-level and route-level together)
 - **v4.0.00** - Partial changelog below
   - BREAKING: heavy TS rewrite for core Router (thank you, ChatGPT)
   - added: nearly all extras from itty-router-extras

example/bun-flow-advanced.ts

@@ -0,0 +1,37 @@
+// WITH FLOW (overriding options, and enabling CORS)
+import { Router, error, flow } from '../src'
+import { IRequest, IRequestStrict } from '../src'
+
+type Env = {
+  KV: object
+}
+
+type CustomRequest = {
+  foo: string
+} & IRequestStrict
+
+type RouterArgs = [env: Env]
+
+const router = Router()
+
+router
+  .all('*', (request) => { request.start = Date.now() })
+  .get('/test', () => 'Success!')
+  .get('/foo/:bar/:baz?', ({ bar, baz }) => ({ bar, baz }))
+
+export default flow(router, {
+  before: (request) => request.start = Date.now(),
+  after: (response, request) => {
+    const { method, start } = request
+    const { status } = response
+    const duration = Date.now() - start
+    const url = new URL(request.url)
+    console.log(`${status} ${method} ${url.pathname+(url.search || '')} - ${duration}ms`)
+  },
+  cors: true,
+  notFound: () => error(404, 'Are you sure about that?'),
+})
+
+const flowed = flow(router)
+
+flowed.fetch()

example/bun-flow.ts

@@ -0,0 +1,6 @@
+import { Router, flow } from '../src'
+
+const app = Router()
+app.get('/', () => 'Hello Itty!')
+
+export default flow(app)

example/bun.ts

@@ -1,4 +1,5 @@
-import { Router, error, json, withParams } from '../dist/index.js'
+// WITHOUT FLOW
+import { IRequest, Router, error, json, withParams } from 'itty-router'
 
 const router = Router()
 
@@ -10,6 +11,8 @@ router
 
 export default {
   port: 3001,
-  fetch: (request, env, ctx) =>
-    router.handle(request, env, ctx).then(json).catch(error),
+  fetch: (request: IRequest) => router
+                                  .handle(request)
+                                  .then(json)
+                                  .catch(error),
 }

example/e2e middleware.ts

@@ -0,0 +1,32 @@
+import { IRequest, IRequestStrict, Router } from 'Router'
+
+type HasFoo = {
+  foo: string
+} & IRequestStrict
+
+type HasBar = {
+  bar: string
+} & IRequestStrict
+
+const router = Router()
+
+// MIDDLEWARE: adds foo to the request
+const withFoo = (request: HasFoo) => {
+  request.foo = 'bar' // no return = next handler gets fired (making this middleware)
+}
+
+// MIDDLEWARE: adds foo to the request
+const withBar = (request: HasBar) => {
+  request.bar = 'baz' // no return = next handler gets fired (making this middleware)
+}
+
+// ADD ROUTES
+router
+  .all<HasFoo & HasBar>('*', withFoo, withBar, (request) => {
+    request.bar // this can be infered
+    request.foo // this can be infered
+  })
+
+  .get('/', withFoo, withBar, (request) => {
+    return request
+  })

example/universal-vs-overrides.ts

@@ -0,0 +1,50 @@
+// WITH FLOW (overriding options, and enabling CORS)
+import { Router, error, flow } from '../src'
+import { IRequest, IRequestStrict } from '../src'
+
+type Env = {
+  KV: object
+}
+
+type CustomRequest = {
+  foo: string
+} & IRequestStrict
+
+type RouterArgs = [env: Env]
+type RouterArgs2 = [env: Env, ctx: ExecutionContext]
+
+const universalRouter =
+  Router<CustomRequest, RouterArgs>()
+    .get('/type-check', (request, env) => {
+      request.foo // should be found
+      env.KV // should be found
+      env.KB // should NOT be found
+    })
+    .get<IRequestStrict>('/type-check', (request, env) => {
+      request.foo // should NOT be found
+      env.KV // should be found
+      env.KB // should NOT be found
+    })
+    .puppy('/type-check', (request, env) => {
+      request.foo // should be found
+      env.KV // should be found
+      env.KB // should NOT be found
+    })
+    .puppy<CustomRequest, RouterArgs2>('/type-check', (request, env) => {
+      request.foo // should be found
+      env.KV // should be found
+      env.KB // should NOT be found
+    })
+
+// Router without generics will use IRequest by default
+const overrideRouter =
+  Router()
+    .get('/type-check', (request, env, ctx) => {
+      request.whatever // should ignore
+      env.whatever // should ignore
+      ctx.whatever // should ignore
+    })
+    .get<IRequestStrict, RouterArgs2>('/type-check', (request, env, ctx) => {
+      request.foo // should NOT be found
+      ctx.waitUntil // should infer
+    })