@qwik.dev/router 2.0.0-beta.45 → 2.0.0-beta.47

package/lib/chunks/user-response.mjs

@@ -1,7 +1,7 @@
-import { A as matchesRouteLoaderId, E as getRouteLoaderValues, J as QACTION_KEY, L as setRouteLoaders, M as resolveRouteLoaderByHash, Q as _asyncRequestStore, T as getRouteLoaderResponse, X as QFN_KEY, Y as QDATA_KEY, Z as Q_ROUTE, a as isPromise, f as FULLPATH_HEADER, g as clearRouteLoaderData, k as loadRouteLoader, r as resolveRouteConfig, w as getRouteLoaderCtx, x as getLoaderRequestEvent } from "./head.qwik.mjs";
 import { t as ensureSlash } from "./pathname.mjs";
+import { A as loadRouteLoader, D as getRouteLoaderValues, E as getRouteLoaderResponse, N as resolveRouteLoaderByHash, R as setRouteLoaders, T as getRouteLoaderParams, a as isPromise, at as RequestEvRouterConfig, f as FULLPATH_HEADER, g as clearRouteLoaderData, it as Q_ROUTE, j as matchesRouteLoaderId, nt as QDATA_KEY, ot as _asyncRequestStore, r as resolveRouteConfig, rt as QFN_KEY, tt as QACTION_KEY, w as getRouteLoaderCtx, x as getLoaderRequestEvent } from "./head.qwik.mjs";
 import { a as QLoaderId, c as resolveValidInternalFullPathname, i as QActionId, s as recognizeRequest, t as IsQAction, u as trimRecognizedInternalPathname } from "./request-path.mjs";
-import { i as RedirectMessage, n as throwIfControlFlowSignal, r as AbortMessage, t as ServerError } from "./server-error.mjs";
+import { a as shareClassIdentity, i as RedirectMessage, n as throwIfControlFlowSignal, r as AbortMessage, t as ServerError } from "./server-error.mjs";
 import { inlinedQrl, isDev } from "@qwik.dev/core";
 import { _deserialize, _serialize, _verifySerializable, isDev as isDev$1 } from "@qwik.dev/core/internal";
 /**
@@ -38,7 +38,7 @@ function setETagHeader(requestEv, normalizedETag) {
 * The eTag argument must already be normalized. Returns true if a 304 was sent (caller should stop
 * processing).
 */
