h3 0.8.4 → 0.8.6

package/README.md

@@ -136,6 +136,7 @@ H3 has concept of compasable utilities that accept `event` (from `eventHandler((
 - `isMethod(event, expected, allowHead?)`
 - `assertMethod(event, expected, allowHead?)`
 - `createError({ statusCode, statusMessage, data? })`
+- `sendProxy(event, { target, headers?, fetchOptions?, fetch?, sendStream? })`
 
 👉 You can learn more about usage in [JSDocs Documentation](https://www.jsdocs.io/package/h3#package-functions).
 

package/dist/index.cjs

@@ -25,6 +25,19 @@ class H3Error extends Error {
     this.unhandled = false;
     this.statusMessage = void 0;
   }
+  toJSON() {
+    const obj = {
+      message: this.message,
+      statusCode: this.statusCode
+    };
+    if (this.statusMessage) {
+      obj.statusMessage = this.statusMessage;
+    }
+    if (this.data !== void 0) {
+      obj.data = this.data;
+    }
+    return obj;
+  }
 }
 H3Error.__h3_error__ = true;
 function createError(input) {
@@ -47,14 +60,18 @@ function createError(input) {
       }
     }
   }
+  if (input.data) {
+    err.data = input.data;
+  }
   if (input.statusCode) {
     err.statusCode = input.statusCode;
+  } else if (input.status) {
+    err.statusCode = input.status;
   }
   if (input.statusMessage) {
     err.statusMessage = input.statusMessage;
-  }
-  if (input.data) {
-    err.data = input.data;
+  } else if (input.statusText) {
+    err.statusMessage = input.statusText;
   }
   if (input.fatal !== void 0) {
     err.fatal = input.fatal;
@@ -133,7 +150,12 @@ function assertMethod(event, expected, allowHead) {
   }
 }
 function getRequestHeaders(event) {
-  return event.req.headers;
+  const _headers = {};
+  for (const key in event.req.headers) {
+    const val = event.req.headers[key];
+    _headers[key] = Array.isArray(val) ? val.filter(Boolean).join(", ") : val;
+  }
+  return _headers;
 }
 const getHeaders = getRequestHeaders;
 function getRequestHeader(event, name) {
@@ -290,7 +312,7 @@ function sendStream(event, data) {
 const noop = () => {
 };
 function writeEarlyHints(event, hints, cb = noop) {
-  if (!event.res.socket && !("writeEarlyHints" in event.res)) {
+  if (!event.res.socket) {
     cb();
     return;
   }
@@ -299,10 +321,6 @@ function writeEarlyHints(event, hints, cb = noop) {
   }
   if (hints.link) {
     hints.link = Array.isArray(hints.link) ? hints.link : hints.link.split(",");
-    hints.link = hints.link.map((l) => l.trim().replace(/; crossorigin/g, ""));
-  }
-  if ("writeEarlyHints" in event.res) {
-    return event.res.writeEarlyHints(hints, cb);
   }
   const headers = Object.entries(hints).map((e) => [e[0].toLowerCase(), e[1]]);
   if (!headers.length) {
@@ -348,6 +366,44 @@ function deleteCookie(event, name, serializeOptions) {
   });
 }
 
+async function sendProxy(event, target, opts = {}) {
+  const _fetch = opts.fetch || globalThis.fetch;
+  if (!_fetch) {
+    throw new Error("fetch is not available. Try importing `node-fetch-native/polyfill` for Node.js.");
+  }
+  const response = await _fetch(target, {
+    headers: opts.headers,
+    ...opts.fetchOptions
+  });
+  event.res.statusCode = response.status;
+  event.res.statusMessage = response.statusText;
+  for (const [key, value] of response.headers.entries()) {
+    if (key === "content-encoding") {
+      continue;
+    }
+    if (key === "content-length") {
+      continue;
+    }
+    event.res.setHeader(key, value);
+  }
+  try {
+    if (response.body) {
+      if (opts.sendStream === false) {
+        const data = new Uint8Array(await response.arrayBuffer());
+        event.res.end(data);
+      } else {
+        for await (const chunk of response.body) {
+          event.res.write(chunk);
+        }
+        event.res.end();
+      }
+    }
+  } catch (err) {
+    event.res.end();
+    throw err;
+  }
+}
+
 class H3Headers {
   constructor(init) {
     if (!init) {
@@ -360,6 +416,18 @@ class H3Headers {
       this._headers = Object.fromEntries(Object.entries(init).map(([key, value]) => [key.toLowerCase(), value]));
     }
   }
+  [Symbol.iterator]() {
+    return this.entries();
+  }
+  entries() {
+    throw Object.entries(this._headers)[Symbol.iterator]();
+  }
+  keys() {
+    return Object.keys(this._headers)[Symbol.iterator]();
+  }
+  values() {
+    throw Object.values(this._headers)[Symbol.iterator]();
+  }
   append(name, value) {
     const _name = name.toLowerCase();
     this.set(_name, [this.get(_name), value].filter(Boolean).join(", "));
@@ -699,7 +767,11 @@ function createRouter(opts = {}) {
     router[method] = (path, handle) => router.add(path, handle, method);
   }
   router.handler = eventHandler((event) => {
-    const path = new URL(event.req.url || "/", "http://localhost").pathname;
+    let path = event.req.url || "/";
+    const qIndex = path.indexOf("?");
+    if (qIndex !== -1) {
+      path = path.substring(0, qIndex);
+    }
     const matched = _router.lookup(path);
     if (!matched) {
       if (opts.preemtive) {
@@ -777,6 +849,7 @@ exports.readBody = readBody;
 exports.readRawBody = readRawBody;
 exports.send = send;
 exports.sendError = sendError;
+exports.sendProxy = sendProxy;
 exports.sendRedirect = sendRedirect;
 exports.sendStream = sendStream;
 exports.setCookie = setCookie;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { IncomingMessage, ServerResponse, OutgoingMessage } from 'http';
 export { IncomingMessage as NodeIncomingMessage, ServerResponse as NodeServerResponse } from 'http';
 import { CookieSerializeOptions } from 'cookie-es';
+import { RequestHeaders as RequestHeaders$1 } from 'src/types';
 import * as ufo from 'ufo';
 
 declare type HTTPMethod = 'GET' | 'HEAD' | 'PATCH' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE';
@@ -13,6 +14,9 @@ interface EventHandler<T = any> {
     (event: H3Event): EventHandlerResponse<T>;
 }
 declare type LazyEventHandler = () => EventHandler | Promise<EventHandler>;
+declare type RequestHeaders = {
+    [name: string]: string | undefined;
+};
 
 declare type NodeListener = (req: IncomingMessage, res: ServerResponse) => void;
 declare type NodePromisifiedHandler = (req: IncomingMessage, res: ServerResponse) => Promise<any>;
@@ -27,6 +31,10 @@ declare function callNodeListener(handler: NodeMiddleware, req: IncomingMessage,
 declare class H3Headers implements Headers {
     _headers: Record<string, string>;
     constructor(init?: HeadersInit);
+    [Symbol.iterator](): IterableIterator<[string, string]>;
+    entries(): IterableIterator<[string, string]>;
+    keys(): IterableIterator<string>;
+    values(): IterableIterator<string>;
     append(name: string, value: string): void;
     delete(name: string): void;
     get(name: string): string | null;
@@ -124,6 +132,7 @@ declare function createAppEventHandler(stack: Stack, options: AppOptions): Event
  */
 declare class H3Error extends Error {
     static __h3_error__: boolean;
+    toJSON(): Pick<H3Error, "statusCode" | "statusMessage" | "data" | "message">;
     statusCode: number;
     fatal: boolean;
     unhandled: boolean;
@@ -136,7 +145,10 @@ declare class H3Error extends Error {
  * @param input {Partial<H3Error>}
  * @return {H3Error} An instance of the H3Error
  */
-declare function createError(input: string | Partial<H3Error>): H3Error;
+declare function createError(input: string | Partial<H3Error> & {
+    status?: number;
+    statusText?: string;
+}): H3Error;
 /**
  * Receive an error and return the corresponding response.<br>
  *  H3 internally uses this function to handle unhandled errors.<br>
@@ -240,6 +252,14 @@ declare function setCookie(event: H3Event, name: string, value: string, serializ
  */
 declare function deleteCookie(event: H3Event, name: string, serializeOptions?: CookieSerializeOptions): void;
 
+interface SendProxyOptions {
+    headers?: RequestHeaders$1 | HeadersInit;
+    fetchOptions?: RequestInit;
+    fetch?: typeof fetch;
+    sendStream?: boolean;
+}
+declare function sendProxy(event: H3Event, target: string, opts?: SendProxyOptions): Promise<void>;
+
 declare function getQuery(event: H3Event): ufo.QueryObject;
 /** @deprecated Use `h3.getQuery` */
 declare const useQuery: typeof getQuery;
@@ -250,9 +270,9 @@ declare function getMethod(event: H3Event, defaultMethod?: HTTPMethod): HTTPMeth
 declare const useMethod: typeof getMethod;
 declare function isMethod(event: H3Event, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): boolean;
 declare function assertMethod(event: H3Event, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): void;
-declare function getRequestHeaders(event: H3Event): H3Event['req']['headers'];
+declare function getRequestHeaders(event: H3Event): RequestHeaders;
 declare const getHeaders: typeof getRequestHeaders;
-declare function getRequestHeader(event: H3Event, name: string): H3Event['req']['headers'][string];
+declare function getRequestHeader(event: H3Event, name: string): RequestHeaders[string];
 declare const getHeader: typeof getRequestHeader;
 
 declare function send(event: H3Event, data?: any, type?: string): Promise<void>;
@@ -285,4 +305,4 @@ interface CreateRouterOptions {
 }
 declare function createRouter(opts?: CreateRouterOptions): Router;
 
-export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CreateRouterOptions, DynamicEventHandler, Encoding, EventHandler, EventHandlerResponse, H3Error, H3Event, H3EventContext, H3Headers, H3Response, HTTPMethod, InputLayer, InputStack, Layer, LazyEventHandler, MIMES, Matcher, NodeListener, NodeMiddleware, NodePromisifiedHandler, Router, RouterMethod, RouterUse, Stack, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, readBody, readRawBody, send, sendError, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, toNodeListener, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody, writeEarlyHints };
+export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CreateRouterOptions, DynamicEventHandler, Encoding, EventHandler, EventHandlerResponse, H3Error, H3Event, H3EventContext, H3Headers, H3Response, HTTPMethod, InputLayer, InputStack, Layer, LazyEventHandler, MIMES, Matcher, NodeListener, NodeMiddleware, NodePromisifiedHandler, RequestHeaders, Router, RouterMethod, RouterUse, SendProxyOptions, Stack, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, readBody, readRawBody, send, sendError, sendProxy, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, toNodeListener, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody, writeEarlyHints };

package/dist/index.mjs

@@ -23,6 +23,19 @@ class H3Error extends Error {
     this.unhandled = false;
     this.statusMessage = void 0;
   }
+  toJSON() {
+    const obj = {
+      message: this.message,
+      statusCode: this.statusCode
+    };
+    if (this.statusMessage) {
+      obj.statusMessage = this.statusMessage;
+    }
+    if (this.data !== void 0) {
+      obj.data = this.data;
+    }
+    return obj;
+  }
 }
 H3Error.__h3_error__ = true;
 function createError(input) {
@@ -45,14 +58,18 @@ function createError(input) {
       }
     }
   }
+  if (input.data) {
+    err.data = input.data;
+  }
   if (input.statusCode) {
     err.statusCode = input.statusCode;
+  } else if (input.status) {
+    err.statusCode = input.status;
   }
   if (input.statusMessage) {
     err.statusMessage = input.statusMessage;
-  }
-  if (input.data) {
-    err.data = input.data;
+  } else if (input.statusText) {
+    err.statusMessage = input.statusText;
   }
   if (input.fatal !== void 0) {
     err.fatal = input.fatal;
@@ -131,7 +148,12 @@ function assertMethod(event, expected, allowHead) {
   }
 }
 function getRequestHeaders(event) {
-  return event.req.headers;
+  const _headers = {};
+  for (const key in event.req.headers) {
+    const val = event.req.headers[key];
+    _headers[key] = Array.isArray(val) ? val.filter(Boolean).join(", ") : val;
+  }
+  return _headers;
 }
 const getHeaders = getRequestHeaders;
 function getRequestHeader(event, name) {
@@ -288,7 +310,7 @@ function sendStream(event, data) {
 const noop = () => {
 };
 function writeEarlyHints(event, hints, cb = noop) {
-  if (!event.res.socket && !("writeEarlyHints" in event.res)) {
+  if (!event.res.socket) {
     cb();
     return;
   }
@@ -297,10 +319,6 @@ function writeEarlyHints(event, hints, cb = noop) {
   }
   if (hints.link) {
     hints.link = Array.isArray(hints.link) ? hints.link : hints.link.split(",");
-    hints.link = hints.link.map((l) => l.trim().replace(/; crossorigin/g, ""));
-  }
-  if ("writeEarlyHints" in event.res) {
-    return event.res.writeEarlyHints(hints, cb);
   }
   const headers = Object.entries(hints).map((e) => [e[0].toLowerCase(), e[1]]);
   if (!headers.length) {
@@ -346,6 +364,44 @@ function deleteCookie(event, name, serializeOptions) {
   });
 }
 
+async function sendProxy(event, target, opts = {}) {
+  const _fetch = opts.fetch || globalThis.fetch;
+  if (!_fetch) {
+    throw new Error("fetch is not available. Try importing `node-fetch-native/polyfill` for Node.js.");
+  }
+  const response = await _fetch(target, {
+    headers: opts.headers,
+    ...opts.fetchOptions
+  });
+  event.res.statusCode = response.status;
+  event.res.statusMessage = response.statusText;
+  for (const [key, value] of response.headers.entries()) {
+    if (key === "content-encoding") {
+      continue;
+    }
+    if (key === "content-length") {
+      continue;
+    }
+    event.res.setHeader(key, value);
+  }
+  try {
+    if (response.body) {
+      if (opts.sendStream === false) {
+        const data = new Uint8Array(await response.arrayBuffer());
+        event.res.end(data);
+      } else {
+        for await (const chunk of response.body) {
+          event.res.write(chunk);
+        }
+        event.res.end();
+      }
+    }
+  } catch (err) {
+    event.res.end();
+    throw err;
+  }
+}
+
 class H3Headers {
   constructor(init) {
     if (!init) {
@@ -358,6 +414,18 @@ class H3Headers {
       this._headers = Object.fromEntries(Object.entries(init).map(([key, value]) => [key.toLowerCase(), value]));
     }
   }
+  [Symbol.iterator]() {
+    return this.entries();
+  }
+  entries() {
+    throw Object.entries(this._headers)[Symbol.iterator]();
+  }
+  keys() {
+    return Object.keys(this._headers)[Symbol.iterator]();
+  }
+  values() {
+    throw Object.values(this._headers)[Symbol.iterator]();
+  }
   append(name, value) {
     const _name = name.toLowerCase();
     this.set(_name, [this.get(_name), value].filter(Boolean).join(", "));
@@ -697,7 +765,11 @@ function createRouter(opts = {}) {
     router[method] = (path, handle) => router.add(path, handle, method);
   }
   router.handler = eventHandler((event) => {
-    const path = new URL(event.req.url || "/", "http://localhost").pathname;
+    let path = event.req.url || "/";
+    const qIndex = path.indexOf("?");
+    if (qIndex !== -1) {
+      path = path.substring(0, qIndex);
+    }
     const matched = _router.lookup(path);
     if (!matched) {
       if (opts.preemtive) {
@@ -726,4 +798,4 @@ function createRouter(opts = {}) {
   return router;
 }
 
-export { H3Error, H3Event, H3Headers, H3Response, MIMES, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, readBody, readRawBody, send, sendError, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, toNodeListener, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody, writeEarlyHints };
+export { H3Error, H3Event, H3Headers, H3Response, MIMES, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, readBody, readRawBody, send, sendError, sendProxy, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, toNodeListener, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody, writeEarlyHints };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "h3",
-  "version": "0.8.4",
+  "version": "0.8.6",
   "description": "Tiny JavaScript Server",
   "repository": "unjs/h3",
   "license": "MIT",
@@ -21,7 +21,7 @@
   ],
   "dependencies": {
     "cookie-es": "^0.5.0",
-    "destr": "^1.1.1",
+    "destr": "^1.2.0",
     "radix3": "^0.2.1",
     "ufo": "^0.8.6"
   },
@@ -29,30 +29,31 @@
     "0x": "^5.4.1",
     "@nuxtjs/eslint-config-typescript": "^11.0.0",
     "@types/express": "^4.17.14",
-    "@types/node": "^18.11.0",
+    "@types/node": "^18.11.7",
     "@types/supertest": "^2.0.12",
     "@vitest/coverage-c8": "^0.24.3",
     "autocannon": "^7.10.0",
     "changelogen": "^0.3.5",
     "connect": "^3.7.0",
-    "eslint": "^8.25.0",
+    "eslint": "^8.26.0",
     "express": "^4.18.2",
     "get-port": "^6.1.2",
     "jiti": "^1.16.0",
     "listhen": "^0.3.4",
-    "supertest": "^6.3.0",
+    "node-fetch-native": "^0.1.8",
+    "supertest": "^6.3.1",
     "typescript": "^4.8.4",
     "unbuild": "^0.9.4",
     "vitest": "^0.24.3"
   },
-  "packageManager": "pnpm@7.13.5",
+  "packageManager": "pnpm@7.14.0",
   "scripts": {
     "build": "unbuild",
     "dev": "vitest",
     "lint": "eslint --ext ts,mjs,cjs .",
     "play": "jiti ./playground/index.ts",
     "profile": "0x -o -D .profile -P 'autocannon -c 100 -p 10 -d 40 http://localhost:$PORT' ./playground/server.cjs",
-    "release": "pnpm test && pnpm test && pnpm build && changelogen --release && pnpm publish && git push --follow-tags",
+    "release": "pnpm test && pnpm build && changelogen --release && pnpm publish && git push --follow-tags",
     "test": "pnpm lint && vitest run --coverage"
   }
 }