itty-router 3.0.0-next.0 → 3.0.0-next.1

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.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)
 - **v2.6.1** - fixes named export in ESM/mjs export

package/dist/itty-router.d.ts

@@ -1,59 +1,28 @@
-type Obj = {
-  [propName: string]: string
-}
-
-interface RouteHandler<TRequest> {
-  (request: TRequest, ...args: any): any
-}
-
-interface Route {
-  <TRequest>(path: string, ...handlers: RouteHandler<TRequest & Request>[]): Router<TRequest>
-}
-
-interface RouteEntry<TRequest> {
-  0: string
-  1: RegExp
-  2: RouteHandler<TRequest>[]
-}
-
-interface Request {
-  method: string
-  params?: Obj
-  query?: Obj
-  url: string
-
-  arrayBuffer?(): Promise<any>
-  blob?(): Promise<any>
-  formData?(): Promise<any>
-  json?(): Promise<any>
-  text?(): Promise<any>
-}
-
-interface IHTTPMethods {
-  get: Route
-  head: Route
-  post: Route
-  put: Route
-  delete: Route
-  connect: Route
-  options: Route
-  trace: Route
-  patch: Route
-}
-
-interface RouterOptions<TRequest> {
-  base?: string
-  routes?: RouteEntry<TRequest>[]
-}
-
-type Router<TRequest = Request, TMethods = {}> = {
-  handle: (request: TRequest, ...extra: any) => Promise<any>
-  routes: RouteEntry<TRequest>[]
-  all: Route
-} & TMethods & {
-  [any:string]: Route
-}
-
-declare function Router<TRequest = Request, TMethods = {}>(options?:RouterOptions<TRequest>): Router<TRequest, TMethods>
-
-export { IHTTPMethods, Obj, Request, Route, RouteEntry, RouteHandler, Router, RouterOptions };
+declare type RequestTraps = {
+    [key: string]: any;
+};
+declare type RequestLike = {
+    method: string;
+    url: string;
+} & RequestTraps;
+interface RouterOptions {
+    base?: string;
+    routes?: RouteEntry[];
+}
+interface RouteHandler {
+    (request: RequestLike, ...args: any): any;
+}
+declare type RouteEntry = [string, RegExp, RouteHandler[]];
+declare type Route = (path: string, ...handlers: RouteHandler[]) => RouterType;
+declare type RouterTraps = {
+    get?: Route;
+    post?: Route;
+};
+declare type RouterType = {
+    __proto__: RouterType;
+    routes: RouteEntry[];
+    handle: (request: RequestLike, ...extra: any) => Promise<any>;
+} & RouterTraps;
+declare function Router({ base, routes }?: RouterOptions): RouterType;
+
+export { RequestLike, RequestTraps, Route, RouteEntry, RouteHandler, Router, RouterOptions, RouterTraps, RouterType };

package/dist/itty-router.js

@@ -22,31 +22,10 @@ __export(itty_router_exports, {
   Router: () => Router
 });
 module.exports = __toCommonJS(itty_router_exports);
