hono 0.4.1 → 0.4.2

package/README.md

@@ -1,6 +1,14 @@
 # Hono
 
-Hono[炎] - _**means flame🔥 in Japanese**_ - is small, simple, and ultrafast web framework for a Service Workers API based serverless such as Cloudflare Workers and Fastly Compute@Edge.
+[![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)
+[![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/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.
 
 ```js
 import { Hono } from 'hono'
@@ -13,9 +21,9 @@ app.fire()
 
 ## Features
 
-- **Ultra fast** - the router is implemented with Trie-Tree structure. Not use loops.
-- **Zero dependencies** - using only Web standard API.
-- **Middleware** - builtin middleware, and you can make your own middleware.
+- **Ultrafast** - the router does not use linear loops.
+- **Zero-dependencies** - using only Web standard API.
+- **Middleware** - builtin middleware and your own middleware.
 - **Optimized** - for Cloudflare Workers.
 
 ## Benchmark
@@ -33,7 +41,7 @@ Fastest is hono
 
 ## Hono in 1 minute
 
-Below is a demonstration to create an application of Cloudflare Workers with Hono.
+A demonstration to create an application of Cloudflare Workers with Hono.
 
 ![Demo](https://user-images.githubusercontent.com/10682/151973526-342644f9-71c5-4fee-81f4-64a7558bb192.gif)
 
@@ -43,21 +51,21 @@ Now, the named path parameter has types.
 
 ## Install
 
-You can install Hono from npm registry:
+You can install Hono from the npm registry.
 
 ```sh
-yarn add hono
+$ yarn add hono
 ```
 
 or
 
 ```sh
-npm install hono
+$ npm install hono
 ```
 
 ## Methods
 
-An instance of `Hono` has these methods:
+An instance of `Hono` has these methods.
 
 - app.**HTTP_METHOD**(path, handler)
 - app.**all**(path, handler)
@@ -70,8 +78,6 @@ An instance of `Hono` has these methods:
 
 ### Basic
 
-`app.HTTP_METHOD`
-
 ```js
 // HTTP Methods
 app.get('/', (c) => c.text('GET /'))
@@ -81,11 +87,7 @@ app.post('/', (c) => c.text('POST /'))
 app.get('/wild/*/card', (c) => {
   return c.text('GET /wild/*/card')
 })
-```
 
-`app.all`
-
-```js
 // Any HTTP methods
 app.all('/hello', (c) => c.text('Any Method /hello'))
 ```
@@ -106,24 +108,25 @@ app.get('/post/:date{[0-9]+}/:title{[a-z]+}', (c) => {
   const date = c.req.param('date')
   const title = c.req.param('title')
   ...
+})
 ```
 
 ### Nested route
 
 ```js
 const book = app.route('/book')
-book.get('/', (c) => c.text('List Books')) // => GET /book
+book.get('/', (c) => c.text('List Books')) // GET /book
 book.get('/:id', (c) => {
-  // => GET /book/:id
+  // GET /book/:id
   const id = c.req.param('id')
   return c.text('Get Book: ' + id)
 })
-book.post('/', (c) => c.text('Create Book')) // => POST /book
+book.post('/', (c) => c.text('Create Book')) // POST /book
 ```
 
 ### no strict
 
-If `strict` is set `false`, `/hello`and`/hello/` are treated the same:
+If `strict` is set `false`, `/hello`and`/hello/` are treated the same. Default is `true`.
 
 ```js
 const app = new Hono({ strict: false })
@@ -131,8 +134,6 @@ const app = new Hono({ strict: false })
 app.get('/hello', (c) => c.text('/hello or /hello/'))
 ```
 
-Default is `true`.
-
 ### async/await
 
 ```js
@@ -156,14 +157,20 @@ const app = new Hono()
 
 app.use('*', poweredBy())
 app.use('*', logger())
-app.use('/auth/*', basicAuth({ username: 'hono', password: 'acoolproject' }))
+app.use(
+  '/auth/*',
+  basicAuth({
+    username: 'hono',
+    password: 'acoolproject',
+  })
+)
 ```
 
 Available builtin middleware are listed on [src/middleware](https://github.com/yusukebe/hono/tree/master/src/middleware).
 
 ### Custom Middleware
 
-You can write your own middleware:
+You can write your own middleware.
 
 ```js
 // Custom logger
@@ -183,7 +190,7 @@ app.get('/message/hello', (c) => c.text('Hello Middleware!'))
 
 ## Context
 
-To handle Request and Reponse, you can use Context object:
+To handle Request and Reponse, you can use Context object.
 
 ### c.req
 
@@ -222,25 +229,26 @@ app.get('/welcome', (c) => {
   c.status(201)
 
   return c.body('Thank you for comming')
+})
+```
 
-  /*
-  Same as:
-  return new Response('Thank you for comming', {
-    status: 201,
-    statusText: 'Created',
-    headers: {
-      'X-Message': 'Hello',
-      'Content-Type': 'text/plain',
-      'Content-Length: '22'
-    }
-  })
-  */
+The Response is the same as below.
+
+```js
+new Response('Thank you for comming', {
+  status: 201,
+  statusText: 'Created',
+  headers: {
+    'X-Message': 'Hello',
+    'Content-Type': 'text/plain',
+    'Content-Length': '22',
+  },
 })
 ```
 
 ### c.text()
 
-Render text as `Content-Type:text/plain`:
+Render texts as `Content-Type:text/plain`.
 
 ```js
 app.get('/say', (c) => {
@@ -250,7 +258,7 @@ app.get('/say', (c) => {
 
 ### c.json()
 
-Render JSON as `Content-Type:application/json`:
+Render JSON as `Content-Type:application/json`.
 
 ```js
 app.get('/api', (c) => {
@@ -260,7 +268,7 @@ app.get('/api', (c) => {
 
 ### c.html()
 
-Render HTML as `Content-Type:text/html`:
+Render HTML as `Content-Type:text/html`.
 
 ```js
 app.get('/', (c) => {
@@ -270,7 +278,7 @@ app.get('/', (c) => {
 
 ### c.notFound()
 
-Return the default `404 Not Found` Response:
+Return the default `404 Not Found` Response.
 
 ```js
 app.get('/notfound', (c) => {
@@ -280,7 +288,7 @@ app.get('/notfound', (c) => {
 
 ### c.redirect()
 
-Redirect, default status code is `302`:
+Redirect, default status code is `302`.
 
 ```js
 app.get('/redirect', (c) => c.redirect('/'))
@@ -321,7 +329,7 @@ app.get('*', async c => {
 
 ## Not Found
 
-If you want, you can set the default `404 Not Found` Response:
+You can write the default `404 Not Found` Response.
 
 ```js
 app.notFound = (c) => {
@@ -331,7 +339,7 @@ app.notFound = (c) => {
 
 ## Error handling
 
-You can handle errors in your way:
+You can handle errors in your way.
 
 ```js
 app.onError = (err, c) => {
@@ -341,7 +349,7 @@ app.onError = (err, c) => {
 
 ## fire
 
-`app.fire()` do:
+`app.fire()` do this.
 
 ```js
 addEventListener('fetch', (event) => {
@@ -361,7 +369,7 @@ export default {
 }
 
 /*
-or just do this:
+or just do:
 export default app
 */
 ```
@@ -374,15 +382,15 @@ Let's write your first code for Cloudflare Workers with Hono.
 
 ### 1. Install Wrangler
 
-Install Cloudflare Command Line "[Wrangler](https://github.com/cloudflare/wrangler)"
+Install Cloudflare Command Line "[Wrangler](https://github.com/cloudflare/wrangler)".
 
 ```sh
-npm i @cloudflare/wrangler -g
+$ npm i @cloudflare/wrangler -g
 ```
 
 ### 2. `npm init`
 
-Make npm skeleton directory.
+Make a npm skeleton directory.
 
 ```sh
 mkdir hono-example
@@ -395,15 +403,15 @@ npm init -y
 Init as a wrangler project.
 
 ```sh
-wrangler init
+$ wrangler init
 ```
 
 ### 4. `npm install hono`
 
-Install `hono` from npm registry.
+Install `hono` from the npm registry.
 
 ```sh
-npm i hono
+$ npm i hono
 ```
 
 ### 5. Write your app
@@ -421,10 +429,10 @@ app.fire()
 
 ### 6. Run
 
-Run the development server locally. Then, access like `http://127.0.0.1:8787/` in your Web browser.
+Run the development server locally. Then, access `http://127.0.0.1:8787/` in your Web browser.
 
 ```sh
-wrangler dev
+$ wrangler dev
 ```
 
 ### 7. Publish
@@ -432,12 +440,22 @@ wrangler dev
 Deploy to Cloudflare. That's all!
 
 ```sh
-wrangler publish
+$ wrangler publish
+```
+
+## Starter template
+
+You can start making your application of Cloudflare Workers with [the starter template](https://github.com/yusukebe/hono-minimal). It is a realy minimal using TypeScript, esbuild, and Miniflare.
+
+To generate a project skelton, run this command.
+
+```
+$ wrangler generate my-app https://github.com/yusukebe/hono-minimal
 ```
 
 ## Related projects
 
-Implementation of the router is inspired by [goblin](https://github.com/bmf-san/goblin). 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.
+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.
 
 - express <https://github.com/expressjs/express>
 - koa <https://github.com/koajs/koa>
@@ -445,10 +463,11 @@ Implementation of the router is inspired by [goblin](https://github.com/bmf-san/
 - Sunder <https://github.com/SunderJS/sunder>
 - goblin <https://github.com/bmf-san/goblin>
 - worktop <https://github.com/lukeed/worktop>
+- Router::Boom <https://github.com/tokuhirom/Router-Boom>
 
 ## Contributing
 
-Contributions Welcome! You can contribute by the following way:
+Contributions Welcome! You can contribute by the following way.
 
 - Write or fix documents
 - Write code of middleware
@@ -456,7 +475,7 @@ Contributions Welcome! You can contribute by the following way:
 - Refactor the code
 - etc.
 
-If you can, let's make Hono together!
+Let's make Hono together!
 
 ## Contributors
 

package/dist/hono.d.ts

@@ -1,9 +1,7 @@
 /// <reference types="@cloudflare/workers-types" />
-import { Node } from './node';
 import { Context } from './context';
 import type { Env } from './context';
-import type { Result } from './router';
-import { Router } from './router';
+import type { Result, Router } from './router';
 declare global {
     interface Request<ParamKeyType = string> {
         param: (key: ParamKeyType) => string;
@@ -17,12 +15,6 @@ export declare type MiddlewareHandler = (c: Context, next: Function) => Promise<
 declare type ParamKeyName<NameWithPattern> = NameWithPattern extends `${infer Name}{${infer _Pattern}` ? Name : NameWithPattern;
 declare type ParamKey<Component> = Component extends `:${infer NameWithPattern}` ? ParamKeyName<NameWithPattern> : never;
 declare type ParamKeys<Path> = Path extends `${infer Component}/${infer Rest}` ? ParamKey<Component> | ParamKeys<Rest> : ParamKey<Path>;
-export declare class TrieRouter<T> extends Router<T> {
-    node: Node<T>;
-    constructor();
-    add(method: string, path: string, handler: T): void;
-    match(method: string, path: string): Result<T> | null;
-}
 export declare class Hono {
     routerClass: {
         new (): Router<any>;

package/dist/hono.js

@@ -1,27 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Hono = exports.TrieRouter = void 0;
-const node_1 = require("./node");
+exports.Hono = void 0;
 const compose_1 = require("./compose");
 const url_1 = require("./utils/url");
 const context_1 = require("./context");
 const router_1 = require("./router");
-class TrieRouter extends router_1.Router {
-    constructor() {
-        super();
-        this.node = new node_1.Node();
-    }
-    add(method, path, handler) {
-        this.node.insert(method, path, handler);
-    }
-    match(method, path) {
-        return this.node.search(method, path);
-    }
-}
-exports.TrieRouter = TrieRouter;
+const trie_router_1 = require("./router/trie-router"); // Default Router
 class Hono {
     constructor(init = {}) {
-        this.routerClass = TrieRouter;
+        this.routerClass = trie_router_1.TrieRouter;
         this.strict = true; // strict routing - default is true
         Object.assign(this, init);
         this.router = new this.routerClass();

package/dist/middleware/basic-auth/basic-auth.d.ts

@@ -3,4 +3,7 @@ export declare const basicAuth: (options: {
     username: string;
     password: string;
     realm?: string;
-}) => (ctx: Context, next: Function) => Promise<any>;
+}, ...users: {
+    username: string;
+    password: string;
+}[]) => (ctx: Context, next: Function) => Promise<any>;

package/dist/middleware/basic-auth/basic-auth.js

@@ -24,24 +24,33 @@ const auth = (req) => {
     }
     return { username: userPass[1], password: userPass[2] };
 };
-const basicAuth = (options) => {
+const basicAuth = (options, ...users) => {
+    if (!options) {
+        throw new Error('basic auth middleware requires options for "username and password"');
+    }
     if (!options.realm) {
         options.realm = 'Secure Area';
     }
+    users.unshift({ username: options.username, password: options.password });
     return async (ctx, next) => {
-        const user = auth(ctx.req);
-        const usernameEqual = user && (await (0, buffer_1.timingSafeEqual)(options.username, user.username));
-        const passwordEqual = user && (await (0, buffer_1.timingSafeEqual)(options.password, user.password));
-        if (!user || !usernameEqual || !passwordEqual) {
-            ctx.res = new Response('Unauthorized', {
-                status: 401,
-                headers: {
-                    'WWW-Authenticate': 'Basic realm="' + options.realm.replace(/"/g, '\\"') + '"',
-                },
-            });
-            return;
+        const requestUser = auth(ctx.req);
+        if (requestUser) {
+            for (const user of users) {
+                const usernameEqual = await (0, buffer_1.timingSafeEqual)(user.username, requestUser.username);
+                const passwordEqual = await (0, buffer_1.timingSafeEqual)(user.password, requestUser.password);
+                if (usernameEqual && passwordEqual) {
+                    // Authorized OK
+                    return next();
+                }
+            }
         }
-        return next();
+        ctx.res = new Response('Unauthorized', {
+            status: 401,
+            headers: {
+                'WWW-Authenticate': 'Basic realm="' + options.realm.replace(/"/g, '\\"') + '"',
+            },
+        });
+        return;
     };
 };
 exports.basicAuth = basicAuth;

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

@@ -1,6 +1,4 @@
-export interface ParamMap {
-    [key: string]: number;
-}
+export declare type ParamMap = Array<[string, number]>;
 export interface Context {
     varIndex: number;
 }

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

@@ -64,7 +64,7 @@ class Node {
                 }
             }
             if (name !== '') {
-                paramMap[name] = node.varIndex;
+                paramMap.push([name, node.varIndex]);
             }
         }
         else {

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

@@ -41,9 +41,8 @@ class RegExpRouter extends router_1.Router {
         const index = match.indexOf('', 1);
         const [handler, paramMap] = handlers[replacementMap[index]];
         const params = {};
-        const keys = Object.keys(paramMap);
-        for (let i = 0; i < keys.length; i++) {
-            params[keys[i]] = match[paramMap[keys[i]]];
+        for (let i = 0; i < paramMap.length; i++) {
+            params[paramMap[i][0]] = match[paramMap[i][1]];
         }
         return new router_1.Result(handler, params);
     }
@@ -68,7 +67,7 @@ class RegExpRouter extends router_1.Router {
             return;
         }
         if (routes.length === 1 && routes[0][0] === '*') {
-            this.matchers[method] = [true, null, [[routes[0][1], {}]]];
+            this.matchers[method] = [true, null, [[routes[0][1], []]]];
             return;
         }
         if (routes.length === 1 && !routes[0][0].match(/:/)) {
@@ -77,7 +76,7 @@ class RegExpRouter extends router_1.Router {
                 ? 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], {}]]];
+            this.matchers[method] = [new RegExp(regExpStr), null, [[routes[0][1], []]]];
             return;
         }
         for (let i = 0; i < routes.length; i++) {
@@ -87,9 +86,9 @@ class RegExpRouter extends router_1.Router {
         const [regexp, indexReplacementMap, paramReplacementMap] = trie.buildRegExp();
         for (let i = 0; i < handlers.length; i++) {
             const paramMap = handlers[i][1];
-            Object.keys(paramMap).forEach((k) => {
-                paramMap[k] = paramReplacementMap[paramMap[k]];
-            });
+            for (let i = 0; i < paramMap.length; i++) {
+                paramMap[i][1] = paramReplacementMap[paramMap[i][1]];
+            }
         }
         this.matchers[method] = [new RegExp(regexp), indexReplacementMap, handlers];
     }

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

@@ -8,7 +8,7 @@ class Trie {
         this.root = new node_1.Node();
     }
     insert(path, index) {
-        const paramMap = {};
+        const paramMap = [];
         /**
          *  - pattern (:label, :label{0-9]+}, ...)
          *  - /* wildcard

package/dist/router/trie-router/index.d.ts

@@ -0,0 +1 @@
+export { TrieRouter } from './router';

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrieRouter = void 0;
+var router_1 = require("./router");
+Object.defineProperty(exports, "TrieRouter", { enumerable: true, get: function () { return router_1.TrieRouter; } });

package/dist/{node.d.ts → router/trie-router/node.d.ts}

@@ -1,5 +1,5 @@
-import type { Pattern } from './utils/url';
-import { Result } from './router';
+import type { Pattern } from '../../utils/url';
+import { Result } from '../../router';
 export declare class Node<T> {
     method: Record<string, T>;
     handler: T;

package/dist/{node.js → router/trie-router/node.js}

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Node = void 0;
-const url_1 = require("./utils/url");
-const router_1 = require("./router");
+const url_1 = require("../../utils/url");
+const router_1 = require("../../router");
 const noRoute = () => {
     return null;
 };

package/dist/router/trie-router/router.d.ts

@@ -0,0 +1,9 @@
+import { Router } from '../../router';
+import type { Result } from '../../router';
+import { Node } from './node';
+export declare class TrieRouter<T> extends Router<T> {
+    node: Node<T>;
+    constructor();
+    add(method: string, path: string, handler: T): void;
+    match(method: string, path: string): Result<T> | null;
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrieRouter = void 0;
+const router_1 = require("../../router");
+const node_1 = require("./node");
+class TrieRouter extends router_1.Router {
+    constructor() {
+        super();
+        this.node = new node_1.Node();
+    }
+    add(method, path, handler) {
+        this.node.insert(method, path, handler);
+    }
+    match(method, path) {
+        return this.node.search(method, path);
+    }
+}
+exports.TrieRouter = TrieRouter;

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "hono",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "[炎] Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint --ext js,ts src .eslintrc.js && prettier --check src",
+    "build": "rimraf dist && tsc",
+    "watch": "tsc -w",
+    "prepublishOnly": "yarn build"
+  },
   "exports": {
     ".": "./dist/index.js",
     "./basic-auth": "./dist/middleware/basic-auth/basic-auth.js",
@@ -17,8 +24,7 @@
     "./mustache": "./dist/middleware/mustache/mustache.js",
     "./powered-by": "./dist/middleware/powered-by/powered-by.js",
     "./serve-static": "./dist/middleware/serve-static/serve-static.js",
-    "./utils/buffer": "./dist/utils/buffer.js",
-    "./package.json": "./package.json"
+    "./router/reg-exp-router": "./dist/router/reg-exp-router/index.js"
   },
   "typesVersions": {
     "*": {
@@ -45,16 +51,12 @@
       ],
       "serve-static": [
         "./dist/middleware/serve-static/serve-static.d.ts"
+      ],
+      "router/reg-exp-router": [
+        "./dist/router/reg-exp-router/router.d.ts"
       ]
     }
   },
-  "scripts": {
-    "test": "jest",
-    "lint": "eslint --ext js,ts src .eslintrc.js test && prettier --check src",
-    "build": "rimraf dist && tsc",
-    "watch": "tsc -w",
-    "prepublishOnly": "yarn build"
-  },
   "author": "Yusuke Wada <yusuke@kamawada.com> (https://github.com/yusukebe)",
   "license": "MIT",
   "repository": {