@hono/node-server 0.6.0 → 1.0.0

package/README.md

@@ -1,13 +1,14 @@
-# Hono on Node.js
+# Node.js Adapter for Hono
 
-This is **HTTP Server for Hono on Node.js**.
-Hono is ultrafast web framework for Cloudflare Workers, Deno, and Bun.
-**It's not for Node.js**.
-**BUT**, there may be a case that you really want to run on Node.js. This library is an adapter server that connects Hono and Node.js.
+This adapter allows you to run your Hono application on Node.js. Initially, Hono wasn't designed for Node.js, but with this adapter, it can now be used with Node.js. It utilizes web standard APIs implemented in Node.js version 18 or higher.
 
-Hono is ultra fast, but not so fast on Node.js, because there is an overhead to adapt Hono's API to Node.js.
+While Hono is ultra-fast, it may not be as fast on Node.js due to the overhead involved in adapting Hono's API to Node.js.
 
-By the way, it is 2.x times faster than Express.
+However, it's worth noting that it is still faster than Express.
+
+## Requirement
+
+- Node.js version 18 or higher.
 
 ## Install
 

package/dist/globals.d.ts

@@ -1,30 +1 @@
-import { atob, btoa } from './base64';
-declare global {
-    namespace NodeJS {
-        interface ProcessEnv {
-            NODE_ENV: 'development' | 'production' | 'test';
-        }
-        interface Global {
-            atob: typeof atob;
-            btoa: typeof btoa;
-            Blob: typeof Blob;
-            File: typeof File;
-            Headers: typeof Headers;
-            Request: typeof Request;
-            Response: typeof Response;
-            fetch: typeof fetch;
-            FormData: typeof FormData;
-            ReadableStream: typeof ReadableStream;
-            WritableStream: typeof WritableStream;
-            TransformStream: typeof TransformStream;
-            TextDecoderStream: typeof TextDecoderStream;
-            TextEncoderStream: typeof TextEncoderStream;
-            crypto: Crypto;
-        }
-    }
-}
-export declare function installGlobals(): void;
-/**
- * Credits:
- *   - https://github.com/remix-run/remix/blob/e77e2eb/packages/remix-node/globals.ts
- */
+export {};

package/dist/globals.js

@@ -3,42 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.installGlobals = void 0;
 const node_crypto_1 = __importDefault(require("node:crypto"));
