hono 0.3.7 → 0.3.8

package/README.md

@@ -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
 
@@ -430,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/context.d.ts

@@ -5,8 +5,8 @@ declare type Headers = {
 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;
@@ -14,7 +14,7 @@ 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;

package/dist/context.js

@@ -28,7 +28,7 @@ class Context {
     }
     status(number) {
         if (this.res) {
-            console.warn('c.res.status is already setted.');
+            console.warn('c.res.status is already set.');
             return;
         }
         this._status = number;

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;
+    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;
@@ -43,3 +54,4 @@ export declare class Hono {
     onError(err: Error): Response;
     notFound(): Response;
 }
+export {};

package/dist/hono.js

@@ -24,7 +24,6 @@ class Hono {
         this.middlewareRouters = [];
         this.tempPath = '/';
     }
-    /* HTTP METHODS */
     get(arg, ...args) {
         return this.addRoute('get', arg, ...args);
     }
@@ -46,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);
     }
@@ -158,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/package.json

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

package/dist/middleware.d.ts

@@ -1,2 +0,0 @@
-export declare class Middleware {
-}

package/dist/middleware.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Middleware = void 0;
-class Middleware {
-}
-exports.Middleware = Middleware;