hono 0.3.8 → 0.4.0

package/README.md

@@ -37,9 +37,13 @@ Below is a demonstration to create an application of Cloudflare Workers with Hon
 
 ![Demo](https://user-images.githubusercontent.com/10682/151973526-342644f9-71c5-4fee-81f4-64a7558bb192.gif)
 
+Now, the named path parameter has types.
+
+![Demo](https://user-images.githubusercontent.com/10682/154179671-9e491597-6778-44ac-a8e6-4483d7ad5393.png)
+
 ## Install
 
-You can install from npm registry:
+You can install Hono from npm registry:
 
 ```sh
 yarn add hono
@@ -53,7 +57,7 @@ npm install hono
 
 ## Methods
 
-Instance of `Hono` has these methods:
+An instance of `Hono` has these methods:
 
 - app.**HTTP_METHOD**(path, handler)
 - app.**all**(path, handler)
@@ -104,14 +108,17 @@ app.get('/post/:date{[0-9]+}/:title{[a-z]+}', (c) => {
   ...
 ```
 
-### Chained Route
+### Nested route
 
 ```js
-app
-  .route('/api/book')
-    .get(() => {...})
-    .post(() => {...})
-    .put(() => {...})
+const book = app.route('/book')
+book.get('/', (c) => c.text('List Books')) // => GET /book
+book.get('/:id', (c) => {
+  // => GET /book/:id
+  const id = c.req.param('id')
+  return c.text('Get Book: ' + id)
+})
+book.post('/', (c) => c.text('Create Book')) // => POST /book
 ```
 
 ### Custom 404 Response
@@ -124,6 +131,18 @@ app.get('*', (c) => {
 })
 ```
 
+### no strict
+
+If `strict` is set `false`, `/hello`and`/hello/` are treated the same:
+
+```js
+const app = new Hono({ strict: false })
+
+app.get('/hello', (c) => c.text('/hello or /hello/'))
+```
+
+Default is `true`.
+
 ## async/await
 
 ```js
@@ -147,15 +166,7 @@ const app = new Hono()
 
 app.use('*', poweredBy())
 app.use('*', logger())
-app.use(
-  '/auth/*',
-  basicAuth({
-    username: 'hono',
-    password: 'acoolproject',
-  })
-)
-
-...
+app.use('/auth/*', basicAuth({ username: 'hono', password: 'acoolproject' }))
 ```
 
 Available builtin middleware are listed on [src/middleware](https://github.com/yusukebe/hono/tree/master/src/middleware).
@@ -440,6 +451,10 @@ Contributions Welcome! You can contribute by the following way:
 
 If you can, let's make Hono together!
 
+## Contributors
+
+Thanks to [all contributors](https://github.com/yusukebe/hono/graphs/contributors)!
+
 ## Author
 
 Yusuke Wada <https://github.com/yusukebe>

package/dist/context.d.ts

@@ -1,7 +1,5 @@
 /// <reference types="@cloudflare/workers-types" />
-declare type Headers = {
-    [key: string]: string;
-};
+declare type Headers = Record<string, string>;
 declare type Data = string | ArrayBuffer | ReadableStream;
 export interface Env {
 }

package/dist/hono.d.ts

@@ -22,30 +22,26 @@ export declare class Router<T> {
     add(method: string, path: string, handler: T): void;
     match(method: string, path: string): Result<T> | null;
 }
+declare type Init = {
+    strict?: boolean;
+};
 export declare class Hono {
     router: Router<Handler[]>;
     middlewareRouters: Router<MiddlewareHandler>[];
     tempPath: string;
-    constructor();
-    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;
+    strict: boolean;
+    constructor(init?: Init);
+    get<Path extends string>(path: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    post<Path extends string>(path: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    put<Path extends string>(path: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    head<Path extends string>(path: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    delete<Path extends string>(path: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    options<Path extends string>(path: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    patch<Path extends string>(path: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
+    all<Path extends string>(path: Path, ...args: Handler<ParamKeys<Path>>[]): Hono;
     route(path: string): Hono;
     use(path: string, middleware: MiddlewareHandler): void;
-    addRoute(method: string, arg: string | Handler, ...args: Handler[]): Hono;
+    addRoute(method: string, path: string, ...args: Handler[]): Hono;
     matchRoute(method: string, path: string): Promise<Result<Handler[]>>;
     dispatch(request: Request, env?: Env, event?: FetchEvent): Promise<Response>;
     handleEvent(event: FetchEvent): Promise<Response>;

package/dist/hono.js

@@ -5,7 +5,6 @@ const node_1 = require("./node");
 const compose_1 = require("./compose");
 const url_1 = require("./utils/url");
 const context_1 = require("./context");
-const METHOD_NAME_OF_ALL = 'ALL';
 class Router {
     constructor() {
         this.node = new node_1.Node();
@@ -19,65 +18,65 @@ class Router {
 }
 exports.Router = Router;
 class Hono {
-    constructor() {
+    constructor(init = { strict: true }) {
         this.router = new Router();
         this.middlewareRouters = [];
-        this.tempPath = '/';
+        this.tempPath = null;
+        this.strict = init.strict; // strict routing - default is true
     }
-    get(arg, ...args) {
-        return this.addRoute('get', arg, ...args);
+    get(path, ...args) {
+        return this.addRoute('get', path, ...args);
     }
-    post(arg, ...args) {
-        return this.addRoute('post', arg, ...args);
+    post(path, ...args) {
+        return this.addRoute('post', path, ...args);
     }
-    put(arg, ...args) {
-        return this.addRoute('put', arg, ...args);
+    put(path, ...args) {
+        return this.addRoute('put', path, ...args);
     }
-    head(arg, ...args) {
-        return this.addRoute('head', arg, ...args);
+    head(path, ...args) {
+        return this.addRoute('head', path, ...args);
     }
-    delete(arg, ...args) {
-        return this.addRoute('delete', arg, ...args);
+    delete(path, ...args) {
+        return this.addRoute('delete', path, ...args);
     }
-    options(arg, ...args) {
-        return this.addRoute('options', arg, ...args);
+    options(path, ...args) {
+        return this.addRoute('options', path, ...args);
     }
-    patch(arg, ...args) {
-        return this.addRoute('patch', arg, ...args);
+    patch(path, ...args) {
+        return this.addRoute('patch', path, ...args);
     }
-    all(arg, ...args) {
-        return this.addRoute('all', arg, ...args);
+    all(path, ...args) {
+        return this.addRoute('all', path, ...args);
     }
     route(path) {
-        this.tempPath = path;
-        return this;
+        const newHono = new Hono();
+        newHono.tempPath = path;
+        newHono.router = this.router;
+        return newHono;
     }
     use(path, middleware) {
         if (middleware.constructor.name !== 'AsyncFunction') {
             throw new TypeError('middleware must be a async function!');
         }
         const router = new Router();
-        router.add(METHOD_NAME_OF_ALL, path, middleware);
+        router.add(node_1.METHOD_NAME_OF_ALL, path, middleware);
         this.middlewareRouters.push(router);
     }
     // addRoute('get', '/', handler)
-    addRoute(method, arg, ...args) {
+    addRoute(method, path, ...args) {
         method = method.toUpperCase();
-        if (typeof arg === 'string') {
-            this.tempPath = arg;
-            this.router.add(method, arg, args);
-        }
-        else {
-            args.unshift(arg);
-            this.router.add(method, this.tempPath, args);
+        if (this.tempPath) {
+            path = (0, url_1.mergePath)(this.tempPath, path);
         }
+        this.router.add(method, path, args);
         return this;
     }
     async matchRoute(method, path) {
         return this.router.match(method, path);
     }
     async dispatch(request, env, event) {
-        const [method, path] = [request.method, (0, url_1.getPathFromURL)(request.url)];
+        const path = (0, url_1.getPathFromURL)(request.url, { strict: this.strict });
+        const method = request.method;
         const result = await this.matchRoute(method, path);
         // Methods for Request object
         request.param = (key) => {
@@ -95,7 +94,7 @@ class Hono {
         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);
+            const mwResult = mr.match(node_1.METHOD_NAME_OF_ALL, path);
             if (mwResult) {
                 middleware.push(mwResult.handler);
             }

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

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

package/dist/middleware/mustache/mustache.js

@@ -4,8 +4,8 @@ exports.mustache = void 0;
 const cloudflare_1 = require("../../utils/cloudflare");
 const EXTENSION = '.mustache';
 const DEFAULT_DOCUMENT = 'index.mustache';
-const mustache = (opt = { root: '' }) => {
-    const { root } = opt;
+const mustache = (init = { root: '' }) => {
+    const { root } = init;
     return async (c, next) => {
         let Mustache;
         try {
@@ -15,7 +15,11 @@ const mustache = (opt = { root: '' }) => {
             throw new Error('If you want to use Mustache Middleware, install "mustache" package first.');
         }
         c.render = async (filename, params = {}, options) => {
-            const path = (0, cloudflare_1.getKVFilePath)({ filename: `${filename}${EXTENSION}`, root: root, defaultDocument: DEFAULT_DOCUMENT });
+            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 "${path}" is not found or blank.`);

package/dist/node.d.ts

@@ -1,24 +1,15 @@
+export declare const METHOD_NAME_OF_ALL = "ALL";
 export declare class Result<T> {
     handler: T;
-    params: {
-        [key: string]: string;
-    };
-    constructor(handler: T, params: {
-        [key: string]: string;
-    });
+    params: Record<string, string>;
+    constructor(handler: T, params: Record<string, string>);
 }
 export declare class Node<T> {
-    method: {
-        [key: string]: T;
-    };
+    method: Record<string, T>;
     handler: T;
-    children: {
-        [key: string]: Node<T>;
-    };
+    children: Record<string, Node<T>>;
     middlewares: [];
-    constructor(method?: string, handler?: T, children?: {
-        [key: string]: Node<T>;
-    });
+    constructor(method?: string, handler?: T, children?: Record<string, Node<T>>);
     insert(method: string, path: string, handler: T): Node<T>;
     search(method: string, path: string): Result<T>;
 }

package/dist/node.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Node = exports.Result = void 0;
+exports.Node = exports.Result = exports.METHOD_NAME_OF_ALL = void 0;
 const url_1 = require("./utils/url");
-const METHOD_NAME_OF_ALL = 'ALL';
+exports.METHOD_NAME_OF_ALL = 'ALL';
 class Result {
     constructor(handler, params) {
         this.handler = handler;
@@ -95,7 +95,7 @@ class Node {
                 return noRoute();
             }
         }
-        const handler = curNode.method[METHOD_NAME_OF_ALL] || curNode.method[method];
+        const handler = curNode.method[exports.METHOD_NAME_OF_ALL] || curNode.method[method];
         if (!handler) {
             return noRoute();
         }

package/dist/utils/url.d.ts

@@ -1,4 +1,9 @@
 export declare const splitPath: (path: string) => string[];
 export declare const getPattern: (label: string) => string[] | null;
-export declare const getPathFromURL: (url: string) => string;
+declare type Params = {
+    strict: boolean;
+};
+export declare const getPathFromURL: (url: string, params?: Params) => string;
 export declare const isAbsoluteURL: (url: string) => boolean;
+export declare const mergePath: (...paths: string[]) => string;
+export {};

package/dist/utils/url.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAbsoluteURL = exports.getPathFromURL = exports.getPattern = exports.splitPath = void 0;
+exports.mergePath = exports.isAbsoluteURL = exports.getPathFromURL = exports.getPattern = exports.splitPath = void 0;
 const URL_REGEXP = /^(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?/;
 const splitPath = (path) => {
     const paths = path.split(/\//); // faster than path.split('/')
@@ -26,7 +26,12 @@ const getPattern = (label) => {
     return null;
 };
 exports.getPattern = getPattern;
-const getPathFromURL = (url) => {
+const getPathFromURL = (url, params = { strict: true }) => {
+    // if strict routing is false => `/hello/hey/` and `/hello/hey` are treated the same
+    // default is true
+    if (!params.strict && url.endsWith('/')) {
+        url = url.slice(0, -1);
+    }
     const match = url.match(URL_REGEXP);
     if (match) {
         return match[5];
@@ -42,3 +47,27 @@ const isAbsoluteURL = (url) => {
     return false;
 };
 exports.isAbsoluteURL = isAbsoluteURL;
+const mergePath = (...paths) => {
+    let p = '';
+    let endsWithSlash = false;
+    for (let path of paths) {
+        /* ['/hey/','/say'] => ['/hey', '/say'] */
+        if (p.endsWith('/')) {
+            p = p.slice(0, -1);
+            endsWithSlash = true;
+        }
+        /* ['/hey','say'] => ['/hey', '/say'] */
+        if (!path.startsWith('/')) {
+            path = `/${path}`;
+        }
+        /* ['/hey/', '/'] => `/hey/` */
+        if (path === '/' && endsWithSlash) {
+            p = `${p}/`;
+        }
+        else if (path !== '/') {
+            p = `${p}${path}`;
+        }
+    }
+    return p;
+};
+exports.mergePath = mergePath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "description": "[炎] Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",