hono 1.5.1 → 1.6.0

package/README.md

@@ -32,8 +32,14 @@ app.fire()
 - **Middleware** - built-in middleware and ability to extend with your own middleware.
 - **TypeScript** - first-class TypeScript support.
 - **Optimized** - for Cloudflare Workers.
+- **Deno** - support for Deno (Experimental).
 
-## Benchmark
+## Benchmarks
+
+### Cloudflare Workers
+
+- Machine: Apple MacBook Pro, 32 GiB, M1 Pro
+- Scripts: [benchmarks/handle-event](https://github.com/honojs/hono/tree/master/benchmarks/handle-event)
 
 **Hono is fastest**, compared to other routers for Cloudflare Workers.
 
@@ -47,6 +53,22 @@ Fastest is hono - regexp-router
 ✨  Done in 43.56s.
 ```
 
+### Deno
+
+- Machine: Apple MacBook Pro, 32 GiB, M1 Pro, Deno v1.22.0
+- Scripts: [benchmarks/deno](https://github.com/honojs/hono/tree/master/benchmarks/deno)
+- Method: `autocannon -c 100 -d 40 -p 10 'http://127.0.0.1:8000/user/lookup/username/foo'`
+
+**Hono is fastest**, compared to other frameworks for Deno.
+
+| Framework                     | Version |                                   Results |
+| ----------------------------- | :-----: | ----------------------------------------: |
+| **Hono - RegExpRouter**       |  1.6.0  | **5118k requests in 40.02s, 865 MB read** |
+| **Hono - TriRouter(default)** |  1.6.0  | **4932k requests in 40.02s, 833 MB read** |
+| Faster                        |   5.7   |     3579k requests in 40.02s, 551 MB read |
+| oak                           | 10.5.1  |     2385k requests in 40.02s, 403 MB read |
+| opine                         |  2.2.0  |     1491k requests in 40.02s, 346 MB read |
+
 ## Why so fast?
 
 Routers used in Hono are really smart.
@@ -734,6 +756,34 @@ export default app
 
 - Hono Examples - <https://github.com/honojs/examples>
 
+## Deno
+
+Hono also works with Deno. This feature is still experimental.
+
+```tsx
+/** @jsx jsx */
+import { serve } from 'https://deno.land/std@0.146.0/http/server.ts'
+import { Hono, logger, poweredBy, basicAuth, jsx } from 'https://deno.land/x/hono/mod.ts'
+
+const app = new Hono()
+
+app.use('*', logger(), poweredBy())
+app.get(
+  '/auth/*',
+  basicAuth({
+    username: 'deno',
+    password: 'isacool',
+  })
+)
+
+app.get('/', (c) => {
+  return c.html(<h1>Hello Deno!</h1>)
+})
+app.get('/auth/abc', (c) => c.text('You are authorized'))
+
+serve(app.fire())
+```
+
 ## Related projects
 
 Implementation of the original router `TrieRouter` is inspired by [goblin](https://github.com/bmf-san/goblin). `RegExpRouter` is inspired by [Router::Boom](https://github.com/tokuhirom/Router-Boom). API design is inspired by [express](https://github.com/expressjs/express) and [koa](https://github.com/koajs/koa). [itty-router](https://github.com/kwhitley/itty-router), [Sunder](https://github.com/SunderJS/sunder), and [worktop](https://github.com/lukeed/worktop) are the other routers or frameworks for Cloudflare Workers.

package/dist/context.d.ts

@@ -17,8 +17,7 @@ export declare class Context<RequestParamKeyType extends string = string, E = En
     private _headers;
     private _res;
     private notFoundHandler;
-    render: (content: string, params?: object, options?: object) => Response | Promise<Response>;
-    constructor(req: Request<RequestParamKeyType>, env?: E | undefined, eventOrExecutionCtx?: FetchEvent | ExecutionContext | undefined, notFoundHandler?: NotFoundHandler);
+    constructor(req: Request, env?: E | undefined, eventOrExecutionCtx?: FetchEvent | ExecutionContext | undefined, notFoundHandler?: NotFoundHandler);
     get res(): Response;
     set res(_res: Response);
     header(name: string, value: string): void;
@@ -29,7 +28,7 @@ export declare class Context<RequestParamKeyType extends string = string, E = En
     newResponse(data: Data | null, status: StatusCode, headers?: Headers): Response;
     body(data: Data | null, status?: StatusCode, headers?: Headers): Response;
     text(text: string, status?: StatusCode, headers?: Headers): Response;
-    json(object: object, status?: StatusCode, headers?: Headers): Response;
+    json<T>(object: T, status?: StatusCode, headers?: Headers): Response;
     html(html: string, status?: StatusCode, headers?: Headers): Response;
     redirect(location: string, status?: StatusCode): Response;
     notFound(): Response | Promise<Response>;

package/dist/context.js

@@ -8,13 +8,13 @@ class Context {
         this._pretty = false;
         this._prettySpace = 2;
         this.req = req;
-        if (env) {
-            this.env = env;
-        }
-        this.executionCtx = eventOrExecutionCtx;
+        this.env = env ? env : {};
         if (eventOrExecutionCtx && 'respondWith' in eventOrExecutionCtx) {
             this.event = eventOrExecutionCtx;
         }
+        else {
+            this.executionCtx = eventOrExecutionCtx;
+        }
         this.notFoundHandler = notFoundHandler;
         this.finalized = false;
     }

package/dist/hono.d.ts

@@ -50,6 +50,5 @@ export declare class Hono<E extends Env = Env, P extends string = '/'> extends H
     handleEvent(event: FetchEvent): Promise<Response>;
     fetch(request: Request, env?: E, executionCtx?: ExecutionContext): Promise<Response>;
     request(input: RequestInfo, requestInit?: RequestInit): Promise<Response>;
-    fire(): void;
 }
 export {};

package/dist/hono.js

@@ -29,7 +29,7 @@ class Hono extends defineDynamicClass() {
             const message = 'Internal Server Error';
             return c.text(message, 500);
         };
-        (0, request_1.extendRequestPrototype)(); // FIXME: should be executed at a better timing
+        (0, request_1.extendRequestPrototype)();
         const allMethods = [...methods, router_1.METHOD_NAME_ALL_LOWERCASE];
         allMethods.map((method) => {
             this[method] = (args1, ...args) => {
@@ -91,13 +91,13 @@ class Hono extends defineDynamicClass() {
     matchRoute(method, path) {
         return this.router.match(method, path);
     }
-    async dispatch(request, executionCtx, env) {
+    async dispatch(request, eventOrExecutionCtx, env) {
         const path = (0, url_1.getPathFromURL)(request.url, this.strict);
         const method = request.method;
         const result = this.matchRoute(method, path);
         request.paramData = result?.params;
         const handlers = result ? result.handlers : [this.notFoundHandler];
-        const c = new context_1.Context(request, env, executionCtx, this.notFoundHandler);
+        const c = new context_1.Context(request, env, eventOrExecutionCtx, this.notFoundHandler);
         const composed = (0, compose_1.compose)(handlers, this.errorHandler, this.notFoundHandler);
         let context;
         try {
@@ -124,10 +124,5 @@ class Hono extends defineDynamicClass() {
         const req = input instanceof Request ? input : new Request(input, requestInit);
         return this.dispatch(req);
     }
-    fire() {
-        addEventListener('fetch', (event) => {
-            event.respondWith(this.handleEvent(event));
-        });
-    }
 }
 exports.Hono = Hono;

package/dist/index.d.ts

@@ -1,5 +1,11 @@
 /// <reference path="request.d.ts" />
-export { Hono } from './hono';
+import { Hono } from './hono';
 export type { Handler, Next } from './hono';
 export { Context } from './context';
 export type { Env } from './context';
+declare module './hono' {
+    interface Hono {
+        fire(): void;
+    }
+}
+export { Hono };

package/dist/index.js

@@ -2,8 +2,13 @@
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference
 /// <reference path="./request.ts" /> Import "declare global" for the Request interface.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = exports.Hono = void 0;
-var hono_1 = require("./hono");
+exports.Hono = exports.Context = void 0;
+const hono_1 = require("./hono");
 Object.defineProperty(exports, "Hono", { enumerable: true, get: function () { return hono_1.Hono; } });
 var context_1 = require("./context");
 Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });
+hono_1.Hono.prototype.fire = function () {
+    addEventListener('fetch', (event) => {
+        void event.respondWith(this.handleEvent(event));
+    });
+};

package/dist/middleware/mustache/mustache.d.ts

@@ -1,6 +1,11 @@
 /// <reference types="@cloudflare/workers-types" />
 import type { Context } from '../../context';
 import type { Next } from '../../hono';
+declare module '../../context' {
+    interface Context {
+        render: (content: string, params?: object, options?: object) => Response | Promise<Response>;
+    }
+}
 export declare type MustacheOptions = {
     root: string;
     manifest?: object | string;

package/dist/middleware/serve-static/serve-static.d.ts

@@ -2,7 +2,8 @@
 import type { Env } from '../../context';
 import type { Handler } from '../../hono';
 export declare type ServeStaticOptions = {
-    root: string;
+    root?: string;
+    path?: string;
     manifest?: object | string;
     namespace?: KVNamespace;
 };

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

@@ -13,7 +13,7 @@ const serveStatic = (options = { root: '' }) => {
         }
         const url = new URL(c.req.url);
         const path = (0, cloudflare_1.getKVFilePath)({
-            filename: url.pathname,
+            filename: options.path ?? url.pathname,
             root: options.root,
             defaultDocument: DEFAULT_DOCUMENT,
         });

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

@@ -22,6 +22,7 @@ class Node {
         this.order = 0;
         this.children = children || {};
         this.methods = [];
+        this.name = '';
         if (method && handler) {
             const m = {};
             m[method] = { handler: handler, score: 0, name: this.name };

package/dist/utils/cloudflare.js

@@ -50,7 +50,7 @@ const getKVFilePath = (options) => {
         filename = filename.concat('/' + defaultDocument);
     }
     // /foo.html => foo.html
-    filename = filename.replace(/^\//, '');
+    filename = filename.replace(/^\.?\//, '');
     // assets/ => assets
     root = root.replace(/\/$/, '');
     // ./assets/foo.html => assets/foo.html

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,9 +11,11 @@
     "test": "jest",
     "lint": "eslint --ext js,ts src .eslintrc.js",
     "lint:fix": "eslint --ext js,ts src .eslintrc.js --fix",
+    "denoify": "rimraf deno_dist && denoify",
     "build": "rimraf dist && tsc --project tsconfig.build.esm.json && tsc --project tsconfig.build.json",
     "watch": "tsc --project tsconfig.build.json -w",
-    "prepublishOnly": "yarn build"
+    "prerelease": "yarn denoify && yarn build",
+    "release": "np"
   },
   "exports": {
     ".": "./dist/index.js",
@@ -112,6 +114,9 @@
     "type": "git",
     "url": "https://github.com/honojs/hono.git"
   },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
   "homepage": "https://github.com/honojs/hono",
   "keywords": [
     "web",
@@ -134,6 +139,7 @@
     "@typescript-eslint/eslint-plugin": "^5.21.0",
     "@typescript-eslint/parser": "^5.21.0",
     "crypto-js": "^4.1.1",
+    "denoify": "^0.11.1",
     "eslint": "^8.14.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-define-config": "^1.4.0",
@@ -145,8 +151,9 @@
     "form-data": "^4.0.0",
     "graphql": "^16.4.0",
     "jest": "27.5.1",
-    "jest-environment-miniflare": "^2.5.0",
+    "jest-environment-miniflare": "^2.5.1",
     "mustache": "^4.2.0",
+    "np": "^7.6.2",
     "prettier": "^2.6.2",
     "prettier-plugin-md-nocjsp": "^1.2.0",
     "rimraf": "^3.0.2",
@@ -156,4 +163,4 @@
   "engines": {
     "node": ">=11.0.0"
   }
-}
+}