hono 0.0.11 → 0.0.12

package/README.md

@@ -6,24 +6,24 @@ Hono [炎] - Tiny web framework for Cloudflare Workers and others.
 const { Hono } = require('hono')
 const app = new Hono()
 
-app.get('/', () => new Response('Hono!!'))
+app.get('/', (c) => c.text('Hono!!'))
 
 app.fire()
 ```
 
-![carbon](https://user-images.githubusercontent.com/10682/147877725-bce9bd46-953d-4d70-9c2b-3eae47ad4df9.png)
+Hono[炎] - _**means flame🔥 in Japanese**_ - is small, fast and simple web flamework for a Service Workers API based serverless such as **Cloudflare Workers** and **Fastly Compute@Edge**. Hono does not depend on any npm packages. However, Hono has a router, context object, and middleware including the builtins. It's easy to make a web application.
 
-## Feature
+## Features
 
-- Fast - the router is implemented with Trie-Tree structure.
-- Portable - zero dependencies.
-- Flexible - you can make your own middlewares.
-- Easy - simple API, builtin middleware, and TypeScript support.
-- Optimized - for Cloudflare Workers or Fastly Compute@Edge.
+- **Fast** - the router is implemented with Trie-Tree structure.
+- **Tiny** - zero dependencies, using Web standard API.
+- **Flexible** - you can make your own middleware.
+- **Easy** - simple API, builtin middleware, and written in TypeScript.
+- **Optimized** - for Cloudflare Workers or Fastly Compute@Edge.
 
 ## Benchmark
 
-Hono is fastest!!
+**Hono is fastest** compared to other routers for Cloudflare Workers.
 
 ```
 hono x 758,264 ops/sec ±5.41% (75 runs sampled)
@@ -33,8 +33,16 @@ Fastest is hono
 ✨  Done in 42.84s.
 ```
 
+## Hono in 1 minute
+
+Below is a demonstration to create an application of Cloudflare Workers with Hono.
+
+![Demo](https://user-images.githubusercontent.com/10682/148223268-2484a891-57c1-472f-9df3-936a5586f002.gif)
+
 ## Install
 
+You can install from npm registry:
+
 ```
 $ yarn add hono
 ```
@@ -47,10 +55,13 @@ $ npm install hono
 
 ## Methods
 
+Instance of `Hono` has these methods:
+
 - app.**HTTP_METHOD**(path, handler)
 - app.**all**(path, handler)
 - app.**route**(path)
 - app.**use**(path, middleware)
+- app.**fire**()
 
 ## Routing
 
@@ -104,7 +115,7 @@ app
     .put(() => {...})
 ```
 
