V5 types fix (#230)

* fixed some missing types in 5.0.0 * router matchup fixed? * moved folder * CHANGELOG * ts-ignore added back in * released v5.0.2 - types fix in rotuer
kwhitley · Mar 29, 2024 · cc8bea8 · cc8bea8
1 parent 89f5dd7
commit cc8bea8
Show file tree

Hide file tree

Showing 30 changed files with 64 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 ## Changelog
 
+- **v5.0.2**
+  - fixed: AutoRouter was missing the router-level generics support of the other 2 routers.
+  - fixed: All 3 routers had their 3rd generic argument, ResponseType added per the spec.
 - **v5.0.0**
   - BREAKING: router.fetch replaces router.handle (now deprecated)
   - BREAKING: "createCors" has been deprecated in favor of "cors" (new options & requirements)

diff --git a/example/bun-autorouter-advanced.ts → examples/bun-autorouter-advanced.ts b/example/bun-autorouter-advanced.ts → examples/bun-autorouter-advanced.ts
diff --git a/example/bun-autorouter.ts → examples/bun-autorouter.ts b/example/bun-autorouter.ts → examples/bun-autorouter.ts
diff --git a/example/bun-router.ts → examples/bun-router.ts b/example/bun-router.ts → examples/bun-router.ts
diff --git a/example/bun.ts → examples/bun.ts b/example/bun.ts → examples/bun.ts
diff --git a/example/cors-types.ts → examples/cors-types.ts b/example/cors-types.ts → examples/cors-types.ts
diff --git a/example/custom-router-props.ts → examples/custom-router-props.ts b/example/custom-router-props.ts → examples/custom-router-props.ts
diff --git a/example/index.ts → examples/index.ts b/example/index.ts → examples/index.ts
diff --git a/example/node-import.js → examples/node-import.js b/example/node-import.js → examples/node-import.js
diff --git a/example/node-require.js → examples/node-require.js b/example/node-require.js → examples/node-require.js
diff --git a/example/request-types.ts → examples/request-types.ts b/example/request-types.ts → examples/request-types.ts
diff --git a/examples/router-matchup.ts b/examples/router-matchup.ts
@@ -0,0 +1,28 @@
+import { AutoRouter } from 'AutoRouter'
+import { IttyRouter } from 'IttyRouter'
+import { Router } from 'Router'
+import { IRequest } from 'types'
+
+// setup
+type FooResponse = { foo: string }
+const request = new Request('https://foo.bar')
+
+// test
+const autorouter = AutoRouter<IRequest, [], FooResponse>()
+const router = Router<IRequest, [], FooResponse>()
+const ittyrouter = IttyRouter<IRequest, [], FooResponse>()
+
+// test getters
+autorouter.get('/throw', (a) => a.b.c)
+router.get('/throw', (a) => a.b.c)
+ittyrouter.get('/throw', (a) => a.b.c)
+
+// autorouter tests
+autorouter.missing
+autorouter.format
+
+// test response formatting
+const autorouterResponse = (await autorouter.fetch(request)).foo
+const routerResponse = (await router.fetch(request)).foo
+const ittyrouterResponse = (await ittyrouter.fetch(request)).foo
+
diff --git a/example/runtimes/bun.ts → examples/runtimes/bun.ts b/example/runtimes/bun.ts → examples/runtimes/bun.ts
diff --git a/example/runtimes/express.js → examples/runtimes/express.js b/example/runtimes/express.js → examples/runtimes/express.js
diff --git a/example/runtimes/node.js → examples/runtimes/node.js b/example/runtimes/node.js → examples/runtimes/node.js
diff --git a/example/types/content.ts → examples/types/content.ts b/example/types/content.ts → examples/types/content.ts
diff --git a/example/types/extra-props.ts → examples/types/extra-props.ts b/example/types/extra-props.ts → examples/types/extra-props.ts
diff --git a/...e/types/global-and-route-level-request.ts → ...s/types/global-and-route-level-request.ts b/...e/types/global-and-route-level-request.ts → ...s/types/global-and-route-level-request.ts
diff --git a/example/types/global-request.ts → examples/types/global-request.ts b/example/types/global-request.ts → examples/types/global-request.ts
diff --git a/example/types/middleware.ts → examples/types/middleware.ts b/example/types/middleware.ts → examples/types/middleware.ts
diff --git a/example/types/requestlike.ts → examples/types/requestlike.ts b/example/types/requestlike.ts → examples/types/requestlike.ts
diff --git a/example/types/route-level-request.ts → examples/types/route-level-request.ts b/example/types/route-level-request.ts → examples/types/route-level-request.ts
diff --git a/example/types/router.ts → examples/types/router.ts b/example/types/router.ts → examples/types/router.ts
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "itty-router",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "description": "A tiny, zero-dependency router, designed to make beautiful APIs in any environment.",
   "main": "./index.js",
   "module": "./index.mjs",

diff --git a/src/AutoRouter.ts b/src/AutoRouter.ts
@@ -1,16 +1,20 @@
 import { Router } from './Router'
 import { error } from './error'
 import { json } from './json'
-import { AutoRouterOptions } from './types'
+import { AutoRouterOptions, AutoRouterType, IRequest } from './types'
 import { withParams } from './withParams'
 
-export const AutoRouter = ({
+export const AutoRouter = <
+  RequestType extends IRequest = IRequest,
+  Args extends any[] = any[],
+  ResponseType = any
+>({
   format = json,
   missing = () => error(404),
   finally: f = [],
   before = [],
   ...options }: AutoRouterOptions = {}
-) => Router({
+): AutoRouterType<RequestType, Args, ResponseType> => Router({
   before: [
     withParams,
     ...before

diff --git a/src/IttyRouter.ts b/src/IttyRouter.ts
@@ -8,8 +8,9 @@ import {
 
 export const IttyRouter = <
   RequestType extends IRequest = IRequest,
-  Args extends any[] = any[]
->({ base = '', routes = [], ...other }: IttyRouterOptions = {}): IttyRouterType<RequestType, Args> =>
+  Args extends any[] = any[],
+  ResponseType = any
+>({ base = '', routes = [], ...other }: IttyRouterOptions = {}): IttyRouterType<RequestType, Args, ResponseType> =>
   ({
     __proto__: new Proxy({}, {
       // @ts-expect-error (we're adding an expected prop "path" to the get)

diff --git a/src/Router.ts b/src/Router.ts
@@ -8,8 +8,9 @@ import {
 
 export const Router = <
   RequestType = IRequest,
-  Args extends any[] = any[]
->({ base = '', routes = [], ...other }: RouterOptions = {}): RouterType<RequestType, Args> =>
+  Args extends any[] = any[],
+  ResponseType = any
+>({ base = '', routes = [], ...other }: RouterOptions = {}): RouterType<RequestType, Args, ResponseType> =>
   ({
     __proto__: new Proxy({}, {
       // @ts-expect-error (we're adding an expected prop "path" to the get)

diff --git a/src/types.ts b/src/types.ts
@@ -1,5 +1,6 @@
 // routers
 export * from './types/AutoRouterOptions'
+export * from './types/AutoRouterType'
 export * from './types/CustomRoutes'
 export * from './types/ErrorHandler'
 export * from './types/IRequest'

diff --git a/src/types/AutoRouterType.ts b/src/types/AutoRouterType.ts
@@ -0,0 +1,13 @@
+import { IRequest } from './IRequest'
+import { RequestHandler } from './RequestHandler'
+import { ResponseHandler } from './ResponseHandler'
+import { RouterType } from './RouterType'
+
+export type AutoRouterType<
+  R = IRequest,
+  Args extends any[] = any[],
+  ResponseType = any
+> = {
+  missing?: RequestHandler
+  format?: ResponseHandler
+} & RouterType<R, Args, ResponseType>
diff --git a/src/types/IttyRouterType.ts b/src/types/IttyRouterType.ts
@@ -5,7 +5,11 @@ import { Route } from './Route'
 import { RouteEntry } from './RouteEntry'
 import { CustomRoutes } from './CustomRoutes'
 
-export type IttyRouterType<R = IRequest, A extends any[] = any[], ResponseType = any> = {
+export type IttyRouterType<
+  R = IRequest,
+  A extends any[] = any[],
+  ResponseType = any
+> = {
   __proto__: IttyRouterType<R>
   routes: RouteEntry[]
   fetch: <Args extends any[] = A>(request: RequestLike, ...extra: Args) => Promise<ResponseType>