hono 0.5.2 → 0.5.5

package/README.md

@@ -1,4 +1,10 @@
-# Hono
+# Hono\[炎\]
+
+<p>
+<a href="https://github.com/yusukebe/hono/blob/master/README.md">English</a>
+&#x000B7;
+<a href="https://github.com/yusukebe/hono/blob/master/docs/README.ja.md">日本語</a>
+</p>
 
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/yusukebe/hono/ci)](https://github.com/yusukebe/hono/actions)
 [![GitHub](https://img.shields.io/github/license/yusukebe/hono)](https://github.com/yusukebe/hono/blob/master/LICENSE)
@@ -8,7 +14,7 @@
 [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/yusukebe/hono)](https://github.com/yusukebe/hono/pulse)
 [![GitHub last commit](https://img.shields.io/github/last-commit/yusukebe/hono)](https://github.com/yusukebe/hono/commits/master)
 
-Hono[炎] - _**means flame🔥 in Japanese**_ - is small, simple, and ultrafast web framework for Service Worker based serverless applications like Cloudflare Workers and Fastly Compute@Edge.
+Hono[炎] - _**means flame🔥 in Japanese**_ - is small, simple, and ultrafast web framework for Cloudflare Workers and Fastly Compute@Edge.
 
 ```js
 import { Hono } from 'hono'
@@ -22,7 +28,7 @@ app.fire()
 ## Features
 
 - **Ultrafast** - the router does not use linear loops.
-- **Zero-dependencies** - using only Web standard API.
+- **Zero-dependencies** - using only Service Worker and Web standard API.
 - **Middleware** - built-in middleware and ability to extend with your own middleware.
 - **Optimized** - for Cloudflare Workers.
 
@@ -53,13 +59,13 @@ Now, the named path parameter has types.
 
 You can install Hono from the npm registry.
 
-```sh
+```
 $ yarn add hono
 ```
 
 or
 
-```sh
+```
 $ npm install hono
 ```
 
@@ -75,6 +81,7 @@ An instance of `Hono` has these methods.
 - app.**onError**(err, handler)
 - app.**fire**()
 - app.**fetch**(request, env, event)
+- app.**request**(path, option)
 
 ## Routing
 
@@ -149,6 +156,8 @@ app.get('/fetch-url', async (c) => {
 
 ### Built-in Middleware
 
+Hono has built-in middleware.
+
 ```js
 import { Hono } from 'hono'
 import { poweredBy } from 'hono/powered-by'
@@ -213,7 +222,7 @@ app.onError((err, c) => {
 
 ## Context
 
-To handle Request and Reponse, you can use Context object.
+To handle Request and Reponse, you can use `Context` object.
 
 ### c.req
 
@@ -303,7 +312,7 @@ app.get('/', (c) => {
 
 ### c.notFound()
 
-Return the `404 Not Found` Response.
+Return the `Not Found` Response.
 
 ```js
 app.get('/notfound', (c) => {
@@ -379,6 +388,17 @@ export default app
 */
 ```
 
+## request
+
+`request` is a useful method for testing.
+
+```js
+test('GET /hello is ok', async () => {
+  const res = await app.request('http://localhost/hello')
+  expect(res.status).toBe(200)
+})
+```
+
 ## Cloudflare Workers with Hono
 
 Using [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/) or [Miniflare](https://miniflare.dev), you can develop the application locally and publish it with few commands.
@@ -400,10 +420,10 @@ Let's write your first code for Cloudflare Workers with Hono.
 
 Make a npm skeleton directory.
 
-```sh
-mkdir hono-example
-cd hono-example
-npm init -y
+```
+$ mkdir hono-example
+$ cd hono-example
+$ npm init -y
 ```
 
 ### 2. `wrangler init`
@@ -426,7 +446,7 @@ Would you like to create a Worker at src/index.js? (y/n) <--- n
 
 Install `hono` from the npm registry.
 
-```sh
+```
 $ npm i hono
 ```
 
@@ -448,7 +468,7 @@ app.fire()
 
 Run the development server locally. Then, access `http://127.0.0.1:8787/` in your Web browser.
 
-```sh
+```
 $ npx wrangler@beta dev index.js
 ```
 
@@ -456,7 +476,7 @@ $ npx wrangler@beta dev index.js
 
 Deploy to Cloudflare. That's all!
 
-```sh
+```
 $ npx wrangler@beta publish index.js
 ```
 

package/dist/context.js

@@ -35,8 +35,8 @@ class Context {
         this._statusText = (0, http_status_1.getStatusText)(number);
     }
     newResponse(data, init = {}) {
-        init.status = init.status || this._status;
-        init.statusText = init.statusText || this._statusText;
+        init.status = init.status || this._status || 200;
+        init.statusText = init.statusText || this._statusText || (0, http_status_1.getStatusText)(init.status);
         init.headers = Object.assign(Object.assign({}, this._headers), init.headers);
         // Content-Length
         let length = 0;

package/dist/hono.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="@cloudflare/workers-types" />
 import { Context } from './context';
 import type { Env } from './context';
-import type { Result, Router } from './router';
+import type { Router } from './router';
 declare global {
     interface Request<ParamKeyType = string> {
         param: (key: ParamKeyType) => string;
@@ -26,25 +26,34 @@ export declare class Hono {
     middlewareRouters: Router<MiddlewareHandler>[];
     tempPath: string;
     constructor(init?: Partial<Pick<Hono, 'routerClass' | 'strict'>>);
-    notFoundHandler: NotFoundHandler;
-    errorHandler: ErrorHandler;
+    private notFoundHandler;
+    private errorHandler;
     get<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    get(path: string, handler: Handler<string>): Hono;
     post<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    post(path: string, handler: Handler<string>): Hono;
     put<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    put(path: string, handler: Handler<string>): Hono;
     head<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    head(path: string, handler: Handler<string>): Hono;
     delete<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    delete(path: string, handler: Handler<string>): Hono;
     options<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    options(path: string, handler: Handler<string>): Hono;
     patch<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    patch(path: string, handler: Handler<string>): Hono;
     all<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    all(path: string, handler: Handler<string>): Hono;
     route(path: string): Hono;
     use(path: string, middleware: MiddlewareHandler): void;
     onError(handler: ErrorHandler): Hono;
     notFound(handler: NotFoundHandler): Hono;
-    addRoute(method: string, path: string, handler: Handler): Hono;
-    matchRoute(method: string, path: string): Promise<Result<Handler>>;
+    private addRoute;
+    private matchRoute;
     dispatch(request: Request, env?: Env, event?: FetchEvent): Promise<Response>;
     handleEvent(event: FetchEvent): Promise<Response>;
     fetch(request: Request, env?: Env, event?: FetchEvent): Promise<Response>;
+    request(input: RequestInfo, requestInit?: RequestInit): Promise<Response>;
     fire(): void;
 }
 export {};

package/dist/hono.js

@@ -128,6 +128,10 @@ class Hono {
     async fetch(request, env, event) {
         return this.dispatch(request, env, event);
     }
+    request(input, requestInit) {
+        const req = new Request(input, requestInit);
+        return this.dispatch(req);
+    }
     fire() {
         addEventListener('fetch', (event) => {
             event.respondWith(this.handleEvent(event));

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

@@ -5,9 +5,7 @@ export interface Context {
 export declare class Node {
     index?: number;
     varIndex?: number;
-    children: {
-        [key: string]: Node;
-    };
+    children: Record<string, Node>;
     insert(tokens: readonly string[], index: number, paramMap: ParamMap, context: Context): void;
     buildRegExpStr(): string;
 }

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

@@ -1,15 +1,7 @@
 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;
-    };
+    routes?: Record<string, Route<T>[]>;
     add(method: string, path: string, handler: T): void;
     match(method: string, path: string): Result<T> | null;
     private buildAllMatchers;

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

@@ -3,11 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RegExpRouter = void 0;
 const router_1 = require("../../router");
 const trie_1 = require("./trie");
+const regExpMatchAll = new RegExp('');
+const emptyParam = {};
 class RegExpRouter extends router_1.Router {
     constructor() {
         super(...arguments);
         this.routes = {};
-        this.matchers = null;
     }
     add(method, path, handler) {
         var _a;
@@ -18,43 +19,54 @@ class RegExpRouter extends router_1.Router {
         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]];
+        const matchers = this.buildAllMatchers();
+        let match;
+        // Optimization for middleware
+        const methods = Object.keys(matchers);
+        if (methods.length === 1 && methods[0] === router_1.METHOD_NAME_OF_ALL) {
+            const [regexp, handlers] = matchers[router_1.METHOD_NAME_OF_ALL];
+            if (handlers.length === 1) {
+                const result = new router_1.Result(handlers[0][0], emptyParam);
+                if (regexp === regExpMatchAll) {
+                    match = () => result;
+                }
+                else if (handlers.length === 1 && !handlers[0][1]) {
+                    match = (_, path) => (regexp.test(path) ? result : null);
+                }
+            }
         }
-        return new router_1.Result(handler, params);
+        match || (match = (method, path) => {
+            const matcher = matchers[method] || matchers[router_1.METHOD_NAME_OF_ALL];
+            if (!matcher) {
+                return null;
+            }
+            const match = path.match(matcher[0]);
+            if (!match) {
+                return null;
+            }
+            const index = match.indexOf('', 1);
+            const [handler, paramMap] = matcher[1][index];
+            if (!paramMap) {
+                return new router_1.Result(handler, emptyParam);
+            }
+            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);
+        });
+        this.match = match;
+        return this.match(method, path);
     }
     buildAllMatchers() {
-        this.matchers || (this.matchers = {});
+        const matchers = {};
         Object.keys(this.routes).forEach((method) => {
-            this.buildMatcher(method);
+            matchers[method] = this.buildMatcher(method);
         });
         delete this.routes; // to reduce memory usage
+        return matchers;
     }
     buildMatcher(method) {
-        this.matchers || (this.matchers = {});
         const trie = new trie_1.Trie();
         const handlers = [];
         const targetMethods = [method];
@@ -63,34 +75,40 @@ class RegExpRouter extends router_1.Router {
         }
         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;
+            return null;
         }
-        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;
+        if (method === router_1.METHOD_NAME_OF_ALL) {
+            if (routes.length === 1 && routes[0][0] === '*') {
+                return [regExpMatchAll, [[routes[0][1], null]]];
+            }
+            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
+                return [new RegExp(regExpStr), [[routes[0][1], null]]];
+            }
         }
         for (let i = 0; i < routes.length; i++) {
             const paramMap = trie.insert(routes[i][0], i);
-            handlers[i] = [routes[i][1], paramMap];
+            handlers[i] = [routes[i][1], Object.keys(paramMap).length !== 0 ? paramMap : null];
         }
         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]];
+            if (paramMap) {
+                for (let i = 0; i < paramMap.length; i++) {
+                    paramMap[i][1] = paramReplacementMap[paramMap[i][1]];
+                }
             }
         }
-        this.matchers[method] = [new RegExp(regexp), indexReplacementMap, handlers];
+        const handlerMap = [];
+        // using `in` because indexReplacementMap is a sparse array
+        for (const i in indexReplacementMap) {
+            handlerMap[i] = handlers[indexReplacementMap[i]];
+        }
+        return [regexp, handlerMap];
     }
 }
 exports.RegExpRouter = RegExpRouter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "0.5.2",
+  "version": "0.5.5",
   "description": "[炎] Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,10 +20,12 @@
     "./body-parse": "./dist/middleware/body-parse/body-parse.js",
     "./cookie": "./dist/middleware/cookie/cookie.js",
     "./cors": "./dist/middleware/cors/cors.js",
+    "./etag": "./dist/middleware/etag/etag.js",
     "./logger": "./dist/middleware/logger/logger.js",
     "./mustache": "./dist/middleware/mustache/mustache.js",
     "./powered-by": "./dist/middleware/powered-by/powered-by.js",
     "./serve-static": "./dist/middleware/serve-static/serve-static.js",
+    "./router/trie-router": "./dist/router/trie-router/router.js",
     "./router/reg-exp-router": "./dist/router/reg-exp-router/index.js"
   },
   "typesVersions": {
@@ -40,6 +42,9 @@
       "cors": [
         "./dist/middleware/cors/cors.d.ts"
       ],
+      "etag": [
+        "./dist/middleware/etag/etag.d.ts"
+      ],
       "logger": [
         "./dist/middleware/logger/logger.d.ts"
       ],
@@ -52,6 +57,9 @@
       "serve-static": [
         "./dist/middleware/serve-static/serve-static.d.ts"
       ],
+      "router/trie-router": [
+        "./dist/router/trie-router/router.d.ts"
+      ],
       "router/reg-exp-router": [
         "./dist/router/reg-exp-router/router.d.ts"
       ]
@@ -98,6 +106,7 @@
     "jest-environment-miniflare": "^2.0.0",
     "mustache": "^4.2.0",
     "prettier": "^2.5.1",
+    "prettier-plugin-md-nocjsp": "^1.2.0",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.1.2",
     "typescript": "^4.5.5"