-## Async
+## async/await
 
 ```js
 app.get('/fetch-url', async () => {
@@ -122,13 +133,21 @@ const { Hono, Middleware } = require('hono')
 
 ...
 
-app.use('*', Middleware.poweredBy())
-app.use('*', Middleware.logger())
-
+app.use(
+  '/auth/*',
+  Middleware.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:
+
 ```js
 // Custom logger
 app.use('*', async (c, next) => {
@@ -136,7 +155,7 @@ app.use('*', async (c, next) => {
   await next()
 })
 
-// Add custom header
+// Add a custom header
 app.use('/message/*', async (c, next) => {
   await next()
   await c.res.headers.add('x-message', 'This is middleware!')
@@ -147,6 +166,8 @@ app.get('/message/hello', () => 'Hello Middleware!')
 
 ### Custom 404 Response
 
+You can customize 404 Not Found response:
+
 ```js
 app.use('*', async (c, next) => {
   await next()
@@ -158,6 +179,8 @@ app.use('*', async (c, next) => {
 
 ### Complex Pattern
 
+You can also do this:
+
 ```js
 // Output response time
 app.use('*', async (c, next) => {
@@ -177,7 +200,9 @@ app.use('*', async (c, next) => {
 
 ## Context
 
-### req
+To handle Request and Reponse easily, you can use Context object:
+
+### c.req
 
 ```js
 
@@ -200,7 +225,7 @@ app.get('/entry/:id', (c) => {
 })
 ```
 
-### res
+### c.res
 
 ```js
 // Response object
@@ -210,7 +235,9 @@ app.use('/', (c, next) => {
 })
 ```
 
-### text
+### c.text()
+
+Render text as `Content-Type:text/plain`:
 
 ```js
 app.get('/say', (c) => {
@@ -218,13 +245,41 @@ app.get('/say', (c) => {
 })
 ```
 
-## Hono in 1 minute
+### c.json()
 
-Create your first Cloudflare Workers with Hono from scratch.
+Render JSON as `Content-Type:application/json`:
 
-### How to setup
+```js
+app.get('/api', (c) => {
+  return c.json({ message: 'Hello!' })
+})
+```
 
-![Demo](https://user-images.githubusercontent.com/10682/147877447-ff5907cd-49be-4976-b3b4-5df2ac6dfda4.gif)
+### c.html()
+
+Render HTML as `Content-Type:text/html`:
+
+```js
+app.get('/api', (c) => {
+  return c.html('<h1>Hello! Hono!</h1>')
+})
+```
+
+## fire
+
+`app.fire()` do:
+
+```js
+addEventListener('fetch', (event) => {
+  event.respondWith(this.handleEvent(event))
+})
+```
+
+## Cloudflare Workers with Hono
+
+Using `wrangler` or `miniflare`, 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
 
@@ -254,7 +309,7 @@ $ wrangler init
 
 ### 4. `npm install hono`
 
-Install `hono` from npm repository.
+Install `hono` from npm registry.
 
 ```
 $ npm i hono
@@ -262,38 +317,59 @@ $ npm i hono
 
 ### 5. Write your app
 
-Only 4 line!!
+Only 4 lines!!
 
 ```js
 const { Hono } = require('hono')
 const app = new Hono()
 
-app.get('/', () => new Response('Hello! Hono!'))
+app.get('/', (c) => c.text('Hello! Hono!'))
 
 app.fire()
 ```
 
-### 6. Run!
+### 6. Run
 
-Run the development server locally.
+Run the development server locally. Then, access like `http://127.0.0.1:8787/` in your Web browser.
 
 ```sh
 $ wrangler dev
 ```
 
+### Publish
+
+Deploy to Cloudflare. That's all!
+
+```sh
+$ wrangler publish
+```
+
 ## Related projects
 
-- koa <https://github.com/koajs/koa>
+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) and [Sunder](https://github.com/SunderJS/sunder) are the other routers or frameworks for Cloudflare Workers.
+
 - express <https://github.com/expressjs/express>
-- oak <https://github.com/oakserver/oak>
+- koa <https://github.com/koajs/koa>
 - itty-router <https://github.com/kwhitley/itty-router>
 - Sunder <https://github.com/SunderJS/sunder>
 - goblin <https://github.com/bmf-san/goblin>
 
+## Contributing
+
+Contributions Welcome! You can contribute by the following way:
+
+- Write or fix documents
+- Write code of middleware
+- Fix bugs
+- Refactor the code
+- etc.
+
+If you can, let's make Hono together!
+
 ## Author
 
 Yusuke Wada <https://github.com/yusukebe>
 
 ## License
 
-MIT
+Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

package/dist/context.d.ts

@@ -0,0 +1,9 @@
+export declare class Context {
+    req: Request;
+    res: Response;
+    constructor(req: Request, res: Response);
+    newResponse(body?: BodyInit | null | undefined, init?: ResponseInit | undefined): Response;
+    text(body: string): Response;
+    json(object: object, replacer?: (string | number)[], space?: string | number): Response;
+    html(body: string): Response;
+}

package/dist/context.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
+class Context {
+    constructor(req, res) {
+        this.req = req;
+        this.res = res;
+    }
+    newResponse(body, init) {
+        return new Response(body, init);
+    }
+    text(body) {
+        if (typeof body !== 'string') {
+            throw new TypeError('text method arg must be a string!');
+        }
+        return this.newResponse(body, {
+            status: 200,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        });
+    }
+    json(object, replacer, space) {
+        if (typeof object !== 'object') {
+            throw new TypeError('json method arg must be a object!');
+        }
+        const body = JSON.stringify(object, replacer, space);
+        return this.newResponse(body, {
+            status: 200,
+            headers: {
+                'Content-Type': 'application/json; charset=UTF-8',
+            },
+        });
+    }
+    html(body) {
+        if (typeof body !== 'string') {
+            throw new TypeError('html method arg must be a string!');
+        }
+        return this.newResponse(body, {
+            status: 200,
+            headers: {
+                'Content-Type': 'text/html; charset=UTF-8',
+            },
+        });
+    }
+}
+exports.Context = Context;

package/dist/hono.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="@cloudflare/workers-types" />
-import { Node, Result } from './node';
+import type { Result } from './node';
+import { Node } from './node';
 import { Middleware } from './middleware';
+import { Context } from './context';
 export { Middleware };
 declare global {
     interface Request {
@@ -8,13 +10,6 @@ declare global {
         query: (key: string) => string | null;
     }
 }
-export declare class Context {
-    req: Request;
-    res: Response;
-    constructor(req: Request, res: Response);
-    newResponse(body?: BodyInit | null | undefined, init?: ResponseInit | undefined): Response;
-    text(body: string): Response;
-}
 declare type Handler = (c: Context, next?: Function) => Response | Promise<Response>;
 declare type MiddlwareHandler = (c: Context, next: Function) => Promise<void>;
 export declare class Router<T> {

package/dist/hono.js

@@ -1,30 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Hono = exports.Router = exports.Context = exports.Middleware = void 0;
+exports.Hono = exports.Router = exports.Middleware = void 0;
 const node_1 = require("./node");
 const compose_1 = require("./compose");
 const util_1 = require("./util");
 const middleware_1 = require("./middleware");
 Object.defineProperty(exports, "Middleware", { enumerable: true, get: function () { return middleware_1.Middleware; } });
+const context_1 = require("./context");
 const METHOD_NAME_OF_ALL = 'ALL';
-class Context {
-    constructor(req, res) {
-        this.req = req;
-        this.res = res;
-    }
-    newResponse(body, init) {
-        return new Response(body, init);
-    }
-    text(body) {
-        return this.newResponse(body, {
-            status: 200,
-            headers: {
-                'Content-Type': 'text/plain',
-            },
-        });
-    }
-}
-exports.Context = Context;
 class Router {
     constructor() {
         this.node = new node_1.Node();
@@ -99,6 +82,7 @@ class Hono {
     addRoute(method, arg, ...args) {
         method = method.toUpperCase();
         if (typeof arg === 'string') {
+            this.tempPath = arg;
             this.router.add(method, arg, args);
         }
         else {
@@ -119,7 +103,7 @@ class Hono {
             }
             return '';
         };
-        let handler = result ? result.handler[0] : this.notFound; // XXX
+        const handler = result ? result.handler[0] : this.notFound; // XXX
         const middleware = [];
         for (const mr of this.middlewareRouters) {
             const mwResult = mr.match(METHOD_NAME_OF_ALL, path);
@@ -127,14 +111,14 @@ class Hono {
                 middleware.push(mwResult.handler);
             }
         }
-        let wrappedHandler = async (context, next) => {
+        const wrappedHandler = async (context, next) => {
             context.res = await handler(context);
             await next();
         };
         middleware.push(middleware_1.Middleware.defaultFilter);
         middleware.push(wrappedHandler);
         const composed = (0, compose_1.compose)(middleware);
-        const c = new Context(request, response);
+        const c = new context_1.Context(request, response);
         await composed(c);
         return c.res;
     }

package/dist/index.d.ts

@@ -1 +1,2 @@
-export { Hono, Middleware, Context } from './hono';
+export { Hono, Middleware } from './hono';
+export { Context } from './context';

package/dist/index.js

@@ -4,4 +4,5 @@ exports.Context = exports.Middleware = exports.Hono = void 0;
 var hono_1 = require("./hono");
 Object.defineProperty(exports, "Hono", { enumerable: true, get: function () { return hono_1.Hono; } });
 Object.defineProperty(exports, "Middleware", { enumerable: true, get: function () { return hono_1.Middleware; } });
-Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return hono_1.Context; } });
+var context_1 = require("./context");
+Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });

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

@@ -0,0 +1,6 @@
+import type { Context } from '../../context';
+export declare const basicAuth: (options: {
+    username: string;
+    password: string;
+    realm?: string;
+}) => (ctx: Context, next: Function) => Promise<any>;

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

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.basicAuth = void 0;
+const util_1 = require("../../util");
+const CREDENTIALS_REGEXP = /^ *(?:[Bb][Aa][Ss][Ii][Cc]) +([A-Za-z0-9._~+/-]+=*) *$/;
+const USER_PASS_REGEXP = /^([^:]*):(.*)$/;
+const auth = (req) => {
+    if (!req) {
+        throw new TypeError('argument req is required');
+    }
+    if (typeof req !== 'object') {
+        throw new TypeError('argument req is required to be an object');
+    }
+    if (!req.headers || typeof req.headers !== 'object') {
+        throw new TypeError('argument req is required to have headers property');
+    }
+    const match = CREDENTIALS_REGEXP.exec(req.headers.get('Authorization'));
+    if (!match) {
+        return undefined;
+    }
+    const userPass = USER_PASS_REGEXP.exec(decodeBase64(match[1]));
+    if (!userPass) {
+        return undefined;
+    }
+    return { username: userPass[1], password: userPass[2] };
+};
+function decodeBase64(str) {
+    return Buffer.from(str, 'base64').toString();
+}
+const basicAuth = (options) => {
+    if (!options.realm) {
+        options.realm = 'Secure Area';
+    }
+    return async (ctx, next) => {
+        const user = auth(ctx.req);
+        const usernameEqual = user && await (0, util_1.timingSafeEqual)(options.username, user.username);
+        const passwordEqual = user && await (0, util_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;
+        }
+        return next();
+    };
+};
+exports.basicAuth = basicAuth;

package/dist/middleware/defaultFilter.d.ts

@@ -1,2 +1,2 @@
-import { Context } from '../hono';
+import type { Context } from '../context';
 export declare const defaultFilter: (c: Context, next: Function) => Promise<void>;

package/dist/middleware/defaultFilter.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultFilter = void 0;
 const defaultFilter = async (c, next) => {
     c.req.query = (key) => {
+        // eslint-disable-next-line
         const url = new URL(c.req.url);
         return url.searchParams.get(key);
     };

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

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

package/dist/middleware/logger/logger.js

@@ -12,7 +12,9 @@ const humanize = (n, opts) => {
 };
 const time = (start) => {
     const delta = Date.now() - start;
-    return humanize([delta < 10000 ? delta + 'ms' : Math.round(delta / 1000) + 's']);
+    return humanize([
+        delta < 10000 ? delta + 'ms' : Math.round(delta / 1000) + 's',
+    ]);
 };
 const LogPrefix = {
     Outgoing: '-->',

package/dist/middleware/poweredBy/poweredBy.d.ts

@@ -1,2 +1,2 @@
-import { Context } from '../../hono';
+import type { Context } from '../../context';
 export declare const poweredBy: () => (c: Context, next: Function) => Promise<void>;

package/dist/middleware.d.ts

@@ -1,8 +1,14 @@
 export declare class Middleware {
-    static defaultFilter: (c: import("./hono").Context, next: Function) => Promise<void>;
-    static poweredBy: () => (c: import("./hono").Context, next: Function) => Promise<void>;
+    static defaultFilter: (c: import("./context").Context, next: Function) => Promise<void>;
+    static poweredBy: () => (c: import("./context").Context, next: Function) => Promise<void>;
     static logger: (fn?: {
         (...data: any[]): void;
         (...data: any[]): void;
-    }) => (c: import("./hono").Context, next: Function) => Promise<void>;
+        (message?: any, ...optionalParams: any[]): void;
+    }) => (c: import("./context").Context, next: Function) => Promise<void>;
+    static basicAuth: (options: {
+        username: string;
+        password: string;
+        realm?: string;
+    }) => (ctx: import("./context").Context, next: Function) => Promise<any>;
 }

package/dist/middleware.js

@@ -4,9 +4,11 @@ exports.Middleware = void 0;
 const defaultFilter_1 = require("./middleware/defaultFilter");
 const poweredBy_1 = require("./middleware/poweredBy/poweredBy");
 const logger_1 = require("./middleware/logger/logger");
+const basic_auth_1 = require("./middleware/basic-auth/basic-auth");
 class Middleware {
 }
 exports.Middleware = Middleware;
 Middleware.defaultFilter = defaultFilter_1.defaultFilter;
 Middleware.poweredBy = poweredBy_1.poweredBy;
 Middleware.logger = logger_1.logger;
+Middleware.basicAuth = basic_auth_1.basicAuth;

package/dist/node.js

@@ -23,6 +23,7 @@ class Node {
         this.middlewares = [];
     }
     insert(method, path, handler) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
         let curNode = this;
         const parts = (0, util_1.splitPath)(path);
         for (let i = 0, len = parts.length; i < len; i++) {
@@ -38,9 +39,10 @@ class Node {
         return curNode;
     }
     search(method, path) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
         let curNode = this;
         const params = {};
-        let parts = (0, util_1.splitPath)(path);
+        const parts = (0, util_1.splitPath)(path);
         for (let i = 0, len = parts.length; i < len; i++) {
             const p = parts[i];
             // '*' => match any path

package/dist/util.d.ts

@@ -1,3 +1,4 @@
 export declare const splitPath: (path: string) => string[];
 export declare const getPattern: (label: string) => string[] | null;
 export declare const getPathFromURL: (url: string) => string;
+export declare const timingSafeEqual: (a: any, b: any) => Promise<boolean>;

package/dist/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPathFromURL = exports.getPattern = exports.splitPath = void 0;
+exports.timingSafeEqual = exports.getPathFromURL = exports.getPattern = exports.splitPath = void 0;
 const splitPath = (path) => {
     const paths = path.split(/\//); // faster than path.split('/')
     if (paths[0] === '') {
@@ -34,3 +34,30 @@ const getPathFromURL = (url) => {
     return '';
 };
 exports.getPathFromURL = getPathFromURL;
+const bufferEqual = (a, b) => {
+    if (a === b) {
+        return true;
+    }
+    if (a.byteLength !== b.byteLength) {
+        return false;
+    }
+    const va = new DataView(a);
+    const vb = new DataView(b);
+    let i = va.byteLength;
+    while (i--) {
+        if (va.getUint8(i) !== vb.getUint8(i)) {
+            return false;
+        }
+    }
+    return true;
+};
+const timingSafeEqual = async (a, b) => {
+    const sa = await crypto.subtle.digest({
+        name: 'SHA-256',
+    }, new TextEncoder().encode(String(a)));
+    const sb = await crypto.subtle.digest({
+        name: 'SHA-256',
+    }, new TextEncoder().encode(String(b)));
+    return bufferEqual(sa, sb) && a === b;
+};
+exports.timingSafeEqual = timingSafeEqual;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "Tiny web framework for Cloudflare Workers and others.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,6 +9,7 @@
   ],
   "scripts": {
     "test": "jest",
+    "lint": "eslint --ext js,ts src .eslintrc.js test",
     "build": "rimraf dist && tsc",
     "watch": "tsc -w",
     "prepublishOnly": "yarn build"
@@ -35,11 +36,26 @@
   "devDependencies": {
     "@cloudflare/workers-types": "^3.3.0",
     "@types/jest": "^27.4.0",
+    "@types/node": "^17.0.8",
     "@types/service-worker-mock": "^2.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.9.0",
+    "eslint": "^7.26.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-define-config": "^1.2.1",
+    "eslint-import-resolver-typescript": "^2.0.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-flowtype": "^5.7.2",
+    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "jest": "^27.4.5",
     "rimraf": "^3.0.2",
     "service-worker-mock": "^2.0.5",
     "ts-jest": "^27.1.2",
+    "@typescript-eslint/parser": "^5.9.0",
     "typescript": "^4.5.4"
+  },
+  "engines": {
+    "node": ">=11.0.0"
   }
 }

package/dist/methods.d.ts

@@ -1 +0,0 @@
-export declare const methods: string[];

package/dist/methods.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.methods = void 0;
-exports.methods = [
-    'get',
-    'post',
-    'put',
-    'head',
-    'delete',
-    'options',
-    'trace',
-    'copy',
-    'lock',
-    'mkcol',
-    'move',
-    'patch',
-    'purge',
-    'propfind',
-    'proppatch',
-    'unlock',
-    'report',
-    'mkactivity',
-    'checkout',
-    'merge',
-    'm-search',
-    'notify',
-    'subscribe',
-    'unsubscribe',
-    'search',
-    'connect',
-];