hono 0.3.4 → 0.3.8

package/README.md

@@ -1,6 +1,6 @@
 # Hono
 
-Hono[炎] - _**means flame🔥 in Japanese**_ - is small, simple, and ultrafast web flamework for a Service Workers API based serverless such as Cloudflare Workers and Fastly Compute@Edge.
+Hono[炎] - _**means flame🔥 in Japanese**_ - is small, simple, and ultrafast web framework for a Service Workers API based serverless such as Cloudflare Workers and Fastly Compute@Edge.
 
 ```js
 import { Hono } from 'hono'
@@ -13,7 +13,7 @@ app.fire()
 
 ## Features
 
-- **Ultra fast** - the router is implemented with Trie-Tree structure.
+- **Ultra fast** - the router is implemented with Trie-Tree structure. Not use loops.
 - **Zero dependencies** - using only Web standard API.
 - **Middleware** - builtin middleware, and you can make your own middleware.
 - **Optimized** - for Cloudflare Workers.
@@ -174,7 +174,7 @@ app.use('*', async (c, next) => {
 // Add a custom header
 app.use('/message/*', async (c, next) => {
   await next()
-  await c.res.headers.add('x-message', 'This is middleware!')
+  await c.header('x-message', 'This is middleware!')
 })
 
 app.get('/message/hello', (c) => c.text('Hello Middleware!'))
@@ -193,30 +193,9 @@ app.use('*', async (c, next) => {
 })
 ```
 
-### Complex Pattern
-
-You can also do this:
-
-```js
-// Output response time
-app.use('*', async (c, next) => {
-  await next()
-  const responseTime = await c.res.headers.get('X-Response-Time')
-  console.log(`X-Response-Time: ${responseTime}`)
-})
-
-// Add X-Response-Time header
-app.use('*', async (c, next) => {
-  const start = Date.now()
-  await next()
-  const ms = Date.now() - start
-  await c.res.headers.append('X-Response-Time', `${ms}ms`)
-})
-```
-
 ## Context
 
-To handle Request and Reponse easily, you can use Context object:
+To handle Request and Reponse, you can use Context object:
 
 ### c.req
 
@@ -253,7 +232,6 @@ 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')
 
