itty-router 5.0.0 → 5.0.1

package/example/request-types.ts

@@ -1,101 +0,0 @@
-import { IRequest, IRequestStrict, IttyRouter } from '../src/IttyRouter'
-
-type FooRequest = {
-  foo: string
-} & IRequest
-
-// extends IRequestStrict, meaning no undefined attributes off Request
-type BarRequest = {
-  bar: number
-} & IRequestStrict
-
-type Env = {
-  KV: string
-}
-
-type CF = [env: Env, ctx: ExecutionContext]
-
-// this router defines a global signature of <BarRequest, CF>
-const custom = IttyRouter<BarRequest, CF>()
-
-custom
-  .get('/', ({ bar, json }) => {
-    console.log('bar', bar)
-  })
-
-  // should not be able to access request.foo
-  .get('/foo/:bar', (request, env, ctx) => {
-    request.params
-    request.bar
-    request.foo
-    env.KV
-    ctx.waitUntil
-  })
-
-  .get<FooRequest>('/', (request) => {
-    request.foo // found in FooRequest override
-  })
-
-const router = IttyRouter({ base: '/' })
-
-router
-  // call custom HTTP method
-  .puppy('/cat/:id', (request) => {
-    // supports standard Request by default
-    request.headers // valid
-    request.foo // valid (generic traps)
-  })
-  .puppy<IRequestStrict>('/cat/:id', (request) => {
-    // supports standard Request by default
-    request.headers // valid
-    request.foo // invalid
-  })
-
-  // standard request
-  .get('*', (request, env: Env, ctx: ExecutionContext) => {
-    request.url
-    env.KV
-    ctx.waitUntil
-  })
-
-  // custom request from handler argument
-  .get('*', (request: FooRequest) => {
-    request.foo
-  })
-
-  // custom request from handler argument
-  .get('*', (request: BarRequest) => {
-    request.bar
-  })
-
-  // custom request from handler argument
-  .get<BarRequest>('*', (request) => {
-    request.bar
-  })
-
-  // custom request from Route
-  .get<BarRequest, CF>('*', ({ bar, foo }, env, ctx) => {
-    env.KV
-    ctx.waitUntil
-  })
-
-  // how to return another custom router method
-  .get<FooRequest, CF>('*', (request) => {
-    request.foo
-  })
-
-  // call custom HTTP method again (to ensure preserved through chain)
-  .puppy('/cat', () => {})
-
-  // undeclared HTTP method?
-  .kitten<FooRequest>('/', (request) => {
-    request.foo
-  })
-
-  .handle<CF>({ method: 'GET', url: 'foo.bar' }, {}, 'asd')
-
-type CFfetch = [request: Request, env: Env, ctx: ExecutionContext]
-
-export default {
-  fetch: (...args: CFfetch) => router.handle(...args),
-}

package/example/runtimes/bun.ts

@@ -1,15 +0,0 @@
-import { Router, error, json, withParams } from 'itty-router'
-
-const router = Router()
-
-router
-  .all('*', withParams)
-  .get('/test', () => 'Success!')
-  .get('/foo/:bar/:baz?', ({ bar, baz }) => ({ bar, baz }))
-  .all('*', () => error(404))
-
-export default {
-  port: 3001,
-  fetch: (request, env, ctx) =>
-    router.handle(request, env, ctx).then(json).catch(error),
-}

package/example/runtimes/express.js

@@ -1,16 +0,0 @@
-import express from 'express'
-import { Router, error, json } from 'itty-router'
-import 'isomorphic-fetch'
-
-const app = express()
-
-const router = Router()
-
-router.get('/', () => 'Success!').all('*', () => error(404))
-
-const handle = (request) => router.handle(request).then(json).catch(error)
-
-app.use(handle)
-
-app.listen(3001)
-console.log('listening at https://localhost:3001')

package/example/runtimes/node.js

@@ -1,20 +0,0 @@
-import { createServerAdapter } from '@whatwg-node/server'
-import { createServer } from 'http'
-import 'isomorphic-fetch'
-import { Router, error, json } from '../dist/index.js'
-
-const router = Router()
-
-router.get('/', () => 'Success!').all('*', () => error(404))
-
-const ittyServer = createServerAdapter((...args) =>
-  router
-    .handle(...args)
-    .then(json)
-    .catch(error)
-)
-
-// Then use it in any environment
-const httpServer = createServer(ittyServer)
-httpServer.listen(3001)
-console.log('listening at https://localhost:3001')

