h3 0.7.13 → 0.7.14

package/README.md

@@ -112,6 +112,8 @@ app.use((req, res, next) => { req.setHeader('X-Foo', 'bar'); next() })
 
 ## Utilities
 
+### Built-in
+
 Instead of adding helpers to `req` and `res`, h3 exposes them as composable utilities.
 
 - `useRawBody(req, encoding?)`
@@ -121,9 +123,15 @@ Instead of adding helpers to `req` and `res`, h3 exposes them as composable util
 - `setCookie(res, name, value, opts?)`
 - `deleteCookie(res, name, opts?)`
 - `useQuery(req)`
+- `getRouterParams(event)`
 - `send(res, data, type?)`
 - `sendRedirect(res, location, code=302)`
-- `appendHeader(res, name, value)`
+- `getRequestHeaders(event, headers)` (alias: `getHeaders`)
+- `getRequestHeader(event, name)` (alias: `getHeader`)
+- `setResponseHeaders(event, headers)` (alias: `setHeaders`)
+- `setResponseHeader(event, name, value)` (alias: `setHeader`)
+- `appendResponseHeaders(event, headers)` (alias: `appendHeaders`)
+- `appendResponseHeader(event, name, value)` (alias: `appendHeader`)
 - `createError({ statusCode, statusMessage, data? })`
 - `sendError(res, error, debug?)`
 - `defineHandle(handle)`
