@qwik.dev/router 2.0.0-beta.27 → 2.0.0-beta.29

package/lib/middleware/aws-lambda/index.mjs

@@ -41,7 +41,13 @@ function createQwikRouter(opts) {
         });
       });
     };
-    return { fixPath, router, staticFile, notFound, handle };
+    return {
+      fixPath,
+      router,
+      staticFile,
+      notFound,
+      handle
+    };
   } catch (err) {
     throw new Error(err.message);
   }

package/lib/middleware/azure-swa/index.mjs

@@ -73,14 +73,19 @@ function createQwikRouter(opts) {
       const notFoundHtml = !req.headers.accept?.includes("text/html") || isStaticPath(req.method || "GET", url) ? "Not Found" : getNotFound(url.pathname);
       return {
         status: 404,
-        headers: { "Content-Type": "text/html; charset=utf-8", "X-Not-Found": url.pathname },
+        headers: {
+          "Content-Type": "text/html; charset=utf-8",
+          "X-Not-Found": url.pathname
+        },
         body: notFoundHtml
       };
     } catch (e) {
       console.error(e);
       return {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8"
+        }
       };
     }
   }

package/lib/middleware/bun/index.mjs

@@ -2,6 +2,7 @@ import { setServerPlatform } from '@qwik.dev/core/server';
 import { _TextEncoderStream_polyfill, isStaticPath, getNotFound, mergeHeadersCookies, requestHandler } from '@qwik.dev/router/middleware/request-handler';
 import { join, extname } from 'node:path';
 import { M as MIME_TYPES } from '../../chunks/mime-types.mjs';
