hono 1.5.2 → 1.6.1

package/README.md

@@ -13,8 +13,9 @@
 [![npm type definitions](https://img.shields.io/npm/types/hono)](https://www.npmjs.com/package/hono)
 [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/honojs/hono)](https://github.com/honojs/hono/pulse)
 [![GitHub last commit](https://img.shields.io/github/last-commit/honojs/hono)](https://github.com/honojs/hono/commits/master)
+[![Deno badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Flatest-version%2Fx%2Fhono%2Fmod.ts)](https://doc.deno.land/https/deno.land/x/hono/mod.ts)
 
-Hono - _**[炎] means flame🔥 in Japanese**_ - is a small, simple, and ultrafast web framework for Cloudflare Workers or Service Worker based serverless such as Fastly Compute@Edge.
+Hono - _**[炎] means flame🔥 in Japanese**_ - is a small, simple, and ultrafast web framework for Cloudflare Workers, Deno, and others.
 
 ```ts
 import { Hono } from 'hono'
@@ -31,9 +32,14 @@ app.fire()
 - **Zero-dependencies** - using only Service Worker and Web Standard API.
 - **Middleware** - built-in middleware and ability to extend with your own middleware.
 - **TypeScript** - first-class TypeScript support.
-- **Optimized** - for Cloudflare Workers.
+- **Multi-platform** - works on Cloudflare Workers, Fastly Compute@Edge, or Deno.
 
-## 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,27 @@ 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, serveStatic, jsx } from 'https://deno.land/x/hono/mod.ts'
+
+const app = new Hono()
+
+app.use('*', logger(), poweredBy())
+
+app.get('/favicon.ico', serveStatic({ path: './public/favicon.ico' }))
+app.get('/', (c) => {
+  return c.html(<h1>Hello Deno!</h1>)
+})
+
+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

@@ -1,12 +1,11 @@
 /// <reference types="@cloudflare/workers-types" />
 import type { NotFoundHandler } from './hono';
-import type { HonoRequest } from './request';
 import type { StatusCode } from './utils/http-status';
 declare type Headers = Record<string, string>;
 export declare type Data = string | ArrayBuffer | ReadableStream;
 export declare type Env = Record<string, any>;
 export declare class Context<RequestParamKeyType extends string = string, E = Env> {
-    req: HonoRequest<RequestParamKeyType>;
+    req: Request<RequestParamKeyType>;
     env: E;
     event: FetchEvent | undefined;
     executionCtx: ExecutionContext | undefined;
@@ -18,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: HonoRequest | Request, 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;
@@ -30,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

@@ -1,26 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = void 0;
-const request_1 = require("./request");
 const url_1 = require("./utils/url");
 class Context {
     constructor(req, env = undefined, eventOrExecutionCtx = undefined, notFoundHandler = () => new Response()) {
         this._status = 200;
         this._pretty = false;
         this._prettySpace = 2;
-        if (req instanceof Request) {
-            this.req = (0, request_1.extendHonoRequest)(req);
-        }
-        else {
-            this.req = req;
-        }
-        if (env) {
-            this.env = env;
-        }
-        this.executionCtx = eventOrExecutionCtx;
+        this.req = req;
+        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,6 +29,7 @@ class Hono extends defineDynamicClass() {
             const message = 'Internal Server Error';
             return c.text(message, 500);
         };
+        (0, request_1.extendRequestPrototype)();
         const allMethods = [...methods, router_1.METHOD_NAME_ALL_LOWERCASE];
         allMethods.map((method) => {
             this[method] = (args1, ...args) => {
@@ -90,14 +91,13 @@ class Hono extends defineDynamicClass() {
     matchRoute(method, path) {
         return this.router.match(method, path);
     }
-    async dispatch(request, executionCtx, env) {
-        request = (0, request_1.extendHonoRequest)(request);
+    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/body-parse/index.d.ts

@@ -1,7 +1,7 @@
 import type { Context } from '../../context';
 import type { Next } from '../../hono';
-declare module '../../request' {
-    interface HonoRequest {
+declare global {
+    interface Request {
         parsedBody: any;
     }
 }

package/dist/middleware/cookie/index.d.ts

@@ -1,7 +1,7 @@
 import type { Context } from '../../context';
 import type { Next } from '../../hono';
-declare module '../../request' {
-    interface HonoRequest {
+declare global {
+    interface Request {
         cookie: {
             (name: string): string;
             (): Record<string, string>;

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/mustache/mustache.js

@@ -7,13 +7,14 @@ exports.mustache = void 0;
 const mustache_1 = __importDefault(require("mustache"));
 const buffer_1 = require("../../utils/buffer");
 const cloudflare_1 = require("../../utils/cloudflare");
+const filepath_1 = require("../../utils/filepath");
 const EXTENSION = '.mustache';
 const DEFAULT_DOCUMENT = 'index.mustache';
 const mustache = (init = { root: '' }) => {
     const { root } = init;
     return async (c, next) => {
         c.render = async (filename, params = {}, options) => {
-            const path = (0, cloudflare_1.getKVFilePath)({
+            const path = (0, filepath_1.getFilePath)({
                 filename: `${filename}${EXTENSION}`,
                 root: root,
                 defaultDocument: DEFAULT_DOCUMENT,
@@ -31,7 +32,7 @@ const mustache = (init = { root: '' }) => {
             if (options) {
                 const partials = options;
                 for (const key of Object.keys(partials)) {
-                    const partialPath = (0, cloudflare_1.getKVFilePath)({
+                    const partialPath = (0, filepath_1.getFilePath)({
                         filename: `${partials[key]}${EXTENSION}`,
                         root: root,
                         defaultDocument: DEFAULT_DOCUMENT,

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serveStatic = void 0;
 const cloudflare_1 = require("../../utils/cloudflare");
+const filepath_1 = require("../../utils/filepath");
 const mime_1 = require("../../utils/mime");
 const DEFAULT_DOCUMENT = 'index.html';
 // This middleware is available only on Cloudflare Workers.
@@ -12,7 +13,7 @@ const serveStatic = (options = { root: '' }) => {
             await next();
         }
         const url = new URL(c.req.url);
-        const path = (0, cloudflare_1.getKVFilePath)({
+        const path = (0, filepath_1.getFilePath)({
             filename: options.path ?? url.pathname,
             root: options.root,
             defaultDocument: DEFAULT_DOCUMENT,

package/dist/request.d.ts

@@ -1,20 +1,22 @@
-export declare class HonoRequest<ParamKeyType extends string = string> extends Request {
-    param: {
-        (key: ParamKeyType): string;
-        (): Record<ParamKeyType, string>;
-    };
-    paramData?: Record<ParamKeyType, string>;
-    query: {
-        (key: string): string;
-        (): Record<string, string>;
-    };
-    queries: {
-        (key: string): string[];
-        (): Record<string, string[]>;
-    };
-    header: {
-        (name: string): string;
-        (): Record<string, string>;
-    };
+declare global {
+    interface Request<ParamKeyType extends string = string> {
+        param: {
+            (key: ParamKeyType): string;
+            (): Record<ParamKeyType, string>;
+        };
+        paramData?: Record<ParamKeyType, string>;
+        query: {
+            (key: string): string;
+            (): Record<string, string>;
+        };
+        queries: {
+            (key: string): string[];
+            (): Record<string, string[]>;
+        };
+        header: {
+            (name: string): string;
+            (): Record<string, string>;
+        };
+    }
 }
-export declare function extendHonoRequest(request: HonoRequest): HonoRequest;
+export declare function extendRequestPrototype(): void;

package/dist/request.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extendHonoRequest = exports.HonoRequest = void 0;
-class HonoRequest extends Request {
-}
-exports.HonoRequest = HonoRequest;
-function extendHonoRequest(request) {
-    request.param = function (key) {
+exports.extendRequestPrototype = void 0;
+function extendRequestPrototype() {
+    if (!!Request.prototype.param) {
+        // already extended
+        return;
+    }
+    Request.prototype.param = function (key) {
         if (this.paramData) {
             if (key) {
                 return this.paramData[key];
@@ -16,7 +17,7 @@ function extendHonoRequest(request) {
         }
         return null;
     };
-    request.header = function (name) {
+    Request.prototype.header = function (name) {
         if (name) {
             return this.headers.get(name);
         }
@@ -28,7 +29,7 @@ function extendHonoRequest(request) {
             return result;
         }
     };
-    request.query = function (key) {
+    Request.prototype.query = function (key) {
         const url = new URL(this.url);
         if (key) {
             return url.searchParams.get(key);
@@ -41,7 +42,7 @@ function extendHonoRequest(request) {
             return result;
         }
     };
-    request.queries = function (key) {
+    Request.prototype.queries = function (key) {
         const url = new URL(this.url);
         if (key) {
             return url.searchParams.getAll(key);
@@ -54,6 +55,5 @@ function extendHonoRequest(request) {
             return result;
         }
     };
-    return request;
 }
-exports.extendHonoRequest = extendHonoRequest;
+exports.extendRequestPrototype = extendRequestPrototype;

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.d.ts

@@ -4,10 +4,3 @@ export declare type KVAssetOptions = {
     namespace?: KVNamespace;
 };
 export declare const getContentFromKVAsset: (path: string, options?: KVAssetOptions | undefined) => Promise<ArrayBuffer | null>;
-declare type FilePathOptions = {
-    filename: string;
-    root?: string;
-    defaultDocument?: string;
-};
-export declare const getKVFilePath: (options: FilePathOptions) => string;
-export {};

package/dist/utils/cloudflare.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKVFilePath = exports.getContentFromKVAsset = void 0;
+exports.getContentFromKVAsset = void 0;
 const getContentFromKVAsset = async (path, options) => {
     let ASSET_MANIFEST = {};
     if (options && options.manifest) {
@@ -37,25 +37,3 @@ const getContentFromKVAsset = async (path, options) => {
     return content;
 };
 exports.getContentFromKVAsset = getContentFromKVAsset;
-const getKVFilePath = (options) => {
-    let filename = options.filename;
-    let root = options.root || '';
-    const defaultDocument = options.defaultDocument || 'index.html';
-    if (filename.endsWith('/')) {
-        // /top/ => /top/index.html
-        filename = filename.concat(defaultDocument);
-    }
-    else if (!filename.match(/\.[a-zA-Z0-9]+$/)) {
-        // /top => /top/index.html
-        filename = filename.concat('/' + defaultDocument);
-    }
-    // /foo.html => foo.html
-    filename = filename.replace(/^\.?\//, '');
-    // assets/ => assets
-    root = root.replace(/\/$/, '');
-    // ./assets/foo.html => assets/foo.html
-    let path = root ? root + '/' + filename : filename;
-    path = path.replace(/^\.?\//, '');
-    return path;
-};
-exports.getKVFilePath = getKVFilePath;

package/dist/utils/filepath.d.ts

@@ -0,0 +1,7 @@
+declare type FilePathOptions = {
+    filename: string;
+    root?: string;
+    defaultDocument?: string;
+};
+export declare const getFilePath: (options: FilePathOptions) => string;
+export {};

package/dist/utils/filepath.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFilePath = void 0;
+const getFilePath = (options) => {
+    let filename = options.filename;
+    let root = options.root || '';
+    const defaultDocument = options.defaultDocument || 'index.html';
+    if (filename.endsWith('/')) {
+        // /top/ => /top/index.html
+        filename = filename.concat(defaultDocument);
+    }
+    else if (!filename.match(/\.[a-zA-Z0-9]+$/)) {
+        // /top => /top/index.html
+        filename = filename.concat('/' + defaultDocument);
+    }
+    // /foo.html => foo.html
+    filename = filename.replace(/^\.?\//, '');
+    // assets/ => assets
+    root = root.replace(/\/$/, '');
+    // ./assets/foo.html => assets/foo.html
+    let path = root ? root + '/' + filename : filename;
+    path = path.replace(/^\.?\//, '');
+    return path;
+};
+exports.getFilePath = getFilePath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "1.5.2",
+  "version": "1.6.1",
   "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 && rimraf 'deno_dist/**/*.test.ts'",
     "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",
@@ -147,6 +153,7 @@
     "jest": "27.5.1",
     "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"
   }
-}
+}