-var url = new URL("https://foo.bar?name=Kevin&age=14&pet=Katiya&pet=Vlad&pet=Halsey");
-var query = (params, out = {}) => {
-  for (const [k, v] of params.entries()) {
-    if (typeof out[k] === "object") {
-      out[k].push(v);
-    } else if (out[k] === void 0) {
-      out[k] = v;
-    } else {
-      out[k] = [out[k], v];
-    }
-  }
-  return out;
-};
-var query2 = (params) => [...params.entries()].reduce((acc, [k, v]) => {
-  if (acc[k] === void 0)
-    return (acc[k] = v) && acc;
-  return (acc[k] = [...[acc[k]], v].flat()) && acc;
-}, {});
-var query3 = (params) => [...params.entries()].reduce(
+var toQuery = (params) => [...params.entries()].reduce(
   (acc, [k, v]) => (acc[k] === void 0 ? acc[k] = v : acc[k] = [...[acc[k]], v].flat()) && acc,
   {}
 );
-console.log(query(url.searchParams));
-console.log(query2(url.searchParams));
-console.log(query3(url.searchParams));
 function Router({ base = "", routes = [] } = {}) {
   return {
     __proto__: new Proxy({}, {
@@ -58,10 +37,10 @@ function Router({ base = "", routes = [] } = {}) {
     }),
     routes,
     async handle(request, ...args) {
-      let response, match, url2 = new URL(request.url);
-      request.query = Object.fromEntries(url2.searchParams);
+      let response, match, url = new URL(request.url);
+      request.query = toQuery(url.searchParams);
       for (let [method, route, handlers] of routes) {
-        if ((method === request.method || method === "ALL") && (match = url2.pathname.match(route))) {
+        if ((method === request.method || method === "ALL") && (match = url.pathname.match(route))) {
           request.params = match.groups;
           for (let handler of handlers) {
             if ((response = await handler(request.proxy || request, ...args)) !== void 0)

package/dist/itty-router.mjs

@@ -1,29 +1,8 @@
 // src/itty-router.ts
-var url = new URL("https://foo.bar?name=Kevin&age=14&pet=Katiya&pet=Vlad&pet=Halsey");
-var query = (params, out = {}) => {
-  for (const [k, v] of params.entries()) {
-    if (typeof out[k] === "object") {
-      out[k].push(v);
-    } else if (out[k] === void 0) {
-      out[k] = v;
-    } else {
-      out[k] = [out[k], v];
-    }
-  }
-  return out;
-};
-var query2 = (params) => [...params.entries()].reduce((acc, [k, v]) => {
-  if (acc[k] === void 0)
-    return (acc[k] = v) && acc;
-  return (acc[k] = [...[acc[k]], v].flat()) && acc;
-}, {});
-var query3 = (params) => [...params.entries()].reduce(
+var toQuery = (params) => [...params.entries()].reduce(
   (acc, [k, v]) => (acc[k] === void 0 ? acc[k] = v : acc[k] = [...[acc[k]], v].flat()) && acc,
   {}
 );
-console.log(query(url.searchParams));
-console.log(query2(url.searchParams));
-console.log(query3(url.searchParams));
 function Router({ base = "", routes = [] } = {}) {
   return {
     __proto__: new Proxy({}, {
@@ -35,10 +14,10 @@ function Router({ base = "", routes = [] } = {}) {
     }),
     routes,
     async handle(request, ...args) {
-      let response, match, url2 = new URL(request.url);
-      request.query = Object.fromEntries(url2.searchParams);
+      let response, match, url = new URL(request.url);
+      request.query = toQuery(url.searchParams);
       for (let [method, route, handlers] of routes) {
-        if ((method === request.method || method === "ALL") && (match = url2.pathname.match(route))) {
+        if ((method === request.method || method === "ALL") && (match = url.pathname.match(route))) {
           request.params = match.groups;
           for (let handler of handlers) {
             if ((response = await handler(request.proxy || request, ...args)) !== void 0)

package/package.json

@@ -1,23 +1,22 @@
 {
   "name": "itty-router",
-  "version": "3.0.0-next.0",
+  "version": "3.0.0-next.1",
   "description": "Tiny, zero-dependency API router - built for Cloudflare Workers, but works everywhere!",
   "sourceType": "module",
-  "files": [
-    "dist/itty-router.js",
-    "dist/itty-router.mjs",
-    "dist/itty-router.d.ts"
-  ],
-  "main": "./dist/itty-router.min.js",
+  "main": "./dist/itty-router.js",
+  "types": "./dist/itty-router.d.ts",
   "exports": {
     ".": {
       "types": "./dist/itty-router.d.ts",
       "import": "./dist/itty-router.mjs",
-      "require": "./dist/itty-router.js",
-      "default": "./dist/itty-router.mjs"
+      "require": "./dist/itty-router.js"
     }
   },
-  "types": "./dist/itty-router.d.ts",
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
   "keywords": [
     "api",
     "router",