hono 4.13.8 → 4.13.10

package/dist/cjs/middleware/compress/index.js

@@ -1,97 +1,82 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var compress_exports = {};
-__export(compress_exports, {
-  COMPRESSIBLE_CONTENT_TYPE_REGEX: () => import_compress.COMPRESSIBLE_CONTENT_TYPE_REGEX,
-  compress: () => compress
-});
-module.exports = __toCommonJS(compress_exports);
-var import_accept = require("../../utils/accept");
-var import_compress = require("../../utils/compress");
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_utils_accept = require("../../utils/accept.js");
+const require_utils_compress = require("../../utils/compress.js");
+//#region src/middleware/compress/index.ts
 const ENCODING_TYPES = ["gzip", "deflate"];
 const cacheControlNoTransformRegExp = /(?:^|,)\s*?no-transform\s*?(?:,|$)/i;
 const selectEncoding = (header, candidates) => {
-  if (header === void 0) {
-    return void 0;
-  }
-  const accepts = (0, import_accept.parseAccept)(header);
-  const wildcardQ = accepts.find((a) => a.type === "*")?.q;
-  let best;
-  for (const enc of candidates) {
-    const explicit = accepts.find((a) => a.type.toLowerCase() === enc);
-    const q = explicit ? explicit.q : wildcardQ ?? 0;
-    if (q === 1) {
-      return enc;
-    } else if (q > 0 && (!best || q > best.q)) {
-      best = { encoding: enc, q };
-    }
-  }
-  return best?.encoding;
+	if (header === void 0) return;
+	const accepts = require_utils_accept.parseAccept(header);
+	const wildcardQ = accepts.find((a) => a.type === "*")?.q;
+	let best;
+	for (const enc of candidates) {
+		const explicit = accepts.find((a) => a.type.toLowerCase() === enc);
+		const q = explicit ? explicit.q : wildcardQ ?? 0;
+		if (q === 1) return enc;
+		else if (q > 0 && (!best || q > best.q)) best = {
+			encoding: enc,
+			q
+		};
+	}
+	return best?.encoding;
 };
 const varyAcceptEncodingRegExp = /(?:^|,)\s*accept-encoding\s*(?:,|$)/i;
