h3 1.9.0 → 1.10.0

package/README.md

@@ -9,7 +9,9 @@
 
 H3 (pronounced as /eɪtʃθriː/, like h-3) is a minimal h(ttp) framework built for high performance and portability.
 
-👉 [Online Playground](https://stackblitz.com/github/unjs/h3/tree/main/playground?startScript=dev)
+👉 [Online Playground](https://stackblitz.com/github/unjs/h3/tree/main/playground)
+
+👉 [Online Examples Playground](https://stackblitz.com/github/unjs/h3/tree/main/examples)
 
 ## Features
 
@@ -135,7 +137,7 @@ app.use(router);
 
 Routes are internally stored in a [Radix Tree](https://en.wikipedia.org/wiki/Radix_tree) and matched using [unjs/radix3](https://github.com/unjs/radix3).
 
-For using nested routers, see [this example](https://stackblitz.com/edit/github-2bmusk?file=app.ts&startScript=dev)
+For using nested routers, see [this example](./examples/nested-router.ts)
 
 ## More app usage examples
 
@@ -314,6 +316,14 @@ PRs are welcome to add your packages.
 - [h3-valibot](https://github.com/intevel/h3-valibot)
   - `useValidateBody(event, schema)`
   - `useValidateParams(event, schema)`
+- [h3-compression](https://github.com/CodeDredd/h3-compression)
+  - `useGZipCompression(event, response)`
+  - `useDeflateCompression(event, response)`
+  - `useBrotliCompression(event, response)`
+  - `useCompression(event, response)`
+  - `useGZipCompressionStream(event, response)`
+  - `useDeflateCompressionStream(event, response)`
+  - `useCompressionStream(event, response)`
 - [@intlify/h3](https://github.com/intlify/h3)
   - `defineI18nMiddleware(options)`
   - `useTranslation(event)`

package/dist/index.cjs

@@ -250,8 +250,9 @@ async function validateData(data, fn) {
 function createValidationError(validateError) {
   throw createError({
     status: 400,
-    message: validateError.message || "Validation Failed",
-    ...validateError
+    statusMessage: "Validation Error",
+    message: validateError?.message || "Validation Error",
+    data: validateError
   });
 }
 
@@ -377,7 +378,7 @@ const ParsedBodySymbol = Symbol.for("h3ParsedBody");
 const PayloadMethods$1 = ["PATCH", "POST", "PUT", "DELETE"];
 function readRawBody(event, encoding = "utf8") {
   assertMethod(event, PayloadMethods$1);
-  const _rawBody = event._requestBody || event.web?.request?.body || event.node.req[RawBodySymbol] || event.node.req.body;
+  const _rawBody = event._requestBody || event.web?.request?.body || event.node.req[RawBodySymbol] || event.node.req.rawBody || event.node.req.body;
   if (_rawBody) {
     const promise2 = Promise.resolve(_rawBody).then((_resolved) => {
       if (Buffer.isBuffer(_resolved)) {

package/dist/index.d.cts

@@ -213,7 +213,7 @@ type HTTPHeaderName = _HTTPHeaderName | Lowercase<_HTTPHeaderName> | (string & {
  *                         This can be used to pass additional information about the error.
  * @property {boolean} internal - Setting this property to `true` will mark the error as an internal error.
  */
-declare class H3Error<DataT = any> extends Error {
+declare class H3Error<DataT = unknown> extends Error {
     static __h3_error__: boolean;
     statusCode: number;
     fatal: boolean;
@@ -232,10 +232,10 @@ declare class H3Error<DataT = any> extends Error {
  * @param input {string | (Partial<H3Error> & { status?: number; statusText?: string })} - The error message or an object containing error properties.
  * @return {H3Error} - An instance of H3Error.
  */
-declare function createError<DataT = any>(input: string | (Partial<H3Error<DataT>> & {
+declare function createError<DataT = unknown>(input: string | (Partial<H3Error<DataT>> & {
     status?: number;
     statusText?: string;
-})): H3Error;
+})): H3Error<DataT>;
 /**
  * Receives an error and returns the corresponding response.
  * H3 internally uses this function to handle unhandled errors.
@@ -253,7 +253,7 @@ declare function sendError(event: H3Event, error: Error | H3Error, debug?: boole
  * @param input {*} - The input to check.
  * @return {boolean} - Returns true if the input is an instance of H3Error, false otherwise.
  */
-declare function isError(input: any): input is H3Error;
+declare function isError<DataT = unknown>(input: any): input is H3Error<DataT>;
 
 interface Layer {
     route: string;
@@ -582,7 +582,7 @@ declare function defaultContentType(event: H3Event, type?: string): void;
 declare function sendRedirect(event: H3Event, location: string, code?: number): Promise<void>;
 declare function getResponseHeaders(event: H3Event): ReturnType<H3Event["res"]["getHeaders"]>;
 declare function getResponseHeader(event: H3Event, name: HTTPHeaderName): ReturnType<H3Event["res"]["getHeader"]>;
-declare function setResponseHeaders(event: H3Event, headers: Record<string, Parameters<OutgoingMessage["setHeader"]>[1]>): void;
+declare function setResponseHeaders(event: H3Event, headers: Record<HTTPHeaderName, Parameters<OutgoingMessage["setHeader"]>[1]>): void;
 declare const setHeaders: typeof setResponseHeaders;
 declare function setResponseHeader(event: H3Event, name: HTTPHeaderName, value: Parameters<OutgoingMessage["setHeader"]>[1]): void;
 declare const setHeader: typeof setResponseHeader;

package/dist/index.d.mts

@@ -213,7 +213,7 @@ type HTTPHeaderName = _HTTPHeaderName | Lowercase<_HTTPHeaderName> | (string & {
  *                         This can be used to pass additional information about the error.
  * @property {boolean} internal - Setting this property to `true` will mark the error as an internal error.
  */
-declare class H3Error<DataT = any> extends Error {
+declare class H3Error<DataT = unknown> extends Error {
     static __h3_error__: boolean;
     statusCode: number;
     fatal: boolean;
@@ -232,10 +232,10 @@ declare class H3Error<DataT = any> extends Error {
  * @param input {string | (Partial<H3Error> & { status?: number; statusText?: string })} - The error message or an object containing error properties.
  * @return {H3Error} - An instance of H3Error.
  */
-declare function createError<DataT = any>(input: string | (Partial<H3Error<DataT>> & {
+declare function createError<DataT = unknown>(input: string | (Partial<H3Error<DataT>> & {
     status?: number;
     statusText?: string;
-})): H3Error;
+})): H3Error<DataT>;
 /**
  * Receives an error and returns the corresponding response.
  * H3 internally uses this function to handle unhandled errors.
@@ -253,7 +253,7 @@ declare function sendError(event: H3Event, error: Error | H3Error, debug?: boole
  * @param input {*} - The input to check.
  * @return {boolean} - Returns true if the input is an instance of H3Error, false otherwise.
  */
-declare function isError(input: any): input is H3Error;
+declare function isError<DataT = unknown>(input: any): input is H3Error<DataT>;
 
 interface Layer {
     route: string;
@@ -582,7 +582,7 @@ declare function defaultContentType(event: H3Event, type?: string): void;
 declare function sendRedirect(event: H3Event, location: string, code?: number): Promise<void>;
 declare function getResponseHeaders(event: H3Event): ReturnType<H3Event["res"]["getHeaders"]>;
 declare function getResponseHeader(event: H3Event, name: HTTPHeaderName): ReturnType<H3Event["res"]["getHeader"]>;
-declare function setResponseHeaders(event: H3Event, headers: Record<string, Parameters<OutgoingMessage["setHeader"]>[1]>): void;
+declare function setResponseHeaders(event: H3Event, headers: Record<HTTPHeaderName, Parameters<OutgoingMessage["setHeader"]>[1]>): void;
 declare const setHeaders: typeof setResponseHeaders;
 declare function setResponseHeader(event: H3Event, name: HTTPHeaderName, value: Parameters<OutgoingMessage["setHeader"]>[1]): void;
 declare const setHeader: typeof setResponseHeader;

package/dist/index.d.ts

@@ -213,7 +213,7 @@ type HTTPHeaderName = _HTTPHeaderName | Lowercase<_HTTPHeaderName> | (string & {
  *                         This can be used to pass additional information about the error.
  * @property {boolean} internal - Setting this property to `true` will mark the error as an internal error.
  */
-declare class H3Error<DataT = any> extends Error {
+declare class H3Error<DataT = unknown> extends Error {
     static __h3_error__: boolean;
     statusCode: number;
     fatal: boolean;
@@ -232,10 +232,10 @@ declare class H3Error<DataT = any> extends Error {
  * @param input {string | (Partial<H3Error> & { status?: number; statusText?: string })} - The error message or an object containing error properties.
  * @return {H3Error} - An instance of H3Error.
  */
-declare function createError<DataT = any>(input: string | (Partial<H3Error<DataT>> & {
+declare function createError<DataT = unknown>(input: string | (Partial<H3Error<DataT>> & {
     status?: number;
     statusText?: string;
-})): H3Error;
+})): H3Error<DataT>;
 /**
  * Receives an error and returns the corresponding response.
  * H3 internally uses this function to handle unhandled errors.
@@ -253,7 +253,7 @@ declare function sendError(event: H3Event, error: Error | H3Error, debug?: boole
  * @param input {*} - The input to check.
  * @return {boolean} - Returns true if the input is an instance of H3Error, false otherwise.
  */
-declare function isError(input: any): input is H3Error;
+declare function isError<DataT = unknown>(input: any): input is H3Error<DataT>;
 
 interface Layer {
     route: string;
@@ -582,7 +582,7 @@ declare function defaultContentType(event: H3Event, type?: string): void;
 declare function sendRedirect(event: H3Event, location: string, code?: number): Promise<void>;
 declare function getResponseHeaders(event: H3Event): ReturnType<H3Event["res"]["getHeaders"]>;
 declare function getResponseHeader(event: H3Event, name: HTTPHeaderName): ReturnType<H3Event["res"]["getHeader"]>;
-declare function setResponseHeaders(event: H3Event, headers: Record<string, Parameters<OutgoingMessage["setHeader"]>[1]>): void;
+declare function setResponseHeaders(event: H3Event, headers: Record<HTTPHeaderName, Parameters<OutgoingMessage["setHeader"]>[1]>): void;
 declare const setHeaders: typeof setResponseHeaders;
 declare function setResponseHeader(event: H3Event, name: HTTPHeaderName, value: Parameters<OutgoingMessage["setHeader"]>[1]): void;
 declare const setHeader: typeof setResponseHeader;

package/dist/index.mjs

@@ -243,8 +243,9 @@ async function validateData(data, fn) {
 function createValidationError(validateError) {
   throw createError({
     status: 400,
-    message: validateError.message || "Validation Failed",
-    ...validateError
+    statusMessage: "Validation Error",
+    message: validateError?.message || "Validation Error",
+    data: validateError
   });
 }
 
@@ -370,7 +371,7 @@ const ParsedBodySymbol = Symbol.for("h3ParsedBody");
 const PayloadMethods$1 = ["PATCH", "POST", "PUT", "DELETE"];
 function readRawBody(event, encoding = "utf8") {
   assertMethod(event, PayloadMethods$1);
-  const _rawBody = event._requestBody || event.web?.request?.body || event.node.req[RawBodySymbol] || event.node.req.body;
+  const _rawBody = event._requestBody || event.web?.request?.body || event.node.req[RawBodySymbol] || event.node.req.rawBody || event.node.req.body;
   if (_rawBody) {
     const promise2 = Promise.resolve(_rawBody).then((_resolved) => {
       if (Buffer.isBuffer(_resolved)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "h3",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Minimal H(TTP) framework built for high performance and portability.",
   "repository": "unjs/h3",
   "license": "MIT",
@@ -27,18 +27,18 @@
     "radix3": "^1.1.0",
     "ufo": "^1.3.2",
     "uncrypto": "^0.1.3",
-    "unenv": "^1.7.4"
+    "unenv": "^1.8.0"
   },
   "devDependencies": {
     "0x": "^5.7.0",
     "@types/express": "^4.17.21",
-    "@types/node": "^20.9.2",
-    "@types/supertest": "^2.0.16",
-    "@vitest/coverage-v8": "^0.34.6",
-    "autocannon": "^7.12.0",
+    "@types/node": "^20.10.4",
+    "@types/supertest": "^6.0.2",
+    "@vitest/coverage-v8": "^1.0.2",
+    "autocannon": "^7.14.0",
     "changelogen": "^0.5.5",
     "connect": "^3.7.0",
-    "eslint": "^8.54.0",
+    "eslint": "^8.55.0",
     "eslint-config-unjs": "^0.2.1",
     "express": "^4.18.2",
     "get-port": "^7.0.0",
@@ -49,22 +49,21 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "supertest": "^6.3.3",
-    "typescript": "^5.2.2",
+    "typescript": "^5.3.3",
     "unbuild": "^2.0.0",
-    "vitest": "^0.34.6",
+    "vitest": "^1.0.2",
     "zod": "^3.22.4"
   },
-  "packageManager": "pnpm@8.10.5",
+  "packageManager": "pnpm@8.11.0",
   "scripts": {
     "build": "unbuild",
     "dev": "vitest",
-    "lint": "eslint --cache --ext .ts,.js,.mjs,.cjs . && prettier -c src test playground",
-    "lint:fix": "eslint --cache --ext .ts,.js,.mjs,.cjs . --fix && prettier -c src test playground -w",
+    "lint": "eslint --cache --ext .ts,.js,.mjs,.cjs . && prettier -c src test playground examples",
+    "lint:fix": "eslint --cache --ext .ts,.js,.mjs,.cjs . --fix && prettier -c src test playground examples -w",
     "play": "listhen -w ./playground/app.ts",
     "profile": "0x -o -D .profile -P 'autocannon -c 100 -p 10 -d 40 http://localhost:$PORT' ./playground/server.cjs",
     "release": "pnpm test && pnpm build && changelogen --release && pnpm publish && git push --follow-tags",
     "release-rc": "pnpm test && pnpm build && changelogen --release --prerelease rc --push --publish --publishTag rc",
-    "test": "pnpm lint && vitest --run typecheck && vitest --run --coverage",
-    "test:types": "vitest typecheck"
+    "test": "pnpm lint && vitest --run --coverage"
   }
 }