itty-router 3.0.8 → 3.0.10

package/CHANGELOG.md

@@ -3,6 +3,7 @@ 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\
 
+- **v3.0.9** - fixes some TS issue, previously requiring you to define Router Methods to chain request definitions. (credit [@jahands](https://github.com/jahands))
 - **v3.0.0** - total TS conversion with improved types, adding greedy params (credit [@markusahlstrand](https://github.com/markusahlstrand))
 - **v2.6.4** - merely a republish, attempting to solve NPM test scores vs CI/CD
 - **v2.6.2** - fixes issue with using base path of "/" with route definitions starting with "/" (creating double slash)

package/README.md

@@ -421,13 +421,6 @@ import {
   Route,                // generic Route type
 } from './itty-router'
 
-// declare a custom Router type with used methods
-interface CustomRouter extends RouterType {
-  all: Route,
-  get: Route,
-  puppy: Route,
-}
-
 // declare a custom Request type to allow request injection from middleware
 type RequestWithAuthors = {
   authors?: string[]
@@ -438,11 +431,11 @@ const withAuthors = (request: IRequest) => {
   request.authors = ['foo', 'bar']
 }
 
-const router = <CustomRouter>Router({ base: '/' })
+const router = Router({ base: '/' })
 
 router
-  .all<CustomRouter>('*', () => {})
-  .get<CustomRouter>('/authors', withAuthors, (request: RequestWithAuthors) => {
+  .all('*', () => {})
+  .get('/authors', withAuthors, (request: RequestWithAuthors) => {
     return request.authors?.[0]
   })
   .puppy('*', (request) => {
@@ -483,6 +476,7 @@ These folks are the real heroes, making open source the powerhouse that it is!
 - [@taralx](https://github.com/taralx) - QOL fixes for contributing (dev dep fix and test file consistency) <3
 - [@technoyes](https://github.com/technoyes) - three kind-of-a-big-deal errors fixed.  Imagine the look on my face... thanks man!! :)
 - [@roojay520](https://github.com/roojay520) - TS interface fixes
+- [@jahands](https://github.com/jahands) - v3.x TS fixes
 #### Documentation
 - [@arunsathiya](https://github.com/arunsathiya),
   [@poacher2k](https://github.com/poacher2k),

package/dist/itty-router.d.ts

@@ -1,11 +1,20 @@
 declare type GenericTraps = {
     [key: string]: any;
 };
+declare type RequestLike = {
+    method: string;
+    url: string;
+} & GenericTraps;
 declare type IRequest = {
     method: string;
     url: string;
-    params: GenericTraps;
-    query: GenericTraps;
+    params: {
+        [key: string]: string;
+    };
+    query: {
+        [key: string]: string | undefined;
+    };
+    proxy?: any;
 } & GenericTraps;
 interface RouterOptions {
     base?: string;
@@ -17,19 +26,19 @@ interface RouteHandler {
 declare type RouteEntry = [string, RegExp, RouteHandler[]];
 declare type Route = <T extends RouterType>(path: string, ...handlers: RouteHandler[]) => T;
 declare type RouterHints = {
-    all?: Route;
-    delete?: Route;
-    get?: Route;
-    options?: Route;
-    patch?: Route;
-    post?: Route;
-    put?: Route;
+    all: Route;
+    delete: Route;
+    get: Route;
+    options: Route;
+    patch: Route;
+    post: Route;
+    put: Route;
 };
 declare type RouterType = {
     __proto__: RouterType;
     routes: RouteEntry[];
-    handle: (request: IRequest, ...extra: any) => Promise<any>;
+    handle: (request: RequestLike, ...extra: any) => Promise<any>;
 } & RouterHints;
 declare const Router: ({ base, routes }?: RouterOptions) => RouterType;
 
-export { GenericTraps, IRequest, Route, RouteEntry, RouteHandler, Router, RouterHints, RouterOptions, RouterType };
+export { GenericTraps, IRequest, RequestLike, Route, RouteEntry, RouteHandler, Router, RouterHints, RouterOptions, RouterType };

package/dist/itty-router.js

@@ -1 +1 @@
-"use strict";var u=Object.defineProperty;var l=Object.getOwnPropertyDescriptor;var d=Object.getOwnPropertyNames;var g=Object.prototype.hasOwnProperty;var h=(r,e)=>{for(var t in e)u(r,t,{get:e[t],enumerable:!0})},x=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of d(e))!g.call(r,o)&&o!==t&&u(r,o,{get:()=>e[o],enumerable:!(n=l(e,o))||n.enumerable});return r};var f=r=>x(u({},"__esModule",{value:!0}),r);var m={};h(m,{Router:()=>c});module.exports=f(m);var T=r=>[...r.entries()].reduce((e,[t,n])=>(e[t]===void 0?e[t]=n:e[t]=[e[t],n].flat())&&e||e,{}),c=({base:r="",routes:e=[]}={})=>({__proto__:new Proxy({},{get:(t,n,o)=>(p,...a)=>e.push([n.toUpperCase(),RegExp(`^${(r+p).replace(/(\/?)\*/g,"($1.*)?").replace(/(\/$)|((?<=\/)\/)/,"").replace(/(:(\w+)\+)/,"(?<$2>.*)").replace(/:(\w+)(\?)?(\.)?/g,"$2(?<$1>[^/]+)$2$3").replace(/\.(?=[\w(])/,"\\.").replace(/\)\.\?\(([^\[]+)\[\^/g,"?)\\.?($1(?<=\\.)[^\\.")}/*$`),a])&&o}),routes:e,async handle(t,...n){let o,p,a=new URL(t.url);t.query=T(a.searchParams);for(let[s,R,y]of e)if((s===t.method||s==="ALL")&&(p=a.pathname.match(R))){t.params=p.groups||{};for(let i of y)if((o=await i(t.proxy||t,...n))!==void 0)return o}}});0&&(module.exports={Router});
+"use strict";var s=Object.defineProperty;var l=Object.getOwnPropertyDescriptor;var g=Object.getOwnPropertyNames;var d=Object.prototype.hasOwnProperty;var x=(r,e)=>{for(var t in e)s(r,t,{get:e[t],enumerable:!0})},h=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of g(e))!d.call(r,o)&&o!==t&&s(r,o,{get:()=>e[o],enumerable:!(n=l(e,o))||n.enumerable});return r};var f=r=>h(s({},"__esModule",{value:!0}),r);var $={};x($,{Router:()=>T});module.exports=f($);var m=r=>[...r.entries()].reduce((e,[t,n])=>(e[t]===void 0?e[t]=n:e[t]=[e[t],n].flat())&&e||e,{}),T=({base:r="",routes:e=[]}={})=>({__proto__:new Proxy({},{get:(t,n,o)=>(p,...a)=>e.push([n.toUpperCase(),RegExp(`^${(r+p).replace(/(\/?)\*/g,"($1.*)?").replace(/(\/$)|((?<=\/)\/)/,"").replace(/(:(\w+)\+)/,"(?<$2>.*)").replace(/:(\w+)(\?)?(\.)?/g,"$2(?<$1>[^/]+)$2$3").replace(/\.(?=[\w(])/,"\\.").replace(/\)\.\?\(([^\[]+)\[\^/g,"?)\\.?($1(?<=\\.)[^\\.")}/*$`),a])&&o}),routes:e,async handle(t,...n){let o,p,a=new URL(t.url);t.query=m(a.searchParams);for(let[u,i,R]of e)if((u===t.method||u==="ALL")&&(p=a.pathname.match(i))){t.params=p.groups||{};for(let y of R)if((o=await y(t.proxy||t,...n))!==void 0)return o}}});0&&(module.exports={Router});

package/dist/itty-router.mjs

@@ -1 +1 @@
-var i=a=>[...a.entries()].reduce((t,[e,r])=>(t[e]===void 0?t[e]=r:t[e]=[t[e],r].flat())&&t||t,{}),l=({base:a="",routes:t=[]}={})=>({__proto__:new Proxy({},{get:(e,r,o)=>(n,...p)=>t.push([r.toUpperCase(),RegExp(`^${(a+n).replace(/(\/?)\*/g,"($1.*)?").replace(/(\/$)|((?<=\/)\/)/,"").replace(/(:(\w+)\+)/,"(?<$2>.*)").replace(/:(\w+)(\?)?(\.)?/g,"$2(?<$1>[^/]+)$2$3").replace(/\.(?=[\w(])/,"\\.").replace(/\)\.\?\(([^\[]+)\[\^/g,"?)\\.?($1(?<=\\.)[^\\.")}/*$`),p])&&o}),routes:t,async handle(e,...r){let o,n,p=new URL(e.url);e.query=i(p.searchParams);for(let[u,s,R]of t)if((u===e.method||u==="ALL")&&(n=p.pathname.match(s))){e.params=n.groups||{};for(let y of R)if((o=await y(e.proxy||e,...r))!==void 0)return o}}});export{l as Router};
+var y=a=>[...a.entries()].reduce((t,[e,r])=>(t[e]===void 0?t[e]=r:t[e]=[t[e],r].flat())&&t||t,{}),l=({base:a="",routes:t=[]}={})=>({__proto__:new Proxy({},{get:(e,r,o)=>(n,...p)=>t.push([r.toUpperCase(),RegExp(`^${(a+n).replace(/(\/?)\*/g,"($1.*)?").replace(/(\/$)|((?<=\/)\/)/,"").replace(/(:(\w+)\+)/,"(?<$2>.*)").replace(/:(\w+)(\?)?(\.)?/g,"$2(?<$1>[^/]+)$2$3").replace(/\.(?=[\w(])/,"\\.").replace(/\)\.\?\(([^\[]+)\[\^/g,"?)\\.?($1(?<=\\.)[^\\.")}/*$`),p])&&o}),routes:t,async handle(e,...r){let o,n,p=new URL(e.url);e.query=y(p.searchParams);for(let[s,u,i]of t)if((s===e.method||s==="ALL")&&(n=p.pathname.match(u))){e.params=n.groups||{};for(let R of i)if((o=await R(e.proxy||e,...r))!==void 0)return o}}});export{l as Router};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-router",
-  "version": "3.0.8",
+  "version": "3.0.10",
   "description": "Tiny, zero-dependency API router - built for Cloudflare Workers, but works everywhere!",
   "sourceType": "module",
   "main": "./dist/itty-router.js",
@@ -42,7 +42,6 @@
     "prerelease": "yarn verify",
     "prebuild": "rimraf dist && mkdir dist",
     "build": "tsup src/itty-router.ts --format cjs,esm --dts --minify --clean",
-    "postbuild": "node check-size.js",
     "release": "release --tag --push --patch",
     "prerelease:next": "yarn verify",
     "release:next": "release --push --type=next"
@@ -58,6 +57,7 @@
   },
   "homepage": "https://itty-router.dev",
   "devDependencies": {
+    "@cloudflare/workers-types": "^4.20221111.1",
     "@vitejs/plugin-vue": "^2.2.4",
     "@vitest/coverage-c8": "^0.24.3",
     "coveralls": "^3.1.1",