bun-router 0.5.8 → 0.7.0

package/README.md

@@ -56,7 +56,7 @@ r.serve();
 
 **SQLite**
 ```ts
-import { router, json } from '..';
+import { router, json } from 'bun-router';
 import { Database } from 'bun:sqlite';
 
 const r = router(3000, {db: './examples/dbs/test.db'});

package/examples/basic.ts

@@ -2,17 +2,12 @@ import { router, http } from '..';
 
 const r = router();
 
-r.add('/', 'GET', () => http.json('ok'));
+r.add('/', 'GET', () => http.json(200, 'ok'));
 
 r.add('/user/:name', 'GET', (ctx) => {
     const name = ctx.params.get('name');
-    return http.json(name);
-});
-
-r.add('/user/:name/:id', 'GET', (ctx) => {
-    const name = ctx.params.get('name');
-    const id = ctx.params.get('id');
-    return http.json({name: name, id: id});
+    if (!name) return http.json(500, 'no name');
+    return http.json(200, name);
 });
 
 r.serve();

package/examples/cookies.ts

@@ -0,0 +1,15 @@
+import { router } from '..';
+
+const r = router();
+
+r.add('/set-cookie', 'GET', ctx => {
+    ctx.cookies.set('domain', 'localhost');
+    ctx.cookies.set('path', '/set-cookie');
+
+    ctx.logger.message(ctx.token ?? 'no token provided');
+
+    return ctx.json( 200, {message: 'cookie stored'});
+});
+
+
+r.serve();

package/examples/dynamic.ts

@@ -1,29 +1,24 @@
 import { router, http } from '..';
 import { Context } from '../lib/router/router.d';
 
-const handler = (ctx: Context) => {
-    const name = ctx.params.get('name');
-    if (typeof name === 'undefined' || name === '') return http.html('<h6 style="color: red">User Undefined</h6>');
-    return http.html(`<h4>Hello, ${name}!</h4>`);
-}
+const home = (ctx: Context) => new Response('Welcome Home', { status: 200 });
 
-const space = (ctx: Context) => {
-    const name = ctx.params.get('name');
-    if (typeof name === 'undefined' || name === '') return http.html(`<h6 style="color: red">Space [${name}] Not Found</h6>`);
-    return http.html(`<h4>Welcome to ${name}!`)
+const subreddit = (ctx: Context) => {
+    const sub = ctx.params.get('subreddit');
+    if (!sub) return http.json(400, { error: 'no subreddit provided' });
+    return http.json(200, { subreddit: sub });
 }
 
-const handleSettings = (ctx: Context) => {
-    const name = ctx.params.get('name');
-    if (typeof name === 'undefined' || name === '') return http.html(`<h6 style="color: red">User Not Found</h6>`);
-    return http.html(`<h4>Settings for ${name}</h4>`)
+const user = (ctx: Context) => {
+    const user = ctx.params.get('user');
+    if (!user) return http.json(400, { error: 'no user provided' });
+    return http.json(200, { user: user });
 }
 
 const r = router();
 
-r.add('/u/:name', 'GET', handler);
-r.add('/s/:name', 'GET', space);
-r.add('/u/:name/settings', 'GET', handleSettings);
-
+r.add('/', 'GET', home);
+r.add('/r/:subreddit', 'GET', subreddit);
+r.add('/u/:user', 'GET', user);
 
 r.serve();

package/examples/logger.ts

@@ -8,9 +8,9 @@ r.add('/:foo', 'GET', (ctx) => {
     const foo = ctx.params.get('foo');
     if (!foo) {
         log.error(500, url.pathname, ctx.request.method, new Error('undefined'));
-        return http.json({status: 500, text: 'Foo is undefined'});
+        return http.json(500,{text: 'Foo is undefined'});
     }
-    return http.html(`<h4 style='font-family: sans-serif;'>Oh hello, ${foo}</h4>`)
+    return http.html(200, `<h4 style='font-family: sans-serif;'>Oh hello, ${foo}</h4>`)
 });
 
 r.serve();

package/examples/todo.ts

@@ -26,7 +26,7 @@ r.add('/api/new', 'POST', ctx => {
     ctx.logger.message(`Adding ${key} with ${content}`);
     todo.add(key, content);
 
-    return ctx.json({ message: 'ok' });
+    return ctx.json(200, { message: 'ok' });
 });
 
 r.add('/api/todo/:key', 'GET', ctx => {
@@ -36,11 +36,11 @@ r.add('/api/todo/:key', 'GET', ctx => {
     const content = todo.get(key);
     if (!content) return http.notFound();
 
-    return ctx.json({key: key, content: content});
+    return ctx.json(200, {key: key, content: content});
 });
 
 r.add('/api/get/all', 'GET', ctx => {
-    return ctx.json(todo.export());
+    return ctx.json(200, todo.export());
 });
 
 r.serve();

package/lib/http/generic-methods.ts

@@ -1,23 +1,22 @@
 import { httpStatusCodes } from "./status";
 
 const http = {
-    json: async (data: any): Promise<Response> => {
+    json: async (statusCode: number, data: any): Promise<Response> => {
         const jsonString = JSON.stringify(data);
         return Promise.resolve(new Response(jsonString, {
-            status: 200,
-            statusText: httpStatusCodes[200],
+            status: statusCode,
+            statusText: httpStatusCodes[statusCode],
             headers: {'Content-Type': 'application/json'},
         }));
     },
-    html: async (content: string): Promise<Response> => {
-        content = Bun.escapeHTML(content);
-        return Promise.resolve(new Response(Bun.escapeHTML(content), {
-            status: 200,
-            statusText: httpStatusCodes[200],
+    html: async (statusCode: number, content: string): Promise<Response> => {
+        return Promise.resolve(new Response(content, {
+            status: statusCode,
+            statusText: httpStatusCodes[statusCode],
             headers: {'Content-Type': 'text/html; charset=utf-8'}
         }));
     },
-    file: async (fp: string): Promise<Response> => {
+    file: async (statusCode: number, fp: string): Promise<Response> => {
         const file = Bun.file(fp);
         const exists = await file.exists();
     
@@ -32,8 +31,8 @@ const http = {
             contentType = file.type + '; charset=utf-8';
     
         return Promise.resolve(new Response(content, {
-            status: 200,
-            statusText: httpStatusCodes[200],
+            status: statusCode,
+            statusText: httpStatusCodes[statusCode],
             headers: { 'Content-Type': contentType}
         }));
     },
@@ -50,6 +49,15 @@ const http = {
     
         return Promise.resolve(response);
     },
+    methodNotAllowed: async (msg?: string): Promise<Response> => {
+        const response = new Response(msg ?? 'method not allowed', {
+            status: 405,
+            statusText: httpStatusCodes[405],
+            headers: {'Content-Type': 'text/html'},
+        });
+    
+        return Promise.resolve(response);
+    },
     message:  async (status: number, msg?: string): Promise<Response> => {
         const response = new Response(msg ?? '?', {
             status: status,
@@ -57,8 +65,7 @@ const http = {
             headers: {'Content-Type': 'text/html; charset-utf-8'},
         });
         return Promise.resolve(response)
-    }
-
+    }, 
 }
 
 export { http }

package/lib/logger/color.ts

@@ -20,7 +20,7 @@ const Colors: Record<string,string> = {
     bgMagenta: "\x1b[45m",
     bgCyan: "\x1b[46m",
     bgWhite: "\x1b[47m",
-  };
+  } as const;
 
   
 const color = (c: string, bkg: string, msg: string) => {

package/lib/logger/logger.ts

@@ -3,6 +3,14 @@ import {Logger} from './logger.d';
 
 const pad = (n: number) => String(n).padStart(2, '0'); 
 
+const TITLE = `
+_                          _           
+| |_ _ _ ___    ___ ___ _ _| |_ ___ ___ 
+| . | | |   |  |  _| . | | |  _| -_|  _|
+|___|___|_|_|  |_| |___|___|_| |___|_|  
+                                                                                    
+`
+
 const timestamp = (date: Date) => {
     const month = pad(date.getMonth());
     const day = pad(date.getDate());
@@ -48,6 +56,7 @@ const logger = (): Logger => {
             const portColor = color('green', 'bgBlack', String(port));
             const msg = `${source}: Starting Server on :${portColor}\n`;
 
+            await Bun.write(Bun.stdout, TITLE);
             await Bun.write(Bun.stdout, msg);
         },
         info: async (statusCode: number, routePath: string, method: string, message?: string) => {

package/lib/router/router.d.ts

@@ -2,21 +2,28 @@ import { TLSOptions, TLSWebSocketServeOptions, WebSocketServeOptions, ServeOptio
 import { Logger } from '../logger/logger';
 import { Database } from 'bun:sqlite';
 
+type HttpHandler = (ctx: Context) => Response | Promise<Response>
 
 type Context = {
-    request: Request,
-    route: Route,
-    params: Map<string, string>,
-    token?: string,
-    db: Database,
-    logger: Logger,
-    json: (data: any) => Response | Promise<Response>,
-}
+    cookies: Map<string, string>;
+    db?: Database;
+    formData: FormData | Promise<FormData> | undefined;
+    json: (statusCode: number, data: any) => Response | Promise<Response>;
+    logger: Logger;
+    params: Map<string, string>;
+    query: URLSearchParams;
+    request: Request;
+    token?: string;
+};
+
 
 type Route = {
-    pattern: string,
-    method: string,
-    callback: (req: Context) => Response | Promise<Response>
+    children: Map<string, Route>;
+    path: string;
+    dynamicPath: string;
+    method: string;
+    handler: HttpHandler;
+    isLast: boolean;
 }
 
 type Options = {
@@ -31,12 +38,11 @@ type RouterOptions<Options> = ServeOptions
 
 
 type Router = (port?: number | string, options?: RouterOptions) => {
-    add: (pattern: string, method: string, callback: (req: Context) => Response | Promise<Response>) => void,
-    GET: (pattern: string, callback: (ctx: Context) => Response | Promise<Response>) => void,
-    POST: (pattern: string, callback: (ctx: Context) => Response | Promise<Response>) => void,
-    static: (pattern: string, root: string) => void,
-    serve: () => void,
+    add: (pattern: string, method: string, callback: (req: Context) => Response | Promise<Response>) => void;
+    static: (pattern: string, root: string) => void;
+    serve: () => void;
 }
 
 
-export { Context , Route, Router, RouterOptions, Options }
+
+export { Context , Route, Router, RouterOptions, Options, HttpHandler }

package/lib/router/router.ts

@@ -1,17 +1,15 @@
 import path from 'path';
 import { Database } from 'bun:sqlite';
-import { Route, Router, Context, RouterOptions, Options } from './router.d';
+import { Route, Router, Context, RouterOptions, Options, HttpHandler } from './router.d';
 import { httpStatusCodes } from '../http/status';
 import { readDir } from '../fs/fsys';
 import { logger } from '../logger/logger';
-import { Logger } from '../logger/logger.d';
 import { http } from '../http/generic-methods';
+import {Radix, createContext} from './tree';
 
-// extract dynamic URL parameters
-// if the route pattern is /:foo and the request URL is /bar: {foo: 'bar'}
-const extract = (route: Route, ctx: Context) => {
+const extract = (path: string, ctx: Context) => {
     const url = new URL(ctx.request.url);
-    const pathSegments = route.pattern.split('/');
+    const pathSegments = path.split('/');
     const urlSegments = url.pathname.split('/');
 
     if (pathSegments.length !== urlSegments.length) return
@@ -19,10 +17,10 @@ const extract = (route: Route, ctx: Context) => {
     return {
         params: () => {
             for (let i = 0; i < pathSegments.length; i++) {
-                if ((pathSegments[i][0] === ':')) {
+                if((pathSegments[i][0] === ':')) {
                     const k = pathSegments[i].replace(':', '');
                     const v = urlSegments[i];
-                    ctx.params.set(k, v);
+                    ctx.params.set(k,v);
                 }
             }
         }
@@ -30,63 +28,16 @@ const extract = (route: Route, ctx: Context) => {
 
 }
 
-// ensure the route pattern matches the request URL
-const match = (route: Route, ctx: Context): boolean => {
-    const url = new URL(ctx.request.url);
-    const patternRegex = new RegExp('^' + route.pattern.replace(/:[^/]+/g, '([^/]+)') + '$');
-    const matches = url.pathname.match(patternRegex);
-
-    if (matches && route.method === ctx.request.method) {
-        const extractor = extract(route, ctx);
-        extractor?.params();
-
-        return true;
-    }
-
-    return false;
-}
-
-// set the context for the reuest
-const setContext = (req: Request, lgr: Logger, opts: Options, route: Route): Context => {
-    return {
-        request: req,
-        params: new Map(),
-        db: new Database(opts.db ?? ':memory:'),
-        logger: lgr,
-        route: route,
-        json: (data: any) => http.json(data),
-    }
-}
-
 const router: Router = (port?: number | string, options?: RouterOptions<Options>) => {
-    const routes: Array<Route> = new Array();
+    const {addRoute, findRoute} = Radix();
     const lgr = logger();
-    let dbConn = '';
 
     return {
-        // add a new route
-        add: (pattern: string, method: string, callback: (ctx: Context) => Response | Promise<Response>) => {
-            routes.push({
-                pattern: pattern,
-                method: method,
-                callback: callback,
-            })
+        // add a route to the router tree 
+        add: (pattern: string, method: string, callback: HttpHandler) => {
+            addRoute(pattern, method, callback);
         },
-        GET: (pattern: string, callback: (ctx: Context) => Response | Promise<Response>) => {
-            routes.push({
-                pattern: pattern,
-                method: 'GET',
-                callback: callback,
-            });
-        },
-        POST: (pattern: string, callback: (ctx: Context) => Response | Promise<Response>) => {
-            routes.push({
-                pattern: pattern,
-                method: 'POST',
-                callback: callback,
-            });
-        },
-        // add a route for static files
+        // add a static route to the router tree
         static: async (pattern: string, root: string) => {
             await readDir(root, async (fp, _) => {
                 const pure = path.join('.', fp);
@@ -103,12 +54,15 @@ const router: Router = (port?: number | string, options?: RouterOptions<Options>
                 if (base === 'index') patternPath = pattern;
 
                 const route: Route = {
-                    pattern: patternPath,
+                    children: new Map(),
+                    dynamicPath: '',
+                    isLast: true,
+                    path: patternPath,
                     method: 'GET',
-                    callback: async () => await http.file(pure),
+                    handler: async () => await http.file(200, pure),
                 };
 
-                routes.push(route);
+                addRoute(route.path, 'GET', route.handler);
             });
         },
         // start the server
@@ -116,41 +70,44 @@ const router: Router = (port?: number | string, options?: RouterOptions<Options>
             lgr.start(port ?? 3000);
             let opts: Options = { db: ':memory:' };
 
+            // TODO: add support for TLS and WebSockets
             Bun.serve({
                 port: port ?? 3000,
                 ...options,
                 async fetch(req) {
                     const url = new URL(req.url);
+                    let path = url.pathname;
 
+                    // set the database
                     if (options) {
                         let o = options as Options;
                         opts.db = o.db;
                     }
 
-                    let statusCode = 404;
-
-                    for (const route of routes) {
-                        const ctx = setContext(req, lgr, opts, route);
-
-                        if (match(route, ctx) || route.pattern === url.pathname) {
-                            if (route.method === ctx.request.method) {
-                                const res = await route.callback(ctx);
-                                statusCode = res.status;
-                                lgr.info(res.status, route.pattern, req.method, httpStatusCodes[res.status]);
-                                return Promise.resolve(res);
-                            } else {
-                                const res = new Response(httpStatusCodes[405], {
-                                    status: 405,
-                                    statusText: httpStatusCodes[305]
-                                });
-                                lgr.info(405, route.pattern, req.method, httpStatusCodes[405])
-                                return Promise.resolve(res);
-                            }
-                        }  
-                    }
+                    const route = findRoute(path);
+
+                    // if the route exists, execute the handler
+                    if (route) {
+                        if (route.method !== req.method) {
+                            lgr.info(405, url.pathname, req.method, httpStatusCodes[405]);
+                            return Promise.resolve(http.methodNotAllowed());
+                        }
+
+                        const context = createContext(path, route, req);
+                        context.db = new Database(opts.db);
+
+                        const response = await route.handler(context);
+
+                        lgr.info(response.status, url.pathname, req.method, httpStatusCodes[response.status]);
+                        return Promise.resolve(response);
+                    } 
+
+                    // if no route is found, return 404
+                    const response = await http.notFound();
+                        
+                    lgr.info(response.status, url.pathname, req.method, httpStatusCodes[response.status]);
+                    return Promise.resolve(http.notFound());
 
-                    lgr.info(statusCode, url.pathname, req.method, httpStatusCodes[statusCode]);
-                    return Promise.resolve(http.message(statusCode, httpStatusCodes[statusCode]));
                 }
             });
         },

package/lib/router/tree.ts

@@ -0,0 +1,90 @@
+import { HttpHandler, Context, Route } from "./router.d";
+import { http } from "../http/generic-methods";
+
+const splitPath = (s: string): string[] => s.split('/').filter(x => x !== '');
+
+const createRoute = (path: string, method: string, handler: HttpHandler): Route => {
+    const route: Route = {
+        children: new Map(),
+        path: path,
+        dynamicPath: '',
+        method: method,
+        handler: handler,
+        isLast: false
+    };
+
+    return route;
+};
+
+const extractParams = (path: string, route: Route, params: Map<string, string>) => {
+    const pathParts = splitPath(path);
+    const routeParts = splitPath(route.path);
+
+    for (let i = 0; i < routeParts.length; i++) {
+        const part = routeParts[i];
+        if (part.startsWith(':')) {
+            params.set(part.slice(1), pathParts[i]);
+        }
+    }
+};
+
+const createContext = (path: string, route: Route, req: Request): Context => {
+    const params: Map<string, string> = new Map();
+
+    if (route) extractParams(path, route, params);
+
+    return {
+        params: params,
+        request: req,
+        query: new URLSearchParams(path),
+        cookies: new Map(),
+        formData: undefined,
+        logger: undefined,
+        json: (statusCode: number, data: any) => http.json(statusCode, data),
+    }
+};
+
+const Radix = () => {
+    let root = createRoute('', 'GET', () => http.notFound());
+
+    const addRoute = (path: string, method: string, handler: HttpHandler) => {
+        const pathParts = splitPath(path);
+        let current = root;
+
+        for (let i = 0; i < pathParts.length; i++) {
+            const part = pathParts[i];
+            if (part.startsWith(':')) {
+                current.dynamicPath = part;
+            }
+            if (!current.children.has(part)) {
+                current.children.set(part, createRoute(part, method, handler));
+            }
+            current = current.children.get(part)!;
+        }
+
+        current.handler = handler;
+        current.isLast = true;
+        current.path = path;
+    };
+
+    const findRoute = (path: string): Route | undefined => {
+        const pathParts = splitPath(path);
+        let current = root;
+        for (let i = 0; i < pathParts.length; i++) {
+            const part = pathParts[i];
+            if (current.children.has(part)) {
+                current = current.children.get(part)!;
+            } else if (current.dynamicPath) {
+                current = current.children.get(current.dynamicPath)!;
+            } else {
+                return;
+            }
+        }
+        return current;
+    }
+
+    return { addRoute, findRoute }
+
+};
+
+export { Radix, createContext }

package/package.json

@@ -8,5 +8,5 @@
   "peerDependencies": {
     "typescript": "^5.0.0"
   },
-  "version": "0.5.8"
+  "version": "0.7.0"
 }

package/tests/router.test.ts

@@ -1,68 +1,4 @@
 import { describe, test, expect } from 'bun:test';
-import { extract } from '..';
-import { Context, Route } from '../lib/router/router.d';
-
-describe('URL Params', () => {
-    test('/user/:name', () => {
-        const route: Route = {
-            pattern: '/user/:name',
-            method: 'GET',
-            callback: () => new Response('ok'),
-        };
-
-        const ctx: Context = {
-            request: new Request('http://localhost:3000/user/foo'),
-            params: new Map(),
-        };
-
-        const extractor = extract(route, ctx);
-
-        extractor?.params();
-
-        const name = ctx.params.get('name');
-        expect(name).toBe('foo');
-    });
-
-    test('/user/:name/:id', () => {
-        const route: Route = {
-            pattern: '/user/:name/:id',
-            method: 'GET',
-            callback: () => new Response('ok'),
-        };
-
-        const ctx: Context = {
-            request: new Request('http://localhost:3000/user/foo/123'),
-            params: new Map(),
-        };
-
-        const extractor = extract(route, ctx);
-
-        extractor?.params();
-
-        const name = ctx.params.get('name');
-        const id = ctx.params.get('id');
-
-        expect(name).toBe('foo');
-        expect(id).toBe('123');
-    });
-
-    test('/foo', () => {
-        const route: Route = {
-            pattern: '/foo',
-            method: 'GET',
-            callback: () => new Response('ok'),
-        }
-
-        const ctx: Context = {
-            request: new Request('http://localhost:3000/foo'),
-            params: new Map(),
-        }
-
-        const url = new URL(ctx.request.url);
-
-        expect(url.pathname).toBe(route.pattern);
-    });
-});
 
 describe('Router', () => {
     test('Serve', async () => {

package/examples/sqlite.ts

@@ -1,22 +0,0 @@
-import { router, http } from '..';
-
-const r = router(3000, {db: './examples/dbs/test.db'});
-
-r.add('/u/new/:name', 'GET', (ctx) => {
-    const name = ctx.params.get('name');
-    const rando = Math.floor(Math.random()*1000);
-
-    ctx.db.run(`INSERT INTO test VALUES(${rando}, "${name}")`);
-
-    return http.json({message: 'ok'});
-});
-
-r.add('/u/:name', 'GET', (ctx) => {
-    const name = ctx.params.get('name');
-    const data = ctx.db.query(`SELECT * FROM test WHERE name = "${name}";`).get();
-    const d = data as {id: number, name: string};
-
-    return d ? http.json(d) : new Response('not found', {status: 404});
-});
-
-r.serve();