hono 0.5.1 → 0.5.4

package/README.md

@@ -1,4 +1,10 @@
-# Hono
+# Hono\[炎\]
+
+<p>
+<a href="https://github.com/yusukebe/hono/blob/master/README.md">English</a>
+&#x000B7;
+<a href="https://github.com/yusukebe/hono/blob/master/docs/README.ja.md">日本語</a>
+</p>
 
 [![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)
@@ -8,7 +14,7 @@
 [![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.
+Hono[炎] - _**means flame🔥 in Japanese**_ - is small, simple, and ultrafast web framework for Cloudflare Workers and Fastly Compute@Edge.
 
 ```js
 import { Hono } from 'hono'
@@ -22,13 +28,13 @@ app.fire()
 ## Features
 
 - **Ultrafast** - the router does not use linear loops.
-- **Zero-dependencies** - using only Web standard API.
-- **Middleware** - builtin middleware and your own middleware.
+- **Zero-dependencies** - using only Service Worker and Web standard API.
+- **Middleware** - built-in middleware and ability to extend with your own middleware.
 - **Optimized** - for Cloudflare Workers.
 
 ## Benchmark
 
-**Hono is fastest** compared to other routers for Cloudflare Workers.
+**Hono is fastest**, compared to other routers for Cloudflare Workers.
 
 ```plain
 hono x 809,503 ops/sec ±6.94% (73 runs sampled)
@@ -41,7 +47,7 @@ Fastest is hono
 
 ## Hono in 1 minute
 
-A demonstration to create an application of Cloudflare Workers with Hono.
+A demonstration to create an application for Cloudflare Workers with Hono.
 
 ![Demo](https://user-images.githubusercontent.com/10682/151973526-342644f9-71c5-4fee-81f4-64a7558bb192.gif)
 
@@ -53,13 +59,13 @@ Now, the named path parameter has types.
 
 You can install Hono from the npm registry.
 
-```sh
+```
 $ yarn add hono
 ```
 
 or
 
-```sh
+```
 $ npm install hono
 ```
 
@@ -75,6 +81,7 @@ An instance of `Hono` has these methods.
 - app.**onError**(err, handler)
 - app.**fire**()
 - app.**fetch**(request, env, event)
+- app.**request**(path, option)
 
 ## Routing
 
@@ -147,7 +154,9 @@ app.get('/fetch-url', async (c) => {
 
 ## Middleware
 
-### Builtin Middleware
+### Built-in Middleware
+
+Hono has built-in middleware.
 
 ```js
 import { Hono } from 'hono'
@@ -168,7 +177,7 @@ app.use(
 )
 ```
 
-Available builtin middleware are listed on [src/middleware](https://github.com/yusukebe/hono/tree/master/src/middleware).
+Available built-in middleware is listed on [src/middleware](https://github.com/yusukebe/hono/tree/master/src/middleware).
 
 ### Custom Middleware
 
@@ -213,7 +222,7 @@ app.onError((err, c) => {
 
 ## Context
 
-To handle Request and Reponse, you can use Context object.
+To handle Request and Reponse, you can use `Context` object.
 
 ### c.req
 
@@ -273,7 +282,7 @@ new Response('Thank you for comming', {
 
 ### c.text()
 
-Render texts as `Content-Type:text/plain`.
+Render text as `Content-Type:text/plain`.
 
 ```js
 app.get('/say', (c) => {
@@ -303,7 +312,7 @@ app.get('/', (c) => {
 
 ### c.notFound()
 
-Return the `404 Not Found` Response.
+Return the `Not Found` Response.
 
 ```js
 app.get('/notfound', (c) => {
@@ -379,51 +388,74 @@ export default app
 */
 ```
 
+## request
+
+`request` is a useful method for testing.
+
+```js
+test('GET /hello is ok', async () => {
+  const res = await app.request('http://localhost/hello')
+  expect(res.status).toBe(200)
+})
+```
+
 ## Cloudflare Workers with Hono
 
-Using `wrangler` or `miniflare`, you can develop the application locally and publish it with few commands.
+Using [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/) or [Miniflare](https://miniflare.dev), you can develop the application locally and publish it with few commands.
 
 Let's write your first code for Cloudflare Workers with Hono.
 
-### 1. Install Wrangler
+---
 
-Install Cloudflare Command Line "[Wrangler](https://github.com/cloudflare/wrangler)".
+### Caution
 
-```sh
-$ npm i @cloudflare/wrangler -g
-```
+**Wrangler 1.x** does not support importing middleware. We recommend two ways:
 
-### 2. `npm init`
+1. Use [Wragler 2.0 Beta](https://github.com/cloudflare/wrangler2).
+2. Build without webpack 4.x. For example, you can use esbuild. See [the starter template](https://github.com/yusukebe/hono-minimal).
+
+---
+
+### 1. `npm init`
 
 Make a npm skeleton directory.
 
-```sh
-mkdir hono-example
-cd hono-example
-npm init -y
+```
+$ mkdir hono-example
+$ cd hono-example
+$ npm init -y
 ```
 
-### 3. `wrangler init`
+### 2. `wrangler init`
 
-Init as a wrangler project.
+Initialize as a wrangler project.
 
-```sh
-$ wrangler init
+```
+$ npx wrangler@beta init
 ```
 
-### 4. `npm install hono`
+Answer the questions. If you want, you can answer `y`.
+
+```
+Would you like to install wrangler into your package.json? (y/n) <--- n
+Would you like to use TypeScript? (y/n) <--- n
+Would you like to create a Worker at src/index.js? (y/n) <--- n
+```
+
+### 3. `npm install hono`
 
 Install `hono` from the npm registry.
 
-```sh
+```
 $ npm i hono
 ```
 
-### 5. Write your app
+### 4. Write your app
 
 Only 4 lines!!
 
 ```js
+// index.js
 import { Hono } from 'hono'
 const app = new Hono()
 
@@ -432,25 +464,25 @@ app.get('/', (c) => c.text('Hello! Hono!'))
 app.fire()
 ```
 
-### 6. Run
+### 5. Run
 
 Run the development server locally. Then, access `http://127.0.0.1:8787/` in your Web browser.
 
-```sh
-$ wrangler dev
+```
+$ npx wrangler@beta dev index.js
 ```
 
-### 7. Publish
+### 6. Publish
 
 Deploy to Cloudflare. That's all!
 
-```sh
-$ wrangler publish
+```
+$ npx wrangler@beta publish index.js
 ```
 
 ## 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.
+You can start making your Cloudflare Workers application with [the starter template](https://github.com/yusukebe/hono-minimal). It is really minimal using TypeScript, esbuild, and Miniflare.
 
 To generate a project skelton, run this command.
 

package/dist/context.js

@@ -35,8 +35,8 @@ class Context {
         this._statusText = (0, http_status_1.getStatusText)(number);
     }
     newResponse(data, init = {}) {
-        init.status = init.status || this._status;
-        init.statusText = init.statusText || this._statusText;
+        init.status = init.status || this._status || 200;
+        init.statusText = init.statusText || this._statusText || (0, http_status_1.getStatusText)(init.status);
         init.headers = Object.assign(Object.assign({}, this._headers), init.headers);
         // Content-Length
         let length = 0;

package/dist/hono.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="@cloudflare/workers-types" />
 import { Context } from './context';
 import type { Env } from './context';
-import type { Result, Router } from './router';
+import type { Router } from './router';
 declare global {
     interface Request<ParamKeyType = string> {
         param: (key: ParamKeyType) => string;
@@ -26,25 +26,34 @@ export declare class Hono {
     middlewareRouters: Router<MiddlewareHandler>[];
     tempPath: string;
     constructor(init?: Partial<Pick<Hono, 'routerClass' | 'strict'>>);
-    notFoundHandler: NotFoundHandler;
-    errorHandler: ErrorHandler;
+    private notFoundHandler;
+    private errorHandler;
     get<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    get(path: string, handler: Handler<string>): Hono;
     post<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    post(path: string, handler: Handler<string>): Hono;
     put<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    put(path: string, handler: Handler<string>): Hono;
     head<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    head(path: string, handler: Handler<string>): Hono;
     delete<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    delete(path: string, handler: Handler<string>): Hono;
     options<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    options(path: string, handler: Handler<string>): Hono;
     patch<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    patch(path: string, handler: Handler<string>): Hono;
     all<Path extends string>(path: Path, handler: Handler<ParamKeys<Path>>): Hono;
+    all(path: string, handler: Handler<string>): Hono;
     route(path: string): Hono;
     use(path: string, middleware: MiddlewareHandler): void;
     onError(handler: ErrorHandler): Hono;
     notFound(handler: NotFoundHandler): Hono;
-    addRoute(method: string, path: string, handler: Handler): Hono;
-    matchRoute(method: string, path: string): Promise<Result<Handler>>;
+    private addRoute;
+    private matchRoute;
     dispatch(request: Request, env?: Env, event?: FetchEvent): Promise<Response>;
     handleEvent(event: FetchEvent): Promise<Response>;
     fetch(request: Request, env?: Env, event?: FetchEvent): Promise<Response>;
+    request(input: RequestInfo, requestInit?: RequestInit): Promise<Response>;
     fire(): void;
 }
 export {};

package/dist/hono.js

@@ -128,6 +128,10 @@ class Hono {
     async fetch(request, env, event) {
         return this.dispatch(request, env, event);
     }
+    request(input, requestInit) {
+        const req = new Request(input, requestInit);
+        return this.dispatch(req);
+    }
     fire() {
         addEventListener('fetch', (event) => {
             event.respondWith(this.handleEvent(event));

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

@@ -3,6 +3,7 @@ export declare const basicAuth: (options: {
     username: string;
     password: string;
     realm?: string;
+    hashFunction?: Function;
 }, ...users: {
     username: string;
     password: string;

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

@@ -37,8 +37,8 @@ const basicAuth = (options, ...users) => {
         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);
+                const usernameEqual = await (0, buffer_1.timingSafeEqual)(user.username, requestUser.username, options.hashFunction);
+                const passwordEqual = await (0, buffer_1.timingSafeEqual)(user.password, requestUser.password, options.hashFunction);
                 if (usernameEqual && passwordEqual) {
                     // Authorized OK
                     return next();

package/dist/utils/buffer.d.ts

@@ -1,2 +1,2 @@
 export declare const equal: (a: ArrayBuffer, b: ArrayBuffer) => boolean;
-export declare const timingSafeEqual: (a: string | object | boolean, b: string | object | boolean) => Promise<boolean>;
+export declare const timingSafeEqual: (a: string | object | boolean, b: string | object | boolean, hashFunction?: Function) => Promise<boolean>;

package/dist/utils/buffer.js

@@ -20,9 +20,12 @@ const equal = (a, b) => {
     return true;
 };
 exports.equal = equal;
-const timingSafeEqual = async (a, b) => {
-    const sa = await (0, crypto_1.sha256)(a);
-    const sb = await (0, crypto_1.sha256)(b);
+const timingSafeEqual = async (a, b, hashFunction) => {
+    if (!hashFunction) {
+        hashFunction = crypto_1.sha256;
+    }
+    const sa = await hashFunction(a);
+    const sb = await hashFunction(b);
     return sa === sb && a === b;
 };
 exports.timingSafeEqual = timingSafeEqual;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "0.5.1",
+  "version": "0.5.4",
   "description": "[炎] Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -78,11 +78,13 @@
   ],
   "devDependencies": {
     "@cloudflare/workers-types": "^3.3.0",
+    "@types/crypto-js": "^4.1.1",
     "@types/jest": "^27.4.0",
     "@types/mustache": "^4.1.2",
     "@types/node": "^17.0.8",
     "@typescript-eslint/eslint-plugin": "^5.9.0",
     "@typescript-eslint/parser": "^5.9.0",
+    "crypto-js": "^4.1.1",
     "eslint": "^7.26.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-define-config": "^1.2.1",
@@ -96,6 +98,7 @@
     "jest-environment-miniflare": "^2.0.0",
     "mustache": "^4.2.0",
     "prettier": "^2.5.1",
+    "prettier-plugin-md-nocjsp": "^1.2.0",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.1.2",
     "typescript": "^4.5.5"