-const web_stream_1 = require("@remix-run/web-stream");
-const base64_1 = require("./base64");
-const fetch_1 = require("./fetch");
-function installGlobals() {
-    if (typeof base64_1.atob === 'undefined')
-        global.atob = base64_1.atob;
-    if (typeof base64_1.btoa === 'undefined')
-        global.btoa = base64_1.btoa;
-    if (typeof Blob === 'undefined')
-        global.Blob = fetch_1.Blob;
-    global.File = fetch_1.File;
-    global.Headers = fetch_1.Headers;
-    global.Request = fetch_1.Request;
-    global.Response = fetch_1.Response;
-    global.fetch = fetch_1.fetch;
-    global.FormData = fetch_1.FormData;
-    global.ReadableStream = web_stream_1.ReadableStream;
-    global.WritableStream = web_stream_1.WritableStream;
-    global.TransformStream = web_stream_1.TransformStream;
-    global.TextDecoderStream = web_stream_1.TextDecoderStream;
-    global.TextEncoderStream = web_stream_1.TextEncoderStream;
-    if (typeof global.crypto === 'undefined') {
-        // If crypto.subtle is undefined, we're in a Node.js v16 environment
-        if (typeof node_crypto_1.default.subtle === 'undefined') {
-            // We can use the webcrypto polyfill
-            global.crypto = require('crypto').webcrypto;
-        }
-        else {
-            global.crypto = node_crypto_1.default;
-        }
-    }
+const webFetch = global.fetch;
+/** jest dose not use crypto in the global, but this is OK for node 18 */
+if (typeof global.crypto === 'undefined') {
+    global.crypto = node_crypto_1.default;
 }
-exports.installGlobals = installGlobals;
-/**
- * Credits:
- *   - https://github.com/remix-run/remix/blob/e77e2eb/packages/remix-node/globals.ts
- */
+global.fetch = (info, init) => {
+    init = {
+        // Disable compression handling so people can return the result of a fetch
+        // directly in the loader without messing with the Content-Encoding header.
+        compress: false,
+        ...init,
+    };
+    return webFetch(info, init);
+};

package/dist/listener.d.ts

@@ -1,3 +1,4 @@
 import { IncomingMessage, ServerResponse } from 'node:http';
 import { FetchCallback } from './types';
+import './globals';
 export declare const getRequestListener: (fetchCallback: FetchCallback) => (incoming: IncomingMessage, outgoing: ServerResponse) => Promise<void>;

package/dist/listener.js

@@ -1,39 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRequestListener = void 0;
-const fetch_1 = require("./fetch");
-const stream_1 = require("./stream");
+const node_stream_1 = require("node:stream");
+const promises_1 = require("node:stream/promises");
+require("./globals");
 const getRequestListener = (fetchCallback) => {
     return async (incoming, outgoing) => {
         const method = incoming.method || 'GET';
         const url = `http://${incoming.headers.host}${incoming.url}`;
-        const headerRecord = {};
+        const headerRecord = [];
         const len = incoming.rawHeaders.length;
-        for (let i = 0; i < len; i++) {
-            if (i % 2 === 0) {
-                const key = incoming.rawHeaders[i];
-                headerRecord[key] = incoming.rawHeaders[i + 1];
-            }
+        for (let i = 0; i < len; i += 2) {
+            headerRecord.push([incoming.rawHeaders[i], incoming.rawHeaders[i + 1]]);
         }
         const init = {
             method: method,
             headers: headerRecord,
-            // duplex: 'half', should used in nodejs 18
         };
         if (!(method === 'GET' || method === 'HEAD')) {
             // lazy-consume request body
-            init.body = (0, stream_1.nodeReadableToWebReadableStream)(incoming);
+            init.body = node_stream_1.Readable.toWeb(incoming);
+            init.duplex = 'half';
         }
         let res;
         try {
             res = (await fetchCallback(new Request(url.toString(), init)));
         }
         catch (e) {
-            res = new fetch_1.Response(null, { status: 500 });
+            res = new Response(null, { status: 500 });
             if (e instanceof Error) {
                 // timeout error emits 504 timeout
                 if (e.name === 'TimeoutError' || e.constructor.name === 'TimeoutError') {
-                    res = new fetch_1.Response(null, { status: 504 });
+                    res = new Response(null, { status: 504 });
                 }
             }
         }
@@ -45,7 +43,8 @@ const getRequestListener = (fetchCallback) => {
         const transferEncoding = res.headers.get('transfer-encoding');
         for (const [k, v] of res.headers) {
             if (k === 'set-cookie') {
-                outgoing.setHeader(k, res.headers.getAll(k));
+                // node native Headers.prototype has getSetCookie method
+                outgoing.setHeader(k, res.headers.getSetCookie(k));
             }
             else {
                 outgoing.setHeader(k, v);
@@ -67,7 +66,7 @@ const getRequestListener = (fetchCallback) => {
                     contentLength ||
                     /^no$/i.test(buffering) ||
                     !/^(application\/json\b|text\/(?!event-stream\b))/i.test(contentType)) {
-                    await (0, stream_1.writeReadableStreamToWritable)(res.body, outgoing);
+                    await (0, promises_1.pipeline)(node_stream_1.Readable.fromWeb(res.body), outgoing);
                 }
                 else {
                     const text = await res.text();

package/dist/serve-static.js

@@ -11,7 +11,7 @@ const serveStatic = (options = { root: '' }) => {
             await next();
         }
         const url = new URL(c.req.url);
-        const filename = options.path ?? url.pathname;
+        const filename = options.path ?? decodeURI(url.pathname);
         let path = (0, filepath_1.getFilePath)({
             filename: options.rewriteRequestPath ? options.rewriteRequestPath(filename) : filename,
             root: options.root,

package/dist/server.js

@@ -2,9 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serve = exports.createAdaptorServer = void 0;
 const node_http_1 = require("node:http");
-const globals_1 = require("./globals");
 const listener_1 = require("./listener");
-(0, globals_1.installGlobals)();
 const createAdaptorServer = (options) => {
     const fetchCallback = options.fetch;
     const requestListener = (0, listener_1.getRequestListener)(fetchCallback);

package/dist/types.d.ts

@@ -1,6 +1,4 @@
 /// <reference types="node" />
-import type { Hono } from 'hono';
-import type { NextApiHandler } from 'next/types';
 import type { createServer } from 'node:http';
 export declare type FetchCallback = (request: Request) => Promise<unknown> | unknown;
 export declare type NextHandlerOption = {
@@ -13,6 +11,3 @@ export declare type Options = {
     serverOptions?: Object;
     createServer?: typeof createServer;
 };
-export interface HandleInterface {
-    <E extends Hono<any, any>>(subApp: E, path?: string): NextApiHandler;
-}

package/dist/vercel.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import type { Env, Hono } from 'hono';
+export declare const handle: <E extends Env, S extends {}, BasePath extends string>(app: Hono<E, S, BasePath>) => (incoming: import("http").IncomingMessage, outgoing: import("http").ServerResponse<import("http").IncomingMessage>) => Promise<void>;

package/dist/vercel.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handle = void 0;
+const listener_1 = require("./listener");
+const handle = (app) => {
+    return (0, listener_1.getRequestListener)(app.fetch);
+};
+exports.handle = handle;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hono/node-server",
-  "version": "0.6.0",
-  "description": "HTTP Server for Hono on Node.js",
+  "version": "1.0.0",
+  "description": "Node.js Adapter for Hono",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -10,15 +10,15 @@
   "exports": {
     ".": "./dist/index.js",
     "./serve-static": "./dist/serve-static.js",
-    "./nextjs": "./dist/nextjs.js"
+    "./vercel": "./dist/vercel.js"
   },
   "typesVersions": {
     "*": {
       "serve-static": [
         "./dist/serve-static.d.ts"
       ],
-      "nextjs": [
-        "./dist/nextjs.d.ts"
+      "vercel": [
+        "./dist/vercel.d.ts"
       ]
     }
   },
@@ -39,19 +39,17 @@
     "registry": "https://registry.npmjs.org",
     "access": "public"
   },
-  "dependencies": {
-    "@remix-run/web-fetch": "^4.3.2",
-    "@remix-run/web-file": "^3.0.2",
-    "@remix-run/web-stream": "^1.0.3"
+  "engines": {
+    "node": ">=18.0.0"
   },
+  "dependencies": {},
   "devDependencies": {
     "@types/jest": "^29.0.1",
     "@types/node": "^18.7.16",
     "@types/supertest": "^2.0.12",
     "hono": "^3.1.5",
     "jest": "^29.0.3",
-    "next": "13.1.6",
-    "np": "^7.6.2",
+    "np": "^7.7.0",
     "rimraf": "^3.0.2",
     "supertest": "^6.2.4",
     "ts-jest": "^29.0.0",

package/dist/base64.d.ts

@@ -1,2 +0,0 @@
-export declare function atob(a: string): string;
-export declare function btoa(b: string): string;

package/dist/base64.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.btoa = exports.atob = void 0;
-function atob(a) {
-    return Buffer.from(a, 'base64').toString('binary');
-}
-exports.atob = atob;
-function btoa(b) {
-    return Buffer.from(b, 'binary').toString('base64');
-}
-exports.btoa = btoa;

package/dist/fetch.d.ts

@@ -1,27 +0,0 @@
-/// <reference types="node" />
-import type { Readable } from 'node:stream';
-import { fetch as webFetch, Headers as WebHeaders, Request as WebRequest, Response as WebResponse } from '@remix-run/web-fetch';
-export { FormData } from '@remix-run/web-fetch';
-export { File, Blob } from '@remix-run/web-file';
-declare type NodeHeadersInit = ConstructorParameters<typeof WebHeaders>[0];
-declare type NodeResponseInit = NonNullable<ConstructorParameters<typeof WebResponse>[1]>;
-declare type NodeRequestInfo = ConstructorParameters<typeof WebRequest>[0] | NodeRequest;
-declare type NodeRequestInit = Omit<NonNullable<ConstructorParameters<typeof WebRequest>[1]>, 'body'> & {
-    body?: NonNullable<ConstructorParameters<typeof WebRequest>[1]>['body'] | Readable;
-};
-export type { NodeHeadersInit as HeadersInit, NodeRequestInfo as RequestInfo, NodeRequestInit as RequestInit, NodeResponseInit as ResponseInit, };
-declare class NodeRequest extends WebRequest {
-    constructor(info: NodeRequestInfo, init?: NodeRequestInit);
-    get headers(): WebHeaders;
-    clone(): NodeRequest;
-}
-declare class NodeResponse extends WebResponse {
-    get headers(): WebHeaders;
-    clone(): NodeResponse;
-}
-export { WebHeaders as Headers, NodeRequest as Request, NodeResponse as Response };
-export declare const fetch: typeof webFetch;
-/**
- * Credits:
- *   - https://github.com/remix-run/remix/blob/e77e2eb/packages/remix-node/fetch.ts
- */

package/dist/fetch.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetch = exports.Response = exports.Request = exports.Headers = exports.Blob = exports.File = exports.FormData = void 0;
-const web_fetch_1 = require("@remix-run/web-fetch");
-Object.defineProperty(exports, "Headers", { enumerable: true, get: function () { return web_fetch_1.Headers; } });
-var web_fetch_2 = require("@remix-run/web-fetch");
-Object.defineProperty(exports, "FormData", { enumerable: true, get: function () { return web_fetch_2.FormData; } });
-var web_file_1 = require("@remix-run/web-file");
-Object.defineProperty(exports, "File", { enumerable: true, get: function () { return web_file_1.File; } });
-Object.defineProperty(exports, "Blob", { enumerable: true, get: function () { return web_file_1.Blob; } });
-class NodeRequest extends web_fetch_1.Request {
-    constructor(info, init) {
-        super(info, init);
-    }
-    get headers() {
-        return super.headers;
-    }
-    // @ts-ignore
-    clone() {
-        return new NodeRequest(this);
-    }
-}
-exports.Request = NodeRequest;
-class NodeResponse extends web_fetch_1.Response {
-    get headers() {
-        return super.headers;
-    }
-    clone() {
-        return super.clone();
-    }
-}
-exports.Response = NodeResponse;
-const fetch = (info, init) => {
-    init = {
-        // Disable compression handling so people can return the result of a fetch
-        // directly in the loader without messing with the Content-Encoding header.
-        compress: false,
-        ...init,
-    };
-    return (0, web_fetch_1.fetch)(info, init);
-};
-exports.fetch = fetch;
-/**
- * Credits:
- *   - https://github.com/remix-run/remix/blob/e77e2eb/packages/remix-node/fetch.ts
- */

package/dist/nextjs.d.ts

@@ -1,2 +0,0 @@
-import { HandleInterface } from './types';
-export declare const handle: HandleInterface;

package/dist/nextjs.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handle = void 0;
-const hono_1 = require("hono");
-const listener_1 = require("./listener");
-// <E extends Hono<any, any>
-const handle = (subApp, path = '/') => {
-    return (0, listener_1.getRequestListener)(new hono_1.Hono().route(path, subApp).fetch);
-};
-exports.handle = handle;

package/dist/stream.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="node" />
-import { Writable, Readable } from 'node:stream';
-/** pipeline will assure the backpressure and reduce huge memory usage */
-export declare function writeReadableStreamToWritable(stream: ReadableStream, writable: Writable): Promise<void>;
-/** This implementation use nodejs Readable::fromWeb as references */
-export declare function webReadableStreamToNodeReadable(stream: ReadableStream): Readable;
-export declare function nodeReadableToWebReadableStream(readable: Readable): ReadableStream<Uint8Array>;

package/dist/stream.js

@@ -1,107 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.nodeReadableToWebReadableStream = exports.webReadableStreamToNodeReadable = exports.writeReadableStreamToWritable = void 0;
-const node_stream_1 = require("node:stream");
-const node_util_1 = require("node:util");
-const pipelinePromise = (0, node_util_1.promisify)(node_stream_1.pipeline);
-/** pipeline will assure the backpressure and reduce huge memory usage */
-async function writeReadableStreamToWritable(stream, writable) {
-    const readable = webReadableStreamToNodeReadable(stream);
-    return pipelinePromise(readable, writable);
-}
-exports.writeReadableStreamToWritable = writeReadableStreamToWritable;
-/** This implementation use nodejs Readable::fromWeb as references */
-function webReadableStreamToNodeReadable(stream) {
-    const reader = stream.getReader();
-    let closed = false;
-    const readable = new node_stream_1.Readable({
-        read() {
-            reader
-                .read()
-                .then(({ done, value }) => {
-                if (done) {
-                    this.push(null);
-                }
-                else {
-                    this.push(value);
-                }
-            })
-                .catch(e => {
-                readable.destroy(e);
-            });
-        },
-        destroy(error, callback) {
-            const done = () => {
-                try {
-                    callback(error);
-                }
-                catch (err) {
-                    process.nextTick(() => {
-                        throw err;
-                    });
-                }
-            };
-            if (!closed) {
-                reader.cancel(error).then(done, done);
-                return;
-            }
-            done();
-        },
-    });
-    reader.closed.then(() => {
-        closed = true;
-    }, error => {
-        readable.destroy(error);
-    });
-    return readable;
-}
-exports.webReadableStreamToNodeReadable = webReadableStreamToNodeReadable;
-function nodeReadableToWebReadableStream(readable) {
-    if (readable.destroyed) {
-        const stream = new ReadableStream();
-        stream.cancel();
-        return stream;
-    }
-    const highWaterMark = readable.readableHighWaterMark;
-    const strategy = { highWaterMark };
-    let controller;
-    const onData = (chunk) => {
-        // Copy the Buffer to detach it from the pool.
-        if (Buffer.isBuffer(chunk)) {
-            chunk = new Uint8Array(chunk);
-        }
-        controller.enqueue(chunk);
-        if (controller.desiredSize !== null && controller.desiredSize <= 0) {
-            readable.pause();
-        }
-    };
-    readable.pause();
-    const cleanup = (0, node_stream_1.finished)(readable, error => {
-        if (error?.code === 'ERR_STREAM_PREMATURE_CLOSE') {
-            const err = new Error(undefined, { cause: error });
-            Object.defineProperty(err, 'name', 'AbortError');
-            error = err;
-        }
-        cleanup();
-        // This is a protection against non-standard, legacy streams
-        // that happen to emit an error event again after finished is called.
-        readable.on('error', () => { });
-        if (error) {
-            return controller.error(error);
-        }
-        controller.close();
-    });
-    readable.on('data', onData);
-    return new ReadableStream({
-        start(c) {
-            controller = c;
-        },
-        pull() {
-            readable.resume();
-        },
-        cancel(reason) {
-            readable.destroy(reason);
-        },
-    }, strategy);
-}
-exports.nodeReadableToWebReadableStream = nodeReadableToWebReadableStream;