hono 0.5.1 → 0.5.2

package/README.md

@@ -23,12 +23,12 @@ app.fire()
 
 - **Ultrafast** - the router does not use linear loops.
 - **Zero-dependencies** - using only Web standard API.
-- **Middleware** - builtin middleware and your own middleware.
+- **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 +41,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)
 
@@ -147,7 +147,7 @@ app.get('/fetch-url', async (c) => {
 
 ## Middleware
 
-### Builtin Middleware
+### Built-in Middleware
 
 ```js
 import { Hono } from 'hono'
@@ -168,7 +168,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
 
@@ -273,7 +273,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) => {
@@ -381,19 +381,22 @@ export default app
 
 ## 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:
+
+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).
 
-### 2. `npm init`
+---
+
+### 1. `npm init`
 
 Make a npm skeleton directory.
 
@@ -403,15 +406,23 @@ 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
+```
+
+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
 ```
 
-### 4. `npm install hono`
+### 3. `npm install hono`
 
 Install `hono` from the npm registry.
 
@@ -419,11 +430,12 @@ Install `hono` from the npm registry.
 $ 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 +444,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/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.2",
   "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",