@hono/node-server 1.12.1 → 1.13.0

package/README.md

@@ -194,6 +194,22 @@ app.use(
 )
 ```
 
+#### `onFound`
+
+You can specify handling when the requested file is found with `onFound`.
+
+```ts
+app.use(
+  '/static/*',
+  serveStatic({
+    // ...
+    onFound: (_path, c) => {
+      c.header('Cache-Control', `public, immutable, max-age=31536000`)
+    },
+  })
+)
+```
+
 #### `onNotFound`
 
 The `onNotFound` is useful for debugging. You can write a handle for when a file is not found.
@@ -210,6 +226,19 @@ app.use(
 )
 ```
 
+#### `precompressed`
+
+The `precompressed` option checks if files with extensions like `.br` or `.gz` are available and serves them based on the `Accept-Encoding` header. It prioritizes Brotli, then Zstd, and Gzip. If none are available, it serves the original file.
+
+```ts
+app.use(
+  '/static/*',
+  serveStatic({
+    precompressed: true,
+  })
+)
+```
+
 ## ConnInfo Helper
 
 You can use the [ConnInfo Helper](https://hono.dev/docs/helpers/conninfo) by importing `getConnInfo` from `@hono/node-server/conninfo`.

package/dist/serve-static.d.mts

@@ -1,14 +1,16 @@
-import { Context, MiddlewareHandler } from 'hono';
+import { Env, Context, MiddlewareHandler } from 'hono';
 
-type ServeStaticOptions = {
+type ServeStaticOptions<E extends Env = Env> = {
     /**
      * Root path, relative to current working directory from which the app was started. Absolute paths are not supported.
      */
     root?: string;
     path?: string;
     index?: string;
+    precompressed?: boolean;
     rewriteRequestPath?: (path: string) => string;
-    onNotFound?: (path: string, c: Context) => void | Promise<void>;
+    onFound?: (path: string, c: Context<E>) => void | Promise<void>;
+    onNotFound?: (path: string, c: Context<E>) => void | Promise<void>;
 };
 declare const serveStatic: (options?: ServeStaticOptions) => MiddlewareHandler;
 

package/dist/serve-static.d.ts

@@ -1,14 +1,16 @@
-import { Context, MiddlewareHandler } from 'hono';
+import { Env, Context, MiddlewareHandler } from 'hono';
 
-type ServeStaticOptions = {
+type ServeStaticOptions<E extends Env = Env> = {
     /**
      * Root path, relative to current working directory from which the app was started. Absolute paths are not supported.
      */
     root?: string;
     path?: string;
     index?: string;
+    precompressed?: boolean;
     rewriteRequestPath?: (path: string) => string;
-    onNotFound?: (path: string, c: Context) => void | Promise<void>;
+    onFound?: (path: string, c: Context<E>) => void | Promise<void>;
+    onNotFound?: (path: string, c: Context<E>) => void | Promise<void>;
 };
 declare const serveStatic: (options?: ServeStaticOptions) => MiddlewareHandler;
 

package/dist/serve-static.js

@@ -23,9 +23,16 @@ __export(serve_static_exports, {
   serveStatic: () => serveStatic
 });
 module.exports = __toCommonJS(serve_static_exports);
-var import_fs = require("fs");
 var import_filepath = require("hono/utils/filepath");
 var import_mime = require("hono/utils/mime");
+var import_fs = require("fs");
+var COMPRESSIBLE_CONTENT_TYPE_REGEX = /^\s*(?:text\/[^;\s]+|application\/(?:javascript|json|xml|xml-dtd|ecmascript|dart|postscript|rtf|tar|toml|vnd\.dart|vnd\.ms-fontobject|vnd\.ms-opentype|wasm|x-httpd-php|x-javascript|x-ns-proxy-autoconfig|x-sh|x-tar|x-virtualbox-hdd|x-virtualbox-ova|x-virtualbox-ovf|x-virtualbox-vbox|x-virtualbox-vdi|x-virtualbox-vhd|x-virtualbox-vmdk|x-www-form-urlencoded)|font\/(?:otf|ttf)|image\/(?:bmp|vnd\.adobe\.photoshop|vnd\.microsoft\.icon|vnd\.ms-dds|x-icon|x-ms-bmp)|message\/rfc822|model\/gltf-binary|x-shader\/x-fragment|x-shader\/x-vertex|[^;\s]+?\+(?:json|text|xml|yaml))(?:[;\s]|$)/i;
+var ENCODINGS = {
+  br: ".br",
+  zstd: ".zst",
+  gzip: ".gz"
+};
+var ENCODINGS_ORDERED_KEYS = Object.keys(ENCODINGS);
 var createStreamBody = (stream) => {
   const body = new ReadableStream({
     start(controller) {
@@ -86,10 +93,29 @@ var serveStatic = (options = { root: "" }) => {
       await options.onNotFound?.(path, c);
       return next();
     }
+    await options.onFound?.(path, c);
     const mimeType = (0, import_mime.getMimeType)(path);
     if (mimeType) {
       c.header("Content-Type", mimeType);
     }
+    if (options.precompressed && (!mimeType || COMPRESSIBLE_CONTENT_TYPE_REGEX.test(mimeType))) {
+      const acceptEncodingSet = new Set(
+        c.req.header("Accept-Encoding")?.split(",").map((encoding) => encoding.trim())
+      );
+      for (const encoding of ENCODINGS_ORDERED_KEYS) {
+        if (!acceptEncodingSet.has(encoding)) {
+          continue;
+        }
+        const precompressedStats = getStats(path + ENCODINGS[encoding]);
+        if (precompressedStats) {
+          c.header("Content-Encoding", encoding);
+          c.header("Vary", "Accept-Encoding", { append: true });
+          stats = precompressedStats;
+          path = path + ENCODINGS[encoding];
+          break;
+        }
+      }
+    }
     const size = stats.size;
     if (c.req.method == "HEAD" || c.req.method == "OPTIONS") {
       c.header("Content-Length", size.toString());

package/dist/serve-static.mjs

@@ -1,7 +1,14 @@
 // src/serve-static.ts
-import { createReadStream, lstatSync } from "fs";
 import { getFilePath, getFilePathWithoutDefaultDocument } from "hono/utils/filepath";
 import { getMimeType } from "hono/utils/mime";
+import { createReadStream, lstatSync } from "fs";
+var COMPRESSIBLE_CONTENT_TYPE_REGEX = /^\s*(?:text\/[^;\s]+|application\/(?:javascript|json|xml|xml-dtd|ecmascript|dart|postscript|rtf|tar|toml|vnd\.dart|vnd\.ms-fontobject|vnd\.ms-opentype|wasm|x-httpd-php|x-javascript|x-ns-proxy-autoconfig|x-sh|x-tar|x-virtualbox-hdd|x-virtualbox-ova|x-virtualbox-ovf|x-virtualbox-vbox|x-virtualbox-vdi|x-virtualbox-vhd|x-virtualbox-vmdk|x-www-form-urlencoded)|font\/(?:otf|ttf)|image\/(?:bmp|vnd\.adobe\.photoshop|vnd\.microsoft\.icon|vnd\.ms-dds|x-icon|x-ms-bmp)|message\/rfc822|model\/gltf-binary|x-shader\/x-fragment|x-shader\/x-vertex|[^;\s]+?\+(?:json|text|xml|yaml))(?:[;\s]|$)/i;
+var ENCODINGS = {
+  br: ".br",
+  zstd: ".zst",
+  gzip: ".gz"
+};
+var ENCODINGS_ORDERED_KEYS = Object.keys(ENCODINGS);
 var createStreamBody = (stream) => {
   const body = new ReadableStream({
     start(controller) {
@@ -62,10 +69,29 @@ var serveStatic = (options = { root: "" }) => {
       await options.onNotFound?.(path, c);
       return next();
     }
+    await options.onFound?.(path, c);
     const mimeType = getMimeType(path);
     if (mimeType) {
       c.header("Content-Type", mimeType);
     }
+    if (options.precompressed && (!mimeType || COMPRESSIBLE_CONTENT_TYPE_REGEX.test(mimeType))) {
+      const acceptEncodingSet = new Set(
+        c.req.header("Accept-Encoding")?.split(",").map((encoding) => encoding.trim())
+      );
+      for (const encoding of ENCODINGS_ORDERED_KEYS) {
+        if (!acceptEncodingSet.has(encoding)) {
+          continue;
+        }
+        const precompressedStats = getStats(path + ENCODINGS[encoding]);
+        if (precompressedStats) {
+          c.header("Content-Encoding", encoding);
+          c.header("Vary", "Accept-Encoding", { append: true });
+          stats = precompressedStats;
+          path = path + ENCODINGS[encoding];
+          break;
+        }
+      }
+    }
     const size = stats.size;
     if (c.req.method == "HEAD" || c.req.method == "OPTIONS") {
       c.header("Content-Length", size.toString());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/node-server",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "Node.js Adapter for Hono",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -60,8 +60,8 @@
     "postbuild": "publint",
     "prerelease": "yarn build && yarn test",
     "release": "np",
-    "lint": "eslint --ext js,ts src test",
-    "lint:fix": "eslint --ext js,ts src test --fix",
+    "lint": "eslint src test",
+    "lint:fix": "eslint src test --fix",
     "format": "prettier --check \"src/**/*.{js,ts}\" \"test/**/*.{js,ts}\"",
     "format:fix": "prettier --write \"src/**/*.{js,ts}\" \"test/**/*.{js,ts}\""
   },
@@ -80,12 +80,12 @@
     "node": ">=18.14.1"
   },
   "devDependencies": {
-    "@hono/eslint-config": "^0.0.4",
+    "@hono/eslint-config": "^1.0.1",
     "@types/jest": "^29.5.3",
     "@types/node": "^20.10.0",
     "@types/supertest": "^2.0.12",
     "@whatwg-node/fetch": "^0.9.14",
-    "eslint": "^8.55.0",
+    "eslint": "^9.10.0",
     "hono": "^4.4.10",
     "jest": "^29.6.1",
     "np": "^7.7.0",
@@ -95,5 +95,8 @@
     "ts-jest": "^29.1.1",
     "tsup": "^7.2.0",
     "typescript": "^5.3.2"
+  },
+  "peerDependencies": {
+    "hono": "^4"
   }
 }