+import { isDev } from '@qwik.dev/core/build';
 
 function getRequestUrl(request, opts) {
   const url = new URL(request.url);
@@ -71,9 +72,12 @@ function createQwikRouter(opts) {
       return null;
     } catch (e) {
       console.error(e);
-      return new Response(String(e || "Error"), {
+      return new Response(isDev ? String(e || "Error") : "Internal Server Error", {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8", "X-Error": "bun-server" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8",
+          "X-Error": "bun-server"
+        }
       });
     }
   }
@@ -83,13 +87,19 @@ function createQwikRouter(opts) {
       const notFoundHtml = !request.headers.get("accept")?.includes("text/html") || isStaticPath(request.method || "GET", url) ? "Not Found" : getNotFound(url.pathname);
       return new Response(notFoundHtml, {
         status: 404,
-        headers: { "Content-Type": "text/html; charset=utf-8", "X-Not-Found": url.pathname }
+        headers: {
+          "Content-Type": "text/html; charset=utf-8",
+          "X-Not-Found": url.pathname
+        }
       });
     } catch (e) {
       console.error(e);
-      return new Response(String(e || "Error"), {
+      return new Response(isDev ? String(e || "Error") : "Internal Server Error", {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8", "X-Error": "bun-server" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8",
+          "X-Error": "bun-server"
+        }
       });
     }
   };
@@ -117,7 +127,10 @@ function createQwikRouter(opts) {
         if (!await content.exists()) {
           return new Response("Not Found", {
             status: 404,
-            headers: { "Content-Type": "text/plain; charset=utf-8", "X-Not-Found": url.pathname }
+            headers: {
+              "Content-Type": "text/plain; charset=utf-8",
+              "X-Not-Found": url.pathname
+            }
           });
         }
         const ext = extname(filePath).replace(/^\./, "");
@@ -132,9 +145,12 @@ function createQwikRouter(opts) {
       return null;
     } catch (e) {
       console.error(e);
-      return new Response(String(e || "Error"), {
+      return new Response(isDev ? String(e || "Error") : "Internal Server Error", {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8", "X-Error": "bun-server" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8",
+          "X-Error": "bun-server"
+        }
       });
     }
   };

package/lib/middleware/cloudflare-pages/index.mjs

@@ -1,5 +1,6 @@
 import { setServerPlatform } from '@qwik.dev/core/server';
 import { _TextEncoderStream_polyfill, isStaticPath, mergeHeadersCookies, requestHandler, getNotFound } from '@qwik.dev/router/middleware/request-handler';
+import { isDev } from '@qwik.dev/core/build';
 
 function createQwikRouter(opts) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
@@ -78,13 +79,19 @@ function createQwikRouter(opts) {
       const notFoundHtml = !request.headers.get("accept")?.includes("text/html") || isStaticPath(request.method || "GET", url) ? "Not Found" : getNotFound(url.pathname);
       return new Response(notFoundHtml, {
         status: 404,
-        headers: { "Content-Type": "text/html; charset=utf-8", "X-Not-Found": url.pathname }
+        headers: {
+          "Content-Type": "text/html; charset=utf-8",
+          "X-Not-Found": url.pathname
+        }
       });
     } catch (e) {
       console.error(e);
-      return new Response(String(e || "Error"), {
+      return new Response(isDev ? String(e || "Error") : "Internal Server Error", {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8", "X-Error": "cloudflare-pages" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8",
+          "X-Error": "cloudflare-pages"
+        }
       });
     }
   }

package/lib/middleware/deno/index.mjs

@@ -2,6 +2,7 @@ import { setServerPlatform } from '@qwik.dev/core/server';
 import { isStaticPath, getNotFound, mergeHeadersCookies, requestHandler } from '@qwik.dev/router/middleware/request-handler';
 import { M as MIME_TYPES } from '../../chunks/mime-types.mjs';
 import { join, fromFileUrl, extname } from 'https://deno.land/std/path/mod.ts';
+import { isDev } from '@qwik.dev/core/build';
 
 function getRequestUrl(request, opts, info) {
   const url = new URL(request.url);
@@ -63,9 +64,12 @@ function createQwikRouter(opts) {
       return null;
     } catch (e) {
       console.error(e);
-      return new Response(String(e || "Error"), {
+      return new Response(isDev ? String(e || "Error") : "Internal Server Error", {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8", "X-Error": "deno-server" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8",
+          "X-Error": "deno-server"
+        }
       });
     }
   }
@@ -75,13 +79,19 @@ function createQwikRouter(opts) {
       const notFoundHtml = !request.headers.get("accept")?.includes("text/html") || isStaticPath(request.method || "GET", url) ? "Not Found" : getNotFound(url.pathname);
       return new Response(notFoundHtml, {
         status: 404,
-        headers: { "Content-Type": "text/html; charset=utf-8", "X-Not-Found": url.pathname }
+        headers: {
+          "Content-Type": "text/html; charset=utf-8",
+          "X-Not-Found": url.pathname
+        }
       });
     } catch (e) {
       console.error(e);
-      return new Response(String(e || "Error"), {
+      return new Response(isDev ? String(e || "Error") : "Internal Server Error", {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8", "X-Error": "deno-server" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8",
+          "X-Error": "deno-server"
+        }
       });
     }
   };
@@ -99,7 +109,9 @@ function createQwikRouter(opts) {
     return {
       filePath,
       // @ts-ignore
-      content: await Deno.open(filePath, { read: true })
+      content: await Deno.open(filePath, {
+        read: true
+      })
     };
   };
   const staticFile = async (request) => {
@@ -119,9 +131,12 @@ function createQwikRouter(opts) {
       return null;
     } catch (e) {
       console.error(e);
-      return new Response(String(e || "Error"), {
+      return new Response(isDev ? String(e || "Error") : "Internal Server Error", {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8", "X-Error": "deno-server" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8",
+          "X-Error": "deno-server"
+        }
       });
     }
   };

package/lib/middleware/netlify-edge/index.mjs

@@ -1,5 +1,6 @@
 import { setServerPlatform } from '@qwik.dev/core/server';
 import { isStaticPath, mergeHeadersCookies, requestHandler, getNotFound } from '@qwik.dev/router/middleware/request-handler';
+import { isDev } from '@qwik.dev/core/build';
 
 function createQwikRouter(opts) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
@@ -53,13 +54,19 @@ function createQwikRouter(opts) {
       const notFoundHtml = !request.headers.get("accept")?.includes("text/html") || isStaticPath(request.method || "GET", url) ? "Not Found" : getNotFound(url.pathname);
       return new Response(notFoundHtml, {
         status: 404,
-        headers: { "Content-Type": "text/html; charset=utf-8", "X-Not-Found": url.pathname }
+        headers: {
+          "Content-Type": "text/html; charset=utf-8",
+          "X-Not-Found": url.pathname
+        }
       });
     } catch (e) {
       console.error(e);
-      return new Response(String(e || "Error"), {
+      return new Response(isDev ? String(e || "Error") : "Internal Server Error", {
         status: 500,
-        headers: { "Content-Type": "text/plain; charset=utf-8", "X-Error": "netlify-edge" }
+        headers: {
+          "Content-Type": "text/plain; charset=utf-8",
+          "X-Error": "netlify-edge"
+        }
       });
     }
   }

package/lib/middleware/node/index.mjs

@@ -7,9 +7,6 @@ import { fileURLToPath } from 'node:url';
 import { M as MIME_TYPES } from '../../chunks/mime-types.mjs';
 import { Http2ServerRequest } from 'node:http2';
 
-function computeOrigin(req, opts) {
-  return opts?.getOrigin?.(req) ?? opts?.origin ?? process.env.ORIGIN ?? fallbackOrigin(req);
-}
 function fallbackOrigin(req) {
   const { PROTOCOL_HEADER, HOST_HEADER } = process.env;
   const headers = req.headers;
@@ -18,11 +15,14 @@ function fallbackOrigin(req) {
   const host = headers[hostHeader];
   return `${protocol}://${host}`;
 }
-function getUrl(req, origin) {
-  return normalizeUrl(req.originalUrl || req.url || "/", origin);
+function computeOrigin(req, opts) {
+  return opts?.getOrigin?.(req) ?? opts?.origin ?? process.env.ORIGIN ?? fallbackOrigin(req);
 }
 function isIgnoredError(message = "") {
-  const ignoredErrors = ["The stream has been destroyed", "write after end"];
+  const ignoredErrors = [
+    "The stream has been destroyed",
+    "write after end"
+  ];
   return ignoredErrors.some((ignored) => message.includes(ignored));
 }
 const invalidHeadersPattern = /^:(method|scheme|authority|path)$/i;
@@ -30,6 +30,9 @@ function normalizeUrl(url, base) {
   const DOUBLE_SLASH_REG = /\/\/|\\\\/g;
   return new URL(url.replace(DOUBLE_SLASH_REG, "/"), base);
 }
+function getUrl(req, origin) {
+  return normalizeUrl(req.originalUrl || req.url || "/", origin);
+}
 async function fromNodeHttp(url, req, res, mode, getClientConn) {
   const requestHeaders = new Headers();
   const nodeRequestHeaders = req.headers;
@@ -116,7 +119,6 @@ async function fromNodeHttp(url, req, res, mode, getClientConn) {
       ssr: true,
       incomingMessage: req,
       node: process.versions.node
-      // Weirdly needed to make typecheck of insights happy
     },
     locale: void 0
   };
@@ -135,13 +137,7 @@ function createQwikRouter(opts) {
   const router = async (req, res, next) => {
     try {
       const origin = computeOrigin(req, opts);
-      const serverRequestEv = await fromNodeHttp(
-        getUrl(req, origin),
-        req,
-        res,
-        "server",
-        opts.getClientConn
-      );
+      const serverRequestEv = await fromNodeHttp(getUrl(req, origin), req, res, "server", opts.getClientConn);
       if (isDev && opts.platform) {
         Object.assign(serverRequestEv.platform, opts.platform);
       }

package/lib/middleware/request-handler/index.d.ts

@@ -2,6 +2,7 @@ import type { Action } from '@qwik.dev/router';
 import type { AsyncLocalStorage } from 'node:async_hooks';
 import type { EnvGetter as EnvGetter_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { FailReturn } from '@qwik.dev/router';
+import type { JSXOutput } from '@qwik.dev/core';
 import type { Loader as Loader_2 } from '@qwik.dev/router';
 import type { QwikCityPlan } from '@qwik.dev/router';
 import type { QwikIntrinsicElements } from '@qwik.dev/core';
@@ -93,6 +94,27 @@ declare interface CacheControlOptions {
 /** @public */
 declare type CacheControlTarget = 'Cache-Control' | 'CDN-Cache-Control' | 'Cloudflare-CDN-Cache-Control' | 'Vercel-CDN-Cache-Control' | '~ANY-OTHER-STRING' | (string & {});
 
+/**
+ * The cacheKey export type. When exported from a page module alongside eTag, enables in-memory SSR
+ * caching.
+ *
+ * - `true`: use the default cache key `status|eTag|pathname`
+ * - Function: receives status, eTag, and pathname; returns a cache key string or null (no cache)
+ *
+ * @public
+ */
+declare type CacheKeyFn = true | ((status: number, eTag: string, pathname: string) => string | null);
+
+/**
+ * Clear the in-memory SSR cache. Call after deployments or data changes.
+ *
+ * When `cacheKey` is provided, only that single entry is removed; otherwise the entire cache is
+ * cleared.
+ *
+ * @public
+ */
+export declare function clearSsrCache(cacheKey?: string): void;
+
 /** @public */
 export declare interface ClientConn {
     ip?: string;
@@ -121,8 +143,18 @@ declare interface ContentMenu {
 
 declare type ContentModule = PageModule | LayoutModule;
 
+/**
+ * The eTag export type: a static string or a function receiving DocumentHeadProps.
+ *
+ * @public
+ */
+declare type ContentModuleETag = string | ((props: DocumentHeadProps) => string | null);
+
+/** @public */
 declare type ContentModuleHead = DocumentHead | ResolvedDocumentHead;
 
+declare type ContentModuleLoader = () => ValueOrPromise<ContentModule>;
+
 /** @public */
 export declare interface Cookie {
     /** Gets a `Request` cookie header value by name. */
@@ -209,6 +241,8 @@ declare type DocumentHead = DocumentHeadValue | ((props: DocumentHeadProps) => D
 /** @public */
 declare interface DocumentHeadProps extends RouteLocation {
     readonly head: ResolvedDocumentHead;
+    /** The HTTP status code of the response (e.g. 200, 404). */
+    readonly status: number;
     /** @deprecated This is not necessary, it works correctly without */
     readonly withLocale: <T>(fn: () => T) => T;
     readonly resolveValue: ResolveSyncValue_2;
@@ -309,28 +343,42 @@ declare type InformationalCode = 100 | 101 | 102 | 103;
 export declare function isStaticPath(method: string, url: URL): boolean;
 
 declare interface LayoutModule extends RouteModule {
-    readonly default: unknown;
+    readonly default?: (props: Record<string, never>) => JSXOutput;
+    readonly routeConfig?: RouteConfig;
     readonly head?: ContentModuleHead;
 }
 
-declare type LoadedRoute = [
-routeName: string,
-params: PathParams,
-mods: (RouteModule | ContentModule)[],
-menu: ContentMenu | undefined,
-routeBundleNames: string[] | undefined
-];
+/** The route to render */
+declare interface LoadedRoute {
+    /** The canonical path of the route, e.g. `/products/[id]` */
+    $routeName$: string;
+    /** The route parameters, e.g. `{ id: '123' }` */
+    $params$: PathParams;
+    /** The modules associated with this route (on 404, contains only the error component) */
+    $mods$: (RouteModule | ContentModule)[];
+    /** The menu associated with this route */
+    $menu$?: ContentMenu | undefined;
+    /** The bundle names for this route */
+    $routeBundleNames$?: string[] | undefined;
+    /** Whether this route is a not-found (404) route */
+    $notFound$?: boolean;
+    /** The error module loader (nearest _E ancestor), for rendering ServerErrors */
+    $errorLoader$?: ContentModuleLoader;
+}
 
 /** @public */
 export declare const mergeHeadersCookies: (headers: Headers, cookies: Cookie) => Headers;
 
 /** @public */
-declare interface PageModule extends RouteModule {
-    readonly default: unknown;
+declare type PageModule = RouteModule & {
+    readonly default: (props: Record<string, never>) => JSXOutput;
+    readonly routeConfig?: RouteConfig;
     readonly head?: ContentModuleHead;
+    readonly eTag?: ContentModuleETag;
+    readonly cacheKey?: CacheKeyFn;
     readonly headings?: ContentHeading[];
     readonly onStaticGenerate?: StaticGenerateHandler;
-}
+};
 
 /** @public */
 declare type PathParams = Record<string, string>;
@@ -550,7 +598,7 @@ declare interface RequestEventInternal extends Readonly<RequestEvent>, Readonly<
     readonly [RequestEvLoaders]: Record<string, ValueOrPromise<unknown> | undefined>;
     readonly [RequestEvLoaderSerializationStrategyMap]: Map<string, SerializationStrategy>;
     readonly [RequestEvMode]: ServerRequestMode;
-    readonly [RequestEvRoute]: LoadedRoute | null;
+    readonly [RequestEvRoute]: LoadedRoute;
     /**
      * Check if this request is already written to.
      *
@@ -615,6 +663,28 @@ export declare class RewriteMessage extends AbortMessage {
     constructor(pathname: string);
 }
 
+/**
+ * Unified route configuration export. Groups head, eTag, and cacheKey with the same resolution
+ * rules as DocumentHead: can be a static object or a function receiving DocumentHeadProps.
+ *
+ * When a module exports `routeConfig`, the separate `head`, `eTag`, and `cacheKey` exports are
+ * ignored for that module.
+ *
+ * @public
+ */
+declare type RouteConfig = RouteConfigValue | ((props: DocumentHeadProps) => RouteConfigValue);
+
+/**
+ * The value shape returned by a routeConfig export (object form or function return).
+ *
+ * @public
+ */
+declare interface RouteConfigValue {
+    readonly head?: DocumentHeadValue;
+    readonly eTag?: ContentModuleETag;
+    readonly cacheKey?: CacheKeyFn;
+}
+
 /** @public */
 declare interface RouteLocation {
     readonly params: Readonly<Record<string, string>>;