hono 0.1.0 → 0.2.3

package/README.md

@@ -23,19 +23,19 @@ app.fire()
 **Hono is fastest** compared to other routers for Cloudflare Workers.
 
 ```plain
-hono x 748,188 ops/sec ±5.40% (77 runs sampled)
-itty-router x 158,817 ops/sec ±3.62% (87 runs sampled)
-sunder x 332,339 ops/sec ±1.11% (95 runs sampled)
-worktop x 205,906 ops/sec ±4.43% (83 runs sampled)
+hono x 708,671 ops/sec ±2.58% (58 runs sampled)
+itty-router x 159,610 ops/sec ±2.86% (87 runs sampled)
+sunder x 322,846 ops/sec ±2.24% (86 runs sampled)
+worktop x 223,625 ops/sec ±2.01% (95 runs sampled)
 Fastest is hono
-✨  Done in 52.79s.
+✨  Done in 57.83s.
 ```
 
 ## 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)
+![Demo](https://user-images.githubusercontent.com/10682/151102477-be0f950e-8d23-49c5-b6d8-d8ecb6b7484e.gif)
 
 ## Install
 
@@ -90,7 +90,7 @@ app.all('/hello', (c) => c.text('Any Method /hello'))
 
 ```js
 app.get('/user/:name', (c) => {
-  const name = c.req.params('name')
+  const name = c.req.param('name')
   ...
 })
 ```
@@ -99,8 +99,8 @@ app.get('/user/:name', (c) => {
 
 ```js
 app.get('/post/:date{[0-9]+}/:title{[a-z]+}', (c) => {
-  const date = c.req.params('date')
-  const title = c.req.params('title')
+  const date = c.req.param('date')
+  const title = c.req.param('title')
   ...
 ```
 
@@ -114,6 +114,16 @@ app
     .put(() => {...})
 ```
 
+### Custom 404 Response
+
+You can customize 404 Not Found response:
+
+```js
+app.get('*', (c) => {
+  return c.text('Custom 404 Error', 404)
+})
+```
+
 ## async/await
 
 ```js
@@ -165,19 +175,6 @@ app.use('/message/*', async (c, next) => {
 app.get('/message/hello', (c) => c.text('Hello Middleware!'))
 ```
 
-### Custom 404 Response
-
-You can customize 404 Not Found response:
-
-```js
-app.use('*', async (c, next) => {
-  await next()
-  if (c.res.status === 404) {
-    c.res = new Response('Custom 404 Not Found', { status: 404 })
-  }
-})
-```
-
 ### Handling Error
 
 ```js
@@ -186,7 +183,7 @@ app.use('*', async (c, next) => {
     await next()
   } catch (err) {
     console.error(`${err}`)
-    c.res = new Response('Custom Error Message', { status: 500 })
+    c.res = c.text('Custom Error Message', { status: 500 })
   }
 })
 ```
@@ -219,13 +216,18 @@ To handle Request and Reponse easily, you can use Context object:
 ### c.req
 
 ```js
-
 // Get Request object
 app.get('/hello', (c) => {
   const userAgent = c.req.headers.get('User-Agent')
   ...
 })
 
+// Shortcut to get a header value
+app.get('/shortcut', (c) => {
+  const userAgent = c.req.header('User-Agent')
+  ...
+})
+
 // Query params
 app.get('/search', (c) => {
   const query = c.req.query('q')
@@ -234,40 +236,34 @@ app.get('/search', (c) => {
 
 // Captured params
 app.get('/entry/:id', (c) => {
-  const id = c.req.params('id')
+  const id = c.req.param('id')
   ...
 })
 ```
 
-### c.res
+### Shortcuts for Response
 
 ```js
-// Response object
-app.use('/', (c, next) => {
-  next()
-  c.res.headers.append('X-Debug', 'Debug message')
-})
-```
-
-### c.event
-
-```js
-// FetchEvent object
-app.use('*', async (c, next) => {
-  c.event.waitUntil(
-    ...
-  )
-  await next()
-})
-```
-
-### c.env
-
-```js
-// Environment object for Cloudflare Workers
-app.get('*', async c => {
-  const counter = c.env.COUNTER
-  ...
+app.get('/welcome', (c) => {
+  c.header('X-Message', 'Hello!')
+  c.header('Content-Type', 'text/plain')
+  c.status(201)
+  c.statusText('201 Content Created')
+
+  return c.body('Thank you for comming')
+
+  /*
+  Same as:
+  return new Response('Thank you for comming', {
+    status: 201,
+    statusText: '201 Content Created',
+    headers: {
+      'X-Message': 'Hello',
+      'Content-Type': 'text/plain',
+      'Content-Length: '22'
+    }
+  })
+  */
 })
 ```
 
@@ -310,6 +306,38 @@ app.get('/redirect', (c) => c.redirect('/'))
 app.get('/redirect-permanently', (c) => c.redirect('/', 301))
 ```
 
+### c.res
+
+```js
+// Response object
+app.use('/', (c, next) => {
+  next()
+  c.res.headers.append('X-Debug', 'Debug message')
+})
+```
+
+### c.event
+
+```js
+// FetchEvent object
+app.use('*', async (c, next) => {
+  c.event.waitUntil(
+    ...
+  )
+  await next()
+})
+```
+
+### c.env
+
+```js
+// Environment object for Cloudflare Workers
+app.get('*', async c => {
+  const counter = c.env.COUNTER
+  ...
+})
+```
+
 ## fire
 
 `app.fire()` do:

package/dist/context.d.ts

@@ -9,12 +9,20 @@ export declare class Context {
     res: Response;
     env: Env;
     event: FetchEvent;
+    private _headers;
+    private _status;
+    private _statusText;
+    render: (template: string, params?: object, options?: object) => Promise<Response>;
     constructor(req: Request, opts?: {
         res: Response;
         env: Env;
         event: FetchEvent;
     });
-    newResponse(body?: BodyInit | null | undefined, init?: ResponseInit | undefined): Response;
+    header(name: string, value: string): void;
+    status(number: number): void;
+    statusText(text: string): void;
+    newResponse(data: any, init?: ResponseInit): Response;
+    body(data: any, status?: number, headers?: Headers): Response;
     text(text: string, status?: number, headers?: Headers): Response;
     json(object: object, status?: number, headers?: Headers): Response;
     html(html: string, status?: number, headers?: Headers): Response;

package/dist/context.js

@@ -10,40 +10,52 @@ class Context {
             this.env = opts.env;
             this.event = opts.event;
         }
+        this._headers = {};
     }
-    newResponse(body, init) {
-        return new Response(body, init);
+    header(name, value) {
+        this._headers[name] = value;
     }
-    text(text, status = 200, headers = {}) {
+    status(number) {
+        this._status = number;
+    }
+    statusText(text) {
+        this._statusText = text;
+    }
+    newResponse(data, init = {}) {
+        init.status = init.status || this._status;
+        init.statusText = init.statusText || this._statusText;
+        const Encoder = new TextEncoder();
+        const length = data ? data.bytelength || Encoder.encode(data).byteLength : 0;
+        init.headers = Object.assign(Object.assign(Object.assign({}, this._headers), init.headers), { 'Content-Length': String(length) });
+        return new Response(data, init);
+    }
+    body(data, status = this._status, headers = this._headers) {
+        return this.newResponse(data, {
+            status: status,
+            headers: headers,
+        });
+    }
+    text(text, status = this._status, headers = {}) {
         if (typeof text !== 'string') {
             throw new TypeError('text method arg must be a string!');
         }
         headers['Content-Type'] = 'text/plain';
-        return this.newResponse(text, {
-            status: status,
-            headers: headers,
-        });
+        return this.body(text, status, headers);
     }
-    json(object, status = 200, headers = {}) {
+    json(object, status = this._status, headers = {}) {
         if (typeof object !== 'object') {
             throw new TypeError('json method arg must be a object!');
         }
         const body = JSON.stringify(object);
         headers['Content-Type'] = 'application/json; charset=UTF-8';
-        return this.newResponse(body, {
-            status: status,
-            headers: headers,
-        });
+        return this.body(body, status, headers);
     }
-    html(html, status = 200, headers = {}) {
+    html(html, status = this._status, headers = {}) {
         if (typeof html !== 'string') {
             throw new TypeError('html method arg must be a string!');
         }
         headers['Content-Type'] = 'text/html; charset=UTF-8';
-        return this.newResponse(html, {
-            status: status,
-            headers: headers,
-        });
+        return this.body(html, status, headers);
     }
     redirect(location, status = 302) {
         if (typeof location !== 'string') {

package/dist/hono.d.ts

@@ -5,9 +5,9 @@ import { Context } from './context';
 import type { Env } from './context';
 declare global {
     interface Request {
-        params: (key: string) => string;
+        param: (key: string) => string;
         query: (key: string) => string | null;
-        parsedBody: any;
+        header: (name: string) => string;
     }
 }
 export declare type Handler = (c: Context, next?: Function) => Response | Promise<Response>;

package/dist/hono.js

@@ -96,7 +96,7 @@ class Hono {
     async dispatch(request, env, event) {
         const [method, path] = [request.method, (0, url_1.getPathFromURL)(request.url)];
         const result = await this.matchRoute(method, path);
-        request.params = (key) => {
+        request.param = (key) => {
             if (result) {
                 return result.params[key];
             }
@@ -137,11 +137,23 @@ class Hono {
         });
     }
     onError(err) {
-        console.error(err);
-        return new Response('Internal Server Error', { status: 500 });
+        console.error(`${err}`);
+        const message = 'Internal Server Error';
+        return new Response(message, {
+            status: 500,
+            headers: {
+                'Content-Length': message.length.toString(),
+            },
+        });
     }
     notFound() {
-        return new Response('Not Found', { status: 404 });
+        const message = 'Not Found';
+        return new Response('Not Found', {
+            status: 404,
+            headers: {
+                'Content-Length': message.length.toString(),
+            },
+        });
     }
 }
 exports.Hono = Hono;

package/dist/middleware/body-parse/body-parse.d.ts

@@ -1,2 +1,7 @@
 import type { Context } from '../../context';
+declare global {
+    interface Request {
+        parsedBody: any;
+    }
+}
 export declare const bodyParse: () => (ctx: Context, next: Function) => Promise<void>;

package/dist/middleware/cookie/cookie.d.ts

@@ -0,0 +1,25 @@
+import type { Context } from '../../context';
+declare global {
+    interface Request {
+        cookie: (name: string) => string;
+    }
+}
+declare module '../../context' {
+    interface Context {
+        cookie: (name: string, value: string, options?: CookieOptions) => void;
+    }
+}
+export declare type Cookie = {
+    [key: string]: string;
+};
+export declare type CookieOptions = {
+    domain?: string;
+    expires?: Date;
+    httpOnly?: boolean;
+    maxAge?: number;
+    path?: string;
+    secure?: boolean;
+    signed?: boolean;
+    sameSite?: 'Strict' | 'Lax' | 'None';
+};
+export declare const cookie: () => (c: Context, next: Function) => Promise<void>;

package/dist/middleware/cookie/cookie.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cookie = void 0;
+const cookie = () => {
+    return async (c, next) => {
+        c.req.cookie = (name) => {
+            const cookie = c.req.headers.get('Cookie');
+            const obj = parse(cookie);
+            const value = obj[name];
+            return value;
+        };
+        c.cookie = (name, value, opt) => {
+            const cookie = serialize(name, value, opt);
+            c.header('Set-Cookie', cookie);
+        };
+        await next();
+    };
+};
+exports.cookie = cookie;
+const parse = (cookie) => {
+    const pairs = cookie.split(/;\s*/g);
+    const parsedCookie = {};
+    for (let i = 0, len = pairs.length; i < len; i++) {
+        const pair = pairs[i].split(/\s*=\s*([^\s]+)/);
+        parsedCookie[pair[0]] = decodeURIComponent(pair[1]);
+    }
+    return parsedCookie;
+};
+const serialize = (name, value, opt = {}) => {
+    value = encodeURIComponent(value);
+    let cookie = `${name}=${value}`;
+    if (opt.maxAge) {
+        cookie += `; Max-Age=${Math.floor(opt.maxAge)}`;
+    }
+    if (opt.domain) {
+        cookie += '; Domain=' + opt.domain;
+    }
+    if (opt.path) {
+        cookie += '; Path=' + opt.path;
+    }
+    if (opt.expires) {
+        cookie += '; Expires=' + opt.expires.toUTCString();
+    }
+    if (opt.httpOnly) {
+        cookie += '; HttpOnly';
+    }
+    if (opt.secure) {
+        cookie += '; Secure';
+    }
+    if (opt.sameSite) {
+        cookie += `; SameSaite=${opt.sameSite}`;
+    }
+    return cookie;
+};

package/dist/middleware/cors/cors.js

@@ -45,6 +45,8 @@ const cors = (options) => {
                 set('Access-Control-Allow-Headers', headers.join(','));
                 set('Vary', 'Access-Control-Request-Headers');
             }
+            c.res.headers.delete('Content-Length');
+            c.res.headers.delete('Content-Type');
             c.res = new Response(null, {
                 headers: c.res.headers,
                 status: 204,

package/dist/middleware/default.js

@@ -7,17 +7,9 @@ const defaultMiddleware = async (c, next) => {
         const url = new URL(c.req.url);
         return url.searchParams.get(key);
     };
+    c.req.header = (name) => {
+        return c.req.headers.get(name);
+    };
     await next();
-    if (c.res.body) {
-        // Do not clone Response, ex: c.res.clone().arrayBuffer()
-        const buffer = await c.res.arrayBuffer();
-        const res = new Response(buffer, {
-            status: c.res.status,
-            statusText: c.res.statusText,
-            headers: c.res.headers,
-        });
-        res.headers.append('Content-Length', buffer.byteLength.toString());
-        c.res = res;
-    }
 };
 exports.defaultMiddleware = defaultMiddleware;

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

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

package/dist/middleware/mustache/mustache.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mustache = void 0;
+const cloudflare_1 = require("../../utils/cloudflare");
+const EXTENSION = '.mustache';
+const mustache = () => {
+    let Mustache;
+    try {
+        Mustache = require('mustache');
+    }
+    catch (_a) {
+        // Do nothing.
+    }
+    return async (c, next) => {
+        if (!Mustache) {
+            throw new Error('If you want to use Mustache Middleware, install mustache module.');
+        }
+        c.render = async (filename, view = {}, options) => {
+            const content = await (0, cloudflare_1.getContentFromKVAsset)(`${filename}${EXTENSION}`);
+            if (!content) {
+                throw new Error(`Template "${filename}${EXTENSION}" is not found or blank.`);
+            }
+            const partialArgs = {};
+            if (options) {
+                const partials = options;
+                for (const key of Object.keys(partials)) {
+                    const partialContent = await (0, cloudflare_1.getContentFromKVAsset)(`${partials[key]}${EXTENSION}`);
+                    if (!partialContent) {
+                        throw new Error(`Partial Template "${partials[key]}${EXTENSION}" is not found or blank.`);
+                    }
+                    partialArgs[key] = partialContent;
+                }
+            }
+            const output = Mustache.render(content, view, partialArgs);
+            return c.html(output);
+        };
+        await next();
+    };
+};
+exports.mustache = mustache;

package/dist/middleware.d.ts

@@ -20,4 +20,6 @@ export declare class Middleware {
         credentials?: boolean;
         exposeHeaders?: string[];
     }) => (c: import("./context").Context, next: Function) => Promise<void>;
+    static cookie: () => (c: import("./context").Context, next: Function) => Promise<void>;
+    static mustache: () => (c: import("./context").Context, next: Function) => Promise<void>;
 }

package/dist/middleware.js

@@ -7,6 +7,8 @@ const logger_1 = require("./middleware/logger/logger");
 const basic_auth_1 = require("./middleware/basic-auth/basic-auth");
 const body_parse_1 = require("./middleware/body-parse/body-parse");
 const cors_1 = require("./middleware/cors/cors");
+const cookie_1 = require("./middleware/cookie/cookie");
+const mustache_1 = require("./middleware/mustache/mustache");
 class Middleware {
 }
 exports.Middleware = Middleware;
@@ -16,3 +18,5 @@ Middleware.logger = logger_1.logger;
 Middleware.basicAuth = basic_auth_1.basicAuth;
 Middleware.bodyParse = body_parse_1.bodyParse;
 Middleware.cors = cors_1.cors;
+Middleware.cookie = cookie_1.cookie;
+Middleware.mustache = mustache_1.mustache;

package/dist/utils/cloudflare.d.ts

@@ -0,0 +1 @@
+export declare const getContentFromKVAsset: (path: string) => Promise<string>;

package/dist/utils/cloudflare.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContentFromKVAsset = void 0;
+const getContentFromKVAsset = async (path) => {
+    let ASSET_MANIFEST;
+    if (typeof __STATIC_CONTENT_MANIFEST === 'string') {
+        ASSET_MANIFEST = JSON.parse(__STATIC_CONTENT_MANIFEST);
+    }
+    else {
+        ASSET_MANIFEST = __STATIC_CONTENT_MANIFEST;
+    }
+    const ASSET_NAMESPACE = __STATIC_CONTENT;
+    const key = ASSET_MANIFEST[path] || path;
+    if (!key) {
+        return;
+    }
+    let content;
+    content = await ASSET_NAMESPACE.get(key, { type: 'text' });
+    if (content) {
+        content = content;
+    }
+    return content;
+};
+exports.getContentFromKVAsset = getContentFromKVAsset;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "0.1.0",
+  "version": "0.2.3",
   "description": "[炎] Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,6 +36,7 @@
   "devDependencies": {
     "@cloudflare/workers-types": "^3.3.0",
     "@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",
@@ -51,6 +52,7 @@
     "form-data": "^4.0.0",
     "jest": "^27.4.5",
     "jest-environment-miniflare": "^2.0.0",
+    "mustache": "^4.2.0",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.1.2",
     "typescript": "^4.5.4"