hono 0.2.1 → 0.3.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/151102477-be0f950e-8d23-49c5-b6d8-d8ecb6b7484e.gif)
+![Demo](https://user-images.githubusercontent.com/10682/151973526-342644f9-71c5-4fee-81f4-64a7558bb192.gif)
 
 ## Install
 
@@ -138,19 +138,24 @@ app.get('/fetch-url', async (c) => {
 ### Builtin Middleware
 
 ```js
-import { Hono, Middleware } from 'hono'
+import { Hono } from 'hono'
+import { poweredBy } from 'hono/powered-by'
+import { logger } from 'hono/logger'
+import { basicAuth } from 'hono/basicAuth'
 
-...
+const app = new Hono()
 
-app.use('*', Middleware.poweredBy())
-app.use('*', Middleware.logger())
+app.use('*', poweredBy())
+app.use('*', logger())
 app.use(
   '/auth/*',
-  Middleware.basicAuth({
+  basicAuth({
     username: 'hono',
     password: 'acoolproject',
   })
 )
+
+...
 ```
 
 Available builtin middleware are listed on [src/middleware](https://github.com/yusukebe/hono/tree/master/src/middleware).
@@ -358,6 +363,11 @@ export default {
     return app.fetch(request, env, event)
   },
 }
+
+/*
+or just do this:
+export default app
+*/
 ```
 
 ## Cloudflare Workers with Hono

package/dist/context.js

@@ -24,9 +24,22 @@ class Context {
     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) });
+        init.headers = Object.assign(Object.assign({}, this._headers), init.headers);
+        // Content-Length
+        let length = 0;
+        if (data) {
+            if (data instanceof ArrayBuffer) {
+                length = data.byteLength;
+            }
+            else if (typeof data == 'string') {
+                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);
     }
     body(data, status = this._status, headers = this._headers) {

package/dist/hono.d.ts

@@ -8,6 +8,7 @@ declare global {
         param: (key: string) => string;
         query: (key: string) => string | null;
         header: (name: string) => string;
+        parsedBody: any;
     }
 }
 export declare type Handler = (c: Context, next?: Function) => Response | Promise<Response>;

package/dist/hono.js

@@ -48,6 +48,7 @@ class Hono {
         return this.addRoute('patch', arg, ...args);
     }
     /*
+    We may implement these HTTP methods:
     trace
     copy
     lock

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 export { Hono } from './hono';
 export type { Handler, MiddlewareHandler } from './hono';
-export { Middleware } from './middleware';
 export { Context } from './context';
 export type { Env } from './context';

package/dist/index.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = exports.Middleware = exports.Hono = void 0;
+exports.Context = exports.Hono = void 0;
 var hono_1 = require("./hono");
 Object.defineProperty(exports, "Hono", { enumerable: true, get: function () { return hono_1.Hono; } });
-var middleware_1 = require("./middleware");
-Object.defineProperty(exports, "Middleware", { enumerable: true, get: function () { return middleware_1.Middleware; } });
 var context_1 = require("./context");
 Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });

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

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

package/dist/middleware/mustache/mustache.js

@@ -1,51 +1,35 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 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) => {
-        let Mustache;
-        try {
-            Mustache = await Promise.resolve().then(() => __importStar(require('mustache')));
-        }
-        catch (e) {
-            console.error(`Mustache is not found! ${e}`);
-            throw new Error(`${e}`);
+        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`);
+            const buffer = await (0, cloudflare_1.getContentFromKVAsset)(`${filename}${EXTENSION}`);
+            if (!buffer) {
+                throw new Error(`Template "${filename}${EXTENSION}" is not found or blank.`);
             }
+            const content = bufferToString(buffer);
             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`);
+                    const partialBuffer = await (0, cloudflare_1.getContentFromKVAsset)(`${partials[key]}${EXTENSION}`);
+                    if (!partialBuffer) {
+                        throw new Error(`Partial Template "${partials[key]}${EXTENSION}" is not found or blank.`);
                     }
-                    partialArgs[key] = partialContent;
+                    partialArgs[key] = bufferToString(partialBuffer);
                 }
             }
             const output = Mustache.render(content, view, partialArgs);
@@ -55,3 +39,10 @@ const mustache = () => {
     };
 };
 exports.mustache = mustache;
+const bufferToString = (buffer) => {
+    if (buffer instanceof ArrayBuffer) {
+        const enc = new TextDecoder('utf-8');
+        return enc.decode(buffer);
+    }
+    return buffer;
+};

package/dist/middleware/serve-static/serve-static.d.ts

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

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serveStatic = void 0;
+const cloudflare_1 = require("../../utils/cloudflare");
+const mime_1 = require("../../utils/mime");
+const DEFAULT_DOCUMENT = 'index.html';
+// This middleware is available only on Cloudflare Workers.
+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 content = await (0, cloudflare_1.getContentFromKVAsset)(path);
+        if (content) {
+            const mimeType = (0, mime_1.getMimeType)(path);
+            if (mimeType) {
+                c.header('Content-Type', mimeType);
+            }
+            c.res = c.body(content);
+        }
+        else {
+            // console.debug(`Static file: ${path} is not found`)
+        }
+    };
+};
+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/middleware.d.ts

@@ -1,25 +1,3 @@
 export declare class Middleware {
     static default: (c: import("./context").Context, next: Function) => Promise<void>;
-    static poweredBy: () => (c: import("./context").Context, next: Function) => Promise<void>;
-    static logger: (fn?: {
-        (...data: any[]): void;
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    }) => (c: import("./context").Context, next: Function) => Promise<void>;
-    static basicAuth: (options: {
-        username: string;
-        password: string;
-        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>;
-    static cookie: () => (c: import("./context").Context, next: Function) => Promise<void>;
-    static mustache: () => (c: import("./context").Context, next: Function) => Promise<void>;
 }

package/dist/middleware.js

@@ -2,21 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Middleware = void 0;
 const default_1 = require("./middleware/default");
-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");
-const cookie_1 = require("./middleware/cookie/cookie");
-const mustache_1 = require("./middleware/mustache/mustache");
 class Middleware {
 }
 exports.Middleware = Middleware;
 Middleware.default = default_1.defaultMiddleware;
-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;
-Middleware.cookie = cookie_1.cookie;
-Middleware.mustache = mustache_1.mustache;

package/dist/utils/cloudflare.d.ts

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

package/dist/utils/cloudflare.js

@@ -14,8 +14,7 @@ const getContentFromKVAsset = async (path) => {
     if (!key) {
         return;
     }
-    let content;
-    content = await ASSET_NAMESPACE.get(key, { type: 'text' });
+    let content = await ASSET_NAMESPACE.get(key, { type: 'arrayBuffer' });
     if (content) {
         content = content;
     }

package/dist/utils/mime.d.ts

@@ -0,0 +1 @@
+export declare const getMimeType: (filename: string) => string;

package/dist/utils/mime.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMimeType = void 0;
+const getMimeType = (filename) => {
+    const regexp = /\.([a-zA-Z0-9]+?)$/;
+    const match = filename.match(regexp);
+    if (!match) {
+        return;
+    }
+    let mimeType = mimes[match[1]];
+    if (mimeType.startsWith('text') || mimeType === 'application/json') {
+        mimeType += '; charset=utf-8';
+    }
+    return mimeType;
+};
+exports.getMimeType = getMimeType;
+const mimes = {
+    aac: 'audio/aac',
+    abw: 'application/x-abiword',
+    arc: 'application/x-freearc',
+    avi: 'video/x-msvideo',
+    azw: 'application/vnd.amazon.ebook',
+    bin: 'application/octet-stream',
+    bmp: 'image/bmp',
+    bz: 'application/x-bzip',
+    bz2: 'application/x-bzip2',
+    csh: 'application/x-csh',
+    css: 'text/css',
+    csv: 'text/csv',
+    doc: 'application/msword',
+    docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+    eot: 'application/vnd.ms-fontobject',
+    epub: 'application/epub+zip',
+    gz: 'application/gzip',
+    gif: 'image/gif',
+    htm: 'text/html',
+    html: 'text/html',
+    ico: 'image/vnd.microsoft.icon',
+    ics: 'text/calendar',
+    jar: 'application/java-archive',
+    jpeg: 'image/jpeg',
+    jpg: 'image/jpeg',
+    js: 'text/javascript',
+    json: 'application/json',
+    jsonld: 'application/ld+json',
+    mid: 'audio/x-midi',
+    midi: 'audio/x-midi',
+    mjs: 'text/javascript',
+    mp3: 'audio/mpeg',
+    mpeg: 'video/mpeg',
+    mpkg: 'application/vnd.apple.installer+xml',
+    odp: 'application/vnd.oasis.opendocument.presentation',
+    ods: 'application/vnd.oasis.opendocument.spreadsheet',
+    odt: 'application/vnd.oasis.opendocument.text',
+    oga: 'audio/ogg',
+    ogv: 'video/ogg',
+    ogx: 'application/ogg',
+    opus: 'audio/opus',
+    otf: 'font/otf',
+    png: 'image/png',
+    pdf: 'application/pdf',
+    php: 'application/php',
+    ppt: 'application/vnd.ms-powerpoint',
+    pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+    rar: 'application/vnd.rar',
+    rtf: 'application/rtf',
+    sh: 'application/x-sh',
+    svg: 'image/svg+xml',
+    swf: 'application/x-shockwave-flash',
+    tar: 'application/x-tar',
+    tif: 'image/tiff',
+    tiff: 'image/tiff',
+    ts: 'video/mp2t',
+    ttf: 'font/ttf',
+    txt: 'text/plain',
+    vsd: 'application/vnd.visio',
+    wav: 'audio/wav',
+    weba: 'audio/webm',
+    webm: 'video/webm',
+    webp: 'image/webp',
+    woff: 'font/woff',
+    woff2: 'font/woff2',
+    xhtml: 'application/xhtml+xml',
+    xls: 'application/vnd.ms-excel',
+    xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+    xml: 'application/xml',
+    xul: 'application/vnd.mozilla.xul+xml',
+    zip: 'application/zip',
+    '3gp': 'video/3gpp',
+    '3g2': 'video/3gpp2',
+    '7z': 'application/x-7z-compressed',
+};

package/package.json

@@ -1,12 +1,51 @@
 {
   "name": "hono",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "[炎] Ultrafast web framework for Cloudflare Workers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./basic-auth": "./dist/middleware/basic-auth/basic-auth.js",
+    "./body-parse": "./dist/middleware/body-parse/body-parse.js",
+    "./cookie": "./dist/middleware/cookie/cookie.js",
+    "./cors": "./dist/middleware/cors/cors.js",
+    "./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"
+  },
+  "typesVersions": {
+    "*": {
+      "basic-auth": [
+        "./dist/middleware/basic-auth/basic-auth.d.ts"
+      ],
+      "body-parse": [
+        "./dist/middleware/body-parse/body-parse.d.ts"
+      ],
+      "cookie": [
+        "./dist/middleware/cookie/cookie.d.ts"
+      ],
+      "cors": [
+        "./dist/middleware/cors/cors.d.ts"
+      ],
+      "logger": [
+        "./dist/middleware/logger/logger.d.ts"
+      ],
+      "mustache": [
+        "./dist/middleware/mustache/mustache.d.ts"
+      ],
+      "powered-by": [
+        "./dist/middleware/powered-by/powered-by.d.ts"
+      ],
+      "serve-static": [
+        "./dist/middleware/serve-static/serve-static.d.ts"
+      ]
+    }
+  },
   "scripts": {
     "test": "jest",
     "lint": "eslint --ext js,ts src .eslintrc.js test",
@@ -55,7 +94,7 @@
     "mustache": "^4.2.0",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.1.2",
-    "typescript": "^4.5.4"
+    "typescript": "^4.5.5"
   },
   "engines": {
     "node": ">=11.0.0"