-function performETagMatch(requestEv, normalizedETag) {
+function performETagMatch(requestEv, normalizedETag, beforeNotModified) {
 	setETagHeader(requestEv, normalizedETag);
 	const ifNoneMatch = requestEv.request.headers.get("If-None-Match");
 	if (ifNoneMatch) {
@@ -50,6 +50,7 @@ function performETagMatch(requestEv, normalizedETag) {
 			}
 		}
 		if (found) {
+			beforeNotModified?.();
 			requestEv.status(304);
 			requestEv.send(304, "");
 			return true;
@@ -213,6 +214,7 @@ var RewriteMessage = class extends AbortMessage {
 		this.pathname = pathname;
 	}
 };
+shareClassIdentity(RewriteMessage, "RewriteMessage");
 var encoder = /*#__PURE__*/ new TextEncoder();
 function getContentType(headers) {
 	return (headers.get("content-type")?.split(/[;,]/, 1)[0].trim() ?? "").toLowerCase();
@@ -231,9 +233,9 @@ var RequestEvSharedNonce = "@nonce";
 var RequestEvIsRewrite = "@rewrite";
 var RequestEvShareServerTiming = "@serverTiming";
 var RequestEvETagCacheKey = "@eTagCacheKey";
-var RequestEvErrorBoundaryCaught = "@errorBoundaryCaught";
+var RequestEvCaughtError = "@caughtError";
 var RequestEvHttpStatusMessage = "@httpStatusMessage";
-function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, basePathname, resolved) {
+function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, basePathname, resolved, routerConfig) {
 	const { request, platform, env } = serverRequestEv;
 	const sharedMap = /* @__PURE__ */ new Map();
 	const cookie = new Cookie(request.headers.get("cookie"));
@@ -311,6 +313,7 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, baseP
 	};
 	const requestEv = {
 		[RequestEvMode]: serverRequestEv.mode,
+		[RequestEvRouterConfig]: routerConfig,
 		get [RequestEvRoute]() {
 			return loadedRoute;
 		},
@@ -592,7 +595,7 @@ function resolveCacheKey(cacheKeyExport, defaultKey, requestEv, eTag) {
 /** Build the default SSR cache key. eTag slot is dropped when no eTag was resolved. */
 function defaultSsrCacheKey(requestEv, eTag) {
 	const status = requestEv.status();
-	const pathname = requestEv.url.pathname;
+	const pathname = requestEv.originalUrl.pathname;
 	return eTag ? `${status}|${eTag}|${pathname}` : `${status}|${pathname}`;
 }
 /** Build the default loader cache key. eTag slot is dropped when no eTag was resolved. */
@@ -668,15 +671,18 @@ function loaderHandler(routeLoaders, loaderPaths) {
 		await runBlockingLoadersBeforeTarget(routeLoaders, loader, requestEv);
 		const loaderRequestEv = createLoaderRequestEventFactory(requestEv)(loader);
 		const cacheControl = resolveLoaderCacheControl(loader.__cacheControl, loaderRequestEv);
+		const applyCacheControl = () => {
+			if (cacheControl !== null && !requestEv.headers.has("Cache-Control")) requestEv.cacheControl(cacheControl);
+		};
 		const normalizedETag = loader.__eTag !== void 0 ? resolvePreETag(loader.__eTag, loaderRequestEv) : "";
-		if (normalizedETag && performETagMatch(loaderRequestEv, normalizedETag)) return;
+		if (normalizedETag && performETagMatch(loaderRequestEv, normalizedETag, applyCacheControl)) return;
 		let cacheKey = "";
 		if (loader.__cacheKey) cacheKey = resolveCacheKey(loader.__cacheKey, defaultLoaderCacheKey, loaderRequestEv, normalizedETag);
 		if (cacheKey) {
 			const cached = getCachedLoader(cacheKey);
 			if (cached) {
 				if (!normalizedETag) {
-					if (performETagMatch(loaderRequestEv, cached.eTag)) return;
+					if (performETagMatch(loaderRequestEv, cached.eTag, applyCacheControl)) return;
 				} else setETagHeader(loaderRequestEv, cached.eTag);
 				await sendLoaderResponse(requestEv, cached.body, cacheControl);
 				return;
@@ -691,18 +697,17 @@ function loaderHandler(routeLoaders, loaderPaths) {
 			eTag: finalETag,
 			body: data
 		});
-		if (!normalizedETag && finalETag && performETagMatch(loaderRequestEv, finalETag)) return;
+		if (!normalizedETag && finalETag && performETagMatch(loaderRequestEv, finalETag, applyCacheControl)) return;
 		await sendLoaderResponse(requestEv, data, cacheControl);
 	};
 }
 /**
-* Resolve the loader's cacheControl option. Loaders default to `no-cache` so the browser always
-* revalidates; pair with `eTag` for cheap 304s. A function form may return `null` to skip the
-* header entirely.
+* Resolve the loader's cacheControl option. Loaders default to private revalidation; pair with
+* `eTag` for cheap 304s. A function form may return `null` to skip the header entirely.
 */
 function resolveLoaderCacheControl(option, requestEv) {
 	const value = typeof option === "function" ? option(requestEv) : option;
-	return value === void 0 ? "no-cache" : value;
+	return value === void 0 ? "private" : value;
 }
 async function runBlockingLoadersBeforeTarget(routeLoaders, targetLoader, requestEv) {
 	for (const loader of routeLoaders) {
@@ -738,6 +743,7 @@ function addVaryHeader(requestEv, value) {
 async function sendJsonResponse(requestEv, responseData, status = 200) {
 	const data = await _serialize(responseData);
 	requestEv.headers.set("Content-Type", "application/json; charset=utf-8");
+	if (!requestEv.headers.has("Cache-Control")) requestEv.cacheControl("private");
 	requestEv.send(status, data);
 }
 async function sendActionResponse(requestEv, responseData) {
@@ -1223,7 +1229,20 @@ var HttpStatus = /* @__PURE__ */ function(HttpStatus) {
 	HttpStatus[HttpStatus["NetworkAuthenticationRequired"] = 511] = "NetworkAuthenticationRequired";
 	return HttpStatus;
 }({});
-function getQwikRouterServerData(requestEv) {
+/** Client-controlled forwarded headers only override the URL when the proxy is trusted. */
+function getServerDataUrl(originalUrl, headers, trustForwardedHeaders) {
+	const url = new URL(originalUrl.pathname + originalUrl.search, originalUrl);
+	if (!trustForwardedHeaders) return url.href;
+	const host = headers.get("X-Forwarded-Host");
+	const protocol = headers.get("X-Forwarded-Proto");
+	if (host) {
+		url.port = "";
+		url.host = host;
+	}
+	if (protocol) url.protocol = protocol;
+	return url.href;
+}
+function getQwikRouterServerData(requestEv, trustForwardedHeaders) {
 	const { params, request, status, locale, originalUrl } = requestEv;
 	const requestHeaders = {};
 	request.headers.forEach((value, key) => requestHeaders[key] = value);
@@ -1232,19 +1251,10 @@ function getQwikRouterServerData(requestEv) {
 	const formData = requestEv.sharedMap.get(RequestEvSharedActionFormData);
 	const routeName = requestEv.sharedMap.get(RequestRouteName);
 	const nonce = requestEv.sharedMap.get(RequestEvSharedNonce);
-	const headers = requestEv.request.headers;
-	const reconstructedUrl = new URL(originalUrl.pathname + originalUrl.search, originalUrl);
-	const host = headers.get("X-Forwarded-Host");
-	const protocol = headers.get("X-Forwarded-Proto");
-	if (host) {
-		reconstructedUrl.port = "";
-		reconstructedUrl.host = host;
-	}
-	if (protocol) reconstructedUrl.protocol = protocol;
 	const routeLoaderCtx = getRouteLoaderCtx(requestEv);
 	const loaderValues = getRouteLoaderValues(requestEv);
 	return {
-		url: reconstructedUrl.href,
+		url: getServerDataUrl(originalUrl, request.headers, trustForwardedHeaders),
 		requestHeaders,
 		renderMode: getRequestMode(requestEv),
 		locale: locale(),
@@ -1427,6 +1437,7 @@ function createResolveRequestHandlers() {
 		if (routeLoaders.length === 0) return;
 		const routeLoaderCtx = getRouteLoaderCtx(requestEv);
 		if (route.$loaderPaths$) Object.assign(routeLoaderCtx.loaderPaths, route.$loaderPaths$);
+		if (route.$loaderParams$) Object.assign(getRouteLoaderParams(requestEv), route.$loaderParams$);
 		setRouteLoaders(requestEv, routeLoaders);
 	}
 	function eTagMiddleware(route) {
@@ -1629,7 +1640,7 @@ function createResolveRequestHandlers() {
 The request origin "${inputOrigin}" does not match the server origin "${origin}".`);
 		}
 	}
-	function renderQwikMiddleware(render) {
+	function renderQwikMiddleware(render, trustForwardedHeaders = false) {
 		return async (requestEv) => {
 			if (requestEv.headersSent) return;
 			const responseHeaders = requestEv.headers;
@@ -1661,7 +1672,7 @@ The request origin "${inputOrigin}" does not match the server origin "${origin}"
 			const stream = writable.getWriter();
 			try {
 				const isStatic = getRequestMode(requestEv) === "static";
-				const serverData = getQwikRouterServerData(requestEv);
+				const serverData = getQwikRouterServerData(requestEv, trustForwardedHeaders);
 				const result = await render({
 					base: requestEv.basePathname + "build/",
 					stream,
@@ -1672,7 +1683,7 @@ The request origin "${inputOrigin}" does not match the server origin "${origin}"
 						...serverData.containerAttributes
 					},
 					onBeforeFirstFlush: (info) => {
-						if (info.errorBoundaryCaught) {
+						if (info.hasCaughtError) {
 							boundaryErrored = true;
 							noStoreSent = true;
 							overrodeCacheControl = responseHeaders.has("Cache-Control");
@@ -1681,8 +1692,8 @@ The request origin "${inputOrigin}" does not match the server origin "${origin}"
 					}
 				});
 				if (typeof result.html === "string") await stream.write(result.html);
-				boundaryErrored ||= result.errorBoundaryCaught === true;
-				if (boundaryErrored) requestEv.sharedMap.set(RequestEvErrorBoundaryCaught, true);
+				boundaryErrored ||= result.hasCaughtError === true;
+				if (boundaryErrored) requestEv.sharedMap.set(RequestEvCaughtError, true);
 			} finally {
 				try {
 					await stream.ready;
@@ -1693,7 +1704,7 @@ The request origin "${inputOrigin}" does not match the server origin "${origin}"
 				}
 			}
 			if (pipeError) throw pipeError;
-			if (boundaryErrored && (noStoreSent ? cachePlan || overrodeCacheControl : !!cachePlan)) console.warn(`An <ErrorBoundary> caught during SSR of ${requestEv.url.pathname} — configured caching disabled: ` + (noStoreSent ? "the response was sent with Cache-Control: no-store." : "the SSR cache was skipped (response headers were already sent)."));
+			if (boundaryErrored && (noStoreSent ? cachePlan || overrodeCacheControl : !!cachePlan)) console.warn(`A <Catch> caught during SSR of ${requestEv.url.pathname} — configured caching disabled: ` + (noStoreSent ? "the response was sent with Cache-Control: no-store." : "the SSR cache was skipped (response headers were already sent)."));
 			if (cachePlan && cacheChunks && cacheChunks.length > 0 && !boundaryErrored) {
 				const totalLength = cacheChunks.reduce((sum, chunk) => sum + chunk.length, 0);
 				const combined = new Uint8Array(totalLength);
@@ -1789,11 +1800,11 @@ var escapeHtml = (s) => {
 var COLOR_400 = "#006ce9";
 var COLOR_500 = "#713fc2";
 var ensureError = (e) => e instanceof Error || typeof e === "object" && e !== null ? e : new Error(String(e));
-function runQwikRouter(serverRequestEv, loadedRoute, requestHandlers, rebuildRouteInfo, basePathname = "/") {
+function runQwikRouter(serverRequestEv, loadedRoute, requestHandlers, rebuildRouteInfo, basePathname = "/", routerConfig) {
 	let resolve;
 	const responsePromise = new Promise((r) => resolve = r);
 	try {
-		const requestEv = createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, basePathname, resolve);
+		const requestEv = createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, basePathname, resolve, routerConfig);
 		return {
 			response: responsePromise,
 			requestEv,
@@ -1869,4 +1880,4 @@ async function runNext(requestEv, rebuildRouteInfo, resolve) {
 		if (!requestEv.isDirty()) resolve(null);
 	}
 }
-export { getStaticPathRedirect as a, clearSsrCache as c, mergeHeadersCookies as d, resolveRequestHandlers as i, RequestEvErrorBoundaryCaught as l, getErrorHtml as n, isStaticPath as o, renderQwikMiddleware as r, clearLoaderCache as s, runQwikRouter as t, RewriteMessage as u };
+export { getStaticPathRedirect as a, clearSsrCache as c, mergeHeadersCookies as d, resolveRequestHandlers as i, RequestEvCaughtError as l, getErrorHtml as n, isStaticPath as o, renderQwikMiddleware as r, clearLoaderCache as s, runQwikRouter as t, RewriteMessage as u };

package/lib/chunks/worker-thread.mjs

@@ -1,4 +1,4 @@
-import { D as getRouteLoaders, E as getRouteLoaderValues, d as loadRoute } from "./head.qwik.mjs";
+import { D as getRouteLoaderValues, O as getRouteLoaders, d as loadRoute } from "./head.qwik.mjs";
 import { l as trimInternalPathname } from "./request-path.mjs";
 import { i as resolveRequestHandlers, r as renderQwikMiddleware, t as runQwikRouter } from "./user-response.mjs";
 import { _serialize } from "@qwik.dev/core/internal";
@@ -75,6 +75,7 @@ async function workerThread(sys) {
 		}
 		if (msg.type === "close") parentPort?.close();
 	});
+	parentPort?.postMessage({ type: "ready" });
 }
 async function workerRender(sys, opts, staticRoute, pendingPromises, callback, deps) {
 	const url = new URL(staticRoute.pathname, opts.origin);
@@ -199,10 +200,10 @@ async function workerRender(sys, opts, staticRoute, pendingPromises, callback, d
 		}, opts, deps).then((rsp) => {
 			if (rsp != null) return rsp.completion.then((r) => {
 				const failRouteOnCaughtBoundary = (completion) => {
-					if (completion === void 0 && rsp.requestEv.sharedMap.get("@errorBoundaryCaught")) {
+					if (completion === void 0 && rsp.requestEv.sharedMap.get("@caughtError")) {
 						result.ok = false;
 						result.filePath = null;
-						return /* @__PURE__ */ new Error(`An <ErrorBoundary> caught an error while rendering ${staticRoute.pathname}`);
+						return /* @__PURE__ */ new Error(`A <Catch> caught an error while rendering ${staticRoute.pathname}`);
 					}
 					return completion;
 				};
@@ -268,6 +269,6 @@ async function requestHandlerForSsg(serverRequestEv, opts, deps) {
 			requestHandlers: deps.resolveRequestHandlers(serverPlugins, loadedRoute, serverRequestEv.request.method, checkOrigin ?? true, deps.renderQwikMiddleware(render))
 		};
 	};
-	return deps.runQwikRouter(serverRequestEv, loadedRoute, requestHandlers, rebuildRouteInfo, qwikRouterConfig.basePathname);
+	return deps.runQwikRouter(serverRequestEv, loadedRoute, requestHandlers, rebuildRouteInfo, qwikRouterConfig.basePathname, qwikRouterConfig);
 }
 export { workerThread };

package/lib/index.d.ts

@@ -427,6 +427,13 @@ export declare interface FormSubmitSuccessDetail<T> {
     value: T;
 }
 
+/**
+ * The base pathname the app is served under, such as `/` or `/docs/`.
+ *
+ * @public
+ */
+export declare const getBasePathname: () => string;
+
 /**
  * Returns the current RequestEvent if possible. Only usable on the server, and only during request
  * processing.
@@ -435,6 +442,32 @@ export declare interface FormSubmitSuccessDetail<T> {
  */
 export declare const getRequestEvent: (thisArg?: unknown) => RequestEvent | undefined;
 
+/**
+ * The app's route config: the route trie, server plugins and build options that the Qwik Router
+ * Vite plugin generated. Resolves once the config is loaded and its `server$` modules are
+ * registered. On the server, the router copy of a Qwik library kept external reads the config of
+ * the app serving the current request.
+ *
+ * @public
+ */
+export declare const getRouterConfig: () => Promise<QwikRouterConfig>;
+
+/**
+ * The route trie of the app, as generated by the Qwik Router Vite plugin.
+ *
+ * @public
+ */
+export declare const getRoutes: () => Promise<RouteData>;
+
+/* Excluded from this release type: _getServiceWorkerScript */
+
+/**
+ * Whether the app's URLs end with a trailing slash.
+ *
+ * @public
+ */
+export declare const getTrailingSlash: () => boolean;
+
 /** @public */
 export declare type GetValidatorInputType<VALIDATOR extends TypedDataValidator> = VALIDATOR extends ValibotDataValidator<infer TYPE> ? v.InferInput<TYPE> : VALIDATOR extends ZodDataValidator<infer TYPE> ? z_2.input<TYPE> : never;
 
@@ -541,6 +574,8 @@ declare interface LoadedRoute {
     $loaders$?: string[];
     /** Runtime-only mapping of routeLoader$ hashes to the matched pathname used for q-loader fetches */
     $loaderPaths$?: Record<string, string>;
+    /** Runtime-only mapping of routeLoader$ hashes to params matched at their loader path */
+    $loaderParams$?: Record<string, PathParams>;
 }
 
 /** @public */
@@ -591,7 +626,9 @@ declare type LoaderOptions = {
      * object) or a function of the request event; the function may return `null` to skip the header.
      * A `Cache-Control` header set inside the loader function wins over this option.
      *
-     * Defaults to `no-cache` (always revalidate; combine with `eTag` for cheap 304s).
+     * Defaults to `private, no-cache` (browser revalidation without shared caching; combine with
+     * `eTag` for cheap 304s). Explicit `'no-cache'` and numeric values allow shared caching; numeric
+     * values include `s-maxage`.
      *
      * The literal value `'immutable'` also marks the loader's data as static, so SSG writes a
      * per-loader JSON file at build time.
@@ -622,7 +659,8 @@ declare type LoaderOptions = {
      * - `true` — use the default key `${pathname}|${filteredSearch}|${loaderId}` (suffixed with
      *   `|${eTag}` when an eTag is set).
      * - Function `(requestEv, eTag) => string | null` — return a custom key, or `null` to skip caching
-     *   this request.
+     *   this request. For user-specific data, include user identity and relevant permissions in the
+     *   key or disable this cache.
      *
      * On cache miss the loader runs, the serialized response is stored alongside its eTag (computed
      * from the data when no `eTag` option is set), and the response is sent. On cache hit the stored
@@ -786,6 +824,8 @@ export declare interface QwikRouterConfig {
      * evaluates without touching the runtime (see the import-cycle notes in `route-loaders.ts`).
      */
     readonly importEagerModules?: () => Promise<unknown>;
+    /** URL of the app's service worker, when the routes define one. */
+    readonly serviceWorkerUrl?: string;
 }
 
 /** @public */
@@ -930,9 +970,9 @@ export declare type ResolvedDocumentHead<FrontMatter extends Record<string, any>
 export declare const routeAction$: ActionConstructor;
 
 /**
- * Hoisted function declarations (not consts) on purpose, like `routeLoaderQrl`: generated route
- * modules call these factories back during their own evaluation via the `@qwik-router-config`
- * cycle, where a `const` binding would throw a TDZ ReferenceError.
+ * Hoisted function declarations (not consts) on purpose, like `routeLoaderQrl`: the app's route
+ * modules call these factories during their own evaluation, which a bundle may run before this
+ * module, where a `const` binding would throw a TDZ ReferenceError.
  *
  * @public
  */
@@ -975,7 +1015,8 @@ export declare interface RouteConfigValue {
 /**
  * A nested route trie structure. The root represents `/` and each level represents a URL segment.
  *
- * Keys starting with `_` are metadata; all other keys are child route segments.
+ * Keys starting with a single `_` are metadata; all other keys are child route segments. A static
+ * segment that starts with `_` is stored with an extra `_` (`_drafts` → `__drafts`).
  *
  * - Use `_W` as the key for a single dynamic segment (param); `_P` on that node names the param.
  * - Use `_A` as the key for a rest/catch-all segment; `_P` on that node names the param.
@@ -1021,7 +1062,7 @@ export declare interface RouteData {
     _R?: string[];
     /** Page loader hashes; override pages include their selected layouts and plugins. */
     _D?: string[];
-    /** Child route segments (any key not starting with `_`) */
+    /** Child route segments (any key not starting with a single `_`) */
     [part: string]: RouteData | RouteData[] | ModuleLoader[] | ContentModuleLoader | MenuModuleLoader | string[] | string | undefined;
 }
 
@@ -1152,6 +1193,8 @@ export declare const ServiceWorkerRegister: (props: {
     nonce?: string;
 }) => JSXOutput;
 
+/* Excluded from this release type: _setRouterConfig */
+
 /** @public */
 export declare interface StaticGenerate {
     params?: PathParams[];