hono 0.0.14 → 0.2.0

package/README.md

@@ -35,7 +35,7 @@ Fastest is hono
 
 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')
   ...
 ```
 
@@ -219,13 +219,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 +239,31 @@ 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
-
-```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
+### Shortcuts for Response
 
 ```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'
+    }
+  })
+  */
 })
 ```
 
@@ -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,19 @@ export declare class Context {
     res: Response;
     env: Env;
     event: FetchEvent;
+    private _headers;
+    private _status;
+    private _statusText;
+    body: (body: BodyInit, init?: ResponseInit) => 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(body: BodyInit, init?: ResponseInit): 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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = void 0;
-const util_1 = require("./util");
+const url_1 = require("./utils/url");
 class Context {
     constructor(req, opts) {
         this.req = req;
@@ -10,8 +10,22 @@ class Context {
             this.env = opts.env;
             this.event = opts.event;
         }
+        this._headers = {};
+        this.body = this.newResponse;
     }
-    newResponse(body, init) {
+    header(name, value) {
+        this._headers[name] = value;
+    }
+    status(number) {
+        this._status = number;
+    }
+    statusText(text) {
+        this._statusText = text;
+    }
+    newResponse(body, init = {}) {
+        init.status = this._status || init.status;
+        init.statusText = this._statusText || init.statusText;
+        init.headers = Object.assign(Object.assign({}, init.headers), this._headers);
         return new Response(body, init);
     }
     text(text, status = 200, headers = {}) {
@@ -49,7 +63,7 @@ class Context {
         if (typeof location !== 'string') {
             throw new TypeError('location must be a string!');
         }
-        if (!(0, util_1.isAbsoluteURL)(location)) {
+        if (!(0, url_1.isAbsoluteURL)(location)) {
             const url = new URL(this.req.url);
             url.pathname = location;
             location = url.toString();

package/dist/hono.d.ts

@@ -5,8 +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;
+        header: (name: string) => string;
         parsedBody: any;
     }
 }

package/dist/hono.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Hono = exports.Router = void 0;
 const node_1 = require("./node");
 const compose_1 = require("./compose");
-const util_1 = require("./util");
+const url_1 = require("./utils/url");
 const middleware_1 = require("./middleware");
 const context_1 = require("./context");
 const METHOD_NAME_OF_ALL = 'ALL';
@@ -94,9 +94,9 @@ class Hono {
         return this.router.match(method, path);
     }
     async dispatch(request, env, event) {
-        const [method, path] = [request.method, (0, util_1.getPathFromURL)(request.url)];
+        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];
             }

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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.basicAuth = void 0;
-const util_1 = require("../../util");
+const buffer_1 = require("../../utils/buffer");
 const CREDENTIALS_REGEXP = /^ *(?:[Bb][Aa][Ss][Ii][Cc]) +([A-Za-z0-9._~+/-]+=*) *$/;
 const USER_PASS_REGEXP = /^([^:]*):(.*)$/;
 const auth = (req) => {
@@ -33,8 +33,8 @@ const basicAuth = (options) => {
     }
     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);
+        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,

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

@@ -0,0 +1,23 @@
+import type { Context } from '../../context';
+declare global {
+    interface Request {
+        cookie: (name: string) => string;
+    }
+    interface Response {
+        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,34 @@
+"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;
+        };
+        await next();
+        c.res.cookie = (name, value, options) => {
+            console.log('c.res.cookie!');
+            const cookie = serialize(name, value);
+            c.res.headers.set('Set-Cookie', cookie);
+        };
+    };
+};
+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, options = {}) => {
+    value = encodeURIComponent(value);
+    const cookie = `${name}=${value}`;
+    return cookie;
+};

package/dist/middleware/cors/cors.d.ts

@@ -0,0 +1,11 @@
+import type { Context } from '../../context';
+declare type CORSOptions = {
+    origin: string;
+    allowMethods?: string[];
+    allowHeaders?: string[];
+    maxAge?: number;
+    credentials?: boolean;
+    exposeHeaders?: string[];
+};
+export declare const cors: (options?: CORSOptions) => (c: Context, next: Function) => Promise<void>;
+export {};

package/dist/middleware/cors/cors.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cors = void 0;
+const cors = (options) => {
+    const defaults = {
+        origin: '*',
+        allowMethods: ['GET', 'HEAD', 'PUT', 'POST', 'DELETE', 'PATCH'],
+        allowHeaders: [],
+        exposeHeaders: [],
+    };
+    const opts = Object.assign(Object.assign({}, defaults), options);
+    return async (c, next) => {
+        await next();
+        function set(key, value) {
+            c.res.headers.append(key, value);
+        }
+        set('Access-Control-Allow-Origin', opts.origin);
+        // Suppose the server sends a response with an Access-Control-Allow-Origin value with an explicit origin (rather than the "*" wildcard).
+        // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
+        if (opts.origin !== '*') {
+            set('Vary', 'Origin');
+        }
+        if (opts.credentials) {
+            set('Access-Control-Allow-Credentials', 'true');
+        }
+        if (opts.exposeHeaders.length) {
+            set('Access-Control-Expose-Headers', opts.exposeHeaders.join(','));
+        }
+        if (c.req.method === 'OPTIONS') {
+            // Preflight
+            if (opts.maxAge != null) {
+                set('Access-Control-Max-Age', opts.maxAge.toString());
+            }
+            if (opts.allowMethods.length) {
+                set('Access-Control-Allow-Methods', opts.allowMethods.join(','));
+            }
+            let headers = opts.allowHeaders;
+            if (!headers.length) {
+                const requestHeaders = c.req.headers.get('Access-Control-Request-Headers');
+                if (requestHeaders) {
+                    headers = requestHeaders.split(/\s*,\s*/);
+                }
+            }
+            if (headers.length) {
+                set('Access-Control-Allow-Headers', headers.join(','));
+                set('Vary', 'Access-Control-Request-Headers');
+            }
+            c.res = new Response(null, {
+                headers: c.res.headers,
+                status: 204,
+                statusText: c.res.statusText,
+            });
+        }
+    };
+};
+exports.cors = cors;

package/dist/middleware/default.js

@@ -7,10 +7,20 @@ 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) {
-        const buff = await c.res.clone().arrayBuffer();
-        c.res.headers.append('Content-Length', buff.byteLength.toString());
+        // 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/logger/logger.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logger = void 0;
-const util_1 = require("../../util");
+const url_1 = require("../../utils/url");
 const humanize = (n, opts) => {
     const options = opts || {};
     const d = options.delimiter || ',';
@@ -33,16 +33,16 @@ const colorStatus = (status = 0) => {
     };
     return out[(status / 100) | 0];
 };
-function log(fn, prefix, method, path, status, elasped) {
+function log(fn, prefix, method, path, status, elasped, contentLength) {
     const out = prefix === LogPrefix.Incoming
         ? `  ${prefix} ${method} ${path}`
-        : `  ${prefix} ${method} ${path} ${colorStatus(status)} ${elasped}`;
+        : `  ${prefix} ${method} ${path} ${colorStatus(status)} ${elasped} ${contentLength}`;
     fn(out);
 }
 const logger = (fn = console.log) => {
     return async (c, next) => {
         const { method } = c.req;
-        const path = (0, util_1.getPathFromURL)(c.req.url);
+        const path = (0, url_1.getPathFromURL)(c.req.url);
         log(fn, LogPrefix.Incoming, method, path);
         const start = Date.now();
         try {
@@ -52,7 +52,13 @@ const logger = (fn = console.log) => {
             log(fn, LogPrefix.Error, method, path, c.res.status || 500, time(start));
             throw e;
         }
-        log(fn, LogPrefix.Outgoing, method, path, c.res.status, time(start));
+        const len = parseFloat(c.res.headers.get('Content-Length'));
+        const contentLength = isNaN(len)
+            ? '0'
+            : len < 1024
+                ? `${len}b`
+                : `${len / 1024}kB`;
+        log(fn, LogPrefix.Outgoing, method, path, c.res.status, time(start), contentLength);
     };
 };
 exports.logger = logger;

package/dist/middleware.d.ts

@@ -12,4 +12,12 @@ export declare class Middleware {
         realm?: string;
     }) => (ctx: import("./context").Context, next: Function) => Promise<any>;
     static bodyParse: () => (ctx: import("./context").Context, next: Function) => Promise<void>;
+    static cors: (options?: {
+        origin: string;
+        allowMethods?: string[];
+        allowHeaders?: string[];
+        maxAge?: number;
+        credentials?: boolean;
+        exposeHeaders?: string[];
+    }) => (c: import("./context").Context, next: Function) => Promise<void>;
 }

package/dist/middleware.js

@@ -6,6 +6,7 @@ const powered_by_1 = require("./middleware/powered-by/powered-by");
 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");
 class Middleware {
 }
 exports.Middleware = Middleware;
@@ -14,3 +15,4 @@ Middleware.poweredBy = powered_by_1.poweredBy;
 Middleware.logger = logger_1.logger;
 Middleware.basicAuth = basic_auth_1.basicAuth;
 Middleware.bodyParse = body_parse_1.bodyParse;
+Middleware.cors = cors_1.cors;

package/dist/node.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Node = exports.Result = void 0;
-const util_1 = require("./util");
+const url_1 = require("./utils/url");
 const METHOD_NAME_OF_ALL = 'ALL';
 class Result {
     constructor(handler, params) {
@@ -25,7 +25,7 @@ class Node {
     insert(method, path, handler) {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         let curNode = this;
-        const parts = (0, util_1.splitPath)(path);
+        const parts = (0, url_1.splitPath)(path);
         for (let i = 0, len = parts.length; i < len; i++) {
             const p = parts[i];
             if (Object.keys(curNode.children).includes(p)) {
@@ -42,11 +42,12 @@ class Node {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         let curNode = this;
         const params = {};
-        const parts = (0, util_1.splitPath)(path);
+        const parts = (0, url_1.splitPath)(path);
         for (let i = 0, len = parts.length; i < len; i++) {
             const p = parts[i];
             // '*' => match any path
-            if (curNode.children['*']) {
+            // /api/* => default wildcard match
+            if (curNode.children['*'] && !curNode.children[p]) {
                 const astNode = curNode.children['*'];
                 if (Object.keys(astNode.children).length === 0) {
                     curNode = astNode;
@@ -73,7 +74,7 @@ class Node {
                     isWildcard = true;
                     break;
                 }
-                const pattern = (0, util_1.getPattern)(key);
+                const pattern = (0, url_1.getPattern)(key);
                 // Named match
                 if (pattern) {
                     const match = p.match(new RegExp(pattern[1]));

package/dist/utils/buffer.d.ts

@@ -0,0 +1,2 @@
+export declare const equal: (a: ArrayBuffer, b: ArrayBuffer) => boolean;
+export declare const timingSafeEqual: (a: any, b: any) => Promise<boolean>;

package/dist/utils/buffer.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timingSafeEqual = exports.equal = void 0;
+const equal = (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;
+};
+exports.equal = equal;
+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 (0, exports.equal)(sa, sb) && a === b;
+};
+exports.timingSafeEqual = timingSafeEqual;

package/dist/{util.d.ts → utils/url.d.ts}

@@ -2,4 +2,3 @@ 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 isAbsoluteURL: (url: string) => boolean;
-export declare const timingSafeEqual: (a: any, b: any) => Promise<boolean>;

package/dist/{util.js → utils/url.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.timingSafeEqual = exports.isAbsoluteURL = exports.getPathFromURL = exports.getPattern = exports.splitPath = void 0;
+exports.isAbsoluteURL = exports.getPathFromURL = exports.getPattern = exports.splitPath = void 0;
 const URL_REGEXP = /^(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?/;
 const splitPath = (path) => {
     const paths = path.split(/\//); // faster than path.split('/')
@@ -27,7 +27,6 @@ const getPattern = (label) => {
 };
 exports.getPattern = getPattern;
 const getPathFromURL = (url) => {
-    // XXX
     const match = url.match(URL_REGEXP);
     if (match) {
         return match[5];
@@ -43,30 +42,3 @@ const isAbsoluteURL = (url) => {
     return false;
 };
 exports.isAbsoluteURL = isAbsoluteURL;
-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.14",
+  "version": "0.2.0",
   "description": "[炎] Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",