hono 1.4.6 → 1.5.1

package/README.md

@@ -73,6 +73,7 @@ Built-in middleware make _"**Write Less, do more**"_ in reality. You can use a l
 - [CORS](https://github.com/honojs/hono/tree/master/src/middleware/cors/)
 - [ETag](https://github.com/honojs/hono/tree/master/src/middleware/etag/)
 - [GraphQL Server](https://github.com/honojs/hono/tree/master/src/middleware/graphql-server/)
+- [html](https://github.com/honojs/hono/tree/master/src/middleware/html/)
 - [JSX](https://github.com/honojs/hono/tree/master/src/middleware/jsx/)
 - [JWT Authentication](https://github.com/honojs/hono/tree/master/src/middleware/jwt/)
 - [Logger](https://github.com/honojs/hono/tree/master/src/middleware/logger/)
@@ -482,10 +483,22 @@ app.use('/', async (c, next) => {
 })
 ```
 
+### c.executionCtx
+
+```ts
+// ExecutionContext object
+app.get('/foo', async (c) => {
+  c.executionCtx.waitUntil(
+    c.env.KV.put(key, data)
+  )
+  ...
+})
+```
+
 ### c.event
 
 ```ts
-// FetchEvent object
+// FetchEvent object (only set when using Service Worker syntax)
 app.get('/foo', async (c) => {
   c.event.waitUntil(
     c.env.KV.put(key, data)
@@ -522,8 +535,8 @@ addEventListener('fetch', (event) => {
 
 ```ts
 export default {
-  fetch(request: Request, env: Env, event: FetchEvent) {
-    return app.fetch(request, env, event)
+  fetch(request: Request, env: Env, ctx: ExecutionContext) {
+    return app.fetch(request, env, ctx)
   },
 }
 ```
@@ -555,9 +568,9 @@ import { RegExpRouter } from 'hono/router/reg-exp-router'
 const app = new Hono({ router: new RegExpRouter() })
 ```
 
-## Routing Ordering
+## Routing priority
 
-The routing priority is decided by the order of registration. Only one handler will be dispatched.
+Handlers or middleware will be executed in registration order.
 
 ```ts
 app.get('/book/a', (c) => c.text('a')) // a
@@ -565,27 +578,37 @@ app.get('/book/:slug', (c) => c.text('common')) // common
 ```
 
 ```http
-GET /book/a ---> `a` // common will not be dispatched
-GET /book/b ---> `common` // a will not be dispatched
+GET /book/a ---> `a`
+GET /book/b ---> `common`
 ```
 
-All scoring rules:
+When a handler is executed, the process will be stopped.
 
 ```ts
-app.get('/api/*', 'c') // score 1.1 <--- `/*` is special wildcard
-app.get('/api/:type/:id', 'd') // score 3.2
-app.get('/api/posts/:id', 'e') // score 3.3
-app.get('/api/posts/123', 'f') // score 3.4
-app.get('/*/*/:id', 'g') // score 3.5
-app.get('/api/posts/*/comment', 'h') // score 4.6 - not match
-app.get('*', 'a') // score 0.7
-app.get('*', 'b') // score 0.8
+app.get('*', (c) => c.text('common')) // common
+app.get('/foo', (c) => c.text('foo')) // foo
 ```
 
-```plain
-GET /api/posts/123
----> will match => c, d, e, f, b, a, b
----> sort by score => a, b, c, d, e, f, g
+```http
+GET /foo ---> `common` // foo will not be dispatched
+```
+
+If you have the middleware that you want to execute, write the code above the handler.
+
+```ts
+app.use('*', logger())
+app.get('/foo', (c) => c.text('foo'))
+```
+
+If you want a "_fallback_" handler, write the code below the other handler.
+
+```ts
+app.get('/foo', (c) => c.text('foo')) // foo
+app.get('*', (c) => c.text('fallback')) // fallback
+```
+
+```http
+GET /bar ---> `fallback`
 ```
 
 ## Cloudflare Workers with Hono

package/dist/context.d.ts

@@ -8,6 +8,7 @@ export declare class Context<RequestParamKeyType extends string = string, E = En
     req: Request<RequestParamKeyType>;
     env: E;
     event: FetchEvent | undefined;
+    executionCtx: ExecutionContext | undefined;
     finalized: boolean;
     private _status;
     private _pretty;
@@ -17,7 +18,7 @@ export declare class Context<RequestParamKeyType extends string = string, E = En
     private _res;
     private notFoundHandler;
     render: (content: string, params?: object, options?: object) => Response | Promise<Response>;
-    constructor(req: Request<RequestParamKeyType>, env?: E | undefined, event?: FetchEvent | undefined, notFoundHandler?: NotFoundHandler);
+    constructor(req: Request<RequestParamKeyType>, env?: E | undefined, eventOrExecutionCtx?: FetchEvent | ExecutionContext | undefined, notFoundHandler?: NotFoundHandler);
     get res(): Response;
     set res(_res: Response);
     header(name: string, value: string): void;

package/dist/context.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = void 0;
 const url_1 = require("./utils/url");
 class Context {
-    constructor(req, env = undefined, event = undefined, notFoundHandler = () => new Response()) {
+    constructor(req, env = undefined, eventOrExecutionCtx = undefined, notFoundHandler = () => new Response()) {
         this._status = 200;
         this._pretty = false;
         this._prettySpace = 2;
@@ -11,7 +11,10 @@ class Context {
         if (env) {
             this.env = env;
         }
-        this.event = event;
+        this.executionCtx = eventOrExecutionCtx;
+        if (eventOrExecutionCtx && 'respondWith' in eventOrExecutionCtx) {
+            this.event = eventOrExecutionCtx;
+        }
         this.notFoundHandler = notFoundHandler;
         this.finalized = false;
     }

package/dist/hono.d.ts

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

package/dist/hono.js

@@ -91,13 +91,13 @@ class Hono extends defineDynamicClass() {
     matchRoute(method, path) {
         return this.router.match(method, path);
     }
-    async dispatch(request, event, env) {
+    async dispatch(request, executionCtx, 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, event, this.notFoundHandler);
+        const c = new context_1.Context(request, env, executionCtx, this.notFoundHandler);
         const composed = (0, compose_1.compose)(handlers, this.errorHandler, this.notFoundHandler);
         let context;
         try {
@@ -117,8 +117,8 @@ class Hono extends defineDynamicClass() {
     async handleEvent(event) {
         return this.dispatch(event.request, event);
     }
-    async fetch(request, env, event) {
-        return this.dispatch(request, event, env);
+    async fetch(request, env, executionCtx) {
+        return this.dispatch(request, executionCtx, env);
     }
     request(input, requestInit) {
         const req = input instanceof Request ? input : new Request(input, requestInit);

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

@@ -0,0 +1,5 @@
+export declare type HtmlEscapedString = string & {
+    isEscaped: true;
+};
+export declare const raw: (value: any) => HtmlEscapedString;
+export declare const html: (strings: TemplateStringsArray, ...values: any[]) => HtmlEscapedString;

package/dist/middleware/html/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.html = exports.raw = void 0;
+const html_1 = require("../../utils/html");
+const raw = (value) => {
+    const escapedString = new String(value);
+    escapedString.isEscaped = true;
+    return escapedString;
+};
+exports.raw = raw;
+const html = (strings, ...values) => {
+    let result = '';
+    for (let i = 0, len = strings.length - 1; i < len; i++) {
+        result += strings[i];
+        const children = values[i] instanceof Array ? values[i].flat(Infinity) : [values[i]];
+        for (let i = 0, len = children.length; i < len; i++) {
+            const child = children[i];
+            if (typeof child === 'boolean' || child === null || child === undefined) {
+                continue;
+            }
+            else if (typeof child === 'object' && child.isEscaped) {
+                result += child;
+            }
+            else {
+                result += (0, html_1.escape)(child.toString());
+            }
+        }
+    }
+    result += strings[strings.length - 1];
+    return (0, exports.raw)(result);
+};
+exports.html = html;

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

@@ -1,17 +1,16 @@
-import type { Context } from '../../context';
-import type { Next } from '../../hono';
+import type { HtmlEscapedString } from '../../utils/html';
 declare global {
-    namespace h.JSX {
+    namespace jsx.JSX {
         interface IntrinsicElements {
             [tagName: string]: Record<string, any>;
         }
     }
 }
-export declare const jsx: () => (c: Context, next: Next) => Promise<void>;
-declare type EscapedString = string & {
-    isEscaped: true;
-};
-export declare const h: (tag: string | Function, props: Record<string, any>, ...children: (string | EscapedString)[]) => EscapedString;
-declare type FC<T = Record<string, any>> = (props: T) => EscapedString;
+export declare const jsx: (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

@@ -1,22 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.memo = exports.h = exports.jsx = void 0;
+exports.Fragment = exports.memo = exports.jsx = void 0;
 const html_1 = require("../../utils/html");
-const jsx = () => {
-    return async (c, next) => {
-        c.render = (content) => {
-            const output = `<!doctype html>${content.toString()}`;
-            return c.html(output);
-        };
-        await next();
-    };
-};
-exports.jsx = jsx;
-const h = (tag, props, ...children) => {
+const jsx = (tag, props, ...children) => {
     if (typeof tag === 'function') {
         return tag.call(null, { ...props, children: children.length <= 1 ? children[0] : children });
     }
-    let result = `<${tag}`;
+    let result = tag !== '' ? `<${tag}` : '';
     const propsKeys = Object.keys(props || {});
     for (let i = 0, len = propsKeys.length; i < len; i++) {
         const v = props[propsKeys[i]];
@@ -34,7 +24,9 @@ const h = (tag, props, ...children) => {
         }
         result += ` ${propsKeys[i]}="${(0, html_1.escape)(v.toString())}"`;
     }
-    result += '>';
+    if (tag !== '') {
+        result += '>';
+    }
     const flattenChildren = children.flat(Infinity);
     for (let i = 0, len = flattenChildren.length; i < len; i++) {
         const child = flattenChildren[i];
@@ -48,12 +40,14 @@ const h = (tag, props, ...children) => {
             result += (0, html_1.escape)(child.toString());
         }
     }
-    result += `</${tag}>`;
+    if (tag !== '') {
+        result += `</${tag}>`;
+    }
     const escapedString = new String(result);
     escapedString.isEscaped = true;
     return escapedString;
 };
-exports.h = h;
+exports.jsx = jsx;
 const shallowEqual = (a, b) => {
     if (a === b) {
         return true;
@@ -82,3 +76,7 @@ const memo = (component, propsAreEqual = shallowEqual) => {
     });
 };
 exports.memo = memo;
+const Fragment = (props) => {
+    return (0, exports.jsx)('', {}, ...(props.children || []));
+};
+exports.Fragment = Fragment;

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

@@ -11,7 +11,6 @@ interface Hint {
 interface HandlerWithSortIndex<T> {
     handler: T;
     index: number;
-    componentsLength: number;
 }
 interface Route<T> {
     method: string;

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

@@ -65,9 +65,7 @@ function compareRoute(a, b) {
     return i === b.hint.regExpComponents.length || a.hint.endWithWildcard ? 1 : 0;
 }
 function compareHandler(a, b) {
-    return a.componentsLength !== b.componentsLength
-        ? a.componentsLength - b.componentsLength
-        : a.index - b.index;
+    return a.index - b.index;
 }
 function getSortedHandlers(handlers) {
     return [...handlers].sort(compareHandler).map((h) => h.handler);
@@ -158,7 +156,6 @@ class RegExpRouter {
         const handlerWithSortIndex = {
             index,
             handler,
-            componentsLength: hint.components.length || 1,
         };
         for (let i = 0, len = routes.length; i < len; i++) {
             if (routes[i].method === method && routes[i].path === path) {
@@ -318,9 +315,7 @@ class RegExpRouter {
                         }
                     }
                     if (routes[j].hint.components.length < routes[i].hint.components.length) {
-                        const componentsLength = routes[j].hint.components.length || 1;
                         routes[j].middleware.push(...routes[i].handlers.map((h) => ({
-                            componentsLength,
                             index: h.index,
                             handler: h.handler,
                         })));

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

@@ -66,18 +66,11 @@ class Node {
             parentPatterns.push(...curNode.patterns);
             curNode = curNode.children[p];
         }
-        let score = 1;
-        if (path === '*') {
-            score = score + this.order * 0.01;
-        }
-        else {
-            score = parts.length + this.order * 0.01;
-        }
         if (!curNode.methods.length) {
             curNode.methods = [];
         }
         const m = {};
-        const handlerSet = { handler: handler, name: this.name, score: score };
+        const handlerSet = { handler: handler, name: this.name, score: this.order };
         m[method] = handlerSet;
         curNode.methods.push(m);
         return curNode;
@@ -90,9 +83,6 @@ class Node {
                 const handlerSet = m[method] || m[router_1.METHOD_NAME_ALL];
                 if (handlerSet !== undefined) {
                     const hs = { ...handlerSet };
-                    if (wildcard) {
-                        hs.score = handlerSet.score - 1;
-                    }
                     handlerSets.push(hs);
                     return;
                 }

package/dist/utils/html.d.ts

@@ -1 +1,4 @@
+export declare type HtmlEscapedString = string & {
+    isEscaped: true;
+};
 export declare const escape: (str: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "1.4.6",
+  "version": "1.5.1",
   "description": "Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,6 +24,7 @@
     "./cors": "./dist/middleware/cors/index.js",
     "./etag": "./dist/middleware/etag/index.js",
     "./graphql-server": "./dist/middleware/graphql-server/index.js",
+    "./html": "./dist/middleware/html/index.js",
     "./jsx": "./dist/middleware/jsx/index.js",
     "./jwt": "./dist/middleware/jwt/index.js",
     "./logger": "./dist/middleware/logger/index.js",
@@ -61,6 +62,9 @@
       "graphql-server": [
         "./dist/middleware/graphql-server"
       ],
+      "html": [
+        "./dist/middleware/html"
+      ],
       "jsx": [
         "./dist/middleware/jsx"
       ],

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

@@ -1,3 +0,0 @@
-export interface Context {
-    render(template: string, params?: object, options?: object): Promise<Response>;
-}

package/dist/middleware/mustache/Context.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });