h3 1.5.0 → 1.6.0

package/README.md

@@ -1,13 +1,13 @@
-[![npm downloads](https://img.shields.io/npm/dm/h3.svg?style=flat-square)](https://npmjs.com/package/h3)
-[![version](https://img.shields.io/npm/v/h3/latest.svg?style=flat-square)](https://npmjs.com/package/h3)
-[![bundlephobia](https://img.shields.io/bundlephobia/min/h3/latest.svg?style=flat-square)](https://bundlephobia.com/result?p=h3)
-[![build status](https://img.shields.io/github/actions/workflow/status/unjs/h3/ci.yml?branch=main&style=flat-square)](https://github.com/unjs/h3/actions)
-[![coverage](https://img.shields.io/codecov/c/gh/unjs/h3/main?style=flat-square)](https://codecov.io/gh/unjs/h3)
-[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue?style=flat-square)](https://www.jsdocs.io/package/h3)
+# H3
 
-> H3 is a minimal h(ttp) framework built for high performance and portability
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![Codecov][codecov-src]][codecov-href]
+[![License][license-src]][license-href]
+[![JSDocs][jsdocs-src]][jsdocs-href]
 
-<!-- ![h3 - Tiny JavaScript Server](.github/banner.svg) -->
+H3 is a minimal h(ttp) framework built for high performance and portability.
 
 ## Features
 
@@ -179,6 +179,9 @@ H3 has a concept of composable utilities that accept `event` (from `eventHandler
 - `isCorsOriginAllowed(event)`
 - `appendCorsHeaders(event, options)` (see [h3-cors](https://github.com/NozomuIkuta/h3-cors) for more detail about options)
 - `appendCorsPreflightHeaders(event, options)` (see [h3-cors](https://github.com/NozomuIkuta/h3-cors) for more detail about options)
+- `getRequestHost(event)`
+- `getRequestProtocol(event)`
+- `getRequestURL(event)`
 
 👉 You can learn more about usage in [JSDocs Documentation](https://www.jsdocs.io/package/h3#package-functions).
 
@@ -200,3 +203,18 @@ PRs are welcome to add your packages.
 ## License
 
 MIT
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/h3?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-version-href]: https://npmjs.com/package/h3
+[npm-downloads-src]: https://img.shields.io/npm/dm/h3?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-downloads-href]: https://npmjs.com/package/h3
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/h3/main?style=flat&colorA=18181B&colorB=F0DB4F
+[codecov-href]: https://codecov.io/gh/unjs/h3
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/h3?style=flat&colorA=18181B&colorB=F0DB4F
+[bundle-href]: https://bundlephobia.com/result?p=h3
+[license-src]: https://img.shields.io/github/license/unjs/h3.svg?style=flat&colorA=18181B&colorB=F0DB4F
+[license-href]: https://github.com/unjs/h3/blob/main/LICENSE
+[jsdocs-src]: https://img.shields.io/badge/jsDocs.io-reference-18181B?style=flat&colorA=18181B&colorB=F0DB4F
+[jsdocs-href]: https://www.jsdocs.io/package/h3

package/dist/index.cjs

@@ -248,6 +248,24 @@ function getRequestHeader(event, name) {
   return value;
 }
 const getHeader = getRequestHeader;
+function getRequestHost(event) {
+  const xForwardedHost = event.node.req.headers["x-forwarded-host"];
+  if (xForwardedHost) {
+    return xForwardedHost;
+  }
+  return event.node.req.headers.host || "localhost";
+}
+function getRequestProtocol(event) {
+  if (event.node.req.headers["x-forwarded-proto"] === "https") {
+    return "https";
+  }
+  return event.node.req.connection.encrypted ? "https" : "http";
+}
+function getRequestURL(event) {
+  const host = getRequestHost(event);
+  const protocol = getRequestProtocol(event);
+  return new URL(event.path || "/", `${protocol}://${host}`);
+}
 
 const RawBodySymbol = Symbol.for("h3RawBody");
 const ParsedBodySymbol = Symbol.for("h3ParsedBody");
@@ -380,7 +398,6 @@ function deleteCookie(event, name, serializeOptions) {
     maxAge: 0
   });
 }
-
 function splitCookiesString(cookiesString) {
   if (typeof cookiesString !== "string") {
     return [];
@@ -528,8 +545,7 @@ function getProxyRequestHeaders(event) {
 function fetchWithEvent(event, req, init, options) {
   return _getFetch(options?.fetch)(req, {
     ...init,
-    // @ts-ignore (context is used for unenv and local fetch)
-    context: init.context || event.context,
+    context: init?.context || event.context,
     headers: {
       ...getProxyRequestHeaders(event),
       ...init?.headers
@@ -1422,6 +1438,9 @@ exports.getProxyRequestHeaders = getProxyRequestHeaders;
 exports.getQuery = getQuery;
 exports.getRequestHeader = getRequestHeader;
 exports.getRequestHeaders = getRequestHeaders;
+exports.getRequestHost = getRequestHost;
+exports.getRequestProtocol = getRequestProtocol;
+exports.getRequestURL = getRequestURL;
 exports.getResponseHeader = getResponseHeader;
 exports.getResponseHeaders = getResponseHeaders;
 exports.getResponseStatus = getResponseStatus;
@@ -1458,6 +1477,7 @@ exports.setHeaders = setHeaders;
 exports.setResponseHeader = setResponseHeader;
 exports.setResponseHeaders = setResponseHeaders;
 exports.setResponseStatus = setResponseStatus;
+exports.splitCookiesString = splitCookiesString;
 exports.toEventHandler = toEventHandler;
 exports.toNodeListener = toNodeListener;
 exports.unsealSession = unsealSession;

package/dist/index.d.ts

@@ -27,7 +27,7 @@ interface SessionConfig {
 }
 declare function useSession<T extends SessionDataT = SessionDataT>(event: H3Event, config: SessionConfig): Promise<{
     readonly id: string | undefined;
-    readonly data: SessionDataT;
+    readonly data: T;
     update: (update: SessionUpdate<T>) => Promise<any>;
     clear: () => Promise<any>;
 }>;
@@ -36,7 +36,7 @@ type SessionUpdate<T extends SessionDataT = SessionDataT> = Partial<SessionData<
 declare function updateSession<T extends SessionDataT = SessionDataT>(event: H3Event, config: SessionConfig, update?: SessionUpdate<T>): Promise<Session<T>>;
 declare function sealSession<T extends SessionDataT = SessionDataT>(event: H3Event, config: SessionConfig): Promise<string>;
 declare function unsealSession(_event: H3Event, config: SessionConfig, sealed: string): Promise<Partial<Session<SessionDataT>>>;
-declare function clearSession(event: H3Event, config: SessionConfig): Promise<void>;
+declare function clearSession(event: H3Event, config: Partial<SessionConfig>): Promise<void>;
 
 type HTTPMethod = "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE";
 type Encoding = false | "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex";
@@ -231,7 +231,7 @@ declare function readRawBody<E extends Encoding = "utf8">(event: H3Event, encodi
  * @return {*} The `Object`, `Array`, `String`, `Number`, `Boolean`, or `null` value corresponding to the request JSON body
  *
  * ```ts
- * const body = await useBody(req)
+ * const body = await readBody(req)
  * ```
  */
 declare function readBody<T = any>(event: H3Event): Promise<T>;
@@ -270,7 +270,7 @@ declare function parseCookies(event: H3Event): Record<string, string>;
  * @param name Name of the cookie to get
  * @returns {*} Value of the cookie (String or undefined)
  * ```ts
- * const authorization = useCookie(request, 'Authorization')
+ * const authorization = getCookie(request, 'Authorization')
  * ```
  */
 declare function getCookie(event: H3Event, name: string): string | undefined;
@@ -295,6 +295,16 @@ declare function setCookie(event: H3Event, name: string, value: string, serializ
  * ```
  */
 declare function deleteCookie(event: H3Event, name: string, serializeOptions?: CookieSerializeOptions): void;
+/**
+ * Set-Cookie header field-values are sometimes comma joined in one string. This splits them without choking on commas
+ * that are within a single set-cookie field-value, such as in the Expires portion.
+ * This is uncommon, but explicitly allowed - see https://tools.ietf.org/html/rfc2616#section-4.2
+ * Node.js does this for every header *except* set-cookie - see https://github.com/nodejs/node/blob/d5e363b77ebaf1caf67cd7528224b651c86815c1/lib/_http_incoming.js#L128
+ * Based on: https://github.com/google/j2objc/commit/16820fdbc8f76ca0c33472810ce0cb03d20efe25
+ * Credits to: https://github.com/tomball for original and https://github.com/chrusart for JavaScript implementation
+ * @source https://github.com/nfriedly/set-cookie-parser/blob/3eab8b7d5d12c8ed87832532861c1a35520cf5b3/lib/set-cookie.js#L144
+ */
+declare function splitCookiesString(cookiesString: string): string[];
 
 interface ProxyOptions {
     headers?: RequestHeaders | HeadersInit;
@@ -307,7 +317,9 @@ interface ProxyOptions {
 declare function proxyRequest(event: H3Event, target: string, opts?: ProxyOptions): Promise<any>;
 declare function sendProxy(event: H3Event, target: string, opts?: ProxyOptions): Promise<any>;
 declare function getProxyRequestHeaders(event: H3Event): any;
-declare function fetchWithEvent(event: H3Event, req: RequestInfo | URL, init?: RequestInit, options?: {
+declare function fetchWithEvent(event: H3Event, req: RequestInfo | URL, init?: RequestInit & {
+    context?: H3EventContext;
+}, options?: {
     fetch: typeof fetch;
 }): Promise<Response>;
 
@@ -321,6 +333,9 @@ declare function getRequestHeaders(event: H3Event): RequestHeaders;
 declare const getHeaders: typeof getRequestHeaders;
 declare function getRequestHeader(event: H3Event, name: string): RequestHeaders[string];
 declare const getHeader: typeof getRequestHeader;
+declare function getRequestHost(event: H3Event): string;
+declare function getRequestProtocol(event: H3Event): "https" | "http";
+declare function getRequestURL(event: H3Event): URL;
 
 declare function send(event: H3Event, data?: any, type?: string): Promise<void>;
 /**
@@ -384,4 +399,4 @@ interface CreateRouterOptions {
 }
 declare function createRouter(opts?: CreateRouterOptions): Router;
 
-export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CreateRouterOptions, DynamicEventHandler, Encoding, EventHandler, EventHandlerResponse, H3CorsOptions, H3Error, H3Event, H3EventContext, H3Headers, H3Response, HTTPMethod, InputLayer, InputStack, Layer, LazyEventHandler, MIMES, Matcher, MultiPartData, NodeEventContext, NodeListener, NodeMiddleware, NodePromisifiedHandler, ProxyOptions, RequestHeaders, Router, RouterMethod, RouterUse, Session, SessionConfig, SessionData, Stack, appendCorsHeaders, appendCorsPreflightHeaders, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, clearSession, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fetchWithEvent, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getProxyRequestHeaders, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getResponseStatus, getResponseStatusText, getRouterParam, getRouterParams, getSession, handleCacheHeaders, handleCors, isCorsOriginAllowed, isError, isEvent, isEventHandler, isMethod, isPreflightRequest, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, proxyRequest, readBody, readMultipartFormData, readRawBody, sealSession, send, sendError, sendNoContent, sendProxy, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, setResponseStatus, toEventHandler, toNodeListener, unsealSession, updateSession, use, useBase, useSession, writeEarlyHints };
+export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CreateRouterOptions, DynamicEventHandler, Encoding, EventHandler, EventHandlerResponse, H3CorsOptions, H3Error, H3Event, H3EventContext, H3Headers, H3Response, HTTPMethod, InputLayer, InputStack, Layer, LazyEventHandler, MIMES, Matcher, MultiPartData, NodeEventContext, NodeListener, NodeMiddleware, NodePromisifiedHandler, ProxyOptions, RequestHeaders, Router, RouterMethod, RouterUse, Session, SessionConfig, SessionData, Stack, appendCorsHeaders, appendCorsPreflightHeaders, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, clearSession, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fetchWithEvent, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getProxyRequestHeaders, getQuery, getRequestHeader, getRequestHeaders, getRequestHost, getRequestProtocol, getRequestURL, getResponseHeader, getResponseHeaders, getResponseStatus, getResponseStatusText, getRouterParam, getRouterParams, getSession, handleCacheHeaders, handleCors, isCorsOriginAllowed, isError, isEvent, isEventHandler, isMethod, isPreflightRequest, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, proxyRequest, readBody, readMultipartFormData, readRawBody, sealSession, send, sendError, sendNoContent, sendProxy, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, setResponseStatus, splitCookiesString, toEventHandler, toNodeListener, unsealSession, updateSession, use, useBase, useSession, writeEarlyHints };

package/dist/index.mjs

@@ -246,6 +246,24 @@ function getRequestHeader(event, name) {
   return value;
 }
 const getHeader = getRequestHeader;
+function getRequestHost(event) {
+  const xForwardedHost = event.node.req.headers["x-forwarded-host"];
+  if (xForwardedHost) {
+    return xForwardedHost;
+  }
+  return event.node.req.headers.host || "localhost";
+}
+function getRequestProtocol(event) {
+  if (event.node.req.headers["x-forwarded-proto"] === "https") {
+    return "https";
+  }
+  return event.node.req.connection.encrypted ? "https" : "http";
+}
+function getRequestURL(event) {
+  const host = getRequestHost(event);
+  const protocol = getRequestProtocol(event);
+  return new URL(event.path || "/", `${protocol}://${host}`);
+}
 
 const RawBodySymbol = Symbol.for("h3RawBody");
 const ParsedBodySymbol = Symbol.for("h3ParsedBody");
@@ -378,7 +396,6 @@ function deleteCookie(event, name, serializeOptions) {
     maxAge: 0
   });
 }
-
 function splitCookiesString(cookiesString) {
   if (typeof cookiesString !== "string") {
     return [];
@@ -526,8 +543,7 @@ function getProxyRequestHeaders(event) {
 function fetchWithEvent(event, req, init, options) {
   return _getFetch(options?.fetch)(req, {
     ...init,
-    // @ts-ignore (context is used for unenv and local fetch)
-    context: init.context || event.context,
+    context: init?.context || event.context,
     headers: {
       ...getProxyRequestHeaders(event),
       ...init?.headers
@@ -1383,4 +1399,4 @@ function createRouter(opts = {}) {
   return router;
 }
 
-export { H3Error, H3Event, H3Headers, H3Response, MIMES, appendCorsHeaders, appendCorsPreflightHeaders, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, clearSession, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fetchWithEvent, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getProxyRequestHeaders, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getResponseStatus, getResponseStatusText, getRouterParam, getRouterParams, getSession, handleCacheHeaders, handleCors, isCorsOriginAllowed, isError, isEvent, isEventHandler, isMethod, isPreflightRequest, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, proxyRequest, readBody, readMultipartFormData, readRawBody, sealSession, send, sendError, sendNoContent, sendProxy, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, setResponseStatus, toEventHandler, toNodeListener, unsealSession, updateSession, use, useBase, useSession, writeEarlyHints };
+export { H3Error, H3Event, H3Headers, H3Response, MIMES, appendCorsHeaders, appendCorsPreflightHeaders, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, clearSession, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fetchWithEvent, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getProxyRequestHeaders, getQuery, getRequestHeader, getRequestHeaders, getRequestHost, getRequestProtocol, getRequestURL, getResponseHeader, getResponseHeaders, getResponseStatus, getResponseStatusText, getRouterParam, getRouterParams, getSession, handleCacheHeaders, handleCors, isCorsOriginAllowed, isError, isEvent, isEventHandler, isMethod, isPreflightRequest, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, proxyRequest, readBody, readMultipartFormData, readRawBody, sealSession, send, sendError, sendNoContent, sendProxy, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, setResponseStatus, splitCookiesString, toEventHandler, toNodeListener, unsealSession, updateSession, use, useBase, useSession, writeEarlyHints };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "h3",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Tiny JavaScript Server",
   "repository": "unjs/h3",
   "license": "MIT",
@@ -25,32 +25,32 @@
     "destr": "^1.2.2",
     "iron-webcrypto": "^0.5.0",
     "radix3": "^1.0.0",
-    "ufo": "^1.1.0",
+    "ufo": "^1.1.1",
     "uncrypto": "^0.1.2"
   },
   "devDependencies": {
-    "0x": "^5.4.1",
+    "0x": "^5.5.0",
     "@types/express": "^4.17.17",
-    "@types/node": "^18.13.0",
+    "@types/node": "^18.15.0",
     "@types/supertest": "^2.0.12",
-    "@vitest/coverage-c8": "^0.28.5",
+    "@vitest/coverage-c8": "^0.29.2",
     "autocannon": "^7.10.0",
-    "changelogen": "^0.4.1",
+    "changelogen": "^0.5.1",
     "connect": "^3.7.0",
-    "eslint": "^8.34.0",
+    "eslint": "^8.35.0",
     "eslint-config-unjs": "^0.1.0",
     "express": "^4.18.2",
     "get-port": "^6.1.2",
-    "jiti": "^1.17.0",
-    "listhen": "^1.0.2",
+    "jiti": "^1.17.2",
+    "listhen": "^1.0.3",
     "node-fetch-native": "^1.0.2",
     "prettier": "^2.8.4",
     "supertest": "^6.3.3",
     "typescript": "^4.9.5",
-    "unbuild": "^1.1.1",
-    "vitest": "^0.28.5"
+    "unbuild": "^1.1.2",
+    "vitest": "^0.29.2"
   },
-  "packageManager": "pnpm@7.27.0",
+  "packageManager": "pnpm@7.29.0",
   "scripts": {
     "build": "unbuild",
     "dev": "vitest",