@@ -261,7 +239,7 @@ app.get('/welcome', (c) => {
   Same as:
   return new Response('Thank you for comming', {
     status: 201,
-    statusText: '201 Content Created',
+    statusText: 'Created',
     headers: {
       'X-Message': 'Hello',
       'Content-Type': 'text/plain',
@@ -431,7 +409,7 @@ Run the development server locally. Then, access like `http://127.0.0.1:8787/` i
 wrangler dev
 ```
 
-### Publish
+### 7. Publish
 
 Deploy to Cloudflare. That's all!
 

package/dist/compose.d.ts

@@ -1 +1 @@
-export declare const compose: (middleware: any) => (context: any, next?: Function) => any;
+export declare const compose: <T>(middleware: Function[]) => (context: T, next?: Function) => Promise<void | object>;

package/dist/compose.js

@@ -7,7 +7,7 @@ const compose = (middleware) => {
     return function (context, next) {
         let index = -1;
         return dispatch(0);
-        function dispatch(i) {
+        async function dispatch(i) {
             if (i <= index)
                 return Promise.reject(new Error('next() called multiple times'));
             index = i;

package/dist/context.d.ts

@@ -2,10 +2,11 @@
 declare type Headers = {
     [key: string]: string;
 };
+declare type Data = string | ArrayBuffer | ReadableStream;
 export interface Env {
 }
-export declare class Context {
-    req: Request;
+export declare class Context<RequestParamKeyType = string> {
+    req: Request<RequestParamKeyType>;
     res: Response;
     env: Env;
     event: FetchEvent;
@@ -13,16 +14,15 @@ export declare class Context {
     private _status;
     private _statusText;
     render: (template: string, params?: object, options?: object) => Promise<Response>;
-    constructor(req: Request, opts?: {
+    constructor(req: Request<RequestParamKeyType>, opts?: {
         res: Response;
         env: Env;
         event: FetchEvent;
     });
     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;
+    newResponse(data: Data, init?: ResponseInit): Response;
+    body(data: Data, 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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = void 0;
 const url_1 = require("./utils/url");
+const http_status_1 = require("./utils/http-status");
 class Context {
     constructor(req, opts) {
         this.req = req;
@@ -13,13 +14,25 @@ class Context {
         this._headers = {};
     }
     header(name, value) {
+        /*
+        XXX:
+        app.use('*', (c, next) => {
+          next()
+          c.header('foo', 'bar') // => c.res.headers.set(...)
+        })
+        */
+        if (this.res) {
+            this.res.headers.set(name, value);
+        }
         this._headers[name] = value;
     }
     status(number) {
+        if (this.res) {
+            console.warn('c.res.status is already set.');
+            return;
+        }
         this._status = number;
-    }
-    statusText(text) {
-        this._statusText = text;
+        this._statusText = (0, http_status_1.getStatusText)(number);
     }
     newResponse(data, init = {}) {
         init.status = init.status || this._status;
@@ -35,9 +48,6 @@ class Context {
                 const Encoder = new TextEncoder();
                 length = Encoder.encode(data).byteLength || 0;
             }
-            else {
-                length = data.bytelength;
-            }
         }
         init.headers = Object.assign(Object.assign({}, init.headers), { 'Content-Length': length.toString() });
         return new Response(data, init);
@@ -52,7 +62,7 @@ class Context {
         if (typeof text !== 'string') {
             throw new TypeError('text method arg must be a string!');
         }
-        headers['Content-Type'] = 'text/plain';
+        headers['Content-Type'] || (headers['Content-Type'] = 'text/plain; charset=UTF-8');
         return this.body(text, status, headers);
     }
     json(object, status = this._status, headers = {}) {
@@ -60,14 +70,14 @@ class Context {
             throw new TypeError('json method arg must be a object!');
         }
         const body = JSON.stringify(object);
-        headers['Content-Type'] = 'application/json; charset=UTF-8';
+        headers['Content-Type'] || (headers['Content-Type'] = 'application/json; charset=UTF-8');
         return this.body(body, status, 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';
+        headers['Content-Type'] || (headers['Content-Type'] = 'text/html; charset=UTF-8');
         return this.body(html, status, headers);
     }
     redirect(location, status = 302) {

package/dist/hono.d.ts

@@ -4,15 +4,18 @@ import { Node } from './node';
 import { Context } from './context';
 import type { Env } from './context';
 declare global {
-    interface Request {
-        param: (key: string) => string;
-        query: (key: string) => string | null;
+    interface Request<ParamKeyType = string> {
+        param: (key: ParamKeyType) => string;
+        query: (key: string) => string;
         header: (name: string) => string;
         parsedBody: any;
     }
 }
-export declare type Handler = (c: Context, next?: Function) => Response | Promise<Response>;
+export declare type Handler<RequestParamKeyType = string> = (c: Context<RequestParamKeyType>, next?: Function) => Response | Promise<Response>;
 export declare type MiddlewareHandler = (c: Context, next: Function) => Promise<void>;
+declare type ParamKeyName<NameWithPattern> = NameWithPattern extends `${infer Name}{${infer _Pattern}` ? Name : NameWithPattern;
+declare type ParamKey<Component> = Component extends `:${infer NameWithPattern}` ? ParamKeyName<NameWithPattern> : never;
+declare type ParamKeys<Path> = Path extends `${infer Component}/${infer Rest}` ? ParamKey<Component> | ParamKeys<Rest> : ParamKey<Path>;
 export declare class Router<T> {
     node: Node<T>;
     constructor();
@@ -24,14 +27,22 @@ export declare class Hono {
     middlewareRouters: Router<MiddlewareHandler>[];
     tempPath: string;
     constructor();
-    get(arg: string | Handler, ...args: Handler[]): Hono;
-    post(arg: string | Handler, ...args: Handler[]): Hono;
-    put(arg: string | Handler, ...args: Handler[]): Hono;
-    head(arg: string | Handler, ...args: Handler[]): Hono;
-    delete(arg: string | Handler, ...args: Handler[]): Hono;
-    options(arg: string | Handler, ...args: Handler[]): Hono;
-    patch(arg: string | Handler, ...args: Handler[]): Hono;
-    all(arg: string | Handler, ...args: Handler[]): Hono;
+    get<Path extends string>(arg: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    get(arg: Handler<never>, ...args: Handler<never>[]): Hono;
+    post<Path extends string>(arg: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    post(arg: Handler, ...args: Handler[]): Hono;
+    put<Path extends string>(arg: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    put(arg: Handler, ...args: Handler[]): Hono;
+    head<Path extends string>(arg: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    head(arg: Handler, ...args: Handler[]): Hono;
+    delete<Path extends string>(arg: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    delete(arg: Handler, ...args: Handler[]): Hono;
+    options<Path extends string>(arg: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    options(arg: Handler, ...args: Handler[]): Hono;
+    patch<Path extends string>(arg: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    patch(arg: Handler, ...args: Handler[]): Hono;
+    all<Path extends string>(arg: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    all(arg: Handler<never>, ...args: Handler<never>[]): Hono;
     route(path: string): Hono;
     use(path: string, middleware: MiddlewareHandler): void;
     addRoute(method: string, arg: string | Handler, ...args: Handler[]): Hono;
@@ -40,6 +51,7 @@ export declare class Hono {
     handleEvent(event: FetchEvent): Promise<Response>;
     fetch(request: Request, env?: Env, event?: FetchEvent): Promise<Response>;
     fire(): void;
-    onError(err: any): Response;
+    onError(err: Error): Response;
     notFound(): Response;
 }
+export {};

package/dist/hono.js

@@ -4,7 +4,6 @@ exports.Hono = exports.Router = void 0;
 const node_1 = require("./node");
 const compose_1 = require("./compose");
 const url_1 = require("./utils/url");
-const middleware_1 = require("./middleware");
 const context_1 = require("./context");
 const METHOD_NAME_OF_ALL = 'ALL';
 class Router {
@@ -25,7 +24,6 @@ class Hono {
         this.middlewareRouters = [];
         this.tempPath = '/';
     }
-    /* HTTP METHODS */
     get(arg, ...args) {
         return this.addRoute('get', arg, ...args);
     }
@@ -47,22 +45,6 @@ class Hono {
     patch(arg, ...args) {
         return this.addRoute('patch', arg, ...args);
     }
-    /*
-    We may implement these HTTP methods:
-    trace
-    copy
-    lock
-    purge
-    unlock
-    report
-    checkout
-    merge
-    notify
-    subscribe
-    unsubscribe
-    search
-    connect
-    */
     all(arg, ...args) {
         return this.addRoute('all', arg, ...args);
     }
@@ -97,11 +79,18 @@ 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);
+        // Methods for Request object
         request.param = (key) => {
             if (result) {
                 return result.params[key];
             }
-            return '';
+        };
+        request.header = (name) => {
+            return request.headers.get(name);
+        };
+        request.query = (key) => {
+            const url = new URL(c.req.url);
+            return url.searchParams.get(key);
         };
         const handler = result ? result.handler[0] : this.notFound; // XXX
         const middleware = [];
@@ -112,10 +101,13 @@ class Hono {
             }
         }
         const wrappedHandler = async (context, next) => {
-            context.res = await handler(context);
+            const res = await handler(context);
+            if (!(res instanceof Response)) {
+                throw new TypeError('response must be a instace of Response');
+            }
+            context.res = res;
             await next();
         };
-        middleware.push(middleware_1.Middleware.default);
         middleware.push(wrappedHandler);
         const composed = (0, compose_1.compose)(middleware);
         const c = new context_1.Context(request, { env: env, event: event, res: null });
@@ -149,7 +141,7 @@ class Hono {
     }
     notFound() {
         const message = 'Not Found';
-        return new Response('Not Found', {
+        return new Response(message, {
             status: 404,
             headers: {
                 'Content-Length': message.length.toString(),

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

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

package/dist/middleware/mustache/mustache.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mustache = void 0;
 const cloudflare_1 = require("../../utils/cloudflare");
 const EXTENSION = '.mustache';
-const mustache = () => {
+const DEFAULT_DOCUMENT = 'index.mustache';
+const mustache = (opt = { root: '' }) => {
+    const { root } = opt;
     return async (c, next) => {
         let Mustache;
         try {
@@ -12,24 +14,30 @@ const mustache = () => {
         catch (_a) {
             throw new Error('If you want to use Mustache Middleware, install "mustache" package first.');
         }
-        c.render = async (filename, view = {}, options) => {
-            const buffer = await (0, cloudflare_1.getContentFromKVAsset)(`${filename}${EXTENSION}`);
+        c.render = async (filename, params = {}, options) => {
+            const path = (0, cloudflare_1.getKVFilePath)({ filename: `${filename}${EXTENSION}`, root: root, defaultDocument: DEFAULT_DOCUMENT });
+            const buffer = await (0, cloudflare_1.getContentFromKVAsset)(path);
             if (!buffer) {
-                throw new Error(`Template "${filename}${EXTENSION}" is not found or blank.`);
+                throw new Error(`Template "${path}" is not found or blank.`);
             }
             const content = bufferToString(buffer);
             const partialArgs = {};
             if (options) {
                 const partials = options;
                 for (const key of Object.keys(partials)) {
-                    const partialBuffer = await (0, cloudflare_1.getContentFromKVAsset)(`${partials[key]}${EXTENSION}`);
+                    const partialPath = (0, cloudflare_1.getKVFilePath)({
+                        filename: `${partials[key]}${EXTENSION}`,
+                        root: root,
+                        defaultDocument: DEFAULT_DOCUMENT,
+                    });
+                    const partialBuffer = await (0, cloudflare_1.getContentFromKVAsset)(partialPath);
                     if (!partialBuffer) {
-                        throw new Error(`Partial Template "${partials[key]}${EXTENSION}" is not found or blank.`);
+                        throw new Error(`Partial Template "${partialPath}" is not found or blank.`);
                     }
                     partialArgs[key] = bufferToString(partialBuffer);
                 }
             }
-            const output = Mustache.render(content, view, partialArgs);
+            const output = Mustache.render(content, params, partialArgs);
             return c.html(output);
         };
         await next();

package/dist/middleware/serve-static/serve-static.js

@@ -9,7 +9,7 @@ const serveStatic = (opt = { root: '' }) => {
     return async (c, next) => {
         await next();
         const url = new URL(c.req.url);
-        const path = getKVPath(url.pathname, opt.root);
+        const path = (0, cloudflare_1.getKVFilePath)({ filename: url.pathname, root: opt.root, defaultDocument: DEFAULT_DOCUMENT });
         const content = await (0, cloudflare_1.getContentFromKVAsset)(path);
         if (content) {
             const mimeType = (0, mime_1.getMimeType)(path);
@@ -24,21 +24,3 @@ const serveStatic = (opt = { root: '' }) => {
     };
 };
 exports.serveStatic = serveStatic;
-const getKVPath = (filename, root) => {
-    if (filename.endsWith('/')) {
-        // /top/ => /top/index.html
-        filename = filename.concat(DEFAULT_DOCUMENT);
-    }
-    else if (!(0, mime_1.getMimeType)(filename)) {
-        // /top => /top/index.html
-        filename = filename.concat('/' + DEFAULT_DOCUMENT);
-    }
-    // /foo.html => foo.html
-    filename = filename.replace(/^\//, '');
-    // assets/ => assets
-    root = root.replace(/\/$/, '');
-    // ./assets/foo.html => assets/foo.html
-    let path = root + '/' + filename;
-    path = path.replace(/^\.?\//, '');
-    return path;
-};

package/dist/node.d.ts

@@ -16,7 +16,7 @@ export declare class Node<T> {
         [key: string]: Node<T>;
     };
     middlewares: [];
-    constructor(method?: string, handler?: any, children?: {
+    constructor(method?: string, handler?: T, children?: {
         [key: string]: Node<T>;
     });
     insert(method: string, path: string, handler: T): Node<T>;

package/dist/utils/buffer.d.ts

@@ -1,4 +1,4 @@
 export declare const equal: (a: ArrayBuffer, b: ArrayBuffer) => boolean;
 export declare const decodeBase64: (str: string) => any;
-export declare const sha256: (a: string) => Promise<string>;
-export declare const timingSafeEqual: (a: any, b: any) => Promise<boolean>;
+export declare const sha256: (a: string | object | boolean) => Promise<string>;
+export declare const timingSafeEqual: (a: string | object | boolean, b: string | object | boolean) => Promise<boolean>;

package/dist/utils/cloudflare.d.ts

@@ -1 +1,8 @@
 export declare const getContentFromKVAsset: (path: string) => Promise<ArrayBuffer>;
+declare type Options = {
+    filename: string;
+    root?: string;
+    defaultDocument?: string;
+};
+export declare const getKVFilePath: (opt: Options) => string;
+export {};

package/dist/utils/cloudflare.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getContentFromKVAsset = void 0;
+exports.getKVFilePath = exports.getContentFromKVAsset = void 0;
 const getContentFromKVAsset = async (path) => {
     let ASSET_MANIFEST;
     if (typeof __STATIC_CONTENT_MANIFEST === 'string') {
@@ -21,3 +21,25 @@ const getContentFromKVAsset = async (path) => {
     return content;
 };
 exports.getContentFromKVAsset = getContentFromKVAsset;
+const getKVFilePath = (opt) => {
+    let filename = opt.filename;
+    let root = opt.root || '';
+    const defaultDocument = opt.defaultDocument || 'index.html';
+    if (filename.endsWith('/')) {
+        // /top/ => /top/index.html
+        filename = filename.concat(defaultDocument);
+    }
+    else if (!filename.match(/\.[a-zA-Z0-9]+$/)) {
+        // /top => /top/index.html
+        filename = filename.concat('/' + defaultDocument);
+    }
+    // /foo.html => foo.html
+    filename = filename.replace(/^\//, '');
+    // assets/ => assets
+    root = root.replace(/\/$/, '');
+    // ./assets/foo.html => assets/foo.html
+    let path = root ? root + '/' + filename : filename;
+    path = path.replace(/^\.?\//, '');
+    return path;
+};
+exports.getKVFilePath = getKVFilePath;

package/dist/utils/http-status.d.ts

@@ -0,0 +1 @@
+export declare const getStatusText: (statusNumber: number) => string;

package/dist/utils/http-status.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStatusText = void 0;
+const getStatusText = (statusNumber) => {
+    const text = statuses[statusNumber];
+    return text;
+};
+exports.getStatusText = getStatusText;
+const statuses = {
+    200: 'OK',
+    201: 'Created',
+    202: 'Accepted',
+    204: 'No Content',
+    206: 'Partial Content',
+    301: 'Moved Permanently',
+    302: 'Moved Temporarily',
+    303: 'See Other',
+    304: 'Not Modified',
+    307: 'Temporary Redirect',
+    308: 'Permanent Redirect',
+    400: 'Bad Request',
+    401: 'Unauthorized',
+    402: 'Payment Required',
+    403: 'Forbidden',
+    404: 'Not Found',
+    405: 'Not Allowed',
+    406: 'Not Acceptable',
+    408: 'Request Time-out',
+    409: 'Conflict',
+    410: 'Gone',
+    411: 'Length Required',
+    412: 'Precondition Failed',
+    413: 'Request Entity Too Large',
+    414: 'Request-URI Too Large',
+    415: 'Unsupported Media Type',
+    416: 'Requested Range Not Satisfiable',
+    421: 'Misdirected Request',
+    429: 'Too Many Requests',
+    500: 'Internal Server Error',
+    501: 'Not Implemented',
+    502: 'Bad Gateway',
+    503: 'Service Temporarily Unavailable',
+    504: 'Gateway Time-out',
+    505: 'HTTP Version Not Supported',
+    507: 'Insufficient Storage',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "0.3.4",
+  "version": "0.3.8",
   "description": "[炎] Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,7 +16,9 @@
     "./logger": "./dist/middleware/logger/logger.js",
     "./mustache": "./dist/middleware/mustache/mustache.js",
     "./powered-by": "./dist/middleware/powered-by/powered-by.js",
-    "./serve-static": "./dist/middleware/serve-static/serve-static.js"
+    "./serve-static": "./dist/middleware/serve-static/serve-static.js",
+    "./utils/buffer": "./dist/utils/buffer.js",
+    "./package.json": "./package.json"
   },
   "typesVersions": {
     "*": {

package/dist/middleware/default.d.ts

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

package/dist/middleware/default.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultMiddleware = void 0;
-const defaultMiddleware = async (c, next) => {
-    c.req.query = (key) => {
-        // eslint-disable-next-line
-        const url = new URL(c.req.url);
-        return url.searchParams.get(key);
-    };
-    c.req.header = (name) => {
-        return c.req.headers.get(name);
-    };
-    await next();
-};
-exports.defaultMiddleware = defaultMiddleware;

package/dist/middleware.d.ts

@@ -1,3 +0,0 @@
-export declare class Middleware {
-    static default: (c: import("./context").Context, next: Function) => Promise<void>;
-}

package/dist/middleware.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Middleware = void 0;
-const default_1 = require("./middleware/default");
-class Middleware {
-}
-exports.Middleware = Middleware;
-Middleware.default = default_1.defaultMiddleware;