package/example/types/content.ts

@@ -1,22 +0,0 @@
-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

package/example/types/extra-props.ts

@@ -1,13 +0,0 @@
-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
-

package/example/types/global-and-route-level-request.ts

@@ -1,17 +0,0 @@
-import { IRequestStrict } from 'IttyRouter'
-import { Router } from 'Router'
-
-const router = Router<IRequestStrict>()
-
-type FooRequest = {
-  foo: string
-} & IRequestStrict
-
-router
-  .get('/basic', () => new Response('Success!'))
-  .get('/text', () => 'Success!')
-  // .get('/params/:foo', ({ foo }) => foo)              // should NOT work
-  .get<FooRequest>('/params/:foo', ({ foo }) => foo)  // should work
-  .get('/json', () => ({ foo: 'bar' }))
-
-export default router

package/example/types/global-request.ts

@@ -1,16 +0,0 @@
-import { IRequestStrict } from 'IttyRouter'
-import { Router } from 'Router'
-
-type FooRequest = {
-  foo: string
-} & IRequestStrict
-
-const router = Router<FooRequest>()
-
-router
-  .get('/', (request) => {
-    request.foo // should work
-    // request.bar // should NOT work
-  })
-
-export default router

package/example/types/middleware.ts

@@ -1,41 +0,0 @@
-import { IRequestStrict, IRequest, RequestHandler } from '../../src/types'
-import { IttyRouter } from 'IttyRouter'
-
-type UserRequest = {
-  user: string
-} & IRequestStrict
-
-const router = IttyRouter<IRequestStrict>()
-
-const withUser: RequestHandler = (request) => {
-  request.user = 'Kevin'
-}
-
-router
-  // upstream request sees the request as IRequest (default), so anything goes
-  .get('/', (request) => {
-    request.user = 123 // not OK
-  })
-
-  // then we add the middleware defined above as <UserRequest>
-  .all('*', withUser, (request) => {
-    request.user = 'Kevin'
-    request.user = 123  // NOT ok
-  })
-
-  // and if we ever need to restore control, add the generic back in
-  .get<UserRequest, []>('/', (request) => {
-    request.user = 'Kevin'
-    request.user = 123  // NOT ok
-  })
-
-  .get('/', (request) => {
-    request.user = 'Kevin' // still ok
-    request.user = 123  // NOT ok
-  })
-
-  router.get('/', (request) => {
-    request.user = 123 // NOT ok
-  })
-
-export default router

package/example/types/requestlike.ts

@@ -1,11 +0,0 @@
-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
-
-

package/example/types/route-level-request.ts

@@ -1,16 +0,0 @@
-import { IRequestStrict } from 'IttyRouter'
-import { Router } from 'Router'
-
-type FooRequest = {
-  foo: string
-} & IRequestStrict
-
-const router = Router()
-
-router
-  .get<FooRequest>('/', (request) => {
-    request.foo // should work
-    // request.bar // should NOT work
-  })
-
-export default router

package/example/types/router.ts

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

package/lib/index.ts

@@ -1,72 +0,0 @@
-/* istanbul ignore file */
-import { expect, it, vi } from 'vitest'
-
-// generates a request from a string like:
-// GET /whatever
-// /foo
-export const toReq = (methodAndPath: string, options: RequestInit = {}) => {
-  let [method, path] = methodAndPath.split(' ')
-  if (!path) {
-    path = method
-    method = 'GET'
-  }
-
-  return new Request(`https://example.com${path}`, { method, ...options })
-}
-
-export const extract = ({ params, query }) => ({ params, query })
-
-const testRoute = async (
-  { route, path, method = 'get', returns = true, log = false },
-  Router
-) => {
-  const routes = []
-  const router = Router({ routes })
-  const handler = vi.fn((req) => req.params)
-
-  // register route
-  router[method](route, handler)
-
-  log && console.log({
-    routes,
-    route,
-    path,
-  })
-
-  await router.fetch(toReq(`${method.toUpperCase()} ${path}`))
-
-  if (!returns) {
-    expect(handler).not.toHaveBeenCalled()
-  } else {
-    expect(handler).toHaveBeenCalled()
-
-    if (typeof returns === 'object') {
-      expect(handler).toHaveReturnedWith(returns)
-    }
-  }
-}
-
-export const runTests = (tests, Router) => {
-  for (let test of tests) {
-    let { route, path, returns = true, description } = test
-    const matchNote = returns
-      ? typeof returns === 'object'
-        ? `returns params ${JSON.stringify(returns)
-            .replace('{', '{ ')
-            .replace('}', ' }')
-            .replace(/"(\w+)":/g, '$1: ')
-            .replace(',', ', ')} from`
-        : 'matches'
-      : 'does NOT match'
-    description = description || `route "${route}" ${matchNote} path "${path}"`
-
-    it(description, async () => {
-      await testRoute(test, Router)
-    })
-  }
-}
-
-export const createTestRunner =
-  (Router) =>
-  (...args) =>
-    runTests(...args, Router)

