hono 2.0.0 → 2.0.3

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <a href="https://honojs.dev">
-    <img src="https://raw.githubusercontent.com/honojs/hono/master/docs/images/hono-title.png" width="500" height="auto" alt="Hono"/>
+    <img src="https://raw.githubusercontent.com/honojs/hono/main/docs/images/hono-title.png" width="500" height="auto" alt="Hono"/>
   </a>
 </div>
 
@@ -14,12 +14,12 @@
 <hr />
 
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/honojs/hono/ci)](https://github.com/honojs/hono/actions)
-[![GitHub](https://img.shields.io/github/license/honojs/hono)](https://github.com/honojs/hono/blob/master/LICENSE)
+[![GitHub](https://img.shields.io/github/license/honojs/hono)](https://github.com/honojs/hono/blob/main/LICENSE)
 [![npm](https://img.shields.io/npm/v/hono)](https://www.npmjs.com/package/hono)
 [![npm](https://img.shields.io/npm/dm/hono)](https://www.npmjs.com/package/hono)
 [![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)
+[![GitHub last commit](https://img.shields.io/github/last-commit/honojs/hono)](https://github.com/honojs/hono/commits/main)
 [![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, Deno, Bun, and others.
@@ -61,19 +61,19 @@ The documentation is available on [honojs.dev](https://honojs.dev).
 
 ## Migration
 
-Migration guide is available on [docs/MIGRATION.md](docs/MIGRATION.md)
+Migration guide is available on [docs/MIGRATION.md](docs/MIGRATION.md).
 
 ## Contributing
 
 Contributions Welcome! You can contribute in the following ways.
 
-- Fix bugs.
-- Create built-in or third-party middleware.
-- Propose new feature.
-- Refactor the code.
-- Write an article about Hono on your Blog.
-- Fix a typo.
-- etc.
+- Create an Issue - Propose a new feature. Report a bug.
+- Pull Request - Fix a bug and typo. Refactor the code.
+- Create third-party middleware - Instruct below.
+- Share - Share your thoughts on the Blog, Twitter, and others.
+- Make your application - Please try to use Hono.
+
+For more details, see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md).
 
 ## Contributors
 

package/dist/compose.js

@@ -4,7 +4,7 @@ exports.compose = void 0;
 const context_1 = require("./context");
 // Based on the code in the MIT licensed `koa-compose` package.
 const compose = (middleware, onError, onNotFound) => {
-    return async (context, next) => {
+    return (context, next) => {
         let index = -1;
         return dispatch(0);
         async function dispatch(i) {
@@ -22,7 +22,7 @@ const compose = (middleware, onError, onNotFound) => {
                 return Promise.resolve(context);
             }
             return Promise.resolve(handler(context, () => dispatch(i + 1)))
-                .then(async (res) => {
+                .then((res) => {
                 // If handler return Response like `return c.text('foo')`
                 if (res && context instanceof context_1.HonoContext) {
                     context.res = res;

package/dist/context.d.ts

@@ -8,15 +8,15 @@ declare type Env = Record<string, any>;
 export interface Context<RequestParamKeyType extends string = string, E = Env> {
     req: Request<RequestParamKeyType>;
     env: E;
-    event: FetchEvent | undefined;
-    executionCtx: ExecutionContext | undefined;
+    event: FetchEvent;
+    executionCtx: ExecutionContext;
     finalized: boolean;
     get res(): Response;
     set res(_res: Response);
     header: (name: string, value: string) => void;
     status: (status: StatusCode) => void;
     set: (key: string, value: any) => void;
-    get: (key: string) => any;
+    get: <T = any>(key: string) => T;
     pretty: (prettyJSON: boolean, space?: number) => void;
     newResponse: (data: Data | null, status: StatusCode, headers: Headers) => Response;
     body: (data: Data | null, status?: StatusCode, headers?: Headers) => Response;
@@ -30,17 +30,18 @@ export interface Context<RequestParamKeyType extends string = string, E = Env> {
 export declare class HonoContext<RequestParamKeyType extends string = string, E = Env> implements Context<RequestParamKeyType, E> {
     req: Request<RequestParamKeyType>;
     env: E;
-    event: FetchEvent | undefined;
-    executionCtx: ExecutionContext | undefined;
     finalized: boolean;
     _status: StatusCode;
+    private _executionCtx;
     private _pretty;
     private _prettySpace;
     private _map;
     private _headers;
     private _res;
     private notFoundHandler;
-    constructor(req: Request, env?: E | undefined, eventOrExecutionCtx?: FetchEvent | ExecutionContext | undefined, notFoundHandler?: NotFoundHandler);
+    constructor(req: Request, env?: E | undefined, executionCtx?: FetchEvent | ExecutionContext | undefined, notFoundHandler?: NotFoundHandler);
+    get event(): FetchEvent;
+    get executionCtx(): ExecutionContext;
     get res(): Response;
     set res(_res: Response);
     header(name: string, value: string): void;

package/dist/context.js

@@ -4,20 +4,31 @@ exports.HonoContext = void 0;
 const cookie_1 = require("./utils/cookie");
 const url_1 = require("./utils/url");
 class HonoContext {
-    constructor(req, env = undefined, eventOrExecutionCtx = undefined, notFoundHandler = () => new Response()) {
+    constructor(req, env = undefined, executionCtx = undefined, notFoundHandler = () => new Response()) {
         this._status = 200;
         this._pretty = false;
         this._prettySpace = 2;
+        this._executionCtx = executionCtx;
         this.req = req;
         this.env = env ? env : {};
-        if (eventOrExecutionCtx && 'respondWith' in eventOrExecutionCtx) {
-            this.event = eventOrExecutionCtx;
+        this.notFoundHandler = notFoundHandler;
+        this.finalized = false;
+    }
+    get event() {
+        if (this._executionCtx instanceof FetchEvent) {
+            return this._executionCtx;
         }
         else {
-            this.executionCtx = eventOrExecutionCtx;
+            throw Error('This context has no FetchEvent');
+        }
+    }
+    get executionCtx() {
+        if (this._executionCtx) {
+            return this._executionCtx;
+        }
+        else {
+            throw Error('This context has no ExecutionContext');
         }
-        this.notFoundHandler = notFoundHandler;
-        this.finalized = false;
     }
     get res() {
         return (this._res || (this._res = new Response()));

package/dist/hono.js

@@ -29,7 +29,7 @@ class Hono extends defineDynamicClass() {
             const message = 'Internal Server Error';
             return c.text(message, 500);
         };
-        this.fetch = async (request, env, executionCtx) => {
+        this.fetch = (request, env, executionCtx) => {
             return this.dispatch(request, executionCtx, env);
         };
         (0, request_1.extendRequestPrototype)();
@@ -117,7 +117,7 @@ class Hono extends defineDynamicClass() {
         }
         return context.res;
     }
-    async handleEvent(event) {
+    handleEvent(event) {
         return this.dispatch(event.request, event);
     }
     request(input, requestInit) {

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

@@ -0,0 +1,7 @@
+import type { Context } from '../../context';
+import type { Next } from '../../hono';
+export declare const cache: (options: {
+    cacheName: string;
+    wait?: boolean;
+    cacheControl?: string;
+}) => (c: Context, next: Next) => Promise<Response | undefined>;

package/dist/middleware/cache/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cache = void 0;
+const cache = (options) => {
+    if (options.wait === undefined) {
+        options.wait = false;
+    }
+    const addHeader = (response) => {
+        if (options.cacheControl)
+            response.headers.append('Cache-Control', options.cacheControl);
+    };
+    return async (c, next) => {
+        const key = c.req;
+        const cache = await caches.open(options.cacheName);
+        const response = await cache.match(key);
+        if (!response) {
+            await next();
+            addHeader(c.res);
+            const response = c.res.clone();
+            if (options.wait) {
+                await cache.put(key, response);
+            }
+            else {
+                c.executionCtx.waitUntil(cache.put(key, response));
+            }
+        }
+        else {
+            return response;
+        }
+    };
+};
+exports.cache = cache;

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

@@ -1,7 +1,8 @@
 import type { Context } from '../../context';
 import type { Next } from '../../hono';
+declare type EncodingType = 'gzip' | 'deflate';
 interface CompressionOptions {
-    encoding?: 'gzip' | 'deflate';
+    encoding?: EncodingType;
 }
 export declare const compress: (options?: CompressionOptions | undefined) => (ctx: Context, next: Next) => Promise<void>;
 export {};

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

@@ -6,11 +6,11 @@ declare global {
         }
     }
 }
-export declare const jsx: (tag: string | Function, props: Record<string, any>, ...children: (string | HtmlEscapedString)[]) => HtmlEscapedString;
+export { jsxFn as jsx };
+declare const jsxFn: (tag: string | Function, props: Record<string, any>, ...children: (string | HtmlEscapedString)[]) => HtmlEscapedString;
 declare type FC<T = Record<string, any>> = (props: T) => HtmlEscapedString;
 export declare const memo: <T>(component: FC<T>, propsAreEqual?: (prevProps: Readonly<T>, nextProps: Readonly<T>) => boolean) => FC<T>;
 export declare const Fragment: (props: {
     key?: string;
     children?: any;
 }) => HtmlEscapedString;
-export {};

package/dist/middleware/jsx/index.js

@@ -19,7 +19,7 @@ const emptyTags = [
     'track',
     'wbr',
 ];
-const jsx = (tag, props, ...children) => {
+const jsxFn = (tag, props, ...children) => {
     if (typeof tag === 'function') {
         return tag.call(null, { ...props, children: children.length <= 1 ? children[0] : children });
     }
@@ -67,7 +67,7 @@ const jsx = (tag, props, ...children) => {
     escapedString.isEscaped = true;
     return escapedString;
 };
-exports.jsx = jsx;
+exports.jsx = jsxFn;
 const shallowEqual = (a, b) => {
     if (a === b) {
         return true;
@@ -97,6 +97,6 @@ const memo = (component, propsAreEqual = shallowEqual) => {
 };
 exports.memo = memo;
 const Fragment = (props) => {
-    return (0, exports.jsx)('', {}, ...(props.children || []));
+    return jsxFn('', {}, ...(props.children || []));
 };
 exports.Fragment = Fragment;

package/dist/middleware/jsx/jsx-dev-runtime.d.ts

@@ -0,0 +1,2 @@
+import type { HtmlEscapedString } from '../html';
+export declare function jsxDEV(tag: string | Function, props: Record<string, any>): HtmlEscapedString;

package/dist/middleware/jsx/jsx-dev-runtime.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsxDEV = void 0;
+const _1 = require(".");
+function jsxDEV(tag, props) {
+    const children = props.children ?? [];
+    delete props['children'];
+    return (0, _1.jsx)(tag, props, ...children);
+}
+exports.jsxDEV = jsxDEV;

package/dist/middleware/jsx/jsx-runtime.d.ts

@@ -0,0 +1,2 @@
+export { jsxDEV as jsx } from './jsx-dev-runtime';
+export { jsxDEV as jsxs } from './jsx-dev-runtime';

package/dist/middleware/jsx/jsx-runtime.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsxs = exports.jsx = void 0;
+var jsx_dev_runtime_1 = require("./jsx-dev-runtime");
+Object.defineProperty(exports, "jsx", { enumerable: true, get: function () { return jsx_dev_runtime_1.jsxDEV; } });
+var jsx_dev_runtime_2 = require("./jsx-dev-runtime");
+Object.defineProperty(exports, "jsxs", { enumerable: true, get: function () { return jsx_dev_runtime_2.jsxDEV; } });

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

@@ -1,7 +1,5 @@
 import type { Context } from '../../context';
 import type { Next } from '../../hono';
-export declare const logger: (fn?: {
-    (...data: any[]): void;
-    (...data: any[]): void;
-    (message?: any, ...optionalParams: any[]): void;
-}) => (c: Context, next: Next) => Promise<void>;
+declare type PrintFunc = (str: string, ...rest: string[]) => void;
+export declare const logger: (fn?: PrintFunc) => (c: Context, next: Next) => Promise<void>;
+export {};

package/dist/middleware/logger/index.js

@@ -2,24 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logger = void 0;
 const url_1 = require("../../utils/url");
-const humanize = (n, opts) => {
-    const options = opts || {};
-    const d = options.delimiter || ',';
-    const s = options.separator || '.';
-    n = n.toString().split('.');
-    n[0] = n[0].replace(/(\d)(?=(\d\d\d)+(?!\d))/g, '$1' + d);
-    return n.join(s);
+var LogPrefix;
+(function (LogPrefix) {
+    LogPrefix["Outgoing"] = "-->";
+    LogPrefix["Incoming"] = "<--";
+    LogPrefix["Error"] = "xxx";
+})(LogPrefix || (LogPrefix = {}));
+const humanize = (times) => {
+    const [delimiter, separator] = [',', '.'];
+    const orderTimes = times.map((v) => v.replace(/(\d)(?=(\d\d\d)+(?!\d))/g, '$1' + delimiter));
+    return orderTimes.join(separator);
 };
 const time = (start) => {
     const delta = Date.now() - start;
-    return humanize([delta < 10000 ? delta + 'ms' : Math.round(delta / 1000) + 's']);
+    return humanize([delta < 1000 ? delta + 'ms' : Math.round(delta / 1000) + 's']);
 };
-const LogPrefix = {
-    Outgoing: '-->',
-    Incoming: '<--',
-    Error: 'xxx',
-};
-const colorStatus = (status = 0) => {
+const colorStatus = (status) => {
     const out = {
         7: `\x1b[35m${status}\x1b[0m`,
         5: `\x1b[31m${status}\x1b[0m`,
@@ -29,9 +27,10 @@ const colorStatus = (status = 0) => {
         1: `\x1b[32m${status}\x1b[0m`,
         0: `\x1b[33m${status}\x1b[0m`,
     };
-    return out[(status / 100) | 0];
+    const calculateStatus = (status / 100) | 0;
+    return out[calculateStatus];
 };
-function log(fn, prefix, method, path, status, elapsed) {
+function log(fn, prefix, method, path, status = 0, elapsed) {
     const out = prefix === LogPrefix.Incoming
         ? `  ${prefix} ${method} ${path}`
         : `  ${prefix} ${method} ${path} ${colorStatus(status)} ${elapsed}`;

package/dist/middleware/serve-static/module.mjs

@@ -6,6 +6,7 @@ import { serveStatic } from './serve-static';
 const module = (options = { root: '' }) => {
     return serveStatic({
         root: options.root,
+        path: options.path,
         manifest: options.manifest ? options.manifest : manifest,
     });
 };

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

@@ -102,8 +102,21 @@ class Node {
             const part = parts[i];
             const isLast = i === len - 1;
             const tempNodes = [];
+            let matched = false;
             for (let j = 0, len2 = curNodes.length; j < len2; j++) {
                 const node = curNodes[j];
+                const nextNode = node.children[part];
+                if (nextNode) {
+                    if (isLast === true) {
+                        // '/hello/*' => match '/hello'
+                        if (nextNode.children['*']) {
+                            handlerSets.push(...this.getHandlerSets(nextNode.children['*'], method, true));
+                        }
+                        handlerSets.push(...this.getHandlerSets(nextNode, method));
+                        matched = true;
+                    }
+                    tempNodes.push(nextNode);
+                }
                 for (let k = 0, len3 = node.patterns.length; k < len3; k++) {
                     const pattern = node.patterns[k];
                     // Wildcard
@@ -128,22 +141,15 @@ class Node {
                             }
                             tempNodes.push(node.children[key]);
                         }
-                        if (typeof name === 'string') {
+                        // '/book/a'     => not-slug
+                        // '/book/:slug' => slug
+                        // GET /book/a   ~> no-slug, param['slug'] => undefined
+                        // GET /book/foo ~> slug, param['slug'] => foo
+                        if (typeof name === 'string' && !matched) {
                             params[name] = part;
                         }
                     }
                 }
-                const nextNode = node.children[part];
-                if (nextNode) {
-                    if (isLast === true) {
-                        // '/hello/*' => match '/hello'
-                        if (nextNode.children['*']) {
-                            handlerSets.push(...this.getHandlerSets(nextNode.children['*'], method, true));
-                        }
-                        handlerSets.push(...this.getHandlerSets(nextNode, method));
-                    }
-                    tempNodes.push(nextNode);
-                }
             }
             curNodes = tempNodes;
         }

package/dist/utils/jwt/jwt.js

@@ -46,7 +46,7 @@ const param = (name) => {
                 },
             };
         default:
-            throw new types_2.JwtAlorithmNotImplemented(name);
+            throw new types_2.JwtAlgorithmNotImplemented(name);
     }
 };
 const signing = async (data, secret, alg = types_1.AlgorithmTypes.HS256) => {

package/dist/utils/jwt/types.d.ts

@@ -1,6 +1,11 @@
-export declare class JwtAlorithmNotImplemented extends Error {
+export declare class JwtAlgorithmNotImplemented extends Error {
     constructor(token: string);
 }
+/**
+ * Export for backward compatibility
+ * @deprecated Use JwtAlgorithmNotImplemented instead
+**/
+export declare const JwtAlorithmNotImplemented: typeof JwtAlgorithmNotImplemented;
 export declare class JwtTokenInvalid extends Error {
     constructor(token: string);
 }

package/dist/utils/jwt/types.js

@@ -1,13 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AlgorithmTypes = exports.JwtTokenSignatureMismatched = exports.JwtTokenExpired = exports.JwtTokenNotBefore = exports.JwtTokenInvalid = exports.JwtAlorithmNotImplemented = void 0;
-class JwtAlorithmNotImplemented extends Error {
+exports.AlgorithmTypes = exports.JwtTokenSignatureMismatched = exports.JwtTokenExpired = exports.JwtTokenNotBefore = exports.JwtTokenInvalid = exports.JwtAlorithmNotImplemented = exports.JwtAlgorithmNotImplemented = void 0;
+class JwtAlgorithmNotImplemented extends Error {
     constructor(token) {
         super(`invalid JWT token: ${token}`);
-        this.name = 'JwtAlorithmNotImplemented';
+        this.name = 'JwtAlgorithmNotImplemented';
     }
 }
-exports.JwtAlorithmNotImplemented = JwtAlorithmNotImplemented;
+exports.JwtAlgorithmNotImplemented = JwtAlgorithmNotImplemented;
+/**
+ * Export for backward compatibility
+ * @deprecated Use JwtAlgorithmNotImplemented instead
+**/
+exports.JwtAlorithmNotImplemented = JwtAlgorithmNotImplemented;
 class JwtTokenInvalid extends Error {
     constructor(token) {
         super(`invalid JWT token: ${token}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "description": "Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,8 @@
   "scripts": {
     "test": "jest",
     "test:deno": "deno test --allow-read deno_test",
-    "test:bun": "bun run ./bun_test/index.test.ts",
+    "test:bun": "bun wiptest --jsx-import-source ../src/middleware/jsx/jsx-dev-runtime bun_test/index.test.tsx",
+    "test:all": "yarn test && yarn test:deno && yarn test:bun",
     "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'",
@@ -23,10 +24,14 @@
     ".": "./dist/index.js",
     "./basic-auth": "./dist/middleware/basic-auth/index.js",
     "./bearer-auth": "./dist/middleware/bearer-auth/index.js",
+    "./cache": "./dist/middleware/cache/index.js",
+    "./compress": "./dist/middleware/compress/index.js",
     "./cors": "./dist/middleware/cors/index.js",
     "./etag": "./dist/middleware/etag/index.js",
     "./html": "./dist/middleware/html/index.js",
     "./jsx": "./dist/middleware/jsx/index.js",
+    "./jsx/jsx-dev-runtime": "./dist/middleware/jsx/jsx-dev-runtime.js",
+    "./jsx/jsx-runtime": "./dist/middleware/jsx/jsx-runtime.js",
     "./jwt": "./dist/middleware/jwt/index.js",
     "./logger": "./dist/middleware/logger/index.js",
     "./powered-by": "./dist/middleware/powered-by/index.js",
@@ -47,8 +52,11 @@
       "bearer-auth": [
         "./dist/middleware/bearer-auth"
       ],
-      "cookie": [
-        "./dist/middleware/cookie"
+      "cache": [
+        "./dist/middleware/cache"
+      ],
+      "compress": [
+        "./dist/middleware/compress"
       ],
       "cors": [
         "./dist/middleware/cors"
@@ -62,6 +70,12 @@
       "jsx": [
         "./dist/middleware/jsx"
       ],
+      "jsx-runtime": [
+        "./dist/middleware/jsx/jsx-runtime.d.ts"
+      ],
+      "jsx-dev-runtime": [
+        "./dist/middleware/jsx/jsx-dev-runtime.d.ts"
+      ],
       "jwt": [
         "./dist/middleware/jwt"
       ],
@@ -126,7 +140,6 @@
     "@cloudflare/workers-types": "^3.7.1",
     "@types/crypto-js": "^4.1.1",
     "@types/jest": "^27.4.1",
-    "@types/mustache": "^4.1.2",
     "@types/node": "^17.0.29",
     "@typescript-eslint/eslint-plugin": "^5.21.0",
     "@typescript-eslint/parser": "^5.21.0",
@@ -143,7 +156,6 @@
     "form-data": "^4.0.0",
     "jest": "27.5.1",
     "jest-environment-miniflare": "^2.6.0",
-    "mustache": "^4.2.0",
     "np": "^7.6.2",
     "prettier": "^2.6.2",
     "rimraf": "^3.0.2",