hono 0.4.0 → 0.5.0

package/dist/hono.js

@@ -1,52 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Hono = exports.Router = void 0;
-const node_1 = require("./node");
+exports.Hono = void 0;
 const compose_1 = require("./compose");
 const url_1 = require("./utils/url");
 const context_1 = require("./context");
-class Router {
-    constructor() {
-        this.node = new node_1.Node();
-    }
-    add(method, path, handler) {
-        this.node.insert(method, path, handler);
-    }
-    match(method, path) {
-        return this.node.search(method, path);
-    }
-}
-exports.Router = Router;
+const router_1 = require("./router");
+const trie_router_1 = require("./router/trie-router"); // Default Router
 class Hono {
-    constructor(init = { strict: true }) {
-        this.router = new Router();
+    constructor(init = {}) {
+        this.routerClass = trie_router_1.TrieRouter;
+        this.strict = true; // strict routing - default is true
+        this.notFoundHandler = (c) => {
+            const message = '404 Not Found';
+            return c.text(message, 404);
+        };
+        this.errorHandler = (err, c) => {
+            console.error(`${err.message}`);
+            const message = 'Internal Server Error';
+            return c.text(message, 500);
+        };
+        Object.assign(this, init);
+        this.router = new this.routerClass();
         this.middlewareRouters = [];
         this.tempPath = null;
-        this.strict = init.strict; // strict routing - default is true
     }
-    get(path, ...args) {
-        return this.addRoute('get', path, ...args);
+    get(path, handler) {
+        return this.addRoute('get', path, handler);
     }
-    post(path, ...args) {
-        return this.addRoute('post', path, ...args);
+    post(path, handler) {
+        return this.addRoute('post', path, handler);
     }
-    put(path, ...args) {
-        return this.addRoute('put', path, ...args);
+    put(path, handler) {
+        return this.addRoute('put', path, handler);
     }
-    head(path, ...args) {
-        return this.addRoute('head', path, ...args);
+    head(path, handler) {
+        return this.addRoute('head', path, handler);
     }
-    delete(path, ...args) {
-        return this.addRoute('delete', path, ...args);
+    delete(path, handler) {
+        return this.addRoute('delete', path, handler);
     }
-    options(path, ...args) {
-        return this.addRoute('options', path, ...args);
+    options(path, handler) {
+        return this.addRoute('options', path, handler);
     }
-    patch(path, ...args) {
-        return this.addRoute('patch', path, ...args);
+    patch(path, handler) {
+        return this.addRoute('patch', path, handler);
     }
-    all(path, ...args) {
-        return this.addRoute('all', path, ...args);
+    all(path, handler) {
+        return this.addRoute('all', path, handler);
     }
     route(path) {
         const newHono = new Hono();
@@ -58,17 +58,25 @@ class Hono {
         if (middleware.constructor.name !== 'AsyncFunction') {
             throw new TypeError('middleware must be a async function!');
         }
-        const router = new Router();
-        router.add(node_1.METHOD_NAME_OF_ALL, path, middleware);
+        const router = new this.routerClass();
+        router.add(router_1.METHOD_NAME_OF_ALL, path, middleware);
         this.middlewareRouters.push(router);
     }
+    onError(handler) {
+        this.errorHandler = handler;
+        return this;
+    }
+    notFound(handler) {
+        this.notFoundHandler = handler;
+        return this;
+    }
     // addRoute('get', '/', handler)
-    addRoute(method, path, ...args) {
+    addRoute(method, path, handler) {
         method = method.toUpperCase();
         if (this.tempPath) {
             path = (0, url_1.mergePath)(this.tempPath, path);
         }
-        this.router.add(method, path, args);
+        this.router.add(method, path, handler);
         return this;
     }
     async matchRoute(method, path) {
@@ -91,10 +99,10 @@ class Hono {
             const url = new URL(c.req.url);
             return url.searchParams.get(key);
         };
-        const handler = result ? result.handler[0] : this.notFound; // XXX
+        const handler = result ? result.handler : this.notFoundHandler;
         const middleware = [];
         for (const mr of this.middlewareRouters) {
-            const mwResult = mr.match(node_1.METHOD_NAME_OF_ALL, path);
+            const mwResult = mr.match(router_1.METHOD_NAME_OF_ALL, path);
             if (mwResult) {
                 middleware.push(mwResult.handler);
             }
@@ -108,44 +116,22 @@ class Hono {
             await next();
         };
         middleware.push(wrappedHandler);
-        const composed = (0, compose_1.compose)(middleware);
+        const composed = (0, compose_1.compose)(middleware, this.errorHandler);
         const c = new context_1.Context(request, { env: env, event: event, res: null });
-        await composed(c);
-        return c.res;
+        c.notFound = () => this.notFoundHandler(c);
+        const context = await composed(c);
+        return context.res;
     }
     async handleEvent(event) {
-        return this.dispatch(event.request, {}, event).catch((err) => {
-            return this.onError(err);
-        });
+        return this.dispatch(event.request, {}, event);
     }
     async fetch(request, env, event) {
-        return this.dispatch(request, env, event).catch((err) => {
-            return this.onError(err);
-        });
+        return this.dispatch(request, env, event);
     }
     fire() {
         addEventListener('fetch', (event) => {
             event.respondWith(this.handleEvent(event));
         });
     }
-    onError(err) {
-        console.error(`${err}`);
-        const message = 'Internal Server Error';
-        return new Response(message, {
-            status: 500,
-            headers: {
-                'Content-Length': message.length.toString(),
-            },
-        });
-    }
-    notFound() {
-        const message = 'Not Found';
-        return new Response(message, {
-            status: 404,
-            headers: {
-                'Content-Length': message.length.toString(),
-            },
-        });
-    }
 }
 exports.Hono = Hono;

package/dist/middleware/basic-auth/basic-auth.d.ts

@@ -3,4 +3,7 @@ export declare const basicAuth: (options: {
     username: string;
     password: string;
     realm?: string;
-}) => (ctx: Context, next: Function) => Promise<any>;
+}, ...users: {
+    username: string;
+    password: string;
+}[]) => (ctx: Context, next: Function) => Promise<any>;

package/dist/middleware/basic-auth/basic-auth.js

@@ -24,24 +24,33 @@ const auth = (req) => {
     }
     return { username: userPass[1], password: userPass[2] };
 };
-const basicAuth = (options) => {
+const basicAuth = (options, ...users) => {
+    if (!options) {
+        throw new Error('basic auth middleware requires options for "username and password"');
+    }
     if (!options.realm) {
         options.realm = 'Secure Area';
     }
+    users.unshift({ username: options.username, password: options.password });
     return async (ctx, next) => {
-        const user = auth(ctx.req);
-        const usernameEqual = user && (await (0, buffer_1.timingSafeEqual)(options.username, user.username));
-        const passwordEqual = user && (await (0, buffer_1.timingSafeEqual)(options.password, user.password));
-        if (!user || !usernameEqual || !passwordEqual) {
-            ctx.res = new Response('Unauthorized', {
-                status: 401,
-                headers: {
-                    'WWW-Authenticate': 'Basic realm="' + options.realm.replace(/"/g, '\\"') + '"',
-                },
-            });
-            return;
+        const requestUser = auth(ctx.req);
+        if (requestUser) {
+            for (const user of users) {
+                const usernameEqual = await (0, buffer_1.timingSafeEqual)(user.username, requestUser.username);
+                const passwordEqual = await (0, buffer_1.timingSafeEqual)(user.password, requestUser.password);
+                if (usernameEqual && passwordEqual) {
+                    // Authorized OK
+                    return next();
+                }
+            }
         }
-        return next();
+        ctx.res = new Response('Unauthorized', {
+            status: 401,
+            headers: {
+                'WWW-Authenticate': 'Basic realm="' + options.realm.replace(/"/g, '\\"') + '"',
+            },
+        });
+        return;
     };
 };
 exports.basicAuth = basicAuth;

package/dist/middleware/logger/logger.js

@@ -12,9 +12,7 @@ const humanize = (n, opts) => {
 };
 const time = (start) => {
     const delta = Date.now() - start;
-    return humanize([
-        delta < 10000 ? delta + 'ms' : Math.round(delta / 1000) + 's',
-    ]);
+    return humanize([delta < 10000 ? delta + 'ms' : Math.round(delta / 1000) + 's']);
 };
 const LogPrefix = {
     Outgoing: '-->',
@@ -45,19 +43,9 @@ const logger = (fn = console.log) => {
         const path = (0, url_1.getPathFromURL)(c.req.url);
         log(fn, LogPrefix.Incoming, method, path);
         const start = Date.now();
-        try {
-            await next();
-        }
-        catch (e) {
-            log(fn, LogPrefix.Error, method, path, c.res.status || 500, time(start));
-            throw e;
-        }
+        await next();
         const len = parseFloat(c.res.headers.get('Content-Length'));
-        const contentLength = isNaN(len)
-            ? '0'
-            : len < 1024
-                ? `${len}b`
-                : `${len / 1024}kB`;
+        const contentLength = isNaN(len) ? '0' : len < 1024 ? `${len}b` : `${len / 1024}kB`;
         log(fn, LogPrefix.Outgoing, method, path, c.res.status, time(start), contentLength);
     };
 };

package/dist/middleware/serve-static/serve-static.js

@@ -9,7 +9,11 @@ const serveStatic = (opt = { root: '' }) => {
     return async (c, next) => {
         await next();
         const url = new URL(c.req.url);
-        const path = (0, cloudflare_1.getKVFilePath)({ filename: url.pathname, root: opt.root, defaultDocument: DEFAULT_DOCUMENT });
+        const path = (0, cloudflare_1.getKVFilePath)({
+            filename: url.pathname,
+            root: opt.root,
+            defaultDocument: DEFAULT_DOCUMENT,
+        });
         const content = await (0, cloudflare_1.getContentFromKVAsset)(path);
         if (content) {
             const mimeType = (0, mime_1.getMimeType)(path);

package/dist/router/reg-exp-router/index.d.ts

@@ -0,0 +1 @@
+export { RegExpRouter } from './router';

package/dist/router/reg-exp-router/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegExpRouter = void 0;
+var router_1 = require("./router");
+Object.defineProperty(exports, "RegExpRouter", { enumerable: true, get: function () { return router_1.RegExpRouter; } });

package/dist/router/reg-exp-router/node.d.ts

@@ -0,0 +1,13 @@
+export declare type ParamMap = Array<[string, number]>;
+export interface Context {
+    varIndex: number;
+}
+export declare class Node {
+    index?: number;
+    varIndex?: number;
+    children: {
+        [key: string]: Node;
+    };
+    insert(tokens: readonly string[], index: number, paramMap: ParamMap, context: Context): void;
+    buildRegExpStr(): string;
+}

package/dist/router/reg-exp-router/node.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Node = void 0;
+const LABEL_REG_EXP_STR = '[^/]+';
+const ONLY_WILDCARD_REG_EXP_STR = '.*';
+const TAIL_WILDCARD_REG_EXP_STR = '(?:|/.*)';
+/**
+ * Sort order:
+ * 1. literal
+ * 2. special pattern (e.g. :label{[0-9]+})
+ * 3. common label pattern (e.g. :label)
+ * 4. wildcard
+ */
+function compareKey(a, b) {
+    if (a.length === 1) {
+        return b.length === 1 ? (a < b ? -1 : 1) : -1;
+    }
+    if (b.length === 1) {
+        return 1;
+    }
+    // wildcard
+    if (a === ONLY_WILDCARD_REG_EXP_STR || a === TAIL_WILDCARD_REG_EXP_STR) {
+        return 1;
+    }
+    else if (b === ONLY_WILDCARD_REG_EXP_STR || b === TAIL_WILDCARD_REG_EXP_STR) {
+        return -1;
+    }
+    // label
+    if (a === LABEL_REG_EXP_STR) {
+        return 1;
+    }
+    else if (b === LABEL_REG_EXP_STR) {
+        return -1;
+    }
+    return a.length === b.length ? (a < b ? -1 : 1) : b.length - a.length;
+}
+class Node {
+    constructor() {
+        this.children = {};
+    }
+    insert(tokens, index, paramMap, context) {
+        var _a;
+        if (tokens.length === 0) {
+            this.index = index;
+            return;
+        }
+        const [token, ...restTokens] = tokens;
+        const pattern = token === '*'
+            ? restTokens.length === 0
+                ? ['', '', ONLY_WILDCARD_REG_EXP_STR] // '*' matches to all the trailing paths
+                : ['', '', LABEL_REG_EXP_STR]
+            : token === '/*'
+                ? ['', '', TAIL_WILDCARD_REG_EXP_STR] // '/path/to/*' is /\/path\/to(?:|/.*)$
+                : token.match(/^\:([^\{\}]+)(?:\{(.+)\})?$/);
+        let node;
+        if (pattern) {
+            const name = pattern[1];
+            const regexpStr = pattern[2] || LABEL_REG_EXP_STR;
+            node = this.children[regexpStr];
+            if (!node) {
+                node = this.children[regexpStr] = new Node();
+                if (name !== '') {
+                    node.varIndex = context.varIndex++;
+                }
+            }
+            if (name !== '') {
+                paramMap.push([name, node.varIndex]);
+            }
+        }
+        else {
+            node = (_a = this.children)[token] || (_a[token] = new Node());
+        }
+        node.insert(restTokens, index, paramMap, context);
+    }
+    buildRegExpStr() {
+        const strList = Object.keys(this.children)
+            .sort(compareKey)
+            .map((k) => {
+            const c = this.children[k];
+            return (typeof c.varIndex === 'number' ? `(${k})@${c.varIndex}` : k) + c.buildRegExpStr();
+        });
+        if (typeof this.index === 'number') {
+            strList.push(`#${this.index}`);
+        }
+        if (strList.length === 0) {
+            return '';
+        }
+        if (strList.length === 1) {
+            return strList[0];
+        }
+        return '(?:' + strList.join('|') + ')';
+    }
+}
+exports.Node = Node;

package/dist/router/reg-exp-router/router.d.ts

@@ -0,0 +1,18 @@
+import { Router, Result } from '../../router';
+import type { ParamMap, ReplacementMap } from './trie';
+declare type Route<T> = [string, T];
+declare type HandlerData<T> = [T, ParamMap];
+declare type Matcher<T> = [RegExp | true, ReplacementMap, HandlerData<T>[]];
+export declare class RegExpRouter<T> extends Router<T> {
+    routes?: {
+        [method: string]: Route<T>[];
+    };
+    matchers?: {
+        [method: string]: Matcher<T> | null;
+    };
+    add(method: string, path: string, handler: T): void;
+    match(method: string, path: string): Result<T> | null;
+    private buildAllMatchers;
+    private buildMatcher;
+}
+export {};

package/dist/router/reg-exp-router/router.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegExpRouter = void 0;
+const router_1 = require("../../router");
+const trie_1 = require("./trie");
+class RegExpRouter extends router_1.Router {
+    constructor() {
+        super(...arguments);
+        this.routes = {};
+        this.matchers = null;
+    }
+    add(method, path, handler) {
+        var _a;
+        if (!this.routes) {
+            throw new Error('Can not add a route since the matcher is already built.');
+        }
+        (_a = this.routes)[method] || (_a[method] = []);
+        this.routes[method].push([path, handler]);
+    }
+    match(method, path) {
+        if (!this.matchers) {
+            this.buildAllMatchers();
+        }
+        const matcher = this.matchers[method] || this.matchers[router_1.METHOD_NAME_OF_ALL];
+        if (!matcher) {
+            return null;
+        }
+        const [regexp, replacementMap, handlers] = matcher;
+        if (regexp === true) {
+            // '*'
+            return new router_1.Result(handlers[0][0], {});
+        }
+        const match = path.match(regexp);
+        if (!match) {
+            return null;
+        }
+        if (!replacementMap) {
+            // there is only one route and no capture
+            return new router_1.Result(handlers[0][0], {});
+        }
+        const index = match.indexOf('', 1);
+        const [handler, paramMap] = handlers[replacementMap[index]];
+        const params = {};
+        for (let i = 0; i < paramMap.length; i++) {
+            params[paramMap[i][0]] = match[paramMap[i][1]];
+        }
+        return new router_1.Result(handler, params);
+    }
+    buildAllMatchers() {
+        this.matchers || (this.matchers = {});
+        Object.keys(this.routes).forEach((method) => {
+            this.buildMatcher(method);
+        });
+        delete this.routes; // to reduce memory usage
+    }
+    buildMatcher(method) {
+        this.matchers || (this.matchers = {});
+        const trie = new trie_1.Trie();
+        const handlers = [];
+        const targetMethods = [method];
+        if (method !== router_1.METHOD_NAME_OF_ALL) {
+            targetMethods.unshift(router_1.METHOD_NAME_OF_ALL);
+        }
+        const routes = targetMethods.flatMap((method) => this.routes[method] || []);
+        if (routes.length === 0) {
+            this.matchers[method] = null;
+            return;
+        }
+        if (routes.length === 1 && routes[0][0] === '*') {
+            this.matchers[method] = [true, null, [[routes[0][1], []]]];
+            return;
+        }
+        if (routes.length === 1 && !routes[0][0].match(/:/)) {
+            // there is only one route and no capture
+            const tmp = routes[0][0].endsWith('*')
+                ? routes[0][0].replace(/\/\*$/, '(?:$|/)') // /path/to/* => /path/to(?:$|/)
+                : `${routes[0][0]}$`; // /path/to/action => /path/to/action$
+            const regExpStr = `^${tmp.replace(/\*/g, '[^/]+')}`; // /prefix/*/path/to => /prefix/[^/]+/path/to
+            this.matchers[method] = [new RegExp(regExpStr), null, [[routes[0][1], []]]];
+            return;
+        }
+        for (let i = 0; i < routes.length; i++) {
+            const paramMap = trie.insert(routes[i][0], i);
+            handlers[i] = [routes[i][1], paramMap];
+        }
+        const [regexp, indexReplacementMap, paramReplacementMap] = trie.buildRegExp();
+        for (let i = 0; i < handlers.length; i++) {
+            const paramMap = handlers[i][1];
+            for (let i = 0; i < paramMap.length; i++) {
+                paramMap[i][1] = paramReplacementMap[paramMap[i][1]];
+            }
+        }
+        this.matchers[method] = [new RegExp(regexp), indexReplacementMap, handlers];
+    }
+}
+exports.RegExpRouter = RegExpRouter;

package/dist/router/reg-exp-router/trie.d.ts

@@ -0,0 +1,10 @@
+import type { ParamMap, Context } from './node';
+import { Node } from './node';
+export type { ParamMap } from './node';
+export declare type ReplacementMap = number[];
+export declare class Trie {
+    context: Context;
+    root: Node;
+    insert(path: string, index: number): ParamMap;
+    buildRegExp(): [RegExp, ReplacementMap, ReplacementMap];
+}

package/dist/router/reg-exp-router/trie.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Trie = void 0;
+const node_1 = require("./node");
+class Trie {
+    constructor() {
+        this.context = { varIndex: 0 };
+        this.root = new node_1.Node();
+    }
+    insert(path, index) {
+        const paramMap = [];
+        /**
+         *  - pattern (:label, :label{0-9]+}, ...)
+         *  - /* wildcard
+         *  - character
+         */
+        const tokens = path.match(/(?::[^\/]+)|(?:\/\*$)|./g);
+        this.root.insert(tokens, index, paramMap, this.context);
+        return paramMap;
+    }
+    buildRegExp() {
+        let regexp = this.root.buildRegExpStr();
+        let captureIndex = 0;
+        const indexReplacementMap = [];
+        const paramReplacementMap = [];
+        regexp = regexp.replace(/#(\d+)|@(\d+)|\.\*\$/g, (_, handlerIndex, paramIndex) => {
+            if (typeof handlerIndex !== 'undefined') {
+                indexReplacementMap[++captureIndex] = Number(handlerIndex);
+                return '$()';
+            }
+            if (typeof paramIndex !== 'undefined') {
+                paramReplacementMap[Number(paramIndex)] = ++captureIndex;
+                return '';
+            }
+            return '';
+        });
+        return [new RegExp(`^${regexp}`), indexReplacementMap, paramReplacementMap];
+    }
+}
+exports.Trie = Trie;

package/dist/router/trie-router/index.d.ts

@@ -0,0 +1 @@
+export { TrieRouter } from './router';

package/dist/router/trie-router/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrieRouter = void 0;
+var router_1 = require("./router");
+Object.defineProperty(exports, "TrieRouter", { enumerable: true, get: function () { return router_1.TrieRouter; } });

package/dist/{node.d.ts → router/trie-router/node.d.ts}

@@ -1,14 +1,11 @@
-export declare const METHOD_NAME_OF_ALL = "ALL";
-export declare class Result<T> {
-    handler: T;
-    params: Record<string, string>;
-    constructor(handler: T, params: Record<string, string>);
-}
+import type { Pattern } from '../../utils/url';
+import { Result } from '../../router';
 export declare class Node<T> {
     method: Record<string, T>;
     handler: T;
     children: Record<string, Node<T>>;
     middlewares: [];
+    patterns: Pattern[];
     constructor(method?: string, handler?: T, children?: Record<string, Node<T>>);
     insert(method: string, path: string, handler: T): Node<T>;
     search(method: string, path: string): Result<T>;