@@ -134,6 +142,13 @@ Instead of adding helpers to `req` and `res`, h3 exposes them as composable util
 
 👉 You can learn more about usage in [JSDocs Documentation](https://www.jsdocs.io/package/h3#package-functions).
 
+### Add-ons
+
+More composable utilities can be found in community packages.
+
+- `validateBody(event, schema)` from [h3-typebox](https://github.com/kevinmarrec/h3-typebox)
+- `validateQuery(event, schema)` from [h3-typebox](https://github.com/kevinmarrec/h3-typebox)
+
 ## How it works?
 
 Using `createApp`, it returns a standard `(req, res)` handler function and internally an array called middleware stack. using`use()` method we can add an item to this internal stack.

package/dist/index.cjs

@@ -11,14 +11,23 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 const destr__default = /*#__PURE__*/_interopDefaultLegacy(destr);
 
-function useQuery(event) {
+function getQuery(event) {
   return ufo.getQuery(event.req.url || "");
 }
-function useMethod(event, defaultMethod = "GET") {
+const useQuery = getQuery;
+function getRouterParams(event) {
+  return event.context.params || {};
+}
+function getRouterParam(event, name) {
+  const params = getRouterParams(event);
+  return params[name];
+}
+function getMethod(event, defaultMethod = "GET") {
   return (event.req.method || defaultMethod).toUpperCase();
 }
+const useMethod = getMethod;
 function isMethod(event, expected, allowHead) {
-  const method = useMethod(event);
+  const method = getMethod(event);
   if (allowHead && method === "HEAD") {
     return true;
   }
@@ -39,11 +48,21 @@ function assertMethod(event, expected, allowHead) {
     });
   }
 }
+function getRequestHeaders(event) {
+  return event.req.headers;
+}
+const getHeaders = getRequestHeaders;
+function getRequestHeader(event, name) {
+  const headers = getRequestHeaders(event);
+  const value = headers[name.toLowerCase()];
+  return value;
+}
+const getHeader = getRequestHeader;
 
 const RawBodySymbol = Symbol("h3RawBody");
 const ParsedBodySymbol = Symbol("h3RawBody");
 const PayloadMethods = ["PATCH", "POST", "PUT", "DELETE"];
-function useRawBody(event, encoding = "utf-8") {
+function readRawBody(event, encoding = "utf-8") {
   assertMethod(event, PayloadMethods);
   if (RawBodySymbol in event.req) {
     const promise2 = Promise.resolve(event.req[RawBodySymbol]);
@@ -64,11 +83,12 @@ function useRawBody(event, encoding = "utf-8") {
   });
   return encoding ? promise.then((buff) => buff.toString(encoding)) : promise;
 }
-async function useBody(event) {
+const useRawBody = readRawBody;
+async function readBody(event) {
   if (ParsedBodySymbol in event.req) {
     return event.req[ParsedBodySymbol];
   }
-  const body = await useRawBody(event);
+  const body = await readRawBody(event);
   if (event.req.headers["content-type"] === "application/x-www-form-urlencoded") {
     const parsedForm = Object.fromEntries(new URLSearchParams(body));
     return parsedForm;
@@ -77,6 +97,7 @@ async function useBody(event) {
   event.req[ParsedBodySymbol] = json;
   return json;
 }
+const useBody = readBody;
 
 function handleCacheHeaders(event, opts) {
   const cacheControls = ["public"].concat(opts.cacheControls || []);
@@ -142,7 +163,25 @@ function sendRedirect(event, location, code = 302) {
 </html>`;
   return send(event, html, MIMES.html);
 }
-function appendHeader(event, name, value) {
+function getResponseHeaders(event) {
+  return event.res.getHeaders();
+}
+function getResponseHeader(event, name) {
+  return event.res.getHeader(name);
+}
+function setResponseHeaders(event, headers) {
+  Object.entries(headers).forEach(([name, value]) => event.res.setHeader(name, value));
+}
+const setHeaders = setResponseHeaders;
+function setResponseHeader(event, name, value) {
+  event.res.setHeader(name, value);
+}
+const setHeader = setResponseHeader;
+function appendResponseHeaders(event, headers) {
+  Object.entries(headers).forEach(([name, value]) => appendResponseHeader(event, name, value));
+}
+const appendHeaders = appendResponseHeaders;
+function appendResponseHeader(event, name, value) {
   let current = event.res.getHeader(name);
   if (!current) {
     event.res.setHeader(name, value);
@@ -153,6 +192,7 @@ function appendHeader(event, name, value) {
   }
   event.res.setHeader(name, current.concat(value));
 }
+const appendHeader = appendResponseHeader;
 function isStream(data) {
   return data && typeof data === "object" && typeof data.pipe === "function" && typeof data.on === "function";
 }
@@ -164,12 +204,14 @@ function sendStream(event, data) {
   });
 }
 
-function useCookies(event) {
+function parseCookies(event) {
   return cookieEs.parse(event.req.headers.cookie || "");
 }
-function useCookie(event, name) {
-  return useCookies(event)[name];
+const useCookies = parseCookies;
+function getCookie(event, name) {
+  return parseCookies(event)[name];
 }
+const useCookie = getCookie;
 function setCookie(event, name, value, serializeOptions) {
   const cookieStr = cookieEs.serialize(name, value, {
     path: "/",
@@ -543,6 +585,9 @@ function createRouter() {
 exports.H3Error = H3Error;
 exports.MIMES = MIMES;
 exports.appendHeader = appendHeader;
+exports.appendHeaders = appendHeaders;
+exports.appendResponseHeader = appendResponseHeader;
+exports.appendResponseHeaders = appendResponseHeaders;
 exports.assertMethod = assertMethod;
 exports.callHandler = callHandler;
 exports.createApp = createApp;
@@ -560,6 +605,17 @@ exports.defineMiddleware = defineMiddleware;
 exports.deleteCookie = deleteCookie;
 exports.dynamicEventHandler = dynamicEventHandler;
 exports.eventHandler = eventHandler;
+exports.getCookie = getCookie;
+exports.getHeader = getHeader;
+exports.getHeaders = getHeaders;
+exports.getMethod = getMethod;
+exports.getQuery = getQuery;
+exports.getRequestHeader = getRequestHeader;
+exports.getRequestHeaders = getRequestHeaders;
+exports.getResponseHeader = getResponseHeader;
+exports.getResponseHeaders = getResponseHeaders;
+exports.getRouterParam = getRouterParam;
+exports.getRouterParams = getRouterParams;
 exports.handleCacheHeaders = handleCacheHeaders;
 exports.isError = isError;
 exports.isEvent = isEvent;
@@ -568,13 +624,20 @@ exports.isMethod = isMethod;
 exports.isStream = isStream;
 exports.lazyEventHandler = lazyEventHandler;
 exports.lazyHandle = lazyHandle;
+exports.parseCookies = parseCookies;
 exports.promisifyHandle = promisifyHandle;
 exports.promisifyHandler = promisifyHandler;
+exports.readBody = readBody;
+exports.readRawBody = readRawBody;
 exports.send = send;
 exports.sendError = sendError;
 exports.sendRedirect = sendRedirect;
 exports.sendStream = sendStream;
 exports.setCookie = setCookie;
+exports.setHeader = setHeader;
+exports.setHeaders = setHeaders;
+exports.setResponseHeader = setResponseHeader;
+exports.setResponseHeaders = setResponseHeaders;
 exports.toEventHandler = toEventHandler;
 exports.use = use;
 exports.useBase = useBase;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import http from 'http';
+import http, { OutgoingMessage } from 'http';
 import { CookieSerializeOptions } from 'cookie-es';
 import * as ufo from 'ufo';
 
@@ -152,7 +152,9 @@ declare function useBase(base: string, handler: Handler): Handler;
  *
  * @return {String|Buffer} Encoded raw string or raw Buffer of the body
  */
-declare function useRawBody(event: CompatibilityEvent, encoding?: Encoding): Encoding extends false ? Buffer : Promise<string | Buffer>;
+declare function readRawBody(event: CompatibilityEvent, encoding?: Encoding): Encoding extends false ? Buffer : Promise<string | Buffer>;
+/** @deprecated Use `h3.readRawBody` */
+declare const useRawBody: typeof readRawBody;
 /**
  * Reads request body and try to safely parse using [destr](https://github.com/unjs/destr)
  * @param event {CompatibilityEvent} H3 event or req passed by h3 handler
@@ -164,7 +166,9 @@ declare function useRawBody(event: CompatibilityEvent, encoding?: Encoding): Enc
  * const body = await useBody(req)
  * ```
  */
-declare function useBody<T = any>(event: CompatibilityEvent): Promise<T>;
+declare function readBody<T = any>(event: CompatibilityEvent): Promise<T>;
+/** @deprecated Use `h3.readBody` */
+declare const useBody: typeof readBody;
 
 interface CacheConditions {
     modifiedTime?: string | Date;
@@ -189,10 +193,12 @@ declare const MIMES: {
  * @param event {CompatibilityEvent} H3 event or req passed by h3 handler
  * @returns Object of cookie name-value pairs
  * ```ts
- * const cookies = useCookies(req)
+ * const cookies = parseCookies(event)
  * ```
  */
-declare function useCookies(event: CompatibilityEvent): Record<string, string>;
+declare function parseCookies(event: CompatibilityEvent): Record<string, string>;
+/** @deprecated Use `h3.parseCookies` */
+declare const useCookies: typeof parseCookies;
 /**
  * Get a cookie value by name.
  * @param event {CompatibilityEvent} H3 event or req passed by h3 handler
@@ -202,7 +208,9 @@ declare function useCookies(event: CompatibilityEvent): Record<string, string>;
  * const authorization = useCookie(request, 'Authorization')
  * ```
  */
-declare function useCookie(event: CompatibilityEvent, name: string): string | undefined;
+declare function getCookie(event: CompatibilityEvent, name: string): string | undefined;
+/** @deprecated Use `h3.getCookie` */
+declare const useCookie: typeof getCookie;
 /**
  * Set a cookie value by name.
  * @param event {CompatibilityEvent} H3 event or res passed by h3 handler
@@ -225,15 +233,34 @@ declare function setCookie(event: CompatibilityEvent, name: string, value: strin
  */
 declare function deleteCookie(event: CompatibilityEvent, name: string, serializeOptions?: CookieSerializeOptions): void;
 
-declare function useQuery(event: CompatibilityEvent): ufo.QueryObject;
-declare function useMethod(event: CompatibilityEvent, defaultMethod?: HTTPMethod): HTTPMethod;
+declare function getQuery(event: CompatibilityEvent): ufo.QueryObject;
+/** @deprecated Use `h3.getQuery` */
+declare const useQuery: typeof getQuery;
+declare function getRouterParams(event: CompatibilityEvent): CompatibilityEvent['context'];
+declare function getRouterParam(event: CompatibilityEvent, name: string): CompatibilityEvent['context'][string];
+declare function getMethod(event: CompatibilityEvent, defaultMethod?: HTTPMethod): HTTPMethod;
+/** @deprecated Use `h3.getMethod` */
+declare const useMethod: typeof getMethod;
 declare function isMethod(event: CompatibilityEvent, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): boolean;
 declare function assertMethod(event: CompatibilityEvent, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): void;
+declare function getRequestHeaders(event: CompatibilityEvent): CompatibilityEvent['req']['headers'];
+declare const getHeaders: typeof getRequestHeaders;
+declare function getRequestHeader(event: CompatibilityEvent, name: string): CompatibilityEvent['req']['headers'][string];
+declare const getHeader: typeof getRequestHeader;
 
 declare function send(event: CompatibilityEvent, data?: any, type?: string): Promise<void>;
 declare function defaultContentType(event: CompatibilityEvent, type?: string): void;
 declare function sendRedirect(event: CompatibilityEvent, location: string, code?: number): Promise<void>;
-declare function appendHeader(event: CompatibilityEvent, name: string, value: string): void;
+declare function getResponseHeaders(event: CompatibilityEvent): ReturnType<CompatibilityEvent['res']['getHeaders']>;
+declare function getResponseHeader(event: CompatibilityEvent, name: string): ReturnType<CompatibilityEvent['res']['getHeader']>;
+declare function setResponseHeaders(event: CompatibilityEvent, headers: Record<string, Parameters<OutgoingMessage['setHeader']>[1]>): void;
+declare const setHeaders: typeof setResponseHeaders;
+declare function setResponseHeader(event: CompatibilityEvent, name: string, value: Parameters<OutgoingMessage['setHeader']>[1]): void;
+declare const setHeader: typeof setResponseHeader;
+declare function appendResponseHeaders(event: CompatibilityEvent, headers: Record<string, string>): void;
+declare const appendHeaders: typeof appendResponseHeaders;
+declare function appendResponseHeader(event: CompatibilityEvent, name: string, value: string): void;
+declare const appendHeader: typeof appendResponseHeader;
 declare function isStream(data: any): any;
 declare function sendStream(event: CompatibilityEvent, data: any): Promise<void>;
 
@@ -247,4 +274,4 @@ interface Router extends AddRouteShortcuts {
 }
 declare function createRouter(): Router;
 
-export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CompatibilityEvent, CompatibilityEventHandler, DynamicEventHandler, Encoding, EventHandler, H3Error, H3Event, H3EventContext, H3Response, HTTPMethod, Handler, IncomingMessage, InputLayer, InputStack, Layer, LazyEventHandler, LazyHandler, MIMES, Matcher, Middleware, NodeHandler, PromisifiedHandler, Router, RouterMethod, RouterUse, ServerResponse, Stack, appendHeader, assertMethod, callHandler, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineHandle, defineHandler, defineLazyEventHandler, defineLazyHandler, defineMiddleware, deleteCookie, dynamicEventHandler, eventHandler, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, lazyHandle, promisifyHandle, promisifyHandler, send, sendError, sendRedirect, sendStream, setCookie, toEventHandler, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };
+export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CompatibilityEvent, CompatibilityEventHandler, DynamicEventHandler, Encoding, EventHandler, H3Error, H3Event, H3EventContext, H3Response, HTTPMethod, Handler, IncomingMessage, InputLayer, InputStack, Layer, LazyEventHandler, LazyHandler, MIMES, Matcher, Middleware, NodeHandler, PromisifiedHandler, Router, RouterMethod, RouterUse, ServerResponse, Stack, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callHandler, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineHandle, defineHandler, defineLazyEventHandler, defineLazyHandler, defineMiddleware, deleteCookie, dynamicEventHandler, eventHandler, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, lazyHandle, parseCookies, promisifyHandle, promisifyHandler, readBody, readRawBody, send, sendError, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };

package/dist/index.mjs

@@ -1,16 +1,25 @@
-import { getQuery, withoutTrailingSlash, withoutBase } from 'ufo';
+import { getQuery as getQuery$1, withoutTrailingSlash, withoutBase } from 'ufo';
 import { createRouter as createRouter$1 } from 'radix3';
 import destr from 'destr';
 import { parse, serialize } from 'cookie-es';
 
-function useQuery(event) {
-  return getQuery(event.req.url || "");
+function getQuery(event) {
+  return getQuery$1(event.req.url || "");
 }
-function useMethod(event, defaultMethod = "GET") {
+const useQuery = getQuery;
+function getRouterParams(event) {
+  return event.context.params || {};
+}
+function getRouterParam(event, name) {
+  const params = getRouterParams(event);
+  return params[name];
+}
+function getMethod(event, defaultMethod = "GET") {
   return (event.req.method || defaultMethod).toUpperCase();
 }
+const useMethod = getMethod;
 function isMethod(event, expected, allowHead) {
-  const method = useMethod(event);
+  const method = getMethod(event);
   if (allowHead && method === "HEAD") {
     return true;
   }
@@ -31,11 +40,21 @@ function assertMethod(event, expected, allowHead) {
     });
   }
 }
+function getRequestHeaders(event) {
+  return event.req.headers;
+}
+const getHeaders = getRequestHeaders;
+function getRequestHeader(event, name) {
+  const headers = getRequestHeaders(event);
+  const value = headers[name.toLowerCase()];
+  return value;
+}
+const getHeader = getRequestHeader;
 
 const RawBodySymbol = Symbol("h3RawBody");
 const ParsedBodySymbol = Symbol("h3RawBody");
 const PayloadMethods = ["PATCH", "POST", "PUT", "DELETE"];
-function useRawBody(event, encoding = "utf-8") {
+function readRawBody(event, encoding = "utf-8") {
   assertMethod(event, PayloadMethods);
   if (RawBodySymbol in event.req) {
     const promise2 = Promise.resolve(event.req[RawBodySymbol]);
@@ -56,11 +75,12 @@ function useRawBody(event, encoding = "utf-8") {
   });
   return encoding ? promise.then((buff) => buff.toString(encoding)) : promise;
 }
-async function useBody(event) {
+const useRawBody = readRawBody;
+async function readBody(event) {
   if (ParsedBodySymbol in event.req) {
     return event.req[ParsedBodySymbol];
   }
-  const body = await useRawBody(event);
+  const body = await readRawBody(event);
   if (event.req.headers["content-type"] === "application/x-www-form-urlencoded") {
     const parsedForm = Object.fromEntries(new URLSearchParams(body));
     return parsedForm;
@@ -69,6 +89,7 @@ async function useBody(event) {
   event.req[ParsedBodySymbol] = json;
   return json;
 }
+const useBody = readBody;
 
 function handleCacheHeaders(event, opts) {
   const cacheControls = ["public"].concat(opts.cacheControls || []);
@@ -134,7 +155,25 @@ function sendRedirect(event, location, code = 302) {
 </html>`;
   return send(event, html, MIMES.html);
 }
-function appendHeader(event, name, value) {
+function getResponseHeaders(event) {
+  return event.res.getHeaders();
+}
+function getResponseHeader(event, name) {
+  return event.res.getHeader(name);
+}
+function setResponseHeaders(event, headers) {
+  Object.entries(headers).forEach(([name, value]) => event.res.setHeader(name, value));
+}
+const setHeaders = setResponseHeaders;
+function setResponseHeader(event, name, value) {
+  event.res.setHeader(name, value);
+}
+const setHeader = setResponseHeader;
+function appendResponseHeaders(event, headers) {
+  Object.entries(headers).forEach(([name, value]) => appendResponseHeader(event, name, value));
+}
+const appendHeaders = appendResponseHeaders;
+function appendResponseHeader(event, name, value) {
   let current = event.res.getHeader(name);
   if (!current) {
     event.res.setHeader(name, value);
@@ -145,6 +184,7 @@ function appendHeader(event, name, value) {
   }
   event.res.setHeader(name, current.concat(value));
 }
+const appendHeader = appendResponseHeader;
 function isStream(data) {
   return data && typeof data === "object" && typeof data.pipe === "function" && typeof data.on === "function";
 }
@@ -156,12 +196,14 @@ function sendStream(event, data) {
   });
 }
 
-function useCookies(event) {
+function parseCookies(event) {
   return parse(event.req.headers.cookie || "");
 }
-function useCookie(event, name) {
-  return useCookies(event)[name];
+const useCookies = parseCookies;
+function getCookie(event, name) {
+  return parseCookies(event)[name];
 }
+const useCookie = getCookie;
 function setCookie(event, name, value, serializeOptions) {
   const cookieStr = serialize(name, value, {
     path: "/",
@@ -532,4 +574,4 @@ function createRouter() {
   return router;
 }
 
-export { H3Error, MIMES, appendHeader, assertMethod, callHandler, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineHandle, defineHandler, defineLazyEventHandler, defineLazyHandler, defineMiddleware, deleteCookie, dynamicEventHandler, eventHandler, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, lazyHandle, promisifyHandle, promisifyHandler, send, sendError, sendRedirect, sendStream, setCookie, toEventHandler, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };
+export { H3Error, MIMES, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callHandler, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineHandle, defineHandler, defineLazyEventHandler, defineLazyHandler, defineMiddleware, deleteCookie, dynamicEventHandler, eventHandler, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, lazyHandle, parseCookies, promisifyHandle, promisifyHandler, readBody, readRawBody, send, sendError, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "h3",
-  "version": "0.7.13",
+  "version": "0.7.14",
   "description": "Tiny JavaScript Server",
   "repository": "unjs/h3",
   "license": "MIT",
@@ -45,7 +45,7 @@
     "unbuild": "latest",
     "vitest": "latest"
   },
-  "packageManager": "pnpm@7.8.0",
+  "packageManager": "pnpm@7.9.0",
   "scripts": {
     "build": "unbuild",
     "dev": "vitest",