h3 0.5.5 → 0.5.6

package/dist/index.cjs

@@ -78,6 +78,37 @@ async function useBody(event) {
   return json;
 }
 
+function handleCacheHeaders(event, opts) {
+  const cacheControls = ["public"].concat(opts.cacheControls || []);
+  let cacheMatched = false;
+  if (opts.maxAge !== void 0) {
+    opts.cacheControls?.push(`max-age=${+opts.maxAge}`, `s-maxage=${+opts.maxAge}`);
+  }
+  if (opts.modifiedTime) {
+    const ifModifiedSince = event.req.headers["if-modified-since"];
+    event.res.setHeader("Last-Modified", +opts.modifiedTime + "");
+    if (ifModifiedSince) {
+      if (new Date(ifModifiedSince) >= opts.modifiedTime) {
+        cacheMatched = true;
+      }
+    }
+  }
+  if (opts.etag) {
+    event.res.setHeader("Etag", opts.etag);
+    const ifNonMatch = event.req.headers["if-none-match"];
+    if (ifNonMatch === opts.etag) {
+      cacheMatched = true;
+    }
+  }
+  event.res.setHeader("Cache-Control", cacheControls.join(", "));
+  if (cacheMatched) {
+    event.res.statusCode = 304;
+    event.res.end("");
+    return true;
+  }
+  return false;
+}
+
 const MIMES = {
   html: "text/html",
   json: "application/json"
@@ -250,12 +281,12 @@ function useBase(base, handler) {
   };
 }
 