package/rollup.config.mjs

@@ -1,68 +0,0 @@
-import terser from '@rollup/plugin-terser'
-import typescript from '@rollup/plugin-typescript'
-import { globby } from 'globby'
-import bundleSize from 'rollup-plugin-bundle-size'
-import copy from 'rollup-plugin-copy'
-import fs from 'fs-extra'
-
-// scan files to build
-const files = (await globby('./src/*.ts', {
-  ignore: ['**/*.spec.ts', 'example', '**/types.ts'],
-})).map(path => ({
-  path,
-  shortPath: path.replace(/(\/src)|(\.ts)/g, '').replace('./index', '.'),
-  esm: path.replace('/src/', '/dist/').replace('.ts', '.mjs'),
-  cjs: path.replace('/src/', '/dist/').replace('.ts', '.js'),
-  types: path.replace('/src/', '/dist/').replace('.ts', '.d.ts'),
-})).sort((a, b) => a.shortPath.toLowerCase() < b.shortPath.toLowerCase() ? -1 : 1)
-
-
-// read original package.json
-const pkg = await fs.readJSON('./package.json')
-
-// create updated exports list from build files
-pkg.exports = files.reduce((acc, file) => {
-  acc[file.shortPath] = {
-    import: file.esm.replace('/dist', ''),
-    require: file.cjs.replace('/dist', ''),
-    types: file.types.replace('/dist', ''),
-  }
-
-  return acc
-}, {})
-
-// write updated package.json
-await fs.writeJSON('./package.json', pkg, { spaces: 2 })
-
-export default async () => {
-  console.log(files.map(f => f.path))
-
-  return files.map(file => ({
-    input: file.path,
-    output: [
-      {
-        format: 'esm',
-        file: file.esm,
-        sourcemap: true,
-      },
-      {
-        format: 'cjs',
-        file: file.cjs,
-        sourcemap: true,
-      },
-    ],
-    plugins: [
-      typescript({ sourceMap: true }),
-      terser(),
-      bundleSize(),
-      copy({
-        targets: [
-          {
-            src: ['LICENSE'],
-            dest: 'dist',
-          },
-        ],
-      }),
-    ],
-  }))
-}

package/tsconfig.json

@@ -1,28 +0,0 @@
-{
-  "compilerOptions": {
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
-    "baseUrl": "src",
-    "declaration": true,
-    "sourceMap": true,
-    "esModuleInterop": true,
-    "inlineSourceMap": false,
-    "lib": ["esnext", "dom", "dom.iterable"],
-    "listEmittedFiles": false,
-    "listFiles": false,
-    "noFallthroughCasesInSwitch": true,
-    "pretty": true,
-    // "moduleResolution": "nodeNext",  // disabled to be compatible with module: "esnext"
-    // "resolveJsonModule": true,       // disabled to be compatible with module: "esnext"
-    "rootDir": "src",
-    "skipLibCheck": true,
-    "strict": true,
-    "traceResolution": false,
-    "outDir": "",
-    "target": "esnext",
-    "module": "esnext",
-    "types": ["@cloudflare/workers-types", "@types/node"]
-  },
-  "exclude": ["node_modules", "dist", "**/*.spec.ts", "**/example.ts"],
-  "include": ["src", "example"]
-}

package/vitest.config.ts

@@ -1,20 +0,0 @@
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
-    exclude: ['**/example/**'],
-    coverage: {
-      reporter: ['text', 'lcov'],
-      exclude: [
-        '**/example/**',
-        '**/lib/**',
-        'src/index.ts',
-        'src/types',
-        'src/types.ts',
-        'src/websocket.ts',
-      ],
-    },
-    environment: 'jsdom',
-  },
-})