h3 0.5.4 → 0.5.7

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"
@@ -254,6 +285,7 @@ function defineEventHandler(handler) {
   handler.__is_handler__ = true;
   return handler;
 }
+const eventHandler = defineEventHandler;
 function defineLazyEventHandler(factory) {
   let _promise;
   let _resolved;
@@ -273,13 +305,26 @@ function defineLazyEventHandler(factory) {
     }
     return _promise;
   };
-  return defineEventHandler((event) => {
+  return eventHandler((event) => {
     if (_resolved) {
       return _resolved(event);
     }
     return resolveHandler().then((handler) => handler(event));
   });
 }
+const lazyEventHandler = defineLazyEventHandler;
+function dynamicEventHandler(initial) {
+  let current = initial;
+  const wrapper = eventHandler((event) => {
+    if (current) {
+      return current(event);
+    }
+  });
+  wrapper.set = (handler) => {
+    current = handler;
+  };
+  return wrapper;
+}
 function isEventHandler(input) {
   return "__is_handler__" in input;
 }
@@ -290,7 +335,7 @@ function toEventHandler(handler) {
   if (typeof handler !== "function") {
     throw new TypeError("Invalid handler. It should be a function:", handler);
   }
-  return defineEventHandler((event) => {
+  return eventHandler((event) => {
     return callHandler(handler, event.req, event.res);
   });
 }
@@ -356,7 +401,7 @@ function use(app, arg1, arg2, arg3) {
 }
 function createAppEventHandler(stack, options) {
   const spacing = options.debug ? 2 : void 0;
-  return defineEventHandler(async (event) => {
+  return eventHandler(async (event) => {
     event.req.originalUrl = event.req.originalUrl || event.req.url || "/";
     const reqUrl = event.req.url || "/";
     for (const layer of stack) {
@@ -401,7 +446,7 @@ function normalizeLayer(input) {
     handler = handler.handler;
   }
   if (input.lazy) {
-    handler = defineLazyEventHandler(handler);
+    handler = lazyEventHandler(handler);
   } else if (!isEventHandler(handler)) {
     handler = toEventHandler(handler);
   }
@@ -430,7 +475,7 @@ function createRouter() {
   for (const method of RouterMethods) {
     router[method] = (path, handle) => router.add(path, handle, method);
   }
-  router.handler = defineEventHandler((event) => {
+  router.handler = eventHandler((event) => {
     let path = event.req.url || "/";
     const queryUrlIndex = path.lastIndexOf("?");
     if (queryUrlIndex > -1) {
@@ -478,11 +523,15 @@ exports.defineLazyEventHandler = defineLazyEventHandler;
 exports.defineLazyHandler = defineLazyHandler;
 exports.defineMiddleware = defineMiddleware;
 exports.deleteCookie = deleteCookie;
+exports.dynamicEventHandler = dynamicEventHandler;
+exports.eventHandler = eventHandler;
+exports.handleCacheHeaders = handleCacheHeaders;
 exports.isError = isError;
 exports.isEvent = isEvent;
 exports.isEventHandler = isEventHandler;
 exports.isMethod = isMethod;
 exports.isStream = isStream;
+exports.lazyEventHandler = lazyEventHandler;
 exports.lazyHandle = lazyHandle;
 exports.promisifyHandle = promisifyHandle;
 exports.promisifyHandler = promisifyHandler;

package/dist/index.d.ts

@@ -7,12 +7,10 @@ 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;
+declare type CompatibilityEvent = H3Event | IncomingMessage;
 declare type _JSONValue<T = string | number | boolean> = T | T[] | Record<string, T>;
 declare type JSONValue = _JSONValue<_JSONValue>;
 declare type H3Response = void | JSONValue | Buffer;
@@ -21,27 +19,35 @@ interface EventHandler {
     (event: CompatibilityEvent): H3Response | Promise<H3Response>;
 }
 declare function defineEventHandler(handler: EventHandler): EventHandler;
+declare const eventHandler: typeof defineEventHandler;
 declare type LazyEventHandler = () => EventHandler | Promise<EventHandler>;
 declare function defineLazyEventHandler(factory: LazyEventHandler): EventHandler;
+declare const lazyEventHandler: typeof defineLazyEventHandler;
+interface DynamicEventHandler extends EventHandler {
+    set: (handler: EventHandler) => void;
+}
+declare function dynamicEventHandler(initial?: EventHandler): DynamicEventHandler;
 declare function isEventHandler(input: any): input is EventHandler;
 declare type CompatibilityEventHandler = EventHandler | Handler | Middleware;
 declare function toEventHandler(handler: CompatibilityEventHandler): EventHandler;
 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>>;
@@ -157,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;
@@ -225,4 +244,4 @@ interface Router extends AddRouteShortcuts {
 }
 declare function createRouter(): Router;
 
-export { AddRouteShortcuts, App, AppOptions, AppUse, CompatibilityEvent, CompatibilityEventHandler, 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, isError, isEvent, isEventHandler, isMethod, isStream, 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"
@@ -246,6 +277,7 @@ function defineEventHandler(handler) {
   handler.__is_handler__ = true;
   return handler;
 }
+const eventHandler = defineEventHandler;
 function defineLazyEventHandler(factory) {
   let _promise;
   let _resolved;
@@ -265,13 +297,26 @@ function defineLazyEventHandler(factory) {
     }
     return _promise;
   };
-  return defineEventHandler((event) => {
+  return eventHandler((event) => {
     if (_resolved) {
       return _resolved(event);
     }
     return resolveHandler().then((handler) => handler(event));
   });
 }
+const lazyEventHandler = defineLazyEventHandler;
+function dynamicEventHandler(initial) {
+  let current = initial;
+  const wrapper = eventHandler((event) => {
+    if (current) {
+      return current(event);
+    }
+  });
+  wrapper.set = (handler) => {
+    current = handler;
+  };
+  return wrapper;
+}
 function isEventHandler(input) {
   return "__is_handler__" in input;
 }
@@ -282,7 +327,7 @@ function toEventHandler(handler) {
   if (typeof handler !== "function") {
     throw new TypeError("Invalid handler. It should be a function:", handler);
   }
-  return defineEventHandler((event) => {
+  return eventHandler((event) => {
     return callHandler(handler, event.req, event.res);
   });
 }
@@ -348,7 +393,7 @@ function use(app, arg1, arg2, arg3) {
 }
 function createAppEventHandler(stack, options) {
   const spacing = options.debug ? 2 : void 0;
-  return defineEventHandler(async (event) => {
+  return eventHandler(async (event) => {
     event.req.originalUrl = event.req.originalUrl || event.req.url || "/";
     const reqUrl = event.req.url || "/";
     for (const layer of stack) {
@@ -393,7 +438,7 @@ function normalizeLayer(input) {
     handler = handler.handler;
   }
   if (input.lazy) {
-    handler = defineLazyEventHandler(handler);
+    handler = lazyEventHandler(handler);
   } else if (!isEventHandler(handler)) {
     handler = toEventHandler(handler);
   }
@@ -422,7 +467,7 @@ function createRouter() {
   for (const method of RouterMethods) {
     router[method] = (path, handle) => router.add(path, handle, method);
   }
-  router.handler = defineEventHandler((event) => {
+  router.handler = eventHandler((event) => {
     let path = event.req.url || "/";
     const queryUrlIndex = path.lastIndexOf("?");
     if (queryUrlIndex > -1) {
@@ -452,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, isError, isEvent, isEventHandler, isMethod, isStream, 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.4",
+  "version": "0.5.7",
   "description": "Tiny JavaScript Server",
   "repository": "unjs/h3",
   "license": "MIT",