Merge edc6221 into 39e75bd

example/types/content.ts

@@ -0,0 +1,22 @@
+import { IRequestStrict, IRequest, RequestHandler } from 'types'
+import { IttyRouter } from 'IttyRouter'
+import { withContent } from 'withContent'
+import { HasContent } from 'types'
+
+type User = {
+  user: string
+}
+
+const router = IttyRouter()
+
+router
+  // upstream request sees the request as IRequest (default), so anything goes
+  .post<HasContent<User>>('/', withContent, ({ content }) => {
+    content.user
+  })
+
+  .get('/pollution', (request) => {
+    request.content.user
+  })
+
+export default router

example/types/extra-props.ts

@@ -0,0 +1,13 @@
+import { IRequestStrict, IRequest, RequestHandler } from 'types'
+import { IttyRouter } from 'IttyRouter'
+import { withContent } from 'withContent'
+import { HasContent } from 'types'
+
+const router = IttyRouter({
+  port: 3000,
+})
+
+router.port = 4000
+router.port.toLowerCase()
+router.puppy() // should not be typed... RIP
+

example/types/middleware.ts

@@ -1,4 +1,5 @@
-import { IRequestStrict, IRequest, IttyRouter, RequestHandler } from 'IttyRouter'
+import { IRequestStrict, IRequest, RequestHandler } from '../../src/types'
+import { IttyRouter } from 'IttyRouter'
 
 type UserRequest = {
   user: string

example/types/requestlike.ts

@@ -0,0 +1,11 @@
+import { IttyRouter } from 'IttyRouter'
+
+const router = IttyRouter()
+
+const request = new Request('https://foo.bar')
+
+router.fetch(request) // should be OK
+router.fetch({ method: 'GET', url: 'foo' }) // should be OK
+router.fetch({ method: 'GET' }) // should NOT be OK
+
+

example/types/router.ts

@@ -0,0 +1,8 @@
+import { Router } from 'Router'
+
+const router = Router({
+  port: 4000,
+  before: [],
+})
+
+router.finally = () => {} // should NOT work

package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-router",
-  "version": "4.3.0-next.4",
+  "version": "5.0.0-next.2",
   "description": "A tiny, zero-dependency router, designed to make beautiful APIs in any environment.",
   "main": "./index.js",
   "module": "./index.mjs",

rollup.config.mjs

@@ -7,7 +7,7 @@ import fs from 'fs-extra'
 
 // scan files to build
 const files = (await globby('./src/*.ts', {
-  ignore: ['**/*.spec.ts', 'example'],
+  ignore: ['**/*.spec.ts', 'example', '**/types.ts'],
 })).map(path => ({
   path,
   shortPath: path.replace(/(\/src)|(\.ts)/g, '').replace('./index', '.'),

src/AutoRouter.ts

@@ -1,15 +1,9 @@
-import { RequestHandler } from 'IttyRouter'
-import { ResponseHandler, Router, RouterOptions } from './Router'
+import { Router } from './Router'
 import { error } from './error'
 import { json } from './json'
+import { AutoRouterOptions } from './types'
 import { withParams } from './withParams'
 
-type AutoRouterOptions = {
-  missing?: RequestHandler
-  format?: ResponseHandler
-} & RouterOptions
-
-// MORE FINE-GRAINED/SIMPLIFIED CONTROL, BUT CANNOT FULLY REPLACE BEFORE/FINALLY STAGES
 export const AutoRouter = ({
   format = json,
   missing = () => error(404),
@@ -29,14 +23,3 @@ export const AutoRouter = ({
   ],
   ...options,
 })
-
-// LESS FINE-GRAINED CONTROL, BUT CAN COMPLETELY REPLACE BEFORE/FINALLY STAGES
-// export const AutoRouter2 = ({ ...options }: RouterOptions = {}) => Router({
-//   before: [withParams],
-//   onError: [error],
-//   finally: [
-//     (r: any) => r ?? error(404),
-//     json,
-//   ],
-//   ...options,
-// })

src/IttyRouter.ts

@@ -1,63 +1,10 @@
-export type GenericTraps = Record<string, any>
-
-export type RequestLike = {
-  method: string
-  url: string
-} & GenericTraps
-
-export type IRequestStrict = {
-  method: string
-  url: string
-  route: string
-  params: {
-    [key: string]: string
-  }
-  query: {
-    [key: string]: string | string[] | undefined
-  }
-  proxy?: any
-} & Request
-
-export type IRequest = IRequestStrict & GenericTraps
-
-export type IttyRouterOptions = {
-  base?: string
-  routes?: RouteEntry[]
-} & Record<string, any>
-
-export type RequestHandler<R = IRequest, Args extends Array<any> = any[]> =
-  (request: R, ...args: Args) => any
-
-export type RouteEntry = [
-  httpMethod: string,
-  match: RegExp,
-  handlers: RequestHandler[],
-  path?: string,
-]
-
-// this is the generic "Route", which allows per-route overrides
-export type Route<R = IRequest, A extends Array<any> = any[]> = <RequestType = R, Args extends Array<any> = A>(
-  path: string,
-  ...handlers: RequestHandler<RequestType, Args>[]
-) => IttyRouterType<RequestType, Args>
-
-export type CustomRoutes<R = Route> = {
-  [key: string]: R
-}
-
-export type IttyRouterType<R = IRequest, A extends any[] = any[], Output = any> = {
-  __proto__: IttyRouterType<R>
-  routes: RouteEntry[]
-  fetch: <Args extends any[] = A>(request: RequestLike, ...extra: Args) => Promise<Output>
-  all: Route<R, A>
-  delete: Route<R, A>
-  get: Route<R, A>
-  head: Route<R, A>
-  options: Route<R, A>
-  patch: Route<R, A>
-  post: Route<R, A>
-  put: Route<R, A>
-} & CustomRoutes<Route<R, A>>
+import {
+  IRequest,
+  IttyRouterOptions,
+  IttyRouterType,
+  RequestHandler,
+  RequestLike,
+} from './types'
 
 export const IttyRouter = <
   RequestType extends IRequest = IRequest,
@@ -78,7 +25,7 @@ export const IttyRouter = <
                 .replace(/\./g, '\\.')                              // dot in path
                 .replace(/(\/?)\*/g, '($1.*)?')                     // wildcard
               }/*$`),
-              // @ts-expect-error - fiddly
+              // @ts-ignore
               handlers,                                             // embed handlers
               path,                                                 // embed clean route path
             ]

src/Router.ts

@@ -1,28 +1,10 @@
 import {
   IRequest,
-  IttyRouterOptions,
-  IttyRouterType,
   RequestHandler,
-  RequestLike
-} from './IttyRouter'
-
-export type ResponseHandler<ResponseType = Response, RequestType = IRequest, Args extends any[] = any[]> =
-    (response: ResponseType & any, request: RequestType & any, ...args: Args) => any
-
-export type ErrorHandler<ErrorType = Error, RequestType = IRequest, Args extends any[] = any[]> =
-    (response: ErrorType, request: RequestType, ...args: Args) => any
-
-export type RouterType<R = IRequest, Args extends any[] = any[]> = {
-  before?: RequestHandler<any>[]
-  catch?: ErrorHandler
-  finally?: ResponseHandler[]
-} & IttyRouterType<R, Args>
-
-export type RouterOptions = {
-  before?: RequestHandler<any>[]
-  catch?: ErrorHandler
-  finally?: ResponseHandler[]
-} & IttyRouterOptions
+  RequestLike,
+  RouterOptions,
+  RouterType
+} from './types'
 
 export const Router = <
   RequestType = IRequest,
@@ -43,7 +25,7 @@ export const Router = <
                 .replace(/\./g, '\\.')                              // dot in path
                 .replace(/(\/?)\*/g, '($1.*)?')                     // wildcard
               }/*$`),
-              // @ts-expect-error - fiddly
+              // @ts-ignore
               handlers,                                             // embed handlers
               path,                                                 // embed clean route path
             ]

src/cors.ts

@@ -1,4 +1,4 @@
-import { IRequest } from 'IttyRouter'
+import { IRequest } from './types'
 
 export type CorsOptions = {
   credentials?: true

src/createResponse.ts

@@ -1,15 +1,9 @@
-export interface ResponseFormatter {
-  (body?: any, options?: ResponseInit): Response
-}
-
-export interface BodyTransformer {
-  (body: any): string
-}
+import { ResponseFormatter } from './types'
 
  export const createResponse =
   (
     format = 'text/plain; charset=utf-8',
-    transform?: BodyTransformer
+    transform?: (body: any) => any,
   ): ResponseFormatter =>
   (body, { ...options } = {}) => {
     if (body === undefined || body instanceof Response) return body

src/error.ts

@@ -1,16 +1,5 @@
 import { json } from './json'
-
-interface ErrorLike extends Error {
-  status?: number
-  [any: string]: any
-}
-
-export type ErrorBody = string | object
-
-export interface ErrorFormatter {
-  (statusCode?: number, body?: ErrorBody): Response
-  (error: ErrorLike): Response
-}
+import { ErrorFormatter } from './types'
 
 const getMessage = (code: number): string => ({
   400: 'Bad Request',
@@ -20,7 +9,7 @@ const getMessage = (code: number): string => ({
   500: 'Internal Server Error',
 })[code] || 'Unknown Error'
 
-export const error: ErrorFormatter = (a = 500, b?: ErrorBody) => {
+export const error: ErrorFormatter = (a = 500, b?) => {
   // handle passing an Error | StatusError directly in
   if (a instanceof Error) {
     const { message, ...err } = a

src/index.ts

@@ -26,3 +26,6 @@ export * from './withParams'
 
 // CORS
 export * from './cors'
+
+// TYPES
+export * from './types'

src/types.ts

@@ -0,0 +1,26 @@
+// routers
+export * from './types/AutoRouterOptions'
+export * from './types/CustomRoutes'
+export * from './types/ErrorHandler'
+export * from './types/IRequest'
+export * from './types/IRequestStrict'
+export * from './types/IttyRouterOptions'
+export * from './types/IttyRouterType'
+export * from './types/RequestHandler'
+export * from './types/ResponseHandler'
+export * from './types/RequestLike'
+export * from './types/ResponseHandler'
+export * from './types/Route'
+export * from './types/RouteEntry'
+export * from './types/RouterOptions'
+export * from './types/RouterType'
+
+// withContent
+export * from './types/HasContent'
+
+// createResponse
+export * from './types/ResponseFormatter'
+
+// errors
+export * from './types/ErrorFormatter'
+

src/types/AutoRouterOptions.ts

@@ -0,0 +1,8 @@
+import { RequestHandler } from './RequestHandler'
+import { ResponseHandler } from './ResponseHandler'
+import { RouterOptions } from './RouterOptions'
+
+export type AutoRouterOptions = {
+  missing?: RequestHandler
+  format?: ResponseHandler
+} & RouterOptions

src/types/CustomRoutes.ts

@@ -0,0 +1,5 @@
+import { Route } from './Route'
+
+export type CustomRoutes<R = Route> = {
+  [key: string]: R
+}

src/types/ErrorFormatter.ts

@@ -0,0 +1,11 @@
+interface ErrorLike extends Error {
+  status?: number
+  [any: string]: any
+}
+
+type ErrorBody = string | object
+
+export interface ErrorFormatter {
+  (statusCode?: number, body?: ErrorBody): Response
+  (error: ErrorLike): Response
+}

src/types/ErrorHandler.ts

@@ -0,0 +1,7 @@
+import { StatusError } from '../StatusError'
+import { IRequest } from './IRequest'
+
+export type ErrorHandler<
+  ErrorType extends Error = StatusError,
+  RequestType = IRequest, Args extends any[] = any[]
+> = (error: ErrorType, request: RequestType, ...args: Args) => any

src/types/GenericTraps.ts

@@ -0,0 +1 @@
+export type GenericTraps = Record<string, any>

src/types/HasContent.ts

@@ -0,0 +1,5 @@
+import { IRequestStrict } from './IRequestStrict'
+
+export type HasContent<ContentType> = {
+  content: ContentType
+} & IRequestStrict

src/types/IRequest.ts

@@ -0,0 +1,4 @@
+import { GenericTraps } from './GenericTraps'
+import { IRequestStrict } from './IRequestStrict'
+
+export type IRequest = IRequestStrict & GenericTraps

src/types/IRequestStrict.ts

@@ -0,0 +1,10 @@
+export type IRequestStrict = {
+  route: string
+  params: {
+    [key: string]: string
+  }
+  query: {
+    [key: string]: string | string[] | undefined
+  }
+  proxy?: any
+} & Request

src/types/IttyRouterOptions.ts

@@ -0,0 +1,7 @@
+import { GenericTraps } from './GenericTraps'
+import { RouteEntry } from './RouteEntry'
+
+export type IttyRouterOptions = {
+  base?: string
+  routes?: RouteEntry[]
+} & GenericTraps