+/**
+* Compress Middleware for Hono.
+*
+* @see {@link https://hono.dev/docs/middleware/builtin/compress}
+*
+* @param {CompressionOptions} [options] - The options for the compress middleware.
+* @param {'gzip' | 'deflate'} [options.encoding] - The compression scheme to allow for response compression. Either 'gzip' or 'deflate'. If not defined, both are allowed and will be used based on the Accept-Encoding header. 'gzip' is prioritized if this option is not provided and the client provides both in the Accept-Encoding header.
+* @param {number} [options.threshold=1024] - The minimum size in bytes to compress. Defaults to 1024 bytes.
+* @param {RegExp | Function} [options.contentTypeFilter=COMPRESSIBLE_CONTENT_TYPE_REGEX] - A RegExp or function to determine if the response Content-Type should be compressed.
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* const app = new Hono()
+*
+* app.use(compress())
+*
+* // Compress only JSON responses
+* app.use(compress({ contentTypeFilter: /^application\/json/ }))
+*
+* // Compress based on custom Content-Type logic
+* app.use(compress({ contentTypeFilter: (type) => COMPRESSIBLE_CONTENT_TYPE_REGEX.test(type) || type === "application/x-myformat" }))
+* ```
+*/
 const compress = (options) => {
-  const threshold = options?.threshold ?? 1024;
-  const candidates = options?.encoding ? [options.encoding] : ENCODING_TYPES;
-  const contentTypeFilter = options?.contentTypeFilter ?? import_compress.COMPRESSIBLE_CONTENT_TYPE_REGEX;
-  const shouldCompress = typeof contentTypeFilter === "function" ? (res) => {
-    const type = res.headers.get("Content-Type");
-    return type && contentTypeFilter(type);
-  } : (res) => {
-    const type = res.headers.get("Content-Type");
-    return type && contentTypeFilter.test(type);
-  };
-  return async function compress2(ctx, next) {
-    await next();
-    const contentLength = ctx.res.headers.get("Content-Length");
-    if (ctx.res.status === 206 || // partial content, Content-Range refers to the uncompressed bytes
-    ctx.res.headers.has("Content-Encoding") || // already encoded
-    ctx.res.headers.has("Transfer-Encoding") || // already encoded or chunked
-    ctx.req.method === "HEAD" || // HEAD request
-    contentLength && Number(contentLength) < threshold || // content-length below threshold
-    !shouldCompress(ctx.res) || // not compressible type
-    !shouldTransform(ctx.res)) {
-      return;
-    }
-    const current = ctx.res.headers.get("Vary");
-    if (current !== "*" && !(current && varyAcceptEncodingRegExp.test(current))) {
-      ctx.header("Vary", current ? `${current}, Accept-Encoding` : "Accept-Encoding");
-    }
-    const accepted = ctx.req.header("Accept-Encoding");
-    const encoding = selectEncoding(accepted, candidates);
-    if (!encoding || !ctx.res.body) {
-      return;
-    }
-    const stream = new CompressionStream(encoding);
-    ctx.res = new Response(ctx.res.body.pipeThrough(stream), ctx.res);
-    ctx.res.headers.delete("Content-Length");
-    ctx.res.headers.set("Content-Encoding", encoding);
-    const etag = ctx.res.headers.get("ETag");
-    if (etag && !etag.startsWith("W/")) {
-      ctx.res.headers.set("ETag", `W/${etag}`);
-    }
-  };
+	const threshold = options?.threshold ?? 1024;
+	const candidates = options?.encoding ? [options.encoding] : ENCODING_TYPES;
+	const contentTypeFilter = options?.contentTypeFilter ?? require_utils_compress.COMPRESSIBLE_CONTENT_TYPE_REGEX;
+	const shouldCompress = typeof contentTypeFilter === "function" ? (res) => {
+		const type = res.headers.get("Content-Type");
+		return type && contentTypeFilter(type);
+	} : (res) => {
+		const type = res.headers.get("Content-Type");
+		return type && contentTypeFilter.test(type);
+	};
+	return async function compress(ctx, next) {
+		await next();
+		const contentLength = ctx.res.headers.get("Content-Length");
+		if (ctx.res.status === 206 || ctx.res.headers.has("Content-Encoding") || ctx.res.headers.has("Transfer-Encoding") || ctx.req.method === "HEAD" || contentLength && Number(contentLength) < threshold || !shouldCompress(ctx.res) || !shouldTransform(ctx.res)) return;
+		const current = ctx.res.headers.get("Vary");
+		if (current !== "*" && !(current && varyAcceptEncodingRegExp.test(current))) ctx.header("Vary", current ? `${current}, Accept-Encoding` : "Accept-Encoding");
+		const accepted = ctx.req.header("Accept-Encoding");
+		const encoding = selectEncoding(accepted, candidates);
+		if (!encoding || !ctx.res.body) return;
+		const stream = new CompressionStream(encoding);
+		ctx.res = new Response(ctx.res.body.pipeThrough(stream), ctx.res);
+		ctx.res.headers.delete("Content-Length");
+		ctx.res.headers.set("Content-Encoding", encoding);
+		const etag = ctx.res.headers.get("ETag");
+		if (etag && !etag.startsWith("W/")) ctx.res.headers.set("ETag", `W/${etag}`);
+	};
 };
 const shouldTransform = (res) => {
-  const cacheControl = res.headers.get("Cache-Control");
-  return !cacheControl || !cacheControlNoTransformRegExp.test(cacheControl);
+	const cacheControl = res.headers.get("Cache-Control");
+	return !cacheControl || !cacheControlNoTransformRegExp.test(cacheControl);
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  COMPRESSIBLE_CONTENT_TYPE_REGEX,
-  compress
-});
+//#endregion
+exports.COMPRESSIBLE_CONTENT_TYPE_REGEX = require_utils_compress.COMPRESSIBLE_CONTENT_TYPE_REGEX;
+exports.compress = compress;

package/dist/cjs/middleware/context-storage/index.js

@@ -1,47 +1,55 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var context_storage_exports = {};
-__export(context_storage_exports, {
-  contextStorage: () => contextStorage,
-  getContext: () => getContext,
-  tryGetContext: () => tryGetContext
-});
-module.exports = __toCommonJS(context_storage_exports);
-var import_node_async_hooks = require("node:async_hooks");
-const asyncLocalStorage = new import_node_async_hooks.AsyncLocalStorage();
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/middleware/context-storage/index.ts
+/**
+* @module
+* Context Storage Middleware for Hono.
+*/
+const asyncLocalStorage = new (require("node:async_hooks")).AsyncLocalStorage();
+/**
+* Context Storage Middleware for Hono.
+*
+* @see {@link https://hono.dev/docs/middleware/builtin/context-storage}
+*
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* type Env = {
+*   Variables: {
+*     message: string
+*   }
+* }
+*
+* const app = new Hono<Env>()
+*
+* app.use(contextStorage())
+*
+* app.use(async (c, next) => {
+*   c.set('message', 'Hono is hot!!')
+*   await next()
+* })
+*
+* app.get('/', async (c) => c.text(getMessage()))
+*
+* const getMessage = () => {
+*   return getContext<Env>().var.message
+* }
+* ```
+*/
 const contextStorage = () => {
-  return async function contextStorage2(c, next) {
-    await asyncLocalStorage.run(c, next);
-  };
+	return async function contextStorage(c, next) {
+		await asyncLocalStorage.run(c, next);
+	};
 };
 const tryGetContext = () => {
-  return asyncLocalStorage.getStore();
+	return asyncLocalStorage.getStore();
 };
 const getContext = () => {
-  const context = tryGetContext();
-  if (!context) {
-    throw new Error("Context is not available");
-  }
-  return context;
+	const context = tryGetContext();
+	if (!context) throw new Error("Context is not available");
+	return context;
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  contextStorage,
-  getContext,
-  tryGetContext
-});
+//#endregion
+exports.contextStorage = contextStorage;
+exports.getContext = getContext;
+exports.tryGetContext = tryGetContext;