-function eventHandler(handler) {
+function defineEventHandler(handler) {
   handler.__is_handler__ = true;
   return handler;
 }
-const defineEventHandler = eventHandler;
-function lazyEventHandler(factory) {
+const eventHandler = defineEventHandler;
+function defineLazyEventHandler(factory) {
   let _promise;
   let _resolved;
   const resolveHandler = () => {
@@ -281,7 +312,7 @@ function lazyEventHandler(factory) {
     return resolveHandler().then((handler) => handler(event));
   });
 }
-const defineLazyEventHandler = lazyEventHandler;
+const lazyEventHandler = defineLazyEventHandler;
 function dynamicEventHandler(initial) {
   let current = initial;
   const wrapper = eventHandler((event) => {
@@ -494,6 +525,7 @@ exports.defineMiddleware = defineMiddleware;
 exports.deleteCookie = deleteCookie;
 exports.dynamicEventHandler = dynamicEventHandler;
 exports.eventHandler = eventHandler;
+exports.handleCacheHeaders = handleCacheHeaders;
 exports.isError = isError;
 exports.isEvent = isEvent;
 exports.isEventHandler = isEventHandler;

package/dist/index.d.ts

@@ -7,9 +7,7 @@ interface H3Event {
     event: H3Event;
     req: IncomingMessage;
     res: ServerResponse;
-    /**
-     * Request params only filled with h3 Router handlers
-     */
+    /** Request params only filled with h3 Router handlers */
     params?: Record<string, any>;
 }
 declare type CompatibilityEvent = H3Event | IncomingMessage | ServerResponse;
@@ -20,13 +18,11 @@ interface EventHandler {
     '__is_handler__'?: true;
     (event: CompatibilityEvent): H3Response | Promise<H3Response>;
 }
-declare function eventHandler(handler: EventHandler): EventHandler;
-/** @deprecated Use eventHandler() */
-declare const defineEventHandler: typeof eventHandler;
+declare function defineEventHandler(handler: EventHandler): EventHandler;
+declare const eventHandler: typeof defineEventHandler;
 declare type LazyEventHandler = () => EventHandler | Promise<EventHandler>;
-declare function lazyEventHandler(factory: LazyEventHandler): EventHandler;
-/** @deprecated use lazyEventHandler() */
-declare const defineLazyEventHandler: typeof lazyEventHandler;
+declare function defineLazyEventHandler(factory: LazyEventHandler): EventHandler;
+declare const lazyEventHandler: typeof defineLazyEventHandler;
 interface DynamicEventHandler extends EventHandler {
     set: (handler: EventHandler) => void;
 }
@@ -37,19 +33,21 @@ declare function toEventHandler(handler: CompatibilityEventHandler): EventHandle
 declare function createEvent(req: http.IncomingMessage, res: http.ServerResponse): CompatibilityEvent;
 declare function isEvent(input: any): input is H3Event;
 
-interface IncomingMessage extends http.IncomingMessage {
-    originalUrl?: string;
+interface CompatibilityRequestProps {
     event: H3Event;
+    /** Only available with connect and press */
+    originalUrl?: string;
+    /** Request params only filled with h3 Router handlers */
+    params?: Record<string, any>;
+}
+interface IncomingMessage extends http.IncomingMessage, CompatibilityRequestProps {
     req: H3Event['req'];
     res: H3Event['res'];
 }
 interface ServerResponse extends http.ServerResponse {
     event: H3Event;
     res: H3Event['res'];
-    req: http.ServerResponse['req'] & {
-        event: H3Event;
-        originalUrl?: string;
-    };
+    req: http.ServerResponse['req'] & CompatibilityRequestProps;
 }
 declare type Handler<T = any, ReqT = {}> = (req: IncomingMessage & ReqT, res: ServerResponse) => T;
 declare type PromisifiedHandler = Handler<Promise<any>>;
@@ -165,6 +163,19 @@ declare function useRawBody(event: CompatibilityEvent, encoding?: Encoding): Enc
  */
 declare function useBody<T = any>(event: CompatibilityEvent): Promise<T>;
 
+interface CacheConditions {
+    modifiedTime?: Date;
+    maxAge?: number;
+    etag?: string;
+    cacheControls?: string[];
+}
+/**
+ * Check request caching headers (`If-Modified-Since`) and add caching headers (Last-Modified, Cache-Control)
+ * Note: `public` cache control will be added by default
+ * @returns `true` when cache headers are matching. When `true` is returned, no reponse should be sent anymore
+ */
+declare function handleCacheHeaders(event: CompatibilityEvent, opts: CacheConditions): boolean;
+
 declare const MIMES: {
     html: string;
     json: string;
@@ -233,4 +244,4 @@ interface Router extends AddRouteShortcuts {
 }
 declare function createRouter(): Router;
 
-export { AddRouteShortcuts, App, AppOptions, AppUse, CompatibilityEvent, CompatibilityEventHandler, DynamicEventHandler, Encoding, EventHandler, H3Error, H3Event, H3Response, HTTPMethod, Handler, IncomingMessage, InputLayer, InputStack, JSONValue, Layer, LazyEventHandler, LazyHandler, MIMES, Matcher, Middleware, NodeHandler, PromisifiedHandler, Router, RouterMethod, RouterUse, ServerResponse, Stack, _JSONValue, appendHeader, assertMethod, callHandler, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineHandle, defineHandler, defineLazyEventHandler, defineLazyHandler, defineMiddleware, deleteCookie, dynamicEventHandler, eventHandler, 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, H3Response, HTTPMethod, Handler, IncomingMessage, InputLayer, InputStack, JSONValue, Layer, LazyEventHandler, LazyHandler, MIMES, Matcher, Middleware, NodeHandler, PromisifiedHandler, Router, RouterMethod, RouterUse, ServerResponse, Stack, _JSONValue, 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 };

package/dist/index.mjs

@@ -70,6 +70,37 @@ async function useBody(event) {
   return json;
 }
 
+function handleCacheHeaders(event, opts) {
+  const cacheControls = ["public"].concat(opts.cacheControls || []);
+  let cacheMatched = false;
+  if (opts.maxAge !== void 0) {
+    opts.cacheControls?.push(`max-age=${+opts.maxAge}`, `s-maxage=${+opts.maxAge}`);
+  }
+  if (opts.modifiedTime) {
+    const ifModifiedSince = event.req.headers["if-modified-since"];
+    event.res.setHeader("Last-Modified", +opts.modifiedTime + "");
+    if (ifModifiedSince) {
+      if (new Date(ifModifiedSince) >= opts.modifiedTime) {
+        cacheMatched = true;
+      }
+    }
+  }
+  if (opts.etag) {
+    event.res.setHeader("Etag", opts.etag);
+    const ifNonMatch = event.req.headers["if-none-match"];
+    if (ifNonMatch === opts.etag) {
+      cacheMatched = true;
+    }
+  }
+  event.res.setHeader("Cache-Control", cacheControls.join(", "));
+  if (cacheMatched) {
+    event.res.statusCode = 304;
+    event.res.end("");
+    return true;
+  }
+  return false;
+}
+
 const MIMES = {
   html: "text/html",
   json: "application/json"
@@ -242,12 +273,12 @@ function useBase(base, handler) {
   };
 }
 
-function eventHandler(handler) {
+function defineEventHandler(handler) {
   handler.__is_handler__ = true;
   return handler;
 }
-const defineEventHandler = eventHandler;
-function lazyEventHandler(factory) {
+const eventHandler = defineEventHandler;
+function defineLazyEventHandler(factory) {
   let _promise;
   let _resolved;
   const resolveHandler = () => {
@@ -273,7 +304,7 @@ function lazyEventHandler(factory) {
     return resolveHandler().then((handler) => handler(event));
   });
 }
-const defineLazyEventHandler = lazyEventHandler;
+const lazyEventHandler = defineLazyEventHandler;
 function dynamicEventHandler(initial) {
   let current = initial;
   const wrapper = eventHandler((event) => {
@@ -466,4 +497,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, 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, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "h3",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "description": "Tiny JavaScript Server",
   "repository": "unjs/h3",
   "license": "MIT",