package/dist/cjs/middleware/cors/index.js

@@ -1,109 +1,109 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var cors_exports = {};
-__export(cors_exports, {
-  cors: () => cors
-});
-module.exports = __toCommonJS(cors_exports);
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/middleware/cors/index.ts
+/**
+* CORS Middleware for Hono.
+*
+* @see {@link https://hono.dev/docs/middleware/builtin/cors}
+*
+* @param {CORSOptions} [options] - The options for the CORS middleware.
+* @param {string | string[] | ((origin: string, c: Context) => Promise<string | undefined | null> | string | undefined | null)} [options.origin='*'] - The value of "Access-Control-Allow-Origin" CORS header.
+* @param {string[] | ((origin: string, c: Context) => Promise<string[]> | string[])} [options.allowMethods=['GET', 'HEAD', 'PUT', 'POST', 'DELETE', 'PATCH', 'QUERY']] - The value of "Access-Control-Allow-Methods" CORS header.
+* @param {string[]} [options.allowHeaders=[]] - The value of "Access-Control-Allow-Headers" CORS header.
+* @param {number} [options.maxAge] - The value of "Access-Control-Max-Age" CORS header.
+* @param {boolean} [options.credentials] - The value of "Access-Control-Allow-Credentials" CORS header.
+* @param {string[]} [options.exposeHeaders=[]] - The value of "Access-Control-Expose-Headers" CORS header.
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* const app = new Hono()
+*
+* app.use('/api/*', cors())
+* app.use(
+*   '/api2/*',
+*   cors({
+*     origin: 'http://example.com',
+*     allowHeaders: ['X-Custom-Header', 'Upgrade-Insecure-Requests'],
+*     allowMethods: ['POST', 'GET', 'OPTIONS'],
+*     exposeHeaders: ['Content-Length', 'X-Kuma-Revision'],
+*     maxAge: 600,
+*     credentials: true,
+*   })
+* )
+*
+* app.all('/api/abc', (c) => {
+*   return c.json({ success: true })
+* })
+* app.all('/api2/abc', (c) => {
+*   return c.json({ success: true })
+* })
+* ```
+*/
 const cors = (options) => {
-  const opts = {
-    origin: "*",
-    allowMethods: ["GET", "HEAD", "PUT", "POST", "DELETE", "PATCH", "QUERY"],
-    allowHeaders: [],
-    exposeHeaders: [],
-    ...options
-  };
-  const exposeHeadersStr = opts.exposeHeaders?.length ? opts.exposeHeaders.join(",") : void 0;
-  const allowHeadersStr = opts.allowHeaders?.length ? opts.allowHeaders.join(",") : void 0;
-  const findAllowOrigin = ((optsOrigin) => {
-    if (typeof optsOrigin === "string") {
-      if (optsOrigin === "*") {
-        return () => optsOrigin;
-      } else {
-        return (origin) => optsOrigin === origin ? origin : null;
-      }
-    } else if (typeof optsOrigin === "function") {
-      return optsOrigin;
-    } else {
-      return (origin) => optsOrigin.includes(origin) ? origin : null;
-    }
-  })(opts.origin);
-  const findAllowMethods = ((optsAllowMethods) => {
-    if (typeof optsAllowMethods === "function") {
-      return async (origin, c) => (await optsAllowMethods(origin, c)).join(",");
-    } else if (Array.isArray(optsAllowMethods)) {
-      const methodsStr = optsAllowMethods.join(",");
-      return () => methodsStr;
-    } else {
-      return () => "";
-    }
-  })(opts.allowMethods);
-  return async function cors2(c, next) {
-    function set(key, value) {
-      c.res.headers.set(key, value);
-    }
-    const allowOrigin = await findAllowOrigin(c.req.header("origin") || "", c);
-    if (allowOrigin) {
-      set("Access-Control-Allow-Origin", allowOrigin);
-    }
-    if (opts.credentials) {
-      set("Access-Control-Allow-Credentials", "true");
-    }
-    if (exposeHeadersStr) {
-      set("Access-Control-Expose-Headers", exposeHeadersStr);
-    }
-    if (c.req.method === "OPTIONS") {
-      if (opts.origin !== "*") {
-        c.res.headers.append("Vary", "Origin");
-      }
-      if (opts.maxAge != null) {
-        set("Access-Control-Max-Age", opts.maxAge.toString());
-      }
-      const allowMethods = await findAllowMethods(c.req.header("origin") || "", c);
-      if (allowMethods) {
-        set("Access-Control-Allow-Methods", allowMethods);
-      }
-      let headersStr = allowHeadersStr;
-      if (!headersStr) {
-        const requestHeaders = c.req.header("Access-Control-Request-Headers");
-        if (requestHeaders) {
-          headersStr = requestHeaders.split(",").map((h) => h.trim()).join(",");
-        }
-      }
-      if (headersStr) {
-        set("Access-Control-Allow-Headers", headersStr);
-        c.res.headers.append("Vary", "Access-Control-Request-Headers");
-      }
-      c.res.headers.delete("Content-Length");
-      c.res.headers.delete("Content-Type");
-      return new Response(null, {
-        headers: c.res.headers,
-        status: 204,
-        statusText: "No Content"
-      });
-    }
-    await next();
-    if (opts.origin !== "*") {
-      c.header("Vary", "Origin", { append: true });
-    }
-  };
+	const opts = {
+		origin: "*",
+		allowMethods: [
+			"GET",
+			"HEAD",
+			"PUT",
+			"POST",
+			"DELETE",
+			"PATCH",
+			"QUERY"
+		],
+		allowHeaders: [],
+		exposeHeaders: [],
+		...options
+	};
+	const exposeHeadersStr = opts.exposeHeaders?.length ? opts.exposeHeaders.join(",") : void 0;
+	const allowHeadersStr = opts.allowHeaders?.length ? opts.allowHeaders.join(",") : void 0;
+	const findAllowOrigin = ((optsOrigin) => {
+		if (typeof optsOrigin === "string") {
+			if (optsOrigin === "*") return () => optsOrigin;
+			else return (origin) => optsOrigin === origin ? origin : null;
+		} else if (typeof optsOrigin === "function") return optsOrigin;
+		else return (origin) => optsOrigin.includes(origin) ? origin : null;
+	})(opts.origin);
+	const findAllowMethods = ((optsAllowMethods) => {
+		if (typeof optsAllowMethods === "function") return async (origin, c) => (await optsAllowMethods(origin, c)).join(",");
+		else if (Array.isArray(optsAllowMethods)) {
+			const methodsStr = optsAllowMethods.join(",");
+			return () => methodsStr;
+		} else return () => "";
+	})(opts.allowMethods);
+	return async function cors(c, next) {
+		function set(key, value) {
+			c.res.headers.set(key, value);
+		}
+		const allowOrigin = await findAllowOrigin(c.req.header("origin") || "", c);
+		if (allowOrigin) set("Access-Control-Allow-Origin", allowOrigin);
+		if (opts.credentials) set("Access-Control-Allow-Credentials", "true");
+		if (exposeHeadersStr) set("Access-Control-Expose-Headers", exposeHeadersStr);
+		if (c.req.method === "OPTIONS") {
+			if (opts.origin !== "*") c.res.headers.append("Vary", "Origin");
+			if (opts.maxAge != null) set("Access-Control-Max-Age", opts.maxAge.toString());
+			const allowMethods = await findAllowMethods(c.req.header("origin") || "", c);
+			if (allowMethods) set("Access-Control-Allow-Methods", allowMethods);
+			let headersStr = allowHeadersStr;
+			if (!headersStr) {
+				const requestHeaders = c.req.header("Access-Control-Request-Headers");
+				if (requestHeaders) headersStr = requestHeaders.split(",").map((h) => h.trim()).join(",");
+			}
+			if (headersStr) {
+				set("Access-Control-Allow-Headers", headersStr);
+				c.res.headers.append("Vary", "Access-Control-Request-Headers");
+			}
+			c.res.headers.delete("Content-Length");
+			c.res.headers.delete("Content-Type");
+			return new Response(null, {
+				headers: c.res.headers,
+				status: 204,
+				statusText: "No Content"
+			});
+		}
+		await next();
+		if (opts.origin !== "*") c.header("Vary", "Origin", { append: true });
+	};
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  cors
-});
+//#endregion
+exports.cors = cors;